From c032e83b22994332dd8769ef34cb817906a63cac Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Thu, 26 Jan 2023 09:42:23 +0100
Subject: fix(treesitter): validate language name

Problem: Some injections (like markdown) allow specifying arbitrary
language names for code blocks, which may be lead to errors when
looking for a corresponding parser in runtime path.

Solution: Validate that the language name only contains alphanumeric
characters and `_` (e.g., for `c_sharp`) and error otherwise.
---
 runtime/lua/vim/treesitter/language.lua | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index c92d63b8c4..8634e53b7b 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -6,7 +6,7 @@ local M = {}
 ---
 --- Parsers are searched in the `parser` runtime directory, or the provided {path}
 ---
----@param lang string Language the parser should parse
+---@param lang string Language the parser should parse (alphanumerical and `_` only)
 ---@param path (string|nil) Optional path the parser is located at
 ---@param silent (boolean|nil) Don't throw an error if language not found
 ---@param symbol_name (string|nil) Internal symbol name for the language to load
@@ -16,13 +16,19 @@ function M.require_language(lang, path, silent, symbol_name)
     return true
   end
   if path == nil then
-    local fname = 'parser/' .. vim.fn.fnameescape(lang) .. '.*'
+    if not (lang and lang:match('[%w_]+') == lang) then
+      if silent then
+        return false
+      end
+      error("'" .. lang .. "' is not a valid language name")
+    end
+
+    local fname = 'parser/' .. lang .. '.*'
     local paths = a.nvim_get_runtime_file(fname, false)
     if #paths == 0 then
       if silent then
         return false
       end
-
       error("no parser for '" .. lang .. "' language, see :help treesitter-parsers")
     end
     path = paths[1]
-- 
cgit 


From 8144deb0989ea5c61fe9a1a5802d230eba33dfdd Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sun, 29 Jan 2023 10:39:20 +0100
Subject: vim-patch:9.0.1256: NetworkManager connection files are not
 recognized (#22038)

Problem:    NetworkManager connection files are not recognized.
Solution:   Add a pattern for NetworkManager connection files. (closes vim/vim#11893)

https://github.com/vim/vim/commit/04e4f1d98556e67d7337224b67b71c828410ee0f

Co-authored-by: ObserverOfTime <chronobserver@disroot.org>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 9293c828b8..0a26e363d5 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -226,6 +226,7 @@ local extension = {
   hook = function(path, bufnr)
     return M.getlines(bufnr, 1) == '[Trigger]' and 'conf'
   end,
+  nmconnection = 'confini',
   mklx = 'context',
   mkiv = 'context',
   mkii = 'context',
-- 
cgit 


From c9ac4e487706658852f0e6c2e71cf669dafba90b Mon Sep 17 00:00:00 2001
From: Amaan Qureshi <amaanq12@gmail.com>
Date: Sun, 29 Jan 2023 14:19:07 -0500
Subject: vim-patch:9.0.1261: Elsa files are not recognized (#22047)

Problem: Elsa files are not recognized.
Solution: Add the name of Elsa files. (Amaan Qureshi)

https://github.com/vim/vim/commit/2a99fe6c41efcd5d1eb47823e7e73cf391e230ba
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 0a26e363d5..1e7b85060e 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -332,6 +332,7 @@ local extension = {
   am = 'elf',
   exs = 'elixir',
   elm = 'elm',
+  lc = 'elsa',
   elv = 'elvish',
   ent = function(path, bufnr)
     return require('vim.filetype.detect').ent(bufnr)
-- 
cgit 


From b649a96fc09fa7f18a988b0b0be5dadb54ad49de Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Tue, 31 Jan 2023 08:12:10 +0100
Subject: vim-patch:9.0.1263: KDL files are not recognized (#22058)

Problem:    KDL files are not recognized.
Solution:   Add a pattern for KDL files. (Amaan Qureshi, closes vim/vim#11898)

https://github.com/vim/vim/commit/907349a74331fc1bc48cf43c1e7d54cb9e0e4fc9

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 1e7b85060e..b356f3d7aa 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -569,6 +569,7 @@ local extension = {
   libsonnet = 'jsonnet',
   jsp = 'jsp',
   jl = 'julia',
+  kdl = 'kdl',
   kv = 'kivy',
   kix = 'kix',
   kts = 'kotlin',
-- 
cgit 


From d6d6ab3f8e77d54c8030c0c18f17d3c72ac4445c Mon Sep 17 00:00:00 2001
From: bfredl <bjorn.linse@gmail.com>
Date: Sat, 26 Feb 2022 15:19:10 +0100
Subject: feat(lua): low-level interpreter mode (nvim -ll)

---
 runtime/lua/vim/_init_packages.lua | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_init_packages.lua b/runtime/lua/vim/_init_packages.lua
index 0c4ee8636d..e3a442af5e 100644
--- a/runtime/lua/vim/_init_packages.lua
+++ b/runtime/lua/vim/_init_packages.lua
@@ -42,8 +42,11 @@ function vim._load_package(name)
   return nil
 end
 
--- Insert vim._load_package after the preloader at position 2
-table.insert(package.loaders, 2, vim._load_package)
+-- TODO(bfredl): dedicated state for this?
+if vim.api then
+  -- Insert vim._load_package after the preloader at position 2
+  table.insert(package.loaders, 2, vim._load_package)
+end
 
 -- builtin functions which always should be available
 require('vim.shared')
@@ -78,6 +81,6 @@ function vim.empty_dict()
 end
 
 -- only on main thread: functions for interacting with editor state
-if not vim.is_thread() then
+if vim.api and not vim.is_thread() then
   require('vim._editor')
 end
-- 
cgit 


From d63ad600e0571ccf07eed1e841e8519da7d4af9f Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 1 Feb 2023 10:08:50 +0100
Subject: vim-patch:9.0.1268: .clangd and .stylelintrc files don't get a
 filetype (#22079)

Problem:    .clangd and .stylelintrc files don't get a filetype.
Solution:   Use yaml for .clangd and json for .stylelintrc files. (Mark
            Skelton, closes vim/vim#11916)

https://github.com/vim/vim/commit/9c51798a1f3b79ace5ae0551a8bb122025ac94ed

Co-authored-by: Mark Skelton <mdskelton99@gmail.com>
---
 runtime/lua/vim/filetype.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index b356f3d7aa..d1a84fcecf 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1464,6 +1464,7 @@ local filename = {
   ['Pipfile.lock'] = 'json',
   ['.firebaserc'] = 'json',
   ['.prettierrc'] = 'json',
+  ['.stylelintrc'] = 'json',
   ['.babelrc'] = 'jsonc',
   ['.eslintrc'] = 'jsonc',
   ['.hintrc'] = 'jsonc',
@@ -1699,6 +1700,7 @@ local filename = {
   fglrxrc = 'xml',
   ['/etc/blkid.tab'] = 'xml',
   ['/etc/blkid.tab.old'] = 'xml',
+  ['.clangd'] = 'yaml',
   ['.clang-format'] = 'yaml',
   ['.clang-tidy'] = 'yaml',
   ['/etc/zprofile'] = 'zsh',
-- 
cgit 


From c05b3c3bbdef4018ce70f0c822c4a55654a9c186 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Thu, 2 Feb 2023 17:26:22 +0100
Subject: vim-patch:9.0.1274: FIRRTL files are not recognized (#22102)

Problem:    FIRRTL files are not recognized.
Solution:   Add a pattern for FIRRTL files. (Amaan Qureshi, closes vim/vim#11931)

https://github.com/vim/vim/commit/685bf83b73d0fe6fd36bb2949bebd6aae66a139e

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index d1a84fcecf..8144731b09 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -385,6 +385,7 @@ local extension = {
   ['m4gl'] = 'fgl',
   ['4gl'] = 'fgl',
   ['4gh'] = 'fgl',
+  fir = 'firrtl',
   fish = 'fish',
   focexec = 'focexec',
   fex = 'focexec',
-- 
cgit 


From 9a5678463c96baf3b39cb3083ddf0da87d39aa23 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sat, 4 Feb 2023 14:58:38 +0000
Subject: fix(treesitter): fix most diagnostics

---
 runtime/lua/vim/treesitter.lua              |  73 +++++++++-------
 runtime/lua/vim/treesitter/_meta.lua        |  60 +++++++++++++
 runtime/lua/vim/treesitter/highlighter.lua  |  50 +++++++++--
 runtime/lua/vim/treesitter/languagetree.lua | 128 +++++++++++++++++++---------
 runtime/lua/vim/treesitter/playground.lua   |  36 ++++----
 runtime/lua/vim/treesitter/query.lua        | 109 ++++++++++++++++-------
 6 files changed, 331 insertions(+), 125 deletions(-)
 create mode 100644 runtime/lua/vim/treesitter/_meta.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 582922ecb6..96b1e24ba9 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -3,8 +3,11 @@ local query = require('vim.treesitter.query')
 local language = require('vim.treesitter.language')
 local LanguageTree = require('vim.treesitter.languagetree')
 
+---@type table<integer,LanguageTree>
 local parsers = setmetatable({}, { __mode = 'v' })
 
+---@class TreesitterModule
+---@field highlighter TSHighlighter
 local M = vim.tbl_extend('error', query, language)
 
 M.language_version = vim._ts_get_language_version()
@@ -12,6 +15,7 @@ M.minimum_language_version = vim._ts_get_minimum_language_version()
 
 setmetatable(M, {
   __index = function(t, k)
+    ---@diagnostic disable:no-unknown
     if k == 'highlighter' then
       t[k] = require('vim.treesitter.highlighter')
       return t[k]
@@ -29,21 +33,23 @@ setmetatable(M, {
 ---
 --- It is not recommended to use this; use |get_parser()| instead.
 ---
----@param bufnr string Buffer the parser will be tied to (0 for current buffer)
+---@param bufnr integer Buffer the parser will be tied to (0 for current buffer)
 ---@param lang string Language of the parser
 ---@param opts (table|nil) Options to pass to the created language tree
 ---
----@return LanguageTree |LanguageTree| object to use for parsing
+---@return LanguageTree object to use for parsing
 function M._create_parser(bufnr, lang, opts)
   language.require_language(lang)
   if bufnr == 0 then
-    bufnr = a.nvim_get_current_buf()
+    bufnr = vim.api.nvim_get_current_buf()
   end
 
   vim.fn.bufload(bufnr)
 
   local self = LanguageTree.new(bufnr, lang, opts)
 
+  ---@diagnostic disable:invisible
+
   ---@private
   local function bytes_cb(_, ...)
     self:_on_bytes(...)
@@ -58,12 +64,14 @@ function M._create_parser(bufnr, lang, opts)
   end
 
   ---@private
-  local function reload_cb(_, ...)
-    self:_on_reload(...)
+  local function reload_cb(_)
+    self:_on_reload()
   end
 
+  local source = self:source() --[[@as integer]]
+
   a.nvim_buf_attach(
-    self:source(),
+    source,
     false,
     { on_bytes = bytes_cb, on_detach = detach_cb, on_reload = reload_cb, preview = true }
   )
@@ -77,11 +85,11 @@ end
 ---
 --- If needed, this will create the parser.
 ---
----@param bufnr (number|nil) Buffer the parser should be tied to (default: current buffer)
+---@param bufnr (integer|nil) Buffer the parser should be tied to (default: current buffer)
 ---@param lang (string|nil) Filetype of this parser (default: buffer filetype)
 ---@param opts (table|nil) Options to pass to the created language tree
 ---
----@return LanguageTree |LanguageTree| object to use for parsing
+---@return LanguageTree object to use for parsing
 function M.get_parser(bufnr, lang, opts)
   opts = opts or {}
 
@@ -107,7 +115,7 @@ end
 ---@param lang string Language of this string
 ---@param opts (table|nil) Options to pass to the created language tree
 ---
----@return LanguageTree |LanguageTree| object to use for parsing
+---@return LanguageTree object to use for parsing
 function M.get_string_parser(str, lang, opts)
   vim.validate({
     str = { str, 'string' },
@@ -120,8 +128,8 @@ end
 
 --- Determines whether a node is the ancestor of another
 ---
----@param dest userdata Possible ancestor |tsnode|
----@param source userdata Possible descendant |tsnode|
+---@param dest TSNode Possible ancestor
+---@param source TSNode Possible descendant
 ---
 ---@return boolean True if {dest} is an ancestor of {source}
 function M.is_ancestor(dest, source)
@@ -143,9 +151,12 @@ end
 
 --- Returns the node's range or an unpacked range table
 ---
----@param node_or_range (userdata|table) |tsnode| or table of positions
+---@param node_or_range (TSNode|table) Node or table of positions
 ---
----@return table `{ start_row, start_col, end_row, end_col }`
+---@return integer start_row
+---@return integer start_col
+---@return integer end_row
+---@return integer end_col
 function M.get_node_range(node_or_range)
   if type(node_or_range) == 'table' then
     return unpack(node_or_range)
@@ -156,9 +167,9 @@ end
 
 --- Determines whether (line, col) position is in node range
 ---
----@param node userdata |tsnode| defining the range
----@param line number Line (0-based)
----@param col number Column (0-based)
+---@param node TSNode defining the range
+---@param line integer Line (0-based)
+---@param col integer Column (0-based)
 ---
 ---@return boolean True if the position is in node range
 function M.is_in_node_range(node, line, col)
@@ -180,7 +191,7 @@ end
 
 --- Determines if a node contains a range
 ---
----@param node userdata |tsnode|
+---@param node TSNode
 ---@param range table
 ---
 ---@return boolean True if the {node} contains the {range}
@@ -197,9 +208,9 @@ end
 --- Each capture is represented by a table containing the capture name as a string as
 --- well as a table of metadata (`priority`, `conceal`, ...; empty if none are defined).
 ---
----@param bufnr number Buffer number (0 for current buffer)
----@param row number Position row
----@param col number Position column
+---@param bufnr integer Buffer number (0 for current buffer)
+---@param row integer Position row
+---@param col integer Position column
 ---
 ---@return table[] List of captures `{ capture = "capture name", metadata = { ... } }`
 function M.get_captures_at_pos(bufnr, row, col)
@@ -250,7 +261,7 @@ end
 
 --- Returns a list of highlight capture names under the cursor
 ---
----@param winnr (number|nil) Window handle or 0 for current window (default)
+---@param winnr (integer|nil) Window handle or 0 for current window (default)
 ---
 ---@return string[] List of capture names
 function M.get_captures_at_cursor(winnr)
@@ -271,14 +282,14 @@ end
 
 --- Returns the smallest named node at the given position
 ---
----@param bufnr number Buffer number (0 for current buffer)
----@param row number Position row
----@param col number Position column
+---@param bufnr integer Buffer number (0 for current buffer)
+---@param row integer Position row
+---@param col integer Position column
 ---@param opts table Optional keyword arguments:
 ---             - lang string|nil Parser language
 ---             - ignore_injections boolean Ignore injected languages (default true)
 ---
----@return userdata|nil |tsnode| under the cursor
+---@return TSNode|nil under the cursor
 function M.get_node_at_pos(bufnr, row, col, opts)
   if bufnr == 0 then
     bufnr = a.nvim_get_current_buf()
@@ -295,7 +306,7 @@ end
 
 --- Returns the smallest named node under the cursor
 ---
----@param winnr (number|nil) Window handle or 0 for current window (default)
+---@param winnr (integer|nil) Window handle or 0 for current window (default)
 ---
 ---@return string Name of node under the cursor
 function M.get_node_at_cursor(winnr)
@@ -323,7 +334,7 @@ end
 --- })
 --- </pre>
 ---
----@param bufnr (number|nil) Buffer to be highlighted (default: current buffer)
+---@param bufnr (integer|nil) Buffer to be highlighted (default: current buffer)
 ---@param lang (string|nil) Language of the parser (default: buffer filetype)
 function M.start(bufnr, lang)
   bufnr = bufnr or a.nvim_get_current_buf()
@@ -333,7 +344,7 @@ end
 
 --- Stops treesitter highlighting for a buffer
 ---
----@param bufnr (number|nil) Buffer to stop highlighting (default: current buffer)
+---@param bufnr (integer|nil) Buffer to stop highlighting (default: current buffer)
 function M.stop(bufnr)
   bufnr = bufnr or a.nvim_get_current_buf()
 
@@ -351,13 +362,13 @@ end
 ---@param opts table|nil Optional options table with the following possible keys:
 ---                      - lang (string|nil): The language of the source buffer. If omitted, the
 ---                        filetype of the source buffer is used.
----                      - bufnr (number|nil): Buffer to draw the tree into. If omitted, a new
+---                      - bufnr (integer|nil): Buffer to draw the tree into. If omitted, a new
 ---                        buffer is created.
----                      - winid (number|nil): Window id to display the tree buffer in. If omitted,
+---                      - winid (integer|nil): Window id to display the tree buffer in. If omitted,
 ---                        a new window is created with {command}.
 ---                      - command (string|nil): Vimscript command to create the window. Default
 ---                        value is "topleft 60vnew". Only used when {winid} is nil.
----                      - title (string|fun(bufnr:number):string|nil): Title of the window. If a
+---                      - title (string|fun(bufnr:integer):string|nil): Title of the window. If a
 ---                        function, it accepts the buffer number of the source buffer as its only
 ---                        argument and should return a string.
 function M.show_tree(opts)
diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
new file mode 100644
index 0000000000..87b4560798
--- /dev/null
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -0,0 +1,60 @@
+---@meta
+
+---@class TSNode
+---@field id fun(self: TSNode): integer
+---@field range fun(self: TSNode): integer, integer, integer, integer
+---@field start fun(self: TSNode): integer, integer, integer
+---@field end_ fun(self: TSNode): integer, integer, integer
+---@field type fun(self: TSNode): string
+---@field symbol fun(self: TSNode): integer
+---@field named fun(self: TSNode): boolean
+---@field missing fun(self: TSNode): boolean
+---@field child_count fun(self: TSNode): integer
+---@field named_child_count fun(self: TSNode): integer
+---@field child fun(self: TSNode, integer): TSNode
+---@field name_child fun(self: TSNode, integer): TSNode
+---@field descendant_for_range fun(self: TSNode, integer, integer, integer, integer): TSNode
+---@field named_descendant_for_range fun(self: TSNode, integer, integer, integer, integer): TSNode
+---@field parent fun(self: TSNode): TSNode
+---@field next_sibling fun(self: TSNode): TSNode
+---@field prev_sibling fun(self: TSNode): TSNode
+---@field next_named_sibling fun(self: TSNode): TSNode
+---@field prev_named_sibling fun(self: TSNode): TSNode
+---@field named_children fun(self: TSNode): TSNode[]
+---@field has_error fun(self: TSNode): boolean
+---@field iter_children fun(self: TSNode): fun(): TSNode, string
+local TSNode = {}
+
+---@param query userdata
+---@param captures true
+---@param start integer
+---@param end_ integer
+---@return fun(): integer, TSNode, any
+function TSNode:_rawquery(query, captures, start, end_) end
+
+---@param query userdata
+---@param captures false
+---@param start integer
+---@param end_ integer
+---@return fun(): string, any
+function TSNode:_rawquery(query, captures, start, end_) end
+
+---@class TSParser
+---@field parse fun(self: TSParser, tree, source: integer|string): TSTree, integer[]
+---@field included_ranges fun(self: TSParser): integer[]
+---@field set_included_ranges fun(self: TSParser, ranges: integer[][])
+
+---@class TSTree
+---@field root fun(self: TSTree): TSNode
+---@field edit fun(self: TSTree, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _:integer)
+---@field copy fun(self: TSTree): TSTree
+
+---@return integer
+vim._ts_get_language_version = function() end
+
+---@return integer
+vim._ts_get_minimum_language_version = function() end
+
+---@param lang string
+---@return TSParser
+vim._create_ts_parser = function(lang) end
diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index d77a0d0d03..8adaa4ef2f 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -1,13 +1,27 @@
 local a = vim.api
 local query = require('vim.treesitter.query')
 
--- support reload for quick experimentation
+---@alias TSHlIter fun(): integer, TSNode, TSMetadata
+
+---@class TSHighlightState
+---@field next_row integer
+---@field iter TSHlIter|nil
+
 ---@class TSHighlighter
+---@field active table<integer,TSHighlighter>
+---@field bufnr integer
+---@field orig_spelloptions string
+---@field _highlight_states table<TSTree,TSHighlightState>
+---@field _queries table<string,TSHighlighterQuery>
+---@field tree LanguageTree
 local TSHighlighter = rawget(vim.treesitter, 'TSHighlighter') or {}
 TSHighlighter.__index = TSHighlighter
 
 TSHighlighter.active = TSHighlighter.active or {}
 
+---@class TSHighlighterQuery
+---@field _query Query|nil
+---@field hl_cache table<integer,integer>
 local TSHighlighterQuery = {}
 TSHighlighterQuery.__index = TSHighlighterQuery
 
@@ -46,7 +60,7 @@ end
 
 --- Creates a new highlighter using @param tree
 ---
----@param tree LanguageTree |LanguageTree| parser object to use for highlighting
+---@param tree LanguageTree parser object to use for highlighting
 ---@param opts (table|nil) Configuration of the highlighter:
 ---           - queries table overwrite queries used by the highlighter
 ---@return TSHighlighter Created highlighter object
@@ -57,9 +71,10 @@ function TSHighlighter.new(tree, opts)
     error('TSHighlighter can not be used with a string parser source.')
   end
 
-  opts = opts or {}
+  opts = opts or {} ---@type { queries: table<string,string> }
   self.tree = tree
   tree:register_cbs({
+    ---@diagnostic disable:invisible
     on_changedtree = function(...)
       self:on_changedtree(...)
     end,
@@ -67,17 +82,20 @@ function TSHighlighter.new(tree, opts)
       self:on_bytes(...)
     end,
     on_detach = function(...)
+      ---@diagnostic disable-next-line:redundant-parameter
       self:on_detach(...)
     end,
   })
 
-  self.bufnr = tree:source()
+  self.bufnr = tree:source() --[[@as integer]]
   self.edit_count = 0
   self.redraw_count = 0
   self.line_count = {}
   -- A map of highlight states.
   -- This state is kept during rendering across each line update.
   self._highlight_states = {}
+
+  ---@type table<string,TSHighlighterQuery>
   self._queries = {}
 
   -- Queries for a specific language can be overridden by a custom
@@ -128,6 +146,8 @@ function TSHighlighter:destroy()
 end
 
 ---@private
+---@param tstree TSTree
+---@return TSHighlightState
 function TSHighlighter:get_highlight_state(tstree)
   if not self._highlight_states[tstree] then
     self._highlight_states[tstree] = {
@@ -145,6 +165,8 @@ function TSHighlighter:reset_highlight_state()
 end
 
 ---@private
+---@param start_row integer
+---@param new_end integer
 function TSHighlighter:on_bytes(_, _, start_row, _, _, _, _, _, new_end)
   a.nvim__buf_redraw_range(self.bufnr, start_row, start_row + new_end + 1)
 end
@@ -155,6 +177,7 @@ function TSHighlighter:on_detach()
 end
 
 ---@private
+---@param changes integer[][]?
 function TSHighlighter:on_changedtree(changes)
   for _, ch in ipairs(changes or {}) do
     a.nvim__buf_redraw_range(self.bufnr, ch[1], ch[3] + 1)
@@ -165,7 +188,7 @@ end
 --
 ---@private
 ---@param lang string Language used by the highlighter.
----@return Query
+---@return TSHighlighterQuery
 function TSHighlighter:get_query(lang)
   if not self._queries[lang] then
     self._queries[lang] = TSHighlighterQuery.new(lang)
@@ -175,7 +198,12 @@ function TSHighlighter:get_query(lang)
 end
 
 ---@private
+---@param self TSHighlighter
+---@param buf integer
+---@param line integer
+---@param is_spell_nav boolean
 local function on_line_impl(self, buf, line, is_spell_nav)
+  ---@diagnostic disable:invisible
   self.tree:for_each_tree(function(tstree, tree)
     if not tstree then
       return
@@ -213,7 +241,7 @@ local function on_line_impl(self, buf, line, is_spell_nav)
       local hl = highlighter_query.hl_cache[capture]
 
       local capture_name = highlighter_query:query().captures[capture]
-      local spell = nil
+      local spell = nil ---@type boolean?
       if capture_name == 'spell' then
         spell = true
       elseif capture_name == 'nospell' then
@@ -242,6 +270,9 @@ local function on_line_impl(self, buf, line, is_spell_nav)
 end
 
 ---@private
+---@param _win integer
+---@param buf integer
+---@param line integer
 function TSHighlighter._on_line(_, _win, buf, line, _)
   local self = TSHighlighter.active[buf]
   if not self then
@@ -252,6 +283,9 @@ function TSHighlighter._on_line(_, _win, buf, line, _)
 end
 
 ---@private
+---@param buf integer
+---@param srow integer
+---@param erow integer
 function TSHighlighter._on_spell_nav(_, _, buf, srow, _, erow, _)
   local self = TSHighlighter.active[buf]
   if not self then
@@ -266,6 +300,7 @@ function TSHighlighter._on_spell_nav(_, _, buf, srow, _, erow, _)
 end
 
 ---@private
+---@param buf integer
 function TSHighlighter._on_buf(_, buf)
   local self = TSHighlighter.active[buf]
   if self then
@@ -274,6 +309,9 @@ function TSHighlighter._on_buf(_, buf)
 end
 
 ---@private
+---@param _win integer
+---@param buf integer
+---@param _topline integer
 function TSHighlighter._on_win(_, _win, buf, _topline)
   local self = TSHighlighter.active[buf]
   if not self then
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index a1e96f8ef2..89aac3ae26 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -2,20 +2,39 @@ local a = vim.api
 local query = require('vim.treesitter.query')
 local language = require('vim.treesitter.language')
 
----@class LanguageTree
----@field _callbacks function[] Callback handlers
----@field _children LanguageTree[] Injected languages
----@field _injection_query table Queries defining injected languages
----@field _opts table Options
----@field _parser userdata Parser for language
----@field _regions table List of regions this tree should manage and parse
----@field _lang string Language name
----@field _regions table
----@field _source (number|string) Buffer or string to parse
----@field _trees userdata[] Reference to parsed |tstree| (one for each language)
----@field _valid boolean If the parsed tree is valid
+---@alias Range {[1]: integer, [2]: integer, [3]: integer, [4]: integer}
+--
+---@alias TSCallbackName
+---| 'changedtree'
+---| 'bytes'
+---| 'detach'
+---| 'child_added'
+---| 'child_removed'
+
+---@alias TSCallbackNameOn
+---| 'on_changedtree'
+---| 'on_bytes'
+---| 'on_detach'
+---| 'on_child_added'
+---| 'on_child_removed'
 
+---@class LanguageTree
+---@field private _callbacks table<TSCallbackName,function[]> Callback handlers
+---@field private _children table<string,LanguageTree> Injected languages
+---@field private _injection_query Query Queries defining injected languages
+---@field private _opts table Options
+---@field private _parser TSParser Parser for language
+---@field private _regions Range[][] List of regions this tree should manage and parse
+---@field private _lang string Language name
+---@field private _source (integer|string) Buffer or string to parse
+---@field private _trees TSTree[] Reference to parsed tree (one for each language)
+---@field private _valid boolean If the parsed tree is valid
 local LanguageTree = {}
+
+---@class LanguageTreeOpts
+---@field queries table<string,string>  -- Deprecated
+---@field injections table<string,string>
+
 LanguageTree.__index = LanguageTree
 
 --- A |LanguageTree| holds the treesitter parser for a given language {lang} used
@@ -23,16 +42,17 @@ LanguageTree.__index = LanguageTree
 --- needs to store parsers for these child languages as well (which in turn may contain
 --- child languages themselves, hence the name).
 ---
----@param source (number|string) Buffer or a string of text to parse
+---@param source (integer|string) Buffer or a string of text to parse
 ---@param lang string Root language this tree represents
 ---@param opts (table|nil) Optional keyword arguments:
 ---             - injections table Mapping language to injection query strings.
 ---                                This is useful for overriding the built-in
 ---                                runtime file searching for the injection language
 ---                                query per language.
----@return LanguageTree |LanguageTree| parser object
+---@return LanguageTree parser object
 function LanguageTree.new(source, lang, opts)
   language.require_language(lang)
+  ---@type LanguageTreeOpts
   opts = opts or {}
 
   if opts.queries then
@@ -65,6 +85,7 @@ function LanguageTree.new(source, lang, opts)
 end
 
 --- Invalidates this parser and all its children
+---@param reload boolean|nil
 function LanguageTree:invalidate(reload)
   self._valid = false
 
@@ -73,7 +94,7 @@ function LanguageTree:invalidate(reload)
     self._trees = {}
   end
 
-  for _, child in ipairs(self._children) do
+  for _, child in pairs(self._children) do
     child:invalidate(reload)
   end
 end
@@ -111,8 +132,8 @@ end
 --- This will run the injection query for this language to
 --- determine if any child languages should be created.
 ---
----@return userdata[] Table of parsed |tstree|
----@return table Change list
+---@return TSTree[]
+---@return table|nil Change list
 function LanguageTree:parse()
   if self._valid then
     return self._trees
@@ -146,7 +167,7 @@ function LanguageTree:parse()
   end
 
   local injections_by_lang = self:_get_injections()
-  local seen_langs = {}
+  local seen_langs = {} ---@type table<string,boolean>
 
   for lang, injection_ranges in pairs(injections_by_lang) do
     local has_lang = language.require_language(lang, nil, true)
@@ -188,8 +209,8 @@ end
 
 --- Invokes the callback for each |LanguageTree| and its children recursively
 ---
----@param fn function(tree: LanguageTree, lang: string)
----@param include_self boolean Whether to include the invoking tree in the results
+---@param fn fun(tree: LanguageTree, lang: string)
+---@param include_self boolean|nil Whether to include the invoking tree in the results
 function LanguageTree:for_each_child(fn, include_self)
   if include_self then
     fn(self, self._lang)
@@ -204,7 +225,7 @@ end
 ---
 --- Note: This includes the invoking tree's child trees as well.
 ---
----@param fn function(tree: TSTree, languageTree: LanguageTree)
+---@param fn fun(tree: TSTree, ltree: LanguageTree)
 function LanguageTree:for_each_tree(fn)
   for _, tree in ipairs(self._trees) do
     fn(tree, self)
@@ -221,7 +242,7 @@ end
 ---
 ---@private
 ---@param lang string Language to add.
----@return LanguageTree Injected |LanguageTree|
+---@return LanguageTree injected
 function LanguageTree:add_child(lang)
   if self._children[lang] then
     self:remove_child(lang)
@@ -258,7 +279,7 @@ end
 --- `remove_child` must be called on the parent to remove it.
 function LanguageTree:destroy()
   -- Cleanup here
-  for _, child in ipairs(self._children) do
+  for _, child in pairs(self._children) do
     child:destroy()
   end
 end
@@ -280,20 +301,22 @@ end
 --- Note: This call invalidates the tree and requires it to be parsed again.
 ---
 ---@private
----@param regions table List of regions this tree should manage and parse.
+---@param regions integer[][][] List of regions this tree should manage and parse.
 function LanguageTree:set_included_regions(regions)
   -- Transform the tables from 4 element long to 6 element long (with byte offset)
   for _, region in ipairs(regions) do
     for i, range in ipairs(region) do
       if type(range) == 'table' and #range == 4 then
+        ---@diagnostic disable-next-line:no-unknown
         local start_row, start_col, end_row, end_col = unpack(range)
         local start_byte = 0
         local end_byte = 0
+        local source = self._source
         -- TODO(vigoux): proper byte computation here, and account for EOL ?
-        if type(self._source) == 'number' then
+        if type(source) == 'number' then
           -- Easy case, this is a buffer parser
-          start_byte = a.nvim_buf_get_offset(self._source, start_row) + start_col
-          end_byte = a.nvim_buf_get_offset(self._source, end_row) + end_col
+          start_byte = a.nvim_buf_get_offset(source, start_row) + start_col
+          end_byte = a.nvim_buf_get_offset(source, end_row) + end_col
         elseif type(self._source) == 'string' then
           -- string parser, single `\n` delimited string
           start_byte = vim.fn.byteidx(self._source, start_col)
@@ -320,9 +343,13 @@ function LanguageTree:included_regions()
 end
 
 ---@private
+---@param node TSNode
+---@param id integer
+---@param metadata TSMetadata
+---@return Range
 local function get_range_from_metadata(node, id, metadata)
   if metadata[id] and metadata[id].range then
-    return metadata[id].range
+    return metadata[id].range --[[@as Range]]
   end
   return { node:range() }
 end
@@ -334,11 +361,13 @@ end
 --- TODO: Allow for an offset predicate to tailor the injection range
 ---       instead of using the entire nodes range.
 ---@private
+---@return table<string, integer[][]>
 function LanguageTree:_get_injections()
   if not self._injection_query then
     return {}
   end
 
+  ---@type table<integer,table<string,table<integer,table>>>
   local injections = {}
 
   for tree_index, tree in ipairs(self._trees) do
@@ -348,14 +377,14 @@ function LanguageTree:_get_injections()
     for pattern, match, metadata in
       self._injection_query:iter_matches(root_node, self._source, start_line, end_line + 1)
     do
-      local lang = nil
-      local ranges = {}
-      local combined = metadata.combined
+      local lang = nil ---@type string
+      local ranges = {} ---@type Range[]
+      local combined = metadata.combined ---@type boolean
 
       -- Directives can configure how injections are captured as well as actual node captures.
       -- This allows more advanced processing for determining ranges and language resolution.
       if metadata.content then
-        local content = metadata.content
+        local content = metadata.content ---@type any
 
         -- Allow for captured nodes to be used
         if type(content) == 'number' then
@@ -368,7 +397,7 @@ function LanguageTree:_get_injections()
       end
 
       if metadata.language then
-        lang = metadata.language
+        lang = metadata.language ---@type string
       end
 
       -- You can specify the content and language together
@@ -379,7 +408,7 @@ function LanguageTree:_get_injections()
 
         -- Lang should override any other language tag
         if name == 'language' and not lang then
-          lang = query.get_node_text(node, self._source)
+          lang = query.get_node_text(node, self._source) --[[@as string]]
         elseif name == 'combined' then
           combined = true
         elseif name == 'content' and #ranges == 0 then
@@ -417,6 +446,7 @@ function LanguageTree:_get_injections()
     end
   end
 
+  ---@type table<string,Range[][]>
   local result = {}
 
   -- Generate a map by lang of node lists.
@@ -429,11 +459,13 @@ function LanguageTree:_get_injections()
 
       for _, entry in pairs(patterns) do
         if entry.combined then
+          ---@diagnostic disable-next-line:no-unknown
           local regions = vim.tbl_map(function(e)
             return vim.tbl_flatten(e)
           end, entry.regions)
           table.insert(result[lang], regions)
         else
+          ---@diagnostic disable-next-line:no-unknown
           for _, ranges in ipairs(entry.regions) do
             table.insert(result[lang], ranges)
           end
@@ -446,6 +478,7 @@ function LanguageTree:_get_injections()
 end
 
 ---@private
+---@param cb_name TSCallbackName
 function LanguageTree:_do_callback(cb_name, ...)
   for _, cb in ipairs(self._callbacks[cb_name]) do
     cb(...)
@@ -453,6 +486,17 @@ function LanguageTree:_do_callback(cb_name, ...)
 end
 
 ---@private
+---@param bufnr integer
+---@param changed_tick integer
+---@param start_row integer
+---@param start_col integer
+---@param start_byte integer
+---@param old_row integer
+---@param old_col integer
+---@param old_byte integer
+---@param new_row integer
+---@param new_col integer
+---@param new_byte integer
 function LanguageTree:_on_bytes(
   bufnr,
   changed_tick,
@@ -523,6 +567,7 @@ end
 ---           - `on_child_added` : emitted when a child is added to the tree.
 ---           - `on_child_removed` : emitted when a child is removed from the tree.
 function LanguageTree:register_cbs(cbs)
+  ---@cast cbs table<TSCallbackNameOn,function>
   if not cbs then
     return
   end
@@ -549,6 +594,9 @@ function LanguageTree:register_cbs(cbs)
 end
 
 ---@private
+---@param tree TSTree
+---@param range Range
+---@return boolean
 local function tree_contains(tree, range)
   local start_row, start_col, end_row, end_col = tree:root():range()
   local start_fits = start_row < range[1] or (start_row == range[1] and start_col <= range[2])
@@ -559,7 +607,7 @@ end
 
 --- Determines whether {range} is contained in the |LanguageTree|.
 ---
----@param range table `{ start_line, start_col, end_line, end_col }`
+---@param range Range `{ start_line, start_col, end_line, end_col }`
 ---@return boolean
 function LanguageTree:contains(range)
   for _, tree in pairs(self._trees) do
@@ -573,10 +621,10 @@ end
 
 --- Gets the tree that contains {range}.
 ---
----@param range table `{ start_line, start_col, end_line, end_col }`
+---@param range Range `{ start_line, start_col, end_line, end_col }`
 ---@param opts table|nil Optional keyword arguments:
 ---             - ignore_injections boolean Ignore injected languages (default true)
----@return userdata|nil Contained |tstree|
+---@return TSTree|nil
 function LanguageTree:tree_for_range(range, opts)
   opts = opts or {}
   local ignore = vim.F.if_nil(opts.ignore_injections, true)
@@ -602,10 +650,10 @@ end
 
 --- Gets the smallest named node that contains {range}.
 ---
----@param range table `{ start_line, start_col, end_line, end_col }`
+---@param range Range `{ start_line, start_col, end_line, end_col }`
 ---@param opts table|nil Optional keyword arguments:
 ---             - ignore_injections boolean Ignore injected languages (default true)
----@return userdata|nil Found |tsnode|
+---@return TSNode|nil Found node
 function LanguageTree:named_node_for_range(range, opts)
   local tree = self:tree_for_range(range, opts)
   if tree then
@@ -615,7 +663,7 @@ end
 
 --- Gets the appropriate language that contains {range}.
 ---
----@param range table `{ start_line, start_col, end_line, end_col }`
+---@param range Range `{ start_line, start_col, end_line, end_col }`
 ---@return LanguageTree Managing {range}
 function LanguageTree:language_for_range(range)
   for _, child in pairs(self._children) do
diff --git a/runtime/lua/vim/treesitter/playground.lua b/runtime/lua/vim/treesitter/playground.lua
index bb073290c6..be7764e6f0 100644
--- a/runtime/lua/vim/treesitter/playground.lua
+++ b/runtime/lua/vim/treesitter/playground.lua
@@ -1,12 +1,13 @@
 local api = vim.api
 
-local M = {}
-
----@class Playground
+---@class TSPlayground
 ---@field ns number API namespace
 ---@field opts table Options table with the following keys:
 ---                  - anon (boolean): If true, display anonymous nodes
 ---                  - lang (boolean): If true, display the language alongside each node
+---@field nodes Node[]
+---@field named Node[]
+local TSPlayground = {}
 ---
 ---@class Node
 ---@field id number Node id
@@ -18,6 +19,7 @@ local M = {}
 ---@field end_lnum number Final line number of this node in the source buffer
 ---@field end_col number Final column number of this node in the source buffer
 ---@field lang string Source language of this node
+---@field root TSNode
 
 --- Traverse all child nodes starting at {node}.
 ---
@@ -31,10 +33,10 @@ local M = {}
 --- node of each of these trees is contained within a node in the primary tree. The {injections}
 --- table maps nodes in the primary tree to root nodes of injected trees.
 ---
----@param node userdata Starting node to begin traversal |tsnode|
+---@param node TSNode Starting node to begin traversal |tsnode|
 ---@param depth number Current recursion depth
 ---@param lang string Language of the tree currently being traversed
----@param injections table Mapping of node ids to root nodes of injected language trees (see
+---@param injections table<integer,Node> Mapping of node ids to root nodes of injected language trees (see
 ---                        explanation above)
 ---@param tree Node[] Output table containing a list of tables each representing a node in the tree
 ---@private
@@ -48,7 +50,7 @@ local function traverse(node, depth, lang, injections, tree)
     local type = child:type()
     local lnum, col, end_lnum, end_col = child:range()
     local named = child:named()
-    local text
+    local text ---@type string
     if named then
       if field then
         text = string.format('%s: (%s)', field, type)
@@ -79,14 +81,14 @@ end
 
 --- Create a new Playground object.
 ---
----@param bufnr number Source buffer number
+---@param bufnr integer Source buffer number
 ---@param lang string|nil Language of source buffer
 ---
----@return Playground|nil
+---@return TSPlayground|nil
 ---@return string|nil Error message, if any
 ---
 ---@private
-function M.new(self, bufnr, lang)
+function TSPlayground:new(bufnr, lang)
   local ok, parser = pcall(vim.treesitter.get_parser, bufnr or 0, lang)
   if not ok then
     return nil, 'No parser available for the given buffer'
@@ -96,7 +98,7 @@ function M.new(self, bufnr, lang)
   -- the primary tree that contains that root. Add a mapping from the node in the primary tree to
   -- the root in the child tree to the {injections} table.
   local root = parser:parse()[1]:root()
-  local injections = {}
+  local injections = {} ---@type table<integer,table>
   parser:for_each_child(function(child, lang_)
     child:for_each_tree(function(tree)
       local r = tree:root()
@@ -112,7 +114,7 @@ function M.new(self, bufnr, lang)
 
   local nodes = traverse(root, 0, parser:lang(), injections, {})
 
-  local named = {}
+  local named = {} ---@type Node[]
   for _, v in ipairs(nodes) do
     if v.named then
       named[#named + 1] = v
@@ -138,9 +140,9 @@ end
 ---
 ---@param bufnr number Buffer number to write into.
 ---@private
-function M.draw(self, bufnr)
+function TSPlayground:draw(bufnr)
   vim.bo[bufnr].modifiable = true
-  local lines = {}
+  local lines = {} ---@type string[]
   for _, item in self:iter() do
     lines[#lines + 1] = table.concat({
       string.rep(' ', item.depth),
@@ -168,19 +170,19 @@ end
 ---@param i number Node number to get
 ---@return Node
 ---@private
-function M.get(self, i)
+function TSPlayground:get(i)
   local t = self.opts.anon and self.nodes or self.named
   return t[i]
 end
 
 --- Iterate over all of the nodes in this Playground object.
 ---
----@return function Iterator over all nodes in this Playground
+---@return (fun(): integer, Node) Iterator over all nodes in this Playground
 ---@return table
 ---@return number
 ---@private
-function M.iter(self)
+function TSPlayground:iter()
   return ipairs(self.opts.anon and self.nodes or self.named)
 end
 
-return M
+return TSPlayground
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index dbf134573d..84ed2667b9 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -1,21 +1,25 @@
 local a = vim.api
 local language = require('vim.treesitter.language')
 
--- query: pattern matching on trees
--- predicate matching is implemented in lua
---
 ---@class Query
 ---@field captures string[] List of captures used in query
----@field info table Contains used queries, predicates, directives
+---@field info TSQueryInfo Contains used queries, predicates, directives
 ---@field query userdata Parsed query
 local Query = {}
 Query.__index = Query
 
+---@class TSQueryInfo
+---@field captures table
+---@field patterns table<string,any[][]>
+
 local M = {}
 
 ---@private
+---@param files string[]
+---@return string[]
 local function dedupe_files(files)
   local result = {}
+  ---@type table<string,boolean>
   local seen = {}
 
   for _, path in ipairs(files) do
@@ -65,10 +69,10 @@ function M.get_query_files(lang, query_name, is_included)
     return {}
   end
 
-  local base_query = nil
+  local base_query = nil ---@type string?
   local extensions = {}
 
-  local base_langs = {}
+  local base_langs = {} ---@type string[]
 
   -- Now get the base languages by looking at the first line of every file
   -- The syntax is the following :
@@ -87,6 +91,7 @@ function M.get_query_files(lang, query_name, is_included)
     local extension = false
 
     for modeline in
+      ---@return string
       function()
         return file:read('*l')
       end
@@ -97,6 +102,7 @@ function M.get_query_files(lang, query_name, is_included)
 
       local langlist = modeline:match(MODELINE_FORMAT)
       if langlist then
+        ---@diagnostic disable-next-line:param-type-mismatch
         for _, incllang in ipairs(vim.split(langlist, ',', true)) do
           local is_optional = incllang:match('%(.*%)')
 
@@ -137,6 +143,8 @@ function M.get_query_files(lang, query_name, is_included)
 end
 
 ---@private
+---@param filenames string[]
+---@return string
 local function read_query_files(filenames)
   local contents = {}
 
@@ -147,7 +155,8 @@ local function read_query_files(filenames)
   return table.concat(contents, '')
 end
 
---- The explicitly set queries from |vim.treesitter.query.set_query()|
+-- The explicitly set queries from |vim.treesitter.query.set_query()|
+---@type table<string,table<string,Query>>
 local explicit_queries = setmetatable({}, {
   __index = function(t, k)
     local lang_queries = {}
@@ -174,7 +183,7 @@ end
 ---@param lang string Language to use for the query
 ---@param query_name string Name of the query (e.g. "highlights")
 ---
----@return Query Parsed query
+---@return Query|nil Parsed query
 function M.get_query(lang, query_name)
   if explicit_queries[lang][query_name] then
     return explicit_queries[lang][query_name]
@@ -188,6 +197,7 @@ function M.get_query(lang, query_name)
   end
 end
 
+---@type {[string]: {[string]: Query}}
 local query_cache = vim.defaulttable(function()
   return setmetatable({}, { __mode = 'v' })
 end)
@@ -226,11 +236,11 @@ end
 
 --- Gets the text corresponding to a given node
 ---
----@param node userdata |tsnode|
+---@param node TSNode
 ---@param source (number|string) Buffer or string from which the {node} is extracted
 ---@param opts (table|nil) Optional parameters.
 ---          - concat: (boolean) Concatenate result in a string (default true)
----@return (string[]|string)
+---@return (string[]|string|nil)
 function M.get_node_text(node, source, opts)
   opts = opts or {}
   local concat = vim.F.if_nil(opts.concat, true)
@@ -239,12 +249,12 @@ function M.get_node_text(node, source, opts)
   local end_row, end_col, end_byte = node:end_()
 
   if type(source) == 'number' then
-    local lines
     local eof_row = a.nvim_buf_line_count(source)
     if start_row >= eof_row then
       return nil
     end
 
+    local lines ---@type string[]
     if end_col == 0 then
       lines = a.nvim_buf_get_lines(source, start_row, end_row, true)
       end_col = -1
@@ -267,8 +277,13 @@ function M.get_node_text(node, source, opts)
   end
 end
 
+---@alias TSMatch table<integer,TSNode>
+
+---@alias TSPredicate fun(match: TSMatch, _, _, predicate: any[]): boolean
+
 -- Predicate handler receive the following arguments
 -- (match, pattern, bufnr, predicate)
+---@type table<string,TSPredicate>
 local predicate_handlers = {
   ['eq?'] = function(match, _, source, predicate)
     local node = match[predicate[2]]
@@ -277,13 +292,13 @@ local predicate_handlers = {
     end
     local node_text = M.get_node_text(node, source)
 
-    local str
+    local str ---@type string
     if type(predicate[3]) == 'string' then
       -- (#eq? @aa "foo")
       str = predicate[3]
     else
       -- (#eq? @aa @bb)
-      str = M.get_node_text(match[predicate[3]], source)
+      str = M.get_node_text(match[predicate[3]], source) --[[@as string]]
     end
 
     if node_text ~= str or str == nil then
@@ -299,7 +314,7 @@ local predicate_handlers = {
       return true
     end
     local regex = predicate[3]
-    return string.find(M.get_node_text(node, source), regex)
+    return string.find(M.get_node_text(node, source) --[[@as string]], regex) ~= nil
   end,
 
   ['match?'] = (function()
@@ -321,10 +336,12 @@ local predicate_handlers = {
     })
 
     return function(match, _, source, pred)
+      ---@cast match TSMatch
       local node = match[pred[2]]
       if not node then
         return true
       end
+      ---@diagnostic disable-next-line no-unknown
       local regex = compiled_vim_regexes[pred[3]]
       return regex:match_str(M.get_node_text(node, source))
     end
@@ -335,7 +352,7 @@ local predicate_handlers = {
     if not node then
       return true
     end
-    local node_text = M.get_node_text(node, source)
+    local node_text = M.get_node_text(node, source) --[[@as string]]
 
     for i = 3, #predicate do
       if string.find(node_text, predicate[i], 1, true) then
@@ -359,6 +376,7 @@ local predicate_handlers = {
     if not string_set then
       string_set = {}
       for i = 3, #predicate do
+        ---@diagnostic disable-next-line:no-unknown
         string_set[predicate[i]] = true
       end
       predicate['string_set'] = string_set
@@ -371,21 +389,39 @@ local predicate_handlers = {
 -- As we provide lua-match? also expose vim-match?
 predicate_handlers['vim-match?'] = predicate_handlers['match?']
 
+---@class TSMetadata
+---@field [integer] TSMetadata
+---@field [string] integer|string
+---@field range Range
+
+---@alias TSDirective fun(match: TSMatch, _, _, predicate: any[], metadata: TSMetadata)
+
+-- Predicate handler receive the following arguments
+-- (match, pattern, bufnr, predicate)
+
 -- Directives store metadata or perform side effects against a match.
 -- Directives should always end with a `!`.
 -- Directive handler receive the following arguments
 -- (match, pattern, bufnr, predicate, metadata)
+---@type table<string,TSDirective>
 local directive_handlers = {
   ['set!'] = function(_, _, _, pred, metadata)
     if #pred == 4 then
       -- (#set! @capture "key" "value")
+      ---@diagnostic disable-next-line:no-unknown
       local _, capture_id, key, value = unpack(pred)
+      ---@cast value integer|string
+      ---@cast capture_id integer
+      ---@cast key string
       if not metadata[capture_id] then
         metadata[capture_id] = {}
       end
       metadata[capture_id][key] = value
     else
+      ---@diagnostic disable-next-line:no-unknown
       local _, key, value = unpack(pred)
+      ---@cast value integer|string
+      ---@cast key string
       -- (#set! "key" "value")
       metadata[key] = value
     end
@@ -393,9 +429,11 @@ local directive_handlers = {
   -- Shifts the range of a node.
   -- Example: (#offset! @_node 0 1 0 -1)
   ['offset!'] = function(match, _, _, pred, metadata)
+    ---@cast pred integer[]
     local capture_id = pred[2]
     local offset_node = match[capture_id]
     local range = { offset_node:range() }
+    ---@cast range integer[] bug in sumneko
     local start_row_offset = pred[3] or 0
     local start_col_offset = pred[4] or 0
     local end_row_offset = pred[5] or 0
@@ -419,8 +457,9 @@ local directive_handlers = {
 --- Adds a new predicate to be used in queries
 ---
 ---@param name string Name of the predicate, without leading #
----@param handler function(match:table, pattern:string, bufnr:number, predicate:string[])
+---@param handler function(match:table<string,TSNode>, pattern:string, bufnr:number, predicate:string[])
 ---   - see |vim.treesitter.query.add_directive()| for argument meanings
+---@param force boolean
 function M.add_predicate(name, handler, force)
   if predicate_handlers[name] and not force then
     error(string.format('Overriding %s', name))
@@ -437,12 +476,13 @@ end
 --- metadata table `metadata[capture_id].key = value`
 ---
 ---@param name string Name of the directive, without leading #
----@param handler function(match:table, pattern:string, bufnr:number, predicate:string[], metadata:table)
+---@param handler function(match:table<string,TSNode>, pattern:string, bufnr:number, predicate:string[], metadata:table)
 ---   - match: see |treesitter-query|
 ---      - node-level data are accessible via `match[capture_id]`
 ---   - pattern: see |treesitter-query|
 ---   - predicate: list of strings containing the full directive being called, e.g.
 ---     `(node (#set! conceal "-"))` would get the predicate `{ "#set!", "conceal", "-" }`
+---@param force boolean
 function M.add_directive(name, handler, force)
   if directive_handlers[name] and not force then
     error(string.format('Overriding %s', name))
@@ -474,6 +514,9 @@ local function is_directive(name)
 end
 
 ---@private
+---@param match TSMatch
+---@param pattern string
+---@param source integer|string
 function Query:match_preds(match, pattern, source)
   local preds = self.info.patterns[pattern]
 
@@ -482,8 +525,9 @@ function Query:match_preds(match, pattern, source)
     -- continue on the other case. This way unknown predicates will not be considered,
     -- which allows some testing and easier user extensibility (#12173).
     -- Also, tree-sitter strips the leading # from predicates for us.
-    local pred_name
-    local is_not
+    local pred_name ---@type string
+
+    local is_not ---@type boolean
 
     -- Skip over directives... they will get processed after all the predicates.
     if not is_directive(pred[1]) then
@@ -513,6 +557,8 @@ function Query:match_preds(match, pattern, source)
 end
 
 ---@private
+---@param match TSMatch
+---@param metadata TSMetadata
 function Query:apply_directives(match, pattern, source, metadata)
   local preds = self.info.patterns[pattern]
 
@@ -534,6 +580,10 @@ end
 -- When the node's range is used, the stop is incremented by 1
 -- to make the search inclusive.
 ---@private
+---@param start integer
+---@param stop integer
+---@param node TSNode
+---@return integer, integer
 local function value_or_node_range(start, stop, node)
   if start == nil and stop == nil then
     local node_start, _, node_stop, _ = node:range()
@@ -565,14 +615,12 @@ end
 --- end
 --- </pre>
 ---
----@param node userdata |tsnode| under which the search will occur
----@param source (number|string) Source buffer or string to extract text from
+---@param node TSNode under which the search will occur
+---@param source (integer|string) Source buffer or string to extract text from
 ---@param start number Starting line for the search
 ---@param stop number Stopping line for the search (end-exclusive)
 ---
----@return number capture Matching capture id
----@return table capture_node Capture for {node}
----@return table metadata for the {capture}
+---@return (fun(): integer, TSNode, TSMetadata): capture id, capture node, metadata
 function Query:iter_captures(node, source, start, stop)
   if type(source) == 'number' and source == 0 then
     source = vim.api.nvim_get_current_buf()
@@ -622,14 +670,12 @@ end
 --- end
 --- </pre>
 ---
----@param node userdata |tsnode| under which the search will occur
----@param source (number|string) Source buffer or string to search
----@param start number Starting line for the search
----@param stop number Stopping line for the search (end-exclusive)
+---@param node TSNode under which the search will occur
+---@param source (integer|string) Source buffer or string to search
+---@param start integer Starting line for the search
+---@param stop integer Stopping line for the search (end-exclusive)
 ---
----@return number pattern id
----@return table match
----@return table metadata
+---@return (fun(): integer, table<integer,TSNode>, table): pattern id, match, metadata
 function Query:iter_matches(node, source, start, stop)
   if type(source) == 'number' and source == 0 then
     source = vim.api.nvim_get_current_buf()
@@ -638,6 +684,7 @@ function Query:iter_matches(node, source, start, stop)
   start, stop = value_or_node_range(start, stop, node)
 
   local raw_iter = node:_rawquery(self.query, false, start, stop)
+  ---@cast raw_iter fun(): string, any
   local function iter()
     local pattern, match = raw_iter()
     local metadata = {}
-- 
cgit 


From 4b9bb3a1841489a18bbeb124fc11cbf359553ef5 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 4 Feb 2023 16:05:45 +0100
Subject: vim-patch:9.0.1278: go.work.sum files are not recognized (#22121)

Problem:    go.work.sum files are not recognized.
Solution:   Recognize go.work.sum files as the gosum filetype. (Amaan Qureshi,
            closes vim/vim#11940)

https://github.com/vim/vim/commit/4ad8ae8465e30df38dba31910f130891b16d38a0

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 8144731b09..bc30b3bd11 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1433,6 +1433,7 @@ local filename = {
   gnashrc = 'gnash',
   ['.gnuplot'] = 'gnuplot',
   ['go.sum'] = 'gosum',
+  ['go.work.sum'] = 'gosum',
   ['go.work'] = 'gowork',
   ['.gprc'] = 'gp',
   ['/.gnupg/gpg.conf'] = 'gpg',
-- 
cgit 


From bb8845340b1b9c2180fb19f049ff9deff5857d99 Mon Sep 17 00:00:00 2001
From: figsoda <figsoda@pm.me>
Date: Thu, 21 Jul 2022 12:08:37 +0100
Subject: feat(treesitter): allow capture text to be transformed

Co-authored-by: Lewis Russell <lewis6991@gmail.com>
---
 runtime/lua/vim/treesitter/languagetree.lua | 10 +++++++++-
 runtime/lua/vim/treesitter/query.lua        | 15 +++++++++++++++
 2 files changed, 24 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 89aac3ae26..3e1bc5d1cb 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -354,6 +354,14 @@ local function get_range_from_metadata(node, id, metadata)
   return { node:range() }
 end
 
+---@private
+local function get_node_text(node, id, metadata, source)
+  if metadata[id] and metadata[id].text then
+    return metadata[id].text
+  end
+  return query.get_node_text(node, source)
+end
+
 --- Gets language injection points by language.
 ---
 --- This is where most of the injection processing occurs.
@@ -408,7 +416,7 @@ function LanguageTree:_get_injections()
 
         -- Lang should override any other language tag
         if name == 'language' and not lang then
-          lang = query.get_node_text(node, self._source) --[[@as string]]
+          lang = get_node_text(node, id, metadata, self._source) --[[@as string]]
         elseif name == 'combined' then
           combined = true
         elseif name == 'content' and #ranges == 0 then
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 84ed2667b9..5ec8c67462 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -452,6 +452,21 @@ local directive_handlers = {
       metadata[capture_id].range = range
     end
   end,
+
+  -- Transform the content of the node
+  -- Example: (#gsub! @_node ".*%.(.*)" "%1")
+  ['gsub!'] = function(match, _, bufnr, pred, metadata)
+    assert(#pred == 4)
+
+    local id = pred[2]
+    local node = match[id]
+    local text = M.get_node_text(node, bufnr, { metadata = metadata[id] }) or ''
+
+    if not metadata[id] then
+      metadata[id] = {}
+    end
+    metadata[id].text = text:gsub(pred[3], pred[4])
+  end,
 }
 
 --- Adds a new predicate to be used in queries
-- 
cgit 


From e1d5ad1cb87d43c3d75619e239312d4ab2029b45 Mon Sep 17 00:00:00 2001
From: figsoda <figsoda@pm.me>
Date: Mon, 26 Dec 2022 16:10:59 -0500
Subject: feat(treesitter): add metadata option for get_node_text

---
 runtime/lua/vim/treesitter/languagetree.lua | 10 +----
 runtime/lua/vim/treesitter/query.lua        | 70 +++++++++++++++++------------
 2 files changed, 43 insertions(+), 37 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 3e1bc5d1cb..8255c6f4fe 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -354,14 +354,6 @@ local function get_range_from_metadata(node, id, metadata)
   return { node:range() }
 end
 
----@private
-local function get_node_text(node, id, metadata, source)
-  if metadata[id] and metadata[id].text then
-    return metadata[id].text
-  end
-  return query.get_node_text(node, source)
-end
-
 --- Gets language injection points by language.
 ---
 --- This is where most of the injection processing occurs.
@@ -416,7 +408,7 @@ function LanguageTree:_get_injections()
 
         -- Lang should override any other language tag
         if name == 'language' and not lang then
-          lang = get_node_text(node, id, metadata, self._source) --[[@as string]]
+          lang = query.get_node_text(node, self._source, { metadata = metadata[id] })
         elseif name == 'combined' then
           combined = true
         elseif name == 'content' and #ranges == 0 then
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 5ec8c67462..9136b596be 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -55,6 +55,38 @@ local function add_included_lang(base_langs, lang, ilang)
   return false
 end
 
+---@private
+---@param buf (number)
+---@param range (table)
+---@param concat (boolean)
+---@returns (string[]|string|nil)
+local function buf_range_get_text(buf, range, concat)
+  local lines
+  local start_row, start_col, end_row, end_col = unpack(range)
+  local eof_row = a.nvim_buf_line_count(buf)
+  if start_row >= eof_row then
+    return nil
+  end
+
+  if end_col == 0 then
+    lines = a.nvim_buf_get_lines(buf, start_row, end_row, true)
+    end_col = -1
+  else
+    lines = a.nvim_buf_get_lines(buf, start_row, end_row + 1, true)
+  end
+
+  if #lines > 0 then
+    if #lines == 1 then
+      lines[1] = string.sub(lines[1], start_col + 1, end_col)
+    else
+      lines[1] = string.sub(lines[1], start_col + 1)
+      lines[#lines] = string.sub(lines[#lines], 1, end_col)
+    end
+  end
+
+  return concat and table.concat(lines, '\n') or lines
+end
+
 --- Gets the list of files used to make up a query
 ---
 ---@param lang string Language to get query for
@@ -240,40 +272,22 @@ end
 ---@param source (number|string) Buffer or string from which the {node} is extracted
 ---@param opts (table|nil) Optional parameters.
 ---          - concat: (boolean) Concatenate result in a string (default true)
+---          - metadata (table) Metadata of a specific capture. This would be
+---            set to `metadata[capture_id]` when using
+---            |vim.treesitter.query.add_directive()|.
 ---@return (string[]|string|nil)
 function M.get_node_text(node, source, opts)
   opts = opts or {}
   local concat = vim.F.if_nil(opts.concat, true)
+  local metadata = opts.metadata or {}
 
-  local start_row, start_col, start_byte = node:start()
-  local end_row, end_col, end_byte = node:end_()
-
-  if type(source) == 'number' then
-    local eof_row = a.nvim_buf_line_count(source)
-    if start_row >= eof_row then
-      return nil
-    end
-
-    local lines ---@type string[]
-    if end_col == 0 then
-      lines = a.nvim_buf_get_lines(source, start_row, end_row, true)
-      end_col = -1
-    else
-      lines = a.nvim_buf_get_lines(source, start_row, end_row + 1, true)
-    end
-
-    if #lines > 0 then
-      if #lines == 1 then
-        lines[1] = string.sub(lines[1], start_col + 1, end_col)
-      else
-        lines[1] = string.sub(lines[1], start_col + 1)
-        lines[#lines] = string.sub(lines[#lines], 1, end_col)
-      end
-    end
-
-    return concat and table.concat(lines, '\n') or lines
+  if metadata.text then
+    return metadata.text
+  elseif type(source) == 'number' then
+    return metadata.range and buf_range_get_text(source, metadata.range, concat)
+      or buf_range_get_text(source, { node:range() }, concat)
   elseif type(source) == 'string' then
-    return source:sub(start_byte + 1, end_byte)
+    return source:sub(select(3, node:start()) + 1, select(3, node:end_()))
   end
 end
 
-- 
cgit 


From 4c66f5ff97a52fbc933fdbe1907c4b960d5a7403 Mon Sep 17 00:00:00 2001
From: figsoda <figsoda@pm.me>
Date: Mon, 26 Dec 2022 16:11:45 -0500
Subject: feat(treesitter): respect metadata[id].range for offset!

---
 runtime/lua/vim/treesitter/query.lua | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 9136b596be..a0522d7cda 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -445,9 +445,11 @@ local directive_handlers = {
   ['offset!'] = function(match, _, _, pred, metadata)
     ---@cast pred integer[]
     local capture_id = pred[2]
-    local offset_node = match[capture_id]
-    local range = { offset_node:range() }
-    ---@cast range integer[] bug in sumneko
+    if not metadata[capture_id] then
+      metadata[capture_id] = {}
+    end
+
+    local range = metadata[capture_id].range or { match[capture_id]:range() }
     local start_row_offset = pred[3] or 0
     local start_col_offset = pred[4] or 0
     local end_row_offset = pred[5] or 0
@@ -460,9 +462,6 @@ local directive_handlers = {
 
     -- If this produces an invalid range, we just skip it.
     if range[1] < range[3] or (range[1] == range[3] and range[2] <= range[4]) then
-      if not metadata[capture_id] then
-        metadata[capture_id] = {}
-      end
       metadata[capture_id].range = range
     end
   end,
-- 
cgit 


From 23e34fe534d201a1323ab040cb2201d21fe865cc Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sun, 5 Feb 2023 17:59:18 +0100
Subject: vim-patch:9.0.1281: Cadence files are not recognized (#22130)

Problem:    Cadence files are not recognized.
Solution:   Recognize Cadence files. (Janez Podhostnik, closes vim/vim#11951)

https://github.com/vim/vim/commit/cb626a4692df7154be02b47d6089ec679e95cb44

Co-authored-by: Janez Podhostnik <janez.podhostnik@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index bc30b3bd11..a18abf09ac 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -191,6 +191,7 @@ local extension = {
   qc = 'c',
   cabal = 'cabal',
   capnp = 'capnp',
+  cdc = 'cdc',
   cdl = 'cdl',
   toc = 'cdrtoc',
   cfc = 'cf',
-- 
cgit 


From 1675f0e270579036c454c38f28e650b60a3fba1a Mon Sep 17 00:00:00 2001
From: Amaan Qureshi <amaanq12@gmail.com>
Date: Mon, 6 Feb 2023 04:01:17 -0500
Subject: vim-patch:9.0.1282: Ron files are not recognized (#22132)

Problem:    Ron files are not recognized.
Solution:   Recognize Ron files. (Amaan Qureshi, closes vim/vim#11948)

https://github.com/vim/vim/commit/c8ef30bc2eaec956549510cd4b2efc96b7aee563
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index a18abf09ac..58728a8872 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -871,6 +871,7 @@ local extension = {
   Snw = 'rnoweb',
   robot = 'robot',
   resource = 'robot',
+  ron = 'ron',
   rsc = 'routeros',
   x = 'rpcgen',
   rpl = 'rpl',
-- 
cgit 


From 8fbe75b3dda7ab3b9e6df0d5406539bde4c80887 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Tue, 7 Feb 2023 10:29:37 +0100
Subject: vim-patch:9.0.1288: FunC files are not recognized (#22153)

Problem:    FunC files are not recognized.
Solution:   Recognize FunC files. (Amaan Qureshi, closes vim/vim#11949)

https://github.com/vim/vim/commit/91deac45392fe93094b9c31403b1ae771dc71938

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 58728a8872..cdc6e4bb7c 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -423,6 +423,7 @@ local extension = {
   fsh = 'fsh',
   fsi = 'fsharp',
   fsx = 'fsharp',
+  fc = 'func',
   fusion = 'fusion',
   gdb = 'gdb',
   gdmo = 'gdmo',
-- 
cgit 


From 1ca4a8b1ddf5256ad53cf486d0b2125434168270 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 8 Feb 2023 09:47:55 +0100
Subject: vim-patch:9.0.1291: Move language files are not recognized (#22162)

Problem:    Move language files are not recognized.
Solution:   Recognize Move language files. (Amaan Qureshi, closes vim/vim#11947)

https://github.com/vim/vim/commit/6642982beaf4f1f5164f0315a1b3e3c275156089

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index cdc6e4bb7c..1f605b72f3 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -692,6 +692,7 @@ local extension = {
   isc = 'monk',
   moo = 'moo',
   moon = 'moonscript',
+  move = 'move',
   mp = 'mp',
   mpiv = function(path, bufnr)
     return 'mp', function(b)
-- 
cgit 


From f5bad01869df449cb1e4ae7f264bcd5c8150f606 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 9 Feb 2023 15:20:47 +0000
Subject: feat(treesitter): playground improvements

- Render node ranges as virtual text
- Set filettype=query. The virtual text is to avoid parsing errors.
- Make sure highlights text is always in view.
---
 runtime/lua/vim/treesitter.lua            | 13 ++++++++---
 runtime/lua/vim/treesitter/playground.lua | 36 +++++++++++++++++++------------
 2 files changed, 32 insertions(+), 17 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 96b1e24ba9..a15d3ec23c 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -411,6 +411,7 @@ function M.show_tree(opts)
   vim.bo[b].buflisted = false
   vim.bo[b].buftype = 'nofile'
   vim.bo[b].bufhidden = 'wipe'
+  vim.bo[b].filetype = 'query'
 
   local title = opts.title
   if not title then
@@ -425,9 +426,6 @@ function M.show_tree(opts)
 
   pg:draw(b)
 
-  vim.fn.matchadd('Comment', '\\[[0-9:-]\\+\\]')
-  vim.fn.matchadd('String', '".*"')
-
   a.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
   a.nvim_buf_set_keymap(b, 'n', '<CR>', '', {
     desc = 'Jump to the node under the cursor in the source buffer',
@@ -467,6 +465,15 @@ function M.show_tree(opts)
         end_col = math.max(0, pos.end_col),
         hl_group = 'Visual',
       })
+
+      local topline, botline = vim.fn.line('w0', win), vim.fn.line('w$', win)
+
+      -- Move the cursor if highlighted range is completely out of view
+      if pos.lnum < topline and pos.end_lnum < topline then
+        a.nvim_win_set_cursor(win, { pos.end_lnum + 1, 0 })
+      elseif pos.lnum > botline and pos.end_lnum > botline then
+        a.nvim_win_set_cursor(win, { pos.lnum + 1, 0 })
+      end
     end,
   })
 
diff --git a/runtime/lua/vim/treesitter/playground.lua b/runtime/lua/vim/treesitter/playground.lua
index be7764e6f0..001bc2d5bf 100644
--- a/runtime/lua/vim/treesitter/playground.lua
+++ b/runtime/lua/vim/treesitter/playground.lua
@@ -136,6 +136,8 @@ function TSPlayground:new(bufnr, lang)
   return t
 end
 
+local decor_ns = api.nvim_create_namespace('ts.playground')
+
 --- Write the contents of this Playground into {bufnr}.
 ---
 ---@param bufnr number Buffer number to write into.
@@ -144,22 +146,28 @@ function TSPlayground:draw(bufnr)
   vim.bo[bufnr].modifiable = true
   local lines = {} ---@type string[]
   for _, item in self:iter() do
-    lines[#lines + 1] = table.concat({
-      string.rep(' ', item.depth),
-      item.text,
-      item.lnum == item.end_lnum
-          and string.format(' [%d:%d-%d]', item.lnum + 1, item.col + 1, item.end_col)
-        or string.format(
-          ' [%d:%d-%d:%d]',
-          item.lnum + 1,
-          item.col + 1,
-          item.end_lnum + 1,
-          item.end_col
-        ),
-      self.opts.lang and string.format(' %s', item.lang) or '',
-    })
+    lines[#lines + 1] = string.rep(' ', item.depth) .. item.text
   end
   api.nvim_buf_set_lines(bufnr, 0, -1, false, lines)
+
+  api.nvim_buf_clear_namespace(bufnr, decor_ns, 0, -1)
+
+  for i, item in self:iter() do
+    local range_str
+    if item.lnum == item.end_lnum then
+      range_str = string.format('[%d:%d-%d]', item.lnum + 1, item.col + 1, item.end_col)
+    else
+      range_str =
+        string.format('[%d:%d-%d:%d]', item.lnum + 1, item.col + 1, item.end_lnum + 1, item.end_col)
+    end
+
+    local lang_str = self.opts.lang and string.format(' %s', item.lang) or ''
+
+    api.nvim_buf_set_extmark(bufnr, decor_ns, i - 1, 0, {
+      virt_text = { { range_str, 'Comment' }, { lang_str, 'Title' } },
+    })
+  end
+
   vim.bo[bufnr].modifiable = false
 end
 
-- 
cgit 


From 8a985d12dd6b4a5a4ba825939f36b7b1a324d849 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 9 Feb 2023 16:08:22 +0000
Subject: fix(treesitter): don't trample parsers when filetype!=lang

This allows vim.treesitter.show_tree() to work on buffers where the
filetype does not match the parser language name e.g, bash/sh.
---
 runtime/lua/vim/treesitter.lua | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index a15d3ec23c..4127198576 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -96,11 +96,13 @@ function M.get_parser(bufnr, lang, opts)
   if bufnr == nil or bufnr == 0 then
     bufnr = a.nvim_get_current_buf()
   end
-  if lang == nil then
-    lang = a.nvim_buf_get_option(bufnr, 'filetype')
-  end
 
-  if parsers[bufnr] == nil or parsers[bufnr]:lang() ~= lang then
+  if parsers[bufnr] == nil then
+    lang = lang or a.nvim_buf_get_option(bufnr, 'filetype')
+    parsers[bufnr] = M._create_parser(bufnr, lang, opts)
+  elseif lang and parsers[bufnr]:lang() ~= lang then
+    -- Only try to create a new parser if lang is provided
+    -- and it doesn't match the stored parser
     parsers[bufnr] = M._create_parser(bufnr, lang, opts)
   end
 
-- 
cgit 


From c5b34fa55483d84d1de32937ffff0b7cf1aeba78 Mon Sep 17 00:00:00 2001
From: glacambre <code@lacamb.re>
Date: Sat, 11 Feb 2023 09:45:11 +0100
Subject: refactor: move init_default_autocmds to lua

The original motivation for this change came from developping
https://github.com/neovim/neovim/pull/22159, which will require adding
more autocommand creation to Neovim's startup sequence.

This change requires lightly editing a test that expected no autocommand
to have been created from lua.
---
 runtime/lua/vim/_editor.lua | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index da8764fbd4..3f27e61810 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -894,6 +894,26 @@ function vim._init_default_mappings()
   ]])
 end
 
+function vim._init_default_autocmds()
+  local nvim_terminal_augroup = vim.api.nvim_create_augroup('nvim_terminal', {})
+  vim.api.nvim_create_autocmd({ 'bufreadcmd' }, {
+    pattern = 'term://*',
+    group = nvim_terminal_augroup,
+    nested = true,
+    command = "if !exists('b:term_title')|call termopen(matchstr(expand(\"<amatch>\"), '\\c\\mterm://\\%(.\\{-}//\\%(\\d\\+:\\)\\?\\)\\?\\zs.*'), {'cwd': expand(get(matchlist(expand(\"<amatch>\"), '\\c\\mterm://\\(.\\{-}\\)//'), 1, ''))})",
+  })
+  vim.api.nvim_create_autocmd({ 'cmdwinenter' }, {
+    pattern = '[:>]',
+    group = vim.api.nvim_create_augroup('nvim_cmdwin', {}),
+    command = 'syntax sync minlines=1 maxlines=1',
+  })
+end
+
+function vim._init_defaults()
+  vim._init_default_mappings()
+  vim._init_default_autocmds()
+end
+
 require('vim._meta')
 
 return vim
-- 
cgit 


From 9668c166e88cd71e517cacfb8d266b75047604f7 Mon Sep 17 00:00:00 2001
From: Jonas Strittmatter <40792180+smjonas@users.noreply.github.com>
Date: Sat, 11 Feb 2023 16:08:33 +0100
Subject: fix(filetype): make vim.filetype.match() work with contents only
 (#22181)

Co-authored-by: Gregory Anders <greg@gpanders.com>
---
 runtime/lua/vim/filetype.lua | 95 ++++++++++++++++++++++----------------------
 1 file changed, 48 insertions(+), 47 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 1f605b72f3..ec568b5b82 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -2449,6 +2449,7 @@ local function match_pattern(name, path, tail, pat)
       return false
     end
   end
+
   -- If the pattern contains a / match against the full path, otherwise just the tail
   local fullpat = '^' .. pat .. '$'
   local matches
@@ -2526,64 +2527,64 @@ function M.match(args)
     name = api.nvim_buf_get_name(bufnr)
   end
 
-  if name then
-    name = normalize_path(name)
-  end
-
   local ft, on_detect
 
-  -- First check for the simple case where the full path exists as a key
-  local path = vim.fn.fnamemodify(name, ':p')
-  ft, on_detect = dispatch(filename[path], path, bufnr)
-  if ft then
-    return ft, on_detect
-  end
+  if name then
+    name = normalize_path(name)
 
-  -- Next check against just the file name
-  local tail = vim.fn.fnamemodify(name, ':t')
-  ft, on_detect = dispatch(filename[tail], path, bufnr)
-  if ft then
-    return ft, on_detect
-  end
+    -- First check for the simple case where the full path exists as a key
+    local path = vim.fn.fnamemodify(name, ':p')
+    ft, on_detect = dispatch(filename[path], path, bufnr)
+    if ft then
+      return ft, on_detect
+    end
 
-  -- Next, check the file path against available patterns with non-negative priority
-  local j = 1
-  for i, v in ipairs(pattern_sorted) do
-    local k = next(v)
-    local opts = v[k][2]
-    if opts.priority < 0 then
-      j = i
-      break
+    -- Next check against just the file name
+    local tail = vim.fn.fnamemodify(name, ':t')
+    ft, on_detect = dispatch(filename[tail], path, bufnr)
+    if ft then
+      return ft, on_detect
     end
 
-    local filetype = v[k][1]
-    local matches = match_pattern(name, path, tail, k)
-    if matches then
-      ft, on_detect = dispatch(filetype, path, bufnr, matches)
-      if ft then
-        return ft, on_detect
+    -- Next, check the file path against available patterns with non-negative priority
+    local j = 1
+    for i, v in ipairs(pattern_sorted) do
+      local k = next(v)
+      local opts = v[k][2]
+      if opts.priority < 0 then
+        j = i
+        break
+      end
+
+      local filetype = v[k][1]
+      local matches = match_pattern(name, path, tail, k)
+      if matches then
+        ft, on_detect = dispatch(filetype, path, bufnr, matches)
+        if ft then
+          return ft, on_detect
+        end
       end
     end
-  end
 
-  -- Next, check file extension
-  local ext = vim.fn.fnamemodify(name, ':e')
-  ft, on_detect = dispatch(extension[ext], path, bufnr)
-  if ft then
-    return ft, on_detect
-  end
+    -- Next, check file extension
+    local ext = vim.fn.fnamemodify(name, ':e')
+    ft, on_detect = dispatch(extension[ext], path, bufnr)
+    if ft then
+      return ft, on_detect
+    end
 
-  -- Next, check patterns with negative priority
-  for i = j, #pattern_sorted do
-    local v = pattern_sorted[i]
-    local k = next(v)
+    -- Next, check patterns with negative priority
+    for i = j, #pattern_sorted do
+      local v = pattern_sorted[i]
+      local k = next(v)
 
-    local filetype = v[k][1]
-    local matches = match_pattern(name, path, tail, k)
-    if matches then
-      ft, on_detect = dispatch(filetype, path, bufnr, matches)
-      if ft then
-        return ft, on_detect
+      local filetype = v[k][1]
+      local matches = match_pattern(name, path, tail, k)
+      if matches then
+        ft, on_detect = dispatch(filetype, path, bufnr, matches)
+        if ft then
+          return ft, on_detect
+        end
       end
     end
   end
-- 
cgit 


From b518aceaa8f738e581e58aacae93514699b5ff8e Mon Sep 17 00:00:00 2001
From: Jonas Strittmatter <40792180+smjonas@users.noreply.github.com>
Date: Tue, 14 Feb 2023 00:04:16 +0100
Subject: feat(filetype): fall back to file extension when matching from
 hashbang (#22140)

If nothing matched in match_from_hashbang, also check the file extension table.
For a hashbang like '#!/bin/env foo', this will set the filetype to 'fooscript'
assuming the filetype for the 'foo' extension is 'fooscript' in the extension
table.
---
 runtime/lua/vim/filetype.lua        |  4 +++-
 runtime/lua/vim/filetype/detect.lua | 11 ++++++++---
 2 files changed, 11 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index ec568b5b82..ca91f3f402 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -2604,7 +2604,9 @@ function M.match(args)
     -- If the function tries to use the filename that is nil then it will fail,
     -- but this enables checks which do not need a filename to still work.
     local ok
-    ok, ft = pcall(require('vim.filetype.detect').match_contents, contents, name)
+    ok, ft = pcall(require('vim.filetype.detect').match_contents, contents, name, function(ext)
+      return dispatch(extension[ext], name, bufnr)
+    end)
     if ok and ft then
       return ft
     end
diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index edffdde9c7..b3d9fedeae 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -1420,7 +1420,7 @@ local patterns_hashbang = {
 
 ---@private
 -- File starts with "#!".
-local function match_from_hashbang(contents, path)
+local function match_from_hashbang(contents, path, dispatch_extension)
   local first_line = contents[1]
   -- Check for a line like "#!/usr/bin/env {options} bash".  Turn it into
   -- "#!/usr/bin/bash" to make matching easier.
@@ -1473,6 +1473,11 @@ local function match_from_hashbang(contents, path)
       return ft
     end
   end
+
+  -- If nothing matched, check the extension table. For a hashbang like
+  -- '#!/bin/env foo', this will set the filetype to 'fooscript' assuming
+  -- the filetype for the 'foo' extension is 'fooscript' in the extension table.
+  return dispatch_extension(name)
 end
 
 local patterns_text = {
@@ -1652,10 +1657,10 @@ local function match_from_text(contents, path)
   return cvs_diff(path, contents)
 end
 
-M.match_contents = function(contents, path)
+function M.match_contents(contents, path, dispatch_extension)
   local first_line = contents[1]
   if first_line:find('^#!') then
-    return match_from_hashbang(contents, path)
+    return match_from_hashbang(contents, path, dispatch_extension)
   else
     return match_from_text(contents, path)
   end
-- 
cgit 


From a289e82142fdc5ff657dd30198546eeb1e115fe9 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 15 Feb 2023 12:26:07 +0000
Subject: fix(treesitter): make params optional

---
 runtime/lua/vim/treesitter/query.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index a0522d7cda..008e5a54d7 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -487,7 +487,7 @@ local directive_handlers = {
 ---@param name string Name of the predicate, without leading #
 ---@param handler function(match:table<string,TSNode>, pattern:string, bufnr:number, predicate:string[])
 ---   - see |vim.treesitter.query.add_directive()| for argument meanings
----@param force boolean
+---@param force boolean|nil
 function M.add_predicate(name, handler, force)
   if predicate_handlers[name] and not force then
     error(string.format('Overriding %s', name))
@@ -510,7 +510,7 @@ end
 ---   - pattern: see |treesitter-query|
 ---   - predicate: list of strings containing the full directive being called, e.g.
 ---     `(node (#set! conceal "-"))` would get the predicate `{ "#set!", "conceal", "-" }`
----@param force boolean
+---@param force boolean|nil
 function M.add_directive(name, handler, force)
   if directive_handlers[name] and not force then
     error(string.format('Overriding %s', name))
-- 
cgit 


From f43fa301c1a2817239e046a242902af65b7cac71 Mon Sep 17 00:00:00 2001
From: Eduard Baturin <trardone@gmail.com>
Date: Sat, 18 Feb 2023 09:43:59 +0300
Subject: fix(lsp): check if the buffer is a directory before w! it (#22289)

---
 runtime/lua/vim/lsp/util.lua | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 38051e6410..4beb4fc367 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -759,9 +759,11 @@ function M.rename(old_fname, new_fname, opts)
   vim.fn.bufload(oldbuf)
 
   -- The there may be pending changes in the buffer
-  api.nvim_buf_call(oldbuf, function()
-    vim.cmd('w!')
-  end)
+  if vim.fn.isdirectory(old_fname) == 0 then
+    api.nvim_buf_call(oldbuf, function()
+      vim.cmd('w!')
+    end)
+  end
 
   local ok, err = os.rename(old_fname, new_fname)
   assert(ok, err)
-- 
cgit 


From 2f6413797499a1bdac28c20a491e8ea3be33bda3 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sun, 19 Feb 2023 01:27:32 +0100
Subject: vim-patch:9.0.1319: PRQL files are not recognized (#22319)

Problem:    PRQL files are not recognized.
Solution:   Add a filetype pattern for PRQL files. (Matthias Queitsch,
            closes vim/vim#12018)

https://github.com/vim/vim/commit/9de960ace0f017fcfeaf64a2f6492f0f88b11fdb

Co-authored-by: Matthias Queitsch <matthias.queitsch@mailbox.org>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index ca91f3f402..4ee7d46b20 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -810,6 +810,7 @@ local extension = {
   pdb = 'prolog',
   pml = 'promela',
   proto = 'proto',
+  prql = 'prql',
   ['psd1'] = 'ps1',
   ['psm1'] = 'ps1',
   ['ps1'] = 'ps1',
-- 
cgit 


From bdf6d8733e2a954031de86e9a2d09c3b03f6641d Mon Sep 17 00:00:00 2001
From: Jason Hansen <jasonrodneyhansen@gmail.com>
Date: Mon, 20 Feb 2023 23:24:47 -0700
Subject: fix(lsp): wrong format of bufnr and client order in error message
 (#22336)

---
 runtime/lua/vim/lsp.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index c5392ac154..0a620e1367 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1736,8 +1736,8 @@ function lsp.buf_detach_client(bufnr, client_id)
     vim.notify(
       string.format(
         'Buffer (id: %d) is not attached to client (id: %d). Cannot detach.',
-        client_id,
-        bufnr
+        bufnr,
+        client_id
       )
     )
     return
-- 
cgit 


From 8714a4009c0f0be0bb27a6b3eb486eeb3d9f3049 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 21 Feb 2023 17:09:18 +0000
Subject: feat(treesitter): add filetype -> lang API

Problem:

  vim.treesitter does not know how to map a specific filetype to a parser.

  This creates problems since in a few places (including in vim.treesitter itself), the filetype is incorrectly used in place of lang.

Solution:

  Add an API to enable this:

  - Add vim.treesitter.language.add() as a replacement for vim.treesitter.language.require_language().
    - Optional arguments are now passed via an opts table.
    - Also takes a filetype (or list of filetypes) so we can keep track of what filetypes are associated with which langs.
    - Deprecated vim.treesitter.language.require_language().
  - Add vim.treesitter.language.get_lang() which returns the associated lang for a given filetype.
  - Add vim.treesitter.language.register() to associate filetypes to a lang without loading the parser.
---
 runtime/lua/vim/treesitter.lua              | 24 +++++----
 runtime/lua/vim/treesitter/health.lua       |  2 +-
 runtime/lua/vim/treesitter/language.lua     | 84 ++++++++++++++++++++++++++---
 runtime/lua/vim/treesitter/languagetree.lua |  4 +-
 runtime/lua/vim/treesitter/query.lua        |  2 +-
 5 files changed, 94 insertions(+), 22 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 4127198576..c524b20bc2 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -29,6 +29,8 @@ setmetatable(M, {
   end,
 })
 
+---@diagnostic disable:invisible
+
 --- Creates a new parser
 ---
 --- It is not recommended to use this; use |get_parser()| instead.
@@ -39,16 +41,15 @@ setmetatable(M, {
 ---
 ---@return LanguageTree object to use for parsing
 function M._create_parser(bufnr, lang, opts)
-  language.require_language(lang)
   if bufnr == 0 then
     bufnr = vim.api.nvim_get_current_buf()
   end
 
   vim.fn.bufload(bufnr)
 
-  local self = LanguageTree.new(bufnr, lang, opts)
+  language.add(lang, { filetype = vim.bo[bufnr].filetype })
 
-  ---@diagnostic disable:invisible
+  local self = LanguageTree.new(bufnr, lang, opts)
 
   ---@private
   local function bytes_cb(_, ...)
@@ -96,13 +97,16 @@ function M.get_parser(bufnr, lang, opts)
   if bufnr == nil or bufnr == 0 then
     bufnr = a.nvim_get_current_buf()
   end
+  if lang == nil then
+    local ft = vim.bo[bufnr].filetype
+    lang = language.get_lang(ft) or ft
+    -- TODO(lewis6991): we should error here and not default to ft
+    -- if not lang then
+    --   error(string.format('filetype %s of buffer %d is not associated with any lang', ft, bufnr))
+    -- end
+  end
 
-  if parsers[bufnr] == nil then
-    lang = lang or a.nvim_buf_get_option(bufnr, 'filetype')
-    parsers[bufnr] = M._create_parser(bufnr, lang, opts)
-  elseif lang and parsers[bufnr]:lang() ~= lang then
-    -- Only try to create a new parser if lang is provided
-    -- and it doesn't match the stored parser
+  if parsers[bufnr] == nil or parsers[bufnr]:lang() ~= lang then
     parsers[bufnr] = M._create_parser(bufnr, lang, opts)
   end
 
@@ -123,7 +127,7 @@ function M.get_string_parser(str, lang, opts)
     str = { str, 'string' },
     lang = { lang, 'string' },
   })
-  language.require_language(lang)
+  language.add(lang)
 
   return LanguageTree.new(str, lang, opts)
 end
diff --git a/runtime/lua/vim/treesitter/health.lua b/runtime/lua/vim/treesitter/health.lua
index c0a1eca0ce..1abcdd0b31 100644
--- a/runtime/lua/vim/treesitter/health.lua
+++ b/runtime/lua/vim/treesitter/health.lua
@@ -17,7 +17,7 @@ function M.check()
 
   for _, parser in pairs(parsers) do
     local parsername = vim.fn.fnamemodify(parser, ':t:r')
-    local is_loadable, ret = pcall(ts.language.require_language, parsername)
+    local is_loadable, ret = pcall(ts.language.add, parsername)
 
     if not is_loadable or not ret then
       health.report_error(
diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index 8634e53b7b..8637d7d544 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -2,19 +2,66 @@ local a = vim.api
 
 local M = {}
 
+---@type table<string,string>
+local ft_to_lang = {}
+
+---@param filetype string
+---@return string|nil
+function M.get_lang(filetype)
+  return ft_to_lang[filetype]
+end
+
+---@deprecated
+function M.require_language(lang, path, silent, symbol_name)
+  return M.add(lang, {
+    silent = silent,
+    path = path,
+    symbol_name = symbol_name,
+  })
+end
+
+---@class treesitter.RequireLangOpts
+---@field path? string
+---@field silent? boolean
+---@field filetype? string|string[]
+---@field symbol_name? string
+
 --- Asserts that a parser for the language {lang} is installed.
 ---
 --- Parsers are searched in the `parser` runtime directory, or the provided {path}
 ---
 ---@param lang string Language the parser should parse (alphanumerical and `_` only)
----@param path (string|nil) Optional path the parser is located at
----@param silent (boolean|nil) Don't throw an error if language not found
----@param symbol_name (string|nil) Internal symbol name for the language to load
+---@param opts (table|nil) Options:
+---                        - filetype (string|string[]) Filetype(s) that lang can be parsed with.
+---                          Note this is not strictly the same as lang since a single lang can
+---                          parse multiple filetypes.
+---                          Defaults to lang.
+---                        - path (string|nil) Optional path the parser is located at
+---                        - symbol_name (string|nil) Internal symbol name for the language to load
+---                        - silent (boolean|nil) Don't throw an error if language not found
 ---@return boolean If the specified language is installed
-function M.require_language(lang, path, silent, symbol_name)
+function M.add(lang, opts)
+  ---@cast opts treesitter.RequireLangOpts
+  opts = opts or {}
+  local path = opts.path
+  local silent = opts.silent
+  local filetype = opts.filetype or lang
+  local symbol_name = opts.symbol_name
+
+  vim.validate({
+    lang = { lang, 'string' },
+    path = { path, 'string', true },
+    silent = { silent, 'boolean', true },
+    symbol_name = { symbol_name, 'string', true },
+    filetype = { filetype, { 'string', 'table' }, true },
+  })
+
+  M.register(lang, filetype or lang)
+
   if vim._ts_has_language(lang) then
     return true
   end
+
   if path == nil then
     if not (lang and lang:match('[%w_]+') == lang) then
       if silent then
@@ -35,9 +82,9 @@ function M.require_language(lang, path, silent, symbol_name)
   end
 
   if silent then
-    return pcall(function()
-      vim._ts_add_language(path, lang, symbol_name)
-    end)
+    if not pcall(vim._ts_add_language, path, lang, symbol_name) then
+      return false
+    end
   else
     vim._ts_add_language(path, lang, symbol_name)
   end
@@ -45,6 +92,27 @@ function M.require_language(lang, path, silent, symbol_name)
   return true
 end
 
+--- Register a lang to be used for a filetype (or list of filetypes).
+---@param lang string Language to register
+---@param filetype string|string[] Filetype(s) to associate with lang
+function M.register(lang, filetype)
+  vim.validate({
+    lang = { lang, 'string' },
+    filetype = { filetype, { 'string', 'table' } },
+  })
+
+  local filetypes ---@type string[]
+  if type(filetype) == 'string' then
+    filetypes = { filetype }
+  else
+    filetypes = filetype
+  end
+
+  for _, f in ipairs(filetypes) do
+    ft_to_lang[f] = lang
+  end
+end
+
 --- Inspects the provided language.
 ---
 --- Inspecting provides some useful information on the language like node names, ...
@@ -52,7 +120,7 @@ end
 ---@param lang string Language
 ---@return table
 function M.inspect_language(lang)
-  M.require_language(lang)
+  M.add(lang)
   return vim._ts_inspect_language(lang)
 end
 
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 8255c6f4fe..81ad83db2c 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -51,7 +51,7 @@ LanguageTree.__index = LanguageTree
 ---                                query per language.
 ---@return LanguageTree parser object
 function LanguageTree.new(source, lang, opts)
-  language.require_language(lang)
+  language.add(lang)
   ---@type LanguageTreeOpts
   opts = opts or {}
 
@@ -170,7 +170,7 @@ function LanguageTree:parse()
   local seen_langs = {} ---@type table<string,boolean>
 
   for lang, injection_ranges in pairs(injections_by_lang) do
-    local has_lang = language.require_language(lang, nil, true)
+    local has_lang = language.add(lang, { silent = true })
 
     -- Child language trees should just be ignored if not found, since
     -- they can depend on the text of a node. Intermediate strings
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 008e5a54d7..83910316a6 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -252,7 +252,7 @@ end)
 ---
 ---@return Query Parsed query
 function M.parse_query(lang, query)
-  language.require_language(lang)
+  language.add(lang)
   local cached = query_cache[lang][query]
   if cached then
     return cached
-- 
cgit 


From d1b34b74580fc09d86144c35e24a1a8a0d531b36 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 22 Feb 2023 10:58:15 +0100
Subject: vim-patch:9.0.1337: yuck files are not recognized (#22358)

Problem:    Yuck files are not recognized.
Solution:   Add a filetype pattern for yuck files. (Amaan Qureshi,
            closes vim/vim#12033)

https://github.com/vim/vim/commit/cfce5cf542db20c7beba5b4211c0ae3305a64a43

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 4ee7d46b20..0dd2dcfcbe 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1131,6 +1131,7 @@ local extension = {
   yml = 'yaml',
   yaml = 'yaml',
   yang = 'yang',
+  yuck = 'yuck',
   ['z8a'] = 'z8a',
   zig = 'zig',
   zir = 'zir',
-- 
cgit 


From 675826da63e879efa97c0998fea192ed5c79d56e Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 22 Feb 2023 08:01:08 -0700
Subject: refactor(treesitter): Add vim.treesitter.get_node() (#22360)

This function replaces both vim.treesitter.get_node_at_pos() and
vim.treesitter.get_node_at_cursor(). These two functions are similar
enough that they don't need separate interfaces. Even worse,
get_node_at_pos() returns a TSNode while get_node_at_cursor() returns a
string, so the two functions behave slightly differently.

vim.treesitter.get_node() combines these two into a more streamlined
interface. With no arguments, it returns the node under the cursor in
the current buffer. Optionally, it can accept a buffer number or a
position to get the node at a given position in a given buffer.
---
 runtime/lua/vim/treesitter.lua | 57 +++++++++++++++++++++++++++++++++++++++---
 1 file changed, 53 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index c524b20bc2..c1e5325519 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -286,6 +286,50 @@ function M.get_captures_at_cursor(winnr)
   return captures
 end
 
+--- Returns the smallest named node at the given position
+---
+---@param opts table|nil Optional keyword arguments:
+---             - bufnr integer|nil Buffer number (nil or 0 for current buffer)
+---             - pos table|nil 0-indexed (row, col) tuple. Defaults to cursor position in the
+---                             current window. Required if {bufnr} is not the current buffer
+---             - ignore_injections boolean Ignore injected languages (default true)
+---
+---@return TSNode | nil Node at the given position
+function M.get_node(opts)
+  opts = opts or {}
+
+  local bufnr = opts.bufnr
+
+  if not bufnr or bufnr == 0 then
+    bufnr = a.nvim_get_current_buf()
+  end
+
+  local row, col
+  if opts.pos then
+    assert(#opts.pos == 2, 'Position must be a (row, col) tuple')
+    row, col = opts.pos[1], opts.pos[2]
+  else
+    assert(
+      bufnr == a.nvim_get_current_buf(),
+      'Position must be explicitly provided when not using the current buffer'
+    )
+    local pos = a.nvim_win_get_cursor(0)
+    -- Subtract one to account for 1-based row indexing in nvim_win_get_cursor
+    row, col = pos[1] - 1, pos[2]
+  end
+
+  assert(row >= 0 and col >= 0, 'Invalid position: row and col must be non-negative')
+
+  local ts_range = { row, col, row, col }
+
+  local root_lang_tree = M.get_parser(bufnr)
+  if not root_lang_tree then
+    return
+  end
+
+  return root_lang_tree:named_node_for_range(ts_range, opts)
+end
+
 --- Returns the smallest named node at the given position
 ---
 ---@param bufnr integer Buffer number (0 for current buffer)
@@ -296,12 +340,16 @@ end
 ---             - ignore_injections boolean Ignore injected languages (default true)
 ---
 ---@return TSNode|nil under the cursor
+---@deprecated
 function M.get_node_at_pos(bufnr, row, col, opts)
+  vim.deprecate('vim.treesitter.get_node_at_pos()', 'vim.treesitter.get_node()', '0.10')
   if bufnr == 0 then
     bufnr = a.nvim_get_current_buf()
   end
   local ts_range = { row, col, row, col }
 
+  opts = opts or {}
+
   local root_lang_tree = M.get_parser(bufnr, opts.lang)
   if not root_lang_tree then
     return
@@ -315,12 +363,13 @@ end
 ---@param winnr (integer|nil) Window handle or 0 for current window (default)
 ---
 ---@return string Name of node under the cursor
+---@deprecated
 function M.get_node_at_cursor(winnr)
+  vim.deprecate('vim.treesitter.get_node_at_cursor()', 'vim.treesitter.get_node():type()', '0.10')
   winnr = winnr or 0
   local bufnr = a.nvim_win_get_buf(winnr)
-  local cursor = a.nvim_win_get_cursor(winnr)
 
-  return M.get_node_at_pos(bufnr, cursor[1] - 1, cursor[2], { ignore_injections = false }):type()
+  return M.get_node({ bufnr = bufnr, ignore_injections = false }):type()
 end
 
 --- Starts treesitter highlighting for a buffer
@@ -493,8 +542,8 @@ function M.show_tree(opts)
 
       a.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
 
-      local cursor = a.nvim_win_get_cursor(win)
-      local cursor_node = M.get_node_at_pos(buf, cursor[1] - 1, cursor[2], {
+      local cursor_node = M.get_node({
+        bufnr = buf,
         lang = opts.lang,
         ignore_injections = false,
       })
-- 
cgit 


From 6752f1005d26c93a033d856a60b7b296f3e51634 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Wed, 14 Dec 2022 19:58:18 +0100
Subject: docs: naming conventions, guidelines

close #21063
---
 runtime/lua/vim/keymap.lua | 50 ++++++++++++++++------------------------------
 runtime/lua/vim/ui.lua     |  7 ++++---
 2 files changed, 21 insertions(+), 36 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/keymap.lua b/runtime/lua/vim/keymap.lua
index ef1c66ea20..911b584c14 100644
--- a/runtime/lua/vim/keymap.lua
+++ b/runtime/lua/vim/keymap.lua
@@ -1,51 +1,35 @@
 local keymap = {}
 
---- Add a new |mapping|.
+--- Adds a new |mapping|.
 --- Examples:
 --- <pre>lua
----   -- Can add mapping to Lua functions
+---   -- Map to a Lua function:
 ---   vim.keymap.set('n', 'lhs', function() print("real lua function") end)
----
----   -- Can use it to map multiple modes
+---   -- Map to multiple modes:
 ---   vim.keymap.set({'n', 'v'}, '<leader>lr', vim.lsp.buf.references, { buffer=true })
----
----   -- Can add mapping for specific buffer
+---   -- Buffer-local mapping:
 ---   vim.keymap.set('n', '<leader>w', "<cmd>w<cr>", { silent = true, buffer = 5 })
----
----   -- Expr mappings
+---   -- Expr mapping:
 ---   vim.keymap.set('i', '<Tab>', function()
 ---     return vim.fn.pumvisible() == 1 and "<C-n>" or "<Tab>"
 ---   end, { expr = true })
----   -- <Plug> mappings
+---   -- <Plug> mapping:
 ---   vim.keymap.set('n', '[%%', '<Plug>(MatchitNormalMultiBackward)')
 --- </pre>
 ---
---- Note that in a mapping like:
---- <pre>lua
----    vim.keymap.set('n', 'asdf', require('jkl').my_fun)
---- </pre>
----
---- the ``require('jkl')`` gets evaluated during this call in order to access the function.
---- If you want to avoid this cost at startup you can wrap it in a function, for example:
---- <pre>lua
----    vim.keymap.set('n', 'asdf', function() return require('jkl').my_fun() end)
---- </pre>
----
----@param mode string|table    Same mode short names as |nvim_set_keymap()|.
+---@param mode string|table    Mode short-name, see |nvim_set_keymap()|.
 ---                            Can also be list of modes to create mapping on multiple modes.
 ---@param lhs string           Left-hand side |{lhs}| of the mapping.
----@param rhs string|function  Right-hand side |{rhs}| of the mapping. Can also be a Lua function.
---
----@param opts table|nil A table of |:map-arguments|.
----                      + Accepts options accepted by the {opts} parameter in |nvim_set_keymap()|,
----                        with the following notable differences:
----                        - replace_keycodes: Defaults to `true` if "expr" is `true`.
----                        - noremap: Always overridden with the inverse of "remap" (see below).
----                      + In addition to those options, the table accepts the following keys:
----                        - buffer: (number or boolean) Add a mapping to the given buffer.
----                        When `0` or `true`, use the current buffer.
----                        - remap: (boolean) Make the mapping recursive.
----                        This is the inverse of the "noremap" option from |nvim_set_keymap()|.
+---@param rhs string|function  Right-hand side |{rhs}| of the mapping, can be a Lua function.
+---
+---@param opts table|nil Table of |:map-arguments|.
+---                      - Same as |nvim_set_keymap()| {opts}, except:
+---                        - "replace_keycodes" defaults to `true` if "expr" is `true`.
+---                        - "noremap": inverse of "remap" (see below).
+---                      - Also accepts:
+---                        - "buffer" number|boolean Creates buffer-local mapping, `0` or `true`
+---                        for current buffer.
+---                        - remap: (boolean) Make the mapping recursive. Inverses "noremap".
 ---                        Defaults to `false`.
 ---@see |nvim_set_keymap()|
 function keymap.set(mode, lhs, rhs, opts)
diff --git a/runtime/lua/vim/ui.lua b/runtime/lua/vim/ui.lua
index 8f5be15221..aaee175f3a 100644
--- a/runtime/lua/vim/ui.lua
+++ b/runtime/lua/vim/ui.lua
@@ -1,6 +1,7 @@
 local M = {}
 
---- Prompts the user to pick a single item from a collection of entries
+--- Prompts the user to pick from a list of items, allowing arbitrary (potentially asynchronous)
+--- work until `on_choice`.
 ---
 ---@param items table Arbitrary items
 ---@param opts table Additional options
@@ -35,7 +36,6 @@ local M = {}
 ---     end
 --- end)
 --- </pre>
-
 function M.select(items, opts, on_choice)
   vim.validate({
     items = { items, 'table', false },
@@ -55,7 +55,8 @@ function M.select(items, opts, on_choice)
   end
 end
 
---- Prompts the user for input
+--- Prompts the user for input, allowing arbitrary (potentially asynchronous) work until
+--- `on_confirm`.
 ---
 ---@param opts table Additional options. See |input()|
 ---     - prompt (string|nil)
-- 
cgit 


From 05de0f4fea237132ff3a9a5a35e9c711c4ece579 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Tue, 21 Feb 2023 17:03:04 +0100
Subject: docs(treesitter): fix parse errors

---
 runtime/lua/vim/treesitter.lua              | 4 ++--
 runtime/lua/vim/treesitter/languagetree.lua | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index c1e5325519..c4df5b2d24 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -157,7 +157,7 @@ end
 
 --- Returns the node's range or an unpacked range table
 ---
----@param node_or_range (TSNode|table) Node or table of positions
+---@param node_or_range (TSNode | table) Node or table of positions
 ---
 ---@return integer start_row
 ---@return integer start_col
@@ -339,7 +339,7 @@ end
 ---             - lang string|nil Parser language
 ---             - ignore_injections boolean Ignore injected languages (default true)
 ---
----@return TSNode|nil under the cursor
+---@return TSNode | nil Node at the given position
 ---@deprecated
 function M.get_node_at_pos(bufnr, row, col, opts)
   vim.deprecate('vim.treesitter.get_node_at_pos()', 'vim.treesitter.get_node()', '0.10')
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 81ad83db2c..c9fd4bb2ea 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -653,7 +653,7 @@ end
 ---@param range Range `{ start_line, start_col, end_line, end_col }`
 ---@param opts table|nil Optional keyword arguments:
 ---             - ignore_injections boolean Ignore injected languages (default true)
----@return TSNode|nil Found node
+---@return TSNode | nil Found node
 function LanguageTree:named_node_for_range(range, opts)
   local tree = self:tree_for_range(range, opts)
   if tree then
-- 
cgit 


From 6dfbeb0d990d24657754463c6ab155c19e7f5f56 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Tue, 21 Feb 2023 17:39:29 +0100
Subject: docs: fix more treesitter parsing errors

---
 runtime/lua/vim/treesitter.lua       | 2 +-
 runtime/lua/vim/treesitter/query.lua | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index c4df5b2d24..44922bbc4d 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -218,7 +218,7 @@ end
 ---@param row integer Position row
 ---@param col integer Position column
 ---
----@return table[] List of captures `{ capture = "capture name", metadata = { ... } }`
+---@return table[] List of captures `{ capture = "name", metadata = { ... } }`
 function M.get_captures_at_pos(bufnr, row, col)
   if bufnr == 0 then
     bufnr = a.nvim_get_current_buf()
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 83910316a6..58a29f2fe0 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -639,7 +639,7 @@ end
 ---   -- typically useful info about the node:
 ---   local type = node:type() -- type of the captured node
 ---   local row1, col1, row2, col2 = node:range() -- range of the capture
----   ... use the info here ...
+---   -- ... use the info here ...
 --- end
 --- </pre>
 ---
@@ -693,7 +693,7 @@ end
 ---
 ---     local node_data = metadata[id] -- Node level metadata
 ---
----     ... use the info here ...
+---     -- ... use the info here ...
 ---   end
 --- end
 --- </pre>
-- 
cgit 


From f140175564001cc1ad84128a0147a5d2f7798a63 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Thu, 23 Feb 2023 13:35:46 +0100
Subject: refactor(lsp): remove workaround for missing bit module (#22373)

---
 runtime/lua/vim/lsp/semantic_tokens.lua | 15 ++++-----------
 1 file changed, 4 insertions(+), 11 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index b1bc48dac6..00b4757ea9 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -1,6 +1,7 @@
 local api = vim.api
 local handlers = require('vim.lsp.handlers')
 local util = require('vim.lsp.util')
+local bit = require('bit')
 
 --- @class STTokenRange
 --- @field line number line number 0-based
@@ -58,18 +59,10 @@ local function modifiers_from_number(x, modifiers_table)
   local modifiers = {}
   local idx = 1
   while x > 0 do
-    if _G.bit then
-      if _G.bit.band(x, 1) == 1 then
-        modifiers[#modifiers + 1] = modifiers_table[idx]
-      end
-      x = _G.bit.rshift(x, 1)
-    else
-      --TODO(jdrouhard): remove this branch once `bit` module is available for non-LuaJIT (#21222)
-      if x % 2 == 1 then
-        modifiers[#modifiers + 1] = modifiers_table[idx]
-      end
-      x = math.floor(x / 2)
+    if bit.band(x, 1) == 1 then
+      modifiers[#modifiers + 1] = modifiers_table[idx]
     end
+    x = bit.rshift(x, 1)
     idx = idx + 1
   end
 
-- 
cgit 


From 75e53341f37eeeda7d9be7f934249f7e5e4397e9 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 23 Feb 2023 15:19:52 +0000
Subject: perf(treesitter): smarter languagetree invalidation

Problem:
  Treesitter injections are slow because all injected trees are invalidated on every change.

Solution:
    Implement smarter invalidation to avoid reparsing injected regions.

    - In on_bytes, try and update self._regions as best we can. This PR just offsets any regions after the change.
    - Add valid flags for each region in self._regions.
    - Call on_bytes recursively for all children.
       - We still need to run the query every time for the top level tree. I don't know how to avoid this. However, if the new injection ranges don't change, then we re-use the old trees and avoid reparsing children.

This should result in roughly a 2-3x reduction in tree parsing when the comment injections are enabled.
---
 runtime/lua/vim/treesitter/_range.lua       | 126 ++++++++++++++
 runtime/lua/vim/treesitter/languagetree.lua | 249 ++++++++++++++++++----------
 runtime/lua/vim/treesitter/query.lua        |   2 +-
 3 files changed, 290 insertions(+), 87 deletions(-)
 create mode 100644 runtime/lua/vim/treesitter/_range.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_range.lua b/runtime/lua/vim/treesitter/_range.lua
new file mode 100644
index 0000000000..b87542c20f
--- /dev/null
+++ b/runtime/lua/vim/treesitter/_range.lua
@@ -0,0 +1,126 @@
+local api = vim.api
+
+local M = {}
+
+---@alias Range4 {[1]: integer, [2]: integer, [3]: integer, [4]: integer}
+---@alias Range6 {[1]: integer, [2]: integer, [3]: integer, [4]: integer, [5]: integer, [6]: integer}
+
+---@private
+---@param a_row integer
+---@param a_col integer
+---@param b_row integer
+---@param b_col integer
+---@return integer
+--- 1: a > b
+--- 0: a == b
+--- -1: a < b
+local function cmp_pos(a_row, a_col, b_row, b_col)
+  if a_row == b_row then
+    if a_col > b_col then
+      return 1
+    elseif a_col < b_col then
+      return -1
+    else
+      return 0
+    end
+  elseif a_row > b_row then
+    return 1
+  end
+
+  return -1
+end
+
+M.cmp_pos = {
+  lt = function(...)
+    return cmp_pos(...) == -1
+  end,
+  le = function(...)
+    return cmp_pos(...) ~= 1
+  end,
+  gt = function(...)
+    return cmp_pos(...) == 1
+  end,
+  ge = function(...)
+    return cmp_pos(...) ~= -1
+  end,
+  eq = function(...)
+    return cmp_pos(...) == 0
+  end,
+  ne = function(...)
+    return cmp_pos(...) ~= 0
+  end,
+}
+
+setmetatable(M.cmp_pos, { __call = cmp_pos })
+
+---@private
+---@param r1 Range4|Range6
+---@param r2 Range4|Range6
+---@return boolean
+function M.intercepts(r1, r2)
+  local off_1 = #r1 == 6 and 1 or 0
+  local off_2 = #r1 == 6 and 1 or 0
+
+  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r2[2], r1[3 + off_1], r1[4 + off_1]
+  local srow_2, scol_2, erow_2, ecol_2 = r2[1], r2[2], r2[3 + off_2], r2[4 + off_2]
+
+  -- r1 is above r2
+  if M.cmp_pos.le(erow_1, ecol_1, srow_2, scol_2) then
+    return false
+  end
+
+  -- r1 is below r2
+  if M.cmp_pos.ge(srow_1, scol_1, erow_2, ecol_2) then
+    return false
+  end
+
+  return true
+end
+
+---@private
+---@param r1 Range4|Range6
+---@param r2 Range4|Range6
+---@return boolean whether r1 contains r2
+function M.contains(r1, r2)
+  local off_1 = #r1 == 6 and 1 or 0
+  local off_2 = #r1 == 6 and 1 or 0
+
+  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r2[2], r1[3 + off_1], r1[4 + off_1]
+  local srow_2, scol_2, erow_2, ecol_2 = r2[1], r2[2], r2[3 + off_2], r2[4 + off_2]
+
+  -- start doesn't fit
+  if M.cmp_pos.gt(srow_1, scol_1, srow_2, scol_2) then
+    return false
+  end
+
+  -- end doesn't fit
+  if M.cmp_pos.lt(erow_1, ecol_1, erow_2, ecol_2) then
+    return false
+  end
+
+  return true
+end
+
+---@private
+---@param source integer|string
+---@param range Range4
+---@return Range6
+function M.add_bytes(source, range)
+  local start_row, start_col, end_row, end_col = range[1], range[2], range[3], range[4]
+  local start_byte = 0
+  local end_byte = 0
+  -- TODO(vigoux): proper byte computation here, and account for EOL ?
+  if type(source) == 'number' then
+    -- Easy case, this is a buffer parser
+    start_byte = api.nvim_buf_get_offset(source, start_row) + start_col
+    end_byte = api.nvim_buf_get_offset(source, end_row) + end_col
+  elseif type(source) == 'string' then
+    -- string parser, single `\n` delimited string
+    start_byte = vim.fn.byteidx(source, start_col)
+    end_byte = vim.fn.byteidx(source, end_col)
+  end
+
+  return { start_row, start_col, start_byte, end_row, end_col, end_byte }
+end
+
+return M
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index c9fd4bb2ea..2d4e2e595b 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -1,9 +1,8 @@
 local a = vim.api
 local query = require('vim.treesitter.query')
 local language = require('vim.treesitter.language')
+local Range = require('vim.treesitter._range')
 
----@alias Range {[1]: integer, [2]: integer, [3]: integer, [4]: integer}
---
 ---@alias TSCallbackName
 ---| 'changedtree'
 ---| 'bytes'
@@ -24,11 +23,13 @@ local language = require('vim.treesitter.language')
 ---@field private _injection_query Query Queries defining injected languages
 ---@field private _opts table Options
 ---@field private _parser TSParser Parser for language
----@field private _regions Range[][] List of regions this tree should manage and parse
+---@field private _regions Range6[][] List of regions this tree should manage and parse
 ---@field private _lang string Language name
 ---@field private _source (integer|string) Buffer or string to parse
 ---@field private _trees TSTree[] Reference to parsed tree (one for each language)
----@field private _valid boolean If the parsed tree is valid
+---@field private _valid boolean|table<integer,true> If the parsed tree is valid
+--- TODO(lewis6991): combine _regions, _valid and _trees
+---@field private _is_child boolean
 local LanguageTree = {}
 
 ---@class LanguageTreeOpts
@@ -114,6 +115,9 @@ end
 --- If the tree is invalid, call `parse()`.
 --- This will return the updated tree.
 function LanguageTree:is_valid()
+  if type(self._valid) == 'table' then
+    return #self._valid == #self._regions
+  end
   return self._valid
 end
 
@@ -127,6 +131,16 @@ function LanguageTree:source()
   return self._source
 end
 
+---@private
+---This is only exposed so it can be wrapped for profiling
+---@param old_tree TSTree
+---@return TSTree, integer[]
+function LanguageTree:_parse_tree(old_tree)
+  local tree, tree_changes = self._parser:parse(old_tree, self._source)
+  self:_do_callback('changedtree', tree_changes, tree)
+  return tree, tree_changes
+end
+
 --- Parses all defined regions using a treesitter parser
 --- for the language this tree represents.
 --- This will run the injection query for this language to
@@ -135,35 +149,27 @@ end
 ---@return TSTree[]
 ---@return table|nil Change list
 function LanguageTree:parse()
-  if self._valid then
+  if self:is_valid() then
     return self._trees
   end
 
-  local parser = self._parser
   local changes = {}
 
-  local old_trees = self._trees
-  self._trees = {}
-
   -- If there are no ranges, set to an empty list
   -- so the included ranges in the parser are cleared.
-  if self._regions and #self._regions > 0 then
+  if #self._regions > 0 then
     for i, ranges in ipairs(self._regions) do
-      local old_tree = old_trees[i]
-      parser:set_included_ranges(ranges)
-
-      local tree, tree_changes = parser:parse(old_tree, self._source)
-      self:_do_callback('changedtree', tree_changes, tree)
-
-      table.insert(self._trees, tree)
-      vim.list_extend(changes, tree_changes)
+      if not self._valid or not self._valid[i] then
+        self._parser:set_included_ranges(ranges)
+        local tree, tree_changes = self:_parse_tree(self._trees[i])
+        self._trees[i] = tree
+        vim.list_extend(changes, tree_changes)
+      end
     end
   else
-    local tree, tree_changes = parser:parse(old_trees[1], self._source)
-    self:_do_callback('changedtree', tree_changes, tree)
-
-    table.insert(self._trees, tree)
-    vim.list_extend(changes, tree_changes)
+    local tree, tree_changes = self:_parse_tree(self._trees[1])
+    self._trees = { tree }
+    changes = tree_changes
   end
 
   local injections_by_lang = self:_get_injections()
@@ -249,6 +255,7 @@ function LanguageTree:add_child(lang)
   end
 
   self._children[lang] = LanguageTree.new(self._source, lang, self._opts)
+  self._children[lang]._is_child = true
 
   self:invalidate()
   self:_do_callback('child_added', self._children[lang])
@@ -298,43 +305,35 @@ end
 --- This allows for embedded languages to be parsed together across different
 --- nodes, which is useful for templating languages like ERB and EJS.
 ---
---- Note: This call invalidates the tree and requires it to be parsed again.
----
 ---@private
----@param regions integer[][][] List of regions this tree should manage and parse.
+---@param regions Range4[][] List of regions this tree should manage and parse.
 function LanguageTree:set_included_regions(regions)
   -- Transform the tables from 4 element long to 6 element long (with byte offset)
   for _, region in ipairs(regions) do
     for i, range in ipairs(region) do
       if type(range) == 'table' and #range == 4 then
-        ---@diagnostic disable-next-line:no-unknown
-        local start_row, start_col, end_row, end_col = unpack(range)
-        local start_byte = 0
-        local end_byte = 0
-        local source = self._source
-        -- TODO(vigoux): proper byte computation here, and account for EOL ?
-        if type(source) == 'number' then
-          -- Easy case, this is a buffer parser
-          start_byte = a.nvim_buf_get_offset(source, start_row) + start_col
-          end_byte = a.nvim_buf_get_offset(source, end_row) + end_col
-        elseif type(self._source) == 'string' then
-          -- string parser, single `\n` delimited string
-          start_byte = vim.fn.byteidx(self._source, start_col)
-          end_byte = vim.fn.byteidx(self._source, end_col)
-        end
+        region[i] = Range.add_bytes(self._source, range)
+      end
+    end
+  end
 
-        region[i] = { start_row, start_col, start_byte, end_row, end_col, end_byte }
+  if #self._regions ~= #regions then
+    self._trees = {}
+    self:invalidate()
+  elseif self._valid ~= false then
+    if self._valid == true then
+      self._valid = {}
+    end
+    for i = 1, #regions do
+      self._valid[i] = true
+      if not vim.deep_equal(self._regions[i], regions[i]) then
+        self._valid[i] = nil
+        self._trees[i] = nil
       end
     end
   end
 
   self._regions = regions
-  -- Trees are no longer valid now that we have changed regions.
-  -- TODO(vigoux,steelsojka): Look into doing this smarter so we can use some of the
-  --                          old trees for incremental parsing. Currently, this only
-  --                          affects injected languages.
-  self._trees = {}
-  self:invalidate()
 end
 
 --- Gets the set of included regions
@@ -346,10 +345,10 @@ end
 ---@param node TSNode
 ---@param id integer
 ---@param metadata TSMetadata
----@return Range
+---@return Range4
 local function get_range_from_metadata(node, id, metadata)
   if metadata[id] and metadata[id].range then
-    return metadata[id].range --[[@as Range]]
+    return metadata[id].range --[[@as Range4]]
   end
   return { node:range() }
 end
@@ -378,7 +377,7 @@ function LanguageTree:_get_injections()
       self._injection_query:iter_matches(root_node, self._source, start_line, end_line + 1)
     do
       local lang = nil ---@type string
-      local ranges = {} ---@type Range[]
+      local ranges = {} ---@type Range4[]
       local combined = metadata.combined ---@type boolean
 
       -- Directives can configure how injections are captured as well as actual node captures.
@@ -408,6 +407,7 @@ function LanguageTree:_get_injections()
 
         -- Lang should override any other language tag
         if name == 'language' and not lang then
+          ---@diagnostic disable-next-line
           lang = query.get_node_text(node, self._source, { metadata = metadata[id] })
         elseif name == 'combined' then
           combined = true
@@ -426,6 +426,8 @@ function LanguageTree:_get_injections()
         end
       end
 
+      assert(type(lang) == 'string')
+
       -- Each tree index should be isolated from the other nodes.
       if not injections[tree_index] then
         injections[tree_index] = {}
@@ -446,7 +448,7 @@ function LanguageTree:_get_injections()
     end
   end
 
-  ---@type table<string,Range[][]>
+  ---@type table<string,Range4[][]>
   local result = {}
 
   -- Generate a map by lang of node lists.
@@ -485,6 +487,45 @@ function LanguageTree:_do_callback(cb_name, ...)
   end
 end
 
+---@private
+---@param regions Range6[][]
+---@param old_range Range6
+---@param new_range Range6
+---@return table<integer, true> region indices to invalidate
+local function update_regions(regions, old_range, new_range)
+  ---@type table<integer,true>
+  local valid = {}
+
+  for i, ranges in ipairs(regions or {}) do
+    valid[i] = true
+    for j, r in ipairs(ranges) do
+      if Range.intercepts(r, old_range) then
+        valid[i] = nil
+        break
+      end
+
+      -- Range after change. Adjust
+      if Range.cmp_pos.gt(r[1], r[2], old_range[4], old_range[5]) then
+        local byte_offset = new_range[6] - old_range[6]
+        local row_offset = new_range[4] - old_range[4]
+
+        -- Update the range to avoid invalidation in set_included_regions()
+        -- which will compare the regions against the parsed injection regions
+        ranges[j] = {
+          r[1] + row_offset,
+          r[2],
+          r[3] + byte_offset,
+          r[4] + row_offset,
+          r[5],
+          r[6] + byte_offset,
+        }
+      end
+    end
+  end
+
+  return valid
+end
+
 ---@private
 ---@param bufnr integer
 ---@param changed_tick integer
@@ -510,14 +551,53 @@ function LanguageTree:_on_bytes(
   new_col,
   new_byte
 )
-  self:invalidate()
-
   local old_end_col = old_col + ((old_row == 0) and start_col or 0)
   local new_end_col = new_col + ((new_row == 0) and start_col or 0)
 
-  -- Edit all trees recursively, together BEFORE emitting a bytes callback.
-  -- In most cases this callback should only be called from the root tree.
-  self:for_each_tree(function(tree)
+  local old_range = {
+    start_row,
+    start_col,
+    start_byte,
+    start_row + old_row,
+    old_end_col,
+    start_byte + old_byte,
+  }
+
+  local new_range = {
+    start_row,
+    start_col,
+    start_byte,
+    start_row + new_row,
+    new_end_col,
+    start_byte + new_byte,
+  }
+
+  local valid_regions = update_regions(self._regions, old_range, new_range)
+
+  if #self._regions == 0 or #valid_regions == 0 then
+    self._valid = false
+  else
+    self._valid = valid_regions
+  end
+
+  for _, child in pairs(self._children) do
+    child:_on_bytes(
+      bufnr,
+      changed_tick,
+      start_row,
+      start_col,
+      start_byte,
+      old_row,
+      old_col,
+      old_byte,
+      new_row,
+      new_col,
+      new_byte
+    )
+  end
+
+  -- Edit trees together BEFORE emitting a bytes callback.
+  for _, tree in ipairs(self._trees) do
     tree:edit(
       start_byte,
       start_byte + old_byte,
@@ -529,22 +609,24 @@ function LanguageTree:_on_bytes(
       start_row + new_row,
       new_end_col
     )
-  end)
+  end
 
-  self:_do_callback(
-    'bytes',
-    bufnr,
-    changed_tick,
-    start_row,
-    start_col,
-    start_byte,
-    old_row,
-    old_col,
-    old_byte,
-    new_row,
-    new_col,
-    new_byte
-  )
+  if not self._is_child then
+    self:_do_callback(
+      'bytes',
+      bufnr,
+      changed_tick,
+      start_row,
+      start_col,
+      start_byte,
+      old_row,
+      old_col,
+      old_byte,
+      new_row,
+      new_col,
+      new_byte
+    )
+  end
 end
 
 ---@private
@@ -595,19 +677,15 @@ end
 
 ---@private
 ---@param tree TSTree
----@param range Range
+---@param range Range4
 ---@return boolean
 local function tree_contains(tree, range)
-  local start_row, start_col, end_row, end_col = tree:root():range()
-  local start_fits = start_row < range[1] or (start_row == range[1] and start_col <= range[2])
-  local end_fits = end_row > range[3] or (end_row == range[3] and end_col >= range[4])
-
-  return start_fits and end_fits
+  return Range.contains({ tree:root():range() }, range)
 end
 
 --- Determines whether {range} is contained in the |LanguageTree|.
 ---
----@param range Range `{ start_line, start_col, end_line, end_col }`
+---@param range Range4 `{ start_line, start_col, end_line, end_col }`
 ---@return boolean
 function LanguageTree:contains(range)
   for _, tree in pairs(self._trees) do
@@ -621,7 +699,7 @@ end
 
 --- Gets the tree that contains {range}.
 ---
----@param range Range `{ start_line, start_col, end_line, end_col }`
+---@param range Range4 `{ start_line, start_col, end_line, end_col }`
 ---@param opts table|nil Optional keyword arguments:
 ---             - ignore_injections boolean Ignore injected languages (default true)
 ---@return TSTree|nil
@@ -631,10 +709,9 @@ function LanguageTree:tree_for_range(range, opts)
 
   if not ignore then
     for _, child in pairs(self._children) do
-      for _, tree in pairs(child:trees()) do
-        if tree_contains(tree, range) then
-          return tree
-        end
+      local tree = child:tree_for_range(range, opts)
+      if tree then
+        return tree
       end
     end
   end
@@ -650,7 +727,7 @@ end
 
 --- Gets the smallest named node that contains {range}.
 ---
----@param range Range `{ start_line, start_col, end_line, end_col }`
+---@param range Range4 `{ start_line, start_col, end_line, end_col }`
 ---@param opts table|nil Optional keyword arguments:
 ---             - ignore_injections boolean Ignore injected languages (default true)
 ---@return TSNode | nil Found node
@@ -663,7 +740,7 @@ end
 
 --- Gets the appropriate language that contains {range}.
 ---
----@param range Range `{ start_line, start_col, end_line, end_col }`
+---@param range Range4 `{ start_line, start_col, end_line, end_col }`
 ---@return LanguageTree Managing {range}
 function LanguageTree:language_for_range(range)
   for _, child in pairs(self._children) do
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 58a29f2fe0..13d98a0625 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -406,7 +406,7 @@ predicate_handlers['vim-match?'] = predicate_handlers['match?']
 ---@class TSMetadata
 ---@field [integer] TSMetadata
 ---@field [string] integer|string
----@field range Range
+---@field range Range4
 
 ---@alias TSDirective fun(match: TSMatch, _, _, predicate: any[], metadata: TSMetadata)
 
-- 
cgit 


From 8c339aa04b2a1ca99a297b2eada8ebc6218f5f1c Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Thu, 23 Feb 2023 17:52:33 +0100
Subject: vim-patch:9.0.1346: Starlark files are not recognized (#22380)

Problem:    Starlark files are not recognized.
Solution:   Add patterns for Starlark files. (Amaan Qureshi, closes vim/vim#12049)

https://github.com/vim/vim/commit/ca06b30073de22dc120b532e90fbee2a10ef9772

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 0dd2dcfcbe..ae3ad6f628 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -995,6 +995,9 @@ local extension = {
   ssa = 'ssa',
   ass = 'ssa',
   st = 'st',
+  ipd = 'starlark',
+  star = 'starlark',
+  starlark = 'starlark',
   imata = 'stata',
   ['do'] = 'stata',
   mata = 'stata',
-- 
cgit 


From 1df3f5ec6aca24cbe7b78ead5c37ad06a65c84e8 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 23 Feb 2023 17:05:20 +0000
Subject: feat(treesitter): upstream foldexpr from nvim-treesitter

---
 runtime/lua/vim/treesitter.lua       |  20 ++++
 runtime/lua/vim/treesitter/_fold.lua | 173 +++++++++++++++++++++++++++++++++++
 2 files changed, 193 insertions(+)
 create mode 100644 runtime/lua/vim/treesitter/_fold.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 44922bbc4d..fead7b7b1b 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -115,6 +115,16 @@ function M.get_parser(bufnr, lang, opts)
   return parsers[bufnr]
 end
 
+---@private
+---@param bufnr (integer|nil) Buffer number
+---@return boolean
+function M._has_parser(bufnr)
+  if bufnr == nil or bufnr == 0 then
+    bufnr = a.nvim_get_current_buf()
+  end
+  return parsers[bufnr] ~= nil
+end
+
 --- Returns a string parser
 ---
 ---@param str string Text to parse
@@ -612,4 +622,14 @@ function M.show_tree(opts)
   })
 end
 
+--- Returns the fold level for {lnum} in the current buffer. Can be set directly to 'foldexpr':
+--- <pre>lua
+--- vim.wo.foldexpr = 'v:lua.vim.treesitter.foldexpr()'
+--- </pre>
+---@param lnum integer|nil Line number to calculate fold level for
+---@return string
+function M.foldexpr(lnum)
+  return require('vim.treesitter._fold').foldexpr(lnum)
+end
+
 return M
diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
new file mode 100644
index 0000000000..a66cc6d543
--- /dev/null
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -0,0 +1,173 @@
+local api = vim.api
+
+local M = {}
+
+--- Memoizes a function based on the buffer tick of the provided bufnr.
+--- The cache entry is cleared when the buffer is detached to avoid memory leaks.
+---@generic F: function
+---@param fn F fn to memoize, taking the bufnr as first argument
+---@return F
+local function memoize_by_changedtick(fn)
+  ---@type table<integer,{result:any,last_tick:integer}>
+  local cache = {}
+
+  ---@param bufnr integer
+  return function(bufnr, ...)
+    local tick = api.nvim_buf_get_changedtick(bufnr)
+
+    if cache[bufnr] then
+      if cache[bufnr].last_tick == tick then
+        return cache[bufnr].result
+      end
+    else
+      local function detach_handler()
+        cache[bufnr] = nil
+      end
+
+      -- Clean up logic only!
+      api.nvim_buf_attach(bufnr, false, {
+        on_detach = detach_handler,
+        on_reload = detach_handler,
+      })
+    end
+
+    cache[bufnr] = {
+      result = fn(bufnr, ...),
+      last_tick = tick,
+    }
+
+    return cache[bufnr].result
+  end
+end
+
+---@param bufnr integer
+---@param capture string
+---@param query_name string
+---@param callback fun(id: integer, node:TSNode, metadata: TSMetadata)
+local function iter_matches_with_capture(bufnr, capture, query_name, callback)
+  local parser = vim.treesitter.get_parser(bufnr)
+
+  if not parser then
+    return
+  end
+
+  parser:for_each_tree(function(tree, lang_tree)
+    local lang = lang_tree:lang()
+    local query = vim.treesitter.query.get_query(lang, query_name)
+    if query then
+      local root = tree:root()
+      local start, _, stop = root:range()
+      for _, match, metadata in query:iter_matches(root, bufnr, start, stop) do
+        for id, node in pairs(match) do
+          if query.captures[id] == capture then
+            callback(id, node, metadata)
+          end
+        end
+      end
+    end
+  end)
+end
+
+---@private
+--- TODO(lewis6991): copied from languagetree.lua. Consolidate
+---@param node TSNode
+---@param id integer
+---@param metadata TSMetadata
+---@return Range
+local function get_range_from_metadata(node, id, metadata)
+  if metadata[id] and metadata[id].range then
+    return metadata[id].range --[[@as Range]]
+  end
+  return { node:range() }
+end
+
+-- This is cached on buf tick to avoid computing that multiple times
+-- Especially not for every line in the file when `zx` is hit
+---@param bufnr integer
+---@return table<integer,string>
+local folds_levels = memoize_by_changedtick(function(bufnr)
+  local max_fold_level = vim.wo.foldnestmax
+  local function trim_level(level)
+    if level > max_fold_level then
+      return max_fold_level
+    end
+    return level
+  end
+
+  -- start..stop is an inclusive range
+  local start_counts = {} ---@type table<integer,integer>
+  local stop_counts = {} ---@type table<integer,integer>
+
+  local prev_start = -1
+  local prev_stop = -1
+
+  local min_fold_lines = vim.wo.foldminlines
+
+  iter_matches_with_capture(bufnr, 'fold', 'folds', function(id, node, metadata)
+    local range = get_range_from_metadata(node, id, metadata)
+    local start, stop, stop_col = range[1], range[3], range[4]
+
+    if stop_col == 0 then
+      stop = stop - 1
+    end
+
+    local fold_length = stop - start + 1
+
+    -- Fold only multiline nodes that are not exactly the same as previously met folds
+    -- Checking against just the previously found fold is sufficient if nodes
+    -- are returned in preorder or postorder when traversing tree
+    if fold_length > min_fold_lines and not (start == prev_start and stop == prev_stop) then
+      start_counts[start] = (start_counts[start] or 0) + 1
+      stop_counts[stop] = (stop_counts[stop] or 0) + 1
+      prev_start = start
+      prev_stop = stop
+    end
+  end)
+
+  ---@type table<integer,string>
+  local levels = {}
+  local current_level = 0
+
+  -- We now have the list of fold opening and closing, fill the gaps and mark where fold start
+  for lnum = 0, api.nvim_buf_line_count(bufnr) do
+    local last_trimmed_level = trim_level(current_level)
+    current_level = current_level + (start_counts[lnum] or 0)
+    local trimmed_level = trim_level(current_level)
+    current_level = current_level - (stop_counts[lnum] or 0)
+
+    -- Determine if it's the start/end of a fold
+    -- NB: vim's fold-expr interface does not have a mechanism to indicate that
+    -- two (or more) folds start at this line, so it cannot distinguish between
+    --  ( \n ( \n )) \n (( \n ) \n )
+    -- versus
+    --  ( \n ( \n ) \n ( \n ) \n )
+    -- If it did have such a mechanism, (trimmed_level - last_trimmed_level)
+    -- would be the correct number of starts to pass on.
+    local prefix = ''
+    if trimmed_level - last_trimmed_level > 0 then
+      prefix = '>'
+    end
+
+    levels[lnum + 1] = prefix .. tostring(trimmed_level)
+  end
+
+  return levels
+end)
+
+---@param lnum integer|nil
+---@return string
+function M.foldexpr(lnum)
+  lnum = lnum or vim.v.lnum
+  local bufnr = api.nvim_get_current_buf()
+
+  ---@diagnostic disable-next-line:invisible
+  if not vim.treesitter._has_parser(bufnr) or not lnum then
+    return '0'
+  end
+
+  local levels = folds_levels(bufnr) or {}
+
+  return levels[lnum] or '0'
+end
+
+return M
-- 
cgit 


From 3f35ebb14dd8b1ceeef45c4f42949f14e3b54b88 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 23 Feb 2023 18:09:44 +0000
Subject: fix(treesitter): fixup language invalidation (#22381)

---
 runtime/lua/vim/treesitter/languagetree.lua | 38 +++++++++++++++++++----------
 1 file changed, 25 insertions(+), 13 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 2d4e2e595b..122496cff3 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -27,7 +27,7 @@ local Range = require('vim.treesitter._range')
 ---@field private _lang string Language name
 ---@field private _source (integer|string) Buffer or string to parse
 ---@field private _trees TSTree[] Reference to parsed tree (one for each language)
----@field private _valid boolean|table<integer,true> If the parsed tree is valid
+---@field private _valid boolean|table<integer,boolean> If the parsed tree is valid
 --- TODO(lewis6991): combine _regions, _valid and _trees
 ---@field private _is_child boolean
 local LanguageTree = {}
@@ -115,10 +115,18 @@ end
 --- If the tree is invalid, call `parse()`.
 --- This will return the updated tree.
 function LanguageTree:is_valid()
-  if type(self._valid) == 'table' then
-    return #self._valid == #self._regions
+  local valid = self._valid
+
+  if type(valid) == 'table' then
+    for _, v in ipairs(valid) do
+      if not v then
+        return false
+      end
+    end
+    return true
   end
-  return self._valid
+
+  return valid
 end
 
 --- Returns a map of language to child tree.
@@ -323,11 +331,17 @@ function LanguageTree:set_included_regions(regions)
   elseif self._valid ~= false then
     if self._valid == true then
       self._valid = {}
+      for i = 1, #regions do
+        self._valid[i] = true
+      end
     end
+
     for i = 1, #regions do
-      self._valid[i] = true
       if not vim.deep_equal(self._regions[i], regions[i]) then
-        self._valid[i] = nil
+        self._valid[i] = false
+      end
+
+      if not self._valid[i] then
         self._trees[i] = nil
       end
     end
@@ -491,16 +505,16 @@ end
 ---@param regions Range6[][]
 ---@param old_range Range6
 ---@param new_range Range6
----@return table<integer, true> region indices to invalidate
+---@return table<integer,boolean> region indices to invalidate
 local function update_regions(regions, old_range, new_range)
-  ---@type table<integer,true>
+  ---@type table<integer,boolean>
   local valid = {}
 
   for i, ranges in ipairs(regions or {}) do
     valid[i] = true
     for j, r in ipairs(ranges) do
       if Range.intercepts(r, old_range) then
-        valid[i] = nil
+        valid[i] = false
         break
       end
 
@@ -572,12 +586,10 @@ function LanguageTree:_on_bytes(
     start_byte + new_byte,
   }
 
-  local valid_regions = update_regions(self._regions, old_range, new_range)
-
-  if #self._regions == 0 or #valid_regions == 0 then
+  if #self._regions == 0 then
     self._valid = false
   else
-    self._valid = valid_regions
+    self._valid = update_regions(self._regions, old_range, new_range)
   end
 
   for _, child in pairs(self._children) do
-- 
cgit 


From 5e1308b7caa89b458cc97d2db956379aa54ed68a Mon Sep 17 00:00:00 2001
From: Amaan Qureshi <amaanq12@gmail.com>
Date: Thu, 23 Feb 2023 16:12:01 -0500
Subject: vim-patch:9.0.1348: Un-grammar files are not recognized (#22383)

Problem:    Un-grammar files are not recognized.
Solution:   Add patterns for Un-grammar files. (Amaan Qureshi, closes vim/vim#12034)

https://github.com/vim/vim/commit/44e08c1cf83f5a50f8b21613551304a6651c1161
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index ae3ad6f628..3a68b61914 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1056,6 +1056,7 @@ local extension = {
   uc = 'uc',
   uit = 'uil',
   uil = 'uil',
+  ungram = 'ungrammar',
   sba = 'vb',
   vb = 'vb',
   dsm = 'vb',
-- 
cgit 


From c57af5d41cd039194dbd9c6fb5b68b377d2a5b59 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 24 Feb 2023 09:50:59 +0000
Subject: feat(treesitter)!: remove silent option from language.add()

Simply use `pcall` if you want to silence an error.
---
 runtime/lua/vim/treesitter/language.lua     | 32 ++++++++++-------------------
 runtime/lua/vim/treesitter/languagetree.lua |  2 +-
 2 files changed, 12 insertions(+), 22 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index 8637d7d544..0796383bf5 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -13,11 +13,19 @@ end
 
 ---@deprecated
 function M.require_language(lang, path, silent, symbol_name)
-  return M.add(lang, {
+  local opts = {
     silent = silent,
     path = path,
     symbol_name = symbol_name,
-  })
+  }
+
+  if silent then
+    local installed = pcall(M.add, lang, opts)
+    return installed
+  end
+
+  M.add(lang, opts)
+  return true
 end
 
 ---@class treesitter.RequireLangOpts
@@ -38,20 +46,16 @@ end
 ---                          Defaults to lang.
 ---                        - path (string|nil) Optional path the parser is located at
 ---                        - symbol_name (string|nil) Internal symbol name for the language to load
----                        - silent (boolean|nil) Don't throw an error if language not found
----@return boolean If the specified language is installed
 function M.add(lang, opts)
   ---@cast opts treesitter.RequireLangOpts
   opts = opts or {}
   local path = opts.path
-  local silent = opts.silent
   local filetype = opts.filetype or lang
   local symbol_name = opts.symbol_name
 
   vim.validate({
     lang = { lang, 'string' },
     path = { path, 'string', true },
-    silent = { silent, 'boolean', true },
     symbol_name = { symbol_name, 'string', true },
     filetype = { filetype, { 'string', 'table' }, true },
   })
@@ -64,32 +68,18 @@ function M.add(lang, opts)
 
   if path == nil then
     if not (lang and lang:match('[%w_]+') == lang) then
-      if silent then
-        return false
-      end
       error("'" .. lang .. "' is not a valid language name")
     end
 
     local fname = 'parser/' .. lang .. '.*'
     local paths = a.nvim_get_runtime_file(fname, false)
     if #paths == 0 then
-      if silent then
-        return false
-      end
       error("no parser for '" .. lang .. "' language, see :help treesitter-parsers")
     end
     path = paths[1]
   end
 
-  if silent then
-    if not pcall(vim._ts_add_language, path, lang, symbol_name) then
-      return false
-    end
-  else
-    vim._ts_add_language(path, lang, symbol_name)
-  end
-
-  return true
+  vim._ts_add_language(path, lang, symbol_name)
 end
 
 --- Register a lang to be used for a filetype (or list of filetypes).
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 122496cff3..7ec7bbfa12 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -184,7 +184,7 @@ function LanguageTree:parse()
   local seen_langs = {} ---@type table<string,boolean>
 
   for lang, injection_ranges in pairs(injections_by_lang) do
-    local has_lang = language.add(lang, { silent = true })
+    local has_lang = pcall(language.add, lang)
 
     -- Child language trees should just be ignored if not found, since
     -- they can depend on the text of a node. Intermediate strings
-- 
cgit 


From 1803dadb209b9193ad8673b243091a4602b3a855 Mon Sep 17 00:00:00 2001
From: Raphael <glephunter@gmail.com>
Date: Fri, 24 Feb 2023 19:55:50 +0800
Subject: refactor(lsp): remove deprecated code (#22389)

---
 runtime/lua/vim/lsp.lua | 20 --------------------
 1 file changed, 20 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 0a620e1367..206c7c9b7e 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1294,26 +1294,6 @@ function lsp.start_client(config)
       client.server_capabilities =
         assert(result.capabilities, "initialize result doesn't contain capabilities")
       client.server_capabilities = protocol.resolve_capabilities(client.server_capabilities)
-
-      -- Deprecation wrapper: this will be removed in 0.8
-      local mt = {}
-      mt.__index = function(table, key)
-        if key == 'resolved_capabilities' then
-          vim.notify_once(
-            '[LSP] Accessing client.resolved_capabilities is deprecated, '
-              .. 'update your plugins or configuration to access client.server_capabilities instead.'
-              .. 'The new key/value pairs in server_capabilities directly match those '
-              .. 'defined in the language server protocol',
-            vim.log.levels.WARN
-          )
-          rawset(table, key, protocol._resolve_capabilities_compat(client.server_capabilities))
-          return rawget(table, key)
-        else
-          return rawget(table, key)
-        end
-      end
-      setmetatable(client, mt)
-
       client.supports_method = function(method)
         local required_capability = lsp._request_name_to_capability[method]
         -- if we don't know about the method, assume that the client supports it.
-- 
cgit 


From 4297127f14fa1b9062db7de0d63981887ebed063 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 24 Feb 2023 15:34:52 +0100
Subject: vim-patch:9.0.1350: CPON files are not recognized (#22392)

Problem:    CPON files are not recognized.
Solution:   Add patterns for CPON files. (Amaan Qureshi, closes vim/vim#12053)

https://github.com/vim/vim/commit/c2254764bcada43eea894eb5852a26d5ac5ca8b0

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 3a68b61914..5475f09444 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -242,6 +242,7 @@ local extension = {
   csh = function(path, bufnr)
     return require('vim.filetype.detect').csh(path, bufnr)
   end,
+  cpon = 'cpon',
   moc = 'cpp',
   hh = 'cpp',
   tlh = 'cpp',
-- 
cgit 


From 15cce77b383d0b0bfdaa1415cdde005cc43267d0 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 24 Feb 2023 17:50:37 +0100
Subject: vim-patch:9.0.1351: Dhall files are not recognized (#22393)

Problem:    Dhall files are not recognized.
Solution:   Add patterns for Dhall files. (Amaan Qureshi, closes vim/vim#12052)

https://github.com/vim/vim/commit/def5521752abefe12db8cc3111a3b205ad1ac929

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 5475f09444..a4e078fd04 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -296,6 +296,7 @@ local extension = {
   desc = 'desc',
   directory = 'desktop',
   desktop = 'desktop',
+  dhall = 'dhall',
   diff = 'diff',
   rej = 'diff',
   Dockerfile = 'dockerfile',
-- 
cgit 


From 5732aa706c639b3d775573d91d1139f24624629c Mon Sep 17 00:00:00 2001
From: Jon Huhn <nojnhuh@users.noreply.github.com>
Date: Sat, 25 Feb 2023 03:07:18 -0600
Subject: feat(lsp): implement workspace/didChangeWatchedFiles (#21293)

---
 runtime/lua/vim/_editor.lua         |   1 +
 runtime/lua/vim/_watch.lua          | 174 +++++++++++++++++++++++
 runtime/lua/vim/lsp/_watchfiles.lua | 274 ++++++++++++++++++++++++++++++++++++
 runtime/lua/vim/lsp/handlers.lua    |  38 +++--
 runtime/lua/vim/lsp/protocol.lua    |   9 ++
 5 files changed, 487 insertions(+), 9 deletions(-)
 create mode 100644 runtime/lua/vim/_watch.lua
 create mode 100644 runtime/lua/vim/lsp/_watchfiles.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 3f27e61810..92444ff550 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -37,6 +37,7 @@ for k, v in pairs({
   health = true,
   fs = true,
   secure = true,
+  _watch = true,
 }) do
   vim._submodules[k] = v
 end
diff --git a/runtime/lua/vim/_watch.lua b/runtime/lua/vim/_watch.lua
new file mode 100644
index 0000000000..dba1522ec8
--- /dev/null
+++ b/runtime/lua/vim/_watch.lua
@@ -0,0 +1,174 @@
+local M = {}
+
+--- Enumeration describing the types of events watchers will emit.
+M.FileChangeType = vim.tbl_add_reverse_lookup({
+  Created = 1,
+  Changed = 2,
+  Deleted = 3,
+})
+
+---@private
+--- Joins filepath elements by static '/' separator
+---
+---@param ... (string) The path elements.
+local function filepath_join(...)
+  return table.concat({ ... }, '/')
+end
+
+---@private
+--- Stops and closes a libuv |uv_fs_event_t| or |uv_fs_poll_t| handle
+---
+---@param handle (uv_fs_event_t|uv_fs_poll_t) The handle to stop
+local function stop(handle)
+  local _, stop_err = handle:stop()
+  assert(not stop_err, stop_err)
+  local is_closing, close_err = handle:is_closing()
+  assert(not close_err, close_err)
+  if not is_closing then
+    handle:close()
+  end
+end
+
+--- Initializes and starts a |uv_fs_event_t|
+---
+---@param path (string) The path to watch
+---@param opts (table|nil) Additional options
+---     - uvflags (table|nil)
+---                Same flags as accepted by |uv.fs_event_start()|
+---@param callback (function) The function called when new events
+---@returns (function) A function to stop the watch
+function M.watch(path, opts, callback)
+  vim.validate({
+    path = { path, 'string', false },
+    opts = { opts, 'table', true },
+    callback = { callback, 'function', false },
+  })
+
+  path = vim.fs.normalize(path)
+  local uvflags = opts and opts.uvflags or {}
+  local handle, new_err = vim.loop.new_fs_event()
+  assert(not new_err, new_err)
+  local _, start_err = handle:start(path, uvflags, function(err, filename, events)
+    assert(not err, err)
+    local fullpath = path
+    if filename then
+      filename = filename:gsub('\\', '/')
+      fullpath = filepath_join(fullpath, filename)
+    end
+    local change_type = events.change and M.FileChangeType.Changed or 0
+    if events.rename then
+      local _, staterr, staterrname = vim.loop.fs_stat(fullpath)
+      if staterrname == 'ENOENT' then
+        change_type = M.FileChangeType.Deleted
+      else
+        assert(not staterr, staterr)
+        change_type = M.FileChangeType.Created
+      end
+    end
+    callback(fullpath, change_type)
+  end)
+  assert(not start_err, start_err)
+  return function()
+    stop(handle)
+  end
+end
+
+local default_poll_interval_ms = 2000
+
+---@private
+--- Implementation for poll, hiding internally-used parameters.
+---
+---@param watches (table|nil) A tree structure to maintain state for recursive watches.
+---     - handle (uv_fs_poll_t)
+---               The libuv handle
+---     - cancel (function)
+---               A function that cancels the handle and all children's handles
+---     - is_dir (boolean)
+---               Indicates whether the path is a directory (and the poll should
+---               be invoked recursively)
+---     - children (table|nil)
+---               A mapping of directory entry name to its recursive watches
+local function poll_internal(path, opts, callback, watches)
+  path = vim.fs.normalize(path)
+  local interval = opts and opts.interval or default_poll_interval_ms
+  watches = watches or {
+    is_dir = true,
+  }
+
+  if not watches.handle then
+    local poll, new_err = vim.loop.new_fs_poll()
+    assert(not new_err, new_err)
+    watches.handle = poll
+    local _, start_err = poll:start(
+      path,
+      interval,
+      vim.schedule_wrap(function(err)
+        if err == 'ENOENT' then
+          return
+        end
+        assert(not err, err)
+        poll_internal(path, opts, callback, watches)
+        callback(path, M.FileChangeType.Changed)
+      end)
+    )
+    assert(not start_err, start_err)
+    callback(path, M.FileChangeType.Created)
+  end
+
+  watches.cancel = function()
+    if watches.children then
+      for _, w in pairs(watches.children) do
+        w.cancel()
+      end
+    end
+    stop(watches.handle)
+  end
+
+  if watches.is_dir then
+    watches.children = watches.children or {}
+    local exists = {}
+    for name, ftype in vim.fs.dir(path) do
+      exists[name] = true
+      if not watches.children[name] then
+        watches.children[name] = {
+          is_dir = ftype == 'directory',
+        }
+        poll_internal(filepath_join(path, name), opts, callback, watches.children[name])
+      end
+    end
+
+    local newchildren = {}
+    for name, watch in pairs(watches.children) do
+      if exists[name] then
+        newchildren[name] = watch
+      else
+        watch.cancel()
+        watches.children[name] = nil
+        callback(path .. '/' .. name, M.FileChangeType.Deleted)
+      end
+    end
+    watches.children = newchildren
+  end
+
+  return watches.cancel
+end
+
+--- Initializes and starts a |uv_fs_poll_t| recursively watching every file underneath the
+--- directory at path.
+---
+---@param path (string) The path to watch. Must refer to a directory.
+---@param opts (table|nil) Additional options
+---     - interval (number|nil)
+---                Polling interval in ms as passed to |uv.fs_poll_start()|. Defaults to 2000.
+---@param callback (function) The function called when new events
+---@returns (function) A function to stop the watch.
+function M.poll(path, opts, callback)
+  vim.validate({
+    path = { path, 'string', false },
+    opts = { opts, 'table', true },
+    callback = { callback, 'function', false },
+  })
+  return poll_internal(path, opts, callback, nil)
+end
+
+return M
diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
new file mode 100644
index 0000000000..b9268b963c
--- /dev/null
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -0,0 +1,274 @@
+local bit = require('bit')
+local watch = require('vim._watch')
+local protocol = require('vim.lsp.protocol')
+
+local M = {}
+
+---@private
+---Parses the raw pattern into a number of Lua-native patterns.
+---
+---@param pattern string The raw glob pattern
+---@return table A list of Lua patterns. A match with any of them matches the input glob pattern.
+local function parse(pattern)
+  local patterns = { '' }
+
+  local path_sep = '[/\\]'
+  local non_path_sep = '[^/\\]'
+
+  local function append(chunks)
+    local new_patterns = {}
+    for _, p in ipairs(patterns) do
+      for _, chunk in ipairs(chunks) do
+        table.insert(new_patterns, p .. chunk)
+      end
+    end
+    patterns = new_patterns
+  end
+
+  local function split(s, sep)
+    local segments = {}
+    local segment = ''
+    local in_braces = false
+    local in_brackets = false
+    for i = 1, #s do
+      local c = string.sub(s, i, i)
+      if c == sep and not in_braces and not in_brackets then
+        table.insert(segments, segment)
+        segment = ''
+      else
+        if c == '{' then
+          in_braces = true
+        elseif c == '}' then
+          in_braces = false
+        elseif c == '[' then
+          in_brackets = true
+        elseif c == ']' then
+          in_brackets = false
+        end
+        segment = segment .. c
+      end
+    end
+    if segment ~= '' then
+      table.insert(segments, segment)
+    end
+    return segments
+  end
+
+  local function escape(c)
+    if
+      c == '?'
+      or c == '.'
+      or c == '('
+      or c == ')'
+      or c == '%'
+      or c == '['
+      or c == ']'
+      or c == '*'
+      or c == '+'
+      or c == '-'
+    then
+      return '%' .. c
+    end
+    return c
+  end
+
+  local segments = split(pattern, '/')
+  for i, segment in ipairs(segments) do
+    local last_seg = i == #segments
+    if segment == '**' then
+      local chunks = {
+        path_sep .. '-',
+        '.-' .. path_sep,
+      }
+      if last_seg then
+        chunks = { '.-' }
+      end
+      append(chunks)
+    else
+      local in_braces = false
+      local brace_val = ''
+      local in_brackets = false
+      local bracket_val = ''
+      for j = 1, #segment do
+        local char = string.sub(segment, j, j)
+        if char ~= '}' and in_braces then
+          brace_val = brace_val .. char
+        else
+          if in_brackets and (char ~= ']' or bracket_val == '') then
+            local res
+            if char == '-' then
+              res = char
+            elseif bracket_val == '' and char == '!' then
+              res = '^'
+            elseif char == '/' then
+              res = ''
+            else
+              res = escape(char)
+            end
+            bracket_val = bracket_val .. res
+          else
+            if char == '{' then
+              in_braces = true
+            elseif char == '[' then
+              in_brackets = true
+            elseif char == '}' then
+              local choices = split(brace_val, ',')
+              local parsed_choices = {}
+              for _, choice in ipairs(choices) do
+                table.insert(parsed_choices, parse(choice))
+              end
+              append(vim.tbl_flatten(parsed_choices))
+              in_braces = false
+              brace_val = ''
+            elseif char == ']' then
+              append({ '[' .. bracket_val .. ']' })
+              in_brackets = false
+              bracket_val = ''
+            elseif char == '?' then
+              append({ non_path_sep })
+            elseif char == '*' then
+              append({ non_path_sep .. '-' })
+            else
+              append({ escape(char) })
+            end
+          end
+        end
+      end
+
+      if not last_seg and (segments[i + 1] ~= '**' or i + 1 < #segments) then
+        append({ path_sep })
+      end
+    end
+  end
+
+  return patterns
+end
+
+---@private
+--- Implementation of LSP 3.17.0's pattern matching: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#pattern
+--- Modeled after VSCode's implementation: https://github.com/microsoft/vscode/blob/0319eed971719ad48e9093daba9d65a5013ec5ab/src/vs/base/common/glob.ts#L509
+---
+---@param pattern string|table The glob pattern (raw or parsed) to match.
+---@param s string The string to match against pattern.
+---@return boolean Whether or not pattern matches s.
+function M._match(pattern, s)
+  if type(pattern) == 'string' then
+    pattern = parse(pattern)
+  end
+  -- Since Lua's built-in string pattern matching does not have an alternate
+  -- operator like '|', `parse` will construct one pattern for each possible
+  -- alternative. Any pattern that matches thus matches the glob.
+  for _, p in ipairs(pattern) do
+    if s:match('^' .. p .. '$') then
+      return true
+    end
+  end
+  return false
+end
+
+M._watchfunc = (vim.fn.has('win32') == 1 or vim.fn.has('mac') == 1) and watch.watch or watch.poll
+
+---@type table<number, table<number, function()>> client id -> registration id -> cancel function
+local cancels = vim.defaulttable()
+
+local queue_timeout_ms = 100
+---@type table<number, uv_timer_t> client id -> libuv timer which will send queued changes at its timeout
+local queue_timers = {}
+---@type table<number, lsp.FileEvent[]> client id -> set of queued changes to send in a single LSP notification
+local change_queues = {}
+---@type table<number, table<string, lsp.FileChangeType>> client id -> URI -> last type of change processed
+--- Used to prune consecutive events of the same type for the same file
+local change_cache = vim.defaulttable()
+
+local to_lsp_change_type = {
+  [watch.FileChangeType.Created] = protocol.FileChangeType.Created,
+  [watch.FileChangeType.Changed] = protocol.FileChangeType.Changed,
+  [watch.FileChangeType.Deleted] = protocol.FileChangeType.Deleted,
+}
+
+--- Registers the workspace/didChangeWatchedFiles capability dynamically.
+---
+---@param reg table LSP Registration object.
+---@param ctx table Context from the |lsp-handler|.
+function M.register(reg, ctx)
+  local client_id = ctx.client_id
+  local client = vim.lsp.get_client_by_id(client_id)
+  for _, w in ipairs(reg.registerOptions.watchers) do
+    local glob_patterns = {}
+    if type(w.globPattern) == 'string' then
+      for _, folder in ipairs(client.workspace_folders) do
+        table.insert(glob_patterns, { baseUri = folder.uri, pattern = w.globPattern })
+      end
+    else
+      table.insert(glob_patterns, w.globPattern)
+    end
+    for _, glob_pattern in ipairs(glob_patterns) do
+      local pattern = parse(glob_pattern.pattern)
+      local base_dir = nil
+      if type(glob_pattern.baseUri) == 'string' then
+        base_dir = glob_pattern.baseUri
+      elseif type(glob_pattern.baseUri) == 'table' then
+        base_dir = glob_pattern.baseUri.uri
+      end
+      assert(base_dir, "couldn't identify root of watch")
+      base_dir = vim.uri_to_fname(base_dir)
+      local kind = w.kind
+        or protocol.WatchKind.Create + protocol.WatchKind.Change + protocol.WatchKind.Delete
+
+      table.insert(
+        cancels[client_id][reg.id],
+        M._watchfunc(base_dir, { uvflags = { recursive = true } }, function(fullpath, change_type)
+          change_type = to_lsp_change_type[change_type]
+          -- e.g. match kind with Delete bit (0b0100) to Delete change_type (3)
+          local kind_mask = bit.lshift(1, change_type - 1)
+          local change_type_match = bit.band(kind, kind_mask) == kind_mask
+          if not M._match(pattern, fullpath) or not change_type_match then
+            return
+          end
+
+          local change = {
+            uri = vim.uri_from_fname(fullpath),
+            type = change_type,
+          }
+
+          local last_type = change_cache[client_id][change.uri]
+          if last_type ~= change.type then
+            change_queues[client_id] = change_queues[client_id] or {}
+            table.insert(change_queues[client_id], change)
+            change_cache[client_id][change.uri] = change.type
+          end
+
+          if not queue_timers[client_id] then
+            queue_timers[client_id] = vim.defer_fn(function()
+              client.notify('workspace/didChangeWatchedFiles', {
+                changes = change_queues[client_id],
+              })
+              queue_timers[client_id] = nil
+              change_queues[client_id] = nil
+              change_cache[client_id] = nil
+            end, queue_timeout_ms)
+          end
+        end)
+      )
+    end
+  end
+end
+
+--- Unregisters the workspace/didChangeWatchedFiles capability dynamically.
+---
+---@param unreg table LSP Unregistration object.
+---@param ctx table Context from the |lsp-handler|.
+function M.unregister(unreg, ctx)
+  local client_id = ctx.client_id
+  local client_cancels = cancels[client_id]
+  local reg_cancels = client_cancels[unreg.id]
+  while #reg_cancels > 0 do
+    table.remove(reg_cancels)()
+  end
+  client_cancels[unreg.id] = nil
+  if not next(cancels[client_id]) then
+    cancels[client_id] = nil
+  end
+end
+
+return M
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 5096100a60..ee5b63d260 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -117,15 +117,35 @@ M['window/showMessageRequest'] = function(_, result)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#client_registerCapability
-M['client/registerCapability'] = function(_, _, ctx)
-  local client_id = ctx.client_id
-  local warning_tpl = 'The language server %s triggers a registerCapability '
-    .. 'handler despite dynamicRegistration set to false. '
-    .. 'Report upstream, this warning is harmless'
-  local client = vim.lsp.get_client_by_id(client_id)
-  local client_name = client and client.name or string.format('id=%d', client_id)
-  local warning = string.format(warning_tpl, client_name)
-  log.warn(warning)
+M['client/registerCapability'] = function(_, result, ctx)
+  local log_unsupported = false
+  for _, reg in ipairs(result.registrations) do
+    if reg.method == 'workspace/didChangeWatchedFiles' then
+      require('vim.lsp._watchfiles').register(reg, ctx)
+    else
+      log_unsupported = true
+    end
+  end
+  if log_unsupported then
+    local client_id = ctx.client_id
+    local warning_tpl = 'The language server %s triggers a registerCapability '
+      .. 'handler despite dynamicRegistration set to false. '
+      .. 'Report upstream, this warning is harmless'
+    local client = vim.lsp.get_client_by_id(client_id)
+    local client_name = client and client.name or string.format('id=%d', client_id)
+    local warning = string.format(warning_tpl, client_name)
+    log.warn(warning)
+  end
+  return vim.NIL
+end
+
+--see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#client_unregisterCapability
+M['client/unregisterCapability'] = function(_, result, ctx)
+  for _, unreg in ipairs(result.unregisterations) do
+    if unreg.method == 'workspace/didChangeWatchedFiles' then
+      require('vim.lsp._watchfiles').unregister(unreg, ctx)
+    end
+  end
   return vim.NIL
 end
 
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 12345b6c8c..df1ab26667 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -28,6 +28,10 @@ end
 ---@class lsp.MessageActionItem
 ---@field title string
 
+---@class lsp.FileEvent
+---@field uri string
+---@field type lsp.FileChangeType
+
 local constants = {
   DiagnosticSeverity = {
     -- Reports an error.
@@ -60,6 +64,7 @@ local constants = {
   },
 
   -- The file event type.
+  ---@enum lsp.FileChangeType
   FileChangeType = {
     -- The file got created.
     Created = 1,
@@ -841,6 +846,10 @@ function protocol.make_client_capabilities()
       semanticTokens = {
         refreshSupport = true,
       },
+      didChangeWatchedFiles = {
+        dynamicRegistration = true,
+        relativePatternSupport = true,
+      },
     },
     experimental = nil,
     window = {
-- 
cgit 


From f0f27e9aef7c237dd55fbb5c2cd47c2f42d01742 Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Sat, 25 Feb 2023 11:17:28 +0100
Subject: Revert "feat(lsp): implement workspace/didChangeWatchedFiles
 (#21293)"

This reverts commit 5732aa706c639b3d775573d91d1139f24624629c.

Causes editor to freeze in projects with many watcher registrations
---
 runtime/lua/vim/_editor.lua         |   1 -
 runtime/lua/vim/_watch.lua          | 174 -----------------------
 runtime/lua/vim/lsp/_watchfiles.lua | 274 ------------------------------------
 runtime/lua/vim/lsp/handlers.lua    |  38 ++---
 runtime/lua/vim/lsp/protocol.lua    |   9 --
 5 files changed, 9 insertions(+), 487 deletions(-)
 delete mode 100644 runtime/lua/vim/_watch.lua
 delete mode 100644 runtime/lua/vim/lsp/_watchfiles.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 92444ff550..3f27e61810 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -37,7 +37,6 @@ for k, v in pairs({
   health = true,
   fs = true,
   secure = true,
-  _watch = true,
 }) do
   vim._submodules[k] = v
 end
diff --git a/runtime/lua/vim/_watch.lua b/runtime/lua/vim/_watch.lua
deleted file mode 100644
index dba1522ec8..0000000000
--- a/runtime/lua/vim/_watch.lua
+++ /dev/null
@@ -1,174 +0,0 @@
-local M = {}
-
---- Enumeration describing the types of events watchers will emit.
-M.FileChangeType = vim.tbl_add_reverse_lookup({
-  Created = 1,
-  Changed = 2,
-  Deleted = 3,
-})
-
----@private
---- Joins filepath elements by static '/' separator
----
----@param ... (string) The path elements.
-local function filepath_join(...)
-  return table.concat({ ... }, '/')
-end
-
----@private
---- Stops and closes a libuv |uv_fs_event_t| or |uv_fs_poll_t| handle
----
----@param handle (uv_fs_event_t|uv_fs_poll_t) The handle to stop
-local function stop(handle)
-  local _, stop_err = handle:stop()
-  assert(not stop_err, stop_err)
-  local is_closing, close_err = handle:is_closing()
-  assert(not close_err, close_err)
-  if not is_closing then
-    handle:close()
-  end
-end
-
---- Initializes and starts a |uv_fs_event_t|
----
----@param path (string) The path to watch
----@param opts (table|nil) Additional options
----     - uvflags (table|nil)
----                Same flags as accepted by |uv.fs_event_start()|
----@param callback (function) The function called when new events
----@returns (function) A function to stop the watch
-function M.watch(path, opts, callback)
-  vim.validate({
-    path = { path, 'string', false },
-    opts = { opts, 'table', true },
-    callback = { callback, 'function', false },
-  })
-
-  path = vim.fs.normalize(path)
-  local uvflags = opts and opts.uvflags or {}
-  local handle, new_err = vim.loop.new_fs_event()
-  assert(not new_err, new_err)
-  local _, start_err = handle:start(path, uvflags, function(err, filename, events)
-    assert(not err, err)
-    local fullpath = path
-    if filename then
-      filename = filename:gsub('\\', '/')
-      fullpath = filepath_join(fullpath, filename)
-    end
-    local change_type = events.change and M.FileChangeType.Changed or 0
-    if events.rename then
-      local _, staterr, staterrname = vim.loop.fs_stat(fullpath)
-      if staterrname == 'ENOENT' then
-        change_type = M.FileChangeType.Deleted
-      else
-        assert(not staterr, staterr)
-        change_type = M.FileChangeType.Created
-      end
-    end
-    callback(fullpath, change_type)
-  end)
-  assert(not start_err, start_err)
-  return function()
-    stop(handle)
-  end
-end
-
-local default_poll_interval_ms = 2000
-
----@private
---- Implementation for poll, hiding internally-used parameters.
----
----@param watches (table|nil) A tree structure to maintain state for recursive watches.
----     - handle (uv_fs_poll_t)
----               The libuv handle
----     - cancel (function)
----               A function that cancels the handle and all children's handles
----     - is_dir (boolean)
----               Indicates whether the path is a directory (and the poll should
----               be invoked recursively)
----     - children (table|nil)
----               A mapping of directory entry name to its recursive watches
-local function poll_internal(path, opts, callback, watches)
-  path = vim.fs.normalize(path)
-  local interval = opts and opts.interval or default_poll_interval_ms
-  watches = watches or {
-    is_dir = true,
-  }
-
-  if not watches.handle then
-    local poll, new_err = vim.loop.new_fs_poll()
-    assert(not new_err, new_err)
-    watches.handle = poll
-    local _, start_err = poll:start(
-      path,
-      interval,
-      vim.schedule_wrap(function(err)
-        if err == 'ENOENT' then
-          return
-        end
-        assert(not err, err)
-        poll_internal(path, opts, callback, watches)
-        callback(path, M.FileChangeType.Changed)
-      end)
-    )
-    assert(not start_err, start_err)
-    callback(path, M.FileChangeType.Created)
-  end
-
-  watches.cancel = function()
-    if watches.children then
-      for _, w in pairs(watches.children) do
-        w.cancel()
-      end
-    end
-    stop(watches.handle)
-  end
-
-  if watches.is_dir then
-    watches.children = watches.children or {}
-    local exists = {}
-    for name, ftype in vim.fs.dir(path) do
-      exists[name] = true
-      if not watches.children[name] then
-        watches.children[name] = {
-          is_dir = ftype == 'directory',
-        }
-        poll_internal(filepath_join(path, name), opts, callback, watches.children[name])
-      end
-    end
-
-    local newchildren = {}
-    for name, watch in pairs(watches.children) do
-      if exists[name] then
-        newchildren[name] = watch
-      else
-        watch.cancel()
-        watches.children[name] = nil
-        callback(path .. '/' .. name, M.FileChangeType.Deleted)
-      end
-    end
-    watches.children = newchildren
-  end
-
-  return watches.cancel
-end
-
---- Initializes and starts a |uv_fs_poll_t| recursively watching every file underneath the
---- directory at path.
----
----@param path (string) The path to watch. Must refer to a directory.
----@param opts (table|nil) Additional options
----     - interval (number|nil)
----                Polling interval in ms as passed to |uv.fs_poll_start()|. Defaults to 2000.
----@param callback (function) The function called when new events
----@returns (function) A function to stop the watch.
-function M.poll(path, opts, callback)
-  vim.validate({
-    path = { path, 'string', false },
-    opts = { opts, 'table', true },
-    callback = { callback, 'function', false },
-  })
-  return poll_internal(path, opts, callback, nil)
-end
-
-return M
diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
deleted file mode 100644
index b9268b963c..0000000000
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ /dev/null
@@ -1,274 +0,0 @@
-local bit = require('bit')
-local watch = require('vim._watch')
-local protocol = require('vim.lsp.protocol')
-
-local M = {}
-
----@private
----Parses the raw pattern into a number of Lua-native patterns.
----
----@param pattern string The raw glob pattern
----@return table A list of Lua patterns. A match with any of them matches the input glob pattern.
-local function parse(pattern)
-  local patterns = { '' }
-
-  local path_sep = '[/\\]'
-  local non_path_sep = '[^/\\]'
-
-  local function append(chunks)
-    local new_patterns = {}
-    for _, p in ipairs(patterns) do
-      for _, chunk in ipairs(chunks) do
-        table.insert(new_patterns, p .. chunk)
-      end
-    end
-    patterns = new_patterns
-  end
-
-  local function split(s, sep)
-    local segments = {}
-    local segment = ''
-    local in_braces = false
-    local in_brackets = false
-    for i = 1, #s do
-      local c = string.sub(s, i, i)
-      if c == sep and not in_braces and not in_brackets then
-        table.insert(segments, segment)
-        segment = ''
-      else
-        if c == '{' then
-          in_braces = true
-        elseif c == '}' then
-          in_braces = false
-        elseif c == '[' then
-          in_brackets = true
-        elseif c == ']' then
-          in_brackets = false
-        end
-        segment = segment .. c
-      end
-    end
-    if segment ~= '' then
-      table.insert(segments, segment)
-    end
-    return segments
-  end
-
-  local function escape(c)
-    if
-      c == '?'
-      or c == '.'
-      or c == '('
-      or c == ')'
-      or c == '%'
-      or c == '['
-      or c == ']'
-      or c == '*'
-      or c == '+'
-      or c == '-'
-    then
-      return '%' .. c
-    end
-    return c
-  end
-
-  local segments = split(pattern, '/')
-  for i, segment in ipairs(segments) do
-    local last_seg = i == #segments
-    if segment == '**' then
-      local chunks = {
-        path_sep .. '-',
-        '.-' .. path_sep,
-      }
-      if last_seg then
-        chunks = { '.-' }
-      end
-      append(chunks)
-    else
-      local in_braces = false
-      local brace_val = ''
-      local in_brackets = false
-      local bracket_val = ''
-      for j = 1, #segment do
-        local char = string.sub(segment, j, j)
-        if char ~= '}' and in_braces then
-          brace_val = brace_val .. char
-        else
-          if in_brackets and (char ~= ']' or bracket_val == '') then
-            local res
-            if char == '-' then
-              res = char
-            elseif bracket_val == '' and char == '!' then
-              res = '^'
-            elseif char == '/' then
-              res = ''
-            else
-              res = escape(char)
-            end
-            bracket_val = bracket_val .. res
-          else
-            if char == '{' then
-              in_braces = true
-            elseif char == '[' then
-              in_brackets = true
-            elseif char == '}' then
-              local choices = split(brace_val, ',')
-              local parsed_choices = {}
-              for _, choice in ipairs(choices) do
-                table.insert(parsed_choices, parse(choice))
-              end
-              append(vim.tbl_flatten(parsed_choices))
-              in_braces = false
-              brace_val = ''
-            elseif char == ']' then
-              append({ '[' .. bracket_val .. ']' })
-              in_brackets = false
-              bracket_val = ''
-            elseif char == '?' then
-              append({ non_path_sep })
-            elseif char == '*' then
-              append({ non_path_sep .. '-' })
-            else
-              append({ escape(char) })
-            end
-          end
-        end
-      end
-
-      if not last_seg and (segments[i + 1] ~= '**' or i + 1 < #segments) then
-        append({ path_sep })
-      end
-    end
-  end
-
-  return patterns
-end
-
----@private
---- Implementation of LSP 3.17.0's pattern matching: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#pattern
---- Modeled after VSCode's implementation: https://github.com/microsoft/vscode/blob/0319eed971719ad48e9093daba9d65a5013ec5ab/src/vs/base/common/glob.ts#L509
----
----@param pattern string|table The glob pattern (raw or parsed) to match.
----@param s string The string to match against pattern.
----@return boolean Whether or not pattern matches s.
-function M._match(pattern, s)
-  if type(pattern) == 'string' then
-    pattern = parse(pattern)
-  end
-  -- Since Lua's built-in string pattern matching does not have an alternate
-  -- operator like '|', `parse` will construct one pattern for each possible
-  -- alternative. Any pattern that matches thus matches the glob.
-  for _, p in ipairs(pattern) do
-    if s:match('^' .. p .. '$') then
-      return true
-    end
-  end
-  return false
-end
-
-M._watchfunc = (vim.fn.has('win32') == 1 or vim.fn.has('mac') == 1) and watch.watch or watch.poll
-
----@type table<number, table<number, function()>> client id -> registration id -> cancel function
-local cancels = vim.defaulttable()
-
-local queue_timeout_ms = 100
----@type table<number, uv_timer_t> client id -> libuv timer which will send queued changes at its timeout
-local queue_timers = {}
----@type table<number, lsp.FileEvent[]> client id -> set of queued changes to send in a single LSP notification
-local change_queues = {}
----@type table<number, table<string, lsp.FileChangeType>> client id -> URI -> last type of change processed
---- Used to prune consecutive events of the same type for the same file
-local change_cache = vim.defaulttable()
-
-local to_lsp_change_type = {
-  [watch.FileChangeType.Created] = protocol.FileChangeType.Created,
-  [watch.FileChangeType.Changed] = protocol.FileChangeType.Changed,
-  [watch.FileChangeType.Deleted] = protocol.FileChangeType.Deleted,
-}
-
---- Registers the workspace/didChangeWatchedFiles capability dynamically.
----
----@param reg table LSP Registration object.
----@param ctx table Context from the |lsp-handler|.
-function M.register(reg, ctx)
-  local client_id = ctx.client_id
-  local client = vim.lsp.get_client_by_id(client_id)
-  for _, w in ipairs(reg.registerOptions.watchers) do
-    local glob_patterns = {}
-    if type(w.globPattern) == 'string' then
-      for _, folder in ipairs(client.workspace_folders) do
-        table.insert(glob_patterns, { baseUri = folder.uri, pattern = w.globPattern })
-      end
-    else
-      table.insert(glob_patterns, w.globPattern)
-    end
-    for _, glob_pattern in ipairs(glob_patterns) do
-      local pattern = parse(glob_pattern.pattern)
-      local base_dir = nil
-      if type(glob_pattern.baseUri) == 'string' then
-        base_dir = glob_pattern.baseUri
-      elseif type(glob_pattern.baseUri) == 'table' then
-        base_dir = glob_pattern.baseUri.uri
-      end
-      assert(base_dir, "couldn't identify root of watch")
-      base_dir = vim.uri_to_fname(base_dir)
-      local kind = w.kind
-        or protocol.WatchKind.Create + protocol.WatchKind.Change + protocol.WatchKind.Delete
-
-      table.insert(
-        cancels[client_id][reg.id],
-        M._watchfunc(base_dir, { uvflags = { recursive = true } }, function(fullpath, change_type)
-          change_type = to_lsp_change_type[change_type]
-          -- e.g. match kind with Delete bit (0b0100) to Delete change_type (3)
-          local kind_mask = bit.lshift(1, change_type - 1)
-          local change_type_match = bit.band(kind, kind_mask) == kind_mask
-          if not M._match(pattern, fullpath) or not change_type_match then
-            return
-          end
-
-          local change = {
-            uri = vim.uri_from_fname(fullpath),
-            type = change_type,
-          }
-
-          local last_type = change_cache[client_id][change.uri]
-          if last_type ~= change.type then
-            change_queues[client_id] = change_queues[client_id] or {}
-            table.insert(change_queues[client_id], change)
-            change_cache[client_id][change.uri] = change.type
-          end
-
-          if not queue_timers[client_id] then
-            queue_timers[client_id] = vim.defer_fn(function()
-              client.notify('workspace/didChangeWatchedFiles', {
-                changes = change_queues[client_id],
-              })
-              queue_timers[client_id] = nil
-              change_queues[client_id] = nil
-              change_cache[client_id] = nil
-            end, queue_timeout_ms)
-          end
-        end)
-      )
-    end
-  end
-end
-
---- Unregisters the workspace/didChangeWatchedFiles capability dynamically.
----
----@param unreg table LSP Unregistration object.
----@param ctx table Context from the |lsp-handler|.
-function M.unregister(unreg, ctx)
-  local client_id = ctx.client_id
-  local client_cancels = cancels[client_id]
-  local reg_cancels = client_cancels[unreg.id]
-  while #reg_cancels > 0 do
-    table.remove(reg_cancels)()
-  end
-  client_cancels[unreg.id] = nil
-  if not next(cancels[client_id]) then
-    cancels[client_id] = nil
-  end
-end
-
-return M
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index ee5b63d260..5096100a60 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -117,35 +117,15 @@ M['window/showMessageRequest'] = function(_, result)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#client_registerCapability
-M['client/registerCapability'] = function(_, result, ctx)
-  local log_unsupported = false
-  for _, reg in ipairs(result.registrations) do
-    if reg.method == 'workspace/didChangeWatchedFiles' then
-      require('vim.lsp._watchfiles').register(reg, ctx)
-    else
-      log_unsupported = true
-    end
-  end
-  if log_unsupported then
-    local client_id = ctx.client_id
-    local warning_tpl = 'The language server %s triggers a registerCapability '
-      .. 'handler despite dynamicRegistration set to false. '
-      .. 'Report upstream, this warning is harmless'
-    local client = vim.lsp.get_client_by_id(client_id)
-    local client_name = client and client.name or string.format('id=%d', client_id)
-    local warning = string.format(warning_tpl, client_name)
-    log.warn(warning)
-  end
-  return vim.NIL
-end
-
---see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#client_unregisterCapability
-M['client/unregisterCapability'] = function(_, result, ctx)
-  for _, unreg in ipairs(result.unregisterations) do
-    if unreg.method == 'workspace/didChangeWatchedFiles' then
-      require('vim.lsp._watchfiles').unregister(unreg, ctx)
-    end
-  end
+M['client/registerCapability'] = function(_, _, ctx)
+  local client_id = ctx.client_id
+  local warning_tpl = 'The language server %s triggers a registerCapability '
+    .. 'handler despite dynamicRegistration set to false. '
+    .. 'Report upstream, this warning is harmless'
+  local client = vim.lsp.get_client_by_id(client_id)
+  local client_name = client and client.name or string.format('id=%d', client_id)
+  local warning = string.format(warning_tpl, client_name)
+  log.warn(warning)
   return vim.NIL
 end
 
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index df1ab26667..12345b6c8c 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -28,10 +28,6 @@ end
 ---@class lsp.MessageActionItem
 ---@field title string
 
----@class lsp.FileEvent
----@field uri string
----@field type lsp.FileChangeType
-
 local constants = {
   DiagnosticSeverity = {
     -- Reports an error.
@@ -64,7 +60,6 @@ local constants = {
   },
 
   -- The file event type.
-  ---@enum lsp.FileChangeType
   FileChangeType = {
     -- The file got created.
     Created = 1,
@@ -846,10 +841,6 @@ function protocol.make_client_capabilities()
       semanticTokens = {
         refreshSupport = true,
       },
-      didChangeWatchedFiles = {
-        dynamicRegistration = true,
-        relativePatternSupport = true,
-      },
     },
     experimental = nil,
     window = {
-- 
cgit 


From c1514d7e6762ed62dee027ecc29bafd4aae2206e Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sat, 25 Feb 2023 18:47:05 +0100
Subject: fix(lsp): fix some type annotations (#22397)

---
 runtime/lua/vim/lsp.lua          | 97 +++++++++++++++++++---------------------
 runtime/lua/vim/lsp/protocol.lua |  9 +---
 runtime/lua/vim/lsp/rpc.lua      |  8 ++--
 runtime/lua/vim/lsp/types.lua    | 20 +++++++++
 4 files changed, 72 insertions(+), 62 deletions(-)
 create mode 100644 runtime/lua/vim/lsp/types.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 206c7c9b7e..d215b4c47e 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -67,7 +67,7 @@ lsp._request_name_to_capability = {
 ---@private
 --- Concatenates and writes a list of strings to the Vim error buffer.
 ---
----@param {...} table[] List to write to the buffer
+---@param ... string List to write to the buffer
 local function err_message(...)
   nvim_err_writeln(table.concat(vim.tbl_flatten({ ... })))
   nvim_command('redraw')
@@ -76,9 +76,8 @@ end
 ---@private
 --- Returns the buffer number for the given {bufnr}.
 ---
----@param bufnr (number|nil) Buffer number to resolve. Defaults to the current
----buffer if not given.
----@returns bufnr (number) Number of requested buffer
+---@param bufnr (integer|nil) Buffer number to resolve. Defaults to current buffer
+---@return integer bufnr
 local function resolve_bufnr(bufnr)
   validate({ bufnr = { bufnr, 'n', true } })
   if bufnr == nil or bufnr == 0 then
@@ -104,7 +103,7 @@ end
 --- Checks whether a given path is a directory.
 ---
 ---@param filename (string) path to check
----@returns true if {filename} exists and is a directory, false otherwise
+---@return boolean # true if {filename} exists and is a directory, false otherwise
 local function is_dir(filename)
   validate({ filename = { filename, 's' } })
   local stat = uv.fs_stat(filename)
@@ -133,7 +132,7 @@ local format_line_ending = {
 
 ---@private
 ---@param bufnr (number)
----@returns (string)
+---@return string
 local function buf_get_line_ending(bufnr)
   return format_line_ending[nvim_buf_get_option(bufnr, 'fileformat')] or '\n'
 end
@@ -142,7 +141,7 @@ local client_index = 0
 ---@private
 --- Returns a new, unused client id.
 ---
----@returns (number) client id
+---@return integer client_id
 local function next_client_id()
   client_index = client_index + 1
   return client_index
@@ -197,7 +196,7 @@ lsp.client_errors = tbl_extend(
 --- Normalizes {encoding} to valid LSP encoding names.
 ---
 ---@param encoding (string) Encoding to normalize
----@returns (string) normalized encoding name
+---@return string # normalized encoding name
 local function validate_encoding(encoding)
   validate({
     encoding = { encoding, 's' },
@@ -215,9 +214,8 @@ end
 --- Parses a command invocation into the command itself and its args. If there
 --- are no arguments, an empty table is returned as the second argument.
 ---
----@param input (List)
----@returns (string) the command
----@returns (list of strings) its arguments
+---@param input string[]
+---@return string command, string[] args #the command and arguments
 function lsp._cmd_parts(input)
   validate({
     cmd = {
@@ -244,9 +242,9 @@ end
 ---@private
 --- Augments a validator function with support for optional (nil) values.
 ---
----@param fn (fun(v)) The original validator function; should return a
+---@param fn (fun(v): boolean) The original validator function; should return a
 ---bool.
----@returns (fun(v)) The augmented function. Also returns true if {v} is
+---@return fun(v): boolean # The augmented function. Also returns true if {v} is
 ---`nil`.
 local function optional_validator(fn)
   return function(v)
@@ -258,10 +256,8 @@ end
 --- Validates a client configuration as given to |vim.lsp.start_client()|.
 ---
 ---@param config (table)
----@returns (table) "Cleaned" config, containing only the command, its
+---@return table config Cleaned config, containing the command, its
 ---arguments, and a valid encoding.
----
----@see |vim.lsp.start_client()|
 local function validate_client_config(config)
   validate({
     config = { config, 't' },
@@ -314,7 +310,7 @@ end
 --- Returns full text of buffer {bufnr} as a string.
 ---
 ---@param bufnr (number) Buffer handle, or 0 for current.
----@returns Buffer text as string.
+---@return string # Buffer text as string.
 local function buf_get_full_text(bufnr)
   local line_ending = buf_get_line_ending(bufnr)
   local text = table.concat(nvim_buf_get_lines(bufnr, 0, -1, true), line_ending)
@@ -331,7 +327,7 @@ end
 --- even if it has side effects.
 ---
 ---@param fn (function) Function to run
----@returns (function) Memoized function
+---@return function fn Memoized function
 local function once(fn)
   local value
   local ran = false
@@ -373,7 +369,7 @@ do
   --- @field lines string[] snapshot of buffer lines from last didChange
   --- @field lines_tmp string[]
   --- @field pending_changes table[] List of debounced changes in incremental sync mode
-  --- @field timer nil|userdata uv_timer
+  --- @field timer nil|uv.uv_timer_t uv_timer
   --- @field last_flush nil|number uv.hrtime of the last flush/didChange-notification
   --- @field needs_flush boolean true if buffer updates haven't been sent to clients/servers yet
   --- @field refs number how many clients are using this group
@@ -648,7 +644,7 @@ do
       if debounce == 0 then
         send_changes(bufnr, group.sync_kind, state, buf_state)
       else
-        local timer = uv.new_timer()
+        local timer = assert(uv.new_timer(), 'Must be able to create timer')
         buf_state.timer = timer
         timer:start(
           debounce,
@@ -1006,7 +1002,7 @@ end
 ---       server will base its workspaceFolders, rootUri, and rootPath
 ---       on initialization.
 ---
----@returns Client id. |vim.lsp.get_client_by_id()| Note: client may not be
+---@return integer|nil client_id. |vim.lsp.get_client_by_id()| Note: client may not be
 --- fully initialized. Use `on_init` to do any actions once
 --- the client has been initialized.
 function lsp.start_client(config)
@@ -1037,7 +1033,7 @@ function lsp.start_client(config)
   --- Returns the default handler if the user hasn't set a custom one.
   ---
   ---@param method (string) LSP method name
-  ---@returns (fn) The handler for the given method, if defined, or the default from |vim.lsp.handlers|
+  ---@return function|nil The handler for the given method, if defined, or the default from |vim.lsp.handlers|
   local function resolve_handler(method)
     return handlers[method] or default_handlers[method]
   end
@@ -1343,11 +1339,11 @@ function lsp.start_client(config)
   --- This is a thin wrapper around {client.rpc.request} with some additional
   --- checks for capabilities and handler availability.
   ---
-  ---@param method (string) LSP method name.
-  ---@param params (table) LSP request params.
-  ---@param handler (function|nil) Response |lsp-handler| for this method.
-  ---@param bufnr (number) Buffer handle (0 for current).
-  ---@returns ({status}, [request_id]): {status} is a bool indicating
+  ---@param method string LSP method name.
+  ---@param params table LSP request params.
+  ---@param handler lsp-handler|nil Response |lsp-handler| for this method.
+  ---@param bufnr integer Buffer handle (0 for current).
+  ---@return boolean status, integer|nil request_id {status} is a bool indicating
   ---whether the request was successful. If it is `false`, then it will
   ---always be `false` (the client has shutdown). If it was
   ---successful, then it will return {request_id} as the
@@ -1395,10 +1391,11 @@ function lsp.start_client(config)
   ---@param timeout_ms (number|nil) Maximum time in milliseconds to wait for
   ---                               a result. Defaults to 1000
   ---@param bufnr (number) Buffer handle (0 for current).
-  ---@returns { err=err, result=result }, a dictionary, where `err` and `result` come from the |lsp-handler|.
-  ---On timeout, cancel or error, returns `(nil, err)` where `err` is a
-  ---string describing the failure reason. If the request was unsuccessful
-  ---returns `nil`.
+  ---@return {err: lsp.ResponseError|nil, result:any}|nil, string|nil err # a dictionary, where
+  --- `err` and `result` come from the |lsp-handler|.
+  --- On timeout, cancel or error, returns `(nil, err)` where `err` is a
+  --- string describing the failure reason. If the request was unsuccessful
+  --- returns `nil`.
   ---@see |vim.lsp.buf_request_sync()|
   function client.request_sync(method, params, timeout_ms, bufnr)
     local request_result = nil
@@ -1429,7 +1426,7 @@ function lsp.start_client(config)
   ---
   ---@param method string LSP method name.
   ---@param params table|nil LSP request params.
-  ---@returns {status} (bool) true if the notification was successful.
+  ---@return boolean status true if the notification was successful.
   ---If it is false, then it will always be false
   ---(the client has shutdown).
   function client.notify(method, params)
@@ -1443,7 +1440,7 @@ function lsp.start_client(config)
   --- Cancels a request with a given request id.
   ---
   ---@param id (number) id of request to cancel
-  ---@returns true if any client returns true; false otherwise
+  ---@return boolean status true if notification was successful. false otherwise
   ---@see |vim.lsp.client.notify()|
   function client.cancel_request(id)
     validate({ id = { id, 'n' } })
@@ -1489,7 +1486,7 @@ function lsp.start_client(config)
   ---@private
   --- Checks whether a client is stopped.
   ---
-  ---@returns (bool) true if client is stopped or in the process of being
+  ---@return boolean # true if client is stopped or in the process of being
   ---stopped; false otherwise
   function client.is_stopped()
     return rpc.is_closing()
@@ -1497,7 +1494,7 @@ function lsp.start_client(config)
 
   ---@private
   --- Runs the on_attach function from the client's config if it was defined.
-  ---@param bufnr (number) Buffer number
+  ---@param bufnr integer Buffer number
   function client._on_attach(bufnr)
     text_document_did_open_handler(bufnr, client)
 
@@ -1771,8 +1768,8 @@ end
 
 --- Returns list of buffers attached to client_id.
 ---
----@param client_id number client id
----@returns list of buffer ids
+---@param client_id integer client id
+---@return integer[] buffers list of buffer ids
 function lsp.get_buffers_by_client_id(client_id)
   local client = lsp.get_client_by_id(client_id)
   return client and vim.tbl_keys(client.attached_buffers) or {}
@@ -1906,7 +1903,7 @@ api.nvim_create_autocmd('VimLeavePre', {
 ---@param handler function|nil See |lsp-handler|
 ---       If nil, follows resolution strategy defined in |lsp-handler-configuration|
 ---
----@returns 2-tuple:
+---@return table<integer, integer>, fun() 2-tuple:
 ---  - Map of client-id:request-id pairs for all successful requests.
 ---  - Function which can be used to cancel all the requests. You could instead
 ---    iterate all clients and call their `cancel_request()` methods.
@@ -1964,10 +1961,10 @@ end
 ---@param method (string) LSP method name
 ---@param params (table|nil) Parameters to send to the server
 ---@param callback (function) The callback to call when all requests are finished.
---  Unlike `buf_request`, this will collect all the responses from each server instead of handling them.
---  A map of client_id:request_result will be provided to the callback
---
----@returns (function) A function that will cancel all requests which is the same as the one returned from `buf_request`.
+--- Unlike `buf_request`, this will collect all the responses from each server instead of handling them.
+--- A map of client_id:request_result will be provided to the callback
+---
+---@return fun() cancel A function that will cancel all requests
 function lsp.buf_request_all(bufnr, method, params, callback)
   local request_results = {}
   local result_count = 0
@@ -2008,9 +2005,9 @@ end
 ---@param timeout_ms (number|nil) Maximum time in milliseconds to wait for a
 ---                               result. Defaults to 1000
 ---
----@returns Map of client_id:request_result. On timeout, cancel or error,
----        returns `(nil, err)` where `err` is a string describing the failure
----        reason.
+---@return table<integer, any>|nil result, string|nil err Map of client_id:request_result.
+--- On timeout, cancel or error, returns `(nil, err)` where `err` is a string describing
+--- the failure reason.
 function lsp.buf_request_sync(bufnr, method, params, timeout_ms)
   local request_results
 
@@ -2035,7 +2032,7 @@ end
 ---@param method (string) Name of the request method
 ---@param params (any) Arguments to send to the server
 ---
----@returns true if any client returns true; false otherwise
+---@return boolean success true if any client returns true; false otherwise
 function lsp.buf_notify(bufnr, method, params)
   validate({
     bufnr = { bufnr, 'n', true },
@@ -2172,7 +2169,7 @@ function lsp.formatexpr(opts)
   for _, client in pairs(lsp.get_active_clients({ bufnr = bufnr })) do
     if client.supports_method('textDocument/rangeFormatting') then
       local params = util.make_formatting_params()
-      local end_line = vim.fn.getline(end_lnum)
+      local end_line = vim.fn.getline(end_lnum) --[[@as string]]
       local end_col = util._str_utfindex_enc(end_line, nil, client.offset_encoding)
       params.range = {
         start = {
@@ -2207,7 +2204,7 @@ end
 ---@param pattern string Pattern used to find a workspace symbol
 ---@param flags string See |tag-function|
 ---
----@returns A list of matching tags
+---@return table[] tags A list of matching tags
 function lsp.tagfunc(...)
   return require('vim.lsp.tagfunc')(...)
 end
@@ -2215,7 +2212,7 @@ end
 ---Checks whether a client is stopped.
 ---
 ---@param client_id (number)
----@returns true if client is stopped, false otherwise.
+---@return boolean stopped true if client is stopped, false otherwise.
 function lsp.client_is_stopped(client_id)
   return active_clients[client_id] == nil
 end
@@ -2262,7 +2259,7 @@ function lsp.set_log_level(level)
 end
 
 --- Gets the path of the logfile used by the LSP client.
----@returns (String) Path to logfile.
+---@return string path to log file
 function lsp.get_log_path()
   return log.get_filename()
 end
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 12345b6c8c..41dfc9e00e 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -20,14 +20,6 @@ function transform_schema_to_table()
 end
 --]=]
 
----@class lsp.ShowMessageRequestParams
----@field type lsp.MessageType
----@field message string
----@field actions nil|lsp.MessageActionItem[]
-
----@class lsp.MessageActionItem
----@field title string
-
 local constants = {
   DiagnosticSeverity = {
     -- Reports an error.
@@ -60,6 +52,7 @@ local constants = {
   },
 
   -- The file event type.
+  ---@enum lsp.FileChangeType
   FileChangeType = {
     -- The file got created.
     Created = 1,
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index f1492601ff..aa833deb99 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -319,9 +319,9 @@ end
 ---
 ---@param method (string) The invoked LSP method
 ---@param params (table|nil) Parameters for the invoked LSP method
----@param callback (function) Callback to invoke
+---@param callback fun(err: lsp.ResponseError|nil, result: any) Callback to invoke
 ---@param notify_reply_callback (function|nil) Callback to invoke as soon as a request is no longer pending
----@returns (bool, number) `(true, message_id)` if request could be sent, `false` if not
+---@return boolean success, integer|nil request_id true, request_id if request could be sent, `false` if not
 function Client:request(method, params, callback, notify_reply_callback)
   validate({
     callback = { callback, 'f' },
@@ -538,9 +538,9 @@ local function public_client(client)
   ---
   ---@param method (string) The invoked LSP method
   ---@param params (table|nil) Parameters for the invoked LSP method
-  ---@param callback (function) Callback to invoke
+  ---@param callback fun(err: lsp.ResponseError | nil, result: any) Callback to invoke
   ---@param notify_reply_callback (function|nil) Callback to invoke as soon as a request is no longer pending
-  ---@returns (bool, number) `(true, message_id)` if request could be sent, `false` if not
+  ---@return boolean success, integer|nil request_id true, message_id if request could be sent, `false` if not
   function result.request(method, params, callback, notify_reply_callback)
     return client:request(method, params, callback, notify_reply_callback)
   end
diff --git a/runtime/lua/vim/lsp/types.lua b/runtime/lua/vim/lsp/types.lua
new file mode 100644
index 0000000000..1aea6841ee
--- /dev/null
+++ b/runtime/lua/vim/lsp/types.lua
@@ -0,0 +1,20 @@
+---@meta
+
+---@alias lsp-handler fun(err: lsp.ResponseError|nil, result: any, context: table, config: table|nil)
+
+---@class lsp.ResponseError
+---@field code integer
+---@field message string
+---@field data string|number|boolean|table[]|table|nil
+
+---@class lsp.ShowMessageRequestParams
+---@field type lsp.MessageType
+---@field message string
+---@field actions nil|lsp.MessageActionItem[]
+
+---@class lsp.MessageActionItem
+---@field title string
+
+---@class lsp.FileEvent
+---@field uri string
+---@field type lsp.FileChangeType
-- 
cgit 


From 774e59f3f9bf50c8350857c6722bb58df2dd940a Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 26 Feb 2023 16:53:33 +0000
Subject: feat(treesitter): expand the API

---
 runtime/lua/vim/treesitter/_meta.lua | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index 87b4560798..731a5ebf9f 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -2,6 +2,7 @@
 
 ---@class TSNode
 ---@field id fun(self: TSNode): integer
+---@field tree fun(self: TSNode): TSTree
 ---@field range fun(self: TSNode): integer, integer, integer, integer
 ---@field start fun(self: TSNode): integer, integer, integer
 ---@field end_ fun(self: TSNode): integer, integer, integer
@@ -9,6 +10,7 @@
 ---@field symbol fun(self: TSNode): integer
 ---@field named fun(self: TSNode): boolean
 ---@field missing fun(self: TSNode): boolean
+---@field extra fun(self: TSNode): boolean
 ---@field child_count fun(self: TSNode): integer
 ---@field named_child_count fun(self: TSNode): integer
 ---@field child fun(self: TSNode, integer): TSNode
@@ -21,7 +23,8 @@
 ---@field next_named_sibling fun(self: TSNode): TSNode
 ---@field prev_named_sibling fun(self: TSNode): TSNode
 ---@field named_children fun(self: TSNode): TSNode[]
----@field has_error fun(self: TSNode): boolean
+---@field has_changes fun(self: TSNode): boolean
+---@field equal fun(self: TSNode, other: TSNode): boolean
 ---@field iter_children fun(self: TSNode): fun(): TSNode, string
 local TSNode = {}
 
@@ -41,8 +44,11 @@ function TSNode:_rawquery(query, captures, start, end_) end
 
 ---@class TSParser
 ---@field parse fun(self: TSParser, tree, source: integer|string): TSTree, integer[]
+---@field reset fun(self: TSParser)
 ---@field included_ranges fun(self: TSParser): integer[]
 ---@field set_included_ranges fun(self: TSParser, ranges: integer[][])
+---@field set_timeout fun(self: TSParser, timeout: integer)
+---@field timeout fun(self: TSParser): integer
 
 ---@class TSTree
 ---@field root fun(self: TSTree): TSNode
-- 
cgit 


From da56f06037c26180021c1e3b73a77fc990f0c1e3 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 27 Feb 2023 10:49:19 +0000
Subject: fix(treesitter): remove virtual text from playground

Implement the range and lang annotations as comments instead
---
 runtime/lua/vim/treesitter/playground.lua | 46 +++++++++++++++++++++----------
 1 file changed, 32 insertions(+), 14 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/playground.lua b/runtime/lua/vim/treesitter/playground.lua
index 001bc2d5bf..fd5b687195 100644
--- a/runtime/lua/vim/treesitter/playground.lua
+++ b/runtime/lua/vim/treesitter/playground.lua
@@ -138,6 +138,19 @@ end
 
 local decor_ns = api.nvim_create_namespace('ts.playground')
 
+---@private
+---@param lnum integer
+---@param col integer
+---@param end_lnum integer
+---@param end_col integer
+---@return string
+local function get_range_str(lnum, col, end_col, end_lnum)
+  if lnum == end_lnum then
+    return string.format('[%d:%d-%d]', lnum + 1, col + 1, end_col)
+  end
+  return string.format('[%d:%d-%d:%d]', lnum + 1, col + 1, end_lnum + 1, end_col)
+end
+
 --- Write the contents of this Playground into {bufnr}.
 ---
 ---@param bufnr number Buffer number to write into.
@@ -145,26 +158,31 @@ local decor_ns = api.nvim_create_namespace('ts.playground')
 function TSPlayground:draw(bufnr)
   vim.bo[bufnr].modifiable = true
   local lines = {} ---@type string[]
+  local lang_hl_marks = {} ---@type table[]
+
   for _, item in self:iter() do
-    lines[#lines + 1] = string.rep(' ', item.depth) .. item.text
+    local range_str = get_range_str(item.lnum, item.col, item.end_lnum, item.end_col)
+    local lang_str = self.opts.lang and string.format(' %s', item.lang) or ''
+    local line = string.rep(' ', item.depth) .. item.text .. '; ' .. range_str .. lang_str
+
+    if self.opts.lang then
+      lang_hl_marks[#lang_hl_marks + 1] = {
+        col = #line - #lang_str,
+        end_col = #line,
+      }
+    end
+
+    lines[#lines + 1] = line
   end
+
   api.nvim_buf_set_lines(bufnr, 0, -1, false, lines)
 
   api.nvim_buf_clear_namespace(bufnr, decor_ns, 0, -1)
 
-  for i, item in self:iter() do
-    local range_str
-    if item.lnum == item.end_lnum then
-      range_str = string.format('[%d:%d-%d]', item.lnum + 1, item.col + 1, item.end_col)
-    else
-      range_str =
-        string.format('[%d:%d-%d:%d]', item.lnum + 1, item.col + 1, item.end_lnum + 1, item.end_col)
-    end
-
-    local lang_str = self.opts.lang and string.format(' %s', item.lang) or ''
-
-    api.nvim_buf_set_extmark(bufnr, decor_ns, i - 1, 0, {
-      virt_text = { { range_str, 'Comment' }, { lang_str, 'Title' } },
+  for i, m in ipairs(lang_hl_marks) do
+    api.nvim_buf_set_extmark(bufnr, decor_ns, i - 1, m.col, {
+      hl_group = 'Title',
+      end_col = m.end_col,
     })
   end
 
-- 
cgit 


From 5aa37e20e0e6cbabf82c5cf1d35c6f5e6e48f099 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 27 Feb 2023 15:01:09 +0000
Subject: fix(treesitter): ipairs -> pairs

Fixes: https://github.com/nvim-treesitter/nvim-treesitter/issues/4349
---
 runtime/lua/vim/treesitter/languagetree.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 7ec7bbfa12..43fb866896 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -467,7 +467,7 @@ function LanguageTree:_get_injections()
 
   -- Generate a map by lang of node lists.
   -- Each list is a set of ranges that should be parsed together.
-  for _, lang_map in ipairs(injections) do
+  for _, lang_map in pairs(injections) do
     for lang, patterns in pairs(lang_map) do
       if not result[lang] then
         result[lang] = {}
-- 
cgit 


From f64098a2df774c79dd454f63ac491570cdcaf2b2 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 27 Feb 2023 15:33:18 +0000
Subject: fix(treesitter): fixup for health

---
 runtime/lua/vim/treesitter/health.lua   | 22 ++++++++++------------
 runtime/lua/vim/treesitter/language.lua |  2 +-
 2 files changed, 11 insertions(+), 13 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/health.lua b/runtime/lua/vim/treesitter/health.lua
index 1abcdd0b31..fd1188fde4 100644
--- a/runtime/lua/vim/treesitter/health.lua
+++ b/runtime/lua/vim/treesitter/health.lua
@@ -2,28 +2,26 @@ local M = {}
 local ts = vim.treesitter
 local health = require('vim.health')
 
---- Lists the parsers currently installed
----
----@return string[] list of parser files
-function M.list_parsers()
-  return vim.api.nvim_get_runtime_file('parser/*', true)
-end
-
 --- Performs a healthcheck for treesitter integration
 function M.check()
-  local parsers = M.list_parsers()
+  local parsers = vim.api.nvim_get_runtime_file('parser/*', true)
 
   health.report_info(string.format('Nvim runtime ABI version: %d', ts.language_version))
 
   for _, parser in pairs(parsers) do
     local parsername = vim.fn.fnamemodify(parser, ':t:r')
-    local is_loadable, ret = pcall(ts.language.add, parsername)
+    local is_loadable, err_or_nil = pcall(ts.language.add, parsername)
 
-    if not is_loadable or not ret then
+    if not is_loadable then
       health.report_error(
-        string.format('Parser "%s" failed to load (path: %s): %s', parsername, parser, ret or '?')
+        string.format(
+          'Parser "%s" failed to load (path: %s): %s',
+          parsername,
+          parser,
+          err_or_nil or '?'
+        )
       )
-    elseif ret then
+    else
       local lang = ts.language.inspect_language(parsername)
       health.report_ok(
         string.format('Parser: %-10s ABI: %d, path: %s', parsername, lang._abi_version, parser)
diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index 0796383bf5..5bcc786e88 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -63,7 +63,7 @@ function M.add(lang, opts)
   M.register(lang, filetype or lang)
 
   if vim._ts_has_language(lang) then
-    return true
+    return
   end
 
   if path == nil then
-- 
cgit 


From 2a8e6a2f1a8e047a8efd84764d9a332bbd6ae96d Mon Sep 17 00:00:00 2001
From: Amaan Qureshi <amaanq12@gmail.com>
Date: Mon, 27 Feb 2023 15:08:31 -0500
Subject: vim-patch:9.0.1360: Cue files are not recognized (#22439)

Problem:    Cue files are not recognized.
Solution:   Add patterns for Cue files. (Amaan Qureshi, closes vim/vim#12067)

https://github.com/vim/vim/commit/80c5b2c0f78b24e52c73bb162dda3ad85acd7e82
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index a4e078fd04..256c053801 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -276,6 +276,7 @@ local extension = {
   feature = 'cucumber',
   cuh = 'cuda',
   cu = 'cuda',
+  cue = 'cue',
   pld = 'cupl',
   si = 'cuplsim',
   cyn = 'cynpp',
-- 
cgit 


From f89e3497c88f59916e3bce2e902be9b0f8bf15ba Mon Sep 17 00:00:00 2001
From: Mike <Mike325@users.noreply.github.com>
Date: Mon, 27 Feb 2023 14:19:41 -0600
Subject: docs(lsp): update cmd_env description (#22438)

---
 runtime/lua/vim/lsp.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index d215b4c47e..61a06ff7a7 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -908,11 +908,11 @@ end
 ---       the `cmd` process. Not related to `root_dir`.
 ---
 --- - cmd_env: (table) Environment flags to pass to the LSP on
----       spawn.  Can be specified using keys like a map or as a list with `k=v`
----       pairs or both. Non-string values are coerced to string.
+---       spawn.  Must be specified using a map-like table.
+---       Non-string values are coerced to string.
 ---       Example:
 ---       <pre>
----                   { "PRODUCTION=true"; "TEST=123"; PORT = 8080; HOST = "0.0.0.0"; }
+---                   { PORT = 8080; HOST = "0.0.0.0"; }
 ---       </pre>
 ---
 --- - detached: (boolean, default true) Daemonize the server process so that it runs in a
-- 
cgit 


From 7574d58304aa3b030aca8f5feafc0f92ec1d81e2 Mon Sep 17 00:00:00 2001
From: Folke Lemaitre <folke.lemaitre@gmail.com>
Date: Tue, 28 Feb 2023 12:12:08 +0100
Subject: fix(inspect): alwasy resolve full treesitter lang hl groups

---
 runtime/lua/vim/_inspector.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_inspector.lua b/runtime/lua/vim/_inspector.lua
index f46a525910..bb6608421b 100644
--- a/runtime/lua/vim/_inspector.lua
+++ b/runtime/lua/vim/_inspector.lua
@@ -69,7 +69,7 @@ function vim.inspect_pos(bufnr, row, col, filter)
   -- treesitter
   if filter.treesitter then
     for _, capture in pairs(vim.treesitter.get_captures_at_pos(bufnr, row, col)) do
-      capture.hl_group = '@' .. capture.capture
+      capture.hl_group = '@' .. capture.capture .. '.' .. capture.lang
       table.insert(results.treesitter, resolve_hl(capture))
     end
   end
-- 
cgit 


From 7e19cabeb192d2e7f20d7bb965a3f62e1543d2ac Mon Sep 17 00:00:00 2001
From: bfredl <bjorn.linse@gmail.com>
Date: Tue, 28 Feb 2023 12:38:33 +0100
Subject: perf(lsp): only redraw the windows containing LSP tokens

redraw! redraws the entire screen instead of just the windows with
the buffer which were actually changed.

I considered trying to calculating the range for the delta
but it looks tricky. Could a follow-up.
---
 runtime/lua/vim/lsp/semantic_tokens.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 00b4757ea9..24b5c6c24e 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -334,7 +334,8 @@ function STHighlighter:process_response(response, client, version)
   current_result.highlights = tokens_to_ranges(tokens, self.bufnr, client)
   current_result.namespace_cleared = false
 
-  api.nvim_command('redraw!')
+  -- redraw all windows displaying buffer
+  api.nvim__buf_redraw_range(self.bufnr, 0, -1)
 end
 
 --- on_win handler for the decoration provider (see |nvim_set_decoration_provider|)
-- 
cgit 


From 96d3616a531b2626e3ab9b4fa2c5dea03a927717 Mon Sep 17 00:00:00 2001
From: Jens Claes <jensclaes33@gmail.com>
Date: Wed, 1 Mar 2023 11:35:16 +0100
Subject: fix(lsp): callHierarchy methods also require the
 callHierarchyProvider (#22427)

---
 runtime/lua/vim/lsp.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 61a06ff7a7..fed56ff846 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -46,6 +46,8 @@ lsp._request_name_to_capability = {
   ['textDocument/typeDefinition'] = { 'typeDefinitionProvider' },
   ['textDocument/documentSymbol'] = { 'documentSymbolProvider' },
   ['textDocument/prepareCallHierarchy'] = { 'callHierarchyProvider' },
+  ['callHierarchy/incomingCalls'] = { 'callHierarchyProvider' },
+  ['callHierarchy/outgoingCalls'] = { 'callHierarchyProvider' },
   ['textDocument/rename'] = { 'renameProvider' },
   ['textDocument/prepareRename'] = { 'renameProvider', 'prepareProvider' },
   ['textDocument/codeAction'] = { 'codeActionProvider' },
-- 
cgit 


From 896d672736b32a8f4a4fa51844b44f266dcdcc6c Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Wed, 1 Mar 2023 15:33:13 +0100
Subject: fix(lsp): use buffer scheme for files not stored on disk (#22407)

Sending `didOpen` with a `file` scheme causes problems with some
language servers because they expect the file to exist on disk.

See https://github.com/microsoft/language-server-protocol/pull/1679
---
 runtime/lua/vim/lsp.lua      | 54 ++++++++++++++++++++++++++++++++++----------
 runtime/lua/vim/lsp/util.lua |  9 ++++++--
 2 files changed, 49 insertions(+), 14 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index fed56ff846..a6d550f48f 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -367,7 +367,7 @@ do
   --- @field offset_encoding "utf-8"|"utf-16"|"utf-32"
   ---
   --- @class CTBufferState
-  --- @field name string name of the buffer
+  --- @field uri string uri of the buffer
   --- @field lines string[] snapshot of buffer lines from last didChange
   --- @field lines_tmp string[]
   --- @field pending_changes table[] List of debounced changes in incremental sync mode
@@ -486,8 +486,12 @@ do
     if buf_state then
       buf_state.refs = buf_state.refs + 1
     else
+      local uri = vim.uri_from_bufnr(bufnr)
+      if not uv.fs_stat(api.nvim_buf_get_name(bufnr)) then
+        uri = uri:gsub('^file://', 'buffer://')
+      end
       buf_state = {
-        name = api.nvim_buf_get_name(bufnr),
+        uri = uri,
         lines = {},
         lines_tmp = {},
         pending_changes = {},
@@ -502,12 +506,26 @@ do
   end
 
   ---@private
-  function changetracking._get_and_set_name(client, bufnr, name)
+  ---@param client table
+  ---@param bufnr integer
+  ---@return string uri
+  function changetracking._get_uri(client, bufnr)
     local state = state_by_group[get_group(client)] or {}
     local buf_state = (state.buffers or {})[bufnr]
-    local old_name = buf_state.name
-    buf_state.name = name
-    return old_name
+    return assert(buf_state.uri, 'Must have an URI set')
+  end
+
+  ---@private
+  ---@param client table
+  ---@param bufnr integer
+  ---@param uri string
+  ---@return string uri
+  function changetracking._get_and_set_uri(client, bufnr, uri)
+    local state = state_by_group[get_group(client)] or {}
+    local buf_state = (state.buffers or {})[bufnr]
+    local old_uri = buf_state.uri
+    buf_state.uri = uri
+    return old_uri
   end
 
   ---@private
@@ -594,7 +612,7 @@ do
         { text = buf_get_full_text(bufnr) },
       }
     end
-    local uri = vim.uri_from_bufnr(bufnr)
+    local uri = buf_state.uri
     for _, client in pairs(state.clients) do
       if not client.is_stopped() and lsp.buf_is_attached(bufnr, client.id) then
         client.notify('textDocument/didChange', {
@@ -707,11 +725,14 @@ local function text_document_did_open_handler(bufnr, client)
     return
   end
   local filetype = nvim_buf_get_option(bufnr, 'filetype')
-
+  local uri = vim.uri_from_bufnr(bufnr)
+  if not uv.fs_stat(api.nvim_buf_get_name(bufnr)) then
+    uri = uri:gsub('^file://', 'buffer://')
+  end
   local params = {
     textDocument = {
       version = 0,
-      uri = vim.uri_from_bufnr(bufnr),
+      uri = uri,
       languageId = client.config.get_language_id(bufnr, filetype),
       text = buf_get_full_text(bufnr),
     },
@@ -1560,8 +1581,13 @@ local function text_document_did_save_handler(bufnr)
   local text = once(buf_get_full_text)
   for_each_buffer_client(bufnr, function(client)
     local name = api.nvim_buf_get_name(bufnr)
-    local old_name = changetracking._get_and_set_name(client, bufnr, name)
-    if old_name and name ~= old_name then
+    local old_uri = changetracking._get_and_set_uri(client, bufnr, uri)
+    if old_uri and name ~= old_uri then
+      client.notify('textDocument/didClose', {
+        textDocument = {
+          uri = old_uri,
+        },
+      })
       client.notify('textDocument/didOpen', {
         textDocument = {
           version = 0,
@@ -1664,8 +1690,12 @@ function lsp.buf_attach_client(bufnr, client_id)
         end)
       end,
       on_detach = function()
-        local params = { textDocument = { uri = uri } }
         for_each_buffer_client(bufnr, function(client, _)
+          local params = {
+            textDocument = {
+              uri = changetracking._get_uri(client, bufnr),
+            },
+          }
           changetracking.reset_buf(client, bufnr)
           if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
             client.notify('textDocument/didClose', params)
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 4beb4fc367..554e26022c 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -2032,7 +2032,12 @@ end
 ---@returns `TextDocumentIdentifier`
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentIdentifier
 function M.make_text_document_params(bufnr)
-  return { uri = vim.uri_from_bufnr(bufnr or 0) }
+  bufnr = bufnr or 0
+  local uri = vim.uri_from_bufnr(bufnr)
+  if not uv.fs_stat(api.nvim_buf_get_name(bufnr)) then
+    uri = uri:gsub('^file://', 'buffer://')
+  end
+  return { uri = uri }
 end
 
 --- Create the workspace params
@@ -2065,7 +2070,7 @@ function M.make_formatting_params(options)
     insertSpaces = vim.bo.expandtab,
   })
   return {
-    textDocument = { uri = vim.uri_from_bufnr(0) },
+    textDocument = M.make_text_document_params(0),
     options = options,
   }
 end
-- 
cgit 


From 014981c9006f9b96b8045e609dc27f4a84da5263 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 1 Mar 2023 09:47:56 -0700
Subject: fix(lsp): only fire LspDetach for attached buffers (#22468)

If the LSP server fails to start then the client never initializes and
thus never calls its on_attach function and an LspAttach event is
never fired. However, the on_exit function still fires a LspDetach
event, so user autocommands that attempt to "clean up" in LspDetach may
run into problems if they assume that the buffer was already attached.

The solution is to only fire an LspDetach event if the buffer was
already attached in the first place.
---
 runtime/lua/vim/lsp.lua | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index a6d550f48f..a56e141c29 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1155,14 +1155,19 @@ function lsp.start_client(config)
       pcall(config.on_exit, code, signal, client_id)
     end
 
+    local client = active_clients[client_id] and active_clients[client_id]
+      or uninitialized_clients[client_id]
+
     for bufnr, client_ids in pairs(all_buffer_active_clients) do
       if client_ids[client_id] then
         vim.schedule(function()
-          nvim_exec_autocmds('LspDetach', {
-            buffer = bufnr,
-            modeline = false,
-            data = { client_id = client_id },
-          })
+          if client and client.attached_buffers[bufnr] then
+            nvim_exec_autocmds('LspDetach', {
+              buffer = bufnr,
+              modeline = false,
+              data = { client_id = client_id },
+            })
+          end
 
           local namespace = vim.lsp.diagnostic.get_namespace(client_id)
           vim.diagnostic.reset(namespace, bufnr)
@@ -1178,8 +1183,6 @@ function lsp.start_client(config)
     -- Schedule the deletion of the client object so that it exists in the execution of LspDetach
     -- autocommands
     vim.schedule(function()
-      local client = active_clients[client_id] and active_clients[client_id]
-        or uninitialized_clients[client_id]
       active_clients[client_id] = nil
       uninitialized_clients[client_id] = nil
 
-- 
cgit 


From bc15b075d14c85098d674a2466d2386e08b0005f Mon Sep 17 00:00:00 2001
From: Mike <Mike325@users.noreply.github.com>
Date: Wed, 1 Mar 2023 10:51:22 -0600
Subject: feat(vim.fs): pass path to find() predicate, lazy evaluate #22378

Problem:
No easy way to find files under certain directories (ex: grab all files under
`test/`) or exclude the content of certain paths (ex. `build/`, `.git/`)

Solution:
Pass the full `path` as an arg to the predicate.
---
 runtime/lua/vim/fs.lua | 35 +++++++++++++++++++++++++++++------
 1 file changed, 29 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index a0d2c4c339..2c3fc64d57 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -144,11 +144,34 @@ end
 --- The search can be narrowed to find only files or only directories by
 --- specifying {type} to be "file" or "directory", respectively.
 ---
----@param names (string|table|fun(name: string): boolean) Names of the files
+--- Examples:
+--- <pre>lua
+--- -- location of Cargo.toml from the current buffer's path
+--- local cargo = vim.fs.find('Cargo.toml', {
+---   upward = true,
+---   stop = vim.loop.os_homedir(),
+---   path = vim.fs.dirname(vim.api.nvim_buf_get_name(0)),
+--- })
+---
+--- -- list all test directories under the runtime directory
+--- local test_dirs = vim.fs.find(
+---   {'test', 'tst', 'testdir'},
+---   {limit = math.huge, type = 'directory', path = './runtime/'}
+--- )
+---
+--- -- get all files ending with .cpp or .hpp inside lib/
+--- local cpp_hpp = vim.fs.find(function(name, path)
+---   return name:match('.*%.[ch]pp$') and path:match('[/\\\\]lib$')
+--- end, {limit = math.huge, type = 'file'})
+--- </pre>
+---
+---@param names (string|table|fun(name: string, path: string): boolean) Names of the files
 ---             and directories to find.
----             Must be base names, paths and globs are not supported.
----             The function is called per file and directory within the
----             traversed directories to test if they match {names}.
+---             Must be base names, paths and globs are not supported when {names} is a string or a table.
+---             If {names} is a function, it is called for each traversed file and directory with args:
+---             - name: base name of the current item
+---             - path: full path of the current item
+---             The function should return `true` if the given file or directory is considered a match.
 ---
 ---@param opts (table) Optional keyword arguments:
 ---                       - path (string): Path to begin searching from. If
@@ -201,7 +224,7 @@ function M.find(names, opts)
       test = function(p)
         local t = {}
         for name, type in M.dir(p) do
-          if names(name) and (not opts.type or opts.type == type) then
+          if (not opts.type or opts.type == type) and names(name, p) then
             table.insert(t, join_paths(p, name))
           end
         end
@@ -250,7 +273,7 @@ function M.find(names, opts)
       for other, type_ in M.dir(dir) do
         local f = join_paths(dir, other)
         if type(names) == 'function' then
-          if names(other) and (not opts.type or opts.type == type_) then
+          if (not opts.type or opts.type == type_) and names(other, dir) then
             if add(f) then
               return matches
             end
-- 
cgit 


From b0b4c310973c2b419350e3c05c772596b1c334e9 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Thu, 2 Mar 2023 10:01:42 -0500
Subject: refactor: rename show_tree => inspect_tree #22474

Problem:
"show" is potentially a new verb that we can avoid (there is already
"open" and "echo"). Even if we can't avoid it, the behavior of
`show_tree` fits well in the "inspect" family of functions: a way for
users to introspect/reflect on the state of Nvim.

Existing "inspect" functions:
    vim.inspect()
    vim.inspect_pos()
    vim.treesitter.inspect_language()
    nvim__inspect_cell

Solution:
Rename `show_tree` to `inspect_tree`.
---
 runtime/lua/vim/treesitter.lua | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index fead7b7b1b..412140b757 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -436,7 +436,7 @@ end
 ---                      - title (string|fun(bufnr:integer):string|nil): Title of the window. If a
 ---                        function, it accepts the buffer number of the source buffer as its only
 ---                        argument and should return a string.
-function M.show_tree(opts)
+function M.inspect_tree(opts)
   vim.validate({
     opts = { opts, 't', true },
   })
@@ -622,6 +622,12 @@ function M.show_tree(opts)
   })
 end
 
+---@deprecated
+---@private
+function M.show_tree()
+  vim.deprecate('show_tree', 'inspect_tree', '0.9', nil, false)
+end
+
 --- Returns the fold level for {lnum} in the current buffer. Can be set directly to 'foldexpr':
 --- <pre>lua
 --- vim.wo.foldexpr = 'v:lua.vim.treesitter.foldexpr()'
-- 
cgit 


From f449121764c19cebda7b8b2c970b76bc8121bae7 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Thu, 2 Mar 2023 18:03:11 +0100
Subject: feat(treesitter): add :InspectTree command (#22477)

---
 runtime/lua/vim/treesitter.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 412140b757..09e3814a17 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -424,6 +424,8 @@ end
 --- display of the source language of each node, and press <Enter> to jump to the node under the
 --- cursor in the source buffer.
 ---
+--- Can also be shown with `:InspectTree`. *:InspectTree*
+---
 ---@param opts table|nil Optional options table with the following possible keys:
 ---                      - lang (string|nil): The language of the source buffer. If omitted, the
 ---                        filetype of the source buffer is used.
-- 
cgit 


From 2eeafc43c43697d18d5634f8f81bf9e60a880e17 Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Thu, 2 Mar 2023 14:06:11 -0700
Subject: fix(treesitter): maintain cursor position when toggling anonymous
 nodes

When toggling anonymous nodes in the :InspectTree window, keep the
cursor fixed relative to the node within the tree. This prevents the
cursor from jumping.
---
 runtime/lua/vim/treesitter.lua | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 09e3814a17..b2909f2154 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -506,8 +506,26 @@ function M.inspect_tree(opts)
   a.nvim_buf_set_keymap(b, 'n', 'a', '', {
     desc = 'Toggle anonymous nodes',
     callback = function()
+      local row, col = unpack(a.nvim_win_get_cursor(w))
+      local curnode = pg:get(row)
+      while curnode and not curnode.named do
+        row = row - 1
+        curnode = pg:get(row)
+      end
+
       pg.opts.anon = not pg.opts.anon
       pg:draw(b)
+
+      if not curnode then
+        return
+      end
+
+      local id = curnode.id
+      for i, node in pg:iter() do
+        if node.id == id then
+          a.nvim_win_set_cursor(w, { i, col })
+        end
+      end
     end,
   })
   a.nvim_buf_set_keymap(b, 'n', 'I', '', {
-- 
cgit 


From 86ff239240e955ef6da95bc9c8814cfd4492f5aa Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Thu, 2 Mar 2023 14:15:18 -0700
Subject: refactor(treesitter): use string.format to create lines

---
 runtime/lua/vim/treesitter/playground.lua | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/playground.lua b/runtime/lua/vim/treesitter/playground.lua
index fd5b687195..992433961f 100644
--- a/runtime/lua/vim/treesitter/playground.lua
+++ b/runtime/lua/vim/treesitter/playground.lua
@@ -146,9 +146,9 @@ local decor_ns = api.nvim_create_namespace('ts.playground')
 ---@return string
 local function get_range_str(lnum, col, end_col, end_lnum)
   if lnum == end_lnum then
-    return string.format('[%d:%d-%d]', lnum + 1, col + 1, end_col)
+    return string.format('[%d:%d - %d]', lnum + 1, col + 1, end_col)
   end
-  return string.format('[%d:%d-%d:%d]', lnum + 1, col + 1, end_lnum + 1, end_col)
+  return string.format('[%d:%d - %d:%d]', lnum + 1, col + 1, end_lnum + 1, end_col)
 end
 
 --- Write the contents of this Playground into {bufnr}.
@@ -163,7 +163,8 @@ function TSPlayground:draw(bufnr)
   for _, item in self:iter() do
     local range_str = get_range_str(item.lnum, item.col, item.end_lnum, item.end_col)
     local lang_str = self.opts.lang and string.format(' %s', item.lang) or ''
-    local line = string.rep(' ', item.depth) .. item.text .. '; ' .. range_str .. lang_str
+    local line =
+      string.format('%s%s ; %s%s', string.rep(' ', item.depth), item.text, range_str, lang_str)
 
     if self.opts.lang then
       lang_hl_marks[#lang_hl_marks + 1] = {
-- 
cgit 


From fdb6b4d2e729211f0526ce75c6a3fcc636859bfd Mon Sep 17 00:00:00 2001
From: Amaan Qureshi <amaanq12@gmail.com>
Date: Thu, 2 Mar 2023 17:29:03 -0500
Subject: vim-patch:9.0.1368: Bass files are not recognized (#22485)

Problem:    Bass files are not recognized.
Solution:   Add patterns for Bass files. (Amaan Qureshi, closes vim/vim#12088)

https://github.com/vim/vim/commit/4ed914b18a47192f79f342bea5e8f59e120d5260
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 256c053801..8911eafc71 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -156,6 +156,7 @@ local extension = {
   bas = function(path, bufnr)
     return require('vim.filetype.detect').bas(bufnr)
   end,
+  bass = 'bass',
   bi = function(path, bufnr)
     return require('vim.filetype.detect').bas(bufnr)
   end,
-- 
cgit 


From 6d4f48182131c36d57589eefd4cefe3c70256d04 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 3 Mar 2023 09:44:02 +0000
Subject: fix(treesitter): disallow empty filetypes

Fixes #22473
---
 runtime/lua/vim/treesitter.lua          |  3 ++-
 runtime/lua/vim/treesitter/language.lua | 10 ++++++++++
 2 files changed, 12 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 09e3814a17..f80da433b1 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -47,7 +47,8 @@ function M._create_parser(bufnr, lang, opts)
 
   vim.fn.bufload(bufnr)
 
-  language.add(lang, { filetype = vim.bo[bufnr].filetype })
+  local ft = vim.bo[bufnr].filetype
+  language.add(lang, { filetype = ft ~= '' and ft or nil })
 
   local self = LanguageTree.new(bufnr, lang, opts)
 
diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index 5bcc786e88..5f34d9cd56 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -60,6 +60,16 @@ function M.add(lang, opts)
     filetype = { filetype, { 'string', 'table' }, true },
   })
 
+  if filetype == '' then
+    error(string.format("'%s' is not a valid filetype", filetype))
+  elseif type(filetype) == 'table' then
+    for _, f in ipairs(filetype) do
+      if f == '' then
+        error(string.format("'%s' is not a valid filetype", filetype))
+      end
+    end
+  end
+
   M.register(lang, filetype or lang)
 
   if vim._ts_has_language(lang) then
-- 
cgit 


From f0a2ffab2923202f4454860ba1a7c7bd0e035ed2 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Fri, 3 Mar 2023 20:05:59 +0900
Subject: fix(treesitter): typos in _range.lua

fix(treesitter): typos _range.lua
---
 runtime/lua/vim/treesitter/_range.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_range.lua b/runtime/lua/vim/treesitter/_range.lua
index b87542c20f..8decd3a1fd 100644
--- a/runtime/lua/vim/treesitter/_range.lua
+++ b/runtime/lua/vim/treesitter/_range.lua
@@ -61,7 +61,7 @@ function M.intercepts(r1, r2)
   local off_1 = #r1 == 6 and 1 or 0
   local off_2 = #r1 == 6 and 1 or 0
 
-  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r2[2], r1[3 + off_1], r1[4 + off_1]
+  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r1[2], r1[3 + off_1], r1[4 + off_1]
   local srow_2, scol_2, erow_2, ecol_2 = r2[1], r2[2], r2[3 + off_2], r2[4 + off_2]
 
   -- r1 is above r2
@@ -85,7 +85,7 @@ function M.contains(r1, r2)
   local off_1 = #r1 == 6 and 1 or 0
   local off_2 = #r1 == 6 and 1 or 0
 
-  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r2[2], r1[3 + off_1], r1[4 + off_1]
+  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r1[2], r1[3 + off_1], r1[4 + off_1]
   local srow_2, scol_2, erow_2, ecol_2 = r2[1], r2[2], r2[3 + off_2], r2[4 + off_2]
 
   -- start doesn't fit
-- 
cgit 


From 8414cfe7f4d8888698343cb54a3f373a28b365db Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Thu, 2 Mar 2023 20:46:59 +0100
Subject: docs: fix vim.treesitter tags

Problem:
Help tags like vim.treesitter.language.add() are confusing because
`vim.treesitter.language` is (thankfully) not a user-facing module.

Solution:
Ignore the "fstem" when generating "treesitter" tags.
---
 runtime/lua/vim/treesitter/highlighter.lua  |  4 +++-
 runtime/lua/vim/treesitter/languagetree.lua | 20 +++++++++-----------
 runtime/lua/vim/treesitter/query.lua        |  5 ++---
 3 files changed, 14 insertions(+), 15 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index 8adaa4ef2f..e3deaf6ba6 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -58,7 +58,9 @@ function TSHighlighterQuery:query()
   return self._query
 end
 
---- Creates a new highlighter using @param tree
+---@private
+---
+--- Creates a highlighter for `tree`.
 ---
 ---@param tree LanguageTree parser object to use for highlighting
 ---@param opts (table|nil) Configuration of the highlighter:
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 43fb866896..1bc7971eba 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -38,18 +38,16 @@ local LanguageTree = {}
 
 LanguageTree.__index = LanguageTree
 
---- A |LanguageTree| holds the treesitter parser for a given language {lang} used
---- to parse a buffer. As the buffer may contain injected languages, the LanguageTree
---- needs to store parsers for these child languages as well (which in turn may contain
---- child languages themselves, hence the name).
+--- @private
 ---
----@param source (integer|string) Buffer or a string of text to parse
----@param lang string Root language this tree represents
----@param opts (table|nil) Optional keyword arguments:
----             - injections table Mapping language to injection query strings.
----                                This is useful for overriding the built-in
----                                runtime file searching for the injection language
----                                query per language.
+--- |LanguageTree| contains a tree of parsers: the root treesitter parser for {lang} and any
+--- "injected" language parsers, which themselves may inject other languages, recursively.
+---
+---@param source (integer|string) Buffer or text string to parse
+---@param lang string Root language of this tree
+---@param opts (table|nil) Optional arguments:
+---             - injections table Map of language to injection query strings. Overrides the
+---                                built-in runtime file searching for language injections.
 ---@return LanguageTree parser object
 function LanguageTree.new(source, lang, opts)
   language.add(lang)
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 13d98a0625..4e9871b59d 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -273,8 +273,7 @@ end
 ---@param opts (table|nil) Optional parameters.
 ---          - concat: (boolean) Concatenate result in a string (default true)
 ---          - metadata (table) Metadata of a specific capture. This would be
----            set to `metadata[capture_id]` when using
----            |vim.treesitter.query.add_directive()|.
+---            set to `metadata[capture_id]` when using |vim.treesitter.add_directive()|.
 ---@return (string[]|string|nil)
 function M.get_node_text(node, source, opts)
   opts = opts or {}
@@ -486,7 +485,7 @@ local directive_handlers = {
 ---
 ---@param name string Name of the predicate, without leading #
 ---@param handler function(match:table<string,TSNode>, pattern:string, bufnr:number, predicate:string[])
----   - see |vim.treesitter.query.add_directive()| for argument meanings
+---   - see |vim.treesitter.add_directive()| for argument meanings
 ---@param force boolean|nil
 function M.add_predicate(name, handler, force)
   if predicate_handlers[name] and not force then
-- 
cgit 


From bf90ceb5488ea2b41eb53335984f017785aefea9 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Fri, 3 Mar 2023 07:52:57 -0700
Subject: fix(treesitter): break early from loop when match is found (#22499)

Fixup to #22484.
---
 runtime/lua/vim/treesitter.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index b63247aa2c..ee66ba9f9b 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -525,6 +525,7 @@ function M.inspect_tree(opts)
       for i, node in pg:iter() do
         if node.id == id then
           a.nvim_win_set_cursor(w, { i, col })
+          break
         end
       end
     end,
-- 
cgit 


From 128b82103ba477482bdfaf10ec71e0986876cca1 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sat, 4 Mar 2023 22:04:05 +0900
Subject: docs(treesitter): number → integer (#22513)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 runtime/lua/vim/treesitter/playground.lua | 22 +++++++++++-----------
 runtime/lua/vim/treesitter/query.lua      | 12 ++++++------
 2 files changed, 17 insertions(+), 17 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/playground.lua b/runtime/lua/vim/treesitter/playground.lua
index 992433961f..7f181c23fd 100644
--- a/runtime/lua/vim/treesitter/playground.lua
+++ b/runtime/lua/vim/treesitter/playground.lua
@@ -1,7 +1,7 @@
 local api = vim.api
 
 ---@class TSPlayground
----@field ns number API namespace
+---@field ns integer API namespace
 ---@field opts table Options table with the following keys:
 ---                  - anon (boolean): If true, display anonymous nodes
 ---                  - lang (boolean): If true, display the language alongside each node
@@ -10,14 +10,14 @@ local api = vim.api
 local TSPlayground = {}
 ---
 ---@class Node
----@field id number Node id
+---@field id integer Node id
 ---@field text string Node text
 ---@field named boolean True if this is a named (non-anonymous) node
----@field depth number Depth of the node within the tree
----@field lnum number Beginning line number of this node in the source buffer
----@field col number Beginning column number of this node in the source buffer
----@field end_lnum number Final line number of this node in the source buffer
----@field end_col number Final column number of this node in the source buffer
+---@field depth integer Depth of the node within the tree
+---@field lnum integer Beginning line number of this node in the source buffer
+---@field col integer Beginning column number of this node in the source buffer
+---@field end_lnum integer Final line number of this node in the source buffer
+---@field end_col integer Final column number of this node in the source buffer
 ---@field lang string Source language of this node
 ---@field root TSNode
 
@@ -34,7 +34,7 @@ local TSPlayground = {}
 --- table maps nodes in the primary tree to root nodes of injected trees.
 ---
 ---@param node TSNode Starting node to begin traversal |tsnode|
----@param depth number Current recursion depth
+---@param depth integer Current recursion depth
 ---@param lang string Language of the tree currently being traversed
 ---@param injections table<integer,Node> Mapping of node ids to root nodes of injected language trees (see
 ---                        explanation above)
@@ -153,7 +153,7 @@ end
 
 --- Write the contents of this Playground into {bufnr}.
 ---
----@param bufnr number Buffer number to write into.
+---@param bufnr integer Buffer number to write into.
 ---@private
 function TSPlayground:draw(bufnr)
   vim.bo[bufnr].modifiable = true
@@ -194,7 +194,7 @@ end
 ---
 --- The node number is dependent on whether or not anonymous nodes are displayed.
 ---
----@param i number Node number to get
+---@param i integer Node number to get
 ---@return Node
 ---@private
 function TSPlayground:get(i)
@@ -206,7 +206,7 @@ end
 ---
 ---@return (fun(): integer, Node) Iterator over all nodes in this Playground
 ---@return table
----@return number
+---@return integer
 ---@private
 function TSPlayground:iter()
   return ipairs(self.opts.anon and self.nodes or self.named)
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 4e9871b59d..22f706585e 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -56,7 +56,7 @@ local function add_included_lang(base_langs, lang, ilang)
 end
 
 ---@private
----@param buf (number)
+---@param buf (integer)
 ---@param range (table)
 ---@param concat (boolean)
 ---@returns (string[]|string|nil)
@@ -269,7 +269,7 @@ end
 --- Gets the text corresponding to a given node
 ---
 ---@param node TSNode
----@param source (number|string) Buffer or string from which the {node} is extracted
+---@param source (integer|string) Buffer or string from which the {node} is extracted
 ---@param opts (table|nil) Optional parameters.
 ---          - concat: (boolean) Concatenate result in a string (default true)
 ---          - metadata (table) Metadata of a specific capture. This would be
@@ -484,7 +484,7 @@ local directive_handlers = {
 --- Adds a new predicate to be used in queries
 ---
 ---@param name string Name of the predicate, without leading #
----@param handler function(match:table<string,TSNode>, pattern:string, bufnr:number, predicate:string[])
+---@param handler function(match:table<string,TSNode>, pattern:string, bufnr:integer, predicate:string[])
 ---   - see |vim.treesitter.add_directive()| for argument meanings
 ---@param force boolean|nil
 function M.add_predicate(name, handler, force)
@@ -503,7 +503,7 @@ end
 --- metadata table `metadata[capture_id].key = value`
 ---
 ---@param name string Name of the directive, without leading #
----@param handler function(match:table<string,TSNode>, pattern:string, bufnr:number, predicate:string[], metadata:table)
+---@param handler function(match:table<string,TSNode>, pattern:string, bufnr:integer, predicate:string[], metadata:table)
 ---   - match: see |treesitter-query|
 ---      - node-level data are accessible via `match[capture_id]`
 ---   - pattern: see |treesitter-query|
@@ -644,8 +644,8 @@ end
 ---
 ---@param node TSNode under which the search will occur
 ---@param source (integer|string) Source buffer or string to extract text from
----@param start number Starting line for the search
----@param stop number Stopping line for the search (end-exclusive)
+---@param start integer Starting line for the search
+---@param stop integer Stopping line for the search (end-exclusive)
 ---
 ---@return (fun(): integer, TSNode, TSMetadata): capture id, capture node, metadata
 function Query:iter_captures(node, source, start, stop)
-- 
cgit 


From 6a20c29dcd050fee011ec1c451b5e70940152885 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sat, 4 Mar 2023 22:05:01 +0900
Subject: docs(filetype): number → integer (#22516)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 runtime/lua/vim/filetype.lua | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 8911eafc71..65579d3543 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -28,9 +28,9 @@ end
 --- If only start_lnum is specified, return a single line as a string.
 --- If both start_lnum and end_lnum are omitted, return all lines from the buffer.
 ---
----@param bufnr number|nil The buffer to get the lines from
----@param start_lnum number|nil The line number of the first line (inclusive, 1-based)
----@param end_lnum number|nil The line number of the last line (inclusive, 1-based)
+---@param bufnr integer|nil The buffer to get the lines from
+---@param start_lnum integer|nil The line number of the first line (inclusive, 1-based)
+---@param end_lnum integer|nil The line number of the last line (inclusive, 1-based)
 ---@return table<string>|string Array of lines, or string when end_lnum is omitted
 function M.getlines(bufnr, start_lnum, end_lnum)
   if end_lnum then
@@ -67,8 +67,8 @@ end
 ---@private
 --- Get the next non-whitespace line in the buffer.
 ---
----@param bufnr number The buffer to get the line from
----@param start_lnum number The line number of the first line to start from (inclusive, 1-based)
+---@param bufnr integer The buffer to get the line from
+---@param start_lnum integer The line number of the first line to start from (inclusive, 1-based)
 ---@return string|nil The first non-blank line if found or `nil` otherwise
 function M.nextnonblank(bufnr, start_lnum)
   for _, line in ipairs(M.getlines(bufnr, start_lnum, -1)) do
-- 
cgit 


From ccd2cc1abd69f677edabd0b66dfd9689eeee54b9 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sat, 4 Mar 2023 22:05:16 +0900
Subject: docs(uri): number → integer (#22515)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 runtime/lua/vim/uri.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/uri.lua b/runtime/lua/vim/uri.lua
index d6b0b7410e..38759fcdc0 100644
--- a/runtime/lua/vim/uri.lua
+++ b/runtime/lua/vim/uri.lua
@@ -80,7 +80,7 @@ local URI_SCHEME_PATTERN = '^([a-zA-Z]+[a-zA-Z0-9.+-]*):.*'
 local WINDOWS_URI_SCHEME_PATTERN = '^([a-zA-Z]+[a-zA-Z0-9.+-]*):[a-zA-Z]:.*'
 
 --- Get a URI from a bufnr
----@param bufnr number
+---@param bufnr integer
 ---@return string URI
 local function uri_from_bufnr(bufnr)
   local fname = vim.api.nvim_buf_get_name(bufnr)
@@ -123,7 +123,7 @@ end
 --- Creates a new unloaded buffer if no buffer for the uri already exists.
 --
 ---@param uri string
----@return number bufnr
+---@return integer bufnr
 local function uri_to_bufnr(uri)
   return vim.fn.bufadd(uri_to_fname(uri))
 end
-- 
cgit 


From 1f07307aeb6564fb794921cc1b2879f84a822921 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sat, 4 Mar 2023 22:05:46 +0900
Subject: docs(inspect): number → integer (#22511)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 runtime/lua/vim/_inspector.lua | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_inspector.lua b/runtime/lua/vim/_inspector.lua
index bb6608421b..9e91597192 100644
--- a/runtime/lua/vim/_inspector.lua
+++ b/runtime/lua/vim/_inspector.lua
@@ -14,15 +14,15 @@ local defaults = {
 ---
 ---Can also be pretty-printed with `:Inspect!`. *:Inspect!*
 ---
----@param bufnr? number defaults to the current buffer
----@param row? number row to inspect, 0-based. Defaults to the row of the current cursor
----@param col? number col to inspect, 0-based. Defaults to the col of the current cursor
+---@param bufnr? integer defaults to the current buffer
+---@param row? integer row to inspect, 0-based. Defaults to the row of the current cursor
+---@param col? integer col to inspect, 0-based. Defaults to the col of the current cursor
 ---@param filter? InspectorFilter (table|nil) a table with key-value pairs to filter the items
 ---               - syntax (boolean): include syntax based highlight groups (defaults to true)
 ---               - treesitter (boolean): include treesitter based highlight groups (defaults to true)
 ---               - extmarks (boolean|"all"): include extmarks. When `all`, then extmarks without a `hl_group` will also be included (defaults to true)
 ---               - semantic_tokens (boolean): include semantic tokens (defaults to true)
----@return {treesitter:table,syntax:table,extmarks:table,semantic_tokens:table,buffer:number,col:number,row:number} (table) a table with the following key-value pairs. Items are in "traversal order":
+---@return {treesitter:table,syntax:table,extmarks:table,semantic_tokens:table,buffer:integer,col:integer,row:integer} (table) a table with the following key-value pairs. Items are in "traversal order":
 ---               - treesitter: a list of treesitter captures
 ---               - syntax: a list of syntax groups
 ---               - semantic_tokens: a list of semantic tokens
@@ -129,9 +129,9 @@ end
 ---
 ---Can also be shown with `:Inspect`. *:Inspect*
 ---
----@param bufnr? number defaults to the current buffer
----@param row? number row to inspect, 0-based. Defaults to the row of the current cursor
----@param col? number col to inspect, 0-based. Defaults to the col of the current cursor
+---@param bufnr? integer defaults to the current buffer
+---@param row? integer row to inspect, 0-based. Defaults to the row of the current cursor
+---@param col? integer col to inspect, 0-based. Defaults to the col of the current cursor
 ---@param filter? InspectorFilter (table|nil) see |vim.inspect_pos()|
 function vim.show_pos(bufnr, row, col, filter)
   local items = vim.inspect_pos(bufnr, row, col, filter)
-- 
cgit 


From 82b77900d7f85088c676be886937628230d0d5c2 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sat, 4 Mar 2023 22:06:20 +0900
Subject: docs(diagnostic): number → integer (#22512)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 runtime/lua/vim/diagnostic.lua | 46 +++++++++++++++++++++---------------------
 1 file changed, 23 insertions(+), 23 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index 6fd000a029..56532d0184 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -630,7 +630,7 @@ end
 ---                         Options:
 ---                         * reverse: (boolean) Reverse sort order
 ---
----@param namespace number|nil Update the options for the given namespace. When omitted, update the
+---@param namespace integer|nil Update the options for the given namespace. When omitted, update the
 ---                            global diagnostic options.
 function M.config(opts, namespace)
   vim.validate({
@@ -674,8 +674,8 @@ end
 
 --- Set diagnostics for the given namespace and buffer.
 ---
----@param namespace number The diagnostic namespace
----@param bufnr number Buffer number
+---@param namespace integer The diagnostic namespace
+---@param bufnr integer Buffer number
 ---@param diagnostics table A list of diagnostic items |diagnostic-structure|
 ---@param opts table|nil Display options to pass to |vim.diagnostic.show()|
 function M.set(namespace, bufnr, diagnostics, opts)
@@ -711,7 +711,7 @@ end
 
 --- Get namespace metadata.
 ---
----@param namespace number Diagnostic namespace
+---@param namespace integer Diagnostic namespace
 ---@return table Namespace metadata
 function M.get_namespace(namespace)
   vim.validate({ namespace = { namespace, 'n' } })
@@ -743,11 +743,11 @@ function M.get_namespaces()
 end
 
 ---@class Diagnostic
----@field buffer number
----@field lnum number 0-indexed
----@field end_lnum nil|number 0-indexed
----@field col number 0-indexed
----@field end_col nil|number 0-indexed
+---@field buffer integer
+---@field lnum integer 0-indexed
+---@field end_lnum nil|integer 0-indexed
+---@field col integer 0-indexed
+---@field end_col nil|integer 0-indexed
 ---@field severity DiagnosticSeverity
 ---@field message string
 ---@field source nil|string
@@ -756,7 +756,7 @@ end
 
 --- Get current diagnostics.
 ---
----@param bufnr number|nil Buffer number to get diagnostics from. Use 0 for
+---@param bufnr integer|nil Buffer number to get diagnostics from. Use 0 for
 ---                        current buffer or nil for all buffers.
 ---@param opts table|nil A table with the following keys:
 ---                        - namespace: (number) Limit diagnostics to the given namespace.
@@ -1083,9 +1083,9 @@ end
 --- To hide diagnostics and prevent them from re-displaying, use
 --- |vim.diagnostic.disable()|.
 ---
----@param namespace number|nil Diagnostic namespace. When omitted, hide
+---@param namespace integer|nil Diagnostic namespace. When omitted, hide
 ---                            diagnostics from all namespaces.
----@param bufnr number|nil Buffer number, or 0 for current buffer. When
+---@param bufnr integer|nil Buffer number, or 0 for current buffer. When
 ---                        omitted, hide diagnostics in all buffers.
 function M.hide(namespace, bufnr)
   vim.validate({
@@ -1108,8 +1108,8 @@ end
 
 --- Check whether diagnostics are disabled in a given buffer.
 ---
----@param bufnr number|nil Buffer number, or 0 for current buffer.
----@param namespace number|nil Diagnostic namespace. When omitted, checks if
+---@param bufnr integer|nil Buffer number, or 0 for current buffer.
+---@param namespace integer|nil Diagnostic namespace. When omitted, checks if
 ---                            all diagnostics are disabled in {bufnr}.
 ---                            Otherwise, only checks if diagnostics from
 ---                            {namespace} are disabled.
@@ -1129,9 +1129,9 @@ end
 
 --- Display diagnostics for the given namespace and buffer.
 ---
----@param namespace number|nil Diagnostic namespace. When omitted, show
+---@param namespace integer|nil Diagnostic namespace. When omitted, show
 ---                            diagnostics from all namespaces.
----@param bufnr number|nil Buffer number, or 0 for current buffer. When omitted, show
+---@param bufnr integer|nil Buffer number, or 0 for current buffer. When omitted, show
 ---                        diagnostics in all buffers.
 ---@param diagnostics table|nil The diagnostics to display. When omitted, use the
 ---                             saved diagnostics for the given namespace and
@@ -1256,7 +1256,7 @@ end
 ---                      Overrides the setting from |vim.diagnostic.config()|.
 ---            - suffix: Same as {prefix}, but appends the text to the diagnostic instead of
 ---                      prepending it. Overrides the setting from |vim.diagnostic.config()|.
----@return number|nil, number|nil: ({float_bufnr}, {win_id})
+---@return integer|nil, integer|nil: ({float_bufnr}, {win_id})
 function M.open_float(opts, ...)
   -- Support old (bufnr, opts) signature
   local bufnr
@@ -1463,9 +1463,9 @@ end
 --- simply remove diagnostic decorations in a way that they can be
 --- re-displayed, use |vim.diagnostic.hide()|.
 ---
----@param namespace number|nil Diagnostic namespace. When omitted, remove
+---@param namespace integer|nil Diagnostic namespace. When omitted, remove
 ---                            diagnostics from all namespaces.
----@param bufnr number|nil Remove diagnostics for the given buffer. When omitted,
+---@param bufnr integer|nil Remove diagnostics for the given buffer. When omitted,
 ---             diagnostics are removed for all buffers.
 function M.reset(namespace, bufnr)
   vim.validate({
@@ -1518,9 +1518,9 @@ end
 
 --- Disable diagnostics in the given buffer.
 ---
----@param bufnr number|nil Buffer number, or 0 for current buffer. When
+---@param bufnr integer|nil Buffer number, or 0 for current buffer. When
 ---                        omitted, disable diagnostics in all buffers.
----@param namespace number|nil Only disable diagnostics for the given namespace.
+---@param namespace integer|nil Only disable diagnostics for the given namespace.
 function M.disable(bufnr, namespace)
   vim.validate({ bufnr = { bufnr, 'n', true }, namespace = { namespace, 'n', true } })
   if bufnr == nil then
@@ -1555,9 +1555,9 @@ end
 
 --- Enable diagnostics in the given buffer.
 ---
----@param bufnr number|nil Buffer number, or 0 for current buffer. When
+---@param bufnr integer|nil Buffer number, or 0 for current buffer. When
 ---                        omitted, enable diagnostics in all buffers.
----@param namespace number|nil Only enable diagnostics for the given namespace.
+---@param namespace integer|nil Only enable diagnostics for the given namespace.
 function M.enable(bufnr, namespace)
   vim.validate({ bufnr = { bufnr, 'n', true }, namespace = { namespace, 'n', true } })
   if bufnr == nil then
-- 
cgit 


From aa16590999a66798eca7d2ba09e971aacdeb54b4 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sat, 4 Mar 2023 22:07:39 +0900
Subject: docs(lua): number → integer (#22517)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 runtime/lua/vim/_editor.lua | 10 +++++-----
 runtime/lua/vim/shared.lua  | 10 +++++-----
 2 files changed, 10 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 3f27e61810..ab49e26dde 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -386,7 +386,7 @@ end
 
 --- Get a table of lines with start, end columns for a region marked by two points
 ---
----@param bufnr number of buffer
+---@param bufnr integer number of buffer
 ---@param pos1 integer[] (line, column) tuple marking beginning of region
 ---@param pos2 integer[] (line, column) tuple marking end of region
 ---@param regtype string type of selection, see |setreg()|
@@ -471,7 +471,7 @@ end
 --- writes to |:messages|.
 ---
 ---@param msg string Content of the notification to show to the user.
----@param level number|nil One of the values from |vim.log.levels|.
+---@param level integer|nil One of the values from |vim.log.levels|.
 ---@param opts table|nil Optional parameters. Unused by default.
 function vim.notify(msg, level, opts) -- luacheck: no unused args
   if level == vim.log.levels.ERROR then
@@ -492,7 +492,7 @@ do
   --- display a notification.
   ---
   ---@param msg string Content of the notification to show to the user.
-  ---@param level number|nil One of the values from |vim.log.levels|.
+  ---@param level integer|nil One of the values from |vim.log.levels|.
   ---@param opts table|nil Optional parameters. Unused by default.
   ---@return boolean true if message was displayed, else false
   function vim.notify_once(msg, level, opts)
@@ -521,10 +521,10 @@ local on_key_cbs = {}
 ---@param fn function: Callback function. It should take one string argument.
 ---                   On each key press, Nvim passes the key char to fn(). |i_CTRL-V|
 ---                   If {fn} is nil, it removes the callback for the associated {ns_id}
----@param ns_id number? Namespace ID. If nil or 0, generates and returns a new
+---@param ns_id integer? Namespace ID. If nil or 0, generates and returns a new
 ---                    |nvim_create_namespace()| id.
 ---
----@return number Namespace id associated with {fn}. Or count of all callbacks
+---@return integer Namespace id associated with {fn}. Or count of all callbacks
 ---if on_key() is called without arguments.
 ---
 ---@note {fn} will be removed if an error occurs while calling.
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index cc48e3f193..1c8defc93a 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -418,8 +418,8 @@ end
 ---@generic T: table
 ---@param dst T List which will be modified and appended to
 ---@param src table List from which values will be inserted
----@param start (number|nil) Start index on src. Defaults to 1
----@param finish (number|nil) Final index on src. Defaults to `#src`
+---@param start (integer|nil) Start index on src. Defaults to 1
+---@param finish (integer|nil) Final index on src. Defaults to `#src`
 ---@return T dst
 function vim.list_extend(dst, src, start, finish)
   vim.validate({
@@ -529,7 +529,7 @@ end
 ---
 ---@see https://github.com/Tieske/Penlight/blob/master/lua/pl/tablex.lua
 ---@param t table Table
----@return number Number of non-nil values in table
+---@return integer Number of non-nil values in table
 function vim.tbl_count(t)
   vim.validate({ t = { t, 't' } })
 
@@ -544,8 +544,8 @@ end
 ---
 ---@generic T
 ---@param list T[] (list) Table
----@param start number|nil Start range of slice
----@param finish number|nil End range of slice
+---@param start integer|nil Start range of slice
+---@param finish integer|nil End range of slice
 ---@return T[] (list) Copy of table sliced from start to finish (inclusive)
 function vim.list_slice(list, start, finish)
   local new_list = {}
-- 
cgit 


From 59542504b41dfddb6f26524fb4ce811e0f22a785 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sun, 5 Mar 2023 01:47:30 +0900
Subject: docs(highlight): fix type annotations (#22272)

---
 runtime/lua/vim/highlight.lua | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/highlight.lua b/runtime/lua/vim/highlight.lua
index 20ad48dd27..89eae0def5 100644
--- a/runtime/lua/vim/highlight.lua
+++ b/runtime/lua/vim/highlight.lua
@@ -36,12 +36,12 @@ end
 
 --- Highlight range between two positions
 ---
----@param bufnr number of buffer to apply highlighting to
----@param ns namespace to add highlight to
----@param higroup highlight group to use for highlighting
----@param start first position (tuple {line,col})
----@param finish second position (tuple {line,col})
----@param opts table with options:
+---@param bufnr integer Buffer number to apply highlighting to
+---@param ns integer Namespace to add highlight to
+---@param higroup string Highlight group to use for highlighting
+---@param start { [1]: integer, [2]: integer } Start position {line, col}
+---@param finish { [1]: integer, [2]: integer } Finish position {line, col}
+---@param opts table|nil Optional parameters
 --             - regtype type of range (see |setreg()|, default charwise)
 --             - inclusive boolean indicating whether the range is end-inclusive (default false)
 --             - priority number indicating priority of highlight (default priorities.user)
@@ -84,7 +84,7 @@ local yank_timer
 --- customize conditions (here: do not highlight a visual selection) via
 ---   au TextYankPost * lua vim.highlight.on_yank {on_visual=false}
 ---
--- @param opts table with options controlling the highlight:
+-- @param opts table|nil Optional parameters
 --              - higroup   highlight group for yanked region (default "IncSearch")
 --              - timeout   time in ms before highlight is cleared (default 150)
 --              - on_macro  highlight when executing macro (default false)
-- 
cgit 


From ac69ba5fa0081026f2c5e6e29d5788802479b7b9 Mon Sep 17 00:00:00 2001
From: Jon Huhn <nojnhuh@users.noreply.github.com>
Date: Sun, 5 Mar 2023 00:52:27 -0600
Subject: feat(lsp): implement workspace/didChangeWatchedFiles (#22405)

---
 runtime/lua/vim/_editor.lua         |   1 +
 runtime/lua/vim/_watch.lua          | 174 +++++++++++++++++++++
 runtime/lua/vim/lsp/_watchfiles.lua | 293 ++++++++++++++++++++++++++++++++++++
 runtime/lua/vim/lsp/handlers.lua    |  38 +++--
 runtime/lua/vim/lsp/protocol.lua    |   4 +
 5 files changed, 501 insertions(+), 9 deletions(-)
 create mode 100644 runtime/lua/vim/_watch.lua
 create mode 100644 runtime/lua/vim/lsp/_watchfiles.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index ab49e26dde..c205451ff9 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -37,6 +37,7 @@ for k, v in pairs({
   health = true,
   fs = true,
   secure = true,
+  _watch = true,
 }) do
   vim._submodules[k] = v
 end
diff --git a/runtime/lua/vim/_watch.lua b/runtime/lua/vim/_watch.lua
new file mode 100644
index 0000000000..dba1522ec8
--- /dev/null
+++ b/runtime/lua/vim/_watch.lua
@@ -0,0 +1,174 @@
+local M = {}
+
+--- Enumeration describing the types of events watchers will emit.
+M.FileChangeType = vim.tbl_add_reverse_lookup({
+  Created = 1,
+  Changed = 2,
+  Deleted = 3,
+})
+
+---@private
+--- Joins filepath elements by static '/' separator
+---
+---@param ... (string) The path elements.
+local function filepath_join(...)
+  return table.concat({ ... }, '/')
+end
+
+---@private
+--- Stops and closes a libuv |uv_fs_event_t| or |uv_fs_poll_t| handle
+---
+---@param handle (uv_fs_event_t|uv_fs_poll_t) The handle to stop
+local function stop(handle)
+  local _, stop_err = handle:stop()
+  assert(not stop_err, stop_err)
+  local is_closing, close_err = handle:is_closing()
+  assert(not close_err, close_err)
+  if not is_closing then
+    handle:close()
+  end
+end
+
+--- Initializes and starts a |uv_fs_event_t|
+---
+---@param path (string) The path to watch
+---@param opts (table|nil) Additional options
+---     - uvflags (table|nil)
+---                Same flags as accepted by |uv.fs_event_start()|
+---@param callback (function) The function called when new events
+---@returns (function) A function to stop the watch
+function M.watch(path, opts, callback)
+  vim.validate({
+    path = { path, 'string', false },
+    opts = { opts, 'table', true },
+    callback = { callback, 'function', false },
+  })
+
+  path = vim.fs.normalize(path)
+  local uvflags = opts and opts.uvflags or {}
+  local handle, new_err = vim.loop.new_fs_event()
+  assert(not new_err, new_err)
+  local _, start_err = handle:start(path, uvflags, function(err, filename, events)
+    assert(not err, err)
+    local fullpath = path
+    if filename then
+      filename = filename:gsub('\\', '/')
+      fullpath = filepath_join(fullpath, filename)
+    end
+    local change_type = events.change and M.FileChangeType.Changed or 0
+    if events.rename then
+      local _, staterr, staterrname = vim.loop.fs_stat(fullpath)
+      if staterrname == 'ENOENT' then
+        change_type = M.FileChangeType.Deleted
+      else
+        assert(not staterr, staterr)
+        change_type = M.FileChangeType.Created
+      end
+    end
+    callback(fullpath, change_type)
+  end)
+  assert(not start_err, start_err)
+  return function()
+    stop(handle)
+  end
+end
+
+local default_poll_interval_ms = 2000
+
+---@private
+--- Implementation for poll, hiding internally-used parameters.
+---
+---@param watches (table|nil) A tree structure to maintain state for recursive watches.
+---     - handle (uv_fs_poll_t)
+---               The libuv handle
+---     - cancel (function)
+---               A function that cancels the handle and all children's handles
+---     - is_dir (boolean)
+---               Indicates whether the path is a directory (and the poll should
+---               be invoked recursively)
+---     - children (table|nil)
+---               A mapping of directory entry name to its recursive watches
+local function poll_internal(path, opts, callback, watches)
+  path = vim.fs.normalize(path)
+  local interval = opts and opts.interval or default_poll_interval_ms
+  watches = watches or {
+    is_dir = true,
+  }
+
+  if not watches.handle then
+    local poll, new_err = vim.loop.new_fs_poll()
+    assert(not new_err, new_err)
+    watches.handle = poll
+    local _, start_err = poll:start(
+      path,
+      interval,
+      vim.schedule_wrap(function(err)
+        if err == 'ENOENT' then
+          return
+        end
+        assert(not err, err)
+        poll_internal(path, opts, callback, watches)
+        callback(path, M.FileChangeType.Changed)
+      end)
+    )
+    assert(not start_err, start_err)
+    callback(path, M.FileChangeType.Created)
+  end
+
+  watches.cancel = function()
+    if watches.children then
+      for _, w in pairs(watches.children) do
+        w.cancel()
+      end
+    end
+    stop(watches.handle)
+  end
+
+  if watches.is_dir then
+    watches.children = watches.children or {}
+    local exists = {}
+    for name, ftype in vim.fs.dir(path) do
+      exists[name] = true
+      if not watches.children[name] then
+        watches.children[name] = {
+          is_dir = ftype == 'directory',
+        }
+        poll_internal(filepath_join(path, name), opts, callback, watches.children[name])
+      end
+    end
+
+    local newchildren = {}
+    for name, watch in pairs(watches.children) do
+      if exists[name] then
+        newchildren[name] = watch
+      else
+        watch.cancel()
+        watches.children[name] = nil
+        callback(path .. '/' .. name, M.FileChangeType.Deleted)
+      end
+    end
+    watches.children = newchildren
+  end
+
+  return watches.cancel
+end
+
+--- Initializes and starts a |uv_fs_poll_t| recursively watching every file underneath the
+--- directory at path.
+---
+---@param path (string) The path to watch. Must refer to a directory.
+---@param opts (table|nil) Additional options
+---     - interval (number|nil)
+---                Polling interval in ms as passed to |uv.fs_poll_start()|. Defaults to 2000.
+---@param callback (function) The function called when new events
+---@returns (function) A function to stop the watch.
+function M.poll(path, opts, callback)
+  vim.validate({
+    path = { path, 'string', false },
+    opts = { opts, 'table', true },
+    callback = { callback, 'function', false },
+  })
+  return poll_internal(path, opts, callback, nil)
+end
+
+return M
diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
new file mode 100644
index 0000000000..96d7fa1d35
--- /dev/null
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -0,0 +1,293 @@
+local bit = require('bit')
+local watch = require('vim._watch')
+local protocol = require('vim.lsp.protocol')
+
+local M = {}
+
+---@private
+---Parses the raw pattern into a number of Lua-native patterns.
+---
+---@param pattern string The raw glob pattern
+---@return table A list of Lua patterns. A match with any of them matches the input glob pattern.
+local function parse(pattern)
+  local patterns = { '' }
+
+  local path_sep = '[/\\]'
+  local non_path_sep = '[^/\\]'
+
+  local function append(chunks)
+    local new_patterns = {}
+    for _, p in ipairs(patterns) do
+      for _, chunk in ipairs(chunks) do
+        table.insert(new_patterns, p .. chunk)
+      end
+    end
+    patterns = new_patterns
+  end
+
+  local function split(s, sep)
+    local segments = {}
+    local segment = ''
+    local in_braces = false
+    local in_brackets = false
+    for i = 1, #s do
+      local c = string.sub(s, i, i)
+      if c == sep and not in_braces and not in_brackets then
+        table.insert(segments, segment)
+        segment = ''
+      else
+        if c == '{' then
+          in_braces = true
+        elseif c == '}' then
+          in_braces = false
+        elseif c == '[' then
+          in_brackets = true
+        elseif c == ']' then
+          in_brackets = false
+        end
+        segment = segment .. c
+      end
+    end
+    if segment ~= '' then
+      table.insert(segments, segment)
+    end
+    return segments
+  end
+
+  local function escape(c)
+    if
+      c == '?'
+      or c == '.'
+      or c == '('
+      or c == ')'
+      or c == '%'
+      or c == '['
+      or c == ']'
+      or c == '*'
+      or c == '+'
+      or c == '-'
+    then
+      return '%' .. c
+    end
+    return c
+  end
+
+  local segments = split(pattern, '/')
+  for i, segment in ipairs(segments) do
+    local last_seg = i == #segments
+    if segment == '**' then
+      local chunks = {
+        path_sep .. '-',
+        '.-' .. path_sep,
+      }
+      if last_seg then
+        chunks = { '.-' }
+      end
+      append(chunks)
+    else
+      local in_braces = false
+      local brace_val = ''
+      local in_brackets = false
+      local bracket_val = ''
+      for j = 1, #segment do
+        local char = string.sub(segment, j, j)
+        if char ~= '}' and in_braces then
+          brace_val = brace_val .. char
+        else
+          if in_brackets and (char ~= ']' or bracket_val == '') then
+            local res
+            if char == '-' then
+              res = char
+            elseif bracket_val == '' and char == '!' then
+              res = '^'
+            elseif char == '/' then
+              res = ''
+            else
+              res = escape(char)
+            end
+            bracket_val = bracket_val .. res
+          else
+            if char == '{' then
+              in_braces = true
+            elseif char == '[' then
+              in_brackets = true
+            elseif char == '}' then
+              local choices = split(brace_val, ',')
+              local parsed_choices = {}
+              for _, choice in ipairs(choices) do
+                table.insert(parsed_choices, parse(choice))
+              end
+              append(vim.tbl_flatten(parsed_choices))
+              in_braces = false
+              brace_val = ''
+            elseif char == ']' then
+              append({ '[' .. bracket_val .. ']' })
+              in_brackets = false
+              bracket_val = ''
+            elseif char == '?' then
+              append({ non_path_sep })
+            elseif char == '*' then
+              append({ non_path_sep .. '-' })
+            else
+              append({ escape(char) })
+            end
+          end
+        end
+      end
+
+      if not last_seg and (segments[i + 1] ~= '**' or i + 1 < #segments) then
+        append({ path_sep })
+      end
+    end
+  end
+
+  return patterns
+end
+
+---@private
+--- Implementation of LSP 3.17.0's pattern matching: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#pattern
+--- Modeled after VSCode's implementation: https://github.com/microsoft/vscode/blob/0319eed971719ad48e9093daba9d65a5013ec5ab/src/vs/base/common/glob.ts#L509
+---
+---@param pattern string|table The glob pattern (raw or parsed) to match.
+---@param s string The string to match against pattern.
+---@return boolean Whether or not pattern matches s.
+function M._match(pattern, s)
+  if type(pattern) == 'string' then
+    pattern = parse(pattern)
+  end
+  -- Since Lua's built-in string pattern matching does not have an alternate
+  -- operator like '|', `parse` will construct one pattern for each possible
+  -- alternative. Any pattern that matches thus matches the glob.
+  for _, p in ipairs(pattern) do
+    if s:match('^' .. p .. '$') then
+      return true
+    end
+  end
+  return false
+end
+
+M._watchfunc = (vim.fn.has('win32') == 1 or vim.fn.has('mac') == 1) and watch.watch or watch.poll
+
+---@type table<number, table<number, function()>> client id -> registration id -> cancel function
+local cancels = vim.defaulttable()
+
+local queue_timeout_ms = 100
+---@type table<number, uv_timer_t> client id -> libuv timer which will send queued changes at its timeout
+local queue_timers = {}
+---@type table<number, lsp.FileEvent[]> client id -> set of queued changes to send in a single LSP notification
+local change_queues = {}
+---@type table<number, table<string, lsp.FileChangeType>> client id -> URI -> last type of change processed
+--- Used to prune consecutive events of the same type for the same file
+local change_cache = vim.defaulttable()
+
+local to_lsp_change_type = {
+  [watch.FileChangeType.Created] = protocol.FileChangeType.Created,
+  [watch.FileChangeType.Changed] = protocol.FileChangeType.Changed,
+  [watch.FileChangeType.Deleted] = protocol.FileChangeType.Deleted,
+}
+
+--- Registers the workspace/didChangeWatchedFiles capability dynamically.
+---
+---@param reg table LSP Registration object.
+---@param ctx table Context from the |lsp-handler|.
+function M.register(reg, ctx)
+  local client_id = ctx.client_id
+  local client = vim.lsp.get_client_by_id(client_id)
+  local watch_regs = {}
+  for _, w in ipairs(reg.registerOptions.watchers) do
+    local glob_patterns = {}
+    if type(w.globPattern) == 'string' then
+      for _, folder in ipairs(client.workspace_folders) do
+        table.insert(glob_patterns, { baseUri = folder.uri, pattern = w.globPattern })
+      end
+    else
+      table.insert(glob_patterns, w.globPattern)
+    end
+    for _, glob_pattern in ipairs(glob_patterns) do
+      local pattern = parse(glob_pattern.pattern)
+      local base_dir = nil
+      if type(glob_pattern.baseUri) == 'string' then
+        base_dir = glob_pattern.baseUri
+      elseif type(glob_pattern.baseUri) == 'table' then
+        base_dir = glob_pattern.baseUri.uri
+      end
+      assert(base_dir, "couldn't identify root of watch")
+      base_dir = vim.uri_to_fname(base_dir)
+      local kind = w.kind
+        or protocol.WatchKind.Create + protocol.WatchKind.Change + protocol.WatchKind.Delete
+
+      table.insert(watch_regs, {
+        base_dir = base_dir,
+        pattern = pattern,
+        kind = kind,
+      })
+    end
+  end
+
+  local callback = function(base_dir)
+    return function(fullpath, change_type)
+      for _, w in ipairs(watch_regs) do
+        change_type = to_lsp_change_type[change_type]
+        -- e.g. match kind with Delete bit (0b0100) to Delete change_type (3)
+        local kind_mask = bit.lshift(1, change_type - 1)
+        local change_type_match = bit.band(w.kind, kind_mask) == kind_mask
+        if base_dir == w.base_dir and M._match(w.pattern, fullpath) and change_type_match then
+          local change = {
+            uri = vim.uri_from_fname(fullpath),
+            type = change_type,
+          }
+
+          local last_type = change_cache[client_id][change.uri]
+          if last_type ~= change.type then
+            change_queues[client_id] = change_queues[client_id] or {}
+            table.insert(change_queues[client_id], change)
+            change_cache[client_id][change.uri] = change.type
+          end
+
+          if not queue_timers[client_id] then
+            queue_timers[client_id] = vim.defer_fn(function()
+              client.notify('workspace/didChangeWatchedFiles', {
+                changes = change_queues[client_id],
+              })
+              queue_timers[client_id] = nil
+              change_queues[client_id] = nil
+              change_cache[client_id] = nil
+            end, queue_timeout_ms)
+          end
+
+          break -- if an event matches multiple watchers, only send one notification
+        end
+      end
+    end
+  end
+
+  local watching = {}
+  for _, w in ipairs(watch_regs) do
+    if not watching[w.base_dir] then
+      watching[w.base_dir] = true
+      table.insert(
+        cancels[client_id][reg.id],
+        M._watchfunc(w.base_dir, { uvflags = { recursive = true } }, callback(w.base_dir))
+      )
+    end
+  end
+end
+
+--- Unregisters the workspace/didChangeWatchedFiles capability dynamically.
+---
+---@param unreg table LSP Unregistration object.
+---@param ctx table Context from the |lsp-handler|.
+function M.unregister(unreg, ctx)
+  local client_id = ctx.client_id
+  local client_cancels = cancels[client_id]
+  local reg_cancels = client_cancels[unreg.id]
+  while #reg_cancels > 0 do
+    table.remove(reg_cancels)()
+  end
+  client_cancels[unreg.id] = nil
+  if not next(cancels[client_id]) then
+    cancels[client_id] = nil
+  end
+end
+
+return M
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 5096100a60..ee5b63d260 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -117,15 +117,35 @@ M['window/showMessageRequest'] = function(_, result)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#client_registerCapability
-M['client/registerCapability'] = function(_, _, ctx)
-  local client_id = ctx.client_id
-  local warning_tpl = 'The language server %s triggers a registerCapability '
-    .. 'handler despite dynamicRegistration set to false. '
-    .. 'Report upstream, this warning is harmless'
-  local client = vim.lsp.get_client_by_id(client_id)
-  local client_name = client and client.name or string.format('id=%d', client_id)
-  local warning = string.format(warning_tpl, client_name)
-  log.warn(warning)
+M['client/registerCapability'] = function(_, result, ctx)
+  local log_unsupported = false
+  for _, reg in ipairs(result.registrations) do
+    if reg.method == 'workspace/didChangeWatchedFiles' then
+      require('vim.lsp._watchfiles').register(reg, ctx)
+    else
+      log_unsupported = true
+    end
+  end
+  if log_unsupported then
+    local client_id = ctx.client_id
+    local warning_tpl = 'The language server %s triggers a registerCapability '
+      .. 'handler despite dynamicRegistration set to false. '
+      .. 'Report upstream, this warning is harmless'
+    local client = vim.lsp.get_client_by_id(client_id)
+    local client_name = client and client.name or string.format('id=%d', client_id)
+    local warning = string.format(warning_tpl, client_name)
+    log.warn(warning)
+  end
+  return vim.NIL
+end
+
+--see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#client_unregisterCapability
+M['client/unregisterCapability'] = function(_, result, ctx)
+  for _, unreg in ipairs(result.unregisterations) do
+    if unreg.method == 'workspace/didChangeWatchedFiles' then
+      require('vim.lsp._watchfiles').unregister(unreg, ctx)
+    end
+  end
   return vim.NIL
 end
 
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 41dfc9e00e..27dd68645a 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -834,6 +834,10 @@ function protocol.make_client_capabilities()
       semanticTokens = {
         refreshSupport = true,
       },
+      didChangeWatchedFiles = {
+        dynamicRegistration = false,
+        relativePatternSupport = true,
+      },
     },
     experimental = nil,
     window = {
-- 
cgit 


From ed05d38d9fa643c7e562b754c6cfed8b9da5c4d8 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sun, 5 Mar 2023 08:42:15 +0100
Subject: fix(lsp): don't monitor files if workspace_folders is nil (#22531)

Fixes:

    Error SERVER_REQUEST_HANDLER_ERROR: "...di/dev/neovim/neovim/runtime/lua/vim/lsp/_watchfiles.lua
    :200: bad argument #1 to 'ipairs' (table expected, got nil)"

Language servers can be started without root_dir or workspace_folders.
---
 runtime/lua/vim/lsp/_watchfiles.lua | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
index 96d7fa1d35..533a955925 100644
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -168,11 +168,11 @@ end
 
 M._watchfunc = (vim.fn.has('win32') == 1 or vim.fn.has('mac') == 1) and watch.watch or watch.poll
 
----@type table<number, table<number, function()>> client id -> registration id -> cancel function
+---@type table<number, table<number, function[]>> client id -> registration id -> cancel function
 local cancels = vim.defaulttable()
 
 local queue_timeout_ms = 100
----@type table<number, uv_timer_t> client id -> libuv timer which will send queued changes at its timeout
+---@type table<number, uv.uv_timer_t> client id -> libuv timer which will send queued changes at its timeout
 local queue_timers = {}
 ---@type table<number, lsp.FileEvent[]> client id -> set of queued changes to send in a single LSP notification
 local change_queues = {}
@@ -193,6 +193,9 @@ local to_lsp_change_type = {
 function M.register(reg, ctx)
   local client_id = ctx.client_id
   local client = vim.lsp.get_client_by_id(client_id)
+  if not client.workspace_folders then
+    return
+  end
   local watch_regs = {}
   for _, w in ipairs(reg.registerOptions.watchers) do
     local glob_patterns = {}
-- 
cgit 


From 533d671271eb76373d9940161e7bfd201b7e7c2b Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Sun, 5 Mar 2023 18:15:29 -0500
Subject: docs: module-level docstrings (@defgroup) #22498

Problem:
gen_vimdoc.py / lua2dox.lua does not support @defgroup or \defgroup
except for "api-foo" modules.

Solution:
Modify `gen_vimdoc.py` to look for section names based on `helptag_fmt`.

TODO:
- Support @module ?
  https://github.com/LuaLS/lua-language-server/wiki/Annotations#module
---
 runtime/lua/vim/treesitter/languagetree.lua | 34 +++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 1bc7971eba..b8b0dd867e 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -1,3 +1,37 @@
+--- @defgroup lua-treesitter-languagetree
+---
+--- @brief A \*LanguageTree\* contains a tree of parsers: the root treesitter parser for {lang} and
+--- any "injected" language parsers, which themselves may inject other languages, recursively.
+--- For example a Lua buffer containing some Vimscript commands needs multiple parsers to fully
+--- understand its contents.
+---
+--- To create a LanguageTree (parser object) for a given buffer and language, use:
+---
+--- <pre>lua
+---     local parser = vim.treesitter.get_parser(bufnr, lang)
+--- </pre>
+---
+--- (where `bufnr=0` means current buffer). `lang` defaults to 'filetype'.
+--- Note: currently the parser is retained for the lifetime of a buffer but this may change;
+--- a plugin should keep a reference to the parser object if it wants incremental updates.
+---
+--- Whenever you need to access the current syntax tree, parse the buffer:
+---
+--- <pre>lua
+---     local tree = parser:parse()
+--- </pre>
+---
+--- This returns a table of immutable |treesitter-tree| objects representing the current state of
+--- the buffer. When the plugin wants to access the state after a (possible) edit it must call
+--- `parse()` again. If the buffer wasn't edited, the same tree will be returned again without extra
+--- work. If the buffer was parsed before, incremental parsing will be done of the changed parts.
+---
+--- Note: To use the parser directly inside a |nvim_buf_attach()| Lua callback, you must call
+--- |vim.treesitter.get_parser()| before you register your callback. But preferably parsing
+--- shouldn't be done directly in the change callback anyway as they will be very frequent. Rather
+--- a plugin that does any kind of analysis on a tree should use a timer to throttle too frequent
+--- updates.
+
 local a = vim.api
 local query = require('vim.treesitter.query')
 local language = require('vim.treesitter.language')
-- 
cgit 


From f9a46391ab5961fe6c6b7d1efdc96befdd495c11 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 6 Mar 2023 10:57:14 +0000
Subject: refactor(treesitter): simplify some range functions

---
 runtime/lua/vim/treesitter.lua        | 26 +++++++-------------------
 runtime/lua/vim/treesitter/_range.lua | 20 ++++++++++++++++++++
 2 files changed, 27 insertions(+), 19 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index ee66ba9f9b..d13824076e 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -2,6 +2,7 @@ local a = vim.api
 local query = require('vim.treesitter.query')
 local language = require('vim.treesitter.language')
 local LanguageTree = require('vim.treesitter.languagetree')
+local Range = require('vim.treesitter._range')
 
 ---@type table<integer,LanguageTree>
 local parsers = setmetatable({}, { __mode = 'v' })
@@ -190,20 +191,7 @@ end
 ---
 ---@return boolean True if the position is in node range
 function M.is_in_node_range(node, line, col)
-  local start_line, start_col, end_line, end_col = M.get_node_range(node)
-  if line >= start_line and line <= end_line then
-    if line == start_line and line == end_line then
-      return col >= start_col and col < end_col
-    elseif line == start_line then
-      return col >= start_col
-    elseif line == end_line then
-      return col < end_col
-    else
-      return true
-    end
-  else
-    return false
-  end
+  return M.node_contains(node, { line, col, line, col })
 end
 
 --- Determines if a node contains a range
@@ -213,11 +201,11 @@ end
 ---
 ---@return boolean True if the {node} contains the {range}
 function M.node_contains(node, range)
-  local start_row, start_col, end_row, end_col = node:range()
-  local start_fits = start_row < range[1] or (start_row == range[1] and start_col <= range[2])
-  local end_fits = end_row > range[3] or (end_row == range[3] and end_col >= range[4])
-
-  return start_fits and end_fits
+  vim.validate({
+    node = { node, 'userdata' },
+    range = { range, Range.validate, 'integer list with 4 or 6 elements' },
+  })
+  return Range.contains({ node:range() }, range)
 end
 
 --- Returns a list of highlight captures at the given position
diff --git a/runtime/lua/vim/treesitter/_range.lua b/runtime/lua/vim/treesitter/_range.lua
index 8decd3a1fd..bec24a23a5 100644
--- a/runtime/lua/vim/treesitter/_range.lua
+++ b/runtime/lua/vim/treesitter/_range.lua
@@ -53,6 +53,26 @@ M.cmp_pos = {
 
 setmetatable(M.cmp_pos, { __call = cmp_pos })
 
+---@private
+---Check if a variable is a valid range object
+---@param r any
+---@return boolean
+function M.validate(r)
+  if type(r) ~= 'table' or #r ~= 6 and #r ~= 4 then
+    return false
+  end
+
+  for _, e in
+    ipairs(r --[[@as any[] ]])
+  do
+    if type(e) ~= 'number' then
+      return false
+    end
+  end
+
+  return true
+end
+
 ---@private
 ---@param r1 Range4|Range6
 ---@param r2 Range4|Range6
-- 
cgit 


From 0e7196438d8f856eecd7c90e160b79cbc8fb08dc Mon Sep 17 00:00:00 2001
From: Kelly Lin <findkellylin@gmail.com>
Date: Sun, 19 Feb 2023 22:33:57 +1100
Subject: feat(lua): add semver api

---
 runtime/lua/vim/_init_packages.lua |   3 +
 runtime/lua/vim/version.lua        | 297 +++++++++++++++++++++++++++++++++++++
 2 files changed, 300 insertions(+)
 create mode 100644 runtime/lua/vim/version.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_init_packages.lua b/runtime/lua/vim/_init_packages.lua
index e3a442af5e..d032026796 100644
--- a/runtime/lua/vim/_init_packages.lua
+++ b/runtime/lua/vim/_init_packages.lua
@@ -69,6 +69,9 @@ setmetatable(vim, {
         t[key] = val
         return t[key]
       end
+    elseif key == 'version' then
+      t[key] = require('vim.version')
+      return t[key]
     end
   end,
 })
diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
new file mode 100644
index 0000000000..49ef019295
--- /dev/null
+++ b/runtime/lua/vim/version.lua
@@ -0,0 +1,297 @@
+local M = {}
+
+---@private
+--- Compares the prerelease component of the two versions.
+---@param v1_parsed table Parsed version.
+---@param v2_parsed table Parsed version.
+---@return integer `-1` if `v1_parsed < v2_parsed`, `0` if `v1_parsed == v2_parsed`, `1` if `v1_parsed > v2_parsed`.
+local function cmp_prerelease(v1_parsed, v2_parsed)
+  if v1_parsed.prerelease and not v2_parsed.prerelease then
+    return -1
+  end
+  if not v1_parsed.prerelease and v2_parsed.prerelease then
+    return 1
+  end
+  if not v1_parsed.prerelease and not v2_parsed.prerelease then
+    return 0
+  end
+
+  local v1_identifiers = vim.split(v1_parsed.prerelease, '.', { plain = true })
+  local v2_identifiers = vim.split(v2_parsed.prerelease, '.', { plain = true })
+  local i = 1
+  local max = math.max(vim.tbl_count(v1_identifiers), vim.tbl_count(v2_identifiers))
+  while i <= max do
+    local v1_identifier = v1_identifiers[i]
+    local v2_identifier = v2_identifiers[i]
+    if v1_identifier ~= v2_identifier then
+      local v1_num = tonumber(v1_identifier)
+      local v2_num = tonumber(v2_identifier)
+      local is_number = v1_num and v2_num
+      if is_number then
+        -- Number comparisons
+        if not v1_num and v2_num then
+          return -1
+        end
+        if v1_num and not v2_num then
+          return 1
+        end
+        if v1_num == v2_num then
+          return 0
+        end
+        if v1_num > v2_num then
+          return 1
+        end
+        if v1_num < v2_num then
+          return -1
+        end
+      else
+        -- String comparisons
+        if v1_identifier and not v2_identifier then
+          return 1
+        end
+        if not v1_identifier and v2_identifier then
+          return -1
+        end
+        if v1_identifier < v2_identifier then
+          return -1
+        end
+        if v1_identifier > v2_identifier then
+          return 1
+        end
+        if v1_identifier == v2_identifier then
+          return 0
+        end
+      end
+    end
+    i = i + 1
+  end
+
+  return 0
+end
+
+---@private
+--- Compares the version core component of the two versions.
+---@param v1_parsed table Parsed version.
+---@param v2_parsed table Parsed version.
+---@return integer `-1` if `v1_parsed < v2_parsed`, `0` if `v1_parsed == v2_parsed`, `1` if `v1_parsed > v2_parsed`.
+local function cmp_version_core(v1_parsed, v2_parsed)
+  if
+    v1_parsed.major == v2_parsed.major
+    and v1_parsed.minor == v2_parsed.minor
+    and v1_parsed.patch == v2_parsed.patch
+  then
+    return 0
+  end
+
+  if
+    v1_parsed.major > v2_parsed.major
+    or v1_parsed.minor > v2_parsed.minor
+    or v1_parsed.patch > v2_parsed.patch
+  then
+    return 1
+  end
+
+  return -1
+end
+
+--- Compares two strings (`v1` and `v2`) in semver format.
+---@param v1 string Version.
+---@param v2 string Version to be compared with v1.
+---@param opts table|nil Optional keyword arguments:
+---                      - strict (boolean):  see `semver.parse` for details. Defaults to false.
+---@return integer `-1` if `v1 < v2`, `0` if `v1 == v2`, `1` if `v1 > v2`.
+function M.cmp(v1, v2, opts)
+  opts = opts or { strict = false }
+  local v1_parsed = M.parse(v1, opts)
+  local v2_parsed = M.parse(v2, opts)
+
+  local result = cmp_version_core(v1_parsed, v2_parsed)
+  if result == 0 then
+    result = cmp_prerelease(v1_parsed, v2_parsed)
+  end
+  return result
+end
+
+---@private
+---@param labels string Prerelease and build component of semantic version string e.g. "-rc1+build.0".
+---@return string|nil
+local function parse_prerelease(labels)
+  -- This pattern matches "-(alpha)+build.15".
+  -- '^%-[%w%.]+$'
+  local result = labels:match('^%-([%w%.]+)+.+$')
+  if result then
+    return result
+  end
+  -- This pattern matches "-(alpha)".
+  result = labels:match('^%-([%w%.]+)')
+  if result then
+    return result
+  end
+
+  return nil
+end
+
+---@private
+---@param labels string Prerelease and build component of semantic version string e.g. "-rc1+build.0".
+---@return string|nil
+local function parse_build(labels)
+  -- Pattern matches "-alpha+(build.15)".
+  local result = labels:match('^%-[%w%.]+%+([%w%.]+)$')
+  if result then
+    return result
+  end
+
+  -- Pattern matches "+(build.15)".
+  result = labels:match('^%+([%w%.]+)$')
+  if result then
+    return result
+  end
+
+  return nil
+end
+
+---@private
+--- Extracts the major, minor, patch and preprelease and build components from
+--- `version`.
+---@param version string Version string
+local function extract_components_strict(version)
+  local major, minor, patch, prerelease_and_build = version:match('^v?(%d+)%.(%d+)%.(%d+)(.*)$')
+  return tonumber(major), tonumber(minor), tonumber(patch), prerelease_and_build
+end
+
+---@private
+--- Extracts the major, minor, patch and preprelease and build components from
+--- `version`. When `minor` and `patch` components are not found (nil), coerce
+--- them to 0.
+---@param version string Version string
+local function extract_components_loose(version)
+  local major, minor, patch, prerelease_and_build = version:match('^v?(%d+)%.?(%d*)%.?(%d*)(.*)$')
+  major = tonumber(major)
+  minor = tonumber(minor) or 0
+  patch = tonumber(patch) or 0
+  return major, minor, patch, prerelease_and_build
+end
+
+---@private
+--- Validates the prerelease and build string e.g. "-rc1+build.0". If the
+--- prerelease, build or both are valid forms then it will return true, if it
+--- is not of any valid form, it will return false.
+---@param prerelease_and_build string
+---@return boolean
+local function is_prerelease_and_build_valid(prerelease_and_build)
+  if prerelease_and_build == '' then
+    return true
+  end
+  local has_build = parse_build(prerelease_and_build) ~= nil
+  local has_prerelease = parse_prerelease(prerelease_and_build) ~= nil
+  local has_prerelease_and_build = has_prerelease and has_build
+  return has_build or has_prerelease or has_prerelease_and_build
+end
+
+---@private
+---@param version string
+---@return string
+local function create_err_msg(version)
+  return string.format('invalid version: "%s"', version)
+end
+
+--- Parses a semantically formatted version string into a table.
+---
+--- Supports leading "v" and leading and trailing whitespace in the version
+--- string. e.g. `" v1.0.1-rc1+build.2"` , `"1.0.1-rc1+build.2"`, `"v1.0.1-rc1+build.2"`
+--- and `"v1.0.1-rc1+build.2 "` will be parsed as:
+---
+--- `{ major = 1, minor = 0, patch = 1, prerelease = 'rc1', build = 'build.2' }`
+---
+---@param version string Version string to be parsed.
+---@param opts table|nil Optional keyword arguments:
+---                      - strict (boolean):  when set to `true` an error will be thrown for version
+---                      strings that do not conform to the semver specification (v2.0.0) (see
+---                      semver.org/spec/v2.0.0.html for details). This means that
+---                      `semver.parse('v1.2)` will throw an error. When set to `false`,
+---                      `semver.parse('v1.2)` will coerce 'v1.2' to 'v1.2.0' and return the table:
+---                      `{ major = 1, minor = 2, patch = 0 }`. Defaults to false.
+---@return table|nil parsed_version Parsed version table or `nil` if `version` is not valid.
+function M.parse(version, opts)
+  if type(version) ~= 'string' then
+    error(create_err_msg(version))
+  end
+
+  opts = opts or { strict = false }
+
+  version = vim.trim(version)
+
+  local extract_components = opts.strict and extract_components_strict or extract_components_loose
+  local major, minor, patch, prerelease_and_build = extract_components(version)
+
+  -- If major is nil then that means that the version does not begin with a
+  -- digit with or without a "v" prefix.
+  if major == nil or not is_prerelease_and_build_valid(prerelease_and_build) then
+    return nil
+  end
+
+  local prerelease = nil
+  local build = nil
+  if prerelease_and_build ~= nil then
+    prerelease = parse_prerelease(prerelease_and_build)
+    build = parse_build(prerelease_and_build)
+  end
+
+  return {
+    major = major,
+    minor = minor,
+    patch = patch,
+    prerelease = prerelease,
+    build = build,
+  }
+end
+
+---@private
+--- Throws an error if `version` cannot be parsed.
+---@param version string
+local function assert_version(version)
+  if M.parse(version) == nil then
+    error(create_err_msg(version))
+  end
+end
+
+---Returns `true` if `v1` are `v2` are equal versions.
+---@param version_1 string
+---@param version_2 string
+---@return boolean
+function M.eq(version_1, version_2)
+  assert_version(version_1)
+  assert_version(version_2)
+
+  return M.cmp(version_1, version_2) == 0
+end
+
+---Returns `true` if `v1` is less than `v2`.
+---@param version_1 string
+---@param version_2 string
+---@return boolean
+function M.lt(version_1, version_2)
+  assert_version(version_1)
+  assert_version(version_2)
+
+  return M.cmp(version_1, version_2) == -1
+end
+
+---Returns `true` if `v1` is greater than `v2`.
+---@param version_1 string
+---@param version_2 string
+---@return boolean
+function M.gt(version_1, version_2)
+  assert_version(version_1)
+  assert_version(version_2)
+
+  return M.cmp(version_1, version_2) == 1
+end
+
+setmetatable(M, {
+  __call = function()
+    return vim.fn.api_info().version
+  end,
+})
+
+return M
-- 
cgit 


From e31e49a8e3aac25e923dce15cc76dca4a447947f Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Mon, 6 Mar 2023 13:23:03 +0100
Subject: refactor(vim.version): cleanup

- version.cmp(): assert valid version
- add test for loading vim.version (the other tests use shared.lua in
  the test runner)
- reduce test scopes, reword test descriptions
---
 runtime/lua/vim/_init_packages.lua |   8 +--
 runtime/lua/vim/version.lua        | 134 ++++++++++++++++---------------------
 2 files changed, 62 insertions(+), 80 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_init_packages.lua b/runtime/lua/vim/_init_packages.lua
index d032026796..57c0fc9122 100644
--- a/runtime/lua/vim/_init_packages.lua
+++ b/runtime/lua/vim/_init_packages.lua
@@ -51,7 +51,10 @@ end
 -- builtin functions which always should be available
 require('vim.shared')
 
-vim._submodules = { inspect = true }
+vim._submodules = {
+  inspect = true,
+  version = true,
+}
 
 -- These are for loading runtime modules in the vim namespace lazily.
 setmetatable(vim, {
@@ -69,9 +72,6 @@ setmetatable(vim, {
         t[key] = val
         return t[key]
       end
-    elseif key == 'version' then
-      t[key] = require('vim.version')
-      return t[key]
     end
   end,
 })
diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index 49ef019295..ddbe228244 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -1,23 +1,41 @@
 local M = {}
 
+---@private
+---@param version string
+---@return string
+local function create_err_msg(version)
+  return string.format('invalid version: "%s"', version)
+end
+
+---@private
+--- Throws an error if `version` cannot be parsed.
+---@param version string
+local function assert_version(version, opt)
+  local rv = M.parse(version, opt)
+  if rv == nil then
+    error(create_err_msg(version))
+  end
+  return rv
+end
+
 ---@private
 --- Compares the prerelease component of the two versions.
----@param v1_parsed table Parsed version.
----@param v2_parsed table Parsed version.
----@return integer `-1` if `v1_parsed < v2_parsed`, `0` if `v1_parsed == v2_parsed`, `1` if `v1_parsed > v2_parsed`.
-local function cmp_prerelease(v1_parsed, v2_parsed)
-  if v1_parsed.prerelease and not v2_parsed.prerelease then
+---@param v1 table Parsed version.
+---@param v2 table Parsed version.
+---@return integer `-1` if `v1 < v2`, `0` if `v1 == v2`, `1` if `v1 > v2`.
+local function cmp_prerelease(v1, v2)
+  if v1.prerelease and not v2.prerelease then
     return -1
   end
-  if not v1_parsed.prerelease and v2_parsed.prerelease then
+  if not v1.prerelease and v2.prerelease then
     return 1
   end
-  if not v1_parsed.prerelease and not v2_parsed.prerelease then
+  if not v1.prerelease and not v2.prerelease then
     return 0
   end
 
-  local v1_identifiers = vim.split(v1_parsed.prerelease, '.', { plain = true })
-  local v2_identifiers = vim.split(v2_parsed.prerelease, '.', { plain = true })
+  local v1_identifiers = vim.split(v1.prerelease, '.', { plain = true })
+  local v2_identifiers = vim.split(v2.prerelease, '.', { plain = true })
   local i = 1
   local max = math.max(vim.tbl_count(v1_identifiers), vim.tbl_count(v2_identifiers))
   while i <= max do
@@ -71,23 +89,15 @@ end
 
 ---@private
 --- Compares the version core component of the two versions.
----@param v1_parsed table Parsed version.
----@param v2_parsed table Parsed version.
----@return integer `-1` if `v1_parsed < v2_parsed`, `0` if `v1_parsed == v2_parsed`, `1` if `v1_parsed > v2_parsed`.
-local function cmp_version_core(v1_parsed, v2_parsed)
-  if
-    v1_parsed.major == v2_parsed.major
-    and v1_parsed.minor == v2_parsed.minor
-    and v1_parsed.patch == v2_parsed.patch
-  then
+---@param v1 table Parsed version.
+---@param v2 table Parsed version.
+---@return integer `-1` if `v1 < v2`, `0` if `v1 == v2`, `1` if `v1 > v2`.
+local function cmp_version_core(v1, v2)
+  if v1.major == v2.major and v1.minor == v2.minor and v1.patch == v2.patch then
     return 0
   end
 
-  if
-    v1_parsed.major > v2_parsed.major
-    or v1_parsed.minor > v2_parsed.minor
-    or v1_parsed.patch > v2_parsed.patch
-  then
+  if v1.major > v2.major or v1.minor > v2.minor or v1.patch > v2.patch then
     return 1
   end
 
@@ -96,14 +106,14 @@ end
 
 --- Compares two strings (`v1` and `v2`) in semver format.
 ---@param v1 string Version.
----@param v2 string Version to be compared with v1.
+---@param v2 string Version to compare with v1.
 ---@param opts table|nil Optional keyword arguments:
 ---                      - strict (boolean):  see `semver.parse` for details. Defaults to false.
 ---@return integer `-1` if `v1 < v2`, `0` if `v1 == v2`, `1` if `v1 > v2`.
 function M.cmp(v1, v2, opts)
   opts = opts or { strict = false }
-  local v1_parsed = M.parse(v1, opts)
-  local v2_parsed = M.parse(v2, opts)
+  local v1_parsed = assert_version(v1, opts)
+  local v2_parsed = assert_version(v2, opts)
 
   local result = cmp_version_core(v1_parsed, v2_parsed)
   if result == 0 then
@@ -188,30 +198,20 @@ local function is_prerelease_and_build_valid(prerelease_and_build)
   return has_build or has_prerelease or has_prerelease_and_build
 end
 
----@private
----@param version string
----@return string
-local function create_err_msg(version)
-  return string.format('invalid version: "%s"', version)
-end
-
---- Parses a semantically formatted version string into a table.
----
---- Supports leading "v" and leading and trailing whitespace in the version
---- string. e.g. `" v1.0.1-rc1+build.2"` , `"1.0.1-rc1+build.2"`, `"v1.0.1-rc1+build.2"`
---- and `"v1.0.1-rc1+build.2 "` will be parsed as:
+--- Parses a semantic version string.
 ---
---- `{ major = 1, minor = 0, patch = 1, prerelease = 'rc1', build = 'build.2' }`
+--- Ignores leading "v" and surrounding whitespace, e.g. " v1.0.1-rc1+build.2",
+--- "1.0.1-rc1+build.2", "v1.0.1-rc1+build.2" and "v1.0.1-rc1+build.2 " are all parsed as:
+--- <pre>
+---   { major = 1, minor = 0, patch = 1, prerelease = "rc1", build = "build.2" }
+--- </pre>
 ---
 ---@param version string Version string to be parsed.
 ---@param opts table|nil Optional keyword arguments:
----                      - strict (boolean):  when set to `true` an error will be thrown for version
----                      strings that do not conform to the semver specification (v2.0.0) (see
----                      semver.org/spec/v2.0.0.html for details). This means that
----                      `semver.parse('v1.2)` will throw an error. When set to `false`,
----                      `semver.parse('v1.2)` will coerce 'v1.2' to 'v1.2.0' and return the table:
----                      `{ major = 1, minor = 2, patch = 0 }`. Defaults to false.
----@return table|nil parsed_version Parsed version table or `nil` if `version` is not valid.
+---                      - strict (boolean):  Default false. If `true`, no coercion is attempted on
+---                      input not strictly conforming to semver v2.0.0
+---                      (https://semver.org/spec/v2.0.0.html). E.g. `parse("v1.2")` returns nil.
+---@return table|nil parsed_version Parsed version table or `nil` if `version` is invalid.
 function M.parse(version, opts)
   if type(version) ~= 'string' then
     error(create_err_msg(version))
@@ -246,46 +246,28 @@ function M.parse(version, opts)
   }
 end
 
----@private
---- Throws an error if `version` cannot be parsed.
----@param version string
-local function assert_version(version)
-  if M.parse(version) == nil then
-    error(create_err_msg(version))
-  end
-end
-
 ---Returns `true` if `v1` are `v2` are equal versions.
----@param version_1 string
----@param version_2 string
+---@param v1 string
+---@param v2 string
 ---@return boolean
-function M.eq(version_1, version_2)
-  assert_version(version_1)
-  assert_version(version_2)
-
-  return M.cmp(version_1, version_2) == 0
+function M.eq(v1, v2)
+  return M.cmp(v1, v2) == 0
 end
 
 ---Returns `true` if `v1` is less than `v2`.
----@param version_1 string
----@param version_2 string
+---@param v1 string
+---@param v2 string
 ---@return boolean
-function M.lt(version_1, version_2)
-  assert_version(version_1)
-  assert_version(version_2)
-
-  return M.cmp(version_1, version_2) == -1
+function M.lt(v1, v2)
+  return M.cmp(v1, v2) == -1
 end
 
 ---Returns `true` if `v1` is greater than `v2`.
----@param version_1 string
----@param version_2 string
+---@param v1 string
+---@param v2 string
 ---@return boolean
-function M.gt(version_1, version_2)
-  assert_version(version_1)
-  assert_version(version_2)
-
-  return M.cmp(version_1, version_2) == 1
+function M.gt(v1, v2)
+  return M.cmp(v1, v2) == 1
 end
 
 setmetatable(M, {
-- 
cgit 


From 74ffebf8ec725a25c2ae1dde81cf26b83fc7ae61 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Mon, 6 Mar 2023 15:08:22 +0100
Subject: fix(vim.version): incorrect version.cmp()

Problem:
If major<major but minor>minor, cmp_version_core returns 1

Solution:
- Fix logic in cmp_version_core
- Delete most eq()/gt()/lt() tests, they are redundant.
---
 runtime/lua/vim/version.lua | 22 ++++++++++------------
 1 file changed, 10 insertions(+), 12 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index ddbe228244..35629c461f 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -3,8 +3,11 @@ local M = {}
 ---@private
 ---@param version string
 ---@return string
-local function create_err_msg(version)
-  return string.format('invalid version: "%s"', version)
+local function create_err_msg(v)
+  if type(v) == 'string' then
+    return string.format('invalid version: "%s"', tostring(v))
+  end
+  return string.format('invalid version: %s (%s)', tostring(v), type(v))
 end
 
 ---@private
@@ -20,9 +23,6 @@ end
 
 ---@private
 --- Compares the prerelease component of the two versions.
----@param v1 table Parsed version.
----@param v2 table Parsed version.
----@return integer `-1` if `v1 < v2`, `0` if `v1 == v2`, `1` if `v1 > v2`.
 local function cmp_prerelease(v1, v2)
   if v1.prerelease and not v2.prerelease then
     return -1
@@ -88,19 +88,17 @@ local function cmp_prerelease(v1, v2)
 end
 
 ---@private
---- Compares the version core component of the two versions.
----@param v1 table Parsed version.
----@param v2 table Parsed version.
----@return integer `-1` if `v1 < v2`, `0` if `v1 == v2`, `1` if `v1 > v2`.
 local function cmp_version_core(v1, v2)
   if v1.major == v2.major and v1.minor == v2.minor and v1.patch == v2.patch then
     return 0
   end
-
-  if v1.major > v2.major or v1.minor > v2.minor or v1.patch > v2.patch then
+  if
+    v1.major > v2.major
+    or (v1.major == v2.major and v1.minor > v2.minor)
+    or (v1.major == v2.major and v1.minor == v2.minor and v1.patch > v2.patch)
+  then
     return 1
   end
-
   return -1
 end
 
-- 
cgit 


From 1cc23e1109ed88275df5c986c352f73b99a0301c Mon Sep 17 00:00:00 2001
From: swarn <swarn@users.noreply.github.com>
Date: Mon, 6 Mar 2023 12:03:13 -0600
Subject: feat(lsp)!: add rule-based sem token highlighting (#22022)

feat(lsp)!: change semantic token highlighting

Change the default highlights used, and add more highlights per token.

Add an LspTokenUpdate event and a highlight_token function.

:Inspect now shows any highlights applied by token highlighting rules,
default or user-defined.

BREAKING CHANGE: change the default highlight groups used by semantic
token highlighting.
---
 runtime/lua/vim/_inspector.lua          |  97 +++++++++--------
 runtime/lua/vim/lsp/semantic_tokens.lua | 183 ++++++++++++++++++++++----------
 2 files changed, 178 insertions(+), 102 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_inspector.lua b/runtime/lua/vim/_inspector.lua
index 9e91597192..92d380b08c 100644
--- a/runtime/lua/vim/_inspector.lua
+++ b/runtime/lua/vim/_inspector.lua
@@ -2,7 +2,7 @@
 ---@field syntax boolean include syntax based highlight groups (defaults to true)
 ---@field treesitter boolean include treesitter based highlight groups (defaults to true)
 ---@field extmarks boolean|"all" include extmarks. When `all`, then extmarks without a `hl_group` will also be included (defaults to true)
----@field semantic_tokens boolean include semantic tokens (defaults to true)
+---@field semantic_tokens boolean include semantic token highlights (defaults to true)
 local defaults = {
   syntax = true,
   treesitter = true,
@@ -81,47 +81,54 @@ function vim.inspect_pos(bufnr, row, col, filter)
     end
   end
 
-  -- semantic tokens
-  if filter.semantic_tokens then
-    for _, token in ipairs(vim.lsp.semantic_tokens.get_at_pos(bufnr, row, col) or {}) do
-      token.hl_groups = {
-        type = resolve_hl({ hl_group = '@' .. token.type }),
-        modifiers = vim.tbl_map(function(modifier)
-          return resolve_hl({ hl_group = '@' .. modifier })
-        end, token.modifiers or {}),
-      }
-      table.insert(results.semantic_tokens, token)
+  --- Convert an extmark tuple into a map-like table
+  --- @private
+  local function to_map(extmark)
+    extmark = {
+      id = extmark[1],
+      row = extmark[2],
+      col = extmark[3],
+      opts = resolve_hl(extmark[4]),
+    }
+    extmark.end_row = extmark.opts.end_row or extmark.row -- inclusive
+    extmark.end_col = extmark.opts.end_col or (extmark.col + 1) -- exclusive
+    return extmark
+  end
+
+  --- Check if an extmark overlaps this position
+  --- @private
+  local function is_here(extmark)
+    return (row >= extmark.row and row <= extmark.end_row) -- within the rows of the extmark
+      and (row > extmark.row or col >= extmark.col) -- either not the first row, or in range of the col
+      and (row < extmark.end_row or col < extmark.end_col) -- either not in the last row or in range of the col
+  end
+
+  -- all extmarks at this position
+  local extmarks = {}
+  for ns, nsid in pairs(vim.api.nvim_get_namespaces()) do
+    local ns_marks = vim.api.nvim_buf_get_extmarks(bufnr, nsid, 0, -1, { details = true })
+    ns_marks = vim.tbl_map(to_map, ns_marks)
+    ns_marks = vim.tbl_filter(is_here, ns_marks)
+    for _, mark in ipairs(ns_marks) do
+      mark.ns_id = nsid
+      mark.ns = ns
     end
+    vim.list_extend(extmarks, ns_marks)
+  end
+
+  if filter.semantic_tokens then
+    results.semantic_tokens = vim.tbl_filter(function(extmark)
+      return extmark.ns:find('vim_lsp_semantic_tokens') == 1
+    end, extmarks)
   end
 
-  -- extmarks
   if filter.extmarks then
-    for ns, nsid in pairs(vim.api.nvim_get_namespaces()) do
-      if ns:find('vim_lsp_semantic_tokens') ~= 1 then
-        local extmarks = vim.api.nvim_buf_get_extmarks(bufnr, nsid, 0, -1, { details = true })
-        for _, extmark in ipairs(extmarks) do
-          extmark = {
-            ns_id = nsid,
-            ns = ns,
-            id = extmark[1],
-            row = extmark[2],
-            col = extmark[3],
-            opts = resolve_hl(extmark[4]),
-          }
-          local end_row = extmark.opts.end_row or extmark.row -- inclusive
-          local end_col = extmark.opts.end_col or (extmark.col + 1) -- exclusive
-          if
-            (filter.extmarks == 'all' or extmark.opts.hl_group) -- filter hl_group
-            and (row >= extmark.row and row <= end_row) -- within the rows of the extmark
-            and (row > extmark.row or col >= extmark.col) -- either not the first row, or in range of the col
-            and (row < end_row or col < end_col) -- either not in the last row or in range of the col
-          then
-            table.insert(results.extmarks, extmark)
-          end
-        end
-      end
-    end
+    results.extmarks = vim.tbl_filter(function(extmark)
+      return extmark.ns:find('vim_lsp_semantic_tokens') ~= 1
+        and (filter.extmarks == 'all' or extmark.opts.hl_group)
+    end, extmarks)
   end
+
   return results
 end
 
@@ -174,16 +181,17 @@ function vim.show_pos(bufnr, row, col, filter)
     nl()
   end
 
+  -- semantic tokens
   if #items.semantic_tokens > 0 then
     append('Semantic Tokens', 'Title')
     nl()
-    for _, token in ipairs(items.semantic_tokens) do
-      local client = vim.lsp.get_client_by_id(token.client_id)
-      client = client and (' (' .. client.name .. ')') or ''
-      item(token.hl_groups.type, 'type' .. client)
-      for _, modifier in ipairs(token.hl_groups.modifiers) do
-        item(modifier, 'modifier' .. client)
-      end
+    local sorted_marks = vim.fn.sort(items.semantic_tokens, function(left, right)
+      local left_first = left.opts.priority < right.opts.priority
+        or left.opts.priority == right.opts.priority and left.opts.hl_group < right.opts.hl_group
+      return left_first and -1 or 1
+    end)
+    for _, extmark in ipairs(sorted_marks) do
+      item(extmark.opts, 'priority: ' .. extmark.opts.priority)
     end
     nl()
   end
@@ -197,6 +205,7 @@ function vim.show_pos(bufnr, row, col, filter)
     end
     nl()
   end
+
   -- extmarks
   if #items.extmarks > 0 then
     append('Extmarks', 'Title')
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 24b5c6c24e..7983d066b8 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -8,8 +8,8 @@ local bit = require('bit')
 --- @field start_col number start column 0-based
 --- @field end_col number end column 0-based
 --- @field type string token type as string
---- @field modifiers string[] token modifiers as strings
---- @field extmark_added boolean whether this extmark has been added to the buffer yet
+--- @field modifiers table token modifiers as a set. E.g., { static = true, readonly = true }
+--- @field marked boolean whether this token has had extmarks applied
 ---
 --- @class STCurrentResult
 --- @field version number document version associated with this result
@@ -36,10 +36,13 @@ local bit = require('bit')
 ---@field client_state table<number, STClientState>
 local STHighlighter = { active = {} }
 
+--- Do a binary search of the tokens in the half-open range [lo, hi).
+---
+--- Return the index i in range such that tokens[j].line < line for all j < i, and
+--- tokens[j].line >= line for all j >= i, or return hi if no such index is found.
+---
 ---@private
-local function binary_search(tokens, line)
-  local lo = 1
-  local hi = #tokens
+local function lower_bound(tokens, line, lo, hi)
   while lo < hi do
     local mid = math.floor((lo + hi) / 2)
     if tokens[mid].line < line then
@@ -51,16 +54,34 @@ local function binary_search(tokens, line)
   return lo
 end
 
+--- Do a binary search of the tokens in the half-open range [lo, hi).
+---
+--- Return the index i in range such that tokens[j].line <= line for all j < i, and
+--- tokens[j].line > line for all j >= i, or return hi if no such index is found.
+---
+---@private
+local function upper_bound(tokens, line, lo, hi)
+  while lo < hi do
+    local mid = math.floor((lo + hi) / 2)
+    if line < tokens[mid].line then
+      hi = mid
+    else
+      lo = mid + 1
+    end
+  end
+  return lo
+end
+
 --- Extracts modifier strings from the encoded number in the token array
 ---
 ---@private
----@return string[]
+---@return table<string, boolean>
 local function modifiers_from_number(x, modifiers_table)
   local modifiers = {}
   local idx = 1
   while x > 0 do
     if bit.band(x, 1) == 1 then
-      modifiers[#modifiers + 1] = modifiers_table[idx]
+      modifiers[modifiers_table[idx]] = true
     end
     x = bit.rshift(x, 1)
     idx = idx + 1
@@ -109,7 +130,7 @@ local function tokens_to_ranges(data, bufnr, client)
         end_col = end_col,
         type = token_type,
         modifiers = modifiers,
-        extmark_added = false,
+        marked = false,
       }
     end
   end
@@ -355,7 +376,7 @@ end
 ---
 ---@private
 function STHighlighter:on_win(topline, botline)
-  for _, state in pairs(self.client_state) do
+  for client_id, state in pairs(self.client_state) do
     local current_result = state.current_result
     if current_result.version and current_result.version == util.buf_versions[self.bufnr] then
       if not current_result.namespace_cleared then
@@ -372,52 +393,55 @@ function STHighlighter:on_win(topline, botline)
       --
       -- Instead, we have to use normal extmarks that can attach to locations
       -- in the buffer and are persisted between redraws.
+      --
+      -- `strict = false` is necessary here for the 1% of cases where the
+      -- current result doesn't actually match the buffer contents. Some
+      -- LSP servers can respond with stale tokens on requests if they are
+      -- still processing changes from a didChange notification.
+      --
+      -- LSP servers that do this _should_ follow up known stale responses
+      -- with a refresh notification once they've finished processing the
+      -- didChange notification, which would re-synchronize the tokens from
+      -- our end.
+      --
+      -- The server I know of that does this is clangd when the preamble of
+      -- a file changes and the token request is processed with a stale
+      -- preamble while the new one is still being built. Once the preamble
+      -- finishes, clangd sends a refresh request which lets the client
+      -- re-synchronize the tokens.
+
+      local set_mark = function(token, hl_group, delta)
+        vim.api.nvim_buf_set_extmark(self.bufnr, state.namespace, token.line, token.start_col, {
+          hl_group = hl_group,
+          end_col = token.end_col,
+          priority = vim.highlight.priorities.semantic_tokens + delta,
+          strict = false,
+        })
+      end
+
+      local ft = vim.bo[self.bufnr].filetype
       local highlights = current_result.highlights
-      local idx = binary_search(highlights, topline)
+      local first = lower_bound(highlights, topline, 1, #highlights + 1)
+      local last = upper_bound(highlights, botline, first, #highlights + 1) - 1
 
-      for i = idx, #highlights do
+      for i = first, last do
         local token = highlights[i]
-
-        if token.line > botline then
-          break
-        end
-
-        if not token.extmark_added then
-          -- `strict = false` is necessary here for the 1% of cases where the
-          -- current result doesn't actually match the buffer contents. Some
-          -- LSP servers can respond with stale tokens on requests if they are
-          -- still processing changes from a didChange notification.
-          --
-          -- LSP servers that do this _should_ follow up known stale responses
-          -- with a refresh notification once they've finished processing the
-          -- didChange notification, which would re-synchronize the tokens from
-          -- our end.
-          --
-          -- The server I know of that does this is clangd when the preamble of
-          -- a file changes and the token request is processed with a stale
-          -- preamble while the new one is still being built. Once the preamble
-          -- finishes, clangd sends a refresh request which lets the client
-          -- re-synchronize the tokens.
-          api.nvim_buf_set_extmark(self.bufnr, state.namespace, token.line, token.start_col, {
-            hl_group = '@' .. token.type,
-            end_col = token.end_col,
-            priority = vim.highlight.priorities.semantic_tokens,
-            strict = false,
-          })
-
-          -- TODO(bfredl) use single extmark when hl_group supports table
-          if #token.modifiers > 0 then
-            for _, modifier in pairs(token.modifiers) do
-              api.nvim_buf_set_extmark(self.bufnr, state.namespace, token.line, token.start_col, {
-                hl_group = '@' .. modifier,
-                end_col = token.end_col,
-                priority = vim.highlight.priorities.semantic_tokens + 1,
-                strict = false,
-              })
-            end
+        if not token.marked then
+          set_mark(token, string.format('@lsp.type.%s.%s', token.type, ft), 0)
+          for modifier, _ in pairs(token.modifiers) do
+            set_mark(token, string.format('@lsp.mod.%s.%s', modifier, ft), 1)
+            set_mark(token, string.format('@lsp.typemod.%s.%s.%s', token.type, modifier, ft), 2)
           end
-
-          token.extmark_added = true
+          token.marked = true
+
+          api.nvim_exec_autocmds('LspTokenUpdate', {
+            pattern = vim.api.nvim_buf_get_name(self.bufnr),
+            modeline = false,
+            data = {
+              token = token,
+              client_id = client_id,
+            },
+          })
         end
       end
     end
@@ -588,7 +612,13 @@ end
 ---@param row number|nil Position row (default cursor position)
 ---@param col number|nil Position column (default cursor position)
 ---
----@return table|nil (table|nil) List of tokens at position
+---@return table|nil (table|nil) List of tokens at position. Each token has
+---        the following fields:
+---        - line (number) line number, 0-based
+---        - start_col (number) start column, 0-based
+---        - end_col (number) end column, 0-based
+---        - type (string) token type as string, e.g. "variable"
+---        - modifiers (table) token modifiers as a set. E.g., { static = true, readonly = true }
 function M.get_at_pos(bufnr, row, col)
   if bufnr == nil or bufnr == 0 then
     bufnr = api.nvim_get_current_buf()
@@ -608,7 +638,7 @@ function M.get_at_pos(bufnr, row, col)
   for client_id, client in pairs(highlighter.client_state) do
     local highlights = client.current_result.highlights
     if highlights then
-      local idx = binary_search(highlights, row)
+      local idx = lower_bound(highlights, row, 1, #highlights + 1)
       for i = idx, #highlights do
         local token = highlights[i]
 
@@ -631,23 +661,60 @@ end
 --- Only has an effect if the buffer is currently active for semantic token
 --- highlighting (|vim.lsp.semantic_tokens.start()| has been called for it)
 ---
----@param bufnr (nil|number) default: current buffer
+---@param bufnr (number|nil) filter by buffer. All buffers if nil, current
+---       buffer if 0
 function M.force_refresh(bufnr)
   vim.validate({
     bufnr = { bufnr, 'n', true },
   })
 
-  if bufnr == nil or bufnr == 0 then
-    bufnr = api.nvim_get_current_buf()
+  local buffers = bufnr == nil and vim.tbl_keys(STHighlighter.active)
+    or bufnr == 0 and { api.nvim_get_current_buf() }
+    or { bufnr }
+
+  for _, buffer in ipairs(buffers) do
+    local highlighter = STHighlighter.active[buffer]
+    if highlighter then
+      highlighter:reset()
+      highlighter:send_request()
+    end
   end
+end
 
+--- Highlight a semantic token.
+---
+--- Apply an extmark with a given highlight group for a semantic token. The
+--- mark will be deleted by the semantic token engine when appropriate; for
+--- example, when the LSP sends updated tokens. This function is intended for
+--- use inside |LspTokenUpdate| callbacks.
+---@param token (table) a semantic token, found as `args.data.token` in
+---       |LspTokenUpdate|.
+---@param bufnr (number) the buffer to highlight
+---@param client_id (number) The ID of the |vim.lsp.client|
+---@param hl_group (string) Highlight group name
+---@param opts (table|nil) Optional parameters.
+---       - priority: (number|nil) Priority for the applied extmark. Defaults
+---         to `vim.highlight.priorities.semantic_tokens + 3`
+function M.highlight_token(token, bufnr, client_id, hl_group, opts)
   local highlighter = STHighlighter.active[bufnr]
   if not highlighter then
     return
   end
 
-  highlighter:reset()
-  highlighter:send_request()
+  local state = highlighter.client_state[client_id]
+  if not state then
+    return
+  end
+
+  opts = opts or {}
+  local priority = opts.priority or vim.highlight.priorities.semantic_tokens + 3
+
+  vim.api.nvim_buf_set_extmark(bufnr, state.namespace, token.line, token.start_col, {
+    hl_group = hl_group,
+    end_col = token.end_col,
+    priority = priority,
+    strict = false,
+  })
 end
 
 --- |lsp-handler| for the method `workspace/semanticTokens/refresh`
-- 
cgit 


From 79571b92ced968ad27bee2a7515a4a04e84dbad2 Mon Sep 17 00:00:00 2001
From: Björn Linse <bjorn.linse@gmail.com>
Date: Wed, 27 Jan 2021 09:00:28 +0100
Subject: feat(lua): omnifunc for builting lua interpreter

also make implicit submodules "uri" and "_inspector" work with completion

this is needed for `:lua=vim.uri_<tab>` wildmenu completion
to work even before uri or _inspector functions are used.
---
 runtime/lua/vim/_editor.lua | 41 +++++++++++++++++++++++++++++++++++++----
 1 file changed, 37 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index c205451ff9..9516233b45 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -42,6 +42,18 @@ for k, v in pairs({
   vim._submodules[k] = v
 end
 
+-- There are things which have special rules in vim._init_packages
+-- for legacy reasons (uri) or for performance (_inspector).
+-- most new things should go into a submodule namespace ( vim.foobar.do_thing() )
+vim._extra = {
+  uri_from_fname = true,
+  uri_from_bufnr = true,
+  uri_to_fname = true,
+  uri_to_bufnr = true,
+  show_pos = true,
+  inspect_pos = true,
+}
+
 vim.log = {
   levels = {
     TRACE = 0,
@@ -575,15 +587,13 @@ function vim._on_key(char)
 end
 
 --- Generate a list of possible completions for the string.
---- String starts with ^ and then has the pattern.
+--- String has the pattern.
 ---
 ---     1. Can we get it to just return things in the global namespace with that name prefix
 ---     2. Can we get it to return things from global namespace even with `print(` in front.
 function vim._expand_pat(pat, env)
   env = env or _G
 
-  pat = string.sub(pat, 2, #pat)
-
   if pat == '' then
     local result = vim.tbl_keys(env)
     table.sort(result)
@@ -644,7 +654,7 @@ function vim._expand_pat(pat, env)
       local mt = getmetatable(final_env)
       if mt and type(mt.__index) == 'table' then
         field = rawget(mt.__index, key)
-      elseif final_env == vim and vim._submodules[key] then
+      elseif final_env == vim and (vim._submodules[key] or vim._extra[key]) then
         field = vim[key]
       end
     end
@@ -674,6 +684,7 @@ function vim._expand_pat(pat, env)
   end
   if final_env == vim then
     insert_keys(vim._submodules)
+    insert_keys(vim._extra)
   end
 
   keys = vim.tbl_keys(keys)
@@ -745,6 +756,28 @@ vim._expand_pat_get_parts = function(lua_string)
   return parts, search_index
 end
 
+do
+  -- Ideally we should just call complete() inside omnifunc, though there are
+  -- some bugs, so fake the two-step dance for now.
+  local matches
+
+  --- Omnifunc for completing lua values from from the runtime lua interpreter,
+  --- similar to the builtin completion for the `:lua` command.
+  ---
+  --- Activate using `set omnifunc=v:lua.vim.lua_omnifunc` in a lua buffer.
+  function vim.lua_omnifunc(find_start, _)
+    if find_start == 1 then
+      local line = vim.api.nvim_get_current_line()
+      local prefix = string.sub(line, 1, vim.api.nvim_win_get_cursor(0)[2])
+      local pos
+      matches, pos = vim._expand_pat(prefix)
+      return (#matches > 0 and pos) or -1
+    else
+      return matches
+    end
+  end
+end
+
 ---Prints given arguments in human-readable format.
 ---Example:
 ---<pre>lua
-- 
cgit 


From 706bcab75eaad2c370d61bf828531054439d3a3e Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Tue, 7 Mar 2023 15:17:52 +0900
Subject: docs(lsp): change type annotations from number → integer (#22510)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 runtime/lua/vim/lsp.lua                 | 72 +++++++++++++++----------------
 runtime/lua/vim/lsp/_snippet.lua        |  2 +-
 runtime/lua/vim/lsp/codelens.lua        | 14 +++---
 runtime/lua/vim/lsp/diagnostic.lua      | 12 +++---
 runtime/lua/vim/lsp/log.lua             |  4 +-
 runtime/lua/vim/lsp/rpc.lua             | 16 +++----
 runtime/lua/vim/lsp/semantic_tokens.lua | 60 +++++++++++++-------------
 runtime/lua/vim/lsp/sync.lua            |  6 +--
 runtime/lua/vim/lsp/util.lua            | 76 ++++++++++++++++-----------------
 9 files changed, 131 insertions(+), 131 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index a56e141c29..9a0b3f3100 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -363,7 +363,7 @@ do
   --- smallest debounce interval is used and we don't group clients by different intervals.
   ---
   --- @class CTGroup
-  --- @field sync_kind number TextDocumentSyncKind, considers config.flags.allow_incremental_sync
+  --- @field sync_kind integer TextDocumentSyncKind, considers config.flags.allow_incremental_sync
   --- @field offset_encoding "utf-8"|"utf-16"|"utf-32"
   ---
   --- @class CTBufferState
@@ -374,12 +374,12 @@ do
   --- @field timer nil|uv.uv_timer_t uv_timer
   --- @field last_flush nil|number uv.hrtime of the last flush/didChange-notification
   --- @field needs_flush boolean true if buffer updates haven't been sent to clients/servers yet
-  --- @field refs number how many clients are using this group
+  --- @field refs integer how many clients are using this group
   ---
   --- @class CTGroupState
-  --- @field buffers table<number, CTBufferState>
-  --- @field debounce number debounce duration in ms
-  --- @field clients table<number, table> clients using this state. {client_id, client}
+  --- @field buffers table<integer, CTBufferState>
+  --- @field debounce integer debounce duration in ms
+  --- @field clients table<integer, table> clients using this state. {client_id, client}
 
   ---@private
   ---@param group CTGroup
@@ -568,7 +568,7 @@ do
   --
   -- This turns the debounce into a kind of client rate limiting
   --
-  ---@param debounce number
+  ---@param debounce integer
   ---@param buf_state CTBufferState
   ---@return number
   local function next_debounce(debounce, buf_state)
@@ -585,8 +585,8 @@ do
   end
 
   ---@private
-  ---@param bufnr number
-  ---@param sync_kind number protocol.TextDocumentSyncKind
+  ---@param bufnr integer
+  ---@param sync_kind integer protocol.TextDocumentSyncKind
   ---@param state CTGroupState
   ---@param buf_state CTBufferState
   local function send_changes(bufnr, sync_kind, state, buf_state)
@@ -714,7 +714,7 @@ end
 ---@private
 --- Default handler for the 'textDocument/didOpen' LSP notification.
 ---
----@param bufnr number Number of the buffer, or 0 for current
+---@param bufnr integer Number of the buffer, or 0 for current
 ---@param client table Client object
 local function text_document_did_open_handler(bufnr, client)
   changetracking.init(client, bufnr)
@@ -1095,7 +1095,7 @@ function lsp.start_client(config)
   ---@private
   --- Invoked when the client operation throws an error.
   ---
-  ---@param code (number) Error code
+  ---@param code (integer) Error code
   ---@param err (...) Other arguments may be passed depending on the error kind
   ---@see `vim.lsp.rpc.client_errors` for possible errors. Use
   ---`vim.lsp.rpc.client_errors[code]` to get a human-friendly name.
@@ -1148,8 +1148,8 @@ function lsp.start_client(config)
   ---@private
   --- Invoked on client exit.
   ---
-  ---@param code (number) exit code of the process
-  ---@param signal (number) the signal used to terminate (if any)
+  ---@param code (integer) exit code of the process
+  ---@param signal (integer) the signal used to terminate (if any)
   function dispatch.on_exit(code, signal)
     if config.on_exit then
       pcall(config.on_exit, code, signal, client_id)
@@ -1414,9 +1414,9 @@ function lsp.start_client(config)
   ---
   ---@param method (string) LSP method name.
   ---@param params (table) LSP request params.
-  ---@param timeout_ms (number|nil) Maximum time in milliseconds to wait for
+  ---@param timeout_ms (integer|nil) Maximum time in milliseconds to wait for
   ---                               a result. Defaults to 1000
-  ---@param bufnr (number) Buffer handle (0 for current).
+  ---@param bufnr (integer) Buffer handle (0 for current).
   ---@return {err: lsp.ResponseError|nil, result:any}|nil, string|nil err # a dictionary, where
   --- `err` and `result` come from the |lsp-handler|.
   --- On timeout, cancel or error, returns `(nil, err)` where `err` is a
@@ -1465,7 +1465,7 @@ function lsp.start_client(config)
   ---@private
   --- Cancels a request with a given request id.
   ---
-  ---@param id (number) id of request to cancel
+  ---@param id (integer) id of request to cancel
   ---@return boolean status true if notification was successful. false otherwise
   ---@see |vim.lsp.client.notify()|
   function client.cancel_request(id)
@@ -1622,8 +1622,8 @@ end
 ---
 --- Without calling this, the server won't be notified of changes to a buffer.
 ---
----@param bufnr (number) Buffer handle, or 0 for current
----@param client_id (number) Client id
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@param client_id (integer) Client id
 function lsp.buf_attach_client(bufnr, client_id)
   validate({
     bufnr = { bufnr, 'n', true },
@@ -1734,8 +1734,8 @@ end
 --- Note: While the server is notified that the text document (buffer)
 --- was closed, it is still able to send notifications should it ignore this notification.
 ---
----@param bufnr number Buffer handle, or 0 for current
----@param client_id number Client id
+---@param bufnr integer Buffer handle, or 0 for current
+---@param client_id integer Client id
 function lsp.buf_detach_client(bufnr, client_id)
   validate({
     bufnr = { bufnr, 'n', true },
@@ -1785,8 +1785,8 @@ end
 
 --- Checks if a buffer is attached for a particular client.
 ---
----@param bufnr (number) Buffer handle, or 0 for current
----@param client_id (number) the client id
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@param client_id (integer) the client id
 function lsp.buf_is_attached(bufnr, client_id)
   return (all_buffer_active_clients[resolve_bufnr(bufnr)] or {})[client_id] == true
 end
@@ -1794,7 +1794,7 @@ end
 --- Gets a client by id, or nil if the id is invalid.
 --- The returned client may not yet be fully initialized.
 ---
----@param client_id number client id
+---@param client_id integer client id
 ---
 ---@returns |vim.lsp.client| object, or nil
 function lsp.get_client_by_id(client_id)
@@ -1821,7 +1821,7 @@ end
 --- By default asks the server to shutdown, unless stop was requested
 --- already for this client, then force-shutdown is attempted.
 ---
----@param client_id number|table id or |vim.lsp.client| object, or list thereof
+---@param client_id integer|table id or |vim.lsp.client| object, or list thereof
 ---@param force boolean|nil shutdown forcefully
 function lsp.stop_client(client_id, force)
   local ids = type(client_id) == 'table' and client_id or { client_id }
@@ -1837,8 +1837,8 @@ function lsp.stop_client(client_id, force)
 end
 
 ---@class vim.lsp.get_active_clients.filter
----@field id number|nil Match clients by id
----@field bufnr number|nil match clients attached to the given buffer
+---@field id integer|nil Match clients by id
+---@field bufnr integer|nil match clients attached to the given buffer
 ---@field name string|nil match clients by name
 
 --- Get active clients.
@@ -1932,7 +1932,7 @@ api.nvim_create_autocmd('VimLeavePre', {
 --- Sends an async request for all active clients attached to the
 --- buffer.
 ---
----@param bufnr (number) Buffer handle, or 0 for current.
+---@param bufnr (integer) Buffer handle, or 0 for current.
 ---@param method (string) LSP method name
 ---@param params table|nil Parameters to send to the server
 ---@param handler function|nil See |lsp-handler|
@@ -1992,7 +1992,7 @@ end
 ---Parameters are the same as |vim.lsp.buf_request()| but the return result and callback are
 ---different.
 ---
----@param bufnr (number) Buffer handle, or 0 for current.
+---@param bufnr (integer) Buffer handle, or 0 for current.
 ---@param method (string) LSP method name
 ---@param params (table|nil) Parameters to send to the server
 ---@param callback (function) The callback to call when all requests are finished.
@@ -2034,10 +2034,10 @@ end
 --- Parameters are the same as |vim.lsp.buf_request()| but the return result is
 --- different. Wait maximum of {timeout_ms} (default 1000) ms.
 ---
----@param bufnr (number) Buffer handle, or 0 for current.
+---@param bufnr (integer) Buffer handle, or 0 for current.
 ---@param method (string) LSP method name
 ---@param params (table|nil) Parameters to send to the server
----@param timeout_ms (number|nil) Maximum time in milliseconds to wait for a
+---@param timeout_ms (integer|nil) Maximum time in milliseconds to wait for a
 ---                               result. Defaults to 1000
 ---
 ---@return table<integer, any>|nil result, string|nil err Map of client_id:request_result.
@@ -2106,10 +2106,10 @@ end
 ---@see |complete-items|
 ---@see |CompleteDone|
 ---
----@param findstart number 0 or 1, decides behavior
----@param base number findstart=0, text to match against
+---@param findstart integer 0 or 1, decides behavior
+---@param base integer findstart=0, text to match against
 ---
----@returns (number) Decided by {findstart}:
+---@returns (integer) Decided by {findstart}:
 --- - findstart=0: column where the completion starts, or -2 or -3
 --- - findstart=1: list of matches (actually just calls |complete()|)
 function lsp.omnifunc(findstart, base)
@@ -2246,7 +2246,7 @@ end
 
 ---Checks whether a client is stopped.
 ---
----@param client_id (number)
+---@param client_id (integer)
 ---@return boolean stopped true if client is stopped, false otherwise.
 function lsp.client_is_stopped(client_id)
   return active_clients[client_id] == nil
@@ -2255,7 +2255,7 @@ end
 --- Gets a map of client_id:client pairs for the given buffer, where each value
 --- is a |vim.lsp.client| object.
 ---
----@param bufnr (number|nil): Buffer handle, or 0 for current
+---@param bufnr (integer|nil): Buffer handle, or 0 for current
 ---@returns (table) Table of (client_id, client) pairs
 ---@deprecated Use |vim.lsp.get_active_clients()| instead.
 function lsp.buf_get_clients(bufnr)
@@ -2284,7 +2284,7 @@ lsp.log_levels = log.levels
 ---
 ---@see |vim.lsp.log_levels|
 ---
----@param level (number|string) the case insensitive level name or number
+---@param level (integer|string) the case insensitive level name or number
 function lsp.set_log_level(level)
   if type(level) == 'string' or type(level) == 'number' then
     log.set_level(level)
@@ -2301,7 +2301,7 @@ end
 
 --- Invokes a function for each LSP client attached to a buffer.
 ---
----@param bufnr number Buffer number
+---@param bufnr integer Buffer number
 ---@param fn function Function to run on each client attached to buffer
 ---                   {bufnr}. The function takes the client, client ID, and
 ---                   buffer number as arguments. Example:
diff --git a/runtime/lua/vim/lsp/_snippet.lua b/runtime/lua/vim/lsp/_snippet.lua
index 3488639fb4..797d8960d5 100644
--- a/runtime/lua/vim/lsp/_snippet.lua
+++ b/runtime/lua/vim/lsp/_snippet.lua
@@ -483,7 +483,7 @@ end)
 local M = {}
 
 ---The snippet node type enum
----@types table<string, number>
+---@types table<string, integer>
 M.NodeType = Node.Type
 
 ---Parse snippet string and returns the AST
diff --git a/runtime/lua/vim/lsp/codelens.lua b/runtime/lua/vim/lsp/codelens.lua
index 17489ed84d..81cac6a511 100644
--- a/runtime/lua/vim/lsp/codelens.lua
+++ b/runtime/lua/vim/lsp/codelens.lua
@@ -61,7 +61,7 @@ end
 
 --- Return all lenses for the given buffer
 ---
----@param bufnr number  Buffer number. 0 can be used for the current buffer.
+---@param bufnr integer  Buffer number. 0 can be used for the current buffer.
 ---@return table (`CodeLens[]`)
 function M.get(bufnr)
   local lenses_by_client = lens_cache_by_buf[bufnr or 0]
@@ -115,8 +115,8 @@ end
 
 --- Clear the lenses
 ---
----@param client_id number|nil filter by client_id. All clients if nil
----@param bufnr number|nil filter by buffer. All buffers if nil
+---@param client_id integer|nil filter by client_id. All clients if nil
+---@param bufnr integer|nil filter by buffer. All buffers if nil
 function M.clear(client_id, bufnr)
   local buffers = bufnr and { resolve_bufnr(bufnr) } or vim.tbl_keys(lens_cache_by_buf)
   for _, iter_bufnr in pairs(buffers) do
@@ -132,8 +132,8 @@ end
 --- Display the lenses using virtual text
 ---
 ---@param lenses table of lenses to display (`CodeLens[] | null`)
----@param bufnr number
----@param client_id number
+---@param bufnr integer
+---@param client_id integer
 function M.display(lenses, bufnr, client_id)
   local ns = namespaces[client_id]
   if not lenses or not next(lenses) then
@@ -177,8 +177,8 @@ end
 --- Store lenses for a specific buffer and client
 ---
 ---@param lenses table of lenses to store (`CodeLens[] | null`)
----@param bufnr number
----@param client_id number
+---@param bufnr integer
+---@param client_id integer
 function M.save(lenses, bufnr, client_id)
   local lenses_by_client = lens_cache_by_buf[bufnr]
   if not lenses_by_client then
diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index 5e2bf75f1b..b27bf6e425 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -4,7 +4,7 @@
 ---@field range Range
 ---@field message string
 ---@field severity DiagnosticSeverity|nil
----@field code number | string
+---@field code integer | string
 ---@field source string
 ---@field tags DiagnosticTag[]
 ---@field relatedInformation DiagnosticRelatedInformation[]
@@ -135,7 +135,7 @@ local _client_namespaces = {}
 
 --- Get the diagnostic namespace associated with an LSP client |vim.diagnostic|.
 ---
----@param client_id number The id of the LSP client
+---@param client_id integer The id of the LSP client
 function M.get_namespace(client_id)
   vim.validate({ client_id = { client_id, 'n' } })
   if not _client_namespaces[client_id] then
@@ -212,7 +212,7 @@ end
 --- this method signature is still used internally in some parts of the LSP
 --- implementation so it's simply marked @private rather than @deprecated.
 ---
----@param client_id number
+---@param client_id integer
 ---@param buffer_client_map table map of buffers to active clients
 ---@private
 function M.reset(client_id, buffer_client_map)
@@ -232,14 +232,14 @@ end
 --- Marked private as this is used internally by the LSP subsystem, but
 --- most users should instead prefer |vim.diagnostic.get()|.
 ---
----@param bufnr number|nil The buffer number
----@param line_nr number|nil The line number
+---@param bufnr integer|nil The buffer number
+---@param line_nr integer|nil The line number
 ---@param opts table|nil Configuration keys
 ---         - severity: (DiagnosticSeverity, default nil)
 ---             - Only return diagnostics with this severity. Overrides severity_limit
 ---         - severity_limit: (DiagnosticSeverity, default nil)
 ---             - Limit severity of diagnostics found. E.g. "Warning" means { "Error", "Warning" } will be valid.
----@param client_id|nil number the client id
+---@param client_id integer|nil the client id
 ---@return table Table with map of line number to list of diagnostics.
 ---              Structured: { [1] = {...}, [5] = {.... } }
 ---@private
diff --git a/runtime/lua/vim/lsp/log.lua b/runtime/lua/vim/lsp/log.lua
index d1a78572aa..51dcb7d21d 100644
--- a/runtime/lua/vim/lsp/log.lua
+++ b/runtime/lua/vim/lsp/log.lua
@@ -141,7 +141,7 @@ end
 vim.tbl_add_reverse_lookup(log.levels)
 
 --- Sets the current log level.
----@param level (string|number) One of `vim.lsp.log.levels`
+---@param level (string|integer) One of `vim.lsp.log.levels`
 function log.set_level(level)
   if type(level) == 'string' then
     current_log_level =
@@ -167,7 +167,7 @@ function log.set_format_func(handle)
 end
 
 --- Checks whether the level is sufficient for logging.
----@param level number log level
+---@param level integer log level
 ---@returns (bool) true if would log, false if not
 function log.should_log(level)
   return level >= current_log_level
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index aa833deb99..30b61d01d6 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -186,7 +186,7 @@ end
 
 --- Creates an RPC response object/table.
 ---
----@param code number RPC error code defined in `vim.lsp.protocol.ErrorCodes`
+---@param code integer RPC error code defined in `vim.lsp.protocol.ErrorCodes`
 ---@param message string|nil arbitrary message to send to server
 ---@param data any|nil arbitrary data to send to server
 local function rpc_response_error(code, message, data)
@@ -224,8 +224,8 @@ end
 ---@private
 --- Default dispatcher for when a client exits.
 ---
----@param code (number): Exit code
----@param signal (number): Number describing the signal used to terminate (if
+---@param code (integer): Exit code
+---@param signal (integer): Number describing the signal used to terminate (if
 ---any)
 function default_dispatchers.on_exit(code, signal)
   local _ = log.info() and log.info('client_exit', { code = code, signal = signal })
@@ -233,7 +233,7 @@ end
 ---@private
 --- Default dispatcher for client errors.
 ---
----@param code (number): Error code
+---@param code (integer): Error code
 ---@param err (any): Details about the error
 ---any)
 function default_dispatchers.on_error(code, err)
@@ -270,7 +270,7 @@ local function create_read_loop(handle_body, on_no_chunk, on_error)
 end
 
 ---@class RpcClient
----@field message_index number
+---@field message_index integer
 ---@field message_callbacks table
 ---@field notify_reply_callbacks table
 ---@field transport table
@@ -588,7 +588,7 @@ end
 --- and port
 ---
 ---@param host string
----@param port number
+---@param port integer
 ---@return function
 local function connect(host, port)
   return function(dispatchers)
@@ -692,8 +692,8 @@ local function start(cmd, cmd_args, dispatchers, extra_spawn_params)
 
   ---@private
   --- Callback for |vim.loop.spawn()| Closes all streams and runs the `on_exit` dispatcher.
-  ---@param code (number) Exit code
-  ---@param signal (number) Signal that was used to terminate (if any)
+  ---@param code (integer) Exit code
+  ---@param signal (integer) Signal that was used to terminate (if any)
   local function onexit(code, signal)
     stdin:close()
     stdout:close()
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 7983d066b8..9eaccd539f 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -4,36 +4,36 @@ local util = require('vim.lsp.util')
 local bit = require('bit')
 
 --- @class STTokenRange
---- @field line number line number 0-based
---- @field start_col number start column 0-based
---- @field end_col number end column 0-based
+--- @field line integer line number 0-based
+--- @field start_col integer start column 0-based
+--- @field end_col integer end column 0-based
 --- @field type string token type as string
 --- @field modifiers table token modifiers as a set. E.g., { static = true, readonly = true }
 --- @field marked boolean whether this token has had extmarks applied
 ---
 --- @class STCurrentResult
---- @field version number document version associated with this result
+--- @field version integer document version associated with this result
 --- @field result_id string resultId from the server; used with delta requests
 --- @field highlights STTokenRange[] cache of highlight ranges for this document version
---- @field tokens number[] raw token array as received by the server. used for calculating delta responses
+--- @field tokens integer[] raw token array as received by the server. used for calculating delta responses
 --- @field namespace_cleared boolean whether the namespace was cleared for this result yet
 ---
 --- @class STActiveRequest
---- @field request_id number the LSP request ID of the most recent request sent to the server
---- @field version number the document version associated with the most recent request
+--- @field request_id integer the LSP request ID of the most recent request sent to the server
+--- @field version integer the document version associated with the most recent request
 ---
 --- @class STClientState
---- @field namespace number
+--- @field namespace integer
 --- @field active_request STActiveRequest
 --- @field current_result STCurrentResult
 
 ---@class STHighlighter
----@field active table<number, STHighlighter>
----@field bufnr number
----@field augroup number augroup for buffer events
----@field debounce number milliseconds to debounce requests for new tokens
+---@field active table<integer, STHighlighter>
+---@field bufnr integer
+---@field augroup integer augroup for buffer events
+---@field debounce integer milliseconds to debounce requests for new tokens
 ---@field timer table uv_timer for debouncing requests for new tokens
----@field client_state table<number, STClientState>
+---@field client_state table<integer, STClientState>
 local STHighlighter = { active = {} }
 
 --- Do a binary search of the tokens in the half-open range [lo, hi).
@@ -141,7 +141,7 @@ end
 --- Construct a new STHighlighter for the buffer
 ---
 ---@private
----@param bufnr number
+---@param bufnr integer
 function STHighlighter.new(bufnr)
   local self = setmetatable({}, { __index = STHighlighter })
 
@@ -470,7 +470,7 @@ end
 --- in case the server supports delta requests.
 ---
 ---@private
----@param client_id number
+---@param client_id integer
 function STHighlighter:mark_dirty(client_id)
   local state = self.client_state[client_id]
   assert(state)
@@ -529,10 +529,10 @@ local M = {}
 ---   client.server_capabilities.semanticTokensProvider = nil
 --- </pre>
 ---
----@param bufnr number
----@param client_id number
+---@param bufnr integer
+---@param client_id integer
 ---@param opts (nil|table) Optional keyword arguments
----  - debounce (number, default: 200): Debounce token requests
+---  - debounce (integer, default: 200): Debounce token requests
 ---        to the server by the given number in milliseconds
 function M.start(bufnr, client_id, opts)
   vim.validate({
@@ -585,8 +585,8 @@ end
 --- of `start()`, so you should only need this function to manually disengage the semantic
 --- token engine without fully detaching the LSP client from the buffer.
 ---
----@param bufnr number
----@param client_id number
+---@param bufnr integer
+---@param client_id integer
 function M.stop(bufnr, client_id)
   vim.validate({
     bufnr = { bufnr, 'n', false },
@@ -608,15 +608,15 @@ end
 --- Return the semantic token(s) at the given position.
 --- If called without arguments, returns the token under the cursor.
 ---
----@param bufnr number|nil Buffer number (0 for current buffer, default)
----@param row number|nil Position row (default cursor position)
----@param col number|nil Position column (default cursor position)
+---@param bufnr integer|nil Buffer number (0 for current buffer, default)
+---@param row integer|nil Position row (default cursor position)
+---@param col integer|nil Position column (default cursor position)
 ---
 ---@return table|nil (table|nil) List of tokens at position. Each token has
 ---        the following fields:
----        - line (number) line number, 0-based
----        - start_col (number) start column, 0-based
----        - end_col (number) end column, 0-based
+---        - line (integer) line number, 0-based
+---        - start_col (integer) start column, 0-based
+---        - end_col (integer) end column, 0-based
 ---        - type (string) token type as string, e.g. "variable"
 ---        - modifiers (table) token modifiers as a set. E.g., { static = true, readonly = true }
 function M.get_at_pos(bufnr, row, col)
@@ -661,7 +661,7 @@ end
 --- Only has an effect if the buffer is currently active for semantic token
 --- highlighting (|vim.lsp.semantic_tokens.start()| has been called for it)
 ---
----@param bufnr (number|nil) filter by buffer. All buffers if nil, current
+---@param bufnr (integer|nil) filter by buffer. All buffers if nil, current
 ---       buffer if 0
 function M.force_refresh(bufnr)
   vim.validate({
@@ -689,11 +689,11 @@ end
 --- use inside |LspTokenUpdate| callbacks.
 ---@param token (table) a semantic token, found as `args.data.token` in
 ---       |LspTokenUpdate|.
----@param bufnr (number) the buffer to highlight
----@param client_id (number) The ID of the |vim.lsp.client|
+---@param bufnr (integer) the buffer to highlight
+---@param client_id (integer) The ID of the |vim.lsp.client|
 ---@param hl_group (string) Highlight group name
 ---@param opts (table|nil) Optional parameters.
----       - priority: (number|nil) Priority for the applied extmark. Defaults
+---       - priority: (integer|nil) Priority for the applied extmark. Defaults
 ---         to `vim.highlight.priorities.semantic_tokens + 3`
 function M.highlight_token(token, bufnr, client_id, hl_group, opts)
   local highlighter = STHighlighter.active[bufnr]
diff --git a/runtime/lua/vim/lsp/sync.lua b/runtime/lua/vim/lsp/sync.lua
index 826352f036..fb5b0b3194 100644
--- a/runtime/lua/vim/lsp/sync.lua
+++ b/runtime/lua/vim/lsp/sync.lua
@@ -388,9 +388,9 @@ end
 --- Returns the range table for the difference between prev and curr lines
 ---@param prev_lines table list of lines
 ---@param curr_lines table list of lines
----@param firstline number line to begin search for first difference
----@param lastline number line to begin search in old_lines for last difference
----@param new_lastline number line to begin search in new_lines for last difference
+---@param firstline integer line to begin search for first difference
+---@param lastline integer line to begin search in old_lines for last difference
+---@param new_lastline integer line to begin search in new_lines for last difference
 ---@param offset_encoding string encoding requested by language server
 ---@returns table TextDocumentContentChangeEvent see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentContentChangeEvent
 function M.compute_diff(
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 554e26022c..c9613dc7a7 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -121,9 +121,9 @@ end
 --- Convert byte index to `encoding` index.
 --- Convenience wrapper around vim.str_utfindex
 ---@param line string line to be indexed
----@param index number|nil byte index (utf-8), or `nil` for length
+---@param index integer|nil byte index (utf-8), or `nil` for length
 ---@param encoding string utf-8|utf-16|utf-32|nil defaults to utf-16
----@return number `encoding` index of `index` in `line`
+---@return integer `encoding` index of `index` in `line`
 function M._str_utfindex_enc(line, index, encoding)
   if not encoding then
     encoding = 'utf-16'
@@ -149,9 +149,9 @@ end
 --- Convenience wrapper around vim.str_byteindex
 ---Alternative to vim.str_byteindex that takes an encoding.
 ---@param line string line to be indexed
----@param index number UTF index
+---@param index integer UTF index
 ---@param encoding string utf-8|utf-16|utf-32|nil defaults to utf-16
----@return number byte (utf-8) index of `encoding` index `index` in `line`
+---@return integer byte (utf-8) index of `encoding` index `index` in `line`
 function M._str_byteindex_enc(line, index, encoding)
   if not encoding then
     encoding = 'utf-16'
@@ -239,9 +239,9 @@ end
 --- Works on unloaded buffers by reading the file using libuv to bypass buf reading events.
 --- Falls back to loading the buffer and nvim_buf_get_lines for buffers with non-file URI.
 ---
----@param bufnr number bufnr to get the lines from
----@param rows number[] zero-indexed line numbers
----@return table<number string> a table mapping rows to lines
+---@param bufnr integer bufnr to get the lines from
+---@param rows integer[] zero-indexed line numbers
+---@return table<integer, string> a table mapping rows to lines
 local function get_lines(bufnr, rows)
   rows = type(rows) == 'table' and rows or { rows }
 
@@ -321,8 +321,8 @@ end
 --- Works on unloaded buffers by reading the file using libuv to bypass buf reading events.
 --- Falls back to loading the buffer and nvim_buf_get_lines for buffers with non-file URI.
 ---
----@param bufnr number
----@param row number zero-indexed line number
+---@param bufnr integer
+---@param row integer zero-indexed line number
 ---@return string the line at row in filename
 local function get_line(bufnr, row)
   return get_lines(bufnr, { row })[row]
@@ -386,7 +386,7 @@ end
 
 --- Applies a list of text edits to a buffer.
 ---@param text_edits table list of `TextEdit` objects
----@param bufnr number Buffer id
+---@param bufnr integer Buffer id
 ---@param offset_encoding string utf-8|utf-16|utf-32
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textEdit
 function M.apply_text_edits(text_edits, bufnr, offset_encoding)
@@ -571,7 +571,7 @@ end
 --- document.
 ---
 ---@param text_document_edit table: a `TextDocumentEdit` object
----@param index number: Optional index of the edit, if from a list of edits (or nil, if not from a list)
+---@param index integer: Optional index of the edit, if from a list of edits (or nil, if not from a list)
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentEdit
 function M.apply_text_document_edit(text_document_edit, index, offset_encoding)
   local text_document = text_document_edit.textDocument
@@ -1009,11 +1009,11 @@ end
 --- Creates a table with sensible default options for a floating window. The
 --- table can be passed to |nvim_open_win()|.
 ---
----@param width (number) window width (in character cells)
----@param height (number) window height (in character cells)
+---@param width (integer) window width (in character cells)
+---@param height (integer) window height (in character cells)
 ---@param opts (table, optional)
----        - offset_x (number) offset to add to `col`
----        - offset_y (number) offset to add to `row`
+---        - offset_x (integer) offset to add to `col`
+---        - offset_y (integer) offset to add to `row`
 ---        - border (string or table) override `border`
 ---        - focusable (string or table) override `focusable`
 ---        - zindex (string or table) override `zindex`, defaults to 50
@@ -1429,7 +1429,7 @@ end
 ---@private
 --- Closes the preview window
 ---
----@param winnr number window id of preview window
+---@param winnr integer window id of preview window
 ---@param bufnrs table|nil optional list of ignored buffers
 local function close_preview_window(winnr, bufnrs)
   vim.schedule(function()
@@ -1448,7 +1448,7 @@ end
 --- Creates autocommands to close a preview window when events happen.
 ---
 ---@param events table list of events
----@param winnr number window id of preview window
+---@param winnr integer window id of preview window
 ---@param bufnrs table list of buffers where the preview window will remain visible
 ---@see |autocmd-events|
 local function close_preview_autocmd(events, winnr, bufnrs)
@@ -1556,14 +1556,14 @@ end
 ---@param contents table of lines to show in window
 ---@param syntax string of syntax to set for opened buffer
 ---@param opts table with optional fields (additional keys are passed on to |nvim_open_win()|)
----             - height: (number) height of floating window
----             - width: (number) width of floating window
+---             - height: (integer) height of floating window
+---             - width: (integer) width of floating window
 ---             - wrap: (boolean, default true) wrap long lines
----             - wrap_at: (number) character to wrap at for computing height when wrap is enabled
----             - max_width: (number) maximal width of floating window
----             - max_height: (number) maximal height of floating window
----             - pad_top: (number) number of lines to pad contents at top
----             - pad_bottom: (number) number of lines to pad contents at bottom
+---             - wrap_at: (integer) character to wrap at for computing height when wrap is enabled
+---             - max_width: (integer) maximal width of floating window
+---             - max_height: (integer) maximal height of floating window
+---             - pad_top: (integer) number of lines to pad contents at top
+---             - pad_bottom: (integer) number of lines to pad contents at bottom
 ---             - focus_id: (string) if a popup with this id is opened, then focus it
 ---             - close_events: (table) list of events that closes the floating window
 ---             - focusable: (boolean, default true) Make float focusable
@@ -1672,7 +1672,7 @@ do --[[ References ]]
 
   --- Removes document highlights from a buffer.
   ---
-  ---@param bufnr number Buffer id
+  ---@param bufnr integer Buffer id
   function M.buf_clear_references(bufnr)
     validate({ bufnr = { bufnr, 'n', true } })
     api.nvim_buf_clear_namespace(bufnr or 0, reference_ns, 0, -1)
@@ -1680,7 +1680,7 @@ do --[[ References ]]
 
   --- Shows a list of document highlights for a certain buffer.
   ---
-  ---@param bufnr number Buffer id
+  ---@param bufnr integer Buffer id
   ---@param references table List of `DocumentHighlight` objects to highlight
   ---@param offset_encoding string One of "utf-8", "utf-16", "utf-32".
   ---@see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentContentChangeEvent
@@ -1893,7 +1893,7 @@ function M.try_trim_markdown_code_blocks(lines)
 end
 
 ---@private
----@param window number|nil: window handle or 0 for current, defaults to current
+---@param window integer|nil: window handle or 0 for current, defaults to current
 ---@param offset_encoding string utf-8|utf-16|utf-32|nil defaults to `offset_encoding` of first client of buffer of `window`
 local function make_position_param(window, offset_encoding)
   window = window or 0
@@ -1913,7 +1913,7 @@ end
 
 --- Creates a `TextDocumentPositionParams` object for the current buffer and cursor position.
 ---
----@param window number|nil: window handle or 0 for current, defaults to current
+---@param window integer|nil: window handle or 0 for current, defaults to current
 ---@param offset_encoding string|nil utf-8|utf-16|utf-32|nil defaults to `offset_encoding` of first client of buffer of `window`
 ---@returns `TextDocumentPositionParams` object
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentPositionParams
@@ -1928,7 +1928,7 @@ function M.make_position_params(window, offset_encoding)
 end
 
 --- Utility function for getting the encoding of the first LSP client on the given buffer.
----@param bufnr (number) buffer handle or 0 for current, defaults to current
+---@param bufnr (integer) buffer handle or 0 for current, defaults to current
 ---@returns (string) encoding first client if there is one, nil otherwise
 function M._get_offset_encoding(bufnr)
   validate({
@@ -1966,7 +1966,7 @@ end
 --- `textDocument/codeAction`, `textDocument/colorPresentation`,
 --- `textDocument/rangeFormatting`.
 ---
----@param window number|nil: window handle or 0 for current, defaults to current
+---@param window integer|nil: window handle or 0 for current, defaults to current
 ---@param offset_encoding "utf-8"|"utf-16"|"utf-32"|nil defaults to `offset_encoding` of first client of buffer of `window`
 ---@returns { textDocument = { uri = `current_file_uri` }, range = { start =
 ---`current_position`, end = `current_position` } }
@@ -1983,11 +1983,11 @@ end
 --- Using the given range in the current buffer, creates an object that
 --- is similar to |vim.lsp.util.make_range_params()|.
 ---
----@param start_pos number[]|nil {row, col} mark-indexed position.
+---@param start_pos integer[]|nil {row, col} mark-indexed position.
 --- Defaults to the start of the last visual selection.
----@param end_pos number[]|nil {row, col} mark-indexed position.
+---@param end_pos integer[]|nil {row, col} mark-indexed position.
 --- Defaults to the end of the last visual selection.
----@param bufnr number|nil buffer handle or 0 for current, defaults to current
+---@param bufnr integer|nil buffer handle or 0 for current, defaults to current
 ---@param offset_encoding "utf-8"|"utf-16"|"utf-32"|nil defaults to `offset_encoding` of first client of `bufnr`
 ---@returns { textDocument = { uri = `current_file_uri` }, range = { start =
 ---`start_position`, end = `end_position` } }
@@ -2028,7 +2028,7 @@ end
 
 --- Creates a `TextDocumentIdentifier` object for the current buffer.
 ---
----@param bufnr number|nil: Buffer handle, defaults to current
+---@param bufnr integer|nil: Buffer handle, defaults to current
 ---@returns `TextDocumentIdentifier`
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentIdentifier
 function M.make_text_document_params(bufnr)
@@ -2049,8 +2049,8 @@ end
 --- Returns indentation size.
 ---
 ---@see 'shiftwidth'
----@param bufnr (number|nil): Buffer handle, defaults to current
----@returns (number) indentation size
+---@param bufnr (integer|nil): Buffer handle, defaults to current
+---@returns (integer) indentation size
 function M.get_effective_tabstop(bufnr)
   validate({ bufnr = { bufnr, 'n', true } })
   local bo = bufnr and vim.bo[bufnr] or vim.bo
@@ -2077,11 +2077,11 @@ end
 
 --- Returns the UTF-32 and UTF-16 offsets for a position in a certain buffer.
 ---
----@param buf number buffer number (0 for current)
+---@param buf integer buffer number (0 for current)
 ---@param row 0-indexed line
 ---@param col 0-indexed byte offset in line
 ---@param offset_encoding string utf-8|utf-16|utf-32|nil defaults to `offset_encoding` of first client of `buf`
----@returns (number, number) `offset_encoding` index of the character in line {row} column {col} in buffer {buf}
+---@returns (integer, integer) `offset_encoding` index of the character in line {row} column {col} in buffer {buf}
 function M.character_offset(buf, row, col, offset_encoding)
   local line = get_line(buf, row)
   if offset_encoding == nil then
-- 
cgit 


From 4385f8a7430f8181189f385a6cfb4e295d30b21e Mon Sep 17 00:00:00 2001
From: jdrouhard <john@drouhard.dev>
Date: Tue, 7 Mar 2023 10:35:12 -0600
Subject: fix(lsp): change LspTokenUpdate to use buffer instead of pattern
 (#22559)

---
 runtime/lua/vim/lsp/semantic_tokens.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 9eaccd539f..a5e007a011 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -435,7 +435,7 @@ function STHighlighter:on_win(topline, botline)
           token.marked = true
 
           api.nvim_exec_autocmds('LspTokenUpdate', {
-            pattern = vim.api.nvim_buf_get_name(self.bufnr),
+            buffer = self.bufnr,
             modeline = false,
             data = {
               token = token,
-- 
cgit 


From ddd257f75301a50c177fc24a693d39a45b47a689 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 8 Mar 2023 11:03:11 +0000
Subject: feat(treesitter): use upstream format for injection queries

---
 runtime/lua/vim/treesitter/_meta.lua        |   8 +-
 runtime/lua/vim/treesitter/languagetree.lua | 240 ++++++++++++++++++++--------
 runtime/lua/vim/treesitter/query.lua        |  21 +--
 3 files changed, 181 insertions(+), 88 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index 731a5ebf9f..ad0854706b 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -14,7 +14,7 @@
 ---@field child_count fun(self: TSNode): integer
 ---@field named_child_count fun(self: TSNode): integer
 ---@field child fun(self: TSNode, integer): TSNode
----@field name_child fun(self: TSNode, integer): TSNode
+---@field named_child fun(self: TSNode, integer): TSNode
 ---@field descendant_for_range fun(self: TSNode, integer, integer, integer, integer): TSNode
 ---@field named_descendant_for_range fun(self: TSNode, integer, integer, integer, integer): TSNode
 ---@field parent fun(self: TSNode): TSNode
@@ -43,10 +43,10 @@ function TSNode:_rawquery(query, captures, start, end_) end
 function TSNode:_rawquery(query, captures, start, end_) end
 
 ---@class TSParser
----@field parse fun(self: TSParser, tree, source: integer|string): TSTree, integer[]
+---@field parse fun(self: TSParser, tree, source: integer|string): TSTree, Range4[]
 ---@field reset fun(self: TSParser)
----@field included_ranges fun(self: TSParser): integer[]
----@field set_included_ranges fun(self: TSParser, ranges: integer[][])
+---@field included_ranges fun(self: TSParser): Range4[]
+---@field set_included_ranges fun(self: TSParser, ranges: Range6[])
 ---@field set_timeout fun(self: TSParser, timeout: integer)
 ---@field timeout fun(self: TSParser): integer
 
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index b8b0dd867e..fbc602486b 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -399,6 +399,169 @@ local function get_range_from_metadata(node, id, metadata)
   return { node:range() }
 end
 
+---@private
+--- TODO(lewis6991): cleanup of the node_range interface
+---@param node TSNode
+---@param id integer
+---@param metadata TSMetadata
+---@return Range4[]
+local function get_node_ranges(node, id, metadata, include_children)
+  local range = get_range_from_metadata(node, id, metadata)
+
+  if include_children then
+    return { range }
+  end
+
+  local ranges = {} ---@type Range4[]
+
+  local srow, scol, erow, ecol = range[1], range[2], range[3], range[4]
+
+  for i = 0, node:named_child_count() - 1 do
+    local child = node:named_child(i)
+    local child_srow, child_scol, child_erow, child_ecol = child:range()
+    if child_srow > srow or child_scol > scol then
+      table.insert(ranges, { srow, scol, child_srow, child_scol })
+    end
+    srow = child_erow
+    scol = child_ecol
+  end
+
+  if erow > srow or ecol > scol then
+    table.insert(ranges, { srow, scol, erow, ecol })
+  end
+
+  return ranges
+end
+
+---@alias TSInjection table<string,table<integer,table>>
+
+---@private
+---@param t table<integer,TSInjection>
+---@param tree_index integer
+---@param pattern integer
+---@param lang string
+---@param combined boolean
+---@param ranges Range4[]
+local function add_injection(t, tree_index, pattern, lang, combined, ranges)
+  assert(type(lang) == 'string')
+
+  -- Each tree index should be isolated from the other nodes.
+  if not t[tree_index] then
+    t[tree_index] = {}
+  end
+
+  if not t[tree_index][lang] then
+    t[tree_index][lang] = {}
+  end
+
+  -- Key this by pattern. If combined is set to true all captures of this pattern
+  -- will be parsed by treesitter as the same "source".
+  -- If combined is false, each "region" will be parsed as a single source.
+  if not t[tree_index][lang][pattern] then
+    t[tree_index][lang][pattern] = { combined = combined, regions = {} }
+  end
+
+  table.insert(t[tree_index][lang][pattern].regions, ranges)
+end
+
+---@private
+---Get node text
+---
+---Note: `query.get_node_text` returns string|string[]|nil so use this simple alias function
+---to annotate it returns string.
+---
+---TODO(lewis6991): use [at]overload annotations on `query.get_node_text`
+---@param node TSNode
+---@param source integer|string
+---@param metadata table
+---@return string
+local function get_node_text(node, source, metadata)
+  return query.get_node_text(node, source, { metadata = metadata }) --[[@as string]]
+end
+
+---@private
+--- Extract injections according to:
+--- https://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection
+---@param match table<integer,TSNode>
+---@param metadata table
+---@return string, boolean, Range4[]
+function LanguageTree:_get_injection(match, metadata)
+  local ranges = {} ---@type Range4[]
+  local combined = metadata['injection.combined'] ~= nil
+  local lang = metadata['injection.language'] ---@type string
+  local include_children = metadata['injection.include-children'] ~= nil
+
+  for id, node in pairs(match) do
+    local name = self._injection_query.captures[id]
+
+    -- Lang should override any other language tag
+    if name == 'injection.language' then
+      lang = get_node_text(node, self._source, metadata[id])
+    elseif name == 'injection.content' then
+      ranges = get_node_ranges(node, id, metadata, include_children)
+    end
+  end
+
+  return lang, combined, ranges
+end
+
+---@private
+---@param match table<integer,TSNode>
+---@param metadata table
+---@return string, boolean, Range4[]
+function LanguageTree:_get_injection_deprecated(match, metadata)
+  local lang = nil ---@type string
+  local ranges = {} ---@type Range4[]
+  local combined = metadata.combined ~= nil
+
+  -- Directives can configure how injections are captured as well as actual node captures.
+  -- This allows more advanced processing for determining ranges and language resolution.
+  if metadata.content then
+    local content = metadata.content ---@type any
+
+    -- Allow for captured nodes to be used
+    if type(content) == 'number' then
+      content = { match[content]:range() }
+    end
+
+    if type(content) == 'table' and #content >= 4 then
+      vim.list_extend(ranges, content)
+    end
+  end
+
+  if metadata.language then
+    lang = metadata.language ---@type string
+  end
+
+  -- You can specify the content and language together
+  -- using a tag with the language, for example
+  -- @javascript
+  for id, node in pairs(match) do
+    local name = self._injection_query.captures[id]
+
+    -- Lang should override any other language tag
+    if name == 'language' and not lang then
+      lang = get_node_text(node, self._source, metadata[id])
+    elseif name == 'combined' then
+      combined = true
+    elseif name == 'content' and #ranges == 0 then
+      table.insert(ranges, get_range_from_metadata(node, id, metadata))
+      -- Ignore any tags that start with "_"
+      -- Allows for other tags to be used in matches
+    elseif string.sub(name, 1, 1) ~= '_' then
+      if not lang then
+        lang = name
+      end
+
+      if #ranges == 0 then
+        table.insert(ranges, get_range_from_metadata(node, id, metadata))
+      end
+    end
+  end
+
+  return lang, combined, ranges
+end
+
 --- Gets language injection points by language.
 ---
 --- This is where most of the injection processing occurs.
@@ -406,13 +569,13 @@ end
 --- TODO: Allow for an offset predicate to tailor the injection range
 ---       instead of using the entire nodes range.
 ---@private
----@return table<string, integer[][]>
+---@return table<string, Range4[][]>
 function LanguageTree:_get_injections()
   if not self._injection_query then
     return {}
   end
 
-  ---@type table<integer,table<string,table<integer,table>>>
+  ---@type table<integer,TSInjection>
   local injections = {}
 
   for tree_index, tree in ipairs(self._trees) do
@@ -422,75 +585,12 @@ function LanguageTree:_get_injections()
     for pattern, match, metadata in
       self._injection_query:iter_matches(root_node, self._source, start_line, end_line + 1)
     do
-      local lang = nil ---@type string
-      local ranges = {} ---@type Range4[]
-      local combined = metadata.combined ---@type boolean
-
-      -- Directives can configure how injections are captured as well as actual node captures.
-      -- This allows more advanced processing for determining ranges and language resolution.
-      if metadata.content then
-        local content = metadata.content ---@type any
-
-        -- Allow for captured nodes to be used
-        if type(content) == 'number' then
-          content = { match[content]:range() }
-        end
-
-        if type(content) == 'table' and #content >= 4 then
-          vim.list_extend(ranges, content)
-        end
-      end
-
-      if metadata.language then
-        lang = metadata.language ---@type string
-      end
-
-      -- You can specify the content and language together
-      -- using a tag with the language, for example
-      -- @javascript
-      for id, node in pairs(match) do
-        local name = self._injection_query.captures[id]
-
-        -- Lang should override any other language tag
-        if name == 'language' and not lang then
-          ---@diagnostic disable-next-line
-          lang = query.get_node_text(node, self._source, { metadata = metadata[id] })
-        elseif name == 'combined' then
-          combined = true
-        elseif name == 'content' and #ranges == 0 then
-          table.insert(ranges, get_range_from_metadata(node, id, metadata))
-          -- Ignore any tags that start with "_"
-          -- Allows for other tags to be used in matches
-        elseif string.sub(name, 1, 1) ~= '_' then
-          if not lang then
-            lang = name
-          end
-
-          if #ranges == 0 then
-            table.insert(ranges, get_range_from_metadata(node, id, metadata))
-          end
-        end
+      local lang, combined, ranges = self:_get_injection(match, metadata)
+      if not lang then
+        -- TODO(lewis6991): remove after 0.9 (#20434)
+        lang, combined, ranges = self:_get_injection_deprecated(match, metadata)
       end
-
-      assert(type(lang) == 'string')
-
-      -- Each tree index should be isolated from the other nodes.
-      if not injections[tree_index] then
-        injections[tree_index] = {}
-      end
-
-      if not injections[tree_index][lang] then
-        injections[tree_index][lang] = {}
-      end
-
-      -- Key this by pattern. If combined is set to true all captures of this pattern
-      -- will be parsed by treesitter as the same "source".
-      -- If combined is false, each "region" will be parsed as a single source.
-      if not injections[tree_index][lang][pattern] then
-        injections[tree_index][lang][pattern] = { combined = combined, regions = {} }
-      end
-
-      table.insert(injections[tree_index][lang][pattern].regions, ranges)
+      add_injection(injections, tree_index, pattern, lang, combined, ranges)
     end
   end
 
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 22f706585e..59894cc7f5 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -407,7 +407,7 @@ predicate_handlers['vim-match?'] = predicate_handlers['match?']
 ---@field [string] integer|string
 ---@field range Range4
 
----@alias TSDirective fun(match: TSMatch, _, _, predicate: any[], metadata: TSMetadata)
+---@alias TSDirective fun(match: TSMatch, _, _, predicate: (string|integer)[], metadata: TSMetadata)
 
 -- Predicate handler receive the following arguments
 -- (match, pattern, bufnr, predicate)
@@ -419,24 +419,17 @@ predicate_handlers['vim-match?'] = predicate_handlers['match?']
 ---@type table<string,TSDirective>
 local directive_handlers = {
   ['set!'] = function(_, _, _, pred, metadata)
-    if #pred == 4 then
-      -- (#set! @capture "key" "value")
-      ---@diagnostic disable-next-line:no-unknown
-      local _, capture_id, key, value = unpack(pred)
-      ---@cast value integer|string
-      ---@cast capture_id integer
-      ---@cast key string
+    if #pred >= 3 and type(pred[2]) == 'number' then
+      -- (#set! @capture key value)
+      local capture_id, key, value = pred[2], pred[3], pred[4]
       if not metadata[capture_id] then
         metadata[capture_id] = {}
       end
       metadata[capture_id][key] = value
     else
-      ---@diagnostic disable-next-line:no-unknown
-      local _, key, value = unpack(pred)
-      ---@cast value integer|string
-      ---@cast key string
-      -- (#set! "key" "value")
-      metadata[key] = value
+      -- (#set! key value)
+      local key, value = pred[2], pred[3]
+      metadata[key] = value or true
     end
   end,
   -- Shifts the range of a node.
-- 
cgit 


From 276b647fdba07bf1762d8dd371c4b655b8a418df Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 8 Mar 2023 17:22:28 +0000
Subject: refactor(treesitter): delegate region calculation to treesitter
 (#22553)

---
 runtime/lua/vim/treesitter/_meta.lua        |   7 +-
 runtime/lua/vim/treesitter/_range.lua       |  28 +-
 runtime/lua/vim/treesitter/languagetree.lua | 410 +++++++++++++++++-----------
 runtime/lua/vim/treesitter/query.lua        |   1 +
 4 files changed, 271 insertions(+), 175 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index ad0854706b..72823ccf26 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -3,7 +3,7 @@
 ---@class TSNode
 ---@field id fun(self: TSNode): integer
 ---@field tree fun(self: TSNode): TSTree
----@field range fun(self: TSNode): integer, integer, integer, integer
+---@field range fun(self: TSNode, include_bytes: boolean?): integer, integer, integer, integer, integer, integer
 ---@field start fun(self: TSNode): integer, integer, integer
 ---@field end_ fun(self: TSNode): integer, integer, integer
 ---@field type fun(self: TSNode): string
@@ -43,9 +43,9 @@ function TSNode:_rawquery(query, captures, start, end_) end
 function TSNode:_rawquery(query, captures, start, end_) end
 
 ---@class TSParser
----@field parse fun(self: TSParser, tree, source: integer|string): TSTree, Range4[]
+---@field parse fun(self: TSParser, tree: TSTree?, source: integer|string, include_bytes: boolean?): TSTree, integer[]
 ---@field reset fun(self: TSParser)
----@field included_ranges fun(self: TSParser): Range4[]
+---@field included_ranges fun(self: TSParser, include_bytes: boolean?): integer[]
 ---@field set_included_ranges fun(self: TSParser, ranges: Range6[])
 ---@field set_timeout fun(self: TSParser, timeout: integer)
 ---@field timeout fun(self: TSParser): integer
@@ -54,6 +54,7 @@ function TSNode:_rawquery(query, captures, start, end_) end
 ---@field root fun(self: TSTree): TSNode
 ---@field edit fun(self: TSTree, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _:integer)
 ---@field copy fun(self: TSTree): TSTree
+---@field included_ranges fun(self: TSTree, include_bytes: boolean?): integer[]
 
 ---@return integer
 vim._ts_get_language_version = function() end
diff --git a/runtime/lua/vim/treesitter/_range.lua b/runtime/lua/vim/treesitter/_range.lua
index bec24a23a5..21e46a560a 100644
--- a/runtime/lua/vim/treesitter/_range.lua
+++ b/runtime/lua/vim/treesitter/_range.lua
@@ -78,11 +78,8 @@ end
 ---@param r2 Range4|Range6
 ---@return boolean
 function M.intercepts(r1, r2)
-  local off_1 = #r1 == 6 and 1 or 0
-  local off_2 = #r1 == 6 and 1 or 0
-
-  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r1[2], r1[3 + off_1], r1[4 + off_1]
-  local srow_2, scol_2, erow_2, ecol_2 = r2[1], r2[2], r2[3 + off_2], r2[4 + off_2]
+  local srow_1, scol_1, erow_1, ecol_1 = M.unpack4(r1)
+  local srow_2, scol_2, erow_2, ecol_2 = M.unpack4(r2)
 
   -- r1 is above r2
   if M.cmp_pos.le(erow_1, ecol_1, srow_2, scol_2) then
@@ -97,16 +94,21 @@ function M.intercepts(r1, r2)
   return true
 end
 
+---@private
+---@param r Range4|Range6
+---@return integer, integer, integer, integer
+function M.unpack4(r)
+  local off_1 = #r == 6 and 1 or 0
+  return r[1], r[2], r[3 + off_1], r[4 + off_1]
+end
+
 ---@private
 ---@param r1 Range4|Range6
 ---@param r2 Range4|Range6
 ---@return boolean whether r1 contains r2
 function M.contains(r1, r2)
-  local off_1 = #r1 == 6 and 1 or 0
-  local off_2 = #r1 == 6 and 1 or 0
-
-  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r1[2], r1[3 + off_1], r1[4 + off_1]
-  local srow_2, scol_2, erow_2, ecol_2 = r2[1], r2[2], r2[3 + off_2], r2[4 + off_2]
+  local srow_1, scol_1, erow_1, ecol_1 = M.unpack4(r1)
+  local srow_2, scol_2, erow_2, ecol_2 = M.unpack4(r2)
 
   -- start doesn't fit
   if M.cmp_pos.gt(srow_1, scol_1, srow_2, scol_2) then
@@ -123,9 +125,13 @@ end
 
 ---@private
 ---@param source integer|string
----@param range Range4
+---@param range Range4|Range6
 ---@return Range6
 function M.add_bytes(source, range)
+  if type(range) == 'table' and #range == 6 then
+    return range --[[@as Range6]]
+  end
+
   local start_row, start_col, end_row, end_col = range[1], range[2], range[3], range[4]
   local start_byte = 0
   local end_byte = 0
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index fbc602486b..57a60bf774 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -57,13 +57,13 @@ local Range = require('vim.treesitter._range')
 ---@field private _injection_query Query Queries defining injected languages
 ---@field private _opts table Options
 ---@field private _parser TSParser Parser for language
----@field private _regions Range6[][] List of regions this tree should manage and parse
+---@field private _regions Range6[][]?
+---List of regions this tree should manage and parse. If nil then regions are
+---taken from _trees. This is mostly a short-lived cache for included_regions()
 ---@field private _lang string Language name
 ---@field private _source (integer|string) Buffer or string to parse
 ---@field private _trees TSTree[] Reference to parsed tree (one for each language)
 ---@field private _valid boolean|table<integer,boolean> If the parsed tree is valid
---- TODO(lewis6991): combine _regions, _valid and _trees
----@field private _is_child boolean
 local LanguageTree = {}
 
 ---@class LanguageTreeOpts
@@ -98,7 +98,6 @@ function LanguageTree.new(source, lang, opts)
     _source = source,
     _lang = lang,
     _children = {},
-    _regions = {},
     _trees = {},
     _opts = opts,
     _injection_query = injections[lang] and query.parse_query(lang, injections[lang])
@@ -117,6 +116,48 @@ function LanguageTree.new(source, lang, opts)
   return self
 end
 
+---@private
+---Measure execution time of a function
+---@generic R1, R2, R3
+---@param f fun(): R1, R2, R2
+---@return integer, R1, R2, R3
+local function tcall(f, ...)
+  local start = vim.loop.hrtime()
+  ---@diagnostic disable-next-line
+  local r = { f(...) }
+  local duration = (vim.loop.hrtime() - start) / 1000000
+  return duration, unpack(r)
+end
+
+---@private
+---@vararg any
+function LanguageTree:_log(...)
+  if vim.g.__ts_debug == nil then
+    return
+  end
+
+  local args = { ... }
+  if type(args[1]) == 'function' then
+    args = { args[1]() }
+  end
+
+  local info = debug.getinfo(2, 'nl')
+  local nregions = #self:included_regions()
+  local prefix =
+    string.format('%s:%d: [%s:%d] ', info.name, info.currentline, self:lang(), nregions)
+
+  a.nvim_out_write(prefix)
+  for _, x in ipairs(args) do
+    if type(x) == 'string' then
+      a.nvim_out_write(x)
+    else
+      a.nvim_out_write(vim.inspect(x, { newline = ' ', indent = '' }))
+    end
+    a.nvim_out_write(' ')
+  end
+  a.nvim_out_write('\n')
+end
+
 --- Invalidates this parser and all its children
 ---@param reload boolean|nil
 function LanguageTree:invalidate(reload)
@@ -146,7 +187,9 @@ end
 --- Determines whether this tree is valid.
 --- If the tree is invalid, call `parse()`.
 --- This will return the updated tree.
-function LanguageTree:is_valid()
+---@param exclude_children boolean|nil
+---@return boolean
+function LanguageTree:is_valid(exclude_children)
   local valid = self._valid
 
   if type(valid) == 'table' then
@@ -155,9 +198,18 @@ function LanguageTree:is_valid()
         return false
       end
     end
-    return true
   end
 
+  if not exclude_children then
+    for _, child in pairs(self._children) do
+      if not child:is_valid(exclude_children) then
+        return false
+      end
+    end
+  end
+
+  assert(type(valid) == 'boolean')
+
   return valid
 end
 
@@ -171,16 +223,6 @@ function LanguageTree:source()
   return self._source
 end
 
----@private
----This is only exposed so it can be wrapped for profiling
----@param old_tree TSTree
----@return TSTree, integer[]
-function LanguageTree:_parse_tree(old_tree)
-  local tree, tree_changes = self._parser:parse(old_tree, self._source)
-  self:_do_callback('changedtree', tree_changes, tree)
-  return tree, tree_changes
-end
-
 --- Parses all defined regions using a treesitter parser
 --- for the language this tree represents.
 --- This will run the injection query for this language to
@@ -190,31 +232,39 @@ end
 ---@return table|nil Change list
 function LanguageTree:parse()
   if self:is_valid() then
+    self:_log('valid')
     return self._trees
   end
 
   local changes = {}
 
-  -- If there are no ranges, set to an empty list
-  -- so the included ranges in the parser are cleared.
-  if #self._regions > 0 then
-    for i, ranges in ipairs(self._regions) do
+  -- Collect some stats
+  local regions_parsed = 0
+  local total_parse_time = 0
+
+  --- At least 1 region is invalid
+  if not self:is_valid(true) then
+    -- If there are no ranges, set to an empty list
+    -- so the included ranges in the parser are cleared.
+    for i, ranges in ipairs(self:included_regions()) do
       if not self._valid or not self._valid[i] then
         self._parser:set_included_ranges(ranges)
-        local tree, tree_changes = self:_parse_tree(self._trees[i])
+        local parse_time, tree, tree_changes =
+          tcall(self._parser.parse, self._parser, self._trees[i], self._source)
+
+        self:_do_callback('changedtree', tree_changes, tree)
         self._trees[i] = tree
         vim.list_extend(changes, tree_changes)
+
+        total_parse_time = total_parse_time + parse_time
+        regions_parsed = regions_parsed + 1
       end
     end
-  else
-    local tree, tree_changes = self:_parse_tree(self._trees[1])
-    self._trees = { tree }
-    changes = tree_changes
   end
 
-  local injections_by_lang = self:_get_injections()
   local seen_langs = {} ---@type table<string,boolean>
 
+  local query_time, injections_by_lang = tcall(self._get_injections, self)
   for lang, injection_ranges in pairs(injections_by_lang) do
     local has_lang = pcall(language.add, lang)
 
@@ -229,15 +279,6 @@ function LanguageTree:parse()
       end
 
       child:set_included_regions(injection_ranges)
-
-      local _, child_changes = child:parse()
-
-      -- Propagate any child changes so they are included in the
-      -- the change list for the callback.
-      if child_changes then
-        vim.list_extend(changes, child_changes)
-      end
-
       seen_langs[lang] = true
     end
   end
@@ -248,6 +289,23 @@ function LanguageTree:parse()
     end
   end
 
+  self:_log({
+    changes = changes,
+    regions_parsed = regions_parsed,
+    parse_time = total_parse_time,
+    query_time = query_time,
+  })
+
+  self:for_each_child(function(child)
+    local _, child_changes = child:parse()
+
+    -- Propagate any child changes so they are included in the
+    -- the change list for the callback.
+    if child_changes then
+      vim.list_extend(changes, child_changes)
+    end
+  end)
+
   self._valid = true
 
   return self._trees, changes
@@ -295,8 +353,6 @@ function LanguageTree:add_child(lang)
   end
 
   self._children[lang] = LanguageTree.new(self._source, lang, self._opts)
-  self._children[lang]._is_child = true
-
   self:invalidate()
   self:_do_callback('child_added', self._children[lang])
 
@@ -331,6 +387,53 @@ function LanguageTree:destroy()
   end
 end
 
+---@private
+---@param region Range6[]
+local function region_tostr(region)
+  local srow, scol = region[1][1], region[1][2]
+  local erow, ecol = region[#region][4], region[#region][5]
+  return string.format('[%d:%d-%d:%d]', srow, scol, erow, ecol)
+end
+
+---@private
+---Sets self._valid properly and efficiently
+---@param fn fun(index: integer, region: Range6[]): boolean
+function LanguageTree:_validate_regions(fn)
+  if not self._valid then
+    return
+  end
+
+  if type(self._valid) ~= 'table' then
+    self._valid = {}
+  end
+
+  local all_valid = true
+
+  for i, region in ipairs(self:included_regions()) do
+    if self._valid[i] == nil then
+      self._valid[i] = true
+    end
+
+    if self._valid[i] then
+      self._valid[i] = fn(i, region)
+      if not self._valid[i] then
+        self:_log(function()
+          return 'invalidating region', i, region_tostr(region)
+        end)
+      end
+    end
+
+    if not self._valid[i] then
+      all_valid = false
+    end
+  end
+
+  -- Compress the valid value to 'true' if there are no invalid regions
+  if all_valid then
+    self._valid = all_valid
+  end
+end
+
 --- Sets the included regions that should be parsed by this |LanguageTree|.
 --- A region is a set of nodes and/or ranges that will be parsed in the same context.
 ---
@@ -357,56 +460,57 @@ function LanguageTree:set_included_regions(regions)
     end
   end
 
-  if #self._regions ~= #regions then
+  if #self:included_regions() ~= #regions then
     self._trees = {}
     self:invalidate()
-  elseif self._valid ~= false then
-    if self._valid == true then
-      self._valid = {}
-      for i = 1, #regions do
-        self._valid[i] = true
-      end
-    end
-
-    for i = 1, #regions do
-      if not vim.deep_equal(self._regions[i], regions[i]) then
-        self._valid[i] = false
-      end
-
-      if not self._valid[i] then
-        self._trees[i] = nil
-      end
-    end
+  else
+    self:_validate_regions(function(i, region)
+      return vim.deep_equal(regions[i], region)
+    end)
   end
-
   self._regions = regions
 end
 
---- Gets the set of included regions
+---Gets the set of included regions
+---@return integer[][]
 function LanguageTree:included_regions()
-  return self._regions
+  if self._regions then
+    return self._regions
+  end
+
+  if #self._trees == 0 then
+    return { {} }
+  end
+
+  local regions = {} ---@type Range6[][]
+  for i, _ in ipairs(self._trees) do
+    regions[i] = self._trees[i]:included_ranges(true)
+  end
+
+  self._regions = regions
+  return regions
 end
 
 ---@private
 ---@param node TSNode
----@param id integer
+---@param source integer|string
 ---@param metadata TSMetadata
----@return Range4
-local function get_range_from_metadata(node, id, metadata)
-  if metadata[id] and metadata[id].range then
-    return metadata[id].range --[[@as Range4]]
+---@return Range6
+local function get_range_from_metadata(node, source, metadata)
+  if metadata and metadata.range then
+    return Range.add_bytes(source, metadata.range --[[@as Range4|Range6]])
   end
-  return { node:range() }
+  return { node:range(true) }
 end
 
 ---@private
 --- TODO(lewis6991): cleanup of the node_range interface
 ---@param node TSNode
----@param id integer
+---@param source string|integer
 ---@param metadata TSMetadata
 ---@return Range4[]
-local function get_node_ranges(node, id, metadata, include_children)
-  local range = get_range_from_metadata(node, id, metadata)
+local function get_node_ranges(node, source, metadata, include_children)
+  local range = get_range_from_metadata(node, source, metadata)
 
   if include_children then
     return { range }
@@ -414,7 +518,7 @@ local function get_node_ranges(node, id, metadata, include_children)
 
   local ranges = {} ---@type Range4[]
 
-  local srow, scol, erow, ecol = range[1], range[2], range[3], range[4]
+  local srow, scol, erow, ecol = Range.unpack4(range)
 
   for i = 0, node:named_child_count() - 1 do
     local child = node:named_child(i)
@@ -498,7 +602,7 @@ function LanguageTree:_get_injection(match, metadata)
     if name == 'injection.language' then
       lang = get_node_text(node, self._source, metadata[id])
     elseif name == 'injection.content' then
-      ranges = get_node_ranges(node, id, metadata, include_children)
+      ranges = get_node_ranges(node, self._source, metadata[id], include_children)
     end
   end
 
@@ -545,7 +649,7 @@ function LanguageTree:_get_injection_deprecated(match, metadata)
     elseif name == 'combined' then
       combined = true
     elseif name == 'content' and #ranges == 0 then
-      table.insert(ranges, get_range_from_metadata(node, id, metadata))
+      table.insert(ranges, get_range_from_metadata(node, self._source, metadata[id]))
       -- Ignore any tags that start with "_"
       -- Allows for other tags to be used in matches
     elseif string.sub(name, 1, 1) ~= '_' then
@@ -554,7 +658,7 @@ function LanguageTree:_get_injection_deprecated(match, metadata)
       end
 
       if #ranges == 0 then
-        table.insert(ranges, get_range_from_metadata(node, id, metadata))
+        table.insert(ranges, get_range_from_metadata(node, self._source, metadata[id]))
       end
     end
   end
@@ -569,7 +673,7 @@ end
 --- TODO: Allow for an offset predicate to tailor the injection range
 ---       instead of using the entire nodes range.
 ---@private
----@return table<string, Range4[][]>
+---@return table<string, Range6[][]>
 function LanguageTree:_get_injections()
   if not self._injection_query then
     return {}
@@ -594,7 +698,7 @@ function LanguageTree:_get_injections()
     end
   end
 
-  ---@type table<string,Range4[][]>
+  ---@type table<string,Range6[][]>
   local result = {}
 
   -- Generate a map by lang of node lists.
@@ -634,42 +738,51 @@ function LanguageTree:_do_callback(cb_name, ...)
 end
 
 ---@private
----@param regions Range6[][]
----@param old_range Range6
----@param new_range Range6
----@return table<integer,boolean> region indices to invalidate
-local function update_regions(regions, old_range, new_range)
-  ---@type table<integer,boolean>
-  local valid = {}
-
-  for i, ranges in ipairs(regions or {}) do
-    valid[i] = true
-    for j, r in ipairs(ranges) do
-      if Range.intercepts(r, old_range) then
-        valid[i] = false
-        break
-      end
+function LanguageTree:_edit(
+  start_byte,
+  end_byte_old,
+  end_byte_new,
+  start_row,
+  start_col,
+  end_row_old,
+  end_col_old,
+  end_row_new,
+  end_col_new
+)
+  for _, tree in ipairs(self._trees) do
+    tree:edit(
+      start_byte,
+      end_byte_old,
+      end_byte_new,
+      start_row,
+      start_col,
+      end_row_old,
+      end_col_old,
+      end_row_new,
+      end_col_new
+    )
+  end
+
+  self._regions = nil
+
+  local changed_range = {
+    start_row,
+    start_col,
+    start_byte,
+    end_row_old,
+    end_col_old,
+    end_byte_old,
+  }
 
-      -- Range after change. Adjust
-      if Range.cmp_pos.gt(r[1], r[2], old_range[4], old_range[5]) then
-        local byte_offset = new_range[6] - old_range[6]
-        local row_offset = new_range[4] - old_range[4]
-
-        -- Update the range to avoid invalidation in set_included_regions()
-        -- which will compare the regions against the parsed injection regions
-        ranges[j] = {
-          r[1] + row_offset,
-          r[2],
-          r[3] + byte_offset,
-          r[4] + row_offset,
-          r[5],
-          r[6] + byte_offset,
-        }
+  -- Validate regions after editing the tree
+  self:_validate_regions(function(_, region)
+    for _, r in ipairs(region) do
+      if Range.intercepts(r, changed_range) then
+        return false
       end
     end
-  end
-
-  return valid
+    return true
+  end)
 end
 
 ---@private
@@ -700,49 +813,26 @@ function LanguageTree:_on_bytes(
   local old_end_col = old_col + ((old_row == 0) and start_col or 0)
   local new_end_col = new_col + ((new_row == 0) and start_col or 0)
 
-  local old_range = {
-    start_row,
-    start_col,
-    start_byte,
-    start_row + old_row,
-    old_end_col,
-    start_byte + old_byte,
-  }
-
-  local new_range = {
+  self:_log(
+    'on_bytes',
+    bufnr,
+    changed_tick,
     start_row,
     start_col,
     start_byte,
-    start_row + new_row,
-    new_end_col,
-    start_byte + new_byte,
-  }
-
-  if #self._regions == 0 then
-    self._valid = false
-  else
-    self._valid = update_regions(self._regions, old_range, new_range)
-  end
-
-  for _, child in pairs(self._children) do
-    child:_on_bytes(
-      bufnr,
-      changed_tick,
-      start_row,
-      start_col,
-      start_byte,
-      old_row,
-      old_col,
-      old_byte,
-      new_row,
-      new_col,
-      new_byte
-    )
-  end
+    old_row,
+    old_col,
+    old_byte,
+    new_row,
+    new_col,
+    new_byte
+  )
 
   -- Edit trees together BEFORE emitting a bytes callback.
-  for _, tree in ipairs(self._trees) do
-    tree:edit(
+  ---@private
+  self:for_each_child(function(child)
+    ---@diagnostic disable-next-line:invisible
+    child:_edit(
       start_byte,
       start_byte + old_byte,
       start_byte + new_byte,
@@ -753,24 +843,22 @@ function LanguageTree:_on_bytes(
       start_row + new_row,
       new_end_col
     )
-  end
+  end, true)
 
-  if not self._is_child then
-    self:_do_callback(
-      'bytes',
-      bufnr,
-      changed_tick,
-      start_row,
-      start_col,
-      start_byte,
-      old_row,
-      old_col,
-      old_byte,
-      new_row,
-      new_col,
-      new_byte
-    )
-  end
+  self:_do_callback(
+    'bytes',
+    bufnr,
+    changed_tick,
+    start_row,
+    start_col,
+    start_byte,
+    old_row,
+    old_col,
+    old_byte,
+    new_row,
+    new_col,
+    new_byte
+  )
 end
 
 ---@private
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 59894cc7f5..e7cf42283d 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -277,6 +277,7 @@ end
 ---@return (string[]|string|nil)
 function M.get_node_text(node, source, opts)
   opts = opts or {}
+  -- TODO(lewis6991): concat only works when source is number.
   local concat = vim.F.if_nil(opts.concat, true)
   local metadata = opts.metadata or {}
 
-- 
cgit 


From b9f19d3e286d95d9209afbc479fa2eb908067fb1 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 8 Mar 2023 17:59:45 +0000
Subject: Revert "refactor(treesitter): delegate region calculation to
 treesitter" (#22575)

Revert "refactor(treesitter): delegate region calculation to treesitter (#22553)"

This reverts commit 276b647fdba07bf1762d8dd371c4b655b8a418df.
---
 runtime/lua/vim/treesitter/_meta.lua        |   7 +-
 runtime/lua/vim/treesitter/_range.lua       |  28 +-
 runtime/lua/vim/treesitter/languagetree.lua | 410 +++++++++++-----------------
 runtime/lua/vim/treesitter/query.lua        |   1 -
 4 files changed, 175 insertions(+), 271 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index 72823ccf26..ad0854706b 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -3,7 +3,7 @@
 ---@class TSNode
 ---@field id fun(self: TSNode): integer
 ---@field tree fun(self: TSNode): TSTree
----@field range fun(self: TSNode, include_bytes: boolean?): integer, integer, integer, integer, integer, integer
+---@field range fun(self: TSNode): integer, integer, integer, integer
 ---@field start fun(self: TSNode): integer, integer, integer
 ---@field end_ fun(self: TSNode): integer, integer, integer
 ---@field type fun(self: TSNode): string
@@ -43,9 +43,9 @@ function TSNode:_rawquery(query, captures, start, end_) end
 function TSNode:_rawquery(query, captures, start, end_) end
 
 ---@class TSParser
----@field parse fun(self: TSParser, tree: TSTree?, source: integer|string, include_bytes: boolean?): TSTree, integer[]
+---@field parse fun(self: TSParser, tree, source: integer|string): TSTree, Range4[]
 ---@field reset fun(self: TSParser)
----@field included_ranges fun(self: TSParser, include_bytes: boolean?): integer[]
+---@field included_ranges fun(self: TSParser): Range4[]
 ---@field set_included_ranges fun(self: TSParser, ranges: Range6[])
 ---@field set_timeout fun(self: TSParser, timeout: integer)
 ---@field timeout fun(self: TSParser): integer
@@ -54,7 +54,6 @@ function TSNode:_rawquery(query, captures, start, end_) end
 ---@field root fun(self: TSTree): TSNode
 ---@field edit fun(self: TSTree, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _:integer)
 ---@field copy fun(self: TSTree): TSTree
----@field included_ranges fun(self: TSTree, include_bytes: boolean?): integer[]
 
 ---@return integer
 vim._ts_get_language_version = function() end
diff --git a/runtime/lua/vim/treesitter/_range.lua b/runtime/lua/vim/treesitter/_range.lua
index 21e46a560a..bec24a23a5 100644
--- a/runtime/lua/vim/treesitter/_range.lua
+++ b/runtime/lua/vim/treesitter/_range.lua
@@ -78,8 +78,11 @@ end
 ---@param r2 Range4|Range6
 ---@return boolean
 function M.intercepts(r1, r2)
-  local srow_1, scol_1, erow_1, ecol_1 = M.unpack4(r1)
-  local srow_2, scol_2, erow_2, ecol_2 = M.unpack4(r2)
+  local off_1 = #r1 == 6 and 1 or 0
+  local off_2 = #r1 == 6 and 1 or 0
+
+  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r1[2], r1[3 + off_1], r1[4 + off_1]
+  local srow_2, scol_2, erow_2, ecol_2 = r2[1], r2[2], r2[3 + off_2], r2[4 + off_2]
 
   -- r1 is above r2
   if M.cmp_pos.le(erow_1, ecol_1, srow_2, scol_2) then
@@ -94,21 +97,16 @@ function M.intercepts(r1, r2)
   return true
 end
 
----@private
----@param r Range4|Range6
----@return integer, integer, integer, integer
-function M.unpack4(r)
-  local off_1 = #r == 6 and 1 or 0
-  return r[1], r[2], r[3 + off_1], r[4 + off_1]
-end
-
 ---@private
 ---@param r1 Range4|Range6
 ---@param r2 Range4|Range6
 ---@return boolean whether r1 contains r2
 function M.contains(r1, r2)
-  local srow_1, scol_1, erow_1, ecol_1 = M.unpack4(r1)
-  local srow_2, scol_2, erow_2, ecol_2 = M.unpack4(r2)
+  local off_1 = #r1 == 6 and 1 or 0
+  local off_2 = #r1 == 6 and 1 or 0
+
+  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r1[2], r1[3 + off_1], r1[4 + off_1]
+  local srow_2, scol_2, erow_2, ecol_2 = r2[1], r2[2], r2[3 + off_2], r2[4 + off_2]
 
   -- start doesn't fit
   if M.cmp_pos.gt(srow_1, scol_1, srow_2, scol_2) then
@@ -125,13 +123,9 @@ end
 
 ---@private
 ---@param source integer|string
----@param range Range4|Range6
+---@param range Range4
 ---@return Range6
 function M.add_bytes(source, range)
-  if type(range) == 'table' and #range == 6 then
-    return range --[[@as Range6]]
-  end
-
   local start_row, start_col, end_row, end_col = range[1], range[2], range[3], range[4]
   local start_byte = 0
   local end_byte = 0
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 57a60bf774..fbc602486b 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -57,13 +57,13 @@ local Range = require('vim.treesitter._range')
 ---@field private _injection_query Query Queries defining injected languages
 ---@field private _opts table Options
 ---@field private _parser TSParser Parser for language
----@field private _regions Range6[][]?
----List of regions this tree should manage and parse. If nil then regions are
----taken from _trees. This is mostly a short-lived cache for included_regions()
+---@field private _regions Range6[][] List of regions this tree should manage and parse
 ---@field private _lang string Language name
 ---@field private _source (integer|string) Buffer or string to parse
 ---@field private _trees TSTree[] Reference to parsed tree (one for each language)
 ---@field private _valid boolean|table<integer,boolean> If the parsed tree is valid
+--- TODO(lewis6991): combine _regions, _valid and _trees
+---@field private _is_child boolean
 local LanguageTree = {}
 
 ---@class LanguageTreeOpts
@@ -98,6 +98,7 @@ function LanguageTree.new(source, lang, opts)
     _source = source,
     _lang = lang,
     _children = {},
+    _regions = {},
     _trees = {},
     _opts = opts,
     _injection_query = injections[lang] and query.parse_query(lang, injections[lang])
@@ -116,48 +117,6 @@ function LanguageTree.new(source, lang, opts)
   return self
 end
 
----@private
----Measure execution time of a function
----@generic R1, R2, R3
----@param f fun(): R1, R2, R2
----@return integer, R1, R2, R3
-local function tcall(f, ...)
-  local start = vim.loop.hrtime()
-  ---@diagnostic disable-next-line
-  local r = { f(...) }
-  local duration = (vim.loop.hrtime() - start) / 1000000
-  return duration, unpack(r)
-end
-
----@private
----@vararg any
-function LanguageTree:_log(...)
-  if vim.g.__ts_debug == nil then
-    return
-  end
-
-  local args = { ... }
-  if type(args[1]) == 'function' then
-    args = { args[1]() }
-  end
-
-  local info = debug.getinfo(2, 'nl')
-  local nregions = #self:included_regions()
-  local prefix =
-    string.format('%s:%d: [%s:%d] ', info.name, info.currentline, self:lang(), nregions)
-
-  a.nvim_out_write(prefix)
-  for _, x in ipairs(args) do
-    if type(x) == 'string' then
-      a.nvim_out_write(x)
-    else
-      a.nvim_out_write(vim.inspect(x, { newline = ' ', indent = '' }))
-    end
-    a.nvim_out_write(' ')
-  end
-  a.nvim_out_write('\n')
-end
-
 --- Invalidates this parser and all its children
 ---@param reload boolean|nil
 function LanguageTree:invalidate(reload)
@@ -187,9 +146,7 @@ end
 --- Determines whether this tree is valid.
 --- If the tree is invalid, call `parse()`.
 --- This will return the updated tree.
----@param exclude_children boolean|nil
----@return boolean
-function LanguageTree:is_valid(exclude_children)
+function LanguageTree:is_valid()
   local valid = self._valid
 
   if type(valid) == 'table' then
@@ -198,18 +155,9 @@ function LanguageTree:is_valid(exclude_children)
         return false
       end
     end
+    return true
   end
 
-  if not exclude_children then
-    for _, child in pairs(self._children) do
-      if not child:is_valid(exclude_children) then
-        return false
-      end
-    end
-  end
-
-  assert(type(valid) == 'boolean')
-
   return valid
 end
 
@@ -223,6 +171,16 @@ function LanguageTree:source()
   return self._source
 end
 
+---@private
+---This is only exposed so it can be wrapped for profiling
+---@param old_tree TSTree
+---@return TSTree, integer[]
+function LanguageTree:_parse_tree(old_tree)
+  local tree, tree_changes = self._parser:parse(old_tree, self._source)
+  self:_do_callback('changedtree', tree_changes, tree)
+  return tree, tree_changes
+end
+
 --- Parses all defined regions using a treesitter parser
 --- for the language this tree represents.
 --- This will run the injection query for this language to
@@ -232,39 +190,31 @@ end
 ---@return table|nil Change list
 function LanguageTree:parse()
   if self:is_valid() then
-    self:_log('valid')
     return self._trees
   end
 
   local changes = {}
 
-  -- Collect some stats
-  local regions_parsed = 0
-  local total_parse_time = 0
-
-  --- At least 1 region is invalid
-  if not self:is_valid(true) then
-    -- If there are no ranges, set to an empty list
-    -- so the included ranges in the parser are cleared.
-    for i, ranges in ipairs(self:included_regions()) do
+  -- If there are no ranges, set to an empty list
+  -- so the included ranges in the parser are cleared.
+  if #self._regions > 0 then
+    for i, ranges in ipairs(self._regions) do
       if not self._valid or not self._valid[i] then
         self._parser:set_included_ranges(ranges)
-        local parse_time, tree, tree_changes =
-          tcall(self._parser.parse, self._parser, self._trees[i], self._source)
-
-        self:_do_callback('changedtree', tree_changes, tree)
+        local tree, tree_changes = self:_parse_tree(self._trees[i])
         self._trees[i] = tree
         vim.list_extend(changes, tree_changes)
-
-        total_parse_time = total_parse_time + parse_time
-        regions_parsed = regions_parsed + 1
       end
     end
+  else
+    local tree, tree_changes = self:_parse_tree(self._trees[1])
+    self._trees = { tree }
+    changes = tree_changes
   end
 
+  local injections_by_lang = self:_get_injections()
   local seen_langs = {} ---@type table<string,boolean>
 
-  local query_time, injections_by_lang = tcall(self._get_injections, self)
   for lang, injection_ranges in pairs(injections_by_lang) do
     local has_lang = pcall(language.add, lang)
 
@@ -279,6 +229,15 @@ function LanguageTree:parse()
       end
 
       child:set_included_regions(injection_ranges)
+
+      local _, child_changes = child:parse()
+
+      -- Propagate any child changes so they are included in the
+      -- the change list for the callback.
+      if child_changes then
+        vim.list_extend(changes, child_changes)
+      end
+
       seen_langs[lang] = true
     end
   end
@@ -289,23 +248,6 @@ function LanguageTree:parse()
     end
   end
 
-  self:_log({
-    changes = changes,
-    regions_parsed = regions_parsed,
-    parse_time = total_parse_time,
-    query_time = query_time,
-  })
-
-  self:for_each_child(function(child)
-    local _, child_changes = child:parse()
-
-    -- Propagate any child changes so they are included in the
-    -- the change list for the callback.
-    if child_changes then
-      vim.list_extend(changes, child_changes)
-    end
-  end)
-
   self._valid = true
 
   return self._trees, changes
@@ -353,6 +295,8 @@ function LanguageTree:add_child(lang)
   end
 
   self._children[lang] = LanguageTree.new(self._source, lang, self._opts)
+  self._children[lang]._is_child = true
+
   self:invalidate()
   self:_do_callback('child_added', self._children[lang])
 
@@ -387,53 +331,6 @@ function LanguageTree:destroy()
   end
 end
 
----@private
----@param region Range6[]
-local function region_tostr(region)
-  local srow, scol = region[1][1], region[1][2]
-  local erow, ecol = region[#region][4], region[#region][5]
-  return string.format('[%d:%d-%d:%d]', srow, scol, erow, ecol)
-end
-
----@private
----Sets self._valid properly and efficiently
----@param fn fun(index: integer, region: Range6[]): boolean
-function LanguageTree:_validate_regions(fn)
-  if not self._valid then
-    return
-  end
-
-  if type(self._valid) ~= 'table' then
-    self._valid = {}
-  end
-
-  local all_valid = true
-
-  for i, region in ipairs(self:included_regions()) do
-    if self._valid[i] == nil then
-      self._valid[i] = true
-    end
-
-    if self._valid[i] then
-      self._valid[i] = fn(i, region)
-      if not self._valid[i] then
-        self:_log(function()
-          return 'invalidating region', i, region_tostr(region)
-        end)
-      end
-    end
-
-    if not self._valid[i] then
-      all_valid = false
-    end
-  end
-
-  -- Compress the valid value to 'true' if there are no invalid regions
-  if all_valid then
-    self._valid = all_valid
-  end
-end
-
 --- Sets the included regions that should be parsed by this |LanguageTree|.
 --- A region is a set of nodes and/or ranges that will be parsed in the same context.
 ---
@@ -460,57 +357,56 @@ function LanguageTree:set_included_regions(regions)
     end
   end
 
-  if #self:included_regions() ~= #regions then
+  if #self._regions ~= #regions then
     self._trees = {}
     self:invalidate()
-  else
-    self:_validate_regions(function(i, region)
-      return vim.deep_equal(regions[i], region)
-    end)
-  end
-  self._regions = regions
-end
-
----Gets the set of included regions
----@return integer[][]
-function LanguageTree:included_regions()
-  if self._regions then
-    return self._regions
-  end
+  elseif self._valid ~= false then
+    if self._valid == true then
+      self._valid = {}
+      for i = 1, #regions do
+        self._valid[i] = true
+      end
+    end
 
-  if #self._trees == 0 then
-    return { {} }
-  end
+    for i = 1, #regions do
+      if not vim.deep_equal(self._regions[i], regions[i]) then
+        self._valid[i] = false
+      end
 
-  local regions = {} ---@type Range6[][]
-  for i, _ in ipairs(self._trees) do
-    regions[i] = self._trees[i]:included_ranges(true)
+      if not self._valid[i] then
+        self._trees[i] = nil
+      end
+    end
   end
 
   self._regions = regions
-  return regions
+end
+
+--- Gets the set of included regions
+function LanguageTree:included_regions()
+  return self._regions
 end
 
 ---@private
 ---@param node TSNode
----@param source integer|string
+---@param id integer
 ---@param metadata TSMetadata
----@return Range6
-local function get_range_from_metadata(node, source, metadata)
-  if metadata and metadata.range then
-    return Range.add_bytes(source, metadata.range --[[@as Range4|Range6]])
+---@return Range4
+local function get_range_from_metadata(node, id, metadata)
+  if metadata[id] and metadata[id].range then
+    return metadata[id].range --[[@as Range4]]
   end
-  return { node:range(true) }
+  return { node:range() }
 end
 
 ---@private
 --- TODO(lewis6991): cleanup of the node_range interface
 ---@param node TSNode
----@param source string|integer
+---@param id integer
 ---@param metadata TSMetadata
 ---@return Range4[]
-local function get_node_ranges(node, source, metadata, include_children)
-  local range = get_range_from_metadata(node, source, metadata)
+local function get_node_ranges(node, id, metadata, include_children)
+  local range = get_range_from_metadata(node, id, metadata)
 
   if include_children then
     return { range }
@@ -518,7 +414,7 @@ local function get_node_ranges(node, source, metadata, include_children)
 
   local ranges = {} ---@type Range4[]
 
-  local srow, scol, erow, ecol = Range.unpack4(range)
+  local srow, scol, erow, ecol = range[1], range[2], range[3], range[4]
 
   for i = 0, node:named_child_count() - 1 do
     local child = node:named_child(i)
@@ -602,7 +498,7 @@ function LanguageTree:_get_injection(match, metadata)
     if name == 'injection.language' then
       lang = get_node_text(node, self._source, metadata[id])
     elseif name == 'injection.content' then
-      ranges = get_node_ranges(node, self._source, metadata[id], include_children)
+      ranges = get_node_ranges(node, id, metadata, include_children)
     end
   end
 
@@ -649,7 +545,7 @@ function LanguageTree:_get_injection_deprecated(match, metadata)
     elseif name == 'combined' then
       combined = true
     elseif name == 'content' and #ranges == 0 then
-      table.insert(ranges, get_range_from_metadata(node, self._source, metadata[id]))
+      table.insert(ranges, get_range_from_metadata(node, id, metadata))
       -- Ignore any tags that start with "_"
       -- Allows for other tags to be used in matches
     elseif string.sub(name, 1, 1) ~= '_' then
@@ -658,7 +554,7 @@ function LanguageTree:_get_injection_deprecated(match, metadata)
       end
 
       if #ranges == 0 then
-        table.insert(ranges, get_range_from_metadata(node, self._source, metadata[id]))
+        table.insert(ranges, get_range_from_metadata(node, id, metadata))
       end
     end
   end
@@ -673,7 +569,7 @@ end
 --- TODO: Allow for an offset predicate to tailor the injection range
 ---       instead of using the entire nodes range.
 ---@private
----@return table<string, Range6[][]>
+---@return table<string, Range4[][]>
 function LanguageTree:_get_injections()
   if not self._injection_query then
     return {}
@@ -698,7 +594,7 @@ function LanguageTree:_get_injections()
     end
   end
 
-  ---@type table<string,Range6[][]>
+  ---@type table<string,Range4[][]>
   local result = {}
 
   -- Generate a map by lang of node lists.
@@ -738,51 +634,42 @@ function LanguageTree:_do_callback(cb_name, ...)
 end
 
 ---@private
-function LanguageTree:_edit(
-  start_byte,
-  end_byte_old,
-  end_byte_new,
-  start_row,
-  start_col,
-  end_row_old,
-  end_col_old,
-  end_row_new,
-  end_col_new
-)
-  for _, tree in ipairs(self._trees) do
-    tree:edit(
-      start_byte,
-      end_byte_old,
-      end_byte_new,
-      start_row,
-      start_col,
-      end_row_old,
-      end_col_old,
-      end_row_new,
-      end_col_new
-    )
-  end
-
-  self._regions = nil
-
-  local changed_range = {
-    start_row,
-    start_col,
-    start_byte,
-    end_row_old,
-    end_col_old,
-    end_byte_old,
-  }
+---@param regions Range6[][]
+---@param old_range Range6
+---@param new_range Range6
+---@return table<integer,boolean> region indices to invalidate
+local function update_regions(regions, old_range, new_range)
+  ---@type table<integer,boolean>
+  local valid = {}
+
+  for i, ranges in ipairs(regions or {}) do
+    valid[i] = true
+    for j, r in ipairs(ranges) do
+      if Range.intercepts(r, old_range) then
+        valid[i] = false
+        break
+      end
 
-  -- Validate regions after editing the tree
-  self:_validate_regions(function(_, region)
-    for _, r in ipairs(region) do
-      if Range.intercepts(r, changed_range) then
-        return false
+      -- Range after change. Adjust
+      if Range.cmp_pos.gt(r[1], r[2], old_range[4], old_range[5]) then
+        local byte_offset = new_range[6] - old_range[6]
+        local row_offset = new_range[4] - old_range[4]
+
+        -- Update the range to avoid invalidation in set_included_regions()
+        -- which will compare the regions against the parsed injection regions
+        ranges[j] = {
+          r[1] + row_offset,
+          r[2],
+          r[3] + byte_offset,
+          r[4] + row_offset,
+          r[5],
+          r[6] + byte_offset,
+        }
       end
     end
-    return true
-  end)
+  end
+
+  return valid
 end
 
 ---@private
@@ -813,26 +700,49 @@ function LanguageTree:_on_bytes(
   local old_end_col = old_col + ((old_row == 0) and start_col or 0)
   local new_end_col = new_col + ((new_row == 0) and start_col or 0)
 
-  self:_log(
-    'on_bytes',
-    bufnr,
-    changed_tick,
+  local old_range = {
+    start_row,
+    start_col,
+    start_byte,
+    start_row + old_row,
+    old_end_col,
+    start_byte + old_byte,
+  }
+
+  local new_range = {
     start_row,
     start_col,
     start_byte,
-    old_row,
-    old_col,
-    old_byte,
-    new_row,
-    new_col,
-    new_byte
-  )
+    start_row + new_row,
+    new_end_col,
+    start_byte + new_byte,
+  }
+
+  if #self._regions == 0 then
+    self._valid = false
+  else
+    self._valid = update_regions(self._regions, old_range, new_range)
+  end
+
+  for _, child in pairs(self._children) do
+    child:_on_bytes(
+      bufnr,
+      changed_tick,
+      start_row,
+      start_col,
+      start_byte,
+      old_row,
+      old_col,
+      old_byte,
+      new_row,
+      new_col,
+      new_byte
+    )
+  end
 
   -- Edit trees together BEFORE emitting a bytes callback.
-  ---@private
-  self:for_each_child(function(child)
-    ---@diagnostic disable-next-line:invisible
-    child:_edit(
+  for _, tree in ipairs(self._trees) do
+    tree:edit(
       start_byte,
       start_byte + old_byte,
       start_byte + new_byte,
@@ -843,22 +753,24 @@ function LanguageTree:_on_bytes(
       start_row + new_row,
       new_end_col
     )
-  end, true)
+  end
 
-  self:_do_callback(
-    'bytes',
-    bufnr,
-    changed_tick,
-    start_row,
-    start_col,
-    start_byte,
-    old_row,
-    old_col,
-    old_byte,
-    new_row,
-    new_col,
-    new_byte
-  )
+  if not self._is_child then
+    self:_do_callback(
+      'bytes',
+      bufnr,
+      changed_tick,
+      start_row,
+      start_col,
+      start_byte,
+      old_row,
+      old_col,
+      old_byte,
+      new_row,
+      new_col,
+      new_byte
+    )
+  end
 end
 
 ---@private
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index e7cf42283d..59894cc7f5 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -277,7 +277,6 @@ end
 ---@return (string[]|string|nil)
 function M.get_node_text(node, source, opts)
   opts = opts or {}
-  -- TODO(lewis6991): concat only works when source is number.
   local concat = vim.F.if_nil(opts.concat, true)
   local metadata = opts.metadata or {}
 
-- 
cgit 


From 6dd9770baf16abfedba667e93d92899602864645 Mon Sep 17 00:00:00 2001
From: Amaan Qureshi <amaanq12@gmail.com>
Date: Wed, 8 Mar 2023 18:19:10 -0500
Subject: vim-patch:9.0.1394: Unx Tal files are not recognized (#22579)

Problem:    Unx Tal files are not recognized.
Solution:   Add a pattern for Unx Tal files. (Amaan Qureshi, closes vim/vim#12117)

https://github.com/vim/vim/commit/cde1f8714ed2c046aa770c46229e781380122bd7
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 65579d3543..33324f580a 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1015,6 +1015,7 @@ local extension = {
   svh = 'systemverilog',
   sv = 'systemverilog',
   tak = 'tak',
+  tal = 'tal',
   task = 'taskedit',
   tm = 'tcl',
   tcl = 'tcl',
-- 
cgit 


From ae70e946eeaec792c9a87a89fea7141b5ee6a33c Mon Sep 17 00:00:00 2001
From: Amaan Qureshi <amaanq12@gmail.com>
Date: Wed, 8 Mar 2023 18:19:18 -0500
Subject: vim-patch:9.0.1395: Odin files are not recognized (#22580)

Problem:    Odin files are not recognized.
Solution:   Add a pattern for Odin files. (Amaan Qureshi, closes vim/vim#12122)

https://github.com/vim/vim/commit/638388b8ef37684e36a7f5d9286bab2d31c28f36
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 33324f580a..8238fec2cc 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -751,6 +751,7 @@ local extension = {
   mli = 'ocaml',
   ml = 'ocaml',
   occ = 'occam',
+  odin = 'odin',
   xom = 'omnimark',
   xin = 'omnimark',
   opam = 'opam',
-- 
cgit 


From be0461e3c216c2e4e2c3397c739b7727a5bf6df8 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 8 Mar 2023 23:45:43 +0000
Subject: fix(treesitter): is_in_node_range (#22582)

TS ranges are end column exclusive, so fix is_in_node_range
to account for that.
---
 runtime/lua/vim/treesitter.lua | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index d13824076e..ab9f8968c8 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -191,7 +191,7 @@ end
 ---
 ---@return boolean True if the position is in node range
 function M.is_in_node_range(node, line, col)
-  return M.node_contains(node, { line, col, line, col })
+  return M.node_contains(node, { line, col, line, col + 1 })
 end
 
 --- Determines if a node contains a range
@@ -202,7 +202,8 @@ end
 ---@return boolean True if the {node} contains the {range}
 function M.node_contains(node, range)
   vim.validate({
-    node = { node, 'userdata' },
+    -- allow a table so nodes can be mocked
+    node = { node, { 'userdata', 'table' } },
     range = { range, Range.validate, 'integer list with 4 or 6 elements' },
   })
   return Range.contains({ node:range() }, range)
-- 
cgit 


From 9ef7297ef142354ace8b1f3f277d0eee3cfdc6d4 Mon Sep 17 00:00:00 2001
From: Michal Liszcz <liszcz.michal@gmail.com>
Date: Thu, 9 Mar 2023 15:12:56 +0100
Subject: feat(lsp): overwrite omnifunc/tagfunc set by ftplugin #22267

Problem:
Some built-in ftplugins set omnifunc/tagfunc/formatexpr which causes
lsp.lua:set_defaults() to skip setup of defaults for those filetypes.
For example the C++ ftplugin has:
    omnifunc=ccomplete#Complete
          Last set from /usr/share/nvim/runtime/ftplugin/c.vim line 30
so the changes done in #95c65a6b221fe6e1cf91e8322e7d7571dc511a71
will always be skipped for C++ files.

Solution:
Overwrite omnifunc/tagfunc/formatexpr options that were set by stock
ftplugin.

Fixes #21001
---
 runtime/lua/vim/lsp.lua | 32 ++++++++++++++++++++++++++++----
 1 file changed, 28 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 9a0b3f3100..cb77e9636f 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1112,19 +1112,43 @@ function lsp.start_client(config)
     end
   end
 
+  ---@private
+  -- Determines whether the given option can be set by `set_defaults`.
+  local function is_empty_or_default(bufnr, option)
+    if vim.bo[bufnr][option] == '' then
+      return true
+    end
+
+    local old_bufnr = vim.fn.bufnr('')
+    local last_set_from = vim.fn.gettext('\n\tLast set from ')
+    local line = vim.fn.gettext(' line ')
+
+    vim.cmd.buffer(bufnr)
+    local scriptname = vim.fn
+      .execute('verbose set ' .. option .. '?')
+      :match(last_set_from .. '(.*)' .. line .. '%d+')
+    vim.cmd.buffer(old_bufnr)
+
+    if not scriptname then
+      return false
+    end
+    local vimruntime = vim.fn.getenv('VIMRUNTIME')
+    return vim.startswith(vim.fn.expand(scriptname), vim.fn.expand(vimruntime))
+  end
+
   ---@private
   local function set_defaults(client, bufnr)
     local capabilities = client.server_capabilities
-    if capabilities.definitionProvider and vim.bo[bufnr].tagfunc == '' then
+    if capabilities.definitionProvider and is_empty_or_default(bufnr, 'tagfunc') then
       vim.bo[bufnr].tagfunc = 'v:lua.vim.lsp.tagfunc'
     end
-    if capabilities.completionProvider and vim.bo[bufnr].omnifunc == '' then
+    if capabilities.completionProvider and is_empty_or_default(bufnr, 'omnifunc') then
       vim.bo[bufnr].omnifunc = 'v:lua.vim.lsp.omnifunc'
     end
     if
       capabilities.documentRangeFormattingProvider
-      and vim.bo[bufnr].formatprg == ''
-      and vim.bo[bufnr].formatexpr == ''
+      and is_empty_or_default(bufnr, 'formatprg')
+      and is_empty_or_default(bufnr, 'formatexpr')
     then
       vim.bo[bufnr].formatexpr = 'v:lua.vim.lsp.formatexpr()'
     end
-- 
cgit 


From ae263aff9547b8b513c4fedaceb4cbf93c57b866 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 9 Mar 2023 16:09:39 +0000
Subject: refactor(treesitter): use byte ranges from treesitter (#22589)

---
 runtime/lua/vim/treesitter/_meta.lua        |   7 +-
 runtime/lua/vim/treesitter/_range.lua       |  35 ++-
 runtime/lua/vim/treesitter/languagetree.lua | 440 +++++++++++++++++-----------
 runtime/lua/vim/treesitter/query.lua        |   1 +
 4 files changed, 305 insertions(+), 178 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index ad0854706b..72823ccf26 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -3,7 +3,7 @@
 ---@class TSNode
 ---@field id fun(self: TSNode): integer
 ---@field tree fun(self: TSNode): TSTree
----@field range fun(self: TSNode): integer, integer, integer, integer
+---@field range fun(self: TSNode, include_bytes: boolean?): integer, integer, integer, integer, integer, integer
 ---@field start fun(self: TSNode): integer, integer, integer
 ---@field end_ fun(self: TSNode): integer, integer, integer
 ---@field type fun(self: TSNode): string
@@ -43,9 +43,9 @@ function TSNode:_rawquery(query, captures, start, end_) end
 function TSNode:_rawquery(query, captures, start, end_) end
 
 ---@class TSParser
----@field parse fun(self: TSParser, tree, source: integer|string): TSTree, Range4[]
+---@field parse fun(self: TSParser, tree: TSTree?, source: integer|string, include_bytes: boolean?): TSTree, integer[]
 ---@field reset fun(self: TSParser)
----@field included_ranges fun(self: TSParser): Range4[]
+---@field included_ranges fun(self: TSParser, include_bytes: boolean?): integer[]
 ---@field set_included_ranges fun(self: TSParser, ranges: Range6[])
 ---@field set_timeout fun(self: TSParser, timeout: integer)
 ---@field timeout fun(self: TSParser): integer
@@ -54,6 +54,7 @@ function TSNode:_rawquery(query, captures, start, end_) end
 ---@field root fun(self: TSTree): TSNode
 ---@field edit fun(self: TSTree, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _:integer)
 ---@field copy fun(self: TSTree): TSTree
+---@field included_ranges fun(self: TSTree, include_bytes: boolean?): integer[]
 
 ---@return integer
 vim._ts_get_language_version = function() end
diff --git a/runtime/lua/vim/treesitter/_range.lua b/runtime/lua/vim/treesitter/_range.lua
index bec24a23a5..02918da23f 100644
--- a/runtime/lua/vim/treesitter/_range.lua
+++ b/runtime/lua/vim/treesitter/_range.lua
@@ -78,11 +78,8 @@ end
 ---@param r2 Range4|Range6
 ---@return boolean
 function M.intercepts(r1, r2)
-  local off_1 = #r1 == 6 and 1 or 0
-  local off_2 = #r1 == 6 and 1 or 0
-
-  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r1[2], r1[3 + off_1], r1[4 + off_1]
-  local srow_2, scol_2, erow_2, ecol_2 = r2[1], r2[2], r2[3 + off_2], r2[4 + off_2]
+  local srow_1, scol_1, erow_1, ecol_1 = M.unpack4(r1)
+  local srow_2, scol_2, erow_2, ecol_2 = M.unpack4(r2)
 
   -- r1 is above r2
   if M.cmp_pos.le(erow_1, ecol_1, srow_2, scol_2) then
@@ -97,16 +94,28 @@ function M.intercepts(r1, r2)
   return true
 end
 
+---@private
+---@param r Range4|Range6
+---@return integer, integer, integer, integer
+function M.unpack4(r)
+  local off_1 = #r == 6 and 1 or 0
+  return r[1], r[2], r[3 + off_1], r[4 + off_1]
+end
+
+---@private
+---@param r Range6
+---@return integer, integer, integer, integer, integer, integer
+function M.unpack6(r)
+  return r[1], r[2], r[3], r[4], r[5], r[6]
+end
+
 ---@private
 ---@param r1 Range4|Range6
 ---@param r2 Range4|Range6
 ---@return boolean whether r1 contains r2
 function M.contains(r1, r2)
-  local off_1 = #r1 == 6 and 1 or 0
-  local off_2 = #r1 == 6 and 1 or 0
-
-  local srow_1, scol_1, erow_1, ecol_1 = r1[1], r1[2], r1[3 + off_1], r1[4 + off_1]
-  local srow_2, scol_2, erow_2, ecol_2 = r2[1], r2[2], r2[3 + off_2], r2[4 + off_2]
+  local srow_1, scol_1, erow_1, ecol_1 = M.unpack4(r1)
+  local srow_2, scol_2, erow_2, ecol_2 = M.unpack4(r2)
 
   -- start doesn't fit
   if M.cmp_pos.gt(srow_1, scol_1, srow_2, scol_2) then
@@ -123,9 +132,13 @@ end
 
 ---@private
 ---@param source integer|string
----@param range Range4
+---@param range Range4|Range6
 ---@return Range6
 function M.add_bytes(source, range)
+  if type(range) == 'table' and #range == 6 then
+    return range --[[@as Range6]]
+  end
+
   local start_row, start_col, end_row, end_col = range[1], range[2], range[3], range[4]
   local start_byte = 0
   local end_byte = 0
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index fbc602486b..c89419085f 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -62,8 +62,6 @@ local Range = require('vim.treesitter._range')
 ---@field private _source (integer|string) Buffer or string to parse
 ---@field private _trees TSTree[] Reference to parsed tree (one for each language)
 ---@field private _valid boolean|table<integer,boolean> If the parsed tree is valid
---- TODO(lewis6991): combine _regions, _valid and _trees
----@field private _is_child boolean
 local LanguageTree = {}
 
 ---@class LanguageTreeOpts
@@ -117,6 +115,48 @@ function LanguageTree.new(source, lang, opts)
   return self
 end
 
+---@private
+---Measure execution time of a function
+---@generic R1, R2, R3
+---@param f fun(): R1, R2, R2
+---@return integer, R1, R2, R3
+local function tcall(f, ...)
+  local start = vim.loop.hrtime()
+  ---@diagnostic disable-next-line
+  local r = { f(...) }
+  local duration = (vim.loop.hrtime() - start) / 1000000
+  return duration, unpack(r)
+end
+
+---@private
+---@vararg any
+function LanguageTree:_log(...)
+  if vim.g.__ts_debug == nil then
+    return
+  end
+
+  local args = { ... }
+  if type(args[1]) == 'function' then
+    args = { args[1]() }
+  end
+
+  local info = debug.getinfo(2, 'nl')
+  local nregions = #self:included_regions()
+  local prefix =
+    string.format('%s:%d: [%s:%d] ', info.name, info.currentline, self:lang(), nregions)
+
+  a.nvim_out_write(prefix)
+  for _, x in ipairs(args) do
+    if type(x) == 'string' then
+      a.nvim_out_write(x)
+    else
+      a.nvim_out_write(vim.inspect(x, { newline = ' ', indent = '' }))
+    end
+    a.nvim_out_write(' ')
+  end
+  a.nvim_out_write('\n')
+end
+
 --- Invalidates this parser and all its children
 ---@param reload boolean|nil
 function LanguageTree:invalidate(reload)
@@ -146,7 +186,9 @@ end
 --- Determines whether this tree is valid.
 --- If the tree is invalid, call `parse()`.
 --- This will return the updated tree.
-function LanguageTree:is_valid()
+---@param exclude_children boolean|nil
+---@return boolean
+function LanguageTree:is_valid(exclude_children)
   local valid = self._valid
 
   if type(valid) == 'table' then
@@ -155,9 +197,18 @@ function LanguageTree:is_valid()
         return false
       end
     end
-    return true
   end
 
+  if not exclude_children then
+    for _, child in pairs(self._children) do
+      if not child:is_valid(exclude_children) then
+        return false
+      end
+    end
+  end
+
+  assert(type(valid) == 'boolean')
+
   return valid
 end
 
@@ -171,16 +222,6 @@ function LanguageTree:source()
   return self._source
 end
 
----@private
----This is only exposed so it can be wrapped for profiling
----@param old_tree TSTree
----@return TSTree, integer[]
-function LanguageTree:_parse_tree(old_tree)
-  local tree, tree_changes = self._parser:parse(old_tree, self._source)
-  self:_do_callback('changedtree', tree_changes, tree)
-  return tree, tree_changes
-end
-
 --- Parses all defined regions using a treesitter parser
 --- for the language this tree represents.
 --- This will run the injection query for this language to
@@ -190,31 +231,45 @@ end
 ---@return table|nil Change list
 function LanguageTree:parse()
   if self:is_valid() then
+    self:_log('valid')
     return self._trees
   end
 
   local changes = {}
 
-  -- If there are no ranges, set to an empty list
-  -- so the included ranges in the parser are cleared.
-  if #self._regions > 0 then
-    for i, ranges in ipairs(self._regions) do
-      if not self._valid or not self._valid[i] then
-        self._parser:set_included_ranges(ranges)
-        local tree, tree_changes = self:_parse_tree(self._trees[i])
-        self._trees[i] = tree
-        vim.list_extend(changes, tree_changes)
+  -- Collect some stats
+  local regions_parsed = 0
+  local total_parse_time = 0
+
+  --- At least 1 region is invalid
+  if not self:is_valid(true) then
+    local function _parsetree(index)
+      local parse_time, tree, tree_changes =
+        tcall(self._parser.parse, self._parser, self._trees[index], self._source)
+
+      self:_do_callback('changedtree', tree_changes, tree)
+      self._trees[index] = tree
+      vim.list_extend(changes, tree_changes)
+
+      total_parse_time = total_parse_time + parse_time
+      regions_parsed = regions_parsed + 1
+    end
+
+    if #self._regions > 0 then
+      for i, ranges in ipairs(self._regions) do
+        if not self._valid or not self._valid[i] then
+          self._parser:set_included_ranges(ranges)
+          _parsetree(i)
+        end
       end
+    else
+      _parsetree(1)
     end
-  else
-    local tree, tree_changes = self:_parse_tree(self._trees[1])
-    self._trees = { tree }
-    changes = tree_changes
   end
 
-  local injections_by_lang = self:_get_injections()
   local seen_langs = {} ---@type table<string,boolean>
 
+  local query_time, injections_by_lang = tcall(self._get_injections, self)
   for lang, injection_ranges in pairs(injections_by_lang) do
     local has_lang = pcall(language.add, lang)
 
@@ -229,15 +284,6 @@ function LanguageTree:parse()
       end
 
       child:set_included_regions(injection_ranges)
-
-      local _, child_changes = child:parse()
-
-      -- Propagate any child changes so they are included in the
-      -- the change list for the callback.
-      if child_changes then
-        vim.list_extend(changes, child_changes)
-      end
-
       seen_langs[lang] = true
     end
   end
@@ -248,6 +294,23 @@ function LanguageTree:parse()
     end
   end
 
+  self:_log({
+    changes = changes,
+    regions_parsed = regions_parsed,
+    parse_time = total_parse_time,
+    query_time = query_time,
+  })
+
+  self:for_each_child(function(child)
+    local _, child_changes = child:parse()
+
+    -- Propagate any child changes so they are included in the
+    -- the change list for the callback.
+    if child_changes then
+      vim.list_extend(changes, child_changes)
+    end
+  end)
+
   self._valid = true
 
   return self._trees, changes
@@ -295,8 +358,6 @@ function LanguageTree:add_child(lang)
   end
 
   self._children[lang] = LanguageTree.new(self._source, lang, self._opts)
-  self._children[lang]._is_child = true
-
   self:invalidate()
   self:_do_callback('child_added', self._children[lang])
 
@@ -331,6 +392,54 @@ function LanguageTree:destroy()
   end
 end
 
+---@private
+---@param region Range6[]
+local function region_tostr(region)
+  local srow, scol = region[1][1], region[1][2]
+  local erow, ecol = region[#region][4], region[#region][5]
+  return string.format('[%d:%d-%d:%d]', srow, scol, erow, ecol)
+end
+
+---@private
+---Iterate through all the regions. fn returns a boolean to indicate if the
+---region is valid or not.
+---@param fn fun(index: integer, region: Range6[]): boolean
+function LanguageTree:_iter_regions(fn)
+  if not self._valid then
+    return
+  end
+
+  if type(self._valid) ~= 'table' then
+    self._valid = {}
+  end
+
+  local all_valid = true
+
+  for i, region in ipairs(self._regions) do
+    if self._valid[i] == nil then
+      self._valid[i] = true
+    end
+
+    if self._valid[i] then
+      self._valid[i] = fn(i, region)
+      if not self._valid[i] then
+        self:_log(function()
+          return 'invalidating region', i, region_tostr(region)
+        end)
+      end
+    end
+
+    if not self._valid[i] then
+      all_valid = false
+    end
+  end
+
+  -- Compress the valid value to 'true' if there are no invalid regions
+  if all_valid then
+    self._valid = all_valid
+  end
+end
+
 --- Sets the included regions that should be parsed by this |LanguageTree|.
 --- A region is a set of nodes and/or ranges that will be parsed in the same context.
 ---
@@ -346,10 +455,10 @@ end
 --- nodes, which is useful for templating languages like ERB and EJS.
 ---
 ---@private
----@param regions Range4[][] List of regions this tree should manage and parse.
-function LanguageTree:set_included_regions(regions)
+---@param new_regions Range4[][] List of regions this tree should manage and parse.
+function LanguageTree:set_included_regions(new_regions)
   -- Transform the tables from 4 element long to 6 element long (with byte offset)
-  for _, region in ipairs(regions) do
+  for _, region in ipairs(new_regions) do
     for i, range in ipairs(region) do
       if type(range) == 'table' and #range == 4 then
         region[i] = Range.add_bytes(self._source, range)
@@ -357,83 +466,75 @@ function LanguageTree:set_included_regions(regions)
     end
   end
 
-  if #self._regions ~= #regions then
+  if #self._regions ~= #new_regions then
     self._trees = {}
     self:invalidate()
-  elseif self._valid ~= false then
-    if self._valid == true then
-      self._valid = {}
-      for i = 1, #regions do
-        self._valid[i] = true
-      end
-    end
-
-    for i = 1, #regions do
-      if not vim.deep_equal(self._regions[i], regions[i]) then
-        self._valid[i] = false
-      end
-
-      if not self._valid[i] then
-        self._trees[i] = nil
-      end
-    end
+  else
+    self:_iter_regions(function(i, region)
+      return vim.deep_equal(new_regions[i], region)
+    end)
   end
-
-  self._regions = regions
+  self._regions = new_regions
 end
 
---- Gets the set of included regions
+---Gets the set of included regions
+---@return integer[][]
 function LanguageTree:included_regions()
   return self._regions
 end
 
 ---@private
 ---@param node TSNode
----@param id integer
+---@param source integer|string
 ---@param metadata TSMetadata
----@return Range4
-local function get_range_from_metadata(node, id, metadata)
-  if metadata[id] and metadata[id].range then
-    return metadata[id].range --[[@as Range4]]
+---@return Range6
+local function get_range_from_metadata(node, source, metadata)
+  if metadata and metadata.range then
+    return Range.add_bytes(source, metadata.range --[[@as Range4|Range6]])
   end
-  return { node:range() }
+  return { node:range(true) }
 end
 
 ---@private
 --- TODO(lewis6991): cleanup of the node_range interface
 ---@param node TSNode
----@param id integer
+---@param source string|integer
 ---@param metadata TSMetadata
----@return Range4[]
-local function get_node_ranges(node, id, metadata, include_children)
-  local range = get_range_from_metadata(node, id, metadata)
+---@return Range6[]
+local function get_node_ranges(node, source, metadata, include_children)
+  local range = get_range_from_metadata(node, source, metadata)
 
   if include_children then
     return { range }
   end
 
-  local ranges = {} ---@type Range4[]
+  local ranges = {} ---@type Range6[]
 
-  local srow, scol, erow, ecol = range[1], range[2], range[3], range[4]
+  local srow, scol, sbyte, erow, ecol, ebyte = Range.unpack6(range)
 
   for i = 0, node:named_child_count() - 1 do
     local child = node:named_child(i)
-    local child_srow, child_scol, child_erow, child_ecol = child:range()
-    if child_srow > srow or child_scol > scol then
-      table.insert(ranges, { srow, scol, child_srow, child_scol })
+    local c_srow, c_scol, c_sbyte, c_erow, c_ecol, c_ebyte = child:range(true)
+    if c_srow > srow or c_scol > scol then
+      ranges[#ranges + 1] = { srow, scol, sbyte, c_srow, c_scol, c_sbyte }
     end
-    srow = child_erow
-    scol = child_ecol
+    srow = c_erow
+    scol = c_ecol
+    sbyte = c_ebyte
   end
 
   if erow > srow or ecol > scol then
-    table.insert(ranges, { srow, scol, erow, ecol })
+    ranges[#ranges + 1] = Range.add_bytes(source, { srow, scol, sbyte, erow, ecol, ebyte })
   end
 
   return ranges
 end
 
----@alias TSInjection table<string,table<integer,table>>
+---@class TSInjectionElem
+---@field combined boolean
+---@field regions Range6[][]
+
+---@alias TSInjection table<string,table<integer,TSInjectionElem>>
 
 ---@private
 ---@param t table<integer,TSInjection>
@@ -498,7 +599,7 @@ function LanguageTree:_get_injection(match, metadata)
     if name == 'injection.language' then
       lang = get_node_text(node, self._source, metadata[id])
     elseif name == 'injection.content' then
-      ranges = get_node_ranges(node, id, metadata, include_children)
+      ranges = get_node_ranges(node, self._source, metadata[id], include_children)
     end
   end
 
@@ -545,7 +646,7 @@ function LanguageTree:_get_injection_deprecated(match, metadata)
     elseif name == 'combined' then
       combined = true
     elseif name == 'content' and #ranges == 0 then
-      table.insert(ranges, get_range_from_metadata(node, id, metadata))
+      ranges[#ranges + 1] = get_range_from_metadata(node, self._source, metadata[id])
       -- Ignore any tags that start with "_"
       -- Allows for other tags to be used in matches
     elseif string.sub(name, 1, 1) ~= '_' then
@@ -554,7 +655,7 @@ function LanguageTree:_get_injection_deprecated(match, metadata)
       end
 
       if #ranges == 0 then
-        table.insert(ranges, get_range_from_metadata(node, id, metadata))
+        ranges[#ranges + 1] = get_range_from_metadata(node, self._source, metadata[id])
       end
     end
   end
@@ -569,7 +670,7 @@ end
 --- TODO: Allow for an offset predicate to tailor the injection range
 ---       instead of using the entire nodes range.
 ---@private
----@return table<string, Range4[][]>
+---@return table<string, Range6[][]>
 function LanguageTree:_get_injections()
   if not self._injection_query then
     return {}
@@ -594,7 +695,7 @@ function LanguageTree:_get_injections()
     end
   end
 
-  ---@type table<string,Range4[][]>
+  ---@type table<string,Range6[][]>
   local result = {}
 
   -- Generate a map by lang of node lists.
@@ -613,7 +714,6 @@ function LanguageTree:_get_injections()
           end, entry.regions)
           table.insert(result[lang], regions)
         else
-          ---@diagnostic disable-next-line:no-unknown
           for _, ranges in ipairs(entry.regions) do
             table.insert(result[lang], ranges)
           end
@@ -634,30 +734,68 @@ function LanguageTree:_do_callback(cb_name, ...)
 end
 
 ---@private
----@param regions Range6[][]
----@param old_range Range6
----@param new_range Range6
----@return table<integer,boolean> region indices to invalidate
-local function update_regions(regions, old_range, new_range)
-  ---@type table<integer,boolean>
-  local valid = {}
-
-  for i, ranges in ipairs(regions or {}) do
-    valid[i] = true
-    for j, r in ipairs(ranges) do
-      if Range.intercepts(r, old_range) then
-        valid[i] = false
-        break
+function LanguageTree:_edit(
+  start_byte,
+  end_byte_old,
+  end_byte_new,
+  start_row,
+  start_col,
+  end_row_old,
+  end_col_old,
+  end_row_new,
+  end_col_new
+)
+  for _, tree in ipairs(self._trees) do
+    tree:edit(
+      start_byte,
+      end_byte_old,
+      end_byte_new,
+      start_row,
+      start_col,
+      end_row_old,
+      end_col_old,
+      end_row_new,
+      end_col_new
+    )
+  end
+
+  local changed_range = {
+    start_row,
+    start_col,
+    start_byte,
+    end_row_old,
+    end_col_old,
+    end_byte_old,
+  }
+
+  local new_range = {
+    start_row,
+    start_col,
+    start_byte,
+    end_row_new,
+    end_col_new,
+    end_byte_new,
+  }
+
+  if #self._regions == 0 then
+    self._valid = false
+  end
+
+  -- Validate regions after editing the tree
+  self:_iter_regions(function(_, region)
+    for i, r in ipairs(region) do
+      if Range.intercepts(r, changed_range) then
+        return false
       end
 
       -- Range after change. Adjust
-      if Range.cmp_pos.gt(r[1], r[2], old_range[4], old_range[5]) then
-        local byte_offset = new_range[6] - old_range[6]
-        local row_offset = new_range[4] - old_range[4]
+      if Range.cmp_pos.gt(r[1], r[2], changed_range[4], changed_range[5]) then
+        local byte_offset = new_range[6] - changed_range[6]
+        local row_offset = new_range[4] - changed_range[4]
 
         -- Update the range to avoid invalidation in set_included_regions()
         -- which will compare the regions against the parsed injection regions
-        ranges[j] = {
+        region[i] = {
           r[1] + row_offset,
           r[2],
           r[3] + byte_offset,
@@ -667,9 +805,8 @@ local function update_regions(regions, old_range, new_range)
         }
       end
     end
-  end
-
-  return valid
+    return true
+  end)
 end
 
 ---@private
@@ -700,49 +837,26 @@ function LanguageTree:_on_bytes(
   local old_end_col = old_col + ((old_row == 0) and start_col or 0)
   local new_end_col = new_col + ((new_row == 0) and start_col or 0)
 
-  local old_range = {
-    start_row,
-    start_col,
-    start_byte,
-    start_row + old_row,
-    old_end_col,
-    start_byte + old_byte,
-  }
-
-  local new_range = {
+  self:_log(
+    'on_bytes',
+    bufnr,
+    changed_tick,
     start_row,
     start_col,
     start_byte,
-    start_row + new_row,
-    new_end_col,
-    start_byte + new_byte,
-  }
-
-  if #self._regions == 0 then
-    self._valid = false
-  else
-    self._valid = update_regions(self._regions, old_range, new_range)
-  end
-
-  for _, child in pairs(self._children) do
-    child:_on_bytes(
-      bufnr,
-      changed_tick,
-      start_row,
-      start_col,
-      start_byte,
-      old_row,
-      old_col,
-      old_byte,
-      new_row,
-      new_col,
-      new_byte
-    )
-  end
+    old_row,
+    old_col,
+    old_byte,
+    new_row,
+    new_col,
+    new_byte
+  )
 
   -- Edit trees together BEFORE emitting a bytes callback.
-  for _, tree in ipairs(self._trees) do
-    tree:edit(
+  ---@private
+  self:for_each_child(function(child)
+    ---@diagnostic disable-next-line:invisible
+    child:_edit(
       start_byte,
       start_byte + old_byte,
       start_byte + new_byte,
@@ -753,24 +867,22 @@ function LanguageTree:_on_bytes(
       start_row + new_row,
       new_end_col
     )
-  end
+  end, true)
 
-  if not self._is_child then
-    self:_do_callback(
-      'bytes',
-      bufnr,
-      changed_tick,
-      start_row,
-      start_col,
-      start_byte,
-      old_row,
-      old_col,
-      old_byte,
-      new_row,
-      new_col,
-      new_byte
-    )
-  end
+  self:_do_callback(
+    'bytes',
+    bufnr,
+    changed_tick,
+    start_row,
+    start_col,
+    start_byte,
+    old_row,
+    old_col,
+    old_byte,
+    new_row,
+    new_col,
+    new_byte
+  )
 end
 
 ---@private
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 59894cc7f5..e7cf42283d 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -277,6 +277,7 @@ end
 ---@return (string[]|string|nil)
 function M.get_node_text(node, source, opts)
   opts = opts or {}
+  -- TODO(lewis6991): concat only works when source is number.
   local concat = vim.F.if_nil(opts.concat, true)
   local metadata = opts.metadata or {}
 
-- 
cgit 


From 68aa2857dd6bc1b33add02121cd36ef1ab32728c Mon Sep 17 00:00:00 2001
From: Amaan Qureshi <amaanq12@gmail.com>
Date: Thu, 9 Mar 2023 12:13:44 -0500
Subject: vim-patch:9.0.1393: Cairo files are not recognized (#22578)

Problem:    Cairo files are not recognized.
Solution:   Add a pattern for Cairo files. (Amaan Qureshi, closes vim/vim#12118)

https://github.com/vim/vim/commit/ff226d49fed2d8fc668084324c7b0f00117c5e74
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 8238fec2cc..1732623223 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -191,6 +191,7 @@ local extension = {
   BUILD = 'bzl',
   qc = 'c',
   cabal = 'cabal',
+  cairo = 'cairo',
   capnp = 'capnp',
   cdc = 'cdc',
   cdl = 'cdl',
-- 
cgit 


From 0ecb4d725e9e2086b045670e4c2fa8962b63d99c Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Fri, 10 Mar 2023 06:17:08 +0900
Subject: docs(lsp): type annotation for lsp.client (#22509)

* Also fix newly found type mismatch.
* Note that it generates new warnings about using @private client
  methods. A proper fix would be to revamp the lsp client documentation
  altogether.
---
 runtime/lua/vim/lsp.lua | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index cb77e9636f..c85d38a50e 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -154,6 +154,8 @@ local all_buffer_active_clients = {}
 local uninitialized_clients = {}
 
 ---@private
+---@param bufnr? integer
+---@param fn fun(client: lsp.Client, client_id: integer, bufnr: integer)
 local function for_each_buffer_client(bufnr, fn, restrict_client_ids)
   validate({
     fn = { fn, 'f' },
@@ -1240,6 +1242,7 @@ function lsp.start_client(config)
     return
   end
 
+  ---@class lsp.Client
   local client = {
     id = client_id,
     name = name,
@@ -1390,7 +1393,7 @@ function lsp.start_client(config)
   --- checks for capabilities and handler availability.
   ---
   ---@param method string LSP method name.
-  ---@param params table LSP request params.
+  ---@param params table|nil LSP request params.
   ---@param handler lsp-handler|nil Response |lsp-handler| for this method.
   ---@param bufnr integer Buffer handle (0 for current).
   ---@return boolean status, integer|nil request_id {status} is a bool indicating
@@ -2087,7 +2090,7 @@ function lsp.buf_request_sync(bufnr, method, params, timeout_ms)
 end
 
 --- Send a notification to a server
----@param bufnr (number|nil) The number of the buffer
+---@param bufnr (integer|nil) The number of the buffer
 ---@param method (string) Name of the request method
 ---@param params (any) Arguments to send to the server
 ---
-- 
cgit 


From adfa9de8ebc4bce96d212280eccddc0306d1b013 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 10 Mar 2023 10:12:57 +0000
Subject: fix(treesitter): do not error on empty filetype

Ignore instead
---
 runtime/lua/vim/treesitter/language.lua | 14 +++-----------
 1 file changed, 3 insertions(+), 11 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index 5f34d9cd56..47375fd5e6 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -60,16 +60,6 @@ function M.add(lang, opts)
     filetype = { filetype, { 'string', 'table' }, true },
   })
 
-  if filetype == '' then
-    error(string.format("'%s' is not a valid filetype", filetype))
-  elseif type(filetype) == 'table' then
-    for _, f in ipairs(filetype) do
-      if f == '' then
-        error(string.format("'%s' is not a valid filetype", filetype))
-      end
-    end
-  end
-
   M.register(lang, filetype or lang)
 
   if vim._ts_has_language(lang) then
@@ -109,7 +99,9 @@ function M.register(lang, filetype)
   end
 
   for _, f in ipairs(filetypes) do
-    ft_to_lang[f] = lang
+    if f ~= '' then
+      ft_to_lang[f] = lang
+    end
   end
 end
 
-- 
cgit 


From c5b9643bf1b0f6d5166b4abf6a7c3f29532aefeb Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 10 Mar 2023 10:25:10 +0000
Subject: fix(treesitter): better lang handling of get_parser()

---
 runtime/lua/vim/treesitter.lua | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index ab9f8968c8..5723cce563 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -99,13 +99,28 @@ function M.get_parser(bufnr, lang, opts)
   if bufnr == nil or bufnr == 0 then
     bufnr = a.nvim_get_current_buf()
   end
+
   if lang == nil then
     local ft = vim.bo[bufnr].filetype
-    lang = language.get_lang(ft) or ft
-    -- TODO(lewis6991): we should error here and not default to ft
-    -- if not lang then
-    --   error(string.format('filetype %s of buffer %d is not associated with any lang', ft, bufnr))
-    -- end
+    if ft ~= '' then
+      lang = language.get_lang(ft) or ft
+      -- TODO(lewis6991): we should error here and not default to ft
+      -- if not lang then
+      --   error(string.format('filetype %s of buffer %d is not associated with any lang', ft, bufnr))
+      -- end
+    else
+      if parsers[bufnr] then
+        return parsers[bufnr]
+      end
+      error(
+        string.format(
+          'There is no parser available for buffer %d and one could not be'
+            .. ' created because lang could not be determined. Either pass lang'
+            .. ' or set the buffer filetype',
+          bufnr
+        )
+      )
+    end
   end
 
   if parsers[bufnr] == nil or parsers[bufnr]:lang() ~= lang then
-- 
cgit 


From 46b73bf22cb951151de9bf0712d42e194000b677 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 9 Mar 2023 15:28:55 +0000
Subject: perf(treesitter): more efficient foldexpr

---
 runtime/lua/vim/treesitter/_fold.lua | 290 +++++++++++++++++++++++------------
 1 file changed, 188 insertions(+), 102 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index a66cc6d543..435cb9fdb6 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -1,139 +1,157 @@
+local Range = require('vim.treesitter._range')
+
 local api = vim.api
 
-local M = {}
+---@class FoldInfo
+---@field levels table<integer,string>
+---@field levels0 table<integer,integer>
+---@field private start_counts table<integer,integer>
+---@field private stop_counts table<integer,integer>
+local FoldInfo = {}
+FoldInfo.__index = FoldInfo
 
---- Memoizes a function based on the buffer tick of the provided bufnr.
---- The cache entry is cleared when the buffer is detached to avoid memory leaks.
----@generic F: function
----@param fn F fn to memoize, taking the bufnr as first argument
----@return F
-local function memoize_by_changedtick(fn)
-  ---@type table<integer,{result:any,last_tick:integer}>
-  local cache = {}
-
-  ---@param bufnr integer
-  return function(bufnr, ...)
-    local tick = api.nvim_buf_get_changedtick(bufnr)
-
-    if cache[bufnr] then
-      if cache[bufnr].last_tick == tick then
-        return cache[bufnr].result
-      end
-    else
-      local function detach_handler()
-        cache[bufnr] = nil
-      end
+function FoldInfo.new()
+  return setmetatable({
+    start_counts = {},
+    stop_counts = {},
+    levels0 = {},
+    levels = {},
+  }, FoldInfo)
+end
 
-      -- Clean up logic only!
-      api.nvim_buf_attach(bufnr, false, {
-        on_detach = detach_handler,
-        on_reload = detach_handler,
-      })
-    end
+---@param srow integer
+---@param erow integer
+function FoldInfo:invalidate_range(srow, erow)
+  for i = srow, erow do
+    self.start_counts[i + 1] = nil
+    self.stop_counts[i + 1] = nil
+    self.levels0[i + 1] = nil
+    self.levels[i + 1] = nil
+  end
+end
 
-    cache[bufnr] = {
-      result = fn(bufnr, ...),
-      last_tick = tick,
-    }
+---@param srow integer
+---@param erow integer
+function FoldInfo:remove_range(srow, erow)
+  for i = erow - 1, srow, -1 do
+    table.remove(self.levels, i + 1)
+    table.remove(self.levels0, i + 1)
+    table.remove(self.start_counts, i + 1)
+    table.remove(self.stop_counts, i + 1)
+  end
+end
 
-    return cache[bufnr].result
+---@param srow integer
+---@param erow integer
+function FoldInfo:add_range(srow, erow)
+  for i = srow, erow - 1 do
+    table.insert(self.levels, i + 1, '-1')
+    table.insert(self.levels0, i + 1, -1)
+    table.insert(self.start_counts, i + 1, nil)
+    table.insert(self.stop_counts, i + 1, nil)
   end
 end
 
----@param bufnr integer
----@param capture string
----@param query_name string
----@param callback fun(id: integer, node:TSNode, metadata: TSMetadata)
-local function iter_matches_with_capture(bufnr, capture, query_name, callback)
-  local parser = vim.treesitter.get_parser(bufnr)
+---@param lnum integer
+function FoldInfo:add_start(lnum)
+  self.start_counts[lnum] = (self.start_counts[lnum] or 0) + 1
+end
 
-  if not parser then
-    return
-  end
+---@param lnum integer
+function FoldInfo:add_stop(lnum)
+  self.stop_counts[lnum] = (self.stop_counts[lnum] or 0) + 1
+end
 
-  parser:for_each_tree(function(tree, lang_tree)
-    local lang = lang_tree:lang()
-    local query = vim.treesitter.query.get_query(lang, query_name)
-    if query then
-      local root = tree:root()
-      local start, _, stop = root:range()
-      for _, match, metadata in query:iter_matches(root, bufnr, start, stop) do
-        for id, node in pairs(match) do
-          if query.captures[id] == capture then
-            callback(id, node, metadata)
-          end
-        end
-      end
-    end
-  end)
+---@param lnum integer
+---@return integer
+function FoldInfo:get_start(lnum)
+  return self.start_counts[lnum] or 0
+end
+
+---@param lnum integer
+---@return integer
+function FoldInfo:get_stop(lnum)
+  return self.stop_counts[lnum] or 0
 end
 
 ---@private
 --- TODO(lewis6991): copied from languagetree.lua. Consolidate
 ---@param node TSNode
----@param id integer
 ---@param metadata TSMetadata
----@return Range
-local function get_range_from_metadata(node, id, metadata)
-  if metadata[id] and metadata[id].range then
-    return metadata[id].range --[[@as Range]]
+---@return Range4
+local function get_range_from_metadata(node, metadata)
+  if metadata and metadata.range then
+    return metadata.range --[[@as Range4]]
   end
   return { node:range() }
 end
 
--- This is cached on buf tick to avoid computing that multiple times
--- Especially not for every line in the file when `zx` is hit
----@param bufnr integer
----@return table<integer,string>
-local folds_levels = memoize_by_changedtick(function(bufnr)
+local function trim_level(level)
   local max_fold_level = vim.wo.foldnestmax
-  local function trim_level(level)
-    if level > max_fold_level then
-      return max_fold_level
-    end
-    return level
+  if level > max_fold_level then
+    return max_fold_level
   end
+  return level
+end
 
-  -- start..stop is an inclusive range
-  local start_counts = {} ---@type table<integer,integer>
-  local stop_counts = {} ---@type table<integer,integer>
+---@param bufnr integer
+---@param info FoldInfo
+---@param srow integer?
+---@param erow integer?
+local function get_folds_levels(bufnr, info, srow, erow)
+  srow = srow or 0
+  erow = erow or api.nvim_buf_line_count(bufnr)
+
+  info:invalidate_range(srow, erow)
 
   local prev_start = -1
   local prev_stop = -1
 
-  local min_fold_lines = vim.wo.foldminlines
+  vim.treesitter.get_parser(bufnr):for_each_tree(function(tree, ltree)
+    local query = vim.treesitter.query.get_query(ltree:lang(), 'folds')
+    if not query then
+      return
+    end
+
+    -- erow in query is end-exclusive
+    local q_erow = erow and erow + 1 or -1
 
-  iter_matches_with_capture(bufnr, 'fold', 'folds', function(id, node, metadata)
-    local range = get_range_from_metadata(node, id, metadata)
-    local start, stop, stop_col = range[1], range[3], range[4]
+    for id, node, metadata in query:iter_captures(tree:root(), bufnr, srow or 0, q_erow) do
+      if query.captures[id] == 'fold' then
+        local range = get_range_from_metadata(node, metadata[id])
+        local start, _, stop, stop_col = Range.unpack4(range)
 
-    if stop_col == 0 then
-      stop = stop - 1
-    end
+        if stop_col == 0 then
+          stop = stop - 1
+        end
 
-    local fold_length = stop - start + 1
+        local fold_length = stop - start + 1
 
-    -- Fold only multiline nodes that are not exactly the same as previously met folds
-    -- Checking against just the previously found fold is sufficient if nodes
-    -- are returned in preorder or postorder when traversing tree
-    if fold_length > min_fold_lines and not (start == prev_start and stop == prev_stop) then
-      start_counts[start] = (start_counts[start] or 0) + 1
-      stop_counts[stop] = (stop_counts[stop] or 0) + 1
-      prev_start = start
-      prev_stop = stop
+        -- Fold only multiline nodes that are not exactly the same as previously met folds
+        -- Checking against just the previously found fold is sufficient if nodes
+        -- are returned in preorder or postorder when traversing tree
+        if
+          fold_length > vim.wo.foldminlines and not (start == prev_start and stop == prev_stop)
+        then
+          info:add_start(start + 1)
+          info:add_stop(stop + 1)
+          prev_start = start
+          prev_stop = stop
+        end
+      end
     end
   end)
 
-  ---@type table<integer,string>
-  local levels = {}
-  local current_level = 0
+  local current_level = info.levels0[srow] or 0
 
   -- We now have the list of fold opening and closing, fill the gaps and mark where fold start
-  for lnum = 0, api.nvim_buf_line_count(bufnr) do
+  for lnum = srow + 1, erow + 1 do
     local last_trimmed_level = trim_level(current_level)
-    current_level = current_level + (start_counts[lnum] or 0)
+    current_level = current_level + info:get_start(lnum)
+    info.levels0[lnum] = current_level
+
     local trimmed_level = trim_level(current_level)
-    current_level = current_level - (stop_counts[lnum] or 0)
+    current_level = current_level - info:get_stop(lnum)
 
     -- Determine if it's the start/end of a fold
     -- NB: vim's fold-expr interface does not have a mechanism to indicate that
@@ -148,11 +166,61 @@ local folds_levels = memoize_by_changedtick(function(bufnr)
       prefix = '>'
     end
 
-    levels[lnum + 1] = prefix .. tostring(trimmed_level)
+    info.levels[lnum] = prefix .. tostring(trimmed_level)
+  end
+end
+
+local M = {}
+
+---@type table<integer,FoldInfo>
+local foldinfos = {}
+
+local function recompute_folds()
+  if api.nvim_get_mode().mode == 'i' then
+    -- foldUpdate() is guarded in insert mode. So update folds on InsertLeave
+    api.nvim_create_autocmd('InsertLeave', {
+      once = true,
+      callback = vim._foldupdate,
+    })
+    return
   end
 
-  return levels
-end)
+  vim._foldupdate()
+end
+
+---@param bufnr integer
+---@param foldinfo FoldInfo
+---@param tree_changes Range4[]
+local function on_changedtree(bufnr, foldinfo, tree_changes)
+  -- For some reason, queries seem to use the old buffer state in on_bytes.
+  -- Get around this by scheduling and manually updating folds.
+  vim.schedule(function()
+    for _, change in ipairs(tree_changes) do
+      local srow, _, erow = Range.unpack4(change)
+      get_folds_levels(bufnr, foldinfo, srow, erow)
+    end
+    recompute_folds()
+  end)
+end
+
+---@param bufnr integer
+---@param foldinfo FoldInfo
+---@param start_row integer
+---@param old_row integer
+---@param new_row integer
+local function on_bytes(bufnr, foldinfo, start_row, old_row, new_row)
+  local end_row_old = start_row + old_row
+  local end_row_new = start_row + new_row
+  if new_row < old_row then
+    foldinfo:remove_range(end_row_old, end_row_new)
+  elseif new_row > old_row then
+    foldinfo:add_range(start_row, end_row_new)
+    vim.schedule(function()
+      get_folds_levels(bufnr, foldinfo, start_row, end_row_new)
+      recompute_folds()
+    end)
+  end
+end
 
 ---@param lnum integer|nil
 ---@return string
@@ -165,9 +233,27 @@ function M.foldexpr(lnum)
     return '0'
   end
 
-  local levels = folds_levels(bufnr) or {}
+  if not foldinfos[bufnr] then
+    foldinfos[bufnr] = FoldInfo.new()
+    get_folds_levels(bufnr, foldinfos[bufnr])
+
+    local parser = vim.treesitter.get_parser(bufnr)
+    parser:register_cbs({
+      on_changedtree = function(tree_changes)
+        on_changedtree(bufnr, foldinfos[bufnr], tree_changes)
+      end,
+
+      on_bytes = function(_, _, start_row, _, _, old_row, _, _, new_row, _, _)
+        on_bytes(bufnr, foldinfos[bufnr], start_row, old_row, new_row)
+      end,
+
+      on_detach = function()
+        foldinfos[bufnr] = nil
+      end,
+    })
+  end
 
-  return levels[lnum] or '0'
+  return foldinfos[bufnr].levels[lnum] or '0'
 end
 
 return M
-- 
cgit 


From 75537768ef0b8cc35ef9c6aa906237e449640b46 Mon Sep 17 00:00:00 2001
From: Null Chilly <56817415+nullchilly@users.noreply.github.com>
Date: Fri, 10 Mar 2023 20:10:38 +0700
Subject: perf(lsp): better binary search mid calculation in semantic token
 (#22607)

This commit replaces the usage of math.floor((lo + hi) / 2) with the faster and equivalent bit.rshift(lo + hi, 1) for calculating the midpoint in binary search.
---
 runtime/lua/vim/lsp/semantic_tokens.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index a5e007a011..03532c33b7 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -44,7 +44,7 @@ local STHighlighter = { active = {} }
 ---@private
 local function lower_bound(tokens, line, lo, hi)
   while lo < hi do
-    local mid = math.floor((lo + hi) / 2)
+    local mid = bit.rshift(lo + hi, 1) -- Equivalent to floor((lo + hi) / 2).
     if tokens[mid].line < line then
       lo = mid + 1
     else
@@ -62,7 +62,7 @@ end
 ---@private
 local function upper_bound(tokens, line, lo, hi)
   while lo < hi do
-    local mid = math.floor((lo + hi) / 2)
+    local mid = bit.rshift(lo + hi, 1) -- Equivalent to floor((lo + hi) / 2).
     if line < tokens[mid].line then
       hi = mid
     else
-- 
cgit 


From 762a06c6bcfbcc1e40ba670bae10bacdbb973524 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 10 Mar 2023 16:16:49 +0000
Subject: feat!(treesitter): do not return changes from LanguageTree:parse()

Never return the changes an only notify them using the `on_changedtree`
callback.

It is not guaranteed for a plugin that it'll be the first one to call
`tree:parse()` and thus get the changes.

Closes #19915
---
 runtime/lua/vim/treesitter/languagetree.lua | 11 ++---------
 1 file changed, 2 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index c89419085f..26321cd1f4 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -228,7 +228,6 @@ end
 --- determine if any child languages should be created.
 ---
 ---@return TSTree[]
----@return table|nil Change list
 function LanguageTree:parse()
   if self:is_valid() then
     self:_log('valid')
@@ -302,18 +301,12 @@ function LanguageTree:parse()
   })
 
   self:for_each_child(function(child)
-    local _, child_changes = child:parse()
-
-    -- Propagate any child changes so they are included in the
-    -- the change list for the callback.
-    if child_changes then
-      vim.list_extend(changes, child_changes)
-    end
+    child:parse()
   end)
 
   self._valid = true
 
-  return self._trees, changes
+  return self._trees
 end
 
 --- Invokes the callback for each |LanguageTree| and its children recursively
-- 
cgit 


From 9d70fe062ca01ac0673faa6ccbb88345916aeea7 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 10 Mar 2023 16:10:05 +0000
Subject: feat(treesitter)!: consolidate query util functions

- And address more type errors.
- Removed the `concat` option from `get_node_text` since it was applied
  inconsistently and made typing awkward.
---
 runtime/lua/vim/treesitter/_fold.lua        | 15 +----
 runtime/lua/vim/treesitter/_range.lua       | 15 ++++-
 runtime/lua/vim/treesitter/languagetree.lua | 55 +++++-----------
 runtime/lua/vim/treesitter/query.lua        | 97 ++++++++++++++---------------
 4 files changed, 79 insertions(+), 103 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index 435cb9fdb6..fd2c707d17 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -1,4 +1,5 @@
 local Range = require('vim.treesitter._range')
+local Query = require('vim.treesitter.query')
 
 local api = vim.api
 
@@ -74,18 +75,6 @@ function FoldInfo:get_stop(lnum)
   return self.stop_counts[lnum] or 0
 end
 
----@private
---- TODO(lewis6991): copied from languagetree.lua. Consolidate
----@param node TSNode
----@param metadata TSMetadata
----@return Range4
-local function get_range_from_metadata(node, metadata)
-  if metadata and metadata.range then
-    return metadata.range --[[@as Range4]]
-  end
-  return { node:range() }
-end
-
 local function trim_level(level)
   local max_fold_level = vim.wo.foldnestmax
   if level > max_fold_level then
@@ -118,7 +107,7 @@ local function get_folds_levels(bufnr, info, srow, erow)
 
     for id, node, metadata in query:iter_captures(tree:root(), bufnr, srow or 0, q_erow) do
       if query.captures[id] == 'fold' then
-        local range = get_range_from_metadata(node, metadata[id])
+        local range = Query.get_range(node, bufnr, metadata[id])
         local start, _, stop, stop_col = Range.unpack4(range)
 
         if stop_col == 0 then
diff --git a/runtime/lua/vim/treesitter/_range.lua b/runtime/lua/vim/treesitter/_range.lua
index 02918da23f..0017a567ec 100644
--- a/runtime/lua/vim/treesitter/_range.lua
+++ b/runtime/lua/vim/treesitter/_range.lua
@@ -2,8 +2,19 @@ local api = vim.api
 
 local M = {}
 
----@alias Range4 {[1]: integer, [2]: integer, [3]: integer, [4]: integer}
----@alias Range6 {[1]: integer, [2]: integer, [3]: integer, [4]: integer, [5]: integer, [6]: integer}
+---@class Range4
+---@field [1] integer start row
+---@field [2] integer start column
+---@field [3] integer end row
+---@field [4] integer end column
+
+---@class Range6
+---@field [1] integer start row
+---@field [2] integer start column
+---@field [3] integer start bytes
+---@field [4] integer end row
+---@field [5] integer end column
+---@field [6] integer end bytes
 
 ---@private
 ---@param a_row integer
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index c89419085f..0bb0601241 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -455,7 +455,7 @@ end
 --- nodes, which is useful for templating languages like ERB and EJS.
 ---
 ---@private
----@param new_regions Range4[][] List of regions this tree should manage and parse.
+---@param new_regions Range6[][] List of regions this tree should manage and parse.
 function LanguageTree:set_included_regions(new_regions)
   -- Transform the tables from 4 element long to 6 element long (with byte offset)
   for _, region in ipairs(new_regions) do
@@ -483,18 +483,6 @@ function LanguageTree:included_regions()
   return self._regions
 end
 
----@private
----@param node TSNode
----@param source integer|string
----@param metadata TSMetadata
----@return Range6
-local function get_range_from_metadata(node, source, metadata)
-  if metadata and metadata.range then
-    return Range.add_bytes(source, metadata.range --[[@as Range4|Range6]])
-  end
-  return { node:range(true) }
-end
-
 ---@private
 --- TODO(lewis6991): cleanup of the node_range interface
 ---@param node TSNode
@@ -502,7 +490,7 @@ end
 ---@param metadata TSMetadata
 ---@return Range6[]
 local function get_node_ranges(node, source, metadata, include_children)
-  local range = get_range_from_metadata(node, source, metadata)
+  local range = query.get_range(node, source, metadata)
 
   if include_children then
     return { range }
@@ -565,31 +553,18 @@ local function add_injection(t, tree_index, pattern, lang, combined, ranges)
   table.insert(t[tree_index][lang][pattern].regions, ranges)
 end
 
----@private
----Get node text
----
----Note: `query.get_node_text` returns string|string[]|nil so use this simple alias function
----to annotate it returns string.
----
----TODO(lewis6991): use [at]overload annotations on `query.get_node_text`
----@param node TSNode
----@param source integer|string
----@param metadata table
----@return string
-local function get_node_text(node, source, metadata)
-  return query.get_node_text(node, source, { metadata = metadata }) --[[@as string]]
-end
-
 ---@private
 --- Extract injections according to:
 --- https://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection
 ---@param match table<integer,TSNode>
----@param metadata table
+---@param metadata TSMetadata
 ---@return string, boolean, Range4[]
 function LanguageTree:_get_injection(match, metadata)
   local ranges = {} ---@type Range4[]
   local combined = metadata['injection.combined'] ~= nil
-  local lang = metadata['injection.language'] ---@type string
+  local lang = metadata['injection.language']
+  assert(type(lang) == 'string')
+
   local include_children = metadata['injection.include-children'] ~= nil
 
   for id, node in pairs(match) do
@@ -597,7 +572,7 @@ function LanguageTree:_get_injection(match, metadata)
 
     -- Lang should override any other language tag
     if name == 'injection.language' then
-      lang = get_node_text(node, self._source, metadata[id])
+      lang = query.get_node_text(node, self._source, { metadata = metadata[id] })
     elseif name == 'injection.content' then
       ranges = get_node_ranges(node, self._source, metadata[id], include_children)
     end
@@ -608,11 +583,11 @@ end
 
 ---@private
 ---@param match table<integer,TSNode>
----@param metadata table
+---@param metadata TSMetadata
 ---@return string, boolean, Range4[]
 function LanguageTree:_get_injection_deprecated(match, metadata)
   local lang = nil ---@type string
-  local ranges = {} ---@type Range4[]
+  local ranges = {} ---@type Range6[]
   local combined = metadata.combined ~= nil
 
   -- Directives can configure how injections are captured as well as actual node captures.
@@ -630,8 +605,10 @@ function LanguageTree:_get_injection_deprecated(match, metadata)
     end
   end
 
-  if metadata.language then
-    lang = metadata.language ---@type string
+  local mlang = metadata.language
+  if mlang ~= nil then
+    assert(type(mlang) == 'string')
+    lang = mlang
   end
 
   -- You can specify the content and language together
@@ -642,11 +619,11 @@ function LanguageTree:_get_injection_deprecated(match, metadata)
 
     -- Lang should override any other language tag
     if name == 'language' and not lang then
-      lang = get_node_text(node, self._source, metadata[id])
+      lang = query.get_node_text(node, self._source, { metadata = metadata[id] })
     elseif name == 'combined' then
       combined = true
     elseif name == 'content' and #ranges == 0 then
-      ranges[#ranges + 1] = get_range_from_metadata(node, self._source, metadata[id])
+      ranges[#ranges + 1] = query.get_range(node, self._source, metadata[id])
       -- Ignore any tags that start with "_"
       -- Allows for other tags to be used in matches
     elseif string.sub(name, 1, 1) ~= '_' then
@@ -655,7 +632,7 @@ function LanguageTree:_get_injection_deprecated(match, metadata)
       end
 
       if #ranges == 0 then
-        ranges[#ranges + 1] = get_range_from_metadata(node, self._source, metadata[id])
+        ranges[#ranges + 1] = query.get_range(node, self._source, metadata[id])
       end
     end
   end
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index e7cf42283d..70af4f7bce 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -1,6 +1,8 @@
 local a = vim.api
 local language = require('vim.treesitter.language')
 
+local Range = require('vim.treesitter._range')
+
 ---@class Query
 ---@field captures string[] List of captures used in query
 ---@field info TSQueryInfo Contains used queries, predicates, directives
@@ -56,35 +58,13 @@ local function add_included_lang(base_langs, lang, ilang)
 end
 
 ---@private
----@param buf (integer)
----@param range (table)
----@param concat (boolean)
----@returns (string[]|string|nil)
-local function buf_range_get_text(buf, range, concat)
-  local lines
-  local start_row, start_col, end_row, end_col = unpack(range)
-  local eof_row = a.nvim_buf_line_count(buf)
-  if start_row >= eof_row then
-    return nil
-  end
-
-  if end_col == 0 then
-    lines = a.nvim_buf_get_lines(buf, start_row, end_row, true)
-    end_col = -1
-  else
-    lines = a.nvim_buf_get_lines(buf, start_row, end_row + 1, true)
-  end
-
-  if #lines > 0 then
-    if #lines == 1 then
-      lines[1] = string.sub(lines[1], start_col + 1, end_col)
-    else
-      lines[1] = string.sub(lines[1], start_col + 1)
-      lines[#lines] = string.sub(lines[#lines], 1, end_col)
-    end
-  end
-
-  return concat and table.concat(lines, '\n') or lines
+---@param buf integer
+---@param range Range6
+---@returns string
+local function buf_range_get_text(buf, range)
+  local start_row, start_col, end_row, end_col = Range.unpack4(range)
+  local lines = a.nvim_buf_get_text(buf, start_row, start_col, end_row, end_col, {})
+  return table.concat(lines, '\n')
 end
 
 --- Gets the list of files used to make up a query
@@ -256,14 +236,28 @@ function M.parse_query(lang, query)
   local cached = query_cache[lang][query]
   if cached then
     return cached
-  else
-    local self = setmetatable({}, Query)
-    self.query = vim._ts_parse_query(lang, query)
-    self.info = self.query:inspect()
-    self.captures = self.info.captures
-    query_cache[lang][query] = self
-    return self
   end
+
+  local self = setmetatable({}, Query)
+  self.query = vim._ts_parse_query(lang, query)
+  self.info = self.query:inspect()
+  self.captures = self.info.captures
+  query_cache[lang][query] = self
+  return self
+end
+
+---Get the range of a |TSNode|. Can also supply {source} and {metadata}
+---to get the range with directives applied.
+---@param node TSNode
+---@param source integer|string|nil Buffer or string from which the {node} is extracted
+---@param metadata TSMetadata|nil
+---@return Range6
+function M.get_range(node, source, metadata)
+  if metadata and metadata.range then
+    assert(source)
+    return Range.add_bytes(source, metadata.range)
+  end
+  return { node:range(true) }
 end
 
 --- Gets the text corresponding to a given node
@@ -271,24 +265,22 @@ end
 ---@param node TSNode
 ---@param source (integer|string) Buffer or string from which the {node} is extracted
 ---@param opts (table|nil) Optional parameters.
----          - concat: (boolean) Concatenate result in a string (default true)
 ---          - metadata (table) Metadata of a specific capture. This would be
 ---            set to `metadata[capture_id]` when using |vim.treesitter.add_directive()|.
----@return (string[]|string|nil)
+---@return string
 function M.get_node_text(node, source, opts)
   opts = opts or {}
-  -- TODO(lewis6991): concat only works when source is number.
-  local concat = vim.F.if_nil(opts.concat, true)
   local metadata = opts.metadata or {}
 
   if metadata.text then
     return metadata.text
   elseif type(source) == 'number' then
-    return metadata.range and buf_range_get_text(source, metadata.range, concat)
-      or buf_range_get_text(source, { node:range() }, concat)
-  elseif type(source) == 'string' then
-    return source:sub(select(3, node:start()) + 1, select(3, node:end_()))
+    local range = M.get_range(node, source, metadata)
+    return buf_range_get_text(source, range)
   end
+
+  ---@cast source string
+  return source:sub(select(3, node:start()) + 1, select(3, node:end_()))
 end
 
 ---@alias TSMatch table<integer,TSNode>
@@ -312,7 +304,7 @@ local predicate_handlers = {
       str = predicate[3]
     else
       -- (#eq? @aa @bb)
-      str = M.get_node_text(match[predicate[3]], source) --[[@as string]]
+      str = M.get_node_text(match[predicate[3]], source)
     end
 
     if node_text ~= str or str == nil then
@@ -328,7 +320,7 @@ local predicate_handlers = {
       return true
     end
     local regex = predicate[3]
-    return string.find(M.get_node_text(node, source) --[[@as string]], regex) ~= nil
+    return string.find(M.get_node_text(node, source), regex) ~= nil
   end,
 
   ['match?'] = (function()
@@ -366,7 +358,7 @@ local predicate_handlers = {
     if not node then
       return true
     end
-    local node_text = M.get_node_text(node, source) --[[@as string]]
+    local node_text = M.get_node_text(node, source)
 
     for i = 3, #predicate do
       if string.find(node_text, predicate[i], 1, true) then
@@ -404,9 +396,9 @@ local predicate_handlers = {
 predicate_handlers['vim-match?'] = predicate_handlers['match?']
 
 ---@class TSMetadata
+---@field range Range4|Range6
 ---@field [integer] TSMetadata
 ---@field [string] integer|string
----@field range Range4
 
 ---@alias TSDirective fun(match: TSMatch, _, _, predicate: (string|integer)[], metadata: TSMetadata)
 
@@ -465,13 +457,20 @@ local directive_handlers = {
     assert(#pred == 4)
 
     local id = pred[2]
+    assert(type(id) == 'number')
+
     local node = match[id]
     local text = M.get_node_text(node, bufnr, { metadata = metadata[id] }) or ''
 
     if not metadata[id] then
       metadata[id] = {}
     end
-    metadata[id].text = text:gsub(pred[3], pred[4])
+
+    local pattern, replacement = pred[3], pred[3]
+    assert(type(pattern) == 'string')
+    assert(type(replacement) == 'string')
+
+    metadata[id].text = text:gsub(pattern, replacement)
   end,
 }
 
-- 
cgit 


From 236c20795eb9f11e21e0719b735ea741711acc08 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sat, 11 Mar 2023 07:35:23 +0100
Subject: revert: "fix(lsp): use buffer scheme for files not stored on disk"
 (#22604)

Although using `buffer://` for unsaved file buffers fixes issues with
language servers like eclipse.jdt.ls or ansible-language-server, it
breaks completion and signature help for clangd.

A regression is worse than a fix for something else, so this reverts
commit 896d672736b32a8f4a4fa51844b44f266dcdcc6c.

The spec change is also still in dicussion, see
https://github.com/microsoft/language-server-protocol/pull/1679#discussion_r1130704886
---
 runtime/lua/vim/lsp.lua      | 54 ++++++++++----------------------------------
 runtime/lua/vim/lsp/util.lua |  9 ++------
 2 files changed, 14 insertions(+), 49 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index c85d38a50e..117b32dc57 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -369,7 +369,7 @@ do
   --- @field offset_encoding "utf-8"|"utf-16"|"utf-32"
   ---
   --- @class CTBufferState
-  --- @field uri string uri of the buffer
+  --- @field name string name of the buffer
   --- @field lines string[] snapshot of buffer lines from last didChange
   --- @field lines_tmp string[]
   --- @field pending_changes table[] List of debounced changes in incremental sync mode
@@ -488,12 +488,8 @@ do
     if buf_state then
       buf_state.refs = buf_state.refs + 1
     else
-      local uri = vim.uri_from_bufnr(bufnr)
-      if not uv.fs_stat(api.nvim_buf_get_name(bufnr)) then
-        uri = uri:gsub('^file://', 'buffer://')
-      end
       buf_state = {
-        uri = uri,
+        name = api.nvim_buf_get_name(bufnr),
         lines = {},
         lines_tmp = {},
         pending_changes = {},
@@ -508,26 +504,12 @@ do
   end
 
   ---@private
-  ---@param client table
-  ---@param bufnr integer
-  ---@return string uri
-  function changetracking._get_uri(client, bufnr)
-    local state = state_by_group[get_group(client)] or {}
-    local buf_state = (state.buffers or {})[bufnr]
-    return assert(buf_state.uri, 'Must have an URI set')
-  end
-
-  ---@private
-  ---@param client table
-  ---@param bufnr integer
-  ---@param uri string
-  ---@return string uri
-  function changetracking._get_and_set_uri(client, bufnr, uri)
+  function changetracking._get_and_set_name(client, bufnr, name)
     local state = state_by_group[get_group(client)] or {}
     local buf_state = (state.buffers or {})[bufnr]
-    local old_uri = buf_state.uri
-    buf_state.uri = uri
-    return old_uri
+    local old_name = buf_state.name
+    buf_state.name = name
+    return old_name
   end
 
   ---@private
@@ -614,7 +596,7 @@ do
         { text = buf_get_full_text(bufnr) },
       }
     end
-    local uri = buf_state.uri
+    local uri = vim.uri_from_bufnr(bufnr)
     for _, client in pairs(state.clients) do
       if not client.is_stopped() and lsp.buf_is_attached(bufnr, client.id) then
         client.notify('textDocument/didChange', {
@@ -727,14 +709,11 @@ local function text_document_did_open_handler(bufnr, client)
     return
   end
   local filetype = nvim_buf_get_option(bufnr, 'filetype')
-  local uri = vim.uri_from_bufnr(bufnr)
-  if not uv.fs_stat(api.nvim_buf_get_name(bufnr)) then
-    uri = uri:gsub('^file://', 'buffer://')
-  end
+
   local params = {
     textDocument = {
       version = 0,
-      uri = uri,
+      uri = vim.uri_from_bufnr(bufnr),
       languageId = client.config.get_language_id(bufnr, filetype),
       text = buf_get_full_text(bufnr),
     },
@@ -1611,13 +1590,8 @@ local function text_document_did_save_handler(bufnr)
   local text = once(buf_get_full_text)
   for_each_buffer_client(bufnr, function(client)
     local name = api.nvim_buf_get_name(bufnr)
-    local old_uri = changetracking._get_and_set_uri(client, bufnr, uri)
-    if old_uri and name ~= old_uri then
-      client.notify('textDocument/didClose', {
-        textDocument = {
-          uri = old_uri,
-        },
-      })
+    local old_name = changetracking._get_and_set_name(client, bufnr, name)
+    if old_name and name ~= old_name then
       client.notify('textDocument/didOpen', {
         textDocument = {
           version = 0,
@@ -1720,12 +1694,8 @@ function lsp.buf_attach_client(bufnr, client_id)
         end)
       end,
       on_detach = function()
+        local params = { textDocument = { uri = uri } }
         for_each_buffer_client(bufnr, function(client, _)
-          local params = {
-            textDocument = {
-              uri = changetracking._get_uri(client, bufnr),
-            },
-          }
           changetracking.reset_buf(client, bufnr)
           if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
             client.notify('textDocument/didClose', params)
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index c9613dc7a7..342fad33c2 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -2032,12 +2032,7 @@ end
 ---@returns `TextDocumentIdentifier`
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentIdentifier
 function M.make_text_document_params(bufnr)
-  bufnr = bufnr or 0
-  local uri = vim.uri_from_bufnr(bufnr)
-  if not uv.fs_stat(api.nvim_buf_get_name(bufnr)) then
-    uri = uri:gsub('^file://', 'buffer://')
-  end
-  return { uri = uri }
+  return { uri = vim.uri_from_bufnr(bufnr or 0) }
 end
 
 --- Create the workspace params
@@ -2070,7 +2065,7 @@ function M.make_formatting_params(options)
     insertSpaces = vim.bo.expandtab,
   })
   return {
-    textDocument = M.make_text_document_params(0),
+    textDocument = { uri = vim.uri_from_bufnr(0) },
     options = options,
   }
 end
-- 
cgit 


From c2f7f8d61c6436e1de13d921f13760fbdfe1d624 Mon Sep 17 00:00:00 2001
From: nullchilly <nullchilly@gmail.com>
Date: Sat, 11 Mar 2023 17:23:50 +0700
Subject: refactor(highlight)!: remove deprecated functions
 vim.highlight.create/link

---
 runtime/lua/vim/highlight.lua | 24 ------------------------
 1 file changed, 24 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/highlight.lua b/runtime/lua/vim/highlight.lua
index 89eae0def5..d71a806ea8 100644
--- a/runtime/lua/vim/highlight.lua
+++ b/runtime/lua/vim/highlight.lua
@@ -10,30 +10,6 @@ M.priorities = {
   user = 200,
 }
 
----@private
-function M.create(higroup, hi_info, default)
-  vim.deprecate('vim.highlight.create', 'vim.api.nvim_set_hl', '0.9')
-  local options = {}
-  -- TODO: Add validation
-  for k, v in pairs(hi_info) do
-    table.insert(options, string.format('%s=%s', k, v))
-  end
-  vim.cmd(
-    string.format(
-      [[highlight %s %s %s]],
-      default and 'default' or '',
-      higroup,
-      table.concat(options, ' ')
-    )
-  )
-end
-
----@private
-function M.link(higroup, link_to, force)
-  vim.deprecate('vim.highlight.link', 'vim.api.nvim_set_hl', '0.9')
-  vim.cmd(string.format([[highlight%s link %s %s]], force and '!' or ' default', higroup, link_to))
-end
-
 --- Highlight range between two positions
 ---
 ---@param bufnr integer Buffer number to apply highlighting to
-- 
cgit 


From 71eebd28d1da487fbbb3c162c6b909940f76883d Mon Sep 17 00:00:00 2001
From: nullchilly <nullchilly@gmail.com>
Date: Sat, 11 Mar 2023 17:24:48 +0700
Subject: refactor(treesitter)!: remove deprecated show_tree func

---
 runtime/lua/vim/treesitter.lua | 6 ------
 1 file changed, 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 5723cce563..56000f99a8 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -648,12 +648,6 @@ function M.inspect_tree(opts)
   })
 end
 
----@deprecated
----@private
-function M.show_tree()
-  vim.deprecate('show_tree', 'inspect_tree', '0.9', nil, false)
-end
-
 --- Returns the fold level for {lnum} in the current buffer. Can be set directly to 'foldexpr':
 --- <pre>lua
 --- vim.wo.foldexpr = 'v:lua.vim.treesitter.foldexpr()'
-- 
cgit 


From 865d8d4720ca72de1c385773ca4c597f3642874c Mon Sep 17 00:00:00 2001
From: Raphael <glephunter@gmail.com>
Date: Sat, 11 Mar 2023 21:49:53 +0800
Subject: refactor(lsp): remove _resolve_capabilities_compat (#22628)

---
 runtime/lua/vim/lsp/protocol.lua | 174 ---------------------------------------
 1 file changed, 174 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 27dd68645a..1686e22c48 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -854,7 +854,6 @@ function protocol.make_client_capabilities()
   }
 end
 
-local if_nil = vim.F.if_nil
 --- Creates a normalized object describing LSP server capabilities.
 ---@param server_capabilities table Table of capabilities supported by the server
 ---@return table Normalized table of capabilities
@@ -892,178 +891,5 @@ function protocol.resolve_capabilities(server_capabilities)
   return server_capabilities
 end
 
----@private
---- Creates a normalized object describing LSP server capabilities.
--- @deprecated access resolved_capabilities instead
----@param server_capabilities table Table of capabilities supported by the server
----@return table Normalized table of capabilities
-function protocol._resolve_capabilities_compat(server_capabilities)
-  local general_properties = {}
-  local text_document_sync_properties
-  do
-    local TextDocumentSyncKind = protocol.TextDocumentSyncKind
-    local textDocumentSync = server_capabilities.textDocumentSync
-    if textDocumentSync == nil then
-      -- Defaults if omitted.
-      text_document_sync_properties = {
-        text_document_open_close = false,
-        text_document_did_change = TextDocumentSyncKind.None,
-        --        text_document_did_change = false;
-        text_document_will_save = false,
-        text_document_will_save_wait_until = false,
-        text_document_save = false,
-        text_document_save_include_text = false,
-      }
-    elseif type(textDocumentSync) == 'number' then
-      -- Backwards compatibility
-      if not TextDocumentSyncKind[textDocumentSync] then
-        return nil, 'Invalid server TextDocumentSyncKind for textDocumentSync'
-      end
-      text_document_sync_properties = {
-        text_document_open_close = true,
-        text_document_did_change = textDocumentSync,
-        text_document_will_save = false,
-        text_document_will_save_wait_until = false,
-        text_document_save = true,
-        text_document_save_include_text = false,
-      }
-    elseif type(textDocumentSync) == 'table' then
-      text_document_sync_properties = {
-        text_document_open_close = if_nil(textDocumentSync.openClose, false),
-        text_document_did_change = if_nil(textDocumentSync.change, TextDocumentSyncKind.None),
-        text_document_will_save = if_nil(textDocumentSync.willSave, true),
-        text_document_will_save_wait_until = if_nil(textDocumentSync.willSaveWaitUntil, true),
-        text_document_save = if_nil(textDocumentSync.save, false),
-        text_document_save_include_text = if_nil(
-          type(textDocumentSync.save) == 'table' and textDocumentSync.save.includeText,
-          false
-        ),
-      }
-    else
-      return nil, string.format('Invalid type for textDocumentSync: %q', type(textDocumentSync))
-    end
-  end
-  general_properties.completion = server_capabilities.completionProvider ~= nil
-  general_properties.hover = server_capabilities.hoverProvider or false
-  general_properties.goto_definition = server_capabilities.definitionProvider or false
-  general_properties.find_references = server_capabilities.referencesProvider or false
-  general_properties.document_highlight = server_capabilities.documentHighlightProvider or false
-  general_properties.document_symbol = server_capabilities.documentSymbolProvider or false
-  general_properties.workspace_symbol = server_capabilities.workspaceSymbolProvider or false
-  general_properties.document_formatting = server_capabilities.documentFormattingProvider or false
-  general_properties.document_range_formatting = server_capabilities.documentRangeFormattingProvider
-    or false
-  general_properties.call_hierarchy = server_capabilities.callHierarchyProvider or false
-  general_properties.execute_command = server_capabilities.executeCommandProvider ~= nil
-
-  if server_capabilities.renameProvider == nil then
-    general_properties.rename = false
-  elseif type(server_capabilities.renameProvider) == 'boolean' then
-    general_properties.rename = server_capabilities.renameProvider
-  else
-    general_properties.rename = true
-  end
-
-  if server_capabilities.codeLensProvider == nil then
-    general_properties.code_lens = false
-    general_properties.code_lens_resolve = false
-  elseif type(server_capabilities.codeLensProvider) == 'table' then
-    general_properties.code_lens = true
-    general_properties.code_lens_resolve = server_capabilities.codeLensProvider.resolveProvider
-      or false
-  else
-    error('The server sent invalid codeLensProvider')
-  end
-
-  if server_capabilities.codeActionProvider == nil then
-    general_properties.code_action = false
-  elseif
-    type(server_capabilities.codeActionProvider) == 'boolean'
-    or type(server_capabilities.codeActionProvider) == 'table'
-  then
-    general_properties.code_action = server_capabilities.codeActionProvider
-  else
-    error('The server sent invalid codeActionProvider')
-  end
-
-  if server_capabilities.declarationProvider == nil then
-    general_properties.declaration = false
-  elseif type(server_capabilities.declarationProvider) == 'boolean' then
-    general_properties.declaration = server_capabilities.declarationProvider
-  elseif type(server_capabilities.declarationProvider) == 'table' then
-    general_properties.declaration = server_capabilities.declarationProvider
-  else
-    error('The server sent invalid declarationProvider')
-  end
-
-  if server_capabilities.typeDefinitionProvider == nil then
-    general_properties.type_definition = false
-  elseif type(server_capabilities.typeDefinitionProvider) == 'boolean' then
-    general_properties.type_definition = server_capabilities.typeDefinitionProvider
-  elseif type(server_capabilities.typeDefinitionProvider) == 'table' then
-    general_properties.type_definition = server_capabilities.typeDefinitionProvider
-  else
-    error('The server sent invalid typeDefinitionProvider')
-  end
-
-  if server_capabilities.implementationProvider == nil then
-    general_properties.implementation = false
-  elseif type(server_capabilities.implementationProvider) == 'boolean' then
-    general_properties.implementation = server_capabilities.implementationProvider
-  elseif type(server_capabilities.implementationProvider) == 'table' then
-    general_properties.implementation = server_capabilities.implementationProvider
-  else
-    error('The server sent invalid implementationProvider')
-  end
-
-  local workspace = server_capabilities.workspace
-  local workspace_properties = {}
-  if workspace == nil or workspace.workspaceFolders == nil then
-    -- Defaults if omitted.
-    workspace_properties = {
-      workspace_folder_properties = {
-        supported = false,
-        changeNotifications = false,
-      },
-    }
-  elseif type(workspace.workspaceFolders) == 'table' then
-    workspace_properties = {
-      workspace_folder_properties = {
-        supported = if_nil(workspace.workspaceFolders.supported, false),
-        changeNotifications = if_nil(workspace.workspaceFolders.changeNotifications, false),
-      },
-    }
-  else
-    error('The server sent invalid workspace')
-  end
-
-  local signature_help_properties
-  if server_capabilities.signatureHelpProvider == nil then
-    signature_help_properties = {
-      signature_help = false,
-      signature_help_trigger_characters = {},
-    }
-  elseif type(server_capabilities.signatureHelpProvider) == 'table' then
-    signature_help_properties = {
-      signature_help = true,
-      -- The characters that trigger signature help automatically.
-      signature_help_trigger_characters = server_capabilities.signatureHelpProvider.triggerCharacters
-        or {},
-    }
-  else
-    error('The server sent invalid signatureHelpProvider')
-  end
-
-  local capabilities = vim.tbl_extend(
-    'error',
-    text_document_sync_properties,
-    signature_help_properties,
-    workspace_properties,
-    general_properties
-  )
-
-  return capabilities
-end
-
 return protocol
 -- vim:sw=2 ts=2 et
-- 
cgit 


From 23dc2a59b6e13b0dbab47c6c64ac5a55095b258b Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sat, 11 Mar 2023 14:50:14 +0100
Subject: fix(lsp): send didClose on buffer rename (#22623)

Subset of https://github.com/neovim/neovim/pull/22407 that was reverted
in https://github.com/neovim/neovim/pull/22604

If a buffer is renamed sending `didClose` for the old buffer helps
ensure the language server doesn't keep a stale document in memory.
---
 runtime/lua/vim/lsp.lua | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 117b32dc57..1896543da3 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1,3 +1,4 @@
+---@diagnostic disable: invisible
 local default_handlers = require('vim.lsp.handlers')
 local log = require('vim.lsp.log')
 local lsp_rpc = require('vim.lsp.rpc')
@@ -1592,6 +1593,11 @@ local function text_document_did_save_handler(bufnr)
     local name = api.nvim_buf_get_name(bufnr)
     local old_name = changetracking._get_and_set_name(client, bufnr, name)
     if old_name and name ~= old_name then
+      client.notify('textDocument/didClose', {
+        textDocument = {
+          uri = vim.uri_from_fname(old_name),
+        },
+      })
       client.notify('textDocument/didOpen', {
         textDocument = {
           version = 0,
-- 
cgit 


From 0ce626b783dcca8eed08a2bb5a18e2c3ef931fbe Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sat, 11 Mar 2023 22:50:53 +0900
Subject: docs(lsp): more precise type annotations (#22621)

---
 runtime/lua/vim/lsp.lua | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 1896543da3..39665a3d4f 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1038,7 +1038,7 @@ function lsp.start_client(config)
   --- Returns the default handler if the user hasn't set a custom one.
   ---
   ---@param method (string) LSP method name
-  ---@return function|nil The handler for the given method, if defined, or the default from |vim.lsp.handlers|
+  ---@return lsp-handler|nil The handler for the given method, if defined, or the default from |vim.lsp.handlers|
   local function resolve_handler(method)
     return handlers[method] or default_handlers[method]
   end
@@ -1938,7 +1938,7 @@ api.nvim_create_autocmd('VimLeavePre', {
 ---@param bufnr (integer) Buffer handle, or 0 for current.
 ---@param method (string) LSP method name
 ---@param params table|nil Parameters to send to the server
----@param handler function|nil See |lsp-handler|
+---@param handler lsp-handler|nil See |lsp-handler|
 ---       If nil, follows resolution strategy defined in |lsp-handler-configuration|
 ---
 ---@return table<integer, integer>, fun() 2-tuple:
@@ -1998,9 +1998,10 @@ end
 ---@param bufnr (integer) Buffer handle, or 0 for current.
 ---@param method (string) LSP method name
 ---@param params (table|nil) Parameters to send to the server
----@param callback (function) The callback to call when all requests are finished.
+---@param callback fun(request_results: table<integer, {error: lsp.ResponseError, result: any}>) (function)
+--- The callback to call when all requests are finished.
 --- Unlike `buf_request`, this will collect all the responses from each server instead of handling them.
---- A map of client_id:request_result will be provided to the callback
+--- A map of client_id:request_result will be provided to the callback.
 ---
 ---@return fun() cancel A function that will cancel all requests
 function lsp.buf_request_all(bufnr, method, params, callback)
@@ -2043,9 +2044,8 @@ end
 ---@param timeout_ms (integer|nil) Maximum time in milliseconds to wait for a
 ---                               result. Defaults to 1000
 ---
----@return table<integer, any>|nil result, string|nil err Map of client_id:request_result.
---- On timeout, cancel or error, returns `(nil, err)` where `err` is a string describing
---- the failure reason.
+---@return table<integer, {err: lsp.ResponseError, result: any}>|nil (table) result Map of client_id:request_result.
+---@return string|nil err On timeout, cancel, or error, `err` is a string describing the failure reason, and `result` is nil.
 function lsp.buf_request_sync(bufnr, method, params, timeout_ms)
   local request_results
 
-- 
cgit 


From 58bbc2ea0b3dfed13471e8cc0447d7598be24276 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 10 Mar 2023 16:40:27 +0000
Subject: refactor(treesitter): add Range type aliase for Range4|Range6

---
 runtime/lua/vim/treesitter/_range.lua       | 14 ++++++++------
 runtime/lua/vim/treesitter/languagetree.lua | 15 ++++++---------
 runtime/lua/vim/treesitter/query.lua        | 12 ++++++++++--
 3 files changed, 24 insertions(+), 17 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_range.lua b/runtime/lua/vim/treesitter/_range.lua
index 0017a567ec..f4db5016ac 100644
--- a/runtime/lua/vim/treesitter/_range.lua
+++ b/runtime/lua/vim/treesitter/_range.lua
@@ -16,6 +16,8 @@ local M = {}
 ---@field [5] integer end column
 ---@field [6] integer end bytes
 
+---@alias Range Range4|Range6
+
 ---@private
 ---@param a_row integer
 ---@param a_col integer
@@ -85,8 +87,8 @@ function M.validate(r)
 end
 
 ---@private
----@param r1 Range4|Range6
----@param r2 Range4|Range6
+---@param r1 Range
+---@param r2 Range
 ---@return boolean
 function M.intercepts(r1, r2)
   local srow_1, scol_1, erow_1, ecol_1 = M.unpack4(r1)
@@ -106,7 +108,7 @@ function M.intercepts(r1, r2)
 end
 
 ---@private
----@param r Range4|Range6
+---@param r Range
 ---@return integer, integer, integer, integer
 function M.unpack4(r)
   local off_1 = #r == 6 and 1 or 0
@@ -121,8 +123,8 @@ function M.unpack6(r)
 end
 
 ---@private
----@param r1 Range4|Range6
----@param r2 Range4|Range6
+---@param r1 Range
+---@param r2 Range
 ---@return boolean whether r1 contains r2
 function M.contains(r1, r2)
   local srow_1, scol_1, erow_1, ecol_1 = M.unpack4(r1)
@@ -143,7 +145,7 @@ end
 
 ---@private
 ---@param source integer|string
----@param range Range4|Range6
+---@param range Range
 ---@return Range6
 function M.add_bytes(source, range)
   if type(range) == 'table' and #range == 6 then
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 0bb0601241..6869fae92c 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -484,7 +484,6 @@ function LanguageTree:included_regions()
 end
 
 ---@private
---- TODO(lewis6991): cleanup of the node_range interface
 ---@param node TSNode
 ---@param source string|integer
 ---@param metadata TSMetadata
@@ -530,7 +529,7 @@ end
 ---@param pattern integer
 ---@param lang string
 ---@param combined boolean
----@param ranges Range4[]
+---@param ranges Range6[]
 local function add_injection(t, tree_index, pattern, lang, combined, ranges)
   assert(type(lang) == 'string')
 
@@ -558,13 +557,11 @@ end
 --- https://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection
 ---@param match table<integer,TSNode>
 ---@param metadata TSMetadata
----@return string, boolean, Range4[]
+---@return string?, boolean, Range6[]
 function LanguageTree:_get_injection(match, metadata)
-  local ranges = {} ---@type Range4[]
+  local ranges = {} ---@type Range6[]
   local combined = metadata['injection.combined'] ~= nil
-  local lang = metadata['injection.language']
-  assert(type(lang) == 'string')
-
+  local lang = metadata['injection.language'] --[[@as string?]]
   local include_children = metadata['injection.include-children'] ~= nil
 
   for id, node in pairs(match) do
@@ -584,7 +581,7 @@ end
 ---@private
 ---@param match table<integer,TSNode>
 ---@param metadata TSMetadata
----@return string, boolean, Range4[]
+---@return string, boolean, Range6[]
 function LanguageTree:_get_injection_deprecated(match, metadata)
   local lang = nil ---@type string
   local ranges = {} ---@type Range6[]
@@ -910,7 +907,7 @@ end
 
 ---@private
 ---@param tree TSTree
----@param range Range4
+---@param range Range
 ---@return boolean
 local function tree_contains(tree, range)
   return Range.contains({ tree:root():range() }, range)
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 70af4f7bce..f4e038b2d8 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -59,10 +59,18 @@ end
 
 ---@private
 ---@param buf integer
----@param range Range6
+---@param range Range
 ---@returns string
 local function buf_range_get_text(buf, range)
   local start_row, start_col, end_row, end_col = Range.unpack4(range)
+  if end_col == 0 then
+    if start_row == end_row then
+      start_col = -1
+      start_row = start_row - 1
+    end
+    end_col = -1
+    end_row = end_row - 1
+  end
   local lines = a.nvim_buf_get_text(buf, start_row, start_col, end_row, end_col, {})
   return table.concat(lines, '\n')
 end
@@ -396,7 +404,7 @@ local predicate_handlers = {
 predicate_handlers['vim-match?'] = predicate_handlers['match?']
 
 ---@class TSMetadata
----@field range Range4|Range6
+---@field range Range
 ---@field [integer] TSMetadata
 ---@field [string] integer|string
 
-- 
cgit 


From d15abd1be4ae85b10174e3ee139d3b7605e87577 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sun, 12 Mar 2023 09:45:28 +0100
Subject: fix(lsp): use line start/end for visual line selection (#22632)

Fixes https://github.com/neovim/neovim/issues/22629
---
 runtime/lua/vim/lsp/buf.lua | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 6ac885c78f..0e16e8f820 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -118,8 +118,10 @@ function M.completion(context)
 end
 
 ---@private
+---@param bufnr integer
+---@param mode "v"|"V"
 ---@return table {start={row, col}, end={row, col}} using (1, 0) indexing
-local function range_from_selection()
+local function range_from_selection(bufnr, mode)
   -- TODO: Use `vim.region()` instead https://github.com/neovim/neovim/pull/13896
 
   -- [bufnum, lnum, col, off]; both row and column 1-indexed
@@ -138,6 +140,11 @@ local function range_from_selection()
     start_row, end_row = end_row, start_row
     start_col, end_col = end_col, start_col
   end
+  if mode == 'V' then
+    start_col = 1
+    local lines = api.nvim_buf_get_lines(bufnr, end_row - 1, end_row, true)
+    end_col = #lines[1]
+  end
   return {
     ['start'] = { start_row, start_col - 1 },
     ['end'] = { end_row, end_col - 1 },
@@ -200,7 +207,7 @@ function M.format(options)
   local mode = api.nvim_get_mode().mode
   local range = options.range
   if not range and mode == 'v' or mode == 'V' then
-    range = range_from_selection()
+    range = range_from_selection(bufnr, mode)
   end
   local method = range and 'textDocument/rangeFormatting' or 'textDocument/formatting'
 
@@ -772,7 +779,7 @@ function M.code_action(options)
     local end_ = assert(options.range['end'], 'range must have a `end` property')
     params = util.make_given_range_params(start, end_)
   elseif mode == 'v' or mode == 'V' then
-    local range = range_from_selection()
+    local range = range_from_selection(0, mode)
     params = util.make_given_range_params(range.start, range['end'])
   else
     params = util.make_range_params()
-- 
cgit 


From 673d2b52fa4335aa083c52e6686f0728e25b8ebd Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Tue, 7 Mar 2023 16:04:57 +0100
Subject: refactor!: rename vim.pretty_print => vim.print

Problem:
The function name `vim.pretty_print`:
1. is verbose, which partially defeats its purpose as sugar
2. does not draw from existing precedent or any sort of convention
   (except external projects like penlight or python?), which reduces
   discoverability, and degrades signaling about best practices.

Solution:
- Rename to `vim.print`.
- Change the behavior so that
  1. strings are printed without quotes
  2. each arg is printed on its own line
  3. tables are indented with 2 instead of 4 spaces
- Example:
  :lua ='a', 'b', 42, {a=3}
  a
  b
  42
  {
    a = 3
  }

Comparison of alternatives:
- `vim.print`:
  - pro: consistent with Lua's `print()`
  - pro: aligns with potential `nvim_print` API function which will
    replace nvim_echo, nvim_notify, etc.
  - con: behaves differently than Lua's `print()`, slightly misleading?
- `vim.echo`:
  - pro: `:echo` has similar "pretty print" behavior.
  - con: inconsistent with Lua idioms.
- `vim.p`:
  - pro: very short, fits with `vim.o`, etc.
  - con: not as discoverable as "echo"
  - con: less opportunity for `local p = vim.p` because of potential shadowing.
---
 runtime/lua/vim/_editor.lua | 39 +++++++++++++++++++++++++++------------
 1 file changed, 27 insertions(+), 12 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 9516233b45..5445c4e492 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -778,22 +778,37 @@ do
   end
 end
 
----Prints given arguments in human-readable format.
----Example:
----<pre>lua
----  -- Print highlight group Normal and store it's contents in a variable.
----  local hl_normal = vim.pretty_print(vim.api.nvim_get_hl_by_name("Normal", true))
----</pre>
----@see |vim.inspect()|
----@return any # given arguments.
+---@private
 function vim.pretty_print(...)
-  local objects = {}
+  vim.deprecate('vim.pretty_print', 'vim.print', '0.10')
+  return vim.print(...)
+end
+
+--- "Pretty prints" the given arguments and returns them unmodified.
+---
+--- Example:
+--- <pre>lua
+---   local hl_normal = vim.print(vim.api.nvim_get_hl_by_name('Normal', true))
+--- </pre>
+---
+--- @see |vim.inspect()|
+--- @return any # given arguments.
+function vim.print(...)
+  if vim.in_fast_event() then
+    print(...)
+    return ...
+  end
+
   for i = 1, select('#', ...) do
-    local v = select(i, ...)
-    table.insert(objects, vim.inspect(v))
+    local o = select(i, ...)
+    if type(o) == 'string' then
+      vim.api.nvim_out_write(o)
+    else
+      vim.api.nvim_out_write(vim.inspect(o, { newline = '\n', indent = '  ' }))
+    end
+    vim.api.nvim_out_write('\n')
   end
 
-  print(table.concat(objects, '    '))
   return ...
 end
 
-- 
cgit 


From 35799a6629f10cc49e79381e61038b3a4ca3bb23 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 13 Mar 2023 10:44:43 +0000
Subject: fix(treesitter): foldexpr (#22652)

The ranges passed to foldinfo.remove_range were in the wrong order.
---
 runtime/lua/vim/treesitter/_fold.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index fd2c707d17..90f4394fcc 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -200,8 +200,9 @@ end
 local function on_bytes(bufnr, foldinfo, start_row, old_row, new_row)
   local end_row_old = start_row + old_row
   local end_row_new = start_row + new_row
+
   if new_row < old_row then
-    foldinfo:remove_range(end_row_old, end_row_new)
+    foldinfo:remove_range(end_row_new, end_row_old)
   elseif new_row > old_row then
     foldinfo:add_range(start_row, end_row_new)
     vim.schedule(function()
-- 
cgit 


From f01f18cdf4ffc3ce035db5fde2f45493eebb7fd9 Mon Sep 17 00:00:00 2001
From: Dan Strokirk <dan.strokirk@gmail.com>
Date: Mon, 13 Mar 2023 14:01:34 +0100
Subject: fix(lsp): remove_workspace_folders fails if client has no
 workspace_folders #22633

When a client has no workspace_folders, (e.g., copilot), `pairs`
code would crash.
---
 runtime/lua/vim/lsp/buf.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 0e16e8f820..8bf3764f5e 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -530,7 +530,7 @@ function M.remove_workspace_folder(workspace_folder)
     { { uri = vim.uri_from_fname(workspace_folder), name = workspace_folder } }
   )
   for _, client in pairs(vim.lsp.get_active_clients({ bufnr = 0 })) do
-    for idx, folder in pairs(client.workspace_folders) do
+    for idx, folder in pairs(client.workspace_folders or {}) do
       if folder.name == workspace_folder then
         vim.lsp.buf_notify(0, 'workspace/didChangeWorkspaceFolders', params)
         client.workspace_folders[idx] = nil
-- 
cgit 


From 8dde7c907ca9ad365895bded2c2f59e08f65d3ed Mon Sep 17 00:00:00 2001
From: hrsh7th <629908+hrsh7th@users.noreply.github.com>
Date: Tue, 14 Mar 2023 20:59:43 +0900
Subject: fix(lsp): vim.lsp.util.apply_text_edits cursor validation #22636

Problem
Using wrong variable when checking the cursor position is valid or not in
vim.lsp.util.apply_text_edits.

Solution
Use the correct variable.
---
 runtime/lua/vim/lsp/util.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 342fad33c2..82c9e3bc87 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -436,7 +436,7 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
 
   -- Some LSP servers are depending on the VSCode behavior.
   -- The VSCode will re-locate the cursor position after applying TextEdit so we also do it.
-  local is_current_buf = api.nvim_get_current_buf() == bufnr
+  local is_current_buf = api.nvim_get_current_buf() == bufnr or bufnr == 0
   local cursor = (function()
     if not is_current_buf then
       return {
@@ -464,7 +464,7 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
       start_col = get_line_byte_from_position(bufnr, text_edit.range.start, offset_encoding),
       end_row = text_edit.range['end'].line,
       end_col = get_line_byte_from_position(bufnr, text_edit.range['end'], offset_encoding),
-      text = split(text_edit.newText, '\n', true),
+      text = split(text_edit.newText, '\n', { plain = true }),
     }
 
     local max = api.nvim_buf_line_count(bufnr)
@@ -522,7 +522,7 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
   if is_cursor_fixed then
     local is_valid_cursor = true
     is_valid_cursor = is_valid_cursor and cursor.row < max
-    is_valid_cursor = is_valid_cursor and cursor.col <= #(get_line(bufnr, max - 1) or '')
+    is_valid_cursor = is_valid_cursor and cursor.col <= #(get_line(bufnr, cursor.row) or '')
     if is_valid_cursor then
       api.nvim_win_set_cursor(0, { cursor.row + 1, cursor.col })
     end
-- 
cgit 


From 4f7879dff0f0dc22ddf4cb2a2095b88605a3bab0 Mon Sep 17 00:00:00 2001
From: Ivan <hello@iillexial.me>
Date: Tue, 14 Mar 2023 13:08:37 +0100
Subject: fix(lsp): kill buffers after renaming a directory #22618

Problem:

When LSP client renames a directory, opened buffers in the edfitor are not
renamed or closed. Then `:wall` shows errors.

https://github.com/neovim/neovim/blob/master/runtime/lua/vim/lsp/util.lua#L776
works correctly if you try to rename a single file, but doesn't delete old
buffers with `old_fname` is a dir.

Solution:
Update the logic in runtime/lua/vim/lsp/util.lua:rename()

Fixes #22617
---
 runtime/lua/vim/lsp/util.lua | 48 +++++++++++++++++++++++++++++++++++---------
 1 file changed, 38 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 82c9e3bc87..48faddfce1 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -743,6 +743,20 @@ local function bufwinid(bufnr)
   end
 end
 
+--- Get list of buffers for a directory
+---@private
+local function get_dir_bufs(path)
+  path = path:gsub('([^%w])', '%%%1')
+  local buffers = {}
+  for _, v in ipairs(vim.api.nvim_list_bufs()) do
+    local bufname = vim.api.nvim_buf_get_name(v):gsub('buffer://', '')
+    if bufname:find(path) then
+      table.insert(buffers, v)
+    end
+  end
+  return buffers
+end
+
 --- Rename old_fname to new_fname
 ---
 ---@param opts (table)
@@ -755,12 +769,22 @@ function M.rename(old_fname, new_fname, opts)
     vim.notify('Rename target already exists. Skipping rename.')
     return
   end
-  local oldbuf = vim.fn.bufadd(old_fname)
-  vim.fn.bufload(oldbuf)
 
-  -- The there may be pending changes in the buffer
-  if vim.fn.isdirectory(old_fname) == 0 then
-    api.nvim_buf_call(oldbuf, function()
+  local oldbufs = {}
+  local win = nil
+
+  if vim.fn.isdirectory(old_fname) == 1 then
+    oldbufs = get_dir_bufs(old_fname)
+  else
+    local oldbuf = vim.fn.bufadd(old_fname)
+    table.insert(oldbufs, oldbuf)
+    win = bufwinid(oldbuf)
+  end
+
+  for _, b in ipairs(oldbufs) do
+    vim.fn.bufload(b)
+    -- The there may be pending changes in the buffer
+    api.nvim_buf_call(b, function()
       vim.cmd('w!')
     end)
   end
@@ -768,12 +792,16 @@ function M.rename(old_fname, new_fname, opts)
   local ok, err = os.rename(old_fname, new_fname)
   assert(ok, err)
 
-  local newbuf = vim.fn.bufadd(new_fname)
-  local win = bufwinid(oldbuf)
-  if win then
-    api.nvim_win_set_buf(win, newbuf)
+  if vim.fn.isdirectory(new_fname) == 0 then
+    local newbuf = vim.fn.bufadd(new_fname)
+    if win then
+      api.nvim_win_set_buf(win, newbuf)
+    end
+  end
+
+  for _, b in ipairs(oldbufs) do
+    api.nvim_buf_delete(b, {})
   end
-  api.nvim_buf_delete(oldbuf, { force = true })
 end
 
 ---@private
-- 
cgit 


From 210120dde81ec289ae01e1d247df08f0b147c08a Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Wed, 15 Mar 2023 08:56:13 -0400
Subject: fix(lua): vim.deprecate() shows ":help deprecated" #22677

Problem:
vim.deprecate() shows ":help deprecated" for third-party plugins. ":help
deprecated" only describes deprecations in Nvim, and is unrelated to any
3rd party deprecations.

Solution:
If `plugin` is specified, don't show  ":help deprecated".

fix #22235
---
 runtime/lua/vim/_editor.lua | 41 +++++++++++++++++++++--------------------
 1 file changed, 21 insertions(+), 20 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 5445c4e492..f2875e5646 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -518,11 +518,6 @@ do
   end
 end
 
----@private
-function vim.register_keystroke_callback()
-  error('vim.register_keystroke_callback is deprecated, instead use: vim.on_key')
-end
-
 local on_key_cbs = {}
 
 --- Adds Lua function {fn} with namespace id {ns_id} as a listener to every,
@@ -882,27 +877,33 @@ function vim._cs_remote(rcid, server_addr, connect_error, args)
   }
 end
 
---- Display a deprecation notification to the user.
+--- Shows a deprecation message to the user.
 ---
----@param name        string     Deprecated function.
----@param alternative string|nil Preferred alternative function.
----@param version     string     Version in which the deprecated function will
----                              be removed.
----@param plugin      string|nil Plugin name that the function will be removed
----                              from. Defaults to "Nvim".
+---@param name        string     Deprecated feature (function, API, etc.).
+---@param alternative string|nil Suggested alternative feature.
+---@param version     string     Version when the deprecated function will be removed.
+---@param plugin      string|nil Name of the plugin that owns the deprecated feature.
+---                              Defaults to "Nvim".
 ---@param backtrace   boolean|nil Prints backtrace. Defaults to true.
+---
+---@returns Deprecated message, or nil if no message was shown.
 function vim.deprecate(name, alternative, version, plugin, backtrace)
-  local message = name .. ' is deprecated'
+  local msg = ('%s is deprecated'):format(name)
   plugin = plugin or 'Nvim'
-  message = alternative and (message .. ', use ' .. alternative .. ' instead.') or message
-  message = message
-    .. ' See :h deprecated\nThis function will be removed in '
-    .. plugin
-    .. ' version '
-    .. version
-  if vim.notify_once(message, vim.log.levels.WARN) and backtrace ~= false then
+  msg = alternative and ('%s, use %s instead.'):format(msg, alternative) or msg
+  msg = ('%s%s\nThis feature will be removed in %s version %s'):format(
+    msg,
+    (plugin == 'Nvim' and ' :help deprecated' or ''),
+    plugin,
+    version
+  )
+  local displayed = vim.notify_once(msg, vim.log.levels.WARN)
+  if displayed and backtrace ~= false then
     vim.notify(debug.traceback('', 2):sub(2), vim.log.levels.WARN)
   end
+  if displayed then
+    return msg
+  end
 end
 
 --- Create builtin mappings (incl. menus).
-- 
cgit 


From 43d33c5d1abb7ed58237cb5e59d6e1e7dd046b55 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 17 Mar 2023 09:40:25 +0100
Subject: vim-patch:9.0.1406: ILE RPG files are not recognized

Problem:    ILE RPG files are not recognized.
Solution:   Add patterns for ILE RPG files. (Andreas Louv, issue vim/vim#12152)

https://github.com/vim/vim/commit/e202ec8a0c89e8ef47a3d38e668b7326fa68510a

Co-authored-by: Andreas Louv <andreas@louv.dk>
---
 runtime/lua/vim/filetype.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 1732623223..7be4b75138 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -883,6 +883,8 @@ local extension = {
   ron = 'ron',
   rsc = 'routeros',
   x = 'rpcgen',
+  rpgle = 'rpgle',
+  rpgleinc = 'rpgle',
   rpl = 'rpl',
   Srst = 'rrst',
   srst = 'rrst',
-- 
cgit 


From d7746b6ef1dcb64b3fc4ba744eafc69780772e26 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 17 Mar 2023 09:41:19 +0100
Subject: vim-patch:9.0.1407: TableGen files are not recognized

Problem:    TableGen files are not recognized.
Solution:   Add a pattern for TableGen files. (Amaan Qureshi, closes vim/vim#12156)

https://github.com/vim/vim/commit/b8ef029ee416fc2b402c3f321a55c9049b0ad2a9

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 7be4b75138..9eb03c776a 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1018,6 +1018,7 @@ local extension = {
   swift = 'swift',
   svh = 'systemverilog',
   sv = 'systemverilog',
+  td = 'tablegen',
   tak = 'tak',
   tal = 'tal',
   task = 'taskedit',
-- 
cgit 


From f83d8ea2798c87e441801ce5f08291808bf6ddbc Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 17 Mar 2023 09:42:01 +0100
Subject: vim-patch:9.0.1408: QMLdir files are not recognized

Problem:    QMLdir files are not recognized.
Solution:   Add a pattern for QMLdir files. (Amaan Qureshi, closes vim/vim#12161)

https://github.com/vim/vim/commit/1505bef5c482a48e704644e6172be91c07ef1d12

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 9eb03c776a..f5353b853d 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1593,6 +1593,7 @@ local filename = {
   ['.pythonstartup'] = 'python',
   ['.pythonrc'] = 'python',
   SConstruct = 'python',
+  qmldir = 'qmldir',
   ['.Rprofile'] = 'r',
   ['Rprofile'] = 'r',
   ['Rprofile.site'] = 'r',
-- 
cgit 


From 571b50be16a0bb859082196ac1a80872526314cb Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 17 Mar 2023 09:42:33 +0100
Subject: vim-patch:9.0.1409: racket files are recognized as scheme

Problem:    Racket files are recognized as scheme.
Solution:   Recognize rackets files separately. (Gabriel Kakizaki,
            closes vim/vim#12164, closes vim/vim#12162)

https://github.com/vim/vim/commit/d11ac403db07b6eac43882485e98caeb5e83e2e5

Co-authored-by: Gabriel Kakizaki <gkakizaki@gmail.com>
---
 runtime/lua/vim/filetype.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index f5353b853d..b777eaa179 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -838,6 +838,9 @@ local extension = {
   R = function(path, bufnr)
     return require('vim.filetype.detect').r(bufnr)
   end,
+  rkt = 'racket',
+  rktd = 'racket',
+  rktl = 'racket',
   rad = 'radiance',
   mat = 'radiance',
   ['pod6'] = 'raku',
@@ -910,9 +913,6 @@ local extension = {
   ss = 'scheme',
   scm = 'scheme',
   sld = 'scheme',
-  rkt = 'scheme',
-  rktd = 'scheme',
-  rktl = 'scheme',
   sce = 'scilab',
   sci = 'scilab',
   scss = 'scss',
-- 
cgit 


From 6162269fa3107b23fd18c6c6d0e3e8fb73cfb45e Mon Sep 17 00:00:00 2001
From: August Masquelier <31262046+levouh@users.noreply.github.com>
Date: Fri, 17 Mar 2023 05:26:13 -0600
Subject: fix(lsp): avoid switching buffers on lsp attach (#22689)

---
 runtime/lua/vim/lsp.lua | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 39665a3d4f..7e8c73ddb6 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1101,21 +1101,21 @@ function lsp.start_client(config)
       return true
     end
 
-    local old_bufnr = vim.fn.bufnr('')
     local last_set_from = vim.fn.gettext('\n\tLast set from ')
     local line = vim.fn.gettext(' line ')
+    local scriptname
 
-    vim.cmd.buffer(bufnr)
-    local scriptname = vim.fn
-      .execute('verbose set ' .. option .. '?')
-      :match(last_set_from .. '(.*)' .. line .. '%d+')
-    vim.cmd.buffer(old_bufnr)
+    vim.api.nvim_buf_call(bufnr, function()
+      scriptname = vim.fn
+        .execute('verbose set ' .. option .. '?')
+        :match(last_set_from .. '(.*)' .. line .. '%d+')
+    end)
 
     if not scriptname then
       return false
     end
-    local vimruntime = vim.fn.getenv('VIMRUNTIME')
-    return vim.startswith(vim.fn.expand(scriptname), vim.fn.expand(vimruntime))
+
+    return vim.startswith(vim.fn.expand(scriptname), vim.fn.expand('$VIMRUNTIME'))
   end
 
   ---@private
-- 
cgit 


From 2720d2c793b22e6c0c8719e5592922619fffdf7a Mon Sep 17 00:00:00 2001
From: Yochem van Rosmalen <yochem+git@icloud.com>
Date: Fri, 17 Mar 2023 12:41:57 +0100
Subject: fix(treesitter): InspectTree does not respect 'splitright' #22692

Problem:
vim.treesitter.inspect_tree() and :InspectTree does not respect 'splitright'.

Solution:
- Change the default `command` from `topleft 60vnew` to `60vnew`.
- Change :InspectTree to respect command mods (`:vertical`, count, etc.).

Closes #22656
---
 runtime/lua/vim/treesitter.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 56000f99a8..43b8c11b80 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -439,7 +439,7 @@ end
 ---                      - winid (integer|nil): Window id to display the tree buffer in. If omitted,
 ---                        a new window is created with {command}.
 ---                      - command (string|nil): Vimscript command to create the window. Default
----                        value is "topleft 60vnew". Only used when {winid} is nil.
+---                        value is "60vnew". Only used when {winid} is nil.
 ---                      - title (string|fun(bufnr:integer):string|nil): Title of the window. If a
 ---                        function, it accepts the buffer number of the source buffer as its only
 ---                        argument and should return a string.
@@ -465,7 +465,7 @@ function M.inspect_tree(opts)
 
   local w = opts.winid
   if not w then
-    vim.cmd(opts.command or 'topleft 60vnew')
+    vim.cmd(opts.command or '60vnew')
     w = a.nvim_get_current_win()
   end
 
-- 
cgit 


From 66ba81a6f7b52c0a765fc52362ca8f730af487ab Mon Sep 17 00:00:00 2001
From: Amaan Qureshi <amaanq12@gmail.com>
Date: Sat, 18 Mar 2023 05:34:31 -0400
Subject: vim-patch:9.0.1412: Pony files are not recognized (#22721)

Problem:    Pony files are not recognized.
Solution:   Add a pattern for Pony files. (Amaan Qureshi, closes vim/vim#12155)

https://github.com/vim/vim/commit/6e377eca8de4c0c0d25808beb7de7676194ebf1d
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index b777eaa179..cf813b19b1 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -800,6 +800,7 @@ local extension = {
   pod = 'pod',
   filter = 'poefilter',
   pk = 'poke',
+  pony = 'pony',
   ps = 'postscr',
   epsi = 'postscr',
   afm = 'postscr',
-- 
cgit 


From e5641df6d3fc3bb6c3c55593b6152082bfc561b6 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sat, 11 Mar 2023 17:11:02 +0000
Subject: feat: add `vim.filetype.get_option()`

---
 runtime/lua/vim/filetype.lua         | 20 +++++++++
 runtime/lua/vim/filetype/options.lua | 82 ++++++++++++++++++++++++++++++++++++
 2 files changed, 102 insertions(+)
 create mode 100644 runtime/lua/vim/filetype/options.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index cf813b19b1..69fcb01e8c 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -2631,4 +2631,24 @@ function M.match(args)
   end
 end
 
+--- Get the default option value for a {filetype}.
+---
+--- The returned value is what would be set in a new buffer after 'filetype'
+--- is set, meaning it should respect all FileType autocmds and ftplugin files.
+---
+--- Example:
+--- <pre>lua
+---   vim.filetype.get_option('vim', 'commentstring')
+--- </pre>
+---
+--- Note: this uses |nvim_get_option_value()| but caches the result.
+--- This means |ftplugin| and |FileType| autocommands are only
+--- triggered once and may not reflect later changes.
+--- @param filetype string Filetype
+--- @param option string Option name
+--- @return string|boolean|integer: Option value
+function M.get_option(filetype, option)
+  return require('vim.filetype.options').get_option(filetype, option)
+end
+
 return M
diff --git a/runtime/lua/vim/filetype/options.lua b/runtime/lua/vim/filetype/options.lua
new file mode 100644
index 0000000000..77a66991d5
--- /dev/null
+++ b/runtime/lua/vim/filetype/options.lua
@@ -0,0 +1,82 @@
+local api = vim.api
+
+local M = {}
+
+local function get_ftplugin_runtime(filetype)
+  return api.nvim__get_runtime({
+    string.format('ftplugin/%s.vim', filetype),
+    string.format('ftplugin/%s_*.vim', filetype),
+    string.format('ftplugin/%s/*.vim', filetype),
+    string.format('ftplugin/%s.lua', filetype),
+    string.format('ftplugin/%s_*.lua', filetype),
+    string.format('ftplugin/%s/*.lua', filetype),
+  }, true, {}) --[[@as string[] ]]
+end
+
+-- Keep track of ftplugin files
+local ftplugin_cache = {} ---@type table<string,table<string,integer>>
+
+-- Keep track of total number of FileType autocmds
+local ft_autocmd_num ---@type integer?
+
+-- Keep track of filetype options
+local ft_option_cache = {} ---@type table<string,table<string,any>>
+
+--- @param path string
+--- @return integer
+local function hash(path)
+  local mtime0 = vim.loop.fs_stat(path).mtime
+  return mtime0.sec * 1000000000 + mtime0.nsec
+end
+
+--- Only update the cache on changes to the number of FileType autocmds
+--- and changes to any ftplugin/ file. This isn't guaranteed to catch everything
+--- but should be good enough.
+--- @param filetype string
+local function update_ft_option_cache(filetype)
+  local new_ftautos = #api.nvim_get_autocmds({ event = 'FileType' })
+  if new_ftautos ~= ft_autocmd_num then
+    -- invalidate
+    ft_option_cache[filetype] = nil
+    ft_autocmd_num = new_ftautos
+  end
+
+  local files = get_ftplugin_runtime(filetype)
+
+  ftplugin_cache[filetype] = ftplugin_cache[filetype] or {}
+
+  if #files ~= #vim.tbl_keys(ftplugin_cache[filetype]) then
+    -- invalidate
+    ft_option_cache[filetype] = nil
+    ftplugin_cache[filetype] = {}
+  end
+
+  for _, f in ipairs(files) do
+    -- VIMRUNTIME should be static so shouldn't need to worry about it changing
+    if not vim.startswith(f, vim.env.VIMRUNTIME) then
+      local mtime = hash(f)
+      if ftplugin_cache[filetype][f] ~= mtime then
+        -- invalidate
+        ft_option_cache[filetype] = nil
+        ftplugin_cache[filetype][f] = mtime
+      end
+    end
+  end
+end
+
+--- @private
+--- @param filetype string Filetype
+--- @param option string Option name
+--- @return string|integer|boolean
+function M.get_option(filetype, option)
+  update_ft_option_cache(filetype)
+
+  if not ft_option_cache[filetype] or not ft_option_cache[filetype][option] then
+    ft_option_cache[filetype] = ft_option_cache[filetype] or {}
+    ft_option_cache[filetype][option] = api.nvim_get_option_value(option, { filetype = filetype })
+  end
+
+  return ft_option_cache[filetype][option]
+end
+
+return M
-- 
cgit 


From 990c481551af2b346f315d75aa0815e9b65051f3 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Thu, 16 Mar 2023 14:50:20 +0100
Subject: refactor(vim.version): use lazy.nvim semver module

Use semver code from https://github.com/folke/lazy.nvim
License: Apache License 2.0

Co-authored-by: Folke Lemaitre <folke.lemaitre@gmail.com>
---
 runtime/lua/vim/version.lua | 191 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 191 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index 35629c461f..b409483755 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -1,5 +1,196 @@
 local M = {}
 
+local LazyM = {}
+M.LazyM = LazyM
+
+---@class Semver
+---@field [1] number
+---@field [2] number
+---@field [3] number
+---@field major number
+---@field minor number
+---@field patch number
+---@field prerelease? string
+---@field build? string
+local Semver = {}
+Semver.__index = Semver
+
+function Semver:__index(key)
+  return type(key) == "number" and ({ self.major, self.minor, self.patch })[key] or Semver[key]
+end
+
+function Semver:__newindex(key, value)
+  if key == 1 then
+    self.major = value
+  elseif key == 2 then
+    self.minor = value
+  elseif key == 3 then
+    self.patch = value
+  else
+    rawset(self, key, value)
+  end
+end
+
+---@param other Semver
+function Semver:__eq(other)
+  for i = 1, 3 do
+    if self[i] ~= other[i] then
+      return false
+    end
+  end
+  return self.prerelease == other.prerelease
+end
+
+function Semver:__tostring()
+  local ret = table.concat({ self.major, self.minor, self.patch }, ".")
+  if self.prerelease then
+    ret = ret .. "-" .. self.prerelease
+  end
+  if self.build then
+    ret = ret .. "+" .. self.build
+  end
+  return ret
+end
+
+---@param other Semver
+function Semver:__lt(other)
+  for i = 1, 3 do
+    if self[i] > other[i] then
+      return false
+    elseif self[i] < other[i] then
+      return true
+    end
+  end
+  if self.prerelease and not other.prerelease then
+    return true
+  end
+  if other.prerelease and not self.prerelease then
+    return false
+  end
+  return (self.prerelease or "") < (other.prerelease or "")
+end
+
+---@param other Semver
+function Semver:__le(other)
+  return self < other or self == other
+end
+
+---@param version string|number[]
+---@return Semver?
+function LazyM.parse(version)
+  if type(version) == "table" then
+    return setmetatable({
+      major = version[1] or 0,
+      minor = version[2] or 0,
+      patch = version[3] or 0,
+    }, Semver)
+  end
+  local major, minor, patch, prerelease, build = version:match("^v?(%d+)%.?(%d*)%.?(%d*)%-?([^+]*)+?(.*)$")
+  if major then
+    return setmetatable({
+      major = tonumber(major),
+      minor = minor == "" and 0 or tonumber(minor),
+      patch = patch == "" and 0 or tonumber(patch),
+      prerelease = prerelease ~= "" and prerelease or nil,
+      build = build ~= "" and build or nil,
+    }, Semver)
+  end
+end
+
+---@generic T: Semver
+---@param versions T[]
+---@return T?
+function LazyM.last(versions)
+  local last = versions[1]
+  for i = 2, #versions do
+    if versions[i] > last then
+      last = versions[i]
+    end
+  end
+  return last
+end
+
+---@class SemverRange
+---@field from Semver
+---@field to? Semver
+local Range = {}
+
+---@param version string|Semver
+function Range:matches(version)
+  if type(version) == "string" then
+    ---@diagnostic disable-next-line: cast-local-type
+    version = LazyM.parse(version)
+  end
+  if version then
+    if version.prerelease ~= self.from.prerelease then
+      return false
+    end
+    return version >= self.from and (self.to == nil or version < self.to)
+  end
+end
+
+---@param spec string
+function LazyM.range(spec)
+  if spec == "*" or spec == "" then
+    return setmetatable({ from = LazyM.parse("0.0.0") }, { __index = Range })
+  end
+
+  ---@type number?
+  local hyphen = spec:find(" - ", 1, true)
+  if hyphen then
+    local a = spec:sub(1, hyphen - 1)
+    local b = spec:sub(hyphen + 3)
+    local parts = vim.split(b, ".", { plain = true })
+    local ra = LazyM.range(a)
+    local rb = LazyM.range(b)
+    return setmetatable({
+      from = ra and ra.from,
+      to = rb and (#parts == 3 and rb.from or rb.to),
+    }, { __index = Range })
+  end
+  ---@type string, string
+  local mods, version = spec:lower():match("^([%^=>~]*)(.*)$")
+  version = version:gsub("%.[%*x]", "")
+  local parts = vim.split(version:gsub("%-.*", ""), ".", { plain = true })
+  if #parts < 3 and mods == "" then
+    mods = "~"
+  end
+
+  local semver = LazyM.parse(version)
+  if semver then
+    local from = semver
+    local to = vim.deepcopy(semver)
+    if mods == "" or mods == "=" then
+      to.patch = to.patch + 1
+    elseif mods == ">" then
+      from.patch = from.patch + 1
+      to = nil
+    elseif mods == ">=" then
+      to = nil
+    elseif mods == "~" then
+      if #parts >= 2 then
+        to[2] = to[2] + 1
+        to[3] = 0
+      else
+        to[1] = to[1] + 1
+        to[2] = 0
+        to[3] = 0
+      end
+    elseif mods == "^" then
+      for i = 1, 3 do
+        if to[i] ~= 0 then
+          to[i] = to[i] + 1
+          for j = i + 1, 3 do
+            to[j] = 0
+          end
+          break
+        end
+      end
+    end
+    return setmetatable({ from = from, to = to }, { __index = Range })
+  end
+end
+
 ---@private
 ---@param version string
 ---@return string
-- 
cgit 


From a715e6f87eede36775d0921b3537c7c57a82890a Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Thu, 16 Mar 2023 22:49:12 +0100
Subject: refactor(vim.version): use lazy.nvim semver module

Now the Nvim version string "v0.9.0-dev-1233+g210120dde81e" parses
correctly.
---
 runtime/lua/vim/version.lua | 295 +++++++++++---------------------------------
 1 file changed, 70 insertions(+), 225 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index b409483755..e79acf079b 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -16,7 +16,7 @@ local Semver = {}
 Semver.__index = Semver
 
 function Semver:__index(key)
-  return type(key) == "number" and ({ self.major, self.minor, self.patch })[key] or Semver[key]
+  return type(key) == 'number' and ({ self.major, self.minor, self.patch })[key] or Semver[key]
 end
 
 function Semver:__newindex(key, value)
@@ -42,12 +42,12 @@ function Semver:__eq(other)
 end
 
 function Semver:__tostring()
-  local ret = table.concat({ self.major, self.minor, self.patch }, ".")
+  local ret = table.concat({ self.major, self.minor, self.patch }, '.')
   if self.prerelease then
-    ret = ret .. "-" .. self.prerelease
+    ret = ret .. '-' .. self.prerelease
   end
   if self.build then
-    ret = ret .. "+" .. self.build
+    ret = ret .. '+' .. self.build
   end
   return ret
 end
@@ -67,7 +67,7 @@ function Semver:__lt(other)
   if other.prerelease and not self.prerelease then
     return false
   end
-  return (self.prerelease or "") < (other.prerelease or "")
+  return (self.prerelease or '') < (other.prerelease or '')
 end
 
 ---@param other Semver
@@ -76,23 +76,40 @@ function Semver:__le(other)
 end
 
 ---@param version string|number[]
+---@param strict? boolean Reject "1.0", "0-x" or other non-conforming version strings
 ---@return Semver?
-function LazyM.parse(version)
-  if type(version) == "table" then
+function LazyM.version(version, strict)
+  if type(version) == 'table' then
     return setmetatable({
       major = version[1] or 0,
       minor = version[2] or 0,
       patch = version[3] or 0,
     }, Semver)
   end
-  local major, minor, patch, prerelease, build = version:match("^v?(%d+)%.?(%d*)%.?(%d*)%-?([^+]*)+?(.*)$")
-  if major then
+
+  local prerel = version:match('%-([^+]*)')
+  local prerel_strict = version:match('%-([0-9A-Za-z-]*)')
+  if
+    strict
+    and prerel
+    and (prerel_strict == nil or prerel_strict == '' or not vim.startswith(prerel, prerel_strict))
+  then
+    return nil -- Invalid prerelease.
+  end
+  local build = prerel and version:match('%-[^+]*%+(.*)$') or version:match('%+(.*)$')
+  local major, minor, patch =
+    version:match('^v?(%d+)%.?(%d*)%.?(%d*)' .. (strict and (prerel and '%-' or '$') or ''))
+
+  if
+    (not strict and major)
+    or (major and minor and patch and major ~= '' and minor ~= '' and patch ~= '')
+  then
     return setmetatable({
       major = tonumber(major),
-      minor = minor == "" and 0 or tonumber(minor),
-      patch = patch == "" and 0 or tonumber(patch),
-      prerelease = prerelease ~= "" and prerelease or nil,
-      build = build ~= "" and build or nil,
+      minor = minor == '' and 0 or tonumber(minor),
+      patch = patch == '' and 0 or tonumber(patch),
+      prerelease = prerel ~= '' and prerel or nil,
+      build = build ~= '' and build or nil,
     }, Semver)
   end
 end
@@ -100,7 +117,7 @@ end
 ---@generic T: Semver
 ---@param versions T[]
 ---@return T?
-function LazyM.last(versions)
+function M.last(versions)
   local last = versions[1]
   for i = 2, #versions do
     if versions[i] > last then
@@ -117,9 +134,9 @@ local Range = {}
 
 ---@param version string|Semver
 function Range:matches(version)
-  if type(version) == "string" then
+  if type(version) == 'string' then
     ---@diagnostic disable-next-line: cast-local-type
-    version = LazyM.parse(version)
+    version = M.parse(version)
   end
   if version then
     if version.prerelease ~= self.from.prerelease then
@@ -131,16 +148,16 @@ end
 
 ---@param spec string
 function LazyM.range(spec)
-  if spec == "*" or spec == "" then
-    return setmetatable({ from = LazyM.parse("0.0.0") }, { __index = Range })
+  if spec == '*' or spec == '' then
+    return setmetatable({ from = M.parse('0.0.0') }, { __index = Range })
   end
 
   ---@type number?
-  local hyphen = spec:find(" - ", 1, true)
+  local hyphen = spec:find(' - ', 1, true)
   if hyphen then
     local a = spec:sub(1, hyphen - 1)
     local b = spec:sub(hyphen + 3)
-    local parts = vim.split(b, ".", { plain = true })
+    local parts = vim.split(b, '.', { plain = true })
     local ra = LazyM.range(a)
     local rb = LazyM.range(b)
     return setmetatable({
@@ -149,25 +166,25 @@ function LazyM.range(spec)
     }, { __index = Range })
   end
   ---@type string, string
-  local mods, version = spec:lower():match("^([%^=>~]*)(.*)$")
-  version = version:gsub("%.[%*x]", "")
-  local parts = vim.split(version:gsub("%-.*", ""), ".", { plain = true })
-  if #parts < 3 and mods == "" then
-    mods = "~"
+  local mods, version = spec:lower():match('^([%^=>~]*)(.*)$')
+  version = version:gsub('%.[%*x]', '')
+  local parts = vim.split(version:gsub('%-.*', ''), '.', { plain = true })
+  if #parts < 3 and mods == '' then
+    mods = '~'
   end
 
-  local semver = LazyM.parse(version)
+  local semver = M.parse(version)
   if semver then
     local from = semver
     local to = vim.deepcopy(semver)
-    if mods == "" or mods == "=" then
+    if mods == '' or mods == '=' then
       to.patch = to.patch + 1
-    elseif mods == ">" then
+    elseif mods == '>' then
       from.patch = from.patch + 1
-      to = nil
-    elseif mods == ">=" then
-      to = nil
-    elseif mods == "~" then
+      to = nil ---@diagnostic disable-line: cast-local-type
+    elseif mods == '>=' then
+      to = nil ---@diagnostic disable-line: cast-local-type
+    elseif mods == '~' then
       if #parts >= 2 then
         to[2] = to[2] + 1
         to[3] = 0
@@ -176,7 +193,7 @@ function LazyM.range(spec)
         to[2] = 0
         to[3] = 0
       end
-    elseif mods == "^" then
+    elseif mods == '^' then
       for i = 1, 3 do
         if to[i] ~= 0 then
           to[i] = to[i] + 1
@@ -192,7 +209,7 @@ function LazyM.range(spec)
 end
 
 ---@private
----@param version string
+---@param v string
 ---@return string
 local function create_err_msg(v)
   if type(v) == 'string' then
@@ -203,188 +220,36 @@ end
 
 ---@private
 --- Throws an error if `version` cannot be parsed.
----@param version string
-local function assert_version(version, opt)
-  local rv = M.parse(version, opt)
+---@param v string
+local function assert_version(v, opt)
+  local rv = M.parse(v, opt)
   if rv == nil then
-    error(create_err_msg(version))
+    error(create_err_msg(v))
   end
   return rv
 end
 
----@private
---- Compares the prerelease component of the two versions.
-local function cmp_prerelease(v1, v2)
-  if v1.prerelease and not v2.prerelease then
-    return -1
-  end
-  if not v1.prerelease and v2.prerelease then
-    return 1
-  end
-  if not v1.prerelease and not v2.prerelease then
-    return 0
-  end
-
-  local v1_identifiers = vim.split(v1.prerelease, '.', { plain = true })
-  local v2_identifiers = vim.split(v2.prerelease, '.', { plain = true })
-  local i = 1
-  local max = math.max(vim.tbl_count(v1_identifiers), vim.tbl_count(v2_identifiers))
-  while i <= max do
-    local v1_identifier = v1_identifiers[i]
-    local v2_identifier = v2_identifiers[i]
-    if v1_identifier ~= v2_identifier then
-      local v1_num = tonumber(v1_identifier)
-      local v2_num = tonumber(v2_identifier)
-      local is_number = v1_num and v2_num
-      if is_number then
-        -- Number comparisons
-        if not v1_num and v2_num then
-          return -1
-        end
-        if v1_num and not v2_num then
-          return 1
-        end
-        if v1_num == v2_num then
-          return 0
-        end
-        if v1_num > v2_num then
-          return 1
-        end
-        if v1_num < v2_num then
-          return -1
-        end
-      else
-        -- String comparisons
-        if v1_identifier and not v2_identifier then
-          return 1
-        end
-        if not v1_identifier and v2_identifier then
-          return -1
-        end
-        if v1_identifier < v2_identifier then
-          return -1
-        end
-        if v1_identifier > v2_identifier then
-          return 1
-        end
-        if v1_identifier == v2_identifier then
-          return 0
-        end
-      end
-    end
-    i = i + 1
-  end
-
-  return 0
-end
-
----@private
-local function cmp_version_core(v1, v2)
-  if v1.major == v2.major and v1.minor == v2.minor and v1.patch == v2.patch then
-    return 0
-  end
-  if
-    v1.major > v2.major
-    or (v1.major == v2.major and v1.minor > v2.minor)
-    or (v1.major == v2.major and v1.minor == v2.minor and v1.patch > v2.patch)
-  then
-    return 1
-  end
-  return -1
-end
-
---- Compares two strings (`v1` and `v2`) in semver format.
+--- Parses and compares two version strings.
+---
+--- semver notes:
+--- - Build metadata MUST be ignored when comparing versions.
+---
 ---@param v1 string Version.
 ---@param v2 string Version to compare with v1.
 ---@param opts table|nil Optional keyword arguments:
----                      - strict (boolean):  see `semver.parse` for details. Defaults to false.
+---                      - strict (boolean):  see `version.parse` for details. Defaults to false.
 ---@return integer `-1` if `v1 < v2`, `0` if `v1 == v2`, `1` if `v1 > v2`.
 function M.cmp(v1, v2, opts)
   opts = opts or { strict = false }
   local v1_parsed = assert_version(v1, opts)
   local v2_parsed = assert_version(v2, opts)
-
-  local result = cmp_version_core(v1_parsed, v2_parsed)
-  if result == 0 then
-    result = cmp_prerelease(v1_parsed, v2_parsed)
-  end
-  return result
-end
-
----@private
----@param labels string Prerelease and build component of semantic version string e.g. "-rc1+build.0".
----@return string|nil
-local function parse_prerelease(labels)
-  -- This pattern matches "-(alpha)+build.15".
-  -- '^%-[%w%.]+$'
-  local result = labels:match('^%-([%w%.]+)+.+$')
-  if result then
-    return result
-  end
-  -- This pattern matches "-(alpha)".
-  result = labels:match('^%-([%w%.]+)')
-  if result then
-    return result
-  end
-
-  return nil
-end
-
----@private
----@param labels string Prerelease and build component of semantic version string e.g. "-rc1+build.0".
----@return string|nil
-local function parse_build(labels)
-  -- Pattern matches "-alpha+(build.15)".
-  local result = labels:match('^%-[%w%.]+%+([%w%.]+)$')
-  if result then
-    return result
-  end
-
-  -- Pattern matches "+(build.15)".
-  result = labels:match('^%+([%w%.]+)$')
-  if result then
-    return result
+  if v1_parsed == v2_parsed then
+    return 0
   end
-
-  return nil
-end
-
----@private
---- Extracts the major, minor, patch and preprelease and build components from
---- `version`.
----@param version string Version string
-local function extract_components_strict(version)
-  local major, minor, patch, prerelease_and_build = version:match('^v?(%d+)%.(%d+)%.(%d+)(.*)$')
-  return tonumber(major), tonumber(minor), tonumber(patch), prerelease_and_build
-end
-
----@private
---- Extracts the major, minor, patch and preprelease and build components from
---- `version`. When `minor` and `patch` components are not found (nil), coerce
---- them to 0.
----@param version string Version string
-local function extract_components_loose(version)
-  local major, minor, patch, prerelease_and_build = version:match('^v?(%d+)%.?(%d*)%.?(%d*)(.*)$')
-  major = tonumber(major)
-  minor = tonumber(minor) or 0
-  patch = tonumber(patch) or 0
-  return major, minor, patch, prerelease_and_build
-end
-
----@private
---- Validates the prerelease and build string e.g. "-rc1+build.0". If the
---- prerelease, build or both are valid forms then it will return true, if it
---- is not of any valid form, it will return false.
----@param prerelease_and_build string
----@return boolean
-local function is_prerelease_and_build_valid(prerelease_and_build)
-  if prerelease_and_build == '' then
-    return true
+  if v1_parsed > v2_parsed then
+    return 1
   end
-  local has_build = parse_build(prerelease_and_build) ~= nil
-  local has_prerelease = parse_prerelease(prerelease_and_build) ~= nil
-  local has_prerelease_and_build = has_prerelease and has_build
-  return has_build or has_prerelease or has_prerelease_and_build
+  return -1
 end
 
 --- Parses a semantic version string.
@@ -405,34 +270,14 @@ function M.parse(version, opts)
   if type(version) ~= 'string' then
     error(create_err_msg(version))
   end
-
   opts = opts or { strict = false }
 
-  version = vim.trim(version)
-
-  local extract_components = opts.strict and extract_components_strict or extract_components_loose
-  local major, minor, patch, prerelease_and_build = extract_components(version)
-
-  -- If major is nil then that means that the version does not begin with a
-  -- digit with or without a "v" prefix.
-  if major == nil or not is_prerelease_and_build_valid(prerelease_and_build) then
-    return nil
-  end
-
-  local prerelease = nil
-  local build = nil
-  if prerelease_and_build ~= nil then
-    prerelease = parse_prerelease(prerelease_and_build)
-    build = parse_build(prerelease_and_build)
+  if opts.strict then
+    return LazyM.version(version, true)
   end
 
-  return {
-    major = major,
-    minor = minor,
-    patch = patch,
-    prerelease = prerelease,
-    build = build,
-  }
+  version = vim.trim(version) -- TODO: add more "scrubbing".
+  return LazyM.version(version, false)
 end
 
 ---Returns `true` if `v1` are `v2` are equal versions.
-- 
cgit 


From a40eb7cc991eb4f8b89f467e8e42563868efa76b Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Fri, 17 Mar 2023 01:12:33 +0100
Subject: feat(vim.version): more coercion with strict=false

Problem:
"tmux 3.2a" (output from "tmux -V") is not parsed easily.

Solution:
With `strict=false`, discard everything before the first digit.

- rename Semver => Version
- rename vim.version.version() => vim.version._version()
- rename matches() => has()
- remove `opts` from cmp()
---
 runtime/lua/vim/version.lua | 267 +++++++++++++++++++++++++++++---------------
 1 file changed, 174 insertions(+), 93 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index e79acf079b..8d8b0d6da7 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -1,9 +1,59 @@
-local M = {}
+--- @defgroup lua-version
+---
+--- @brief The \`vim.version\` module provides functions for comparing versions and ranges
+--- conforming to the https://semver.org spec. Plugins, and plugin managers, can use this to check
+--- available tools and dependencies on the current system.
+---
+--- Example:
+---   <pre>lua
+---   local v = vim.version.parse(vim.fn.system({'tmux', '-V'}), {strict=false})
+---   if vim.version.gt(v, {3, 2, 0}) then
+---     -- ...
+---   end
+---   </pre>
+---
+--- \*vim.version()\* returns the version of the current Nvim process.
+---
+--- VERSION RANGE SPEC \*version-range\*
+---
+--- A version "range spec" defines a semantic version range which can be tested against a version,
+--- using |vim.version.range()|.
+---
+--- Supported range specs are shown in the following table.
+--- Note: suffixed versions (1.2.3-rc1) are not matched.
+---   <pre>
+---   1.2.3             is 1.2.3
+---   =1.2.3            is 1.2.3
+---   >1.2.3            greater than 1.2.3
+---   <1.2.3            before 1.2.3
+---   >=1.2.3           at least 1.2.3
+---   ~1.2.3            is >=1.2.3 <1.3.0       "reasonably close to 1.2.3"
+---   ^1.2.3            is >=1.2.3 <2.0.0       "compatible with 1.2.3"
+---   ^0.2.3            is >=0.2.3 <0.3.0       (0.x.x is special)
+---   ^0.0.1            is =0.0.1               (0.0.x is special)
+---   ^1.2              is >=1.2.0 <2.0.0       (like ^1.2.0)
+---   ~1.2              is >=1.2.0 <1.3.0       (like ~1.2.0)
+---   ^1                is >=1.0.0 <2.0.0       "compatible with 1"
+---   ~1                same                    "reasonably close to 1"
+---   1.x               same
+---   1.*               same
+---   1                 same
+---   *                 any version
+---   x                 same
+---
+---   1.2.3 - 2.3.4     is >=1.2.3 <=2.3.4
+---
+---   Partial right: missing pieces treated as x (2.3 => 2.3.x).
+---   1.2.3 - 2.3       is >=1.2.3 <2.4.0
+---   1.2.3 - 2         is >=1.2.3 <3.0.0
+---
+---   Partial left: missing pieces treated as 0 (1.2 => 1.2.0).
+---   1.2 - 2.3.0       is 1.2.0 - 2.3.0
+---   </pre>
 
-local LazyM = {}
-M.LazyM = LazyM
+local M = {}
 
----@class Semver
+---@class Version
 ---@field [1] number
 ---@field [2] number
 ---@field [3] number
@@ -12,14 +62,14 @@ M.LazyM = LazyM
 ---@field patch number
 ---@field prerelease? string
 ---@field build? string
-local Semver = {}
-Semver.__index = Semver
+local Version = {}
+Version.__index = Version
 
-function Semver:__index(key)
-  return type(key) == 'number' and ({ self.major, self.minor, self.patch })[key] or Semver[key]
+function Version:__index(key)
+  return type(key) == 'number' and ({ self.major, self.minor, self.patch })[key] or Version[key]
 end
 
-function Semver:__newindex(key, value)
+function Version:__newindex(key, value)
   if key == 1 then
     self.major = value
   elseif key == 2 then
@@ -31,8 +81,8 @@ function Semver:__newindex(key, value)
   end
 end
 
----@param other Semver
-function Semver:__eq(other)
+---@param other Version
+function Version:__eq(other)
   for i = 1, 3 do
     if self[i] ~= other[i] then
       return false
@@ -41,7 +91,7 @@ function Semver:__eq(other)
   return self.prerelease == other.prerelease
 end
 
-function Semver:__tostring()
+function Version:__tostring()
   local ret = table.concat({ self.major, self.minor, self.patch }, '.')
   if self.prerelease then
     ret = ret .. '-' .. self.prerelease
@@ -52,8 +102,8 @@ function Semver:__tostring()
   return ret
 end
 
----@param other Semver
-function Semver:__lt(other)
+---@param other Version
+function Version:__lt(other)
   for i = 1, 3 do
     if self[i] > other[i] then
       return false
@@ -70,21 +120,32 @@ function Semver:__lt(other)
   return (self.prerelease or '') < (other.prerelease or '')
 end
 
----@param other Semver
-function Semver:__le(other)
+---@param other Version
+function Version:__le(other)
   return self < other or self == other
 end
 
----@param version string|number[]
----@param strict? boolean Reject "1.0", "0-x" or other non-conforming version strings
----@return Semver?
-function LazyM.version(version, strict)
+--- @private
+---
+--- Creates a new Version object. Not public currently.
+---
+--- @param version string|number[]|Version
+--- @param strict? boolean Reject "1.0", "0-x", "3.2a" or other non-conforming version strings
+--- @return Version?
+function M._version(version, strict) -- Adapted from https://github.com/folke/lazy.nvim
   if type(version) == 'table' then
+    if version.major then
+      return setmetatable(vim.deepcopy(version), Version)
+    end
     return setmetatable({
       major = version[1] or 0,
       minor = version[2] or 0,
       patch = version[3] or 0,
-    }, Semver)
+    }, Version)
+  end
+
+  if not strict then -- TODO: add more "scrubbing".
+    version = version:match('%d[^ ]*')
   end
 
   local prerel = version:match('%-([^+]*)')
@@ -110,11 +171,13 @@ function LazyM.version(version, strict)
       patch = patch == '' and 0 or tonumber(patch),
       prerelease = prerel ~= '' and prerel or nil,
       build = build ~= '' and build or nil,
-    }, Semver)
+    }, Version)
   end
 end
 
----@generic T: Semver
+---TODO: generalize this, move to func.lua
+---
+---@generic T: Version
 ---@param versions T[]
 ---@return T?
 function M.last(versions)
@@ -127,13 +190,15 @@ function M.last(versions)
   return last
 end
 
----@class SemverRange
----@field from Semver
----@field to? Semver
+---@class Range
+---@field from Version
+---@field to? Version
 local Range = {}
 
----@param version string|Semver
-function Range:matches(version)
+--- @private
+---
+---@param version string|Version
+function Range:has(version)
   if type(version) == 'string' then
     ---@diagnostic disable-next-line: cast-local-type
     version = M.parse(version)
@@ -146,8 +211,32 @@ function Range:matches(version)
   end
 end
 
----@param spec string
-function LazyM.range(spec)
+--- Parses a semver |version-range| "spec" and returns a range object:
+---   <pre>
+---   {
+---     from: Version
+---     to: Version
+---     has(v: string|Version)
+---   }
+---   </pre>
+---
+--- `:has()` checks if a version is in the range (inclusive `from`, exclusive `to`). Example:
+---   <pre>lua
+---   local r = vim.version.range('1.0.0 - 2.0.0')
+---   print(r:has('1.9.9'))  -- true
+---   print(r:has('2.0.0'))  -- false
+---   </pre>
+---
+--- Or use cmp(), eq(), lt(), and gt() to compare `.to` and `.from` directly:
+---   <pre>lua
+---   local r = vim.version.range('1.0.0 - 2.0.0')
+---   print(vim.version.gt({1,0,3}, r.from) and vim.version.lt({1,0,3}, r.to))
+---   </pre>
+---
+--- @see # https://github.com/npm/node-semver#ranges
+---
+--- @param spec string Version range "spec"
+function M.range(spec) -- Adapted from https://github.com/folke/lazy.nvim
   if spec == '*' or spec == '' then
     return setmetatable({ from = M.parse('0.0.0') }, { __index = Range })
   end
@@ -158,8 +247,8 @@ function LazyM.range(spec)
     local a = spec:sub(1, hyphen - 1)
     local b = spec:sub(hyphen + 3)
     local parts = vim.split(b, '.', { plain = true })
-    local ra = LazyM.range(a)
-    local rb = LazyM.range(b)
+    local ra = M.range(a)
+    local rb = M.range(b)
     return setmetatable({
       from = ra and ra.from,
       to = rb and (#parts == 3 and rb.from or rb.to),
@@ -209,40 +298,40 @@ function LazyM.range(spec)
 end
 
 ---@private
----@param v string
+---@param v string|Version
 ---@return string
 local function create_err_msg(v)
   if type(v) == 'string' then
     return string.format('invalid version: "%s"', tostring(v))
+  elseif type(v) == 'table' and v.major then
+    return string.format('invalid version: %s', vim.inspect(v))
   end
   return string.format('invalid version: %s (%s)', tostring(v), type(v))
 end
 
----@private
---- Throws an error if `version` cannot be parsed.
----@param v string
-local function assert_version(v, opt)
-  local rv = M.parse(v, opt)
-  if rv == nil then
-    error(create_err_msg(v))
-  end
-  return rv
-end
-
---- Parses and compares two version strings.
+--- Parses and compares two version version objects (the result of |vim.version.parse()|, or
+--- specified literally as a `{major, minor, patch}` tuple, e.g. `{1, 0, 3}`).
 ---
---- semver notes:
---- - Build metadata MUST be ignored when comparing versions.
+--- Example:
+--- <pre>lua
+---   if vim.version.cmp({1,0,3}, {0,2,1}) == 0 then
+---     -- ...
+---   end
+---   local v1 = vim.version.parse('1.0.3-pre')
+---   local v2 = vim.version.parse('0.2.1')
+---   if vim.version.cmp(v1, v2) == 0 then
+---     -- ...
+---   end
+--- </pre>
 ---
----@param v1 string Version.
----@param v2 string Version to compare with v1.
----@param opts table|nil Optional keyword arguments:
----                      - strict (boolean):  see `version.parse` for details. Defaults to false.
----@return integer `-1` if `v1 < v2`, `0` if `v1 == v2`, `1` if `v1 > v2`.
-function M.cmp(v1, v2, opts)
-  opts = opts or { strict = false }
-  local v1_parsed = assert_version(v1, opts)
-  local v2_parsed = assert_version(v2, opts)
+--- @note Per semver, build metadata is ignored when comparing two otherwise-equivalent versions.
+---
+---@param v1 Version|number[] Version object.
+---@param v2 Version|number[] Version to compare with `v1`.
+---@return integer -1 if `v1 < v2`, 0 if `v1 == v2`, 1 if `v1 > v2`.
+function M.cmp(v1, v2)
+  local v1_parsed = assert(M._version(v1), create_err_msg(v1))
+  local v2_parsed = assert(M._version(v2), create_err_msg(v1))
   if v1_parsed == v2_parsed then
     return 0
   end
@@ -252,58 +341,50 @@ function M.cmp(v1, v2, opts)
   return -1
 end
 
---- Parses a semantic version string.
----
---- Ignores leading "v" and surrounding whitespace, e.g. " v1.0.1-rc1+build.2",
---- "1.0.1-rc1+build.2", "v1.0.1-rc1+build.2" and "v1.0.1-rc1+build.2 " are all parsed as:
---- <pre>
----   { major = 1, minor = 0, patch = 1, prerelease = "rc1", build = "build.2" }
---- </pre>
----
----@param version string Version string to be parsed.
----@param opts table|nil Optional keyword arguments:
----                      - strict (boolean):  Default false. If `true`, no coercion is attempted on
----                      input not strictly conforming to semver v2.0.0
----                      (https://semver.org/spec/v2.0.0.html). E.g. `parse("v1.2")` returns nil.
----@return table|nil parsed_version Parsed version table or `nil` if `version` is invalid.
-function M.parse(version, opts)
-  if type(version) ~= 'string' then
-    error(create_err_msg(version))
-  end
-  opts = opts or { strict = false }
-
-  if opts.strict then
-    return LazyM.version(version, true)
-  end
-
-  version = vim.trim(version) -- TODO: add more "scrubbing".
-  return LazyM.version(version, false)
-end
-
----Returns `true` if `v1` are `v2` are equal versions.
----@param v1 string
----@param v2 string
+---Returns `true` if the given versions are equal.
+---@param v1 Version|number[]
+---@param v2 Version|number[]
 ---@return boolean
 function M.eq(v1, v2)
   return M.cmp(v1, v2) == 0
 end
 
----Returns `true` if `v1` is less than `v2`.
----@param v1 string
----@param v2 string
+---Returns `true` if `v1 < v2`.
+---@param v1 Version|number[]
+---@param v2 Version|number[]
 ---@return boolean
 function M.lt(v1, v2)
   return M.cmp(v1, v2) == -1
 end
 
----Returns `true` if `v1` is greater than `v2`.
----@param v1 string
----@param v2 string
+---Returns `true` if `v1 > v2`.
+---@param v1 Version|number[]
+---@param v2 Version|number[]
 ---@return boolean
 function M.gt(v1, v2)
   return M.cmp(v1, v2) == 1
 end
 
+--- Parses a semantic version string and returns a version object which can be used with other
+--- `vim.version` functions. For example "1.0.1-rc1+build.2" returns:
+--- <pre>
+---   { major = 1, minor = 0, patch = 1, prerelease = "rc1", build = "build.2" }
+--- </pre>
+---
+--- @see # https://semver.org/spec/v2.0.0.html
+---
+---@param version string Version string to parse.
+---@param opts table|nil Optional keyword arguments:
+---                      - strict (boolean):  Default false. If `true`, no coercion is attempted on
+---                      input not conforming to semver v2.0.0. If `false`, `parse()` attempts to
+---                      coerce input such as "1.0", "0-x", "tmux 3.2a" into valid versions.
+---@return table|nil parsed_version Version object or `nil` if input is invalid.
+function M.parse(version, opts)
+  assert(type(version) == 'string', create_err_msg(version))
+  opts = opts or { strict = false }
+  return M._version(version, opts.strict)
+end
+
 setmetatable(M, {
   __call = function()
     return vim.fn.api_info().version
-- 
cgit 


From d11986171b4a5ddd950053e2b9a26d2ad8e89a5c Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Mon, 20 Mar 2023 21:07:09 +0100
Subject: vim-patch:9.0.1415: Crystal files are not recognized

Problem:    Crystal files are not recognized.
Solution:   Add a pattern for Crystal files. (Amaan Qureshi, closes vim/vim#12175)

https://github.com/vim/vim/commit/7c4516fe93d865f4ef1877181f8156b8b9331856

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 69fcb01e8c..399760b254 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -265,6 +265,7 @@ local extension = {
   end,
   cql = 'cqlang',
   crm = 'crm',
+  cr = 'crystal',
   csx = 'cs',
   cs = 'cs',
   csc = 'csc',
-- 
cgit 


From 0c9ed19af3be45d679d77460dd5f6833752f9f56 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Mon, 20 Mar 2023 21:07:55 +0100
Subject: vim-patch:9.0.1417: ESDL files are not recognized

Problem:    ESDL files are not recognized.
Solution:   Add a pattern for ESDL files. (Amaan Qureshi, closes vim/vim#12174)

https://github.com/vim/vim/commit/a1fa8b3ac2f7b54c7901ad3eb0ba8b8290912509

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 399760b254..5127474765 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -350,6 +350,7 @@ local extension = {
   yaws = 'erlang',
   erb = 'eruby',
   rhtml = 'eruby',
+  esdl = 'esdl',
   ec = 'esqlc',
   EC = 'esqlc',
   strl = 'esterel',
-- 
cgit 


From 48ce2ef912cbbe43b85b45a8a97f8d240318718a Mon Sep 17 00:00:00 2001
From: Amaan Qureshi <amaanq12@gmail.com>
Date: Wed, 22 Mar 2023 04:19:56 -0400
Subject: vim-patch:9.0.{1419,1421,1422,1423}: some files are not recognized
 (#22749)

vim-patch:9.0.1419: Lean files are not recognized

Problem:    Lean files are not recognized.
Solution:   Add a pattern for Lean files. (Amaan Qureshi, closes vim/vim#12177)

https://github.com/vim/vim/commit/4a5c39fc52a73d46ac77cf574f765a465befc3c0

vim-patch:9.0.1421: Nu files are not recognized

Problem:    Nu files are not recognized.
Solution:   Add a pattern for Nu files. (Amaan Qureshi, closes vim/vim#12172)

https://github.com/vim/vim/commit/8aa2a37f8983a7863afa32d9ffbe64b2f2bc70be

vim-patch:9.0.1422: Sage files are not recognized

Problem:    Sage files are not recognized.
Solution:   Add a pattern for Sage files. (Amaan Qureshi, closes vim/vim#12176)

https://github.com/vim/vim/commit/d0639d717ba7cf8b04b588aadd0b379ed43a5f1f

vim-patch:9.0.1423: WebAssembly Interface Type files are not recognized

Problem:    WebAssembly Interface Type files are not recognized.
Solution:   Add a pattern for WIT files. (Amaan Qureshi, closes vim/vim#12173)

https://github.com/vim/vim/commit/890c77203637626b1005db818667084d11e653e7
---
 runtime/lua/vim/filetype.lua | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 5127474765..fa4208e2a4 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -593,6 +593,7 @@ local extension = {
   lte = 'latte',
   ld = 'ld',
   ldif = 'ldif',
+  lean = 'lean',
   journal = 'ledger',
   ldg = 'ledger',
   ledger = 'ledger',
@@ -908,6 +909,7 @@ local extension = {
   builder = 'ruby',
   rake = 'ruby',
   rs = 'rust',
+  sage = 'sage',
   sas = 'sas',
   sass = 'sass',
   sa = 'sather',
@@ -1106,6 +1108,7 @@ local extension = {
   wdl = 'wdl',
   wm = 'webmacro',
   wbt = 'winbatch',
+  wit = 'wit',
   wml = 'wml',
   wsml = 'wsml',
   ad = 'xdefaults',
@@ -1543,6 +1546,8 @@ local filename = {
   NEWS = function(path, bufnr)
     return require('vim.filetype.detect').news(bufnr)
   end,
+  ['env.nu'] = 'nu',
+  ['config.nu'] = 'nu',
   ['.ocamlinit'] = 'ocaml',
   ['.octaverc'] = 'octave',
   octaverc = 'octave',
-- 
cgit 


From 9c49c1047079427ff0a2356cb37302934845108e Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Mon, 20 Mar 2023 08:12:33 +0100
Subject: feat(vim.gsplit): gain features of vim.split

Problem:
- vim.split has more features than vim.gsplit.
- Cannot inspect the "separator" segments of vim.split or vim.gsplit.

Solution:
- Move common implementation from vim.split into vim.gsplit.
  - TODO: deprecate vim.split in favor of vim.totable(vim.gsplit())?
- Introduce `keepsep` parameter.

Related: 84f66909e4008a57da947f1640bfc24da5e41a72
---
 runtime/lua/vim/shared.lua | 122 ++++++++++++++++++++++++++++-----------------
 1 file changed, 77 insertions(+), 45 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 1c8defc93a..95ddb3c70d 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -59,6 +59,13 @@ end)()
 
 --- Splits a string at each instance of a separator.
 ---
+--- Example:
+---   <pre>lua
+---   for s in vim.gsplit(':aa::b:', ':', {plain=true}) do
+---     print(s)
+---   end
+---   </pre>
+---
 ---@see |vim.split()|
 ---@see |luaref-patterns|
 ---@see https://www.lua.org/pil/20.2.html
@@ -66,17 +73,40 @@ end)()
 ---
 ---@param s string String to split
 ---@param sep string Separator or pattern
----@param plain (boolean|nil) If `true` use `sep` literally (passed to string.find)
----@return fun():string (function) Iterator over the split components
-function vim.gsplit(s, sep, plain)
-  vim.validate({ s = { s, 's' }, sep = { sep, 's' }, plain = { plain, 'b', true } })
+---@param opts (table|nil) Keyword arguments |kwargs|:
+---       - keepsep: (boolean) Include segments matching `sep` instead of discarding them.
+---       - plain: (boolean) Use `sep` literally (as in string.find).
+---       - trimempty: (boolean) Discard empty segments at start and end of the sequence.
+---@return fun():string|nil (function) Iterator over the split components
+function vim.gsplit(s, sep, opts)
+  local plain
+  local trimempty = false
+  local keepsep = false
+  if type(opts) == 'boolean' then
+    plain = opts -- For backwards compatibility.
+  else
+    vim.validate({ s = { s, 's' }, sep = { sep, 's' }, opts = { opts, 't', true } })
+    opts = opts or {}
+    plain, trimempty, keepsep = opts.plain, opts.trimempty, opts.keepsep
+    assert(not trimempty or not keepsep, 'keepsep+trimempty not supported')
+  end
 
   local start = 1
   local done = false
+  local sepseg = nil -- Last matched `sep` segment.
+  local sepesc = plain and vim.pesc(sep) or sep
+
+  -- For `trimempty`:
+  local empty_start = true -- Only empty segments seen so far.
+  local empty_segs = 0 -- Empty segments found between non-empty segments.
+  local nonemptyseg = nil
 
   local function _pass(i, j, ...)
     if i then
       assert(j + 1 > start, 'Infinite loop detected')
+      if keepsep then
+        sepseg = s:match(sepesc, start)
+      end
       local seg = s:sub(start, i - 1)
       start = j + 1
       return seg, ...
@@ -87,16 +117,48 @@ function vim.gsplit(s, sep, plain)
   end
 
   return function()
-    if done or (s == '' and sep == '') then
-      return
-    end
-    if sep == '' then
+    if trimempty and empty_segs > 0 then
+      -- trimempty: Pop the collected empty segments.
+      empty_segs = empty_segs - 1
+      return ''
+    elseif trimempty and nonemptyseg then
+      local seg = nonemptyseg
+      nonemptyseg = nil
+      return seg
+    elseif keepsep and sepseg then
+      local seg = sepseg
+      sepseg = nil
+      return seg
+    elseif done or (s == '' and sep == '') then
+      return nil
+    elseif sep == '' then
       if start == #s then
         done = true
       end
       return _pass(start + 1, start)
     end
-    return _pass(s:find(sep, start, plain))
+
+    local seg = _pass(s:find(sep, start, plain))
+
+    -- Trim empty segments from start/end.
+    if trimempty and seg == '' then
+      while not done and seg == '' do
+        empty_segs = empty_segs + 1
+        seg = _pass(s:find(sep, start, plain))
+      end
+      if done and seg == '' then
+        return nil
+      elseif empty_start then
+        empty_start = false
+        empty_segs = 0
+        return seg
+      end
+      nonemptyseg = seg ~= '' and seg or nil
+      seg = ''
+      empty_segs = empty_segs - 1
+    end
+
+    return seg
   end
 end
 
@@ -108,51 +170,21 @@ end
 ---  split("axaby", "ab?")                   --> {'','x','y'}
 ---  split("x*yz*o", "*", {plain=true})      --> {'x','yz','o'}
 ---  split("|x|y|z|", "|", {trimempty=true}) --> {'x', 'y', 'z'}
+---  split("|x|y|z|", "|", {keepsep=true})   --> {'|', 'x', '|', 'y', '|', 'z', '|'}
 --- </pre>
 ---
 ---@see |vim.gsplit()|
 ---
 ---@param s string String to split
 ---@param sep string Separator or pattern
----@param kwargs (table|nil) Keyword arguments:
----       - plain: (boolean) If `true` use `sep` literally (passed to string.find)
----       - trimempty: (boolean) If `true` remove empty items from the front
----         and back of the list
+---@param opts (table|nil) Keyword arguments |kwargs| accepted by |vim.gsplit()|
 ---@return string[] List of split components
-function vim.split(s, sep, kwargs)
-  local plain
-  local trimempty = false
-  if type(kwargs) == 'boolean' then
-    -- Support old signature for backward compatibility
-    plain = kwargs
-  else
-    vim.validate({ kwargs = { kwargs, 't', true } })
-    kwargs = kwargs or {}
-    plain = kwargs.plain
-    trimempty = kwargs.trimempty
-  end
-
+function vim.split(s, sep, opts)
+  -- TODO(justinmk): deprecate vim.split in favor of vim.totable(vim.gsplit())
   local t = {}
-  local skip = trimempty
-  for c in vim.gsplit(s, sep, plain) do
-    if c ~= '' then
-      skip = false
-    end
-
-    if not skip then
-      table.insert(t, c)
-    end
+  for c in vim.gsplit(s, sep, opts) do
+    table.insert(t, c)
   end
-
-  if trimempty then
-    for i = #t, 1, -1 do
-      if t[i] ~= '' then
-        break
-      end
-      table.remove(t, i)
-    end
-  end
-
   return t
 end
 
-- 
cgit 


From 8a70adbde03ee9931dc4e1b6f31bd8635eb3633b Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Mon, 20 Mar 2023 13:36:06 +0100
Subject: fix(vim.version): prerelease compare

Problem:
semver specifies that digit sequences in a prerelease string should be
compared as numbers, not lexically: https://semver.org/#spec-item-11
> Precedence for two pre-release versions with the same major, minor,
> and patch version MUST be determined by comparing each dot separated
> identifier from left to right until a difference is found as follows:
> 1. Identifiers consisting of only digits are compared numerically.
> 2. Identifiers with letters or hyphens are compared lexically in ASCII sort order.
> 3. Numeric identifiers always have lower precedence than non-numeric identifiers.
> 4. A larger set of pre-release fields has a higher precedence than a smaller set, if all of the preceding identifiers are equal.
Example:
1.0.0-alpha < 1.0.0-alpha.1 < 1.0.0-alpha.beta < 1.0.0-beta < 1.0.0-beta.2 < 1.0.0-beta.11 < 1.0.0-rc.1 < 1.0.0.

Solution:
cmp_prerel() treats all digit sequences in a prerelease string as
numbers. This doesn't _exactly_ match the spec, which specifies that
only dot-delimited digit sequences should be treated as numbers...
---
 runtime/lua/vim/shared.lua  | 17 +++++++++--------
 runtime/lua/vim/version.lua | 46 +++++++++++++++++++++++++++++++++------------
 2 files changed, 43 insertions(+), 20 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 95ddb3c70d..9eb49cdfac 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -66,14 +66,15 @@ end)()
 ---   end
 ---   </pre>
 ---
----@see |vim.split()|
----@see |luaref-patterns|
----@see https://www.lua.org/pil/20.2.html
----@see http://lua-users.org/wiki/StringLibraryTutorial
----
----@param s string String to split
----@param sep string Separator or pattern
----@param opts (table|nil) Keyword arguments |kwargs|:
+--- @see |string.gmatch()|
+--- @see |vim.split()|
+--- @see |luaref-patterns|
+--- @see https://www.lua.org/pil/20.2.html
+--- @see http://lua-users.org/wiki/StringLibraryTutorial
+---
+--- @param s string String to split
+--- @param sep string Separator or pattern
+--- @param opts (table|nil) Keyword arguments |kwargs|:
 ---       - keepsep: (boolean) Include segments matching `sep` instead of discarding them.
 ---       - plain: (boolean) Use `sep` literally (as in string.find).
 ---       - trimempty: (boolean) Discard empty segments at start and end of the sequence.
diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index 8d8b0d6da7..43001c195c 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -65,6 +65,33 @@ local M = {}
 local Version = {}
 Version.__index = Version
 
+--- Compares prerelease strings: per semver, number parts must be must be treated as numbers:
+--- "pre1.10" is greater than "pre1.2". https://semver.org/#spec-item-11
+local function cmp_prerel(prerel1, prerel2)
+  if not prerel1 or not prerel2 then
+    return prerel1 and -1 or (prerel2 and 1 or 0)
+  end
+  -- TODO(justinmk): not fully spec-compliant; this treats non-dot-delimited digit sequences as
+  -- numbers. Maybe better: "(.-)(%.%d*)".
+  local iter1 = prerel1:gmatch('([^0-9]*)(%d*)')
+  local iter2 = prerel2:gmatch('([^0-9]*)(%d*)')
+  while true do
+    local word1, n1 = iter1()
+    local word2, n2 = iter2()
+    if word1 == nil and word2 == nil then -- Done iterating.
+      return 0
+    end
+    word1, n1, word2, n2 =
+      word1 or '', n1 and tonumber(n1) or 0, word2 or '', n2 and tonumber(n2) or 0
+    if word1 ~= word2 then
+      return word1 < word2 and -1 or 1
+    end
+    if n1 ~= n2 then
+      return n1 < n2 and -1 or 1
+    end
+  end
+end
+
 function Version:__index(key)
   return type(key) == 'number' and ({ self.major, self.minor, self.patch })[key] or Version[key]
 end
@@ -88,7 +115,7 @@ function Version:__eq(other)
       return false
     end
   end
-  return self.prerelease == other.prerelease
+  return 0 == cmp_prerel(self.prerelease, other.prerelease)
 end
 
 function Version:__tostring()
@@ -111,13 +138,7 @@ function Version:__lt(other)
       return true
     end
   end
-  if self.prerelease and not other.prerelease then
-    return true
-  end
-  if other.prerelease and not self.prerelease then
-    return false
-  end
-  return (self.prerelease or '') < (other.prerelease or '')
+  return -1 == cmp_prerel(self.prerelease, other.prerelease)
 end
 
 ---@param other Version
@@ -127,7 +148,7 @@ end
 
 --- @private
 ---
---- Creates a new Version object. Not public currently.
+--- Creates a new Version object, or returns `nil` if `version` is invalid.
 ---
 --- @param version string|number[]|Version
 --- @param strict? boolean Reject "1.0", "0-x", "3.2a" or other non-conforming version strings
@@ -173,6 +194,7 @@ function M._version(version, strict) -- Adapted from https://github.com/folke/la
       build = build ~= '' and build or nil,
     }, Version)
   end
+  return nil -- Invalid version string.
 end
 
 ---TODO: generalize this, move to func.lua
@@ -341,7 +363,7 @@ function M.cmp(v1, v2)
   return -1
 end
 
----Returns `true` if the given versions are equal.
+---Returns `true` if the given versions are equal. See |vim.version.cmp()| for usage.
 ---@param v1 Version|number[]
 ---@param v2 Version|number[]
 ---@return boolean
@@ -349,7 +371,7 @@ function M.eq(v1, v2)
   return M.cmp(v1, v2) == 0
 end
 
----Returns `true` if `v1 < v2`.
+---Returns `true` if `v1 < v2`. See |vim.version.cmp()| for usage.
 ---@param v1 Version|number[]
 ---@param v2 Version|number[]
 ---@return boolean
@@ -357,7 +379,7 @@ function M.lt(v1, v2)
   return M.cmp(v1, v2) == -1
 end
 
----Returns `true` if `v1 > v2`.
+---Returns `true` if `v1 > v2`. See |vim.version.cmp()| for usage.
 ---@param v1 Version|number[]
 ---@param v2 Version|number[]
 ---@return boolean
-- 
cgit 


From e51139f5c1d70bef1424f29e63eb527514e42865 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Wed, 22 Mar 2023 15:14:51 +0100
Subject: refactor(vim.gsplit): remove "keepsep"

string.gmatch() is superior, use that instead.
---
 runtime/lua/vim/shared.lua  | 25 ++++++++++---------------
 runtime/lua/vim/version.lua |  2 ++
 2 files changed, 12 insertions(+), 15 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 9eb49cdfac..884929e33a 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -66,6 +66,14 @@ end)()
 ---   end
 ---   </pre>
 ---
+--- If you want to also inspect the separator itself (instead of discarding it), use
+--- |string.gmatch()|. Example:
+---   <pre>lua
+---   for word, num in ('foo111bar222'):gmatch('([^0-9]*)(%d*)') do
+---     print(('word: %s num: %s'):format(word, num))
+---   end
+---   </pre>
+---
 --- @see |string.gmatch()|
 --- @see |vim.split()|
 --- @see |luaref-patterns|
@@ -75,27 +83,22 @@ end)()
 --- @param s string String to split
 --- @param sep string Separator or pattern
 --- @param opts (table|nil) Keyword arguments |kwargs|:
----       - keepsep: (boolean) Include segments matching `sep` instead of discarding them.
 ---       - plain: (boolean) Use `sep` literally (as in string.find).
 ---       - trimempty: (boolean) Discard empty segments at start and end of the sequence.
 ---@return fun():string|nil (function) Iterator over the split components
 function vim.gsplit(s, sep, opts)
   local plain
   local trimempty = false
-  local keepsep = false
   if type(opts) == 'boolean' then
     plain = opts -- For backwards compatibility.
   else
     vim.validate({ s = { s, 's' }, sep = { sep, 's' }, opts = { opts, 't', true } })
     opts = opts or {}
-    plain, trimempty, keepsep = opts.plain, opts.trimempty, opts.keepsep
-    assert(not trimempty or not keepsep, 'keepsep+trimempty not supported')
+    plain, trimempty = opts.plain, opts.trimempty
   end
 
   local start = 1
   local done = false
-  local sepseg = nil -- Last matched `sep` segment.
-  local sepesc = plain and vim.pesc(sep) or sep
 
   -- For `trimempty`:
   local empty_start = true -- Only empty segments seen so far.
@@ -105,9 +108,6 @@ function vim.gsplit(s, sep, opts)
   local function _pass(i, j, ...)
     if i then
       assert(j + 1 > start, 'Infinite loop detected')
-      if keepsep then
-        sepseg = s:match(sepesc, start)
-      end
       local seg = s:sub(start, i - 1)
       start = j + 1
       return seg, ...
@@ -126,10 +126,6 @@ function vim.gsplit(s, sep, opts)
       local seg = nonemptyseg
       nonemptyseg = nil
       return seg
-    elseif keepsep and sepseg then
-      local seg = sepseg
-      sepseg = nil
-      return seg
     elseif done or (s == '' and sep == '') then
       return nil
     elseif sep == '' then
@@ -171,17 +167,16 @@ end
 ---  split("axaby", "ab?")                   --> {'','x','y'}
 ---  split("x*yz*o", "*", {plain=true})      --> {'x','yz','o'}
 ---  split("|x|y|z|", "|", {trimempty=true}) --> {'x', 'y', 'z'}
----  split("|x|y|z|", "|", {keepsep=true})   --> {'|', 'x', '|', 'y', '|', 'z', '|'}
 --- </pre>
 ---
 ---@see |vim.gsplit()|
+---@see |string.gmatch()|
 ---
 ---@param s string String to split
 ---@param sep string Separator or pattern
 ---@param opts (table|nil) Keyword arguments |kwargs| accepted by |vim.gsplit()|
 ---@return string[] List of split components
 function vim.split(s, sep, opts)
-  -- TODO(justinmk): deprecate vim.split in favor of vim.totable(vim.gsplit())
   local t = {}
   for c in vim.gsplit(s, sep, opts) do
     table.insert(t, c)
diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index 43001c195c..3aacf3d4e0 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -65,6 +65,8 @@ local M = {}
 local Version = {}
 Version.__index = Version
 
+--- @private
+---
 --- Compares prerelease strings: per semver, number parts must be must be treated as numbers:
 --- "pre1.10" is greater than "pre1.2". https://semver.org/#spec-item-11
 local function cmp_prerel(prerel1, prerel2)
-- 
cgit 


From 28cfcf51269b7390b447c8a5b61d5083c830e834 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 22 Mar 2023 16:49:04 +0000
Subject: fix(api): vim.filetype.get_option() (#22753)

- Fix a bug in the cache
- Set some buffer options on the dummy buffer
---
 runtime/lua/vim/filetype/options.lua | 24 +++++++++++++++---------
 1 file changed, 15 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype/options.lua b/runtime/lua/vim/filetype/options.lua
index 77a66991d5..a093c249f7 100644
--- a/runtime/lua/vim/filetype/options.lua
+++ b/runtime/lua/vim/filetype/options.lua
@@ -3,7 +3,7 @@ local api = vim.api
 local M = {}
 
 local function get_ftplugin_runtime(filetype)
-  return api.nvim__get_runtime({
+  local files = api.nvim__get_runtime({
     string.format('ftplugin/%s.vim', filetype),
     string.format('ftplugin/%s_*.vim', filetype),
     string.format('ftplugin/%s/*.vim', filetype),
@@ -11,6 +11,15 @@ local function get_ftplugin_runtime(filetype)
     string.format('ftplugin/%s_*.lua', filetype),
     string.format('ftplugin/%s/*.lua', filetype),
   }, true, {}) --[[@as string[] ]]
+
+  local r = {} ---@type string[]
+  for _, f in ipairs(files) do
+    -- VIMRUNTIME should be static so shouldn't need to worry about it changing
+    if not vim.startswith(f, vim.env.VIMRUNTIME) then
+      r[#r + 1] = f
+    end
+  end
+  return r
 end
 
 -- Keep track of ftplugin files
@@ -52,14 +61,11 @@ local function update_ft_option_cache(filetype)
   end
 
   for _, f in ipairs(files) do
-    -- VIMRUNTIME should be static so shouldn't need to worry about it changing
-    if not vim.startswith(f, vim.env.VIMRUNTIME) then
-      local mtime = hash(f)
-      if ftplugin_cache[filetype][f] ~= mtime then
-        -- invalidate
-        ft_option_cache[filetype] = nil
-        ftplugin_cache[filetype][f] = mtime
-      end
+    local mtime = hash(f)
+    if ftplugin_cache[filetype][f] ~= mtime then
+      -- invalidate
+      ft_option_cache[filetype] = nil
+      ftplugin_cache[filetype][f] = mtime
     end
   end
 end
-- 
cgit 


From ea0b66d208dbcd5d5c0a17810596d769c7a0b6dd Mon Sep 17 00:00:00 2001
From: meredith <merrilymeredith@users.noreply.github.com>
Date: Thu, 23 Mar 2023 02:27:53 -0500
Subject: fix(lsp): Jump to tag locations reliably when :ltag is used (#22750)

---
 runtime/lua/vim/lsp/tagfunc.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/tagfunc.lua b/runtime/lua/vim/lsp/tagfunc.lua
index 49029f8599..eb25b67db9 100644
--- a/runtime/lua/vim/lsp/tagfunc.lua
+++ b/runtime/lua/vim/lsp/tagfunc.lua
@@ -9,7 +9,7 @@ local function mk_tag_item(name, range, uri, offset_encoding)
   return {
     name = name,
     filename = vim.uri_to_fname(uri),
-    cmd = string.format('call cursor(%d, %d)|', range.start.line + 1, byte),
+    cmd = string.format([[/\%%%dl\%%%dc/]], range.start.line + 1, byte),
   }
 end
 
-- 
cgit 


From 4e4203f71b0b9bb2ca4ad9abd2fbf4ea1deaf9a6 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 23 Mar 2023 11:23:51 +0000
Subject: fix(treesitter): annotations

- Begin using `@package` in place of `@private` for functions
that are accessed internally but outside their defined class.

- Rename Node -> TSP.Node
---
 runtime/lua/vim/treesitter.lua              |  6 ++----
 runtime/lua/vim/treesitter/_fold.lua        | 20 ++++++++++++++------
 runtime/lua/vim/treesitter/_meta.lua        |  3 ++-
 runtime/lua/vim/treesitter/highlighter.lua  | 23 ++++++++++-------------
 runtime/lua/vim/treesitter/languagetree.lua | 11 +++++------
 runtime/lua/vim/treesitter/playground.lua   | 26 +++++++++++++-------------
 6 files changed, 46 insertions(+), 43 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 43b8c11b80..685b1d8830 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -30,8 +30,6 @@ setmetatable(M, {
   end,
 })
 
----@diagnostic disable:invisible
-
 --- Creates a new parser
 ---
 --- It is not recommended to use this; use |get_parser()| instead.
@@ -132,7 +130,7 @@ function M.get_parser(bufnr, lang, opts)
   return parsers[bufnr]
 end
 
----@private
+---@package
 ---@param bufnr (integer|nil) Buffer number
 ---@return boolean
 function M._has_parser(bufnr)
@@ -276,7 +274,7 @@ function M.get_captures_at_pos(bufnr, row, col)
         end
       end
     end
-  end, true)
+  end)
   return matches
 end
 
diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index 90f4394fcc..3e67e400c2 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -3,7 +3,7 @@ local Query = require('vim.treesitter.query')
 
 local api = vim.api
 
----@class FoldInfo
+---@class TS.FoldInfo
 ---@field levels table<integer,string>
 ---@field levels0 table<integer,integer>
 ---@field private start_counts table<integer,integer>
@@ -11,6 +11,7 @@ local api = vim.api
 local FoldInfo = {}
 FoldInfo.__index = FoldInfo
 
+---@private
 function FoldInfo.new()
   return setmetatable({
     start_counts = {},
@@ -20,6 +21,7 @@ function FoldInfo.new()
   }, FoldInfo)
 end
 
+---@package
 ---@param srow integer
 ---@param erow integer
 function FoldInfo:invalidate_range(srow, erow)
@@ -31,6 +33,7 @@ function FoldInfo:invalidate_range(srow, erow)
   end
 end
 
+---@package
 ---@param srow integer
 ---@param erow integer
 function FoldInfo:remove_range(srow, erow)
@@ -42,6 +45,7 @@ function FoldInfo:remove_range(srow, erow)
   end
 end
 
+---@package
 ---@param srow integer
 ---@param erow integer
 function FoldInfo:add_range(srow, erow)
@@ -53,22 +57,26 @@ function FoldInfo:add_range(srow, erow)
   end
 end
 
+---@package
 ---@param lnum integer
 function FoldInfo:add_start(lnum)
   self.start_counts[lnum] = (self.start_counts[lnum] or 0) + 1
 end
 
+---@package
 ---@param lnum integer
 function FoldInfo:add_stop(lnum)
   self.stop_counts[lnum] = (self.stop_counts[lnum] or 0) + 1
 end
 
+---@packag
 ---@param lnum integer
 ---@return integer
 function FoldInfo:get_start(lnum)
   return self.start_counts[lnum] or 0
 end
 
+---@package
 ---@param lnum integer
 ---@return integer
 function FoldInfo:get_stop(lnum)
@@ -84,7 +92,7 @@ local function trim_level(level)
 end
 
 ---@param bufnr integer
----@param info FoldInfo
+---@param info TS.FoldInfo
 ---@param srow integer?
 ---@param erow integer?
 local function get_folds_levels(bufnr, info, srow, erow)
@@ -161,7 +169,7 @@ end
 
 local M = {}
 
----@type table<integer,FoldInfo>
+---@type table<integer,TS.FoldInfo>
 local foldinfos = {}
 
 local function recompute_folds()
@@ -178,7 +186,7 @@ local function recompute_folds()
 end
 
 ---@param bufnr integer
----@param foldinfo FoldInfo
+---@param foldinfo TS.FoldInfo
 ---@param tree_changes Range4[]
 local function on_changedtree(bufnr, foldinfo, tree_changes)
   -- For some reason, queries seem to use the old buffer state in on_bytes.
@@ -193,7 +201,7 @@ local function on_changedtree(bufnr, foldinfo, tree_changes)
 end
 
 ---@param bufnr integer
----@param foldinfo FoldInfo
+---@param foldinfo TS.FoldInfo
 ---@param start_row integer
 ---@param old_row integer
 ---@param new_row integer
@@ -212,13 +220,13 @@ local function on_bytes(bufnr, foldinfo, start_row, old_row, new_row)
   end
 end
 
+---@package
 ---@param lnum integer|nil
 ---@return string
 function M.foldexpr(lnum)
   lnum = lnum or vim.v.lnum
   local bufnr = api.nvim_get_current_buf()
 
-  ---@diagnostic disable-next-line:invisible
   if not vim.treesitter._has_parser(bufnr) or not lnum then
     return '0'
   end
diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index 72823ccf26..4d0f43d030 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -3,7 +3,8 @@
 ---@class TSNode
 ---@field id fun(self: TSNode): integer
 ---@field tree fun(self: TSNode): TSTree
----@field range fun(self: TSNode, include_bytes: boolean?): integer, integer, integer, integer, integer, integer
+---@field range fun(self: TSNode, include_bytes: false?): integer, integer, integer, integer
+---@field range fun(self: TSNode, include_bytes: true): integer, integer, integer, integer, integer, integer
 ---@field start fun(self: TSNode): integer, integer, integer
 ---@field end_ fun(self: TSNode): integer, integer, integer
 ---@field type fun(self: TSNode): string
diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index e3deaf6ba6..e24b3ba5df 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -53,12 +53,12 @@ function TSHighlighterQuery.new(lang, query_string)
   return self
 end
 
----@private
+---@package
 function TSHighlighterQuery:query()
   return self._query
 end
 
----@private
+---@package
 ---
 --- Creates a highlighter for `tree`.
 ---
@@ -76,16 +76,14 @@ function TSHighlighter.new(tree, opts)
   opts = opts or {} ---@type { queries: table<string,string> }
   self.tree = tree
   tree:register_cbs({
-    ---@diagnostic disable:invisible
     on_changedtree = function(...)
       self:on_changedtree(...)
     end,
     on_bytes = function(...)
       self:on_bytes(...)
     end,
-    on_detach = function(...)
-      ---@diagnostic disable-next-line:redundant-parameter
-      self:on_detach(...)
+    on_detach = function()
+      self:on_detach()
     end,
   })
 
@@ -147,7 +145,7 @@ function TSHighlighter:destroy()
   end
 end
 
----@private
+---@package
 ---@param tstree TSTree
 ---@return TSHighlightState
 function TSHighlighter:get_highlight_state(tstree)
@@ -166,19 +164,19 @@ function TSHighlighter:reset_highlight_state()
   self._highlight_states = {}
 end
 
----@private
+---@package
 ---@param start_row integer
 ---@param new_end integer
 function TSHighlighter:on_bytes(_, _, start_row, _, _, _, _, _, new_end)
   a.nvim__buf_redraw_range(self.bufnr, start_row, start_row + new_end + 1)
 end
 
----@private
+---@package
 function TSHighlighter:on_detach()
   self:destroy()
 end
 
----@private
+---@package
 ---@param changes integer[][]?
 function TSHighlighter:on_changedtree(changes)
   for _, ch in ipairs(changes or {}) do
@@ -188,7 +186,7 @@ end
 
 --- Gets the query used for @param lang
 --
----@private
+---@package
 ---@param lang string Language used by the highlighter.
 ---@return TSHighlighterQuery
 function TSHighlighter:get_query(lang)
@@ -205,7 +203,6 @@ end
 ---@param line integer
 ---@param is_spell_nav boolean
 local function on_line_impl(self, buf, line, is_spell_nav)
-  ---@diagnostic disable:invisible
   self.tree:for_each_tree(function(tstree, tree)
     if not tstree then
       return
@@ -268,7 +265,7 @@ local function on_line_impl(self, buf, line, is_spell_nav)
         state.next_row = start_row
       end
     end
-  end, true)
+  end)
 end
 
 ---@private
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index bdfe281a5b..ae41062ab2 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -70,7 +70,7 @@ local LanguageTree = {}
 
 LanguageTree.__index = LanguageTree
 
---- @private
+--- @package
 ---
 --- |LanguageTree| contains a tree of parsers: the root treesitter parser for {lang} and any
 --- "injected" language parsers, which themselves may inject other languages, recursively.
@@ -700,7 +700,7 @@ function LanguageTree:_do_callback(cb_name, ...)
   end
 end
 
----@private
+---@package
 function LanguageTree:_edit(
   start_byte,
   end_byte_old,
@@ -776,7 +776,7 @@ function LanguageTree:_edit(
   end)
 end
 
----@private
+---@package
 ---@param bufnr integer
 ---@param changed_tick integer
 ---@param start_row integer
@@ -822,7 +822,6 @@ function LanguageTree:_on_bytes(
   -- Edit trees together BEFORE emitting a bytes callback.
   ---@private
   self:for_each_child(function(child)
-    ---@diagnostic disable-next-line:invisible
     child:_edit(
       start_byte,
       start_byte + old_byte,
@@ -852,12 +851,12 @@ function LanguageTree:_on_bytes(
   )
 end
 
----@private
+---@package
 function LanguageTree:_on_reload()
   self:invalidate(true)
 end
 
----@private
+---@package
 function LanguageTree:_on_detach(...)
   self:invalidate(true)
   self:_do_callback('detach', ...)
diff --git a/runtime/lua/vim/treesitter/playground.lua b/runtime/lua/vim/treesitter/playground.lua
index 7f181c23fd..35f06f5caf 100644
--- a/runtime/lua/vim/treesitter/playground.lua
+++ b/runtime/lua/vim/treesitter/playground.lua
@@ -5,11 +5,11 @@ local api = vim.api
 ---@field opts table Options table with the following keys:
 ---                  - anon (boolean): If true, display anonymous nodes
 ---                  - lang (boolean): If true, display the language alongside each node
----@field nodes Node[]
----@field named Node[]
+---@field nodes TSP.Node[]
+---@field named TSP.Node[]
 local TSPlayground = {}
----
----@class Node
+
+---@class TSP.Node
 ---@field id integer Node id
 ---@field text string Node text
 ---@field named boolean True if this is a named (non-anonymous) node
@@ -36,9 +36,9 @@ local TSPlayground = {}
 ---@param node TSNode Starting node to begin traversal |tsnode|
 ---@param depth integer Current recursion depth
 ---@param lang string Language of the tree currently being traversed
----@param injections table<integer,Node> Mapping of node ids to root nodes of injected language trees (see
+---@param injections table<integer,TSP.Node> Mapping of node ids to root nodes of injected language trees (see
 ---                        explanation above)
----@param tree Node[] Output table containing a list of tables each representing a node in the tree
+---@param tree TSP.Node[] Output table containing a list of tables each representing a node in the tree
 ---@private
 local function traverse(node, depth, lang, injections, tree)
   local injection = injections[node:id()]
@@ -87,7 +87,7 @@ end
 ---@return TSPlayground|nil
 ---@return string|nil Error message, if any
 ---
----@private
+---@package
 function TSPlayground:new(bufnr, lang)
   local ok, parser = pcall(vim.treesitter.get_parser, bufnr or 0, lang)
   if not ok then
@@ -114,7 +114,7 @@ function TSPlayground:new(bufnr, lang)
 
   local nodes = traverse(root, 0, parser:lang(), injections, {})
 
-  local named = {} ---@type Node[]
+  local named = {} ---@type TSP.Node[]
   for _, v in ipairs(nodes) do
     if v.named then
       named[#named + 1] = v
@@ -154,7 +154,7 @@ end
 --- Write the contents of this Playground into {bufnr}.
 ---
 ---@param bufnr integer Buffer number to write into.
----@private
+---@package
 function TSPlayground:draw(bufnr)
   vim.bo[bufnr].modifiable = true
   local lines = {} ---@type string[]
@@ -195,8 +195,8 @@ end
 --- The node number is dependent on whether or not anonymous nodes are displayed.
 ---
 ---@param i integer Node number to get
----@return Node
----@private
+---@return TSP.Node
+---@package
 function TSPlayground:get(i)
   local t = self.opts.anon and self.nodes or self.named
   return t[i]
@@ -204,10 +204,10 @@ end
 
 --- Iterate over all of the nodes in this Playground object.
 ---
----@return (fun(): integer, Node) Iterator over all nodes in this Playground
+---@return (fun(): integer, TSP.Node) Iterator over all nodes in this Playground
 ---@return table
 ---@return integer
----@private
+---@package
 function TSPlayground:iter()
   return ipairs(self.opts.anon and self.nodes or self.named)
 end
-- 
cgit 


From ee5008f8789f61a3b153220abb870dd49427e52c Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 24 Mar 2023 14:06:04 +0100
Subject: vim-patch:9.0.1425: "wat" and "wast" files are one filetype (#22774)

Problem:    "wat" and "wast" files are one filetype.
Solution:   Add a separate filetype for "wat" files. (Amaan Qureshi,
            closes vim/vim#12165)

https://github.com/vim/vim/commit/3ea62381c527395ae701715335776f427d22eb7b

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index fa4208e2a4..740304df15 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1103,8 +1103,8 @@ local extension = {
   wrl = 'vrml',
   vroom = 'vroom',
   vue = 'vue',
-  wat = 'wast',
   wast = 'wast',
+  wat = 'wat',
   wdl = 'wdl',
   wm = 'webmacro',
   wbt = 'winbatch',
-- 
cgit 


From cbbf8bd666c8419fdab80a0887948c8a36279c19 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 24 Mar 2023 14:43:14 +0000
Subject: feat(treesitter)!: deprecate top level indexes to modules (#22761)

The following top level Treesitter functions have been moved:
  - vim.treesitter.inspect_language() -> vim.treesitter.language.inspect()
  - vim.treesitter.get_query_files() -> vim.treesitter.query.get_files()
  - vim.treesitter.set_query() -> vim.treesitter.query.set()
  - vim.treesitter.query.set_query() -> vim.treesitter.query.set()
  - vim.treesitter.get_query() -> vim.treesitter.query.get()
  - vim.treesitter.query.get_query() -> vim.treesitter.query.get()
  - vim.treesitter.parse_query() -> vim.treesitter.query.parse()
  - vim.treesitter.query.parse_query() -> vim.treesitter.query.parse()
  - vim.treesitter.add_predicate() -> vim.treesitter.query.add_predicate()
  - vim.treesitter.add_directive() -> vim.treesitter.query.add_directive()
  - vim.treesitter.list_predicates() -> vim.treesitter.query.list_predicates()
  - vim.treesitter.list_directives() -> vim.treesitter.query.list_directives()
  - vim.treesitter.query.get_range() -> vim.treesitter.get_range()
  - vim.treesitter.query.get_node_text() -> vim.treesitter.get_node_text()
---
 runtime/lua/vim/treesitter.lua              |  89 +++++++++++++++++---
 runtime/lua/vim/treesitter/highlighter.lua  |   6 +-
 runtime/lua/vim/treesitter/language.lua     |  13 ++-
 runtime/lua/vim/treesitter/languagetree.lua |  14 ++--
 runtime/lua/vim/treesitter/query.lua        | 123 +++++++++++++---------------
 5 files changed, 155 insertions(+), 90 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 685b1d8830..4c3b17daa4 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -1,6 +1,4 @@
 local a = vim.api
-local query = require('vim.treesitter.query')
-local language = require('vim.treesitter.language')
 local LanguageTree = require('vim.treesitter.languagetree')
 local Range = require('vim.treesitter._range')
 
@@ -9,12 +7,9 @@ local parsers = setmetatable({}, { __mode = 'v' })
 
 ---@class TreesitterModule
 ---@field highlighter TSHighlighter
-local M = vim.tbl_extend('error', query, language)
-
-M.language_version = vim._ts_get_language_version()
-M.minimum_language_version = vim._ts_get_minimum_language_version()
-
-setmetatable(M, {
+---@field query TSQueryModule
+---@field language TSLanguageModule
+local M = setmetatable({}, {
   __index = function(t, k)
     ---@diagnostic disable:no-unknown
     if k == 'highlighter' then
@@ -27,9 +22,26 @@ setmetatable(M, {
       t[k] = require('vim.treesitter.query')
       return t[k]
     end
+
+    local query = require('vim.treesitter.query')
+    if query[k] then
+      vim.deprecate('vim.treesitter.' .. k .. '()', 'vim.treesitter.query.' .. k .. '()', '0.10')
+      t[k] = query[k]
+      return t[k]
+    end
+
+    local language = require('vim.treesitter.language')
+    if language[k] then
+      vim.deprecate('vim.treesitter.' .. k .. '()', 'vim.treesitter.language.' .. k .. '()', '0.10')
+      t[k] = language[k]
+      return t[k]
+    end
   end,
 })
 
+M.language_version = vim._ts_get_language_version()
+M.minimum_language_version = vim._ts_get_minimum_language_version()
+
 --- Creates a new parser
 ---
 --- It is not recommended to use this; use |get_parser()| instead.
@@ -47,7 +59,7 @@ function M._create_parser(bufnr, lang, opts)
   vim.fn.bufload(bufnr)
 
   local ft = vim.bo[bufnr].filetype
-  language.add(lang, { filetype = ft ~= '' and ft or nil })
+  M.language.add(lang, { filetype = ft ~= '' and ft or nil })
 
   local self = LanguageTree.new(bufnr, lang, opts)
 
@@ -101,7 +113,7 @@ function M.get_parser(bufnr, lang, opts)
   if lang == nil then
     local ft = vim.bo[bufnr].filetype
     if ft ~= '' then
-      lang = language.get_lang(ft) or ft
+      lang = M.language.get_lang(ft) or ft
       -- TODO(lewis6991): we should error here and not default to ft
       -- if not lang then
       --   error(string.format('filetype %s of buffer %d is not associated with any lang', ft, bufnr))
@@ -152,7 +164,7 @@ function M.get_string_parser(str, lang, opts)
     str = { str, 'string' },
     lang = { lang, 'string' },
   })
-  language.add(lang)
+  M.language.add(lang)
 
   return LanguageTree.new(str, lang, opts)
 end
@@ -196,6 +208,61 @@ function M.get_node_range(node_or_range)
   end
 end
 
+---Get the range of a |TSNode|. Can also supply {source} and {metadata}
+---to get the range with directives applied.
+---@param node TSNode
+---@param source integer|string|nil Buffer or string from which the {node} is extracted
+---@param metadata TSMetadata|nil
+---@return Range6
+function M.get_range(node, source, metadata)
+  if metadata and metadata.range then
+    assert(source)
+    return Range.add_bytes(source, metadata.range)
+  end
+  return { node:range(true) }
+end
+
+---@private
+---@param buf integer
+---@param range Range
+---@returns string
+local function buf_range_get_text(buf, range)
+  local start_row, start_col, end_row, end_col = Range.unpack4(range)
+  if end_col == 0 then
+    if start_row == end_row then
+      start_col = -1
+      start_row = start_row - 1
+    end
+    end_col = -1
+    end_row = end_row - 1
+  end
+  local lines = a.nvim_buf_get_text(buf, start_row, start_col, end_row, end_col, {})
+  return table.concat(lines, '\n')
+end
+
+--- Gets the text corresponding to a given node
+---
+---@param node TSNode
+---@param source (integer|string) Buffer or string from which the {node} is extracted
+---@param opts (table|nil) Optional parameters.
+---          - metadata (table) Metadata of a specific capture. This would be
+---            set to `metadata[capture_id]` when using |vim.treesitter.query.add_directive()|.
+---@return string
+function M.get_node_text(node, source, opts)
+  opts = opts or {}
+  local metadata = opts.metadata or {}
+
+  if metadata.text then
+    return metadata.text
+  elseif type(source) == 'number' then
+    local range = vim.treesitter.get_range(node, source, metadata)
+    return buf_range_get_text(source, range)
+  end
+
+  ---@cast source string
+  return source:sub(select(3, node:start()) + 1, select(3, node:end_()))
+end
+
 --- Determines whether (line, col) position is in node range
 ---
 ---@param node TSNode defining the range
diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index e24b3ba5df..729cd34090 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -1,5 +1,5 @@
 local a = vim.api
-local query = require('vim.treesitter.query')
+local query = vim.treesitter.query
 
 ---@alias TSHlIter fun(): integer, TSNode, TSMetadata
 
@@ -45,9 +45,9 @@ function TSHighlighterQuery.new(lang, query_string)
   })
 
   if query_string then
-    self._query = query.parse_query(lang, query_string)
+    self._query = query.parse(lang, query_string)
   else
-    self._query = query.get_query(lang, 'highlights')
+    self._query = query.get(lang, 'highlights')
   end
 
   return self
diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index 47375fd5e6..974d66ec05 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -1,5 +1,6 @@
 local a = vim.api
 
+---@class TSLanguageModule
 local M = {}
 
 ---@type table<string,string>
@@ -111,9 +112,19 @@ end
 ---
 ---@param lang string Language
 ---@return table
-function M.inspect_language(lang)
+function M.inspect(lang)
   M.add(lang)
   return vim._ts_inspect_language(lang)
 end
 
+---@deprecated
+function M.inspect_language(...)
+  vim.deprecate(
+    'vim.treesitter.language.inspect_language()',
+    'vim.treesitter.language.inspect()',
+    '0.10'
+  )
+  return M.inspect(...)
+end
+
 return M
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index ae41062ab2..82e507551d 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -99,8 +99,8 @@ function LanguageTree.new(source, lang, opts)
     _regions = {},
     _trees = {},
     _opts = opts,
-    _injection_query = injections[lang] and query.parse_query(lang, injections[lang])
-      or query.get_query(lang, 'injections'),
+    _injection_query = injections[lang] and query.parse(lang, injections[lang])
+      or query.get(lang, 'injections'),
     _valid = false,
     _parser = vim._create_ts_parser(lang),
     _callbacks = {
@@ -482,7 +482,7 @@ end
 ---@param metadata TSMetadata
 ---@return Range6[]
 local function get_node_ranges(node, source, metadata, include_children)
-  local range = query.get_range(node, source, metadata)
+  local range = vim.treesitter.get_range(node, source, metadata)
 
   if include_children then
     return { range }
@@ -562,7 +562,7 @@ function LanguageTree:_get_injection(match, metadata)
 
     -- Lang should override any other language tag
     if name == 'injection.language' then
-      lang = query.get_node_text(node, self._source, { metadata = metadata[id] })
+      lang = vim.treesitter.get_node_text(node, self._source, { metadata = metadata[id] })
     elseif name == 'injection.content' then
       ranges = get_node_ranges(node, self._source, metadata[id], include_children)
     end
@@ -609,11 +609,11 @@ function LanguageTree:_get_injection_deprecated(match, metadata)
 
     -- Lang should override any other language tag
     if name == 'language' and not lang then
-      lang = query.get_node_text(node, self._source, { metadata = metadata[id] })
+      lang = vim.treesitter.get_node_text(node, self._source, { metadata = metadata[id] })
     elseif name == 'combined' then
       combined = true
     elseif name == 'content' and #ranges == 0 then
-      ranges[#ranges + 1] = query.get_range(node, self._source, metadata[id])
+      ranges[#ranges + 1] = vim.treesitter.get_range(node, self._source, metadata[id])
       -- Ignore any tags that start with "_"
       -- Allows for other tags to be used in matches
     elseif string.sub(name, 1, 1) ~= '_' then
@@ -622,7 +622,7 @@ function LanguageTree:_get_injection_deprecated(match, metadata)
       end
 
       if #ranges == 0 then
-        ranges[#ranges + 1] = query.get_range(node, self._source, metadata[id])
+        ranges[#ranges + 1] = vim.treesitter.get_range(node, self._source, metadata[id])
       end
     end
   end
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index f4e038b2d8..8ccd6da8a7 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -1,8 +1,6 @@
 local a = vim.api
 local language = require('vim.treesitter.language')
 
-local Range = require('vim.treesitter._range')
-
 ---@class Query
 ---@field captures string[] List of captures used in query
 ---@field info TSQueryInfo Contains used queries, predicates, directives
@@ -14,6 +12,7 @@ Query.__index = Query
 ---@field captures table
 ---@field patterns table<string,any[][]>
 
+---@class TSQueryModule
 local M = {}
 
 ---@private
@@ -57,22 +56,14 @@ local function add_included_lang(base_langs, lang, ilang)
   return false
 end
 
----@private
----@param buf integer
----@param range Range
----@returns string
-local function buf_range_get_text(buf, range)
-  local start_row, start_col, end_row, end_col = Range.unpack4(range)
-  if end_col == 0 then
-    if start_row == end_row then
-      start_col = -1
-      start_row = start_row - 1
-    end
-    end_col = -1
-    end_row = end_row - 1
-  end
-  local lines = a.nvim_buf_get_text(buf, start_row, start_col, end_row, end_col, {})
-  return table.concat(lines, '\n')
+---@deprecated
+function M.get_query_files(...)
+  vim.deprecate(
+    'vim.treesitter.query.get_query_files()',
+    'vim.treesitter.query.get_files()',
+    '0.10'
+  )
+  return M.get_files(...)
 end
 
 --- Gets the list of files used to make up a query
@@ -81,7 +72,7 @@ end
 ---@param query_name string Name of the query to load (e.g., "highlights")
 ---@param is_included (boolean|nil) Internal parameter, most of the time left as `nil`
 ---@return string[] query_files List of files to load for given query and language
-function M.get_query_files(lang, query_name, is_included)
+function M.get_files(lang, query_name, is_included)
   local query_path = string.format('queries/%s/%s.scm', lang, query_name)
   local lang_files = dedupe_files(a.nvim_get_runtime_file(query_path, true))
 
@@ -153,7 +144,7 @@ function M.get_query_files(lang, query_name, is_included)
 
   local query_files = {}
   for _, base_lang in ipairs(base_langs) do
-    local base_files = M.get_query_files(base_lang, query_name, true)
+    local base_files = M.get_files(base_lang, query_name, true)
     vim.list_extend(query_files, base_files)
   end
   vim.list_extend(query_files, { base_query })
@@ -175,7 +166,7 @@ local function read_query_files(filenames)
   return table.concat(contents, '')
 end
 
--- The explicitly set queries from |vim.treesitter.query.set_query()|
+-- The explicitly set queries from |vim.treesitter.query.set()|
 ---@type table<string,table<string,Query>>
 local explicit_queries = setmetatable({}, {
   __index = function(t, k)
@@ -186,6 +177,12 @@ local explicit_queries = setmetatable({}, {
   end,
 })
 
+---@deprecated
+function M.set_query(...)
+  vim.deprecate('vim.treesitter.query.set_query()', 'vim.treesitter.query.set()', '0.10')
+  M.set(...)
+end
+
 --- Sets the runtime query named {query_name} for {lang}
 ---
 --- This allows users to override any runtime files and/or configuration
@@ -194,8 +191,17 @@ local explicit_queries = setmetatable({}, {
 ---@param lang string Language to use for the query
 ---@param query_name string Name of the query (e.g., "highlights")
 ---@param text string Query text (unparsed).
-function M.set_query(lang, query_name, text)
-  explicit_queries[lang][query_name] = M.parse_query(lang, text)
+function M.set(lang, query_name, text)
+  explicit_queries[lang][query_name] = M.parse(lang, text)
+end
+
+---@deprecated
+---@param lang string Language to use for the query
+---@param query_name string Name of the query (e.g. "highlights")
+---
+---@return Query|nil Parsed query
+function M.get_query(lang, query_name)
+  return M.get(lang, query_name)
 end
 
 --- Returns the runtime query {query_name} for {lang}.
@@ -204,16 +210,16 @@ end
 ---@param query_name string Name of the query (e.g. "highlights")
 ---
 ---@return Query|nil Parsed query
-function M.get_query(lang, query_name)
+function M.get(lang, query_name)
   if explicit_queries[lang][query_name] then
     return explicit_queries[lang][query_name]
   end
 
-  local query_files = M.get_query_files(lang, query_name)
+  local query_files = M.get_files(lang, query_name)
   local query_string = read_query_files(query_files)
 
   if #query_string > 0 then
-    return M.parse_query(lang, query_string)
+    return M.parse(lang, query_string)
   end
 end
 
@@ -222,6 +228,12 @@ local query_cache = vim.defaulttable(function()
   return setmetatable({}, { __mode = 'v' })
 end)
 
+---@deprecated
+function M.parse_query(...)
+  vim.deprecate('vim.treesitter.query.parse_query()', 'vim.treesitter.query.parse()', '0.10')
+  return M.parse(...)
+end
+
 --- Parse {query} as a string. (If the query is in a file, the caller
 --- should read the contents into a string before calling).
 ---
@@ -239,7 +251,7 @@ end)
 ---@param query string Query in s-expr syntax
 ---
 ---@return Query Parsed query
-function M.parse_query(lang, query)
+function M.parse(lang, query)
   language.add(lang)
   local cached = query_cache[lang][query]
   if cached then
@@ -254,41 +266,16 @@ function M.parse_query(lang, query)
   return self
 end
 
----Get the range of a |TSNode|. Can also supply {source} and {metadata}
----to get the range with directives applied.
----@param node TSNode
----@param source integer|string|nil Buffer or string from which the {node} is extracted
----@param metadata TSMetadata|nil
----@return Range6
-function M.get_range(node, source, metadata)
-  if metadata and metadata.range then
-    assert(source)
-    return Range.add_bytes(source, metadata.range)
-  end
-  return { node:range(true) }
+---@deprecated
+function M.get_range(...)
+  vim.deprecate('vim.treesitter.query.get_range()', 'vim.treesitter.get_range()', '0.10')
+  return vim.treesitter.get_range(...)
 end
 
---- Gets the text corresponding to a given node
----
----@param node TSNode
----@param source (integer|string) Buffer or string from which the {node} is extracted
----@param opts (table|nil) Optional parameters.
----          - metadata (table) Metadata of a specific capture. This would be
----            set to `metadata[capture_id]` when using |vim.treesitter.add_directive()|.
----@return string
-function M.get_node_text(node, source, opts)
-  opts = opts or {}
-  local metadata = opts.metadata or {}
-
-  if metadata.text then
-    return metadata.text
-  elseif type(source) == 'number' then
-    local range = M.get_range(node, source, metadata)
-    return buf_range_get_text(source, range)
-  end
-
-  ---@cast source string
-  return source:sub(select(3, node:start()) + 1, select(3, node:end_()))
+---@deprecated
+function M.get_node_text(...)
+  vim.deprecate('vim.treesitter.query.get_node_text()', 'vim.treesitter.get_node_text()', '0.10')
+  return vim.treesitter.get_node_text(...)
 end
 
 ---@alias TSMatch table<integer,TSNode>
@@ -304,7 +291,7 @@ local predicate_handlers = {
     if not node then
       return true
     end
-    local node_text = M.get_node_text(node, source)
+    local node_text = vim.treesitter.get_node_text(node, source)
 
     local str ---@type string
     if type(predicate[3]) == 'string' then
@@ -312,7 +299,7 @@ local predicate_handlers = {
       str = predicate[3]
     else
       -- (#eq? @aa @bb)
-      str = M.get_node_text(match[predicate[3]], source)
+      str = vim.treesitter.get_node_text(match[predicate[3]], source)
     end
 
     if node_text ~= str or str == nil then
@@ -328,7 +315,7 @@ local predicate_handlers = {
       return true
     end
     local regex = predicate[3]
-    return string.find(M.get_node_text(node, source), regex) ~= nil
+    return string.find(vim.treesitter.get_node_text(node, source), regex) ~= nil
   end,
 
   ['match?'] = (function()
@@ -357,7 +344,7 @@ local predicate_handlers = {
       end
       ---@diagnostic disable-next-line no-unknown
       local regex = compiled_vim_regexes[pred[3]]
-      return regex:match_str(M.get_node_text(node, source))
+      return regex:match_str(vim.treesitter.get_node_text(node, source))
     end
   end)(),
 
@@ -366,7 +353,7 @@ local predicate_handlers = {
     if not node then
       return true
     end
-    local node_text = M.get_node_text(node, source)
+    local node_text = vim.treesitter.get_node_text(node, source)
 
     for i = 3, #predicate do
       if string.find(node_text, predicate[i], 1, true) then
@@ -382,7 +369,7 @@ local predicate_handlers = {
     if not node then
       return true
     end
-    local node_text = M.get_node_text(node, source)
+    local node_text = vim.treesitter.get_node_text(node, source)
 
     -- Since 'predicate' will not be used by callers of this function, use it
     -- to store a string set built from the list of words to check against.
@@ -468,7 +455,7 @@ local directive_handlers = {
     assert(type(id) == 'number')
 
     local node = match[id]
-    local text = M.get_node_text(node, bufnr, { metadata = metadata[id] }) or ''
+    local text = vim.treesitter.get_node_text(node, bufnr, { metadata = metadata[id] }) or ''
 
     if not metadata[id] then
       metadata[id] = {}
@@ -486,7 +473,7 @@ local directive_handlers = {
 ---
 ---@param name string Name of the predicate, without leading #
 ---@param handler function(match:table<string,TSNode>, pattern:string, bufnr:integer, predicate:string[])
----   - see |vim.treesitter.add_directive()| for argument meanings
+---   - see |vim.treesitter.query.add_directive()| for argument meanings
 ---@param force boolean|nil
 function M.add_predicate(name, handler, force)
   if predicate_handlers[name] and not force then
-- 
cgit 


From ac7397f4a06e451fedde86fb4eba0038d0d75e68 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 24 Mar 2023 16:31:30 +0000
Subject: fix(treesitter): add missing deprecate

---
 runtime/lua/vim/treesitter/_fold.lua | 5 ++---
 runtime/lua/vim/treesitter/query.lua | 9 +++------
 2 files changed, 5 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index 3e67e400c2..6547ab936e 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -1,5 +1,4 @@
 local Range = require('vim.treesitter._range')
-local Query = require('vim.treesitter.query')
 
 local api = vim.api
 
@@ -105,7 +104,7 @@ local function get_folds_levels(bufnr, info, srow, erow)
   local prev_stop = -1
 
   vim.treesitter.get_parser(bufnr):for_each_tree(function(tree, ltree)
-    local query = vim.treesitter.query.get_query(ltree:lang(), 'folds')
+    local query = vim.treesitter.query.get(ltree:lang(), 'folds')
     if not query then
       return
     end
@@ -115,7 +114,7 @@ local function get_folds_levels(bufnr, info, srow, erow)
 
     for id, node, metadata in query:iter_captures(tree:root(), bufnr, srow or 0, q_erow) do
       if query.captures[id] == 'fold' then
-        local range = Query.get_range(node, bufnr, metadata[id])
+        local range = vim.treesitter.get_range(node, bufnr, metadata[id])
         local start, _, stop, stop_col = Range.unpack4(range)
 
         if stop_col == 0 then
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 8ccd6da8a7..25623c1498 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -196,12 +196,9 @@ function M.set(lang, query_name, text)
 end
 
 ---@deprecated
----@param lang string Language to use for the query
----@param query_name string Name of the query (e.g. "highlights")
----
----@return Query|nil Parsed query
-function M.get_query(lang, query_name)
-  return M.get(lang, query_name)
+function M.get_query(...)
+  vim.deprecate('vim.treesitter.query.get_query()', 'vim.treesitter.query.get()', '0.10')
+  return M.get(...)
 end
 
 --- Returns the runtime query {query_name} for {lang}.
-- 
cgit 


From 42876ddc7ad7d3dac3e1caf2494f402e7eb25a88 Mon Sep 17 00:00:00 2001
From: Jakub Łuczyński <doubleloop@users.noreply.github.com>
Date: Sat, 25 Mar 2023 09:28:59 +0100
Subject: docs: more details about vim.region (#21116)

---
 runtime/lua/vim/_editor.lua | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index f2875e5646..fd6a5865ce 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -397,14 +397,17 @@ do
   vim.t = make_dict_accessor('t')
 end
 
---- Get a table of lines with start, end columns for a region marked by two points
+--- Get a table of lines with start, end columns for a region marked by two points.
+--- Input and output positions are (0,0)-indexed and indicate byte positions.
 ---
 ---@param bufnr integer number of buffer
 ---@param pos1 integer[] (line, column) tuple marking beginning of region
 ---@param pos2 integer[] (line, column) tuple marking end of region
 ---@param regtype string type of selection, see |setreg()|
----@param inclusive boolean indicating whether the selection is end-inclusive
----@return table region Table of the form `{linenr = {startcol,endcol}}`
+---@param inclusive boolean indicating whether column of pos2 is inclusive
+---@return table region Table of the form `{linenr = {startcol,endcol}}`.
+---        `endcol` is exclusive, and whole lines are marked with
+---        `{startcol,endcol} = {0,-1}`.
 function vim.region(bufnr, pos1, pos2, regtype, inclusive)
   if not vim.api.nvim_buf_is_loaded(bufnr) then
     vim.fn.bufload(bufnr)
-- 
cgit 


From 36ee10057ab9a93144975449cc5e27f9b96e0af3 Mon Sep 17 00:00:00 2001
From: Micah Halter <micah@mehalter.com>
Date: Sat, 25 Mar 2023 09:01:39 -0400
Subject: fix(lsp): add missing silent check in lsp hover handler (#22763)

Fixup to #21531.
---
 runtime/lua/vim/lsp/handlers.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index ee5b63d260..d01f8e6159 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -364,7 +364,9 @@ function M.hover(_, result, ctx, config)
   local markdown_lines = util.convert_input_to_markdown_lines(result.contents)
   markdown_lines = util.trim_empty_lines(markdown_lines)
   if vim.tbl_isempty(markdown_lines) then
-    vim.notify('No information available')
+    if config.silent ~= true then
+      vim.notify('No information available')
+    end
     return
   end
   return util.open_floating_preview(markdown_lines, 'markdown', config)
-- 
cgit 


From 257d894d75bc583bb16f4dbe441907eb273d20ad Mon Sep 17 00:00:00 2001
From: Roberto Pommella Alegro <robertoaall@gmail.com>
Date: Sat, 25 Mar 2023 13:46:07 -0300
Subject: feat(lsp): render markdown in docs hover #22766

Problem:
LSP docs hover (textDocument/hover) doesn't handle HTML escape seqs in markdown.

Solution:
Convert common HTML escape seqs to a nicer form, to display in the float.
closees #22757

Signed-off-by: Kasama <robertoaall@gmail.com>
---
 runtime/lua/vim/lsp/util.lua | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 48faddfce1..ebde7af16c 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1378,6 +1378,20 @@ function M.stylize_markdown(bufnr, contents, opts)
     end
   end
 
+  -- Handle some common html escape sequences
+  stripped = vim.tbl_map(function(line)
+    local escapes = {
+      ['&gt;'] = '>',
+      ['&lt;'] = '<',
+      ['&quot;'] = '"',
+      ['&apos;'] = "'",
+      ['&ensp;'] = ' ',
+      ['&emsp;'] = ' ',
+      ['&amp;'] = '&',
+    }
+    return (string.gsub(line, '&[^ ;]+;', escapes))
+  end, stripped)
+
   -- Compute size of float needed to show (wrapped) lines
   opts.wrap_at = opts.wrap_at or (vim.wo['wrap'] and api.nvim_win_get_width(0))
   local width = M._make_floating_popup_size(stripped, opts)
-- 
cgit 


From fe9cbcb3a5c82932ecfb8f49d07e98a1fc2b31e5 Mon Sep 17 00:00:00 2001
From: Evgeni Chasnovski <evgeni.chasnovski@gmail.com>
Date: Sat, 25 Mar 2023 18:58:48 +0200
Subject: feat(api): nvim_exec2(), deprecate nvim_exec() #19032

Problem:
The signature of nvim_exec() is not extensible per ":help api-contract".

Solution:
Introduce nvim_exec2() and deprecate nvim_exec().
---
 runtime/lua/vim/_editor.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index fd6a5865ce..db7a6c1d17 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -322,8 +322,8 @@ end
 ---
 ---@param command string|table Command(s) to execute.
 ---                            If a string, executes multiple lines of Vim script at once. In this
----                            case, it is an alias to |nvim_exec()|, where `output` is set to
----                            false. Thus it works identical to |:source|.
+---                            case, it is an alias to |nvim_exec2()|, where `opts.output` is set
+---                            to false. Thus it works identical to |:source|.
 ---                            If a table, executes a single command. In this case, it is an alias
 ---                            to |nvim_cmd()| where `opts` is empty.
 ---@see |ex-cmd-index|
@@ -338,7 +338,7 @@ vim.cmd = setmetatable({}, {
     if type(command) == 'table' then
       return vim.api.nvim_cmd(command, {})
     else
-      return vim.api.nvim_exec(command, false)
+      return vim.api.nvim_exec2(command, { output = false }).output
     end
   end,
   __index = function(t, command)
-- 
cgit 


From 4863ca6b8902c5b0aab95f2af640118cd417d379 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sun, 26 Mar 2023 10:49:32 +0800
Subject: test: use exec_capture() in more places (#22787)

Problem:
Using `meths.exec2("code", { output = true })` is too verbose.

Solution:
Use exec_capture() in more places.
---
 runtime/lua/vim/_editor.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index db7a6c1d17..2ff4d440f0 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -338,7 +338,8 @@ vim.cmd = setmetatable({}, {
     if type(command) == 'table' then
       return vim.api.nvim_cmd(command, {})
     else
-      return vim.api.nvim_exec2(command, { output = false }).output
+      vim.api.nvim_exec2(command, {})
+      return ''
     end
   end,
   __index = function(t, command)
-- 
cgit 


From 2257ade3dc2daab5ee12d27807c0b3bcf103cd29 Mon Sep 17 00:00:00 2001
From: Folke Lemaitre <folke.lemaitre@gmail.com>
Date: Sun, 26 Mar 2023 12:42:15 +0200
Subject: feat(lua): add `vim.loader`

feat: new faster lua loader using byte-compilation
---
 runtime/lua/vim/_editor.lua |   1 +
 runtime/lua/vim/loader.lua  | 536 ++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 537 insertions(+)
 create mode 100644 runtime/lua/vim/loader.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 2ff4d440f0..0c4b634f6f 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -28,6 +28,7 @@
 for k, v in pairs({
   treesitter = true,
   filetype = true,
+  loader = true,
   F = true,
   lsp = true,
   highlight = true,
diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
new file mode 100644
index 0000000000..41d5579664
--- /dev/null
+++ b/runtime/lua/vim/loader.lua
@@ -0,0 +1,536 @@
+local uv = vim.loop
+
+local M = {}
+
+---@alias CacheHash {mtime: {sec:number, nsec:number}, size:number}
+---@alias CacheEntry {hash:CacheHash, chunk:string}
+
+---@class ModuleFindOpts
+---@field all? boolean Search for all matches (defaults to `false`)
+---@field rtp? boolean Search for modname in the runtime path (defaults to `true`)
+---@field patterns? string[] Paterns to use (defaults to `{"/init.lua", ".lua"}`)
+---@field paths? string[] Extra paths to search for modname
+
+---@class ModuleInfo
+---@field modpath string Path of the module
+---@field modname string Name of the module
+---@field stat? uv_fs_t File stat of the module path
+
+---@alias LoaderStats table<string, {total:number, time:number, [string]:number?}?>
+
+M.path = vim.fn.stdpath('cache') .. '/luac'
+M.enabled = false
+
+---@class Loader
+---@field _rtp string[]
+---@field _rtp_pure string[]
+---@field _rtp_key string
+local Loader = {
+  VERSION = 3,
+  ---@type table<string, table<string,ModuleInfo>>
+  _indexed = {},
+  ---@type table<string, string[]>
+  _topmods = {},
+  _loadfile = loadfile,
+  ---@type LoaderStats
+  _stats = {
+    find = { total = 0, time = 0, not_found = 0 },
+  },
+}
+
+--- Tracks the time spent in a function
+---@private
+function Loader.track(stat, start)
+  Loader._stats[stat] = Loader._stats[stat] or { total = 0, time = 0 }
+  Loader._stats[stat].total = Loader._stats[stat].total + 1
+  Loader._stats[stat].time = Loader._stats[stat].time + uv.hrtime() - start
+end
+
+--- slightly faster/different version than vim.fs.normalize
+--- we also need to have it here, since the loader will load vim.fs
+---@private
+function Loader.normalize(path)
+  if path:sub(1, 1) == '~' then
+    local home = vim.loop.os_homedir() or '~'
+    if home:sub(-1) == '\\' or home:sub(-1) == '/' then
+      home = home:sub(1, -2)
+    end
+    path = home .. path:sub(2)
+  end
+  path = path:gsub('\\', '/'):gsub('/+', '/')
+  return path:sub(-1) == '/' and path:sub(1, -2) or path
+end
+
+--- Gets the rtp excluding after directories.
+--- The result is cached, and will be updated if the runtime path changes.
+--- When called from a fast event, the cached value will be returned.
+--- @return string[] rtp, boolean updated
+---@private
+function Loader.get_rtp()
+  local start = uv.hrtime()
+  if vim.in_fast_event() then
+    Loader.track('get_rtp', start)
+    return (Loader._rtp or {}), false
+  end
+  local updated = false
+  local key = vim.go.rtp
+  if key ~= Loader._rtp_key then
+    Loader._rtp = {}
+    for _, path in ipairs(vim.api.nvim_get_runtime_file('', true)) do
+      path = Loader.normalize(path)
+      -- skip after directories
+      if
+        path:sub(-6, -1) ~= '/after'
+        and not (Loader._indexed[path] and vim.tbl_isempty(Loader._indexed[path]))
+      then
+        Loader._rtp[#Loader._rtp + 1] = path
+      end
+    end
+    updated = true
+    Loader._rtp_key = key
+  end
+  Loader.track('get_rtp', start)
+  return Loader._rtp, updated
+end
+
+--- Returns the cache file name
+---@param name string can be a module name, or a file name
+---@return string file_name
+---@private
+function Loader.cache_file(name)
+  local ret = M.path .. '/' .. name:gsub('[/\\:]', '%%')
+  return ret:sub(-4) == '.lua' and (ret .. 'c') or (ret .. '.luac')
+end
+
+--- Saves the cache entry for a given module or file
+---@param name string module name or filename
+---@param entry CacheEntry
+---@private
+function Loader.write(name, entry)
+  local cname = Loader.cache_file(name)
+  local f = assert(uv.fs_open(cname, 'w', 438))
+  local header = {
+    Loader.VERSION,
+    entry.hash.size,
+    entry.hash.mtime.sec,
+    entry.hash.mtime.nsec,
+  }
+  uv.fs_write(f, table.concat(header, ',') .. '\0')
+  uv.fs_write(f, entry.chunk)
+  uv.fs_close(f)
+end
+
+--- Loads the cache entry for a given module or file
+---@param name string module name or filename
+---@return CacheEntry?
+---@private
+function Loader.read(name)
+  local start = uv.hrtime()
+  local cname = Loader.cache_file(name)
+  local f = uv.fs_open(cname, 'r', 438)
+  if f then
+    local hash = uv.fs_fstat(f) --[[@as CacheHash]]
+    local data = uv.fs_read(f, hash.size, 0) --[[@as string]]
+    uv.fs_close(f)
+
+    local zero = data:find('\0', 1, true)
+    if not zero then
+      return
+    end
+
+    ---@type integer[]|{[0]:integer}
+    local header = vim.split(data:sub(1, zero - 1), ',')
+    if tonumber(header[1]) ~= Loader.VERSION then
+      return
+    end
+    Loader.track('read', start)
+    return {
+      hash = {
+        size = tonumber(header[2]),
+        mtime = { sec = tonumber(header[3]), nsec = tonumber(header[4]) },
+      },
+      chunk = data:sub(zero + 1),
+    }
+  end
+  Loader.track('read', start)
+end
+
+--- The `package.loaders` loader for lua files using the cache.
+---@param modname string module name
+---@return string|function
+---@private
+function Loader.loader(modname)
+  local start = uv.hrtime()
+  local ret = M.find(modname)[1]
+  if ret then
+    local chunk, err = Loader.load(ret.modpath, { hash = ret.stat })
+    Loader.track('loader', start)
+    return chunk or error(err)
+  end
+  Loader.track('loader', start)
+  return '\ncache_loader: module ' .. modname .. ' not found'
+end
+
+--- The `package.loaders` loader for libs
+---@param modname string module name
+---@return string|function
+---@private
+function Loader.loader_lib(modname)
+  local start = uv.hrtime()
+  local sysname = uv.os_uname().sysname:lower() or ''
+  local is_win = sysname:find('win', 1, true) and not sysname:find('darwin', 1, true)
+  local ret = M.find(modname, { patterns = is_win and { '.dll' } or { '.so' } })[1]
+  ---@type function?, string?
+  if ret then
+    -- Making function name in Lua 5.1 (see src/loadlib.c:mkfuncname) is
+    -- a) strip prefix up to and including the first dash, if any
+    -- b) replace all dots by underscores
+    -- c) prepend "luaopen_"
+    -- So "foo-bar.baz" should result in "luaopen_bar_baz"
+    local dash = modname:find('-', 1, true)
+    local funcname = dash and modname:sub(dash + 1) or modname
+    local chunk, err = package.loadlib(ret.modpath, 'luaopen_' .. funcname:gsub('%.', '_'))
+    Loader.track('loader_lib', start)
+    return chunk or error(err)
+  end
+  Loader.track('loader_lib', start)
+  return '\ncache_loader_lib: module ' .. modname .. ' not found'
+end
+
+--- `loadfile` using the cache
+---@param filename? string
+---@param mode? "b"|"t"|"bt"
+---@param env? table
+---@param hash? CacheHash
+---@return function?, string?  error_message
+---@private
+-- luacheck: ignore 312
+function Loader.loadfile(filename, mode, env, hash)
+  local start = uv.hrtime()
+  filename = Loader.normalize(filename)
+  mode = nil -- ignore mode, since we byte-compile the lua source files
+  local chunk, err = Loader.load(filename, { mode = mode, env = env, hash = hash })
+  Loader.track('loadfile', start)
+  return chunk, err
+end
+
+--- Checks whether two cache hashes are the same based on:
+--- * file size
+--- * mtime in seconds
+--- * mtime in nanoseconds
+---@param h1 CacheHash
+---@param h2 CacheHash
+---@private
+function Loader.eq(h1, h2)
+  return h1
+    and h2
+    and h1.size == h2.size
+    and h1.mtime.sec == h2.mtime.sec
+    and h1.mtime.nsec == h2.mtime.nsec
+end
+
+--- Loads the given module path using the cache
+---@param modpath string
+---@param opts? {hash?: CacheHash, mode?: "b"|"t"|"bt", env?:table} (table|nil) Options for loading the module:
+---    - hash: (table) the hash of the file to load if it is already known. (defaults to `vim.loop.fs_stat({modpath})`)
+---    - mode: (string) the mode to load the module with. "b"|"t"|"bt" (defaults to `nil`)
+---    - env: (table) the environment to load the module in. (defaults to `nil`)
+---@see |luaL_loadfile()|
+---@return function?, string? error_message
+---@private
+function Loader.load(modpath, opts)
+  local start = uv.hrtime()
+
+  opts = opts or {}
+  local hash = opts.hash or uv.fs_stat(modpath)
+  ---@type function?, string?
+  local chunk, err
+
+  if not hash then
+    -- trigger correct error
+    chunk, err = Loader._loadfile(modpath, opts.mode, opts.env)
+    Loader.track('load', start)
+    return chunk, err
+  end
+
+  local entry = Loader.read(modpath)
+  if entry and Loader.eq(entry.hash, hash) then
+    -- found in cache and up to date
+    chunk, err = load(entry.chunk --[[@as string]], '@' .. modpath, opts.mode, opts.env)
+    if not (err and err:find('cannot load incompatible bytecode', 1, true)) then
+      Loader.track('load', start)
+      return chunk, err
+    end
+  end
+  entry = { hash = hash, modpath = modpath }
+
+  chunk, err = Loader._loadfile(modpath, opts.mode, opts.env)
+  if chunk then
+    entry.chunk = string.dump(chunk)
+    Loader.write(modpath, entry)
+  end
+  Loader.track('load', start)
+  return chunk, err
+end
+
+--- Finds lua modules for the given module name.
+---@param modname string Module name, or `"*"` to find the top-level modules instead
+---@param opts? ModuleFindOpts (table|nil) Options for finding a module:
+---    - rtp: (boolean) Search for modname in the runtime path (defaults to `true`)
+---    - paths: (string[]) Extra paths to search for modname (defaults to `{}`)
+---    - patterns: (string[]) List of patterns to use when searching for modules.
+---                A pattern is a string added to the basename of the Lua module being searched.
+---                (defaults to `{"/init.lua", ".lua"}`)
+---    - all: (boolean) Return all matches instead of just the first one (defaults to `false`)
+---@return ModuleInfo[] (list) A list of results with the following properties:
+---    - modpath: (string) the path to the module
+---    - modname: (string) the name of the module
+---    - stat: (table|nil) the fs_stat of the module path. Won't be returned for `modname="*"`
+function M.find(modname, opts)
+  local start = uv.hrtime()
+  opts = opts or {}
+
+  modname = modname:gsub('/', '.')
+  local basename = modname:gsub('%.', '/')
+  local idx = modname:find('.', 1, true)
+
+  -- HACK: fix incorrect require statements. Really not a fan of keeping this,
+  -- but apparently the regular lua loader also allows this
+  if idx == 1 then
+    modname = modname:gsub('^%.+', '')
+    basename = modname:gsub('%.', '/')
+    idx = modname:find('.', 1, true)
+  end
+
+  -- get the top-level module name
+  local topmod = idx and modname:sub(1, idx - 1) or modname
+
+  -- OPTIM: search for a directory first when topmod == modname
+  local patterns = opts.patterns
+    or (topmod == modname and { '/init.lua', '.lua' } or { '.lua', '/init.lua' })
+  for p, pattern in ipairs(patterns) do
+    patterns[p] = '/lua/' .. basename .. pattern
+  end
+
+  ---@type ModuleInfo[]
+  local results = {}
+
+  -- Only continue if we haven't found anything yet or we want to find all
+  ---@private
+  local function continue()
+    return #results == 0 or opts.all
+  end
+
+  -- Checks if the given paths contain the top-level module.
+  -- If so, it tries to find the module path for the given module name.
+  ---@param paths string[]
+  ---@private
+  local function _find(paths)
+    for _, path in ipairs(paths) do
+      if topmod == '*' then
+        for _, r in pairs(Loader.lsmod(path)) do
+          results[#results + 1] = r
+          if not continue() then
+            return
+          end
+        end
+      elseif Loader.lsmod(path)[topmod] then
+        for _, pattern in ipairs(patterns) do
+          local modpath = path .. pattern
+          Loader._stats.find.stat = (Loader._stats.find.stat or 0) + 1
+          local hash = uv.fs_stat(modpath)
+          if hash then
+            results[#results + 1] = { modpath = modpath, stat = hash, modname = modname }
+            if not continue() then
+              return
+            end
+          end
+        end
+      end
+    end
+  end
+
+  -- always check the rtp first
+  if opts.rtp ~= false then
+    _find(Loader._rtp or {})
+    if continue() then
+      local rtp, updated = Loader.get_rtp()
+      if updated then
+        _find(rtp)
+      end
+    end
+  end
+
+  -- check any additional paths
+  if continue() and opts.paths then
+    _find(opts.paths)
+  end
+
+  Loader.track('find', start)
+  if #results == 0 then
+    -- module not found
+    Loader._stats.find.not_found = Loader._stats.find.not_found + 1
+  end
+
+  return results
+end
+
+--- Resets the topmods cache for the path, or all the paths
+--- if path is nil.
+---@param path string? path to reset
+function M.reset(path)
+  if path then
+    Loader._indexed[Loader.normalize(path)] = nil
+  else
+    Loader._indexed = {}
+  end
+end
+
+--- Enables the experimental Lua module loader:
+--- * overrides loadfile
+--- * adds the lua loader using the byte-compilation cache
+--- * adds the libs loader
+--- * removes the default Neovim loader
+function M.enable()
+  if M.enabled then
+    return
+  end
+  M.enabled = true
+  vim.fn.mkdir(vim.fn.fnamemodify(M.path, ':p'), 'p')
+  _G.loadfile = Loader.loadfile
+  -- add lua loader
+  table.insert(package.loaders, 2, Loader.loader)
+  -- add libs loader
+  table.insert(package.loaders, 3, Loader.loader_lib)
+  -- remove Neovim loader
+  for l, loader in ipairs(package.loaders) do
+    if loader == vim._load_package then
+      table.remove(package.loaders, l)
+      break
+    end
+  end
+
+  -- this will reset the top-mods in case someone adds a new
+  -- top-level lua module to a path already on the rtp
+  vim.api.nvim_create_autocmd('BufWritePost', {
+    group = vim.api.nvim_create_augroup('cache_topmods_reset', { clear = true }),
+    callback = function(event)
+      local bufname = event.match ---@type string
+      local idx = bufname:find('/lua/', 1, true)
+      if idx then
+        M.reset(bufname:sub(1, idx - 1))
+      end
+    end,
+  })
+end
+
+--- Disables the experimental Lua module loader:
+--- * removes the loaders
+--- * adds the default Neovim loader
+function M.disable()
+  if not M.enabled then
+    return
+  end
+  M.enabled = false
+  _G.loadfile = Loader._loadfile
+  ---@diagnostic disable-next-line: no-unknown
+  for l, loader in ipairs(package.loaders) do
+    if loader == Loader.loader or loader == Loader.loader_lib then
+      table.remove(package.loaders, l)
+    end
+  end
+  table.insert(package.loaders, 2, vim._load_package)
+  vim.api.nvim_del_augroup_by_name('cache_topmods_reset')
+end
+
+--- Return the top-level `/lua/*` modules for this path
+---@param path string path to check for top-level lua modules
+---@private
+function Loader.lsmod(path)
+  if not Loader._indexed[path] then
+    local start = uv.hrtime()
+    Loader._indexed[path] = {}
+    local handle = vim.loop.fs_scandir(path .. '/lua')
+    while handle do
+      local name, t = vim.loop.fs_scandir_next(handle)
+      if not name then
+        break
+      end
+      local modpath = path .. '/lua/' .. name
+      -- HACK: type is not always returned due to a bug in luv
+      t = t or uv.fs_stat(modpath).type
+      ---@type string
+      local topname
+      local ext = name:sub(-4)
+      if ext == '.lua' or ext == '.dll' then
+        topname = name:sub(1, -5)
+      elseif name:sub(-3) == '.so' then
+        topname = name:sub(1, -4)
+      elseif t == 'link' or t == 'directory' then
+        topname = name
+      end
+      if topname then
+        Loader._indexed[path][topname] = { modpath = modpath, modname = topname }
+        Loader._topmods[topname] = Loader._topmods[topname] or {}
+        if not vim.tbl_contains(Loader._topmods[topname], path) then
+          table.insert(Loader._topmods[topname], path)
+        end
+      end
+    end
+    Loader.track('lsmod', start)
+  end
+  return Loader._indexed[path]
+end
+
+--- Debug function that wrapps all loaders and tracks stats
+---@private
+function M._profile_loaders()
+  for l, loader in pairs(package.loaders) do
+    local loc = debug.getinfo(loader, 'Sn').source:sub(2)
+    package.loaders[l] = function(modname)
+      local start = vim.loop.hrtime()
+      local ret = loader(modname)
+      Loader.track('loader ' .. l .. ': ' .. loc, start)
+      Loader.track('loader_all', start)
+      return ret
+    end
+  end
+end
+
+--- Prints all cache stats
+---@param opts? {print?:boolean}
+---@return LoaderStats
+---@private
+function M._inspect(opts)
+  if opts and opts.print then
+    ---@private
+    local function ms(nsec)
+      return math.floor(nsec / 1e6 * 1000 + 0.5) / 1000 .. 'ms'
+    end
+    local chunks = {} ---@type string[][]
+    ---@type string[]
+    local stats = vim.tbl_keys(Loader._stats)
+    table.sort(stats)
+    for _, stat in ipairs(stats) do
+      vim.list_extend(chunks, {
+        { '\n' .. stat .. '\n', 'Title' },
+        { '* total:    ' },
+        { tostring(Loader._stats[stat].total) .. '\n', 'Number' },
+        { '* time:     ' },
+        { ms(Loader._stats[stat].time) .. '\n', 'Bold' },
+        { '* avg time: ' },
+        { ms(Loader._stats[stat].time / Loader._stats[stat].total) .. '\n', 'Bold' },
+      })
+      for k, v in pairs(Loader._stats[stat]) do
+        if not vim.tbl_contains({ 'time', 'total' }, k) then
+          chunks[#chunks + 1] = { '* ' .. k .. ':' .. string.rep(' ', 9 - #k) }
+          chunks[#chunks + 1] = { tostring(v) .. '\n', 'Number' }
+        end
+      end
+    end
+    vim.api.nvim_echo(chunks, true, {})
+  end
+  return Loader._stats
+end
+
+return M
-- 
cgit 


From 3c82ce0d625184a90e6b2dda96e38fcb44f901d2 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 26 Mar 2023 12:46:24 +0100
Subject: refactor(loader): use vim.fs

---
 runtime/lua/vim/fs.lua     | 11 ++++++++---
 runtime/lua/vim/loader.lua |  7 +------
 2 files changed, 9 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index 2c3fc64d57..c6371e9163 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -77,6 +77,8 @@ local function join_paths(...)
   return (table.concat({ ... }, '/'):gsub('//+', '/'))
 end
 
+---@alias Iterator fun(): string?, string?
+
 --- Return an iterator over the files and directories located in {path}
 ---
 ---@param path (string) An absolute or relative path to the directory to iterate
@@ -100,10 +102,13 @@ function M.dir(path, opts)
   })
 
   if not opts.depth or opts.depth == 1 then
-    return function(fs)
+    local fs = vim.loop.fs_scandir(M.normalize(path))
+    return function()
+      if not fs then
+        return
+      end
       return vim.loop.fs_scandir_next(fs)
-    end,
-      vim.loop.fs_scandir(M.normalize(path))
+    end
   end
 
   --- @async
diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index 41d5579664..bafe766a5d 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -450,12 +450,7 @@ function Loader.lsmod(path)
   if not Loader._indexed[path] then
     local start = uv.hrtime()
     Loader._indexed[path] = {}
-    local handle = vim.loop.fs_scandir(path .. '/lua')
-    while handle do
-      local name, t = vim.loop.fs_scandir_next(handle)
-      if not name then
-        break
-      end
+    for name, t in vim.fs.dir(path .. '/lua') do
       local modpath = path .. '/lua/' .. name
       -- HACK: type is not always returned due to a bug in luv
       t = t or uv.fs_stat(modpath).type
-- 
cgit 


From fab8dab6b6273767e2b31e4282cee5a11349ac8f Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 26 Mar 2023 12:47:06 +0100
Subject: refactor(loader): remove BufWritePost autocmd

---
 runtime/lua/vim/loader.lua | 14 --------------
 1 file changed, 14 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index bafe766a5d..3dc1bd9574 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -409,19 +409,6 @@ function M.enable()
       break
     end
   end
-
-  -- this will reset the top-mods in case someone adds a new
-  -- top-level lua module to a path already on the rtp
-  vim.api.nvim_create_autocmd('BufWritePost', {
-    group = vim.api.nvim_create_augroup('cache_topmods_reset', { clear = true }),
-    callback = function(event)
-      local bufname = event.match ---@type string
-      local idx = bufname:find('/lua/', 1, true)
-      if idx then
-        M.reset(bufname:sub(1, idx - 1))
-      end
-    end,
-  })
 end
 
 --- Disables the experimental Lua module loader:
@@ -440,7 +427,6 @@ function M.disable()
     end
   end
   table.insert(package.loaders, 2, vim._load_package)
-  vim.api.nvim_del_augroup_by_name('cache_topmods_reset')
 end
 
 --- Return the top-level `/lua/*` modules for this path
-- 
cgit 


From ffd8cd1a96a96b09351a5ffde1068c3595443128 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 26 Mar 2023 12:49:38 +0100
Subject: refactor(loader): add typing for package.loaders

---
 runtime/lua/vim/loader.lua | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index 3dc1bd9574..19df7e4383 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -1,5 +1,8 @@
 local uv = vim.loop
 
+--- @type (fun(modename: string): fun()|string)[]
+local loaders = package.loaders
+
 local M = {}
 
 ---@alias CacheHash {mtime: {sec:number, nsec:number}, size:number}
@@ -399,13 +402,13 @@ function M.enable()
   vim.fn.mkdir(vim.fn.fnamemodify(M.path, ':p'), 'p')
   _G.loadfile = Loader.loadfile
   -- add lua loader
-  table.insert(package.loaders, 2, Loader.loader)
+  table.insert(loaders, 2, Loader.loader)
   -- add libs loader
-  table.insert(package.loaders, 3, Loader.loader_lib)
+  table.insert(loaders, 3, Loader.loader_lib)
   -- remove Neovim loader
-  for l, loader in ipairs(package.loaders) do
+  for l, loader in ipairs(loaders) do
     if loader == vim._load_package then
-      table.remove(package.loaders, l)
+      table.remove(loaders, l)
       break
     end
   end
@@ -420,13 +423,12 @@ function M.disable()
   end
   M.enabled = false
   _G.loadfile = Loader._loadfile
-  ---@diagnostic disable-next-line: no-unknown
-  for l, loader in ipairs(package.loaders) do
+  for l, loader in ipairs(loaders) do
     if loader == Loader.loader or loader == Loader.loader_lib then
-      table.remove(package.loaders, l)
+      table.remove(loaders, l)
     end
   end
-  table.insert(package.loaders, 2, vim._load_package)
+  table.insert(loaders, 2, vim._load_package)
 end
 
 --- Return the top-level `/lua/*` modules for this path
@@ -466,9 +468,9 @@ end
 --- Debug function that wrapps all loaders and tracks stats
 ---@private
 function M._profile_loaders()
-  for l, loader in pairs(package.loaders) do
+  for l, loader in pairs(loaders) do
     local loc = debug.getinfo(loader, 'Sn').source:sub(2)
-    package.loaders[l] = function(modname)
+    loaders[l] = function(modname)
       local start = vim.loop.hrtime()
       local ret = loader(modname)
       Loader.track('loader ' .. l .. ': ' .. loc, start)
-- 
cgit 


From 25fa051fa157ca4bce712e61602447a4222581ca Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 26 Mar 2023 13:01:48 +0100
Subject: feat(vim.fs): improve normalize

- Add options argument with an option to expand env vars
- Resolve '//' -> '/'
- Use in vim.loader
---
 runtime/lua/vim/fs.lua     | 34 +++++++++++++++++++++++++---------
 runtime/lua/vim/loader.lua | 20 +++++---------------
 2 files changed, 30 insertions(+), 24 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index c6371e9163..407b334f20 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -321,16 +321,32 @@ end
 --- </pre>
 ---
 ---@param path (string) Path to normalize
+---@param opts table|nil Options:
+---             - expand_env: boolean Expand environment variables (default: true)
 ---@return (string) Normalized path
-function M.normalize(path)
-  vim.validate({ path = { path, 's' } })
-  return (
-    path
-      :gsub('^~$', vim.loop.os_homedir())
-      :gsub('^~/', vim.loop.os_homedir() .. '/')
-      :gsub('%$([%w_]+)', vim.loop.os_getenv)
-      :gsub('\\', '/')
-  )
+function M.normalize(path, opts)
+  opts = opts or {}
+
+  vim.validate({
+    path = { path, { 'string' } },
+    expand_env = { opts.expand_env, { 'boolean' }, true },
+  })
+
+  if path:sub(1, 1) == '~' then
+    local home = vim.loop.os_homedir() or '~'
+    if home:sub(-1) == '\\' or home:sub(-1) == '/' then
+      home = home:sub(1, -2)
+    end
+    path = home .. path:sub(2)
+  end
+
+  if opts.expand_env == nil or opts.expand_env then
+    path = path:gsub('%$([%w_]+)', vim.loop.os_getenv)
+  end
+
+  path = path:gsub('\\', '/'):gsub('/+', '/')
+
+  return path:sub(-1) == '/' and path:sub(1, -2) or path
 end
 
 return M
diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index 19df7e4383..eccf95e2f2 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -49,19 +49,9 @@ function Loader.track(stat, start)
   Loader._stats[stat].time = Loader._stats[stat].time + uv.hrtime() - start
 end
 
---- slightly faster/different version than vim.fs.normalize
---- we also need to have it here, since the loader will load vim.fs
 ---@private
-function Loader.normalize(path)
-  if path:sub(1, 1) == '~' then
-    local home = vim.loop.os_homedir() or '~'
-    if home:sub(-1) == '\\' or home:sub(-1) == '/' then
-      home = home:sub(1, -2)
-    end
-    path = home .. path:sub(2)
-  end
-  path = path:gsub('\\', '/'):gsub('/+', '/')
-  return path:sub(-1) == '/' and path:sub(1, -2) or path
+local function normalize(path)
+  return vim.fs.normalize(path, { expand_env = false })
 end
 
 --- Gets the rtp excluding after directories.
@@ -80,7 +70,7 @@ function Loader.get_rtp()
   if key ~= Loader._rtp_key then
     Loader._rtp = {}
     for _, path in ipairs(vim.api.nvim_get_runtime_file('', true)) do
-      path = Loader.normalize(path)
+      path = normalize(path)
       -- skip after directories
       if
         path:sub(-6, -1) ~= '/after'
@@ -210,7 +200,7 @@ end
 -- luacheck: ignore 312
 function Loader.loadfile(filename, mode, env, hash)
   local start = uv.hrtime()
-  filename = Loader.normalize(filename)
+  filename = normalize(filename)
   mode = nil -- ignore mode, since we byte-compile the lua source files
   local chunk, err = Loader.load(filename, { mode = mode, env = env, hash = hash })
   Loader.track('loadfile', start)
@@ -383,7 +373,7 @@ end
 ---@param path string? path to reset
 function M.reset(path)
   if path then
-    Loader._indexed[Loader.normalize(path)] = nil
+    Loader._indexed[normalize(path)] = nil
   else
     Loader._indexed = {}
   end
-- 
cgit 


From fd70a9dca199aae1eb7714608d63e8b2e63fb293 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 26 Mar 2023 13:23:34 +0100
Subject: refactor(loader): simplify tracking logic

---
 runtime/lua/vim/loader.lua | 74 +++++++++++++++++++---------------------------
 1 file changed, 30 insertions(+), 44 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index eccf95e2f2..7b6b9cb563 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -41,14 +41,6 @@ local Loader = {
   },
 }
 
---- Tracks the time spent in a function
----@private
-function Loader.track(stat, start)
-  Loader._stats[stat] = Loader._stats[stat] or { total = 0, time = 0 }
-  Loader._stats[stat].total = Loader._stats[stat].total + 1
-  Loader._stats[stat].time = Loader._stats[stat].time + uv.hrtime() - start
-end
-
 ---@private
 local function normalize(path)
   return vim.fs.normalize(path, { expand_env = false })
@@ -60,9 +52,7 @@ end
 --- @return string[] rtp, boolean updated
 ---@private
 function Loader.get_rtp()
-  local start = uv.hrtime()
   if vim.in_fast_event() then
-    Loader.track('get_rtp', start)
     return (Loader._rtp or {}), false
   end
   local updated = false
@@ -82,7 +72,6 @@ function Loader.get_rtp()
     updated = true
     Loader._rtp_key = key
   end
-  Loader.track('get_rtp', start)
   return Loader._rtp, updated
 end
 
@@ -118,7 +107,6 @@ end
 ---@return CacheEntry?
 ---@private
 function Loader.read(name)
-  local start = uv.hrtime()
   local cname = Loader.cache_file(name)
   local f = uv.fs_open(cname, 'r', 438)
   if f then
@@ -136,7 +124,6 @@ function Loader.read(name)
     if tonumber(header[1]) ~= Loader.VERSION then
       return
     end
-    Loader.track('read', start)
     return {
       hash = {
         size = tonumber(header[2]),
@@ -145,7 +132,6 @@ function Loader.read(name)
       chunk = data:sub(zero + 1),
     }
   end
-  Loader.track('read', start)
 end
 
 --- The `package.loaders` loader for lua files using the cache.
@@ -153,14 +139,11 @@ end
 ---@return string|function
 ---@private
 function Loader.loader(modname)
-  local start = uv.hrtime()
   local ret = M.find(modname)[1]
   if ret then
     local chunk, err = Loader.load(ret.modpath, { hash = ret.stat })
-    Loader.track('loader', start)
     return chunk or error(err)
   end
-  Loader.track('loader', start)
   return '\ncache_loader: module ' .. modname .. ' not found'
 end
 
@@ -169,7 +152,6 @@ end
 ---@return string|function
 ---@private
 function Loader.loader_lib(modname)
-  local start = uv.hrtime()
   local sysname = uv.os_uname().sysname:lower() or ''
   local is_win = sysname:find('win', 1, true) and not sysname:find('darwin', 1, true)
   local ret = M.find(modname, { patterns = is_win and { '.dll' } or { '.so' } })[1]
@@ -183,10 +165,8 @@ function Loader.loader_lib(modname)
     local dash = modname:find('-', 1, true)
     local funcname = dash and modname:sub(dash + 1) or modname
     local chunk, err = package.loadlib(ret.modpath, 'luaopen_' .. funcname:gsub('%.', '_'))
-    Loader.track('loader_lib', start)
     return chunk or error(err)
   end
-  Loader.track('loader_lib', start)
   return '\ncache_loader_lib: module ' .. modname .. ' not found'
 end
 
@@ -199,12 +179,9 @@ end
 ---@private
 -- luacheck: ignore 312
 function Loader.loadfile(filename, mode, env, hash)
-  local start = uv.hrtime()
-  filename = normalize(filename)
-  mode = nil -- ignore mode, since we byte-compile the lua source files
-  local chunk, err = Loader.load(filename, { mode = mode, env = env, hash = hash })
-  Loader.track('loadfile', start)
-  return chunk, err
+  -- ignore mode, since we byte-compile the lua source files
+  mode = nil
+  return Loader.load(normalize(filename), { mode = mode, env = env, hash = hash })
 end
 
 --- Checks whether two cache hashes are the same based on:
@@ -232,8 +209,6 @@ end
 ---@return function?, string? error_message
 ---@private
 function Loader.load(modpath, opts)
-  local start = uv.hrtime()
-
   opts = opts or {}
   local hash = opts.hash or uv.fs_stat(modpath)
   ---@type function?, string?
@@ -241,9 +216,7 @@ function Loader.load(modpath, opts)
 
   if not hash then
     -- trigger correct error
-    chunk, err = Loader._loadfile(modpath, opts.mode, opts.env)
-    Loader.track('load', start)
-    return chunk, err
+    return Loader._loadfile(modpath, opts.mode, opts.env)
   end
 
   local entry = Loader.read(modpath)
@@ -251,7 +224,6 @@ function Loader.load(modpath, opts)
     -- found in cache and up to date
     chunk, err = load(entry.chunk --[[@as string]], '@' .. modpath, opts.mode, opts.env)
     if not (err and err:find('cannot load incompatible bytecode', 1, true)) then
-      Loader.track('load', start)
       return chunk, err
     end
   end
@@ -262,7 +234,6 @@ function Loader.load(modpath, opts)
     entry.chunk = string.dump(chunk)
     Loader.write(modpath, entry)
   end
-  Loader.track('load', start)
   return chunk, err
 end
 
@@ -280,7 +251,6 @@ end
 ---    - modname: (string) the name of the module
 ---    - stat: (table|nil) the fs_stat of the module path. Won't be returned for `modname="*"`
 function M.find(modname, opts)
-  local start = uv.hrtime()
   opts = opts or {}
 
   modname = modname:gsub('/', '.')
@@ -359,7 +329,6 @@ function M.find(modname, opts)
     _find(opts.paths)
   end
 
-  Loader.track('find', start)
   if #results == 0 then
     -- module not found
     Loader._stats.find.not_found = Loader._stats.find.not_found + 1
@@ -426,7 +395,6 @@ end
 ---@private
 function Loader.lsmod(path)
   if not Loader._indexed[path] then
-    local start = uv.hrtime()
     Loader._indexed[path] = {}
     for name, t in vim.fs.dir(path .. '/lua') do
       local modpath = path .. '/lua/' .. name
@@ -450,23 +418,41 @@ function Loader.lsmod(path)
         end
       end
     end
-    Loader.track('lsmod', start)
   end
   return Loader._indexed[path]
 end
 
+--- Tracks the time spent in a function
+--- @generic F: function
+--- @param f F
+--- @return F
+--- @private
+function Loader.track(stat, f)
+  return function(...)
+    local start = vim.loop.hrtime()
+    local r = { f(...) }
+    Loader._stats[stat] = Loader._stats[stat] or { total = 0, time = 0 }
+    Loader._stats[stat].total = Loader._stats[stat].total + 1
+    Loader._stats[stat].time = Loader._stats[stat].time + uv.hrtime() - start
+    return unpack(r, 1, table.maxn(r))
+  end
+end
+
+Loader.get_rtp = Loader.track('get_rtp', Loader.get_rtp)
+Loader.read = Loader.track('read', Loader.read)
+Loader.loader = Loader.track('loader', Loader.loader)
+Loader.loader_lib = Loader.track('loader_lib', Loader.loader_lib)
+Loader.loadfile = Loader.track('loadfile', Loader.loadfile)
+Loader.load = Loader.track('load', Loader.load)
+M.find = Loader.track('find', M.find)
+Loader.lsmod = Loader.track('lsmod', Loader.lsmod)
+
 --- Debug function that wrapps all loaders and tracks stats
 ---@private
 function M._profile_loaders()
   for l, loader in pairs(loaders) do
     local loc = debug.getinfo(loader, 'Sn').source:sub(2)
-    loaders[l] = function(modname)
-      local start = vim.loop.hrtime()
-      local ret = loader(modname)
-      Loader.track('loader ' .. l .. ': ' .. loc, start)
-      Loader.track('loader_all', start)
-      return ret
-    end
+    loaders[l] = Loader.track('loader ' .. l .. ': ' .. loc, loader)
   end
 end
 
-- 
cgit 


From 196f69909db9e44477731cd805dac119a54725c2 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 29 Mar 2023 10:23:52 +0200
Subject: vim-patch:9.0.1430: Livebook files are not recognized (#22808)

Problem:    Livebook files are not recognized.
Solution:   Add a pattern for Livebook files. (Mathias Jean Johansen,
            closes vim/vim#12203)

https://github.com/vim/vim/commit/64002035178ac3e0d9ab7269d1bf06c6ede5a854

Co-authored-by: Mathias Jean Johansen <mathias@mjj.io>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 740304df15..87439f9f0c 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -615,6 +615,7 @@ local extension = {
   asd = 'lisp',
   lt = 'lite',
   lite = 'lite',
+  livemd = 'livebook',
   lgt = 'logtalk',
   lotos = 'lotos',
   lot = 'lotos',
-- 
cgit 


From 61e54f26361b2e7d08eabde9a4cbf42aaa41683b Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 30 Mar 2023 10:26:28 +0100
Subject: feat: add `vim.treesitter.language.get_filetypes()` (#22643)

---
 runtime/lua/vim/treesitter.lua              | 33 +++++++----------
 runtime/lua/vim/treesitter/language.lua     | 57 +++++++++++++++++++----------
 runtime/lua/vim/treesitter/languagetree.lua |  7 +---
 3 files changed, 51 insertions(+), 46 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 4c3b17daa4..2594c1672d 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -58,9 +58,6 @@ function M._create_parser(bufnr, lang, opts)
 
   vim.fn.bufload(bufnr)
 
-  local ft = vim.bo[bufnr].filetype
-  M.language.add(lang, { filetype = ft ~= '' and ft or nil })
-
   local self = LanguageTree.new(bufnr, lang, opts)
 
   ---@private
@@ -94,7 +91,12 @@ function M._create_parser(bufnr, lang, opts)
   return self
 end
 
---- Returns the parser for a specific buffer and filetype and attaches it to the buffer
+--- @private
+local function valid_lang(lang)
+  return lang and lang ~= ''
+end
+
+--- Returns the parser for a specific buffer and attaches it to the buffer
 ---
 --- If needed, this will create the parser.
 ---
@@ -110,18 +112,12 @@ function M.get_parser(bufnr, lang, opts)
     bufnr = a.nvim_get_current_buf()
   end
 
-  if lang == nil then
-    local ft = vim.bo[bufnr].filetype
-    if ft ~= '' then
-      lang = M.language.get_lang(ft) or ft
-      -- TODO(lewis6991): we should error here and not default to ft
-      -- if not lang then
-      --   error(string.format('filetype %s of buffer %d is not associated with any lang', ft, bufnr))
-      -- end
-    else
-      if parsers[bufnr] then
-        return parsers[bufnr]
-      end
+  if not valid_lang(lang) then
+    lang = M.language.get_lang(vim.bo[bufnr].filetype) or vim.bo[bufnr].filetype
+  end
+
+  if not valid_lang(lang) then
+    if not parsers[bufnr] then
       error(
         string.format(
           'There is no parser available for buffer %d and one could not be'
@@ -131,9 +127,7 @@ function M.get_parser(bufnr, lang, opts)
         )
       )
     end
-  end
-
-  if parsers[bufnr] == nil or parsers[bufnr]:lang() ~= lang then
+  elseif parsers[bufnr] == nil or parsers[bufnr]:lang() ~= lang then
     parsers[bufnr] = M._create_parser(bufnr, lang, opts)
   end
 
@@ -164,7 +158,6 @@ function M.get_string_parser(str, lang, opts)
     str = { str, 'string' },
     lang = { lang, 'string' },
   })
-  M.language.add(lang)
 
   return LanguageTree.new(str, lang, opts)
 end
diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index 974d66ec05..b1c788e6ba 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -6,9 +6,25 @@ local M = {}
 ---@type table<string,string>
 local ft_to_lang = {}
 
----@param filetype string
----@return string|nil
+--- Get the filetypes associated with the parser named {lang}.
+--- @param lang string Name of parser
+--- @return string[] filetypes
+function M.get_filetypes(lang)
+  local r = {} ---@type string[]
+  for ft, p in pairs(ft_to_lang) do
+    if p == lang then
+      r[#r + 1] = ft
+    end
+  end
+  return r
+end
+
+--- @param filetype string
+--- @return string|nil
 function M.get_lang(filetype)
+  if filetype == '' then
+    return
+  end
   return ft_to_lang[filetype]
 end
 
@@ -35,16 +51,14 @@ end
 ---@field filetype? string|string[]
 ---@field symbol_name? string
 
---- Asserts that a parser for the language {lang} is installed.
+--- Load parser with name {lang}
 ---
 --- Parsers are searched in the `parser` runtime directory, or the provided {path}
 ---
----@param lang string Language the parser should parse (alphanumerical and `_` only)
+---@param lang string Name of the parser (alphanumerical and `_` only)
 ---@param opts (table|nil) Options:
----                        - filetype (string|string[]) Filetype(s) that lang can be parsed with.
----                          Note this is not strictly the same as lang since a single lang can
----                          parse multiple filetypes.
----                          Defaults to lang.
+---                        - filetype (string|string[]) Default filetype the parser should be associated with.
+---                          Defaults to {lang}.
 ---                        - path (string|nil) Optional path the parser is located at
 ---                        - symbol_name (string|nil) Internal symbol name for the language to load
 function M.add(lang, opts)
@@ -61,7 +75,7 @@ function M.add(lang, opts)
     filetype = { filetype, { 'string', 'table' }, true },
   })
 
-  M.register(lang, filetype or lang)
+  M.register(lang, filetype)
 
   if vim._ts_has_language(lang) then
     return
@@ -83,23 +97,26 @@ function M.add(lang, opts)
   vim._ts_add_language(path, lang, symbol_name)
 end
 
---- Register a lang to be used for a filetype (or list of filetypes).
----@param lang string Language to register
----@param filetype string|string[] Filetype(s) to associate with lang
+--- @private
+--- @param x string|string[]
+--- @return string[]
+local function ensure_list(x)
+  if type(x) == 'table' then
+    return x
+  end
+  return { x }
+end
+
+--- Register a parser named {lang} to be used for {filetype}(s).
+--- @param lang string Name of parser
+--- @param filetype string|string[] Filetype(s) to associate with lang
 function M.register(lang, filetype)
   vim.validate({
     lang = { lang, 'string' },
     filetype = { filetype, { 'string', 'table' } },
   })
 
-  local filetypes ---@type string[]
-  if type(filetype) == 'string' then
-    filetypes = { filetype }
-  else
-    filetypes = filetype
-  end
-
-  for _, f in ipairs(filetypes) do
+  for _, f in ipairs(ensure_list(filetype)) do
     if f ~= '' then
       ft_to_lang[f] = lang
     end
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 82e507551d..922e4881ca 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -76,7 +76,7 @@ LanguageTree.__index = LanguageTree
 --- "injected" language parsers, which themselves may inject other languages, recursively.
 ---
 ---@param source (integer|string) Buffer or text string to parse
----@param lang string Root language of this tree
+---@param lang string|nil Root language of this tree
 ---@param opts (table|nil) Optional arguments:
 ---             - injections table Map of language to injection query strings. Overrides the
 ---                                built-in runtime file searching for language injections.
@@ -86,11 +86,6 @@ function LanguageTree.new(source, lang, opts)
   ---@type LanguageTreeOpts
   opts = opts or {}
 
-  if opts.queries then
-    a.nvim_err_writeln("'queries' is no longer supported. Use 'injections' now")
-    opts.injections = opts.queries
-  end
-
   local injections = opts.injections or {}
   local self = setmetatable({
     _source = source,
-- 
cgit 


From 226a6c3eaef2a7220841d3d5e69e1baf543b3d6f Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 30 Mar 2023 14:49:58 +0100
Subject: feat(diagnostic): add support for tags

The LSP spec supports two tags that can be added to diagnostics:
unnecessary and deprecated. Extend vim.diagnostic to be able to handle
these.
---
 runtime/lua/vim/diagnostic.lua     | 12 +++++++++
 runtime/lua/vim/lsp/diagnostic.lua | 54 +++++++++++++++++++++++++++++---------
 runtime/lua/vim/lsp/protocol.lua   |  2 ++
 runtime/lua/vim/lsp/types.lua      | 17 ++++++++++++
 4 files changed, 73 insertions(+), 12 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index 56532d0184..714038f8e4 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -483,6 +483,7 @@ local function next_diagnostic(position, search_forward, bufnr, opts, namespace)
   local diagnostics =
     get_diagnostics(bufnr, vim.tbl_extend('keep', opts, { namespace = namespace }), true)
   local line_diagnostics = diagnostic_lines(diagnostics)
+
   for i = 0, line_count do
     local offset = i * (search_forward and 1 or -1)
     local lnum = position[1] + offset
@@ -752,6 +753,7 @@ end
 ---@field message string
 ---@field source nil|string
 ---@field code nil|string
+---@field _tags { deprecated: boolean, unnecessary: boolean}
 ---@field user_data nil|any arbitrary data plugins can add
 
 --- Get current diagnostics.
@@ -948,6 +950,16 @@ M.handlers.underline = {
         higroup = underline_highlight_map.Error
       end
 
+      if diagnostic._tags then
+        -- TODO(lewis6991): we should be able to stack these.
+        if diagnostic._tags.unnecessary then
+          higroup = 'DiagnosticUnnecessary'
+        end
+        if diagnostic._tags.deprecated then
+          higroup = 'DiagnosticDeprecated'
+        end
+      end
+
       vim.highlight.range(
         bufnr,
         underline_ns,
diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index b27bf6e425..dcc8f6549c 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -1,13 +1,6 @@
 ---@brief lsp-diagnostic
----
----@class Diagnostic
----@field range Range
----@field message string
----@field severity DiagnosticSeverity|nil
----@field code integer | string
----@field source string
----@field tags DiagnosticTag[]
----@field relatedInformation DiagnosticRelatedInformation[]
+
+local protocol = require('vim.lsp.protocol')
 
 local M = {}
 
@@ -22,14 +15,16 @@ local function get_client_id(client_id)
 end
 
 ---@private
+---@param severity lsp.DiagnosticSeverity
 local function severity_lsp_to_vim(severity)
   if type(severity) == 'string' then
-    severity = vim.lsp.protocol.DiagnosticSeverity[severity]
+    severity = protocol.DiagnosticSeverity[severity]
   end
   return severity
 end
 
 ---@private
+---@return lsp.DiagnosticSeverity
 local function severity_vim_to_lsp(severity)
   if type(severity) == 'string' then
     severity = vim.diagnostic.severity[severity]
@@ -38,6 +33,7 @@ local function severity_vim_to_lsp(severity)
 end
 
 ---@private
+---@return integer
 local function line_byte_from_position(lines, lnum, col, offset_encoding)
   if not lines or offset_encoding == 'utf-8' then
     return col
@@ -77,12 +73,41 @@ local function get_buf_lines(bufnr)
   return lines
 end
 
+--- @private
+--- @param diagnostic lsp.Diagnostic
+--- @param client_id integer
+--- @return table?
+local function tags_lsp_to_vim(diagnostic, client_id)
+  local tags ---@type table?
+  for _, tag in ipairs(diagnostic.tags or {}) do
+    if tag == protocol.DiagnosticTag.Unnecessary then
+      tags = tags or {}
+      tags.unnecessary = true
+    elseif tag == protocol.DiagnosticTag.Deprecated then
+      tags = tags or {}
+      tags.deprecated = true
+    else
+      vim.notify_once(
+        string.format('Unknown DiagnosticTag %d from LSP client %d', tag, client_id),
+        vim.log.levels.WARN
+      )
+    end
+  end
+  return tags
+end
+
 ---@private
+---@param diagnostics lsp.Diagnostic[]
+---@param bufnr integer
+---@param client_id integer
+---@return Diagnostic[]
 local function diagnostic_lsp_to_vim(diagnostics, bufnr, client_id)
   local buf_lines = get_buf_lines(bufnr)
   local client = vim.lsp.get_client_by_id(client_id)
   local offset_encoding = client and client.offset_encoding or 'utf-16'
+  ---@diagnostic disable-next-line:no-unknown
   return vim.tbl_map(function(diagnostic)
+    ---@cast diagnostic lsp.Diagnostic
     local start = diagnostic.range.start
     local _end = diagnostic.range['end']
     return {
@@ -94,12 +119,12 @@ local function diagnostic_lsp_to_vim(diagnostics, bufnr, client_id)
       message = diagnostic.message,
       source = diagnostic.source,
       code = diagnostic.code,
+      tags = tags_lsp_to_vim(diagnostic, client_id),
       user_data = {
         lsp = {
           -- usage of user_data.lsp.code is deprecated in favor of the top-level code field
           code = diagnostic.code,
           codeDescription = diagnostic.codeDescription,
-          tags = diagnostic.tags,
           relatedInformation = diagnostic.relatedInformation,
           data = diagnostic.data,
         },
@@ -108,9 +133,13 @@ local function diagnostic_lsp_to_vim(diagnostics, bufnr, client_id)
   end, diagnostics)
 end
 
----@private
+--- @private
+--- @param diagnostics Diagnostic[]
+--- @return lsp.Diagnostic[]
 local function diagnostic_vim_to_lsp(diagnostics)
+  ---@diagnostic disable-next-line:no-unknown
   return vim.tbl_map(function(diagnostic)
+    ---@cast diagnostic Diagnostic
     return vim.tbl_extend('keep', {
       -- "keep" the below fields over any duplicate fields in diagnostic.user_data.lsp
       range = {
@@ -131,6 +160,7 @@ local function diagnostic_vim_to_lsp(diagnostics)
   end, diagnostics)
 end
 
+---@type table<integer,integer>
 local _client_namespaces = {}
 
 --- Get the diagnostic namespace associated with an LSP client |vim.diagnostic|.
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 1686e22c48..f4489ad17d 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -21,6 +21,7 @@ end
 --]=]
 
 local constants = {
+  --- @enum lsp.DiagnosticSeverity
   DiagnosticSeverity = {
     -- Reports an error.
     Error = 1,
@@ -32,6 +33,7 @@ local constants = {
     Hint = 4,
   },
 
+  --- @enum lsp.DiagnosticTag
   DiagnosticTag = {
     -- Unused or unnecessary code
     Unnecessary = 1,
diff --git a/runtime/lua/vim/lsp/types.lua b/runtime/lua/vim/lsp/types.lua
index 1aea6841ee..779f313aa7 100644
--- a/runtime/lua/vim/lsp/types.lua
+++ b/runtime/lua/vim/lsp/types.lua
@@ -18,3 +18,20 @@
 ---@class lsp.FileEvent
 ---@field uri string
 ---@field type lsp.FileChangeType
+
+---@class lsp.Position
+---@field line integer
+---@field character integer
+
+---@class lsp.Range
+---@field start lsp.Position
+---@field end lsp.Position
+
+---@class lsp.Diagnostic
+---@field range lsp.Range
+---@field message string
+---@field severity? lsp.DiagnosticSeverity
+---@field code integer | string
+---@field source string
+---@field tags? lsp.DiagnosticTag[]
+---@field relatedInformation DiagnosticRelatedInformation[]
-- 
cgit 


From 4cff3aceeac2027d82080649ff1c8be9ffa87b90 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 31 Mar 2023 09:43:13 +0100
Subject: fix(loader): disable profiling by default

---
 runtime/lua/vim/loader.lua | 30 ++++++++++++++++++------------
 1 file changed, 18 insertions(+), 12 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index 7b6b9cb563..7ac7f44338 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -438,21 +438,27 @@ function Loader.track(stat, f)
   end
 end
 
-Loader.get_rtp = Loader.track('get_rtp', Loader.get_rtp)
-Loader.read = Loader.track('read', Loader.read)
-Loader.loader = Loader.track('loader', Loader.loader)
-Loader.loader_lib = Loader.track('loader_lib', Loader.loader_lib)
-Loader.loadfile = Loader.track('loadfile', Loader.loadfile)
-Loader.load = Loader.track('load', Loader.load)
-M.find = Loader.track('find', M.find)
-Loader.lsmod = Loader.track('lsmod', Loader.lsmod)
+---@class ProfileOpts
+---@field loaders? boolean Add profiling to the loaders
 
 --- Debug function that wrapps all loaders and tracks stats
 ---@private
-function M._profile_loaders()
-  for l, loader in pairs(loaders) do
-    local loc = debug.getinfo(loader, 'Sn').source:sub(2)
-    loaders[l] = Loader.track('loader ' .. l .. ': ' .. loc, loader)
+---@param opts ProfileOpts?
+function M._profile(opts)
+  Loader.get_rtp = Loader.track('get_rtp', Loader.get_rtp)
+  Loader.read = Loader.track('read', Loader.read)
+  Loader.loader = Loader.track('loader', Loader.loader)
+  Loader.loader_lib = Loader.track('loader_lib', Loader.loader_lib)
+  Loader.loadfile = Loader.track('loadfile', Loader.loadfile)
+  Loader.load = Loader.track('load', Loader.load)
+  M.find = Loader.track('find', M.find)
+  Loader.lsmod = Loader.track('lsmod', Loader.lsmod)
+
+  if opts and opts.loaders then
+    for l, loader in pairs(loaders) do
+      local loc = debug.getinfo(loader, 'Sn').source:sub(2)
+      loaders[l] = Loader.track('loader ' .. l .. ': ' .. loc, loader)
+    end
   end
 end
 
-- 
cgit 


From ed10e4ef60c63d924b9969abdf77adaad506b676 Mon Sep 17 00:00:00 2001
From: Akin <22454918+akinsho@users.noreply.github.com>
Date: Fri, 31 Mar 2023 11:23:19 +0100
Subject: fix(diagnostic): use correct field name for tags (#22835)

LSP tags are added to the diagnostic as "tags" but referred to as "_tags"
in the diagnostic underline handler
---
 runtime/lua/vim/lsp/diagnostic.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index dcc8f6549c..3efa5c51ff 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -119,7 +119,7 @@ local function diagnostic_lsp_to_vim(diagnostics, bufnr, client_id)
       message = diagnostic.message,
       source = diagnostic.source,
       code = diagnostic.code,
-      tags = tags_lsp_to_vim(diagnostic, client_id),
+      _tags = tags_lsp_to_vim(diagnostic, client_id),
       user_data = {
         lsp = {
           -- usage of user_data.lsp.code is deprecated in favor of the top-level code field
-- 
cgit 


From 83bfd94d1df5eecb8e4069a227c7d24598636d63 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 31 Mar 2023 13:05:22 +0100
Subject: refactor(loader): cache hash information

Whenever we run fs_stat() on a path, save this information in the loader
so it can be re-used.

- Loader.loadfile: Remove arguments `hash` as it is no longer needed.

- Loader.loader: Use _G.loadstring instead of Loader.load
  This allows plugins to wrap loadstring to inspection and profiling

- factor out read file logic
---
 runtime/lua/vim/loader.lua | 62 +++++++++++++++++++++++++++++++++-------------
 1 file changed, 45 insertions(+), 17 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index 7ac7f44338..201de18497 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -5,7 +5,7 @@ local loaders = package.loaders
 
 local M = {}
 
----@alias CacheHash {mtime: {sec:number, nsec:number}, size:number}
+---@alias CacheHash {mtime: {sec:number, nsec:number}, size:number, type: string}
 ---@alias CacheEntry {hash:CacheHash, chunk:string}
 
 ---@class ModuleFindOpts
@@ -32,6 +32,8 @@ local Loader = {
   VERSION = 3,
   ---@type table<string, table<string,ModuleInfo>>
   _indexed = {},
+  ---@type table<string, CacheHash>
+  _hashes = {},
   ---@type table<string, string[]>
   _topmods = {},
   _loadfile = loadfile,
@@ -41,6 +43,18 @@ local Loader = {
   },
 }
 
+--- @param path string
+--- @return uv.fs_stat.result
+--- @private
+function Loader.get_hash(path)
+  if not Loader._hashes[path] then
+    -- Note we must never save a stat for a non-existent path.
+    -- For non-existent paths fs_stat() will return nil.
+    Loader._hashes[path] = uv.fs_stat(path)
+  end
+  return Loader._hashes[path]
+end
+
 ---@private
 local function normalize(path)
   return vim.fs.normalize(path, { expand_env = false })
@@ -102,18 +116,28 @@ function Loader.write(name, entry)
   uv.fs_close(f)
 end
 
+--- @param path string
+--- @param mode integer
+--- @return string? data
+--- @private
+local function readfile(path, mode)
+  local f = uv.fs_open(path, 'r', mode)
+  if f then
+    local hash = assert(uv.fs_fstat(f))
+    local data = uv.fs_read(f, hash.size, 0) --[[@as string?]]
+    uv.fs_close(f)
+    return data
+  end
+end
+
 --- Loads the cache entry for a given module or file
 ---@param name string module name or filename
 ---@return CacheEntry?
 ---@private
 function Loader.read(name)
   local cname = Loader.cache_file(name)
-  local f = uv.fs_open(cname, 'r', 438)
-  if f then
-    local hash = uv.fs_fstat(f) --[[@as CacheHash]]
-    local data = uv.fs_read(f, hash.size, 0) --[[@as string]]
-    uv.fs_close(f)
-
+  local data = readfile(cname, 438)
+  if data then
     local zero = data:find('\0', 1, true)
     if not zero then
       return
@@ -141,7 +165,9 @@ end
 function Loader.loader(modname)
   local ret = M.find(modname)[1]
   if ret then
-    local chunk, err = Loader.load(ret.modpath, { hash = ret.stat })
+    -- Make sure to call the global loadfile so we respect any augmentations done elsewhere.
+    -- E.g. profiling
+    local chunk, err = loadfile(ret.modpath)
     return chunk or error(err)
   end
   return '\ncache_loader: module ' .. modname .. ' not found'
@@ -171,17 +197,17 @@ function Loader.loader_lib(modname)
 end
 
 --- `loadfile` using the cache
+--- Note this has the mode and env arguments which is supported by LuaJIT and is 5.1 compatible.
 ---@param filename? string
 ---@param mode? "b"|"t"|"bt"
 ---@param env? table
----@param hash? CacheHash
 ---@return function?, string?  error_message
 ---@private
 -- luacheck: ignore 312
-function Loader.loadfile(filename, mode, env, hash)
+function Loader.loadfile(filename, mode, env)
   -- ignore mode, since we byte-compile the lua source files
   mode = nil
-  return Loader.load(normalize(filename), { mode = mode, env = env, hash = hash })
+  return Loader.load(normalize(filename), { mode = mode, env = env })
 end
 
 --- Checks whether two cache hashes are the same based on:
@@ -201,8 +227,7 @@ end
 
 --- Loads the given module path using the cache
 ---@param modpath string
----@param opts? {hash?: CacheHash, mode?: "b"|"t"|"bt", env?:table} (table|nil) Options for loading the module:
----    - hash: (table) the hash of the file to load if it is already known. (defaults to `vim.loop.fs_stat({modpath})`)
+---@param opts? {mode?: "b"|"t"|"bt", env?:table} (table|nil) Options for loading the module:
 ---    - mode: (string) the mode to load the module with. "b"|"t"|"bt" (defaults to `nil`)
 ---    - env: (table) the environment to load the module in. (defaults to `nil`)
 ---@see |luaL_loadfile()|
@@ -210,7 +235,7 @@ end
 ---@private
 function Loader.load(modpath, opts)
   opts = opts or {}
-  local hash = opts.hash or uv.fs_stat(modpath)
+  local hash = Loader.get_hash(modpath)
   ---@type function?, string?
   local chunk, err
 
@@ -301,7 +326,7 @@ function M.find(modname, opts)
         for _, pattern in ipairs(patterns) do
           local modpath = path .. pattern
           Loader._stats.find.stat = (Loader._stats.find.stat or 0) + 1
-          local hash = uv.fs_stat(modpath)
+          local hash = Loader.get_hash(modpath)
           if hash then
             results[#results + 1] = { modpath = modpath, stat = hash, modname = modname }
             if not continue() then
@@ -337,7 +362,7 @@ function M.find(modname, opts)
   return results
 end
 
---- Resets the topmods cache for the path, or all the paths
+--- Resets the cache for the path, or all the paths
 --- if path is nil.
 ---@param path string? path to reset
 function M.reset(path)
@@ -346,6 +371,9 @@ function M.reset(path)
   else
     Loader._indexed = {}
   end
+
+  -- Path could be a directory so just clear all the hashes.
+  Loader._hashes = {}
 end
 
 --- Enables the experimental Lua module loader:
@@ -399,7 +427,7 @@ function Loader.lsmod(path)
     for name, t in vim.fs.dir(path .. '/lua') do
       local modpath = path .. '/lua/' .. name
       -- HACK: type is not always returned due to a bug in luv
-      t = t or uv.fs_stat(modpath).type
+      t = t or Loader.get_hash(modpath).type
       ---@type string
       local topname
       local ext = name:sub(-4)
-- 
cgit 


From d7f7450017b9b05303698a6cda54303ef22c63b3 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 31 Mar 2023 17:09:00 +0200
Subject: refactor(treesitter)!: rename help parser to vimdoc

---
 runtime/lua/vim/treesitter/language.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index b1c788e6ba..5b74bb6200 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -4,7 +4,9 @@ local a = vim.api
 local M = {}
 
 ---@type table<string,string>
-local ft_to_lang = {}
+local ft_to_lang = {
+  help = 'vimdoc',
+}
 
 --- Get the filetypes associated with the parser named {lang}.
 --- @param lang string Name of parser
-- 
cgit 


From 6a4ebf894fa39bfb09695a129a3300cb99408542 Mon Sep 17 00:00:00 2001
From: Sizhe Zhao <prc.zhao@outlook.com>
Date: Sat, 1 Apr 2023 21:47:20 +0800
Subject: fix(health): stop using deprecated ts.language.inspect_language()
 (#22850)

---
 runtime/lua/vim/treesitter/health.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/health.lua b/runtime/lua/vim/treesitter/health.lua
index fd1188fde4..dabf2cdf6c 100644
--- a/runtime/lua/vim/treesitter/health.lua
+++ b/runtime/lua/vim/treesitter/health.lua
@@ -22,7 +22,7 @@ function M.check()
         )
       )
     else
-      local lang = ts.language.inspect_language(parsername)
+      local lang = ts.language.inspect(parsername)
       health.report_ok(
         string.format('Parser: %-10s ABI: %d, path: %s', parsername, lang._abi_version, parser)
       )
-- 
cgit 


From 643c0ed571f1ac6e83f73ab2593132901278b4da Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Sat, 1 Apr 2023 08:02:58 -0600
Subject: feat: allow function passed to defaulttable to take an argument
 (#22839)

Pass the value of the key being accessed to the create function, to
allow users to dynamically generate default values.
---
 runtime/lua/vim/shared.lua | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 884929e33a..9e337e93e8 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -796,13 +796,15 @@ end
 --- a.b.c = 1
 --- </pre>
 ---
----@param create function|nil The function called to create a missing value.
+---@param create function?(key:any):any The function called to create a missing value.
 ---@return table Empty table with metamethod
 function vim.defaulttable(create)
-  create = create or vim.defaulttable
+  create = create or function(_)
+    return vim.defaulttable()
+  end
   return setmetatable({}, {
     __index = function(tbl, key)
-      rawset(tbl, key, create())
+      rawset(tbl, key, create(key))
       return rawget(tbl, key)
     end,
   })
-- 
cgit 


From a93024555720325ecede9d2d15e4bd0f1fd82739 Mon Sep 17 00:00:00 2001
From: Luuk van Baal <luukvbaal@gmail.com>
Date: Sat, 25 Mar 2023 15:19:22 +0100
Subject: refactor(lua): get all marks instead of iterating over namespaces

Inspector now also includes highlights set in anonymous namespaces.

Close #22732
---
 runtime/lua/vim/_inspector.lua | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_inspector.lua b/runtime/lua/vim/_inspector.lua
index 92d380b08c..05983d3f0d 100644
--- a/runtime/lua/vim/_inspector.lua
+++ b/runtime/lua/vim/_inspector.lua
@@ -81,6 +81,12 @@ function vim.inspect_pos(bufnr, row, col, filter)
     end
   end
 
+  -- namespace id -> name map
+  local nsmap = {}
+  for name, id in pairs(vim.api.nvim_get_namespaces()) do
+    nsmap[id] = name
+  end
+
   --- Convert an extmark tuple into a map-like table
   --- @private
   local function to_map(extmark)
@@ -90,6 +96,8 @@ function vim.inspect_pos(bufnr, row, col, filter)
       col = extmark[3],
       opts = resolve_hl(extmark[4]),
     }
+    extmark.ns_id = extmark.opts.ns_id
+    extmark.ns = nsmap[extmark.ns_id] or ''
     extmark.end_row = extmark.opts.end_row or extmark.row -- inclusive
     extmark.end_col = extmark.opts.end_col or (extmark.col + 1) -- exclusive
     return extmark
@@ -104,17 +112,9 @@ function vim.inspect_pos(bufnr, row, col, filter)
   end
 
   -- all extmarks at this position
-  local extmarks = {}
-  for ns, nsid in pairs(vim.api.nvim_get_namespaces()) do
-    local ns_marks = vim.api.nvim_buf_get_extmarks(bufnr, nsid, 0, -1, { details = true })
-    ns_marks = vim.tbl_map(to_map, ns_marks)
-    ns_marks = vim.tbl_filter(is_here, ns_marks)
-    for _, mark in ipairs(ns_marks) do
-      mark.ns_id = nsid
-      mark.ns = ns
-    end
-    vim.list_extend(extmarks, ns_marks)
-  end
+  local extmarks = vim.api.nvim_buf_get_extmarks(bufnr, -1, 0, -1, { details = true })
+  extmarks = vim.tbl_map(to_map, extmarks)
+  extmarks = vim.tbl_filter(is_here, extmarks)
 
   if filter.semantic_tokens then
     results.semantic_tokens = vim.tbl_filter(function(extmark)
-- 
cgit 


From e30cc8be1950a6d1dec7395807966e1b5d0d9194 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Mon, 3 Apr 2023 16:27:49 +0200
Subject: vim-patch:9.0.1438: .fs files are falsely recognized as forth files
 (#22871)

Problem:    .fs files are falsely recognized as forth files.
Solution:   Check 100 lines for something that looks like forth. (Johan
            Kotlinski, closes vim/vim#12219, closes vim/vim#11988)

https://github.com/vim/vim/commit/065088d5549e7711668321cc5a77c9a9b684b142

Co-authored-by: Johan Kotlinski <kotlinski@gmail.com>
---
 runtime/lua/vim/filetype/detect.lua | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index b3d9fedeae..d1eabadc4a 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -473,12 +473,12 @@ function M.fs(bufnr)
   if vim.g.filetype_fs then
     return vim.g.filetype_fs
   end
-  local line = nextnonblank(bufnr, 1)
-  if findany(line, { '^%s*%.?%( ', '^%s*\\G? ', '^\\$', '^%s*: %S' }) then
-    return 'forth'
-  else
-    return 'fsharp'
+  for _, line in ipairs(getlines(bufnr, 1, 100)) do
+    if line:find('^[:(\\] ') then
+      return 'forth'
+    end
   end
+  return 'fsharp'
 end
 
 function M.git(bufnr)
-- 
cgit 


From 469e6bfc56aa18350bfab13bef8a51b02a5b3c65 Mon Sep 17 00:00:00 2001
From: danilax999 <75566563+danilax999@users.noreply.github.com>
Date: Tue, 4 Apr 2023 14:26:21 +0300
Subject: fix(treesitter): use capture metadata range if exists

use `treesitter.get_range` instead of inline expression
---
 runtime/lua/vim/treesitter/highlighter.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index 729cd34090..d3cc1b698c 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -236,7 +236,8 @@ local function on_line_impl(self, buf, line, is_spell_nav)
         break
       end
 
-      local start_row, start_col, end_row, end_col = node:range()
+      local range = vim.treesitter.get_range(node, buf, metadata[capture])
+      local start_row, start_col, _, end_row, end_col, _ = unpack(range)
       local hl = highlighter_query.hl_cache[capture]
 
       local capture_name = highlighter_query:query().captures[capture]
-- 
cgit 


From 090ade4af6344a7bc4ee56a8052c0739c0428c04 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 4 Apr 2023 12:58:16 +0100
Subject: refactor(treesitter): delegate region calculation to treesitter
 (#22576)

---
 runtime/lua/vim/treesitter/languagetree.lua | 94 ++++++++++++-----------------
 1 file changed, 38 insertions(+), 56 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 922e4881ca..cf0ecbd839 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -57,7 +57,9 @@ local Range = require('vim.treesitter._range')
 ---@field private _injection_query Query Queries defining injected languages
 ---@field private _opts table Options
 ---@field private _parser TSParser Parser for language
----@field private _regions Range6[][] List of regions this tree should manage and parse
+---@field private _regions Range6[][]?
+---List of regions this tree should manage and parse. If nil then regions are
+---taken from _trees. This is mostly a short-lived cache for included_regions()
 ---@field private _lang string Language name
 ---@field private _source (integer|string) Buffer or string to parse
 ---@field private _trees TSTree[] Reference to parsed tree (one for each language)
@@ -91,7 +93,6 @@ function LanguageTree.new(source, lang, opts)
     _source = source,
     _lang = lang,
     _children = {},
-    _regions = {},
     _trees = {},
     _opts = opts,
     _injection_query = injections[lang] and query.parse(lang, injections[lang])
@@ -237,27 +238,21 @@ function LanguageTree:parse()
 
   --- At least 1 region is invalid
   if not self:is_valid(true) then
-    local function _parsetree(index)
-      local parse_time, tree, tree_changes =
-        tcall(self._parser.parse, self._parser, self._trees[index], self._source)
-
-      self:_do_callback('changedtree', tree_changes, tree)
-      self._trees[index] = tree
-      vim.list_extend(changes, tree_changes)
-
-      total_parse_time = total_parse_time + parse_time
-      regions_parsed = regions_parsed + 1
-    end
-
-    if #self._regions > 0 then
-      for i, ranges in ipairs(self._regions) do
-        if not self._valid or not self._valid[i] then
-          self._parser:set_included_ranges(ranges)
-          _parsetree(i)
-        end
+    -- If there are no ranges, set to an empty list
+    -- so the included ranges in the parser are cleared.
+    for i, ranges in ipairs(self:included_regions()) do
+      if not self._valid or not self._valid[i] then
+        self._parser:set_included_ranges(ranges)
+        local parse_time, tree, tree_changes =
+          tcall(self._parser.parse, self._parser, self._trees[i], self._source)
+
+        self:_do_callback('changedtree', tree_changes, tree)
+        self._trees[i] = tree
+        vim.list_extend(changes, tree_changes)
+
+        total_parse_time = total_parse_time + parse_time
+        regions_parsed = regions_parsed + 1
       end
-    else
-      _parsetree(1)
     end
   end
 
@@ -403,7 +398,7 @@ function LanguageTree:_iter_regions(fn)
 
   local all_valid = true
 
-  for i, region in ipairs(self._regions) do
+  for i, region in ipairs(self:included_regions()) do
     if self._valid[i] == nil then
       self._valid[i] = true
     end
@@ -454,7 +449,7 @@ function LanguageTree:set_included_regions(new_regions)
     end
   end
 
-  if #self._regions ~= #new_regions then
+  if #self:included_regions() ~= #new_regions then
     self._trees = {}
     self:invalidate()
   else
@@ -462,13 +457,28 @@ function LanguageTree:set_included_regions(new_regions)
       return vim.deep_equal(new_regions[i], region)
     end)
   end
+
   self._regions = new_regions
 end
 
 ---Gets the set of included regions
 ---@return integer[][]
 function LanguageTree:included_regions()
-  return self._regions
+  if self._regions then
+    return self._regions
+  end
+
+  if #self._trees == 0 then
+    return { {} }
+  end
+
+  local regions = {} ---@type Range6[][]
+  for i, _ in ipairs(self._trees) do
+    regions[i] = self._trees[i]:included_ranges(true)
+  end
+
+  self._regions = regions
+  return regions
 end
 
 ---@private
@@ -721,6 +731,8 @@ function LanguageTree:_edit(
     )
   end
 
+  self._regions = nil
+
   local changed_range = {
     start_row,
     start_col,
@@ -730,42 +742,12 @@ function LanguageTree:_edit(
     end_byte_old,
   }
 
-  local new_range = {
-    start_row,
-    start_col,
-    start_byte,
-    end_row_new,
-    end_col_new,
-    end_byte_new,
-  }
-
-  if #self._regions == 0 then
-    self._valid = false
-  end
-
   -- Validate regions after editing the tree
   self:_iter_regions(function(_, region)
-    for i, r in ipairs(region) do
+    for _, r in ipairs(region) do
       if Range.intercepts(r, changed_range) then
         return false
       end
-
-      -- Range after change. Adjust
-      if Range.cmp_pos.gt(r[1], r[2], changed_range[4], changed_range[5]) then
-        local byte_offset = new_range[6] - changed_range[6]
-        local row_offset = new_range[4] - changed_range[4]
-
-        -- Update the range to avoid invalidation in set_included_regions()
-        -- which will compare the regions against the parsed injection regions
-        region[i] = {
-          r[1] + row_offset,
-          r[2],
-          r[3] + byte_offset,
-          r[4] + row_offset,
-          r[5],
-          r[6] + byte_offset,
-        }
-      end
     end
     return true
   end)
-- 
cgit 


From b75acd2f94feac5b55eaa219e7beb2af93f15cf0 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 4 Apr 2023 13:07:27 +0100
Subject: fix(treesitter): disable folding in inspect_tree() (#22885)

---
 runtime/lua/vim/treesitter.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 2594c1672d..44bf4c9e20 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -538,6 +538,7 @@ function M.inspect_tree(opts)
 
   vim.wo[w].scrolloff = 5
   vim.wo[w].wrap = false
+  vim.wo[w].foldmethod = 'manual' -- disable folding
   vim.bo[b].buflisted = false
   vim.bo[b].buftype = 'nofile'
   vim.bo[b].bufhidden = 'wipe'
-- 
cgit 


From a5c572bd446a89be2dccb2f7479ff1b017074640 Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Tue, 4 Apr 2023 19:07:33 +0200
Subject: docs: fix typos

Co-authored-by: Gregory Anders <greg@gpanders.com>
Co-authored-by: Raphael <glephunter@gmail.com>
Co-authored-by: C.D. MacEachern <craig.daniel.maceachern@gmail.com>
Co-authored-by: himanoa <matsunoappy@gmail.com>
---
 runtime/lua/vim/loader.lua           | 4 ++--
 runtime/lua/vim/shared.lua           | 2 +-
 runtime/lua/vim/treesitter/_fold.lua | 2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index 201de18497..38b1e9fc0f 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -11,7 +11,7 @@ local M = {}
 ---@class ModuleFindOpts
 ---@field all? boolean Search for all matches (defaults to `false`)
 ---@field rtp? boolean Search for modname in the runtime path (defaults to `true`)
----@field patterns? string[] Paterns to use (defaults to `{"/init.lua", ".lua"}`)
+---@field patterns? string[] Patterns to use (defaults to `{"/init.lua", ".lua"}`)
 ---@field paths? string[] Extra paths to search for modname
 
 ---@class ModuleInfo
@@ -469,7 +469,7 @@ end
 ---@class ProfileOpts
 ---@field loaders? boolean Add profiling to the loaders
 
---- Debug function that wrapps all loaders and tracks stats
+--- Debug function that wraps all loaders and tracks stats
 ---@private
 ---@param opts ProfileOpts?
 function M._profile(opts)
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 9e337e93e8..eb734fb512 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -655,7 +655,7 @@ end
 ---  vim.validate{arg1={{'foo'}, {'table', 'string'}}, arg2={'foo', {'table', 'string'}}}
 ---     --> NOP (success)
 ---
----  vim.validate{arg1={1, {'string', table'}}}
+---  vim.validate{arg1={1, {'string', 'table'}}}
 ---     --> error('arg1: expected string|table, got number')
 ---
 --- </pre>
diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index 6547ab936e..7df93d1b2e 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -68,7 +68,7 @@ function FoldInfo:add_stop(lnum)
   self.stop_counts[lnum] = (self.stop_counts[lnum] or 0) + 1
 end
 
----@packag
+---@package
 ---@param lnum integer
 ---@return integer
 function FoldInfo:get_start(lnum)
-- 
cgit 


From b1de4820b7b1a527f4d0cf9a20192d92bea1d9c4 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sat, 1 Apr 2023 12:55:04 +0100
Subject: refactor(treesitter): move inspect_tree impl

---
 runtime/lua/vim/treesitter.lua            | 205 +--------------------------
 runtime/lua/vim/treesitter/playground.lua | 225 +++++++++++++++++++++++++++++-
 2 files changed, 226 insertions(+), 204 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 44bf4c9e20..092fdf0ae2 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -502,209 +502,8 @@ end
 ---                        function, it accepts the buffer number of the source buffer as its only
 ---                        argument and should return a string.
 function M.inspect_tree(opts)
-  vim.validate({
-    opts = { opts, 't', true },
-  })
-
-  opts = opts or {}
-
-  local Playground = require('vim.treesitter.playground')
-  local buf = a.nvim_get_current_buf()
-  local win = a.nvim_get_current_win()
-  local pg = assert(Playground:new(buf, opts.lang))
-
-  -- Close any existing playground window
-  if vim.b[buf].playground then
-    local w = vim.b[buf].playground
-    if a.nvim_win_is_valid(w) then
-      a.nvim_win_close(w, true)
-    end
-  end
-
-  local w = opts.winid
-  if not w then
-    vim.cmd(opts.command or '60vnew')
-    w = a.nvim_get_current_win()
-  end
-
-  local b = opts.bufnr
-  if b then
-    a.nvim_win_set_buf(w, b)
-  else
-    b = a.nvim_win_get_buf(w)
-  end
-
-  vim.b[buf].playground = w
-
-  vim.wo[w].scrolloff = 5
-  vim.wo[w].wrap = false
-  vim.wo[w].foldmethod = 'manual' -- disable folding
-  vim.bo[b].buflisted = false
-  vim.bo[b].buftype = 'nofile'
-  vim.bo[b].bufhidden = 'wipe'
-  vim.bo[b].filetype = 'query'
-
-  local title = opts.title
-  if not title then
-    local bufname = a.nvim_buf_get_name(buf)
-    title = string.format('Syntax tree for %s', vim.fn.fnamemodify(bufname, ':.'))
-  elseif type(title) == 'function' then
-    title = title(buf)
-  end
-
-  assert(type(title) == 'string', 'Window title must be a string')
-  a.nvim_buf_set_name(b, title)
-
-  pg:draw(b)
-
-  a.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
-  a.nvim_buf_set_keymap(b, 'n', '<CR>', '', {
-    desc = 'Jump to the node under the cursor in the source buffer',
-    callback = function()
-      local row = a.nvim_win_get_cursor(w)[1]
-      local pos = pg:get(row)
-      a.nvim_set_current_win(win)
-      a.nvim_win_set_cursor(win, { pos.lnum + 1, pos.col })
-    end,
-  })
-  a.nvim_buf_set_keymap(b, 'n', 'a', '', {
-    desc = 'Toggle anonymous nodes',
-    callback = function()
-      local row, col = unpack(a.nvim_win_get_cursor(w))
-      local curnode = pg:get(row)
-      while curnode and not curnode.named do
-        row = row - 1
-        curnode = pg:get(row)
-      end
-
-      pg.opts.anon = not pg.opts.anon
-      pg:draw(b)
-
-      if not curnode then
-        return
-      end
-
-      local id = curnode.id
-      for i, node in pg:iter() do
-        if node.id == id then
-          a.nvim_win_set_cursor(w, { i, col })
-          break
-        end
-      end
-    end,
-  })
-  a.nvim_buf_set_keymap(b, 'n', 'I', '', {
-    desc = 'Toggle language display',
-    callback = function()
-      pg.opts.lang = not pg.opts.lang
-      pg:draw(b)
-    end,
-  })
-
-  local group = a.nvim_create_augroup('treesitter/playground', {})
-
-  a.nvim_create_autocmd('CursorMoved', {
-    group = group,
-    buffer = b,
-    callback = function()
-      a.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
-      local row = a.nvim_win_get_cursor(w)[1]
-      local pos = pg:get(row)
-      a.nvim_buf_set_extmark(buf, pg.ns, pos.lnum, pos.col, {
-        end_row = pos.end_lnum,
-        end_col = math.max(0, pos.end_col),
-        hl_group = 'Visual',
-      })
-
-      local topline, botline = vim.fn.line('w0', win), vim.fn.line('w$', win)
-
-      -- Move the cursor if highlighted range is completely out of view
-      if pos.lnum < topline and pos.end_lnum < topline then
-        a.nvim_win_set_cursor(win, { pos.end_lnum + 1, 0 })
-      elseif pos.lnum > botline and pos.end_lnum > botline then
-        a.nvim_win_set_cursor(win, { pos.lnum + 1, 0 })
-      end
-    end,
-  })
-
-  a.nvim_create_autocmd('CursorMoved', {
-    group = group,
-    buffer = buf,
-    callback = function()
-      if not a.nvim_buf_is_loaded(b) then
-        return true
-      end
-
-      a.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
-
-      local cursor_node = M.get_node({
-        bufnr = buf,
-        lang = opts.lang,
-        ignore_injections = false,
-      })
-      if not cursor_node then
-        return
-      end
-
-      local cursor_node_id = cursor_node:id()
-      for i, v in pg:iter() do
-        if v.id == cursor_node_id then
-          local start = v.depth
-          local end_col = start + #v.text
-          a.nvim_buf_set_extmark(b, pg.ns, i - 1, start, {
-            end_col = end_col,
-            hl_group = 'Visual',
-          })
-          a.nvim_win_set_cursor(w, { i, 0 })
-          break
-        end
-      end
-    end,
-  })
-
-  a.nvim_create_autocmd({ 'TextChanged', 'InsertLeave' }, {
-    group = group,
-    buffer = buf,
-    callback = function()
-      if not a.nvim_buf_is_loaded(b) then
-        return true
-      end
-
-      pg = assert(Playground:new(buf, opts.lang))
-      pg:draw(b)
-    end,
-  })
-
-  a.nvim_create_autocmd('BufLeave', {
-    group = group,
-    buffer = b,
-    callback = function()
-      a.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
-    end,
-  })
-
-  a.nvim_create_autocmd('BufLeave', {
-    group = group,
-    buffer = buf,
-    callback = function()
-      if not a.nvim_buf_is_loaded(b) then
-        return true
-      end
-
-      a.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
-    end,
-  })
-
-  a.nvim_create_autocmd('BufHidden', {
-    group = group,
-    buffer = buf,
-    once = true,
-    callback = function()
-      if a.nvim_win_is_valid(w) then
-        a.nvim_win_close(w, true)
-      end
-    end,
-  })
+  ---@cast opts InspectTreeOpts
+  require('vim.treesitter.playground').inspect_tree(opts)
 end
 
 --- Returns the fold level for {lnum} in the current buffer. Can be set directly to 'foldexpr':
diff --git a/runtime/lua/vim/treesitter/playground.lua b/runtime/lua/vim/treesitter/playground.lua
index 35f06f5caf..7eead14579 100644
--- a/runtime/lua/vim/treesitter/playground.lua
+++ b/runtime/lua/vim/treesitter/playground.lua
@@ -1,5 +1,8 @@
 local api = vim.api
 
+---@class TSPlaygroundModule
+local M = {}
+
 ---@class TSPlayground
 ---@field ns integer API namespace
 ---@field opts table Options table with the following keys:
@@ -212,4 +215,224 @@ function TSPlayground:iter()
   return ipairs(self.opts.anon and self.nodes or self.named)
 end
 
-return TSPlayground
+--- @class InspectTreeOpts
+--- @field lang string? The language of the source buffer. If omitted, the
+---                     filetype of the source buffer is used.
+--- @field bufnr integer? Buffer to draw the tree into. If omitted, a new
+---                       buffer is created.
+--- @field winid integer? Window id to display the tree buffer in. If omitted,
+---                       a new window is created with {command}.
+--- @field command string? Vimscript command to create the window. Default
+---                       value is "60vnew". Only used when {winid} is nil.
+--- @field title (string|fun(bufnr:integer):string|nil) Title of the window. If a
+---                       function, it accepts the buffer number of the source
+---                       buffer as its only argument and should return a string.
+
+--- @param opts InspectTreeOpts
+function M.inspect_tree(opts)
+  vim.validate({
+    opts = { opts, 't', true },
+  })
+
+  opts = opts or {}
+
+  local buf = api.nvim_get_current_buf()
+  local win = api.nvim_get_current_win()
+  local pg = assert(TSPlayground:new(buf, opts.lang))
+
+  -- Close any existing playground window
+  if vim.b[buf].playground then
+    local w = vim.b[buf].playground
+    if api.nvim_win_is_valid(w) then
+      api.nvim_win_close(w, true)
+    end
+  end
+
+  local w = opts.winid
+  if not w then
+    vim.cmd(opts.command or '60vnew')
+    w = api.nvim_get_current_win()
+  end
+
+  local b = opts.bufnr
+  if b then
+    api.nvim_win_set_buf(w, b)
+  else
+    b = api.nvim_win_get_buf(w)
+  end
+
+  vim.b[buf].playground = w
+
+  vim.wo[w].scrolloff = 5
+  vim.wo[w].wrap = false
+  vim.wo[w].foldmethod = 'manual'  -- disable folding
+  vim.bo[b].buflisted = false
+  vim.bo[b].buftype = 'nofile'
+  vim.bo[b].bufhidden = 'wipe'
+  vim.bo[b].filetype = 'query'
+
+  local title --- @type string?
+  local opts_title = opts.title
+  if not opts_title then
+    local bufname = api.nvim_buf_get_name(buf)
+    title = string.format('Syntax tree for %s', vim.fn.fnamemodify(bufname, ':.'))
+  elseif type(opts_title) == 'function' then
+    title = opts_title(buf)
+  end
+
+  assert(type(title) == 'string', 'Window title must be a string')
+  api.nvim_buf_set_name(b, title)
+
+  pg:draw(b)
+
+  api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
+  api.nvim_buf_set_keymap(b, 'n', '<CR>', '', {
+    desc = 'Jump to the node under the cursor in the source buffer',
+    callback = function()
+      local row = api.nvim_win_get_cursor(w)[1]
+      local pos = pg:get(row)
+      api.nvim_set_current_win(win)
+      api.nvim_win_set_cursor(win, { pos.lnum + 1, pos.col })
+    end,
+  })
+  api.nvim_buf_set_keymap(b, 'n', 'a', '', {
+    desc = 'Toggle anonymous nodes',
+    callback = function()
+      local row, col = unpack(api.nvim_win_get_cursor(w))
+      local curnode = pg:get(row)
+      while curnode and not curnode.named do
+        row = row - 1
+        curnode = pg:get(row)
+      end
+
+      pg.opts.anon = not pg.opts.anon
+      pg:draw(b)
+
+      if not curnode then
+        return
+      end
+
+      local id = curnode.id
+      for i, node in pg:iter() do
+        if node.id == id then
+          api.nvim_win_set_cursor(w, { i, col })
+          break
+        end
+      end
+    end,
+  })
+  api.nvim_buf_set_keymap(b, 'n', 'I', '', {
+    desc = 'Toggle language display',
+    callback = function()
+      pg.opts.lang = not pg.opts.lang
+      pg:draw(b)
+    end,
+  })
+
+  local group = api.nvim_create_augroup('treesitter/playground', {})
+
+  api.nvim_create_autocmd('CursorMoved', {
+    group = group,
+    buffer = b,
+    callback = function()
+      api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
+      local row = api.nvim_win_get_cursor(w)[1]
+      local pos = pg:get(row)
+      api.nvim_buf_set_extmark(buf, pg.ns, pos.lnum, pos.col, {
+        end_row = pos.end_lnum,
+        end_col = math.max(0, pos.end_col),
+        hl_group = 'Visual',
+      })
+
+      local topline, botline = vim.fn.line('w0', win), vim.fn.line('w$', win)
+
+      -- Move the cursor if highlighted range is completely out of view
+      if pos.lnum < topline and pos.end_lnum < topline then
+        api.nvim_win_set_cursor(win, { pos.end_lnum + 1, 0 })
+      elseif pos.lnum > botline and pos.end_lnum > botline then
+        api.nvim_win_set_cursor(win, { pos.lnum + 1, 0 })
+      end
+    end,
+  })
+
+  api.nvim_create_autocmd('CursorMoved', {
+    group = group,
+    buffer = buf,
+    callback = function()
+      if not api.nvim_buf_is_loaded(b) then
+        return true
+      end
+
+      api.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
+
+      local cursor_node = vim.treesitter.get_node({
+        bufnr = buf,
+        lang = opts.lang,
+        ignore_injections = false,
+      })
+      if not cursor_node then
+        return
+      end
+
+      local cursor_node_id = cursor_node:id()
+      for i, v in pg:iter() do
+        if v.id == cursor_node_id then
+          local start = v.depth
+          local end_col = start + #v.text
+          api.nvim_buf_set_extmark(b, pg.ns, i - 1, start, {
+            end_col = end_col,
+            hl_group = 'Visual',
+          })
+          api.nvim_win_set_cursor(w, { i, 0 })
+          break
+        end
+      end
+    end,
+  })
+
+  api.nvim_create_autocmd({ 'TextChanged', 'InsertLeave' }, {
+    group = group,
+    buffer = buf,
+    callback = function()
+      if not api.nvim_buf_is_loaded(b) then
+        return true
+      end
+
+      pg = assert(TSPlayground:new(buf, opts.lang))
+      pg:draw(b)
+    end,
+  })
+
+  api.nvim_create_autocmd('BufLeave', {
+    group = group,
+    buffer = b,
+    callback = function()
+      api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
+    end,
+  })
+
+  api.nvim_create_autocmd('BufLeave', {
+    group = group,
+    buffer = buf,
+    callback = function()
+      if not api.nvim_buf_is_loaded(b) then
+        return true
+      end
+
+      api.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
+    end,
+  })
+
+  api.nvim_create_autocmd('BufHidden', {
+    group = group,
+    buffer = buf,
+    once = true,
+    callback = function()
+      if api.nvim_win_is_valid(w) then
+        api.nvim_win_close(w, true)
+      end
+    end,
+  })
+end
+
+return M
-- 
cgit 


From 743860de40502227b3f0ed64317eb937d24d4a36 Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Tue, 4 Apr 2023 21:59:06 +0200
Subject: test: replace lfs with luv and vim.fs

test: replace lfs with luv

luv already pretty much does everything lfs does, so this duplication
of dependencies isn't needed.
---
 runtime/lua/vim/_editor.lua        | 1 -
 runtime/lua/vim/_init_packages.lua | 1 +
 2 files changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 0c4b634f6f..fa0980563a 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -36,7 +36,6 @@ for k, v in pairs({
   keymap = true,
   ui = true,
   health = true,
-  fs = true,
   secure = true,
   _watch = true,
 }) do
diff --git a/runtime/lua/vim/_init_packages.lua b/runtime/lua/vim/_init_packages.lua
index 57c0fc9122..2cf2e91a8c 100644
--- a/runtime/lua/vim/_init_packages.lua
+++ b/runtime/lua/vim/_init_packages.lua
@@ -54,6 +54,7 @@ require('vim.shared')
 vim._submodules = {
   inspect = true,
   version = true,
+  fs = true,
 }
 
 -- These are for loading runtime modules in the vim namespace lazily.
-- 
cgit 


From e826d09c18ab8840592b6cdbbcfe3e311a047174 Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Tue, 4 Apr 2023 23:37:46 +0200
Subject: fix(windows): consistent normalization in fs.find

vim.fs.find(".luacheckrc")

```
c:\\projects\\neovim/.luacheckrc # before

c:/projects/neovim/.luacheckrc   # after
```

Co-authored-by: kylo252 <59826753+kylo252@users.noreply.github.com>
---
 runtime/lua/vim/fs.lua                    | 2 +-
 runtime/lua/vim/treesitter/playground.lua | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index 407b334f20..2a51bde263 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -216,7 +216,7 @@ function M.find(names, opts)
 
   ---@private
   local function add(match)
-    matches[#matches + 1] = match
+    matches[#matches + 1] = M.normalize(match)
     if #matches == limit then
       return true
     end
diff --git a/runtime/lua/vim/treesitter/playground.lua b/runtime/lua/vim/treesitter/playground.lua
index 7eead14579..2c0a0d1aa6 100644
--- a/runtime/lua/vim/treesitter/playground.lua
+++ b/runtime/lua/vim/treesitter/playground.lua
@@ -265,7 +265,7 @@ function M.inspect_tree(opts)
 
   vim.wo[w].scrolloff = 5
   vim.wo[w].wrap = false
-  vim.wo[w].foldmethod = 'manual'  -- disable folding
+  vim.wo[w].foldmethod = 'manual' -- disable folding
   vim.bo[b].buflisted = false
   vim.bo[b].buftype = 'nofile'
   vim.bo[b].bufhidden = 'wipe'
-- 
cgit 


From 999cb36c2bb64d1f93bb6f8e607e0eb26eadcd63 Mon Sep 17 00:00:00 2001
From: Michal Liszcz <liszcz.michal@gmail.com>
Date: Wed, 5 Apr 2023 14:02:08 +0200
Subject: refactor(lsp): do not parse verbose output when overwriting options
 (#22810)

---
 runtime/lua/vim/lsp.lua | 17 ++++++-----------
 1 file changed, 6 insertions(+), 11 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 7e8c73ddb6..2d39f2d45d 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1101,21 +1101,16 @@ function lsp.start_client(config)
       return true
     end
 
-    local last_set_from = vim.fn.gettext('\n\tLast set from ')
-    local line = vim.fn.gettext(' line ')
-    local scriptname
-
-    vim.api.nvim_buf_call(bufnr, function()
-      scriptname = vim.fn
-        .execute('verbose set ' .. option .. '?')
-        :match(last_set_from .. '(.*)' .. line .. '%d+')
-    end)
+    local info = vim.api.nvim_get_option_info2(option, { buf = bufnr })
+    local scriptinfo = vim.tbl_filter(function(e)
+      return e.sid == info.last_set_sid
+    end, vim.fn.getscriptinfo())
 
-    if not scriptname then
+    if #scriptinfo ~= 1 then
       return false
     end
 
-    return vim.startswith(vim.fn.expand(scriptname), vim.fn.expand('$VIMRUNTIME'))
+    return vim.startswith(scriptinfo[1].name, vim.fn.expand('$VIMRUNTIME'))
   end
 
   ---@private
-- 
cgit 


From 34ac75b32927328a0c691c5bda987c0fdb5ce9eb Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 5 Apr 2023 17:19:53 +0100
Subject: refactor: rename local API alias from a to api

Problem:
  Codebase inconsistently binds vim.api onto a or api.

Solution:
  Use api everywhere. a as an identifier is too short to have at the
  module level.
---
 runtime/lua/vim/_meta.lua                   | 20 +++++++++----------
 runtime/lua/vim/treesitter.lua              | 30 ++++++++++++++---------------
 runtime/lua/vim/treesitter/highlighter.lua  | 18 ++++++++---------
 runtime/lua/vim/treesitter/language.lua     |  4 ++--
 runtime/lua/vim/treesitter/languagetree.lua | 12 ++++++------
 runtime/lua/vim/treesitter/query.lua        |  8 ++++----
 6 files changed, 46 insertions(+), 46 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta.lua b/runtime/lua/vim/_meta.lua
index 104f29c4c0..e3ad4d76c9 100644
--- a/runtime/lua/vim/_meta.lua
+++ b/runtime/lua/vim/_meta.lua
@@ -1,4 +1,4 @@
-local a = vim.api
+local api = vim.api
 
 -- TODO(tjdevries): Improve option metadata so that this doesn't have to be hardcoded.
 --                  Can be done in a separate PR.
@@ -30,7 +30,7 @@ end
 
 local options_info = setmetatable({}, {
   __index = function(t, k)
-    local info = a.nvim_get_option_info(k)
+    local info = api.nvim_get_option_info(k)
     info.metatype = get_option_metatype(k, info)
     rawset(t, k, info)
     return rawget(t, k)
@@ -74,12 +74,12 @@ local function new_opt_accessor(handle, scope)
         return new_opt_accessor(k, scope)
       end
       opt_validate(k, scope)
-      return a.nvim_get_option_value(k, { [scope] = handle or 0 })
+      return api.nvim_get_option_value(k, { [scope] = handle or 0 })
     end,
 
     __newindex = function(_, k, v)
       opt_validate(k, scope)
-      return a.nvim_set_option_value(k, v, { [scope] = handle or 0 })
+      return api.nvim_set_option_value(k, v, { [scope] = handle or 0 })
     end,
   })
 end
@@ -91,10 +91,10 @@ vim.wo = new_opt_accessor(nil, 'win')
 --  this ONLY sets the global option. like `setglobal`
 vim.go = setmetatable({}, {
   __index = function(_, k)
-    return a.nvim_get_option_value(k, { scope = 'global' })
+    return api.nvim_get_option_value(k, { scope = 'global' })
   end,
   __newindex = function(_, k, v)
-    return a.nvim_set_option_value(k, v, { scope = 'global' })
+    return api.nvim_set_option_value(k, v, { scope = 'global' })
   end,
 })
 
@@ -102,10 +102,10 @@ vim.go = setmetatable({}, {
 --  it has no additional metamethod magic.
 vim.o = setmetatable({}, {
   __index = function(_, k)
-    return a.nvim_get_option_value(k, {})
+    return api.nvim_get_option_value(k, {})
   end,
   __newindex = function(_, k, v)
-    return a.nvim_set_option_value(k, v, {})
+    return api.nvim_set_option_value(k, v, {})
   end,
 })
 
@@ -488,7 +488,7 @@ local function create_option_accessor(scope)
     --  opt[my_option] = value
     _set = function(self)
       local value = convert_value_to_vim(self._name, self._info, self._value)
-      a.nvim_set_option_value(self._name, value, { scope = scope })
+      api.nvim_set_option_value(self._name, value, { scope = scope })
     end,
 
     get = function(self)
@@ -526,7 +526,7 @@ local function create_option_accessor(scope)
 
   return setmetatable({}, {
     __index = function(_, k)
-      return make_option(k, a.nvim_get_option_value(k, {}))
+      return make_option(k, api.nvim_get_option_value(k, {}))
     end,
 
     __newindex = function(_, k, v)
diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 092fdf0ae2..d1f5996768 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -1,4 +1,4 @@
-local a = vim.api
+local api = vim.api
 local LanguageTree = require('vim.treesitter.languagetree')
 local Range = require('vim.treesitter._range')
 
@@ -80,7 +80,7 @@ function M._create_parser(bufnr, lang, opts)
 
   local source = self:source() --[[@as integer]]
 
-  a.nvim_buf_attach(
+  api.nvim_buf_attach(
     source,
     false,
     { on_bytes = bytes_cb, on_detach = detach_cb, on_reload = reload_cb, preview = true }
@@ -109,7 +109,7 @@ function M.get_parser(bufnr, lang, opts)
   opts = opts or {}
 
   if bufnr == nil or bufnr == 0 then
-    bufnr = a.nvim_get_current_buf()
+    bufnr = api.nvim_get_current_buf()
   end
 
   if not valid_lang(lang) then
@@ -141,7 +141,7 @@ end
 ---@return boolean
 function M._has_parser(bufnr)
   if bufnr == nil or bufnr == 0 then
-    bufnr = a.nvim_get_current_buf()
+    bufnr = api.nvim_get_current_buf()
   end
   return parsers[bufnr] ~= nil
 end
@@ -229,7 +229,7 @@ local function buf_range_get_text(buf, range)
     end_col = -1
     end_row = end_row - 1
   end
-  local lines = a.nvim_buf_get_text(buf, start_row, start_col, end_row, end_col, {})
+  local lines = api.nvim_buf_get_text(buf, start_row, start_col, end_row, end_col, {})
   return table.concat(lines, '\n')
 end
 
@@ -294,7 +294,7 @@ end
 ---@return table[] List of captures `{ capture = "name", metadata = { ... } }`
 function M.get_captures_at_pos(bufnr, row, col)
   if bufnr == 0 then
-    bufnr = a.nvim_get_current_buf()
+    bufnr = api.nvim_get_current_buf()
   end
   local buf_highlighter = M.highlighter.active[bufnr]
 
@@ -345,8 +345,8 @@ end
 ---@return string[] List of capture names
 function M.get_captures_at_cursor(winnr)
   winnr = winnr or 0
-  local bufnr = a.nvim_win_get_buf(winnr)
-  local cursor = a.nvim_win_get_cursor(winnr)
+  local bufnr = api.nvim_win_get_buf(winnr)
+  local cursor = api.nvim_win_get_cursor(winnr)
 
   local data = M.get_captures_at_pos(bufnr, cursor[1] - 1, cursor[2])
 
@@ -374,7 +374,7 @@ function M.get_node(opts)
   local bufnr = opts.bufnr
 
   if not bufnr or bufnr == 0 then
-    bufnr = a.nvim_get_current_buf()
+    bufnr = api.nvim_get_current_buf()
   end
 
   local row, col
@@ -383,10 +383,10 @@ function M.get_node(opts)
     row, col = opts.pos[1], opts.pos[2]
   else
     assert(
-      bufnr == a.nvim_get_current_buf(),
+      bufnr == api.nvim_get_current_buf(),
       'Position must be explicitly provided when not using the current buffer'
     )
-    local pos = a.nvim_win_get_cursor(0)
+    local pos = api.nvim_win_get_cursor(0)
     -- Subtract one to account for 1-based row indexing in nvim_win_get_cursor
     row, col = pos[1] - 1, pos[2]
   end
@@ -417,7 +417,7 @@ end
 function M.get_node_at_pos(bufnr, row, col, opts)
   vim.deprecate('vim.treesitter.get_node_at_pos()', 'vim.treesitter.get_node()', '0.10')
   if bufnr == 0 then
-    bufnr = a.nvim_get_current_buf()
+    bufnr = api.nvim_get_current_buf()
   end
   local ts_range = { row, col, row, col }
 
@@ -440,7 +440,7 @@ end
 function M.get_node_at_cursor(winnr)
   vim.deprecate('vim.treesitter.get_node_at_cursor()', 'vim.treesitter.get_node():type()', '0.10')
   winnr = winnr or 0
-  local bufnr = a.nvim_win_get_buf(winnr)
+  local bufnr = api.nvim_win_get_buf(winnr)
 
   return M.get_node({ bufnr = bufnr, ignore_injections = false }):type()
 end
@@ -465,7 +465,7 @@ end
 ---@param bufnr (integer|nil) Buffer to be highlighted (default: current buffer)
 ---@param lang (string|nil) Language of the parser (default: buffer filetype)
 function M.start(bufnr, lang)
-  bufnr = bufnr or a.nvim_get_current_buf()
+  bufnr = bufnr or api.nvim_get_current_buf()
   local parser = M.get_parser(bufnr, lang)
   M.highlighter.new(parser)
 end
@@ -474,7 +474,7 @@ end
 ---
 ---@param bufnr (integer|nil) Buffer to stop highlighting (default: current buffer)
 function M.stop(bufnr)
-  bufnr = bufnr or a.nvim_get_current_buf()
+  bufnr = bufnr or api.nvim_get_current_buf()
 
   if M.highlighter.active[bufnr] then
     M.highlighter.active[bufnr]:destroy()
diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index d3cc1b698c..ac2a929487 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -1,4 +1,4 @@
-local a = vim.api
+local api = vim.api
 local query = vim.treesitter.query
 
 ---@alias TSHlIter fun(): integer, TSNode, TSMetadata
@@ -25,7 +25,7 @@ TSHighlighter.active = TSHighlighter.active or {}
 local TSHighlighterQuery = {}
 TSHighlighterQuery.__index = TSHighlighterQuery
 
-local ns = a.nvim_create_namespace('treesitter/highlighter')
+local ns = api.nvim_create_namespace('treesitter/highlighter')
 
 ---@private
 function TSHighlighterQuery.new(lang, query_string)
@@ -36,7 +36,7 @@ function TSHighlighterQuery.new(lang, query_string)
       local name = self._query.captures[capture]
       local id = 0
       if not vim.startswith(name, '_') then
-        id = a.nvim_get_hl_id_by_name('@' .. name .. '.' .. lang)
+        id = api.nvim_get_hl_id_by_name('@' .. name .. '.' .. lang)
       end
 
       rawset(table, capture, id)
@@ -121,7 +121,7 @@ function TSHighlighter.new(tree, opts)
     vim.cmd.runtime({ 'syntax/synload.vim', bang = true })
   end
 
-  a.nvim_buf_call(self.bufnr, function()
+  api.nvim_buf_call(self.bufnr, function()
     vim.opt_local.spelloptions:append('noplainbuffer')
   end)
 
@@ -140,7 +140,7 @@ function TSHighlighter:destroy()
     vim.bo[self.bufnr].spelloptions = self.orig_spelloptions
     vim.b[self.bufnr].ts_highlight = nil
     if vim.g.syntax_on == 1 then
-      a.nvim_exec_autocmds('FileType', { group = 'syntaxset', buffer = self.bufnr })
+      api.nvim_exec_autocmds('FileType', { group = 'syntaxset', buffer = self.bufnr })
     end
   end
 end
@@ -168,7 +168,7 @@ end
 ---@param start_row integer
 ---@param new_end integer
 function TSHighlighter:on_bytes(_, _, start_row, _, _, _, _, _, new_end)
-  a.nvim__buf_redraw_range(self.bufnr, start_row, start_row + new_end + 1)
+  api.nvim__buf_redraw_range(self.bufnr, start_row, start_row + new_end + 1)
 end
 
 ---@package
@@ -180,7 +180,7 @@ end
 ---@param changes integer[][]?
 function TSHighlighter:on_changedtree(changes)
   for _, ch in ipairs(changes or {}) do
-    a.nvim__buf_redraw_range(self.bufnr, ch[1], ch[3] + 1)
+    api.nvim__buf_redraw_range(self.bufnr, ch[1], ch[3] + 1)
   end
 end
 
@@ -252,7 +252,7 @@ local function on_line_impl(self, buf, line, is_spell_nav)
       local spell_pri_offset = capture_name == 'nospell' and 1 or 0
 
       if hl and end_row >= line and (not is_spell_nav or spell ~= nil) then
-        a.nvim_buf_set_extmark(buf, ns, start_row, start_col, {
+        api.nvim_buf_set_extmark(buf, ns, start_row, start_col, {
           end_line = end_row,
           end_col = end_col,
           hl_group = hl,
@@ -323,7 +323,7 @@ function TSHighlighter._on_win(_, _win, buf, _topline)
   return true
 end
 
-a.nvim_set_decoration_provider(ns, {
+api.nvim_set_decoration_provider(ns, {
   on_buf = TSHighlighter._on_buf,
   on_win = TSHighlighter._on_win,
   on_line = TSHighlighter._on_line,
diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index 5b74bb6200..b616d4d70b 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -1,4 +1,4 @@
-local a = vim.api
+local api = vim.api
 
 ---@class TSLanguageModule
 local M = {}
@@ -89,7 +89,7 @@ function M.add(lang, opts)
     end
 
     local fname = 'parser/' .. lang .. '.*'
-    local paths = a.nvim_get_runtime_file(fname, false)
+    local paths = api.nvim_get_runtime_file(fname, false)
     if #paths == 0 then
       error("no parser for '" .. lang .. "' language, see :help treesitter-parsers")
     end
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index cf0ecbd839..703d2a1f6d 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -32,7 +32,7 @@
 --- a plugin that does any kind of analysis on a tree should use a timer to throttle too frequent
 --- updates.
 
-local a = vim.api
+local api = vim.api
 local query = require('vim.treesitter.query')
 local language = require('vim.treesitter.language')
 local Range = require('vim.treesitter._range')
@@ -141,16 +141,16 @@ function LanguageTree:_log(...)
   local prefix =
     string.format('%s:%d: [%s:%d] ', info.name, info.currentline, self:lang(), nregions)
 
-  a.nvim_out_write(prefix)
+  api.nvim_out_write(prefix)
   for _, x in ipairs(args) do
     if type(x) == 'string' then
-      a.nvim_out_write(x)
+      api.nvim_out_write(x)
     else
-      a.nvim_out_write(vim.inspect(x, { newline = ' ', indent = '' }))
+      api.nvim_out_write(vim.inspect(x, { newline = ' ', indent = '' }))
     end
-    a.nvim_out_write(' ')
+    api.nvim_out_write(' ')
   end
-  a.nvim_out_write('\n')
+  api.nvim_out_write('\n')
 end
 
 --- Invalidates this parser and all its children
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 25623c1498..5b87e6ac31 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -1,4 +1,4 @@
-local a = vim.api
+local api = vim.api
 local language = require('vim.treesitter.language')
 
 ---@class Query
@@ -74,7 +74,7 @@ end
 ---@return string[] query_files List of files to load for given query and language
 function M.get_files(lang, query_name, is_included)
   local query_path = string.format('queries/%s/%s.scm', lang, query_name)
-  local lang_files = dedupe_files(a.nvim_get_runtime_file(query_path, true))
+  local lang_files = dedupe_files(api.nvim_get_runtime_file(query_path, true))
 
   if #lang_files == 0 then
     return {}
@@ -635,7 +635,7 @@ end
 ---@return (fun(): integer, TSNode, TSMetadata): capture id, capture node, metadata
 function Query:iter_captures(node, source, start, stop)
   if type(source) == 'number' and source == 0 then
-    source = vim.api.nvim_get_current_buf()
+    source = api.nvim_get_current_buf()
   end
 
   start, stop = value_or_node_range(start, stop, node)
@@ -690,7 +690,7 @@ end
 ---@return (fun(): integer, table<integer,TSNode>, table): pattern id, match, metadata
 function Query:iter_matches(node, source, start, stop)
   if type(source) == 'number' and source == 0 then
-    source = vim.api.nvim_get_current_buf()
+    source = api.nvim_get_current_buf()
   end
 
   start, stop = value_or_node_range(start, stop, node)
-- 
cgit 


From e29bc03c046b3a137c2e36b4d34c119b277d62b2 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 6 Apr 2023 15:16:44 +0100
Subject: fix(treesitter): do not track ranges of the root tree (#22912)

Fixes #22911
---
 runtime/lua/vim/treesitter/languagetree.lua | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 703d2a1f6d..4aa07d1b96 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -57,6 +57,7 @@ local Range = require('vim.treesitter._range')
 ---@field private _injection_query Query Queries defining injected languages
 ---@field private _opts table Options
 ---@field private _parser TSParser Parser for language
+---@field private _has_regions boolean
 ---@field private _regions Range6[][]?
 ---List of regions this tree should manage and parse. If nil then regions are
 ---taken from _trees. This is mostly a short-lived cache for included_regions()
@@ -440,6 +441,8 @@ end
 ---@private
 ---@param new_regions Range6[][] List of regions this tree should manage and parse.
 function LanguageTree:set_included_regions(new_regions)
+  self._has_regions = true
+
   -- Transform the tables from 4 element long to 6 element long (with byte offset)
   for _, region in ipairs(new_regions) do
     for i, range in ipairs(region) do
@@ -468,7 +471,8 @@ function LanguageTree:included_regions()
     return self._regions
   end
 
-  if #self._trees == 0 then
+  if not self._has_regions or #self._trees == 0 then
+    -- treesitter.c will default empty ranges to { -1, -1, -1, -1, -1, -1}
     return { {} }
   end
 
@@ -744,6 +748,10 @@ function LanguageTree:_edit(
 
   -- Validate regions after editing the tree
   self:_iter_regions(function(_, region)
+    if #region == 0 then
+      -- empty region, use the full source
+      return false
+    end
     for _, r in ipairs(region) do
       if Range.intercepts(r, changed_range) then
         return false
-- 
cgit 


From d675bd01b1e78b93e559320b262bdae40b3b54b2 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Fri, 7 Apr 2023 08:22:47 -0600
Subject: feat(lua): allow vim.F.if_nil to take multiple arguments (#22903)

The first argument which is non-nil is returned. This is useful when
using nested default values (e.g. in the EditorConfig plugin).

Before:

  local enable = vim.F.if_nil(vim.b.editorconfig, vim.F.if_nil(vim.g.editorconfig, true))

After:

  local enable = vim.F.if_nil(vim.b.editorconfig, vim.g.editorconfig, true)
---
 runtime/lua/vim/F.lua | 31 +++++++++++++++++++++----------
 1 file changed, 21 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/F.lua b/runtime/lua/vim/F.lua
index 3e370c0a84..16c834b371 100644
--- a/runtime/lua/vim/F.lua
+++ b/runtime/lua/vim/F.lua
@@ -1,18 +1,29 @@
 local F = {}
 
---- Returns {a} if it is not nil, otherwise returns {b}.
+--- Returns the first argument which is not nil.
 ---
----@generic A
----@generic B
+--- If all arguments are nil, returns nil.
 ---
----@param a A
----@param b B
----@return A | B
-function F.if_nil(a, b)
-  if a == nil then
-    return b
+--- Examples:
+--- <pre>
+--- local a = nil
+--- local b = nil
+--- local c = 42
+--- local d = true
+--- assert(vim.F.if_nil(a, b, c, d) == 42)
+--- </pre>
+---
+---@param ... any
+---@return any
+function F.if_nil(...)
+  local nargs = select('#', ...)
+  for i = 1, nargs do
+    local v = select(i, ...)
+    if v ~= nil then
+      return v
+    end
   end
-  return a
+  return nil
 end
 
 -- Use in combination with pcall
-- 
cgit 


From ccc0980f86c6ef9a86b0e5a3a691f37cea8eb776 Mon Sep 17 00:00:00 2001
From: Scott Ming <TheRealScottMing@gmail.com>
Date: Tue, 11 Apr 2023 16:26:03 +0800
Subject: fix(treesitter): Use the correct replacement args for #gsub!
 directive (#23015)

fix(treesitter): use the correct replacement args for #gsub! directive
---
 runtime/lua/vim/treesitter/query.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 5b87e6ac31..8a747ba14c 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -458,7 +458,7 @@ local directive_handlers = {
       metadata[id] = {}
     end
 
-    local pattern, replacement = pred[3], pred[3]
+    local pattern, replacement = pred[3], pred[4]
     assert(type(pattern) == 'string')
     assert(type(replacement) == 'string')
 
-- 
cgit 


From 9e86f473e0f4e21c5f40bf990c53194d593a0f9f Mon Sep 17 00:00:00 2001
From: NAKAI Tsuyoshi <82267684+uga-rosa@users.noreply.github.com>
Date: Tue, 11 Apr 2023 23:28:46 +0900
Subject: feat(lua): vim.region accepts getpos() arg (#22635)

---
 runtime/lua/vim/_editor.lua   | 22 ++++++++++++++++++++--
 runtime/lua/vim/highlight.lua | 19 ++++---------------
 2 files changed, 24 insertions(+), 17 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index fa0980563a..c922ec93db 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -402,8 +402,8 @@ end
 --- Input and output positions are (0,0)-indexed and indicate byte positions.
 ---
 ---@param bufnr integer number of buffer
----@param pos1 integer[] (line, column) tuple marking beginning of region
----@param pos2 integer[] (line, column) tuple marking end of region
+---@param pos1 integer[]|string start of region as a (line, column) tuple or string accepted by |getpos()|
+---@param pos2 integer[]|string end of region as a (line, column) tuple or string accepted by |getpos()|
 ---@param regtype string type of selection, see |setreg()|
 ---@param inclusive boolean indicating whether column of pos2 is inclusive
 ---@return table region Table of the form `{linenr = {startcol,endcol}}`.
@@ -414,6 +414,24 @@ function vim.region(bufnr, pos1, pos2, regtype, inclusive)
     vim.fn.bufload(bufnr)
   end
 
+  if type(pos1) == 'string' then
+    local pos = vim.fn.getpos(pos1)
+    pos1 = { pos[2] - 1, pos[3] - 1 + pos[4] }
+  end
+  if type(pos2) == 'string' then
+    local pos = vim.fn.getpos(pos2)
+    pos2 = { pos[2] - 1, pos[3] - 1 + pos[4] }
+  end
+
+  if pos1[1] > pos2[1] or (pos1[1] == pos2[1] and pos1[2] > pos2[2]) then
+    pos1, pos2 = pos2, pos1
+  end
+
+  -- getpos() may return {0,0,0,0}
+  if pos1[1] < 0 or pos1[2] < 0 then
+    return {}
+  end
+
   -- check that region falls within current buffer
   local buf_line_count = vim.api.nvim_buf_line_count(bufnr)
   pos1[1] = math.min(pos1[1], buf_line_count - 1)
diff --git a/runtime/lua/vim/highlight.lua b/runtime/lua/vim/highlight.lua
index d71a806ea8..a6cfcb730f 100644
--- a/runtime/lua/vim/highlight.lua
+++ b/runtime/lua/vim/highlight.lua
@@ -15,8 +15,8 @@ M.priorities = {
 ---@param bufnr integer Buffer number to apply highlighting to
 ---@param ns integer Namespace to add highlight to
 ---@param higroup string Highlight group to use for highlighting
----@param start { [1]: integer, [2]: integer } Start position {line, col}
----@param finish { [1]: integer, [2]: integer } Finish position {line, col}
+---@param start integer[]|string Start of region as a (line, column) tuple or string accepted by |getpos()|
+---@param finish integer[]|string End of region as a (line, column) tuple or string accepted by |getpos()|
 ---@param opts table|nil Optional parameters
 --             - regtype type of range (see |setreg()|, default charwise)
 --             - inclusive boolean indicating whether the range is end-inclusive (default false)
@@ -27,11 +27,6 @@ function M.range(bufnr, ns, higroup, start, finish, opts)
   local inclusive = opts.inclusive or false
   local priority = opts.priority or M.priorities.user
 
-  -- sanity check
-  if start[2] < 0 or finish[1] < start[1] then
-    return
-  end
-
   local region = vim.region(bufnr, start, finish, regtype, inclusive)
   for linenr, cols in pairs(region) do
     local end_row
@@ -104,18 +99,12 @@ function M.on_yank(opts)
     yank_timer:close()
   end
 
-  local pos1 = vim.fn.getpos("'[")
-  local pos2 = vim.fn.getpos("']")
-
-  pos1 = { pos1[2] - 1, pos1[3] - 1 + pos1[4] }
-  pos2 = { pos2[2] - 1, pos2[3] - 1 + pos2[4] }
-
   M.range(
     bufnr,
     yank_ns,
     higroup,
-    pos1,
-    pos2,
+    "'[",
+    "']",
     { regtype = event.regtype, inclusive = event.inclusive, priority = M.priorities.user }
   )
 
-- 
cgit 


From 37011bc45ef333776bccea84a1a7ced6c68e3b51 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Wed, 12 Apr 2023 15:16:15 +0200
Subject: fix(diagnostic): rename buffer → bufnr in type annotation (#23042)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

See `:h diagnostic-structure`, the property name is `bufnr`, not
`buffer`.
---
 runtime/lua/vim/diagnostic.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index 714038f8e4..d1b50304c7 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -744,7 +744,7 @@ function M.get_namespaces()
 end
 
 ---@class Diagnostic
----@field buffer integer
+---@field bufnr integer
 ---@field lnum integer 0-indexed
 ---@field end_lnum nil|integer 0-indexed
 ---@field col integer 0-indexed
-- 
cgit 


From 66c66d8db8ab5cb6d0c6d85d64556d7cf20b04fa Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 13 Apr 2023 17:34:47 +0100
Subject: fix(loader): reset hashes when running the loader

---
 runtime/lua/vim/loader.lua | 18 +++++++++++++-----
 1 file changed, 13 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index 38b1e9fc0f..7f953adc21 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -5,7 +5,7 @@ local loaders = package.loaders
 
 local M = {}
 
----@alias CacheHash {mtime: {sec:number, nsec:number}, size:number, type: string}
+---@alias CacheHash {mtime: {nsec: integer, sec: integer}, size: integer, type?: uv.aliases.fs_stat_types}
 ---@alias CacheEntry {hash:CacheHash, chunk:string}
 
 ---@class ModuleFindOpts
@@ -28,12 +28,11 @@ M.enabled = false
 ---@field _rtp string[]
 ---@field _rtp_pure string[]
 ---@field _rtp_key string
+---@field _hashes? table<string, CacheHash>
 local Loader = {
   VERSION = 3,
   ---@type table<string, table<string,ModuleInfo>>
   _indexed = {},
-  ---@type table<string, CacheHash>
-  _hashes = {},
   ---@type table<string, string[]>
   _topmods = {},
   _loadfile = loadfile,
@@ -44,9 +43,13 @@ local Loader = {
 }
 
 --- @param path string
---- @return uv.fs_stat.result
+--- @return CacheHash
 --- @private
 function Loader.get_hash(path)
+  if not Loader._hashes then
+    return uv.fs_stat(path) --[[@as CacheHash]]
+  end
+
   if not Loader._hashes[path] then
     -- Note we must never save a stat for a non-existent path.
     -- For non-existent paths fs_stat() will return nil.
@@ -163,13 +166,16 @@ end
 ---@return string|function
 ---@private
 function Loader.loader(modname)
+  Loader._hashes = {}
   local ret = M.find(modname)[1]
   if ret then
     -- Make sure to call the global loadfile so we respect any augmentations done elsewhere.
     -- E.g. profiling
     local chunk, err = loadfile(ret.modpath)
+    Loader._hashes = nil
     return chunk or error(err)
   end
+  Loader._hashes = nil
   return '\ncache_loader: module ' .. modname .. ' not found'
 end
 
@@ -373,7 +379,9 @@ function M.reset(path)
   end
 
   -- Path could be a directory so just clear all the hashes.
-  Loader._hashes = {}
+  if Loader._hashes then
+    Loader._hashes = {}
+  end
 end
 
 --- Enables the experimental Lua module loader:
-- 
cgit 


From bfb28b62dab756ec76a73506c2070ddf491a0cdd Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Thu, 13 Apr 2023 15:29:13 -0600
Subject: refactor: remove modelines from Lua files

Now that we have builtin EditorConfig support and a formatting check in
CI, these are not necessary.
---
 runtime/lua/vim/lsp.lua          | 1 -
 runtime/lua/vim/lsp/buf.lua      | 1 -
 runtime/lua/vim/lsp/handlers.lua | 1 -
 runtime/lua/vim/lsp/log.lua      | 1 -
 runtime/lua/vim/lsp/protocol.lua | 1 -
 runtime/lua/vim/lsp/rpc.lua      | 1 -
 runtime/lua/vim/lsp/util.lua     | 1 -
 runtime/lua/vim/shared.lua       | 1 -
 runtime/lua/vim/uri.lua          | 1 -
 9 files changed, 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 2d39f2d45d..3db3545786 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -2384,4 +2384,3 @@ lsp.commands = setmetatable({}, {
 })
 
 return lsp
--- vim:sw=2 ts=2 et
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 8bf3764f5e..3d9011656f 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -806,4 +806,3 @@ function M.execute_command(command_params)
 end
 
 return M
--- vim:sw=2 ts=2 et
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index d01f8e6159..71bef43bc1 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -644,4 +644,3 @@ for k, fn in pairs(M) do
 end
 
 return M
--- vim:sw=2 ts=2 et
diff --git a/runtime/lua/vim/lsp/log.lua b/runtime/lua/vim/lsp/log.lua
index 51dcb7d21d..3d5bc06c3f 100644
--- a/runtime/lua/vim/lsp/log.lua
+++ b/runtime/lua/vim/lsp/log.lua
@@ -174,4 +174,3 @@ function log.should_log(level)
 end
 
 return log
--- vim:sw=2 ts=2 et
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index f4489ad17d..2cb8fc7955 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -894,4 +894,3 @@ function protocol.resolve_capabilities(server_capabilities)
 end
 
 return protocol
--- vim:sw=2 ts=2 et
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index 30b61d01d6..af3190c9bd 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -753,4 +753,3 @@ return {
   client_errors = client_errors,
   create_read_loop = create_read_loop,
 }
--- vim:sw=2 ts=2 et
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index ebde7af16c..dca258e4b9 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -2154,4 +2154,3 @@ M._get_line_byte_from_position = get_line_byte_from_position
 M.buf_versions = {}
 
 return M
--- vim:sw=2 ts=2 et
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index eb734fb512..9245adae3a 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -811,4 +811,3 @@ function vim.defaulttable(create)
 end
 
 return vim
--- vim:sw=2 ts=2 et
diff --git a/runtime/lua/vim/uri.lua b/runtime/lua/vim/uri.lua
index 38759fcdc0..08ed829114 100644
--- a/runtime/lua/vim/uri.lua
+++ b/runtime/lua/vim/uri.lua
@@ -134,4 +134,3 @@ return {
   uri_to_fname = uri_to_fname,
   uri_to_bufnr = uri_to_bufnr,
 }
--- vim:sw=2 ts=2 et
-- 
cgit 


From 4d04feb6629cb049cb2a13ba35f0c8d3c6b67ff4 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 14 Apr 2023 10:39:57 +0200
Subject: feat(lua): vim.tbl_contains supports general tables and predicates
 (#23040)

* feat(lua): vim.tbl_contains supports general tables and predicates

Problem: `vim.tbl_contains` only works for list-like tables (integer
keys without gaps) and primitive values (in particular, not for nested
tables).

Solution: Rename `vim.tbl_contains` to `vim.list_contains` and add new
`vim.tbl_contains` that works for general tables and optionally allows
`value` to be a predicate function that is checked for every key.
---
 runtime/lua/vim/loader.lua       |  4 ++--
 runtime/lua/vim/lsp.lua          |  4 ++--
 runtime/lua/vim/lsp/_snippet.lua |  4 ++--
 runtime/lua/vim/lsp/codelens.lua |  2 +-
 runtime/lua/vim/lsp/util.lua     |  2 +-
 runtime/lua/vim/shared.lua       | 45 ++++++++++++++++++++++++++++++++++++++--
 6 files changed, 51 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index 7f953adc21..66627fe4e7 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -449,7 +449,7 @@ function Loader.lsmod(path)
       if topname then
         Loader._indexed[path][topname] = { modpath = modpath, modname = topname }
         Loader._topmods[topname] = Loader._topmods[topname] or {}
-        if not vim.tbl_contains(Loader._topmods[topname], path) then
+        if not vim.list_contains(Loader._topmods[topname], path) then
           table.insert(Loader._topmods[topname], path)
         end
       end
@@ -523,7 +523,7 @@ function M._inspect(opts)
         { ms(Loader._stats[stat].time / Loader._stats[stat].total) .. '\n', 'Bold' },
       })
       for k, v in pairs(Loader._stats[stat]) do
-        if not vim.tbl_contains({ 'time', 'total' }, k) then
+        if not vim.list_contains({ 'time', 'total' }, k) then
           chunks[#chunks + 1] = { '* ' .. k .. ':' .. string.rep(' ', 9 - #k) }
           chunks[#chunks + 1] = { tostring(v) .. '\n', 'Number' }
         end
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 3db3545786..5c78bd7580 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -171,7 +171,7 @@ local function for_each_buffer_client(bufnr, fn, restrict_client_ids)
   if restrict_client_ids and #restrict_client_ids > 0 then
     local filtered_client_ids = {}
     for client_id in pairs(client_ids) do
-      if vim.tbl_contains(restrict_client_ids, client_id) then
+      if vim.list_contains(restrict_client_ids, client_id) then
         filtered_client_ids[client_id] = true
       end
     end
@@ -2186,7 +2186,7 @@ function lsp.formatexpr(opts)
   opts = opts or {}
   local timeout_ms = opts.timeout_ms or 500
 
-  if vim.tbl_contains({ 'i', 'R', 'ic', 'ix' }, vim.fn.mode()) then
+  if vim.list_contains({ 'i', 'R', 'ic', 'ix' }, vim.fn.mode()) then
     -- `formatexpr` is also called when exceeding `textwidth` in insert mode
     -- fall back to internal formatting
     return 1
diff --git a/runtime/lua/vim/lsp/_snippet.lua b/runtime/lua/vim/lsp/_snippet.lua
index 797d8960d5..e7ada5415f 100644
--- a/runtime/lua/vim/lsp/_snippet.lua
+++ b/runtime/lua/vim/lsp/_snippet.lua
@@ -17,14 +17,14 @@ P.take_until = function(targets, specials)
         table.insert(raw, '\\')
         new_pos = new_pos + 1
         c = string.sub(input, new_pos, new_pos)
-        if not vim.tbl_contains(targets, c) and not vim.tbl_contains(specials, c) then
+        if not vim.list_contains(targets, c) and not vim.list_contains(specials, c) then
           table.insert(esc, '\\')
         end
         table.insert(raw, c)
         table.insert(esc, c)
         new_pos = new_pos + 1
       else
-        if vim.tbl_contains(targets, c) then
+        if vim.list_contains(targets, c) then
           break
         end
         table.insert(raw, c)
diff --git a/runtime/lua/vim/lsp/codelens.lua b/runtime/lua/vim/lsp/codelens.lua
index 81cac6a511..005a0047fa 100644
--- a/runtime/lua/vim/lsp/codelens.lua
+++ b/runtime/lua/vim/lsp/codelens.lua
@@ -42,7 +42,7 @@ local function execute_lens(lens, bufnr, client_id)
   -- Need to use the client that returned the lens → must not use buf_request
   local command_provider = client.server_capabilities.executeCommandProvider
   local commands = type(command_provider) == 'table' and command_provider.commands or {}
-  if not vim.tbl_contains(commands, command.command) then
+  if not vim.list_contains(commands, command.command) then
     vim.notify(
       string.format(
         'Language server does not support command `%s`. This command may require a client extension.',
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index dca258e4b9..31af2afb0b 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1476,7 +1476,7 @@ end
 local function close_preview_window(winnr, bufnrs)
   vim.schedule(function()
     -- exit if we are in one of ignored buffers
-    if bufnrs and vim.tbl_contains(bufnrs, api.nvim_get_current_buf()) then
+    if bufnrs and vim.list_contains(bufnrs, api.nvim_get_current_buf()) then
       return
     end
 
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 9245adae3a..7ecb56eb92 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -252,12 +252,53 @@ function vim.tbl_filter(func, t)
   return rettab
 end
 
---- Checks if a list-like (vector) table contains `value`.
+--- Checks if a table contains a given value, specified either directly or via
+--- a predicate that is checked for each value.
+---
+--- Example:
+--- <pre>lua
+---  vim.tbl_contains({ 'a', { 'b', 'c' } }, function(v)
+---    return vim.deep_equal(v, { 'b', 'c' })
+---  end, { predicate = true })
+---  -- true
+--- </pre>
+---
+---@see |vim.list_contains()| for checking values in list-like tables
 ---
 ---@param t table Table to check
+---@param value any Value to compare or predicate function reference
+---@param opts (table|nil) Keyword arguments |kwargs|:
+---       - predicate: (boolean) `value` is a function reference to be checked (default false)
+---@return boolean `true` if `t` contains `value`
+function vim.tbl_contains(t, value, opts)
+  vim.validate({ t = { t, 't' }, opts = { opts, 't', true } })
+
+  local pred
+  if opts and opts.predicate then
+    vim.validate({ value = { value, 'c' } })
+    pred = value
+  else
+    pred = function(v)
+      return v == value
+    end
+  end
+
+  for _, v in pairs(t) do
+    if pred(v) then
+      return true
+    end
+  end
+  return false
+end
+
+--- Checks if a list-like table (integer keys without gaps) contains `value`.
+---
+---@see |vim.tbl_contains()| for checking values in general tables
+---
+---@param t table Table to check (must be list-like, not validated)
 ---@param value any Value to compare
 ---@return boolean `true` if `t` contains `value`
-function vim.tbl_contains(t, value)
+function vim.list_contains(t, value)
   vim.validate({ t = { t, 't' } })
 
   for _, v in ipairs(t) do
-- 
cgit 


From 7caf0eafd83b5a92f2ff219b3a64ffae4174b9af Mon Sep 17 00:00:00 2001
From: NAKAI Tsuyoshi <82267684+uga-rosa@users.noreply.github.com>
Date: Fri, 14 Apr 2023 19:01:08 +0900
Subject: feat(lua)!: add stricter vim.tbl_islist() and rename old one to
 vim.tbl_isarray() (#16440)

feat(lua)!: add stricter vim.tbl_islist(), rename vim.tbl_isarray()

Problem: `vim.tbl_islist` allows gaps in tables with integer keys
("arrays").

Solution: Rename `vim.tbl_islist` to `vim.tbl_isarray`, add new
`vim.tbl.islist` that checks for consecutive integer keys that start
from 1.
---
 runtime/lua/vim/shared.lua | 47 +++++++++++++++++++++++++++++++++++++++-------
 1 file changed, 40 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 7ecb56eb92..f700f4a6b3 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -320,10 +320,10 @@ function vim.tbl_isempty(t)
   return next(t) == nil
 end
 
---- We only merge empty tables or tables that are not a list
+--- We only merge empty tables or tables that are not an array (indexed by integers)
 ---@private
 local function can_merge(v)
-  return type(v) == 'table' and (vim.tbl_isempty(v) or not vim.tbl_islist(v))
+  return type(v) == 'table' and (vim.tbl_isempty(v) or not vim.tbl_isarray(v))
 end
 
 local function tbl_extend(behavior, deep_extend, ...)
@@ -554,15 +554,15 @@ function vim.spairs(t)
   end
 end
 
---- Tests if a Lua table can be treated as an array.
+--- Tests if a Lua table can be treated as an array (a table indexed by integers).
 ---
 --- Empty table `{}` is assumed to be an array, unless it was created by
 --- |vim.empty_dict()| or returned as a dict-like |API| or Vimscript result,
 --- for example from |rpcrequest()| or |vim.fn|.
 ---
----@param t table Table
----@return boolean `true` if array-like table, else `false`
-function vim.tbl_islist(t)
+---@param t table
+---@return boolean `true` if array-like table, else `false`.
+function vim.tbl_isarray(t)
   if type(t) ~= 'table' then
     return false
   end
@@ -570,7 +570,8 @@ function vim.tbl_islist(t)
   local count = 0
 
   for k, _ in pairs(t) do
-    if type(k) == 'number' then
+    --- Check if the number k is an integer
+    if type(k) == 'number' and k == math.floor(k) then
       count = count + 1
     else
       return false
@@ -589,6 +590,38 @@ function vim.tbl_islist(t)
   end
 end
 
+--- Tests if a Lua table can be treated as a list (a table indexed by consecutive integers starting from 1).
+---
+--- Empty table `{}` is assumed to be an list, unless it was created by
+--- |vim.empty_dict()| or returned as a dict-like |API| or Vimscript result,
+--- for example from |rpcrequest()| or |vim.fn|.
+---
+---@param t table
+---@return boolean `true` if list-like table, else `false`.
+function vim.tbl_islist(t)
+  if type(t) ~= 'table' then
+    return false
+  end
+
+  local num_elem = vim.tbl_count(t)
+
+  if num_elem == 0 then
+    -- TODO(bfredl): in the future, we will always be inside nvim
+    -- then this check can be deleted.
+    if vim._empty_dict_mt == nil then
+      return nil
+    end
+    return getmetatable(t) ~= vim._empty_dict_mt
+  else
+    for i = 1, num_elem do
+      if t[i] == nil then
+        return false
+      end
+    end
+    return true
+  end
+end
+
 --- Counts the number of non-nil values in table `t`.
 ---
 --- <pre>lua
-- 
cgit 


From c08b03076167837cff9eb66c19440d727e6dad31 Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Sat, 15 Apr 2023 23:40:48 +0200
Subject: refactor: deprecate checkhealth functions

The following functions are deprecated and will be removed in
Nvim v0.11:

- health#report_start()
- health#report_info()
- health#report_ok()
- health#report_warn()
- health#report_error()
- vim.health.report_start()
- vim.health.report_info()
- vim.health.report_ok()
- vim.health.report_warn()
- vim.health.report_error()

Users should instead use these:

- vim.health.start()
- vim.health.info()
- vim.health.ok()
- vim.health.warn()
- vim.health.error()
---
 runtime/lua/vim/health.lua            | 264 ++++++++++++++++++++++++++++++++--
 runtime/lua/vim/lsp/health.lua        |   6 +-
 runtime/lua/vim/treesitter/health.lua |   6 +-
 3 files changed, 261 insertions(+), 15 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/health.lua b/runtime/lua/vim/health.lua
index 044880e076..04f8f9695b 100644
--- a/runtime/lua/vim/health.lua
+++ b/runtime/lua/vim/health.lua
@@ -1,23 +1,196 @@
 local M = {}
 
-function M.report_start(msg)
-  vim.fn['health#report_start'](msg)
+local s_output = {}
+
+-- From a path return a list [{name}, {func}, {type}] representing a healthcheck
+local function filepath_to_healthcheck(path)
+  path = vim.fs.normalize(path)
+  local name
+  local func
+  local filetype
+  if path:find('vim$') then
+    name = vim.fs.basename(path):gsub('%.vim$', '')
+    func = 'health#' .. name .. '#check'
+    filetype = 'v'
+  else
+    local subpath = path:gsub('.*lua/', '')
+    if vim.fs.basename(subpath) == 'health.lua' then
+      -- */health.lua
+      name = vim.fs.dirname(subpath)
+    else
+      -- */health/init.lua
+      name = vim.fs.dirname(vim.fs.dirname(subpath))
+    end
+    name = name:gsub('/', '.')
+
+    func = 'require("' .. name .. '.health").check()'
+    filetype = 'l'
+  end
+  return { name, func, filetype }
 end
 
-function M.report_info(msg)
-  vim.fn['health#report_info'](msg)
+-- Returns { {name, func, type}, ... } representing healthchecks
+local function get_healthcheck_list(plugin_names)
+  local healthchecks = {}
+  plugin_names = vim.split(plugin_names, ' ')
+  for _, p in pairs(plugin_names) do
+    -- support vim/lsp/health{/init/}.lua as :checkhealth vim.lsp
+
+    p = p:gsub('%.', '/')
+    p = p:gsub('*', '**')
+
+    local paths = vim.api.nvim_get_runtime_file('autoload/health/' .. p .. '.vim', true)
+    vim.list_extend(
+      paths,
+      vim.api.nvim_get_runtime_file('lua/**/' .. p .. '/health/init.lua', true)
+    )
+    vim.list_extend(paths, vim.api.nvim_get_runtime_file('lua/**/' .. p .. '/health.lua', true))
+
+    if vim.tbl_count(paths) == 0 then
+      healthchecks[#healthchecks + 1] = { p, '', '' } -- healthcheck not found
+    else
+      local unique_paths = {}
+      for _, v in pairs(paths) do
+        unique_paths[v] = true
+      end
+      paths = {}
+      for k, _ in pairs(unique_paths) do
+        paths[#paths + 1] = k
+      end
+
+      for _, v in ipairs(paths) do
+        healthchecks[#healthchecks + 1] = filepath_to_healthcheck(v)
+      end
+    end
+  end
+  return healthchecks
 end
 
-function M.report_ok(msg)
-  vim.fn['health#report_ok'](msg)
+-- Returns {name: [func, type], ..} representing healthchecks
+local function get_healthcheck(plugin_names)
+  local health_list = get_healthcheck_list(plugin_names)
+  local healthchecks = {}
+  for _, c in pairs(health_list) do
+    if c[1] ~= 'vim' then
+      healthchecks[c[1]] = { c[2], c[3] }
+    end
+  end
+
+  return healthchecks
 end
 
-function M.report_warn(msg, ...)
-  vim.fn['health#report_warn'](msg, ...)
+-- Indents lines *except* line 1 of a string if it contains newlines.
+local function indent_after_line1(s, columns)
+  local lines = vim.split(s, '\n')
+  local indent = string.rep(' ', columns)
+  for i = 2, #lines do
+    lines[i] = indent .. lines[i]
+  end
+  return table.concat(lines, '\n')
+end
+
+-- Changes ':h clipboard' to ':help |clipboard|'.
+local function help_to_link(s)
+  return vim.fn.substitute(s, [[\v:h%[elp] ([^|][^"\r\n ]+)]], [[:help |\1|]], [[g]])
+end
+
+-- Format a message for a specific report item.
+-- Variable args: Optional advice (string or list)
+local function format_report_message(status, msg, ...)
+  local output = '- ' .. status
+  if status ~= '' then
+    output = output .. ' '
+  end
+
+  output = output .. indent_after_line1(msg, 2)
+
+  local varargs = ...
+
+  -- Optional parameters
+  if varargs then
+    if type(varargs) == 'string' then
+      varargs = { varargs }
+    end
+
+    output = output .. '\n  - ADVICE:'
+
+    -- Report each suggestion
+    for _, v in ipairs(varargs) do
+      if v then
+        output = output .. '\n    - ' .. indent_after_line1(v, 6)
+      end
+    end
+  end
+
+  return help_to_link(output)
+end
+
+local function collect_output(output)
+  vim.list_extend(s_output, vim.split(output, '\n'))
+end
+
+-- Starts a new report.
+function M.start(name)
+  local input = string.format('\n%s ~', name)
+  collect_output(input)
+end
+
+-- Reports a message in the current section.
+function M.info(msg)
+  local input = format_report_message('', msg)
+  collect_output(input)
+end
+
+-- Reports a successful healthcheck.
+function M.ok(msg)
+  local input = format_report_message('OK', msg)
+  collect_output(input)
+end
+
+-- Reports a health warning.
+-- ...: Optional advice (string or table)
+function M.warn(msg, ...)
+  local input = format_report_message('WARNING', msg, ...)
+  collect_output(input)
 end
 
+-- Reports a failed healthcheck.
+-- ...: Optional advice (string or table)
+function M.error(msg, ...)
+  local input = format_report_message('ERROR', msg, ...)
+  collect_output(input)
+end
+
+local function deprecate(type)
+  local before = string.format('vim.health.report_%s()', type)
+  local after = string.format('vim.health.%s()', type)
+  local message = vim.deprecate(before, after, '0.11')
+  if message then
+    M.warn(message)
+  end
+  vim.cmd.redraw()
+  vim.print('Running healthchecks...')
+end
+
+function M.report_start(name)
+  deprecate('start')
+  M.start(name)
+end
+function M.report_info(msg)
+  deprecate('info')
+  M.info(msg)
+end
+function M.report_ok(msg)
+  deprecate('ok')
+  M.ok(msg)
+end
+function M.report_warn(msg, ...)
+  deprecate('warn')
+  M.warn(msg, ...)
+end
 function M.report_error(msg, ...)
-  vim.fn['health#report_error'](msg, ...)
+  deprecate('error')
+  M.error(msg, ...)
 end
 
 local path2name = function(path)
@@ -59,4 +232,77 @@ M._complete = function()
   return vim.tbl_keys(unique)
 end
 
+-- Runs the specified healthchecks.
+-- Runs all discovered healthchecks if plugin_names is empty.
+function M._check(plugin_names)
+  local healthchecks = plugin_names == '' and get_healthcheck('*') or get_healthcheck(plugin_names)
+
+  -- Create buffer and open in a tab, unless this is the default buffer when Nvim starts.
+  local emptybuf = vim.fn.bufnr('$') == 1 and vim.fn.getline(1) == '' and 1 == vim.fn.line('$')
+  local mod = emptybuf and 'buffer' or 'tab sbuffer'
+  local bufnr = vim.api.nvim_create_buf(true, true)
+  vim.cmd(mod .. ' ' .. bufnr)
+
+  if vim.fn.bufexists('health://') == 1 then
+    vim.cmd.bwipe('health://')
+  end
+  vim.cmd.file('health://')
+  vim.cmd.setfiletype('checkhealth')
+
+  if healthchecks == nil or next(healthchecks) == nil then
+    vim.fn.setline(1, 'ERROR: No healthchecks found.')
+    return
+  end
+  vim.cmd.redraw()
+  vim.print('Running healthchecks...')
+
+  for name, value in vim.spairs(healthchecks) do
+    local func = value[1]
+    local type = value[2]
+    s_output = {}
+
+    if func == '' then
+      s_output = {}
+      M.error('No healthcheck found for "' .. name .. '" plugin.')
+    end
+    if type == 'v' then
+      vim.cmd.call(func, {})
+    else
+      local f = assert(loadstring(func))
+      local ok, output = pcall(f)
+      if not ok then
+        M.error(
+          string.format('Failed to run healthcheck for "%s" plugin. Exception:\n%s\n', name, output)
+        )
+      end
+    end
+    -- in the event the healthcheck doesn't return anything
+    -- (the plugin author should avoid this possibility)
+    if next(s_output) == nil then
+      s_output = {}
+      M.error('The healthcheck report for "' .. name .. '" plugin is empty.')
+    end
+    local header = { string.rep('=', 78), name .. ': ' .. func, '' }
+    -- remove empty line after header from report_start
+    if s_output[1] == '' then
+      local tmp = {}
+      for i = 2, #s_output do
+        tmp[#tmp + 1] = s_output[i]
+      end
+      s_output = {}
+      for _, v in ipairs(tmp) do
+        s_output[#s_output + 1] = v
+      end
+    end
+    s_output[#s_output + 1] = ''
+    s_output = vim.list_extend(header, s_output)
+    vim.fn.append('$', s_output)
+    vim.cmd.redraw()
+  end
+
+  -- Clear the 'Running healthchecks...' message.
+  vim.cmd.redraw()
+  vim.print('')
+end
+
 return M
diff --git a/runtime/lua/vim/lsp/health.lua b/runtime/lua/vim/lsp/health.lua
index 987707e661..6ca468393e 100644
--- a/runtime/lua/vim/lsp/health.lua
+++ b/runtime/lua/vim/lsp/health.lua
@@ -2,8 +2,8 @@ local M = {}
 
 --- Performs a healthcheck for LSP
 function M.check()
-  local report_info = vim.health.report_info
-  local report_warn = vim.health.report_warn
+  local report_info = vim.health.info
+  local report_warn = vim.health.warn
 
   local log = require('vim.lsp.log')
   local current_log_level = log.get_level()
@@ -29,7 +29,7 @@ function M.check()
   report_fn(string.format('Log size: %d KB', log_size / 1000))
 
   local clients = vim.lsp.get_active_clients()
-  vim.health.report_start('vim.lsp: Active Clients')
+  vim.health.start('vim.lsp: Active Clients')
   if next(clients) then
     for _, client in pairs(clients) do
       report_info(
diff --git a/runtime/lua/vim/treesitter/health.lua b/runtime/lua/vim/treesitter/health.lua
index dabf2cdf6c..ed1161e97f 100644
--- a/runtime/lua/vim/treesitter/health.lua
+++ b/runtime/lua/vim/treesitter/health.lua
@@ -6,14 +6,14 @@ local health = require('vim.health')
 function M.check()
   local parsers = vim.api.nvim_get_runtime_file('parser/*', true)
 
-  health.report_info(string.format('Nvim runtime ABI version: %d', ts.language_version))
+  health.info(string.format('Nvim runtime ABI version: %d', ts.language_version))
 
   for _, parser in pairs(parsers) do
     local parsername = vim.fn.fnamemodify(parser, ':t:r')
     local is_loadable, err_or_nil = pcall(ts.language.add, parsername)
 
     if not is_loadable then
-      health.report_error(
+      health.error(
         string.format(
           'Parser "%s" failed to load (path: %s): %s',
           parsername,
@@ -23,7 +23,7 @@ function M.check()
       )
     else
       local lang = ts.language.inspect(parsername)
-      health.report_ok(
+      health.ok(
         string.format('Parser: %-10s ABI: %d, path: %s', parsername, lang._abi_version, parser)
       )
     end
-- 
cgit 


From d9e9dc3a06b78d3d1548757348788454f62ea3dc Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sun, 16 Apr 2023 10:59:04 +0200
Subject: vim-patch:9.0.1455: C++ 20 modules are not recognized (#23124)

Problem:    C++ 20 modules are not recognized.
Solution:   Add patterns to recognize C++ 20 modules as "cpp". (Ben Jackson,
            closes vim/vim#12261)

https://github.com/vim/vim/commit/732d69e1918b28ad0fe16eb9bc5a776c7958122b

Co-authored-by: Ben Jackson <puremourning@gmail.com>
---
 runtime/lua/vim/filetype.lua | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 87439f9f0c..74ab7d8260 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -257,6 +257,10 @@ local extension = {
   tcc = 'cpp',
   hxx = 'cpp',
   hpp = 'cpp',
+  ccm = 'cpp',
+  cppm = 'cpp',
+  cxxm = 'cpp',
+  ['c++m'] = 'cpp',
   cpp = function(path, bufnr)
     return vim.g.cynlib_syntax_for_cpp and 'cynlib' or 'cpp'
   end,
-- 
cgit 


From 2f779b94e7fe0fb2fba00dd8e644c60605e83179 Mon Sep 17 00:00:00 2001
From: Raphael <glephunter@gmail.com>
Date: Sun, 16 Apr 2023 17:50:32 +0800
Subject: fix(lua): inspect_pos respect bufnr when get syntax info (#23098)

---
 runtime/lua/vim/_inspector.lua | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_inspector.lua b/runtime/lua/vim/_inspector.lua
index 05983d3f0d..2ebb7a7efd 100644
--- a/runtime/lua/vim/_inspector.lua
+++ b/runtime/lua/vim/_inspector.lua
@@ -70,15 +70,18 @@ function vim.inspect_pos(bufnr, row, col, filter)
   if filter.treesitter then
     for _, capture in pairs(vim.treesitter.get_captures_at_pos(bufnr, row, col)) do
       capture.hl_group = '@' .. capture.capture .. '.' .. capture.lang
-      table.insert(results.treesitter, resolve_hl(capture))
+      results.treesitter[#results.treesitter + 1] = resolve_hl(capture)
     end
   end
 
   -- syntax
-  if filter.syntax then
-    for _, i1 in ipairs(vim.fn.synstack(row + 1, col + 1)) do
-      table.insert(results.syntax, resolve_hl({ hl_group = vim.fn.synIDattr(i1, 'name') }))
-    end
+  if filter.syntax and vim.api.nvim_buf_is_valid(bufnr) then
+    vim.api.nvim_buf_call(bufnr, function()
+      for _, i1 in ipairs(vim.fn.synstack(row + 1, col + 1)) do
+        results.syntax[#results.syntax + 1] =
+          resolve_hl({ hl_group = vim.fn.synIDattr(i1, 'name') })
+      end
+    end)
   end
 
   -- namespace id -> name map
-- 
cgit 


From b0978fca6b82a061b345df43745c3ab860e02b58 Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Sun, 16 Apr 2023 12:26:13 +0200
Subject: fix(checkhealth): fix crash due to incorrect argument type

---
 runtime/lua/vim/health.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/health.lua b/runtime/lua/vim/health.lua
index 04f8f9695b..ff338b95ea 100644
--- a/runtime/lua/vim/health.lua
+++ b/runtime/lua/vim/health.lua
@@ -266,7 +266,7 @@ function M._check(plugin_names)
       M.error('No healthcheck found for "' .. name .. '" plugin.')
     end
     if type == 'v' then
-      vim.cmd.call(func, {})
+      vim.fn.call(func, {})
     else
       local f = assert(loadstring(func))
       local ok, output = pcall(f)
-- 
cgit 


From 07b60efd8058bb515998f50048b511d50f9671f8 Mon Sep 17 00:00:00 2001
From: Isak Samsten <isak@samsten.se>
Date: Mon, 17 Apr 2023 13:53:34 +0200
Subject: feat(diagnostic): specify diagnostic virtual text prefix as a
 function

- vim.diagnostic.config() now accepts a function for the virtual_text.prefix
  option, which allows for rendering e.g., diagnostic severities differently.
---
 runtime/lua/vim/diagnostic.lua | 18 ++++++++++++++----
 1 file changed, 14 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index d1b50304c7..0d1d01b391 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -600,7 +600,10 @@ end
 ---                                 means to always show the diagnostic source.
 ---                       * spacing: (number) Amount of empty spaces inserted at the beginning
 ---                                  of the virtual text.
----                       * prefix: (string) Prepend diagnostic message with prefix.
+---                       * prefix: (string or function) prepend diagnostic message with prefix.
+---                                 If a function, it must have the signature (diagnostic) -> string,
+---                                 where {diagnostic} is of type |diagnostic-structure|. This can be
+---                                 used to render diagnostic symbols or error codes.
 ---                       * suffix: (string or function) Append diagnostic message with suffix.
 ---                                 If a function, it must have the signature (diagnostic) ->
 ---                                 string, where {diagnostic} is of type |diagnostic-structure|.
@@ -1066,8 +1069,15 @@ function M._get_virt_text_chunks(line_diags, opts)
   -- Create a little more space between virtual text and contents
   local virt_texts = { { string.rep(' ', spacing) } }
 
-  for i = 1, #line_diags - 1 do
-    table.insert(virt_texts, { prefix, virtual_text_highlight_map[line_diags[i].severity] })
+  for i = 1, #line_diags do
+    local resolved_prefix = prefix
+    if type(prefix) == 'function' then
+      resolved_prefix = prefix(line_diags[i]) or ''
+    end
+    table.insert(
+      virt_texts,
+      { resolved_prefix, virtual_text_highlight_map[line_diags[i].severity] }
+    )
   end
   local last = line_diags[#line_diags]
 
@@ -1078,7 +1088,7 @@ function M._get_virt_text_chunks(line_diags, opts)
       suffix = suffix(last) or ''
     end
     table.insert(virt_texts, {
-      string.format('%s %s%s', prefix, last.message:gsub('\r', ''):gsub('\n', '  '), suffix),
+      string.format(' %s%s', last.message:gsub('\r', ''):gsub('\n', '  '), suffix),
       virtual_text_highlight_map[last.severity],
     })
 
-- 
cgit 


From 6cc76011ca28ff61f1c2f8de6d895d4c6d0a1ad8 Mon Sep 17 00:00:00 2001
From: Jon Huhn <nojnhuh@users.noreply.github.com>
Date: Mon, 17 Apr 2023 11:50:05 -0500
Subject: fix(watchfiles): skip Created events when poll starts (#23139)

---
 runtime/lua/vim/_watch.lua | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_watch.lua b/runtime/lua/vim/_watch.lua
index dba1522ec8..dbffd726a2 100644
--- a/runtime/lua/vim/_watch.lua
+++ b/runtime/lua/vim/_watch.lua
@@ -88,6 +88,9 @@ local default_poll_interval_ms = 2000
 ---               be invoked recursively)
 ---     - children (table|nil)
 ---               A mapping of directory entry name to its recursive watches
+--      - started (boolean|nil)
+--                Whether or not the watcher has first been initialized. Used
+--                to prevent a flood of Created events on startup.
 local function poll_internal(path, opts, callback, watches)
   path = vim.fs.normalize(path)
   local interval = opts and opts.interval or default_poll_interval_ms
@@ -112,7 +115,9 @@ local function poll_internal(path, opts, callback, watches)
       end)
     )
     assert(not start_err, start_err)
-    callback(path, M.FileChangeType.Created)
+    if watches.started then
+      callback(path, M.FileChangeType.Created)
+    end
   end
 
   watches.cancel = function()
@@ -132,6 +137,7 @@ local function poll_internal(path, opts, callback, watches)
       if not watches.children[name] then
         watches.children[name] = {
           is_dir = ftype == 'directory',
+          started = watches.started,
         }
         poll_internal(filepath_join(path, name), opts, callback, watches.children[name])
       end
@@ -150,6 +156,8 @@ local function poll_internal(path, opts, callback, watches)
     watches.children = newchildren
   end
 
+  watches.started = true
+
   return watches.cancel
 end
 
-- 
cgit 


From ab1edecfb7c73c82c2d5886cb8e270b44aca7d01 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Mon, 17 Apr 2023 12:54:19 -0600
Subject: feat(lua): add vim.iter (#23029)

vim.iter wraps a table or iterator function into an `Iter` object with
methods such as `filter`, `map`, and `fold` which can be chained to
produce iterator pipelines that do not create new tables at each step.
---
 runtime/lua/vim/iter.lua   | 836 +++++++++++++++++++++++++++++++++++++++++++++
 runtime/lua/vim/shared.lua | 105 ++++++
 2 files changed, 941 insertions(+)
 create mode 100644 runtime/lua/vim/iter.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
new file mode 100644
index 0000000000..b73c03ba9a
--- /dev/null
+++ b/runtime/lua/vim/iter.lua
@@ -0,0 +1,836 @@
+--- Iterator implementation.
+
+---@class Iter
+local Iter = {}
+Iter.__index = Iter
+Iter.__call = function(self)
+  return self:next()
+end
+
+--- Special case implementations for iterators on list tables.
+---@class ListIter : Iter
+---@field _table table Underlying table data (table iterators only)
+---@field _head number Index to the front of a table iterator (table iterators only)
+---@field _tail number Index to the end of a table iterator (table iterators only)
+local ListIter = {}
+ListIter.__index = setmetatable(ListIter, Iter)
+ListIter.__call = function(self)
+  return self:next()
+end
+
+--- Special case implementations for iterators on non-list tables.
+---@class TableIter : Iter
+local TableIter = {}
+TableIter.__index = setmetatable(TableIter, Iter)
+TableIter.__call = function(self)
+  return self:next()
+end
+
+---@private
+local function unpack(t)
+  if type(t) == 'table' then
+    return _G.unpack(t)
+  end
+  return t
+end
+
+---@private
+local function pack(...)
+  if select('#', ...) > 1 then
+    return { ... }
+  end
+  return ...
+end
+
+--- Add a filter step to the iterator pipeline.
+---
+--- Example:
+--- <pre>lua
+--- local bufs = vim.iter(vim.api.nvim_list_bufs()):filter(vim.api.nvim_buf_is_loaded)
+--- </pre>
+---
+---@param f function(...):bool Takes all values returned from the previous stage in the pipeline and
+---                            returns false or nil if the current iterator element should be
+---                            removed.
+---@return Iter
+function Iter.filter(self, f)
+  ---@private
+  local function fn(...)
+    local result = nil
+    if select(1, ...) ~= nil then
+      if not f(...) then
+        return true, nil
+      else
+        result = pack(...)
+      end
+    end
+    return false, result
+  end
+
+  local next = self.next
+  self.next = function(this)
+    local cont, result
+    repeat
+      cont, result = fn(next(this))
+    until not cont
+    return unpack(result)
+  end
+  return self
+end
+
+---@private
+function ListIter.filter(self, f)
+  local inc = self._head < self._tail and 1 or -1
+  local n = self._head
+  for i = self._head, self._tail - inc, inc do
+    local v = self._table[i]
+    if f(unpack(v)) then
+      self._table[n] = v
+      n = n + inc
+    end
+  end
+  self._tail = n
+  return self
+end
+
+--- Add a map step to the iterator pipeline.
+---
+--- If the map function returns nil, the value is filtered from the iterator.
+---
+--- Example:
+--- <pre>lua
+--- local it = vim.iter({ 1, 2, 3, 4 }):map(function(v)
+---   if v % 2 == 0 then
+---     return v * 3
+---   end
+--- end)
+--- it:totable()
+--- -- { 6, 12 }
+--- </pre>
+---
+---@param f function(...):any Mapping function. Takes all values returned from the previous stage
+---                            in the pipeline as arguments and returns one or more new values,
+---                            which are used in the next pipeline stage. Nil return values returned
+---                            are filtered from the output.
+---@return Iter
+function Iter.map(self, f)
+  ---@private
+  local function fn(...)
+    local result = nil
+    if select(1, ...) ~= nil then
+      result = pack(f(...))
+      if result == nil then
+        return true, nil
+      end
+    end
+    return false, result
+  end
+
+  local next = self.next
+  self.next = function(this)
+    local cont, result
+    repeat
+      cont, result = fn(next(this))
+    until not cont
+    return unpack(result)
+  end
+  return self
+end
+
+---@private
+function ListIter.map(self, f)
+  local inc = self._head < self._tail and 1 or -1
+  local n = self._head
+  for i = self._head, self._tail - inc, inc do
+    local v = pack(f(unpack(self._table[i])))
+    if v ~= nil then
+      self._table[n] = v
+      n = n + inc
+    end
+  end
+  self._tail = n
+  return self
+end
+
+--- Call a function once for each item in the pipeline.
+---
+--- This is used for functions which have side effects. To modify the values in the iterator, use
+--- |Iter:map()|.
+---
+--- This function drains the iterator.
+---
+---@param f function(...) Function to execute for each item in the pipeline. Takes all of the
+---                        values returned by the previous stage in the pipeline as arguments.
+function Iter.each(self, f)
+  ---@private
+  local function fn(...)
+    if select(1, ...) ~= nil then
+      f(...)
+      return true
+    end
+  end
+  while fn(self:next()) do
+  end
+end
+
+---@private
+function ListIter.each(self, f)
+  local inc = self._head < self._tail and 1 or -1
+  for i = self._head, self._tail - inc, inc do
+    f(unpack(self._table[i]))
+  end
+  self._head = self._tail
+end
+
+--- Collect the iterator into a table.
+---
+--- The resulting table depends on the initial source in the iterator pipeline. List-like tables
+--- and function iterators will be collected into a list-like table. If multiple values are returned
+--- from the final stage in the iterator pipeline, each value will be included in a table. If a
+--- map-like table was used as the initial source, then a map-like table is returned.
+---
+--- Examples:
+--- <pre>lua
+--- vim.iter(string.gmatch('100 20 50', '%d+')):map(tonumber):totable()
+--- -- { 100, 20, 50 }
+---
+--- vim.iter({ 1, 2, 3 }):map(function(v) return v, 2 * v end):totable()
+--- -- { { 1, 2 }, { 2, 4 }, { 3, 6 } }
+---
+--- vim.iter({ a = 1, b = 2, c = 3 }):filter(function(k, v) return v % 2 ~= 0 end):totable()
+--- -- { a = 1, c = 3 }
+--- </pre>
+---
+---@return table
+function Iter.totable(self)
+  local t = {}
+
+  while true do
+    local args = pack(self:next())
+    if args == nil then
+      break
+    end
+    t[#t + 1] = args
+  end
+  return t
+end
+
+---@private
+function ListIter.totable(self)
+  if self._head == 1 and self._tail == #self._table + 1 and self.next == ListIter.next then
+    return self._table
+  end
+
+  return Iter.totable(self)
+end
+
+---@private
+function TableIter.totable(self)
+  local t = {}
+  for k, v in self do
+    t[k] = v
+  end
+  return t
+end
+
+--- Fold an iterator or table into a single value.
+---
+---@generic A
+---
+---@param init A Initial value of the accumulator.
+---@param f function(acc:A, ...):A Accumulation function.
+---@return A
+function Iter.fold(self, init, f)
+  local acc = init
+
+  --- Use a closure to handle var args returned from iterator
+  ---@private
+  local function fn(...)
+    if select(1, ...) ~= nil then
+      acc = f(acc, ...)
+      return true
+    end
+  end
+
+  while fn(self:next()) do
+  end
+  return acc
+end
+
+---@private
+function ListIter.fold(self, init, f)
+  local acc = init
+  local inc = self._head < self._tail and 1 or -1
+  for i = self._head, self._tail - inc, inc do
+    acc = f(acc, unpack(self._table[i]))
+  end
+  return acc
+end
+
+--- Return the next value from the iterator.
+---
+--- Example:
+--- <pre>lua
+---
+--- local it = vim.iter(string.gmatch('1 2 3', '%d+')):map(tonumber)
+--- it:next()
+--- -- 1
+--- it:next()
+--- -- 2
+--- it:next()
+--- -- 3
+---
+--- </pre>
+---
+---@return any
+function Iter.next(self) -- luacheck: no unused args
+  -- This function is provided by the source iterator in Iter.new. This definition exists only for
+  -- the docstring
+end
+
+---@private
+function ListIter.next(self)
+  if self._head ~= self._tail then
+    local v = self._table[self._head]
+    local inc = self._head < self._tail and 1 or -1
+    self._head = self._head + inc
+    return unpack(v)
+  end
+end
+
+--- Reverse an iterator.
+---
+--- Only supported for iterators on list-like tables.
+---
+--- Example:
+--- <pre>lua
+---
+--- local it = vim.iter({ 3, 6, 9, 12 }):rev()
+--- it:totable()
+--- -- { 12, 9, 6, 3 }
+---
+--- </pre>
+---
+---@return Iter
+function Iter.rev(self)
+  error('rev() requires a list-like table')
+  return self
+end
+
+---@private
+function ListIter.rev(self)
+  local inc = self._head < self._tail and 1 or -1
+  self._head, self._tail = self._tail - inc, self._head - inc
+  return self
+end
+
+--- Peek at the next value in the iterator without consuming it.
+---
+--- Only supported for iterators on list-like tables.
+---
+--- Example:
+--- <pre>lua
+---
+--- local it = vim.iter({ 3, 6, 9, 12 })
+--- it:peek()
+--- -- 3
+--- it:peek()
+--- -- 3
+--- it:next()
+--- -- 3
+---
+--- </pre>
+---
+---@return any
+function Iter.peek(self) -- luacheck: no unused args
+  error('peek() requires a list-like table')
+end
+
+---@private
+function ListIter.peek(self)
+  if self._head ~= self._tail then
+    return self._table[self._head]
+  end
+end
+
+--- Find the first value in the iterator that satisfies the given predicate.
+---
+--- Advances the iterator. Returns nil and drains the iterator if no value is found.
+---
+--- Examples:
+--- <pre>lua
+---
+--- local it = vim.iter({ 3, 6, 9, 12 })
+--- it:find(12)
+--- -- 12
+---
+--- local it = vim.iter({ 3, 6, 9, 12 })
+--- it:find(20)
+--- -- nil
+---
+--- local it = vim.iter({ 3, 6, 9, 12 })
+--- it:find(function(v) return v % 4 == 0 end)
+--- -- 12
+---
+--- </pre>
+---
+---@return any
+function Iter.find(self, f)
+  if type(f) ~= 'function' then
+    local val = f
+    f = function(v)
+      return v == val
+    end
+  end
+
+  local result = nil
+
+  --- Use a closure to handle var args returned from iterator
+  ---@private
+  local function fn(...)
+    if select(1, ...) ~= nil then
+      if f(...) then
+        result = pack(...)
+      else
+        return true
+      end
+    end
+  end
+
+  while fn(self:next()) do
+  end
+  return unpack(result)
+end
+
+--- Find the first value in the iterator that satisfies the given predicate, starting from the end.
+---
+--- Advances the iterator. Returns nil and drains the iterator if no value is found.
+---
+--- Only supported for iterators on list-like tables.
+---
+--- Examples:
+--- <pre>lua
+---
+--- local it = vim.iter({ 1, 2, 3, 2, 1 }):enumerate()
+--- it:rfind(1)
+--- -- 5	1
+--- it:rfind(1)
+--- -- 1	1
+---
+--- </pre>
+---
+---@see Iter.find
+---
+---@return any
+function Iter.rfind(self, f) -- luacheck: no unused args
+  error('rfind() requires a list-like table')
+end
+
+---@private
+function ListIter.rfind(self, f) -- luacheck: no unused args
+  if type(f) ~= 'function' then
+    local val = f
+    f = function(v)
+      return v == val
+    end
+  end
+
+  local inc = self._head < self._tail and 1 or -1
+  for i = self._tail - inc, self._head, -inc do
+    local v = self._table[i]
+    if f(unpack(v)) then
+      self._tail = i
+      return unpack(v)
+    end
+  end
+  self._head = self._tail
+end
+
+--- Return the next value from the end of the iterator.
+---
+--- Only supported for iterators on list-like tables.
+---
+--- Example:
+--- <pre>lua
+--- local it = vim.iter({1, 2, 3, 4})
+--- it:nextback()
+--- -- 4
+--- it:nextback()
+--- -- 3
+--- </pre>
+---
+---@return any
+function Iter.nextback(self) -- luacheck: no unused args
+  error('nextback() requires a list-like table')
+end
+
+function ListIter.nextback(self)
+  if self._head ~= self._tail then
+    local inc = self._head < self._tail and 1 or -1
+    self._tail = self._tail - inc
+    return self._table[self._tail]
+  end
+end
+
+--- Return the next value from the end of the iterator without consuming it.
+---
+--- Only supported for iterators on list-like tables.
+---
+--- Example:
+--- <pre>lua
+--- local it = vim.iter({1, 2, 3, 4})
+--- it:peekback()
+--- -- 4
+--- it:peekback()
+--- -- 4
+--- it:nextback()
+--- -- 4
+--- </pre>
+---
+---@return any
+function Iter.peekback(self) -- luacheck: no unused args
+  error('peekback() requires a list-like table')
+end
+
+function ListIter.peekback(self)
+  if self._head ~= self._tail then
+    local inc = self._head < self._tail and 1 or -1
+    return self._table[self._tail - inc]
+  end
+end
+
+--- Skip values in the iterator.
+---
+--- Example:
+--- <pre>lua
+---
+--- local it = vim.iter({ 3, 6, 9, 12 }):skip(2)
+--- it:next()
+--- -- 9
+---
+--- </pre>
+---
+---@param n number Number of values to skip.
+---@return Iter
+function Iter.skip(self, n)
+  for _ = 1, n do
+    local _ = self:next()
+  end
+  return self
+end
+
+---@private
+function ListIter.skip(self, n)
+  local inc = self._head < self._tail and n or -n
+  self._head = self._head + inc
+  if (inc > 0 and self._head > self._tail) or (inc < 0 and self._head < self._tail) then
+    self._head = self._tail
+  end
+  return self
+end
+
+--- Skip values in the iterator starting from the end.
+---
+--- Only supported for iterators on list-like tables.
+---
+--- Example:
+--- <pre>lua
+--- local it = vim.iter({ 1, 2, 3, 4, 5 }):skipback(2)
+--- it:next()
+--- -- 1
+--- it:nextback()
+--- -- 3
+--- </pre>
+---
+---@param n number Number of values to skip.
+---@return Iter
+function Iter.skipback(self, n) -- luacheck: no unused args
+  error('skipback() requires a list-like table')
+  return self
+end
+
+---@private
+function ListIter.skipback(self, n)
+  local inc = self._head < self._tail and n or -n
+  self._tail = self._tail - inc
+  if (inc > 0 and self._head > self._tail) or (inc < 0 and self._head < self._tail) then
+    self._head = self._tail
+  end
+  return self
+end
+
+--- Return the nth value in the iterator.
+---
+--- This function advances the iterator.
+---
+--- Example:
+--- <pre>lua
+---
+--- local it = vim.iter({ 3, 6, 9, 12 })
+--- it:nth(2)
+--- -- 6
+--- it:nth(2)
+--- -- 12
+---
+--- </pre>
+---
+---@param n number The index of the value to return.
+---@return any
+function Iter.nth(self, n)
+  if n > 0 then
+    return self:skip(n - 1):next()
+  end
+end
+
+--- Return the nth value from the end of the iterator.
+---
+--- This function advances the iterator.
+---
+--- Only supported for iterators on list-like tables.
+---
+--- Example:
+--- <pre>lua
+---
+--- local it = vim.iter({ 3, 6, 9, 12 })
+--- it:nthback(2)
+--- -- 9
+--- it:nthback(2)
+--- -- 3
+---
+--- </pre>
+---
+---@param n number The index of the value to return.
+---@return any
+function Iter.nthback(self, n)
+  if n > 0 then
+    return self:skipback(n - 1):nextback()
+  end
+end
+
+--- Slice an iterator, changing its start and end positions.
+---
+--- This is equivalent to :skip(first - 1):skipback(len - last + 1)
+---
+--- Only supported for iterators on list-like tables.
+---
+---@param first number
+---@param last number
+---@return Iter
+function Iter.slice(self, first, last) -- luacheck: no unused args
+  return self:skip(math.max(0, first - 1)):skipback(math.max(0, self._tail - last - 1))
+end
+
+--- Return true if any of the items in the iterator match the given predicate.
+---
+---@param pred function(...):bool Predicate function. Takes all values returned from the previous
+---                                stage in the pipeline as arguments and returns true if the
+---                                predicate matches.
+function Iter.any(self, pred)
+  local any = false
+
+  --- Use a closure to handle var args returned from iterator
+  ---@private
+  local function fn(...)
+    if select(1, ...) ~= nil then
+      if pred(...) then
+        any = true
+      else
+        return true
+      end
+    end
+  end
+
+  while fn(self:next()) do
+  end
+  return any
+end
+
+--- Return true if all of the items in the iterator match the given predicate.
+---
+---@param pred function(...):bool Predicate function. Takes all values returned from the previous
+---                                stage in the pipeline as arguments and returns true if the
+---                                predicate matches.
+function Iter.all(self, pred)
+  local all = true
+
+  ---@private
+  local function fn(...)
+    if select(1, ...) ~= nil then
+      if not pred(...) then
+        all = false
+      else
+        return true
+      end
+    end
+  end
+
+  while fn(self:next()) do
+  end
+  return all
+end
+
+--- Return the last item in the iterator.
+---
+--- Drains the iterator.
+---
+--- Example:
+--- <pre>lua
+---
+--- local it = vim.iter(vim.gsplit('abcdefg', ''))
+--- it:last()
+--- -- 'g'
+---
+--- local it = vim.iter({ 3, 6, 9, 12, 15 })
+--- it:last()
+--- -- 15
+---
+--- </pre>
+---
+---@return any
+function Iter.last(self)
+  local last = self:next()
+  local cur = self:next()
+  while cur do
+    last = cur
+    cur = self:next()
+  end
+  return last
+end
+
+---@private
+function ListIter.last(self)
+  local inc = self._head < self._tail and 1 or -1
+  local v = self._table[self._tail - inc]
+  self._head = self._tail
+  return v
+end
+
+--- Add an iterator stage that returns the current iterator count as well as the iterator value.
+---
+--- For list tables, prefer
+--- <pre>lua
+--- vim.iter(ipairs(t))
+--- </pre>
+---
+--- over
+---
+--- <pre>lua
+--- vim.iter(t):enumerate()
+--- </pre>
+---
+--- as the former is faster.
+---
+--- Example:
+--- <pre>lua
+---
+--- local it = vim.iter(vim.gsplit('abc', '')):enumerate()
+--- it:next()
+--- -- 1	'a'
+--- it:next()
+--- -- 2	'b'
+--- it:next()
+--- -- 3	'c'
+---
+--- </pre>
+---
+---@return Iter
+function Iter.enumerate(self)
+  local i = 0
+  return self:map(function(...)
+    i = i + 1
+    return i, ...
+  end)
+end
+
+---@private
+function ListIter.enumerate(self)
+  local inc = self._head < self._tail and 1 or -1
+  for i = self._head, self._tail - inc, inc do
+    local v = self._table[i]
+    self._table[i] = { i, v }
+  end
+  return self
+end
+
+--- Create a new Iter object from a table or iterator.
+---
+---@param src table|function Table or iterator to drain values from
+---@return Iter
+function Iter.new(src, ...)
+  local it = {}
+  if type(src) == 'table' then
+    local t = {}
+
+    -- Check if source table can be treated like a list (indices are consecutive integers
+    -- starting from 1)
+    local count = 0
+    for _ in pairs(src) do
+      count = count + 1
+      local v = src[count]
+      if v == nil then
+        return TableIter.new(src)
+      end
+      t[count] = v
+    end
+    return ListIter.new(t)
+  end
+
+  if type(src) == 'function' then
+    local s, var = ...
+
+    --- Use a closure to handle var args returned from iterator
+    ---@private
+    local function fn(...)
+      if select(1, ...) ~= nil then
+        var = select(1, ...)
+        return ...
+      end
+    end
+
+    function it.next()
+      return fn(src(s, var))
+    end
+
+    setmetatable(it, Iter)
+  else
+    error('src must be a table or function')
+  end
+  return it
+end
+
+--- Create a new ListIter
+---
+---@param t table List-like table. Caller guarantees that this table is a valid list.
+---@return Iter
+---@private
+function ListIter.new(t)
+  local it = {}
+  it._table = t
+  it._head = 1
+  it._tail = #t + 1
+  setmetatable(it, ListIter)
+  return it
+end
+
+--- Create a new TableIter
+---
+---@param t table Table to iterate over. For list-like tables, use ListIter.new instead.
+---@return Iter
+---@private
+function TableIter.new(t)
+  local it = {}
+
+  local index = nil
+  function it.next()
+    local k, v = next(t, index)
+    if k ~= nil then
+      index = k
+      return k, v
+    end
+  end
+
+  setmetatable(it, TableIter)
+  return it
+end
+
+return Iter
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index f700f4a6b3..1a96ef9bc4 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -884,4 +884,109 @@ function vim.defaulttable(create)
   })
 end
 
+--- Create an Iter |lua-iter| object from a table or iterator.
+---
+--- The input value can be a table  or a function iterator (see |luaref-in|).
+---
+--- This function wraps the input value into an interface which allows chaining
+--- multiple pipeline stages in an efficient manner. Each pipeline stage
+--- receives as input the output values from the prior stage. The values used in
+--- the first stage of the pipeline depend on the type passed to this function:
+---
+--- - List tables pass only the value of each element
+--- - Non-list tables pass both the key and value of each element
+--- - Function iterators pass all of the values returned by their respective
+---   function
+---
+--- Examples:
+--- <pre>lua
+--- local it = vim.iter({ 1, 2, 3, 4, 5 })
+--- it:map(function(v)
+---   return v * 3
+--- end)
+--- it:rev()
+--- it:skip(2)
+--- it:totable()
+--- -- { 9, 6, 3 }
+---
+--- vim.iter(ipairs({ 1, 2, 3, 4, 5 })):map(function(i, v)
+---   if i > 2 then return v end
+--- end):totable()
+--- -- { 3, 4, 5 }
+---
+--- local it = vim.iter(vim.gsplit('1,2,3,4,5', ','))
+--- it:map(function(s) return tonumber(s) end)
+--- for i, d in it:enumerate() do
+---   print(string.format("Column %d is %d", i, d))
+--- end
+--- -- Column 1 is 1
+--- -- Column 2 is 2
+--- -- Column 3 is 3
+--- -- Column 4 is 4
+--- -- Column 5 is 5
+---
+--- vim.iter({ a = 1, b = 2, c = 3, z = 26 }):any(function(k, v)
+---   return k == 'z'
+--- end)
+--- -- true
+--- </pre>
+---
+---@see |lua-iter|
+---
+---@param src table|function Table or iterator.
+---@return Iter @|lua-iter|
+function vim.iter(src, ...)
+  local Iter = require('vim.iter')
+  return Iter.new(src, ...)
+end
+
+--- Collect an iterator into a table.
+---
+--- This is a convenience function that performs:
+--- <pre>lua
+--- vim.iter(f):totable()
+--- </pre>
+---
+---@param f function Iterator function
+---@return table
+function vim.totable(f, ...)
+  return vim.iter(f, ...):totable()
+end
+
+--- Filter a table or iterator.
+---
+--- This is a convenience function that performs:
+--- <pre>lua
+--- vim.iter(src):filter(f):totable()
+--- </pre>
+---
+---@see |Iter:filter()|
+---
+---@param f function(...):bool Filter function. Accepts the current iterator or table values as
+---                            arguments and returns true if those values should be kept in the
+---                            final table
+---@param src table|function Table or iterator function to filter
+---@return table
+function vim.filter(f, src, ...)
+  return vim.iter(src, ...):filter(f):totable()
+end
+
+--- Map and filter a table or iterator.
+---
+--- This is a convenience function that performs:
+--- <pre>lua
+--- vim.iter(src):map(f):totable()
+--- </pre>
+---
+---@see |Iter:map()|
+---
+---@param f function(...):?any Map function. Accepts the current iterator or table values as
+---                            arguments and returns one or more new values. Nil values are removed
+---                            from the final table.
+---@param src table|function Table or iterator function to filter
+---@return table
+function vim.map(f, src, ...)
+  return vim.iter(src, ...):map(f):totable()
+end
+
 return vim
-- 
cgit 


From 6d9f5b6bf0fc324b33ce01f74a6030c9271b1a01 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 19 Apr 2023 09:41:26 +0200
Subject: vim-patch:9.0.1464: strace filetype detection is expensive (#23175)

Problem:    Strace filetype detection is expensive.
Solution:   Match with a cheap pattern first. (Federico Mengozzi,
            closes vim/vim#12220)

https://github.com/vim/vim/commit/6e5a9f948221b52caaaf106079cb3430c4dd7c77

Co-authored-by: Federico Mengozzi <19249682+fedemengo@users.noreply.github.com>
---
 runtime/lua/vim/filetype/detect.lua | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index d1eabadc4a..94114ae7c3 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -1550,8 +1550,15 @@ local patterns_text = {
   ['^SNNS pattern definition file'] = 'snnspat',
   ['^SNNS result file'] = 'snnsres',
   ['^%%.-[Vv]irata'] = { 'virata', { start_lnum = 1, end_lnum = 5 } },
-  ['[0-9:%.]* *execve%('] = 'strace',
-  ['^__libc_start_main'] = 'strace',
+  function(lines)
+    if
+      -- inaccurate fast match first, then use accurate slow match
+      (lines[1]:find('execve%(') and lines[1]:find('^[0-9:%.]* *execve%('))
+      or lines[1]:find('^__libc_start_main')
+    then
+      return 'strace'
+    end
+  end,
   -- VSE JCL
   ['^\\* $$ JOB\\>'] = { 'vsejcl', { vim_regex = true } },
   ['^// *JOB\\>'] = { 'vsejcl', { vim_regex = true } },
-- 
cgit 


From cff02e993d920fa4bf0b5dc8b8f12d979850f049 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 19 Apr 2023 10:19:33 +0200
Subject: vim-patch:9.0.1467: Jenkinsfiles are not recognized as groovy
 (#23195)

Problem:    Jenkinsfiles are not recognized as groovy.
Solution:   Add a pattern for Jenkinsfiles. (closes vim/vim#12236)

https://github.com/vim/vim/commit/142ffb024dd5123090c2fd02f55702e76520f1df

Co-authored-by: dundargoc <gocdundar@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 74ab7d8260..6cfe6e6c35 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1469,6 +1469,7 @@ local filename = {
   ['.gprc'] = 'gp',
   ['/.gnupg/gpg.conf'] = 'gpg',
   ['/.gnupg/options'] = 'gpg',
+  ['Jenkinsfile'] = 'groovy',
   ['/var/backups/gshadow.bak'] = 'group',
   ['/etc/gshadow'] = 'group',
   ['/etc/group-'] = 'group',
-- 
cgit 


From 6b96122453fda22dc44a581af1d536988c1adf41 Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Wed, 19 Apr 2023 06:45:56 -0600
Subject: fix(iter): add tag to packed table

If pack() is called with a single value, it does not create a table; it
simply returns the value it is passed. When unpack is called with a
table argument, it interprets that table as a list of values that were
packed together into a table.

This causes a problem when the single value being packed is _itself_ a
table. pack() will not place it into another table, but unpack() sees
the table argument and tries to unpack it.

To fix this, we add a simple "tag" to packed table values so that
unpack() only attempts to unpack tables that have this tag. Other tables
are left alone. The tag is simply the length of the table.
---
 runtime/lua/vim/iter.lua | 25 ++++++++++++++++++++-----
 1 file changed, 20 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index b73c03ba9a..fff7644b6a 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -28,16 +28,17 @@ end
 
 ---@private
 local function unpack(t)
-  if type(t) == 'table' then
-    return _G.unpack(t)
+  if type(t) == 'table' and t.__n ~= nil then
+    return _G.unpack(t, 1, t.__n)
   end
   return t
 end
 
 ---@private
 local function pack(...)
-  if select('#', ...) > 1 then
-    return { ... }
+  local n = select('#', ...)
+  if n > 1 then
+    return { __n = n, ... }
   end
   return ...
 end
@@ -210,6 +211,12 @@ function Iter.totable(self)
     if args == nil then
       break
     end
+
+    if type(args) == 'table' then
+      -- Removed packed table tag if it exists
+      args.__n = nil
+    end
+
     t[#t + 1] = args
   end
   return t
@@ -218,6 +225,14 @@ end
 ---@private
 function ListIter.totable(self)
   if self._head == 1 and self._tail == #self._table + 1 and self.next == ListIter.next then
+    -- Remove any packed table tags
+    for i = 1, #self._table do
+      local v = self._table[i]
+      if type(v) == 'table' then
+        v.__n = nil
+        self._table[i] = v
+      end
+    end
     return self._table
   end
 
@@ -747,7 +762,7 @@ function ListIter.enumerate(self)
   local inc = self._head < self._tail and 1 or -1
   for i = self._head, self._tail - inc, inc do
     local v = self._table[i]
-    self._table[i] = { i, v }
+    self._table[i] = pack(i, v)
   end
   return self
 end
-- 
cgit 


From 94894068794dbb99804cda689b6c37e70376c8ca Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Wed, 19 Apr 2023 07:05:04 -0600
Subject: fix(iter): remove special case totable for map-like tables

This was originally meant as a convenience but prevents possible
functionality. For example:

  -- Get the keys of the table with even values
  local t = { a = 1, b = 2, c = 3, d = 4 }
  vim.iter(t):map(function(k, v)
    if v % 2 == 0 then return k end
  end):totable()

The example above would not work, because the map() function returns
only a single value, and cannot be converted back into a table (there
are many such examples like this).

Instead, to convert an iterator into a map-like table, users can use
fold():

  vim.iter(t):fold({}, function(t, k, v)
    t[k] = v
    return t
  end)
---
 runtime/lua/vim/iter.lua | 67 +++++++++++++++++-------------------------------
 1 file changed, 23 insertions(+), 44 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index fff7644b6a..c5d5ef835b 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -18,14 +18,6 @@ ListIter.__call = function(self)
   return self:next()
 end
 
---- Special case implementations for iterators on non-list tables.
----@class TableIter : Iter
-local TableIter = {}
-TableIter.__index = setmetatable(TableIter, Iter)
-TableIter.__call = function(self)
-  return self:next()
-end
-
 ---@private
 local function unpack(t)
   if type(t) == 'table' and t.__n ~= nil then
@@ -185,10 +177,10 @@ end
 
 --- Collect the iterator into a table.
 ---
---- The resulting table depends on the initial source in the iterator pipeline. List-like tables
---- and function iterators will be collected into a list-like table. If multiple values are returned
---- from the final stage in the iterator pipeline, each value will be included in a table. If a
---- map-like table was used as the initial source, then a map-like table is returned.
+--- The resulting table depends on the initial source in the iterator pipeline.
+--- List-like tables and function iterators will be collected into a list-like
+--- table. If multiple values are returned from the final stage in the iterator
+--- pipeline, each value will be included in a table.
 ---
 --- Examples:
 --- <pre>lua
@@ -199,9 +191,13 @@ end
 --- -- { { 1, 2 }, { 2, 4 }, { 3, 6 } }
 ---
 --- vim.iter({ a = 1, b = 2, c = 3 }):filter(function(k, v) return v % 2 ~= 0 end):totable()
---- -- { a = 1, c = 3 }
+--- -- { { 'a', 1 }, { 'c', 3 } }
 --- </pre>
 ---
+--- The generated table is a list-like table with consecutive, numeric indices.
+--- To create a map-like table with arbitrary keys, use |Iter:fold()|.
+---
+---
 ---@return table
 function Iter.totable(self)
   local t = {}
@@ -239,17 +235,21 @@ function ListIter.totable(self)
   return Iter.totable(self)
 end
 
----@private
-function TableIter.totable(self)
-  local t = {}
-  for k, v in self do
-    t[k] = v
-  end
-  return t
-end
-
 --- Fold an iterator or table into a single value.
 ---
+--- Examples:
+--- <pre>
+--- -- Create a new table with only even values
+--- local t = { a = 1, b = 2, c = 3, d = 4 }
+--- local it = vim.iter(t)
+--- it:filter(function(k, v) return v % 2 == 0 end)
+--- it:fold({}, function(t, k, v)
+---   t[k] = v
+---   return t
+--- end)
+--- -- { b = 2, d = 4 }
+--- </pre>
+---
 ---@generic A
 ---
 ---@param init A Initial value of the accumulator.
@@ -783,7 +783,7 @@ function Iter.new(src, ...)
       count = count + 1
       local v = src[count]
       if v == nil then
-        return TableIter.new(src)
+        return Iter.new(pairs(src))
       end
       t[count] = v
     end
@@ -827,25 +827,4 @@ function ListIter.new(t)
   return it
 end
 
---- Create a new TableIter
----
----@param t table Table to iterate over. For list-like tables, use ListIter.new instead.
----@return Iter
----@private
-function TableIter.new(t)
-  local it = {}
-
-  local index = nil
-  function it.next()
-    local k, v = next(t, index)
-    if k ~= nil then
-      index = k
-      return k, v
-    end
-  end
-
-  setmetatable(it, TableIter)
-  return it
-end
-
 return Iter
-- 
cgit 


From ab2811746eb72e06309a9877dbe6cb70d9cd3b12 Mon Sep 17 00:00:00 2001
From: William <50717946+BIKA-C@users.noreply.github.com>
Date: Thu, 20 Apr 2023 06:42:49 -0700
Subject: fix(treesitter playground): fix the wrong range of a node displayed
 i… (#23209)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

fix(treesitter playground): wrong range of a node displayed in playground

The call parameters order of the function `get_range_str` is flipped for the last two arguments compared to the declaration.
---
 runtime/lua/vim/treesitter/playground.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/playground.lua b/runtime/lua/vim/treesitter/playground.lua
index 2c0a0d1aa6..c512710810 100644
--- a/runtime/lua/vim/treesitter/playground.lua
+++ b/runtime/lua/vim/treesitter/playground.lua
@@ -147,7 +147,7 @@ local decor_ns = api.nvim_create_namespace('ts.playground')
 ---@param end_lnum integer
 ---@param end_col integer
 ---@return string
-local function get_range_str(lnum, col, end_col, end_lnum)
+local function get_range_str(lnum, col, end_lnum, end_col)
   if lnum == end_lnum then
     return string.format('[%d:%d - %d]', lnum + 1, col + 1, end_col)
   end
-- 
cgit 


From 622b1ae38a36c3d26fad19faa788d622f7835921 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Fri, 21 Apr 2023 06:46:18 +0200
Subject: fix(lua): vim.split may trim inner empty items

Problem:
`vim.split('a:::', ':', {trimempty=true})` trims inner empty items.
Regression from 9c49c1047079427ff0a2356cb37302934845108e

Solution:
Set `empty_start=false` when first non-empty item is found.
close #23212
---
 runtime/lua/vim/shared.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 1a96ef9bc4..08f8afd087 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -138,7 +138,9 @@ function vim.gsplit(s, sep, opts)
     local seg = _pass(s:find(sep, start, plain))
 
     -- Trim empty segments from start/end.
-    if trimempty and seg == '' then
+    if seg ~= '' then
+      empty_start = false
+    elseif trimempty then
       while not done and seg == '' do
         empty_segs = empty_segs + 1
         seg = _pass(s:find(sep, start, plain))
-- 
cgit 


From 824766612d4e7d53b717bd1e2b0d1d895054accd Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Fri, 21 Apr 2023 07:26:44 +0200
Subject: refactor(lua): simplify vim.gsplit impl

---
 runtime/lua/vim/shared.lua | 31 +++++++++++++------------------
 1 file changed, 13 insertions(+), 18 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 08f8afd087..5f4ea8822b 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -100,10 +100,9 @@ function vim.gsplit(s, sep, opts)
   local start = 1
   local done = false
 
-  -- For `trimempty`:
+  -- For `trimempty`: queue of collected segments, to be emitted at next pass.
+  local segs = {}
   local empty_start = true -- Only empty segments seen so far.
-  local empty_segs = 0 -- Empty segments found between non-empty segments.
-  local nonemptyseg = nil
 
   local function _pass(i, j, ...)
     if i then
@@ -118,14 +117,9 @@ function vim.gsplit(s, sep, opts)
   end
 
   return function()
-    if trimempty and empty_segs > 0 then
-      -- trimempty: Pop the collected empty segments.
-      empty_segs = empty_segs - 1
-      return ''
-    elseif trimempty and nonemptyseg then
-      local seg = nonemptyseg
-      nonemptyseg = nil
-      return seg
+    if trimempty and #segs > 0 then
+      -- trimempty: Pop the collected segments.
+      return table.remove(segs)
     elseif done or (s == '' and sep == '') then
       return nil
     elseif sep == '' then
@@ -138,23 +132,24 @@ function vim.gsplit(s, sep, opts)
     local seg = _pass(s:find(sep, start, plain))
 
     -- Trim empty segments from start/end.
-    if seg ~= '' then
+    if trimempty and seg ~= '' then
       empty_start = false
-    elseif trimempty then
+    elseif trimempty and seg == '' then
       while not done and seg == '' do
-        empty_segs = empty_segs + 1
+        table.insert(segs, 1, '')
         seg = _pass(s:find(sep, start, plain))
       end
       if done and seg == '' then
         return nil
       elseif empty_start then
         empty_start = false
-        empty_segs = 0
+        segs = {}
         return seg
       end
-      nonemptyseg = seg ~= '' and seg or nil
-      seg = ''
-      empty_segs = empty_segs - 1
+      if seg ~= '' then
+        table.insert(segs, 1, seg)
+      end
+      return table.remove(segs)
     end
 
     return seg
-- 
cgit 


From f68af3c3bc92c12f7dbbd32f44df8ab57a58ac98 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Fri, 21 Apr 2023 16:13:39 -0600
Subject: refactor(iter): use metatable as packed table tag (#23254)

This is a more robust method for tagging a packed table as it completely
eliminates the possibility of mistaking an actual table key as the
packed table tag.
---
 runtime/lua/vim/iter.lua | 35 ++++++++++++++++++++---------------
 1 file changed, 20 insertions(+), 15 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index c5d5ef835b..2545853b41 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -18,10 +18,13 @@ ListIter.__call = function(self)
   return self:next()
 end
 
+--- Packed tables use this as their metatable
+local packedmt = {}
+
 ---@private
 local function unpack(t)
-  if type(t) == 'table' and t.__n ~= nil then
-    return _G.unpack(t, 1, t.__n)
+  if getmetatable(t) == packedmt then
+    return _G.unpack(t, 1, t.n)
   end
   return t
 end
@@ -30,11 +33,20 @@ end
 local function pack(...)
   local n = select('#', ...)
   if n > 1 then
-    return { __n = n, ... }
+    return setmetatable({ n = n, ... }, packedmt)
   end
   return ...
 end
 
+---@private
+local function sanitize(t)
+  if getmetatable(t) == packedmt then
+    -- Remove length tag
+    t.n = nil
+  end
+  return t
+end
+
 --- Add a filter step to the iterator pipeline.
 ---
 --- Example:
@@ -208,12 +220,7 @@ function Iter.totable(self)
       break
     end
 
-    if type(args) == 'table' then
-      -- Removed packed table tag if it exists
-      args.__n = nil
-    end
-
-    t[#t + 1] = args
+    t[#t + 1] = sanitize(args)
   end
   return t
 end
@@ -221,12 +228,10 @@ end
 ---@private
 function ListIter.totable(self)
   if self._head == 1 and self._tail == #self._table + 1 and self.next == ListIter.next then
-    -- Remove any packed table tags
-    for i = 1, #self._table do
-      local v = self._table[i]
-      if type(v) == 'table' then
-        v.__n = nil
-        self._table[i] = v
+    -- Sanitize packed table values
+    if getmetatable(self._table[1]) == packedmt then
+      for i = 1, #self._table do
+        self._table[i] = sanitize(self._table[i])
       end
     end
     return self._table
-- 
cgit 


From e9b85acfbb8d3b1dd6f92deb187800be757c6c68 Mon Sep 17 00:00:00 2001
From: Jon Huhn <nojnhuh@users.noreply.github.com>
Date: Sat, 22 Apr 2023 02:37:38 -0500
Subject: feat(lsp): enable workspace/didChangeWatchedFiles by default (#23190)

---
 runtime/lua/vim/lsp/protocol.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 2cb8fc7955..a7919f12f5 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -837,7 +837,7 @@ function protocol.make_client_capabilities()
         refreshSupport = true,
       },
       didChangeWatchedFiles = {
-        dynamicRegistration = false,
+        dynamicRegistration = true,
         relativePatternSupport = true,
       },
     },
-- 
cgit 


From 1cb46abff1e903e999105b244329f22678ba8a30 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sat, 22 Apr 2023 23:51:53 +0800
Subject: vim-patch:9.0.1475: busted configuration files are not recognized
 (#23266)

Problem:    Busted configuration files are not recognized.
Solution:   Recognize busted configuration files as Lua. (Craig MacEachern,
            closes vim/vim#12209)

Co-authored-by: C.D. MacEachern <craig.daniel.maceachern@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 6cfe6e6c35..cbd9aa640b 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1522,6 +1522,7 @@ local filename = {
   ['.lsl'] = function(path, bufnr)
     return require('vim.filetype.detect').lsl(bufnr)
   end,
+  ['.busted'] = 'lua',
   ['.luacheckrc'] = 'lua',
   ['lynx.cfg'] = 'lynx',
   ['m3overrides'] = 'm3build',
-- 
cgit 


From f17bb4f41102ecec7989bc4c14c626dc595e2f0b Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sun, 23 Apr 2023 14:15:52 +0200
Subject: vim-patch:9.0.1478: filetypes for *.v files not detected properly
 (#23282)

* vim-patch:9.0.1478: filetypes for *.v files not detected properly

Problem:    Filetypes for *.v files not detected properly.
Solution:   Use the file contents to detect the filetype. (Turiiya,
            closes vim/vim#12281)

https://github.com/vim/vim/commit/80406c26188219f3773b2e9c49160caeeb386ee2

Co-authored-by: Turiiya <34311583+tobealive@users.noreply.github.com>
Co-authored-by: Jonas Strittmatter <40792180+smjonas@users.noreply.github.com>
---
 runtime/lua/vim/filetype.lua        |  4 +++-
 runtime/lua/vim/filetype/detect.lua | 18 ++++++++++++++++++
 2 files changed, 21 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index cbd9aa640b..4fafc4e2e2 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1091,7 +1091,9 @@ local extension = {
   vr = 'vera',
   vri = 'vera',
   vrh = 'vera',
-  v = 'verilog',
+  v = function(path, bufnr)
+    return require('vim.filetype.detect').v(bufnr)
+  end,
   va = 'verilogams',
   vams = 'verilogams',
   vhdl = 'vhdl',
diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index 94114ae7c3..74b01d569c 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -1322,6 +1322,24 @@ function M.txt(bufnr)
   end
 end
 
+-- Determine if a .v file is Verilog, V, or Coq
+function M.v(bufnr)
+  if vim.fn.did_filetype() ~= 0 then
+    -- Filetype was already detected
+    return
+  end
+  for _, line in ipairs(getlines(bufnr, 1, 200)) do
+    if not line:find('^%s*/') then
+      if findany(line, { ';%s*$', ';%s*/' }) then
+        return 'verilog'
+      elseif findany(line, { '%.%s*$', '%.%s*%(%*' }) then
+        return 'coq'
+      end
+    end
+  end
+  return 'v'
+end
+
 -- WEB (*.web is also used for Winbatch: Guess, based on expecting "%" comment
 -- lines in a WEB file).
 function M.web(bufnr)
-- 
cgit 


From 1e73891d696a00b046ab19d245001424b174c931 Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Mon, 24 Apr 2023 19:57:40 -0600
Subject: refactor(iter): move helper functions under vim.iter

vim.iter is now both a function and a module (similar to vim.version).
---
 runtime/lua/vim/_init_packages.lua |   1 +
 runtime/lua/vim/iter.lua           | 112 ++++++++++++++++++++++++++++++++++++-
 runtime/lua/vim/shared.lua         | 105 ----------------------------------
 3 files changed, 110 insertions(+), 108 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_init_packages.lua b/runtime/lua/vim/_init_packages.lua
index 2cf2e91a8c..5db258c011 100644
--- a/runtime/lua/vim/_init_packages.lua
+++ b/runtime/lua/vim/_init_packages.lua
@@ -55,6 +55,7 @@ vim._submodules = {
   inspect = true,
   version = true,
   fs = true,
+  iter = true,
 }
 
 -- These are for loading runtime modules in the vim namespace lazily.
diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index 2545853b41..c2e2c5bd9f 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -1,4 +1,56 @@
---- Iterator implementation.
+---@defgroup lua-iter
+---
+--- The \*vim.iter\* module provides a generic "iterator" interface over tables and iterator
+--- functions.
+---
+--- \*vim.iter()\* wraps its table or function argument into an \*Iter\* object with methods (such
+--- as |Iter:filter()| and |Iter:map()|) that transform the underlying source data. These methods
+--- can be chained together to create iterator "pipelines". Each pipeline stage receives as input
+--- the output values from the prior stage. The values used in the first stage of the pipeline
+--- depend on the type passed to this function:
+---
+--- - List tables pass only the value of each element
+--- - Non-list tables pass both the key and value of each element
+--- - Function iterators pass all of the values returned by their respective
+---   function
+---
+--- Examples:
+--- <pre>lua
+---   local it = vim.iter({ 1, 2, 3, 4, 5 })
+---   it:map(function(v)
+---     return v * 3
+---   end)
+---   it:rev()
+---   it:skip(2)
+---   it:totable()
+---   -- { 9, 6, 3 }
+---
+---   vim.iter(ipairs({ 1, 2, 3, 4, 5 })):map(function(i, v)
+---     if i > 2 then return v end
+---   end):totable()
+---   -- { 3, 4, 5 }
+---
+---   local it = vim.iter(vim.gsplit('1,2,3,4,5', ','))
+---   it:map(function(s) return tonumber(s) end)
+---   for i, d in it:enumerate() do
+---     print(string.format("Column %d is %d", i, d))
+---   end
+---   -- Column 1 is 1
+---   -- Column 2 is 2
+---   -- Column 3 is 3
+---   -- Column 4 is 4
+---   -- Column 5 is 5
+---
+---   vim.iter({ a = 1, b = 2, c = 3, z = 26 }):any(function(k, v)
+---     return k == 'z'
+---   end)
+---   -- true
+--- </pre>
+---
+--- In addition to the |vim.iter()| function, the |vim.iter| module provides convenience functions
+--- like |vim.iter.filter()| and |vim.iter.totable()|.
+
+local M = {}
 
 ---@class Iter
 local Iter = {}
@@ -733,7 +785,6 @@ end
 --- </pre>
 ---
 --- over
----
 --- <pre>lua
 --- vim.iter(t):enumerate()
 --- </pre>
@@ -776,6 +827,7 @@ end
 ---
 ---@param src table|function Table or iterator to drain values from
 ---@return Iter
+---@private
 function Iter.new(src, ...)
   local it = {}
   if type(src) == 'table' then
@@ -807,6 +859,7 @@ function Iter.new(src, ...)
       end
     end
 
+    ---@private
     function it.next()
       return fn(src(s, var))
     end
@@ -832,4 +885,57 @@ function ListIter.new(t)
   return it
 end
 
-return Iter
+--- Collect an iterator into a table.
+---
+--- This is a convenience function that performs:
+--- <pre>lua
+--- vim.iter(f):totable()
+--- </pre>
+---
+---@param f function Iterator function
+---@return table
+function M.totable(f, ...)
+  return Iter.new(f, ...):totable()
+end
+
+--- Filter a table or iterator.
+---
+--- This is a convenience function that performs:
+--- <pre>lua
+--- vim.iter(src):filter(f):totable()
+--- </pre>
+---
+---@see |Iter:filter()|
+---
+---@param f function(...):bool Filter function. Accepts the current iterator or table values as
+---                            arguments and returns true if those values should be kept in the
+---                            final table
+---@param src table|function Table or iterator function to filter
+---@return table
+function M.filter(f, src, ...)
+  return Iter.new(src, ...):filter(f):totable()
+end
+
+--- Map and filter a table or iterator.
+---
+--- This is a convenience function that performs:
+--- <pre>lua
+--- vim.iter(src):map(f):totable()
+--- </pre>
+---
+---@see |Iter:map()|
+---
+---@param f function(...):?any Map function. Accepts the current iterator or table values as
+---                            arguments and returns one or more new values. Nil values are removed
+---                            from the final table.
+---@param src table|function Table or iterator function to filter
+---@return table
+function M.map(f, src, ...)
+  return Iter.new(src, ...):map(f):totable()
+end
+
+return setmetatable(M, {
+  __call = function(_, ...)
+    return Iter.new(...)
+  end,
+})
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 5f4ea8822b..a55deb1415 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -881,109 +881,4 @@ function vim.defaulttable(create)
   })
 end
 
---- Create an Iter |lua-iter| object from a table or iterator.
----
---- The input value can be a table  or a function iterator (see |luaref-in|).
----
---- This function wraps the input value into an interface which allows chaining
---- multiple pipeline stages in an efficient manner. Each pipeline stage
---- receives as input the output values from the prior stage. The values used in
---- the first stage of the pipeline depend on the type passed to this function:
----
---- - List tables pass only the value of each element
---- - Non-list tables pass both the key and value of each element
---- - Function iterators pass all of the values returned by their respective
----   function
----
---- Examples:
---- <pre>lua
---- local it = vim.iter({ 1, 2, 3, 4, 5 })
---- it:map(function(v)
----   return v * 3
---- end)
---- it:rev()
---- it:skip(2)
---- it:totable()
---- -- { 9, 6, 3 }
----
---- vim.iter(ipairs({ 1, 2, 3, 4, 5 })):map(function(i, v)
----   if i > 2 then return v end
---- end):totable()
---- -- { 3, 4, 5 }
----
---- local it = vim.iter(vim.gsplit('1,2,3,4,5', ','))
---- it:map(function(s) return tonumber(s) end)
---- for i, d in it:enumerate() do
----   print(string.format("Column %d is %d", i, d))
---- end
---- -- Column 1 is 1
---- -- Column 2 is 2
---- -- Column 3 is 3
---- -- Column 4 is 4
---- -- Column 5 is 5
----
---- vim.iter({ a = 1, b = 2, c = 3, z = 26 }):any(function(k, v)
----   return k == 'z'
---- end)
---- -- true
---- </pre>
----
----@see |lua-iter|
----
----@param src table|function Table or iterator.
----@return Iter @|lua-iter|
-function vim.iter(src, ...)
-  local Iter = require('vim.iter')
-  return Iter.new(src, ...)
-end
-
---- Collect an iterator into a table.
----
---- This is a convenience function that performs:
---- <pre>lua
---- vim.iter(f):totable()
---- </pre>
----
----@param f function Iterator function
----@return table
-function vim.totable(f, ...)
-  return vim.iter(f, ...):totable()
-end
-
---- Filter a table or iterator.
----
---- This is a convenience function that performs:
---- <pre>lua
---- vim.iter(src):filter(f):totable()
---- </pre>
----
----@see |Iter:filter()|
----
----@param f function(...):bool Filter function. Accepts the current iterator or table values as
----                            arguments and returns true if those values should be kept in the
----                            final table
----@param src table|function Table or iterator function to filter
----@return table
-function vim.filter(f, src, ...)
-  return vim.iter(src, ...):filter(f):totable()
-end
-
---- Map and filter a table or iterator.
----
---- This is a convenience function that performs:
---- <pre>lua
---- vim.iter(src):map(f):totable()
---- </pre>
----
----@see |Iter:map()|
----
----@param f function(...):?any Map function. Accepts the current iterator or table values as
----                            arguments and returns one or more new values. Nil values are removed
----                            from the final table.
----@param src table|function Table or iterator function to filter
----@return table
-function vim.map(f, src, ...)
-  return vim.iter(src, ...):map(f):totable()
-end
-
 return vim
-- 
cgit 


From 7e70ca0b4808bb9d8f19c28c8f93e8f2b9e0d0f0 Mon Sep 17 00:00:00 2001
From: ii14 <59243201+ii14@users.noreply.github.com>
Date: Tue, 25 Apr 2023 16:52:44 +0200
Subject: feat(lua): vim.keycode (#22960)

Using nvim_replace_termcodes is too verbose, add vim.keycode for
translating keycodes.

Co-authored-by: ii14 <ii14@users.noreply.github.com>
---
 runtime/lua/vim/_editor.lua | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index c922ec93db..20e813d77c 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -829,6 +829,20 @@ function vim.print(...)
   return ...
 end
 
+--- Translate keycodes.
+---
+--- Example:
+--- <pre>lua
+---   local k = vim.keycode
+---   vim.g.mapleader = k'<bs>'
+--- </pre>
+--- @param str string String to be converted.
+--- @return string
+--- @see |nvim_replace_termcodes()|
+function vim.keycode(str)
+  return vim.api.nvim_replace_termcodes(str, true, true, true)
+end
+
 function vim._cs_remote(rcid, server_addr, connect_error, args)
   local function connection_failure_errmsg(consequence)
     local explanation
-- 
cgit 


From 45bcf8386918bbb475fbe20c48b508aa89ed0624 Mon Sep 17 00:00:00 2001
From: bfredl <bjorn.linse@gmail.com>
Date: Thu, 20 Apr 2023 13:19:38 +0200
Subject: refactor(build): include lpeg as a library

---
 runtime/lua/vim/_init_packages.lua |   1 +
 runtime/lua/vim/re.lua             | 269 +++++++++++++++++++++++++++++++++++++
 2 files changed, 270 insertions(+)
 create mode 100644 runtime/lua/vim/re.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_init_packages.lua b/runtime/lua/vim/_init_packages.lua
index 5db258c011..8750afba34 100644
--- a/runtime/lua/vim/_init_packages.lua
+++ b/runtime/lua/vim/_init_packages.lua
@@ -56,6 +56,7 @@ vim._submodules = {
   version = true,
   fs = true,
   iter = true,
+  re = true,
 }
 
 -- These are for loading runtime modules in the vim namespace lazily.
diff --git a/runtime/lua/vim/re.lua b/runtime/lua/vim/re.lua
new file mode 100644
index 0000000000..dffe37186a
--- /dev/null
+++ b/runtime/lua/vim/re.lua
@@ -0,0 +1,269 @@
+-- $Id: re.lua $
+-- vendored from lpeg-1.0.2
+-- Copyright © 2007-2019 Lua.org, PUC-Rio.
+
+-- imported functions and modules
+local tonumber, type, print, error = tonumber, type, print, error
+local setmetatable = setmetatable
+local m = require"lpeg"
+
+-- 'm' will be used to parse expressions, and 'mm' will be used to
+-- create expressions; that is, 're' runs on 'm', creating patterns
+-- on 'mm'
+local mm = m
+
+-- pattern's metatable
+local mt = getmetatable(mm.P(0))
+
+
+
+-- No more global accesses after this point
+local version = _VERSION
+if version == "Lua 5.2" then _ENV = nil end
+
+
+local any = m.P(1)
+
+
+-- Pre-defined names
+local Predef = { nl = m.P"\n" }
+
+
+local mem
+local fmem
+local gmem
+
+
+local function updatelocale ()
+  mm.locale(Predef)
+  Predef.a = Predef.alpha
+  Predef.c = Predef.cntrl
+  Predef.d = Predef.digit
+  Predef.g = Predef.graph
+  Predef.l = Predef.lower
+  Predef.p = Predef.punct
+  Predef.s = Predef.space
+  Predef.u = Predef.upper
+  Predef.w = Predef.alnum
+  Predef.x = Predef.xdigit
+  Predef.A = any - Predef.a
+  Predef.C = any - Predef.c
+  Predef.D = any - Predef.d
+  Predef.G = any - Predef.g
+  Predef.L = any - Predef.l
+  Predef.P = any - Predef.p
+  Predef.S = any - Predef.s
+  Predef.U = any - Predef.u
+  Predef.W = any - Predef.w
+  Predef.X = any - Predef.x
+  mem = {}    -- restart memoization
+  fmem = {}
+  gmem = {}
+  local mt = {__mode = "v"}
+  setmetatable(mem, mt)
+  setmetatable(fmem, mt)
+  setmetatable(gmem, mt)
+end
+
+
+updatelocale()
+
+
+
+local I = m.P(function (s,i) print(i, s:sub(1, i-1)); return i end)
+
+
+local function patt_error (s, i)
+  local msg = (#s < i + 20) and s:sub(i)
+                             or s:sub(i,i+20) .. "..."
+  msg = ("pattern error near '%s'"):format(msg)
+  error(msg, 2)
+end
+
+local function mult (p, n)
+  local np = mm.P(true)
+  while n >= 1 do
+    if n%2 >= 1 then np = np * p end
+    p = p * p
+    n = n/2
+  end
+  return np
+end
+
+local function equalcap (s, i, c)
+  if type(c) ~= "string" then return nil end
+  local e = #c + i
+  if s:sub(i, e - 1) == c then return e else return nil end
+end
+
+
+local S = (Predef.space + "--" * (any - Predef.nl)^0)^0
+
+local name = m.R("AZ", "az", "__") * m.R("AZ", "az", "__", "09")^0
+
+local arrow = S * "<-"
+
+local seq_follow = m.P"/" + ")" + "}" + ":}" + "~}" + "|}" + (name * arrow) + -1
+
+name = m.C(name)
+
+
+-- a defined name only have meaning in a given environment
+local Def = name * m.Carg(1)
+
+
+local function getdef (id, defs)
+  local c = defs and defs[id]
+  if not c then error("undefined name: " .. id) end
+  return c
+end
+
+-- match a name and return a group of its corresponding definition
+-- and 'f' (to be folded in 'Suffix')
+local function defwithfunc (f)
+  return m.Cg(Def / getdef * m.Cc(f))
+end
+
+
+local num = m.C(m.R"09"^1) * S / tonumber
+
+local String = "'" * m.C((any - "'")^0) * "'" +
+               '"' * m.C((any - '"')^0) * '"'
+
+
+local defined = "%" * Def / function (c,Defs)
+  local cat =  Defs and Defs[c] or Predef[c]
+  if not cat then error ("name '" .. c .. "' undefined") end
+  return cat
+end
+
+local Range = m.Cs(any * (m.P"-"/"") * (any - "]")) / mm.R
+
+local item = (defined + Range + m.C(any)) / m.P
+
+local Class =
+    "["
+  * (m.C(m.P"^"^-1))    -- optional complement symbol
+  * m.Cf(item * (item - "]")^0, mt.__add) /
+                          function (c, p) return c == "^" and any - p or p end
+  * "]"
+
+local function adddef (t, k, exp)
+  if t[k] then
+    error("'"..k.."' already defined as a rule")
+  else
+    t[k] = exp
+  end
+  return t
+end
+
+local function firstdef (n, r) return adddef({n}, n, r) end
+
+
+local function NT (n, b)
+  if not b then
+    error("rule '"..n.."' used outside a grammar")
+  else return mm.V(n)
+  end
+end
+
+
+local exp = m.P{ "Exp",
+  Exp = S * ( m.V"Grammar"
+            + m.Cf(m.V"Seq" * ("/" * S * m.V"Seq")^0, mt.__add) );
+  Seq = m.Cf(m.Cc(m.P"") * m.V"Prefix"^0 , mt.__mul)
+        * (#seq_follow + patt_error);
+  Prefix = "&" * S * m.V"Prefix" / mt.__len
+         + "!" * S * m.V"Prefix" / mt.__unm
+         + m.V"Suffix";
+  Suffix = m.Cf(m.V"Primary" * S *
+          ( ( m.P"+" * m.Cc(1, mt.__pow)
+            + m.P"*" * m.Cc(0, mt.__pow)
+            + m.P"?" * m.Cc(-1, mt.__pow)
+            + "^" * ( m.Cg(num * m.Cc(mult))
+                    + m.Cg(m.C(m.S"+-" * m.R"09"^1) * m.Cc(mt.__pow))
+                    )
+            + "->" * S * ( m.Cg((String + num) * m.Cc(mt.__div))
+                         + m.P"{}" * m.Cc(nil, m.Ct)
+                         + defwithfunc(mt.__div)
+                         )
+            + "=>" * S * defwithfunc(m.Cmt)
+            + "~>" * S * defwithfunc(m.Cf)
+            ) * S
+          )^0, function (a,b,f) return f(a,b) end );
+  Primary = "(" * m.V"Exp" * ")"
+            + String / mm.P
+            + Class
+            + defined
+            + "{:" * (name * ":" + m.Cc(nil)) * m.V"Exp" * ":}" /
+                     function (n, p) return mm.Cg(p, n) end
+            + "=" * name / function (n) return mm.Cmt(mm.Cb(n), equalcap) end
+            + m.P"{}" / mm.Cp
+            + "{~" * m.V"Exp" * "~}" / mm.Cs
+            + "{|" * m.V"Exp" * "|}" / mm.Ct
+            + "{" * m.V"Exp" * "}" / mm.C
+            + m.P"." * m.Cc(any)
+            + (name * -arrow + "<" * name * ">") * m.Cb("G") / NT;
+  Definition = name * arrow * m.V"Exp";
+  Grammar = m.Cg(m.Cc(true), "G") *
+            m.Cf(m.V"Definition" / firstdef * m.Cg(m.V"Definition")^0,
+              adddef) / mm.P
+}
+
+local pattern = S * m.Cg(m.Cc(false), "G") * exp / mm.P * (-any + patt_error)
+
+
+local function compile (p, defs)
+  if mm.type(p) == "pattern" then return p end   -- already compiled
+  local cp = pattern:match(p, 1, defs)
+  if not cp then error("incorrect pattern", 3) end
+  return cp
+end
+
+local function match (s, p, i)
+  local cp = mem[p]
+  if not cp then
+    cp = compile(p)
+    mem[p] = cp
+  end
+  return cp:match(s, i or 1)
+end
+
+local function find (s, p, i)
+  local cp = fmem[p]
+  if not cp then
+    cp = compile(p) / 0
+    cp = mm.P{ mm.Cp() * cp * mm.Cp() + 1 * mm.V(1) }
+    fmem[p] = cp
+  end
+  local i, e = cp:match(s, i or 1)
+  if i then return i, e - 1
+  else return i
+  end
+end
+
+local function gsub (s, p, rep)
+  local g = gmem[p] or {}   -- ensure gmem[p] is not collected while here
+  gmem[p] = g
+  local cp = g[rep]
+  if not cp then
+    cp = compile(p)
+    cp = mm.Cs((cp / rep + 1)^0)
+    g[rep] = cp
+  end
+  return cp:match(s)
+end
+
+
+-- exported names
+local re = {
+  compile = compile,
+  match = match,
+  find = find,
+  gsub = gsub,
+  updatelocale = updatelocale,
+}
+
+if version == "Lua 5.1" then _G.re = re end
+
+return re
-- 
cgit 


From ef1801cc7c3d8fe9fd8524a3b677095d4437fc66 Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Fri, 28 Apr 2023 11:37:53 -0600
Subject: perf(iter): reduce number of table allocations

Packing and unpacking return values impairs performance considerably.
In an attempt to avoid creating tables as much as possible we can
instead pass return values between functions (which does not require
knowing the number of values a function might return). This makes the
code more complex, but improves benchmark numbers non-trivially.
---
 runtime/lua/vim/iter.lua | 164 +++++++++++++++++++++++++++++------------------
 1 file changed, 102 insertions(+), 62 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index c2e2c5bd9f..bda3508262 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -1,13 +1,14 @@
 ---@defgroup lua-iter
 ---
---- The \*vim.iter\* module provides a generic "iterator" interface over tables and iterator
---- functions.
+--- The \*vim.iter\* module provides a generic "iterator" interface over tables
+--- and iterator functions.
 ---
---- \*vim.iter()\* wraps its table or function argument into an \*Iter\* object with methods (such
---- as |Iter:filter()| and |Iter:map()|) that transform the underlying source data. These methods
---- can be chained together to create iterator "pipelines". Each pipeline stage receives as input
---- the output values from the prior stage. The values used in the first stage of the pipeline
---- depend on the type passed to this function:
+--- \*vim.iter()\* wraps its table or function argument into an \*Iter\* object
+--- with methods (such as |Iter:filter()| and |Iter:map()|) that transform the
+--- underlying source data. These methods can be chained together to create
+--- iterator "pipelines". Each pipeline stage receives as input the output
+--- values from the prior stage. The values used in the first stage of the
+--- pipeline depend on the type passed to this function:
 ---
 --- - List tables pass only the value of each element
 --- - Non-list tables pass both the key and value of each element
@@ -47,8 +48,8 @@
 ---   -- true
 --- </pre>
 ---
---- In addition to the |vim.iter()| function, the |vim.iter| module provides convenience functions
---- like |vim.iter.filter()| and |vim.iter.totable()|.
+--- In addition to the |vim.iter()| function, the |vim.iter| module provides
+--- convenience functions like |vim.iter.filter()| and |vim.iter.totable()|.
 
 local M = {}
 
@@ -61,9 +62,9 @@ end
 
 --- Special case implementations for iterators on list tables.
 ---@class ListIter : Iter
----@field _table table Underlying table data (table iterators only)
----@field _head number Index to the front of a table iterator (table iterators only)
----@field _tail number Index to the end of a table iterator (table iterators only)
+---@field _table table Underlying table data
+---@field _head number Index to the front of a table iterator
+---@field _tail number Index to the end of a table iterator
 local ListIter = {}
 ListIter.__index = setmetatable(ListIter, Iter)
 ListIter.__call = function(self)
@@ -75,7 +76,7 @@ local packedmt = {}
 
 ---@private
 local function unpack(t)
-  if getmetatable(t) == packedmt then
+  if type(t) == 'table' and getmetatable(t) == packedmt then
     return _G.unpack(t, 1, t.n)
   end
   return t
@@ -92,13 +93,47 @@ end
 
 ---@private
 local function sanitize(t)
-  if getmetatable(t) == packedmt then
+  if type(t) == 'table' and getmetatable(t) == packedmt then
     -- Remove length tag
     t.n = nil
   end
   return t
 end
 
+--- Determine if the current iterator stage should continue.
+---
+--- If any arguments are passed to this function, then return those arguments
+--- and stop the current iterator stage. Otherwise, return true to signal that
+--- the current stage should continue.
+---
+---@param ... any Function arguments.
+---@return boolean True if the iterator stage should continue, false otherwise
+---@return any Function arguments.
+---@private
+local function continue(...)
+  if select('#', ...) > 0 then
+    return false, ...
+  end
+  return true
+end
+
+--- If no input arguments are given return false, indicating the current
+--- iterator stage should stop. Otherwise, apply the arguments to the function
+--- f. If that function returns no values, the current iterator stage continues.
+--- Otherwise, those values are returned.
+---
+---@param f function Function to call with the given arguments
+---@param ... any Arguments to apply to f
+---@return boolean True if the iterator pipeline should continue, false otherwise
+---@return any Return values of f
+---@private
+local function apply(f, ...)
+  if select('#', ...) > 0 then
+    return continue(f(...))
+  end
+  return false
+end
+
 --- Add a filter step to the iterator pipeline.
 ---
 --- Example:
@@ -106,33 +141,16 @@ end
 --- local bufs = vim.iter(vim.api.nvim_list_bufs()):filter(vim.api.nvim_buf_is_loaded)
 --- </pre>
 ---
----@param f function(...):bool Takes all values returned from the previous stage in the pipeline and
----                            returns false or nil if the current iterator element should be
----                            removed.
+---@param f function(...):bool Takes all values returned from the previous stage
+---                            in the pipeline and returns false or nil if the
+---                            current iterator element should be removed.
 ---@return Iter
 function Iter.filter(self, f)
-  ---@private
-  local function fn(...)
-    local result = nil
-    if select(1, ...) ~= nil then
-      if not f(...) then
-        return true, nil
-      else
-        result = pack(...)
-      end
+  return self:map(function(...)
+    if f(...) then
+      return ...
     end
-    return false, result
-  end
-
-  local next = self.next
-  self.next = function(this)
-    local cont, result
-    repeat
-      cont, result = fn(next(this))
-    until not cont
-    return unpack(result)
-  end
-  return self
+  end)
 end
 
 ---@private
@@ -165,31 +183,52 @@ end
 --- -- { 6, 12 }
 --- </pre>
 ---
----@param f function(...):any Mapping function. Takes all values returned from the previous stage
----                            in the pipeline as arguments and returns one or more new values,
----                            which are used in the next pipeline stage. Nil return values returned
----                            are filtered from the output.
+---@param f function(...):any Mapping function. Takes all values returned from
+---                           the previous stage in the pipeline as arguments
+---                           and returns one or more new values, which are used
+---                           in the next pipeline stage. Nil return values
+---                           are filtered from the output.
 ---@return Iter
 function Iter.map(self, f)
+  -- Implementation note: the reader may be forgiven for observing that this
+  -- function appears excessively convoluted. The problem to solve is that each
+  -- stage of the iterator pipeline can return any number of values, and the
+  -- number of values could even change per iteration. And the return values
+  -- must be checked to determine if the pipeline has ended, so we cannot
+  -- naively forward them along to the next stage.
+  --
+  -- A simple approach is to pack all of the return values into a table, check
+  -- for nil, then unpack the table for the next stage. However, packing and
+  -- unpacking tables is quite slow. There is no other way in Lua to handle an
+  -- unknown number of function return values than to simply forward those
+  -- values along to another function. Hence the intricate function passing you
+  -- see here.
+
+  local next = self.next
+
+  --- Drain values from the upstream iterator source until a value can be
+  --- returned.
+  ---
+  --- This is a recursive function. The base case is when the first argument is
+  --- false, which indicates that the rest of the arguments should be returned
+  --- as the values for the current iteration stage.
+  ---
+  ---@param cont boolean If true, the current iterator stage should continue to
+  ---                    pull values from its upstream pipeline stage.
+  ---                    Otherwise, this stage is complete and returns the
+  ---                    values passed.
+  ---@param ... any Values to return if cont is false.
+  ---@return any
   ---@private
-  local function fn(...)
-    local result = nil
-    if select(1, ...) ~= nil then
-      result = pack(f(...))
-      if result == nil then
-        return true, nil
-      end
+  local function fn(cont, ...)
+    if cont then
+      return fn(apply(f, next(self)))
     end
-    return false, result
+    return ...
   end
 
-  local next = self.next
-  self.next = function(this)
-    local cont, result
-    repeat
-      cont, result = fn(next(this))
-    until not cont
-    return unpack(result)
+  self.next = function()
+    return fn(apply(f, next(self)))
   end
   return self
 end
@@ -211,17 +250,18 @@ end
 
 --- Call a function once for each item in the pipeline.
 ---
---- This is used for functions which have side effects. To modify the values in the iterator, use
---- |Iter:map()|.
+--- This is used for functions which have side effects. To modify the values in
+--- the iterator, use |Iter:map()|.
 ---
 --- This function drains the iterator.
 ---
----@param f function(...) Function to execute for each item in the pipeline. Takes all of the
----                        values returned by the previous stage in the pipeline as arguments.
+---@param f function(...) Function to execute for each item in the pipeline.
+---                       Takes all of the values returned by the previous stage
+---                       in the pipeline as arguments.
 function Iter.each(self, f)
   ---@private
   local function fn(...)
-    if select(1, ...) ~= nil then
+    if select('#', ...) > 0 then
       f(...)
       return true
     end
-- 
cgit 


From c194acbfc479d8e5839fa629363f93f6550d035c Mon Sep 17 00:00:00 2001
From: Stephan Seitz <stephan.seitz@fau.de>
Date: Sat, 29 Apr 2023 18:22:26 +0200
Subject: feat(treesitter): add query_linter from nvim-treesitter/playground
 (#22784)

Co-authored-by: clason <clason@users.noreply.github.com>
Co-authored-by: lewis6991 <lewis6991@users.noreply.github.com>
---
 runtime/lua/vim/treesitter/_query_linter.lua | 302 +++++++++++++++++++++++++++
 runtime/lua/vim/treesitter/playground.lua    |   1 +
 runtime/lua/vim/treesitter/query.lua         |  29 +++
 3 files changed, 332 insertions(+)
 create mode 100644 runtime/lua/vim/treesitter/_query_linter.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_query_linter.lua b/runtime/lua/vim/treesitter/_query_linter.lua
new file mode 100644
index 0000000000..62f28d3097
--- /dev/null
+++ b/runtime/lua/vim/treesitter/_query_linter.lua
@@ -0,0 +1,302 @@
+local namespace = vim.api.nvim_create_namespace('vim.treesitter.query_linter')
+-- those node names exist for every language
+local BUILT_IN_NODE_NAMES = { '_', 'ERROR' }
+
+local M = {}
+
+--- @class QueryLinterNormalizedOpts
+--- @field langs string[]
+--- @field clear boolean
+
+--- @private
+--- Caches parse results for queries for each language.
+--- Entries of parse_cache[lang][query_text] will either be true for successful parse or contain the
+--- error message of the parse
+--- @type table<string,table<string,string|true>>
+local parse_cache = {}
+
+--- Contains language dependent context for the query linter
+--- @class QueryLinterLanguageContext
+--- @field lang string? Current `lang` of the targeted parser
+--- @field parser_info table? Parser info returned by vim.treesitter.language.inspect
+--- @field is_first_lang boolean Whether this is the first language of a linter run checking queries for multiple `langs`
+
+--- @private
+--- Adds a diagnostic for node in the query buffer
+--- @param diagnostics Diagnostic[]
+--- @param node TSNode
+--- @param buf integer
+--- @param lint string
+--- @param lang string?
+local function add_lint_for_node(diagnostics, node, buf, lint, lang)
+  local node_text = vim.treesitter.get_node_text(node, buf):gsub('\n', ' ')
+  --- @type string
+  local message = lint .. ': ' .. node_text
+  local error_range = { node:range() }
+  diagnostics[#diagnostics + 1] = {
+    lnum = error_range[1],
+    end_lnum = error_range[3],
+    col = error_range[2],
+    end_col = error_range[4],
+    severity = vim.diagnostic.ERROR,
+    message = message,
+    source = lang,
+  }
+end
+
+--- @private
+--- Determines the target language of a query file by its path: <lang>/<query_type>.scm
+--- @param buf integer
+--- @return string?
+local function guess_query_lang(buf)
+  local filename = vim.api.nvim_buf_get_name(buf)
+  if filename ~= '' then
+    local ok, query_lang = pcall(vim.fn.fnamemodify, filename, ':p:h:t')
+    if ok then
+      return query_lang
+    end
+  end
+end
+
+--- @private
+--- @param buf integer
+--- @param opts QueryLinterOpts|QueryLinterNormalizedOpts|nil
+--- @return QueryLinterNormalizedOpts
+local function normalize_opts(buf, opts)
+  opts = opts or {}
+  if not opts.langs then
+    opts.langs = guess_query_lang(buf)
+  end
+
+  if type(opts.langs) ~= 'table' then
+    --- @diagnostic disable-next-line:assign-type-mismatch
+    opts.langs = { opts.langs }
+  end
+
+  --- @cast opts QueryLinterNormalizedOpts
+  opts.langs = opts.langs or {}
+  return opts
+end
+
+local lint_query = [[;; query
+  (program [(named_node) (list) (grouping)] @toplevel)
+  (named_node
+    name: _ @node.named)
+  (anonymous_node
+    name: _ @node.anonymous)
+  (field_definition
+    name: (identifier) @field)
+  (predicate
+    name: (identifier) @predicate.name
+    type: (predicate_type) @predicate.type)
+  (ERROR) @error
+]]
+
+--- @private
+--- @param node TSNode
+--- @param buf integer
+--- @param lang string
+--- @param diagnostics Diagnostic[]
+local function check_toplevel(node, buf, lang, diagnostics)
+  local query_text = vim.treesitter.get_node_text(node, buf)
+
+  if not parse_cache[lang] then
+    parse_cache[lang] = {}
+  end
+
+  local lang_cache = parse_cache[lang]
+
+  if lang_cache[query_text] == nil then
+    local ok, err = pcall(vim.treesitter.query.parse, lang, query_text)
+
+    if not ok and type(err) == 'string' then
+      err = err:match('.-:%d+: (.+)')
+    end
+
+    lang_cache[query_text] = ok or err
+  end
+
+  local cache_entry = lang_cache[query_text]
+
+  if type(cache_entry) == 'string' then
+    add_lint_for_node(diagnostics, node, buf, cache_entry, lang)
+  end
+end
+
+--- @private
+--- @param node TSNode
+--- @param buf integer
+--- @param lang string
+--- @param parser_info table
+--- @param diagnostics Diagnostic[]
+local function check_field(node, buf, lang, parser_info, diagnostics)
+  local field_name = vim.treesitter.get_node_text(node, buf)
+  if not vim.tbl_contains(parser_info.fields, field_name) then
+    add_lint_for_node(diagnostics, node, buf, 'Invalid field', lang)
+  end
+end
+
+--- @private
+--- @param node TSNode
+--- @param buf integer
+--- @param lang string
+--- @param parser_info (table)
+--- @param diagnostics Diagnostic[]
+local function check_node(node, buf, lang, parser_info, diagnostics)
+  local node_type = vim.treesitter.get_node_text(node, buf)
+  local is_named = node_type:sub(1, 1) ~= '"'
+
+  if not is_named then
+    node_type = node_type:gsub('"(.*)".*$', '%1'):gsub('\\(.)', '%1')
+  end
+
+  local found = vim.tbl_contains(BUILT_IN_NODE_NAMES, node_type)
+    or vim.tbl_contains(parser_info.symbols, function(s)
+      return vim.deep_equal(s, { node_type, is_named })
+    end, { predicate = true })
+
+  if not found then
+    add_lint_for_node(diagnostics, node, buf, 'Invalid node type', lang)
+  end
+end
+
+--- @private
+--- @param node TSNode
+--- @param buf integer
+--- @param is_predicate boolean
+--- @return string
+local function get_predicate_name(node, buf, is_predicate)
+  local name = vim.treesitter.get_node_text(node, buf)
+  if is_predicate then
+    if vim.startswith(name, 'not-') then
+      --- @type string
+      name = name:sub(string.len('not-') + 1)
+    end
+    return name .. '?'
+  end
+  return name .. '!'
+end
+
+--- @private
+--- @param predicate_node TSNode
+--- @param predicate_type_node TSNode
+--- @param buf integer
+--- @param lang string?
+--- @param diagnostics Diagnostic[]
+local function check_predicate(predicate_node, predicate_type_node, buf, lang, diagnostics)
+  local type_string = vim.treesitter.get_node_text(predicate_type_node, buf)
+
+  -- Quirk of the query grammar that directives are also predicates!
+  if type_string == '?' then
+    if
+      not vim.tbl_contains(
+        vim.treesitter.query.list_predicates(),
+        get_predicate_name(predicate_node, buf, true)
+      )
+    then
+      add_lint_for_node(diagnostics, predicate_node, buf, 'Unknown predicate', lang)
+    end
+  elseif type_string == '!' then
+    if
+      not vim.tbl_contains(
+        vim.treesitter.query.list_directives(),
+        get_predicate_name(predicate_node, buf, false)
+      )
+    then
+      add_lint_for_node(diagnostics, predicate_node, buf, 'Unknown directive', lang)
+    end
+  end
+end
+
+--- @private
+--- @param buf integer
+--- @param match table<integer,TSNode>
+--- @param query Query
+--- @param lang_context QueryLinterLanguageContext
+--- @param diagnostics Diagnostic[]
+local function lint_match(buf, match, query, lang_context, diagnostics)
+  local predicate --- @type TSNode
+  local predicate_type --- @type TSNode
+  local lang = lang_context.lang
+  local parser_info = lang_context.parser_info
+
+  for id, node in pairs(match) do
+    local cap_id = query.captures[id]
+
+    -- perform language-independent checks only for first lang
+    if lang_context.is_first_lang then
+      if cap_id == 'error' then
+        add_lint_for_node(diagnostics, node, buf, 'Syntax error')
+      elseif cap_id == 'predicate.name' then
+        predicate = node
+      elseif cap_id == 'predicate.type' then
+        predicate_type = node
+      end
+    end
+
+    -- other checks rely on Neovim parser introspection
+    if lang and parser_info then
+      if cap_id == 'toplevel' then
+        check_toplevel(node, buf, lang, diagnostics)
+      elseif cap_id == 'field' then
+        check_field(node, buf, lang, parser_info, diagnostics)
+      elseif cap_id == 'node.named' or cap_id == 'node.anonymous' then
+        check_node(node, buf, lang, parser_info, diagnostics)
+      end
+    end
+  end
+
+  if predicate and predicate_type then
+    check_predicate(predicate, predicate_type, buf, lang, diagnostics)
+  end
+end
+
+--- @private
+--- @param buf integer Buffer to lint
+--- @param opts QueryLinterOpts|QueryLinterNormalizedOpts|nil Options for linting
+function M.lint(buf, opts)
+  if buf == 0 then
+    buf = vim.api.nvim_get_current_buf()
+  end
+
+  local diagnostics = {}
+  local query = vim.treesitter.query.parse('query', lint_query)
+
+  opts = normalize_opts(buf, opts)
+
+  -- perform at least one iteration even with no langs to perform language independent checks
+  for i = 1, math.max(1, #opts.langs) do
+    local lang = opts.langs[i]
+
+    --- @type boolean, (table|nil)
+    local ok, parser_info = pcall(vim.treesitter.language.inspect, lang)
+    if not ok then
+      parser_info = nil
+    end
+
+    local parser = vim.treesitter.get_parser(buf)
+    parser:parse()
+    parser:for_each_tree(function(tree, ltree)
+      if ltree:lang() == 'query' then
+        for _, match, _ in query:iter_matches(tree:root(), buf, 0, -1) do
+          local lang_context = {
+            lang = lang,
+            parser_info = parser_info,
+            is_first_lang = i == 1,
+          }
+          lint_match(buf, match, query, lang_context, diagnostics)
+        end
+      end
+    end)
+  end
+
+  vim.diagnostic.set(namespace, buf, diagnostics)
+end
+
+--- @private
+--- @param buf integer
+function M.clear(buf)
+  vim.diagnostic.reset(namespace, buf)
+end
+
+return M
diff --git a/runtime/lua/vim/treesitter/playground.lua b/runtime/lua/vim/treesitter/playground.lua
index c512710810..8293c1bd0a 100644
--- a/runtime/lua/vim/treesitter/playground.lua
+++ b/runtime/lua/vim/treesitter/playground.lua
@@ -269,6 +269,7 @@ function M.inspect_tree(opts)
   vim.bo[b].buflisted = false
   vim.bo[b].buftype = 'nofile'
   vim.bo[b].bufhidden = 'wipe'
+  vim.b[b].disable_query_linter = true
   vim.bo[b].filetype = 'query'
 
   local title --- @type string?
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 8a747ba14c..492bfd1ffb 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -714,4 +714,33 @@ function Query:iter_matches(node, source, start, stop)
   return iter
 end
 
+---@class QueryLinterOpts
+---@field langs (string|string[]|nil)
+---@field clear (boolean)
+
+--- Lint treesitter queries using installed parser, or clear lint errors.
+---
+--- Use |treesitter-parsers| in runtimepath to check the query file in {buf} for errors:
+---
+---   - verify that used nodes are valid identifiers in the grammar.
+---   - verify that predicates and directives are valid.
+---   - verify that top-level s-expressions are valid.
+---
+--- The found diagnostics are reported using |diagnostic-api|.
+--- By default, the parser used for verification is determined by the containing folder
+--- of the query file, e.g., if the path is `**/lua/highlights.scm`, the parser for the
+--- `lua` language will be used.
+---@param buf (integer) Buffer handle
+---@param opts (QueryLinterOpts|nil) Optional keyword arguments:
+---   - langs (string|string[]|nil) Language(s) to use for checking the query.
+---            If multiple languages are specified, queries are validated for all of them
+---   - clear (boolean) if `true`, just clear current lint errors
+function M.lint(buf, opts)
+  if opts and opts.clear then
+    require('vim.treesitter._query_linter').clear(buf)
+  else
+    require('vim.treesitter._query_linter').lint(buf, opts)
+  end
+end
+
 return M
-- 
cgit 


From 668f16bac779ac52d7bd9452e6001a7a6d1e9965 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sun, 30 Apr 2023 11:01:54 +0200
Subject: feat(treesitter): upstream query omnifunc from playground (#23394)

and set by default in `ftplugin/query.lua`
---
 runtime/lua/vim/treesitter/_query_linter.lua | 60 ++++++++++++++++++++++++++--
 runtime/lua/vim/treesitter/query.lua         | 12 +++++-
 2 files changed, 68 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_query_linter.lua b/runtime/lua/vim/treesitter/_query_linter.lua
index 62f28d3097..ecdee5fc95 100644
--- a/runtime/lua/vim/treesitter/_query_linter.lua
+++ b/runtime/lua/vim/treesitter/_query_linter.lua
@@ -1,4 +1,6 @@
-local namespace = vim.api.nvim_create_namespace('vim.treesitter.query_linter')
+local api = vim.api
+
+local namespace = api.nvim_create_namespace('vim.treesitter.query_linter')
 -- those node names exist for every language
 local BUILT_IN_NODE_NAMES = { '_', 'ERROR' }
 
@@ -49,7 +51,7 @@ end
 --- @param buf integer
 --- @return string?
 local function guess_query_lang(buf)
-  local filename = vim.api.nvim_buf_get_name(buf)
+  local filename = api.nvim_buf_get_name(buf)
   if filename ~= '' then
     local ok, query_lang = pcall(vim.fn.fnamemodify, filename, ':p:h:t')
     if ok then
@@ -256,7 +258,7 @@ end
 --- @param opts QueryLinterOpts|QueryLinterNormalizedOpts|nil Options for linting
 function M.lint(buf, opts)
   if buf == 0 then
-    buf = vim.api.nvim_get_current_buf()
+    buf = api.nvim_get_current_buf()
   end
 
   local diagnostics = {}
@@ -299,4 +301,56 @@ function M.clear(buf)
   vim.diagnostic.reset(namespace, buf)
 end
 
+--- @private
+--- @param findstart integer
+--- @param base string
+function M.omnifunc(findstart, base)
+  if findstart == 1 then
+    local result =
+      api.nvim_get_current_line():sub(1, api.nvim_win_get_cursor(0)[2]):find('["#%-%w]*$')
+    return result - 1
+  end
+
+  local buf = api.nvim_get_current_buf()
+  local query_lang = guess_query_lang(buf)
+
+  local ok, parser_info = pcall(vim.treesitter.language.inspect, query_lang)
+  if not ok then
+    return -2
+  end
+
+  local items = {}
+  for _, f in pairs(parser_info.fields) do
+    if f:find(base, 1, true) then
+      table.insert(items, f .. ':')
+    end
+  end
+  for _, p in pairs(vim.treesitter.query.list_predicates()) do
+    local text = '#' .. p
+    local found = text:find(base, 1, true)
+    if found and found <= 2 then -- with or without '#'
+      table.insert(items, text)
+    end
+    text = '#not-' .. p
+    found = text:find(base, 1, true)
+    if found and found <= 2 then -- with or without '#'
+      table.insert(items, text)
+    end
+  end
+  for _, p in pairs(vim.treesitter.query.list_directives()) do
+    local text = '#' .. p
+    local found = text:find(base, 1, true)
+    if found and found <= 2 then -- with or without '#'
+      table.insert(items, text)
+    end
+  end
+  for _, s in pairs(parser_info.symbols) do
+    local text = s[2] and s[1] or '"' .. s[1]:gsub([[\]], [[\\]]) .. '"'
+    if text:find(base, 1, true) then
+      table.insert(items, text)
+    end
+  end
+  return { words = items, refresh = 'always' }
+end
+
 return M
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 492bfd1ffb..93841bb31e 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -728,7 +728,7 @@ end
 ---
 --- The found diagnostics are reported using |diagnostic-api|.
 --- By default, the parser used for verification is determined by the containing folder
---- of the query file, e.g., if the path is `**/lua/highlights.scm`, the parser for the
+--- of the query file, e.g., if the path ends in `/lua/highlights.scm`, the parser for the
 --- `lua` language will be used.
 ---@param buf (integer) Buffer handle
 ---@param opts (QueryLinterOpts|nil) Optional keyword arguments:
@@ -743,4 +743,14 @@ function M.lint(buf, opts)
   end
 end
 
+--- Omnifunc for completing node names and predicates in treesitter queries.
+---
+--- Use via
+--- <pre>lua
+---   vim.bo.omnifunc = 'v:lua.vim.treesitter.query.omnifunc'
+--- </pre>
+function M.omnifunc(findstart, base)
+  return require('vim.treesitter._query_linter').omnifunc(findstart, base)
+end
+
 return M
-- 
cgit 


From 19a793545f15bb7e0bac2fc8f705c600e8f9c9bb Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 30 Apr 2023 16:11:38 +0100
Subject: fix(treesitter): redraw added/removed injections properly (#23287)

When injections are added or removed make sure to:
- invoke 'changedtree' callbacks for when new trees are added.
- invoke 'changedtree' callbacks for when trees are invalidated
- redraw regions when languagetree children are removed
---
 runtime/lua/vim/treesitter/highlighter.lua  | 20 ++++---
 runtime/lua/vim/treesitter/languagetree.lua | 81 +++++++++++++++++++----------
 2 files changed, 68 insertions(+), 33 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index ac2a929487..4bb764c5c6 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -76,9 +76,6 @@ function TSHighlighter.new(tree, opts)
   opts = opts or {} ---@type { queries: table<string,string> }
   self.tree = tree
   tree:register_cbs({
-    on_changedtree = function(...)
-      self:on_changedtree(...)
-    end,
     on_bytes = function(...)
       self:on_bytes(...)
     end,
@@ -87,6 +84,17 @@ function TSHighlighter.new(tree, opts)
     end,
   })
 
+  tree:register_cbs({
+    on_changedtree = function(...)
+      self:on_changedtree(...)
+    end,
+    on_child_removed = function(child)
+      child:for_each_tree(function(t)
+        self:on_changedtree(t:included_ranges(true))
+      end)
+    end,
+  }, true)
+
   self.bufnr = tree:source() --[[@as integer]]
   self.edit_count = 0
   self.redraw_count = 0
@@ -177,10 +185,10 @@ function TSHighlighter:on_detach()
 end
 
 ---@package
----@param changes integer[][]?
+---@param changes Range6[][]
 function TSHighlighter:on_changedtree(changes)
-  for _, ch in ipairs(changes or {}) do
-    api.nvim__buf_redraw_range(self.bufnr, ch[1], ch[3] + 1)
+  for _, ch in ipairs(changes) do
+    api.nvim__buf_redraw_range(self.bufnr, ch[1], ch[4] + 1)
   end
 end
 
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 4aa07d1b96..19cea32367 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -51,8 +51,18 @@ local Range = require('vim.treesitter._range')
 ---| 'on_child_added'
 ---| 'on_child_removed'
 
+--- @type table<TSCallbackNameOn,TSCallbackName>
+local TSCallbackNames = {
+  on_changedtree = 'changedtree',
+  on_bytes = 'bytes',
+  on_detach = 'detach',
+  on_child_added = 'child_added',
+  on_child_removed = 'child_removed',
+}
+
 ---@class LanguageTree
 ---@field private _callbacks table<TSCallbackName,function[]> Callback handlers
+---@field package _callbacks_rec table<TSCallbackName,function[]> Callback handlers (recursive)
 ---@field private _children table<string,LanguageTree> Injected languages
 ---@field private _injection_query Query Queries defining injected languages
 ---@field private _opts table Options
@@ -79,7 +89,7 @@ LanguageTree.__index = LanguageTree
 --- "injected" language parsers, which themselves may inject other languages, recursively.
 ---
 ---@param source (integer|string) Buffer or text string to parse
----@param lang string|nil Root language of this tree
+---@param lang string Root language of this tree
 ---@param opts (table|nil) Optional arguments:
 ---             - injections table Map of language to injection query strings. Overrides the
 ---                                built-in runtime file searching for language injections.
@@ -100,15 +110,15 @@ function LanguageTree.new(source, lang, opts)
       or query.get(lang, 'injections'),
     _valid = false,
     _parser = vim._create_ts_parser(lang),
-    _callbacks = {
-      changedtree = {},
-      bytes = {},
-      detach = {},
-      child_added = {},
-      child_removed = {},
-    },
+    _callbacks = {},
+    _callbacks_rec = {},
   }, LanguageTree)
 
+  for _, name in pairs(TSCallbackNames) do
+    self._callbacks[name] = {}
+    self._callbacks_rec[name] = {}
+  end
+
   return self
 end
 
@@ -121,6 +131,7 @@ local function tcall(f, ...)
   local start = vim.loop.hrtime()
   ---@diagnostic disable-next-line
   local r = { f(...) }
+  --- @type number
   local duration = (vim.loop.hrtime() - start) / 1000000
   return duration, unpack(r)
 end
@@ -161,6 +172,9 @@ function LanguageTree:invalidate(reload)
 
   -- buffer was reloaded, reparse all trees
   if reload then
+    for _, t in ipairs(self._trees) do
+      self:_do_callback('changedtree', t:included_ranges(true), t)
+    end
     self._trees = {}
   end
 
@@ -245,9 +259,12 @@ function LanguageTree:parse()
       if not self._valid or not self._valid[i] then
         self._parser:set_included_ranges(ranges)
         local parse_time, tree, tree_changes =
-          tcall(self._parser.parse, self._parser, self._trees[i], self._source)
+          tcall(self._parser.parse, self._parser, self._trees[i], self._source, true)
+
+        -- Pass ranges if this is an initial parse
+        local cb_changes = self._trees[i] and tree_changes or ranges
 
-        self:_do_callback('changedtree', tree_changes, tree)
+        self:_do_callback('changedtree', cb_changes, tree)
         self._trees[i] = tree
         vim.list_extend(changes, tree_changes)
 
@@ -341,7 +358,14 @@ function LanguageTree:add_child(lang)
     self:remove_child(lang)
   end
 
-  self._children[lang] = LanguageTree.new(self._source, lang, self._opts)
+  local child = LanguageTree.new(self._source, lang, self._opts)
+
+  -- Inherit recursive callbacks
+  for nm, cb in pairs(self._callbacks_rec) do
+    vim.list_extend(child._callbacks_rec[nm], cb)
+  end
+
+  self._children[lang] = child
   self:invalidate()
   self:_do_callback('child_added', self._children[lang])
 
@@ -453,6 +477,10 @@ function LanguageTree:set_included_regions(new_regions)
   end
 
   if #self:included_regions() ~= #new_regions then
+    -- TODO(lewis6991): inefficient; invalidate trees incrementally
+    for _, t in ipairs(self._trees) do
+      self:_do_callback('changedtree', t:included_ranges(true), t)
+    end
     self._trees = {}
     self:invalidate()
   else
@@ -707,6 +735,9 @@ function LanguageTree:_do_callback(cb_name, ...)
   for _, cb in ipairs(self._callbacks[cb_name]) do
     cb(...)
   end
+  for _, cb in ipairs(self._callbacks_rec[cb_name]) do
+    cb(...)
+  end
 end
 
 ---@package
@@ -855,30 +886,26 @@ end
 ---              changed.
 ---           - `on_child_added` : emitted when a child is added to the tree.
 ---           - `on_child_removed` : emitted when a child is removed from the tree.
-function LanguageTree:register_cbs(cbs)
+--- @param recursive? boolean Apply callbacks recursively for all children. Any new children will
+---                           also inherit the callbacks.
+function LanguageTree:register_cbs(cbs, recursive)
   ---@cast cbs table<TSCallbackNameOn,function>
   if not cbs then
     return
   end
 
-  if cbs.on_changedtree then
-    table.insert(self._callbacks.changedtree, cbs.on_changedtree)
-  end
-
-  if cbs.on_bytes then
-    table.insert(self._callbacks.bytes, cbs.on_bytes)
-  end
+  local callbacks = recursive and self._callbacks_rec or self._callbacks
 
-  if cbs.on_detach then
-    table.insert(self._callbacks.detach, cbs.on_detach)
-  end
-
-  if cbs.on_child_added then
-    table.insert(self._callbacks.child_added, cbs.on_child_added)
+  for name, cbname in pairs(TSCallbackNames) do
+    if cbs[name] then
+      table.insert(callbacks[cbname], cbs[name])
+    end
   end
 
-  if cbs.on_child_removed then
-    table.insert(self._callbacks.child_removed, cbs.on_child_removed)
+  if recursive then
+    self:for_each_child(function(child)
+      child:register_cbs(cbs, true)
+    end)
   end
 end
 
-- 
cgit 


From edf05b005f34f59dd40468c36cc139e217345a71 Mon Sep 17 00:00:00 2001
From: jdrouhard <john@drouhard.dev>
Date: Mon, 1 May 2023 00:15:32 -0500
Subject: perf(lsp): process semantic tokens response in a coroutine that
 yields every 5ms (#23375)

---
 runtime/lua/vim/lsp/semantic_tokens.lua | 45 +++++++++++++++++++++++++++------
 1 file changed, 37 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 03532c33b7..b6b09c58b1 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -1,7 +1,8 @@
 local api = vim.api
+local bit = require('bit')
 local handlers = require('vim.lsp.handlers')
 local util = require('vim.lsp.util')
-local bit = require('bit')
+local uv = vim.loop
 
 --- @class STTokenRange
 --- @field line integer line number 0-based
@@ -94,15 +95,38 @@ end
 ---
 ---@private
 ---@return STTokenRange[]
-local function tokens_to_ranges(data, bufnr, client)
+local function tokens_to_ranges(data, bufnr, client, request)
   local legend = client.server_capabilities.semanticTokensProvider.legend
   local token_types = legend.tokenTypes
   local token_modifiers = legend.tokenModifiers
   local ranges = {}
 
+  local start = uv.hrtime()
+  local ms_to_ns = 1000 * 1000
+  local yield_interval_ns = 5 * ms_to_ns
+  local co, is_main = coroutine.running()
+
   local line
   local start_char = 0
   for i = 1, #data, 5 do
+    -- if this function is called from the main coroutine, let it run to completion with no yield
+    if not is_main then
+      local elapsed_ns = uv.hrtime() - start
+
+      if elapsed_ns > yield_interval_ns then
+        vim.schedule(function()
+          coroutine.resume(co, util.buf_versions[bufnr])
+        end)
+        if request.version ~= coroutine.yield() then
+          -- request became stale since the last time the coroutine ran.
+          -- abandon it by yielding without a way to resume
+          coroutine.yield()
+        end
+
+        start = uv.hrtime()
+      end
+    end
+
     local delta_line = data[i]
     line = line and line + delta_line or delta_line
     local delta_start = data[i + 1]
@@ -280,7 +304,7 @@ function STHighlighter:send_request()
         local c = vim.lsp.get_client_by_id(ctx.client_id)
         local highlighter = STHighlighter.active[ctx.bufnr]
         if not err and c and highlighter then
-          highlighter:process_response(response, c, version)
+          coroutine.wrap(STHighlighter.process_response)(highlighter, response, c, version)
         end
       end, self.bufnr)
 
@@ -315,11 +339,9 @@ function STHighlighter:process_response(response, client, version)
     return
   end
 
-  -- reset active request
-  state.active_request = {}
-
   -- skip nil responses
   if response == nil then
+    state.active_request = {}
     return
   end
 
@@ -347,12 +369,19 @@ function STHighlighter:process_response(response, client, version)
     tokens = response.data
   end
 
-  -- Update the state with the new results
+  -- convert token list to highlight ranges
+  -- this could yield and run over multiple event loop iterations
+  local highlights = tokens_to_ranges(tokens, self.bufnr, client, state.active_request)
+
+  -- reset active request
+  state.active_request = {}
+
+  -- update the state with the new results
   local current_result = state.current_result
   current_result.version = version
   current_result.result_id = response.resultId
   current_result.tokens = tokens
-  current_result.highlights = tokens_to_ranges(tokens, self.bufnr, client)
+  current_result.highlights = highlights
   current_result.namespace_cleared = false
 
   -- redraw all windows displaying buffer
-- 
cgit 


From 37dd818722c50a5dbe0771a88a1cdaf98d9596b5 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Mon, 1 May 2023 10:55:51 +0200
Subject: vim-patch:9.0.1503: Luau files are not recognized (#23412)

Problem:    Luau files are not recognized.
Solution:   Add a patter for Luau files. (Amaan Qureshi, closes vim/vim#12317)

https://github.com/vim/vim/commit/2dcfe9ae1df61e1249520ed435dd8cf60e157103

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 4fafc4e2e2..5c799b23f2 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -637,6 +637,7 @@ local extension = {
   nse = 'lua',
   rockspec = 'lua',
   lua = 'lua',
+  luau = 'luau',
   lrc = 'lyrics',
   m = function(path, bufnr)
     return require('vim.filetype.detect').m(bufnr)
-- 
cgit 


From 26cc946226d96bf6b474d850b961e1060346c96f Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 1 May 2023 10:32:29 +0100
Subject: fix(treesitter): foldexpr tweaks

Some small general fixes found working on developing async parsing.
---
 runtime/lua/vim/treesitter/_fold.lua        | 40 ++++++++++++++++++++++++-----
 runtime/lua/vim/treesitter/languagetree.lua |  2 +-
 2 files changed, 34 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index 7df93d1b2e..51e60bf495 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -1,3 +1,5 @@
+local ts = vim.treesitter
+
 local Range = require('vim.treesitter._range')
 
 local api = vim.api
@@ -90,21 +92,45 @@ local function trim_level(level)
   return level
 end
 
+--- If a parser doesn't have any ranges explicitly set, treesitter will
+--- return a range with end_row and end_bytes with a value of UINT32_MAX,
+--- so clip end_row to the max buffer line.
+---
+--- TODO(lewis6991): Handle this generally
+---
+--- @param bufnr integer
+--- @param erow integer?
+--- @return integer
+local function normalise_erow(bufnr, erow)
+  local max_erow = api.nvim_buf_line_count(bufnr) - 1
+  return math.min(erow or max_erow, max_erow)
+end
+
 ---@param bufnr integer
 ---@param info TS.FoldInfo
 ---@param srow integer?
 ---@param erow integer?
 local function get_folds_levels(bufnr, info, srow, erow)
+  if not api.nvim_buf_is_valid(bufnr) then
+    return false
+  end
+
   srow = srow or 0
-  erow = erow or api.nvim_buf_line_count(bufnr)
+  erow = normalise_erow(bufnr, erow)
 
   info:invalidate_range(srow, erow)
 
   local prev_start = -1
   local prev_stop = -1
 
-  vim.treesitter.get_parser(bufnr):for_each_tree(function(tree, ltree)
-    local query = vim.treesitter.query.get(ltree:lang(), 'folds')
+  local parser = ts.get_parser(bufnr)
+
+  if not parser:is_valid() then
+    return
+  end
+
+  parser:for_each_tree(function(tree, ltree)
+    local query = ts.query.get(ltree:lang(), 'folds')
     if not query then
       return
     end
@@ -112,9 +138,9 @@ local function get_folds_levels(bufnr, info, srow, erow)
     -- erow in query is end-exclusive
     local q_erow = erow and erow + 1 or -1
 
-    for id, node, metadata in query:iter_captures(tree:root(), bufnr, srow or 0, q_erow) do
+    for id, node, metadata in query:iter_captures(tree:root(), bufnr, srow, q_erow) do
       if query.captures[id] == 'fold' then
-        local range = vim.treesitter.get_range(node, bufnr, metadata[id])
+        local range = ts.get_range(node, bufnr, metadata[id])
         local start, _, stop, stop_col = Range.unpack4(range)
 
         if stop_col == 0 then
@@ -226,7 +252,7 @@ function M.foldexpr(lnum)
   lnum = lnum or vim.v.lnum
   local bufnr = api.nvim_get_current_buf()
 
-  if not vim.treesitter._has_parser(bufnr) or not lnum then
+  if not ts._has_parser(bufnr) or not lnum then
     return '0'
   end
 
@@ -234,7 +260,7 @@ function M.foldexpr(lnum)
     foldinfos[bufnr] = FoldInfo.new()
     get_folds_levels(bufnr, foldinfos[bufnr])
 
-    local parser = vim.treesitter.get_parser(bufnr)
+    local parser = ts.get_parser(bufnr)
     parser:register_cbs({
       on_changedtree = function(tree_changes)
         on_changedtree(bufnr, foldinfos[bufnr], tree_changes)
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 19cea32367..1adf6759fa 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -262,7 +262,7 @@ function LanguageTree:parse()
           tcall(self._parser.parse, self._parser, self._trees[i], self._source, true)
 
         -- Pass ranges if this is an initial parse
-        local cb_changes = self._trees[i] and tree_changes or ranges
+        local cb_changes = self._trees[i] and tree_changes or tree:included_ranges(true)
 
         self:_do_callback('changedtree', cb_changes, tree)
         self._trees[i] = tree
-- 
cgit 


From fba18a3b62310f4535d979a05288101b9af2ef50 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 2 May 2023 10:07:18 +0100
Subject: fix(treesitter): do not calc folds on unloaded buffers

Fixes #23423
---
 runtime/lua/vim/treesitter/_fold.lua | 20 ++++++++++++++------
 1 file changed, 14 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index 51e60bf495..edceb8217a 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -111,10 +111,6 @@ end
 ---@param srow integer?
 ---@param erow integer?
 local function get_folds_levels(bufnr, info, srow, erow)
-  if not api.nvim_buf_is_valid(bufnr) then
-    return false
-  end
-
   srow = srow or 0
   erow = normalise_erow(bufnr, erow)
 
@@ -210,13 +206,25 @@ local function recompute_folds()
   vim._foldupdate()
 end
 
+--- Schedule a function only if bufnr is loaded
+---@param bufnr integer
+---@param fn function
+local function schedule_if_loaded(bufnr, fn)
+  vim.schedule(function()
+    if not api.nvim_buf_is_loaded(bufnr) then
+      return
+    end
+    fn()
+  end)
+end
+
 ---@param bufnr integer
 ---@param foldinfo TS.FoldInfo
 ---@param tree_changes Range4[]
 local function on_changedtree(bufnr, foldinfo, tree_changes)
   -- For some reason, queries seem to use the old buffer state in on_bytes.
   -- Get around this by scheduling and manually updating folds.
-  vim.schedule(function()
+  schedule_if_loaded(bufnr, function()
     for _, change in ipairs(tree_changes) do
       local srow, _, erow = Range.unpack4(change)
       get_folds_levels(bufnr, foldinfo, srow, erow)
@@ -238,7 +246,7 @@ local function on_bytes(bufnr, foldinfo, start_row, old_row, new_row)
     foldinfo:remove_range(end_row_new, end_row_old)
   elseif new_row > old_row then
     foldinfo:add_range(start_row, end_row_new)
-    vim.schedule(function()
+    schedule_if_loaded(bufnr, function()
       get_folds_levels(bufnr, foldinfo, start_row, end_row_new)
       recompute_folds()
     end)
-- 
cgit 


From 3ba930844c302dc43d32a30ed453667409596c4a Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 2 May 2023 22:27:14 +0100
Subject: perf(treesitter): insert/remove items efficiently (#23443)

---
 runtime/lua/vim/treesitter/_fold.lua | 63 +++++++++++++++++++++++++++++-------
 1 file changed, 52 insertions(+), 11 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index edceb8217a..f6425d7cb9 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -34,15 +34,58 @@ function FoldInfo:invalidate_range(srow, erow)
   end
 end
 
+--- Efficiently remove items from middle of a list a list.
+---
+--- Calling table.remove() in a loop will re-index the tail of the table on
+--- every iteration, instead this function will re-index  the table exactly
+--- once.
+---
+--- Based on https://stackoverflow.com/questions/12394841/safely-remove-items-from-an-array-table-while-iterating/53038524#53038524
+---
+---@param t any[]
+---@param first integer
+---@param last integer
+local function list_remove(t, first, last)
+  local n = #t
+  for i = 0, n - first do
+    t[first + i] = t[last + 1 + i]
+    t[last + 1 + i] = nil
+  end
+end
+
 ---@package
 ---@param srow integer
 ---@param erow integer
 function FoldInfo:remove_range(srow, erow)
-  for i = erow - 1, srow, -1 do
-    table.remove(self.levels, i + 1)
-    table.remove(self.levels0, i + 1)
-    table.remove(self.start_counts, i + 1)
-    table.remove(self.stop_counts, i + 1)
+  list_remove(self.levels, srow + 1, erow)
+  list_remove(self.levels0, srow + 1, erow)
+  list_remove(self.start_counts, srow + 1, erow)
+  list_remove(self.stop_counts, srow + 1, erow)
+end
+
+--- Efficiently insert items into the middle of a list.
+---
+--- Calling table.insert() in a loop will re-index the tail of the table on
+--- every iteration, instead this function will re-index  the table exactly
+--- once.
+---
+--- Based on https://stackoverflow.com/questions/12394841/safely-remove-items-from-an-array-table-while-iterating/53038524#53038524
+---
+---@param t any[]
+---@param first integer
+---@param last integer
+---@param v any
+local function list_insert(t, first, last, v)
+  local n = #t
+
+  -- Shift table forward
+  for i = n - first, 0, -1 do
+    t[last + 1 + i] = t[first + i]
+  end
+
+  -- Fill in new values
+  for i = first, last do
+    t[i] = v
   end
 end
 
@@ -50,12 +93,10 @@ end
 ---@param srow integer
 ---@param erow integer
 function FoldInfo:add_range(srow, erow)
-  for i = srow, erow - 1 do
-    table.insert(self.levels, i + 1, '-1')
-    table.insert(self.levels0, i + 1, -1)
-    table.insert(self.start_counts, i + 1, nil)
-    table.insert(self.stop_counts, i + 1, nil)
-  end
+  list_insert(self.levels, srow + 1, erow, '-1')
+  list_insert(self.levels0, srow + 1, erow, -1)
+  list_insert(self.start_counts, srow + 1, erow, nil)
+  list_insert(self.stop_counts, srow + 1, erow, nil)
 end
 
 ---@package
-- 
cgit 


From 648f777931d49b8013146f69d7e2776f69c52900 Mon Sep 17 00:00:00 2001
From: jdrouhard <john@drouhard.dev>
Date: Fri, 5 May 2023 00:41:36 -0500
Subject: perf(lsp): load buffer contents once when processing semantic tokens
 responses (#23484)

perf(lsp): load buffer contents once when processing semantic token responses

Using _get_line_byte_from_position() for each token's boundaries was a
pretty huge bottleneck, since that function would load individual buffer
lines via nvim_buf_get_lines() (plus a lot of extra overhead). So each
token caused two calls to nvim_buf_get_lines() (once for the start
position, and once for the end position).

For semantic tokens, we only attach to buffers that have already been
loaded, so we can safely just get all the lines for the entire buffer at
once, and lift the rest of the _get_line_byte_from_position()
implementation directly while bypassing the part that loads the buffer
line.

While I was looking at get_lines (used by _get_line_byte_from_position),
I noticed that we were checking for non-file URIs before we even looked
to see if we already had the buffer loaded. Moving the buffer-loaded
check to be the first thing done in get_lines() more than halved the
average time spent transforming the token list into highlight ranges vs
when it was still using _get_line_byte_from_position. I ended up
improving that loop more by not using get_lines, but figured the
performance improvement it provided was worth leaving in.
---
 runtime/lua/vim/lsp/semantic_tokens.lua | 17 ++++++++++++-----
 runtime/lua/vim/lsp/util.lua            | 12 ++++++------
 2 files changed, 18 insertions(+), 11 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index b6b09c58b1..376cac19a7 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -99,6 +99,7 @@ local function tokens_to_ranges(data, bufnr, client, request)
   local legend = client.server_capabilities.semanticTokensProvider.legend
   local token_types = legend.tokenTypes
   local token_modifiers = legend.tokenModifiers
+  local lines = api.nvim_buf_get_lines(bufnr, 0, -1, false)
   local ranges = {}
 
   local start = uv.hrtime()
@@ -137,11 +138,17 @@ local function tokens_to_ranges(data, bufnr, client, request)
     local modifiers = modifiers_from_number(data[i + 4], token_modifiers)
 
     ---@private
-    local function _get_byte_pos(char_pos)
-      return util._get_line_byte_from_position(bufnr, {
-        line = line,
-        character = char_pos,
-      }, client.offset_encoding)
+    local function _get_byte_pos(col)
+      if col > 0 then
+        local buf_line = lines[line + 1] or ''
+        local ok, result
+        ok, result = pcall(util._str_byteindex_enc, buf_line, col, client.offset_encoding)
+        if ok then
+          return result
+        end
+        return math.min(#buf_line, col)
+      end
+      return col
     end
 
     local start_col = _get_byte_pos(start_char)
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 31af2afb0b..8274361f6d 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -253,12 +253,17 @@ local function get_lines(bufnr, rows)
   ---@private
   local function buf_lines()
     local lines = {}
-    for _, row in pairs(rows) do
+    for _, row in ipairs(rows) do
       lines[row] = (api.nvim_buf_get_lines(bufnr, row, row + 1, false) or { '' })[1]
     end
     return lines
   end
 
+  -- use loaded buffers if available
+  if vim.fn.bufloaded(bufnr) == 1 then
+    return buf_lines()
+  end
+
   local uri = vim.uri_from_bufnr(bufnr)
 
   -- load the buffer if this is not a file uri
@@ -268,11 +273,6 @@ local function get_lines(bufnr, rows)
     return buf_lines()
   end
 
-  -- use loaded buffers if available
-  if vim.fn.bufloaded(bufnr) == 1 then
-    return buf_lines()
-  end
-
   local filename = api.nvim_buf_get_name(bufnr)
 
   -- get the data from the file
-- 
cgit 


From 9248dd77ac58bd23721dc4e156e43ed5e9ada338 Mon Sep 17 00:00:00 2001
From: marcoSven <me@marcosven.com>
Date: Sat, 6 May 2023 21:53:36 +0200
Subject: feat(lua): add hl priority opts on yank (#23509)

feat(lua): add hl priority opts on_yank

Signed-off-by: marcoSven <me@marcosven.com>
---
 runtime/lua/vim/highlight.lua | 14 ++++++--------
 1 file changed, 6 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/highlight.lua b/runtime/lua/vim/highlight.lua
index a6cfcb730f..86e1adb49e 100644
--- a/runtime/lua/vim/highlight.lua
+++ b/runtime/lua/vim/highlight.lua
@@ -61,6 +61,7 @@ local yank_timer
 --              - on_macro  highlight when executing macro (default false)
 --              - on_visual highlight when yanking visual selection (default true)
 --              - event     event structure (default vim.v.event)
+--              - priority  integer priority (default |vim.highlight.priorities|`.user`)
 function M.on_yank(opts)
   vim.validate({
     opts = {
@@ -99,14 +100,11 @@ function M.on_yank(opts)
     yank_timer:close()
   end
 
-  M.range(
-    bufnr,
-    yank_ns,
-    higroup,
-    "'[",
-    "']",
-    { regtype = event.regtype, inclusive = event.inclusive, priority = M.priorities.user }
-  )
+  M.range(bufnr, yank_ns, higroup, "'[", "']", {
+    regtype = event.regtype,
+    inclusive = event.inclusive,
+    priority = opts.priority or M.priorities.user,
+  })
 
   yank_timer = vim.defer_fn(function()
     yank_timer = nil
-- 
cgit 


From 02f92978fe4f4d465260a9936dca1526bbe76931 Mon Sep 17 00:00:00 2001
From: hituzi no sippo <43565959+hituzi-no-sippo@users.noreply.github.com>
Date: Wed, 10 May 2023 00:24:49 +0900
Subject: docs(lsp): fix type of `config.cmd` argument for
 `vim.lsp.start_client` (#23550)

---
 runtime/lua/vim/lsp.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 5c78bd7580..b86d41b234 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -901,7 +901,7 @@ end
 --- Field `cmd` in {config} is required.
 ---
 ---@param config (table) Configuration for the server:
---- - cmd: (table|string|fun(dispatchers: table):table) command string or
+--- - cmd: (string[]|fun(dispatchers: table):table) command string or
 ---       list treated like |jobstart()|. The command must launch the language server
 ---       process. `cmd` can also be a function that creates an RPC client.
 ---       The function receives a dispatchers table and must return a table with the
-- 
cgit 


From 075a72d5ff9d49b1e93c0253b54931ecdcf673f3 Mon Sep 17 00:00:00 2001
From: Jon Huhn <nojnhuh@users.noreply.github.com>
Date: Tue, 9 May 2023 11:12:54 -0500
Subject: fix(lsp): fix relative patterns for `workspace/didChangeWatchedFiles`
 (#23548)

---
 runtime/lua/vim/lsp/_watchfiles.lua | 10 +++++++++-
 1 file changed, 9 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
index 533a955925..3a78724d79 100644
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -198,16 +198,17 @@ function M.register(reg, ctx)
   end
   local watch_regs = {}
   for _, w in ipairs(reg.registerOptions.watchers) do
+    local relative_pattern = false
     local glob_patterns = {}
     if type(w.globPattern) == 'string' then
       for _, folder in ipairs(client.workspace_folders) do
         table.insert(glob_patterns, { baseUri = folder.uri, pattern = w.globPattern })
       end
     else
+      relative_pattern = true
       table.insert(glob_patterns, w.globPattern)
     end
     for _, glob_pattern in ipairs(glob_patterns) do
-      local pattern = parse(glob_pattern.pattern)
       local base_dir = nil
       if type(glob_pattern.baseUri) == 'string' then
         base_dir = glob_pattern.baseUri
@@ -216,9 +217,16 @@ function M.register(reg, ctx)
       end
       assert(base_dir, "couldn't identify root of watch")
       base_dir = vim.uri_to_fname(base_dir)
+
       local kind = w.kind
         or protocol.WatchKind.Create + protocol.WatchKind.Change + protocol.WatchKind.Delete
 
+      local pattern = glob_pattern.pattern
+      if relative_pattern then
+        pattern = base_dir .. '/' .. pattern
+      end
+      pattern = parse(pattern)
+
       table.insert(watch_regs, {
         base_dir = base_dir,
         pattern = pattern,
-- 
cgit 


From 4e5061dba765df2a74ac4a8182f6e7fe21da125d Mon Sep 17 00:00:00 2001
From: hituzi no sippo <43565959+hituzi-no-sippo@users.noreply.github.com>
Date: Wed, 10 May 2023 04:00:29 +0900
Subject: docs(lsp): fix `config.cmd` argument for `vim.lsp.start_client`
 (#23560)

---
 runtime/lua/vim/lsp.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index b86d41b234..a724593188 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -901,8 +901,8 @@ end
 --- Field `cmd` in {config} is required.
 ---
 ---@param config (table) Configuration for the server:
---- - cmd: (string[]|fun(dispatchers: table):table) command string or
----       list treated like |jobstart()|. The command must launch the language server
+--- - cmd: (string[]|fun(dispatchers: table):table) command a list of
+---       strings treated like |jobstart()|. The command must launch the language server
 ---       process. `cmd` can also be a function that creates an RPC client.
 ---       The function receives a dispatchers table and must return a table with the
 ---       functions `request`, `notify`, `is_closing` and `terminate`
-- 
cgit 


From e90b506903babc84f8c5b796c3b25c7f20e183d2 Mon Sep 17 00:00:00 2001
From: Gaétan Lepage <33058747+GaetanLepage@users.noreply.github.com>
Date: Thu, 11 May 2023 09:43:02 +0200
Subject: vim-patch:9.0.1539: typst filetype is not recognized (#23578)

Problem:    Typst filetype is not recognized.
Solution:   Distinguish between sql and typst. (Gaetan Lepage, closes vim/vim#12363)

https://github.com/vim/vim/commit/4ce1bda869e4ec0152d7dcbe1e491ceac5341d5e
---
 runtime/lua/vim/filetype.lua        |  4 +++-
 runtime/lua/vim/filetype/detect.lua | 22 ++++++++++++++++++++++
 2 files changed, 25 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 5c799b23f2..c746eef1bb 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -997,7 +997,9 @@ local extension = {
   spi = 'spyce',
   spy = 'spyce',
   tyc = 'sql',
-  typ = 'sql',
+  typ = function(path, bufnr)
+    return require('vim.filetype.detect').typ(bufnr)
+  end,
   pkb = 'sql',
   tyb = 'sql',
   pks = 'sql',
diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index 74b01d569c..94106a3547 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -1322,6 +1322,28 @@ function M.txt(bufnr)
   end
 end
 
+function M.typ(bufnr)
+  if vim.g.filetype_typ then
+    return vim.g.filetype_typ
+  end
+
+  for _, line in ipairs(getlines(bufnr, 1, 200)) do
+    if
+      findany(line, {
+        '^CASE[%s]?=[%s]?SAME$',
+        '^CASE[%s]?=[%s]?LOWER$',
+        '^CASE[%s]?=[%s]?UPPER$',
+        '^CASE[%s]?=[%s]?OPPOSITE$',
+        '^TYPE%s',
+      })
+    then
+      return 'sql'
+    end
+  end
+
+  return 'typst'
+end
+
 -- Determine if a .v file is Verilog, V, or Coq
 function M.v(bufnr)
   if vim.fn.did_filetype() ~= 0 then
-- 
cgit 


From af040c3a079f6e25db0ad6b908aa1327f67deb82 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 11 May 2023 11:13:32 +0100
Subject: feat(treesitter): add support for setting query depths

---
 runtime/lua/vim/treesitter/_meta.lua | 14 ++++++++------
 runtime/lua/vim/treesitter/query.lua |  8 ++++++--
 2 files changed, 14 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index 4d0f43d030..c1009f5f5d 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -31,17 +31,19 @@ local TSNode = {}
 
 ---@param query userdata
 ---@param captures true
----@param start integer
----@param end_ integer
+---@param start? integer
+---@param end_? integer
+---@param opts? table
 ---@return fun(): integer, TSNode, any
-function TSNode:_rawquery(query, captures, start, end_) end
+function TSNode:_rawquery(query, captures, start, end_, opts) end
 
 ---@param query userdata
 ---@param captures false
----@param start integer
----@param end_ integer
+---@param start? integer
+---@param end_? integer
+---@param opts? table
 ---@return fun(): string, any
-function TSNode:_rawquery(query, captures, start, end_) end
+function TSNode:_rawquery(query, captures, start, end_, opts) end
 
 ---@class TSParser
 ---@field parse fun(self: TSParser, tree: TSTree?, source: integer|string, include_bytes: boolean?): TSTree, integer[]
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 93841bb31e..e6a117557a 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -686,16 +686,20 @@ end
 ---@param source (integer|string) Source buffer or string to search
 ---@param start integer Starting line for the search
 ---@param stop integer Stopping line for the search (end-exclusive)
+---@param opts table|nil Options:
+---   - max_start_depth (integer) if non-zero, sets the maximum start depth
+---     for each match. This is used to prevent traversing too deep into a tree.
+---     Requires treesitter >= 0.20.9.
 ---
 ---@return (fun(): integer, table<integer,TSNode>, table): pattern id, match, metadata
-function Query:iter_matches(node, source, start, stop)
+function Query:iter_matches(node, source, start, stop, opts)
   if type(source) == 'number' and source == 0 then
     source = api.nvim_get_current_buf()
   end
 
   start, stop = value_or_node_range(start, stop, node)
 
-  local raw_iter = node:_rawquery(self.query, false, start, stop)
+  local raw_iter = node:_rawquery(self.query, false, start, stop, opts)
   ---@cast raw_iter fun(): string, any
   local function iter()
     local pattern, match = raw_iter()
-- 
cgit 


From 512a90520e3287b9962ed7853d1f1021b564a133 Mon Sep 17 00:00:00 2001
From: Raphael <glephunter@gmail.com>
Date: Sat, 13 May 2023 17:27:05 +0800
Subject: refactor(lsp): mark server_ready function as deprecated (#23520)

---
 runtime/lua/vim/lsp/buf.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 3d9011656f..a307dea673 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -31,7 +31,9 @@ end
 --- ready.
 ---
 ---@returns `true` if server responds.
+---@deprecated
 function M.server_ready()
+  vim.deprecate('vim.lsp.buf.server_ready', nil, '0.10.0')
   return not not vim.lsp.buf_notify(0, 'window/progress', {})
 end
 
-- 
cgit 


From 32dc484ec9ec2d86a5fc7127e37f1ef115b9be76 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 13 May 2023 13:29:11 +0200
Subject: fix(treesitter): support subfiletypes in get_lang (#23605)

---
 runtime/lua/vim/treesitter/language.lua | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index b616d4d70b..08c297c9ad 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -27,6 +27,11 @@ function M.get_lang(filetype)
   if filetype == '' then
     return
   end
+  if ft_to_lang[filetype] then
+    return ft_to_lang[filetype]
+  end
+  -- support subfiletypes like html.glimmer
+  filetype = vim.split(filetype, '.', { plain = true })[1]
   return ft_to_lang[filetype]
 end
 
-- 
cgit 


From 6f29c68928c3f20d9a1b1a7a311cfac65aa1b4e6 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 13 May 2023 15:00:08 +0200
Subject: vim-patch:9.0.1549: USD filetype is not recognized (#23608)

Problem:    USD filetype is not recognized.
Solution:   Add patterns for USD filetype. (Colin Kennedy, closes vim/vim#12370)

https://github.com/vim/vim/commit/b848ce6b7e27f24aff47a4d63933e0f96663acfe

Co-authored-by: Colin Kennedy <colinvfx@gmail.com>
---
 runtime/lua/vim/filetype.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index c746eef1bb..5075c18976 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1080,6 +1080,8 @@ local extension = {
   uit = 'uil',
   uil = 'uil',
   ungram = 'ungrammar',
+  usd = 'usd',
+  usda = 'usd',
   sba = 'vb',
   vb = 'vb',
   dsm = 'vb',
-- 
cgit 


From 08991b078267e5de0a19a136d00d4f71ad651a32 Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Sat, 13 May 2023 21:33:22 +0200
Subject: docs: small fixes

Co-authored-by: Christian Clason <c.clason@uni-graz.at>
Co-authored-by: Gregory Anders <greg@gpanders.com>
Co-authored-by: HiPhish <hiphish@posteo.de>
Co-authored-by: Julio B <julio.bacel@gmail.com>
Co-authored-by: T727 <74924917+T-727@users.noreply.github.com>
Co-authored-by: camoz <camoz@users.noreply.github.com>
Co-authored-by: champignoom <66909116+champignoom@users.noreply.github.com>
---
 runtime/lua/vim/_editor.lua                 | 2 +-
 runtime/lua/vim/_inspector.lua              | 2 +-
 runtime/lua/vim/lsp.lua                     | 2 +-
 runtime/lua/vim/shared.lua                  | 8 ++++----
 runtime/lua/vim/treesitter/languagetree.lua | 6 ++++--
 runtime/lua/vim/treesitter/query.lua        | 4 ++--
 runtime/lua/vim/version.lua                 | 2 +-
 7 files changed, 14 insertions(+), 12 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 20e813d77c..b26def5958 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -778,7 +778,7 @@ do
   -- some bugs, so fake the two-step dance for now.
   local matches
 
-  --- Omnifunc for completing lua values from from the runtime lua interpreter,
+  --- Omnifunc for completing lua values from the runtime lua interpreter,
   --- similar to the builtin completion for the `:lua` command.
   ---
   --- Activate using `set omnifunc=v:lua.vim.lua_omnifunc` in a lua buffer.
diff --git a/runtime/lua/vim/_inspector.lua b/runtime/lua/vim/_inspector.lua
index 2ebb7a7efd..ecd39c35bc 100644
--- a/runtime/lua/vim/_inspector.lua
+++ b/runtime/lua/vim/_inspector.lua
@@ -90,7 +90,7 @@ function vim.inspect_pos(bufnr, row, col, filter)
     nsmap[id] = name
   end
 
-  --- Convert an extmark tuple into a map-like table
+  --- Convert an extmark tuple into a table
   --- @private
   local function to_map(extmark)
     extmark = {
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index a724593188..92f5653158 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -913,7 +913,7 @@ end
 ---       the `cmd` process. Not related to `root_dir`.
 ---
 --- - cmd_env: (table) Environment flags to pass to the LSP on
----       spawn.  Must be specified using a map-like table.
+---       spawn.  Must be specified using a table.
 ---       Non-string values are coerced to string.
 ---       Example:
 ---       <pre>
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index a55deb1415..4f230c4412 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -361,7 +361,7 @@ local function tbl_extend(behavior, deep_extend, ...)
   return ret
 end
 
---- Merges two or more map-like tables.
+--- Merges two or more tables.
 ---
 ---@see |extend()|
 ---
@@ -369,13 +369,13 @@ end
 ---      - "error": raise an error
 ---      - "keep":  use value from the leftmost map
 ---      - "force": use value from the rightmost map
----@param ... table Two or more map-like tables
+---@param ... table Two or more tables
 ---@return table Merged table
 function vim.tbl_extend(behavior, ...)
   return tbl_extend(behavior, false, ...)
 end
 
---- Merges recursively two or more map-like tables.
+--- Merges recursively two or more tables.
 ---
 ---@see |vim.tbl_extend()|
 ---
@@ -385,7 +385,7 @@ end
 ---      - "error": raise an error
 ---      - "keep":  use value from the leftmost map
 ---      - "force": use value from the rightmost map
----@param ... T2 Two or more map-like tables
+---@param ... T2 Two or more tables
 ---@return T1|T2 (table) Merged table
 function vim.tbl_deep_extend(behavior, ...)
   return tbl_extend(behavior, true, ...)
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 1adf6759fa..0efe3af85c 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -882,10 +882,12 @@ end
 ---@param cbs table An |nvim_buf_attach()|-like table argument with the following handlers:
 ---           - `on_bytes` : see |nvim_buf_attach()|, but this will be called _after_ the parsers callback.
 ---           - `on_changedtree` : a callback that will be called every time the tree has syntactical changes.
----              It will only be passed one argument, which is a table of the ranges (as node ranges) that
----              changed.
+---              It will be passed two arguments: a table of the ranges (as node ranges) that
+---              changed and the changed tree.
 ---           - `on_child_added` : emitted when a child is added to the tree.
 ---           - `on_child_removed` : emitted when a child is removed from the tree.
+---           - `on_detach` : emitted when the buffer is detached, see |nvim_buf_detach_event|.
+---              Takes one argument, the number of the buffer.
 --- @param recursive? boolean Apply callbacks recursively for all children. Any new children will
 ---                           also inherit the callbacks.
 function LanguageTree:register_cbs(cbs, recursive)
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index e6a117557a..75e5bf8870 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -609,10 +609,10 @@ end
 ---
 --- {source} is needed if the query contains predicates; then the caller
 --- must ensure to use a freshly parsed tree consistent with the current
---- text of the buffer (if relevant). {start_row} and {end_row} can be used to limit
+--- text of the buffer (if relevant). {start} and {stop} can be used to limit
 --- matches inside a row range (this is typically used with root node
 --- as the {node}, i.e., to get syntax highlight matches in the current
---- viewport). When omitted, the {start} and {end} row values are used from the given node.
+--- viewport). When omitted, the {start} and {stop} row values are used from the given node.
 ---
 --- The iterator returns three values: a numeric id identifying the capture,
 --- the captured node, and metadata from any directives processing the match.
diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index 3aacf3d4e0..ebe8f4e053 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -333,7 +333,7 @@ local function create_err_msg(v)
   return string.format('invalid version: %s (%s)', tostring(v), type(v))
 end
 
---- Parses and compares two version version objects (the result of |vim.version.parse()|, or
+--- Parses and compares two version objects (the result of |vim.version.parse()|, or
 --- specified literally as a `{major, minor, patch}` tuple, e.g. `{1, 0, 3}`).
 ---
 --- Example:
-- 
cgit 


From 9ff59517cbf309d31f979a49b7dc82b237ecfcc4 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 13 May 2023 12:56:21 +0200
Subject: fix(treesitter): update c queries

---
 runtime/lua/vim/treesitter/query.lua | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 75e5bf8870..73b561c777 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -382,6 +382,39 @@ local predicate_handlers = {
 
     return string_set[node_text]
   end,
+
+  ['has-ancestor?'] = function(match, _, _, predicate)
+    local node = match[predicate[2]]
+    if not node then
+      return true
+    end
+
+    local ancestor_types = {}
+    for _, type in ipairs({ unpack(predicate, 3) }) do
+      ancestor_types[type] = true
+    end
+
+    node = node:parent()
+    while node do
+      if ancestor_types[node:type()] then
+        return true
+      end
+      node = node:parent()
+    end
+    return false
+  end,
+
+  ['has-parent?'] = function(match, _, _, predicate)
+    local node = match[predicate[2]]
+    if not node then
+      return true
+    end
+
+    if vim.list_contains({ unpack(predicate, 3) }, node:parent():type()) then
+      return true
+    end
+    return false
+  end,
 }
 
 -- As we provide lua-match? also expose vim-match?
-- 
cgit 


From 6b19170d44ca56cf65542ee184d2bc89c6d622a9 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 16 May 2023 16:41:47 +0100
Subject: fix(treesitter): correctly calculate bytes for text sources (#23655)

Fixes #20419
---
 runtime/lua/vim/treesitter/_range.lua | 38 ++++++++++++++++++++++++-----------
 1 file changed, 26 insertions(+), 12 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_range.lua b/runtime/lua/vim/treesitter/_range.lua
index f4db5016ac..35081c6400 100644
--- a/runtime/lua/vim/treesitter/_range.lua
+++ b/runtime/lua/vim/treesitter/_range.lua
@@ -143,6 +143,29 @@ function M.contains(r1, r2)
   return true
 end
 
+--- @param source integer|string
+--- @param index integer
+--- @return integer
+local function get_offset(source, index)
+  if index == 0 then
+    return 0
+  end
+
+  if type(source) == 'number' then
+    return api.nvim_buf_get_offset(source, index)
+  end
+
+  local byte = 0
+  local next_offset = source:gmatch('()\n')
+  local line = 1
+  while line <= index do
+    byte = next_offset() --[[@as integer]]
+    line = line + 1
+  end
+
+  return byte
+end
+
 ---@private
 ---@param source integer|string
 ---@param range Range
@@ -152,19 +175,10 @@ function M.add_bytes(source, range)
     return range --[[@as Range6]]
   end
 
-  local start_row, start_col, end_row, end_col = range[1], range[2], range[3], range[4]
-  local start_byte = 0
-  local end_byte = 0
+  local start_row, start_col, end_row, end_col = M.unpack4(range)
   -- TODO(vigoux): proper byte computation here, and account for EOL ?
-  if type(source) == 'number' then
-    -- Easy case, this is a buffer parser
-    start_byte = api.nvim_buf_get_offset(source, start_row) + start_col
-    end_byte = api.nvim_buf_get_offset(source, end_row) + end_col
-  elseif type(source) == 'string' then
-    -- string parser, single `\n` delimited string
-    start_byte = vim.fn.byteidx(source, start_col)
-    end_byte = vim.fn.byteidx(source, end_col)
-  end
+  local start_byte = get_offset(source, start_row) + start_col
+  local end_byte = get_offset(source, end_row) + end_col
 
   return { start_row, start_col, start_byte, end_row, end_col, end_byte }
 end
-- 
cgit 


From 189fb6203262340e7a59e782be970bcd8ae28e61 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 17 May 2023 11:42:18 +0100
Subject: feat(treesitter): improved logging (#23638)

- Add bindings to Treesitter ts_parser_set_logger and ts_parser_logger
- Add logfile with path STDPATH('log')/treesitter.c
- Rework existing LanguageTree loggin to use logfile
- Begin implementing log levels for vim.g.__ts_debug
---
 runtime/lua/vim/fs.lua                      |  6 ++-
 runtime/lua/vim/treesitter/_meta.lua        |  4 ++
 runtime/lua/vim/treesitter/languagetree.lua | 67 +++++++++++++++++++++++++----
 3 files changed, 67 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index 2a51bde263..7f9f3a2bce 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -73,10 +73,14 @@ function M.basename(file)
 end
 
 ---@private
-local function join_paths(...)
+---@param ... string
+---@return string
+function M._join_paths(...)
   return (table.concat({ ... }, '/'):gsub('//+', '/'))
 end
 
+local join_paths = M._join_paths
+
 ---@alias Iterator fun(): string?, string?
 
 --- Return an iterator over the files and directories located in {path}
diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index c1009f5f5d..9ca4b560c6 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -45,6 +45,8 @@ function TSNode:_rawquery(query, captures, start, end_, opts) end
 ---@return fun(): string, any
 function TSNode:_rawquery(query, captures, start, end_, opts) end
 
+---@alias TSLoggerCallback fun(logtype: 'parse'|'lex', msg: string)
+
 ---@class TSParser
 ---@field parse fun(self: TSParser, tree: TSTree?, source: integer|string, include_bytes: boolean?): TSTree, integer[]
 ---@field reset fun(self: TSParser)
@@ -52,6 +54,8 @@ function TSNode:_rawquery(query, captures, start, end_, opts) end
 ---@field set_included_ranges fun(self: TSParser, ranges: Range6[])
 ---@field set_timeout fun(self: TSParser, timeout: integer)
 ---@field timeout fun(self: TSParser): integer
+---@field _set_logger fun(self: TSParser, lex: boolean, parse: boolean, cb: TSLoggerCallback)
+---@field _logger fun(self: TSParser): TSLoggerCallback
 
 ---@class TSTree
 ---@field root fun(self: TSTree): TSNode
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 0efe3af85c..6c780f33c4 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -31,8 +31,17 @@
 --- shouldn't be done directly in the change callback anyway as they will be very frequent. Rather
 --- a plugin that does any kind of analysis on a tree should use a timer to throttle too frequent
 --- updates.
+---
+
+-- Debugging:
+--
+-- vim.g.__ts_debug levels:
+--    - 1. Messages from languagetree.lua
+--    - 2. Parse messages from treesitter
+--    - 2. Lex messages from treesitter
+--
+-- Log file can be found in stdpath('log')/treesitter.log
 
-local api = vim.api
 local query = require('vim.treesitter.query')
 local language = require('vim.treesitter.language')
 local Range = require('vim.treesitter._range')
@@ -75,6 +84,8 @@ local TSCallbackNames = {
 ---@field private _source (integer|string) Buffer or string to parse
 ---@field private _trees TSTree[] Reference to parsed tree (one for each language)
 ---@field private _valid boolean|table<integer,boolean> If the parsed tree is valid
+---@field private _logger? fun(logtype: string, msg: string)
+---@field private _logfile? file*
 local LanguageTree = {}
 
 ---@class LanguageTreeOpts
@@ -114,6 +125,10 @@ function LanguageTree.new(source, lang, opts)
     _callbacks_rec = {},
   }, LanguageTree)
 
+  if vim.g.__ts_debug and type(vim.g.__ts_debug) == 'number' then
+    self:_set_logger()
+  end
+
   for _, name in pairs(TSCallbackNames) do
     self._callbacks[name] = {}
     self._callbacks_rec[name] = {}
@@ -122,6 +137,33 @@ function LanguageTree.new(source, lang, opts)
   return self
 end
 
+function LanguageTree:_set_logger()
+  local source = self:source()
+  source = type(source) == 'string' and 'text' or tostring(source)
+
+  local lang = self:lang()
+
+  local logfilename = vim.fs._join_paths(vim.fn.stdpath('log'), 'treesitter.log')
+
+  local logfile, openerr = io.open(logfilename, 'a+')
+
+  if not logfile or openerr then
+    error(string.format('Could not open file (%s) for logging: %s', logfilename, openerr))
+    return
+  end
+
+  self._logfile = logfile
+
+  self._logger = function(logtype, msg)
+    self._logfile:write(string.format('%s:%s:(%s) %s\n', source, lang, logtype, msg))
+    self._logfile:flush()
+  end
+
+  local log_lex = vim.g.__ts_debug >= 3
+  local log_parse = vim.g.__ts_debug >= 2
+  self._parser:_set_logger(log_lex, log_parse, self._logger)
+end
+
 ---@private
 ---Measure execution time of a function
 ---@generic R1, R2, R3
@@ -139,7 +181,11 @@ end
 ---@private
 ---@vararg any
 function LanguageTree:_log(...)
-  if vim.g.__ts_debug == nil then
+  if not self._logger then
+    return
+  end
+
+  if not vim.g.__ts_debug or vim.g.__ts_debug < 1 then
     return
   end
 
@@ -150,19 +196,17 @@ function LanguageTree:_log(...)
 
   local info = debug.getinfo(2, 'nl')
   local nregions = #self:included_regions()
-  local prefix =
-    string.format('%s:%d: [%s:%d] ', info.name, info.currentline, self:lang(), nregions)
+  local prefix = string.format('%s:%d: (#regions=%d) ', info.name, info.currentline, nregions)
 
-  api.nvim_out_write(prefix)
+  local msg = { prefix }
   for _, x in ipairs(args) do
     if type(x) == 'string' then
-      api.nvim_out_write(x)
+      msg[#msg + 1] = x
     else
-      api.nvim_out_write(vim.inspect(x, { newline = ' ', indent = '' }))
+      msg[#msg + 1] = vim.inspect(x, { newline = ' ', indent = '' })
     end
-    api.nvim_out_write(' ')
   end
-  api.nvim_out_write('\n')
+  self._logger('nvim', table.concat(msg, ' '))
 end
 
 --- Invalidates this parser and all its children
@@ -876,6 +920,11 @@ end
 function LanguageTree:_on_detach(...)
   self:invalidate(true)
   self:_do_callback('detach', ...)
+  if self._logfile then
+    self._logger('nvim', 'detaching')
+    self._logger = nil
+    self._logfile:close()
+  end
 end
 
 --- Registers callbacks for the |LanguageTree|.
-- 
cgit 


From ef64e225f6f6c01280aa8472bebe812016f357bf Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 18 May 2023 10:52:01 +0100
Subject: fix(treesitter): allow foldexpr without highlights (#23672)

Ref nvim-treesitter/nvim-treesitter#4748
---
 runtime/lua/vim/treesitter.lua       | 10 ----------
 runtime/lua/vim/treesitter/_fold.lua |  4 ++--
 2 files changed, 2 insertions(+), 12 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index d1f5996768..12fbe1654f 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -136,16 +136,6 @@ function M.get_parser(bufnr, lang, opts)
   return parsers[bufnr]
 end
 
----@package
----@param bufnr (integer|nil) Buffer number
----@return boolean
-function M._has_parser(bufnr)
-  if bufnr == nil or bufnr == 0 then
-    bufnr = api.nvim_get_current_buf()
-  end
-  return parsers[bufnr] ~= nil
-end
-
 --- Returns a string parser
 ---
 ---@param str string Text to parse
diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index f6425d7cb9..a8f8c7967e 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -301,7 +301,8 @@ function M.foldexpr(lnum)
   lnum = lnum or vim.v.lnum
   local bufnr = api.nvim_get_current_buf()
 
-  if not ts._has_parser(bufnr) or not lnum then
+  local parser = vim.F.npcall(ts.get_parser, bufnr)
+  if not parser then
     return '0'
   end
 
@@ -309,7 +310,6 @@ function M.foldexpr(lnum)
     foldinfos[bufnr] = FoldInfo.new()
     get_folds_levels(bufnr, foldinfos[bufnr])
 
-    local parser = ts.get_parser(bufnr)
     parser:register_cbs({
       on_changedtree = function(tree_changes)
         on_changedtree(bufnr, foldinfos[bufnr], tree_changes)
-- 
cgit 


From 201f366b370a9df724258b3c9bf01ffaadb8dd01 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 19 May 2023 09:11:22 +0200
Subject: vim-patch:9.0.1565: json lines files are not recognized (#23677)

Problem:    Json lines files are not recognized.
Solution:   Add a pattern to detect "jsonl" files. (issue vim/vim#7520)

https://github.com/vim/vim/commit/6fadbc1e8c1f4c5b03eb6a78aeb023ca2c2a9a7d

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 5075c18976..1b04666161 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -579,6 +579,7 @@ local extension = {
   ['json-patch'] = 'json',
   json5 = 'json5',
   jsonc = 'jsonc',
+  jsonl = 'jsonl',
   jsonnet = 'jsonnet',
   libsonnet = 'jsonnet',
   jsp = 'jsp',
-- 
cgit 


From 073035a030f5ef8ae9b9ca51552f887944c52eaa Mon Sep 17 00:00:00 2001
From: Jon Huhn <nojnhuh@users.noreply.github.com>
Date: Sat, 20 May 2023 00:45:39 -0500
Subject: fix(lsp): don't register didChangeWatchedFiles when capability not
 set (#23689)

Some LSP servers (tailwindcss, rome) are known to request registration
for `workspace/didChangeWatchedFiles` even when the corresponding client
capability does not advertise support. This change adds an extra check
in the `client/registerCapability` handler not to start a watch unless
the client capability is set appropriately.
---
 runtime/lua/vim/lsp/_watchfiles.lua | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
index 3a78724d79..cf2c57db1f 100644
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -193,7 +193,12 @@ local to_lsp_change_type = {
 function M.register(reg, ctx)
   local client_id = ctx.client_id
   local client = vim.lsp.get_client_by_id(client_id)
-  if not client.workspace_folders then
+  if
+    -- Ill-behaved servers may not honor the client capability and try to register
+    -- anyway, so ignore requests when the user has opted out of the feature.
+    not client.config.capabilities.workspace.didChangeWatchedFiles.dynamicRegistration
+    or not client.workspace_folders
+  then
     return
   end
   local watch_regs = {}
-- 
cgit 


From e3e6fadfd82861471c32fdcabe00bbef3de84563 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 20 May 2023 17:30:48 +0200
Subject: feat(fs): expose join_paths as `vim.fs.joinpath` (#23685)

This is a small function but used a lot in some plugins.
---
 runtime/lua/vim/fs.lua | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index 7f9f3a2bce..864ba495f1 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -72,15 +72,15 @@ function M.basename(file)
   return file:match('[/\\]$') and '' or (file:match('[^\\/]*$'):gsub('\\', '/'))
 end
 
----@private
+--- Concatenate directories and/or file into a single path with normalization
+--- (e.g., `"foo/"` and `"bar"` get joined to `"foo/bar"`)
+---
 ---@param ... string
 ---@return string
-function M._join_paths(...)
+function M.joinpath(...)
   return (table.concat({ ... }, '/'):gsub('//+', '/'))
 end
 
-local join_paths = M._join_paths
-
 ---@alias Iterator fun(): string?, string?
 
 --- Return an iterator over the files and directories located in {path}
@@ -120,14 +120,14 @@ function M.dir(path, opts)
     local dirs = { { path, 1 } }
     while #dirs > 0 do
       local dir0, level = unpack(table.remove(dirs, 1))
-      local dir = level == 1 and dir0 or join_paths(path, dir0)
+      local dir = level == 1 and dir0 or M.joinpath(path, dir0)
       local fs = vim.loop.fs_scandir(M.normalize(dir))
       while fs do
         local name, t = vim.loop.fs_scandir_next(fs)
         if not name then
           break
         end
-        local f = level == 1 and name or join_paths(dir0, name)
+        local f = level == 1 and name or M.joinpath(dir0, name)
         coroutine.yield(f, t)
         if
           opts.depth
@@ -234,7 +234,7 @@ function M.find(names, opts)
         local t = {}
         for name, type in M.dir(p) do
           if (not opts.type or opts.type == type) and names(name, p) then
-            table.insert(t, join_paths(p, name))
+            table.insert(t, M.joinpath(p, name))
           end
         end
         return t
@@ -243,7 +243,7 @@ function M.find(names, opts)
       test = function(p)
         local t = {}
         for _, name in ipairs(names) do
-          local f = join_paths(p, name)
+          local f = M.joinpath(p, name)
           local stat = vim.loop.fs_stat(f)
           if stat and (not opts.type or opts.type == stat.type) then
             t[#t + 1] = f
@@ -280,7 +280,7 @@ function M.find(names, opts)
       end
 
       for other, type_ in M.dir(dir) do
-        local f = join_paths(dir, other)
+        local f = M.joinpath(dir, other)
         if type(names) == 'function' then
           if (not opts.type or opts.type == type_) and names(other, dir) then
             if add(f) then
-- 
cgit 


From 1fe1bb084d0099fc4f9bfdc11189485d0f74b75a Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 19 Dec 2022 16:37:45 +0000
Subject: refactor(options): deprecate nvim[_buf|_win]_[gs]et_option

Co-authored-by: zeertzjq <zeertzjq@outlook.com>
Co-authored-by: famiu <famiuhaque@protonmail.com>
---
 runtime/lua/vim/lsp.lua          | 16 ++++++----------
 runtime/lua/vim/lsp/handlers.lua |  2 +-
 runtime/lua/vim/lsp/util.lua     | 30 +++++++++++++-----------------
 3 files changed, 20 insertions(+), 28 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 92f5653158..2e6ca7a0ac 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -8,12 +8,8 @@ local sync = require('vim.lsp.sync')
 local semantic_tokens = require('vim.lsp.semantic_tokens')
 
 local api = vim.api
-local nvim_err_writeln, nvim_buf_get_lines, nvim_command, nvim_buf_get_option, nvim_exec_autocmds =
-  api.nvim_err_writeln,
-  api.nvim_buf_get_lines,
-  api.nvim_command,
-  api.nvim_buf_get_option,
-  api.nvim_exec_autocmds
+local nvim_err_writeln, nvim_buf_get_lines, nvim_command, nvim_exec_autocmds =
+  api.nvim_err_writeln, api.nvim_buf_get_lines, api.nvim_command, api.nvim_exec_autocmds
 local uv = vim.loop
 local tbl_isempty, tbl_extend = vim.tbl_isempty, vim.tbl_extend
 local validate = vim.validate
@@ -137,7 +133,7 @@ local format_line_ending = {
 ---@param bufnr (number)
 ---@return string
 local function buf_get_line_ending(bufnr)
-  return format_line_ending[nvim_buf_get_option(bufnr, 'fileformat')] or '\n'
+  return format_line_ending[vim.bo[bufnr].fileformat] or '\n'
 end
 
 local client_index = 0
@@ -319,7 +315,7 @@ end
 local function buf_get_full_text(bufnr)
   local line_ending = buf_get_line_ending(bufnr)
   local text = table.concat(nvim_buf_get_lines(bufnr, 0, -1, true), line_ending)
-  if nvim_buf_get_option(bufnr, 'eol') then
+  if vim.bo[bufnr].eol then
     text = text .. line_ending
   end
   return text
@@ -709,7 +705,7 @@ local function text_document_did_open_handler(bufnr, client)
   if not api.nvim_buf_is_loaded(bufnr) then
     return
   end
-  local filetype = nvim_buf_get_option(bufnr, 'filetype')
+  local filetype = vim.bo[bufnr].filetype
 
   local params = {
     textDocument = {
@@ -2177,7 +2173,7 @@ end
 ---
 --- Currently only supports a single client. This can be set via
 --- `setlocal formatexpr=v:lua.vim.lsp.formatexpr()` but will typically or in `on_attach`
---- via ``vim.api.nvim_buf_set_option(bufnr, 'formatexpr', 'v:lua.vim.lsp.formatexpr(#{timeout_ms:250})')``.
+--- via ``vim.bo[bufnr].formatexpr = 'v:lua.vim.lsp.formatexpr(#{timeout_ms:250})'``.
 ---
 ---@param opts table options for customizing the formatting expression which takes the
 ---                   following optional keys:
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 71bef43bc1..8e926c4644 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -454,7 +454,7 @@ function M.signature_help(_, result, ctx, config)
   local client = vim.lsp.get_client_by_id(ctx.client_id)
   local triggers =
     vim.tbl_get(client.server_capabilities, 'signatureHelpProvider', 'triggerCharacters')
-  local ft = api.nvim_buf_get_option(ctx.bufnr, 'filetype')
+  local ft = vim.bo[ctx.bufnr].filetype
   local lines, hl = util.convert_signature_help_to_markdown_lines(result, ft, triggers)
   lines = util.trim_empty_lines(lines)
   if vim.tbl_isempty(lines) then
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 8274361f6d..9fffc845b1 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -401,7 +401,7 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
   if not api.nvim_buf_is_loaded(bufnr) then
     vim.fn.bufload(bufnr)
   end
-  api.nvim_buf_set_option(bufnr, 'buflisted', true)
+  vim.bo[bufnr].buflisted = true
 
   -- Fix reversed range and indexing each text_edits
   local index = 0
@@ -530,11 +530,7 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
 
   -- Remove final line if needed
   local fix_eol = has_eol_text_edit
-  fix_eol = fix_eol
-    and (
-      api.nvim_buf_get_option(bufnr, 'eol')
-      or (api.nvim_buf_get_option(bufnr, 'fixeol') and not api.nvim_buf_get_option(bufnr, 'binary'))
-    )
+  fix_eol = fix_eol and (vim.bo[bufnr].eol or (vim.bo[bufnr].fixeol and not vim.bo[bufnr].binary))
   fix_eol = fix_eol and get_line(bufnr, max - 1) == ''
   if fix_eol then
     api.nvim_buf_set_lines(bufnr, -2, -1, false, {})
@@ -1076,7 +1072,7 @@ function M.make_floating_popup_options(width, height, opts)
 
   local wincol = opts.relative == 'mouse' and vim.fn.getmousepos().column or vim.fn.wincol()
 
-  if wincol + width + (opts.offset_x or 0) <= api.nvim_get_option('columns') then
+  if wincol + width + (opts.offset_x or 0) <= vim.o.columns then
     anchor = anchor .. 'W'
     col = 0
   else
@@ -1142,7 +1138,7 @@ function M.show_document(location, offset_encoding, opts)
     or focus and api.nvim_get_current_win()
     or create_window_without_focus()
 
-  api.nvim_buf_set_option(bufnr, 'buflisted', true)
+  vim.bo[bufnr].buflisted = true
   api.nvim_win_set_buf(win, bufnr)
   if focus then
     api.nvim_set_current_win(win)
@@ -1201,12 +1197,12 @@ function M.preview_location(location, opts)
   end
   local range = location.targetRange or location.range
   local contents = api.nvim_buf_get_lines(bufnr, range.start.line, range['end'].line + 1, false)
-  local syntax = api.nvim_buf_get_option(bufnr, 'syntax')
+  local syntax = vim.bo[bufnr].syntax
   if syntax == '' then
     -- When no syntax is set, we use filetype as fallback. This might not result
     -- in a valid syntax definition. See also ft detection in stylize_markdown.
     -- An empty syntax is more common now with TreeSitter, since TS disables syntax.
-    syntax = api.nvim_buf_get_option(bufnr, 'filetype')
+    syntax = vim.bo[bufnr].filetype
   end
   opts = opts or {}
   opts.focus_id = 'location'
@@ -1665,7 +1661,7 @@ function M.open_floating_preview(contents, syntax, opts)
     contents = M.stylize_markdown(floating_bufnr, contents, opts)
   else
     if syntax then
-      api.nvim_buf_set_option(floating_bufnr, 'syntax', syntax)
+      vim.bo[floating_bufnr].syntax = syntax
     end
     api.nvim_buf_set_lines(floating_bufnr, 0, -1, true, contents)
   end
@@ -1681,16 +1677,16 @@ function M.open_floating_preview(contents, syntax, opts)
   local float_option = M.make_floating_popup_options(width, height, opts)
   local floating_winnr = api.nvim_open_win(floating_bufnr, false, float_option)
   if do_stylize then
-    api.nvim_win_set_option(floating_winnr, 'conceallevel', 2)
-    api.nvim_win_set_option(floating_winnr, 'concealcursor', 'n')
+    vim.wo[floating_winnr].conceallevel = 2
+    vim.wo[floating_winnr].concealcursor = 'n'
   end
   -- disable folding
-  api.nvim_win_set_option(floating_winnr, 'foldenable', false)
+  vim.wo[floating_winnr].foldenable = false
   -- soft wrapping
-  api.nvim_win_set_option(floating_winnr, 'wrap', opts.wrap)
+  vim.wo[floating_winnr].wrap = opts.wrap
 
-  api.nvim_buf_set_option(floating_bufnr, 'modifiable', false)
-  api.nvim_buf_set_option(floating_bufnr, 'bufhidden', 'wipe')
+  vim.bo[floating_bufnr].modifiable = false
+  vim.bo[floating_bufnr].bufhidden = 'wipe'
   api.nvim_buf_set_keymap(
     floating_bufnr,
     'n',
-- 
cgit 


From 44d4ae448d0ab357a3aade773ea58c66c3c969cc Mon Sep 17 00:00:00 2001
From: Matthieu Coudron <teto@users.noreply.github.com>
Date: Fri, 26 May 2023 21:51:18 +0200
Subject: fix: function was renamed (#23772)

---
 runtime/lua/vim/treesitter/languagetree.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 6c780f33c4..244d88f3e0 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -143,7 +143,7 @@ function LanguageTree:_set_logger()
 
   local lang = self:lang()
 
-  local logfilename = vim.fs._join_paths(vim.fn.stdpath('log'), 'treesitter.log')
+  local logfilename = vim.fs.joinpath(vim.fn.stdpath('log'), 'treesitter.log')
 
   local logfile, openerr = io.open(logfilename, 'a+')
 
-- 
cgit 


From ddd92a70d2aab5247895e89abaaa79c62ba7dbb4 Mon Sep 17 00:00:00 2001
From: Folke Lemaitre <folke.lemaitre@gmail.com>
Date: Sun, 28 May 2023 07:51:28 +0200
Subject: feat(lsp): initial support for dynamic capabilities (#23681)

- `client.dynamic_capabilities` is an object that tracks client register/unregister
- `client.supports_method` will additionally check if a dynamic capability supports the method, taking document filters into account. But only if the client enabled `dynamicRegistration` for the capability
- updated the default client capabilities to include dynamicRegistration for:
    - formatting
    - rangeFormatting
    - hover
    - codeAction
    - hover
    - rename
---
 runtime/lua/vim/lsp.lua          | 121 ++++++++++++++++++++++-----------------
 runtime/lua/vim/lsp/_dynamic.lua | 109 +++++++++++++++++++++++++++++++++++
 runtime/lua/vim/lsp/buf.lua      |   6 +-
 runtime/lua/vim/lsp/handlers.lua |  28 ++++++---
 runtime/lua/vim/lsp/protocol.lua |  13 ++++-
 runtime/lua/vim/lsp/types.lua    |  28 +++++++++
 6 files changed, 236 insertions(+), 69 deletions(-)
 create mode 100644 runtime/lua/vim/lsp/_dynamic.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 2e6ca7a0ac..5337abea25 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -50,6 +50,7 @@ lsp._request_name_to_capability = {
   ['textDocument/codeAction'] = { 'codeActionProvider' },
   ['textDocument/codeLens'] = { 'codeLensProvider' },
   ['codeLens/resolve'] = { 'codeLensProvider', 'resolveProvider' },
+  ['codeAction/resolve'] = { 'codeActionProvider', 'resolveProvider' },
   ['workspace/executeCommand'] = { 'executeCommandProvider' },
   ['workspace/symbol'] = { 'workspaceSymbolProvider' },
   ['textDocument/references'] = { 'referencesProvider' },
@@ -886,6 +887,47 @@ function lsp.start(config, opts)
   return client_id
 end
 
+---@private
+-- Determines whether the given option can be set by `set_defaults`.
+local function is_empty_or_default(bufnr, option)
+  if vim.bo[bufnr][option] == '' then
+    return true
+  end
+
+  local info = vim.api.nvim_get_option_info2(option, { buf = bufnr })
+  local scriptinfo = vim.tbl_filter(function(e)
+    return e.sid == info.last_set_sid
+  end, vim.fn.getscriptinfo())
+
+  if #scriptinfo ~= 1 then
+    return false
+  end
+
+  return vim.startswith(scriptinfo[1].name, vim.fn.expand('$VIMRUNTIME'))
+end
+
+---@private
+---@param client lsp.Client
+function lsp._set_defaults(client, bufnr)
+  if
+    client.supports_method('textDocument/definition') and is_empty_or_default(bufnr, 'tagfunc')
+  then
+    vim.bo[bufnr].tagfunc = 'v:lua.vim.lsp.tagfunc'
+  end
+  if
+    client.supports_method('textDocument/completion') and is_empty_or_default(bufnr, 'omnifunc')
+  then
+    vim.bo[bufnr].omnifunc = 'v:lua.vim.lsp.omnifunc'
+  end
+  if
+    client.supports_method('textDocument/rangeFormatting')
+    and is_empty_or_default(bufnr, 'formatprg')
+    and is_empty_or_default(bufnr, 'formatexpr')
+  then
+    vim.bo[bufnr].formatexpr = 'v:lua.vim.lsp.formatexpr()'
+  end
+end
+
 -- FIXME: DOC: Currently all methods on the `vim.lsp.client` object are
 -- documented twice: Here, and on the methods themselves (e.g.
 -- `client.request()`). This is a workaround for the vimdoc generator script
@@ -1090,43 +1132,6 @@ function lsp.start_client(config)
     end
   end
 
-  ---@private
-  -- Determines whether the given option can be set by `set_defaults`.
-  local function is_empty_or_default(bufnr, option)
-    if vim.bo[bufnr][option] == '' then
-      return true
-    end
-
-    local info = vim.api.nvim_get_option_info2(option, { buf = bufnr })
-    local scriptinfo = vim.tbl_filter(function(e)
-      return e.sid == info.last_set_sid
-    end, vim.fn.getscriptinfo())
-
-    if #scriptinfo ~= 1 then
-      return false
-    end
-
-    return vim.startswith(scriptinfo[1].name, vim.fn.expand('$VIMRUNTIME'))
-  end
-
-  ---@private
-  local function set_defaults(client, bufnr)
-    local capabilities = client.server_capabilities
-    if capabilities.definitionProvider and is_empty_or_default(bufnr, 'tagfunc') then
-      vim.bo[bufnr].tagfunc = 'v:lua.vim.lsp.tagfunc'
-    end
-    if capabilities.completionProvider and is_empty_or_default(bufnr, 'omnifunc') then
-      vim.bo[bufnr].omnifunc = 'v:lua.vim.lsp.omnifunc'
-    end
-    if
-      capabilities.documentRangeFormattingProvider
-      and is_empty_or_default(bufnr, 'formatprg')
-      and is_empty_or_default(bufnr, 'formatexpr')
-    then
-      vim.bo[bufnr].formatexpr = 'v:lua.vim.lsp.formatexpr()'
-    end
-  end
-
   ---@private
   --- Reset defaults set by `set_defaults`.
   --- Must only be called if the last client attached to a buffer exits.
@@ -1228,7 +1233,9 @@ function lsp.start_client(config)
     requests = {},
     -- for $/progress report
     messages = { name = name, messages = {}, progress = {}, status = {} },
+    dynamic_capabilities = require('vim.lsp._dynamic').new(client_id),
   }
+  client.config.capabilities = config.capabilities or protocol.make_client_capabilities()
 
   -- Store the uninitialized_clients for cleanup in case we exit before initialize finishes.
   uninitialized_clients[client_id] = client
@@ -1291,7 +1298,7 @@ function lsp.start_client(config)
       -- User provided initialization options.
       initializationOptions = config.init_options,
       -- The capabilities provided by the client (editor or tool)
-      capabilities = config.capabilities or protocol.make_client_capabilities(),
+      capabilities = config.capabilities,
       -- The initial trace setting. If omitted trace is disabled ("off").
       -- trace = "off" | "messages" | "verbose";
       trace = valid_traces[config.trace] or 'off',
@@ -1300,6 +1307,26 @@ function lsp.start_client(config)
       -- TODO(ashkan) handle errors here.
       pcall(config.before_init, initialize_params, config)
     end
+
+    --- @param method string
+    --- @param opts? {bufnr?: number}
+    client.supports_method = function(method, opts)
+      opts = opts or {}
+      local required_capability = lsp._request_name_to_capability[method]
+      -- if we don't know about the method, assume that the client supports it.
+      if not required_capability then
+        return true
+      end
+      if vim.tbl_get(client.server_capabilities or {}, unpack(required_capability)) then
+        return true
+      else
+        if client.dynamic_capabilities:supports_registration(method) then
+          return client.dynamic_capabilities:supports(method, opts)
+        end
+        return false
+      end
+    end
+
     local _ = log.trace() and log.trace(log_prefix, 'initialize_params', initialize_params)
     rpc.request('initialize', initialize_params, function(init_err, result)
       assert(not init_err, tostring(init_err))
@@ -1314,18 +1341,6 @@ function lsp.start_client(config)
       client.server_capabilities =
         assert(result.capabilities, "initialize result doesn't contain capabilities")
       client.server_capabilities = protocol.resolve_capabilities(client.server_capabilities)
-      client.supports_method = function(method)
-        local required_capability = lsp._request_name_to_capability[method]
-        -- if we don't know about the method, assume that the client supports it.
-        if not required_capability then
-          return true
-        end
-        if vim.tbl_get(client.server_capabilities, unpack(required_capability)) then
-          return true
-        else
-          return false
-        end
-      end
 
       if next(config.settings) then
         client.notify('workspace/didChangeConfiguration', { settings = config.settings })
@@ -1522,7 +1537,7 @@ function lsp.start_client(config)
   function client._on_attach(bufnr)
     text_document_did_open_handler(bufnr, client)
 
-    set_defaults(client, bufnr)
+    lsp._set_defaults(client, bufnr)
 
     nvim_exec_autocmds('LspAttach', {
       buffer = bufnr,
@@ -1946,7 +1961,7 @@ function lsp.buf_request(bufnr, method, params, handler)
   local supported_clients = {}
   local method_supported = false
   for_each_buffer_client(bufnr, function(client, client_id)
-    if client.supports_method(method) then
+    if client.supports_method(method, { bufnr = bufnr }) then
       method_supported = true
       table.insert(supported_clients, client_id)
     end
@@ -2002,7 +2017,7 @@ function lsp.buf_request_all(bufnr, method, params, callback)
 
   local set_expected_result_count = once(function()
     for_each_buffer_client(bufnr, function(client)
-      if client.supports_method(method) then
+      if client.supports_method(method, { bufnr = bufnr }) then
         expected_result_count = expected_result_count + 1
       end
     end)
diff --git a/runtime/lua/vim/lsp/_dynamic.lua b/runtime/lua/vim/lsp/_dynamic.lua
new file mode 100644
index 0000000000..04040e8e28
--- /dev/null
+++ b/runtime/lua/vim/lsp/_dynamic.lua
@@ -0,0 +1,109 @@
+local wf = require('vim.lsp._watchfiles')
+
+--- @class lsp.DynamicCapabilities
+--- @field capabilities table<string, lsp.Registration[]>
+--- @field client_id number
+local M = {}
+
+--- @param client_id number
+function M.new(client_id)
+  return setmetatable({
+    capabilities = {},
+    client_id = client_id,
+  }, { __index = M })
+end
+
+function M:supports_registration(method)
+  local client = vim.lsp.get_client_by_id(self.client_id)
+  if not client then
+    return false
+  end
+  local capability = vim.tbl_get(client.config.capabilities, unpack(vim.split(method, '/')))
+  return type(capability) == 'table' and capability.dynamicRegistration
+end
+
+--- @param registrations lsp.Registration[]
+--- @private
+function M:register(registrations)
+  -- remove duplicates
+  self:unregister(registrations)
+  for _, reg in ipairs(registrations) do
+    local method = reg.method
+    if not self.capabilities[method] then
+      self.capabilities[method] = {}
+    end
+    table.insert(self.capabilities[method], reg)
+  end
+end
+
+--- @param unregisterations lsp.Unregistration[]
+--- @private
+function M:unregister(unregisterations)
+  for _, unreg in ipairs(unregisterations) do
+    local method = unreg.method
+    if not self.capabilities[method] then
+      return
+    end
+    local id = unreg.id
+    for i, reg in ipairs(self.capabilities[method]) do
+      if reg.id == id then
+        table.remove(self.capabilities[method], i)
+        break
+      end
+    end
+  end
+end
+
+--- @param method string
+--- @param opts? {bufnr?: number}
+--- @return lsp.Registration? (table|nil) the registration if found
+--- @private
+function M:get(method, opts)
+  opts = opts or {}
+  opts.bufnr = opts.bufnr or vim.api.nvim_get_current_buf()
+  for _, reg in ipairs(self.capabilities[method] or {}) do
+    if not reg.registerOptions then
+      return reg
+    end
+    local documentSelector = reg.registerOptions.documentSelector
+    if not documentSelector then
+      return reg
+    end
+    if M.match(opts.bufnr, documentSelector) then
+      return reg
+    end
+  end
+end
+
+--- @param method string
+--- @param opts? {bufnr?: number}
+--- @private
+function M:supports(method, opts)
+  return self:get(method, opts) ~= nil
+end
+
+--- @param bufnr number
+--- @param documentSelector lsp.DocumentSelector
+--- @private
+function M.match(bufnr, documentSelector)
+  local ft = vim.bo[bufnr].filetype
+  local uri = vim.uri_from_bufnr(bufnr)
+  local fname = vim.uri_to_fname(uri)
+  for _, filter in ipairs(documentSelector) do
+    local matches = true
+    if filter.language and ft ~= filter.language then
+      matches = false
+    end
+    if matches and filter.scheme and not vim.startswith(uri, filter.scheme .. ':') then
+      matches = false
+    end
+    if matches and filter.pattern and not wf._match(filter.pattern, fname) then
+      matches = false
+    end
+    if matches then
+      return true
+    end
+  end
+end
+
+return M
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index a307dea673..b2f202c4ba 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -683,11 +683,7 @@ local function on_code_action_results(results, ctx, options)
     --
     local client = vim.lsp.get_client_by_id(action_tuple[1])
     local action = action_tuple[2]
-    if
-      not action.edit
-      and client
-      and vim.tbl_get(client.server_capabilities, 'codeActionProvider', 'resolveProvider')
-    then
+    if not action.edit and client and client.supports_method('codeAction/resolve') then
       client.request('codeAction/resolve', action, function(err, resolved_action)
         if err then
           vim.notify(err.code .. ': ' .. err.message, vim.log.levels.ERROR)
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 8e926c4644..5346160871 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -118,22 +118,30 @@ end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#client_registerCapability
 M['client/registerCapability'] = function(_, result, ctx)
-  local log_unsupported = false
+  local client_id = ctx.client_id
+  ---@type lsp.Client
+  local client = vim.lsp.get_client_by_id(client_id)
+
+  client.dynamic_capabilities:register(result.registrations)
+  for bufnr, _ in ipairs(client.attached_buffers) do
+    vim.lsp._set_defaults(client, bufnr)
+  end
+
+  ---@type string[]
+  local unsupported = {}
   for _, reg in ipairs(result.registrations) do
     if reg.method == 'workspace/didChangeWatchedFiles' then
       require('vim.lsp._watchfiles').register(reg, ctx)
-    else
-      log_unsupported = true
+    elseif not client.dynamic_capabilities:supports_registration(reg.method) then
+      unsupported[#unsupported + 1] = reg.method
     end
   end
-  if log_unsupported then
-    local client_id = ctx.client_id
+  if #unsupported > 0 then
     local warning_tpl = 'The language server %s triggers a registerCapability '
-      .. 'handler despite dynamicRegistration set to false. '
+      .. 'handler for %s despite dynamicRegistration set to false. '
       .. 'Report upstream, this warning is harmless'
-    local client = vim.lsp.get_client_by_id(client_id)
     local client_name = client and client.name or string.format('id=%d', client_id)
-    local warning = string.format(warning_tpl, client_name)
+    local warning = string.format(warning_tpl, client_name, table.concat(unsupported, ', '))
     log.warn(warning)
   end
   return vim.NIL
@@ -141,6 +149,10 @@ end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#client_unregisterCapability
 M['client/unregisterCapability'] = function(_, result, ctx)
+  local client_id = ctx.client_id
+  local client = vim.lsp.get_client_by_id(client_id)
+  client.dynamic_capabilities:unregister(result.unregisterations)
+
   for _, unreg in ipairs(result.unregisterations) do
     if unreg.method == 'workspace/didChangeWatchedFiles' then
       require('vim.lsp._watchfiles').unregister(unreg, ctx)
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index a7919f12f5..a28ff407b7 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -697,7 +697,7 @@ function protocol.make_client_capabilities()
         didSave = true,
       },
       codeAction = {
-        dynamicRegistration = false,
+        dynamicRegistration = true,
 
         codeActionLiteralSupport = {
           codeActionKind = {
@@ -714,6 +714,12 @@ function protocol.make_client_capabilities()
           properties = { 'edit' },
         },
       },
+      formatting = {
+        dynamicRegistration = true,
+      },
+      rangeFormatting = {
+        dynamicRegistration = true,
+      },
       completion = {
         dynamicRegistration = false,
         completionItem = {
@@ -747,6 +753,7 @@ function protocol.make_client_capabilities()
       },
       definition = {
         linkSupport = true,
+        dynamicRegistration = true,
       },
       implementation = {
         linkSupport = true,
@@ -755,7 +762,7 @@ function protocol.make_client_capabilities()
         linkSupport = true,
       },
       hover = {
-        dynamicRegistration = false,
+        dynamicRegistration = true,
         contentFormat = { protocol.MarkupKind.Markdown, protocol.MarkupKind.PlainText },
       },
       signatureHelp = {
@@ -790,7 +797,7 @@ function protocol.make_client_capabilities()
         hierarchicalDocumentSymbolSupport = true,
       },
       rename = {
-        dynamicRegistration = false,
+        dynamicRegistration = true,
         prepareSupport = true,
       },
       publishDiagnostics = {
diff --git a/runtime/lua/vim/lsp/types.lua b/runtime/lua/vim/lsp/types.lua
index 779f313aa7..e77e1fb63a 100644
--- a/runtime/lua/vim/lsp/types.lua
+++ b/runtime/lua/vim/lsp/types.lua
@@ -35,3 +35,31 @@
 ---@field source string
 ---@field tags? lsp.DiagnosticTag[]
 ---@field relatedInformation DiagnosticRelatedInformation[]
+
+--- @class lsp.DocumentFilter
+--- @field language? string
+--- @field scheme? string
+--- @field pattern? string
+
+--- @alias lsp.DocumentSelector lsp.DocumentFilter[]
+
+--- @alias lsp.RegisterOptions any | lsp.StaticRegistrationOptions | lsp.TextDocumentRegistrationOptions
+
+--- @class lsp.Registration
+--- @field id string
+--- @field method string
+--- @field registerOptions? lsp.RegisterOptions
+
+--- @alias lsp.RegistrationParams {registrations: lsp.Registration[]}
+
+--- @class lsp.StaticRegistrationOptions
+--- @field id? string
+
+--- @class lsp.TextDocumentRegistrationOptions
+--- @field documentSelector? lsp.DocumentSelector
+
+--- @class lsp.Unregistration
+--- @field id string
+--- @field method string
+
+--- @alias lsp.UnregistrationParams {unregisterations: lsp.Unregistration[]}
-- 
cgit 


From 8e17054a2333318340f23abd7a94abfe474fb52f Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sun, 28 May 2023 11:47:07 +0200
Subject: vim-patch:9.0.1584: not all meson files are recognized (#23797)

Problem:    Not all meson files are recognized.
Solution:   Add "meson.options". (Liam Beguin, closes vim/vim#12444)

https://github.com/vim/vim/commit/1ba0b9e36f36926a7675b31efeda7d3e495c9157

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 1b04666161..57df621153 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1547,6 +1547,7 @@ local filename = {
   ['man.config'] = 'manconf',
   ['maxima-init.mac'] = 'maxima',
   ['meson.build'] = 'meson',
+  ['meson.options'] = 'meson',
   ['meson_options.txt'] = 'meson',
   ['/etc/conf.modules'] = 'modconf',
   ['/etc/modules'] = 'modconf',
-- 
cgit 


From b8a2220f5eb32ead6b66f7c49b7e915883bf3539 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Mon, 29 May 2023 10:25:05 +0200
Subject: vim-patch:9.0.1587: Corn config files are not recognized (#23807)

Problem:    Corn config files are not recognized.
Solution:   Add a pattern for Corn config files. (Jake Stanger, closes vim/vim#12449)

https://github.com/vim/vim/commit/05843e89601c03389a2d7978e7e16aec641a3dc4

Co-authored-by: Jake Stanger <mail@jstanger.dev>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 57df621153..6990de3391 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -241,6 +241,7 @@ local extension = {
   copyright = function(path, bufnr)
     return require('vim.filetype.detect').copyright(bufnr)
   end,
+  corn = 'corn',
   csh = function(path, bufnr)
     return require('vim.filetype.detect').csh(path, bufnr)
   end,
-- 
cgit 


From e8776074f50593df90402a3642236990edfba6f0 Mon Sep 17 00:00:00 2001
From: Omar El Halabi <omar_halabi25@hotmail.com>
Date: Tue, 30 May 2023 00:44:23 +0200
Subject: vim-patch:9.0.1591: some "gomod" files are not recognized (#23820)

Problem:    Some "gomod" files are not recognized.
Solution:   Check for "go.mod" file name before checking out the contents.
            (Omar El Halabi, closes vim/vim#12462)

https://github.com/vim/vim/commit/c9fbd2560f24180d2efa40028ed68427341d2d99
---
 runtime/lua/vim/filetype/detect.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index 94106a3547..70e590ed10 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -771,14 +771,14 @@ end
 function M.mod(path, bufnr)
   if vim.g.filetype_mod then
     return vim.g.filetype_mod
+  elseif matchregex(path, [[\c\<go\.mod$]]) then
+    return 'gomod'
   elseif is_lprolog(bufnr) then
     return 'lprolog'
   elseif matchregex(nextnonblank(bufnr, 1), [[\%(\<MODULE\s\+\w\+\s*;\|^\s*(\*\)]]) then
     return 'modula2'
   elseif is_rapid(bufnr) then
     return 'rapid'
-  elseif matchregex(path, [[\c\<go\.mod$]]) then
-    return 'gomod'
   else
     -- Nothing recognized, assume modsim3
     return 'modsim3'
-- 
cgit 


From dd3fa645735539c75b72dc1b0114278b5fa57f7f Mon Sep 17 00:00:00 2001
From: Folke Lemaitre <folke.lemaitre@gmail.com>
Date: Tue, 30 May 2023 19:15:07 +0200
Subject: fix(lsp): fix dynamic registration of code actions (#23826)

---
 runtime/lua/vim/lsp/buf.lua | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index b2f202c4ba..bb3ca0e6d6 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -681,9 +681,16 @@ local function on_code_action_results(results, ctx, options)
     --  command: string
     --  arguments?: any[]
     --
+    ---@type lsp.Client
     local client = vim.lsp.get_client_by_id(action_tuple[1])
     local action = action_tuple[2]
-    if not action.edit and client and client.supports_method('codeAction/resolve') then
+
+    local reg = client.dynamic_capabilities:get('textDocument/codeAction', { bufnr = ctx.bufnr })
+
+    local supports_resolve = vim.tbl_get(reg or {}, 'registerOptions', 'resolveProvider')
+      or client.supports_method('codeAction/resolve')
+
+    if not action.edit and client and supports_resolve then
       client.request('codeAction/resolve', action, function(err, resolved_action)
         if err then
           vim.notify(err.code .. ': ' .. err.message, vim.log.levels.ERROR)
-- 
cgit 


From 58618d208acd3827c4e86668529edb619bb9b8dd Mon Sep 17 00:00:00 2001
From: jdrouhard <john@drouhard.dev>
Date: Tue, 30 May 2023 13:56:29 -0500
Subject: feat(lsp)!: promote LspRequest to a full autocmd and enrich with
 additional data (#23694)

BREAKING CHANGE: LspRequest is no longer a User autocmd but is now a
first class citizen.

LspRequest as a User autocmd had limited functionality. Namely, the only
thing you could do was use the notification to do a lookup on all the
clients' requests tables to figure out what changed.

Promoting the autocmd to a full autocmd lets us set the buffer the
request was initiated on (so people can set buffer-local autocmds for
listening to these events).

Additionally, when used from Lua, we can pass additional metadata about
the request along with the notification, including the client ID, the
request ID, and the actual request object stored on the client's
requests table. Users can now listen for these events and act on them
proactively instead of polling all of the requests tables and looking
for changes.
---
 runtime/lua/vim/lsp.lua | 27 ++++++++++++++++++++++-----
 1 file changed, 22 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 5337abea25..c9ca8cd224 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -799,7 +799,9 @@ end
 ---    to the server. Entries are key-value pairs with the key
 ---    being the request ID while the value is a table with `type`,
 ---    `bufnr`, and `method` key-value pairs. `type` is either "pending"
----    for an active request, or "cancel" for a cancel request.
+---    for an active request, or "cancel" for a cancel request. It will
+---    be "complete" ephemerally while executing |LspRequest| autocmds
+---    when replies are received from the server.
 ---
 ---  - {config} (table): copy of the table that was passed by the user
 ---    to |vim.lsp.start_client()|.
@@ -1408,13 +1410,24 @@ function lsp.start_client(config)
         { method = method, client_id = client_id, bufnr = bufnr, params = params }
       )
     end, function(request_id)
+      local request = client.requests[request_id]
+      request.type = 'complete'
+      nvim_exec_autocmds('LspRequest', {
+        buffer = bufnr,
+        modeline = false,
+        data = { client_id = client_id, request_id = request_id, request = request },
+      })
       client.requests[request_id] = nil
-      nvim_exec_autocmds('User', { pattern = 'LspRequest', modeline = false })
     end)
 
     if success and request_id then
-      client.requests[request_id] = { type = 'pending', bufnr = bufnr, method = method }
-      nvim_exec_autocmds('User', { pattern = 'LspRequest', modeline = false })
+      local request = { type = 'pending', bufnr = bufnr, method = method }
+      client.requests[request_id] = request
+      nvim_exec_autocmds('LspRequest', {
+        buffer = bufnr,
+        modeline = false,
+        data = { client_id = client_id, request_id = request_id, request = request },
+      })
     end
 
     return success, request_id
@@ -1486,7 +1499,11 @@ function lsp.start_client(config)
     local request = client.requests[id]
     if request and request.type == 'pending' then
       request.type = 'cancel'
-      nvim_exec_autocmds('User', { pattern = 'LspRequest', modeline = false })
+      nvim_exec_autocmds('LspRequest', {
+        buffer = request.bufnr,
+        modeline = false,
+        data = { client_id = client_id, request_id = id, request = request },
+      })
     end
     return rpc.notify('$/cancelRequest', { id = id })
   end
-- 
cgit 


From be5e3611541051d9fa5b752a4fe1da6ab78b141e Mon Sep 17 00:00:00 2001
From: Raphael <glepnir@neovim.pro>
Date: Thu, 1 Jun 2023 14:38:38 +0800
Subject: fix(lsp): add param assert in client_is_stopped (#23857)

---
 runtime/lua/vim/lsp.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index c9ca8cd224..d64ed0b5a3 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -2275,7 +2275,8 @@ end
 ---@param client_id (integer)
 ---@return boolean stopped true if client is stopped, false otherwise.
 function lsp.client_is_stopped(client_id)
-  return active_clients[client_id] == nil
+  assert(client_id, 'missing client_id param')
+  return active_clients[client_id] == nil and not uninitialized_clients[client_id]
 end
 
 --- Gets a map of client_id:client pairs for the given buffer, where each value
-- 
cgit 


From fb54e6980ea6fec218a11f118e97ef65f250395a Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Thu, 1 Jun 2023 11:15:33 -0500
Subject: feat(lsp): set client offset_encoding if server supports
 positionEncoding

If the server sends the positionEncoding capability in its
initialization response, automatically set the client's offset_encoding
to use the value provided.
---
 runtime/lua/vim/lsp.lua | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index d64ed0b5a3..baf8b5c1a8 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1344,6 +1344,10 @@ function lsp.start_client(config)
         assert(result.capabilities, "initialize result doesn't contain capabilities")
       client.server_capabilities = protocol.resolve_capabilities(client.server_capabilities)
 
+      if client.server_capabilities.positionEncoding then
+        client.offset_encoding = client.server_capabilities.positionEncoding
+      end
+
       if next(config.settings) then
         client.notify('workspace/didChangeConfiguration', { settings = config.settings })
       end
-- 
cgit 


From 15641f38cf4b489a7c83e2c3aa6efc4c63009f00 Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Thu, 1 Jun 2023 11:39:51 -0500
Subject: feat(lsp): include positionEncodings in default client capabilities

---
 runtime/lua/vim/lsp/protocol.lua | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index a28ff407b7..7e49a572e7 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -634,6 +634,13 @@ export interface WorkspaceClientCapabilities {
 --- capabilities.
 function protocol.make_client_capabilities()
   return {
+    general = {
+      positionEncodings = {
+        'utf-8',
+        'utf-16',
+        'utf-32',
+      },
+    },
     textDocument = {
       semanticTokens = {
         dynamicRegistration = false,
-- 
cgit 


From aa130d0c7ea69a05330d0b054b414cc3a15dac45 Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Fri, 2 Jun 2023 16:59:58 +0200
Subject: docs: small fixes (#23619)

Co-authored-by: Evgeni Chasnovski <evgeni.chasnovski@gmail.com>
Co-authored-by: Gustavo Ferreira <gustavo.ferreira@imaginecurve.com>
Co-authored-by: Kai Moschcau <mail@kmoschcau.de>
Co-authored-by: Lampros <hauahx@gmail.com>
---
 runtime/lua/vim/iter.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index bda3508262..9112b6c3bb 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -335,7 +335,7 @@ end
 --- Fold an iterator or table into a single value.
 ---
 --- Examples:
---- <pre>
+--- <pre>lua
 --- -- Create a new table with only even values
 --- local t = { a = 1, b = 2, c = 3, d = 4 }
 --- local it = vim.iter(t)
-- 
cgit 


From c65e2203f70cd5d66fcb8ffb26f8cef38f50e04f Mon Sep 17 00:00:00 2001
From: Sebastian Lyng Johansen <seblyng98@gmail.com>
Date: Sat, 3 Jun 2023 09:18:05 +0200
Subject: docs(iter): add emmylua type to iter module (#23845)

---
 runtime/lua/vim/iter.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index 9112b6c3bb..56012e9b9f 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -51,6 +51,8 @@
 --- In addition to the |vim.iter()| function, the |vim.iter| module provides
 --- convenience functions like |vim.iter.filter()| and |vim.iter.totable()|.
 
+---@class IterMod
+---@operator call:Iter
 local M = {}
 
 ---@class Iter
@@ -974,6 +976,7 @@ function M.map(f, src, ...)
   return Iter.new(src, ...):map(f):totable()
 end
 
+---@type IterMod
 return setmetatable(M, {
   __call = function(_, ...)
     return Iter.new(...)
-- 
cgit 


From 2db719f6c2b677fcbc197b02fe52764a851523b2 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sat, 3 Jun 2023 11:06:00 +0100
Subject: feat(lua): rename vim.loop -> vim.uv (#22846)

---
 runtime/lua/vim/_editor.lua                 |  8 ++++++--
 runtime/lua/vim/_watch.lua                  |  6 +++---
 runtime/lua/vim/filetype/options.lua        |  2 +-
 runtime/lua/vim/fs.lua                      | 20 ++++++++++----------
 runtime/lua/vim/loader.lua                  |  4 ++--
 runtime/lua/vim/lsp.lua                     |  2 +-
 runtime/lua/vim/lsp/health.lua              |  2 +-
 runtime/lua/vim/lsp/log.lua                 |  4 ++--
 runtime/lua/vim/lsp/rpc.lua                 |  4 ++--
 runtime/lua/vim/lsp/semantic_tokens.lua     |  2 +-
 runtime/lua/vim/lsp/util.lua                |  2 +-
 runtime/lua/vim/secure.lua                  |  6 +++---
 runtime/lua/vim/treesitter/languagetree.lua |  4 ++--
 13 files changed, 35 insertions(+), 31 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index b26def5958..7b946a55e4 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -42,6 +42,10 @@ for k, v in pairs({
   vim._submodules[k] = v
 end
 
+-- Remove at Nvim 1.0
+---@deprecated
+vim.loop = vim.uv
+
 -- There are things which have special rules in vim._init_packages
 -- for legacy reasons (uri) or for performance (_inspector).
 -- most new things should go into a submodule namespace ( vim.foobar.do_thing() )
@@ -159,7 +163,7 @@ do
   ---                - 3: ends the paste (exactly once)
   ---@returns boolean # false if client should cancel the paste.
   function vim.paste(lines, phase)
-    local now = vim.loop.now()
+    local now = vim.uv.now()
     local is_first_chunk = phase < 2
     local is_last_chunk = phase == -1 or phase == 3
     if is_first_chunk then -- Reset flags.
@@ -483,7 +487,7 @@ end
 ---@return table timer luv timer object
 function vim.defer_fn(fn, timeout)
   vim.validate({ fn = { fn, 'c', true } })
-  local timer = vim.loop.new_timer()
+  local timer = vim.uv.new_timer()
   timer:start(
     timeout,
     0,
diff --git a/runtime/lua/vim/_watch.lua b/runtime/lua/vim/_watch.lua
index dbffd726a2..3bd8a56f6e 100644
--- a/runtime/lua/vim/_watch.lua
+++ b/runtime/lua/vim/_watch.lua
@@ -46,7 +46,7 @@ function M.watch(path, opts, callback)
 
   path = vim.fs.normalize(path)
   local uvflags = opts and opts.uvflags or {}
-  local handle, new_err = vim.loop.new_fs_event()
+  local handle, new_err = vim.uv.new_fs_event()
   assert(not new_err, new_err)
   local _, start_err = handle:start(path, uvflags, function(err, filename, events)
     assert(not err, err)
@@ -57,7 +57,7 @@ function M.watch(path, opts, callback)
     end
     local change_type = events.change and M.FileChangeType.Changed or 0
     if events.rename then
-      local _, staterr, staterrname = vim.loop.fs_stat(fullpath)
+      local _, staterr, staterrname = vim.uv.fs_stat(fullpath)
       if staterrname == 'ENOENT' then
         change_type = M.FileChangeType.Deleted
       else
@@ -99,7 +99,7 @@ local function poll_internal(path, opts, callback, watches)
   }
 
   if not watches.handle then
-    local poll, new_err = vim.loop.new_fs_poll()
+    local poll, new_err = vim.uv.new_fs_poll()
     assert(not new_err, new_err)
     watches.handle = poll
     local _, start_err = poll:start(
diff --git a/runtime/lua/vim/filetype/options.lua b/runtime/lua/vim/filetype/options.lua
index a093c249f7..2a28b5a8e3 100644
--- a/runtime/lua/vim/filetype/options.lua
+++ b/runtime/lua/vim/filetype/options.lua
@@ -34,7 +34,7 @@ local ft_option_cache = {} ---@type table<string,table<string,any>>
 --- @param path string
 --- @return integer
 local function hash(path)
-  local mtime0 = vim.loop.fs_stat(path).mtime
+  local mtime0 = vim.uv.fs_stat(path).mtime
   return mtime0.sec * 1000000000 + mtime0.nsec
 end
 
diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index 864ba495f1..5e63fb6237 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -1,6 +1,6 @@
 local M = {}
 
-local iswin = vim.loop.os_uname().sysname == 'Windows_NT'
+local iswin = vim.uv.os_uname().sysname == 'Windows_NT'
 
 --- Iterate over all the parents of the given file or directory.
 ---
@@ -106,12 +106,12 @@ function M.dir(path, opts)
   })
 
   if not opts.depth or opts.depth == 1 then
-    local fs = vim.loop.fs_scandir(M.normalize(path))
+    local fs = vim.uv.fs_scandir(M.normalize(path))
     return function()
       if not fs then
         return
       end
-      return vim.loop.fs_scandir_next(fs)
+      return vim.uv.fs_scandir_next(fs)
     end
   end
 
@@ -121,9 +121,9 @@ function M.dir(path, opts)
     while #dirs > 0 do
       local dir0, level = unpack(table.remove(dirs, 1))
       local dir = level == 1 and dir0 or M.joinpath(path, dir0)
-      local fs = vim.loop.fs_scandir(M.normalize(dir))
+      local fs = vim.uv.fs_scandir(M.normalize(dir))
       while fs do
-        local name, t = vim.loop.fs_scandir_next(fs)
+        local name, t = vim.uv.fs_scandir_next(fs)
         if not name then
           break
         end
@@ -158,7 +158,7 @@ end
 --- -- location of Cargo.toml from the current buffer's path
 --- local cargo = vim.fs.find('Cargo.toml', {
 ---   upward = true,
----   stop = vim.loop.os_homedir(),
+---   stop = vim.uv.os_homedir(),
 ---   path = vim.fs.dirname(vim.api.nvim_buf_get_name(0)),
 --- })
 ---
@@ -212,7 +212,7 @@ function M.find(names, opts)
 
   names = type(names) == 'string' and { names } or names
 
-  local path = opts.path or vim.loop.cwd()
+  local path = opts.path or vim.uv.cwd()
   local stop = opts.stop
   local limit = opts.limit or 1
 
@@ -244,7 +244,7 @@ function M.find(names, opts)
         local t = {}
         for _, name in ipairs(names) do
           local f = M.joinpath(p, name)
-          local stat = vim.loop.fs_stat(f)
+          local stat = vim.uv.fs_stat(f)
           if stat and (not opts.type or opts.type == stat.type) then
             t[#t + 1] = f
           end
@@ -337,7 +337,7 @@ function M.normalize(path, opts)
   })
 
   if path:sub(1, 1) == '~' then
-    local home = vim.loop.os_homedir() or '~'
+    local home = vim.uv.os_homedir() or '~'
     if home:sub(-1) == '\\' or home:sub(-1) == '/' then
       home = home:sub(1, -2)
     end
@@ -345,7 +345,7 @@ function M.normalize(path, opts)
   end
 
   if opts.expand_env == nil or opts.expand_env then
-    path = path:gsub('%$([%w_]+)', vim.loop.os_getenv)
+    path = path:gsub('%$([%w_]+)', vim.uv.os_getenv)
   end
 
   path = path:gsub('\\', '/'):gsub('/+', '/')
diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index 66627fe4e7..9024bdb231 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -1,4 +1,4 @@
-local uv = vim.loop
+local uv = vim.uv
 
 --- @type (fun(modename: string): fun()|string)[]
 local loaders = package.loaders
@@ -465,7 +465,7 @@ end
 --- @private
 function Loader.track(stat, f)
   return function(...)
-    local start = vim.loop.hrtime()
+    local start = vim.uv.hrtime()
     local r = { f(...) }
     Loader._stats[stat] = Loader._stats[stat] or { total = 0, time = 0 }
     Loader._stats[stat].total = Loader._stats[stat].total + 1
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index baf8b5c1a8..5f7a95ae14 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -10,7 +10,7 @@ local semantic_tokens = require('vim.lsp.semantic_tokens')
 local api = vim.api
 local nvim_err_writeln, nvim_buf_get_lines, nvim_command, nvim_exec_autocmds =
   api.nvim_err_writeln, api.nvim_buf_get_lines, api.nvim_command, api.nvim_exec_autocmds
-local uv = vim.loop
+local uv = vim.uv
 local tbl_isempty, tbl_extend = vim.tbl_isempty, vim.tbl_extend
 local validate = vim.validate
 local if_nil = vim.F.if_nil
diff --git a/runtime/lua/vim/lsp/health.lua b/runtime/lua/vim/lsp/health.lua
index 6ca468393e..8817bb71de 100644
--- a/runtime/lua/vim/lsp/health.lua
+++ b/runtime/lua/vim/lsp/health.lua
@@ -22,7 +22,7 @@ function M.check()
   local log_path = vim.lsp.get_log_path()
   report_info(string.format('Log path: %s', log_path))
 
-  local log_file = vim.loop.fs_stat(log_path)
+  local log_file = vim.uv.fs_stat(log_path)
   local log_size = log_file and log_file.size or 0
 
   local report_fn = (log_size / 1000000 > 100 and report_warn or report_info)
diff --git a/runtime/lua/vim/lsp/log.lua b/runtime/lua/vim/lsp/log.lua
index 3d5bc06c3f..07d0500797 100644
--- a/runtime/lua/vim/lsp/log.lua
+++ b/runtime/lua/vim/lsp/log.lua
@@ -31,7 +31,7 @@ do
     end
   end
 
-  local path_sep = vim.loop.os_uname().version:match('Windows') and '\\' or '/'
+  local path_sep = vim.uv.os_uname().version:match('Windows') and '\\' or '/'
   ---@private
   local function path_join(...)
     return table.concat(vim.tbl_flatten({ ... }), path_sep)
@@ -68,7 +68,7 @@ do
       return false
     end
 
-    local log_info = vim.loop.fs_stat(logfilename)
+    local log_info = vim.uv.fs_stat(logfilename)
     if log_info and log_info.size > 1e9 then
       local warn_msg = string.format(
         'LSP client log is large (%d MB): %s',
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index af3190c9bd..5f48effebf 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -1,4 +1,4 @@
-local uv = vim.loop
+local uv = vim.uv
 local log = require('vim.lsp.log')
 local protocol = require('vim.lsp.protocol')
 local validate, schedule, schedule_wrap = vim.validate, vim.schedule, vim.schedule_wrap
@@ -691,7 +691,7 @@ local function start(cmd, cmd_args, dispatchers, extra_spawn_params)
   })
 
   ---@private
-  --- Callback for |vim.loop.spawn()| Closes all streams and runs the `on_exit` dispatcher.
+  --- Callback for |vim.uv.spawn()| Closes all streams and runs the `on_exit` dispatcher.
   ---@param code (integer) Exit code
   ---@param signal (integer) Signal that was used to terminate (if any)
   local function onexit(code, signal)
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 376cac19a7..191cc7b400 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -2,7 +2,7 @@ local api = vim.api
 local bit = require('bit')
 local handlers = require('vim.lsp.handlers')
 local util = require('vim.lsp.util')
-local uv = vim.loop
+local uv = vim.uv
 
 --- @class STTokenRange
 --- @field line integer line number 0-based
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 9fffc845b1..53f8dba814 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -4,7 +4,7 @@ local validate = vim.validate
 local api = vim.api
 local list_extend = vim.list_extend
 local highlight = require('vim.highlight')
-local uv = vim.loop
+local uv = vim.uv
 
 local npcall = vim.F.npcall
 local split = vim.split
diff --git a/runtime/lua/vim/secure.lua b/runtime/lua/vim/secure.lua
index 443b152273..1a04e11231 100644
--- a/runtime/lua/vim/secure.lua
+++ b/runtime/lua/vim/secure.lua
@@ -51,7 +51,7 @@ end
 ---        trusted, or nil otherwise.
 function M.read(path)
   vim.validate({ path = { path, 's' } })
-  local fullpath = vim.loop.fs_realpath(vim.fs.normalize(path))
+  local fullpath = vim.uv.fs_realpath(vim.fs.normalize(path))
   if not fullpath then
     return nil
   end
@@ -149,13 +149,13 @@ function M.trust(opts)
 
   local fullpath
   if path then
-    fullpath = vim.loop.fs_realpath(vim.fs.normalize(path))
+    fullpath = vim.uv.fs_realpath(vim.fs.normalize(path))
   elseif bufnr then
     local bufname = vim.api.nvim_buf_get_name(bufnr)
     if bufname == '' then
       return false, 'buffer is not associated with a file'
     end
-    fullpath = vim.loop.fs_realpath(vim.fs.normalize(bufname))
+    fullpath = vim.uv.fs_realpath(vim.fs.normalize(bufname))
   else
     error('one of "path" or "bufnr" is required')
   end
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 244d88f3e0..cabfa8ccc0 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -170,11 +170,11 @@ end
 ---@param f fun(): R1, R2, R2
 ---@return integer, R1, R2, R3
 local function tcall(f, ...)
-  local start = vim.loop.hrtime()
+  local start = vim.uv.hrtime()
   ---@diagnostic disable-next-line
   local r = { f(...) }
   --- @type number
-  local duration = (vim.loop.hrtime() - start) / 1000000
+  local duration = (vim.uv.hrtime() - start) / 1000000
   return duration, unpack(r)
 end
 
-- 
cgit 


From 40db569014471deb5bd17860be00d6833387be79 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sat, 3 Jun 2023 11:06:10 +0100
Subject: perf(iter): make ListIter.totable more efficient (#23714)

---
 runtime/lua/vim/iter.lua | 34 +++++++++++++++++++++++++---------
 1 file changed, 25 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index 56012e9b9f..0e98d0437e 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -66,7 +66,7 @@ end
 ---@class ListIter : Iter
 ---@field _table table Underlying table data
 ---@field _head number Index to the front of a table iterator
----@field _tail number Index to the end of a table iterator
+---@field _tail number Index to the end of a table iterator (exclusive)
 local ListIter = {}
 ListIter.__index = setmetatable(ListIter, Iter)
 ListIter.__call = function(self)
@@ -321,17 +321,33 @@ end
 
 ---@private
 function ListIter.totable(self)
-  if self._head == 1 and self._tail == #self._table + 1 and self.next == ListIter.next then
-    -- Sanitize packed table values
-    if getmetatable(self._table[1]) == packedmt then
-      for i = 1, #self._table do
-        self._table[i] = sanitize(self._table[i])
-      end
+  if self.next ~= ListIter.next or self._head >= self._tail then
+    return Iter.totable(self)
+  end
+
+  local needs_sanitize = getmetatable(self._table[1]) == packedmt
+
+  -- Reindex and sanitize.
+  local len = self._tail - self._head
+
+  if needs_sanitize then
+    for i = 1, len do
+      self._table[i] = sanitize(self._table[self._head - 1 + i])
+    end
+  else
+    for i = 1, len do
+      self._table[i] = self._table[self._head - 1 + i]
     end
-    return self._table
   end
 
-  return Iter.totable(self)
+  for i = len + 1, table.maxn(self._table) do
+    self._table[i] = nil
+  end
+
+  self._head = 1
+  self._tail = len + 1
+
+  return self._table
 end
 
 --- Fold an iterator or table into a single value.
-- 
cgit 


From 0a439e38634542fd961bb4f04b1cdda304cb1bb5 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sun, 4 Jun 2023 00:39:46 +0200
Subject: vim-patch:9.0.1601: filetype detection fails for *.conf file without
 comments (#23896)

Problem:    Filetype detection fails for *.conf file without comments.
            (Dmitrii Tcyganok)
Solution:   Use "conf" filetype as a fallback for an empty .conf file.
            (closes vim/vim#12487, closes vim/vim#12483)

https://github.com/vim/vim/commit/664fd12aa27a3c6bd19cfa474c4630d6c03fcc61

Co-authored-by: zeertzjq <zeertzjq@outlook.com>
---
 runtime/lua/vim/filetype/detect.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index 70e590ed10..b347215895 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -196,6 +196,9 @@ function M.conf(path, bufnr)
   if vim.fn.did_filetype() ~= 0 or path:find(vim.g.ft_ignore_pat) then
     return
   end
+  if path:find('%.conf$') then
+    return 'conf'
+  end
   for _, line in ipairs(getlines(bufnr, 1, 5)) do
     if line:find('^#') then
       return 'conf'
-- 
cgit 


From 96e19533f60add50eea4598560bbd56de3b1fca3 Mon Sep 17 00:00:00 2001
From: Artyom Andreev <artandra@icloud.com>
Date: Sun, 4 Jun 2023 04:03:25 +0300
Subject: feat(lsp): set kind in select call for codelens #23889

---
 runtime/lua/vim/lsp/codelens.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/codelens.lua b/runtime/lua/vim/lsp/codelens.lua
index 005a0047fa..ea8c52c334 100644
--- a/runtime/lua/vim/lsp/codelens.lua
+++ b/runtime/lua/vim/lsp/codelens.lua
@@ -97,6 +97,7 @@ function M.run()
   else
     vim.ui.select(options, {
       prompt = 'Code lenses:',
+      kind = 'codelens',
       format_item = function(option)
         return option.lens.command.title
       end,
-- 
cgit 


From 5282d3299c9b1b07f3e02a9014bc2632cf3b4fed Mon Sep 17 00:00:00 2001
From: Folke Lemaitre <folke.lemaitre@gmail.com>
Date: Mon, 5 Jun 2023 01:45:01 +0200
Subject: fix(lsp): restore marks after apply_text_edits() #14630

PROBLEM:
Whenever any text edits are applied to the buffer, the `marks` part of those
lines will be lost. This is mostly problematic for code formatters that format
the whole buffer like `prettier`, `luafmt`, ...

When doing atomic changes inside a vim doc, vim keeps track of those changes and
can update the positions of marks accordingly, but in this case we have a whole
doc that changed. There's no simple way to update the positions of all marks
from the previous document state to the new document state.

SOLUTION:
* save marks right before `nvim_buf_set_lines` is called inside `apply_text_edits`
* check if any marks were lost after doing `nvim_buf_set_lines`
* restore those marks to the previous positions

TEST CASE:
* have a formatter enabled
* open any file
* create a couple of marks
* indent the whole file to the right
* save the file
Before this change: all marks will be removed.
After this change: they will be preserved.

Fixes #14307
---
 runtime/lua/vim/lsp/util.lua | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 53f8dba814..ba8c72128e 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -451,6 +451,14 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
     }
   end)()
 
+  -- save and restore local marks since they get deleted by nvim_buf_set_lines
+  local marks = {}
+  for _, m in pairs(vim.fn.getmarklist(bufnr or vim.api.nvim_get_current_buf())) do
+    if m.mark:match("^'[a-z]$") then
+      marks[m.mark:sub(2, 2)] = { m.pos[2], m.pos[3] - 1 } -- api-indexed
+    end
+  end
+
   -- Apply text edits.
   local is_cursor_fixed = false
   local has_eol_text_edit = false
@@ -518,6 +526,20 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
 
   local max = api.nvim_buf_line_count(bufnr)
 
+  -- no need to restore marks that still exist
+  for _, m in pairs(vim.fn.getmarklist(bufnr or vim.api.nvim_get_current_buf())) do
+    marks[m.mark:sub(2, 2)] = nil
+  end
+  -- restore marks
+  for mark, pos in pairs(marks) do
+    if pos then
+      -- make sure we don't go out of bounds
+      pos[1] = math.min(pos[1], max)
+      pos[2] = math.min(pos[2], #(get_line(bufnr, pos[1] - 1) or ''))
+      vim.api.nvim_buf_set_mark(bufnr or 0, mark, pos[1], pos[2], {})
+    end
+  end
+
   -- Apply fixed cursor position.
   if is_cursor_fixed then
     local is_valid_cursor = true
-- 
cgit 


From 3c6d971e5488dc75b7db07c14d01f87827f28a67 Mon Sep 17 00:00:00 2001
From: Raphael <glepnir@neovim.pro>
Date: Mon, 5 Jun 2023 13:17:38 +0800
Subject: fix(lsp): set extra info only when it has a value (#23868)

---
 runtime/lua/vim/lsp/util.lua | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index ba8c72128e..e36014d07d 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -716,15 +716,18 @@ function M.text_document_completion_list_to_complete_items(result, prefix)
   local matches = {}
 
   for _, completion_item in ipairs(items) do
-    local info = ' '
+    local info = ''
     local documentation = completion_item.documentation
     if documentation then
       if type(documentation) == 'string' and documentation ~= '' then
         info = documentation
       elseif type(documentation) == 'table' and type(documentation.value) == 'string' then
         info = documentation.value
-        -- else
-        -- TODO(ashkan) Validation handling here?
+      else
+        vim.notify(
+          ('invalid documentation value %s'):format(vim.inspect(documentation)),
+          vim.log.levels.WARN
+        )
       end
     end
 
@@ -734,7 +737,7 @@ function M.text_document_completion_list_to_complete_items(result, prefix)
       abbr = completion_item.label,
       kind = M._get_completion_item_kind_name(completion_item.kind),
       menu = completion_item.detail or '',
-      info = info,
+      info = #info > 0 and info or nil,
       icase = 1,
       dup = 1,
       empty = 1,
-- 
cgit 


From 416fe8d185dcc072df7942953d867d9c605e9ffd Mon Sep 17 00:00:00 2001
From: Jon Huhn <nojnhuh@users.noreply.github.com>
Date: Mon, 5 Jun 2023 00:19:31 -0500
Subject: refactor(lsp): use LPeg for watchfiles matching (#23788)

---
 runtime/lua/vim/lsp/_watchfiles.lua | 191 +++++++++++-------------------------
 1 file changed, 56 insertions(+), 135 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
index cf2c57db1f..14e5dc6cf8 100644
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -1,152 +1,81 @@
 local bit = require('bit')
+local lpeg = require('lpeg')
 local watch = require('vim._watch')
 local protocol = require('vim.lsp.protocol')
 
 local M = {}
 
 ---@private
----Parses the raw pattern into a number of Lua-native patterns.
+--- Parses the raw pattern into an |lpeg| pattern. LPeg patterns natively support the "this" or "that"
+--- alternative constructions described in the LSP spec that cannot be expressed in a standard Lua pattern.
 ---
 ---@param pattern string The raw glob pattern
----@return table A list of Lua patterns. A match with any of them matches the input glob pattern.
+---@return userdata An |lpeg| representation of the pattern, or nil if the pattern is invalid.
 local function parse(pattern)
-  local patterns = { '' }
+  local l = lpeg
 
-  local path_sep = '[/\\]'
-  local non_path_sep = '[^/\\]'
+  local P, S, V = lpeg.P, lpeg.S, lpeg.V
+  local C, Cc, Ct, Cf = lpeg.C, lpeg.Cc, lpeg.Ct, lpeg.Cf
 
-  local function append(chunks)
-    local new_patterns = {}
-    for _, p in ipairs(patterns) do
-      for _, chunk in ipairs(chunks) do
-        table.insert(new_patterns, p .. chunk)
-      end
-    end
-    patterns = new_patterns
-  end
+  local pathsep = '/'
 
-  local function split(s, sep)
-    local segments = {}
-    local segment = ''
-    local in_braces = false
-    local in_brackets = false
-    for i = 1, #s do
-      local c = string.sub(s, i, i)
-      if c == sep and not in_braces and not in_brackets then
-        table.insert(segments, segment)
-        segment = ''
-      else
-        if c == '{' then
-          in_braces = true
-        elseif c == '}' then
-          in_braces = false
-        elseif c == '[' then
-          in_brackets = true
-        elseif c == ']' then
-          in_brackets = false
-        end
-        segment = segment .. c
-      end
+  local function class(inv, ranges)
+    for i, r in ipairs(ranges) do
+      ranges[i] = r[1] .. r[2]
     end
-    if segment ~= '' then
-      table.insert(segments, segment)
+    local patt = l.R(unpack(ranges))
+    if inv == '!' then
+      patt = P(1) - patt
     end
-    return segments
+    return patt
   end
 
-  local function escape(c)
-    if
-      c == '?'
-      or c == '.'
-      or c == '('
-      or c == ')'
-      or c == '%'
-      or c == '['
-      or c == ']'
-      or c == '*'
-      or c == '+'
-      or c == '-'
-    then
-      return '%' .. c
-    end
-    return c
+  local function add(acc, a)
+    return acc + a
   end
 
-  local segments = split(pattern, '/')
-  for i, segment in ipairs(segments) do
-    local last_seg = i == #segments
-    if segment == '**' then
-      local chunks = {
-        path_sep .. '-',
-        '.-' .. path_sep,
-      }
-      if last_seg then
-        chunks = { '.-' }
-      end
-      append(chunks)
-    else
-      local in_braces = false
-      local brace_val = ''
-      local in_brackets = false
-      local bracket_val = ''
-      for j = 1, #segment do
-        local char = string.sub(segment, j, j)
-        if char ~= '}' and in_braces then
-          brace_val = brace_val .. char
-        else
-          if in_brackets and (char ~= ']' or bracket_val == '') then
-            local res
-            if char == '-' then
-              res = char
-            elseif bracket_val == '' and char == '!' then
-              res = '^'
-            elseif char == '/' then
-              res = ''
-            else
-              res = escape(char)
-            end
-            bracket_val = bracket_val .. res
-          else
-            if char == '{' then
-              in_braces = true
-            elseif char == '[' then
-              in_brackets = true
-            elseif char == '}' then
-              local choices = split(brace_val, ',')
-              local parsed_choices = {}
-              for _, choice in ipairs(choices) do
-                table.insert(parsed_choices, parse(choice))
-              end
-              append(vim.tbl_flatten(parsed_choices))
-              in_braces = false
-              brace_val = ''
-            elseif char == ']' then
-              append({ '[' .. bracket_val .. ']' })
-              in_brackets = false
-              bracket_val = ''
-            elseif char == '?' then
-              append({ non_path_sep })
-            elseif char == '*' then
-              append({ non_path_sep .. '-' })
-            else
-              append({ escape(char) })
-            end
-          end
-        end
-      end
+  local function mul(acc, m)
+    return acc * m
+  end
 
-      if not last_seg and (segments[i + 1] ~= '**' or i + 1 < #segments) then
-        append({ path_sep })
-      end
-    end
+  local function star(stars, after)
+    return (-after * (l.P(1) - pathsep)) ^ #stars * after
   end
 
-  return patterns
+  local function dstar(after)
+    return (-after * l.P(1)) ^ 0 * after
+  end
+
+  local p = P({
+    'Pattern',
+    Pattern = V('Elem') ^ -1 * V('End'),
+    Elem = Cf(
+      (V('DStar') + V('Star') + V('Ques') + V('Class') + V('CondList') + V('Literal'))
+        * (V('Elem') + V('End')),
+      mul
+    ),
+    DStar = P('**') * (P(pathsep) * (V('Elem') + V('End')) + V('End')) / dstar,
+    Star = C(P('*') ^ 1) * (V('Elem') + V('End')) / star,
+    Ques = P('?') * Cc(l.P(1) - pathsep),
+    Class = P('[') * C(P('!') ^ -1) * Ct(Ct(C(1) * '-' * C(P(1) - ']')) ^ 1 * ']') / class,
+    CondList = P('{') * Cf(V('Cond') * (P(',') * V('Cond')) ^ 0, add) * '}',
+    -- TODO: '*' inside a {} condition is interpreted literally but should probably have the same
+    -- wildcard semantics it usually has.
+    -- Fixing this is non-trivial because '*' should match non-greedily up to "the rest of the
+    -- pattern" which in all other cases is the entire succeeding part of the pattern, but at the end of a {}
+    -- condition means "everything after the {}" where several other options separated by ',' may
+    -- exist in between that should not be matched by '*'.
+    Cond = Cf((V('Ques') + V('Class') + V('CondList') + (V('Literal') - S(',}'))) ^ 1, mul)
+      + Cc(l.P(0)),
+    Literal = P(1) / l.P,
+    End = P(-1) * Cc(l.P(-1)),
+  })
+
+  return p:match(pattern)
 end
 
 ---@private
 --- Implementation of LSP 3.17.0's pattern matching: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#pattern
---- Modeled after VSCode's implementation: https://github.com/microsoft/vscode/blob/0319eed971719ad48e9093daba9d65a5013ec5ab/src/vs/base/common/glob.ts#L509
 ---
 ---@param pattern string|table The glob pattern (raw or parsed) to match.
 ---@param s string The string to match against pattern.
@@ -155,15 +84,7 @@ function M._match(pattern, s)
   if type(pattern) == 'string' then
     pattern = parse(pattern)
   end
-  -- Since Lua's built-in string pattern matching does not have an alternate
-  -- operator like '|', `parse` will construct one pattern for each possible
-  -- alternative. Any pattern that matches thus matches the glob.
-  for _, p in ipairs(pattern) do
-    if s:match('^' .. p .. '$') then
-      return true
-    end
-  end
-  return false
+  return pattern:match(s) ~= nil
 end
 
 M._watchfunc = (vim.fn.has('win32') == 1 or vim.fn.has('mac') == 1) and watch.watch or watch.poll
@@ -226,11 +147,11 @@ function M.register(reg, ctx)
       local kind = w.kind
         or protocol.WatchKind.Create + protocol.WatchKind.Change + protocol.WatchKind.Delete
 
-      local pattern = glob_pattern.pattern
+      local pattern = parse(glob_pattern.pattern)
+      assert(pattern, 'invalid pattern: ' .. glob_pattern.pattern)
       if relative_pattern then
-        pattern = base_dir .. '/' .. pattern
+        pattern = lpeg.P(base_dir .. '/') * pattern
       end
-      pattern = parse(pattern)
 
       table.insert(watch_regs, {
         base_dir = base_dir,
-- 
cgit 


From ca26ec34386dfe98b0edf3de9aeb7b66f40d5efd Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Mon, 5 Jun 2023 08:21:23 -0500
Subject: fix(lsp): use only utf-16 in default client positionEncodings
 (#23903)

The Nvim client does not yet support multiple offset encodings for
clients in the same buffer. Until it does, stick to utf-16 by default.
---
 runtime/lua/vim/lsp/protocol.lua | 2 --
 1 file changed, 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 7e49a572e7..7558b5c6ba 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -636,9 +636,7 @@ function protocol.make_client_capabilities()
   return {
     general = {
       positionEncodings = {
-        'utf-8',
         'utf-16',
-        'utf-32',
       },
     },
     textDocument = {
-- 
cgit 


From ca887b80a911df4db4ab5f5496075b9415b9990a Mon Sep 17 00:00:00 2001
From: Gianmaria Bajo <mg1979.git@gmail.com>
Date: Tue, 6 Jun 2023 15:38:45 +0200
Subject: fix: version-range < and <= #23539

vim.version.range() couldn't parse them correctly.
For example, vim.version.range('<0.9.0'):has('0.9.0') returned `true`.

fix: range:has() accepts vim.version()
So that it's possible to compare a range with:

    vim.version.range(spec):has(vim.version())
---
 runtime/lua/vim/version.lua | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index ebe8f4e053..d4a3752e37 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -226,8 +226,13 @@ function Range:has(version)
   if type(version) == 'string' then
     ---@diagnostic disable-next-line: cast-local-type
     version = M.parse(version)
+  else
+    -- Need metatable to compare versions.
+    version = setmetatable(vim.deepcopy(version), Version)
   end
   if version then
+    -- Workaround: vim.version() reports "prerelease" as a boolean.
+    version.prerelease = version.prerelease or nil
     if version.prerelease ~= self.from.prerelease then
       return false
     end
@@ -244,11 +249,14 @@ end
 ---   }
 ---   </pre>
 ---
---- `:has()` checks if a version is in the range (inclusive `from`, exclusive `to`). Example:
+--- `:has()` checks if a version is in the range (inclusive `from`, exclusive `to`).
+---
+--- Example:
 ---   <pre>lua
 ---   local r = vim.version.range('1.0.0 - 2.0.0')
----   print(r:has('1.9.9'))  -- true
----   print(r:has('2.0.0'))  -- false
+---   print(r:has('1.9.9'))       -- true
+---   print(r:has('2.0.0'))       -- false
+---   print(r:has(vim.version())) -- check against current Nvim version
 ---   </pre>
 ---
 --- Or use cmp(), eq(), lt(), and gt() to compare `.to` and `.from` directly:
@@ -279,7 +287,7 @@ function M.range(spec) -- Adapted from https://github.com/folke/lazy.nvim
     }, { __index = Range })
   end
   ---@type string, string
-  local mods, version = spec:lower():match('^([%^=>~]*)(.*)$')
+  local mods, version = spec:lower():match('^([%^=<>~]*)(.*)$')
   version = version:gsub('%.[%*x]', '')
   local parts = vim.split(version:gsub('%-.*', ''), '.', { plain = true })
   if #parts < 3 and mods == '' then
@@ -292,6 +300,11 @@ function M.range(spec) -- Adapted from https://github.com/folke/lazy.nvim
     local to = vim.deepcopy(semver)
     if mods == '' or mods == '=' then
       to.patch = to.patch + 1
+    elseif mods == '<' then
+      from = M._version({})
+    elseif mods == '<=' then
+      from = M._version({})
+      to.patch = to.patch + 1
     elseif mods == '>' then
       from.patch = from.patch + 1
       to = nil ---@diagnostic disable-line: cast-local-type
-- 
cgit 


From c48b1421af28d0317c807bca00c7e2fff97d9ad0 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Tue, 6 Jun 2023 08:23:20 -0700
Subject: refactor!: rename "playground" => "dev" #23919

Problem:
"playground" is new jargon that overlaps with existing concepts:
"dev" (`:help dev`) and "view" (also "scratch" `:help scratch-buffer`) .

Solution:
We should consistently use "dev" as the namespace for where "developer
tools" live. For purposes of a "throwaway sandbox object", we can use
the name "view".
- Rename `TSPlayground` => `TSView`
- Rename `playground.lua` => `dev.lua`
---
 runtime/lua/vim/treesitter.lua            |   2 +-
 runtime/lua/vim/treesitter/dev.lua        | 441 ++++++++++++++++++++++++++++++
 runtime/lua/vim/treesitter/playground.lua | 439 -----------------------------
 3 files changed, 442 insertions(+), 440 deletions(-)
 create mode 100644 runtime/lua/vim/treesitter/dev.lua
 delete mode 100644 runtime/lua/vim/treesitter/playground.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 12fbe1654f..5526c9858c 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -493,7 +493,7 @@ end
 ---                        argument and should return a string.
 function M.inspect_tree(opts)
   ---@cast opts InspectTreeOpts
-  require('vim.treesitter.playground').inspect_tree(opts)
+  require('vim.treesitter.dev').inspect_tree(opts)
 end
 
 --- Returns the fold level for {lnum} in the current buffer. Can be set directly to 'foldexpr':
diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
new file mode 100644
index 0000000000..99cd147658
--- /dev/null
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -0,0 +1,441 @@
+local api = vim.api
+
+---@class TSDevModule
+local M = {}
+
+---@class TSTreeView
+---@field ns integer API namespace
+---@field opts table Options table with the following keys:
+---                  - anon (boolean): If true, display anonymous nodes
+---                  - lang (boolean): If true, display the language alongside each node
+---@field nodes TSP.Node[]
+---@field named TSP.Node[]
+local TSTreeView = {}
+
+---@class TSP.Node
+---@field id integer Node id
+---@field text string Node text
+---@field named boolean True if this is a named (non-anonymous) node
+---@field depth integer Depth of the node within the tree
+---@field lnum integer Beginning line number of this node in the source buffer
+---@field col integer Beginning column number of this node in the source buffer
+---@field end_lnum integer Final line number of this node in the source buffer
+---@field end_col integer Final column number of this node in the source buffer
+---@field lang string Source language of this node
+---@field root TSNode
+
+--- Traverse all child nodes starting at {node}.
+---
+--- This is a recursive function. The {depth} parameter indicates the current recursion level.
+--- {lang} is a string indicating the language of the tree currently being traversed. Each traversed
+--- node is added to {tree}. When recursion completes, {tree} is an array of all nodes in the order
+--- they were visited.
+---
+--- {injections} is a table mapping node ids from the primary tree to language tree injections. Each
+--- injected language has a series of trees nested within the primary language's tree, and the root
+--- node of each of these trees is contained within a node in the primary tree. The {injections}
+--- table maps nodes in the primary tree to root nodes of injected trees.
+---
+---@param node TSNode Starting node to begin traversal |tsnode|
+---@param depth integer Current recursion depth
+---@param lang string Language of the tree currently being traversed
+---@param injections table<integer,TSP.Node> Mapping of node ids to root nodes of injected language trees (see
+---                        explanation above)
+---@param tree TSP.Node[] Output table containing a list of tables each representing a node in the tree
+---@private
+local function traverse(node, depth, lang, injections, tree)
+  local injection = injections[node:id()]
+  if injection then
+    traverse(injection.root, depth, injection.lang, injections, tree)
+  end
+
+  for child, field in node:iter_children() do
+    local type = child:type()
+    local lnum, col, end_lnum, end_col = child:range()
+    local named = child:named()
+    local text ---@type string
+    if named then
+      if field then
+        text = string.format('%s: (%s)', field, type)
+      else
+        text = string.format('(%s)', type)
+      end
+    else
+      text = string.format('"%s"', type:gsub('\n', '\\n'))
+    end
+
+    table.insert(tree, {
+      id = child:id(),
+      text = text,
+      named = named,
+      depth = depth,
+      lnum = lnum,
+      col = col,
+      end_lnum = end_lnum,
+      end_col = end_col,
+      lang = lang,
+    })
+
+    traverse(child, depth + 1, lang, injections, tree)
+  end
+
+  return tree
+end
+
+--- Create a new treesitter view.
+---
+---@param bufnr integer Source buffer number
+---@param lang string|nil Language of source buffer
+---
+---@return TSTreeView|nil
+---@return string|nil Error message, if any
+---
+---@package
+function TSTreeView:new(bufnr, lang)
+  local ok, parser = pcall(vim.treesitter.get_parser, bufnr or 0, lang)
+  if not ok then
+    return nil, 'No parser available for the given buffer'
+  end
+
+  -- For each child tree (injected language), find the root of the tree and locate the node within
+  -- the primary tree that contains that root. Add a mapping from the node in the primary tree to
+  -- the root in the child tree to the {injections} table.
+  local root = parser:parse()[1]:root()
+  local injections = {} ---@type table<integer,table>
+  parser:for_each_child(function(child, lang_)
+    child:for_each_tree(function(tree)
+      local r = tree:root()
+      local node = root:named_descendant_for_range(r:range())
+      if node then
+        injections[node:id()] = {
+          lang = lang_,
+          root = r,
+        }
+      end
+    end)
+  end)
+
+  local nodes = traverse(root, 0, parser:lang(), injections, {})
+
+  local named = {} ---@type TSP.Node[]
+  for _, v in ipairs(nodes) do
+    if v.named then
+      named[#named + 1] = v
+    end
+  end
+
+  local t = {
+    ns = api.nvim_create_namespace(''),
+    nodes = nodes,
+    named = named,
+    opts = {
+      anon = false,
+      lang = false,
+    },
+  }
+
+  setmetatable(t, self)
+  self.__index = self
+  return t
+end
+
+local decor_ns = api.nvim_create_namespace('ts.dev')
+
+---@private
+---@param lnum integer
+---@param col integer
+---@param end_lnum integer
+---@param end_col integer
+---@return string
+local function get_range_str(lnum, col, end_lnum, end_col)
+  if lnum == end_lnum then
+    return string.format('[%d:%d - %d]', lnum + 1, col + 1, end_col)
+  end
+  return string.format('[%d:%d - %d:%d]', lnum + 1, col + 1, end_lnum + 1, end_col)
+end
+
+--- Write the contents of this View into {bufnr}.
+---
+---@param bufnr integer Buffer number to write into.
+---@package
+function TSTreeView:draw(bufnr)
+  vim.bo[bufnr].modifiable = true
+  local lines = {} ---@type string[]
+  local lang_hl_marks = {} ---@type table[]
+
+  for _, item in self:iter() do
+    local range_str = get_range_str(item.lnum, item.col, item.end_lnum, item.end_col)
+    local lang_str = self.opts.lang and string.format(' %s', item.lang) or ''
+    local line =
+      string.format('%s%s ; %s%s', string.rep(' ', item.depth), item.text, range_str, lang_str)
+
+    if self.opts.lang then
+      lang_hl_marks[#lang_hl_marks + 1] = {
+        col = #line - #lang_str,
+        end_col = #line,
+      }
+    end
+
+    lines[#lines + 1] = line
+  end
+
+  api.nvim_buf_set_lines(bufnr, 0, -1, false, lines)
+
+  api.nvim_buf_clear_namespace(bufnr, decor_ns, 0, -1)
+
+  for i, m in ipairs(lang_hl_marks) do
+    api.nvim_buf_set_extmark(bufnr, decor_ns, i - 1, m.col, {
+      hl_group = 'Title',
+      end_col = m.end_col,
+    })
+  end
+
+  vim.bo[bufnr].modifiable = false
+end
+
+--- Get node {i} from this View.
+---
+--- The node number is dependent on whether or not anonymous nodes are displayed.
+---
+---@param i integer Node number to get
+---@return TSP.Node
+---@package
+function TSTreeView:get(i)
+  local t = self.opts.anon and self.nodes or self.named
+  return t[i]
+end
+
+--- Iterate over all of the nodes in this View.
+---
+---@return (fun(): integer, TSP.Node) Iterator over all nodes in this View
+---@return table
+---@return integer
+---@package
+function TSTreeView:iter()
+  return ipairs(self.opts.anon and self.nodes or self.named)
+end
+
+--- @class InspectTreeOpts
+--- @field lang string? The language of the source buffer. If omitted, the
+---                     filetype of the source buffer is used.
+--- @field bufnr integer? Buffer to draw the tree into. If omitted, a new
+---                       buffer is created.
+--- @field winid integer? Window id to display the tree buffer in. If omitted,
+---                       a new window is created with {command}.
+--- @field command string? Vimscript command to create the window. Default
+---                       value is "60vnew". Only used when {winid} is nil.
+--- @field title (string|fun(bufnr:integer):string|nil) Title of the window. If a
+---                       function, it accepts the buffer number of the source
+---                       buffer as its only argument and should return a string.
+
+--- @private
+---
+--- @param opts InspectTreeOpts
+function M.inspect_tree(opts)
+  vim.validate({
+    opts = { opts, 't', true },
+  })
+
+  opts = opts or {}
+
+  local buf = api.nvim_get_current_buf()
+  local win = api.nvim_get_current_win()
+  local pg = assert(TSTreeView:new(buf, opts.lang))
+
+  -- Close any existing dev window
+  if vim.b[buf].dev then
+    local w = vim.b[buf].dev
+    if api.nvim_win_is_valid(w) then
+      api.nvim_win_close(w, true)
+    end
+  end
+
+  local w = opts.winid
+  if not w then
+    vim.cmd(opts.command or '60vnew')
+    w = api.nvim_get_current_win()
+  end
+
+  local b = opts.bufnr
+  if b then
+    api.nvim_win_set_buf(w, b)
+  else
+    b = api.nvim_win_get_buf(w)
+  end
+
+  vim.b[buf].dev = w
+
+  vim.wo[w].scrolloff = 5
+  vim.wo[w].wrap = false
+  vim.wo[w].foldmethod = 'manual' -- disable folding
+  vim.bo[b].buflisted = false
+  vim.bo[b].buftype = 'nofile'
+  vim.bo[b].bufhidden = 'wipe'
+  vim.b[b].disable_query_linter = true
+  vim.bo[b].filetype = 'query'
+
+  local title --- @type string?
+  local opts_title = opts.title
+  if not opts_title then
+    local bufname = api.nvim_buf_get_name(buf)
+    title = string.format('Syntax tree for %s', vim.fn.fnamemodify(bufname, ':.'))
+  elseif type(opts_title) == 'function' then
+    title = opts_title(buf)
+  end
+
+  assert(type(title) == 'string', 'Window title must be a string')
+  api.nvim_buf_set_name(b, title)
+
+  pg:draw(b)
+
+  api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
+  api.nvim_buf_set_keymap(b, 'n', '<CR>', '', {
+    desc = 'Jump to the node under the cursor in the source buffer',
+    callback = function()
+      local row = api.nvim_win_get_cursor(w)[1]
+      local pos = pg:get(row)
+      api.nvim_set_current_win(win)
+      api.nvim_win_set_cursor(win, { pos.lnum + 1, pos.col })
+    end,
+  })
+  api.nvim_buf_set_keymap(b, 'n', 'a', '', {
+    desc = 'Toggle anonymous nodes',
+    callback = function()
+      local row, col = unpack(api.nvim_win_get_cursor(w))
+      local curnode = pg:get(row)
+      while curnode and not curnode.named do
+        row = row - 1
+        curnode = pg:get(row)
+      end
+
+      pg.opts.anon = not pg.opts.anon
+      pg:draw(b)
+
+      if not curnode then
+        return
+      end
+
+      local id = curnode.id
+      for i, node in pg:iter() do
+        if node.id == id then
+          api.nvim_win_set_cursor(w, { i, col })
+          break
+        end
+      end
+    end,
+  })
+  api.nvim_buf_set_keymap(b, 'n', 'I', '', {
+    desc = 'Toggle language display',
+    callback = function()
+      pg.opts.lang = not pg.opts.lang
+      pg:draw(b)
+    end,
+  })
+
+  local group = api.nvim_create_augroup('treesitter/dev', {})
+
+  api.nvim_create_autocmd('CursorMoved', {
+    group = group,
+    buffer = b,
+    callback = function()
+      api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
+      local row = api.nvim_win_get_cursor(w)[1]
+      local pos = pg:get(row)
+      api.nvim_buf_set_extmark(buf, pg.ns, pos.lnum, pos.col, {
+        end_row = pos.end_lnum,
+        end_col = math.max(0, pos.end_col),
+        hl_group = 'Visual',
+      })
+
+      local topline, botline = vim.fn.line('w0', win), vim.fn.line('w$', win)
+
+      -- Move the cursor if highlighted range is completely out of view
+      if pos.lnum < topline and pos.end_lnum < topline then
+        api.nvim_win_set_cursor(win, { pos.end_lnum + 1, 0 })
+      elseif pos.lnum > botline and pos.end_lnum > botline then
+        api.nvim_win_set_cursor(win, { pos.lnum + 1, 0 })
+      end
+    end,
+  })
+
+  api.nvim_create_autocmd('CursorMoved', {
+    group = group,
+    buffer = buf,
+    callback = function()
+      if not api.nvim_buf_is_loaded(b) then
+        return true
+      end
+
+      api.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
+
+      local cursor_node = vim.treesitter.get_node({
+        bufnr = buf,
+        lang = opts.lang,
+        ignore_injections = false,
+      })
+      if not cursor_node then
+        return
+      end
+
+      local cursor_node_id = cursor_node:id()
+      for i, v in pg:iter() do
+        if v.id == cursor_node_id then
+          local start = v.depth
+          local end_col = start + #v.text
+          api.nvim_buf_set_extmark(b, pg.ns, i - 1, start, {
+            end_col = end_col,
+            hl_group = 'Visual',
+          })
+          api.nvim_win_set_cursor(w, { i, 0 })
+          break
+        end
+      end
+    end,
+  })
+
+  api.nvim_create_autocmd({ 'TextChanged', 'InsertLeave' }, {
+    group = group,
+    buffer = buf,
+    callback = function()
+      if not api.nvim_buf_is_loaded(b) then
+        return true
+      end
+
+      pg = assert(TSTreeView:new(buf, opts.lang))
+      pg:draw(b)
+    end,
+  })
+
+  api.nvim_create_autocmd('BufLeave', {
+    group = group,
+    buffer = b,
+    callback = function()
+      api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
+    end,
+  })
+
+  api.nvim_create_autocmd('BufLeave', {
+    group = group,
+    buffer = buf,
+    callback = function()
+      if not api.nvim_buf_is_loaded(b) then
+        return true
+      end
+
+      api.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
+    end,
+  })
+
+  api.nvim_create_autocmd('BufHidden', {
+    group = group,
+    buffer = buf,
+    once = true,
+    callback = function()
+      if api.nvim_win_is_valid(w) then
+        api.nvim_win_close(w, true)
+      end
+    end,
+  })
+end
+
+return M
diff --git a/runtime/lua/vim/treesitter/playground.lua b/runtime/lua/vim/treesitter/playground.lua
deleted file mode 100644
index 8293c1bd0a..0000000000
--- a/runtime/lua/vim/treesitter/playground.lua
+++ /dev/null
@@ -1,439 +0,0 @@
-local api = vim.api
-
----@class TSPlaygroundModule
-local M = {}
-
----@class TSPlayground
----@field ns integer API namespace
----@field opts table Options table with the following keys:
----                  - anon (boolean): If true, display anonymous nodes
----                  - lang (boolean): If true, display the language alongside each node
----@field nodes TSP.Node[]
----@field named TSP.Node[]
-local TSPlayground = {}
-
----@class TSP.Node
----@field id integer Node id
----@field text string Node text
----@field named boolean True if this is a named (non-anonymous) node
----@field depth integer Depth of the node within the tree
----@field lnum integer Beginning line number of this node in the source buffer
----@field col integer Beginning column number of this node in the source buffer
----@field end_lnum integer Final line number of this node in the source buffer
----@field end_col integer Final column number of this node in the source buffer
----@field lang string Source language of this node
----@field root TSNode
-
---- Traverse all child nodes starting at {node}.
----
---- This is a recursive function. The {depth} parameter indicates the current recursion level.
---- {lang} is a string indicating the language of the tree currently being traversed. Each traversed
---- node is added to {tree}. When recursion completes, {tree} is an array of all nodes in the order
---- they were visited.
----
---- {injections} is a table mapping node ids from the primary tree to language tree injections. Each
---- injected language has a series of trees nested within the primary language's tree, and the root
---- node of each of these trees is contained within a node in the primary tree. The {injections}
---- table maps nodes in the primary tree to root nodes of injected trees.
----
----@param node TSNode Starting node to begin traversal |tsnode|
----@param depth integer Current recursion depth
----@param lang string Language of the tree currently being traversed
----@param injections table<integer,TSP.Node> Mapping of node ids to root nodes of injected language trees (see
----                        explanation above)
----@param tree TSP.Node[] Output table containing a list of tables each representing a node in the tree
----@private
-local function traverse(node, depth, lang, injections, tree)
-  local injection = injections[node:id()]
-  if injection then
-    traverse(injection.root, depth, injection.lang, injections, tree)
-  end
-
-  for child, field in node:iter_children() do
-    local type = child:type()
-    local lnum, col, end_lnum, end_col = child:range()
-    local named = child:named()
-    local text ---@type string
-    if named then
-      if field then
-        text = string.format('%s: (%s)', field, type)
-      else
-        text = string.format('(%s)', type)
-      end
-    else
-      text = string.format('"%s"', type:gsub('\n', '\\n'))
-    end
-
-    table.insert(tree, {
-      id = child:id(),
-      text = text,
-      named = named,
-      depth = depth,
-      lnum = lnum,
-      col = col,
-      end_lnum = end_lnum,
-      end_col = end_col,
-      lang = lang,
-    })
-
-    traverse(child, depth + 1, lang, injections, tree)
-  end
-
-  return tree
-end
-
---- Create a new Playground object.
----
----@param bufnr integer Source buffer number
----@param lang string|nil Language of source buffer
----
----@return TSPlayground|nil
----@return string|nil Error message, if any
----
----@package
-function TSPlayground:new(bufnr, lang)
-  local ok, parser = pcall(vim.treesitter.get_parser, bufnr or 0, lang)
-  if not ok then
-    return nil, 'No parser available for the given buffer'
-  end
-
-  -- For each child tree (injected language), find the root of the tree and locate the node within
-  -- the primary tree that contains that root. Add a mapping from the node in the primary tree to
-  -- the root in the child tree to the {injections} table.
-  local root = parser:parse()[1]:root()
-  local injections = {} ---@type table<integer,table>
-  parser:for_each_child(function(child, lang_)
-    child:for_each_tree(function(tree)
-      local r = tree:root()
-      local node = root:named_descendant_for_range(r:range())
-      if node then
-        injections[node:id()] = {
-          lang = lang_,
-          root = r,
-        }
-      end
-    end)
-  end)
-
-  local nodes = traverse(root, 0, parser:lang(), injections, {})
-
-  local named = {} ---@type TSP.Node[]
-  for _, v in ipairs(nodes) do
-    if v.named then
-      named[#named + 1] = v
-    end
-  end
-
-  local t = {
-    ns = api.nvim_create_namespace(''),
-    nodes = nodes,
-    named = named,
-    opts = {
-      anon = false,
-      lang = false,
-    },
-  }
-
-  setmetatable(t, self)
-  self.__index = self
-  return t
-end
-
-local decor_ns = api.nvim_create_namespace('ts.playground')
-
----@private
----@param lnum integer
----@param col integer
----@param end_lnum integer
----@param end_col integer
----@return string
-local function get_range_str(lnum, col, end_lnum, end_col)
-  if lnum == end_lnum then
-    return string.format('[%d:%d - %d]', lnum + 1, col + 1, end_col)
-  end
-  return string.format('[%d:%d - %d:%d]', lnum + 1, col + 1, end_lnum + 1, end_col)
-end
-
---- Write the contents of this Playground into {bufnr}.
----
----@param bufnr integer Buffer number to write into.
----@package
-function TSPlayground:draw(bufnr)
-  vim.bo[bufnr].modifiable = true
-  local lines = {} ---@type string[]
-  local lang_hl_marks = {} ---@type table[]
-
-  for _, item in self:iter() do
-    local range_str = get_range_str(item.lnum, item.col, item.end_lnum, item.end_col)
-    local lang_str = self.opts.lang and string.format(' %s', item.lang) or ''
-    local line =
-      string.format('%s%s ; %s%s', string.rep(' ', item.depth), item.text, range_str, lang_str)
-
-    if self.opts.lang then
-      lang_hl_marks[#lang_hl_marks + 1] = {
-        col = #line - #lang_str,
-        end_col = #line,
-      }
-    end
-
-    lines[#lines + 1] = line
-  end
-
-  api.nvim_buf_set_lines(bufnr, 0, -1, false, lines)
-
-  api.nvim_buf_clear_namespace(bufnr, decor_ns, 0, -1)
-
-  for i, m in ipairs(lang_hl_marks) do
-    api.nvim_buf_set_extmark(bufnr, decor_ns, i - 1, m.col, {
-      hl_group = 'Title',
-      end_col = m.end_col,
-    })
-  end
-
-  vim.bo[bufnr].modifiable = false
-end
-
---- Get node {i} from this Playground object.
----
---- The node number is dependent on whether or not anonymous nodes are displayed.
----
----@param i integer Node number to get
----@return TSP.Node
----@package
-function TSPlayground:get(i)
-  local t = self.opts.anon and self.nodes or self.named
-  return t[i]
-end
-
---- Iterate over all of the nodes in this Playground object.
----
----@return (fun(): integer, TSP.Node) Iterator over all nodes in this Playground
----@return table
----@return integer
----@package
-function TSPlayground:iter()
-  return ipairs(self.opts.anon and self.nodes or self.named)
-end
-
---- @class InspectTreeOpts
---- @field lang string? The language of the source buffer. If omitted, the
----                     filetype of the source buffer is used.
---- @field bufnr integer? Buffer to draw the tree into. If omitted, a new
----                       buffer is created.
---- @field winid integer? Window id to display the tree buffer in. If omitted,
----                       a new window is created with {command}.
---- @field command string? Vimscript command to create the window. Default
----                       value is "60vnew". Only used when {winid} is nil.
---- @field title (string|fun(bufnr:integer):string|nil) Title of the window. If a
----                       function, it accepts the buffer number of the source
----                       buffer as its only argument and should return a string.
-
---- @param opts InspectTreeOpts
-function M.inspect_tree(opts)
-  vim.validate({
-    opts = { opts, 't', true },
-  })
-
-  opts = opts or {}
-
-  local buf = api.nvim_get_current_buf()
-  local win = api.nvim_get_current_win()
-  local pg = assert(TSPlayground:new(buf, opts.lang))
-
-  -- Close any existing playground window
-  if vim.b[buf].playground then
-    local w = vim.b[buf].playground
-    if api.nvim_win_is_valid(w) then
-      api.nvim_win_close(w, true)
-    end
-  end
-
-  local w = opts.winid
-  if not w then
-    vim.cmd(opts.command or '60vnew')
-    w = api.nvim_get_current_win()
-  end
-
-  local b = opts.bufnr
-  if b then
-    api.nvim_win_set_buf(w, b)
-  else
-    b = api.nvim_win_get_buf(w)
-  end
-
-  vim.b[buf].playground = w
-
-  vim.wo[w].scrolloff = 5
-  vim.wo[w].wrap = false
-  vim.wo[w].foldmethod = 'manual' -- disable folding
-  vim.bo[b].buflisted = false
-  vim.bo[b].buftype = 'nofile'
-  vim.bo[b].bufhidden = 'wipe'
-  vim.b[b].disable_query_linter = true
-  vim.bo[b].filetype = 'query'
-
-  local title --- @type string?
-  local opts_title = opts.title
-  if not opts_title then
-    local bufname = api.nvim_buf_get_name(buf)
-    title = string.format('Syntax tree for %s', vim.fn.fnamemodify(bufname, ':.'))
-  elseif type(opts_title) == 'function' then
-    title = opts_title(buf)
-  end
-
-  assert(type(title) == 'string', 'Window title must be a string')
-  api.nvim_buf_set_name(b, title)
-
-  pg:draw(b)
-
-  api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
-  api.nvim_buf_set_keymap(b, 'n', '<CR>', '', {
-    desc = 'Jump to the node under the cursor in the source buffer',
-    callback = function()
-      local row = api.nvim_win_get_cursor(w)[1]
-      local pos = pg:get(row)
-      api.nvim_set_current_win(win)
-      api.nvim_win_set_cursor(win, { pos.lnum + 1, pos.col })
-    end,
-  })
-  api.nvim_buf_set_keymap(b, 'n', 'a', '', {
-    desc = 'Toggle anonymous nodes',
-    callback = function()
-      local row, col = unpack(api.nvim_win_get_cursor(w))
-      local curnode = pg:get(row)
-      while curnode and not curnode.named do
-        row = row - 1
-        curnode = pg:get(row)
-      end
-
-      pg.opts.anon = not pg.opts.anon
-      pg:draw(b)
-
-      if not curnode then
-        return
-      end
-
-      local id = curnode.id
-      for i, node in pg:iter() do
-        if node.id == id then
-          api.nvim_win_set_cursor(w, { i, col })
-          break
-        end
-      end
-    end,
-  })
-  api.nvim_buf_set_keymap(b, 'n', 'I', '', {
-    desc = 'Toggle language display',
-    callback = function()
-      pg.opts.lang = not pg.opts.lang
-      pg:draw(b)
-    end,
-  })
-
-  local group = api.nvim_create_augroup('treesitter/playground', {})
-
-  api.nvim_create_autocmd('CursorMoved', {
-    group = group,
-    buffer = b,
-    callback = function()
-      api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
-      local row = api.nvim_win_get_cursor(w)[1]
-      local pos = pg:get(row)
-      api.nvim_buf_set_extmark(buf, pg.ns, pos.lnum, pos.col, {
-        end_row = pos.end_lnum,
-        end_col = math.max(0, pos.end_col),
-        hl_group = 'Visual',
-      })
-
-      local topline, botline = vim.fn.line('w0', win), vim.fn.line('w$', win)
-
-      -- Move the cursor if highlighted range is completely out of view
-      if pos.lnum < topline and pos.end_lnum < topline then
-        api.nvim_win_set_cursor(win, { pos.end_lnum + 1, 0 })
-      elseif pos.lnum > botline and pos.end_lnum > botline then
-        api.nvim_win_set_cursor(win, { pos.lnum + 1, 0 })
-      end
-    end,
-  })
-
-  api.nvim_create_autocmd('CursorMoved', {
-    group = group,
-    buffer = buf,
-    callback = function()
-      if not api.nvim_buf_is_loaded(b) then
-        return true
-      end
-
-      api.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
-
-      local cursor_node = vim.treesitter.get_node({
-        bufnr = buf,
-        lang = opts.lang,
-        ignore_injections = false,
-      })
-      if not cursor_node then
-        return
-      end
-
-      local cursor_node_id = cursor_node:id()
-      for i, v in pg:iter() do
-        if v.id == cursor_node_id then
-          local start = v.depth
-          local end_col = start + #v.text
-          api.nvim_buf_set_extmark(b, pg.ns, i - 1, start, {
-            end_col = end_col,
-            hl_group = 'Visual',
-          })
-          api.nvim_win_set_cursor(w, { i, 0 })
-          break
-        end
-      end
-    end,
-  })
-
-  api.nvim_create_autocmd({ 'TextChanged', 'InsertLeave' }, {
-    group = group,
-    buffer = buf,
-    callback = function()
-      if not api.nvim_buf_is_loaded(b) then
-        return true
-      end
-
-      pg = assert(TSPlayground:new(buf, opts.lang))
-      pg:draw(b)
-    end,
-  })
-
-  api.nvim_create_autocmd('BufLeave', {
-    group = group,
-    buffer = b,
-    callback = function()
-      api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
-    end,
-  })
-
-  api.nvim_create_autocmd('BufLeave', {
-    group = group,
-    buffer = buf,
-    callback = function()
-      if not api.nvim_buf_is_loaded(b) then
-        return true
-      end
-
-      api.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
-    end,
-  })
-
-  api.nvim_create_autocmd('BufHidden', {
-    group = group,
-    buffer = buf,
-    once = true,
-    callback = function()
-      if api.nvim_win_is_valid(w) then
-        api.nvim_win_close(w, true)
-      end
-    end,
-  })
-end
-
-return M
-- 
cgit 


From 4382d2ed564b80944345785d780cf1b19fb23ba8 Mon Sep 17 00:00:00 2001
From: Alexandre Teoi <ateoi@users.noreply.github.com>
Date: Tue, 6 Jun 2023 12:42:26 -0300
Subject: feat(health): fold successful healthchecks #22866

Problem:
checkhealth can be noisy, but we don't want to omit info.

Solution:
Fold OK results by default, if 'foldenable' is enabled.
Resolves #22796
---
 runtime/lua/vim/health.lua | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/health.lua b/runtime/lua/vim/health.lua
index ff338b95ea..6e47a22d03 100644
--- a/runtime/lua/vim/health.lua
+++ b/runtime/lua/vim/health.lua
@@ -2,6 +2,40 @@ local M = {}
 
 local s_output = {}
 
+-- Returns the fold text of the current healthcheck section
+function M.foldtext()
+  local foldtext = vim.fn.foldtext()
+
+  if vim.bo.filetype ~= 'checkhealth' then
+    return foldtext
+  end
+
+  if vim.b.failedchecks == nil then
+    vim.b.failedchecks = vim.empty_dict()
+  end
+
+  if vim.b.failedchecks[foldtext] == nil then
+    local warning = '- WARNING '
+    local warninglen = string.len(warning)
+    local err = '- ERROR '
+    local errlen = string.len(err)
+    local failedchecks = vim.b.failedchecks
+    failedchecks[foldtext] = false
+
+    local foldcontent = vim.api.nvim_buf_get_lines(0, vim.v.foldstart - 1, vim.v.foldend, false)
+    for _, line in ipairs(foldcontent) do
+      if string.sub(line, 1, warninglen) == warning or string.sub(line, 1, errlen) == err then
+        failedchecks[foldtext] = true
+        break
+      end
+    end
+
+    vim.b.failedchecks = failedchecks
+  end
+
+  return vim.b.failedchecks[foldtext] and '+WE' .. foldtext:sub(4) or foldtext
+end
+
 -- From a path return a list [{name}, {func}, {type}] representing a healthcheck
 local function filepath_to_healthcheck(path)
   path = vim.fs.normalize(path)
-- 
cgit 


From 5f4895200a49d92e636dea9c5474ab5b0882384d Mon Sep 17 00:00:00 2001
From: max397574 <81827001+max397574@users.noreply.github.com>
Date: Wed, 7 Jun 2023 13:32:39 +0200
Subject: feat(scripts): add lsp_types.lua (#23750)

---
 runtime/lua/vim/lsp/types/protocol.lua | 4398 ++++++++++++++++++++++++++++++++
 1 file changed, 4398 insertions(+)
 create mode 100644 runtime/lua/vim/lsp/types/protocol.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/types/protocol.lua b/runtime/lua/vim/lsp/types/protocol.lua
new file mode 100644
index 0000000000..4b6660eb51
--- /dev/null
+++ b/runtime/lua/vim/lsp/types/protocol.lua
@@ -0,0 +1,4398 @@
+--[[
+This file is autogenerated from scripts/lsp_types.lua
+Regenerate:
+nvim -l scripts/lsp_types.lua gen --runtime/lua/vim/lsp/types/protocol.lua
+--]]
+
+---@alias lsp.null nil
+---@alias uinteger integer
+---@alias lsp.decimal number
+---@alias lsp.DocumentUri string
+---@alias lsp.URI string
+---@alias lsp.LSPObject table<string, lsp.LSPAny>
+---@alias lsp.LSPArray lsp.LSPAny[]
+---@alias lsp.LSPAny lsp.LSPObject|lsp.LSPArray|string|number|boolean|nil
+
+---@class lsp.ImplementationParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---Represents a location inside a resource, such as a line
+---inside a text file.
+---@class lsp.Location
+---@field uri lsp.DocumentUri
+---@field range lsp.Range
+
+---@class lsp.ImplementationRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---@class lsp.TypeDefinitionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---@class lsp.TypeDefinitionRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---A workspace folder inside a client.
+---@class lsp.WorkspaceFolder
+---The associated URI for this workspace folder.
+---@field uri lsp.URI
+---The name of the workspace folder. Used to refer to this
+---workspace folder in the user interface.
+---@field name string
+
+---The parameters of a `workspace/didChangeWorkspaceFolders` notification.
+---@class lsp.DidChangeWorkspaceFoldersParams
+---The actual workspace folder change event.
+---@field event lsp.WorkspaceFoldersChangeEvent
+
+---The parameters of a configuration request.
+---@class lsp.ConfigurationParams
+---@field items lsp.ConfigurationItem[]
+
+---Parameters for a {@link DocumentColorRequest}.
+---@class lsp.DocumentColorParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---Represents a color range from a document.
+---@class lsp.ColorInformation
+---The range in the document where this color appears.
+---@field range lsp.Range
+---The actual color value for this color range.
+---@field color lsp.Color
+
+---@class lsp.DocumentColorRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---Parameters for a {@link ColorPresentationRequest}.
+---@class lsp.ColorPresentationParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The color to request presentations for.
+---@field color lsp.Color
+---The range where the color would be inserted. Serves as a context.
+---@field range lsp.Range
+
+---@class lsp.ColorPresentation
+---The label of this color presentation. It will be shown on the color
+---picker header. By default this is also the text that is inserted when selecting
+---this color presentation.
+---@field label string
+---An {@link TextEdit edit} which is applied to a document when selecting
+---this presentation for the color.  When `falsy` the {@link ColorPresentation.label label}
+---is used.
+---@field textEdit? lsp.TextEdit
+---An optional array of additional {@link TextEdit text edits} that are applied when
+---selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.
+---@field additionalTextEdits? lsp.TextEdit[]
+
+---@class lsp.WorkDoneProgressOptions
+---@field workDoneProgress? boolean
+
+---General text document registration options.
+---@class lsp.TextDocumentRegistrationOptions
+---A document selector to identify the scope of the registration. If set to null
+---the document selector provided on the client side will be used.
+---@field documentSelector lsp.DocumentSelector|lsp.null
+
+---Parameters for a {@link FoldingRangeRequest}.
+---@class lsp.FoldingRangeParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---Represents a folding range. To be valid, start and end line must be bigger than zero and smaller
+---than the number of lines in the document. Clients are free to ignore invalid ranges.
+---@class lsp.FoldingRange
+---The zero-based start line of the range to fold. The folded area starts after the line's last character.
+---To be valid, the end must be zero or larger and smaller than the number of lines in the document.
+---@field startLine uinteger
+---The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
+---@field startCharacter? uinteger
+---The zero-based end line of the range to fold. The folded area ends with the line's last character.
+---To be valid, the end must be zero or larger and smaller than the number of lines in the document.
+---@field endLine uinteger
+---The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
+---@field endCharacter? uinteger
+---Describes the kind of the folding range such as `comment' or 'region'. The kind
+---is used to categorize folding ranges and used by commands like 'Fold all comments'.
+---See {@link FoldingRangeKind} for an enumeration of standardized kinds.
+---@field kind? lsp.FoldingRangeKind
+---The text that the client should show when the specified range is
+---collapsed. If not defined or not supported by the client, a default
+---will be chosen by the client.
+---
+---@since 3.17.0
+---@field collapsedText? string
+
+---@class lsp.FoldingRangeRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---@class lsp.DeclarationParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---@class lsp.DeclarationRegistrationOptions: lsp.DeclarationOptions, lsp.StaticRegistrationOptions
+
+---A parameter literal used in selection range requests.
+---@class lsp.SelectionRangeParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The positions inside the text document.
+---@field positions lsp.Position[]
+
+---A selection range represents a part of a selection hierarchy. A selection range
+---may have a parent selection range that contains it.
+---@class lsp.SelectionRange
+---The {@link Range range} of this selection range.
+---@field range lsp.Range
+---The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.
+---@field parent? lsp.SelectionRange
+
+---@class lsp.SelectionRangeRegistrationOptions: lsp.SelectionRangeOptions, lsp.StaticRegistrationOptions
+
+---@class lsp.WorkDoneProgressCreateParams
+---The token to be used to report progress.
+---@field token lsp.ProgressToken
+
+---@class lsp.WorkDoneProgressCancelParams
+---The token to be used to report progress.
+---@field token lsp.ProgressToken
+
+---The parameter of a `textDocument/prepareCallHierarchy` request.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyPrepareParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+
+---Represents programming constructs like functions or constructors in the context
+---of call hierarchy.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyItem
+---The name of this item.
+---@field name string
+---The kind of this item.
+---@field kind lsp.SymbolKind
+---Tags for this item.
+---@field tags? lsp.SymbolTag[]
+---More detail for this item, e.g. the signature of a function.
+---@field detail? string
+---The resource identifier of this item.
+---@field uri lsp.DocumentUri
+---The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
+---@field range lsp.Range
+---The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function.
+---Must be contained by the {@link CallHierarchyItem.range `range`}.
+---@field selectionRange lsp.Range
+---A data entry field that is preserved between a call hierarchy prepare and
+---incoming calls or outgoing calls requests.
+---@field data? lsp.LSPAny
+
+---Call hierarchy options used during static or dynamic registration.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---The parameter of a `callHierarchy/incomingCalls` request.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyIncomingCallsParams
+---@field item lsp.CallHierarchyItem
+
+---Represents an incoming call, e.g. a caller of a method or constructor.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyIncomingCall
+---The item that makes the call.
+---@field from lsp.CallHierarchyItem
+---The ranges at which the calls appear. This is relative to the caller
+---denoted by {@link CallHierarchyIncomingCall.from `this.from`}.
+---@field fromRanges lsp.Range[]
+
+---The parameter of a `callHierarchy/outgoingCalls` request.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyOutgoingCallsParams
+---@field item lsp.CallHierarchyItem
+
+---Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyOutgoingCall
+---The item that is called.
+---@field to lsp.CallHierarchyItem
+---The range at which this item is called. This is the range relative to the caller, e.g the item
+---passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`}
+---and not {@link CallHierarchyOutgoingCall.to `this.to`}.
+---@field fromRanges lsp.Range[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---@since 3.16.0
+---@class lsp.SemanticTokens
+---An optional result id. If provided and clients support delta updating
+---the client will include the result id in the next semantic token request.
+---A server can then instead of computing all semantic tokens again simply
+---send a delta.
+---@field resultId? string
+---The actual tokens.
+---@field data uinteger[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensPartialResult
+---@field data uinteger[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---@since 3.16.0
+---@class lsp.SemanticTokensDeltaParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The result id of a previous response. The result Id can either point to a full response
+---or a delta response depending on what was received last.
+---@field previousResultId string
+
+---@since 3.16.0
+---@class lsp.SemanticTokensDelta
+---@field resultId? string
+---The semantic token edits to transform a previous result into a new result.
+---@field edits lsp.SemanticTokensEdit[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensDeltaPartialResult
+---@field edits lsp.SemanticTokensEdit[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensRangeParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The range the semantic tokens are requested for.
+---@field range lsp.Range
+
+---Params to show a resource in the UI.
+---
+---@since 3.16.0
+---@class lsp.ShowDocumentParams
+---The uri to show.
+---@field uri lsp.URI
+---Indicates to show the resource in an external program.
+---To show, for example, `https://code.visualstudio.com/`
+---in the default WEB browser set `external` to `true`.
+---@field external? boolean
+---An optional property to indicate whether the editor
+---showing the document should take focus or not.
+---Clients might ignore this property if an external
+---program is started.
+---@field takeFocus? boolean
+---An optional selection range if the document is a text
+---document. Clients might ignore the property if an
+---external program is started or the file is not a text
+---file.
+---@field selection? lsp.Range
+
+---The result of a showDocument request.
+---
+---@since 3.16.0
+---@class lsp.ShowDocumentResult
+---A boolean indicating if the show was successful.
+---@field success boolean
+
+---@class lsp.LinkedEditingRangeParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+
+---The result of a linked editing range request.
+---
+---@since 3.16.0
+---@class lsp.LinkedEditingRanges
+---A list of ranges that can be edited together. The ranges must have
+---identical length and contain identical text content. The ranges cannot overlap.
+---@field ranges lsp.Range[]
+---An optional word pattern (regular expression) that describes valid contents for
+---the given ranges. If no pattern is provided, the client configuration's word
+---pattern will be used.
+---@field wordPattern? string
+
+---@class lsp.LinkedEditingRangeRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---The parameters sent in notifications/requests for user-initiated creation of
+---files.
+---
+---@since 3.16.0
+---@class lsp.CreateFilesParams
+---An array of all files/folders created in this operation.
+---@field files lsp.FileCreate[]
+
+---A workspace edit represents changes to many resources managed in the workspace. The edit
+---should either provide `changes` or `documentChanges`. If documentChanges are present
+---they are preferred over `changes` if the client can handle versioned document edits.
+---
+---Since version 3.13.0 a workspace edit can contain resource operations as well. If resource
+---operations are present clients need to execute the operations in the order in which they
+---are provided. So a workspace edit for example can consist of the following two changes:
+---(1) a create file a.txt and (2) a text document edit which insert text into file a.txt.
+---
+---An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will
+---cause failure of the operation. How the client recovers from the failure is described by
+---the client capability: `workspace.workspaceEdit.failureHandling`
+---@class lsp.WorkspaceEdit
+---Holds changes to existing resources.
+---@field changes? table<lsp.DocumentUri, lsp.TextEdit[]>
+---Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes
+---are either an array of `TextDocumentEdit`s to express changes to n different text documents
+---where each text document edit addresses a specific version of a text document. Or it can contain
+---above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations.
+---
+---Whether a client supports versioned document edits is expressed via
+---`workspace.workspaceEdit.documentChanges` client capability.
+---
+---If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then
+---only plain `TextEdit`s using the `changes` property are supported.
+---@field documentChanges? lsp.TextDocumentEdit|lsp.CreateFile|lsp.RenameFile|lsp.DeleteFile[]
+---A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and
+---delete file / folder operations.
+---
+---Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`.
+---
+---@since 3.16.0
+---@field changeAnnotations? table<lsp.ChangeAnnotationIdentifier, lsp.ChangeAnnotation>
+
+---The options to register for file operations.
+---
+---@since 3.16.0
+---@class lsp.FileOperationRegistrationOptions
+---The actual filters.
+---@field filters lsp.FileOperationFilter[]
+
+---The parameters sent in notifications/requests for user-initiated renames of
+---files.
+---
+---@since 3.16.0
+---@class lsp.RenameFilesParams
+---An array of all files/folders renamed in this operation. When a folder is renamed, only
+---the folder will be included, and not its children.
+---@field files lsp.FileRename[]
+
+---The parameters sent in notifications/requests for user-initiated deletes of
+---files.
+---
+---@since 3.16.0
+---@class lsp.DeleteFilesParams
+---An array of all files/folders deleted in this operation.
+---@field files lsp.FileDelete[]
+
+---@class lsp.MonikerParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---Moniker definition to match LSIF 0.5 moniker definition.
+---
+---@since 3.16.0
+---@class lsp.Moniker
+---The scheme of the moniker. For example tsc or .Net
+---@field scheme string
+---The identifier of the moniker. The value is opaque in LSIF however
+---schema owners are allowed to define the structure if they want.
+---@field identifier string
+---The scope in which the moniker is unique
+---@field unique lsp.UniquenessLevel
+---The moniker kind if known.
+---@field kind? lsp.MonikerKind
+
+---@class lsp.MonikerRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameter of a `textDocument/prepareTypeHierarchy` request.
+---
+---@since 3.17.0
+---@class lsp.TypeHierarchyPrepareParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+
+---@since 3.17.0
+---@class lsp.TypeHierarchyItem
+---The name of this item.
+---@field name string
+---The kind of this item.
+---@field kind lsp.SymbolKind
+---Tags for this item.
+---@field tags? lsp.SymbolTag[]
+---More detail for this item, e.g. the signature of a function.
+---@field detail? string
+---The resource identifier of this item.
+---@field uri lsp.DocumentUri
+---The range enclosing this symbol not including leading/trailing whitespace
+---but everything else, e.g. comments and code.
+---@field range lsp.Range
+---The range that should be selected and revealed when this symbol is being
+---picked, e.g. the name of a function. Must be contained by the
+---{@link TypeHierarchyItem.range `range`}.
+---@field selectionRange lsp.Range
+---A data entry field that is preserved between a type hierarchy prepare and
+---supertypes or subtypes requests. It could also be used to identify the
+---type hierarchy in the server, helping improve the performance on
+---resolving supertypes and subtypes.
+---@field data? lsp.LSPAny
+
+---Type hierarchy options used during static or dynamic registration.
+---
+---@since 3.17.0
+---@class lsp.TypeHierarchyRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---The parameter of a `typeHierarchy/supertypes` request.
+---
+---@since 3.17.0
+---@class lsp.TypeHierarchySupertypesParams
+---@field item lsp.TypeHierarchyItem
+
+---The parameter of a `typeHierarchy/subtypes` request.
+---
+---@since 3.17.0
+---@class lsp.TypeHierarchySubtypesParams
+---@field item lsp.TypeHierarchyItem
+
+---A parameter literal used in inline value requests.
+---
+---@since 3.17.0
+---@class lsp.InlineValueParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The document range for which inline values should be computed.
+---@field range lsp.Range
+---Additional information about the context in which inline values were
+---requested.
+---@field context lsp.InlineValueContext
+
+---Inline value options used during static or dynamic registration.
+---
+---@since 3.17.0
+---@class lsp.InlineValueRegistrationOptions: lsp.InlineValueOptions, lsp.StaticRegistrationOptions
+
+---A parameter literal used in inlay hint requests.
+---
+---@since 3.17.0
+---@class lsp.InlayHintParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The document range for which inlay hints should be computed.
+---@field range lsp.Range
+
+---Inlay hint information.
+---
+---@since 3.17.0
+---@class lsp.InlayHint
+---The position of this hint.
+---@field position lsp.Position
+---The label of this hint. A human readable string or an array of
+---InlayHintLabelPart label parts.
+---
+---*Note* that neither the string nor the label part can be empty.
+---@field label string|lsp.InlayHintLabelPart[]
+---The kind of this hint. Can be omitted in which case the client
+---should fall back to a reasonable default.
+---@field kind? lsp.InlayHintKind
+---Optional text edits that are performed when accepting this inlay hint.
+---
+---*Note* that edits are expected to change the document so that the inlay
+---hint (or its nearest variant) is now part of the document and the inlay
+---hint itself is now obsolete.
+---@field textEdits? lsp.TextEdit[]
+---The tooltip text when you hover over this item.
+---@field tooltip? string|lsp.MarkupContent
+---Render padding before the hint.
+---
+---Note: Padding should use the editor's background color, not the
+---background color of the hint itself. That means padding can be used
+---to visually align/separate an inlay hint.
+---@field paddingLeft? boolean
+---Render padding after the hint.
+---
+---Note: Padding should use the editor's background color, not the
+---background color of the hint itself. That means padding can be used
+---to visually align/separate an inlay hint.
+---@field paddingRight? boolean
+---A data entry field that is preserved on an inlay hint between
+---a `textDocument/inlayHint` and a `inlayHint/resolve` request.
+---@field data? lsp.LSPAny
+
+---Inlay hint options used during static or dynamic registration.
+---
+---@since 3.17.0
+---@class lsp.InlayHintRegistrationOptions: lsp.InlayHintOptions, lsp.StaticRegistrationOptions
+
+---Parameters of the document diagnostic request.
+---
+---@since 3.17.0
+---@class lsp.DocumentDiagnosticParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The additional identifier  provided during registration.
+---@field identifier? string
+---The result id of a previous response if provided.
+---@field previousResultId? string
+
+---A partial result for a document diagnostic report.
+---
+---@since 3.17.0
+---@class lsp.DocumentDiagnosticReportPartialResult
+---@field relatedDocuments table<lsp.DocumentUri, lsp.FullDocumentDiagnosticReport|lsp.UnchangedDocumentDiagnosticReport>
+
+---Cancellation data returned from a diagnostic request.
+---
+---@since 3.17.0
+---@class lsp.DiagnosticServerCancellationData
+---@field retriggerRequest boolean
+
+---Diagnostic registration options.
+---
+---@since 3.17.0
+---@class lsp.DiagnosticRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---Parameters of the workspace diagnostic request.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceDiagnosticParams
+---The additional identifier provided during registration.
+---@field identifier? string
+---The currently known diagnostic reports with their
+---previous result ids.
+---@field previousResultIds lsp.PreviousResultId[]
+
+---A workspace diagnostic report.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceDiagnosticReport
+---@field items lsp.WorkspaceDocumentDiagnosticReport[]
+
+---A partial result for a workspace diagnostic report.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceDiagnosticReportPartialResult
+---@field items lsp.WorkspaceDocumentDiagnosticReport[]
+
+---The params sent in an open notebook document notification.
+---
+---@since 3.17.0
+---@class lsp.DidOpenNotebookDocumentParams
+---The notebook document that got opened.
+---@field notebookDocument lsp.NotebookDocument
+---The text documents that represent the content
+---of a notebook cell.
+---@field cellTextDocuments lsp.TextDocumentItem[]
+
+---The params sent in a change notebook document notification.
+---
+---@since 3.17.0
+---@class lsp.DidChangeNotebookDocumentParams
+---The notebook document that did change. The version number points
+---to the version after all provided changes have been applied. If
+---only the text document content of a cell changes the notebook version
+---doesn't necessarily have to change.
+---@field notebookDocument lsp.VersionedNotebookDocumentIdentifier
+---The actual changes to the notebook document.
+---
+---The changes describe single state changes to the notebook document.
+---So if there are two changes c1 (at array index 0) and c2 (at array
+---index 1) for a notebook in state S then c1 moves the notebook from
+---S to S' and c2 from S' to S''. So c1 is computed on the state S and
+---c2 is computed on the state S'.
+---
+---To mirror the content of a notebook using change events use the following approach:
+---- start with the same initial content
+---- apply the 'notebookDocument/didChange' notifications in the order you receive them.
+---- apply the `NotebookChangeEvent`s in a single notification in the order
+---  you receive them.
+---@field change lsp.NotebookDocumentChangeEvent
+
+---The params sent in a save notebook document notification.
+---
+---@since 3.17.0
+---@class lsp.DidSaveNotebookDocumentParams
+---The notebook document that got saved.
+---@field notebookDocument lsp.NotebookDocumentIdentifier
+
+---The params sent in a close notebook document notification.
+---
+---@since 3.17.0
+---@class lsp.DidCloseNotebookDocumentParams
+---The notebook document that got closed.
+---@field notebookDocument lsp.NotebookDocumentIdentifier
+---The text documents that represent the content
+---of a notebook cell that got closed.
+---@field cellTextDocuments lsp.TextDocumentIdentifier[]
+
+---A parameter literal used in inline completion requests.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.InlineCompletionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+---Additional information about the context in which inline completions were
+---requested.
+---@field context lsp.InlineCompletionContext
+
+---Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.InlineCompletionList
+---The inline completion items
+---@field items lsp.InlineCompletionItem[]
+
+---An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.InlineCompletionItem
+---The text to replace the range with. Must be set.
+---@field insertText string|lsp.StringValue
+---A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used.
+---@field filterText? string
+---The range to replace. Must begin and end on the same line.
+---@field range? lsp.Range
+---An optional {@link Command} that is executed *after* inserting this completion.
+---@field command? lsp.Command
+
+---Inline completion options used during static or dynamic registration.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.InlineCompletionRegistrationOptions: lsp.InlineCompletionOptions, lsp.StaticRegistrationOptions
+
+---@class lsp.RegistrationParams
+---@field registrations lsp.Registration[]
+
+---@class lsp.UnregistrationParams
+---@field unregisterations lsp.Unregistration[]
+
+---@class lsp.InitializeParams: lsp._InitializeParams
+
+---The result returned from an initialize request.
+---@class lsp.InitializeResult
+---The capabilities the language server provides.
+---@field capabilities lsp.ServerCapabilities
+---Information about the server.
+---
+---@since 3.15.0
+---@field serverInfo? anonym1
+
+---The data type of the ResponseError if the
+---initialize request fails.
+---@class lsp.InitializeError
+---Indicates whether the client execute the following retry logic:
+---(1) show the message provided by the ResponseError to the user
+---(2) user selects retry or cancel
+---(3) if user selected retry the initialize method is sent again.
+---@field retry boolean
+
+---@class lsp.InitializedParams
+
+---The parameters of a change configuration notification.
+---@class lsp.DidChangeConfigurationParams
+---The actual changed settings
+---@field settings lsp.LSPAny
+
+---@class lsp.DidChangeConfigurationRegistrationOptions
+---@field section? string|string[]
+
+---The parameters of a notification message.
+---@class lsp.ShowMessageParams
+---The message type. See {@link MessageType}
+---@field type lsp.MessageType
+---The actual message.
+---@field message string
+
+---@class lsp.ShowMessageRequestParams
+---The message type. See {@link MessageType}
+---@field type lsp.MessageType
+---The actual message.
+---@field message string
+---The message action items to present.
+---@field actions? lsp.MessageActionItem[]
+
+---@class lsp.MessageActionItem
+---A short title like 'Retry', 'Open Log' etc.
+---@field title string
+
+---The log message parameters.
+---@class lsp.LogMessageParams
+---The message type. See {@link MessageType}
+---@field type lsp.MessageType
+---The actual message.
+---@field message string
+
+---The parameters sent in an open text document notification
+---@class lsp.DidOpenTextDocumentParams
+---The document that was opened.
+---@field textDocument lsp.TextDocumentItem
+
+---The change text document notification's parameters.
+---@class lsp.DidChangeTextDocumentParams
+---The document that did change. The version number points
+---to the version after all provided content changes have
+---been applied.
+---@field textDocument lsp.VersionedTextDocumentIdentifier
+---The actual content changes. The content changes describe single state changes
+---to the document. So if there are two content changes c1 (at array index 0) and
+---c2 (at array index 1) for a document in state S then c1 moves the document from
+---S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed
+---on the state S'.
+---
+---To mirror the content of a document using change events use the following approach:
+---- start with the same initial content
+---- apply the 'textDocument/didChange' notifications in the order you receive them.
+---- apply the `TextDocumentContentChangeEvent`s in a single notification in the order
+---  you receive them.
+---@field contentChanges lsp.TextDocumentContentChangeEvent[]
+
+---Describe options to be used when registered for text document change events.
+---@class lsp.TextDocumentChangeRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---How documents are synced to the server.
+---@field syncKind lsp.TextDocumentSyncKind
+
+---The parameters sent in a close text document notification
+---@class lsp.DidCloseTextDocumentParams
+---The document that was closed.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---The parameters sent in a save text document notification
+---@class lsp.DidSaveTextDocumentParams
+---The document that was saved.
+---@field textDocument lsp.TextDocumentIdentifier
+---Optional the content when saved. Depends on the includeText value
+---when the save notification was requested.
+---@field text? string
+
+---Save registration options.
+---@class lsp.TextDocumentSaveRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters sent in a will save text document notification.
+---@class lsp.WillSaveTextDocumentParams
+---The document that will be saved.
+---@field textDocument lsp.TextDocumentIdentifier
+---The 'TextDocumentSaveReason'.
+---@field reason lsp.TextDocumentSaveReason
+
+---A text edit applicable to a text document.
+---@class lsp.TextEdit
+---The range of the text document to be manipulated. To insert
+---text into a document create a range where start === end.
+---@field range lsp.Range
+---The string to be inserted. For delete operations use an
+---empty string.
+---@field newText string
+
+---The watched files change notification's parameters.
+---@class lsp.DidChangeWatchedFilesParams
+---The actual file events.
+---@field changes lsp.FileEvent[]
+
+---Describe options to be used when registered for text document change events.
+---@class lsp.DidChangeWatchedFilesRegistrationOptions
+---The watchers to register.
+---@field watchers lsp.FileSystemWatcher[]
+
+---The publish diagnostic notification's parameters.
+---@class lsp.PublishDiagnosticsParams
+---The URI for which diagnostic information is reported.
+---@field uri lsp.DocumentUri
+---Optional the version number of the document the diagnostics are published for.
+---
+---@since 3.15.0
+---@field version? integer
+---An array of diagnostic information items.
+---@field diagnostics lsp.Diagnostic[]
+
+---Completion parameters
+---@class lsp.CompletionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---The completion context. This is only available it the client specifies
+---to send this using the client capability `textDocument.completion.contextSupport === true`
+---@field context? lsp.CompletionContext
+
+---A completion item represents a text snippet that is
+---proposed to complete text that is being typed.
+---@class lsp.CompletionItem
+---The label of this completion item.
+---
+---The label property is also by default the text that
+---is inserted when selecting this completion.
+---
+---If label details are provided the label itself should
+---be an unqualified name of the completion item.
+---@field label string
+---Additional details for the label
+---
+---@since 3.17.0
+---@field labelDetails? lsp.CompletionItemLabelDetails
+---The kind of this completion item. Based of the kind
+---an icon is chosen by the editor.
+---@field kind? lsp.CompletionItemKind
+---Tags for this completion item.
+---
+---@since 3.15.0
+---@field tags? lsp.CompletionItemTag[]
+---A human-readable string with additional information
+---about this item, like type or symbol information.
+---@field detail? string
+---A human-readable string that represents a doc-comment.
+---@field documentation? string|lsp.MarkupContent
+---Indicates if this item is deprecated.
+---@deprecated Use `tags` instead.
+---@field deprecated? boolean
+---Select this item when showing.
+---
+---*Note* that only one completion item can be selected and that the
+---tool / client decides which item that is. The rule is that the *first*
+---item of those that match best is selected.
+---@field preselect? boolean
+---A string that should be used when comparing this item
+---with other items. When `falsy` the {@link CompletionItem.label label}
+---is used.
+---@field sortText? string
+---A string that should be used when filtering a set of
+---completion items. When `falsy` the {@link CompletionItem.label label}
+---is used.
+---@field filterText? string
+---A string that should be inserted into a document when selecting
+---this completion. When `falsy` the {@link CompletionItem.label label}
+---is used.
+---
+---The `insertText` is subject to interpretation by the client side.
+---Some tools might not take the string literally. For example
+---VS Code when code complete is requested in this example
+---`con<cursor position>` and a completion item with an `insertText` of
+---`console` is provided it will only insert `sole`. Therefore it is
+---recommended to use `textEdit` instead since it avoids additional client
+---side interpretation.
+---@field insertText? string
+---The format of the insert text. The format applies to both the
+---`insertText` property and the `newText` property of a provided
+---`textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.
+---
+---Please note that the insertTextFormat doesn't apply to
+---`additionalTextEdits`.
+---@field insertTextFormat? lsp.InsertTextFormat
+---How whitespace and indentation is handled during completion
+---item insertion. If not provided the clients default value depends on
+---the `textDocument.completion.insertTextMode` client capability.
+---
+---@since 3.16.0
+---@field insertTextMode? lsp.InsertTextMode
+---An {@link TextEdit edit} which is applied to a document when selecting
+---this completion. When an edit is provided the value of
+---{@link CompletionItem.insertText insertText} is ignored.
+---
+---Most editors support two different operations when accepting a completion
+---item. One is to insert a completion text and the other is to replace an
+---existing text with a completion text. Since this can usually not be
+---predetermined by a server it can report both ranges. Clients need to
+---signal support for `InsertReplaceEdits` via the
+---`textDocument.completion.insertReplaceSupport` client capability
+---property.
+---
+---*Note 1:* The text edit's range as well as both ranges from an insert
+---replace edit must be a [single line] and they must contain the position
+---at which completion has been requested.
+---*Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range
+---must be a prefix of the edit's replace range, that means it must be
+---contained and starting at the same position.
+---
+---@since 3.16.0 additional type `InsertReplaceEdit`
+---@field textEdit? lsp.TextEdit|lsp.InsertReplaceEdit
+---The edit text used if the completion item is part of a CompletionList and
+---CompletionList defines an item default for the text edit range.
+---
+---Clients will only honor this property if they opt into completion list
+---item defaults using the capability `completionList.itemDefaults`.
+---
+---If not provided and a list's default range is provided the label
+---property is used as a text.
+---
+---@since 3.17.0
+---@field textEditText? string
+---An optional array of additional {@link TextEdit text edits} that are applied when
+---selecting this completion. Edits must not overlap (including the same insert position)
+---with the main {@link CompletionItem.textEdit edit} nor with themselves.
+---
+---Additional text edits should be used to change text unrelated to the current cursor position
+---(for example adding an import statement at the top of the file if the completion item will
+---insert an unqualified type).
+---@field additionalTextEdits? lsp.TextEdit[]
+---An optional set of characters that when pressed while this completion is active will accept it first and
+---then type that character. *Note* that all commit characters should have `length=1` and that superfluous
+---characters will be ignored.
+---@field commitCharacters? string[]
+---An optional {@link Command command} that is executed *after* inserting this completion. *Note* that
+---additional modifications to the current document should be described with the
+---{@link CompletionItem.additionalTextEdits additionalTextEdits}-property.
+---@field command? lsp.Command
+---A data entry field that is preserved on a completion item between a
+---{@link CompletionRequest} and a {@link CompletionResolveRequest}.
+---@field data? lsp.LSPAny
+
+---Represents a collection of {@link CompletionItem completion items} to be presented
+---in the editor.
+---@class lsp.CompletionList
+---This list it not complete. Further typing results in recomputing this list.
+---
+---Recomputed lists have all their items replaced (not appended) in the
+---incomplete completion sessions.
+---@field isIncomplete boolean
+---In many cases the items of an actual completion result share the same
+---value for properties like `commitCharacters` or the range of a text
+---edit. A completion list can therefore define item defaults which will
+---be used if a completion item itself doesn't specify the value.
+---
+---If a completion list specifies a default value and a completion item
+---also specifies a corresponding value the one from the item is used.
+---
+---Servers are only allowed to return default values if the client
+---signals support for this via the `completionList.itemDefaults`
+---capability.
+---
+---@since 3.17.0
+---@field itemDefaults? anonym3
+---The completion items.
+---@field items lsp.CompletionItem[]
+
+---Registration options for a {@link CompletionRequest}.
+---@class lsp.CompletionRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link HoverRequest}.
+---@class lsp.HoverParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+
+---The result of a hover request.
+---@class lsp.Hover
+---The hover's content
+---@field contents lsp.MarkupContent|lsp.MarkedString|lsp.MarkedString[]
+---An optional range inside the text document that is used to
+---visualize the hover, e.g. by changing the background color.
+---@field range? lsp.Range
+
+---Registration options for a {@link HoverRequest}.
+---@class lsp.HoverRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link SignatureHelpRequest}.
+---@class lsp.SignatureHelpParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+---The signature help context. This is only available if the client specifies
+---to send this using the client capability `textDocument.signatureHelp.contextSupport === true`
+---
+---@since 3.15.0
+---@field context? lsp.SignatureHelpContext
+
+---Signature help represents the signature of something
+---callable. There can be multiple signature but only one
+---active and only one active parameter.
+---@class lsp.SignatureHelp
+---One or more signatures.
+---@field signatures lsp.SignatureInformation[]
+---The active signature. If omitted or the value lies outside the
+---range of `signatures` the value defaults to zero or is ignored if
+---the `SignatureHelp` has no signatures.
+---
+---Whenever possible implementors should make an active decision about
+---the active signature and shouldn't rely on a default value.
+---
+---In future version of the protocol this property might become
+---mandatory to better express this.
+---@field activeSignature? uinteger
+---The active parameter of the active signature. If omitted or the value
+---lies outside the range of `signatures[activeSignature].parameters`
+---defaults to 0 if the active signature has parameters. If
+---the active signature has no parameters it is ignored.
+---In future version of the protocol this property might become
+---mandatory to better express the active parameter if the
+---active signature does have any.
+---@field activeParameter? uinteger
+
+---Registration options for a {@link SignatureHelpRequest}.
+---@class lsp.SignatureHelpRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link DefinitionRequest}.
+---@class lsp.DefinitionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---Registration options for a {@link DefinitionRequest}.
+---@class lsp.DefinitionRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link ReferencesRequest}.
+---@class lsp.ReferenceParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---@field context lsp.ReferenceContext
+
+---Registration options for a {@link ReferencesRequest}.
+---@class lsp.ReferenceRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link DocumentHighlightRequest}.
+---@class lsp.DocumentHighlightParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---A document highlight is a range inside a text document which deserves
+---special attention. Usually a document highlight is visualized by changing
+---the background color of its range.
+---@class lsp.DocumentHighlight
+---The range this highlight applies to.
+---@field range lsp.Range
+---The highlight kind, default is {@link DocumentHighlightKind.Text text}.
+---@field kind? lsp.DocumentHighlightKind
+
+---Registration options for a {@link DocumentHighlightRequest}.
+---@class lsp.DocumentHighlightRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link DocumentSymbolRequest}.
+---@class lsp.DocumentSymbolParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---Represents information about programming constructs like variables, classes,
+---interfaces etc.
+---@class lsp.SymbolInformation: lsp.BaseSymbolInformation
+---Indicates if this symbol is deprecated.
+---
+---@deprecated Use tags instead
+---@field deprecated? boolean
+---The location of this symbol. The location's range is used by a tool
+---to reveal the location in the editor. If the symbol is selected in the
+---tool the range's start information is used to position the cursor. So
+---the range usually spans more than the actual symbol's name and does
+---normally include things like visibility modifiers.
+---
+---The range doesn't have to denote a node range in the sense of an abstract
+---syntax tree. It can therefore not be used to re-construct a hierarchy of
+---the symbols.
+---@field location lsp.Location
+
+---Represents programming constructs like variables, classes, interfaces etc.
+---that appear in a document. Document symbols can be hierarchical and they
+---have two ranges: one that encloses its definition and one that points to
+---its most interesting range, e.g. the range of an identifier.
+---@class lsp.DocumentSymbol
+---The name of this symbol. Will be displayed in the user interface and therefore must not be
+---an empty string or a string only consisting of white spaces.
+---@field name string
+---More detail for this symbol, e.g the signature of a function.
+---@field detail? string
+---The kind of this symbol.
+---@field kind lsp.SymbolKind
+---Tags for this document symbol.
+---
+---@since 3.16.0
+---@field tags? lsp.SymbolTag[]
+---Indicates if this symbol is deprecated.
+---
+---@deprecated Use tags instead
+---@field deprecated? boolean
+---The range enclosing this symbol not including leading/trailing whitespace but everything else
+---like comments. This information is typically used to determine if the clients cursor is
+---inside the symbol to reveal in the symbol in the UI.
+---@field range lsp.Range
+---The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
+---Must be contained by the `range`.
+---@field selectionRange lsp.Range
+---Children of this symbol, e.g. properties of a class.
+---@field children? lsp.DocumentSymbol[]
+
+---Registration options for a {@link DocumentSymbolRequest}.
+---@class lsp.DocumentSymbolRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link CodeActionRequest}.
+---@class lsp.CodeActionParams
+---The document in which the command was invoked.
+---@field textDocument lsp.TextDocumentIdentifier
+---The range for which the command was invoked.
+---@field range lsp.Range
+---Context carrying additional information.
+---@field context lsp.CodeActionContext
+
+---Represents a reference to a command. Provides a title which
+---will be used to represent a command in the UI and, optionally,
+---an array of arguments which will be passed to the command handler
+---function when invoked.
+---@class lsp.Command
+---Title of the command, like `save`.
+---@field title string
+---The identifier of the actual command handler.
+---@field command string
+---Arguments that the command handler should be
+---invoked with.
+---@field arguments? lsp.LSPAny[]
+
+---A code action represents a change that can be performed in code, e.g. to fix a problem or
+---to refactor code.
+---
+---A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
+---@class lsp.CodeAction
+---A short, human-readable, title for this code action.
+---@field title string
+---The kind of the code action.
+---
+---Used to filter code actions.
+---@field kind? lsp.CodeActionKind
+---The diagnostics that this code action resolves.
+---@field diagnostics? lsp.Diagnostic[]
+---Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted
+---by keybindings.
+---
+---A quick fix should be marked preferred if it properly addresses the underlying error.
+---A refactoring should be marked preferred if it is the most reasonable choice of actions to take.
+---
+---@since 3.15.0
+---@field isPreferred? boolean
+---Marks that the code action cannot currently be applied.
+---
+---Clients should follow the following guidelines regarding disabled code actions:
+---
+---  - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action)
+---    code action menus.
+---
+---  - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type
+---    of code action, such as refactorings.
+---
+---  - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions)
+---    that auto applies a code action and only disabled code actions are returned, the client should show the user an
+---    error message with `reason` in the editor.
+---
+---@since 3.16.0
+---@field disabled? anonym4
+---The workspace edit this code action performs.
+---@field edit? lsp.WorkspaceEdit
+---A command this code action executes. If a code action
+---provides an edit and a command, first the edit is
+---executed and then the command.
+---@field command? lsp.Command
+---A data entry field that is preserved on a code action between
+---a `textDocument/codeAction` and a `codeAction/resolve` request.
+---
+---@since 3.16.0
+---@field data? lsp.LSPAny
+
+---Registration options for a {@link CodeActionRequest}.
+---@class lsp.CodeActionRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link WorkspaceSymbolRequest}.
+---@class lsp.WorkspaceSymbolParams
+---A query string to filter symbols by. Clients may send an empty
+---string here to request all symbols.
+---@field query string
+
+---A special workspace symbol that supports locations without a range.
+---
+---See also SymbolInformation.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceSymbol: lsp.BaseSymbolInformation
+---The location of the symbol. Whether a server is allowed to
+---return a location without a range depends on the client
+---capability `workspace.symbol.resolveSupport`.
+---
+---See SymbolInformation#location for more details.
+---@field location lsp.Location|anonym5
+---A data entry field that is preserved on a workspace symbol between a
+---workspace symbol request and a workspace symbol resolve request.
+---@field data? lsp.LSPAny
+
+---Registration options for a {@link WorkspaceSymbolRequest}.
+---@class lsp.WorkspaceSymbolRegistrationOptions: lsp.WorkspaceSymbolOptions
+
+---The parameters of a {@link CodeLensRequest}.
+---@class lsp.CodeLensParams
+---The document to request code lens for.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---A code lens represents a {@link Command command} that should be shown along with
+---source text, like the number of references, a way to run tests, etc.
+---
+---A code lens is _unresolved_ when no command is associated to it. For performance
+---reasons the creation of a code lens and resolving should be done in two stages.
+---@class lsp.CodeLens
+---The range in which this code lens is valid. Should only span a single line.
+---@field range lsp.Range
+---The command this code lens represents.
+---@field command? lsp.Command
+---A data entry field that is preserved on a code lens item between
+---a {@link CodeLensRequest} and a [CodeLensResolveRequest]
+---(#CodeLensResolveRequest)
+---@field data? lsp.LSPAny
+
+---Registration options for a {@link CodeLensRequest}.
+---@class lsp.CodeLensRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link DocumentLinkRequest}.
+---@class lsp.DocumentLinkParams
+---The document to provide document links for.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---A document link is a range in a text document that links to an internal or external resource, like another
+---text document or a web site.
+---@class lsp.DocumentLink
+---The range this link applies to.
+---@field range lsp.Range
+---The uri this link points to. If missing a resolve request is sent later.
+---@field target? lsp.URI
+---The tooltip text when you hover over this link.
+---
+---If a tooltip is provided, is will be displayed in a string that includes instructions on how to
+---trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,
+---user settings, and localization.
+---
+---@since 3.15.0
+---@field tooltip? string
+---A data entry field that is preserved on a document link between a
+---DocumentLinkRequest and a DocumentLinkResolveRequest.
+---@field data? lsp.LSPAny
+
+---Registration options for a {@link DocumentLinkRequest}.
+---@class lsp.DocumentLinkRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link DocumentFormattingRequest}.
+---@class lsp.DocumentFormattingParams
+---The document to format.
+---@field textDocument lsp.TextDocumentIdentifier
+---The format options.
+---@field options lsp.FormattingOptions
+
+---Registration options for a {@link DocumentFormattingRequest}.
+---@class lsp.DocumentFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link DocumentRangeFormattingRequest}.
+---@class lsp.DocumentRangeFormattingParams
+---The document to format.
+---@field textDocument lsp.TextDocumentIdentifier
+---The range to format
+---@field range lsp.Range
+---The format options
+---@field options lsp.FormattingOptions
+
+---Registration options for a {@link DocumentRangeFormattingRequest}.
+---@class lsp.DocumentRangeFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link DocumentOnTypeFormattingRequest}.
+---@class lsp.DocumentOnTypeFormattingParams
+---The document to format.
+---@field textDocument lsp.TextDocumentIdentifier
+---The position around which the on type formatting should happen.
+---This is not necessarily the exact position where the character denoted
+---by the property `ch` got typed.
+---@field position lsp.Position
+---The character that has been typed that triggered the formatting
+---on type request. That is not necessarily the last character that
+---got inserted into the document since the client could auto insert
+---characters as well (e.g. like automatic brace completion).
+---@field ch string
+---The formatting options.
+---@field options lsp.FormattingOptions
+
+---Registration options for a {@link DocumentOnTypeFormattingRequest}.
+---@class lsp.DocumentOnTypeFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link RenameRequest}.
+---@class lsp.RenameParams
+---The document to rename.
+---@field textDocument lsp.TextDocumentIdentifier
+---The position at which this request was sent.
+---@field position lsp.Position
+---The new name of the symbol. If the given name is not valid the
+---request must return a {@link ResponseError} with an
+---appropriate message set.
+---@field newName string
+
+---Registration options for a {@link RenameRequest}.
+---@class lsp.RenameRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---@class lsp.PrepareRenameParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+
+---The parameters of a {@link ExecuteCommandRequest}.
+---@class lsp.ExecuteCommandParams
+---The identifier of the actual command handler.
+---@field command string
+---Arguments that the command should be invoked with.
+---@field arguments? lsp.LSPAny[]
+
+---Registration options for a {@link ExecuteCommandRequest}.
+---@class lsp.ExecuteCommandRegistrationOptions: lsp.ExecuteCommandOptions
+
+---The parameters passed via an apply workspace edit request.
+---@class lsp.ApplyWorkspaceEditParams
+---An optional label of the workspace edit. This label is
+---presented in the user interface for example on an undo
+---stack to undo the workspace edit.
+---@field label? string
+---The edits to apply.
+---@field edit lsp.WorkspaceEdit
+
+---The result returned from the apply workspace edit request.
+---
+---@since 3.17 renamed from ApplyWorkspaceEditResponse
+---@class lsp.ApplyWorkspaceEditResult
+---Indicates whether the edit was applied or not.
+---@field applied boolean
+---An optional textual description for why the edit was not applied.
+---This may be used by the server for diagnostic logging or to provide
+---a suitable error for a request that triggered the edit.
+---@field failureReason? string
+---Depending on the client's failure handling strategy `failedChange` might
+---contain the index of the change that failed. This property is only available
+---if the client signals a `failureHandlingStrategy` in its client capabilities.
+---@field failedChange? uinteger
+
+---@class lsp.WorkDoneProgressBegin
+---@field kind "begin"
+---Mandatory title of the progress operation. Used to briefly inform about
+---the kind of operation being performed.
+---
+---Examples: "Indexing" or "Linking dependencies".
+---@field title string
+---Controls if a cancel button should show to allow the user to cancel the
+---long running operation. Clients that don't support cancellation are allowed
+---to ignore the setting.
+---@field cancellable? boolean
+---Optional, more detailed associated progress message. Contains
+---complementary information to the `title`.
+---
+---Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
+---If unset, the previous progress message (if any) is still valid.
+---@field message? string
+---Optional progress percentage to display (value 100 is considered 100%).
+---If not provided infinite progress is assumed and clients are allowed
+---to ignore the `percentage` value in subsequent in report notifications.
+---
+---The value should be steadily rising. Clients are free to ignore values
+---that are not following this rule. The value range is [0, 100].
+---@field percentage? uinteger
+
+---@class lsp.WorkDoneProgressReport
+---@field kind "report"
+---Controls enablement state of a cancel button.
+---
+---Clients that don't support cancellation or don't support controlling the button's
+---enablement state are allowed to ignore the property.
+---@field cancellable? boolean
+---Optional, more detailed associated progress message. Contains
+---complementary information to the `title`.
+---
+---Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
+---If unset, the previous progress message (if any) is still valid.
+---@field message? string
+---Optional progress percentage to display (value 100 is considered 100%).
+---If not provided infinite progress is assumed and clients are allowed
+---to ignore the `percentage` value in subsequent in report notifications.
+---
+---The value should be steadily rising. Clients are free to ignore values
+---that are not following this rule. The value range is [0, 100]
+---@field percentage? uinteger
+
+---@class lsp.WorkDoneProgressEnd
+---@field kind "end"
+---Optional, a final message indicating to for example indicate the outcome
+---of the operation.
+---@field message? string
+
+---@class lsp.SetTraceParams
+---@field value lsp.TraceValues
+
+---@class lsp.LogTraceParams
+---@field message string
+---@field verbose? string
+
+---@class lsp.CancelParams
+---The request id to cancel.
+---@field id integer|string
+
+---@class lsp.ProgressParams
+---The progress token provided by the client or server.
+---@field token lsp.ProgressToken
+---The progress data.
+---@field value lsp.LSPAny
+
+---A parameter literal used in requests to pass a text document and a position inside that
+---document.
+---@class lsp.TextDocumentPositionParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The position inside the text document.
+---@field position lsp.Position
+
+---@class lsp.WorkDoneProgressParams
+---An optional token that a server can use to report work done progress.
+---@field workDoneToken? lsp.ProgressToken
+
+---@class lsp.PartialResultParams
+---An optional token that a server can use to report partial results (e.g. streaming) to
+---the client.
+---@field partialResultToken? lsp.ProgressToken
+
+---Represents the connection of two locations. Provides additional metadata over normal {@link Location locations},
+---including an origin range.
+---@class lsp.LocationLink
+---Span of the origin of this link.
+---
+---Used as the underlined span for mouse interaction. Defaults to the word range at
+---the definition position.
+---@field originSelectionRange? lsp.Range
+---The target resource identifier of this link.
+---@field targetUri lsp.DocumentUri
+---The full target range of this link. If the target for example is a symbol then target range is the
+---range enclosing this symbol not including leading/trailing whitespace but everything else
+---like comments. This information is typically used to highlight the range in the editor.
+---@field targetRange lsp.Range
+---The range that should be selected and revealed when this link is being followed, e.g the name of a function.
+---Must be contained by the `targetRange`. See also `DocumentSymbol#range`
+---@field targetSelectionRange lsp.Range
+
+---A range in a text document expressed as (zero-based) start and end positions.
+---
+---If you want to specify a range that contains a line including the line ending
+---character(s) then use an end position denoting the start of the next line.
+---For example:
+---```ts
+---{
+---    start: { line: 5, character: 23 }
+---    end : { line 6, character : 0 }
+---}
+---```
+---@class lsp.Range
+---The range's start position.
+---@field start lsp.Position
+---The range's end position.
+---@field end lsp.Position
+
+---@class lsp.ImplementationOptions
+
+---Static registration options to be returned in the initialize
+---request.
+---@class lsp.StaticRegistrationOptions
+---The id used to register the request. The id can be used to deregister
+---the request again. See also Registration#id.
+---@field id? string
+
+---@class lsp.TypeDefinitionOptions
+
+---The workspace folder change event.
+---@class lsp.WorkspaceFoldersChangeEvent
+---The array of added workspace folders
+---@field added lsp.WorkspaceFolder[]
+---The array of the removed workspace folders
+---@field removed lsp.WorkspaceFolder[]
+
+---@class lsp.ConfigurationItem
+---The scope to get the configuration section for.
+---@field scopeUri? string
+---The configuration section asked for.
+---@field section? string
+
+---A literal to identify a text document in the client.
+---@class lsp.TextDocumentIdentifier
+---The text document's uri.
+---@field uri lsp.DocumentUri
+
+---Represents a color in RGBA space.
+---@class lsp.Color
+---The red component of this color in the range [0-1].
+---@field red decimal
+---The green component of this color in the range [0-1].
+---@field green decimal
+---The blue component of this color in the range [0-1].
+---@field blue decimal
+---The alpha component of this color in the range [0-1].
+---@field alpha decimal
+
+---@class lsp.DocumentColorOptions
+
+---@class lsp.FoldingRangeOptions
+
+---@class lsp.DeclarationOptions
+
+---Position in a text document expressed as zero-based line and character
+---offset. Prior to 3.17 the offsets were always based on a UTF-16 string
+---representation. So a string of the form `a𐐀b` the character offset of the
+---character `a` is 0, the character offset of `𐐀` is 1 and the character
+---offset of b is 3 since `𐐀` is represented using two code units in UTF-16.
+---Since 3.17 clients and servers can agree on a different string encoding
+---representation (e.g. UTF-8). The client announces it's supported encoding
+---via the client capability [`general.positionEncodings`](#clientCapabilities).
+---The value is an array of position encodings the client supports, with
+---decreasing preference (e.g. the encoding at index `0` is the most preferred
+---one). To stay backwards compatible the only mandatory encoding is UTF-16
+---represented via the string `utf-16`. The server can pick one of the
+---encodings offered by the client and signals that encoding back to the
+---client via the initialize result's property
+---[`capabilities.positionEncoding`](#serverCapabilities). If the string value
+---`utf-16` is missing from the client's capability `general.positionEncodings`
+---servers can safely assume that the client supports UTF-16. If the server
+---omits the position encoding in its initialize result the encoding defaults
+---to the string value `utf-16`. Implementation considerations: since the
+---conversion from one encoding into another requires the content of the
+---file / line the conversion is best done where the file is read which is
+---usually on the server side.
+---
+---Positions are line end character agnostic. So you can not specify a position
+---that denotes `\r|\n` or `\n|` where `|` represents the character offset.
+---
+---@since 3.17.0 - support for negotiated position encoding.
+---@class lsp.Position
+---Line position in a document (zero-based).
+---
+---If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document.
+---If a line number is negative, it defaults to 0.
+---@field line uinteger
+---Character offset on a line in a document (zero-based).
+---
+---The meaning of this offset is determined by the negotiated
+---`PositionEncodingKind`.
+---
+---If the character value is greater than the line length it defaults back to the
+---line length.
+---@field character uinteger
+
+---@class lsp.SelectionRangeOptions
+
+---Call hierarchy options used during static registration.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyOptions
+
+---@since 3.16.0
+---@class lsp.SemanticTokensOptions
+---The legend used by the server
+---@field legend lsp.SemanticTokensLegend
+---Server supports providing semantic tokens for a specific range
+---of a document.
+---@field range? boolean|anonym6
+---Server supports providing semantic tokens for a full document.
+---@field full? boolean|anonym7
+
+---@since 3.16.0
+---@class lsp.SemanticTokensEdit
+---The start offset of the edit.
+---@field start uinteger
+---The count of elements to remove.
+---@field deleteCount uinteger
+---The elements to insert.
+---@field data? uinteger[]
+
+---@class lsp.LinkedEditingRangeOptions
+
+---Represents information on a file/folder create.
+---
+---@since 3.16.0
+---@class lsp.FileCreate
+---A file:// URI for the location of the file/folder being created.
+---@field uri string
+
+---Describes textual changes on a text document. A TextDocumentEdit describes all changes
+---on a document version Si and after they are applied move the document to version Si+1.
+---So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any
+---kind of ordering. However the edits must be non overlapping.
+---@class lsp.TextDocumentEdit
+---The text document to change.
+---@field textDocument lsp.OptionalVersionedTextDocumentIdentifier
+---The edits to be applied.
+---
+---@since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a
+---client capability.
+---@field edits lsp.TextEdit|lsp.AnnotatedTextEdit[]
+
+---Create file operation.
+---@class lsp.CreateFile: lsp.ResourceOperation
+---A create
+---@field kind "create"
+---The resource to create.
+---@field uri lsp.DocumentUri
+---Additional options
+---@field options? lsp.CreateFileOptions
+
+---Rename file operation
+---@class lsp.RenameFile: lsp.ResourceOperation
+---A rename
+---@field kind "rename"
+---The old (existing) location.
+---@field oldUri lsp.DocumentUri
+---The new location.
+---@field newUri lsp.DocumentUri
+---Rename options.
+---@field options? lsp.RenameFileOptions
+
+---Delete file operation
+---@class lsp.DeleteFile: lsp.ResourceOperation
+---A delete
+---@field kind "delete"
+---The file to delete.
+---@field uri lsp.DocumentUri
+---Delete options.
+---@field options? lsp.DeleteFileOptions
+
+---Additional information that describes document changes.
+---
+---@since 3.16.0
+---@class lsp.ChangeAnnotation
+---A human-readable string describing the actual change. The string
+---is rendered prominent in the user interface.
+---@field label string
+---A flag which indicates that user confirmation is needed
+---before applying the change.
+---@field needsConfirmation? boolean
+---A human-readable string which is rendered less prominent in
+---the user interface.
+---@field description? string
+
+---A filter to describe in which file operation requests or notifications
+---the server is interested in receiving.
+---
+---@since 3.16.0
+---@class lsp.FileOperationFilter
+---A Uri scheme like `file` or `untitled`.
+---@field scheme? string
+---The actual file operation pattern.
+---@field pattern lsp.FileOperationPattern
+
+---Represents information on a file/folder rename.
+---
+---@since 3.16.0
+---@class lsp.FileRename
+---A file:// URI for the original location of the file/folder being renamed.
+---@field oldUri string
+---A file:// URI for the new location of the file/folder being renamed.
+---@field newUri string
+
+---Represents information on a file/folder delete.
+---
+---@since 3.16.0
+---@class lsp.FileDelete
+---A file:// URI for the location of the file/folder being deleted.
+---@field uri string
+
+---@class lsp.MonikerOptions
+
+---Type hierarchy options used during static registration.
+---
+---@since 3.17.0
+---@class lsp.TypeHierarchyOptions
+
+---@since 3.17.0
+---@class lsp.InlineValueContext
+---The stack frame (as a DAP Id) where the execution has stopped.
+---@field frameId integer
+---The document range where execution has stopped.
+---Typically the end position of the range denotes the line where the inline values are shown.
+---@field stoppedLocation lsp.Range
+
+---Provide inline value as text.
+---
+---@since 3.17.0
+---@class lsp.InlineValueText
+---The document range for which the inline value applies.
+---@field range lsp.Range
+---The text of the inline value.
+---@field text string
+
+---Provide inline value through a variable lookup.
+---If only a range is specified, the variable name will be extracted from the underlying document.
+---An optional variable name can be used to override the extracted name.
+---
+---@since 3.17.0
+---@class lsp.InlineValueVariableLookup
+---The document range for which the inline value applies.
+---The range is used to extract the variable name from the underlying document.
+---@field range lsp.Range
+---If specified the name of the variable to look up.
+---@field variableName? string
+---How to perform the lookup.
+---@field caseSensitiveLookup boolean
+
+---Provide an inline value through an expression evaluation.
+---If only a range is specified, the expression will be extracted from the underlying document.
+---An optional expression can be used to override the extracted expression.
+---
+---@since 3.17.0
+---@class lsp.InlineValueEvaluatableExpression
+---The document range for which the inline value applies.
+---The range is used to extract the evaluatable expression from the underlying document.
+---@field range lsp.Range
+---If specified the expression overrides the extracted expression.
+---@field expression? string
+
+---Inline value options used during static registration.
+---
+---@since 3.17.0
+---@class lsp.InlineValueOptions
+
+---An inlay hint label part allows for interactive and composite labels
+---of inlay hints.
+---
+---@since 3.17.0
+---@class lsp.InlayHintLabelPart
+---The value of this label part.
+---@field value string
+---The tooltip text when you hover over this label part. Depending on
+---the client capability `inlayHint.resolveSupport` clients might resolve
+---this property late using the resolve request.
+---@field tooltip? string|lsp.MarkupContent
+---An optional source code location that represents this
+---label part.
+---
+---The editor will use this location for the hover and for code navigation
+---features: This part will become a clickable link that resolves to the
+---definition of the symbol at the given location (not necessarily the
+---location itself), it shows the hover that shows at the given location,
+---and it shows a context menu with further code navigation commands.
+---
+---Depending on the client capability `inlayHint.resolveSupport` clients
+---might resolve this property late using the resolve request.
+---@field location? lsp.Location
+---An optional command for this label part.
+---
+---Depending on the client capability `inlayHint.resolveSupport` clients
+---might resolve this property late using the resolve request.
+---@field command? lsp.Command
+
+---A `MarkupContent` literal represents a string value which content is interpreted base on its
+---kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
+---
+---If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.
+---See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
+---
+---Here is an example how such a string can be constructed using JavaScript / TypeScript:
+---```ts
+---let markdown: MarkdownContent = {
+--- kind: MarkupKind.Markdown,
+--- value: [
+---   '# Header',
+---   'Some text',
+---   '```typescript',
+---   'someCode();',
+---   '```'
+--- ].join('\n')
+---};
+---```
+---
+---*Please Note* that clients might sanitize the return markdown. A client could decide to
+---remove HTML from the markdown to avoid script execution.
+---@class lsp.MarkupContent
+---The type of the Markup
+---@field kind lsp.MarkupKind
+---The content itself
+---@field value string
+
+---Inlay hint options used during static registration.
+---
+---@since 3.17.0
+---@class lsp.InlayHintOptions
+---The server provides support to resolve additional
+---information for an inlay hint item.
+---@field resolveProvider? boolean
+
+---A full diagnostic report with a set of related documents.
+---
+---@since 3.17.0
+---@class lsp.RelatedFullDocumentDiagnosticReport: lsp.FullDocumentDiagnosticReport
+---Diagnostics of related documents. This information is useful
+---in programming languages where code in a file A can generate
+---diagnostics in a file B which A depends on. An example of
+---such a language is C/C++ where marco definitions in a file
+---a.cpp and result in errors in a header file b.hpp.
+---
+---@since 3.17.0
+---@field relatedDocuments? table<lsp.DocumentUri, lsp.FullDocumentDiagnosticReport|lsp.UnchangedDocumentDiagnosticReport>
+
+---An unchanged diagnostic report with a set of related documents.
+---
+---@since 3.17.0
+---@class lsp.RelatedUnchangedDocumentDiagnosticReport: lsp.UnchangedDocumentDiagnosticReport
+---Diagnostics of related documents. This information is useful
+---in programming languages where code in a file A can generate
+---diagnostics in a file B which A depends on. An example of
+---such a language is C/C++ where marco definitions in a file
+---a.cpp and result in errors in a header file b.hpp.
+---
+---@since 3.17.0
+---@field relatedDocuments? table<lsp.DocumentUri, lsp.FullDocumentDiagnosticReport|lsp.UnchangedDocumentDiagnosticReport>
+
+---A diagnostic report with a full set of problems.
+---
+---@since 3.17.0
+---@class lsp.FullDocumentDiagnosticReport
+---A full document diagnostic report.
+---@field kind "full"
+---An optional result id. If provided it will
+---be sent on the next diagnostic request for the
+---same document.
+---@field resultId? string
+---The actual items.
+---@field items lsp.Diagnostic[]
+
+---A diagnostic report indicating that the last returned
+---report is still accurate.
+---
+---@since 3.17.0
+---@class lsp.UnchangedDocumentDiagnosticReport
+---A document diagnostic report indicating
+---no changes to the last result. A server can
+---only return `unchanged` if result ids are
+---provided.
+---@field kind "unchanged"
+---A result id which will be sent on the next
+---diagnostic request for the same document.
+---@field resultId string
+
+---Diagnostic options.
+---
+---@since 3.17.0
+---@class lsp.DiagnosticOptions
+---An optional identifier under which the diagnostics are
+---managed by the client.
+---@field identifier? string
+---Whether the language has inter file dependencies meaning that
+---editing code in one file can result in a different diagnostic
+---set in another file. Inter file dependencies are common for
+---most programming languages and typically uncommon for linters.
+---@field interFileDependencies boolean
+---The server provides support for workspace diagnostics as well.
+---@field workspaceDiagnostics boolean
+
+---A previous result id in a workspace pull request.
+---
+---@since 3.17.0
+---@class lsp.PreviousResultId
+---The URI for which the client knowns a
+---result id.
+---@field uri lsp.DocumentUri
+---The value of the previous result id.
+---@field value string
+
+---A notebook document.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocument
+---The notebook document's uri.
+---@field uri lsp.URI
+---The type of the notebook.
+---@field notebookType string
+---The version number of this document (it will increase after each
+---change, including undo/redo).
+---@field version integer
+---Additional metadata stored with the notebook
+---document.
+---
+---Note: should always be an object literal (e.g. LSPObject)
+---@field metadata? lsp.LSPObject
+---The cells of a notebook.
+---@field cells lsp.NotebookCell[]
+
+---An item to transfer a text document from the client to the
+---server.
+---@class lsp.TextDocumentItem
+---The text document's uri.
+---@field uri lsp.DocumentUri
+---The text document's language identifier.
+---@field languageId string
+---The version number of this document (it will increase after each
+---change, including undo/redo).
+---@field version integer
+---The content of the opened text document.
+---@field text string
+
+---A versioned notebook document identifier.
+---
+---@since 3.17.0
+---@class lsp.VersionedNotebookDocumentIdentifier
+---The version number of this notebook document.
+---@field version integer
+---The notebook document's uri.
+---@field uri lsp.URI
+
+---A change event for a notebook document.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentChangeEvent
+---The changed meta data if any.
+---
+---Note: should always be an object literal (e.g. LSPObject)
+---@field metadata? lsp.LSPObject
+---Changes to cells
+---@field cells? anonym10
+
+---A literal to identify a notebook document in the client.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentIdentifier
+---The notebook document's uri.
+---@field uri lsp.URI
+
+---Provides information about the context in which an inline completion was requested.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.InlineCompletionContext
+---Describes how the inline completion was triggered.
+---@field triggerKind lsp.InlineCompletionTriggerKind
+---Provides information about the currently selected item in the autocomplete widget if it is visible.
+---@field selectedCompletionInfo? lsp.SelectedCompletionInfo
+
+---A string value used as a snippet is a template which allows to insert text
+---and to control the editor cursor when insertion happens.
+---
+---A snippet can define tab stops and placeholders with `$1`, `$2`
+---and `${3:foo}`. `$0` defines the final tab stop, it defaults to
+---the end of the snippet. Variables are defined with `$name` and
+---`${name:default value}`.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.StringValue
+---The kind of string value.
+---@field kind "snippet"
+---The snippet string.
+---@field value string
+
+---Inline completion options used during static registration.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.InlineCompletionOptions
+
+---General parameters to register for a notification or to register a provider.
+---@class lsp.Registration
+---The id used to register the request. The id can be used to deregister
+---the request again.
+---@field id string
+---The method / capability to register for.
+---@field method string
+---Options necessary for the registration.
+---@field registerOptions? lsp.LSPAny
+
+---General parameters to unregister a request or notification.
+---@class lsp.Unregistration
+---The id used to unregister the request or notification. Usually an id
+---provided during the register request.
+---@field id string
+---The method to unregister for.
+---@field method string
+
+---The initialize parameters
+---@class lsp._InitializeParams
+---The process Id of the parent process that started
+---the server.
+---
+---Is `null` if the process has not been started by another process.
+---If the parent process is not alive then the server should exit.
+---@field processId integer|lsp.null
+---Information about the client
+---
+---@since 3.15.0
+---@field clientInfo? anonym11
+---The locale the client is currently showing the user interface
+---in. This must not necessarily be the locale of the operating
+---system.
+---
+---Uses IETF language tags as the value's syntax
+---(See https://en.wikipedia.org/wiki/IETF_language_tag)
+---
+---@since 3.16.0
+---@field locale? string
+---The rootPath of the workspace. Is null
+---if no folder is open.
+---
+---@deprecated in favour of rootUri.
+---@field rootPath? string|lsp.null
+---The rootUri of the workspace. Is null if no
+---folder is open. If both `rootPath` and `rootUri` are set
+---`rootUri` wins.
+---
+---@deprecated in favour of workspaceFolders.
+---@field rootUri lsp.DocumentUri|lsp.null
+---The capabilities provided by the client (editor or tool)
+---@field capabilities lsp.ClientCapabilities
+---User provided initialization options.
+---@field initializationOptions? lsp.LSPAny
+---The initial trace setting. If omitted trace is disabled ('off').
+---@field trace? lsp.TraceValues
+
+---@class lsp.WorkspaceFoldersInitializeParams
+---The workspace folders configured in the client when the server starts.
+---
+---This property is only available if the client supports workspace folders.
+---It can be `null` if the client supports workspace folders but none are
+---configured.
+---
+---@since 3.6.0
+---@field workspaceFolders? lsp.WorkspaceFolder[]|lsp.null
+
+---Defines the capabilities provided by a language
+---server.
+---@class lsp.ServerCapabilities
+---The position encoding the server picked from the encodings offered
+---by the client via the client capability `general.positionEncodings`.
+---
+---If the client didn't provide any position encodings the only valid
+---value that a server can return is 'utf-16'.
+---
+---If omitted it defaults to 'utf-16'.
+---
+---@since 3.17.0
+---@field positionEncoding? lsp.PositionEncodingKind
+---Defines how text documents are synced. Is either a detailed structure
+---defining each notification or for backwards compatibility the
+---TextDocumentSyncKind number.
+---@field textDocumentSync? lsp.TextDocumentSyncOptions|lsp.TextDocumentSyncKind
+---Defines how notebook documents are synced.
+---
+---@since 3.17.0
+---@field notebookDocumentSync? lsp.NotebookDocumentSyncOptions|lsp.NotebookDocumentSyncRegistrationOptions
+---The server provides completion support.
+---@field completionProvider? lsp.CompletionOptions
+---The server provides hover support.
+---@field hoverProvider? boolean|lsp.HoverOptions
+---The server provides signature help support.
+---@field signatureHelpProvider? lsp.SignatureHelpOptions
+---The server provides Goto Declaration support.
+---@field declarationProvider? boolean|lsp.DeclarationOptions|lsp.DeclarationRegistrationOptions
+---The server provides goto definition support.
+---@field definitionProvider? boolean|lsp.DefinitionOptions
+---The server provides Goto Type Definition support.
+---@field typeDefinitionProvider? boolean|lsp.TypeDefinitionOptions|lsp.TypeDefinitionRegistrationOptions
+---The server provides Goto Implementation support.
+---@field implementationProvider? boolean|lsp.ImplementationOptions|lsp.ImplementationRegistrationOptions
+---The server provides find references support.
+---@field referencesProvider? boolean|lsp.ReferenceOptions
+---The server provides document highlight support.
+---@field documentHighlightProvider? boolean|lsp.DocumentHighlightOptions
+---The server provides document symbol support.
+---@field documentSymbolProvider? boolean|lsp.DocumentSymbolOptions
+---The server provides code actions. CodeActionOptions may only be
+---specified if the client states that it supports
+---`codeActionLiteralSupport` in its initial `initialize` request.
+---@field codeActionProvider? boolean|lsp.CodeActionOptions
+---The server provides code lens.
+---@field codeLensProvider? lsp.CodeLensOptions
+---The server provides document link support.
+---@field documentLinkProvider? lsp.DocumentLinkOptions
+---The server provides color provider support.
+---@field colorProvider? boolean|lsp.DocumentColorOptions|lsp.DocumentColorRegistrationOptions
+---The server provides workspace symbol support.
+---@field workspaceSymbolProvider? boolean|lsp.WorkspaceSymbolOptions
+---The server provides document formatting.
+---@field documentFormattingProvider? boolean|lsp.DocumentFormattingOptions
+---The server provides document range formatting.
+---@field documentRangeFormattingProvider? boolean|lsp.DocumentRangeFormattingOptions
+---The server provides document formatting on typing.
+---@field documentOnTypeFormattingProvider? lsp.DocumentOnTypeFormattingOptions
+---The server provides rename support. RenameOptions may only be
+---specified if the client states that it supports
+---`prepareSupport` in its initial `initialize` request.
+---@field renameProvider? boolean|lsp.RenameOptions
+---The server provides folding provider support.
+---@field foldingRangeProvider? boolean|lsp.FoldingRangeOptions|lsp.FoldingRangeRegistrationOptions
+---The server provides selection range support.
+---@field selectionRangeProvider? boolean|lsp.SelectionRangeOptions|lsp.SelectionRangeRegistrationOptions
+---The server provides execute command support.
+---@field executeCommandProvider? lsp.ExecuteCommandOptions
+---The server provides call hierarchy support.
+---
+---@since 3.16.0
+---@field callHierarchyProvider? boolean|lsp.CallHierarchyOptions|lsp.CallHierarchyRegistrationOptions
+---The server provides linked editing range support.
+---
+---@since 3.16.0
+---@field linkedEditingRangeProvider? boolean|lsp.LinkedEditingRangeOptions|lsp.LinkedEditingRangeRegistrationOptions
+---The server provides semantic tokens support.
+---
+---@since 3.16.0
+---@field semanticTokensProvider? lsp.SemanticTokensOptions|lsp.SemanticTokensRegistrationOptions
+---The server provides moniker support.
+---
+---@since 3.16.0
+---@field monikerProvider? boolean|lsp.MonikerOptions|lsp.MonikerRegistrationOptions
+---The server provides type hierarchy support.
+---
+---@since 3.17.0
+---@field typeHierarchyProvider? boolean|lsp.TypeHierarchyOptions|lsp.TypeHierarchyRegistrationOptions
+---The server provides inline values.
+---
+---@since 3.17.0
+---@field inlineValueProvider? boolean|lsp.InlineValueOptions|lsp.InlineValueRegistrationOptions
+---The server provides inlay hints.
+---
+---@since 3.17.0
+---@field inlayHintProvider? boolean|lsp.InlayHintOptions|lsp.InlayHintRegistrationOptions
+---The server has support for pull model diagnostics.
+---
+---@since 3.17.0
+---@field diagnosticProvider? lsp.DiagnosticOptions|lsp.DiagnosticRegistrationOptions
+---Inline completion options used during static registration.
+---
+---@since 3.18.0
+---@proposed
+---@field inlineCompletionProvider? boolean|lsp.InlineCompletionOptions
+---Workspace specific server capabilities.
+---@field workspace? anonym12
+---Experimental server capabilities.
+---@field experimental? lsp.LSPAny
+
+---A text document identifier to denote a specific version of a text document.
+---@class lsp.VersionedTextDocumentIdentifier: lsp.TextDocumentIdentifier
+---The version number of this document.
+---@field version integer
+
+---Save options.
+---@class lsp.SaveOptions
+---The client is supposed to include the content on save.
+---@field includeText? boolean
+
+---An event describing a file change.
+---@class lsp.FileEvent
+---The file's uri.
+---@field uri lsp.DocumentUri
+---The change type.
+---@field type lsp.FileChangeType
+
+---@class lsp.FileSystemWatcher
+---The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.
+---
+---@since 3.17.0 support for relative patterns.
+---@field globPattern lsp.GlobPattern
+---The kind of events of interest. If omitted it defaults
+---to WatchKind.Create | WatchKind.Change | WatchKind.Delete
+---which is 7.
+---@field kind? lsp.WatchKind
+
+---Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
+---are only valid in the scope of a resource.
+---@class lsp.Diagnostic
+---The range at which the message applies
+---@field range lsp.Range
+---The diagnostic's severity. Can be omitted. If omitted it is up to the
+---client to interpret diagnostics as error, warning, info or hint.
+---@field severity? lsp.DiagnosticSeverity
+---The diagnostic's code, which usually appear in the user interface.
+---@field code? integer|string
+---An optional property to describe the error code.
+---Requires the code field (above) to be present/not null.
+---
+---@since 3.16.0
+---@field codeDescription? lsp.CodeDescription
+---A human-readable string describing the source of this
+---diagnostic, e.g. 'typescript' or 'super lint'. It usually
+---appears in the user interface.
+---@field source? string
+---The diagnostic's message. It usually appears in the user interface
+---@field message string
+---Additional metadata about the diagnostic.
+---
+---@since 3.15.0
+---@field tags? lsp.DiagnosticTag[]
+---An array of related diagnostic information, e.g. when symbol-names within
+---a scope collide all definitions can be marked via this property.
+---@field relatedInformation? lsp.DiagnosticRelatedInformation[]
+---A data entry field that is preserved between a `textDocument/publishDiagnostics`
+---notification and `textDocument/codeAction` request.
+---
+---@since 3.16.0
+---@field data? lsp.LSPAny
+
+---Contains additional information about the context in which a completion request is triggered.
+---@class lsp.CompletionContext
+---How the completion was triggered.
+---@field triggerKind lsp.CompletionTriggerKind
+---The trigger character (a single character) that has trigger code complete.
+---Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
+---@field triggerCharacter? string
+
+---Additional details for a completion item label.
+---
+---@since 3.17.0
+---@class lsp.CompletionItemLabelDetails
+---An optional string which is rendered less prominently directly after {@link CompletionItem.label label},
+---without any spacing. Should be used for function signatures and type annotations.
+---@field detail? string
+---An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used
+---for fully qualified names and file paths.
+---@field description? string
+
+---A special text edit to provide an insert and a replace operation.
+---
+---@since 3.16.0
+---@class lsp.InsertReplaceEdit
+---The string to be inserted.
+---@field newText string
+---The range if the insert is requested
+---@field insert lsp.Range
+---The range if the replace is requested.
+---@field replace lsp.Range
+
+---Completion options.
+---@class lsp.CompletionOptions
+---Most tools trigger completion request automatically without explicitly requesting
+---it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user
+---starts to type an identifier. For example if the user types `c` in a JavaScript file
+---code complete will automatically pop up present `console` besides others as a
+---completion item. Characters that make up identifiers don't need to be listed here.
+---
+---If code complete should automatically be trigger on characters not being valid inside
+---an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
+---@field triggerCharacters? string[]
+---The list of all possible characters that commit a completion. This field can be used
+---if clients don't support individual commit characters per completion item. See
+---`ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport`
+---
+---If a server provides both `allCommitCharacters` and commit characters on an individual
+---completion item the ones on the completion item win.
+---
+---@since 3.2.0
+---@field allCommitCharacters? string[]
+---The server provides support to resolve additional
+---information for a completion item.
+---@field resolveProvider? boolean
+---The server supports the following `CompletionItem` specific
+---capabilities.
+---
+---@since 3.17.0
+---@field completionItem? anonym13
+
+---Hover options.
+---@class lsp.HoverOptions
+
+---Additional information about the context in which a signature help request was triggered.
+---
+---@since 3.15.0
+---@class lsp.SignatureHelpContext
+---Action that caused signature help to be triggered.
+---@field triggerKind lsp.SignatureHelpTriggerKind
+---Character that caused signature help to be triggered.
+---
+---This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`
+---@field triggerCharacter? string
+---`true` if signature help was already showing when it was triggered.
+---
+---Retriggers occurs when the signature help is already active and can be caused by actions such as
+---typing a trigger character, a cursor move, or document content changes.
+---@field isRetrigger boolean
+---The currently active `SignatureHelp`.
+---
+---The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on
+---the user navigating through available signatures.
+---@field activeSignatureHelp? lsp.SignatureHelp
+
+---Represents the signature of something callable. A signature
+---can have a label, like a function-name, a doc-comment, and
+---a set of parameters.
+---@class lsp.SignatureInformation
+---The label of this signature. Will be shown in
+---the UI.
+---@field label string
+---The human-readable doc-comment of this signature. Will be shown
+---in the UI but can be omitted.
+---@field documentation? string|lsp.MarkupContent
+---The parameters of this signature.
+---@field parameters? lsp.ParameterInformation[]
+---The index of the active parameter.
+---
+---If provided, this is used in place of `SignatureHelp.activeParameter`.
+---
+---@since 3.16.0
+---@field activeParameter? uinteger
+
+---Server Capabilities for a {@link SignatureHelpRequest}.
+---@class lsp.SignatureHelpOptions
+---List of characters that trigger signature help automatically.
+---@field triggerCharacters? string[]
+---List of characters that re-trigger signature help.
+---
+---These trigger characters are only active when signature help is already showing. All trigger characters
+---are also counted as re-trigger characters.
+---
+---@since 3.15.0
+---@field retriggerCharacters? string[]
+
+---Server Capabilities for a {@link DefinitionRequest}.
+---@class lsp.DefinitionOptions
+
+---Value-object that contains additional information when
+---requesting references.
+---@class lsp.ReferenceContext
+---Include the declaration of the current symbol.
+---@field includeDeclaration boolean
+
+---Reference options.
+---@class lsp.ReferenceOptions
+
+---Provider options for a {@link DocumentHighlightRequest}.
+---@class lsp.DocumentHighlightOptions
+
+---A base for all symbol information.
+---@class lsp.BaseSymbolInformation
+---The name of this symbol.
+---@field name string
+---The kind of this symbol.
+---@field kind lsp.SymbolKind
+---Tags for this symbol.
+---
+---@since 3.16.0
+---@field tags? lsp.SymbolTag[]
+---The name of the symbol containing this symbol. This information is for
+---user interface purposes (e.g. to render a qualifier in the user interface
+---if necessary). It can't be used to re-infer a hierarchy for the document
+---symbols.
+---@field containerName? string
+
+---Provider options for a {@link DocumentSymbolRequest}.
+---@class lsp.DocumentSymbolOptions
+---A human-readable string that is shown when multiple outlines trees
+---are shown for the same document.
+---
+---@since 3.16.0
+---@field label? string
+
+---Contains additional diagnostic information about the context in which
+---a {@link CodeActionProvider.provideCodeActions code action} is run.
+---@class lsp.CodeActionContext
+---An array of diagnostics known on the client side overlapping the range provided to the
+---`textDocument/codeAction` request. They are provided so that the server knows which
+---errors are currently presented to the user for the given range. There is no guarantee
+---that these accurately reflect the error state of the resource. The primary parameter
+---to compute code actions is the provided range.
+---@field diagnostics lsp.Diagnostic[]
+---Requested kind of actions to return.
+---
+---Actions not of this kind are filtered out by the client before being shown. So servers
+---can omit computing them.
+---@field only? lsp.CodeActionKind[]
+---The reason why code actions were requested.
+---
+---@since 3.17.0
+---@field triggerKind? lsp.CodeActionTriggerKind
+
+---Provider options for a {@link CodeActionRequest}.
+---@class lsp.CodeActionOptions
+---CodeActionKinds that this server may return.
+---
+---The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server
+---may list out every specific kind they provide.
+---@field codeActionKinds? lsp.CodeActionKind[]
+---The server provides support to resolve additional
+---information for a code action.
+---
+---@since 3.16.0
+---@field resolveProvider? boolean
+
+---Server capabilities for a {@link WorkspaceSymbolRequest}.
+---@class lsp.WorkspaceSymbolOptions
+---The server provides support to resolve additional
+---information for a workspace symbol.
+---
+---@since 3.17.0
+---@field resolveProvider? boolean
+
+---Code Lens provider options of a {@link CodeLensRequest}.
+---@class lsp.CodeLensOptions
+---Code lens has a resolve provider as well.
+---@field resolveProvider? boolean
+
+---Provider options for a {@link DocumentLinkRequest}.
+---@class lsp.DocumentLinkOptions
+---Document links have a resolve provider as well.
+---@field resolveProvider? boolean
+
+---Value-object describing what options formatting should use.
+---@class lsp.FormattingOptions
+---Size of a tab in spaces.
+---@field tabSize uinteger
+---Prefer spaces over tabs.
+---@field insertSpaces boolean
+---Trim trailing whitespace on a line.
+---
+---@since 3.15.0
+---@field trimTrailingWhitespace? boolean
+---Insert a newline character at the end of the file if one does not exist.
+---
+---@since 3.15.0
+---@field insertFinalNewline? boolean
+---Trim all newlines after the final newline at the end of the file.
+---
+---@since 3.15.0
+---@field trimFinalNewlines? boolean
+
+---Provider options for a {@link DocumentFormattingRequest}.
+---@class lsp.DocumentFormattingOptions
+
+---Provider options for a {@link DocumentRangeFormattingRequest}.
+---@class lsp.DocumentRangeFormattingOptions
+
+---Provider options for a {@link DocumentOnTypeFormattingRequest}.
+---@class lsp.DocumentOnTypeFormattingOptions
+---A character on which formatting should be triggered, like `{`.
+---@field firstTriggerCharacter string
+---More trigger characters.
+---@field moreTriggerCharacter? string[]
+
+---Provider options for a {@link RenameRequest}.
+---@class lsp.RenameOptions
+---Renames should be checked and tested before being executed.
+---
+---@since version 3.12.0
+---@field prepareProvider? boolean
+
+---The server capabilities of a {@link ExecuteCommandRequest}.
+---@class lsp.ExecuteCommandOptions
+---The commands to be executed on the server
+---@field commands string[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensLegend
+---The token types a server uses.
+---@field tokenTypes string[]
+---The token modifiers a server uses.
+---@field tokenModifiers string[]
+
+---A text document identifier to optionally denote a specific version of a text document.
+---@class lsp.OptionalVersionedTextDocumentIdentifier: lsp.TextDocumentIdentifier
+---The version number of this document. If a versioned text document identifier
+---is sent from the server to the client and the file is not open in the editor
+---(the server has not received an open notification before) the server can send
+---`null` to indicate that the version is unknown and the content on disk is the
+---truth (as specified with document content ownership).
+---@field version integer|lsp.null
+
+---A special text edit with an additional change annotation.
+---
+---@since 3.16.0.
+---@class lsp.AnnotatedTextEdit: lsp.TextEdit
+---The actual identifier of the change annotation
+---@field annotationId lsp.ChangeAnnotationIdentifier
+
+---A generic resource operation.
+---@class lsp.ResourceOperation
+---The resource operation kind.
+---@field kind string
+---An optional annotation identifier describing the operation.
+---
+---@since 3.16.0
+---@field annotationId? lsp.ChangeAnnotationIdentifier
+
+---Options to create a file.
+---@class lsp.CreateFileOptions
+---Overwrite existing file. Overwrite wins over `ignoreIfExists`
+---@field overwrite? boolean
+---Ignore if exists.
+---@field ignoreIfExists? boolean
+
+---Rename file options
+---@class lsp.RenameFileOptions
+---Overwrite target if existing. Overwrite wins over `ignoreIfExists`
+---@field overwrite? boolean
+---Ignores if target exists.
+---@field ignoreIfExists? boolean
+
+---Delete file options
+---@class lsp.DeleteFileOptions
+---Delete the content recursively if a folder is denoted.
+---@field recursive? boolean
+---Ignore the operation if the file doesn't exist.
+---@field ignoreIfNotExists? boolean
+
+---A pattern to describe in which file operation requests or notifications
+---the server is interested in receiving.
+---
+---@since 3.16.0
+---@class lsp.FileOperationPattern
+---The glob pattern to match. Glob patterns can have the following syntax:
+---- `*` to match one or more characters in a path segment
+---- `?` to match on one character in a path segment
+---- `**` to match any number of path segments, including none
+---- `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+---@field glob string
+---Whether to match files or folders with this pattern.
+---
+---Matches both if undefined.
+---@field matches? lsp.FileOperationPatternKind
+---Additional options used during matching.
+---@field options? lsp.FileOperationPatternOptions
+
+---A full document diagnostic report for a workspace diagnostic result.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceFullDocumentDiagnosticReport: lsp.FullDocumentDiagnosticReport
+---The URI for which diagnostic information is reported.
+---@field uri lsp.DocumentUri
+---The version number for which the diagnostics are reported.
+---If the document is not marked as open `null` can be provided.
+---@field version integer|lsp.null
+
+---An unchanged document diagnostic report for a workspace diagnostic result.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceUnchangedDocumentDiagnosticReport: lsp.UnchangedDocumentDiagnosticReport
+---The URI for which diagnostic information is reported.
+---@field uri lsp.DocumentUri
+---The version number for which the diagnostics are reported.
+---If the document is not marked as open `null` can be provided.
+---@field version integer|lsp.null
+
+---A notebook cell.
+---
+---A cell's document URI must be unique across ALL notebook
+---cells and can therefore be used to uniquely identify a
+---notebook cell or the cell's text document.
+---
+---@since 3.17.0
+---@class lsp.NotebookCell
+---The cell's kind
+---@field kind lsp.NotebookCellKind
+---The URI of the cell's text document
+---content.
+---@field document lsp.DocumentUri
+---Additional metadata stored with the cell.
+---
+---Note: should always be an object literal (e.g. LSPObject)
+---@field metadata? lsp.LSPObject
+---Additional execution summary information
+---if supported by the client.
+---@field executionSummary? lsp.ExecutionSummary
+
+---A change describing how to move a `NotebookCell`
+---array from state S to S'.
+---
+---@since 3.17.0
+---@class lsp.NotebookCellArrayChange
+---The start oftest of the cell that changed.
+---@field start uinteger
+---The deleted cells
+---@field deleteCount uinteger
+---The new cells, if any
+---@field cells? lsp.NotebookCell[]
+
+---Describes the currently selected completion item.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.SelectedCompletionInfo
+---The range that will be replaced if this completion item is accepted.
+---@field range lsp.Range
+---The text the range will be replaced with if this completion is accepted.
+---@field text string
+
+---Defines the capabilities provided by the client.
+---@class lsp.ClientCapabilities
+---Workspace specific client capabilities.
+---@field workspace? lsp.WorkspaceClientCapabilities
+---Text document specific client capabilities.
+---@field textDocument? lsp.TextDocumentClientCapabilities
+---Capabilities specific to the notebook document support.
+---
+---@since 3.17.0
+---@field notebookDocument? lsp.NotebookDocumentClientCapabilities
+---Window specific client capabilities.
+---@field window? lsp.WindowClientCapabilities
+---General client capabilities.
+---
+---@since 3.16.0
+---@field general? lsp.GeneralClientCapabilities
+---Experimental client capabilities.
+---@field experimental? lsp.LSPAny
+
+---@class lsp.TextDocumentSyncOptions
+---Open and close notifications are sent to the server. If omitted open close notification should not
+---be sent.
+---@field openClose? boolean
+---Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
+---and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
+---@field change? lsp.TextDocumentSyncKind
+---If present will save notifications are sent to the server. If omitted the notification should not be
+---sent.
+---@field willSave? boolean
+---If present will save wait until requests are sent to the server. If omitted the request should not be
+---sent.
+---@field willSaveWaitUntil? boolean
+---If present save notifications are sent to the server. If omitted the notification should not be
+---sent.
+---@field save? boolean|lsp.SaveOptions
+
+---Options specific to a notebook plus its cells
+---to be synced to the server.
+---
+---If a selector provides a notebook document
+---filter but no cell selector all cells of a
+---matching notebook document will be synced.
+---
+---If a selector provides no notebook document
+---filter but only a cell selector all notebook
+---document that contain at least one matching
+---cell will be synced.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentSyncOptions
+---The notebooks to be synced
+---@field notebookSelector anonym15|anonym17[]
+---Whether save notification should be forwarded to
+---the server. Will only be honored if mode === `notebook`.
+---@field save? boolean
+
+---Registration options specific to a notebook.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentSyncRegistrationOptions: lsp.NotebookDocumentSyncOptions, lsp.StaticRegistrationOptions
+
+---@class lsp.WorkspaceFoldersServerCapabilities
+---The server has support for workspace folders
+---@field supported? boolean
+---Whether the server wants to receive workspace folder
+---change notifications.
+---
+---If a string is provided the string is treated as an ID
+---under which the notification is registered on the client
+---side. The ID can be used to unregister for these events
+---using the `client/unregisterCapability` request.
+---@field changeNotifications? string|boolean
+
+---Options for notifications/requests for user operations on files.
+---
+---@since 3.16.0
+---@class lsp.FileOperationOptions
+---The server is interested in receiving didCreateFiles notifications.
+---@field didCreate? lsp.FileOperationRegistrationOptions
+---The server is interested in receiving willCreateFiles requests.
+---@field willCreate? lsp.FileOperationRegistrationOptions
+---The server is interested in receiving didRenameFiles notifications.
+---@field didRename? lsp.FileOperationRegistrationOptions
+---The server is interested in receiving willRenameFiles requests.
+---@field willRename? lsp.FileOperationRegistrationOptions
+---The server is interested in receiving didDeleteFiles file notifications.
+---@field didDelete? lsp.FileOperationRegistrationOptions
+---The server is interested in receiving willDeleteFiles file requests.
+---@field willDelete? lsp.FileOperationRegistrationOptions
+
+---Structure to capture a description for an error code.
+---
+---@since 3.16.0
+---@class lsp.CodeDescription
+---An URI to open with more information about the diagnostic error.
+---@field href lsp.URI
+
+---Represents a related message and source code location for a diagnostic. This should be
+---used to point to code locations that cause or related to a diagnostics, e.g when duplicating
+---a symbol in a scope.
+---@class lsp.DiagnosticRelatedInformation
+---The location of this related diagnostic information.
+---@field location lsp.Location
+---The message of this related diagnostic information.
+---@field message string
+
+---Represents a parameter of a callable-signature. A parameter can
+---have a label and a doc-comment.
+---@class lsp.ParameterInformation
+---The label of this parameter information.
+---
+---Either a string or an inclusive start and exclusive end offsets within its containing
+---signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
+---string representation as `Position` and `Range` does.
+---
+---*Note*: a label of type string should be a substring of its containing signature label.
+---Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
+---@field label string|{ [1]: uinteger, [2]: uinteger }
+---The human-readable doc-comment of this parameter. Will be shown
+---in the UI but can be omitted.
+---@field documentation? string|lsp.MarkupContent
+
+---A notebook cell text document filter denotes a cell text
+---document by different properties.
+---
+---@since 3.17.0
+---@class lsp.NotebookCellTextDocumentFilter
+---A filter that matches against the notebook
+---containing the notebook cell. If a string
+---value is provided it matches against the
+---notebook type. '*' matches every notebook.
+---@field notebook string|lsp.NotebookDocumentFilter
+---A language id like `python`.
+---
+---Will be matched against the language id of the
+---notebook cell document. '*' matches every language.
+---@field language? string
+
+---Matching options for the file operation pattern.
+---
+---@since 3.16.0
+---@class lsp.FileOperationPatternOptions
+---The pattern should be matched ignoring casing.
+---@field ignoreCase? boolean
+
+---@class lsp.ExecutionSummary
+---A strict monotonically increasing value
+---indicating the execution order of a cell
+---inside a notebook.
+---@field executionOrder uinteger
+---Whether the execution was successful or
+---not if known by the client.
+---@field success? boolean
+
+---Workspace specific client capabilities.
+---@class lsp.WorkspaceClientCapabilities
+---The client supports applying batch edits
+---to the workspace by supporting the request
+---'workspace/applyEdit'
+---@field applyEdit? boolean
+---Capabilities specific to `WorkspaceEdit`s.
+---@field workspaceEdit? lsp.WorkspaceEditClientCapabilities
+---Capabilities specific to the `workspace/didChangeConfiguration` notification.
+---@field didChangeConfiguration? lsp.DidChangeConfigurationClientCapabilities
+---Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
+---@field didChangeWatchedFiles? lsp.DidChangeWatchedFilesClientCapabilities
+---Capabilities specific to the `workspace/symbol` request.
+---@field symbol? lsp.WorkspaceSymbolClientCapabilities
+---Capabilities specific to the `workspace/executeCommand` request.
+---@field executeCommand? lsp.ExecuteCommandClientCapabilities
+---The client has support for workspace folders.
+---
+---@since 3.6.0
+---@field workspaceFolders? boolean
+---The client supports `workspace/configuration` requests.
+---
+---@since 3.6.0
+---@field configuration? boolean
+---Capabilities specific to the semantic token requests scoped to the
+---workspace.
+---
+---@since 3.16.0.
+---@field semanticTokens? lsp.SemanticTokensWorkspaceClientCapabilities
+---Capabilities specific to the code lens requests scoped to the
+---workspace.
+---
+---@since 3.16.0.
+---@field codeLens? lsp.CodeLensWorkspaceClientCapabilities
+---The client has support for file notifications/requests for user operations on files.
+---
+---Since 3.16.0
+---@field fileOperations? lsp.FileOperationClientCapabilities
+---Capabilities specific to the inline values requests scoped to the
+---workspace.
+---
+---@since 3.17.0.
+---@field inlineValue? lsp.InlineValueWorkspaceClientCapabilities
+---Capabilities specific to the inlay hint requests scoped to the
+---workspace.
+---
+---@since 3.17.0.
+---@field inlayHint? lsp.InlayHintWorkspaceClientCapabilities
+---Capabilities specific to the diagnostic requests scoped to the
+---workspace.
+---
+---@since 3.17.0.
+---@field diagnostics? lsp.DiagnosticWorkspaceClientCapabilities
+
+---Text document specific client capabilities.
+---@class lsp.TextDocumentClientCapabilities
+---Defines which synchronization capabilities the client supports.
+---@field synchronization? lsp.TextDocumentSyncClientCapabilities
+---Capabilities specific to the `textDocument/completion` request.
+---@field completion? lsp.CompletionClientCapabilities
+---Capabilities specific to the `textDocument/hover` request.
+---@field hover? lsp.HoverClientCapabilities
+---Capabilities specific to the `textDocument/signatureHelp` request.
+---@field signatureHelp? lsp.SignatureHelpClientCapabilities
+---Capabilities specific to the `textDocument/declaration` request.
+---
+---@since 3.14.0
+---@field declaration? lsp.DeclarationClientCapabilities
+---Capabilities specific to the `textDocument/definition` request.
+---@field definition? lsp.DefinitionClientCapabilities
+---Capabilities specific to the `textDocument/typeDefinition` request.
+---
+---@since 3.6.0
+---@field typeDefinition? lsp.TypeDefinitionClientCapabilities
+---Capabilities specific to the `textDocument/implementation` request.
+---
+---@since 3.6.0
+---@field implementation? lsp.ImplementationClientCapabilities
+---Capabilities specific to the `textDocument/references` request.
+---@field references? lsp.ReferenceClientCapabilities
+---Capabilities specific to the `textDocument/documentHighlight` request.
+---@field documentHighlight? lsp.DocumentHighlightClientCapabilities
+---Capabilities specific to the `textDocument/documentSymbol` request.
+---@field documentSymbol? lsp.DocumentSymbolClientCapabilities
+---Capabilities specific to the `textDocument/codeAction` request.
+---@field codeAction? lsp.CodeActionClientCapabilities
+---Capabilities specific to the `textDocument/codeLens` request.
+---@field codeLens? lsp.CodeLensClientCapabilities
+---Capabilities specific to the `textDocument/documentLink` request.
+---@field documentLink? lsp.DocumentLinkClientCapabilities
+---Capabilities specific to the `textDocument/documentColor` and the
+---`textDocument/colorPresentation` request.
+---
+---@since 3.6.0
+---@field colorProvider? lsp.DocumentColorClientCapabilities
+---Capabilities specific to the `textDocument/formatting` request.
+---@field formatting? lsp.DocumentFormattingClientCapabilities
+---Capabilities specific to the `textDocument/rangeFormatting` request.
+---@field rangeFormatting? lsp.DocumentRangeFormattingClientCapabilities
+---Capabilities specific to the `textDocument/onTypeFormatting` request.
+---@field onTypeFormatting? lsp.DocumentOnTypeFormattingClientCapabilities
+---Capabilities specific to the `textDocument/rename` request.
+---@field rename? lsp.RenameClientCapabilities
+---Capabilities specific to the `textDocument/foldingRange` request.
+---
+---@since 3.10.0
+---@field foldingRange? lsp.FoldingRangeClientCapabilities
+---Capabilities specific to the `textDocument/selectionRange` request.
+---
+---@since 3.15.0
+---@field selectionRange? lsp.SelectionRangeClientCapabilities
+---Capabilities specific to the `textDocument/publishDiagnostics` notification.
+---@field publishDiagnostics? lsp.PublishDiagnosticsClientCapabilities
+---Capabilities specific to the various call hierarchy requests.
+---
+---@since 3.16.0
+---@field callHierarchy? lsp.CallHierarchyClientCapabilities
+---Capabilities specific to the various semantic token request.
+---
+---@since 3.16.0
+---@field semanticTokens? lsp.SemanticTokensClientCapabilities
+---Capabilities specific to the `textDocument/linkedEditingRange` request.
+---
+---@since 3.16.0
+---@field linkedEditingRange? lsp.LinkedEditingRangeClientCapabilities
+---Client capabilities specific to the `textDocument/moniker` request.
+---
+---@since 3.16.0
+---@field moniker? lsp.MonikerClientCapabilities
+---Capabilities specific to the various type hierarchy requests.
+---
+---@since 3.17.0
+---@field typeHierarchy? lsp.TypeHierarchyClientCapabilities
+---Capabilities specific to the `textDocument/inlineValue` request.
+---
+---@since 3.17.0
+---@field inlineValue? lsp.InlineValueClientCapabilities
+---Capabilities specific to the `textDocument/inlayHint` request.
+---
+---@since 3.17.0
+---@field inlayHint? lsp.InlayHintClientCapabilities
+---Capabilities specific to the diagnostic pull model.
+---
+---@since 3.17.0
+---@field diagnostic? lsp.DiagnosticClientCapabilities
+---Client capabilities specific to inline completions.
+---
+---@since 3.18.0
+---@proposed
+---@field inlineCompletion? lsp.InlineCompletionClientCapabilities
+
+---Capabilities specific to the notebook document support.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentClientCapabilities
+---Capabilities specific to notebook document synchronization
+---
+---@since 3.17.0
+---@field synchronization lsp.NotebookDocumentSyncClientCapabilities
+
+---@class lsp.WindowClientCapabilities
+---It indicates whether the client supports server initiated
+---progress using the `window/workDoneProgress/create` request.
+---
+---The capability also controls Whether client supports handling
+---of progress notifications. If set servers are allowed to report a
+---`workDoneProgress` property in the request specific server
+---capabilities.
+---
+---@since 3.15.0
+---@field workDoneProgress? boolean
+---Capabilities specific to the showMessage request.
+---
+---@since 3.16.0
+---@field showMessage? lsp.ShowMessageRequestClientCapabilities
+---Capabilities specific to the showDocument request.
+---
+---@since 3.16.0
+---@field showDocument? lsp.ShowDocumentClientCapabilities
+
+---General client capabilities.
+---
+---@since 3.16.0
+---@class lsp.GeneralClientCapabilities
+---Client capability that signals how the client
+---handles stale requests (e.g. a request
+---for which the client will not process the response
+---anymore since the information is outdated).
+---
+---@since 3.17.0
+---@field staleRequestSupport? anonym18
+---Client capabilities specific to regular expressions.
+---
+---@since 3.16.0
+---@field regularExpressions? lsp.RegularExpressionsClientCapabilities
+---Client capabilities specific to the client's markdown parser.
+---
+---@since 3.16.0
+---@field markdown? lsp.MarkdownClientCapabilities
+---The position encodings supported by the client. Client and server
+---have to agree on the same position encoding to ensure that offsets
+---(e.g. character position in a line) are interpreted the same on both
+---sides.
+---
+---To keep the protocol backwards compatible the following applies: if
+---the value 'utf-16' is missing from the array of position encodings
+---servers can assume that the client supports UTF-16. UTF-16 is
+---therefore a mandatory encoding.
+---
+---If omitted it defaults to ['utf-16'].
+---
+---Implementation considerations: since the conversion from one encoding
+---into another requires the content of the file / line the conversion
+---is best done where the file is read which is usually on the server
+---side.
+---
+---@since 3.17.0
+---@field positionEncodings? lsp.PositionEncodingKind[]
+
+---A relative pattern is a helper to construct glob patterns that are matched
+---relatively to a base URI. The common value for a `baseUri` is a workspace
+---folder root, but it can be another absolute URI as well.
+---
+---@since 3.17.0
+---@class lsp.RelativePattern
+---A workspace folder or a base URI to which this pattern will be matched
+---against relatively.
+---@field baseUri lsp.WorkspaceFolder|lsp.URI
+---The actual glob pattern;
+---@field pattern lsp.Pattern
+
+---@class lsp.WorkspaceEditClientCapabilities
+---The client supports versioned document changes in `WorkspaceEdit`s
+---@field documentChanges? boolean
+---The resource operations the client supports. Clients should at least
+---support 'create', 'rename' and 'delete' files and folders.
+---
+---@since 3.13.0
+---@field resourceOperations? lsp.ResourceOperationKind[]
+---The failure handling strategy of a client if applying the workspace edit
+---fails.
+---
+---@since 3.13.0
+---@field failureHandling? lsp.FailureHandlingKind
+---Whether the client normalizes line endings to the client specific
+---setting.
+---If set to `true` the client will normalize line ending characters
+---in a workspace edit to the client-specified new line
+---character.
+---
+---@since 3.16.0
+---@field normalizesLineEndings? boolean
+---Whether the client in general supports change annotations on text edits,
+---create file, rename file and delete file changes.
+---
+---@since 3.16.0
+---@field changeAnnotationSupport? anonym19
+
+---@class lsp.DidChangeConfigurationClientCapabilities
+---Did change configuration notification supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---@class lsp.DidChangeWatchedFilesClientCapabilities
+---Did change watched files notification supports dynamic registration. Please note
+---that the current protocol doesn't support static configuration for file changes
+---from the server side.
+---@field dynamicRegistration? boolean
+---Whether the client has support for {@link  RelativePattern relative pattern}
+---or not.
+---
+---@since 3.17.0
+---@field relativePatternSupport? boolean
+
+---Client capabilities for a {@link WorkspaceSymbolRequest}.
+---@class lsp.WorkspaceSymbolClientCapabilities
+---Symbol request supports dynamic registration.
+---@field dynamicRegistration? boolean
+---Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
+---@field symbolKind? anonym20
+---The client supports tags on `SymbolInformation`.
+---Clients supporting tags have to handle unknown tags gracefully.
+---
+---@since 3.16.0
+---@field tagSupport? anonym21
+---The client support partial workspace symbols. The client will send the
+---request `workspaceSymbol/resolve` to the server to resolve additional
+---properties.
+---
+---@since 3.17.0
+---@field resolveSupport? anonym22
+
+---The client capabilities of a {@link ExecuteCommandRequest}.
+---@class lsp.ExecuteCommandClientCapabilities
+---Execute command supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---@since 3.16.0
+---@class lsp.SemanticTokensWorkspaceClientCapabilities
+---Whether the client implementation supports a refresh request sent from
+---the server to the client.
+---
+---Note that this event is global and will force the client to refresh all
+---semantic tokens currently shown. It should be used with absolute care
+---and is useful for situation where a server for example detects a project
+---wide change that requires such a calculation.
+---@field refreshSupport? boolean
+
+---@since 3.16.0
+---@class lsp.CodeLensWorkspaceClientCapabilities
+---Whether the client implementation supports a refresh request sent from the
+---server to the client.
+---
+---Note that this event is global and will force the client to refresh all
+---code lenses currently shown. It should be used with absolute care and is
+---useful for situation where a server for example detect a project wide
+---change that requires such a calculation.
+---@field refreshSupport? boolean
+
+---Capabilities relating to events from file operations by the user in the client.
+---
+---These events do not come from the file system, they come from user operations
+---like renaming a file in the UI.
+---
+---@since 3.16.0
+---@class lsp.FileOperationClientCapabilities
+---Whether the client supports dynamic registration for file requests/notifications.
+---@field dynamicRegistration? boolean
+---The client has support for sending didCreateFiles notifications.
+---@field didCreate? boolean
+---The client has support for sending willCreateFiles requests.
+---@field willCreate? boolean
+---The client has support for sending didRenameFiles notifications.
+---@field didRename? boolean
+---The client has support for sending willRenameFiles requests.
+---@field willRename? boolean
+---The client has support for sending didDeleteFiles notifications.
+---@field didDelete? boolean
+---The client has support for sending willDeleteFiles requests.
+---@field willDelete? boolean
+
+---Client workspace capabilities specific to inline values.
+---
+---@since 3.17.0
+---@class lsp.InlineValueWorkspaceClientCapabilities
+---Whether the client implementation supports a refresh request sent from the
+---server to the client.
+---
+---Note that this event is global and will force the client to refresh all
+---inline values currently shown. It should be used with absolute care and is
+---useful for situation where a server for example detects a project wide
+---change that requires such a calculation.
+---@field refreshSupport? boolean
+
+---Client workspace capabilities specific to inlay hints.
+---
+---@since 3.17.0
+---@class lsp.InlayHintWorkspaceClientCapabilities
+---Whether the client implementation supports a refresh request sent from
+---the server to the client.
+---
+---Note that this event is global and will force the client to refresh all
+---inlay hints currently shown. It should be used with absolute care and
+---is useful for situation where a server for example detects a project wide
+---change that requires such a calculation.
+---@field refreshSupport? boolean
+
+---Workspace client capabilities specific to diagnostic pull requests.
+---
+---@since 3.17.0
+---@class lsp.DiagnosticWorkspaceClientCapabilities
+---Whether the client implementation supports a refresh request sent from
+---the server to the client.
+---
+---Note that this event is global and will force the client to refresh all
+---pulled diagnostics currently shown. It should be used with absolute care and
+---is useful for situation where a server for example detects a project wide
+---change that requires such a calculation.
+---@field refreshSupport? boolean
+
+---@class lsp.TextDocumentSyncClientCapabilities
+---Whether text document synchronization supports dynamic registration.
+---@field dynamicRegistration? boolean
+---The client supports sending will save notifications.
+---@field willSave? boolean
+---The client supports sending a will save request and
+---waits for a response providing text edits which will
+---be applied to the document before it is saved.
+---@field willSaveWaitUntil? boolean
+---The client supports did save notifications.
+---@field didSave? boolean
+
+---Completion client capabilities
+---@class lsp.CompletionClientCapabilities
+---Whether completion supports dynamic registration.
+---@field dynamicRegistration? boolean
+---The client supports the following `CompletionItem` specific
+---capabilities.
+---@field completionItem? anonym26
+---@field completionItemKind? anonym27
+---Defines how the client handles whitespace and indentation
+---when accepting a completion item that uses multi line
+---text in either `insertText` or `textEdit`.
+---
+---@since 3.17.0
+---@field insertTextMode? lsp.InsertTextMode
+---The client supports to send additional context information for a
+---`textDocument/completion` request.
+---@field contextSupport? boolean
+---The client supports the following `CompletionList` specific
+---capabilities.
+---
+---@since 3.17.0
+---@field completionList? anonym28
+
+---@class lsp.HoverClientCapabilities
+---Whether hover supports dynamic registration.
+---@field dynamicRegistration? boolean
+---Client supports the following content formats for the content
+---property. The order describes the preferred format of the client.
+---@field contentFormat? lsp.MarkupKind[]
+
+---Client Capabilities for a {@link SignatureHelpRequest}.
+---@class lsp.SignatureHelpClientCapabilities
+---Whether signature help supports dynamic registration.
+---@field dynamicRegistration? boolean
+---The client supports the following `SignatureInformation`
+---specific properties.
+---@field signatureInformation? anonym30
+---The client supports to send additional context information for a
+---`textDocument/signatureHelp` request. A client that opts into
+---contextSupport will also support the `retriggerCharacters` on
+---`SignatureHelpOptions`.
+---
+---@since 3.15.0
+---@field contextSupport? boolean
+
+---@since 3.14.0
+---@class lsp.DeclarationClientCapabilities
+---Whether declaration supports dynamic registration. If this is set to `true`
+---the client supports the new `DeclarationRegistrationOptions` return value
+---for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---The client supports additional metadata in the form of declaration links.
+---@field linkSupport? boolean
+
+---Client Capabilities for a {@link DefinitionRequest}.
+---@class lsp.DefinitionClientCapabilities
+---Whether definition supports dynamic registration.
+---@field dynamicRegistration? boolean
+---The client supports additional metadata in the form of definition links.
+---
+---@since 3.14.0
+---@field linkSupport? boolean
+
+---Since 3.6.0
+---@class lsp.TypeDefinitionClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `TypeDefinitionRegistrationOptions` return value
+---for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---The client supports additional metadata in the form of definition links.
+---
+---Since 3.14.0
+---@field linkSupport? boolean
+
+---@since 3.6.0
+---@class lsp.ImplementationClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `ImplementationRegistrationOptions` return value
+---for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---The client supports additional metadata in the form of definition links.
+---
+---@since 3.14.0
+---@field linkSupport? boolean
+
+---Client Capabilities for a {@link ReferencesRequest}.
+---@class lsp.ReferenceClientCapabilities
+---Whether references supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---Client Capabilities for a {@link DocumentHighlightRequest}.
+---@class lsp.DocumentHighlightClientCapabilities
+---Whether document highlight supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---Client Capabilities for a {@link DocumentSymbolRequest}.
+---@class lsp.DocumentSymbolClientCapabilities
+---Whether document symbol supports dynamic registration.
+---@field dynamicRegistration? boolean
+---Specific capabilities for the `SymbolKind` in the
+---`textDocument/documentSymbol` request.
+---@field symbolKind? anonym31
+---The client supports hierarchical document symbols.
+---@field hierarchicalDocumentSymbolSupport? boolean
+---The client supports tags on `SymbolInformation`. Tags are supported on
+---`DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true.
+---Clients supporting tags have to handle unknown tags gracefully.
+---
+---@since 3.16.0
+---@field tagSupport? anonym32
+---The client supports an additional label presented in the UI when
+---registering a document symbol provider.
+---
+---@since 3.16.0
+---@field labelSupport? boolean
+
+---The Client Capabilities of a {@link CodeActionRequest}.
+---@class lsp.CodeActionClientCapabilities
+---Whether code action supports dynamic registration.
+---@field dynamicRegistration? boolean
+---The client support code action literals of type `CodeAction` as a valid
+---response of the `textDocument/codeAction` request. If the property is not
+---set the request can only return `Command` literals.
+---
+---@since 3.8.0
+---@field codeActionLiteralSupport? anonym34
+---Whether code action supports the `isPreferred` property.
+---
+---@since 3.15.0
+---@field isPreferredSupport? boolean
+---Whether code action supports the `disabled` property.
+---
+---@since 3.16.0
+---@field disabledSupport? boolean
+---Whether code action supports the `data` property which is
+---preserved between a `textDocument/codeAction` and a
+---`codeAction/resolve` request.
+---
+---@since 3.16.0
+---@field dataSupport? boolean
+---Whether the client supports resolving additional code action
+---properties via a separate `codeAction/resolve` request.
+---
+---@since 3.16.0
+---@field resolveSupport? anonym35
+---Whether the client honors the change annotations in
+---text edits and resource operations returned via the
+---`CodeAction#edit` property by for example presenting
+---the workspace edit in the user interface and asking
+---for confirmation.
+---
+---@since 3.16.0
+---@field honorsChangeAnnotations? boolean
+
+---The client capabilities  of a {@link CodeLensRequest}.
+---@class lsp.CodeLensClientCapabilities
+---Whether code lens supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---The client capabilities of a {@link DocumentLinkRequest}.
+---@class lsp.DocumentLinkClientCapabilities
+---Whether document link supports dynamic registration.
+---@field dynamicRegistration? boolean
+---Whether the client supports the `tooltip` property on `DocumentLink`.
+---
+---@since 3.15.0
+---@field tooltipSupport? boolean
+
+---@class lsp.DocumentColorClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `DocumentColorRegistrationOptions` return value
+---for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+
+---Client capabilities of a {@link DocumentFormattingRequest}.
+---@class lsp.DocumentFormattingClientCapabilities
+---Whether formatting supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---Client capabilities of a {@link DocumentRangeFormattingRequest}.
+---@class lsp.DocumentRangeFormattingClientCapabilities
+---Whether range formatting supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---Client capabilities of a {@link DocumentOnTypeFormattingRequest}.
+---@class lsp.DocumentOnTypeFormattingClientCapabilities
+---Whether on type formatting supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---@class lsp.RenameClientCapabilities
+---Whether rename supports dynamic registration.
+---@field dynamicRegistration? boolean
+---Client supports testing for validity of rename operations
+---before execution.
+---
+---@since 3.12.0
+---@field prepareSupport? boolean
+---Client supports the default behavior result.
+---
+---The value indicates the default behavior used by the
+---client.
+---
+---@since 3.16.0
+---@field prepareSupportDefaultBehavior? lsp.PrepareSupportDefaultBehavior
+---Whether the client honors the change annotations in
+---text edits and resource operations returned via the
+---rename request's workspace edit by for example presenting
+---the workspace edit in the user interface and asking
+---for confirmation.
+---
+---@since 3.16.0
+---@field honorsChangeAnnotations? boolean
+
+---@class lsp.FoldingRangeClientCapabilities
+---Whether implementation supports dynamic registration for folding range
+---providers. If this is set to `true` the client supports the new
+---`FoldingRangeRegistrationOptions` return value for the corresponding
+---server capability as well.
+---@field dynamicRegistration? boolean
+---The maximum number of folding ranges that the client prefers to receive
+---per document. The value serves as a hint, servers are free to follow the
+---limit.
+---@field rangeLimit? uinteger
+---If set, the client signals that it only supports folding complete lines.
+---If set, client will ignore specified `startCharacter` and `endCharacter`
+---properties in a FoldingRange.
+---@field lineFoldingOnly? boolean
+---Specific options for the folding range kind.
+---
+---@since 3.17.0
+---@field foldingRangeKind? anonym36
+---Specific options for the folding range.
+---
+---@since 3.17.0
+---@field foldingRange? anonym37
+
+---@class lsp.SelectionRangeClientCapabilities
+---Whether implementation supports dynamic registration for selection range providers. If this is set to `true`
+---the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server
+---capability as well.
+---@field dynamicRegistration? boolean
+
+---The publish diagnostic client capabilities.
+---@class lsp.PublishDiagnosticsClientCapabilities
+---Whether the clients accepts diagnostics with related information.
+---@field relatedInformation? boolean
+---Client supports the tag property to provide meta data about a diagnostic.
+---Clients supporting tags have to handle unknown tags gracefully.
+---
+---@since 3.15.0
+---@field tagSupport? anonym38
+---Whether the client interprets the version property of the
+---`textDocument/publishDiagnostics` notification's parameter.
+---
+---@since 3.15.0
+---@field versionSupport? boolean
+---Client supports a codeDescription property
+---
+---@since 3.16.0
+---@field codeDescriptionSupport? boolean
+---Whether code action supports the `data` property which is
+---preserved between a `textDocument/publishDiagnostics` and
+---`textDocument/codeAction` request.
+---
+---@since 3.16.0
+---@field dataSupport? boolean
+
+---@since 3.16.0
+---@class lsp.CallHierarchyClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+
+---@since 3.16.0
+---@class lsp.SemanticTokensClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---Which requests the client supports and might send to the server
+---depending on the server's capability. Please note that clients might not
+---show semantic tokens or degrade some of the user experience if a range
+---or full request is advertised by the client but not provided by the
+---server. If for example the client capability `requests.full` and
+---`request.range` are both set to true but the server only provides a
+---range provider the client might not render a minimap correctly or might
+---even decide to not show any semantic tokens at all.
+---@field requests anonym41
+---The token types that the client supports.
+---@field tokenTypes string[]
+---The token modifiers that the client supports.
+---@field tokenModifiers string[]
+---The token formats the clients supports.
+---@field formats lsp.TokenFormat[]
+---Whether the client supports tokens that can overlap each other.
+---@field overlappingTokenSupport? boolean
+---Whether the client supports tokens that can span multiple lines.
+---@field multilineTokenSupport? boolean
+---Whether the client allows the server to actively cancel a
+---semantic token request, e.g. supports returning
+---LSPErrorCodes.ServerCancelled. If a server does the client
+---needs to retrigger the request.
+---
+---@since 3.17.0
+---@field serverCancelSupport? boolean
+---Whether the client uses semantic tokens to augment existing
+---syntax tokens. If set to `true` client side created syntax
+---tokens and semantic tokens are both used for colorization. If
+---set to `false` the client only uses the returned semantic tokens
+---for colorization.
+---
+---If the value is `undefined` then the client behavior is not
+---specified.
+---
+---@since 3.17.0
+---@field augmentsSyntaxTokens? boolean
+
+---Client capabilities for the linked editing range request.
+---
+---@since 3.16.0
+---@class lsp.LinkedEditingRangeClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+
+---Client capabilities specific to the moniker request.
+---
+---@since 3.16.0
+---@class lsp.MonikerClientCapabilities
+---Whether moniker supports dynamic registration. If this is set to `true`
+---the client supports the new `MonikerRegistrationOptions` return value
+---for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+
+---@since 3.17.0
+---@class lsp.TypeHierarchyClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+
+---Client capabilities specific to inline values.
+---
+---@since 3.17.0
+---@class lsp.InlineValueClientCapabilities
+---Whether implementation supports dynamic registration for inline value providers.
+---@field dynamicRegistration? boolean
+
+---Inlay hint client capabilities.
+---
+---@since 3.17.0
+---@class lsp.InlayHintClientCapabilities
+---Whether inlay hints support dynamic registration.
+---@field dynamicRegistration? boolean
+---Indicates which properties a client can resolve lazily on an inlay
+---hint.
+---@field resolveSupport? anonym42
+
+---Client capabilities specific to diagnostic pull requests.
+---
+---@since 3.17.0
+---@class lsp.DiagnosticClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---Whether the clients supports related documents for document diagnostic pulls.
+---@field relatedDocumentSupport? boolean
+
+---Client capabilities specific to inline completions.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.InlineCompletionClientCapabilities
+---Whether implementation supports dynamic registration for inline completion providers.
+---@field dynamicRegistration? boolean
+
+---Notebook specific client capabilities.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentSyncClientCapabilities
+---Whether implementation supports dynamic registration. If this is
+---set to `true` the client supports the new
+---`(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---The client supports sending execution summary data per cell.
+---@field executionSummarySupport? boolean
+
+---Show message request client capabilities
+---@class lsp.ShowMessageRequestClientCapabilities
+---Capabilities specific to the `MessageActionItem` type.
+---@field messageActionItem? anonym43
+
+---Client capabilities for the showDocument request.
+---
+---@since 3.16.0
+---@class lsp.ShowDocumentClientCapabilities
+---The client has support for the showDocument
+---request.
+---@field support boolean
+
+---Client capabilities specific to regular expressions.
+---
+---@since 3.16.0
+---@class lsp.RegularExpressionsClientCapabilities
+---The engine's name.
+---@field engine string
+---The engine's version.
+---@field version? string
+
+---Client capabilities specific to the used markdown parser.
+---
+---@since 3.16.0
+---@class lsp.MarkdownClientCapabilities
+---The name of the parser.
+---@field parser string
+---The version of the parser.
+---@field version? string
+---A list of HTML tags that the client allows / supports in
+---Markdown.
+---
+---@since 3.17.0
+---@field allowedTags? string[]
+
+---A set of predefined token types. This set is not fixed
+---an clients can specify additional token types via the
+---corresponding client capabilities.
+---
+---@since 3.16.0
+---@alias lsp.SemanticTokenTypes
+---| "namespace" # namespace
+---| "type" # type
+---| "class" # class
+---| "enum" # enum
+---| "interface" # interface
+---| "struct" # struct
+---| "typeParameter" # typeParameter
+---| "parameter" # parameter
+---| "variable" # variable
+---| "property" # property
+---| "enumMember" # enumMember
+---| "event" # event
+---| "function" # function
+---| "method" # method
+---| "macro" # macro
+---| "keyword" # keyword
+---| "modifier" # modifier
+---| "comment" # comment
+---| "string" # string
+---| "number" # number
+---| "regexp" # regexp
+---| "operator" # operator
+---| "decorator" # decorator
+
+---A set of predefined token modifiers. This set is not fixed
+---an clients can specify additional token types via the
+---corresponding client capabilities.
+---
+---@since 3.16.0
+---@alias lsp.SemanticTokenModifiers
+---| "declaration" # declaration
+---| "definition" # definition
+---| "readonly" # readonly
+---| "static" # static
+---| "deprecated" # deprecated
+---| "abstract" # abstract
+---| "async" # async
+---| "modification" # modification
+---| "documentation" # documentation
+---| "defaultLibrary" # defaultLibrary
+
+---The document diagnostic report kinds.
+---
+---@since 3.17.0
+---@alias lsp.DocumentDiagnosticReportKind
+---| "full" # Full
+---| "unchanged" # Unchanged
+
+---Predefined error codes.
+---@alias lsp.ErrorCodes
+---| -32700 # ParseError
+---| -32600 # InvalidRequest
+---| -32601 # MethodNotFound
+---| -32602 # InvalidParams
+---| -32603 # InternalError
+---| -32002 # ServerNotInitialized
+---| -32001 # UnknownErrorCode
+
+---@alias lsp.LSPErrorCodes
+---| -32803 # RequestFailed
+---| -32802 # ServerCancelled
+---| -32801 # ContentModified
+---| -32800 # RequestCancelled
+
+---A set of predefined range kinds.
+---@alias lsp.FoldingRangeKind
+---| "comment" # Comment
+---| "imports" # Imports
+---| "region" # Region
+
+---A symbol kind.
+---@alias lsp.SymbolKind
+---| 1 # File
+---| 2 # Module
+---| 3 # Namespace
+---| 4 # Package
+---| 5 # Class
+---| 6 # Method
+---| 7 # Property
+---| 8 # Field
+---| 9 # Constructor
+---| 10 # Enum
+---| 11 # Interface
+---| 12 # Function
+---| 13 # Variable
+---| 14 # Constant
+---| 15 # String
+---| 16 # Number
+---| 17 # Boolean
+---| 18 # Array
+---| 19 # Object
+---| 20 # Key
+---| 21 # Null
+---| 22 # EnumMember
+---| 23 # Struct
+---| 24 # Event
+---| 25 # Operator
+---| 26 # TypeParameter
+
+---Symbol tags are extra annotations that tweak the rendering of a symbol.
+---
+---@since 3.16
+---@alias lsp.SymbolTag
+---| 1 # Deprecated
+
+---Moniker uniqueness level to define scope of the moniker.
+---
+---@since 3.16.0
+---@alias lsp.UniquenessLevel
+---| "document" # document
+---| "project" # project
+---| "group" # group
+---| "scheme" # scheme
+---| "global" # global
+
+---The moniker kind.
+---
+---@since 3.16.0
+---@alias lsp.MonikerKind
+---| "import" # import
+---| "export" # export
+---| "local" # local
+
+---Inlay hint kinds.
+---
+---@since 3.17.0
+---@alias lsp.InlayHintKind
+---| 1 # Type
+---| 2 # Parameter
+
+---The message type
+---@alias lsp.MessageType
+---| 1 # Error
+---| 2 # Warning
+---| 3 # Info
+---| 4 # Log
+
+---Defines how the host (editor) should sync
+---document changes to the language server.
+---@alias lsp.TextDocumentSyncKind
+---| 0 # None
+---| 1 # Full
+---| 2 # Incremental
+
+---Represents reasons why a text document is saved.
+---@alias lsp.TextDocumentSaveReason
+---| 1 # Manual
+---| 2 # AfterDelay
+---| 3 # FocusOut
+
+---The kind of a completion entry.
+---@alias lsp.CompletionItemKind
+---| 1 # Text
+---| 2 # Method
+---| 3 # Function
+---| 4 # Constructor
+---| 5 # Field
+---| 6 # Variable
+---| 7 # Class
+---| 8 # Interface
+---| 9 # Module
+---| 10 # Property
+---| 11 # Unit
+---| 12 # Value
+---| 13 # Enum
+---| 14 # Keyword
+---| 15 # Snippet
+---| 16 # Color
+---| 17 # File
+---| 18 # Reference
+---| 19 # Folder
+---| 20 # EnumMember
+---| 21 # Constant
+---| 22 # Struct
+---| 23 # Event
+---| 24 # Operator
+---| 25 # TypeParameter
+
+---Completion item tags are extra annotations that tweak the rendering of a completion
+---item.
+---
+---@since 3.15.0
+---@alias lsp.CompletionItemTag
+---| 1 # Deprecated
+
+---Defines whether the insert text in a completion item should be interpreted as
+---plain text or a snippet.
+---@alias lsp.InsertTextFormat
+---| 1 # PlainText
+---| 2 # Snippet
+
+---How whitespace and indentation is handled during completion
+---item insertion.
+---
+---@since 3.16.0
+---@alias lsp.InsertTextMode
+---| 1 # asIs
+---| 2 # adjustIndentation
+
+---A document highlight kind.
+---@alias lsp.DocumentHighlightKind
+---| 1 # Text
+---| 2 # Read
+---| 3 # Write
+
+---A set of predefined code action kinds
+---@alias lsp.CodeActionKind
+---| "" # Empty
+---| "quickfix" # QuickFix
+---| "refactor" # Refactor
+---| "refactor.extract" # RefactorExtract
+---| "refactor.inline" # RefactorInline
+---| "refactor.rewrite" # RefactorRewrite
+---| "source" # Source
+---| "source.organizeImports" # SourceOrganizeImports
+---| "source.fixAll" # SourceFixAll
+
+---@alias lsp.TraceValues
+---| "off" # Off
+---| "messages" # Messages
+---| "verbose" # Verbose
+
+---Describes the content type that a client supports in various
+---result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
+---
+---Please note that `MarkupKinds` must not start with a `$`. This kinds
+---are reserved for internal usage.
+---@alias lsp.MarkupKind
+---| "plaintext" # PlainText
+---| "markdown" # Markdown
+
+---Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
+---
+---@since 3.18.0
+---@proposed
+---@alias lsp.InlineCompletionTriggerKind
+---| 0 # Invoked
+---| 1 # Automatic
+
+---A set of predefined position encoding kinds.
+---
+---@since 3.17.0
+---@alias lsp.PositionEncodingKind
+---| "utf-8" # UTF8
+---| "utf-16" # UTF16
+---| "utf-32" # UTF32
+
+---The file event type
+---@alias lsp.FileChangeType
+---| 1 # Created
+---| 2 # Changed
+---| 3 # Deleted
+
+---@alias lsp.WatchKind
+---| 1 # Create
+---| 2 # Change
+---| 4 # Delete
+
+---The diagnostic's severity.
+---@alias lsp.DiagnosticSeverity
+---| 1 # Error
+---| 2 # Warning
+---| 3 # Information
+---| 4 # Hint
+
+---The diagnostic tags.
+---
+---@since 3.15.0
+---@alias lsp.DiagnosticTag
+---| 1 # Unnecessary
+---| 2 # Deprecated
+
+---How a completion was triggered
+---@alias lsp.CompletionTriggerKind
+---| 1 # Invoked
+---| 2 # TriggerCharacter
+---| 3 # TriggerForIncompleteCompletions
+
+---How a signature help was triggered.
+---
+---@since 3.15.0
+---@alias lsp.SignatureHelpTriggerKind
+---| 1 # Invoked
+---| 2 # TriggerCharacter
+---| 3 # ContentChange
+
+---The reason why code actions were requested.
+---
+---@since 3.17.0
+---@alias lsp.CodeActionTriggerKind
+---| 1 # Invoked
+---| 2 # Automatic
+
+---A pattern kind describing if a glob pattern matches a file a folder or
+---both.
+---
+---@since 3.16.0
+---@alias lsp.FileOperationPatternKind
+---| "file" # file
+---| "folder" # folder
+
+---A notebook cell kind.
+---
+---@since 3.17.0
+---@alias lsp.NotebookCellKind
+---| 1 # Markup
+---| 2 # Code
+
+---@alias lsp.ResourceOperationKind
+---| "create" # Create
+---| "rename" # Rename
+---| "delete" # Delete
+
+---@alias lsp.FailureHandlingKind
+---| "abort" # Abort
+---| "transactional" # Transactional
+---| "textOnlyTransactional" # TextOnlyTransactional
+---| "undo" # Undo
+
+---@alias lsp.PrepareSupportDefaultBehavior
+---| 1 # Identifier
+
+---@alias lsp.TokenFormat
+---| "relative" # Relative
+
+---The definition of a symbol represented as one or many {@link Location locations}.
+---For most programming languages there is only one location at which a symbol is
+---defined.
+---
+---Servers should prefer returning `DefinitionLink` over `Definition` if supported
+---by the client.
+---@alias lsp.Definition lsp.Location|lsp.Location[]
+
+---Information about where a symbol is defined.
+---
+---Provides additional metadata over normal {@link Location location} definitions, including the range of
+---the defining symbol
+---@alias lsp.DefinitionLink lsp.LocationLink
+
+---LSP arrays.
+---@since 3.17.0
+---@alias lsp.LSPArray lsp.LSPAny[]
+
+---The LSP any type.
+---Please note that strictly speaking a property with the value `undefined`
+---can't be converted into JSON preserving the property name. However for
+---convenience it is allowed and assumed that all these properties are
+---optional as well.
+---@since 3.17.0
+---@alias lsp.LSPAny lsp.LSPObject|lsp.LSPArray|string|integer|uinteger|decimal|boolean|lsp.null
+
+---The declaration of a symbol representation as one or many {@link Location locations}.
+---@alias lsp.Declaration lsp.Location|lsp.Location[]
+
+---Information about where a symbol is declared.
+---
+---Provides additional metadata over normal {@link Location location} declarations, including the range of
+---the declaring symbol.
+---
+---Servers should prefer returning `DeclarationLink` over `Declaration` if supported
+---by the client.
+---@alias lsp.DeclarationLink lsp.LocationLink
+
+---Inline value information can be provided by different means:
+---- directly as a text value (class InlineValueText).
+---- as a name to use for a variable lookup (class InlineValueVariableLookup)
+---- as an evaluatable expression (class InlineValueEvaluatableExpression)
+---The InlineValue types combines all inline value types into one type.
+---
+---@since 3.17.0
+---@alias lsp.InlineValue lsp.InlineValueText|lsp.InlineValueVariableLookup|lsp.InlineValueEvaluatableExpression
+
+---The result of a document diagnostic pull request. A report can
+---either be a full report containing all diagnostics for the
+---requested document or an unchanged report indicating that nothing
+---has changed in terms of diagnostics in comparison to the last
+---pull request.
+---
+---@since 3.17.0
+---@alias lsp.DocumentDiagnosticReport lsp.RelatedFullDocumentDiagnosticReport|lsp.RelatedUnchangedDocumentDiagnosticReport
+
+---@alias lsp.PrepareRenameResult lsp.Range|anonym44|anonym45
+
+---A document selector is the combination of one or many document filters.
+---
+---@sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;
+---
+---The use of a string as a document filter is deprecated @since 3.16.0.
+---@alias lsp.DocumentSelector lsp.DocumentFilter[]
+
+---@alias lsp.ProgressToken integer|string
+
+---An identifier to refer to a change annotation stored with a workspace edit.
+---@alias lsp.ChangeAnnotationIdentifier string
+
+---A workspace diagnostic document report.
+---
+---@since 3.17.0
+---@alias lsp.WorkspaceDocumentDiagnosticReport lsp.WorkspaceFullDocumentDiagnosticReport|lsp.WorkspaceUnchangedDocumentDiagnosticReport
+
+---An event describing a change to a text document. If only a text is provided
+---it is considered to be the full content of the document.
+---@alias lsp.TextDocumentContentChangeEvent anonym46|anonym47
+
+---MarkedString can be used to render human readable text. It is either a markdown string
+---or a code-block that provides a language and a code snippet. The language identifier
+---is semantically equal to the optional language identifier in fenced code blocks in GitHub
+---issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
+---
+---The pair of a language and a value is an equivalent to markdown:
+---```${language}
+---${value}
+---```
+---
+---Note that markdown strings will be sanitized - that means html will be escaped.
+---@deprecated use MarkupContent instead.
+---@alias lsp.MarkedString string|anonym48
+
+---A document filter describes a top level text document or
+---a notebook cell document.
+---
+---@since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
+---@alias lsp.DocumentFilter lsp.TextDocumentFilter|lsp.NotebookCellTextDocumentFilter
+
+---LSP object definition.
+---@since 3.17.0
+---@alias lsp.LSPObject table<string, lsp.LSPAny>
+
+---The glob pattern. Either a string pattern or a relative pattern.
+---
+---@since 3.17.0
+---@alias lsp.GlobPattern lsp.Pattern|lsp.RelativePattern
+
+---A document filter denotes a document by different properties like
+---the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of
+---its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
+---
+---Glob patterns can have the following syntax:
+---- `*` to match one or more characters in a path segment
+---- `?` to match on one character in a path segment
+---- `**` to match any number of path segments, including none
+---- `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+---
+---@sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
+---@sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
+---
+---@since 3.17.0
+---@alias lsp.TextDocumentFilter anonym49|anonym50|anonym51
+
+---A notebook document filter denotes a notebook document by
+---different properties. The properties will be match
+---against the notebook's URI (same as with documents)
+---
+---@since 3.17.0
+---@alias lsp.NotebookDocumentFilter anonym52|anonym53|anonym54
+
+---The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
+---- `*` to match one or more characters in a path segment
+---- `?` to match on one character in a path segment
+---- `**` to match any number of path segments, including none
+---- `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+---
+---@since 3.17.0
+---@alias lsp.Pattern string
+
+---@class anonym1
+---The name of the server as defined by the server.
+---@field name string
+---The server's version as defined by the server.
+---@field version? string
+
+---@class anonym3
+---@field insert lsp.Range
+---@field replace lsp.Range
+
+---@class anonym2
+---A default commit character set.
+---
+---@since 3.17.0
+---@field commitCharacters? string[]
+---A default edit range.
+---
+---@since 3.17.0
+---@field editRange? lsp.Range|anonym3
+---A default insert text format.
+---
+---@since 3.17.0
+---@field insertTextFormat? lsp.InsertTextFormat
+---A default insert text mode.
+---
+---@since 3.17.0
+---@field insertTextMode? lsp.InsertTextMode
+---A default data value.
+---
+---@since 3.17.0
+---@field data? lsp.LSPAny
+
+---@class anonym4
+---Human readable description of why the code action is currently disabled.
+---
+---This is displayed in the code actions UI.
+---@field reason string
+
+---@class anonym5
+---@field uri lsp.DocumentUri
+
+---@class anonym6
+
+---@class anonym7
+---The server supports deltas for full documents.
+---@field delta? boolean
+
+---@class anonym9
+---The change to the cell array.
+---@field array lsp.NotebookCellArrayChange
+---Additional opened cell text documents.
+---@field didOpen? lsp.TextDocumentItem[]
+---Additional closed cell text documents.
+---@field didClose? lsp.TextDocumentIdentifier[]
+
+---@class anonym10
+---@field document lsp.VersionedTextDocumentIdentifier
+---@field changes lsp.TextDocumentContentChangeEvent[]
+
+---@class anonym8
+---Changes to the cell structure to add or
+---remove cells.
+---@field structure? anonym9
+---Changes to notebook cells properties like its
+---kind, execution summary or metadata.
+---@field data? lsp.NotebookCell[]
+---Changes to the text content of notebook cells.
+---@field textContent? anonym10[]
+
+---@class anonym11
+---The name of the client as defined by the client.
+---@field name string
+---The client's version as defined by the client.
+---@field version? string
+
+---@class anonym12
+---The server supports workspace folder.
+---
+---@since 3.6.0
+---@field workspaceFolders? lsp.WorkspaceFoldersServerCapabilities
+---The server is interested in notifications/requests for operations on files.
+---
+---@since 3.16.0
+---@field fileOperations? lsp.FileOperationOptions
+
+---@class anonym13
+---The server has support for completion item label
+---details (see also `CompletionItemLabelDetails`) when
+---receiving a completion item in a resolve call.
+---
+---@since 3.17.0
+---@field labelDetailsSupport? boolean
+
+---@class anonym15
+---@field language string
+
+---@class anonym14
+---The notebook to be synced If a string
+---value is provided it matches against the
+---notebook type. '*' matches every notebook.
+---@field notebook string|lsp.NotebookDocumentFilter
+---The cells of the matching notebook to be synced.
+---@field cells? anonym15[]
+
+---@class anonym17
+---@field language string
+
+---@class anonym16
+---The notebook to be synced If a string
+---value is provided it matches against the
+---notebook type. '*' matches every notebook.
+---@field notebook? string|lsp.NotebookDocumentFilter
+---The cells of the matching notebook to be synced.
+---@field cells anonym17[]
+
+---@class anonym18
+---The client will actively cancel the request.
+---@field cancel boolean
+---The list of requests for which the client
+---will retry the request if it receives a
+---response with error code `ContentModified`
+---@field retryOnContentModified string[]
+
+---@class anonym19
+---Whether the client groups edits with equal labels into tree nodes,
+---for instance all edits labelled with "Changes in Strings" would
+---be a tree node.
+---@field groupsOnLabel? boolean
+
+---@class anonym20
+---The symbol kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---
+---If this property is not present the client only supports
+---the symbol kinds from `File` to `Array` as defined in
+---the initial version of the protocol.
+---@field valueSet? lsp.SymbolKind[]
+
+---@class anonym21
+---The tags supported by the client.
+---@field valueSet lsp.SymbolTag[]
+
+---@class anonym22
+---The properties that a client can resolve lazily. Usually
+---`location.range`
+---@field properties string[]
+
+---@class anonym24
+---The tags supported by the client.
+---@field valueSet lsp.CompletionItemTag[]
+
+---@class anonym25
+---The properties that a client can resolve lazily.
+---@field properties string[]
+
+---@class anonym26
+---@field valueSet lsp.InsertTextMode[]
+
+---@class anonym23
+---Client supports snippets as insert text.
+---
+---A snippet can define tab stops and placeholders with `$1`, `$2`
+---and `${3:foo}`. `$0` defines the final tab stop, it defaults to
+---the end of the snippet. Placeholders with equal identifiers are linked,
+---that is typing in one will update others too.
+---@field snippetSupport? boolean
+---Client supports commit characters on a completion item.
+---@field commitCharactersSupport? boolean
+---Client supports the following content formats for the documentation
+---property. The order describes the preferred format of the client.
+---@field documentationFormat? lsp.MarkupKind[]
+---Client supports the deprecated property on a completion item.
+---@field deprecatedSupport? boolean
+---Client supports the preselect property on a completion item.
+---@field preselectSupport? boolean
+---Client supports the tag property on a completion item. Clients supporting
+---tags have to handle unknown tags gracefully. Clients especially need to
+---preserve unknown tags when sending a completion item back to the server in
+---a resolve call.
+---
+---@since 3.15.0
+---@field tagSupport? anonym24
+---Client support insert replace edit to control different behavior if a
+---completion item is inserted in the text or should replace text.
+---
+---@since 3.16.0
+---@field insertReplaceSupport? boolean
+---Indicates which properties a client can resolve lazily on a completion
+---item. Before version 3.16.0 only the predefined properties `documentation`
+---and `details` could be resolved lazily.
+---
+---@since 3.16.0
+---@field resolveSupport? anonym25
+---The client supports the `insertTextMode` property on
+---a completion item to override the whitespace handling mode
+---as defined by the client (see `insertTextMode`).
+---
+---@since 3.16.0
+---@field insertTextModeSupport? anonym26
+---The client has support for completion item label
+---details (see also `CompletionItemLabelDetails`).
+---
+---@since 3.17.0
+---@field labelDetailsSupport? boolean
+
+---@class anonym27
+---The completion item kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---
+---If this property is not present the client only supports
+---the completion items kinds from `Text` to `Reference` as defined in
+---the initial version of the protocol.
+---@field valueSet? lsp.CompletionItemKind[]
+
+---@class anonym28
+---The client supports the following itemDefaults on
+---a completion list.
+---
+---The value lists the supported property names of the
+---`CompletionList.itemDefaults` object. If omitted
+---no properties are supported.
+---
+---@since 3.17.0
+---@field itemDefaults? string[]
+
+---@class anonym30
+---The client supports processing label offsets instead of a
+---simple label string.
+---
+---@since 3.14.0
+---@field labelOffsetSupport? boolean
+
+---@class anonym29
+---Client supports the following content formats for the documentation
+---property. The order describes the preferred format of the client.
+---@field documentationFormat? lsp.MarkupKind[]
+---Client capabilities specific to parameter information.
+---@field parameterInformation? anonym30
+---The client supports the `activeParameter` property on `SignatureInformation`
+---literal.
+---
+---@since 3.16.0
+---@field activeParameterSupport? boolean
+
+---@class anonym31
+---The symbol kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---
+---If this property is not present the client only supports
+---the symbol kinds from `File` to `Array` as defined in
+---the initial version of the protocol.
+---@field valueSet? lsp.SymbolKind[]
+
+---@class anonym32
+---The tags supported by the client.
+---@field valueSet lsp.SymbolTag[]
+
+---@class anonym34
+---The code action kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---@field valueSet lsp.CodeActionKind[]
+
+---@class anonym33
+---The code action kind is support with the following value
+---set.
+---@field codeActionKind anonym34
+
+---@class anonym35
+---The properties that a client can resolve lazily.
+---@field properties string[]
+
+---@class anonym36
+---The folding range kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---@field valueSet? lsp.FoldingRangeKind[]
+
+---@class anonym37
+---If set, the client signals that it supports setting collapsedText on
+---folding ranges to display custom labels instead of the default text.
+---
+---@since 3.17.0
+---@field collapsedText? boolean
+
+---@class anonym38
+---The tags supported by the client.
+---@field valueSet lsp.DiagnosticTag[]
+
+---@class anonym40
+
+---@class anonym41
+---The client will send the `textDocument/semanticTokens/full/delta` request if
+---the server provides a corresponding handler.
+---@field delta? boolean
+
+---@class anonym39
+---The client will send the `textDocument/semanticTokens/range` request if
+---the server provides a corresponding handler.
+---@field range? boolean|anonym40
+---The client will send the `textDocument/semanticTokens/full` request if
+---the server provides a corresponding handler.
+---@field full? boolean|anonym41
+
+---@class anonym42
+---The properties that a client can resolve lazily.
+---@field properties string[]
+
+---@class anonym43
+---Whether the client supports additional attributes which
+---are preserved and send back to the server in the
+---request's response.
+---@field additionalPropertiesSupport? boolean
+
+---@class anonym44
+---@field range lsp.Range
+---@field placeholder string
+
+---@class anonym45
+---@field defaultBehavior boolean
+
+---@class anonym46
+---The range of the document that changed.
+---@field range lsp.Range
+---The optional length of the range that got replaced.
+---
+---@deprecated use range instead.
+---@field rangeLength? uinteger
+---The new text for the provided range.
+---@field text string
+
+---@class anonym47
+---The new text of the whole document.
+---@field text string
+
+---@class anonym48
+---@field language string
+---@field value string
+
+---@class anonym49
+---A language id, like `typescript`.
+---@field language string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---A glob pattern, like `*.{ts,js}`.
+---@field pattern? string
+
+---@class anonym50
+---A language id, like `typescript`.
+---@field language? string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme string
+---A glob pattern, like `*.{ts,js}`.
+---@field pattern? string
+
+---@class anonym51
+---A language id, like `typescript`.
+---@field language? string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---A glob pattern, like `*.{ts,js}`.
+---@field pattern string
+
+---@class anonym52
+---The type of the enclosing notebook.
+---@field notebookType string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---A glob pattern.
+---@field pattern? string
+
+---@class anonym53
+---The type of the enclosing notebook.
+---@field notebookType? string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme string
+---A glob pattern.
+---@field pattern? string
+
+---@class anonym54
+---The type of the enclosing notebook.
+---@field notebookType? string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---A glob pattern.
+---@field pattern string
-- 
cgit 


From 4ecc71f6fc7377403ed91ae5bc32992a5d08f678 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 7 Jun 2023 13:39:41 +0100
Subject: fix(lsp): reduce diagnostics and add more types (#23948)

---
 runtime/lua/vim/lsp.lua          | 144 +++++++++++++++++++++++++--------------
 runtime/lua/vim/lsp/protocol.lua |   1 +
 2 files changed, 92 insertions(+), 53 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 5f7a95ae14..532504a7db 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -147,9 +147,9 @@ local function next_client_id()
   return client_index
 end
 -- Tracks all clients created via lsp.start_client
-local active_clients = {}
-local all_buffer_active_clients = {}
-local uninitialized_clients = {}
+local active_clients = {} --- @type table<integer,lsp.Client>
+local all_buffer_active_clients = {} --- @type table<integer,table<integer,true>>
+local uninitialized_clients = {} --- @type table<integer,lsp.Client>
 
 ---@private
 ---@param bufnr? integer
@@ -166,7 +166,7 @@ local function for_each_buffer_client(bufnr, fn, restrict_client_ids)
   end
 
   if restrict_client_ids and #restrict_client_ids > 0 then
-    local filtered_client_ids = {}
+    local filtered_client_ids = {} --- @type table<integer,true>
     for client_id in pairs(client_ids) do
       if vim.list_contains(restrict_client_ids, client_id) then
         filtered_client_ids[client_id] = true
@@ -257,9 +257,10 @@ end
 ---@private
 --- Validates a client configuration as given to |vim.lsp.start_client()|.
 ---
----@param config (table)
----@return table config Cleaned config, containing the command, its
----arguments, and a valid encoding.
+---@param config (lsp.ClientConfig)
+---@return (string|fun(dispatchers:table):table) Command
+---@return string[] Arguments
+---@return string Encoding.
 local function validate_client_config(config)
   validate({
     config = { config, 't' },
@@ -290,22 +291,19 @@ local function validate_client_config(config)
     'flags.debounce_text_changes must be a number with the debounce time in milliseconds'
   )
 
-  local cmd, cmd_args
-  if type(config.cmd) == 'function' then
-    cmd = config.cmd
+  local cmd, cmd_args --- @type (string|fun(dispatchers:table):table), string[]
+  local config_cmd = config.cmd
+  if type(config_cmd) == 'function' then
+    cmd = config_cmd
   else
-    cmd, cmd_args = lsp._cmd_parts(config.cmd)
+    cmd, cmd_args = lsp._cmd_parts(config_cmd)
   end
   local offset_encoding = valid_encodings.UTF16
   if config.offset_encoding then
     offset_encoding = validate_encoding(config.offset_encoding)
   end
 
-  return {
-    cmd = cmd,
-    cmd_args = cmd_args,
-    offset_encoding = offset_encoding,
-  }
+  return cmd, cmd_args, offset_encoding
 end
 
 ---@private
@@ -328,10 +326,11 @@ end
 --- only the first returned value will be memoized and returned. The function will only be run once,
 --- even if it has side effects.
 ---
----@param fn (function) Function to run
----@return function fn Memoized function
+---@generic T: function
+---@param fn (T) Function to run
+---@return T
 local function once(fn)
-  local value
+  local value --- @type any
   local ran = false
   return function(...)
     if not ran then
@@ -371,7 +370,7 @@ do
   --- @field lines string[] snapshot of buffer lines from last didChange
   --- @field lines_tmp string[]
   --- @field pending_changes table[] List of debounced changes in incremental sync mode
-  --- @field timer nil|uv.uv_timer_t uv_timer
+  --- @field timer nil|uv_timer_t uv_timer
   --- @field last_flush nil|number uv.hrtime of the last flush/didChange-notification
   --- @field needs_flush boolean true if buffer updates haven't been sent to clients/servers yet
   --- @field refs integer how many clients are using this group
@@ -610,7 +609,7 @@ do
 
   ---@private
   function changetracking.send_changes(bufnr, firstline, lastline, new_lastline)
-    local groups = {}
+    local groups = {} ---@type table<string,CTGroup>
     for _, client in pairs(lsp.get_active_clients({ bufnr = bufnr })) do
       local group = get_group(client)
       groups[group_key(group)] = group
@@ -812,6 +811,10 @@ function lsp.client()
   error()
 end
 
+--- @class lsp.StartOpts
+--- @field reuse_client fun(client: lsp.Client, config: table): boolean
+--- @field bufnr integer
+
 --- Create a new LSP client and start a language server or reuses an already
 --- running client if one is found matching `name` and `root_dir`.
 --- Attaches the current buffer to the client.
@@ -849,7 +852,7 @@ end
 --- `ftplugin/<filetype_name>.lua` (See |ftplugin-name|)
 ---
 ---@param config table Same configuration as documented in |vim.lsp.start_client()|
----@param opts nil|table Optional keyword arguments:
+---@param opts (nil|lsp.StartOpts) Optional keyword arguments:
 ---             - reuse_client (fun(client: client, config: table): boolean)
 ---                            Predicate used to decide if a client should be re-used.
 ---                            Used on all running clients.
@@ -858,14 +861,13 @@ end
 ---             - bufnr (number)
 ---                     Buffer handle to attach to if starting or re-using a
 ---                     client (0 for current).
----@return number|nil client_id
+---@return integer|nil client_id
 function lsp.start(config, opts)
   opts = opts or {}
   local reuse_client = opts.reuse_client
     or function(client, conf)
       return client.config.root_dir == conf.root_dir and client.name == conf.name
     end
-  config.name = config.name
   if not config.name and type(config.cmd) == 'table' then
     config.name = config.cmd[1] and vim.fs.basename(config.cmd[1]) or nil
   end
@@ -930,6 +932,29 @@ function lsp._set_defaults(client, bufnr)
   end
 end
 
+--- @class lsp.ClientConfig
+--- @field cmd (string[]|fun(dispatchers: table):table)
+--- @field cmd_cwd string
+--- @field cmd_env (table)
+--- @field detached boolean
+--- @field workspace_folders (table)
+--- @field capabilities lsp.ClientCapabilities
+--- @field handlers table<string,function>
+--- @field settings table
+--- @field commands table
+--- @field init_options table
+--- @field name string
+--- @field get_language_id fun(bufnr: integer, filetype: string): string
+--- @field offset_encoding string
+--- @field on_error fun(code: integer)
+--- @field before_init function
+--- @field on_init function
+--- @field on_exit fun(code: integer, signal: integer, client_id: integer)
+--- @field on_attach fun(client: lsp.Client, bufnr: integer)
+--- @field trace 'off'|'messages'|'verbose'|nil
+--- @field flags table
+--- @field root_dir string
+
 -- FIXME: DOC: Currently all methods on the `vim.lsp.client` object are
 -- documented twice: Here, and on the methods themselves (e.g.
 -- `client.request()`). This is a workaround for the vimdoc generator script
@@ -940,7 +965,7 @@ end
 ---
 --- Field `cmd` in {config} is required.
 ---
----@param config (table) Configuration for the server:
+---@param config (lsp.ClientConfig) Configuration for the server:
 --- - cmd: (string[]|fun(dispatchers: table):table) command a list of
 ---       strings treated like |jobstart()|. The command must launch the language server
 ---       process. `cmd` can also be a function that creates an RPC client.
@@ -970,7 +995,7 @@ end
 ---       the LSP spec.
 ---
 --- - capabilities: Map overriding the default capabilities defined by
----       |vim.lsp.protocol.make_client_capabilities()|, passed to the language
+---       \|vim.lsp.protocol.make_client_capabilities()|, passed to the language
 ---       server on initialization. Hint: use make_client_capabilities() and modify
 ---       its result.
 ---       - Note: To send an empty dictionary use
@@ -1051,9 +1076,7 @@ end
 --- fully initialized. Use `on_init` to do any actions once
 --- the client has been initialized.
 function lsp.start_client(config)
-  local cleaned_config = validate_client_config(config)
-  local cmd, cmd_args, offset_encoding =
-    cleaned_config.cmd, cleaned_config.cmd_args, cleaned_config.offset_encoding
+  local cmd, cmd_args, offset_encoding = validate_client_config(config)
 
   config.flags = config.flags or {}
   config.settings = config.settings or {}
@@ -1090,7 +1113,9 @@ function lsp.start_client(config)
   ---@param method (string) LSP method name
   ---@param params (table) The parameters for that method.
   function dispatch.notification(method, params)
-    local _ = log.trace() and log.trace('notification', method, params)
+    if log.trace() then
+      log.trace('notification', method, params)
+    end
     local handler = resolve_handler(method)
     if handler then
       -- Method name is provided here for convenience.
@@ -1104,13 +1129,19 @@ function lsp.start_client(config)
   ---@param method (string) LSP method name
   ---@param params (table) The parameters for that method
   function dispatch.server_request(method, params)
-    local _ = log.trace() and log.trace('server_request', method, params)
+    if log.trace() then
+      log.trace('server_request', method, params)
+    end
     local handler = resolve_handler(method)
     if handler then
-      local _ = log.trace() and log.trace('server_request: found handler for', method)
+      if log.trace() then
+        log.trace('server_request: found handler for', method)
+      end
       return handler(nil, params, { method = method, client_id = client_id })
     end
-    local _ = log.warn() and log.warn('server_request: no handler found for', method)
+    if log.warn() then
+      log.warn('server_request: no handler found for', method)
+    end
     return nil, lsp.rpc_response_error(protocol.ErrorCodes.MethodNotFound)
   end
 
@@ -1122,8 +1153,9 @@ function lsp.start_client(config)
   ---@see `vim.lsp.rpc.client_errors` for possible errors. Use
   ---`vim.lsp.rpc.client_errors[code]` to get a human-friendly name.
   function dispatch.on_error(code, err)
-    local _ = log.error()
-      and log.error(log_prefix, 'on_error', { code = lsp.client_errors[code], err = err })
+    if log.error() then
+      log.error(log_prefix, 'on_error', { code = lsp.client_errors[code], err = err })
+    end
     err_message(log_prefix, ': Error ', lsp.client_errors[code], ': ', vim.inspect(err))
     if config.on_error then
       local status, usererr = pcall(config.on_error, code, err)
@@ -1232,11 +1264,13 @@ function lsp.start_client(config)
     handlers = handlers,
     commands = config.commands or {},
 
+    --- @type table<integer,{ type: string, bufnr: integer, method: string}>
     requests = {},
     -- for $/progress report
     messages = { name = name, messages = {}, progress = {}, status = {} },
     dynamic_capabilities = require('vim.lsp._dynamic').new(client_id),
   }
+  --- @type lsp.ClientCapabilities
   client.config.capabilities = config.capabilities or protocol.make_client_capabilities()
 
   -- Store the uninitialized_clients for cleanup in case we exit before initialize finishes.
@@ -1251,9 +1285,9 @@ function lsp.start_client(config)
     }
     local version = vim.version()
 
-    local workspace_folders
-    local root_uri
-    local root_path
+    local workspace_folders --- @type table[]?
+    local root_uri --- @type string?
+    local root_path --- @type string?
     if config.workspace_folders or config.root_dir then
       if config.root_dir and not config.workspace_folders then
         workspace_folders = {
@@ -1278,7 +1312,7 @@ function lsp.start_client(config)
       -- the process has not been started by another process.  If the parent
       -- process is not alive then the server should exit (see exit notification)
       -- its process.
-      processId = uv.getpid(),
+      processId = uv.os_getpid(),
       -- Information about the client
       -- since 3.15.0
       clientInfo = {
@@ -1405,8 +1439,9 @@ function lsp.start_client(config)
     -- Ensure pending didChange notifications are sent so that the server doesn't operate on a stale state
     changetracking.flush(client, bufnr)
     bufnr = resolve_bufnr(bufnr)
-    local _ = log.debug()
-      and log.debug(log_prefix, 'client.request', client_id, method, params, handler, bufnr)
+    if log.debug() then
+      log.debug(log_prefix, 'client.request', client_id, method, params, handler, bufnr)
+    end
     local success, request_id = rpc.request(method, params, function(err, result)
       handler(
         err,
@@ -1879,13 +1914,13 @@ end
 ---               - id (number): Only return clients with the given id
 ---               - bufnr (number): Only return clients attached to this buffer
 ---               - name (string): Only return clients with the given name
----@returns (table) List of |vim.lsp.client| objects
+---@return lsp.Client[]: List of |vim.lsp.client| objects
 function lsp.get_active_clients(filter)
   validate({ filter = { filter, 't', true } })
 
   filter = filter or {}
 
-  local clients = {}
+  local clients = {} --- @type lsp.Client[]
 
   local t = filter.bufnr and (all_buffer_active_clients[resolve_bufnr(filter.bufnr)] or {})
     or active_clients
@@ -2143,20 +2178,20 @@ end
 --- - findstart=0: column where the completion starts, or -2 or -3
 --- - findstart=1: list of matches (actually just calls |complete()|)
 function lsp.omnifunc(findstart, base)
-  local _ = log.debug() and log.debug('omnifunc.findstart', { findstart = findstart, base = base })
+  if log.debug() then
+    log.debug('omnifunc.findstart', { findstart = findstart, base = base })
+  end
 
   local bufnr = resolve_bufnr()
   local has_buffer_clients = not tbl_isempty(all_buffer_active_clients[bufnr] or {})
   if not has_buffer_clients then
-    if findstart == 1 then
-      return -1
-    else
-      return {}
-    end
+    return findstart == 1 and -1 or {}
   end
 
   -- Then, perform standard completion request
-  local _ = log.info() and log.info('base ', base)
+  if log.info() then
+    log.info('base ', base)
+  end
 
   local pos = api.nvim_win_get_cursor(0)
   local line = api.nvim_get_current_line()
@@ -2270,8 +2305,8 @@ end
 ---@param flags string See |tag-function|
 ---
 ---@return table[] tags A list of matching tags
-function lsp.tagfunc(...)
-  return require('vim.lsp.tagfunc')(...)
+function lsp.tagfunc(pattern, flags)
+  return require('vim.lsp.tagfunc')(pattern, flags)
 end
 
 ---Checks whether a client is stopped.
@@ -2359,10 +2394,13 @@ end
 --- are valid keys and make sense to include for this handler.
 ---
 --- Will error on invalid keys (i.e. keys that do not exist in the options)
+--- @param name string
+--- @param options table<string,any>
+--- @param user_config table<string,any>
 function lsp._with_extend(name, options, user_config)
   user_config = user_config or {}
 
-  local resulting_config = {}
+  local resulting_config = {} --- @type table<string,any>
   for k, v in pairs(user_config) do
     if options[k] == nil then
       error(
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 7558b5c6ba..172d43e483 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -632,6 +632,7 @@ export interface WorkspaceClientCapabilities {
 
 --- Gets a new ClientCapabilities object describing the LSP client
 --- capabilities.
+--- @return lsp.ClientCapabilities
 function protocol.make_client_capabilities()
   return {
     general = {
-- 
cgit 


From c0952e62fd0ee16a3275bb69e0de04c836b39015 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 7 Jun 2023 13:52:23 +0100
Subject: feat(lua): add `vim.system()`

feat(lua): add vim.system()

Problem:

  Handling system commands in Lua is tedious and error-prone:
  - vim.fn.jobstart() is vimscript and comes with all limitations attached to typval.
  - vim.loop.spawn is too low level

Solution:

  Add vim.system().
  Partly inspired by Python's subprocess module
  Does not expose any libuv objects.
---
 runtime/lua/vim/_editor.lua |  99 ++++++++++---
 runtime/lua/vim/_system.lua | 342 ++++++++++++++++++++++++++++++++++++++++++++
 runtime/lua/vim/lsp/rpc.lua | 124 ++++++----------
 3 files changed, 469 insertions(+), 96 deletions(-)
 create mode 100644 runtime/lua/vim/_system.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 7b946a55e4..d46b0fbf32 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -42,10 +42,6 @@ for k, v in pairs({
   vim._submodules[k] = v
 end
 
--- Remove at Nvim 1.0
----@deprecated
-vim.loop = vim.uv
-
 -- There are things which have special rules in vim._init_packages
 -- for legacy reasons (uri) or for performance (_inspector).
 -- most new things should go into a submodule namespace ( vim.foobar.do_thing() )
@@ -69,13 +65,73 @@ vim.log = {
   },
 }
 
--- Internal-only until comments in #8107 are addressed.
--- Returns:
---    {errcode}, {output}
-function vim._system(cmd)
-  local out = vim.fn.system(cmd)
-  local err = vim.v.shell_error
-  return err, out
+-- TODO(lewis6991): document that the signature is system({cmd}, [{opts},] {on_exit})
+--- Run a system command
+---
+--- Examples:
+--- <pre>lua
+---
+---   local on_exit = function(obj)
+---     print(obj.code)
+---     print(obj.signal)
+---     print(obj.stdout)
+---     print(obj.stderr)
+---   end
+---
+---   -- Run asynchronously
+---   vim.system({'echo', 'hello'}, { text = true }, on_exit)
+---
+---   -- Run synchronously
+---   local obj = vim.system({'echo', 'hello'}, { text = true }):wait()
+---   -- { code = 0, signal = 0, stdout = 'hello', stderr = '' }
+---
+--- </pre>
+---
+--- See |uv.spawn()| for more details.
+---
+--- @param cmd (string[]) Command to execute
+--- @param opts (SystemOpts|nil) Options:
+---   - cwd: (string) Set the current working directory for the sub-process.
+---   - env: table<string,string> Set environment variables for the new process. Inherits the
+---     current environment with `NVIM` set to |v:servername|.
+---   - clear_env: (boolean) `env` defines the job environment exactly, instead of merging current
+---     environment.
+---   - stdin: (string|string[]|boolean) If `true`, then a pipe to stdin is opened and can be written
+---     to via the `write()` method to SystemObj. If string or string[] then will be written to stdin
+---     and closed. Defaults to `false`.
+---   - stdout: (boolean|function)
+---     Handle output from stdout. When passed as a function must have the signature `fun(err: string, data: string)`.
+---     Defaults to `true`
+---   - stderr: (boolean|function)
+---     Handle output from stdout. When passed as a function must have the signature `fun(err: string, data: string)`.
+---     Defaults to `true`.
+---   - text: (boolean) Handle stdout and stderr as text. Replaces `\r\n` with `\n`.
+---   - timeout: (integer)
+---   - detach: (boolean) If true, spawn the child process in a detached state - this will make it
+---     a process group leader, and will effectively enable the child to keep running after the
+---     parent exits. Note that the child process will still keep the parent's event loop alive
+---     unless the parent process calls |uv.unref()| on the child's process handle.
+---
+--- @param on_exit (function|nil) Called when subprocess exits. When provided, the command runs
+---   asynchronously. Receives SystemCompleted object, see return of SystemObj:wait().
+---
+--- @return SystemObj Object with the fields:
+---   - pid (integer) Process ID
+---   - wait (fun(timeout: integer|nil): SystemCompleted)
+---     - SystemCompleted is an object with the fields:
+---      - code: (integer)
+---      - signal: (integer)
+---      - stdout: (string), nil if stdout argument is passed
+---      - stderr: (string), nil if stderr argument is passed
+---   - kill (fun(signal: integer))
+---   - write (fun(data: string|nil)) Requires `stdin=true`. Pass `nil` to close the stream.
+---   - is_closing (fun(): boolean)
+function vim.system(cmd, opts, on_exit)
+  if type(opts) == 'function' then
+    on_exit = opts
+    opts = nil
+  end
+  return require('vim._system').run(cmd, opts, on_exit)
 end
 
 -- Gets process info from the `ps` command.
@@ -85,13 +141,14 @@ function vim._os_proc_info(pid)
     error('invalid pid')
   end
   local cmd = { 'ps', '-p', pid, '-o', 'comm=' }
-  local err, name = vim._system(cmd)
-  if 1 == err and vim.trim(name) == '' then
+  local r = vim.system(cmd):wait()
+  local name = assert(r.stdout)
+  if r.code == 1 and vim.trim(name) == '' then
     return {} -- Process not found.
-  elseif 0 ~= err then
+  elseif r.code ~= 0 then
     error('command failed: ' .. vim.fn.string(cmd))
   end
-  local _, ppid = vim._system({ 'ps', '-p', pid, '-o', 'ppid=' })
+  local ppid = assert(vim.system({ 'ps', '-p', pid, '-o', 'ppid=' }):wait().stdout)
   -- Remove trailing whitespace.
   name = vim.trim(name):gsub('^.*/', '')
   ppid = tonumber(ppid) or -1
@@ -109,14 +166,14 @@ function vim._os_proc_children(ppid)
     error('invalid ppid')
   end
   local cmd = { 'pgrep', '-P', ppid }
-  local err, rv = vim._system(cmd)
-  if 1 == err and vim.trim(rv) == '' then
+  local r = vim.system(cmd):wait()
+  if r.code == 1 and vim.trim(r.stdout) == '' then
     return {} -- Process not found.
-  elseif 0 ~= err then
+  elseif r.code ~= 0 then
     error('command failed: ' .. vim.fn.string(cmd))
   end
   local children = {}
-  for s in rv:gmatch('%S+') do
+  for s in r.stdout:gmatch('%S+') do
     local i = tonumber(s)
     if i ~= nil then
       table.insert(children, i)
@@ -1006,4 +1063,8 @@ end
 
 require('vim._meta')
 
+-- Remove at Nvim 1.0
+---@deprecated
+vim.loop = vim.uv
+
 return vim
diff --git a/runtime/lua/vim/_system.lua b/runtime/lua/vim/_system.lua
new file mode 100644
index 0000000000..eadf801a31
--- /dev/null
+++ b/runtime/lua/vim/_system.lua
@@ -0,0 +1,342 @@
+local uv = vim.uv
+
+--- @class SystemOpts
+--- @field cmd string[]
+--- @field stdin string|string[]|true
+--- @field stdout fun(err:string, data: string)|false
+--- @field stderr fun(err:string, data: string)|false
+--- @field cwd? string
+--- @field env? table<string,string|number>
+--- @field clear_env? boolean
+--- @field text boolean?
+--- @field timeout? integer Timeout in ms
+--- @field detach? boolean
+
+--- @class SystemCompleted
+--- @field code integer
+--- @field signal integer
+--- @field stdout? string
+--- @field stderr? string
+
+--- @class SystemState
+--- @field handle uv_process_t
+--- @field timer uv_timer_t
+--- @field pid integer
+--- @field timeout? integer
+--- @field done boolean
+--- @field stdin uv_stream_t?
+--- @field stdout uv_stream_t?
+--- @field stderr uv_stream_t?
+--- @field cmd string[]
+--- @field result? SystemCompleted
+
+---@private
+---@param state SystemState
+local function close_handles(state)
+  for _, handle in pairs({ state.handle, state.stdin, state.stdout, state.stderr }) do
+    if not handle:is_closing() then
+      handle:close()
+    end
+  end
+end
+
+--- @param cmd string[]
+--- @return SystemCompleted
+local function timeout_result(cmd)
+  local cmd_str = table.concat(cmd, ' ')
+  local err = string.format("Command timed out: '%s'", cmd_str)
+  return { code = 0, signal = 2, stdout = '', stderr = err }
+end
+
+--- @class SystemObj
+--- @field pid integer
+--- @field private _state SystemState
+--- @field wait fun(self: SystemObj, timeout?: integer): SystemCompleted
+--- @field kill fun(self: SystemObj, signal: integer)
+--- @field write fun(self: SystemObj, data?: string|string[])
+--- @field is_closing fun(self: SystemObj): boolean?
+local SystemObj = {}
+
+--- @param state SystemState
+--- @return SystemObj
+local function new_systemobj(state)
+  return setmetatable({
+    pid = state.pid,
+    _state = state,
+  }, { __index = SystemObj })
+end
+
+--- @param signal integer
+function SystemObj:kill(signal)
+  local state = self._state
+  state.handle:kill(signal)
+  close_handles(state)
+end
+
+local MAX_TIMEOUT = 2 ^ 31
+
+--- @param timeout? integer
+--- @return SystemCompleted
+function SystemObj:wait(timeout)
+  local state = self._state
+
+  vim.wait(timeout or state.timeout or MAX_TIMEOUT, function()
+    return state.done
+  end)
+
+  if not state.done then
+    self:kill(6) -- 'sigint'
+    state.result = timeout_result(state.cmd)
+  end
+
+  return state.result
+end
+
+--- @param data string[]|string|nil
+function SystemObj:write(data)
+  local stdin = self._state.stdin
+
+  if not stdin then
+    error('stdin has not been opened on this object')
+  end
+
+  if type(data) == 'table' then
+    for _, v in ipairs(data) do
+      stdin:write(v)
+      stdin:write('\n')
+    end
+  elseif type(data) == 'string' then
+    stdin:write(data)
+  elseif data == nil then
+    -- Shutdown the write side of the duplex stream and then close the pipe.
+    -- Note shutdown will wait for all the pending write requests to complete
+    -- TODO(lewis6991): apparently shutdown doesn't behave this way.
+    -- (https://github.com/neovim/neovim/pull/17620#discussion_r820775616)
+    stdin:write('', function()
+      stdin:shutdown(function()
+        if stdin then
+          stdin:close()
+        end
+      end)
+    end)
+  end
+end
+
+--- @return boolean
+function SystemObj:is_closing()
+  local handle = self._state.handle
+  return handle == nil or handle:is_closing()
+end
+
+---@private
+---@param output function|'false'
+---@return uv_stream_t?
+---@return function? Handler
+local function setup_output(output)
+  if output == nil then
+    return assert(uv.new_pipe(false)), nil
+  end
+
+  if type(output) == 'function' then
+    return assert(uv.new_pipe(false)), output
+  end
+
+  assert(output == false)
+  return nil, nil
+end
+
+---@private
+---@param input string|string[]|true|nil
+---@return uv_stream_t?
+---@return string|string[]?
+local function setup_input(input)
+  if not input then
+    return
+  end
+
+  local towrite --- @type string|string[]?
+  if type(input) == 'string' or type(input) == 'table' then
+    towrite = input
+  end
+
+  return assert(uv.new_pipe(false)), towrite
+end
+
+--- @return table<string,string>
+local function base_env()
+  local env = vim.fn.environ()
+  env['NVIM'] = vim.v.servername
+  env['NVIM_LISTEN_ADDRESS'] = nil
+  return env
+end
+
+--- uv.spawn will completely overwrite the environment
+--- when we just want to modify the existing one, so
+--- make sure to prepopulate it with the current env.
+--- @param env? table<string,string|number>
+--- @param clear_env? boolean
+--- @return string[]?
+local function setup_env(env, clear_env)
+  if clear_env then
+    return env
+  end
+
+  --- @type table<string,string|number>
+  env = vim.tbl_extend('force', base_env(), env or {})
+
+  local renv = {} --- @type string[]
+  for k, v in pairs(env) do
+    renv[#renv + 1] = string.format('%s=%s', k, tostring(v))
+  end
+
+  return renv
+end
+
+--- @param stream uv_stream_t
+--- @param text? boolean
+--- @param bucket string[]
+--- @return fun(err: string?, data: string?)
+local function default_handler(stream, text, bucket)
+  return function(err, data)
+    if err then
+      error(err)
+    end
+    if data ~= nil then
+      if text then
+        bucket[#bucket + 1] = data:gsub('\r\n', '\n')
+      else
+        bucket[#bucket + 1] = data
+      end
+    else
+      stream:read_stop()
+      stream:close()
+    end
+  end
+end
+
+local M = {}
+
+--- @param cmd string
+--- @param opts uv.aliases.spawn_options
+--- @param on_exit fun(code: integer, signal: integer)
+--- @param on_error fun()
+--- @return uv_process_t, integer
+local function spawn(cmd, opts, on_exit, on_error)
+  local handle, pid_or_err = uv.spawn(cmd, opts, on_exit)
+  if not handle then
+    on_error()
+    error(pid_or_err)
+  end
+  return handle, pid_or_err --[[@as integer]]
+end
+
+--- Run a system command
+---
+--- @param cmd string[]
+--- @param opts? SystemOpts
+--- @param on_exit? fun(out: SystemCompleted)
+--- @return SystemObj
+function M.run(cmd, opts, on_exit)
+  vim.validate({
+    cmd = { cmd, 'table' },
+    opts = { opts, 'table', true },
+    on_exit = { on_exit, 'function', true },
+  })
+
+  opts = opts or {}
+
+  local stdout, stdout_handler = setup_output(opts.stdout)
+  local stderr, stderr_handler = setup_output(opts.stderr)
+  local stdin, towrite = setup_input(opts.stdin)
+
+  --- @type SystemState
+  local state = {
+    done = false,
+    cmd = cmd,
+    timeout = opts.timeout,
+    stdin = stdin,
+    stdout = stdout,
+    stderr = stderr,
+  }
+
+  -- Define data buckets as tables and concatenate the elements at the end as
+  -- one operation.
+  --- @type string[], string[]
+  local stdout_data, stderr_data
+
+  state.handle, state.pid = spawn(cmd[1], {
+    args = vim.list_slice(cmd, 2),
+    stdio = { stdin, stdout, stderr },
+    cwd = opts.cwd,
+    env = setup_env(opts.env, opts.clear_env),
+    detached = opts.detach,
+    hide = true,
+  }, function(code, signal)
+    close_handles(state)
+    if state.timer then
+      state.timer:stop()
+      state.timer:close()
+    end
+
+    local check = assert(uv.new_check())
+
+    check:start(function()
+      for _, pipe in pairs({ state.stdin, state.stdout, state.stderr }) do
+        if not pipe:is_closing() then
+          return
+        end
+      end
+      check:stop()
+
+      state.done = true
+      state.result = {
+        code = code,
+        signal = signal,
+        stdout = stdout_data and table.concat(stdout_data) or nil,
+        stderr = stderr_data and table.concat(stderr_data) or nil,
+      }
+
+      if on_exit then
+        on_exit(state.result)
+      end
+    end)
+  end, function()
+    close_handles(state)
+  end)
+
+  if stdout then
+    stdout_data = {}
+    stdout:read_start(stdout_handler or default_handler(stdout, opts.text, stdout_data))
+  end
+
+  if stderr then
+    stderr_data = {}
+    stderr:read_start(stderr_handler or default_handler(stderr, opts.text, stderr_data))
+  end
+
+  local obj = new_systemobj(state)
+
+  if towrite then
+    obj:write(towrite)
+    obj:write(nil) -- close the stream
+  end
+
+  if opts.timeout then
+    state.timer = assert(uv.new_timer())
+    state.timer:start(opts.timeout, 0, function()
+      state.timer:stop()
+      state.timer:close()
+      if state.handle and state.handle:is_active() then
+        obj:kill(6) --- 'sigint'
+        state.result = timeout_result(state.cmd)
+        if on_exit then
+          on_exit(state.result)
+        end
+      end
+    end)
+  end
+
+  return obj
+end
+
+return M
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index 5f48effebf..64bc732bdf 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -14,32 +14,6 @@ local function is_dir(filename)
   return stat and stat.type == 'directory' or false
 end
 
----@private
---- Merges current process env with the given env and returns the result as
---- a list of "k=v" strings.
----
---- <pre>
---- Example:
----
----  in:    { PRODUCTION="false", PATH="/usr/bin/", PORT=123, HOST="0.0.0.0", }
----  out:   { "PRODUCTION=false", "PATH=/usr/bin/", "PORT=123", "HOST=0.0.0.0", }
---- </pre>
----@param env (table) table of environment variable assignments
----@returns (table) list of `"k=v"` strings
-local function env_merge(env)
-  if env == nil then
-    return env
-  end
-  -- Merge.
-  env = vim.tbl_extend('force', vim.fn.environ(), env)
-  local final_env = {}
-  for k, v in pairs(env) do
-    assert(type(k) == 'string', 'env must be a dict')
-    table.insert(final_env, k .. '=' .. tostring(v))
-  end
-  return final_env
-end
-
 ---@private
 --- Embeds the given string into a table and correctly computes `Content-Length`.
 ---
@@ -658,89 +632,85 @@ end
 --- - `is_closing()` returns a boolean indicating if the RPC is closing.
 --- - `terminate()` terminates the RPC client.
 local function start(cmd, cmd_args, dispatchers, extra_spawn_params)
-  local _ = log.info()
-    and log.info('Starting RPC client', { cmd = cmd, args = cmd_args, extra = extra_spawn_params })
+  if log.info() then
+    log.info('Starting RPC client', { cmd = cmd, args = cmd_args, extra = extra_spawn_params })
+  end
+
   validate({
     cmd = { cmd, 's' },
     cmd_args = { cmd_args, 't' },
     dispatchers = { dispatchers, 't', true },
   })
 
-  if extra_spawn_params and extra_spawn_params.cwd then
+  extra_spawn_params = extra_spawn_params or {}
+
+  if extra_spawn_params.cwd then
     assert(is_dir(extra_spawn_params.cwd), 'cwd must be a directory')
   end
 
   dispatchers = merge_dispatchers(dispatchers)
-  local stdin = uv.new_pipe(false)
-  local stdout = uv.new_pipe(false)
-  local stderr = uv.new_pipe(false)
-  local handle, pid
+
+  local sysobj ---@type SystemObj
 
   local client = new_client(dispatchers, {
     write = function(msg)
-      stdin:write(msg)
+      sysobj:write(msg)
     end,
     is_closing = function()
-      return handle == nil or handle:is_closing()
+      return sysobj == nil or sysobj:is_closing()
     end,
     terminate = function()
-      if handle then
-        handle:kill(15)
-      end
+      sysobj:kill(15)
     end,
   })
 
-  ---@private
-  --- Callback for |vim.uv.spawn()| Closes all streams and runs the `on_exit` dispatcher.
-  ---@param code (integer) Exit code
-  ---@param signal (integer) Signal that was used to terminate (if any)
-  local function onexit(code, signal)
-    stdin:close()
-    stdout:close()
-    stderr:close()
-    handle:close()
-    dispatchers.on_exit(code, signal)
+  local handle_body = function(body)
+    client:handle_body(body)
   end
-  local spawn_params = {
-    args = cmd_args,
-    stdio = { stdin, stdout, stderr },
-    detached = not is_win,
-  }
-  if extra_spawn_params then
-    spawn_params.cwd = extra_spawn_params.cwd
-    spawn_params.env = env_merge(extra_spawn_params.env)
-    if extra_spawn_params.detached ~= nil then
-      spawn_params.detached = extra_spawn_params.detached
+
+  local stdout_handler = create_read_loop(handle_body, nil, function(err)
+    client:on_error(client_errors.READ_ERROR, err)
+  end)
+
+  local stderr_handler = function(_, chunk)
+    if chunk and log.error() then
+      log.error('rpc', cmd, 'stderr', chunk)
     end
   end
-  handle, pid = uv.spawn(cmd, spawn_params, onexit)
-  if handle == nil then
-    stdin:close()
-    stdout:close()
-    stderr:close()
+
+  local detached = not is_win
+  if extra_spawn_params.detached ~= nil then
+    detached = extra_spawn_params.detached
+  end
+
+  local cmd1 = { cmd }
+  vim.list_extend(cmd1, cmd_args)
+
+  local ok, sysobj_or_err = pcall(vim.system, cmd1, {
+    stdin = true,
+    stdout = stdout_handler,
+    stderr = stderr_handler,
+    cwd = extra_spawn_params.cwd,
+    env = extra_spawn_params.env,
+    detach = detached,
+  }, function(obj)
+    dispatchers.on_exit(obj.code, obj.signal)
+  end)
+
+  if not ok then
+    local err = sysobj_or_err --[[@as string]]
     local msg = string.format('Spawning language server with cmd: `%s` failed', cmd)
-    if string.match(pid, 'ENOENT') then
+    if string.match(err, 'ENOENT') then
       msg = msg
         .. '. The language server is either not installed, missing from PATH, or not executable.'
     else
-      msg = msg .. string.format(' with error message: %s', pid)
+      msg = msg .. string.format(' with error message: %s', err)
     end
     vim.notify(msg, vim.log.levels.WARN)
     return
   end
 
-  stderr:read_start(function(_, chunk)
-    if chunk then
-      local _ = log.error() and log.error('rpc', cmd, 'stderr', chunk)
-    end
-  end)
-
-  local handle_body = function(body)
-    client:handle_body(body)
-  end
-  stdout:read_start(create_read_loop(handle_body, nil, function(err)
-    client:on_error(client_errors.READ_ERROR, err)
-  end))
+  sysobj = sysobj_or_err --[[@as SystemObj]]
 
   return public_client(client)
 end
-- 
cgit 


From 0329f5c2f4f300b9ffe66b0b4b2db1d51c6293d1 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 7 Jun 2023 20:53:02 +0200
Subject: vim-patch:9.0.1615: URL shortcut files are not recognized (#23950)

Problem:    URL shortcut files are not recognized.
Solution:   Add a pattern for URL shortcut files. (closes vim/vim#12474)

https://github.com/vim/vim/commit/cdb7b4c50826df254d2e5ba8abd211e49b7a9784

Co-authored-by: ObserverOfTime <chronobserver@disroot.org>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 6990de3391..13d3d3e53a 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1082,6 +1082,7 @@ local extension = {
   uit = 'uil',
   uil = 'uil',
   ungram = 'ungrammar',
+  url = 'urlshortcut',
   usd = 'usd',
   usda = 'usd',
   sba = 'vb',
-- 
cgit 


From 7c661207cc4357553ed2b057b6c8f28400024361 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Thu, 8 Jun 2023 12:11:24 +0200
Subject: feat(lua): add ringbuffer (#22894)

https://en.wikipedia.org/wiki/Circular_buffer
---
 runtime/lua/vim/shared.lua | 94 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 94 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 4f230c4412..f899157ab7 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -881,4 +881,98 @@ function vim.defaulttable(create)
   })
 end
 
+do
+  ---@class vim.Ringbuf<T>
+  ---@field private _items table[]
+  ---@field private _idx_read integer
+  ---@field private _idx_write integer
+  ---@field private _size integer
+  local Ringbuf = {}
+
+  --- Clear all items
+  function Ringbuf.clear(self)
+    self._items = {}
+    self._idx_read = 0
+    self._idx_write = 0
+  end
+
+  --- Adds an item, overriding the oldest item if the buffer is full.
+  ---@generic T
+  ---@param item T
+  function Ringbuf.push(self, item)
+    self._items[self._idx_write] = item
+    self._idx_write = (self._idx_write + 1) % self._size
+    if self._idx_write == self._idx_read then
+      self._idx_read = (self._idx_read + 1) % self._size
+    end
+  end
+
+  --- Removes and returns the first unread item
+  ---@generic T
+  ---@return T?
+  function Ringbuf.pop(self)
+    local idx_read = self._idx_read
+    if idx_read == self._idx_write then
+      return nil
+    end
+    local item = self._items[idx_read]
+    self._items[idx_read] = nil
+    self._idx_read = (idx_read + 1) % self._size
+    return item
+  end
+
+  --- Returns the first unread item without removing it
+  ---@generic T
+  ---@return T?
+  function Ringbuf.peek(self)
+    if self._idx_read == self._idx_write then
+      return nil
+    end
+    return self._items[self._idx_read]
+  end
+
+  --- Create a ring buffer limited to a maximal number of items.
+  --- Once the buffer is full, adding a new entry overrides the oldest entry.
+  ---
+  --- <pre>
+  ---   local ringbuf = vim.ringbuf(4)
+  ---   ringbuf:push("a")
+  ---   ringbuf:push("b")
+  ---   ringbuf:push("c")
+  ---   ringbuf:push("d")
+  ---   ringbuf:push("e")    -- overrides "a"
+  ---   print(ringbuf:pop()) -- returns "b"
+  ---   print(ringbuf:pop()) -- returns "c"
+  ---
+  ---   -- Can be used as iterator. Pops remaining items:
+  ---   for val in ringbuf do
+  ---     print(val)
+  ---   end
+  --- </pre>
+  ---
+  --- Returns a Ringbuf instance with the following methods:
+  ---
+  --- - |Ringbuf:push()|
+  --- - |Ringbuf:pop()|
+  --- - |Ringbuf:peek()|
+  --- - |Ringbuf:clear()|
+  ---
+  ---@param size integer
+  ---@return vim.Ringbuf ringbuf (table)
+  function vim.ringbuf(size)
+    local ringbuf = {
+      _items = {},
+      _size = size + 1,
+      _idx_read = 0,
+      _idx_write = 0,
+    }
+    return setmetatable(ringbuf, {
+      __index = Ringbuf,
+      __call = function(self)
+        return self:pop()
+      end,
+    })
+  end
+end
+
 return vim
-- 
cgit 


From be539f5fa8e2d7ad73f7f69941bd6ff13354e89c Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Thu, 8 Jun 2023 21:53:16 +0200
Subject: vim-patch:9.0.1618: Trace32 files are not recognized (#23960)

Problem:    Trace32 files are not recognized.
Solution:   Add patterns for the t32 filetype. (Christoph Sax, closes vim/vim#12505)

https://github.com/vim/vim/commit/7fbcee6f928356f1c205a4dfa67c1d542f743b92

Co-authored-by: Christoph Sax <christoph.sax@mailbox.org>
---
 runtime/lua/vim/filetype.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 13d3d3e53a..18c47ea2f4 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1033,6 +1033,8 @@ local extension = {
   swift = 'swift',
   svh = 'systemverilog',
   sv = 'systemverilog',
+  cmm = 't32',
+  t32 = 't32',
   td = 'tablegen',
   tak = 'tak',
   tal = 'tal',
-- 
cgit 


From f31dba93f921891159eb707b185517648df00d6b Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 9 Jun 2023 08:59:28 +0200
Subject: vim-patch:9.0.1620: Nix files are not recognized from the hashbang
 line (#23961)

Problem:    Nix files are not recognized from the hashbang line.
Solution:   Add a hashbang check. (issue vim/vim#12507)

https://github.com/vim/vim/commit/19548c6a742d954ecd0b50b0680c37cc6ced7473

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/filetype/detect.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index b347215895..4e18ed190a 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -1459,6 +1459,7 @@ local patterns_hashbang = {
   ['gforth\\>'] = { 'forth', { vim_regex = true } },
   ['icon\\>'] = { 'icon', { vim_regex = true } },
   guile = 'scheme',
+  ['nix%-shell'] = 'nix',
 }
 
 ---@private
@@ -1491,7 +1492,7 @@ local function match_from_hashbang(contents, path, dispatch_extension)
   elseif matchregex(first_line, [[^#!\s*[^/\\ ]*\>\([^/\\]\|$\)]]) then
     name = vim.fn.substitute(first_line, [[^#!\s*\([^/\\ ]*\>\).*]], '\\1', '')
   else
-    name = vim.fn.substitute(first_line, [[^#!\s*\S*[/\\]\(\i\+\).*]], '\\1', '')
+    name = vim.fn.substitute(first_line, [[^#!\s*\S*[/\\]\(\f\+\).*]], '\\1', '')
   end
 
   -- tcl scripts may have #!/bin/sh in the first line and "exec wish" in the
-- 
cgit 


From e5e0bda41b640d324350c5147b956e37e9f8b32c Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Fri, 9 Jun 2023 11:32:43 +0200
Subject: feat(lsp)!: add vim.lsp.status, client.progress and promote
 LspProgressUpdate (#23958)

`client.messages` could grow unbounded because the default handler only
added new messages, never removing them.

A user either had to consume the messages by calling
`vim.lsp.util.get_progress_messages` or by manually removing them from
`client.messages.progress`. If they didn't do that, using LSP
effectively leaked memory.

To fix this, this deprecates the `messages` property and instead adds a
`progress` ring buffer that only keeps at most 50 messages. In addition
it deprecates `vim.lsp.util.get_progress_messages` in favour of a new
`vim.lsp.status()` and also promotes the `LspProgressUpdate` user
autocmd to a regular autocmd to allow users to pattern match on the
progress kind.

Also closes https://github.com/neovim/neovim/pull/20327
---
 runtime/lua/vim/lsp.lua          | 62 ++++++++++++++++++++++++++++++++-
 runtime/lua/vim/lsp/handlers.lua | 75 +++++++++++++++++-----------------------
 runtime/lua/vim/lsp/types.lua    |  8 ++++-
 runtime/lua/vim/lsp/util.lua     | 29 ++++++++++++++++
 4 files changed, 129 insertions(+), 45 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 532504a7db..6ddbfc6df7 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -807,6 +807,9 @@ end
 ---
 ---  - {server_capabilities} (table): Response from the server sent on
 ---    `initialize` describing the server's capabilities.
+---
+---  - {progress} A ring buffer (|vim.ringbuf()|) containing progress messages
+---    sent by the server.
 function lsp.client()
   error()
 end
@@ -891,6 +894,50 @@ function lsp.start(config, opts)
   return client_id
 end
 
+--- Consumes the latest progress messages from all clients and formats them as a string.
+--- Empty if there are no clients or if no new messages
+---
+---@return string
+function lsp.status()
+  local percentage = nil
+  local groups = {}
+  for _, client in ipairs(vim.lsp.get_active_clients()) do
+    for progress in client.progress do
+      local value = progress.value
+      if type(value) == 'table' and value.kind then
+        local group = groups[progress.token]
+        if not group then
+          group = {}
+          groups[progress.token] = group
+        end
+        group.title = value.title or group.title
+        group.message = value.message or group.message
+        if value.percentage then
+          percentage = math.max(percentage or 0, value.percentage)
+        end
+      end
+      -- else: Doesn't look like work done progress and can be in any format
+      -- Just ignore it as there is no sensible way to display it
+    end
+  end
+  local messages = {}
+  for _, group in pairs(groups) do
+    if group.title then
+      table.insert(
+        messages,
+        group.message and (group.title .. ': ' .. group.message) or group.title
+      )
+    elseif group.message then
+      table.insert(messages, group.message)
+    end
+  end
+  local message = table.concat(messages, ', ')
+  if percentage then
+    return string.format('%03d: %s', percentage, message)
+  end
+  return message
+end
+
 ---@private
 -- Determines whether the given option can be set by `set_defaults`.
 local function is_empty_or_default(bufnr, option)
@@ -1266,10 +1313,23 @@ function lsp.start_client(config)
 
     --- @type table<integer,{ type: string, bufnr: integer, method: string}>
     requests = {},
-    -- for $/progress report
+
+    --- Contains $/progress report messages.
+    --- They have the format {token: integer|string, value: any}
+    --- For "work done progress", value will be one of:
+    --- - lsp.WorkDoneProgressBegin,
+    --- - lsp.WorkDoneProgressReport (extended with title from Begin)
+    --- - lsp.WorkDoneProgressEnd    (extended with title from Begin)
+    progress = vim.ringbuf(50),
+
+    ---@deprecated use client.progress instead
     messages = { name = name, messages = {}, progress = {}, status = {} },
     dynamic_capabilities = require('vim.lsp._dynamic').new(client_id),
   }
+
+  ---@type table<string|integer, string> title of unfinished progress sequences by token
+  client.progress.pending = {}
+
   --- @type lsp.ClientCapabilities
   client.config.capabilities = config.capabilities or protocol.make_client_capabilities()
 
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 5346160871..19338ae8f0 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -9,7 +9,7 @@ local M = {}
 
 ---@private
 --- Writes to error buffer.
----@param ... (table of strings) Will be concatenated before being written
+---@param ... string Will be concatenated before being written
 local function err_message(...)
   vim.notify(table.concat(vim.tbl_flatten({ ... })), vim.log.levels.ERROR)
   api.nvim_command('redraw')
@@ -20,63 +20,52 @@ M['workspace/executeCommand'] = function(_, _, _, _)
   -- Error handling is done implicitly by wrapping all handlers; see end of this file
 end
 
----@private
-local function progress_handler(_, result, ctx, _)
-  local client_id = ctx.client_id
-  local client = vim.lsp.get_client_by_id(client_id)
-  local client_name = client and client.name or string.format('id=%d', client_id)
+--see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#progress
+---@param result lsp.ProgressParams
+---@param ctx lsp.HandlerContext
+M['$/progress'] = function(_, result, ctx)
+  local client = vim.lsp.get_client_by_id(ctx.client_id)
   if not client then
-    err_message('LSP[', client_name, '] client has shut down during progress update')
+    err_message('LSP[id=', tostring(ctx.client_id), '] client has shut down during progress update')
     return vim.NIL
   end
-  local val = result.value -- unspecified yet
-  local token = result.token -- string or number
+  local kind = nil
+  local value = result.value
 
-  if type(val) ~= 'table' then
-    val = { content = val }
-  end
-  if val.kind then
-    if val.kind == 'begin' then
-      client.messages.progress[token] = {
-        title = val.title,
-        cancellable = val.cancellable,
-        message = val.message,
-        percentage = val.percentage,
-      }
-    elseif val.kind == 'report' then
-      client.messages.progress[token].cancellable = val.cancellable
-      client.messages.progress[token].message = val.message
-      client.messages.progress[token].percentage = val.percentage
-    elseif val.kind == 'end' then
-      if client.messages.progress[token] == nil then
-        err_message('LSP[', client_name, '] received `end` message with no corresponding `begin`')
-      else
-        client.messages.progress[token].message = val.message
-        client.messages.progress[token].done = true
+  if type(value) == 'table' then
+    kind = value.kind
+    -- Carry over title of `begin` messages to `report` and `end` messages
+    -- So that consumers always have it available, even if they consume a
+    -- subset of the full sequence
+    if kind == 'begin' then
+      client.progress.pending[result.token] = value.title
+    else
+      value.title = client.progress.pending[result.token]
+      if kind == 'end' then
+        client.progress.pending[result.token] = nil
       end
     end
-  else
-    client.messages.progress[token] = val
-    client.messages.progress[token].done = true
   end
 
-  api.nvim_exec_autocmds('User', { pattern = 'LspProgressUpdate', modeline = false })
-end
+  client.progress:push(result)
 
---see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#progress
-M['$/progress'] = progress_handler
+  api.nvim_exec_autocmds('LspProgress', {
+    pattern = kind,
+    modeline = false,
+    data = { client_id = ctx.client_id, result = result },
+  })
+end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#window_workDoneProgress_create
+---@param result lsp.WorkDoneProgressCreateParams
+---@param ctx lsp.HandlerContext
 M['window/workDoneProgress/create'] = function(_, result, ctx)
-  local client_id = ctx.client_id
-  local client = vim.lsp.get_client_by_id(client_id)
-  local token = result.token -- string or number
-  local client_name = client and client.name or string.format('id=%d', client_id)
+  local client = vim.lsp.get_client_by_id(ctx.client_id)
   if not client then
-    err_message('LSP[', client_name, '] client has shut down while creating progress report')
+    err_message('LSP[id=', tostring(ctx.client_id), '] client has shut down during progress update')
     return vim.NIL
   end
-  client.messages.progress[token] = {}
+  client.progress:push(result)
   return vim.NIL
 end
 
diff --git a/runtime/lua/vim/lsp/types.lua b/runtime/lua/vim/lsp/types.lua
index e77e1fb63a..ef85a0d10f 100644
--- a/runtime/lua/vim/lsp/types.lua
+++ b/runtime/lua/vim/lsp/types.lua
@@ -1,6 +1,12 @@
 ---@meta
 
----@alias lsp-handler fun(err: lsp.ResponseError|nil, result: any, context: table, config: table|nil)
+---@alias lsp-handler fun(err: lsp.ResponseError|nil, result: any, context: lsp.HandlerContext, config: table|nil)
+
+---@class lsp.HandlerContext
+---@field method string
+---@field client_id integer
+---@field bufnr integer
+---@field params any
 
 ---@class lsp.ResponseError
 ---@field code integer
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index e36014d07d..538e48c805 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -353,11 +353,40 @@ end
 
 --- Process and return progress reports from lsp server
 ---@private
+---@deprecated Use vim.lsp.status() or access client.progress directly
 function M.get_progress_messages()
+  vim.deprecate('vim.lsp.util.get_progress_messages', 'vim.lsp.status', '0.11.0')
   local new_messages = {}
   local progress_remove = {}
 
   for _, client in ipairs(vim.lsp.get_active_clients()) do
+    local groups = {}
+    for progress in client.progress do
+      local value = progress.value
+      if type(value) == 'table' and value.kind then
+        local group = groups[progress.token]
+        if not group then
+          group = {
+            done = false,
+            progress = true,
+            title = 'empty title',
+          }
+          groups[progress.token] = group
+        end
+        group.title = value.title or group.title
+        group.cancellable = value.cancellable or group.cancellable
+        if value.kind == 'end' then
+          group.done = true
+        end
+        group.message = value.message or group.message
+        group.percentage = value.percentage or group.percentage
+      end
+    end
+
+    for _, group in pairs(groups) do
+      table.insert(new_messages, group)
+    end
+
     local messages = client.messages
     local data = messages
     for token, ctx in pairs(data.progress) do
-- 
cgit 


From 5959b3c9222629c0e6020672ad5b13d0ed707c99 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 9 Jun 2023 23:48:31 +0200
Subject: vim-patch:9.0.1622: filetype name t32 is a bit obscure (#23967)

Problem:    Filetype name t32 is a bit obscure.
Solution:   Rename t32 to trace32. (Christoph Sax, closes vim/vim#12512)

https://github.com/vim/vim/commit/740df76c90ee2c421ab7852b7ff2835aa0af782a

Co-authored-by: Christoph Sax <christoph.sax@mailbox.org>
---
 runtime/lua/vim/filetype.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 18c47ea2f4..fc8871f593 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1033,8 +1033,8 @@ local extension = {
   swift = 'swift',
   svh = 'systemverilog',
   sv = 'systemverilog',
-  cmm = 't32',
-  t32 = 't32',
+  cmm = 'trace32',
+  t32 = 'trace32',
   td = 'tablegen',
   tak = 'tak',
   tal = 'tal',
-- 
cgit 


From 7154f0c98619d0789618f370a6c7f81ee1775469 Mon Sep 17 00:00:00 2001
From: Jonas Strittmatter <40792180+smjonas@users.noreply.github.com>
Date: Sat, 10 Jun 2023 03:37:05 +0200
Subject: docs: fix typos (#23917)

---
 runtime/lua/vim/fs.lua     | 2 +-
 runtime/lua/vim/keymap.lua | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index 5e63fb6237..c89147dbd2 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -72,7 +72,7 @@ function M.basename(file)
   return file:match('[/\\]$') and '' or (file:match('[^\\/]*$'):gsub('\\', '/'))
 end
 
---- Concatenate directories and/or file into a single path with normalization
+--- Concatenate directories and/or file paths into a single path with normalization
 --- (e.g., `"foo/"` and `"bar"` get joined to `"foo/bar"`)
 ---
 ---@param ... string
diff --git a/runtime/lua/vim/keymap.lua b/runtime/lua/vim/keymap.lua
index 911b584c14..0d7fc3b1ec 100644
--- a/runtime/lua/vim/keymap.lua
+++ b/runtime/lua/vim/keymap.lua
@@ -6,7 +6,7 @@ local keymap = {}
 ---   -- Map to a Lua function:
 ---   vim.keymap.set('n', 'lhs', function() print("real lua function") end)
 ---   -- Map to multiple modes:
----   vim.keymap.set({'n', 'v'}, '<leader>lr', vim.lsp.buf.references, { buffer=true })
+---   vim.keymap.set({'n', 'v'}, '<leader>lr', vim.lsp.buf.references, { buffer = true })
 ---   -- Buffer-local mapping:
 ---   vim.keymap.set('n', '<leader>w', "<cmd>w<cr>", { silent = true, buffer = 5 })
 ---   -- Expr mapping:
-- 
cgit 


From b302da9ad220a7699d4b0ebf642529d142a0b9cf Mon Sep 17 00:00:00 2001
From: Raphael <glepnir@neovim.pro>
Date: Sun, 11 Jun 2023 02:32:41 +0800
Subject: fix(lsp): use percentage format on lsp.status (#23971)

---
 runtime/lua/vim/lsp.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 6ddbfc6df7..1d9a91801a 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -933,7 +933,7 @@ function lsp.status()
   end
   local message = table.concat(messages, ', ')
   if percentage then
-    return string.format('%03d: %s', percentage, message)
+    return string.format('%3d%%: %s', percentage, message)
   end
   return message
 end
-- 
cgit 


From 302d3cfb96d7f0c856262e1a4252d058e3300c8b Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sat, 10 Jun 2023 20:33:23 +0200
Subject: feat(lua): use callable table as iterator in vim.iter (#23957)

A table passed to `vim.iter` can be a class instance with a `__call`
implementation for the iterator protocol.
---
 runtime/lua/vim/iter.lua | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index 0e98d0437e..204d22b9be 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -14,6 +14,8 @@
 --- - Non-list tables pass both the key and value of each element
 --- - Function iterators pass all of the values returned by their respective
 ---   function
+--- - Tables with a metatable implementing __call are treated as function
+---   iterators
 ---
 --- Examples:
 --- <pre>lua
@@ -46,6 +48,12 @@
 ---     return k == 'z'
 ---   end)
 ---   -- true
+---
+---   local rb = vim.ringbuf(3)
+---   rb:push("a")
+---   rb:push("b")
+---   vim.iter(rb):totable()
+---   -- { "a", "b" }
 --- </pre>
 ---
 --- In addition to the |vim.iter()| function, the |vim.iter| module provides
@@ -889,6 +897,17 @@ end
 function Iter.new(src, ...)
   local it = {}
   if type(src) == 'table' then
+    local mt = getmetatable(src)
+    if mt and type(mt.__call) == 'function' then
+      ---@private
+      function it.next()
+        return src()
+      end
+
+      setmetatable(it, Iter)
+      return it
+    end
+
     local t = {}
 
     -- Check if source table can be treated like a list (indices are consecutive integers
-- 
cgit 


From cce9460524aa17bcd4daa095f4706220b81f8845 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sun, 11 Jun 2023 15:29:51 +0800
Subject: fix(remote): make --remote-expr print to stdout (#23980)

---
 runtime/lua/vim/_editor.lua | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index d46b0fbf32..dc396b8f65 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -932,7 +932,7 @@ function vim._cs_remote(rcid, server_addr, connect_error, args)
     or subcmd == 'tab-wait'
     or subcmd == 'tab-wait-silent'
   then
-    return { errmsg = 'E5600: Wait commands not yet implemented in nvim' }
+    return { errmsg = 'E5600: Wait commands not yet implemented in Nvim' }
   elseif subcmd == 'tab-silent' then
     f_tab = true
     f_silent = true
@@ -946,8 +946,9 @@ function vim._cs_remote(rcid, server_addr, connect_error, args)
     if rcid == 0 then
       return { errmsg = connection_failure_errmsg('Send expression failed.') }
     end
-    print(vim.fn.rpcrequest(rcid, 'nvim_eval', args[2]))
-    return { should_exit = true, tabbed = false }
+    local expr = 'string(' .. args[2] .. ')'
+    local res = vim.fn.rpcrequest(rcid, 'nvim_eval', expr)
+    return { result = res, should_exit = true, tabbed = false }
   elseif subcmd ~= '' then
     return { errmsg = 'Unknown option argument: ' .. args[1] }
   end
-- 
cgit 


From 643546b82b4bc0c29ca869f81af868a019723d83 Mon Sep 17 00:00:00 2001
From: Chinmay Dalal <dalal.chinmay.0101@gmail.com>
Date: Sun, 11 Jun 2023 15:23:37 +0530
Subject: feat(lsp): add handlers for inlay hints (#23736)

initial support; public API left for a follow-up PR
---
 runtime/lua/vim/lsp.lua             |  17 ++-
 runtime/lua/vim/lsp/_inlay_hint.lua | 217 ++++++++++++++++++++++++++++++++++++
 runtime/lua/vim/lsp/handlers.lua    |  26 +++++
 runtime/lua/vim/lsp/protocol.lua    |   9 ++
 runtime/lua/vim/lsp/types.lua       |  25 +++++
 5 files changed, 289 insertions(+), 5 deletions(-)
 create mode 100644 runtime/lua/vim/lsp/_inlay_hint.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 1d9a91801a..6f9a6c460b 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -17,6 +17,7 @@ local if_nil = vim.F.if_nil
 
 local lsp = {
   protocol = protocol,
+  _inlay_hint = require('vim.lsp._inlay_hint'),
 
   handlers = default_handlers,
 
@@ -60,6 +61,8 @@ lsp._request_name_to_capability = {
   ['textDocument/documentHighlight'] = { 'documentHighlightProvider' },
   ['textDocument/semanticTokens/full'] = { 'semanticTokensProvider' },
   ['textDocument/semanticTokens/full/delta'] = { 'semanticTokensProvider' },
+  ['textDocument/inlayHint'] = { 'inlayHintProvider' },
+  ['inlayHint/resolve'] = { 'inlayHintProvider', 'resolveProvider' },
 }
 
 -- TODO improve handling of scratch buffers with LSP attached.
@@ -1498,16 +1501,20 @@ function lsp.start_client(config)
     end
     -- Ensure pending didChange notifications are sent so that the server doesn't operate on a stale state
     changetracking.flush(client, bufnr)
+    local version = util.buf_versions[bufnr]
     bufnr = resolve_bufnr(bufnr)
     if log.debug() then
       log.debug(log_prefix, 'client.request', client_id, method, params, handler, bufnr)
     end
     local success, request_id = rpc.request(method, params, function(err, result)
-      handler(
-        err,
-        result,
-        { method = method, client_id = client_id, bufnr = bufnr, params = params }
-      )
+      local context = {
+        method = method,
+        client_id = client_id,
+        bufnr = bufnr,
+        params = params,
+        version = version,
+      }
+      handler(err, result, context)
     end, function(request_id)
       local request = client.requests[request_id]
       request.type = 'complete'
diff --git a/runtime/lua/vim/lsp/_inlay_hint.lua b/runtime/lua/vim/lsp/_inlay_hint.lua
new file mode 100644
index 0000000000..aa6ec9aca8
--- /dev/null
+++ b/runtime/lua/vim/lsp/_inlay_hint.lua
@@ -0,0 +1,217 @@
+local util = require('vim.lsp.util')
+local log = require('vim.lsp.log')
+local api = vim.api
+local M = {}
+
+---@class lsp._inlay_hint.bufstate
+---@field version integer
+---@field client_hint table<integer, table<integer, lsp.InlayHint[]>> client_id -> (lnum -> hints)
+
+---@type table<integer, lsp._inlay_hint.bufstate>
+local hint_cache_by_buf = setmetatable({}, {
+  __index = function(t, b)
+    local key = b > 0 and b or api.nvim_get_current_buf()
+    return rawget(t, key)
+  end,
+})
+
+local namespace = api.nvim_create_namespace('vim_lsp_inlayhint')
+
+M.__explicit_buffers = {}
+
+--- |lsp-handler| for the method `textDocument/inlayHint`
+--- Store hints for a specific buffer and client
+--- Resolves unresolved hints
+---@private
+function M.on_inlayhint(err, result, ctx, _)
+  if err then
+    local _ = log.error() and log.error('inlayhint', err)
+    return
+  end
+  local bufnr = ctx.bufnr
+  if util.buf_versions[bufnr] ~= ctx.version then
+    return
+  end
+  local client_id = ctx.client_id
+  if not result then
+    return
+  end
+  local bufstate = hint_cache_by_buf[bufnr]
+  if not bufstate then
+    bufstate = {
+      client_hint = vim.defaulttable(),
+      version = ctx.version,
+    }
+    hint_cache_by_buf[bufnr] = bufstate
+    api.nvim_buf_attach(bufnr, false, {
+      on_detach = function(_, b)
+        api.nvim_buf_clear_namespace(b, namespace, 0, -1)
+        hint_cache_by_buf[b] = nil
+      end,
+      on_reload = function(_, b)
+        api.nvim_buf_clear_namespace(b, namespace, 0, -1)
+        hint_cache_by_buf[b] = nil
+      end,
+    })
+  end
+  local hints_by_client = bufstate.client_hint
+  local client = vim.lsp.get_client_by_id(client_id)
+
+  local new_hints_by_lnum = vim.defaulttable()
+  local num_unprocessed = #result
+  if num_unprocessed == 0 then
+    hints_by_client[client_id] = {}
+    bufstate.version = ctx.version
+    api.nvim__buf_redraw_range(bufnr, 0, -1)
+    return
+  end
+
+  local lines = api.nvim_buf_get_lines(bufnr, 0, -1, false)
+  ---@private
+  local function pos_to_byte(position)
+    local col = position.character
+    if col > 0 then
+      local line = lines[position.line + 1] or ''
+      local ok, convert_result
+      ok, convert_result = pcall(util._str_byteindex_enc, line, col, client.offset_encoding)
+      if ok then
+        return convert_result
+      end
+      return math.min(#line, col)
+    end
+    return col
+  end
+
+  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)
+  end
+
+  hints_by_client[client_id] = new_hints_by_lnum
+  bufstate.version = ctx.version
+  api.nvim__buf_redraw_range(bufnr, 0, -1)
+end
+
+---@private
+local function resolve_bufnr(bufnr)
+  return bufnr == 0 and api.nvim_get_current_buf() or bufnr
+end
+
+--- Refresh inlay hints for a buffer
+---
+--- It is recommended to trigger this using an autocmd or via keymap.
+---@param opts (nil|table) Optional arguments
+---  - bufnr (integer, default: 0): Buffer whose hints to refresh
+---  - only_visible (boolean, default: false): Whether to only refresh hints for the visible regions of the buffer
+---
+--- Example:
+--- <pre>vim
+---   autocmd BufEnter,InsertLeave,BufWritePost <buffer> lua vim.lsp._inlay_hint.refresh()
+--- </pre>
+---
+---@private
+function M.refresh(opts)
+  opts = opts or {}
+  local bufnr = opts.bufnr or 0
+  local only_visible = opts.only_visible or false
+  bufnr = resolve_bufnr(bufnr)
+  M.__explicit_buffers[bufnr] = true
+  local buffer_windows = {}
+  for _, winid in ipairs(api.nvim_list_wins()) do
+    if api.nvim_win_get_buf(winid) == bufnr then
+      table.insert(buffer_windows, winid)
+    end
+  end
+  for _, window in ipairs(buffer_windows) do
+    local first = vim.fn.line('w0', window)
+    local last = vim.fn.line('w$', window)
+    local params = {
+      textDocument = util.make_text_document_params(bufnr),
+      range = {
+        start = { line = first - 1, character = 0 },
+        ['end'] = { line = last, character = 0 },
+      },
+    }
+    vim.lsp.buf_request(bufnr, 'textDocument/inlayHint', params)
+  end
+  if not only_visible then
+    local params = {
+      textDocument = util.make_text_document_params(bufnr),
+      range = {
+        start = { line = 0, character = 0 },
+        ['end'] = { line = api.nvim_buf_line_count(bufnr), character = 0 },
+      },
+    }
+    vim.lsp.buf_request(bufnr, 'textDocument/inlayHint', params)
+  end
+end
+
+--- Clear inlay hints
+---
+---@param client_id integer|nil filter by client_id. All clients if nil
+---@param bufnr integer|nil filter by buffer. All buffers if nil
+---@private
+function M.clear(client_id, bufnr)
+  local buffers = bufnr and { resolve_bufnr(bufnr) } or vim.tbl_keys(hint_cache_by_buf)
+  for _, iter_bufnr in ipairs(buffers) do
+    M.__explicit_buffers[iter_bufnr] = false
+    local bufstate = hint_cache_by_buf[iter_bufnr]
+    local client_lens = (bufstate or {}).client_hint or {}
+    local client_ids = client_id and { client_id } or vim.tbl_keys(client_lens)
+    for _, iter_client_id in ipairs(client_ids) do
+      if bufstate then
+        bufstate.client_hint[iter_client_id] = {}
+      end
+    end
+    api.nvim_buf_clear_namespace(iter_bufnr, namespace, 0, -1)
+  end
+  vim.cmd('redraw!')
+end
+
+api.nvim_set_decoration_provider(namespace, {
+  on_win = function(_, _, bufnr, topline, botline)
+    local bufstate = hint_cache_by_buf[bufnr]
+    if not bufstate then
+      return
+    end
+
+    if bufstate.version ~= util.buf_versions[bufnr] then
+      return
+    end
+    local hints_by_client = bufstate.client_hint
+    api.nvim_buf_clear_namespace(bufnr, namespace, 0, -1)
+
+    for lnum = topline, botline do
+      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
+          local text = ''
+          if type(hint.label) == 'string' then
+            text = hint.label
+          else
+            for _, part in ipairs(hint.label) do
+              text = text .. part.value
+            end
+          end
+          if hint.paddingLeft then
+            text = ' ' .. text
+          end
+          if hint.paddingRight then
+            text = text .. ' '
+          end
+          api.nvim_buf_set_extmark(bufnr, namespace, lnum, hint.position.character, {
+            virt_text_pos = 'inline',
+            ephemeral = false,
+            virt_text = {
+              { text, 'LspInlayHint' },
+            },
+            hl_mode = 'combine',
+          })
+        end
+      end
+    end
+  end,
+})
+
+return M
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 19338ae8f0..44a9a58aca 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -219,6 +219,10 @@ M['textDocument/codeLens'] = function(...)
   return require('vim.lsp.codelens').on_codelens(...)
 end
 
+M['textDocument/inlayHint'] = function(...)
+  return require('vim.lsp._inlay_hint').on_inlayhint(...)
+end
+
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_references
 M['textDocument/references'] = function(_, result, ctx, config)
   if not result or vim.tbl_isempty(result) then
@@ -612,6 +616,28 @@ M['window/showDocument'] = function(_, result, ctx, _)
   return { success = success or false }
 end
 
+---@see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspace_inlayHint_refresh
+M['workspace/inlayHint/refresh'] = function(err, _, ctx)
+  local inlay_hint = require('vim.lsp._inlay_hint')
+  if not inlay_hint.__explicit_buffers[ctx.bufnr] then
+    return vim.NIL
+  end
+  if err then
+    return vim.NIL
+  end
+
+  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
+        inlay_hint.refresh({ bufnr = bufnr })
+        break
+      end
+    end
+  end
+
+  return vim.NIL
+end
+
 -- Add boilerplate error validation and logging for all of these.
 for k, fn in pairs(M) do
   M[k] = function(err, result, ctx, config)
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 172d43e483..b3a7903420 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -641,6 +641,12 @@ function protocol.make_client_capabilities()
       },
     },
     textDocument = {
+      inlayHint = {
+        dynamicRegistration = false,
+        resolveSupport = {
+          properties = {},
+        },
+      },
       semanticTokens = {
         dynamicRegistration = false,
         tokenTypes = {
@@ -853,6 +859,9 @@ function protocol.make_client_capabilities()
         dynamicRegistration = true,
         relativePatternSupport = true,
       },
+      inlayHint = {
+        refreshSupport = true,
+      },
     },
     experimental = nil,
     window = {
diff --git a/runtime/lua/vim/lsp/types.lua b/runtime/lua/vim/lsp/types.lua
index ef85a0d10f..108aeeb922 100644
--- a/runtime/lua/vim/lsp/types.lua
+++ b/runtime/lua/vim/lsp/types.lua
@@ -69,3 +69,28 @@
 --- @field method string
 
 --- @alias lsp.UnregistrationParams {unregisterations: lsp.Unregistration[]}
+
+---@class lsp.Location
+---@field uri string
+---@field range lsp.Range
+
+---@class lsp.MarkupContent
+---@field kind string
+---@field value string
+
+---@class lsp.InlayHintLabelPart
+---@field value string
+---@field tooltip? string | lsp.MarkupContent
+---@field location? lsp.Location
+
+---@class lsp.TextEdit
+---@field range lsp.Range
+---@field newText string
+
+---@class lsp.InlayHint
+---@field position lsp.Position
+---@field label string | lsp.InlayHintLabelPart[]
+---@field kind? integer
+---@field textEdits? lsp.TextEdit[]
+---@field paddingLeft? boolean
+---@field paddingRight? boolean
-- 
cgit 


From bde59e81473f29944ef80ff98f6b2c88010b2df6 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sun, 11 Jun 2023 22:12:32 +0800
Subject: fix(remote): restore previous --remote-expr output formatting
 (#23988)

- Use tostring() as that's what print() uses internally.
- Do not append trailing new line.
---
 runtime/lua/vim/_editor.lua | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index dc396b8f65..1c7eb30b03 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -940,14 +940,13 @@ function vim._cs_remote(rcid, server_addr, connect_error, args)
     if rcid == 0 then
       return { errmsg = connection_failure_errmsg('Send failed.') }
     end
-    vim.fn.rpcrequest(rcid, 'nvim_input', args[2])
+    vim.rpcrequest(rcid, 'nvim_input', args[2])
     return { should_exit = true, tabbed = false }
   elseif subcmd == 'expr' then
     if rcid == 0 then
       return { errmsg = connection_failure_errmsg('Send expression failed.') }
     end
-    local expr = 'string(' .. args[2] .. ')'
-    local res = vim.fn.rpcrequest(rcid, 'nvim_eval', expr)
+    local res = tostring(vim.rpcrequest(rcid, 'nvim_eval', args[2]))
     return { result = res, should_exit = true, tabbed = false }
   elseif subcmd ~= '' then
     return { errmsg = 'Unknown option argument: ' .. args[1] }
-- 
cgit 


From ceb37ff1d83c6dc341dc43d3dc8c81f657bc9484 Mon Sep 17 00:00:00 2001
From: Stephan Seitz <sseitz@nvidia.com>
Date: Sun, 11 Jun 2023 23:46:22 +0200
Subject: refactor(treesitter): use npcall in _query_linter.lua #23985

---
 runtime/lua/vim/treesitter/_query_linter.lua | 12 +++---------
 1 file changed, 3 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_query_linter.lua b/runtime/lua/vim/treesitter/_query_linter.lua
index ecdee5fc95..3dd0177a81 100644
--- a/runtime/lua/vim/treesitter/_query_linter.lua
+++ b/runtime/lua/vim/treesitter/_query_linter.lua
@@ -53,10 +53,7 @@ end
 local function guess_query_lang(buf)
   local filename = api.nvim_buf_get_name(buf)
   if filename ~= '' then
-    local ok, query_lang = pcall(vim.fn.fnamemodify, filename, ':p:h:t')
-    if ok then
-      return query_lang
-    end
+    return vim.F.npcall(vim.fn.fnamemodify, filename, ':p:h:t')
   end
 end
 
@@ -270,11 +267,8 @@ function M.lint(buf, opts)
   for i = 1, math.max(1, #opts.langs) do
     local lang = opts.langs[i]
 
-    --- @type boolean, (table|nil)
-    local ok, parser_info = pcall(vim.treesitter.language.inspect, lang)
-    if not ok then
-      parser_info = nil
-    end
+    --- @type (table|nil)
+    local parser_info = vim.F.npcall(vim.treesitter.language.inspect, lang)
 
     local parser = vim.treesitter.get_parser(buf)
     parser:parse()
-- 
cgit 


From ecdb6465e272119f80f3b68a6695e0f74b02ca49 Mon Sep 17 00:00:00 2001
From: Gianmaria Bajo <mg1979.git@gmail.com>
Date: Wed, 7 Jun 2023 14:28:44 +0200
Subject: feat: vim.version() returns a Version object

- vim.version() returns a Version object.
  Makes it printable and removes the need of workarounds when passing it
  to other vim.version methods.
---
 runtime/lua/vim/version.lua | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index d4a3752e37..5578423453 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -226,13 +226,11 @@ function Range:has(version)
   if type(version) == 'string' then
     ---@diagnostic disable-next-line: cast-local-type
     version = M.parse(version)
-  else
+  elseif getmetatable(version) ~= Version then
     -- Need metatable to compare versions.
     version = setmetatable(vim.deepcopy(version), Version)
   end
   if version then
-    -- Workaround: vim.version() reports "prerelease" as a boolean.
-    version.prerelease = version.prerelease or nil
     if version.prerelease ~= self.from.prerelease then
       return false
     end
@@ -423,8 +421,12 @@ function M.parse(version, opts)
 end
 
 setmetatable(M, {
+  --- Returns the current Nvim version.
   __call = function()
-    return vim.fn.api_info().version
+    local version = vim.fn.api_info().version
+    -- Workaround: vim.fn.api_info().version reports "prerelease" as a boolean.
+    version.prerelease = version.prerelease or nil
+    return setmetatable(version, Version)
   end,
 })
 
-- 
cgit 


From d3b9feccb39124cefbe4b0c492fb0bc3f777d0b4 Mon Sep 17 00:00:00 2001
From: Stanislav Asunkin <1353637+stasjok@users.noreply.github.com>
Date: Mon, 12 Jun 2023 01:48:13 +0300
Subject: docs: fix vim.tbl_get type annotations #23992

---
 runtime/lua/vim/shared.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index f899157ab7..dd05299295 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -456,7 +456,7 @@ end
 --- </pre>
 ---
 ---@param o table Table to index
----@param ... string Optional strings (0 or more, variadic) via which to index the table
+---@param ... any Optional keys (0 or more, variadic) via which to index the table
 ---
 ---@return any Nested value indexed by key (if it exists), else nil
 function vim.tbl_get(o, ...)
-- 
cgit 


From e6887932539315e02621edb77d5e77c7c2a0b033 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Mon, 12 Jun 2023 01:14:33 +0200
Subject: feat: tostring(vim.version())
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Problem:
tostring(vim.version()) returns "table: 0x…".

Solution:
Modify vim.version() to return a string prerelease instead of a boolean.

Fix #23863
---
 runtime/lua/vim/version.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index 5578423453..92250ff1f8 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -425,7 +425,7 @@ setmetatable(M, {
   __call = function()
     local version = vim.fn.api_info().version
     -- Workaround: vim.fn.api_info().version reports "prerelease" as a boolean.
-    version.prerelease = version.prerelease or nil
+    version.prerelease = version.prerelease and 'dev' or nil
     return setmetatable(version, Version)
   end,
 })
-- 
cgit 


From 0eb02ea90a5a7c2e35bfcf99b701a28ff2901b4b Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 12 Jun 2023 20:08:08 +0800
Subject: docs: various clarifications (#23999)

Close #18907
Close #20314
Close #23749
---
 runtime/lua/vim/_editor.lua | 4 ++--
 runtime/lua/vim/keymap.lua  | 8 ++++----
 2 files changed, 6 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 1c7eb30b03..1de2ade1a1 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -534,9 +534,9 @@ function vim.region(bufnr, pos1, pos2, regtype, inclusive)
   return region
 end
 
---- Defers calling `fn` until `timeout` ms passes.
+--- Defers calling {fn} until {timeout} ms passes.
 ---
---- Use to do a one-shot timer that calls `fn`
+--- Use to do a one-shot timer that calls {fn}
 --- Note: The {fn} is |vim.schedule_wrap()|ped automatically, so API functions are
 --- safe to call.
 ---@param fn function Callback to call once `timeout` expires
diff --git a/runtime/lua/vim/keymap.lua b/runtime/lua/vim/keymap.lua
index 0d7fc3b1ec..9dbc65afe8 100644
--- a/runtime/lua/vim/keymap.lua
+++ b/runtime/lua/vim/keymap.lua
@@ -27,9 +27,9 @@ local keymap = {}
 ---                        - "replace_keycodes" defaults to `true` if "expr" is `true`.
 ---                        - "noremap": inverse of "remap" (see below).
 ---                      - Also accepts:
----                        - "buffer" number|boolean Creates buffer-local mapping, `0` or `true`
+---                        - "buffer": (number|boolean) Creates buffer-local mapping, `0` or `true`
 ---                        for current buffer.
----                        - remap: (boolean) Make the mapping recursive. Inverses "noremap".
+---                        - "remap": (boolean) Make the mapping recursive. Inverse of "noremap".
 ---                        Defaults to `false`.
 ---@see |nvim_set_keymap()|
 function keymap.set(mode, lhs, rhs, opts)
@@ -83,8 +83,8 @@ end
 ---   vim.keymap.del({'n', 'i', 'v'}, '<leader>w', { buffer = 5 })
 --- </pre>
 ---@param opts table|nil A table of optional arguments:
----                      - buffer: (number or boolean) Remove a mapping from the given buffer.
----                      When "true" or 0, use the current buffer.
+---                      - "buffer": (number|boolean) Remove a mapping from the given buffer.
+---                        When `0` or `true`, use the current buffer.
 ---@see |vim.keymap.set()|
 ---
 function keymap.del(modes, lhs, opts)
-- 
cgit 


From 91f67fabe69f5e3be19f37709261ea7abaa1a3cd Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Tue, 13 Jun 2023 16:53:13 +0200
Subject: fix(lsp): handle stale bufnr on LspRequest autocmd trigger (#24013)

Fixes a `Invalid buffer id: 123` race when the buffer gets deleted before
the callback triggered.

Alternative to https://github.com/neovim/neovim/pull/23981
---
 runtime/lua/vim/lsp.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 6f9a6c460b..9118e7e2e1 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1519,7 +1519,7 @@ function lsp.start_client(config)
       local request = client.requests[request_id]
       request.type = 'complete'
       nvim_exec_autocmds('LspRequest', {
-        buffer = bufnr,
+        buffer = api.nvim_buf_is_valid(bufnr) and bufnr or nil,
         modeline = false,
         data = { client_id = client_id, request_id = request_id, request = request },
       })
-- 
cgit 


From bc67bbe4469b777a958f5ad515dec777777e9f2d Mon Sep 17 00:00:00 2001
From: Rohit Sukumaran <rohit.sukumaran8@gmail.com>
Date: Tue, 13 Jun 2023 20:47:35 +0530
Subject: fix(codelens): add buffer and line checks before displaying codelens
 (#23887)

Co-authored-by: Rohit Sukumaran <rohit.sukumaran@kredx.com>
---
 runtime/lua/vim/lsp/codelens.lua | 29 +++++++++++++++++++++--------
 1 file changed, 21 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/codelens.lua b/runtime/lua/vim/lsp/codelens.lua
index ea8c52c334..e26bdcc6d4 100644
--- a/runtime/lua/vim/lsp/codelens.lua
+++ b/runtime/lua/vim/lsp/codelens.lua
@@ -136,6 +136,10 @@ end
 ---@param bufnr integer
 ---@param client_id integer
 function M.display(lenses, bufnr, client_id)
+  if not api.nvim_buf_is_loaded(bufnr) then
+    return
+  end
+
   local ns = namespaces[client_id]
   if not lenses or not next(lenses) then
     api.nvim_buf_clear_namespace(bufnr, ns, 0, -1)
@@ -181,6 +185,10 @@ end
 ---@param bufnr integer
 ---@param client_id integer
 function M.save(lenses, bufnr, client_id)
+  if not api.nvim_buf_is_loaded(bufnr) then
+    return
+  end
+
   local lenses_by_client = lens_cache_by_buf[bufnr]
   if not lenses_by_client then
     lenses_by_client = {}
@@ -221,19 +229,24 @@ local function resolve_lenses(lenses, bufnr, client_id, callback)
       countdown()
     else
       client.request('codeLens/resolve', lens, function(_, result)
-        if result and result.command then
+        if api.nvim_buf_is_loaded(bufnr) and result and result.command then
           lens.command = result.command
           -- Eager display to have some sort of incremental feedback
           -- Once all lenses got resolved there will be a full redraw for all lenses
           -- So that multiple lens per line are properly displayed
-          api.nvim_buf_set_extmark(
-            bufnr,
-            ns,
-            lens.range.start.line,
-            0,
-            { virt_text = { { lens.command.title, 'LspCodeLens' } }, hl_mode = 'combine' }
-          )
+
+          local num_lines = api.nvim_buf_line_count(bufnr)
+          if lens.range.start.line <= num_lines then
+            api.nvim_buf_set_extmark(
+              bufnr,
+              ns,
+              lens.range.start.line,
+              0,
+              { virt_text = { { lens.command.title, 'LspCodeLens' } }, hl_mode = 'combine' }
+            )
+          end
         end
+
         countdown()
       end, bufnr)
     end
-- 
cgit 


From 79a5b89d66db74560e751561542064674e980146 Mon Sep 17 00:00:00 2001
From: Jon Huhn <nojnhuh@users.noreply.github.com>
Date: Wed, 14 Jun 2023 05:40:11 -0500
Subject: perf(lsp): reduce polling handles for workspace/didChangeWatchedFiles
 (#23500)

Co-authored-by: Lewis Russell <lewis6991@gmail.com>
---
 runtime/lua/vim/_watch.lua          | 73 ++++++++++++++++++++++++++++---------
 runtime/lua/vim/lsp/_watchfiles.lua | 52 +++++++++++++++++---------
 2 files changed, 91 insertions(+), 34 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_watch.lua b/runtime/lua/vim/_watch.lua
index 3bd8a56f6e..d489cef9fc 100644
--- a/runtime/lua/vim/_watch.lua
+++ b/runtime/lua/vim/_watch.lua
@@ -11,6 +11,7 @@ M.FileChangeType = vim.tbl_add_reverse_lookup({
 --- Joins filepath elements by static '/' separator
 ---
 ---@param ... (string) The path elements.
+---@return string
 local function filepath_join(...)
   return table.concat({ ... }, '/')
 end
@@ -36,7 +37,7 @@ end
 ---     - uvflags (table|nil)
 ---                Same flags as accepted by |uv.fs_event_start()|
 ---@param callback (function) The function called when new events
----@returns (function) A function to stop the watch
+---@return (function) A function to stop the watch
 function M.watch(path, opts, callback)
   vim.validate({
     path = { path, 'string', false },
@@ -75,10 +76,25 @@ end
 
 local default_poll_interval_ms = 2000
 
+--- @class watch.Watches
+--- @field is_dir boolean
+--- @field children? table<string,watch.Watches>
+--- @field cancel? fun()
+--- @field started? boolean
+--- @field handle? uv_fs_poll_t
+
+--- @class watch.PollOpts
+--- @field interval? integer
+--- @field include_pattern? userdata
+--- @field exclude_pattern? userdata
+
 ---@private
 --- Implementation for poll, hiding internally-used parameters.
 ---
----@param watches (table|nil) A tree structure to maintain state for recursive watches.
+---@param path string
+---@param opts watch.PollOpts
+---@param callback fun(patch: string, filechangetype: integer)
+---@param watches (watch.Watches|nil) A tree structure to maintain state for recursive watches.
 ---     - handle (uv_fs_poll_t)
 ---               The libuv handle
 ---     - cancel (function)
@@ -88,15 +104,36 @@ local default_poll_interval_ms = 2000
 ---               be invoked recursively)
 ---     - children (table|nil)
 ---               A mapping of directory entry name to its recursive watches
---      - started (boolean|nil)
---                Whether or not the watcher has first been initialized. Used
---                to prevent a flood of Created events on startup.
+---     - started (boolean|nil)
+---               Whether or not the watcher has first been initialized. Used
+---               to prevent a flood of Created events on startup.
+---@return fun() Cancel function
 local function poll_internal(path, opts, callback, watches)
   path = vim.fs.normalize(path)
   local interval = opts and opts.interval or default_poll_interval_ms
   watches = watches or {
     is_dir = true,
   }
+  watches.cancel = function()
+    if watches.children then
+      for _, w in pairs(watches.children) do
+        w.cancel()
+      end
+    end
+    if watches.handle then
+      stop(watches.handle)
+    end
+  end
+
+  local function incl_match()
+    return not opts.include_pattern or opts.include_pattern:match(path) ~= nil
+  end
+  local function excl_match()
+    return opts.exclude_pattern and opts.exclude_pattern:match(path) ~= nil
+  end
+  if not watches.is_dir and not incl_match() or excl_match() then
+    return watches.cancel
+  end
 
   if not watches.handle then
     local poll, new_err = vim.uv.new_fs_poll()
@@ -120,18 +157,9 @@ local function poll_internal(path, opts, callback, watches)
     end
   end
 
-  watches.cancel = function()
-    if watches.children then
-      for _, w in pairs(watches.children) do
-        w.cancel()
-      end
-    end
-    stop(watches.handle)
-  end
-
   if watches.is_dir then
     watches.children = watches.children or {}
-    local exists = {}
+    local exists = {} --- @type table<string,true>
     for name, ftype in vim.fs.dir(path) do
       exists[name] = true
       if not watches.children[name] then
@@ -143,14 +171,16 @@ local function poll_internal(path, opts, callback, watches)
       end
     end
 
-    local newchildren = {}
+    local newchildren = {} ---@type table<string,watch.Watches>
     for name, watch in pairs(watches.children) do
       if exists[name] then
         newchildren[name] = watch
       else
         watch.cancel()
         watches.children[name] = nil
-        callback(path .. '/' .. name, M.FileChangeType.Deleted)
+        if watch.handle then
+          callback(path .. '/' .. name, M.FileChangeType.Deleted)
+        end
       end
     end
     watches.children = newchildren
@@ -168,6 +198,15 @@ end
 ---@param opts (table|nil) Additional options
 ---     - interval (number|nil)
 ---                Polling interval in ms as passed to |uv.fs_poll_start()|. Defaults to 2000.
+---     - include_pattern (LPeg pattern|nil)
+---                An |lpeg| pattern. Only changes to files whose full paths match the pattern
+---                will be reported. Only matches against non-directoriess, all directories will
+---                be watched for new potentially-matching files. exclude_pattern can be used to
+---                filter out directories. When nil, matches any file name.
+---     - exclude_pattern (LPeg pattern|nil)
+---                An |lpeg| pattern. Only changes to files and directories whose full path does
+---                not match the pattern will be reported. Matches against both files and
+---                directories. When nil, matches nothing.
 ---@param callback (function) The function called when new events
 ---@returns (function) A function to stop the watch.
 function M.poll(path, opts, callback)
diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
index 14e5dc6cf8..87938fe4d5 100644
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -1,7 +1,7 @@
 local bit = require('bit')
-local lpeg = require('lpeg')
 local watch = require('vim._watch')
 local protocol = require('vim.lsp.protocol')
+local lpeg = vim.lpeg
 
 local M = {}
 
@@ -107,6 +107,13 @@ local to_lsp_change_type = {
   [watch.FileChangeType.Deleted] = protocol.FileChangeType.Deleted,
 }
 
+--- Default excludes the same as VSCode's `files.watcherExclude` setting.
+--- https://github.com/microsoft/vscode/blob/eef30e7165e19b33daa1e15e92fa34ff4a5df0d3/src/vs/workbench/contrib/files/browser/files.contribution.ts#L261
+---@type Lpeg pattern
+M._poll_exclude_pattern = parse('**/.git/{objects,subtree-cache}/**')
+  + parse('**/node_modules/*/**')
+  + parse('**/.hg/store/**')
+
 --- Registers the workspace/didChangeWatchedFiles capability dynamically.
 ---
 ---@param reg table LSP Registration object.
@@ -122,10 +129,10 @@ function M.register(reg, ctx)
   then
     return
   end
-  local watch_regs = {}
+  local watch_regs = {} --- @type table<string,{pattern:userdata,kind:integer}>
   for _, w in ipairs(reg.registerOptions.watchers) do
     local relative_pattern = false
-    local glob_patterns = {}
+    local glob_patterns = {} --- @type {baseUri:string, pattern: string}[]
     if type(w.globPattern) == 'string' then
       for _, folder in ipairs(client.workspace_folders) do
         table.insert(glob_patterns, { baseUri = folder.uri, pattern = w.globPattern })
@@ -135,7 +142,7 @@ function M.register(reg, ctx)
       table.insert(glob_patterns, w.globPattern)
     end
     for _, glob_pattern in ipairs(glob_patterns) do
-      local base_dir = nil
+      local base_dir = nil ---@type string?
       if type(glob_pattern.baseUri) == 'string' then
         base_dir = glob_pattern.baseUri
       elseif type(glob_pattern.baseUri) == 'table' then
@@ -144,6 +151,7 @@ function M.register(reg, ctx)
       assert(base_dir, "couldn't identify root of watch")
       base_dir = vim.uri_to_fname(base_dir)
 
+      ---@type integer
       local kind = w.kind
         or protocol.WatchKind.Create + protocol.WatchKind.Change + protocol.WatchKind.Delete
 
@@ -153,8 +161,8 @@ function M.register(reg, ctx)
         pattern = lpeg.P(base_dir .. '/') * pattern
       end
 
-      table.insert(watch_regs, {
-        base_dir = base_dir,
+      watch_regs[base_dir] = watch_regs[base_dir] or {}
+      table.insert(watch_regs[base_dir], {
         pattern = pattern,
         kind = kind,
       })
@@ -163,12 +171,12 @@ function M.register(reg, ctx)
 
   local callback = function(base_dir)
     return function(fullpath, change_type)
-      for _, w in ipairs(watch_regs) do
+      for _, w in ipairs(watch_regs[base_dir]) do
         change_type = to_lsp_change_type[change_type]
         -- e.g. match kind with Delete bit (0b0100) to Delete change_type (3)
         local kind_mask = bit.lshift(1, change_type - 1)
         local change_type_match = bit.band(w.kind, kind_mask) == kind_mask
-        if base_dir == w.base_dir and M._match(w.pattern, fullpath) and change_type_match then
+        if M._match(w.pattern, fullpath) and change_type_match then
           local change = {
             uri = vim.uri_from_fname(fullpath),
             type = change_type,
@@ -198,15 +206,25 @@ function M.register(reg, ctx)
     end
   end
 
-  local watching = {}
-  for _, w in ipairs(watch_regs) do
-    if not watching[w.base_dir] then
-      watching[w.base_dir] = true
-      table.insert(
-        cancels[client_id][reg.id],
-        M._watchfunc(w.base_dir, { uvflags = { recursive = true } }, callback(w.base_dir))
-      )
-    end
+  for base_dir, watches in pairs(watch_regs) do
+    local include_pattern = vim.iter(watches):fold(lpeg.P(false), function(acc, w)
+      return acc + w.pattern
+    end)
+
+    table.insert(
+      cancels[client_id][reg.id],
+      M._watchfunc(base_dir, {
+        uvflags = {
+          recursive = true,
+        },
+        -- include_pattern will ensure the pattern from *any* watcher definition for the
+        -- base_dir matches. This first pass prevents polling for changes to files that
+        -- will never be sent to the LSP server. A second pass in the callback is still necessary to
+        -- match a *particular* pattern+kind pair.
+        include_pattern = include_pattern,
+        exclude_pattern = M._poll_exclude_pattern,
+      }, callback(base_dir))
+    )
   end
 end
 
-- 
cgit 


From c07dceba335c56c9a356395ad0d1e5a14d416752 Mon Sep 17 00:00:00 2001
From: Jonas Strittmatter <40792180+smjonas@users.noreply.github.com>
Date: Sat, 17 Jun 2023 08:01:31 +0200
Subject: fix(lsp): allow Lua pattern chars in code action filter (#24041)

Previously, filtering code actions with the "only" option failed
if the code action kind contained special Lua pattern chars such as "-"
(e.g. the ocaml language server supports a "type-annotate" code action).

Solution: use string comparison instead of string.find
---
 runtime/lua/vim/lsp/buf.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index bb3ca0e6d6..e0034cf86e 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -608,9 +608,9 @@ local function on_code_action_results(results, ctx, options)
       end
       local found = false
       for _, o in ipairs(options.context.only) do
-        -- action kinds are hierarchical with . as a separator: when requesting only
-        -- 'quickfix' this filter allows both 'quickfix' and 'quickfix.foo', for example
-        if a.kind:find('^' .. o .. '$') or a.kind:find('^' .. o .. '%.') then
+        -- action kinds are hierarchical with . as a separator: when requesting only 'type-annotate'
+        -- this filter allows both 'type-annotate' and 'type-annotate.foo', for example
+        if a.kind == o or vim.startswith(a.kind, o .. '.') then
           found = true
           break
         end
-- 
cgit 


From 8a7e3353eb5bffb10015254917361266b4b20511 Mon Sep 17 00:00:00 2001
From: Evgeni Chasnovski <evgeni.chasnovski@gmail.com>
Date: Sun, 18 Jun 2023 14:49:33 +0300
Subject: fix(fs): make `normalize()` work with '/' path (#24047)

Problem: Current implementation of "remove trailing /" doesn't
account for the case of literal '/' as path.
Solution: Remove trailing / only if it preceded by something else.

Co-authored by: notomo <notomo.motono@gmail.com>
---
 runtime/lua/vim/fs.lua | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index c89147dbd2..cdb314fa3d 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -348,9 +348,7 @@ function M.normalize(path, opts)
     path = path:gsub('%$([%w_]+)', vim.uv.os_getenv)
   end
 
-  path = path:gsub('\\', '/'):gsub('/+', '/')
-
-  return path:sub(-1) == '/' and path:sub(1, -2) or path
+  return (path:gsub('\\', '/'):gsub('/+', '/'):gsub('(.)/$', '%1'))
 end
 
 return M
-- 
cgit 


From 8c9dab3e0d788d44c8a2fee83a6193f5955c814e Mon Sep 17 00:00:00 2001
From: Santos Gallegos <stsewd@proton.me>
Date: Sun, 18 Jun 2023 09:42:17 -0500
Subject: fix(treesitter): use vim.highlight.priorities instead of hardcoded
 100 (#24052)

Problem: Treesitter highlighting base priority cannot be customized.

Solution: Use `vim.highlight.priorities.treesitter` instead of hard-coded value.
---
 runtime/lua/vim/treesitter/highlighter.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index 4bb764c5c6..d4db6bc404 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -260,12 +260,14 @@ local function on_line_impl(self, buf, line, is_spell_nav)
       local spell_pri_offset = capture_name == 'nospell' and 1 or 0
 
       if hl and end_row >= line and (not is_spell_nav or spell ~= nil) then
+        local priority = (tonumber(metadata.priority) or vim.highlight.priorities.treesitter)
+          + spell_pri_offset
         api.nvim_buf_set_extmark(buf, ns, start_row, start_col, {
           end_line = end_row,
           end_col = end_col,
           hl_group = hl,
           ephemeral = true,
-          priority = (tonumber(metadata.priority) or 100) + spell_pri_offset, -- Low but leaves room below
+          priority = priority,
           conceal = metadata.conceal,
           spell = spell,
         })
-- 
cgit 


From cee981bf09c81ab4b2fe6facf45076ea4bac46a5 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Mon, 19 Jun 2023 02:24:44 -0700
Subject: docs #22363

Co-authored by: zeertzjq <zeertzjq@outlook.com>
Co-authored by: Steven Todd McIntyre II <114119064+stmii@users.noreply.github.com>
Co-authored by: nobe4 <nobe4@users.noreply.github.com>

- docs: mention --luadev-mod to run with lua runtime files
  When changing a lua file in the ./runtime folder, a new contributor
  might expect changes to be applied to the built Neovim binary.
---
 runtime/lua/vim/iter.lua | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index 204d22b9be..9c7bd13164 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -1,7 +1,8 @@
 ---@defgroup lua-iter
 ---
---- The \*vim.iter\* module provides a generic "iterator" interface over tables
---- and iterator functions.
+--- @brief The \*vim.iter\* module provides a generic interface for working with
+--- iterables: tables, lists, iterator functions, pair()/ipair()-like iterators,
+--- and \`vim.iter()\` objects.
 ---
 --- \*vim.iter()\* wraps its table or function argument into an \*Iter\* object
 --- with methods (such as |Iter:filter()| and |Iter:map()|) that transform the
-- 
cgit 


From 72a6643b1380cdf6f1153d70eeaffb90bdca30d6 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Mon, 19 Jun 2023 08:40:33 -0700
Subject: docs #24061

- nvim requires rpc responses in reverse order. https://github.com/neovim/neovim/issues/19932
- NVIM_APPNAME: UIs normally should NOT set this.

ref #23520
fix #24050
fix #23660
fix #23353
fix #23337
fix #22213
fix #19161
fix #18088
fix #20693
---
 runtime/lua/vim/lsp.lua | 31 ++++++++++++++-----------------
 1 file changed, 14 insertions(+), 17 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 9118e7e2e1..761a8406f2 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1491,7 +1491,7 @@ function lsp.start_client(config)
   ---successful, then it will return {request_id} as the
   ---second result. You can use this with `client.cancel_request(request_id)`
   ---to cancel the-request.
-  ---@see |vim.lsp.buf_request()|
+  ---@see |vim.lsp.buf_request_all()|
   function client.request(method, params, handler, bufnr)
     if not handler then
       handler = assert(
@@ -2119,22 +2119,19 @@ function lsp.buf_request(bufnr, method, params, handler)
   return client_request_ids, _cancel_all_requests
 end
 
----Sends an async request for all active clients attached to the buffer.
----Executes the callback on the combined result.
----Parameters are the same as |vim.lsp.buf_request()| but the return result and callback are
----different.
+--- Sends an async request for all active clients attached to the buffer and executes the `handler`
+--- callback with the combined result.
 ---
 ---@param bufnr (integer) Buffer handle, or 0 for current.
 ---@param method (string) LSP method name
 ---@param params (table|nil) Parameters to send to the server
----@param callback fun(request_results: table<integer, {error: lsp.ResponseError, result: any}>) (function)
---- The callback to call when all requests are finished.
---- Unlike `buf_request`, this will collect all the responses from each server instead of handling them.
---- A map of client_id:request_result will be provided to the callback.
----
----@return fun() cancel A function that will cancel all requests
-function lsp.buf_request_all(bufnr, method, params, callback)
-  local request_results = {}
+---@param handler fun(results: table<integer, {error: lsp.ResponseError, result: any}>) (function)
+--- Handler called after all requests are completed. Server results are passed as
+--- a `client_id:result` map.
+---
+---@return fun() cancel Function that cancels all requests.
+function lsp.buf_request_all(bufnr, method, params, handler)
+  local results = {}
   local result_count = 0
   local expected_result_count = 0
 
@@ -2147,12 +2144,12 @@ function lsp.buf_request_all(bufnr, method, params, callback)
   end)
 
   local function _sync_handler(err, result, ctx)
-    request_results[ctx.client_id] = { error = err, result = result }
+    results[ctx.client_id] = { error = err, result = result }
     result_count = result_count + 1
     set_expected_result_count()
 
     if result_count >= expected_result_count then
-      callback(request_results)
+      handler(results)
     end
   end
 
@@ -2164,8 +2161,8 @@ end
 --- Sends a request to all server and waits for the response of all of them.
 ---
 --- Calls |vim.lsp.buf_request_all()| but blocks Nvim while awaiting the result.
---- Parameters are the same as |vim.lsp.buf_request()| but the return result is
---- different. Wait maximum of {timeout_ms} (default 1000) ms.
+--- Parameters are the same as |vim.lsp.buf_request_all()| but the result is
+--- different. Waits a maximum of {timeout_ms} (default 1000) ms.
 ---
 ---@param bufnr (integer) Buffer handle, or 0 for current.
 ---@param method (string) LSP method name
-- 
cgit 


From ca5de9306c00d07cce1daef1f0038c937098bc66 Mon Sep 17 00:00:00 2001
From: Chinmay Dalal <dalal.chinmay.0101@gmail.com>
Date: Tue, 20 Jun 2023 11:36:54 +0530
Subject: feat(lsp): inlay hints #23984

Add automatic refresh and a public interface on top of #23736

 * add on_reload, on_detach handlers in `enable()` buf_attach, and
  LspDetach autocommand in case of manual detach
* unify `__buffers` and `hint_cache_by_buf`
* use callback bufnr in `on_lines` callback, bufstate: remove __index override
* move user-facing functions into vim.lsp.buf, unify enable/disable/toggle

Closes #18086
---
 runtime/lua/vim/lsp.lua             |   1 -
 runtime/lua/vim/lsp/_inlay_hint.lua | 164 +++++++++++++++++++++++++-----------
 runtime/lua/vim/lsp/buf.lua         |  15 ++++
 runtime/lua/vim/lsp/handlers.lua    |   3 -
 4 files changed, 131 insertions(+), 52 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 761a8406f2..917aeb6604 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -17,7 +17,6 @@ local if_nil = vim.F.if_nil
 
 local lsp = {
   protocol = protocol,
-  _inlay_hint = require('vim.lsp._inlay_hint'),
 
   handlers = default_handlers,
 
diff --git a/runtime/lua/vim/lsp/_inlay_hint.lua b/runtime/lua/vim/lsp/_inlay_hint.lua
index aa6ec9aca8..70d332a1ac 100644
--- a/runtime/lua/vim/lsp/_inlay_hint.lua
+++ b/runtime/lua/vim/lsp/_inlay_hint.lua
@@ -6,22 +6,30 @@ local M = {}
 ---@class lsp._inlay_hint.bufstate
 ---@field version integer
 ---@field client_hint table<integer, table<integer, lsp.InlayHint[]>> client_id -> (lnum -> hints)
+---@field enabled boolean Whether inlay hints are enabled for the buffer
+---@field timer uv.uv_timer_t? Debounce timer associated with the buffer
 
 ---@type table<integer, lsp._inlay_hint.bufstate>
-local hint_cache_by_buf = setmetatable({}, {
-  __index = function(t, b)
-    local key = b > 0 and b or api.nvim_get_current_buf()
-    return rawget(t, key)
-  end,
-})
+local bufstates = {}
 
 local namespace = api.nvim_create_namespace('vim_lsp_inlayhint')
+local augroup = api.nvim_create_augroup('vim_lsp_inlayhint', {})
 
-M.__explicit_buffers = {}
+--- Reset the request debounce timer of a buffer
+---@private
+local function reset_timer(reset_bufnr)
+  local timer = bufstates[reset_bufnr].timer
+  if timer then
+    bufstates[reset_bufnr].timer = nil
+    if not timer:is_closing() then
+      timer:stop()
+      timer:close()
+    end
+  end
+end
 
 --- |lsp-handler| for the method `textDocument/inlayHint`
 --- Store hints for a specific buffer and client
---- Resolves unresolved hints
 ---@private
 function M.on_inlayhint(err, result, ctx, _)
   if err then
@@ -36,21 +44,20 @@ function M.on_inlayhint(err, result, ctx, _)
   if not result then
     return
   end
-  local bufstate = hint_cache_by_buf[bufnr]
-  if not bufstate then
-    bufstate = {
-      client_hint = vim.defaulttable(),
-      version = ctx.version,
-    }
-    hint_cache_by_buf[bufnr] = bufstate
+  local bufstate = bufstates[bufnr]
+  if not (bufstate.client_hint and bufstate.version) then
+    bufstate.client_hint = vim.defaulttable()
+    bufstate.version = ctx.version
     api.nvim_buf_attach(bufnr, false, {
-      on_detach = function(_, b)
-        api.nvim_buf_clear_namespace(b, namespace, 0, -1)
-        hint_cache_by_buf[b] = nil
+      on_detach = function(_, cb_bufnr)
+        api.nvim_buf_clear_namespace(cb_bufnr, namespace, 0, -1)
+        bufstates[cb_bufnr].version = nil
+        bufstates[cb_bufnr].client_hint = nil
       end,
-      on_reload = function(_, b)
-        api.nvim_buf_clear_namespace(b, namespace, 0, -1)
-        hint_cache_by_buf[b] = nil
+      on_reload = function(_, cb_bufnr)
+        api.nvim_buf_clear_namespace(cb_bufnr, namespace, 0, -1)
+        bufstates[cb_bufnr].version = nil
+        bufstates[cb_bufnr].client_hint = nil
       end,
     })
   end
@@ -95,28 +102,24 @@ end
 
 ---@private
 local function resolve_bufnr(bufnr)
-  return bufnr == 0 and api.nvim_get_current_buf() or bufnr
+  return bufnr > 0 and bufnr or api.nvim_get_current_buf()
 end
 
 --- Refresh inlay hints for a buffer
 ---
---- It is recommended to trigger this using an autocmd or via keymap.
 ---@param opts (nil|table) Optional arguments
 ---  - bufnr (integer, default: 0): Buffer whose hints to refresh
 ---  - only_visible (boolean, default: false): Whether to only refresh hints for the visible regions of the buffer
 ---
---- Example:
---- <pre>vim
----   autocmd BufEnter,InsertLeave,BufWritePost <buffer> lua vim.lsp._inlay_hint.refresh()
---- </pre>
----
 ---@private
 function M.refresh(opts)
   opts = opts or {}
-  local bufnr = opts.bufnr or 0
+  local bufnr = resolve_bufnr(opts.bufnr or 0)
+  local bufstate = bufstates[bufnr]
+  if not (bufstate and bufstate.enabled) then
+    return
+  end
   local only_visible = opts.only_visible or false
-  bufnr = resolve_bufnr(bufnr)
-  M.__explicit_buffers[bufnr] = true
   local buffer_windows = {}
   for _, winid in ipairs(api.nvim_list_wins()) do
     if api.nvim_win_get_buf(winid) == bufnr then
@@ -148,30 +151,95 @@ function M.refresh(opts)
 end
 
 --- Clear inlay hints
----
----@param client_id integer|nil filter by client_id. All clients if nil
----@param bufnr integer|nil filter by buffer. All buffers if nil
+---@param bufnr (integer) Buffer handle, or 0 for current
 ---@private
-function M.clear(client_id, bufnr)
-  local buffers = bufnr and { resolve_bufnr(bufnr) } or vim.tbl_keys(hint_cache_by_buf)
-  for _, iter_bufnr in ipairs(buffers) do
-    M.__explicit_buffers[iter_bufnr] = false
-    local bufstate = hint_cache_by_buf[iter_bufnr]
-    local client_lens = (bufstate or {}).client_hint or {}
-    local client_ids = client_id and { client_id } or vim.tbl_keys(client_lens)
-    for _, iter_client_id in ipairs(client_ids) do
-      if bufstate then
-        bufstate.client_hint[iter_client_id] = {}
-      end
+local function clear(bufnr)
+  bufnr = resolve_bufnr(bufnr)
+  reset_timer(bufnr)
+  local bufstate = bufstates[bufnr]
+  local client_lens = (bufstate or {}).client_hint or {}
+  local client_ids = vim.tbl_keys(client_lens)
+  for _, iter_client_id in ipairs(client_ids) do
+    if bufstate then
+      bufstate.client_hint[iter_client_id] = {}
     end
-    api.nvim_buf_clear_namespace(iter_bufnr, namespace, 0, -1)
   end
-  vim.cmd('redraw!')
+  api.nvim_buf_clear_namespace(bufnr, namespace, 0, -1)
+  api.nvim__buf_redraw_range(bufnr, 0, -1)
+end
+
+---@private
+local function make_request(request_bufnr)
+  reset_timer(request_bufnr)
+  M.refresh({ bufnr = request_bufnr })
+end
+
+--- Enable inlay hints for a buffer
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@private
+function M.enable(bufnr)
+  bufnr = resolve_bufnr(bufnr)
+  local bufstate = bufstates[bufnr]
+  if not (bufstate and bufstate.enabled) then
+    bufstates[bufnr] = { enabled = true, timer = nil }
+    M.refresh({ bufnr = bufnr })
+    api.nvim_buf_attach(bufnr, true, {
+      on_lines = function(_, cb_bufnr)
+        if not bufstates[cb_bufnr].enabled then
+          return true
+        end
+        reset_timer(cb_bufnr)
+        bufstates[cb_bufnr].timer = vim.defer_fn(function()
+          make_request(cb_bufnr)
+        end, 200)
+      end,
+      on_reload = function(_, cb_bufnr)
+        clear(cb_bufnr)
+        bufstates[cb_bufnr] = nil
+        M.refresh({ bufnr = cb_bufnr })
+      end,
+      on_detach = function(_, cb_bufnr)
+        clear(cb_bufnr)
+        bufstates[cb_bufnr] = nil
+      end,
+    })
+    api.nvim_create_autocmd('LspDetach', {
+      buffer = bufnr,
+      callback = function(opts)
+        clear(opts.buf)
+      end,
+      once = true,
+      group = augroup,
+    })
+  end
+end
+
+--- Disable inlay hints for a buffer
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@private
+function M.disable(bufnr)
+  bufnr = resolve_bufnr(bufnr)
+  clear(bufnr)
+  bufstates[bufnr].enabled = nil
+  bufstates[bufnr].timer = nil
+end
+
+--- Toggle inlay hints for a buffer
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@private
+function M.toggle(bufnr)
+  bufnr = resolve_bufnr(bufnr)
+  local bufstate = bufstates[bufnr]
+  if bufstate and bufstate.enabled then
+    M.disable(bufnr)
+  else
+    M.enable(bufnr)
+  end
 end
 
 api.nvim_set_decoration_provider(namespace, {
   on_win = function(_, _, bufnr, topline, botline)
-    local bufstate = hint_cache_by_buf[bufnr]
+    local bufstate = bufstates[bufnr]
     if not bufstate then
       return
     end
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index e0034cf86e..c3deffc1f9 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -810,4 +810,19 @@ function M.execute_command(command_params)
   request('workspace/executeCommand', command_params)
 end
 
+--- Enable/disable/toggle inlay hints for a buffer
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@param enable (boolean|nil) true/false to enable/disable, nil to toggle
+function M.inlay_hint(bufnr, enable)
+  vim.validate({ enable = { enable, { 'boolean', 'nil' } }, bufnr = { bufnr, 'number' } })
+  local inlay_hint = require('vim.lsp._inlay_hint')
+  if enable then
+    inlay_hint.enable(bufnr)
+  elseif enable == false then
+    inlay_hint.disable(bufnr)
+  else
+    inlay_hint.toggle(bufnr)
+  end
+end
+
 return M
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 44a9a58aca..284e3ef2d0 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -619,9 +619,6 @@ end
 ---@see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspace_inlayHint_refresh
 M['workspace/inlayHint/refresh'] = function(err, _, ctx)
   local inlay_hint = require('vim.lsp._inlay_hint')
-  if not inlay_hint.__explicit_buffers[ctx.bufnr] then
-    return vim.NIL
-  end
   if err then
     return vim.NIL
   end
-- 
cgit 


From 96b94f8d77774e3dabdec48bba2b56246a3ccba8 Mon Sep 17 00:00:00 2001
From: Chinmay Dalal <dalal.chinmay.0101@gmail.com>
Date: Tue, 20 Jun 2023 15:06:06 +0530
Subject: fix(lsp): duplicate on_detach, on_reload callbacks #24067

M.enable already clears bufstate[bufnr] and the namespace,
the duplicate callbacks cause an error (indexing bufstate[bufnr] fails)
---
 runtime/lua/vim/lsp/_inlay_hint.lua | 12 ------------
 1 file changed, 12 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_inlay_hint.lua b/runtime/lua/vim/lsp/_inlay_hint.lua
index 70d332a1ac..bdce464480 100644
--- a/runtime/lua/vim/lsp/_inlay_hint.lua
+++ b/runtime/lua/vim/lsp/_inlay_hint.lua
@@ -48,18 +48,6 @@ function M.on_inlayhint(err, result, ctx, _)
   if not (bufstate.client_hint and bufstate.version) then
     bufstate.client_hint = vim.defaulttable()
     bufstate.version = ctx.version
-    api.nvim_buf_attach(bufnr, false, {
-      on_detach = function(_, cb_bufnr)
-        api.nvim_buf_clear_namespace(cb_bufnr, namespace, 0, -1)
-        bufstates[cb_bufnr].version = nil
-        bufstates[cb_bufnr].client_hint = nil
-      end,
-      on_reload = function(_, cb_bufnr)
-        api.nvim_buf_clear_namespace(cb_bufnr, namespace, 0, -1)
-        bufstates[cb_bufnr].version = nil
-        bufstates[cb_bufnr].client_hint = nil
-      end,
-    })
   end
   local hints_by_client = bufstate.client_hint
   local client = vim.lsp.get_client_by_id(client_id)
-- 
cgit 


From 64f2691a984a5b1e2958d5656a910054982a6f0e Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Tue, 20 Jun 2023 18:36:18 +0200
Subject: refactor(lsp): extract common execute command functionality (#24065)

---
 runtime/lua/vim/lsp.lua          | 40 ++++++++++++++++++++++++++++++++++++++++
 runtime/lua/vim/lsp/buf.lua      | 18 ++----------------
 runtime/lua/vim/lsp/codelens.lua | 24 +++---------------------
 runtime/lua/vim/lsp/types.lua    |  2 +-
 4 files changed, 46 insertions(+), 38 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 917aeb6604..25e69a8006 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1653,6 +1653,46 @@ function lsp.start_client(config)
     return rpc.is_closing()
   end
 
+  ---@private
+  --- Execute a lsp command, either via client command function (if available)
+  --- or via workspace/executeCommand (if supported by the server)
+  ---
+  ---@param command lsp.Command
+  ---@param context? {bufnr: integer}
+  ---@param handler? lsp-handler only called if a server command
+  function client._exec_cmd(command, context, handler)
+    context = vim.deepcopy(context or {})
+    context.bufnr = context.bufnr or api.nvim_get_current_buf()
+    context.client_id = client.id
+    local cmdname = command.command
+    local fn = client.commands[cmdname] or lsp.commands[cmdname]
+    if fn then
+      fn(command, context)
+      return
+    end
+
+    local command_provider = client.server_capabilities.executeCommandProvider
+    local commands = type(command_provider) == 'table' and command_provider.commands or {}
+    if not vim.list_contains(commands, cmdname) then
+      vim.notify_once(
+        string.format(
+          'Language server `%s` does not support command `%s`. This command may require a client extension.',
+          client.name,
+          cmdname
+        ),
+        vim.log.levels.WARN
+      )
+      return
+    end
+    -- Not using command directly to exclude extra properties,
+    -- see https://github.com/python-lsp/python-lsp-server/issues/146
+    local params = {
+      command = command.command,
+      arguments = command.arguments,
+    }
+    client.request('workspace/executeCommand', params, handler, context.bufnr)
+  end
+
   ---@private
   --- Runs the on_attach function from the client's config if it was defined.
   ---@param bufnr integer Buffer number
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index c3deffc1f9..45056cf272 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -646,21 +646,7 @@ local function on_code_action_results(results, ctx, options)
     end
     if action.command then
       local command = type(action.command) == 'table' and action.command or action
-      local fn = client.commands[command.command] or vim.lsp.commands[command.command]
-      if fn then
-        local enriched_ctx = vim.deepcopy(ctx)
-        enriched_ctx.client_id = client.id
-        fn(command, enriched_ctx)
-      else
-        -- Not using command directly to exclude extra properties,
-        -- see https://github.com/python-lsp/python-lsp-server/issues/146
-        local params = {
-          command = command.command,
-          arguments = command.arguments,
-          workDoneToken = command.workDoneToken,
-        }
-        client.request('workspace/executeCommand', params, nil, ctx.bufnr)
-      end
+      client._exec_cmd(command, ctx)
     end
   end
 
@@ -697,7 +683,7 @@ local function on_code_action_results(results, ctx, options)
           return
         end
         apply_action(resolved_action, client)
-      end)
+      end, ctx.bufnr)
     else
       apply_action(action, client)
     end
diff --git a/runtime/lua/vim/lsp/codelens.lua b/runtime/lua/vim/lsp/codelens.lua
index e26bdcc6d4..5acfe90d5e 100644
--- a/runtime/lua/vim/lsp/codelens.lua
+++ b/runtime/lua/vim/lsp/codelens.lua
@@ -33,30 +33,12 @@ local function execute_lens(lens, bufnr, client_id)
 
   local client = vim.lsp.get_client_by_id(client_id)
   assert(client, 'Client is required to execute lens, client_id=' .. client_id)
-  local command = lens.command
-  local fn = client.commands[command.command] or vim.lsp.commands[command.command]
-  if fn then
-    fn(command, { bufnr = bufnr, client_id = client_id })
-    return
-  end
-  -- Need to use the client that returned the lens → must not use buf_request
-  local command_provider = client.server_capabilities.executeCommandProvider
-  local commands = type(command_provider) == 'table' and command_provider.commands or {}
-  if not vim.list_contains(commands, command.command) then
-    vim.notify(
-      string.format(
-        'Language server does not support command `%s`. This command may require a client extension.',
-        command.command
-      ),
-      vim.log.levels.WARN
-    )
-    return
-  end
-  client.request('workspace/executeCommand', command, function(...)
+
+  client._exec_cmd(lens.command, { bufnr = bufnr }, function(...)
     local result = vim.lsp.handlers['workspace/executeCommand'](...)
     M.refresh()
     return result
-  end, bufnr)
+  end)
 end
 
 --- Return all lenses for the given buffer
diff --git a/runtime/lua/vim/lsp/types.lua b/runtime/lua/vim/lsp/types.lua
index 108aeeb922..cdfbcfb11b 100644
--- a/runtime/lua/vim/lsp/types.lua
+++ b/runtime/lua/vim/lsp/types.lua
@@ -1,6 +1,6 @@
 ---@meta
 
----@alias lsp-handler fun(err: lsp.ResponseError|nil, result: any, context: lsp.HandlerContext, config: table|nil)
+---@alias lsp-handler fun(err: lsp.ResponseError|nil, result: any, context: lsp.HandlerContext, config: table|nil): any?
 
 ---@class lsp.HandlerContext
 ---@field method string
-- 
cgit 


From d3e0352574731ae47b2ad2e4683c326ae5b2a549 Mon Sep 17 00:00:00 2001
From: Chinmay Dalal <dalal.chinmay.0101@gmail.com>
Date: Tue, 20 Jun 2023 22:06:31 +0530
Subject: fix(lsp): check if inlay hints are enabled for a buffer before
 disabling (#24074)

disabling before enabling throws an error otherwise, because bufstate[bufnr]
doesn't exist
---
 runtime/lua/vim/lsp/_inlay_hint.lua | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_inlay_hint.lua b/runtime/lua/vim/lsp/_inlay_hint.lua
index bdce464480..e7cc8ba7ae 100644
--- a/runtime/lua/vim/lsp/_inlay_hint.lua
+++ b/runtime/lua/vim/lsp/_inlay_hint.lua
@@ -207,9 +207,11 @@ end
 ---@private
 function M.disable(bufnr)
   bufnr = resolve_bufnr(bufnr)
-  clear(bufnr)
-  bufstates[bufnr].enabled = nil
-  bufstates[bufnr].timer = nil
+  if bufstates[bufnr] and bufstates[bufnr].enabled then
+    clear(bufnr)
+    bufstates[bufnr].enabled = nil
+    bufstates[bufnr].timer = nil
+  end
 end
 
 --- Toggle inlay hints for a buffer
-- 
cgit 


From 3bf887f6e08fa272679187340ca483809275b20a Mon Sep 17 00:00:00 2001
From: Sooryakiran Ponnath <skp.frl@gmail.com>
Date: Tue, 20 Jun 2023 15:17:13 -0400
Subject: fix(lsp): always return boolean in lsp.buf_client_attach (#24077)

Co-authored-by: Mathias Fussenegger <f.mathias@zignar.net>
---
 runtime/lua/vim/lsp.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 25e69a8006..cb1c101c58 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1799,6 +1799,7 @@ end
 ---
 ---@param bufnr (integer) Buffer handle, or 0 for current
 ---@param client_id (integer) Client id
+---@return boolean success `true` if client was attached successfully; `false` otherwise
 function lsp.buf_attach_client(bufnr, client_id)
   validate({
     bufnr = { bufnr, 'n', true },
@@ -1887,7 +1888,7 @@ function lsp.buf_attach_client(bufnr, client_id)
   end
 
   if buffer_client_ids[client_id] then
-    return
+    return true
   end
   -- This is our first time attaching this client to this buffer.
   buffer_client_ids[client_id] = true
-- 
cgit 


From e42fdaad21a87d0aaf882f1ad836b00d2eccd21a Mon Sep 17 00:00:00 2001
From: Akin <22454918+akinsho@users.noreply.github.com>
Date: Wed, 21 Jun 2023 09:55:19 +0200
Subject: fix(lsp): add spacing for inlay hints separately #24079

Problem:
Spacing around inlay hints has the same highlight as the hint itself.
The LSP spec for inlay hints specifically mentions the padding should not be
coloured:

    /**
    Render padding before the hint.
    Note: Padding should use the editor's background color, not the
    background color of the hint itself. That means padding can be used
    to visually align/separate an inlay hint.
    */
    paddingLeft?: boolean;
    /**
    Render padding after the hint.
    Note: Padding should use the editor's background color, not the
    background color of the hint itself. That means padding can be used
    to visually align/separate an inlay hint.
    */
    paddingRight?: boolean;

Solution:
Add the space as separate parts of the virtual text, don't add the space to the
text itself.
---
 runtime/lua/vim/lsp/_inlay_hint.lua | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_inlay_hint.lua b/runtime/lua/vim/lsp/_inlay_hint.lua
index e7cc8ba7ae..8edf14e707 100644
--- a/runtime/lua/vim/lsp/_inlay_hint.lua
+++ b/runtime/lua/vim/lsp/_inlay_hint.lua
@@ -252,18 +252,18 @@ api.nvim_set_decoration_provider(namespace, {
               text = text .. part.value
             end
           end
+          local vt = {}
           if hint.paddingLeft then
-            text = ' ' .. text
+            vt[#vt + 1] = { ' ' }
           end
+          vt[#vt + 1] = { text, 'LspInlayHint' }
           if hint.paddingRight then
-            text = text .. ' '
+            vt[#vt + 1] = { ' ' }
           end
           api.nvim_buf_set_extmark(bufnr, namespace, lnum, hint.position.character, {
             virt_text_pos = 'inline',
             ephemeral = false,
-            virt_text = {
-              { text, 'LspInlayHint' },
-            },
+            virt_text = vt,
             hl_mode = 'combine',
           })
         end
-- 
cgit 


From 21b074feb09b7f2e4807a816be6fd0687f23c564 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Wed, 21 Jun 2023 11:34:49 +0200
Subject: refactor(lsp): report full Nvim version string in clientInfo

---
 runtime/lua/vim/lsp.lua | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index cb1c101c58..ea81244c68 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1345,7 +1345,6 @@ function lsp.start_client(config)
       messages = 'messages',
       verbose = 'verbose',
     }
-    local version = vim.version()
 
     local workspace_folders --- @type table[]?
     local root_uri --- @type string?
@@ -1379,7 +1378,7 @@ function lsp.start_client(config)
       -- since 3.15.0
       clientInfo = {
         name = 'Neovim',
-        version = string.format('%s.%s.%s', version.major, version.minor, version.patch),
+        version = tostring(vim.version()),
       },
       -- The rootPath of the workspace. Is null if no folder is open.
       --
-- 
cgit 


From 43e76cc3462bc5bcf2b6ade8af1c36e21d3da3c9 Mon Sep 17 00:00:00 2001
From: Julian Grinblat <julian@dotcore.co.il>
Date: Thu, 22 Jun 2023 16:36:38 +0900
Subject: fix: tostring(vim.version()) fails if build is NIL #24097
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Problem:
Since #23925, Version.build may be vim.NIL, which causes tostring() to fail:
    E5108: Error executing lua E5114: Error while converting print argument #1: …/version.lua:129:
    attempt to concatenate field 'build' (a userdata value)
    stack traceback:
            [C]: in function 'print'
            [string ":lua"]:1: in main chunk

Solution:
Handle vim.NIL in Version:__tostring().
---
 runtime/lua/vim/version.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index 92250ff1f8..cd28a9b54b 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -125,7 +125,7 @@ function Version:__tostring()
   if self.prerelease then
     ret = ret .. '-' .. self.prerelease
   end
-  if self.build then
+  if self.build and self.build ~= vim.NIL then
     ret = ret .. '+' .. self.build
   end
   return ret
-- 
cgit 


From 4d3a04279d32bc97d18ab2883c678c94f80487bc Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Thu, 22 Jun 2023 10:18:49 +0200
Subject: perf(lsp): remove grouping logic from lsp.status (#24096)

With the title carry-over logic in the `$/progress` handler it's not
necessary to group again in vim.lsp.status
---
 runtime/lua/vim/lsp.lua | 22 +++-------------------
 1 file changed, 3 insertions(+), 19 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index ea81244c68..38e0e34790 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -902,18 +902,13 @@ end
 ---@return string
 function lsp.status()
   local percentage = nil
-  local groups = {}
+  local messages = {}
   for _, client in ipairs(vim.lsp.get_active_clients()) do
     for progress in client.progress do
       local value = progress.value
       if type(value) == 'table' and value.kind then
-        local group = groups[progress.token]
-        if not group then
-          group = {}
-          groups[progress.token] = group
-        end
-        group.title = value.title or group.title
-        group.message = value.message or group.message
+        local message = value.message and (value.title .. ': ' .. value.message) or value.title
+        messages[#messages + 1] = message
         if value.percentage then
           percentage = math.max(percentage or 0, value.percentage)
         end
@@ -922,17 +917,6 @@ function lsp.status()
       -- Just ignore it as there is no sensible way to display it
     end
   end
-  local messages = {}
-  for _, group in pairs(groups) do
-    if group.title then
-      table.insert(
-        messages,
-        group.message and (group.title .. ': ' .. group.message) or group.title
-      )
-    elseif group.message then
-      table.insert(messages, group.message)
-    end
-  end
   local message = table.concat(messages, ', ')
   if percentage then
     return string.format('%3d%%: %s', percentage, message)
-- 
cgit 


From 4e6356559c8cd44dbcaa765d1f39e176064526ec Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Thu, 22 Jun 2023 03:44:51 -0700
Subject: test: spellcheck :help (vimdoc) files #24109

Enforce consistent terminology (defined in
`gen_help_html.lua:spell_dict`) for common misspellings.

This does not spellcheck English in general (perhaps a future TODO,
though it may be noisy).
---
 runtime/lua/vim/_editor.lua |  6 +++---
 runtime/lua/vim/_meta.lua   |  4 ++--
 runtime/lua/vim/loader.lua  | 22 +++++++++++-----------
 runtime/lua/vim/lsp.lua     |  2 +-
 runtime/lua/vim/lsp/buf.lua |  2 +-
 5 files changed, 18 insertions(+), 18 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 1de2ade1a1..e2ed0d980e 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -3,7 +3,7 @@
 -- Lua code lives in one of three places:
 --    1. runtime/lua/vim/ (the runtime): For "nice to have" features, e.g. the
 --       `inspect` and `lpeg` modules.
---    2. runtime/lua/vim/shared.lua: pure lua functions which always
+--    2. runtime/lua/vim/shared.lua: pure Lua functions which always
 --       are available. Used in the test runner, as well as worker threads
 --       and processes launched from Nvim.
 --    3. runtime/lua/vim/_editor.lua: Code which directly interacts with
@@ -839,10 +839,10 @@ do
   -- some bugs, so fake the two-step dance for now.
   local matches
 
-  --- Omnifunc for completing lua values from the runtime lua interpreter,
+  --- Omnifunc for completing Lua values from the runtime Lua interpreter,
   --- similar to the builtin completion for the `:lua` command.
   ---
-  --- Activate using `set omnifunc=v:lua.vim.lua_omnifunc` in a lua buffer.
+  --- Activate using `set omnifunc=v:lua.vim.lua_omnifunc` in a Lua buffer.
   function vim.lua_omnifunc(find_start, _)
     if find_start == 1 then
       local line = vim.api.nvim_get_current_line()
diff --git a/runtime/lua/vim/_meta.lua b/runtime/lua/vim/_meta.lua
index e3ad4d76c9..913f1fe203 100644
--- a/runtime/lua/vim/_meta.lua
+++ b/runtime/lua/vim/_meta.lua
@@ -239,7 +239,7 @@ local to_vim_value = {
   end,
 }
 
---- Convert a lua value to a vimoption_T value
+--- Convert a Lua value to a vimoption_T value
 local function convert_value_to_vim(name, info, value)
   if value == nil then
     return vim.NIL
@@ -250,7 +250,7 @@ local function convert_value_to_vim(name, info, value)
   return to_vim_value[info.metatype](info, value)
 end
 
--- Map of OptionType to functions that take vimoption_T values and convert to lua values.
+-- Map of OptionType to functions that take vimoption_T values and convert to Lua values.
 -- Each function takes (info, vim_value) -> lua_value
 local to_lua_value = {
   boolean = passthrough,
diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index 9024bdb231..f340dc85b5 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -161,7 +161,7 @@ function Loader.read(name)
   end
 end
 
---- The `package.loaders` loader for lua files using the cache.
+--- The `package.loaders` loader for Lua files using the cache.
 ---@param modname string module name
 ---@return string|function
 ---@private
@@ -211,7 +211,7 @@ end
 ---@private
 -- luacheck: ignore 312
 function Loader.loadfile(filename, mode, env)
-  -- ignore mode, since we byte-compile the lua source files
+  -- ignore mode, since we byte-compile the Lua source files
   mode = nil
   return Loader.load(normalize(filename), { mode = mode, env = env })
 end
@@ -268,7 +268,7 @@ function Loader.load(modpath, opts)
   return chunk, err
 end
 
---- Finds lua modules for the given module name.
+--- Finds Lua modules for the given module name.
 ---@param modname string Module name, or `"*"` to find the top-level modules instead
 ---@param opts? ModuleFindOpts (table|nil) Options for finding a module:
 ---    - rtp: (boolean) Search for modname in the runtime path (defaults to `true`)
@@ -289,7 +289,7 @@ function M.find(modname, opts)
   local idx = modname:find('.', 1, true)
 
   -- HACK: fix incorrect require statements. Really not a fan of keeping this,
-  -- but apparently the regular lua loader also allows this
+  -- but apparently the regular Lua loader also allows this
   if idx == 1 then
     modname = modname:gsub('^%.+', '')
     basename = modname:gsub('%.', '/')
@@ -386,9 +386,9 @@ end
 
 --- Enables the experimental Lua module loader:
 --- * overrides loadfile
---- * adds the lua loader using the byte-compilation cache
+--- * adds the Lua loader using the byte-compilation cache
 --- * adds the libs loader
---- * removes the default Neovim loader
+--- * removes the default Nvim loader
 function M.enable()
   if M.enabled then
     return
@@ -396,11 +396,11 @@ function M.enable()
   M.enabled = true
   vim.fn.mkdir(vim.fn.fnamemodify(M.path, ':p'), 'p')
   _G.loadfile = Loader.loadfile
-  -- add lua loader
+  -- add Lua loader
   table.insert(loaders, 2, Loader.loader)
   -- add libs loader
   table.insert(loaders, 3, Loader.loader_lib)
-  -- remove Neovim loader
+  -- remove Nvim loader
   for l, loader in ipairs(loaders) do
     if loader == vim._load_package then
       table.remove(loaders, l)
@@ -411,7 +411,7 @@ end
 
 --- Disables the experimental Lua module loader:
 --- * removes the loaders
---- * adds the default Neovim loader
+--- * adds the default Nvim loader
 function M.disable()
   if not M.enabled then
     return
@@ -426,8 +426,8 @@ function M.disable()
   table.insert(loaders, 2, vim._load_package)
 end
 
---- Return the top-level `/lua/*` modules for this path
----@param path string path to check for top-level lua modules
+--- Return the top-level \`/lua/*` modules for this path
+---@param path string path to check for top-level Lua modules
 ---@private
 function Loader.lsmod(path)
   if not Loader._indexed[path] then
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 38e0e34790..5b192ca514 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1076,7 +1076,7 @@ end
 ---       `initialize_result.offsetEncoding` if `capabilities.offsetEncoding` was
 ---       sent to it. You can only modify the `client.offset_encoding` here before
 ---       any notifications are sent. Most language servers expect to be sent client specified settings after
----       initialization. Neovim does not make this assumption. A
+---       initialization. Nvim does not make this assumption. A
 ---       `workspace/didChangeConfiguration` notification should be sent
 ---        to the server during on_init.
 ---
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 45056cf272..17b444a6e8 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -159,7 +159,7 @@ end
 --- @param options table|nil Optional table which holds the following optional fields:
 ---     - formatting_options (table|nil):
 ---         Can be used to specify FormattingOptions. Some unspecified options will be
----         automatically derived from the current Neovim options.
+---         automatically derived from the current Nvim options.
 ---         See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#formattingOptions
 ---     - timeout_ms (integer|nil, default 1000):
 ---         Time in milliseconds to block for formatting requests. No effect if async=true
-- 
cgit 


From 134b9ec483616e20d96c26fdb7ef3f3e912108a8 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Thu, 22 Jun 2023 13:54:35 +0200
Subject: feat(lsp): soft deprecate vim.lsp.for_each_buffer_client (#24104)

There is no need for two ways to access all clients of a buffer.

This doesn't add a `vim.deprecate` call yet, as the function is probably
used a lot, but removes it from the documentation and annotates it with
`@deprecated`
---
 runtime/lua/vim/lsp.lua | 60 ++++++++++++++++++++++++-------------------------
 1 file changed, 29 insertions(+), 31 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 5b192ca514..970bb56478 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1740,7 +1740,7 @@ local function text_document_did_save_handler(bufnr)
   bufnr = resolve_bufnr(bufnr)
   local uri = vim.uri_from_bufnr(bufnr)
   local text = once(buf_get_full_text)
-  for_each_buffer_client(bufnr, function(client)
+  for _, client in ipairs(lsp.get_active_clients({ bufnr = bufnr })) do
     local name = api.nvim_buf_get_name(bufnr)
     local old_name = changetracking._get_and_set_name(client, bufnr, name)
     if old_name and name ~= old_name then
@@ -1772,7 +1772,7 @@ local function text_document_did_save_handler(bufnr)
         text = included_text,
       })
     end
-  end)
+  end
 end
 
 --- Implements the `textDocument/did…` notifications required to track a buffer
@@ -1808,7 +1808,7 @@ function lsp.buf_attach_client(bufnr, client_id)
       buffer = bufnr,
       desc = 'vim.lsp: textDocument/willSave',
       callback = function(ctx)
-        for_each_buffer_client(ctx.buf, function(client)
+        for _, client in ipairs(lsp.get_active_clients({ bufnr = ctx.buf })) do
           local params = {
             textDocument = {
               uri = uri,
@@ -1827,7 +1827,7 @@ function lsp.buf_attach_client(bufnr, client_id)
               log.error(vim.inspect(err))
             end
           end
-        end)
+        end
       end,
     })
     api.nvim_create_autocmd('BufWritePost', {
@@ -1843,23 +1843,23 @@ function lsp.buf_attach_client(bufnr, client_id)
       on_lines = text_document_did_change_handler,
       on_reload = function()
         local params = { textDocument = { uri = uri } }
-        for_each_buffer_client(bufnr, function(client, _)
+        for _, client in ipairs(lsp.get_active_clients({ bufnr = bufnr })) do
           changetracking.reset_buf(client, bufnr)
           if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
             client.notify('textDocument/didClose', params)
           end
           text_document_did_open_handler(bufnr, client)
-        end)
+        end
       end,
       on_detach = function()
         local params = { textDocument = { uri = uri } }
-        for_each_buffer_client(bufnr, function(client, _)
+        for _, client in ipairs(lsp.get_active_clients({ bufnr = bufnr })) do
           changetracking.reset_buf(client, bufnr)
           if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
             client.notify('textDocument/didClose', params)
           end
           client.attached_buffers[bufnr] = nil
-        end)
+        end
         util.buf_versions[bufnr] = nil
         all_buffer_active_clients[bufnr] = nil
       end,
@@ -1932,7 +1932,7 @@ function lsp.buf_detach_client(bufnr, client_id)
     all_buffer_active_clients[bufnr] = nil
   end
 
-  local namespace = vim.lsp.diagnostic.get_namespace(client_id)
+  local namespace = lsp.diagnostic.get_namespace(client_id)
   vim.diagnostic.reset(namespace, bufnr)
 
   vim.notify(string.format('Detached buffer (id: %d) from client (id: %d)', bufnr, client_id))
@@ -2104,34 +2104,30 @@ function lsp.buf_request(bufnr, method, params, handler)
     handler = { handler, 'f', true },
   })
 
-  local supported_clients = {}
+  bufnr = resolve_bufnr(bufnr)
   local method_supported = false
-  for_each_buffer_client(bufnr, function(client, client_id)
+  local clients = lsp.get_active_clients({ bufnr = bufnr })
+  local client_request_ids = {}
+  for _, client in ipairs(clients) do
     if client.supports_method(method, { bufnr = bufnr }) then
       method_supported = true
-      table.insert(supported_clients, client_id)
+
+      local request_success, request_id = client.request(method, params, handler, bufnr)
+      -- This could only fail if the client shut down in the time since we looked
+      -- it up and we did the request, which should be rare.
+      if request_success then
+        client_request_ids[client.id] = request_id
+      end
     end
-  end)
+  end
 
   -- if has client but no clients support the given method, notify the user
-  if
-    not tbl_isempty(all_buffer_active_clients[resolve_bufnr(bufnr)] or {}) and not method_supported
-  then
+  if next(clients) and not method_supported then
     vim.notify(lsp._unsupported_method(method), vim.log.levels.ERROR)
     nvim_command('redraw')
     return {}, function() end
   end
 
-  local client_request_ids = {}
-  for_each_buffer_client(bufnr, function(client, client_id, resolved_bufnr)
-    local request_success, request_id = client.request(method, params, handler, resolved_bufnr)
-    -- This could only fail if the client shut down in the time since we looked
-    -- it up and we did the request, which should be rare.
-    if request_success then
-      client_request_ids[client_id] = request_id
-    end
-  end, supported_clients)
-
   local function _cancel_all_requests()
     for client_id, request_id in pairs(client_request_ids) do
       local client = active_clients[client_id]
@@ -2159,11 +2155,11 @@ function lsp.buf_request_all(bufnr, method, params, handler)
   local expected_result_count = 0
 
   local set_expected_result_count = once(function()
-    for_each_buffer_client(bufnr, function(client)
+    for _, client in ipairs(lsp.get_active_clients({ bufnr = bufnr })) do
       if client.supports_method(method, { bufnr = bufnr }) then
         expected_result_count = expected_result_count + 1
       end
-    end)
+    end
   end)
 
   local function _sync_handler(err, result, ctx)
@@ -2226,11 +2222,11 @@ function lsp.buf_notify(bufnr, method, params)
     method = { method, 's' },
   })
   local resp = false
-  for_each_buffer_client(bufnr, function(client, _client_id, _resolved_bufnr)
+  for _, client in ipairs(lsp.get_active_clients({ bufnr = bufnr })) do
     if client.rpc.notify(method, params) then
       resp = true
     end
-  end)
+  end
   return resp
 end
 
@@ -2371,7 +2367,7 @@ function lsp.formatexpr(opts)
       local response =
         client.request_sync('textDocument/rangeFormatting', params, timeout_ms, bufnr)
       if response.result then
-        vim.lsp.util.apply_text_edits(response.result, 0, client.offset_encoding)
+        lsp.util.apply_text_edits(response.result, 0, client.offset_encoding)
         return 0
       end
     end
@@ -2452,6 +2448,7 @@ function lsp.get_log_path()
   return log.get_filename()
 end
 
+---@private
 --- Invokes a function for each LSP client attached to a buffer.
 ---
 ---@param bufnr integer Buffer number
@@ -2463,6 +2460,7 @@ end
 ---                 print(vim.inspect(client))
 ---               end)
 ---             </pre>
+---@deprecated use lsp.get_active_clients({ bufnr = bufnr }) with regular loop
 function lsp.for_each_buffer_client(bufnr, fn)
   return for_each_buffer_client(bufnr, fn)
 end
-- 
cgit 


From 904ad5458de095fec563fb9180fed2c4c87331e1 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Thu, 22 Jun 2023 19:38:49 +0200
Subject: vim-patch:9.0.1645: zserio files are not recognized (#24120)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Problem:    zserio files are not recognized.
Solution:   Add a pattern for zserio files. (Dominique Pellé,
            closes vim/vim#12544)

https://github.com/vim/vim/commit/2b994da57a0ac6ec0ec09fe3783f48ecd2bce610

Co-authored-by: =?UTF-8?q?Dominique=20Pell=C3=A9?= <dominique.pelle@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index fc8871f593..08a042d376 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1174,6 +1174,7 @@ local extension = {
   zir = 'zir',
   zu = 'zimbu',
   zut = 'zimbutempl',
+  zs = 'zserio',
   zsh = 'zsh',
   vala = 'vala',
   web = function(path, bufnr)
-- 
cgit 


From 12c2c16acf7051d364d29cfd71f2542b0943d8e8 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Thu, 22 Jun 2023 19:39:57 +0200
Subject: feat(lsp): opt-in to dynamicRegistration for inlay hints (#24102)

Since https://github.com/neovim/neovim/pull/23681 there is dynamic
registration support. We should use that for new features unless there
is a good reason to turn it off.
---
 runtime/lua/vim/lsp/protocol.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index b3a7903420..ea38bfe237 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -642,7 +642,7 @@ function protocol.make_client_capabilities()
     },
     textDocument = {
       inlayHint = {
-        dynamicRegistration = false,
+        dynamicRegistration = true,
         resolveSupport = {
           properties = {},
         },
-- 
cgit 


From 94a904b453e5fe5b2cb098828c093e34246d4125 Mon Sep 17 00:00:00 2001
From: Chinmay Dalal <dalal.chinmay.0101@gmail.com>
Date: Fri, 23 Jun 2023 17:19:54 +0530
Subject: fix(lsp): reapplying already-applied hints #24114

Problem:
The decoration provider clears the whole buffer then redraws all the hints every
time the window was redrawn. This may lead to an infinite loop.

Solution:
Store the last applied version for a line and only clear and redraw the line if
the buffer version has changed.
---
 runtime/lua/vim/lsp/_inlay_hint.lua | 54 ++++++++++++++++++++-----------------
 1 file changed, 29 insertions(+), 25 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_inlay_hint.lua b/runtime/lua/vim/lsp/_inlay_hint.lua
index 8edf14e707..66fed4f350 100644
--- a/runtime/lua/vim/lsp/_inlay_hint.lua
+++ b/runtime/lua/vim/lsp/_inlay_hint.lua
@@ -8,6 +8,7 @@ local M = {}
 ---@field client_hint table<integer, table<integer, lsp.InlayHint[]>> client_id -> (lnum -> hints)
 ---@field enabled boolean Whether inlay hints are enabled for the buffer
 ---@field timer uv.uv_timer_t? Debounce timer associated with the buffer
+---@field applied table<integer, integer> Last version of hints applied to this line
 
 ---@type table<integer, lsp._inlay_hint.bufstate>
 local bufstates = {}
@@ -169,7 +170,7 @@ function M.enable(bufnr)
   bufnr = resolve_bufnr(bufnr)
   local bufstate = bufstates[bufnr]
   if not (bufstate and bufstate.enabled) then
-    bufstates[bufnr] = { enabled = true, timer = nil }
+    bufstates[bufnr] = { enabled = true, timer = nil, applied = {} }
     M.refresh({ bufnr = bufnr })
     api.nvim_buf_attach(bufnr, true, {
       on_lines = function(_, cb_bufnr)
@@ -238,35 +239,38 @@ api.nvim_set_decoration_provider(namespace, {
       return
     end
     local hints_by_client = bufstate.client_hint
-    api.nvim_buf_clear_namespace(bufnr, namespace, 0, -1)
 
     for lnum = topline, botline do
-      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
-          local text = ''
-          if type(hint.label) == 'string' then
-            text = hint.label
-          else
-            for _, part in ipairs(hint.label) do
-              text = text .. part.value
+      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
+            local text = ''
+            if type(hint.label) == 'string' then
+              text = hint.label
+            else
+              for _, part in ipairs(hint.label) do
+                text = text .. part.value
+              end
             end
+            local vt = {}
+            if hint.paddingLeft then
+              vt[#vt + 1] = { ' ' }
+            end
+            vt[#vt + 1] = { text, 'LspInlayHint' }
+            if hint.paddingRight then
+              vt[#vt + 1] = { ' ' }
+            end
+            api.nvim_buf_set_extmark(bufnr, namespace, lnum, hint.position.character, {
+              virt_text_pos = 'inline',
+              ephemeral = false,
+              virt_text = vt,
+              hl_mode = 'combine',
+            })
           end
-          local vt = {}
-          if hint.paddingLeft then
-            vt[#vt + 1] = { ' ' }
-          end
-          vt[#vt + 1] = { text, 'LspInlayHint' }
-          if hint.paddingRight then
-            vt[#vt + 1] = { ' ' }
-          end
-          api.nvim_buf_set_extmark(bufnr, namespace, lnum, hint.position.character, {
-            virt_text_pos = 'inline',
-            ephemeral = false,
-            virt_text = vt,
-            hl_mode = 'combine',
-          })
         end
+        bufstate.applied[lnum] = bufstate.version
       end
     end
   end,
-- 
cgit 


From 4dc86477b674d056b137a3afafd8824f7b7717ec Mon Sep 17 00:00:00 2001
From: Raphael <glepnir@neovim.pro>
Date: Fri, 23 Jun 2023 19:54:47 +0800
Subject: build(luarc.json): disable luadoc-miss-see-name #24108

---
 runtime/lua/vim/lsp.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 970bb56478..2c115007de 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1183,7 +1183,7 @@ function lsp.start_client(config)
   ---
   ---@param code (integer) Error code
   ---@param err (...) Other arguments may be passed depending on the error kind
-  ---@see `vim.lsp.rpc.client_errors` for possible errors. Use
+  ---@see vim.lsp.rpc.client_errors for possible errors. Use
   ---`vim.lsp.rpc.client_errors[code]` to get a human-friendly name.
   function dispatch.on_error(code, err)
     if log.error() then
@@ -2366,7 +2366,7 @@ function lsp.formatexpr(opts)
       }
       local response =
         client.request_sync('textDocument/rangeFormatting', params, timeout_ms, bufnr)
-      if response.result then
+      if response and response.result then
         lsp.util.apply_text_edits(response.result, 0, client.offset_encoding)
         return 0
       end
-- 
cgit 


From fdf5013e218c55ca8f9bdb7cf5f16f8596330ea2 Mon Sep 17 00:00:00 2001
From: smjonas <jonas.strittmatter@gmx.de>
Date: Wed, 21 Jun 2023 07:12:53 +0200
Subject: fix(filetype): correctly detect bash-fc-{id} files as "sh"

---
 runtime/lua/vim/filetype.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index fc8871f593..91d5dc1c62 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -2188,7 +2188,7 @@ local pattern = {
   ['.*/etc/profile'] = function(path, bufnr)
     return require('vim.filetype.detect').sh(path, M.getlines(bufnr))
   end,
-  ['bash%-fc[%-%.]'] = function(path, bufnr)
+  ['bash%-fc[%-%.].*'] = function(path, bufnr)
     return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
   end,
   ['%.tcshrc.*'] = function(path, bufnr)
-- 
cgit 


From fa0a25dcb3a4fd2d6f03e09bcc7edac2f9ea8ded Mon Sep 17 00:00:00 2001
From: Chinmay Dalal <dalal.chinmay.0101@gmail.com>
Date: Sat, 24 Jun 2023 05:03:15 +0530
Subject: fix(lsp): error in reset_timer on second detach #24117

Problem:
On running `zig fmt` manually, the on_lines callback and the
server both detach (for some reason), and both of them call
`clear()`. This fixes it, otherwise the second one to detach
has an error in `reset_timer` since the bufstate doesn't exist

Solution:
* exit early in clear if `bufstates[bufnr]` is nil
* set bufstatte.enabled to true on reload instead of making bufstate nil
---
 runtime/lua/vim/lsp/_inlay_hint.lua | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_inlay_hint.lua b/runtime/lua/vim/lsp/_inlay_hint.lua
index 66fed4f350..84794841ae 100644
--- a/runtime/lua/vim/lsp/_inlay_hint.lua
+++ b/runtime/lua/vim/lsp/_inlay_hint.lua
@@ -144,6 +144,9 @@ end
 ---@private
 local function clear(bufnr)
   bufnr = resolve_bufnr(bufnr)
+  if not bufstates[bufnr] then
+    return
+  end
   reset_timer(bufnr)
   local bufstate = bufstates[bufnr]
   local client_lens = (bufstate or {}).client_hint or {}
@@ -184,7 +187,9 @@ function M.enable(bufnr)
       end,
       on_reload = function(_, cb_bufnr)
         clear(cb_bufnr)
-        bufstates[cb_bufnr] = nil
+        if bufstates[cb_bufnr] and bufstates[cb_bufnr].enabled then
+          bufstates[cb_bufnr] = { enabled = true }
+        end
         M.refresh({ bufnr = cb_bufnr })
       end,
       on_detach = function(_, cb_bufnr)
-- 
cgit 


From cc624fac683ce6dbd01f10781817cd654cceed38 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 24 Jun 2023 20:04:30 +0200
Subject: vim-patch:9.0.1661: BUCK files are not recognized (#24142)

Problem:    BUCK files are not recognized.
Solution:   Recognize BUCK files as "bzl". (Son Luong Ngoc, closes vim/vim#12564)

https://github.com/vim/vim/commit/b46e0f3263acd99c61df06ee3c4d1f6e0b471bc3

Co-authored-by: Son Luong Ngoc <sluongng@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 33e80690ff..7bcc67313d 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1372,6 +1372,7 @@ local filename = {
   ['named.root'] = 'bindzone',
   WORKSPACE = 'bzl',
   ['WORKSPACE.bzlmod'] = 'bzl',
+  BUCK = 'bzl',
   BUILD = 'bzl',
   ['cabal.project'] = 'cabalproject',
   ['cabal.config'] = 'cabalconfig',
-- 
cgit 


From 036da0d07921e67090d1a62c9a4e382ca09d8584 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Sat, 24 Jun 2023 13:47:10 +0200
Subject: fix(docs): vimdoc syntax errors

gen_help_html: truncate parse-error sample text
---
 runtime/lua/vim/iter.lua     | 2 +-
 runtime/lua/vim/lsp/buf.lua  | 6 +++---
 runtime/lua/vim/lsp/util.lua | 8 ++++----
 3 files changed, 8 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index 9c7bd13164..245a33625e 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -359,7 +359,7 @@ function ListIter.totable(self)
   return self._table
 end
 
---- Fold an iterator or table into a single value.
+--- Fold ("reduce") an iterator or table into a single value.
 ---
 --- Examples:
 --- <pre>lua
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 17b444a6e8..c2e0179cc4 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -122,7 +122,7 @@ end
 ---@private
 ---@param bufnr integer
 ---@param mode "v"|"V"
----@return table {start={row, col}, end={row, col}} using (1, 0) indexing
+---@return table {start={row,col}, end={row,col}} using (1, 0) indexing
 local function range_from_selection(bufnr, mode)
   -- TODO: Use `vim.region()` instead https://github.com/neovim/neovim/pull/13896
 
@@ -189,7 +189,7 @@ end
 ---         Restrict formatting to the client with name (client.name) matching this field.
 ---
 ---     - range (table|nil) Range to format.
----         Table must contain `start` and `end` keys with {row, col} tuples using
+---         Table must contain `start` and `end` keys with {row,col} tuples using
 ---         (1,0) indexing.
 ---         Defaults to current selection in visual mode
 ---         Defaults to `nil` in other modes, formatting the full buffer
@@ -741,7 +741,7 @@ end
 ---  - range: (table|nil)
 ---           Range for which code actions should be requested.
 ---           If in visual mode this defaults to the active selection.
----           Table must contain `start` and `end` keys with {row, col} tuples
+---           Table must contain `start` and `end` keys with {row,col} tuples
 ---           using mark-like indexing. See |api-indexing|
 ---
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_codeAction
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 538e48c805..4c319e7c41 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -178,8 +178,8 @@ local _str_byteindex_enc = M._str_byteindex_enc
 --- CAUTION: Changes in-place!
 ---
 ---@param lines (table) Original list of strings
----@param A (table) Start position; a 2-tuple of {line, col} numbers
----@param B (table) End position; a 2-tuple of {line, col} numbers
+---@param A (table) Start position; a 2-tuple of {line,col} numbers
+---@param B (table) End position; a 2-tuple of {line,col} numbers
 ---@param new_lines A list of strings to replace the original
 ---@returns (table) The modified {lines} object
 function M.set_lines(lines, A, B, new_lines)
@@ -2075,9 +2075,9 @@ end
 --- Using the given range in the current buffer, creates an object that
 --- is similar to |vim.lsp.util.make_range_params()|.
 ---
----@param start_pos integer[]|nil {row, col} mark-indexed position.
+---@param start_pos integer[]|nil {row,col} mark-indexed position.
 --- Defaults to the start of the last visual selection.
----@param end_pos integer[]|nil {row, col} mark-indexed position.
+---@param end_pos integer[]|nil {row,col} mark-indexed position.
 --- Defaults to the end of the last visual selection.
 ---@param bufnr integer|nil buffer handle or 0 for current, defaults to current
 ---@param offset_encoding "utf-8"|"utf-16"|"utf-32"|nil defaults to `offset_encoding` of first client of `bufnr`
-- 
cgit 


From 49a7585981cdf7403e76a614558e602a98e64301 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Fri, 23 Jun 2023 12:16:55 +0200
Subject: docs: autocmds, misc

---
 runtime/lua/vim/_editor.lua | 2 ++
 runtime/lua/vim/lsp.lua     | 2 +-
 2 files changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index e2ed0d980e..ab20c36b17 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -184,6 +184,7 @@ end
 
 --- Gets a human-readable representation of the given object.
 ---
+---@see |vim.print()|
 ---@see https://github.com/kikito/inspect.lua
 ---@see https://github.com/mpeterv/vinspect
 local function inspect(object, options) -- luacheck: no unused
@@ -870,6 +871,7 @@ end
 --- </pre>
 ---
 --- @see |vim.inspect()|
+--- @see |:=|
 --- @return any # given arguments.
 function vim.print(...)
   if vim.in_fast_event() then
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 970bb56478..a8e75c4dc9 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -2457,7 +2457,7 @@ end
 ---                   buffer number as arguments. Example:
 ---             <pre>lua
 ---               vim.lsp.for_each_buffer_client(0, function(client, client_id, bufnr)
----                 print(vim.inspect(client))
+---                 vim.print(client)
 ---               end)
 ---             </pre>
 ---@deprecated use lsp.get_active_clients({ bufnr = bufnr }) with regular loop
-- 
cgit 


From 0ca2d11c1f473d9924c261c9dbd4e38730932bb4 Mon Sep 17 00:00:00 2001
From: Jonas Strittmatter <40792180+smjonas@users.noreply.github.com>
Date: Mon, 26 Jun 2023 12:19:13 +0200
Subject: vim-patch:9.0.1632: not all cabal config files are recognized
 (#24025)

Problem:    Not all cabal config files are recognized.
Solution:   Add a couple of patterns. (Marcin Szamotulski, closes vim/vim#12463)

https://github.com/vim/vim/commit/166cd7b801ebe4aa042a9bbd6007d1951800aaa9

Also:
- Do not expand Lua patterns in environment variables used in file patterns.
- Test $XDG_CONFIG_HOME on Windows, as it can be used by Nvim (and the runner
  sets it).

Co-authored-by: Marcin Szamotulski <coot@coot.me>
---
 runtime/lua/vim/filetype.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 7bcc67313d..fc94091622 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1809,6 +1809,8 @@ local pattern = {
   ['bzr_log%..*'] = 'bzr',
   ['.*enlightenment/.*%.cfg'] = 'c',
   ['${HOME}/cabal%.config'] = 'cabalconfig',
+  ['${HOME}/%.config/cabal/config'] = 'cabalconfig',
+  ['${XDG_CONFIG_HOME}/cabal/config'] = 'cabalconfig',
   ['cabal%.project%..*'] = starsetf('cabalproject'),
   ['.*/%.calendar/.*'] = starsetf('calendar'),
   ['.*/share/calendar/.*/calendar%..*'] = starsetf('calendar'),
@@ -2490,7 +2492,7 @@ local function match_pattern(name, path, tail, pat)
         return_early = true
         return nil
       end
-      return vim.env[env]
+      return vim.pesc(vim.env[env])
     end)
     if return_early then
       return false
-- 
cgit 


From 8ea9a70d05d6a7f9bab410101a87e6b184f14634 Mon Sep 17 00:00:00 2001
From: ObserverOfTime <chronobserver@disroot.org>
Date: Tue, 27 Jun 2023 10:14:34 +0300
Subject: vim-patch:9.0.1668: PEM files are not recognized (#24169)

Problem:    PEM files are not recognized.
Solution:   Add patterns to match PEM files. (closes vim/vim#12582)

https://github.com/vim/vim/commit/0256d76a3392aef270b38d1cf7633008e45c2003
---
 runtime/lua/vim/filetype.lua | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index fc94091622..bc880ed130 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -783,6 +783,10 @@ local extension = {
   g = 'pccts',
   pcmk = 'pcmk',
   pdf = 'pdf',
+  pem = 'pem',
+  cer = 'pem',
+  crt = 'pem',
+  csr = 'pem',
   plx = 'perl',
   prisma = 'prisma',
   psgi = 'perl',
-- 
cgit 


From 929e4865d1f59cb356f3f2f8a10ad6095b435544 Mon Sep 17 00:00:00 2001
From: NAKAI Tsuyoshi <82267684+uga-rosa@users.noreply.github.com>
Date: Wed, 28 Jun 2023 00:14:17 +0900
Subject: docs(diagnostic): return value of get() #24144

---
 runtime/lua/vim/diagnostic.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index 0d1d01b391..093bfb631e 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -767,7 +767,7 @@ end
 ---                        - namespace: (number) Limit diagnostics to the given namespace.
 ---                        - lnum: (number) Limit diagnostics to the given line number.
 ---                        - severity: See |diagnostic-severity|.
----@return Diagnostic[] table A list of diagnostic items |diagnostic-structure|.
+---@return Diagnostic[] table A list of diagnostic items |diagnostic-structure|. Keys `bufnr`, `end_lnum`, `end_col`, and `severity` are guaranteed to be present.
 function M.get(bufnr, opts)
   vim.validate({
     bufnr = { bufnr, 'n', true },
-- 
cgit 


From c7e7f1d4b4b62c75bb54e652f25c6c6b8785a7f4 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Wed, 28 Jun 2023 03:05:09 +0900
Subject: fix(treesitter): make foldexpr work without highlighting (#24167)

Problem: Treesitter fold is not updated if treesitter hightlight is not
active. More precisely, updating folds requires `LanguageTree:parse()`.

Solution: Call `parse()` before computing folds and compute folds when
lines are added/removed.

This doesn't guarantee correctness of the folds, because some changes
that don't add/remove line won't update the folds even if they should
(e.g. adding pair of braces). But it is good enough for most cases,
while not introducing big overhead.

Also, if highlighting is active, it is likely that
`TSHighlighter._on_buf` already ran `parse()` (or vice versa).
---
 runtime/lua/vim/treesitter/_fold.lua | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index a8f8c7967e..d308657237 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -162,9 +162,7 @@ local function get_folds_levels(bufnr, info, srow, erow)
 
   local parser = ts.get_parser(bufnr)
 
-  if not parser:is_valid() then
-    return
-  end
+  parser:parse()
 
   parser:for_each_tree(function(tree, ltree)
     local query = ts.query.get(ltree:lang(), 'folds')
@@ -283,10 +281,12 @@ local function on_bytes(bufnr, foldinfo, start_row, old_row, new_row)
   local end_row_old = start_row + old_row
   local end_row_new = start_row + new_row
 
-  if new_row < old_row then
-    foldinfo:remove_range(end_row_new, end_row_old)
-  elseif new_row > old_row then
-    foldinfo:add_range(start_row, end_row_new)
+  if new_row ~= old_row then
+    if new_row < old_row then
+      foldinfo:remove_range(end_row_new, end_row_old)
+    else
+      foldinfo:add_range(start_row, end_row_new)
+    end
     schedule_if_loaded(bufnr, function()
       get_folds_levels(bufnr, foldinfo, start_row, end_row_new)
       recompute_folds()
-- 
cgit 


From e85e7fc7bcccfa3b8f9e52ec4d6cb21591b50468 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Wed, 28 Jun 2023 03:05:44 +0900
Subject: fix(treesitter): handle empty region when logging (#24173)

---
 runtime/lua/vim/treesitter/languagetree.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index cabfa8ccc0..bf6333aaa4 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -447,6 +447,9 @@ end
 ---@private
 ---@param region Range6[]
 local function region_tostr(region)
+  if #region == 0 then
+    return '[]'
+  end
   local srow, scol = region[1][1], region[1][2]
   local erow, ecol = region[#region][4], region[#region][5]
   return string.format('[%d:%d-%d:%d]', srow, scol, erow, ecol)
-- 
cgit 


From 7968322e7a20b557631f4b496751658e80f6e7b0 Mon Sep 17 00:00:00 2001
From: Chinmay Dalal <dalal.chinmay.0101@gmail.com>
Date: Thu, 29 Jun 2023 19:56:29 +0530
Subject: fix(lsp): inlay_hint nil reference error #24202

Problem:
vim_lsp_inlayhint: Error executing lua: .../lsp/_inlay_hint.lua:249: attempt to index field 'applied' (a nil value)

Solution:
Assign {} to bufstates.applied in on_reload

fixes #24172
---
 runtime/lua/vim/lsp/_inlay_hint.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_inlay_hint.lua b/runtime/lua/vim/lsp/_inlay_hint.lua
index 84794841ae..ccf1b5cca4 100644
--- a/runtime/lua/vim/lsp/_inlay_hint.lua
+++ b/runtime/lua/vim/lsp/_inlay_hint.lua
@@ -188,7 +188,7 @@ function M.enable(bufnr)
       on_reload = function(_, cb_bufnr)
         clear(cb_bufnr)
         if bufstates[cb_bufnr] and bufstates[cb_bufnr].enabled then
-          bufstates[cb_bufnr] = { enabled = true }
+          bufstates[cb_bufnr] = { enabled = true, applied = {} }
         end
         M.refresh({ bufnr = cb_bufnr })
       end,
-- 
cgit 


From 37079fca58f396fd866dc7b7d87a0100c17ee760 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Fri, 30 Jun 2023 11:33:28 +0200
Subject: feat(lsp): move inlay_hint() to vim.lsp (#24130)

Allows to keep more functions hidden and gives a path forward for
further inlay_hint related functions - like applying textEdits.

See https://github.com/neovim/neovim/pull/23984#pullrequestreview-1486624668
---
 runtime/lua/vim/lsp.lua             |   7 +
 runtime/lua/vim/lsp/_inlay_hint.lua | 284 --------------------------------
 runtime/lua/vim/lsp/buf.lua         |  15 --
 runtime/lua/vim/lsp/handlers.lua    |  20 +--
 runtime/lua/vim/lsp/inlay_hint.lua  | 313 ++++++++++++++++++++++++++++++++++++
 5 files changed, 323 insertions(+), 316 deletions(-)
 delete mode 100644 runtime/lua/vim/lsp/_inlay_hint.lua
 create mode 100644 runtime/lua/vim/lsp/inlay_hint.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 1e5ce8fa10..ca4851f8d7 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -2474,6 +2474,13 @@ function lsp.with(handler, override_config)
   end
 end
 
+--- Enable/disable/toggle inlay hints for a buffer
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@param enable (boolean|nil) true/false to enable/disable, nil to toggle
+function lsp.inlay_hint(bufnr, enable)
+  return require('vim.lsp.inlay_hint')(bufnr, enable)
+end
+
 --- Helper function to use when implementing a handler.
 --- This will check that all of the keys in the user configuration
 --- are valid keys and make sense to include for this handler.
diff --git a/runtime/lua/vim/lsp/_inlay_hint.lua b/runtime/lua/vim/lsp/_inlay_hint.lua
deleted file mode 100644
index ccf1b5cca4..0000000000
--- a/runtime/lua/vim/lsp/_inlay_hint.lua
+++ /dev/null
@@ -1,284 +0,0 @@
-local util = require('vim.lsp.util')
-local log = require('vim.lsp.log')
-local api = vim.api
-local M = {}
-
----@class lsp._inlay_hint.bufstate
----@field version integer
----@field client_hint table<integer, table<integer, lsp.InlayHint[]>> client_id -> (lnum -> hints)
----@field enabled boolean Whether inlay hints are enabled for the buffer
----@field timer uv.uv_timer_t? Debounce timer associated with the buffer
----@field applied table<integer, integer> Last version of hints applied to this line
-
----@type table<integer, lsp._inlay_hint.bufstate>
-local bufstates = {}
-
-local namespace = api.nvim_create_namespace('vim_lsp_inlayhint')
-local augroup = api.nvim_create_augroup('vim_lsp_inlayhint', {})
-
---- Reset the request debounce timer of a buffer
----@private
-local function reset_timer(reset_bufnr)
-  local timer = bufstates[reset_bufnr].timer
-  if timer then
-    bufstates[reset_bufnr].timer = nil
-    if not timer:is_closing() then
-      timer:stop()
-      timer:close()
-    end
-  end
-end
-
---- |lsp-handler| for the method `textDocument/inlayHint`
---- Store hints for a specific buffer and client
----@private
-function M.on_inlayhint(err, result, ctx, _)
-  if err then
-    local _ = log.error() and log.error('inlayhint', err)
-    return
-  end
-  local bufnr = ctx.bufnr
-  if util.buf_versions[bufnr] ~= ctx.version then
-    return
-  end
-  local client_id = ctx.client_id
-  if not result then
-    return
-  end
-  local bufstate = bufstates[bufnr]
-  if not (bufstate.client_hint and bufstate.version) then
-    bufstate.client_hint = vim.defaulttable()
-    bufstate.version = ctx.version
-  end
-  local hints_by_client = bufstate.client_hint
-  local client = vim.lsp.get_client_by_id(client_id)
-
-  local new_hints_by_lnum = vim.defaulttable()
-  local num_unprocessed = #result
-  if num_unprocessed == 0 then
-    hints_by_client[client_id] = {}
-    bufstate.version = ctx.version
-    api.nvim__buf_redraw_range(bufnr, 0, -1)
-    return
-  end
-
-  local lines = api.nvim_buf_get_lines(bufnr, 0, -1, false)
-  ---@private
-  local function pos_to_byte(position)
-    local col = position.character
-    if col > 0 then
-      local line = lines[position.line + 1] or ''
-      local ok, convert_result
-      ok, convert_result = pcall(util._str_byteindex_enc, line, col, client.offset_encoding)
-      if ok then
-        return convert_result
-      end
-      return math.min(#line, col)
-    end
-    return col
-  end
-
-  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)
-  end
-
-  hints_by_client[client_id] = new_hints_by_lnum
-  bufstate.version = ctx.version
-  api.nvim__buf_redraw_range(bufnr, 0, -1)
-end
-
----@private
-local function resolve_bufnr(bufnr)
-  return bufnr > 0 and bufnr or api.nvim_get_current_buf()
-end
-
---- Refresh inlay hints for a buffer
----
----@param opts (nil|table) Optional arguments
----  - bufnr (integer, default: 0): Buffer whose hints to refresh
----  - only_visible (boolean, default: false): Whether to only refresh hints for the visible regions of the buffer
----
----@private
-function M.refresh(opts)
-  opts = opts or {}
-  local bufnr = resolve_bufnr(opts.bufnr or 0)
-  local bufstate = bufstates[bufnr]
-  if not (bufstate and bufstate.enabled) then
-    return
-  end
-  local only_visible = opts.only_visible or false
-  local buffer_windows = {}
-  for _, winid in ipairs(api.nvim_list_wins()) do
-    if api.nvim_win_get_buf(winid) == bufnr then
-      table.insert(buffer_windows, winid)
-    end
-  end
-  for _, window in ipairs(buffer_windows) do
-    local first = vim.fn.line('w0', window)
-    local last = vim.fn.line('w$', window)
-    local params = {
-      textDocument = util.make_text_document_params(bufnr),
-      range = {
-        start = { line = first - 1, character = 0 },
-        ['end'] = { line = last, character = 0 },
-      },
-    }
-    vim.lsp.buf_request(bufnr, 'textDocument/inlayHint', params)
-  end
-  if not only_visible then
-    local params = {
-      textDocument = util.make_text_document_params(bufnr),
-      range = {
-        start = { line = 0, character = 0 },
-        ['end'] = { line = api.nvim_buf_line_count(bufnr), character = 0 },
-      },
-    }
-    vim.lsp.buf_request(bufnr, 'textDocument/inlayHint', params)
-  end
-end
-
---- Clear inlay hints
----@param bufnr (integer) Buffer handle, or 0 for current
----@private
-local function clear(bufnr)
-  bufnr = resolve_bufnr(bufnr)
-  if not bufstates[bufnr] then
-    return
-  end
-  reset_timer(bufnr)
-  local bufstate = bufstates[bufnr]
-  local client_lens = (bufstate or {}).client_hint or {}
-  local client_ids = vim.tbl_keys(client_lens)
-  for _, iter_client_id in ipairs(client_ids) do
-    if bufstate then
-      bufstate.client_hint[iter_client_id] = {}
-    end
-  end
-  api.nvim_buf_clear_namespace(bufnr, namespace, 0, -1)
-  api.nvim__buf_redraw_range(bufnr, 0, -1)
-end
-
----@private
-local function make_request(request_bufnr)
-  reset_timer(request_bufnr)
-  M.refresh({ bufnr = request_bufnr })
-end
-
---- Enable inlay hints for a buffer
----@param bufnr (integer) Buffer handle, or 0 for current
----@private
-function M.enable(bufnr)
-  bufnr = resolve_bufnr(bufnr)
-  local bufstate = bufstates[bufnr]
-  if not (bufstate and bufstate.enabled) then
-    bufstates[bufnr] = { enabled = true, timer = nil, applied = {} }
-    M.refresh({ bufnr = bufnr })
-    api.nvim_buf_attach(bufnr, true, {
-      on_lines = function(_, cb_bufnr)
-        if not bufstates[cb_bufnr].enabled then
-          return true
-        end
-        reset_timer(cb_bufnr)
-        bufstates[cb_bufnr].timer = vim.defer_fn(function()
-          make_request(cb_bufnr)
-        end, 200)
-      end,
-      on_reload = function(_, cb_bufnr)
-        clear(cb_bufnr)
-        if bufstates[cb_bufnr] and bufstates[cb_bufnr].enabled then
-          bufstates[cb_bufnr] = { enabled = true, applied = {} }
-        end
-        M.refresh({ bufnr = cb_bufnr })
-      end,
-      on_detach = function(_, cb_bufnr)
-        clear(cb_bufnr)
-        bufstates[cb_bufnr] = nil
-      end,
-    })
-    api.nvim_create_autocmd('LspDetach', {
-      buffer = bufnr,
-      callback = function(opts)
-        clear(opts.buf)
-      end,
-      once = true,
-      group = augroup,
-    })
-  end
-end
-
---- Disable inlay hints for a buffer
----@param bufnr (integer) Buffer handle, or 0 for current
----@private
-function M.disable(bufnr)
-  bufnr = resolve_bufnr(bufnr)
-  if bufstates[bufnr] and bufstates[bufnr].enabled then
-    clear(bufnr)
-    bufstates[bufnr].enabled = nil
-    bufstates[bufnr].timer = nil
-  end
-end
-
---- Toggle inlay hints for a buffer
----@param bufnr (integer) Buffer handle, or 0 for current
----@private
-function M.toggle(bufnr)
-  bufnr = resolve_bufnr(bufnr)
-  local bufstate = bufstates[bufnr]
-  if bufstate and bufstate.enabled then
-    M.disable(bufnr)
-  else
-    M.enable(bufnr)
-  end
-end
-
-api.nvim_set_decoration_provider(namespace, {
-  on_win = function(_, _, bufnr, topline, botline)
-    local bufstate = bufstates[bufnr]
-    if not bufstate then
-      return
-    end
-
-    if bufstate.version ~= util.buf_versions[bufnr] then
-      return
-    end
-    local hints_by_client = bufstate.client_hint
-
-    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
-            local text = ''
-            if type(hint.label) == 'string' then
-              text = hint.label
-            else
-              for _, part in ipairs(hint.label) do
-                text = text .. part.value
-              end
-            end
-            local vt = {}
-            if hint.paddingLeft then
-              vt[#vt + 1] = { ' ' }
-            end
-            vt[#vt + 1] = { text, 'LspInlayHint' }
-            if hint.paddingRight then
-              vt[#vt + 1] = { ' ' }
-            end
-            api.nvim_buf_set_extmark(bufnr, namespace, lnum, hint.position.character, {
-              virt_text_pos = 'inline',
-              ephemeral = false,
-              virt_text = vt,
-              hl_mode = 'combine',
-            })
-          end
-        end
-        bufstate.applied[lnum] = bufstate.version
-      end
-    end
-  end,
-})
-
-return M
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index c2e0179cc4..0369725216 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -796,19 +796,4 @@ function M.execute_command(command_params)
   request('workspace/executeCommand', command_params)
 end
 
---- Enable/disable/toggle inlay hints for a buffer
----@param bufnr (integer) Buffer handle, or 0 for current
----@param enable (boolean|nil) true/false to enable/disable, nil to toggle
-function M.inlay_hint(bufnr, enable)
-  vim.validate({ enable = { enable, { 'boolean', 'nil' } }, bufnr = { bufnr, 'number' } })
-  local inlay_hint = require('vim.lsp._inlay_hint')
-  if enable then
-    inlay_hint.enable(bufnr)
-  elseif enable == false then
-    inlay_hint.disable(bufnr)
-  else
-    inlay_hint.toggle(bufnr)
-  end
-end
-
 return M
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 284e3ef2d0..625a2ed282 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -220,7 +220,7 @@ M['textDocument/codeLens'] = function(...)
 end
 
 M['textDocument/inlayHint'] = function(...)
-  return require('vim.lsp._inlay_hint').on_inlayhint(...)
+  return require('vim.lsp.inlay_hint').on_inlayhint(...)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_references
@@ -617,22 +617,8 @@ M['window/showDocument'] = function(_, result, ctx, _)
 end
 
 ---@see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspace_inlayHint_refresh
-M['workspace/inlayHint/refresh'] = function(err, _, ctx)
-  local inlay_hint = require('vim.lsp._inlay_hint')
-  if err then
-    return vim.NIL
-  end
-
-  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
-        inlay_hint.refresh({ bufnr = bufnr })
-        break
-      end
-    end
-  end
-
-  return vim.NIL
+M['workspace/inlayHint/refresh'] = function(err, result, ctx, config)
+  return require('vim.lsp.inlay_hint').on_refresh(err, result, ctx, config)
 end
 
 -- Add boilerplate error validation and logging for all of these.
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
new file mode 100644
index 0000000000..1af18bbc61
--- /dev/null
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -0,0 +1,313 @@
+local util = require('vim.lsp.util')
+local log = require('vim.lsp.log')
+local api = vim.api
+local M = {}
+
+---@class lsp._inlay_hint.bufstate
+---@field version integer
+---@field client_hint table<integer, table<integer, lsp.InlayHint[]>> client_id -> (lnum -> hints)
+---@field enabled boolean Whether inlay hints are enabled for the buffer
+---@field timer uv.uv_timer_t? Debounce timer associated with the buffer
+---@field applied table<integer, integer> Last version of hints applied to this line
+
+---@type table<integer, lsp._inlay_hint.bufstate>
+local bufstates = {}
+
+local namespace = api.nvim_create_namespace('vim_lsp_inlayhint')
+local augroup = api.nvim_create_augroup('vim_lsp_inlayhint', {})
+
+--- Reset the request debounce timer of a buffer
+---@private
+local function reset_timer(reset_bufnr)
+  local timer = bufstates[reset_bufnr].timer
+  if timer then
+    bufstates[reset_bufnr].timer = nil
+    if not timer:is_closing() then
+      timer:stop()
+      timer:close()
+    end
+  end
+end
+
+--- |lsp-handler| for the method `textDocument/inlayHint`
+--- Store hints for a specific buffer and client
+---@private
+function M.on_inlayhint(err, result, ctx, _)
+  if err then
+    local _ = log.error() and log.error('inlayhint', err)
+    return
+  end
+  local bufnr = ctx.bufnr
+  if util.buf_versions[bufnr] ~= ctx.version then
+    return
+  end
+  local client_id = ctx.client_id
+  if not result then
+    return
+  end
+  local bufstate = bufstates[bufnr]
+  if not (bufstate.client_hint and bufstate.version) then
+    bufstate.client_hint = vim.defaulttable()
+    bufstate.version = ctx.version
+  end
+  local hints_by_client = bufstate.client_hint
+  local client = vim.lsp.get_client_by_id(client_id)
+
+  local new_hints_by_lnum = vim.defaulttable()
+  local num_unprocessed = #result
+  if num_unprocessed == 0 then
+    hints_by_client[client_id] = {}
+    bufstate.version = ctx.version
+    api.nvim__buf_redraw_range(bufnr, 0, -1)
+    return
+  end
+
+  local lines = api.nvim_buf_get_lines(bufnr, 0, -1, false)
+  ---@private
+  local function pos_to_byte(position)
+    local col = position.character
+    if col > 0 then
+      local line = lines[position.line + 1] or ''
+      local ok, convert_result
+      ok, convert_result = pcall(util._str_byteindex_enc, line, col, client.offset_encoding)
+      if ok then
+        return convert_result
+      end
+      return math.min(#line, col)
+    end
+    return col
+  end
+
+  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)
+  end
+
+  hints_by_client[client_id] = new_hints_by_lnum
+  bufstate.version = ctx.version
+  api.nvim__buf_redraw_range(bufnr, 0, -1)
+end
+
+---@private
+local function resolve_bufnr(bufnr)
+  return bufnr > 0 and bufnr or api.nvim_get_current_buf()
+end
+
+--- Refresh inlay hints for a buffer
+---
+---@param opts (nil|table) Optional arguments
+---  - bufnr (integer, default: 0): Buffer whose hints to refresh
+---  - only_visible (boolean, default: false): Whether to only refresh hints for the visible regions of the buffer
+---
+---@private
+local function refresh(opts)
+  opts = opts or {}
+  local bufnr = resolve_bufnr(opts.bufnr or 0)
+  local bufstate = bufstates[bufnr]
+  if not (bufstate and bufstate.enabled) then
+    return
+  end
+  local only_visible = opts.only_visible or false
+  local buffer_windows = {}
+  for _, winid in ipairs(api.nvim_list_wins()) do
+    if api.nvim_win_get_buf(winid) == bufnr then
+      table.insert(buffer_windows, winid)
+    end
+  end
+  for _, window in ipairs(buffer_windows) do
+    local first = vim.fn.line('w0', window)
+    local last = vim.fn.line('w$', window)
+    local params = {
+      textDocument = util.make_text_document_params(bufnr),
+      range = {
+        start = { line = first - 1, character = 0 },
+        ['end'] = { line = last, character = 0 },
+      },
+    }
+    vim.lsp.buf_request(bufnr, 'textDocument/inlayHint', params)
+  end
+  if not only_visible then
+    local params = {
+      textDocument = util.make_text_document_params(bufnr),
+      range = {
+        start = { line = 0, character = 0 },
+        ['end'] = { line = api.nvim_buf_line_count(bufnr), character = 0 },
+      },
+    }
+    vim.lsp.buf_request(bufnr, 'textDocument/inlayHint', params)
+  end
+end
+
+--- |lsp-handler| for the method `textDocument/inlayHint/refresh`
+---@private
+function M.on_refresh(err, _, ctx, _)
+  if err then
+    return vim.NIL
+  end
+  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
+        refresh({ bufnr = bufnr })
+        break
+      end
+    end
+  end
+
+  return vim.NIL
+end
+
+--- Clear inlay hints
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@private
+local function clear(bufnr)
+  bufnr = resolve_bufnr(bufnr)
+  if not bufstates[bufnr] then
+    return
+  end
+  reset_timer(bufnr)
+  local bufstate = bufstates[bufnr]
+  local client_lens = (bufstate or {}).client_hint or {}
+  local client_ids = vim.tbl_keys(client_lens)
+  for _, iter_client_id in ipairs(client_ids) do
+    if bufstate then
+      bufstate.client_hint[iter_client_id] = {}
+    end
+  end
+  api.nvim_buf_clear_namespace(bufnr, namespace, 0, -1)
+  api.nvim__buf_redraw_range(bufnr, 0, -1)
+end
+
+---@private
+local function make_request(request_bufnr)
+  reset_timer(request_bufnr)
+  refresh({ bufnr = request_bufnr })
+end
+
+--- Enable inlay hints for a buffer
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@private
+local function enable(bufnr)
+  bufnr = resolve_bufnr(bufnr)
+  local bufstate = bufstates[bufnr]
+  if not (bufstate and bufstate.enabled) then
+    bufstates[bufnr] = { enabled = true, timer = nil, applied = {} }
+    refresh({ bufnr = bufnr })
+    api.nvim_buf_attach(bufnr, true, {
+      on_lines = function(_, cb_bufnr)
+        if not bufstates[cb_bufnr].enabled then
+          return true
+        end
+        reset_timer(cb_bufnr)
+        bufstates[cb_bufnr].timer = vim.defer_fn(function()
+          make_request(cb_bufnr)
+        end, 200)
+      end,
+      on_reload = function(_, cb_bufnr)
+        clear(cb_bufnr)
+        if bufstates[cb_bufnr] and bufstates[cb_bufnr].enabled then
+          bufstates[cb_bufnr] = { enabled = true, applied = {} }
+        end
+        refresh({ bufnr = cb_bufnr })
+      end,
+      on_detach = function(_, cb_bufnr)
+        clear(cb_bufnr)
+        bufstates[cb_bufnr] = nil
+      end,
+    })
+    api.nvim_create_autocmd('LspDetach', {
+      buffer = bufnr,
+      callback = function(opts)
+        clear(opts.buf)
+      end,
+      once = true,
+      group = augroup,
+    })
+  end
+end
+
+--- Disable inlay hints for a buffer
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@private
+local function disable(bufnr)
+  bufnr = resolve_bufnr(bufnr)
+  if bufstates[bufnr] and bufstates[bufnr].enabled then
+    clear(bufnr)
+    bufstates[bufnr].enabled = nil
+    bufstates[bufnr].timer = nil
+  end
+end
+
+--- Toggle inlay hints for a buffer
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@private
+local function toggle(bufnr)
+  bufnr = resolve_bufnr(bufnr)
+  local bufstate = bufstates[bufnr]
+  if bufstate and bufstate.enabled then
+    M.disable(bufnr)
+  else
+    M.enable(bufnr)
+  end
+end
+
+api.nvim_set_decoration_provider(namespace, {
+  on_win = function(_, _, bufnr, topline, botline)
+    local bufstate = bufstates[bufnr]
+    if not bufstate then
+      return
+    end
+
+    if bufstate.version ~= util.buf_versions[bufnr] then
+      return
+    end
+    local hints_by_client = bufstate.client_hint
+
+    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
+            local text = ''
+            if type(hint.label) == 'string' then
+              text = hint.label
+            else
+              for _, part in ipairs(hint.label) do
+                text = text .. part.value
+              end
+            end
+            local vt = {}
+            if hint.paddingLeft then
+              vt[#vt + 1] = { ' ' }
+            end
+            vt[#vt + 1] = { text, 'LspInlayHint' }
+            if hint.paddingRight then
+              vt[#vt + 1] = { ' ' }
+            end
+            api.nvim_buf_set_extmark(bufnr, namespace, lnum, hint.position.character, {
+              virt_text_pos = 'inline',
+              ephemeral = false,
+              virt_text = vt,
+              hl_mode = 'combine',
+            })
+          end
+        end
+        bufstate.applied[lnum] = bufstate.version
+      end
+    end
+  end,
+})
+
+return setmetatable(M, {
+  __call = function(_, bufnr, enable_)
+    vim.validate({ enable = { enable_, { 'boolean', 'nil' } }, bufnr = { bufnr, 'number' } })
+    if enable_ then
+      enable(bufnr)
+    elseif enable_ == false then
+      disable(bufnr)
+    else
+      toggle(bufnr)
+    end
+  end,
+})
-- 
cgit 


From d191bdf9d5e54722e28ddb0cccc8eb2312a234df Mon Sep 17 00:00:00 2001
From: Sanchayan Maity <sanchayan@sanchayanmaity.net>
Date: Fri, 30 Jun 2023 17:12:58 +0530
Subject: fix(lsp): fix attempt to call non existent function (#24212)

Commit 37079fc moved inlay_hint to vim.lsp() but in the process did
missed converting a call to disable/enable which are now local.

Fixes the below error when trying to toggle inlay hints.

E5108: Error executing lua /usr/local/share/nvim/runtime/lua/vim/lsp/inlay_hint.lua:248: attempt to call field 'disable' (a nil value)
stack traceback:
        /usr/local/share/nvim/runtime/lua/vim/lsp/inlay_hint.lua:248: in function 'toggle'
        /usr/local/share/nvim/runtime/lua/vim/lsp/inlay_hint.lua:310: in function 'inlay_hint'
        [string ":lua"]:1: in main chunk
---
 runtime/lua/vim/lsp/inlay_hint.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 1af18bbc61..f577a31696 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -245,9 +245,9 @@ local function toggle(bufnr)
   bufnr = resolve_bufnr(bufnr)
   local bufstate = bufstates[bufnr]
   if bufstate and bufstate.enabled then
-    M.disable(bufnr)
+    disable(bufnr)
   else
-    M.enable(bufnr)
+    enable(bufnr)
   end
 end
 
-- 
cgit 


From 11844dde81c41bded54f2383b57f8eef406f2736 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 1 Jul 2023 11:08:06 +0200
Subject: feat(treesitter): bundle markdown parser and queries (#22481)

* bundle split Markdown parser from https://github.com/MDeiml/tree-sitter-markdown
* add queries from https://github.com/nvim-treesitter/nvim-treesitter/tree/main
* upstream `#trim!` and `#inject-language!` directives

Co-authored-by: dundargoc <gocdundar@gmail.com>
---
 runtime/lua/vim/treesitter/query.lua | 60 +++++++++++++++++++++++++++++++++++-
 1 file changed, 59 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 73b561c777..7f90fa10e8 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -475,7 +475,6 @@ local directive_handlers = {
       metadata[capture_id].range = range
     end
   end,
-
   -- Transform the content of the node
   -- Example: (#gsub! @_node ".*%.(.*)" "%1")
   ['gsub!'] = function(match, _, bufnr, pred, metadata)
@@ -497,6 +496,65 @@ local directive_handlers = {
 
     metadata[id].text = text:gsub(pattern, replacement)
   end,
+  -- Trim blank lines from end of the node
+  -- Example: (#trim! @fold)
+  -- TODO(clason): generalize to arbitrary whitespace removal
+  ['trim!'] = function(match, _, bufnr, pred, metadata)
+    local node = match[pred[2]]
+    if not node then
+      return
+    end
+
+    local start_row, start_col, end_row, end_col = node:range()
+
+    -- Don't trim if region ends in middle of a line
+    if end_col ~= 0 then
+      return
+    end
+
+    while true do
+      -- As we only care when end_col == 0, always inspect one line above end_row.
+      local end_line = vim.api.nvim_buf_get_lines(bufnr, end_row - 1, end_row, true)[1]
+
+      if end_line ~= '' then
+        break
+      end
+
+      end_row = end_row - 1
+    end
+
+    -- If this produces an invalid range, we just skip it.
+    if start_row < end_row or (start_row == end_row and start_col <= end_col) then
+      metadata.range = { start_row, start_col, end_row, end_col }
+    end
+  end,
+  -- Set injection language from node text, interpreted first as language and then as filetype
+  -- Example: (#inject-language! @_lang)
+  ['inject-language!'] = function(match, _, bufnr, pred, metadata)
+    local id = pred[2]
+    local node = match[id]
+    if not node then
+      return
+    end
+
+    -- TODO(clason): replace by refactored `ts.has_parser` API
+    local has_parser = function(lang)
+      return vim._ts_has_language(lang)
+        or #vim.api.nvim_get_runtime_file('parser/' .. lang .. '.*', false) > 0
+    end
+
+    local alias = vim.treesitter.get_node_text(node, bufnr, { metadata = metadata[id] })
+    if not alias then
+      return
+    elseif has_parser(alias) then
+      metadata['injection.language'] = alias
+    else
+      local lang = vim.treesitter.language.get_lang(alias)
+      if lang and has_parser(lang) then
+        metadata['injection.language'] = lang
+      end
+    end
+  end,
 }
 
 --- Adds a new predicate to be used in queries
-- 
cgit 


From ba8f19ebb67ca27d746f4b1cd902ab3d807eace3 Mon Sep 17 00:00:00 2001
From: Raphael <glepnir@neovim.pro>
Date: Sat, 1 Jul 2023 18:42:37 +0800
Subject: fix(lsp): lint warnings, default offset_encoding #24046

- fix lint / analysis warnings
- locations_to_items(): get default offset_encoding from active client
- character_offset(): get default offset_encoding from active client
---
 runtime/lua/vim/lsp/buf.lua      |   6 +-
 runtime/lua/vim/lsp/codelens.lua |   4 +-
 runtime/lua/vim/lsp/log.lua      |   2 +-
 runtime/lua/vim/lsp/protocol.lua |  11 +++-
 runtime/lua/vim/lsp/rpc.lua      |   2 +-
 runtime/lua/vim/lsp/util.lua     | 134 +++++++++++++++++++++------------------
 6 files changed, 85 insertions(+), 74 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 0369725216..c742505ec6 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -581,9 +581,9 @@ function M.document_highlight()
 end
 
 --- Removes document highlights from current buffer.
----
-function M.clear_references()
-  util.buf_clear_references()
+--- @param bufnr integer|nil
+function M.clear_references(bufnr)
+  util.buf_clear_references(bufnr or 0)
 end
 
 ---@private
diff --git a/runtime/lua/vim/lsp/codelens.lua b/runtime/lua/vim/lsp/codelens.lua
index 5acfe90d5e..67104cc40b 100644
--- a/runtime/lua/vim/lsp/codelens.lua
+++ b/runtime/lua/vim/lsp/codelens.lua
@@ -33,11 +33,9 @@ local function execute_lens(lens, bufnr, client_id)
 
   local client = vim.lsp.get_client_by_id(client_id)
   assert(client, 'Client is required to execute lens, client_id=' .. client_id)
-
   client._exec_cmd(lens.command, { bufnr = bufnr }, function(...)
-    local result = vim.lsp.handlers['workspace/executeCommand'](...)
+    vim.lsp.handlers['workspace/executeCommand'](...)
     M.refresh()
-    return result
   end)
 end
 
diff --git a/runtime/lua/vim/lsp/log.lua b/runtime/lua/vim/lsp/log.lua
index 07d0500797..c77e7c045b 100644
--- a/runtime/lua/vim/lsp/log.lua
+++ b/runtime/lua/vim/lsp/log.lua
@@ -154,7 +154,7 @@ function log.set_level(level)
 end
 
 --- Gets the current log level.
----@return string current log level
+---@return integer current log level
 function log.get_level()
   return current_log_level
 end
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index ea38bfe237..27da891656 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -880,7 +880,7 @@ end
 
 --- Creates a normalized object describing LSP server capabilities.
 ---@param server_capabilities table Table of capabilities supported by the server
----@return table Normalized table of capabilities
+---@return table|nil Normalized table of capabilities
 function protocol.resolve_capabilities(server_capabilities)
   local TextDocumentSyncKind = protocol.TextDocumentSyncKind
   local textDocumentSync = server_capabilities.textDocumentSync
@@ -898,7 +898,8 @@ function protocol.resolve_capabilities(server_capabilities)
   elseif type(textDocumentSync) == 'number' then
     -- Backwards compatibility
     if not TextDocumentSyncKind[textDocumentSync] then
-      return nil, 'Invalid server TextDocumentSyncKind for textDocumentSync'
+      vim.notify('Invalid server TextDocumentSyncKind for textDocumentSync', vim.log.levels.ERROR)
+      return nil
     end
     server_capabilities.textDocumentSync = {
       openClose = true,
@@ -910,7 +911,11 @@ function protocol.resolve_capabilities(server_capabilities)
       },
     }
   elseif type(textDocumentSync) ~= 'table' then
-    return nil, string.format('Invalid type for textDocumentSync: %q', type(textDocumentSync))
+    vim.notify(
+      string.format('Invalid type for textDocumentSync: %q', type(textDocumentSync)),
+      vim.log.levels.ERROR
+    )
+    return nil
   end
   return server_capabilities
 end
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index 64bc732bdf..6552eaa800 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -36,7 +36,7 @@ end
 local function parse_headers(header)
   assert(type(header) == 'string', 'header must be a string')
   local headers = {}
-  for line in vim.gsplit(header, '\r\n', true) do
+  for line in vim.gsplit(header, '\r\n', { plain = true }) do
     if line == '' then
       break
     end
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 4c319e7c41..6cb91417f2 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -25,9 +25,9 @@ local default_border = {
 ---@private
 --- Check the border given by opts or the default border for the additional
 --- size it adds to a float.
----@param opts (table, optional) options for the floating window
+---@param opts table optional options for the floating window
 ---            - border (string or table) the border
----@returns (table) size of border in the form of { height = height, width = width }
+---@return table size of border in the form of { height = height, width = width }
 local function get_border_size(opts)
   local border = opts and opts.border or default_border
   local height = 0
@@ -106,7 +106,7 @@ end
 ---@private
 local function split_lines(value)
   value = string.gsub(value, '\r\n?', '\n')
-  return split(value, '\n', true)
+  return split(value, '\n', { plain = true })
 end
 
 ---@private
@@ -122,7 +122,7 @@ end
 --- Convenience wrapper around vim.str_utfindex
 ---@param line string line to be indexed
 ---@param index integer|nil byte index (utf-8), or `nil` for length
----@param encoding string utf-8|utf-16|utf-32|nil defaults to utf-16
+---@param encoding string|nil utf-8|utf-16|utf-32|nil defaults to utf-16
 ---@return integer `encoding` index of `index` in `line`
 function M._str_utfindex_enc(line, index, encoding)
   if not encoding then
@@ -150,7 +150,7 @@ end
 ---Alternative to vim.str_byteindex that takes an encoding.
 ---@param line string line to be indexed
 ---@param index integer UTF index
----@param encoding string utf-8|utf-16|utf-32|nil defaults to utf-16
+---@param encoding string utf-8|utf-16|utf-32| defaults to utf-16
 ---@return integer byte (utf-8) index of `encoding` index `index` in `line`
 function M._str_byteindex_enc(line, index, encoding)
   if not encoding then
@@ -180,8 +180,8 @@ local _str_byteindex_enc = M._str_byteindex_enc
 ---@param lines (table) Original list of strings
 ---@param A (table) Start position; a 2-tuple of {line,col} numbers
 ---@param B (table) End position; a 2-tuple of {line,col} numbers
----@param new_lines A list of strings to replace the original
----@returns (table) The modified {lines} object
+---@param new_lines (table) list of strings to replace the original
+---@return table The modified {lines} object
 function M.set_lines(lines, A, B, new_lines)
   -- 0-indexing to 1-indexing
   local i_0 = A[1] + 1
@@ -241,7 +241,7 @@ end
 ---
 ---@param bufnr integer bufnr to get the lines from
 ---@param rows integer[] zero-indexed line numbers
----@return table<integer, string> a table mapping rows to lines
+---@return table<integer, string>|string a table mapping rows to lines
 local function get_lines(bufnr, rows)
   rows = type(rows) == 'table' and rows or { rows }
 
@@ -331,8 +331,9 @@ end
 ---@private
 --- Position is a https://microsoft.github.io/language-server-protocol/specifications/specification-current/#position
 --- Returns a zero-indexed column, since set_lines() does the conversion to
----@param offset_encoding string utf-8|utf-16|utf-32
+---@param offset_encoding string|nil utf-8|utf-16|utf-32
 --- 1-indexed
+---@return integer
 local function get_line_byte_from_position(bufnr, position, offset_encoding)
   -- LSP's line and characters are 0-indexed
   -- Vim's line and columns are 1-indexed
@@ -598,8 +599,8 @@ end
 --- Can be used to extract the completion items from a
 --- `textDocument/completion` request, which may return one of
 --- `CompletionItem[]`, `CompletionList` or null.
----@param result (table) The result of a `textDocument/completion` request
----@returns (table) List of completion items
+---@param result table The result of a `textDocument/completion` request
+---@return table List of completion items
 ---@see https://microsoft.github.io/language-server-protocol/specification#textDocument_completion
 function M.extract_completion_items(result)
   if type(result) == 'table' and result.items then
@@ -658,7 +659,7 @@ end
 --- Parses snippets in a completion entry.
 ---
 ---@param input string unparsed snippet
----@returns string parsed snippet
+---@return string parsed snippet
 function M.parse_snippet(input)
   local ok, parsed = pcall(function()
     return tostring(snippet.parse(input))
@@ -718,7 +719,7 @@ end
 --- specification.
 ---
 ---@param completion_item_kind (`vim.lsp.protocol.completionItemKind`)
----@returns (`vim.lsp.protocol.completionItemKind`)
+---@return (`vim.lsp.protocol.completionItemKind`)
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_completion
 function M._get_completion_item_kind_name(completion_item_kind)
   return protocol.CompletionItemKind[completion_item_kind] or 'Unknown'
@@ -727,12 +728,12 @@ end
 --- Turns the result of a `textDocument/completion` request into vim-compatible
 --- |complete-items|.
 ---
----@param result The result of a `textDocument/completion` call, e.g. from
+---@param result table The result of a `textDocument/completion` call, e.g. from
 ---|vim.lsp.buf.completion()|, which may be one of `CompletionItem[]`,
 --- `CompletionList` or `null`
 ---@param prefix (string) the prefix to filter the completion items
----@returns { matches = complete-items table, incomplete = bool }
----@see |complete-items|
+---@return table { matches = complete-items table, incomplete = bool }
+---@see complete-items
 function M.text_document_completion_list_to_complete_items(result, prefix)
   local items = M.extract_completion_items(result)
   if vim.tbl_isempty(items) then
@@ -937,7 +938,7 @@ end
 ---
 ---@param input (`MarkedString` | `MarkedString[]` | `MarkupContent`)
 ---@param contents (table|nil) List of strings to extend with converted lines. Defaults to {}.
----@returns {contents}, extended with lines of converted markdown.
+---@return table {contents} extended with lines of converted markdown.
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover
 function M.convert_input_to_markdown_lines(input, contents)
   contents = contents or {}
@@ -985,10 +986,11 @@ end
 
 --- Converts `textDocument/SignatureHelp` response to markdown lines.
 ---
----@param signature_help Response of `textDocument/SignatureHelp`
----@param ft optional filetype that will be use as the `lang` for the label markdown code block
----@param triggers optional list of trigger characters from the lsp server. used to better determine parameter offsets
----@returns list of lines of converted markdown.
+---@param signature_help table Response of `textDocument/SignatureHelp`
+---@param ft string|nil filetype that will be use as the `lang` for the label markdown code block
+---@param triggers table|nil list of trigger characters from the lsp server. used to better determine parameter offsets
+---@return table|nil table list of lines of converted markdown.
+---@return table|nil table of active hl
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_signatureHelp
 function M.convert_signature_help_to_markdown_lines(signature_help, ft, triggers)
   if not signature_help.signatures then
@@ -1015,7 +1017,7 @@ function M.convert_signature_help_to_markdown_lines(signature_help, ft, triggers
     -- wrap inside a code block so stylize_markdown can render it properly
     label = ('```%s\n%s\n```'):format(ft, label)
   end
-  list_extend(contents, split(label, '\n', true))
+  list_extend(contents, split(label, '\n', { plain = true }))
   if signature.documentation then
     M.convert_input_to_markdown_lines(signature.documentation, contents)
   end
@@ -1087,16 +1089,16 @@ end
 --- Creates a table with sensible default options for a floating window. The
 --- table can be passed to |nvim_open_win()|.
 ---
----@param width (integer) window width (in character cells)
----@param height (integer) window height (in character cells)
----@param opts (table, optional)
+---@param width integer window width (in character cells)
+---@param height integer window height (in character cells)
+---@param opts table optional
 ---        - offset_x (integer) offset to add to `col`
 ---        - offset_y (integer) offset to add to `row`
 ---        - border (string or table) override `border`
 ---        - focusable (string or table) override `focusable`
 ---        - zindex (string or table) override `zindex`, defaults to 50
 ---        - relative ("mouse"|"cursor") defaults to "cursor"
----@returns (table) Options
+---@return table Options
 function M.make_floating_popup_options(width, height, opts)
   validate({
     opts = { opts, 't', true },
@@ -1160,7 +1162,7 @@ end
 --- Shows document and optionally jumps to the location.
 ---
 ---@param location table (`Location`|`LocationLink`)
----@param offset_encoding "utf-8" | "utf-16" | "utf-32"
+---@param offset_encoding string|nil utf-8|utf-16|utf-32
 ---@param opts table|nil options
 ---        - reuse_win (boolean) Jump to existing window if buffer is already open.
 ---        - focus (boolean) Whether to focus/jump to location if possible. Defaults to true.
@@ -1217,7 +1219,7 @@ end
 --- Jumps to a location.
 ---
 ---@param location table (`Location`|`LocationLink`)
----@param offset_encoding "utf-8" | "utf-16" | "utf-32"
+---@param offset_encoding string|nil utf-8|utf-16|utf-32
 ---@param reuse_win boolean|nil Jump to existing window if buffer is already open.
 ---@return boolean `true` if the jump succeeded
 function M.jump_to_location(location, offset_encoding, reuse_win)
@@ -1237,8 +1239,9 @@ end
 ---   - for Location, range is shown (e.g., function definition)
 ---   - for LocationLink, targetRange is shown (e.g., body of function definition)
 ---
----@param location a single `Location` or `LocationLink`
----@returns (bufnr,winnr) buffer and window number of floating window or nil
+---@param location table a single `Location` or `LocationLink`
+---@return integer|nil buffer id of float window
+---@return integer|nil window id of float window
 function M.preview_location(location, opts)
   -- location may be LocationLink or Location (more useful for the former)
   local uri = location.targetUri or location.uri
@@ -1275,10 +1278,10 @@ end
 --- Trims empty lines from input and pad top and bottom with empty lines
 ---
 ---@param contents table of lines to trim and pad
----@param opts dictionary with optional fields
+---@param opts table with optional fields
 ---             - pad_top    number of lines to pad contents at top (default 0)
 ---             - pad_bottom number of lines to pad contents at bottom (default 0)
----@return contents table of trimmed and padded lines
+---@return table table of trimmed and padded lines
 function M._trim(contents, opts)
   validate({
     contents = { contents, 't' },
@@ -1301,7 +1304,7 @@ end
 
 --- Generates a table mapping markdown code block lang to vim syntax,
 --- based on g:markdown_fenced_languages
----@return a table of lang -> syntax mappings
+---@return table table of lang -> syntax mappings
 ---@private
 local function get_markdown_fences()
   local fences = {}
@@ -1324,7 +1327,7 @@ end
 --- If you want to open a popup with fancy markdown, use `open_floating_preview` instead
 ---
 ---@param contents table of lines to show in window
----@param opts dictionary with optional fields
+---@param opts table with optional fields
 ---  - height    of floating window
 ---  - width     of floating window
 ---  - wrap_at   character to wrap at for computing height
@@ -1333,7 +1336,7 @@ end
 ---  - pad_top    number of lines to pad contents at top
 ---  - pad_bottom number of lines to pad contents at bottom
 ---  - separator insert separator after code block
----@returns width,height size of float
+---@return table stripped content
 function M.stylize_markdown(bufnr, contents, opts)
   validate({
     contents = { contents, 't' },
@@ -1480,10 +1483,10 @@ function M.stylize_markdown(bufnr, contents, opts)
     if not langs[lang] then
       -- HACK: reset current_syntax, since some syntax files like markdown won't load if it is already set
       pcall(api.nvim_buf_del_var, bufnr, 'current_syntax')
-      -- TODO(ashkan): better validation before this.
-      if not pcall(vim.cmd, string.format('syntax include %s syntax/%s.vim', lang, ft)) then
+      if #api.nvim_get_runtime_file(('syntax/%s.vim'):format(ft), true) == 0 then
         return
       end
+      vim.cmd(string.format('syntax include %s syntax/%s.vim', lang, ft))
       langs[lang] = true
     end
     vim.cmd(
@@ -1542,7 +1545,7 @@ end
 ---@param events table list of events
 ---@param winnr integer window id of preview window
 ---@param bufnrs table list of buffers where the preview window will remain visible
----@see |autocmd-events|
+---@see autocmd-events
 local function close_preview_autocmd(events, winnr, bufnrs)
   local augroup = api.nvim_create_augroup('preview_window_' .. winnr, {
     clear = true,
@@ -1572,13 +1575,14 @@ end
 --- Computes size of float needed to show contents (with optional wrapping)
 ---
 ---@param contents table of lines to show in window
----@param opts dictionary with optional fields
+---@param opts table with optional fields
 ---            - height  of floating window
 ---            - width   of floating window
 ---            - wrap_at character to wrap at for computing height
 ---            - max_width  maximal width of floating window
 ---            - max_height maximal height of floating window
----@returns width,height size of float
+---@return integer width size of float
+---@return integer height size of float
 function M._make_floating_popup_size(contents, opts)
   validate({
     contents = { contents, 't' },
@@ -1662,7 +1666,8 @@ end
 ---             - focus: (boolean, default true) If `true`, and if {focusable}
 ---                      is also `true`, focus an existing floating window with the same
 ---                      {focus_id}
----@returns bufnr,winnr buffer and window number of the newly created floating
+---@return integer bufnr of newly created float window
+---@return integer winid of newly created float window
 ---preview window
 function M.open_floating_preview(contents, syntax, opts)
   validate({
@@ -1766,7 +1771,7 @@ do --[[ References ]]
   ---
   ---@param bufnr integer Buffer id
   function M.buf_clear_references(bufnr)
-    validate({ bufnr = { bufnr, 'n', true } })
+    validate({ bufnr = { bufnr, { 'n', 'nil' }, true } })
     api.nvim_buf_clear_namespace(bufnr or 0, reference_ns, 0, -1)
   end
 
@@ -1828,13 +1833,15 @@ end)
 ---
 ---@param locations table list of `Location`s or `LocationLink`s
 ---@param offset_encoding string offset_encoding for locations utf-8|utf-16|utf-32
----@returns (table) list of items
+---                              default to first client of buffer
+---@return table list of items
 function M.locations_to_items(locations, offset_encoding)
   if offset_encoding == nil then
     vim.notify_once(
       'locations_to_items must be called with valid offset encoding',
       vim.log.levels.WARN
     )
+    offset_encoding = vim.lsp.get_active_clients({ bufnr = 0 })[1].offset_encoding
   end
 
   local items = {}
@@ -1896,7 +1903,7 @@ end
 
 --- Converts symbols to quickfix list items.
 ---
----@param symbols DocumentSymbol[] or SymbolInformation[]
+---@param symbols table DocumentSymbol[] or SymbolInformation[]
 function M.symbols_to_items(symbols, bufnr)
   ---@private
   local function _symbols_to_items(_symbols, _items, _bufnr)
@@ -1936,8 +1943,8 @@ function M.symbols_to_items(symbols, bufnr)
 end
 
 --- Removes empty lines from the beginning and end.
----@param lines (table) list of lines to trim
----@returns (table) trimmed list of lines
+---@param lines table list of lines to trim
+---@return table trimmed list of lines
 function M.trim_empty_lines(lines)
   local start = 1
   for i = 1, #lines do
@@ -1961,8 +1968,8 @@ end
 ---
 --- CAUTION: Modifies the input in-place!
 ---
----@param lines (table) list of lines
----@returns (string) filetype or "markdown" if it was unchanged.
+---@param lines table list of lines
+---@return string filetype or "markdown" if it was unchanged.
 function M.try_trim_markdown_code_blocks(lines)
   local language_id = lines[1]:match('^```(.*)')
   if language_id then
@@ -2007,7 +2014,7 @@ end
 ---
 ---@param window integer|nil: window handle or 0 for current, defaults to current
 ---@param offset_encoding string|nil utf-8|utf-16|utf-32|nil defaults to `offset_encoding` of first client of buffer of `window`
----@returns `TextDocumentPositionParams` object
+---@return table `TextDocumentPositionParams` object
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentPositionParams
 function M.make_position_params(window, offset_encoding)
   window = window or 0
@@ -2021,7 +2028,7 @@ end
 
 --- Utility function for getting the encoding of the first LSP client on the given buffer.
 ---@param bufnr (integer) buffer handle or 0 for current, defaults to current
----@returns (string) encoding first client if there is one, nil otherwise
+---@return string encoding first client if there is one, nil otherwise
 function M._get_offset_encoding(bufnr)
   validate({
     bufnr = { bufnr, 'n', true },
@@ -2060,7 +2067,7 @@ end
 ---
 ---@param window integer|nil: window handle or 0 for current, defaults to current
 ---@param offset_encoding "utf-8"|"utf-16"|"utf-32"|nil defaults to `offset_encoding` of first client of buffer of `window`
----@returns { textDocument = { uri = `current_file_uri` }, range = { start =
+---@return table { textDocument = { uri = `current_file_uri` }, range = { start =
 ---`current_position`, end = `current_position` } }
 function M.make_range_params(window, offset_encoding)
   local buf = api.nvim_win_get_buf(window or 0)
@@ -2081,7 +2088,7 @@ end
 --- Defaults to the end of the last visual selection.
 ---@param bufnr integer|nil buffer handle or 0 for current, defaults to current
 ---@param offset_encoding "utf-8"|"utf-16"|"utf-32"|nil defaults to `offset_encoding` of first client of `bufnr`
----@returns { textDocument = { uri = `current_file_uri` }, range = { start =
+---@return table { textDocument = { uri = `current_file_uri` }, range = { start =
 ---`start_position`, end = `end_position` } }
 function M.make_given_range_params(start_pos, end_pos, bufnr, offset_encoding)
   validate({
@@ -2121,15 +2128,15 @@ end
 --- Creates a `TextDocumentIdentifier` object for the current buffer.
 ---
 ---@param bufnr integer|nil: Buffer handle, defaults to current
----@returns `TextDocumentIdentifier`
+---@return table `TextDocumentIdentifier`
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentIdentifier
 function M.make_text_document_params(bufnr)
   return { uri = vim.uri_from_bufnr(bufnr or 0) }
 end
 
 --- Create the workspace params
----@param added
----@param removed
+---@param added table
+---@param removed table
 function M.make_workspace_params(added, removed)
   return { event = { added = added, removed = removed } }
 end
@@ -2137,7 +2144,7 @@ end
 ---
 ---@see 'shiftwidth'
 ---@param bufnr (integer|nil): Buffer handle, defaults to current
----@returns (integer) indentation size
+---@return (integer) indentation size
 function M.get_effective_tabstop(bufnr)
   validate({ bufnr = { bufnr, 'n', true } })
   local bo = bufnr and vim.bo[bufnr] or vim.bo
@@ -2148,7 +2155,7 @@ end
 --- Creates a `DocumentFormattingParams` object for the current buffer and cursor position.
 ---
 ---@param options table|nil with valid `FormattingOptions` entries
----@returns `DocumentFormattingParams` object
+---@return `DocumentFormattingParams` object
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_formatting
 function M.make_formatting_params(options)
   validate({ options = { options, 't', true } })
@@ -2167,8 +2174,8 @@ end
 ---@param buf integer buffer number (0 for current)
 ---@param row 0-indexed line
 ---@param col 0-indexed byte offset in line
----@param offset_encoding string utf-8|utf-16|utf-32|nil defaults to `offset_encoding` of first client of `buf`
----@returns (integer, integer) `offset_encoding` index of the character in line {row} column {col} in buffer {buf}
+---@param offset_encoding string utf-8|utf-16|utf-32 defaults to `offset_encoding` of first client of `buf`
+---@return integer `offset_encoding` index of the character in line {row} column {col} in buffer {buf}
 function M.character_offset(buf, row, col, offset_encoding)
   local line = get_line(buf, row)
   if offset_encoding == nil then
@@ -2176,6 +2183,7 @@ function M.character_offset(buf, row, col, offset_encoding)
       'character_offset must be called with valid offset encoding',
       vim.log.levels.WARN
     )
+    offset_encoding = vim.lsp.get_active_clients({ bufnr = buf })[1].offset_encoding
   end
   -- If the col is past the EOL, use the line length.
   if col > #line then
@@ -2186,11 +2194,11 @@ end
 
 --- Helper function to return nested values in language server settings
 ---
----@param settings a table of language server settings
----@param section  a string indicating the field of the settings table
----@returns (table or string) The value of settings accessed via section
+---@param settings table language server settings
+---@param section  string indicating the field of the settings table
+---@return table|string The value of settings accessed via section
 function M.lookup_section(settings, section)
-  for part in vim.gsplit(section, '.', true) do
+  for part in vim.gsplit(section, '.', { plain = true }) do
     settings = settings[part]
     if settings == nil then
       return vim.NIL
-- 
cgit 


From 4fd852b8cb88ed035203d3f9ae2e6a8258244974 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Mon, 3 Jul 2023 00:44:21 +0900
Subject: perf(treesitter): cache fold query (#24222)

perf(treesitter): cache vim.treesitter.query.get

Problem:
vim.treesitter.query.get searches and reads query files every time it's
called, if user hasn't overridden the query. So this can incur slowdown
when called frequently.

This can happen when using treesitter foldexpr. For example, when using
`:h :range!` in markdown file to format fenced codeblock, on_changedtree
in _fold.lua is triggered many times despite that the tree doesn't have
syntactic changes (might be a bug in LanguageTree). (Incidentally, the
resulting fold is incorrect due to a bug in `:h range!`.) on_changedtree
calls vim.treesitter.query.get for each tree changes. In addition, it
may request folds queries for injected languages without fold queries,
such as markdown_inline.

Solution:
* Cache the result of vim.treesitter.query.get.
* If query file was not found, fail quickly at later calls.
---
 runtime/lua/vim/treesitter/query.lua | 30 ++++++++++++++++++++++++------
 1 file changed, 24 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 7f90fa10e8..7610ef7b7f 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -195,6 +195,12 @@ function M.set(lang, query_name, text)
   explicit_queries[lang][query_name] = M.parse(lang, text)
 end
 
+--- `false` if query files didn't exist or were empty
+---@type table<string, table<string, Query|false>>
+local query_get_cache = vim.defaulttable(function()
+  return setmetatable({}, { __mode = 'v' })
+end)
+
 ---@deprecated
 function M.get_query(...)
   vim.deprecate('vim.treesitter.query.get_query()', 'vim.treesitter.query.get()', '0.10')
@@ -212,16 +218,28 @@ function M.get(lang, query_name)
     return explicit_queries[lang][query_name]
   end
 
+  local cached = query_get_cache[lang][query_name]
+  if cached then
+    return cached
+  elseif cached == false then
+    return nil
+  end
+
   local query_files = M.get_files(lang, query_name)
   local query_string = read_query_files(query_files)
 
-  if #query_string > 0 then
-    return M.parse(lang, query_string)
+  if #query_string == 0 then
+    query_get_cache[lang][query_name] = false
+    return nil
   end
+
+  local query = M.parse(lang, query_string)
+  query_get_cache[lang][query_name] = query
+  return query
 end
 
----@type {[string]: {[string]: Query}}
-local query_cache = vim.defaulttable(function()
+---@type table<string, table<string, Query>>
+local query_parse_cache = vim.defaulttable(function()
   return setmetatable({}, { __mode = 'v' })
 end)
 
@@ -250,7 +268,7 @@ end
 ---@return Query Parsed query
 function M.parse(lang, query)
   language.add(lang)
-  local cached = query_cache[lang][query]
+  local cached = query_parse_cache[lang][query]
   if cached then
     return cached
   end
@@ -259,7 +277,7 @@ function M.parse(lang, query)
   self.query = vim._ts_parse_query(lang, query)
   self.info = self.query:inspect()
   self.captures = self.info.captures
-  query_cache[lang][query] = self
+  query_parse_cache[lang][query] = self
   return self
 end
 
-- 
cgit 


From cf5f1492d702f940934b0b40024d1741e4474542 Mon Sep 17 00:00:00 2001
From: Raphael <glepnir@neovim.pro>
Date: Tue, 4 Jul 2023 20:30:31 +0800
Subject: fix(lsp): revert change to buf.clear_references() #24238

Problem: in #24046 the signature of buf.clear_references() changed, which
indirectly breaks callers that were passing "ignored" args.

Solution: because util.buf_clear_references() already defaulted to "current buffer",
the change to buf.clear_references() isn't actually needed, so just revert it.
---
 runtime/lua/vim/lsp/buf.lua  | 5 ++---
 runtime/lua/vim/lsp/util.lua | 4 ++--
 2 files changed, 4 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index c742505ec6..bac66b671d 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -581,9 +581,8 @@ function M.document_highlight()
 end
 
 --- Removes document highlights from current buffer.
---- @param bufnr integer|nil
-function M.clear_references(bufnr)
-  util.buf_clear_references(bufnr or 0)
+function M.clear_references()
+  util.buf_clear_references()
 end
 
 ---@private
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 6cb91417f2..8d6f88bb2c 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1769,9 +1769,9 @@ do --[[ References ]]
 
   --- Removes document highlights from a buffer.
   ---
-  ---@param bufnr integer Buffer id
+  ---@param bufnr integer|nil Buffer id
   function M.buf_clear_references(bufnr)
-    validate({ bufnr = { bufnr, { 'n', 'nil' }, true } })
+    validate({ bufnr = { bufnr, { 'n' }, true } })
     api.nvim_buf_clear_namespace(bufnr or 0, reference_ns, 0, -1)
   end
 
-- 
cgit 


From af6e6ccf3dee815850639ec5613dda3442caa7d6 Mon Sep 17 00:00:00 2001
From: marshmallow <marshycity@gmail.com>
Date: Sun, 30 Apr 2023 15:53:02 +1000
Subject: feat(vim.ui): vim.ui.open, "gx" without netrw
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
Co-authored-by: ii14 <59243201+ii14@users.noreply.github.com>
---
 runtime/lua/vim/lsp/handlers.lua | 15 +++-------
 runtime/lua/vim/ui.lua           | 65 ++++++++++++++++++++++++++++++++++++++++
 2 files changed, 69 insertions(+), 11 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 625a2ed282..9b102c0f84 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -573,22 +573,15 @@ M['window/showDocument'] = function(_, result, ctx, _)
 
   if result.external then
     -- TODO(lvimuser): ask the user for confirmation
-    local cmd
-    if vim.fn.has('win32') == 1 then
-      cmd = { 'cmd.exe', '/c', 'start', '""', uri }
-    elseif vim.fn.has('macunix') == 1 then
-      cmd = { 'open', uri }
-    else
-      cmd = { 'xdg-open', uri }
-    end
 
-    local ret = vim.fn.system(cmd)
-    if vim.v.shell_error ~= 0 then
+    local ret = vim.ui.open(uri)
+
+    if ret.code ~= 0 or ret == nil then
       return {
         success = false,
         error = {
           code = protocol.ErrorCodes.UnknownErrorCode,
-          message = ret,
+          message = ret and ret.stderr or 'No handler could be found',
         },
       }
     end
diff --git a/runtime/lua/vim/ui.lua b/runtime/lua/vim/ui.lua
index aaee175f3a..2200ee7bc3 100644
--- a/runtime/lua/vim/ui.lua
+++ b/runtime/lua/vim/ui.lua
@@ -104,4 +104,69 @@ function M.input(opts, on_confirm)
   end
 end
 
+--- Opens a path in the system's default handler.
+--- This function utilizes `xdg-open`, `wslview`, `explorer`, or `open` commands
+--- depending on the system to open the provided path.
+---
+--- Notifies the user if unsuccessful
+---
+---@param path string Path to be opened
+---
+---@return SystemCompleted|nil result Result of command, if an appropriate one
+---could be found.
+---
+---@see |vim.system|
+---
+--- Example:
+--- <pre>lua
+--- vim.ui.open("https://neovim.io/")
+---
+--- vim.ui.open("/path/to/file")
+--- </pre>
+function M.open(path)
+  if not path or path == '' then
+    vim.notify('os_open: No path provided', vim.log.levels.ERROR)
+    return nil
+  end
+
+  local cmd
+
+  if vim.fn.has('macunix') == 1 then
+    cmd = { 'open', path }
+  elseif vim.fn.has('win32') == 1 then
+    cmd = { 'explorer', path }
+  else
+    if vim.fn.executable('wslview') == 1 then
+      cmd = { 'wslview', path }
+    elseif vim.fn.executable('xdg-open') == 1 then
+      cmd = { 'xdg-open', path }
+    else
+      vim.notify(
+        'os_open: Could not find an appropriate command to use (Is xdg-open installed?)',
+        vim.log.levels.ERROR
+      )
+
+      return nil
+    end
+  end
+
+  local ret = vim
+    .system(cmd, {
+      text = true,
+      detach = true,
+    })
+    :wait()
+
+  if ret.code ~= 0 then
+    local msg = {
+      'Failed to open path',
+      ret,
+      vim.inspect(cmd),
+    }
+    vim.notify(table.concat(msg, '\n'), vim.log.levels.ERROR)
+  end
+
+  return ret
+end
+
 return M
-- 
cgit 


From 67b2ed1004ae551c9fe1bbd29a86b5a301570800 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Sun, 2 Jul 2023 16:51:30 +0200
Subject: fix(gx): visual selection, expand env vars

---
Rejected experiment: move vim.ui.open() to vim.env.open()

Problem:
`vim.ui` is where user-interface "providers" live, which can be
overridden. It would also be useful to have a "providers" namespace for
platform-specific features such as "open", clipboard, python, and the other
providers listed in `:help providers`. We could overload `vim.ui` to
serve that purpose as the single "providers" namespace, but
`vim.ui.nodejs()` for example seems awkward.

Solution:
`vim.env` currently has too narrow of a purpose. Overload it to also be
a namespace for `vim.env.open`.

diff --git a/runtime/lua/vim/_meta.lua b/runtime/lua/vim/_meta.lua
index 913f1fe20348..17d05ff37595 100644
--- a/runtime/lua/vim/_meta.lua
+++ b/runtime/lua/vim/_meta.lua
@@ -37,8 +37,28 @@ local options_info = setmetatable({}, {
   end,
 })

-vim.env = setmetatable({}, {
-  __index = function(_, k)
+vim.env = setmetatable({
+  open = setmetatable({}, {
+      __call = function(_, uri)
+        print('xxxxx'..uri)
+        return true
+      end,
+      __tostring = function()
+        local v = vim.fn.getenv('open')
+        if v == vim.NIL then
+          return nil
+        end
+        return v
+      end,
+    })
+  },
+  {
+  __index = function(t, k, ...)
+    if k == 'open' then
+      error()
+      -- vim.print({...})
+      -- return rawget(t, k)
+    end
     local v = vim.fn.getenv(k)
     if v == vim.NIL then
       return nil
---
 runtime/lua/vim/lsp/handlers.lua |  6 ++--
 runtime/lua/vim/ui.lua           | 75 ++++++++++++++++------------------------
 2 files changed, 33 insertions(+), 48 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 9b102c0f84..79d3f7aab0 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -576,12 +576,12 @@ M['window/showDocument'] = function(_, result, ctx, _)
 
     local ret = vim.ui.open(uri)
 
-    if ret.code ~= 0 or ret == nil then
+    if ret == nil or ret.code ~= 0 then
       return {
         success = false,
         error = {
           code = protocol.ErrorCodes.UnknownErrorCode,
-          message = ret and ret.stderr or 'No handler could be found',
+          message = ret and ret.stderr or 'No handler found',
         },
       }
     end
@@ -593,7 +593,7 @@ M['window/showDocument'] = function(_, result, ctx, _)
   local client = vim.lsp.get_client_by_id(client_id)
   local client_name = client and client.name or string.format('id=%d', client_id)
   if not client then
-    err_message({ 'LSP[', client_name, '] client has shut down after sending ', ctx.method })
+    err_message('LSP[', client_name, '] client has shut down after sending ', ctx.method)
     return vim.NIL
   end
 
diff --git a/runtime/lua/vim/ui.lua b/runtime/lua/vim/ui.lua
index 2200ee7bc3..3ffa329f74 100644
--- a/runtime/lua/vim/ui.lua
+++ b/runtime/lua/vim/ui.lua
@@ -104,69 +104,54 @@ function M.input(opts, on_confirm)
   end
 end
 
---- Opens a path in the system's default handler.
---- This function utilizes `xdg-open`, `wslview`, `explorer`, or `open` commands
---- depending on the system to open the provided path.
+--- Opens `path` with the system default handler (macOS `open`, Windows `explorer.exe`, Linux
+--- `xdg-open`, …), or shows a message on failure.
 ---
---- Notifies the user if unsuccessful
+--- Expands "~/" and environment variables in filesystem paths.
 ---
----@param path string Path to be opened
----
----@return SystemCompleted|nil result Result of command, if an appropriate one
----could be found.
----
----@see |vim.system|
----
---- Example:
+--- Examples:
 --- <pre>lua
 --- vim.ui.open("https://neovim.io/")
----
---- vim.ui.open("/path/to/file")
+--- vim.ui.open("~/path/to/file")
+--- vim.ui.open("$VIMRUNTIME")
 --- </pre>
+---
+---@param path string Path or URL to open
+---
+---@return SystemCompleted|nil result Command result, or nil if not found.
+---
+---@see |vim.system()|
 function M.open(path)
-  if not path or path == '' then
-    vim.notify('os_open: No path provided', vim.log.levels.ERROR)
-    return nil
+  vim.validate{
+    path={path, 'string'}
+  }
+  local is_uri = path:match('%w+:')
+  if not is_uri then
+    path = vim.fn.expand(path)
   end
 
   local cmd
 
-  if vim.fn.has('macunix') == 1 then
+  if vim.fn.has('mac') == 1 then
     cmd = { 'open', path }
   elseif vim.fn.has('win32') == 1 then
     cmd = { 'explorer', path }
+  elseif vim.fn.executable('wslview') == 1 then
+    cmd = { 'wslview', path }
+  elseif vim.fn.executable('xdg-open') == 1 then
+    cmd = { 'xdg-open', path }
   else
-    if vim.fn.executable('wslview') == 1 then
-      cmd = { 'wslview', path }
-    elseif vim.fn.executable('xdg-open') == 1 then
-      cmd = { 'xdg-open', path }
-    else
-      vim.notify(
-        'os_open: Could not find an appropriate command to use (Is xdg-open installed?)',
-        vim.log.levels.ERROR
-      )
-
-      return nil
-    end
+    vim.notify('vim.ui.open: no handler found (tried: wslview, xdg-open)', vim.log.levels.ERROR)
+    return nil
   end
 
-  local ret = vim
-    .system(cmd, {
-      text = true,
-      detach = true,
-    })
-    :wait()
-
-  if ret.code ~= 0 then
-    local msg = {
-      'Failed to open path',
-      ret,
-      vim.inspect(cmd),
-    }
-    vim.notify(table.concat(msg, '\n'), vim.log.levels.ERROR)
+  local rv = vim.system(cmd, { text = true, detach = true, }):wait()
+  if rv.code ~= 0 then
+    local msg = ('vim.ui.open: command failed (%d): %s'):format(rv.code, vim.inspect(cmd))
+    vim.notify(msg, vim.log.levels.ERROR)
   end
 
-  return ret
+  return rv
 end
 
 return M
-- 
cgit 


From e644e7ce0b36dd5e75770f3faa0a84f15e2561e8 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Tue, 4 Jul 2023 23:33:23 +0200
Subject: fix(vim.ui.open): return (don't show) error message

Problem:
Showing an error via vim.notify() makes it awkward for callers such as
lsp/handlers.lua to avoid showing redundant errors.

Solution:
Return the message instead of showing it. Let the caller decide whether
and when to show the message.
---
 runtime/lua/vim/lsp/handlers.lua |  5 ++---
 runtime/lua/vim/ui.lua           | 20 ++++++++++----------
 2 files changed, 12 insertions(+), 13 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 79d3f7aab0..70781cb7a6 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -573,15 +573,14 @@ M['window/showDocument'] = function(_, result, ctx, _)
 
   if result.external then
     -- TODO(lvimuser): ask the user for confirmation
-
-    local ret = vim.ui.open(uri)
+    local ret, err = vim.ui.open(uri)
 
     if ret == nil or ret.code ~= 0 then
       return {
         success = false,
         error = {
           code = protocol.ErrorCodes.UnknownErrorCode,
-          message = ret and ret.stderr or 'No handler found',
+          message = ret and ret.stderr or err,
         },
       }
     end
diff --git a/runtime/lua/vim/ui.lua b/runtime/lua/vim/ui.lua
index 3ffa329f74..fd06611da2 100644
--- a/runtime/lua/vim/ui.lua
+++ b/runtime/lua/vim/ui.lua
@@ -105,7 +105,7 @@ function M.input(opts, on_confirm)
 end
 
 --- Opens `path` with the system default handler (macOS `open`, Windows `explorer.exe`, Linux
---- `xdg-open`, …), or shows a message on failure.
+--- `xdg-open`, …), or returns (but does not show) an error message on failure.
 ---
 --- Expands "~/" and environment variables in filesystem paths.
 ---
@@ -118,13 +118,14 @@ end
 ---
 ---@param path string Path or URL to open
 ---
----@return SystemCompleted|nil result Command result, or nil if not found.
+---@return SystemCompleted|nil # Command result, or nil if not found.
+---@return string|nil # Error message on failure
 ---
 ---@see |vim.system()|
 function M.open(path)
-  vim.validate{
-    path={path, 'string'}
-  }
+  vim.validate({
+    path = { path, 'string' },
+  })
   local is_uri = path:match('%w+:')
   if not is_uri then
     path = vim.fn.expand(path)
@@ -141,17 +142,16 @@ function M.open(path)
   elseif vim.fn.executable('xdg-open') == 1 then
     cmd = { 'xdg-open', path }
   else
-    vim.notify('vim.ui.open: no handler found (tried: wslview, xdg-open)', vim.log.levels.ERROR)
-    return nil
+    return nil, 'vim.ui.open: no handler found (tried: wslview, xdg-open)'
   end
 
-  local rv = vim.system(cmd, { text = true, detach = true, }):wait()
+  local rv = vim.system(cmd, { text = true, detach = true }):wait()
   if rv.code ~= 0 then
     local msg = ('vim.ui.open: command failed (%d): %s'):format(rv.code, vim.inspect(cmd))
-    vim.notify(msg, vim.log.levels.ERROR)
+    return rv, msg
   end
 
-  return rv
+  return rv, nil
 end
 
 return M
-- 
cgit 


From 2afb04758c341e17c70b8d2e3869c901c8cdb7d2 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 6 Jul 2023 12:56:19 +0800
Subject: fix(vim.system): close check handle (#24270)

Fix hang after running vim.system() with sanitizers.
---
 runtime/lua/vim/_system.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_system.lua b/runtime/lua/vim/_system.lua
index eadf801a31..ff566866c0 100644
--- a/runtime/lua/vim/_system.lua
+++ b/runtime/lua/vim/_system.lua
@@ -287,6 +287,7 @@ function M.run(cmd, opts, on_exit)
         end
       end
       check:stop()
+      check:close()
 
       state.done = true
       state.result = {
-- 
cgit 


From abd380e28d48dd155b1e29cd2453f13b28bf7e08 Mon Sep 17 00:00:00 2001
From: Steven Ward <planet36@users.noreply.github.com>
Date: Mon, 5 Jun 2023 22:05:51 -0500
Subject: fix(defaults): visual mode star (*,#) is fragile

Problem:
Visual mode "*", "#" mappings don't work on text with "/", "\", "?", and
newlines.

Solution:
Get the visual selection and escape it as a search pattern.
Add functions vim.get_visual_selection and _search_for_visual_selection.

Fix #21676
---
 runtime/lua/vim/_editor.lua | 84 +++++++++++++++++++++++++++++++++++++++++----
 1 file changed, 78 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index ab20c36b17..e00d512a2a 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -435,7 +435,7 @@ vim.cmd = setmetatable({}, {
 do
   local validate = vim.validate
 
-  --@private
+  ---@private
   local function make_dict_accessor(scope, handle)
     validate({
       scope = { scope, 's' },
@@ -535,6 +535,55 @@ function vim.region(bufnr, pos1, pos2, regtype, inclusive)
   return region
 end
 
+--- Gets the content of the visual selection.
+---
+--- The result is either a string or, if {list} is `true`, a list of strings.
+--- If not in any |visual-mode|, `nil` is returned.
+---
+--- @param list boolean|nil
+---        Return a list of strings instead of a string.  See |getreg()|.
+---        Defaults to `false`.
+--- @param append_empty boolean|nil
+---        Append an empty string to the result when in |linewise-visual| mode and {list} is `true`.
+---        This will preserve the trailing newline of the selection when the result is concatenated with `"\n"`.
+---        Defaults to `false`.
+--- @return string|table
+function vim.get_visual_selection(list, append_empty)
+  list = list or false
+  append_empty = append_empty or false
+
+  local mode = vim.api.nvim_get_mode().mode
+  if mode ~= 'v' and mode ~= 'V' and mode:byte() ~= 22 then
+    return nil
+  end
+
+  local reg_name_unnamed = '"'
+  local reg_name_yank = '0'
+
+  local reg_info_unnamed = vim.fn.getreginfo(reg_name_unnamed)
+  local reg_info_yank = vim.fn.getreginfo(reg_name_yank)
+  local opt_clipboard = vim.o.clipboard
+  local opt_report = vim.o.report
+
+  vim.o.clipboard = ''
+  vim.o.report = vim.v.maxcol
+
+  vim.api.nvim_feedkeys('y', 'nx', false)
+
+  local yanked = vim.fn.getreg(reg_name_yank, 1, list)
+
+  vim.fn.setreg(reg_name_unnamed, reg_info_unnamed)
+  vim.fn.setreg(reg_name_yank, reg_info_yank)
+  vim.o.clipboard = opt_clipboard
+  vim.o.report = opt_report
+
+  if list and append_empty and mode == 'V' then
+    table.insert(yanked, '')
+  end
+
+  return yanked
+end
+
 --- Defers calling {fn} until {timeout} ms passes.
 ---
 --- Use to do a one-shot timer that calls {fn}
@@ -985,7 +1034,7 @@ end
 ---                              Defaults to "Nvim".
 ---@param backtrace   boolean|nil Prints backtrace. Defaults to true.
 ---
----@returns Deprecated message, or nil if no message was shown.
+---@return Deprecated message, or nil if no message was shown.
 function vim.deprecate(name, alternative, version, plugin, backtrace)
   local msg = ('%s is deprecated'):format(name)
   plugin = plugin or 'Nvim'
@@ -1010,9 +1059,28 @@ end
 function vim._init_default_mappings()
   -- mappings
 
-  --@private
+  ---@private
+  local function _search_for_visual_selection(search_prefix)
+    if search_prefix ~= '/' and search_prefix ~= '?' then
+      return
+    end
+    -- Escape these characters
+    local replacements = {
+      [search_prefix] = [[\]] .. search_prefix,
+      [ [[\]] ] = [[\\]],
+      ['\t'] = [[\t]],
+      ['\n'] = [[\n]],
+    }
+    local pattern = '[' .. table.concat(vim.tbl_keys(replacements), '') .. ']'
+    local visual_selection = vim.get_visual_selection(false)
+    local escaped_visual_selection = string.gsub(visual_selection, pattern, replacements)
+    local search_cmd = search_prefix .. [[\V]] .. escaped_visual_selection .. '\n'
+    vim.api.nvim_feedkeys(search_cmd, 'nx', true)
+  end
+
+  ---@private
   local function map(mode, lhs, rhs)
-    vim.api.nvim_set_keymap(mode, lhs, rhs, { noremap = true, desc = 'Nvim builtin' })
+    vim.keymap.set(mode, lhs, rhs, { noremap = true, desc = 'Nvim builtin' })
   end
 
   map('n', 'Y', 'y$')
@@ -1020,8 +1088,12 @@ function vim._init_default_mappings()
   map('n', '<C-L>', '<Cmd>nohlsearch<Bar>diffupdate<Bar>normal! <C-L><CR>')
   map('i', '<C-U>', '<C-G>u<C-U>')
   map('i', '<C-W>', '<C-G>u<C-W>')
-  map('x', '*', 'y/\\V<C-R>"<CR>')
-  map('x', '#', 'y?\\V<C-R>"<CR>')
+  map('x', '*', function()
+    _search_for_visual_selection('/')
+  end)
+  map('x', '#', function()
+    _search_for_visual_selection('?')
+  end)
   -- Use : instead of <Cmd> so that ranges are supported. #19365
   map('n', '&', ':&&<CR>')
 
-- 
cgit 


From f39ca5df232cb6e70b1932b7444840acf42cf87b Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Wed, 5 Jul 2023 19:47:43 +0200
Subject: refactor(defaults): use vim.region for visual star (*,#)

Problem:
The parent commit added a new vim.get_visual_selection() function to
improve visual star. But that is redundant with vim.region(). Any
current limitations of vim.region() should be fixed instead of adding
a new function.

Solution:
Delete vim.get_visual_selection().
Use vim.region() to get the visual selection.
TODO: fails with visual "block" selections.
---
 runtime/lua/vim/_editor.lua | 107 ++++++++++++++------------------------------
 1 file changed, 33 insertions(+), 74 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index e00d512a2a..6f701e9ae9 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -535,55 +535,6 @@ function vim.region(bufnr, pos1, pos2, regtype, inclusive)
   return region
 end
 
---- Gets the content of the visual selection.
----
---- The result is either a string or, if {list} is `true`, a list of strings.
---- If not in any |visual-mode|, `nil` is returned.
----
---- @param list boolean|nil
----        Return a list of strings instead of a string.  See |getreg()|.
----        Defaults to `false`.
---- @param append_empty boolean|nil
----        Append an empty string to the result when in |linewise-visual| mode and {list} is `true`.
----        This will preserve the trailing newline of the selection when the result is concatenated with `"\n"`.
----        Defaults to `false`.
---- @return string|table
-function vim.get_visual_selection(list, append_empty)
-  list = list or false
-  append_empty = append_empty or false
-
-  local mode = vim.api.nvim_get_mode().mode
-  if mode ~= 'v' and mode ~= 'V' and mode:byte() ~= 22 then
-    return nil
-  end
-
-  local reg_name_unnamed = '"'
-  local reg_name_yank = '0'
-
-  local reg_info_unnamed = vim.fn.getreginfo(reg_name_unnamed)
-  local reg_info_yank = vim.fn.getreginfo(reg_name_yank)
-  local opt_clipboard = vim.o.clipboard
-  local opt_report = vim.o.report
-
-  vim.o.clipboard = ''
-  vim.o.report = vim.v.maxcol
-
-  vim.api.nvim_feedkeys('y', 'nx', false)
-
-  local yanked = vim.fn.getreg(reg_name_yank, 1, list)
-
-  vim.fn.setreg(reg_name_unnamed, reg_info_unnamed)
-  vim.fn.setreg(reg_name_yank, reg_info_yank)
-  vim.o.clipboard = opt_clipboard
-  vim.o.report = opt_report
-
-  if list and append_empty and mode == 'V' then
-    table.insert(yanked, '')
-  end
-
-  return yanked
-end
-
 --- Defers calling {fn} until {timeout} ms passes.
 ---
 --- Use to do a one-shot timer that calls {fn}
@@ -1034,7 +985,7 @@ end
 ---                              Defaults to "Nvim".
 ---@param backtrace   boolean|nil Prints backtrace. Defaults to true.
 ---
----@return Deprecated message, or nil if no message was shown.
+---@return string|nil # Deprecated message, or nil if no message was shown.
 function vim.deprecate(name, alternative, version, plugin, backtrace)
   local msg = ('%s is deprecated'):format(name)
   plugin = plugin or 'Nvim'
@@ -1049,9 +1000,7 @@ function vim.deprecate(name, alternative, version, plugin, backtrace)
   if displayed and backtrace ~= false then
     vim.notify(debug.traceback('', 2):sub(2), vim.log.levels.WARN)
   end
-  if displayed then
-    return msg
-  end
+  return displayed and msg or nil
 end
 
 --- Create builtin mappings (incl. menus).
@@ -1060,27 +1009,37 @@ function vim._init_default_mappings()
   -- mappings
 
   ---@private
-  local function _search_for_visual_selection(search_prefix)
-    if search_prefix ~= '/' and search_prefix ~= '?' then
-      return
+  local function region_chunks(region)
+    local chunks = {}
+    local maxcol = vim.v.maxcol
+    for line, cols in vim.spairs(region) do
+      local endcol = cols[2] == maxcol and -1 or cols[2]
+      local chunk = vim.api.nvim_buf_get_text(0, line, cols[1], line, endcol, {})[1]
+      table.insert(chunks, chunk)
     end
-    -- Escape these characters
-    local replacements = {
-      [search_prefix] = [[\]] .. search_prefix,
-      [ [[\]] ] = [[\\]],
-      ['\t'] = [[\t]],
-      ['\n'] = [[\n]],
-    }
-    local pattern = '[' .. table.concat(vim.tbl_keys(replacements), '') .. ']'
-    local visual_selection = vim.get_visual_selection(false)
-    local escaped_visual_selection = string.gsub(visual_selection, pattern, replacements)
-    local search_cmd = search_prefix .. [[\V]] .. escaped_visual_selection .. '\n'
+    return chunks
+  end
+
+  ---@private
+  local function _visual_search(cmd)
+    assert(cmd == '/' or cmd == '?')
+    vim.api.nvim_feedkeys('\27', 'nx', true) -- Escape visual mode.
+    local region = vim.region(0, "'<", "'>", vim.fn.visualmode(), vim.o.selection == 'inclusive')
+    local chunks = region_chunks(region)
+    local esc_chunks = vim
+      .iter(chunks)
+      :map(function(v)
+        return vim.fn.escape(v, [[/\]])
+      end)
+      :totable()
+    local esc_pat = table.concat(esc_chunks, [[\n]])
+    local search_cmd = ([[%s\V%s%s]]):format(cmd, esc_pat, '\n')
     vim.api.nvim_feedkeys(search_cmd, 'nx', true)
   end
 
   ---@private
   local function map(mode, lhs, rhs)
-    vim.keymap.set(mode, lhs, rhs, { noremap = true, desc = 'Nvim builtin' })
+    vim.keymap.set(mode, lhs, rhs, { desc = 'Nvim builtin' })
   end
 
   map('n', 'Y', 'y$')
@@ -1088,12 +1047,12 @@ function vim._init_default_mappings()
   map('n', '<C-L>', '<Cmd>nohlsearch<Bar>diffupdate<Bar>normal! <C-L><CR>')
   map('i', '<C-U>', '<C-G>u<C-U>')
   map('i', '<C-W>', '<C-G>u<C-W>')
-  map('x', '*', function()
-    _search_for_visual_selection('/')
-  end)
-  map('x', '#', function()
-    _search_for_visual_selection('?')
-  end)
+  vim.keymap.set('x', '*', function()
+    _visual_search('/')
+  end, { desc = 'Nvim builtin', silent = true })
+  vim.keymap.set('x', '#', function()
+    _visual_search('?')
+  end, { desc = 'Nvim builtin', silent = true })
   -- Use : instead of <Cmd> so that ranges are supported. #19365
   map('n', '&', ':&&<CR>')
 
-- 
cgit 


From c44d819ae1f29cd34ee3b2350b5c702caed949c3 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Fri, 7 Jul 2023 19:12:46 +0900
Subject: fix(treesitter): update folds in all relevant windows (#24230)

Problem: When using treesitter foldexpr,
* :diffput/get open diff folds, and
* folds are not updated in other windows that contain the updated
  buffer.

Solution: Update folds in all windows that contain the updated buffer
and use expr foldmethod.
---
 runtime/lua/vim/treesitter/_fold.lua | 34 ++++++++++++++++++++++++++--------
 1 file changed, 26 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index d308657237..a02d0a584d 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -232,20 +232,40 @@ local M = {}
 ---@type table<integer,TS.FoldInfo>
 local foldinfos = {}
 
-local function recompute_folds()
+--- Update the folds in the windows that contain the buffer and use expr foldmethod (assuming that
+--- the user doesn't use different foldexpr for the same buffer).
+---
+--- Nvim usually automatically updates folds when text changes, but it doesn't work here because
+--- FoldInfo update is scheduled. So we do it manually.
+local function foldupdate(bufnr)
+  local function do_update()
+    for _, win in ipairs(vim.fn.win_findbuf(bufnr)) do
+      api.nvim_win_call(win, function()
+        if vim.wo.foldmethod == 'expr' then
+          vim._foldupdate()
+        end
+      end)
+    end
+  end
+
   if api.nvim_get_mode().mode == 'i' then
     -- foldUpdate() is guarded in insert mode. So update folds on InsertLeave
     api.nvim_create_autocmd('InsertLeave', {
       once = true,
-      callback = vim._foldupdate,
+      callback = do_update,
     })
     return
   end
 
-  vim._foldupdate()
+  do_update()
 end
 
---- Schedule a function only if bufnr is loaded
+--- Schedule a function only if bufnr is loaded.
+--- We schedule fold level computation for the following reasons:
+--- * queries seem to use the old buffer state in on_bytes for some unknown reason;
+--- * to avoid textlock;
+--- * to avoid infinite recursion:
+---   get_folds_levels → parse → _do_callback → on_changedtree → get_folds_levels.
 ---@param bufnr integer
 ---@param fn function
 local function schedule_if_loaded(bufnr, fn)
@@ -261,14 +281,12 @@ end
 ---@param foldinfo TS.FoldInfo
 ---@param tree_changes Range4[]
 local function on_changedtree(bufnr, foldinfo, tree_changes)
-  -- For some reason, queries seem to use the old buffer state in on_bytes.
-  -- Get around this by scheduling and manually updating folds.
   schedule_if_loaded(bufnr, function()
     for _, change in ipairs(tree_changes) do
       local srow, _, erow = Range.unpack4(change)
       get_folds_levels(bufnr, foldinfo, srow, erow)
     end
-    recompute_folds()
+    foldupdate(bufnr)
   end)
 end
 
@@ -289,7 +307,7 @@ local function on_bytes(bufnr, foldinfo, start_row, old_row, new_row)
     end
     schedule_if_loaded(bufnr, function()
       get_folds_levels(bufnr, foldinfo, start_row, end_row_new)
-      recompute_folds()
+      foldupdate(bufnr)
     end)
   end
 end
-- 
cgit 


From c379d72c490544b3a56eb0e52ce3c8ef740051d8 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 7 Jul 2023 16:37:36 +0100
Subject: feat(lua): allow vim.wo to be double indexed (#20288)

* feat(lua): allow vim.wo to be double indexed

Problem: `vim.wo` does not implement `setlocal`
Solution: Allow `vim.wo` to be double indexed

Co-authored-by: Christian Clason <c.clason@uni-graz.at>
---
 runtime/lua/vim/_meta.lua | 53 +++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 44 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta.lua b/runtime/lua/vim/_meta.lua
index 913f1fe203..41e6e8be86 100644
--- a/runtime/lua/vim/_meta.lua
+++ b/runtime/lua/vim/_meta.lua
@@ -67,25 +67,60 @@ local function opt_validate(option_name, target_scope)
   end
 end
 
-local function new_opt_accessor(handle, scope)
+local function new_buf_opt_accessor(bufnr)
   return setmetatable({}, {
     __index = function(_, k)
-      if handle == nil and type(k) == 'number' then
-        return new_opt_accessor(k, scope)
+      if bufnr == nil and type(k) == 'number' then
+        return new_buf_opt_accessor(k)
       end
-      opt_validate(k, scope)
-      return api.nvim_get_option_value(k, { [scope] = handle or 0 })
+      opt_validate(k, 'buf')
+      return api.nvim_get_option_value(k, { buf = bufnr or 0 })
     end,
 
     __newindex = function(_, k, v)
-      opt_validate(k, scope)
-      return api.nvim_set_option_value(k, v, { [scope] = handle or 0 })
+      opt_validate(k, 'buf')
+      return api.nvim_set_option_value(k, v, { buf = bufnr or 0 })
     end,
   })
 end
 
-vim.bo = new_opt_accessor(nil, 'buf')
-vim.wo = new_opt_accessor(nil, 'win')
+vim.bo = new_buf_opt_accessor()
+
+local function new_win_opt_accessor(winid, bufnr)
+  return setmetatable({}, {
+    __index = function(_, k)
+      if bufnr == nil and type(k) == 'number' then
+        if winid == nil then
+          return new_win_opt_accessor(k)
+        else
+          return new_win_opt_accessor(winid, k)
+        end
+      end
+
+      if bufnr ~= nil and bufnr ~= 0 then
+        error('only bufnr=0 is supported')
+      end
+
+      opt_validate(k, 'win')
+      -- TODO(lewis6991): allow passing both buf and win to nvim_get_option_value
+      return api.nvim_get_option_value(k, {
+        scope = bufnr and 'local' or nil,
+        win = winid or 0,
+      })
+    end,
+
+    __newindex = function(_, k, v)
+      opt_validate(k, 'win')
+      -- TODO(lewis6991): allow passing both buf and win to nvim_set_option_value
+      return api.nvim_set_option_value(k, v, {
+        scope = bufnr and 'local' or nil,
+        win = winid or 0,
+      })
+    end,
+  })
+end
+
+vim.wo = new_win_opt_accessor()
 
 -- vim global option
 --  this ONLY sets the global option. like `setglobal`
-- 
cgit 


From 21fa19f3e8c1d7b427c6d7c0dbcd6702d1e4e397 Mon Sep 17 00:00:00 2001
From: Chinmay Dalal <dalal.chinmay.0101@gmail.com>
Date: Sat, 8 Jul 2023 12:44:52 +0530
Subject: fix(lsp): don't use hl_mode = combine for inlay hints #24276

Problem: `hl_mode` for inlay hints is `combine`, causing bugs like
inlay hints using highlights from the previous character
(#24152, #24068)

Solution: Don't use hl_mode=combine for inlay hints.
---
 runtime/lua/vim/lsp/inlay_hint.lua | 1 -
 1 file changed, 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index f577a31696..6426b0c039 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -289,7 +289,6 @@ api.nvim_set_decoration_provider(namespace, {
               virt_text_pos = 'inline',
               ephemeral = false,
               virt_text = vt,
-              hl_mode = 'combine',
             })
           end
         end
-- 
cgit 


From 00d2f4b96eb9c8dcb6b9f67e256bb7faa19354db Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Tue, 4 Jul 2023 19:22:04 +0200
Subject: docs: MAINTAIN.md, nvim_get_mark

---
 runtime/lua/vim/_editor.lua | 38 +++++++++++++++++++-------------------
 1 file changed, 19 insertions(+), 19 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 6f701e9ae9..80e7518b01 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -460,17 +460,18 @@ do
   vim.t = make_dict_accessor('t')
 end
 
---- Get a table of lines with start, end columns for a region marked by two points.
---- Input and output positions are (0,0)-indexed and indicate byte positions.
+--- Gets a dict of line segment ("chunk") positions for the region from `pos1` to `pos2`.
 ---
----@param bufnr integer number of buffer
----@param pos1 integer[]|string start of region as a (line, column) tuple or string accepted by |getpos()|
----@param pos2 integer[]|string end of region as a (line, column) tuple or string accepted by |getpos()|
----@param regtype string type of selection, see |setreg()|
----@param inclusive boolean indicating whether column of pos2 is inclusive
----@return table region Table of the form `{linenr = {startcol,endcol}}`.
----        `endcol` is exclusive, and whole lines are marked with
----        `{startcol,endcol} = {0,-1}`.
+--- Input and output positions are byte positions, (0,0)-indexed. "End of line" column
+--- position (for example, |linewise| visual selection) is returned as |v:maxcol| (big number).
+---
+---@param bufnr integer Buffer number, or 0 for current buffer
+---@param pos1 integer[]|string Start of region as a (line, column) tuple or |getpos()|-compatible string
+---@param pos2 integer[]|string End of region as a (line, column) tuple or |getpos()|-compatible string
+---@param regtype string \|setreg()|-style selection type
+---@param inclusive boolean Controls whether `pos2` column is inclusive (see also 'selection').
+---@return table region Dict of the form `{linenr = {startcol,endcol}}`. `endcol` is exclusive, and
+---whole lines are returned as `{startcol,endcol} = {0,-1}`.
 function vim.region(bufnr, pos1, pos2, regtype, inclusive)
   if not vim.api.nvim_buf_is_loaded(bufnr) then
     vim.fn.bufload(bufnr)
@@ -610,18 +611,17 @@ local on_key_cbs = {}
 --- The Nvim command-line option |-w| is related but does not support callbacks
 --- and cannot be toggled dynamically.
 ---
----@param fn function: Callback function. It should take one string argument.
----                   On each key press, Nvim passes the key char to fn(). |i_CTRL-V|
----                   If {fn} is nil, it removes the callback for the associated {ns_id}
+---@note {fn} will be removed on error.
+---@note {fn} will not be cleared by |nvim_buf_clear_namespace()|
+---@note {fn} will receive the keys after mappings have been evaluated
+---
+---@param fn fun(key: string) Function invoked on every key press. |i_CTRL-V|
+---                   Returning nil removes the callback associated with namespace {ns_id}.
 ---@param ns_id integer? Namespace ID. If nil or 0, generates and returns a new
 ---                    |nvim_create_namespace()| id.
 ---
 ---@return integer Namespace id associated with {fn}. Or count of all callbacks
 ---if on_key() is called without arguments.
----
----@note {fn} will be removed if an error occurs while calling.
----@note {fn} will not be cleared by |nvim_buf_clear_namespace()|
----@note {fn} will receive the keys after mappings have been evaluated
 function vim.on_key(fn, ns_id)
   if fn == nil and ns_id == nil then
     return #on_key_cbs
@@ -1049,10 +1049,10 @@ function vim._init_default_mappings()
   map('i', '<C-W>', '<C-G>u<C-W>')
   vim.keymap.set('x', '*', function()
     _visual_search('/')
-  end, { desc = 'Nvim builtin', silent = true })
+  end, { desc = ':help v_star-default', silent = true })
   vim.keymap.set('x', '#', function()
     _visual_search('?')
-  end, { desc = 'Nvim builtin', silent = true })
+  end, { desc = ':help v_#-default', silent = true })
   -- Use : instead of <Cmd> so that ranges are supported. #19365
   map('n', '&', ':&&<CR>')
 
-- 
cgit 


From 6318edadc32acce3ed41a6995a5faa5395b5f562 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Sat, 8 Jul 2023 15:28:13 +0200
Subject: fix(defaults): visual hash (#) on text with "?"

Problem:
The default "#" mapping fails on the following example after v$h# with
cursor at start of the first line:

    aa?/\bb
    aa
    aa?/\bb

Solution:
Also escape "?".
---
 runtime/lua/vim/_editor.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 80e7518b01..0bbbed74bb 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -1029,7 +1029,7 @@ function vim._init_default_mappings()
     local esc_chunks = vim
       .iter(chunks)
       :map(function(v)
-        return vim.fn.escape(v, [[/\]])
+        return vim.fn.escape(v, [[?/\]])
       end)
       :totable()
     local esc_pat = table.concat(esc_chunks, [[\n]])
-- 
cgit 


From b9a0e762f1d79d17631b7d17cf25b6e25006d8c2 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Sat, 8 Jul 2023 16:55:27 +0200
Subject: fix(defaults): visual star (*) on text with "?"

regression from 6318edadc32acce3ed41a6995a5faa5395b5f562
---
 runtime/lua/vim/_editor.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 0bbbed74bb..5a93f5cd60 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -1029,7 +1029,7 @@ function vim._init_default_mappings()
     local esc_chunks = vim
       .iter(chunks)
       :map(function(v)
-        return vim.fn.escape(v, [[?/\]])
+        return vim.fn.escape(v, cmd == '/' and [[/\]] or [[?\]])
       end)
       :totable()
     local esc_pat = table.concat(esc_chunks, [[\n]])
-- 
cgit 


From 766f4978d6cb146511cf0b676c01e5327db46647 Mon Sep 17 00:00:00 2001
From: Raphael <glepnir@neovim.pro>
Date: Mon, 10 Jul 2023 19:38:15 +0800
Subject: fix(lint): lint warnings #24226

---
 runtime/lua/vim/_editor.lua      |  2 +-
 runtime/lua/vim/_watch.lua       |  4 ++--
 runtime/lua/vim/filetype.lua     |  2 +-
 runtime/lua/vim/fs.lua           |  8 ++++----
 runtime/lua/vim/lsp.lua          | 20 ++++++++++----------
 runtime/lua/vim/lsp/buf.lua      | 15 ++++++++-------
 runtime/lua/vim/lsp/handlers.lua |  7 ++++---
 runtime/lua/vim/lsp/log.lua      |  2 +-
 runtime/lua/vim/lsp/rpc.lua      | 17 ++++++++---------
 runtime/lua/vim/lsp/sync.lua     | 12 +++++++-----
 runtime/lua/vim/uri.lua          | 10 ++--------
 11 files changed, 48 insertions(+), 51 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 5a93f5cd60..47215416e0 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -219,7 +219,7 @@ do
   ---                - 1: starts the paste (exactly once)
   ---                - 2: continues the paste (zero or more times)
   ---                - 3: ends the paste (exactly once)
-  ---@returns boolean # false if client should cancel the paste.
+  ---@return boolean result false if client should cancel the paste.
   function vim.paste(lines, phase)
     local now = vim.uv.now()
     local is_first_chunk = phase < 2
diff --git a/runtime/lua/vim/_watch.lua b/runtime/lua/vim/_watch.lua
index d489cef9fc..00b7416098 100644
--- a/runtime/lua/vim/_watch.lua
+++ b/runtime/lua/vim/_watch.lua
@@ -37,7 +37,7 @@ end
 ---     - uvflags (table|nil)
 ---                Same flags as accepted by |uv.fs_event_start()|
 ---@param callback (function) The function called when new events
----@return (function) A function to stop the watch
+---@return (function) Stops the watcher
 function M.watch(path, opts, callback)
   vim.validate({
     path = { path, 'string', false },
@@ -208,7 +208,7 @@ end
 ---                not match the pattern will be reported. Matches against both files and
 ---                directories. When nil, matches nothing.
 ---@param callback (function) The function called when new events
----@returns (function) A function to stop the watch.
+---@return function Stops the watcher
 function M.poll(path, opts, callback)
   vim.validate({
     path = { path, 'string', false },
diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index bc880ed130..33d451315d 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -28,7 +28,7 @@ end
 --- If only start_lnum is specified, return a single line as a string.
 --- If both start_lnum and end_lnum are omitted, return all lines from the buffer.
 ---
----@param bufnr integer|nil The buffer to get the lines from
+---@param bufnr integer The buffer to get the lines from
 ---@param start_lnum integer|nil The line number of the first line (inclusive, 1-based)
 ---@param end_lnum integer|nil The line number of the last line (inclusive, 1-based)
 ---@return table<string>|string Array of lines, or string when end_lnum is omitted
diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index cdb314fa3d..48d76e5d7e 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -20,7 +20,7 @@ local iswin = vim.uv.os_uname().sysname == 'Windows_NT'
 --- </pre>
 ---
 ---@param start (string) Initial file or directory.
----@return (function) Iterator
+---@return function Iterator
 function M.parents(start)
   return function(_, dir)
     local parent = M.dirname(dir)
@@ -37,7 +37,7 @@ end
 --- Return the parent directory of the given file or directory
 ---
 ---@param file (string) File or directory
----@return (string) Parent directory of {file}
+---@return string|nil Parent directory of {file}
 function M.dirname(file)
   if file == nil then
     return nil
@@ -59,8 +59,8 @@ end
 
 --- Return the basename of the given file or directory
 ---
----@param file (string) File or directory
----@return (string) Basename of {file}
+---@param file string File or directory
+---@return string|nil Basename of {file}
 function M.basename(file)
   if file == nil then
     return nil
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index ca4851f8d7..ed431e080e 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1951,7 +1951,7 @@ end
 ---
 ---@param client_id integer client id
 ---
----@returns |vim.lsp.client| object, or nil
+---@return (nil|lsp.Client) client rpc object
 function lsp.get_client_by_id(client_id)
   return active_clients[client_id] or uninitialized_clients[client_id]
 end
@@ -2090,13 +2090,14 @@ api.nvim_create_autocmd('VimLeavePre', {
 ---@param bufnr (integer) Buffer handle, or 0 for current.
 ---@param method (string) LSP method name
 ---@param params table|nil Parameters to send to the server
----@param handler lsp-handler|nil See |lsp-handler|
+---@param handler lsp-handler See |lsp-handler|
 ---       If nil, follows resolution strategy defined in |lsp-handler-configuration|
 ---
----@return table<integer, integer>, fun() 2-tuple:
----  - Map of client-id:request-id pairs for all successful requests.
----  - Function which can be used to cancel all the requests. You could instead
----    iterate all clients and call their `cancel_request()` methods.
+---@return table<integer, integer> client_request_ids Map of client-id:request-id pairs
+---for all successful requests.
+---@return function _cancel_all_requests Function which can be used to
+---cancel all the requests. You could instead
+---iterate all clients and call their `cancel_request()` methods.
 function lsp.buf_request(bufnr, method, params, handler)
   validate({
     bufnr = { bufnr, 'n', true },
@@ -2147,8 +2148,7 @@ end
 ---@param handler fun(results: table<integer, {error: lsp.ResponseError, result: any}>) (function)
 --- Handler called after all requests are completed. Server results are passed as
 --- a `client_id:result` map.
----
----@return fun() cancel Function that cancels all requests.
+---@return function cancel Function that cancels all requests.
 function lsp.buf_request_all(bufnr, method, params, handler)
   local results = {}
   local result_count = 0
@@ -2257,7 +2257,7 @@ end
 ---@param findstart integer 0 or 1, decides behavior
 ---@param base integer findstart=0, text to match against
 ---
----@returns (integer) Decided by {findstart}:
+---@return integer|table Decided by {findstart}:
 --- - findstart=0: column where the completion starts, or -2 or -3
 --- - findstart=1: list of matches (actually just calls |complete()|)
 function lsp.omnifunc(findstart, base)
@@ -2405,7 +2405,7 @@ end
 --- is a |vim.lsp.client| object.
 ---
 ---@param bufnr (integer|nil): Buffer handle, or 0 for current
----@returns (table) Table of (client_id, client) pairs
+---@return table result is table of (client_id, client) pairs
 ---@deprecated Use |vim.lsp.get_active_clients()| instead.
 function lsp.buf_get_clients(bufnr)
   local result = {}
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index bac66b671d..8ae0e0cde3 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -13,10 +13,11 @@ local M = {}
 ---@param params (table|nil) Parameters to send to the server
 ---@param handler (function|nil) See |lsp-handler|. Follows |lsp-handler-resolution|
 --
----@returns 2-tuple:
----  - Map of client-id:request-id pairs for all successful requests.
----  - Function which can be used to cancel all the requests. You could instead
----    iterate all clients and call their `cancel_request()` methods.
+---@return table<integer, integer> client_request_ids Map of client-id:request-id pairs
+---for all successful requests.
+---@return function _cancel_all_requests Function which can be used to
+---cancel all the requests. You could instead
+---iterate all clients and call their `cancel_request()` methods.
 ---
 ---@see |vim.lsp.buf_request()|
 local function request(method, params, handler)
@@ -30,7 +31,7 @@ end
 --- Checks whether the language servers attached to the current buffer are
 --- ready.
 ---
----@returns `true` if server responds.
+---@return boolean if server responds.
 ---@deprecated
 function M.server_ready()
   vim.deprecate('vim.lsp.buf.server_ready', nil, '0.10.0')
@@ -108,7 +109,7 @@ end
 --- Retrieves the completion items at the current cursor position. Can only be
 --- called in Insert mode.
 ---
----@param context (context support not yet implemented) Additional information
+---@param context table (context support not yet implemented) Additional information
 --- about the context in which a completion was triggered (how it was triggered,
 --- and by which trigger character, if applicable)
 ---
@@ -549,7 +550,7 @@ end
 --- call, the user is prompted to enter a string on the command line. An empty
 --- string means no filtering is done.
 ---
----@param query (string, optional)
+---@param query string|nil optional
 ---@param options table|nil additional options
 ---     - on_list: (function) handler for list results. See |lsp-on-list-handler|
 function M.workspace_symbol(query, options)
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 70781cb7a6..20c4d7458b 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -382,7 +382,7 @@ M['textDocument/hover'] = M.hover
 
 ---@private
 --- Jumps to a location. Used as a handler for multiple LSP methods.
----@param _ (not used)
+---@param _ nil not used
 ---@param result (table) result of LSP method; a location or a list of locations.
 ---@param ctx (table) table containing the context of the request, including the method
 ---(`textDocument/definition` can return `Location` or `Location[]`
@@ -496,8 +496,9 @@ end
 --- Displays call hierarchy in the quickfix window.
 ---
 ---@param direction `"from"` for incoming calls and `"to"` for outgoing calls
----@returns `CallHierarchyIncomingCall[]` if {direction} is `"from"`,
----@returns `CallHierarchyOutgoingCall[]` if {direction} is `"to"`,
+---@return function
+--- `CallHierarchyIncomingCall[]` if {direction} is `"from"`,
+--- `CallHierarchyOutgoingCall[]` if {direction} is `"to"`,
 local make_call_hierarchy_handler = function(direction)
   return function(_, result)
     if not result then
diff --git a/runtime/lua/vim/lsp/log.lua b/runtime/lua/vim/lsp/log.lua
index c77e7c045b..033f93bd6e 100644
--- a/runtime/lua/vim/lsp/log.lua
+++ b/runtime/lua/vim/lsp/log.lua
@@ -44,7 +44,7 @@ do
   vim.fn.mkdir(vim.fn.stdpath('log'), 'p')
 
   --- Returns the log filename.
-  ---@returns (string) log filename
+  ---@return string log filename
   function log.get_filename()
     return logfilename
   end
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index 6552eaa800..c110c3a67c 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -8,7 +8,7 @@ local is_win = uv.os_uname().version:find('Windows')
 ---@private
 --- Checks whether a given path exists and is a directory.
 ---@param filename (string) path to check
----@returns (bool)
+---@return boolean
 local function is_dir(filename)
   local stat = uv.fs_stat(filename)
   return stat and stat.type == 'directory' or false
@@ -18,7 +18,7 @@ end
 --- Embeds the given string into a table and correctly computes `Content-Length`.
 ---
 ---@param encoded_message (string)
----@returns (table) table containing encoded message and `Content-Length` attribute
+---@return string containing encoded message and `Content-Length` attribute
 local function format_message_with_content_length(encoded_message)
   return table.concat({
     'Content-Length: ',
@@ -32,7 +32,7 @@ end
 --- Parses an LSP Message's header
 ---
 ---@param header string: The header to parse.
----@return table parsed headers
+---@return table # parsed headers
 local function parse_headers(header)
   assert(type(header) == 'string', 'header must be a string')
   local headers = {}
@@ -190,7 +190,8 @@ end
 ---
 ---@param method (string) The invoked LSP method
 ---@param params (table): Parameters for the invoked LSP method
----@returns `nil` and `vim.lsp.protocol.ErrorCodes.MethodNotFound`.
+---@return nil
+---@return table `vim.lsp.protocol.ErrorCodes.MethodNotFound`
 function default_dispatchers.server_request(method, params)
   local _ = log.debug() and log.debug('server_request', method, params)
   return nil, rpc_response_error(protocol.ErrorCodes.MethodNotFound)
@@ -268,7 +269,7 @@ end
 --- Sends a notification to the LSP server.
 ---@param method (string) The invoked LSP method
 ---@param params (any): Parameters for the invoked LSP method
----@returns (bool) `true` if notification could be sent, `false` if not
+---@return boolean `true` if notification could be sent, `false` if not
 function Client:notify(method, params)
   return self:encode_and_send({
     jsonrpc = '2.0',
@@ -522,7 +523,7 @@ local function public_client(client)
   --- Sends a notification to the LSP server.
   ---@param method (string) The invoked LSP method
   ---@param params (table|nil): Parameters for the invoked LSP method
-  ---@returns (bool) `true` if notification could be sent, `false` if not
+  ---@return boolean `true` if notification could be sent, `false` if not
   function result.notify(method, params)
     return client:notify(method, params)
   end
@@ -624,9 +625,7 @@ end
 --- server process. May contain:
 --- - {cwd} (string) Working directory for the LSP server process
 --- - {env} (table) Additional environment variables for LSP server process
----@returns Client RPC object.
----
----@returns Methods:
+---@return table|nil Client RPC object, with these methods:
 --- - `notify()` |vim.lsp.rpc.notify()|
 --- - `request()` |vim.lsp.rpc.request()|
 --- - `is_closing()` returns a boolean indicating if the RPC is closing.
diff --git a/runtime/lua/vim/lsp/sync.lua b/runtime/lua/vim/lsp/sync.lua
index fb5b0b3194..350c096b47 100644
--- a/runtime/lua/vim/lsp/sync.lua
+++ b/runtime/lua/vim/lsp/sync.lua
@@ -94,7 +94,8 @@ end
 ---@param line string the line to index into
 ---@param byte integer the byte idx
 ---@param offset_encoding string utf-8|utf-16|utf-32|nil (default: utf-8)
----@returns table<string, int> byte_idx and char_idx of first change position
+---@return integer byte_idx of first change position
+---@return integer char_idx of first change position
 local function align_end_position(line, byte, offset_encoding)
   local char
   -- If on the first byte, or an empty string: the trivial case
@@ -129,7 +130,7 @@ end
 ---@param lastline integer lastline from on_lines, adjusted to 1-index
 ---@param new_lastline integer new_lastline from on_lines, adjusted to 1-index
 ---@param offset_encoding string utf-8|utf-16|utf-32|nil (fallback to utf-8)
----@returns table<int, int> line_idx, byte_idx, and char_idx of first change position
+---@return table result table include line_idx, byte_idx, and char_idx of first change position
 local function compute_start_range(
   prev_lines,
   curr_lines,
@@ -209,7 +210,8 @@ end
 ---@param lastline integer
 ---@param new_lastline integer
 ---@param offset_encoding string
----@returns (int, int) end_line_idx and end_col_idx of range
+---@return integer|table end_line_idx and end_col_idx of range
+---@return table|nil end_col_idx of range
 local function compute_end_range(
   prev_lines,
   curr_lines,
@@ -310,7 +312,7 @@ end
 ---@param lines table list of lines
 ---@param start_range table table returned by first_difference
 ---@param end_range table new_end_range returned by last_difference
----@returns string text extracted from defined region
+---@return string text extracted from defined region
 local function extract_text(lines, start_range, end_range, line_ending)
   if not lines[start_range.line_idx] then
     return ''
@@ -392,7 +394,7 @@ end
 ---@param lastline integer line to begin search in old_lines for last difference
 ---@param new_lastline integer line to begin search in new_lines for last difference
 ---@param offset_encoding string encoding requested by language server
----@returns table TextDocumentContentChangeEvent see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentContentChangeEvent
+---@return table TextDocumentContentChangeEvent see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentContentChangeEvent
 function M.compute_diff(
   prev_lines,
   curr_lines,
diff --git a/runtime/lua/vim/uri.lua b/runtime/lua/vim/uri.lua
index 08ed829114..dec7840eb0 100644
--- a/runtime/lua/vim/uri.lua
+++ b/runtime/lua/vim/uri.lua
@@ -30,14 +30,8 @@ do
     -- https://tools.ietf.org/html/rfc3986#section-2.2
     rfc3986 = "^A-Za-z0-9%-._~!$&'()*+,;=:@/",
   }
-  local sbyte, tohex = string.byte
-  if jit then
-    tohex = require('bit').tohex
-  else
-    tohex = function(b)
-      return string.format('%02x', b)
-    end
-  end
+  local sbyte = string.byte
+  local tohex = require('bit').tohex
 
   ---@private
   local function percent_encode_char(char)
-- 
cgit 


From 317c80f460a7826421f40f57ee8bdbd736b0f225 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Wed, 12 Jul 2023 14:48:21 +0200
Subject: feat(lsp): add method filter to get_active_clients (#24319)

---
 runtime/lua/vim/lsp.lua     |  3 +++
 runtime/lua/vim/lsp/buf.lua | 28 +++++++++++-----------------
 2 files changed, 14 insertions(+), 17 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index ed431e080e..1f9b6c4360 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1995,6 +1995,7 @@ end
 ---@field id integer|nil Match clients by id
 ---@field bufnr integer|nil match clients attached to the given buffer
 ---@field name string|nil match clients by name
+---@field method string|nil match client by supported method name
 
 --- Get active clients.
 ---
@@ -2004,6 +2005,7 @@ end
 ---               - id (number): Only return clients with the given id
 ---               - bufnr (number): Only return clients attached to this buffer
 ---               - name (string): Only return clients with the given name
+---               - method (string): Only return clients supporting the given method
 ---@return lsp.Client[]: List of |vim.lsp.client| objects
 function lsp.get_active_clients(filter)
   validate({ filter = { filter, 't', true } })
@@ -2020,6 +2022,7 @@ function lsp.get_active_clients(filter)
       client
       and (filter.id == nil or client.id == filter.id)
       and (filter.name == nil or client.name == filter.name)
+      and (filter.method == nil or client.supports_method(filter.method, { bufnr = filter.bufnr }))
     then
       clients[#clients + 1] = client
     end
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 8ae0e0cde3..b238b5c221 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -197,15 +197,6 @@ end
 function M.format(options)
   options = options or {}
   local bufnr = options.bufnr or api.nvim_get_current_buf()
-  local clients = vim.lsp.get_active_clients({
-    id = options.id,
-    bufnr = bufnr,
-    name = options.name,
-  })
-
-  if options.filter then
-    clients = vim.tbl_filter(options.filter, clients)
-  end
 
   local mode = api.nvim_get_mode().mode
   local range = options.range
@@ -214,9 +205,15 @@ function M.format(options)
   end
   local method = range and 'textDocument/rangeFormatting' or 'textDocument/formatting'
 
-  clients = vim.tbl_filter(function(client)
-    return client.supports_method(method)
-  end, clients)
+  local clients = vim.lsp.get_active_clients({
+    id = options.id,
+    bufnr = bufnr,
+    name = options.name,
+    method = method,
+  })
+  if options.filter then
+    clients = vim.tbl_filter(options.filter, clients)
+  end
 
   if #clients == 0 then
     vim.notify('[LSP] Format request failed, no matching language servers.')
@@ -277,16 +274,13 @@ function M.rename(new_name, options)
   local clients = vim.lsp.get_active_clients({
     bufnr = bufnr,
     name = options.name,
+    -- Clients must at least support rename, prepareRename is optional
+    method = 'textDocument/rename',
   })
   if options.filter then
     clients = vim.tbl_filter(options.filter, clients)
   end
 
-  -- Clients must at least support rename, prepareRename is optional
-  clients = vim.tbl_filter(function(client)
-    return client.supports_method('textDocument/rename')
-  end, clients)
-
   if #clients == 0 then
     vim.notify('[LSP] Rename, no matching language servers with rename capability.')
   end
-- 
cgit 


From a3f4598226c4d01e4fbc41181a1ad21793862fe3 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Thu, 13 Jul 2023 14:43:36 +0200
Subject: docs(lua): adds links to related keymap functions to keymap.set
 (#24337)

Might help with discovery, given that there is no `keymap.get()`
---
 runtime/lua/vim/keymap.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/keymap.lua b/runtime/lua/vim/keymap.lua
index 9dbc65afe8..2b55ddc787 100644
--- a/runtime/lua/vim/keymap.lua
+++ b/runtime/lua/vim/keymap.lua
@@ -32,6 +32,9 @@ local keymap = {}
 ---                        - "remap": (boolean) Make the mapping recursive. Inverse of "noremap".
 ---                        Defaults to `false`.
 ---@see |nvim_set_keymap()|
+---@see |maparg()|
+---@see |mapcheck()|
+---@see |mapset()|
 function keymap.set(mode, lhs, rhs, opts)
   vim.validate({
     mode = { mode, { 's', 't' } },
-- 
cgit 


From 2ecba65b4ba741618ecbfd2a50a939987078bc98 Mon Sep 17 00:00:00 2001
From: Techatrix <19954306+Techatrix@users.noreply.github.com>
Date: Fri, 14 Jul 2023 05:36:10 +0000
Subject: fix(lsp): remove unknown LSP protocol property (#24345)

'hierarchicalWorkspaceSymbolSupport' is not part of the LSP Specification
---
 runtime/lua/vim/lsp/protocol.lua | 1 -
 1 file changed, 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 27da891656..5bc0baf241 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -844,7 +844,6 @@ function protocol.make_client_capabilities()
             return res
           end)(),
         },
-        hierarchicalWorkspaceSymbolSupport = true,
       },
       configuration = true,
       workspaceFolders = true,
-- 
cgit 


From 33e1a8cd7042816a064c0d2bf32b6570d7e88b79 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Fri, 14 Jul 2023 18:47:18 +0200
Subject: feat(lsp): map K to hover by default #24331

Related: https://github.com/neovim/neovim/issues/24252
---
 runtime/lua/vim/lsp.lua | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 1f9b6c4360..e9a1423d2d 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -963,6 +963,15 @@ function lsp._set_defaults(client, bufnr)
   then
     vim.bo[bufnr].formatexpr = 'v:lua.vim.lsp.formatexpr()'
   end
+  api.nvim_buf_call(bufnr, function()
+    if
+      client.supports_method('textDocument/hover')
+      and is_empty_or_default(bufnr, 'keywordprg')
+      and vim.fn.maparg('K', 'n', false, false) == ''
+    then
+      vim.keymap.set('n', 'K', vim.lsp.buf.hover, { buffer = bufnr })
+    end
+  end)
 end
 
 --- @class lsp.ClientConfig
@@ -1202,7 +1211,7 @@ function lsp.start_client(config)
   ---@private
   --- Reset defaults set by `set_defaults`.
   --- Must only be called if the last client attached to a buffer exits.
-  local function unset_defaults(bufnr)
+  local function reset_defaults(bufnr)
     if vim.bo[bufnr].tagfunc == 'v:lua.vim.lsp.tagfunc' then
       vim.bo[bufnr].tagfunc = nil
     end
@@ -1212,6 +1221,12 @@ function lsp.start_client(config)
     if vim.bo[bufnr].formatexpr == 'v:lua.vim.lsp.formatexpr()' then
       vim.bo[bufnr].formatexpr = nil
     end
+    api.nvim_buf_call(bufnr, function()
+      local keymap = vim.fn.maparg('K', 'n', false, true)
+      if keymap and keymap.callback == vim.lsp.buf.hover then
+        vim.keymap.del('n', 'K', { buffer = bufnr })
+      end
+    end)
   end
 
   ---@private
@@ -1243,7 +1258,7 @@ function lsp.start_client(config)
 
           client_ids[client_id] = nil
           if vim.tbl_isempty(client_ids) then
-            unset_defaults(bufnr)
+            reset_defaults(bufnr)
           end
         end)
       end
-- 
cgit 


From 251ca45ac94851c896db0d27685622fb78a73b3e Mon Sep 17 00:00:00 2001
From: Mike <10135646+mikesmithgh@users.noreply.github.com>
Date: Sun, 16 Jul 2023 06:11:45 -0400
Subject: fix(lsp): markdown code fence should allow space before info string
 #24364

Problem:
Bash language server returns "hover" markdown content that starts with
a code fence and info string of `man` preceded by whitespace, which Nvim
does not render properly.

See https://github.com/bash-lsp/bash-language-server/blob/0ee73c53cebdc18311d4a4ad9367185ea4d98a03/server/src/server.ts#L821C15-L821C15
```typescript
function getMarkdownContent(documentation: string, language?: string): LSP.MarkupContent {
  return {
    value: language
      ? // eslint-disable-next-line prefer-template
        ['``` ' + language, documentation, '```'].join('\n')
      : documentation,
    kind: LSP.MarkupKind.Markdown,
  }
}
```

For example,
```
    ``` man
    NAME
       git - the stupid content tracker
    ```
```

If I remove the white space, then it is properly formatted.
```
    ```man instead of ``` man
```

Per CommonMark Spec https://spec.commonmark.org/0.30/#info-string
whitespace is allowed before and after the `info string` which
identifies the language in a codeblock.
> The line with the opening code fence may optionally contain some text
> following the code fence; this is trimmed of leading and trailing
> spaces or tabs and called the [info
> string](https://spec.commonmark.org/0.30/#info-string). If the [info
> string](https://spec.commonmark.org/0.30/#info-string) comes after
> a backtick fence, it may not contain any backtick characters. (The
> reason for this restriction is that otherwise some inline code would
> be incorrectly interpreted as the beginning of a fenced code block.)

 Solution:
 Adjust stylize_markdown() to allow whitespace before codeblock info.
---
 runtime/lua/vim/lsp/util.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 8d6f88bb2c..0da88f800e 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1347,7 +1347,7 @@ function M.stylize_markdown(bufnr, contents, opts)
   -- table of fence types to {ft, begin, end}
   -- when ft is nil, we get the ft from the regex match
   local matchers = {
-    block = { nil, '```+([a-zA-Z0-9_]*)', '```+' },
+    block = { nil, '```+%s*([a-zA-Z0-9_]*)', '```+' },
     pre = { nil, '<pre>([a-z0-9]*)', '</pre>' },
     code = { '', '<code>', '</code>' },
     text = { 'text', '<text>', '</text>' },
-- 
cgit 


From d0b612f360125785eb95afaa51620c5c7695e381 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 16 Jul 2023 09:27:39 +0100
Subject: refactor: rename _meta.lua to _options.lua

---
 runtime/lua/vim/_editor.lua  |   2 +-
 runtime/lua/vim/_meta.lua    | 575 -------------------------------------------
 runtime/lua/vim/_options.lua | 575 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 576 insertions(+), 576 deletions(-)
 delete mode 100644 runtime/lua/vim/_meta.lua
 create mode 100644 runtime/lua/vim/_options.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 47215416e0..bb0aa97a0d 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -1094,7 +1094,7 @@ function vim._init_defaults()
   vim._init_default_autocmds()
 end
 
-require('vim._meta')
+require('vim._options')
 
 -- Remove at Nvim 1.0
 ---@deprecated
diff --git a/runtime/lua/vim/_meta.lua b/runtime/lua/vim/_meta.lua
deleted file mode 100644
index 41e6e8be86..0000000000
--- a/runtime/lua/vim/_meta.lua
+++ /dev/null
@@ -1,575 +0,0 @@
-local api = vim.api
-
--- TODO(tjdevries): Improve option metadata so that this doesn't have to be hardcoded.
---                  Can be done in a separate PR.
-local key_value_options = {
-  fillchars = true,
-  fcs = true,
-  listchars = true,
-  lcs = true,
-  winhighlight = true,
-  winhl = true,
-}
-
---- Convert a vimoption_T style dictionary to the correct OptionType associated with it.
----@return string
-local function get_option_metatype(name, info)
-  if info.type == 'string' then
-    if info.flaglist then
-      return 'set'
-    elseif info.commalist then
-      if key_value_options[name] then
-        return 'map'
-      end
-      return 'array'
-    end
-    return 'string'
-  end
-  return info.type
-end
-
-local options_info = setmetatable({}, {
-  __index = function(t, k)
-    local info = api.nvim_get_option_info(k)
-    info.metatype = get_option_metatype(k, info)
-    rawset(t, k, info)
-    return rawget(t, k)
-  end,
-})
-
-vim.env = setmetatable({}, {
-  __index = function(_, k)
-    local v = vim.fn.getenv(k)
-    if v == vim.NIL then
-      return nil
-    end
-    return v
-  end,
-
-  __newindex = function(_, k, v)
-    vim.fn.setenv(k, v)
-  end,
-})
-
-local function opt_validate(option_name, target_scope)
-  local scope = options_info[option_name].scope
-  if scope ~= target_scope then
-    local scope_to_string = { buf = 'buffer', win = 'window' }
-    error(
-      string.format(
-        [['%s' is a %s option, not a %s option. See ":help %s"]],
-        option_name,
-        scope_to_string[scope] or scope,
-        scope_to_string[target_scope] or target_scope,
-        option_name
-      )
-    )
-  end
-end
-
-local function new_buf_opt_accessor(bufnr)
-  return setmetatable({}, {
-    __index = function(_, k)
-      if bufnr == nil and type(k) == 'number' then
-        return new_buf_opt_accessor(k)
-      end
-      opt_validate(k, 'buf')
-      return api.nvim_get_option_value(k, { buf = bufnr or 0 })
-    end,
-
-    __newindex = function(_, k, v)
-      opt_validate(k, 'buf')
-      return api.nvim_set_option_value(k, v, { buf = bufnr or 0 })
-    end,
-  })
-end
-
-vim.bo = new_buf_opt_accessor()
-
-local function new_win_opt_accessor(winid, bufnr)
-  return setmetatable({}, {
-    __index = function(_, k)
-      if bufnr == nil and type(k) == 'number' then
-        if winid == nil then
-          return new_win_opt_accessor(k)
-        else
-          return new_win_opt_accessor(winid, k)
-        end
-      end
-
-      if bufnr ~= nil and bufnr ~= 0 then
-        error('only bufnr=0 is supported')
-      end
-
-      opt_validate(k, 'win')
-      -- TODO(lewis6991): allow passing both buf and win to nvim_get_option_value
-      return api.nvim_get_option_value(k, {
-        scope = bufnr and 'local' or nil,
-        win = winid or 0,
-      })
-    end,
-
-    __newindex = function(_, k, v)
-      opt_validate(k, 'win')
-      -- TODO(lewis6991): allow passing both buf and win to nvim_set_option_value
-      return api.nvim_set_option_value(k, v, {
-        scope = bufnr and 'local' or nil,
-        win = winid or 0,
-      })
-    end,
-  })
-end
-
-vim.wo = new_win_opt_accessor()
-
--- vim global option
---  this ONLY sets the global option. like `setglobal`
-vim.go = setmetatable({}, {
-  __index = function(_, k)
-    return api.nvim_get_option_value(k, { scope = 'global' })
-  end,
-  __newindex = function(_, k, v)
-    return api.nvim_set_option_value(k, v, { scope = 'global' })
-  end,
-})
-
--- vim `set` style options.
---  it has no additional metamethod magic.
-vim.o = setmetatable({}, {
-  __index = function(_, k)
-    return api.nvim_get_option_value(k, {})
-  end,
-  __newindex = function(_, k, v)
-    return api.nvim_set_option_value(k, v, {})
-  end,
-})
-
----@brief [[
---- vim.opt, vim.opt_local and vim.opt_global implementation
----
---- To be used as helpers for working with options within neovim.
---- For information on how to use, see :help vim.opt
----
----@brief ]]
-
---- Preserves the order and does not mutate the original list
-local function remove_duplicate_values(t)
-  local result, seen = {}, {}
-  for _, v in ipairs(t) do
-    if not seen[v] then
-      table.insert(result, v)
-    end
-
-    seen[v] = true
-  end
-
-  return result
-end
-
--- Check whether the OptionTypes is allowed for vim.opt
--- If it does not match, throw an error which indicates which option causes the error.
-local function assert_valid_value(name, value, types)
-  local type_of_value = type(value)
-  for _, valid_type in ipairs(types) do
-    if valid_type == type_of_value then
-      return
-    end
-  end
-
-  error(
-    string.format(
-      "Invalid option type '%s' for '%s', should be %s",
-      type_of_value,
-      name,
-      table.concat(types, ' or ')
-    )
-  )
-end
-
-local function passthrough(_, x)
-  return x
-end
-
-local function tbl_merge(left, right)
-  return vim.tbl_extend('force', left, right)
-end
-
-local function tbl_remove(t, value)
-  if type(value) == 'string' then
-    t[value] = nil
-  else
-    for _, v in ipairs(value) do
-      t[v] = nil
-    end
-  end
-
-  return t
-end
-
-local valid_types = {
-  boolean = { 'boolean' },
-  number = { 'number' },
-  string = { 'string' },
-  set = { 'string', 'table' },
-  array = { 'string', 'table' },
-  map = { 'string', 'table' },
-}
-
--- Map of functions to take a Lua style value and convert to vimoption_T style value.
--- Each function takes (info, lua_value) -> vim_value
-local to_vim_value = {
-  boolean = passthrough,
-  number = passthrough,
-  string = passthrough,
-
-  set = function(info, value)
-    if type(value) == 'string' then
-      return value
-    end
-
-    if info.flaglist and info.commalist then
-      local keys = {}
-      for k, v in pairs(value) do
-        if v then
-          table.insert(keys, k)
-        end
-      end
-
-      table.sort(keys)
-      return table.concat(keys, ',')
-    else
-      local result = ''
-      for k, v in pairs(value) do
-        if v then
-          result = result .. k
-        end
-      end
-
-      return result
-    end
-  end,
-
-  array = function(info, value)
-    if type(value) == 'string' then
-      return value
-    end
-    if not info.allows_duplicates then
-      value = remove_duplicate_values(value)
-    end
-    return table.concat(value, ',')
-  end,
-
-  map = function(_, value)
-    if type(value) == 'string' then
-      return value
-    end
-
-    local result = {}
-    for opt_key, opt_value in pairs(value) do
-      table.insert(result, string.format('%s:%s', opt_key, opt_value))
-    end
-
-    table.sort(result)
-    return table.concat(result, ',')
-  end,
-}
-
---- Convert a Lua value to a vimoption_T value
-local function convert_value_to_vim(name, info, value)
-  if value == nil then
-    return vim.NIL
-  end
-
-  assert_valid_value(name, value, valid_types[info.metatype])
-
-  return to_vim_value[info.metatype](info, value)
-end
-
--- Map of OptionType to functions that take vimoption_T values and convert to Lua values.
--- Each function takes (info, vim_value) -> lua_value
-local to_lua_value = {
-  boolean = passthrough,
-  number = passthrough,
-  string = passthrough,
-
-  array = function(info, value)
-    if type(value) == 'table' then
-      if not info.allows_duplicates then
-        value = remove_duplicate_values(value)
-      end
-
-      return value
-    end
-
-    -- Empty strings mean that there is nothing there,
-    -- so empty table should be returned.
-    if value == '' then
-      return {}
-    end
-
-    -- Handles unescaped commas in a list.
-    if string.find(value, ',,,') then
-      local left, right = unpack(vim.split(value, ',,,'))
-
-      local result = {}
-      vim.list_extend(result, vim.split(left, ','))
-      table.insert(result, ',')
-      vim.list_extend(result, vim.split(right, ','))
-
-      table.sort(result)
-
-      return result
-    end
-
-    if string.find(value, ',^,,', 1, true) then
-      local left, right = unpack(vim.split(value, ',^,,', true))
-
-      local result = {}
-      vim.list_extend(result, vim.split(left, ','))
-      table.insert(result, '^,')
-      vim.list_extend(result, vim.split(right, ','))
-
-      table.sort(result)
-
-      return result
-    end
-
-    return vim.split(value, ',')
-  end,
-
-  set = function(info, value)
-    if type(value) == 'table' then
-      return value
-    end
-
-    -- Empty strings mean that there is nothing there,
-    -- so empty table should be returned.
-    if value == '' then
-      return {}
-    end
-
-    assert(info.flaglist, 'That is the only one I know how to handle')
-
-    if info.flaglist and info.commalist then
-      local split_value = vim.split(value, ',')
-      local result = {}
-      for _, v in ipairs(split_value) do
-        result[v] = true
-      end
-
-      return result
-    else
-      local result = {}
-      for i = 1, #value do
-        result[value:sub(i, i)] = true
-      end
-
-      return result
-    end
-  end,
-
-  map = function(info, raw_value)
-    if type(raw_value) == 'table' then
-      return raw_value
-    end
-
-    assert(info.commalist, 'Only commas are supported currently')
-
-    local result = {}
-
-    local comma_split = vim.split(raw_value, ',')
-    for _, key_value_str in ipairs(comma_split) do
-      local key, value = unpack(vim.split(key_value_str, ':'))
-      key = vim.trim(key)
-
-      result[key] = value
-    end
-
-    return result
-  end,
-}
-
---- Converts a vimoption_T style value to a Lua value
-local function convert_value_to_lua(info, option_value)
-  return to_lua_value[info.metatype](info, option_value)
-end
-
-local prepend_methods = {
-  number = function()
-    error("The '^' operator is not currently supported for")
-  end,
-
-  string = function(left, right)
-    return right .. left
-  end,
-
-  array = function(left, right)
-    for i = #right, 1, -1 do
-      table.insert(left, 1, right[i])
-    end
-
-    return left
-  end,
-
-  map = tbl_merge,
-  set = tbl_merge,
-}
-
---- Handles the '^' operator
-local function prepend_value(info, current, new)
-  return prepend_methods[info.metatype](
-    convert_value_to_lua(info, current),
-    convert_value_to_lua(info, new)
-  )
-end
-
-local add_methods = {
-  number = function(left, right)
-    return left + right
-  end,
-
-  string = function(left, right)
-    return left .. right
-  end,
-
-  array = function(left, right)
-    for _, v in ipairs(right) do
-      table.insert(left, v)
-    end
-
-    return left
-  end,
-
-  map = tbl_merge,
-  set = tbl_merge,
-}
-
---- Handles the '+' operator
-local function add_value(info, current, new)
-  return add_methods[info.metatype](
-    convert_value_to_lua(info, current),
-    convert_value_to_lua(info, new)
-  )
-end
-
-local function remove_one_item(t, val)
-  if vim.tbl_islist(t) then
-    local remove_index = nil
-    for i, v in ipairs(t) do
-      if v == val then
-        remove_index = i
-      end
-    end
-
-    if remove_index then
-      table.remove(t, remove_index)
-    end
-  else
-    t[val] = nil
-  end
-end
-
-local remove_methods = {
-  number = function(left, right)
-    return left - right
-  end,
-
-  string = function()
-    error('Subtraction not supported for strings.')
-  end,
-
-  array = function(left, right)
-    if type(right) == 'string' then
-      remove_one_item(left, right)
-    else
-      for _, v in ipairs(right) do
-        remove_one_item(left, v)
-      end
-    end
-
-    return left
-  end,
-
-  map = tbl_remove,
-  set = tbl_remove,
-}
-
---- Handles the '-' operator
-local function remove_value(info, current, new)
-  return remove_methods[info.metatype](convert_value_to_lua(info, current), new)
-end
-
-local function create_option_accessor(scope)
-  local option_mt
-
-  local function make_option(name, value)
-    local info = assert(options_info[name], 'Not a valid option name: ' .. name)
-
-    if type(value) == 'table' and getmetatable(value) == option_mt then
-      assert(name == value._name, "must be the same value, otherwise that's weird.")
-
-      value = value._value
-    end
-
-    return setmetatable({
-      _name = name,
-      _value = value,
-      _info = info,
-    }, option_mt)
-  end
-
-  option_mt = {
-    -- To set a value, instead use:
-    --  opt[my_option] = value
-    _set = function(self)
-      local value = convert_value_to_vim(self._name, self._info, self._value)
-      api.nvim_set_option_value(self._name, value, { scope = scope })
-    end,
-
-    get = function(self)
-      return convert_value_to_lua(self._info, self._value)
-    end,
-
-    append = function(self, right)
-      self._value = add_value(self._info, self._value, right)
-      self:_set()
-    end,
-
-    __add = function(self, right)
-      return make_option(self._name, add_value(self._info, self._value, right))
-    end,
-
-    prepend = function(self, right)
-      self._value = prepend_value(self._info, self._value, right)
-      self:_set()
-    end,
-
-    __pow = function(self, right)
-      return make_option(self._name, prepend_value(self._info, self._value, right))
-    end,
-
-    remove = function(self, right)
-      self._value = remove_value(self._info, self._value, right)
-      self:_set()
-    end,
-
-    __sub = function(self, right)
-      return make_option(self._name, remove_value(self._info, self._value, right))
-    end,
-  }
-  option_mt.__index = option_mt
-
-  return setmetatable({}, {
-    __index = function(_, k)
-      return make_option(k, api.nvim_get_option_value(k, {}))
-    end,
-
-    __newindex = function(_, k, v)
-      make_option(k, v):_set()
-    end,
-  })
-end
-
-vim.opt = create_option_accessor()
-vim.opt_local = create_option_accessor('local')
-vim.opt_global = create_option_accessor('global')
diff --git a/runtime/lua/vim/_options.lua b/runtime/lua/vim/_options.lua
new file mode 100644
index 0000000000..41e6e8be86
--- /dev/null
+++ b/runtime/lua/vim/_options.lua
@@ -0,0 +1,575 @@
+local api = vim.api
+
+-- TODO(tjdevries): Improve option metadata so that this doesn't have to be hardcoded.
+--                  Can be done in a separate PR.
+local key_value_options = {
+  fillchars = true,
+  fcs = true,
+  listchars = true,
+  lcs = true,
+  winhighlight = true,
+  winhl = true,
+}
+
+--- Convert a vimoption_T style dictionary to the correct OptionType associated with it.
+---@return string
+local function get_option_metatype(name, info)
+  if info.type == 'string' then
+    if info.flaglist then
+      return 'set'
+    elseif info.commalist then
+      if key_value_options[name] then
+        return 'map'
+      end
+      return 'array'
+    end
+    return 'string'
+  end
+  return info.type
+end
+
+local options_info = setmetatable({}, {
+  __index = function(t, k)
+    local info = api.nvim_get_option_info(k)
+    info.metatype = get_option_metatype(k, info)
+    rawset(t, k, info)
+    return rawget(t, k)
+  end,
+})
+
+vim.env = setmetatable({}, {
+  __index = function(_, k)
+    local v = vim.fn.getenv(k)
+    if v == vim.NIL then
+      return nil
+    end
+    return v
+  end,
+
+  __newindex = function(_, k, v)
+    vim.fn.setenv(k, v)
+  end,
+})
+
+local function opt_validate(option_name, target_scope)
+  local scope = options_info[option_name].scope
+  if scope ~= target_scope then
+    local scope_to_string = { buf = 'buffer', win = 'window' }
+    error(
+      string.format(
+        [['%s' is a %s option, not a %s option. See ":help %s"]],
+        option_name,
+        scope_to_string[scope] or scope,
+        scope_to_string[target_scope] or target_scope,
+        option_name
+      )
+    )
+  end
+end
+
+local function new_buf_opt_accessor(bufnr)
+  return setmetatable({}, {
+    __index = function(_, k)
+      if bufnr == nil and type(k) == 'number' then
+        return new_buf_opt_accessor(k)
+      end
+      opt_validate(k, 'buf')
+      return api.nvim_get_option_value(k, { buf = bufnr or 0 })
+    end,
+
+    __newindex = function(_, k, v)
+      opt_validate(k, 'buf')
+      return api.nvim_set_option_value(k, v, { buf = bufnr or 0 })
+    end,
+  })
+end
+
+vim.bo = new_buf_opt_accessor()
+
+local function new_win_opt_accessor(winid, bufnr)
+  return setmetatable({}, {
+    __index = function(_, k)
+      if bufnr == nil and type(k) == 'number' then
+        if winid == nil then
+          return new_win_opt_accessor(k)
+        else
+          return new_win_opt_accessor(winid, k)
+        end
+      end
+
+      if bufnr ~= nil and bufnr ~= 0 then
+        error('only bufnr=0 is supported')
+      end
+
+      opt_validate(k, 'win')
+      -- TODO(lewis6991): allow passing both buf and win to nvim_get_option_value
+      return api.nvim_get_option_value(k, {
+        scope = bufnr and 'local' or nil,
+        win = winid or 0,
+      })
+    end,
+
+    __newindex = function(_, k, v)
+      opt_validate(k, 'win')
+      -- TODO(lewis6991): allow passing both buf and win to nvim_set_option_value
+      return api.nvim_set_option_value(k, v, {
+        scope = bufnr and 'local' or nil,
+        win = winid or 0,
+      })
+    end,
+  })
+end
+
+vim.wo = new_win_opt_accessor()
+
+-- vim global option
+--  this ONLY sets the global option. like `setglobal`
+vim.go = setmetatable({}, {
+  __index = function(_, k)
+    return api.nvim_get_option_value(k, { scope = 'global' })
+  end,
+  __newindex = function(_, k, v)
+    return api.nvim_set_option_value(k, v, { scope = 'global' })
+  end,
+})
+
+-- vim `set` style options.
+--  it has no additional metamethod magic.
+vim.o = setmetatable({}, {
+  __index = function(_, k)
+    return api.nvim_get_option_value(k, {})
+  end,
+  __newindex = function(_, k, v)
+    return api.nvim_set_option_value(k, v, {})
+  end,
+})
+
+---@brief [[
+--- vim.opt, vim.opt_local and vim.opt_global implementation
+---
+--- To be used as helpers for working with options within neovim.
+--- For information on how to use, see :help vim.opt
+---
+---@brief ]]
+
+--- Preserves the order and does not mutate the original list
+local function remove_duplicate_values(t)
+  local result, seen = {}, {}
+  for _, v in ipairs(t) do
+    if not seen[v] then
+      table.insert(result, v)
+    end
+
+    seen[v] = true
+  end
+
+  return result
+end
+
+-- Check whether the OptionTypes is allowed for vim.opt
+-- If it does not match, throw an error which indicates which option causes the error.
+local function assert_valid_value(name, value, types)
+  local type_of_value = type(value)
+  for _, valid_type in ipairs(types) do
+    if valid_type == type_of_value then
+      return
+    end
+  end
+
+  error(
+    string.format(
+      "Invalid option type '%s' for '%s', should be %s",
+      type_of_value,
+      name,
+      table.concat(types, ' or ')
+    )
+  )
+end
+
+local function passthrough(_, x)
+  return x
+end
+
+local function tbl_merge(left, right)
+  return vim.tbl_extend('force', left, right)
+end
+
+local function tbl_remove(t, value)
+  if type(value) == 'string' then
+    t[value] = nil
+  else
+    for _, v in ipairs(value) do
+      t[v] = nil
+    end
+  end
+
+  return t
+end
+
+local valid_types = {
+  boolean = { 'boolean' },
+  number = { 'number' },
+  string = { 'string' },
+  set = { 'string', 'table' },
+  array = { 'string', 'table' },
+  map = { 'string', 'table' },
+}
+
+-- Map of functions to take a Lua style value and convert to vimoption_T style value.
+-- Each function takes (info, lua_value) -> vim_value
+local to_vim_value = {
+  boolean = passthrough,
+  number = passthrough,
+  string = passthrough,
+
+  set = function(info, value)
+    if type(value) == 'string' then
+      return value
+    end
+
+    if info.flaglist and info.commalist then
+      local keys = {}
+      for k, v in pairs(value) do
+        if v then
+          table.insert(keys, k)
+        end
+      end
+
+      table.sort(keys)
+      return table.concat(keys, ',')
+    else
+      local result = ''
+      for k, v in pairs(value) do
+        if v then
+          result = result .. k
+        end
+      end
+
+      return result
+    end
+  end,
+
+  array = function(info, value)
+    if type(value) == 'string' then
+      return value
+    end
+    if not info.allows_duplicates then
+      value = remove_duplicate_values(value)
+    end
+    return table.concat(value, ',')
+  end,
+
+  map = function(_, value)
+    if type(value) == 'string' then
+      return value
+    end
+
+    local result = {}
+    for opt_key, opt_value in pairs(value) do
+      table.insert(result, string.format('%s:%s', opt_key, opt_value))
+    end
+
+    table.sort(result)
+    return table.concat(result, ',')
+  end,
+}
+
+--- Convert a Lua value to a vimoption_T value
+local function convert_value_to_vim(name, info, value)
+  if value == nil then
+    return vim.NIL
+  end
+
+  assert_valid_value(name, value, valid_types[info.metatype])
+
+  return to_vim_value[info.metatype](info, value)
+end
+
+-- Map of OptionType to functions that take vimoption_T values and convert to Lua values.
+-- Each function takes (info, vim_value) -> lua_value
+local to_lua_value = {
+  boolean = passthrough,
+  number = passthrough,
+  string = passthrough,
+
+  array = function(info, value)
+    if type(value) == 'table' then
+      if not info.allows_duplicates then
+        value = remove_duplicate_values(value)
+      end
+
+      return value
+    end
+
+    -- Empty strings mean that there is nothing there,
+    -- so empty table should be returned.
+    if value == '' then
+      return {}
+    end
+
+    -- Handles unescaped commas in a list.
+    if string.find(value, ',,,') then
+      local left, right = unpack(vim.split(value, ',,,'))
+
+      local result = {}
+      vim.list_extend(result, vim.split(left, ','))
+      table.insert(result, ',')
+      vim.list_extend(result, vim.split(right, ','))
+
+      table.sort(result)
+
+      return result
+    end
+
+    if string.find(value, ',^,,', 1, true) then
+      local left, right = unpack(vim.split(value, ',^,,', true))
+
+      local result = {}
+      vim.list_extend(result, vim.split(left, ','))
+      table.insert(result, '^,')
+      vim.list_extend(result, vim.split(right, ','))
+
+      table.sort(result)
+
+      return result
+    end
+
+    return vim.split(value, ',')
+  end,
+
+  set = function(info, value)
+    if type(value) == 'table' then
+      return value
+    end
+
+    -- Empty strings mean that there is nothing there,
+    -- so empty table should be returned.
+    if value == '' then
+      return {}
+    end
+
+    assert(info.flaglist, 'That is the only one I know how to handle')
+
+    if info.flaglist and info.commalist then
+      local split_value = vim.split(value, ',')
+      local result = {}
+      for _, v in ipairs(split_value) do
+        result[v] = true
+      end
+
+      return result
+    else
+      local result = {}
+      for i = 1, #value do
+        result[value:sub(i, i)] = true
+      end
+
+      return result
+    end
+  end,
+
+  map = function(info, raw_value)
+    if type(raw_value) == 'table' then
+      return raw_value
+    end
+
+    assert(info.commalist, 'Only commas are supported currently')
+
+    local result = {}
+
+    local comma_split = vim.split(raw_value, ',')
+    for _, key_value_str in ipairs(comma_split) do
+      local key, value = unpack(vim.split(key_value_str, ':'))
+      key = vim.trim(key)
+
+      result[key] = value
+    end
+
+    return result
+  end,
+}
+
+--- Converts a vimoption_T style value to a Lua value
+local function convert_value_to_lua(info, option_value)
+  return to_lua_value[info.metatype](info, option_value)
+end
+
+local prepend_methods = {
+  number = function()
+    error("The '^' operator is not currently supported for")
+  end,
+
+  string = function(left, right)
+    return right .. left
+  end,
+
+  array = function(left, right)
+    for i = #right, 1, -1 do
+      table.insert(left, 1, right[i])
+    end
+
+    return left
+  end,
+
+  map = tbl_merge,
+  set = tbl_merge,
+}
+
+--- Handles the '^' operator
+local function prepend_value(info, current, new)
+  return prepend_methods[info.metatype](
+    convert_value_to_lua(info, current),
+    convert_value_to_lua(info, new)
+  )
+end
+
+local add_methods = {
+  number = function(left, right)
+    return left + right
+  end,
+
+  string = function(left, right)
+    return left .. right
+  end,
+
+  array = function(left, right)
+    for _, v in ipairs(right) do
+      table.insert(left, v)
+    end
+
+    return left
+  end,
+
+  map = tbl_merge,
+  set = tbl_merge,
+}
+
+--- Handles the '+' operator
+local function add_value(info, current, new)
+  return add_methods[info.metatype](
+    convert_value_to_lua(info, current),
+    convert_value_to_lua(info, new)
+  )
+end
+
+local function remove_one_item(t, val)
+  if vim.tbl_islist(t) then
+    local remove_index = nil
+    for i, v in ipairs(t) do
+      if v == val then
+        remove_index = i
+      end
+    end
+
+    if remove_index then
+      table.remove(t, remove_index)
+    end
+  else
+    t[val] = nil
+  end
+end
+
+local remove_methods = {
+  number = function(left, right)
+    return left - right
+  end,
+
+  string = function()
+    error('Subtraction not supported for strings.')
+  end,
+
+  array = function(left, right)
+    if type(right) == 'string' then
+      remove_one_item(left, right)
+    else
+      for _, v in ipairs(right) do
+        remove_one_item(left, v)
+      end
+    end
+
+    return left
+  end,
+
+  map = tbl_remove,
+  set = tbl_remove,
+}
+
+--- Handles the '-' operator
+local function remove_value(info, current, new)
+  return remove_methods[info.metatype](convert_value_to_lua(info, current), new)
+end
+
+local function create_option_accessor(scope)
+  local option_mt
+
+  local function make_option(name, value)
+    local info = assert(options_info[name], 'Not a valid option name: ' .. name)
+
+    if type(value) == 'table' and getmetatable(value) == option_mt then
+      assert(name == value._name, "must be the same value, otherwise that's weird.")
+
+      value = value._value
+    end
+
+    return setmetatable({
+      _name = name,
+      _value = value,
+      _info = info,
+    }, option_mt)
+  end
+
+  option_mt = {
+    -- To set a value, instead use:
+    --  opt[my_option] = value
+    _set = function(self)
+      local value = convert_value_to_vim(self._name, self._info, self._value)
+      api.nvim_set_option_value(self._name, value, { scope = scope })
+    end,
+
+    get = function(self)
+      return convert_value_to_lua(self._info, self._value)
+    end,
+
+    append = function(self, right)
+      self._value = add_value(self._info, self._value, right)
+      self:_set()
+    end,
+
+    __add = function(self, right)
+      return make_option(self._name, add_value(self._info, self._value, right))
+    end,
+
+    prepend = function(self, right)
+      self._value = prepend_value(self._info, self._value, right)
+      self:_set()
+    end,
+
+    __pow = function(self, right)
+      return make_option(self._name, prepend_value(self._info, self._value, right))
+    end,
+
+    remove = function(self, right)
+      self._value = remove_value(self._info, self._value, right)
+      self:_set()
+    end,
+
+    __sub = function(self, right)
+      return make_option(self._name, remove_value(self._info, self._value, right))
+    end,
+  }
+  option_mt.__index = option_mt
+
+  return setmetatable({}, {
+    __index = function(_, k)
+      return make_option(k, api.nvim_get_option_value(k, {}))
+    end,
+
+    __newindex = function(_, k, v)
+      make_option(k, v):_set()
+    end,
+  })
+end
+
+vim.opt = create_option_accessor()
+vim.opt_local = create_option_accessor('local')
+vim.opt_global = create_option_accessor('global')
-- 
cgit 


From 0ac3c4d6314df5fe40571a83e157a425ab7ce16d Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sat, 15 Jul 2023 16:55:32 +0100
Subject: docs(lua): move function docs to lua files

---
 runtime/lua/vim/_meta/builtin.lua | 236 +++++++++++++++++++++++
 runtime/lua/vim/_meta/diff.lua    |  67 +++++++
 runtime/lua/vim/_meta/json.lua    |  35 ++++
 runtime/lua/vim/_meta/misc.lua    |  11 ++
 runtime/lua/vim/_meta/mpack.lua   |  13 ++
 runtime/lua/vim/_meta/regex.lua   |  34 ++++
 runtime/lua/vim/_meta/spell.lua   |  29 +++
 runtime/lua/vim/_options.lua      | 381 ++++++++++++++++++++++++++++++++++++--
 runtime/lua/vim/highlight.lua     |  65 +++++--
 9 files changed, 838 insertions(+), 33 deletions(-)
 create mode 100644 runtime/lua/vim/_meta/builtin.lua
 create mode 100644 runtime/lua/vim/_meta/diff.lua
 create mode 100644 runtime/lua/vim/_meta/json.lua
 create mode 100644 runtime/lua/vim/_meta/misc.lua
 create mode 100644 runtime/lua/vim/_meta/mpack.lua
 create mode 100644 runtime/lua/vim/_meta/regex.lua
 create mode 100644 runtime/lua/vim/_meta/spell.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/builtin.lua b/runtime/lua/vim/_meta/builtin.lua
new file mode 100644
index 0000000000..384dd4351d
--- /dev/null
+++ b/runtime/lua/vim/_meta/builtin.lua
@@ -0,0 +1,236 @@
+---@meta
+
+---@defgroup lua-builtin
+---
+---@brief <pre>help
+---vim.api.{func}({...})                                                    *vim.api*
+---    Invokes Nvim |API| function {func} with arguments {...}.
+---    Example: call the "nvim_get_current_line()" API function: >lua
+---        print(tostring(vim.api.nvim_get_current_line()))
+---
+---vim.NIL                                                                  *vim.NIL*
+---    Special value representing NIL in |RPC| and |v:null| in Vimscript
+---    conversion, and similar cases. Lua `nil` cannot be used as part of a Lua
+---    table representing a Dictionary or Array, because it is treated as
+---    missing: `{"foo", nil}` is the same as `{"foo"}`.
+---
+---vim.type_idx                                                        *vim.type_idx*
+---    Type index for use in |lua-special-tbl|. Specifying one of the values from
+---    |vim.types| allows typing the empty table (it is unclear whether empty Lua
+---    table represents empty list or empty array) and forcing integral numbers
+---    to be |Float|. See |lua-special-tbl| for more details.
+---
+---vim.val_idx                                                          *vim.val_idx*
+---    Value index for tables representing |Float|s. A table representing
+---    floating-point value 1.0 looks like this: >lua
+---        {
+---          [vim.type_idx] = vim.types.float,
+---          [vim.val_idx] = 1.0,
+---        }
+---<    See also |vim.type_idx| and |lua-special-tbl|.
+---
+---vim.types                                                              *vim.types*
+---    Table with possible values for |vim.type_idx|. Contains two sets of
+---    key-value pairs: first maps possible values for |vim.type_idx| to
+---    human-readable strings, second maps human-readable type names to values
+---    for |vim.type_idx|. Currently contains pairs for `float`, `array` and
+---        `dictionary` types.
+---
+---    Note: One must expect that values corresponding to `vim.types.float`,
+---    `vim.types.array` and `vim.types.dictionary` fall under only two following
+---    assumptions:
+---    1. Value may serve both as a key and as a value in a table. Given the
+---       properties of Lua tables this basically means “value is not `nil`”.
+---    2. For each value in `vim.types` table `vim.types[vim.types[value]]` is the
+---       same as `value`.
+---    No other restrictions are put on types, and it is not guaranteed that
+---    values corresponding to `vim.types.float`, `vim.types.array` and
+---    `vim.types.dictionary` will not change or that `vim.types` table will only
+---    contain values for these three types.
+---
+---                                                   *log_levels* *vim.log.levels*
+---Log levels are one of the values defined in `vim.log.levels`:
+---
+---    vim.log.levels.DEBUG
+---    vim.log.levels.ERROR
+---    vim.log.levels.INFO
+---    vim.log.levels.TRACE
+---    vim.log.levels.WARN
+---    vim.log.levels.OFF
+---
+---</pre>
+
+--- Returns true if the code is executing as part of a "fast" event handler,
+--- where most of the API is disabled. These are low-level events (e.g.
+--- |lua-loop-callbacks|) which can be invoked whenever Nvim polls for input.
+--- When this is `false` most API functions are callable (but may be subject
+--- to other restrictions such as |textlock|).
+function vim.in_fast_event() end
+
+--- Creates a special empty table (marked with a metatable), which Nvim to an
+--- empty dictionary when translating Lua values to Vimscript or API types.
+--- Nvim by default converts an empty table `{}` without this metatable to an
+--- list/array.
+---
+--- Note: If numeric keys are present in the table, Nvim ignores the metatable
+--- marker and converts the dict to a list/array anyway.
+function vim.empty_dict() end
+
+--- Sends {event} to {channel} via |RPC| and returns immediately. If {channel}
+--- is 0, the event is broadcast to all channels.
+---
+--- This function also works in a fast callback |lua-loop-callbacks|.
+--- @param channel integer
+--- @param method string
+--- @param args? any[]
+--- @param ...? any
+function vim.rpcnotify(channel, method, args, ...) end
+
+--- Sends a request to {channel} to invoke {method} via |RPC| and blocks until
+--- a response is received.
+---
+--- Note: NIL values as part of the return value is represented as |vim.NIL|
+--- special value
+--- @param channel integer
+--- @param method string
+--- @param args? any[]
+--- @param ...? any
+function vim.rpcrequest(channel, method, args, ...) end
+
+--- Compares strings case-insensitively.
+--- @param a string
+--- @param b string
+--- @return 0|1|-1
+--- if strings are
+--- equal, {a} is greater than {b} or {a} is lesser than {b}, respectively.
+function vim.stricmp(a, b) end
+
+--- Convert UTF-32 or UTF-16 {index} to byte index. If {use_utf16} is not
+--- supplied, it defaults to false (use UTF-32). Returns the byte index.
+---
+--- Invalid UTF-8 and NUL is treated like by |vim.str_byteindex()|.
+--- An {index} in the middle of a UTF-16 sequence is rounded upwards to
+--- the end of that sequence.
+--- @param str string
+--- @param index number
+--- @param use_utf16? any
+function vim.str_byteindex(str, index, use_utf16) end
+
+--- Convert byte index to UTF-32 and UTF-16 indices. If {index} is not
+--- supplied, the length of the string is used. All indices are zero-based.
+---
+--- Embedded NUL bytes are treated as terminating the string. Invalid UTF-8
+--- bytes, and embedded surrogates are counted as one code point each. An
+--- {index} in the middle of a UTF-8 sequence is rounded upwards to the end of
+--- that sequence.
+--- @param str string
+--- @param index? number
+--- @return integer UTF-32 index
+--- @return integer UTF-16 index
+function vim.str_utfindex(str, index) end
+
+--- The result is a String, which is the text {str} converted from
+--- encoding {from} to encoding {to}. When the conversion fails `nil` is
+--- returned.  When some characters could not be converted they
+--- are replaced with "?".
+--- The encoding names are whatever the iconv() library function
+--- can accept, see ":Man 3 iconv".
+---
+--- @param str string Text to convert
+--- @param from number Encoding of {str}
+--- @param to number Target encoding
+--- @param opts? table<string, any>
+--- @return string|nil Converted string if conversion succeeds, `nil` otherwise.
+function vim.iconv(str, from, to, opts) end
+
+--- Schedules {callback} to be invoked soon by the main event-loop. Useful
+--- to avoid |textlock| or other temporary restrictions.
+--- @param callback fun()
+function vim.schedule(callback) end
+
+--- Wait for {time} in milliseconds until {callback} returns `true`.
+---
+--- Executes {callback} immediately and at approximately {interval}
+--- milliseconds (default 200). Nvim still processes other events during
+--- this time.
+---
+--- Examples:
+--- <pre>lua
+---
+--- ---
+--- -- Wait for 100 ms, allowing other events to process
+--- vim.wait(100, function() end)
+---
+--- ---
+--- -- Wait for 100 ms or until global variable set.
+--- vim.wait(100, function() return vim.g.waiting_for_var end)
+---
+--- ---
+--- -- Wait for 1 second or until global variable set, checking every ~500 ms
+--- vim.wait(1000, function() return vim.g.waiting_for_var end, 500)
+---
+--- ---
+--- -- Schedule a function to set a value in 100ms
+--- vim.defer_fn(function() vim.g.timer_result = true end, 100)
+---
+--- -- Would wait ten seconds if results blocked. Actually only waits  100 ms
+--- if vim.wait(10000, function() return vim.g.timer_result end) then
+---   print('Only waiting a little bit of time!')
+--- end
+--- </pre>
+---
+--- @param time integer Number of milliseconds to wait
+--- @param callback? fun(): boolean Optional callback. Waits until {callback} returns true
+--- @param interval? integer (Approximate) number of milliseconds to wait between polls
+--- @param fast_only? boolean If true, only |api-fast| events will be processed.
+---                           If called from while in an |api-fast| event, will
+---                           automatically be set to `true`.
+--- @return boolean, nil|-1|-2
+---     - If {callback} returns `true` during the {time}: `true, nil`
+---     - If {callback} never returns `true` during the {time}: `false, -1`
+---     - If {callback} is interrupted during the {time}: `false, -2`
+---     - If {callback} errors, the error is raised.
+function vim.wait(time, callback, interval, fast_only) end
+
+--- Attach to ui events, similar to |nvim_ui_attach()| but receive events
+--- as Lua callback. Can be used to implement screen elements like
+--- popupmenu or message handling in Lua.
+---
+--- {options} should be a dictionary-like table, where `ext_...` options should
+--- be set to true to receive events for the respective external element.
+---
+--- {callback} receives event name plus additional parameters. See |ui-popupmenu|
+--- and the sections below for event format for respective events.
+---
+--- WARNING: This api is considered experimental.  Usability will vary for
+--- different screen elements. In particular `ext_messages` behavior is subject
+--- to further changes and usability improvements.  This is expected to be
+--- used to handle messages when setting 'cmdheight' to zero (which is
+--- likewise experimental).
+---
+--- Example (stub for a |ui-popupmenu| implementation):
+--- <pre>lua
+---
+---   ns = vim.api.nvim_create_namespace('my_fancy_pum')
+---
+---   vim.ui_attach(ns, {ext_popupmenu=true}, function(event, ...)
+---     if event == "popupmenu_show" then
+---       local items, selected, row, col, grid = ...
+---       print("display pum ", #items)
+---     elseif event == "popupmenu_select" then
+---       local selected = ...
+---       print("selected", selected)
+---     elseif event == "popupmenu_hide" then
+---       print("FIN")
+---     end
+---   end)
+--- </pre>
+--- @param ns integer
+--- @param options table<string, any>
+--- @param callback fun()
+function vim.ui_attach(ns, options, callback) end
+
+--- Detach a callback previously attached with |vim.ui_attach()| for the
+--- given namespace {ns}.
+--- @param ns integer
+function vim.ui_detach(ns) end
diff --git a/runtime/lua/vim/_meta/diff.lua b/runtime/lua/vim/_meta/diff.lua
new file mode 100644
index 0000000000..8e8aaf8b64
--- /dev/null
+++ b/runtime/lua/vim/_meta/diff.lua
@@ -0,0 +1,67 @@
+---@meta
+
+--- Run diff on strings {a} and {b}. Any indices returned by this function,
+--- either directly or via callback arguments, are 1-based.
+---
+--- Examples:
+--- <pre>lua
+---     vim.diff('a\\n', 'b\\nc\\n')
+---     -- =>
+---     -- @@ -1 +1,2 @@
+---     -- -a
+---     -- +b
+---     -- +c
+---
+---     vim.diff('a\\n', 'b\\nc\\n', {result_type = 'indices'})
+---     -- =>
+---     -- {
+---     --   {1, 1, 1, 2}
+---     -- }
+--- </pre>
+---
+--- @param a string First string to compare
+--- @param b string Second string to compare
+--- @param opts table<string,any> Optional parameters:
+---     - `on_hunk` (callback):
+---       Invoked for each hunk in the diff. Return a negative number
+---       to cancel the callback for any remaining hunks.
+---       Args:
+---       - `start_a` (integer): Start line of hunk in {a}.
+---       - `count_a` (integer): Hunk size in {a}.
+---       - `start_b` (integer): Start line of hunk in {b}.
+---       - `count_b` (integer): Hunk size in {b}.
+---     - `result_type` (string): Form of the returned diff:
+---       - "unified": (default) String in unified format.
+---       - "indices": Array of hunk locations.
+---       Note: This option is ignored if `on_hunk` is used.
+---     - `linematch` (boolean|integer): Run linematch on the resulting hunks
+---       from xdiff. When integer, only hunks upto this size in
+---       lines are run through linematch. Requires `result_type = indices`,
+---       ignored otherwise.
+---     - `algorithm` (string):
+---       Diff algorithm to use. Values:
+---       - "myers"      the default algorithm
+---       - "minimal"    spend extra time to generate the
+---                      smallest possible diff
+---       - "patience"   patience diff algorithm
+---       - "histogram"  histogram diff algorithm
+---     - `ctxlen` (integer): Context length
+---     - `interhunkctxlen` (integer):
+---       Inter hunk context length
+---     - `ignore_whitespace` (boolean):
+---       Ignore whitespace
+---     - `ignore_whitespace_change` (boolean):
+---       Ignore whitespace change
+---     - `ignore_whitespace_change_at_eol` (boolean)
+---       Ignore whitespace change at end-of-line.
+---     - `ignore_cr_at_eol` (boolean)
+---       Ignore carriage return at end-of-line
+---     - `ignore_blank_lines` (boolean)
+---       Ignore blank lines
+---     - `indent_heuristic` (boolean):
+---       Use the indent heuristic for the internal
+---       diff library.
+---
+--- @return string|table|nil
+---     See {opts.result_type}. `nil` if {opts.on_hunk} is given.
+function vim.diff(a, b, opts) end
diff --git a/runtime/lua/vim/_meta/json.lua b/runtime/lua/vim/_meta/json.lua
new file mode 100644
index 0000000000..15e81d5004
--- /dev/null
+++ b/runtime/lua/vim/_meta/json.lua
@@ -0,0 +1,35 @@
+--- @meta
+
+--- @defgroup lua-json
+---
+--- @brief The \*vim.json\* module provides encoding and decoding of Lua objects to and
+--- from JSON-encoded strings. Supports |vim.NIL| and |vim.empty_dict()|.
+
+--- Decodes (or "unpacks") the JSON-encoded {str} to a Lua object.
+---
+--- - Decodes JSON "null" as |vim.NIL| (controllable by {opts}, see below).
+--- - Decodes empty object as |vim.empty_dict()|.
+--- - Decodes empty array as `{}` (empty Lua table).
+---
+--- Example:
+--- <pre>lua
+--- :lua vim.print(vim.json.decode('{"bar":[],"foo":{},"zub":null}'))
+--- --> { bar = {}, foo = vim.empty_dict(), zub = vim.NIL }
+--- </pre>
+--- Parameters: ~
+---   • {str}    Stringified JSON data.
+---   • {opts}   Options map keys:
+---              • luanil: { object: bool, array: bool }
+---                • `luanil.object=true` converts `null` in JSON objects to
+---                  Lua `nil` instead of `vim.NIL`.
+---                • `luanil.array=true` converts `null` in JSON arrays to Lua
+---                  `nil` instead of `vim.NIL`.
+--- @param str string
+--- @param opts? table<string, any>
+--- @return any
+function vim.json.decode(str, opts) end
+
+--- Encodes (or "packs") Lua object {obj} as JSON in a Lua string.
+--- @param obj any
+--- @return string
+function vim.json.encode(obj) end
diff --git a/runtime/lua/vim/_meta/misc.lua b/runtime/lua/vim/_meta/misc.lua
new file mode 100644
index 0000000000..954e8b4675
--- /dev/null
+++ b/runtime/lua/vim/_meta/misc.lua
@@ -0,0 +1,11 @@
+---@meta
+
+--- Invokes |vim-function| or |user-function| {func} with arguments {...}.
+--- See also |vim.fn|.
+--- Equivalent to:
+--- <pre>lua
+---     vim.fn[func]({...})
+--- </pre>
+--- @param func fun()
+--- @param ... any
+function vim.call(func, ...) end
diff --git a/runtime/lua/vim/_meta/mpack.lua b/runtime/lua/vim/_meta/mpack.lua
new file mode 100644
index 0000000000..2764177e5c
--- /dev/null
+++ b/runtime/lua/vim/_meta/mpack.lua
@@ -0,0 +1,13 @@
+--- @meta
+
+--- @defgroup lua-mpack
+---
+--- @brief The \*vim.mpack\* module provides encoding and decoding of Lua objects to and
+--- from msgpack-encoded strings. Supports |vim.NIL| and |vim.empty_dict()|.
+
+--- Decodes (or "unpacks") the msgpack-encoded {str} to a Lua object.
+--- @param str string
+function vim.mpack.decode(str) end
+
+--- Encodes (or "packs") Lua object {obj} as msgpack in a Lua string.
+function vim.mpack.encode(obj) end
diff --git a/runtime/lua/vim/_meta/regex.lua b/runtime/lua/vim/_meta/regex.lua
new file mode 100644
index 0000000000..afa78772da
--- /dev/null
+++ b/runtime/lua/vim/_meta/regex.lua
@@ -0,0 +1,34 @@
+--- @meta
+
+--- @defgroup lua-regex
+---
+--- @brief Vim regexes can be used directly from Lua. Currently they only allow
+--- matching within a single line.
+
+--- Parse the Vim regex {re} and return a regex object. Regexes are "magic"
+--- and case-sensitive by default, regardless of 'magic' and 'ignorecase'.
+--- They can be controlled with flags, see |/magic| and |/ignorecase|.
+--- @param re string
+--- @return vim.regex
+function vim.regex(re) end
+
+--- @class vim.regex
+local regex = {}
+
+--- Match the string against the regex. If the string should match the regex
+--- precisely, surround the regex with `^` and `$`. If the was a match, the
+--- byte indices for the beginning and end of the match is returned. When
+--- there is no match, `nil` is returned. As any integer is truth-y,
+--- `regex:match()` can be directly used as a condition in an if-statement.
+--- @param str string
+function regex:match_str(str) end
+
+--- Match line {line_idx} (zero-based) in buffer {bufnr}. If {start} and {end}
+--- are supplied, match only this byte index range. Otherwise see
+--- |regex:match_str()|. If {start} is used, then the returned byte indices
+--- will be relative {start}.
+--- @param bufnr integer
+--- @param line_idx integer
+--- @param start? integer
+--- @param end_? integer
+function regex:match_line(bufnr, line_idx, start, end_) end
diff --git a/runtime/lua/vim/_meta/spell.lua b/runtime/lua/vim/_meta/spell.lua
new file mode 100644
index 0000000000..926c8a686d
--- /dev/null
+++ b/runtime/lua/vim/_meta/spell.lua
@@ -0,0 +1,29 @@
+--- @meta
+
+--- Check {str} for spelling errors. Similar to the Vimscript function
+--- |spellbadword()|.
+---
+--- Note: The behaviour of this function is dependent on: 'spelllang',
+--- 'spellfile', 'spellcapcheck' and 'spelloptions' which can all be local to
+--- the buffer. Consider calling this with |nvim_buf_call()|.
+---
+--- Example:
+--- <pre>lua
+---     vim.spell.check("the quik brown fox")
+---     -- =>
+---     -- {
+---     --     {'quik', 'bad', 5}
+---     -- }
+--- </pre>
+---
+--- @param str string
+--- @return {[1]: string, [2]: string, [3]: string}[]
+---   List of tuples with three items:
+---     - The badly spelled word.
+---     - The type of the spelling error:
+---         "bad"   spelling mistake
+---         "rare"  rare word
+---         "local" word only valid in another region
+---         "caps"  word should start with Capital
+---     - The position in {str} where the word begins.
+function vim.spell.check(str) end
diff --git a/runtime/lua/vim/_options.lua b/runtime/lua/vim/_options.lua
index 41e6e8be86..d498ae0a2c 100644
--- a/runtime/lua/vim/_options.lua
+++ b/runtime/lua/vim/_options.lua
@@ -1,3 +1,108 @@
+---@defgroup lua-vimscript
+---
+---@brief Nvim Lua provides an interface or "bridge" to Vimscript variables and
+---functions, and editor commands and options.
+---
+---Objects passed over this bridge are COPIED (marshalled): there are no
+---"references". |lua-guide-variables| For example, using \`vim.fn.remove()\` on
+---a Lua list copies the list object to Vimscript and does NOT modify the Lua
+---list:
+---<pre>lua
+---    local list = { 1, 2, 3 }
+---    vim.fn.remove(list, 0)
+---    vim.print(list)  --> "{ 1, 2, 3 }"
+---</pre>
+
+---@addtogroup lua-vimscript
+---@brief <pre>help
+---vim.call({func}, {...})                                           *vim.call()*
+---    Invokes |vim-function| or |user-function| {func} with arguments {...}.
+---    See also |vim.fn|.
+---    Equivalent to: >lua
+---        vim.fn[func]({...})
+---<
+---vim.cmd({command})
+---    See |vim.cmd()|.
+---
+---vim.fn.{func}({...})                                                  *vim.fn*
+---    Invokes |vim-function| or |user-function| {func} with arguments {...}.
+---    To call autoload functions, use the syntax: >lua
+---        vim.fn['some\#function']({...})
+---<
+---    Unlike vim.api.|nvim_call_function()| this converts directly between Vim
+---    objects and Lua objects. If the Vim function returns a float, it will be
+---    represented directly as a Lua number. Empty lists and dictionaries both
+---    are represented by an empty table.
+---
+---    Note: |v:null| values as part of the return value is represented as
+---    |vim.NIL| special value
+---
+---    Note: vim.fn keys are generated lazily, thus `pairs(vim.fn)` only
+---    enumerates functions that were called at least once.
+---
+---    Note: The majority of functions cannot run in |api-fast| callbacks with some
+---    undocumented exceptions which are allowed.
+---
+---                                                           *lua-vim-variables*
+---The Vim editor global dictionaries |g:| |w:| |b:| |t:| |v:| can be accessed
+---from Lua conveniently and idiomatically by referencing the `vim.*` Lua tables
+---described below. In this way you can easily read and modify global Vimscript
+---variables from Lua.
+---
+---Example: >lua
+---
+---    vim.g.foo = 5     -- Set the g:foo Vimscript variable.
+---    print(vim.g.foo)  -- Get and print the g:foo Vimscript variable.
+---    vim.g.foo = nil   -- Delete (:unlet) the Vimscript variable.
+---    vim.b[2].foo = 6  -- Set b:foo for buffer 2
+---<
+---
+---Note that setting dictionary fields directly will not write them back into
+---Nvim. This is because the index into the namespace simply returns a copy.
+---Instead the whole dictionary must be written as one. This can be achieved by
+---creating a short-lived temporary.
+---
+---Example: >lua
+---
+---    vim.g.my_dict.field1 = 'value'  -- Does not work
+---
+---    local my_dict = vim.g.my_dict   --
+---    my_dict.field1 = 'value'        -- Instead do
+---    vim.g.my_dict = my_dict         --
+---
+---vim.g                                                                  *vim.g*
+---    Global (|g:|) editor variables.
+---    Key with no value returns `nil`.
+---
+---vim.b                                                                  *vim.b*
+---    Buffer-scoped (|b:|) variables for the current buffer.
+---    Invalid or unset key returns `nil`. Can be indexed with
+---    an integer to access variables for a specific buffer.
+---
+---vim.w                                                                  *vim.w*
+---    Window-scoped (|w:|) variables for the current window.
+---    Invalid or unset key returns `nil`. Can be indexed with
+---    an integer to access variables for a specific window.
+---
+---vim.t                                                                  *vim.t*
+---    Tabpage-scoped (|t:|) variables for the current tabpage.
+---    Invalid or unset key returns `nil`. Can be indexed with
+---    an integer to access variables for a specific tabpage.
+---
+---vim.v                                                                  *vim.v*
+---    |v:| variables.
+---    Invalid or unset key returns `nil`.
+---
+---vim.env                                                              *vim.env*
+---    Environment variables defined in the editor session.
+---    See |expand-env| and |:let-environment| for the Vimscript behavior.
+---    Invalid or unset key returns `nil`.
+---    Example: >lua
+---        vim.env.FOO = 'bar'
+---        print(vim.env.TERM)
+---<
+---</pre>
+
 local api = vim.api
 
 -- TODO(tjdevries): Improve option metadata so that this doesn't have to be hardcoded.
@@ -13,6 +118,7 @@ local key_value_options = {
 
 --- Convert a vimoption_T style dictionary to the correct OptionType associated with it.
 ---@return string
+---@private
 local function get_option_metatype(name, info)
   if info.type == 'string' then
     if info.flaglist then
@@ -51,6 +157,7 @@ vim.env = setmetatable({}, {
   end,
 })
 
+---@private
 local function opt_validate(option_name, target_scope)
   local scope = options_info[option_name].scope
   if scope ~= target_scope then
@@ -67,6 +174,7 @@ local function opt_validate(option_name, target_scope)
   end
 end
 
+---@private
 local function new_buf_opt_accessor(bufnr)
   return setmetatable({}, {
     __index = function(_, k)
@@ -84,8 +192,7 @@ local function new_buf_opt_accessor(bufnr)
   })
 end
 
-vim.bo = new_buf_opt_accessor()
-
+---@private
 local function new_win_opt_accessor(winid, bufnr)
   return setmetatable({}, {
     __index = function(_, k)
@@ -120,30 +227,118 @@ local function new_win_opt_accessor(winid, bufnr)
   })
 end
 
-vim.wo = new_win_opt_accessor()
-
--- vim global option
---  this ONLY sets the global option. like `setglobal`
-vim.go = setmetatable({}, {
+---@addtogroup lua-vimscript
+---@brief <pre>help
+---` `                                                                *lua-options*
+---                                                             *lua-vim-options*
+---                                                                 *lua-vim-set*
+---                                                            *lua-vim-setlocal*
+---
+---Vim options can be accessed through |vim.o|, which behaves like Vimscript
+---|:set|.
+---
+---    Examples: ~
+---
+---    To set a boolean toggle:
+---        Vimscript: `set number`
+---        Lua:       `vim.o.number = true`
+---
+---    To set a string value:
+---        Vimscript: `set wildignore=*.o,*.a,__pycache__`
+---        Lua:       `vim.o.wildignore = '*.o,*.a,__pycache__'`
+---
+---Similarly, there is |vim.bo| and |vim.wo| for setting buffer-scoped and
+---window-scoped options. Note that this must NOT be confused with
+---|local-options| and |:setlocal|. There is also |vim.go| that only accesses the
+---global value of a |global-local| option, see |:setglobal|.
+---</pre>
+
+---@addtogroup lua-vimscript
+---@brief <pre>help
+---vim.o                                                                  *vim.o*
+---    Get or set |options|. Like `:set`. Invalid key is an error.
+---
+---    Note: this works on both buffer-scoped and window-scoped options using the
+---    current buffer and window.
+---
+---    Example: >lua
+---        vim.o.cmdheight = 4
+---        print(vim.o.columns)
+---        print(vim.o.foo)     -- error: invalid key
+---<
+---</pre>
+vim.o = setmetatable({}, {
   __index = function(_, k)
-    return api.nvim_get_option_value(k, { scope = 'global' })
+    return api.nvim_get_option_value(k, {})
   end,
   __newindex = function(_, k, v)
-    return api.nvim_set_option_value(k, v, { scope = 'global' })
+    return api.nvim_set_option_value(k, v, {})
   end,
 })
 
--- vim `set` style options.
---  it has no additional metamethod magic.
-vim.o = setmetatable({}, {
+---@addtogroup lua-vimscript
+---@brief <pre>help
+---vim.go                                                                *vim.go*
+---    Get or set global |options|. Like `:setglobal`. Invalid key is
+---    an error.
+---
+---    Note: this is different from |vim.o| because this accesses the global
+---    option value and thus is mostly useful for use with |global-local|
+---    options.
+---
+---    Example: >lua
+---        vim.go.cmdheight = 4
+---        print(vim.go.columns)
+---        print(vim.go.bar)     -- error: invalid key
+---<
+---</pre>
+vim.go = setmetatable({}, {
   __index = function(_, k)
-    return api.nvim_get_option_value(k, {})
+    return api.nvim_get_option_value(k, { scope = 'global' })
   end,
   __newindex = function(_, k, v)
-    return api.nvim_set_option_value(k, v, {})
+    return api.nvim_set_option_value(k, v, { scope = 'global' })
   end,
 })
 
+---@addtogroup lua-vimscript
+---@brief <pre>help
+---vim.bo[{bufnr}]                                                                *vim.bo*
+---    Get or set buffer-scoped |options| for the buffer with number {bufnr}.
+---    Like `:set` and `:setlocal`. If [{bufnr}] is omitted then the current
+---    buffer is used. Invalid {bufnr} or key is an error.
+---
+---    Note: this is equivalent to both `:set` and `:setlocal`.
+---
+---    Example: >lua
+---        local bufnr = vim.api.nvim_get_current_buf()
+---        vim.bo[bufnr].buflisted = true    -- same as vim.bo.buflisted = true
+---        print(vim.bo.comments)
+---        print(vim.bo.baz)                 -- error: invalid key
+---</pre>
+vim.bo = new_buf_opt_accessor()
+
+---@addtogroup lua-vimscript
+---@brief <pre>help
+---vim.wo[{winid}][{bufnr}]                                                       *vim.wo*
+---    Get or set window-scoped |options| for the window with handle {winid} and
+---    buffer with number {bufnr}. Like `:setlocal` if {bufnr} is provided, like
+---    `:set` otherwise. If [{winid}] is omitted then the current window is
+---    used. Invalid {winid}, {bufnr} or key is an error.
+---
+---    Note: only {bufnr} with value `0` (the current buffer in the window) is
+---    supported.
+---
+---    Example: >lua
+---        local winid = vim.api.nvim_get_current_win()
+---        vim.wo[winid].number = true    -- same as vim.wo.number = true
+---        print(vim.wo.foldmarker)
+---        print(vim.wo.quux)             -- error: invalid key
+---        vim.wo[winid][0].spell = false -- like ':setlocal nospell'
+---<
+---</pre>
+vim.wo = new_win_opt_accessor()
+
 ---@brief [[
 --- vim.opt, vim.opt_local and vim.opt_global implementation
 ---
@@ -153,6 +348,7 @@ vim.o = setmetatable({}, {
 ---@brief ]]
 
 --- Preserves the order and does not mutate the original list
+--- @private
 local function remove_duplicate_values(t)
   local result, seen = {}, {}
   for _, v in ipairs(t) do
@@ -168,6 +364,7 @@ end
 
 -- Check whether the OptionTypes is allowed for vim.opt
 -- If it does not match, throw an error which indicates which option causes the error.
+--- @private
 local function assert_valid_value(name, value, types)
   local type_of_value = type(value)
   for _, valid_type in ipairs(types) do
@@ -186,14 +383,17 @@ local function assert_valid_value(name, value, types)
   )
 end
 
+--- @private
 local function passthrough(_, x)
   return x
 end
 
+--- @private
 local function tbl_merge(left, right)
   return vim.tbl_extend('force', left, right)
 end
 
+--- @private
 local function tbl_remove(t, value)
   if type(value) == 'string' then
     t[value] = nil
@@ -275,6 +475,7 @@ local to_vim_value = {
 }
 
 --- Convert a Lua value to a vimoption_T value
+--- @private
 local function convert_value_to_vim(name, info, value)
   if value == nil then
     return vim.NIL
@@ -390,6 +591,7 @@ local to_lua_value = {
 }
 
 --- Converts a vimoption_T style value to a Lua value
+--- @private
 local function convert_value_to_lua(info, option_value)
   return to_lua_value[info.metatype](info, option_value)
 end
@@ -416,6 +618,7 @@ local prepend_methods = {
 }
 
 --- Handles the '^' operator
+--- @private
 local function prepend_value(info, current, new)
   return prepend_methods[info.metatype](
     convert_value_to_lua(info, current),
@@ -445,6 +648,7 @@ local add_methods = {
 }
 
 --- Handles the '+' operator
+--- @private
 local function add_value(info, current, new)
   return add_methods[info.metatype](
     convert_value_to_lua(info, current),
@@ -452,6 +656,7 @@ local function add_value(info, current, new)
   )
 end
 
+--- @private
 local function remove_one_item(t, val)
   if vim.tbl_islist(t) then
     local remove_index = nil
@@ -495,13 +700,16 @@ local remove_methods = {
 }
 
 --- Handles the '-' operator
+--- @private
 local function remove_value(info, current, new)
   return remove_methods[info.metatype](convert_value_to_lua(info, current), new)
 end
 
+--- @private
 local function create_option_accessor(scope)
   local option_mt
 
+  --- @private
   local function make_option(name, value)
     local info = assert(options_info[name], 'Not a valid option name: ' .. name)
 
@@ -570,6 +778,151 @@ local function create_option_accessor(scope)
   })
 end
 
+---@addtogroup lua-vimscript
+---@brief <pre>help
+---` `                                                                       *vim.opt_local*
+---                                                                       *vim.opt_global*
+---                                                                              *vim.opt*
+---
+---
+---A special interface |vim.opt| exists for conveniently interacting with list-
+---and map-style option from Lua: It allows accessing them as Lua tables and
+---offers object-oriented method for adding and removing entries.
+---
+---    Examples: ~
+---
+---    The following methods of setting a list-style option are equivalent:
+---        In Vimscript: >vim
+---            set wildignore=*.o,*.a,__pycache__
+---<
+---        In Lua using `vim.o`: >lua
+---            vim.o.wildignore = '*.o,*.a,__pycache__'
+---<
+---        In Lua using `vim.opt`: >lua
+---            vim.opt.wildignore = { '*.o', '*.a', '__pycache__' }
+---<
+---    To replicate the behavior of |:set+=|, use: >lua
+---
+---        vim.opt.wildignore:append { "*.pyc", "node_modules" }
+---<
+---    To replicate the behavior of |:set^=|, use: >lua
+---
+---        vim.opt.wildignore:prepend { "new_first_value" }
+---<
+---    To replicate the behavior of |:set-=|, use: >lua
+---
+---        vim.opt.wildignore:remove { "node_modules" }
+---<
+---    The following methods of setting a map-style option are equivalent:
+---        In Vimscript: >vim
+---            set listchars=space:_,tab:>~
+---<
+---        In Lua using `vim.o`: >lua
+---            vim.o.listchars = 'space:_,tab:>~'
+---<
+---        In Lua using `vim.opt`: >lua
+---            vim.opt.listchars = { space = '_', tab = '>~' }
+---<
+---
+---Note that |vim.opt| returns an `Option` object, not the value of the option,
+---which is accessed through |vim.opt:get()|:
+---
+---    Examples: ~
+---
+---    The following methods of getting a list-style option are equivalent:
+---        In Vimscript: >vim
+---            echo wildignore
+---<
+---        In Lua using `vim.o`: >lua
+---            print(vim.o.wildignore)
+---<
+---        In Lua using `vim.opt`: >lua
+---            vim.print(vim.opt.wildignore:get())
+---<
+---
+---In any of the above examples, to replicate the behavior |:setlocal|, use
+---`vim.opt_local`. Additionally, to replicate the behavior of |:setglobal|, use
+---`vim.opt_global`.
+---</pre>
+
+--- @diagnostic disable-next-line:unused-local used for gen_vimdoc
+local Option = {}
+
+---Returns a Lua-representation of the option. Boolean, number and string
+---values will be returned in exactly the same fashion.
+---
+---For values that are comma-separated lists, an array will be returned with
+---the values as entries in the array: <pre>lua
+---    vim.cmd [[set wildignore=*.pyc,*.o]]
+---
+---    vim.print(vim.opt.wildignore:get())
+---    -- { "*.pyc", "*.o", }
+---
+---    for _, ignore_pattern in ipairs(vim.opt.wildignore:get()) do
+---        print("Will ignore:", ignore_pattern)
+---    end
+---    -- Will ignore: *.pyc
+---    -- Will ignore: *.o
+---</pre>
+---
+---For values that are comma-separated maps, a table will be returned with
+---the names as keys and the values as entries: <pre>lua
+---    vim.cmd [[set listchars=space:_,tab:>~]]
+---
+---    vim.print(vim.opt.listchars:get())
+---    --  { space = "_", tab = ">~", }
+---
+---    for char, representation in pairs(vim.opt.listchars:get()) do
+---        print(char, "=>", representation)
+---    end
+---</pre>
+---
+---For values that are lists of flags, a set will be returned with the flags
+---as keys and `true` as entries. <pre>lua
+---    vim.cmd [[set formatoptions=njtcroql]]
+---
+---    vim.print(vim.opt.formatoptions:get())
+---    -- { n = true, j = true, c = true, ... }
+---
+---    local format_opts = vim.opt.formatoptions:get()
+---    if format_opts.j then
+---        print("J is enabled!")
+---    end
+---</pre>
+---@return string|integer|boolean|nil value of option
+---@diagnostic disable-next-line:unused-local used for gen_vimdoc
+function Option:get() end
+
+---Append a value to string-style options. See |:set+=|
+---
+---These are equivalent: <pre>lua
+---    vim.opt.formatoptions:append('j')
+---    vim.opt.formatoptions = vim.opt.formatoptions + 'j'
+---</pre>
+---@param value string Value to append
+--- @diagnostic disable-next-line:unused-local used for gen_vimdoc
+function Option:append(value) end
+
+---Prepend a value to string-style options. See |:set^=|
+---
+---These are equivalent: <pre>lua
+---    vim.opt.wildignore:prepend('*.o')
+---    vim.opt.wildignore = vim.opt.wildignore ^ '*.o'
+---</pre>
+---@param value string Value to prepend
+---@diagnostic disable-next-line:unused-local used for gen_vimdoc
+function Option:prepend(value) end
+
+---Remove a value from string-style options. See |:set-=|
+---
+---These are equivalent: <pre>lua
+---    vim.opt.wildignore:remove('*.pyc')
+---    vim.opt.wildignore = vim.opt.wildignore - '*.pyc'
+---</pre>
+---@param value string Value to remove
+---@diagnostic disable-next-line:unused-local used for gen_vimdoc
+function Option:remove(value) end
+
 vim.opt = create_option_accessor()
 vim.opt_local = create_option_accessor('local')
 vim.opt_global = create_option_accessor('global')
diff --git a/runtime/lua/vim/highlight.lua b/runtime/lua/vim/highlight.lua
index 86e1adb49e..97a5a1233f 100644
--- a/runtime/lua/vim/highlight.lua
+++ b/runtime/lua/vim/highlight.lua
@@ -1,3 +1,36 @@
+---@defgroup lua-highlight
+---
+---@brief
+---Nvim includes a function for highlighting a selection on yank.
+---
+---To enable it, add the following to your `init.vim`:
+---<pre>vim
+---    au TextYankPost * silent! lua vim.highlight.on_yank()
+---</pre>
+---
+---You can customize the highlight group and the duration of
+---the highlight via:
+---<pre>vim
+---    au TextYankPost * silent! lua vim.highlight.on_yank {higroup="IncSearch", timeout=150}
+---</pre>
+---
+---If you want to exclude visual selections from highlighting on yank, use:
+---<pre>vim
+---    au TextYankPost * silent! lua vim.highlight.on_yank {on_visual=false}
+---</pre>
+---
+--- <pre>help
+---vim.highlight.priorities                            *vim.highlight.priorities*
+---
+---    Table with default priorities used for highlighting:
+---        • `syntax`: `50`, used for standard syntax highlighting
+---        • `treesitter`: `100`, used for tree-sitter-based highlighting
+---        • `semantic_tokens`: `125`, used for LSP semantic token highlighting
+---        • `diagnostics`: `150`, used for code analysis such as diagnostics
+---        • `user`: `200`, used for user-triggered highlights such as LSP document
+---          symbols or `on_yank` autocommands
+---</pre>
+
 local api = vim.api
 
 local M = {}
@@ -10,7 +43,7 @@ M.priorities = {
   user = 200,
 }
 
---- Highlight range between two positions
+--- Apply highlight group to range of text.
 ---
 ---@param bufnr integer Buffer number to apply highlighting to
 ---@param ns integer Namespace to add highlight to
@@ -18,9 +51,9 @@ M.priorities = {
 ---@param start integer[]|string Start of region as a (line, column) tuple or string accepted by |getpos()|
 ---@param finish integer[]|string End of region as a (line, column) tuple or string accepted by |getpos()|
 ---@param opts table|nil Optional parameters
---             - regtype type of range (see |setreg()|, default charwise)
---             - inclusive boolean indicating whether the range is end-inclusive (default false)
---             - priority number indicating priority of highlight (default priorities.user)
+---            - regtype type of range (see |setreg()|, default charwise)
+---            - inclusive boolean indicating whether the range is end-inclusive (default false)
+---            - priority number indicating priority of highlight (default priorities.user)
 function M.range(bufnr, ns, higroup, start, finish, opts)
   opts = opts or {}
   local regtype = opts.regtype or 'v'
@@ -46,22 +79,16 @@ end
 
 local yank_ns = api.nvim_create_namespace('hlyank')
 local yank_timer
---- Highlight the yanked region
----
---- use from init.vim via
----   au TextYankPost * lua vim.highlight.on_yank()
---- customize highlight group and timeout via
----   au TextYankPost * lua vim.highlight.on_yank {higroup="IncSearch", timeout=150}
---- customize conditions (here: do not highlight a visual selection) via
----   au TextYankPost * lua vim.highlight.on_yank {on_visual=false}
+
+--- Highlight the yanked text
 ---
--- @param opts table|nil Optional parameters
---              - higroup   highlight group for yanked region (default "IncSearch")
---              - timeout   time in ms before highlight is cleared (default 150)
---              - on_macro  highlight when executing macro (default false)
---              - on_visual highlight when yanking visual selection (default true)
---              - event     event structure (default vim.v.event)
---              - priority  integer priority (default |vim.highlight.priorities|`.user`)
+--- @param opts table|nil Optional parameters
+---              - higroup   highlight group for yanked region (default "IncSearch")
+---              - timeout   time in ms before highlight is cleared (default 150)
+---              - on_macro  highlight when executing macro (default false)
+---              - on_visual highlight when yanking visual selection (default true)
+---              - event     event structure (default vim.v.event)
+---              - priority  integer priority (default |vim.highlight.priorities|`.user`)
 function M.on_yank(opts)
   vim.validate({
     opts = {
-- 
cgit 


From c2d7c2826ca77b0ca31bec511fdcdf1e4abaf946 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 17 Jul 2023 15:13:54 +0100
Subject: docs(lua): change *lua-foo* -> *vim.foo*

---
 runtime/lua/vim/_meta/builtin.lua | 2 +-
 runtime/lua/vim/_meta/json.lua    | 4 ++--
 runtime/lua/vim/_meta/mpack.lua   | 4 ++--
 runtime/lua/vim/_meta/regex.lua   | 2 +-
 runtime/lua/vim/highlight.lua     | 2 +-
 runtime/lua/vim/iter.lua          | 4 ++--
 runtime/lua/vim/version.lua       | 2 +-
 7 files changed, 10 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/builtin.lua b/runtime/lua/vim/_meta/builtin.lua
index 384dd4351d..a1786b2cdb 100644
--- a/runtime/lua/vim/_meta/builtin.lua
+++ b/runtime/lua/vim/_meta/builtin.lua
@@ -1,6 +1,6 @@
 ---@meta
 
----@defgroup lua-builtin
+---@defgroup vim.builtin
 ---
 ---@brief <pre>help
 ---vim.api.{func}({...})                                                    *vim.api*
diff --git a/runtime/lua/vim/_meta/json.lua b/runtime/lua/vim/_meta/json.lua
index 15e81d5004..2580b56870 100644
--- a/runtime/lua/vim/_meta/json.lua
+++ b/runtime/lua/vim/_meta/json.lua
@@ -1,8 +1,8 @@
 --- @meta
 
---- @defgroup lua-json
+--- @defgroup vim.json
 ---
---- @brief The \*vim.json\* module provides encoding and decoding of Lua objects to and
+--- This module provides encoding and decoding of Lua objects to and
 --- from JSON-encoded strings. Supports |vim.NIL| and |vim.empty_dict()|.
 
 --- Decodes (or "unpacks") the JSON-encoded {str} to a Lua object.
diff --git a/runtime/lua/vim/_meta/mpack.lua b/runtime/lua/vim/_meta/mpack.lua
index 2764177e5c..1bcb6845b9 100644
--- a/runtime/lua/vim/_meta/mpack.lua
+++ b/runtime/lua/vim/_meta/mpack.lua
@@ -1,8 +1,8 @@
 --- @meta
 
---- @defgroup lua-mpack
+--- @defgroup vim.mpack
 ---
---- @brief The \*vim.mpack\* module provides encoding and decoding of Lua objects to and
+--- This module provides encoding and decoding of Lua objects to and
 --- from msgpack-encoded strings. Supports |vim.NIL| and |vim.empty_dict()|.
 
 --- Decodes (or "unpacks") the msgpack-encoded {str} to a Lua object.
diff --git a/runtime/lua/vim/_meta/regex.lua b/runtime/lua/vim/_meta/regex.lua
index afa78772da..0af1bccea5 100644
--- a/runtime/lua/vim/_meta/regex.lua
+++ b/runtime/lua/vim/_meta/regex.lua
@@ -1,6 +1,6 @@
 --- @meta
 
---- @defgroup lua-regex
+--- @defgroup vim.regex
 ---
 --- @brief Vim regexes can be used directly from Lua. Currently they only allow
 --- matching within a single line.
diff --git a/runtime/lua/vim/highlight.lua b/runtime/lua/vim/highlight.lua
index 97a5a1233f..0eb782339c 100644
--- a/runtime/lua/vim/highlight.lua
+++ b/runtime/lua/vim/highlight.lua
@@ -1,4 +1,4 @@
----@defgroup lua-highlight
+---@defgroup vim.highlight
 ---
 ---@brief
 ---Nvim includes a function for highlighting a selection on yank.
diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index 245a33625e..6c1afcad91 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -1,6 +1,6 @@
----@defgroup lua-iter
+---@defgroup vim.iter
 ---
---- @brief The \*vim.iter\* module provides a generic interface for working with
+--- This module provides a generic interface for working with
 --- iterables: tables, lists, iterator functions, pair()/ipair()-like iterators,
 --- and \`vim.iter()\` objects.
 ---
diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index cd28a9b54b..8ff8a19cb9 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -1,4 +1,4 @@
---- @defgroup lua-version
+--- @defgroup vim.version
 ---
 --- @brief The \`vim.version\` module provides functions for comparing versions and ranges
 --- conforming to the https://semver.org spec. Plugins, and plugin managers, can use this to check
-- 
cgit 


From 69d49727d7766d799aa1989bf67e763258b868e6 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 17 Jul 2023 16:32:56 +0100
Subject: fix: luacheck

---
 runtime/lua/vim/_meta/builtin.lua | 2 ++
 runtime/lua/vim/_meta/diff.lua    | 2 ++
 runtime/lua/vim/_meta/json.lua    | 2 ++
 runtime/lua/vim/_meta/misc.lua    | 2 ++
 runtime/lua/vim/_meta/mpack.lua   | 2 ++
 runtime/lua/vim/_meta/regex.lua   | 4 +++-
 runtime/lua/vim/_meta/spell.lua   | 2 ++
 runtime/lua/vim/_options.lua      | 8 ++++----
 8 files changed, 19 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/builtin.lua b/runtime/lua/vim/_meta/builtin.lua
index a1786b2cdb..1d7b1071b7 100644
--- a/runtime/lua/vim/_meta/builtin.lua
+++ b/runtime/lua/vim/_meta/builtin.lua
@@ -1,5 +1,7 @@
 ---@meta
 
+-- luacheck: no unused args
+
 ---@defgroup vim.builtin
 ---
 ---@brief <pre>help
diff --git a/runtime/lua/vim/_meta/diff.lua b/runtime/lua/vim/_meta/diff.lua
index 8e8aaf8b64..246ac0c75a 100644
--- a/runtime/lua/vim/_meta/diff.lua
+++ b/runtime/lua/vim/_meta/diff.lua
@@ -1,5 +1,7 @@
 ---@meta
 
+-- luacheck: no unused args
+
 --- Run diff on strings {a} and {b}. Any indices returned by this function,
 --- either directly or via callback arguments, are 1-based.
 ---
diff --git a/runtime/lua/vim/_meta/json.lua b/runtime/lua/vim/_meta/json.lua
index 2580b56870..76a6c7b733 100644
--- a/runtime/lua/vim/_meta/json.lua
+++ b/runtime/lua/vim/_meta/json.lua
@@ -1,5 +1,7 @@
 --- @meta
 
+-- luacheck: no unused args
+
 --- @defgroup vim.json
 ---
 --- This module provides encoding and decoding of Lua objects to and
diff --git a/runtime/lua/vim/_meta/misc.lua b/runtime/lua/vim/_meta/misc.lua
index 954e8b4675..8a76755962 100644
--- a/runtime/lua/vim/_meta/misc.lua
+++ b/runtime/lua/vim/_meta/misc.lua
@@ -1,5 +1,7 @@
 ---@meta
 
+-- luacheck: no unused args
+
 --- Invokes |vim-function| or |user-function| {func} with arguments {...}.
 --- See also |vim.fn|.
 --- Equivalent to:
diff --git a/runtime/lua/vim/_meta/mpack.lua b/runtime/lua/vim/_meta/mpack.lua
index 1bcb6845b9..54e097ad97 100644
--- a/runtime/lua/vim/_meta/mpack.lua
+++ b/runtime/lua/vim/_meta/mpack.lua
@@ -1,5 +1,7 @@
 --- @meta
 
+-- luacheck: no unused args
+
 --- @defgroup vim.mpack
 ---
 --- This module provides encoding and decoding of Lua objects to and
diff --git a/runtime/lua/vim/_meta/regex.lua b/runtime/lua/vim/_meta/regex.lua
index 0af1bccea5..4bca67797a 100644
--- a/runtime/lua/vim/_meta/regex.lua
+++ b/runtime/lua/vim/_meta/regex.lua
@@ -1,5 +1,7 @@
 --- @meta
 
+-- luacheck: no unused args
+
 --- @defgroup vim.regex
 ---
 --- @brief Vim regexes can be used directly from Lua. Currently they only allow
@@ -13,7 +15,7 @@
 function vim.regex(re) end
 
 --- @class vim.regex
-local regex = {}
+local regex = {} -- luacheck: no unused
 
 --- Match the string against the regex. If the string should match the regex
 --- precisely, surround the regex with `^` and `$`. If the was a match, the
diff --git a/runtime/lua/vim/_meta/spell.lua b/runtime/lua/vim/_meta/spell.lua
index 926c8a686d..d55867f769 100644
--- a/runtime/lua/vim/_meta/spell.lua
+++ b/runtime/lua/vim/_meta/spell.lua
@@ -1,5 +1,7 @@
 --- @meta
 
+-- luacheck: no unused args
+
 --- Check {str} for spelling errors. Similar to the Vimscript function
 --- |spellbadword()|.
 ---
diff --git a/runtime/lua/vim/_options.lua b/runtime/lua/vim/_options.lua
index d498ae0a2c..6dbe4cf64a 100644
--- a/runtime/lua/vim/_options.lua
+++ b/runtime/lua/vim/_options.lua
@@ -846,7 +846,7 @@ end
 ---</pre>
 
 --- @diagnostic disable-next-line:unused-local used for gen_vimdoc
-local Option = {}
+local Option = {} -- luacheck: no unused
 
 ---Returns a Lua-representation of the option. Boolean, number and string
 ---values will be returned in exactly the same fashion.
@@ -901,7 +901,7 @@ function Option:get() end
 ---</pre>
 ---@param value string Value to append
 --- @diagnostic disable-next-line:unused-local used for gen_vimdoc
-function Option:append(value) end
+function Option:append(value) end -- luacheck: no unused
 
 ---Prepend a value to string-style options. See |:set^=|
 ---
@@ -911,7 +911,7 @@ function Option:append(value) end
 ---</pre>
 ---@param value string Value to prepend
 ---@diagnostic disable-next-line:unused-local used for gen_vimdoc
-function Option:prepend(value) end
+function Option:prepend(value) end -- luacheck: no unused
 
 ---Remove a value from string-style options. See |:set-=|
 ---
@@ -921,7 +921,7 @@ function Option:prepend(value) end
 ---</pre>
 ---@param value string Value to remove
 ---@diagnostic disable-next-line:unused-local used for gen_vimdoc
-function Option:remove(value) end
+function Option:remove(value) end -- luacheck: no unused
 
 vim.opt = create_option_accessor()
 vim.opt_local = create_option_accessor('local')
-- 
cgit 


From 6e9b204afbe5f16c44a2697aed07aafff36bf856 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 17 Jul 2023 16:39:57 +0100
Subject: fix: doc errors

---
 runtime/lua/vim/_meta/builtin.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/builtin.lua b/runtime/lua/vim/_meta/builtin.lua
index 1d7b1071b7..980e40d61b 100644
--- a/runtime/lua/vim/_meta/builtin.lua
+++ b/runtime/lua/vim/_meta/builtin.lua
@@ -141,7 +141,7 @@ function vim.str_utfindex(str, index) end
 --- @param str string Text to convert
 --- @param from number Encoding of {str}
 --- @param to number Target encoding
---- @param opts? table<string, any>
+--- @param opts? table<string,any>
 --- @return string|nil Converted string if conversion succeeds, `nil` otherwise.
 function vim.iconv(str, from, to, opts) end
 
-- 
cgit 


From 1b9ccd38a12f8fdbdff51ef0b3ff363540f745ec Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Mon, 17 Jul 2023 18:27:16 +0200
Subject: feat(lsp)!: rename vim.lsp.get_active_clients to get_clients (#24113)

---
 runtime/lua/vim/lsp.lua        | 45 ++++++++++++++++++++++++------------------
 runtime/lua/vim/lsp/buf.lua    | 11 +++++------
 runtime/lua/vim/lsp/health.lua |  2 +-
 runtime/lua/vim/lsp/util.lua   |  8 ++++----
 4 files changed, 36 insertions(+), 30 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index e9a1423d2d..97aab45f2c 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -612,7 +612,7 @@ do
   ---@private
   function changetracking.send_changes(bufnr, firstline, lastline, new_lastline)
     local groups = {} ---@type table<string,CTGroup>
-    for _, client in pairs(lsp.get_active_clients({ bufnr = bufnr })) do
+    for _, client in pairs(lsp.get_clients({ bufnr = bufnr })) do
       local group = get_group(client)
       groups[group_key(group)] = group
     end
@@ -734,7 +734,7 @@ end
 -- FIXME: DOC: Shouldn't need to use a dummy function
 --
 --- LSP client object. You can get an active client object via
---- |vim.lsp.get_client_by_id()| or |vim.lsp.get_active_clients()|.
+--- |vim.lsp.get_client_by_id()| or |vim.lsp.get_clients()|.
 ---
 --- - Methods:
 ---
@@ -880,7 +880,7 @@ function lsp.start(config, opts)
   if bufnr == nil or bufnr == 0 then
     bufnr = api.nvim_get_current_buf()
   end
-  for _, clients in ipairs({ uninitialized_clients, lsp.get_active_clients() }) do
+  for _, clients in ipairs({ uninitialized_clients, lsp.get_clients() }) do
     for _, client in pairs(clients) do
       if reuse_client(client, config) then
         lsp.buf_attach_client(bufnr, client.id)
@@ -903,7 +903,7 @@ end
 function lsp.status()
   local percentage = nil
   local messages = {}
-  for _, client in ipairs(vim.lsp.get_active_clients()) do
+  for _, client in ipairs(vim.lsp.get_clients()) do
     for progress in client.progress do
       local value = progress.value
       if type(value) == 'table' and value.kind then
@@ -1755,7 +1755,7 @@ local function text_document_did_save_handler(bufnr)
   bufnr = resolve_bufnr(bufnr)
   local uri = vim.uri_from_bufnr(bufnr)
   local text = once(buf_get_full_text)
-  for _, client in ipairs(lsp.get_active_clients({ bufnr = bufnr })) do
+  for _, client in ipairs(lsp.get_clients({ bufnr = bufnr })) do
     local name = api.nvim_buf_get_name(bufnr)
     local old_name = changetracking._get_and_set_name(client, bufnr, name)
     if old_name and name ~= old_name then
@@ -1823,7 +1823,7 @@ function lsp.buf_attach_client(bufnr, client_id)
       buffer = bufnr,
       desc = 'vim.lsp: textDocument/willSave',
       callback = function(ctx)
-        for _, client in ipairs(lsp.get_active_clients({ bufnr = ctx.buf })) do
+        for _, client in ipairs(lsp.get_clients({ bufnr = ctx.buf })) do
           local params = {
             textDocument = {
               uri = uri,
@@ -1858,7 +1858,7 @@ function lsp.buf_attach_client(bufnr, client_id)
       on_lines = text_document_did_change_handler,
       on_reload = function()
         local params = { textDocument = { uri = uri } }
-        for _, client in ipairs(lsp.get_active_clients({ bufnr = bufnr })) do
+        for _, client in ipairs(lsp.get_clients({ bufnr = bufnr })) do
           changetracking.reset_buf(client, bufnr)
           if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
             client.notify('textDocument/didClose', params)
@@ -1868,7 +1868,7 @@ function lsp.buf_attach_client(bufnr, client_id)
       end,
       on_detach = function()
         local params = { textDocument = { uri = uri } }
-        for _, client in ipairs(lsp.get_active_clients({ bufnr = bufnr })) do
+        for _, client in ipairs(lsp.get_clients({ bufnr = bufnr })) do
           changetracking.reset_buf(client, bufnr)
           if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
             client.notify('textDocument/didClose', params)
@@ -1985,7 +1985,7 @@ end
 --- You can also use the `stop()` function on a |vim.lsp.client| object.
 --- To stop all clients:
 --- <pre>lua
---- vim.lsp.stop_client(vim.lsp.get_active_clients())
+--- vim.lsp.stop_client(vim.lsp.get_clients())
 --- </pre>
 ---
 --- By default asks the server to shutdown, unless stop was requested
@@ -2006,7 +2006,7 @@ function lsp.stop_client(client_id, force)
   end
 end
 
----@class vim.lsp.get_active_clients.filter
+---@class vim.lsp.get_clients.filter
 ---@field id integer|nil Match clients by id
 ---@field bufnr integer|nil match clients attached to the given buffer
 ---@field name string|nil match clients by name
@@ -2014,7 +2014,7 @@ end
 
 --- Get active clients.
 ---
----@param filter vim.lsp.get_active_clients.filter|nil (table|nil) A table with
+---@param filter vim.lsp.get_clients.filter|nil (table|nil) A table with
 ---              key-value pairs used to filter the returned clients.
 ---              The available keys are:
 ---               - id (number): Only return clients with the given id
@@ -2022,7 +2022,7 @@ end
 ---               - name (string): Only return clients with the given name
 ---               - method (string): Only return clients supporting the given method
 ---@return lsp.Client[]: List of |vim.lsp.client| objects
-function lsp.get_active_clients(filter)
+function lsp.get_clients(filter)
   validate({ filter = { filter, 't', true } })
 
   filter = filter or {}
@@ -2045,6 +2045,13 @@ function lsp.get_active_clients(filter)
   return clients
 end
 
+---@private
+---@deprecated
+function lsp.get_active_clients(filter)
+  -- TODO: add vim.deprecate call after 0.10 is out for removal in 0.12
+  return lsp.get_clients(filter)
+end
+
 api.nvim_create_autocmd('VimLeavePre', {
   desc = 'vim.lsp: exit handler',
   callback = function()
@@ -2125,7 +2132,7 @@ function lsp.buf_request(bufnr, method, params, handler)
 
   bufnr = resolve_bufnr(bufnr)
   local method_supported = false
-  local clients = lsp.get_active_clients({ bufnr = bufnr })
+  local clients = lsp.get_clients({ bufnr = bufnr })
   local client_request_ids = {}
   for _, client in ipairs(clients) do
     if client.supports_method(method, { bufnr = bufnr }) then
@@ -2173,7 +2180,7 @@ function lsp.buf_request_all(bufnr, method, params, handler)
   local expected_result_count = 0
 
   local set_expected_result_count = once(function()
-    for _, client in ipairs(lsp.get_active_clients({ bufnr = bufnr })) do
+    for _, client in ipairs(lsp.get_clients({ bufnr = bufnr })) do
       if client.supports_method(method, { bufnr = bufnr }) then
         expected_result_count = expected_result_count + 1
       end
@@ -2240,7 +2247,7 @@ function lsp.buf_notify(bufnr, method, params)
     method = { method, 's' },
   })
   local resp = false
-  for _, client in ipairs(lsp.get_active_clients({ bufnr = bufnr })) do
+  for _, client in ipairs(lsp.get_clients({ bufnr = bufnr })) do
     if client.rpc.notify(method, params) then
       resp = true
     end
@@ -2367,7 +2374,7 @@ function lsp.formatexpr(opts)
     return 0
   end
   local bufnr = api.nvim_get_current_buf()
-  for _, client in pairs(lsp.get_active_clients({ bufnr = bufnr })) do
+  for _, client in pairs(lsp.get_clients({ bufnr = bufnr })) do
     if client.supports_method('textDocument/rangeFormatting') then
       local params = util.make_formatting_params()
       local end_line = vim.fn.getline(end_lnum) --[[@as string]]
@@ -2424,10 +2431,10 @@ end
 ---
 ---@param bufnr (integer|nil): Buffer handle, or 0 for current
 ---@return table result is table of (client_id, client) pairs
----@deprecated Use |vim.lsp.get_active_clients()| instead.
+---@deprecated Use |vim.lsp.get_clients()| instead.
 function lsp.buf_get_clients(bufnr)
   local result = {}
-  for _, client in ipairs(lsp.get_active_clients({ bufnr = resolve_bufnr(bufnr) })) do
+  for _, client in ipairs(lsp.get_clients({ bufnr = resolve_bufnr(bufnr) })) do
     result[client.id] = client
   end
   return result
@@ -2478,7 +2485,7 @@ end
 ---                 vim.print(client)
 ---               end)
 ---             </pre>
----@deprecated use lsp.get_active_clients({ bufnr = bufnr }) with regular loop
+---@deprecated use lsp.get_clients({ bufnr = bufnr }) with regular loop
 function lsp.for_each_buffer_client(bufnr, fn)
   return for_each_buffer_client(bufnr, fn)
 end
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index b238b5c221..2140d3ae37 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -197,7 +197,6 @@ end
 function M.format(options)
   options = options or {}
   local bufnr = options.bufnr or api.nvim_get_current_buf()
-
   local mode = api.nvim_get_mode().mode
   local range = options.range
   if not range and mode == 'v' or mode == 'V' then
@@ -205,7 +204,7 @@ function M.format(options)
   end
   local method = range and 'textDocument/rangeFormatting' or 'textDocument/formatting'
 
-  local clients = vim.lsp.get_active_clients({
+  local clients = vim.lsp.get_clients({
     id = options.id,
     bufnr = bufnr,
     name = options.name,
@@ -271,7 +270,7 @@ end
 function M.rename(new_name, options)
   options = options or {}
   local bufnr = options.bufnr or api.nvim_get_current_buf()
-  local clients = vim.lsp.get_active_clients({
+  local clients = vim.lsp.get_clients({
     bufnr = bufnr,
     name = options.name,
     -- Clients must at least support rename, prepareRename is optional
@@ -468,7 +467,7 @@ end
 ---
 function M.list_workspace_folders()
   local workspace_folders = {}
-  for _, client in pairs(vim.lsp.get_active_clients({ bufnr = 0 })) do
+  for _, client in pairs(vim.lsp.get_clients({ bufnr = 0 })) do
     for _, folder in pairs(client.workspace_folders or {}) do
       table.insert(workspace_folders, folder.name)
     end
@@ -493,7 +492,7 @@ function M.add_workspace_folder(workspace_folder)
     { { uri = vim.uri_from_fname(workspace_folder), name = workspace_folder } },
     {}
   )
-  for _, client in pairs(vim.lsp.get_active_clients({ bufnr = 0 })) do
+  for _, client in pairs(vim.lsp.get_clients({ bufnr = 0 })) do
     local found = false
     for _, folder in pairs(client.workspace_folders or {}) do
       if folder.name == workspace_folder then
@@ -526,7 +525,7 @@ function M.remove_workspace_folder(workspace_folder)
     { {} },
     { { uri = vim.uri_from_fname(workspace_folder), name = workspace_folder } }
   )
-  for _, client in pairs(vim.lsp.get_active_clients({ bufnr = 0 })) do
+  for _, client in pairs(vim.lsp.get_clients({ bufnr = 0 })) do
     for idx, folder in pairs(client.workspace_folders or {}) do
       if folder.name == workspace_folder then
         vim.lsp.buf_notify(0, 'workspace/didChangeWorkspaceFolders', params)
diff --git a/runtime/lua/vim/lsp/health.lua b/runtime/lua/vim/lsp/health.lua
index 8817bb71de..023b1c26be 100644
--- a/runtime/lua/vim/lsp/health.lua
+++ b/runtime/lua/vim/lsp/health.lua
@@ -28,7 +28,7 @@ function M.check()
   local report_fn = (log_size / 1000000 > 100 and report_warn or report_info)
   report_fn(string.format('Log size: %d KB', log_size / 1000))
 
-  local clients = vim.lsp.get_active_clients()
+  local clients = vim.lsp.get_clients()
   vim.health.start('vim.lsp: Active Clients')
   if next(clients) then
     for _, client in pairs(clients) do
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 0da88f800e..59b9916f64 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -360,7 +360,7 @@ function M.get_progress_messages()
   local new_messages = {}
   local progress_remove = {}
 
-  for _, client in ipairs(vim.lsp.get_active_clients()) do
+  for _, client in ipairs(vim.lsp.get_clients()) do
     local groups = {}
     for progress in client.progress do
       local value = progress.value
@@ -1841,7 +1841,7 @@ function M.locations_to_items(locations, offset_encoding)
       'locations_to_items must be called with valid offset encoding',
       vim.log.levels.WARN
     )
-    offset_encoding = vim.lsp.get_active_clients({ bufnr = 0 })[1].offset_encoding
+    offset_encoding = vim.lsp.get_clients({ bufnr = 0 })[1].offset_encoding
   end
 
   local items = {}
@@ -2036,7 +2036,7 @@ function M._get_offset_encoding(bufnr)
 
   local offset_encoding
 
-  for _, client in pairs(vim.lsp.get_active_clients({ bufnr = bufnr })) do
+  for _, client in pairs(vim.lsp.get_clients({ bufnr = bufnr })) do
     if client.offset_encoding == nil then
       vim.notify_once(
         string.format(
@@ -2183,7 +2183,7 @@ function M.character_offset(buf, row, col, offset_encoding)
       'character_offset must be called with valid offset encoding',
       vim.log.levels.WARN
     )
-    offset_encoding = vim.lsp.get_active_clients({ bufnr = buf })[1].offset_encoding
+    offset_encoding = vim.lsp.get_clients({ bufnr = buf })[1].offset_encoding
   end
   -- If the col is past the EOL, use the line length.
   if col > #line then
-- 
cgit 


From e4da418ba8388e94bb186e3f9a2004ee1e96f1e5 Mon Sep 17 00:00:00 2001
From: Mike <4576770+mike325@users.noreply.github.com>
Date: Tue, 18 Jul 2023 08:36:04 +0200
Subject: fix(fs.lua): normalize slash truncation (#23753)

Preserve last slash in windows' root drive directories
---
 runtime/lua/vim/fs.lua | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index 48d76e5d7e..d06dcb87cf 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -348,7 +348,11 @@ function M.normalize(path, opts)
     path = path:gsub('%$([%w_]+)', vim.uv.os_getenv)
   end
 
-  return (path:gsub('\\', '/'):gsub('/+', '/'):gsub('(.)/$', '%1'))
+  path = path:gsub('\\', '/'):gsub('/+', '/')
+  if iswin and path:match('^%w:/$') then
+    return path
+  end
+  return (path:gsub('(.)/$', '%1'))
 end
 
 return M
-- 
cgit 


From be74807eef13ff8c90d55cf8b22b01d6d33b1641 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 18 Jul 2023 15:42:30 +0100
Subject: docs(lua): more improvements (#24387)

* docs(lua): teach lua2dox how to table

* docs(lua): teach gen_vimdoc.py about local functions

No more need to mark local functions with @private

* docs(lua): mention @nodoc and @meta in dev-lua-doc

* fixup!

Co-authored-by: Justin M. Keyes <justinkz@gmail.com>

---------

Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
---
 runtime/lua/vim/_editor.lua                 |  20 ++--
 runtime/lua/vim/_inspector.lua              |   6 --
 runtime/lua/vim/_options.lua                | 142 ++++++++++++----------------
 runtime/lua/vim/_system.lua                 |   3 -
 runtime/lua/vim/_watch.lua                  |   3 -
 runtime/lua/vim/diagnostic.lua              |  24 -----
 runtime/lua/vim/filetype.lua                |   5 -
 runtime/lua/vim/fs.lua                      |   1 -
 runtime/lua/vim/highlight.lua               |  19 ++--
 runtime/lua/vim/iter.lua                    |  12 ---
 runtime/lua/vim/loader.lua                  |   8 +-
 runtime/lua/vim/lsp.lua                     |  44 +++------
 runtime/lua/vim/lsp/_watchfiles.lua         |   1 -
 runtime/lua/vim/lsp/buf.lua                 |  14 ---
 runtime/lua/vim/lsp/codelens.lua            |   4 -
 runtime/lua/vim/lsp/diagnostic.lua          |   9 +-
 runtime/lua/vim/lsp/handlers.lua            |   3 -
 runtime/lua/vim/lsp/inlay_hint.lua          |   9 --
 runtime/lua/vim/lsp/log.lua                 |  17 ++--
 runtime/lua/vim/lsp/rpc.lua                 |  68 ++++++-------
 runtime/lua/vim/lsp/semantic_tokens.lua     |   7 --
 runtime/lua/vim/lsp/sync.lua                |   7 --
 runtime/lua/vim/lsp/tagfunc.lua             |   4 -
 runtime/lua/vim/lsp/util.lua                |  25 +----
 runtime/lua/vim/secure.lua                  |   2 -
 runtime/lua/vim/shared.lua                  |  83 ++++++++--------
 runtime/lua/vim/treesitter.lua              |   8 +-
 runtime/lua/vim/treesitter/dev.lua          |   2 -
 runtime/lua/vim/treesitter/highlighter.lua  |   2 +-
 runtime/lua/vim/treesitter/language.lua     |   1 -
 runtime/lua/vim/treesitter/languagetree.lua |   5 -
 runtime/lua/vim/treesitter/query.lua        |   9 --
 runtime/lua/vim/uri.lua                     |  24 ++---
 runtime/lua/vim/version.lua                 |   3 -
 34 files changed, 178 insertions(+), 416 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index bb0aa97a0d..4372aef7b3 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -54,6 +54,7 @@ vim._extra = {
   inspect_pos = true,
 }
 
+--- @private
 vim.log = {
   levels = {
     TRACE = 0,
@@ -187,9 +188,7 @@ end
 ---@see |vim.print()|
 ---@see https://github.com/kikito/inspect.lua
 ---@see https://github.com/mpeterv/vinspect
-local function inspect(object, options) -- luacheck: no unused
-  error(object, options) -- Stub for gen_vimdoc.py
-end
+vim.inspect = vim.inspect
 
 do
   local tdots, tick, got_line1, undo_started, trailing_nl = 0, 0, false, false, false
@@ -328,6 +327,7 @@ function vim.schedule_wrap(cb)
 end
 
 -- vim.fn.{func}(...)
+---@private
 vim.fn = setmetatable({}, {
   __index = function(t, key)
     local _fn
@@ -345,10 +345,13 @@ vim.fn = setmetatable({}, {
   end,
 })
 
+--- @private
 vim.funcref = function(viml_func_name)
   return vim.fn[viml_func_name]
 end
 
+local VIM_CMD_ARG_MAX = 20
+
 --- Execute Vim script commands.
 ---
 --- Note that `vim.cmd` can be indexed with a command name to return a callable function to the
@@ -389,12 +392,6 @@ end
 ---                            If a table, executes a single command. In this case, it is an alias
 ---                            to |nvim_cmd()| where `opts` is empty.
 ---@see |ex-cmd-index|
-function vim.cmd(command) -- luacheck: no unused
-  error(command) -- Stub for gen_vimdoc.py
-end
-
-local VIM_CMD_ARG_MAX = 20
-
 vim.cmd = setmetatable({}, {
   __call = function(_, command)
     if type(command) == 'table' then
@@ -435,7 +432,6 @@ vim.cmd = setmetatable({}, {
 do
   local validate = vim.validate
 
-  ---@private
   local function make_dict_accessor(scope, handle)
     validate({
       scope = { scope, 's' },
@@ -745,7 +741,6 @@ function vim._expand_pat(pat, env)
   end
 
   local keys = {}
-  ---@private
   local function insert_keys(obj)
     for k, _ in pairs(obj) do
       if type(k) == 'string' and string.sub(k, 1, string.len(match_part)) == match_part then
@@ -1008,7 +1003,6 @@ end
 function vim._init_default_mappings()
   -- mappings
 
-  ---@private
   local function region_chunks(region)
     local chunks = {}
     local maxcol = vim.v.maxcol
@@ -1020,7 +1014,6 @@ function vim._init_default_mappings()
     return chunks
   end
 
-  ---@private
   local function _visual_search(cmd)
     assert(cmd == '/' or cmd == '?')
     vim.api.nvim_feedkeys('\27', 'nx', true) -- Escape visual mode.
@@ -1037,7 +1030,6 @@ function vim._init_default_mappings()
     vim.api.nvim_feedkeys(search_cmd, 'nx', true)
   end
 
-  ---@private
   local function map(mode, lhs, rhs)
     vim.keymap.set(mode, lhs, rhs, { desc = 'Nvim builtin' })
   end
diff --git a/runtime/lua/vim/_inspector.lua b/runtime/lua/vim/_inspector.lua
index ecd39c35bc..3f7b9d2c23 100644
--- a/runtime/lua/vim/_inspector.lua
+++ b/runtime/lua/vim/_inspector.lua
@@ -56,7 +56,6 @@ function vim.inspect_pos(bufnr, row, col, filter)
   }
 
   -- resolve hl links
-  ---@private
   local function resolve_hl(data)
     if data.hl_group then
       local hlid = vim.api.nvim_get_hl_id_by_name(data.hl_group)
@@ -91,7 +90,6 @@ function vim.inspect_pos(bufnr, row, col, filter)
   end
 
   --- Convert an extmark tuple into a table
-  --- @private
   local function to_map(extmark)
     extmark = {
       id = extmark[1],
@@ -107,7 +105,6 @@ function vim.inspect_pos(bufnr, row, col, filter)
   end
 
   --- Check if an extmark overlaps this position
-  --- @private
   local function is_here(extmark)
     return (row >= extmark.row and row <= extmark.end_row) -- within the rows of the extmark
       and (row > extmark.row or col >= extmark.col) -- either not the first row, or in range of the col
@@ -148,17 +145,14 @@ function vim.show_pos(bufnr, row, col, filter)
 
   local lines = { {} }
 
-  ---@private
   local function append(str, hl)
     table.insert(lines[#lines], { str, hl })
   end
 
-  ---@private
   local function nl()
     table.insert(lines, {})
   end
 
-  ---@private
   local function item(data, comment)
     append('  - ')
     append(data.hl_group, data.hl_group)
diff --git a/runtime/lua/vim/_options.lua b/runtime/lua/vim/_options.lua
index 6dbe4cf64a..d54e8b447c 100644
--- a/runtime/lua/vim/_options.lua
+++ b/runtime/lua/vim/_options.lua
@@ -92,15 +92,6 @@
 ---vim.v                                                                  *vim.v*
 ---    |v:| variables.
 ---    Invalid or unset key returns `nil`.
----
----vim.env                                                              *vim.env*
----    Environment variables defined in the editor session.
----    See |expand-env| and |:let-environment| for the Vimscript behavior.
----    Invalid or unset key returns `nil`.
----    Example: >lua
----        vim.env.FOO = 'bar'
----        print(vim.env.TERM)
----<
 ---</pre>
 
 local api = vim.api
@@ -118,7 +109,6 @@ local key_value_options = {
 
 --- Convert a vimoption_T style dictionary to the correct OptionType associated with it.
 ---@return string
----@private
 local function get_option_metatype(name, info)
   if info.type == 'string' then
     if info.flaglist then
@@ -143,6 +133,14 @@ local options_info = setmetatable({}, {
   end,
 })
 
+---Environment variables defined in the editor session.
+---See |expand-env| and |:let-environment| for the Vimscript behavior.
+---Invalid or unset key returns `nil`.
+---Example: <pre>lua
+---    vim.env.FOO = 'bar'
+---    print(vim.env.TERM)
+---</pre>
+---@param var string
 vim.env = setmetatable({}, {
   __index = function(_, k)
     local v = vim.fn.getenv(k)
@@ -157,7 +155,6 @@ vim.env = setmetatable({}, {
   end,
 })
 
----@private
 local function opt_validate(option_name, target_scope)
   local scope = options_info[option_name].scope
   if scope ~= target_scope then
@@ -174,7 +171,6 @@ local function opt_validate(option_name, target_scope)
   end
 end
 
----@private
 local function new_buf_opt_accessor(bufnr)
   return setmetatable({}, {
     __index = function(_, k)
@@ -192,7 +188,6 @@ local function new_buf_opt_accessor(bufnr)
   })
 end
 
----@private
 local function new_win_opt_accessor(winid, bufnr)
   return setmetatable({}, {
     __index = function(_, k)
@@ -253,19 +248,15 @@ end
 ---global value of a |global-local| option, see |:setglobal|.
 ---</pre>
 
----@addtogroup lua-vimscript
----@brief <pre>help
----vim.o                                                                  *vim.o*
----    Get or set |options|. Like `:set`. Invalid key is an error.
+---Get or set |options|. Like `:set`. Invalid key is an error.
 ---
----    Note: this works on both buffer-scoped and window-scoped options using the
----    current buffer and window.
+---Note: this works on both buffer-scoped and window-scoped options using the
+---current buffer and window.
 ---
----    Example: >lua
----        vim.o.cmdheight = 4
----        print(vim.o.columns)
----        print(vim.o.foo)     -- error: invalid key
----<
+---Example: <pre>lua
+---    vim.o.cmdheight = 4
+---    print(vim.o.columns)
+---    print(vim.o.foo)     -- error: invalid key
 ---</pre>
 vim.o = setmetatable({}, {
   __index = function(_, k)
@@ -276,21 +267,17 @@ vim.o = setmetatable({}, {
   end,
 })
 
----@addtogroup lua-vimscript
----@brief <pre>help
----vim.go                                                                *vim.go*
----    Get or set global |options|. Like `:setglobal`. Invalid key is
----    an error.
----
----    Note: this is different from |vim.o| because this accesses the global
----    option value and thus is mostly useful for use with |global-local|
----    options.
----
----    Example: >lua
----        vim.go.cmdheight = 4
----        print(vim.go.columns)
----        print(vim.go.bar)     -- error: invalid key
----<
+---Get or set global |options|. Like `:setglobal`. Invalid key is
+---an error.
+---
+---Note: this is different from |vim.o| because this accesses the global
+---option value and thus is mostly useful for use with |global-local|
+---options.
+---
+---Example: <pre>lua
+---    vim.go.cmdheight = 4
+---    print(vim.go.columns)
+---    print(vim.go.bar)     -- error: invalid key
 ---</pre>
 vim.go = setmetatable({}, {
   __index = function(_, k)
@@ -301,41 +288,36 @@ vim.go = setmetatable({}, {
   end,
 })
 
----@addtogroup lua-vimscript
----@brief <pre>help
----vim.bo[{bufnr}]                                                                *vim.bo*
----    Get or set buffer-scoped |options| for the buffer with number {bufnr}.
----    Like `:set` and `:setlocal`. If [{bufnr}] is omitted then the current
----    buffer is used. Invalid {bufnr} or key is an error.
----
----    Note: this is equivalent to both `:set` and `:setlocal`.
----
----    Example: >lua
----        local bufnr = vim.api.nvim_get_current_buf()
----        vim.bo[bufnr].buflisted = true    -- same as vim.bo.buflisted = true
----        print(vim.bo.comments)
----        print(vim.bo.baz)                 -- error: invalid key
+---Get or set buffer-scoped |options| for the buffer with number {bufnr}.
+---Like `:set` and `:setlocal`. If [{bufnr}] is omitted then the current
+---buffer is used. Invalid {bufnr} or key is an error.
+---
+---Note: this is equivalent to both `:set` and `:setlocal`.
+---
+---Example: <pre>lua
+---    local bufnr = vim.api.nvim_get_current_buf()
+---    vim.bo[bufnr].buflisted = true    -- same as vim.bo.buflisted = true
+---    print(vim.bo.comments)
+---    print(vim.bo.baz)                 -- error: invalid key
 ---</pre>
+---@param bufnr integer|nil
 vim.bo = new_buf_opt_accessor()
 
----@addtogroup lua-vimscript
----@brief <pre>help
----vim.wo[{winid}][{bufnr}]                                                       *vim.wo*
----    Get or set window-scoped |options| for the window with handle {winid} and
----    buffer with number {bufnr}. Like `:setlocal` if {bufnr} is provided, like
----    `:set` otherwise. If [{winid}] is omitted then the current window is
----    used. Invalid {winid}, {bufnr} or key is an error.
----
----    Note: only {bufnr} with value `0` (the current buffer in the window) is
----    supported.
----
----    Example: >lua
----        local winid = vim.api.nvim_get_current_win()
----        vim.wo[winid].number = true    -- same as vim.wo.number = true
----        print(vim.wo.foldmarker)
----        print(vim.wo.quux)             -- error: invalid key
----        vim.wo[winid][0].spell = false -- like ':setlocal nospell'
----<
+---Get or set window-scoped |options| for the window with handle {winid} and
+---buffer with number {bufnr}. Like `:setlocal` if {bufnr} is provided, like
+---`:set` otherwise. If [{winid}] is omitted then the current window is
+---used. Invalid {winid}, {bufnr} or key is an error.
+---
+---Note: only {bufnr} with value `0` (the current buffer in the window) is
+---supported.
+---
+---Example: <pre>lua
+---    local winid = vim.api.nvim_get_current_win()
+---    vim.wo[winid].number = true    -- same as vim.wo.number = true
+---    print(vim.wo.foldmarker)
+---    print(vim.wo.quux)             -- error: invalid key
+---    vim.wo[winid][0].spell = false -- like ':setlocal nospell'
+---
 ---</pre>
 vim.wo = new_win_opt_accessor()
 
@@ -348,7 +330,6 @@ vim.wo = new_win_opt_accessor()
 ---@brief ]]
 
 --- Preserves the order and does not mutate the original list
---- @private
 local function remove_duplicate_values(t)
   local result, seen = {}, {}
   for _, v in ipairs(t) do
@@ -364,7 +345,6 @@ end
 
 -- Check whether the OptionTypes is allowed for vim.opt
 -- If it does not match, throw an error which indicates which option causes the error.
---- @private
 local function assert_valid_value(name, value, types)
   local type_of_value = type(value)
   for _, valid_type in ipairs(types) do
@@ -383,17 +363,14 @@ local function assert_valid_value(name, value, types)
   )
 end
 
---- @private
 local function passthrough(_, x)
   return x
 end
 
---- @private
 local function tbl_merge(left, right)
   return vim.tbl_extend('force', left, right)
 end
 
---- @private
 local function tbl_remove(t, value)
   if type(value) == 'string' then
     t[value] = nil
@@ -475,7 +452,6 @@ local to_vim_value = {
 }
 
 --- Convert a Lua value to a vimoption_T value
---- @private
 local function convert_value_to_vim(name, info, value)
   if value == nil then
     return vim.NIL
@@ -591,7 +567,6 @@ local to_lua_value = {
 }
 
 --- Converts a vimoption_T style value to a Lua value
---- @private
 local function convert_value_to_lua(info, option_value)
   return to_lua_value[info.metatype](info, option_value)
 end
@@ -618,7 +593,6 @@ local prepend_methods = {
 }
 
 --- Handles the '^' operator
---- @private
 local function prepend_value(info, current, new)
   return prepend_methods[info.metatype](
     convert_value_to_lua(info, current),
@@ -648,7 +622,6 @@ local add_methods = {
 }
 
 --- Handles the '+' operator
---- @private
 local function add_value(info, current, new)
   return add_methods[info.metatype](
     convert_value_to_lua(info, current),
@@ -656,7 +629,6 @@ local function add_value(info, current, new)
   )
 end
 
---- @private
 local function remove_one_item(t, val)
   if vim.tbl_islist(t) then
     local remove_index = nil
@@ -700,16 +672,13 @@ local remove_methods = {
 }
 
 --- Handles the '-' operator
---- @private
 local function remove_value(info, current, new)
   return remove_methods[info.metatype](convert_value_to_lua(info, current), new)
 end
 
---- @private
 local function create_option_accessor(scope)
   local option_mt
 
-  --- @private
   local function make_option(name, value)
     local info = assert(options_info[name], 'Not a valid option name: ' .. name)
 
@@ -923,6 +892,11 @@ function Option:prepend(value) end -- luacheck: no unused
 ---@diagnostic disable-next-line:unused-local used for gen_vimdoc
 function Option:remove(value) end -- luacheck: no unused
 
+---@private
 vim.opt = create_option_accessor()
+
+---@private
 vim.opt_local = create_option_accessor('local')
+
+---@private
 vim.opt_global = create_option_accessor('global')
diff --git a/runtime/lua/vim/_system.lua b/runtime/lua/vim/_system.lua
index ff566866c0..e6dab90425 100644
--- a/runtime/lua/vim/_system.lua
+++ b/runtime/lua/vim/_system.lua
@@ -30,7 +30,6 @@ local uv = vim.uv
 --- @field cmd string[]
 --- @field result? SystemCompleted
 
----@private
 ---@param state SystemState
 local function close_handles(state)
   for _, handle in pairs({ state.handle, state.stdin, state.stdout, state.stderr }) do
@@ -128,7 +127,6 @@ function SystemObj:is_closing()
   return handle == nil or handle:is_closing()
 end
 
----@private
 ---@param output function|'false'
 ---@return uv_stream_t?
 ---@return function? Handler
@@ -145,7 +143,6 @@ local function setup_output(output)
   return nil, nil
 end
 
----@private
 ---@param input string|string[]|true|nil
 ---@return uv_stream_t?
 ---@return string|string[]?
diff --git a/runtime/lua/vim/_watch.lua b/runtime/lua/vim/_watch.lua
index 00b7416098..dc5f59f38b 100644
--- a/runtime/lua/vim/_watch.lua
+++ b/runtime/lua/vim/_watch.lua
@@ -7,7 +7,6 @@ M.FileChangeType = vim.tbl_add_reverse_lookup({
   Deleted = 3,
 })
 
----@private
 --- Joins filepath elements by static '/' separator
 ---
 ---@param ... (string) The path elements.
@@ -16,7 +15,6 @@ local function filepath_join(...)
   return table.concat({ ... }, '/')
 end
 
----@private
 --- Stops and closes a libuv |uv_fs_event_t| or |uv_fs_poll_t| handle
 ---
 ---@param handle (uv_fs_event_t|uv_fs_poll_t) The handle to stop
@@ -88,7 +86,6 @@ local default_poll_interval_ms = 2000
 --- @field include_pattern? userdata
 --- @field exclude_pattern? userdata
 
----@private
 --- Implementation for poll, hiding internally-used parameters.
 ---
 ---@param path string
diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index 093bfb631e..f0adc4104e 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -72,7 +72,6 @@ local bufs_waiting_to_update = setmetatable({}, bufnr_and_namespace_cacher_mt)
 
 local all_namespaces = {}
 
----@private
 local function to_severity(severity)
   if type(severity) == 'string' then
     return assert(
@@ -83,7 +82,6 @@ local function to_severity(severity)
   return severity
 end
 
----@private
 local function filter_by_severity(severity, diagnostics)
   if not severity then
     return diagnostics
@@ -104,7 +102,6 @@ local function filter_by_severity(severity, diagnostics)
   end, diagnostics)
 end
 
----@private
 local function count_sources(bufnr)
   local seen = {}
   local count = 0
@@ -119,7 +116,6 @@ local function count_sources(bufnr)
   return count
 end
 
----@private
 local function prefix_source(diagnostics)
   return vim.tbl_map(function(d)
     if not d.source then
@@ -132,7 +128,6 @@ local function prefix_source(diagnostics)
   end, diagnostics)
 end
 
----@private
 local function reformat_diagnostics(format, diagnostics)
   vim.validate({
     format = { format, 'f' },
@@ -146,7 +141,6 @@ local function reformat_diagnostics(format, diagnostics)
   return formatted
 end
 
----@private
 local function enabled_value(option, namespace)
   local ns = namespace and M.get_namespace(namespace) or {}
   if ns.opts and type(ns.opts[option]) == 'table' then
@@ -160,7 +154,6 @@ local function enabled_value(option, namespace)
   return {}
 end
 
----@private
 local function resolve_optional_value(option, value, namespace, bufnr)
   if not value then
     return false
@@ -180,7 +173,6 @@ local function resolve_optional_value(option, value, namespace, bufnr)
   end
 end
 
----@private
 local function get_resolved_options(opts, namespace, bufnr)
   local ns = namespace and M.get_namespace(namespace) or {}
   -- Do not use tbl_deep_extend so that an empty table can be used to reset to default values
@@ -202,7 +194,6 @@ local diagnostic_severities = {
 }
 
 -- Make a map from DiagnosticSeverity -> Highlight Name
----@private
 local function make_highlight_map(base_name)
   local result = {}
   for k in pairs(diagnostic_severities) do
@@ -243,7 +234,6 @@ local define_default_signs = (function()
   end
 end)()
 
----@private
 local function get_bufnr(bufnr)
   if not bufnr or bufnr == 0 then
     return api.nvim_get_current_buf()
@@ -251,7 +241,6 @@ local function get_bufnr(bufnr)
   return bufnr
 end
 
----@private
 local function diagnostic_lines(diagnostics)
   if not diagnostics then
     return {}
@@ -269,7 +258,6 @@ local function diagnostic_lines(diagnostics)
   return diagnostics_by_line
 end
 
----@private
 local function set_diagnostic_cache(namespace, bufnr, diagnostics)
   for _, diagnostic in ipairs(diagnostics) do
     assert(diagnostic.lnum, 'Diagnostic line number is required')
@@ -284,7 +272,6 @@ local function set_diagnostic_cache(namespace, bufnr, diagnostics)
   diagnostic_cache[bufnr][namespace] = diagnostics
 end
 
----@private
 local function restore_extmarks(bufnr, last)
   for ns, extmarks in pairs(diagnostic_cache_extmarks[bufnr]) do
     local extmarks_current = api.nvim_buf_get_extmarks(bufnr, ns, 0, -1, { details = true })
@@ -306,7 +293,6 @@ local function restore_extmarks(bufnr, last)
   end
 end
 
----@private
 local function save_extmarks(namespace, bufnr)
   bufnr = get_bufnr(bufnr)
   if not diagnostic_attached_buffers[bufnr] then
@@ -326,13 +312,11 @@ end
 
 local registered_autocmds = {}
 
----@private
 local function make_augroup_key(namespace, bufnr)
   local ns = M.get_namespace(namespace)
   return string.format('DiagnosticInsertLeave:%s:%s', bufnr, ns.name)
 end
 
----@private
 local function execute_scheduled_display(namespace, bufnr)
   local args = bufs_waiting_to_update[bufnr][namespace]
   if not args then
@@ -348,7 +332,6 @@ end
 --- Table of autocmd events to fire the update for displaying new diagnostic information
 local insert_leave_auto_cmds = { 'InsertLeave', 'CursorHoldI' }
 
----@private
 local function schedule_display(namespace, bufnr, args)
   bufs_waiting_to_update[bufnr][namespace] = args
 
@@ -367,7 +350,6 @@ local function schedule_display(namespace, bufnr, args)
   end
 end
 
----@private
 local function clear_scheduled_display(namespace, bufnr)
   local key = make_augroup_key(namespace, bufnr)
 
@@ -377,7 +359,6 @@ local function clear_scheduled_display(namespace, bufnr)
   end
 end
 
----@private
 local function get_diagnostics(bufnr, opts, clamp)
   opts = opts or {}
 
@@ -392,7 +373,6 @@ local function get_diagnostics(bufnr, opts, clamp)
     end,
   })
 
-  ---@private
   local function add(b, d)
     if not opts.lnum or d.lnum == opts.lnum then
       if clamp and api.nvim_buf_is_loaded(b) then
@@ -416,7 +396,6 @@ local function get_diagnostics(bufnr, opts, clamp)
     end
   end
 
-  ---@private
   local function add_all_diags(buf, diags)
     for _, diagnostic in pairs(diags) do
       add(buf, diagnostic)
@@ -450,7 +429,6 @@ local function get_diagnostics(bufnr, opts, clamp)
   return diagnostics
 end
 
----@private
 local function set_list(loclist, opts)
   opts = opts or {}
   local open = vim.F.if_nil(opts.open, true)
@@ -474,7 +452,6 @@ local function set_list(loclist, opts)
   end
 end
 
----@private
 local function next_diagnostic(position, search_forward, bufnr, opts, namespace)
   position[1] = position[1] - 1
   bufnr = get_bufnr(bufnr)
@@ -525,7 +502,6 @@ local function next_diagnostic(position, search_forward, bufnr, opts, namespace)
   end
 end
 
----@private
 local function diagnostic_move_pos(opts, pos)
   opts = opts or {}
 
diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 33d451315d..40f72a217d 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -2,7 +2,6 @@ local api = vim.api
 
 local M = {}
 
----@private
 local function starsetf(ft, opts)
   return {
     function(path, bufnr)
@@ -2317,7 +2316,6 @@ local pattern = {
 -- luacheck: pop
 -- luacheck: pop
 
----@private
 local function sort_by_priority(t)
   local sorted = {}
   for k, v in pairs(t) do
@@ -2341,7 +2339,6 @@ end
 
 local pattern_sorted = sort_by_priority(pattern)
 
----@private
 local function normalize_path(path, as_pattern)
   local normal = path:gsub('\\', '/')
   if normal:find('^~') then
@@ -2456,7 +2453,6 @@ function M.add(filetypes)
   end
 end
 
----@private
 local function dispatch(ft, path, bufnr, ...)
   local on_detect
   if type(ft) == 'function' then
@@ -2483,7 +2479,6 @@ end
 -- Lookup table/cache for patterns that contain an environment variable pattern, e.g. ${SOME_VAR}.
 local expand_env_lookup = {}
 
----@private
 local function match_pattern(name, path, tail, pat)
   if expand_env_lookup[pat] == nil then
     expand_env_lookup[pat] = pat:find('%${') ~= nil
diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index d06dcb87cf..842767098c 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -218,7 +218,6 @@ function M.find(names, opts)
 
   local matches = {}
 
-  ---@private
   local function add(match)
     matches[#matches + 1] = M.normalize(match)
     if #matches == limit then
diff --git a/runtime/lua/vim/highlight.lua b/runtime/lua/vim/highlight.lua
index 0eb782339c..14b0e71312 100644
--- a/runtime/lua/vim/highlight.lua
+++ b/runtime/lua/vim/highlight.lua
@@ -18,23 +18,18 @@
 ---<pre>vim
 ---    au TextYankPost * silent! lua vim.highlight.on_yank {on_visual=false}
 ---</pre>
----
---- <pre>help
----vim.highlight.priorities                            *vim.highlight.priorities*
----
----    Table with default priorities used for highlighting:
----        • `syntax`: `50`, used for standard syntax highlighting
----        • `treesitter`: `100`, used for tree-sitter-based highlighting
----        • `semantic_tokens`: `125`, used for LSP semantic token highlighting
----        • `diagnostics`: `150`, used for code analysis such as diagnostics
----        • `user`: `200`, used for user-triggered highlights such as LSP document
----          symbols or `on_yank` autocommands
----</pre>
 
 local api = vim.api
 
 local M = {}
 
+--- Table with default priorities used for highlighting:
+---     - `syntax`: `50`, used for standard syntax highlighting
+---     - `treesitter`: `100`, used for tree-sitter-based highlighting
+---     - `semantic_tokens`: `125`, used for LSP semantic token highlighting
+---     - `diagnostics`: `150`, used for code analysis such as diagnostics
+---     - `user`: `200`, used for user-triggered highlights such as LSP document
+---       symbols or `on_yank` autocommands
 M.priorities = {
   syntax = 50,
   treesitter = 100,
diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index 6c1afcad91..7bffcc9c20 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -85,7 +85,6 @@ end
 --- Packed tables use this as their metatable
 local packedmt = {}
 
----@private
 local function unpack(t)
   if type(t) == 'table' and getmetatable(t) == packedmt then
     return _G.unpack(t, 1, t.n)
@@ -93,7 +92,6 @@ local function unpack(t)
   return t
 end
 
----@private
 local function pack(...)
   local n = select('#', ...)
   if n > 1 then
@@ -102,7 +100,6 @@ local function pack(...)
   return ...
 end
 
----@private
 local function sanitize(t)
   if type(t) == 'table' and getmetatable(t) == packedmt then
     -- Remove length tag
@@ -120,7 +117,6 @@ end
 ---@param ... any Function arguments.
 ---@return boolean True if the iterator stage should continue, false otherwise
 ---@return any Function arguments.
----@private
 local function continue(...)
   if select('#', ...) > 0 then
     return false, ...
@@ -137,7 +133,6 @@ end
 ---@param ... any Arguments to apply to f
 ---@return boolean True if the iterator pipeline should continue, false otherwise
 ---@return any Return values of f
----@private
 local function apply(f, ...)
   if select('#', ...) > 0 then
     return continue(f(...))
@@ -230,7 +225,6 @@ function Iter.map(self, f)
   ---                    values passed.
   ---@param ... any Values to return if cont is false.
   ---@return any
-  ---@private
   local function fn(cont, ...)
     if cont then
       return fn(apply(f, next(self)))
@@ -270,7 +264,6 @@ end
 ---                       Takes all of the values returned by the previous stage
 ---                       in the pipeline as arguments.
 function Iter.each(self, f)
-  ---@private
   local function fn(...)
     if select('#', ...) > 0 then
       f(...)
@@ -383,7 +376,6 @@ function Iter.fold(self, init, f)
   local acc = init
 
   --- Use a closure to handle var args returned from iterator
-  ---@private
   local function fn(...)
     if select(1, ...) ~= nil then
       acc = f(acc, ...)
@@ -525,7 +517,6 @@ function Iter.find(self, f)
   local result = nil
 
   --- Use a closure to handle var args returned from iterator
-  ---@private
   local function fn(...)
     if select(1, ...) ~= nil then
       if f(...) then
@@ -768,7 +759,6 @@ function Iter.any(self, pred)
   local any = false
 
   --- Use a closure to handle var args returned from iterator
-  ---@private
   local function fn(...)
     if select(1, ...) ~= nil then
       if pred(...) then
@@ -792,7 +782,6 @@ end
 function Iter.all(self, pred)
   local all = true
 
-  ---@private
   local function fn(...)
     if select(1, ...) ~= nil then
       if not pred(...) then
@@ -929,7 +918,6 @@ function Iter.new(src, ...)
     local s, var = ...
 
     --- Use a closure to handle var args returned from iterator
-    ---@private
     local function fn(...)
       if select(1, ...) ~= nil then
         var = select(1, ...)
diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index f340dc85b5..4f4722b0c3 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -21,7 +21,10 @@ local M = {}
 
 ---@alias LoaderStats table<string, {total:number, time:number, [string]:number?}?>
 
+---@nodoc
 M.path = vim.fn.stdpath('cache') .. '/luac'
+
+---@nodoc
 M.enabled = false
 
 ---@class Loader
@@ -58,7 +61,6 @@ function Loader.get_hash(path)
   return Loader._hashes[path]
 end
 
----@private
 local function normalize(path)
   return vim.fs.normalize(path, { expand_env = false })
 end
@@ -122,7 +124,6 @@ end
 --- @param path string
 --- @param mode integer
 --- @return string? data
---- @private
 local function readfile(path, mode)
   local f = uv.fs_open(path, 'r', mode)
   if f then
@@ -310,7 +311,6 @@ function M.find(modname, opts)
   local results = {}
 
   -- Only continue if we haven't found anything yet or we want to find all
-  ---@private
   local function continue()
     return #results == 0 or opts.all
   end
@@ -318,7 +318,6 @@ function M.find(modname, opts)
   -- Checks if the given paths contain the top-level module.
   -- If so, it tries to find the module path for the given module name.
   ---@param paths string[]
-  ---@private
   local function _find(paths)
     for _, path in ipairs(paths) do
       if topmod == '*' then
@@ -504,7 +503,6 @@ end
 ---@private
 function M._inspect(opts)
   if opts and opts.print then
-    ---@private
     local function ms(nsec)
       return math.floor(nsec / 1e6 * 1000 + 0.5) / 1000 .. 'ms'
     end
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 97aab45f2c..35e4bc9dd8 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -66,7 +66,6 @@ lsp._request_name_to_capability = {
 
 -- TODO improve handling of scratch buffers with LSP attached.
 
----@private
 --- Concatenates and writes a list of strings to the Vim error buffer.
 ---
 ---@param ... string List to write to the buffer
@@ -75,7 +74,6 @@ local function err_message(...)
   nvim_command('redraw')
 end
 
----@private
 --- Returns the buffer number for the given {bufnr}.
 ---
 ---@param bufnr (integer|nil) Buffer number to resolve. Defaults to current buffer
@@ -101,7 +99,6 @@ function lsp._unsupported_method(method)
   return msg
 end
 
----@private
 --- Checks whether a given path is a directory.
 ---
 ---@param filename (string) path to check
@@ -132,7 +129,6 @@ local format_line_ending = {
   ['mac'] = '\r',
 }
 
----@private
 ---@param bufnr (number)
 ---@return string
 local function buf_get_line_ending(bufnr)
@@ -140,7 +136,6 @@ local function buf_get_line_ending(bufnr)
 end
 
 local client_index = 0
----@private
 --- Returns a new, unused client id.
 ---
 ---@return integer client_id
@@ -153,7 +148,6 @@ local active_clients = {} --- @type table<integer,lsp.Client>
 local all_buffer_active_clients = {} --- @type table<integer,table<integer,true>>
 local uninitialized_clients = {} --- @type table<integer,lsp.Client>
 
----@private
 ---@param bufnr? integer
 ---@param fn fun(client: lsp.Client, client_id: integer, bufnr: integer)
 local function for_each_buffer_client(bufnr, fn, restrict_client_ids)
@@ -185,9 +179,10 @@ local function for_each_buffer_client(bufnr, fn, restrict_client_ids)
   end
 end
 
--- Error codes to be used with `on_error` from |vim.lsp.start_client|.
--- Can be used to look up the string from a the number or the number
--- from the string.
+--- Error codes to be used with `on_error` from |vim.lsp.start_client|.
+--- Can be used to look up the string from a the number or the number
+--- from the string.
+--- @nodoc
 lsp.client_errors = tbl_extend(
   'error',
   lsp_rpc.client_errors,
@@ -196,7 +191,6 @@ lsp.client_errors = tbl_extend(
   })
 )
 
----@private
 --- Normalizes {encoding} to valid LSP encoding names.
 ---
 ---@param encoding (string) Encoding to normalize
@@ -243,7 +237,6 @@ function lsp._cmd_parts(input)
   return cmd, cmd_args
 end
 
----@private
 --- Augments a validator function with support for optional (nil) values.
 ---
 ---@param fn (fun(v): boolean) The original validator function; should return a
@@ -256,7 +249,6 @@ local function optional_validator(fn)
   end
 end
 
----@private
 --- Validates a client configuration as given to |vim.lsp.start_client()|.
 ---
 ---@param config (lsp.ClientConfig)
@@ -308,7 +300,6 @@ local function validate_client_config(config)
   return cmd, cmd_args, offset_encoding
 end
 
----@private
 --- Returns full text of buffer {bufnr} as a string.
 ---
 ---@param bufnr (number) Buffer handle, or 0 for current.
@@ -322,7 +313,6 @@ local function buf_get_full_text(bufnr)
   return text
 end
 
----@private
 --- Memoizes a function. On first run, the function return value is saved and
 --- immediately returned on subsequent runs. If the function returns a multival,
 --- only the first returned value will be memoized and returned. The function will only be run once,
@@ -382,7 +372,6 @@ do
   --- @field debounce integer debounce duration in ms
   --- @field clients table<integer, table> clients using this state. {client_id, client}
 
-  ---@private
   ---@param group CTGroup
   ---@return string
   local function group_key(group)
@@ -403,7 +392,6 @@ do
     end,
   })
 
-  ---@private
   ---@return CTGroup
   local function get_group(client)
     local allow_inc_sync = if_nil(client.config.flags.allow_incremental_sync, true)
@@ -419,7 +407,6 @@ do
     }
   end
 
-  ---@private
   ---@param state CTBufferState
   local function incremental_changes(state, encoding, bufnr, firstline, lastline, new_lastline)
     local prev_lines = state.lines
@@ -543,8 +530,6 @@ do
     end
   end
 
-  ---@private
-  --
   -- Adjust debounce time by taking time of last didChange notification into
   -- consideration. If the last didChange happened more than `debounce` time ago,
   -- debounce can be skipped and otherwise maybe reduced.
@@ -567,7 +552,6 @@ do
     return math.max(debounce - ms_since_last_flush, 0)
   end
 
-  ---@private
   ---@param bufnr integer
   ---@param sync_kind integer protocol.TextDocumentSyncKind
   ---@param state CTGroupState
@@ -694,7 +678,6 @@ do
   end
 end
 
----@private
 --- Default handler for the 'textDocument/didOpen' LSP notification.
 ---
 ---@param bufnr integer Number of the buffer, or 0 for current
@@ -924,7 +907,6 @@ function lsp.status()
   return message
 end
 
----@private
 -- Determines whether the given option can be set by `set_defaults`.
 local function is_empty_or_default(bufnr, option)
   if vim.bo[bufnr][option] == '' then
@@ -1138,7 +1120,6 @@ function lsp.start_client(config)
 
   local dispatch = {}
 
-  ---@private
   --- Returns the handler associated with an LSP method.
   --- Returns the default handler if the user hasn't set a custom one.
   ---
@@ -1208,7 +1189,6 @@ function lsp.start_client(config)
     end
   end
 
-  ---@private
   --- Reset defaults set by `set_defaults`.
   --- Must only be called if the last client attached to a buffer exits.
   local function reset_defaults(bufnr)
@@ -1337,7 +1317,6 @@ function lsp.start_client(config)
   -- Store the uninitialized_clients for cleanup in case we exit before initialize finishes.
   uninitialized_clients[client_id] = client
 
-  ---@private
   local function initialize()
     local valid_traces = {
       off = 'off',
@@ -1749,7 +1728,6 @@ do
   end
 end
 
----@private
 ---Buffer lifecycle handler for textDocument/didSave
 local function text_document_did_save_handler(bufnr)
   bufnr = resolve_bufnr(bufnr)
@@ -2082,7 +2060,6 @@ api.nvim_create_autocmd('VimLeavePre', {
 
     local poll_time = 50
 
-    ---@private
     local function check_clients_closed()
       for client_id, timeout in pairs(timeouts) do
         timeouts[client_id] = timeout - poll_time
@@ -2440,12 +2417,13 @@ function lsp.buf_get_clients(bufnr)
   return result
 end
 
--- Log level dictionary with reverse lookup as well.
---
--- Can be used to lookup the number from the name or the
--- name from the number.
--- Levels by name: "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF"
--- Level numbers begin with "TRACE" at 0
+--- Log level dictionary with reverse lookup as well.
+---
+--- Can be used to lookup the number from the name or the
+--- name from the number.
+--- Levels by name: "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF"
+--- Level numbers begin with "TRACE" at 0
+--- @nodoc
 lsp.log_levels = log.levels
 
 --- Sets the global log level for LSP logging.
diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
index 87938fe4d5..b66f2f6f32 100644
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -5,7 +5,6 @@ local lpeg = vim.lpeg
 
 local M = {}
 
----@private
 --- Parses the raw pattern into an |lpeg| pattern. LPeg patterns natively support the "this" or "that"
 --- alternative constructions described in the LSP spec that cannot be expressed in a standard Lua pattern.
 ---
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 2140d3ae37..46f582dc7e 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -5,7 +5,6 @@ local npcall = vim.F.npcall
 
 local M = {}
 
----@private
 --- Sends an async request to all active clients attached to the current
 --- buffer.
 ---
@@ -45,7 +44,6 @@ function M.hover()
   request('textDocument/hover', params)
 end
 
----@private
 local function request_with_options(name, params, options)
   local req_handler
   if options then
@@ -120,7 +118,6 @@ function M.completion(context)
   return request('textDocument/completion', params)
 end
 
----@private
 ---@param bufnr integer
 ---@param mode "v"|"V"
 ---@return table {start={row,col}, end={row,col}} using (1, 0) indexing
@@ -218,7 +215,6 @@ function M.format(options)
     vim.notify('[LSP] Format request failed, no matching language servers.')
   end
 
-  ---@private
   local function set_range(client, params)
     if range then
       local range_params =
@@ -289,7 +285,6 @@ function M.rename(new_name, options)
   -- Compute early to account for cursor movements after going async
   local cword = vim.fn.expand('<cword>')
 
-  ---@private
   local function get_text_at_range(range, offset_encoding)
     return api.nvim_buf_get_text(
       bufnr,
@@ -307,7 +302,6 @@ function M.rename(new_name, options)
       return
     end
 
-    ---@private
     local function rename(name)
       local params = util.make_position_params(win, client.offset_encoding)
       params.newName = name
@@ -408,7 +402,6 @@ function M.document_symbol(options)
   request_with_options('textDocument/documentSymbol', params, options)
 end
 
----@private
 local function pick_call_hierarchy_item(call_hierarchy_items)
   if not call_hierarchy_items then
     return
@@ -428,7 +421,6 @@ local function pick_call_hierarchy_item(call_hierarchy_items)
   return choice
 end
 
----@private
 local function call_hierarchy(method)
   local params = util.make_position_params()
   request('textDocument/prepareCallHierarchy', params, function(err, result, ctx)
@@ -579,8 +571,6 @@ function M.clear_references()
   util.buf_clear_references()
 end
 
----@private
---
 --- This is not public because the main extension point is
 --- vim.ui.select which can be overridden independently.
 ---
@@ -592,7 +582,6 @@ end
 local function on_code_action_results(results, ctx, options)
   local action_tuples = {}
 
-  ---@private
   local function action_filter(a)
     -- filter by specified action kind
     if options and options.context and options.context.only then
@@ -632,7 +621,6 @@ local function on_code_action_results(results, ctx, options)
     return
   end
 
-  ---@private
   local function apply_action(action, client)
     if action.edit then
       util.apply_workspace_edit(action.edit, client.offset_encoding)
@@ -643,7 +631,6 @@ local function on_code_action_results(results, ctx, options)
     end
   end
 
-  ---@private
   local function on_user_choice(action_tuple)
     if not action_tuple then
       return
@@ -701,7 +688,6 @@ end
 
 --- Requests code actions from all clients and calls the handler exactly once
 --- with all aggregated results
----@private
 local function code_action_request(params, options)
   local bufnr = api.nvim_get_current_buf()
   local method = 'textDocument/codeAction'
diff --git a/runtime/lua/vim/lsp/codelens.lua b/runtime/lua/vim/lsp/codelens.lua
index 67104cc40b..a516238ae0 100644
--- a/runtime/lua/vim/lsp/codelens.lua
+++ b/runtime/lua/vim/lsp/codelens.lua
@@ -26,7 +26,6 @@ local namespaces = setmetatable({}, {
 ---@private
 M.__namespaces = namespaces
 
----@private
 local function execute_lens(lens, bufnr, client_id)
   local line = lens.range.start.line
   api.nvim_buf_clear_namespace(bufnr, namespaces[client_id], line, line + 1)
@@ -89,7 +88,6 @@ function M.run()
   end
 end
 
----@private
 local function resolve_bufnr(bufnr)
   return bufnr == 0 and api.nvim_get_current_buf() or bufnr
 end
@@ -186,7 +184,6 @@ function M.save(lenses, bufnr, client_id)
   lenses_by_client[client_id] = lenses
 end
 
----@private
 local function resolve_lenses(lenses, bufnr, client_id, callback)
   lenses = lenses or {}
   local num_lens = vim.tbl_count(lenses)
@@ -195,7 +192,6 @@ local function resolve_lenses(lenses, bufnr, client_id, callback)
     return
   end
 
-  ---@private
   local function countdown()
     num_lens = num_lens - 1
     if num_lens == 0 then
diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index 3efa5c51ff..c2cf7c6ba5 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -5,7 +5,7 @@ local protocol = require('vim.lsp.protocol')
 local M = {}
 
 local DEFAULT_CLIENT_ID = -1
----@private
+
 local function get_client_id(client_id)
   if client_id == nil then
     client_id = DEFAULT_CLIENT_ID
@@ -14,7 +14,6 @@ local function get_client_id(client_id)
   return client_id
 end
 
----@private
 ---@param severity lsp.DiagnosticSeverity
 local function severity_lsp_to_vim(severity)
   if type(severity) == 'string' then
@@ -23,7 +22,6 @@ local function severity_lsp_to_vim(severity)
   return severity
 end
 
----@private
 ---@return lsp.DiagnosticSeverity
 local function severity_vim_to_lsp(severity)
   if type(severity) == 'string' then
@@ -32,7 +30,6 @@ local function severity_vim_to_lsp(severity)
   return severity
 end
 
----@private
 ---@return integer
 local function line_byte_from_position(lines, lnum, col, offset_encoding)
   if not lines or offset_encoding == 'utf-8' then
@@ -48,7 +45,6 @@ local function line_byte_from_position(lines, lnum, col, offset_encoding)
   return col
 end
 
----@private
 local function get_buf_lines(bufnr)
   if vim.api.nvim_buf_is_loaded(bufnr) then
     return vim.api.nvim_buf_get_lines(bufnr, 0, -1, false)
@@ -73,7 +69,6 @@ local function get_buf_lines(bufnr)
   return lines
 end
 
---- @private
 --- @param diagnostic lsp.Diagnostic
 --- @param client_id integer
 --- @return table?
@@ -96,7 +91,6 @@ local function tags_lsp_to_vim(diagnostic, client_id)
   return tags
 end
 
----@private
 ---@param diagnostics lsp.Diagnostic[]
 ---@param bufnr integer
 ---@param client_id integer
@@ -133,7 +127,6 @@ local function diagnostic_lsp_to_vim(diagnostics, bufnr, client_id)
   end, diagnostics)
 end
 
---- @private
 --- @param diagnostics Diagnostic[]
 --- @return lsp.Diagnostic[]
 local function diagnostic_vim_to_lsp(diagnostics)
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 20c4d7458b..ce3db68618 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -7,7 +7,6 @@ local M = {}
 
 -- FIXME: DOC: Expose in vimdocs
 
----@private
 --- Writes to error buffer.
 ---@param ... string Will be concatenated before being written
 local function err_message(...)
@@ -246,7 +245,6 @@ M['textDocument/references'] = function(_, result, ctx, config)
   end
 end
 
----@private
 --- Return a function that converts LSP responses to list items and opens the list
 ---
 --- The returned function has an optional {config} parameter that accepts a table
@@ -380,7 +378,6 @@ end
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover
 M['textDocument/hover'] = M.hover
 
----@private
 --- Jumps to a location. Used as a handler for multiple LSP methods.
 ---@param _ nil not used
 ---@param result (table) result of LSP method; a location or a list of locations.
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 6426b0c039..bec6f33e93 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -17,7 +17,6 @@ local namespace = api.nvim_create_namespace('vim_lsp_inlayhint')
 local augroup = api.nvim_create_augroup('vim_lsp_inlayhint', {})
 
 --- Reset the request debounce timer of a buffer
----@private
 local function reset_timer(reset_bufnr)
   local timer = bufstates[reset_bufnr].timer
   if timer then
@@ -63,7 +62,6 @@ function M.on_inlayhint(err, result, ctx, _)
   end
 
   local lines = api.nvim_buf_get_lines(bufnr, 0, -1, false)
-  ---@private
   local function pos_to_byte(position)
     local col = position.character
     if col > 0 then
@@ -89,7 +87,6 @@ function M.on_inlayhint(err, result, ctx, _)
   api.nvim__buf_redraw_range(bufnr, 0, -1)
 end
 
----@private
 local function resolve_bufnr(bufnr)
   return bufnr > 0 and bufnr or api.nvim_get_current_buf()
 end
@@ -100,7 +97,6 @@ end
 ---  - bufnr (integer, default: 0): Buffer whose hints to refresh
 ---  - only_visible (boolean, default: false): Whether to only refresh hints for the visible regions of the buffer
 ---
----@private
 local function refresh(opts)
   opts = opts or {}
   local bufnr = resolve_bufnr(opts.bufnr or 0)
@@ -159,7 +155,6 @@ end
 
 --- Clear inlay hints
 ---@param bufnr (integer) Buffer handle, or 0 for current
----@private
 local function clear(bufnr)
   bufnr = resolve_bufnr(bufnr)
   if not bufstates[bufnr] then
@@ -178,7 +173,6 @@ local function clear(bufnr)
   api.nvim__buf_redraw_range(bufnr, 0, -1)
 end
 
----@private
 local function make_request(request_bufnr)
   reset_timer(request_bufnr)
   refresh({ bufnr = request_bufnr })
@@ -186,7 +180,6 @@ end
 
 --- Enable inlay hints for a buffer
 ---@param bufnr (integer) Buffer handle, or 0 for current
----@private
 local function enable(bufnr)
   bufnr = resolve_bufnr(bufnr)
   local bufstate = bufstates[bufnr]
@@ -228,7 +221,6 @@ end
 
 --- Disable inlay hints for a buffer
 ---@param bufnr (integer) Buffer handle, or 0 for current
----@private
 local function disable(bufnr)
   bufnr = resolve_bufnr(bufnr)
   if bufstates[bufnr] and bufstates[bufnr].enabled then
@@ -240,7 +232,6 @@ end
 
 --- Toggle inlay hints for a buffer
 ---@param bufnr (integer) Buffer handle, or 0 for current
----@private
 local function toggle(bufnr)
   bufnr = resolve_bufnr(bufnr)
   local bufstate = bufstates[bufnr]
diff --git a/runtime/lua/vim/lsp/log.lua b/runtime/lua/vim/lsp/log.lua
index 033f93bd6e..6d2e0bc292 100644
--- a/runtime/lua/vim/lsp/log.lua
+++ b/runtime/lua/vim/lsp/log.lua
@@ -2,14 +2,12 @@
 
 local log = {}
 
--- FIXME: DOC
--- Should be exposed in the vim docs.
---
--- Log level dictionary with reverse lookup as well.
---
--- Can be used to lookup the number from the name or the name from the number.
--- Levels by name: "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF"
--- Level numbers begin with "TRACE" at 0
+--- Log level dictionary with reverse lookup as well.
+---
+--- Can be used to lookup the number from the name or the name from the number.
+--- Levels by name: "TRACE", "DEBUG", "INFO", "WARN", "ERROR", "OFF"
+--- Level numbers begin with "TRACE" at 0
+--- @nodoc
 log.levels = vim.deepcopy(vim.log.levels)
 
 -- Default log level is warn.
@@ -20,7 +18,6 @@ local format_func = function(arg)
 end
 
 do
-  ---@private
   local function notify(msg, level)
     if vim.in_fast_event() then
       vim.schedule(function()
@@ -32,7 +29,6 @@ do
   end
 
   local path_sep = vim.uv.os_uname().version:match('Windows') and '\\' or '/'
-  ---@private
   local function path_join(...)
     return table.concat(vim.tbl_flatten({ ... }), path_sep)
   end
@@ -50,7 +46,6 @@ do
   end
 
   local logfile, openerr
-  ---@private
   --- Opens log file. Returns true if file is open, false on error
   local function open_logfile()
     -- Try to open file only once
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index c110c3a67c..a77af937b3 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -5,7 +5,6 @@ local validate, schedule, schedule_wrap = vim.validate, vim.schedule, vim.schedu
 
 local is_win = uv.os_uname().version:find('Windows')
 
----@private
 --- Checks whether a given path exists and is a directory.
 ---@param filename (string) path to check
 ---@return boolean
@@ -14,7 +13,6 @@ local function is_dir(filename)
   return stat and stat.type == 'directory' or false
 end
 
----@private
 --- Embeds the given string into a table and correctly computes `Content-Length`.
 ---
 ---@param encoded_message (string)
@@ -28,7 +26,6 @@ local function format_message_with_content_length(encoded_message)
   })
 end
 
----@private
 --- Parses an LSP Message's header
 ---
 ---@param header string: The header to parse.
@@ -60,7 +57,6 @@ local header_start_pattern = ('content'):gsub('%w', function(c)
   return '[' .. c .. c:upper() .. ']'
 end)
 
----@private
 --- The actual workhorse.
 local function request_parser_loop()
   local buffer = '' -- only for header part
@@ -115,8 +111,11 @@ local function request_parser_loop()
   end
 end
 
+local M = {}
+
 --- Mapping of error codes used by the client
-local client_errors = {
+--- @nodoc
+M.client_errors = {
   INVALID_SERVER_MESSAGE = 1,
   INVALID_SERVER_JSON = 2,
   NO_RESULT_CALLBACK_FOUND = 3,
@@ -126,13 +125,13 @@ local client_errors = {
   SERVER_RESULT_CALLBACK_ERROR = 7,
 }
 
-client_errors = vim.tbl_add_reverse_lookup(client_errors)
+M.client_errors = vim.tbl_add_reverse_lookup(M.client_errors)
 
 --- Constructs an error message from an LSP error object.
 ---
 ---@param err (table) The error object
 ---@returns (string) The formatted error message
-local function format_rpc_error(err)
+function M.format_rpc_error(err)
   validate({
     err = { err, 't' },
   })
@@ -163,7 +162,7 @@ end
 ---@param code integer RPC error code defined in `vim.lsp.protocol.ErrorCodes`
 ---@param message string|nil arbitrary message to send to server
 ---@param data any|nil arbitrary data to send to server
-local function rpc_response_error(code, message, data)
+function M.rpc_response_error(code, message, data)
   -- TODO should this error or just pick a sane error (like InternalError)?
   local code_name = assert(protocol.ErrorCodes[code], 'Invalid RPC error code')
   return setmetatable({
@@ -171,7 +170,7 @@ local function rpc_response_error(code, message, data)
     message = message or code_name,
     data = data,
   }, {
-    __tostring = format_rpc_error,
+    __tostring = M.format_rpc_error,
   })
 end
 
@@ -185,6 +184,7 @@ local default_dispatchers = {}
 function default_dispatchers.notification(method, params)
   local _ = log.debug() and log.debug('notification', method, params)
 end
+
 ---@private
 --- Default dispatcher for requests sent to an LSP server.
 ---
@@ -194,8 +194,9 @@ end
 ---@return table `vim.lsp.protocol.ErrorCodes.MethodNotFound`
 function default_dispatchers.server_request(method, params)
   local _ = log.debug() and log.debug('server_request', method, params)
-  return nil, rpc_response_error(protocol.ErrorCodes.MethodNotFound)
+  return nil, M.rpc_response_error(protocol.ErrorCodes.MethodNotFound)
 end
+
 ---@private
 --- Default dispatcher for when a client exits.
 ---
@@ -205,6 +206,7 @@ end
 function default_dispatchers.on_exit(code, signal)
   local _ = log.info() and log.info('client_exit', { code = code, signal = signal })
 end
+
 ---@private
 --- Default dispatcher for client errors.
 ---
@@ -212,11 +214,11 @@ end
 ---@param err (any): Details about the error
 ---any)
 function default_dispatchers.on_error(code, err)
-  local _ = log.error() and log.error('client_error:', client_errors[code], err)
+  local _ = log.error() and log.error('client_error:', M.client_errors[code], err)
 end
 
 ---@private
-local function create_read_loop(handle_body, on_no_chunk, on_error)
+function M.create_read_loop(handle_body, on_no_chunk, on_error)
   local parse_chunk = coroutine.wrap(request_parser_loop)
   parse_chunk()
   return function(err, chunk)
@@ -329,7 +331,7 @@ end
 
 ---@private
 function Client:on_error(errkind, ...)
-  assert(client_errors[errkind])
+  assert(M.client_errors[errkind])
   -- TODO what to do if this fails?
   pcall(self.dispatchers.on_error, errkind, ...)
 end
@@ -356,7 +358,7 @@ end
 function Client:handle_body(body)
   local ok, decoded = pcall(vim.json.decode, body, { luanil = { object = true } })
   if not ok then
-    self:on_error(client_errors.INVALID_SERVER_JSON, decoded)
+    self:on_error(M.client_errors.INVALID_SERVER_JSON, decoded)
     return
   end
   local _ = log.debug() and log.debug('rpc.receive', decoded)
@@ -369,7 +371,7 @@ function Client:handle_body(body)
       coroutine.wrap(function()
         local status, result
         status, result, err = self:try_call(
-          client_errors.SERVER_REQUEST_HANDLER_ERROR,
+          M.client_errors.SERVER_REQUEST_HANDLER_ERROR,
           self.dispatchers.server_request,
           decoded.method,
           decoded.params
@@ -401,7 +403,7 @@ function Client:handle_body(body)
           end
         else
           -- On an exception, result will contain the error message.
-          err = rpc_response_error(protocol.ErrorCodes.InternalError, result)
+          err = M.rpc_response_error(protocol.ErrorCodes.InternalError, result)
           result = nil
         end
         self:send_response(decoded.id, err, result)
@@ -454,34 +456,33 @@ function Client:handle_body(body)
       })
       if decoded.error then
         decoded.error = setmetatable(decoded.error, {
-          __tostring = format_rpc_error,
+          __tostring = M.format_rpc_error,
         })
       end
       self:try_call(
-        client_errors.SERVER_RESULT_CALLBACK_ERROR,
+        M.client_errors.SERVER_RESULT_CALLBACK_ERROR,
         callback,
         decoded.error,
         decoded.result
       )
     else
-      self:on_error(client_errors.NO_RESULT_CALLBACK_FOUND, decoded)
+      self:on_error(M.client_errors.NO_RESULT_CALLBACK_FOUND, decoded)
       local _ = log.error() and log.error('No callback found for server response id ' .. result_id)
     end
   elseif type(decoded.method) == 'string' then
     -- Notification
     self:try_call(
-      client_errors.NOTIFICATION_HANDLER_ERROR,
+      M.client_errors.NOTIFICATION_HANDLER_ERROR,
       self.dispatchers.notification,
       decoded.method,
       decoded.params
     )
   else
     -- Invalid server message
-    self:on_error(client_errors.INVALID_SERVER_MESSAGE, decoded)
+    self:on_error(M.client_errors.INVALID_SERVER_MESSAGE, decoded)
   end
 end
 
----@private
 ---@return RpcClient
 local function new_client(dispatchers, transport)
   local state = {
@@ -494,7 +495,6 @@ local function new_client(dispatchers, transport)
   return setmetatable(state, { __index = Client })
 end
 
----@private
 ---@param client RpcClient
 local function public_client(client)
   local result = {}
@@ -531,7 +531,6 @@ local function public_client(client)
   return result
 end
 
----@private
 local function merge_dispatchers(dispatchers)
   if dispatchers then
     local user_dispatchers = dispatchers
@@ -565,7 +564,7 @@ end
 ---@param host string
 ---@param port integer
 ---@return function
-local function connect(host, port)
+function M.connect(host, port)
   return function(dispatchers)
     dispatchers = merge_dispatchers(dispatchers)
     local tcp = uv.new_tcp()
@@ -600,8 +599,8 @@ local function connect(host, port)
       local handle_body = function(body)
         client:handle_body(body)
       end
-      tcp:read_start(create_read_loop(handle_body, transport.terminate, function(read_err)
-        client:on_error(client_errors.READ_ERROR, read_err)
+      tcp:read_start(M.create_read_loop(handle_body, transport.terminate, function(read_err)
+        client:on_error(M.client_errors.READ_ERROR, read_err)
       end))
     end)
 
@@ -630,7 +629,7 @@ end
 --- - `request()` |vim.lsp.rpc.request()|
 --- - `is_closing()` returns a boolean indicating if the RPC is closing.
 --- - `terminate()` terminates the RPC client.
-local function start(cmd, cmd_args, dispatchers, extra_spawn_params)
+function M.start(cmd, cmd_args, dispatchers, extra_spawn_params)
   if log.info() then
     log.info('Starting RPC client', { cmd = cmd, args = cmd_args, extra = extra_spawn_params })
   end
@@ -667,8 +666,8 @@ local function start(cmd, cmd_args, dispatchers, extra_spawn_params)
     client:handle_body(body)
   end
 
-  local stdout_handler = create_read_loop(handle_body, nil, function(err)
-    client:on_error(client_errors.READ_ERROR, err)
+  local stdout_handler = M.create_read_loop(handle_body, nil, function(err)
+    client:on_error(M.client_errors.READ_ERROR, err)
   end)
 
   local stderr_handler = function(_, chunk)
@@ -714,11 +713,4 @@ local function start(cmd, cmd_args, dispatchers, extra_spawn_params)
   return public_client(client)
 end
 
-return {
-  start = start,
-  connect = connect,
-  rpc_response_error = rpc_response_error,
-  format_rpc_error = format_rpc_error,
-  client_errors = client_errors,
-  create_read_loop = create_read_loop,
-}
+return M
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 191cc7b400..84723bbc05 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -41,8 +41,6 @@ local STHighlighter = { active = {} }
 ---
 --- Return the index i in range such that tokens[j].line < line for all j < i, and
 --- tokens[j].line >= line for all j >= i, or return hi if no such index is found.
----
----@private
 local function lower_bound(tokens, line, lo, hi)
   while lo < hi do
     local mid = bit.rshift(lo + hi, 1) -- Equivalent to floor((lo + hi) / 2).
@@ -59,8 +57,6 @@ end
 ---
 --- Return the index i in range such that tokens[j].line <= line for all j < i, and
 --- tokens[j].line > line for all j >= i, or return hi if no such index is found.
----
----@private
 local function upper_bound(tokens, line, lo, hi)
   while lo < hi do
     local mid = bit.rshift(lo + hi, 1) -- Equivalent to floor((lo + hi) / 2).
@@ -75,7 +71,6 @@ end
 
 --- Extracts modifier strings from the encoded number in the token array
 ---
----@private
 ---@return table<string, boolean>
 local function modifiers_from_number(x, modifiers_table)
   local modifiers = {}
@@ -93,7 +88,6 @@ end
 
 --- Converts a raw token list to a list of highlight ranges used by the on_win callback
 ---
----@private
 ---@return STTokenRange[]
 local function tokens_to_ranges(data, bufnr, client, request)
   local legend = client.server_capabilities.semanticTokensProvider.legend
@@ -137,7 +131,6 @@ local function tokens_to_ranges(data, bufnr, client, request)
     local token_type = token_types[data[i + 3] + 1]
     local modifiers = modifiers_from_number(data[i + 4], token_modifiers)
 
-    ---@private
     local function _get_byte_pos(col)
       if col > 0 then
         local buf_line = lines[line + 1] or ''
diff --git a/runtime/lua/vim/lsp/sync.lua b/runtime/lua/vim/lsp/sync.lua
index 350c096b47..9c1bbf3892 100644
--- a/runtime/lua/vim/lsp/sync.lua
+++ b/runtime/lua/vim/lsp/sync.lua
@@ -48,7 +48,6 @@ local str_utfindex = vim.str_utfindex
 local str_utf_start = vim.str_utf_start
 local str_utf_end = vim.str_utf_end
 
----@private
 -- Given a line, byte idx, and offset_encoding convert to the
 -- utf-8, utf-16, or utf-32 index.
 ---@param line string the line to index into
@@ -74,7 +73,6 @@ local function byte_to_utf(line, byte, offset_encoding)
   return utf_idx + 1
 end
 
----@private
 local function compute_line_length(line, offset_encoding)
   local length
   local _
@@ -88,7 +86,6 @@ local function compute_line_length(line, offset_encoding)
   return length
 end
 
----@private
 -- Given a line, byte idx, alignment, and offset_encoding convert to the aligned
 -- utf-8 index and either the utf-16, or utf-32 index.
 ---@param line string the line to index into
@@ -122,7 +119,6 @@ local function align_end_position(line, byte, offset_encoding)
   return byte, char
 end
 
----@private
 --- Finds the first line, byte, and char index of the difference between the previous and current lines buffer normalized to the previous codepoint.
 ---@param prev_lines table list of lines from previous buffer
 ---@param curr_lines table list of lines from current buffer
@@ -198,7 +194,6 @@ local function compute_start_range(
   return { line_idx = firstline, byte_idx = byte_idx, char_idx = char_idx }
 end
 
----@private
 --- Finds the last line and byte index of the differences between prev and current buffer.
 --- Normalized to the next codepoint.
 --- prev_end_range is the text range sent to the server representing the changed region.
@@ -307,7 +302,6 @@ local function compute_end_range(
   return prev_end_range, curr_end_range
 end
 
----@private
 --- Get the text of the range defined by start and end line/column
 ---@param lines table list of lines
 ---@param start_range table table returned by first_difference
@@ -343,7 +337,6 @@ local function extract_text(lines, start_range, end_range, line_ending)
   end
 end
 
----@private
 -- rangelength depends on the offset encoding
 -- bytes for utf-8 (clangd with extension)
 -- codepoints for utf-16
diff --git a/runtime/lua/vim/lsp/tagfunc.lua b/runtime/lua/vim/lsp/tagfunc.lua
index eb25b67db9..c70eb573c2 100644
--- a/runtime/lua/vim/lsp/tagfunc.lua
+++ b/runtime/lua/vim/lsp/tagfunc.lua
@@ -1,7 +1,6 @@
 local lsp = vim.lsp
 local util = lsp.util
 
----@private
 local function mk_tag_item(name, range, uri, offset_encoding)
   local bufnr = vim.uri_to_bufnr(uri)
   -- This is get_line_byte_from_position is 0-indexed, call cursor expects a 1-indexed position
@@ -13,7 +12,6 @@ local function mk_tag_item(name, range, uri, offset_encoding)
   }
 end
 
----@private
 local function query_definition(pattern)
   local params = util.make_position_params()
   local results_by_client, err = lsp.buf_request_sync(0, 'textDocument/definition', params, 1000)
@@ -42,7 +40,6 @@ local function query_definition(pattern)
   return results
 end
 
----@private
 local function query_workspace_symbols(pattern)
   local results_by_client, err =
     lsp.buf_request_sync(0, 'workspace/symbol', { query = pattern }, 1000)
@@ -62,7 +59,6 @@ local function query_workspace_symbols(pattern)
   return results
 end
 
----@private
 local function tagfunc(pattern, flags)
   local matches
   if string.match(flags, 'c') then
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 59b9916f64..9a6114c35b 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -22,7 +22,6 @@ local default_border = {
   { ' ', 'NormalFloat' },
 }
 
----@private
 --- Check the border given by opts or the default border for the additional
 --- size it adds to a float.
 ---@param opts table optional options for the floating window
@@ -60,7 +59,6 @@ local function get_border_size(opts)
         )
       )
     end
-    ---@private
     local function border_width(id)
       id = (id - 1) % #border + 1
       if type(border[id]) == 'table' then
@@ -77,7 +75,6 @@ local function get_border_size(opts)
         )
       )
     end
-    ---@private
     local function border_height(id)
       id = (id - 1) % #border + 1
       if type(border[id]) == 'table' then
@@ -103,13 +100,11 @@ local function get_border_size(opts)
   return { height = height, width = width }
 end
 
----@private
 local function split_lines(value)
   value = string.gsub(value, '\r\n?', '\n')
   return split(value, '\n', { plain = true })
 end
 
----@private
 local function create_window_without_focus()
   local prev = vim.api.nvim_get_current_win()
   vim.cmd.new()
@@ -219,7 +214,6 @@ function M.set_lines(lines, A, B, new_lines)
   return lines
 end
 
----@private
 local function sort_by_key(fn)
   return function(a, b)
     local ka, kb = fn(a), fn(b)
@@ -234,7 +228,6 @@ local function sort_by_key(fn)
   end
 end
 
----@private
 --- Gets the zero-indexed lines from the given buffer.
 --- Works on unloaded buffers by reading the file using libuv to bypass buf reading events.
 --- Falls back to loading the buffer and nvim_buf_get_lines for buffers with non-file URI.
@@ -250,7 +243,6 @@ local function get_lines(bufnr, rows)
     bufnr = api.nvim_get_current_buf()
   end
 
-  ---@private
   local function buf_lines()
     local lines = {}
     for _, row in ipairs(rows) do
@@ -316,7 +308,6 @@ local function get_lines(bufnr, rows)
   return lines
 end
 
----@private
 --- Gets the zero-indexed line from the given buffer.
 --- Works on unloaded buffers by reading the file using libuv to bypass buf reading events.
 --- Falls back to loading the buffer and nvim_buf_get_lines for buffers with non-file URI.
@@ -328,7 +319,6 @@ local function get_line(bufnr, row)
   return get_lines(bufnr, { row })[row]
 end
 
----@private
 --- Position is a https://microsoft.github.io/language-server-protocol/specifications/specification-current/#position
 --- Returns a zero-indexed column, since set_lines() does the conversion to
 ---@param offset_encoding string|nil utf-8|utf-16|utf-32
@@ -670,7 +660,6 @@ function M.parse_snippet(input)
   return parsed
 end
 
----@private
 --- Sorts by CompletionItem.sortText.
 ---
 --see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_completion
@@ -680,7 +669,6 @@ local function sort_completion_items(items)
   end)
 end
 
----@private
 --- Returns text that should be inserted when selecting completion item. The
 --- precedence is as follows: textEdit.newText > insertText > label
 --see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_completion
@@ -703,7 +691,6 @@ local function get_completion_word(item)
   return item.label
 end
 
----@private
 --- Some language servers return complementary candidates whose prefixes do not
 --- match are also returned. So we exclude completion candidates whose prefix
 --- does not match.
@@ -784,7 +771,6 @@ function M.text_document_completion_list_to_complete_items(result, prefix)
   return matches
 end
 
----@private
 --- Like vim.fn.bufwinid except it works across tabpages.
 local function bufwinid(bufnr)
   for _, win in ipairs(api.nvim_list_wins()) do
@@ -795,7 +781,6 @@ local function bufwinid(bufnr)
 end
 
 --- Get list of buffers for a directory
----@private
 local function get_dir_bufs(path)
   path = path:gsub('([^%w])', '%%%1')
   local buffers = {}
@@ -855,7 +840,6 @@ function M.rename(old_fname, new_fname, opts)
   end
 end
 
----@private
 local function create_file(change)
   local opts = change.options or {}
   -- from spec: Overwrite wins over `ignoreIfExists`
@@ -870,7 +854,6 @@ local function create_file(change)
   vim.fn.bufadd(fname)
 end
 
----@private
 local function delete_file(change)
   local opts = change.options or {}
   local fname = vim.uri_to_fname(change.uri)
@@ -1266,7 +1249,6 @@ function M.preview_location(location, opts)
   return M.open_floating_preview(contents, syntax, opts)
 end
 
----@private
 local function find_window_by_var(name, value)
   for _, win in ipairs(api.nvim_list_wins()) do
     if npcall(api.nvim_win_get_var, win, name) == value then
@@ -1305,7 +1287,6 @@ end
 --- Generates a table mapping markdown code block lang to vim syntax,
 --- based on g:markdown_fenced_languages
 ---@return table table of lang -> syntax mappings
----@private
 local function get_markdown_fences()
   local fences = {}
   for _, fence in pairs(vim.g.markdown_fenced_languages or {}) do
@@ -1460,7 +1441,6 @@ function M.stylize_markdown(bufnr, contents, opts)
   api.nvim_buf_set_lines(bufnr, 0, -1, false, stripped)
 
   local idx = 1
-  ---@private
   -- keep track of syntaxes we already included.
   -- no need to include the same syntax more than once
   local langs = {}
@@ -1521,7 +1501,6 @@ function M.stylize_markdown(bufnr, contents, opts)
   return stripped
 end
 
----@private
 --- Closes the preview window
 ---
 ---@param winnr integer window id of preview window
@@ -1539,7 +1518,6 @@ local function close_preview_window(winnr, bufnrs)
   end)
 end
 
----@private
 --- Creates autocommands to close a preview window when events happen.
 ---
 ---@param events table list of events
@@ -1905,7 +1883,6 @@ end
 ---
 ---@param symbols table DocumentSymbol[] or SymbolInformation[]
 function M.symbols_to_items(symbols, bufnr)
-  ---@private
   local function _symbols_to_items(_symbols, _items, _bufnr)
     for _, symbol in ipairs(_symbols) do
       if symbol.location then -- SymbolInformation type
@@ -1991,7 +1968,6 @@ function M.try_trim_markdown_code_blocks(lines)
   return 'markdown'
 end
 
----@private
 ---@param window integer|nil: window handle or 0 for current, defaults to current
 ---@param offset_encoding string utf-8|utf-16|utf-32|nil defaults to `offset_encoding` of first client of buffer of `window`
 local function make_position_param(window, offset_encoding)
@@ -2209,6 +2185,7 @@ end
 
 M._get_line_byte_from_position = get_line_byte_from_position
 
+---@nodoc
 M.buf_versions = {}
 
 return M
diff --git a/runtime/lua/vim/secure.lua b/runtime/lua/vim/secure.lua
index 1a04e11231..837738c041 100644
--- a/runtime/lua/vim/secure.lua
+++ b/runtime/lua/vim/secure.lua
@@ -1,6 +1,5 @@
 local M = {}
 
----@private
 --- Reads trust database from $XDG_STATE_HOME/nvim/trust.
 ---
 ---@return (table) Contents of trust database, if it exists. Empty table otherwise.
@@ -22,7 +21,6 @@ local function read_trust()
   return trust
 end
 
----@private
 --- Writes provided {trust} table to trust database at
 --- $XDG_STATE_HOME/nvim/trust.
 ---
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index dd05299295..291b003d87 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -8,6 +8,45 @@
 
 vim = vim or {}
 
+local function _id(v)
+  return v
+end
+
+local deepcopy
+
+local deepcopy_funcs = {
+  table = function(orig, cache)
+    if cache[orig] then
+      return cache[orig]
+    end
+    local copy = {}
+
+    cache[orig] = copy
+    local mt = getmetatable(orig)
+    for k, v in pairs(orig) do
+      copy[deepcopy(k, cache)] = deepcopy(v, cache)
+    end
+    return setmetatable(copy, mt)
+  end,
+  number = _id,
+  string = _id,
+  ['nil'] = _id,
+  boolean = _id,
+  ['function'] = _id,
+}
+
+deepcopy = function(orig, _cache)
+  local f = deepcopy_funcs[type(orig)]
+  if f then
+    return f(orig, _cache or {})
+  else
+    if type(orig) == 'userdata' and orig == vim.NIL then
+      return vim.NIL
+    end
+    error('Cannot deepcopy object of type ' .. type(orig))
+  end
+end
+
 --- Returns a deep copy of the given object. Non-table objects are copied as
 --- in a typical Lua assignment, whereas table objects are copied recursively.
 --- Functions are naively copied, so functions in the copied table point to the
@@ -17,45 +56,9 @@ vim = vim or {}
 ---@generic T: table
 ---@param orig T Table to copy
 ---@return T Table of copied keys and (nested) values.
-function vim.deepcopy(orig) end -- luacheck: no unused
-vim.deepcopy = (function()
-  local function _id(v)
-    return v
-  end
-
-  local deepcopy_funcs = {
-    table = function(orig, cache)
-      if cache[orig] then
-        return cache[orig]
-      end
-      local copy = {}
-
-      cache[orig] = copy
-      local mt = getmetatable(orig)
-      for k, v in pairs(orig) do
-        copy[vim.deepcopy(k, cache)] = vim.deepcopy(v, cache)
-      end
-      return setmetatable(copy, mt)
-    end,
-    number = _id,
-    string = _id,
-    ['nil'] = _id,
-    boolean = _id,
-    ['function'] = _id,
-  }
-
-  return function(orig, cache)
-    local f = deepcopy_funcs[type(orig)]
-    if f then
-      return f(orig, cache or {})
-    else
-      if type(orig) == 'userdata' and orig == vim.NIL then
-        return vim.NIL
-      end
-      error('Cannot deepcopy object of type ' .. type(orig))
-    end
-  end
-end)()
+function vim.deepcopy(orig)
+  return deepcopy(orig)
+end
 
 --- Splits a string at each instance of a separator.
 ---
@@ -318,7 +321,6 @@ function vim.tbl_isempty(t)
 end
 
 --- We only merge empty tables or tables that are not an array (indexed by integers)
----@private
 local function can_merge(v)
   return type(v) == 'table' and (vim.tbl_isempty(v) or not vim.tbl_isarray(v))
 end
@@ -770,7 +772,6 @@ do
     return type(val) == t or (t == 'callable' and vim.is_callable(val))
   end
 
-  ---@private
   local function is_valid(opt)
     if type(opt) ~= 'table' then
       return false, string.format('opt: expected table, got %s', type(opt))
diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 5526c9858c..8bd85d3734 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -39,7 +39,10 @@ local M = setmetatable({}, {
   end,
 })
 
+--- @nodoc
 M.language_version = vim._ts_get_language_version()
+
+--- @nodoc
 M.minimum_language_version = vim._ts_get_minimum_language_version()
 
 --- Creates a new parser
@@ -60,12 +63,10 @@ function M._create_parser(bufnr, lang, opts)
 
   local self = LanguageTree.new(bufnr, lang, opts)
 
-  ---@private
   local function bytes_cb(_, ...)
     self:_on_bytes(...)
   end
 
-  ---@private
   local function detach_cb(_, ...)
     if parsers[bufnr] == self then
       parsers[bufnr] = nil
@@ -73,7 +74,6 @@ function M._create_parser(bufnr, lang, opts)
     self:_on_detach(...)
   end
 
-  ---@private
   local function reload_cb(_)
     self:_on_reload()
   end
@@ -91,7 +91,6 @@ function M._create_parser(bufnr, lang, opts)
   return self
 end
 
---- @private
 local function valid_lang(lang)
   return lang and lang ~= ''
 end
@@ -205,7 +204,6 @@ function M.get_range(node, source, metadata)
   return { node:range(true) }
 end
 
----@private
 ---@param buf integer
 ---@param range Range
 ---@returns string
diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index 99cd147658..1bb5a08205 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -42,7 +42,6 @@ local TSTreeView = {}
 ---@param injections table<integer,TSP.Node> Mapping of node ids to root nodes of injected language trees (see
 ---                        explanation above)
 ---@param tree TSP.Node[] Output table containing a list of tables each representing a node in the tree
----@private
 local function traverse(node, depth, lang, injections, tree)
   local injection = injections[node:id()]
   if injection then
@@ -141,7 +140,6 @@ end
 
 local decor_ns = api.nvim_create_namespace('ts.dev')
 
----@private
 ---@param lnum integer
 ---@param col integer
 ---@param end_lnum integer
diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index d4db6bc404..f8ec5b175d 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -17,6 +17,7 @@ local query = vim.treesitter.query
 local TSHighlighter = rawget(vim.treesitter, 'TSHighlighter') or {}
 TSHighlighter.__index = TSHighlighter
 
+--- @nodoc
 TSHighlighter.active = TSHighlighter.active or {}
 
 ---@class TSHighlighterQuery
@@ -205,7 +206,6 @@ function TSHighlighter:get_query(lang)
   return self._queries[lang]
 end
 
----@private
 ---@param self TSHighlighter
 ---@param buf integer
 ---@param line integer
diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index 08c297c9ad..9695e2c41c 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -104,7 +104,6 @@ function M.add(lang, opts)
   vim._ts_add_language(path, lang, symbol_name)
 end
 
---- @private
 --- @param x string|string[]
 --- @return string[]
 local function ensure_list(x)
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index bf6333aaa4..0d4a1a54dd 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -164,7 +164,6 @@ function LanguageTree:_set_logger()
   self._parser:_set_logger(log_lex, log_parse, self._logger)
 end
 
----@private
 ---Measure execution time of a function
 ---@generic R1, R2, R3
 ---@param f fun(): R1, R2, R2
@@ -444,7 +443,6 @@ function LanguageTree:destroy()
   end
 end
 
----@private
 ---@param region Range6[]
 local function region_tostr(region)
   if #region == 0 then
@@ -560,7 +558,6 @@ function LanguageTree:included_regions()
   return regions
 end
 
----@private
 ---@param node TSNode
 ---@param source string|integer
 ---@param metadata TSMetadata
@@ -600,7 +597,6 @@ end
 
 ---@alias TSInjection table<string,table<integer,TSInjectionElem>>
 
----@private
 ---@param t table<integer,TSInjection>
 ---@param tree_index integer
 ---@param pattern integer
@@ -963,7 +959,6 @@ function LanguageTree:register_cbs(cbs, recursive)
   end
 end
 
----@private
 ---@param tree TSTree
 ---@param range Range
 ---@return boolean
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 7610ef7b7f..08186468a5 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -15,7 +15,6 @@ Query.__index = Query
 ---@class TSQueryModule
 local M = {}
 
----@private
 ---@param files string[]
 ---@return string[]
 local function dedupe_files(files)
@@ -33,7 +32,6 @@ local function dedupe_files(files)
   return result
 end
 
----@private
 local function safe_read(filename, read_quantifier)
   local file, err = io.open(filename, 'r')
   if not file then
@@ -44,7 +42,6 @@ local function safe_read(filename, read_quantifier)
   return content
 end
 
----@private
 --- Adds {ilang} to {base_langs}, only if {ilang} is different than {lang}
 ---
 ---@return boolean true If lang == ilang
@@ -153,7 +150,6 @@ function M.get_files(lang, query_name, is_included)
   return query_files
 end
 
----@private
 ---@param filenames string[]
 ---@return string
 local function read_query_files(filenames)
@@ -335,7 +331,6 @@ local predicate_handlers = {
 
   ['match?'] = (function()
     local magic_prefixes = { ['\\v'] = true, ['\\m'] = true, ['\\M'] = true, ['\\V'] = true }
-    ---@private
     local function check_magic(str)
       if string.len(str) < 2 or magic_prefixes[string.sub(str, 1, 2)] then
         return str
@@ -624,12 +619,10 @@ function M.list_predicates()
   return vim.tbl_keys(predicate_handlers)
 end
 
----@private
 local function xor(x, y)
   return (x or y) and not (x and y)
 end
 
----@private
 local function is_directive(name)
   return string.sub(name, -1) == '!'
 end
@@ -700,7 +693,6 @@ end
 --- Returns the start and stop value if set else the node's range.
 -- When the node's range is used, the stop is incremented by 1
 -- to make the search inclusive.
----@private
 ---@param start integer
 ---@param stop integer
 ---@param node TSNode
@@ -750,7 +742,6 @@ function Query:iter_captures(node, source, start, stop)
   start, stop = value_or_node_range(start, stop, node)
 
   local raw_iter = node:_rawquery(self.query, true, start, stop)
-  ---@private
   local function iter()
     local capture, captured_node, match = raw_iter()
     local metadata = {}
diff --git a/runtime/lua/vim/uri.lua b/runtime/lua/vim/uri.lua
index dec7840eb0..eaa64a6fad 100644
--- a/runtime/lua/vim/uri.lua
+++ b/runtime/lua/vim/uri.lua
@@ -8,7 +8,6 @@ do
   local schar = string.char
 
   --- Convert hex to char
-  ---@private
   local function hex_to_char(hex)
     return schar(tonumber(hex, 16))
   end
@@ -33,7 +32,6 @@ do
   local sbyte = string.byte
   local tohex = require('bit').tohex
 
-  ---@private
   local function percent_encode_char(char)
     return '%' .. tohex(sbyte(char), 2)
   end
@@ -46,15 +44,16 @@ do
   end
 end
 
----@private
 local function is_windows_file_uri(uri)
   return uri:match('^file:/+[a-zA-Z]:') ~= nil
 end
 
+local M = {}
+
 --- Get a URI from a file path.
 ---@param path string Path to file
 ---@return string URI
-local function uri_from_fname(path)
+function M.uri_from_fname(path)
   local volume_path, fname = path:match('^([a-zA-Z]:)(.*)')
   local is_windows = volume_path ~= nil
   if is_windows then
@@ -76,7 +75,7 @@ local WINDOWS_URI_SCHEME_PATTERN = '^([a-zA-Z]+[a-zA-Z0-9.+-]*):[a-zA-Z]:.*'
 --- Get a URI from a bufnr
 ---@param bufnr integer
 ---@return string URI
-local function uri_from_bufnr(bufnr)
+function M.uri_from_bufnr(bufnr)
   local fname = vim.api.nvim_buf_get_name(bufnr)
   local volume_path = fname:match('^([a-zA-Z]:).*')
   local is_windows = volume_path ~= nil
@@ -90,14 +89,14 @@ local function uri_from_bufnr(bufnr)
   if scheme then
     return fname
   else
-    return uri_from_fname(fname)
+    return M.uri_from_fname(fname)
   end
 end
 
 --- Get a filename from a URI
 ---@param uri string
 ---@return string filename or unchanged URI for non-file URIs
-local function uri_to_fname(uri)
+function M.uri_to_fname(uri)
   local scheme = assert(uri:match(URI_SCHEME_PATTERN), 'URI must contain a scheme: ' .. uri)
   if scheme ~= 'file' then
     return uri
@@ -118,13 +117,8 @@ end
 --
 ---@param uri string
 ---@return integer bufnr
-local function uri_to_bufnr(uri)
-  return vim.fn.bufadd(uri_to_fname(uri))
+function M.uri_to_bufnr(uri)
+  return vim.fn.bufadd(M.uri_to_fname(uri))
 end
 
-return {
-  uri_from_fname = uri_from_fname,
-  uri_from_bufnr = uri_from_bufnr,
-  uri_to_fname = uri_to_fname,
-  uri_to_bufnr = uri_to_bufnr,
-}
+return M
diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index 8ff8a19cb9..96889438eb 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -65,8 +65,6 @@ local M = {}
 local Version = {}
 Version.__index = Version
 
---- @private
----
 --- Compares prerelease strings: per semver, number parts must be must be treated as numbers:
 --- "pre1.10" is greater than "pre1.2". https://semver.org/#spec-item-11
 local function cmp_prerel(prerel1, prerel2)
@@ -332,7 +330,6 @@ function M.range(spec) -- Adapted from https://github.com/folke/lazy.nvim
   end
 end
 
----@private
 ---@param v string|Version
 ---@return string
 local function create_err_msg(v)
-- 
cgit 


From 2f22ed6a00db10c4852a8fa232b8782f8b6a6646 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Wed, 19 Jul 2023 07:10:11 +0200
Subject: feat(lsp): handle multiple clients in omnifunc (#24381)

Also fixes https://github.com/neovim/neovim/issues/24369 by adding an
extra `vim.schedule` to ensure the `vim.fn.complete` call happens
outside of a luv callback
---
 runtime/lua/vim/lsp.lua | 88 ++++++++++++++++++++++++++++++-------------------
 1 file changed, 54 insertions(+), 34 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 35e4bc9dd8..65cce6af47 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -2268,8 +2268,9 @@ function lsp.omnifunc(findstart, base)
   end
 
   local bufnr = resolve_bufnr()
-  local has_buffer_clients = not tbl_isempty(all_buffer_active_clients[bufnr] or {})
-  if not has_buffer_clients then
+  local clients = lsp.get_clients({ bufnr = bufnr, method = 'textDocument/completion' })
+  local remaining = #clients
+  if remaining == 0 then
     return findstart == 1 and -1 or {}
   end
 
@@ -2278,47 +2279,66 @@ function lsp.omnifunc(findstart, base)
     log.info('base ', base)
   end
 
-  local pos = api.nvim_win_get_cursor(0)
+  local win = api.nvim_get_current_win()
+  local pos = api.nvim_win_get_cursor(win)
   local line = api.nvim_get_current_line()
   local line_to_cursor = line:sub(1, pos[2])
   local _ = log.trace() and log.trace('omnifunc.line', pos, line)
 
   -- Get the start position of the current keyword
-  local textMatch = vim.fn.match(line_to_cursor, '\\k*$')
+  local match_pos = vim.fn.match(line_to_cursor, '\\k*$') + 1
+  local items = {}
 
-  local params = util.make_position_params()
+  local startbyte
 
-  local items = {}
-  lsp.buf_request(bufnr, 'textDocument/completion', params, function(err, result, ctx)
-    if err or not result or vim.fn.mode() ~= 'i' then
-      return
+  ---@private
+  local function on_done()
+    local mode = api.nvim_get_mode()['mode']
+    if mode == 'i' or mode == 'ic' then
+      vim.fn.complete(startbyte or match_pos, items)
     end
+  end
 
-    -- Completion response items may be relative to a position different than `textMatch`.
-    -- Concrete example, with sumneko/lua-language-server:
-    --
-    -- require('plenary.asy|
-    --         ▲       ▲   ▲
-    --         │       │   └── cursor_pos: 20
-    --         │       └────── textMatch: 17
-    --         └────────────── textEdit.range.start.character: 9
-    --                                 .newText = 'plenary.async'
-    --                  ^^^
-    --                  prefix (We'd remove everything not starting with `asy`,
-    --                  so we'd eliminate the `plenary.async` result
-    --
-    -- `adjust_start_col` is used to prefer the language server boundary.
-    --
-    local client = lsp.get_client_by_id(ctx.client_id)
-    local encoding = client and client.offset_encoding or 'utf-16'
-    local candidates = util.extract_completion_items(result)
-    local startbyte = adjust_start_col(pos[1], line, candidates, encoding) or textMatch
-    local prefix = line:sub(startbyte + 1, pos[2])
-    local matches = util.text_document_completion_list_to_complete_items(result, prefix)
-    -- TODO(ashkan): is this the best way to do this?
-    vim.list_extend(items, matches)
-    vim.fn.complete(startbyte + 1, items)
-  end)
+  for _, client in ipairs(clients) do
+    local params = util.make_position_params(win, client.offset_encoding)
+    client.request('textDocument/completion', params, function(err, result)
+      if err then
+        log.warn(err.message)
+      end
+      if result and vim.fn.mode() == 'i' then
+        -- Completion response items may be relative to a position different than `textMatch`.
+        -- Concrete example, with sumneko/lua-language-server:
+        --
+        -- require('plenary.asy|
+        --         ▲       ▲   ▲
+        --         │       │   └── cursor_pos: 20
+        --         │       └────── textMatch: 17
+        --         └────────────── textEdit.range.start.character: 9
+        --                                 .newText = 'plenary.async'
+        --                  ^^^
+        --                  prefix (We'd remove everything not starting with `asy`,
+        --                  so we'd eliminate the `plenary.async` result
+        --
+        -- `adjust_start_col` is used to prefer the language server boundary.
+        --
+        local encoding = client.offset_encoding
+        local candidates = util.extract_completion_items(result)
+        local curstartbyte = adjust_start_col(pos[1], line, candidates, encoding)
+        if startbyte == nil then
+          startbyte = curstartbyte
+        elseif curstartbyte ~= nil and curstartbyte ~= startbyte then
+          startbyte = match_pos
+        end
+        local prefix = startbyte and line:sub(startbyte + 1) or line_to_cursor:sub(match_pos)
+        local matches = util.text_document_completion_list_to_complete_items(result, prefix)
+        vim.list_extend(items, matches)
+      end
+      remaining = remaining - 1
+      if remaining == 0 then
+        vim.schedule(on_done)
+      end
+    end, bufnr)
+  end
 
   -- Return -2 to signal that we should continue completion so that we can
   -- async complete.
-- 
cgit 


From 86ce3878d662c1dbfec61a5ad8e7c16c4283ed5c Mon Sep 17 00:00:00 2001
From: futsuuu <105504350+futsuuu@users.noreply.github.com>
Date: Thu, 20 Jul 2023 01:55:35 +0900
Subject: docs(lua): clarify fs.find() documentation #24394

---
 runtime/lua/vim/fs.lua | 54 ++++++++++++++++++++++++--------------------------
 1 file changed, 26 insertions(+), 28 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index 842767098c..92966523c0 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -2,7 +2,7 @@ local M = {}
 
 local iswin = vim.uv.os_uname().sysname == 'Windows_NT'
 
---- Iterate over all the parents of the given file or directory.
+--- Iterate over all the parents of the given path.
 ---
 --- Example:
 --- <pre>lua
@@ -19,7 +19,7 @@ local iswin = vim.uv.os_uname().sysname == 'Windows_NT'
 --- end
 --- </pre>
 ---
----@param start (string) Initial file or directory.
+---@param start (string) Initial path.
 ---@return function Iterator
 function M.parents(start)
   return function(_, dir)
@@ -34,9 +34,9 @@ function M.parents(start)
     start
 end
 
---- Return the parent directory of the given file or directory
+--- Return the parent directory of the given path
 ---
----@param file (string) File or directory
+---@param file (string) Path
 ---@return string|nil Parent directory of {file}
 function M.dirname(file)
   if file == nil then
@@ -57,9 +57,9 @@ function M.dirname(file)
   return (dir:gsub('\\', '/'))
 end
 
---- Return the basename of the given file or directory
+--- Return the basename of the given path
 ---
----@param file string File or directory
+---@param file string Path
 ---@return string|nil Basename of {file}
 function M.basename(file)
   if file == nil then
@@ -83,7 +83,7 @@ end
 
 ---@alias Iterator fun(): string?, string?
 
---- Return an iterator over the files and directories located in {path}
+--- Return an iterator over the items located in {path}
 ---
 ---@param path (string) An absolute or relative path to the directory to iterate
 ---            over. The path is first normalized |vim.fs.normalize()|.
@@ -93,9 +93,10 @@ end
 ---               to control traversal. Return false to stop searching the current directory.
 ---               Only useful when depth > 1
 ---
----@return Iterator over files and directories in {path}. Each iteration yields
----        two values: name and type. Each "name" is the basename of the file or
----        directory relative to {path}. Type is one of "file" or "directory".
+---@return Iterator over items in {path}. Each iteration yields two values: "name" and "type".
+---        "name" is the basename of the item relative to {path}.
+---        "type" is one of the following:
+---        "file", "directory", "link", "fifo", "socket", "char", "block", "unknown".
 function M.dir(path, opts)
   opts = opts or {}
 
@@ -142,16 +143,16 @@ function M.dir(path, opts)
   end)
 end
 
---- Find files or directories in the given path.
+--- Find files or directories (or other items as specified by `opts.type`) in the given path.
 ---
---- Finds any files or directories given in {names} starting from {path}. If
---- {upward} is "true" then the search traverses upward through parent
---- directories; otherwise, the search traverses downward. Note that downward
---- searches are recursive and may search through many directories! If {stop}
---- is non-nil, then the search stops when the directory given in {stop} is
---- reached. The search terminates when {limit} (default 1) matches are found.
---- The search can be narrowed to find only files or only directories by
---- specifying {type} to be "file" or "directory", respectively.
+--- Finds items given in {names} starting from {path}. If {upward} is "true"
+--- then the search traverses upward through parent directories; otherwise,
+--- the search traverses downward. Note that downward searches are recursive
+--- and may search through many directories! If {stop} is non-nil, then the
+--- search stops when the directory given in {stop} is reached. The search
+--- terminates when {limit} (default 1) matches are found. You can set {type}
+--- to "file", "directory", "link", "socket", "char", "block", or "fifo"
+--- to narrow the search to find only that type.
 ---
 --- Examples:
 --- <pre>lua
@@ -174,13 +175,12 @@ end
 --- end, {limit = math.huge, type = 'file'})
 --- </pre>
 ---
----@param names (string|table|fun(name: string, path: string): boolean) Names of the files
----             and directories to find.
+---@param names (string|table|fun(name: string, path: string): boolean) Names of the items to find.
 ---             Must be base names, paths and globs are not supported when {names} is a string or a table.
----             If {names} is a function, it is called for each traversed file and directory with args:
+---             If {names} is a function, it is called for each traversed item with args:
 ---             - name: base name of the current item
 ---             - path: full path of the current item
----             The function should return `true` if the given file or directory is considered a match.
+---             The function should return `true` if the given item is considered a match.
 ---
 ---@param opts (table) Optional keyword arguments:
 ---                       - path (string): Path to begin searching from. If
@@ -191,14 +191,12 @@ end
 ---                                (recursively).
 ---                       - stop (string): Stop searching when this directory is
 ---                              reached. The directory itself is not searched.
----                       - type (string): Find only files ("file") or
----                              directories ("directory"). If omitted, both
----                              files and directories that match {names} are
----                              included.
+---                       - type (string): Find only items of the given type.
+---                               If omitted, all items that match {names} are included.
 ---                       - limit (number, default 1): Stop the search after
 ---                               finding this many matches. Use `math.huge` to
 ---                               place no limit on the number of matches.
----@return (table) Normalized paths |vim.fs.normalize()| of all matching files or directories
+---@return (table) Normalized paths |vim.fs.normalize()| of all matching items
 function M.find(names, opts)
   opts = opts or {}
   vim.validate({
-- 
cgit 


From 63b3408551561127f7845470eb51404bcd6f547b Mon Sep 17 00:00:00 2001
From: Chris AtLee <chris@atlee.ca>
Date: Thu, 20 Jul 2023 03:03:48 -0400
Subject: feat(lsp): implement textDocument/diagnostic (#24128)

---
 runtime/lua/vim/lsp.lua            |  22 ++++-
 runtime/lua/vim/lsp/diagnostic.lua | 187 ++++++++++++++++++++++++++++++++++---
 runtime/lua/vim/lsp/handlers.lua   |   4 +
 runtime/lua/vim/lsp/inlay_hint.lua |  77 ++++-----------
 runtime/lua/vim/lsp/protocol.lua   |   3 +
 runtime/lua/vim/lsp/util.lua       |  40 ++++++++
 6 files changed, 263 insertions(+), 70 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 65cce6af47..fa2a888a54 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -61,6 +61,7 @@ lsp._request_name_to_capability = {
   ['textDocument/semanticTokens/full'] = { 'semanticTokensProvider' },
   ['textDocument/semanticTokens/full/delta'] = { 'semanticTokensProvider' },
   ['textDocument/inlayHint'] = { 'inlayHintProvider' },
+  ['textDocument/diagnostic'] = { 'diagnosticProvider' },
   ['inlayHint/resolve'] = { 'inlayHintProvider', 'resolveProvider' },
 }
 
@@ -954,6 +955,9 @@ function lsp._set_defaults(client, bufnr)
       vim.keymap.set('n', 'K', vim.lsp.buf.hover, { buffer = bufnr })
     end
   end)
+  if client.supports_method('textDocument/diagnostic') then
+    lsp.diagnostic._enable(bufnr)
+  end
 end
 
 --- @class lsp.ClientConfig
@@ -1567,7 +1571,23 @@ function lsp.start_client(config)
     if method ~= 'textDocument/didChange' then
       changetracking.flush(client)
     end
-    return rpc.notify(method, params)
+
+    local result = rpc.notify(method, params)
+
+    if result then
+      vim.schedule(function()
+        nvim_exec_autocmds('LspNotify', {
+          modeline = false,
+          data = {
+            client_id = client.id,
+            method = method,
+            params = params,
+          },
+        })
+      end)
+    end
+
+    return result
   end
 
   ---@private
diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index c2cf7c6ba5..34be13096d 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -1,9 +1,14 @@
 ---@brief lsp-diagnostic
 
+local util = require('vim.lsp.util')
 local protocol = require('vim.lsp.protocol')
 
+local api = vim.api
+
 local M = {}
 
+local augroup = api.nvim_create_augroup('vim_lsp_diagnostic', {})
+
 local DEFAULT_CLIENT_ID = -1
 
 local function get_client_id(client_id)
@@ -154,19 +159,43 @@ local function diagnostic_vim_to_lsp(diagnostics)
 end
 
 ---@type table<integer,integer>
-local _client_namespaces = {}
+local _client_push_namespaces = {}
+---@type table<integer,integer>
+local _client_pull_namespaces = {}
 
---- Get the diagnostic namespace associated with an LSP client |vim.diagnostic|.
+--- Get the diagnostic namespace associated with an LSP client |vim.diagnostic| for diagnostics
 ---
 ---@param client_id integer The id of the LSP client
-function M.get_namespace(client_id)
+---@param is_pull boolean Whether the namespace is for a pull or push client
+function M.get_namespace(client_id, is_pull)
   vim.validate({ client_id = { client_id, 'n' } })
-  if not _client_namespaces[client_id] then
-    local client = vim.lsp.get_client_by_id(client_id)
-    local name = string.format('vim.lsp.%s.%d', client and client.name or 'unknown', client_id)
-    _client_namespaces[client_id] = vim.api.nvim_create_namespace(name)
+
+  local namespace_table
+  local key
+  local name
+  local client = vim.lsp.get_client_by_id(client_id)
+
+  if is_pull then
+    namespace_table = _client_pull_namespaces
+    local server_id = vim.tbl_get(client.server_capabilities, 'diagnosticProvider', 'identifier')
+    key = string.format('%d:%s', client_id, server_id or 'nil')
+    name = string.format(
+      'vim.lsp.%s.%d.%s',
+      client and client.name or 'unknown',
+      client_id,
+      server_id or 'nil'
+    )
+  else
+    namespace_table = _client_push_namespaces
+    key = client_id
+    name = string.format('vim.lsp.%s.%d', client and client.name or 'unknown', client_id)
   end
-  return _client_namespaces[client_id]
+
+  if not namespace_table[key] then
+    namespace_table[key] = api.nvim_create_namespace(name)
+  end
+
+  return namespace_table[key]
 end
 
 --- |lsp-handler| for the method "textDocument/publishDiagnostics"
@@ -209,7 +238,7 @@ function M.on_publish_diagnostics(_, result, ctx, config)
   end
 
   client_id = get_client_id(client_id)
-  local namespace = M.get_namespace(client_id)
+  local namespace = M.get_namespace(client_id, false)
 
   if config then
     for _, opt in pairs(config) do
@@ -229,7 +258,75 @@ function M.on_publish_diagnostics(_, result, ctx, config)
   vim.diagnostic.set(namespace, bufnr, diagnostic_lsp_to_vim(diagnostics, bufnr, client_id))
 end
 
---- Clear diagnostics and diagnostic cache.
+--- |lsp-handler| for the method "textDocument/diagnostic"
+---
+--- See |vim.diagnostic.config()| for configuration options. Handler-specific
+--- configuration can be set using |vim.lsp.with()|:
+--- <pre>lua
+--- vim.lsp.handlers["textDocument/diagnostic"] = vim.lsp.with(
+---   vim.lsp.diagnostic.on_diagnostic, {
+---     -- Enable underline, use default values
+---     underline = true,
+---     -- Enable virtual text, override spacing to 4
+---     virtual_text = {
+---       spacing = 4,
+---     },
+---     -- Use a function to dynamically turn signs off
+---     -- and on, using buffer local variables
+---     signs = function(namespace, bufnr)
+---       return vim.b[bufnr].show_signs == true
+---     end,
+---     -- Disable a feature
+---     update_in_insert = false,
+---   }
+--- )
+--- </pre>
+---
+---@param config table Configuration table (see |vim.diagnostic.config()|).
+function M.on_diagnostic(_, result, ctx, config)
+  local client_id = ctx.client_id
+  local uri = ctx.params.textDocument.uri
+  local fname = vim.uri_to_fname(uri)
+
+  if result == nil then
+    return
+  end
+
+  if result.kind == 'unchanged' then
+    return
+  end
+
+  local diagnostics = result.items
+  if #diagnostics == 0 and vim.fn.bufexists(fname) == 0 then
+    return
+  end
+  local bufnr = vim.fn.bufadd(fname)
+
+  if not bufnr then
+    return
+  end
+
+  client_id = get_client_id(client_id)
+
+  local namespace = M.get_namespace(client_id, true)
+
+  if config then
+    for _, opt in pairs(config) do
+      if type(opt) == 'table' and not opt.severity and opt.severity_limit then
+        opt.severity = { min = severity_lsp_to_vim(opt.severity_limit) }
+      end
+    end
+
+    -- Persist configuration to ensure buffer reloads use the same
+    -- configuration. To make lsp.with configuration work (See :help
+    -- lsp-handler-configuration)
+    vim.diagnostic.config(config, namespace)
+  end
+
+  vim.diagnostic.set(namespace, bufnr, diagnostic_lsp_to_vim(diagnostics, bufnr, client_id))
+end
+
+--- Clear push diagnostics and diagnostic cache.
 ---
 --- Diagnostic producers should prefer |vim.diagnostic.reset()|. However,
 --- this method signature is still used internally in some parts of the LSP
@@ -243,7 +340,7 @@ function M.reset(client_id, buffer_client_map)
   vim.schedule(function()
     for bufnr, client_ids in pairs(buffer_client_map) do
       if client_ids[client_id] then
-        local namespace = M.get_namespace(client_id)
+        local namespace = M.get_namespace(client_id, false)
         vim.diagnostic.reset(namespace, bufnr)
       end
     end
@@ -275,7 +372,7 @@ function M.get_line_diagnostics(bufnr, line_nr, opts, client_id)
   end
 
   if client_id then
-    opts.namespace = M.get_namespace(client_id)
+    opts.namespace = M.get_namespace(client_id, false)
   end
 
   if not line_nr then
@@ -287,4 +384,70 @@ function M.get_line_diagnostics(bufnr, line_nr, opts, client_id)
   return diagnostic_vim_to_lsp(vim.diagnostic.get(bufnr, opts))
 end
 
+--- Clear diagnostics from pull based clients
+--- @private
+local function clear(bufnr)
+  for _, namespace in pairs(_client_pull_namespaces) do
+    vim.diagnostic.reset(namespace, bufnr)
+  end
+end
+
+--- autocmd ids for LspNotify handlers per buffer
+--- @private
+--- @type table<integer,integer>
+local _autocmd_ids = {}
+
+--- Disable pull diagnostics for a buffer
+--- @private
+local function disable(bufnr)
+  if not _autocmd_ids[bufnr] then
+    return
+  end
+  api.nvim_del_autocmd(_autocmd_ids[bufnr])
+  _autocmd_ids[bufnr] = nil
+  clear(bufnr)
+end
+
+--- Enable pull diagnostics for a buffer
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@private
+function M._enable(bufnr)
+  if bufnr == nil or bufnr == 0 then
+    bufnr = api.nvim_get_current_buf()
+  end
+
+  if _autocmd_ids[bufnr] then
+    return
+  end
+
+  _autocmd_ids[bufnr] = api.nvim_create_autocmd('LspNotify', {
+    buffer = bufnr,
+    callback = function(opts)
+      if opts.data.method ~= 'textDocument/didChange' then
+        return
+      end
+      util._refresh('textDocument/diagnostic', { bufnr = bufnr, only_visible = true })
+    end,
+    group = augroup,
+  })
+
+  api.nvim_buf_attach(bufnr, false, {
+    on_reload = function()
+      util._refresh('textDocument/diagnostic', { bufnr = bufnr })
+    end,
+    on_detach = function()
+      disable(bufnr)
+    end,
+  })
+
+  api.nvim_create_autocmd('LspDetach', {
+    buffer = bufnr,
+    callback = function()
+      disable(bufnr)
+    end,
+    once = true,
+    group = augroup,
+  })
+end
+
 return M
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index ce3db68618..d887183972 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -214,6 +214,10 @@ M['textDocument/publishDiagnostics'] = function(...)
   return require('vim.lsp.diagnostic').on_publish_diagnostics(...)
 end
 
+M['textDocument/diagnostic'] = function(...)
+  return require('vim.lsp.diagnostic').on_diagnostic(...)
+end
+
 M['textDocument/codeLens'] = function(...)
   return require('vim.lsp.codelens').on_codelens(...)
 end
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index bec6f33e93..1c29e8a866 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -87,54 +87,6 @@ function M.on_inlayhint(err, result, ctx, _)
   api.nvim__buf_redraw_range(bufnr, 0, -1)
 end
 
-local function resolve_bufnr(bufnr)
-  return bufnr > 0 and bufnr or api.nvim_get_current_buf()
-end
-
---- Refresh inlay hints for a buffer
----
----@param opts (nil|table) Optional arguments
----  - bufnr (integer, default: 0): Buffer whose hints to refresh
----  - only_visible (boolean, default: false): Whether to only refresh hints for the visible regions of the buffer
----
-local function refresh(opts)
-  opts = opts or {}
-  local bufnr = resolve_bufnr(opts.bufnr or 0)
-  local bufstate = bufstates[bufnr]
-  if not (bufstate and bufstate.enabled) then
-    return
-  end
-  local only_visible = opts.only_visible or false
-  local buffer_windows = {}
-  for _, winid in ipairs(api.nvim_list_wins()) do
-    if api.nvim_win_get_buf(winid) == bufnr then
-      table.insert(buffer_windows, winid)
-    end
-  end
-  for _, window in ipairs(buffer_windows) do
-    local first = vim.fn.line('w0', window)
-    local last = vim.fn.line('w$', window)
-    local params = {
-      textDocument = util.make_text_document_params(bufnr),
-      range = {
-        start = { line = first - 1, character = 0 },
-        ['end'] = { line = last, character = 0 },
-      },
-    }
-    vim.lsp.buf_request(bufnr, 'textDocument/inlayHint', params)
-  end
-  if not only_visible then
-    local params = {
-      textDocument = util.make_text_document_params(bufnr),
-      range = {
-        start = { line = 0, character = 0 },
-        ['end'] = { line = api.nvim_buf_line_count(bufnr), character = 0 },
-      },
-    }
-    vim.lsp.buf_request(bufnr, 'textDocument/inlayHint', params)
-  end
-end
-
 --- |lsp-handler| for the method `textDocument/inlayHint/refresh`
 ---@private
 function M.on_refresh(err, _, ctx, _)
@@ -144,8 +96,11 @@ 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
-        refresh({ bufnr = bufnr })
-        break
+        local bufstate = bufstates[bufnr]
+        if bufstate and bufstate.enabled then
+          util._refresh('textDocument/inlayHint', { bufnr = bufnr })
+          break
+        end
       end
     end
   end
@@ -156,7 +111,9 @@ end
 --- Clear inlay hints
 ---@param bufnr (integer) Buffer handle, or 0 for current
 local function clear(bufnr)
-  bufnr = resolve_bufnr(bufnr)
+  if bufnr == nil or bufnr == 0 then
+    bufnr = api.nvim_get_current_buf()
+  end
   if not bufstates[bufnr] then
     return
   end
@@ -175,17 +132,19 @@ end
 
 local function make_request(request_bufnr)
   reset_timer(request_bufnr)
-  refresh({ bufnr = request_bufnr })
+  util._refresh('textDocument/inlayHint', { bufnr = request_bufnr })
 end
 
 --- Enable inlay hints for a buffer
 ---@param bufnr (integer) Buffer handle, or 0 for current
 local function enable(bufnr)
-  bufnr = resolve_bufnr(bufnr)
+  if bufnr == nil or bufnr == 0 then
+    bufnr = api.nvim_get_current_buf()
+  end
   local bufstate = bufstates[bufnr]
   if not (bufstate and bufstate.enabled) then
     bufstates[bufnr] = { enabled = true, timer = nil, applied = {} }
-    refresh({ bufnr = bufnr })
+    util._refresh('textDocument/inlayHint', { bufnr = bufnr })
     api.nvim_buf_attach(bufnr, true, {
       on_lines = function(_, cb_bufnr)
         if not bufstates[cb_bufnr].enabled then
@@ -201,7 +160,7 @@ local function enable(bufnr)
         if bufstates[cb_bufnr] and bufstates[cb_bufnr].enabled then
           bufstates[cb_bufnr] = { enabled = true, applied = {} }
         end
-        refresh({ bufnr = cb_bufnr })
+        util._refresh('textDocument/inlayHint', { bufnr = cb_bufnr })
       end,
       on_detach = function(_, cb_bufnr)
         clear(cb_bufnr)
@@ -222,7 +181,9 @@ end
 --- Disable inlay hints for a buffer
 ---@param bufnr (integer) Buffer handle, or 0 for current
 local function disable(bufnr)
-  bufnr = resolve_bufnr(bufnr)
+  if bufnr == nil or bufnr == 0 then
+    bufnr = api.nvim_get_current_buf()
+  end
   if bufstates[bufnr] and bufstates[bufnr].enabled then
     clear(bufnr)
     bufstates[bufnr].enabled = nil
@@ -233,7 +194,9 @@ end
 --- Toggle inlay hints for a buffer
 ---@param bufnr (integer) Buffer handle, or 0 for current
 local function toggle(bufnr)
-  bufnr = resolve_bufnr(bufnr)
+  if bufnr == nil or bufnr == 0 then
+    bufnr = api.nvim_get_current_buf()
+  end
   local bufstate = bufstates[bufnr]
   if bufstate and bufstate.enabled then
     disable(bufnr)
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 5bc0baf241..537a5eda39 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -641,6 +641,9 @@ function protocol.make_client_capabilities()
       },
     },
     textDocument = {
+      diagnostic = {
+        dynamicRegistration = false,
+      },
       inlayHint = {
         dynamicRegistration = true,
         resolveSupport = {
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 9a6114c35b..0b06d2bbb5 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -2183,6 +2183,46 @@ function M.lookup_section(settings, section)
   return settings
 end
 
+---@private
+--- Request updated LSP information for a buffer.
+---
+---@param method string LSP method to call
+---@param opts (nil|table) Optional arguments
+---  - bufnr (integer, default: 0): Buffer to refresh
+---  - only_visible (boolean, default: false): Whether to only refresh for the visible regions of the buffer
+function M._refresh(method, opts)
+  opts = opts or {}
+  local bufnr = opts.bufnr
+  if bufnr == nil or bufnr == 0 then
+    bufnr = api.nvim_get_current_buf()
+  end
+  local only_visible = opts.only_visible or false
+  for _, window in ipairs(api.nvim_list_wins()) do
+    if api.nvim_win_get_buf(window) == bufnr then
+      local first = vim.fn.line('w0', window)
+      local last = vim.fn.line('w$', window)
+      local params = {
+        textDocument = M.make_text_document_params(bufnr),
+        range = {
+          start = { line = first - 1, character = 0 },
+          ['end'] = { line = last, character = 0 },
+        },
+      }
+      vim.lsp.buf_request(bufnr, method, params)
+    end
+  end
+  if not only_visible then
+    local params = {
+      textDocument = M.make_text_document_params(bufnr),
+      range = {
+        start = { line = 0, character = 0 },
+        ['end'] = { line = api.nvim_buf_line_count(bufnr), character = 0 },
+      },
+    }
+    vim.lsp.buf_request(bufnr, method, params)
+  end
+end
+
 M._get_line_byte_from_position = get_line_byte_from_position
 
 ---@nodoc
-- 
cgit 


From 519b9929e94c94965b73ac4b04aedb03fd2708ca Mon Sep 17 00:00:00 2001
From: marshmallow <marshycity@gmail.com>
Date: Wed, 19 Jul 2023 10:06:20 +1000
Subject: fix(ui.open): some URLs fail on Windows

Problem:
On Windows, `explorer.exe` fails to open some URLs, for example:

    :lua vim.ui.open('https://devdocs.io/#q=lua%20lua_call')

https://github.com/neovim/neovim/pull/23401#issuecomment-1641015704

Solution:
Use rundll32 instead.
---
 runtime/lua/vim/ui.lua | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/ui.lua b/runtime/lua/vim/ui.lua
index fd06611da2..87b52787a0 100644
--- a/runtime/lua/vim/ui.lua
+++ b/runtime/lua/vim/ui.lua
@@ -136,7 +136,11 @@ function M.open(path)
   if vim.fn.has('mac') == 1 then
     cmd = { 'open', path }
   elseif vim.fn.has('win32') == 1 then
-    cmd = { 'explorer', path }
+    if vim.fn.executable('rundll32') == 1 then
+      cmd = { 'rundll32', 'url.dll,FileProtocolHandler', path }
+    else
+      return nil, 'vim.ui.open: rundll32 not found'
+    end
   elseif vim.fn.executable('wslview') == 1 then
     cmd = { 'wslview', path }
   elseif vim.fn.executable('xdg-open') == 1 then
-- 
cgit 


From cfcda91827d73dda740e372b237383c19e63dab9 Mon Sep 17 00:00:00 2001
From: Gnik <gnikdroy@gmail.com>
Date: Sat, 22 Jul 2023 13:27:25 +0545
Subject: docs(lua): add missing word in docs for vim.empty_dict (#24401)

---
 runtime/lua/vim/_meta/builtin.lua | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/builtin.lua b/runtime/lua/vim/_meta/builtin.lua
index 980e40d61b..88f07f2a51 100644
--- a/runtime/lua/vim/_meta/builtin.lua
+++ b/runtime/lua/vim/_meta/builtin.lua
@@ -69,10 +69,10 @@
 --- to other restrictions such as |textlock|).
 function vim.in_fast_event() end
 
---- Creates a special empty table (marked with a metatable), which Nvim to an
---- empty dictionary when translating Lua values to Vimscript or API types.
---- Nvim by default converts an empty table `{}` without this metatable to an
---- list/array.
+--- Creates a special empty table (marked with a metatable), which Nvim
+--- converts to an empty dictionary when translating Lua values to Vimscript
+--- or API types. Nvim by default converts an empty table `{}` without this
+--- metatable to an list/array.
 ---
 --- Note: If numeric keys are present in the table, Nvim ignores the metatable
 --- marker and converts the dict to a list/array anyway.
-- 
cgit 


From 24e3ee9d07e1433cb13b4d96ec20999f5f02b204 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sat, 22 Jul 2023 09:52:13 +0100
Subject: fix(api/options): validate buf and win

Fixes #24398
---
 runtime/lua/vim/_options.lua | 36 +++++++-----------------------------
 1 file changed, 7 insertions(+), 29 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_options.lua b/runtime/lua/vim/_options.lua
index d54e8b447c..e1c125baf2 100644
--- a/runtime/lua/vim/_options.lua
+++ b/runtime/lua/vim/_options.lua
@@ -124,14 +124,12 @@ local function get_option_metatype(name, info)
   return info.type
 end
 
-local options_info = setmetatable({}, {
-  __index = function(t, k)
-    local info = api.nvim_get_option_info(k)
-    info.metatype = get_option_metatype(k, info)
-    rawset(t, k, info)
-    return rawget(t, k)
-  end,
-})
+--- @param name string
+local function get_options_info(name)
+  local info = api.nvim_get_option_info(name)
+  info.metatype = get_option_metatype(name, info)
+  return info
+end
 
 ---Environment variables defined in the editor session.
 ---See |expand-env| and |:let-environment| for the Vimscript behavior.
@@ -155,34 +153,16 @@ vim.env = setmetatable({}, {
   end,
 })
 
-local function opt_validate(option_name, target_scope)
-  local scope = options_info[option_name].scope
-  if scope ~= target_scope then
-    local scope_to_string = { buf = 'buffer', win = 'window' }
-    error(
-      string.format(
-        [['%s' is a %s option, not a %s option. See ":help %s"]],
-        option_name,
-        scope_to_string[scope] or scope,
-        scope_to_string[target_scope] or target_scope,
-        option_name
-      )
-    )
-  end
-end
-
 local function new_buf_opt_accessor(bufnr)
   return setmetatable({}, {
     __index = function(_, k)
       if bufnr == nil and type(k) == 'number' then
         return new_buf_opt_accessor(k)
       end
-      opt_validate(k, 'buf')
       return api.nvim_get_option_value(k, { buf = bufnr or 0 })
     end,
 
     __newindex = function(_, k, v)
-      opt_validate(k, 'buf')
       return api.nvim_set_option_value(k, v, { buf = bufnr or 0 })
     end,
   })
@@ -203,7 +183,6 @@ local function new_win_opt_accessor(winid, bufnr)
         error('only bufnr=0 is supported')
       end
 
-      opt_validate(k, 'win')
       -- TODO(lewis6991): allow passing both buf and win to nvim_get_option_value
       return api.nvim_get_option_value(k, {
         scope = bufnr and 'local' or nil,
@@ -212,7 +191,6 @@ local function new_win_opt_accessor(winid, bufnr)
     end,
 
     __newindex = function(_, k, v)
-      opt_validate(k, 'win')
       -- TODO(lewis6991): allow passing both buf and win to nvim_set_option_value
       return api.nvim_set_option_value(k, v, {
         scope = bufnr and 'local' or nil,
@@ -680,7 +658,7 @@ local function create_option_accessor(scope)
   local option_mt
 
   local function make_option(name, value)
-    local info = assert(options_info[name], 'Not a valid option name: ' .. name)
+    local info = assert(get_options_info(name), 'Not a valid option name: ' .. name)
 
     if type(value) == 'table' and getmetatable(value) == option_mt then
       assert(name == value._name, "must be the same value, otherwise that's weird.")
-- 
cgit 


From 4b57ff77febbe6073bc4c5c3a45b0ad0d5d40e6c Mon Sep 17 00:00:00 2001
From: Chris AtLee <chris.atlee@shopify.com>
Date: Sat, 22 Jul 2023 05:00:17 -0400
Subject: refactor(lsp): use LspNotify for inlay_hint (#24411)

---
 runtime/lua/vim/lsp.lua            |  6 +--
 runtime/lua/vim/lsp/inlay_hint.lua | 86 +++++++++++++++-----------------------
 2 files changed, 37 insertions(+), 55 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index fa2a888a54..78b5f53723 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1572,9 +1572,9 @@ function lsp.start_client(config)
       changetracking.flush(client)
     end
 
-    local result = rpc.notify(method, params)
+    local client_active = rpc.notify(method, params)
 
-    if result then
+    if client_active then
       vim.schedule(function()
         nvim_exec_autocmds('LspNotify', {
           modeline = false,
@@ -1587,7 +1587,7 @@ function lsp.start_client(config)
       end)
     end
 
-    return result
+    return client_active
   end
 
   ---@private
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 1c29e8a866..912ce6898e 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -6,28 +6,14 @@ local M = {}
 ---@class lsp._inlay_hint.bufstate
 ---@field version integer
 ---@field client_hint table<integer, table<integer, lsp.InlayHint[]>> client_id -> (lnum -> hints)
----@field enabled boolean Whether inlay hints are enabled for the buffer
----@field timer uv.uv_timer_t? Debounce timer associated with the buffer
 ---@field applied table<integer, integer> Last version of hints applied to this line
-
+---@field autocmd_id integer The autocmd id for the buffer
 ---@type table<integer, lsp._inlay_hint.bufstate>
 local bufstates = {}
 
 local namespace = api.nvim_create_namespace('vim_lsp_inlayhint')
 local augroup = api.nvim_create_augroup('vim_lsp_inlayhint', {})
 
---- Reset the request debounce timer of a buffer
-local function reset_timer(reset_bufnr)
-  local timer = bufstates[reset_bufnr].timer
-  if timer then
-    bufstates[reset_bufnr].timer = nil
-    if not timer:is_closing() then
-      timer:stop()
-      timer:close()
-    end
-  end
-end
-
 --- |lsp-handler| for the method `textDocument/inlayHint`
 --- Store hints for a specific buffer and client
 ---@private
@@ -97,7 +83,7 @@ function M.on_refresh(err, _, ctx, _)
     for _, winid in ipairs(api.nvim_list_wins()) do
       if api.nvim_win_get_buf(winid) == bufnr then
         local bufstate = bufstates[bufnr]
-        if bufstate and bufstate.enabled then
+        if bufstate then
           util._refresh('textDocument/inlayHint', { bufnr = bufnr })
           break
         end
@@ -117,7 +103,6 @@ local function clear(bufnr)
   if not bufstates[bufnr] then
     return
   end
-  reset_timer(bufnr)
   local bufstate = bufstates[bufnr]
   local client_lens = (bufstate or {}).client_hint or {}
   local client_ids = vim.tbl_keys(client_lens)
@@ -130,9 +115,17 @@ local function clear(bufnr)
   api.nvim__buf_redraw_range(bufnr, 0, -1)
 end
 
-local function make_request(request_bufnr)
-  reset_timer(request_bufnr)
-  util._refresh('textDocument/inlayHint', { bufnr = request_bufnr })
+--- Disable inlay hints for a buffer
+---@param bufnr (integer) Buffer handle, or 0 for current
+local function disable(bufnr)
+  if bufnr == nil or bufnr == 0 then
+    bufnr = api.nvim_get_current_buf()
+  end
+  clear(bufnr)
+  if bufstates[bufnr] and bufstates[bufnr].autocmd_id then
+    api.nvim_del_autocmd(bufstates[bufnr].autocmd_id)
+  end
+  bufstates[bufnr] = nil
 end
 
 --- Enable inlay hints for a buffer
@@ -142,35 +135,37 @@ local function enable(bufnr)
     bufnr = api.nvim_get_current_buf()
   end
   local bufstate = bufstates[bufnr]
-  if not (bufstate and bufstate.enabled) then
-    bufstates[bufnr] = { enabled = true, timer = nil, applied = {} }
-    util._refresh('textDocument/inlayHint', { bufnr = bufnr })
-    api.nvim_buf_attach(bufnr, true, {
-      on_lines = function(_, cb_bufnr)
-        if not bufstates[cb_bufnr].enabled then
-          return true
+  if not bufstate then
+    bufstates[bufnr] = { applied = {} }
+    bufstates[bufnr].autocmd_id = api.nvim_create_autocmd('LspNotify', {
+      buffer = bufnr,
+      callback = function(opts)
+        if opts.data.method ~= 'textDocument/didChange' then
+          return
+        end
+        if bufstates[bufnr] then
+          util._refresh('textDocument/inlayHint', { bufnr = bufnr })
         end
-        reset_timer(cb_bufnr)
-        bufstates[cb_bufnr].timer = vim.defer_fn(function()
-          make_request(cb_bufnr)
-        end, 200)
       end,
+      group = augroup,
+    })
+    util._refresh('textDocument/inlayHint', { bufnr = bufnr })
+    api.nvim_buf_attach(bufnr, true, {
       on_reload = function(_, cb_bufnr)
         clear(cb_bufnr)
-        if bufstates[cb_bufnr] and bufstates[cb_bufnr].enabled then
-          bufstates[cb_bufnr] = { enabled = true, applied = {} }
+        if bufstates[cb_bufnr] then
+          bufstates[cb_bufnr].applied = {}
+          util._refresh('textDocument/inlayHint', { bufnr = cb_bufnr })
         end
-        util._refresh('textDocument/inlayHint', { bufnr = cb_bufnr })
       end,
       on_detach = function(_, cb_bufnr)
-        clear(cb_bufnr)
-        bufstates[cb_bufnr] = nil
+        disable(cb_bufnr)
       end,
     })
     api.nvim_create_autocmd('LspDetach', {
       buffer = bufnr,
-      callback = function(opts)
-        clear(opts.buf)
+      callback = function()
+        disable(bufnr)
       end,
       once = true,
       group = augroup,
@@ -178,19 +173,6 @@ local function enable(bufnr)
   end
 end
 
---- Disable inlay hints for a buffer
----@param bufnr (integer) Buffer handle, or 0 for current
-local function disable(bufnr)
-  if bufnr == nil or bufnr == 0 then
-    bufnr = api.nvim_get_current_buf()
-  end
-  if bufstates[bufnr] and bufstates[bufnr].enabled then
-    clear(bufnr)
-    bufstates[bufnr].enabled = nil
-    bufstates[bufnr].timer = nil
-  end
-end
-
 --- Toggle inlay hints for a buffer
 ---@param bufnr (integer) Buffer handle, or 0 for current
 local function toggle(bufnr)
@@ -198,7 +180,7 @@ local function toggle(bufnr)
     bufnr = api.nvim_get_current_buf()
   end
   local bufstate = bufstates[bufnr]
-  if bufstate and bufstate.enabled then
+  if bufstate then
     disable(bufnr)
   else
     enable(bufnr)
-- 
cgit 


From 48085e40bb0e4435ddb2eb7f14b4531b943e0c89 Mon Sep 17 00:00:00 2001
From: Micah Halter <micah@mehalter.com>
Date: Mon, 24 Jul 2023 10:26:38 -0400
Subject: fix(treesitter): stop() should treat 0 as current buffer #24450

---
 runtime/lua/vim/treesitter.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 8bd85d3734..04420c81e3 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -462,7 +462,7 @@ end
 ---
 ---@param bufnr (integer|nil) Buffer to stop highlighting (default: current buffer)
 function M.stop(bufnr)
-  bufnr = bufnr or api.nvim_get_current_buf()
+  bufnr = (bufnr and bufnr ~= 0) and bufnr or api.nvim_get_current_buf()
 
   if M.highlighter.active[bufnr] then
     M.highlighter.active[bufnr]:destroy()
-- 
cgit 


From 6a486c44e66f05ae11137ad7a192b89989192566 Mon Sep 17 00:00:00 2001
From: marshmallow <marshycity@gmail.com>
Date: Tue, 25 Jul 2023 01:35:19 +1000
Subject: fix(gx): move to to _init_default_mappings #24420

Problem:
netrw may conflict with the Nvim default "gx" mapping.

Solution:
Initialize keymapping earlier by moving it to vim._init_default_mappings().
That also avoids needing to check maparg().
---
 runtime/lua/vim/_editor.lua | 27 +++++++++++++++++++++++++++
 1 file changed, 27 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 4372aef7b3..87f6d6581c 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -1048,6 +1048,33 @@ function vim._init_default_mappings()
   -- Use : instead of <Cmd> so that ranges are supported. #19365
   map('n', '&', ':&&<CR>')
 
+  -- gx
+
+  -- TODO: use vim.region() when it lands... #13896 #16843
+  local function get_visual_selection()
+    local save_a = vim.fn.getreginfo('a')
+    vim.cmd([[norm! "ay]])
+    local selection = vim.fn.getreg('a', 1)
+    vim.fn.setreg('a', save_a)
+    return selection
+  end
+
+  local function do_open(uri)
+    local _, err = vim.ui.open(uri)
+    if err then
+      vim.notify(err, vim.log.levels.ERROR)
+    end
+  end
+
+  local gx_desc =
+    'Opens filepath or URI under cursor with the system handler (file explorer, web browser, …)'
+  vim.keymap.set({ 'n' }, 'gx', function()
+    do_open(vim.fn.expand('<cfile>'))
+  end, { desc = gx_desc })
+  vim.keymap.set({ 'x' }, 'gx', function()
+    do_open(get_visual_selection())
+  end, { desc = gx_desc })
+
   -- menus
 
   -- TODO VimScript, no l10n
-- 
cgit 


From add7e106d59b8e3822310846a850b3ed3fb5db0e Mon Sep 17 00:00:00 2001
From: Keith Smiley <keithbsmiley@gmail.com>
Date: Mon, 24 Jul 2023 08:58:59 -0700
Subject: fix(lsp): noisy warning about offset_encodings #24441

In the case you hit this warning in a buffer (like with C++ and clangd),
this message potentially fires over and over again making it difficult
to use the editor at all.
---
 runtime/lua/vim/lsp/util.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 0b06d2bbb5..4ff420cf48 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -2026,7 +2026,7 @@ function M._get_offset_encoding(bufnr)
     if not offset_encoding then
       offset_encoding = this_offset_encoding
     elseif offset_encoding ~= this_offset_encoding then
-      vim.notify(
+      vim.notify_once(
         'warning: multiple different client offset_encodings detected for buffer, this is not supported yet',
         vim.log.levels.WARN
       )
-- 
cgit 


From a37d568082ad2a6fd479bc0584f1088b51019b7f Mon Sep 17 00:00:00 2001
From: Mitchell Hanberg <mitch@mitchellhanberg.com>
Date: Mon, 24 Jul 2023 12:09:53 -0400
Subject: fix(lsp): send empty "added" list when removing workspace folder
 #24440

When adding `workspace/didChangeWorkspaceFolders` support to my [language server](https://github.com/elixir-tools/next-ls), I noticed that when neovim removes a workspace, it sends an empty table (which is serialized to an empty JSON array) for the value in the `added` field.

This does not follow the spec; the `added` table should just be empty.

The following error led me to this discovery. Note the payload includes `"added" => [[]]`:

```
22:46:48.476 [error] LSP Exited.

Last message received: handle_notification %{"jsonrpc" => "2.0", "method" => "workspace/didChangeWorkspaceFolders", "params" => %{"event" => %{"added" => [[]], "removed" => [%{"name" => "/Users/mitchell/src/gen_lsp", "uri" => "file:///Users/mitchell/src/gen_lsp"}]}}}

** (MatchError) no match of right hand side value: {:error, %{"params" => %{"event" => %{"added" => [error: "expected a map"]}}}}
    (gen_lsp 0.4.0) lib/gen_lsp.ex:265: anonymous fn/4 in GenLSP.loop/3
    (gen_lsp 0.4.0) lib/gen_lsp.ex:292: GenLSP.attempt/3
    (stdlib 5.0.2) proc_lib.erl:241: :proc_lib.init_p_do_apply/3
```
---
 runtime/lua/vim/lsp/buf.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 46f582dc7e..02d8d0fa7b 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -514,7 +514,7 @@ function M.remove_workspace_folder(workspace_folder)
     return
   end
   local params = util.make_workspace_params(
-    { {} },
+    {},
     { { uri = vim.uri_from_fname(workspace_folder), name = workspace_folder } }
   )
   for _, client in pairs(vim.lsp.get_clients({ bufnr = 0 })) do
-- 
cgit 


From 966eb8e0b3be1b409e491d5cf1e32e82e806a134 Mon Sep 17 00:00:00 2001
From: Bruce Weirdan <weirdan@gmail.com>
Date: Mon, 24 Jul 2023 19:26:17 +0200
Subject: fix(lsp): announce publishDiagnostics.dataSupport (#24442)

Neovim already passed `data` element from published diagnostic to code action, but failed to announce it in client capabilities.

Here is the test that shows that `data` element is returned by `vim.lsp.diagnostic.get_line_diagnostics()`:

https://github.com/neovim/neovim/blob/f56c1848091bb64c63b5bc25ec74bcbd2f52bdde/test/functional/plugin/lsp/diagnostic_spec.lua#L103-L115

and then `get_line_diagnostics()` is used to construct the context for code action request:

https://github.com/neovim/neovim/blob/f56c1848091bb64c63b5bc25ec74bcbd2f52bdde/runtime/lua/vim/lsp/buf.lua#L742
---
 runtime/lua/vim/lsp/protocol.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 537a5eda39..31cc071d18 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -828,6 +828,7 @@ function protocol.make_client_capabilities()
             return res
           end)(),
         },
+        dataSupport = true,
       },
       callHierarchy = {
         dynamicRegistration = false,
-- 
cgit 


From 7668f89d5be6d463bf6ab0c2d3a0393e3ec26e7f Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Mon, 24 Jul 2023 20:21:35 +0200
Subject: fix(lsp): replace @private with @nodoc for public client functions
 (#24415)

* fix(lsp): replace @private with @nodoc for public client functions

To prevent lua-ls warnings in plugins which use the functions.

* fix(lsp): remove duplicate type annotations/class definitions

These annotations became duplicate with https://github.com/neovim/neovim/pull/23750
---
 runtime/lua/vim/lsp.lua       | 10 +++---
 runtime/lua/vim/lsp/types.lua | 79 ++-----------------------------------------
 2 files changed, 7 insertions(+), 82 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 78b5f53723..1a1dc684ba 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1455,7 +1455,7 @@ function lsp.start_client(config)
     end)
   end
 
-  ---@private
+  ---@nodoc
   --- Sends a request to the server.
   ---
   --- This is a thin wrapper around {client.rpc.request} with some additional
@@ -1559,7 +1559,7 @@ function lsp.start_client(config)
     return request_result
   end
 
-  ---@private
+  ---@nodoc
   --- Sends a notification to an LSP server.
   ---
   ---@param method string LSP method name.
@@ -1590,7 +1590,7 @@ function lsp.start_client(config)
     return client_active
   end
 
-  ---@private
+  ---@nodoc
   --- Cancels a request with a given request id.
   ---
   ---@param id (integer) id of request to cancel
@@ -1613,7 +1613,8 @@ function lsp.start_client(config)
   -- Track this so that we can escalate automatically if we've already tried a
   -- graceful shutdown
   local graceful_shutdown_failed = false
-  ---@private
+
+  ---@nodoc
   --- Stops a client, optionally with force.
   ---
   ---By default, it will just ask the - server to shutdown without force. If
@@ -2311,7 +2312,6 @@ function lsp.omnifunc(findstart, base)
 
   local startbyte
 
-  ---@private
   local function on_done()
     local mode = api.nvim_get_mode()['mode']
     if mode == 'i' or mode == 'ic' then
diff --git a/runtime/lua/vim/lsp/types.lua b/runtime/lua/vim/lsp/types.lua
index cdfbcfb11b..98e948c945 100644
--- a/runtime/lua/vim/lsp/types.lua
+++ b/runtime/lua/vim/lsp/types.lua
@@ -5,92 +5,17 @@
 ---@class lsp.HandlerContext
 ---@field method string
 ---@field client_id integer
----@field bufnr integer
----@field params any
+---@field bufnr? integer
+---@field params? any
 
 ---@class lsp.ResponseError
 ---@field code integer
 ---@field message string
 ---@field data string|number|boolean|table[]|table|nil
 
----@class lsp.ShowMessageRequestParams
----@field type lsp.MessageType
----@field message string
----@field actions nil|lsp.MessageActionItem[]
-
----@class lsp.MessageActionItem
----@field title string
-
----@class lsp.FileEvent
----@field uri string
----@field type lsp.FileChangeType
-
----@class lsp.Position
----@field line integer
----@field character integer
-
----@class lsp.Range
----@field start lsp.Position
----@field end lsp.Position
-
----@class lsp.Diagnostic
----@field range lsp.Range
----@field message string
----@field severity? lsp.DiagnosticSeverity
----@field code integer | string
----@field source string
----@field tags? lsp.DiagnosticTag[]
----@field relatedInformation DiagnosticRelatedInformation[]
-
 --- @class lsp.DocumentFilter
 --- @field language? string
 --- @field scheme? string
 --- @field pattern? string
 
---- @alias lsp.DocumentSelector lsp.DocumentFilter[]
-
 --- @alias lsp.RegisterOptions any | lsp.StaticRegistrationOptions | lsp.TextDocumentRegistrationOptions
-
---- @class lsp.Registration
---- @field id string
---- @field method string
---- @field registerOptions? lsp.RegisterOptions
-
---- @alias lsp.RegistrationParams {registrations: lsp.Registration[]}
-
---- @class lsp.StaticRegistrationOptions
---- @field id? string
-
---- @class lsp.TextDocumentRegistrationOptions
---- @field documentSelector? lsp.DocumentSelector
-
---- @class lsp.Unregistration
---- @field id string
---- @field method string
-
---- @alias lsp.UnregistrationParams {unregisterations: lsp.Unregistration[]}
-
----@class lsp.Location
----@field uri string
----@field range lsp.Range
-
----@class lsp.MarkupContent
----@field kind string
----@field value string
-
----@class lsp.InlayHintLabelPart
----@field value string
----@field tooltip? string | lsp.MarkupContent
----@field location? lsp.Location
-
----@class lsp.TextEdit
----@field range lsp.Range
----@field newText string
-
----@class lsp.InlayHint
----@field position lsp.Position
----@field label string | lsp.InlayHintLabelPart[]
----@field kind? integer
----@field textEdits? lsp.TextEdit[]
----@field paddingLeft? boolean
----@field paddingRight? boolean
-- 
cgit 


From 4d0f4c3de9cbdcf85e606b5aaf9488820b95b679 Mon Sep 17 00:00:00 2001
From: Raphael <glepnir@neovim.pro>
Date: Tue, 25 Jul 2023 19:38:48 +0800
Subject: fix(lsp): E403 if doc contains multiple codeblocks #24458

Problem:
Content that has codeblocks with different languages, results in
multiple calls to:
    syntax include vim syntax/vim.vim
which raises error:
    E403: syntax sync: line continuations pattern specified twice
Before ba8f19ebb67ca27d746f4b1cd902ab3d807eace3, this was avoided by
using pcall() to ignore the error.

Solution:
Restore the use of pcall() to ignore the error.
We plan to replace this logic with a treesitter approach, so this is
good enough for now.

Fix #24431
---
 runtime/lua/vim/lsp/util.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 4ff420cf48..4d3071fd68 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1466,7 +1466,7 @@ function M.stylize_markdown(bufnr, contents, opts)
       if #api.nvim_get_runtime_file(('syntax/%s.vim'):format(ft), true) == 0 then
         return
       end
-      vim.cmd(string.format('syntax include %s syntax/%s.vim', lang, ft))
+      pcall(vim.cmd, string.format('syntax include %s syntax/%s.vim', lang, ft))
       langs[lang] = true
     end
     vim.cmd(
-- 
cgit 


From 20c331915f4e317c615c7cfea469a9baedd2e4f7 Mon Sep 17 00:00:00 2001
From: Christoph Hasse <hassec@users.noreply.github.com>
Date: Tue, 25 Jul 2023 08:40:13 -0400
Subject: fix(lsp): SignatureHelp docstring is not escaped #16702

Problem:
Nvim LSP client always treats signature.documentation as markdown, even
if the server returns a plain string.
Per https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#signatureInformation
in a SignatureInformation response, the documentation field can be
either "string" or "MarkupContent".

Solution:
If signature.documentation is a string, treat it as "plaintext".

Closes #16563
---
 runtime/lua/vim/lsp/util.lua | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 4d3071fd68..738e23ff28 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1002,6 +1002,12 @@ function M.convert_signature_help_to_markdown_lines(signature_help, ft, triggers
   end
   list_extend(contents, split(label, '\n', { plain = true }))
   if signature.documentation then
+    -- if LSP returns plain string, we treat it as plaintext. This avoids
+    -- special characters like underscore or similar from being interpreted
+    -- as markdown font modifiers
+    if type(signature.documentation) == 'string' then
+      signature.documentation = { kind = 'plaintext', value = signature.documentation }
+    end
     M.convert_input_to_markdown_lines(signature.documentation, contents)
   end
   if signature.parameters and #signature.parameters > 0 then
-- 
cgit 


From 74bd4aba57d2f1b224abe46a6de82911d14ef6c1 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Tue, 25 Jul 2023 16:57:19 +0200
Subject: fix(lsp): fix multi client handling workspace_folder methods (#18839)

`buf_notify` sends the notification to all clients of a buffer, calling
that inside a loop over clients multiplies the amount of notifications.
---
 runtime/lua/vim/lsp/buf.lua | 32 ++++++++++++++++++--------------
 1 file changed, 18 insertions(+), 14 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 02d8d0fa7b..5e0e429021 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -480,11 +480,13 @@ function M.add_workspace_folder(workspace_folder)
     print(workspace_folder, ' is not a valid directory')
     return
   end
-  local params = util.make_workspace_params(
-    { { uri = vim.uri_from_fname(workspace_folder), name = workspace_folder } },
-    {}
-  )
-  for _, client in pairs(vim.lsp.get_clients({ bufnr = 0 })) do
+  local new_workspace = {
+    uri = vim.uri_from_fname(workspace_folder),
+    name = workspace_folder,
+  }
+  local params = { event = { added = { new_workspace }, removed = {} } }
+  local bufnr = vim.api.nvim_get_current_buf()
+  for _, client in pairs(vim.lsp.get_clients({ bufnr = bufnr })) do
     local found = false
     for _, folder in pairs(client.workspace_folders or {}) do
       if folder.name == workspace_folder then
@@ -494,11 +496,11 @@ function M.add_workspace_folder(workspace_folder)
       end
     end
     if not found then
-      vim.lsp.buf_notify(0, 'workspace/didChangeWorkspaceFolders', params)
+      client.notify('workspace/didChangeWorkspaceFolders', params)
       if not client.workspace_folders then
         client.workspace_folders = {}
       end
-      table.insert(client.workspace_folders, params.event.added[1])
+      table.insert(client.workspace_folders, new_workspace)
     end
   end
 end
@@ -513,14 +515,16 @@ function M.remove_workspace_folder(workspace_folder)
   if not (workspace_folder and #workspace_folder > 0) then
     return
   end
-  local params = util.make_workspace_params(
-    {},
-    { { uri = vim.uri_from_fname(workspace_folder), name = workspace_folder } }
-  )
-  for _, client in pairs(vim.lsp.get_clients({ bufnr = 0 })) do
-    for idx, folder in pairs(client.workspace_folders or {}) do
+  local workspace = {
+    uri = vim.uri_from_fname(workspace_folder),
+    name = workspace_folder,
+  }
+  local params = { event = { added = {}, removed = { workspace } } }
+  local bufnr = vim.api.nvim_get_current_buf()
+  for _, client in pairs(vim.lsp.get_clients({ bufnr = bufnr })) do
+    for idx, folder in pairs(client.workspace_folders) do
       if folder.name == workspace_folder then
-        vim.lsp.buf_notify(0, 'workspace/didChangeWorkspaceFolders', params)
+        client.notify('workspace/didChangeWorkspaceFolders', params)
         client.workspace_folders[idx] = nil
         return
       end
-- 
cgit 


From fd089c8e50c211d7beae15dbc9492ae5a1a5f2e2 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 26 Jul 2023 09:50:54 +0100
Subject: feat(lua): typing for vim.fn.* (#24473)

Problem:
  No LSP information for `vim.fn.*`

Solution:
  Add meta file for `vim.fn.*`.
---
 runtime/lua/vim/_meta/vimfn.lua | 11162 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 11162 insertions(+)
 create mode 100644 runtime/lua/vim/_meta/vimfn.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
new file mode 100644
index 0000000000..b70e361e48
--- /dev/null
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -0,0 +1,11162 @@
+--- @meta
+-- THIS FILE IS GENERATED
+-- DO NOT EDIT
+
+--- Return the absolute value of {expr}.  When {expr} evaluates to
+--- a |Float| abs() returns a |Float|.  When {expr} can be
+--- converted to a |Number| abs() returns a |Number|.  Otherwise
+--- abs() gives an error message and returns -1.
+--- Examples: >
+---   echo abs(1.456)
+--- <  1.456  >
+---   echo abs(-5.456)
+--- <  5.456  >
+---   echo abs(-4)
+--- <  4
+---
+--- Can also be used as a |method|: >
+---   Compute()->abs()
+---
+--- @param expr any
+--- @return any
+function vim.fn.abs(expr) end
+
+--- Return the arc cosine of {expr} measured in radians, as a
+--- |Float| in the range of [0, pi].
+--- {expr} must evaluate to a |Float| or a |Number| in the range
+--- [-1, 1].
+--- Returns NaN if {expr} is outside the range [-1, 1].  Returns
+--- 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo acos(0)
+--- <  1.570796 >
+---   :echo acos(-0.5)
+--- <  2.094395
+---
+--- Can also be used as a |method|: >
+---   Compute()->acos()
+---
+--- @param expr any
+--- @return number
+function vim.fn.acos(expr) end
+
+--- Append the item {expr} to |List| or |Blob| {object}.  Returns
+--- the resulting |List| or |Blob|.  Examples: >
+---   :let alist = add([1, 2, 3], item)
+---   :call add(mylist, "woodstock")
+--- <Note that when {expr} is a |List| it is appended as a single
+--- item.  Use |extend()| to concatenate |Lists|.
+--- When {object} is a |Blob| then {expr} must be a number.
+--- Use |insert()| to add an item at another position.
+--- Returns 1 if {object} is not a |List| or a |Blob|.
+---
+--- Can also be used as a |method|: >
+---   mylist->add(val1)->add(val2)
+---
+--- @param object any
+--- @param expr any
+--- @return any
+function vim.fn.add(object, expr) end
+
+--- Bitwise AND on the two arguments.  The arguments are converted
+--- to a number.  A List, Dict or Float argument causes an error.
+--- Also see `or()` and `xor()`.
+--- Example: >
+---   :let flag = and(bits, 0x80)
+--- <Can also be used as a |method|: >
+---   :let flag = bits->and(0x80)
+---
+--- @param expr any
+--- @param expr1 any
+--- @return any
+vim.fn['and'] = function(expr, expr1) end
+
+--- Returns Dictionary of |api-metadata|.
+---
+--- View it in a nice human-readable format: >
+---        :lua vim.print(vim.fn.api_info())
+---
+--- @return any
+function vim.fn.api_info() end
+
+--- When {text} is a |List|: Append each item of the |List| as a
+--- text line below line {lnum} in the current buffer.
+--- Otherwise append {text} as one text line below line {lnum} in
+--- the current buffer.
+--- Any type of item is accepted and converted to a String.
+--- {lnum} can be zero to insert a line before the first one.
+--- {lnum} is used like with |getline()|.
+--- Returns 1 for failure ({lnum} out of range or out of memory),
+--- 0 for success.  Example: >
+---   :let failed = append(line('$'), "# THE END")
+---   :let failed = append(0, ["Chapter 1", "the beginning"])
+---
+--- <Can also be used as a |method| after a List: >
+---   mylist->append(lnum)
+---
+--- @param lnum integer
+--- @param text any
+--- @return any
+function vim.fn.append(lnum, text) end
+
+--- Like |append()| but append the text in buffer {expr}.
+---
+--- This function works only for loaded buffers. First call
+--- |bufload()| if needed.
+---
+--- For the use of {buf}, see |bufname()|.
+---
+--- {lnum} is the line number to append below.  Note that using
+--- |line()| would use the current buffer, not the one appending
+--- to.  Use "$" to append at the end of the buffer.  Other string
+--- values are not supported.
+---
+--- On success 0 is returned, on failure 1 is returned.
+---
+--- If {buf} is not a valid buffer or {lnum} is not valid, an
+--- error message is given. Example: >
+---   :let failed = appendbufline(13, 0, "# THE START")
+--- <
+--- Can also be used as a |method| after a List: >
+---   mylist->appendbufline(buf, lnum)
+---
+--- @param buf any
+--- @param lnum integer
+--- @param text any
+--- @return any
+function vim.fn.appendbufline(buf, lnum, text) end
+
+--- The result is the number of files in the argument list.  See
+--- |arglist|.
+--- If {winid} is not supplied, the argument list of the current
+--- window is used.
+--- If {winid} is -1, the global argument list is used.
+--- Otherwise {winid} specifies the window of which the argument
+--- list is used: either the window number or the window ID.
+--- Returns -1 if the {winid} argument is invalid.
+---
+---           *argidx()*
+--- @param winid? integer
+--- @return integer
+function vim.fn.argc(winid) end
+
+--- the first file.  argc() - 1 is the last one.  See |arglist|.
+---
+---           *arglistid()*
+--- @return integer
+function vim.fn.argidx() end
+
+--- Return the argument list ID.  This is a number which
+--- identifies the argument list being used.  Zero is used for the
+--- global argument list.  See |arglist|.
+--- Returns -1 if the arguments are invalid.
+---
+--- Without arguments use the current window.
+--- With {winnr} only use this window in the current tab page.
+--- With {winnr} and {tabnr} use the window in the specified tab
+--- page.
+--- {winnr} can be the window number or the |window-ID|.
+---
+---           *argv()*
+--- @param winnr? integer
+--- @param tabnr? integer
+--- @return integer
+function vim.fn.arglistid(winnr, tabnr) end
+
+--- The result is the {nr}th file in the argument list.  See
+--- |arglist|.  "argv(0)" is the first one.  Example: >
+---   :let i = 0
+---   :while i < argc()
+---   :  let f = escape(fnameescape(argv(i)), '.')
+---   :  exe 'amenu Arg.' .. f .. ' :e ' .. f .. '<CR>'
+---   :  let i = i + 1
+---   :endwhile
+--- <Without the {nr} argument, or when {nr} is -1, a |List| with
+--- the whole |arglist| is returned.
+---
+--- The {winid} argument specifies the window ID, see |argc()|.
+--- For the Vim command line arguments see |v:argv|.
+---
+--- Returns an empty string if {nr}th argument is not present in
+--- the argument list.  Returns an empty List if the {winid}
+--- argument is invalid.
+---
+--- @param nr? integer
+--- @param winid? integer
+--- @return any
+function vim.fn.argv(nr, winid) end
+
+--- Return the arc sine of {expr} measured in radians, as a |Float|
+--- in the range of [-pi/2, pi/2].
+--- {expr} must evaluate to a |Float| or a |Number| in the range
+--- [-1, 1].
+--- Returns NaN if {expr} is outside the range [-1, 1].  Returns
+--- 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo asin(0.8)
+--- <  0.927295 >
+---   :echo asin(-0.5)
+--- <  -0.523599
+---
+--- Can also be used as a |method|: >
+---   Compute()->asin()
+---
+---
+--- assert_ functions are documented here: |assert-functions-details|
+---
+---
+--- @param expr any
+--- @return any
+function vim.fn.asin(expr) end
+
+--- Run {cmd} and add an error message to |v:errors| if it does
+--- NOT produce a beep or visual bell.
+--- Also see |assert_fails()|, |assert_nobeep()| and
+--- |assert-return|.
+---
+--- Can also be used as a |method|: >
+---   GetCmd()->assert_beeps()
+--- <
+---           *assert_equal()*
+--- @param cmd any
+--- @return 0|1
+function vim.fn.assert_beeps(cmd) end
+
+--- When {expected} and {actual} are not equal an error message is
+--- added to |v:errors| and 1 is returned.  Otherwise zero is
+--- returned. |assert-return|
+--- The error is in the form "Expected {expected} but got
+--- {actual}".  When {msg} is present it is prefixed to that.
+---
+--- There is no automatic conversion, the String "4" is different
+--- from the Number 4.  And the number 4 is different from the
+--- Float 4.0.  The value of 'ignorecase' is not used here, case
+--- always matters.
+--- Example: >
+---   assert_equal('foo', 'bar')
+--- <Will result in a string to be added to |v:errors|:
+---   test.vim line 12: Expected 'foo' but got 'bar' ~
+---
+--- Can also be used as a |method|: >
+---   mylist->assert_equal([1, 2, 3])
+---
+--- <          *assert_equalfile()*
+--- @param expected any
+--- @param actual any
+--- @param msg? any
+--- @return 0|1
+function vim.fn.assert_equal(expected, actual, msg) end
+
+--- When the files {fname-one} and {fname-two} do not contain
+--- exactly the same text an error message is added to |v:errors|.
+--- Also see |assert-return|.
+--- When {fname-one} or {fname-two} does not exist the error will
+--- mention that.
+---
+--- Can also be used as a |method|: >
+---   GetLog()->assert_equalfile('expected.log')
+---
+--- @return any
+function vim.fn.assert_equalfile() end
+
+--- When v:exception does not contain the string {error} an error
+--- message is added to |v:errors|.  Also see |assert-return|.
+--- This can be used to assert that a command throws an exception.
+--- Using the error number, followed by a colon, avoids problems
+--- with translations: >
+---   try
+---     commandthatfails
+---     call assert_false(1, 'command should have failed')
+---   catch
+---     call assert_exception('E492:')
+---   endtry
+--- <
+---           *assert_fails()*
+--- @param error any
+--- @param msg? any
+--- @return 0|1
+function vim.fn.assert_exception(error, msg) end
+
+--- Run {cmd} and add an error message to |v:errors| if it does
+--- NOT produce an error or when {error} is not found in the
+--- error message.  Also see |assert-return|.
+---
+--- When {error} is a string it must be found literally in the
+--- first reported error. Most often this will be the error code,
+--- including the colon, e.g. "E123:". >
+---   assert_fails('bad cmd', 'E987:')
+--- <
+--- When {error} is a |List| with one or two strings, these are
+--- used as patterns.  The first pattern is matched against the
+--- first reported error: >
+---   assert_fails('cmd', ['E987:.*expected bool'])
+--- <The second pattern, if present, is matched against the last
+--- reported error.  To only match the last error use an empty
+--- string for the first error: >
+---   assert_fails('cmd', ['', 'E987:'])
+--- <
+--- If {msg} is empty then it is not used.  Do this to get the
+--- default message when passing the {lnum} argument.
+---
+--- When {lnum} is present and not negative, and the {error}
+--- argument is present and matches, then this is compared with
+--- the line number at which the error was reported. That can be
+--- the line number in a function or in a script.
+---
+--- When {context} is present it is used as a pattern and matched
+--- against the context (script name or function name) where
+--- {lnum} is located in.
+---
+--- Note that beeping is not considered an error, and some failing
+--- commands only beep.  Use |assert_beeps()| for those.
+---
+--- Can also be used as a |method|: >
+---   GetCmd()->assert_fails('E99:')
+---
+--- @param cmd any
+--- @param error? any
+--- @param msg? any
+--- @param lnum? integer
+--- @param context? any
+--- @return 0|1
+function vim.fn.assert_fails(cmd, error, msg, lnum, context) end
+
+--- When {actual} is not false an error message is added to
+--- |v:errors|, like with |assert_equal()|.
+--- The error is in the form "Expected False but got {actual}".
+--- When {msg} is present it is prepended to that.
+--- Also see |assert-return|.
+---
+--- A value is false when it is zero. When {actual} is not a
+--- number the assert fails.
+---
+--- Can also be used as a |method|: >
+---   GetResult()->assert_false()
+---
+--- @param actual any
+--- @param msg? any
+--- @return 0|1
+function vim.fn.assert_false(actual, msg) end
+
+--- This asserts number and |Float| values.  When {actual}  is lower
+--- than {lower} or higher than {upper} an error message is added
+--- to |v:errors|.  Also see |assert-return|.
+--- The error is in the form "Expected range {lower} - {upper},
+--- but got {actual}".  When {msg} is present it is prefixed to
+--- that.
+---
+---             *assert_match()*
+--- @param lower any
+--- @param upper any
+--- @param actual any
+--- @param msg? any
+--- @return 0|1
+function vim.fn.assert_inrange(lower, upper, actual, msg) end
+
+--- When {pattern} does not match {actual} an error message is
+--- added to |v:errors|.  Also see |assert-return|.
+--- The error is in the form "Pattern {pattern} does not match
+--- {actual}".  When {msg} is present it is prefixed to that.
+---
+--- {pattern} is used as with |expr-=~|: The matching is always done
+--- like 'magic' was set and 'cpoptions' is empty, no matter what
+--- the actual value of 'magic' or 'cpoptions' is.
+---
+--- {actual} is used as a string, automatic conversion applies.
+--- Use "^" and "$" to match with the start and end of the text.
+--- Use both to match the whole text.
+---
+--- Example: >
+---   assert_match('^f.*o$', 'foobar')
+--- <Will result in a string to be added to |v:errors|:
+---   test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~
+---
+--- Can also be used as a |method|: >
+---   getFile()->assert_match('foo.*')
+--- <
+--- @param pattern any
+--- @param actual any
+--- @param msg? any
+--- @return 0|1
+function vim.fn.assert_match(pattern, actual, msg) end
+
+--- Run {cmd} and add an error message to |v:errors| if it
+--- produces a beep or visual bell.
+--- Also see |assert_beeps()|.
+---
+--- Can also be used as a |method|: >
+---   GetCmd()->assert_nobeep()
+--- <
+---           *assert_notequal()*
+--- @param cmd any
+--- @return 0|1
+function vim.fn.assert_nobeep(cmd) end
+
+--- The opposite of `assert_equal()`: add an error message to
+--- |v:errors| when {expected} and {actual} are equal.
+--- Also see |assert-return|.
+---
+--- Can also be used as a |method|: >
+---   mylist->assert_notequal([1, 2, 3])
+---
+--- <          *assert_notmatch()*
+--- @param expected any
+--- @param actual any
+--- @param msg? any
+--- @return any
+function vim.fn.assert_notequal(expected, actual, msg) end
+
+--- The opposite of `assert_match()`: add an error message to
+--- |v:errors| when {pattern} matches {actual}.
+--- Also see |assert-return|.
+---
+--- Can also be used as a |method|: >
+---   getFile()->assert_notmatch('bar.*')
+---
+---
+--- @param pattern any
+--- @param actual any
+--- @param msg? any
+--- @return any
+function vim.fn.assert_notmatch(pattern, actual, msg) end
+
+--- Report a test failure directly, using String {msg}.
+--- Always returns one.
+---
+--- Can also be used as a |method|: >
+---   GetMessage()->assert_report()
+---
+---
+--- @param msg any
+--- @return any
+function vim.fn.assert_report(msg) end
+
+--- When {actual} is not true an error message is added to
+--- |v:errors|, like with |assert_equal()|.
+--- Also see |assert-return|.
+--- A value is |TRUE| when it is a non-zero number or |v:true|.
+--- When {actual} is not a number or |v:true| the assert fails.
+--- When {msg} is given it precedes the default message.
+---
+--- Can also be used as a |method|: >
+---   GetResult()->assert_true()
+--- <
+---
+--- @param actual any
+--- @param msg? any
+--- @return any
+function vim.fn.assert_true(actual, msg) end
+
+--- Return the principal value of the arc tangent of {expr}, in
+--- the range [-pi/2, +pi/2] radians, as a |Float|.
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo atan(100)
+--- <  1.560797 >
+---   :echo atan(-4.01)
+--- <  -1.326405
+---
+--- Can also be used as a |method|: >
+---   Compute()->atan()
+---
+--- @param expr any
+--- @return number
+function vim.fn.atan(expr) end
+
+--- Return the arc tangent of {expr1} / {expr2}, measured in
+--- radians, as a |Float| in the range [-pi, pi].
+--- {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr1} or {expr2} is not a |Float| or a
+--- |Number|.
+--- Examples: >
+---   :echo atan2(-1, 1)
+--- <  -0.785398 >
+---   :echo atan2(1, -1)
+--- <  2.356194
+---
+--- Can also be used as a |method|: >
+---   Compute()->atan2(1)
+---
+--- @param expr1 any
+--- @param expr2 any
+--- @return number
+function vim.fn.atan2(expr1, expr2) end
+
+--- Return a List containing the number value of each byte in Blob
+--- {blob}.  Examples: >
+---   blob2list(0z0102.0304)  returns [1, 2, 3, 4]
+---   blob2list(0z)    returns []
+--- <Returns an empty List on error.  |list2blob()| does the
+--- opposite.
+---
+--- Can also be used as a |method|: >
+---   GetBlob()->blob2list()
+--- <
+---           *browse()*
+--- @param blob any
+--- @return any
+function vim.fn.blob2list(blob) end
+
+--- Put up a file requester.  This only works when "has("browse")"
+--- returns |TRUE| (only in some GUI versions).
+--- The input fields are:
+---     {save}  when |TRUE|, select file to write
+---     {title}  title for the requester
+---     {initdir}  directory to start browsing in
+---     {default}  default file name
+--- An empty string is returned when the "Cancel" button is hit,
+--- something went wrong, or browsing is not possible.
+---
+---           *browsedir()*
+--- @param save any
+--- @param title any
+--- @param initdir any
+--- @param default any
+--- @return any
+function vim.fn.browse(save, title, initdir, default) end
+
+--- Put up a directory requester.  This only works when
+--- "has("browse")" returns |TRUE| (only in some GUI versions).
+--- On systems where a directory browser is not supported a file
+--- browser is used.  In that case: select a file in the directory
+--- to be used.
+--- The input fields are:
+---     {title}  title for the requester
+---     {initdir}  directory to start browsing in
+--- When the "Cancel" button is hit, something went wrong, or
+--- browsing is not possible, an empty string is returned.
+---
+--- @param title any
+--- @param initdir any
+--- @return any
+function vim.fn.browsedir(title, initdir) end
+
+--- Add a buffer to the buffer list with name {name} (must be a
+--- String).
+--- If a buffer for file {name} already exists, return that buffer
+--- number.  Otherwise return the buffer number of the newly
+--- created buffer.  When {name} is an empty string then a new
+--- buffer is always created.
+--- The buffer will not have 'buflisted' set and not be loaded
+--- yet.  To add some text to the buffer use this: >
+---   let bufnr = bufadd('someName')
+---   call bufload(bufnr)
+---   call setbufline(bufnr, 1, ['some', 'text'])
+--- <Returns 0 on error.
+--- Can also be used as a |method|: >
+---   let bufnr = 'somename'->bufadd()
+---
+--- @param name string
+--- @return integer
+function vim.fn.bufadd(name) end
+
+--- The result is a Number, which is |TRUE| if a buffer called
+--- {buf} exists.
+--- If the {buf} argument is a number, buffer numbers are used.
+--- Number zero is the alternate buffer for the current window.
+---
+--- If the {buf} argument is a string it must match a buffer name
+--- exactly.  The name can be:
+--- - Relative to the current directory.
+--- - A full path.
+--- - The name of a buffer with 'buftype' set to "nofile".
+--- - A URL name.
+--- Unlisted buffers will be found.
+--- Note that help files are listed by their short name in the
+--- output of |:buffers|, but bufexists() requires using their
+--- long name to be able to find them.
+--- bufexists() may report a buffer exists, but to use the name
+--- with a |:buffer| command you may need to use |expand()|.  Esp
+--- for MS-Windows 8.3 names in the form "c:\DOCUME~1"
+--- Use "bufexists(0)" to test for the existence of an alternate
+--- file name.
+---
+--- Can also be used as a |method|: >
+---   let exists = 'somename'->bufexists()
+---
+--- @param buf any
+--- @return 0|1
+function vim.fn.bufexists(buf) end
+
+--- @deprecated
+--- Obsolete name for |bufexists()|.
+function vim.fn.buffer_exists(...) end
+
+--- @deprecated
+--- Obsolete name for |bufname()|.
+function vim.fn.buffer_name(...) end
+
+--- @deprecated
+--- Obsolete name for |bufnr()|.
+function vim.fn.buffer_number(...) end
+
+--- The result is a Number, which is |TRUE| if a buffer called
+--- {buf} exists and is listed (has the 'buflisted' option set).
+--- The {buf} argument is used like with |bufexists()|.
+---
+--- Can also be used as a |method|: >
+---   let listed = 'somename'->buflisted()
+---
+--- @param buf any
+--- @return 0|1
+function vim.fn.buflisted(buf) end
+
+--- Ensure the buffer {buf} is loaded.  When the buffer name
+--- refers to an existing file then the file is read.  Otherwise
+--- the buffer will be empty.  If the buffer was already loaded
+--- then there is no change.  If the buffer is not related to a
+--- file the no file is read (e.g., when 'buftype' is "nofile").
+--- If there is an existing swap file for the file of the buffer,
+--- there will be no dialog, the buffer will be loaded anyway.
+--- The {buf} argument is used like with |bufexists()|.
+---
+--- Can also be used as a |method|: >
+---   eval 'somename'->bufload()
+---
+--- @param buf any
+function vim.fn.bufload(buf) end
+
+--- The result is a Number, which is |TRUE| if a buffer called
+--- {buf} exists and is loaded (shown in a window or hidden).
+--- The {buf} argument is used like with |bufexists()|.
+---
+--- Can also be used as a |method|: >
+---   let loaded = 'somename'->bufloaded()
+---
+--- @param buf any
+--- @return 0|1
+function vim.fn.bufloaded(buf) end
+
+--- The result is the name of a buffer.  Mostly as it is displayed
+--- by the `:ls` command, but not using special names such as
+--- "[No Name]".
+--- If {buf} is omitted the current buffer is used.
+--- If {buf} is a Number, that buffer number's name is given.
+--- Number zero is the alternate buffer for the current window.
+--- If {buf} is a String, it is used as a |file-pattern| to match
+--- with the buffer names.  This is always done like 'magic' is
+--- set and 'cpoptions' is empty.  When there is more than one
+--- match an empty string is returned.
+--- "" or "%" can be used for the current buffer, "#" for the
+--- alternate buffer.
+--- A full match is preferred, otherwise a match at the start, end
+--- or middle of the buffer name is accepted.  If you only want a
+--- full match then put "^" at the start and "$" at the end of the
+--- pattern.
+--- Listed buffers are found first.  If there is a single match
+--- with a listed buffer, that one is returned.  Next unlisted
+--- buffers are searched for.
+--- If the {buf} is a String, but you want to use it as a buffer
+--- number, force it to be a Number by adding zero to it: >
+---   :echo bufname("3" + 0)
+--- <Can also be used as a |method|: >
+---   echo bufnr->bufname()
+---
+--- <If the buffer doesn't exist, or doesn't have a name, an empty
+--- string is returned. >
+---   bufname("#")    alternate buffer name
+---   bufname(3)    name of buffer 3
+---   bufname("%")    name of current buffer
+---   bufname("file2")  name of buffer where "file2" matches.
+--- <
+---           *bufnr()*
+--- @param buf? any
+--- @return string
+function vim.fn.bufname(buf) end
+
+--- The result is the number of a buffer, as it is displayed by
+--- the `:ls` command.  For the use of {buf}, see |bufname()|
+--- above.
+--- If the buffer doesn't exist, -1 is returned.  Or, if the
+--- {create} argument is present and TRUE, a new, unlisted,
+--- buffer is created and its number is returned.
+--- bufnr("$") is the last buffer: >
+---   :let last_buffer = bufnr("$")
+--- <The result is a Number, which is the highest buffer number
+--- of existing buffers.  Note that not all buffers with a smaller
+--- number necessarily exist, because ":bwipeout" may have removed
+--- them.  Use bufexists() to test for the existence of a buffer.
+---
+--- Can also be used as a |method|: >
+---   echo bufref->bufnr()
+---
+--- @param buf? any
+--- @param create? any
+--- @return integer
+function vim.fn.bufnr(buf, create) end
+
+--- The result is a Number, which is the |window-ID| of the first
+--- window associated with buffer {buf}.  For the use of {buf},
+--- see |bufname()| above.  If buffer {buf} doesn't exist or
+--- there is no such window, -1 is returned.  Example: >
+---
+---   echo "A window containing buffer 1 is " .. (bufwinid(1))
+--- <
+--- Only deals with the current tab page.  See |win_findbuf()| for
+--- finding more.
+---
+--- Can also be used as a |method|: >
+---   FindBuffer()->bufwinid()
+---
+--- @param buf any
+--- @return integer
+function vim.fn.bufwinid(buf) end
+
+--- Like |bufwinid()| but return the window number instead of the
+--- |window-ID|.
+--- If buffer {buf} doesn't exist or there is no such window, -1
+--- is returned.  Example: >
+---
+---   echo "A window containing buffer 1 is " .. (bufwinnr(1))
+---
+--- <The number can be used with |CTRL-W_w| and ":wincmd w"
+--- |:wincmd|.
+---
+--- Can also be used as a |method|: >
+---   FindBuffer()->bufwinnr()
+---
+--- @param buf any
+--- @return integer
+function vim.fn.bufwinnr(buf) end
+
+--- Return the line number that contains the character at byte
+--- count {byte} in the current buffer.  This includes the
+--- end-of-line character, depending on the 'fileformat' option
+--- for the current buffer.  The first character has byte count
+--- one.
+--- Also see |line2byte()|, |go| and |:goto|.
+---
+--- Returns -1 if the {byte} value is invalid.
+---
+--- Can also be used as a |method|: >
+---   GetOffset()->byte2line()
+---
+--- @param byte any
+--- @return integer
+function vim.fn.byte2line(byte) end
+
+--- Return byte index of the {nr}th character in the String
+--- {expr}.  Use zero for the first character, it then returns
+--- zero.
+--- If there are no multibyte characters the returned value is
+--- equal to {nr}.
+--- Composing characters are not counted separately, their byte
+--- length is added to the preceding base character.  See
+--- |byteidxcomp()| below for counting composing characters
+--- separately.
+--- When {utf16} is present and TRUE, {nr} is used as the UTF-16
+--- index in the String {expr} instead of as the character index.
+--- The UTF-16 index is the index in the string when it is encoded
+--- with 16-bit words.  If the specified UTF-16 index is in the
+--- middle of a character (e.g. in a 4-byte character), then the
+--- byte index of the first byte in the character is returned.
+--- Refer to |string-offset-encoding| for more information.
+--- Example : >
+---   echo matchstr(str, ".", byteidx(str, 3))
+--- <will display the fourth character.  Another way to do the
+--- same: >
+---   let s = strpart(str, byteidx(str, 3))
+---   echo strpart(s, 0, byteidx(s, 1))
+--- <Also see |strgetchar()| and |strcharpart()|.
+---
+--- If there are less than {nr} characters -1 is returned.
+--- If there are exactly {nr} characters the length of the string
+--- in bytes is returned.
+--- See |charidx()| and |utf16idx()| for getting the character and
+--- UTF-16 index respectively from the byte index.
+--- Examples: >
+---   echo byteidx('a😊😊', 2)  returns 5
+---   echo byteidx('a😊😊', 2, 1)  returns 1
+---   echo byteidx('a😊😊', 3, 1)  returns 5
+--- <
+--- Can also be used as a |method|: >
+---   GetName()->byteidx(idx)
+---
+--- @param expr any
+--- @param nr integer
+--- @param utf16? any
+--- @return integer
+function vim.fn.byteidx(expr, nr, utf16) end
+
+--- Like byteidx(), except that a composing character is counted
+--- as a separate character.  Example: >
+---   let s = 'e' .. nr2char(0x301)
+---   echo byteidx(s, 1)
+---   echo byteidxcomp(s, 1)
+---   echo byteidxcomp(s, 2)
+--- <The first and third echo result in 3 ('e' plus composing
+--- character is 3 bytes), the second echo results in 1 ('e' is
+--- one byte).
+---
+--- Can also be used as a |method|: >
+---   GetName()->byteidxcomp(idx)
+---
+--- @param expr any
+--- @param nr integer
+--- @param utf16? any
+--- @return integer
+function vim.fn.byteidxcomp(expr, nr, utf16) end
+
+--- Call function {func} with the items in |List| {arglist} as
+--- arguments.
+--- {func} can either be a |Funcref| or the name of a function.
+--- a:firstline and a:lastline are set to the cursor line.
+--- Returns the return value of the called function.
+--- {dict} is for functions with the "dict" attribute.  It will be
+--- used to set the local variable "self". |Dictionary-function|
+---
+--- Can also be used as a |method|: >
+---   GetFunc()->call([arg, arg], dict)
+---
+--- @param func any
+--- @param arglist any
+--- @param dict? any
+--- @return any
+function vim.fn.call(func, arglist, dict) end
+
+--- Return the smallest integral value greater than or equal to
+--- {expr} as a |Float| (round up).
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Examples: >
+---   echo ceil(1.456)
+--- <  2.0  >
+---   echo ceil(-5.456)
+--- <  -5.0  >
+---   echo ceil(4.0)
+--- <  4.0
+---
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+---
+--- Can also be used as a |method|: >
+---   Compute()->ceil()
+---
+--- @param expr any
+--- @return any
+function vim.fn.ceil(expr) end
+
+--- Close a channel or a specific stream associated with it.
+--- For a job, {stream} can be one of "stdin", "stdout",
+--- "stderr" or "rpc" (closes stdin/stdout for a job started
+--- with `"rpc":v:true`) If {stream} is omitted, all streams
+--- are closed. If the channel is a pty, this will then close the
+--- pty master, sending SIGHUP to the job process.
+--- For a socket, there is only one stream, and {stream} should be
+--- omitted.
+---
+--- @param id any
+--- @param stream? any
+--- @return any
+function vim.fn.chanclose(id, stream) end
+
+--- Return the number of the most recent change.  This is the same
+--- number as what is displayed with |:undolist| and can be used
+--- with the |:undo| command.
+--- When a change was made it is the number of that change.  After
+--- redo it is the number of the redone change.  After undo it is
+--- one less than the number of the undone change.
+--- Returns 0 if the undo list is empty.
+---
+--- @return integer
+function vim.fn.changenr() end
+
+--- Send data to channel {id}. For a job, it writes it to the
+--- stdin of the process. For the stdio channel |channel-stdio|,
+--- it writes to Nvim's stdout.  Returns the number of bytes
+--- written if the write succeeded, 0 otherwise.
+--- See |channel-bytes| for more information.
+---
+--- {data} may be a string, string convertible, |Blob|, or a list.
+--- If {data} is a list, the items will be joined by newlines; any
+--- newlines in an item will be sent as NUL. To send a final
+--- newline, include a final empty string. Example: >
+---   :call chansend(id, ["abc", "123\n456", ""])
+--- <will send "abc<NL>123<NUL>456<NL>".
+---
+--- chansend() writes raw data, not RPC messages.  If the channel
+--- was created with `"rpc":v:true` then the channel expects RPC
+--- messages, use |rpcnotify()| and |rpcrequest()| instead.
+---
+---
+--- @param id any
+--- @param data any
+--- @return any
+function vim.fn.chansend(id, data) end
+
+--- Return Number value of the first char in {string}.
+--- Examples: >
+---   char2nr(" ")    returns 32
+---   char2nr("ABC")    returns 65
+---   char2nr("á")    returns 225
+---   char2nr("á"[0])    returns 195
+---   char2nr("\<M-x>")  returns 128
+--- <Non-ASCII characters are always treated as UTF-8 characters.
+--- {utf8} is ignored, it exists only for backwards-compatibility.
+--- A combining character is a separate character.
+--- |nr2char()| does the opposite.
+---
+--- Returns 0 if {string} is not a |String|.
+---
+--- Can also be used as a |method|: >
+---   GetChar()->char2nr()
+---
+--- @param string string
+--- @param utf8? any
+--- @return any
+function vim.fn.char2nr(string, utf8) end
+
+--- Return the character class of the first character in {string}.
+--- The character class is one of:
+---   0  blank
+---   1  punctuation
+---   2  word character
+---   3  emoji
+---   other  specific Unicode class
+--- The class is used in patterns and word motions.
+--- Returns 0 if {string} is not a |String|.
+---
+---
+--- @param string string
+--- @return any
+function vim.fn.charclass(string) end
+
+--- Same as |col()| but returns the character index of the column
+--- position given with {expr} instead of the byte position.
+---
+--- Example:
+--- With the cursor on '세' in line 5 with text "여보세요": >
+---   charcol('.')    returns 3
+---   col('.')    returns 7
+---
+--- <Can also be used as a |method|: >
+---   GetPos()->col()
+--- <
+---           *charidx()*
+--- @param expr any
+--- @param winid? integer
+--- @return any
+function vim.fn.charcol(expr, winid) end
+
+--- Return the character index of the byte at {idx} in {string}.
+--- The index of the first character is zero.
+--- If there are no multibyte characters the returned value is
+--- equal to {idx}.
+---
+--- When {countcc} is omitted or |FALSE|, then composing characters
+--- are not counted separately, their byte length is added to the
+--- preceding base character.
+--- When {countcc} is |TRUE|, then composing characters are
+--- counted as separate characters.
+---
+--- When {utf16} is present and TRUE, {idx} is used as the UTF-16
+--- index in the String {expr} instead of as the byte index.
+---
+--- Returns -1 if the arguments are invalid or if there are less
+--- than {idx} bytes. If there are exactly {idx} bytes the length
+--- of the string in characters is returned.
+---
+--- An error is given and -1 is returned if the first argument is
+--- not a string, the second argument is not a number or when the
+--- third argument is present and is not zero or one.
+---
+--- See |byteidx()| and |byteidxcomp()| for getting the byte index
+--- from the character index and |utf16idx()| for getting the
+--- UTF-16 index from the character index.
+--- Refer to |string-offset-encoding| for more information.
+--- Examples: >
+---   echo charidx('áb́ć', 3)    returns 1
+---   echo charidx('áb́ć', 6, 1)  returns 4
+---   echo charidx('áb́ć', 16)    returns -1
+---   echo charidx('a😊😊', 4, 0, 1)  returns 2
+--- <
+--- Can also be used as a |method|: >
+---   GetName()->charidx(idx)
+---
+--- @param string string
+--- @param idx integer
+--- @param countcc? any
+--- @param utf16? any
+--- @return any
+function vim.fn.charidx(string, idx, countcc, utf16) end
+
+--- Change the current working directory to {dir}.  The scope of
+--- the directory change depends on the directory of the current
+--- window:
+---   - If the current window has a window-local directory
+---     (|:lcd|), then changes the window local directory.
+---   - Otherwise, if the current tabpage has a local
+---     directory (|:tcd|) then changes the tabpage local
+---     directory.
+---   - Otherwise, changes the global directory.
+--- {dir} must be a String.
+--- If successful, returns the previous working directory.  Pass
+--- this to another chdir() to restore the directory.
+--- On failure, returns an empty string.
+---
+--- Example: >
+---   let save_dir = chdir(newdir)
+---   if save_dir != ""
+---      " ... do some work
+---      call chdir(save_dir)
+---   endif
+---
+--- <Can also be used as a |method|: >
+---   GetDir()->chdir()
+--- <
+--- @param dir string
+--- @return any
+function vim.fn.chdir(dir) end
+
+--- Get the amount of indent for line {lnum} according the C
+--- indenting rules, as with 'cindent'.
+--- The indent is counted in spaces, the value of 'tabstop' is
+--- relevant.  {lnum} is used just like in |getline()|.
+--- When {lnum} is invalid -1 is returned.
+--- See |C-indenting|.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->cindent()
+---
+--- @param lnum integer
+--- @return any
+function vim.fn.cindent(lnum) end
+
+--- Clears all matches previously defined for the current window
+--- by |matchadd()| and the |:match| commands.
+--- If {win} is specified, use the window with this number or
+--- window ID instead of the current window.
+---
+--- Can also be used as a |method|: >
+---   GetWin()->clearmatches()
+--- <
+--- @param win? any
+--- @return any
+function vim.fn.clearmatches(win) end
+
+--- The result is a Number, which is the byte index of the column
+--- position given with {expr}.  The accepted positions are:
+---     .      the cursor position
+---     $      the end of the cursor line (the result is the
+---       number of bytes in the cursor line plus one)
+---     'x      position of mark x (if the mark is not set, 0 is
+---       returned)
+---     v       In Visual mode: the start of the Visual area (the
+---       cursor is the end).  When not in Visual mode
+---       returns the cursor position.  Differs from |'<| in
+---       that it's updated right away.
+--- Additionally {expr} can be [lnum, col]: a |List| with the line
+--- and column number. Most useful when the column is "$", to get
+--- the last column of a specific line.  When "lnum" or "col" is
+--- out of range then col() returns zero.
+--- With the optional {winid} argument the values are obtained for
+--- that window instead of the current window.
+--- To get the line number use |line()|.  To get both use
+--- |getpos()|.
+--- For the screen column position use |virtcol()|.  For the
+--- character position use |charcol()|.
+--- Note that only marks in the current file can be used.
+--- Examples: >
+---   col(".")    column of cursor
+---   col("$")    length of cursor line plus one
+---   col("'t")    column of mark t
+---   col("'" .. markname)  column of mark markname
+--- <The first column is 1.  Returns 0 if {expr} is invalid or when
+--- the window with ID {winid} is not found.
+--- For an uppercase mark the column may actually be in another
+--- buffer.
+--- For the cursor position, when 'virtualedit' is active, the
+--- column is one higher if the cursor is after the end of the
+--- line.  Also, when using a <Cmd> mapping the cursor isn't
+--- moved, this can be used to obtain the column in Insert mode: >
+---   :imap <F2> <Cmd>echo col(".").."\n"<CR>
+---
+--- <Can also be used as a |method|: >
+---   GetPos()->col()
+--- <
+---
+--- @param expr any
+--- @param winid? integer
+--- @return integer
+function vim.fn.col(expr, winid) end
+
+--- Set the matches for Insert mode completion.
+--- Can only be used in Insert mode.  You need to use a mapping
+--- with CTRL-R = (see |i_CTRL-R|).  It does not work after CTRL-O
+--- or with an expression mapping.
+--- {startcol} is the byte offset in the line where the completed
+--- text start.  The text up to the cursor is the original text
+--- that will be replaced by the matches.  Use col('.') for an
+--- empty string.  "col('.') - 1" will replace one character by a
+--- match.
+--- {matches} must be a |List|.  Each |List| item is one match.
+--- See |complete-items| for the kind of items that are possible.
+--- "longest" in 'completeopt' is ignored.
+--- Note that the after calling this function you need to avoid
+--- inserting anything that would cause completion to stop.
+--- The match can be selected with CTRL-N and CTRL-P as usual with
+--- Insert mode completion.  The popup menu will appear if
+--- specified, see |ins-completion-menu|.
+--- Example: >
+---   inoremap <F5> <C-R>=ListMonths()<CR>
+---
+---   func ListMonths()
+---     call complete(col('.'), ['January', 'February', 'March',
+--- \ 'April', 'May', 'June', 'July', 'August', 'September',
+--- \ 'October', 'November', 'December'])
+---     return ''
+---   endfunc
+--- <This isn't very useful, but it shows how it works.  Note that
+--- an empty string is returned to avoid a zero being inserted.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- second argument: >
+---   GetMatches()->complete(col('.'))
+---
+--- @param startcol any
+--- @param matches any
+function vim.fn.complete(startcol, matches) end
+
+--- Add {expr} to the list of matches.  Only to be used by the
+--- function specified with the 'completefunc' option.
+--- Returns 0 for failure (empty string or out of memory),
+--- 1 when the match was added, 2 when the match was already in
+--- the list.
+--- See |complete-functions| for an explanation of {expr}.  It is
+--- the same as one item in the list that 'omnifunc' would return.
+---
+--- Can also be used as a |method|: >
+---   GetMoreMatches()->complete_add()
+---
+--- @param expr any
+--- @return 0|1|2
+function vim.fn.complete_add(expr) end
+
+--- Check for a key typed while looking for completion matches.
+--- This is to be used when looking for matches takes some time.
+--- Returns |TRUE| when searching for matches is to be aborted,
+--- zero otherwise.
+--- Only to be used by the function specified with the
+--- 'completefunc' option.
+---
+---
+--- @return 0|1
+function vim.fn.complete_check() end
+
+--- Returns a |Dictionary| with information about Insert mode
+--- completion.  See |ins-completion|.
+--- The items are:
+---    mode    Current completion mode name string.
+---     See |complete_info_mode| for the values.
+---    pum_visible  |TRUE| if popup menu is visible.
+---     See |pumvisible()|.
+---    items  List of completion matches.  Each item is a
+---     dictionary containing the entries "word",
+---     "abbr", "menu", "kind", "info" and "user_data".
+---     See |complete-items|.
+---    selected  Selected item index.  First index is zero.
+---     Index is -1 if no item is selected (showing
+---     typed text only, or the last completion after
+---     no item is selected when using the <Up> or
+---     <Down> keys)
+---    inserted  Inserted string. [NOT IMPLEMENTED YET]
+---
+---           *complete_info_mode*
+--- mode values are:
+---    ""         Not in completion mode
+---    "keyword"       Keyword completion |i_CTRL-X_CTRL-N|
+---    "ctrl_x"       Just pressed CTRL-X |i_CTRL-X|
+---    "scroll"       Scrolling with |i_CTRL-X_CTRL-E| or
+---          |i_CTRL-X_CTRL-Y|
+---    "whole_line"       Whole lines |i_CTRL-X_CTRL-L|
+---    "files"       File names |i_CTRL-X_CTRL-F|
+---    "tags"       Tags |i_CTRL-X_CTRL-]|
+---    "path_defines"    Definition completion |i_CTRL-X_CTRL-D|
+---    "path_patterns"   Include completion |i_CTRL-X_CTRL-I|
+---    "dictionary"       Dictionary |i_CTRL-X_CTRL-K|
+---    "thesaurus"       Thesaurus |i_CTRL-X_CTRL-T|
+---    "cmdline"       Vim Command line |i_CTRL-X_CTRL-V|
+---    "function"       User defined completion |i_CTRL-X_CTRL-U|
+---    "omni"       Omni completion |i_CTRL-X_CTRL-O|
+---    "spell"       Spelling suggestions |i_CTRL-X_s|
+---    "eval"       |complete()| completion
+---    "unknown"       Other internal modes
+---
+--- If the optional {what} list argument is supplied, then only
+--- the items listed in {what} are returned.  Unsupported items in
+--- {what} are silently ignored.
+---
+--- To get the position and size of the popup menu, see
+--- |pum_getpos()|. It's also available in |v:event| during the
+--- |CompleteChanged| event.
+---
+--- Returns an empty |Dictionary| on error.
+---
+--- Examples: >
+---   " Get all items
+---   call complete_info()
+---   " Get only 'mode'
+---   call complete_info(['mode'])
+---   " Get only 'mode' and 'pum_visible'
+---   call complete_info(['mode', 'pum_visible'])
+---
+--- <Can also be used as a |method|: >
+---   GetItems()->complete_info()
+--- <
+---         *confirm()*
+--- @param what? any
+--- @return table
+function vim.fn.complete_info(what) end
+
+--- confirm() offers the user a dialog, from which a choice can be
+--- made.  It returns the number of the choice.  For the first
+--- choice this is 1.
+---
+--- {msg} is displayed in a dialog with {choices} as the
+--- alternatives.  When {choices} is missing or empty, "&OK" is
+--- used (and translated).
+--- {msg} is a String, use '\n' to include a newline.  Only on
+--- some systems the string is wrapped when it doesn't fit.
+---
+--- {choices} is a String, with the individual choices separated
+--- by '\n', e.g. >
+---   confirm("Save changes?", "&Yes\n&No\n&Cancel")
+--- <The letter after the '&' is the shortcut key for that choice.
+--- Thus you can type 'c' to select "Cancel".  The shortcut does
+--- not need to be the first letter: >
+---   confirm("file has been modified", "&Save\nSave &All")
+--- <For the console, the first letter of each choice is used as
+--- the default shortcut key.  Case is ignored.
+---
+--- The optional {type} String argument gives the type of dialog.
+--- It can be one of these values: "Error", "Question", "Info",
+--- "Warning" or "Generic".  Only the first character is relevant.
+--- When {type} is omitted, "Generic" is used.
+---
+--- The optional {type} argument gives the type of dialog.  This
+--- is only used for the icon of the Win32 GUI.  It can be one of
+--- these values: "Error", "Question", "Info", "Warning" or
+--- "Generic".  Only the first character is relevant.
+--- When {type} is omitted, "Generic" is used.
+---
+--- If the user aborts the dialog by pressing <Esc>, CTRL-C,
+--- or another valid interrupt key, confirm() returns 0.
+---
+--- An example: >
+---    let choice = confirm("What do you want?",
+---       \ "&Apples\n&Oranges\n&Bananas", 2)
+---    if choice == 0
+---   echo "make up your mind!"
+---    elseif choice == 3
+---   echo "tasteful"
+---    else
+---   echo "I prefer bananas myself."
+---    endif
+--- <In a GUI dialog, buttons are used.  The layout of the buttons
+--- depends on the 'v' flag in 'guioptions'.  If it is included,
+--- the buttons are always put vertically.  Otherwise,  confirm()
+--- tries to put the buttons in one horizontal line.  If they
+--- don't fit, a vertical layout is used anyway.  For some systems
+--- the horizontal layout is always used.
+---
+--- Can also be used as a |method|in: >
+---   BuildMessage()->confirm("&Yes\n&No")
+--- <
+---           *copy()*
+--- @param msg any
+--- @param choices? any
+--- @param default? any
+--- @param type? any
+--- @return any
+function vim.fn.confirm(msg, choices, default, type) end
+
+--- different from using {expr} directly.
+--- When {expr} is a |List| a shallow copy is created.  This means
+--- that the original |List| can be changed without changing the
+--- copy, and vice versa.  But the items are identical, thus
+--- changing an item changes the contents of both |Lists|.
+--- A |Dictionary| is copied in a similar way as a |List|.
+--- Also see |deepcopy()|.
+--- Can also be used as a |method|: >
+---   mylist->copy()
+---
+--- @param expr any
+--- @return any
+function vim.fn.copy(expr) end
+
+--- Return the cosine of {expr}, measured in radians, as a |Float|.
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo cos(100)
+--- <  0.862319 >
+---   :echo cos(-4.01)
+--- <  -0.646043
+---
+--- Can also be used as a |method|: >
+---   Compute()->cos()
+---
+--- @param expr any
+--- @return any
+function vim.fn.cos(expr) end
+
+--- Return the hyperbolic cosine of {expr} as a |Float| in the range
+--- [1, inf].
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo cosh(0.5)
+--- <  1.127626 >
+---   :echo cosh(-0.5)
+--- <  -1.127626
+---
+--- Can also be used as a |method|: >
+---   Compute()->cosh()
+---
+--- @param expr any
+--- @return any
+function vim.fn.cosh(expr) end
+
+--- Return the number of times an item with value {expr} appears
+--- in |String|, |List| or |Dictionary| {comp}.
+---
+--- If {start} is given then start with the item with this index.
+--- {start} can only be used with a |List|.
+---
+--- When {ic} is given and it's |TRUE| then case is ignored.
+---
+--- When {comp} is a string then the number of not overlapping
+--- occurrences of {expr} is returned. Zero is returned when
+--- {expr} is an empty string.
+---
+--- Can also be used as a |method|: >
+---   mylist->count(val)
+--- <
+--- @param comp any
+--- @param expr any
+--- @param ic? any
+--- @param start? any
+--- @return any
+function vim.fn.count(comp, expr, ic, start) end
+
+--- Returns a |Dictionary| representing the |context| at {index}
+--- from the top of the |context-stack| (see |context-dict|).
+--- If {index} is not given, it is assumed to be 0 (i.e.: top).
+---
+--- @param index? any
+--- @return any
+function vim.fn.ctxget(index) end
+
+--- Pops and restores the |context| at the top of the
+--- |context-stack|.
+---
+--- @return any
+function vim.fn.ctxpop() end
+
+--- Pushes the current editor state (|context|) on the
+--- |context-stack|.
+--- If {types} is given and is a |List| of |String|s, it specifies
+--- which |context-types| to include in the pushed context.
+--- Otherwise, all context types are included.
+---
+--- @param types? any
+--- @return any
+function vim.fn.ctxpush(types) end
+
+--- Sets the |context| at {index} from the top of the
+--- |context-stack| to that represented by {context}.
+--- {context} is a Dictionary with context data (|context-dict|).
+--- If {index} is not given, it is assumed to be 0 (i.e.: top).
+---
+--- @param context any
+--- @param index? any
+--- @return any
+function vim.fn.ctxset(context, index) end
+
+--- Returns the size of the |context-stack|.
+---
+--- @return any
+function vim.fn.ctxsize() end
+
+--- Positions the cursor at the column (byte count) {col} in the
+--- line {lnum}.  The first column is one.
+---
+--- When there is one argument {list} this is used as a |List|
+--- with two, three or four item:
+---   [{lnum}, {col}]
+---   [{lnum}, {col}, {off}]
+---   [{lnum}, {col}, {off}, {curswant}]
+--- This is like the return value of |getpos()| or |getcurpos()|,
+--- but without the first item.
+---
+--- To position the cursor using {col} as the character count, use
+--- |setcursorcharpos()|.
+---
+--- Does not change the jumplist.
+--- {lnum} is used like with |getline()|, except that if {lnum} is
+--- zero, the cursor will stay in the current line.
+--- If {lnum} is greater than the number of lines in the buffer,
+--- the cursor will be positioned at the last line in the buffer.
+--- If {col} is greater than the number of bytes in the line,
+--- the cursor will be positioned at the last character in the
+--- line.
+--- If {col} is zero, the cursor will stay in the current column.
+--- If {curswant} is given it is used to set the preferred column
+--- for vertical movement.  Otherwise {col} is used.
+---
+--- When 'virtualedit' is used {off} specifies the offset in
+--- screen columns from the start of the character.  E.g., a
+--- position within a <Tab> or after the last character.
+--- Returns 0 when the position could be set, -1 otherwise.
+---
+--- Can also be used as a |method|: >
+---   GetCursorPos()->cursor()
+---
+--- @param list any
+--- @return any
+function vim.fn.cursor(list) end
+
+--- Specifically used to interrupt a program being debugged.  It
+--- will cause process {pid} to get a SIGTRAP.  Behavior for other
+--- processes is undefined. See |terminal-debug|.
+--- (Sends a SIGINT to a process {pid} other than MS-Windows)
+---
+--- Returns |TRUE| if successfully interrupted the program.
+--- Otherwise returns |FALSE|.
+---
+--- Can also be used as a |method|: >
+---   GetPid()->debugbreak()
+---
+--- @param pid any
+--- @return any
+function vim.fn.debugbreak(pid) end
+
+--- Make a copy of {expr}.  For Numbers and Strings this isn't
+--- different from using {expr} directly.
+--- When {expr} is a |List| a full copy is created.  This means
+--- that the original |List| can be changed without changing the
+--- copy, and vice versa.  When an item is a |List|, a copy for it
+--- is made, recursively.  Thus changing an item in the copy does
+--- not change the contents of the original |List|.
+---
+--- When {noref} is omitted or zero a contained |List| or
+--- |Dictionary| is only copied once.  All references point to
+--- this single copy.  With {noref} set to 1 every occurrence of a
+--- |List| or |Dictionary| results in a new copy.  This also means
+--- that a cyclic reference causes deepcopy() to fail.
+---             *E724*
+--- Nesting is possible up to 100 levels.  When there is an item
+--- that refers back to a higher level making a deep copy with
+--- {noref} set to 1 will fail.
+--- Also see |copy()|.
+---
+--- Can also be used as a |method|: >
+---   GetObject()->deepcopy()
+---
+--- @param expr any
+--- @param noref? any
+--- @return any
+function vim.fn.deepcopy(expr, noref) end
+
+--- Without {flags} or with {flags} empty: Deletes the file by the
+--- name {fname}.
+---
+--- This also works when {fname} is a symbolic link.  The symbolic
+--- link itself is deleted, not what it points to.
+---
+--- When {flags} is "d": Deletes the directory by the name
+--- {fname}.  This fails when directory {fname} is not empty.
+---
+--- When {flags} is "rf": Deletes the directory by the name
+--- {fname} and everything in it, recursively.  BE CAREFUL!
+--- Note: on MS-Windows it is not possible to delete a directory
+--- that is being used.
+---
+--- The result is a Number, which is 0/false if the delete
+--- operation was successful and -1/true when the deletion failed
+--- or partly failed.
+---
+--- Can also be used as a |method|: >
+---   GetName()->delete()
+---
+--- @param fname integer
+--- @param flags? string
+--- @return integer
+function vim.fn.delete(fname, flags) end
+
+--- Delete lines {first} to {last} (inclusive) from buffer {buf}.
+--- If {last} is omitted then delete line {first} only.
+--- On success 0 is returned, on failure 1 is returned.
+---
+--- This function works only for loaded buffers. First call
+--- |bufload()| if needed.
+---
+--- For the use of {buf}, see |bufname()| above.
+---
+--- {first} and {last} are used like with |getline()|. Note that
+--- when using |line()| this refers to the current buffer. Use "$"
+--- to refer to the last line in buffer {buf}.
+---
+--- Can also be used as a |method|: >
+---   GetBuffer()->deletebufline(1)
+--- <
+--- @param buf any
+--- @param first any
+--- @param last? any
+--- @return any
+function vim.fn.deletebufline(buf, first, last) end
+
+--- Adds a watcher to a dictionary. A dictionary watcher is
+--- identified by three components:
+---
+--- - A dictionary({dict});
+--- - A key pattern({pattern}).
+--- - A function({callback}).
+---
+--- After this is called, every change on {dict} and on keys
+--- matching {pattern} will result in {callback} being invoked.
+---
+--- For example, to watch all global variables: >
+---   silent! call dictwatcherdel(g:, '*', 'OnDictChanged')
+---   function! OnDictChanged(d,k,z)
+---     echomsg string(a:k) string(a:z)
+---   endfunction
+---   call dictwatcheradd(g:, '*', 'OnDictChanged')
+--- <
+--- For now {pattern} only accepts very simple patterns that can
+--- contain a "*" at the end of the string, in which case it will
+--- match every key that begins with the substring before the "*".
+--- That means if "*" is not the last character of {pattern}, only
+--- keys that are exactly equal as {pattern} will be matched.
+---
+--- The {callback} receives three arguments:
+---
+--- - The dictionary being watched.
+--- - The key which changed.
+--- - A dictionary containing the new and old values for the key.
+---
+--- The type of change can be determined by examining the keys
+--- present on the third argument:
+---
+--- - If contains both `old` and `new`, the key was updated.
+--- - If it contains only `new`, the key was added.
+--- - If it contains only `old`, the key was deleted.
+---
+--- This function can be used by plugins to implement options with
+--- validation and parsing logic.
+---
+--- @param dict any
+--- @param pattern any
+--- @param callback any
+--- @return any
+function vim.fn.dictwatcheradd(dict, pattern, callback) end
+
+--- Removes a watcher added  with |dictwatcheradd()|. All three
+--- arguments must match the ones passed to |dictwatcheradd()| in
+--- order for the watcher to be successfully deleted.
+---
+---           *did_filetype()*
+--- @param dict any
+--- @param pattern any
+--- @param callback any
+--- @return any
+function vim.fn.dictwatcherdel(dict, pattern, callback) end
+
+--- FileType event has been triggered at least once.  Can be used
+--- to avoid triggering the FileType event again in the scripts
+--- that detect the file type. |FileType|
+--- Returns |FALSE| when `:setf FALLBACK` was used.
+--- When editing another file, the counter is reset, thus this
+--- really checks if the FileType event has been triggered for the
+--- current buffer.  This allows an autocommand that starts
+--- editing another buffer to set 'filetype' and load a syntax
+--- file.
+---
+--- @return any
+function vim.fn.did_filetype() end
+
+--- Returns the number of filler lines above line {lnum}.
+--- These are the lines that were inserted at this point in
+--- another diff'ed window.  These filler lines are shown in the
+--- display but don't exist in the buffer.
+--- {lnum} is used like with |getline()|.  Thus "." is the current
+--- line, "'m" mark m, etc.
+--- Returns 0 if the current window is not in diff mode.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->diff_filler()
+---
+--- @param lnum integer
+--- @return any
+function vim.fn.diff_filler(lnum) end
+
+--- Returns the highlight ID for diff mode at line {lnum} column
+--- {col} (byte index).  When the current line does not have a
+--- diff change zero is returned.
+--- {lnum} is used like with |getline()|.  Thus "." is the current
+--- line, "'m" mark m, etc.
+--- {col} is 1 for the leftmost column, {lnum} is 1 for the first
+--- line.
+--- The highlight ID can be used with |synIDattr()| to obtain
+--- syntax information about the highlighting.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->diff_hlID(col)
+--- <
+---
+--- @param lnum integer
+--- @param col integer
+--- @return any
+function vim.fn.diff_hlID(lnum, col) end
+
+--- Return the digraph of {chars}.  This should be a string with
+--- exactly two characters.  If {chars} are not just two
+--- characters, or the digraph of {chars} does not exist, an error
+--- is given and an empty string is returned.
+---
+--- Also see |digraph_getlist()|.
+---
+--- Examples: >
+--- " Get a built-in digraph
+--- :echo digraph_get('00')    " Returns '∞'
+---
+--- " Get a user-defined digraph
+--- :call digraph_set('aa', 'あ')
+--- :echo digraph_get('aa')    " Returns 'あ'
+--- <
+--- Can also be used as a |method|: >
+---   GetChars()->digraph_get()
+--- <
+---
+--- @param chars any
+--- @return any
+function vim.fn.digraph_get(chars) end
+
+--- Return a list of digraphs.  If the {listall} argument is given
+--- and it is TRUE, return all digraphs, including the default
+--- digraphs.  Otherwise, return only user-defined digraphs.
+---
+--- Also see |digraph_get()|.
+---
+--- Examples: >
+--- " Get user-defined digraphs
+--- :echo digraph_getlist()
+---
+--- " Get all the digraphs, including default digraphs
+--- :echo digraph_getlist(1)
+--- <
+--- Can also be used as a |method|: >
+---   GetNumber()->digraph_getlist()
+--- <
+---
+--- @param listall? any
+--- @return any
+function vim.fn.digraph_getlist(listall) end
+
+--- Add digraph {chars} to the list.  {chars} must be a string
+--- with two characters.  {digraph} is a string with one UTF-8
+--- encoded character.  *E1215*
+--- Be careful, composing characters are NOT ignored.  This
+--- function is similar to |:digraphs| command, but useful to add
+--- digraphs start with a white space.
+---
+--- The function result is v:true if |digraph| is registered.  If
+--- this fails an error message is given and v:false is returned.
+---
+--- If you want to define multiple digraphs at once, you can use
+--- |digraph_setlist()|.
+---
+--- Example: >
+---   call digraph_set('  ', 'あ')
+--- <
+--- Can be used as a |method|: >
+---   GetString()->digraph_set('あ')
+--- <
+---
+--- @param chars any
+--- @param digraph any
+--- @return any
+function vim.fn.digraph_set(chars, digraph) end
+
+--- Similar to |digraph_set()| but this function can add multiple
+--- digraphs at once.  {digraphlist} is a list composed of lists,
+--- where each list contains two strings with {chars} and
+--- {digraph} as in |digraph_set()|. *E1216*
+--- Example: >
+---     call digraph_setlist([['aa', 'あ'], ['ii', 'い']])
+--- <
+--- It is similar to the following: >
+---     for [chars, digraph] in [['aa', 'あ'], ['ii', 'い']]
+---     call digraph_set(chars, digraph)
+---     endfor
+--- <Except that the function returns after the first error,
+--- following digraphs will not be added.
+---
+--- Can be used as a |method|: >
+---     GetList()->digraph_setlist()
+--- <
+---
+--- @param digraphlist any
+--- @return any
+function vim.fn.digraph_setlist(digraphlist) end
+
+--- Return the Number 1 if {expr} is empty, zero otherwise.
+--- - A |List| or |Dictionary| is empty when it does not have any
+---   items.
+--- - A |String| is empty when its length is zero.
+--- - A |Number| and |Float| are empty when their value is zero.
+--- - |v:false| and |v:null| are empty, |v:true| is not.
+--- - A |Blob| is empty when its length is zero.
+---
+--- Can also be used as a |method|: >
+---   mylist->empty()
+---
+--- @param expr any
+--- @return any
+function vim.fn.empty(expr) end
+
+--- Return all of environment variables as dictionary. You can
+--- check if an environment variable exists like this: >
+---   :echo has_key(environ(), 'HOME')
+--- <Note that the variable name may be CamelCase; to ignore case
+--- use this: >
+---   :echo index(keys(environ()), 'HOME', 0, 1) != -1
+---
+--- @return any
+function vim.fn.environ() end
+
+--- Escape the characters in {chars} that occur in {string} with a
+--- backslash.  Example: >
+---   :echo escape('c:\program files\vim', ' \')
+--- <results in: >
+---   c:\\program\ files\\vim
+--- <Also see |shellescape()| and |fnameescape()|.
+---
+--- Can also be used as a |method|: >
+---   GetText()->escape(' \')
+--- <
+---           *eval()*
+--- @param string string
+--- @param chars any
+--- @return any
+function vim.fn.escape(string, chars) end
+
+--- turn the result of |string()| back into the original value.
+--- This works for Numbers, Floats, Strings, Blobs and composites
+--- of them.  Also works for |Funcref|s that refer to existing
+--- functions.
+---
+--- Can also be used as a |method|: >
+---   argv->join()->eval()
+---
+--- @param string string
+--- @return any
+function vim.fn.eval(string) end
+
+--- Returns 1 when inside an event handler.  That is that Vim got
+--- interrupted while waiting for the user to type a character,
+--- e.g., when dropping a file on Vim.  This means interactive
+--- commands cannot be used.  Otherwise zero is returned.
+---
+--- @return any
+function vim.fn.eventhandler() end
+
+--- This function checks if an executable with the name {expr}
+--- exists.  {expr} must be the name of the program without any
+--- arguments.
+--- executable() uses the value of $PATH and/or the normal
+--- searchpath for programs.    *PATHEXT*
+--- On MS-Windows the ".exe", ".bat", etc. can optionally be
+--- included.  Then the extensions in $PATHEXT are tried.  Thus if
+--- "foo.exe" does not exist, "foo.exe.bat" can be found.  If
+--- $PATHEXT is not set then ".exe;.com;.bat;.cmd" is used.  A dot
+--- by itself can be used in $PATHEXT to try using the name
+--- without an extension.  When 'shell' looks like a Unix shell,
+--- then the name is also tried without adding an extension.
+--- On MS-Windows it only checks if the file exists and is not a
+--- directory, not if it's really executable.
+--- On Windows an executable in the same directory as Vim is
+--- always found (it is added to $PATH at |startup|).
+--- The result is a Number:
+---   1  exists
+---   0  does not exist
+---   -1  not implemented on this system
+--- |exepath()| can be used to get the full path of an executable.
+---
+--- Can also be used as a |method|: >
+---   GetCommand()->executable()
+---
+--- @param expr any
+--- @return any
+function vim.fn.executable(expr) end
+
+--- Execute {command} and capture its output.
+--- If {command} is a |String|, returns {command} output.
+--- If {command} is a |List|, returns concatenated outputs.
+--- Line continuations in {command} are not recognized.
+--- Examples: >
+---   echo execute('echon "foo"')
+--- <  foo >
+---   echo execute(['echon "foo"', 'echon "bar"'])
+--- <  foobar
+---
+--- The optional {silent} argument can have these values:
+---   ""    no `:silent` used
+---   "silent"  `:silent` used
+---   "silent!"  `:silent!` used
+--- The default is "silent".  Note that with "silent!", unlike
+--- `:redir`, error messages are dropped.
+---
+--- To get a list of lines use `split()` on the result: >
+---   execute('args')->split("\n")
+---
+--- <This function is not available in the |sandbox|.
+--- Note: If nested, an outer execute() will not observe output of
+--- the inner calls.
+--- Note: Text attributes (highlights) are not captured.
+--- To execute a command in another window than the current one
+--- use `win_execute()`.
+---
+--- Can also be used as a |method|: >
+---   GetCommand()->execute()
+---
+--- @param command any
+--- @param silent? boolean
+--- @return any
+function vim.fn.execute(command, silent) end
+
+--- Returns the full path of {expr} if it is an executable and
+--- given as a (partial or full) path or is found in $PATH.
+--- Returns empty string otherwise.
+--- If {expr} starts with "./" the |current-directory| is used.
+---
+--- Can also be used as a |method|: >
+---   GetCommand()->exepath()
+--- <
+---           *exists()*
+--- @param expr any
+--- @return any
+function vim.fn.exepath(expr) end
+
+--- defined, zero otherwise.
+---
+--- For checking for a supported feature use |has()|.
+--- For checking if a file exists use |filereadable()|.
+---
+--- The {expr} argument is a string, which contains one of these:
+---   varname    internal variable (see
+---   dict.key  |internal-variables|).  Also works
+---   list[i]    for |curly-braces-names|, |Dictionary|
+---       entries, |List| items, etc.
+---       Beware that evaluating an index may
+---       cause an error message for an invalid
+---       expression.  E.g.: >
+---          :let l = [1, 2, 3]
+---          :echo exists("l[5]")
+--- <         0 >
+---          :echo exists("l[xx]")
+--- <         E121: Undefined variable: xx
+---          0
+---   &option-name  Vim option (only checks if it exists,
+---       not if it really works)
+---   +option-name  Vim option that works.
+---   $ENVNAME  environment variable (could also be
+---       done by comparing with an empty
+---       string)
+---   `*funcname`  built-in function (see |functions|)
+---       or user defined function (see
+---       |user-function|). Also works for a
+---       variable that is a Funcref.
+---   :cmdname  Ex command: built-in command, user
+---       command or command modifier |:command|.
+---       Returns:
+---       1  for match with start of a command
+---       2  full match with a command
+---       3  matches several user commands
+---       To check for a supported command
+---       always check the return value to be 2.
+---   :2match    The |:2match| command.
+---   :3match    The |:3match| command (but you
+---       probably should not use it, it is
+---       reserved for internal usage)
+---   #event    autocommand defined for this event
+---   #event#pattern  autocommand defined for this event and
+---       pattern (the pattern is taken
+---       literally and compared to the
+---       autocommand patterns character by
+---       character)
+---   #group    autocommand group exists
+---   #group#event  autocommand defined for this group and
+---       event.
+---   #group#event#pattern
+---       autocommand defined for this group,
+---       event and pattern.
+---   ##event    autocommand for this event is
+---       supported.
+---
+--- Examples: >
+---   exists("&mouse")
+---   exists("$HOSTNAME")
+---   exists("*strftime")
+---   exists("*s:MyFunc")
+---   exists("*MyFunc")
+---   exists("bufcount")
+---   exists(":Make")
+---   exists("#CursorHold")
+---   exists("#BufReadPre#*.gz")
+---   exists("#filetypeindent")
+---   exists("#filetypeindent#FileType")
+---   exists("#filetypeindent#FileType#*")
+---   exists("##ColorScheme")
+--- <There must be no space between the symbol (&/$/*/#) and the
+--- name.
+--- There must be no extra characters after the name, although in
+--- a few cases this is ignored.  That may become stricter in the
+--- future, thus don't count on it!
+--- Working example: >
+---   exists(":make")
+--- <NOT working example: >
+---   exists(":make install")
+---
+--- <Note that the argument must be a string, not the name of the
+--- variable itself.  For example: >
+---   exists(bufcount)
+--- <This doesn't check for existence of the "bufcount" variable,
+--- but gets the value of "bufcount", and checks if that exists.
+---
+--- Can also be used as a |method|: >
+---   Varname()->exists()
+---
+--- @param expr any
+--- @return 0|1
+function vim.fn.exists(expr) end
+
+--- Return the exponential of {expr} as a |Float| in the range
+--- [0, inf].
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo exp(2)
+--- <  7.389056 >
+---   :echo exp(-1)
+--- <  0.367879
+---
+--- Can also be used as a |method|: >
+---   Compute()->exp()
+---
+--- @param expr any
+--- @return any
+function vim.fn.exp(expr) end
+
+--- Expand wildcards and the following special keywords in
+--- {string}.  'wildignorecase' applies.
+---
+--- If {list} is given and it is |TRUE|, a List will be returned.
+--- Otherwise the result is a String and when there are several
+--- matches, they are separated by <NL> characters.
+---
+--- If the expansion fails, the result is an empty string.  A name
+--- for a non-existing file is not included, unless {string} does
+--- not start with '%', '#' or '<', see below.
+---
+--- When {string} starts with '%', '#' or '<', the expansion is
+--- done like for the |cmdline-special| variables with their
+--- associated modifiers.  Here is a short overview:
+---
+---   %    current file name
+---   #    alternate file name
+---   #n    alternate file name n
+---   <cfile>    file name under the cursor
+---   <afile>    autocmd file name
+---   <abuf>    autocmd buffer number (as a String!)
+---   <amatch>  autocmd matched name
+---   <cexpr>    C expression under the cursor
+---   <sfile>    sourced script file or function name
+---   <slnum>    sourced script line number or function
+---       line number
+---   <sflnum>  script file line number, also when in
+---       a function
+---   <SID>    "<SNR>123_"  where "123" is the
+---       current script ID  |<SID>|
+---   <script>  sourced script file, or script file
+---       where the current function was defined
+---   <stack>    call stack
+---   <cword>    word under the cursor
+---   <cWORD>    WORD under the cursor
+---   <client>  the {clientid} of the last received
+---       message
+--- Modifiers:
+---   :p    expand to full path
+---   :h    head (last path component removed)
+---   :t    tail (last path component only)
+---   :r    root (one extension removed)
+---   :e    extension only
+---
+--- Example: >
+---   :let &tags = expand("%:p:h") .. "/tags"
+--- <Note that when expanding a string that starts with '%', '#' or
+--- '<', any following text is ignored.  This does NOT work: >
+---   :let doesntwork = expand("%:h.bak")
+--- <Use this: >
+---   :let doeswork = expand("%:h") .. ".bak"
+--- <Also note that expanding "<cfile>" and others only returns the
+--- referenced file name without further expansion.  If "<cfile>"
+--- is "~/.cshrc", you need to do another expand() to have the
+--- "~/" expanded into the path of the home directory: >
+---   :echo expand(expand("<cfile>"))
+--- <
+--- There cannot be white space between the variables and the
+--- following modifier.  The |fnamemodify()| function can be used
+--- to modify normal file names.
+---
+--- When using '%' or '#', and the current or alternate file name
+--- is not defined, an empty string is used.  Using "%:p" in a
+--- buffer with no name, results in the current directory, with a
+--- '/' added.
+--- When 'verbose' is set then expanding '%', '#' and <> items
+--- will result in an error message if the argument cannot be
+--- expanded.
+---
+--- When {string} does not start with '%', '#' or '<', it is
+--- expanded like a file name is expanded on the command line.
+--- 'suffixes' and 'wildignore' are used, unless the optional
+--- {nosuf} argument is given and it is |TRUE|.
+--- Names for non-existing files are included.  The "**" item can
+--- be used to search in a directory tree.  For example, to find
+--- all "README" files in the current directory and below: >
+---   :echo expand("**/README")
+--- <
+--- expand() can also be used to expand variables and environment
+--- variables that are only known in a shell.  But this can be
+--- slow, because a shell may be used to do the expansion.  See
+--- |expr-env-expand|.
+--- The expanded variable is still handled like a list of file
+--- names.  When an environment variable cannot be expanded, it is
+--- left unchanged.  Thus ":echo expand('$FOOBAR')" results in
+--- "$FOOBAR".
+---
+--- See |glob()| for finding existing files.  See |system()| for
+--- getting the raw output of an external command.
+---
+--- Can also be used as a |method|: >
+---   Getpattern()->expand()
+---
+--- @param string string
+--- @param nosuf? boolean
+--- @param list? any
+--- @return string|string[]
+function vim.fn.expand(string, nosuf, list) end
+
+--- Expand special items in String {string} like what is done for
+--- an Ex command such as `:edit`.  This expands special keywords,
+--- like with |expand()|, and environment variables, anywhere in
+--- {string}.  "~user" and "~/path" are only expanded at the
+--- start.
+---
+--- The following items are supported in the {options} Dict
+--- argument:
+---     errmsg  If set to TRUE, error messages are displayed
+---     if an error is encountered during expansion.
+---     By default, error messages are not displayed.
+---
+--- Returns the expanded string.  If an error is encountered
+--- during expansion, the unmodified {string} is returned.
+---
+--- Example: >
+---   :echo expandcmd('make %<.o')
+---   make /path/runtime/doc/builtin.o
+---   :echo expandcmd('make %<.o', {'errmsg': v:true})
+--- <
+--- Can also be used as a |method|: >
+---   GetCommand()->expandcmd()
+--- <
+--- @param string string
+--- @param options? table
+--- @return any
+function vim.fn.expandcmd(string, options) end
+
+--- {expr1} and {expr2} must be both |Lists| or both
+--- |Dictionaries|.
+---
+--- If they are |Lists|: Append {expr2} to {expr1}.
+--- If {expr3} is given insert the items of {expr2} before the
+--- item with index {expr3} in {expr1}.  When {expr3} is zero
+--- insert before the first item.  When {expr3} is equal to
+--- len({expr1}) then {expr2} is appended.
+--- Examples: >
+---   :echo sort(extend(mylist, [7, 5]))
+---   :call extend(mylist, [2, 3], 1)
+--- <When {expr1} is the same List as {expr2} then the number of
+--- items copied is equal to the original length of the List.
+--- E.g., when {expr3} is 1 you get N new copies of the first item
+--- (where N is the original length of the List).
+--- Use |add()| to concatenate one item to a list.  To concatenate
+--- two lists into a new list use the + operator: >
+---   :let newlist = [1, 2, 3] + [4, 5]
+--- <
+--- If they are |Dictionaries|:
+--- Add all entries from {expr2} to {expr1}.
+--- If a key exists in both {expr1} and {expr2} then {expr3} is
+--- used to decide what to do:
+--- {expr3} = "keep": keep the value of {expr1}
+--- {expr3} = "force": use the value of {expr2}
+--- {expr3} = "error": give an error message    *E737*
+--- When {expr3} is omitted then "force" is assumed.
+---
+--- {expr1} is changed when {expr2} is not empty.  If necessary
+--- make a copy of {expr1} first.
+--- {expr2} remains unchanged.
+--- When {expr1} is locked and {expr2} is not empty the operation
+--- fails.
+--- Returns {expr1}.  Returns 0 on error.
+---
+--- Can also be used as a |method|: >
+---   mylist->extend(otherlist)
+---
+---
+--- @param expr1 any
+--- @param expr2 any
+--- @param expr3? any
+--- @return any
+function vim.fn.extend(expr1, expr2, expr3) end
+
+--- Like |extend()| but instead of adding items to {expr1} a new
+--- List or Dictionary is created and returned.  {expr1} remains
+--- unchanged.
+---
+---
+--- @param expr1 any
+--- @param expr2 any
+--- @param expr3? any
+--- @return any
+function vim.fn.extendnew(expr1, expr2, expr3) end
+
+--- Characters in {string} are queued for processing as if they
+--- come from a mapping or were typed by the user.
+---
+--- By default the string is added to the end of the typeahead
+--- buffer, thus if a mapping is still being executed the
+--- characters come after them.  Use the 'i' flag to insert before
+--- other characters, they will be executed next, before any
+--- characters from a mapping.
+---
+--- The function does not wait for processing of keys contained in
+--- {string}.
+---
+--- To include special keys into {string}, use double-quotes
+--- and "\..." notation |expr-quote|. For example,
+--- feedkeys("\<CR>") simulates pressing of the <Enter> key. But
+--- feedkeys('\<CR>') pushes 5 characters.
+--- The |<Ignore>| keycode may be used to exit the
+--- wait-for-character without doing anything.
+---
+--- {mode} is a String, which can contain these character flags:
+--- 'm'  Remap keys. This is default.  If {mode} is absent,
+---   keys are remapped.
+--- 'n'  Do not remap keys.
+--- 't'  Handle keys as if typed; otherwise they are handled as
+---   if coming from a mapping.  This matters for undo,
+---   opening folds, etc.
+--- 'i'  Insert the string instead of appending (see above).
+--- 'x'  Execute commands until typeahead is empty.  This is
+---   similar to using ":normal!".  You can call feedkeys()
+---   several times without 'x' and then one time with 'x'
+---   (possibly with an empty {string}) to execute all the
+---   typeahead.  Note that when Vim ends in Insert mode it
+---   will behave as if <Esc> is typed, to avoid getting
+---   stuck, waiting for a character to be typed before the
+---   script continues.
+---   Note that if you manage to call feedkeys() while
+---   executing commands, thus calling it recursively, then
+---   all typeahead will be consumed by the last call.
+--- '!'  When used with 'x' will not end Insert mode. Can be
+---   used in a test when a timer is set to exit Insert mode
+---   a little later.  Useful for testing CursorHoldI.
+---
+--- Return value is always 0.
+---
+--- Can also be used as a |method|: >
+---   GetInput()->feedkeys()
+---
+--- @param string string
+--- @param mode? string
+--- @return any
+function vim.fn.feedkeys(string, mode) end
+
+--- @deprecated
+--- Obsolete name for |filereadable()|.
+function vim.fn.file_readable(...) end
+
+--- The result is a Number, which is |TRUE| when a file with the
+--- name {file} exists, and can be read.  If {file} doesn't exist,
+--- or is a directory, the result is |FALSE|.  {file} is any
+--- expression, which is used as a String.
+--- If you don't care about the file being readable you can use
+--- |glob()|.
+--- {file} is used as-is, you may want to expand wildcards first: >
+---   echo filereadable('~/.vimrc')
+---   0
+---   echo filereadable(expand('~/.vimrc'))
+---   1
+---
+--- <Can also be used as a |method|: >
+---   GetName()->filereadable()
+---
+--- @param file string
+--- @return 0|1
+function vim.fn.filereadable(file) end
+
+--- The result is a Number, which is 1 when a file with the
+--- name {file} exists, and can be written.  If {file} doesn't
+--- exist, or is not writable, the result is 0.  If {file} is a
+--- directory, and we can write to it, the result is 2.
+---
+--- Can also be used as a |method|: >
+---   GetName()->filewritable()
+---
+--- @param file string
+--- @return 0|1
+function vim.fn.filewritable(file) end
+
+--- {expr1} must be a |List|, |Blob|, or a |Dictionary|.
+--- For each item in {expr1} evaluate {expr2} and when the result
+--- is zero remove the item from the |List| or |Dictionary|. For a
+--- |Blob| each byte is removed.
+---
+--- {expr2} must be a |string| or |Funcref|.
+---
+--- If {expr2} is a |string|, inside {expr2} |v:val| has the value
+--- of the current item.  For a |Dictionary| |v:key| has the key
+--- of the current item and for a |List| |v:key| has the index of
+--- the current item.  For a |Blob| |v:key| has the index of the
+--- current byte.
+---
+--- Examples: >
+---   call filter(mylist, 'v:val !~ "OLD"')
+--- <Removes the items where "OLD" appears. >
+---   call filter(mydict, 'v:key >= 8')
+--- <Removes the items with a key below 8. >
+---   call filter(var, 0)
+--- <Removes all the items, thus clears the |List| or |Dictionary|.
+---
+--- Note that {expr2} is the result of expression and is then
+--- used as an expression again.  Often it is good to use a
+--- |literal-string| to avoid having to double backslashes.
+---
+--- If {expr2} is a |Funcref| it must take two arguments:
+---   1. the key or the index of the current item.
+---   2. the value of the current item.
+--- The function must return |TRUE| if the item should be kept.
+--- Example that keeps the odd items of a list: >
+---   func Odd(idx, val)
+---     return a:idx % 2 == 1
+---   endfunc
+---   call filter(mylist, function('Odd'))
+--- <It is shorter when using a |lambda|: >
+---   call filter(myList, {idx, val -> idx * val <= 42})
+--- <If you do not use "val" you can leave it out: >
+---   call filter(myList, {idx -> idx % 2 == 1})
+--- <
+--- The operation is done in-place.  If you want a |List| or
+--- |Dictionary| to remain unmodified make a copy first: >
+---   :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
+---
+--- <Returns {expr1}, the |List|, |Blob| or |Dictionary| that was
+--- filtered.  When an error is encountered while evaluating
+--- {expr2} no further items in {expr1} are processed.  When
+--- {expr2} is a Funcref errors inside a function are ignored,
+--- unless it was defined with the "abort" flag.
+---
+--- Can also be used as a |method|: >
+---   mylist->filter(expr2)
+---
+--- @param expr1 any
+--- @param expr2 any
+--- @return any
+function vim.fn.filter(expr1, expr2) end
+
+--- Find directory {name} in {path}.  Supports both downwards and
+--- upwards recursive directory searches.  See |file-searching|
+--- for the syntax of {path}.
+---
+--- Returns the path of the first found match.  When the found
+--- directory is below the current directory a relative path is
+--- returned.  Otherwise a full path is returned.
+--- If {path} is omitted or empty then 'path' is used.
+---
+--- If the optional {count} is given, find {count}'s occurrence of
+--- {name} in {path} instead of the first one.
+--- When {count} is negative return all the matches in a |List|.
+---
+--- Returns an empty string if the directory is not found.
+---
+--- This is quite similar to the ex-command `:find`.
+---
+--- Can also be used as a |method|: >
+---   GetName()->finddir()
+---
+--- @param name string
+--- @param path? string
+--- @param count? any
+--- @return any
+function vim.fn.finddir(name, path, count) end
+
+--- Just like |finddir()|, but find a file instead of a directory.
+--- Uses 'suffixesadd'.
+--- Example: >
+---   :echo findfile("tags.vim", ".;")
+--- <Searches from the directory of the current file upwards until
+--- it finds the file "tags.vim".
+---
+--- Can also be used as a |method|: >
+---   GetName()->findfile()
+---
+--- @param name string
+--- @param path? string
+--- @param count? any
+--- @return any
+function vim.fn.findfile(name, path, count) end
+
+--- Flatten {list} up to {maxdepth} levels.  Without {maxdepth}
+--- the result is a |List| without nesting, as if {maxdepth} is
+--- a very large number.
+--- The {list} is changed in place, use |flattennew()| if you do
+--- not want that.
+---             *E900*
+--- {maxdepth} means how deep in nested lists changes are made.
+--- {list} is not modified when {maxdepth} is 0.
+--- {maxdepth} must be positive number.
+---
+--- If there is an error the number zero is returned.
+---
+--- Example: >
+---   :echo flatten([1, [2, [3, 4]], 5])
+--- <  [1, 2, 3, 4, 5] >
+---   :echo flatten([1, [2, [3, 4]], 5], 1)
+--- <  [1, 2, [3, 4], 5]
+---
+--- Can also be used as a |method|: >
+---   mylist->flatten()
+--- <
+--- @param list any
+--- @param maxdepth? any
+--- @return any[]|0
+function vim.fn.flatten(list, maxdepth) end
+
+--- Like |flatten()| but first make a copy of {list}.
+---
+---
+--- @param list any
+--- @param maxdepth? any
+--- @return any[]|0
+function vim.fn.flattennew(list, maxdepth) end
+
+--- Convert {expr} to a Number by omitting the part after the
+--- decimal point.
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0 if {expr} is not a |Float| or a |Number|.
+--- When the value of {expr} is out of range for a |Number| the
+--- result is truncated to 0x7fffffff or -0x7fffffff (or when
+--- 64-bit Number support is enabled, 0x7fffffffffffffff or
+--- -0x7fffffffffffffff).  NaN results in -0x80000000 (or when
+--- 64-bit Number support is enabled, -0x8000000000000000).
+--- Examples: >
+---   echo float2nr(3.95)
+--- <  3  >
+---   echo float2nr(-23.45)
+--- <  -23  >
+---   echo float2nr(1.0e100)
+--- <  2147483647  (or 9223372036854775807) >
+---   echo float2nr(-1.0e150)
+--- <  -2147483647 (or -9223372036854775807) >
+---   echo float2nr(1.0e-100)
+--- <  0
+---
+--- Can also be used as a |method|: >
+---   Compute()->float2nr()
+---
+--- @param expr any
+--- @return any
+function vim.fn.float2nr(expr) end
+
+--- Return the largest integral value less than or equal to
+--- {expr} as a |Float| (round down).
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   echo floor(1.856)
+--- <  1.0  >
+---   echo floor(-5.456)
+--- <  -6.0  >
+---   echo floor(4.0)
+--- <  4.0
+---
+--- Can also be used as a |method|: >
+---   Compute()->floor()
+---
+--- @param expr any
+--- @return any
+function vim.fn.floor(expr) end
+
+--- Return the remainder of {expr1} / {expr2}, even if the
+--- division is not representable.  Returns {expr1} - i * {expr2}
+--- for some integer i such that if {expr2} is non-zero, the
+--- result has the same sign as {expr1} and magnitude less than
+--- the magnitude of {expr2}.  If {expr2} is zero, the value
+--- returned is zero.  The value returned is a |Float|.
+--- {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr1} or {expr2} is not a |Float| or a
+--- |Number|.
+--- Examples: >
+---   :echo fmod(12.33, 1.22)
+--- <  0.13 >
+---   :echo fmod(-12.33, 1.22)
+--- <  -0.13
+---
+--- Can also be used as a |method|: >
+---   Compute()->fmod(1.22)
+---
+--- @param expr1 any
+--- @param expr2 any
+--- @return any
+function vim.fn.fmod(expr1, expr2) end
+
+--- Escape {string} for use as file name command argument.  All
+--- characters that have a special meaning, such as '%' and '|'
+--- are escaped with a backslash.
+--- For most systems the characters escaped are
+--- " \t\n*?[{`$\\%#'\"|!<".  For systems where a backslash
+--- appears in a filename, it depends on the value of 'isfname'.
+--- A leading '+' and '>' is also escaped (special after |:edit|
+--- and |:write|).  And a "-" by itself (special after |:cd|).
+--- Returns an empty string on error.
+--- Example: >
+---   :let fname = '+some str%nge|name'
+---   :exe "edit " .. fnameescape(fname)
+--- <results in executing: >
+---   edit \+some\ str\%nge\|name
+--- <
+--- Can also be used as a |method|: >
+---   GetName()->fnameescape()
+---
+--- @param string string
+--- @return string
+function vim.fn.fnameescape(string) end
+
+--- Modify file name {fname} according to {mods}.  {mods} is a
+--- string of characters like it is used for file names on the
+--- command line.  See |filename-modifiers|.
+--- Example: >
+---   :echo fnamemodify("main.c", ":p:h")
+--- <results in: >
+---   /home/user/vim/vim/src
+--- <If {mods} is empty or an unsupported modifier is used then
+--- {fname} is returned.
+--- When {fname} is empty then with {mods} ":h" returns ".", so
+--- that `:cd` can be used with it.  This is different from
+--- expand('%:h') without a buffer name, which returns an empty
+--- string.
+--- Note: Environment variables don't work in {fname}, use
+--- |expand()| first then.
+---
+--- Can also be used as a |method|: >
+---   GetName()->fnamemodify(':p:h')
+---
+--- @param fname integer
+--- @param mods string
+--- @return string
+function vim.fn.fnamemodify(fname, mods) end
+
+--- The result is a Number.  If the line {lnum} is in a closed
+--- fold, the result is the number of the first line in that fold.
+--- If the line {lnum} is not in a closed fold, -1 is returned.
+--- {lnum} is used like with |getline()|.  Thus "." is the current
+--- line, "'m" mark m, etc.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->foldclosed()
+---
+--- @param lnum integer
+--- @return integer
+function vim.fn.foldclosed(lnum) end
+
+--- The result is a Number.  If the line {lnum} is in a closed
+--- fold, the result is the number of the last line in that fold.
+--- If the line {lnum} is not in a closed fold, -1 is returned.
+--- {lnum} is used like with |getline()|.  Thus "." is the current
+--- line, "'m" mark m, etc.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->foldclosedend()
+---
+--- @param lnum integer
+--- @return integer
+function vim.fn.foldclosedend(lnum) end
+
+--- The result is a Number, which is the foldlevel of line {lnum}
+--- in the current buffer.  For nested folds the deepest level is
+--- returned.  If there is no fold at line {lnum}, zero is
+--- returned.  It doesn't matter if the folds are open or closed.
+--- When used while updating folds (from 'foldexpr') -1 is
+--- returned for lines where folds are still to be updated and the
+--- foldlevel is unknown.  As a special case the level of the
+--- previous line is usually available.
+--- {lnum} is used like with |getline()|.  Thus "." is the current
+--- line, "'m" mark m, etc.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->foldlevel()
+--- <
+---           *foldtext()*
+--- @param lnum integer
+--- @return integer
+function vim.fn.foldlevel(lnum) end
+
+--- the default function used for the 'foldtext' option and should
+--- only be called from evaluating 'foldtext'.  It uses the
+--- |v:foldstart|, |v:foldend| and |v:folddashes| variables.
+--- The returned string looks like this: >
+---   +-- 45 lines: abcdef
+--- <The number of leading dashes depends on the foldlevel.  The
+--- "45" is the number of lines in the fold.  "abcdef" is the text
+--- in the first non-blank line of the fold.  Leading white space,
+--- "//" or "/*" and the text from the 'foldmarker' and
+--- 'commentstring' options is removed.
+--- When used to draw the actual foldtext, the rest of the line
+--- will be filled with the fold char from the 'fillchars'
+--- setting.
+--- Returns an empty string when there is no fold.
+---
+--- @return string
+function vim.fn.foldtext() end
+
+--- Returns the text that is displayed for the closed fold at line
+--- {lnum}.  Evaluates 'foldtext' in the appropriate context.
+--- When there is no closed fold at {lnum} an empty string is
+--- returned.
+--- {lnum} is used like with |getline()|.  Thus "." is the current
+--- line, "'m" mark m, etc.
+--- Useful when exporting folded text, e.g., to HTML.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->foldtextresult()
+--- <
+--- @param lnum integer
+--- @return string
+function vim.fn.foldtextresult(lnum) end
+
+--- Get the full command name from a short abbreviated command
+--- name; see |20.2| for details on command abbreviations.
+---
+--- The string argument {name} may start with a `:` and can
+--- include a [range], these are skipped and not returned.
+--- Returns an empty string if a command doesn't exist or if it's
+--- ambiguous (for user-defined commands).
+---
+--- For example `fullcommand('s')`, `fullcommand('sub')`,
+--- `fullcommand(':%substitute')` all return "substitute".
+---
+--- Can also be used as a |method|: >
+---   GetName()->fullcommand()
+--- <
+---         *funcref()*
+--- @param name string
+--- @return string
+function vim.fn.fullcommand(name) end
+
+--- Just like |function()|, but the returned Funcref will lookup
+--- the function by reference, not by name.  This matters when the
+--- function {name} is redefined later.
+---
+--- Unlike |function()|, {name} must be an existing user function.
+--- It only works for an autoloaded function if it has already
+--- been loaded (to avoid mistakenly loading the autoload script
+--- when only intending to use the function name, use |function()|
+--- instead). {name} cannot be a builtin function.
+--- Returns 0 on error.
+---
+--- Can also be used as a |method|: >
+---   GetFuncname()->funcref([arg])
+--- <
+---     *function()* *partial* *E700* *E923*
+--- @param name string
+--- @param arglist? any
+--- @param dict? any
+--- @return any
+function vim.fn.funcref(name, arglist, dict) end
+
+--- Return a |Funcref| variable that refers to function {name}.
+--- {name} can be the name of a user defined function or an
+--- internal function.
+---
+--- {name} can also be a Funcref or a partial. When it is a
+--- partial the dict stored in it will be used and the {dict}
+--- argument is not allowed. E.g.: >
+---   let FuncWithArg = function(dict.Func, [arg])
+---   let Broken = function(dict.Func, [arg], dict)
+--- <
+--- When using the Funcref the function will be found by {name},
+--- also when it was redefined later. Use |funcref()| to keep the
+--- same function.
+---
+--- When {arglist} or {dict} is present this creates a partial.
+--- That means the argument list and/or the dictionary is stored in
+--- the Funcref and will be used when the Funcref is called.
+---
+--- The arguments are passed to the function in front of other
+--- arguments, but after any argument from |method|.  Example: >
+---   func Callback(arg1, arg2, name)
+---   "...
+---   let Partial = function('Callback', ['one', 'two'])
+---   "...
+---   call Partial('name')
+--- <Invokes the function as with: >
+---   call Callback('one', 'two', 'name')
+---
+--- <With a |method|: >
+---   func Callback(one, two, three)
+---   "...
+---   let Partial = function('Callback', ['two'])
+---   "...
+---   eval 'one'->Partial('three')
+--- <Invokes the function as with: >
+---   call Callback('one', 'two', 'three')
+---
+--- <The function() call can be nested to add more arguments to the
+--- Funcref.  The extra arguments are appended to the list of
+--- arguments.  Example: >
+---   func Callback(arg1, arg2, name)
+---   "...
+---   let Func = function('Callback', ['one'])
+---   let Func2 = function(Func, ['two'])
+---   "...
+---   call Func2('name')
+--- <Invokes the function as with: >
+---   call Callback('one', 'two', 'name')
+---
+--- <The Dictionary is only useful when calling a "dict" function.
+--- In that case the {dict} is passed in as "self". Example: >
+---   function Callback() dict
+---      echo "called for " .. self.name
+---   endfunction
+---   "...
+---   let context = {"name": "example"}
+---   let Func = function('Callback', context)
+---   "...
+---   call Func()  " will echo: called for example
+--- <The use of function() is not needed when there are no extra
+--- arguments, these two are equivalent, if Callback() is defined
+--- as context.Callback(): >
+---   let Func = function('Callback', context)
+---   let Func = context.Callback
+---
+--- <The argument list and the Dictionary can be combined: >
+---   function Callback(arg1, count) dict
+---   "...
+---   let context = {"name": "example"}
+---   let Func = function('Callback', ['one'], context)
+---   "...
+---   call Func(500)
+--- <Invokes the function as with: >
+---   call context.Callback('one', 500)
+--- <
+--- Returns 0 on error.
+---
+--- Can also be used as a |method|: >
+---   GetFuncname()->function([arg])
+---
+--- @param name string
+--- @param arglist? any
+--- @param dict? any
+--- @return any
+vim.fn['function'] = function(name, arglist, dict) end
+
+--- Cleanup unused |Lists| and |Dictionaries| that have circular
+--- references.
+---
+--- There is hardly ever a need to invoke this function, as it is
+--- automatically done when Vim runs out of memory or is waiting
+--- for the user to press a key after 'updatetime'.  Items without
+--- circular references are always freed when they become unused.
+--- This is useful if you have deleted a very big |List| and/or
+--- |Dictionary| with circular references in a script that runs
+--- for a long time.
+---
+--- When the optional {atexit} argument is one, garbage
+--- collection will also be done when exiting Vim, if it wasn't
+--- done before.  This is useful when checking for memory leaks.
+---
+--- The garbage collection is not done immediately but only when
+--- it's safe to perform.  This is when waiting for the user to
+--- type a character.
+---
+--- @param atexit? any
+--- @return any
+function vim.fn.garbagecollect(atexit) end
+
+--- Get item {what} from Funcref {func}.  Possible values for
+--- {what} are:
+---   "name"  The function name
+---   "func"  The function
+---   "dict"  The dictionary
+---   "args"  The list with arguments
+--- Returns zero on error.
+---
+---           *getbufinfo()*
+--- @param func any
+--- @param what any
+--- @return any
+function vim.fn.get(func, what) end
+
+--- Get information about buffers as a List of Dictionaries.
+---
+--- Without an argument information about all the buffers is
+--- returned.
+---
+--- When the argument is a |Dictionary| only the buffers matching
+--- the specified criteria are returned.  The following keys can
+--- be specified in {dict}:
+---   buflisted  include only listed buffers.
+---   bufloaded  include only loaded buffers.
+---   bufmodified  include only modified buffers.
+---
+--- Otherwise, {buf} specifies a particular buffer to return
+--- information for.  For the use of {buf}, see |bufname()|
+--- above.  If the buffer is found the returned List has one item.
+--- Otherwise the result is an empty list.
+---
+--- Each returned List item is a dictionary with the following
+--- entries:
+---   bufnr    Buffer number.
+---   changed    TRUE if the buffer is modified.
+---   changedtick  Number of changes made to the buffer.
+---   hidden    TRUE if the buffer is hidden.
+---   lastused  Timestamp in seconds, like
+---       |localtime()|, when the buffer was
+---       last used.
+---   listed    TRUE if the buffer is listed.
+---   lnum    Line number used for the buffer when
+---       opened in the current window.
+---       Only valid if the buffer has been
+---       displayed in the window in the past.
+---       If you want the line number of the
+---       last known cursor position in a given
+---       window, use |line()|: >
+---         :echo line('.', {winid})
+--- <
+---   linecount  Number of lines in the buffer (only
+---       valid when loaded)
+---   loaded    TRUE if the buffer is loaded.
+---   name    Full path to the file in the buffer.
+---   signs    List of signs placed in the buffer.
+---       Each list item is a dictionary with
+---       the following fields:
+---           id    sign identifier
+---           lnum  line number
+---           name  sign name
+---   variables  A reference to the dictionary with
+---       buffer-local variables.
+---   windows    List of |window-ID|s that display this
+---       buffer
+---
+--- Examples: >
+---   for buf in getbufinfo()
+---       echo buf.name
+---   endfor
+---   for buf in getbufinfo({'buflisted':1})
+---       if buf.changed
+---     ....
+---       endif
+---   endfor
+--- <
+--- To get buffer-local options use: >
+---   getbufvar({bufnr}, '&option_name')
+--- <
+--- Can also be used as a |method|: >
+---   GetBufnr()->getbufinfo()
+--- <
+---
+---           *getbufline()*
+--- @param dict? any
+--- @return any
+function vim.fn.getbufinfo(dict) end
+
+--- Return a |List| with the lines starting from {lnum} to {end}
+--- (inclusive) in the buffer {buf}.  If {end} is omitted, a
+--- |List| with only the line {lnum} is returned.  See
+--- `getbufoneline()` for only getting the line.
+---
+--- For the use of {buf}, see |bufname()| above.
+---
+--- For {lnum} and {end} "$" can be used for the last line of the
+--- buffer.  Otherwise a number must be used.
+---
+--- When {lnum} is smaller than 1 or bigger than the number of
+--- lines in the buffer, an empty |List| is returned.
+---
+--- When {end} is greater than the number of lines in the buffer,
+--- it is treated as {end} is set to the number of lines in the
+--- buffer.  When {end} is before {lnum} an empty |List| is
+--- returned.
+---
+--- This function works only for loaded buffers.  For unloaded and
+--- non-existing buffers, an empty |List| is returned.
+---
+--- Example: >
+---   :let lines = getbufline(bufnr("myfile"), 1, "$")
+---
+--- <Can also be used as a |method|: >
+---   GetBufnr()->getbufline(lnum)
+--- <
+---           *getbufoneline()*
+--- @param buf any
+--- @param lnum integer
+--- @param end_? any
+--- @return any
+function vim.fn.getbufline(buf, lnum, end_) end
+
+--- Just like `getbufline()` but only get one line and return it
+--- as a string.
+---
+--- @param buf any
+--- @param lnum integer
+--- @return any
+function vim.fn.getbufoneline(buf, lnum) end
+
+--- The result is the value of option or local buffer variable
+--- {varname} in buffer {buf}.  Note that the name without "b:"
+--- must be used.
+--- The {varname} argument is a string.
+--- When {varname} is empty returns a |Dictionary| with all the
+--- buffer-local variables.
+--- When {varname} is equal to "&" returns a |Dictionary| with all
+--- the buffer-local options.
+--- Otherwise, when {varname} starts with "&" returns the value of
+--- a buffer-local option.
+--- This also works for a global or buffer-local option, but it
+--- doesn't work for a global variable, window-local variable or
+--- window-local option.
+--- For the use of {buf}, see |bufname()| above.
+--- When the buffer or variable doesn't exist {def} or an empty
+--- string is returned, there is no error message.
+--- Examples: >
+---   :let bufmodified = getbufvar(1, "&mod")
+---   :echo "todo myvar = " .. getbufvar("todo", "myvar")
+---
+--- <Can also be used as a |method|: >
+---   GetBufnr()->getbufvar(varname)
+--- <
+--- @param buf any
+--- @param varname string
+--- @param def? any
+--- @return any
+function vim.fn.getbufvar(buf, varname, def) end
+
+--- Returns a |List| of cell widths of character ranges overridden
+--- by |setcellwidths()|.  The format is equal to the argument of
+--- |setcellwidths()|.  If no character ranges have their cell
+--- widths overridden, an empty List is returned.
+---
+---
+--- @return any
+function vim.fn.getcellwidths() end
+
+--- Returns the |changelist| for the buffer {buf}. For the use
+--- of {buf}, see |bufname()| above. If buffer {buf} doesn't
+--- exist, an empty list is returned.
+---
+--- The returned list contains two entries: a list with the change
+--- locations and the current position in the list.  Each
+--- entry in the change list is a dictionary with the following
+--- entries:
+---   col    column number
+---   coladd    column offset for 'virtualedit'
+---   lnum    line number
+--- If buffer {buf} is the current buffer, then the current
+--- position refers to the position in the list. For other
+--- buffers, it is set to the length of the list.
+---
+--- Can also be used as a |method|: >
+---   GetBufnr()->getchangelist()
+---
+--- @param buf? any
+--- @return any
+function vim.fn.getchangelist(buf) end
+
+--- Get a single character from the user or input stream.
+--- If [expr] is omitted, wait until a character is available.
+--- If [expr] is 0, only get a character when one is available.
+---   Return zero otherwise.
+--- If [expr] is 1, only check if a character is available, it is
+---   not consumed.  Return zero if no character available.
+--- If you prefer always getting a string use |getcharstr()|.
+---
+--- Without [expr] and when [expr] is 0 a whole character or
+--- special key is returned.  If it is a single character, the
+--- result is a Number.  Use |nr2char()| to convert it to a String.
+--- Otherwise a String is returned with the encoded character.
+--- For a special key it's a String with a sequence of bytes
+--- starting with 0x80 (decimal: 128).  This is the same value as
+--- the String "\<Key>", e.g., "\<Left>".  The returned value is
+--- also a String when a modifier (shift, control, alt) was used
+--- that is not included in the character.
+---
+--- When [expr] is 0 and Esc is typed, there will be a short delay
+--- while Vim waits to see if this is the start of an escape
+--- sequence.
+---
+--- When [expr] is 1 only the first byte is returned.  For a
+--- one-byte character it is the character itself as a number.
+--- Use nr2char() to convert it to a String.
+---
+--- Use getcharmod() to obtain any additional modifiers.
+---
+--- When the user clicks a mouse button, the mouse event will be
+--- returned.  The position can then be found in |v:mouse_col|,
+--- |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|.
+--- |getmousepos()| can also be used.  Mouse move events will be
+--- ignored.
+--- This example positions the mouse as it would normally happen: >
+---   let c = getchar()
+---   if c == "\<LeftMouse>" && v:mouse_win > 0
+---     exe v:mouse_win .. "wincmd w"
+---     exe v:mouse_lnum
+---     exe "normal " .. v:mouse_col .. "|"
+---   endif
+--- <
+--- There is no prompt, you will somehow have to make clear to the
+--- user that a character has to be typed.  The screen is not
+--- redrawn, e.g. when resizing the window.
+---
+--- There is no mapping for the character.
+--- Key codes are replaced, thus when the user presses the <Del>
+--- key you get the code for the <Del> key, not the raw character
+--- sequence.  Examples: >
+---   getchar() == "\<Del>"
+---   getchar() == "\<S-Left>"
+--- <This example redefines "f" to ignore case: >
+---   :nmap f :call FindChar()<CR>
+---   :function FindChar()
+---   :  let c = nr2char(getchar())
+---   :  while col('.') < col('$') - 1
+---   :    normal l
+---   :    if getline('.')[col('.') - 1] ==? c
+---   :      break
+---   :    endif
+---   :  endwhile
+---   :endfunction
+--- <
+--- @return integer
+function vim.fn.getchar() end
+
+--- The result is a Number which is the state of the modifiers for
+--- the last obtained character with getchar() or in another way.
+--- These values are added together:
+---   2  shift
+---   4  control
+---   8  alt (meta)
+---   16  meta (when it's different from ALT)
+---   32  mouse double click
+---   64  mouse triple click
+---   96  mouse quadruple click (== 32 + 64)
+---   128  command (Macintosh only)
+--- Only the modifiers that have not been included in the
+--- character itself are obtained.  Thus Shift-a results in "A"
+--- without a modifier.  Returns 0 if no modifiers are used.
+---
+---           *getcharpos()*
+--- @return integer
+function vim.fn.getcharmod() end
+
+--- Get the position for String {expr}. Same as |getpos()| but the
+--- column number in the returned List is a character index
+--- instead of a byte index.
+--- If |getpos()| returns a very large column number, equal to
+--- |v:maxcol|, then getcharpos() will return the character index
+--- of the last character.
+---
+--- Example:
+--- With the cursor on '세' in line 5 with text "여보세요": >
+---   getcharpos('.')    returns [0, 5, 3, 0]
+---   getpos('.')    returns [0, 5, 7, 0]
+--- <
+--- Can also be used as a |method|: >
+---   GetMark()->getcharpos()
+---
+--- @param expr any
+--- @return any
+function vim.fn.getcharpos(expr) end
+
+--- Return the current character search information as a {dict}
+--- with the following entries:
+---
+---     char  character previously used for a character
+---     search (|t|, |f|, |T|, or |F|); empty string
+---     if no character search has been performed
+---     forward  direction of character search; 1 for forward,
+---     0 for backward
+---     until  type of character search; 1 for a |t| or |T|
+---     character search, 0 for an |f| or |F|
+---     character search
+---
+--- This can be useful to always have |;| and |,| search
+--- forward/backward regardless of the direction of the previous
+--- character search: >
+---   :nnoremap <expr> ; getcharsearch().forward ? ';' : ','
+---   :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
+--- <Also see |setcharsearch()|.
+---
+---
+--- @return any
+function vim.fn.getcharsearch() end
+
+--- Get a single character from the user or input stream as a
+--- string.
+--- If [expr] is omitted, wait until a character is available.
+--- If [expr] is 0 or false, only get a character when one is
+---   available.  Return an empty string otherwise.
+--- If [expr] is 1 or true, only check if a character is
+---   available, it is not consumed.  Return an empty string
+---   if no character is available.
+--- Otherwise this works like |getchar()|, except that a number
+--- result is converted to a string.
+---
+--- @return string
+function vim.fn.getcharstr() end
+
+--- Return the type of the current command-line completion.
+--- Only works when the command line is being edited, thus
+--- requires use of |c_CTRL-\_e| or |c_CTRL-R_=|.
+--- See |:command-completion| for the return string.
+--- Also see |getcmdtype()|, |setcmdpos()|, |getcmdline()| and
+--- |setcmdline()|.
+--- Returns an empty string when completion is not defined.
+---
+--- @return string
+function vim.fn.getcmdcompltype() end
+
+--- Return the current command-line.  Only works when the command
+--- line is being edited, thus requires use of |c_CTRL-\_e| or
+--- |c_CTRL-R_=|.
+--- Example: >
+---   :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
+--- <Also see |getcmdtype()|, |getcmdpos()|, |setcmdpos()| and
+--- |setcmdline()|.
+--- Returns an empty string when entering a password or using
+--- |inputsecret()|.
+---
+--- @return string
+function vim.fn.getcmdline() end
+
+--- Return the position of the cursor in the command line as a
+--- byte count.  The first column is 1.
+--- Only works when editing the command line, thus requires use of
+--- |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
+--- Returns 0 otherwise.
+--- Also see |getcmdtype()|, |setcmdpos()|, |getcmdline()| and
+--- |setcmdline()|.
+---
+--- @return any
+function vim.fn.getcmdpos() end
+
+--- Return the screen position of the cursor in the command line
+--- as a byte count.  The first column is 1.
+--- Instead of |getcmdpos()|, it adds the prompt position.
+--- Only works when editing the command line, thus requires use of
+--- |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
+--- Returns 0 otherwise.
+--- Also see |getcmdpos()|, |setcmdpos()|, |getcmdline()| and
+--- |setcmdline()|.
+---
+--- @return any
+function vim.fn.getcmdscreenpos() end
+
+--- Return the current command-line type. Possible return values
+--- are:
+---     :  normal Ex command
+---     >  debug mode command |debug-mode|
+---     /  forward search command
+---     ?  backward search command
+---     \@  |input()| command
+---     `-`  |:insert| or |:append| command
+---     =  |i_CTRL-R_=|
+--- Only works when editing the command line, thus requires use of
+--- |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
+--- Returns an empty string otherwise.
+--- Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
+---
+--- @return ':'|'>'|'/'|'?'|'@'|'-'|'='
+function vim.fn.getcmdtype() end
+
+--- Return the current |command-line-window| type. Possible return
+--- values are the same as |getcmdtype()|. Returns an empty string
+--- when not in the command-line window.
+---
+--- @return ':'|'>'|'/'|'?'|'@'|'-'|'='
+function vim.fn.getcmdwintype() end
+
+--- Return a list of command-line completion matches. The String
+--- {type} argument specifies what for.  The following completion
+--- types are supported:
+---
+--- arglist    file names in argument list
+--- augroup    autocmd groups
+--- buffer    buffer names
+--- breakpoint  |:breakadd| and |:breakdel| suboptions
+--- cmdline    |cmdline-completion| result
+--- color    color schemes
+--- command    Ex command
+--- compiler  compilers
+--- diff_buffer     |:diffget| and |:diffput| completion
+--- dir    directory names
+--- environment  environment variable names
+--- event    autocommand events
+--- expression  Vim expression
+--- file    file and directory names
+--- file_in_path  file and directory names in |'path'|
+--- filetype  filetype names |'filetype'|
+--- function  function name
+--- help    help subjects
+--- highlight  highlight groups
+--- history    |:history| suboptions
+--- locale    locale names (as output of locale -a)
+--- mapclear  buffer argument
+--- mapping    mapping name
+--- menu    menus
+--- messages  |:messages| suboptions
+--- option    options
+--- packadd    optional package |pack-add| names
+--- runtime    |:runtime| completion
+--- scriptnames  sourced script names |:scriptnames|
+--- shellcmd  Shell command
+--- sign    |:sign| suboptions
+--- syntax    syntax file names |'syntax'|
+--- syntime    |:syntime| suboptions
+--- tag    tags
+--- tag_listfiles  tags, file names
+--- user    user names
+--- var    user variables
+---
+--- If {pat} is an empty string, then all the matches are
+--- returned.  Otherwise only items matching {pat} are returned.
+--- See |wildcards| for the use of special characters in {pat}.
+---
+--- If the optional {filtered} flag is set to 1, then 'wildignore'
+--- is applied to filter the results.  Otherwise all the matches
+--- are returned. The 'wildignorecase' option always applies.
+---
+--- If the 'wildoptions' option contains "fuzzy", then fuzzy
+--- matching is used to get the completion matches. Otherwise
+--- regular expression matching is used.  Thus this function
+--- follows the user preference, what happens on the command line.
+--- If you do not want this you can make 'wildoptions' empty
+--- before calling getcompletion() and restore it afterwards.
+---
+--- If {type} is "cmdline", then the |cmdline-completion| result is
+--- returned.  For example, to complete the possible values after
+--- a ":call" command: >
+---   echo getcompletion('call ', 'cmdline')
+--- <
+--- If there are no matches, an empty list is returned.  An
+--- invalid value for {type} produces an error.
+---
+--- Can also be used as a |method|: >
+---   GetPattern()->getcompletion('color')
+--- <
+---           *getcurpos()*
+--- @param pat any
+--- @param type any
+--- @param filtered? any
+--- @return string[]
+function vim.fn.getcompletion(pat, type, filtered) end
+
+--- Get the position of the cursor.  This is like getpos('.'), but
+--- includes an extra "curswant" item in the list:
+---     [0, lnum, col, off, curswant] ~
+--- The "curswant" number is the preferred column when moving the
+--- cursor vertically.  After |$| command it will be a very large
+--- number equal to |v:maxcol|.  Also see |getcursorcharpos()| and
+--- |getpos()|.
+--- The first "bufnum" item is always zero. The byte position of
+--- the cursor is returned in "col". To get the character
+--- position, use |getcursorcharpos()|.
+---
+--- The optional {winid} argument can specify the window.  It can
+--- be the window number or the |window-ID|.  The last known
+--- cursor position is returned, this may be invalid for the
+--- current value of the buffer if it is not the current window.
+--- If {winid} is invalid a list with zeroes is returned.
+---
+--- This can be used to save and restore the cursor position: >
+---   let save_cursor = getcurpos()
+---   MoveTheCursorAround
+---   call setpos('.', save_cursor)
+--- <Note that this only works within the window.  See
+--- |winrestview()| for restoring more state.
+---
+--- Can also be used as a |method|: >
+---   GetWinid()->getcurpos()
+--- <
+---           *getcursorcharpos()*
+--- @param winid? integer
+--- @return any
+function vim.fn.getcurpos(winid) end
+
+--- Same as |getcurpos()| but the column number in the returned
+--- List is a character index instead of a byte index.
+---
+--- Example:
+--- With the cursor on '보' in line 3 with text "여보세요": >
+---   getcursorcharpos()  returns [0, 3, 2, 0, 3]
+---   getcurpos()    returns [0, 3, 4, 0, 3]
+--- <
+--- Can also be used as a |method|: >
+---   GetWinid()->getcursorcharpos()
+---
+--- @param winid? integer
+--- @return any
+function vim.fn.getcursorcharpos(winid) end
+
+--- With no arguments, returns the name of the effective
+--- |current-directory|. With {winnr} or {tabnr} the working
+--- directory of that scope is returned, and 'autochdir' is
+--- ignored.
+--- Tabs and windows are identified by their respective numbers,
+--- 0 means current tab or window. Missing tab number implies 0.
+--- Thus the following are equivalent: >
+---   getcwd(0)
+---   getcwd(0, 0)
+--- <If {winnr} is -1 it is ignored, only the tab is resolved.
+--- {winnr} can be the window number or the |window-ID|.
+--- If both {winnr} and {tabnr} are -1 the global working
+--- directory is returned.
+--- Throw error if the arguments are invalid. |E5000| |E5001| |E5002|
+---
+--- Can also be used as a |method|: >
+---   GetWinnr()->getcwd()
+---
+--- @param winnr? integer
+--- @param tabnr? integer
+--- @return string
+function vim.fn.getcwd(winnr, tabnr) end
+
+--- Return the value of environment variable {name}.  The {name}
+--- argument is a string, without a leading '$'.  Example: >
+---   myHome = getenv('HOME')
+---
+--- <When the variable does not exist |v:null| is returned.  That
+--- is different from a variable set to an empty string.
+--- See also |expr-env|.
+---
+--- Can also be used as a |method|: >
+---   GetVarname()->getenv()
+---
+--- @param name string
+--- @return string
+function vim.fn.getenv(name) end
+
+--- Without an argument returns the name of the normal font being
+--- used.  Like what is used for the Normal highlight group
+--- |hl-Normal|.
+--- With an argument a check is done whether String {name} is a
+--- valid font name.  If not then an empty string is returned.
+--- Otherwise the actual font name is returned, or {name} if the
+--- GUI does not support obtaining the real name.
+--- Only works when the GUI is running, thus not in your vimrc or
+--- gvimrc file.  Use the |GUIEnter| autocommand to use this
+--- function just after the GUI has started.
+---
+--- @param name? string
+--- @return string
+function vim.fn.getfontname(name) end
+
+--- The result is a String, which is the read, write, and execute
+--- permissions of the given file {fname}.
+--- If {fname} does not exist or its directory cannot be read, an
+--- empty string is returned.
+--- The result is of the form "rwxrwxrwx", where each group of
+--- "rwx" flags represent, in turn, the permissions of the owner
+--- of the file, the group the file belongs to, and other users.
+--- If a user does not have a given permission the flag for this
+--- is replaced with the string "-".  Examples: >
+---   :echo getfperm("/etc/passwd")
+---   :echo getfperm(expand("~/.config/nvim/init.vim"))
+--- <This will hopefully (from a security point of view) display
+--- the string "rw-r--r--" or even "rw-------".
+---
+--- Can also be used as a |method|: >
+---   GetFilename()->getfperm()
+--- <
+--- For setting permissions use |setfperm()|.
+---
+--- @param fname integer
+--- @return string
+function vim.fn.getfperm(fname) end
+
+--- The result is a Number, which is the size in bytes of the
+--- given file {fname}.
+--- If {fname} is a directory, 0 is returned.
+--- If the file {fname} can't be found, -1 is returned.
+--- If the size of {fname} is too big to fit in a Number then -2
+--- is returned.
+---
+--- Can also be used as a |method|: >
+---   GetFilename()->getfsize()
+---
+--- @param fname integer
+--- @return integer
+function vim.fn.getfsize(fname) end
+
+--- The result is a Number, which is the last modification time of
+--- the given file {fname}.  The value is measured as seconds
+--- since 1st Jan 1970, and may be passed to strftime().  See also
+--- |localtime()| and |strftime()|.
+--- If the file {fname} can't be found -1 is returned.
+---
+--- Can also be used as a |method|: >
+---   GetFilename()->getftime()
+---
+--- @param fname integer
+--- @return integer
+function vim.fn.getftime(fname) end
+
+--- The result is a String, which is a description of the kind of
+--- file of the given file {fname}.
+--- If {fname} does not exist an empty string is returned.
+--- Here is a table over different kinds of files and their
+--- results:
+---   Normal file    "file"
+---   Directory    "dir"
+---   Symbolic link    "link"
+---   Block device    "bdev"
+---   Character device  "cdev"
+---   Socket      "socket"
+---   FIFO      "fifo"
+---   All other    "other"
+--- Example: >
+---   getftype("/home")
+--- <Note that a type such as "link" will only be returned on
+--- systems that support it.  On some systems only "dir" and
+--- "file" are returned.
+---
+--- Can also be used as a |method|: >
+---   GetFilename()->getftype()
+---
+--- @param fname integer
+--- @return 'file'|'dir'|'link'|'bdev'|'cdev'|'socket'|'fifo'|'other'
+function vim.fn.getftype(fname) end
+
+--- Returns the |jumplist| for the specified window.
+---
+--- Without arguments use the current window.
+--- With {winnr} only use this window in the current tab page.
+--- {winnr} can also be a |window-ID|.
+--- With {winnr} and {tabnr} use the window in the specified tab
+--- page.  If {winnr} or {tabnr} is invalid, an empty list is
+--- returned.
+---
+--- The returned list contains two entries: a list with the jump
+--- locations and the last used jump position number in the list.
+--- Each entry in the jump location list is a dictionary with
+--- the following entries:
+---   bufnr    buffer number
+---   col    column number
+---   coladd    column offset for 'virtualedit'
+---   filename  filename if available
+---   lnum    line number
+---
+--- Can also be used as a |method|: >
+---   GetWinnr()->getjumplist()
+---
+--- <          *getline()*
+--- @param winnr? integer
+--- @param tabnr? integer
+--- @return any
+function vim.fn.getjumplist(winnr, tabnr) end
+
+--- Without {end} the result is a String, which is line {lnum}
+--- from the current buffer.  Example: >
+---   getline(1)
+--- <When {lnum} is a String that doesn't start with a
+--- digit, |line()| is called to translate the String into a Number.
+--- To get the line under the cursor: >
+---   getline(".")
+--- <When {lnum} is a number smaller than 1 or bigger than the
+--- number of lines in the buffer, an empty string is returned.
+---
+--- When {end} is given the result is a |List| where each item is
+--- a line from the current buffer in the range {lnum} to {end},
+--- including line {end}.
+--- {end} is used in the same way as {lnum}.
+--- Non-existing lines are silently omitted.
+--- When {end} is before {lnum} an empty |List| is returned.
+--- Example: >
+---   :let start = line('.')
+---   :let end = search("^$") - 1
+---   :let lines = getline(start, end)
+---
+--- <Can also be used as a |method|: >
+---   ComputeLnum()->getline()
+---
+--- <To get lines from another buffer see |getbufline()| and
+--- |getbufoneline()|
+---
+--- @param lnum integer
+--- @param end_? any
+--- @return any
+function vim.fn.getline(lnum, end_) end
+
+--- Returns a |List| with all the entries in the location list for
+--- window {nr}.  {nr} can be the window number or the |window-ID|.
+--- When {nr} is zero the current window is used.
+---
+--- For a location list window, the displayed location list is
+--- returned.  For an invalid window number {nr}, an empty list is
+--- returned. Otherwise, same as |getqflist()|.
+---
+--- If the optional {what} dictionary argument is supplied, then
+--- returns the items listed in {what} as a dictionary. Refer to
+--- |getqflist()| for the supported items in {what}.
+---
+--- In addition to the items supported by |getqflist()| in {what},
+--- the following item is supported by |getloclist()|:
+---
+---   filewinid  id of the window used to display files
+---       from the location list. This field is
+---       applicable only when called from a
+---       location list window. See
+---       |location-list-file-window| for more
+---       details.
+---
+--- Returns a |Dictionary| with default values if there is no
+--- location list for the window {nr}.
+--- Returns an empty Dictionary if window {nr} does not exist.
+---
+--- Examples (See also |getqflist-examples|): >
+---   :echo getloclist(3, {'all': 0})
+---   :echo getloclist(5, {'filewinid': 0})
+---
+---
+--- @param nr integer
+--- @param what? any
+--- @return any
+function vim.fn.getloclist(nr, what) end
+
+--- Without the {buf} argument returns a |List| with information
+--- about all the global marks. |mark|
+---
+--- If the optional {buf} argument is specified, returns the
+--- local marks defined in buffer {buf}.  For the use of {buf},
+--- see |bufname()|.  If {buf} is invalid, an empty list is
+--- returned.
+---
+--- Each item in the returned List is a |Dict| with the following:
+---     mark   name of the mark prefixed by "'"
+---     pos     a |List| with the position of the mark:
+---     [bufnum, lnum, col, off]
+---      Refer to |getpos()| for more information.
+---     file   file name
+---
+--- Refer to |getpos()| for getting information about a specific
+--- mark.
+---
+--- Can also be used as a |method|: >
+---   GetBufnr()->getmarklist()
+---
+--- @param buf? any
+--- @return any
+function vim.fn.getmarklist(buf) end
+
+--- Returns a |List| with all matches previously defined for the
+--- current window by |matchadd()| and the |:match| commands.
+--- |getmatches()| is useful in combination with |setmatches()|,
+--- as |setmatches()| can restore a list of matches saved by
+--- |getmatches()|.
+--- If {win} is specified, use the window with this number or
+--- window ID instead of the current window.  If {win} is invalid,
+--- an empty list is returned.
+--- Example: >vim
+---   :echo getmatches()
+--- >
+---        [{"group": "MyGroup1", "pattern": "TODO",
+---   "priority": 10, "id": 1}, {"group": "MyGroup2",
+---   "pattern": "FIXME", "priority": 10, "id": 2}]
+--- >vim
+---   :let m = getmatches()
+---   :call clearmatches()
+---   :echo getmatches()
+--- >
+---   []
+--- >vim
+---   :call setmatches(m)
+---   :echo getmatches()
+--- >
+---   [{"group": "MyGroup1", "pattern": "TODO",
+---   "priority": 10, "id": 1}, {"group": "MyGroup2",
+---   "pattern": "FIXME", "priority": 10, "id": 2}]
+--- >vim
+---   :unlet m
+--- <
+--- @param win? any
+--- @return any
+function vim.fn.getmatches(win) end
+
+--- Returns a Dictionary with the last known position of the
+--- mouse.  This can be used in a mapping for a mouse click.  The
+--- items are:
+---   screenrow  screen row
+---   screencol  screen column
+---   winid    Window ID of the click
+---   winrow    row inside "winid"
+---   wincol    column inside "winid"
+---   line    text line inside "winid"
+---   column    text column inside "winid"
+--- All numbers are 1-based.
+---
+--- If not over a window, e.g. when in the command line, then only
+--- "screenrow" and "screencol" are valid, the others are zero.
+---
+--- When on the status line below a window or the vertical
+--- separator right of a window, the "line" and "column" values
+--- are zero.
+---
+--- When the position is after the text then "column" is the
+--- length of the text in bytes plus one.
+---
+--- If the mouse is over a focusable floating window then that
+--- window is used.
+---
+--- When using |getchar()| the Vim variables |v:mouse_lnum|,
+--- |v:mouse_col| and |v:mouse_winid| also provide these values.
+---
+---           *getpid()*
+--- @return any
+function vim.fn.getmousepos() end
+
+--- This is a unique number, until Vim exits.
+---
+---           *getpos()*
+--- @return integer
+function vim.fn.getpid() end
+
+--- {expr} see |line()|.  For getting the cursor position see
+--- |getcurpos()|.
+--- The result is a |List| with four numbers:
+---     [bufnum, lnum, col, off]
+--- "bufnum" is zero, unless a mark like '0 or 'A is used, then it
+--- is the buffer number of the mark.
+--- "lnum" and "col" are the position in the buffer.  The first
+--- column is 1.
+--- The "off" number is zero, unless 'virtualedit' is used.  Then
+--- it is the offset in screen columns from the start of the
+--- character.  E.g., a position within a <Tab> or after the last
+--- character.
+--- Note that for '< and '> Visual mode matters: when it is "V"
+--- (visual line mode) the column of '< is zero and the column of
+--- '> is a large number equal to |v:maxcol|.
+--- The column number in the returned List is the byte position
+--- within the line. To get the character position in the line,
+--- use |getcharpos()|.
+--- A very large column number equal to |v:maxcol| can be returned,
+--- in which case it means "after the end of the line".
+--- If {expr} is invalid, returns a list with all zeros.
+--- This can be used to save and restore the position of a mark: >
+---   let save_a_mark = getpos("'a")
+---   ...
+---   call setpos("'a", save_a_mark)
+--- <Also see |getcharpos()|, |getcurpos()| and |setpos()|.
+---
+--- Can also be used as a |method|: >
+---   GetMark()->getpos()
+---
+--- @param expr any
+--- @return any
+function vim.fn.getpos(expr) end
+
+--- Returns a |List| with all the current quickfix errors.  Each
+--- list item is a dictionary with these entries:
+---   bufnr  number of buffer that has the file name, use
+---     bufname() to get the name
+---   module  module name
+---   lnum  line number in the buffer (first line is 1)
+---   end_lnum
+---     end of line number if the item is multiline
+---   col  column number (first column is 1)
+---   end_col  end of column number if the item has range
+---   vcol  |TRUE|: "col" is visual column
+---     |FALSE|: "col" is byte index
+---   nr  error number
+---   pattern  search pattern used to locate the error
+---   text  description of the error
+---   type  type of the error, 'E', '1', etc.
+---   valid  |TRUE|: recognized error message
+---
+--- When there is no error list or it's empty, an empty list is
+--- returned. Quickfix list entries with a non-existing buffer
+--- number are returned with "bufnr" set to zero (Note: some
+--- functions accept buffer number zero for the alternate buffer,
+--- you may need to explicitly check for zero).
+---
+--- Useful application: Find pattern matches in multiple files and
+--- do something with them: >
+---   :vimgrep /theword/jg *.c
+---   :for d in getqflist()
+---   :   echo bufname(d.bufnr) ':' d.lnum '=' d.text
+---   :endfor
+--- <
+--- If the optional {what} dictionary argument is supplied, then
+--- returns only the items listed in {what} as a dictionary. The
+--- following string items are supported in {what}:
+---   changedtick  get the total number of changes made
+---       to the list |quickfix-changedtick|
+---   context  get the |quickfix-context|
+---   efm  errorformat to use when parsing "lines". If
+---     not present, then the 'errorformat' option
+---     value is used.
+---   id  get information for the quickfix list with
+---     |quickfix-ID|; zero means the id for the
+---     current list or the list specified by "nr"
+---   idx  get information for the quickfix entry at this
+---     index in the list specified by "id" or "nr".
+---     If set to zero, then uses the current entry.
+---     See |quickfix-index|
+---   items  quickfix list entries
+---   lines  parse a list of lines using 'efm' and return
+---     the resulting entries.  Only a |List| type is
+---     accepted.  The current quickfix list is not
+---     modified. See |quickfix-parse|.
+---   nr  get information for this quickfix list; zero
+---     means the current quickfix list and "$" means
+---     the last quickfix list
+---   qfbufnr number of the buffer displayed in the quickfix
+---     window. Returns 0 if the quickfix buffer is
+---     not present. See |quickfix-buffer|.
+---   size  number of entries in the quickfix list
+---   title  get the list title |quickfix-title|
+---   winid  get the quickfix |window-ID|
+---   all  all of the above quickfix properties
+--- Non-string items in {what} are ignored. To get the value of a
+--- particular item, set it to zero.
+--- If "nr" is not present then the current quickfix list is used.
+--- If both "nr" and a non-zero "id" are specified, then the list
+--- specified by "id" is used.
+--- To get the number of lists in the quickfix stack, set "nr" to
+--- "$" in {what}. The "nr" value in the returned dictionary
+--- contains the quickfix stack size.
+--- When "lines" is specified, all the other items except "efm"
+--- are ignored.  The returned dictionary contains the entry
+--- "items" with the list of entries.
+---
+--- The returned dictionary contains the following entries:
+---   changedtick  total number of changes made to the
+---       list |quickfix-changedtick|
+---   context  quickfix list context. See |quickfix-context|
+---     If not present, set to "".
+---   id  quickfix list ID |quickfix-ID|. If not
+---     present, set to 0.
+---   idx  index of the quickfix entry in the list. If not
+---     present, set to 0.
+---   items  quickfix list entries. If not present, set to
+---     an empty list.
+---   nr  quickfix list number. If not present, set to 0
+---   qfbufnr  number of the buffer displayed in the quickfix
+---     window. If not present, set to 0.
+---   size  number of entries in the quickfix list. If not
+---     present, set to 0.
+---   title  quickfix list title text. If not present, set
+---     to "".
+---   winid  quickfix |window-ID|. If not present, set to 0
+---
+--- Examples (See also |getqflist-examples|): >
+---   :echo getqflist({'all': 1})
+---   :echo getqflist({'nr': 2, 'title': 1})
+---   :echo getqflist({'lines' : ["F1:10:L10"]})
+--- <
+--- @param what? any
+--- @return any
+function vim.fn.getqflist(what) end
+
+--- The result is a String, which is the contents of register
+--- {regname}.  Example: >
+---   :let cliptext = getreg('*')
+--- <When register {regname} was not set the result is an empty
+--- string.
+--- The {regname} argument must be a string.
+---
+--- getreg('=') returns the last evaluated value of the expression
+--- register.  (For use in maps.)
+--- getreg('=', 1) returns the expression itself, so that it can
+--- be restored with |setreg()|.  For other registers the extra
+--- argument is ignored, thus you can always give it.
+---
+--- If {list} is present and |TRUE|, the result type is changed
+--- to |List|. Each list item is one text line. Use it if you care
+--- about zero bytes possibly present inside register: without
+--- third argument both NLs and zero bytes are represented as NLs
+--- (see |NL-used-for-Nul|).
+--- When the register was not set an empty list is returned.
+---
+--- If {regname} is not specified, |v:register| is used.
+---
+--- Can also be used as a |method|: >
+---   GetRegname()->getreg()
+---
+--- @param regname? string
+--- @param list? any
+--- @return string|string[]
+function vim.fn.getreg(regname, list) end
+
+--- Returns detailed information about register {regname} as a
+--- Dictionary with the following entries:
+---   regcontents  List of lines contained in register
+---       {regname}, like
+---       getreg({regname}, 1, 1).
+---   regtype    the type of register {regname}, as in
+---       |getregtype()|.
+---   isunnamed  Boolean flag, v:true if this register
+---       is currently pointed to by the unnamed
+---       register.
+---   points_to  for the unnamed register, gives the
+---       single letter name of the register
+---       currently pointed to (see |quotequote|).
+---       For example, after deleting a line
+---       with `dd`, this field will be "1",
+---       which is the register that got the
+---       deleted text.
+---
+--- The {regname} argument is a string.  If {regname} is invalid
+--- or not set, an empty Dictionary will be returned.
+--- If {regname} is not specified, |v:register| is used.
+--- The returned Dictionary can be passed to |setreg()|.
+---
+--- Can also be used as a |method|: >
+---   GetRegname()->getreginfo()
+---
+--- @param regname? string
+--- @return table
+function vim.fn.getreginfo(regname) end
+
+--- The result is a String, which is type of register {regname}.
+--- The value will be one of:
+---     "v"      for |charwise| text
+---     "V"      for |linewise| text
+---     "<CTRL-V>{width}"  for |blockwise-visual| text
+---     ""      for an empty or unknown register
+--- <CTRL-V> is one character with value 0x16.
+--- The {regname} argument is a string.  If {regname} is not
+--- specified, |v:register| is used.
+---
+--- Can also be used as a |method|: >
+---   GetRegname()->getregtype()
+---
+--- @param regname? string
+--- @return string
+function vim.fn.getregtype(regname) end
+
+--- Returns a |List| with information about all the sourced Vim
+--- scripts in the order they were sourced, like what
+--- `:scriptnames` shows.
+---
+--- The optional Dict argument {opts} supports the following
+--- optional items:
+---     name  Script name match pattern. If specified,
+---     and "sid" is not specified, information about
+---     scripts with a name that match the pattern
+---     "name" are returned.
+---     sid    Script ID |<SID>|.  If specified, only
+---     information about the script with ID "sid" is
+---     returned and "name" is ignored.
+---
+--- Each item in the returned List is a |Dict| with the following
+--- items:
+---     autoload  Always set to FALSE.
+---     functions   List of script-local function names defined in
+---     the script.  Present only when a particular
+---     script is specified using the "sid" item in
+---     {opts}.
+---     name  Vim script file name.
+---     sid    Script ID |<SID>|.
+---     variables   A dictionary with the script-local variables.
+---     Present only when a particular script is
+---     specified using the "sid" item in {opts}.
+---     Note that this is a copy, the value of
+---     script-local variables cannot be changed using
+---     this dictionary.
+---     version  Vimscript version, always 1
+---
+--- Examples: >
+---   :echo getscriptinfo({'name': 'myscript'})
+---   :echo getscriptinfo({'sid': 15}).variables
+--- <
+--- @param opts? table
+--- @return any
+function vim.fn.getscriptinfo(opts) end
+
+--- If {tabnr} is not specified, then information about all the
+--- tab pages is returned as a |List|. Each List item is a
+--- |Dictionary|.  Otherwise, {tabnr} specifies the tab page
+--- number and information about that one is returned.  If the tab
+--- page does not exist an empty List is returned.
+---
+--- Each List item is a |Dictionary| with the following entries:
+---   tabnr    tab page number.
+---   variables  a reference to the dictionary with
+---       tabpage-local variables
+---   windows    List of |window-ID|s in the tab page.
+---
+--- Can also be used as a |method|: >
+---   GetTabnr()->gettabinfo()
+---
+--- @param tabnr? integer
+--- @return any
+function vim.fn.gettabinfo(tabnr) end
+
+--- Get the value of a tab-local variable {varname} in tab page
+--- {tabnr}. |t:var|
+--- Tabs are numbered starting with one.
+--- The {varname} argument is a string.  When {varname} is empty a
+--- dictionary with all tab-local variables is returned.
+--- Note that the name without "t:" must be used.
+--- When the tab or variable doesn't exist {def} or an empty
+--- string is returned, there is no error message.
+---
+--- Can also be used as a |method|: >
+---   GetTabnr()->gettabvar(varname)
+---
+--- @param tabnr integer
+--- @param varname string
+--- @param def? any
+--- @return any
+function vim.fn.gettabvar(tabnr, varname, def) end
+
+--- Get the value of window-local variable {varname} in window
+--- {winnr} in tab page {tabnr}.
+--- The {varname} argument is a string.  When {varname} is empty a
+--- dictionary with all window-local variables is returned.
+--- When {varname} is equal to "&" get the values of all
+--- window-local options in a |Dictionary|.
+--- Otherwise, when {varname} starts with "&" get the value of a
+--- window-local option.
+--- Note that {varname} must be the name without "w:".
+--- Tabs are numbered starting with one.  For the current tabpage
+--- use |getwinvar()|.
+--- {winnr} can be the window number or the |window-ID|.
+--- When {winnr} is zero the current window is used.
+--- This also works for a global option, buffer-local option and
+--- window-local option, but it doesn't work for a global variable
+--- or buffer-local variable.
+--- When the tab, window or variable doesn't exist {def} or an
+--- empty string is returned, there is no error message.
+--- Examples: >
+---   :let list_is_on = gettabwinvar(1, 2, '&list')
+---   :echo "myvar = " .. gettabwinvar(3, 1, 'myvar')
+--- <
+--- To obtain all window-local variables use: >
+---   gettabwinvar({tabnr}, {winnr}, '&')
+---
+--- <Can also be used as a |method|: >
+---   GetTabnr()->gettabwinvar(winnr, varname)
+---
+--- @param tabnr integer
+--- @param winnr integer
+--- @param varname string
+--- @param def? any
+--- @return any
+function vim.fn.gettabwinvar(tabnr, winnr, varname, def) end
+
+--- The result is a Dict, which is the tag stack of window {winnr}.
+--- {winnr} can be the window number or the |window-ID|.
+--- When {winnr} is not specified, the current window is used.
+--- When window {winnr} doesn't exist, an empty Dict is returned.
+---
+--- The returned dictionary contains the following entries:
+---   curidx    Current index in the stack. When at
+---       top of the stack, set to (length + 1).
+---       Index of bottom of the stack is 1.
+---   items    List of items in the stack. Each item
+---       is a dictionary containing the
+---       entries described below.
+---   length    Number of entries in the stack.
+---
+--- Each item in the stack is a dictionary with the following
+--- entries:
+---   bufnr    buffer number of the current jump
+---   from    cursor position before the tag jump.
+---       See |getpos()| for the format of the
+---       returned list.
+---   matchnr    current matching tag number. Used when
+---       multiple matching tags are found for a
+---       name.
+---   tagname    name of the tag
+---
+--- See |tagstack| for more information about the tag stack.
+---
+--- Can also be used as a |method|: >
+---   GetWinnr()->gettagstack()
+---
+---
+--- @param winnr? integer
+--- @return any
+function vim.fn.gettagstack(winnr) end
+
+--- Translate String {text} if possible.
+--- This is mainly for use in the distributed Vim scripts.  When
+--- generating message translations the {text} is extracted by
+--- xgettext, the translator can add the translated message in the
+--- .po file and Vim will lookup the translation when gettext() is
+--- called.
+--- For {text} double quoted strings are preferred, because
+--- xgettext does not understand escaping in single quoted
+--- strings.
+---
+---
+--- @param text any
+--- @return any
+function vim.fn.gettext(text) end
+
+--- Returns information about windows as a |List| with Dictionaries.
+---
+--- If {winid} is given Information about the window with that ID
+--- is returned, as a |List| with one item.  If the window does not
+--- exist the result is an empty list.
+---
+--- Without {winid} information about all the windows in all the
+--- tab pages is returned.
+---
+--- Each List item is a |Dictionary| with the following entries:
+---   botline    last complete displayed buffer line
+---   bufnr    number of buffer in the window
+---   height    window height (excluding winbar)
+---   loclist    1 if showing a location list
+---   quickfix  1 if quickfix or location list window
+---   terminal  1 if a terminal window
+---   tabnr    tab page number
+---   topline    first displayed buffer line
+---   variables  a reference to the dictionary with
+---       window-local variables
+---   width    window width
+---   winbar    1 if the window has a toolbar, 0
+---       otherwise
+---   wincol    leftmost screen column of the window;
+---       "col" from |win_screenpos()|
+---   textoff    number of columns occupied by any
+---       'foldcolumn', 'signcolumn' and line
+---       number in front of the text
+---   winid    |window-ID|
+---   winnr    window number
+---   winrow    topmost screen line of the window;
+---       "row" from |win_screenpos()|
+---
+--- Can also be used as a |method|: >
+---   GetWinnr()->getwininfo()
+---
+--- @param winid? integer
+--- @return any
+function vim.fn.getwininfo(winid) end
+
+--- The result is a |List| with two numbers, the result of
+--- |getwinposx()| and |getwinposy()| combined:
+---   [x-pos, y-pos]
+--- {timeout} can be used to specify how long to wait in msec for
+--- a response from the terminal.  When omitted 100 msec is used.
+---
+--- Use a longer time for a remote terminal.
+--- When using a value less than 10 and no response is received
+--- within that time, a previously reported position is returned,
+--- if available.  This can be used to poll for the position and
+--- do some work in the meantime: >
+---   while 1
+---     let res = getwinpos(1)
+---     if res[0] >= 0
+---       break
+---     endif
+---     " Do some work here
+---   endwhile
+--- <
+--- Can also be used as a |method|: >
+---   GetTimeout()->getwinpos()
+--- <
+---           *getwinposx()*
+--- @param timeout? integer
+--- @return any
+function vim.fn.getwinpos(timeout) end
+
+--- the left hand side of the GUI Vim window.  The result will be
+--- -1 if the information is not available.
+--- The value can be used with `:winpos`.
+---
+---           *getwinposy()*
+--- @return integer
+function vim.fn.getwinposx() end
+
+--- the top of the GUI Vim window.  The result will be -1 if the
+--- information is not available.
+--- The value can be used with `:winpos`.
+---
+--- @return integer
+function vim.fn.getwinposy() end
+
+--- Like |gettabwinvar()| for the current tabpage.
+--- Examples: >
+---   :let list_is_on = getwinvar(2, '&list')
+---   :echo "myvar = " .. getwinvar(1, 'myvar')
+---
+--- <Can also be used as a |method|: >
+---   GetWinnr()->getwinvar(varname)
+--- <
+--- @param winnr integer
+--- @param varname string
+--- @param def? any
+--- @return any
+function vim.fn.getwinvar(winnr, varname, def) end
+
+--- Expand the file wildcards in {expr}.  See |wildcards| for the
+--- use of special characters.
+---
+--- Unless the optional {nosuf} argument is given and is |TRUE|,
+--- the 'suffixes' and 'wildignore' options apply: Names matching
+--- one of the patterns in 'wildignore' will be skipped and
+--- 'suffixes' affect the ordering of matches.
+--- 'wildignorecase' always applies.
+---
+--- When {list} is present and it is |TRUE| the result is a |List|
+--- with all matching files. The advantage of using a List is,
+--- you also get filenames containing newlines correctly.
+--- Otherwise the result is a String and when there are several
+--- matches, they are separated by <NL> characters.
+---
+--- If the expansion fails, the result is an empty String or List.
+---
+--- You can also use |readdir()| if you need to do complicated
+--- things, such as limiting the number of matches.
+---
+--- A name for a non-existing file is not included.  A symbolic
+--- link is only included if it points to an existing file.
+--- However, when the {alllinks} argument is present and it is
+--- |TRUE| then all symbolic links are included.
+---
+--- For most systems backticks can be used to get files names from
+--- any external command.  Example: >
+---   :let tagfiles = glob("`find . -name tags -print`")
+---   :let &tags = substitute(tagfiles, "\n", ",", "g")
+--- <The result of the program inside the backticks should be one
+--- item per line.  Spaces inside an item are allowed.
+---
+--- See |expand()| for expanding special Vim variables.  See
+--- |system()| for getting the raw output of an external command.
+---
+--- Can also be used as a |method|: >
+---   GetExpr()->glob()
+---
+--- @param expr any
+--- @param nosuf? boolean
+--- @param list? any
+--- @param alllinks? any
+--- @return any
+function vim.fn.glob(expr, nosuf, list, alllinks) end
+
+--- Convert a file pattern, as used by glob(), into a search
+--- pattern.  The result can be used to match with a string that
+--- is a file name.  E.g. >
+---   if filename =~ glob2regpat('Make*.mak')
+--- <This is equivalent to: >
+---   if filename =~ '^Make.*\.mak$'
+--- <When {string} is an empty string the result is "^$", match an
+--- empty string.
+--- Note that the result depends on the system.  On MS-Windows
+--- a backslash usually means a path separator.
+---
+--- Can also be used as a |method|: >
+---   GetExpr()->glob2regpat()
+--- <            *globpath()*
+--- @param string string
+--- @return any
+function vim.fn.glob2regpat(string) end
+
+--- Perform glob() for String {expr} on all directories in {path}
+--- and concatenate the results.  Example: >
+---   :echo globpath(&rtp, "syntax/c.vim")
+--- <
+--- {path} is a comma-separated list of directory names.  Each
+--- directory name is prepended to {expr} and expanded like with
+--- |glob()|.  A path separator is inserted when needed.
+--- To add a comma inside a directory name escape it with a
+--- backslash.  Note that on MS-Windows a directory may have a
+--- trailing backslash, remove it if you put a comma after it.
+--- If the expansion fails for one of the directories, there is no
+--- error message.
+---
+--- Unless the optional {nosuf} argument is given and is |TRUE|,
+--- the 'suffixes' and 'wildignore' options apply: Names matching
+--- one of the patterns in 'wildignore' will be skipped and
+--- 'suffixes' affect the ordering of matches.
+---
+--- When {list} is present and it is |TRUE| the result is a |List|
+--- with all matching files. The advantage of using a List is, you
+--- also get filenames containing newlines correctly. Otherwise
+--- the result is a String and when there are several matches,
+--- they are separated by <NL> characters.  Example: >
+---   :echo globpath(&rtp, "syntax/c.vim", 0, 1)
+--- <
+--- {allinks} is used as with |glob()|.
+---
+--- The "**" item can be used to search in a directory tree.
+--- For example, to find all "README.txt" files in the directories
+--- in 'runtimepath' and below: >
+---   :echo globpath(&rtp, "**/README.txt")
+--- <Upwards search and limiting the depth of "**" is not
+--- supported, thus using 'path' will not always work properly.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- second argument: >
+---   GetExpr()->globpath(&rtp)
+--- <
+---           *has()*
+--- @param path string
+--- @param expr any
+--- @param nosuf? boolean
+--- @param list? any
+--- @param allinks? any
+--- @return any
+function vim.fn.globpath(path, expr, nosuf, list, allinks) end
+
+--- {feature} argument is a feature name like "nvim-0.2.1" or
+--- "win32", see below.  See also |exists()|.
+---
+--- To get the system name use |vim.uv|.os_uname() in Lua: >lua
+---   print(vim.uv.os_uname().sysname)
+---
+--- <If the code has a syntax error then Vimscript may skip the
+--- rest of the line.  Put |:if| and |:endif| on separate lines to
+--- avoid the syntax error: >
+---   if has('feature')
+---     let x = this->breaks->without->the->feature
+---   endif
+--- <
+--- Vim's compile-time feature-names (prefixed with "+") are not
+--- recognized because Nvim is always compiled with all possible
+--- features. |feature-compile|
+---
+--- Feature names can be:
+--- 1.  Nvim version. For example the "nvim-0.2.1" feature means
+---     that Nvim is version 0.2.1 or later: >
+---   :if has("nvim-0.2.1")
+---
+--- <2.  Runtime condition or other pseudo-feature. For example the
+---     "win32" feature checks if the current system is Windows: >
+---   :if has("win32")
+--- <          *feature-list*
+---     List of supported pseudo-feature names:
+---   acl    |ACL| support.
+---   bsd    BSD system (not macOS, use "mac" for that).
+---   clipboard  |clipboard| provider is available.
+---   fname_case  Case in file names matters (for Darwin and MS-Windows
+---       this is not present).
+---                         gui_running  Nvim has a GUI.
+---   iconv    Can use |iconv()| for conversion.
+---   linux    Linux system.
+---   mac    MacOS system.
+---   nvim    This is Nvim.
+---   python3    Legacy Vim |python3| interface. |has-python|
+---   pythonx    Legacy Vim |python_x| interface. |has-pythonx|
+---   sun    SunOS system.
+---   ttyin    input is a terminal (tty).
+---   ttyout    output is a terminal (tty).
+---   unix    Unix system.
+---   *vim_starting*  True during |startup|.
+---   win32    Windows system (32 or 64 bit).
+---   win64    Windows system (64 bit).
+---   wsl    WSL (Windows Subsystem for Linux) system.
+---
+---           *has-patch*
+--- 3.  Vim patch. For example the "patch123" feature means that
+---     Vim patch 123 at the current |v:version| was included: >
+---   :if v:version > 602 || v:version == 602 && has("patch148")
+---
+--- <4.  Vim version. For example the "patch-7.4.237" feature means
+---     that Nvim is Vim-compatible to version 7.4.237 or later. >
+---   :if has("patch-7.4.237")
+---
+---
+--- @param feature any
+--- @return 0|1
+function vim.fn.has(feature) end
+
+--- The result is a Number, which is TRUE if |Dictionary| {dict}
+--- has an entry with key {key}.  FALSE otherwise. The {key}
+--- argument is a string.
+---
+--- Can also be used as a |method|: >
+---   mydict->has_key(key)
+---
+--- @param dict any
+--- @param key any
+--- @return 0|1
+function vim.fn.has_key(dict, key) end
+
+--- The result is a Number, which is 1 when the window has set a
+--- local path via |:lcd| or when {winnr} is -1 and the tabpage
+--- has set a local path via |:tcd|, otherwise 0.
+---
+--- Tabs and windows are identified by their respective numbers,
+--- 0 means current tab or window. Missing argument implies 0.
+--- Thus the following are equivalent: >
+---   haslocaldir()
+---   haslocaldir(0)
+---   haslocaldir(0, 0)
+--- <With {winnr} use that window in the current tabpage.
+--- With {winnr} and {tabnr} use the window in that tabpage.
+--- {winnr} can be the window number or the |window-ID|.
+--- If {winnr} is -1 it is ignored, only the tab is resolved.
+--- Throw error if the arguments are invalid. |E5000| |E5001| |E5002|
+---
+--- Can also be used as a |method|: >
+---   GetWinnr()->haslocaldir()
+---
+--- @param winnr? integer
+--- @param tabnr? integer
+--- @return 0|1
+function vim.fn.haslocaldir(winnr, tabnr) end
+
+--- The result is a Number, which is TRUE if there is a mapping
+--- that contains {what} in somewhere in the rhs (what it is
+--- mapped to) and this mapping exists in one of the modes
+--- indicated by {mode}.
+--- The arguments {what} and {mode} are strings.
+--- When {abbr} is there and it is |TRUE| use abbreviations
+--- instead of mappings.  Don't forget to specify Insert and/or
+--- Command-line mode.
+--- Both the global mappings and the mappings local to the current
+--- buffer are checked for a match.
+--- If no matching mapping is found FALSE is returned.
+--- The following characters are recognized in {mode}:
+---   n  Normal mode
+---   v  Visual and Select mode
+---   x  Visual mode
+---   s  Select mode
+---   o  Operator-pending mode
+---   i  Insert mode
+---   l  Language-Argument ("r", "f", "t", etc.)
+---   c  Command-line mode
+--- When {mode} is omitted, "nvo" is used.
+---
+--- This function is useful to check if a mapping already exists
+--- to a function in a Vim script.  Example: >
+---   :if !hasmapto('\ABCdoit')
+---   :   map <Leader>d \ABCdoit
+---   :endif
+--- <This installs the mapping to "\ABCdoit" only if there isn't
+--- already a mapping to "\ABCdoit".
+---
+--- Can also be used as a |method|: >
+---   GetRHS()->hasmapto()
+---
+--- @param what any
+--- @param mode? string
+--- @param abbr? any
+--- @return 0|1
+function vim.fn.hasmapto(what, mode, abbr) end
+
+--- @deprecated
+--- Obsolete name for |hlID()|.
+function vim.fn.highlightID(...) end
+
+--- @deprecated
+--- Obsolete name for |hlexists()|.
+function vim.fn.highlight_exists(...) end
+
+--- Add the String {item} to the history {history} which can be
+--- one of:          *hist-names*
+---   "cmd"   or ":"    command line history
+---   "search" or "/"   search pattern history
+---   "expr"   or "="   typed expression history
+---   "input"  or "\@"    input line history
+---   "debug"  or ">"   debug command history
+---   empty      the current or last used history
+--- The {history} string does not need to be the whole name, one
+--- character is sufficient.
+--- If {item} does already exist in the history, it will be
+--- shifted to become the newest entry.
+--- The result is a Number: TRUE if the operation was successful,
+--- otherwise FALSE is returned.
+---
+--- Example: >
+---   :call histadd("input", strftime("%Y %b %d"))
+---   :let date=input("Enter date: ")
+--- <This function is not available in the |sandbox|.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- second argument: >
+---   GetHistory()->histadd('search')
+---
+--- @param history any
+--- @param item any
+--- @return 0|1
+function vim.fn.histadd(history, item) end
+
+--- Clear {history}, i.e. delete all its entries.  See |hist-names|
+--- for the possible values of {history}.
+---
+--- If the parameter {item} evaluates to a String, it is used as a
+--- regular expression.  All entries matching that expression will
+--- be removed from the history (if there are any).
+--- Upper/lowercase must match, unless "\c" is used |/\c|.
+--- If {item} evaluates to a Number, it will be interpreted as
+--- an index, see |:history-indexing|.  The respective entry will
+--- be removed if it exists.
+---
+--- The result is TRUE for a successful operation, otherwise FALSE
+--- is returned.
+---
+--- Examples:
+--- Clear expression register history: >
+---   :call histdel("expr")
+--- <
+--- Remove all entries starting with "*" from the search history: >
+---   :call histdel("/", '^\*')
+--- <
+--- The following three are equivalent: >
+---   :call histdel("search", histnr("search"))
+---   :call histdel("search", -1)
+---   :call histdel("search", '^' .. histget("search", -1) .. '$')
+--- <
+--- To delete the last search pattern and use the last-but-one for
+--- the "n" command and 'hlsearch': >
+---   :call histdel("search", -1)
+---   :let \@/ = histget("search", -1)
+--- <
+--- Can also be used as a |method|: >
+---   GetHistory()->histdel()
+---
+--- @param history any
+--- @param item? any
+--- @return 0|1
+function vim.fn.histdel(history, item) end
+
+--- The result is a String, the entry with Number {index} from
+--- {history}.  See |hist-names| for the possible values of
+--- {history}, and |:history-indexing| for {index}.  If there is
+--- no such entry, an empty String is returned.  When {index} is
+--- omitted, the most recent item from the history is used.
+---
+--- Examples:
+--- Redo the second last search from history. >
+---   :execute '/' .. histget("search", -2)
+---
+--- <Define an Ex command ":H {num}" that supports re-execution of
+--- the {num}th entry from the output of |:history|. >
+---   :command -nargs=1 H execute histget("cmd", 0+<args>)
+--- <
+--- Can also be used as a |method|: >
+---   GetHistory()->histget()
+---
+--- @param history any
+--- @param index? any
+--- @return string
+function vim.fn.histget(history, index) end
+
+--- The result is the Number of the current entry in {history}.
+--- See |hist-names| for the possible values of {history}.
+--- If an error occurred, -1 is returned.
+---
+--- Example: >
+---   :let inp_index = histnr("expr")
+---
+--- <Can also be used as a |method|: >
+---   GetHistory()->histnr()
+--- <
+--- @param history any
+--- @return integer
+function vim.fn.histnr(history) end
+
+--- with name {name}.  When the highlight group doesn't exist,
+--- zero is returned.
+--- This can be used to retrieve information about the highlight
+--- group.  For example, to get the background color of the
+--- "Comment" group: >
+---   :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
+--- <
+--- Can also be used as a |method|: >
+---   GetName()->hlID()
+---
+--- @param name string
+--- @return integer
+function vim.fn.hlID(name) end
+
+--- The result is a Number, which is TRUE if a highlight group
+--- called {name} exists.  This is when the group has been
+--- defined in some way.  Not necessarily when highlighting has
+--- been defined for it, it may also have been used for a syntax
+--- item.
+---
+--- Can also be used as a |method|: >
+---   GetName()->hlexists()
+--- <
+---           *hlID()*
+--- @param name string
+--- @return 0|1
+function vim.fn.hlexists(name) end
+
+--- The result is a String, which is the name of the machine on
+--- which Vim is currently running.  Machine names greater than
+--- 256 characters long are truncated.
+---
+--- @return string
+function vim.fn.hostname() end
+
+--- The result is a String, which is the text {string} converted
+--- from encoding {from} to encoding {to}.
+--- When the conversion completely fails an empty string is
+--- returned.  When some characters could not be converted they
+--- are replaced with "?".
+--- The encoding names are whatever the iconv() library function
+--- can accept, see ":!man 3 iconv".
+--- Note that Vim uses UTF-8 for all Unicode encodings, conversion
+--- from/to UCS-2 is automatically changed to use UTF-8.  You
+--- cannot use UCS-2 in a string anyway, because of the NUL bytes.
+---
+--- Can also be used as a |method|: >
+---   GetText()->iconv('latin1', 'utf-8')
+--- <
+---           *indent()*
+--- @param string string
+--- @param from any
+--- @param to any
+--- @return any
+function vim.fn.iconv(string, from, to) end
+
+--- Returns a |String| which is a unique identifier of the
+--- container type (|List|, |Dict|, |Blob| and |Partial|). It is
+--- guaranteed that for the mentioned types `id(v1) ==# id(v2)`
+--- returns true iff `type(v1) == type(v2) && v1 is v2`.
+--- Note that |v:_null_string|, |v:_null_list|, |v:_null_dict| and
+--- |v:_null_blob| have the same `id()` with different types
+--- because they are internally represented as NULL pointers.
+--- `id()` returns a hexadecimal representanion of the pointers to
+--- the containers (i.e. like `0x994a40`), same as `printf("%p",
+--- {expr})`, but it is advised against counting on the exact
+--- format of the return value.
+---
+--- It is not guaranteed that `id(no_longer_existing_container)`
+--- will not be equal to some other `id()`: new containers may
+--- reuse identifiers of the garbage-collected ones.
+---
+--- @param expr any
+--- @return any
+function vim.fn.id(expr) end
+
+--- current buffer.  The indent is counted in spaces, the value
+--- of 'tabstop' is relevant.  {lnum} is used just like in
+--- |getline()|.
+--- When {lnum} is invalid -1 is returned.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->indent()
+---
+--- @param lnum integer
+--- @return integer
+function vim.fn.indent(lnum) end
+
+--- Find {expr} in {object} and return its index.  See
+--- |indexof()| for using a lambda to select the item.
+---
+--- If {object} is a |List| return the lowest index where the item
+--- has a value equal to {expr}.  There is no automatic
+--- conversion, so the String "4" is different from the Number 4.
+--- And the Number 4 is different from the Float 4.0.  The value
+--- of 'ignorecase' is not used here, case matters as indicated by
+--- the {ic} argument.
+---
+--- If {object} is a |Blob| return the lowest index where the byte
+--- value is equal to {expr}.
+---
+--- If {start} is given then start looking at the item with index
+--- {start} (may be negative for an item relative to the end).
+---
+--- When {ic} is given and it is |TRUE|, ignore case.  Otherwise
+--- case must match.
+---
+--- -1 is returned when {expr} is not found in {object}.
+--- Example: >
+---   :let idx = index(words, "the")
+---   :if index(numbers, 123) >= 0
+---
+--- <Can also be used as a |method|: >
+---   GetObject()->index(what)
+---
+--- @param object any
+--- @param expr any
+--- @param start? any
+--- @param ic? any
+--- @return any
+function vim.fn.index(object, expr, start, ic) end
+
+--- Returns the index of an item in {object} where {expr} is
+--- v:true.  {object} must be a |List| or a |Blob|.
+---
+--- If {object} is a |List|, evaluate {expr} for each item in the
+--- List until the expression is v:true and return the index of
+--- this item.
+---
+--- If {object} is a |Blob| evaluate {expr} for each byte in the
+--- Blob until the expression is v:true and return the index of
+--- this byte.
+---
+--- {expr} must be a |string| or |Funcref|.
+---
+--- If {expr} is a |string|: If {object} is a |List|, inside
+--- {expr} |v:key| has the index of the current List item and
+--- |v:val| has the value of the item.  If {object} is a |Blob|,
+--- inside {expr} |v:key| has the index of the current byte and
+--- |v:val| has the byte value.
+---
+--- If {expr} is a |Funcref| it must take two arguments:
+---   1. the key or the index of the current item.
+---   2. the value of the current item.
+--- The function must return |TRUE| if the item is found and the
+--- search should stop.
+---
+--- The optional argument {opts} is a Dict and supports the
+--- following items:
+---     startidx  start evaluating {expr} at the item with this
+---     index; may be negative for an item relative to
+---     the end
+--- Returns -1 when {expr} evaluates to v:false for all the items.
+--- Example: >
+---   :let l = [#{n: 10}, #{n: 20}, #{n: 30}]
+---   :echo indexof(l, "v:val.n == 20")
+---   :echo indexof(l, {i, v -> v.n == 30})
+---   :echo indexof(l, "v:val.n == 20", #{startidx: 1})
+---
+--- <Can also be used as a |method|: >
+---   mylist->indexof(expr)
+---
+--- @param object any
+--- @param expr any
+--- @param opts? table
+--- @return any
+function vim.fn.indexof(object, expr, opts) end
+
+--- The result is a String, which is whatever the user typed on
+--- the command-line.  The {prompt} argument is either a prompt
+--- string, or a blank string (for no prompt).  A '\n' can be used
+--- in the prompt to start a new line.
+---
+--- In the second form it accepts a single dictionary with the
+--- following keys, any of which may be omitted:
+---
+--- Key           Default  Description ~
+--- prompt        ""       Same as {prompt} in the first form.
+--- default       ""       Same as {text} in the first form.
+--- completion    nothing  Same as {completion} in the first form.
+--- cancelreturn  ""       The value returned when the dialog is
+---                        cancelled.
+--- highlight     nothing  Highlight handler: |Funcref|.
+---
+--- The highlighting set with |:echohl| is used for the prompt.
+--- The input is entered just like a command-line, with the same
+--- editing commands and mappings.  There is a separate history
+--- for lines typed for input().
+--- Example: >
+---   :if input("Coffee or beer? ") == "beer"
+---   :  echo "Cheers!"
+---   :endif
+--- <
+--- If the optional {text} argument is present and not empty, this
+--- is used for the default reply, as if the user typed this.
+--- Example: >
+---   :let color = input("Color? ", "white")
+---
+--- <The optional {completion} argument specifies the type of
+--- completion supported for the input.  Without it completion is
+--- not performed.  The supported completion types are the same as
+--- that can be supplied to a user-defined command using the
+--- "-complete=" argument.  Refer to |:command-completion| for
+--- more information.  Example: >
+---   let fname = input("File: ", "", "file")
+---
+--- <      *input()-highlight* *E5400* *E5402*
+--- The optional `highlight` key allows specifying function which
+--- will be used for highlighting user input.  This function
+--- receives user input as its only argument and must return
+--- a list of 3-tuples [hl_start_col, hl_end_col + 1, hl_group]
+--- where
+---   hl_start_col is the first highlighted column,
+---   hl_end_col is the last highlighted column (+ 1!),
+---   hl_group is |:hi| group used for highlighting.
+---             *E5403* *E5404* *E5405* *E5406*
+--- Both hl_start_col and hl_end_col + 1 must point to the start
+--- of the multibyte character (highlighting must not break
+--- multibyte characters), hl_end_col + 1 may be equal to the
+--- input length.  Start column must be in range [0, len(input)),
+--- end column must be in range (hl_start_col, len(input)],
+--- sections must be ordered so that next hl_start_col is greater
+--- then or equal to previous hl_end_col.
+---
+--- Example (try some input with parentheses): >
+---   highlight RBP1 guibg=Red ctermbg=red
+---   highlight RBP2 guibg=Yellow ctermbg=yellow
+---   highlight RBP3 guibg=Green ctermbg=green
+---   highlight RBP4 guibg=Blue ctermbg=blue
+---   let g:rainbow_levels = 4
+---   function! RainbowParens(cmdline)
+---     let ret = []
+---     let i = 0
+---     let lvl = 0
+---     while i < len(a:cmdline)
+---       if a:cmdline[i] is# '('
+---         call add(ret, [i, i + 1, 'RBP' .. ((lvl % g:rainbow_levels) + 1)])
+---         let lvl += 1
+---       elseif a:cmdline[i] is# ')'
+---         let lvl -= 1
+---         call add(ret, [i, i + 1, 'RBP' .. ((lvl % g:rainbow_levels) + 1)])
+---       endif
+---       let i += 1
+---     endwhile
+---     return ret
+---   endfunction
+---   call input({'prompt':'>','highlight':'RainbowParens'})
+--- <
+--- Highlight function is called at least once for each new
+--- displayed input string, before command-line is redrawn.  It is
+--- expected that function is pure for the duration of one input()
+--- call, i.e. it produces the same output for the same input, so
+--- output may be memoized.  Function is run like under |:silent|
+--- modifier. If the function causes any errors, it will be
+--- skipped for the duration of the current input() call.
+---
+--- Highlighting is disabled if command-line contains arabic
+--- characters.
+---
+--- NOTE: This function must not be used in a startup file, for
+--- the versions that only run in GUI mode (e.g., the Win32 GUI).
+--- Note: When input() is called from within a mapping it will
+--- consume remaining characters from that mapping, because a
+--- mapping is handled like the characters were typed.
+--- Use |inputsave()| before input() and |inputrestore()|
+--- after input() to avoid that.  Another solution is to avoid
+--- that further characters follow in the mapping, e.g., by using
+--- |:execute| or |:normal|.
+---
+--- Example with a mapping: >
+---   :nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR>
+---   :function GetFoo()
+---   :  call inputsave()
+---   :  let g:Foo = input("enter search pattern: ")
+---   :  call inputrestore()
+---   :endfunction
+---
+--- <Can also be used as a |method|: >
+---   GetPrompt()->input()
+---
+--- @param opts table
+--- @return any
+function vim.fn.input(opts) end
+
+--- @deprecated
+--- Use |input()| instead.
+function vim.fn.inputdialog(...) end
+
+--- {textlist} must be a |List| of strings.  This |List| is
+--- displayed, one string per line.  The user will be prompted to
+--- enter a number, which is returned.
+--- The user can also select an item by clicking on it with the
+--- mouse, if the mouse is enabled in the command line ('mouse' is
+--- "a" or includes "c").  For the first string 0 is returned.
+--- When clicking above the first item a negative number is
+--- returned.  When clicking on the prompt one more than the
+--- length of {textlist} is returned.
+--- Make sure {textlist} has less than 'lines' entries, otherwise
+--- it won't work.  It's a good idea to put the entry number at
+--- the start of the string.  And put a prompt in the first item.
+--- Example: >
+---   let color = inputlist(['Select color:', '1. red',
+---     \ '2. green', '3. blue'])
+---
+--- <Can also be used as a |method|: >
+---   GetChoices()->inputlist()
+---
+--- @param textlist any
+--- @return any
+function vim.fn.inputlist(textlist) end
+
+--- Restore typeahead that was saved with a previous |inputsave()|.
+--- Should be called the same number of times inputsave() is
+--- called.  Calling it more often is harmless though.
+--- Returns TRUE when there is nothing to restore, FALSE otherwise.
+---
+--- @return any
+function vim.fn.inputrestore() end
+
+--- Preserve typeahead (also from mappings) and clear it, so that
+--- a following prompt gets input from the user.  Should be
+--- followed by a matching inputrestore() after the prompt.  Can
+--- be used several times, in which case there must be just as
+--- many inputrestore() calls.
+--- Returns TRUE when out of memory, FALSE otherwise.
+---
+--- @return any
+function vim.fn.inputsave() end
+
+--- This function acts much like the |input()| function with but
+--- two exceptions:
+--- a) the user's response will be displayed as a sequence of
+--- asterisks ("*") thereby keeping the entry secret, and
+--- b) the user's response will not be recorded on the input
+--- |history| stack.
+--- The result is a String, which is whatever the user actually
+--- typed on the command-line in response to the issued prompt.
+--- NOTE: Command-line completion is not supported.
+---
+--- Can also be used as a |method|: >
+---   GetPrompt()->inputsecret()
+---
+--- @param prompt any
+--- @param text? any
+--- @return any
+function vim.fn.inputsecret(prompt, text) end
+
+--- When {object} is a |List| or a |Blob| insert {item} at the start
+--- of it.
+---
+--- If {idx} is specified insert {item} before the item with index
+--- {idx}.  If {idx} is zero it goes before the first item, just
+--- like omitting {idx}.  A negative {idx} is also possible, see
+--- |list-index|.  -1 inserts just before the last item.
+---
+--- Returns the resulting |List| or |Blob|.  Examples: >
+---   :let mylist = insert([2, 3, 5], 1)
+---   :call insert(mylist, 4, -1)
+---   :call insert(mylist, 6, len(mylist))
+--- <The last example can be done simpler with |add()|.
+--- Note that when {item} is a |List| it is inserted as a single
+--- item.  Use |extend()| to concatenate |Lists|.
+---
+--- Can also be used as a |method|: >
+---   mylist->insert(item)
+---
+--- @param object any
+--- @param item any
+--- @param idx? integer
+--- @return any
+function vim.fn.insert(object, item, idx) end
+
+--- Interrupt script execution.  It works more or less like the
+--- user typing CTRL-C, most commands won't execute and control
+--- returns to the user.  This is useful to abort execution
+--- from lower down, e.g. in an autocommand.  Example: >
+--- :function s:check_typoname(file)
+--- :   if fnamemodify(a:file, ':t') == '['
+--- :       echomsg 'Maybe typo'
+--- :       call interrupt()
+--- :   endif
+--- :endfunction
+--- :au BufWritePre * call s:check_typoname(expand('<amatch>'))
+---
+--- @return any
+function vim.fn.interrupt() end
+
+--- Bitwise invert.  The argument is converted to a number.  A
+--- List, Dict or Float argument causes an error.  Example: >
+---   :let bits = invert(bits)
+--- <Can also be used as a |method|: >
+---   :let bits = bits->invert()
+---
+--- @param expr any
+--- @return any
+function vim.fn.invert(expr) end
+
+--- The result is a Number, which is |TRUE| when a directory
+--- with the name {directory} exists.  If {directory} doesn't
+--- exist, or isn't a directory, the result is |FALSE|.  {directory}
+--- is any expression, which is used as a String.
+---
+--- Can also be used as a |method|: >
+---   GetName()->isdirectory()
+---
+--- @param directory any
+--- @return 0|1
+function vim.fn.isdirectory(directory) end
+
+--- Return 1 if {expr} is a positive infinity, or -1 a negative
+--- infinity, otherwise 0. >
+---   :echo isinf(1.0 / 0.0)
+--- <  1 >
+---   :echo isinf(-1.0 / 0.0)
+--- <  -1
+---
+--- Can also be used as a |method|: >
+---   Compute()->isinf()
+---
+--- @param expr any
+--- @return 1|0|-1
+function vim.fn.isinf(expr) end
+
+--- The result is a Number, which is |TRUE| when {expr} is the
+--- name of a locked variable.
+--- The string argument {expr} must be the name of a variable,
+--- |List| item or |Dictionary| entry, not the variable itself!
+--- Example: >
+---   :let alist = [0, ['a', 'b'], 2, 3]
+---   :lockvar 1 alist
+---   :echo islocked('alist')    " 1
+---   :echo islocked('alist[1]')  " 0
+---
+--- <When {expr} is a variable that does not exist you get an error
+--- message.  Use |exists()| to check for existence.
+---
+--- Can also be used as a |method|: >
+---   GetName()->islocked()
+---
+--- @param expr any
+--- @return 0|1
+function vim.fn.islocked(expr) end
+
+--- Return |TRUE| if {expr} is a float with value NaN. >
+---   echo isnan(0.0 / 0.0)
+--- <  1
+---
+--- Can also be used as a |method|: >
+---   Compute()->isnan()
+---
+--- @param expr any
+--- @return 0|1
+function vim.fn.isnan(expr) end
+
+--- Return a |List| with all the key-value pairs of {dict}.  Each
+--- |List| item is a list with two items: the key of a {dict}
+--- entry and the value of this entry.  The |List| is in arbitrary
+--- order.  Also see |keys()| and |values()|.
+--- Example: >
+---   for [key, value] in items(mydict)
+---      echo key .. ': ' .. value
+---   endfor
+---
+--- <Can also be used as a |method|: >
+---   mydict->items()
+---
+--- @param dict any
+--- @return any
+function vim.fn.items(dict) end
+
+--- @deprecated
+--- Obsolete name for |chanclose()|
+function vim.fn.jobclose(...) end
+
+--- Return the PID (process id) of |job-id| {job}.
+---
+--- @param job any
+--- @return integer
+function vim.fn.jobpid(job) end
+
+--- Resize the pseudo terminal window of |job-id| {job} to {width}
+--- columns and {height} rows.
+--- Fails if the job was not started with `"pty":v:true`.
+---
+--- @param job any
+--- @param width integer
+--- @param height integer
+--- @return any
+function vim.fn.jobresize(job, width, height) end
+
+--- @deprecated
+--- Obsolete name for |chansend()|
+function vim.fn.jobsend(...) end
+
+--- Note: Prefer |vim.system()| in Lua.
+---
+--- Spawns {cmd} as a job.
+--- If {cmd} is a List it runs directly (no 'shell').
+--- If {cmd} is a String it runs in the 'shell', like this: >
+---   :call jobstart(split(&shell) + split(&shellcmdflag) + ['{cmd}'])
+--- <(See |shell-unquoting| for details.)
+---
+--- Example: >
+---   :call jobstart('nvim -h', {'on_stdout':{j,d,e->append(line('.'),d)}})
+--- <
+--- Returns |job-id| on success, 0 on invalid arguments (or job
+--- table is full), -1 if {cmd}[0] or 'shell' is not executable.
+--- The returned job-id is a valid |channel-id| representing the
+--- job's stdio streams. Use |chansend()| (or |rpcnotify()| and
+--- |rpcrequest()| if "rpc" was enabled) to send data to stdin and
+--- |chanclose()| to close the streams without stopping the job.
+---
+--- See |job-control| and |RPC|.
+---
+--- NOTE: on Windows if {cmd} is a List:
+---   - cmd[0] must be an executable (not a "built-in"). If it is
+---     in $PATH it can be called by name, without an extension: >
+---       :call jobstart(['ping', 'neovim.io'])
+--- <    If it is a full or partial path, extension is required: >
+---       :call jobstart(['System32\ping.exe', 'neovim.io'])
+--- <  - {cmd} is collapsed to a string of quoted args as expected
+---     by CommandLineToArgvW https://msdn.microsoft.com/bb776391
+---     unless cmd[0] is some form of "cmd.exe".
+---
+---           *jobstart-env*
+--- The job environment is initialized as follows:
+---   $NVIM                is set to |v:servername| of the parent Nvim
+---   $NVIM_LISTEN_ADDRESS is unset
+---   $NVIM_LOG_FILE       is unset
+---   $VIM                 is unset
+---   $VIMRUNTIME          is unset
+--- You can set these with the `env` option.
+---
+---           *jobstart-options*
+--- {opts} is a dictionary with these keys:
+---   clear_env:  (boolean) `env` defines the job environment
+---         exactly, instead of merging current environment.
+---   cwd:        (string, default=|current-directory|) Working
+---         directory of the job.
+---   detach:     (boolean) Detach the job process: it will not be
+---         killed when Nvim exits. If the process exits
+---         before Nvim, `on_exit` will be invoked.
+---   env:        (dict) Map of environment variable name:value
+---         pairs extending (or replace with "clear_env")
+---         the current environment. |jobstart-env|
+---   height:     (number) Height of the `pty` terminal.
+---   |on_exit|:    (function) Callback invoked when the job exits.
+---   |on_stdout|:  (function) Callback invoked when the job emits
+---         stdout data.
+---   |on_stderr|:  (function) Callback invoked when the job emits
+---         stderr data.
+---   overlapped: (boolean) Sets FILE_FLAG_OVERLAPPED for the
+---         stdio passed to the child process. Only on
+---         MS-Windows; ignored on other platforms.
+---   pty:        (boolean) Connect the job to a new pseudo
+---         terminal, and its streams to the master file
+---         descriptor. `on_stdout` receives all output,
+---         `on_stderr` is ignored. |terminal-start|
+---   rpc:        (boolean) Use |msgpack-rpc| to communicate with
+---         the job over stdio. Then `on_stdout` is ignored,
+---         but `on_stderr` can still be used.
+---   stderr_buffered: (boolean) Collect data until EOF (stream closed)
+---         before invoking `on_stderr`. |channel-buffered|
+---   stdout_buffered: (boolean) Collect data until EOF (stream
+---         closed) before invoking `on_stdout`. |channel-buffered|
+---   stdin:      (string) Either "pipe" (default) to connect the
+---         job's stdin to a channel or "null" to disconnect
+---         stdin.
+---   width:      (number) Width of the `pty` terminal.
+---
+--- {opts} is passed as |self| dictionary to the callback; the
+--- caller may set other keys to pass application-specific data.
+---
+--- Returns:
+---   - |channel-id| on success
+---   - 0 on invalid arguments
+---   - -1 if {cmd}[0] is not executable.
+--- See also |job-control|, |channel|, |msgpack-rpc|.
+---
+--- @param cmd any
+--- @param opts? table
+--- @return any
+function vim.fn.jobstart(cmd, opts) end
+
+--- Stop |job-id| {id} by sending SIGTERM to the job process. If
+--- the process does not terminate after a timeout then SIGKILL
+--- will be sent. When the job terminates its |on_exit| handler
+--- (if any) will be invoked.
+--- See |job-control|.
+---
+--- Returns 1 for valid job id, 0 for invalid id, including jobs have
+--- exited or stopped.
+---
+--- @param id any
+--- @return any
+function vim.fn.jobstop(id) end
+
+--- Waits for jobs and their |on_exit| handlers to complete.
+---
+--- {jobs} is a List of |job-id|s to wait for.
+--- {timeout} is the maximum waiting time in milliseconds. If
+--- omitted or -1, wait forever.
+---
+--- Timeout of 0 can be used to check the status of a job: >
+---   let running = jobwait([{job-id}], 0)[0] == -1
+--- <
+--- During jobwait() callbacks for jobs not in the {jobs} list may
+--- be invoked. The screen will not redraw unless |:redraw| is
+--- invoked by a callback.
+---
+--- Returns a list of len({jobs}) integers, where each integer is
+--- the status of the corresponding job:
+---   Exit-code, if the job exited
+---   -1 if the timeout was exceeded
+---   -2 if the job was interrupted (by |CTRL-C|)
+---   -3 if the job-id is invalid
+---
+--- @param jobs any
+--- @param timeout? integer
+--- @return any
+function vim.fn.jobwait(jobs, timeout) end
+
+--- Join the items in {list} together into one String.
+--- When {sep} is specified it is put in between the items.  If
+--- {sep} is omitted a single space is used.
+--- Note that {sep} is not added at the end.  You might want to
+--- add it there too: >
+---   let lines = join(mylist, "\n") .. "\n"
+--- <String items are used as-is.  |Lists| and |Dictionaries| are
+--- converted into a string like with |string()|.
+--- The opposite function is |split()|.
+---
+--- Can also be used as a |method|: >
+---   mylist->join()
+---
+--- @param list any
+--- @param sep? any
+--- @return any
+function vim.fn.join(list, sep) end
+
+--- Convert {expr} from JSON object.  Accepts |readfile()|-style
+--- list as the input, as well as regular string.  May output any
+--- Vim value. In the following cases it will output
+--- |msgpack-special-dict|:
+--- 1. Dictionary contains duplicate key.
+--- 2. Dictionary contains empty key.
+--- 3. String contains NUL byte.  Two special dictionaries: for
+---    dictionary and for string will be emitted in case string
+---    with NUL byte was a dictionary key.
+---
+--- Note: function treats its input as UTF-8 always.  The JSON
+--- standard allows only a few encodings, of which UTF-8 is
+--- recommended and the only one required to be supported.
+--- Non-UTF-8 characters are an error.
+---
+--- Can also be used as a |method|: >
+---   ReadObject()->json_decode()
+---
+--- @param expr any
+--- @return any
+function vim.fn.json_decode(expr) end
+
+--- Convert {expr} into a JSON string.  Accepts
+--- |msgpack-special-dict| as the input.  Will not convert
+--- |Funcref|s, mappings with non-string keys (can be created as
+--- |msgpack-special-dict|), values with self-referencing
+--- containers, strings which contain non-UTF-8 characters,
+--- pseudo-UTF-8 strings which contain codepoints reserved for
+--- surrogate pairs (such strings are not valid UTF-8 strings).
+--- Non-printable characters are converted into "\u1234" escapes
+--- or special escapes like "\t", other are dumped as-is.
+--- |Blob|s are converted to arrays of the individual bytes.
+---
+--- Can also be used as a |method|: >
+---   GetObject()->json_encode()
+---
+--- @param expr any
+--- @return any
+function vim.fn.json_encode(expr) end
+
+--- Return a |List| with all the keys of {dict}.  The |List| is in
+--- arbitrary order.  Also see |items()| and |values()|.
+---
+--- Can also be used as a |method|: >
+---   mydict->keys()
+---
+--- @param dict any
+--- @return any
+function vim.fn.keys(dict) end
+
+--- Turn the internal byte representation of keys into a form that
+--- can be used for |:map|.  E.g. >
+---   :let xx = "\<C-Home>"
+---   :echo keytrans(xx)
+--- <  <C-Home>
+---
+--- Can also be used as a |method|: >
+---   "\<C-Home>"->keytrans()
+---
+--- <          *len()* *E701*
+--- @param string string
+--- @return any
+function vim.fn.keytrans(string) end
+
+--- @deprecated
+--- Obsolete name for bufnr("$").
+function vim.fn.last_buffer_nr(...) end
+
+--- When {expr} is a String or a Number the length in bytes is
+--- used, as with |strlen()|.
+--- When {expr} is a |List| the number of items in the |List| is
+--- returned.
+--- When {expr} is a |Blob| the number of bytes is returned.
+--- When {expr} is a |Dictionary| the number of entries in the
+--- |Dictionary| is returned.
+--- Otherwise an error is given and returns zero.
+---
+--- Can also be used as a |method|: >
+---   mylist->len()
+---
+--- <        *libcall()* *E364* *E368*
+--- @param expr any
+--- @return any
+function vim.fn.len(expr) end
+
+--- Call function {funcname} in the run-time library {libname}
+--- with single argument {argument}.
+--- This is useful to call functions in a library that you
+--- especially made to be used with Vim.  Since only one argument
+--- is possible, calling standard library functions is rather
+--- limited.
+--- The result is the String returned by the function.  If the
+--- function returns NULL, this will appear as an empty string ""
+--- to Vim.
+--- If the function returns a number, use libcallnr()!
+--- If {argument} is a number, it is passed to the function as an
+--- int; if {argument} is a string, it is passed as a
+--- null-terminated string.
+---
+--- libcall() allows you to write your own 'plug-in' extensions to
+--- Vim without having to recompile the program.  It is NOT a
+--- means to call system functions!  If you try to do so Vim will
+--- very probably crash.
+---
+--- For Win32, the functions you write must be placed in a DLL
+--- and use the normal C calling convention (NOT Pascal which is
+--- used in Windows System DLLs).  The function must take exactly
+--- one parameter, either a character pointer or a long integer,
+--- and must return a character pointer or NULL.  The character
+--- pointer returned must point to memory that will remain valid
+--- after the function has returned (e.g. in static data in the
+--- DLL).  If it points to allocated memory, that memory will
+--- leak away.  Using a static buffer in the function should work,
+--- it's then freed when the DLL is unloaded.
+---
+--- WARNING: If the function returns a non-valid pointer, Vim may
+--- crash!  This also happens if the function returns a number,
+--- because Vim thinks it's a pointer.
+--- For Win32 systems, {libname} should be the filename of the DLL
+--- without the ".DLL" suffix.  A full path is only required if
+--- the DLL is not in the usual places.
+--- For Unix: When compiling your own plugins, remember that the
+--- object code must be compiled as position-independent ('PIC').
+--- Examples: >
+---   :echo libcall("libc.so", "getenv", "HOME")
+---
+--- <Can also be used as a |method|, the base is passed as the
+--- third argument: >
+---   GetValue()->libcall("libc.so", "getenv")
+--- <
+---           *libcallnr()*
+--- @param libname string
+--- @param funcname string
+--- @param argument any
+--- @return any
+function vim.fn.libcall(libname, funcname, argument) end
+
+--- Just like |libcall()|, but used for a function that returns an
+--- int instead of a string.
+--- Examples: >
+---   :echo libcallnr("/usr/lib/libc.so", "getpid", "")
+---   :call libcallnr("libc.so", "printf", "Hello World!\n")
+---   :call libcallnr("libc.so", "sleep", 10)
+--- <
+--- Can also be used as a |method|, the base is passed as the
+--- third argument: >
+---   GetValue()->libcallnr("libc.so", "printf")
+--- <
+--- @param libname string
+--- @param funcname string
+--- @param argument any
+--- @return any
+function vim.fn.libcallnr(libname, funcname, argument) end
+
+--- The result is a Number, which is the line number of the file
+--- position given with {expr}.  The {expr} argument is a string.
+--- The accepted positions are:
+---     .      the cursor position
+---     $      the last line in the current buffer
+---     'x      position of mark x (if the mark is not set, 0 is
+---       returned)
+---     w0      first line visible in current window (one if the
+---       display isn't updated, e.g. in silent Ex mode)
+---     w$      last line visible in current window (this is one
+---       less than "w0" if no lines are visible)
+---     v      In Visual mode: the start of the Visual area (the
+---       cursor is the end).  When not in Visual mode
+---       returns the cursor position.  Differs from |'<| in
+---       that it's updated right away.
+--- Note that a mark in another file can be used.  The line number
+--- then applies to another buffer.
+--- To get the column number use |col()|.  To get both use
+--- |getpos()|.
+--- With the optional {winid} argument the values are obtained for
+--- that window instead of the current window.
+--- Returns 0 for invalid values of {expr} and {winid}.
+--- Examples: >
+---   line(".")    line number of the cursor
+---   line(".", winid)  idem, in window "winid"
+---   line("'t")    line number of mark t
+---   line("'" .. marker)  line number of mark marker
+--- <
+--- To jump to the last known position when opening a file see
+--- |last-position-jump|.
+---
+--- Can also be used as a |method|: >
+---   GetValue()->line()
+---
+--- @param expr any
+--- @param winid? integer
+--- @return integer
+function vim.fn.line(expr, winid) end
+
+--- Return the byte count from the start of the buffer for line
+--- {lnum}.  This includes the end-of-line character, depending on
+--- the 'fileformat' option for the current buffer.  The first
+--- line returns 1. UTF-8 encoding is used, 'fileencoding' is
+--- ignored.  This can also be used to get the byte count for the
+--- line just below the last line: >
+---   line2byte(line("$") + 1)
+--- <This is the buffer size plus one.  If 'fileencoding' is empty
+--- it is the file size plus one.  {lnum} is used like with
+--- |getline()|.  When {lnum} is invalid -1 is returned.
+--- Also see |byte2line()|, |go| and |:goto|.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->line2byte()
+---
+--- @param lnum integer
+--- @return integer
+function vim.fn.line2byte(lnum) end
+
+--- Get the amount of indent for line {lnum} according the lisp
+--- indenting rules, as with 'lisp'.
+--- The indent is counted in spaces, the value of 'tabstop' is
+--- relevant.  {lnum} is used just like in |getline()|.
+--- When {lnum} is invalid, -1 is returned.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->lispindent()
+---
+--- @param lnum integer
+--- @return any
+function vim.fn.lispindent(lnum) end
+
+--- Return a Blob concatenating all the number values in {list}.
+--- Examples: >
+---   list2blob([1, 2, 3, 4])  returns 0z01020304
+---   list2blob([])    returns 0z
+--- <Returns an empty Blob on error.  If one of the numbers is
+--- negative or more than 255 error *E1239* is given.
+---
+--- |blob2list()| does the opposite.
+---
+--- Can also be used as a |method|: >
+---   GetList()->list2blob()
+---
+--- @param list any
+--- @return any
+function vim.fn.list2blob(list) end
+
+--- Convert each number in {list} to a character string can
+--- concatenate them all.  Examples: >
+---   list2str([32])    returns " "
+---   list2str([65, 66, 67])  returns "ABC"
+--- <The same can be done (slowly) with: >
+---   join(map(list, {nr, val -> nr2char(val)}), '')
+--- <|str2list()| does the opposite.
+---
+--- UTF-8 encoding is always used, {utf8} option has no effect,
+--- and exists only for backwards-compatibility.
+--- With UTF-8 composing characters work as expected: >
+---   list2str([97, 769])  returns "á"
+--- <
+--- Returns an empty string on error.
+---
+--- Can also be used as a |method|: >
+---   GetList()->list2str()
+---
+--- @param list any
+--- @param utf8? any
+--- @return any
+function vim.fn.list2str(list, utf8) end
+
+--- Return the current time, measured as seconds since 1st Jan
+--- 1970.  See also |strftime()|, |strptime()| and |getftime()|.
+---
+---
+--- @return any
+function vim.fn.localtime() end
+
+--- Return the natural logarithm (base e) of {expr} as a |Float|.
+--- {expr} must evaluate to a |Float| or a |Number| in the range
+--- (0, inf].
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo log(10)
+--- <  2.302585 >
+---   :echo log(exp(5))
+--- <  5.0
+---
+--- Can also be used as a |method|: >
+---   Compute()->log()
+---
+--- @param expr any
+--- @return any
+function vim.fn.log(expr) end
+
+--- Return the logarithm of Float {expr} to base 10 as a |Float|.
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo log10(1000)
+--- <  3.0 >
+---   :echo log10(0.01)
+--- <  -2.0
+---
+--- Can also be used as a |method|: >
+---   Compute()->log10()
+---
+--- @param expr any
+--- @return any
+function vim.fn.log10(expr) end
+
+--- Evaluate Lua expression {expr} and return its result converted
+--- to Vim data structures. See |lua-eval| for more details.
+---
+--- Can also be used as a |method|: >
+---   GetExpr()->luaeval()
+---
+--- @param expr any
+--- @param expr1? any
+--- @return any
+function vim.fn.luaeval(expr, expr1) end
+
+--- {expr1} must be a |List|, |Blob| or |Dictionary|.
+--- Replace each item in {expr1} with the result of evaluating
+--- {expr2}.  For a |Blob| each byte is replaced.
+---
+--- {expr2} must be a |string| or |Funcref|.
+---
+--- If {expr2} is a |string|, inside {expr2} |v:val| has the value
+--- of the current item.  For a |Dictionary| |v:key| has the key
+--- of the current item and for a |List| |v:key| has the index of
+--- the current item.  For a |Blob| |v:key| has the index of the
+--- current byte.
+--- Example: >
+---   :call map(mylist, '"> " .. v:val .. " <"')
+--- <This puts "> " before and " <" after each item in "mylist".
+---
+--- Note that {expr2} is the result of an expression and is then
+--- used as an expression again.  Often it is good to use a
+--- |literal-string| to avoid having to double backslashes.  You
+--- still have to double ' quotes
+---
+--- If {expr2} is a |Funcref| it is called with two arguments:
+---   1. The key or the index of the current item.
+---   2. the value of the current item.
+--- The function must return the new value of the item. Example
+--- that changes each value by "key-value": >
+---   func KeyValue(key, val)
+---     return a:key .. '-' .. a:val
+---   endfunc
+---   call map(myDict, function('KeyValue'))
+--- <It is shorter when using a |lambda|: >
+---   call map(myDict, {key, val -> key .. '-' .. val})
+--- <If you do not use "val" you can leave it out: >
+---   call map(myDict, {key -> 'item: ' .. key})
+--- <If you do not use "key" you can use a short name: >
+---   call map(myDict, {_, val -> 'item: ' .. val})
+--- <
+--- The operation is done in-place.  If you want a |List| or
+--- |Dictionary| to remain unmodified make a copy first: >
+---   :let tlist = map(copy(mylist), ' v:val .. "\t"')
+---
+--- <Returns {expr1}, the |List|, |Blob| or |Dictionary| that was
+--- filtered.  When an error is encountered while evaluating
+--- {expr2} no further items in {expr1} are processed.  When
+--- {expr2} is a Funcref errors inside a function are ignored,
+--- unless it was defined with the "abort" flag.
+---
+--- Can also be used as a |method|: >
+---   mylist->map(expr2)
+---
+---
+--- @param expr1 any
+--- @param expr2 any
+--- @return any
+function vim.fn.map(expr1, expr2) end
+
+--- When {dict} is omitted or zero: Return the rhs of mapping
+--- {name} in mode {mode}.  The returned String has special
+--- characters translated like in the output of the ":map" command
+--- listing.
+---
+--- When there is no mapping for {name}, an empty String is
+--- returned if {dict} is FALSE, otherwise returns an empty Dict.
+--- When the mapping for {name} is empty, then "<Nop>" is
+--- returned.
+---
+--- The {name} can have special key names, like in the ":map"
+--- command.
+---
+--- {mode} can be one of these strings:
+---   "n"  Normal
+---   "v"  Visual (including Select)
+---   "o"  Operator-pending
+---   "i"  Insert
+---   "c"  Cmd-line
+---   "s"  Select
+---   "x"  Visual
+---   "l"  langmap |language-mapping|
+---   "t"  Terminal
+---   ""  Normal, Visual and Operator-pending
+--- When {mode} is omitted, the modes for "" are used.
+---
+--- When {abbr} is there and it is |TRUE| use abbreviations
+--- instead of mappings.
+---
+--- When {dict} is there and it is |TRUE| return a dictionary
+--- containing all the information of the mapping with the
+--- following items:
+---   "lhs"       The {lhs} of the mapping as it would be typed
+---   "lhsraw"   The {lhs} of the mapping as raw bytes
+---   "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate
+---         form, only present when it differs from "lhsraw"
+---   "rhs"       The {rhs} of the mapping as typed.
+---   "silent"   1 for a |:map-silent| mapping, else 0.
+---   "noremap"  1 if the {rhs} of the mapping is not remappable.
+---   "script"   1 if mapping was defined with <script>.
+---   "expr"     1 for an expression mapping (|:map-<expr>|).
+---   "buffer"   1 for a buffer local mapping (|:map-local|).
+---   "mode"     Modes for which the mapping is defined. In
+---        addition to the modes mentioned above, these
+---        characters will be used:
+---        " "     Normal, Visual and Operator-pending
+---        "!"     Insert and Commandline mode
+---          (|mapmode-ic|)
+---   "sid"       The script local ID, used for <sid> mappings
+---        (|<SID>|).  Negative for special contexts.
+---   "lnum"     The line number in "sid", zero if unknown.
+---   "nowait"   Do not wait for other, longer mappings.
+---        (|:map-<nowait>|).
+---
+--- The dictionary can be used to restore a mapping with
+--- |mapset()|.
+---
+--- The mappings local to the current buffer are checked first,
+--- then the global mappings.
+--- This function can be used to map a key even when it's already
+--- mapped, and have it do the original mapping too.  Sketch: >
+---   exe 'nnoremap <Tab> ==' .. maparg('<Tab>', 'n')
+---
+--- <Can also be used as a |method|: >
+---   GetKey()->maparg('n')
+---
+--- @param name string
+--- @param mode? string
+--- @param abbr? any
+--- @param dict? any
+--- @return any
+function vim.fn.maparg(name, mode, abbr, dict) end
+
+--- Check if there is a mapping that matches with {name} in mode
+--- {mode}.  See |maparg()| for {mode} and special names in
+--- {name}.
+--- When {abbr} is there and it is non-zero use abbreviations
+--- instead of mappings.
+--- A match happens with a mapping that starts with {name} and
+--- with a mapping which is equal to the start of {name}.
+---
+---   matches mapping "a"  "ab"  "abc" ~
+---    mapcheck("a")  yes  yes   yes
+---    mapcheck("abc")  yes  yes   yes
+---    mapcheck("ax")  yes  no   no
+---    mapcheck("b")  no  no   no
+---
+--- The difference with maparg() is that mapcheck() finds a
+--- mapping that matches with {name}, while maparg() only finds a
+--- mapping for {name} exactly.
+--- When there is no mapping that starts with {name}, an empty
+--- String is returned.  If there is one, the RHS of that mapping
+--- is returned.  If there are several mappings that start with
+--- {name}, the RHS of one of them is returned.  This will be
+--- "<Nop>" if the RHS is empty.
+--- The mappings local to the current buffer are checked first,
+--- then the global mappings.
+--- This function can be used to check if a mapping can be added
+--- without being ambiguous.  Example: >
+---   :if mapcheck("_vv") == ""
+---   :   map _vv :set guifont=7x13<CR>
+---   :endif
+--- <This avoids adding the "_vv" mapping when there already is a
+--- mapping for "_v" or for "_vvv".
+---
+--- Can also be used as a |method|: >
+---   GetKey()->mapcheck('n')
+---
+--- @param name string
+--- @param mode? string
+--- @param abbr? any
+--- @return any
+function vim.fn.mapcheck(name, mode, abbr) end
+
+--- Restore a mapping from a dictionary returned by |maparg()|.
+--- {mode} and {abbr} should be the same as for the call to
+--- |maparg()|. *E460*
+--- {mode} is used to define the mode in which the mapping is set,
+--- not the "mode" entry in {dict}.
+--- Example for saving and restoring a mapping: >
+---   let save_map = maparg('K', 'n', 0, 1)
+---   nnoremap K somethingelse
+---   ...
+---   call mapset('n', 0, save_map)
+--- <Note that if you are going to replace a map in several modes,
+--- e.g. with `:map!`, you need to save the mapping for all of
+--- them, since they can differ.
+---
+---
+--- @param mode string
+--- @param abbr any
+--- @param dict any
+--- @return any
+function vim.fn.mapset(mode, abbr, dict) end
+
+--- When {expr} is a |List| then this returns the index of the
+--- first item where {pat} matches.  Each item is used as a
+--- String, |Lists| and |Dictionaries| are used as echoed.
+---
+--- Otherwise, {expr} is used as a String.  The result is a
+--- Number, which gives the index (byte offset) in {expr} where
+--- {pat} matches.
+---
+--- A match at the first character or |List| item returns zero.
+--- If there is no match -1 is returned.
+---
+--- For getting submatches see |matchlist()|.
+--- Example: >
+---   :echo match("testing", "ing")  " results in 4
+---   :echo match([1, 'x'], '\a')  " results in 1
+--- <See |string-match| for how {pat} is used.
+---             *strpbrk()*
+--- Vim doesn't have a strpbrk() function.  But you can do: >
+---   :let sepidx = match(line, '[.,;: \t]')
+--- <            *strcasestr()*
+--- Vim doesn't have a strcasestr() function.  But you can add
+--- "\c" to the pattern to ignore case: >
+---   :let idx = match(haystack, '\cneedle')
+--- <
+--- If {start} is given, the search starts from byte index
+--- {start} in a String or item {start} in a |List|.
+--- The result, however, is still the index counted from the
+--- first character/item.  Example: >
+---   :echo match("testing", "ing", 2)
+--- <result is again "4". >
+---   :echo match("testing", "ing", 4)
+--- <result is again "4". >
+---   :echo match("testing", "t", 2)
+--- <result is "3".
+--- For a String, if {start} > 0 then it is like the string starts
+--- {start} bytes later, thus "^" will match at {start}.  Except
+--- when {count} is given, then it's like matches before the
+--- {start} byte are ignored (this is a bit complicated to keep it
+--- backwards compatible).
+--- For a String, if {start} < 0, it will be set to 0.  For a list
+--- the index is counted from the end.
+--- If {start} is out of range ({start} > strlen({expr}) for a
+--- String or {start} > len({expr}) for a |List|) -1 is returned.
+---
+--- When {count} is given use the {count}th match.  When a match
+--- is found in a String the search for the next one starts one
+--- character further.  Thus this example results in 1: >
+---   echo match("testing", "..", 0, 2)
+--- <In a |List| the search continues in the next item.
+--- Note that when {count} is added the way {start} works changes,
+--- see above.
+---
+--- See |pattern| for the patterns that are accepted.
+--- The 'ignorecase' option is used to set the ignore-caseness of
+--- the pattern.  'smartcase' is NOT used.  The matching is always
+--- done like 'magic' is set and 'cpoptions' is empty.
+--- Note that a match at the start is preferred, thus when the
+--- pattern is using "*" (any number of matches) it tends to find
+--- zero matches at the start instead of a number of matches
+--- further down in the text.
+---
+--- Can also be used as a |method|: >
+---   GetText()->match('word')
+---   GetList()->match('word')
+--- <
+---   *matchadd()* *E798* *E799* *E801* *E957*
+--- @param expr any
+--- @param pat any
+--- @param start? any
+--- @param count? any
+--- @return any
+function vim.fn.match(expr, pat, start, count) end
+
+--- Defines a pattern to be highlighted in the current window (a
+--- "match").  It will be highlighted with {group}.  Returns an
+--- identification number (ID), which can be used to delete the
+--- match using |matchdelete()|.  The ID is bound to the window.
+--- Matching is case sensitive and magic, unless case sensitivity
+--- or magicness are explicitly overridden in {pattern}.  The
+--- 'magic', 'smartcase' and 'ignorecase' options are not used.
+--- The "Conceal" value is special, it causes the match to be
+--- concealed.
+---
+--- The optional {priority} argument assigns a priority to the
+--- match.  A match with a high priority will have its
+--- highlighting overrule that of a match with a lower priority.
+--- A priority is specified as an integer (negative numbers are no
+--- exception).  If the {priority} argument is not specified, the
+--- default priority is 10.  The priority of 'hlsearch' is zero,
+--- hence all matches with a priority greater than zero will
+--- overrule it.  Syntax highlighting (see 'syntax') is a separate
+--- mechanism, and regardless of the chosen priority a match will
+--- always overrule syntax highlighting.
+---
+--- The optional {id} argument allows the request for a specific
+--- match ID.  If a specified ID is already taken, an error
+--- message will appear and the match will not be added.  An ID
+--- is specified as a positive integer (zero excluded).  IDs 1, 2
+--- and 3 are reserved for |:match|, |:2match| and |:3match|,
+--- respectively.  3 is reserved for use by the |matchparen|
+--- plugin.
+--- If the {id} argument is not specified or -1, |matchadd()|
+--- automatically chooses a free ID, which is at least 1000.
+---
+--- The optional {dict} argument allows for further custom
+--- values. Currently this is used to specify a match specific
+--- conceal character that will be shown for |hl-Conceal|
+--- highlighted matches. The dict can have the following members:
+---
+---   conceal      Special character to show instead of the
+---         match (only for |hl-Conceal| highlighted
+---         matches, see |:syn-cchar|)
+---   window      Instead of the current window use the
+---         window with this number or window ID.
+---
+--- The number of matches is not limited, as it is the case with
+--- the |:match| commands.
+---
+--- Returns -1 on error.
+---
+--- Example: >
+---   :highlight MyGroup ctermbg=green guibg=green
+---   :let m = matchadd("MyGroup", "TODO")
+--- <Deletion of the pattern: >
+---   :call matchdelete(m)
+---
+--- <A list of matches defined by |matchadd()| and |:match| are
+--- available from |getmatches()|.  All matches can be deleted in
+--- one operation by |clearmatches()|.
+---
+--- Can also be used as a |method|: >
+---   GetGroup()->matchadd('TODO')
+--- <
+---           *matchaddpos()*
+--- @param group any
+--- @param pattern any
+--- @param priority? any
+--- @param id? any
+--- @param dict? any
+--- @return any
+function vim.fn.matchadd(group, pattern, priority, id, dict) end
+
+--- Same as |matchadd()|, but requires a list of positions {pos}
+--- instead of a pattern. This command is faster than |matchadd()|
+--- because it does not require to handle regular expressions and
+--- sets buffer line boundaries to redraw screen. It is supposed
+--- to be used when fast match additions and deletions are
+--- required, for example to highlight matching parentheses.
+---           *E5030* *E5031*
+--- {pos} is a list of positions.  Each position can be one of
+--- these:
+--- - A number.  This whole line will be highlighted.  The first
+---   line has number 1.
+--- - A list with one number, e.g., [23]. The whole line with this
+---   number will be highlighted.
+--- - A list with two numbers, e.g., [23, 11]. The first number is
+---   the line number, the second one is the column number (first
+---   column is 1, the value must correspond to the byte index as
+---   |col()| would return).  The character at this position will
+---   be highlighted.
+--- - A list with three numbers, e.g., [23, 11, 3]. As above, but
+---   the third number gives the length of the highlight in bytes.
+---
+--- Entries with zero and negative line numbers are silently
+--- ignored, as well as entries with negative column numbers and
+--- lengths.
+---
+--- Returns -1 on error.
+---
+--- Example: >
+---   :highlight MyGroup ctermbg=green guibg=green
+---   :let m = matchaddpos("MyGroup", [[23, 24], 34])
+--- <Deletion of the pattern: >
+---   :call matchdelete(m)
+---
+--- <Matches added by |matchaddpos()| are returned by
+--- |getmatches()|.
+---
+--- Can also be used as a |method|: >
+---   GetGroup()->matchaddpos([23, 11])
+---
+--- @param group any
+--- @param pos any
+--- @param priority? any
+--- @param id? any
+--- @param dict? any
+--- @return any
+function vim.fn.matchaddpos(group, pos, priority, id, dict) end
+
+--- Selects the {nr} match item, as set with a |:match|,
+--- |:2match| or |:3match| command.
+--- Return a |List| with two elements:
+---   The name of the highlight group used
+---   The pattern used.
+--- When {nr} is not 1, 2 or 3 returns an empty |List|.
+--- When there is no match item set returns ['', ''].
+--- This is useful to save and restore a |:match|.
+--- Highlighting matches using the |:match| commands are limited
+--- to three matches. |matchadd()| does not have this limitation.
+---
+--- Can also be used as a |method|: >
+---   GetMatch()->matcharg()
+---
+--- @param nr integer
+--- @return any
+function vim.fn.matcharg(nr) end
+
+--- Deletes a match with ID {id} previously defined by |matchadd()|
+--- or one of the |:match| commands.  Returns 0 if successful,
+--- otherwise -1.  See example for |matchadd()|.  All matches can
+--- be deleted in one operation by |clearmatches()|.
+--- If {win} is specified, use the window with this number or
+--- window ID instead of the current window.
+---
+--- Can also be used as a |method|: >
+---   GetMatch()->matchdelete()
+---
+--- @param id any
+--- @param win? any
+--- @return any
+function vim.fn.matchdelete(id, win) end
+
+--- Same as |match()|, but return the index of first character
+--- after the match.  Example: >
+---   :echo matchend("testing", "ing")
+--- <results in "7".
+---           *strspn()* *strcspn()*
+--- Vim doesn't have a strspn() or strcspn() function, but you can
+--- do it with matchend(): >
+---   :let span = matchend(line, '[a-zA-Z]')
+---   :let span = matchend(line, '[^a-zA-Z]')
+--- <Except that -1 is returned when there are no matches.
+---
+--- The {start}, if given, has the same meaning as for |match()|. >
+---   :echo matchend("testing", "ing", 2)
+--- <results in "7". >
+---   :echo matchend("testing", "ing", 5)
+--- <result is "-1".
+--- When {expr} is a |List| the result is equal to |match()|.
+---
+--- Can also be used as a |method|: >
+---   GetText()->matchend('word')
+---
+--- @param expr any
+--- @param pat any
+--- @param start? any
+--- @param count? any
+--- @return any
+function vim.fn.matchend(expr, pat, start, count) end
+
+--- If {list} is a list of strings, then returns a |List| with all
+--- the strings in {list} that fuzzy match {str}. The strings in
+--- the returned list are sorted based on the matching score.
+---
+--- The optional {dict} argument always supports the following
+--- items:
+---     matchseq  When this item is present return only matches
+---     that contain the characters in {str} in the
+---     given sequence.
+---     limit  Maximum number of matches in {list} to be
+---     returned.  Zero means no limit.
+---
+--- If {list} is a list of dictionaries, then the optional {dict}
+--- argument supports the following additional items:
+---     key    Key of the item which is fuzzy matched against
+---     {str}. The value of this item should be a
+---     string.
+---     text_cb  |Funcref| that will be called for every item
+---     in {list} to get the text for fuzzy matching.
+---     This should accept a dictionary item as the
+---     argument and return the text for that item to
+---     use for fuzzy matching.
+---
+--- {str} is treated as a literal string and regular expression
+--- matching is NOT supported.  The maximum supported {str} length
+--- is 256.
+---
+--- When {str} has multiple words each separated by white space,
+--- then the list of strings that have all the words is returned.
+---
+--- If there are no matching strings or there is an error, then an
+--- empty list is returned. If length of {str} is greater than
+--- 256, then returns an empty list.
+---
+--- When {limit} is given, matchfuzzy() will find up to this
+--- number of matches in {list} and return them in sorted order.
+---
+--- Refer to |fuzzy-matching| for more information about fuzzy
+--- matching strings.
+---
+--- Example: >
+---    :echo matchfuzzy(["clay", "crow"], "cay")
+--- <results in ["clay"]. >
+---    :echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl")
+--- <results in a list of buffer names fuzzy matching "ndl". >
+---    :echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'})
+--- <results in a list of buffer information dicts with buffer
+--- names fuzzy matching "ndl". >
+---    :echo getbufinfo()->matchfuzzy("spl",
+---         \ {'text_cb' : {v -> v.name}})
+--- <results in a list of buffer information dicts with buffer
+--- names fuzzy matching "spl". >
+---    :echo v:oldfiles->matchfuzzy("test")
+--- <results in a list of file names fuzzy matching "test". >
+---    :let l = readfile("buffer.c")->matchfuzzy("str")
+--- <results in a list of lines in "buffer.c" fuzzy matching "str". >
+---    :echo ['one two', 'two one']->matchfuzzy('two one')
+--- <results in `['two one', 'one two']` . >
+---    :echo ['one two', 'two one']->matchfuzzy('two one',
+---         \ {'matchseq': 1})
+--- <results in `['two one']`.
+---
+--- @param list any
+--- @param str any
+--- @param dict? any
+--- @return any
+function vim.fn.matchfuzzy(list, str, dict) end
+
+--- Same as |matchfuzzy()|, but returns the list of matched
+--- strings, the list of character positions where characters
+--- in {str} matches and a list of matching scores.  You can
+--- use |byteidx()| to convert a character position to a byte
+--- position.
+---
+--- If {str} matches multiple times in a string, then only the
+--- positions for the best match is returned.
+---
+--- If there are no matching strings or there is an error, then a
+--- list with three empty list items is returned.
+---
+--- Example: >
+---   :echo matchfuzzypos(['testing'], 'tsg')
+--- <results in [["testing"], [[0, 2, 6]], [99]] >
+---   :echo matchfuzzypos(['clay', 'lacy'], 'la')
+--- <results in [["lacy", "clay"], [[0, 1], [1, 2]], [153, 133]] >
+---   :echo [{'text': 'hello', 'id' : 10}]
+---     \ ->matchfuzzypos('ll', {'key' : 'text'})
+--- <results in `[[{"id": 10, "text": "hello"}], [[2, 3]], [127]]`
+---
+--- @param list any
+--- @param str any
+--- @param dict? any
+--- @return any
+function vim.fn.matchfuzzypos(list, str, dict) end
+
+--- Same as |match()|, but return a |List|.  The first item in the
+--- list is the matched string, same as what matchstr() would
+--- return.  Following items are submatches, like "\1", "\2", etc.
+--- in |:substitute|.  When an optional submatch didn't match an
+--- empty string is used.  Example: >
+---   echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
+--- <Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
+--- When there is no match an empty list is returned.
+---
+--- You can pass in a List, but that is not very useful.
+---
+--- Can also be used as a |method|: >
+---   GetText()->matchlist('word')
+---
+--- @param expr any
+--- @param pat any
+--- @param start? any
+--- @param count? any
+--- @return any
+function vim.fn.matchlist(expr, pat, start, count) end
+
+--- Same as |match()|, but return the matched string.  Example: >
+---   :echo matchstr("testing", "ing")
+--- <results in "ing".
+--- When there is no match "" is returned.
+--- The {start}, if given, has the same meaning as for |match()|. >
+---   :echo matchstr("testing", "ing", 2)
+--- <results in "ing". >
+---   :echo matchstr("testing", "ing", 5)
+--- <result is "".
+--- When {expr} is a |List| then the matching item is returned.
+--- The type isn't changed, it's not necessarily a String.
+---
+--- Can also be used as a |method|: >
+---   GetText()->matchstr('word')
+---
+--- @param expr any
+--- @param pat any
+--- @param start? any
+--- @param count? any
+--- @return any
+function vim.fn.matchstr(expr, pat, start, count) end
+
+--- Same as |matchstr()|, but return the matched string, the start
+--- position and the end position of the match.  Example: >
+---   :echo matchstrpos("testing", "ing")
+--- <results in ["ing", 4, 7].
+--- When there is no match ["", -1, -1] is returned.
+--- The {start}, if given, has the same meaning as for |match()|. >
+---   :echo matchstrpos("testing", "ing", 2)
+--- <results in ["ing", 4, 7]. >
+---   :echo matchstrpos("testing", "ing", 5)
+--- <result is ["", -1, -1].
+--- When {expr} is a |List| then the matching item, the index
+--- of first item where {pat} matches, the start position and the
+--- end position of the match are returned. >
+---   :echo matchstrpos([1, '__x'], '\a')
+--- <result is ["x", 1, 2, 3].
+--- The type isn't changed, it's not necessarily a String.
+---
+--- Can also be used as a |method|: >
+---   GetText()->matchstrpos('word')
+--- <
+---
+---           *max()*
+--- @param expr any
+--- @param pat any
+--- @param start? any
+--- @param count? any
+--- @return any
+function vim.fn.matchstrpos(expr, pat, start, count) end
+
+---   echo max([apples, pears, oranges])
+---
+--- <{expr} can be a |List| or a |Dictionary|.  For a Dictionary,
+--- it returns the maximum of all values in the Dictionary.
+--- If {expr} is neither a List nor a Dictionary, or one of the
+--- items in {expr} cannot be used as a Number this results in
+---                 an error.  An empty |List| or |Dictionary| results in zero.
+---
+--- Can also be used as a |method|: >
+---   mylist->max()
+---
+---
+--- @param expr any
+--- @return any
+function vim.fn.max(expr) end
+
+--- Returns a |List| of |Dictionaries| describing |menus| (defined
+--- by |:menu|, |:amenu|, …), including |hidden-menus|.
+---
+--- {path} matches a menu by name, or all menus if {path} is an
+--- empty string.  Example: >
+---   :echo menu_get('File','')
+---   :echo menu_get('')
+--- <
+--- {modes} is a string of zero or more modes (see |maparg()| or
+--- |creating-menus| for the list of modes). "a" means "all".
+---
+--- Example: >
+---   nnoremenu &Test.Test inormal
+---   inoremenu Test.Test insert
+---   vnoremenu Test.Test x
+---   echo menu_get("")
+---
+--- <returns something like this: >
+---
+---   [ {
+---     "hidden": 0,
+---     "name": "Test",
+---     "priority": 500,
+---     "shortcut": 84,
+---     "submenus": [ {
+---       "hidden": 0,
+---       "mappings": {
+---         i": {
+---     "enabled": 1,
+---     "noremap": 1,
+---     "rhs": "insert",
+---     "sid": 1,
+---     "silent": 0
+---         },
+---         n": { ... },
+---         s": { ... },
+---         v": { ... }
+---       },
+---       "name": "Test",
+---       "priority": 500,
+---       "shortcut": 0
+---     } ]
+---   } ]
+--- <
+---
+--- @param path string
+--- @param modes? any
+--- @return any
+function vim.fn.menu_get(path, modes) end
+
+--- Return information about the specified menu {name} in
+--- mode {mode}. The menu name should be specified without the
+--- shortcut character ('&'). If {name} is "", then the top-level
+--- menu names are returned.
+---
+--- {mode} can be one of these strings:
+---   "n"  Normal
+---   "v"  Visual (including Select)
+---   "o"  Operator-pending
+---   "i"  Insert
+---   "c"  Cmd-line
+---   "s"  Select
+---   "x"  Visual
+---   "t"  Terminal-Job
+---   ""  Normal, Visual and Operator-pending
+---   "!"  Insert and Cmd-line
+--- When {mode} is omitted, the modes for "" are used.
+---
+--- Returns a |Dictionary| containing the following items:
+---   accel    menu item accelerator text |menu-text|
+---   display  display name (name without '&')
+---   enabled  v:true if this menu item is enabled
+---     Refer to |:menu-enable|
+---   icon    name of the icon file (for toolbar)
+---     |toolbar-icon|
+---   iconidx  index of a built-in icon
+---   modes    modes for which the menu is defined. In
+---     addition to the modes mentioned above, these
+---     characters will be used:
+---     " "  Normal, Visual and Operator-pending
+---   name    menu item name.
+---   noremenu  v:true if the {rhs} of the menu item is not
+---     remappable else v:false.
+---   priority  menu order priority |menu-priority|
+---   rhs    right-hand-side of the menu item. The returned
+---     string has special characters translated like
+---     in the output of the ":menu" command listing.
+---     When the {rhs} of a menu item is empty, then
+---     "<Nop>" is returned.
+---   script  v:true if script-local remapping of {rhs} is
+---     allowed else v:false.  See |:menu-script|.
+---   shortcut  shortcut key (character after '&' in
+---     the menu name) |menu-shortcut|
+---   silent  v:true if the menu item is created
+---     with <silent> argument |:menu-silent|
+---   submenus  |List| containing the names of
+---     all the submenus.  Present only if the menu
+---     item has submenus.
+---
+--- Returns an empty dictionary if the menu item is not found.
+---
+--- Examples: >
+---   :echo menu_info('Edit.Cut')
+---   :echo menu_info('File.Save', 'n')
+---
+---   " Display the entire menu hierarchy in a buffer
+---   func ShowMenu(name, pfx)
+---     let m = menu_info(a:name)
+---     call append(line('$'), a:pfx .. m.display)
+---     for child in m->get('submenus', [])
+---       call ShowMenu(a:name .. '.' .. escape(child, '.'),
+---           \ a:pfx .. '    ')
+---     endfor
+---   endfunc
+---   new
+---   for topmenu in menu_info('').submenus
+---     call ShowMenu(topmenu, '')
+---   endfor
+--- <
+--- Can also be used as a |method|: >
+---   GetMenuName()->menu_info('v')
+---
+---
+--- <          *min()*
+--- @param name string
+--- @param mode? string
+--- @return any
+function vim.fn.menu_info(name, mode) end
+
+---   echo min([apples, pears, oranges])
+---
+--- <{expr} can be a |List| or a |Dictionary|.  For a Dictionary,
+--- it returns the minimum of all values in the Dictionary.
+--- If {expr} is neither a List nor a Dictionary, or one of the
+--- items in {expr} cannot be used as a Number this results in
+--- an error.  An empty |List| or |Dictionary| results in zero.
+---
+--- Can also be used as a |method|: >
+---   mylist->min()
+---
+--- <          *mkdir()* *E739*
+--- @param expr any
+--- @return any
+function vim.fn.min(expr) end
+
+--- Create directory {name}.
+---
+--- When {flags} is present it must be a string.  An empty string
+--- has no effect.
+---
+--- If {flags} contains "p" then intermediate directories are
+--- created as necessary.
+---
+--- If {flags} contains "D" then {name} is deleted at the end of
+--- the current function, as with: >
+---   defer delete({name}, 'd')
+--- <
+--- If {flags} contains "R" then {name} is deleted recursively at
+--- the end of the current function, as with: >
+---   defer delete({name}, 'rf')
+--- <Note that when {name} has more than one part and "p" is used
+--- some directories may already exist.  Only the first one that
+--- is created and what it contains is scheduled to be deleted.
+--- E.g. when using: >
+---   call mkdir('subdir/tmp/autoload', 'pR')
+--- <and "subdir" already exists then "subdir/tmp" will be
+--- scheduled for deletion, like with: >
+---   defer delete('subdir/tmp', 'rf')
+--- <
+--- If {prot} is given it is used to set the protection bits of
+--- the new directory.  The default is 0o755 (rwxr-xr-x: r/w for
+--- the user, readable for others).  Use 0o700 to make it
+--- unreadable for others.
+---
+--- {prot} is applied for all parts of {name}.  Thus if you create
+--- /tmp/foo/bar then /tmp/foo will be created with 0o700. Example: >
+---   :call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700)
+---
+--- <This function is not available in the |sandbox|.
+---
+--- If you try to create an existing directory with {flags} set to
+--- "p" mkdir() will silently exit.
+---
+--- The function result is a Number, which is TRUE if the call was
+--- successful or FALSE if the directory creation failed or partly
+--- failed.
+---
+--- Can also be used as a |method|: >
+---   GetName()->mkdir()
+--- <
+---           *mode()*
+--- @param name string
+--- @param flags? string
+--- @param prot? any
+--- @return any
+function vim.fn.mkdir(name, flags, prot) end
+
+--- If [expr] is supplied and it evaluates to a non-zero Number or
+--- a non-empty String (|non-zero-arg|), then the full mode is
+--- returned, otherwise only the first letter is returned.
+---
+---    n      Normal
+---    no      Operator-pending
+---    nov      Operator-pending (forced charwise |o_v|)
+---    noV      Operator-pending (forced linewise |o_V|)
+---    noCTRL-V Operator-pending (forced blockwise |o_CTRL-V|)
+---     CTRL-V is one character
+---    niI      Normal using |i_CTRL-O| in |Insert-mode|
+---    niR      Normal using |i_CTRL-O| in |Replace-mode|
+---    niV      Normal using |i_CTRL-O| in |Virtual-Replace-mode|
+---    nt      Normal in |terminal-emulator| (insert goes to
+---     Terminal mode)
+---    ntT      Normal using |t_CTRL-\_CTRL-O| in |Terminal-mode|
+---    v      Visual by character
+---    vs      Visual by character using |v_CTRL-O| in Select mode
+---    V      Visual by line
+---    Vs      Visual by line using |v_CTRL-O| in Select mode
+---    CTRL-V   Visual blockwise
+---    CTRL-Vs  Visual blockwise using |v_CTRL-O| in Select mode
+---    s      Select by character
+---    S      Select by line
+---    CTRL-S   Select blockwise
+---    i      Insert
+---    ic      Insert mode completion |compl-generic|
+---    ix      Insert mode |i_CTRL-X| completion
+---    R      Replace |R|
+---    Rc      Replace mode completion |compl-generic|
+---    Rx      Replace mode |i_CTRL-X| completion
+---    Rv      Virtual Replace |gR|
+---    Rvc      Virtual Replace mode completion |compl-generic|
+---    Rvx      Virtual Replace mode |i_CTRL-X| completion
+---    c      Command-line editing
+---    cv      Vim Ex mode |gQ|
+---    r      Hit-enter prompt
+---    rm      The -- more -- prompt
+---    r?      A |:confirm| query of some sort
+---    !      Shell or external command is executing
+---    t      Terminal mode: keys go to the job
+---
+--- This is useful in the 'statusline' option or RPC calls. In
+--- most other places it always returns "c" or "n".
+--- Note that in the future more modes and more specific modes may
+--- be added. It's better not to compare the whole string but only
+--- the leading character(s).
+--- Also see |visualmode()|.
+---
+--- Can also be used as a |method|: >
+---   DoFull()->mode()
+---
+--- @return any
+function vim.fn.mode() end
+
+--- Convert a list of Vimscript objects to msgpack. Returned value is a
+--- |readfile()|-style list. When {type} contains "B", a |Blob| is
+--- returned instead. Example: >
+---   call writefile(msgpackdump([{}]), 'fname.mpack', 'b')
+--- <or, using a |Blob|: >
+---   call writefile(msgpackdump([{}], 'B'), 'fname.mpack')
+--- <
+--- This will write the single 0x80 byte to a `fname.mpack` file
+--- (dictionary with zero items is represented by 0x80 byte in
+--- messagepack).
+---
+--- Limitations:        *E5004* *E5005*
+--- 1. |Funcref|s cannot be dumped.
+--- 2. Containers that reference themselves cannot be dumped.
+--- 3. Dictionary keys are always dumped as STR strings.
+--- 4. Other strings and |Blob|s are always dumped as BIN strings.
+--- 5. Points 3. and 4. do not apply to |msgpack-special-dict|s.
+---
+--- @param list any
+--- @param type? any
+--- @return any
+function vim.fn.msgpackdump(list, type) end
+
+--- Convert a |readfile()|-style list or a |Blob| to a list of
+--- Vimscript objects.
+--- Example: >
+---   let fname = expand('~/.config/nvim/shada/main.shada')
+---   let mpack = readfile(fname, 'b')
+---   let shada_objects = msgpackparse(mpack)
+--- <This will read ~/.config/nvim/shada/main.shada file to
+--- `shada_objects` list.
+---
+--- Limitations:
+--- 1. Mapping ordering is not preserved unless messagepack
+---    mapping is dumped using generic mapping
+---    (|msgpack-special-map|).
+--- 2. Since the parser aims to preserve all data untouched
+---    (except for 1.) some strings are parsed to
+---    |msgpack-special-dict| format which is not convenient to
+---    use.
+---           *msgpack-special-dict*
+--- Some messagepack strings may be parsed to special
+--- dictionaries. Special dictionaries are dictionaries which
+---
+--- 1. Contain exactly two keys: `_TYPE` and `_VAL`.
+--- 2. `_TYPE` key is one of the types found in |v:msgpack_types|
+---    variable.
+--- 3. Value for `_VAL` has the following format (Key column
+---    contains name of the key from |v:msgpack_types|):
+---
+--- Key  Value ~
+--- nil  Zero, ignored when dumping.  Not returned by
+---   |msgpackparse()| since |v:null| was introduced.
+--- boolean  One or zero.  When dumping it is only checked that
+---   value is a |Number|.  Not returned by |msgpackparse()|
+---   since |v:true| and |v:false| were introduced.
+--- integer  |List| with four numbers: sign (-1 or 1), highest two
+---   bits, number with bits from 62nd to 31st, lowest 31
+---   bits. I.e. to get actual number one will need to use
+---   code like >
+---     _VAL[0] * ((_VAL[1] << 62)
+---                & (_VAL[2] << 31)
+---                & _VAL[3])
+--- <  Special dictionary with this type will appear in
+---   |msgpackparse()| output under one of the following
+---   circumstances:
+---   1. |Number| is 32-bit and value is either above
+---      INT32_MAX or below INT32_MIN.
+---   2. |Number| is 64-bit and value is above INT64_MAX. It
+---      cannot possibly be below INT64_MIN because msgpack
+---      C parser does not support such values.
+--- float  |Float|. This value cannot possibly appear in
+---   |msgpackparse()| output.
+--- string  |readfile()|-style list of strings. This value will
+---   appear in |msgpackparse()| output if string contains
+---   zero byte or if string is a mapping key and mapping is
+---   being represented as special dictionary for other
+---   reasons.
+--- binary  |String|, or |Blob| if binary string contains zero
+---   byte. This value cannot appear in |msgpackparse()|
+---   output since blobs were introduced.
+--- array  |List|. This value cannot appear in |msgpackparse()|
+---   output.
+---           *msgpack-special-map*
+--- map  |List| of |List|s with two items (key and value) each.
+---   This value will appear in |msgpackparse()| output if
+---   parsed mapping contains one of the following keys:
+---   1. Any key that is not a string (including keys which
+---      are binary strings).
+---   2. String with NUL byte inside.
+---   3. Duplicate key.
+---   4. Empty key.
+--- ext  |List| with two values: first is a signed integer
+---   representing extension type. Second is
+---   |readfile()|-style list of strings.
+---
+--- @param data any
+--- @return any
+function vim.fn.msgpackparse(data) end
+
+--- Return the line number of the first line at or below {lnum}
+--- that is not blank.  Example: >
+---   if getline(nextnonblank(1)) =~ "Java"
+--- <When {lnum} is invalid or there is no non-blank line at or
+--- below it, zero is returned.
+--- {lnum} is used like with |getline()|.
+--- See also |prevnonblank()|.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->nextnonblank()
+---
+--- @param lnum integer
+--- @return any
+function vim.fn.nextnonblank(lnum) end
+
+--- Return a string with a single character, which has the number
+--- value {expr}.  Examples: >
+---   nr2char(64)    returns "\@"
+---   nr2char(32)    returns " "
+--- <Example for "utf-8": >
+---   nr2char(300)    returns I with bow character
+--- <UTF-8 encoding is always used, {utf8} option has no effect,
+--- and exists only for backwards-compatibility.
+--- Note that a NUL character in the file is specified with
+--- nr2char(10), because NULs are represented with newline
+--- characters.  nr2char(0) is a real NUL and terminates the
+--- string, thus results in an empty string.
+---
+--- Can also be used as a |method|: >
+---   GetNumber()->nr2char()
+---
+--- nvim_...({...})          *E5555* *nvim_...()* *eval-api*
+--- Call nvim |api| functions. The type checking of arguments will
+--- be stricter than for most other builtins. For instance,
+--- if Integer is expected, a |Number| must be passed in, a
+--- |String| will not be autoconverted.
+--- Buffer numbers, as returned by |bufnr()| could be used as
+--- first argument to nvim_buf_... functions.  All functions
+--- expecting an object (buffer, window or tabpage) can
+--- also take the numerical value 0 to indicate the current
+--- (focused) object.
+---
+--- @param expr any
+--- @param utf8? any
+--- @return any
+function vim.fn.nr2char(expr, utf8) end
+
+--- Bitwise OR on the two arguments.  The arguments are converted
+--- to a number.  A List, Dict or Float argument causes an error.
+--- Also see `and()` and `xor()`.
+--- Example: >
+---   :let bits = or(bits, 0x80)
+--- <Can also be used as a |method|: >
+---   :let bits = bits->or(0x80)
+---
+--- <Rationale: The reason this is a function and not using the "|"
+--- character like many languages, is that Vi has always used "|"
+--- to separate commands.  In many places it would not be clear if
+--- "|" is an operator or a command separator.
+---
+---
+--- @param expr any
+--- @param expr1 any
+--- @return any
+vim.fn['or'] = function(expr, expr1) end
+
+--- Shorten directory names in the path {path} and return the
+--- result.  The tail, the file name, is kept as-is.  The other
+--- components in the path are reduced to {len} letters in length.
+--- If {len} is omitted or smaller than 1 then 1 is used (single
+--- letters).  Leading '~' and '.' characters are kept.  Examples: >
+---   :echo pathshorten('~/.config/nvim/autoload/file1.vim')
+--- <  ~/.c/n/a/file1.vim ~
+--- >
+---   :echo pathshorten('~/.config/nvim/autoload/file2.vim', 2)
+--- <  ~/.co/nv/au/file2.vim ~
+--- It doesn't matter if the path exists or not.
+--- Returns an empty string on error.
+---
+--- Can also be used as a |method|: >
+---   GetDirectories()->pathshorten()
+---
+--- @param path string
+--- @param len? any
+--- @return any
+function vim.fn.pathshorten(path, len) end
+
+--- Evaluate |perl| expression {expr} and return its result
+--- converted to Vim data structures.
+--- Numbers and strings are returned as they are (strings are
+--- copied though).
+--- Lists are represented as Vim |List| type.
+--- Dictionaries are represented as Vim |Dictionary| type,
+--- non-string keys result in error.
+---
+--- Note: If you want an array or hash, {expr} must return a
+--- reference to it.
+--- Example: >
+---   :echo perleval('[1 .. 4]')
+--- <  [1, 2, 3, 4]
+---
+--- Can also be used as a |method|: >
+---   GetExpr()->perleval()
+---
+--- @param expr any
+--- @return any
+function vim.fn.perleval(expr) end
+
+--- Return the power of {x} to the exponent {y} as a |Float|.
+--- {x} and {y} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {x} or {y} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo pow(3, 3)
+--- <  27.0 >
+---   :echo pow(2, 16)
+--- <  65536.0 >
+---   :echo pow(32, 0.20)
+--- <  2.0
+---
+--- Can also be used as a |method|: >
+---   Compute()->pow(3)
+---
+--- @param x any
+--- @param y any
+--- @return any
+function vim.fn.pow(x, y) end
+
+--- Return the line number of the first line at or above {lnum}
+--- that is not blank.  Example: >
+---   let ind = indent(prevnonblank(v:lnum - 1))
+--- <When {lnum} is invalid or there is no non-blank line at or
+--- above it, zero is returned.
+--- {lnum} is used like with |getline()|.
+--- Also see |nextnonblank()|.
+---
+--- Can also be used as a |method|: >
+---   GetLnum()->prevnonblank()
+---
+--- @param lnum integer
+--- @return any
+function vim.fn.prevnonblank(lnum) end
+
+--- Return a String with {fmt}, where "%" items are replaced by
+--- the formatted form of their respective arguments.  Example: >
+---   printf("%4d: E%d %.30s", lnum, errno, msg)
+--- <May result in:
+---   "  99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
+---
+--- When used as a |method| the base is passed as the second
+--- argument: >
+---   Compute()->printf("result: %d")
+--- <
+--- You can use `call()` to pass the items as a list.
+---
+--- Often used items are:
+---   %s  string
+---   %6S  string right-aligned in 6 display cells
+---   %6s  string right-aligned in 6 bytes
+---   %.9s  string truncated to 9 bytes
+---   %c  single byte
+---   %d  decimal number
+---   %5d  decimal number padded with spaces to 5 characters
+---   %b  binary number
+---   %08b  binary number padded with zeros to at least 8 characters
+---   %B  binary number using upper case letters
+---   %x  hex number
+---   %04x  hex number padded with zeros to at least 4 characters
+---   %X  hex number using upper case letters
+---   %o  octal number
+---   %f  floating point number as 12.23, inf, -inf or nan
+---   %F  floating point number as 12.23, INF, -INF or NAN
+---   %e  floating point number as 1.23e3, inf, -inf or nan
+---   %E  floating point number as 1.23E3, INF, -INF or NAN
+---   %g  floating point number, as %f or %e depending on value
+---   %G  floating point number, as %F or %E depending on value
+---   %%  the % character itself
+---   %p  representation of the pointer to the container
+---
+--- Conversion specifications start with '%' and end with the
+--- conversion type.  All other characters are copied unchanged to
+--- the result.
+---
+--- The "%" starts a conversion specification.  The following
+--- arguments appear in sequence:
+---
+---   %  [flags]  [field-width]  [.precision]  type
+---
+--- flags
+---   Zero or more of the following flags:
+---
+---     #        The value should be converted to an "alternate
+---         form".  For c, d, and s conversions, this option
+---         has no effect.  For o conversions, the precision
+---         of the number is increased to force the first
+---         character of the output string to a zero (except
+---         if a zero value is printed with an explicit
+---         precision of zero).
+---         For x and X conversions, a non-zero result has
+---         the string "0x" (or "0X" for X conversions)
+---         prepended to it.
+---
+---     0 (zero)  Zero padding.  For all conversions the converted
+---         value is padded on the left with zeros rather
+---         than blanks.  If a precision is given with a
+---         numeric conversion (d, o, x, and X), the 0 flag
+---         is ignored.
+---
+---     -        A negative field width flag; the converted value
+---         is to be left adjusted on the field boundary.
+---         The converted value is padded on the right with
+---         blanks, rather than on the left with blanks or
+---         zeros.  A - overrides a 0 if both are given.
+---
+---     ' ' (space)  A blank should be left before a positive
+---         number produced by a signed conversion (d).
+---
+---     +        A sign must always be placed before a number
+---         produced by a signed conversion.  A + overrides
+---         a space if both are used.
+---
+--- field-width
+---   An optional decimal digit string specifying a minimum
+---   field width.  If the converted value has fewer bytes
+---   than the field width, it will be padded with spaces on
+---   the left (or right, if the left-adjustment flag has
+---   been given) to fill out the field width.  For the S
+---   conversion the count is in cells.
+---
+--- .precision
+---   An optional precision, in the form of a period '.'
+---   followed by an optional digit string.  If the digit
+---   string is omitted, the precision is taken as zero.
+---   This gives the minimum number of digits to appear for
+---   d, o, x, and X conversions, the maximum number of
+---   bytes to be printed from a string for s conversions,
+---   or the maximum number of cells to be printed from a
+---   string for S conversions.
+---   For floating point it is the number of digits after
+---   the decimal point.
+---
+--- type
+---   A character that specifies the type of conversion to
+---   be applied, see below.
+---
+--- A field width or precision, or both, may be indicated by an
+--- asterisk "*" instead of a digit string.  In this case, a
+--- Number argument supplies the field width or precision.  A
+--- negative field width is treated as a left adjustment flag
+--- followed by a positive field width; a negative precision is
+--- treated as though it were missing.  Example: >
+---   :echo printf("%d: %.*s", nr, width, line)
+--- <This limits the length of the text used from "line" to
+--- "width" bytes.
+---
+--- The conversion specifiers and their meanings are:
+---
+---     *printf-d* *printf-b* *printf-B* *printf-o* *printf-x* *printf-X*
+--- dbBoxX  The Number argument is converted to signed decimal (d),
+---   unsigned binary (b and B), unsigned octal (o), or
+---   unsigned hexadecimal (x and X) notation.  The letters
+---   "abcdef" are used for x conversions; the letters
+---   "ABCDEF" are used for X conversions.  The precision, if
+---   any, gives the minimum number of digits that must
+---   appear; if the converted value requires fewer digits, it
+---   is padded on the left with zeros.  In no case does a
+---   non-existent or small field width cause truncation of a
+---   numeric field; if the result of a conversion is wider
+---   than the field width, the field is expanded to contain
+---   the conversion result.
+---   The 'h' modifier indicates the argument is 16 bits.
+---   The 'l' modifier indicates the argument is 32 bits.
+---   The 'L' modifier indicates the argument is 64 bits.
+---   Generally, these modifiers are not useful. They are
+---   ignored when type is known from the argument.
+---
+--- i  alias for d
+--- D  alias for ld
+--- U  alias for lu
+--- O  alias for lo
+---
+---           *printf-c*
+--- c  The Number argument is converted to a byte, and the
+---   resulting character is written.
+---
+---           *printf-s*
+--- s  The text of the String argument is used.  If a
+---   precision is specified, no more bytes than the number
+---   specified are used.
+---   If the argument is not a String type, it is
+---   automatically converted to text with the same format
+---   as ":echo".
+---           *printf-S*
+--- S  The text of the String argument is used.  If a
+---   precision is specified, no more display cells than the
+---   number specified are used.
+---
+---           *printf-f* *E807*
+--- f F  The Float argument is converted into a string of the
+---   form 123.456.  The precision specifies the number of
+---   digits after the decimal point.  When the precision is
+---   zero the decimal point is omitted.  When the precision
+---   is not specified 6 is used.  A really big number
+---   (out of range or dividing by zero) results in "inf"
+---    or "-inf" with %f (INF or -INF with %F).
+---    "0.0 / 0.0" results in "nan" with %f (NAN with %F).
+---   Example: >
+---     echo printf("%.2f", 12.115)
+--- <    12.12
+---   Note that roundoff depends on the system libraries.
+---   Use |round()| when in doubt.
+---
+---           *printf-e* *printf-E*
+--- e E  The Float argument is converted into a string of the
+---   form 1.234e+03 or 1.234E+03 when using 'E'.  The
+---   precision specifies the number of digits after the
+---   decimal point, like with 'f'.
+---
+---           *printf-g* *printf-G*
+--- g G  The Float argument is converted like with 'f' if the
+---   value is between 0.001 (inclusive) and 10000000.0
+---   (exclusive).  Otherwise 'e' is used for 'g' and 'E'
+---   for 'G'.  When no precision is specified superfluous
+---   zeroes and '+' signs are removed, except for the zero
+---   immediately after the decimal point.  Thus 10000000.0
+---   results in 1.0e7.
+---
+---           *printf-%*
+--- %  A '%' is written.  No argument is converted.  The
+---   complete conversion specification is "%%".
+---
+--- When a Number argument is expected a String argument is also
+--- accepted and automatically converted.
+--- When a Float or String argument is expected a Number argument
+--- is also accepted and automatically converted.
+--- Any other argument type results in an error message.
+---
+---           *E766* *E767*
+--- The number of {exprN} arguments must exactly match the number
+--- of "%" items.  If there are not sufficient or too many
+--- arguments an error is given.  Up to 18 arguments can be used.
+---
+--- @param fmt any
+--- @param expr1? any
+--- @return any
+function vim.fn.printf(fmt, expr1) end
+
+--- Returns the effective prompt text for buffer {buf}.  {buf} can
+--- be a buffer name or number.  See |prompt-buffer|.
+---
+--- If the buffer doesn't exist or isn't a prompt buffer, an empty
+--- string is returned.
+---
+--- Can also be used as a |method|: >
+---   GetBuffer()->prompt_getprompt()
+---
+--- @param buf any
+--- @return any
+function vim.fn.prompt_getprompt(buf) end
+
+--- Set prompt callback for buffer {buf} to {expr}.  When {expr}
+--- is an empty string the callback is removed.  This has only
+--- effect if {buf} has 'buftype' set to "prompt".
+---
+--- The callback is invoked when pressing Enter.  The current
+--- buffer will always be the prompt buffer.  A new line for a
+--- prompt is added before invoking the callback, thus the prompt
+--- for which the callback was invoked will be in the last but one
+--- line.
+--- If the callback wants to add text to the buffer, it must
+--- insert it above the last line, since that is where the current
+--- prompt is.  This can also be done asynchronously.
+--- The callback is invoked with one argument, which is the text
+--- that was entered at the prompt.  This can be an empty string
+--- if the user only typed Enter.
+--- Example: >
+---    func s:TextEntered(text)
+---      if a:text == 'exit' || a:text == 'quit'
+---        stopinsert
+---        " Reset 'modified' to allow the buffer to be closed.
+---        " We assume there is nothing useful to be saved.
+---        set nomodified
+---        close
+---      else
+---        " Do something useful with "a:text".  In this example
+---        " we just repeat it.
+---        call append(line('$') - 1, 'Entered: "' .. a:text .. '"')
+---      endif
+---    endfunc
+---    call prompt_setcallback(bufnr(), function('s:TextEntered'))
+---
+--- <Can also be used as a |method|: >
+---   GetBuffer()->prompt_setcallback(callback)
+---
+--- @param buf any
+--- @param expr any
+--- @return any
+function vim.fn.prompt_setcallback(buf, expr) end
+
+--- Set a callback for buffer {buf} to {expr}.  When {expr} is an
+--- empty string the callback is removed.  This has only effect if
+--- {buf} has 'buftype' set to "prompt".
+---
+--- This callback will be invoked when pressing CTRL-C in Insert
+--- mode.  Without setting a callback Vim will exit Insert mode,
+--- as in any buffer.
+---
+--- Can also be used as a |method|: >
+---   GetBuffer()->prompt_setinterrupt(callback)
+---
+--- @param buf any
+--- @param expr any
+--- @return any
+function vim.fn.prompt_setinterrupt(buf, expr) end
+
+--- Set prompt for buffer {buf} to {text}.  You most likely want
+--- {text} to end in a space.
+--- The result is only visible if {buf} has 'buftype' set to
+--- "prompt".  Example: >
+---   call prompt_setprompt(bufnr(''), 'command: ')
+--- <
+--- Can also be used as a |method|: >
+---   GetBuffer()->prompt_setprompt('command: ')
+---
+--- @param buf any
+--- @param text any
+--- @return any
+function vim.fn.prompt_setprompt(buf, text) end
+
+--- If the popup menu (see |ins-completion-menu|) is not visible,
+--- returns an empty |Dictionary|, otherwise, returns a
+--- |Dictionary| with the following keys:
+---   height    nr of items visible
+---   width    screen cells
+---   row    top screen row (0 first row)
+---   col    leftmost screen column (0 first col)
+---   size    total nr of items
+---   scrollbar  |TRUE| if scrollbar is visible
+---
+--- The values are the same as in |v:event| during |CompleteChanged|.
+---
+--- @return any
+function vim.fn.pum_getpos() end
+
+--- Returns non-zero when the popup menu is visible, zero
+--- otherwise.  See |ins-completion-menu|.
+--- This can be used to avoid some things that would remove the
+--- popup menu.
+---
+--- @return any
+function vim.fn.pumvisible() end
+
+--- Evaluate Python expression {expr} and return its result
+--- converted to Vim data structures.
+--- Numbers and strings are returned as they are (strings are
+--- copied though, Unicode strings are additionally converted to
+--- UTF-8).
+--- Lists are represented as Vim |List| type.
+--- Dictionaries are represented as Vim |Dictionary| type with
+--- keys converted to strings.
+---
+--- Can also be used as a |method|: >
+---   GetExpr()->py3eval()
+--- <
+---           *E858* *E859*
+--- @param expr any
+--- @return any
+function vim.fn.py3eval(expr) end
+
+--- Evaluate Python expression {expr} and return its result
+--- converted to Vim data structures.
+--- Numbers and strings are returned as they are (strings are
+--- copied though).
+--- Lists are represented as Vim |List| type.
+--- Dictionaries are represented as Vim |Dictionary| type,
+--- non-string keys result in error.
+---
+--- Can also be used as a |method|: >
+---   GetExpr()->pyeval()
+---
+--- @param expr any
+--- @return any
+function vim.fn.pyeval(expr) end
+
+--- Evaluate Python expression {expr} and return its result
+--- converted to Vim data structures.
+--- Uses Python 2 or 3, see |python_x| and 'pyxversion'.
+--- See also: |pyeval()|, |py3eval()|
+---
+--- Can also be used as a |method|: >
+---   GetExpr()->pyxeval()
+--- <
+--- @param expr any
+--- @return any
+function vim.fn.pyxeval(expr) end
+
+--- Return a pseudo-random Number generated with an xoshiro128**
+--- algorithm using seed {expr}.  The returned number is 32 bits,
+--- also on 64 bits systems, for consistency.
+--- {expr} can be initialized by |srand()| and will be updated by
+--- rand().  If {expr} is omitted, an internal seed value is used
+--- and updated.
+--- Returns -1 if {expr} is invalid.
+---
+--- Examples: >
+---   :echo rand()
+---   :let seed = srand()
+---   :echo rand(seed)
+---   :echo rand(seed) % 16  " random number 0 - 15
+--- <
+--- Can also be used as a |method|: >
+---   seed->rand()
+--- <
+---
+---           *E726* *E727*
+--- @param expr? any
+--- @return any
+function vim.fn.rand(expr) end
+
+--- Returns a |List| with Numbers:
+--- - If only {expr} is specified: [0, 1, ..., {expr} - 1]
+--- - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
+--- - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
+---   {max}] (increasing {expr} with {stride} each time, not
+---   producing a value past {max}).
+--- When the maximum is one before the start the result is an
+--- empty list.  When the maximum is more than one before the
+--- start this is an error.
+--- Examples: >
+---   range(4)    " [0, 1, 2, 3]
+---   range(2, 4)    " [2, 3, 4]
+---   range(2, 9, 3)    " [2, 5, 8]
+---   range(2, -2, -1)  " [2, 1, 0, -1, -2]
+---   range(0)    " []
+---   range(2, 0)    " error!
+--- <
+--- Can also be used as a |method|: >
+---   GetExpr()->range()
+--- <
+---
+--- @param expr any
+--- @param max? any
+--- @param stride? any
+--- @return any
+function vim.fn.range(expr, max, stride) end
+
+--- Read file {fname} in binary mode and return a |Blob|.
+--- If {offset} is specified, read the file from the specified
+--- offset.  If it is a negative value, it is used as an offset
+--- from the end of the file.  E.g., to read the last 12 bytes: >
+---   readblob('file.bin', -12)
+--- <If {size} is specified, only the specified size will be read.
+--- E.g. to read the first 100 bytes of a file: >
+---   readblob('file.bin', 0, 100)
+--- <If {size} is -1 or omitted, the whole data starting from
+--- {offset} will be read.
+--- This can be also used to read the data from a character device
+--- on Unix when {size} is explicitly set.  Only if the device
+--- supports seeking {offset} can be used.  Otherwise it should be
+--- zero.  E.g. to read 10 bytes from a serial console: >
+---   readblob('/dev/ttyS0', 0, 10)
+--- <When the file can't be opened an error message is given and
+--- the result is an empty |Blob|.
+--- When the offset is beyond the end of the file the result is an
+--- empty blob.
+--- When trying to read more bytes than are available the result
+--- is truncated.
+--- Also see |readfile()| and |writefile()|.
+---
+---
+---           *readdir()*
+--- @param fname integer
+--- @param offset? any
+--- @param size? any
+--- @return any
+function vim.fn.readblob(fname, offset, size) end
+
+--- Return a list with file and directory names in {directory}.
+--- You can also use |glob()| if you don't need to do complicated
+--- things, such as limiting the number of matches.
+---
+--- When {expr} is omitted all entries are included.
+--- When {expr} is given, it is evaluated to check what to do:
+---   If {expr} results in -1 then no further entries will
+---   be handled.
+---   If {expr} results in 0 then this entry will not be
+---   added to the list.
+---   If {expr} results in 1 then this entry will be added
+---   to the list.
+--- Each time {expr} is evaluated |v:val| is set to the entry name.
+--- When {expr} is a function the name is passed as the argument.
+--- For example, to get a list of files ending in ".txt": >
+---   readdir(dirname, {n -> n =~ '.txt$'})
+--- <To skip hidden and backup files: >
+---   readdir(dirname, {n -> n !~ '^\.\|\~$'})
+---
+--- <If you want to get a directory tree: >
+---                   function! s:tree(dir)
+---                       return {a:dir : map(readdir(a:dir),
+---       \ {_, x -> isdirectory(x) ?
+---       \          {x : s:tree(a:dir .. '/' .. x)} : x})}
+---                   endfunction
+---                   echo s:tree(".")
+--- <
+--- Returns an empty List on error.
+---
+--- Can also be used as a |method|: >
+---   GetDirName()->readdir()
+--- <
+---
+---           *readfile()*
+--- @param directory any
+--- @param expr? any
+--- @return any
+function vim.fn.readdir(directory, expr) end
+
+--- Read file {fname} and return a |List|, each line of the file
+--- as an item.  Lines are broken at NL characters.  Macintosh
+--- files separated with CR will result in a single long line
+--- (unless a NL appears somewhere).
+--- All NUL characters are replaced with a NL character.
+--- When {type} contains "b" binary mode is used:
+--- - When the last line ends in a NL an extra empty list item is
+---   added.
+--- - No CR characters are removed.
+--- Otherwise:
+--- - CR characters that appear before a NL are removed.
+--- - Whether the last line ends in a NL or not does not matter.
+--- - Any UTF-8 byte order mark is removed from the text.
+--- When {max} is given this specifies the maximum number of lines
+--- to be read.  Useful if you only want to check the first ten
+--- lines of a file: >
+---   :for line in readfile(fname, '', 10)
+---   :  if line =~ 'Date' | echo line | endif
+---   :endfor
+--- <When {max} is negative -{max} lines from the end of the file
+--- are returned, or as many as there are.
+--- When {max} is zero the result is an empty list.
+--- Note that without {max} the whole file is read into memory.
+--- Also note that there is no recognition of encoding.  Read a
+--- file into a buffer if you need to.
+--- Deprecated (use |readblob()| instead): When {type} contains
+--- "B" a |Blob| is returned with the binary data of the file
+--- unmodified.
+--- When the file can't be opened an error message is given and
+--- the result is an empty list.
+--- Also see |writefile()|.
+---
+--- Can also be used as a |method|: >
+---   GetFileName()->readfile()
+---
+--- @param fname integer
+--- @param type? any
+--- @param max? any
+--- @return any
+function vim.fn.readfile(fname, type, max) end
+
+--- {func} is called for every item in {object}, which can be a
+--- |List| or a |Blob|.  {func} is called with two arguments: the
+--- result so far and current item.  After processing all items
+--- the result is returned.
+---
+--- {initial} is the initial result.  When omitted, the first item
+--- in {object} is used and {func} is first called for the second
+--- item.  If {initial} is not given and {object} is empty no
+--- result can be computed, an E998 error is given.
+---
+--- Examples: >
+---   echo reduce([1, 3, 5], { acc, val -> acc + val })
+---   echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a')
+---   echo reduce(0z1122, { acc, val -> 2 * acc + val })
+--- <
+--- Can also be used as a |method|: >
+---   echo mylist->reduce({ acc, val -> acc + val }, 0)
+---
+--- @param object any
+--- @param func any
+--- @param initial? any
+--- @return any
+function vim.fn.reduce(object, func, initial) end
+
+--- Returns the single letter name of the register being executed.
+--- Returns an empty string when no register is being executed.
+--- See |\@|.
+---
+--- @return any
+function vim.fn.reg_executing() end
+
+--- Returns the single letter name of the last recorded register.
+--- Returns an empty string when nothing was recorded yet.
+--- See |q| and |Q|.
+---
+--- @return any
+function vim.fn.reg_recorded() end
+
+--- Returns the single letter name of the register being recorded.
+--- Returns an empty string when not recording.  See |q|.
+---
+--- @return any
+function vim.fn.reg_recording() end
+
+--- Return an item that represents a time value.  The item is a
+--- list with items that depend on the system.
+--- The item can be passed to |reltimestr()| to convert it to a
+--- string or |reltimefloat()| to convert to a Float.
+---
+--- Without an argument it returns the current "relative time", an
+--- implementation-defined value meaningful only when used as an
+--- argument to |reltime()|, |reltimestr()| and |reltimefloat()|.
+---
+--- With one argument it returns the time passed since the time
+--- specified in the argument.
+--- With two arguments it returns the time passed between {start}
+--- and {end}.
+---
+--- The {start} and {end} arguments must be values returned by
+--- reltime().  Returns zero on error.
+---
+--- Can also be used as a |method|: >
+---   GetStart()->reltime()
+--- <
+--- Note: |localtime()| returns the current (non-relative) time.
+---
+--- @param start? any
+--- @param end_? any
+--- @return any
+function vim.fn.reltime(start, end_) end
+
+--- Return a Float that represents the time value of {time}.
+--- Unit of time is seconds.
+--- Example:
+---   let start = reltime()
+---   call MyFunction()
+---   let seconds = reltimefloat(reltime(start))
+--- See the note of reltimestr() about overhead.
+--- Also see |profiling|.
+--- If there is an error an empty string is returned
+---
+--- Can also be used as a |method|: >
+---   reltime(start)->reltimefloat()
+---
+--- @param time any
+--- @return any
+function vim.fn.reltimefloat(time) end
+
+--- Return a String that represents the time value of {time}.
+--- This is the number of seconds, a dot and the number of
+--- microseconds.  Example: >
+---   let start = reltime()
+---   call MyFunction()
+---   echo reltimestr(reltime(start))
+--- <Note that overhead for the commands will be added to the time.
+--- Leading spaces are used to make the string align nicely.  You
+--- can use split() to remove it. >
+---   echo split(reltimestr(reltime(start)))[0]
+--- <Also see |profiling|.
+--- If there is an error an empty string is returned
+---
+--- Can also be used as a |method|: >
+---   reltime(start)->reltimestr()
+--- <
+--- @param time any
+--- @return any
+function vim.fn.reltimestr(time) end
+
+--- Remove the entry from {dict} with key {key} and return it.
+--- Example: >
+---   :echo "removed " .. remove(dict, "one")
+--- <If there is no {key} in {dict} this is an error.
+--- Returns zero on error.
+---
+--- @param dict any
+--- @param key any
+--- @return any
+function vim.fn.remove(dict, key) end
+
+--- Rename the file by the name {from} to the name {to}.  This
+--- should also work to move files across file systems.  The
+--- result is a Number, which is 0 if the file was renamed
+--- successfully, and non-zero when the renaming failed.
+--- NOTE: If {to} exists it is overwritten without warning.
+--- This function is not available in the |sandbox|.
+---
+--- Can also be used as a |method|: >
+---   GetOldName()->rename(newname)
+---
+--- @param from any
+--- @param to any
+--- @return any
+function vim.fn.rename(from, to) end
+
+--- Repeat {expr} {count} times and return the concatenated
+--- result.  Example: >
+---   :let separator = repeat('-', 80)
+--- <When {count} is zero or negative the result is empty.
+--- When {expr} is a |List| or a |Blob| the result is {expr}
+--- concatenated {count} times.  Example: >
+---   :let longlist = repeat(['a', 'b'], 3)
+--- <Results in ['a', 'b', 'a', 'b', 'a', 'b'].
+---
+--- Can also be used as a |method|: >
+---   mylist->repeat(count)
+---
+--- @param expr any
+--- @param count any
+--- @return any
+vim.fn['repeat'] = function(expr, count) end
+
+--- On MS-Windows, when {filename} is a shortcut (a .lnk file),
+--- returns the path the shortcut points to in a simplified form.
+--- On Unix, repeat resolving symbolic links in all path
+--- components of {filename} and return the simplified result.
+--- To cope with link cycles, resolving of symbolic links is
+--- stopped after 100 iterations.
+--- On other systems, return the simplified {filename}.
+--- The simplification step is done as by |simplify()|.
+--- resolve() keeps a leading path component specifying the
+--- current directory (provided the result is still a relative
+--- path name) and also keeps a trailing path separator.
+---
+--- Can also be used as a |method|: >
+---   GetName()->resolve()
+--- <
+---           *reverse()*
+--- @param filename any
+--- @return any
+function vim.fn.resolve(filename) end
+
+--- Reverse the order of items in {object} in-place.
+--- {object} can be a |List| or a |Blob|.
+--- Returns {object}.
+--- Returns zero if {object} is not a List or a Blob.
+--- If you want an object to remain unmodified make a copy first: >
+---   :let revlist = reverse(copy(mylist))
+--- <Can also be used as a |method|: >
+---   mylist->reverse()
+---
+--- @param object any
+--- @return any
+function vim.fn.reverse(object) end
+
+--- Round off {expr} to the nearest integral value and return it
+--- as a |Float|.  If {expr} lies halfway between two integral
+--- values, then use the larger one (away from zero).
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   echo round(0.456)
+--- <  0.0  >
+---   echo round(4.5)
+--- <  5.0 >
+---   echo round(-4.5)
+--- <  -5.0
+---
+--- Can also be used as a |method|: >
+---   Compute()->round()
+---
+--- @param expr any
+--- @return any
+function vim.fn.round(expr) end
+
+--- Sends {event} to {channel} via |RPC| and returns immediately.
+--- If {channel} is 0, the event is broadcast to all channels.
+--- Example: >
+---   :au VimLeave call rpcnotify(0, "leaving")
+---
+--- @param channel any
+--- @param event any
+--- @param args? any
+--- @return any
+function vim.fn.rpcnotify(channel, event, args) end
+
+--- Sends a request to {channel} to invoke {method} via
+--- |RPC| and blocks until a response is received.
+--- Example: >
+---   :let result = rpcrequest(rpc_chan, "func", 1, 2, 3)
+---
+--- @param channel any
+--- @param method any
+--- @param args? any
+--- @return any
+function vim.fn.rpcrequest(channel, method, args) end
+
+--- Deprecated. Replace  >
+---   :let id = rpcstart('prog', ['arg1', 'arg2'])
+--- <with >
+---   :let id = jobstart(['prog', 'arg1', 'arg2'], {'rpc': v:true})
+---
+--- @param prog any
+--- @param argv? any
+--- @return any
+function vim.fn.rpcstart(prog, argv) end
+
+--- @deprecated
+--- Use |jobstop()| instead to stop any job, or
+--- `chanclose(id, "rpc")` to close RPC communication
+--- without stopping the job. Use chanclose(id) to close
+--- any socket.
+function vim.fn.rpcstop(...) end
+
+--- Evaluate Ruby expression {expr} and return its result
+--- converted to Vim data structures.
+--- Numbers, floats and strings are returned as they are (strings
+--- are copied though).
+--- Arrays are represented as Vim |List| type.
+--- Hashes are represented as Vim |Dictionary| type.
+--- Other objects are represented as strings resulted from their
+--- "Object#to_s" method.
+---
+--- Can also be used as a |method|: >
+---   GetRubyExpr()->rubyeval()
+---
+--- @param expr any
+--- @return any
+function vim.fn.rubyeval(expr) end
+
+--- Like |screenchar()|, but return the attribute.  This is a rather
+--- arbitrary number that can only be used to compare to the
+--- attribute at other positions.
+--- Returns -1 when row or col is out of range.
+---
+--- Can also be used as a |method|: >
+---   GetRow()->screenattr(col)
+---
+--- @param row any
+--- @param col integer
+--- @return any
+function vim.fn.screenattr(row, col) end
+
+--- The result is a Number, which is the character at position
+--- [row, col] on the screen.  This works for every possible
+--- screen position, also status lines, window separators and the
+--- command line.  The top left position is row one, column one
+--- The character excludes composing characters.  For double-byte
+--- encodings it may only be the first byte.
+--- This is mainly to be used for testing.
+--- Returns -1 when row or col is out of range.
+---
+--- Can also be used as a |method|: >
+---   GetRow()->screenchar(col)
+---
+--- @param row any
+--- @param col integer
+--- @return any
+function vim.fn.screenchar(row, col) end
+
+--- The result is a List of Numbers.  The first number is the same
+--- as what |screenchar()| returns.  Further numbers are
+--- composing characters on top of the base character.
+--- This is mainly to be used for testing.
+--- Returns an empty List when row or col is out of range.
+---
+--- Can also be used as a |method|: >
+---   GetRow()->screenchars(col)
+---
+--- @param row any
+--- @param col integer
+--- @return any
+function vim.fn.screenchars(row, col) end
+
+--- The result is a Number, which is the current screen column of
+--- the cursor. The leftmost column has number 1.
+--- This function is mainly used for testing.
+---
+--- Note: Always returns the current screen column, thus if used
+--- in a command (e.g. ":echo screencol()") it will return the
+--- column inside the command line, which is 1 when the command is
+--- executed. To get the cursor position in the file use one of
+--- the following mappings: >
+---   nnoremap <expr> GG ":echom " .. screencol() .. "\n"
+---   nnoremap <silent> GG :echom screencol()<CR>
+---   noremap GG <Cmd>echom screencol()<Cr>
+--- <
+--- @return any
+function vim.fn.screencol() end
+
+--- The result is a Dict with the screen position of the text
+--- character in window {winid} at buffer line {lnum} and column
+--- {col}.  {col} is a one-based byte index.
+--- The Dict has these members:
+---   row  screen row
+---   col  first screen column
+---   endcol  last screen column
+---   curscol  cursor screen column
+--- If the specified position is not visible, all values are zero.
+--- The "endcol" value differs from "col" when the character
+--- occupies more than one screen cell.  E.g. for a Tab "col" can
+--- be 1 and "endcol" can be 8.
+--- The "curscol" value is where the cursor would be placed.  For
+--- a Tab it would be the same as "endcol", while for a double
+--- width character it would be the same as "col".
+--- The |conceal| feature is ignored here, the column numbers are
+--- as if 'conceallevel' is zero.  You can set the cursor to the
+--- right position and use |screencol()| to get the value with
+--- |conceal| taken into account.
+--- If the position is in a closed fold the screen position of the
+--- first character is returned, {col} is not used.
+--- Returns an empty Dict if {winid} is invalid.
+---
+--- Can also be used as a |method|: >
+---   GetWinid()->screenpos(lnum, col)
+---
+--- @param winid integer
+--- @param lnum integer
+--- @param col integer
+--- @return any
+function vim.fn.screenpos(winid, lnum, col) end
+
+--- The result is a Number, which is the current screen row of the
+--- cursor.  The top line has number one.
+--- This function is mainly used for testing.
+--- Alternatively you can use |winline()|.
+---
+--- Note: Same restrictions as with |screencol()|.
+---
+--- @return any
+function vim.fn.screenrow() end
+
+--- The result is a String that contains the base character and
+--- any composing characters at position [row, col] on the screen.
+--- This is like |screenchars()| but returning a String with the
+--- characters.
+--- This is mainly to be used for testing.
+--- Returns an empty String when row or col is out of range.
+---
+--- Can also be used as a |method|: >
+---   GetRow()->screenstring(col)
+--- <
+---             *search()*
+--- @param row any
+--- @param col integer
+--- @return any
+function vim.fn.screenstring(row, col) end
+
+--- Search for regexp pattern {pattern}.  The search starts at the
+--- cursor position (you can use |cursor()| to set it).
+---
+--- When a match has been found its line number is returned.
+--- If there is no match a 0 is returned and the cursor doesn't
+--- move.  No error message is given.
+---
+--- {flags} is a String, which can contain these character flags:
+--- 'b'  search Backward instead of forward
+--- 'c'  accept a match at the Cursor position
+--- 'e'  move to the End of the match
+--- 'n'  do Not move the cursor
+--- 'p'  return number of matching sub-Pattern (see below)
+--- 's'  Set the ' mark at the previous location of the cursor
+--- 'w'  Wrap around the end of the file
+--- 'W'  don't Wrap around the end of the file
+--- 'z'  start searching at the cursor column instead of Zero
+--- If neither 'w' or 'W' is given, the 'wrapscan' option applies.
+---
+--- If the 's' flag is supplied, the ' mark is set, only if the
+--- cursor is moved. The 's' flag cannot be combined with the 'n'
+--- flag.
+---
+--- 'ignorecase', 'smartcase' and 'magic' are used.
+---
+--- When the 'z' flag is not given, forward searching always
+--- starts in column zero and then matches before the cursor are
+--- skipped.  When the 'c' flag is present in 'cpo' the next
+--- search starts after the match.  Without the 'c' flag the next
+--- search starts one column after the start of the match.  This
+--- matters for overlapping matches.  See |cpo-c|.  You can also
+--- insert "\ze" to change where the match ends, see  |/\ze|.
+---
+--- When searching backwards and the 'z' flag is given then the
+--- search starts in column zero, thus no match in the current
+--- line will be found (unless wrapping around the end of the
+--- file).
+---
+--- When the {stopline} argument is given then the search stops
+--- after searching this line.  This is useful to restrict the
+--- search to a range of lines.  Examples: >
+---   let match = search('(', 'b', line("w0"))
+---   let end = search('END', '', line("w$"))
+--- <When {stopline} is used and it is not zero this also implies
+--- that the search does not wrap around the end of the file.
+--- A zero value is equal to not giving the argument.
+---
+--- When the {timeout} argument is given the search stops when
+--- more than this many milliseconds have passed.  Thus when
+--- {timeout} is 500 the search stops after half a second.
+--- The value must not be negative.  A zero value is like not
+--- giving the argument.
+---
+--- If the {skip} expression is given it is evaluated with the
+--- cursor positioned on the start of a match.  If it evaluates to
+--- non-zero this match is skipped.  This can be used, for
+--- example, to skip a match in a comment or a string.
+--- {skip} can be a string, which is evaluated as an expression, a
+--- function reference or a lambda.
+--- When {skip} is omitted or empty, every match is accepted.
+--- When evaluating {skip} causes an error the search is aborted
+--- and -1 returned.
+---           *search()-sub-match*
+--- With the 'p' flag the returned value is one more than the
+--- first sub-match in \(\).  One if none of them matched but the
+--- whole pattern did match.
+--- To get the column number too use |searchpos()|.
+---
+--- The cursor will be positioned at the match, unless the 'n'
+--- flag is used.
+---
+--- Example (goes over all files in the argument list): >
+---     :let n = 1
+---     :while n <= argc()      " loop over all files in arglist
+---     :  exe "argument " .. n
+---     :  " start at the last char in the file and wrap for the
+---     :  " first search to find match at start of file
+---     :  normal G$
+---     :  let flags = "w"
+---     :  while search("foo", flags) > 0
+---     :   s/foo/bar/g
+---     :   let flags = "W"
+---     :  endwhile
+---     :  update        " write the file if modified
+---     :  let n = n + 1
+---     :endwhile
+--- <
+--- Example for using some flags: >
+---     :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
+--- <This will search for the keywords "if", "else", and "endif"
+--- under or after the cursor.  Because of the 'p' flag, it
+--- returns 1, 2, or 3 depending on which keyword is found, or 0
+--- if the search fails.  With the cursor on the first word of the
+--- line:
+---     if (foo == 0) | let foo = foo + 1 | endif ~
+--- the function returns 1.  Without the 'c' flag, the function
+--- finds the "endif" and returns 3.  The same thing happens
+--- without the 'e' flag if the cursor is on the "f" of "if".
+--- The 'n' flag tells the function not to move the cursor.
+---
+--- Can also be used as a |method|: >
+---   GetPattern()->search()
+---
+--- @param pattern any
+--- @param flags? string
+--- @param stopline? any
+--- @param timeout? integer
+--- @param skip? any
+--- @return any
+function vim.fn.search(pattern, flags, stopline, timeout, skip) end
+
+--- Get or update the last search count, like what is displayed
+--- without the "S" flag in 'shortmess'.  This works even if
+--- 'shortmess' does contain the "S" flag.
+---
+--- This returns a Dictionary. The dictionary is empty if the
+--- previous pattern was not set and "pattern" was not specified.
+---
+---   key    type    meaning ~
+---   current  |Number|  current position of match;
+---         0 if the cursor position is
+---         before the first match
+---   exact_match  |Boolean|  1 if "current" is matched on
+---         "pos", otherwise 0
+---   total    |Number|  total count of matches found
+---   incomplete  |Number|  0: search was fully completed
+---         1: recomputing was timed out
+---         2: max count exceeded
+---
+--- For {options} see further down.
+---
+--- To get the last search count when |n| or |N| was pressed, call
+--- this function with `recompute: 0` . This sometimes returns
+--- wrong information because |n| and |N|'s maximum count is 99.
+--- If it exceeded 99 the result must be max count + 1 (100). If
+--- you want to get correct information, specify `recompute: 1`: >
+---
+---   " result == maxcount + 1 (100) when many matches
+---   let result = searchcount(#{recompute: 0})
+---
+---   " Below returns correct result (recompute defaults
+---   " to 1)
+---   let result = searchcount()
+--- <
+--- The function is useful to add the count to 'statusline': >
+---   function! LastSearchCount() abort
+---     let result = searchcount(#{recompute: 0})
+---     if empty(result)
+---       return ''
+---     endif
+---     if result.incomplete ==# 1     " timed out
+---       return printf(' /%s [?/??]', \@/)
+---     elseif result.incomplete ==# 2 " max count exceeded
+---       if result.total > result.maxcount &&
+---       \  result.current > result.maxcount
+---         return printf(' /%s [>%d/>%d]', \@/,
+---         \             result.current, result.total)
+---       elseif result.total > result.maxcount
+---         return printf(' /%s [%d/>%d]', \@/,
+---         \             result.current, result.total)
+---       endif
+---     endif
+---     return printf(' /%s [%d/%d]', \@/,
+---     \             result.current, result.total)
+---   endfunction
+---   let &statusline ..= '%{LastSearchCount()}'
+---
+---   " Or if you want to show the count only when
+---   " 'hlsearch' was on
+---   " let &statusline ..=
+---   " \   '%{v:hlsearch ? LastSearchCount() : ""}'
+--- <
+--- You can also update the search count, which can be useful in a
+--- |CursorMoved| or |CursorMovedI| autocommand: >
+---
+---   autocmd CursorMoved,CursorMovedI *
+---     \ let s:searchcount_timer = timer_start(
+---     \   200, function('s:update_searchcount'))
+---   function! s:update_searchcount(timer) abort
+---     if a:timer ==# s:searchcount_timer
+---       call searchcount(#{
+---       \ recompute: 1, maxcount: 0, timeout: 100})
+---       redrawstatus
+---     endif
+---   endfunction
+--- <
+--- This can also be used to count matched texts with specified
+--- pattern in the current buffer using "pattern":  >
+---
+---   " Count '\<foo\>' in this buffer
+---   " (Note that it also updates search count)
+---   let result = searchcount(#{pattern: '\<foo\>'})
+---
+---   " To restore old search count by old pattern,
+---   " search again
+---   call searchcount()
+--- <
+--- {options} must be a Dictionary. It can contain:
+---   key    type    meaning ~
+---   recompute  |Boolean|  if |TRUE|, recompute the count
+---         like |n| or |N| was executed.
+---         otherwise returns the last
+---         computed result (when |n| or
+---         |N| was used when "S" is not
+---         in 'shortmess', or this
+---         function was called).
+---         (default: |TRUE|)
+---   pattern  |String|  recompute if this was given
+---         and different with |\@/|.
+---         this works as same as the
+---         below command is executed
+---         before calling this function >
+---           let \@/ = pattern
+--- <        (default: |\@/|)
+---   timeout  |Number|  0 or negative number is no
+---         timeout. timeout milliseconds
+---         for recomputing the result
+---         (default: 0)
+---   maxcount  |Number|  0 or negative number is no
+---         limit. max count of matched
+---         text while recomputing the
+---         result.  if search exceeded
+---         total count, "total" value
+---         becomes `maxcount + 1`
+---         (default: 0)
+---   pos    |List|    `[lnum, col, off]` value
+---         when recomputing the result.
+---         this changes "current" result
+---         value. see |cursor()|, |getpos()|
+---         (default: cursor's position)
+---
+--- Can also be used as a |method|: >
+---   GetSearchOpts()->searchcount()
+--- <
+--- @param options? table
+--- @return any
+function vim.fn.searchcount(options) end
+
+--- Search for the declaration of {name}.
+---
+--- With a non-zero {global} argument it works like |gD|, find
+--- first match in the file.  Otherwise it works like |gd|, find
+--- first match in the function.
+---
+--- With a non-zero {thisblock} argument matches in a {} block
+--- that ends before the cursor position are ignored.  Avoids
+--- finding variable declarations only valid in another scope.
+---
+--- Moves the cursor to the found match.
+--- Returns zero for success, non-zero for failure.
+--- Example: >
+---   if searchdecl('myvar') == 0
+---      echo getline('.')
+---   endif
+--- <
+--- Can also be used as a |method|: >
+---   GetName()->searchdecl()
+--- <
+---           *searchpair()*
+--- @param name string
+--- @param global? any
+--- @param thisblock? any
+--- @return any
+function vim.fn.searchdecl(name, global, thisblock) end
+
+--- Same as |search()|, but returns a |List| with the line and
+--- column position of the match. The first element of the |List|
+--- is the line number and the second element is the byte index of
+--- the column position of the match. If no match is found,
+--- returns [0, 0].
+--- Example: >
+---   :let [lnum, col] = searchpos('mypattern', 'n')
+---
+--- <When the 'p' flag is given then there is an extra item with
+--- the sub-pattern match number |search()-sub-match|.  Example: >
+---   :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
+--- <In this example "submatch" is 2 when a lowercase letter is
+--- found |/\l|, 3 when an uppercase letter is found |/\u|.
+---
+--- Can also be used as a |method|: >
+---   GetPattern()->searchpos()
+---
+--- @param pattern any
+--- @param flags? string
+--- @param stopline? any
+--- @param timeout? integer
+--- @param skip? any
+--- @return any
+function vim.fn.searchpos(pattern, flags, stopline, timeout, skip) end
+
+--- Returns a list of server addresses, or empty if all servers
+--- were stopped. |serverstart()| |serverstop()|
+--- Example: >
+---   :echo serverlist()
+---
+--- @return any
+function vim.fn.serverlist() end
+
+--- Opens a socket or named pipe at {address} and listens for
+--- |RPC| messages. Clients can send |API| commands to the
+--- returned address to control Nvim.
+---
+--- Returns the address string (which may differ from the
+--- {address} argument, see below).
+---
+--- - If {address} has a colon (":") it is a TCP/IPv4/IPv6 address
+---   where the last ":" separates host and port (empty or zero
+---   assigns a random port).
+--- - Else {address} is the path to a named pipe (except on Windows).
+---   - If {address} has no slashes ("/") it is treated as the
+---     "name" part of a generated path in this format: >
+---   stdpath("run").."/{name}.{pid}.{counter}"
+--- <  - If {address} is omitted the name is "nvim". >
+---   :echo serverstart()
+---   => /tmp/nvim.bram/oknANW/nvim.15430.5
+---
+--- <Example bash command to list all Nvim servers: >
+---   ls ${XDG_RUNTIME_DIR:-${TMPDIR}nvim.${USER}}/*/nvim.*.0
+---
+--- <Example named pipe: >
+---   if has('win32')
+---     echo serverstart('\\.\pipe\nvim-pipe-1234')
+---   else
+---     echo serverstart('nvim.sock')
+---   endif
+--- <
+--- Example TCP/IP address: >
+---   echo serverstart('::1:12345')
+---
+--- @param address? any
+--- @return any
+function vim.fn.serverstart(address) end
+
+--- Closes the pipe or socket at {address}.
+--- Returns TRUE if {address} is valid, else FALSE.
+--- If |v:servername| is stopped it is set to the next available
+--- address in |serverlist()|.
+---
+--- @param address any
+--- @return any
+function vim.fn.serverstop(address) end
+
+--- Set line {lnum} to {text} in buffer {buf}.  This works like
+--- |setline()| for the specified buffer.
+---
+--- This function works only for loaded buffers. First call
+--- |bufload()| if needed.
+---
+--- To insert lines use |appendbufline()|.
+---
+--- {text} can be a string to set one line, or a list of strings
+--- to set multiple lines.  If the list extends below the last
+--- line then those lines are added.
+---
+--- For the use of {buf}, see |bufname()| above.
+---
+--- {lnum} is used like with |setline()|.
+--- Use "$" to refer to the last line in buffer {buf}.
+--- When {lnum} is just below the last line the {text} will be
+--- added below the last line.
+--- On success 0 is returned, on failure 1 is returned.
+---
+--- If {buf} is not a valid buffer or {lnum} is not valid, an
+--- error message is given.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- third argument: >
+---   GetText()->setbufline(buf, lnum)
+---
+--- @param buf any
+--- @param lnum integer
+--- @param text any
+--- @return any
+function vim.fn.setbufline(buf, lnum, text) end
+
+--- Set option or local variable {varname} in buffer {buf} to
+--- {val}.
+--- This also works for a global or local window option, but it
+--- doesn't work for a global or local window variable.
+--- For a local window option the global value is unchanged.
+--- For the use of {buf}, see |bufname()| above.
+--- The {varname} argument is a string.
+--- Note that the variable name without "b:" must be used.
+--- Examples: >
+---   :call setbufvar(1, "&mod", 1)
+---   :call setbufvar("todo", "myvar", "foobar")
+--- <This function is not available in the |sandbox|.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- third argument: >
+---   GetValue()->setbufvar(buf, varname)
+---
+---
+--- @param buf any
+--- @param varname string
+--- @param val any
+--- @return any
+function vim.fn.setbufvar(buf, varname, val) end
+
+--- Specify overrides for cell widths of character ranges.  This
+--- tells Vim how wide characters are when displayed in the
+--- terminal, counted in screen cells.  The values override
+--- 'ambiwidth'.  Example: >
+---    call setcellwidths([
+---     \ [0x111, 0x111, 1],
+---     \ [0x2194, 0x2199, 2],
+---     \ ])
+---
+--- <The {list} argument is a List of Lists with each three
+--- numbers: [{low}, {high}, {width}].  *E1109* *E1110*
+--- {low} and {high} can be the same, in which case this refers to
+--- one character.  Otherwise it is the range of characters from
+--- {low} to {high} (inclusive).    *E1111* *E1114*
+--- Only characters with value 0x80 and higher can be used.
+---
+--- {width} must be either 1 or 2, indicating the character width
+--- in screen cells.      *E1112*
+--- An error is given if the argument is invalid, also when a
+--- range overlaps with another.    *E1113*
+---
+--- If the new value causes 'fillchars' or 'listchars' to become
+--- invalid it is rejected and an error is given.
+---
+--- To clear the overrides pass an empty {list}: >
+---    call setcellwidths([])
+---
+--- <You can use the script $VIMRUNTIME/tools/emoji_list.vim to see
+--- the effect for known emoji characters.  Move the cursor
+--- through the text to check if the cell widths of your terminal
+--- match with what Vim knows about each emoji.  If it doesn't
+--- look right you need to adjust the {list} argument.
+---
+---
+--- @param list any
+--- @return any
+function vim.fn.setcellwidths(list) end
+
+--- Same as |setpos()| but uses the specified column number as the
+--- character index instead of the byte index in the line.
+---
+--- Example:
+--- With the text "여보세요" in line 8: >
+---   call setcharpos('.', [0, 8, 4, 0])
+--- <positions the cursor on the fourth character '요'. >
+---   call setpos('.', [0, 8, 4, 0])
+--- <positions the cursor on the second character '보'.
+---
+--- Can also be used as a |method|: >
+---   GetPosition()->setcharpos('.')
+---
+--- @param expr any
+--- @param list any
+--- @return any
+function vim.fn.setcharpos(expr, list) end
+
+--- Set the current character search information to {dict},
+--- which contains one or more of the following entries:
+---
+---     char  character which will be used for a subsequent
+---     |,| or |;| command; an empty string clears the
+---     character search
+---     forward  direction of character search; 1 for forward,
+---     0 for backward
+---     until  type of character search; 1 for a |t| or |T|
+---     character search, 0 for an |f| or |F|
+---     character search
+---
+--- This can be useful to save/restore a user's character search
+--- from a script: >
+---   :let prevsearch = getcharsearch()
+---   :" Perform a command which clobbers user's search
+---   :call setcharsearch(prevsearch)
+--- <Also see |getcharsearch()|.
+---
+--- Can also be used as a |method|: >
+---   SavedSearch()->setcharsearch()
+---
+--- @param dict any
+--- @return any
+function vim.fn.setcharsearch(dict) end
+
+--- Set the command line to {str} and set the cursor position to
+--- {pos}.
+--- If {pos} is omitted, the cursor is positioned after the text.
+--- Returns 0 when successful, 1 when not editing the command
+--- line.
+---
+--- Can also be used as a |method|: >
+---   GetText()->setcmdline()
+---
+--- @param str any
+--- @param pos? any
+--- @return any
+function vim.fn.setcmdline(str, pos) end
+
+--- Set the cursor position in the command line to byte position
+--- {pos}.  The first position is 1.
+--- Use |getcmdpos()| to obtain the current position.
+--- Only works while editing the command line, thus you must use
+--- |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='.  For
+--- |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
+--- set after the command line is set to the expression.  For
+--- |c_CTRL-R_=| it is set after evaluating the expression but
+--- before inserting the resulting text.
+--- When the number is too big the cursor is put at the end of the
+--- line.  A number smaller than one has undefined results.
+--- Returns 0 when successful, 1 when not editing the command
+--- line.
+---
+--- Can also be used as a |method|: >
+---   GetPos()->setcmdpos()
+---
+--- @param pos any
+--- @return any
+function vim.fn.setcmdpos(pos) end
+
+--- Same as |cursor()| but uses the specified column number as the
+--- character index instead of the byte index in the line.
+---
+--- Example:
+--- With the text "여보세요" in line 4: >
+---   call setcursorcharpos(4, 3)
+--- <positions the cursor on the third character '세'. >
+---   call cursor(4, 3)
+--- <positions the cursor on the first character '여'.
+---
+--- Can also be used as a |method|: >
+---   GetCursorPos()->setcursorcharpos()
+---
+--- @param list any
+--- @return any
+function vim.fn.setcursorcharpos(list) end
+
+--- Set environment variable {name} to {val}.  Example: >
+---   call setenv('HOME', '/home/myhome')
+---
+--- <When {val} is |v:null| the environment variable is deleted.
+--- See also |expr-env|.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- second argument: >
+---   GetPath()->setenv('PATH')
+---
+--- @param name string
+--- @param val any
+--- @return any
+function vim.fn.setenv(name, val) end
+
+--- Set the file permissions for {fname} to {mode}.
+--- {mode} must be a string with 9 characters.  It is of the form
+--- "rwxrwxrwx", where each group of "rwx" flags represent, in
+--- turn, the permissions of the owner of the file, the group the
+--- file belongs to, and other users.  A '-' character means the
+--- permission is off, any other character means on.  Multi-byte
+--- characters are not supported.
+---
+--- For example "rw-r-----" means read-write for the user,
+--- readable by the group, not accessible by others.  "xx-x-----"
+--- would do the same thing.
+---
+--- Returns non-zero for success, zero for failure.
+---
+--- Can also be used as a |method|: >
+---   GetFilename()->setfperm(mode)
+--- <
+--- To read permissions see |getfperm()|.
+---
+--- @param fname integer
+--- @param mode string
+--- @return any
+function vim.fn.setfperm(fname, mode) end
+
+--- Set line {lnum} of the current buffer to {text}.  To insert
+--- lines use |append()|. To set lines in another buffer use
+--- |setbufline()|.
+---
+--- {lnum} is used like with |getline()|.
+--- When {lnum} is just below the last line the {text} will be
+--- added below the last line.
+--- {text} can be any type or a List of any type, each item is
+--- converted to a String.
+---
+--- If this succeeds, FALSE is returned.  If this fails (most likely
+--- because {lnum} is invalid) TRUE is returned.
+---
+--- Example: >
+---   :call setline(5, strftime("%c"))
+---
+--- <When {text} is a |List| then line {lnum} and following lines
+--- will be set to the items in the list.  Example: >
+---   :call setline(5, ['aaa', 'bbb', 'ccc'])
+--- <This is equivalent to: >
+---   :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
+---   :  call setline(n, l)
+---   :endfor
+---
+--- <Note: The '[ and '] marks are not set.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- second argument: >
+---   GetText()->setline(lnum)
+---
+--- @param lnum integer
+--- @param text any
+--- @return any
+function vim.fn.setline(lnum, text) end
+
+--- Create or replace or add to the location list for window {nr}.
+--- {nr} can be the window number or the |window-ID|.
+--- When {nr} is zero the current window is used.
+---
+--- For a location list window, the displayed location list is
+--- modified.  For an invalid window number {nr}, -1 is returned.
+--- Otherwise, same as |setqflist()|.
+--- Also see |location-list|.
+---
+--- For {action} see |setqflist-action|.
+---
+--- If the optional {what} dictionary argument is supplied, then
+--- only the items listed in {what} are set. Refer to |setqflist()|
+--- for the list of supported keys in {what}.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- second argument: >
+---   GetLoclist()->setloclist(winnr)
+---
+--- @param nr integer
+--- @param list any
+--- @param action? any
+--- @param what? any
+--- @return any
+function vim.fn.setloclist(nr, list, action, what) end
+
+--- Restores a list of matches saved by |getmatches()| for the
+--- current window.  Returns 0 if successful, otherwise -1.  All
+--- current matches are cleared before the list is restored.  See
+--- example for |getmatches()|.
+--- If {win} is specified, use the window with this number or
+--- window ID instead of the current window.
+---
+--- Can also be used as a |method|: >
+---   GetMatches()->setmatches()
+--- <
+---           *setpos()*
+--- @param list any
+--- @param win? any
+--- @return any
+function vim.fn.setmatches(list, win) end
+
+--- Set the position for String {expr}.  Possible values:
+---   .  the cursor
+---   'x  mark x
+---
+--- {list} must be a |List| with four or five numbers:
+---     [bufnum, lnum, col, off]
+---     [bufnum, lnum, col, off, curswant]
+---
+--- "bufnum" is the buffer number.  Zero can be used for the
+--- current buffer.  When setting an uppercase mark "bufnum" is
+--- used for the mark position.  For other marks it specifies the
+--- buffer to set the mark in.  You can use the |bufnr()| function
+--- to turn a file name into a buffer number.
+--- For setting the cursor and the ' mark "bufnum" is ignored,
+--- since these are associated with a window, not a buffer.
+--- Does not change the jumplist.
+---
+--- "lnum" and "col" are the position in the buffer.  The first
+--- column is 1.  Use a zero "lnum" to delete a mark.  If "col" is
+--- smaller than 1 then 1 is used. To use the character count
+--- instead of the byte count, use |setcharpos()|.
+---
+--- The "off" number is only used when 'virtualedit' is set. Then
+--- it is the offset in screen columns from the start of the
+--- character.  E.g., a position within a <Tab> or after the last
+--- character.
+---
+--- The "curswant" number is only used when setting the cursor
+--- position.  It sets the preferred column for when moving the
+--- cursor vertically.  When the "curswant" number is missing the
+--- preferred column is not set.  When it is present and setting a
+--- mark position it is not used.
+---
+--- Note that for '< and '> changing the line number may result in
+--- the marks to be effectively be swapped, so that '< is always
+--- before '>.
+---
+--- Returns 0 when the position could be set, -1 otherwise.
+--- An error message is given if {expr} is invalid.
+---
+--- Also see |setcharpos()|, |getpos()| and |getcurpos()|.
+---
+--- This does not restore the preferred column for moving
+--- vertically; if you set the cursor position with this, |j| and
+--- |k| motions will jump to previous columns!  Use |cursor()| to
+--- also set the preferred column.  Also see the "curswant" key in
+--- |winrestview()|.
+---
+--- Can also be used as a |method|: >
+---   GetPosition()->setpos('.')
+---
+--- @param expr any
+--- @param list any
+--- @return any
+function vim.fn.setpos(expr, list) end
+
+--- Create or replace or add to the quickfix list.
+---
+--- If the optional {what} dictionary argument is supplied, then
+--- only the items listed in {what} are set. The first {list}
+--- argument is ignored.  See below for the supported items in
+--- {what}.
+---           *setqflist-what*
+--- When {what} is not present, the items in {list} are used.  Each
+--- item must be a dictionary.  Non-dictionary items in {list} are
+--- ignored.  Each dictionary item can contain the following
+--- entries:
+---
+---     bufnr  buffer number; must be the number of a valid
+---     buffer
+---     filename  name of a file; only used when "bufnr" is not
+---     present or it is invalid.
+---     module  name of a module; if given it will be used in
+---     quickfix error window instead of the filename.
+---     lnum  line number in the file
+---     end_lnum  end of lines, if the item spans multiple lines
+---     pattern  search pattern used to locate the error
+---     col    column number
+---     vcol  when non-zero: "col" is visual column
+---     when zero: "col" is byte index
+---     end_col  end column, if the item spans multiple columns
+---     nr    error number
+---     text  description of the error
+---     type  single-character error type, 'E', 'W', etc.
+---     valid  recognized error message
+---
+--- The "col", "vcol", "nr", "type" and "text" entries are
+--- optional.  Either "lnum" or "pattern" entry can be used to
+--- locate a matching error line.
+--- If the "filename" and "bufnr" entries are not present or
+--- neither the "lnum" or "pattern" entries are present, then the
+--- item will not be handled as an error line.
+--- If both "pattern" and "lnum" are present then "pattern" will
+--- be used.
+--- If the "valid" entry is not supplied, then the valid flag is
+--- set when "bufnr" is a valid buffer or "filename" exists.
+--- If you supply an empty {list}, the quickfix list will be
+--- cleared.
+--- Note that the list is not exactly the same as what
+--- |getqflist()| returns.
+---
+--- {action} values:    *setqflist-action* *E927*
+--- 'a'  The items from {list} are added to the existing
+---   quickfix list. If there is no existing list, then a
+---   new list is created.
+---
+--- 'r'  The items from the current quickfix list are replaced
+---   with the items from {list}.  This can also be used to
+---   clear the list: >
+---     :call setqflist([], 'r')
+--- <
+--- 'f'  All the quickfix lists in the quickfix stack are
+---   freed.
+---
+--- If {action} is not present or is set to ' ', then a new list
+--- is created. The new quickfix list is added after the current
+--- quickfix list in the stack and all the following lists are
+--- freed. To add a new quickfix list at the end of the stack,
+--- set "nr" in {what} to "$".
+---
+--- The following items can be specified in dictionary {what}:
+---     context  quickfix list context. See |quickfix-context|
+---     efm    errorformat to use when parsing text from
+---     "lines". If this is not present, then the
+---     'errorformat' option value is used.
+---     See |quickfix-parse|
+---     id    quickfix list identifier |quickfix-ID|
+---     idx    index of the current entry in the quickfix
+---     list specified by "id" or "nr". If set to '$',
+---     then the last entry in the list is set as the
+---     current entry.  See |quickfix-index|
+---     items  list of quickfix entries. Same as the {list}
+---     argument.
+---     lines  use 'errorformat' to parse a list of lines and
+---     add the resulting entries to the quickfix list
+---     {nr} or {id}.  Only a |List| value is supported.
+---     See |quickfix-parse|
+---     nr    list number in the quickfix stack; zero
+---     means the current quickfix list and "$" means
+---     the last quickfix list.
+---     quickfixtextfunc
+---     function to get the text to display in the
+---     quickfix window.  The value can be the name of
+---     a function or a funcref or a lambda.  Refer to
+---     |quickfix-window-function| for an explanation
+---     of how to write the function and an example.
+---     title  quickfix list title text. See |quickfix-title|
+--- Unsupported keys in {what} are ignored.
+--- If the "nr" item is not present, then the current quickfix list
+--- is modified. When creating a new quickfix list, "nr" can be
+--- set to a value one greater than the quickfix stack size.
+--- When modifying a quickfix list, to guarantee that the correct
+--- list is modified, "id" should be used instead of "nr" to
+--- specify the list.
+---
+--- Examples (See also |setqflist-examples|): >
+---    :call setqflist([], 'r', {'title': 'My search'})
+---    :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
+---    :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
+--- <
+--- Returns zero for success, -1 for failure.
+---
+--- This function can be used to create a quickfix list
+--- independent of the 'errorformat' setting.  Use a command like
+--- `:cc 1` to jump to the first position.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- second argument: >
+---   GetErrorlist()->setqflist()
+--- <
+---           *setreg()*
+--- @param list any
+--- @param action? any
+--- @param what? any
+--- @return any
+function vim.fn.setqflist(list, action, what) end
+
+--- Set the register {regname} to {value}.
+--- If {regname} is "" or "\@", the unnamed register '"' is used.
+--- The {regname} argument is a string.
+---
+--- {value} may be any value returned by |getreg()| or
+--- |getreginfo()|, including a |List| or |Dict|.
+--- If {options} contains "a" or {regname} is upper case,
+--- then the value is appended.
+---
+--- {options} can also contain a register type specification:
+---     "c" or "v"        |charwise| mode
+---     "l" or "V"        |linewise| mode
+---     "b" or "<CTRL-V>" |blockwise-visual| mode
+--- If a number immediately follows "b" or "<CTRL-V>" then this is
+--- used as the width of the selection - if it is not specified
+--- then the width of the block is set to the number of characters
+--- in the longest line (counting a <Tab> as 1 character).
+--- If {options} contains "u" or '"', then the unnamed register is
+--- set to point to register {regname}.
+---
+--- If {options} contains no register settings, then the default
+--- is to use character mode unless {value} ends in a <NL> for
+--- string {value} and linewise mode for list {value}. Blockwise
+--- mode is never selected automatically.
+--- Returns zero for success, non-zero for failure.
+---
+---           *E883*
+--- Note: you may not use |List| containing more than one item to
+---       set search and expression registers. Lists containing no
+---       items act like empty strings.
+---
+--- Examples: >
+---   :call setreg(v:register, \@*)
+---   :call setreg('*', \@%, 'ac')
+---   :call setreg('a', "1\n2\n3", 'b5')
+---   :call setreg('"', { 'points_to': 'a'})
+---
+--- <This example shows using the functions to save and restore a
+--- register: >
+---   :let var_a = getreginfo()
+---   :call setreg('a', var_a)
+--- <or: >
+---   :let var_a = getreg('a', 1, 1)
+---   :let var_amode = getregtype('a')
+---       ....
+---   :call setreg('a', var_a, var_amode)
+--- <Note: you may not reliably restore register value
+--- without using the third argument to |getreg()| as without it
+--- newlines are represented as newlines AND Nul bytes are
+--- represented as newlines as well, see |NL-used-for-Nul|.
+---
+--- You can also change the type of a register by appending
+--- nothing: >
+---   :call setreg('a', '', 'al')
+---
+--- <Can also be used as a |method|, the base is passed as the
+--- second argument: >
+---   GetText()->setreg('a')
+---
+--- @param regname string
+--- @param value any
+--- @param options? table
+--- @return any
+function vim.fn.setreg(regname, value, options) end
+
+--- Set tab-local variable {varname} to {val} in tab page {tabnr}.
+--- |t:var|
+--- The {varname} argument is a string.
+--- Note that the variable name without "t:" must be used.
+--- Tabs are numbered starting with one.
+--- This function is not available in the |sandbox|.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- third argument: >
+---   GetValue()->settabvar(tab, name)
+---
+--- @param tabnr integer
+--- @param varname string
+--- @param val any
+--- @return any
+function vim.fn.settabvar(tabnr, varname, val) end
+
+--- Set option or local variable {varname} in window {winnr} to
+--- {val}.
+--- Tabs are numbered starting with one.  For the current tabpage
+--- use |setwinvar()|.
+--- {winnr} can be the window number or the |window-ID|.
+--- When {winnr} is zero the current window is used.
+--- This also works for a global or local buffer option, but it
+--- doesn't work for a global or local buffer variable.
+--- For a local buffer option the global value is unchanged.
+--- Note that the variable name without "w:" must be used.
+--- Examples: >
+---   :call settabwinvar(1, 1, "&list", 0)
+---   :call settabwinvar(3, 2, "myvar", "foobar")
+--- <This function is not available in the |sandbox|.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- fourth argument: >
+---   GetValue()->settabwinvar(tab, winnr, name)
+---
+--- @param tabnr integer
+--- @param winnr integer
+--- @param varname string
+--- @param val any
+--- @return any
+function vim.fn.settabwinvar(tabnr, winnr, varname, val) end
+
+--- Modify the tag stack of the window {nr} using {dict}.
+--- {nr} can be the window number or the |window-ID|.
+---
+--- For a list of supported items in {dict}, refer to
+--- |gettagstack()|. "curidx" takes effect before changing the tag
+--- stack.
+---           *E962*
+--- How the tag stack is modified depends on the {action}
+--- argument:
+--- - If {action} is not present or is set to 'r', then the tag
+---   stack is replaced.
+--- - If {action} is set to 'a', then new entries from {dict} are
+---   pushed (added) onto the tag stack.
+--- - If {action} is set to 't', then all the entries from the
+---   current entry in the tag stack or "curidx" in {dict} are
+---   removed and then new entries are pushed to the stack.
+---
+--- The current index is set to one after the length of the tag
+--- stack after the modification.
+---
+--- Returns zero for success, -1 for failure.
+---
+--- Examples (for more examples see |tagstack-examples|):
+---     Empty the tag stack of window 3: >
+---   call settagstack(3, {'items' : []})
+---
+--- <    Save and restore the tag stack: >
+---   let stack = gettagstack(1003)
+---   " do something else
+---   call settagstack(1003, stack)
+---   unlet stack
+--- <
+--- Can also be used as a |method|, the base is passed as the
+--- second argument: >
+---   GetStack()->settagstack(winnr)
+---
+--- @param nr integer
+--- @param dict any
+--- @param action? any
+--- @return any
+function vim.fn.settagstack(nr, dict, action) end
+
+--- Like |settabwinvar()| for the current tab page.
+--- Examples: >
+---   :call setwinvar(1, "&list", 0)
+---   :call setwinvar(2, "myvar", "foobar")
+---
+--- <Can also be used as a |method|, the base is passed as the
+--- third argument: >
+---   GetValue()->setwinvar(winnr, name)
+---
+--- @param nr integer
+--- @param varname string
+--- @param val any
+--- @return any
+function vim.fn.setwinvar(nr, varname, val) end
+
+--- Returns a String with 64 hex characters, which is the SHA256
+--- checksum of {string}.
+---
+--- Can also be used as a |method|: >
+---   GetText()->sha256()
+---
+--- @param string string
+--- @return any
+function vim.fn.sha256(string) end
+
+--- Escape {string} for use as a shell command argument.
+---
+--- On Windows when 'shellslash' is not set, encloses {string} in
+--- double-quotes and doubles all double-quotes within {string}.
+--- Otherwise encloses {string} in single-quotes and replaces all
+--- "'" with "'\''".
+---
+--- If {special} is a |non-zero-arg|:
+--- - Special items such as "!", "%", "#" and "<cword>" will be
+---   preceded by a backslash. The backslash will be removed again
+---   by the |:!| command.
+--- - The <NL> character is escaped.
+---
+--- If 'shell' contains "csh" in the tail:
+--- - The "!" character will be escaped. This is because csh and
+---   tcsh use "!" for history replacement even in single-quotes.
+--- - The <NL> character is escaped (twice if {special} is
+---   a |non-zero-arg|).
+---
+--- If 'shell' contains "fish" in the tail, the "\" character will
+--- be escaped because in fish it is used as an escape character
+--- inside single quotes.
+---
+--- Example of use with a |:!| command: >
+---     :exe '!dir ' .. shellescape(expand('<cfile>'), 1)
+--- <This results in a directory listing for the file under the
+--- cursor.  Example of use with |system()|: >
+---     :call system("chmod +w -- " .. shellescape(expand("%")))
+--- <See also |::S|.
+---
+--- Can also be used as a |method|: >
+---   GetCommand()->shellescape()
+---
+--- @param string string
+--- @param special? any
+--- @return any
+function vim.fn.shellescape(string, special) end
+
+--- Returns the effective value of 'shiftwidth'. This is the
+--- 'shiftwidth' value unless it is zero, in which case it is the
+--- 'tabstop' value.  To be backwards compatible in indent
+--- plugins, use this: >
+---   if exists('*shiftwidth')
+---     func s:sw()
+---       return shiftwidth()
+---     endfunc
+---   else
+---     func s:sw()
+---       return &sw
+---     endfunc
+---   endif
+--- <And then use s:sw() instead of &sw.
+---
+--- When there is one argument {col} this is used as column number
+--- for which to return the 'shiftwidth' value. This matters for the
+--- 'vartabstop' feature. If no {col} argument is given, column 1
+--- will be assumed.
+---
+--- Can also be used as a |method|: >
+---   GetColumn()->shiftwidth()
+---
+--- sign_ functions are documented here: |sign-functions-details|
+---
+--- @param col? integer
+--- @return any
+function vim.fn.shiftwidth(col) end
+
+--- Define a new sign named {name} or modify the attributes of an
+--- existing sign.  This is similar to the |:sign-define| command.
+---
+--- Prefix {name} with a unique text to avoid name collisions.
+--- There is no {group} like with placing signs.
+---
+--- The {name} can be a String or a Number.  The optional {dict}
+--- argument specifies the sign attributes.  The following values
+--- are supported:
+---    icon    full path to the bitmap file for the sign.
+---    linehl  highlight group used for the whole line the
+---     sign is placed in.
+---    numhl  highlight group used for the line number where
+---     the sign is placed.
+---    text    text that is displayed when there is no icon
+---     or the GUI is not being used.
+---    texthl  highlight group used for the text item
+---    culhl  highlight group used for the text item when
+---     the cursor is on the same line as the sign and
+---     'cursorline' is enabled.
+---
+--- If the sign named {name} already exists, then the attributes
+--- of the sign are updated.
+---
+--- The one argument {list} can be used to define a list of signs.
+--- Each list item is a dictionary with the above items in {dict}
+--- and a "name" item for the sign name.
+---
+--- Returns 0 on success and -1 on failure.  When the one argument
+--- {list} is used, then returns a List of values one for each
+--- defined sign.
+---
+--- Examples: >
+---   call sign_define("mySign", {
+---     \ "text" : "=>",
+---     \ "texthl" : "Error",
+---     \ "linehl" : "Search"})
+---   call sign_define([
+---     \ {'name' : 'sign1',
+---     \  'text' : '=>'},
+---     \ {'name' : 'sign2',
+---     \  'text' : '!!'}
+---     \ ])
+--- <
+--- Can also be used as a |method|: >
+---   GetSignList()->sign_define()
+---
+--- @param list any
+--- @return any
+function vim.fn.sign_define(list) end
+
+--- Get a list of defined signs and their attributes.
+--- This is similar to the |:sign-list| command.
+---
+--- If the {name} is not supplied, then a list of all the defined
+--- signs is returned. Otherwise the attribute of the specified
+--- sign is returned.
+---
+--- Each list item in the returned value is a dictionary with the
+--- following entries:
+---    icon    full path to the bitmap file of the sign
+---    linehl  highlight group used for the whole line the
+---     sign is placed in; not present if not set.
+---    name    name of the sign
+---    numhl  highlight group used for the line number where
+---     the sign is placed; not present if not set.
+---    text    text that is displayed when there is no icon
+---     or the GUI is not being used.
+---    texthl  highlight group used for the text item; not
+---     present if not set.
+---    culhl  highlight group used for the text item when
+---     the cursor is on the same line as the sign and
+---     'cursorline' is enabled; not present if not
+---     set.
+---
+--- Returns an empty List if there are no signs and when {name} is
+--- not found.
+---
+--- Examples: >
+---   " Get a list of all the defined signs
+---   echo sign_getdefined()
+---
+---   " Get the attribute of the sign named mySign
+---   echo sign_getdefined("mySign")
+--- <
+--- Can also be used as a |method|: >
+---   GetSignList()->sign_getdefined()
+---
+--- @param name? string
+--- @return any
+function vim.fn.sign_getdefined(name) end
+
+--- Return a list of signs placed in a buffer or all the buffers.
+--- This is similar to the |:sign-place-list| command.
+---
+--- If the optional buffer name {buf} is specified, then only the
+--- list of signs placed in that buffer is returned.  For the use
+--- of {buf}, see |bufname()|. The optional {dict} can contain
+--- the following entries:
+---    group  select only signs in this group
+---    id    select sign with this identifier
+---    lnum    select signs placed in this line. For the use
+---     of {lnum}, see |line()|.
+--- If {group} is "*", then signs in all the groups including the
+--- global group are returned. If {group} is not supplied or is an
+--- empty string, then only signs in the global group are
+--- returned.  If no arguments are supplied, then signs in the
+--- global group placed in all the buffers are returned.
+--- See |sign-group|.
+---
+--- Each list item in the returned value is a dictionary with the
+--- following entries:
+---   bufnr  number of the buffer with the sign
+---   signs  list of signs placed in {bufnr}. Each list
+---     item is a dictionary with the below listed
+---     entries
+---
+--- The dictionary for each sign contains the following entries:
+---   group   sign group. Set to '' for the global group.
+---   id   identifier of the sign
+---   lnum   line number where the sign is placed
+---   name   name of the defined sign
+---   priority sign priority
+---
+--- The returned signs in a buffer are ordered by their line
+--- number and priority.
+---
+--- Returns an empty list on failure or if there are no placed
+--- signs.
+---
+--- Examples: >
+---   " Get a List of signs placed in eval.c in the
+---   " global group
+---   echo sign_getplaced("eval.c")
+---
+---   " Get a List of signs in group 'g1' placed in eval.c
+---   echo sign_getplaced("eval.c", {'group' : 'g1'})
+---
+---   " Get a List of signs placed at line 10 in eval.c
+---   echo sign_getplaced("eval.c", {'lnum' : 10})
+---
+---   " Get sign with identifier 10 placed in a.py
+---   echo sign_getplaced("a.py", {'id' : 10})
+---
+---   " Get sign with id 20 in group 'g1' placed in a.py
+---   echo sign_getplaced("a.py", {'group' : 'g1',
+---           \  'id' : 20})
+---
+---   " Get a List of all the placed signs
+---   echo sign_getplaced()
+--- <
+--- Can also be used as a |method|: >
+---   GetBufname()->sign_getplaced()
+--- <
+---           *sign_jump()*
+--- @param buf? any
+--- @param dict? any
+--- @return any
+function vim.fn.sign_getplaced(buf, dict) end
+
+--- Open the buffer {buf} or jump to the window that contains
+--- {buf} and position the cursor at sign {id} in group {group}.
+--- This is similar to the |:sign-jump| command.
+---
+--- If {group} is an empty string, then the global group is used.
+--- For the use of {buf}, see |bufname()|.
+---
+--- Returns the line number of the sign. Returns -1 if the
+--- arguments are invalid.
+---
+--- Example: >
+---   " Jump to sign 10 in the current buffer
+---   call sign_jump(10, '', '')
+--- <
+--- Can also be used as a |method|: >
+---   GetSignid()->sign_jump()
+--- <
+---           *sign_place()*
+--- @param id any
+--- @param group any
+--- @param buf any
+--- @return any
+function vim.fn.sign_jump(id, group, buf) end
+
+--- Place the sign defined as {name} at line {lnum} in file or
+--- buffer {buf} and assign {id} and {group} to sign.  This is
+--- similar to the |:sign-place| command.
+---
+--- If the sign identifier {id} is zero, then a new identifier is
+--- allocated.  Otherwise the specified number is used. {group} is
+--- the sign group name. To use the global sign group, use an
+--- empty string.  {group} functions as a namespace for {id}, thus
+--- two groups can use the same IDs. Refer to |sign-identifier|
+--- and |sign-group| for more information.
+---
+--- {name} refers to a defined sign.
+--- {buf} refers to a buffer name or number. For the accepted
+--- values, see |bufname()|.
+---
+--- The optional {dict} argument supports the following entries:
+---   lnum    line number in the file or buffer
+---       {buf} where the sign is to be placed.
+---       For the accepted values, see |line()|.
+---   priority  priority of the sign. See
+---       |sign-priority| for more information.
+---
+--- If the optional {dict} is not specified, then it modifies the
+--- placed sign {id} in group {group} to use the defined sign
+--- {name}.
+---
+--- Returns the sign identifier on success and -1 on failure.
+---
+--- Examples: >
+---   " Place a sign named sign1 with id 5 at line 20 in
+---   " buffer json.c
+---   call sign_place(5, '', 'sign1', 'json.c',
+---           \ {'lnum' : 20})
+---
+---   " Updates sign 5 in buffer json.c to use sign2
+---   call sign_place(5, '', 'sign2', 'json.c')
+---
+---   " Place a sign named sign3 at line 30 in
+---   " buffer json.c with a new identifier
+---   let id = sign_place(0, '', 'sign3', 'json.c',
+---           \ {'lnum' : 30})
+---
+---   " Place a sign named sign4 with id 10 in group 'g3'
+---   " at line 40 in buffer json.c with priority 90
+---   call sign_place(10, 'g3', 'sign4', 'json.c',
+---       \ {'lnum' : 40, 'priority' : 90})
+--- <
+--- Can also be used as a |method|: >
+---   GetSignid()->sign_place(group, name, expr)
+--- <
+---           *sign_placelist()*
+--- @param id any
+--- @param group any
+--- @param name string
+--- @param buf any
+--- @param dict? any
+--- @return any
+function vim.fn.sign_place(id, group, name, buf, dict) end
+
+--- Place one or more signs.  This is similar to the
+--- |sign_place()| function.  The {list} argument specifies the
+--- List of signs to place. Each list item is a dict with the
+--- following sign attributes:
+---     buffer  Buffer name or number. For the accepted
+---     values, see |bufname()|.
+---     group  Sign group. {group} functions as a namespace
+---     for {id}, thus two groups can use the same
+---     IDs. If not specified or set to an empty
+---     string, then the global group is used.   See
+---     |sign-group| for more information.
+---     id    Sign identifier. If not specified or zero,
+---     then a new unique identifier is allocated.
+---     Otherwise the specified number is used. See
+---     |sign-identifier| for more information.
+---     lnum  Line number in the buffer where the sign is to
+---     be placed. For the accepted values, see
+---     |line()|.
+---     name  Name of the sign to place. See |sign_define()|
+---     for more information.
+---     priority  Priority of the sign. When multiple signs are
+---     placed on a line, the sign with the highest
+---     priority is used. If not specified, the
+---     default value of 10 is used. See
+---     |sign-priority| for more information.
+---
+--- If {id} refers to an existing sign, then the existing sign is
+--- modified to use the specified {name} and/or {priority}.
+---
+--- Returns a List of sign identifiers. If failed to place a
+--- sign, the corresponding list item is set to -1.
+---
+--- Examples: >
+---   " Place sign s1 with id 5 at line 20 and id 10 at line
+---   " 30 in buffer a.c
+---   let [n1, n2] = sign_placelist([
+---     \ {'id' : 5,
+---     \  'name' : 's1',
+---     \  'buffer' : 'a.c',
+---     \  'lnum' : 20},
+---     \ {'id' : 10,
+---     \  'name' : 's1',
+---     \  'buffer' : 'a.c',
+---     \  'lnum' : 30}
+---     \ ])
+---
+---   " Place sign s1 in buffer a.c at line 40 and 50
+---   " with auto-generated identifiers
+---   let [n1, n2] = sign_placelist([
+---     \ {'name' : 's1',
+---     \  'buffer' : 'a.c',
+---     \  'lnum' : 40},
+---     \ {'name' : 's1',
+---     \  'buffer' : 'a.c',
+---     \  'lnum' : 50}
+---     \ ])
+--- <
+--- Can also be used as a |method|: >
+---   GetSignlist()->sign_placelist()
+---
+--- @param list any
+--- @return any
+function vim.fn.sign_placelist(list) end
+
+--- Deletes a previously defined sign {name}. This is similar to
+--- the |:sign-undefine| command. If {name} is not supplied, then
+--- deletes all the defined signs.
+---
+--- The one argument {list} can be used to undefine a list of
+--- signs. Each list item is the name of a sign.
+---
+--- Returns 0 on success and -1 on failure.  For the one argument
+--- {list} call, returns a list of values one for each undefined
+--- sign.
+---
+--- Examples: >
+---   " Delete a sign named mySign
+---   call sign_undefine("mySign")
+---
+---   " Delete signs 'sign1' and 'sign2'
+---   call sign_undefine(["sign1", "sign2"])
+---
+---   " Delete all the signs
+---   call sign_undefine()
+--- <
+--- Can also be used as a |method|: >
+---   GetSignlist()->sign_undefine()
+---
+--- @param list? any
+--- @return any
+function vim.fn.sign_undefine(list) end
+
+--- Remove a previously placed sign in one or more buffers.  This
+--- is similar to the |:sign-unplace| command.
+---
+--- {group} is the sign group name. To use the global sign group,
+--- use an empty string.  If {group} is set to "*", then all the
+--- groups including the global group are used.
+--- The signs in {group} are selected based on the entries in
+--- {dict}.  The following optional entries in {dict} are
+--- supported:
+---   buffer  buffer name or number. See |bufname()|.
+---   id  sign identifier
+--- If {dict} is not supplied, then all the signs in {group} are
+--- removed.
+---
+--- Returns 0 on success and -1 on failure.
+---
+--- Examples: >
+---   " Remove sign 10 from buffer a.vim
+---   call sign_unplace('', {'buffer' : "a.vim", 'id' : 10})
+---
+---   " Remove sign 20 in group 'g1' from buffer 3
+---   call sign_unplace('g1', {'buffer' : 3, 'id' : 20})
+---
+---   " Remove all the signs in group 'g2' from buffer 10
+---   call sign_unplace('g2', {'buffer' : 10})
+---
+---   " Remove sign 30 in group 'g3' from all the buffers
+---   call sign_unplace('g3', {'id' : 30})
+---
+---   " Remove all the signs placed in buffer 5
+---   call sign_unplace('*', {'buffer' : 5})
+---
+---   " Remove the signs in group 'g4' from all the buffers
+---   call sign_unplace('g4')
+---
+---   " Remove sign 40 from all the buffers
+---   call sign_unplace('*', {'id' : 40})
+---
+---   " Remove all the placed signs from all the buffers
+---   call sign_unplace('*')
+---
+--- <Can also be used as a |method|: >
+---   GetSigngroup()->sign_unplace()
+--- <
+--- @param group any
+--- @param dict? any
+--- @return any
+function vim.fn.sign_unplace(group, dict) end
+
+--- Remove previously placed signs from one or more buffers.  This
+--- is similar to the |sign_unplace()| function.
+---
+--- The {list} argument specifies the List of signs to remove.
+--- Each list item is a dict with the following sign attributes:
+---     buffer  buffer name or number. For the accepted
+---     values, see |bufname()|. If not specified,
+---     then the specified sign is removed from all
+---     the buffers.
+---     group  sign group name. If not specified or set to an
+---     empty string, then the global sign group is
+---     used. If set to "*", then all the groups
+---     including the global group are used.
+---     id    sign identifier. If not specified, then all
+---     the signs in the specified group are removed.
+---
+--- Returns a List where an entry is set to 0 if the corresponding
+--- sign was successfully removed or -1 on failure.
+---
+--- Example: >
+---   " Remove sign with id 10 from buffer a.vim and sign
+---   " with id 20 from buffer b.vim
+---   call sign_unplacelist([
+---     \ {'id' : 10, 'buffer' : "a.vim"},
+---     \ {'id' : 20, 'buffer' : 'b.vim'},
+---     \ ])
+--- <
+--- Can also be used as a |method|: >
+---   GetSignlist()->sign_unplacelist()
+--- <
+---
+--- @param list any
+--- @return any
+function vim.fn.sign_unplacelist(list) end
+
+--- Simplify the file name as much as possible without changing
+--- the meaning.  Shortcuts (on MS-Windows) or symbolic links (on
+--- Unix) are not resolved.  If the first path component in
+--- {filename} designates the current directory, this will be
+--- valid for the result as well.  A trailing path separator is
+--- not removed either. On Unix "//path" is unchanged, but
+--- "///path" is simplified to "/path" (this follows the Posix
+--- standard).
+--- Example: >
+---   simplify("./dir/.././/file/") == "./file/"
+--- <Note: The combination "dir/.." is only removed if "dir" is
+--- a searchable directory or does not exist.  On Unix, it is also
+--- removed when "dir" is a symbolic link within the same
+--- directory.  In order to resolve all the involved symbolic
+--- links before simplifying the path name, use |resolve()|.
+---
+--- Can also be used as a |method|: >
+---   GetName()->simplify()
+---
+--- @param filename any
+--- @return any
+function vim.fn.simplify(filename) end
+
+--- Return the sine of {expr}, measured in radians, as a |Float|.
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo sin(100)
+--- <  -0.506366 >
+---   :echo sin(-4.01)
+--- <  0.763301
+---
+--- Can also be used as a |method|: >
+---   Compute()->sin()
+---
+--- @param expr any
+--- @return any
+function vim.fn.sin(expr) end
+
+--- Return the hyperbolic sine of {expr} as a |Float| in the range
+--- [-inf, inf].
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo sinh(0.5)
+--- <  0.521095 >
+---   :echo sinh(-0.9)
+--- <  -1.026517
+---
+--- Can also be used as a |method|: >
+---   Compute()->sinh()
+---
+--- @param expr any
+--- @return any
+function vim.fn.sinh(expr) end
+
+--- Similar to using a |slice| "expr[start : end]", but "end" is
+--- used exclusive.  And for a string the indexes are used as
+--- character indexes instead of byte indexes.
+--- Also, composing characters are not counted.
+--- When {end} is omitted the slice continues to the last item.
+--- When {end} is -1 the last item is omitted.
+--- Returns an empty value if {start} or {end} are invalid.
+---
+--- Can also be used as a |method|: >
+---   GetList()->slice(offset)
+---
+---
+--- @param expr any
+--- @param start any
+--- @param end_? any
+--- @return any
+function vim.fn.slice(expr, start, end_) end
+
+--- Connect a socket to an address. If {mode} is "pipe" then
+--- {address} should be the path of a local domain socket (on
+--- unix) or named pipe (on Windows). If {mode} is "tcp" then
+--- {address} should be of the form "host:port" where the host
+--- should be an ip adderess or host name, and port the port
+--- number.
+---
+--- For "pipe" mode, see |luv-pipe-handle|. For "tcp" mode, see
+--- |luv-tcp-handle|.
+---
+--- Returns a |channel| ID. Close the socket with |chanclose()|.
+--- Use |chansend()| to send data over a bytes socket, and
+--- |rpcrequest()| and |rpcnotify()| to communicate with a RPC
+--- socket.
+---
+--- {opts} is an optional dictionary with these keys:
+---   |on_data| : callback invoked when data was read from socket
+---   data_buffered : read socket data in |channel-buffered| mode.
+---   rpc     : If set, |msgpack-rpc| will be used to communicate
+---       over the socket.
+--- Returns:
+---   - The channel ID on success (greater than zero)
+---   - 0 on invalid arguments or connection failure.
+---
+--- @param mode string
+--- @param address any
+--- @param opts? table
+--- @return any
+function vim.fn.sockconnect(mode, address, opts) end
+
+--- Sort the items in {list} in-place.  Returns {list}.
+---
+--- If you want a list to remain unmodified make a copy first: >
+---   :let sortedlist = sort(copy(mylist))
+---
+--- <When {func} is omitted, is empty or zero, then sort() uses the
+--- string representation of each item to sort on.  Numbers sort
+--- after Strings, |Lists| after Numbers.  For sorting text in the
+--- current buffer use |:sort|.
+---
+--- When {func} is given and it is '1' or 'i' then case is
+--- ignored.
+---
+--- When {func} is given and it is 'l' then the current collation
+--- locale is used for ordering. Implementation details: strcoll()
+--- is used to compare strings. See |:language| check or set the
+--- collation locale. |v:collate| can also be used to check the
+--- current locale. Sorting using the locale typically ignores
+--- case. Example: >
+---   " ö is sorted similarly to o with English locale.
+---   :language collate en_US.UTF8
+---   :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
+--- <  ['n', 'o', 'O', 'ö', 'p', 'z'] ~
+--- >
+---   " ö is sorted after z with Swedish locale.
+---   :language collate sv_SE.UTF8
+---   :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
+--- <  ['n', 'o', 'O', 'p', 'z', 'ö'] ~
+--- This does not work properly on Mac.
+---
+--- When {func} is given and it is 'n' then all items will be
+--- sorted numerical (Implementation detail: this uses the
+--- strtod() function to parse numbers, Strings, Lists, Dicts and
+--- Funcrefs will be considered as being 0).
+---
+--- When {func} is given and it is 'N' then all items will be
+--- sorted numerical. This is like 'n' but a string containing
+--- digits will be used as the number they represent.
+---
+--- When {func} is given and it is 'f' then all items will be
+--- sorted numerical. All values must be a Number or a Float.
+---
+--- When {func} is a |Funcref| or a function name, this function
+--- is called to compare items.  The function is invoked with two
+--- items as argument and must return zero if they are equal, 1 or
+--- bigger if the first one sorts after the second one, -1 or
+--- smaller if the first one sorts before the second one.
+---
+--- {dict} is for functions with the "dict" attribute.  It will be
+--- used to set the local variable "self". |Dictionary-function|
+---
+--- The sort is stable, items which compare equal (as number or as
+--- string) will keep their relative position. E.g., when sorting
+--- on numbers, text strings will sort next to each other, in the
+--- same order as they were originally.
+---
+--- Can also be used as a |method|: >
+---   mylist->sort()
+---
+--- <Also see |uniq()|.
+---
+--- Example: >
+---   func MyCompare(i1, i2)
+---      return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
+---   endfunc
+---   eval mylist->sort("MyCompare")
+--- <A shorter compare version for this specific simple case, which
+--- ignores overflow: >
+---   func MyCompare(i1, i2)
+---      return a:i1 - a:i2
+---   endfunc
+--- <For a simple expression you can use a lambda: >
+---   eval mylist->sort({i1, i2 -> i1 - i2})
+--- <
+---           *soundfold()*
+--- @param list any
+--- @param func? any
+--- @param dict? any
+--- @return any
+function vim.fn.sort(list, func, dict) end
+
+--- Return the sound-folded equivalent of {word}.  Uses the first
+--- language in 'spelllang' for the current window that supports
+--- soundfolding.  'spell' must be set.  When no sound folding is
+--- possible the {word} is returned unmodified.
+--- This can be used for making spelling suggestions.  Note that
+--- the method can be quite slow.
+---
+--- Can also be used as a |method|: >
+---   GetWord()->soundfold()
+--- <
+---           *spellbadword()*
+--- @param word any
+--- @return any
+function vim.fn.soundfold(word) end
+
+--- Without argument: The result is the badly spelled word under
+--- or after the cursor.  The cursor is moved to the start of the
+--- bad word.  When no bad word is found in the cursor line the
+--- result is an empty string and the cursor doesn't move.
+---
+--- With argument: The result is the first word in {sentence} that
+--- is badly spelled.  If there are no spelling mistakes the
+--- result is an empty string.
+---
+--- The return value is a list with two items:
+--- - The badly spelled word or an empty string.
+--- - The type of the spelling error:
+---   "bad"    spelling mistake
+---   "rare"    rare word
+---   "local"    word only valid in another region
+---   "caps"    word should start with Capital
+--- Example: >
+---   echo spellbadword("the quik brown fox")
+--- <  ['quik', 'bad'] ~
+---
+--- The spelling information for the current window and the value
+--- of 'spelllang' are used.
+---
+--- Can also be used as a |method|: >
+---   GetText()->spellbadword()
+--- <
+---           *spellsuggest()*
+--- @param sentence? any
+--- @return any
+function vim.fn.spellbadword(sentence) end
+
+--- Return a |List| with spelling suggestions to replace {word}.
+--- When {max} is given up to this number of suggestions are
+--- returned.  Otherwise up to 25 suggestions are returned.
+---
+--- When the {capital} argument is given and it's non-zero only
+--- suggestions with a leading capital will be given.  Use this
+--- after a match with 'spellcapcheck'.
+---
+--- {word} can be a badly spelled word followed by other text.
+--- This allows for joining two words that were split.  The
+--- suggestions also include the following text, thus you can
+--- replace a line.
+---
+--- {word} may also be a good word.  Similar words will then be
+--- returned.  {word} itself is not included in the suggestions,
+--- although it may appear capitalized.
+---
+--- The spelling information for the current window is used.  The
+--- values of 'spelllang' and 'spellsuggest' are used.
+---
+--- Can also be used as a |method|: >
+---   GetWord()->spellsuggest()
+---
+--- @param word any
+--- @param max? any
+--- @param capital? any
+--- @return any
+function vim.fn.spellsuggest(word, max, capital) end
+
+--- Make a |List| out of {string}.  When {pattern} is omitted or
+--- empty each white-separated sequence of characters becomes an
+--- item.
+--- Otherwise the string is split where {pattern} matches,
+--- removing the matched characters. 'ignorecase' is not used
+--- here, add \c to ignore case. |/\c|
+--- When the first or last item is empty it is omitted, unless the
+--- {keepempty} argument is given and it's non-zero.
+--- Other empty items are kept when {pattern} matches at least one
+--- character or when {keepempty} is non-zero.
+--- Example: >
+---   :let words = split(getline('.'), '\W\+')
+--- <To split a string in individual characters: >
+---   :for c in split(mystring, '\zs')
+--- <If you want to keep the separator you can also use '\zs' at
+--- the end of the pattern: >
+---   :echo split('abc:def:ghi', ':\zs')
+--- <  ['abc:', 'def:', 'ghi'] ~
+--- Splitting a table where the first element can be empty: >
+---   :let items = split(line, ':', 1)
+--- <The opposite function is |join()|.
+---
+--- Can also be used as a |method|: >
+---   GetString()->split()
+---
+--- @param string string
+--- @param pattern? any
+--- @param keepempty? any
+--- @return any
+function vim.fn.split(string, pattern, keepempty) end
+
+--- Return the non-negative square root of Float {expr} as a
+--- |Float|.
+--- {expr} must evaluate to a |Float| or a |Number|.  When {expr}
+--- is negative the result is NaN (Not a Number).  Returns 0.0 if
+--- {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo sqrt(100)
+--- <  10.0 >
+---   :echo sqrt(-4.01)
+--- <  str2float("nan")
+--- NaN may be different, it depends on system libraries.
+---
+--- Can also be used as a |method|: >
+---   Compute()->sqrt()
+---
+--- @param expr any
+--- @return any
+function vim.fn.sqrt(expr) end
+
+--- Initialize seed used by |rand()|:
+--- - If {expr} is not given, seed values are initialized by
+---   reading from /dev/urandom, if possible, or using time(NULL)
+---   a.k.a. epoch time otherwise; this only has second accuracy.
+--- - If {expr} is given it must be a Number.  It is used to
+---   initialize the seed values.  This is useful for testing or
+---   when a predictable sequence is intended.
+---
+--- Examples: >
+---   :let seed = srand()
+---   :let seed = srand(userinput)
+---   :echo rand(seed)
+--- <
+--- Can also be used as a |method|: >
+---   userinput->srand()
+---
+--- @param expr? any
+--- @return any
+function vim.fn.srand(expr) end
+
+--- With |--headless| this opens stdin and stdout as a |channel|.
+--- May be called only once. See |channel-stdio|. stderr is not
+--- handled by this function, see |v:stderr|.
+---
+--- Close the stdio handles with |chanclose()|. Use |chansend()|
+--- to send data to stdout, and |rpcrequest()| and |rpcnotify()|
+--- to communicate over RPC.
+---
+--- {opts} is a dictionary with these keys:
+---   |on_stdin| : callback invoked when stdin is written to.
+---   on_print : callback invoked when Nvim needs to print a
+---        message, with the message (whose type is string)
+---        as sole argument.
+---   stdin_buffered : read stdin in |channel-buffered| mode.
+---   rpc      : If set, |msgpack-rpc| will be used to communicate
+---        over stdio
+--- Returns:
+---   - |channel-id| on success (value is always 1)
+---   - 0 on invalid arguments
+---
+---
+--- @param opts table
+--- @return any
+function vim.fn.stdioopen(opts) end
+
+--- Returns |standard-path| locations of various default files and
+--- directories.
+---
+--- {what}       Type    Description ~
+--- cache        String  Cache directory: arbitrary temporary
+---                      storage for plugins, etc.
+--- config       String  User configuration directory. |init.vim|
+---                      is stored here.
+--- config_dirs  List    Other configuration directories.
+--- data         String  User data directory.
+--- data_dirs    List    Other data directories.
+--- log          String  Logs directory (for use by plugins too).
+--- run          String  Run directory: temporary, local storage
+---          for sockets, named pipes, etc.
+--- state        String  Session state directory: storage for file
+---          drafts, swap, undo, |shada|.
+---
+--- Example: >
+---   :echo stdpath("config")
+---
+---
+--- @param what any
+--- @return any
+function vim.fn.stdpath(what) end
+
+--- Convert String {string} to a Float.  This mostly works the
+--- same as when using a floating point number in an expression,
+--- see |floating-point-format|.  But it's a bit more permissive.
+--- E.g., "1e40" is accepted, while in an expression you need to
+--- write "1.0e40".  The hexadecimal form "0x123" is also
+--- accepted, but not others, like binary or octal.
+--- When {quoted} is present and non-zero then embedded single
+--- quotes before the dot are ignored, thus "1'000.0" is a
+--- thousand.
+--- Text after the number is silently ignored.
+--- The decimal point is always '.', no matter what the locale is
+--- set to.  A comma ends the number: "12,345.67" is converted to
+--- 12.0.  You can strip out thousands separators with
+--- |substitute()|: >
+---   let f = str2float(substitute(text, ',', '', 'g'))
+--- <
+--- Returns 0.0 if the conversion fails.
+---
+--- Can also be used as a |method|: >
+---   let f = text->substitute(',', '', 'g')->str2float()
+---
+--- @param string string
+--- @param quoted? any
+--- @return any
+function vim.fn.str2float(string, quoted) end
+
+--- Return a list containing the number values which represent
+--- each character in String {string}.  Examples: >
+---   str2list(" ")    returns [32]
+---   str2list("ABC")    returns [65, 66, 67]
+--- <|list2str()| does the opposite.
+---
+--- UTF-8 encoding is always used, {utf8} option has no effect,
+--- and exists only for backwards-compatibility.
+--- With UTF-8 composing characters are handled properly: >
+---   str2list("á")    returns [97, 769]
+---
+--- <Can also be used as a |method|: >
+---   GetString()->str2list()
+---
+--- @param string string
+--- @param utf8? any
+--- @return any
+function vim.fn.str2list(string, utf8) end
+
+--- Convert string {string} to a number.
+--- {base} is the conversion base, it can be 2, 8, 10 or 16.
+--- When {quoted} is present and non-zero then embedded single
+--- quotes are ignored, thus "1'000'000" is a million.
+---
+--- When {base} is omitted base 10 is used.  This also means that
+--- a leading zero doesn't cause octal conversion to be used, as
+--- with the default String to Number conversion.  Example: >
+---   let nr = str2nr('0123')
+--- <
+--- When {base} is 16 a leading "0x" or "0X" is ignored.  With a
+--- different base the result will be zero. Similarly, when
+--- {base} is 8 a leading "0", "0o" or "0O" is ignored, and when
+--- {base} is 2 a leading "0b" or "0B" is ignored.
+--- Text after the number is silently ignored.
+---
+--- Returns 0 if {string} is empty or on error.
+---
+--- Can also be used as a |method|: >
+---   GetText()->str2nr()
+---
+---
+--- @param string string
+--- @param base? any
+--- @return any
+function vim.fn.str2nr(string, base) end
+
+--- The result is a Number, which is the number of characters
+--- in String {string}.  Composing characters are ignored.
+--- |strchars()| can count the number of characters, counting
+--- composing characters separately.
+---
+--- Returns 0 if {string} is empty or on error.
+---
+--- Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
+---
+--- Can also be used as a |method|: >
+---   GetText()->strcharlen()
+---
+---
+--- @param string string
+--- @return any
+function vim.fn.strcharlen(string) end
+
+--- Like |strpart()| but using character index and length instead
+--- of byte index and length.
+--- When {skipcc} is omitted or zero, composing characters are
+--- counted separately.
+--- When {skipcc} set to 1, Composing characters are ignored,
+--- similar to  |slice()|.
+--- When a character index is used where a character does not
+--- exist it is omitted and counted as one character.  For
+--- example: >
+---   strcharpart('abc', -1, 2)
+--- <results in 'a'.
+---
+--- Returns an empty string on error.
+---
+--- Can also be used as a |method|: >
+---   GetText()->strcharpart(5)
+---
+---
+--- @param src any
+--- @param start any
+--- @param len? any
+--- @param skipcc? any
+--- @return any
+function vim.fn.strcharpart(src, start, len, skipcc) end
+
+--- The result is a Number, which is the number of characters
+--- in String {string}.
+--- When {skipcc} is omitted or zero, composing characters are
+--- counted separately.
+--- When {skipcc} set to 1, Composing characters are ignored.
+--- |strcharlen()| always does this.
+---
+--- Returns zero on error.
+---
+--- Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
+---
+--- {skipcc} is only available after 7.4.755.  For backward
+--- compatibility, you can define a wrapper function: >
+---     if has("patch-7.4.755")
+---       function s:strchars(str, skipcc)
+---   return strchars(a:str, a:skipcc)
+---       endfunction
+---     else
+---       function s:strchars(str, skipcc)
+---   if a:skipcc
+---     return strlen(substitute(a:str, ".", "x", "g"))
+---   else
+---     return strchars(a:str)
+---   endif
+---       endfunction
+---     endif
+--- <
+--- Can also be used as a |method|: >
+---   GetText()->strchars()
+---
+--- @param string string
+--- @param skipcc? any
+--- @return any
+function vim.fn.strchars(string, skipcc) end
+
+--- The result is a Number, which is the number of display cells
+--- String {string} occupies on the screen when it starts at {col}
+--- (first column is zero).  When {col} is omitted zero is used.
+--- Otherwise it is the screen column where to start.  This
+--- matters for Tab characters.
+--- The option settings of the current window are used.  This
+--- matters for anything that's displayed differently, such as
+--- 'tabstop' and 'display'.
+--- When {string} contains characters with East Asian Width Class
+--- Ambiguous, this function's return value depends on 'ambiwidth'.
+--- Returns zero on error.
+--- Also see |strlen()|, |strwidth()| and |strchars()|.
+---
+--- Can also be used as a |method|: >
+---   GetText()->strdisplaywidth()
+---
+--- @param string string
+--- @param col? integer
+--- @return any
+function vim.fn.strdisplaywidth(string, col) end
+
+--- The result is a String, which is a formatted date and time, as
+--- specified by the {format} string.  The given {time} is used,
+--- or the current time if no time is given.  The accepted
+--- {format} depends on your system, thus this is not portable!
+--- See the manual page of the C function strftime() for the
+--- format.  The maximum length of the result is 80 characters.
+--- See also |localtime()|, |getftime()| and |strptime()|.
+--- The language can be changed with the |:language| command.
+--- Examples: >
+---   :echo strftime("%c")       Sun Apr 27 11:49:23 1997
+---   :echo strftime("%Y %b %d %X")     1997 Apr 27 11:53:25
+---   :echo strftime("%y%m%d %T")     970427 11:53:55
+---   :echo strftime("%H:%M")     11:55
+---   :echo strftime("%c", getftime("file.c"))
+---            Show mod time of file.c.
+---
+--- <Can also be used as a |method|: >
+---   GetFormat()->strftime()
+---
+--- @param format any
+--- @param time? any
+--- @return any
+function vim.fn.strftime(format, time) end
+
+--- Get a Number corresponding to the character at {index} in
+--- {str}.  This uses a zero-based character index, not a byte
+--- index.  Composing characters are considered separate
+--- characters here.  Use |nr2char()| to convert the Number to a
+--- String.
+--- Returns -1 if {index} is invalid.
+--- Also see |strcharpart()| and |strchars()|.
+---
+--- Can also be used as a |method|: >
+---   GetText()->strgetchar(5)
+---
+--- @param str any
+--- @param index any
+--- @return any
+function vim.fn.strgetchar(str, index) end
+
+--- The result is a Number, which gives the byte index in
+--- {haystack} of the first occurrence of the String {needle}.
+--- If {start} is specified, the search starts at index {start}.
+--- This can be used to find a second match: >
+---   :let colon1 = stridx(line, ":")
+---   :let colon2 = stridx(line, ":", colon1 + 1)
+--- <The search is done case-sensitive.
+--- For pattern searches use |match()|.
+--- -1 is returned if the {needle} does not occur in {haystack}.
+--- See also |strridx()|.
+--- Examples: >
+---   :echo stridx("An Example", "Example")       3
+---   :echo stridx("Starting point", "Start")    0
+---   :echo stridx("Starting point", "start")   -1
+--- <        *strstr()* *strchr()*
+--- stridx() works similar to the C function strstr().  When used
+--- with a single character it works similar to strchr().
+---
+--- Can also be used as a |method|: >
+---   GetHaystack()->stridx(needle)
+--- <
+---           *string()*
+--- @param haystack any
+--- @param needle any
+--- @param start? any
+--- @return any
+function vim.fn.stridx(haystack, needle, start) end
+
+--- Float, String, Blob or a composition of them, then the result
+--- can be parsed back with |eval()|.
+---   {expr} type  result ~
+---   String    'string'
+---   Number    123
+---   Float    123.123456 or 1.123456e8 or
+---       `str2float('inf')`
+---   Funcref    `function('name')`
+---   Blob    0z00112233.44556677.8899
+---   List    [item, item]
+---   Dictionary  `{key: value, key: value}`
+--- Note that in String values the ' character is doubled.
+--- Also see |strtrans()|.
+--- Note 2: Output format is mostly compatible with YAML, except
+--- for infinite and NaN floating-point values representations
+--- which use |str2float()|.  Strings are also dumped literally,
+--- only single quote is escaped, which does not allow using YAML
+--- for parsing back binary strings.  |eval()| should always work for
+--- strings and floats though and this is the only official
+--- method, use |msgpackdump()| or |json_encode()| if you need to
+--- share data with other application.
+---
+--- Can also be used as a |method|: >
+---   mylist->string()
+---
+--- @param expr any
+--- @return any
+function vim.fn.string(expr) end
+
+--- The result is a Number, which is the length of the String
+--- {string} in bytes.
+--- If the argument is a Number it is first converted to a String.
+--- For other types an error is given and zero is returned.
+--- If you want to count the number of multibyte characters use
+--- |strchars()|.
+--- Also see |len()|, |strdisplaywidth()| and |strwidth()|.
+---
+--- Can also be used as a |method|: >
+---   GetString()->strlen()
+---
+--- @param string string
+--- @return any
+function vim.fn.strlen(string) end
+
+--- The result is a String, which is part of {src}, starting from
+--- byte {start}, with the byte length {len}.
+--- When {chars} is present and TRUE then {len} is the number of
+--- characters positions (composing characters are not counted
+--- separately, thus "1" means one base character and any
+--- following composing characters).
+--- To count {start} as characters instead of bytes use
+--- |strcharpart()|.
+---
+--- When bytes are selected which do not exist, this doesn't
+--- result in an error, the bytes are simply omitted.
+--- If {len} is missing, the copy continues from {start} till the
+--- end of the {src}. >
+---   strpart("abcdefg", 3, 2)    == "de"
+---   strpart("abcdefg", -2, 4)   == "ab"
+---   strpart("abcdefg", 5, 4)    == "fg"
+---   strpart("abcdefg", 3)      == "defg"
+---
+--- <Note: To get the first character, {start} must be 0.  For
+--- example, to get the character under the cursor: >
+---   strpart(getline("."), col(".") - 1, 1, v:true)
+--- <
+--- Returns an empty string on error.
+---
+--- Can also be used as a |method|: >
+---   GetText()->strpart(5)
+---
+--- @param src any
+--- @param start any
+--- @param len? any
+--- @param chars? any
+--- @return any
+function vim.fn.strpart(src, start, len, chars) end
+
+--- The result is a Number, which is a unix timestamp representing
+--- the date and time in {timestring}, which is expected to match
+--- the format specified in {format}.
+---
+--- The accepted {format} depends on your system, thus this is not
+--- portable!  See the manual page of the C function strptime()
+--- for the format.  Especially avoid "%c".  The value of $TZ also
+--- matters.
+---
+--- If the {timestring} cannot be parsed with {format} zero is
+--- returned.  If you do not know the format of {timestring} you
+--- can try different {format} values until you get a non-zero
+--- result.
+---
+--- See also |strftime()|.
+--- Examples: >
+---   :echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23")
+--- <  862156163 >
+---   :echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55"))
+--- <  Sun Apr 27 11:53:55 1997 >
+---   :echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
+--- <  Sun Apr 27 12:53:55 1997
+---
+--- Can also be used as a |method|: >
+---   GetFormat()->strptime(timestring)
+--- <
+--- @param format any
+--- @param timestring any
+--- @return any
+function vim.fn.strptime(format, timestring) end
+
+--- The result is a Number, which gives the byte index in
+--- {haystack} of the last occurrence of the String {needle}.
+--- When {start} is specified, matches beyond this index are
+--- ignored.  This can be used to find a match before a previous
+--- match: >
+---   :let lastcomma = strridx(line, ",")
+---   :let comma2 = strridx(line, ",", lastcomma - 1)
+--- <The search is done case-sensitive.
+--- For pattern searches use |match()|.
+--- -1 is returned if the {needle} does not occur in {haystack}.
+--- If the {needle} is empty the length of {haystack} is returned.
+--- See also |stridx()|.  Examples: >
+---   :echo strridx("an angry armadillo", "an")       3
+--- <          *strrchr()*
+--- When used with a single character it works similar to the C
+--- function strrchr().
+---
+--- Can also be used as a |method|: >
+---   GetHaystack()->strridx(needle)
+---
+--- @param haystack any
+--- @param needle any
+--- @param start? any
+--- @return any
+function vim.fn.strridx(haystack, needle, start) end
+
+--- The result is a String, which is {string} with all unprintable
+--- characters translated into printable characters |'isprint'|.
+--- Like they are shown in a window.  Example: >
+---   echo strtrans(\@a)
+--- <This displays a newline in register a as "^\@" instead of
+--- starting a new line.
+---
+--- Returns an empty string on error.
+---
+--- Can also be used as a |method|: >
+---   GetString()->strtrans()
+---
+--- @param string string
+--- @return any
+function vim.fn.strtrans(string) end
+
+--- The result is a Number, which is the number of UTF-16 code
+--- units in String {string} (after converting it to UTF-16).
+---
+--- When {countcc} is TRUE, composing characters are counted
+--- separately.
+--- When {countcc} is omitted or FALSE, composing characters are
+--- ignored.
+---
+--- Returns zero on error.
+---
+--- Also see |strlen()| and |strcharlen()|.
+--- Examples: >
+---     echo strutf16len('a')    returns 1
+---     echo strutf16len('©')    returns 1
+---     echo strutf16len('😊')    returns 2
+---     echo strutf16len('ą́')    returns 1
+---     echo strutf16len('ą́', v:true)  returns 3
+---
+--- Can also be used as a |method|: >
+---   GetText()->strutf16len()
+--- <
+--- @param string string
+--- @param countcc? any
+--- @return any
+function vim.fn.strutf16len(string, countcc) end
+
+--- The result is a Number, which is the number of display cells
+--- String {string} occupies.  A Tab character is counted as one
+--- cell, alternatively use |strdisplaywidth()|.
+--- When {string} contains characters with East Asian Width Class
+--- Ambiguous, this function's return value depends on 'ambiwidth'.
+--- Returns zero on error.
+--- Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
+---
+--- Can also be used as a |method|: >
+---   GetString()->strwidth()
+---
+--- @param string string
+--- @return any
+function vim.fn.strwidth(string) end
+
+--- Only for an expression in a |:substitute| command or
+--- substitute() function.
+--- Returns the {nr}th submatch of the matched text.  When {nr}
+--- is 0 the whole matched text is returned.
+--- Note that a NL in the string can stand for a line break of a
+--- multi-line match or a NUL character in the text.
+--- Also see |sub-replace-expression|.
+---
+--- If {list} is present and non-zero then submatch() returns
+--- a list of strings, similar to |getline()| with two arguments.
+--- NL characters in the text represent NUL characters in the
+--- text.
+--- Only returns more than one item for |:substitute|, inside
+--- |substitute()| this list will always contain one or zero
+--- items, since there are no real line breaks.
+---
+--- When substitute() is used recursively only the submatches in
+--- the current (deepest) call can be obtained.
+---
+--- Returns an empty string or list on error.
+---
+--- Examples: >
+---   :s/\d\+/\=submatch(0) + 1/
+---   :echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
+--- <This finds the first number in the line and adds one to it.
+--- A line break is included as a newline character.
+---
+--- Can also be used as a |method|: >
+---   GetNr()->submatch()
+---
+--- @param nr integer
+--- @param list? any
+--- @return any
+function vim.fn.submatch(nr, list) end
+
+--- The result is a String, which is a copy of {string}, in which
+--- the first match of {pat} is replaced with {sub}.
+--- When {flags} is "g", all matches of {pat} in {string} are
+--- replaced.  Otherwise {flags} should be "".
+---
+--- This works like the ":substitute" command (without any flags).
+--- But the matching with {pat} is always done like the 'magic'
+--- option is set and 'cpoptions' is empty (to make scripts
+--- portable).  'ignorecase' is still relevant, use |/\c| or |/\C|
+--- if you want to ignore or match case and ignore 'ignorecase'.
+--- 'smartcase' is not used.  See |string-match| for how {pat} is
+--- used.
+---
+--- A "~" in {sub} is not replaced with the previous {sub}.
+--- Note that some codes in {sub} have a special meaning
+--- |sub-replace-special|.  For example, to replace something with
+--- "\n" (two characters), use "\\\\n" or '\\n'.
+---
+--- When {pat} does not match in {string}, {string} is returned
+--- unmodified.
+---
+--- Example: >
+---   :let &path = substitute(&path, ",\\=[^,]*$", "", "")
+--- <This removes the last component of the 'path' option. >
+---   :echo substitute("testing", ".*", "\\U\\0", "")
+--- <results in "TESTING".
+---
+--- When {sub} starts with "\=", the remainder is interpreted as
+--- an expression. See |sub-replace-expression|.  Example: >
+---   :echo substitute(s, '%\(\x\x\)',
+---      \ '\=nr2char("0x" .. submatch(1))', 'g')
+---
+--- <When {sub} is a Funcref that function is called, with one
+--- optional argument.  Example: >
+---    :echo substitute(s, '%\(\x\x\)', SubNr, 'g')
+--- <The optional argument is a list which contains the whole
+--- matched string and up to nine submatches, like what
+--- |submatch()| returns.  Example: >
+---    :echo substitute(s, '%\(\x\x\)', {m -> '0x' .. m[1]}, 'g')
+---
+--- <Returns an empty string on error.
+---
+--- Can also be used as a |method|: >
+---   GetString()->substitute(pat, sub, flags)
+---
+--- @param string string
+--- @param pat any
+--- @param sub any
+--- @param flags string
+--- @return any
+function vim.fn.substitute(string, pat, sub, flags) end
+
+--- Returns a list of swap file names, like what "vim -r" shows.
+--- See the |-r| command argument.  The 'directory' option is used
+--- for the directories to inspect.  If you only want to get a
+--- list of swap files in the current directory then temporarily
+--- set 'directory' to a dot: >
+---   let save_dir = &directory
+---   let &directory = '.'
+---   let swapfiles = swapfilelist()
+---   let &directory = save_dir
+---
+--- @return any
+function vim.fn.swapfilelist() end
+
+--- The result is a dictionary, which holds information about the
+--- swapfile {fname}. The available fields are:
+---   version Vim version
+---   user  user name
+---   host  host name
+---   fname  original file name
+---   pid  PID of the Vim process that created the swap
+---     file
+---   mtime  last modification time in seconds
+---   inode  Optional: INODE number of the file
+---   dirty  1 if file was modified, 0 if not
+--- In case of failure an "error" item is added with the reason:
+---   Cannot open file: file not found or in accessible
+---   Cannot read file: cannot read first block
+---   Not a swap file: does not contain correct block ID
+---   Magic number mismatch: Info in first block is invalid
+---
+--- Can also be used as a |method|: >
+---   GetFilename()->swapinfo()
+---
+--- @param fname integer
+--- @return any
+function vim.fn.swapinfo(fname) end
+
+--- The result is the swap file path of the buffer {buf}.
+--- For the use of {buf}, see |bufname()| above.
+--- If buffer {buf} is the current buffer, the result is equal to
+--- |:swapname| (unless there is no swap file).
+--- If buffer {buf} has no swap file, returns an empty string.
+---
+--- Can also be used as a |method|: >
+---   GetBufname()->swapname()
+---
+--- @param buf any
+--- @return any
+function vim.fn.swapname(buf) end
+
+--- The result is a Number, which is the syntax ID at the position
+--- {lnum} and {col} in the current window.
+--- The syntax ID can be used with |synIDattr()| and
+--- |synIDtrans()| to obtain syntax information about text.
+---
+--- {col} is 1 for the leftmost column, {lnum} is 1 for the first
+--- line.  'synmaxcol' applies, in a longer line zero is returned.
+--- Note that when the position is after the last character,
+--- that's where the cursor can be in Insert mode, synID() returns
+--- zero.  {lnum} is used like with |getline()|.
+---
+--- When {trans} is |TRUE|, transparent items are reduced to the
+--- item that they reveal.  This is useful when wanting to know
+--- the effective color.  When {trans} is |FALSE|, the transparent
+--- item is returned.  This is useful when wanting to know which
+--- syntax item is effective (e.g. inside parens).
+--- Warning: This function can be very slow.  Best speed is
+--- obtained by going through the file in forward direction.
+---
+--- Returns zero on error.
+---
+--- Example (echoes the name of the syntax item under the cursor): >
+---   :echo synIDattr(synID(line("."), col("."), 1), "name")
+--- <
+---
+--- @param lnum integer
+--- @param col integer
+--- @param trans any
+--- @return any
+function vim.fn.synID(lnum, col, trans) end
+
+--- The result is a String, which is the {what} attribute of
+--- syntax ID {synID}.  This can be used to obtain information
+--- about a syntax item.
+--- {mode} can be "gui" or "cterm", to get the attributes
+--- for that mode.  When {mode} is omitted, or an invalid value is
+--- used, the attributes for the currently active highlighting are
+--- used (GUI or cterm).
+--- Use synIDtrans() to follow linked highlight groups.
+--- {what}    result
+--- "name"    the name of the syntax item
+--- "fg"    foreground color (GUI: color name used to set
+---     the color, cterm: color number as a string,
+---     term: empty string)
+--- "bg"    background color (as with "fg")
+--- "font"    font name (only available in the GUI)
+---     |highlight-font|
+--- "sp"    special color (as with "fg") |guisp|
+--- "fg#"    like "fg", but for the GUI and the GUI is
+---     running the name in "#RRGGBB" form
+--- "bg#"    like "fg#" for "bg"
+--- "sp#"    like "fg#" for "sp"
+--- "bold"    "1" if bold
+--- "italic"  "1" if italic
+--- "reverse"  "1" if reverse
+--- "inverse"  "1" if inverse (= reverse)
+--- "standout"  "1" if standout
+--- "underline"  "1" if underlined
+--- "undercurl"  "1" if undercurled
+--- "underdouble"  "1" if double underlined
+--- "underdotted"  "1" if dotted underlined
+--- "underdashed"  "1" if dashed underlined
+--- "strikethrough"  "1" if struckthrough
+--- "altfont"  "1" if alternative font
+--- "nocombine"  "1" if nocombine
+---
+--- Returns an empty string on error.
+---
+--- Example (echoes the color of the syntax item under the
+--- cursor): >
+---   :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
+--- <
+--- Can also be used as a |method|: >
+---   :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
+---
+--- @param synID any
+--- @param what any
+--- @param mode? string
+--- @return any
+function vim.fn.synIDattr(synID, what, mode) end
+
+--- The result is a Number, which is the translated syntax ID of
+--- {synID}.  This is the syntax group ID of what is being used to
+--- highlight the character.  Highlight links given with
+--- ":highlight link" are followed.
+---
+--- Returns zero on error.
+---
+--- Can also be used as a |method|: >
+---   :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
+---
+--- @param synID any
+--- @return any
+function vim.fn.synIDtrans(synID) end
+
+--- The result is a |List| with currently three items:
+--- 1. The first item in the list is 0 if the character at the
+---    position {lnum} and {col} is not part of a concealable
+---    region, 1 if it is.  {lnum} is used like with |getline()|.
+--- 2. The second item in the list is a string. If the first item
+---    is 1, the second item contains the text which will be
+---    displayed in place of the concealed text, depending on the
+---    current setting of 'conceallevel' and 'listchars'.
+--- 3. The third and final item in the list is a number
+---    representing the specific syntax region matched in the
+---    line. When the character is not concealed the value is
+---    zero. This allows detection of the beginning of a new
+---    concealable region if there are two consecutive regions
+---    with the same replacement character.  For an example, if
+---    the text is "123456" and both "23" and "45" are concealed
+---    and replaced by the character "X", then:
+---   call      returns ~
+---   synconcealed(lnum, 1)   [0, '', 0]
+---   synconcealed(lnum, 2)   [1, 'X', 1]
+---   synconcealed(lnum, 3)   [1, 'X', 1]
+---   synconcealed(lnum, 4)   [1, 'X', 2]
+---   synconcealed(lnum, 5)   [1, 'X', 2]
+---   synconcealed(lnum, 6)   [0, '', 0]
+---
+---
+--- @param lnum integer
+--- @param col integer
+--- @return any
+function vim.fn.synconcealed(lnum, col) end
+
+--- Return a |List|, which is the stack of syntax items at the
+--- position {lnum} and {col} in the current window.  {lnum} is
+--- used like with |getline()|.  Each item in the List is an ID
+--- like what |synID()| returns.
+--- The first item in the List is the outer region, following are
+--- items contained in that one.  The last one is what |synID()|
+--- returns, unless not the whole item is highlighted or it is a
+--- transparent item.
+--- This function is useful for debugging a syntax file.
+--- Example that shows the syntax stack under the cursor: >
+---   for id in synstack(line("."), col("."))
+---      echo synIDattr(id, "name")
+---   endfor
+--- <When the position specified with {lnum} and {col} is invalid
+--- an empty list is returned.  The position just after the last
+--- character in a line and the first column in an empty line are
+--- valid positions.
+---
+--- @param lnum integer
+--- @param col integer
+--- @return any
+function vim.fn.synstack(lnum, col) end
+
+--- Note: Prefer |vim.system()| in Lua.
+---
+--- Gets the output of {cmd} as a |string| (|systemlist()| returns
+--- a |List|) and sets |v:shell_error| to the error code.
+--- {cmd} is treated as in |jobstart()|:
+--- If {cmd} is a List it runs directly (no 'shell').
+--- If {cmd} is a String it runs in the 'shell', like this: >
+---   :call jobstart(split(&shell) + split(&shellcmdflag) + ['{cmd}'])
+---
+--- <Not to be used for interactive commands.
+---
+--- Result is a String, filtered to avoid platform-specific quirks:
+--- - <CR><NL> is replaced with <NL>
+--- - NUL characters are replaced with SOH (0x01)
+---
+--- Example: >
+---     :echo system(['ls', expand('%:h')])
+---
+--- <If {input} is a string it is written to a pipe and passed as
+--- stdin to the command.  The string is written as-is, line
+--- separators are not changed.
+--- If {input} is a |List| it is written to the pipe as
+--- |writefile()| does with {binary} set to "b" (i.e. with
+--- a newline between each list item, and newlines inside list
+--- items converted to NULs).
+--- When {input} is given and is a valid buffer id, the content of
+--- the buffer is written to the file line by line, each line
+--- terminated by NL (and NUL where the text has NL).
+---             *E5677*
+--- Note: system() cannot write to or read from backgrounded ("&")
+--- shell commands, e.g.: >
+---     :echo system("cat - &", "foo")
+--- <which is equivalent to: >
+---     $ echo foo | bash -c 'cat - &'
+--- <The pipes are disconnected (unless overridden by shell
+--- redirection syntax) before input can reach it. Use
+--- |jobstart()| instead.
+---
+--- Note: Use |shellescape()| or |::S| with |expand()| or
+--- |fnamemodify()| to escape special characters in a command
+--- argument. 'shellquote' and 'shellxquote' must be properly
+--- configured. Example: >
+---     :echo system('ls '..shellescape(expand('%:h')))
+---     :echo system('ls '..expand('%:h:S'))
+---
+--- <Unlike ":!cmd" there is no automatic check for changed files.
+--- Use |:checktime| to force a check.
+---
+--- Can also be used as a |method|: >
+---   :echo GetCmd()->system()
+---
+--- @param cmd any
+--- @param input? any
+--- @return any
+function vim.fn.system(cmd, input) end
+
+--- Same as |system()|, but returns a |List| with lines (parts of
+--- output separated by NL) with NULs transformed into NLs. Output
+--- is the same as |readfile()| will output with {binary} argument
+--- set to "b", except that a final newline is not preserved,
+--- unless {keepempty} is non-zero.
+--- Note that on MS-Windows you may get trailing CR characters.
+---
+--- To see the difference between "echo hello" and "echo -n hello"
+--- use |system()| and |split()|: >
+---   echo split(system('echo hello'), '\n', 1)
+--- <
+--- Returns an empty string on error.
+---
+--- Can also be used as a |method|: >
+---   :echo GetCmd()->systemlist()
+---
+--- @param cmd any
+--- @param input? any
+--- @param keepempty? any
+--- @return any
+function vim.fn.systemlist(cmd, input, keepempty) end
+
+--- The result is a |List|, where each item is the number of the
+--- buffer associated with each window in the current tab page.
+--- {arg} specifies the number of the tab page to be used. When
+--- omitted the current tab page is used.
+--- When {arg} is invalid the number zero is returned.
+--- To get a list of all buffers in all tabs use this: >
+---   let buflist = []
+---   for i in range(tabpagenr('$'))
+---      call extend(buflist, tabpagebuflist(i + 1))
+---   endfor
+--- <Note that a buffer may appear in more than one window.
+---
+--- Can also be used as a |method|: >
+---   GetTabpage()->tabpagebuflist()
+---
+--- @param arg? any
+--- @return any
+function vim.fn.tabpagebuflist(arg) end
+
+--- The result is a Number, which is the number of the current
+--- tab page.  The first tab page has number 1.
+---
+--- The optional argument {arg} supports the following values:
+---   $  the number of the last tab page (the tab page
+---     count).
+---   #  the number of the last accessed tab page
+---     (where |g<Tab>| goes to).  If there is no
+---     previous tab page, 0 is returned.
+--- The number can be used with the |:tab| command.
+---
+--- Returns zero on error.
+---
+--- @param arg? any
+--- @return any
+function vim.fn.tabpagenr(arg) end
+
+--- Like |winnr()| but for tab page {tabarg}.
+--- {tabarg} specifies the number of tab page to be used.
+--- {arg} is used like with |winnr()|:
+--- - When omitted the current window number is returned.  This is
+---   the window which will be used when going to this tab page.
+--- - When "$" the number of windows is returned.
+--- - When "#" the previous window nr is returned.
+--- Useful examples: >
+---     tabpagewinnr(1)      " current window of tab page 1
+---     tabpagewinnr(4, '$')    " number of windows in tab page 4
+--- <When {tabarg} is invalid zero is returned.
+---
+--- Can also be used as a |method|: >
+---   GetTabpage()->tabpagewinnr()
+--- <
+---           *tagfiles()*
+--- @param tabarg any
+--- @param arg? any
+--- @return any
+function vim.fn.tabpagewinnr(tabarg, arg) end
+
+--- for the current buffer.  This is the 'tags' option expanded.
+---
+---
+--- @return any
+function vim.fn.tagfiles() end
+
+--- Returns a |List| of tags matching the regular expression {expr}.
+---
+--- If {filename} is passed it is used to prioritize the results
+--- in the same way that |:tselect| does. See |tag-priority|.
+--- {filename} should be the full path of the file.
+---
+--- Each list item is a dictionary with at least the following
+--- entries:
+---   name    Name of the tag.
+---   filename  Name of the file where the tag is
+---       defined.  It is either relative to the
+---       current directory or a full path.
+---   cmd    Ex command used to locate the tag in
+---       the file.
+---   kind    Type of the tag.  The value for this
+---       entry depends on the language specific
+---       kind values.  Only available when
+---       using a tags file generated by
+---       Universal/Exuberant ctags or hdrtag.
+---   static    A file specific tag.  Refer to
+---       |static-tag| for more information.
+--- More entries may be present, depending on the content of the
+--- tags file: access, implementation, inherits and signature.
+--- Refer to the ctags documentation for information about these
+--- fields.  For C code the fields "struct", "class" and "enum"
+--- may appear, they give the name of the entity the tag is
+--- contained in.
+---
+--- The ex-command "cmd" can be either an ex search pattern, a
+--- line number or a line number followed by a byte number.
+---
+--- If there are no matching tags, then an empty list is returned.
+---
+--- To get an exact tag match, the anchors '^' and '$' should be
+--- used in {expr}.  This also make the function work faster.
+--- Refer to |tag-regexp| for more information about the tag
+--- search regular expression pattern.
+---
+--- Refer to |'tags'| for information about how the tags file is
+--- located by Vim. Refer to |tags-file-format| for the format of
+--- the tags file generated by the different ctags tools.
+---
+--- Can also be used as a |method|: >
+---   GetTagpattern()->taglist()
+---
+--- @param expr any
+--- @param filename? any
+--- @return any
+function vim.fn.taglist(expr, filename) end
+
+--- Return the tangent of {expr}, measured in radians, as a |Float|
+--- in the range [-inf, inf].
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo tan(10)
+--- <  0.648361 >
+---   :echo tan(-4.01)
+--- <  -1.181502
+---
+--- Can also be used as a |method|: >
+---   Compute()->tan()
+---
+--- @param expr any
+--- @return any
+function vim.fn.tan(expr) end
+
+--- Return the hyperbolic tangent of {expr} as a |Float| in the
+--- range [-1, 1].
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   :echo tanh(0.5)
+--- <  0.462117 >
+---   :echo tanh(-1)
+--- <  -0.761594
+---
+--- Can also be used as a |method|: >
+---   Compute()->tanh()
+--- <
+---           *timer_info()*
+--- @param expr any
+--- @return any
+function vim.fn.tanh(expr) end
+
+--- Generates a (non-existent) filename located in the Nvim root
+--- |tempdir|. Scripts can use the filename as a temporary file.
+--- Example: >
+---   :let tmpfile = tempname()
+---   :exe "redir > " .. tmpfile
+---
+--- @return string
+function vim.fn.tempname() end
+
+--- Spawns {cmd} in a new pseudo-terminal session connected
+--- to the current (unmodified) buffer. Parameters and behavior
+--- are the same as |jobstart()| except "pty", "width", "height",
+--- and "TERM" are ignored: "height" and "width" are taken from
+--- the current window. Note that termopen() implies a "pty" arg
+--- to jobstart(), and thus has the implications documented at
+--- |jobstart()|.
+---
+--- Returns the same values as jobstart().
+---
+--- Terminal environment is initialized as in |jobstart-env|,
+--- except $TERM is set to "xterm-256color". Full behavior is
+--- described in |terminal|.
+---
+--- @param cmd any
+--- @param opts? table
+--- @return any
+function vim.fn.termopen(cmd, opts) end
+
+--- Return a list with information about timers.
+--- When {id} is given only information about this timer is
+--- returned.  When timer {id} does not exist an empty list is
+--- returned.
+--- When {id} is omitted information about all timers is returned.
+---
+--- For each timer the information is stored in a |Dictionary| with
+--- these items:
+---     "id"      the timer ID
+---     "time"      time the timer was started with
+---     "repeat"      number of times the timer will still fire;
+---         -1 means forever
+---     "callback"      the callback
+---
+--- Can also be used as a |method|: >
+---   GetTimer()->timer_info()
+--- <
+--- @param id? any
+--- @return any
+function vim.fn.timer_info(id) end
+
+--- Pause or unpause a timer.  A paused timer does not invoke its
+--- callback when its time expires.  Unpausing a timer may cause
+--- the callback to be invoked almost immediately if enough time
+--- has passed.
+---
+--- Pausing a timer is useful to avoid the callback to be called
+--- for a short time.
+---
+--- If {paused} evaluates to a non-zero Number or a non-empty
+--- String, then the timer is paused, otherwise it is unpaused.
+--- See |non-zero-arg|.
+---
+--- Can also be used as a |method|: >
+---   GetTimer()->timer_pause(1)
+--- <
+---         *timer_start()* *timer* *timers*
+--- @param timer any
+--- @param paused any
+--- @return any
+function vim.fn.timer_pause(timer, paused) end
+
+--- Create a timer and return the timer ID.
+---
+--- {time} is the waiting time in milliseconds. This is the
+--- minimum time before invoking the callback.  When the system is
+--- busy or Vim is not waiting for input the time will be longer.
+--- Zero can be used to execute the callback when Vim is back in
+--- the main loop.
+---
+--- {callback} is the function to call.  It can be the name of a
+--- function or a |Funcref|.  It is called with one argument, which
+--- is the timer ID.  The callback is only invoked when Vim is
+--- waiting for input.
+---
+--- {options} is a dictionary.  Supported entries:
+---    "repeat"  Number of times to repeat the callback.
+---     -1 means forever.  Default is 1.
+---     If the timer causes an error three times in a
+---     row the repeat is cancelled.
+---
+--- Returns -1 on error.
+---
+--- Example: >
+---   func MyHandler(timer)
+---     echo 'Handler called'
+---   endfunc
+---   let timer = timer_start(500, 'MyHandler',
+---     \ {'repeat': 3})
+--- <This invokes MyHandler() three times at 500 msec intervals.
+---
+--- Can also be used as a |method|: >
+---   GetMsec()->timer_start(callback)
+---
+--- <Not available in the |sandbox|.
+---
+--- @param time any
+--- @param callback any
+--- @param options? table
+--- @return any
+function vim.fn.timer_start(time, callback, options) end
+
+--- Stop a timer.  The timer callback will no longer be invoked.
+--- {timer} is an ID returned by timer_start(), thus it must be a
+--- Number.  If {timer} does not exist there is no error.
+---
+--- Can also be used as a |method|: >
+---   GetTimer()->timer_stop()
+--- <
+--- @param timer any
+--- @return any
+function vim.fn.timer_stop(timer) end
+
+--- Stop all timers.  The timer callbacks will no longer be
+--- invoked.  Useful if some timers is misbehaving.  If there are
+--- no timers there is no error.
+---
+--- @return any
+function vim.fn.timer_stopall() end
+
+--- The result is a copy of the String given, with all uppercase
+--- characters turned into lowercase (just like applying |gu| to
+--- the string).  Returns an empty string on error.
+---
+--- Can also be used as a |method|: >
+---   GetText()->tolower()
+---
+--- @param expr any
+--- @return string
+function vim.fn.tolower(expr) end
+
+--- The result is a copy of the String given, with all lowercase
+--- characters turned into uppercase (just like applying |gU| to
+--- the string).  Returns an empty string on error.
+---
+--- Can also be used as a |method|: >
+---   GetText()->toupper()
+---
+--- @param expr any
+--- @return string
+function vim.fn.toupper(expr) end
+
+--- The result is a copy of the {src} string with all characters
+--- which appear in {fromstr} replaced by the character in that
+--- position in the {tostr} string.  Thus the first character in
+--- {fromstr} is translated into the first character in {tostr}
+--- and so on.  Exactly like the unix "tr" command.
+--- This code also deals with multibyte characters properly.
+---
+--- Returns an empty string on error.
+---
+--- Examples: >
+---   echo tr("hello there", "ht", "HT")
+--- <returns "Hello THere" >
+---   echo tr("<blob>", "<>", "{}")
+--- <returns "{blob}"
+---
+--- Can also be used as a |method|: >
+---   GetText()->tr(from, to)
+---
+--- @param src any
+--- @param fromstr any
+--- @param tostr any
+--- @return any
+function vim.fn.tr(src, fromstr, tostr) end
+
+--- Return {text} as a String where any character in {mask} is
+--- removed from the beginning and/or end of {text}.
+--- If {mask} is not given, {mask} is all characters up to 0x20,
+--- which includes Tab, space, NL and CR, plus the non-breaking
+--- space character 0xa0.
+--- The optional {dir} argument specifies where to remove the
+--- characters:
+---   0  remove from the beginning and end of {text}
+---   1  remove only at the beginning of {text}
+---   2  remove only at the end of {text}
+--- When omitted both ends are trimmed.
+--- This function deals with multibyte characters properly.
+--- Returns an empty string on error.
+---
+--- Examples: >
+---   echo trim("   some text ")
+--- <returns "some text" >
+---   echo trim("  \r\t\t\r RESERVE \t\n\x0B\xA0") .. "_TAIL"
+--- <returns "RESERVE_TAIL" >
+---   echo trim("rm<Xrm<>X>rrm", "rm<>")
+--- <returns "Xrm<>X" (characters in the middle are not removed) >
+---   echo trim("  vim  ", " ", 2)
+--- <returns "  vim"
+---
+--- Can also be used as a |method|: >
+---   GetText()->trim()
+---
+--- @param text any
+--- @param mask? any
+--- @param dir? string
+--- @return string
+function vim.fn.trim(text, mask, dir) end
+
+--- Return the largest integral value with magnitude less than or
+--- equal to {expr} as a |Float| (truncate towards zero).
+--- {expr} must evaluate to a |Float| or a |Number|.
+--- Returns 0.0 if {expr} is not a |Float| or a |Number|.
+--- Examples: >
+---   echo trunc(1.456)
+--- <  1.0  >
+---   echo trunc(-5.456)
+--- <  -5.0  >
+---   echo trunc(4.0)
+--- <  4.0
+---
+--- Can also be used as a |method|: >
+---   Compute()->trunc()
+---
+--- @param expr any
+--- @return any
+function vim.fn.trunc(expr) end
+
+--- The result is a Number representing the type of {expr}.
+--- Instead of using the number directly, it is better to use the
+--- v:t_ variable that has the value:
+---         Number:     0 (|v:t_number|)
+---   String:     1 (|v:t_string|)
+---   Funcref:    2 (|v:t_func|)
+---   List:       3 (|v:t_list|)
+---   Dictionary: 4 (|v:t_dict|)
+---   Float:      5 (|v:t_float|)
+---   Boolean:    6 (|v:true| and |v:false|)
+---   Null:       7 (|v:null|)
+---   Blob:      10 (|v:t_blob|)
+--- For backward compatibility, this method can be used: >
+---   :if type(myvar) == type(0)
+---   :if type(myvar) == type("")
+---   :if type(myvar) == type(function("tr"))
+---   :if type(myvar) == type([])
+---   :if type(myvar) == type({})
+---   :if type(myvar) == type(0.0)
+---   :if type(myvar) == type(v:true)
+--- <In place of checking for |v:null| type it is better to check
+--- for |v:null| directly as it is the only value of this type: >
+---   :if myvar is v:null
+--- <               To check if the v:t_ variables exist use this: >
+---                         :if exists('v:t_number')
+---
+--- <Can also be used as a |method|: >
+---   mylist->type()
+---
+--- @param expr any
+--- @return any
+function vim.fn.type(expr) end
+
+--- Return the name of the undo file that would be used for a file
+--- with name {name} when writing.  This uses the 'undodir'
+--- option, finding directories that exist.  It does not check if
+--- the undo file exists.
+--- {name} is always expanded to the full path, since that is what
+--- is used internally.
+--- If {name} is empty undofile() returns an empty string, since a
+--- buffer without a file name will not write an undo file.
+--- Useful in combination with |:wundo| and |:rundo|.
+---
+--- Can also be used as a |method|: >
+---   GetFilename()->undofile()
+---
+--- @param name string
+--- @return string
+function vim.fn.undofile(name) end
+
+--- Return the current state of the undo tree in a dictionary with
+--- the following items:
+---   "seq_last"  The highest undo sequence number used.
+---   "seq_cur"  The sequence number of the current position in
+---     the undo tree.  This differs from "seq_last"
+---     when some changes were undone.
+---   "time_cur"  Time last used for |:earlier| and related
+---     commands.  Use |strftime()| to convert to
+---     something readable.
+---   "save_last"  Number of the last file write.  Zero when no
+---     write yet.
+---   "save_cur"  Number of the current position in the undo
+---     tree.
+---   "synced"  Non-zero when the last undo block was synced.
+---     This happens when waiting from input from the
+---     user.  See |undo-blocks|.
+---   "entries"  A list of dictionaries with information about
+---     undo blocks.
+---
+--- The first item in the "entries" list is the oldest undo item.
+--- Each List item is a |Dictionary| with these items:
+---   "seq"    Undo sequence number.  Same as what appears in
+---     |:undolist|.
+---   "time"  Timestamp when the change happened.  Use
+---     |strftime()| to convert to something readable.
+---   "newhead"  Only appears in the item that is the last one
+---     that was added.  This marks the last change
+---     and where further changes will be added.
+---   "curhead"  Only appears in the item that is the last one
+---     that was undone.  This marks the current
+---     position in the undo tree, the block that will
+---     be used by a redo command.  When nothing was
+---     undone after the last change this item will
+---     not appear anywhere.
+---   "save"  Only appears on the last block before a file
+---     write.  The number is the write count.  The
+---     first write has number 1, the last one the
+---     "save_last" mentioned above.
+---   "alt"    Alternate entry.  This is again a List of undo
+---     blocks.  Each item may again have an "alt"
+---     item.
+---
+--- @return any
+function vim.fn.undotree() end
+
+--- Remove second and succeeding copies of repeated adjacent
+--- {list} items in-place.  Returns {list}.  If you want a list
+--- to remain unmodified make a copy first: >
+---   :let newlist = uniq(copy(mylist))
+--- <The default compare function uses the string representation of
+--- each item.  For the use of {func} and {dict} see |sort()|.
+---
+--- Returns zero if {list} is not a |List|.
+---
+--- Can also be used as a |method|: >
+---   mylist->uniq()
+--- <
+---           *utf16idx()*
+--- @param list any
+--- @param func? any
+--- @param dict? any
+--- @return any[]|0
+function vim.fn.uniq(list, func, dict) end
+
+--- Same as |charidx()| but returns the UTF-16 code unit index of
+--- the byte at {idx} in {string} (after converting it to UTF-16).
+---
+--- When {charidx} is present and TRUE, {idx} is used as the
+--- character index in the String {string} instead of as the byte
+--- index.
+--- An {idx} in the middle of a UTF-8 sequence is rounded
+--- downwards to the beginning of that sequence.
+---
+--- Returns -1 if the arguments are invalid or if there are less
+--- than {idx} bytes in {string}. If there are exactly {idx} bytes
+--- the length of the string in UTF-16 code units is returned.
+---
+--- See |byteidx()| and |byteidxcomp()| for getting the byte index
+--- from the UTF-16 index and |charidx()| for getting the
+--- character index from the UTF-16 index.
+--- Refer to |string-offset-encoding| for more information.
+--- Examples: >
+---   echo utf16idx('a😊😊', 3)  returns 2
+---   echo utf16idx('a😊😊', 7)  returns 4
+---   echo utf16idx('a😊😊', 1, 0, 1)  returns 2
+---   echo utf16idx('a😊😊', 2, 0, 1)  returns 4
+---   echo utf16idx('aą́c', 6)    returns 2
+---   echo utf16idx('aą́c', 6, 1)  returns 4
+---   echo utf16idx('a😊😊', 9)  returns -1
+--- <
+--- Can also be used as a |method|: >
+---   GetName()->utf16idx(idx)
+---
+---
+--- @param string string
+--- @param idx integer
+--- @param countcc? any
+--- @param charidx? any
+--- @return integer
+function vim.fn.utf16idx(string, idx, countcc, charidx) end
+
+--- Return a |List| with all the values of {dict}.  The |List| is
+--- in arbitrary order.  Also see |items()| and |keys()|.
+--- Returns zero if {dict} is not a |Dict|.
+---
+--- Can also be used as a |method|: >
+---   mydict->values()
+---
+--- @param dict any
+--- @return any
+function vim.fn.values(dict) end
+
+--- The result is a Number, which is the screen column of the file
+--- position given with {expr}.  That is, the last screen position
+--- occupied by the character at that position, when the screen
+--- would be of unlimited width.  When there is a <Tab> at the
+--- position, the returned Number will be the column at the end of
+--- the <Tab>.  For example, for a <Tab> in column 1, with 'ts'
+--- set to 8, it returns 8. |conceal| is ignored.
+--- For the byte position use |col()|.
+---
+--- For the use of {expr} see |col()|.
+---
+--- When 'virtualedit' is used {expr} can be [lnum, col, off],
+--- where "off" is the offset in screen columns from the start of
+--- the character.  E.g., a position within a <Tab> or after the
+--- last character.  When "off" is omitted zero is used.  When
+--- Virtual editing is active in the current mode, a position
+--- beyond the end of the line can be returned.  Also see
+--- |'virtualedit'|
+---
+--- The accepted positions are:
+---     .      the cursor position
+---     $      the end of the cursor line (the result is the
+---       number of displayed characters in the cursor line
+---       plus one)
+---     'x      position of mark x (if the mark is not set, 0 is
+---       returned)
+---     v       In Visual mode: the start of the Visual area (the
+---       cursor is the end).  When not in Visual mode
+---       returns the cursor position.  Differs from |'<| in
+---       that it's updated right away.
+---
+--- If {list} is present and non-zero then virtcol() returns a List
+--- with the first and last screen position occupied by the
+--- character.
+---
+--- Note that only marks in the current file can be used.
+--- Examples: >
+---   " With text "foo^Lbar" and cursor on the "^L":
+---
+---   virtcol(".")  " returns 5
+---   virtcol(".", 1)  " returns [4, 5]
+---   virtcol("$")  " returns 9
+---
+---   " With text "    there", with 't at 'h':
+---
+---   virtcol("'t")  " returns 6
+--- <The first column is 1.  0 is returned for an error.
+--- A more advanced example that echoes the maximum length of
+--- all lines: >
+---     echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
+---
+--- <Can also be used as a |method|: >
+---   GetPos()->virtcol()
+---
+--- @param expr any
+--- @param list? any
+--- @return any
+function vim.fn.virtcol(expr, list) end
+
+--- The result is a Number, which is the byte index of the
+--- character in window {winid} at buffer line {lnum} and virtual
+--- column {col}.
+---
+--- If {col} is greater than the last virtual column in line
+--- {lnum}, then the byte index of the character at the last
+--- virtual column is returned.
+---
+--- The {winid} argument can be the window number or the
+--- |window-ID|. If this is zero, then the current window is used.
+---
+--- Returns -1 if the window {winid} doesn't exist or the buffer
+--- line {lnum} or virtual column {col} is invalid.
+---
+--- See also |screenpos()|, |virtcol()| and |col()|.
+---
+--- Can also be used as a |method|: >
+---   GetWinid()->virtcol2col(lnum, col)
+---
+--- @param winid integer
+--- @param lnum integer
+--- @param col integer
+--- @return any
+function vim.fn.virtcol2col(winid, lnum, col) end
+
+--- The result is a String, which describes the last Visual mode
+--- used in the current buffer.  Initially it returns an empty
+--- string, but once Visual mode has been used, it returns "v",
+--- "V", or "<CTRL-V>" (a single CTRL-V character) for
+--- character-wise, line-wise, or block-wise Visual mode
+--- respectively.
+--- Example: >
+---   :exe "normal " .. visualmode()
+--- <This enters the same Visual mode as before.  It is also useful
+--- in scripts if you wish to act differently depending on the
+--- Visual mode that was used.
+--- If Visual mode is active, use |mode()| to get the Visual mode
+--- (e.g., in a |:vmap|).
+--- If {expr} is supplied and it evaluates to a non-zero Number or
+--- a non-empty String, then the Visual mode will be cleared and
+--- the old value is returned.  See |non-zero-arg|.
+---
+--- @param expr? any
+--- @return any
+function vim.fn.visualmode(expr) end
+
+--- Waits until {condition} evaluates to |TRUE|, where {condition}
+--- is a |Funcref| or |string| containing an expression.
+---
+--- {timeout} is the maximum waiting time in milliseconds, -1
+--- means forever.
+---
+--- Condition is evaluated on user events, internal events, and
+--- every {interval} milliseconds (default: 200).
+---
+--- Returns a status integer:
+---   0 if the condition was satisfied before timeout
+---   -1 if the timeout was exceeded
+---   -2 if the function was interrupted (by |CTRL-C|)
+---   -3 if an error occurred
+---
+--- @param timeout integer
+--- @param condition any
+--- @param interval? any
+--- @return any
+function vim.fn.wait(timeout, condition, interval) end
+
+--- Returns |TRUE| when the wildmenu is active and |FALSE|
+--- otherwise.  See 'wildmenu' and 'wildmode'.
+--- This can be used in mappings to handle the 'wildcharm' option
+--- gracefully. (Makes only sense with |mapmode-c| mappings).
+---
+--- For example to make <c-j> work like <down> in wildmode, use: >
+---     :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
+--- <
+--- (Note, this needs the 'wildcharm' option set appropriately).
+---
+--- @return any
+function vim.fn.wildmenumode() end
+
+--- Like `execute()` but in the context of window {id}.
+--- The window will temporarily be made the current window,
+--- without triggering autocommands or changing directory.  When
+--- executing {command} autocommands will be triggered, this may
+--- have unexpected side effects.  Use `:noautocmd` if needed.
+--- Example: >
+---   call win_execute(winid, 'syntax enable')
+--- <Doing the same with `setwinvar()` would not trigger
+--- autocommands and not actually show syntax highlighting.
+---
+--- When window {id} does not exist then no error is given and
+--- an empty string is returned.
+---
+--- Can also be used as a |method|, the base is passed as the
+--- second argument: >
+---   GetCommand()->win_execute(winid)
+---
+--- @param id any
+--- @param command any
+--- @param silent? boolean
+--- @return any
+function vim.fn.win_execute(id, command, silent) end
+
+--- Returns a |List| with |window-ID|s for windows that contain
+--- buffer {bufnr}.  When there is none the list is empty.
+---
+--- Can also be used as a |method|: >
+---   GetBufnr()->win_findbuf()
+---
+--- @param bufnr any
+--- @return integer[]
+function vim.fn.win_findbuf(bufnr) end
+
+--- Get the |window-ID| for the specified window.
+--- When {win} is missing use the current window.
+--- With {win} this is the window number.  The top window has
+--- number 1.
+--- Without {tab} use the current tab, otherwise the tab with
+--- number {tab}.  The first tab has number one.
+--- Return zero if the window cannot be found.
+---
+--- Can also be used as a |method|: >
+---   GetWinnr()->win_getid()
+---
+--- @param win? any
+--- @param tab? any
+--- @return integer
+function vim.fn.win_getid(win, tab) end
+
+--- Return the type of the window:
+---   "autocmd"  autocommand window. Temporary window
+---       used to execute autocommands.
+---   "command"  command-line window |cmdwin|
+---   (empty)    normal window
+---   "loclist"  |location-list-window|
+---   "popup"    floating window |api-floatwin|
+---   "preview"  preview window |preview-window|
+---   "quickfix"  |quickfix-window|
+---   "unknown"  window {nr} not found
+---
+--- When {nr} is omitted return the type of the current window.
+--- When {nr} is given return the type of this window by number or
+--- |window-ID|.
+---
+--- Also see the 'buftype' option.
+---
+--- Can also be used as a |method|: >
+---   GetWinid()->win_gettype()
+--- <
+--- @param nr? integer
+--- @return 'autocmd'|'command'|''|'loclist'|'popup'|'preview'|'quickfix'|'unknown'
+function vim.fn.win_gettype(nr) end
+
+--- Go to window with ID {expr}.  This may also change the current
+--- tabpage.
+--- Return TRUE if successful, FALSE if the window cannot be found.
+---
+--- Can also be used as a |method|: >
+---   GetWinid()->win_gotoid()
+---
+--- @param expr any
+--- @return 0|1
+function vim.fn.win_gotoid(expr) end
+
+--- Return a list with the tab number and window number of window
+--- with ID {expr}: [tabnr, winnr].
+--- Return [0, 0] if the window cannot be found.
+---
+--- Can also be used as a |method|: >
+---   GetWinid()->win_id2tabwin()
+---
+--- @param expr any
+--- @return any
+function vim.fn.win_id2tabwin(expr) end
+
+--- Return the window number of window with ID {expr}.
+--- Return 0 if the window cannot be found in the current tabpage.
+---
+--- Can also be used as a |method|: >
+---   GetWinid()->win_id2win()
+---
+--- @param expr any
+--- @return any
+function vim.fn.win_id2win(expr) end
+
+--- Move window {nr}'s vertical separator (i.e., the right border)
+--- by {offset} columns, as if being dragged by the mouse. {nr}
+--- can be a window number or |window-ID|. A positive {offset}
+--- moves right and a negative {offset} moves left. Moving a
+--- window's vertical separator will change the width of the
+--- window and the width of other windows adjacent to the vertical
+--- separator. The magnitude of movement may be smaller than
+--- specified (e.g., as a consequence of maintaining
+--- 'winminwidth'). Returns TRUE if the window can be found and
+--- FALSE otherwise.
+--- This will fail for the rightmost window and a full-width
+--- window, since it has no separator on the right.
+--- Only works for the current tab page. *E1308*
+---
+--- Can also be used as a |method|: >
+---   GetWinnr()->win_move_separator(offset)
+---
+--- @param nr integer
+--- @param offset any
+--- @return any
+function vim.fn.win_move_separator(nr, offset) end
+
+--- Move window {nr}'s status line (i.e., the bottom border) by
+--- {offset} rows, as if being dragged by the mouse. {nr} can be a
+--- window number or |window-ID|. A positive {offset} moves down
+--- and a negative {offset} moves up. Moving a window's status
+--- line will change the height of the window and the height of
+--- other windows adjacent to the status line. The magnitude of
+--- movement may be smaller than specified (e.g., as a consequence
+--- of maintaining 'winminheight'). Returns TRUE if the window can
+--- be found and FALSE otherwise.
+--- Only works for the current tab page.
+---
+--- Can also be used as a |method|: >
+---   GetWinnr()->win_move_statusline(offset)
+---
+--- @param nr integer
+--- @param offset any
+--- @return any
+function vim.fn.win_move_statusline(nr, offset) end
+
+--- Return the screen position of window {nr} as a list with two
+--- numbers: [row, col].  The first window always has position
+--- [1, 1], unless there is a tabline, then it is [2, 1].
+--- {nr} can be the window number or the |window-ID|.  Use zero
+--- for the current window.
+--- Returns [0, 0] if the window cannot be found in the current
+--- tabpage.
+---
+--- Can also be used as a |method|: >
+---   GetWinid()->win_screenpos()
+--- <
+--- @param nr integer
+--- @return any
+function vim.fn.win_screenpos(nr) end
+
+--- Move the window {nr} to a new split of the window {target}.
+--- This is similar to moving to {target}, creating a new window
+--- using |:split| but having the same contents as window {nr}, and
+--- then closing {nr}.
+---
+--- Both {nr} and {target} can be window numbers or |window-ID|s.
+--- Both must be in the current tab page.
+---
+--- Returns zero for success, non-zero for failure.
+---
+--- {options} is a |Dictionary| with the following optional entries:
+---   "vertical"  When TRUE, the split is created vertically,
+---     like with |:vsplit|.
+---   "rightbelow"  When TRUE, the split is made below or to the
+---     right (if vertical).  When FALSE, it is done
+---     above or to the left (if vertical).  When not
+---     present, the values of 'splitbelow' and
+---     'splitright' are used.
+---
+--- Can also be used as a |method|: >
+---   GetWinid()->win_splitmove(target)
+--- <
+---           *winbufnr()*
+--- @param nr integer
+--- @param target any
+--- @param options? table
+--- @return any
+function vim.fn.win_splitmove(nr, target, options) end
+
+--- associated with window {nr}.  {nr} can be the window number or
+--- the |window-ID|.
+--- When {nr} is zero, the number of the buffer in the current
+--- window is returned.
+--- When window {nr} doesn't exist, -1 is returned.
+--- Example: >
+---   :echo "The file in the current window is " .. bufname(winbufnr(0))
+--- <
+--- Can also be used as a |method|: >
+---   FindWindow()->winbufnr()->bufname()
+--- <
+---           *wincol()*
+--- @param nr integer
+--- @return integer
+function vim.fn.winbufnr(nr) end
+
+--- cursor in the window.  This is counting screen cells from the
+--- left side of the window.  The leftmost column is one.
+---
+---           *windowsversion()*
+--- @return integer
+function vim.fn.wincol() end
+
+--- The result is a String.  For MS-Windows it indicates the OS
+--- version.  E.g, Windows 10 is "10.0", Windows 8 is "6.2",
+--- Windows XP is "5.1".  For non-MS-Windows systems the result is
+--- an empty string.
+---
+--- @return string
+function vim.fn.windowsversion() end
+
+--- The result is a Number, which is the height of window {nr}.
+--- {nr} can be the window number or the |window-ID|.
+--- When {nr} is zero, the height of the current window is
+--- returned.  When window {nr} doesn't exist, -1 is returned.
+--- An existing window always has a height of zero or more.
+--- This excludes any window toolbar line.
+--- Examples: >
+---   :echo "The current window has " .. winheight(0) .. " lines."
+---
+--- <Can also be used as a |method|: >
+---   GetWinid()->winheight()
+--- <
+--- @param nr integer
+--- @return integer
+function vim.fn.winheight(nr) end
+
+--- The result is a nested List containing the layout of windows
+--- in a tabpage.
+---
+--- Without {tabnr} use the current tabpage, otherwise the tabpage
+--- with number {tabnr}. If the tabpage {tabnr} is not found,
+--- returns an empty list.
+---
+--- For a leaf window, it returns:
+---   ["leaf", {winid}]
+--- For horizontally split windows, which form a column, it
+--- returns: >
+---   ["col", [{nested list of windows}]]
+--- <For vertically split windows, which form a row, it returns: >
+---   ["row", [{nested list of windows}]]
+--- <
+--- Example: >
+---   " Only one window in the tab page
+---   :echo winlayout()
+---   ['leaf', 1000]
+---   " Two horizontally split windows
+---   :echo winlayout()
+---   ['col', [['leaf', 1000], ['leaf', 1001]]]
+---   " The second tab page, with three horizontally split
+---   " windows, with two vertically split windows in the
+---   " middle window
+---   :echo winlayout(2)
+---   ['col', [['leaf', 1002], ['row', [['leaf', 1003],
+---           ['leaf', 1001]]], ['leaf', 1000]]]
+--- <
+--- Can also be used as a |method|: >
+---   GetTabnr()->winlayout()
+--- <
+---           *winline()*
+--- @param tabnr? integer
+--- @return any
+function vim.fn.winlayout(tabnr) end
+
+--- in the window.  This is counting screen lines from the top of
+--- the window.  The first line is one.
+--- If the cursor was moved the view on the file will be updated
+--- first, this may cause a scroll.
+---
+---           *winnr()*
+--- @return integer
+function vim.fn.winline() end
+
+--- window.  The top window has number 1.
+--- Returns zero for a popup window.
+---
+--- The optional argument {arg} supports the following values:
+---   $  the number of the last window (the window
+---     count).
+---   #  the number of the last accessed window (where
+---     |CTRL-W_p| goes to).  If there is no previous
+---     window or it is in another tab page 0 is
+---     returned.
+---   {N}j  the number of the Nth window below the
+---     current window (where |CTRL-W_j| goes to).
+---   {N}k  the number of the Nth window above the current
+---     window (where |CTRL-W_k| goes to).
+---   {N}h  the number of the Nth window left of the
+---     current window (where |CTRL-W_h| goes to).
+---   {N}l  the number of the Nth window right of the
+---     current window (where |CTRL-W_l| goes to).
+--- The number can be used with |CTRL-W_w| and ":wincmd w"
+--- |:wincmd|.
+--- When {arg} is invalid an error is given and zero is returned.
+--- Also see |tabpagewinnr()| and |win_getid()|.
+--- Examples: >
+---   let window_count = winnr('$')
+---   let prev_window = winnr('#')
+---   let wnum = winnr('3k')
+---
+--- <Can also be used as a |method|: >
+---   GetWinval()->winnr()
+--- <
+---           *winrestcmd()*
+--- @param arg? any
+--- @return any
+function vim.fn.winnr(arg) end
+
+--- the current window sizes.  Only works properly when no windows
+--- are opened or closed and the current window and tab page is
+--- unchanged.
+--- Example: >
+---   :let cmd = winrestcmd()
+---   :call MessWithWindowSizes()
+---   :exe cmd
+--- <
+---           *winrestview()*
+--- @return any
+function vim.fn.winrestcmd() end
+
+--- Uses the |Dictionary| returned by |winsaveview()| to restore
+--- the view of the current window.
+--- Note: The {dict} does not have to contain all values, that are
+--- returned by |winsaveview()|. If values are missing, those
+--- settings won't be restored. So you can use: >
+---     :call winrestview({'curswant': 4})
+--- <
+--- This will only set the curswant value (the column the cursor
+--- wants to move on vertical movements) of the cursor to column 5
+--- (yes, that is 5), while all other settings will remain the
+--- same. This is useful, if you set the cursor position manually.
+---
+--- If you have changed the values the result is unpredictable.
+--- If the window size changed the result won't be the same.
+---
+--- Can also be used as a |method|: >
+---   GetView()->winrestview()
+--- <
+---           *winsaveview()*
+--- @param dict any
+--- @return any
+function vim.fn.winrestview(dict) end
+
+--- the view of the current window.  Use |winrestview()| to
+--- restore the view.
+--- This is useful if you have a mapping that jumps around in the
+--- buffer and you want to go back to the original view.
+--- This does not save fold information.  Use the 'foldenable'
+--- option to temporarily switch off folding, so that folds are
+--- not opened when moving around. This may have side effects.
+--- The return value includes:
+---   lnum    cursor line number
+---   col    cursor column (Note: the first column
+---       zero, as opposed to what |getcurpos()|
+---       returns)
+---   coladd    cursor column offset for 'virtualedit'
+---   curswant  column for vertical movement (Note:
+---       the first column is zero, as opposed
+---       to what |getcurpos()| returns).  After
+---       |$| command it will be a very large
+---       number equal to |v:maxcol|.
+---   topline    first line in the window
+---   topfill    filler lines, only in diff mode
+---   leftcol    first column displayed; only used when
+---       'wrap' is off
+---   skipcol    columns skipped
+--- Note that no option values are saved.
+---
+---
+--- @return any
+function vim.fn.winsaveview() end
+
+--- The result is a Number, which is the width of window {nr}.
+--- {nr} can be the window number or the |window-ID|.
+--- When {nr} is zero, the width of the current window is
+--- returned.  When window {nr} doesn't exist, -1 is returned.
+--- An existing window always has a width of zero or more.
+--- Examples: >
+---   :echo "The current window has " .. winwidth(0) .. " columns."
+---   :if winwidth(0) <= 50
+---   :  50 wincmd |
+---   :endif
+--- <For getting the terminal or screen size, see the 'columns'
+--- option.
+---
+--- Can also be used as a |method|: >
+---   GetWinid()->winwidth()
+---
+--- @param nr integer
+--- @return any
+function vim.fn.winwidth(nr) end
+
+--- The result is a dictionary of byte/chars/word statistics for
+--- the current buffer.  This is the same info as provided by
+--- |g_CTRL-G|
+--- The return value includes:
+---   bytes    Number of bytes in the buffer
+---   chars    Number of chars in the buffer
+---   words    Number of words in the buffer
+---   cursor_bytes    Number of bytes before cursor position
+---       (not in Visual mode)
+---   cursor_chars    Number of chars before cursor position
+---       (not in Visual mode)
+---   cursor_words    Number of words before cursor position
+---       (not in Visual mode)
+---   visual_bytes    Number of bytes visually selected
+---       (only in Visual mode)
+---   visual_chars    Number of chars visually selected
+---       (only in Visual mode)
+---   visual_words    Number of words visually selected
+---       (only in Visual mode)
+---
+---
+---           *writefile()*
+--- @return any
+function vim.fn.wordcount() end
+
+--- When {object} is a |List| write it to file {fname}.  Each list
+--- item is separated with a NL.  Each list item must be a String
+--- or Number.
+--- All NL characters are replaced with a NUL character.
+--- Inserting CR characters needs to be done before passing {list}
+--- to writefile().
+---
+--- When {object} is a |Blob| write the bytes to file {fname}
+--- unmodified, also when binary mode is not specified.
+---
+--- {flags} must be a String.  These characters are recognized:
+---
+--- 'b'  Binary mode is used: There will not be a NL after the
+---      last list item.  An empty item at the end does cause the
+---      last line in the file to end in a NL.
+---
+--- 'a'  Append mode is used, lines are appended to the file: >
+---   :call writefile(["foo"], "event.log", "a")
+---   :call writefile(["bar"], "event.log", "a")
+--- <
+--- 'D'  Delete the file when the current function ends.  This
+---      works like: >
+---   :defer delete({fname})
+--- <     Fails when not in a function.  Also see |:defer|.
+---
+--- 's'  fsync() is called after writing the file.  This flushes
+---      the file to disk, if possible.  This takes more time but
+---      avoids losing the file if the system crashes.
+---
+--- 'S'  fsync() is not called, even when 'fsync' is set.
+---
+---      When {flags} does not contain "S" or "s" then fsync() is
+---      called if the 'fsync' option is set.
+---
+--- An existing file is overwritten, if possible.
+---
+--- When the write fails -1 is returned, otherwise 0.  There is an
+--- error message if the file can't be created or when writing
+--- fails.
+---
+--- Also see |readfile()|.
+--- To copy a file byte for byte: >
+---   :let fl = readfile("foo", "b")
+---   :call writefile(fl, "foocopy", "b")
+---
+--- <Can also be used as a |method|: >
+---   GetText()->writefile("thefile")
+---
+--- @param object any
+--- @param fname integer
+--- @param flags? string
+--- @return any
+function vim.fn.writefile(object, fname, flags) end
+
+--- Bitwise XOR on the two arguments.  The arguments are converted
+--- to a number.  A List, Dict or Float argument causes an error.
+--- Also see `and()` and `or()`.
+--- Example: >
+---   :let bits = xor(bits, 0x80)
+--- <
+--- Can also be used as a |method|: >
+---   :let bits = bits->xor(0x80)
+--- <
+--- @param expr any
+--- @param expr1 any
+--- @return any
+function vim.fn.xor(expr, expr1) end
-- 
cgit 


From ccf328172bac2b02f9bd19fa58e105958514a28a Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Wed, 26 Jul 2023 21:07:39 +0800
Subject: fix(gen_vimfn_types): don't include tag before signature's line
 (#24492)

When signature is a bit long or there are too many tags, the tags appear
before the signature's line. Don't include the line with tags in the
previous function' docs.

Also fix lint warnings.
---
 runtime/lua/vim/_meta/vimfn.lua | 72 -----------------------------------------
 1 file changed, 72 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index b70e361e48..409c288036 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -135,14 +135,12 @@ function vim.fn.appendbufline(buf, lnum, text) end
 --- list is used: either the window number or the window ID.
 --- Returns -1 if the {winid} argument is invalid.
 ---
----           *argidx()*
 --- @param winid? integer
 --- @return integer
 function vim.fn.argc(winid) end
 
 --- the first file.  argc() - 1 is the last one.  See |arglist|.
 ---
----           *arglistid()*
 --- @return integer
 function vim.fn.argidx() end
 
@@ -157,7 +155,6 @@ function vim.fn.argidx() end
 --- page.
 --- {winnr} can be the window number or the |window-ID|.
 ---
----           *argv()*
 --- @param winnr? integer
 --- @param tabnr? integer
 --- @return integer
@@ -217,7 +214,6 @@ function vim.fn.asin(expr) end
 --- Can also be used as a |method|: >
 ---   GetCmd()->assert_beeps()
 --- <
----           *assert_equal()*
 --- @param cmd any
 --- @return 0|1
 function vim.fn.assert_beeps(cmd) end
@@ -240,7 +236,6 @@ function vim.fn.assert_beeps(cmd) end
 --- Can also be used as a |method|: >
 ---   mylist->assert_equal([1, 2, 3])
 ---
---- <          *assert_equalfile()*
 --- @param expected any
 --- @param actual any
 --- @param msg? any
@@ -271,7 +266,6 @@ function vim.fn.assert_equalfile() end
 ---     call assert_exception('E492:')
 ---   endtry
 --- <
----           *assert_fails()*
 --- @param error any
 --- @param msg? any
 --- @return 0|1
@@ -345,7 +339,6 @@ function vim.fn.assert_false(actual, msg) end
 --- but got {actual}".  When {msg} is present it is prefixed to
 --- that.
 ---
----             *assert_match()*
 --- @param lower any
 --- @param upper any
 --- @param actual any
@@ -387,7 +380,6 @@ function vim.fn.assert_match(pattern, actual, msg) end
 --- Can also be used as a |method|: >
 ---   GetCmd()->assert_nobeep()
 --- <
----           *assert_notequal()*
 --- @param cmd any
 --- @return 0|1
 function vim.fn.assert_nobeep(cmd) end
@@ -399,7 +391,6 @@ function vim.fn.assert_nobeep(cmd) end
 --- Can also be used as a |method|: >
 ---   mylist->assert_notequal([1, 2, 3])
 ---
---- <          *assert_notmatch()*
 --- @param expected any
 --- @param actual any
 --- @param msg? any
@@ -493,7 +484,6 @@ function vim.fn.atan2(expr1, expr2) end
 --- Can also be used as a |method|: >
 ---   GetBlob()->blob2list()
 --- <
----           *browse()*
 --- @param blob any
 --- @return any
 function vim.fn.blob2list(blob) end
@@ -508,7 +498,6 @@ function vim.fn.blob2list(blob) end
 --- An empty string is returned when the "Cancel" button is hit,
 --- something went wrong, or browsing is not possible.
 ---
----           *browsedir()*
 --- @param save any
 --- @param title any
 --- @param initdir any
@@ -660,7 +649,6 @@ function vim.fn.bufloaded(buf) end
 ---   bufname("%")    name of current buffer
 ---   bufname("file2")  name of buffer where "file2" matches.
 --- <
----           *bufnr()*
 --- @param buf? any
 --- @return string
 function vim.fn.bufname(buf) end
@@ -931,7 +919,6 @@ function vim.fn.charclass(string) end
 --- <Can also be used as a |method|: >
 ---   GetPos()->col()
 --- <
----           *charidx()*
 --- @param expr any
 --- @param winid? integer
 --- @return any
@@ -1202,7 +1189,6 @@ function vim.fn.complete_check() end
 --- <Can also be used as a |method|: >
 ---   GetItems()->complete_info()
 --- <
----         *confirm()*
 --- @param what? any
 --- @return table
 function vim.fn.complete_info(what) end
@@ -1261,7 +1247,6 @@ function vim.fn.complete_info(what) end
 --- Can also be used as a |method|in: >
 ---   BuildMessage()->confirm("&Yes\n&No")
 --- <
----           *copy()*
 --- @param msg any
 --- @param choices? any
 --- @param default? any
@@ -1554,7 +1539,6 @@ function vim.fn.dictwatcheradd(dict, pattern, callback) end
 --- arguments must match the ones passed to |dictwatcheradd()| in
 --- order for the watcher to be successfully deleted.
 ---
----           *did_filetype()*
 --- @param dict any
 --- @param pattern any
 --- @param callback any
@@ -1734,7 +1718,6 @@ function vim.fn.environ() end
 --- Can also be used as a |method|: >
 ---   GetText()->escape(' \')
 --- <
----           *eval()*
 --- @param string string
 --- @param chars any
 --- @return any
@@ -1832,7 +1815,6 @@ function vim.fn.execute(command, silent) end
 --- Can also be used as a |method|: >
 ---   GetCommand()->exepath()
 --- <
----           *exists()*
 --- @param expr any
 --- @return any
 function vim.fn.exepath(expr) end
@@ -2506,7 +2488,6 @@ function vim.fn.foldclosedend(lnum) end
 --- Can also be used as a |method|: >
 ---   GetLnum()->foldlevel()
 --- <
----           *foldtext()*
 --- @param lnum integer
 --- @return integer
 function vim.fn.foldlevel(lnum) end
@@ -2558,7 +2539,6 @@ function vim.fn.foldtextresult(lnum) end
 --- Can also be used as a |method|: >
 ---   GetName()->fullcommand()
 --- <
----         *funcref()*
 --- @param name string
 --- @return string
 function vim.fn.fullcommand(name) end
@@ -2577,7 +2557,6 @@ function vim.fn.fullcommand(name) end
 --- Can also be used as a |method|: >
 ---   GetFuncname()->funcref([arg])
 --- <
----     *function()* *partial* *E700* *E923*
 --- @param name string
 --- @param arglist? any
 --- @param dict? any
@@ -2701,7 +2680,6 @@ function vim.fn.garbagecollect(atexit) end
 ---   "args"  The list with arguments
 --- Returns zero on error.
 ---
----           *getbufinfo()*
 --- @param func any
 --- @param what any
 --- @return any
@@ -2775,7 +2753,6 @@ function vim.fn.get(func, what) end
 ---   GetBufnr()->getbufinfo()
 --- <
 ---
----           *getbufline()*
 --- @param dict? any
 --- @return any
 function vim.fn.getbufinfo(dict) end
@@ -2807,7 +2784,6 @@ function vim.fn.getbufinfo(dict) end
 --- <Can also be used as a |method|: >
 ---   GetBufnr()->getbufline(lnum)
 --- <
----           *getbufoneline()*
 --- @param buf any
 --- @param lnum integer
 --- @param end_? any
@@ -2963,7 +2939,6 @@ function vim.fn.getchar() end
 --- character itself are obtained.  Thus Shift-a results in "A"
 --- without a modifier.  Returns 0 if no modifiers are used.
 ---
----           *getcharpos()*
 --- @return integer
 function vim.fn.getcharmod() end
 
@@ -3162,7 +3137,6 @@ function vim.fn.getcmdwintype() end
 --- Can also be used as a |method|: >
 ---   GetPattern()->getcompletion('color')
 --- <
----           *getcurpos()*
 --- @param pat any
 --- @param type any
 --- @param filtered? any
@@ -3196,7 +3170,6 @@ function vim.fn.getcompletion(pat, type, filtered) end
 --- Can also be used as a |method|: >
 ---   GetWinid()->getcurpos()
 --- <
----           *getcursorcharpos()*
 --- @param winid? integer
 --- @return any
 function vim.fn.getcurpos(winid) end
@@ -3367,7 +3340,6 @@ function vim.fn.getftype(fname) end
 --- Can also be used as a |method|: >
 ---   GetWinnr()->getjumplist()
 ---
---- <          *getline()*
 --- @param winnr? integer
 --- @param tabnr? integer
 --- @return any
@@ -3528,13 +3500,11 @@ function vim.fn.getmatches(win) end
 --- When using |getchar()| the Vim variables |v:mouse_lnum|,
 --- |v:mouse_col| and |v:mouse_winid| also provide these values.
 ---
----           *getpid()*
 --- @return any
 function vim.fn.getmousepos() end
 
 --- This is a unique number, until Vim exits.
 ---
----           *getpos()*
 --- @return integer
 function vim.fn.getpid() end
 
@@ -3975,7 +3945,6 @@ function vim.fn.getwininfo(winid) end
 --- Can also be used as a |method|: >
 ---   GetTimeout()->getwinpos()
 --- <
----           *getwinposx()*
 --- @param timeout? integer
 --- @return any
 function vim.fn.getwinpos(timeout) end
@@ -3984,7 +3953,6 @@ function vim.fn.getwinpos(timeout) end
 --- -1 if the information is not available.
 --- The value can be used with `:winpos`.
 ---
----           *getwinposy()*
 --- @return integer
 function vim.fn.getwinposx() end
 
@@ -4067,7 +4035,6 @@ function vim.fn.glob(expr, nosuf, list, alllinks) end
 ---
 --- Can also be used as a |method|: >
 ---   GetExpr()->glob2regpat()
---- <            *globpath()*
 --- @param string string
 --- @return any
 function vim.fn.glob2regpat(string) end
@@ -4110,7 +4077,6 @@ function vim.fn.glob2regpat(string) end
 --- second argument: >
 ---   GetExpr()->globpath(&rtp)
 --- <
----           *has()*
 --- @param path string
 --- @param expr any
 --- @param nosuf? boolean
@@ -4391,7 +4357,6 @@ function vim.fn.hlID(name) end
 --- Can also be used as a |method|: >
 ---   GetName()->hlexists()
 --- <
----           *hlID()*
 --- @param name string
 --- @return 0|1
 function vim.fn.hlexists(name) end
@@ -4417,7 +4382,6 @@ function vim.fn.hostname() end
 --- Can also be used as a |method|: >
 ---   GetText()->iconv('latin1', 'utf-8')
 --- <
----           *indent()*
 --- @param string string
 --- @param from any
 --- @param to any
@@ -5067,7 +5031,6 @@ function vim.fn.keys(dict) end
 --- Can also be used as a |method|: >
 ---   "\<C-Home>"->keytrans()
 ---
---- <          *len()* *E701*
 --- @param string string
 --- @return any
 function vim.fn.keytrans(string) end
@@ -5088,7 +5051,6 @@ function vim.fn.last_buffer_nr(...) end
 --- Can also be used as a |method|: >
 ---   mylist->len()
 ---
---- <        *libcall()* *E364* *E368*
 --- @param expr any
 --- @return any
 function vim.fn.len(expr) end
@@ -5138,7 +5100,6 @@ function vim.fn.len(expr) end
 --- third argument: >
 ---   GetValue()->libcall("libc.so", "getenv")
 --- <
----           *libcallnr()*
 --- @param libname string
 --- @param funcname string
 --- @param argument any
@@ -5578,7 +5539,6 @@ function vim.fn.mapset(mode, abbr, dict) end
 ---   GetText()->match('word')
 ---   GetList()->match('word')
 --- <
----   *matchadd()* *E798* *E799* *E801* *E957*
 --- @param expr any
 --- @param pat any
 --- @param start? any
@@ -5646,7 +5606,6 @@ function vim.fn.match(expr, pat, start, count) end
 --- Can also be used as a |method|: >
 ---   GetGroup()->matchadd('TODO')
 --- <
----           *matchaddpos()*
 --- @param group any
 --- @param pattern any
 --- @param priority? any
@@ -5922,7 +5881,6 @@ function vim.fn.matchstr(expr, pat, start, count) end
 ---   GetText()->matchstrpos('word')
 --- <
 ---
----           *max()*
 --- @param expr any
 --- @param pat any
 --- @param start? any
@@ -6069,7 +6027,6 @@ function vim.fn.menu_get(path, modes) end
 ---   GetMenuName()->menu_info('v')
 ---
 ---
---- <          *min()*
 --- @param name string
 --- @param mode? string
 --- @return any
@@ -6086,7 +6043,6 @@ function vim.fn.menu_info(name, mode) end
 --- Can also be used as a |method|: >
 ---   mylist->min()
 ---
---- <          *mkdir()* *E739*
 --- @param expr any
 --- @return any
 function vim.fn.min(expr) end
@@ -6136,7 +6092,6 @@ function vim.fn.min(expr) end
 --- Can also be used as a |method|: >
 ---   GetName()->mkdir()
 --- <
----           *mode()*
 --- @param name string
 --- @param flags? string
 --- @param prot? any
@@ -6867,7 +6822,6 @@ function vim.fn.range(expr, max, stride) end
 --- Also see |readfile()| and |writefile()|.
 ---
 ---
----           *readdir()*
 --- @param fname integer
 --- @param offset? any
 --- @param size? any
@@ -6907,7 +6861,6 @@ function vim.fn.readblob(fname, offset, size) end
 ---   GetDirName()->readdir()
 --- <
 ---
----           *readfile()*
 --- @param directory any
 --- @param expr? any
 --- @return any
@@ -7120,7 +7073,6 @@ vim.fn['repeat'] = function(expr, count) end
 --- Can also be used as a |method|: >
 ---   GetName()->resolve()
 --- <
----           *reverse()*
 --- @param filename any
 --- @return any
 function vim.fn.resolve(filename) end
@@ -7325,7 +7277,6 @@ function vim.fn.screenrow() end
 --- Can also be used as a |method|: >
 ---   GetRow()->screenstring(col)
 --- <
----             *search()*
 --- @param row any
 --- @param col integer
 --- @return any
@@ -7589,7 +7540,6 @@ function vim.fn.searchcount(options) end
 --- Can also be used as a |method|: >
 ---   GetName()->searchdecl()
 --- <
----           *searchpair()*
 --- @param name string
 --- @param global? any
 --- @param thisblock? any
@@ -7974,7 +7924,6 @@ function vim.fn.setloclist(nr, list, action, what) end
 --- Can also be used as a |method|: >
 ---   GetMatches()->setmatches()
 --- <
----           *setpos()*
 --- @param list any
 --- @param win? any
 --- @return any
@@ -8150,7 +8099,6 @@ function vim.fn.setpos(expr, list) end
 --- second argument: >
 ---   GetErrorlist()->setqflist()
 --- <
----           *setreg()*
 --- @param list any
 --- @param action? any
 --- @param what? any
@@ -8553,7 +8501,6 @@ function vim.fn.sign_getdefined(name) end
 --- Can also be used as a |method|: >
 ---   GetBufname()->sign_getplaced()
 --- <
----           *sign_jump()*
 --- @param buf? any
 --- @param dict? any
 --- @return any
@@ -8576,7 +8523,6 @@ function vim.fn.sign_getplaced(buf, dict) end
 --- Can also be used as a |method|: >
 ---   GetSignid()->sign_jump()
 --- <
----           *sign_place()*
 --- @param id any
 --- @param group any
 --- @param buf any
@@ -8633,7 +8579,6 @@ function vim.fn.sign_jump(id, group, buf) end
 --- Can also be used as a |method|: >
 ---   GetSignid()->sign_place(group, name, expr)
 --- <
----           *sign_placelist()*
 --- @param id any
 --- @param group any
 --- @param name string
@@ -8996,7 +8941,6 @@ function vim.fn.sockconnect(mode, address, opts) end
 --- <For a simple expression you can use a lambda: >
 ---   eval mylist->sort({i1, i2 -> i1 - i2})
 --- <
----           *soundfold()*
 --- @param list any
 --- @param func? any
 --- @param dict? any
@@ -9013,7 +8957,6 @@ function vim.fn.sort(list, func, dict) end
 --- Can also be used as a |method|: >
 ---   GetWord()->soundfold()
 --- <
----           *spellbadword()*
 --- @param word any
 --- @return any
 function vim.fn.soundfold(word) end
@@ -9044,7 +8987,6 @@ function vim.fn.soundfold(word) end
 --- Can also be used as a |method|: >
 ---   GetText()->spellbadword()
 --- <
----           *spellsuggest()*
 --- @param sentence? any
 --- @return any
 function vim.fn.spellbadword(sentence) end
@@ -9429,7 +9371,6 @@ function vim.fn.strgetchar(str, index) end
 --- Can also be used as a |method|: >
 ---   GetHaystack()->stridx(needle)
 --- <
----           *string()*
 --- @param haystack any
 --- @param needle any
 --- @param start? any
@@ -10042,7 +9983,6 @@ function vim.fn.tabpagenr(arg) end
 --- Can also be used as a |method|: >
 ---   GetTabpage()->tabpagewinnr()
 --- <
----           *tagfiles()*
 --- @param tabarg any
 --- @param arg? any
 --- @return any
@@ -10134,7 +10074,6 @@ function vim.fn.tan(expr) end
 --- Can also be used as a |method|: >
 ---   Compute()->tanh()
 --- <
----           *timer_info()*
 --- @param expr any
 --- @return any
 function vim.fn.tanh(expr) end
@@ -10203,7 +10142,6 @@ function vim.fn.timer_info(id) end
 --- Can also be used as a |method|: >
 ---   GetTimer()->timer_pause(1)
 --- <
----         *timer_start()* *timer* *timers*
 --- @param timer any
 --- @param paused any
 --- @return any
@@ -10472,7 +10410,6 @@ function vim.fn.undotree() end
 --- Can also be used as a |method|: >
 ---   mylist->uniq()
 --- <
----           *utf16idx()*
 --- @param list any
 --- @param func? any
 --- @param dict? any
@@ -10849,7 +10786,6 @@ function vim.fn.win_screenpos(nr) end
 --- Can also be used as a |method|: >
 ---   GetWinid()->win_splitmove(target)
 --- <
----           *winbufnr()*
 --- @param nr integer
 --- @param target any
 --- @param options? table
@@ -10867,7 +10803,6 @@ function vim.fn.win_splitmove(nr, target, options) end
 --- Can also be used as a |method|: >
 ---   FindWindow()->winbufnr()->bufname()
 --- <
----           *wincol()*
 --- @param nr integer
 --- @return integer
 function vim.fn.winbufnr(nr) end
@@ -10875,7 +10810,6 @@ function vim.fn.winbufnr(nr) end
 --- cursor in the window.  This is counting screen cells from the
 --- left side of the window.  The leftmost column is one.
 ---
----           *windowsversion()*
 --- @return integer
 function vim.fn.wincol() end
 
@@ -10935,7 +10869,6 @@ function vim.fn.winheight(nr) end
 --- Can also be used as a |method|: >
 ---   GetTabnr()->winlayout()
 --- <
----           *winline()*
 --- @param tabnr? integer
 --- @return any
 function vim.fn.winlayout(tabnr) end
@@ -10945,7 +10878,6 @@ function vim.fn.winlayout(tabnr) end
 --- If the cursor was moved the view on the file will be updated
 --- first, this may cause a scroll.
 ---
----           *winnr()*
 --- @return integer
 function vim.fn.winline() end
 
@@ -10979,7 +10911,6 @@ function vim.fn.winline() end
 --- <Can also be used as a |method|: >
 ---   GetWinval()->winnr()
 --- <
----           *winrestcmd()*
 --- @param arg? any
 --- @return any
 function vim.fn.winnr(arg) end
@@ -10992,7 +10923,6 @@ function vim.fn.winnr(arg) end
 ---   :call MessWithWindowSizes()
 ---   :exe cmd
 --- <
----           *winrestview()*
 --- @return any
 function vim.fn.winrestcmd() end
 
@@ -11014,7 +10944,6 @@ function vim.fn.winrestcmd() end
 --- Can also be used as a |method|: >
 ---   GetView()->winrestview()
 --- <
----           *winsaveview()*
 --- @param dict any
 --- @return any
 function vim.fn.winrestview(dict) end
@@ -11089,7 +11018,6 @@ function vim.fn.winwidth(nr) end
 ---       (only in Visual mode)
 ---
 ---
----           *writefile()*
 --- @return any
 function vim.fn.wordcount() end
 
-- 
cgit 


From 42333ea98dfcd2994ee128a3467dfe68205154cd Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 28 Jul 2023 14:48:41 +0100
Subject: feat(docs): generate builtin.txt (#24493)

- eval.lua is now the source of truth.

- Formatting is much more consistent.

- Fixed Lua type generation for polymorphic functions (get(), etc).

- Removed "Overview" section from builtin.txt
  - Can generate this if we really want it.

- Moved functions from sign.txt and testing.txt into builtin.txt.

- Removed the *timer* *timers* tags since libuv timers via vim.uv should be preferred.

- Removed the temp-file-name tag from tempname()

- Moved lueval() from lua.txt to builtin.txt.

* Fix indent

* fixup!

* fixup! fixup!

* fixup! better tag formatting

* fixup: revert changes no longer needed

* fixup! CI

---------

Co-authored-by: zeertzjq <zeertzjq@outlook.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 575 +++++++++++++++++++++++++++++++---------
 1 file changed, 450 insertions(+), 125 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 409c288036..82213324e3 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -18,7 +18,7 @@
 ---   Compute()->abs()
 ---
 --- @param expr any
---- @return any
+--- @return number
 function vim.fn.abs(expr) end
 
 --- Return the arc cosine of {expr} measured in radians, as a
@@ -68,7 +68,7 @@ function vim.fn.add(object, expr) end
 ---
 --- @param expr any
 --- @param expr1 any
---- @return any
+--- @return integer
 vim.fn['and'] = function(expr, expr1) end
 
 --- Returns Dictionary of |api-metadata|.
@@ -76,7 +76,7 @@ vim.fn['and'] = function(expr, expr1) end
 --- View it in a nice human-readable format: >
 ---        :lua vim.print(vim.fn.api_info())
 ---
---- @return any
+--- @return table
 function vim.fn.api_info() end
 
 --- When {text} is a |List|: Append each item of the |List| as a
@@ -96,7 +96,7 @@ function vim.fn.api_info() end
 ---
 --- @param lnum integer
 --- @param text any
---- @return any
+--- @return 0|1
 function vim.fn.append(lnum, text) end
 
 --- Like |append()| but append the text in buffer {expr}.
@@ -122,8 +122,8 @@ function vim.fn.append(lnum, text) end
 ---
 --- @param buf any
 --- @param lnum integer
---- @param text any
---- @return any
+--- @param text string
+--- @return 0|1
 function vim.fn.appendbufline(buf, lnum, text) end
 
 --- The result is the number of files in the argument list.  See
@@ -139,6 +139,7 @@ function vim.fn.appendbufline(buf, lnum, text) end
 --- @return integer
 function vim.fn.argc(winid) end
 
+--- The result is the current index in the argument list.  0 is
 --- the first file.  argc() - 1 is the last one.  See |arglist|.
 ---
 --- @return integer
@@ -180,7 +181,7 @@ function vim.fn.arglistid(winnr, tabnr) end
 ---
 --- @param nr? integer
 --- @param winid? integer
---- @return any
+--- @return string|string[]
 function vim.fn.argv(nr, winid) end
 
 --- Return the arc sine of {expr} measured in radians, as a |Float|
@@ -197,13 +198,10 @@ function vim.fn.argv(nr, winid) end
 ---
 --- Can also be used as a |method|: >
 ---   Compute()->asin()
----
----
---- assert_ functions are documented here: |assert-functions-details|
----
+--- <
 ---
 --- @param expr any
---- @return any
+--- @return number
 function vim.fn.asin(expr) end
 
 --- Run {cmd} and add an error message to |v:errors| if it does
@@ -214,6 +212,7 @@ function vim.fn.asin(expr) end
 --- Can also be used as a |method|: >
 ---   GetCmd()->assert_beeps()
 --- <
+---
 --- @param cmd any
 --- @return 0|1
 function vim.fn.assert_beeps(cmd) end
@@ -251,7 +250,7 @@ function vim.fn.assert_equal(expected, actual, msg) end
 --- Can also be used as a |method|: >
 ---   GetLog()->assert_equalfile('expected.log')
 ---
---- @return any
+--- @return 0|1
 function vim.fn.assert_equalfile() end
 
 --- When v:exception does not contain the string {error} an error
@@ -266,6 +265,7 @@ function vim.fn.assert_equalfile() end
 ---     call assert_exception('E492:')
 ---   endtry
 --- <
+---
 --- @param error any
 --- @param msg? any
 --- @return 0|1
@@ -367,6 +367,7 @@ function vim.fn.assert_inrange(lower, upper, actual, msg) end
 --- Can also be used as a |method|: >
 ---   getFile()->assert_match('foo.*')
 --- <
+---
 --- @param pattern any
 --- @param actual any
 --- @param msg? any
@@ -380,6 +381,7 @@ function vim.fn.assert_match(pattern, actual, msg) end
 --- Can also be used as a |method|: >
 ---   GetCmd()->assert_nobeep()
 --- <
+---
 --- @param cmd any
 --- @return 0|1
 function vim.fn.assert_nobeep(cmd) end
@@ -391,10 +393,12 @@ function vim.fn.assert_nobeep(cmd) end
 --- Can also be used as a |method|: >
 ---   mylist->assert_notequal([1, 2, 3])
 ---
+--- <
+---
 --- @param expected any
 --- @param actual any
 --- @param msg? any
---- @return any
+--- @return 0|1
 function vim.fn.assert_notequal(expected, actual, msg) end
 
 --- The opposite of `assert_match()`: add an error message to
@@ -403,12 +407,12 @@ function vim.fn.assert_notequal(expected, actual, msg) end
 ---
 --- Can also be used as a |method|: >
 ---   getFile()->assert_notmatch('bar.*')
----
+--- <
 ---
 --- @param pattern any
 --- @param actual any
 --- @param msg? any
---- @return any
+--- @return 0|1
 function vim.fn.assert_notmatch(pattern, actual, msg) end
 
 --- Report a test failure directly, using String {msg}.
@@ -416,10 +420,10 @@ function vim.fn.assert_notmatch(pattern, actual, msg) end
 ---
 --- Can also be used as a |method|: >
 ---   GetMessage()->assert_report()
----
+--- <
 ---
 --- @param msg any
---- @return any
+--- @return 0|1
 function vim.fn.assert_report(msg) end
 
 --- When {actual} is not true an error message is added to
@@ -435,7 +439,7 @@ function vim.fn.assert_report(msg) end
 ---
 --- @param actual any
 --- @param msg? any
---- @return any
+--- @return 0|1
 function vim.fn.assert_true(actual, msg) end
 
 --- Return the principal value of the arc tangent of {expr}, in
@@ -484,8 +488,9 @@ function vim.fn.atan2(expr1, expr2) end
 --- Can also be used as a |method|: >
 ---   GetBlob()->blob2list()
 --- <
+---
 --- @param blob any
---- @return any
+--- @return any[]
 function vim.fn.blob2list(blob) end
 
 --- Put up a file requester.  This only works when "has("browse")"
@@ -502,7 +507,7 @@ function vim.fn.blob2list(blob) end
 --- @param title any
 --- @param initdir any
 --- @param default any
---- @return any
+--- @return 0|1
 function vim.fn.browse(save, title, initdir, default) end
 
 --- Put up a directory requester.  This only works when
@@ -518,7 +523,7 @@ function vim.fn.browse(save, title, initdir, default) end
 ---
 --- @param title any
 --- @param initdir any
---- @return any
+--- @return 0|1
 function vim.fn.browsedir(title, initdir) end
 
 --- Add a buffer to the buffer list with name {name} (must be a
@@ -570,14 +575,23 @@ function vim.fn.bufexists(buf) end
 
 --- @deprecated
 --- Obsolete name for |bufexists()|.
+---
+--- @param ... any
+--- @return 0|1
 function vim.fn.buffer_exists(...) end
 
 --- @deprecated
 --- Obsolete name for |bufname()|.
+---
+--- @param ... any
+--- @return string
 function vim.fn.buffer_name(...) end
 
 --- @deprecated
 --- Obsolete name for |bufnr()|.
+---
+--- @param ... any
+--- @return integer
 function vim.fn.buffer_number(...) end
 
 --- The result is a Number, which is |TRUE| if a buffer called
@@ -649,6 +663,7 @@ function vim.fn.bufloaded(buf) end
 ---   bufname("%")    name of current buffer
 ---   bufname("file2")  name of buffer where "file2" matches.
 --- <
+---
 --- @param buf? any
 --- @return string
 function vim.fn.bufname(buf) end
@@ -796,6 +811,7 @@ function vim.fn.byteidxcomp(expr, nr, utf16) end
 ---
 --- Can also be used as a |method|: >
 ---   GetFunc()->call([arg, arg], dict)
+--- <
 ---
 --- @param func any
 --- @param arglist any
@@ -818,9 +834,10 @@ function vim.fn.call(func, arglist, dict) end
 ---
 --- Can also be used as a |method|: >
 ---   Compute()->ceil()
+--- <
 ---
 --- @param expr any
---- @return any
+--- @return number
 function vim.fn.ceil(expr) end
 
 --- Close a channel or a specific stream associated with it.
@@ -834,7 +851,7 @@ function vim.fn.ceil(expr) end
 ---
 --- @param id any
 --- @param stream? any
---- @return any
+--- @return 0|1
 function vim.fn.chanclose(id, stream) end
 
 --- Return the number of the most recent change.  This is the same
@@ -865,10 +882,9 @@ function vim.fn.changenr() end
 --- was created with `"rpc":v:true` then the channel expects RPC
 --- messages, use |rpcnotify()| and |rpcrequest()| instead.
 ---
----
 --- @param id any
 --- @param data any
---- @return any
+--- @return 0|1
 function vim.fn.chansend(id, data) end
 
 --- Return Number value of the first char in {string}.
@@ -890,7 +906,7 @@ function vim.fn.chansend(id, data) end
 ---
 --- @param string string
 --- @param utf8? any
---- @return any
+--- @return 0|1
 function vim.fn.char2nr(string, utf8) end
 
 --- Return the character class of the first character in {string}.
@@ -903,9 +919,8 @@ function vim.fn.char2nr(string, utf8) end
 --- The class is used in patterns and word motions.
 --- Returns 0 if {string} is not a |String|.
 ---
----
 --- @param string string
---- @return any
+--- @return 0|1|2|3|'other'
 function vim.fn.charclass(string) end
 
 --- Same as |col()| but returns the character index of the column
@@ -919,9 +934,10 @@ function vim.fn.charclass(string) end
 --- <Can also be used as a |method|: >
 ---   GetPos()->col()
 --- <
+---
 --- @param expr any
 --- @param winid? integer
---- @return any
+--- @return integer
 function vim.fn.charcol(expr, winid) end
 
 --- Return the character index of the byte at {idx} in {string}.
@@ -963,7 +979,7 @@ function vim.fn.charcol(expr, winid) end
 --- @param idx integer
 --- @param countcc? any
 --- @param utf16? any
---- @return any
+--- @return integer
 function vim.fn.charidx(string, idx, countcc, utf16) end
 
 --- Change the current working directory to {dir}.  The scope of
@@ -990,8 +1006,9 @@ function vim.fn.charidx(string, idx, countcc, utf16) end
 --- <Can also be used as a |method|: >
 ---   GetDir()->chdir()
 --- <
+---
 --- @param dir string
---- @return any
+--- @return string
 function vim.fn.chdir(dir) end
 
 --- Get the amount of indent for line {lnum} according the C
@@ -1005,7 +1022,7 @@ function vim.fn.chdir(dir) end
 ---   GetLnum()->cindent()
 ---
 --- @param lnum integer
---- @return any
+--- @return integer
 function vim.fn.cindent(lnum) end
 
 --- Clears all matches previously defined for the current window
@@ -1016,8 +1033,8 @@ function vim.fn.cindent(lnum) end
 --- Can also be used as a |method|: >
 ---   GetWin()->clearmatches()
 --- <
+---
 --- @param win? any
---- @return any
 function vim.fn.clearmatches(win) end
 
 --- The result is a Number, which is the byte index of the column
@@ -1088,8 +1105,8 @@ function vim.fn.col(expr, winid) end
 ---
 ---   func ListMonths()
 ---     call complete(col('.'), ['January', 'February', 'March',
---- \ 'April', 'May', 'June', 'July', 'August', 'September',
---- \ 'October', 'November', 'December'])
+---       \ 'April', 'May', 'June', 'July', 'August', 'September',
+---       \ 'October', 'November', 'December'])
 ---     return ''
 ---   endfunc
 --- <This isn't very useful, but it shows how it works.  Note that
@@ -1125,7 +1142,6 @@ function vim.fn.complete_add(expr) end
 --- Only to be used by the function specified with the
 --- 'completefunc' option.
 ---
----
 --- @return 0|1
 function vim.fn.complete_check() end
 
@@ -1189,6 +1205,7 @@ function vim.fn.complete_check() end
 --- <Can also be used as a |method|: >
 ---   GetItems()->complete_info()
 --- <
+---
 --- @param what? any
 --- @return table
 function vim.fn.complete_info(what) end
@@ -1247,13 +1264,15 @@ function vim.fn.complete_info(what) end
 --- Can also be used as a |method|in: >
 ---   BuildMessage()->confirm("&Yes\n&No")
 --- <
+---
 --- @param msg any
 --- @param choices? any
 --- @param default? any
 --- @param type? any
---- @return any
+--- @return integer
 function vim.fn.confirm(msg, choices, default, type) end
 
+--- Make a copy of {expr}.  For Numbers and Strings this isn't
 --- different from using {expr} directly.
 --- When {expr} is a |List| a shallow copy is created.  This means
 --- that the original |List| can be changed without changing the
@@ -1281,7 +1300,7 @@ function vim.fn.copy(expr) end
 ---   Compute()->cos()
 ---
 --- @param expr any
---- @return any
+--- @return number
 function vim.fn.cos(expr) end
 
 --- Return the hyperbolic cosine of {expr} as a |Float| in the range
@@ -1298,7 +1317,7 @@ function vim.fn.cos(expr) end
 ---   Compute()->cosh()
 ---
 --- @param expr any
---- @return any
+--- @return number
 function vim.fn.cosh(expr) end
 
 --- Return the number of times an item with value {expr} appears
@@ -1316,11 +1335,12 @@ function vim.fn.cosh(expr) end
 --- Can also be used as a |method|: >
 ---   mylist->count(val)
 --- <
+---
 --- @param comp any
 --- @param expr any
 --- @param ic? any
 --- @param start? any
---- @return any
+--- @return integer
 function vim.fn.count(comp, expr, ic, start) end
 
 --- Returns a |Dictionary| representing the |context| at {index}
@@ -1328,7 +1348,7 @@ function vim.fn.count(comp, expr, ic, start) end
 --- If {index} is not given, it is assumed to be 0 (i.e.: top).
 ---
 --- @param index? any
---- @return any
+--- @return table
 function vim.fn.ctxget(index) end
 
 --- Pops and restores the |context| at the top of the
@@ -1362,6 +1382,12 @@ function vim.fn.ctxset(context, index) end
 --- @return any
 function vim.fn.ctxsize() end
 
+--- @param lnum integer
+--- @param col? integer
+--- @param off? any
+--- @return any
+function vim.fn.cursor(lnum, col, off) end
+
 --- Positions the cursor at the column (byte count) {col} in the
 --- line {lnum}.  The first column is one.
 ---
@@ -1410,6 +1436,7 @@ function vim.fn.cursor(list) end
 ---
 --- Can also be used as a |method|: >
 ---   GetPid()->debugbreak()
+--- <
 ---
 --- @param pid any
 --- @return any
@@ -1484,6 +1511,7 @@ function vim.fn.delete(fname, flags) end
 --- Can also be used as a |method|: >
 ---   GetBuffer()->deletebufline(1)
 --- <
+---
 --- @param buf any
 --- @param first any
 --- @param last? any
@@ -1545,6 +1573,7 @@ function vim.fn.dictwatcheradd(dict, pattern, callback) end
 --- @return any
 function vim.fn.dictwatcherdel(dict, pattern, callback) end
 
+--- Returns |TRUE| when autocommands are being executed and the
 --- FileType event has been triggered at least once.  Can be used
 --- to avoid triggering the FileType event again in the scripts
 --- that detect the file type. |FileType|
@@ -1718,11 +1747,13 @@ function vim.fn.environ() end
 --- Can also be used as a |method|: >
 ---   GetText()->escape(' \')
 --- <
+---
 --- @param string string
 --- @param chars any
 --- @return any
 function vim.fn.escape(string, chars) end
 
+--- Evaluate {string} and return the result.  Especially useful to
 --- turn the result of |string()| back into the original value.
 --- This works for Numbers, Floats, Strings, Blobs and composites
 --- of them.  Also works for |Funcref|s that refer to existing
@@ -1815,10 +1846,12 @@ function vim.fn.execute(command, silent) end
 --- Can also be used as a |method|: >
 ---   GetCommand()->exepath()
 --- <
+---
 --- @param expr any
 --- @return any
 function vim.fn.exepath(expr) end
 
+--- The result is a Number, which is |TRUE| if {expr} is
 --- defined, zero otherwise.
 ---
 --- For checking for a supported feature use |has()|.
@@ -2051,6 +2084,7 @@ function vim.fn.expand(string, nosuf, list) end
 --- Can also be used as a |method|: >
 ---   GetCommand()->expandcmd()
 --- <
+---
 --- @param string string
 --- @param options? table
 --- @return any
@@ -2093,7 +2127,7 @@ function vim.fn.expandcmd(string, options) end
 ---
 --- Can also be used as a |method|: >
 ---   mylist->extend(otherlist)
----
+--- <
 ---
 --- @param expr1 any
 --- @param expr2 any
@@ -2105,7 +2139,6 @@ function vim.fn.extend(expr1, expr2, expr3) end
 --- List or Dictionary is created and returned.  {expr1} remains
 --- unchanged.
 ---
----
 --- @param expr1 any
 --- @param expr2 any
 --- @param expr3? any
@@ -2166,7 +2199,10 @@ function vim.fn.feedkeys(string, mode) end
 
 --- @deprecated
 --- Obsolete name for |filereadable()|.
-function vim.fn.file_readable(...) end
+---
+--- @param file string
+--- @return any
+function vim.fn.file_readable(file) end
 
 --- The result is a Number, which is |TRUE| when a file with the
 --- name {file} exists, and can be read.  If {file} doesn't exist,
@@ -2319,6 +2355,7 @@ function vim.fn.findfile(name, path, count) end
 --- Can also be used as a |method|: >
 ---   mylist->flatten()
 --- <
+---
 --- @param list any
 --- @param maxdepth? any
 --- @return any[]|0
@@ -2326,7 +2363,6 @@ function vim.fn.flatten(list, maxdepth) end
 
 --- Like |flatten()| but first make a copy of {list}.
 ---
----
 --- @param list any
 --- @param maxdepth? any
 --- @return any[]|0
@@ -2488,10 +2524,12 @@ function vim.fn.foldclosedend(lnum) end
 --- Can also be used as a |method|: >
 ---   GetLnum()->foldlevel()
 --- <
+---
 --- @param lnum integer
 --- @return integer
 function vim.fn.foldlevel(lnum) end
 
+--- Returns a String, to be displayed for a closed fold.  This is
 --- the default function used for the 'foldtext' option and should
 --- only be called from evaluating 'foldtext'.  It uses the
 --- |v:foldstart|, |v:foldend| and |v:folddashes| variables.
@@ -2521,6 +2559,7 @@ function vim.fn.foldtext() end
 --- Can also be used as a |method|: >
 ---   GetLnum()->foldtextresult()
 --- <
+---
 --- @param lnum integer
 --- @return string
 function vim.fn.foldtextresult(lnum) end
@@ -2539,6 +2578,7 @@ function vim.fn.foldtextresult(lnum) end
 --- Can also be used as a |method|: >
 ---   GetName()->fullcommand()
 --- <
+---
 --- @param name string
 --- @return string
 function vim.fn.fullcommand(name) end
@@ -2557,6 +2597,7 @@ function vim.fn.fullcommand(name) end
 --- Can also be used as a |method|: >
 ---   GetFuncname()->funcref([arg])
 --- <
+---
 --- @param name string
 --- @param arglist? any
 --- @param dict? any
@@ -2672,6 +2713,41 @@ vim.fn['function'] = function(name, arglist, dict) end
 --- @return any
 function vim.fn.garbagecollect(atexit) end
 
+--- Get item {idx} from |List| {list}.  When this item is not
+--- available return {default}.  Return zero when {default} is
+--- omitted.
+--- Can also be used as a |method|: >
+---   mylist->get(idx)
+---
+--- @param list any[]
+--- @param idx integer
+--- @param default? any
+--- @return any
+function vim.fn.get(list, idx, default) end
+
+--- Get byte {idx} from |Blob| {blob}.  When this byte is not
+--- available return {default}.  Return -1 when {default} is
+--- omitted.
+---
+--- @param blob string
+--- @param idx integer
+--- @param default? any
+--- @return any
+function vim.fn.get(blob, idx, default) end
+
+--- Get item with key {key} from |Dictionary| {dict}.  When this
+--- item is not available return {default}.  Return zero when
+--- {default} is omitted.  Useful example: >
+---   let val = get(g:, 'var_name', 'default')
+--- <This gets the value of g:var_name if it exists, and uses
+--- "default" when it does not exist.
+---
+--- @param dict table<string,any>
+--- @param key string
+--- @param default? any
+--- @return any
+function vim.fn.get(dict, key, default) end
+
 --- Get item {what} from Funcref {func}.  Possible values for
 --- {what} are:
 ---   "name"  The function name
@@ -2680,11 +2756,15 @@ function vim.fn.garbagecollect(atexit) end
 ---   "args"  The list with arguments
 --- Returns zero on error.
 ---
---- @param func any
---- @param what any
+--- @param func function
+--- @param what string
 --- @return any
 function vim.fn.get(func, what) end
 
+--- @param buf? integer|string
+--- @return any
+function vim.fn.getbufinfo(buf) end
+
 --- Get information about buffers as a List of Dictionaries.
 ---
 --- Without an argument information about all the buffers is
@@ -2753,7 +2833,7 @@ function vim.fn.get(func, what) end
 ---   GetBufnr()->getbufinfo()
 --- <
 ---
---- @param dict? any
+--- @param dict? table<string,any>
 --- @return any
 function vim.fn.getbufinfo(dict) end
 
@@ -2784,9 +2864,10 @@ function vim.fn.getbufinfo(dict) end
 --- <Can also be used as a |method|: >
 ---   GetBufnr()->getbufline(lnum)
 --- <
+---
 --- @param buf any
 --- @param lnum integer
---- @param end_? any
+--- @param end_? integer
 --- @return any
 function vim.fn.getbufline(buf, lnum, end_) end
 
@@ -2821,6 +2902,7 @@ function vim.fn.getbufoneline(buf, lnum) end
 --- <Can also be used as a |method|: >
 ---   GetBufnr()->getbufvar(varname)
 --- <
+---
 --- @param buf any
 --- @param varname string
 --- @param def? any
@@ -2832,7 +2914,6 @@ function vim.fn.getbufvar(buf, varname, def) end
 --- |setcellwidths()|.  If no character ranges have their cell
 --- widths overridden, an empty List is returned.
 ---
----
 --- @return any
 function vim.fn.getcellwidths() end
 
@@ -2854,8 +2935,8 @@ function vim.fn.getcellwidths() end
 --- Can also be used as a |method|: >
 ---   GetBufnr()->getchangelist()
 ---
---- @param buf? any
---- @return any
+--- @param buf? integer|string
+--- @return table[]
 function vim.fn.getchangelist(buf) end
 
 --- Get a single character from the user or input stream.
@@ -2921,6 +3002,7 @@ function vim.fn.getchangelist(buf) end
 ---   :  endwhile
 ---   :endfunction
 --- <
+---
 --- @return integer
 function vim.fn.getchar() end
 
@@ -2958,7 +3040,7 @@ function vim.fn.getcharmod() end
 ---   GetMark()->getcharpos()
 ---
 --- @param expr any
---- @return any
+--- @return integer[]
 function vim.fn.getcharpos(expr) end
 
 --- Return the current character search information as a {dict}
@@ -2980,8 +3062,7 @@ function vim.fn.getcharpos(expr) end
 ---   :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
 --- <Also see |setcharsearch()|.
 ---
----
---- @return any
+--- @return table[]
 function vim.fn.getcharsearch() end
 
 --- Get a single character from the user or input stream as a
@@ -3030,7 +3111,7 @@ function vim.fn.getcmdline() end
 --- Also see |getcmdtype()|, |setcmdpos()|, |getcmdline()| and
 --- |setcmdline()|.
 ---
---- @return any
+--- @return integer
 function vim.fn.getcmdpos() end
 
 --- Return the screen position of the cursor in the command line
@@ -3137,6 +3218,7 @@ function vim.fn.getcmdwintype() end
 --- Can also be used as a |method|: >
 ---   GetPattern()->getcompletion('color')
 --- <
+---
 --- @param pat any
 --- @param type any
 --- @param filtered? any
@@ -3170,6 +3252,7 @@ function vim.fn.getcompletion(pat, type, filtered) end
 --- Can also be used as a |method|: >
 ---   GetWinid()->getcurpos()
 --- <
+---
 --- @param winid? integer
 --- @return any
 function vim.fn.getcurpos(winid) end
@@ -3339,6 +3422,7 @@ function vim.fn.getftype(fname) end
 ---
 --- Can also be used as a |method|: >
 ---   GetWinnr()->getjumplist()
+--- <
 ---
 --- @param winnr? integer
 --- @param tabnr? integer
@@ -3374,7 +3458,7 @@ function vim.fn.getjumplist(winnr, tabnr) end
 ---
 --- @param lnum integer
 --- @param end_? any
---- @return any
+--- @return string|string[]
 function vim.fn.getline(lnum, end_) end
 
 --- Returns a |List| with all the entries in the location list for
@@ -3406,7 +3490,7 @@ function vim.fn.getline(lnum, end_) end
 --- Examples (See also |getqflist-examples|): >
 ---   :echo getloclist(3, {'all': 0})
 ---   :echo getloclist(5, {'filewinid': 0})
----
+--- <
 ---
 --- @param nr integer
 --- @param what? any
@@ -3448,26 +3532,27 @@ function vim.fn.getmarklist(buf) end
 --- an empty list is returned.
 --- Example: >vim
 ---   :echo getmatches()
---- >
----        [{"group": "MyGroup1", "pattern": "TODO",
+--- < >
+---   [{"group": "MyGroup1", "pattern": "TODO",
 ---   "priority": 10, "id": 1}, {"group": "MyGroup2",
 ---   "pattern": "FIXME", "priority": 10, "id": 2}]
---- >vim
+--- < >vim
 ---   :let m = getmatches()
 ---   :call clearmatches()
 ---   :echo getmatches()
---- >
+--- < >
 ---   []
---- >vim
+--- < >vim
 ---   :call setmatches(m)
 ---   :echo getmatches()
---- >
+--- < >
 ---   [{"group": "MyGroup1", "pattern": "TODO",
 ---   "priority": 10, "id": 1}, {"group": "MyGroup2",
 ---   "pattern": "FIXME", "priority": 10, "id": 2}]
---- >vim
+--- < >vim
 ---   :unlet m
 --- <
+---
 --- @param win? any
 --- @return any
 function vim.fn.getmatches(win) end
@@ -3503,11 +3588,13 @@ function vim.fn.getmatches(win) end
 --- @return any
 function vim.fn.getmousepos() end
 
+--- Return a Number which is the process ID of the Vim process.
 --- This is a unique number, until Vim exits.
 ---
 --- @return integer
 function vim.fn.getpid() end
 
+--- Get the position for String {expr}.  For possible values of
 --- {expr} see |line()|.  For getting the cursor position see
 --- |getcurpos()|.
 --- The result is a |List| with four numbers:
@@ -3641,6 +3728,7 @@ function vim.fn.getpos(expr) end
 ---   :echo getqflist({'nr': 2, 'title': 1})
 ---   :echo getqflist({'lines' : ["F1:10:L10"]})
 --- <
+---
 --- @param what? any
 --- @return any
 function vim.fn.getqflist(what) end
@@ -3757,6 +3845,7 @@ function vim.fn.getregtype(regname) end
 ---   :echo getscriptinfo({'name': 'myscript'})
 ---   :echo getscriptinfo({'sid': 15}).variables
 --- <
+---
 --- @param opts? table
 --- @return any
 function vim.fn.getscriptinfo(opts) end
@@ -3822,8 +3911,8 @@ function vim.fn.gettabvar(tabnr, varname, def) end
 --- <
 --- To obtain all window-local variables use: >
 ---   gettabwinvar({tabnr}, {winnr}, '&')
----
---- <Can also be used as a |method|: >
+--- <
+--- Can also be used as a |method|: >
 ---   GetTabnr()->gettabwinvar(winnr, varname)
 ---
 --- @param tabnr integer
@@ -3862,7 +3951,7 @@ function vim.fn.gettabwinvar(tabnr, winnr, varname, def) end
 ---
 --- Can also be used as a |method|: >
 ---   GetWinnr()->gettagstack()
----
+--- <
 ---
 --- @param winnr? integer
 --- @return any
@@ -3878,7 +3967,6 @@ function vim.fn.gettagstack(winnr) end
 --- xgettext does not understand escaping in single quoted
 --- strings.
 ---
----
 --- @param text any
 --- @return any
 function vim.fn.gettext(text) end
@@ -3945,10 +4033,12 @@ function vim.fn.getwininfo(winid) end
 --- Can also be used as a |method|: >
 ---   GetTimeout()->getwinpos()
 --- <
+---
 --- @param timeout? integer
 --- @return any
 function vim.fn.getwinpos(timeout) end
 
+--- The result is a Number, which is the X coordinate in pixels of
 --- the left hand side of the GUI Vim window.  The result will be
 --- -1 if the information is not available.
 --- The value can be used with `:winpos`.
@@ -3956,6 +4046,7 @@ function vim.fn.getwinpos(timeout) end
 --- @return integer
 function vim.fn.getwinposx() end
 
+--- The result is a Number, which is the Y coordinate in pixels of
 --- the top of the GUI Vim window.  The result will be -1 if the
 --- information is not available.
 --- The value can be used with `:winpos`.
@@ -3971,6 +4062,7 @@ function vim.fn.getwinposy() end
 --- <Can also be used as a |method|: >
 ---   GetWinnr()->getwinvar(varname)
 --- <
+---
 --- @param winnr integer
 --- @param varname string
 --- @param def? any
@@ -4035,6 +4127,8 @@ function vim.fn.glob(expr, nosuf, list, alllinks) end
 ---
 --- Can also be used as a |method|: >
 ---   GetExpr()->glob2regpat()
+--- <
+---
 --- @param string string
 --- @return any
 function vim.fn.glob2regpat(string) end
@@ -4077,6 +4171,7 @@ function vim.fn.glob2regpat(string) end
 --- second argument: >
 ---   GetExpr()->globpath(&rtp)
 --- <
+---
 --- @param path string
 --- @param expr any
 --- @param nosuf? boolean
@@ -4085,6 +4180,7 @@ function vim.fn.glob2regpat(string) end
 --- @return any
 function vim.fn.globpath(path, expr, nosuf, list, allinks) end
 
+--- Returns 1 if {feature} is supported, 0 otherwise.  The
 --- {feature} argument is a feature name like "nvim-0.2.1" or
 --- "win32", see below.  See also |exists()|.
 ---
@@ -4141,7 +4237,7 @@ function vim.fn.globpath(path, expr, nosuf, list, allinks) end
 --- <4.  Vim version. For example the "patch-7.4.237" feature means
 ---     that Nvim is Vim-compatible to version 7.4.237 or later. >
 ---   :if has("patch-7.4.237")
----
+--- <
 ---
 --- @param feature any
 --- @return 0|1
@@ -4224,11 +4320,17 @@ function vim.fn.hasmapto(what, mode, abbr) end
 
 --- @deprecated
 --- Obsolete name for |hlID()|.
-function vim.fn.highlightID(...) end
+---
+--- @param name string
+--- @return any
+function vim.fn.highlightID(name) end
 
 --- @deprecated
 --- Obsolete name for |hlexists()|.
-function vim.fn.highlight_exists(...) end
+---
+--- @param name string
+--- @return any
+function vim.fn.highlight_exists(name) end
 
 --- Add the String {item} to the history {history} which can be
 --- one of:          *hist-names*
@@ -4330,10 +4432,12 @@ function vim.fn.histget(history, index) end
 --- <Can also be used as a |method|: >
 ---   GetHistory()->histnr()
 --- <
+---
 --- @param history any
 --- @return integer
 function vim.fn.histnr(history) end
 
+--- The result is a Number, which is the ID of the highlight group
 --- with name {name}.  When the highlight group doesn't exist,
 --- zero is returned.
 --- This can be used to retrieve information about the highlight
@@ -4357,6 +4461,7 @@ function vim.fn.hlID(name) end
 --- Can also be used as a |method|: >
 ---   GetName()->hlexists()
 --- <
+---
 --- @param name string
 --- @return 0|1
 function vim.fn.hlexists(name) end
@@ -4382,6 +4487,7 @@ function vim.fn.hostname() end
 --- Can also be used as a |method|: >
 ---   GetText()->iconv('latin1', 'utf-8')
 --- <
+---
 --- @param string string
 --- @param from any
 --- @param to any
@@ -4500,6 +4606,13 @@ function vim.fn.index(object, expr, start, ic) end
 --- @return any
 function vim.fn.indexof(object, expr, opts) end
 
+---
+--- @param prompt any
+--- @param text? any
+--- @param completion? any
+--- @return any
+function vim.fn.input(prompt, text, completion) end
+
 --- The result is a String, which is whatever the user typed on
 --- the command-line.  The {prompt} argument is either a prompt
 --- string, or a blank string (for no prompt).  A '\n' can be used
@@ -4618,6 +4731,9 @@ function vim.fn.input(opts) end
 
 --- @deprecated
 --- Use |input()| instead.
+---
+--- @param ... any
+--- @return any
 function vim.fn.inputdialog(...) end
 
 --- {textlist} must be a |List| of strings.  This |List| is
@@ -4804,6 +4920,9 @@ function vim.fn.items(dict) end
 
 --- @deprecated
 --- Obsolete name for |chanclose()|
+---
+--- @param ... any
+--- @return any
 function vim.fn.jobclose(...) end
 
 --- Return the PID (process id) of |job-id| {job}.
@@ -4824,6 +4943,9 @@ function vim.fn.jobresize(job, width, height) end
 
 --- @deprecated
 --- Obsolete name for |chansend()|
+---
+--- @param ... any
+--- @return any
 function vim.fn.jobsend(...) end
 
 --- Note: Prefer |vim.system()| in Lua.
@@ -5030,6 +5152,7 @@ function vim.fn.keys(dict) end
 ---
 --- Can also be used as a |method|: >
 ---   "\<C-Home>"->keytrans()
+--- <
 ---
 --- @param string string
 --- @return any
@@ -5037,7 +5160,9 @@ function vim.fn.keytrans(string) end
 
 --- @deprecated
 --- Obsolete name for bufnr("$").
-function vim.fn.last_buffer_nr(...) end
+---
+--- @return any
+function vim.fn.last_buffer_nr() end
 
 --- When {expr} is a String or a Number the length in bytes is
 --- used, as with |strlen()|.
@@ -5050,6 +5175,7 @@ function vim.fn.last_buffer_nr(...) end
 ---
 --- Can also be used as a |method|: >
 ---   mylist->len()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -5100,6 +5226,7 @@ function vim.fn.len(expr) end
 --- third argument: >
 ---   GetValue()->libcall("libc.so", "getenv")
 --- <
+---
 --- @param libname string
 --- @param funcname string
 --- @param argument any
@@ -5117,6 +5244,7 @@ function vim.fn.libcall(libname, funcname, argument) end
 --- third argument: >
 ---   GetValue()->libcallnr("libc.so", "printf")
 --- <
+---
 --- @param libname string
 --- @param funcname string
 --- @param argument any
@@ -5236,7 +5364,6 @@ function vim.fn.list2str(list, utf8) end
 --- Return the current time, measured as seconds since 1st Jan
 --- 1970.  See also |strftime()|, |strptime()| and |getftime()|.
 ---
----
 --- @return any
 function vim.fn.localtime() end
 
@@ -5273,17 +5400,6 @@ function vim.fn.log(expr) end
 --- @return any
 function vim.fn.log10(expr) end
 
---- Evaluate Lua expression {expr} and return its result converted
---- to Vim data structures. See |lua-eval| for more details.
----
---- Can also be used as a |method|: >
----   GetExpr()->luaeval()
----
---- @param expr any
---- @param expr1? any
---- @return any
-function vim.fn.luaeval(expr, expr1) end
-
 --- {expr1} must be a |List|, |Blob| or |Dictionary|.
 --- Replace each item in {expr1} with the result of evaluating
 --- {expr2}.  For a |Blob| each byte is replaced.
@@ -5332,7 +5448,7 @@ function vim.fn.luaeval(expr, expr1) end
 ---
 --- Can also be used as a |method|: >
 ---   mylist->map(expr2)
----
+--- <
 ---
 --- @param expr1 any
 --- @param expr2 any
@@ -5407,9 +5523,9 @@ function vim.fn.map(expr1, expr2) end
 ---
 --- @param name string
 --- @param mode? string
---- @param abbr? any
---- @param dict? any
---- @return any
+--- @param abbr? boolean
+--- @param dict? boolean
+--- @return string|table<string,any>
 function vim.fn.maparg(name, mode, abbr, dict) end
 
 --- Check if there is a mapping that matches with {name} in mode
@@ -5467,7 +5583,6 @@ function vim.fn.mapcheck(name, mode, abbr) end
 --- e.g. with `:map!`, you need to save the mapping for all of
 --- them, since they can differ.
 ---
----
 --- @param mode string
 --- @param abbr any
 --- @param dict any
@@ -5539,6 +5654,7 @@ function vim.fn.mapset(mode, abbr, dict) end
 ---   GetText()->match('word')
 ---   GetList()->match('word')
 --- <
+---
 --- @param expr any
 --- @param pat any
 --- @param start? any
@@ -5606,6 +5722,7 @@ function vim.fn.match(expr, pat, start, count) end
 --- Can also be used as a |method|: >
 ---   GetGroup()->matchadd('TODO')
 --- <
+---
 --- @param group any
 --- @param pattern any
 --- @param priority? any
@@ -5888,6 +6005,7 @@ function vim.fn.matchstr(expr, pat, start, count) end
 --- @return any
 function vim.fn.matchstrpos(expr, pat, start, count) end
 
+--- Return the maximum value of all items in {expr}. Example: >
 ---   echo max([apples, pears, oranges])
 ---
 --- <{expr} can be a |List| or a |Dictionary|.  For a Dictionary,
@@ -5898,7 +6016,7 @@ function vim.fn.matchstrpos(expr, pat, start, count) end
 ---
 --- Can also be used as a |method|: >
 ---   mylist->max()
----
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -6025,13 +6143,14 @@ function vim.fn.menu_get(path, modes) end
 --- <
 --- Can also be used as a |method|: >
 ---   GetMenuName()->menu_info('v')
----
+--- <
 ---
 --- @param name string
 --- @param mode? string
 --- @return any
 function vim.fn.menu_info(name, mode) end
 
+--- Return the minimum value of all items in {expr}. Example: >
 ---   echo min([apples, pears, oranges])
 ---
 --- <{expr} can be a |List| or a |Dictionary|.  For a Dictionary,
@@ -6042,6 +6161,7 @@ function vim.fn.menu_info(name, mode) end
 ---
 --- Can also be used as a |method|: >
 ---   mylist->min()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -6092,12 +6212,14 @@ function vim.fn.min(expr) end
 --- Can also be used as a |method|: >
 ---   GetName()->mkdir()
 --- <
+---
 --- @param name string
 --- @param flags? string
 --- @param prot? any
 --- @return any
 function vim.fn.mkdir(name, flags, prot) end
 
+--- Return a string that indicates the current mode.
 --- If [expr] is supplied and it evaluates to a non-zero Number or
 --- a non-empty String (|non-zero-arg|), then the full mode is
 --- returned, otherwise only the first letter is returned.
@@ -6283,17 +6405,7 @@ function vim.fn.nextnonblank(lnum) end
 ---
 --- Can also be used as a |method|: >
 ---   GetNumber()->nr2char()
----
---- nvim_...({...})          *E5555* *nvim_...()* *eval-api*
---- Call nvim |api| functions. The type checking of arguments will
---- be stricter than for most other builtins. For instance,
---- if Integer is expected, a |Number| must be passed in, a
---- |String| will not be autoconverted.
---- Buffer numbers, as returned by |bufnr()| could be used as
---- first argument to nvim_buf_... functions.  All functions
---- expecting an object (buffer, window or tabpage) can
---- also take the numerical value 0 to indicate the current
---- (focused) object.
+--- <
 ---
 --- @param expr any
 --- @param utf8? any
@@ -6313,7 +6425,6 @@ function vim.fn.nr2char(expr, utf8) end
 --- to separate commands.  In many places it would not be clear if
 --- "|" is an operator or a command separator.
 ---
----
 --- @param expr any
 --- @param expr1 any
 --- @return any
@@ -6716,7 +6827,7 @@ function vim.fn.pumvisible() end
 --- Can also be used as a |method|: >
 ---   GetExpr()->py3eval()
 --- <
----           *E858* *E859*
+---
 --- @param expr any
 --- @return any
 function vim.fn.py3eval(expr) end
@@ -6744,6 +6855,7 @@ function vim.fn.pyeval(expr) end
 --- Can also be used as a |method|: >
 ---   GetExpr()->pyxeval()
 --- <
+---
 --- @param expr any
 --- @return any
 function vim.fn.pyxeval(expr) end
@@ -6766,7 +6878,6 @@ function vim.fn.pyxeval(expr) end
 ---   seed->rand()
 --- <
 ---
----           *E726* *E727*
 --- @param expr? any
 --- @return any
 function vim.fn.rand(expr) end
@@ -6821,7 +6932,6 @@ function vim.fn.range(expr, max, stride) end
 --- is truncated.
 --- Also see |readfile()| and |writefile()|.
 ---
----
 --- @param fname integer
 --- @param offset? any
 --- @param size? any
@@ -6848,12 +6958,12 @@ function vim.fn.readblob(fname, offset, size) end
 ---   readdir(dirname, {n -> n !~ '^\.\|\~$'})
 ---
 --- <If you want to get a directory tree: >
----                   function! s:tree(dir)
----                       return {a:dir : map(readdir(a:dir),
+---   function! s:tree(dir)
+---       return {a:dir : map(readdir(a:dir),
 ---       \ {_, x -> isdirectory(x) ?
 ---       \          {x : s:tree(a:dir .. '/' .. x)} : x})}
----                   endfunction
----                   echo s:tree(".")
+---   endfunction
+---   echo s:tree(".")
 --- <
 --- Returns an empty List on error.
 ---
@@ -6900,6 +7010,7 @@ function vim.fn.readdir(directory, expr) end
 ---
 --- Can also be used as a |method|: >
 ---   GetFileName()->readfile()
+--- <
 ---
 --- @param fname integer
 --- @param type? any
@@ -6951,6 +7062,13 @@ function vim.fn.reg_recorded() end
 --- @return any
 function vim.fn.reg_recording() end
 
+--- @return any
+function vim.fn.reltime() end
+
+--- @param start? any
+--- @return any
+function vim.fn.reltime(start) end
+
 --- Return an item that represents a time value.  The item is a
 --- list with items that depend on the system.
 --- The item can be passed to |reltimestr()| to convert it to a
@@ -7011,10 +7129,61 @@ function vim.fn.reltimefloat(time) end
 --- Can also be used as a |method|: >
 ---   reltime(start)->reltimestr()
 --- <
+---
 --- @param time any
 --- @return any
 function vim.fn.reltimestr(time) end
 
+--- @param list any
+--- @param idx integer
+--- @return any
+function vim.fn.remove(list, idx) end
+
+--- Without {end}: Remove the item at {idx} from |List| {list} and
+--- return the item.
+--- With {end}: Remove items from {idx} to {end} (inclusive) and
+--- return a |List| with these items.  When {idx} points to the same
+--- item as {end} a list with one item is returned.  When {end}
+--- points to an item before {idx} this is an error.
+--- See |list-index| for possible values of {idx} and {end}.
+--- Returns zero on error.
+--- Example: >
+---   :echo "last item: " .. remove(mylist, -1)
+---   :call remove(mylist, 0, 9)
+--- <
+--- Use |delete()| to remove a file.
+---
+--- Can also be used as a |method|: >
+---   mylist->remove(idx)
+---
+--- @param list any
+--- @param idx integer
+--- @param end_? any
+--- @return any
+function vim.fn.remove(list, idx, end_) end
+
+--- @param blob any
+--- @param idx integer
+--- @return any
+function vim.fn.remove(blob, idx) end
+
+--- Without {end}: Remove the byte at {idx} from |Blob| {blob} and
+--- return the byte.
+--- With {end}: Remove bytes from {idx} to {end} (inclusive) and
+--- return a |Blob| with these bytes.  When {idx} points to the same
+--- byte as {end} a |Blob| with one byte is returned.  When {end}
+--- points to a byte before {idx} this is an error.
+--- Returns zero on error.
+--- Example: >
+---   :echo "last byte: " .. remove(myblob, -1)
+---   :call remove(mylist, 0, 9)
+---
+--- @param blob any
+--- @param idx integer
+--- @param end_? any
+--- @return any
+function vim.fn.remove(blob, idx, end_) end
+
 --- Remove the entry from {dict} with key {key} and return it.
 --- Example: >
 ---   :echo "removed " .. remove(dict, "one")
@@ -7052,6 +7221,7 @@ function vim.fn.rename(from, to) end
 ---
 --- Can also be used as a |method|: >
 ---   mylist->repeat(count)
+--- <
 ---
 --- @param expr any
 --- @param count any
@@ -7073,6 +7243,7 @@ vim.fn['repeat'] = function(expr, count) end
 --- Can also be used as a |method|: >
 ---   GetName()->resolve()
 --- <
+---
 --- @param filename any
 --- @return any
 function vim.fn.resolve(filename) end
@@ -7147,6 +7318,9 @@ function vim.fn.rpcstart(prog, argv) end
 --- `chanclose(id, "rpc")` to close RPC communication
 --- without stopping the job. Use chanclose(id) to close
 --- any socket.
+---
+--- @param ... any
+--- @return any
 function vim.fn.rpcstop(...) end
 
 --- Evaluate Ruby expression {expr} and return its result
@@ -7222,6 +7396,7 @@ function vim.fn.screenchars(row, col) end
 ---   nnoremap <silent> GG :echom screencol()<CR>
 ---   noremap GG <Cmd>echom screencol()<Cr>
 --- <
+---
 --- @return any
 function vim.fn.screencol() end
 
@@ -7277,6 +7452,7 @@ function vim.fn.screenrow() end
 --- Can also be used as a |method|: >
 ---   GetRow()->screenstring(col)
 --- <
+---
 --- @param row any
 --- @param col integer
 --- @return any
@@ -7516,6 +7692,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
 --- Can also be used as a |method|: >
 ---   GetSearchOpts()->searchcount()
 --- <
+---
 --- @param options? table
 --- @return any
 function vim.fn.searchcount(options) end
@@ -7540,12 +7717,113 @@ function vim.fn.searchcount(options) end
 --- Can also be used as a |method|: >
 ---   GetName()->searchdecl()
 --- <
+---
 --- @param name string
 --- @param global? any
 --- @param thisblock? any
 --- @return any
 function vim.fn.searchdecl(name, global, thisblock) end
 
+--- Search for the match of a nested start-end pair.  This can be
+--- used to find the "endif" that matches an "if", while other
+--- if/endif pairs in between are ignored.
+--- The search starts at the cursor.  The default is to search
+--- forward, include 'b' in {flags} to search backward.
+--- If a match is found, the cursor is positioned at it and the
+--- line number is returned.  If no match is found 0 or -1 is
+--- returned and the cursor doesn't move.  No error message is
+--- given.
+---
+--- {start}, {middle} and {end} are patterns, see |pattern|.  They
+--- must not contain \( \) pairs.  Use of \%( \) is allowed.  When
+--- {middle} is not empty, it is found when searching from either
+--- direction, but only when not in a nested start-end pair.  A
+--- typical use is: >
+---   searchpair('\<if\>', '\<else\>', '\<endif\>')
+--- <By leaving {middle} empty the "else" is skipped.
+---
+--- {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
+--- |search()|.  Additionally:
+--- 'r'  Repeat until no more matches found; will find the
+---   outer pair.  Implies the 'W' flag.
+--- 'm'  Return number of matches instead of line number with
+---   the match; will be > 1 when 'r' is used.
+--- Note: it's nearly always a good idea to use the 'W' flag, to
+--- avoid wrapping around the end of the file.
+---
+--- When a match for {start}, {middle} or {end} is found, the
+--- {skip} expression is evaluated with the cursor positioned on
+--- the start of the match.  It should return non-zero if this
+--- match is to be skipped.  E.g., because it is inside a comment
+--- or a string.
+--- When {skip} is omitted or empty, every match is accepted.
+--- When evaluating {skip} causes an error the search is aborted
+--- and -1 returned.
+--- {skip} can be a string, a lambda, a funcref or a partial.
+--- Anything else makes the function fail.
+---
+--- For {stopline} and {timeout} see |search()|.
+---
+--- The value of 'ignorecase' is used.  'magic' is ignored, the
+--- patterns are used like it's on.
+---
+--- The search starts exactly at the cursor.  A match with
+--- {start}, {middle} or {end} at the next character, in the
+--- direction of searching, is the first one found.  Example: >
+---   if 1
+---     if 2
+---     endif 2
+---   endif 1
+--- <When starting at the "if 2", with the cursor on the "i", and
+--- searching forwards, the "endif 2" is found.  When starting on
+--- the character just before the "if 2", the "endif 1" will be
+--- found.  That's because the "if 2" will be found first, and
+--- then this is considered to be a nested if/endif from "if 2" to
+--- "endif 2".
+--- When searching backwards and {end} is more than one character,
+--- it may be useful to put "\zs" at the end of the pattern, so
+--- that when the cursor is inside a match with the end it finds
+--- the matching start.
+---
+--- Example, to find the "endif" command in a Vim script: >
+---
+---   :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
+---   \ 'getline(".") =~ "^\\s*\""')
+---
+--- <The cursor must be at or after the "if" for which a match is
+--- to be found.  Note that single-quote strings are used to avoid
+--- having to double the backslashes.  The skip expression only
+--- catches comments at the start of a line, not after a command.
+--- Also, a word "en" or "if" halfway through a line is considered
+--- a match.
+--- Another example, to search for the matching "{" of a "}": >
+---
+---   :echo searchpair('{', '', '}', 'bW')
+---
+--- <This works when the cursor is at or before the "}" for which a
+--- match is to be found.  To reject matches that syntax
+--- highlighting recognized as strings: >
+---
+---   :echo searchpair('{', '', '}', 'bW',
+---        \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
+--- <
+---
+--- @return any
+function vim.fn.searchpair() end
+
+--- Same as |searchpair()|, but returns a |List| with the line and
+--- column position of the match. The first element of the |List|
+--- is the line number and the second element is the byte index of
+--- the column position of the match.  If no match is found,
+--- returns [0, 0]. >
+---
+---   :let [lnum,col] = searchpairpos('{', '', '}', 'n')
+--- <
+--- See |match-parens| for a bigger and more useful example.
+---
+--- @return any
+function vim.fn.searchpairpos() end
+
 --- Same as |search()|, but returns a |List| with the line and
 --- column position of the match. The first element of the |List|
 --- is the line number and the second element is the byte index of
@@ -7672,7 +7950,7 @@ function vim.fn.setbufline(buf, lnum, text) end
 --- Can also be used as a |method|, the base is passed as the
 --- third argument: >
 ---   GetValue()->setbufvar(buf, varname)
----
+--- <
 ---
 --- @param buf any
 --- @param varname string
@@ -7713,7 +7991,6 @@ function vim.fn.setbufvar(buf, varname, val) end
 --- match with what Vim knows about each emoji.  If it doesn't
 --- look right you need to adjust the {list} argument.
 ---
----
 --- @param list any
 --- @return any
 function vim.fn.setcellwidths(list) end
@@ -7797,6 +8074,12 @@ function vim.fn.setcmdline(str, pos) end
 --- @return any
 function vim.fn.setcmdpos(pos) end
 
+--- @param lnum integer
+--- @param col? integer
+--- @param off? any
+--- @return any
+function vim.fn.setcursorcharpos(lnum, col, off) end
+
 --- Same as |cursor()| but uses the specified column number as the
 --- character index instead of the byte index in the line.
 ---
@@ -7823,6 +8106,7 @@ function vim.fn.setcursorcharpos(list) end
 --- Can also be used as a |method|, the base is passed as the
 --- second argument: >
 ---   GetPath()->setenv('PATH')
+--- <
 ---
 --- @param name string
 --- @param val any
@@ -7924,6 +8208,7 @@ function vim.fn.setloclist(nr, list, action, what) end
 --- Can also be used as a |method|: >
 ---   GetMatches()->setmatches()
 --- <
+---
 --- @param list any
 --- @param win? any
 --- @return any
@@ -8099,6 +8384,7 @@ function vim.fn.setpos(expr, list) end
 --- second argument: >
 ---   GetErrorlist()->setqflist()
 --- <
+---
 --- @param list any
 --- @param action? any
 --- @param what? any
@@ -8347,6 +8633,11 @@ function vim.fn.shellescape(string, special) end
 --- @return any
 function vim.fn.shiftwidth(col) end
 
+--- @param name string
+--- @param dict? any
+--- @return any
+function vim.fn.sign_define(name, dict) end
+
 --- Define a new sign named {name} or modify the attributes of an
 --- existing sign.  This is similar to the |:sign-define| command.
 ---
@@ -8501,6 +8792,7 @@ function vim.fn.sign_getdefined(name) end
 --- Can also be used as a |method|: >
 ---   GetBufname()->sign_getplaced()
 --- <
+---
 --- @param buf? any
 --- @param dict? any
 --- @return any
@@ -8523,6 +8815,7 @@ function vim.fn.sign_getplaced(buf, dict) end
 --- Can also be used as a |method|: >
 ---   GetSignid()->sign_jump()
 --- <
+---
 --- @param id any
 --- @param group any
 --- @param buf any
@@ -8579,6 +8872,7 @@ function vim.fn.sign_jump(id, group, buf) end
 --- Can also be used as a |method|: >
 ---   GetSignid()->sign_place(group, name, expr)
 --- <
+---
 --- @param id any
 --- @param group any
 --- @param name string
@@ -8651,6 +8945,10 @@ function vim.fn.sign_place(id, group, name, buf, dict) end
 --- @return any
 function vim.fn.sign_placelist(list) end
 
+--- @param name? string
+--- @return any
+function vim.fn.sign_undefine(name) end
+
 --- Deletes a previously defined sign {name}. This is similar to
 --- the |:sign-undefine| command. If {name} is not supplied, then
 --- deletes all the defined signs.
@@ -8723,6 +9021,7 @@ function vim.fn.sign_undefine(list) end
 --- <Can also be used as a |method|: >
 ---   GetSigngroup()->sign_unplace()
 --- <
+---
 --- @param group any
 --- @param dict? any
 --- @return any
@@ -8829,7 +9128,7 @@ function vim.fn.sinh(expr) end
 ---
 --- Can also be used as a |method|: >
 ---   GetList()->slice(offset)
----
+--- <
 ---
 --- @param expr any
 --- @param start any
@@ -8941,6 +9240,7 @@ function vim.fn.sockconnect(mode, address, opts) end
 --- <For a simple expression you can use a lambda: >
 ---   eval mylist->sort({i1, i2 -> i1 - i2})
 --- <
+---
 --- @param list any
 --- @param func? any
 --- @param dict? any
@@ -8957,6 +9257,7 @@ function vim.fn.sort(list, func, dict) end
 --- Can also be used as a |method|: >
 ---   GetWord()->soundfold()
 --- <
+---
 --- @param word any
 --- @return any
 function vim.fn.soundfold(word) end
@@ -8987,6 +9288,7 @@ function vim.fn.soundfold(word) end
 --- Can also be used as a |method|: >
 ---   GetText()->spellbadword()
 --- <
+---
 --- @param sentence? any
 --- @return any
 function vim.fn.spellbadword(sentence) end
@@ -9110,7 +9412,6 @@ function vim.fn.srand(expr) end
 ---   - |channel-id| on success (value is always 1)
 ---   - 0 on invalid arguments
 ---
----
 --- @param opts table
 --- @return any
 function vim.fn.stdioopen(opts) end
@@ -9134,7 +9435,7 @@ function vim.fn.stdioopen(opts) end
 ---
 --- Example: >
 ---   :echo stdpath("config")
----
+--- <
 ---
 --- @param what any
 --- @return any
@@ -9205,7 +9506,7 @@ function vim.fn.str2list(string, utf8) end
 ---
 --- Can also be used as a |method|: >
 ---   GetText()->str2nr()
----
+--- <
 ---
 --- @param string string
 --- @param base? any
@@ -9223,7 +9524,7 @@ function vim.fn.str2nr(string, base) end
 ---
 --- Can also be used as a |method|: >
 ---   GetText()->strcharlen()
----
+--- <
 ---
 --- @param string string
 --- @return any
@@ -9245,7 +9546,7 @@ function vim.fn.strcharlen(string) end
 ---
 --- Can also be used as a |method|: >
 ---   GetText()->strcharpart(5)
----
+--- <
 ---
 --- @param src any
 --- @param start any
@@ -9371,12 +9672,14 @@ function vim.fn.strgetchar(str, index) end
 --- Can also be used as a |method|: >
 ---   GetHaystack()->stridx(needle)
 --- <
+---
 --- @param haystack any
 --- @param needle any
 --- @param start? any
 --- @return any
 function vim.fn.stridx(haystack, needle, start) end
 
+--- Return {expr} converted to a String.  If {expr} is a Number,
 --- Float, String, Blob or a composition of them, then the result
 --- can be parsed back with |eval()|.
 ---   {expr} type  result ~
@@ -9481,6 +9784,7 @@ function vim.fn.strpart(src, start, len, chars) end
 --- Can also be used as a |method|: >
 ---   GetFormat()->strptime(timestring)
 --- <
+---
 --- @param format any
 --- @param timestring any
 --- @return any
@@ -9549,6 +9853,7 @@ function vim.fn.strtrans(string) end
 --- Can also be used as a |method|: >
 ---   GetText()->strutf16len()
 --- <
+---
 --- @param string string
 --- @param countcc? any
 --- @return any
@@ -9824,7 +10129,7 @@ function vim.fn.synIDtrans(synID) end
 ---   synconcealed(lnum, 4)   [1, 'X', 2]
 ---   synconcealed(lnum, 5)   [1, 'X', 2]
 ---   synconcealed(lnum, 6)   [0, '', 0]
----
+--- <
 ---
 --- @param lnum integer
 --- @param col integer
@@ -9983,14 +10288,15 @@ function vim.fn.tabpagenr(arg) end
 --- Can also be used as a |method|: >
 ---   GetTabpage()->tabpagewinnr()
 --- <
+---
 --- @param tabarg any
 --- @param arg? any
 --- @return any
 function vim.fn.tabpagewinnr(tabarg, arg) end
 
+--- Returns a |List| with the file names used to search for tags
 --- for the current buffer.  This is the 'tags' option expanded.
 ---
----
 --- @return any
 function vim.fn.tagfiles() end
 
@@ -10074,6 +10380,7 @@ function vim.fn.tan(expr) end
 --- Can also be used as a |method|: >
 ---   Compute()->tanh()
 --- <
+---
 --- @param expr any
 --- @return any
 function vim.fn.tanh(expr) end
@@ -10123,6 +10430,7 @@ function vim.fn.termopen(cmd, opts) end
 --- Can also be used as a |method|: >
 ---   GetTimer()->timer_info()
 --- <
+---
 --- @param id? any
 --- @return any
 function vim.fn.timer_info(id) end
@@ -10142,6 +10450,7 @@ function vim.fn.timer_info(id) end
 --- Can also be used as a |method|: >
 ---   GetTimer()->timer_pause(1)
 --- <
+---
 --- @param timer any
 --- @param paused any
 --- @return any
@@ -10194,6 +10503,7 @@ function vim.fn.timer_start(time, callback, options) end
 --- Can also be used as a |method|: >
 ---   GetTimer()->timer_stop()
 --- <
+---
 --- @param timer any
 --- @return any
 function vim.fn.timer_stop(timer) end
@@ -10410,6 +10720,7 @@ function vim.fn.undotree() end
 --- Can also be used as a |method|: >
 ---   mylist->uniq()
 --- <
+---
 --- @param list any
 --- @param func? any
 --- @param dict? any
@@ -10444,7 +10755,7 @@ function vim.fn.uniq(list, func, dict) end
 --- <
 --- Can also be used as a |method|: >
 ---   GetName()->utf16idx(idx)
----
+--- <
 ---
 --- @param string string
 --- @param idx integer
@@ -10672,6 +10983,7 @@ function vim.fn.win_getid(win, tab) end
 --- Can also be used as a |method|: >
 ---   GetWinid()->win_gettype()
 --- <
+---
 --- @param nr? integer
 --- @return 'autocmd'|'command'|''|'loclist'|'popup'|'preview'|'quickfix'|'unknown'
 function vim.fn.win_gettype(nr) end
@@ -10760,6 +11072,7 @@ function vim.fn.win_move_statusline(nr, offset) end
 --- Can also be used as a |method|: >
 ---   GetWinid()->win_screenpos()
 --- <
+---
 --- @param nr integer
 --- @return any
 function vim.fn.win_screenpos(nr) end
@@ -10786,12 +11099,14 @@ function vim.fn.win_screenpos(nr) end
 --- Can also be used as a |method|: >
 ---   GetWinid()->win_splitmove(target)
 --- <
+---
 --- @param nr integer
 --- @param target any
 --- @param options? table
 --- @return any
 function vim.fn.win_splitmove(nr, target, options) end
 
+--- The result is a Number, which is the number of the buffer
 --- associated with window {nr}.  {nr} can be the window number or
 --- the |window-ID|.
 --- When {nr} is zero, the number of the buffer in the current
@@ -10803,10 +11118,12 @@ function vim.fn.win_splitmove(nr, target, options) end
 --- Can also be used as a |method|: >
 ---   FindWindow()->winbufnr()->bufname()
 --- <
+---
 --- @param nr integer
 --- @return integer
 function vim.fn.winbufnr(nr) end
 
+--- The result is a Number, which is the virtual column of the
 --- cursor in the window.  This is counting screen cells from the
 --- left side of the window.  The leftmost column is one.
 ---
@@ -10833,6 +11150,7 @@ function vim.fn.windowsversion() end
 --- <Can also be used as a |method|: >
 ---   GetWinid()->winheight()
 --- <
+---
 --- @param nr integer
 --- @return integer
 function vim.fn.winheight(nr) end
@@ -10869,10 +11187,12 @@ function vim.fn.winheight(nr) end
 --- Can also be used as a |method|: >
 ---   GetTabnr()->winlayout()
 --- <
+---
 --- @param tabnr? integer
 --- @return any
 function vim.fn.winlayout(tabnr) end
 
+--- The result is a Number, which is the screen line of the cursor
 --- in the window.  This is counting screen lines from the top of
 --- the window.  The first line is one.
 --- If the cursor was moved the view on the file will be updated
@@ -10881,6 +11201,7 @@ function vim.fn.winlayout(tabnr) end
 --- @return integer
 function vim.fn.winline() end
 
+--- The result is a Number, which is the number of the current
 --- window.  The top window has number 1.
 --- Returns zero for a popup window.
 ---
@@ -10911,10 +11232,12 @@ function vim.fn.winline() end
 --- <Can also be used as a |method|: >
 ---   GetWinval()->winnr()
 --- <
+---
 --- @param arg? any
 --- @return any
 function vim.fn.winnr(arg) end
 
+--- Returns a sequence of |:resize| commands that should restore
 --- the current window sizes.  Only works properly when no windows
 --- are opened or closed and the current window and tab page is
 --- unchanged.
@@ -10923,6 +11246,7 @@ function vim.fn.winnr(arg) end
 ---   :call MessWithWindowSizes()
 ---   :exe cmd
 --- <
+---
 --- @return any
 function vim.fn.winrestcmd() end
 
@@ -10944,10 +11268,12 @@ function vim.fn.winrestcmd() end
 --- Can also be used as a |method|: >
 ---   GetView()->winrestview()
 --- <
+---
 --- @param dict any
 --- @return any
 function vim.fn.winrestview(dict) end
 
+--- Returns a |Dictionary| that contains information to restore
 --- the view of the current window.  Use |winrestview()| to
 --- restore the view.
 --- This is useful if you have a mapping that jumps around in the
@@ -10973,7 +11299,6 @@ function vim.fn.winrestview(dict) end
 ---   skipcol    columns skipped
 --- Note that no option values are saved.
 ---
----
 --- @return any
 function vim.fn.winsaveview() end
 
@@ -11017,7 +11342,6 @@ function vim.fn.winwidth(nr) end
 ---   visual_words    Number of words visually selected
 ---       (only in Visual mode)
 ---
----
 --- @return any
 function vim.fn.wordcount() end
 
@@ -11084,6 +11408,7 @@ function vim.fn.writefile(object, fname, flags) end
 --- Can also be used as a |method|: >
 ---   :let bits = bits->xor(0x80)
 --- <
+---
 --- @param expr any
 --- @param expr1 any
 --- @return any
-- 
cgit 


From 2736cb3adf4ff2b9e3ba188eb7d081e1cb938fb4 Mon Sep 17 00:00:00 2001
From: altermo <107814000+altermo@users.noreply.github.com>
Date: Sat, 29 Jul 2023 16:08:32 +0200
Subject: docs(lua): vim.str_utf_{start,end,pos} #24424

Closes #24422
---
 runtime/lua/vim/_meta/builtin.lua | 47 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/builtin.lua b/runtime/lua/vim/_meta/builtin.lua
index 88f07f2a51..a5508bdc04 100644
--- a/runtime/lua/vim/_meta/builtin.lua
+++ b/runtime/lua/vim/_meta/builtin.lua
@@ -118,6 +118,53 @@ function vim.stricmp(a, b) end
 --- @param use_utf16? any
 function vim.str_byteindex(str, index, use_utf16) end
 
+--- Gets a list of the starting byte positions of each UTF-8 codepoint in the given string.
+---
+--- Embedded NUL bytes are treated as terminating the string.
+--- @param str string
+--- @return table
+function vim.str_utf_pos(str) end
+
+--- Gets the distance (in bytes) from the starting byte of the codepoint (character) that {index}
+--- points to.
+---
+--- The result can be added to {index} to get the starting byte of a character.
+---
+--- Examples:
+--- <pre>lua
+--- -- The character 'æ' are equal to the bytes '\xc3\xa6' (using UTF-8)
+---
+--- -- Returns 0 because the index is pointing at the first byte of a character
+--- vim.str_utf_start('æ', 1)
+---
+--- -- Returns -1 because the index is pointing at the second byte of a character
+--- vim.str_utf_start('æ', 2)
+--- </pre>
+---
+--- @param str string
+--- @param index number
+--- @return number
+function vim.str_utf_start(str, index) end
+
+--- Gets the distance (in bytes) from the last byte of the codepoint (character) that {index} points
+--- to.
+---
+--- Examples:
+--- <pre>lua
+--- -- The character 'æ' are equal to the bytes '\xc3\xa6' (using UTF-8)
+---
+--- -- Returns 0 because the index is pointing at the last byte of a character
+--- vim.str_utf_end('æ', 2)
+---
+--- -- Returns 1 because the index is pointing at the second last byte of a character
+--- vim.str_utf_end('æ', 1)
+--- </pre>
+---
+--- @param str string
+--- @param index number
+--- @return number
+function vim.str_utf_end(str, index) end
+
 --- Convert byte index to UTF-32 and UTF-16 indices. If {index} is not
 --- supplied, the length of the string is used. All indices are zero-based.
 ---
-- 
cgit 


From 996dd36c77321ea91758b5996d152a2f37af99dd Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sat, 29 Jul 2023 16:10:40 +0200
Subject: feat(lsp): add actionable advice to lsp client quit error msg
 (#24510)

Co-authored-by: Justin M. Keyes <justinkz@gmail.com>
---
 runtime/lua/vim/lsp.lua | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 1a1dc684ba..edf69af718 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1260,8 +1260,13 @@ function lsp.start_client(config)
         changetracking.reset(client)
       end
       if code ~= 0 or (signal ~= 0 and signal ~= 15) then
-        local msg =
-          string.format('Client %s quit with exit code %s and signal %s', client_id, code, signal)
+        local msg = string.format(
+          'Client %s quit with exit code %s and signal %s. Check log for errors: %s',
+          name,
+          code,
+          signal,
+          lsp.get_log_path()
+        )
         vim.notify(msg, vim.log.levels.WARN)
       end
     end)
-- 
cgit 


From 9b5f58185e1ff0597c7e95b7205d9ec11be1848c Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 1 Aug 2023 09:57:52 +0100
Subject: docs(builtin): fix and annotate language blocks (#24506)

---
 runtime/lua/vim/_meta/vimfn.lua | 2839 +++++++++++++++++++++------------------
 1 file changed, 1544 insertions(+), 1295 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 82213324e3..8b56d8e708 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -6,16 +6,17 @@
 --- a |Float| abs() returns a |Float|.  When {expr} can be
 --- converted to a |Number| abs() returns a |Number|.  Otherwise
 --- abs() gives an error message and returns -1.
---- Examples: >
+--- Examples: >vim
 ---   echo abs(1.456)
---- <  1.456  >
+--- <  1.456  >vim
 ---   echo abs(-5.456)
---- <  5.456  >
+--- <  5.456  >vim
 ---   echo abs(-4)
 --- <  4
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->abs()
+--- <
 ---
 --- @param expr any
 --- @return number
@@ -27,31 +28,33 @@ function vim.fn.abs(expr) end
 --- [-1, 1].
 --- Returns NaN if {expr} is outside the range [-1, 1].  Returns
 --- 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo acos(0)
---- <  1.570796 >
----   :echo acos(-0.5)
+--- Examples: >vim
+---   echo acos(0)
+--- <  1.570796 >vim
+---   echo acos(-0.5)
 --- <  2.094395
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->acos()
+--- <
 ---
 --- @param expr any
 --- @return number
 function vim.fn.acos(expr) end
 
 --- Append the item {expr} to |List| or |Blob| {object}.  Returns
---- the resulting |List| or |Blob|.  Examples: >
----   :let alist = add([1, 2, 3], item)
----   :call add(mylist, "woodstock")
+--- the resulting |List| or |Blob|.  Examples: >vim
+---   let alist = add([1, 2, 3], item)
+---   call add(mylist, "woodstock")
 --- <Note that when {expr} is a |List| it is appended as a single
 --- item.  Use |extend()| to concatenate |Lists|.
 --- When {object} is a |Blob| then {expr} must be a number.
 --- Use |insert()| to add an item at another position.
 --- Returns 1 if {object} is not a |List| or a |Blob|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->add(val1)->add(val2)
+--- <
 ---
 --- @param object any
 --- @param expr any
@@ -61,10 +64,11 @@ function vim.fn.add(object, expr) end
 --- Bitwise AND on the two arguments.  The arguments are converted
 --- to a number.  A List, Dict or Float argument causes an error.
 --- Also see `or()` and `xor()`.
---- Example: >
----   :let flag = and(bits, 0x80)
---- <Can also be used as a |method|: >
----   :let flag = bits->and(0x80)
+--- Example: >vim
+---   let flag = and(bits, 0x80)
+--- <Can also be used as a |method|: >vim
+---   let flag = bits->and(0x80)
+--- <
 ---
 --- @param expr any
 --- @param expr1 any
@@ -73,8 +77,9 @@ vim.fn['and'] = function(expr, expr1) end
 
 --- Returns Dictionary of |api-metadata|.
 ---
---- View it in a nice human-readable format: >
----        :lua vim.print(vim.fn.api_info())
+--- View it in a nice human-readable format: >vim
+---        lua vim.print(vim.fn.api_info())
+--- <
 ---
 --- @return table
 function vim.fn.api_info() end
@@ -87,12 +92,13 @@ function vim.fn.api_info() end
 --- {lnum} can be zero to insert a line before the first one.
 --- {lnum} is used like with |getline()|.
 --- Returns 1 for failure ({lnum} out of range or out of memory),
---- 0 for success.  Example: >
----   :let failed = append(line('$'), "# THE END")
----   :let failed = append(0, ["Chapter 1", "the beginning"])
+--- 0 for success.  Example: >vim
+---   let failed = append(line('$'), "# THE END")
+---   let failed = append(0, ["Chapter 1", "the beginning"])
 ---
---- <Can also be used as a |method| after a List: >
+--- <Can also be used as a |method| after a List: >vim
 ---   mylist->append(lnum)
+--- <
 ---
 --- @param lnum integer
 --- @param text any
@@ -114,11 +120,12 @@ function vim.fn.append(lnum, text) end
 --- On success 0 is returned, on failure 1 is returned.
 ---
 --- If {buf} is not a valid buffer or {lnum} is not valid, an
---- error message is given. Example: >
----   :let failed = appendbufline(13, 0, "# THE START")
+--- error message is given. Example: >vim
+---   let failed = appendbufline(13, 0, "# THE START")
 --- <
---- Can also be used as a |method| after a List: >
+--- Can also be used as a |method| after a List: >vim
 ---   mylist->appendbufline(buf, lnum)
+--- <
 ---
 --- @param buf any
 --- @param lnum integer
@@ -162,13 +169,13 @@ function vim.fn.argidx() end
 function vim.fn.arglistid(winnr, tabnr) end
 
 --- The result is the {nr}th file in the argument list.  See
---- |arglist|.  "argv(0)" is the first one.  Example: >
----   :let i = 0
----   :while i < argc()
----   :  let f = escape(fnameescape(argv(i)), '.')
----   :  exe 'amenu Arg.' .. f .. ' :e ' .. f .. '<CR>'
----   :  let i = i + 1
----   :endwhile
+--- |arglist|.  "argv(0)" is the first one.  Example: >vim
+---   let i = 0
+---   while i < argc()
+---     let f = escape(fnameescape(argv(i)), '.')
+---     exe 'amenu Arg.' .. f .. ' :e ' .. f .. '<CR>'
+---     let i = i + 1
+---   endwhile
 --- <Without the {nr} argument, or when {nr} is -1, a |List| with
 --- the whole |arglist| is returned.
 ---
@@ -190,13 +197,13 @@ function vim.fn.argv(nr, winid) end
 --- [-1, 1].
 --- Returns NaN if {expr} is outside the range [-1, 1].  Returns
 --- 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo asin(0.8)
---- <  0.927295 >
----   :echo asin(-0.5)
+--- Examples: >vim
+---   echo asin(0.8)
+--- <  0.927295 >vim
+---   echo asin(-0.5)
 --- <  -0.523599
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->asin()
 --- <
 ---
@@ -209,7 +216,7 @@ function vim.fn.asin(expr) end
 --- Also see |assert_fails()|, |assert_nobeep()| and
 --- |assert-return|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetCmd()->assert_beeps()
 --- <
 ---
@@ -227,13 +234,14 @@ function vim.fn.assert_beeps(cmd) end
 --- from the Number 4.  And the number 4 is different from the
 --- Float 4.0.  The value of 'ignorecase' is not used here, case
 --- always matters.
---- Example: >
+--- Example: >vim
 ---   assert_equal('foo', 'bar')
 --- <Will result in a string to be added to |v:errors|:
 ---   test.vim line 12: Expected 'foo' but got 'bar' ~
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->assert_equal([1, 2, 3])
+--- <
 ---
 --- @param expected any
 --- @param actual any
@@ -247,8 +255,9 @@ function vim.fn.assert_equal(expected, actual, msg) end
 --- When {fname-one} or {fname-two} does not exist the error will
 --- mention that.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLog()->assert_equalfile('expected.log')
+--- <
 ---
 --- @return 0|1
 function vim.fn.assert_equalfile() end
@@ -257,7 +266,7 @@ function vim.fn.assert_equalfile() end
 --- message is added to |v:errors|.  Also see |assert-return|.
 --- This can be used to assert that a command throws an exception.
 --- Using the error number, followed by a colon, avoids problems
---- with translations: >
+--- with translations: >vim
 ---   try
 ---     commandthatfails
 ---     call assert_false(1, 'command should have failed')
@@ -277,16 +286,16 @@ function vim.fn.assert_exception(error, msg) end
 ---
 --- When {error} is a string it must be found literally in the
 --- first reported error. Most often this will be the error code,
---- including the colon, e.g. "E123:". >
+--- including the colon, e.g. "E123:". >vim
 ---   assert_fails('bad cmd', 'E987:')
 --- <
 --- When {error} is a |List| with one or two strings, these are
 --- used as patterns.  The first pattern is matched against the
---- first reported error: >
+--- first reported error: >vim
 ---   assert_fails('cmd', ['E987:.*expected bool'])
 --- <The second pattern, if present, is matched against the last
 --- reported error.  To only match the last error use an empty
---- string for the first error: >
+--- string for the first error: >vim
 ---   assert_fails('cmd', ['', 'E987:'])
 --- <
 --- If {msg} is empty then it is not used.  Do this to get the
@@ -304,8 +313,9 @@ function vim.fn.assert_exception(error, msg) end
 --- Note that beeping is not considered an error, and some failing
 --- commands only beep.  Use |assert_beeps()| for those.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetCmd()->assert_fails('E99:')
+--- <
 ---
 --- @param cmd any
 --- @param error? any
@@ -324,8 +334,9 @@ function vim.fn.assert_fails(cmd, error, msg, lnum, context) end
 --- A value is false when it is zero. When {actual} is not a
 --- number the assert fails.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetResult()->assert_false()
+--- <
 ---
 --- @param actual any
 --- @param msg? any
@@ -359,12 +370,12 @@ function vim.fn.assert_inrange(lower, upper, actual, msg) end
 --- Use "^" and "$" to match with the start and end of the text.
 --- Use both to match the whole text.
 ---
---- Example: >
+--- Example: >vim
 ---   assert_match('^f.*o$', 'foobar')
 --- <Will result in a string to be added to |v:errors|:
 ---   test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   getFile()->assert_match('foo.*')
 --- <
 ---
@@ -378,7 +389,7 @@ function vim.fn.assert_match(pattern, actual, msg) end
 --- produces a beep or visual bell.
 --- Also see |assert_beeps()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetCmd()->assert_nobeep()
 --- <
 ---
@@ -390,9 +401,8 @@ function vim.fn.assert_nobeep(cmd) end
 --- |v:errors| when {expected} and {actual} are equal.
 --- Also see |assert-return|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->assert_notequal([1, 2, 3])
----
 --- <
 ---
 --- @param expected any
@@ -405,7 +415,7 @@ function vim.fn.assert_notequal(expected, actual, msg) end
 --- |v:errors| when {pattern} matches {actual}.
 --- Also see |assert-return|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   getFile()->assert_notmatch('bar.*')
 --- <
 ---
@@ -418,7 +428,7 @@ function vim.fn.assert_notmatch(pattern, actual, msg) end
 --- Report a test failure directly, using String {msg}.
 --- Always returns one.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetMessage()->assert_report()
 --- <
 ---
@@ -433,7 +443,7 @@ function vim.fn.assert_report(msg) end
 --- When {actual} is not a number or |v:true| the assert fails.
 --- When {msg} is given it precedes the default message.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetResult()->assert_true()
 --- <
 ---
@@ -446,14 +456,15 @@ function vim.fn.assert_true(actual, msg) end
 --- the range [-pi/2, +pi/2] radians, as a |Float|.
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo atan(100)
---- <  1.560797 >
----   :echo atan(-4.01)
+--- Examples: >vim
+---   echo atan(100)
+--- <  1.560797 >vim
+---   echo atan(-4.01)
 --- <  -1.326405
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->atan()
+--- <
 ---
 --- @param expr any
 --- @return number
@@ -464,14 +475,15 @@ function vim.fn.atan(expr) end
 --- {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr1} or {expr2} is not a |Float| or a
 --- |Number|.
---- Examples: >
----   :echo atan2(-1, 1)
---- <  -0.785398 >
----   :echo atan2(1, -1)
+--- Examples: >vim
+---   echo atan2(-1, 1)
+--- <  -0.785398 >vim
+---   echo atan2(1, -1)
 --- <  2.356194
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->atan2(1)
+--- <
 ---
 --- @param expr1 any
 --- @param expr2 any
@@ -479,13 +491,13 @@ function vim.fn.atan(expr) end
 function vim.fn.atan2(expr1, expr2) end
 
 --- Return a List containing the number value of each byte in Blob
---- {blob}.  Examples: >
----   blob2list(0z0102.0304)  returns [1, 2, 3, 4]
----   blob2list(0z)    returns []
+--- {blob}.  Examples: >vim
+---   blob2list(0z0102.0304)  " returns [1, 2, 3, 4]
+---   blob2list(0z)    " returns []
 --- <Returns an empty List on error.  |list2blob()| does the
 --- opposite.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetBlob()->blob2list()
 --- <
 ---
@@ -533,13 +545,14 @@ function vim.fn.browsedir(title, initdir) end
 --- created buffer.  When {name} is an empty string then a new
 --- buffer is always created.
 --- The buffer will not have 'buflisted' set and not be loaded
---- yet.  To add some text to the buffer use this: >
+--- yet.  To add some text to the buffer use this: >vim
 ---   let bufnr = bufadd('someName')
 ---   call bufload(bufnr)
 ---   call setbufline(bufnr, 1, ['some', 'text'])
 --- <Returns 0 on error.
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   let bufnr = 'somename'->bufadd()
+--- <
 ---
 --- @param name string
 --- @return integer
@@ -566,8 +579,9 @@ function vim.fn.bufadd(name) end
 --- Use "bufexists(0)" to test for the existence of an alternate
 --- file name.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   let exists = 'somename'->bufexists()
+--- <
 ---
 --- @param buf any
 --- @return 0|1
@@ -598,8 +612,9 @@ function vim.fn.buffer_number(...) end
 --- {buf} exists and is listed (has the 'buflisted' option set).
 --- The {buf} argument is used like with |bufexists()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   let listed = 'somename'->buflisted()
+--- <
 ---
 --- @param buf any
 --- @return 0|1
@@ -614,8 +629,9 @@ function vim.fn.buflisted(buf) end
 --- there will be no dialog, the buffer will be loaded anyway.
 --- The {buf} argument is used like with |bufexists()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   eval 'somename'->bufload()
+--- <
 ---
 --- @param buf any
 function vim.fn.bufload(buf) end
@@ -624,8 +640,9 @@ function vim.fn.bufload(buf) end
 --- {buf} exists and is loaded (shown in a window or hidden).
 --- The {buf} argument is used like with |bufexists()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   let loaded = 'somename'->bufloaded()
+--- <
 ---
 --- @param buf any
 --- @return 0|1
@@ -651,17 +668,17 @@ function vim.fn.bufloaded(buf) end
 --- with a listed buffer, that one is returned.  Next unlisted
 --- buffers are searched for.
 --- If the {buf} is a String, but you want to use it as a buffer
---- number, force it to be a Number by adding zero to it: >
----   :echo bufname("3" + 0)
---- <Can also be used as a |method|: >
+--- number, force it to be a Number by adding zero to it: >vim
+---   echo bufname("3" + 0)
+--- <Can also be used as a |method|: >vim
 ---   echo bufnr->bufname()
 ---
 --- <If the buffer doesn't exist, or doesn't have a name, an empty
---- string is returned. >
----   bufname("#")    alternate buffer name
----   bufname(3)    name of buffer 3
----   bufname("%")    name of current buffer
----   bufname("file2")  name of buffer where "file2" matches.
+--- string is returned. >vim
+---   echo bufname("#")    " alternate buffer name
+---   echo bufname(3)    " name of buffer 3
+---   echo bufname("%")    " name of current buffer
+---   echo bufname("file2")  " name of buffer where "file2" matches.
 --- <
 ---
 --- @param buf? any
@@ -674,15 +691,16 @@ function vim.fn.bufname(buf) end
 --- If the buffer doesn't exist, -1 is returned.  Or, if the
 --- {create} argument is present and TRUE, a new, unlisted,
 --- buffer is created and its number is returned.
---- bufnr("$") is the last buffer: >
----   :let last_buffer = bufnr("$")
+--- bufnr("$") is the last buffer: >vim
+---   let last_buffer = bufnr("$")
 --- <The result is a Number, which is the highest buffer number
 --- of existing buffers.  Note that not all buffers with a smaller
 --- number necessarily exist, because ":bwipeout" may have removed
 --- them.  Use bufexists() to test for the existence of a buffer.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   echo bufref->bufnr()
+--- <
 ---
 --- @param buf? any
 --- @param create? any
@@ -692,15 +710,16 @@ function vim.fn.bufnr(buf, create) end
 --- The result is a Number, which is the |window-ID| of the first
 --- window associated with buffer {buf}.  For the use of {buf},
 --- see |bufname()| above.  If buffer {buf} doesn't exist or
---- there is no such window, -1 is returned.  Example: >
+--- there is no such window, -1 is returned.  Example: >vim
 ---
 ---   echo "A window containing buffer 1 is " .. (bufwinid(1))
 --- <
 --- Only deals with the current tab page.  See |win_findbuf()| for
 --- finding more.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   FindBuffer()->bufwinid()
+--- <
 ---
 --- @param buf any
 --- @return integer
@@ -709,15 +728,16 @@ function vim.fn.bufwinid(buf) end
 --- Like |bufwinid()| but return the window number instead of the
 --- |window-ID|.
 --- If buffer {buf} doesn't exist or there is no such window, -1
---- is returned.  Example: >
+--- is returned.  Example: >vim
 ---
 ---   echo "A window containing buffer 1 is " .. (bufwinnr(1))
 ---
 --- <The number can be used with |CTRL-W_w| and ":wincmd w"
 --- |:wincmd|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   FindBuffer()->bufwinnr()
+--- <
 ---
 --- @param buf any
 --- @return integer
@@ -732,8 +752,9 @@ function vim.fn.bufwinnr(buf) end
 ---
 --- Returns -1 if the {byte} value is invalid.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetOffset()->byte2line()
+--- <
 ---
 --- @param byte any
 --- @return integer
@@ -755,10 +776,10 @@ function vim.fn.byte2line(byte) end
 --- middle of a character (e.g. in a 4-byte character), then the
 --- byte index of the first byte in the character is returned.
 --- Refer to |string-offset-encoding| for more information.
---- Example : >
+--- Example : >vim
 ---   echo matchstr(str, ".", byteidx(str, 3))
 --- <will display the fourth character.  Another way to do the
---- same: >
+--- same: >vim
 ---   let s = strpart(str, byteidx(str, 3))
 ---   echo strpart(s, 0, byteidx(s, 1))
 --- <Also see |strgetchar()| and |strcharpart()|.
@@ -768,13 +789,14 @@ function vim.fn.byte2line(byte) end
 --- in bytes is returned.
 --- See |charidx()| and |utf16idx()| for getting the character and
 --- UTF-16 index respectively from the byte index.
---- Examples: >
----   echo byteidx('a😊😊', 2)  returns 5
----   echo byteidx('a😊😊', 2, 1)  returns 1
----   echo byteidx('a😊😊', 3, 1)  returns 5
+--- Examples: >vim
+---   echo byteidx('a😊😊', 2)  " returns 5
+---   echo byteidx('a😊😊', 2, 1)  " returns 1
+---   echo byteidx('a😊😊', 3, 1)  " returns 5
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->byteidx(idx)
+--- <
 ---
 --- @param expr any
 --- @param nr integer
@@ -783,7 +805,7 @@ function vim.fn.byte2line(byte) end
 function vim.fn.byteidx(expr, nr, utf16) end
 
 --- Like byteidx(), except that a composing character is counted
---- as a separate character.  Example: >
+--- as a separate character.  Example: >vim
 ---   let s = 'e' .. nr2char(0x301)
 ---   echo byteidx(s, 1)
 ---   echo byteidxcomp(s, 1)
@@ -792,8 +814,9 @@ function vim.fn.byteidx(expr, nr, utf16) end
 --- character is 3 bytes), the second echo results in 1 ('e' is
 --- one byte).
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->byteidxcomp(idx)
+--- <
 ---
 --- @param expr any
 --- @param nr integer
@@ -809,7 +832,7 @@ function vim.fn.byteidxcomp(expr, nr, utf16) end
 --- {dict} is for functions with the "dict" attribute.  It will be
 --- used to set the local variable "self". |Dictionary-function|
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFunc()->call([arg, arg], dict)
 --- <
 ---
@@ -822,17 +845,17 @@ function vim.fn.call(func, arglist, dict) end
 --- Return the smallest integral value greater than or equal to
 --- {expr} as a |Float| (round up).
 --- {expr} must evaluate to a |Float| or a |Number|.
---- Examples: >
+--- Examples: >vim
 ---   echo ceil(1.456)
---- <  2.0  >
+--- <  2.0  >vim
 ---   echo ceil(-5.456)
---- <  -5.0  >
+--- <  -5.0  >vim
 ---   echo ceil(4.0)
 --- <  4.0
 ---
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->ceil()
 --- <
 ---
@@ -874,8 +897,8 @@ function vim.fn.changenr() end
 --- {data} may be a string, string convertible, |Blob|, or a list.
 --- If {data} is a list, the items will be joined by newlines; any
 --- newlines in an item will be sent as NUL. To send a final
---- newline, include a final empty string. Example: >
----   :call chansend(id, ["abc", "123\n456", ""])
+--- newline, include a final empty string. Example: >vim
+---   call chansend(id, ["abc", "123\n456", ""])
 --- <will send "abc<NL>123<NUL>456<NL>".
 ---
 --- chansend() writes raw data, not RPC messages.  If the channel
@@ -888,12 +911,12 @@ function vim.fn.changenr() end
 function vim.fn.chansend(id, data) end
 
 --- Return Number value of the first char in {string}.
---- Examples: >
----   char2nr(" ")    returns 32
----   char2nr("ABC")    returns 65
----   char2nr("á")    returns 225
----   char2nr("á"[0])    returns 195
----   char2nr("\<M-x>")  returns 128
+--- Examples: >vim
+---   echo char2nr(" ")    " returns 32
+---   echo char2nr("ABC")    " returns 65
+---   echo char2nr("á")    " returns 225
+---   echo char2nr("á"[0])    " returns 195
+---   echo char2nr("\<M-x>")  " returns 128
 --- <Non-ASCII characters are always treated as UTF-8 characters.
 --- {utf8} is ignored, it exists only for backwards-compatibility.
 --- A combining character is a separate character.
@@ -901,8 +924,9 @@ function vim.fn.chansend(id, data) end
 ---
 --- Returns 0 if {string} is not a |String|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetChar()->char2nr()
+--- <
 ---
 --- @param string string
 --- @param utf8? any
@@ -927,11 +951,11 @@ function vim.fn.charclass(string) end
 --- position given with {expr} instead of the byte position.
 ---
 --- Example:
---- With the cursor on '세' in line 5 with text "여보세요": >
----   charcol('.')    returns 3
----   col('.')    returns 7
+--- With the cursor on '세' in line 5 with text "여보세요": >vim
+---   echo charcol('.')    " returns 3
+---   echo col('.')    " returns 7
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetPos()->col()
 --- <
 ---
@@ -966,14 +990,15 @@ function vim.fn.charcol(expr, winid) end
 --- from the character index and |utf16idx()| for getting the
 --- UTF-16 index from the character index.
 --- Refer to |string-offset-encoding| for more information.
---- Examples: >
----   echo charidx('áb́ć', 3)    returns 1
----   echo charidx('áb́ć', 6, 1)  returns 4
----   echo charidx('áb́ć', 16)    returns -1
----   echo charidx('a😊😊', 4, 0, 1)  returns 2
+--- Examples: >vim
+---   echo charidx('áb́ć', 3)    " returns 1
+---   echo charidx('áb́ć', 6, 1)  " returns 4
+---   echo charidx('áb́ć', 16)    " returns -1
+---   echo charidx('a😊😊', 4, 0, 1)  " returns 2
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->charidx(idx)
+--- <
 ---
 --- @param string string
 --- @param idx integer
@@ -996,14 +1021,14 @@ function vim.fn.charidx(string, idx, countcc, utf16) end
 --- this to another chdir() to restore the directory.
 --- On failure, returns an empty string.
 ---
---- Example: >
+--- Example: >vim
 ---   let save_dir = chdir(newdir)
 ---   if save_dir != ""
 ---      " ... do some work
 ---      call chdir(save_dir)
 ---   endif
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetDir()->chdir()
 --- <
 ---
@@ -1018,8 +1043,9 @@ function vim.fn.chdir(dir) end
 --- When {lnum} is invalid -1 is returned.
 --- See |C-indenting|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->cindent()
+--- <
 ---
 --- @param lnum integer
 --- @return integer
@@ -1030,7 +1056,7 @@ function vim.fn.cindent(lnum) end
 --- If {win} is specified, use the window with this number or
 --- window ID instead of the current window.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWin()->clearmatches()
 --- <
 ---
@@ -1059,11 +1085,11 @@ function vim.fn.clearmatches(win) end
 --- For the screen column position use |virtcol()|.  For the
 --- character position use |charcol()|.
 --- Note that only marks in the current file can be used.
---- Examples: >
----   col(".")    column of cursor
----   col("$")    length of cursor line plus one
----   col("'t")    column of mark t
----   col("'" .. markname)  column of mark markname
+--- Examples: >vim
+---   echo col(".")    " column of cursor
+---   echo col("$")    " length of cursor line plus one
+---   echo col("'t")    " column of mark t
+---   echo col("'" .. markname)  " column of mark markname
 --- <The first column is 1.  Returns 0 if {expr} is invalid or when
 --- the window with ID {winid} is not found.
 --- For an uppercase mark the column may actually be in another
@@ -1071,10 +1097,10 @@ function vim.fn.clearmatches(win) end
 --- For the cursor position, when 'virtualedit' is active, the
 --- column is one higher if the cursor is after the end of the
 --- line.  Also, when using a <Cmd> mapping the cursor isn't
---- moved, this can be used to obtain the column in Insert mode: >
----   :imap <F2> <Cmd>echo col(".").."\n"<CR>
+--- moved, this can be used to obtain the column in Insert mode: >vim
+---   imap <F2> <Cmd>echo col(".").."\n"<CR>
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetPos()->col()
 --- <
 ---
@@ -1100,7 +1126,7 @@ function vim.fn.col(expr, winid) end
 --- The match can be selected with CTRL-N and CTRL-P as usual with
 --- Insert mode completion.  The popup menu will appear if
 --- specified, see |ins-completion-menu|.
---- Example: >
+--- Example: >vim
 ---   inoremap <F5> <C-R>=ListMonths()<CR>
 ---
 ---   func ListMonths()
@@ -1113,8 +1139,9 @@ function vim.fn.col(expr, winid) end
 --- an empty string is returned to avoid a zero being inserted.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- second argument: >
+--- second argument: >vim
 ---   GetMatches()->complete(col('.'))
+--- <
 ---
 --- @param startcol any
 --- @param matches any
@@ -1128,8 +1155,9 @@ function vim.fn.complete(startcol, matches) end
 --- See |complete-functions| for an explanation of {expr}.  It is
 --- the same as one item in the list that 'omnifunc' would return.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetMoreMatches()->complete_add()
+--- <
 ---
 --- @param expr any
 --- @return 0|1|2
@@ -1194,7 +1222,7 @@ function vim.fn.complete_check() end
 ---
 --- Returns an empty |Dictionary| on error.
 ---
---- Examples: >
+--- Examples: >vim
 ---   " Get all items
 ---   call complete_info()
 ---   " Get only 'mode'
@@ -1202,7 +1230,7 @@ function vim.fn.complete_check() end
 ---   " Get only 'mode' and 'pum_visible'
 ---   call complete_info(['mode', 'pum_visible'])
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetItems()->complete_info()
 --- <
 ---
@@ -1221,11 +1249,11 @@ function vim.fn.complete_info(what) end
 --- some systems the string is wrapped when it doesn't fit.
 ---
 --- {choices} is a String, with the individual choices separated
---- by '\n', e.g. >
+--- by '\n', e.g. >vim
 ---   confirm("Save changes?", "&Yes\n&No\n&Cancel")
 --- <The letter after the '&' is the shortcut key for that choice.
 --- Thus you can type 'c' to select "Cancel".  The shortcut does
---- not need to be the first letter: >
+--- not need to be the first letter: >vim
 ---   confirm("file has been modified", "&Save\nSave &All")
 --- <For the console, the first letter of each choice is used as
 --- the default shortcut key.  Case is ignored.
@@ -1244,7 +1272,7 @@ function vim.fn.complete_info(what) end
 --- If the user aborts the dialog by pressing <Esc>, CTRL-C,
 --- or another valid interrupt key, confirm() returns 0.
 ---
---- An example: >
+--- An example: >vim
 ---    let choice = confirm("What do you want?",
 ---       \ "&Apples\n&Oranges\n&Bananas", 2)
 ---    if choice == 0
@@ -1261,7 +1289,7 @@ function vim.fn.complete_info(what) end
 --- don't fit, a vertical layout is used anyway.  For some systems
 --- the horizontal layout is always used.
 ---
---- Can also be used as a |method|in: >
+--- Can also be used as a |method|in: >vim
 ---   BuildMessage()->confirm("&Yes\n&No")
 --- <
 ---
@@ -1280,8 +1308,9 @@ function vim.fn.confirm(msg, choices, default, type) end
 --- changing an item changes the contents of both |Lists|.
 --- A |Dictionary| is copied in a similar way as a |List|.
 --- Also see |deepcopy()|.
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->copy()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -1290,14 +1319,15 @@ function vim.fn.copy(expr) end
 --- Return the cosine of {expr}, measured in radians, as a |Float|.
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo cos(100)
---- <  0.862319 >
----   :echo cos(-4.01)
+--- Examples: >vim
+---   echo cos(100)
+--- <  0.862319 >vim
+---   echo cos(-4.01)
 --- <  -0.646043
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->cos()
+--- <
 ---
 --- @param expr any
 --- @return number
@@ -1307,14 +1337,15 @@ function vim.fn.cos(expr) end
 --- [1, inf].
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo cosh(0.5)
---- <  1.127626 >
----   :echo cosh(-0.5)
+--- Examples: >vim
+---   echo cosh(0.5)
+--- <  1.127626 >vim
+---   echo cosh(-0.5)
 --- <  -1.127626
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->cosh()
+--- <
 ---
 --- @param expr any
 --- @return number
@@ -1332,7 +1363,7 @@ function vim.fn.cosh(expr) end
 --- occurrences of {expr} is returned. Zero is returned when
 --- {expr} is an empty string.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->count(val)
 --- <
 ---
@@ -1419,8 +1450,9 @@ function vim.fn.cursor(lnum, col, off) end
 --- position within a <Tab> or after the last character.
 --- Returns 0 when the position could be set, -1 otherwise.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetCursorPos()->cursor()
+--- <
 ---
 --- @param list any
 --- @return any
@@ -1434,7 +1466,7 @@ function vim.fn.cursor(list) end
 --- Returns |TRUE| if successfully interrupted the program.
 --- Otherwise returns |FALSE|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetPid()->debugbreak()
 --- <
 ---
@@ -1461,8 +1493,9 @@ function vim.fn.debugbreak(pid) end
 --- {noref} set to 1 will fail.
 --- Also see |copy()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetObject()->deepcopy()
+--- <
 ---
 --- @param expr any
 --- @param noref? any
@@ -1487,8 +1520,9 @@ function vim.fn.deepcopy(expr, noref) end
 --- operation was successful and -1/true when the deletion failed
 --- or partly failed.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->delete()
+--- <
 ---
 --- @param fname integer
 --- @param flags? string
@@ -1508,7 +1542,7 @@ function vim.fn.delete(fname, flags) end
 --- when using |line()| this refers to the current buffer. Use "$"
 --- to refer to the last line in buffer {buf}.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetBuffer()->deletebufline(1)
 --- <
 ---
@@ -1528,7 +1562,7 @@ function vim.fn.deletebufline(buf, first, last) end
 --- After this is called, every change on {dict} and on keys
 --- matching {pattern} will result in {callback} being invoked.
 ---
---- For example, to watch all global variables: >
+--- For example, to watch all global variables: >vim
 ---   silent! call dictwatcherdel(g:, '*', 'OnDictChanged')
 ---   function! OnDictChanged(d,k,z)
 ---     echomsg string(a:k) string(a:z)
@@ -1595,8 +1629,9 @@ function vim.fn.did_filetype() end
 --- line, "'m" mark m, etc.
 --- Returns 0 if the current window is not in diff mode.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->diff_filler()
+--- <
 ---
 --- @param lnum integer
 --- @return any
@@ -1612,7 +1647,7 @@ function vim.fn.diff_filler(lnum) end
 --- The highlight ID can be used with |synIDattr()| to obtain
 --- syntax information about the highlighting.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->diff_hlID(col)
 --- <
 ---
@@ -1628,15 +1663,15 @@ function vim.fn.diff_hlID(lnum, col) end
 ---
 --- Also see |digraph_getlist()|.
 ---
---- Examples: >
+--- Examples: >vim
 --- " Get a built-in digraph
---- :echo digraph_get('00')    " Returns '∞'
+--- echo digraph_get('00')    " Returns '∞'
 ---
 --- " Get a user-defined digraph
---- :call digraph_set('aa', 'あ')
---- :echo digraph_get('aa')    " Returns 'あ'
+--- call digraph_set('aa', 'あ')
+--- echo digraph_get('aa')    " Returns 'あ'
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetChars()->digraph_get()
 --- <
 ---
@@ -1650,14 +1685,14 @@ function vim.fn.digraph_get(chars) end
 ---
 --- Also see |digraph_get()|.
 ---
---- Examples: >
+--- Examples: >vim
 --- " Get user-defined digraphs
---- :echo digraph_getlist()
+--- echo digraph_getlist()
 ---
 --- " Get all the digraphs, including default digraphs
---- :echo digraph_getlist(1)
+--- echo digraph_getlist(1)
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetNumber()->digraph_getlist()
 --- <
 ---
@@ -1678,10 +1713,10 @@ function vim.fn.digraph_getlist(listall) end
 --- If you want to define multiple digraphs at once, you can use
 --- |digraph_setlist()|.
 ---
---- Example: >
+--- Example: >vim
 ---   call digraph_set('  ', 'あ')
 --- <
---- Can be used as a |method|: >
+--- Can be used as a |method|: >vim
 ---   GetString()->digraph_set('あ')
 --- <
 ---
@@ -1694,17 +1729,17 @@ function vim.fn.digraph_set(chars, digraph) end
 --- digraphs at once.  {digraphlist} is a list composed of lists,
 --- where each list contains two strings with {chars} and
 --- {digraph} as in |digraph_set()|. *E1216*
---- Example: >
+--- Example: >vim
 ---     call digraph_setlist([['aa', 'あ'], ['ii', 'い']])
 --- <
---- It is similar to the following: >
+--- It is similar to the following: >vim
 ---     for [chars, digraph] in [['aa', 'あ'], ['ii', 'い']]
 ---     call digraph_set(chars, digraph)
 ---     endfor
 --- <Except that the function returns after the first error,
 --- following digraphs will not be added.
 ---
---- Can be used as a |method|: >
+--- Can be used as a |method|: >vim
 ---     GetList()->digraph_setlist()
 --- <
 ---
@@ -1720,31 +1755,33 @@ function vim.fn.digraph_setlist(digraphlist) end
 --- - |v:false| and |v:null| are empty, |v:true| is not.
 --- - A |Blob| is empty when its length is zero.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->empty()
+--- <
 ---
 --- @param expr any
 --- @return any
 function vim.fn.empty(expr) end
 
 --- Return all of environment variables as dictionary. You can
---- check if an environment variable exists like this: >
----   :echo has_key(environ(), 'HOME')
+--- check if an environment variable exists like this: >vim
+---   echo has_key(environ(), 'HOME')
 --- <Note that the variable name may be CamelCase; to ignore case
---- use this: >
----   :echo index(keys(environ()), 'HOME', 0, 1) != -1
+--- use this: >vim
+---   echo index(keys(environ()), 'HOME', 0, 1) != -1
+--- <
 ---
 --- @return any
 function vim.fn.environ() end
 
 --- Escape the characters in {chars} that occur in {string} with a
---- backslash.  Example: >
----   :echo escape('c:\program files\vim', ' \')
+--- backslash.  Example: >vim
+---   echo escape('c:\program files\vim', ' \')
 --- <results in: >
 ---   c:\\program\ files\\vim
 --- <Also see |shellescape()| and |fnameescape()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->escape(' \')
 --- <
 ---
@@ -1759,8 +1796,9 @@ function vim.fn.escape(string, chars) end
 --- of them.  Also works for |Funcref|s that refer to existing
 --- functions.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   argv->join()->eval()
+--- <
 ---
 --- @param string string
 --- @return any
@@ -1796,8 +1834,9 @@ function vim.fn.eventhandler() end
 ---   -1  not implemented on this system
 --- |exepath()| can be used to get the full path of an executable.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetCommand()->executable()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -1807,9 +1846,9 @@ function vim.fn.executable(expr) end
 --- If {command} is a |String|, returns {command} output.
 --- If {command} is a |List|, returns concatenated outputs.
 --- Line continuations in {command} are not recognized.
---- Examples: >
+--- Examples: >vim
 ---   echo execute('echon "foo"')
---- <  foo >
+--- <  foo >vim
 ---   echo execute(['echon "foo"', 'echon "bar"'])
 --- <  foobar
 ---
@@ -1820,7 +1859,7 @@ function vim.fn.executable(expr) end
 --- The default is "silent".  Note that with "silent!", unlike
 --- `:redir`, error messages are dropped.
 ---
---- To get a list of lines use `split()` on the result: >
+--- To get a list of lines use `split()` on the result: >vim
 ---   execute('args')->split("\n")
 ---
 --- <This function is not available in the |sandbox|.
@@ -1830,8 +1869,9 @@ function vim.fn.executable(expr) end
 --- To execute a command in another window than the current one
 --- use `win_execute()`.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetCommand()->execute()
+--- <
 ---
 --- @param command any
 --- @param silent? boolean
@@ -1843,7 +1883,7 @@ function vim.fn.execute(command, silent) end
 --- Returns empty string otherwise.
 --- If {expr} starts with "./" the |current-directory| is used.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetCommand()->exepath()
 --- <
 ---
@@ -1864,11 +1904,11 @@ function vim.fn.exepath(expr) end
 ---       entries, |List| items, etc.
 ---       Beware that evaluating an index may
 ---       cause an error message for an invalid
----       expression.  E.g.: >
----          :let l = [1, 2, 3]
----          :echo exists("l[5]")
---- <         0 >
----          :echo exists("l[xx]")
+---       expression.  E.g.: >vim
+---          let l = [1, 2, 3]
+---          echo exists("l[5]")
+--- <         0 >vim
+---          echo exists("l[xx]")
 --- <         E121: Undefined variable: xx
 ---          0
 ---   &option-name  Vim option (only checks if it exists,
@@ -1908,38 +1948,39 @@ function vim.fn.exepath(expr) end
 ---   ##event    autocommand for this event is
 ---       supported.
 ---
---- Examples: >
----   exists("&mouse")
----   exists("$HOSTNAME")
----   exists("*strftime")
----   exists("*s:MyFunc")
----   exists("*MyFunc")
----   exists("bufcount")
----   exists(":Make")
----   exists("#CursorHold")
----   exists("#BufReadPre#*.gz")
----   exists("#filetypeindent")
----   exists("#filetypeindent#FileType")
----   exists("#filetypeindent#FileType#*")
----   exists("##ColorScheme")
+--- Examples: >vim
+---   echo exists("&mouse")
+---   echo exists("$HOSTNAME")
+---   echo exists("*strftime")
+---   echo exists("*s:MyFunc")
+---   echo exists("*MyFunc")
+---   echo exists("bufcount")
+---   echo exists(":Make")
+---   echo exists("#CursorHold")
+---   echo exists("#BufReadPre#*.gz")
+---   echo exists("#filetypeindent")
+---   echo exists("#filetypeindent#FileType")
+---   echo exists("#filetypeindent#FileType#*")
+---   echo exists("##ColorScheme")
 --- <There must be no space between the symbol (&/$/*/#) and the
 --- name.
 --- There must be no extra characters after the name, although in
 --- a few cases this is ignored.  That may become stricter in the
 --- future, thus don't count on it!
---- Working example: >
----   exists(":make")
---- <NOT working example: >
----   exists(":make install")
+--- Working example: >vim
+---   echo exists(":make")
+--- <NOT working example: >vim
+---   echo exists(":make install")
 ---
 --- <Note that the argument must be a string, not the name of the
---- variable itself.  For example: >
----   exists(bufcount)
+--- variable itself.  For example: >vim
+---   echo exists(bufcount)
 --- <This doesn't check for existence of the "bufcount" variable,
 --- but gets the value of "bufcount", and checks if that exists.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Varname()->exists()
+--- <
 ---
 --- @param expr any
 --- @return 0|1
@@ -1949,14 +1990,15 @@ function vim.fn.exists(expr) end
 --- [0, inf].
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo exp(2)
---- <  7.389056 >
----   :echo exp(-1)
+--- Examples: >vim
+---   echo exp(2)
+--- <  7.389056 >vim
+---   echo exp(-1)
 --- <  0.367879
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->exp()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -2006,18 +2048,18 @@ function vim.fn.exp(expr) end
 ---   :r    root (one extension removed)
 ---   :e    extension only
 ---
---- Example: >
----   :let &tags = expand("%:p:h") .. "/tags"
+--- Example: >vim
+---   let &tags = expand("%:p:h") .. "/tags"
 --- <Note that when expanding a string that starts with '%', '#' or
---- '<', any following text is ignored.  This does NOT work: >
----   :let doesntwork = expand("%:h.bak")
---- <Use this: >
----   :let doeswork = expand("%:h") .. ".bak"
+--- '<', any following text is ignored.  This does NOT work: >vim
+---   let doesntwork = expand("%:h.bak")
+--- <Use this: >vim
+---   let doeswork = expand("%:h") .. ".bak"
 --- <Also note that expanding "<cfile>" and others only returns the
 --- referenced file name without further expansion.  If "<cfile>"
 --- is "~/.cshrc", you need to do another expand() to have the
---- "~/" expanded into the path of the home directory: >
----   :echo expand(expand("<cfile>"))
+--- "~/" expanded into the path of the home directory: >vim
+---   echo expand(expand("<cfile>"))
 --- <
 --- There cannot be white space between the variables and the
 --- following modifier.  The |fnamemodify()| function can be used
@@ -2037,8 +2079,8 @@ function vim.fn.exp(expr) end
 --- {nosuf} argument is given and it is |TRUE|.
 --- Names for non-existing files are included.  The "**" item can
 --- be used to search in a directory tree.  For example, to find
---- all "README" files in the current directory and below: >
----   :echo expand("**/README")
+--- all "README" files in the current directory and below: >vim
+---   echo expand("**/README")
 --- <
 --- expand() can also be used to expand variables and environment
 --- variables that are only known in a shell.  But this can be
@@ -2052,8 +2094,9 @@ function vim.fn.exp(expr) end
 --- See |glob()| for finding existing files.  See |system()| for
 --- getting the raw output of an external command.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Getpattern()->expand()
+--- <
 ---
 --- @param string string
 --- @param nosuf? boolean
@@ -2076,12 +2119,14 @@ function vim.fn.expand(string, nosuf, list) end
 --- Returns the expanded string.  If an error is encountered
 --- during expansion, the unmodified {string} is returned.
 ---
---- Example: >
----   :echo expandcmd('make %<.o')
+--- Example: >vim
+---   echo expandcmd('make %<.o')
+--- < >
 ---   make /path/runtime/doc/builtin.o
----   :echo expandcmd('make %<.o', {'errmsg': v:true})
+--- < >vim
+---   echo expandcmd('make %<.o', {'errmsg': v:true})
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetCommand()->expandcmd()
 --- <
 ---
@@ -2098,16 +2143,16 @@ function vim.fn.expandcmd(string, options) end
 --- item with index {expr3} in {expr1}.  When {expr3} is zero
 --- insert before the first item.  When {expr3} is equal to
 --- len({expr1}) then {expr2} is appended.
---- Examples: >
----   :echo sort(extend(mylist, [7, 5]))
----   :call extend(mylist, [2, 3], 1)
+--- Examples: >vim
+---   echo sort(extend(mylist, [7, 5]))
+---   call extend(mylist, [2, 3], 1)
 --- <When {expr1} is the same List as {expr2} then the number of
 --- items copied is equal to the original length of the List.
 --- E.g., when {expr3} is 1 you get N new copies of the first item
 --- (where N is the original length of the List).
 --- Use |add()| to concatenate one item to a list.  To concatenate
---- two lists into a new list use the + operator: >
----   :let newlist = [1, 2, 3] + [4, 5]
+--- two lists into a new list use the + operator: >vim
+---   let newlist = [1, 2, 3] + [4, 5]
 --- <
 --- If they are |Dictionaries|:
 --- Add all entries from {expr2} to {expr1}.
@@ -2125,7 +2170,7 @@ function vim.fn.expandcmd(string, options) end
 --- fails.
 --- Returns {expr1}.  Returns 0 on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->extend(otherlist)
 --- <
 ---
@@ -2189,8 +2234,9 @@ function vim.fn.extendnew(expr1, expr2, expr3) end
 ---
 --- Return value is always 0.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetInput()->feedkeys()
+--- <
 ---
 --- @param string string
 --- @param mode? string
@@ -2210,14 +2256,19 @@ function vim.fn.file_readable(file) end
 --- expression, which is used as a String.
 --- If you don't care about the file being readable you can use
 --- |glob()|.
---- {file} is used as-is, you may want to expand wildcards first: >
+--- {file} is used as-is, you may want to expand wildcards first: >vim
 ---   echo filereadable('~/.vimrc')
+--- < >
 ---   0
+--- < >vim
 ---   echo filereadable(expand('~/.vimrc'))
+--- < >
 ---   1
+--- <
 ---
---- <Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->filereadable()
+--- <
 ---
 --- @param file string
 --- @return 0|1
@@ -2228,8 +2279,9 @@ function vim.fn.filereadable(file) end
 --- exist, or is not writable, the result is 0.  If {file} is a
 --- directory, and we can write to it, the result is 2.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->filewritable()
+--- <
 ---
 --- @param file string
 --- @return 0|1
@@ -2248,11 +2300,11 @@ function vim.fn.filewritable(file) end
 --- the current item.  For a |Blob| |v:key| has the index of the
 --- current byte.
 ---
---- Examples: >
+--- Examples: >vim
 ---   call filter(mylist, 'v:val !~ "OLD"')
---- <Removes the items where "OLD" appears. >
+--- <Removes the items where "OLD" appears. >vim
 ---   call filter(mydict, 'v:key >= 8')
---- <Removes the items with a key below 8. >
+--- <Removes the items with a key below 8. >vim
 ---   call filter(var, 0)
 --- <Removes all the items, thus clears the |List| or |Dictionary|.
 ---
@@ -2264,19 +2316,19 @@ function vim.fn.filewritable(file) end
 ---   1. the key or the index of the current item.
 ---   2. the value of the current item.
 --- The function must return |TRUE| if the item should be kept.
---- Example that keeps the odd items of a list: >
+--- Example that keeps the odd items of a list: >vim
 ---   func Odd(idx, val)
 ---     return a:idx % 2 == 1
 ---   endfunc
 ---   call filter(mylist, function('Odd'))
---- <It is shorter when using a |lambda|: >
+--- <It is shorter when using a |lambda|: >vim
 ---   call filter(myList, {idx, val -> idx * val <= 42})
---- <If you do not use "val" you can leave it out: >
+--- <If you do not use "val" you can leave it out: >vim
 ---   call filter(myList, {idx -> idx % 2 == 1})
 --- <
 --- The operation is done in-place.  If you want a |List| or
---- |Dictionary| to remain unmodified make a copy first: >
----   :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
+--- |Dictionary| to remain unmodified make a copy first: >vim
+---   let l = filter(copy(mylist), 'v:val =~ "KEEP"')
 ---
 --- <Returns {expr1}, the |List|, |Blob| or |Dictionary| that was
 --- filtered.  When an error is encountered while evaluating
@@ -2284,8 +2336,9 @@ function vim.fn.filewritable(file) end
 --- {expr2} is a Funcref errors inside a function are ignored,
 --- unless it was defined with the "abort" flag.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->filter(expr2)
+--- <
 ---
 --- @param expr1 any
 --- @param expr2 any
@@ -2309,8 +2362,9 @@ function vim.fn.filter(expr1, expr2) end
 ---
 --- This is quite similar to the ex-command `:find`.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->finddir()
+--- <
 ---
 --- @param name string
 --- @param path? string
@@ -2320,13 +2374,14 @@ function vim.fn.finddir(name, path, count) end
 
 --- Just like |finddir()|, but find a file instead of a directory.
 --- Uses 'suffixesadd'.
---- Example: >
----   :echo findfile("tags.vim", ".;")
+--- Example: >vim
+---   echo findfile("tags.vim", ".;")
 --- <Searches from the directory of the current file upwards until
 --- it finds the file "tags.vim".
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->findfile()
+--- <
 ---
 --- @param name string
 --- @param path? string
@@ -2346,13 +2401,13 @@ function vim.fn.findfile(name, path, count) end
 ---
 --- If there is an error the number zero is returned.
 ---
---- Example: >
----   :echo flatten([1, [2, [3, 4]], 5])
---- <  [1, 2, 3, 4, 5] >
----   :echo flatten([1, [2, [3, 4]], 5], 1)
+--- Example: >vim
+---   echo flatten([1, [2, [3, 4]], 5])
+--- <  [1, 2, 3, 4, 5] >vim
+---   echo flatten([1, [2, [3, 4]], 5], 1)
 --- <  [1, 2, [3, 4], 5]
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->flatten()
 --- <
 ---
@@ -2377,20 +2432,21 @@ function vim.fn.flattennew(list, maxdepth) end
 --- 64-bit Number support is enabled, 0x7fffffffffffffff or
 --- -0x7fffffffffffffff).  NaN results in -0x80000000 (or when
 --- 64-bit Number support is enabled, -0x8000000000000000).
---- Examples: >
+--- Examples: >vim
 ---   echo float2nr(3.95)
---- <  3  >
+--- <  3  >vim
 ---   echo float2nr(-23.45)
---- <  -23  >
+--- <  -23  >vim
 ---   echo float2nr(1.0e100)
---- <  2147483647  (or 9223372036854775807) >
+--- <  2147483647  (or 9223372036854775807) >vim
 ---   echo float2nr(-1.0e150)
---- <  -2147483647 (or -9223372036854775807) >
+--- <  -2147483647 (or -9223372036854775807) >vim
 ---   echo float2nr(1.0e-100)
 --- <  0
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->float2nr()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -2400,16 +2456,17 @@ function vim.fn.float2nr(expr) end
 --- {expr} as a |Float| (round down).
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
+--- Examples: >vim
 ---   echo floor(1.856)
---- <  1.0  >
+--- <  1.0  >vim
 ---   echo floor(-5.456)
---- <  -6.0  >
+--- <  -6.0  >vim
 ---   echo floor(4.0)
 --- <  4.0
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->floor()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -2424,14 +2481,15 @@ function vim.fn.floor(expr) end
 --- {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr1} or {expr2} is not a |Float| or a
 --- |Number|.
---- Examples: >
----   :echo fmod(12.33, 1.22)
---- <  0.13 >
----   :echo fmod(-12.33, 1.22)
+--- Examples: >vim
+---   echo fmod(12.33, 1.22)
+--- <  0.13 >vim
+---   echo fmod(-12.33, 1.22)
 --- <  -0.13
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->fmod(1.22)
+--- <
 ---
 --- @param expr1 any
 --- @param expr2 any
@@ -2439,7 +2497,7 @@ function vim.fn.floor(expr) end
 function vim.fn.fmod(expr1, expr2) end
 
 --- Escape {string} for use as file name command argument.  All
---- characters that have a special meaning, such as '%' and '|'
+--- characters that have a special meaning, such as `'%'` and `'|'`
 --- are escaped with a backslash.
 --- For most systems the characters escaped are
 --- " \t\n*?[{`$\\%#'\"|!<".  For systems where a backslash
@@ -2447,14 +2505,15 @@ function vim.fn.fmod(expr1, expr2) end
 --- A leading '+' and '>' is also escaped (special after |:edit|
 --- and |:write|).  And a "-" by itself (special after |:cd|).
 --- Returns an empty string on error.
---- Example: >
----   :let fname = '+some str%nge|name'
----   :exe "edit " .. fnameescape(fname)
---- <results in executing: >
+--- Example: >vim
+---   let fname = '+some str%nge|name'
+---   exe "edit " .. fnameescape(fname)
+--- <results in executing: >vim
 ---   edit \+some\ str\%nge\|name
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->fnameescape()
+--- <
 ---
 --- @param string string
 --- @return string
@@ -2463,8 +2522,8 @@ function vim.fn.fnameescape(string) end
 --- Modify file name {fname} according to {mods}.  {mods} is a
 --- string of characters like it is used for file names on the
 --- command line.  See |filename-modifiers|.
---- Example: >
----   :echo fnamemodify("main.c", ":p:h")
+--- Example: >vim
+---   echo fnamemodify("main.c", ":p:h")
 --- <results in: >
 ---   /home/user/vim/vim/src
 --- <If {mods} is empty or an unsupported modifier is used then
@@ -2476,8 +2535,9 @@ function vim.fn.fnameescape(string) end
 --- Note: Environment variables don't work in {fname}, use
 --- |expand()| first then.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->fnamemodify(':p:h')
+--- <
 ---
 --- @param fname integer
 --- @param mods string
@@ -2490,8 +2550,9 @@ function vim.fn.fnamemodify(fname, mods) end
 --- {lnum} is used like with |getline()|.  Thus "." is the current
 --- line, "'m" mark m, etc.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->foldclosed()
+--- <
 ---
 --- @param lnum integer
 --- @return integer
@@ -2503,8 +2564,9 @@ function vim.fn.foldclosed(lnum) end
 --- {lnum} is used like with |getline()|.  Thus "." is the current
 --- line, "'m" mark m, etc.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->foldclosedend()
+--- <
 ---
 --- @param lnum integer
 --- @return integer
@@ -2521,7 +2583,7 @@ function vim.fn.foldclosedend(lnum) end
 --- {lnum} is used like with |getline()|.  Thus "." is the current
 --- line, "'m" mark m, etc.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->foldlevel()
 --- <
 ---
@@ -2556,7 +2618,7 @@ function vim.fn.foldtext() end
 --- line, "'m" mark m, etc.
 --- Useful when exporting folded text, e.g., to HTML.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->foldtextresult()
 --- <
 ---
@@ -2575,7 +2637,7 @@ function vim.fn.foldtextresult(lnum) end
 --- For example `fullcommand('s')`, `fullcommand('sub')`,
 --- `fullcommand(':%substitute')` all return "substitute".
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->fullcommand()
 --- <
 ---
@@ -2594,7 +2656,7 @@ function vim.fn.fullcommand(name) end
 --- instead). {name} cannot be a builtin function.
 --- Returns 0 on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFuncname()->funcref([arg])
 --- <
 ---
@@ -2610,7 +2672,7 @@ function vim.fn.funcref(name, arglist, dict) end
 ---
 --- {name} can also be a Funcref or a partial. When it is a
 --- partial the dict stored in it will be used and the {dict}
---- argument is not allowed. E.g.: >
+--- argument is not allowed. E.g.: >vim
 ---   let FuncWithArg = function(dict.Func, [arg])
 ---   let Broken = function(dict.Func, [arg], dict)
 --- <
@@ -2623,38 +2685,41 @@ function vim.fn.funcref(name, arglist, dict) end
 --- the Funcref and will be used when the Funcref is called.
 ---
 --- The arguments are passed to the function in front of other
---- arguments, but after any argument from |method|.  Example: >
+--- arguments, but after any argument from |method|.  Example: >vim
 ---   func Callback(arg1, arg2, name)
 ---   "...
+---   endfunc
 ---   let Partial = function('Callback', ['one', 'two'])
 ---   "...
 ---   call Partial('name')
---- <Invokes the function as with: >
+--- <Invokes the function as with: >vim
 ---   call Callback('one', 'two', 'name')
 ---
---- <With a |method|: >
+--- <With a |method|: >vim
 ---   func Callback(one, two, three)
 ---   "...
+---   endfunc
 ---   let Partial = function('Callback', ['two'])
 ---   "...
 ---   eval 'one'->Partial('three')
---- <Invokes the function as with: >
+--- <Invokes the function as with: >vim
 ---   call Callback('one', 'two', 'three')
 ---
 --- <The function() call can be nested to add more arguments to the
 --- Funcref.  The extra arguments are appended to the list of
---- arguments.  Example: >
+--- arguments.  Example: >vim
 ---   func Callback(arg1, arg2, name)
 ---   "...
+---   endfunc
 ---   let Func = function('Callback', ['one'])
 ---   let Func2 = function(Func, ['two'])
 ---   "...
 ---   call Func2('name')
---- <Invokes the function as with: >
+--- <Invokes the function as with: >vim
 ---   call Callback('one', 'two', 'name')
 ---
 --- <The Dictionary is only useful when calling a "dict" function.
---- In that case the {dict} is passed in as "self". Example: >
+--- In that case the {dict} is passed in as "self". Example: >vim
 ---   function Callback() dict
 ---      echo "called for " .. self.name
 ---   endfunction
@@ -2665,24 +2730,26 @@ function vim.fn.funcref(name, arglist, dict) end
 ---   call Func()  " will echo: called for example
 --- <The use of function() is not needed when there are no extra
 --- arguments, these two are equivalent, if Callback() is defined
---- as context.Callback(): >
+--- as context.Callback(): >vim
 ---   let Func = function('Callback', context)
 ---   let Func = context.Callback
 ---
---- <The argument list and the Dictionary can be combined: >
+--- <The argument list and the Dictionary can be combined: >vim
 ---   function Callback(arg1, count) dict
 ---   "...
+---   endfunction
 ---   let context = {"name": "example"}
 ---   let Func = function('Callback', ['one'], context)
 ---   "...
 ---   call Func(500)
---- <Invokes the function as with: >
+--- <Invokes the function as with: >vim
 ---   call context.Callback('one', 500)
 --- <
 --- Returns 0 on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFuncname()->function([arg])
+--- <
 ---
 --- @param name string
 --- @param arglist? any
@@ -2716,8 +2783,9 @@ function vim.fn.garbagecollect(atexit) end
 --- Get item {idx} from |List| {list}.  When this item is not
 --- available return {default}.  Return zero when {default} is
 --- omitted.
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->get(idx)
+--- <
 ---
 --- @param list any[]
 --- @param idx integer
@@ -2737,7 +2805,7 @@ function vim.fn.get(blob, idx, default) end
 
 --- Get item with key {key} from |Dictionary| {dict}.  When this
 --- item is not available return {default}.  Return zero when
---- {default} is omitted.  Useful example: >
+--- {default} is omitted.  Useful example: >vim
 ---   let val = get(g:, 'var_name', 'default')
 --- <This gets the value of g:var_name if it exists, and uses
 --- "default" when it does not exist.
@@ -2798,8 +2866,8 @@ function vim.fn.getbufinfo(buf) end
 ---       displayed in the window in the past.
 ---       If you want the line number of the
 ---       last known cursor position in a given
----       window, use |line()|: >
----         :echo line('.', {winid})
+---       window, use |line()|: >vim
+---         echo line('.', {winid})
 --- <
 ---   linecount  Number of lines in the buffer (only
 ---       valid when loaded)
@@ -2816,20 +2884,20 @@ function vim.fn.getbufinfo(buf) end
 ---   windows    List of |window-ID|s that display this
 ---       buffer
 ---
---- Examples: >
+--- Examples: >vim
 ---   for buf in getbufinfo()
 ---       echo buf.name
 ---   endfor
 ---   for buf in getbufinfo({'buflisted':1})
 ---       if buf.changed
----     ....
+---     " ....
 ---       endif
 ---   endfor
 --- <
---- To get buffer-local options use: >
+--- To get buffer-local options use: >vim
 ---   getbufvar({bufnr}, '&option_name')
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetBufnr()->getbufinfo()
 --- <
 ---
@@ -2858,10 +2926,10 @@ function vim.fn.getbufinfo(dict) end
 --- This function works only for loaded buffers.  For unloaded and
 --- non-existing buffers, an empty |List| is returned.
 ---
---- Example: >
----   :let lines = getbufline(bufnr("myfile"), 1, "$")
+--- Example: >vim
+---   let lines = getbufline(bufnr("myfile"), 1, "$")
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetBufnr()->getbufline(lnum)
 --- <
 ---
@@ -2895,11 +2963,11 @@ function vim.fn.getbufoneline(buf, lnum) end
 --- For the use of {buf}, see |bufname()| above.
 --- When the buffer or variable doesn't exist {def} or an empty
 --- string is returned, there is no error message.
---- Examples: >
----   :let bufmodified = getbufvar(1, "&mod")
----   :echo "todo myvar = " .. getbufvar("todo", "myvar")
+--- Examples: >vim
+---   let bufmodified = getbufvar(1, "&mod")
+---   echo "todo myvar = " .. getbufvar("todo", "myvar")
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetBufnr()->getbufvar(varname)
 --- <
 ---
@@ -2932,8 +3000,9 @@ function vim.fn.getcellwidths() end
 --- position refers to the position in the list. For other
 --- buffers, it is set to the length of the list.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetBufnr()->getchangelist()
+--- <
 ---
 --- @param buf? integer|string
 --- @return table[]
@@ -2972,7 +3041,7 @@ function vim.fn.getchangelist(buf) end
 --- |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|.
 --- |getmousepos()| can also be used.  Mouse move events will be
 --- ignored.
---- This example positions the mouse as it would normally happen: >
+--- This example positions the mouse as it would normally happen: >vim
 ---   let c = getchar()
 ---   if c == "\<LeftMouse>" && v:mouse_win > 0
 ---     exe v:mouse_win .. "wincmd w"
@@ -2987,20 +3056,20 @@ function vim.fn.getchangelist(buf) end
 --- There is no mapping for the character.
 --- Key codes are replaced, thus when the user presses the <Del>
 --- key you get the code for the <Del> key, not the raw character
---- sequence.  Examples: >
+--- sequence.  Examples: >vim
 ---   getchar() == "\<Del>"
 ---   getchar() == "\<S-Left>"
---- <This example redefines "f" to ignore case: >
----   :nmap f :call FindChar()<CR>
----   :function FindChar()
----   :  let c = nr2char(getchar())
----   :  while col('.') < col('$') - 1
----   :    normal l
----   :    if getline('.')[col('.') - 1] ==? c
----   :      break
----   :    endif
----   :  endwhile
----   :endfunction
+--- <This example redefines "f" to ignore case: >vim
+---   nmap f :call FindChar()<CR>
+---   function FindChar()
+---     let c = nr2char(getchar())
+---     while col('.') < col('$') - 1
+---       normal l
+---       if getline('.')[col('.') - 1] ==? c
+---         break
+---       endif
+---     endwhile
+---   endfunction
 --- <
 ---
 --- @return integer
@@ -3032,12 +3101,13 @@ function vim.fn.getcharmod() end
 --- of the last character.
 ---
 --- Example:
---- With the cursor on '세' in line 5 with text "여보세요": >
+--- With the cursor on '세' in line 5 with text "여보세요": >vim
 ---   getcharpos('.')    returns [0, 5, 3, 0]
 ---   getpos('.')    returns [0, 5, 7, 0]
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetMark()->getcharpos()
+--- <
 ---
 --- @param expr any
 --- @return integer[]
@@ -3057,9 +3127,9 @@ function vim.fn.getcharpos(expr) end
 ---
 --- This can be useful to always have |;| and |,| search
 --- forward/backward regardless of the direction of the previous
---- character search: >
----   :nnoremap <expr> ; getcharsearch().forward ? ';' : ','
----   :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
+--- character search: >vim
+---   nnoremap <expr> ; getcharsearch().forward ? ';' : ','
+---   nnoremap <expr> , getcharsearch().forward ? ',' : ';'
 --- <Also see |setcharsearch()|.
 ---
 --- @return table[]
@@ -3093,8 +3163,8 @@ function vim.fn.getcmdcompltype() end
 --- Return the current command-line.  Only works when the command
 --- line is being edited, thus requires use of |c_CTRL-\_e| or
 --- |c_CTRL-R_=|.
---- Example: >
----   :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
+--- Example: >vim
+---   cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
 --- <Also see |getcmdtype()|, |getcmdpos()|, |setcmdpos()| and
 --- |setcmdline()|.
 --- Returns an empty string when entering a password or using
@@ -3209,13 +3279,13 @@ function vim.fn.getcmdwintype() end
 ---
 --- If {type} is "cmdline", then the |cmdline-completion| result is
 --- returned.  For example, to complete the possible values after
---- a ":call" command: >
+--- a ":call" command: >vim
 ---   echo getcompletion('call ', 'cmdline')
 --- <
 --- If there are no matches, an empty list is returned.  An
 --- invalid value for {type} produces an error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetPattern()->getcompletion('color')
 --- <
 ---
@@ -3242,14 +3312,14 @@ function vim.fn.getcompletion(pat, type, filtered) end
 --- current value of the buffer if it is not the current window.
 --- If {winid} is invalid a list with zeroes is returned.
 ---
---- This can be used to save and restore the cursor position: >
+--- This can be used to save and restore the cursor position: >vim
 ---   let save_cursor = getcurpos()
 ---   MoveTheCursorAround
 ---   call setpos('.', save_cursor)
 --- <Note that this only works within the window.  See
 --- |winrestview()| for restoring more state.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinid()->getcurpos()
 --- <
 ---
@@ -3261,12 +3331,13 @@ function vim.fn.getcurpos(winid) end
 --- List is a character index instead of a byte index.
 ---
 --- Example:
---- With the cursor on '보' in line 3 with text "여보세요": >
----   getcursorcharpos()  returns [0, 3, 2, 0, 3]
----   getcurpos()    returns [0, 3, 4, 0, 3]
+--- With the cursor on '보' in line 3 with text "여보세요": >vim
+---   getcursorcharpos()  " returns [0, 3, 2, 0, 3]
+---   getcurpos()    " returns [0, 3, 4, 0, 3]
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinid()->getcursorcharpos()
+--- <
 ---
 --- @param winid? integer
 --- @return any
@@ -3278,7 +3349,7 @@ function vim.fn.getcursorcharpos(winid) end
 --- ignored.
 --- Tabs and windows are identified by their respective numbers,
 --- 0 means current tab or window. Missing tab number implies 0.
---- Thus the following are equivalent: >
+--- Thus the following are equivalent: >vim
 ---   getcwd(0)
 ---   getcwd(0, 0)
 --- <If {winnr} is -1 it is ignored, only the tab is resolved.
@@ -3287,8 +3358,9 @@ function vim.fn.getcursorcharpos(winid) end
 --- directory is returned.
 --- Throw error if the arguments are invalid. |E5000| |E5001| |E5002|
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinnr()->getcwd()
+--- <
 ---
 --- @param winnr? integer
 --- @param tabnr? integer
@@ -3296,15 +3368,16 @@ function vim.fn.getcursorcharpos(winid) end
 function vim.fn.getcwd(winnr, tabnr) end
 
 --- Return the value of environment variable {name}.  The {name}
---- argument is a string, without a leading '$'.  Example: >
+--- argument is a string, without a leading '$'.  Example: >vim
 ---   myHome = getenv('HOME')
 ---
 --- <When the variable does not exist |v:null| is returned.  That
 --- is different from a variable set to an empty string.
 --- See also |expr-env|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetVarname()->getenv()
+--- <
 ---
 --- @param name string
 --- @return string
@@ -3333,13 +3406,13 @@ function vim.fn.getfontname(name) end
 --- "rwx" flags represent, in turn, the permissions of the owner
 --- of the file, the group the file belongs to, and other users.
 --- If a user does not have a given permission the flag for this
---- is replaced with the string "-".  Examples: >
----   :echo getfperm("/etc/passwd")
----   :echo getfperm(expand("~/.config/nvim/init.vim"))
+--- is replaced with the string "-".  Examples: >vim
+---   echo getfperm("/etc/passwd")
+---   echo getfperm(expand("~/.config/nvim/init.vim"))
 --- <This will hopefully (from a security point of view) display
 --- the string "rw-r--r--" or even "rw-------".
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFilename()->getfperm()
 --- <
 --- For setting permissions use |setfperm()|.
@@ -3355,8 +3428,9 @@ function vim.fn.getfperm(fname) end
 --- If the size of {fname} is too big to fit in a Number then -2
 --- is returned.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFilename()->getfsize()
+--- <
 ---
 --- @param fname integer
 --- @return integer
@@ -3368,8 +3442,9 @@ function vim.fn.getfsize(fname) end
 --- |localtime()| and |strftime()|.
 --- If the file {fname} can't be found -1 is returned.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFilename()->getftime()
+--- <
 ---
 --- @param fname integer
 --- @return integer
@@ -3388,14 +3463,15 @@ function vim.fn.getftime(fname) end
 ---   Socket      "socket"
 ---   FIFO      "fifo"
 ---   All other    "other"
---- Example: >
+--- Example: >vim
 ---   getftype("/home")
 --- <Note that a type such as "link" will only be returned on
 --- systems that support it.  On some systems only "dir" and
 --- "file" are returned.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFilename()->getftype()
+--- <
 ---
 --- @param fname integer
 --- @return 'file'|'dir'|'link'|'bdev'|'cdev'|'socket'|'fifo'|'other'
@@ -3420,7 +3496,7 @@ function vim.fn.getftype(fname) end
 ---   filename  filename if available
 ---   lnum    line number
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinnr()->getjumplist()
 --- <
 ---
@@ -3430,11 +3506,11 @@ function vim.fn.getftype(fname) end
 function vim.fn.getjumplist(winnr, tabnr) end
 
 --- Without {end} the result is a String, which is line {lnum}
---- from the current buffer.  Example: >
+--- from the current buffer.  Example: >vim
 ---   getline(1)
 --- <When {lnum} is a String that doesn't start with a
 --- digit, |line()| is called to translate the String into a Number.
---- To get the line under the cursor: >
+--- To get the line under the cursor: >vim
 ---   getline(".")
 --- <When {lnum} is a number smaller than 1 or bigger than the
 --- number of lines in the buffer, an empty string is returned.
@@ -3445,12 +3521,12 @@ function vim.fn.getjumplist(winnr, tabnr) end
 --- {end} is used in the same way as {lnum}.
 --- Non-existing lines are silently omitted.
 --- When {end} is before {lnum} an empty |List| is returned.
---- Example: >
----   :let start = line('.')
----   :let end = search("^$") - 1
----   :let lines = getline(start, end)
+--- Example: >vim
+---   let start = line('.')
+---   let end = search("^$") - 1
+---   let lines = getline(start, end)
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   ComputeLnum()->getline()
 ---
 --- <To get lines from another buffer see |getbufline()| and
@@ -3487,9 +3563,9 @@ function vim.fn.getline(lnum, end_) end
 --- location list for the window {nr}.
 --- Returns an empty Dictionary if window {nr} does not exist.
 ---
---- Examples (See also |getqflist-examples|): >
----   :echo getloclist(3, {'all': 0})
----   :echo getloclist(5, {'filewinid': 0})
+--- Examples (See also |getqflist-examples|): >vim
+---   echo getloclist(3, {'all': 0})
+---   echo getloclist(5, {'filewinid': 0})
 --- <
 ---
 --- @param nr integer
@@ -3515,8 +3591,9 @@ function vim.fn.getloclist(nr, what) end
 --- Refer to |getpos()| for getting information about a specific
 --- mark.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetBufnr()->getmarklist()
+--- <
 ---
 --- @param buf? any
 --- @return any
@@ -3531,26 +3608,26 @@ function vim.fn.getmarklist(buf) end
 --- window ID instead of the current window.  If {win} is invalid,
 --- an empty list is returned.
 --- Example: >vim
----   :echo getmatches()
+---   echo getmatches()
 --- < >
 ---   [{"group": "MyGroup1", "pattern": "TODO",
 ---   "priority": 10, "id": 1}, {"group": "MyGroup2",
 ---   "pattern": "FIXME", "priority": 10, "id": 2}]
 --- < >vim
----   :let m = getmatches()
----   :call clearmatches()
----   :echo getmatches()
+---   let m = getmatches()
+---   call clearmatches()
+---   echo getmatches()
 --- < >
 ---   []
 --- < >vim
----   :call setmatches(m)
----   :echo getmatches()
+---   call setmatches(m)
+---   echo getmatches()
 --- < >
 ---   [{"group": "MyGroup1", "pattern": "TODO",
 ---   "priority": 10, "id": 1}, {"group": "MyGroup2",
 ---   "pattern": "FIXME", "priority": 10, "id": 2}]
 --- < >vim
----   :unlet m
+---   unlet m
 --- <
 ---
 --- @param win? any
@@ -3616,14 +3693,15 @@ function vim.fn.getpid() end
 --- A very large column number equal to |v:maxcol| can be returned,
 --- in which case it means "after the end of the line".
 --- If {expr} is invalid, returns a list with all zeros.
---- This can be used to save and restore the position of a mark: >
+--- This can be used to save and restore the position of a mark: >vim
 ---   let save_a_mark = getpos("'a")
----   ...
+---   " ...
 ---   call setpos("'a", save_a_mark)
 --- <Also see |getcharpos()|, |getcurpos()| and |setpos()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetMark()->getpos()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -3654,11 +3732,11 @@ function vim.fn.getpos(expr) end
 --- you may need to explicitly check for zero).
 ---
 --- Useful application: Find pattern matches in multiple files and
---- do something with them: >
----   :vimgrep /theword/jg *.c
----   :for d in getqflist()
----   :   echo bufname(d.bufnr) ':' d.lnum '=' d.text
----   :endfor
+--- do something with them: >vim
+---   vimgrep /theword/jg *.c
+---   for d in getqflist()
+---      echo bufname(d.bufnr) ':' d.lnum '=' d.text
+---   endfor
 --- <
 --- If the optional {what} dictionary argument is supplied, then
 --- returns only the items listed in {what} as a dictionary. The
@@ -3723,10 +3801,10 @@ function vim.fn.getpos(expr) end
 ---     to "".
 ---   winid  quickfix |window-ID|. If not present, set to 0
 ---
---- Examples (See also |getqflist-examples|): >
----   :echo getqflist({'all': 1})
----   :echo getqflist({'nr': 2, 'title': 1})
----   :echo getqflist({'lines' : ["F1:10:L10"]})
+--- Examples (See also |getqflist-examples|): >vim
+---   echo getqflist({'all': 1})
+---   echo getqflist({'nr': 2, 'title': 1})
+---   echo getqflist({'lines' : ["F1:10:L10"]})
 --- <
 ---
 --- @param what? any
@@ -3734,8 +3812,8 @@ function vim.fn.getpos(expr) end
 function vim.fn.getqflist(what) end
 
 --- The result is a String, which is the contents of register
---- {regname}.  Example: >
----   :let cliptext = getreg('*')
+--- {regname}.  Example: >vim
+---   let cliptext = getreg('*')
 --- <When register {regname} was not set the result is an empty
 --- string.
 --- The {regname} argument must be a string.
@@ -3755,8 +3833,9 @@ function vim.fn.getqflist(what) end
 ---
 --- If {regname} is not specified, |v:register| is used.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetRegname()->getreg()
+--- <
 ---
 --- @param regname? string
 --- @param list? any
@@ -3786,8 +3865,9 @@ function vim.fn.getreg(regname, list) end
 --- If {regname} is not specified, |v:register| is used.
 --- The returned Dictionary can be passed to |setreg()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetRegname()->getreginfo()
+--- <
 ---
 --- @param regname? string
 --- @return table
@@ -3803,8 +3883,9 @@ function vim.fn.getreginfo(regname) end
 --- The {regname} argument is a string.  If {regname} is not
 --- specified, |v:register| is used.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetRegname()->getregtype()
+--- <
 ---
 --- @param regname? string
 --- @return string
@@ -3841,9 +3922,9 @@ function vim.fn.getregtype(regname) end
 ---     this dictionary.
 ---     version  Vimscript version, always 1
 ---
---- Examples: >
----   :echo getscriptinfo({'name': 'myscript'})
----   :echo getscriptinfo({'sid': 15}).variables
+--- Examples: >vim
+---   echo getscriptinfo({'name': 'myscript'})
+---   echo getscriptinfo({'sid': 15}).variables
 --- <
 ---
 --- @param opts? table
@@ -3862,8 +3943,9 @@ function vim.fn.getscriptinfo(opts) end
 ---       tabpage-local variables
 ---   windows    List of |window-ID|s in the tab page.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetTabnr()->gettabinfo()
+--- <
 ---
 --- @param tabnr? integer
 --- @return any
@@ -3878,8 +3960,9 @@ function vim.fn.gettabinfo(tabnr) end
 --- When the tab or variable doesn't exist {def} or an empty
 --- string is returned, there is no error message.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetTabnr()->gettabvar(varname)
+--- <
 ---
 --- @param tabnr integer
 --- @param varname string
@@ -3905,15 +3988,16 @@ function vim.fn.gettabvar(tabnr, varname, def) end
 --- or buffer-local variable.
 --- When the tab, window or variable doesn't exist {def} or an
 --- empty string is returned, there is no error message.
---- Examples: >
----   :let list_is_on = gettabwinvar(1, 2, '&list')
----   :echo "myvar = " .. gettabwinvar(3, 1, 'myvar')
+--- Examples: >vim
+---   let list_is_on = gettabwinvar(1, 2, '&list')
+---   echo "myvar = " .. gettabwinvar(3, 1, 'myvar')
 --- <
---- To obtain all window-local variables use: >
+--- To obtain all window-local variables use: >vim
 ---   gettabwinvar({tabnr}, {winnr}, '&')
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetTabnr()->gettabwinvar(winnr, varname)
+--- <
 ---
 --- @param tabnr integer
 --- @param winnr integer
@@ -3949,7 +4033,7 @@ function vim.fn.gettabwinvar(tabnr, winnr, varname, def) end
 ---
 --- See |tagstack| for more information about the tag stack.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinnr()->gettagstack()
 --- <
 ---
@@ -4004,8 +4088,9 @@ function vim.fn.gettext(text) end
 ---   winrow    topmost screen line of the window;
 ---       "row" from |win_screenpos()|
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinnr()->getwininfo()
+--- <
 ---
 --- @param winid? integer
 --- @return any
@@ -4021,7 +4106,7 @@ function vim.fn.getwininfo(winid) end
 --- When using a value less than 10 and no response is received
 --- within that time, a previously reported position is returned,
 --- if available.  This can be used to poll for the position and
---- do some work in the meantime: >
+--- do some work in the meantime: >vim
 ---   while 1
 ---     let res = getwinpos(1)
 ---     if res[0] >= 0
@@ -4030,7 +4115,7 @@ function vim.fn.getwininfo(winid) end
 ---     " Do some work here
 ---   endwhile
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetTimeout()->getwinpos()
 --- <
 ---
@@ -4055,11 +4140,11 @@ function vim.fn.getwinposx() end
 function vim.fn.getwinposy() end
 
 --- Like |gettabwinvar()| for the current tabpage.
---- Examples: >
----   :let list_is_on = getwinvar(2, '&list')
----   :echo "myvar = " .. getwinvar(1, 'myvar')
+--- Examples: >vim
+---   let list_is_on = getwinvar(2, '&list')
+---   echo "myvar = " .. getwinvar(1, 'myvar')
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetWinnr()->getwinvar(varname)
 --- <
 ---
@@ -4095,17 +4180,18 @@ function vim.fn.getwinvar(winnr, varname, def) end
 --- |TRUE| then all symbolic links are included.
 ---
 --- For most systems backticks can be used to get files names from
---- any external command.  Example: >
----   :let tagfiles = glob("`find . -name tags -print`")
----   :let &tags = substitute(tagfiles, "\n", ",", "g")
+--- any external command.  Example: >vim
+---   let tagfiles = glob("`find . -name tags -print`")
+---   let &tags = substitute(tagfiles, "\n", ",", "g")
 --- <The result of the program inside the backticks should be one
 --- item per line.  Spaces inside an item are allowed.
 ---
 --- See |expand()| for expanding special Vim variables.  See
 --- |system()| for getting the raw output of an external command.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetExpr()->glob()
+--- <
 ---
 --- @param expr any
 --- @param nosuf? boolean
@@ -4116,16 +4202,20 @@ function vim.fn.glob(expr, nosuf, list, alllinks) end
 
 --- Convert a file pattern, as used by glob(), into a search
 --- pattern.  The result can be used to match with a string that
---- is a file name.  E.g. >
+--- is a file name.  E.g. >vim
 ---   if filename =~ glob2regpat('Make*.mak')
---- <This is equivalent to: >
+---     " ...
+---   endif
+--- <This is equivalent to: >vim
 ---   if filename =~ '^Make.*\.mak$'
+---     " ...
+---   endif
 --- <When {string} is an empty string the result is "^$", match an
 --- empty string.
 --- Note that the result depends on the system.  On MS-Windows
 --- a backslash usually means a path separator.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetExpr()->glob2regpat()
 --- <
 ---
@@ -4134,8 +4224,8 @@ function vim.fn.glob(expr, nosuf, list, alllinks) end
 function vim.fn.glob2regpat(string) end
 
 --- Perform glob() for String {expr} on all directories in {path}
---- and concatenate the results.  Example: >
----   :echo globpath(&rtp, "syntax/c.vim")
+--- and concatenate the results.  Example: >vim
+---   echo globpath(&rtp, "syntax/c.vim")
 --- <
 --- {path} is a comma-separated list of directory names.  Each
 --- directory name is prepended to {expr} and expanded like with
@@ -4155,20 +4245,20 @@ function vim.fn.glob2regpat(string) end
 --- with all matching files. The advantage of using a List is, you
 --- also get filenames containing newlines correctly. Otherwise
 --- the result is a String and when there are several matches,
---- they are separated by <NL> characters.  Example: >
----   :echo globpath(&rtp, "syntax/c.vim", 0, 1)
+--- they are separated by <NL> characters.  Example: >vim
+---   echo globpath(&rtp, "syntax/c.vim", 0, 1)
 --- <
 --- {allinks} is used as with |glob()|.
 ---
 --- The "**" item can be used to search in a directory tree.
 --- For example, to find all "README.txt" files in the directories
---- in 'runtimepath' and below: >
----   :echo globpath(&rtp, "**/README.txt")
+--- in 'runtimepath' and below: >vim
+---   echo globpath(&rtp, "**/README.txt")
 --- <Upwards search and limiting the depth of "**" is not
 --- supported, thus using 'path' will not always work properly.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- second argument: >
+--- second argument: >vim
 ---   GetExpr()->globpath(&rtp)
 --- <
 ---
@@ -4189,9 +4279,9 @@ function vim.fn.globpath(path, expr, nosuf, list, allinks) end
 ---
 --- <If the code has a syntax error then Vimscript may skip the
 --- rest of the line.  Put |:if| and |:endif| on separate lines to
---- avoid the syntax error: >
+--- avoid the syntax error: >vim
 ---   if has('feature')
----     let x = this->breaks->without->the->feature
+---     let x = this_breaks_without_the_feature()
 ---   endif
 --- <
 --- Vim's compile-time feature-names (prefixed with "+") are not
@@ -4200,12 +4290,16 @@ function vim.fn.globpath(path, expr, nosuf, list, allinks) end
 ---
 --- Feature names can be:
 --- 1.  Nvim version. For example the "nvim-0.2.1" feature means
----     that Nvim is version 0.2.1 or later: >
----   :if has("nvim-0.2.1")
+---     that Nvim is version 0.2.1 or later: >vim
+---   if has("nvim-0.2.1")
+---     " ...
+---   endif
 ---
 --- <2.  Runtime condition or other pseudo-feature. For example the
----     "win32" feature checks if the current system is Windows: >
----   :if has("win32")
+---     "win32" feature checks if the current system is Windows: >vim
+---   if has("win32")
+---     " ...
+---   endif
 --- <          *feature-list*
 ---     List of supported pseudo-feature names:
 ---   acl    |ACL| support.
@@ -4231,12 +4325,16 @@ function vim.fn.globpath(path, expr, nosuf, list, allinks) end
 ---
 ---           *has-patch*
 --- 3.  Vim patch. For example the "patch123" feature means that
----     Vim patch 123 at the current |v:version| was included: >
----   :if v:version > 602 || v:version == 602 && has("patch148")
+---     Vim patch 123 at the current |v:version| was included: >vim
+---   if v:version > 602 || v:version == 602 && has("patch148")
+---     " ...
+---   endif
 ---
 --- <4.  Vim version. For example the "patch-7.4.237" feature means
----     that Nvim is Vim-compatible to version 7.4.237 or later. >
----   :if has("patch-7.4.237")
+---     that Nvim is Vim-compatible to version 7.4.237 or later. >vim
+---   if has("patch-7.4.237")
+---     " ...
+---   endif
 --- <
 ---
 --- @param feature any
@@ -4247,8 +4345,9 @@ function vim.fn.has(feature) end
 --- has an entry with key {key}.  FALSE otherwise. The {key}
 --- argument is a string.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mydict->has_key(key)
+--- <
 ---
 --- @param dict any
 --- @param key any
@@ -4261,18 +4360,19 @@ function vim.fn.has_key(dict, key) end
 ---
 --- Tabs and windows are identified by their respective numbers,
 --- 0 means current tab or window. Missing argument implies 0.
---- Thus the following are equivalent: >
----   haslocaldir()
----   haslocaldir(0)
----   haslocaldir(0, 0)
+--- Thus the following are equivalent: >vim
+---   echo haslocaldir()
+---   echo haslocaldir(0)
+---   echo haslocaldir(0, 0)
 --- <With {winnr} use that window in the current tabpage.
 --- With {winnr} and {tabnr} use the window in that tabpage.
 --- {winnr} can be the window number or the |window-ID|.
 --- If {winnr} is -1 it is ignored, only the tab is resolved.
 --- Throw error if the arguments are invalid. |E5000| |E5001| |E5002|
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinnr()->haslocaldir()
+--- <
 ---
 --- @param winnr? integer
 --- @param tabnr? integer
@@ -4302,15 +4402,16 @@ function vim.fn.haslocaldir(winnr, tabnr) end
 --- When {mode} is omitted, "nvo" is used.
 ---
 --- This function is useful to check if a mapping already exists
---- to a function in a Vim script.  Example: >
----   :if !hasmapto('\ABCdoit')
----   :   map <Leader>d \ABCdoit
----   :endif
+--- to a function in a Vim script.  Example: >vim
+---   if !hasmapto('\ABCdoit')
+---      map <Leader>d \ABCdoit
+---   endif
 --- <This installs the mapping to "\ABCdoit" only if there isn't
 --- already a mapping to "\ABCdoit".
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetRHS()->hasmapto()
+--- <
 ---
 --- @param what any
 --- @param mode? string
@@ -4347,14 +4448,15 @@ function vim.fn.highlight_exists(name) end
 --- The result is a Number: TRUE if the operation was successful,
 --- otherwise FALSE is returned.
 ---
---- Example: >
----   :call histadd("input", strftime("%Y %b %d"))
----   :let date=input("Enter date: ")
+--- Example: >vim
+---   call histadd("input", strftime("%Y %b %d"))
+---   let date=input("Enter date: ")
 --- <This function is not available in the |sandbox|.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- second argument: >
+--- second argument: >vim
 ---   GetHistory()->histadd('search')
+--- <
 ---
 --- @param history any
 --- @param item any
@@ -4376,24 +4478,25 @@ function vim.fn.histadd(history, item) end
 --- is returned.
 ---
 --- Examples:
---- Clear expression register history: >
----   :call histdel("expr")
+--- Clear expression register history: >vim
+---   call histdel("expr")
 --- <
---- Remove all entries starting with "*" from the search history: >
----   :call histdel("/", '^\*')
+--- Remove all entries starting with "*" from the search history: >vim
+---   call histdel("/", '^\*')
 --- <
---- The following three are equivalent: >
----   :call histdel("search", histnr("search"))
----   :call histdel("search", -1)
----   :call histdel("search", '^' .. histget("search", -1) .. '$')
+--- The following three are equivalent: >vim
+---   call histdel("search", histnr("search"))
+---   call histdel("search", -1)
+---   call histdel("search", '^' .. histget("search", -1) .. '$')
 --- <
 --- To delete the last search pattern and use the last-but-one for
---- the "n" command and 'hlsearch': >
----   :call histdel("search", -1)
----   :let \@/ = histget("search", -1)
+--- the "n" command and 'hlsearch': >vim
+---   call histdel("search", -1)
+---   let \@/ = histget("search", -1)
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetHistory()->histdel()
+--- <
 ---
 --- @param history any
 --- @param item? any
@@ -4407,15 +4510,16 @@ function vim.fn.histdel(history, item) end
 --- omitted, the most recent item from the history is used.
 ---
 --- Examples:
---- Redo the second last search from history. >
----   :execute '/' .. histget("search", -2)
+--- Redo the second last search from history. >vim
+---   execute '/' .. histget("search", -2)
 ---
 --- <Define an Ex command ":H {num}" that supports re-execution of
---- the {num}th entry from the output of |:history|. >
----   :command -nargs=1 H execute histget("cmd", 0+<args>)
+--- the {num}th entry from the output of |:history|. >vim
+---   command -nargs=1 H execute histget("cmd", 0+<args>)
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetHistory()->histget()
+--- <
 ---
 --- @param history any
 --- @param index? any
@@ -4426,10 +4530,10 @@ function vim.fn.histget(history, index) end
 --- See |hist-names| for the possible values of {history}.
 --- If an error occurred, -1 is returned.
 ---
---- Example: >
----   :let inp_index = histnr("expr")
+--- Example: >vim
+---   let inp_index = histnr("expr")
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetHistory()->histnr()
 --- <
 ---
@@ -4442,11 +4546,12 @@ function vim.fn.histnr(history) end
 --- zero is returned.
 --- This can be used to retrieve information about the highlight
 --- group.  For example, to get the background color of the
---- "Comment" group: >
----   :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
+--- "Comment" group: >vim
+---   echo synIDattr(synIDtrans(hlID("Comment")), "bg")
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->hlID()
+--- <
 ---
 --- @param name string
 --- @return integer
@@ -4458,7 +4563,7 @@ function vim.fn.hlID(name) end
 --- been defined for it, it may also have been used for a syntax
 --- item.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->hlexists()
 --- <
 ---
@@ -4484,7 +4589,7 @@ function vim.fn.hostname() end
 --- from/to UCS-2 is automatically changed to use UTF-8.  You
 --- cannot use UCS-2 in a string anyway, because of the NUL bytes.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->iconv('latin1', 'utf-8')
 --- <
 ---
@@ -4498,8 +4603,8 @@ function vim.fn.iconv(string, from, to) end
 --- container type (|List|, |Dict|, |Blob| and |Partial|). It is
 --- guaranteed that for the mentioned types `id(v1) ==# id(v2)`
 --- returns true iff `type(v1) == type(v2) && v1 is v2`.
---- Note that |v:_null_string|, |v:_null_list|, |v:_null_dict| and
---- |v:_null_blob| have the same `id()` with different types
+--- Note that `v:_null_string`, `v:_null_list`, `v:_null_dict` and
+--- `v:_null_blob` have the same `id()` with different types
 --- because they are internally represented as NULL pointers.
 --- `id()` returns a hexadecimal representanion of the pointers to
 --- the containers (i.e. like `0x994a40`), same as `printf("%p",
@@ -4519,8 +4624,9 @@ function vim.fn.id(expr) end
 --- |getline()|.
 --- When {lnum} is invalid -1 is returned.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->indent()
+--- <
 ---
 --- @param lnum integer
 --- @return integer
@@ -4546,12 +4652,15 @@ function vim.fn.indent(lnum) end
 --- case must match.
 ---
 --- -1 is returned when {expr} is not found in {object}.
---- Example: >
----   :let idx = index(words, "the")
----   :if index(numbers, 123) >= 0
+--- Example: >vim
+---   let idx = index(words, "the")
+---   if index(numbers, 123) >= 0
+---     " ...
+---   endif
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetObject()->index(what)
+--- <
 ---
 --- @param object any
 --- @param expr any
@@ -4591,14 +4700,15 @@ function vim.fn.index(object, expr, start, ic) end
 ---     index; may be negative for an item relative to
 ---     the end
 --- Returns -1 when {expr} evaluates to v:false for all the items.
---- Example: >
----   :let l = [#{n: 10}, #{n: 20}, #{n: 30}]
----   :echo indexof(l, "v:val.n == 20")
----   :echo indexof(l, {i, v -> v.n == 30})
----   :echo indexof(l, "v:val.n == 20", #{startidx: 1})
+--- Example: >vim
+---   let l = [#{n: 10}, #{n: 20}, #{n: 30}]
+---   echo indexof(l, "v:val.n == 20")
+---   echo indexof(l, {i, v -> v.n == 30})
+---   echo indexof(l, "v:val.n == 20", #{startidx: 1})
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   mylist->indexof(expr)
+--- <
 ---
 --- @param object any
 --- @param expr any
@@ -4633,22 +4743,22 @@ function vim.fn.input(prompt, text, completion) end
 --- The input is entered just like a command-line, with the same
 --- editing commands and mappings.  There is a separate history
 --- for lines typed for input().
---- Example: >
----   :if input("Coffee or beer? ") == "beer"
----   :  echo "Cheers!"
----   :endif
+--- Example: >vim
+---   if input("Coffee or beer? ") == "beer"
+---     echo "Cheers!"
+---   endif
 --- <
 --- If the optional {text} argument is present and not empty, this
 --- is used for the default reply, as if the user typed this.
---- Example: >
----   :let color = input("Color? ", "white")
+--- Example: >vim
+---   let color = input("Color? ", "white")
 ---
 --- <The optional {completion} argument specifies the type of
 --- completion supported for the input.  Without it completion is
 --- not performed.  The supported completion types are the same as
 --- that can be supplied to a user-defined command using the
 --- "-complete=" argument.  Refer to |:command-completion| for
---- more information.  Example: >
+--- more information.  Example: >vim
 ---   let fname = input("File: ", "", "file")
 ---
 --- <      *input()-highlight* *E5400* *E5402*
@@ -4669,7 +4779,7 @@ function vim.fn.input(prompt, text, completion) end
 --- sections must be ordered so that next hl_start_col is greater
 --- then or equal to previous hl_end_col.
 ---
---- Example (try some input with parentheses): >
+--- Example (try some input with parentheses): >vim
 ---   highlight RBP1 guibg=Red ctermbg=red
 ---   highlight RBP2 guibg=Yellow ctermbg=yellow
 ---   highlight RBP3 guibg=Green ctermbg=green
@@ -4714,16 +4824,17 @@ function vim.fn.input(prompt, text, completion) end
 --- that further characters follow in the mapping, e.g., by using
 --- |:execute| or |:normal|.
 ---
---- Example with a mapping: >
----   :nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR>
----   :function GetFoo()
----   :  call inputsave()
----   :  let g:Foo = input("enter search pattern: ")
----   :  call inputrestore()
----   :endfunction
+--- Example with a mapping: >vim
+---   nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR>
+---   function GetFoo()
+---     call inputsave()
+---     let g:Foo = input("enter search pattern: ")
+---     call inputrestore()
+---   endfunction
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetPrompt()->input()
+--- <
 ---
 --- @param opts table
 --- @return any
@@ -4748,12 +4859,13 @@ function vim.fn.inputdialog(...) end
 --- Make sure {textlist} has less than 'lines' entries, otherwise
 --- it won't work.  It's a good idea to put the entry number at
 --- the start of the string.  And put a prompt in the first item.
---- Example: >
+--- Example: >vim
 ---   let color = inputlist(['Select color:', '1. red',
 ---     \ '2. green', '3. blue'])
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetChoices()->inputlist()
+--- <
 ---
 --- @param textlist any
 --- @return any
@@ -4787,8 +4899,9 @@ function vim.fn.inputsave() end
 --- typed on the command-line in response to the issued prompt.
 --- NOTE: Command-line completion is not supported.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetPrompt()->inputsecret()
+--- <
 ---
 --- @param prompt any
 --- @param text? any
@@ -4803,16 +4916,17 @@ function vim.fn.inputsecret(prompt, text) end
 --- like omitting {idx}.  A negative {idx} is also possible, see
 --- |list-index|.  -1 inserts just before the last item.
 ---
---- Returns the resulting |List| or |Blob|.  Examples: >
----   :let mylist = insert([2, 3, 5], 1)
----   :call insert(mylist, 4, -1)
----   :call insert(mylist, 6, len(mylist))
+--- Returns the resulting |List| or |Blob|.  Examples: >vim
+---   let mylist = insert([2, 3, 5], 1)
+---   call insert(mylist, 4, -1)
+---   call insert(mylist, 6, len(mylist))
 --- <The last example can be done simpler with |add()|.
 --- Note that when {item} is a |List| it is inserted as a single
 --- item.  Use |extend()| to concatenate |Lists|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->insert(item)
+--- <
 ---
 --- @param object any
 --- @param item any
@@ -4823,23 +4937,25 @@ function vim.fn.insert(object, item, idx) end
 --- Interrupt script execution.  It works more or less like the
 --- user typing CTRL-C, most commands won't execute and control
 --- returns to the user.  This is useful to abort execution
---- from lower down, e.g. in an autocommand.  Example: >
---- :function s:check_typoname(file)
---- :   if fnamemodify(a:file, ':t') == '['
---- :       echomsg 'Maybe typo'
---- :       call interrupt()
---- :   endif
---- :endfunction
---- :au BufWritePre * call s:check_typoname(expand('<amatch>'))
+--- from lower down, e.g. in an autocommand.  Example: >vim
+--- function s:check_typoname(file)
+---    if fnamemodify(a:file, ':t') == '['
+---        echomsg 'Maybe typo'
+---        call interrupt()
+---    endif
+--- endfunction
+--- au BufWritePre * call s:check_typoname(expand('<amatch>'))
+--- <
 ---
 --- @return any
 function vim.fn.interrupt() end
 
 --- Bitwise invert.  The argument is converted to a number.  A
---- List, Dict or Float argument causes an error.  Example: >
----   :let bits = invert(bits)
---- <Can also be used as a |method|: >
----   :let bits = bits->invert()
+--- List, Dict or Float argument causes an error.  Example: >vim
+---   let bits = invert(bits)
+--- <Can also be used as a |method|: >vim
+---   let bits = bits->invert()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -4850,22 +4966,24 @@ function vim.fn.invert(expr) end
 --- exist, or isn't a directory, the result is |FALSE|.  {directory}
 --- is any expression, which is used as a String.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->isdirectory()
+--- <
 ---
 --- @param directory any
 --- @return 0|1
 function vim.fn.isdirectory(directory) end
 
 --- Return 1 if {expr} is a positive infinity, or -1 a negative
---- infinity, otherwise 0. >
----   :echo isinf(1.0 / 0.0)
---- <  1 >
----   :echo isinf(-1.0 / 0.0)
+--- infinity, otherwise 0. >vim
+---   echo isinf(1.0 / 0.0)
+--- <  1 >vim
+---   echo isinf(-1.0 / 0.0)
 --- <  -1
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->isinf()
+--- <
 ---
 --- @param expr any
 --- @return 1|0|-1
@@ -4875,28 +4993,30 @@ function vim.fn.isinf(expr) end
 --- name of a locked variable.
 --- The string argument {expr} must be the name of a variable,
 --- |List| item or |Dictionary| entry, not the variable itself!
---- Example: >
----   :let alist = [0, ['a', 'b'], 2, 3]
----   :lockvar 1 alist
----   :echo islocked('alist')    " 1
----   :echo islocked('alist[1]')  " 0
+--- Example: >vim
+---   let alist = [0, ['a', 'b'], 2, 3]
+---   lockvar 1 alist
+---   echo islocked('alist')    " 1
+---   echo islocked('alist[1]')  " 0
 ---
 --- <When {expr} is a variable that does not exist you get an error
 --- message.  Use |exists()| to check for existence.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->islocked()
+--- <
 ---
 --- @param expr any
 --- @return 0|1
 function vim.fn.islocked(expr) end
 
---- Return |TRUE| if {expr} is a float with value NaN. >
+--- Return |TRUE| if {expr} is a float with value NaN. >vim
 ---   echo isnan(0.0 / 0.0)
 --- <  1
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->isnan()
+--- <
 ---
 --- @param expr any
 --- @return 0|1
@@ -4906,13 +5026,14 @@ function vim.fn.isnan(expr) end
 --- |List| item is a list with two items: the key of a {dict}
 --- entry and the value of this entry.  The |List| is in arbitrary
 --- order.  Also see |keys()| and |values()|.
---- Example: >
+--- Example: >vim
 ---   for [key, value] in items(mydict)
 ---      echo key .. ': ' .. value
 ---   endfor
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   mydict->items()
+--- <
 ---
 --- @param dict any
 --- @return any
@@ -4952,12 +5073,12 @@ function vim.fn.jobsend(...) end
 ---
 --- Spawns {cmd} as a job.
 --- If {cmd} is a List it runs directly (no 'shell').
---- If {cmd} is a String it runs in the 'shell', like this: >
----   :call jobstart(split(&shell) + split(&shellcmdflag) + ['{cmd}'])
+--- If {cmd} is a String it runs in the 'shell', like this: >vim
+---   call jobstart(split(&shell) + split(&shellcmdflag) + ['{cmd}'])
 --- <(See |shell-unquoting| for details.)
 ---
---- Example: >
----   :call jobstart('nvim -h', {'on_stdout':{j,d,e->append(line('.'),d)}})
+--- Example: >vim
+---   call jobstart('nvim -h', {'on_stdout':{j,d,e->append(line('.'),d)}})
 --- <
 --- Returns |job-id| on success, 0 on invalid arguments (or job
 --- table is full), -1 if {cmd}[0] or 'shell' is not executable.
@@ -4970,10 +5091,10 @@ function vim.fn.jobsend(...) end
 ---
 --- NOTE: on Windows if {cmd} is a List:
 ---   - cmd[0] must be an executable (not a "built-in"). If it is
----     in $PATH it can be called by name, without an extension: >
----       :call jobstart(['ping', 'neovim.io'])
---- <    If it is a full or partial path, extension is required: >
----       :call jobstart(['System32\ping.exe', 'neovim.io'])
+---     in $PATH it can be called by name, without an extension: >vim
+---       call jobstart(['ping', 'neovim.io'])
+--- <    If it is a full or partial path, extension is required: >vim
+---       call jobstart(['System32\ping.exe', 'neovim.io'])
 --- <  - {cmd} is collapsed to a string of quoted args as expected
 ---     by CommandLineToArgvW https://msdn.microsoft.com/bb776391
 ---     unless cmd[0] is some form of "cmd.exe".
@@ -5057,7 +5178,7 @@ function vim.fn.jobstop(id) end
 --- {timeout} is the maximum waiting time in milliseconds. If
 --- omitted or -1, wait forever.
 ---
---- Timeout of 0 can be used to check the status of a job: >
+--- Timeout of 0 can be used to check the status of a job: >vim
 ---   let running = jobwait([{job-id}], 0)[0] == -1
 --- <
 --- During jobwait() callbacks for jobs not in the {jobs} list may
@@ -5080,14 +5201,15 @@ function vim.fn.jobwait(jobs, timeout) end
 --- When {sep} is specified it is put in between the items.  If
 --- {sep} is omitted a single space is used.
 --- Note that {sep} is not added at the end.  You might want to
---- add it there too: >
+--- add it there too: >vim
 ---   let lines = join(mylist, "\n") .. "\n"
 --- <String items are used as-is.  |Lists| and |Dictionaries| are
 --- converted into a string like with |string()|.
 --- The opposite function is |split()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->join()
+--- <
 ---
 --- @param list any
 --- @param sep? any
@@ -5109,8 +5231,9 @@ function vim.fn.join(list, sep) end
 --- recommended and the only one required to be supported.
 --- Non-UTF-8 characters are an error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   ReadObject()->json_decode()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -5127,8 +5250,9 @@ function vim.fn.json_decode(expr) end
 --- or special escapes like "\t", other are dumped as-is.
 --- |Blob|s are converted to arrays of the individual bytes.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetObject()->json_encode()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -5137,20 +5261,21 @@ function vim.fn.json_encode(expr) end
 --- Return a |List| with all the keys of {dict}.  The |List| is in
 --- arbitrary order.  Also see |items()| and |values()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mydict->keys()
+--- <
 ---
 --- @param dict any
 --- @return any
 function vim.fn.keys(dict) end
 
 --- Turn the internal byte representation of keys into a form that
---- can be used for |:map|.  E.g. >
----   :let xx = "\<C-Home>"
----   :echo keytrans(xx)
+--- can be used for |:map|.  E.g. >vim
+---   let xx = "\<C-Home>"
+---   echo keytrans(xx)
 --- <  <C-Home>
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   "\<C-Home>"->keytrans()
 --- <
 ---
@@ -5173,7 +5298,7 @@ function vim.fn.last_buffer_nr() end
 --- |Dictionary| is returned.
 --- Otherwise an error is given and returns zero.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->len()
 --- <
 ---
@@ -5219,11 +5344,11 @@ function vim.fn.len(expr) end
 --- the DLL is not in the usual places.
 --- For Unix: When compiling your own plugins, remember that the
 --- object code must be compiled as position-independent ('PIC').
---- Examples: >
----   :echo libcall("libc.so", "getenv", "HOME")
+--- Examples: >vim
+---   echo libcall("libc.so", "getenv", "HOME")
 ---
 --- <Can also be used as a |method|, the base is passed as the
---- third argument: >
+--- third argument: >vim
 ---   GetValue()->libcall("libc.so", "getenv")
 --- <
 ---
@@ -5235,13 +5360,13 @@ function vim.fn.libcall(libname, funcname, argument) end
 
 --- Just like |libcall()|, but used for a function that returns an
 --- int instead of a string.
---- Examples: >
----   :echo libcallnr("/usr/lib/libc.so", "getpid", "")
----   :call libcallnr("libc.so", "printf", "Hello World!\n")
----   :call libcallnr("libc.so", "sleep", 10)
+--- Examples: >vim
+---   echo libcallnr("/usr/lib/libc.so", "getpid", "")
+---   call libcallnr("libc.so", "printf", "Hello World!\n")
+---   call libcallnr("libc.so", "sleep", 10)
 --- <
 --- Can also be used as a |method|, the base is passed as the
---- third argument: >
+--- third argument: >vim
 ---   GetValue()->libcallnr("libc.so", "printf")
 --- <
 ---
@@ -5273,17 +5398,18 @@ function vim.fn.libcallnr(libname, funcname, argument) end
 --- With the optional {winid} argument the values are obtained for
 --- that window instead of the current window.
 --- Returns 0 for invalid values of {expr} and {winid}.
---- Examples: >
----   line(".")    line number of the cursor
----   line(".", winid)  idem, in window "winid"
----   line("'t")    line number of mark t
----   line("'" .. marker)  line number of mark marker
+--- Examples: >vim
+---   echo line(".")    " line number of the cursor
+---   echo line(".", winid)  " idem, in window "winid"
+---   echo line("'t")    " line number of mark t
+---   echo line("'" .. marker)  " line number of mark marker
 --- <
 --- To jump to the last known position when opening a file see
 --- |last-position-jump|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetValue()->line()
+--- <
 ---
 --- @param expr any
 --- @param winid? integer
@@ -5295,15 +5421,16 @@ function vim.fn.line(expr, winid) end
 --- the 'fileformat' option for the current buffer.  The first
 --- line returns 1. UTF-8 encoding is used, 'fileencoding' is
 --- ignored.  This can also be used to get the byte count for the
---- line just below the last line: >
----   line2byte(line("$") + 1)
+--- line just below the last line: >vim
+---   echo line2byte(line("$") + 1)
 --- <This is the buffer size plus one.  If 'fileencoding' is empty
 --- it is the file size plus one.  {lnum} is used like with
 --- |getline()|.  When {lnum} is invalid -1 is returned.
 --- Also see |byte2line()|, |go| and |:goto|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->line2byte()
+--- <
 ---
 --- @param lnum integer
 --- @return integer
@@ -5315,46 +5442,49 @@ function vim.fn.line2byte(lnum) end
 --- relevant.  {lnum} is used just like in |getline()|.
 --- When {lnum} is invalid, -1 is returned.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->lispindent()
+--- <
 ---
 --- @param lnum integer
 --- @return any
 function vim.fn.lispindent(lnum) end
 
 --- Return a Blob concatenating all the number values in {list}.
---- Examples: >
----   list2blob([1, 2, 3, 4])  returns 0z01020304
----   list2blob([])    returns 0z
+--- Examples: >vim
+---   echo list2blob([1, 2, 3, 4])  " returns 0z01020304
+---   echo list2blob([])    " returns 0z
 --- <Returns an empty Blob on error.  If one of the numbers is
 --- negative or more than 255 error *E1239* is given.
 ---
 --- |blob2list()| does the opposite.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetList()->list2blob()
+--- <
 ---
 --- @param list any
 --- @return any
 function vim.fn.list2blob(list) end
 
 --- Convert each number in {list} to a character string can
---- concatenate them all.  Examples: >
----   list2str([32])    returns " "
----   list2str([65, 66, 67])  returns "ABC"
---- <The same can be done (slowly) with: >
----   join(map(list, {nr, val -> nr2char(val)}), '')
+--- concatenate them all.  Examples: >vim
+---   echo list2str([32])    " returns " "
+---   echo list2str([65, 66, 67])  " returns "ABC"
+--- <The same can be done (slowly) with: >vim
+---   echo join(map(list, {nr, val -> nr2char(val)}), '')
 --- <|str2list()| does the opposite.
 ---
 --- UTF-8 encoding is always used, {utf8} option has no effect,
 --- and exists only for backwards-compatibility.
---- With UTF-8 composing characters work as expected: >
----   list2str([97, 769])  returns "á"
+--- With UTF-8 composing characters work as expected: >vim
+---   echo list2str([97, 769])  " returns "á"
 --- <
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetList()->list2str()
+--- <
 ---
 --- @param list any
 --- @param utf8? any
@@ -5371,14 +5501,15 @@ function vim.fn.localtime() end
 --- {expr} must evaluate to a |Float| or a |Number| in the range
 --- (0, inf].
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo log(10)
---- <  2.302585 >
----   :echo log(exp(5))
+--- Examples: >vim
+---   echo log(10)
+--- <  2.302585 >vim
+---   echo log(exp(5))
 --- <  5.0
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->log()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -5387,14 +5518,15 @@ function vim.fn.log(expr) end
 --- Return the logarithm of Float {expr} to base 10 as a |Float|.
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo log10(1000)
---- <  3.0 >
----   :echo log10(0.01)
+--- Examples: >vim
+---   echo log10(1000)
+--- <  3.0 >vim
+---   echo log10(0.01)
 --- <  -2.0
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->log10()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -5411,8 +5543,8 @@ function vim.fn.log10(expr) end
 --- of the current item and for a |List| |v:key| has the index of
 --- the current item.  For a |Blob| |v:key| has the index of the
 --- current byte.
---- Example: >
----   :call map(mylist, '"> " .. v:val .. " <"')
+--- Example: >vim
+---   call map(mylist, '"> " .. v:val .. " <"')
 --- <This puts "> " before and " <" after each item in "mylist".
 ---
 --- Note that {expr2} is the result of an expression and is then
@@ -5424,21 +5556,21 @@ function vim.fn.log10(expr) end
 ---   1. The key or the index of the current item.
 ---   2. the value of the current item.
 --- The function must return the new value of the item. Example
---- that changes each value by "key-value": >
+--- that changes each value by "key-value": >vim
 ---   func KeyValue(key, val)
 ---     return a:key .. '-' .. a:val
 ---   endfunc
 ---   call map(myDict, function('KeyValue'))
---- <It is shorter when using a |lambda|: >
+--- <It is shorter when using a |lambda|: >vim
 ---   call map(myDict, {key, val -> key .. '-' .. val})
---- <If you do not use "val" you can leave it out: >
+--- <If you do not use "val" you can leave it out: >vim
 ---   call map(myDict, {key -> 'item: ' .. key})
---- <If you do not use "key" you can use a short name: >
+--- <If you do not use "key" you can use a short name: >vim
 ---   call map(myDict, {_, val -> 'item: ' .. val})
 --- <
 --- The operation is done in-place.  If you want a |List| or
---- |Dictionary| to remain unmodified make a copy first: >
----   :let tlist = map(copy(mylist), ' v:val .. "\t"')
+--- |Dictionary| to remain unmodified make a copy first: >vim
+---   let tlist = map(copy(mylist), ' v:val .. "\t"')
 ---
 --- <Returns {expr1}, the |List|, |Blob| or |Dictionary| that was
 --- filtered.  When an error is encountered while evaluating
@@ -5446,7 +5578,7 @@ function vim.fn.log10(expr) end
 --- {expr2} is a Funcref errors inside a function are ignored,
 --- unless it was defined with the "abort" flag.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->map(expr2)
 --- <
 ---
@@ -5515,11 +5647,12 @@ function vim.fn.map(expr1, expr2) end
 --- The mappings local to the current buffer are checked first,
 --- then the global mappings.
 --- This function can be used to map a key even when it's already
---- mapped, and have it do the original mapping too.  Sketch: >
+--- mapped, and have it do the original mapping too.  Sketch: >vim
 ---   exe 'nnoremap <Tab> ==' .. maparg('<Tab>', 'n')
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetKey()->maparg('n')
+--- <
 ---
 --- @param name string
 --- @param mode? string
@@ -5553,15 +5686,16 @@ function vim.fn.maparg(name, mode, abbr, dict) end
 --- The mappings local to the current buffer are checked first,
 --- then the global mappings.
 --- This function can be used to check if a mapping can be added
---- without being ambiguous.  Example: >
----   :if mapcheck("_vv") == ""
----   :   map _vv :set guifont=7x13<CR>
----   :endif
+--- without being ambiguous.  Example: >vim
+---   if mapcheck("_vv") == ""
+---      map _vv :set guifont=7x13<CR>
+---   endif
 --- <This avoids adding the "_vv" mapping when there already is a
 --- mapping for "_v" or for "_vvv".
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetKey()->mapcheck('n')
+--- <
 ---
 --- @param name string
 --- @param mode? string
@@ -5574,10 +5708,10 @@ function vim.fn.mapcheck(name, mode, abbr) end
 --- |maparg()|. *E460*
 --- {mode} is used to define the mode in which the mapping is set,
 --- not the "mode" entry in {dict}.
---- Example for saving and restoring a mapping: >
+--- Example for saving and restoring a mapping: >vim
 ---   let save_map = maparg('K', 'n', 0, 1)
 ---   nnoremap K somethingelse
----   ...
+---   " ...
 ---   call mapset('n', 0, save_map)
 --- <Note that if you are going to replace a map in several modes,
 --- e.g. with `:map!`, you need to save the mapping for all of
@@ -5601,27 +5735,27 @@ function vim.fn.mapset(mode, abbr, dict) end
 --- If there is no match -1 is returned.
 ---
 --- For getting submatches see |matchlist()|.
---- Example: >
----   :echo match("testing", "ing")  " results in 4
----   :echo match([1, 'x'], '\a')  " results in 1
+--- Example: >vim
+---   echo match("testing", "ing")  " results in 4
+---   echo match([1, 'x'], '\a')  " results in 1
 --- <See |string-match| for how {pat} is used.
 ---             *strpbrk()*
---- Vim doesn't have a strpbrk() function.  But you can do: >
----   :let sepidx = match(line, '[.,;: \t]')
+--- Vim doesn't have a strpbrk() function.  But you can do: >vim
+---   let sepidx = match(line, '[.,;: \t]')
 --- <            *strcasestr()*
 --- Vim doesn't have a strcasestr() function.  But you can add
---- "\c" to the pattern to ignore case: >
----   :let idx = match(haystack, '\cneedle')
+--- "\c" to the pattern to ignore case: >vim
+---   let idx = match(haystack, '\cneedle')
 --- <
 --- If {start} is given, the search starts from byte index
 --- {start} in a String or item {start} in a |List|.
 --- The result, however, is still the index counted from the
---- first character/item.  Example: >
----   :echo match("testing", "ing", 2)
---- <result is again "4". >
----   :echo match("testing", "ing", 4)
---- <result is again "4". >
----   :echo match("testing", "t", 2)
+--- first character/item.  Example: >vim
+---   echo match("testing", "ing", 2)
+--- <result is again "4". >vim
+---   echo match("testing", "ing", 4)
+--- <result is again "4". >vim
+---   echo match("testing", "t", 2)
 --- <result is "3".
 --- For a String, if {start} > 0 then it is like the string starts
 --- {start} bytes later, thus "^" will match at {start}.  Except
@@ -5635,7 +5769,7 @@ function vim.fn.mapset(mode, abbr, dict) end
 ---
 --- When {count} is given use the {count}th match.  When a match
 --- is found in a String the search for the next one starts one
---- character further.  Thus this example results in 1: >
+--- character further.  Thus this example results in 1: >vim
 ---   echo match("testing", "..", 0, 2)
 --- <In a |List| the search continues in the next item.
 --- Note that when {count} is added the way {start} works changes,
@@ -5650,7 +5784,7 @@ function vim.fn.mapset(mode, abbr, dict) end
 --- zero matches at the start instead of a number of matches
 --- further down in the text.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->match('word')
 ---   GetList()->match('word')
 --- <
@@ -5709,17 +5843,17 @@ function vim.fn.match(expr, pat, start, count) end
 ---
 --- Returns -1 on error.
 ---
---- Example: >
----   :highlight MyGroup ctermbg=green guibg=green
----   :let m = matchadd("MyGroup", "TODO")
---- <Deletion of the pattern: >
----   :call matchdelete(m)
+--- Example: >vim
+---   highlight MyGroup ctermbg=green guibg=green
+---   let m = matchadd("MyGroup", "TODO")
+--- <Deletion of the pattern: >vim
+---   call matchdelete(m)
 ---
 --- <A list of matches defined by |matchadd()| and |:match| are
 --- available from |getmatches()|.  All matches can be deleted in
 --- one operation by |clearmatches()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetGroup()->matchadd('TODO')
 --- <
 ---
@@ -5758,17 +5892,18 @@ function vim.fn.matchadd(group, pattern, priority, id, dict) end
 ---
 --- Returns -1 on error.
 ---
---- Example: >
----   :highlight MyGroup ctermbg=green guibg=green
----   :let m = matchaddpos("MyGroup", [[23, 24], 34])
---- <Deletion of the pattern: >
----   :call matchdelete(m)
+--- Example: >vim
+---   highlight MyGroup ctermbg=green guibg=green
+---   let m = matchaddpos("MyGroup", [[23, 24], 34])
+--- <Deletion of the pattern: >vim
+---   call matchdelete(m)
 ---
 --- <Matches added by |matchaddpos()| are returned by
 --- |getmatches()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetGroup()->matchaddpos([23, 11])
+--- <
 ---
 --- @param group any
 --- @param pos any
@@ -5789,8 +5924,9 @@ function vim.fn.matchaddpos(group, pos, priority, id, dict) end
 --- Highlighting matches using the |:match| commands are limited
 --- to three matches. |matchadd()| does not have this limitation.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetMatch()->matcharg()
+--- <
 ---
 --- @param nr integer
 --- @return any
@@ -5803,8 +5939,9 @@ function vim.fn.matcharg(nr) end
 --- If {win} is specified, use the window with this number or
 --- window ID instead of the current window.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetMatch()->matchdelete()
+--- <
 ---
 --- @param id any
 --- @param win? any
@@ -5812,25 +5949,26 @@ function vim.fn.matcharg(nr) end
 function vim.fn.matchdelete(id, win) end
 
 --- Same as |match()|, but return the index of first character
---- after the match.  Example: >
----   :echo matchend("testing", "ing")
+--- after the match.  Example: >vim
+---   echo matchend("testing", "ing")
 --- <results in "7".
 ---           *strspn()* *strcspn()*
 --- Vim doesn't have a strspn() or strcspn() function, but you can
---- do it with matchend(): >
----   :let span = matchend(line, '[a-zA-Z]')
----   :let span = matchend(line, '[^a-zA-Z]')
+--- do it with matchend(): >vim
+---   let span = matchend(line, '[a-zA-Z]')
+---   let span = matchend(line, '[^a-zA-Z]')
 --- <Except that -1 is returned when there are no matches.
 ---
---- The {start}, if given, has the same meaning as for |match()|. >
----   :echo matchend("testing", "ing", 2)
---- <results in "7". >
----   :echo matchend("testing", "ing", 5)
+--- The {start}, if given, has the same meaning as for |match()|. >vim
+---   echo matchend("testing", "ing", 2)
+--- <results in "7". >vim
+---   echo matchend("testing", "ing", 5)
 --- <result is "-1".
 --- When {expr} is a |List| the result is equal to |match()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->matchend('word')
+--- <
 ---
 --- @param expr any
 --- @param pat any
@@ -5879,25 +6017,25 @@ function vim.fn.matchend(expr, pat, start, count) end
 --- Refer to |fuzzy-matching| for more information about fuzzy
 --- matching strings.
 ---
---- Example: >
----    :echo matchfuzzy(["clay", "crow"], "cay")
---- <results in ["clay"]. >
----    :echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl")
---- <results in a list of buffer names fuzzy matching "ndl". >
----    :echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'})
+--- Example: >vim
+---    echo matchfuzzy(["clay", "crow"], "cay")
+--- <results in ["clay"]. >vim
+---    echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl")
+--- <results in a list of buffer names fuzzy matching "ndl". >vim
+---    echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'})
 --- <results in a list of buffer information dicts with buffer
---- names fuzzy matching "ndl". >
----    :echo getbufinfo()->matchfuzzy("spl",
+--- names fuzzy matching "ndl". >vim
+---    echo getbufinfo()->matchfuzzy("spl",
 ---         \ {'text_cb' : {v -> v.name}})
 --- <results in a list of buffer information dicts with buffer
---- names fuzzy matching "spl". >
----    :echo v:oldfiles->matchfuzzy("test")
---- <results in a list of file names fuzzy matching "test". >
----    :let l = readfile("buffer.c")->matchfuzzy("str")
---- <results in a list of lines in "buffer.c" fuzzy matching "str". >
----    :echo ['one two', 'two one']->matchfuzzy('two one')
---- <results in `['two one', 'one two']` . >
----    :echo ['one two', 'two one']->matchfuzzy('two one',
+--- names fuzzy matching "spl". >vim
+---    echo v:oldfiles->matchfuzzy("test")
+--- <results in a list of file names fuzzy matching "test". >vim
+---    let l = readfile("buffer.c")->matchfuzzy("str")
+--- <results in a list of lines in "buffer.c" fuzzy matching "str". >vim
+---    echo ['one two', 'two one']->matchfuzzy('two one')
+--- <results in `['two one', 'one two']` . >vim
+---    echo ['one two', 'two one']->matchfuzzy('two one',
 ---         \ {'matchseq': 1})
 --- <results in `['two one']`.
 ---
@@ -5919,12 +6057,12 @@ function vim.fn.matchfuzzy(list, str, dict) end
 --- If there are no matching strings or there is an error, then a
 --- list with three empty list items is returned.
 ---
---- Example: >
----   :echo matchfuzzypos(['testing'], 'tsg')
---- <results in [["testing"], [[0, 2, 6]], [99]] >
----   :echo matchfuzzypos(['clay', 'lacy'], 'la')
---- <results in [["lacy", "clay"], [[0, 1], [1, 2]], [153, 133]] >
----   :echo [{'text': 'hello', 'id' : 10}]
+--- Example: >vim
+---   echo matchfuzzypos(['testing'], 'tsg')
+--- <results in [["testing"], [[0, 2, 6]], [99]] >vim
+---   echo matchfuzzypos(['clay', 'lacy'], 'la')
+--- <results in [["lacy", "clay"], [[0, 1], [1, 2]], [153, 133]] >vim
+---   echo [{'text': 'hello', 'id' : 10}]
 ---     \ ->matchfuzzypos('ll', {'key' : 'text'})
 --- <results in `[[{"id": 10, "text": "hello"}], [[2, 3]], [127]]`
 ---
@@ -5938,15 +6076,16 @@ function vim.fn.matchfuzzypos(list, str, dict) end
 --- list is the matched string, same as what matchstr() would
 --- return.  Following items are submatches, like "\1", "\2", etc.
 --- in |:substitute|.  When an optional submatch didn't match an
---- empty string is used.  Example: >
+--- empty string is used.  Example: >vim
 ---   echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
 --- <Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
 --- When there is no match an empty list is returned.
 ---
 --- You can pass in a List, but that is not very useful.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->matchlist('word')
+--- <
 ---
 --- @param expr any
 --- @param pat any
@@ -5955,20 +6094,21 @@ function vim.fn.matchfuzzypos(list, str, dict) end
 --- @return any
 function vim.fn.matchlist(expr, pat, start, count) end
 
---- Same as |match()|, but return the matched string.  Example: >
----   :echo matchstr("testing", "ing")
+--- Same as |match()|, but return the matched string.  Example: >vim
+---   echo matchstr("testing", "ing")
 --- <results in "ing".
 --- When there is no match "" is returned.
---- The {start}, if given, has the same meaning as for |match()|. >
----   :echo matchstr("testing", "ing", 2)
---- <results in "ing". >
----   :echo matchstr("testing", "ing", 5)
+--- The {start}, if given, has the same meaning as for |match()|. >vim
+---   echo matchstr("testing", "ing", 2)
+--- <results in "ing". >vim
+---   echo matchstr("testing", "ing", 5)
 --- <result is "".
 --- When {expr} is a |List| then the matching item is returned.
 --- The type isn't changed, it's not necessarily a String.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->matchstr('word')
+--- <
 ---
 --- @param expr any
 --- @param pat any
@@ -5978,23 +6118,23 @@ function vim.fn.matchlist(expr, pat, start, count) end
 function vim.fn.matchstr(expr, pat, start, count) end
 
 --- Same as |matchstr()|, but return the matched string, the start
---- position and the end position of the match.  Example: >
----   :echo matchstrpos("testing", "ing")
+--- position and the end position of the match.  Example: >vim
+---   echo matchstrpos("testing", "ing")
 --- <results in ["ing", 4, 7].
 --- When there is no match ["", -1, -1] is returned.
---- The {start}, if given, has the same meaning as for |match()|. >
----   :echo matchstrpos("testing", "ing", 2)
---- <results in ["ing", 4, 7]. >
----   :echo matchstrpos("testing", "ing", 5)
+--- The {start}, if given, has the same meaning as for |match()|. >vim
+---   echo matchstrpos("testing", "ing", 2)
+--- <results in ["ing", 4, 7]. >vim
+---   echo matchstrpos("testing", "ing", 5)
 --- <result is ["", -1, -1].
 --- When {expr} is a |List| then the matching item, the index
 --- of first item where {pat} matches, the start position and the
---- end position of the match are returned. >
----   :echo matchstrpos([1, '__x'], '\a')
+--- end position of the match are returned. >vim
+---   echo matchstrpos([1, '__x'], '\a')
 --- <result is ["x", 1, 2, 3].
 --- The type isn't changed, it's not necessarily a String.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->matchstrpos('word')
 --- <
 ---
@@ -6005,7 +6145,7 @@ function vim.fn.matchstr(expr, pat, start, count) end
 --- @return any
 function vim.fn.matchstrpos(expr, pat, start, count) end
 
---- Return the maximum value of all items in {expr}. Example: >
+--- Return the maximum value of all items in {expr}. Example: >vim
 ---   echo max([apples, pears, oranges])
 ---
 --- <{expr} can be a |List| or a |Dictionary|.  For a Dictionary,
@@ -6014,7 +6154,7 @@ function vim.fn.matchstrpos(expr, pat, start, count) end
 --- items in {expr} cannot be used as a Number this results in
 ---                 an error.  An empty |List| or |Dictionary| results in zero.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->max()
 --- <
 ---
@@ -6026,14 +6166,14 @@ function vim.fn.max(expr) end
 --- by |:menu|, |:amenu|, …), including |hidden-menus|.
 ---
 --- {path} matches a menu by name, or all menus if {path} is an
---- empty string.  Example: >
----   :echo menu_get('File','')
----   :echo menu_get('')
+--- empty string.  Example: >vim
+---   echo menu_get('File','')
+---   echo menu_get('')
 --- <
 --- {modes} is a string of zero or more modes (see |maparg()| or
 --- |creating-menus| for the list of modes). "a" means "all".
 ---
---- Example: >
+--- Example: >vim
 ---   nnoremenu &Test.Test inormal
 ---   inoremenu Test.Test insert
 ---   vnoremenu Test.Test x
@@ -6123,9 +6263,9 @@ function vim.fn.menu_get(path, modes) end
 ---
 --- Returns an empty dictionary if the menu item is not found.
 ---
---- Examples: >
----   :echo menu_info('Edit.Cut')
----   :echo menu_info('File.Save', 'n')
+--- Examples: >vim
+---   echo menu_info('Edit.Cut')
+---   echo menu_info('File.Save', 'n')
 ---
 ---   " Display the entire menu hierarchy in a buffer
 ---   func ShowMenu(name, pfx)
@@ -6141,7 +6281,7 @@ function vim.fn.menu_get(path, modes) end
 ---     call ShowMenu(topmenu, '')
 ---   endfor
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetMenuName()->menu_info('v')
 --- <
 ---
@@ -6150,7 +6290,7 @@ function vim.fn.menu_get(path, modes) end
 --- @return any
 function vim.fn.menu_info(name, mode) end
 
---- Return the minimum value of all items in {expr}. Example: >
+--- Return the minimum value of all items in {expr}. Example: >vim
 ---   echo min([apples, pears, oranges])
 ---
 --- <{expr} can be a |List| or a |Dictionary|.  For a Dictionary,
@@ -6159,7 +6299,7 @@ function vim.fn.menu_info(name, mode) end
 --- items in {expr} cannot be used as a Number this results in
 --- an error.  An empty |List| or |Dictionary| results in zero.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->min()
 --- <
 ---
@@ -6176,19 +6316,19 @@ function vim.fn.min(expr) end
 --- created as necessary.
 ---
 --- If {flags} contains "D" then {name} is deleted at the end of
---- the current function, as with: >
+--- the current function, as with: >vim
 ---   defer delete({name}, 'd')
 --- <
 --- If {flags} contains "R" then {name} is deleted recursively at
---- the end of the current function, as with: >
+--- the end of the current function, as with: >vim
 ---   defer delete({name}, 'rf')
 --- <Note that when {name} has more than one part and "p" is used
 --- some directories may already exist.  Only the first one that
 --- is created and what it contains is scheduled to be deleted.
---- E.g. when using: >
+--- E.g. when using: >vim
 ---   call mkdir('subdir/tmp/autoload', 'pR')
 --- <and "subdir" already exists then "subdir/tmp" will be
---- scheduled for deletion, like with: >
+--- scheduled for deletion, like with: >vim
 ---   defer delete('subdir/tmp', 'rf')
 --- <
 --- If {prot} is given it is used to set the protection bits of
@@ -6197,8 +6337,8 @@ function vim.fn.min(expr) end
 --- unreadable for others.
 ---
 --- {prot} is applied for all parts of {name}.  Thus if you create
---- /tmp/foo/bar then /tmp/foo will be created with 0o700. Example: >
----   :call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700)
+--- /tmp/foo/bar then /tmp/foo will be created with 0o700. Example: >vim
+---   call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700)
 ---
 --- <This function is not available in the |sandbox|.
 ---
@@ -6209,7 +6349,7 @@ function vim.fn.min(expr) end
 --- successful or FALSE if the directory creation failed or partly
 --- failed.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->mkdir()
 --- <
 ---
@@ -6269,17 +6409,18 @@ function vim.fn.mkdir(name, flags, prot) end
 --- the leading character(s).
 --- Also see |visualmode()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   DoFull()->mode()
+--- <
 ---
 --- @return any
 function vim.fn.mode() end
 
 --- Convert a list of Vimscript objects to msgpack. Returned value is a
 --- |readfile()|-style list. When {type} contains "B", a |Blob| is
---- returned instead. Example: >
+--- returned instead. Example: >vim
 ---   call writefile(msgpackdump([{}]), 'fname.mpack', 'b')
---- <or, using a |Blob|: >
+--- <or, using a |Blob|: >vim
 ---   call writefile(msgpackdump([{}], 'B'), 'fname.mpack')
 --- <
 --- This will write the single 0x80 byte to a `fname.mpack` file
@@ -6300,7 +6441,7 @@ function vim.fn.msgpackdump(list, type) end
 
 --- Convert a |readfile()|-style list or a |Blob| to a list of
 --- Vimscript objects.
---- Example: >
+--- Example: >vim
 ---   let fname = expand('~/.config/nvim/shada/main.shada')
 ---   let mpack = readfile(fname, 'b')
 ---   let shada_objects = msgpackparse(mpack)
@@ -6376,34 +6517,36 @@ function vim.fn.msgpackdump(list, type) end
 function vim.fn.msgpackparse(data) end
 
 --- Return the line number of the first line at or below {lnum}
---- that is not blank.  Example: >
----   if getline(nextnonblank(1)) =~ "Java"
+--- that is not blank.  Example: >vim
+---   if getline(nextnonblank(1)) =~ "Java" | endif
 --- <When {lnum} is invalid or there is no non-blank line at or
 --- below it, zero is returned.
 --- {lnum} is used like with |getline()|.
 --- See also |prevnonblank()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->nextnonblank()
+--- <
 ---
 --- @param lnum integer
 --- @return any
 function vim.fn.nextnonblank(lnum) end
 
 --- Return a string with a single character, which has the number
---- value {expr}.  Examples: >
----   nr2char(64)    returns "\@"
----   nr2char(32)    returns " "
---- <Example for "utf-8": >
----   nr2char(300)    returns I with bow character
---- <UTF-8 encoding is always used, {utf8} option has no effect,
+--- value {expr}.  Examples: >vim
+---   echo nr2char(64)    " returns '\@'
+---   echo nr2char(32)    " returns ' '
+--- <Example for "utf-8": >vim
+---   echo nr2char(300)    " returns I with bow character
+--- <
+--- UTF-8 encoding is always used, {utf8} option has no effect,
 --- and exists only for backwards-compatibility.
 --- Note that a NUL character in the file is specified with
 --- nr2char(10), because NULs are represented with newline
 --- characters.  nr2char(0) is a real NUL and terminates the
 --- string, thus results in an empty string.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetNumber()->nr2char()
 --- <
 ---
@@ -6415,10 +6558,10 @@ function vim.fn.nr2char(expr, utf8) end
 --- Bitwise OR on the two arguments.  The arguments are converted
 --- to a number.  A List, Dict or Float argument causes an error.
 --- Also see `and()` and `xor()`.
---- Example: >
----   :let bits = or(bits, 0x80)
---- <Can also be used as a |method|: >
----   :let bits = bits->or(0x80)
+--- Example: >vim
+---   let bits = or(bits, 0x80)
+--- <Can also be used as a |method|: >vim
+---   let bits = bits->or(0x80)
 ---
 --- <Rationale: The reason this is a function and not using the "|"
 --- character like many languages, is that Vi has always used "|"
@@ -6434,17 +6577,18 @@ vim.fn['or'] = function(expr, expr1) end
 --- result.  The tail, the file name, is kept as-is.  The other
 --- components in the path are reduced to {len} letters in length.
 --- If {len} is omitted or smaller than 1 then 1 is used (single
---- letters).  Leading '~' and '.' characters are kept.  Examples: >
----   :echo pathshorten('~/.config/nvim/autoload/file1.vim')
+--- letters).  Leading '~' and '.' characters are kept.  Examples: >vim
+---   echo pathshorten('~/.config/nvim/autoload/file1.vim')
 --- <  ~/.c/n/a/file1.vim ~
---- >
----   :echo pathshorten('~/.config/nvim/autoload/file2.vim', 2)
+--- >vim
+---   echo pathshorten('~/.config/nvim/autoload/file2.vim', 2)
 --- <  ~/.co/nv/au/file2.vim ~
 --- It doesn't matter if the path exists or not.
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetDirectories()->pathshorten()
+--- <
 ---
 --- @param path string
 --- @param len? any
@@ -6461,12 +6605,13 @@ function vim.fn.pathshorten(path, len) end
 ---
 --- Note: If you want an array or hash, {expr} must return a
 --- reference to it.
---- Example: >
----   :echo perleval('[1 .. 4]')
+--- Example: >vim
+---   echo perleval('[1 .. 4]')
 --- <  [1, 2, 3, 4]
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetExpr()->perleval()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -6475,16 +6620,17 @@ function vim.fn.perleval(expr) end
 --- Return the power of {x} to the exponent {y} as a |Float|.
 --- {x} and {y} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {x} or {y} is not a |Float| or a |Number|.
---- Examples: >
----   :echo pow(3, 3)
---- <  27.0 >
----   :echo pow(2, 16)
---- <  65536.0 >
----   :echo pow(32, 0.20)
+--- Examples: >vim
+---   echo pow(3, 3)
+--- <  27.0 >vim
+---   echo pow(2, 16)
+--- <  65536.0 >vim
+---   echo pow(32, 0.20)
 --- <  2.0
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->pow(3)
+--- <
 ---
 --- @param x any
 --- @param y any
@@ -6492,28 +6638,29 @@ function vim.fn.perleval(expr) end
 function vim.fn.pow(x, y) end
 
 --- Return the line number of the first line at or above {lnum}
---- that is not blank.  Example: >
+--- that is not blank.  Example: >vim
 ---   let ind = indent(prevnonblank(v:lnum - 1))
 --- <When {lnum} is invalid or there is no non-blank line at or
 --- above it, zero is returned.
 --- {lnum} is used like with |getline()|.
 --- Also see |nextnonblank()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetLnum()->prevnonblank()
+--- <
 ---
 --- @param lnum integer
 --- @return any
 function vim.fn.prevnonblank(lnum) end
 
 --- Return a String with {fmt}, where "%" items are replaced by
---- the formatted form of their respective arguments.  Example: >
----   printf("%4d: E%d %.30s", lnum, errno, msg)
+--- the formatted form of their respective arguments.  Example: >vim
+---   echo printf("%4d: E%d %.30s", lnum, errno, msg)
 --- <May result in:
 ---   "  99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
 ---
 --- When used as a |method| the base is passed as the second
---- argument: >
+--- argument: >vim
 ---   Compute()->printf("result: %d")
 --- <
 --- You can use `call()` to pass the items as a list.
@@ -6613,8 +6760,8 @@ function vim.fn.prevnonblank(lnum) end
 --- Number argument supplies the field width or precision.  A
 --- negative field width is treated as a left adjustment flag
 --- followed by a positive field width; a negative precision is
---- treated as though it were missing.  Example: >
----   :echo printf("%d: %.*s", nr, width, line)
+--- treated as though it were missing.  Example: >vim
+---   echo printf("%d: %.*s", nr, width, line)
 --- <This limits the length of the text used from "line" to
 --- "width" bytes.
 ---
@@ -6669,7 +6816,7 @@ function vim.fn.prevnonblank(lnum) end
 ---   (out of range or dividing by zero) results in "inf"
 ---    or "-inf" with %f (INF or -INF with %F).
 ---    "0.0 / 0.0" results in "nan" with %f (NAN with %F).
----   Example: >
+---   Example: >vim
 ---     echo printf("%.2f", 12.115)
 --- <    12.12
 ---   Note that roundoff depends on the system libraries.
@@ -6716,8 +6863,9 @@ function vim.fn.printf(fmt, expr1) end
 --- If the buffer doesn't exist or isn't a prompt buffer, an empty
 --- string is returned.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetBuffer()->prompt_getprompt()
+--- <
 ---
 --- @param buf any
 --- @return any
@@ -6738,7 +6886,7 @@ function vim.fn.prompt_getprompt(buf) end
 --- The callback is invoked with one argument, which is the text
 --- that was entered at the prompt.  This can be an empty string
 --- if the user only typed Enter.
---- Example: >
+--- Example: >vim
 ---    func s:TextEntered(text)
 ---      if a:text == 'exit' || a:text == 'quit'
 ---        stopinsert
@@ -6754,8 +6902,9 @@ function vim.fn.prompt_getprompt(buf) end
 ---    endfunc
 ---    call prompt_setcallback(bufnr(), function('s:TextEntered'))
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetBuffer()->prompt_setcallback(callback)
+--- <
 ---
 --- @param buf any
 --- @param expr any
@@ -6770,8 +6919,9 @@ function vim.fn.prompt_setcallback(buf, expr) end
 --- mode.  Without setting a callback Vim will exit Insert mode,
 --- as in any buffer.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetBuffer()->prompt_setinterrupt(callback)
+--- <
 ---
 --- @param buf any
 --- @param expr any
@@ -6781,11 +6931,12 @@ function vim.fn.prompt_setinterrupt(buf, expr) end
 --- Set prompt for buffer {buf} to {text}.  You most likely want
 --- {text} to end in a space.
 --- The result is only visible if {buf} has 'buftype' set to
---- "prompt".  Example: >
+--- "prompt".  Example: >vim
 ---   call prompt_setprompt(bufnr(''), 'command: ')
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetBuffer()->prompt_setprompt('command: ')
+--- <
 ---
 --- @param buf any
 --- @param text any
@@ -6824,7 +6975,7 @@ function vim.fn.pumvisible() end
 --- Dictionaries are represented as Vim |Dictionary| type with
 --- keys converted to strings.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetExpr()->py3eval()
 --- <
 ---
@@ -6840,8 +6991,9 @@ function vim.fn.py3eval(expr) end
 --- Dictionaries are represented as Vim |Dictionary| type,
 --- non-string keys result in error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetExpr()->pyeval()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -6852,7 +7004,7 @@ function vim.fn.pyeval(expr) end
 --- Uses Python 2 or 3, see |python_x| and 'pyxversion'.
 --- See also: |pyeval()|, |py3eval()|
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetExpr()->pyxeval()
 --- <
 ---
@@ -6868,13 +7020,13 @@ function vim.fn.pyxeval(expr) end
 --- and updated.
 --- Returns -1 if {expr} is invalid.
 ---
---- Examples: >
----   :echo rand()
----   :let seed = srand()
----   :echo rand(seed)
----   :echo rand(seed) % 16  " random number 0 - 15
+--- Examples: >vim
+---   echo rand()
+---   let seed = srand()
+---   echo rand(seed)
+---   echo rand(seed) % 16  " random number 0 - 15
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   seed->rand()
 --- <
 ---
@@ -6891,15 +7043,15 @@ function vim.fn.rand(expr) end
 --- When the maximum is one before the start the result is an
 --- empty list.  When the maximum is more than one before the
 --- start this is an error.
---- Examples: >
----   range(4)    " [0, 1, 2, 3]
----   range(2, 4)    " [2, 3, 4]
----   range(2, 9, 3)    " [2, 5, 8]
----   range(2, -2, -1)  " [2, 1, 0, -1, -2]
----   range(0)    " []
----   range(2, 0)    " error!
---- <
---- Can also be used as a |method|: >
+--- Examples: >vim
+---   echo range(4)    " [0, 1, 2, 3]
+---   echo range(2, 4)    " [2, 3, 4]
+---   echo range(2, 9, 3)    " [2, 5, 8]
+---   echo range(2, -2, -1)  " [2, 1, 0, -1, -2]
+---   echo range(0)    " []
+---   echo range(2, 0)    " error!
+--- <
+--- Can also be used as a |method|: >vim
 ---   GetExpr()->range()
 --- <
 ---
@@ -6912,18 +7064,18 @@ function vim.fn.range(expr, max, stride) end
 --- Read file {fname} in binary mode and return a |Blob|.
 --- If {offset} is specified, read the file from the specified
 --- offset.  If it is a negative value, it is used as an offset
---- from the end of the file.  E.g., to read the last 12 bytes: >
----   readblob('file.bin', -12)
+--- from the end of the file.  E.g., to read the last 12 bytes: >vim
+---   echo readblob('file.bin', -12)
 --- <If {size} is specified, only the specified size will be read.
---- E.g. to read the first 100 bytes of a file: >
----   readblob('file.bin', 0, 100)
+--- E.g. to read the first 100 bytes of a file: >vim
+---   echo readblob('file.bin', 0, 100)
 --- <If {size} is -1 or omitted, the whole data starting from
 --- {offset} will be read.
 --- This can be also used to read the data from a character device
 --- on Unix when {size} is explicitly set.  Only if the device
 --- supports seeking {offset} can be used.  Otherwise it should be
---- zero.  E.g. to read 10 bytes from a serial console: >
----   readblob('/dev/ttyS0', 0, 10)
+--- zero.  E.g. to read 10 bytes from a serial console: >vim
+---   echo readblob('/dev/ttyS0', 0, 10)
 --- <When the file can't be opened an error message is given and
 --- the result is an empty |Blob|.
 --- When the offset is beyond the end of the file the result is an
@@ -6952,12 +7104,12 @@ function vim.fn.readblob(fname, offset, size) end
 ---   to the list.
 --- Each time {expr} is evaluated |v:val| is set to the entry name.
 --- When {expr} is a function the name is passed as the argument.
---- For example, to get a list of files ending in ".txt": >
----   readdir(dirname, {n -> n =~ '.txt$'})
---- <To skip hidden and backup files: >
----   readdir(dirname, {n -> n !~ '^\.\|\~$'})
+--- For example, to get a list of files ending in ".txt": >vim
+---   echo readdir(dirname, {n -> n =~ '.txt$'})
+--- <To skip hidden and backup files: >vim
+---   echo readdir(dirname, {n -> n !~ '^\.\|\~$'})
 ---
---- <If you want to get a directory tree: >
+--- <If you want to get a directory tree: >vim
 ---   function! s:tree(dir)
 ---       return {a:dir : map(readdir(a:dir),
 ---       \ {_, x -> isdirectory(x) ?
@@ -6967,7 +7119,7 @@ function vim.fn.readblob(fname, offset, size) end
 --- <
 --- Returns an empty List on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetDirName()->readdir()
 --- <
 ---
@@ -6991,10 +7143,10 @@ function vim.fn.readdir(directory, expr) end
 --- - Any UTF-8 byte order mark is removed from the text.
 --- When {max} is given this specifies the maximum number of lines
 --- to be read.  Useful if you only want to check the first ten
---- lines of a file: >
----   :for line in readfile(fname, '', 10)
----   :  if line =~ 'Date' | echo line | endif
----   :endfor
+--- lines of a file: >vim
+---   for line in readfile(fname, '', 10)
+---     if line =~ 'Date' | echo line | endif
+---   endfor
 --- <When {max} is negative -{max} lines from the end of the file
 --- are returned, or as many as there are.
 --- When {max} is zero the result is an empty list.
@@ -7008,7 +7160,7 @@ function vim.fn.readdir(directory, expr) end
 --- the result is an empty list.
 --- Also see |writefile()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFileName()->readfile()
 --- <
 ---
@@ -7028,13 +7180,14 @@ function vim.fn.readfile(fname, type, max) end
 --- item.  If {initial} is not given and {object} is empty no
 --- result can be computed, an E998 error is given.
 ---
---- Examples: >
+--- Examples: >vim
 ---   echo reduce([1, 3, 5], { acc, val -> acc + val })
 ---   echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a')
 ---   echo reduce(0z1122, { acc, val -> 2 * acc + val })
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   echo mylist->reduce({ acc, val -> acc + val }, 0)
+--- <
 ---
 --- @param object any
 --- @param func any
@@ -7086,7 +7239,7 @@ function vim.fn.reltime(start) end
 --- The {start} and {end} arguments must be values returned by
 --- reltime().  Returns zero on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetStart()->reltime()
 --- <
 --- Note: |localtime()| returns the current (non-relative) time.
@@ -7106,8 +7259,9 @@ function vim.fn.reltime(start, end_) end
 --- Also see |profiling|.
 --- If there is an error an empty string is returned
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   reltime(start)->reltimefloat()
+--- <
 ---
 --- @param time any
 --- @return any
@@ -7115,19 +7269,19 @@ function vim.fn.reltimefloat(time) end
 
 --- Return a String that represents the time value of {time}.
 --- This is the number of seconds, a dot and the number of
---- microseconds.  Example: >
+--- microseconds.  Example: >vim
 ---   let start = reltime()
 ---   call MyFunction()
 ---   echo reltimestr(reltime(start))
 --- <Note that overhead for the commands will be added to the time.
 --- Leading spaces are used to make the string align nicely.  You
---- can use split() to remove it. >
+--- can use split() to remove it. >vim
 ---   echo split(reltimestr(reltime(start)))[0]
 --- <Also see |profiling|.
 --- If there is an error an empty string is returned
 ---
---- Can also be used as a |method|: >
----   reltime(start)->reltimestr()
+--- Can also be used as a |method|: >vim
+---   echo reltime(start)->reltimestr()
 --- <
 ---
 --- @param time any
@@ -7147,14 +7301,15 @@ function vim.fn.remove(list, idx) end
 --- points to an item before {idx} this is an error.
 --- See |list-index| for possible values of {idx} and {end}.
 --- Returns zero on error.
---- Example: >
----   :echo "last item: " .. remove(mylist, -1)
----   :call remove(mylist, 0, 9)
+--- Example: >vim
+---   echo "last item: " .. remove(mylist, -1)
+---   call remove(mylist, 0, 9)
 --- <
 --- Use |delete()| to remove a file.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->remove(idx)
+--- <
 ---
 --- @param list any
 --- @param idx integer
@@ -7174,9 +7329,10 @@ function vim.fn.remove(blob, idx) end
 --- byte as {end} a |Blob| with one byte is returned.  When {end}
 --- points to a byte before {idx} this is an error.
 --- Returns zero on error.
---- Example: >
----   :echo "last byte: " .. remove(myblob, -1)
----   :call remove(mylist, 0, 9)
+--- Example: >vim
+---   echo "last byte: " .. remove(myblob, -1)
+---   call remove(mylist, 0, 9)
+--- <
 ---
 --- @param blob any
 --- @param idx integer
@@ -7185,8 +7341,8 @@ function vim.fn.remove(blob, idx) end
 function vim.fn.remove(blob, idx, end_) end
 
 --- Remove the entry from {dict} with key {key} and return it.
---- Example: >
----   :echo "removed " .. remove(dict, "one")
+--- Example: >vim
+---   echo "removed " .. remove(dict, "one")
 --- <If there is no {key} in {dict} this is an error.
 --- Returns zero on error.
 ---
@@ -7202,8 +7358,9 @@ function vim.fn.remove(dict, key) end
 --- NOTE: If {to} exists it is overwritten without warning.
 --- This function is not available in the |sandbox|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetOldName()->rename(newname)
+--- <
 ---
 --- @param from any
 --- @param to any
@@ -7211,15 +7368,15 @@ function vim.fn.remove(dict, key) end
 function vim.fn.rename(from, to) end
 
 --- Repeat {expr} {count} times and return the concatenated
---- result.  Example: >
----   :let separator = repeat('-', 80)
+--- result.  Example: >vim
+---   let separator = repeat('-', 80)
 --- <When {count} is zero or negative the result is empty.
 --- When {expr} is a |List| or a |Blob| the result is {expr}
---- concatenated {count} times.  Example: >
----   :let longlist = repeat(['a', 'b'], 3)
+--- concatenated {count} times.  Example: >vim
+---   let longlist = repeat(['a', 'b'], 3)
 --- <Results in ['a', 'b', 'a', 'b', 'a', 'b'].
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->repeat(count)
 --- <
 ---
@@ -7240,7 +7397,7 @@ vim.fn['repeat'] = function(expr, count) end
 --- current directory (provided the result is still a relative
 --- path name) and also keeps a trailing path separator.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->resolve()
 --- <
 ---
@@ -7252,10 +7409,11 @@ function vim.fn.resolve(filename) end
 --- {object} can be a |List| or a |Blob|.
 --- Returns {object}.
 --- Returns zero if {object} is not a List or a Blob.
---- If you want an object to remain unmodified make a copy first: >
----   :let revlist = reverse(copy(mylist))
---- <Can also be used as a |method|: >
+--- If you want an object to remain unmodified make a copy first: >vim
+---   let revlist = reverse(copy(mylist))
+--- <Can also be used as a |method|: >vim
 ---   mylist->reverse()
+--- <
 ---
 --- @param object any
 --- @return any
@@ -7266,16 +7424,17 @@ function vim.fn.reverse(object) end
 --- values, then use the larger one (away from zero).
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
+--- Examples: >vim
 ---   echo round(0.456)
---- <  0.0  >
+--- <  0.0  >vim
 ---   echo round(4.5)
---- <  5.0 >
+--- <  5.0 >vim
 ---   echo round(-4.5)
 --- <  -5.0
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->round()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -7283,8 +7442,9 @@ function vim.fn.round(expr) end
 
 --- Sends {event} to {channel} via |RPC| and returns immediately.
 --- If {channel} is 0, the event is broadcast to all channels.
---- Example: >
----   :au VimLeave call rpcnotify(0, "leaving")
+--- Example: >vim
+---   au VimLeave call rpcnotify(0, "leaving")
+--- <
 ---
 --- @param channel any
 --- @param event any
@@ -7294,8 +7454,9 @@ function vim.fn.rpcnotify(channel, event, args) end
 
 --- Sends a request to {channel} to invoke {method} via
 --- |RPC| and blocks until a response is received.
---- Example: >
----   :let result = rpcrequest(rpc_chan, "func", 1, 2, 3)
+--- Example: >vim
+---   let result = rpcrequest(rpc_chan, "func", 1, 2, 3)
+--- <
 ---
 --- @param channel any
 --- @param method any
@@ -7303,10 +7464,11 @@ function vim.fn.rpcnotify(channel, event, args) end
 --- @return any
 function vim.fn.rpcrequest(channel, method, args) end
 
---- Deprecated. Replace  >
----   :let id = rpcstart('prog', ['arg1', 'arg2'])
---- <with >
----   :let id = jobstart(['prog', 'arg1', 'arg2'], {'rpc': v:true})
+--- Deprecated. Replace  >vim
+---   let id = rpcstart('prog', ['arg1', 'arg2'])
+--- <with >vim
+---   let id = jobstart(['prog', 'arg1', 'arg2'], {'rpc': v:true})
+--- <
 ---
 --- @param prog any
 --- @param argv? any
@@ -7332,8 +7494,9 @@ function vim.fn.rpcstop(...) end
 --- Other objects are represented as strings resulted from their
 --- "Object#to_s" method.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetRubyExpr()->rubyeval()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -7344,8 +7507,9 @@ function vim.fn.rubyeval(expr) end
 --- attribute at other positions.
 --- Returns -1 when row or col is out of range.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetRow()->screenattr(col)
+--- <
 ---
 --- @param row any
 --- @param col integer
@@ -7361,8 +7525,9 @@ function vim.fn.screenattr(row, col) end
 --- This is mainly to be used for testing.
 --- Returns -1 when row or col is out of range.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetRow()->screenchar(col)
+--- <
 ---
 --- @param row any
 --- @param col integer
@@ -7375,8 +7540,9 @@ function vim.fn.screenchar(row, col) end
 --- This is mainly to be used for testing.
 --- Returns an empty List when row or col is out of range.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetRow()->screenchars(col)
+--- <
 ---
 --- @param row any
 --- @param col integer
@@ -7391,7 +7557,7 @@ function vim.fn.screenchars(row, col) end
 --- in a command (e.g. ":echo screencol()") it will return the
 --- column inside the command line, which is 1 when the command is
 --- executed. To get the cursor position in the file use one of
---- the following mappings: >
+--- the following mappings: >vim
 ---   nnoremap <expr> GG ":echom " .. screencol() .. "\n"
 ---   nnoremap <silent> GG :echom screencol()<CR>
 ---   noremap GG <Cmd>echom screencol()<Cr>
@@ -7423,8 +7589,9 @@ function vim.fn.screencol() end
 --- first character is returned, {col} is not used.
 --- Returns an empty Dict if {winid} is invalid.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinid()->screenpos(lnum, col)
+--- <
 ---
 --- @param winid integer
 --- @param lnum integer
@@ -7449,7 +7616,7 @@ function vim.fn.screenrow() end
 --- This is mainly to be used for testing.
 --- Returns an empty String when row or col is out of range.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetRow()->screenstring(col)
 --- <
 ---
@@ -7498,7 +7665,7 @@ function vim.fn.screenstring(row, col) end
 ---
 --- When the {stopline} argument is given then the search stops
 --- after searching this line.  This is useful to restrict the
---- search to a range of lines.  Examples: >
+--- search to a range of lines.  Examples: >vim
 ---   let match = search('(', 'b', line("w0"))
 ---   let end = search('END', '', line("w$"))
 --- <When {stopline} is used and it is not zero this also implies
@@ -7529,24 +7696,24 @@ function vim.fn.screenstring(row, col) end
 --- The cursor will be positioned at the match, unless the 'n'
 --- flag is used.
 ---
---- Example (goes over all files in the argument list): >
----     :let n = 1
----     :while n <= argc()      " loop over all files in arglist
----     :  exe "argument " .. n
----     :  " start at the last char in the file and wrap for the
----     :  " first search to find match at start of file
----     :  normal G$
----     :  let flags = "w"
----     :  while search("foo", flags) > 0
----     :   s/foo/bar/g
----     :   let flags = "W"
----     :  endwhile
----     :  update        " write the file if modified
----     :  let n = n + 1
----     :endwhile
---- <
---- Example for using some flags: >
----     :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
+--- Example (goes over all files in the argument list): >vim
+---     let n = 1
+---     while n <= argc()      " loop over all files in arglist
+---       exe "argument " .. n
+---       " start at the last char in the file and wrap for the
+---       " first search to find match at start of file
+---       normal G$
+---       let flags = "w"
+---       while search("foo", flags) > 0
+---         s/foo/bar/g
+---         let flags = "W"
+---       endwhile
+---       update        " write the file if modified
+---       let n = n + 1
+---     endwhile
+--- <
+--- Example for using some flags: >vim
+---     echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
 --- <This will search for the keywords "if", "else", and "endif"
 --- under or after the cursor.  Because of the 'p' flag, it
 --- returns 1, 2, or 3 depending on which keyword is found, or 0
@@ -7558,8 +7725,9 @@ function vim.fn.screenstring(row, col) end
 --- without the 'e' flag if the cursor is on the "f" of "if".
 --- The 'n' flag tells the function not to move the cursor.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetPattern()->search()
+--- <
 ---
 --- @param pattern any
 --- @param flags? string
@@ -7593,7 +7761,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
 --- this function with `recompute: 0` . This sometimes returns
 --- wrong information because |n| and |N|'s maximum count is 99.
 --- If it exceeded 99 the result must be max count + 1 (100). If
---- you want to get correct information, specify `recompute: 1`: >
+--- you want to get correct information, specify `recompute: 1`: >vim
 ---
 ---   " result == maxcount + 1 (100) when many matches
 ---   let result = searchcount(#{recompute: 0})
@@ -7602,7 +7770,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
 ---   " to 1)
 ---   let result = searchcount()
 --- <
---- The function is useful to add the count to 'statusline': >
+--- The function is useful to add the count to 'statusline': >vim
 ---   function! LastSearchCount() abort
 ---     let result = searchcount(#{recompute: 0})
 ---     if empty(result)
@@ -7631,7 +7799,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
 ---   " \   '%{v:hlsearch ? LastSearchCount() : ""}'
 --- <
 --- You can also update the search count, which can be useful in a
---- |CursorMoved| or |CursorMovedI| autocommand: >
+--- |CursorMoved| or |CursorMovedI| autocommand: >vim
 ---
 ---   autocmd CursorMoved,CursorMovedI *
 ---     \ let s:searchcount_timer = timer_start(
@@ -7645,7 +7813,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
 ---   endfunction
 --- <
 --- This can also be used to count matched texts with specified
---- pattern in the current buffer using "pattern":  >
+--- pattern in the current buffer using "pattern":  >vim
 ---
 ---   " Count '\<foo\>' in this buffer
 ---   " (Note that it also updates search count)
@@ -7669,7 +7837,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
 ---         and different with |\@/|.
 ---         this works as same as the
 ---         below command is executed
----         before calling this function >
+---         before calling this function >vim
 ---           let \@/ = pattern
 --- <        (default: |\@/|)
 ---   timeout  |Number|  0 or negative number is no
@@ -7689,7 +7857,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
 ---         value. see |cursor()|, |getpos()|
 ---         (default: cursor's position)
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetSearchOpts()->searchcount()
 --- <
 ---
@@ -7709,12 +7877,12 @@ function vim.fn.searchcount(options) end
 ---
 --- Moves the cursor to the found match.
 --- Returns zero for success, non-zero for failure.
---- Example: >
+--- Example: >vim
 ---   if searchdecl('myvar') == 0
 ---      echo getline('.')
 ---   endif
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->searchdecl()
 --- <
 ---
@@ -7738,8 +7906,8 @@ function vim.fn.searchdecl(name, global, thisblock) end
 --- must not contain \( \) pairs.  Use of \%( \) is allowed.  When
 --- {middle} is not empty, it is found when searching from either
 --- direction, but only when not in a nested start-end pair.  A
---- typical use is: >
----   searchpair('\<if\>', '\<else\>', '\<endif\>')
+--- typical use is: >vim
+---   echo searchpair('\<if\>', '\<else\>', '\<endif\>')
 --- <By leaving {middle} empty the "else" is skipped.
 ---
 --- {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
@@ -7769,7 +7937,7 @@ function vim.fn.searchdecl(name, global, thisblock) end
 ---
 --- The search starts exactly at the cursor.  A match with
 --- {start}, {middle} or {end} at the next character, in the
---- direction of searching, is the first one found.  Example: >
+--- direction of searching, is the first one found.  Example: >vim
 ---   if 1
 ---     if 2
 ---     endif 2
@@ -7785,9 +7953,9 @@ function vim.fn.searchdecl(name, global, thisblock) end
 --- that when the cursor is inside a match with the end it finds
 --- the matching start.
 ---
---- Example, to find the "endif" command in a Vim script: >
+--- Example, to find the "endif" command in a Vim script: >vim
 ---
----   :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
+---   echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
 ---   \ 'getline(".") =~ "^\\s*\""')
 ---
 --- <The cursor must be at or after the "if" for which a match is
@@ -7796,15 +7964,15 @@ function vim.fn.searchdecl(name, global, thisblock) end
 --- catches comments at the start of a line, not after a command.
 --- Also, a word "en" or "if" halfway through a line is considered
 --- a match.
---- Another example, to search for the matching "{" of a "}": >
+--- Another example, to search for the matching "{" of a "}": >vim
 ---
----   :echo searchpair('{', '', '}', 'bW')
+---   echo searchpair('{', '', '}', 'bW')
 ---
 --- <This works when the cursor is at or before the "}" for which a
 --- match is to be found.  To reject matches that syntax
---- highlighting recognized as strings: >
+--- highlighting recognized as strings: >vim
 ---
----   :echo searchpair('{', '', '}', 'bW',
+---   echo searchpair('{', '', '}', 'bW',
 ---        \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
 --- <
 ---
@@ -7815,9 +7983,9 @@ function vim.fn.searchpair() end
 --- column position of the match. The first element of the |List|
 --- is the line number and the second element is the byte index of
 --- the column position of the match.  If no match is found,
---- returns [0, 0]. >
+--- returns [0, 0]. >vim
 ---
----   :let [lnum,col] = searchpairpos('{', '', '}', 'n')
+---   let [lnum,col] = searchpairpos('{', '', '}', 'n')
 --- <
 --- See |match-parens| for a bigger and more useful example.
 ---
@@ -7829,17 +7997,18 @@ function vim.fn.searchpairpos() end
 --- is the line number and the second element is the byte index of
 --- the column position of the match. If no match is found,
 --- returns [0, 0].
---- Example: >
----   :let [lnum, col] = searchpos('mypattern', 'n')
+--- Example: >vim
+---   let [lnum, col] = searchpos('mypattern', 'n')
 ---
 --- <When the 'p' flag is given then there is an extra item with
---- the sub-pattern match number |search()-sub-match|.  Example: >
----   :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
+--- the sub-pattern match number |search()-sub-match|.  Example: >vim
+---   let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
 --- <In this example "submatch" is 2 when a lowercase letter is
 --- found |/\l|, 3 when an uppercase letter is found |/\u|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetPattern()->searchpos()
+--- <
 ---
 --- @param pattern any
 --- @param flags? string
@@ -7851,8 +8020,9 @@ function vim.fn.searchpos(pattern, flags, stopline, timeout, skip) end
 
 --- Returns a list of server addresses, or empty if all servers
 --- were stopped. |serverstart()| |serverstop()|
---- Example: >
----   :echo serverlist()
+--- Example: >vim
+---   echo serverlist()
+--- <
 ---
 --- @return any
 function vim.fn.serverlist() end
@@ -7869,24 +8039,26 @@ function vim.fn.serverlist() end
 ---   assigns a random port).
 --- - Else {address} is the path to a named pipe (except on Windows).
 ---   - If {address} has no slashes ("/") it is treated as the
----     "name" part of a generated path in this format: >
+---     "name" part of a generated path in this format: >vim
 ---   stdpath("run").."/{name}.{pid}.{counter}"
---- <  - If {address} is omitted the name is "nvim". >
----   :echo serverstart()
+--- <  - If {address} is omitted the name is "nvim". >vim
+---   echo serverstart()
+--- < >
 ---   => /tmp/nvim.bram/oknANW/nvim.15430.5
----
---- <Example bash command to list all Nvim servers: >
+--- <
+--- Example bash command to list all Nvim servers: >bash
 ---   ls ${XDG_RUNTIME_DIR:-${TMPDIR}nvim.${USER}}/*/nvim.*.0
 ---
---- <Example named pipe: >
+--- <Example named pipe: >vim
 ---   if has('win32')
 ---     echo serverstart('\\.\pipe\nvim-pipe-1234')
 ---   else
 ---     echo serverstart('nvim.sock')
 ---   endif
 --- <
---- Example TCP/IP address: >
+--- Example TCP/IP address: >vim
 ---   echo serverstart('::1:12345')
+--- <
 ---
 --- @param address? any
 --- @return any
@@ -7925,8 +8097,9 @@ function vim.fn.serverstop(address) end
 --- error message is given.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- third argument: >
+--- third argument: >vim
 ---   GetText()->setbufline(buf, lnum)
+--- <
 ---
 --- @param buf any
 --- @param lnum integer
@@ -7942,13 +8115,13 @@ function vim.fn.setbufline(buf, lnum, text) end
 --- For the use of {buf}, see |bufname()| above.
 --- The {varname} argument is a string.
 --- Note that the variable name without "b:" must be used.
---- Examples: >
----   :call setbufvar(1, "&mod", 1)
----   :call setbufvar("todo", "myvar", "foobar")
+--- Examples: >vim
+---   call setbufvar(1, "&mod", 1)
+---   call setbufvar("todo", "myvar", "foobar")
 --- <This function is not available in the |sandbox|.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- third argument: >
+--- third argument: >vim
 ---   GetValue()->setbufvar(buf, varname)
 --- <
 ---
@@ -7961,7 +8134,7 @@ function vim.fn.setbufvar(buf, varname, val) end
 --- Specify overrides for cell widths of character ranges.  This
 --- tells Vim how wide characters are when displayed in the
 --- terminal, counted in screen cells.  The values override
---- 'ambiwidth'.  Example: >
+--- 'ambiwidth'.  Example: >vim
 ---    call setcellwidths([
 ---     \ [0x111, 0x111, 1],
 ---     \ [0x2194, 0x2199, 2],
@@ -7982,7 +8155,7 @@ function vim.fn.setbufvar(buf, varname, val) end
 --- If the new value causes 'fillchars' or 'listchars' to become
 --- invalid it is rejected and an error is given.
 ---
---- To clear the overrides pass an empty {list}: >
+--- To clear the overrides pass an empty {list}: >vim
 ---    call setcellwidths([])
 ---
 --- <You can use the script $VIMRUNTIME/tools/emoji_list.vim to see
@@ -7999,14 +8172,15 @@ function vim.fn.setcellwidths(list) end
 --- character index instead of the byte index in the line.
 ---
 --- Example:
---- With the text "여보세요" in line 8: >
+--- With the text "여보세요" in line 8: >vim
 ---   call setcharpos('.', [0, 8, 4, 0])
---- <positions the cursor on the fourth character '요'. >
+--- <positions the cursor on the fourth character '요'. >vim
 ---   call setpos('.', [0, 8, 4, 0])
 --- <positions the cursor on the second character '보'.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetPosition()->setcharpos('.')
+--- <
 ---
 --- @param expr any
 --- @param list any
@@ -8026,14 +8200,15 @@ function vim.fn.setcharpos(expr, list) end
 ---     character search
 ---
 --- This can be useful to save/restore a user's character search
---- from a script: >
----   :let prevsearch = getcharsearch()
----   :" Perform a command which clobbers user's search
----   :call setcharsearch(prevsearch)
+--- from a script: >vim
+---   let prevsearch = getcharsearch()
+---   " Perform a command which clobbers user's search
+---   call setcharsearch(prevsearch)
 --- <Also see |getcharsearch()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   SavedSearch()->setcharsearch()
+--- <
 ---
 --- @param dict any
 --- @return any
@@ -8045,8 +8220,9 @@ function vim.fn.setcharsearch(dict) end
 --- Returns 0 when successful, 1 when not editing the command
 --- line.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->setcmdline()
+--- <
 ---
 --- @param str any
 --- @param pos? any
@@ -8067,8 +8243,9 @@ function vim.fn.setcmdline(str, pos) end
 --- Returns 0 when successful, 1 when not editing the command
 --- line.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetPos()->setcmdpos()
+--- <
 ---
 --- @param pos any
 --- @return any
@@ -8084,27 +8261,28 @@ function vim.fn.setcursorcharpos(lnum, col, off) end
 --- character index instead of the byte index in the line.
 ---
 --- Example:
---- With the text "여보세요" in line 4: >
+--- With the text "여보세요" in line 4: >vim
 ---   call setcursorcharpos(4, 3)
---- <positions the cursor on the third character '세'. >
+--- <positions the cursor on the third character '세'. >vim
 ---   call cursor(4, 3)
 --- <positions the cursor on the first character '여'.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetCursorPos()->setcursorcharpos()
+--- <
 ---
 --- @param list any
 --- @return any
 function vim.fn.setcursorcharpos(list) end
 
---- Set environment variable {name} to {val}.  Example: >
+--- Set environment variable {name} to {val}.  Example: >vim
 ---   call setenv('HOME', '/home/myhome')
 ---
 --- <When {val} is |v:null| the environment variable is deleted.
 --- See also |expr-env|.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- second argument: >
+--- second argument: >vim
 ---   GetPath()->setenv('PATH')
 --- <
 ---
@@ -8127,7 +8305,7 @@ function vim.fn.setenv(name, val) end
 ---
 --- Returns non-zero for success, zero for failure.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFilename()->setfperm(mode)
 --- <
 --- To read permissions see |getfperm()|.
@@ -8150,22 +8328,23 @@ function vim.fn.setfperm(fname, mode) end
 --- If this succeeds, FALSE is returned.  If this fails (most likely
 --- because {lnum} is invalid) TRUE is returned.
 ---
---- Example: >
----   :call setline(5, strftime("%c"))
+--- Example: >vim
+---   call setline(5, strftime("%c"))
 ---
 --- <When {text} is a |List| then line {lnum} and following lines
---- will be set to the items in the list.  Example: >
----   :call setline(5, ['aaa', 'bbb', 'ccc'])
---- <This is equivalent to: >
----   :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
----   :  call setline(n, l)
----   :endfor
+--- will be set to the items in the list.  Example: >vim
+---   call setline(5, ['aaa', 'bbb', 'ccc'])
+--- <This is equivalent to: >vim
+---   for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
+---     call setline(n, l)
+---   endfor
 ---
 --- <Note: The '[ and '] marks are not set.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- second argument: >
+--- second argument: >vim
 ---   GetText()->setline(lnum)
+--- <
 ---
 --- @param lnum integer
 --- @param text any
@@ -8188,8 +8367,9 @@ function vim.fn.setline(lnum, text) end
 --- for the list of supported keys in {what}.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- second argument: >
+--- second argument: >vim
 ---   GetLoclist()->setloclist(winnr)
+--- <
 ---
 --- @param nr integer
 --- @param list any
@@ -8205,7 +8385,7 @@ function vim.fn.setloclist(nr, list, action, what) end
 --- If {win} is specified, use the window with this number or
 --- window ID instead of the current window.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetMatches()->setmatches()
 --- <
 ---
@@ -8262,8 +8442,9 @@ function vim.fn.setmatches(list, win) end
 --- also set the preferred column.  Also see the "curswant" key in
 --- |winrestview()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetPosition()->setpos('.')
+--- <
 ---
 --- @param expr any
 --- @param list any
@@ -8322,8 +8503,8 @@ function vim.fn.setpos(expr, list) end
 ---
 --- 'r'  The items from the current quickfix list are replaced
 ---   with the items from {list}.  This can also be used to
----   clear the list: >
----     :call setqflist([], 'r')
+---   clear the list: >vim
+---     call setqflist([], 'r')
 --- <
 --- 'f'  All the quickfix lists in the quickfix stack are
 ---   freed.
@@ -8369,10 +8550,10 @@ function vim.fn.setpos(expr, list) end
 --- list is modified, "id" should be used instead of "nr" to
 --- specify the list.
 ---
---- Examples (See also |setqflist-examples|): >
----    :call setqflist([], 'r', {'title': 'My search'})
----    :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
----    :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
+--- Examples (See also |setqflist-examples|): >vim
+---    call setqflist([], 'r', {'title': 'My search'})
+---    call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
+---    call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
 --- <
 --- Returns zero for success, -1 for failure.
 ---
@@ -8381,7 +8562,7 @@ function vim.fn.setpos(expr, list) end
 --- `:cc 1` to jump to the first position.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- second argument: >
+--- second argument: >vim
 ---   GetErrorlist()->setqflist()
 --- <
 ---
@@ -8422,33 +8603,34 @@ function vim.fn.setqflist(list, action, what) end
 ---       set search and expression registers. Lists containing no
 ---       items act like empty strings.
 ---
---- Examples: >
----   :call setreg(v:register, \@*)
----   :call setreg('*', \@%, 'ac')
----   :call setreg('a', "1\n2\n3", 'b5')
----   :call setreg('"', { 'points_to': 'a'})
+--- Examples: >vim
+---   call setreg(v:register, \@*)
+---   call setreg('*', \@%, 'ac')
+---   call setreg('a', "1\n2\n3", 'b5')
+---   call setreg('"', { 'points_to': 'a'})
 ---
 --- <This example shows using the functions to save and restore a
---- register: >
----   :let var_a = getreginfo()
----   :call setreg('a', var_a)
---- <or: >
----   :let var_a = getreg('a', 1, 1)
----   :let var_amode = getregtype('a')
----       ....
----   :call setreg('a', var_a, var_amode)
+--- register: >vim
+---   let var_a = getreginfo()
+---   call setreg('a', var_a)
+--- <or: >vim
+---   let var_a = getreg('a', 1, 1)
+---   let var_amode = getregtype('a')
+---   " ....
+---   call setreg('a', var_a, var_amode)
 --- <Note: you may not reliably restore register value
 --- without using the third argument to |getreg()| as without it
 --- newlines are represented as newlines AND Nul bytes are
 --- represented as newlines as well, see |NL-used-for-Nul|.
 ---
 --- You can also change the type of a register by appending
---- nothing: >
----   :call setreg('a', '', 'al')
+--- nothing: >vim
+---   call setreg('a', '', 'al')
 ---
 --- <Can also be used as a |method|, the base is passed as the
---- second argument: >
+--- second argument: >vim
 ---   GetText()->setreg('a')
+--- <
 ---
 --- @param regname string
 --- @param value any
@@ -8464,8 +8646,9 @@ function vim.fn.setreg(regname, value, options) end
 --- This function is not available in the |sandbox|.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- third argument: >
+--- third argument: >vim
 ---   GetValue()->settabvar(tab, name)
+--- <
 ---
 --- @param tabnr integer
 --- @param varname string
@@ -8483,14 +8666,15 @@ function vim.fn.settabvar(tabnr, varname, val) end
 --- doesn't work for a global or local buffer variable.
 --- For a local buffer option the global value is unchanged.
 --- Note that the variable name without "w:" must be used.
---- Examples: >
----   :call settabwinvar(1, 1, "&list", 0)
----   :call settabwinvar(3, 2, "myvar", "foobar")
+--- Examples: >vim
+---   call settabwinvar(1, 1, "&list", 0)
+---   call settabwinvar(3, 2, "myvar", "foobar")
 --- <This function is not available in the |sandbox|.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- fourth argument: >
+--- fourth argument: >vim
 ---   GetValue()->settabwinvar(tab, winnr, name)
+--- <
 ---
 --- @param tabnr integer
 --- @param winnr integer
@@ -8522,18 +8706,19 @@ function vim.fn.settabwinvar(tabnr, winnr, varname, val) end
 --- Returns zero for success, -1 for failure.
 ---
 --- Examples (for more examples see |tagstack-examples|):
----     Empty the tag stack of window 3: >
+---     Empty the tag stack of window 3: >vim
 ---   call settagstack(3, {'items' : []})
 ---
---- <    Save and restore the tag stack: >
+--- <    Save and restore the tag stack: >vim
 ---   let stack = gettagstack(1003)
 ---   " do something else
 ---   call settagstack(1003, stack)
 ---   unlet stack
 --- <
 --- Can also be used as a |method|, the base is passed as the
---- second argument: >
+--- second argument: >vim
 ---   GetStack()->settagstack(winnr)
+--- <
 ---
 --- @param nr integer
 --- @param dict any
@@ -8542,13 +8727,14 @@ function vim.fn.settabwinvar(tabnr, winnr, varname, val) end
 function vim.fn.settagstack(nr, dict, action) end
 
 --- Like |settabwinvar()| for the current tab page.
---- Examples: >
----   :call setwinvar(1, "&list", 0)
----   :call setwinvar(2, "myvar", "foobar")
+--- Examples: >vim
+---   call setwinvar(1, "&list", 0)
+---   call setwinvar(2, "myvar", "foobar")
 ---
 --- <Can also be used as a |method|, the base is passed as the
---- third argument: >
+--- third argument: >vim
 ---   GetValue()->setwinvar(winnr, name)
+--- <
 ---
 --- @param nr integer
 --- @param varname string
@@ -8559,8 +8745,9 @@ function vim.fn.setwinvar(nr, varname, val) end
 --- Returns a String with 64 hex characters, which is the SHA256
 --- checksum of {string}.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->sha256()
+--- <
 ---
 --- @param string string
 --- @return any
@@ -8589,15 +8776,16 @@ function vim.fn.sha256(string) end
 --- be escaped because in fish it is used as an escape character
 --- inside single quotes.
 ---
---- Example of use with a |:!| command: >
----     :exe '!dir ' .. shellescape(expand('<cfile>'), 1)
+--- Example of use with a |:!| command: >vim
+---     exe '!dir ' .. shellescape(expand('<cfile>'), 1)
 --- <This results in a directory listing for the file under the
---- cursor.  Example of use with |system()|: >
----     :call system("chmod +w -- " .. shellescape(expand("%")))
+--- cursor.  Example of use with |system()|: >vim
+---     call system("chmod +w -- " .. shellescape(expand("%")))
 --- <See also |::S|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetCommand()->shellescape()
+--- <
 ---
 --- @param string string
 --- @param special? any
@@ -8607,7 +8795,7 @@ function vim.fn.shellescape(string, special) end
 --- Returns the effective value of 'shiftwidth'. This is the
 --- 'shiftwidth' value unless it is zero, in which case it is the
 --- 'tabstop' value.  To be backwards compatible in indent
---- plugins, use this: >
+--- plugins, use this: >vim
 ---   if exists('*shiftwidth')
 ---     func s:sw()
 ---       return shiftwidth()
@@ -8624,10 +8812,9 @@ function vim.fn.shellescape(string, special) end
 --- 'vartabstop' feature. If no {col} argument is given, column 1
 --- will be assumed.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetColumn()->shiftwidth()
----
---- sign_ functions are documented here: |sign-functions-details|
+--- <
 ---
 --- @param col? integer
 --- @return any
@@ -8670,7 +8857,7 @@ function vim.fn.sign_define(name, dict) end
 --- {list} is used, then returns a List of values one for each
 --- defined sign.
 ---
---- Examples: >
+--- Examples: >vim
 ---   call sign_define("mySign", {
 ---     \ "text" : "=>",
 ---     \ "texthl" : "Error",
@@ -8682,8 +8869,9 @@ function vim.fn.sign_define(name, dict) end
 ---     \  'text' : '!!'}
 ---     \ ])
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetSignList()->sign_define()
+--- <
 ---
 --- @param list any
 --- @return any
@@ -8716,15 +8904,16 @@ function vim.fn.sign_define(list) end
 --- Returns an empty List if there are no signs and when {name} is
 --- not found.
 ---
---- Examples: >
+--- Examples: >vim
 ---   " Get a list of all the defined signs
 ---   echo sign_getdefined()
 ---
 ---   " Get the attribute of the sign named mySign
 ---   echo sign_getdefined("mySign")
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetSignList()->sign_getdefined()
+--- <
 ---
 --- @param name? string
 --- @return any
@@ -8768,7 +8957,7 @@ function vim.fn.sign_getdefined(name) end
 --- Returns an empty list on failure or if there are no placed
 --- signs.
 ---
---- Examples: >
+--- Examples: >vim
 ---   " Get a List of signs placed in eval.c in the
 ---   " global group
 ---   echo sign_getplaced("eval.c")
@@ -8789,7 +8978,7 @@ function vim.fn.sign_getdefined(name) end
 ---   " Get a List of all the placed signs
 ---   echo sign_getplaced()
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetBufname()->sign_getplaced()
 --- <
 ---
@@ -8808,11 +8997,11 @@ function vim.fn.sign_getplaced(buf, dict) end
 --- Returns the line number of the sign. Returns -1 if the
 --- arguments are invalid.
 ---
---- Example: >
+--- Example: >vim
 ---   " Jump to sign 10 in the current buffer
 ---   call sign_jump(10, '', '')
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetSignid()->sign_jump()
 --- <
 ---
@@ -8850,7 +9039,7 @@ function vim.fn.sign_jump(id, group, buf) end
 ---
 --- Returns the sign identifier on success and -1 on failure.
 ---
---- Examples: >
+--- Examples: >vim
 ---   " Place a sign named sign1 with id 5 at line 20 in
 ---   " buffer json.c
 ---   call sign_place(5, '', 'sign1', 'json.c',
@@ -8869,7 +9058,7 @@ function vim.fn.sign_jump(id, group, buf) end
 ---   call sign_place(10, 'g3', 'sign4', 'json.c',
 ---       \ {'lnum' : 40, 'priority' : 90})
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetSignid()->sign_place(group, name, expr)
 --- <
 ---
@@ -8913,7 +9102,7 @@ function vim.fn.sign_place(id, group, name, buf, dict) end
 --- Returns a List of sign identifiers. If failed to place a
 --- sign, the corresponding list item is set to -1.
 ---
---- Examples: >
+--- Examples: >vim
 ---   " Place sign s1 with id 5 at line 20 and id 10 at line
 ---   " 30 in buffer a.c
 ---   let [n1, n2] = sign_placelist([
@@ -8938,8 +9127,9 @@ function vim.fn.sign_place(id, group, name, buf, dict) end
 ---     \  'lnum' : 50}
 ---     \ ])
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetSignlist()->sign_placelist()
+--- <
 ---
 --- @param list any
 --- @return any
@@ -8960,7 +9150,7 @@ function vim.fn.sign_undefine(name) end
 --- {list} call, returns a list of values one for each undefined
 --- sign.
 ---
---- Examples: >
+--- Examples: >vim
 ---   " Delete a sign named mySign
 ---   call sign_undefine("mySign")
 ---
@@ -8970,8 +9160,9 @@ function vim.fn.sign_undefine(name) end
 ---   " Delete all the signs
 ---   call sign_undefine()
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetSignlist()->sign_undefine()
+--- <
 ---
 --- @param list? any
 --- @return any
@@ -8993,7 +9184,7 @@ function vim.fn.sign_undefine(list) end
 ---
 --- Returns 0 on success and -1 on failure.
 ---
---- Examples: >
+--- Examples: >vim
 ---   " Remove sign 10 from buffer a.vim
 ---   call sign_unplace('', {'buffer' : "a.vim", 'id' : 10})
 ---
@@ -9018,7 +9209,7 @@ function vim.fn.sign_undefine(list) end
 ---   " Remove all the placed signs from all the buffers
 ---   call sign_unplace('*')
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetSigngroup()->sign_unplace()
 --- <
 ---
@@ -9046,7 +9237,7 @@ function vim.fn.sign_unplace(group, dict) end
 --- Returns a List where an entry is set to 0 if the corresponding
 --- sign was successfully removed or -1 on failure.
 ---
---- Example: >
+--- Example: >vim
 ---   " Remove sign with id 10 from buffer a.vim and sign
 ---   " with id 20 from buffer b.vim
 ---   call sign_unplacelist([
@@ -9054,7 +9245,7 @@ function vim.fn.sign_unplace(group, dict) end
 ---     \ {'id' : 20, 'buffer' : 'b.vim'},
 ---     \ ])
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetSignlist()->sign_unplacelist()
 --- <
 ---
@@ -9070,7 +9261,7 @@ function vim.fn.sign_unplacelist(list) end
 --- not removed either. On Unix "//path" is unchanged, but
 --- "///path" is simplified to "/path" (this follows the Posix
 --- standard).
---- Example: >
+--- Example: >vim
 ---   simplify("./dir/.././/file/") == "./file/"
 --- <Note: The combination "dir/.." is only removed if "dir" is
 --- a searchable directory or does not exist.  On Unix, it is also
@@ -9078,8 +9269,9 @@ function vim.fn.sign_unplacelist(list) end
 --- directory.  In order to resolve all the involved symbolic
 --- links before simplifying the path name, use |resolve()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetName()->simplify()
+--- <
 ---
 --- @param filename any
 --- @return any
@@ -9088,14 +9280,15 @@ function vim.fn.simplify(filename) end
 --- Return the sine of {expr}, measured in radians, as a |Float|.
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo sin(100)
---- <  -0.506366 >
----   :echo sin(-4.01)
+--- Examples: >vim
+---   echo sin(100)
+--- <  -0.506366 >vim
+---   echo sin(-4.01)
 --- <  0.763301
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->sin()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -9105,14 +9298,15 @@ function vim.fn.sin(expr) end
 --- [-inf, inf].
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo sinh(0.5)
---- <  0.521095 >
----   :echo sinh(-0.9)
+--- Examples: >vim
+---   echo sinh(0.5)
+--- <  0.521095 >vim
+---   echo sinh(-0.9)
 --- <  -1.026517
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->sinh()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -9126,7 +9320,7 @@ function vim.fn.sinh(expr) end
 --- When {end} is -1 the last item is omitted.
 --- Returns an empty value if {start} or {end} are invalid.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetList()->slice(offset)
 --- <
 ---
@@ -9168,8 +9362,8 @@ function vim.fn.sockconnect(mode, address, opts) end
 
 --- Sort the items in {list} in-place.  Returns {list}.
 ---
---- If you want a list to remain unmodified make a copy first: >
----   :let sortedlist = sort(copy(mylist))
+--- If you want a list to remain unmodified make a copy first: >vim
+---   let sortedlist = sort(copy(mylist))
 ---
 --- <When {func} is omitted, is empty or zero, then sort() uses the
 --- string representation of each item to sort on.  Numbers sort
@@ -9184,15 +9378,15 @@ function vim.fn.sockconnect(mode, address, opts) end
 --- is used to compare strings. See |:language| check or set the
 --- collation locale. |v:collate| can also be used to check the
 --- current locale. Sorting using the locale typically ignores
---- case. Example: >
+--- case. Example: >vim
 ---   " ö is sorted similarly to o with English locale.
----   :language collate en_US.UTF8
----   :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
+---   language collate en_US.UTF8
+---   echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
 --- <  ['n', 'o', 'O', 'ö', 'p', 'z'] ~
---- >
+--- >vim
 ---   " ö is sorted after z with Swedish locale.
----   :language collate sv_SE.UTF8
----   :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
+---   language collate sv_SE.UTF8
+---   echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
 --- <  ['n', 'o', 'O', 'p', 'z', 'ö'] ~
 --- This does not work properly on Mac.
 ---
@@ -9222,22 +9416,22 @@ function vim.fn.sockconnect(mode, address, opts) end
 --- on numbers, text strings will sort next to each other, in the
 --- same order as they were originally.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->sort()
 ---
 --- <Also see |uniq()|.
 ---
---- Example: >
+--- Example: >vim
 ---   func MyCompare(i1, i2)
 ---      return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
 ---   endfunc
 ---   eval mylist->sort("MyCompare")
 --- <A shorter compare version for this specific simple case, which
---- ignores overflow: >
+--- ignores overflow: >vim
 ---   func MyCompare(i1, i2)
 ---      return a:i1 - a:i2
 ---   endfunc
---- <For a simple expression you can use a lambda: >
+--- <For a simple expression you can use a lambda: >vim
 ---   eval mylist->sort({i1, i2 -> i1 - i2})
 --- <
 ---
@@ -9254,7 +9448,7 @@ function vim.fn.sort(list, func, dict) end
 --- This can be used for making spelling suggestions.  Note that
 --- the method can be quite slow.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWord()->soundfold()
 --- <
 ---
@@ -9278,14 +9472,14 @@ function vim.fn.soundfold(word) end
 ---   "rare"    rare word
 ---   "local"    word only valid in another region
 ---   "caps"    word should start with Capital
---- Example: >
+--- Example: >vim
 ---   echo spellbadword("the quik brown fox")
 --- <  ['quik', 'bad'] ~
 ---
 --- The spelling information for the current window and the value
 --- of 'spelllang' are used.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->spellbadword()
 --- <
 ---
@@ -9313,8 +9507,9 @@ function vim.fn.spellbadword(sentence) end
 --- The spelling information for the current window is used.  The
 --- values of 'spelllang' and 'spellsuggest' are used.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWord()->spellsuggest()
+--- <
 ---
 --- @param word any
 --- @param max? any
@@ -9332,20 +9527,23 @@ function vim.fn.spellsuggest(word, max, capital) end
 --- {keepempty} argument is given and it's non-zero.
 --- Other empty items are kept when {pattern} matches at least one
 --- character or when {keepempty} is non-zero.
---- Example: >
----   :let words = split(getline('.'), '\W\+')
---- <To split a string in individual characters: >
----   :for c in split(mystring, '\zs')
+--- Example: >vim
+---   let words = split(getline('.'), '\W\+')
+--- <To split a string in individual characters: >vim
+---   for c in split(mystring, '\zs') | endfor
 --- <If you want to keep the separator you can also use '\zs' at
---- the end of the pattern: >
----   :echo split('abc:def:ghi', ':\zs')
---- <  ['abc:', 'def:', 'ghi'] ~
---- Splitting a table where the first element can be empty: >
----   :let items = split(line, ':', 1)
+--- the end of the pattern: >vim
+---   echo split('abc:def:ghi', ':\zs')
+--- < >
+---   ['abc:', 'def:', 'ghi']
+--- <
+--- Splitting a table where the first element can be empty: >vim
+---   let items = split(line, ':', 1)
 --- <The opposite function is |join()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetString()->split()
+--- <
 ---
 --- @param string string
 --- @param pattern? any
@@ -9358,15 +9556,16 @@ function vim.fn.split(string, pattern, keepempty) end
 --- {expr} must evaluate to a |Float| or a |Number|.  When {expr}
 --- is negative the result is NaN (Not a Number).  Returns 0.0 if
 --- {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo sqrt(100)
---- <  10.0 >
----   :echo sqrt(-4.01)
+--- Examples: >vim
+---   echo sqrt(100)
+--- <  10.0 >vim
+---   echo sqrt(-4.01)
 --- <  str2float("nan")
 --- NaN may be different, it depends on system libraries.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->sqrt()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -9380,13 +9579,14 @@ function vim.fn.sqrt(expr) end
 ---   initialize the seed values.  This is useful for testing or
 ---   when a predictable sequence is intended.
 ---
---- Examples: >
----   :let seed = srand()
----   :let seed = srand(userinput)
----   :echo rand(seed)
+--- Examples: >vim
+---   let seed = srand()
+---   let seed = srand(userinput)
+---   echo rand(seed)
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   userinput->srand()
+--- <
 ---
 --- @param expr? any
 --- @return any
@@ -9433,8 +9633,8 @@ function vim.fn.stdioopen(opts) end
 --- state        String  Session state directory: storage for file
 ---          drafts, swap, undo, |shada|.
 ---
---- Example: >
----   :echo stdpath("config")
+--- Example: >vim
+---   echo stdpath("config")
 --- <
 ---
 --- @param what any
@@ -9454,13 +9654,14 @@ function vim.fn.stdpath(what) end
 --- The decimal point is always '.', no matter what the locale is
 --- set to.  A comma ends the number: "12,345.67" is converted to
 --- 12.0.  You can strip out thousands separators with
---- |substitute()|: >
+--- |substitute()|: >vim
 ---   let f = str2float(substitute(text, ',', '', 'g'))
 --- <
 --- Returns 0.0 if the conversion fails.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   let f = text->substitute(',', '', 'g')->str2float()
+--- <
 ---
 --- @param string string
 --- @param quoted? any
@@ -9468,18 +9669,19 @@ function vim.fn.stdpath(what) end
 function vim.fn.str2float(string, quoted) end
 
 --- Return a list containing the number values which represent
---- each character in String {string}.  Examples: >
----   str2list(" ")    returns [32]
----   str2list("ABC")    returns [65, 66, 67]
+--- each character in String {string}.  Examples: >vim
+---   echo str2list(" ")    " returns [32]
+---   echo str2list("ABC")    " returns [65, 66, 67]
 --- <|list2str()| does the opposite.
 ---
 --- UTF-8 encoding is always used, {utf8} option has no effect,
 --- and exists only for backwards-compatibility.
---- With UTF-8 composing characters are handled properly: >
----   str2list("á")    returns [97, 769]
+--- With UTF-8 composing characters are handled properly: >vim
+---   echo str2list("á")    " returns [97, 769]
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetString()->str2list()
+--- <
 ---
 --- @param string string
 --- @param utf8? any
@@ -9493,7 +9695,7 @@ function vim.fn.str2list(string, utf8) end
 ---
 --- When {base} is omitted base 10 is used.  This also means that
 --- a leading zero doesn't cause octal conversion to be used, as
---- with the default String to Number conversion.  Example: >
+--- with the default String to Number conversion.  Example: >vim
 ---   let nr = str2nr('0123')
 --- <
 --- When {base} is 16 a leading "0x" or "0X" is ignored.  With a
@@ -9504,7 +9706,7 @@ function vim.fn.str2list(string, utf8) end
 ---
 --- Returns 0 if {string} is empty or on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->str2nr()
 --- <
 ---
@@ -9522,7 +9724,7 @@ function vim.fn.str2nr(string, base) end
 ---
 --- Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->strcharlen()
 --- <
 ---
@@ -9538,13 +9740,13 @@ function vim.fn.strcharlen(string) end
 --- similar to  |slice()|.
 --- When a character index is used where a character does not
 --- exist it is omitted and counted as one character.  For
---- example: >
----   strcharpart('abc', -1, 2)
+--- example: >vim
+---   echo strcharpart('abc', -1, 2)
 --- <results in 'a'.
 ---
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->strcharpart(5)
 --- <
 ---
@@ -9567,7 +9769,7 @@ function vim.fn.strcharpart(src, start, len, skipcc) end
 --- Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
 ---
 --- {skipcc} is only available after 7.4.755.  For backward
---- compatibility, you can define a wrapper function: >
+--- compatibility, you can define a wrapper function: >vim
 ---     if has("patch-7.4.755")
 ---       function s:strchars(str, skipcc)
 ---   return strchars(a:str, a:skipcc)
@@ -9582,8 +9784,9 @@ function vim.fn.strcharpart(src, start, len, skipcc) end
 ---       endfunction
 ---     endif
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->strchars()
+--- <
 ---
 --- @param string string
 --- @param skipcc? any
@@ -9603,8 +9806,9 @@ function vim.fn.strchars(string, skipcc) end
 --- Returns zero on error.
 --- Also see |strlen()|, |strwidth()| and |strchars()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->strdisplaywidth()
+--- <
 ---
 --- @param string string
 --- @param col? integer
@@ -9619,16 +9823,17 @@ function vim.fn.strdisplaywidth(string, col) end
 --- format.  The maximum length of the result is 80 characters.
 --- See also |localtime()|, |getftime()| and |strptime()|.
 --- The language can be changed with the |:language| command.
---- Examples: >
----   :echo strftime("%c")       Sun Apr 27 11:49:23 1997
----   :echo strftime("%Y %b %d %X")     1997 Apr 27 11:53:25
----   :echo strftime("%y%m%d %T")     970427 11:53:55
----   :echo strftime("%H:%M")     11:55
----   :echo strftime("%c", getftime("file.c"))
----            Show mod time of file.c.
----
---- <Can also be used as a |method|: >
+--- Examples: >vim
+---   echo strftime("%c")       " Sun Apr 27 11:49:23 1997
+---   echo strftime("%Y %b %d %X")     " 1997 Apr 27 11:53:25
+---   echo strftime("%y%m%d %T")     " 970427 11:53:55
+---   echo strftime("%H:%M")             " 11:55
+---   echo strftime("%c", getftime("file.c"))
+---            " Show mod time of file.c.
+---
+--- <Can also be used as a |method|: >vim
 ---   GetFormat()->strftime()
+--- <
 ---
 --- @param format any
 --- @param time? any
@@ -9643,8 +9848,9 @@ function vim.fn.strftime(format, time) end
 --- Returns -1 if {index} is invalid.
 --- Also see |strcharpart()| and |strchars()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->strgetchar(5)
+--- <
 ---
 --- @param str any
 --- @param index any
@@ -9654,22 +9860,22 @@ function vim.fn.strgetchar(str, index) end
 --- The result is a Number, which gives the byte index in
 --- {haystack} of the first occurrence of the String {needle}.
 --- If {start} is specified, the search starts at index {start}.
---- This can be used to find a second match: >
----   :let colon1 = stridx(line, ":")
----   :let colon2 = stridx(line, ":", colon1 + 1)
+--- This can be used to find a second match: >vim
+---   let colon1 = stridx(line, ":")
+---   let colon2 = stridx(line, ":", colon1 + 1)
 --- <The search is done case-sensitive.
 --- For pattern searches use |match()|.
 --- -1 is returned if the {needle} does not occur in {haystack}.
 --- See also |strridx()|.
---- Examples: >
----   :echo stridx("An Example", "Example")       3
----   :echo stridx("Starting point", "Start")    0
----   :echo stridx("Starting point", "start")   -1
+--- Examples: >vim
+---   echo stridx("An Example", "Example")       " 3
+---   echo stridx("Starting point", "Start")    " 0
+---   echo stridx("Starting point", "start")   " -1
 --- <        *strstr()* *strchr()*
 --- stridx() works similar to the C function strstr().  When used
 --- with a single character it works similar to strchr().
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetHaystack()->stridx(needle)
 --- <
 ---
@@ -9702,8 +9908,9 @@ function vim.fn.stridx(haystack, needle, start) end
 --- method, use |msgpackdump()| or |json_encode()| if you need to
 --- share data with other application.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->string()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -9717,8 +9924,9 @@ function vim.fn.string(expr) end
 --- |strchars()|.
 --- Also see |len()|, |strdisplaywidth()| and |strwidth()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetString()->strlen()
+--- <
 ---
 --- @param string string
 --- @return any
@@ -9736,20 +9944,21 @@ function vim.fn.strlen(string) end
 --- When bytes are selected which do not exist, this doesn't
 --- result in an error, the bytes are simply omitted.
 --- If {len} is missing, the copy continues from {start} till the
---- end of the {src}. >
----   strpart("abcdefg", 3, 2)    == "de"
----   strpart("abcdefg", -2, 4)   == "ab"
----   strpart("abcdefg", 5, 4)    == "fg"
----   strpart("abcdefg", 3)      == "defg"
+--- end of the {src}. >vim
+---   echo strpart("abcdefg", 3, 2)    " returns 'de'
+---   echo strpart("abcdefg", -2, 4)   " returns 'ab'
+---   echo strpart("abcdefg", 5, 4)    " returns 'fg'
+---   echo strpart("abcdefg", 3)   " returns 'defg'
 ---
 --- <Note: To get the first character, {start} must be 0.  For
---- example, to get the character under the cursor: >
+--- example, to get the character under the cursor: >vim
 ---   strpart(getline("."), col(".") - 1, 1, v:true)
 --- <
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->strpart(5)
+--- <
 ---
 --- @param src any
 --- @param start any
@@ -9773,15 +9982,15 @@ function vim.fn.strpart(src, start, len, chars) end
 --- result.
 ---
 --- See also |strftime()|.
---- Examples: >
----   :echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23")
---- <  862156163 >
----   :echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55"))
---- <  Sun Apr 27 11:53:55 1997 >
----   :echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
+--- Examples: >vim
+---   echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23")
+--- <  862156163 >vim
+---   echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55"))
+--- <  Sun Apr 27 11:53:55 1997 >vim
+---   echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
 --- <  Sun Apr 27 12:53:55 1997
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFormat()->strptime(timestring)
 --- <
 ---
@@ -9794,21 +10003,22 @@ function vim.fn.strptime(format, timestring) end
 --- {haystack} of the last occurrence of the String {needle}.
 --- When {start} is specified, matches beyond this index are
 --- ignored.  This can be used to find a match before a previous
---- match: >
----   :let lastcomma = strridx(line, ",")
----   :let comma2 = strridx(line, ",", lastcomma - 1)
+--- match: >vim
+---   let lastcomma = strridx(line, ",")
+---   let comma2 = strridx(line, ",", lastcomma - 1)
 --- <The search is done case-sensitive.
 --- For pattern searches use |match()|.
 --- -1 is returned if the {needle} does not occur in {haystack}.
 --- If the {needle} is empty the length of {haystack} is returned.
---- See also |stridx()|.  Examples: >
----   :echo strridx("an angry armadillo", "an")       3
+--- See also |stridx()|.  Examples: >vim
+---   echo strridx("an angry armadillo", "an")       3
 --- <          *strrchr()*
 --- When used with a single character it works similar to the C
 --- function strrchr().
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetHaystack()->strridx(needle)
+--- <
 ---
 --- @param haystack any
 --- @param needle any
@@ -9818,15 +10028,16 @@ function vim.fn.strridx(haystack, needle, start) end
 
 --- The result is a String, which is {string} with all unprintable
 --- characters translated into printable characters |'isprint'|.
---- Like they are shown in a window.  Example: >
+--- Like they are shown in a window.  Example: >vim
 ---   echo strtrans(\@a)
 --- <This displays a newline in register a as "^\@" instead of
 --- starting a new line.
 ---
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetString()->strtrans()
+--- <
 ---
 --- @param string string
 --- @return any
@@ -9843,14 +10054,14 @@ function vim.fn.strtrans(string) end
 --- Returns zero on error.
 ---
 --- Also see |strlen()| and |strcharlen()|.
---- Examples: >
----     echo strutf16len('a')    returns 1
----     echo strutf16len('©')    returns 1
----     echo strutf16len('😊')    returns 2
----     echo strutf16len('ą́')    returns 1
----     echo strutf16len('ą́', v:true)  returns 3
----
---- Can also be used as a |method|: >
+--- Examples: >vim
+---     echo strutf16len('a')    " returns 1
+---     echo strutf16len('©')    " returns 1
+---     echo strutf16len('😊')    " returns 2
+---     echo strutf16len('ą́')    " returns 1
+---     echo strutf16len('ą́', v:true)  " returns 3
+---
+--- Can also be used as a |method|: >vim
 ---   GetText()->strutf16len()
 --- <
 ---
@@ -9867,8 +10078,9 @@ function vim.fn.strutf16len(string, countcc) end
 --- Returns zero on error.
 --- Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetString()->strwidth()
+--- <
 ---
 --- @param string string
 --- @return any
@@ -9895,14 +10107,15 @@ function vim.fn.strwidth(string) end
 ---
 --- Returns an empty string or list on error.
 ---
---- Examples: >
----   :s/\d\+/\=submatch(0) + 1/
----   :echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
+--- Examples: >vim
+---   s/\d\+/\=submatch(0) + 1/
+---   echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
 --- <This finds the first number in the line and adds one to it.
 --- A line break is included as a newline character.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetNr()->submatch()
+--- <
 ---
 --- @param nr integer
 --- @param list? any
@@ -9930,29 +10143,30 @@ function vim.fn.submatch(nr, list) end
 --- When {pat} does not match in {string}, {string} is returned
 --- unmodified.
 ---
---- Example: >
----   :let &path = substitute(&path, ",\\=[^,]*$", "", "")
---- <This removes the last component of the 'path' option. >
----   :echo substitute("testing", ".*", "\\U\\0", "")
+--- Example: >vim
+---   let &path = substitute(&path, ",\\=[^,]*$", "", "")
+--- <This removes the last component of the 'path' option. >vim
+---   echo substitute("testing", ".*", "\\U\\0", "")
 --- <results in "TESTING".
 ---
 --- When {sub} starts with "\=", the remainder is interpreted as
---- an expression. See |sub-replace-expression|.  Example: >
----   :echo substitute(s, '%\(\x\x\)',
+--- an expression. See |sub-replace-expression|.  Example: >vim
+---   echo substitute(s, '%\(\x\x\)',
 ---      \ '\=nr2char("0x" .. submatch(1))', 'g')
 ---
 --- <When {sub} is a Funcref that function is called, with one
---- optional argument.  Example: >
----    :echo substitute(s, '%\(\x\x\)', SubNr, 'g')
+--- optional argument.  Example: >vim
+---    echo substitute(s, '%\(\x\x\)', SubNr, 'g')
 --- <The optional argument is a list which contains the whole
 --- matched string and up to nine submatches, like what
---- |submatch()| returns.  Example: >
----    :echo substitute(s, '%\(\x\x\)', {m -> '0x' .. m[1]}, 'g')
+--- |submatch()| returns.  Example: >vim
+---    echo substitute(s, '%\(\x\x\)', {m -> '0x' .. m[1]}, 'g')
 ---
 --- <Returns an empty string on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetString()->substitute(pat, sub, flags)
+--- <
 ---
 --- @param string string
 --- @param pat any
@@ -9965,7 +10179,7 @@ function vim.fn.substitute(string, pat, sub, flags) end
 --- See the |-r| command argument.  The 'directory' option is used
 --- for the directories to inspect.  If you only want to get a
 --- list of swap files in the current directory then temporarily
---- set 'directory' to a dot: >
+--- set 'directory' to a dot: >vim
 ---   let save_dir = &directory
 ---   let &directory = '.'
 ---   let swapfiles = swapfilelist()
@@ -9991,8 +10205,9 @@ function vim.fn.swapfilelist() end
 ---   Not a swap file: does not contain correct block ID
 ---   Magic number mismatch: Info in first block is invalid
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFilename()->swapinfo()
+--- <
 ---
 --- @param fname integer
 --- @return any
@@ -10004,8 +10219,9 @@ function vim.fn.swapinfo(fname) end
 --- |:swapname| (unless there is no swap file).
 --- If buffer {buf} has no swap file, returns an empty string.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetBufname()->swapname()
+--- <
 ---
 --- @param buf any
 --- @return any
@@ -10032,8 +10248,8 @@ function vim.fn.swapname(buf) end
 ---
 --- Returns zero on error.
 ---
---- Example (echoes the name of the syntax item under the cursor): >
----   :echo synIDattr(synID(line("."), col("."), 1), "name")
+--- Example (echoes the name of the syntax item under the cursor): >vim
+---   echo synIDattr(synID(line("."), col("."), 1), "name")
 --- <
 ---
 --- @param lnum integer
@@ -10080,11 +10296,12 @@ function vim.fn.synID(lnum, col, trans) end
 --- Returns an empty string on error.
 ---
 --- Example (echoes the color of the syntax item under the
---- cursor): >
----   :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
+--- cursor): >vim
+---   echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
+--- <
+--- Can also be used as a |method|: >vim
+---   echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
 --- <
---- Can also be used as a |method|: >
----   :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
 ---
 --- @param synID any
 --- @param what any
@@ -10099,8 +10316,9 @@ function vim.fn.synIDattr(synID, what, mode) end
 ---
 --- Returns zero on error.
 ---
---- Can also be used as a |method|: >
----   :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
+--- Can also be used as a |method|: >vim
+---   echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
+--- <
 ---
 --- @param synID any
 --- @return any
@@ -10145,7 +10363,7 @@ function vim.fn.synconcealed(lnum, col) end
 --- returns, unless not the whole item is highlighted or it is a
 --- transparent item.
 --- This function is useful for debugging a syntax file.
---- Example that shows the syntax stack under the cursor: >
+--- Example that shows the syntax stack under the cursor: >vim
 ---   for id in synstack(line("."), col("."))
 ---      echo synIDattr(id, "name")
 ---   endfor
@@ -10165,8 +10383,8 @@ function vim.fn.synstack(lnum, col) end
 --- a |List|) and sets |v:shell_error| to the error code.
 --- {cmd} is treated as in |jobstart()|:
 --- If {cmd} is a List it runs directly (no 'shell').
---- If {cmd} is a String it runs in the 'shell', like this: >
----   :call jobstart(split(&shell) + split(&shellcmdflag) + ['{cmd}'])
+--- If {cmd} is a String it runs in the 'shell', like this: >vim
+---   call jobstart(split(&shell) + split(&shellcmdflag) + ['{cmd}'])
 ---
 --- <Not to be used for interactive commands.
 ---
@@ -10174,8 +10392,8 @@ function vim.fn.synstack(lnum, col) end
 --- - <CR><NL> is replaced with <NL>
 --- - NUL characters are replaced with SOH (0x01)
 ---
---- Example: >
----     :echo system(['ls', expand('%:h')])
+--- Example: >vim
+---     echo system(['ls', expand('%:h')])
 ---
 --- <If {input} is a string it is written to a pipe and passed as
 --- stdin to the command.  The string is written as-is, line
@@ -10189,8 +10407,8 @@ function vim.fn.synstack(lnum, col) end
 --- terminated by NL (and NUL where the text has NL).
 ---             *E5677*
 --- Note: system() cannot write to or read from backgrounded ("&")
---- shell commands, e.g.: >
----     :echo system("cat - &", "foo")
+--- shell commands, e.g.: >vim
+---     echo system("cat - &", "foo")
 --- <which is equivalent to: >
 ---     $ echo foo | bash -c 'cat - &'
 --- <The pipes are disconnected (unless overridden by shell
@@ -10200,15 +10418,16 @@ function vim.fn.synstack(lnum, col) end
 --- Note: Use |shellescape()| or |::S| with |expand()| or
 --- |fnamemodify()| to escape special characters in a command
 --- argument. 'shellquote' and 'shellxquote' must be properly
---- configured. Example: >
----     :echo system('ls '..shellescape(expand('%:h')))
----     :echo system('ls '..expand('%:h:S'))
+--- configured. Example: >vim
+---     echo system('ls '..shellescape(expand('%:h')))
+---     echo system('ls '..expand('%:h:S'))
 ---
 --- <Unlike ":!cmd" there is no automatic check for changed files.
 --- Use |:checktime| to force a check.
 ---
---- Can also be used as a |method|: >
----   :echo GetCmd()->system()
+--- Can also be used as a |method|: >vim
+---   echo GetCmd()->system()
+--- <
 ---
 --- @param cmd any
 --- @param input? any
@@ -10223,13 +10442,14 @@ function vim.fn.system(cmd, input) end
 --- Note that on MS-Windows you may get trailing CR characters.
 ---
 --- To see the difference between "echo hello" and "echo -n hello"
---- use |system()| and |split()|: >
+--- use |system()| and |split()|: >vim
 ---   echo split(system('echo hello'), '\n', 1)
 --- <
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >
----   :echo GetCmd()->systemlist()
+--- Can also be used as a |method|: >vim
+---   echo GetCmd()->systemlist()
+--- <
 ---
 --- @param cmd any
 --- @param input? any
@@ -10242,15 +10462,16 @@ function vim.fn.systemlist(cmd, input, keepempty) end
 --- {arg} specifies the number of the tab page to be used. When
 --- omitted the current tab page is used.
 --- When {arg} is invalid the number zero is returned.
---- To get a list of all buffers in all tabs use this: >
+--- To get a list of all buffers in all tabs use this: >vim
 ---   let buflist = []
 ---   for i in range(tabpagenr('$'))
 ---      call extend(buflist, tabpagebuflist(i + 1))
 ---   endfor
 --- <Note that a buffer may appear in more than one window.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetTabpage()->tabpagebuflist()
+--- <
 ---
 --- @param arg? any
 --- @return any
@@ -10280,12 +10501,12 @@ function vim.fn.tabpagenr(arg) end
 ---   the window which will be used when going to this tab page.
 --- - When "$" the number of windows is returned.
 --- - When "#" the previous window nr is returned.
---- Useful examples: >
+--- Useful examples: >vim
 ---     tabpagewinnr(1)      " current window of tab page 1
 ---     tabpagewinnr(4, '$')    " number of windows in tab page 4
 --- <When {tabarg} is invalid zero is returned.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetTabpage()->tabpagewinnr()
 --- <
 ---
@@ -10342,7 +10563,7 @@ function vim.fn.tagfiles() end
 --- located by Vim. Refer to |tags-file-format| for the format of
 --- the tags file generated by the different ctags tools.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetTagpattern()->taglist()
 ---
 --- @param expr any
@@ -10354,14 +10575,15 @@ function vim.fn.taglist(expr, filename) end
 --- in the range [-inf, inf].
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo tan(10)
---- <  0.648361 >
----   :echo tan(-4.01)
+--- Examples: >vim
+---   echo tan(10)
+--- <  0.648361 >vim
+---   echo tan(-4.01)
 --- <  -1.181502
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->tan()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -10371,13 +10593,13 @@ function vim.fn.tan(expr) end
 --- range [-1, 1].
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
----   :echo tanh(0.5)
---- <  0.462117 >
----   :echo tanh(-1)
+--- Examples: >vim
+---   echo tanh(0.5)
+--- <  0.462117 >vim
+---   echo tanh(-1)
 --- <  -0.761594
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->tanh()
 --- <
 ---
@@ -10387,9 +10609,10 @@ function vim.fn.tanh(expr) end
 
 --- Generates a (non-existent) filename located in the Nvim root
 --- |tempdir|. Scripts can use the filename as a temporary file.
---- Example: >
----   :let tmpfile = tempname()
----   :exe "redir > " .. tmpfile
+--- Example: >vim
+---   let tmpfile = tempname()
+---   exe "redir > " .. tmpfile
+--- <
 ---
 --- @return string
 function vim.fn.tempname() end
@@ -10427,7 +10650,7 @@ function vim.fn.termopen(cmd, opts) end
 ---         -1 means forever
 ---     "callback"      the callback
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetTimer()->timer_info()
 --- <
 ---
@@ -10447,7 +10670,7 @@ function vim.fn.timer_info(id) end
 --- String, then the timer is paused, otherwise it is unpaused.
 --- See |non-zero-arg|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetTimer()->timer_pause(1)
 --- <
 ---
@@ -10477,7 +10700,7 @@ function vim.fn.timer_pause(timer, paused) end
 ---
 --- Returns -1 on error.
 ---
---- Example: >
+--- Example: >vim
 ---   func MyHandler(timer)
 ---     echo 'Handler called'
 ---   endfunc
@@ -10485,7 +10708,7 @@ function vim.fn.timer_pause(timer, paused) end
 ---     \ {'repeat': 3})
 --- <This invokes MyHandler() three times at 500 msec intervals.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetMsec()->timer_start(callback)
 ---
 --- <Not available in the |sandbox|.
@@ -10500,7 +10723,7 @@ function vim.fn.timer_start(time, callback, options) end
 --- {timer} is an ID returned by timer_start(), thus it must be a
 --- Number.  If {timer} does not exist there is no error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetTimer()->timer_stop()
 --- <
 ---
@@ -10519,8 +10742,9 @@ function vim.fn.timer_stopall() end
 --- characters turned into lowercase (just like applying |gu| to
 --- the string).  Returns an empty string on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->tolower()
+--- <
 ---
 --- @param expr any
 --- @return string
@@ -10530,8 +10754,9 @@ function vim.fn.tolower(expr) end
 --- characters turned into uppercase (just like applying |gU| to
 --- the string).  Returns an empty string on error.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->toupper()
+--- <
 ---
 --- @param expr any
 --- @return string
@@ -10546,14 +10771,15 @@ function vim.fn.toupper(expr) end
 ---
 --- Returns an empty string on error.
 ---
---- Examples: >
+--- Examples: >vim
 ---   echo tr("hello there", "ht", "HT")
---- <returns "Hello THere" >
+--- <returns "Hello THere" >vim
 ---   echo tr("<blob>", "<>", "{}")
 --- <returns "{blob}"
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->tr(from, to)
+--- <
 ---
 --- @param src any
 --- @param fromstr any
@@ -10575,18 +10801,19 @@ function vim.fn.tr(src, fromstr, tostr) end
 --- This function deals with multibyte characters properly.
 --- Returns an empty string on error.
 ---
---- Examples: >
+--- Examples: >vim
 ---   echo trim("   some text ")
---- <returns "some text" >
+--- <returns "some text" >vim
 ---   echo trim("  \r\t\t\r RESERVE \t\n\x0B\xA0") .. "_TAIL"
---- <returns "RESERVE_TAIL" >
+--- <returns "RESERVE_TAIL" >vim
 ---   echo trim("rm<Xrm<>X>rrm", "rm<>")
---- <returns "Xrm<>X" (characters in the middle are not removed) >
+--- <returns "Xrm<>X" (characters in the middle are not removed) >vim
 ---   echo trim("  vim  ", " ", 2)
 --- <returns "  vim"
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetText()->trim()
+--- <
 ---
 --- @param text any
 --- @param mask? any
@@ -10598,16 +10825,17 @@ function vim.fn.trim(text, mask, dir) end
 --- equal to {expr} as a |Float| (truncate towards zero).
 --- {expr} must evaluate to a |Float| or a |Number|.
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
---- Examples: >
+--- Examples: >vim
 ---   echo trunc(1.456)
---- <  1.0  >
+--- <  1.0  >vim
 ---   echo trunc(-5.456)
---- <  -5.0  >
+--- <  -5.0  >vim
 ---   echo trunc(4.0)
 --- <  4.0
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   Compute()->trunc()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -10625,22 +10853,23 @@ function vim.fn.trunc(expr) end
 ---   Boolean:    6 (|v:true| and |v:false|)
 ---   Null:       7 (|v:null|)
 ---   Blob:      10 (|v:t_blob|)
---- For backward compatibility, this method can be used: >
----   :if type(myvar) == type(0)
----   :if type(myvar) == type("")
----   :if type(myvar) == type(function("tr"))
----   :if type(myvar) == type([])
----   :if type(myvar) == type({})
----   :if type(myvar) == type(0.0)
----   :if type(myvar) == type(v:true)
+--- For backward compatibility, this method can be used: >vim
+---   if type(myvar) == type(0) | endif
+---   if type(myvar) == type("") | endif
+---   if type(myvar) == type(function("tr")) | endif
+---   if type(myvar) == type([]) | endif
+---   if type(myvar) == type({}) | endif
+---   if type(myvar) == type(0.0) | endif
+---   if type(myvar) == type(v:true) | endif
 --- <In place of checking for |v:null| type it is better to check
---- for |v:null| directly as it is the only value of this type: >
----   :if myvar is v:null
---- <               To check if the v:t_ variables exist use this: >
----                         :if exists('v:t_number')
+--- for |v:null| directly as it is the only value of this type: >vim
+---   if myvar is v:null | endif
+--- <To check if the v:t_ variables exist use this: >vim
+---   if exists('v:t_number') | endif
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   mylist->type()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -10656,8 +10885,9 @@ function vim.fn.type(expr) end
 --- buffer without a file name will not write an undo file.
 --- Useful in combination with |:wundo| and |:rundo|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetFilename()->undofile()
+--- <
 ---
 --- @param name string
 --- @return string
@@ -10710,14 +10940,14 @@ function vim.fn.undotree() end
 
 --- Remove second and succeeding copies of repeated adjacent
 --- {list} items in-place.  Returns {list}.  If you want a list
---- to remain unmodified make a copy first: >
----   :let newlist = uniq(copy(mylist))
+--- to remain unmodified make a copy first: >vim
+---   let newlist = uniq(copy(mylist))
 --- <The default compare function uses the string representation of
 --- each item.  For the use of {func} and {dict} see |sort()|.
 ---
 --- Returns zero if {list} is not a |List|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mylist->uniq()
 --- <
 ---
@@ -10744,16 +10974,16 @@ function vim.fn.uniq(list, func, dict) end
 --- from the UTF-16 index and |charidx()| for getting the
 --- character index from the UTF-16 index.
 --- Refer to |string-offset-encoding| for more information.
---- Examples: >
----   echo utf16idx('a😊😊', 3)  returns 2
----   echo utf16idx('a😊😊', 7)  returns 4
----   echo utf16idx('a😊😊', 1, 0, 1)  returns 2
----   echo utf16idx('a😊😊', 2, 0, 1)  returns 4
----   echo utf16idx('aą́c', 6)    returns 2
----   echo utf16idx('aą́c', 6, 1)  returns 4
----   echo utf16idx('a😊😊', 9)  returns -1
---- <
---- Can also be used as a |method|: >
+--- Examples: >vim
+---   echo utf16idx('a😊😊', 3)  " returns 2
+---   echo utf16idx('a😊😊', 7)  " returns 4
+---   echo utf16idx('a😊😊', 1, 0, 1)  " returns 2
+---   echo utf16idx('a😊😊', 2, 0, 1)  " returns 4
+---   echo utf16idx('aą́c', 6)    " returns 2
+---   echo utf16idx('aą́c', 6, 1)  " returns 4
+---   echo utf16idx('a😊😊', 9)  " returns -1
+--- <
+--- Can also be used as a |method|: >vim
 ---   GetName()->utf16idx(idx)
 --- <
 ---
@@ -10768,8 +10998,9 @@ function vim.fn.utf16idx(string, idx, countcc, charidx) end
 --- in arbitrary order.  Also see |items()| and |keys()|.
 --- Returns zero if {dict} is not a |Dict|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   mydict->values()
+--- <
 ---
 --- @param dict any
 --- @return any
@@ -10811,23 +11042,24 @@ function vim.fn.values(dict) end
 --- character.
 ---
 --- Note that only marks in the current file can be used.
---- Examples: >
+--- Examples: >vim
 ---   " With text "foo^Lbar" and cursor on the "^L":
 ---
----   virtcol(".")  " returns 5
----   virtcol(".", 1)  " returns [4, 5]
----   virtcol("$")  " returns 9
+---   echo virtcol(".")  " returns 5
+---   echo virtcol(".", 1)  " returns [4, 5]
+---   echo virtcol("$")  " returns 9
 ---
 ---   " With text "    there", with 't at 'h':
 ---
----   virtcol("'t")  " returns 6
---- <The first column is 1.  0 is returned for an error.
---- A more advanced example that echoes the maximum length of
---- all lines: >
+---   echo virtcol("'t")  " returns 6
+--- <Techo he first column is 1.  0 is returned for an error.
+--- A echo more advanced example that echoes the maximum length of
+--- all lines: >vim
 ---     echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetPos()->virtcol()
+--- <
 ---
 --- @param expr any
 --- @param list? any
@@ -10850,8 +11082,9 @@ function vim.fn.virtcol(expr, list) end
 ---
 --- See also |screenpos()|, |virtcol()| and |col()|.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinid()->virtcol2col(lnum, col)
+--- <
 ---
 --- @param winid integer
 --- @param lnum integer
@@ -10865,8 +11098,8 @@ function vim.fn.virtcol2col(winid, lnum, col) end
 --- "V", or "<CTRL-V>" (a single CTRL-V character) for
 --- character-wise, line-wise, or block-wise Visual mode
 --- respectively.
---- Example: >
----   :exe "normal " .. visualmode()
+--- Example: >vim
+---   exe "normal " .. visualmode()
 --- <This enters the same Visual mode as before.  It is also useful
 --- in scripts if you wish to act differently depending on the
 --- Visual mode that was used.
@@ -10906,8 +11139,8 @@ function vim.fn.wait(timeout, condition, interval) end
 --- This can be used in mappings to handle the 'wildcharm' option
 --- gracefully. (Makes only sense with |mapmode-c| mappings).
 ---
---- For example to make <c-j> work like <down> in wildmode, use: >
----     :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
+--- For example to make <c-j> work like <down> in wildmode, use: >vim
+---     cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
 --- <
 --- (Note, this needs the 'wildcharm' option set appropriately).
 ---
@@ -10919,7 +11152,7 @@ function vim.fn.wildmenumode() end
 --- without triggering autocommands or changing directory.  When
 --- executing {command} autocommands will be triggered, this may
 --- have unexpected side effects.  Use `:noautocmd` if needed.
---- Example: >
+--- Example: >vim
 ---   call win_execute(winid, 'syntax enable')
 --- <Doing the same with `setwinvar()` would not trigger
 --- autocommands and not actually show syntax highlighting.
@@ -10928,8 +11161,9 @@ function vim.fn.wildmenumode() end
 --- an empty string is returned.
 ---
 --- Can also be used as a |method|, the base is passed as the
---- second argument: >
+--- second argument: >vim
 ---   GetCommand()->win_execute(winid)
+--- <
 ---
 --- @param id any
 --- @param command any
@@ -10940,8 +11174,9 @@ function vim.fn.win_execute(id, command, silent) end
 --- Returns a |List| with |window-ID|s for windows that contain
 --- buffer {bufnr}.  When there is none the list is empty.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetBufnr()->win_findbuf()
+--- <
 ---
 --- @param bufnr any
 --- @return integer[]
@@ -10955,8 +11190,9 @@ function vim.fn.win_findbuf(bufnr) end
 --- number {tab}.  The first tab has number one.
 --- Return zero if the window cannot be found.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinnr()->win_getid()
+--- <
 ---
 --- @param win? any
 --- @param tab? any
@@ -10980,7 +11216,7 @@ function vim.fn.win_getid(win, tab) end
 ---
 --- Also see the 'buftype' option.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinid()->win_gettype()
 --- <
 ---
@@ -10992,8 +11228,9 @@ function vim.fn.win_gettype(nr) end
 --- tabpage.
 --- Return TRUE if successful, FALSE if the window cannot be found.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinid()->win_gotoid()
+--- <
 ---
 --- @param expr any
 --- @return 0|1
@@ -11003,8 +11240,9 @@ function vim.fn.win_gotoid(expr) end
 --- with ID {expr}: [tabnr, winnr].
 --- Return [0, 0] if the window cannot be found.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinid()->win_id2tabwin()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -11013,8 +11251,9 @@ function vim.fn.win_id2tabwin(expr) end
 --- Return the window number of window with ID {expr}.
 --- Return 0 if the window cannot be found in the current tabpage.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinid()->win_id2win()
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -11034,8 +11273,9 @@ function vim.fn.win_id2win(expr) end
 --- window, since it has no separator on the right.
 --- Only works for the current tab page. *E1308*
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinnr()->win_move_separator(offset)
+--- <
 ---
 --- @param nr integer
 --- @param offset any
@@ -11053,8 +11293,9 @@ function vim.fn.win_move_separator(nr, offset) end
 --- be found and FALSE otherwise.
 --- Only works for the current tab page.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinnr()->win_move_statusline(offset)
+--- <
 ---
 --- @param nr integer
 --- @param offset any
@@ -11069,7 +11310,7 @@ function vim.fn.win_move_statusline(nr, offset) end
 --- Returns [0, 0] if the window cannot be found in the current
 --- tabpage.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinid()->win_screenpos()
 --- <
 ---
@@ -11096,7 +11337,7 @@ function vim.fn.win_screenpos(nr) end
 ---     present, the values of 'splitbelow' and
 ---     'splitright' are used.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinid()->win_splitmove(target)
 --- <
 ---
@@ -11112,10 +11353,10 @@ function vim.fn.win_splitmove(nr, target, options) end
 --- When {nr} is zero, the number of the buffer in the current
 --- window is returned.
 --- When window {nr} doesn't exist, -1 is returned.
---- Example: >
----   :echo "The file in the current window is " .. bufname(winbufnr(0))
+--- Example: >vim
+---   echo "The file in the current window is " .. bufname(winbufnr(0))
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   FindWindow()->winbufnr()->bufname()
 --- <
 ---
@@ -11144,10 +11385,10 @@ function vim.fn.windowsversion() end
 --- returned.  When window {nr} doesn't exist, -1 is returned.
 --- An existing window always has a height of zero or more.
 --- This excludes any window toolbar line.
---- Examples: >
----   :echo "The current window has " .. winheight(0) .. " lines."
+--- Examples: >vim
+---   echo "The current window has " .. winheight(0) .. " lines."
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetWinid()->winheight()
 --- <
 ---
@@ -11162,29 +11403,35 @@ function vim.fn.winheight(nr) end
 --- with number {tabnr}. If the tabpage {tabnr} is not found,
 --- returns an empty list.
 ---
---- For a leaf window, it returns:
+--- For a leaf window, it returns: >
 ---   ["leaf", {winid}]
+--- <
 --- For horizontally split windows, which form a column, it
 --- returns: >
 ---   ["col", [{nested list of windows}]]
 --- <For vertically split windows, which form a row, it returns: >
 ---   ["row", [{nested list of windows}]]
 --- <
---- Example: >
+--- Example: >vim
 ---   " Only one window in the tab page
----   :echo winlayout()
+---   echo winlayout()
+--- < >
 ---   ['leaf', 1000]
+--- < >vim
 ---   " Two horizontally split windows
----   :echo winlayout()
+---   echo winlayout()
+--- < >
 ---   ['col', [['leaf', 1000], ['leaf', 1001]]]
+--- < >vim
 ---   " The second tab page, with three horizontally split
 ---   " windows, with two vertically split windows in the
 ---   " middle window
----   :echo winlayout(2)
+---   echo winlayout(2)
+--- < >
 ---   ['col', [['leaf', 1002], ['row', [['leaf', 1003],
 ---           ['leaf', 1001]]], ['leaf', 1000]]]
 --- <
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetTabnr()->winlayout()
 --- <
 ---
@@ -11224,12 +11471,12 @@ function vim.fn.winline() end
 --- |:wincmd|.
 --- When {arg} is invalid an error is given and zero is returned.
 --- Also see |tabpagewinnr()| and |win_getid()|.
---- Examples: >
+--- Examples: >vim
 ---   let window_count = winnr('$')
 ---   let prev_window = winnr('#')
 ---   let wnum = winnr('3k')
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetWinval()->winnr()
 --- <
 ---
@@ -11241,10 +11488,10 @@ function vim.fn.winnr(arg) end
 --- the current window sizes.  Only works properly when no windows
 --- are opened or closed and the current window and tab page is
 --- unchanged.
---- Example: >
----   :let cmd = winrestcmd()
----   :call MessWithWindowSizes()
----   :exe cmd
+--- Example: >vim
+---   let cmd = winrestcmd()
+---   call MessWithWindowSizes()
+---   exe cmd
 --- <
 ---
 --- @return any
@@ -11254,8 +11501,8 @@ function vim.fn.winrestcmd() end
 --- the view of the current window.
 --- Note: The {dict} does not have to contain all values, that are
 --- returned by |winsaveview()|. If values are missing, those
---- settings won't be restored. So you can use: >
----     :call winrestview({'curswant': 4})
+--- settings won't be restored. So you can use: >vim
+---     call winrestview({'curswant': 4})
 --- <
 --- This will only set the curswant value (the column the cursor
 --- wants to move on vertical movements) of the cursor to column 5
@@ -11265,7 +11512,7 @@ function vim.fn.winrestcmd() end
 --- If you have changed the values the result is unpredictable.
 --- If the window size changed the result won't be the same.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetView()->winrestview()
 --- <
 ---
@@ -11307,16 +11554,17 @@ function vim.fn.winsaveview() end
 --- When {nr} is zero, the width of the current window is
 --- returned.  When window {nr} doesn't exist, -1 is returned.
 --- An existing window always has a width of zero or more.
---- Examples: >
----   :echo "The current window has " .. winwidth(0) .. " columns."
----   :if winwidth(0) <= 50
----   :  50 wincmd |
----   :endif
+--- Examples: >vim
+---   echo "The current window has " .. winwidth(0) .. " columns."
+---   if winwidth(0) <= 50
+---     50 wincmd |
+---   endif
 --- <For getting the terminal or screen size, see the 'columns'
 --- option.
 ---
---- Can also be used as a |method|: >
+--- Can also be used as a |method|: >vim
 ---   GetWinid()->winwidth()
+--- <
 ---
 --- @param nr integer
 --- @return any
@@ -11361,13 +11609,13 @@ function vim.fn.wordcount() end
 ---      last list item.  An empty item at the end does cause the
 ---      last line in the file to end in a NL.
 ---
---- 'a'  Append mode is used, lines are appended to the file: >
----   :call writefile(["foo"], "event.log", "a")
----   :call writefile(["bar"], "event.log", "a")
+--- 'a'  Append mode is used, lines are appended to the file: >vim
+---   call writefile(["foo"], "event.log", "a")
+---   call writefile(["bar"], "event.log", "a")
 --- <
 --- 'D'  Delete the file when the current function ends.  This
----      works like: >
----   :defer delete({fname})
+---      works like: >vim
+---   defer delete({fname})
 --- <     Fails when not in a function.  Also see |:defer|.
 ---
 --- 's'  fsync() is called after writing the file.  This flushes
@@ -11386,12 +11634,13 @@ function vim.fn.wordcount() end
 --- fails.
 ---
 --- Also see |readfile()|.
---- To copy a file byte for byte: >
----   :let fl = readfile("foo", "b")
----   :call writefile(fl, "foocopy", "b")
+--- To copy a file byte for byte: >vim
+---   let fl = readfile("foo", "b")
+---   call writefile(fl, "foocopy", "b")
 ---
---- <Can also be used as a |method|: >
+--- <Can also be used as a |method|: >vim
 ---   GetText()->writefile("thefile")
+--- <
 ---
 --- @param object any
 --- @param fname integer
@@ -11402,11 +11651,11 @@ function vim.fn.writefile(object, fname, flags) end
 --- Bitwise XOR on the two arguments.  The arguments are converted
 --- to a number.  A List, Dict or Float argument causes an error.
 --- Also see `and()` and `or()`.
---- Example: >
----   :let bits = xor(bits, 0x80)
+--- Example: >vim
+---   let bits = xor(bits, 0x80)
 --- <
---- Can also be used as a |method|: >
----   :let bits = bits->xor(0x80)
+--- Can also be used as a |method|: >vim
+---   let bits = bits->xor(0x80)
 --- <
 ---
 --- @param expr any
-- 
cgit 


From ccb5a76e5a2cc8627da6e3453697d2628ed0c6ac Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 1 Aug 2023 18:07:02 +0800
Subject: fix(defaults): don't use nvim_feedkeys in default mappings (#24520)

Problem:    Using nvim_feedkeys in default mappings makes it hard to use
            them as a part of another mapping.
Solution:   Use an expression mapping and stop Visual mode later.

Fix #24518.
---
 runtime/lua/vim/_editor.lua | 19 ++++++++++++-------
 1 file changed, 12 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 87f6d6581c..6182270708 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -1016,8 +1016,13 @@ function vim._init_default_mappings()
 
   local function _visual_search(cmd)
     assert(cmd == '/' or cmd == '?')
-    vim.api.nvim_feedkeys('\27', 'nx', true) -- Escape visual mode.
-    local region = vim.region(0, "'<", "'>", vim.fn.visualmode(), vim.o.selection == 'inclusive')
+    local region = vim.region(
+      0,
+      '.',
+      'v',
+      vim.api.nvim_get_mode().mode:sub(1, 1),
+      vim.o.selection == 'inclusive'
+    )
     local chunks = region_chunks(region)
     local esc_chunks = vim
       .iter(chunks)
@@ -1027,7 +1032,7 @@ function vim._init_default_mappings()
       :totable()
     local esc_pat = table.concat(esc_chunks, [[\n]])
     local search_cmd = ([[%s\V%s%s]]):format(cmd, esc_pat, '\n')
-    vim.api.nvim_feedkeys(search_cmd, 'nx', true)
+    return '\27' .. search_cmd
   end
 
   local function map(mode, lhs, rhs)
@@ -1040,11 +1045,11 @@ function vim._init_default_mappings()
   map('i', '<C-U>', '<C-G>u<C-U>')
   map('i', '<C-W>', '<C-G>u<C-W>')
   vim.keymap.set('x', '*', function()
-    _visual_search('/')
-  end, { desc = ':help v_star-default', silent = true })
+    return _visual_search('/')
+  end, { desc = ':help v_star-default', expr = true, silent = true })
   vim.keymap.set('x', '#', function()
-    _visual_search('?')
-  end, { desc = ':help v_#-default', silent = true })
+    return _visual_search('?')
+  end, { desc = ':help v_#-default', expr = true, silent = true })
   -- Use : instead of <Cmd> so that ranges are supported. #19365
   map('n', '&', ':&&<CR>')
 
-- 
cgit 


From e55e80d51ca5d85770981bffb9254badc3662e0c Mon Sep 17 00:00:00 2001
From: Chris AtLee <chris@atlee.ca>
Date: Tue, 1 Aug 2023 08:13:52 -0400
Subject: fix(lsp): inlay hints: "Failed to delete autocmd" when closing buffer
 #24469
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Problem:
"Failed to delete autocmd" error when deleting LspNotify autocmd. #24456

Solution:
Change a few things in the inlay_hint and diagnostic LSP code:
1. Re-introduce the `enabled` flag for the buffer state tables. Previously I was
   relying on the presence of an autocmd id in the state table to track whether
   inlay_hint / diagnostic was enabled for a buffer. There are two reasons why
   this doesn't work well:
  - Each time inlay_hint / diagnostic is enabled, we call `nvim_buf_attach` on
    the buffer, resulting in multiple `on_reload` or `on_detach` callbacks being
    registered.
  - Commands like `bwipeout` delete buffer local autocmds, sometimes before our
    `on_detach` callbacks have a chance to delete them first. This causes the
  - Use module local enabled state for diagnostic as well. bwipeout can race
    with on_detach callbacks for deleting autocmds. Error referenced in #24456.
2. Change the `LspDetach` autocmd to run each time (i.e., remove the `once`
   flag). Since we're only registering autocmds once per buffer now, we
   need to make sure that we set the enabled flag properly each time the LSP
   client detaches from the buffer.
  - Remove `once` from the LspDetach autocmds for inlay_hint and diagnostic.
    We only set up the autocmd once now. Gets removed when buffer is deleted.
3. Have the `LspNotify` handler also refresh the inlay_hint / diagnostics when
   receiving the `textDocument/didOpen` event. Before this point, the LSP
   backend doesn't have the contents of the buffer, so can't provide inlay hints
   or diagnostics.

Downsides of this approach:
* When inlay_hint / diagnostics are disabled on a buffer, it will continue to
  receive `LspNotify` events for that buffer. The callback exits early since the
  `enabled` flag is false.

Alternatives:
* Can we wrap the call to `nvim_del_autocmd` in `pcall` to swallow any errors
  resulting from trying to delete the autocmd?

Fixes #24456

Helped-by: Maria José Solano <majosolano99@gmail.com>
---
 runtime/lua/vim/lsp/diagnostic.lua | 85 +++++++++++++++++++++-----------------
 runtime/lua/vim/lsp/inlay_hint.lua | 35 +++++++++-------
 2 files changed, 67 insertions(+), 53 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index 34be13096d..44bb90d985 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -392,19 +392,18 @@ local function clear(bufnr)
   end
 end
 
---- autocmd ids for LspNotify handlers per buffer
---- @private
---- @type table<integer,integer>
-local _autocmd_ids = {}
+---@class lsp.diagnostic.bufstate
+---@field enabled boolean Whether inlay hints are enabled for this buffer
+---@type table<integer, lsp.diagnostic.bufstate>
+local bufstates = {}
 
 --- Disable pull diagnostics for a buffer
 --- @private
 local function disable(bufnr)
-  if not _autocmd_ids[bufnr] then
-    return
+  local bufstate = bufstates[bufnr]
+  if bufstate then
+    bufstate.enabled = false
   end
-  api.nvim_del_autocmd(_autocmd_ids[bufnr])
-  _autocmd_ids[bufnr] = nil
   clear(bufnr)
 end
 
@@ -416,38 +415,46 @@ function M._enable(bufnr)
     bufnr = api.nvim_get_current_buf()
   end
 
-  if _autocmd_ids[bufnr] then
-    return
+  if not bufstates[bufnr] then
+    bufstates[bufnr] = { enabled = true }
+
+    api.nvim_create_autocmd('LspNotify', {
+      buffer = bufnr,
+      callback = function(opts)
+        if
+          opts.data.method ~= 'textDocument/didChange'
+          and opts.data.method ~= 'textDocument/didOpen'
+        then
+          return
+        end
+        if bufstates[bufnr] and bufstates[bufnr].enabled then
+          util._refresh('textDocument/diagnostic', { bufnr = bufnr, only_visible = true })
+        end
+      end,
+      group = augroup,
+    })
+
+    api.nvim_buf_attach(bufnr, false, {
+      on_reload = function()
+        if bufstates[bufnr] and bufstates[bufnr].enabled then
+          util._refresh('textDocument/diagnostic', { bufnr = bufnr })
+        end
+      end,
+      on_detach = function()
+        disable(bufnr)
+      end,
+    })
+
+    api.nvim_create_autocmd('LspDetach', {
+      buffer = bufnr,
+      callback = function()
+        disable(bufnr)
+      end,
+      group = augroup,
+    })
+  else
+    bufstates[bufnr].enabled = true
   end
-
-  _autocmd_ids[bufnr] = api.nvim_create_autocmd('LspNotify', {
-    buffer = bufnr,
-    callback = function(opts)
-      if opts.data.method ~= 'textDocument/didChange' then
-        return
-      end
-      util._refresh('textDocument/diagnostic', { bufnr = bufnr, only_visible = true })
-    end,
-    group = augroup,
-  })
-
-  api.nvim_buf_attach(bufnr, false, {
-    on_reload = function()
-      util._refresh('textDocument/diagnostic', { bufnr = bufnr })
-    end,
-    on_detach = function()
-      disable(bufnr)
-    end,
-  })
-
-  api.nvim_create_autocmd('LspDetach', {
-    buffer = bufnr,
-    callback = function()
-      disable(bufnr)
-    end,
-    once = true,
-    group = augroup,
-  })
 end
 
 return M
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 912ce6898e..2bf0fb9cb2 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -3,12 +3,12 @@ local log = require('vim.lsp.log')
 local api = vim.api
 local M = {}
 
----@class lsp._inlay_hint.bufstate
+---@class lsp.inlay_hint.bufstate
 ---@field version integer
 ---@field client_hint table<integer, table<integer, lsp.InlayHint[]>> client_id -> (lnum -> hints)
 ---@field applied table<integer, integer> Last version of hints applied to this line
----@field autocmd_id integer The autocmd id for the buffer
----@type table<integer, lsp._inlay_hint.bufstate>
+---@field enabled boolean Whether inlay hints are enabled for this buffer
+---@type table<integer, lsp.inlay_hint.bufstate>
 local bufstates = {}
 
 local namespace = api.nvim_create_namespace('vim_lsp_inlayhint')
@@ -31,6 +31,9 @@ function M.on_inlayhint(err, result, ctx, _)
     return
   end
   local bufstate = bufstates[bufnr]
+  if not bufstate or not bufstate.enabled then
+    return
+  end
   if not (bufstate.client_hint and bufstate.version) then
     bufstate.client_hint = vim.defaulttable()
     bufstate.version = ctx.version
@@ -122,10 +125,9 @@ local function disable(bufnr)
     bufnr = api.nvim_get_current_buf()
   end
   clear(bufnr)
-  if bufstates[bufnr] and bufstates[bufnr].autocmd_id then
-    api.nvim_del_autocmd(bufstates[bufnr].autocmd_id)
+  if bufstates[bufnr] then
+    bufstates[bufnr] = { enabled = false, applied = {} }
   end
-  bufstates[bufnr] = nil
 end
 
 --- Enable inlay hints for a buffer
@@ -136,24 +138,27 @@ local function enable(bufnr)
   end
   local bufstate = bufstates[bufnr]
   if not bufstate then
-    bufstates[bufnr] = { applied = {} }
-    bufstates[bufnr].autocmd_id = api.nvim_create_autocmd('LspNotify', {
+    bufstates[bufnr] = { applied = {}, enabled = true }
+    api.nvim_create_autocmd('LspNotify', {
       buffer = bufnr,
       callback = function(opts)
-        if opts.data.method ~= 'textDocument/didChange' then
+        if
+          opts.data.method ~= 'textDocument/didChange'
+          and opts.data.method ~= 'textDocument/didOpen'
+        then
           return
         end
-        if bufstates[bufnr] then
+        if bufstates[bufnr] and bufstates[bufnr].enabled then
           util._refresh('textDocument/inlayHint', { bufnr = bufnr })
         end
       end,
       group = augroup,
     })
     util._refresh('textDocument/inlayHint', { bufnr = bufnr })
-    api.nvim_buf_attach(bufnr, true, {
+    api.nvim_buf_attach(bufnr, false, {
       on_reload = function(_, cb_bufnr)
         clear(cb_bufnr)
-        if bufstates[cb_bufnr] then
+        if bufstates[cb_bufnr] and bufstates[cb_bufnr].enabled then
           bufstates[cb_bufnr].applied = {}
           util._refresh('textDocument/inlayHint', { bufnr = cb_bufnr })
         end
@@ -167,9 +172,11 @@ local function enable(bufnr)
       callback = function()
         disable(bufnr)
       end,
-      once = true,
       group = augroup,
     })
+  else
+    bufstate.enabled = true
+    util._refresh('textDocument/inlayHint', { bufnr = bufnr })
   end
 end
 
@@ -180,7 +187,7 @@ local function toggle(bufnr)
     bufnr = api.nvim_get_current_buf()
   end
   local bufstate = bufstates[bufnr]
-  if bufstate then
+  if bufstate and bufstate.enabled then
     disable(bufnr)
   else
     enable(bufnr)
-- 
cgit 


From 48d533272e57e91e4d14c93b26d4922957f40cd7 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 1 Aug 2023 14:20:44 +0100
Subject: feat(lua-types): types for vim.api.* (#24523)

---
 runtime/lua/vim/_meta/api.lua         | 2178 +++++++++++++++++++++++++++++++++
 runtime/lua/vim/_meta/api_keysets.lua |  249 ++++
 runtime/lua/vim/_meta/vimfn.lua       |    1 +
 3 files changed, 2428 insertions(+)
 create mode 100644 runtime/lua/vim/_meta/api.lua
 create mode 100644 runtime/lua/vim/_meta/api_keysets.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
new file mode 100644
index 0000000000..3622ba5d19
--- /dev/null
+++ b/runtime/lua/vim/_meta/api.lua
@@ -0,0 +1,2178 @@
+--- @meta
+-- THIS FILE IS GENERATED
+-- DO NOT EDIT
+error('Cannot require a meta file')
+
+vim.api = {}
+
+--- @private
+--- @param buffer integer
+--- @param first integer
+--- @param last integer
+function vim.api.nvim__buf_redraw_range(buffer, first, last) end
+
+--- @private
+--- @param buffer integer
+--- @return table<string,any>
+function vim.api.nvim__buf_stats(buffer) end
+
+--- @private
+--- @return string
+function vim.api.nvim__get_lib_dir() end
+
+--- @private
+--- Find files in runtime directories
+---
+--- @param pat any[] pattern of files to search for
+--- @param all boolean whether to return all matches or only the first
+--- @param opts vim.api.keyset.runtime is_lua: only search Lua subdirs
+--- @return string[]
+function vim.api.nvim__get_runtime(pat, all, opts) end
+
+--- @private
+--- Returns object given as argument.
+--- This API function is used for testing. One should not rely on its presence
+--- in plugins.
+---
+--- @param obj any Object to return.
+--- @return any
+function vim.api.nvim__id(obj) end
+
+--- @private
+--- Returns array given as argument.
+--- This API function is used for testing. One should not rely on its presence
+--- in plugins.
+---
+--- @param arr any[] Array to return.
+--- @return any[]
+function vim.api.nvim__id_array(arr) end
+
+--- @private
+--- Returns dictionary given as argument.
+--- This API function is used for testing. One should not rely on its presence
+--- in plugins.
+---
+--- @param dct table<string,any> Dictionary to return.
+--- @return table<string,any>
+function vim.api.nvim__id_dictionary(dct) end
+
+--- @private
+--- Returns floating-point value given as argument.
+--- This API function is used for testing. One should not rely on its presence
+--- in plugins.
+---
+--- @param flt number Value to return.
+--- @return number
+function vim.api.nvim__id_float(flt) end
+
+--- @private
+--- @param grid integer
+--- @param row integer
+--- @param col integer
+--- @return any[]
+function vim.api.nvim__inspect_cell(grid, row, col) end
+
+--- @private
+--- @return any[]
+function vim.api.nvim__runtime_inspect() end
+
+--- @private
+--- @param path string
+function vim.api.nvim__screenshot(path) end
+
+--- @private
+--- Gets internal stats.
+---
+--- @return table<string,any>
+function vim.api.nvim__stats() end
+
+--- @private
+--- @param str string
+--- @return any
+function vim.api.nvim__unpack(str) end
+
+--- Adds a highlight to buffer.
+--- Useful for plugins that dynamically generate highlights to a buffer (like
+--- a semantic highlighter or linter). The function adds a single highlight to
+--- a buffer. Unlike `matchaddpos()` highlights follow changes to line
+--- numbering (as lines are inserted/removed above the highlighted line), like
+--- signs and marks do.
+--- Namespaces are used for batch deletion/updating of a set of highlights. To
+--- create a namespace, use `nvim_create_namespace()` which returns a
+--- namespace id. Pass it in to this function as `ns_id` to add highlights to
+--- the namespace. All highlights in the same namespace can then be cleared
+--- with single call to `nvim_buf_clear_namespace()`. If the highlight never
+--- will be deleted by an API call, pass `ns_id = -1`.
+--- As a shorthand, `ns_id = 0` can be used to create a new namespace for the
+--- highlight, the allocated id is then returned. If `hl_group` is the empty
+--- string no highlight is added, but a new `ns_id` is still returned. This is
+--- supported for backwards compatibility, new code should use
+--- `nvim_create_namespace()` to create a new empty namespace.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param ns_id integer namespace to use or -1 for ungrouped highlight
+--- @param hl_group string Name of the highlight group to use
+--- @param line integer Line to highlight (zero-indexed)
+--- @param col_start integer Start of (byte-indexed) column range to highlight
+--- @param col_end integer End of (byte-indexed) column range to highlight, or -1 to
+---                  highlight to end of line
+--- @return integer
+function vim.api.nvim_buf_add_highlight(buffer, ns_id, hl_group, line, col_start, col_end) end
+
+--- Activates buffer-update events on a channel, or as Lua callbacks.
+--- Example (Lua): capture buffer updates in a global `events` variable (use "vim.print(events)" to see its contents):
+--- ```lua
+---   events = {}
+---   vim.api.nvim_buf_attach(0, false, {
+---     on_lines=function(...) table.insert(events, {...}) end})
+--- ```
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param send_buffer boolean True if the initial notification should contain the
+---                    whole buffer: first notification will be
+---                    `nvim_buf_lines_event`. Else the first notification
+---                    will be `nvim_buf_changedtick_event`. Not for Lua
+---                    callbacks.
+--- @param opts table<string,function> Optional parameters.
+---                    • on_lines: Lua callback invoked on change. Return `true` to detach. Args:
+---                      • the string "lines"
+---                      • buffer handle
+---                      • b:changedtick
+---                      • first line that changed (zero-indexed)
+---                      • last line that was changed
+---                      • last line in the updated range
+---                      • byte count of previous contents
+---                      • deleted_codepoints (if `utf_sizes` is true)
+---                      • deleted_codeunits (if `utf_sizes` is true)
+---
+---                    • on_bytes: Lua callback invoked on change. This
+---                      callback receives more granular information about the
+---                      change compared to on_lines. Return `true` to detach. Args:
+---                      • the string "bytes"
+---                      • buffer handle
+---                      • b:changedtick
+---                      • start row of the changed text (zero-indexed)
+---                      • start column of the changed text
+---                      • byte offset of the changed text (from the start of
+---                        the buffer)
+---                      • old end row of the changed text
+---                      • old end column of the changed text
+---                      • old end byte length of the changed text
+---                      • new end row of the changed text
+---                      • new end column of the changed text
+---                      • new end byte length of the changed text
+---
+---                    • on_changedtick: Lua callback invoked on changedtick
+---                      increment without text change. Args:
+---                      • the string "changedtick"
+---                      • buffer handle
+---                      • b:changedtick
+---
+---                    • on_detach: Lua callback invoked on detach. Args:
+---                      • the string "detach"
+---                      • buffer handle
+---
+---                    • on_reload: Lua callback invoked on reload. The entire
+---                      buffer content should be considered changed. Args:
+---                      • the string "reload"
+---                      • buffer handle
+---
+---                    • utf_sizes: include UTF-32 and UTF-16 size of the
+---                      replaced region, as args to `on_lines`.
+---                    • preview: also attach to command preview (i.e.
+---                      'inccommand') events.
+--- @return boolean
+function vim.api.nvim_buf_attach(buffer, send_buffer, opts) end
+
+--- call a function with buffer as temporary current buffer
+--- This temporarily switches current buffer to "buffer". If the current
+--- window already shows "buffer", the window is not switched If a window
+--- inside the current tabpage (including a float) already shows the buffer
+--- One of these windows will be set as current window temporarily. Otherwise
+--- a temporary scratch window (called the "autocmd window" for historical
+--- reasons) will be used.
+--- This is useful e.g. to call Vimscript functions that only work with the
+--- current buffer/window currently, like `termopen()`.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param fun function Function to call inside the buffer (currently Lua callable
+---               only)
+--- @return any
+function vim.api.nvim_buf_call(buffer, fun) end
+
+--- @deprecated
+--- @param buffer integer
+--- @param ns_id integer
+--- @param line_start integer
+--- @param line_end integer
+function vim.api.nvim_buf_clear_highlight(buffer, ns_id, line_start, line_end) end
+
+--- Clears `namespace`d objects (highlights, `extmarks`, virtual text) from a
+--- region.
+--- Lines are 0-indexed. `api-indexing` To clear the namespace in the entire
+--- buffer, specify line_start=0 and line_end=-1.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param ns_id integer Namespace to clear, or -1 to clear all namespaces.
+--- @param line_start integer Start of range of lines to clear
+--- @param line_end integer End of range of lines to clear (exclusive) or -1 to
+---                   clear to end of buffer.
+function vim.api.nvim_buf_clear_namespace(buffer, ns_id, line_start, line_end) end
+
+--- Creates a buffer-local command `user-commands`.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer.
+--- @param name string
+--- @param command any
+--- @param opts vim.api.keyset.user_command
+function vim.api.nvim_buf_create_user_command(buffer, name, command, opts) end
+
+--- Removes an `extmark`.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param ns_id integer Namespace id from `nvim_create_namespace()`
+--- @param id integer Extmark id
+--- @return boolean
+function vim.api.nvim_buf_del_extmark(buffer, ns_id, id) end
+
+--- Unmaps a buffer-local `mapping` for the given mode.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param mode string
+--- @param lhs string
+function vim.api.nvim_buf_del_keymap(buffer, mode, lhs) end
+
+--- Deletes a named mark in the buffer. See `mark-motions`.
+---
+--- @param buffer integer Buffer to set the mark on
+--- @param name string Mark name
+--- @return boolean
+function vim.api.nvim_buf_del_mark(buffer, name) end
+
+--- Delete a buffer-local user-defined command.
+--- Only commands created with `:command-buffer` or
+--- `nvim_buf_create_user_command()` can be deleted with this function.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer.
+--- @param name string Name of the command to delete.
+function vim.api.nvim_buf_del_user_command(buffer, name) end
+
+--- Removes a buffer-scoped (b:) variable
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param name string Variable name
+function vim.api.nvim_buf_del_var(buffer, name) end
+
+--- Deletes the buffer. See `:bwipeout`
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param opts table<string,any> Optional parameters. Keys:
+---               • force: Force deletion and ignore unsaved changes.
+---               • unload: Unloaded only, do not delete. See `:bunload`
+function vim.api.nvim_buf_delete(buffer, opts) end
+
+--- Deactivates buffer-update events on the channel.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @return boolean
+function vim.api.nvim_buf_detach(buffer) end
+
+--- Gets a changed tick of a buffer
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @return integer
+function vim.api.nvim_buf_get_changedtick(buffer) end
+
+--- Gets a map of buffer-local `user-commands`.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param opts vim.api.keyset.get_commands Optional parameters. Currently not used.
+--- @return table<string,any>
+function vim.api.nvim_buf_get_commands(buffer, opts) end
+
+--- Gets the position (0-indexed) of an `extmark`.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param ns_id integer Namespace id from `nvim_create_namespace()`
+--- @param id integer Extmark id
+--- @param opts table<string,any> Optional parameters. Keys:
+---               • details: Whether to include the details dict
+---               • hl_name: Whether to include highlight group name instead
+---                 of id, true if omitted
+--- @return integer[]
+function vim.api.nvim_buf_get_extmark_by_id(buffer, ns_id, id, opts) end
+
+--- Gets `extmarks` in "traversal order" from a `charwise` region defined by
+--- buffer positions (inclusive, 0-indexed `api-indexing`).
+--- Region can be given as (row,col) tuples, or valid extmark ids (whose
+--- positions define the bounds). 0 and -1 are understood as (0,0) and (-1,-1)
+--- respectively, thus the following are equivalent:
+--- ```lua
+---   vim.api.nvim_buf_get_extmarks(0, my_ns, 0, -1, {})
+---   vim.api.nvim_buf_get_extmarks(0, my_ns, {0,0}, {-1,-1}, {})
+--- ```
+--- If `end` is less than `start`, traversal works backwards. (Useful with
+--- `limit`, to get the first marks prior to a given position.)
+--- Example:
+--- ```lua
+---   local api = vim.api
+---   local pos = api.nvim_win_get_cursor(0)
+---   local ns  = api.nvim_create_namespace('my-plugin')
+---   -- Create new extmark at line 1, column 1.
+---   local m1  = api.nvim_buf_set_extmark(0, ns, 0, 0, {})
+---   -- Create new extmark at line 3, column 1.
+---   local m2  = api.nvim_buf_set_extmark(0, ns, 2, 0, {})
+---   -- Get extmarks only from line 3.
+---   local ms  = api.nvim_buf_get_extmarks(0, ns, {2,0}, {2,0}, {})
+---   -- Get all marks in this buffer + namespace.
+---   local all = api.nvim_buf_get_extmarks(0, ns, 0, -1, {})
+---   vim.print(ms)
+--- ```
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param ns_id integer Namespace id from `nvim_create_namespace()` or -1 for all
+---               namespaces
+--- @param start any Start of range: a 0-indexed (row, col) or valid extmark id
+---               (whose position defines the bound). `api-indexing`
+--- @param end_ any End of range (inclusive): a 0-indexed (row, col) or valid
+---               extmark id (whose position defines the bound).
+---               `api-indexing`
+--- @param opts table<string,any> Optional parameters. Keys:
+---               • limit: Maximum number of marks to return
+---               • details: Whether to include the details dict
+---               • hl_name: Whether to include highlight group name instead
+---                 of id, true if omitted
+---               • type: Filter marks by type: "highlight", "sign",
+---                 "virt_text" and "virt_lines"
+--- @return any[]
+function vim.api.nvim_buf_get_extmarks(buffer, ns_id, start, end_, opts) end
+
+--- Gets a list of buffer-local `mapping` definitions.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param mode string Mode short-name ("n", "i", "v", ...)
+--- @return table<string,any>[]
+function vim.api.nvim_buf_get_keymap(buffer, mode) end
+
+--- Gets a line-range from the buffer.
+--- Indexing is zero-based, end-exclusive. Negative indices are interpreted as
+--- length+1+index: -1 refers to the index past the end. So to get the last
+--- element use start=-2 and end=-1.
+--- Out-of-bounds indices are clamped to the nearest valid value, unless
+--- `strict_indexing` is set.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param start integer First line index
+--- @param end_ integer Last line index, exclusive
+--- @param strict_indexing boolean Whether out-of-bounds should be an error.
+--- @return string[]
+function vim.api.nvim_buf_get_lines(buffer, start, end_, strict_indexing) end
+
+--- Returns a `(row,col)` tuple representing the position of the named mark.
+--- "End of line" column position is returned as `v:maxcol` (big number). See
+--- `mark-motions`.
+--- Marks are (1,0)-indexed. `api-indexing`
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param name string Mark name
+--- @return integer[]
+function vim.api.nvim_buf_get_mark(buffer, name) end
+
+--- Gets the full file name for the buffer
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @return string
+function vim.api.nvim_buf_get_name(buffer) end
+
+--- @deprecated
+--- @param buffer integer
+--- @return integer
+function vim.api.nvim_buf_get_number(buffer) end
+
+--- Returns the byte offset of a line (0-indexed). `api-indexing`
+--- Line 1 (index=0) has offset 0. UTF-8 bytes are counted. EOL is one byte.
+--- 'fileformat' and 'fileencoding' are ignored. The line index just after the
+--- last line gives the total byte-count of the buffer. A final EOL byte is
+--- counted if it would be written, see 'eol'.
+--- Unlike `line2byte()`, throws error for out-of-bounds indexing. Returns -1
+--- for unloaded buffer.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param index integer Line index
+--- @return integer
+function vim.api.nvim_buf_get_offset(buffer, index) end
+
+--- @param buffer integer
+--- @param name string
+--- @return any
+function vim.api.nvim_buf_get_option(buffer, name) end
+
+--- Gets a range from the buffer.
+--- This differs from `nvim_buf_get_lines()` in that it allows retrieving only
+--- portions of a line.
+--- Indexing is zero-based. Row indices are end-inclusive, and column indices
+--- are end-exclusive.
+--- Prefer `nvim_buf_get_lines()` when retrieving entire lines.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param start_row integer First line index
+--- @param start_col integer Starting column (byte offset) on first line
+--- @param end_row integer Last line index, inclusive
+--- @param end_col integer Ending column (byte offset) on last line, exclusive
+--- @param opts table<string,any> Optional parameters. Currently unused.
+--- @return string[]
+function vim.api.nvim_buf_get_text(buffer, start_row, start_col, end_row, end_col, opts) end
+
+--- Gets a buffer-scoped (b:) variable.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param name string Variable name
+--- @return any
+function vim.api.nvim_buf_get_var(buffer, name) end
+
+--- Checks if a buffer is valid and loaded. See `api-buffer` for more info
+--- about unloaded buffers.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @return boolean
+function vim.api.nvim_buf_is_loaded(buffer) end
+
+--- Checks if a buffer is valid.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @return boolean
+function vim.api.nvim_buf_is_valid(buffer) end
+
+--- Returns the number of lines in the given buffer.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @return integer
+function vim.api.nvim_buf_line_count(buffer) end
+
+--- Creates or updates an `extmark`.
+--- By default a new extmark is created when no id is passed in, but it is
+--- also possible to create a new mark by passing in a previously unused id or
+--- move an existing mark by passing in its id. The caller must then keep
+--- track of existing and unused ids itself. (Useful over RPC, to avoid
+--- waiting for the return value.)
+--- Using the optional arguments, it is possible to use this to highlight a
+--- range of text, and also to associate virtual text to the mark.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param ns_id integer Namespace id from `nvim_create_namespace()`
+--- @param line integer Line where to place the mark, 0-based. `api-indexing`
+--- @param col integer Column where to place the mark, 0-based. `api-indexing`
+--- @param opts vim.api.keyset.set_extmark Optional parameters.
+---               • id : id of the extmark to edit.
+---               • end_row : ending line of the mark, 0-based inclusive.
+---               • end_col : ending col of the mark, 0-based exclusive.
+---               • hl_group : name of the highlight group used to highlight
+---                 this mark.
+---               • hl_eol : when true, for a multiline highlight covering the
+---                 EOL of a line, continue the highlight for the rest of the
+---                 screen line (just like for diff and cursorline highlight).
+---               • virt_text : virtual text to link to this mark. A list of
+---                 [text, highlight] tuples, each representing a text chunk
+---                 with specified highlight. `highlight` element can either
+---                 be a single highlight group, or an array of multiple
+---                 highlight groups that will be stacked (highest priority
+---                 last). A highlight group can be supplied either as a
+---                 string or as an integer, the latter which can be obtained
+---                 using `nvim_get_hl_id_by_name()`.
+---               • virt_text_pos : position of virtual text. Possible values:
+---                 • "eol": right after eol character (default).
+---                 • "overlay": display over the specified column, without
+---                   shifting the underlying text.
+---                 • "right_align": display right aligned in the window.
+---                 • "inline": display at the specified column, and shift the
+---                   buffer text to the right as needed.
+---
+---               • virt_text_win_col : position the virtual text at a fixed
+---                 window column (starting from the first text column of the
+---                 screen line) instead of "virt_text_pos".
+---               • virt_text_hide : hide the virtual text when the background
+---                 text is selected or hidden because of scrolling with
+---                 'nowrap' or 'smoothscroll'. Currently only affects
+---                 "overlay" virt_text.
+---               • hl_mode : control how highlights are combined with the
+---                 highlights of the text. Currently only affects virt_text
+---                 highlights, but might affect `hl_group` in later versions.
+---                 • "replace": only show the virt_text color. This is the
+---                   default.
+---                 • "combine": combine with background text color.
+---                 • "blend": blend with background text color. Not supported
+---                   for "inline" virt_text.
+---
+---               • virt_lines : virtual lines to add next to this mark This
+---                 should be an array over lines, where each line in turn is
+---                 an array over [text, highlight] tuples. In general, buffer
+---                 and window options do not affect the display of the text.
+---                 In particular 'wrap' and 'linebreak' options do not take
+---                 effect, so the number of extra screen lines will always
+---                 match the size of the array. However the 'tabstop' buffer
+---                 option is still used for hard tabs. By default lines are
+---                 placed below the buffer line containing the mark.
+---               • virt_lines_above: place virtual lines above instead.
+---               • virt_lines_leftcol: Place extmarks in the leftmost column
+---                 of the window, bypassing sign and number columns.
+---               • ephemeral : for use with `nvim_set_decoration_provider()`
+---                 callbacks. The mark will only be used for the current
+---                 redraw cycle, and not be permantently stored in the
+---                 buffer.
+---               • right_gravity : boolean that indicates the direction the
+---                 extmark will be shifted in when new text is inserted (true
+---                 for right, false for left). Defaults to true.
+---               • end_right_gravity : boolean that indicates the direction
+---                 the extmark end position (if it exists) will be shifted in
+---                 when new text is inserted (true for right, false for
+---                 left). Defaults to false.
+---               • priority: a priority value for the highlight group or sign
+---                 attribute. For example treesitter highlighting uses a
+---                 value of 100.
+---               • strict: boolean that indicates extmark should not be
+---                 placed if the line or column value is past the end of the
+---                 buffer or end of the line respectively. Defaults to true.
+---               • sign_text: string of length 1-2 used to display in the
+---                 sign column. Note: ranges are unsupported and decorations
+---                 are only applied to start_row
+---               • sign_hl_group: name of the highlight group used to
+---                 highlight the sign column text. Note: ranges are
+---                 unsupported and decorations are only applied to start_row
+---               • number_hl_group: name of the highlight group used to
+---                 highlight the number column. Note: ranges are unsupported
+---                 and decorations are only applied to start_row
+---               • line_hl_group: name of the highlight group used to
+---                 highlight the whole line. Note: ranges are unsupported and
+---                 decorations are only applied to start_row
+---               • cursorline_hl_group: name of the highlight group used to
+---                 highlight the line when the cursor is on the same line as
+---                 the mark and 'cursorline' is enabled. Note: ranges are
+---                 unsupported and decorations are only applied to start_row
+---               • conceal: string which should be either empty or a single
+---                 character. Enable concealing similar to `:syn-conceal`.
+---                 When a character is supplied it is used as `:syn-cchar`.
+---                 "hl_group" is used as highlight for the cchar if provided,
+---                 otherwise it defaults to `hl-Conceal`.
+---               • spell: boolean indicating that spell checking should be
+---                 performed within this extmark
+---               • ui_watched: boolean that indicates the mark should be
+---                 drawn by a UI. When set, the UI will receive win_extmark
+---                 events. Note: the mark is positioned by virt_text
+---                 attributes. Can be used together with virt_text.
+--- @return integer
+function vim.api.nvim_buf_set_extmark(buffer, ns_id, line, col, opts) end
+
+--- Sets a buffer-local `mapping` for the given mode.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param mode string
+--- @param lhs string
+--- @param rhs string
+--- @param opts vim.api.keyset.keymap
+function vim.api.nvim_buf_set_keymap(buffer, mode, lhs, rhs, opts) end
+
+--- Sets (replaces) a line-range in the buffer.
+--- Indexing is zero-based, end-exclusive. Negative indices are interpreted as
+--- length+1+index: -1 refers to the index past the end. So to change or
+--- delete the last element use start=-2 and end=-1.
+--- To insert lines at a given index, set `start` and `end` to the same index.
+--- To delete a range of lines, set `replacement` to an empty array.
+--- Out-of-bounds indices are clamped to the nearest valid value, unless
+--- `strict_indexing` is set.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param start integer First line index
+--- @param end_ integer Last line index, exclusive
+--- @param strict_indexing boolean Whether out-of-bounds should be an error.
+--- @param replacement string[] Array of lines to use as replacement
+function vim.api.nvim_buf_set_lines(buffer, start, end_, strict_indexing, replacement) end
+
+--- Sets a named mark in the given buffer, all marks are allowed
+--- file/uppercase, visual, last change, etc. See `mark-motions`.
+--- Marks are (1,0)-indexed. `api-indexing`
+---
+--- @param buffer integer Buffer to set the mark on
+--- @param name string Mark name
+--- @param line integer Line number
+--- @param col integer Column/row number
+--- @param opts table<string,any> Optional parameters. Reserved for future use.
+--- @return boolean
+function vim.api.nvim_buf_set_mark(buffer, name, line, col, opts) end
+
+--- Sets the full file name for a buffer
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param name string Buffer name
+function vim.api.nvim_buf_set_name(buffer, name) end
+
+--- @param buffer integer
+--- @param name string
+--- @param value any
+function vim.api.nvim_buf_set_option(buffer, name, value) end
+
+--- Sets (replaces) a range in the buffer
+--- This is recommended over `nvim_buf_set_lines()` when only modifying parts
+--- of a line, as extmarks will be preserved on non-modified parts of the
+--- touched lines.
+--- Indexing is zero-based. Row indices are end-inclusive, and column indices
+--- are end-exclusive.
+--- To insert text at a given `(row, column)` location, use `start_row =
+--- end_row = row` and `start_col = end_col = col`. To delete the text in a
+--- range, use `replacement = {}`.
+--- Prefer `nvim_buf_set_lines()` if you are only adding or deleting entire
+--- lines.
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param start_row integer First line index
+--- @param start_col integer Starting column (byte offset) on first line
+--- @param end_row integer Last line index, inclusive
+--- @param end_col integer Ending column (byte offset) on last line, exclusive
+--- @param replacement string[] Array of lines to use as replacement
+function vim.api.nvim_buf_set_text(buffer, start_row, start_col, end_row, end_col, replacement) end
+
+--- Sets a buffer-scoped (b:) variable
+---
+--- @param buffer integer Buffer handle, or 0 for current buffer
+--- @param name string Variable name
+--- @param value any Variable value
+function vim.api.nvim_buf_set_var(buffer, name, value) end
+
+--- @deprecated
+--- @param buffer integer
+--- @param src_id integer
+--- @param line integer
+--- @param chunks any[]
+--- @param opts table<string,any>
+--- @return integer
+function vim.api.nvim_buf_set_virtual_text(buffer, src_id, line, chunks, opts) end
+
+--- Calls many API methods atomically.
+--- This has two main usages:
+--- 1. To perform several requests from an async context atomically, i.e.
+---    without interleaving redraws, RPC requests from other clients, or user
+---    interactions (however API methods may trigger autocommands or event
+---    processing which have such side effects, e.g. `:sleep` may wake
+---    timers).
+--- 2. To minimize RPC overhead (roundtrips) of a sequence of many requests.
+---
+---
+--- @param calls any[] an array of calls, where each call is described by an array
+---              with two elements: the request name, and an array of
+---              arguments.
+--- @return any[]
+function vim.api.nvim_call_atomic(calls) end
+
+--- Calls a Vimscript `Dictionary-function` with the given arguments.
+--- On execution error: fails with Vimscript error, updates v:errmsg.
+---
+--- @param dict any Dictionary, or String evaluating to a Vimscript `self` dict
+--- @param fn string Name of the function defined on the Vimscript dict
+--- @param args any[] Function arguments packed in an Array
+--- @return any
+function vim.api.nvim_call_dict_function(dict, fn, args) end
+
+--- Calls a Vimscript function with the given arguments.
+--- On execution error: fails with Vimscript error, updates v:errmsg.
+---
+--- @param fn string Function to call
+--- @param args any[] Function arguments packed in an Array
+--- @return any
+function vim.api.nvim_call_function(fn, args) end
+
+--- Send data to channel `id`. For a job, it writes it to the stdin of the
+--- process. For the stdio channel `channel-stdio`, it writes to Nvim's
+--- stdout. For an internal terminal instance (`nvim_open_term()`) it writes
+--- directly to terminal output. See `channel-bytes` for more information.
+--- This function writes raw data, not RPC messages. If the channel was
+--- created with `rpc=true` then the channel expects RPC messages, use
+--- `vim.rpcnotify()` and `vim.rpcrequest()` instead.
+---
+--- @param chan integer id of the channel
+--- @param data string data to write. 8-bit clean: can contain NUL bytes.
+function vim.api.nvim_chan_send(chan, data) end
+
+--- Clear all autocommands that match the corresponding {opts}. To delete a
+--- particular autocmd, see `nvim_del_autocmd()`.
+---
+--- @param opts vim.api.keyset.clear_autocmds Parameters
+---             • event: (string|table) Examples:
+---               • event: "pat1"
+---               • event: { "pat1" }
+---               • event: { "pat1", "pat2", "pat3" }
+---
+---             • pattern: (string|table)
+---               • pattern or patterns to match exactly.
+---                 • For example, if you have `*.py` as that pattern for the
+---                   autocmd, you must pass `*.py` exactly to clear it.
+---                   `test.py` will not match the pattern.
+---
+---               • defaults to clearing all patterns.
+---               • NOTE: Cannot be used with {buffer}
+---
+---             • buffer: (bufnr)
+---               • clear only `autocmd-buflocal` autocommands.
+---               • NOTE: Cannot be used with {pattern}
+---
+---             • group: (string|int) The augroup name or id.
+---               • NOTE: If not passed, will only delete autocmds not in any group.
+function vim.api.nvim_clear_autocmds(opts) end
+
+--- Executes an Ex command.
+--- Unlike `nvim_command()` this command takes a structured Dictionary instead
+--- of a String. This allows for easier construction and manipulation of an Ex
+--- command. This also allows for things such as having spaces inside a
+--- command argument, expanding filenames in a command that otherwise doesn't
+--- expand filenames, etc. Command arguments may also be Number, Boolean or
+--- String.
+--- The first argument may also be used instead of count for commands that
+--- support it in order to make their usage simpler with `vim.cmd()`. For
+--- example, instead of `vim.cmd.bdelete{ count = 2 }`, you may do
+--- `vim.cmd.bdelete(2)`.
+--- On execution error: fails with Vimscript error, updates v:errmsg.
+---
+--- @param cmd vim.api.keyset.cmd Command to execute. Must be a Dictionary that can contain the
+---             same values as the return value of `nvim_parse_cmd()` except
+---             "addr", "nargs" and "nextcmd" which are ignored if provided.
+---             All values except for "cmd" are optional.
+--- @param opts vim.api.keyset.cmd_opts Optional parameters.
+---             • output: (boolean, default false) Whether to return command
+---               output.
+--- @return string
+function vim.api.nvim_cmd(cmd, opts) end
+
+--- Executes an Ex command.
+--- On execution error: fails with Vimscript error, updates v:errmsg.
+--- Prefer using `nvim_cmd()` or `nvim_exec2()` over this. To evaluate
+--- multiple lines of Vim script or an Ex command directly, use
+--- `nvim_exec2()`. To construct an Ex command using a structured format and
+--- then execute it, use `nvim_cmd()`. To modify an Ex command before
+--- evaluating it, use `nvim_parse_cmd()` in conjunction with `nvim_cmd()`.
+---
+--- @param command string Ex command string
+function vim.api.nvim_command(command) end
+
+--- @deprecated
+--- @param command string
+--- @return string
+function vim.api.nvim_command_output(command) end
+
+--- Create or get an autocommand group `autocmd-groups`.
+--- To get an existing group id, do:
+--- ```lua
+---     local id = vim.api.nvim_create_augroup("MyGroup", {
+---         clear = false
+---     })
+--- ```
+---
+--- @param name string String: The name of the group
+--- @param opts vim.api.keyset.create_augroup Dictionary Parameters
+---             • clear (bool) optional: defaults to true. Clear existing
+---               commands if the group already exists `autocmd-groups`.
+--- @return integer
+function vim.api.nvim_create_augroup(name, opts) end
+
+--- Creates an `autocommand` event handler, defined by `callback` (Lua function or Vimscript function name string) or `command` (Ex command string).
+--- Example using Lua callback:
+--- ```lua
+---     vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, {
+---       pattern = {"*.c", "*.h"},
+---       callback = function(ev)
+---         print(string.format('event fired: %s', vim.inspect(ev)))
+---       end
+---     })
+--- ```
+--- Example using an Ex command as the handler:
+--- ```lua
+---     vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, {
+---       pattern = {"*.c", "*.h"},
+---       command = "echo 'Entering a C or C++ file'",
+---     })
+--- ```
+--- Note: `pattern` is NOT automatically expanded (unlike with `:autocmd`), thus names like
+--- "$HOME" and "~" must be expanded explicitly:
+--- ```lua
+---   pattern = vim.fn.expand("~") .. "/some/path/*.py"
+--- ```
+---
+--- @param event any (string|array) Event(s) that will trigger the handler
+---              (`callback` or `command`).
+--- @param opts vim.api.keyset.create_autocmd Options dict:
+---              • group (string|integer) optional: autocommand group name or
+---                id to match against.
+---              • pattern (string|array) optional: pattern(s) to match
+---                literally `autocmd-pattern`.
+---              • buffer (integer) optional: buffer number for buffer-local
+---                autocommands `autocmd-buflocal`. Cannot be used with
+---                {pattern}.
+---              • desc (string) optional: description (for documentation and
+---                troubleshooting).
+---              • callback (function|string) optional: Lua function (or
+---                Vimscript function name, if string) called when the
+---                event(s) is triggered. Lua callback can return true to
+---                delete the autocommand, and receives a table argument with
+---                these keys:
+---                • id: (number) autocommand id
+---                • event: (string) name of the triggered event
+---                  `autocmd-events`
+---                • group: (number|nil) autocommand group id, if any
+---                • match: (string) expanded value of `<amatch>`
+---                • buf: (number) expanded value of `<abuf>`
+---                • file: (string) expanded value of `<afile>`
+---                • data: (any) arbitrary data passed from
+---                  `nvim_exec_autocmds()`
+---
+---              • command (string) optional: Vim command to execute on event.
+---                Cannot be used with {callback}
+---              • once (boolean) optional: defaults to false. Run the
+---                autocommand only once `autocmd-once`.
+---              • nested (boolean) optional: defaults to false. Run nested
+---                autocommands `autocmd-nested`.
+--- @return integer
+function vim.api.nvim_create_autocmd(event, opts) end
+
+--- Creates a new, empty, unnamed buffer.
+---
+--- @param listed boolean Sets 'buflisted'
+--- @param scratch boolean Creates a "throwaway" `scratch-buffer` for temporary work
+---                (always 'nomodified'). Also sets 'nomodeline' on the
+---                buffer.
+--- @return integer
+function vim.api.nvim_create_buf(listed, scratch) end
+
+--- Creates a new namespace or gets an existing one. *namespace*
+--- Namespaces are used for buffer highlights and virtual text, see
+--- `nvim_buf_add_highlight()` and `nvim_buf_set_extmark()`.
+--- Namespaces can be named or anonymous. If `name` matches an existing
+--- namespace, the associated id is returned. If `name` is an empty string a
+--- new, anonymous namespace is created.
+---
+--- @param name string Namespace name or empty string
+--- @return integer
+function vim.api.nvim_create_namespace(name) end
+
+--- Creates a global `user-commands` command.
+--- For Lua usage see `lua-guide-commands-create`.
+--- Example:
+--- ```vim
+---    :call nvim_create_user_command('SayHello', 'echo "Hello world!"', {'bang': v:true})
+---    :SayHello
+---    Hello world!
+--- ```
+---
+--- @param name string Name of the new user command. Must begin with an uppercase
+---                letter.
+--- @param command any Replacement command to execute when this user command is
+---                executed. When called from Lua, the command can also be a
+---                Lua function. The function is called with a single table
+---                argument that contains the following keys:
+---                • name: (string) Command name
+---                • args: (string) The args passed to the command, if any
+---                  `<args>`
+---                • fargs: (table) The args split by unescaped whitespace
+---                  (when more than one argument is allowed), if any
+---                  `<f-args>`
+---                • nargs: (string) Number of arguments `:command-nargs`
+---                • bang: (boolean) "true" if the command was executed with a
+---                  ! modifier `<bang>`
+---                • line1: (number) The starting line of the command range
+---                  `<line1>`
+---                • line2: (number) The final line of the command range
+---                  `<line2>`
+---                • range: (number) The number of items in the command range:
+---                  0, 1, or 2 `<range>`
+---                • count: (number) Any count supplied `<count>`
+---                • reg: (string) The optional register, if specified `<reg>`
+---                • mods: (string) Command modifiers, if any `<mods>`
+---                • smods: (table) Command modifiers in a structured format.
+---                  Has the same structure as the "mods" key of
+---                  `nvim_parse_cmd()`.
+--- @param opts vim.api.keyset.user_command Optional `command-attributes`.
+---                • Set boolean attributes such as `:command-bang` or
+---                  `:command-bar` to true (but not `:command-buffer`, use
+---                  `nvim_buf_create_user_command()` instead).
+---                • "complete" `:command-complete` also accepts a Lua
+---                  function which works like
+---                  `:command-completion-customlist`.
+---                • Other parameters:
+---                  • desc: (string) Used for listing the command when a Lua
+---                    function is used for {command}.
+---                  • force: (boolean, default true) Override any previous
+---                    definition.
+---                  • preview: (function) Preview callback for 'inccommand'
+---                    `:command-preview`
+function vim.api.nvim_create_user_command(name, command, opts) end
+
+--- Delete an autocommand group by id.
+--- To get a group id one can use `nvim_get_autocmds()`.
+--- NOTE: behavior differs from `:augroup-delete`. When deleting a group,
+--- autocommands contained in this group will also be deleted and cleared.
+--- This group will no longer exist.
+---
+--- @param id integer Integer The id of the group.
+function vim.api.nvim_del_augroup_by_id(id) end
+
+--- Delete an autocommand group by name.
+--- NOTE: behavior differs from `:augroup-delete`. When deleting a group,
+--- autocommands contained in this group will also be deleted and cleared.
+--- This group will no longer exist.
+---
+--- @param name string String The name of the group.
+function vim.api.nvim_del_augroup_by_name(name) end
+
+--- Delete an autocommand by id.
+--- NOTE: Only autocommands created via the API have an id.
+---
+--- @param id integer Integer The id returned by nvim_create_autocmd
+function vim.api.nvim_del_autocmd(id) end
+
+--- Deletes the current line.
+---
+function vim.api.nvim_del_current_line() end
+
+--- Unmaps a global `mapping` for the given mode.
+--- To unmap a buffer-local mapping, use `nvim_buf_del_keymap()`.
+---
+--- @param mode string
+--- @param lhs string
+function vim.api.nvim_del_keymap(mode, lhs) end
+
+--- Deletes an uppercase/file named mark. See `mark-motions`.
+---
+--- @param name string Mark name
+--- @return boolean
+function vim.api.nvim_del_mark(name) end
+
+--- Delete a user-defined command.
+---
+--- @param name string Name of the command to delete.
+function vim.api.nvim_del_user_command(name) end
+
+--- Removes a global (g:) variable.
+---
+--- @param name string Variable name
+function vim.api.nvim_del_var(name) end
+
+--- Echo a message.
+---
+--- @param chunks any[] A list of [text, hl_group] arrays, each representing a text
+---                chunk with specified highlight. `hl_group` element can be
+---                omitted for no highlight.
+--- @param history boolean if true, add to `message-history`.
+--- @param opts vim.api.keyset.echo_opts Optional parameters.
+---                • verbose: Message was printed as a result of 'verbose'
+---                  option if Nvim was invoked with -V3log_file, the message
+---                  will be redirected to the log_file and suppressed from
+---                  direct output.
+function vim.api.nvim_echo(chunks, history, opts) end
+
+--- Writes a message to the Vim error buffer. Does not append "\n", the
+--- message is buffered (won't display) until a linefeed is written.
+---
+--- @param str string Message
+function vim.api.nvim_err_write(str) end
+
+--- Writes a message to the Vim error buffer. Appends "\n", so the buffer is
+--- flushed (and displayed).
+---
+--- @param str string Message
+function vim.api.nvim_err_writeln(str) end
+
+--- @param lvl integer
+--- @param data string
+function vim.api.nvim_error_event(lvl, data) end
+
+--- Evaluates a Vimscript `expression`. Dictionaries and Lists are recursively
+--- expanded.
+--- On execution error: fails with Vimscript error, updates v:errmsg.
+---
+--- @param expr string Vimscript expression string
+--- @return any
+function vim.api.nvim_eval(expr) end
+
+--- Evaluates statusline string.
+---
+--- @param str string Statusline string (see 'statusline').
+--- @param opts vim.api.keyset.eval_statusline Optional parameters.
+---             • winid: (number) `window-ID` of the window to use as context
+---               for statusline.
+---             • maxwidth: (number) Maximum width of statusline.
+---             • fillchar: (string) Character to fill blank spaces in the
+---               statusline (see 'fillchars'). Treated as single-width even
+---               if it isn't.
+---             • highlights: (boolean) Return highlight information.
+---             • use_winbar: (boolean) Evaluate winbar instead of statusline.
+---             • use_tabline: (boolean) Evaluate tabline instead of
+---               statusline. When true, {winid} is ignored. Mutually
+---               exclusive with {use_winbar}.
+---             • use_statuscol_lnum: (number) Evaluate statuscolumn for this
+---               line number instead of statusline.
+--- @return table<string,any>
+function vim.api.nvim_eval_statusline(str, opts) end
+
+--- @deprecated
+--- @param src string
+--- @param output boolean
+--- @return string
+function vim.api.nvim_exec(src, output) end
+
+--- Executes Vimscript (multiline block of Ex commands), like anonymous
+--- `:source`.
+--- Unlike `nvim_command()` this function supports heredocs, script-scope
+--- (s:), etc.
+--- On execution error: fails with Vimscript error, updates v:errmsg.
+---
+--- @param src string Vimscript code
+--- @param opts vim.api.keyset.exec_opts Optional parameters.
+---             • output: (boolean, default false) Whether to capture and
+---               return all (non-error, non-shell `:!`) output.
+--- @return table<string,any>
+function vim.api.nvim_exec2(src, opts) end
+
+--- Execute all autocommands for {event} that match the corresponding {opts}
+--- `autocmd-execute`.
+---
+--- @param event any (String|Array) The event or events to execute
+--- @param opts vim.api.keyset.exec_autocmds Dictionary of autocommand options:
+---              • group (string|integer) optional: the autocommand group name
+---                or id to match against. `autocmd-groups`.
+---              • pattern (string|array) optional: defaults to "*"
+---                `autocmd-pattern`. Cannot be used with {buffer}.
+---              • buffer (integer) optional: buffer number
+---                `autocmd-buflocal`. Cannot be used with {pattern}.
+---              • modeline (bool) optional: defaults to true. Process the
+---                modeline after the autocommands `<nomodeline>`.
+---              • data (any): arbitrary data to send to the autocommand
+---                callback. See `nvim_create_autocmd()` for details.
+function vim.api.nvim_exec_autocmds(event, opts) end
+
+--- Execute Lua code. Parameters (if any) are available as `...` inside the
+--- chunk. The chunk can return a value.
+--- Only statements are executed. To evaluate an expression, prefix it with
+--- `return`: return my_function(...)
+---
+--- @param code string Lua code to execute
+--- @param args any[] Arguments to the code
+--- @return any
+function vim.api.nvim_exec_lua(code, args) end
+
+--- @deprecated
+--- @param code string
+--- @param args any[]
+--- @return any
+function vim.api.nvim_execute_lua(code, args) end
+
+--- Sends input-keys to Nvim, subject to various quirks controlled by `mode`
+--- flags. This is a blocking call, unlike `nvim_input()`.
+--- On execution error: does not fail, but updates v:errmsg.
+--- To input sequences like <C-o> use `nvim_replace_termcodes()` (typically
+--- with escape_ks=false) to replace `keycodes`, then pass the result to
+--- nvim_feedkeys().
+--- Example:
+--- ```vim
+---     :let key = nvim_replace_termcodes("<C-o>", v:true, v:false, v:true)
+---     :call nvim_feedkeys(key, 'n', v:false)
+--- ```
+---
+--- @param keys string to be typed
+--- @param mode string behavior flags, see `feedkeys()`
+--- @param escape_ks boolean If true, escape K_SPECIAL bytes in `keys`. This should be
+---                  false if you already used `nvim_replace_termcodes()`, and
+---                  true otherwise.
+function vim.api.nvim_feedkeys(keys, mode, escape_ks) end
+
+--- Gets the option information for all options.
+--- The dictionary has the full option names as keys and option metadata
+--- dictionaries as detailed at `nvim_get_option_info2()`.
+---
+--- @return table<string,any>
+function vim.api.nvim_get_all_options_info() end
+
+--- Returns a 2-tuple (Array), where item 0 is the current channel id and item
+--- 1 is the `api-metadata` map (Dictionary).
+---
+--- @return any[]
+function vim.api.nvim_get_api_info() end
+
+--- Get all autocommands that match the corresponding {opts}.
+--- These examples will get autocommands matching ALL the given criteria:
+--- ```lua
+---   -- Matches all criteria
+---   autocommands = vim.api.nvim_get_autocmds({
+---     group = "MyGroup",
+---     event = {"BufEnter", "BufWinEnter"},
+---     pattern = {"*.c", "*.h"}
+---   })
+---
+---   -- All commands from one group
+---   autocommands = vim.api.nvim_get_autocmds({
+---     group = "MyGroup",
+---   })
+--- ```
+--- NOTE: When multiple patterns or events are provided, it will find all the
+--- autocommands that match any combination of them.
+---
+--- @param opts vim.api.keyset.get_autocmds Dictionary with at least one of the following:
+---             • group (string|integer): the autocommand group name or id to
+---               match against.
+---             • event (string|array): event or events to match against
+---               `autocmd-events`.
+---             • pattern (string|array): pattern or patterns to match against
+---               `autocmd-pattern`. Cannot be used with {buffer}
+---             • buffer: Buffer number or list of buffer numbers for buffer
+---               local autocommands `autocmd-buflocal`. Cannot be used with
+---               {pattern}
+--- @return any[]
+function vim.api.nvim_get_autocmds(opts) end
+
+--- Gets information about a channel.
+---
+--- @param chan integer
+--- @return table<string,any>
+function vim.api.nvim_get_chan_info(chan) end
+
+--- Returns the 24-bit RGB value of a `nvim_get_color_map()` color name or
+--- "#rrggbb" hexadecimal string.
+--- Example:
+--- ```vim
+---     :echo nvim_get_color_by_name("Pink")
+---     :echo nvim_get_color_by_name("#cbcbcb")
+--- ```
+---
+--- @param name string Color name or "#rrggbb" string
+--- @return integer
+function vim.api.nvim_get_color_by_name(name) end
+
+--- Returns a map of color names and RGB values.
+--- Keys are color names (e.g. "Aqua") and values are 24-bit RGB color values
+--- (e.g. 65535).
+---
+--- @return table<string,any>
+function vim.api.nvim_get_color_map() end
+
+--- Gets a map of global (non-buffer-local) Ex commands.
+--- Currently only `user-commands` are supported, not builtin Ex commands.
+---
+--- @param opts vim.api.keyset.get_commands Optional parameters. Currently only supports {"builtin":false}
+--- @return table<string,any>
+function vim.api.nvim_get_commands(opts) end
+
+--- Gets a map of the current editor state.
+---
+--- @param opts vim.api.keyset.context Optional parameters.
+---             • types: List of `context-types` ("regs", "jumps", "bufs",
+---               "gvars", …) to gather, or empty for "all".
+--- @return table<string,any>
+function vim.api.nvim_get_context(opts) end
+
+--- Gets the current buffer.
+---
+--- @return integer
+function vim.api.nvim_get_current_buf() end
+
+--- Gets the current line.
+---
+--- @return string
+function vim.api.nvim_get_current_line() end
+
+--- Gets the current tabpage.
+---
+--- @return integer
+function vim.api.nvim_get_current_tabpage() end
+
+--- Gets the current window.
+---
+--- @return integer
+function vim.api.nvim_get_current_win() end
+
+--- Gets all or specific highlight groups in a namespace.
+---
+--- @param ns_id integer Get highlight groups for namespace ns_id
+---              `nvim_get_namespaces()`. Use 0 to get global highlight groups
+---              `:highlight`.
+--- @param opts vim.api.keyset.get_highlight Options dict:
+---              • name: (string) Get a highlight definition by name.
+---              • id: (integer) Get a highlight definition by id.
+---              • link: (boolean, default true) Show linked group name
+---                instead of effective definition `:hi-link`.
+--- @return table<string,any>
+function vim.api.nvim_get_hl(ns_id, opts) end
+
+--- @deprecated
+--- @param hl_id integer
+--- @param rgb boolean
+--- @return table<string,any>
+function vim.api.nvim_get_hl_by_id(hl_id, rgb) end
+
+--- @deprecated
+--- @param name string
+--- @param rgb boolean
+--- @return table<string,any>
+function vim.api.nvim_get_hl_by_name(name, rgb) end
+
+--- Gets a highlight group by name
+--- similar to `hlID()`, but allocates a new ID if not present.
+---
+--- @param name string
+--- @return integer
+function vim.api.nvim_get_hl_id_by_name(name) end
+
+--- Gets a list of global (non-buffer-local) `mapping` definitions.
+---
+--- @param mode string Mode short-name ("n", "i", "v", ...)
+--- @return table<string,any>[]
+function vim.api.nvim_get_keymap(mode) end
+
+--- Returns a `(row, col, buffer, buffername)` tuple representing the position
+--- of the uppercase/file named mark. "End of line" column position is
+--- returned as `v:maxcol` (big number). See `mark-motions`.
+--- Marks are (1,0)-indexed. `api-indexing`
+---
+--- @param name string Mark name
+--- @param opts table<string,any> Optional parameters. Reserved for future use.
+--- @return any[]
+function vim.api.nvim_get_mark(name, opts) end
+
+--- Gets the current mode. `mode()` "blocking" is true if Nvim is waiting for
+--- input.
+---
+--- @return table<string,any>
+function vim.api.nvim_get_mode() end
+
+--- Gets existing, non-anonymous `namespace`s.
+---
+--- @return table<string,any>
+function vim.api.nvim_get_namespaces() end
+
+--- @param name string
+--- @return any
+function vim.api.nvim_get_option(name) end
+
+--- @param name string
+--- @return table<string,any>
+function vim.api.nvim_get_option_info(name) end
+
+--- Gets the option information for one option from arbitrary buffer or window
+--- Resulting dictionary has keys:
+--- • name: Name of the option (like 'filetype')
+--- • shortname: Shortened name of the option (like 'ft')
+--- • type: type of option ("string", "number" or "boolean")
+--- • default: The default value for the option
+--- • was_set: Whether the option was set.
+--- • last_set_sid: Last set script id (if any)
+--- • last_set_linenr: line number where option was set
+--- • last_set_chan: Channel where option was set (0 for local)
+--- • scope: one of "global", "win", or "buf"
+--- • global_local: whether win or buf option has a global value
+--- • commalist: List of comma separated values
+--- • flaglist: List of single char flags
+---
+--- When {scope} is not provided, the last set information applies to the
+--- local value in the current buffer or window if it is available, otherwise
+--- the global value information is returned. This behavior can be disabled by
+--- explicitly specifying {scope} in the {opts} table.
+---
+--- @param name string Option name
+--- @param opts vim.api.keyset.option Optional parameters
+---             • scope: One of "global" or "local". Analogous to `:setglobal`
+---               and `:setlocal`, respectively.
+---             • win: `window-ID`. Used for getting window local options.
+---             • buf: Buffer number. Used for getting buffer local options.
+---               Implies {scope} is "local".
+--- @return table<string,any>
+function vim.api.nvim_get_option_info2(name, opts) end
+
+--- Gets the value of an option. The behavior of this function matches that of
+--- `:set`: the local value of an option is returned if it exists; otherwise,
+--- the global value is returned. Local values always correspond to the
+--- current buffer or window, unless "buf" or "win" is set in {opts}.
+---
+--- @param name string Option name
+--- @param opts vim.api.keyset.option Optional parameters
+---             • scope: One of "global" or "local". Analogous to `:setglobal`
+---               and `:setlocal`, respectively.
+---             • win: `window-ID`. Used for getting window local options.
+---             • buf: Buffer number. Used for getting buffer local options.
+---               Implies {scope} is "local".
+---             • filetype: `filetype`. Used to get the default option for a
+---               specific filetype. Cannot be used with any other option.
+---               Note: this will trigger `ftplugin` and all `FileType`
+---               autocommands for the corresponding filetype.
+--- @return any
+function vim.api.nvim_get_option_value(name, opts) end
+
+--- Gets info describing process `pid`.
+---
+--- @param pid integer
+--- @return any
+function vim.api.nvim_get_proc(pid) end
+
+--- Gets the immediate children of process `pid`.
+---
+--- @param pid integer
+--- @return any[]
+function vim.api.nvim_get_proc_children(pid) end
+
+--- Find files in runtime directories
+--- "name" can contain wildcards. For example
+--- nvim_get_runtime_file("colors/*.vim", true) will return all color scheme
+--- files. Always use forward slashes (/) in the search pattern for
+--- subdirectories regardless of platform.
+--- It is not an error to not find any files. An empty array is returned then.
+---
+--- @param name string pattern of files to search for
+--- @param all boolean whether to return all matches or only the first
+--- @return string[]
+function vim.api.nvim_get_runtime_file(name, all) end
+
+--- Gets a global (g:) variable.
+---
+--- @param name string Variable name
+--- @return any
+function vim.api.nvim_get_var(name) end
+
+--- Gets a v: variable.
+---
+--- @param name string Variable name
+--- @return any
+function vim.api.nvim_get_vvar(name) end
+
+--- Queues raw user-input. Unlike `nvim_feedkeys()`, this uses a low-level
+--- input buffer and the call is non-blocking (input is processed
+--- asynchronously by the eventloop).
+--- On execution error: does not fail, but updates v:errmsg.
+---
+--- @param keys string to be typed
+--- @return integer
+function vim.api.nvim_input(keys) end
+
+--- Send mouse event from GUI.
+--- Non-blocking: does not wait on any result, but queues the event to be
+--- processed soon by the event loop.
+---
+--- @param button string Mouse button: one of "left", "right", "middle", "wheel",
+---                 "move".
+--- @param action string For ordinary buttons, one of "press", "drag", "release".
+---                 For the wheel, one of "up", "down", "left", "right".
+---                 Ignored for "move".
+--- @param modifier string String of modifiers each represented by a single char. The
+---                 same specifiers are used as for a key press, except that
+---                 the "-" separator is optional, so "C-A-", "c-a" and "CA"
+---                 can all be used to specify Ctrl+Alt+click.
+--- @param grid integer Grid number if the client uses `ui-multigrid`, else 0.
+--- @param row integer Mouse row-position (zero-based, like redraw events)
+--- @param col integer Mouse column-position (zero-based, like redraw events)
+function vim.api.nvim_input_mouse(button, action, modifier, grid, row, col) end
+
+--- Gets the current list of buffer handles
+--- Includes unlisted (unloaded/deleted) buffers, like `:ls!`. Use
+--- `nvim_buf_is_loaded()` to check if a buffer is loaded.
+---
+--- @return integer[]
+function vim.api.nvim_list_bufs() end
+
+--- Get information about all open channels.
+---
+--- @return any[]
+function vim.api.nvim_list_chans() end
+
+--- Gets the paths contained in `runtime-search-path`.
+---
+--- @return string[]
+function vim.api.nvim_list_runtime_paths() end
+
+--- Gets the current list of tabpage handles.
+---
+--- @return integer[]
+function vim.api.nvim_list_tabpages() end
+
+--- Gets a list of dictionaries representing attached UIs.
+---
+--- @return any[]
+function vim.api.nvim_list_uis() end
+
+--- Gets the current list of window handles.
+---
+--- @return integer[]
+function vim.api.nvim_list_wins() end
+
+--- Sets the current editor state from the given `context` map.
+---
+--- @param dict table<string,any> `Context` map.
+--- @return any
+function vim.api.nvim_load_context(dict) end
+
+--- Notify the user with a message
+--- Relays the call to vim.notify . By default forwards your message in the
+--- echo area but can be overridden to trigger desktop notifications.
+---
+--- @param msg string Message to display to the user
+--- @param log_level integer The log level
+--- @param opts table<string,any> Reserved for future use.
+--- @return any
+function vim.api.nvim_notify(msg, log_level, opts) end
+
+--- Open a terminal instance in a buffer
+--- By default (and currently the only option) the terminal will not be
+--- connected to an external process. Instead, input send on the channel will
+--- be echoed directly by the terminal. This is useful to display ANSI
+--- terminal sequences returned as part of a rpc message, or similar.
+--- Note: to directly initiate the terminal using the right size, display the
+--- buffer in a configured window before calling this. For instance, for a
+--- floating display, first create an empty buffer using `nvim_create_buf()`,
+--- then display it using `nvim_open_win()`, and then call this function. Then
+--- `nvim_chan_send()` can be called immediately to process sequences in a
+--- virtual terminal having the intended size.
+---
+--- @param buffer integer the buffer to use (expected to be empty)
+--- @param opts table<string,function> Optional parameters.
+---               • on_input: Lua callback for input sent, i e keypresses in
+---                 terminal mode. Note: keypresses are sent raw as they would
+---                 be to the pty master end. For instance, a carriage return
+---                 is sent as a "\r", not as a "\n". `textlock` applies. It
+---                 is possible to call `nvim_chan_send()` directly in the
+---                 callback however. ["input", term, bufnr, data]
+--- @return integer
+function vim.api.nvim_open_term(buffer, opts) end
+
+--- Open a new window.
+--- Currently this is used to open floating and external windows. Floats are
+--- windows that are drawn above the split layout, at some anchor position in
+--- some other window. Floats can be drawn internally or by external GUI with
+--- the `ui-multigrid` extension. External windows are only supported with
+--- multigrid GUIs, and are displayed as separate top-level windows.
+--- For a general overview of floats, see `api-floatwin`.
+--- Exactly one of `external` and `relative` must be specified. The `width`
+--- and `height` of the new window must be specified.
+--- With relative=editor (row=0,col=0) refers to the top-left corner of the
+--- screen-grid and (row=Lines-1,col=Columns-1) refers to the bottom-right
+--- corner. Fractional values are allowed, but the builtin implementation
+--- (used by non-multigrid UIs) will always round down to nearest integer.
+--- Out-of-bounds values, and configurations that make the float not fit
+--- inside the main editor, are allowed. The builtin implementation truncates
+--- values so floats are fully within the main screen grid. External GUIs
+--- could let floats hover outside of the main window like a tooltip, but this
+--- should not be used to specify arbitrary WM screen positions.
+--- Example (Lua): window-relative float
+--- ```lua
+---     vim.api.nvim_open_win(0, false,
+---       {relative='win', row=3, col=3, width=12, height=3})
+--- ```
+--- Example (Lua): buffer-relative float (travels as buffer is scrolled)
+--- ```lua
+---     vim.api.nvim_open_win(0, false,
+---       {relative='win', width=12, height=3, bufpos={100,10}})
+--- ```
+---
+--- @param buffer integer Buffer to display, or 0 for current buffer
+--- @param enter boolean Enter the window (make it the current window)
+--- @param config vim.api.keyset.float_config Map defining the window configuration. Keys:
+---               • relative: Sets the window layout to "floating", placed at
+---                 (row,col) coordinates relative to:
+---                 • "editor" The global editor grid
+---                 • "win" Window given by the `win` field, or current
+---                   window.
+---                 • "cursor" Cursor position in current window.
+---                 • "mouse" Mouse position
+---
+---               • win: `window-ID` for relative="win".
+---               • anchor: Decides which corner of the float to place at
+---                 (row,col):
+---                 • "NW" northwest (default)
+---                 • "NE" northeast
+---                 • "SW" southwest
+---                 • "SE" southeast
+---
+---               • width: Window width (in character cells). Minimum of 1.
+---               • height: Window height (in character cells). Minimum of 1.
+---               • bufpos: Places float relative to buffer text (only when
+---                 relative="win"). Takes a tuple of zero-indexed [line,
+---                 column]. `row` and `col` if given are applied relative to this position, else they
+---                 default to:
+---                 • `row=1` and `col=0` if `anchor` is "NW" or "NE"
+---                 • `row=0` and `col=0` if `anchor` is "SW" or "SE" (thus
+---                   like a tooltip near the buffer text).
+---
+---               • row: Row position in units of "screen cell height", may be
+---                 fractional.
+---               • col: Column position in units of "screen cell width", may
+---                 be fractional.
+---               • focusable: Enable focus by user actions (wincmds, mouse
+---                 events). Defaults to true. Non-focusable windows can be
+---                 entered by `nvim_set_current_win()`.
+---               • external: GUI should display the window as an external
+---                 top-level window. Currently accepts no other positioning
+---                 configuration together with this.
+---               • zindex: Stacking order. floats with higher `zindex` go on top on floats with lower indices. Must be larger
+---                 than zero. The following screen elements have hard-coded
+---                 z-indices:
+---                 • 100: insert completion popupmenu
+---                 • 200: message scrollback
+---                 • 250: cmdline completion popupmenu (when
+---                   wildoptions+=pum) The default value for floats are 50.
+---                   In general, values below 100 are recommended, unless
+---                   there is a good reason to overshadow builtin elements.
+---
+---               • style: (optional) Configure the appearance of the window.
+---                 Currently only supports one value:
+---                 • "minimal" Nvim will display the window with many UI
+---                   options disabled. This is useful when displaying a
+---                   temporary float where the text should not be edited.
+---                   Disables 'number', 'relativenumber', 'cursorline',
+---                   'cursorcolumn', 'foldcolumn', 'spell' and 'list'
+---                   options. 'signcolumn' is changed to `auto` and
+---                   'colorcolumn' is cleared. 'statuscolumn' is changed to
+---                   empty. The end-of-buffer region is hidden by setting
+---                   `eob` flag of 'fillchars' to a space char, and clearing
+---                   the `hl-EndOfBuffer` region in 'winhighlight'.
+---
+---               • border: Style of (optional) window border. This can either
+---                 be a string or an array. The string values are
+---                 • "none": No border (default).
+---                 • "single": A single line box.
+---                 • "double": A double line box.
+---                 • "rounded": Like "single", but with rounded corners ("╭"
+---                   etc.).
+---                 • "solid": Adds padding by a single whitespace cell.
+---                 • "shadow": A drop shadow effect by blending with the
+---                   background.
+---                 • If it is an array, it should have a length of eight or
+---                   any divisor of eight. The array will specifify the eight
+---                   chars building up the border in a clockwise fashion
+---                   starting with the top-left corner. As an example, the
+---                   double box style could be specified as [ "╔", "═" ,"╗",
+---                   "║", "╝", "═", "╚", "║" ]. If the number of chars are
+---                   less than eight, they will be repeated. Thus an ASCII
+---                   border could be specified as [ "/", "-", "\\", "|" ], or
+---                   all chars the same as [ "x" ]. An empty string can be
+---                   used to turn off a specific border, for instance, [ "",
+---                   "", "", ">", "", "", "", "<" ] will only make vertical
+---                   borders but not horizontal ones. By default,
+---                   `FloatBorder` highlight is used, which links to
+---                   `WinSeparator` when not defined. It could also be
+---                   specified by character: [ ["+", "MyCorner"], ["x",
+---                   "MyBorder"] ].
+---
+---               • title: Title (optional) in window border, String or list.
+---                 List is [text, highlight] tuples. if is string the default
+---                 highlight group is `FloatTitle`.
+---               • title_pos: Title position must set with title option.
+---                 value can be of `left` `center` `right` default is left.
+---               • noautocmd: If true then no buffer-related autocommand
+---                 events such as `BufEnter`, `BufLeave` or `BufWinEnter` may
+---                 fire from calling this function.
+--- @return integer
+function vim.api.nvim_open_win(buffer, enter, config) end
+
+--- Writes a message to the Vim output buffer. Does not append "\n", the
+--- message is buffered (won't display) until a linefeed is written.
+---
+--- @param str string Message
+function vim.api.nvim_out_write(str) end
+
+--- Parse command line.
+--- Doesn't check the validity of command arguments.
+---
+--- @param str string Command line string to parse. Cannot contain "\n".
+--- @param opts table<string,any> Optional parameters. Reserved for future use.
+--- @return table<string,any>
+function vim.api.nvim_parse_cmd(str, opts) end
+
+--- Parse a Vimscript expression.
+---
+--- @param expr string Expression to parse. Always treated as a single line.
+--- @param flags string Flags:
+---                  • "m" if multiple expressions in a row are allowed (only
+---                    the first one will be parsed),
+---                  • "E" if EOC tokens are not allowed (determines whether
+---                    they will stop parsing process or be recognized as an
+---                    operator/space, though also yielding an error).
+---                  • "l" when needing to start parsing with lvalues for
+---                    ":let" or ":for". Common flag sets:
+---                  • "m" to parse like for ":echo".
+---                  • "E" to parse like for "<C-r>=".
+---                  • empty string for ":call".
+---                  • "lm" to parse for ":let".
+--- @param highlight boolean If true, return value will also include "highlight" key
+---                  containing array of 4-tuples (arrays) (Integer, Integer,
+---                  Integer, String), where first three numbers define the
+---                  highlighted region and represent line, starting column
+---                  and ending column (latter exclusive: one should highlight
+---                  region [start_col, end_col)).
+--- @return table<string,any>
+function vim.api.nvim_parse_expression(expr, flags, highlight) end
+
+--- Pastes at cursor, in any mode.
+--- Invokes the `vim.paste` handler, which handles each mode appropriately.
+--- Sets redo/undo. Faster than `nvim_input()`. Lines break at LF ("\n").
+--- Errors ('nomodifiable', `vim.paste()` failure, …) are reflected in `err`
+--- but do not affect the return value (which is strictly decided by
+--- `vim.paste()`). On error, subsequent calls are ignored ("drained") until
+--- the next paste is initiated (phase 1 or -1).
+---
+--- @param data string Multiline input. May be binary (containing NUL bytes).
+--- @param crlf boolean Also break lines at CR and CRLF.
+--- @param phase integer -1: paste in a single call (i.e. without streaming). To
+---              "stream" a paste, call `nvim_paste` sequentially with these `phase` values:
+---              • 1: starts the paste (exactly once)
+---              • 2: continues the paste (zero or more times)
+---              • 3: ends the paste (exactly once)
+--- @return boolean
+function vim.api.nvim_paste(data, crlf, phase) end
+
+--- Puts text at cursor, in any mode.
+--- Compare `:put` and `p` which are always linewise.
+---
+--- @param lines string[] `readfile()`-style list of lines. `channel-lines`
+--- @param type string Edit behavior: any `getregtype()` result, or:
+---               • "b" `blockwise-visual` mode (may include width, e.g. "b3")
+---               • "c" `charwise` mode
+---               • "l" `linewise` mode
+---               • "" guess by contents, see `setreg()`
+--- @param after boolean If true insert after cursor (like `p`), or before (like
+---               `P`).
+--- @param follow boolean If true place cursor at end of inserted text.
+function vim.api.nvim_put(lines, type, after, follow) end
+
+--- Replaces terminal codes and `keycodes` (<CR>, <Esc>, ...) in a string with
+--- the internal representation.
+---
+--- @param str string String to be converted.
+--- @param from_part boolean Legacy Vim parameter. Usually true.
+--- @param do_lt boolean Also translate <lt>. Ignored if `special` is false.
+--- @param special boolean Replace `keycodes`, e.g. <CR> becomes a "\r" char.
+--- @return string
+function vim.api.nvim_replace_termcodes(str, from_part, do_lt, special) end
+
+--- Selects an item in the completion popup menu.
+--- If neither `ins-completion` nor `cmdline-completion` popup menu is active
+--- this API call is silently ignored. Useful for an external UI using
+--- `ui-popupmenu` to control the popup menu with the mouse. Can also be used
+--- in a mapping; use <Cmd> `:map-cmd` or a Lua mapping to ensure the mapping
+--- doesn't end completion mode.
+---
+--- @param item integer Index (zero-based) of the item to select. Value of -1
+---               selects nothing and restores the original text.
+--- @param insert boolean For `ins-completion`, whether the selection should be
+---               inserted in the buffer. Ignored for `cmdline-completion`.
+--- @param finish boolean Finish the completion and dismiss the popup menu. Implies
+---               {insert}.
+--- @param opts table<string,any> Optional parameters. Reserved for future use.
+function vim.api.nvim_select_popupmenu_item(item, insert, finish, opts) end
+
+--- Self-identifies the client.
+--- The client/plugin/application should call this after connecting, to
+--- provide hints about its identity and purpose, for debugging and
+--- orchestration.
+--- Can be called more than once; the caller should merge old info if
+--- appropriate. Example: library first identifies the channel, then a plugin
+--- using that library later identifies itself.
+---
+--- @param name string Short name for the connected client
+--- @param version table<string,any> Dictionary describing the version, with these (optional)
+---                   keys:
+---                   • "major" major version (defaults to 0 if not set, for
+---                     no release yet)
+---                   • "minor" minor version
+---                   • "patch" patch number
+---                   • "prerelease" string describing a prerelease, like
+---                     "dev" or "beta1"
+---                   • "commit" hash or similar identifier of commit
+--- @param type string Must be one of the following values. Client libraries
+---                   should default to "remote" unless overridden by the
+---                   user.
+---                   • "remote" remote client connected to Nvim.
+---                   • "ui" gui frontend
+---                   • "embedder" application using Nvim as a component (for
+---                     example, IDE/editor implementing a vim mode).
+---                   • "host" plugin host, typically started by nvim
+---                   • "plugin" single plugin, started by nvim
+--- @param methods table<string,any> Builtin methods in the client. For a host, this does not
+---                   include plugin methods which will be discovered later.
+---                   The key should be the method name, the values are dicts
+---                   with these (optional) keys (more keys may be added in
+---                   future versions of Nvim, thus unknown keys are ignored.
+---                   Clients must only use keys defined in this or later
+---                   versions of Nvim):
+---                   • "async" if true, send as a notification. If false or
+---                     unspecified, use a blocking request
+---                   • "nargs" Number of arguments. Could be a single integer
+---                     or an array of two integers, minimum and maximum
+---                     inclusive.
+--- @param attributes table<string,any> Arbitrary string:string map of informal client
+---                   properties. Suggested keys:
+---                   • "website": Client homepage URL (e.g. GitHub
+---                     repository)
+---                   • "license": License description ("Apache 2", "GPLv3",
+---                     "MIT", …)
+---                   • "logo": URI or path to image, preferably small logo or
+---                     icon. .png or .svg format is preferred.
+function vim.api.nvim_set_client_info(name, version, type, methods, attributes) end
+
+--- Sets the current buffer.
+---
+--- @param buffer integer Buffer handle
+function vim.api.nvim_set_current_buf(buffer) end
+
+--- Changes the global working directory.
+---
+--- @param dir string Directory path
+function vim.api.nvim_set_current_dir(dir) end
+
+--- Sets the current line.
+---
+--- @param line string Line contents
+function vim.api.nvim_set_current_line(line) end
+
+--- Sets the current tabpage.
+---
+--- @param tabpage integer Tabpage handle
+function vim.api.nvim_set_current_tabpage(tabpage) end
+
+--- Sets the current window.
+---
+--- @param window integer Window handle
+function vim.api.nvim_set_current_win(window) end
+
+--- Set or change decoration provider for a `namespace`
+--- This is a very general purpose interface for having Lua callbacks being
+--- triggered during the redraw code.
+--- The expected usage is to set `extmarks` for the currently redrawn buffer.
+--- `nvim_buf_set_extmark()` can be called to add marks on a per-window or
+--- per-lines basis. Use the `ephemeral` key to only use the mark for the
+--- current screen redraw (the callback will be called again for the next
+--- redraw ).
+--- Note: this function should not be called often. Rather, the callbacks
+--- themselves can be used to throttle unneeded callbacks. the `on_start`
+--- callback can return `false` to disable the provider until the next redraw.
+--- Similarly, return `false` in `on_win` will skip the `on_lines` calls for
+--- that window (but any extmarks set in `on_win` will still be used). A
+--- plugin managing multiple sources of decoration should ideally only set one
+--- provider, and merge the sources internally. You can use multiple `ns_id`
+--- for the extmarks set/modified inside the callback anyway.
+--- Note: doing anything other than setting extmarks is considered
+--- experimental. Doing things like changing options are not explicitly
+--- forbidden, but is likely to have unexpected consequences (such as 100% CPU
+--- consumption). doing `vim.rpcnotify` should be OK, but `vim.rpcrequest` is
+--- quite dubious for the moment.
+--- Note: It is not allowed to remove or update extmarks in 'on_line'
+--- callbacks.
+---
+--- @param ns_id integer Namespace id from `nvim_create_namespace()`
+--- @param opts vim.api.keyset.set_decoration_provider Table of callbacks:
+---              • on_start: called first on each screen redraw ["start",
+---                tick]
+---              • on_buf: called for each buffer being redrawn (before window
+---                callbacks) ["buf", bufnr, tick]
+---              • on_win: called when starting to redraw a specific window.
+---                ["win", winid, bufnr, topline, botline_guess]
+---              • on_line: called for each buffer line being redrawn. (The
+---                interaction with fold lines is subject to change) ["win",
+---                winid, bufnr, row]
+---              • on_end: called at the end of a redraw cycle ["end", tick]
+function vim.api.nvim_set_decoration_provider(ns_id, opts) end
+
+--- Sets a highlight group.
+---
+--- @param ns_id integer Namespace id for this highlight `nvim_create_namespace()`.
+---              Use 0 to set a highlight group globally `:highlight`.
+---              Highlights from non-global namespaces are not active by
+---              default, use `nvim_set_hl_ns()` or `nvim_win_set_hl_ns()` to
+---              activate them.
+--- @param name string Highlight group name, e.g. "ErrorMsg"
+--- @param val vim.api.keyset.highlight Highlight definition map, accepts the following keys:
+---              • fg (or foreground): color name or "#RRGGBB", see note.
+---              • bg (or background): color name or "#RRGGBB", see note.
+---              • sp (or special): color name or "#RRGGBB"
+---              • blend: integer between 0 and 100
+---              • bold: boolean
+---              • standout: boolean
+---              • underline: boolean
+---              • undercurl: boolean
+---              • underdouble: boolean
+---              • underdotted: boolean
+---              • underdashed: boolean
+---              • strikethrough: boolean
+---              • italic: boolean
+---              • reverse: boolean
+---              • nocombine: boolean
+---              • link: name of another highlight group to link to, see
+---                `:hi-link`.
+---              • default: Don't override existing definition `:hi-default`
+---              • ctermfg: Sets foreground of cterm color `ctermfg`
+---              • ctermbg: Sets background of cterm color `ctermbg`
+---              • cterm: cterm attribute map, like `highlight-args`. If not
+---                set, cterm attributes will match those from the attribute
+---                map documented above.
+function vim.api.nvim_set_hl(ns_id, name, val) end
+
+--- Set active namespace for highlights defined with `nvim_set_hl()`. This can
+--- be set for a single window, see `nvim_win_set_hl_ns()`.
+---
+--- @param ns_id integer the namespace to use
+function vim.api.nvim_set_hl_ns(ns_id) end
+
+--- Set active namespace for highlights defined with `nvim_set_hl()` while
+--- redrawing.
+--- This function meant to be called while redrawing, primarily from
+--- `nvim_set_decoration_provider()` on_win and on_line callbacks, which are
+--- allowed to change the namespace during a redraw cycle.
+---
+--- @param ns_id integer the namespace to activate
+function vim.api.nvim_set_hl_ns_fast(ns_id) end
+
+--- Sets a global `mapping` for the given mode.
+--- To set a buffer-local mapping, use `nvim_buf_set_keymap()`.
+--- Unlike `:map`, leading/trailing whitespace is accepted as part of the
+--- {lhs} or {rhs}. Empty {rhs} is `<Nop>`. `keycodes` are replaced as usual.
+--- Example:
+--- ```vim
+---     call nvim_set_keymap('n', ' <NL>', '', {'nowait': v:true})
+--- ```
+--- is equivalent to:
+--- ```vim
+---     nmap <nowait> <Space><NL> <Nop>
+--- ```
+---
+--- @param mode string Mode short-name (map command prefix: "n", "i", "v", "x", …) or
+---             "!" for `:map!`, or empty string for `:map`. "ia", "ca" or
+---             "!a" for abbreviation in Insert mode, Cmdline mode, or both,
+---             respectively
+--- @param lhs string Left-hand-side `{lhs}` of the mapping.
+--- @param rhs string Right-hand-side `{rhs}` of the mapping.
+--- @param opts vim.api.keyset.keymap Optional parameters map: Accepts all `:map-arguments` as keys
+---             except `<buffer>`, values are booleans (default false). Also:
+---             • "noremap" non-recursive mapping `:noremap`
+---             • "desc" human-readable description.
+---             • "callback" Lua function called in place of {rhs}.
+---             • "replace_keycodes" (boolean) When "expr" is true, replace
+---               keycodes in the resulting string (see
+---               `nvim_replace_termcodes()`). Returning nil from the Lua
+---               "callback" is equivalent to returning an empty string.
+function vim.api.nvim_set_keymap(mode, lhs, rhs, opts) end
+
+--- @param name string
+--- @param value any
+function vim.api.nvim_set_option(name, value) end
+
+--- Sets the value of an option. The behavior of this function matches that of
+--- `:set`: for global-local options, both the global and local value are set
+--- unless otherwise specified with {scope}.
+--- Note the options {win} and {buf} cannot be used together.
+---
+--- @param name string Option name
+--- @param value any New option value
+--- @param opts vim.api.keyset.option Optional parameters
+---              • scope: One of "global" or "local". Analogous to
+---                `:setglobal` and `:setlocal`, respectively.
+---              • win: `window-ID`. Used for setting window local option.
+---              • buf: Buffer number. Used for setting buffer local option.
+function vim.api.nvim_set_option_value(name, value, opts) end
+
+--- Sets a global (g:) variable.
+---
+--- @param name string Variable name
+--- @param value any Variable value
+function vim.api.nvim_set_var(name, value) end
+
+--- Sets a v: variable, if it is not readonly.
+---
+--- @param name string Variable name
+--- @param value any Variable value
+function vim.api.nvim_set_vvar(name, value) end
+
+--- Calculates the number of display cells occupied by `text`. Control
+--- characters including <Tab> count as one cell.
+---
+--- @param text string Some text
+--- @return integer
+function vim.api.nvim_strwidth(text) end
+
+--- Subscribes to event broadcasts.
+---
+--- @param event string Event type string
+function vim.api.nvim_subscribe(event) end
+
+--- Removes a tab-scoped (t:) variable
+---
+--- @param tabpage integer Tabpage handle, or 0 for current tabpage
+--- @param name string Variable name
+function vim.api.nvim_tabpage_del_var(tabpage, name) end
+
+--- Gets the tabpage number
+---
+--- @param tabpage integer Tabpage handle, or 0 for current tabpage
+--- @return integer
+function vim.api.nvim_tabpage_get_number(tabpage) end
+
+--- Gets a tab-scoped (t:) variable
+---
+--- @param tabpage integer Tabpage handle, or 0 for current tabpage
+--- @param name string Variable name
+--- @return any
+function vim.api.nvim_tabpage_get_var(tabpage, name) end
+
+--- Gets the current window in a tabpage
+---
+--- @param tabpage integer Tabpage handle, or 0 for current tabpage
+--- @return integer
+function vim.api.nvim_tabpage_get_win(tabpage) end
+
+--- Checks if a tabpage is valid
+---
+--- @param tabpage integer Tabpage handle, or 0 for current tabpage
+--- @return boolean
+function vim.api.nvim_tabpage_is_valid(tabpage) end
+
+--- Gets the windows in a tabpage
+---
+--- @param tabpage integer Tabpage handle, or 0 for current tabpage
+--- @return integer[]
+function vim.api.nvim_tabpage_list_wins(tabpage) end
+
+--- Sets a tab-scoped (t:) variable
+---
+--- @param tabpage integer Tabpage handle, or 0 for current tabpage
+--- @param name string Variable name
+--- @param value any Variable value
+function vim.api.nvim_tabpage_set_var(tabpage, name, value) end
+
+--- Activates UI events on the channel.
+--- Entry point of all UI clients. Allows `--embed` to continue startup.
+--- Implies that the client is ready to show the UI. Adds the client to the
+--- list of UIs. `nvim_list_uis()`
+---
+--- @param width integer Requested screen columns
+--- @param height integer Requested screen rows
+--- @param options table<string,any> `ui-option` map
+function vim.api.nvim_ui_attach(width, height, options) end
+
+--- Deactivates UI events on the channel.
+--- Removes the client from the list of UIs. `nvim_list_uis()`
+---
+function vim.api.nvim_ui_detach() end
+
+--- Tells Nvim the geometry of the popupmenu, to align floating windows with
+--- an external popup menu.
+--- Note that this method is not to be confused with
+--- `nvim_ui_pum_set_height()`, which sets the number of visible items in the
+--- popup menu, while this function sets the bounding box of the popup menu,
+--- including visual elements such as borders and sliders. Floats need not use
+--- the same font size, nor be anchored to exact grid corners, so one can set
+--- floating-point numbers to the popup menu geometry.
+---
+--- @param width number Popupmenu width.
+--- @param height number Popupmenu height.
+--- @param row number Popupmenu row.
+--- @param col number Popupmenu height.
+function vim.api.nvim_ui_pum_set_bounds(width, height, row, col) end
+
+--- Tells Nvim the number of elements displaying in the popupmenu, to decide
+--- <PageUp> and <PageDown> movement.
+---
+--- @param height integer Popupmenu height, must be greater than zero.
+function vim.api.nvim_ui_pum_set_height(height) end
+
+--- @param gained boolean
+function vim.api.nvim_ui_set_focus(gained) end
+
+--- @param name string
+--- @param value any
+function vim.api.nvim_ui_set_option(name, value) end
+
+--- @param width integer
+--- @param height integer
+function vim.api.nvim_ui_try_resize(width, height) end
+
+--- Tell Nvim to resize a grid. Triggers a grid_resize event with the
+--- requested grid size or the maximum size if it exceeds size limits.
+--- On invalid grid handle, fails with error.
+---
+--- @param grid integer The handle of the grid to be changed.
+--- @param width integer The new requested width.
+--- @param height integer The new requested height.
+function vim.api.nvim_ui_try_resize_grid(grid, width, height) end
+
+--- Unsubscribes to event broadcasts.
+---
+--- @param event string Event type string
+function vim.api.nvim_unsubscribe(event) end
+
+--- Calls a function with window as temporary current window.
+---
+--- @param window integer Window handle, or 0 for current window
+--- @param fun function Function to call inside the window (currently Lua callable
+---               only)
+--- @return any
+function vim.api.nvim_win_call(window, fun) end
+
+--- Closes the window (like `:close` with a `window-ID`).
+---
+--- @param window integer Window handle, or 0 for current window
+--- @param force boolean Behave like `:close!` The last window of a buffer with
+---               unwritten changes can be closed. The buffer will become
+---               hidden, even if 'hidden' is not set.
+function vim.api.nvim_win_close(window, force) end
+
+--- Removes a window-scoped (w:) variable
+---
+--- @param window integer Window handle, or 0 for current window
+--- @param name string Variable name
+function vim.api.nvim_win_del_var(window, name) end
+
+--- Gets the current buffer in a window
+---
+--- @param window integer Window handle, or 0 for current window
+--- @return integer
+function vim.api.nvim_win_get_buf(window) end
+
+--- Gets window configuration.
+--- The returned value may be given to `nvim_open_win()`.
+--- `relative` is empty for normal windows.
+---
+--- @param window integer Window handle, or 0 for current window
+--- @return table<string,any>
+function vim.api.nvim_win_get_config(window) end
+
+--- Gets the (1,0)-indexed, buffer-relative cursor position for a given window
+--- (different windows showing the same buffer have independent cursor
+--- positions). `api-indexing`
+---
+--- @param window integer Window handle, or 0 for current window
+--- @return integer[]
+function vim.api.nvim_win_get_cursor(window) end
+
+--- Gets the window height
+---
+--- @param window integer Window handle, or 0 for current window
+--- @return integer
+function vim.api.nvim_win_get_height(window) end
+
+--- Gets the window number
+---
+--- @param window integer Window handle, or 0 for current window
+--- @return integer
+function vim.api.nvim_win_get_number(window) end
+
+--- @param window integer
+--- @param name string
+--- @return any
+function vim.api.nvim_win_get_option(window, name) end
+
+--- Gets the window position in display cells. First position is zero.
+---
+--- @param window integer Window handle, or 0 for current window
+--- @return integer[]
+function vim.api.nvim_win_get_position(window) end
+
+--- Gets the window tabpage
+---
+--- @param window integer Window handle, or 0 for current window
+--- @return integer
+function vim.api.nvim_win_get_tabpage(window) end
+
+--- Gets a window-scoped (w:) variable
+---
+--- @param window integer Window handle, or 0 for current window
+--- @param name string Variable name
+--- @return any
+function vim.api.nvim_win_get_var(window, name) end
+
+--- Gets the window width
+---
+--- @param window integer Window handle, or 0 for current window
+--- @return integer
+function vim.api.nvim_win_get_width(window) end
+
+--- Closes the window and hide the buffer it contains (like `:hide` with a
+--- `window-ID`).
+--- Like `:hide` the buffer becomes hidden unless another window is editing
+--- it, or 'bufhidden' is `unload`, `delete` or `wipe` as opposed to `:close`
+--- or `nvim_win_close()`, which will close the buffer.
+---
+--- @param window integer Window handle, or 0 for current window
+function vim.api.nvim_win_hide(window) end
+
+--- Checks if a window is valid
+---
+--- @param window integer Window handle, or 0 for current window
+--- @return boolean
+function vim.api.nvim_win_is_valid(window) end
+
+--- Sets the current buffer in a window, without side effects
+---
+--- @param window integer Window handle, or 0 for current window
+--- @param buffer integer Buffer handle
+function vim.api.nvim_win_set_buf(window, buffer) end
+
+--- Configures window layout. Currently only for floating and external windows
+--- (including changing a split window to those layouts).
+--- When reconfiguring a floating window, absent option keys will not be
+--- changed. `row`/`col` and `relative` must be reconfigured together.
+---
+--- @param window integer Window handle, or 0 for current window
+--- @param config vim.api.keyset.float_config Map defining the window configuration, see `nvim_open_win()`
+function vim.api.nvim_win_set_config(window, config) end
+
+--- Sets the (1,0)-indexed cursor position in the window. `api-indexing` This
+--- scrolls the window even if it is not the current one.
+---
+--- @param window integer Window handle, or 0 for current window
+--- @param pos integer[] (row, col) tuple representing the new position
+function vim.api.nvim_win_set_cursor(window, pos) end
+
+--- Sets the window height.
+---
+--- @param window integer Window handle, or 0 for current window
+--- @param height integer Height as a count of rows
+function vim.api.nvim_win_set_height(window, height) end
+
+--- Set highlight namespace for a window. This will use highlights defined
+--- with `nvim_set_hl()` for this namespace, but fall back to global
+--- highlights (ns=0) when missing.
+--- This takes precedence over the 'winhighlight' option.
+---
+--- @param window integer
+--- @param ns_id integer the namespace to use
+function vim.api.nvim_win_set_hl_ns(window, ns_id) end
+
+--- @param window integer
+--- @param name string
+--- @param value any
+function vim.api.nvim_win_set_option(window, name, value) end
+
+--- Sets a window-scoped (w:) variable
+---
+--- @param window integer Window handle, or 0 for current window
+--- @param name string Variable name
+--- @param value any Variable value
+function vim.api.nvim_win_set_var(window, name, value) end
+
+--- Sets the window width. This will only succeed if the screen is split
+--- vertically.
+---
+--- @param window integer Window handle, or 0 for current window
+--- @param width integer Width as a count of columns
+function vim.api.nvim_win_set_width(window, width) end
+
+--- Computes the number of screen lines occupied by a range of text in a given
+--- window. Works for off-screen text and takes folds into account.
+--- Diff filler or virtual lines above a line are counted as a part of that
+--- line, unless the line is on "start_row" and "start_vcol" is specified.
+--- Diff filler or virtual lines below the last buffer line are counted in the
+--- result when "end_row" is omitted.
+--- Line indexing is similar to `nvim_buf_get_text()`.
+---
+--- @param window integer Window handle, or 0 for current window.
+--- @param opts vim.api.keyset.win_text_height Optional parameters:
+---               • start_row: Starting line index, 0-based inclusive. When
+---                 omitted start at the very top.
+---               • end_row: Ending line index, 0-based inclusive. When
+---                 omitted end at the very bottom.
+---               • start_vcol: Starting virtual column index on "start_row",
+---                 0-based inclusive, rounded down to full screen lines. When
+---                 omitted include the whole line.
+---               • end_vcol: Ending virtual column index on "end_row",
+---                 0-based exclusive, rounded up to full screen lines. When
+---                 omitted include the whole line.
+--- @return table<string,any>
+function vim.api.nvim_win_text_height(window, opts) end
diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
new file mode 100644
index 0000000000..184eb7a060
--- /dev/null
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -0,0 +1,249 @@
+--- @meta
+-- THIS FILE IS GENERATED
+-- DO NOT EDIT
+error('Cannot require a meta file')
+
+--- @class vim.api.keyset.clear_autocmds
+--- @field buffer any
+--- @field event any
+--- @field group any
+--- @field pattern any
+
+--- @class vim.api.keyset.cmd
+--- @field cmd any
+--- @field range any
+--- @field count any
+--- @field reg any
+--- @field bang any
+--- @field args any
+--- @field magic any
+--- @field mods any
+--- @field nargs any
+--- @field addr any
+--- @field nextcmd any
+
+--- @class vim.api.keyset.cmd_magic
+--- @field file any
+--- @field bar any
+
+--- @class vim.api.keyset.cmd_mods
+--- @field silent any
+--- @field emsg_silent any
+--- @field unsilent any
+--- @field filter any
+--- @field sandbox any
+--- @field noautocmd any
+--- @field browse any
+--- @field confirm any
+--- @field hide any
+--- @field horizontal any
+--- @field keepalt any
+--- @field keepjumps any
+--- @field keepmarks any
+--- @field keeppatterns any
+--- @field lockmarks any
+--- @field noswapfile any
+--- @field tab any
+--- @field verbose any
+--- @field vertical any
+--- @field split any
+
+--- @class vim.api.keyset.cmd_mods_filter
+--- @field pattern any
+--- @field force any
+
+--- @class vim.api.keyset.cmd_opts
+--- @field output any
+
+--- @class vim.api.keyset.context
+--- @field types any
+
+--- @class vim.api.keyset.create_augroup
+--- @field clear any
+
+--- @class vim.api.keyset.create_autocmd
+--- @field buffer any
+--- @field callback any
+--- @field command any
+--- @field desc any
+--- @field group any
+--- @field nested any
+--- @field once any
+--- @field pattern any
+
+--- @class vim.api.keyset.echo_opts
+--- @field verbose any
+
+--- @class vim.api.keyset.eval_statusline
+--- @field winid any
+--- @field maxwidth any
+--- @field fillchar any
+--- @field highlights any
+--- @field use_winbar any
+--- @field use_tabline any
+--- @field use_statuscol_lnum any
+
+--- @class vim.api.keyset.exec_autocmds
+--- @field buffer any
+--- @field group any
+--- @field modeline any
+--- @field pattern any
+--- @field data any
+
+--- @class vim.api.keyset.exec_opts
+--- @field output any
+
+--- @class vim.api.keyset.float_config
+--- @field row any
+--- @field col any
+--- @field width any
+--- @field height any
+--- @field anchor any
+--- @field relative any
+--- @field win any
+--- @field bufpos any
+--- @field external any
+--- @field focusable any
+--- @field zindex any
+--- @field border any
+--- @field title any
+--- @field title_pos any
+--- @field style any
+--- @field noautocmd any
+
+--- @class vim.api.keyset.get_autocmds
+--- @field event any
+--- @field group any
+--- @field pattern any
+--- @field buffer any
+
+--- @class vim.api.keyset.get_commands
+--- @field builtin any
+
+--- @class vim.api.keyset.get_highlight
+--- @field id any
+--- @field name any
+--- @field link any
+
+--- @class vim.api.keyset.highlight
+--- @field bold any
+--- @field standout any
+--- @field strikethrough any
+--- @field underline any
+--- @field undercurl any
+--- @field underdouble any
+--- @field underdotted any
+--- @field underdashed any
+--- @field italic any
+--- @field reverse any
+--- @field altfont any
+--- @field nocombine any
+--- @field default_ any
+--- @field cterm any
+--- @field foreground any
+--- @field fg any
+--- @field background any
+--- @field bg any
+--- @field ctermfg any
+--- @field ctermbg any
+--- @field special any
+--- @field sp any
+--- @field link any
+--- @field global_link any
+--- @field fallback any
+--- @field blend any
+--- @field fg_indexed any
+--- @field bg_indexed any
+
+--- @class vim.api.keyset.highlight_cterm
+--- @field bold any
+--- @field standout any
+--- @field strikethrough any
+--- @field underline any
+--- @field undercurl any
+--- @field underdouble any
+--- @field underdotted any
+--- @field underdashed any
+--- @field italic any
+--- @field reverse any
+--- @field altfont any
+--- @field nocombine any
+
+--- @class vim.api.keyset.keymap
+--- @field noremap any
+--- @field nowait any
+--- @field silent any
+--- @field script any
+--- @field expr any
+--- @field unique any
+--- @field callback any
+--- @field desc any
+--- @field replace_keycodes any
+
+--- @class vim.api.keyset.option
+--- @field scope any
+--- @field win any
+--- @field buf any
+--- @field filetype any
+
+--- @class vim.api.keyset.runtime
+--- @field is_lua any
+--- @field do_source any
+
+--- @class vim.api.keyset.set_decoration_provider
+--- @field on_start any
+--- @field on_buf any
+--- @field on_win any
+--- @field on_line any
+--- @field on_end any
+--- @field _on_hl_def any
+--- @field _on_spell_nav any
+
+--- @class vim.api.keyset.set_extmark
+--- @field id any
+--- @field end_line any
+--- @field end_row any
+--- @field end_col any
+--- @field hl_group any
+--- @field virt_text any
+--- @field virt_text_pos any
+--- @field virt_text_win_col any
+--- @field virt_text_hide any
+--- @field hl_eol any
+--- @field hl_mode any
+--- @field ephemeral any
+--- @field priority any
+--- @field right_gravity any
+--- @field end_right_gravity any
+--- @field virt_lines any
+--- @field virt_lines_above any
+--- @field virt_lines_leftcol any
+--- @field strict any
+--- @field sign_text any
+--- @field sign_hl_group any
+--- @field number_hl_group any
+--- @field line_hl_group any
+--- @field cursorline_hl_group any
+--- @field conceal any
+--- @field spell any
+--- @field ui_watched any
+
+--- @class vim.api.keyset.user_command
+--- @field addr any
+--- @field bang any
+--- @field bar any
+--- @field complete any
+--- @field count any
+--- @field desc any
+--- @field force any
+--- @field keepscript any
+--- @field nargs any
+--- @field preview any
+--- @field range any
+--- @field register_ any
+
+--- @class vim.api.keyset.win_text_height
+--- @field start_row any
+--- @field end_row any
+--- @field start_vcol any
+--- @field end_vcol any
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 8b56d8e708..261f349756 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -1,6 +1,7 @@
 --- @meta
 -- THIS FILE IS GENERATED
 -- DO NOT EDIT
+error('Cannot require a meta file')
 
 --- Return the absolute value of {expr}.  When {expr} evaluates to
 --- a |Float| abs() returns a |Float|.  When {expr} can be
-- 
cgit 


From da09f9b551badfb3fd363589009168560ae607f6 Mon Sep 17 00:00:00 2001
From: mathew <glepnir@neovim.pro>
Date: Fri, 28 Jul 2023 15:24:18 +0800
Subject: feat(gen_lsp.lua): protocol.Methods #24504

---
 runtime/lua/vim/lsp/protocol.lua       | 270 +++++++++++++++++++++++++++++++++
 runtime/lua/vim/lsp/types/protocol.lua |   2 +-
 2 files changed, 271 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 31cc071d18..e45baa59c5 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -923,4 +923,274 @@ function protocol.resolve_capabilities(server_capabilities)
   return server_capabilities
 end
 
+-- Generated by lsp_types.lua, keep at end of file.
+--- LSP method names.
+---
+---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#metaModel
+protocol.Methods = {
+  --- The initialize request is sent from the client to the server.
+  --- It is sent once as the request after starting up the server.
+  --- The requests parameter is of type {@link InitializeParams}
+  --- the response if of type {@link InitializeResult} of a Thenable that
+  --- resolves to such.
+  initialize = 'initialize',
+  --- A shutdown request is sent from the client to the server.
+  --- It is sent once when the client decides to shutdown the
+  --- server. The only notification that is sent after a shutdown request
+  --- is the exit event.
+  shutdown = 'shutdown',
+  --- The `client/registerCapability` request is sent from the server to the client to register a new capability
+  --- handler on the client side.
+  client_registerCapability = 'client/registerCapability',
+  --- The `client/unregisterCapability` request is sent from the server to the client to unregister a previously registered capability
+  --- handler on the client side.
+  client_unregisterCapability = 'client/unregisterCapability',
+  --- A request to resolve the implementation locations of a symbol at a given text
+  --- document position. The request's parameter is of type [TextDocumentPositionParams]
+  --- (#TextDocumentPositionParams) the response is of type {@link Definition} or a
+  --- Thenable that resolves to such.
+  textDocument_implementation = 'textDocument/implementation',
+  --- A request to resolve the type definition locations of a symbol at a given text
+  --- document position. The request's parameter is of type [TextDocumentPositionParams]
+  --- (#TextDocumentPositionParams) the response is of type {@link Definition} or a
+  --- Thenable that resolves to such.
+  textDocument_typeDefinition = 'textDocument/typeDefinition',
+  --- A request to list all color symbols found in a given text document. The request's
+  --- parameter is of type {@link DocumentColorParams} the
+  --- response is of type {@link ColorInformation ColorInformation[]} or a Thenable
+  --- that resolves to such.
+  textDocument_documentColor = 'textDocument/documentColor',
+  --- A request to list all presentation for a color. The request's
+  --- parameter is of type {@link ColorPresentationParams} the
+  --- response is of type {@link ColorInformation ColorInformation[]} or a Thenable
+  --- that resolves to such.
+  textDocument_colorPresentation = 'textDocument/colorPresentation',
+  --- A request to provide folding ranges in a document. The request's
+  --- parameter is of type {@link FoldingRangeParams}, the
+  --- response is of type {@link FoldingRangeList} or a Thenable
+  --- that resolves to such.
+  textDocument_foldingRange = 'textDocument/foldingRange',
+  --- A request to resolve the type definition locations of a symbol at a given text
+  --- document position. The request's parameter is of type [TextDocumentPositionParams]
+  --- (#TextDocumentPositionParams) the response is of type {@link Declaration}
+  --- or a typed array of {@link DeclarationLink} or a Thenable that resolves
+  --- to such.
+  textDocument_declaration = 'textDocument/declaration',
+  --- A request to provide selection ranges in a document. The request's
+  --- parameter is of type {@link SelectionRangeParams}, the
+  --- response is of type {@link SelectionRange SelectionRange[]} or a Thenable
+  --- that resolves to such.
+  textDocument_selectionRange = 'textDocument/selectionRange',
+  --- A request to result a `CallHierarchyItem` in a document at a given position.
+  --- Can be used as an input to an incoming or outgoing call hierarchy.
+  --- @since 3.16.0
+  textDocument_prepareCallHierarchy = 'textDocument/prepareCallHierarchy',
+  --- @since 3.16.0
+  textDocument_semanticTokens_full = 'textDocument/semanticTokens/full',
+  --- @since 3.16.0
+  textDocument_semanticTokens_full_delta = 'textDocument/semanticTokens/full/delta',
+  --- @since 3.16.0
+  textDocument_semanticTokens_range = 'textDocument/semanticTokens/range',
+  --- A request to provide ranges that can be edited together.
+  --- @since 3.16.0
+  textDocument_linkedEditingRange = 'textDocument/linkedEditingRange',
+  --- A request to get the moniker of a symbol at a given text document position.
+  --- The request parameter is of type {@link TextDocumentPositionParams}.
+  --- The response is of type {@link Moniker Moniker[]} or `null`.
+  textDocument_moniker = 'textDocument/moniker',
+  --- A request to result a `TypeHierarchyItem` in a document at a given position.
+  --- Can be used as an input to a subtypes or supertypes type hierarchy.
+  --- @since 3.17.0
+  textDocument_prepareTypeHierarchy = 'textDocument/prepareTypeHierarchy',
+  --- A request to provide inline values in a document. The request's parameter is of
+  --- type {@link InlineValueParams}, the response is of type
+  --- {@link InlineValue InlineValue[]} or a Thenable that resolves to such.
+  --- @since 3.17.0
+  textDocument_inlineValue = 'textDocument/inlineValue',
+  --- A request to provide inlay hints in a document. The request's parameter is of
+  --- type {@link InlayHintsParams}, the response is of type
+  --- {@link InlayHint InlayHint[]} or a Thenable that resolves to such.
+  --- @since 3.17.0
+  textDocument_inlayHint = 'textDocument/inlayHint',
+  --- The document diagnostic request definition.
+  --- @since 3.17.0
+  textDocument_diagnostic = 'textDocument/diagnostic',
+  --- A request to provide inline completions in a document. The request's parameter is of
+  --- type {@link InlineCompletionParams}, the response is of type
+  --- {@link InlineCompletion InlineCompletion[]} or a Thenable that resolves to such.
+  --- @since 3.18.0
+  textDocument_inlineCompletion = 'textDocument/inlineCompletion',
+  --- A document will save request is sent from the client to the server before
+  --- the document is actually saved. The request can return an array of TextEdits
+  --- which will be applied to the text document before it is saved. Please note that
+  --- clients might drop results if computing the text edits took too long or if a
+  --- server constantly fails on this request. This is done to keep the save fast and
+  --- reliable.
+  textDocument_willSaveWaitUntil = 'textDocument/willSaveWaitUntil',
+  --- Request to request completion at a given text document position. The request's
+  --- parameter is of type {@link TextDocumentPosition} the response
+  --- is of type {@link CompletionItem CompletionItem[]} or {@link CompletionList}
+  --- or a Thenable that resolves to such.
+  --- The request can delay the computation of the {@link CompletionItem.detail `detail`}
+  --- and {@link CompletionItem.documentation `documentation`} properties to the `completionItem/resolve`
+  --- request. However, properties that are needed for the initial sorting and filtering, like `sortText`,
+  --- `filterText`, `insertText`, and `textEdit`, must not be changed during resolve.
+  textDocument_completion = 'textDocument/completion',
+  --- Request to request hover information at a given text document position. The request's
+  --- parameter is of type {@link TextDocumentPosition} the response is of
+  --- type {@link Hover} or a Thenable that resolves to such.
+  textDocument_hover = 'textDocument/hover',
+  textDocument_signatureHelp = 'textDocument/signatureHelp',
+  --- A request to resolve the definition location of a symbol at a given text
+  --- document position. The request's parameter is of type [TextDocumentPosition]
+  --- (#TextDocumentPosition) the response is of either type {@link Definition}
+  --- or a typed array of {@link DefinitionLink} or a Thenable that resolves
+  --- to such.
+  textDocument_definition = 'textDocument/definition',
+  --- A request to resolve project-wide references for the symbol denoted
+  --- by the given text document position. The request's parameter is of
+  --- type {@link ReferenceParams} the response is of type
+  --- {@link Location Location[]} or a Thenable that resolves to such.
+  textDocument_references = 'textDocument/references',
+  --- Request to resolve a {@link DocumentHighlight} for a given
+  --- text document position. The request's parameter is of type [TextDocumentPosition]
+  --- (#TextDocumentPosition) the request response is of type [DocumentHighlight[]]
+  --- (#DocumentHighlight) or a Thenable that resolves to such.
+  textDocument_documentHighlight = 'textDocument/documentHighlight',
+  --- A request to list all symbols found in a given text document. The request's
+  --- parameter is of type {@link TextDocumentIdentifier} the
+  --- response is of type {@link SymbolInformation SymbolInformation[]} or a Thenable
+  --- that resolves to such.
+  textDocument_documentSymbol = 'textDocument/documentSymbol',
+  --- A request to provide commands for the given text document and range.
+  textDocument_codeAction = 'textDocument/codeAction',
+  --- A request to provide code lens for the given text document.
+  textDocument_codeLens = 'textDocument/codeLens',
+  --- A request to provide document links
+  textDocument_documentLink = 'textDocument/documentLink',
+  --- A request to to format a whole document.
+  textDocument_formatting = 'textDocument/formatting',
+  --- A request to format a range in a document.
+  textDocument_rangeFormatting = 'textDocument/rangeFormatting',
+  --- A request to format ranges in a document.
+  --- @since 3.18.0
+  --- @proposed
+  textDocument_rangesFormatting = 'textDocument/rangesFormatting',
+  --- A request to format a document on type.
+  textDocument_onTypeFormatting = 'textDocument/onTypeFormatting',
+  --- A request to rename a symbol.
+  textDocument_rename = 'textDocument/rename',
+  --- A request to test and perform the setup necessary for a rename.
+  --- @since 3.16 - support for default behavior
+  textDocument_prepareRename = 'textDocument/prepareRename',
+  --- The `workspace/workspaceFolders` is sent from the server to the client to fetch the open workspace folders.
+  workspace_workspaceFolders = 'workspace/workspaceFolders',
+  --- The 'workspace/configuration' request is sent from the server to the client to fetch a certain
+  --- configuration setting.
+  --- This pull model replaces the old push model were the client signaled configuration change via an
+  --- event. If the server still needs to react to configuration changes (since the server caches the
+  --- result of `workspace/configuration` requests) the server should register for an empty configuration
+  --- change event and empty the cache if such an event is received.
+  workspace_configuration = 'workspace/configuration',
+  --- @since 3.16.0
+  workspace_semanticTokens_refresh = 'workspace/semanticTokens/refresh',
+  --- The will create files request is sent from the client to the server before files are actually
+  --- created as long as the creation is triggered from within the client.
+  --- The request can return a `WorkspaceEdit` which will be applied to workspace before the
+  --- files are created. Hence the `WorkspaceEdit` can not manipulate the content of the file
+  --- to be created.
+  --- @since 3.16.0
+  workspace_willCreateFiles = 'workspace/willCreateFiles',
+  --- The will rename files request is sent from the client to the server before files are actually
+  --- renamed as long as the rename is triggered from within the client.
+  --- @since 3.16.0
+  workspace_willRenameFiles = 'workspace/willRenameFiles',
+  --- The did delete files notification is sent from the client to the server when
+  --- files were deleted from within the client.
+  --- @since 3.16.0
+  workspace_willDeleteFiles = 'workspace/willDeleteFiles',
+  --- @since 3.17.0
+  workspace_inlineValue_refresh = 'workspace/inlineValue/refresh',
+  --- @since 3.17.0
+  workspace_inlayHint_refresh = 'workspace/inlayHint/refresh',
+  --- The workspace diagnostic request definition.
+  --- @since 3.17.0
+  workspace_diagnostic = 'workspace/diagnostic',
+  --- The diagnostic refresh request definition.
+  --- @since 3.17.0
+  workspace_diagnostic_refresh = 'workspace/diagnostic/refresh',
+  --- A request to list project-wide symbols matching the query string given
+  --- by the {@link WorkspaceSymbolParams}. The response is
+  --- of type {@link SymbolInformation SymbolInformation[]} or a Thenable that
+  --- resolves to such.
+  --- @since 3.17.0 - support for WorkspaceSymbol in the returned data. Clients
+  ---  need to advertise support for WorkspaceSymbols via the client capability
+  ---  `workspace.symbol.resolveSupport`.
+  workspace_symbol = 'workspace/symbol',
+  --- A request to refresh all code actions
+  --- @since 3.16.0
+  workspace_codeLens_refresh = 'workspace/codeLens/refresh',
+  --- A request send from the client to the server to execute a command. The request might return
+  --- a workspace edit which the client will apply to the workspace.
+  workspace_executeCommand = 'workspace/executeCommand',
+  --- A request sent from the server to the client to modified certain resources.
+  workspace_applyEdit = 'workspace/applyEdit',
+  --- The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress
+  --- reporting from the server.
+  window_workDoneProgress_create = 'window/workDoneProgress/create',
+  --- A request to resolve the incoming calls for a given `CallHierarchyItem`.
+  --- @since 3.16.0
+  callHierarchy_incomingCalls = 'callHierarchy/incomingCalls',
+  --- A request to resolve the outgoing calls for a given `CallHierarchyItem`.
+  --- @since 3.16.0
+  callHierarchy_outgoingCalls = 'callHierarchy/outgoingCalls',
+  --- A request to show a document. This request might open an
+  --- external program depending on the value of the URI to open.
+  --- For example a request to open `https://code.visualstudio.com/`
+  --- will very likely open the URI in a WEB browser.
+  --- @since 3.16.0
+  window_showDocument = 'window/showDocument',
+  --- A request to resolve the supertypes for a given `TypeHierarchyItem`.
+  --- @since 3.17.0
+  typeHierarchy_supertypes = 'typeHierarchy/supertypes',
+  --- A request to resolve the subtypes for a given `TypeHierarchyItem`.
+  --- @since 3.17.0
+  typeHierarchy_subtypes = 'typeHierarchy/subtypes',
+  --- A request to resolve additional properties for an inlay hint.
+  --- The request's parameter is of type {@link InlayHint}, the response is
+  --- of type {@link InlayHint} or a Thenable that resolves to such.
+  --- @since 3.17.0
+  inlayHint_resolve = 'inlayHint/resolve',
+  --- The show message request is sent from the server to the client to show a message
+  --- and a set of options actions to the user.
+  window_showMessageRequest = 'window/showMessageRequest',
+  --- Request to resolve additional information for a given completion item.The request's
+  --- parameter is of type {@link CompletionItem} the response
+  --- is of type {@link CompletionItem} or a Thenable that resolves to such.
+  completionItem_resolve = 'completionItem/resolve',
+  --- Request to resolve additional information for a given code action.The request's
+  --- parameter is of type {@link CodeAction} the response
+  --- is of type {@link CodeAction} or a Thenable that resolves to such.
+  codeAction_resolve = 'codeAction/resolve',
+  --- A request to resolve the range inside the workspace
+  --- symbol's location.
+  --- @since 3.17.0
+  workspaceSymbol_resolve = 'workspaceSymbol/resolve',
+  --- A request to resolve a command for a given code lens.
+  codeLens_resolve = 'codeLens/resolve',
+  --- Request to resolve additional information for a given document link. The request's
+  --- parameter is of type {@link DocumentLink} the response
+  --- is of type {@link DocumentLink} or a Thenable that resolves to such.
+  documentLink_resolve = 'documentLink/resolve',
+}
+local function freeze(t)
+  return setmetatable({}, {
+    __index = t,
+    __newindex = function()
+      error('cannot modify immutable table')
+    end,
+  })
+end
+protocol.Methods = freeze(protocol.Methods)
+
 return protocol
diff --git a/runtime/lua/vim/lsp/types/protocol.lua b/runtime/lua/vim/lsp/types/protocol.lua
index 4b6660eb51..241d64e6e5 100644
--- a/runtime/lua/vim/lsp/types/protocol.lua
+++ b/runtime/lua/vim/lsp/types/protocol.lua
@@ -1,7 +1,7 @@
 --[[
 This file is autogenerated from scripts/lsp_types.lua
 Regenerate:
-nvim -l scripts/lsp_types.lua gen --runtime/lua/vim/lsp/types/protocol.lua
+nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/protocol.lua
 --]]
 
 ---@alias lsp.null nil
-- 
cgit 


From f41496ce74fb30c18bb9a03027a172800b269643 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Tue, 1 Aug 2023 15:52:53 +0200
Subject: feat(gen_lsp.lua): sort by name, handle failure #24504

---
 runtime/lua/vim/lsp/protocol.lua       | 362 ++++++++++++++++-----------------
 runtime/lua/vim/lsp/types/protocol.lua |  73 ++++---
 2 files changed, 215 insertions(+), 220 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index e45baa59c5..3844c697c6 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -923,110 +923,62 @@ function protocol.resolve_capabilities(server_capabilities)
   return server_capabilities
 end
 
--- Generated by lsp_types.lua, keep at end of file.
+-- Generated by gen_lsp.lua, keep at end of file.
 --- LSP method names.
 ---
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#metaModel
 protocol.Methods = {
+  --- A request to resolve the incoming calls for a given `CallHierarchyItem`.
+  --- @since 3.16.0
+  callHierarchy_incomingCalls = 'callHierarchy/incomingCalls',
+  --- A request to resolve the outgoing calls for a given `CallHierarchyItem`.
+  --- @since 3.16.0
+  callHierarchy_outgoingCalls = 'callHierarchy/outgoingCalls',
+  --- The `client/registerCapability` request is sent from the server to the client to register a new capability
+  --- handler on the client side.
+  client_registerCapability = 'client/registerCapability',
+  --- The `client/unregisterCapability` request is sent from the server to the client to unregister a previously registered capability
+  --- handler on the client side.
+  client_unregisterCapability = 'client/unregisterCapability',
+  --- Request to resolve additional information for a given code action.The request's
+  --- parameter is of type {@link CodeAction} the response
+  --- is of type {@link CodeAction} or a Thenable that resolves to such.
+  codeAction_resolve = 'codeAction/resolve',
+  --- A request to resolve a command for a given code lens.
+  codeLens_resolve = 'codeLens/resolve',
+  --- Request to resolve additional information for a given completion item.The request's
+  --- parameter is of type {@link CompletionItem} the response
+  --- is of type {@link CompletionItem} or a Thenable that resolves to such.
+  completionItem_resolve = 'completionItem/resolve',
+  --- Request to resolve additional information for a given document link. The request's
+  --- parameter is of type {@link DocumentLink} the response
+  --- is of type {@link DocumentLink} or a Thenable that resolves to such.
+  documentLink_resolve = 'documentLink/resolve',
   --- The initialize request is sent from the client to the server.
   --- It is sent once as the request after starting up the server.
   --- The requests parameter is of type {@link InitializeParams}
   --- the response if of type {@link InitializeResult} of a Thenable that
   --- resolves to such.
   initialize = 'initialize',
+  --- A request to resolve additional properties for an inlay hint.
+  --- The request's parameter is of type {@link InlayHint}, the response is
+  --- of type {@link InlayHint} or a Thenable that resolves to such.
+  --- @since 3.17.0
+  inlayHint_resolve = 'inlayHint/resolve',
   --- A shutdown request is sent from the client to the server.
   --- It is sent once when the client decides to shutdown the
   --- server. The only notification that is sent after a shutdown request
   --- is the exit event.
   shutdown = 'shutdown',
-  --- The `client/registerCapability` request is sent from the server to the client to register a new capability
-  --- handler on the client side.
-  client_registerCapability = 'client/registerCapability',
-  --- The `client/unregisterCapability` request is sent from the server to the client to unregister a previously registered capability
-  --- handler on the client side.
-  client_unregisterCapability = 'client/unregisterCapability',
-  --- A request to resolve the implementation locations of a symbol at a given text
-  --- document position. The request's parameter is of type [TextDocumentPositionParams]
-  --- (#TextDocumentPositionParams) the response is of type {@link Definition} or a
-  --- Thenable that resolves to such.
-  textDocument_implementation = 'textDocument/implementation',
-  --- A request to resolve the type definition locations of a symbol at a given text
-  --- document position. The request's parameter is of type [TextDocumentPositionParams]
-  --- (#TextDocumentPositionParams) the response is of type {@link Definition} or a
-  --- Thenable that resolves to such.
-  textDocument_typeDefinition = 'textDocument/typeDefinition',
-  --- A request to list all color symbols found in a given text document. The request's
-  --- parameter is of type {@link DocumentColorParams} the
-  --- response is of type {@link ColorInformation ColorInformation[]} or a Thenable
-  --- that resolves to such.
-  textDocument_documentColor = 'textDocument/documentColor',
+  --- A request to provide commands for the given text document and range.
+  textDocument_codeAction = 'textDocument/codeAction',
+  --- A request to provide code lens for the given text document.
+  textDocument_codeLens = 'textDocument/codeLens',
   --- A request to list all presentation for a color. The request's
   --- parameter is of type {@link ColorPresentationParams} the
   --- response is of type {@link ColorInformation ColorInformation[]} or a Thenable
   --- that resolves to such.
   textDocument_colorPresentation = 'textDocument/colorPresentation',
-  --- A request to provide folding ranges in a document. The request's
-  --- parameter is of type {@link FoldingRangeParams}, the
-  --- response is of type {@link FoldingRangeList} or a Thenable
-  --- that resolves to such.
-  textDocument_foldingRange = 'textDocument/foldingRange',
-  --- A request to resolve the type definition locations of a symbol at a given text
-  --- document position. The request's parameter is of type [TextDocumentPositionParams]
-  --- (#TextDocumentPositionParams) the response is of type {@link Declaration}
-  --- or a typed array of {@link DeclarationLink} or a Thenable that resolves
-  --- to such.
-  textDocument_declaration = 'textDocument/declaration',
-  --- A request to provide selection ranges in a document. The request's
-  --- parameter is of type {@link SelectionRangeParams}, the
-  --- response is of type {@link SelectionRange SelectionRange[]} or a Thenable
-  --- that resolves to such.
-  textDocument_selectionRange = 'textDocument/selectionRange',
-  --- A request to result a `CallHierarchyItem` in a document at a given position.
-  --- Can be used as an input to an incoming or outgoing call hierarchy.
-  --- @since 3.16.0
-  textDocument_prepareCallHierarchy = 'textDocument/prepareCallHierarchy',
-  --- @since 3.16.0
-  textDocument_semanticTokens_full = 'textDocument/semanticTokens/full',
-  --- @since 3.16.0
-  textDocument_semanticTokens_full_delta = 'textDocument/semanticTokens/full/delta',
-  --- @since 3.16.0
-  textDocument_semanticTokens_range = 'textDocument/semanticTokens/range',
-  --- A request to provide ranges that can be edited together.
-  --- @since 3.16.0
-  textDocument_linkedEditingRange = 'textDocument/linkedEditingRange',
-  --- A request to get the moniker of a symbol at a given text document position.
-  --- The request parameter is of type {@link TextDocumentPositionParams}.
-  --- The response is of type {@link Moniker Moniker[]} or `null`.
-  textDocument_moniker = 'textDocument/moniker',
-  --- A request to result a `TypeHierarchyItem` in a document at a given position.
-  --- Can be used as an input to a subtypes or supertypes type hierarchy.
-  --- @since 3.17.0
-  textDocument_prepareTypeHierarchy = 'textDocument/prepareTypeHierarchy',
-  --- A request to provide inline values in a document. The request's parameter is of
-  --- type {@link InlineValueParams}, the response is of type
-  --- {@link InlineValue InlineValue[]} or a Thenable that resolves to such.
-  --- @since 3.17.0
-  textDocument_inlineValue = 'textDocument/inlineValue',
-  --- A request to provide inlay hints in a document. The request's parameter is of
-  --- type {@link InlayHintsParams}, the response is of type
-  --- {@link InlayHint InlayHint[]} or a Thenable that resolves to such.
-  --- @since 3.17.0
-  textDocument_inlayHint = 'textDocument/inlayHint',
-  --- The document diagnostic request definition.
-  --- @since 3.17.0
-  textDocument_diagnostic = 'textDocument/diagnostic',
-  --- A request to provide inline completions in a document. The request's parameter is of
-  --- type {@link InlineCompletionParams}, the response is of type
-  --- {@link InlineCompletion InlineCompletion[]} or a Thenable that resolves to such.
-  --- @since 3.18.0
-  textDocument_inlineCompletion = 'textDocument/inlineCompletion',
-  --- A document will save request is sent from the client to the server before
-  --- the document is actually saved. The request can return an array of TextEdits
-  --- which will be applied to the text document before it is saved. Please note that
-  --- clients might drop results if computing the text edits took too long or if a
-  --- server constantly fails on this request. This is done to keep the save fast and
-  --- reliable.
-  textDocument_willSaveWaitUntil = 'textDocument/willSaveWaitUntil',
   --- Request to request completion at a given text document position. The request's
   --- parameter is of type {@link TextDocumentPosition} the response
   --- is of type {@link CompletionItem CompletionItem[]} or {@link CompletionList}
@@ -1036,55 +988,153 @@ protocol.Methods = {
   --- request. However, properties that are needed for the initial sorting and filtering, like `sortText`,
   --- `filterText`, `insertText`, and `textEdit`, must not be changed during resolve.
   textDocument_completion = 'textDocument/completion',
-  --- Request to request hover information at a given text document position. The request's
-  --- parameter is of type {@link TextDocumentPosition} the response is of
-  --- type {@link Hover} or a Thenable that resolves to such.
-  textDocument_hover = 'textDocument/hover',
-  textDocument_signatureHelp = 'textDocument/signatureHelp',
+  --- A request to resolve the type definition locations of a symbol at a given text
+  --- document position. The request's parameter is of type [TextDocumentPositionParams]
+  --- (#TextDocumentPositionParams) the response is of type {@link Declaration}
+  --- or a typed array of {@link DeclarationLink} or a Thenable that resolves
+  --- to such.
+  textDocument_declaration = 'textDocument/declaration',
   --- A request to resolve the definition location of a symbol at a given text
   --- document position. The request's parameter is of type [TextDocumentPosition]
   --- (#TextDocumentPosition) the response is of either type {@link Definition}
   --- or a typed array of {@link DefinitionLink} or a Thenable that resolves
   --- to such.
   textDocument_definition = 'textDocument/definition',
-  --- A request to resolve project-wide references for the symbol denoted
-  --- by the given text document position. The request's parameter is of
-  --- type {@link ReferenceParams} the response is of type
-  --- {@link Location Location[]} or a Thenable that resolves to such.
-  textDocument_references = 'textDocument/references',
+  --- The document diagnostic request definition.
+  --- @since 3.17.0
+  textDocument_diagnostic = 'textDocument/diagnostic',
+  --- A request to list all color symbols found in a given text document. The request's
+  --- parameter is of type {@link DocumentColorParams} the
+  --- response is of type {@link ColorInformation ColorInformation[]} or a Thenable
+  --- that resolves to such.
+  textDocument_documentColor = 'textDocument/documentColor',
   --- Request to resolve a {@link DocumentHighlight} for a given
   --- text document position. The request's parameter is of type [TextDocumentPosition]
   --- (#TextDocumentPosition) the request response is of type [DocumentHighlight[]]
   --- (#DocumentHighlight) or a Thenable that resolves to such.
   textDocument_documentHighlight = 'textDocument/documentHighlight',
+  --- A request to provide document links
+  textDocument_documentLink = 'textDocument/documentLink',
   --- A request to list all symbols found in a given text document. The request's
   --- parameter is of type {@link TextDocumentIdentifier} the
   --- response is of type {@link SymbolInformation SymbolInformation[]} or a Thenable
   --- that resolves to such.
   textDocument_documentSymbol = 'textDocument/documentSymbol',
-  --- A request to provide commands for the given text document and range.
-  textDocument_codeAction = 'textDocument/codeAction',
-  --- A request to provide code lens for the given text document.
-  textDocument_codeLens = 'textDocument/codeLens',
-  --- A request to provide document links
-  textDocument_documentLink = 'textDocument/documentLink',
-  --- A request to to format a whole document.
+  --- A request to provide folding ranges in a document. The request's
+  --- parameter is of type {@link FoldingRangeParams}, the
+  --- response is of type {@link FoldingRangeList} or a Thenable
+  --- that resolves to such.
+  textDocument_foldingRange = 'textDocument/foldingRange',
+  --- A request to format a whole document.
   textDocument_formatting = 'textDocument/formatting',
+  --- Request to request hover information at a given text document position. The request's
+  --- parameter is of type {@link TextDocumentPosition} the response is of
+  --- type {@link Hover} or a Thenable that resolves to such.
+  textDocument_hover = 'textDocument/hover',
+  --- A request to resolve the implementation locations of a symbol at a given text
+  --- document position. The request's parameter is of type [TextDocumentPositionParams]
+  --- (#TextDocumentPositionParams) the response is of type {@link Definition} or a
+  --- Thenable that resolves to such.
+  textDocument_implementation = 'textDocument/implementation',
+  --- A request to provide inlay hints in a document. The request's parameter is of
+  --- type {@link InlayHintsParams}, the response is of type
+  --- {@link InlayHint InlayHint[]} or a Thenable that resolves to such.
+  --- @since 3.17.0
+  textDocument_inlayHint = 'textDocument/inlayHint',
+  --- A request to provide inline completions in a document. The request's parameter is of
+  --- type {@link InlineCompletionParams}, the response is of type
+  --- {@link InlineCompletion InlineCompletion[]} or a Thenable that resolves to such.
+  --- @since 3.18.0
+  textDocument_inlineCompletion = 'textDocument/inlineCompletion',
+  --- A request to provide inline values in a document. The request's parameter is of
+  --- type {@link InlineValueParams}, the response is of type
+  --- {@link InlineValue InlineValue[]} or a Thenable that resolves to such.
+  --- @since 3.17.0
+  textDocument_inlineValue = 'textDocument/inlineValue',
+  --- A request to provide ranges that can be edited together.
+  --- @since 3.16.0
+  textDocument_linkedEditingRange = 'textDocument/linkedEditingRange',
+  --- A request to get the moniker of a symbol at a given text document position.
+  --- The request parameter is of type {@link TextDocumentPositionParams}.
+  --- The response is of type {@link Moniker Moniker[]} or `null`.
+  textDocument_moniker = 'textDocument/moniker',
+  --- A request to format a document on type.
+  textDocument_onTypeFormatting = 'textDocument/onTypeFormatting',
+  --- A request to result a `CallHierarchyItem` in a document at a given position.
+  --- Can be used as an input to an incoming or outgoing call hierarchy.
+  --- @since 3.16.0
+  textDocument_prepareCallHierarchy = 'textDocument/prepareCallHierarchy',
+  --- A request to test and perform the setup necessary for a rename.
+  --- @since 3.16 - support for default behavior
+  textDocument_prepareRename = 'textDocument/prepareRename',
+  --- A request to result a `TypeHierarchyItem` in a document at a given position.
+  --- Can be used as an input to a subtypes or supertypes type hierarchy.
+  --- @since 3.17.0
+  textDocument_prepareTypeHierarchy = 'textDocument/prepareTypeHierarchy',
   --- A request to format a range in a document.
   textDocument_rangeFormatting = 'textDocument/rangeFormatting',
   --- A request to format ranges in a document.
   --- @since 3.18.0
   --- @proposed
   textDocument_rangesFormatting = 'textDocument/rangesFormatting',
-  --- A request to format a document on type.
-  textDocument_onTypeFormatting = 'textDocument/onTypeFormatting',
+  --- A request to resolve project-wide references for the symbol denoted
+  --- by the given text document position. The request's parameter is of
+  --- type {@link ReferenceParams} the response is of type
+  --- {@link Location Location[]} or a Thenable that resolves to such.
+  textDocument_references = 'textDocument/references',
   --- A request to rename a symbol.
   textDocument_rename = 'textDocument/rename',
-  --- A request to test and perform the setup necessary for a rename.
-  --- @since 3.16 - support for default behavior
-  textDocument_prepareRename = 'textDocument/prepareRename',
-  --- The `workspace/workspaceFolders` is sent from the server to the client to fetch the open workspace folders.
-  workspace_workspaceFolders = 'workspace/workspaceFolders',
+  --- A request to provide selection ranges in a document. The request's
+  --- parameter is of type {@link SelectionRangeParams}, the
+  --- response is of type {@link SelectionRange SelectionRange[]} or a Thenable
+  --- that resolves to such.
+  textDocument_selectionRange = 'textDocument/selectionRange',
+  --- @since 3.16.0
+  textDocument_semanticTokens_full = 'textDocument/semanticTokens/full',
+  --- @since 3.16.0
+  textDocument_semanticTokens_full_delta = 'textDocument/semanticTokens/full/delta',
+  --- @since 3.16.0
+  textDocument_semanticTokens_range = 'textDocument/semanticTokens/range',
+  textDocument_signatureHelp = 'textDocument/signatureHelp',
+  --- A request to resolve the type definition locations of a symbol at a given text
+  --- document position. The request's parameter is of type [TextDocumentPositionParams]
+  --- (#TextDocumentPositionParams) the response is of type {@link Definition} or a
+  --- Thenable that resolves to such.
+  textDocument_typeDefinition = 'textDocument/typeDefinition',
+  --- A document will save request is sent from the client to the server before
+  --- the document is actually saved. The request can return an array of TextEdits
+  --- which will be applied to the text document before it is saved. Please note that
+  --- clients might drop results if computing the text edits took too long or if a
+  --- server constantly fails on this request. This is done to keep the save fast and
+  --- reliable.
+  textDocument_willSaveWaitUntil = 'textDocument/willSaveWaitUntil',
+  --- A request to resolve the subtypes for a given `TypeHierarchyItem`.
+  --- @since 3.17.0
+  typeHierarchy_subtypes = 'typeHierarchy/subtypes',
+  --- A request to resolve the supertypes for a given `TypeHierarchyItem`.
+  --- @since 3.17.0
+  typeHierarchy_supertypes = 'typeHierarchy/supertypes',
+  --- A request to show a document. This request might open an
+  --- external program depending on the value of the URI to open.
+  --- For example a request to open `https://code.visualstudio.com/`
+  --- will very likely open the URI in a WEB browser.
+  --- @since 3.16.0
+  window_showDocument = 'window/showDocument',
+  --- The show message request is sent from the server to the client to show a message
+  --- and a set of options actions to the user.
+  window_showMessageRequest = 'window/showMessageRequest',
+  --- The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress
+  --- reporting from the server.
+  window_workDoneProgress_create = 'window/workDoneProgress/create',
+  --- A request to resolve the range inside the workspace
+  --- symbol's location.
+  --- @since 3.17.0
+  workspaceSymbol_resolve = 'workspaceSymbol/resolve',
+  --- A request sent from the server to the client to modified certain resources.
+  workspace_applyEdit = 'workspace/applyEdit',
+  --- A request to refresh all code actions
+  --- @since 3.16.0
+  workspace_codeLens_refresh = 'workspace/codeLens/refresh',
   --- The 'workspace/configuration' request is sent from the server to the client to fetch a certain
   --- configuration setting.
   --- This pull model replaces the old push model were the client signaled configuration change via an
@@ -1092,33 +1142,21 @@ protocol.Methods = {
   --- result of `workspace/configuration` requests) the server should register for an empty configuration
   --- change event and empty the cache if such an event is received.
   workspace_configuration = 'workspace/configuration',
-  --- @since 3.16.0
-  workspace_semanticTokens_refresh = 'workspace/semanticTokens/refresh',
-  --- The will create files request is sent from the client to the server before files are actually
-  --- created as long as the creation is triggered from within the client.
-  --- The request can return a `WorkspaceEdit` which will be applied to workspace before the
-  --- files are created. Hence the `WorkspaceEdit` can not manipulate the content of the file
-  --- to be created.
-  --- @since 3.16.0
-  workspace_willCreateFiles = 'workspace/willCreateFiles',
-  --- The will rename files request is sent from the client to the server before files are actually
-  --- renamed as long as the rename is triggered from within the client.
-  --- @since 3.16.0
-  workspace_willRenameFiles = 'workspace/willRenameFiles',
-  --- The did delete files notification is sent from the client to the server when
-  --- files were deleted from within the client.
-  --- @since 3.16.0
-  workspace_willDeleteFiles = 'workspace/willDeleteFiles',
-  --- @since 3.17.0
-  workspace_inlineValue_refresh = 'workspace/inlineValue/refresh',
-  --- @since 3.17.0
-  workspace_inlayHint_refresh = 'workspace/inlayHint/refresh',
   --- The workspace diagnostic request definition.
   --- @since 3.17.0
   workspace_diagnostic = 'workspace/diagnostic',
   --- The diagnostic refresh request definition.
   --- @since 3.17.0
   workspace_diagnostic_refresh = 'workspace/diagnostic/refresh',
+  --- A request send from the client to the server to execute a command. The request might return
+  --- a workspace edit which the client will apply to the workspace.
+  workspace_executeCommand = 'workspace/executeCommand',
+  --- @since 3.17.0
+  workspace_inlayHint_refresh = 'workspace/inlayHint/refresh',
+  --- @since 3.17.0
+  workspace_inlineValue_refresh = 'workspace/inlineValue/refresh',
+  --- @since 3.16.0
+  workspace_semanticTokens_refresh = 'workspace/semanticTokens/refresh',
   --- A request to list project-wide symbols matching the query string given
   --- by the {@link WorkspaceSymbolParams}. The response is
   --- of type {@link SymbolInformation SymbolInformation[]} or a Thenable that
@@ -1127,61 +1165,23 @@ protocol.Methods = {
   ---  need to advertise support for WorkspaceSymbols via the client capability
   ---  `workspace.symbol.resolveSupport`.
   workspace_symbol = 'workspace/symbol',
-  --- A request to refresh all code actions
-  --- @since 3.16.0
-  workspace_codeLens_refresh = 'workspace/codeLens/refresh',
-  --- A request send from the client to the server to execute a command. The request might return
-  --- a workspace edit which the client will apply to the workspace.
-  workspace_executeCommand = 'workspace/executeCommand',
-  --- A request sent from the server to the client to modified certain resources.
-  workspace_applyEdit = 'workspace/applyEdit',
-  --- The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress
-  --- reporting from the server.
-  window_workDoneProgress_create = 'window/workDoneProgress/create',
-  --- A request to resolve the incoming calls for a given `CallHierarchyItem`.
+  --- The will create files request is sent from the client to the server before files are actually
+  --- created as long as the creation is triggered from within the client.
+  --- The request can return a `WorkspaceEdit` which will be applied to workspace before the
+  --- files are created. Hence the `WorkspaceEdit` can not manipulate the content of the file
+  --- to be created.
   --- @since 3.16.0
-  callHierarchy_incomingCalls = 'callHierarchy/incomingCalls',
-  --- A request to resolve the outgoing calls for a given `CallHierarchyItem`.
+  workspace_willCreateFiles = 'workspace/willCreateFiles',
+  --- The did delete files notification is sent from the client to the server when
+  --- files were deleted from within the client.
   --- @since 3.16.0
-  callHierarchy_outgoingCalls = 'callHierarchy/outgoingCalls',
-  --- A request to show a document. This request might open an
-  --- external program depending on the value of the URI to open.
-  --- For example a request to open `https://code.visualstudio.com/`
-  --- will very likely open the URI in a WEB browser.
+  workspace_willDeleteFiles = 'workspace/willDeleteFiles',
+  --- The will rename files request is sent from the client to the server before files are actually
+  --- renamed as long as the rename is triggered from within the client.
   --- @since 3.16.0
-  window_showDocument = 'window/showDocument',
-  --- A request to resolve the supertypes for a given `TypeHierarchyItem`.
-  --- @since 3.17.0
-  typeHierarchy_supertypes = 'typeHierarchy/supertypes',
-  --- A request to resolve the subtypes for a given `TypeHierarchyItem`.
-  --- @since 3.17.0
-  typeHierarchy_subtypes = 'typeHierarchy/subtypes',
-  --- A request to resolve additional properties for an inlay hint.
-  --- The request's parameter is of type {@link InlayHint}, the response is
-  --- of type {@link InlayHint} or a Thenable that resolves to such.
-  --- @since 3.17.0
-  inlayHint_resolve = 'inlayHint/resolve',
-  --- The show message request is sent from the server to the client to show a message
-  --- and a set of options actions to the user.
-  window_showMessageRequest = 'window/showMessageRequest',
-  --- Request to resolve additional information for a given completion item.The request's
-  --- parameter is of type {@link CompletionItem} the response
-  --- is of type {@link CompletionItem} or a Thenable that resolves to such.
-  completionItem_resolve = 'completionItem/resolve',
-  --- Request to resolve additional information for a given code action.The request's
-  --- parameter is of type {@link CodeAction} the response
-  --- is of type {@link CodeAction} or a Thenable that resolves to such.
-  codeAction_resolve = 'codeAction/resolve',
-  --- A request to resolve the range inside the workspace
-  --- symbol's location.
-  --- @since 3.17.0
-  workspaceSymbol_resolve = 'workspaceSymbol/resolve',
-  --- A request to resolve a command for a given code lens.
-  codeLens_resolve = 'codeLens/resolve',
-  --- Request to resolve additional information for a given document link. The request's
-  --- parameter is of type {@link DocumentLink} the response
-  --- is of type {@link DocumentLink} or a Thenable that resolves to such.
-  documentLink_resolve = 'documentLink/resolve',
+  workspace_willRenameFiles = 'workspace/willRenameFiles',
+  --- The `workspace/workspaceFolders` is sent from the server to the client to fetch the open workspace folders.
+  workspace_workspaceFolders = 'workspace/workspaceFolders',
 }
 local function freeze(t)
   return setmetatable({}, {
diff --git a/runtime/lua/vim/lsp/types/protocol.lua b/runtime/lua/vim/lsp/types/protocol.lua
index 241d64e6e5..e1ed8dbcc3 100644
--- a/runtime/lua/vim/lsp/types/protocol.lua
+++ b/runtime/lua/vim/lsp/types/protocol.lua
@@ -1,7 +1,7 @@
 --[[
-This file is autogenerated from scripts/lsp_types.lua
+This file is autogenerated from scripts/gen_lsp.lua
 Regenerate:
-nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/protocol.lua
+nvim -l scripts/gen_lsp.lua gen --version 3.18 --runtime/lua/vim/lsp/types/protocol.lua
 --]]
 
 ---@alias lsp.null nil
@@ -611,16 +611,12 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---A parameter literal used in inline completion requests.
 ---
 ---@since 3.18.0
----@proposed
 ---@class lsp.InlineCompletionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
 ---Additional information about the context in which inline completions were
 ---requested.
 ---@field context lsp.InlineCompletionContext
 
 ---Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.
----
----@since 3.18.0
----@proposed
 ---@class lsp.InlineCompletionList
 ---The inline completion items
 ---@field items lsp.InlineCompletionItem[]
@@ -628,10 +624,11 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
 ---
 ---@since 3.18.0
----@proposed
 ---@class lsp.InlineCompletionItem
 ---The text to replace the range with. Must be set.
----@field insertText string|lsp.StringValue
+---@field insertText string
+---The format of the insert text. The format applies to the `insertText`. If omitted defaults to `InsertTextFormat.PlainText`.
+---@field insertTextFormat? lsp.InsertTextFormat
 ---A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used.
 ---@field filterText? string
 ---The range to replace. Must begin and end on the same line.
@@ -642,7 +639,6 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---Inline completion options used during static or dynamic registration.
 ---
 ---@since 3.18.0
----@proposed
 ---@class lsp.InlineCompletionRegistrationOptions: lsp.InlineCompletionOptions, lsp.StaticRegistrationOptions
 
 ---@class lsp.RegistrationParams
@@ -1249,6 +1245,18 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---Registration options for a {@link DocumentRangeFormattingRequest}.
 ---@class lsp.DocumentRangeFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
 
+---The parameters of a {@link DocumentRangesFormattingRequest}.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.DocumentRangesFormattingParams
+---The document to format.
+---@field textDocument lsp.TextDocumentIdentifier
+---The ranges to format
+---@field ranges lsp.Range[]
+---The format options
+---@field options lsp.FormattingOptions
+
 ---The parameters of a {@link DocumentOnTypeFormattingRequest}.
 ---@class lsp.DocumentOnTypeFormattingParams
 ---The document to format.
@@ -1904,36 +1912,18 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---Provides information about the context in which an inline completion was requested.
 ---
 ---@since 3.18.0
----@proposed
 ---@class lsp.InlineCompletionContext
 ---Describes how the inline completion was triggered.
 ---@field triggerKind lsp.InlineCompletionTriggerKind
 ---Provides information about the currently selected item in the autocomplete widget if it is visible.
 ---@field selectedCompletionInfo? lsp.SelectedCompletionInfo
 
----A string value used as a snippet is a template which allows to insert text
----and to control the editor cursor when insertion happens.
----
----A snippet can define tab stops and placeholders with `$1`, `$2`
----and `${3:foo}`. `$0` defines the final tab stop, it defaults to
----the end of the snippet. Variables are defined with `$name` and
----`${name:default value}`.
----
----@since 3.18.0
----@proposed
----@class lsp.StringValue
----The kind of string value.
----@field kind "snippet"
----The snippet string.
----@field value string
-
 ---Inline completion options used during static registration.
 ---
 ---@since 3.18.0
----@proposed
 ---@class lsp.InlineCompletionOptions
 
----General parameters to register for a notification or to register a provider.
+---General parameters to to register for an notification or to register a provider.
 ---@class lsp.Registration
 ---The id used to register the request. The id can be used to deregister
 ---the request again.
@@ -2104,7 +2094,6 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---Inline completion options used during static registration.
 ---
 ---@since 3.18.0
----@proposed
 ---@field inlineCompletionProvider? boolean|lsp.InlineCompletionOptions
 ---Workspace specific server capabilities.
 ---@field workspace? anonym12
@@ -2399,6 +2388,11 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 
 ---Provider options for a {@link DocumentRangeFormattingRequest}.
 ---@class lsp.DocumentRangeFormattingOptions
+---Whether the server supports formatting multiple ranges at once.
+---
+---@since 3.18.0
+---@proposed
+---@field rangesSupport? boolean
 
 ---Provider options for a {@link DocumentOnTypeFormattingRequest}.
 ---@class lsp.DocumentOnTypeFormattingOptions
@@ -2548,7 +2542,6 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---Describes the currently selected completion item.
 ---
 ---@since 3.18.0
----@proposed
 ---@class lsp.SelectedCompletionInfo
 ---The range that will be replaced if this completion item is accepted.
 ---@field range lsp.Range
@@ -2857,7 +2850,6 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---Client capabilities specific to inline completions.
 ---
 ---@since 3.18.0
----@proposed
 ---@field inlineCompletion? lsp.InlineCompletionClientCapabilities
 
 ---Capabilities specific to the notebook document support.
@@ -3283,6 +3275,11 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---@class lsp.DocumentRangeFormattingClientCapabilities
 ---Whether range formatting supports dynamic registration.
 ---@field dynamicRegistration? boolean
+---Whether the client supports formatting multiple ranges at once.
+---
+---@since 3.18.0
+---@proposed
+---@field rangesSupport? boolean
 
 ---Client capabilities of a {@link DocumentOnTypeFormattingRequest}.
 ---@class lsp.DocumentOnTypeFormattingClientCapabilities
@@ -3474,7 +3471,6 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---Client capabilities specific to inline completions.
 ---
 ---@since 3.18.0
----@proposed
 ---@class lsp.InlineCompletionClientCapabilities
 ---Whether implementation supports dynamic registration for inline completion providers.
 ---@field dynamicRegistration? boolean
@@ -3663,6 +3659,12 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---| 1 # Type
 ---| 2 # Parameter
 
+---Defines whether the insert text in a completion item should be interpreted as
+---plain text or a snippet.
+---@alias lsp.InsertTextFormat
+---| 1 # PlainText
+---| 2 # Snippet
+
 ---The message type
 ---@alias lsp.MessageType
 ---| 1 # Error
@@ -3718,12 +3720,6 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---@alias lsp.CompletionItemTag
 ---| 1 # Deprecated
 
----Defines whether the insert text in a completion item should be interpreted as
----plain text or a snippet.
----@alias lsp.InsertTextFormat
----| 1 # PlainText
----| 2 # Snippet
-
 ---How whitespace and indentation is handled during completion
 ---item insertion.
 ---
@@ -3767,7 +3763,6 @@ nvim -l scripts/lsp_types.lua gen --version 3.1x --runtime/lua/vim/lsp/types/pro
 ---Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
 ---
 ---@since 3.18.0
----@proposed
 ---@alias lsp.InlineCompletionTriggerKind
 ---| 0 # Invoked
 ---| 1 # Automatic
-- 
cgit 


From 0804034c07ad5883bc653d054e549a87d429a8b7 Mon Sep 17 00:00:00 2001
From: Tyler Miller <tmillr@proton.me>
Date: Tue, 1 Aug 2023 08:28:28 -0700
Subject: fix(loader): cache path ambiguity #24491

Problem: cache paths are derived by replacing each reserved/filesystem-
path-sensitive char with a `%` char in the original path. With this
method, two different files at two different paths (each containing `%`
chars) can erroneously resolve to the very same cache path in certain
edge-cases.

Solution: derive cache paths by url-encoding the original (path) instead
using `vim.uri_encode()` with `"rfc2396"`. Increment `Loader.VERSION` to
denote this change.
---
 runtime/lua/vim/loader.lua |   5 ++-
 runtime/lua/vim/uri.lua    | 103 +++++++++++++++++++++++----------------------
 2 files changed, 56 insertions(+), 52 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index 4f4722b0c3..e08ccba701 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -1,4 +1,5 @@
 local uv = vim.uv
+local uri_encode = vim.uri_encode
 
 --- @type (fun(modename: string): fun()|string)[]
 local loaders = package.loaders
@@ -33,7 +34,7 @@ M.enabled = false
 ---@field _rtp_key string
 ---@field _hashes? table<string, CacheHash>
 local Loader = {
-  VERSION = 3,
+  VERSION = 4,
   ---@type table<string, table<string,ModuleInfo>>
   _indexed = {},
   ---@type table<string, string[]>
@@ -99,7 +100,7 @@ end
 ---@return string file_name
 ---@private
 function Loader.cache_file(name)
-  local ret = M.path .. '/' .. name:gsub('[/\\:]', '%%')
+  local ret = ('%s/%s'):format(M.path, uri_encode(name, 'rfc2396'))
   return ret:sub(-4) == '.lua' and (ret .. 'c') or (ret .. '.luac')
 end
 
diff --git a/runtime/lua/vim/uri.lua b/runtime/lua/vim/uri.lua
index eaa64a6fad..9dce80b77e 100644
--- a/runtime/lua/vim/uri.lua
+++ b/runtime/lua/vim/uri.lua
@@ -1,65 +1,71 @@
---- TODO: This is implemented only for files now.
+---TODO: This is implemented only for files currently.
 -- https://tools.ietf.org/html/rfc3986
 -- https://tools.ietf.org/html/rfc2732
 -- https://tools.ietf.org/html/rfc2396
 
-local uri_decode
-do
-  local schar = string.char
+local M = {}
+local sbyte = string.byte
+local schar = string.char
+local tohex = require('bit').tohex
+local URI_SCHEME_PATTERN = '^([a-zA-Z]+[a-zA-Z0-9.+-]*):.*'
+local WINDOWS_URI_SCHEME_PATTERN = '^([a-zA-Z]+[a-zA-Z0-9.+-]*):[a-zA-Z]:.*'
+local PATTERNS = {
+  ---RFC 2396
+  ---https://tools.ietf.org/html/rfc2396#section-2.2
+  rfc2396 = "^A-Za-z0-9%-_.!~*'()",
+  ---RFC 2732
+  ---https://tools.ietf.org/html/rfc2732
+  rfc2732 = "^A-Za-z0-9%-_.!~*'()[]",
+  ---RFC 3986
+  ---https://tools.ietf.org/html/rfc3986#section-2.2
+  rfc3986 = "^A-Za-z0-9%-._~!$&'()*+,;=:@/",
+}
 
-  --- Convert hex to char
-  local function hex_to_char(hex)
-    return schar(tonumber(hex, 16))
-  end
-  uri_decode = function(str)
-    return str:gsub('%%([a-fA-F0-9][a-fA-F0-9])', hex_to_char)
-  end
+---Converts hex to char
+---@param hex string
+---@return string
+local function hex_to_char(hex)
+  return schar(tonumber(hex, 16))
 end
 
-local uri_encode
-do
-  local PATTERNS = {
-    --- RFC 2396
-    -- https://tools.ietf.org/html/rfc2396#section-2.2
-    rfc2396 = "^A-Za-z0-9%-_.!~*'()",
-    --- RFC 2732
-    -- https://tools.ietf.org/html/rfc2732
-    rfc2732 = "^A-Za-z0-9%-_.!~*'()[]",
-    --- RFC 3986
-    -- https://tools.ietf.org/html/rfc3986#section-2.2
-    rfc3986 = "^A-Za-z0-9%-._~!$&'()*+,;=:@/",
-  }
-  local sbyte = string.byte
-  local tohex = require('bit').tohex
-
-  local function percent_encode_char(char)
-    return '%' .. tohex(sbyte(char), 2)
-  end
-  uri_encode = function(text, rfc)
-    if not text then
-      return
-    end
-    local pattern = PATTERNS[rfc] or PATTERNS.rfc3986
-    return text:gsub('([' .. pattern .. '])', percent_encode_char)
-  end
+---@param char string
+---@return string
+local function percent_encode_char(char)
+  return '%' .. tohex(sbyte(char), 2)
 end
 
+---@param uri string
+---@return boolean
 local function is_windows_file_uri(uri)
   return uri:match('^file:/+[a-zA-Z]:') ~= nil
 end
 
-local M = {}
+---URI-encodes a string using percent escapes.
+---@param str string string to encode
+---@param rfc "rfc2396" | "rfc2732" | "rfc3986" | nil
+---@return string encoded string
+function M.uri_encode(str, rfc)
+  local pattern = PATTERNS[rfc] or PATTERNS.rfc3986
+  return (str:gsub('([' .. pattern .. '])', percent_encode_char)) -- clamped to 1 retval with ()
+end
+
+---URI-decodes a string containing percent escapes.
+---@param str string string to decode
+---@return string decoded string
+function M.uri_decode(str)
+  return (str:gsub('%%([a-fA-F0-9][a-fA-F0-9])', hex_to_char)) -- clamped to 1 retval with ()
+end
 
---- Get a URI from a file path.
+---Gets a URI from a file path.
 ---@param path string Path to file
 ---@return string URI
 function M.uri_from_fname(path)
   local volume_path, fname = path:match('^([a-zA-Z]:)(.*)')
   local is_windows = volume_path ~= nil
   if is_windows then
-    path = volume_path .. uri_encode(fname:gsub('\\', '/'))
+    path = volume_path .. M.uri_encode(fname:gsub('\\', '/'))
   else
-    path = uri_encode(path)
+    path = M.uri_encode(path)
   end
   local uri_parts = { 'file://' }
   if is_windows then
@@ -69,10 +75,7 @@ function M.uri_from_fname(path)
   return table.concat(uri_parts)
 end
 
-local URI_SCHEME_PATTERN = '^([a-zA-Z]+[a-zA-Z0-9.+-]*):.*'
-local WINDOWS_URI_SCHEME_PATTERN = '^([a-zA-Z]+[a-zA-Z0-9.+-]*):[a-zA-Z]:.*'
-
---- Get a URI from a bufnr
+---Gets a URI from a bufnr.
 ---@param bufnr integer
 ---@return string URI
 function M.uri_from_bufnr(bufnr)
@@ -93,7 +96,7 @@ function M.uri_from_bufnr(bufnr)
   end
 end
 
---- Get a filename from a URI
+---Gets a filename from a URI.
 ---@param uri string
 ---@return string filename or unchanged URI for non-file URIs
 function M.uri_to_fname(uri)
@@ -101,8 +104,8 @@ function M.uri_to_fname(uri)
   if scheme ~= 'file' then
     return uri
   end
-  uri = uri_decode(uri)
-  -- TODO improve this.
+  uri = M.uri_decode(uri)
+  --TODO improve this.
   if is_windows_file_uri(uri) then
     uri = uri:gsub('^file:/+', '')
     uri = uri:gsub('/', '\\')
@@ -112,8 +115,8 @@ function M.uri_to_fname(uri)
   return uri
 end
 
---- Get the buffer for a uri.
---- Creates a new unloaded buffer if no buffer for the uri already exists.
+---Gets the buffer for a uri.
+---Creates a new unloaded buffer if no buffer for the uri already exists.
 --
 ---@param uri string
 ---@return integer bufnr
-- 
cgit 


From 642586977158b44c007177169d3091840a72a8fd Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 1 Aug 2023 18:03:33 +0100
Subject: feat(lua): add meta file for vim submodules (#24525)

---
 runtime/lua/vim/_meta.lua | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
 create mode 100644 runtime/lua/vim/_meta.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta.lua b/runtime/lua/vim/_meta.lua
new file mode 100644
index 0000000000..839830294e
--- /dev/null
+++ b/runtime/lua/vim/_meta.lua
@@ -0,0 +1,26 @@
+--- @meta
+
+--- The following modules are loaded specially in _init_packages.lua
+
+vim.F = require('vim.F')
+vim._watch = require('vim._watch')
+vim.diagnostic = require('vim.diagnostic')
+vim.filetype = require('vim.filetype')
+vim.fs = require('vim.fs')
+vim.health = require('vim.health')
+vim.highlight = require('vim.highlight')
+vim.iter = require('vim.iter')
+vim.keymap = require('vim.keymap')
+vim.loader = require('vim.loader')
+vim.lsp = require('vim.lsp')
+vim.re = require('vim.re')
+vim.secure = require('vim.secure')
+vim.ui = require('vim.ui')
+vim.version = require('vim.version')
+
+local uri = require('vim.uri')
+
+vim.uri_from_fname = uri.uri_from_fname
+vim.uri_from_bufnr = uri.uri_from_bufnr
+vim.uri_to_fname = uri.uri_to_fname
+vim.uri_to_bufnr = uri.uri_to_bufnr
-- 
cgit 


From d086bc1e8590a92a70c414bd60e1e988bbdd3c0a Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Tue, 1 Aug 2023 16:17:26 -0700
Subject: docs: drop "Can also be used as a method" #24508

Now that we "own" builtin.txt, we cant remove the repetitive mention of
Vimscript's UFCS syntax. It's noisy to mention this for each function,
and it's also not a Vimscript feature that should be encouraged.

Also change the builtin.txt heading to "NVIM REFERENCE MANUAL", which
indicates when a help file is Nvim-owned.
---
 runtime/lua/vim/_meta/vimfn.lua | 1264 +--------------------------------------
 1 file changed, 4 insertions(+), 1260 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 261f349756..3de2e5ac4f 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -15,10 +15,6 @@ error('Cannot require a meta file')
 ---   echo abs(-4)
 --- <  4
 ---
---- Can also be used as a |method|: >vim
----   Compute()->abs()
---- <
----
 --- @param expr any
 --- @return number
 function vim.fn.abs(expr) end
@@ -35,10 +31,6 @@ function vim.fn.abs(expr) end
 ---   echo acos(-0.5)
 --- <  2.094395
 ---
---- Can also be used as a |method|: >vim
----   Compute()->acos()
---- <
----
 --- @param expr any
 --- @return number
 function vim.fn.acos(expr) end
@@ -53,10 +45,6 @@ function vim.fn.acos(expr) end
 --- Use |insert()| to add an item at another position.
 --- Returns 1 if {object} is not a |List| or a |Blob|.
 ---
---- Can also be used as a |method|: >vim
----   mylist->add(val1)->add(val2)
---- <
----
 --- @param object any
 --- @param expr any
 --- @return any
@@ -67,8 +55,6 @@ function vim.fn.add(object, expr) end
 --- Also see `or()` and `xor()`.
 --- Example: >vim
 ---   let flag = and(bits, 0x80)
---- <Can also be used as a |method|: >vim
----   let flag = bits->and(0x80)
 --- <
 ---
 --- @param expr any
@@ -96,9 +82,6 @@ function vim.fn.api_info() end
 --- 0 for success.  Example: >vim
 ---   let failed = append(line('$'), "# THE END")
 ---   let failed = append(0, ["Chapter 1", "the beginning"])
----
---- <Can also be used as a |method| after a List: >vim
----   mylist->append(lnum)
 --- <
 ---
 --- @param lnum integer
@@ -124,9 +107,6 @@ function vim.fn.append(lnum, text) end
 --- error message is given. Example: >vim
 ---   let failed = appendbufline(13, 0, "# THE START")
 --- <
---- Can also be used as a |method| after a List: >vim
----   mylist->appendbufline(buf, lnum)
---- <
 ---
 --- @param buf any
 --- @param lnum integer
@@ -204,10 +184,6 @@ function vim.fn.argv(nr, winid) end
 ---   echo asin(-0.5)
 --- <  -0.523599
 ---
---- Can also be used as a |method|: >vim
----   Compute()->asin()
---- <
----
 --- @param expr any
 --- @return number
 function vim.fn.asin(expr) end
@@ -217,10 +193,6 @@ function vim.fn.asin(expr) end
 --- Also see |assert_fails()|, |assert_nobeep()| and
 --- |assert-return|.
 ---
---- Can also be used as a |method|: >vim
----   GetCmd()->assert_beeps()
---- <
----
 --- @param cmd any
 --- @return 0|1
 function vim.fn.assert_beeps(cmd) end
@@ -240,10 +212,6 @@ function vim.fn.assert_beeps(cmd) end
 --- <Will result in a string to be added to |v:errors|:
 ---   test.vim line 12: Expected 'foo' but got 'bar' ~
 ---
---- Can also be used as a |method|: >vim
----   mylist->assert_equal([1, 2, 3])
---- <
----
 --- @param expected any
 --- @param actual any
 --- @param msg? any
@@ -256,10 +224,6 @@ function vim.fn.assert_equal(expected, actual, msg) end
 --- When {fname-one} or {fname-two} does not exist the error will
 --- mention that.
 ---
---- Can also be used as a |method|: >vim
----   GetLog()->assert_equalfile('expected.log')
---- <
----
 --- @return 0|1
 function vim.fn.assert_equalfile() end
 
@@ -314,10 +278,6 @@ function vim.fn.assert_exception(error, msg) end
 --- Note that beeping is not considered an error, and some failing
 --- commands only beep.  Use |assert_beeps()| for those.
 ---
---- Can also be used as a |method|: >vim
----   GetCmd()->assert_fails('E99:')
---- <
----
 --- @param cmd any
 --- @param error? any
 --- @param msg? any
@@ -335,10 +295,6 @@ function vim.fn.assert_fails(cmd, error, msg, lnum, context) end
 --- A value is false when it is zero. When {actual} is not a
 --- number the assert fails.
 ---
---- Can also be used as a |method|: >vim
----   GetResult()->assert_false()
---- <
----
 --- @param actual any
 --- @param msg? any
 --- @return 0|1
@@ -376,10 +332,6 @@ function vim.fn.assert_inrange(lower, upper, actual, msg) end
 --- <Will result in a string to be added to |v:errors|:
 ---   test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~
 ---
---- Can also be used as a |method|: >vim
----   getFile()->assert_match('foo.*')
---- <
----
 --- @param pattern any
 --- @param actual any
 --- @param msg? any
@@ -390,10 +342,6 @@ function vim.fn.assert_match(pattern, actual, msg) end
 --- produces a beep or visual bell.
 --- Also see |assert_beeps()|.
 ---
---- Can also be used as a |method|: >vim
----   GetCmd()->assert_nobeep()
---- <
----
 --- @param cmd any
 --- @return 0|1
 function vim.fn.assert_nobeep(cmd) end
@@ -402,10 +350,6 @@ function vim.fn.assert_nobeep(cmd) end
 --- |v:errors| when {expected} and {actual} are equal.
 --- Also see |assert-return|.
 ---
---- Can also be used as a |method|: >vim
----   mylist->assert_notequal([1, 2, 3])
---- <
----
 --- @param expected any
 --- @param actual any
 --- @param msg? any
@@ -416,10 +360,6 @@ function vim.fn.assert_notequal(expected, actual, msg) end
 --- |v:errors| when {pattern} matches {actual}.
 --- Also see |assert-return|.
 ---
---- Can also be used as a |method|: >vim
----   getFile()->assert_notmatch('bar.*')
---- <
----
 --- @param pattern any
 --- @param actual any
 --- @param msg? any
@@ -429,10 +369,6 @@ function vim.fn.assert_notmatch(pattern, actual, msg) end
 --- Report a test failure directly, using String {msg}.
 --- Always returns one.
 ---
---- Can also be used as a |method|: >vim
----   GetMessage()->assert_report()
---- <
----
 --- @param msg any
 --- @return 0|1
 function vim.fn.assert_report(msg) end
@@ -444,10 +380,6 @@ function vim.fn.assert_report(msg) end
 --- When {actual} is not a number or |v:true| the assert fails.
 --- When {msg} is given it precedes the default message.
 ---
---- Can also be used as a |method|: >vim
----   GetResult()->assert_true()
---- <
----
 --- @param actual any
 --- @param msg? any
 --- @return 0|1
@@ -463,10 +395,6 @@ function vim.fn.assert_true(actual, msg) end
 ---   echo atan(-4.01)
 --- <  -1.326405
 ---
---- Can also be used as a |method|: >vim
----   Compute()->atan()
---- <
----
 --- @param expr any
 --- @return number
 function vim.fn.atan(expr) end
@@ -482,10 +410,6 @@ function vim.fn.atan(expr) end
 ---   echo atan2(1, -1)
 --- <  2.356194
 ---
---- Can also be used as a |method|: >vim
----   Compute()->atan2(1)
---- <
----
 --- @param expr1 any
 --- @param expr2 any
 --- @return number
@@ -498,10 +422,6 @@ function vim.fn.atan2(expr1, expr2) end
 --- <Returns an empty List on error.  |list2blob()| does the
 --- opposite.
 ---
---- Can also be used as a |method|: >vim
----   GetBlob()->blob2list()
---- <
----
 --- @param blob any
 --- @return any[]
 function vim.fn.blob2list(blob) end
@@ -551,9 +471,6 @@ function vim.fn.browsedir(title, initdir) end
 ---   call bufload(bufnr)
 ---   call setbufline(bufnr, 1, ['some', 'text'])
 --- <Returns 0 on error.
---- Can also be used as a |method|: >vim
----   let bufnr = 'somename'->bufadd()
---- <
 ---
 --- @param name string
 --- @return integer
@@ -580,10 +497,6 @@ function vim.fn.bufadd(name) end
 --- Use "bufexists(0)" to test for the existence of an alternate
 --- file name.
 ---
---- Can also be used as a |method|: >vim
----   let exists = 'somename'->bufexists()
---- <
----
 --- @param buf any
 --- @return 0|1
 function vim.fn.bufexists(buf) end
@@ -613,10 +526,6 @@ function vim.fn.buffer_number(...) end
 --- {buf} exists and is listed (has the 'buflisted' option set).
 --- The {buf} argument is used like with |bufexists()|.
 ---
---- Can also be used as a |method|: >vim
----   let listed = 'somename'->buflisted()
---- <
----
 --- @param buf any
 --- @return 0|1
 function vim.fn.buflisted(buf) end
@@ -630,10 +539,6 @@ function vim.fn.buflisted(buf) end
 --- there will be no dialog, the buffer will be loaded anyway.
 --- The {buf} argument is used like with |bufexists()|.
 ---
---- Can also be used as a |method|: >vim
----   eval 'somename'->bufload()
---- <
----
 --- @param buf any
 function vim.fn.bufload(buf) end
 
@@ -641,10 +546,6 @@ function vim.fn.bufload(buf) end
 --- {buf} exists and is loaded (shown in a window or hidden).
 --- The {buf} argument is used like with |bufexists()|.
 ---
---- Can also be used as a |method|: >vim
----   let loaded = 'somename'->bufloaded()
---- <
----
 --- @param buf any
 --- @return 0|1
 function vim.fn.bufloaded(buf) end
@@ -669,11 +570,6 @@ function vim.fn.bufloaded(buf) end
 --- with a listed buffer, that one is returned.  Next unlisted
 --- buffers are searched for.
 --- If the {buf} is a String, but you want to use it as a buffer
---- number, force it to be a Number by adding zero to it: >vim
----   echo bufname("3" + 0)
---- <Can also be used as a |method|: >vim
----   echo bufnr->bufname()
----
 --- <If the buffer doesn't exist, or doesn't have a name, an empty
 --- string is returned. >vim
 ---   echo bufname("#")    " alternate buffer name
@@ -699,10 +595,6 @@ function vim.fn.bufname(buf) end
 --- number necessarily exist, because ":bwipeout" may have removed
 --- them.  Use bufexists() to test for the existence of a buffer.
 ---
---- Can also be used as a |method|: >vim
----   echo bufref->bufnr()
---- <
----
 --- @param buf? any
 --- @param create? any
 --- @return integer
@@ -718,10 +610,6 @@ function vim.fn.bufnr(buf, create) end
 --- Only deals with the current tab page.  See |win_findbuf()| for
 --- finding more.
 ---
---- Can also be used as a |method|: >vim
----   FindBuffer()->bufwinid()
---- <
----
 --- @param buf any
 --- @return integer
 function vim.fn.bufwinid(buf) end
@@ -736,10 +624,6 @@ function vim.fn.bufwinid(buf) end
 --- <The number can be used with |CTRL-W_w| and ":wincmd w"
 --- |:wincmd|.
 ---
---- Can also be used as a |method|: >vim
----   FindBuffer()->bufwinnr()
---- <
----
 --- @param buf any
 --- @return integer
 function vim.fn.bufwinnr(buf) end
@@ -753,10 +637,6 @@ function vim.fn.bufwinnr(buf) end
 ---
 --- Returns -1 if the {byte} value is invalid.
 ---
---- Can also be used as a |method|: >vim
----   GetOffset()->byte2line()
---- <
----
 --- @param byte any
 --- @return integer
 function vim.fn.byte2line(byte) end
@@ -795,9 +675,6 @@ function vim.fn.byte2line(byte) end
 ---   echo byteidx('a😊😊', 2, 1)  " returns 1
 ---   echo byteidx('a😊😊', 3, 1)  " returns 5
 --- <
---- Can also be used as a |method|: >vim
----   GetName()->byteidx(idx)
---- <
 ---
 --- @param expr any
 --- @param nr integer
@@ -815,10 +692,6 @@ function vim.fn.byteidx(expr, nr, utf16) end
 --- character is 3 bytes), the second echo results in 1 ('e' is
 --- one byte).
 ---
---- Can also be used as a |method|: >vim
----   GetName()->byteidxcomp(idx)
---- <
----
 --- @param expr any
 --- @param nr integer
 --- @param utf16? any
@@ -833,10 +706,6 @@ function vim.fn.byteidxcomp(expr, nr, utf16) end
 --- {dict} is for functions with the "dict" attribute.  It will be
 --- used to set the local variable "self". |Dictionary-function|
 ---
---- Can also be used as a |method|: >vim
----   GetFunc()->call([arg, arg], dict)
---- <
----
 --- @param func any
 --- @param arglist any
 --- @param dict? any
@@ -856,10 +725,6 @@ function vim.fn.call(func, arglist, dict) end
 ---
 --- Returns 0.0 if {expr} is not a |Float| or a |Number|.
 ---
---- Can also be used as a |method|: >vim
----   Compute()->ceil()
---- <
----
 --- @param expr any
 --- @return number
 function vim.fn.ceil(expr) end
@@ -925,10 +790,6 @@ function vim.fn.chansend(id, data) end
 ---
 --- Returns 0 if {string} is not a |String|.
 ---
---- Can also be used as a |method|: >vim
----   GetChar()->char2nr()
---- <
----
 --- @param string string
 --- @param utf8? any
 --- @return 0|1
@@ -956,10 +817,6 @@ function vim.fn.charclass(string) end
 ---   echo charcol('.')    " returns 3
 ---   echo col('.')    " returns 7
 ---
---- <Can also be used as a |method|: >vim
----   GetPos()->col()
---- <
----
 --- @param expr any
 --- @param winid? integer
 --- @return integer
@@ -997,9 +854,6 @@ function vim.fn.charcol(expr, winid) end
 ---   echo charidx('áb́ć', 16)    " returns -1
 ---   echo charidx('a😊😊', 4, 0, 1)  " returns 2
 --- <
---- Can also be used as a |method|: >vim
----   GetName()->charidx(idx)
---- <
 ---
 --- @param string string
 --- @param idx integer
@@ -1029,10 +883,6 @@ function vim.fn.charidx(string, idx, countcc, utf16) end
 ---      call chdir(save_dir)
 ---   endif
 ---
---- <Can also be used as a |method|: >vim
----   GetDir()->chdir()
---- <
----
 --- @param dir string
 --- @return string
 function vim.fn.chdir(dir) end
@@ -1044,10 +894,6 @@ function vim.fn.chdir(dir) end
 --- When {lnum} is invalid -1 is returned.
 --- See |C-indenting|.
 ---
---- Can also be used as a |method|: >vim
----   GetLnum()->cindent()
---- <
----
 --- @param lnum integer
 --- @return integer
 function vim.fn.cindent(lnum) end
@@ -1057,10 +903,6 @@ function vim.fn.cindent(lnum) end
 --- If {win} is specified, use the window with this number or
 --- window ID instead of the current window.
 ---
---- Can also be used as a |method|: >vim
----   GetWin()->clearmatches()
---- <
----
 --- @param win? any
 function vim.fn.clearmatches(win) end
 
@@ -1101,10 +943,6 @@ function vim.fn.clearmatches(win) end
 --- moved, this can be used to obtain the column in Insert mode: >vim
 ---   imap <F2> <Cmd>echo col(".").."\n"<CR>
 ---
---- <Can also be used as a |method|: >vim
----   GetPos()->col()
---- <
----
 --- @param expr any
 --- @param winid? integer
 --- @return integer
@@ -1139,11 +977,6 @@ function vim.fn.col(expr, winid) end
 --- <This isn't very useful, but it shows how it works.  Note that
 --- an empty string is returned to avoid a zero being inserted.
 ---
---- Can also be used as a |method|, the base is passed as the
---- second argument: >vim
----   GetMatches()->complete(col('.'))
---- <
----
 --- @param startcol any
 --- @param matches any
 function vim.fn.complete(startcol, matches) end
@@ -1156,10 +989,6 @@ function vim.fn.complete(startcol, matches) end
 --- See |complete-functions| for an explanation of {expr}.  It is
 --- the same as one item in the list that 'omnifunc' would return.
 ---
---- Can also be used as a |method|: >vim
----   GetMoreMatches()->complete_add()
---- <
----
 --- @param expr any
 --- @return 0|1|2
 function vim.fn.complete_add(expr) end
@@ -1231,10 +1060,6 @@ function vim.fn.complete_check() end
 ---   " Get only 'mode' and 'pum_visible'
 ---   call complete_info(['mode', 'pum_visible'])
 ---
---- <Can also be used as a |method|: >vim
----   GetItems()->complete_info()
---- <
----
 --- @param what? any
 --- @return table
 function vim.fn.complete_info(what) end
@@ -1290,10 +1115,6 @@ function vim.fn.complete_info(what) end
 --- don't fit, a vertical layout is used anyway.  For some systems
 --- the horizontal layout is always used.
 ---
---- Can also be used as a |method|in: >vim
----   BuildMessage()->confirm("&Yes\n&No")
---- <
----
 --- @param msg any
 --- @param choices? any
 --- @param default? any
@@ -1309,9 +1130,6 @@ function vim.fn.confirm(msg, choices, default, type) end
 --- changing an item changes the contents of both |Lists|.
 --- A |Dictionary| is copied in a similar way as a |List|.
 --- Also see |deepcopy()|.
---- Can also be used as a |method|: >vim
----   mylist->copy()
---- <
 ---
 --- @param expr any
 --- @return any
@@ -1326,10 +1144,6 @@ function vim.fn.copy(expr) end
 ---   echo cos(-4.01)
 --- <  -0.646043
 ---
---- Can also be used as a |method|: >vim
----   Compute()->cos()
---- <
----
 --- @param expr any
 --- @return number
 function vim.fn.cos(expr) end
@@ -1344,10 +1158,6 @@ function vim.fn.cos(expr) end
 ---   echo cosh(-0.5)
 --- <  -1.127626
 ---
---- Can also be used as a |method|: >vim
----   Compute()->cosh()
---- <
----
 --- @param expr any
 --- @return number
 function vim.fn.cosh(expr) end
@@ -1364,10 +1174,6 @@ function vim.fn.cosh(expr) end
 --- occurrences of {expr} is returned. Zero is returned when
 --- {expr} is an empty string.
 ---
---- Can also be used as a |method|: >vim
----   mylist->count(val)
---- <
----
 --- @param comp any
 --- @param expr any
 --- @param ic? any
@@ -1451,10 +1257,6 @@ function vim.fn.cursor(lnum, col, off) end
 --- position within a <Tab> or after the last character.
 --- Returns 0 when the position could be set, -1 otherwise.
 ---
---- Can also be used as a |method|: >vim
----   GetCursorPos()->cursor()
---- <
----
 --- @param list any
 --- @return any
 function vim.fn.cursor(list) end
@@ -1467,10 +1269,6 @@ function vim.fn.cursor(list) end
 --- Returns |TRUE| if successfully interrupted the program.
 --- Otherwise returns |FALSE|.
 ---
---- Can also be used as a |method|: >vim
----   GetPid()->debugbreak()
---- <
----
 --- @param pid any
 --- @return any
 function vim.fn.debugbreak(pid) end
@@ -1494,10 +1292,6 @@ function vim.fn.debugbreak(pid) end
 --- {noref} set to 1 will fail.
 --- Also see |copy()|.
 ---
---- Can also be used as a |method|: >vim
----   GetObject()->deepcopy()
---- <
----
 --- @param expr any
 --- @param noref? any
 --- @return any
@@ -1521,10 +1315,6 @@ function vim.fn.deepcopy(expr, noref) end
 --- operation was successful and -1/true when the deletion failed
 --- or partly failed.
 ---
---- Can also be used as a |method|: >vim
----   GetName()->delete()
---- <
----
 --- @param fname integer
 --- @param flags? string
 --- @return integer
@@ -1543,10 +1333,6 @@ function vim.fn.delete(fname, flags) end
 --- when using |line()| this refers to the current buffer. Use "$"
 --- to refer to the last line in buffer {buf}.
 ---
---- Can also be used as a |method|: >vim
----   GetBuffer()->deletebufline(1)
---- <
----
 --- @param buf any
 --- @param first any
 --- @param last? any
@@ -1630,10 +1416,6 @@ function vim.fn.did_filetype() end
 --- line, "'m" mark m, etc.
 --- Returns 0 if the current window is not in diff mode.
 ---
---- Can also be used as a |method|: >vim
----   GetLnum()->diff_filler()
---- <
----
 --- @param lnum integer
 --- @return any
 function vim.fn.diff_filler(lnum) end
@@ -1648,10 +1430,6 @@ function vim.fn.diff_filler(lnum) end
 --- The highlight ID can be used with |synIDattr()| to obtain
 --- syntax information about the highlighting.
 ---
---- Can also be used as a |method|: >vim
----   GetLnum()->diff_hlID(col)
---- <
----
 --- @param lnum integer
 --- @param col integer
 --- @return any
@@ -1672,9 +1450,6 @@ function vim.fn.diff_hlID(lnum, col) end
 --- call digraph_set('aa', 'あ')
 --- echo digraph_get('aa')    " Returns 'あ'
 --- <
---- Can also be used as a |method|: >vim
----   GetChars()->digraph_get()
---- <
 ---
 --- @param chars any
 --- @return any
@@ -1693,9 +1468,6 @@ function vim.fn.digraph_get(chars) end
 --- " Get all the digraphs, including default digraphs
 --- echo digraph_getlist(1)
 --- <
---- Can also be used as a |method|: >vim
----   GetNumber()->digraph_getlist()
---- <
 ---
 --- @param listall? any
 --- @return any
@@ -1756,10 +1528,6 @@ function vim.fn.digraph_setlist(digraphlist) end
 --- - |v:false| and |v:null| are empty, |v:true| is not.
 --- - A |Blob| is empty when its length is zero.
 ---
---- Can also be used as a |method|: >vim
----   mylist->empty()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.empty(expr) end
@@ -1782,10 +1550,6 @@ function vim.fn.environ() end
 ---   c:\\program\ files\\vim
 --- <Also see |shellescape()| and |fnameescape()|.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->escape(' \')
---- <
----
 --- @param string string
 --- @param chars any
 --- @return any
@@ -1797,10 +1561,6 @@ function vim.fn.escape(string, chars) end
 --- of them.  Also works for |Funcref|s that refer to existing
 --- functions.
 ---
---- Can also be used as a |method|: >vim
----   argv->join()->eval()
---- <
----
 --- @param string string
 --- @return any
 function vim.fn.eval(string) end
@@ -1835,10 +1595,6 @@ function vim.fn.eventhandler() end
 ---   -1  not implemented on this system
 --- |exepath()| can be used to get the full path of an executable.
 ---
---- Can also be used as a |method|: >vim
----   GetCommand()->executable()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.executable(expr) end
@@ -1870,10 +1626,6 @@ function vim.fn.executable(expr) end
 --- To execute a command in another window than the current one
 --- use `win_execute()`.
 ---
---- Can also be used as a |method|: >vim
----   GetCommand()->execute()
---- <
----
 --- @param command any
 --- @param silent? boolean
 --- @return any
@@ -1884,10 +1636,6 @@ function vim.fn.execute(command, silent) end
 --- Returns empty string otherwise.
 --- If {expr} starts with "./" the |current-directory| is used.
 ---
---- Can also be used as a |method|: >vim
----   GetCommand()->exepath()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.exepath(expr) end
@@ -1979,10 +1727,6 @@ function vim.fn.exepath(expr) end
 --- <This doesn't check for existence of the "bufcount" variable,
 --- but gets the value of "bufcount", and checks if that exists.
 ---
---- Can also be used as a |method|: >vim
----   Varname()->exists()
---- <
----
 --- @param expr any
 --- @return 0|1
 function vim.fn.exists(expr) end
@@ -1997,10 +1741,6 @@ function vim.fn.exists(expr) end
 ---   echo exp(-1)
 --- <  0.367879
 ---
---- Can also be used as a |method|: >vim
----   Compute()->exp()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.exp(expr) end
@@ -2095,10 +1835,6 @@ function vim.fn.exp(expr) end
 --- See |glob()| for finding existing files.  See |system()| for
 --- getting the raw output of an external command.
 ---
---- Can also be used as a |method|: >vim
----   Getpattern()->expand()
---- <
----
 --- @param string string
 --- @param nosuf? boolean
 --- @param list? any
@@ -2127,9 +1863,6 @@ function vim.fn.expand(string, nosuf, list) end
 --- < >vim
 ---   echo expandcmd('make %<.o', {'errmsg': v:true})
 --- <
---- Can also be used as a |method|: >vim
----   GetCommand()->expandcmd()
---- <
 ---
 --- @param string string
 --- @param options? table
@@ -2171,10 +1904,6 @@ function vim.fn.expandcmd(string, options) end
 --- fails.
 --- Returns {expr1}.  Returns 0 on error.
 ---
---- Can also be used as a |method|: >vim
----   mylist->extend(otherlist)
---- <
----
 --- @param expr1 any
 --- @param expr2 any
 --- @param expr3? any
@@ -2235,10 +1964,6 @@ function vim.fn.extendnew(expr1, expr2, expr3) end
 ---
 --- Return value is always 0.
 ---
---- Can also be used as a |method|: >vim
----   GetInput()->feedkeys()
---- <
----
 --- @param string string
 --- @param mode? string
 --- @return any
@@ -2267,10 +1992,6 @@ function vim.fn.file_readable(file) end
 ---   1
 --- <
 ---
---- Can also be used as a |method|: >vim
----   GetName()->filereadable()
---- <
----
 --- @param file string
 --- @return 0|1
 function vim.fn.filereadable(file) end
@@ -2280,10 +2001,6 @@ function vim.fn.filereadable(file) end
 --- exist, or is not writable, the result is 0.  If {file} is a
 --- directory, and we can write to it, the result is 2.
 ---
---- Can also be used as a |method|: >vim
----   GetName()->filewritable()
---- <
----
 --- @param file string
 --- @return 0|1
 function vim.fn.filewritable(file) end
@@ -2337,10 +2054,6 @@ function vim.fn.filewritable(file) end
 --- {expr2} is a Funcref errors inside a function are ignored,
 --- unless it was defined with the "abort" flag.
 ---
---- Can also be used as a |method|: >vim
----   mylist->filter(expr2)
---- <
----
 --- @param expr1 any
 --- @param expr2 any
 --- @return any
@@ -2363,10 +2076,6 @@ function vim.fn.filter(expr1, expr2) end
 ---
 --- This is quite similar to the ex-command `:find`.
 ---
---- Can also be used as a |method|: >vim
----   GetName()->finddir()
---- <
----
 --- @param name string
 --- @param path? string
 --- @param count? any
@@ -2380,10 +2089,6 @@ function vim.fn.finddir(name, path, count) end
 --- <Searches from the directory of the current file upwards until
 --- it finds the file "tags.vim".
 ---
---- Can also be used as a |method|: >vim
----   GetName()->findfile()
---- <
----
 --- @param name string
 --- @param path? string
 --- @param count? any
@@ -2408,10 +2113,6 @@ function vim.fn.findfile(name, path, count) end
 ---   echo flatten([1, [2, [3, 4]], 5], 1)
 --- <  [1, 2, [3, 4], 5]
 ---
---- Can also be used as a |method|: >vim
----   mylist->flatten()
---- <
----
 --- @param list any
 --- @param maxdepth? any
 --- @return any[]|0
@@ -2445,10 +2146,6 @@ function vim.fn.flattennew(list, maxdepth) end
 ---   echo float2nr(1.0e-100)
 --- <  0
 ---
---- Can also be used as a |method|: >vim
----   Compute()->float2nr()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.float2nr(expr) end
@@ -2465,10 +2162,6 @@ function vim.fn.float2nr(expr) end
 ---   echo floor(4.0)
 --- <  4.0
 ---
---- Can also be used as a |method|: >vim
----   Compute()->floor()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.floor(expr) end
@@ -2488,10 +2181,6 @@ function vim.fn.floor(expr) end
 ---   echo fmod(-12.33, 1.22)
 --- <  -0.13
 ---
---- Can also be used as a |method|: >vim
----   Compute()->fmod(1.22)
---- <
----
 --- @param expr1 any
 --- @param expr2 any
 --- @return any
@@ -2512,9 +2201,6 @@ function vim.fn.fmod(expr1, expr2) end
 --- <results in executing: >vim
 ---   edit \+some\ str\%nge\|name
 --- <
---- Can also be used as a |method|: >vim
----   GetName()->fnameescape()
---- <
 ---
 --- @param string string
 --- @return string
@@ -2536,10 +2222,6 @@ function vim.fn.fnameescape(string) end
 --- Note: Environment variables don't work in {fname}, use
 --- |expand()| first then.
 ---
---- Can also be used as a |method|: >vim
----   GetName()->fnamemodify(':p:h')
---- <
----
 --- @param fname integer
 --- @param mods string
 --- @return string
@@ -2551,10 +2233,6 @@ function vim.fn.fnamemodify(fname, mods) end
 --- {lnum} is used like with |getline()|.  Thus "." is the current
 --- line, "'m" mark m, etc.
 ---
---- Can also be used as a |method|: >vim
----   GetLnum()->foldclosed()
---- <
----
 --- @param lnum integer
 --- @return integer
 function vim.fn.foldclosed(lnum) end
@@ -2565,10 +2243,6 @@ function vim.fn.foldclosed(lnum) end
 --- {lnum} is used like with |getline()|.  Thus "." is the current
 --- line, "'m" mark m, etc.
 ---
---- Can also be used as a |method|: >vim
----   GetLnum()->foldclosedend()
---- <
----
 --- @param lnum integer
 --- @return integer
 function vim.fn.foldclosedend(lnum) end
@@ -2584,10 +2258,6 @@ function vim.fn.foldclosedend(lnum) end
 --- {lnum} is used like with |getline()|.  Thus "." is the current
 --- line, "'m" mark m, etc.
 ---
---- Can also be used as a |method|: >vim
----   GetLnum()->foldlevel()
---- <
----
 --- @param lnum integer
 --- @return integer
 function vim.fn.foldlevel(lnum) end
@@ -2619,10 +2289,6 @@ function vim.fn.foldtext() end
 --- line, "'m" mark m, etc.
 --- Useful when exporting folded text, e.g., to HTML.
 ---
---- Can also be used as a |method|: >vim
----   GetLnum()->foldtextresult()
---- <
----
 --- @param lnum integer
 --- @return string
 function vim.fn.foldtextresult(lnum) end
@@ -2638,10 +2304,6 @@ function vim.fn.foldtextresult(lnum) end
 --- For example `fullcommand('s')`, `fullcommand('sub')`,
 --- `fullcommand(':%substitute')` all return "substitute".
 ---
---- Can also be used as a |method|: >vim
----   GetName()->fullcommand()
---- <
----
 --- @param name string
 --- @return string
 function vim.fn.fullcommand(name) end
@@ -2657,10 +2319,6 @@ function vim.fn.fullcommand(name) end
 --- instead). {name} cannot be a builtin function.
 --- Returns 0 on error.
 ---
---- Can also be used as a |method|: >vim
----   GetFuncname()->funcref([arg])
---- <
----
 --- @param name string
 --- @param arglist? any
 --- @param dict? any
@@ -2748,10 +2406,6 @@ function vim.fn.funcref(name, arglist, dict) end
 --- <
 --- Returns 0 on error.
 ---
---- Can also be used as a |method|: >vim
----   GetFuncname()->function([arg])
---- <
----
 --- @param name string
 --- @param arglist? any
 --- @param dict? any
@@ -2784,9 +2438,6 @@ function vim.fn.garbagecollect(atexit) end
 --- Get item {idx} from |List| {list}.  When this item is not
 --- available return {default}.  Return zero when {default} is
 --- omitted.
---- Can also be used as a |method|: >vim
----   mylist->get(idx)
---- <
 ---
 --- @param list any[]
 --- @param idx integer
@@ -2898,9 +2549,6 @@ function vim.fn.getbufinfo(buf) end
 --- To get buffer-local options use: >vim
 ---   getbufvar({bufnr}, '&option_name')
 --- <
---- Can also be used as a |method|: >vim
----   GetBufnr()->getbufinfo()
---- <
 ---
 --- @param dict? table<string,any>
 --- @return any
@@ -2930,10 +2578,6 @@ function vim.fn.getbufinfo(dict) end
 --- Example: >vim
 ---   let lines = getbufline(bufnr("myfile"), 1, "$")
 ---
---- <Can also be used as a |method|: >vim
----   GetBufnr()->getbufline(lnum)
---- <
----
 --- @param buf any
 --- @param lnum integer
 --- @param end_? integer
@@ -2968,10 +2612,6 @@ function vim.fn.getbufoneline(buf, lnum) end
 ---   let bufmodified = getbufvar(1, "&mod")
 ---   echo "todo myvar = " .. getbufvar("todo", "myvar")
 ---
---- <Can also be used as a |method|: >vim
----   GetBufnr()->getbufvar(varname)
---- <
----
 --- @param buf any
 --- @param varname string
 --- @param def? any
@@ -3001,10 +2641,6 @@ function vim.fn.getcellwidths() end
 --- position refers to the position in the list. For other
 --- buffers, it is set to the length of the list.
 ---
---- Can also be used as a |method|: >vim
----   GetBufnr()->getchangelist()
---- <
----
 --- @param buf? integer|string
 --- @return table[]
 function vim.fn.getchangelist(buf) end
@@ -3106,9 +2742,6 @@ function vim.fn.getcharmod() end
 ---   getcharpos('.')    returns [0, 5, 3, 0]
 ---   getpos('.')    returns [0, 5, 7, 0]
 --- <
---- Can also be used as a |method|: >vim
----   GetMark()->getcharpos()
---- <
 ---
 --- @param expr any
 --- @return integer[]
@@ -3286,10 +2919,6 @@ function vim.fn.getcmdwintype() end
 --- If there are no matches, an empty list is returned.  An
 --- invalid value for {type} produces an error.
 ---
---- Can also be used as a |method|: >vim
----   GetPattern()->getcompletion('color')
---- <
----
 --- @param pat any
 --- @param type any
 --- @param filtered? any
@@ -3320,10 +2949,6 @@ function vim.fn.getcompletion(pat, type, filtered) end
 --- <Note that this only works within the window.  See
 --- |winrestview()| for restoring more state.
 ---
---- Can also be used as a |method|: >vim
----   GetWinid()->getcurpos()
---- <
----
 --- @param winid? integer
 --- @return any
 function vim.fn.getcurpos(winid) end
@@ -3336,9 +2961,6 @@ function vim.fn.getcurpos(winid) end
 ---   getcursorcharpos()  " returns [0, 3, 2, 0, 3]
 ---   getcurpos()    " returns [0, 3, 4, 0, 3]
 --- <
---- Can also be used as a |method|: >vim
----   GetWinid()->getcursorcharpos()
---- <
 ---
 --- @param winid? integer
 --- @return any
@@ -3359,10 +2981,6 @@ function vim.fn.getcursorcharpos(winid) end
 --- directory is returned.
 --- Throw error if the arguments are invalid. |E5000| |E5001| |E5002|
 ---
---- Can also be used as a |method|: >vim
----   GetWinnr()->getcwd()
---- <
----
 --- @param winnr? integer
 --- @param tabnr? integer
 --- @return string
@@ -3376,10 +2994,6 @@ function vim.fn.getcwd(winnr, tabnr) end
 --- is different from a variable set to an empty string.
 --- See also |expr-env|.
 ---
---- Can also be used as a |method|: >vim
----   GetVarname()->getenv()
---- <
----
 --- @param name string
 --- @return string
 function vim.fn.getenv(name) end
@@ -3413,9 +3027,6 @@ function vim.fn.getfontname(name) end
 --- <This will hopefully (from a security point of view) display
 --- the string "rw-r--r--" or even "rw-------".
 ---
---- Can also be used as a |method|: >vim
----   GetFilename()->getfperm()
---- <
 --- For setting permissions use |setfperm()|.
 ---
 --- @param fname integer
@@ -3429,10 +3040,6 @@ function vim.fn.getfperm(fname) end
 --- If the size of {fname} is too big to fit in a Number then -2
 --- is returned.
 ---
---- Can also be used as a |method|: >vim
----   GetFilename()->getfsize()
---- <
----
 --- @param fname integer
 --- @return integer
 function vim.fn.getfsize(fname) end
@@ -3443,10 +3050,6 @@ function vim.fn.getfsize(fname) end
 --- |localtime()| and |strftime()|.
 --- If the file {fname} can't be found -1 is returned.
 ---
---- Can also be used as a |method|: >vim
----   GetFilename()->getftime()
---- <
----
 --- @param fname integer
 --- @return integer
 function vim.fn.getftime(fname) end
@@ -3470,10 +3073,6 @@ function vim.fn.getftime(fname) end
 --- systems that support it.  On some systems only "dir" and
 --- "file" are returned.
 ---
---- Can also be used as a |method|: >vim
----   GetFilename()->getftype()
---- <
----
 --- @param fname integer
 --- @return 'file'|'dir'|'link'|'bdev'|'cdev'|'socket'|'fifo'|'other'
 function vim.fn.getftype(fname) end
@@ -3497,10 +3096,6 @@ function vim.fn.getftype(fname) end
 ---   filename  filename if available
 ---   lnum    line number
 ---
---- Can also be used as a |method|: >vim
----   GetWinnr()->getjumplist()
---- <
----
 --- @param winnr? integer
 --- @param tabnr? integer
 --- @return any
@@ -3527,9 +3122,6 @@ function vim.fn.getjumplist(winnr, tabnr) end
 ---   let end = search("^$") - 1
 ---   let lines = getline(start, end)
 ---
---- <Can also be used as a |method|: >vim
----   ComputeLnum()->getline()
----
 --- <To get lines from another buffer see |getbufline()| and
 --- |getbufoneline()|
 ---
@@ -3592,10 +3184,6 @@ function vim.fn.getloclist(nr, what) end
 --- Refer to |getpos()| for getting information about a specific
 --- mark.
 ---
---- Can also be used as a |method|: >vim
----   GetBufnr()->getmarklist()
---- <
----
 --- @param buf? any
 --- @return any
 function vim.fn.getmarklist(buf) end
@@ -3700,10 +3288,6 @@ function vim.fn.getpid() end
 ---   call setpos("'a", save_a_mark)
 --- <Also see |getcharpos()|, |getcurpos()| and |setpos()|.
 ---
---- Can also be used as a |method|: >vim
----   GetMark()->getpos()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.getpos(expr) end
@@ -3834,10 +3418,6 @@ function vim.fn.getqflist(what) end
 ---
 --- If {regname} is not specified, |v:register| is used.
 ---
---- Can also be used as a |method|: >vim
----   GetRegname()->getreg()
---- <
----
 --- @param regname? string
 --- @param list? any
 --- @return string|string[]
@@ -3866,10 +3446,6 @@ function vim.fn.getreg(regname, list) end
 --- If {regname} is not specified, |v:register| is used.
 --- The returned Dictionary can be passed to |setreg()|.
 ---
---- Can also be used as a |method|: >vim
----   GetRegname()->getreginfo()
---- <
----
 --- @param regname? string
 --- @return table
 function vim.fn.getreginfo(regname) end
@@ -3884,10 +3460,6 @@ function vim.fn.getreginfo(regname) end
 --- The {regname} argument is a string.  If {regname} is not
 --- specified, |v:register| is used.
 ---
---- Can also be used as a |method|: >vim
----   GetRegname()->getregtype()
---- <
----
 --- @param regname? string
 --- @return string
 function vim.fn.getregtype(regname) end
@@ -3944,10 +3516,6 @@ function vim.fn.getscriptinfo(opts) end
 ---       tabpage-local variables
 ---   windows    List of |window-ID|s in the tab page.
 ---
---- Can also be used as a |method|: >vim
----   GetTabnr()->gettabinfo()
---- <
----
 --- @param tabnr? integer
 --- @return any
 function vim.fn.gettabinfo(tabnr) end
@@ -3961,10 +3529,6 @@ function vim.fn.gettabinfo(tabnr) end
 --- When the tab or variable doesn't exist {def} or an empty
 --- string is returned, there is no error message.
 ---
---- Can also be used as a |method|: >vim
----   GetTabnr()->gettabvar(varname)
---- <
----
 --- @param tabnr integer
 --- @param varname string
 --- @param def? any
@@ -3996,9 +3560,6 @@ function vim.fn.gettabvar(tabnr, varname, def) end
 --- To obtain all window-local variables use: >vim
 ---   gettabwinvar({tabnr}, {winnr}, '&')
 --- <
---- Can also be used as a |method|: >vim
----   GetTabnr()->gettabwinvar(winnr, varname)
---- <
 ---
 --- @param tabnr integer
 --- @param winnr integer
@@ -4034,10 +3595,6 @@ function vim.fn.gettabwinvar(tabnr, winnr, varname, def) end
 ---
 --- See |tagstack| for more information about the tag stack.
 ---
---- Can also be used as a |method|: >vim
----   GetWinnr()->gettagstack()
---- <
----
 --- @param winnr? integer
 --- @return any
 function vim.fn.gettagstack(winnr) end
@@ -4089,10 +3646,6 @@ function vim.fn.gettext(text) end
 ---   winrow    topmost screen line of the window;
 ---       "row" from |win_screenpos()|
 ---
---- Can also be used as a |method|: >vim
----   GetWinnr()->getwininfo()
---- <
----
 --- @param winid? integer
 --- @return any
 function vim.fn.getwininfo(winid) end
@@ -4116,9 +3669,6 @@ function vim.fn.getwininfo(winid) end
 ---     " Do some work here
 ---   endwhile
 --- <
---- Can also be used as a |method|: >vim
----   GetTimeout()->getwinpos()
---- <
 ---
 --- @param timeout? integer
 --- @return any
@@ -4145,10 +3695,6 @@ function vim.fn.getwinposy() end
 ---   let list_is_on = getwinvar(2, '&list')
 ---   echo "myvar = " .. getwinvar(1, 'myvar')
 ---
---- <Can also be used as a |method|: >vim
----   GetWinnr()->getwinvar(varname)
---- <
----
 --- @param winnr integer
 --- @param varname string
 --- @param def? any
@@ -4190,10 +3736,6 @@ function vim.fn.getwinvar(winnr, varname, def) end
 --- See |expand()| for expanding special Vim variables.  See
 --- |system()| for getting the raw output of an external command.
 ---
---- Can also be used as a |method|: >vim
----   GetExpr()->glob()
---- <
----
 --- @param expr any
 --- @param nosuf? boolean
 --- @param list? any
@@ -4216,10 +3758,6 @@ function vim.fn.glob(expr, nosuf, list, alllinks) end
 --- Note that the result depends on the system.  On MS-Windows
 --- a backslash usually means a path separator.
 ---
---- Can also be used as a |method|: >vim
----   GetExpr()->glob2regpat()
---- <
----
 --- @param string string
 --- @return any
 function vim.fn.glob2regpat(string) end
@@ -4258,11 +3796,6 @@ function vim.fn.glob2regpat(string) end
 --- <Upwards search and limiting the depth of "**" is not
 --- supported, thus using 'path' will not always work properly.
 ---
---- Can also be used as a |method|, the base is passed as the
---- second argument: >vim
----   GetExpr()->globpath(&rtp)
---- <
----
 --- @param path string
 --- @param expr any
 --- @param nosuf? boolean
@@ -4346,10 +3879,6 @@ function vim.fn.has(feature) end
 --- has an entry with key {key}.  FALSE otherwise. The {key}
 --- argument is a string.
 ---
---- Can also be used as a |method|: >vim
----   mydict->has_key(key)
---- <
----
 --- @param dict any
 --- @param key any
 --- @return 0|1
@@ -4371,10 +3900,6 @@ function vim.fn.has_key(dict, key) end
 --- If {winnr} is -1 it is ignored, only the tab is resolved.
 --- Throw error if the arguments are invalid. |E5000| |E5001| |E5002|
 ---
---- Can also be used as a |method|: >vim
----   GetWinnr()->haslocaldir()
---- <
----
 --- @param winnr? integer
 --- @param tabnr? integer
 --- @return 0|1
@@ -4410,10 +3935,6 @@ function vim.fn.haslocaldir(winnr, tabnr) end
 --- <This installs the mapping to "\ABCdoit" only if there isn't
 --- already a mapping to "\ABCdoit".
 ---
---- Can also be used as a |method|: >vim
----   GetRHS()->hasmapto()
---- <
----
 --- @param what any
 --- @param mode? string
 --- @param abbr? any
@@ -4454,11 +3975,6 @@ function vim.fn.highlight_exists(name) end
 ---   let date=input("Enter date: ")
 --- <This function is not available in the |sandbox|.
 ---
---- Can also be used as a |method|, the base is passed as the
---- second argument: >vim
----   GetHistory()->histadd('search')
---- <
----
 --- @param history any
 --- @param item any
 --- @return 0|1
@@ -4495,9 +4011,6 @@ function vim.fn.histadd(history, item) end
 ---   call histdel("search", -1)
 ---   let \@/ = histget("search", -1)
 --- <
---- Can also be used as a |method|: >vim
----   GetHistory()->histdel()
---- <
 ---
 --- @param history any
 --- @param item? any
@@ -4518,9 +4031,6 @@ function vim.fn.histdel(history, item) end
 --- the {num}th entry from the output of |:history|. >vim
 ---   command -nargs=1 H execute histget("cmd", 0+<args>)
 --- <
---- Can also be used as a |method|: >vim
----   GetHistory()->histget()
---- <
 ---
 --- @param history any
 --- @param index? any
@@ -4534,10 +4044,6 @@ function vim.fn.histget(history, index) end
 --- Example: >vim
 ---   let inp_index = histnr("expr")
 ---
---- <Can also be used as a |method|: >vim
----   GetHistory()->histnr()
---- <
----
 --- @param history any
 --- @return integer
 function vim.fn.histnr(history) end
@@ -4550,9 +4056,6 @@ function vim.fn.histnr(history) end
 --- "Comment" group: >vim
 ---   echo synIDattr(synIDtrans(hlID("Comment")), "bg")
 --- <
---- Can also be used as a |method|: >vim
----   GetName()->hlID()
---- <
 ---
 --- @param name string
 --- @return integer
@@ -4564,10 +4067,6 @@ function vim.fn.hlID(name) end
 --- been defined for it, it may also have been used for a syntax
 --- item.
 ---
---- Can also be used as a |method|: >vim
----   GetName()->hlexists()
---- <
----
 --- @param name string
 --- @return 0|1
 function vim.fn.hlexists(name) end
@@ -4590,10 +4089,6 @@ function vim.fn.hostname() end
 --- from/to UCS-2 is automatically changed to use UTF-8.  You
 --- cannot use UCS-2 in a string anyway, because of the NUL bytes.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->iconv('latin1', 'utf-8')
---- <
----
 --- @param string string
 --- @param from any
 --- @param to any
@@ -4622,12 +4117,8 @@ function vim.fn.id(expr) end
 
 --- current buffer.  The indent is counted in spaces, the value
 --- of 'tabstop' is relevant.  {lnum} is used just like in
---- |getline()|.
---- When {lnum} is invalid -1 is returned.
----
---- Can also be used as a |method|: >vim
----   GetLnum()->indent()
---- <
+--- |getline()|.
+--- When {lnum} is invalid -1 is returned.
 ---
 --- @param lnum integer
 --- @return integer
@@ -4659,10 +4150,6 @@ function vim.fn.indent(lnum) end
 ---     " ...
 ---   endif
 ---
---- <Can also be used as a |method|: >vim
----   GetObject()->index(what)
---- <
----
 --- @param object any
 --- @param expr any
 --- @param start? any
@@ -4707,10 +4194,6 @@ function vim.fn.index(object, expr, start, ic) end
 ---   echo indexof(l, {i, v -> v.n == 30})
 ---   echo indexof(l, "v:val.n == 20", #{startidx: 1})
 ---
---- <Can also be used as a |method|: >vim
----   mylist->indexof(expr)
---- <
----
 --- @param object any
 --- @param expr any
 --- @param opts? table
@@ -4833,10 +4316,6 @@ function vim.fn.input(prompt, text, completion) end
 ---     call inputrestore()
 ---   endfunction
 ---
---- <Can also be used as a |method|: >vim
----   GetPrompt()->input()
---- <
----
 --- @param opts table
 --- @return any
 function vim.fn.input(opts) end
@@ -4864,10 +4343,6 @@ function vim.fn.inputdialog(...) end
 ---   let color = inputlist(['Select color:', '1. red',
 ---     \ '2. green', '3. blue'])
 ---
---- <Can also be used as a |method|: >vim
----   GetChoices()->inputlist()
---- <
----
 --- @param textlist any
 --- @return any
 function vim.fn.inputlist(textlist) end
@@ -4900,10 +4375,6 @@ function vim.fn.inputsave() end
 --- typed on the command-line in response to the issued prompt.
 --- NOTE: Command-line completion is not supported.
 ---
---- Can also be used as a |method|: >vim
----   GetPrompt()->inputsecret()
---- <
----
 --- @param prompt any
 --- @param text? any
 --- @return any
@@ -4925,10 +4396,6 @@ function vim.fn.inputsecret(prompt, text) end
 --- Note that when {item} is a |List| it is inserted as a single
 --- item.  Use |extend()| to concatenate |Lists|.
 ---
---- Can also be used as a |method|: >vim
----   mylist->insert(item)
---- <
----
 --- @param object any
 --- @param item any
 --- @param idx? integer
@@ -4952,11 +4419,6 @@ function vim.fn.insert(object, item, idx) end
 function vim.fn.interrupt() end
 
 --- Bitwise invert.  The argument is converted to a number.  A
---- List, Dict or Float argument causes an error.  Example: >vim
----   let bits = invert(bits)
---- <Can also be used as a |method|: >vim
----   let bits = bits->invert()
---- <
 ---
 --- @param expr any
 --- @return any
@@ -4967,10 +4429,6 @@ function vim.fn.invert(expr) end
 --- exist, or isn't a directory, the result is |FALSE|.  {directory}
 --- is any expression, which is used as a String.
 ---
---- Can also be used as a |method|: >vim
----   GetName()->isdirectory()
---- <
----
 --- @param directory any
 --- @return 0|1
 function vim.fn.isdirectory(directory) end
@@ -4982,10 +4440,6 @@ function vim.fn.isdirectory(directory) end
 ---   echo isinf(-1.0 / 0.0)
 --- <  -1
 ---
---- Can also be used as a |method|: >vim
----   Compute()->isinf()
---- <
----
 --- @param expr any
 --- @return 1|0|-1
 function vim.fn.isinf(expr) end
@@ -5003,10 +4457,6 @@ function vim.fn.isinf(expr) end
 --- <When {expr} is a variable that does not exist you get an error
 --- message.  Use |exists()| to check for existence.
 ---
---- Can also be used as a |method|: >vim
----   GetName()->islocked()
---- <
----
 --- @param expr any
 --- @return 0|1
 function vim.fn.islocked(expr) end
@@ -5015,10 +4465,6 @@ function vim.fn.islocked(expr) end
 ---   echo isnan(0.0 / 0.0)
 --- <  1
 ---
---- Can also be used as a |method|: >vim
----   Compute()->isnan()
---- <
----
 --- @param expr any
 --- @return 0|1
 function vim.fn.isnan(expr) end
@@ -5032,10 +4478,6 @@ function vim.fn.isnan(expr) end
 ---      echo key .. ': ' .. value
 ---   endfor
 ---
---- <Can also be used as a |method|: >vim
----   mydict->items()
---- <
----
 --- @param dict any
 --- @return any
 function vim.fn.items(dict) end
@@ -5208,10 +4650,6 @@ function vim.fn.jobwait(jobs, timeout) end
 --- converted into a string like with |string()|.
 --- The opposite function is |split()|.
 ---
---- Can also be used as a |method|: >vim
----   mylist->join()
---- <
----
 --- @param list any
 --- @param sep? any
 --- @return any
@@ -5232,10 +4670,6 @@ function vim.fn.join(list, sep) end
 --- recommended and the only one required to be supported.
 --- Non-UTF-8 characters are an error.
 ---
---- Can also be used as a |method|: >vim
----   ReadObject()->json_decode()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.json_decode(expr) end
@@ -5251,10 +4685,6 @@ function vim.fn.json_decode(expr) end
 --- or special escapes like "\t", other are dumped as-is.
 --- |Blob|s are converted to arrays of the individual bytes.
 ---
---- Can also be used as a |method|: >vim
----   GetObject()->json_encode()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.json_encode(expr) end
@@ -5262,10 +4692,6 @@ function vim.fn.json_encode(expr) end
 --- Return a |List| with all the keys of {dict}.  The |List| is in
 --- arbitrary order.  Also see |items()| and |values()|.
 ---
---- Can also be used as a |method|: >vim
----   mydict->keys()
---- <
----
 --- @param dict any
 --- @return any
 function vim.fn.keys(dict) end
@@ -5276,10 +4702,6 @@ function vim.fn.keys(dict) end
 ---   echo keytrans(xx)
 --- <  <C-Home>
 ---
---- Can also be used as a |method|: >vim
----   "\<C-Home>"->keytrans()
---- <
----
 --- @param string string
 --- @return any
 function vim.fn.keytrans(string) end
@@ -5299,10 +4721,6 @@ function vim.fn.last_buffer_nr() end
 --- |Dictionary| is returned.
 --- Otherwise an error is given and returns zero.
 ---
---- Can also be used as a |method|: >vim
----   mylist->len()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.len(expr) end
@@ -5348,11 +4766,6 @@ function vim.fn.len(expr) end
 --- Examples: >vim
 ---   echo libcall("libc.so", "getenv", "HOME")
 ---
---- <Can also be used as a |method|, the base is passed as the
---- third argument: >vim
----   GetValue()->libcall("libc.so", "getenv")
---- <
----
 --- @param libname string
 --- @param funcname string
 --- @param argument any
@@ -5366,10 +4779,6 @@ function vim.fn.libcall(libname, funcname, argument) end
 ---   call libcallnr("libc.so", "printf", "Hello World!\n")
 ---   call libcallnr("libc.so", "sleep", 10)
 --- <
---- Can also be used as a |method|, the base is passed as the
---- third argument: >vim
----   GetValue()->libcallnr("libc.so", "printf")
---- <
 ---
 --- @param libname string
 --- @param funcname string
@@ -5408,10 +4817,6 @@ function vim.fn.libcallnr(libname, funcname, argument) end
 --- To jump to the last known position when opening a file see
 --- |last-position-jump|.
 ---
---- Can also be used as a |method|: >vim
----   GetValue()->line()
---- <
----
 --- @param expr any
 --- @param winid? integer
 --- @return integer
@@ -5429,10 +4834,6 @@ function vim.fn.line(expr, winid) end
 --- |getline()|.  When {lnum} is invalid -1 is returned.
 --- Also see |byte2line()|, |go| and |:goto|.
 ---
---- Can also be used as a |method|: >vim
----   GetLnum()->line2byte()
---- <
----
 --- @param lnum integer
 --- @return integer
 function vim.fn.line2byte(lnum) end
@@ -5443,10 +4844,6 @@ function vim.fn.line2byte(lnum) end
 --- relevant.  {lnum} is used just like in |getline()|.
 --- When {lnum} is invalid, -1 is returned.
 ---
---- Can also be used as a |method|: >vim
----   GetLnum()->lispindent()
---- <
----
 --- @param lnum integer
 --- @return any
 function vim.fn.lispindent(lnum) end
@@ -5460,10 +4857,6 @@ function vim.fn.lispindent(lnum) end
 ---
 --- |blob2list()| does the opposite.
 ---
---- Can also be used as a |method|: >vim
----   GetList()->list2blob()
---- <
----
 --- @param list any
 --- @return any
 function vim.fn.list2blob(list) end
@@ -5483,10 +4876,6 @@ function vim.fn.list2blob(list) end
 --- <
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >vim
----   GetList()->list2str()
---- <
----
 --- @param list any
 --- @param utf8? any
 --- @return any
@@ -5508,10 +4897,6 @@ function vim.fn.localtime() end
 ---   echo log(exp(5))
 --- <  5.0
 ---
---- Can also be used as a |method|: >vim
----   Compute()->log()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.log(expr) end
@@ -5525,10 +4910,6 @@ function vim.fn.log(expr) end
 ---   echo log10(0.01)
 --- <  -2.0
 ---
---- Can also be used as a |method|: >vim
----   Compute()->log10()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.log10(expr) end
@@ -5579,10 +4960,6 @@ function vim.fn.log10(expr) end
 --- {expr2} is a Funcref errors inside a function are ignored,
 --- unless it was defined with the "abort" flag.
 ---
---- Can also be used as a |method|: >vim
----   mylist->map(expr2)
---- <
----
 --- @param expr1 any
 --- @param expr2 any
 --- @return any
@@ -5651,10 +5028,6 @@ function vim.fn.map(expr1, expr2) end
 --- mapped, and have it do the original mapping too.  Sketch: >vim
 ---   exe 'nnoremap <Tab> ==' .. maparg('<Tab>', 'n')
 ---
---- <Can also be used as a |method|: >vim
----   GetKey()->maparg('n')
---- <
----
 --- @param name string
 --- @param mode? string
 --- @param abbr? boolean
@@ -5694,10 +5067,6 @@ function vim.fn.maparg(name, mode, abbr, dict) end
 --- <This avoids adding the "_vv" mapping when there already is a
 --- mapping for "_v" or for "_vvv".
 ---
---- Can also be used as a |method|: >vim
----   GetKey()->mapcheck('n')
---- <
----
 --- @param name string
 --- @param mode? string
 --- @param abbr? any
@@ -5785,11 +5154,6 @@ function vim.fn.mapset(mode, abbr, dict) end
 --- zero matches at the start instead of a number of matches
 --- further down in the text.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->match('word')
----   GetList()->match('word')
---- <
----
 --- @param expr any
 --- @param pat any
 --- @param start? any
@@ -5854,10 +5218,6 @@ function vim.fn.match(expr, pat, start, count) end
 --- available from |getmatches()|.  All matches can be deleted in
 --- one operation by |clearmatches()|.
 ---
---- Can also be used as a |method|: >vim
----   GetGroup()->matchadd('TODO')
---- <
----
 --- @param group any
 --- @param pattern any
 --- @param priority? any
@@ -5902,10 +5262,6 @@ function vim.fn.matchadd(group, pattern, priority, id, dict) end
 --- <Matches added by |matchaddpos()| are returned by
 --- |getmatches()|.
 ---
---- Can also be used as a |method|: >vim
----   GetGroup()->matchaddpos([23, 11])
---- <
----
 --- @param group any
 --- @param pos any
 --- @param priority? any
@@ -5925,10 +5281,6 @@ function vim.fn.matchaddpos(group, pos, priority, id, dict) end
 --- Highlighting matches using the |:match| commands are limited
 --- to three matches. |matchadd()| does not have this limitation.
 ---
---- Can also be used as a |method|: >vim
----   GetMatch()->matcharg()
---- <
----
 --- @param nr integer
 --- @return any
 function vim.fn.matcharg(nr) end
@@ -5940,10 +5292,6 @@ function vim.fn.matcharg(nr) end
 --- If {win} is specified, use the window with this number or
 --- window ID instead of the current window.
 ---
---- Can also be used as a |method|: >vim
----   GetMatch()->matchdelete()
---- <
----
 --- @param id any
 --- @param win? any
 --- @return any
@@ -5967,10 +5315,6 @@ function vim.fn.matchdelete(id, win) end
 --- <result is "-1".
 --- When {expr} is a |List| the result is equal to |match()|.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->matchend('word')
---- <
----
 --- @param expr any
 --- @param pat any
 --- @param start? any
@@ -6084,10 +5428,6 @@ function vim.fn.matchfuzzypos(list, str, dict) end
 ---
 --- You can pass in a List, but that is not very useful.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->matchlist('word')
---- <
----
 --- @param expr any
 --- @param pat any
 --- @param start? any
@@ -6107,10 +5447,6 @@ function vim.fn.matchlist(expr, pat, start, count) end
 --- When {expr} is a |List| then the matching item is returned.
 --- The type isn't changed, it's not necessarily a String.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->matchstr('word')
---- <
----
 --- @param expr any
 --- @param pat any
 --- @param start? any
@@ -6135,10 +5471,6 @@ function vim.fn.matchstr(expr, pat, start, count) end
 --- <result is ["x", 1, 2, 3].
 --- The type isn't changed, it's not necessarily a String.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->matchstrpos('word')
---- <
----
 --- @param expr any
 --- @param pat any
 --- @param start? any
@@ -6155,10 +5487,6 @@ function vim.fn.matchstrpos(expr, pat, start, count) end
 --- items in {expr} cannot be used as a Number this results in
 ---                 an error.  An empty |List| or |Dictionary| results in zero.
 ---
---- Can also be used as a |method|: >vim
----   mylist->max()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.max(expr) end
@@ -6282,9 +5610,6 @@ function vim.fn.menu_get(path, modes) end
 ---     call ShowMenu(topmenu, '')
 ---   endfor
 --- <
---- Can also be used as a |method|: >vim
----   GetMenuName()->menu_info('v')
---- <
 ---
 --- @param name string
 --- @param mode? string
@@ -6300,10 +5625,6 @@ function vim.fn.menu_info(name, mode) end
 --- items in {expr} cannot be used as a Number this results in
 --- an error.  An empty |List| or |Dictionary| results in zero.
 ---
---- Can also be used as a |method|: >vim
----   mylist->min()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.min(expr) end
@@ -6350,10 +5671,6 @@ function vim.fn.min(expr) end
 --- successful or FALSE if the directory creation failed or partly
 --- failed.
 ---
---- Can also be used as a |method|: >vim
----   GetName()->mkdir()
---- <
----
 --- @param name string
 --- @param flags? string
 --- @param prot? any
@@ -6410,10 +5727,6 @@ function vim.fn.mkdir(name, flags, prot) end
 --- the leading character(s).
 --- Also see |visualmode()|.
 ---
---- Can also be used as a |method|: >vim
----   DoFull()->mode()
---- <
----
 --- @return any
 function vim.fn.mode() end
 
@@ -6525,10 +5838,6 @@ function vim.fn.msgpackparse(data) end
 --- {lnum} is used like with |getline()|.
 --- See also |prevnonblank()|.
 ---
---- Can also be used as a |method|: >vim
----   GetLnum()->nextnonblank()
---- <
----
 --- @param lnum integer
 --- @return any
 function vim.fn.nextnonblank(lnum) end
@@ -6547,10 +5856,6 @@ function vim.fn.nextnonblank(lnum) end
 --- characters.  nr2char(0) is a real NUL and terminates the
 --- string, thus results in an empty string.
 ---
---- Can also be used as a |method|: >vim
----   GetNumber()->nr2char()
---- <
----
 --- @param expr any
 --- @param utf8? any
 --- @return any
@@ -6561,8 +5866,6 @@ function vim.fn.nr2char(expr, utf8) end
 --- Also see `and()` and `xor()`.
 --- Example: >vim
 ---   let bits = or(bits, 0x80)
---- <Can also be used as a |method|: >vim
----   let bits = bits->or(0x80)
 ---
 --- <Rationale: The reason this is a function and not using the "|"
 --- character like many languages, is that Vi has always used "|"
@@ -6587,10 +5890,6 @@ vim.fn['or'] = function(expr, expr1) end
 --- It doesn't matter if the path exists or not.
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >vim
----   GetDirectories()->pathshorten()
---- <
----
 --- @param path string
 --- @param len? any
 --- @return any
@@ -6610,10 +5909,6 @@ function vim.fn.pathshorten(path, len) end
 ---   echo perleval('[1 .. 4]')
 --- <  [1, 2, 3, 4]
 ---
---- Can also be used as a |method|: >vim
----   GetExpr()->perleval()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.perleval(expr) end
@@ -6629,10 +5924,6 @@ function vim.fn.perleval(expr) end
 ---   echo pow(32, 0.20)
 --- <  2.0
 ---
---- Can also be used as a |method|: >vim
----   Compute()->pow(3)
---- <
----
 --- @param x any
 --- @param y any
 --- @return any
@@ -6646,10 +5937,6 @@ function vim.fn.pow(x, y) end
 --- {lnum} is used like with |getline()|.
 --- Also see |nextnonblank()|.
 ---
---- Can also be used as a |method|: >vim
----   GetLnum()->prevnonblank()
---- <
----
 --- @param lnum integer
 --- @return any
 function vim.fn.prevnonblank(lnum) end
@@ -6864,10 +6151,6 @@ function vim.fn.printf(fmt, expr1) end
 --- If the buffer doesn't exist or isn't a prompt buffer, an empty
 --- string is returned.
 ---
---- Can also be used as a |method|: >vim
----   GetBuffer()->prompt_getprompt()
---- <
----
 --- @param buf any
 --- @return any
 function vim.fn.prompt_getprompt(buf) end
@@ -6903,10 +6186,6 @@ function vim.fn.prompt_getprompt(buf) end
 ---    endfunc
 ---    call prompt_setcallback(bufnr(), function('s:TextEntered'))
 ---
---- <Can also be used as a |method|: >vim
----   GetBuffer()->prompt_setcallback(callback)
---- <
----
 --- @param buf any
 --- @param expr any
 --- @return any
@@ -6920,10 +6199,6 @@ function vim.fn.prompt_setcallback(buf, expr) end
 --- mode.  Without setting a callback Vim will exit Insert mode,
 --- as in any buffer.
 ---
---- Can also be used as a |method|: >vim
----   GetBuffer()->prompt_setinterrupt(callback)
---- <
----
 --- @param buf any
 --- @param expr any
 --- @return any
@@ -6935,9 +6210,6 @@ function vim.fn.prompt_setinterrupt(buf, expr) end
 --- "prompt".  Example: >vim
 ---   call prompt_setprompt(bufnr(''), 'command: ')
 --- <
---- Can also be used as a |method|: >vim
----   GetBuffer()->prompt_setprompt('command: ')
---- <
 ---
 --- @param buf any
 --- @param text any
@@ -6976,10 +6248,6 @@ function vim.fn.pumvisible() end
 --- Dictionaries are represented as Vim |Dictionary| type with
 --- keys converted to strings.
 ---
---- Can also be used as a |method|: >vim
----   GetExpr()->py3eval()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.py3eval(expr) end
@@ -6992,10 +6260,6 @@ function vim.fn.py3eval(expr) end
 --- Dictionaries are represented as Vim |Dictionary| type,
 --- non-string keys result in error.
 ---
---- Can also be used as a |method|: >vim
----   GetExpr()->pyeval()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.pyeval(expr) end
@@ -7005,10 +6269,6 @@ function vim.fn.pyeval(expr) end
 --- Uses Python 2 or 3, see |python_x| and 'pyxversion'.
 --- See also: |pyeval()|, |py3eval()|
 ---
---- Can also be used as a |method|: >vim
----   GetExpr()->pyxeval()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.pyxeval(expr) end
@@ -7027,9 +6287,6 @@ function vim.fn.pyxeval(expr) end
 ---   echo rand(seed)
 ---   echo rand(seed) % 16  " random number 0 - 15
 --- <
---- Can also be used as a |method|: >vim
----   seed->rand()
---- <
 ---
 --- @param expr? any
 --- @return any
@@ -7052,9 +6309,6 @@ function vim.fn.rand(expr) end
 ---   echo range(0)    " []
 ---   echo range(2, 0)    " error!
 --- <
---- Can also be used as a |method|: >vim
----   GetExpr()->range()
---- <
 ---
 --- @param expr any
 --- @param max? any
@@ -7120,10 +6374,6 @@ function vim.fn.readblob(fname, offset, size) end
 --- <
 --- Returns an empty List on error.
 ---
---- Can also be used as a |method|: >vim
----   GetDirName()->readdir()
---- <
----
 --- @param directory any
 --- @param expr? any
 --- @return any
@@ -7161,10 +6411,6 @@ function vim.fn.readdir(directory, expr) end
 --- the result is an empty list.
 --- Also see |writefile()|.
 ---
---- Can also be used as a |method|: >vim
----   GetFileName()->readfile()
---- <
----
 --- @param fname integer
 --- @param type? any
 --- @param max? any
@@ -7186,9 +6432,6 @@ function vim.fn.readfile(fname, type, max) end
 ---   echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a')
 ---   echo reduce(0z1122, { acc, val -> 2 * acc + val })
 --- <
---- Can also be used as a |method|: >vim
----   echo mylist->reduce({ acc, val -> acc + val }, 0)
---- <
 ---
 --- @param object any
 --- @param func any
@@ -7240,9 +6483,6 @@ function vim.fn.reltime(start) end
 --- The {start} and {end} arguments must be values returned by
 --- reltime().  Returns zero on error.
 ---
---- Can also be used as a |method|: >vim
----   GetStart()->reltime()
---- <
 --- Note: |localtime()| returns the current (non-relative) time.
 ---
 --- @param start? any
@@ -7260,10 +6500,6 @@ function vim.fn.reltime(start, end_) end
 --- Also see |profiling|.
 --- If there is an error an empty string is returned
 ---
---- Can also be used as a |method|: >vim
----   reltime(start)->reltimefloat()
---- <
----
 --- @param time any
 --- @return any
 function vim.fn.reltimefloat(time) end
@@ -7281,10 +6517,6 @@ function vim.fn.reltimefloat(time) end
 --- <Also see |profiling|.
 --- If there is an error an empty string is returned
 ---
---- Can also be used as a |method|: >vim
----   echo reltime(start)->reltimestr()
---- <
----
 --- @param time any
 --- @return any
 function vim.fn.reltimestr(time) end
@@ -7308,10 +6540,6 @@ function vim.fn.remove(list, idx) end
 --- <
 --- Use |delete()| to remove a file.
 ---
---- Can also be used as a |method|: >vim
----   mylist->remove(idx)
---- <
----
 --- @param list any
 --- @param idx integer
 --- @param end_? any
@@ -7359,10 +6587,6 @@ function vim.fn.remove(dict, key) end
 --- NOTE: If {to} exists it is overwritten without warning.
 --- This function is not available in the |sandbox|.
 ---
---- Can also be used as a |method|: >vim
----   GetOldName()->rename(newname)
---- <
----
 --- @param from any
 --- @param to any
 --- @return any
@@ -7377,10 +6601,6 @@ function vim.fn.rename(from, to) end
 ---   let longlist = repeat(['a', 'b'], 3)
 --- <Results in ['a', 'b', 'a', 'b', 'a', 'b'].
 ---
---- Can also be used as a |method|: >vim
----   mylist->repeat(count)
---- <
----
 --- @param expr any
 --- @param count any
 --- @return any
@@ -7398,10 +6618,6 @@ vim.fn['repeat'] = function(expr, count) end
 --- current directory (provided the result is still a relative
 --- path name) and also keeps a trailing path separator.
 ---
---- Can also be used as a |method|: >vim
----   GetName()->resolve()
---- <
----
 --- @param filename any
 --- @return any
 function vim.fn.resolve(filename) end
@@ -7410,11 +6626,6 @@ function vim.fn.resolve(filename) end
 --- {object} can be a |List| or a |Blob|.
 --- Returns {object}.
 --- Returns zero if {object} is not a List or a Blob.
---- If you want an object to remain unmodified make a copy first: >vim
----   let revlist = reverse(copy(mylist))
---- <Can also be used as a |method|: >vim
----   mylist->reverse()
---- <
 ---
 --- @param object any
 --- @return any
@@ -7433,10 +6644,6 @@ function vim.fn.reverse(object) end
 ---   echo round(-4.5)
 --- <  -5.0
 ---
---- Can also be used as a |method|: >vim
----   Compute()->round()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.round(expr) end
@@ -7495,10 +6702,6 @@ function vim.fn.rpcstop(...) end
 --- Other objects are represented as strings resulted from their
 --- "Object#to_s" method.
 ---
---- Can also be used as a |method|: >vim
----   GetRubyExpr()->rubyeval()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.rubyeval(expr) end
@@ -7508,10 +6711,6 @@ function vim.fn.rubyeval(expr) end
 --- attribute at other positions.
 --- Returns -1 when row or col is out of range.
 ---
---- Can also be used as a |method|: >vim
----   GetRow()->screenattr(col)
---- <
----
 --- @param row any
 --- @param col integer
 --- @return any
@@ -7526,10 +6725,6 @@ function vim.fn.screenattr(row, col) end
 --- This is mainly to be used for testing.
 --- Returns -1 when row or col is out of range.
 ---
---- Can also be used as a |method|: >vim
----   GetRow()->screenchar(col)
---- <
----
 --- @param row any
 --- @param col integer
 --- @return any
@@ -7541,10 +6736,6 @@ function vim.fn.screenchar(row, col) end
 --- This is mainly to be used for testing.
 --- Returns an empty List when row or col is out of range.
 ---
---- Can also be used as a |method|: >vim
----   GetRow()->screenchars(col)
---- <
----
 --- @param row any
 --- @param col integer
 --- @return any
@@ -7590,10 +6781,6 @@ function vim.fn.screencol() end
 --- first character is returned, {col} is not used.
 --- Returns an empty Dict if {winid} is invalid.
 ---
---- Can also be used as a |method|: >vim
----   GetWinid()->screenpos(lnum, col)
---- <
----
 --- @param winid integer
 --- @param lnum integer
 --- @param col integer
@@ -7617,10 +6804,6 @@ function vim.fn.screenrow() end
 --- This is mainly to be used for testing.
 --- Returns an empty String when row or col is out of range.
 ---
---- Can also be used as a |method|: >vim
----   GetRow()->screenstring(col)
---- <
----
 --- @param row any
 --- @param col integer
 --- @return any
@@ -7726,10 +6909,6 @@ function vim.fn.screenstring(row, col) end
 --- without the 'e' flag if the cursor is on the "f" of "if".
 --- The 'n' flag tells the function not to move the cursor.
 ---
---- Can also be used as a |method|: >vim
----   GetPattern()->search()
---- <
----
 --- @param pattern any
 --- @param flags? string
 --- @param stopline? any
@@ -7858,10 +7037,6 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
 ---         value. see |cursor()|, |getpos()|
 ---         (default: cursor's position)
 ---
---- Can also be used as a |method|: >vim
----   GetSearchOpts()->searchcount()
---- <
----
 --- @param options? table
 --- @return any
 function vim.fn.searchcount(options) end
@@ -7883,9 +7058,6 @@ function vim.fn.searchcount(options) end
 ---      echo getline('.')
 ---   endif
 --- <
---- Can also be used as a |method|: >vim
----   GetName()->searchdecl()
---- <
 ---
 --- @param name string
 --- @param global? any
@@ -8007,10 +7179,6 @@ function vim.fn.searchpairpos() end
 --- <In this example "submatch" is 2 when a lowercase letter is
 --- found |/\l|, 3 when an uppercase letter is found |/\u|.
 ---
---- Can also be used as a |method|: >vim
----   GetPattern()->searchpos()
---- <
----
 --- @param pattern any
 --- @param flags? string
 --- @param stopline? any
@@ -8097,11 +7265,6 @@ function vim.fn.serverstop(address) end
 --- If {buf} is not a valid buffer or {lnum} is not valid, an
 --- error message is given.
 ---
---- Can also be used as a |method|, the base is passed as the
---- third argument: >vim
----   GetText()->setbufline(buf, lnum)
---- <
----
 --- @param buf any
 --- @param lnum integer
 --- @param text any
@@ -8121,11 +7284,6 @@ function vim.fn.setbufline(buf, lnum, text) end
 ---   call setbufvar("todo", "myvar", "foobar")
 --- <This function is not available in the |sandbox|.
 ---
---- Can also be used as a |method|, the base is passed as the
---- third argument: >vim
----   GetValue()->setbufvar(buf, varname)
---- <
----
 --- @param buf any
 --- @param varname string
 --- @param val any
@@ -8179,10 +7337,6 @@ function vim.fn.setcellwidths(list) end
 ---   call setpos('.', [0, 8, 4, 0])
 --- <positions the cursor on the second character '보'.
 ---
---- Can also be used as a |method|: >vim
----   GetPosition()->setcharpos('.')
---- <
----
 --- @param expr any
 --- @param list any
 --- @return any
@@ -8207,10 +7361,6 @@ function vim.fn.setcharpos(expr, list) end
 ---   call setcharsearch(prevsearch)
 --- <Also see |getcharsearch()|.
 ---
---- Can also be used as a |method|: >vim
----   SavedSearch()->setcharsearch()
---- <
----
 --- @param dict any
 --- @return any
 function vim.fn.setcharsearch(dict) end
@@ -8221,10 +7371,6 @@ function vim.fn.setcharsearch(dict) end
 --- Returns 0 when successful, 1 when not editing the command
 --- line.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->setcmdline()
---- <
----
 --- @param str any
 --- @param pos? any
 --- @return any
@@ -8244,10 +7390,6 @@ function vim.fn.setcmdline(str, pos) end
 --- Returns 0 when successful, 1 when not editing the command
 --- line.
 ---
---- Can also be used as a |method|: >vim
----   GetPos()->setcmdpos()
---- <
----
 --- @param pos any
 --- @return any
 function vim.fn.setcmdpos(pos) end
@@ -8268,10 +7410,6 @@ function vim.fn.setcursorcharpos(lnum, col, off) end
 ---   call cursor(4, 3)
 --- <positions the cursor on the first character '여'.
 ---
---- Can also be used as a |method|: >vim
----   GetCursorPos()->setcursorcharpos()
---- <
----
 --- @param list any
 --- @return any
 function vim.fn.setcursorcharpos(list) end
@@ -8282,11 +7420,6 @@ function vim.fn.setcursorcharpos(list) end
 --- <When {val} is |v:null| the environment variable is deleted.
 --- See also |expr-env|.
 ---
---- Can also be used as a |method|, the base is passed as the
---- second argument: >vim
----   GetPath()->setenv('PATH')
---- <
----
 --- @param name string
 --- @param val any
 --- @return any
@@ -8306,9 +7439,6 @@ function vim.fn.setenv(name, val) end
 ---
 --- Returns non-zero for success, zero for failure.
 ---
---- Can also be used as a |method|: >vim
----   GetFilename()->setfperm(mode)
---- <
 --- To read permissions see |getfperm()|.
 ---
 --- @param fname integer
@@ -8342,11 +7472,6 @@ function vim.fn.setfperm(fname, mode) end
 ---
 --- <Note: The '[ and '] marks are not set.
 ---
---- Can also be used as a |method|, the base is passed as the
---- second argument: >vim
----   GetText()->setline(lnum)
---- <
----
 --- @param lnum integer
 --- @param text any
 --- @return any
@@ -8367,11 +7492,6 @@ function vim.fn.setline(lnum, text) end
 --- only the items listed in {what} are set. Refer to |setqflist()|
 --- for the list of supported keys in {what}.
 ---
---- Can also be used as a |method|, the base is passed as the
---- second argument: >vim
----   GetLoclist()->setloclist(winnr)
---- <
----
 --- @param nr integer
 --- @param list any
 --- @param action? any
@@ -8383,12 +7503,8 @@ function vim.fn.setloclist(nr, list, action, what) end
 --- current window.  Returns 0 if successful, otherwise -1.  All
 --- current matches are cleared before the list is restored.  See
 --- example for |getmatches()|.
---- If {win} is specified, use the window with this number or
---- window ID instead of the current window.
----
---- Can also be used as a |method|: >vim
----   GetMatches()->setmatches()
---- <
+--- If {win} is specified, use the window with this number or
+--- window ID instead of the current window.
 ---
 --- @param list any
 --- @param win? any
@@ -8443,10 +7559,6 @@ function vim.fn.setmatches(list, win) end
 --- also set the preferred column.  Also see the "curswant" key in
 --- |winrestview()|.
 ---
---- Can also be used as a |method|: >vim
----   GetPosition()->setpos('.')
---- <
----
 --- @param expr any
 --- @param list any
 --- @return any
@@ -8562,11 +7674,6 @@ function vim.fn.setpos(expr, list) end
 --- independent of the 'errorformat' setting.  Use a command like
 --- `:cc 1` to jump to the first position.
 ---
---- Can also be used as a |method|, the base is passed as the
---- second argument: >vim
----   GetErrorlist()->setqflist()
---- <
----
 --- @param list any
 --- @param action? any
 --- @param what? any
@@ -8628,11 +7735,6 @@ function vim.fn.setqflist(list, action, what) end
 --- nothing: >vim
 ---   call setreg('a', '', 'al')
 ---
---- <Can also be used as a |method|, the base is passed as the
---- second argument: >vim
----   GetText()->setreg('a')
---- <
----
 --- @param regname string
 --- @param value any
 --- @param options? table
@@ -8646,11 +7748,6 @@ function vim.fn.setreg(regname, value, options) end
 --- Tabs are numbered starting with one.
 --- This function is not available in the |sandbox|.
 ---
---- Can also be used as a |method|, the base is passed as the
---- third argument: >vim
----   GetValue()->settabvar(tab, name)
---- <
----
 --- @param tabnr integer
 --- @param varname string
 --- @param val any
@@ -8672,11 +7769,6 @@ function vim.fn.settabvar(tabnr, varname, val) end
 ---   call settabwinvar(3, 2, "myvar", "foobar")
 --- <This function is not available in the |sandbox|.
 ---
---- Can also be used as a |method|, the base is passed as the
---- fourth argument: >vim
----   GetValue()->settabwinvar(tab, winnr, name)
---- <
----
 --- @param tabnr integer
 --- @param winnr integer
 --- @param varname string
@@ -8716,10 +7808,6 @@ function vim.fn.settabwinvar(tabnr, winnr, varname, val) end
 ---   call settagstack(1003, stack)
 ---   unlet stack
 --- <
---- Can also be used as a |method|, the base is passed as the
---- second argument: >vim
----   GetStack()->settagstack(winnr)
---- <
 ---
 --- @param nr integer
 --- @param dict any
@@ -8732,11 +7820,6 @@ function vim.fn.settagstack(nr, dict, action) end
 ---   call setwinvar(1, "&list", 0)
 ---   call setwinvar(2, "myvar", "foobar")
 ---
---- <Can also be used as a |method|, the base is passed as the
---- third argument: >vim
----   GetValue()->setwinvar(winnr, name)
---- <
----
 --- @param nr integer
 --- @param varname string
 --- @param val any
@@ -8746,10 +7829,6 @@ function vim.fn.setwinvar(nr, varname, val) end
 --- Returns a String with 64 hex characters, which is the SHA256
 --- checksum of {string}.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->sha256()
---- <
----
 --- @param string string
 --- @return any
 function vim.fn.sha256(string) end
@@ -8784,10 +7863,6 @@ function vim.fn.sha256(string) end
 ---     call system("chmod +w -- " .. shellescape(expand("%")))
 --- <See also |::S|.
 ---
---- Can also be used as a |method|: >vim
----   GetCommand()->shellescape()
---- <
----
 --- @param string string
 --- @param special? any
 --- @return any
@@ -8813,10 +7888,6 @@ function vim.fn.shellescape(string, special) end
 --- 'vartabstop' feature. If no {col} argument is given, column 1
 --- will be assumed.
 ---
---- Can also be used as a |method|: >vim
----   GetColumn()->shiftwidth()
---- <
----
 --- @param col? integer
 --- @return any
 function vim.fn.shiftwidth(col) end
@@ -8870,9 +7941,6 @@ function vim.fn.sign_define(name, dict) end
 ---     \  'text' : '!!'}
 ---     \ ])
 --- <
---- Can also be used as a |method|: >vim
----   GetSignList()->sign_define()
---- <
 ---
 --- @param list any
 --- @return any
@@ -8912,9 +7980,6 @@ function vim.fn.sign_define(list) end
 ---   " Get the attribute of the sign named mySign
 ---   echo sign_getdefined("mySign")
 --- <
---- Can also be used as a |method|: >vim
----   GetSignList()->sign_getdefined()
---- <
 ---
 --- @param name? string
 --- @return any
@@ -8979,9 +8044,6 @@ function vim.fn.sign_getdefined(name) end
 ---   " Get a List of all the placed signs
 ---   echo sign_getplaced()
 --- <
---- Can also be used as a |method|: >vim
----   GetBufname()->sign_getplaced()
---- <
 ---
 --- @param buf? any
 --- @param dict? any
@@ -9002,9 +8064,6 @@ function vim.fn.sign_getplaced(buf, dict) end
 ---   " Jump to sign 10 in the current buffer
 ---   call sign_jump(10, '', '')
 --- <
---- Can also be used as a |method|: >vim
----   GetSignid()->sign_jump()
---- <
 ---
 --- @param id any
 --- @param group any
@@ -9059,9 +8118,6 @@ function vim.fn.sign_jump(id, group, buf) end
 ---   call sign_place(10, 'g3', 'sign4', 'json.c',
 ---       \ {'lnum' : 40, 'priority' : 90})
 --- <
---- Can also be used as a |method|: >vim
----   GetSignid()->sign_place(group, name, expr)
---- <
 ---
 --- @param id any
 --- @param group any
@@ -9128,9 +8184,6 @@ function vim.fn.sign_place(id, group, name, buf, dict) end
 ---     \  'lnum' : 50}
 ---     \ ])
 --- <
---- Can also be used as a |method|: >vim
----   GetSignlist()->sign_placelist()
---- <
 ---
 --- @param list any
 --- @return any
@@ -9161,9 +8214,6 @@ function vim.fn.sign_undefine(name) end
 ---   " Delete all the signs
 ---   call sign_undefine()
 --- <
---- Can also be used as a |method|: >vim
----   GetSignlist()->sign_undefine()
---- <
 ---
 --- @param list? any
 --- @return any
@@ -9210,10 +8260,6 @@ function vim.fn.sign_undefine(list) end
 ---   " Remove all the placed signs from all the buffers
 ---   call sign_unplace('*')
 ---
---- <Can also be used as a |method|: >vim
----   GetSigngroup()->sign_unplace()
---- <
----
 --- @param group any
 --- @param dict? any
 --- @return any
@@ -9246,9 +8292,6 @@ function vim.fn.sign_unplace(group, dict) end
 ---     \ {'id' : 20, 'buffer' : 'b.vim'},
 ---     \ ])
 --- <
---- Can also be used as a |method|: >vim
----   GetSignlist()->sign_unplacelist()
---- <
 ---
 --- @param list any
 --- @return any
@@ -9270,10 +8313,6 @@ function vim.fn.sign_unplacelist(list) end
 --- directory.  In order to resolve all the involved symbolic
 --- links before simplifying the path name, use |resolve()|.
 ---
---- Can also be used as a |method|: >vim
----   GetName()->simplify()
---- <
----
 --- @param filename any
 --- @return any
 function vim.fn.simplify(filename) end
@@ -9287,10 +8326,6 @@ function vim.fn.simplify(filename) end
 ---   echo sin(-4.01)
 --- <  0.763301
 ---
---- Can also be used as a |method|: >vim
----   Compute()->sin()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.sin(expr) end
@@ -9305,10 +8340,6 @@ function vim.fn.sin(expr) end
 ---   echo sinh(-0.9)
 --- <  -1.026517
 ---
---- Can also be used as a |method|: >vim
----   Compute()->sinh()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.sinh(expr) end
@@ -9321,10 +8352,6 @@ function vim.fn.sinh(expr) end
 --- When {end} is -1 the last item is omitted.
 --- Returns an empty value if {start} or {end} are invalid.
 ---
---- Can also be used as a |method|: >vim
----   GetList()->slice(offset)
---- <
----
 --- @param expr any
 --- @param start any
 --- @param end_? any
@@ -9417,10 +8444,6 @@ function vim.fn.sockconnect(mode, address, opts) end
 --- on numbers, text strings will sort next to each other, in the
 --- same order as they were originally.
 ---
---- Can also be used as a |method|: >vim
----   mylist->sort()
----
---- <Also see |uniq()|.
 ---
 --- Example: >vim
 ---   func MyCompare(i1, i2)
@@ -9449,10 +8472,6 @@ function vim.fn.sort(list, func, dict) end
 --- This can be used for making spelling suggestions.  Note that
 --- the method can be quite slow.
 ---
---- Can also be used as a |method|: >vim
----   GetWord()->soundfold()
---- <
----
 --- @param word any
 --- @return any
 function vim.fn.soundfold(word) end
@@ -9480,10 +8499,6 @@ function vim.fn.soundfold(word) end
 --- The spelling information for the current window and the value
 --- of 'spelllang' are used.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->spellbadword()
---- <
----
 --- @param sentence? any
 --- @return any
 function vim.fn.spellbadword(sentence) end
@@ -9508,10 +8523,6 @@ function vim.fn.spellbadword(sentence) end
 --- The spelling information for the current window is used.  The
 --- values of 'spelllang' and 'spellsuggest' are used.
 ---
---- Can also be used as a |method|: >vim
----   GetWord()->spellsuggest()
---- <
----
 --- @param word any
 --- @param max? any
 --- @param capital? any
@@ -9542,10 +8553,6 @@ function vim.fn.spellsuggest(word, max, capital) end
 ---   let items = split(line, ':', 1)
 --- <The opposite function is |join()|.
 ---
---- Can also be used as a |method|: >vim
----   GetString()->split()
---- <
----
 --- @param string string
 --- @param pattern? any
 --- @param keepempty? any
@@ -9564,10 +8571,6 @@ function vim.fn.split(string, pattern, keepempty) end
 --- <  str2float("nan")
 --- NaN may be different, it depends on system libraries.
 ---
---- Can also be used as a |method|: >vim
----   Compute()->sqrt()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.sqrt(expr) end
@@ -9585,9 +8588,6 @@ function vim.fn.sqrt(expr) end
 ---   let seed = srand(userinput)
 ---   echo rand(seed)
 --- <
---- Can also be used as a |method|: >vim
----   userinput->srand()
---- <
 ---
 --- @param expr? any
 --- @return any
@@ -9660,10 +8660,6 @@ function vim.fn.stdpath(what) end
 --- <
 --- Returns 0.0 if the conversion fails.
 ---
---- Can also be used as a |method|: >vim
----   let f = text->substitute(',', '', 'g')->str2float()
---- <
----
 --- @param string string
 --- @param quoted? any
 --- @return any
@@ -9680,10 +8676,6 @@ function vim.fn.str2float(string, quoted) end
 --- With UTF-8 composing characters are handled properly: >vim
 ---   echo str2list("á")    " returns [97, 769]
 ---
---- <Can also be used as a |method|: >vim
----   GetString()->str2list()
---- <
----
 --- @param string string
 --- @param utf8? any
 --- @return any
@@ -9707,10 +8699,6 @@ function vim.fn.str2list(string, utf8) end
 ---
 --- Returns 0 if {string} is empty or on error.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->str2nr()
---- <
----
 --- @param string string
 --- @param base? any
 --- @return any
@@ -9725,10 +8713,6 @@ function vim.fn.str2nr(string, base) end
 ---
 --- Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->strcharlen()
---- <
----
 --- @param string string
 --- @return any
 function vim.fn.strcharlen(string) end
@@ -9747,10 +8731,6 @@ function vim.fn.strcharlen(string) end
 ---
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->strcharpart(5)
---- <
----
 --- @param src any
 --- @param start any
 --- @param len? any
@@ -9785,9 +8765,6 @@ function vim.fn.strcharpart(src, start, len, skipcc) end
 ---       endfunction
 ---     endif
 --- <
---- Can also be used as a |method|: >vim
----   GetText()->strchars()
---- <
 ---
 --- @param string string
 --- @param skipcc? any
@@ -9807,10 +8784,6 @@ function vim.fn.strchars(string, skipcc) end
 --- Returns zero on error.
 --- Also see |strlen()|, |strwidth()| and |strchars()|.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->strdisplaywidth()
---- <
----
 --- @param string string
 --- @param col? integer
 --- @return any
@@ -9832,10 +8805,6 @@ function vim.fn.strdisplaywidth(string, col) end
 ---   echo strftime("%c", getftime("file.c"))
 ---            " Show mod time of file.c.
 ---
---- <Can also be used as a |method|: >vim
----   GetFormat()->strftime()
---- <
----
 --- @param format any
 --- @param time? any
 --- @return any
@@ -9849,10 +8818,6 @@ function vim.fn.strftime(format, time) end
 --- Returns -1 if {index} is invalid.
 --- Also see |strcharpart()| and |strchars()|.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->strgetchar(5)
---- <
----
 --- @param str any
 --- @param index any
 --- @return any
@@ -9876,10 +8841,6 @@ function vim.fn.strgetchar(str, index) end
 --- stridx() works similar to the C function strstr().  When used
 --- with a single character it works similar to strchr().
 ---
---- Can also be used as a |method|: >vim
----   GetHaystack()->stridx(needle)
---- <
----
 --- @param haystack any
 --- @param needle any
 --- @param start? any
@@ -9909,10 +8870,6 @@ function vim.fn.stridx(haystack, needle, start) end
 --- method, use |msgpackdump()| or |json_encode()| if you need to
 --- share data with other application.
 ---
---- Can also be used as a |method|: >vim
----   mylist->string()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.string(expr) end
@@ -9925,10 +8882,6 @@ function vim.fn.string(expr) end
 --- |strchars()|.
 --- Also see |len()|, |strdisplaywidth()| and |strwidth()|.
 ---
---- Can also be used as a |method|: >vim
----   GetString()->strlen()
---- <
----
 --- @param string string
 --- @return any
 function vim.fn.strlen(string) end
@@ -9957,10 +8910,6 @@ function vim.fn.strlen(string) end
 --- <
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->strpart(5)
---- <
----
 --- @param src any
 --- @param start any
 --- @param len? any
@@ -9991,10 +8940,6 @@ function vim.fn.strpart(src, start, len, chars) end
 ---   echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
 --- <  Sun Apr 27 12:53:55 1997
 ---
---- Can also be used as a |method|: >vim
----   GetFormat()->strptime(timestring)
---- <
----
 --- @param format any
 --- @param timestring any
 --- @return any
@@ -10017,10 +8962,6 @@ function vim.fn.strptime(format, timestring) end
 --- When used with a single character it works similar to the C
 --- function strrchr().
 ---
---- Can also be used as a |method|: >vim
----   GetHaystack()->strridx(needle)
---- <
----
 --- @param haystack any
 --- @param needle any
 --- @param start? any
@@ -10036,10 +8977,6 @@ function vim.fn.strridx(haystack, needle, start) end
 ---
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >vim
----   GetString()->strtrans()
---- <
----
 --- @param string string
 --- @return any
 function vim.fn.strtrans(string) end
@@ -10062,10 +8999,6 @@ function vim.fn.strtrans(string) end
 ---     echo strutf16len('ą́')    " returns 1
 ---     echo strutf16len('ą́', v:true)  " returns 3
 ---
---- Can also be used as a |method|: >vim
----   GetText()->strutf16len()
---- <
----
 --- @param string string
 --- @param countcc? any
 --- @return any
@@ -10079,10 +9012,6 @@ function vim.fn.strutf16len(string, countcc) end
 --- Returns zero on error.
 --- Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
 ---
---- Can also be used as a |method|: >vim
----   GetString()->strwidth()
---- <
----
 --- @param string string
 --- @return any
 function vim.fn.strwidth(string) end
@@ -10114,10 +9043,6 @@ function vim.fn.strwidth(string) end
 --- <This finds the first number in the line and adds one to it.
 --- A line break is included as a newline character.
 ---
---- Can also be used as a |method|: >vim
----   GetNr()->submatch()
---- <
----
 --- @param nr integer
 --- @param list? any
 --- @return any
@@ -10165,10 +9090,6 @@ function vim.fn.submatch(nr, list) end
 ---
 --- <Returns an empty string on error.
 ---
---- Can also be used as a |method|: >vim
----   GetString()->substitute(pat, sub, flags)
---- <
----
 --- @param string string
 --- @param pat any
 --- @param sub any
@@ -10206,10 +9127,6 @@ function vim.fn.swapfilelist() end
 ---   Not a swap file: does not contain correct block ID
 ---   Magic number mismatch: Info in first block is invalid
 ---
---- Can also be used as a |method|: >vim
----   GetFilename()->swapinfo()
---- <
----
 --- @param fname integer
 --- @return any
 function vim.fn.swapinfo(fname) end
@@ -10220,10 +9137,6 @@ function vim.fn.swapinfo(fname) end
 --- |:swapname| (unless there is no swap file).
 --- If buffer {buf} has no swap file, returns an empty string.
 ---
---- Can also be used as a |method|: >vim
----   GetBufname()->swapname()
---- <
----
 --- @param buf any
 --- @return any
 function vim.fn.swapname(buf) end
@@ -10317,10 +9230,6 @@ function vim.fn.synIDattr(synID, what, mode) end
 ---
 --- Returns zero on error.
 ---
---- Can also be used as a |method|: >vim
----   echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
---- <
----
 --- @param synID any
 --- @return any
 function vim.fn.synIDtrans(synID) end
@@ -10426,10 +9335,6 @@ function vim.fn.synstack(lnum, col) end
 --- <Unlike ":!cmd" there is no automatic check for changed files.
 --- Use |:checktime| to force a check.
 ---
---- Can also be used as a |method|: >vim
----   echo GetCmd()->system()
---- <
----
 --- @param cmd any
 --- @param input? any
 --- @return any
@@ -10448,10 +9353,6 @@ function vim.fn.system(cmd, input) end
 --- <
 --- Returns an empty string on error.
 ---
---- Can also be used as a |method|: >vim
----   echo GetCmd()->systemlist()
---- <
----
 --- @param cmd any
 --- @param input? any
 --- @param keepempty? any
@@ -10470,10 +9371,6 @@ function vim.fn.systemlist(cmd, input, keepempty) end
 ---   endfor
 --- <Note that a buffer may appear in more than one window.
 ---
---- Can also be used as a |method|: >vim
----   GetTabpage()->tabpagebuflist()
---- <
----
 --- @param arg? any
 --- @return any
 function vim.fn.tabpagebuflist(arg) end
@@ -10507,10 +9404,6 @@ function vim.fn.tabpagenr(arg) end
 ---     tabpagewinnr(4, '$')    " number of windows in tab page 4
 --- <When {tabarg} is invalid zero is returned.
 ---
---- Can also be used as a |method|: >vim
----   GetTabpage()->tabpagewinnr()
---- <
----
 --- @param tabarg any
 --- @param arg? any
 --- @return any
@@ -10564,9 +9457,6 @@ function vim.fn.tagfiles() end
 --- located by Vim. Refer to |tags-file-format| for the format of
 --- the tags file generated by the different ctags tools.
 ---
---- Can also be used as a |method|: >vim
----   GetTagpattern()->taglist()
----
 --- @param expr any
 --- @param filename? any
 --- @return any
@@ -10582,10 +9472,6 @@ function vim.fn.taglist(expr, filename) end
 ---   echo tan(-4.01)
 --- <  -1.181502
 ---
---- Can also be used as a |method|: >vim
----   Compute()->tan()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.tan(expr) end
@@ -10600,10 +9486,6 @@ function vim.fn.tan(expr) end
 ---   echo tanh(-1)
 --- <  -0.761594
 ---
---- Can also be used as a |method|: >vim
----   Compute()->tanh()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.tanh(expr) end
@@ -10651,10 +9533,6 @@ function vim.fn.termopen(cmd, opts) end
 ---         -1 means forever
 ---     "callback"      the callback
 ---
---- Can also be used as a |method|: >vim
----   GetTimer()->timer_info()
---- <
----
 --- @param id? any
 --- @return any
 function vim.fn.timer_info(id) end
@@ -10671,10 +9549,6 @@ function vim.fn.timer_info(id) end
 --- String, then the timer is paused, otherwise it is unpaused.
 --- See |non-zero-arg|.
 ---
---- Can also be used as a |method|: >vim
----   GetTimer()->timer_pause(1)
---- <
----
 --- @param timer any
 --- @param paused any
 --- @return any
@@ -10709,11 +9583,6 @@ function vim.fn.timer_pause(timer, paused) end
 ---     \ {'repeat': 3})
 --- <This invokes MyHandler() three times at 500 msec intervals.
 ---
---- Can also be used as a |method|: >vim
----   GetMsec()->timer_start(callback)
----
---- <Not available in the |sandbox|.
----
 --- @param time any
 --- @param callback any
 --- @param options? table
@@ -10724,10 +9593,6 @@ function vim.fn.timer_start(time, callback, options) end
 --- {timer} is an ID returned by timer_start(), thus it must be a
 --- Number.  If {timer} does not exist there is no error.
 ---
---- Can also be used as a |method|: >vim
----   GetTimer()->timer_stop()
---- <
----
 --- @param timer any
 --- @return any
 function vim.fn.timer_stop(timer) end
@@ -10743,10 +9608,6 @@ function vim.fn.timer_stopall() end
 --- characters turned into lowercase (just like applying |gu| to
 --- the string).  Returns an empty string on error.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->tolower()
---- <
----
 --- @param expr any
 --- @return string
 function vim.fn.tolower(expr) end
@@ -10755,10 +9616,6 @@ function vim.fn.tolower(expr) end
 --- characters turned into uppercase (just like applying |gU| to
 --- the string).  Returns an empty string on error.
 ---
---- Can also be used as a |method|: >vim
----   GetText()->toupper()
---- <
----
 --- @param expr any
 --- @return string
 function vim.fn.toupper(expr) end
@@ -10778,10 +9635,6 @@ function vim.fn.toupper(expr) end
 ---   echo tr("<blob>", "<>", "{}")
 --- <returns "{blob}"
 ---
---- Can also be used as a |method|: >vim
----   GetText()->tr(from, to)
---- <
----
 --- @param src any
 --- @param fromstr any
 --- @param tostr any
@@ -10812,10 +9665,6 @@ function vim.fn.tr(src, fromstr, tostr) end
 ---   echo trim("  vim  ", " ", 2)
 --- <returns "  vim"
 ---
---- Can also be used as a |method|: >vim
----   GetText()->trim()
---- <
----
 --- @param text any
 --- @param mask? any
 --- @param dir? string
@@ -10834,10 +9683,6 @@ function vim.fn.trim(text, mask, dir) end
 ---   echo trunc(4.0)
 --- <  4.0
 ---
---- Can also be used as a |method|: >vim
----   Compute()->trunc()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.trunc(expr) end
@@ -10868,10 +9713,6 @@ function vim.fn.trunc(expr) end
 --- <To check if the v:t_ variables exist use this: >vim
 ---   if exists('v:t_number') | endif
 ---
---- <Can also be used as a |method|: >vim
----   mylist->type()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.type(expr) end
@@ -10886,10 +9727,6 @@ function vim.fn.type(expr) end
 --- buffer without a file name will not write an undo file.
 --- Useful in combination with |:wundo| and |:rundo|.
 ---
---- Can also be used as a |method|: >vim
----   GetFilename()->undofile()
---- <
----
 --- @param name string
 --- @return string
 function vim.fn.undofile(name) end
@@ -10948,10 +9785,6 @@ function vim.fn.undotree() end
 ---
 --- Returns zero if {list} is not a |List|.
 ---
---- Can also be used as a |method|: >vim
----   mylist->uniq()
---- <
----
 --- @param list any
 --- @param func? any
 --- @param dict? any
@@ -10984,9 +9817,6 @@ function vim.fn.uniq(list, func, dict) end
 ---   echo utf16idx('aą́c', 6, 1)  " returns 4
 ---   echo utf16idx('a😊😊', 9)  " returns -1
 --- <
---- Can also be used as a |method|: >vim
----   GetName()->utf16idx(idx)
---- <
 ---
 --- @param string string
 --- @param idx integer
@@ -10999,10 +9829,6 @@ function vim.fn.utf16idx(string, idx, countcc, charidx) end
 --- in arbitrary order.  Also see |items()| and |keys()|.
 --- Returns zero if {dict} is not a |Dict|.
 ---
---- Can also be used as a |method|: >vim
----   mydict->values()
---- <
----
 --- @param dict any
 --- @return any
 function vim.fn.values(dict) end
@@ -11058,10 +9884,6 @@ function vim.fn.values(dict) end
 --- all lines: >vim
 ---     echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
 ---
---- <Can also be used as a |method|: >vim
----   GetPos()->virtcol()
---- <
----
 --- @param expr any
 --- @param list? any
 --- @return any
@@ -11083,10 +9905,6 @@ function vim.fn.virtcol(expr, list) end
 ---
 --- See also |screenpos()|, |virtcol()| and |col()|.
 ---
---- Can also be used as a |method|: >vim
----   GetWinid()->virtcol2col(lnum, col)
---- <
----
 --- @param winid integer
 --- @param lnum integer
 --- @param col integer
@@ -11161,11 +9979,6 @@ function vim.fn.wildmenumode() end
 --- When window {id} does not exist then no error is given and
 --- an empty string is returned.
 ---
---- Can also be used as a |method|, the base is passed as the
---- second argument: >vim
----   GetCommand()->win_execute(winid)
---- <
----
 --- @param id any
 --- @param command any
 --- @param silent? boolean
@@ -11175,10 +9988,6 @@ function vim.fn.win_execute(id, command, silent) end
 --- Returns a |List| with |window-ID|s for windows that contain
 --- buffer {bufnr}.  When there is none the list is empty.
 ---
---- Can also be used as a |method|: >vim
----   GetBufnr()->win_findbuf()
---- <
----
 --- @param bufnr any
 --- @return integer[]
 function vim.fn.win_findbuf(bufnr) end
@@ -11191,10 +10000,6 @@ function vim.fn.win_findbuf(bufnr) end
 --- number {tab}.  The first tab has number one.
 --- Return zero if the window cannot be found.
 ---
---- Can also be used as a |method|: >vim
----   GetWinnr()->win_getid()
---- <
----
 --- @param win? any
 --- @param tab? any
 --- @return integer
@@ -11217,10 +10022,6 @@ function vim.fn.win_getid(win, tab) end
 ---
 --- Also see the 'buftype' option.
 ---
---- Can also be used as a |method|: >vim
----   GetWinid()->win_gettype()
---- <
----
 --- @param nr? integer
 --- @return 'autocmd'|'command'|''|'loclist'|'popup'|'preview'|'quickfix'|'unknown'
 function vim.fn.win_gettype(nr) end
@@ -11229,10 +10030,6 @@ function vim.fn.win_gettype(nr) end
 --- tabpage.
 --- Return TRUE if successful, FALSE if the window cannot be found.
 ---
---- Can also be used as a |method|: >vim
----   GetWinid()->win_gotoid()
---- <
----
 --- @param expr any
 --- @return 0|1
 function vim.fn.win_gotoid(expr) end
@@ -11241,10 +10038,6 @@ function vim.fn.win_gotoid(expr) end
 --- with ID {expr}: [tabnr, winnr].
 --- Return [0, 0] if the window cannot be found.
 ---
---- Can also be used as a |method|: >vim
----   GetWinid()->win_id2tabwin()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.win_id2tabwin(expr) end
@@ -11252,10 +10045,6 @@ function vim.fn.win_id2tabwin(expr) end
 --- Return the window number of window with ID {expr}.
 --- Return 0 if the window cannot be found in the current tabpage.
 ---
---- Can also be used as a |method|: >vim
----   GetWinid()->win_id2win()
---- <
----
 --- @param expr any
 --- @return any
 function vim.fn.win_id2win(expr) end
@@ -11274,10 +10063,6 @@ function vim.fn.win_id2win(expr) end
 --- window, since it has no separator on the right.
 --- Only works for the current tab page. *E1308*
 ---
---- Can also be used as a |method|: >vim
----   GetWinnr()->win_move_separator(offset)
---- <
----
 --- @param nr integer
 --- @param offset any
 --- @return any
@@ -11294,10 +10079,6 @@ function vim.fn.win_move_separator(nr, offset) end
 --- be found and FALSE otherwise.
 --- Only works for the current tab page.
 ---
---- Can also be used as a |method|: >vim
----   GetWinnr()->win_move_statusline(offset)
---- <
----
 --- @param nr integer
 --- @param offset any
 --- @return any
@@ -11311,10 +10092,6 @@ function vim.fn.win_move_statusline(nr, offset) end
 --- Returns [0, 0] if the window cannot be found in the current
 --- tabpage.
 ---
---- Can also be used as a |method|: >vim
----   GetWinid()->win_screenpos()
---- <
----
 --- @param nr integer
 --- @return any
 function vim.fn.win_screenpos(nr) end
@@ -11338,10 +10115,6 @@ function vim.fn.win_screenpos(nr) end
 ---     present, the values of 'splitbelow' and
 ---     'splitright' are used.
 ---
---- Can also be used as a |method|: >vim
----   GetWinid()->win_splitmove(target)
---- <
----
 --- @param nr integer
 --- @param target any
 --- @param options? table
@@ -11357,9 +10130,6 @@ function vim.fn.win_splitmove(nr, target, options) end
 --- Example: >vim
 ---   echo "The file in the current window is " .. bufname(winbufnr(0))
 --- <
---- Can also be used as a |method|: >vim
----   FindWindow()->winbufnr()->bufname()
---- <
 ---
 --- @param nr integer
 --- @return integer
@@ -11389,10 +10159,6 @@ function vim.fn.windowsversion() end
 --- Examples: >vim
 ---   echo "The current window has " .. winheight(0) .. " lines."
 ---
---- <Can also be used as a |method|: >vim
----   GetWinid()->winheight()
---- <
----
 --- @param nr integer
 --- @return integer
 function vim.fn.winheight(nr) end
@@ -11432,9 +10198,6 @@ function vim.fn.winheight(nr) end
 ---   ['col', [['leaf', 1002], ['row', [['leaf', 1003],
 ---           ['leaf', 1001]]], ['leaf', 1000]]]
 --- <
---- Can also be used as a |method|: >vim
----   GetTabnr()->winlayout()
---- <
 ---
 --- @param tabnr? integer
 --- @return any
@@ -11477,10 +10240,6 @@ function vim.fn.winline() end
 ---   let prev_window = winnr('#')
 ---   let wnum = winnr('3k')
 ---
---- <Can also be used as a |method|: >vim
----   GetWinval()->winnr()
---- <
----
 --- @param arg? any
 --- @return any
 function vim.fn.winnr(arg) end
@@ -11513,10 +10272,6 @@ function vim.fn.winrestcmd() end
 --- If you have changed the values the result is unpredictable.
 --- If the window size changed the result won't be the same.
 ---
---- Can also be used as a |method|: >vim
----   GetView()->winrestview()
---- <
----
 --- @param dict any
 --- @return any
 function vim.fn.winrestview(dict) end
@@ -11563,10 +10318,6 @@ function vim.fn.winsaveview() end
 --- <For getting the terminal or screen size, see the 'columns'
 --- option.
 ---
---- Can also be used as a |method|: >vim
----   GetWinid()->winwidth()
---- <
----
 --- @param nr integer
 --- @return any
 function vim.fn.winwidth(nr) end
@@ -11639,10 +10390,6 @@ function vim.fn.wordcount() end
 ---   let fl = readfile("foo", "b")
 ---   call writefile(fl, "foocopy", "b")
 ---
---- <Can also be used as a |method|: >vim
----   GetText()->writefile("thefile")
---- <
----
 --- @param object any
 --- @param fname integer
 --- @param flags? string
@@ -11655,9 +10402,6 @@ function vim.fn.writefile(object, fname, flags) end
 --- Example: >vim
 ---   let bits = xor(bits, 0x80)
 --- <
---- Can also be used as a |method|: >vim
----   let bits = bits->xor(0x80)
---- <
 ---
 --- @param expr any
 --- @param expr1 any
-- 
cgit 


From 1ee905a63aa9f3d6873ec75a0954866d8660699e Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Wed, 2 Aug 2023 22:14:32 +0800
Subject: docs(builtin): fix alignment of comments in code blocks (#24529)

---
 runtime/lua/vim/_meta/vimfn.lua | 38 +++++++++++++++++++-------------------
 1 file changed, 19 insertions(+), 19 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 3de2e5ac4f..b15d780121 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -572,9 +572,9 @@ function vim.fn.bufloaded(buf) end
 --- If the {buf} is a String, but you want to use it as a buffer
 --- <If the buffer doesn't exist, or doesn't have a name, an empty
 --- string is returned. >vim
----   echo bufname("#")    " alternate buffer name
+---   echo bufname("#")  " alternate buffer name
 ---   echo bufname(3)    " name of buffer 3
----   echo bufname("%")    " name of current buffer
+---   echo bufname("%")  " name of current buffer
 ---   echo bufname("file2")  " name of buffer where "file2" matches.
 --- <
 ---
@@ -778,10 +778,10 @@ function vim.fn.chansend(id, data) end
 
 --- Return Number value of the first char in {string}.
 --- Examples: >vim
----   echo char2nr(" ")    " returns 32
----   echo char2nr("ABC")    " returns 65
----   echo char2nr("á")    " returns 225
----   echo char2nr("á"[0])    " returns 195
+---   echo char2nr(" ")  " returns 32
+---   echo char2nr("ABC")  " returns 65
+---   echo char2nr("á")  " returns 225
+---   echo char2nr("á"[0])  " returns 195
 ---   echo char2nr("\<M-x>")  " returns 128
 --- <Non-ASCII characters are always treated as UTF-8 characters.
 --- {utf8} is ignored, it exists only for backwards-compatibility.
@@ -814,7 +814,7 @@ function vim.fn.charclass(string) end
 ---
 --- Example:
 --- With the cursor on '세' in line 5 with text "여보세요": >vim
----   echo charcol('.')    " returns 3
+---   echo charcol('.')  " returns 3
 ---   echo col('.')    " returns 7
 ---
 --- @param expr any
@@ -929,9 +929,9 @@ function vim.fn.clearmatches(win) end
 --- character position use |charcol()|.
 --- Note that only marks in the current file can be used.
 --- Examples: >vim
----   echo col(".")    " column of cursor
----   echo col("$")    " length of cursor line plus one
----   echo col("'t")    " column of mark t
+---   echo col(".")      " column of cursor
+---   echo col("$")      " length of cursor line plus one
+---   echo col("'t")      " column of mark t
 ---   echo col("'" .. markname)  " column of mark markname
 --- <The first column is 1.  Returns 0 if {expr} is invalid or when
 --- the window with ID {winid} is not found.
@@ -4809,9 +4809,9 @@ function vim.fn.libcallnr(libname, funcname, argument) end
 --- that window instead of the current window.
 --- Returns 0 for invalid values of {expr} and {winid}.
 --- Examples: >vim
----   echo line(".")    " line number of the cursor
----   echo line(".", winid)  " idem, in window "winid"
----   echo line("'t")    " line number of mark t
+---   echo line(".")      " line number of the cursor
+---   echo line(".", winid)    " idem, in window "winid"
+---   echo line("'t")      " line number of mark t
 ---   echo line("'" .. marker)  " line number of mark marker
 --- <
 --- To jump to the last known position when opening a file see
@@ -6303,11 +6303,11 @@ function vim.fn.rand(expr) end
 --- start this is an error.
 --- Examples: >vim
 ---   echo range(4)    " [0, 1, 2, 3]
----   echo range(2, 4)    " [2, 3, 4]
----   echo range(2, 9, 3)    " [2, 5, 8]
+---   echo range(2, 4)  " [2, 3, 4]
+---   echo range(2, 9, 3)  " [2, 5, 8]
 ---   echo range(2, -2, -1)  " [2, 1, 0, -1, -2]
 ---   echo range(0)    " []
----   echo range(2, 0)    " error!
+---   echo range(2, 0)  " error!
 --- <
 ---
 --- @param expr any
@@ -8801,7 +8801,7 @@ function vim.fn.strdisplaywidth(string, col) end
 ---   echo strftime("%c")       " Sun Apr 27 11:49:23 1997
 ---   echo strftime("%Y %b %d %X")     " 1997 Apr 27 11:53:25
 ---   echo strftime("%y%m%d %T")     " 970427 11:53:55
----   echo strftime("%H:%M")             " 11:55
+---   echo strftime("%H:%M")       " 11:55
 ---   echo strftime("%c", getftime("file.c"))
 ---            " Show mod time of file.c.
 ---
@@ -8834,8 +8834,8 @@ function vim.fn.strgetchar(str, index) end
 --- -1 is returned if the {needle} does not occur in {haystack}.
 --- See also |strridx()|.
 --- Examples: >vim
----   echo stridx("An Example", "Example")       " 3
----   echo stridx("Starting point", "Start")    " 0
+---   echo stridx("An Example", "Example")     " 3
+---   echo stridx("Starting point", "Start")   " 0
 ---   echo stridx("Starting point", "start")   " -1
 --- <        *strstr()* *strchr()*
 --- stridx() works similar to the C function strstr().  When used
-- 
cgit 


From 4a06de40e7c5bfe3be8f243b23b1676034fc6b08 Mon Sep 17 00:00:00 2001
From: Marc Jakobi <marc.jakobi@tiko.energy>
Date: Wed, 2 Aug 2023 20:22:44 +0200
Subject: docs(lua): fix generated `fname` param annotations #24533

---
 runtime/lua/vim/_meta/vimfn.lua | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index b15d780121..bb11e34a57 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -1315,7 +1315,7 @@ function vim.fn.deepcopy(expr, noref) end
 --- operation was successful and -1/true when the deletion failed
 --- or partly failed.
 ---
---- @param fname integer
+--- @param fname string
 --- @param flags? string
 --- @return integer
 function vim.fn.delete(fname, flags) end
@@ -2222,7 +2222,7 @@ function vim.fn.fnameescape(string) end
 --- Note: Environment variables don't work in {fname}, use
 --- |expand()| first then.
 ---
---- @param fname integer
+--- @param fname string
 --- @param mods string
 --- @return string
 function vim.fn.fnamemodify(fname, mods) end
@@ -3029,7 +3029,7 @@ function vim.fn.getfontname(name) end
 ---
 --- For setting permissions use |setfperm()|.
 ---
---- @param fname integer
+--- @param fname string
 --- @return string
 function vim.fn.getfperm(fname) end
 
@@ -3040,7 +3040,7 @@ function vim.fn.getfperm(fname) end
 --- If the size of {fname} is too big to fit in a Number then -2
 --- is returned.
 ---
---- @param fname integer
+--- @param fname string
 --- @return integer
 function vim.fn.getfsize(fname) end
 
@@ -3050,7 +3050,7 @@ function vim.fn.getfsize(fname) end
 --- |localtime()| and |strftime()|.
 --- If the file {fname} can't be found -1 is returned.
 ---
---- @param fname integer
+--- @param fname string
 --- @return integer
 function vim.fn.getftime(fname) end
 
@@ -3073,7 +3073,7 @@ function vim.fn.getftime(fname) end
 --- systems that support it.  On some systems only "dir" and
 --- "file" are returned.
 ---
---- @param fname integer
+--- @param fname string
 --- @return 'file'|'dir'|'link'|'bdev'|'cdev'|'socket'|'fifo'|'other'
 function vim.fn.getftype(fname) end
 
@@ -6339,7 +6339,7 @@ function vim.fn.range(expr, max, stride) end
 --- is truncated.
 --- Also see |readfile()| and |writefile()|.
 ---
---- @param fname integer
+--- @param fname string
 --- @param offset? any
 --- @param size? any
 --- @return any
@@ -6411,7 +6411,7 @@ function vim.fn.readdir(directory, expr) end
 --- the result is an empty list.
 --- Also see |writefile()|.
 ---
---- @param fname integer
+--- @param fname string
 --- @param type? any
 --- @param max? any
 --- @return any
@@ -7441,7 +7441,7 @@ function vim.fn.setenv(name, val) end
 ---
 --- To read permissions see |getfperm()|.
 ---
---- @param fname integer
+--- @param fname string
 --- @param mode string
 --- @return any
 function vim.fn.setfperm(fname, mode) end
@@ -9127,7 +9127,7 @@ function vim.fn.swapfilelist() end
 ---   Not a swap file: does not contain correct block ID
 ---   Magic number mismatch: Info in first block is invalid
 ---
---- @param fname integer
+--- @param fname string
 --- @return any
 function vim.fn.swapinfo(fname) end
 
@@ -10391,7 +10391,7 @@ function vim.fn.wordcount() end
 ---   call writefile(fl, "foocopy", "b")
 ---
 --- @param object any
---- @param fname integer
+--- @param fname string
 --- @param flags? string
 --- @return any
 function vim.fn.writefile(object, fname, flags) end
-- 
cgit 


From 214b125132778c5d51d4d7e673d31a9be835e150 Mon Sep 17 00:00:00 2001
From: Raphael <glephunter@gmail.com>
Date: Thu, 3 Aug 2023 17:52:21 +0800
Subject: fix(gen_lsp.lua): no notifications in lsp.Methods #24530

Problem:
- Notifications are missing from `lsp.Methods`.
- Need a way to represent `$/` prefixed methods.

Solution:
- Generate notifications.
- Use "dollar_" prefix for `$/` methods.
---
 runtime/lua/vim/lsp/protocol.lua | 86 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 85 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 3844c697c6..0755fa991f 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -954,22 +954,46 @@ protocol.Methods = {
   --- parameter is of type {@link DocumentLink} the response
   --- is of type {@link DocumentLink} or a Thenable that resolves to such.
   documentLink_resolve = 'documentLink/resolve',
+  dollar_cancelRequest = '$/cancelRequest',
+  dollar_logTrace = '$/logTrace',
+  dollar_progress = '$/progress',
+  dollar_setTrace = '$/setTrace',
+  --- The exit event is sent from the client to the server to
+  --- ask the server to exit its process.
+  exit = 'exit',
   --- The initialize request is sent from the client to the server.
   --- It is sent once as the request after starting up the server.
   --- The requests parameter is of type {@link InitializeParams}
   --- the response if of type {@link InitializeResult} of a Thenable that
   --- resolves to such.
   initialize = 'initialize',
+  --- The initialized notification is sent from the client to the
+  --- server after the client is fully initialized and the server
+  --- is allowed to send requests from the server to the client.
+  initialized = 'initialized',
   --- A request to resolve additional properties for an inlay hint.
   --- The request's parameter is of type {@link InlayHint}, the response is
   --- of type {@link InlayHint} or a Thenable that resolves to such.
   --- @since 3.17.0
   inlayHint_resolve = 'inlayHint/resolve',
+  notebookDocument_didChange = 'notebookDocument/didChange',
+  --- A notification sent when a notebook closes.
+  --- @since 3.17.0
+  notebookDocument_didClose = 'notebookDocument/didClose',
+  --- A notification sent when a notebook opens.
+  --- @since 3.17.0
+  notebookDocument_didOpen = 'notebookDocument/didOpen',
+  --- A notification sent when a notebook document is saved.
+  --- @since 3.17.0
+  notebookDocument_didSave = 'notebookDocument/didSave',
   --- A shutdown request is sent from the client to the server.
   --- It is sent once when the client decides to shutdown the
   --- server. The only notification that is sent after a shutdown request
   --- is the exit event.
   shutdown = 'shutdown',
+  --- The telemetry event notification is sent from the server to the client to ask
+  --- the client to log telemetry data.
+  telemetry_event = 'telemetry/event',
   --- A request to provide commands for the given text document and range.
   textDocument_codeAction = 'textDocument/codeAction',
   --- A request to provide code lens for the given text document.
@@ -1003,6 +1027,29 @@ protocol.Methods = {
   --- The document diagnostic request definition.
   --- @since 3.17.0
   textDocument_diagnostic = 'textDocument/diagnostic',
+  --- The document change notification is sent from the client to the server to signal
+  --- changes to a text document.
+  textDocument_didChange = 'textDocument/didChange',
+  --- The document close notification is sent from the client to the server when
+  --- the document got closed in the client. The document's truth now exists where
+  --- the document's uri points to (e.g. if the document's uri is a file uri the
+  --- truth now exists on disk). As with the open notification the close notification
+  --- is about managing the document's content. Receiving a close notification
+  --- doesn't mean that the document was open in an editor before. A close
+  --- notification requires a previous open notification to be sent.
+  textDocument_didClose = 'textDocument/didClose',
+  --- The document open notification is sent from the client to the server to signal
+  --- newly opened text documents. The document's truth is now managed by the client
+  --- and the server must not try to read the document's truth using the document's
+  --- uri. Open in this sense means it is managed by the client. It doesn't necessarily
+  --- mean that its content is presented in an editor. An open notification must not
+  --- be sent more than once without a corresponding close notification send before.
+  --- This means open and close notification must be balanced and the max open count
+  --- is one.
+  textDocument_didOpen = 'textDocument/didOpen',
+  --- The document save notification is sent from the client to the server when
+  --- the document got saved in the client.
+  textDocument_didSave = 'textDocument/didSave',
   --- A request to list all color symbols found in a given text document. The request's
   --- parameter is of type {@link DocumentColorParams} the
   --- response is of type {@link ColorInformation ColorInformation[]} or a Thenable
@@ -1025,7 +1072,7 @@ protocol.Methods = {
   --- response is of type {@link FoldingRangeList} or a Thenable
   --- that resolves to such.
   textDocument_foldingRange = 'textDocument/foldingRange',
-  --- A request to format a whole document.
+  --- A request to to format a whole document.
   textDocument_formatting = 'textDocument/formatting',
   --- Request to request hover information at a given text document position. The request's
   --- parameter is of type {@link TextDocumentPosition} the response is of
@@ -1071,6 +1118,9 @@ protocol.Methods = {
   --- Can be used as an input to a subtypes or supertypes type hierarchy.
   --- @since 3.17.0
   textDocument_prepareTypeHierarchy = 'textDocument/prepareTypeHierarchy',
+  --- Diagnostics notification are sent from the server to the client to signal
+  --- results of validation runs.
+  textDocument_publishDiagnostics = 'textDocument/publishDiagnostics',
   --- A request to format a range in a document.
   textDocument_rangeFormatting = 'textDocument/rangeFormatting',
   --- A request to format ranges in a document.
@@ -1101,6 +1151,9 @@ protocol.Methods = {
   --- (#TextDocumentPositionParams) the response is of type {@link Definition} or a
   --- Thenable that resolves to such.
   textDocument_typeDefinition = 'textDocument/typeDefinition',
+  --- A document will save notification is sent from the client to the server before
+  --- the document is actually saved.
+  textDocument_willSave = 'textDocument/willSave',
   --- A document will save request is sent from the client to the server before
   --- the document is actually saved. The request can return an array of TextEdits
   --- which will be applied to the text document before it is saved. Please note that
@@ -1114,15 +1167,24 @@ protocol.Methods = {
   --- A request to resolve the supertypes for a given `TypeHierarchyItem`.
   --- @since 3.17.0
   typeHierarchy_supertypes = 'typeHierarchy/supertypes',
+  --- The log message notification is sent from the server to the client to ask
+  --- the client to log a particular message.
+  window_logMessage = 'window/logMessage',
   --- A request to show a document. This request might open an
   --- external program depending on the value of the URI to open.
   --- For example a request to open `https://code.visualstudio.com/`
   --- will very likely open the URI in a WEB browser.
   --- @since 3.16.0
   window_showDocument = 'window/showDocument',
+  --- The show message notification is sent from a server to a client to ask
+  --- the client to display a particular message in the user interface.
+  window_showMessage = 'window/showMessage',
   --- The show message request is sent from the server to the client to show a message
   --- and a set of options actions to the user.
   window_showMessageRequest = 'window/showMessageRequest',
+  --- The `window/workDoneProgress/cancel` notification is sent from  the client to the server to cancel a progress
+  --- initiated on the server side.
+  window_workDoneProgress_cancel = 'window/workDoneProgress/cancel',
   --- The `window/workDoneProgress/create` request is sent from the server to the client to initiate progress
   --- reporting from the server.
   window_workDoneProgress_create = 'window/workDoneProgress/create',
@@ -1148,6 +1210,28 @@ protocol.Methods = {
   --- The diagnostic refresh request definition.
   --- @since 3.17.0
   workspace_diagnostic_refresh = 'workspace/diagnostic/refresh',
+  --- The configuration change notification is sent from the client to the server
+  --- when the client's configuration has changed. The notification contains
+  --- the changed configuration as defined by the language client.
+  workspace_didChangeConfiguration = 'workspace/didChangeConfiguration',
+  --- The watched files notification is sent from the client to the server when
+  --- the client detects changes to file watched by the language client.
+  workspace_didChangeWatchedFiles = 'workspace/didChangeWatchedFiles',
+  --- The `workspace/didChangeWorkspaceFolders` notification is sent from the client to the server when the workspace
+  --- folder configuration changes.
+  workspace_didChangeWorkspaceFolders = 'workspace/didChangeWorkspaceFolders',
+  --- The did create files notification is sent from the client to the server when
+  --- files were created from within the client.
+  --- @since 3.16.0
+  workspace_didCreateFiles = 'workspace/didCreateFiles',
+  --- The will delete files request is sent from the client to the server before files are actually
+  --- deleted as long as the deletion is triggered from within the client.
+  --- @since 3.16.0
+  workspace_didDeleteFiles = 'workspace/didDeleteFiles',
+  --- The did rename files notification is sent from the client to the server when
+  --- files were renamed from within the client.
+  --- @since 3.16.0
+  workspace_didRenameFiles = 'workspace/didRenameFiles',
   --- A request send from the client to the server to execute a command. The request might return
   --- a workspace edit which the client will apply to the workspace.
   workspace_executeCommand = 'workspace/executeCommand',
-- 
cgit 


From f1772272b4fda43c093fc495f54b5e7c11968d62 Mon Sep 17 00:00:00 2001
From: Raphael <glephunter@gmail.com>
Date: Thu, 3 Aug 2023 19:03:48 +0800
Subject: refactor(lsp): use protocol.Methods instead of strings #24537

---
 runtime/lua/vim/lsp.lua                 | 101 ++++++++++++++++----------------
 runtime/lua/vim/lsp/_watchfiles.lua     |   3 +-
 runtime/lua/vim/lsp/buf.lua             |  54 ++++++++---------
 runtime/lua/vim/lsp/codelens.lua        |   5 +-
 runtime/lua/vim/lsp/diagnostic.lua      |   9 +--
 runtime/lua/vim/lsp/handlers.lua        |  71 +++++++++++-----------
 runtime/lua/vim/lsp/inlay_hint.lua      |  15 ++---
 runtime/lua/vim/lsp/semantic_tokens.lua |   5 +-
 runtime/lua/vim/lsp/tagfunc.lua         |   5 +-
 9 files changed, 138 insertions(+), 130 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index edf69af718..b4c853d3d4 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -3,6 +3,7 @@ local default_handlers = require('vim.lsp.handlers')
 local log = require('vim.lsp.log')
 local lsp_rpc = require('vim.lsp.rpc')
 local protocol = require('vim.lsp.protocol')
+local ms = protocol.Methods
 local util = require('vim.lsp.util')
 local sync = require('vim.lsp.sync')
 local semantic_tokens = require('vim.lsp.semantic_tokens')
@@ -35,34 +36,34 @@ local lsp = {
 
 -- maps request name to the required server_capability in the client.
 lsp._request_name_to_capability = {
-  ['textDocument/hover'] = { 'hoverProvider' },
-  ['textDocument/signatureHelp'] = { 'signatureHelpProvider' },
-  ['textDocument/definition'] = { 'definitionProvider' },
-  ['textDocument/implementation'] = { 'implementationProvider' },
-  ['textDocument/declaration'] = { 'declarationProvider' },
-  ['textDocument/typeDefinition'] = { 'typeDefinitionProvider' },
-  ['textDocument/documentSymbol'] = { 'documentSymbolProvider' },
-  ['textDocument/prepareCallHierarchy'] = { 'callHierarchyProvider' },
-  ['callHierarchy/incomingCalls'] = { 'callHierarchyProvider' },
-  ['callHierarchy/outgoingCalls'] = { 'callHierarchyProvider' },
-  ['textDocument/rename'] = { 'renameProvider' },
-  ['textDocument/prepareRename'] = { 'renameProvider', 'prepareProvider' },
-  ['textDocument/codeAction'] = { 'codeActionProvider' },
-  ['textDocument/codeLens'] = { 'codeLensProvider' },
-  ['codeLens/resolve'] = { 'codeLensProvider', 'resolveProvider' },
-  ['codeAction/resolve'] = { 'codeActionProvider', 'resolveProvider' },
-  ['workspace/executeCommand'] = { 'executeCommandProvider' },
-  ['workspace/symbol'] = { 'workspaceSymbolProvider' },
-  ['textDocument/references'] = { 'referencesProvider' },
-  ['textDocument/rangeFormatting'] = { 'documentRangeFormattingProvider' },
-  ['textDocument/formatting'] = { 'documentFormattingProvider' },
-  ['textDocument/completion'] = { 'completionProvider' },
-  ['textDocument/documentHighlight'] = { 'documentHighlightProvider' },
-  ['textDocument/semanticTokens/full'] = { 'semanticTokensProvider' },
-  ['textDocument/semanticTokens/full/delta'] = { 'semanticTokensProvider' },
-  ['textDocument/inlayHint'] = { 'inlayHintProvider' },
-  ['textDocument/diagnostic'] = { 'diagnosticProvider' },
-  ['inlayHint/resolve'] = { 'inlayHintProvider', 'resolveProvider' },
+  [ms.textDocument_hover] = { 'hoverProvider' },
+  [ms.textDocument_signatureHelp] = { 'signatureHelpProvider' },
+  [ms.textDocument_definition] = { 'definitionProvider' },
+  [ms.textDocument_implementation] = { 'implementationProvider' },
+  [ms.textDocument_declaration] = { 'declarationProvider' },
+  [ms.textDocument_typeDefinition] = { 'typeDefinitionProvider' },
+  [ms.textDocument_documentSymbol] = { 'documentSymbolProvider' },
+  [ms.textDocument_prepareCallHierarchy] = { 'callHierarchyProvider' },
+  [ms.callHierarchy_incomingCalls] = { 'callHierarchyProvider' },
+  [ms.callHierarchy_outgoingCalls] = { 'callHierarchyProvider' },
+  [ms.textDocument_rename] = { 'renameProvider' },
+  [ms.textDocument_prepareRename] = { 'renameProvider', 'prepareProvider' },
+  [ms.textDocument_codeAction] = { 'codeActionProvider' },
+  [ms.textDocument_codeLens] = { 'codeLensProvider' },
+  [ms.codeLens_resolve] = { 'codeLensProvider', 'resolveProvider' },
+  [ms.codeAction_resolve] = { 'codeActionProvider', 'resolveProvider' },
+  [ms.workspace_executeCommand] = { 'executeCommandProvider' },
+  [ms.workspace_symbol] = { 'workspaceSymbolProvider' },
+  [ms.textDocument_references] = { 'referencesProvider' },
+  [ms.textDocument_rangeFormatting] = { 'documentRangeFormattingProvider' },
+  [ms.textDocument_formatting] = { 'documentFormattingProvider' },
+  [ms.textDocument_completion] = { 'completionProvider' },
+  [ms.textDocument_documentHighlight] = { 'documentHighlightProvider' },
+  [ms.textDocument_semanticTokens_full] = { 'semanticTokensProvider' },
+  [ms.textDocument_semanticTokens_full_delta] = { 'semanticTokensProvider' },
+  [ms.textDocument_inlayHint] = { 'inlayHintProvider' },
+  [ms.textDocument_diagnostic] = { 'diagnosticProvider' },
+  [ms.inlayHint_resolve] = { 'inlayHintProvider', 'resolveProvider' },
 }
 
 -- TODO improve handling of scratch buffers with LSP attached.
@@ -583,7 +584,7 @@ do
     local uri = vim.uri_from_bufnr(bufnr)
     for _, client in pairs(state.clients) do
       if not client.is_stopped() and lsp.buf_is_attached(bufnr, client.id) then
-        client.notify('textDocument/didChange', {
+        client.notify(ms.textDocument_didChange, {
           textDocument = {
             uri = uri,
             version = util.buf_versions[bufnr],
@@ -701,7 +702,7 @@ local function text_document_did_open_handler(bufnr, client)
       text = buf_get_full_text(bufnr),
     },
   }
-  client.notify('textDocument/didOpen', params)
+  client.notify(ms.textDocument_didOpen, params)
   util.buf_versions[bufnr] = params.textDocument.version
 
   -- Next chance we get, we should re-do the diagnostics
@@ -930,17 +931,17 @@ end
 ---@param client lsp.Client
 function lsp._set_defaults(client, bufnr)
   if
-    client.supports_method('textDocument/definition') and is_empty_or_default(bufnr, 'tagfunc')
+    client.supports_method(ms.textDocument_definition) and is_empty_or_default(bufnr, 'tagfunc')
   then
     vim.bo[bufnr].tagfunc = 'v:lua.vim.lsp.tagfunc'
   end
   if
-    client.supports_method('textDocument/completion') and is_empty_or_default(bufnr, 'omnifunc')
+    client.supports_method(ms.textDocument_completion) and is_empty_or_default(bufnr, 'omnifunc')
   then
     vim.bo[bufnr].omnifunc = 'v:lua.vim.lsp.omnifunc'
   end
   if
-    client.supports_method('textDocument/rangeFormatting')
+    client.supports_method(ms.textDocument_rangeFormatting)
     and is_empty_or_default(bufnr, 'formatprg')
     and is_empty_or_default(bufnr, 'formatexpr')
   then
@@ -948,14 +949,14 @@ function lsp._set_defaults(client, bufnr)
   end
   api.nvim_buf_call(bufnr, function()
     if
-      client.supports_method('textDocument/hover')
+      client.supports_method(ms.textDocument_hover)
       and is_empty_or_default(bufnr, 'keywordprg')
       and vim.fn.maparg('K', 'n', false, false) == ''
     then
       vim.keymap.set('n', 'K', vim.lsp.buf.hover, { buffer = bufnr })
     end
   end)
-  if client.supports_method('textDocument/diagnostic') then
+  if client.supports_method(ms.textDocument_diagnostic) then
     lsp.diagnostic._enable(bufnr)
   end
 end
@@ -1431,7 +1432,7 @@ function lsp.start_client(config)
       end
 
       if next(config.settings) then
-        client.notify('workspace/didChangeConfiguration', { settings = config.settings })
+        client.notify(ms.workspace_didChangeConfiguration, { settings = config.settings })
       end
 
       if config.on_init then
@@ -1573,7 +1574,7 @@ function lsp.start_client(config)
   ---If it is false, then it will always be false
   ---(the client has shutdown).
   function client.notify(method, params)
-    if method ~= 'textDocument/didChange' then
+    if method ~= ms.textDocument_didChange then
       changetracking.flush(client)
     end
 
@@ -1693,7 +1694,7 @@ function lsp.start_client(config)
       command = command.command,
       arguments = command.arguments,
     }
-    client.request('workspace/executeCommand', params, handler, context.bufnr)
+    client.request(ms.workspace_executeCommand, params, handler, context.bufnr)
   end
 
   ---@private
@@ -1763,12 +1764,12 @@ local function text_document_did_save_handler(bufnr)
     local name = api.nvim_buf_get_name(bufnr)
     local old_name = changetracking._get_and_set_name(client, bufnr, name)
     if old_name and name ~= old_name then
-      client.notify('textDocument/didClose', {
+      client.notify(ms.textDocument_didClose, {
         textDocument = {
           uri = vim.uri_from_fname(old_name),
         },
       })
-      client.notify('textDocument/didOpen', {
+      client.notify(ms.textDocument_didOpen, {
         textDocument = {
           version = 0,
           uri = uri,
@@ -1784,7 +1785,7 @@ local function text_document_did_save_handler(bufnr)
       if type(save_capability) == 'table' and save_capability.includeText then
         included_text = text(bufnr)
       end
-      client.notify('textDocument/didSave', {
+      client.notify(ms.textDocument_didSave, {
         textDocument = {
           uri = uri,
         },
@@ -1835,11 +1836,11 @@ function lsp.buf_attach_client(bufnr, client_id)
             reason = protocol.TextDocumentSaveReason.Manual,
           }
           if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'willSave') then
-            client.notify('textDocument/willSave', params)
+            client.notify(ms.textDocument_willSave, params)
           end
           if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'willSaveWaitUntil') then
             local result, err =
-              client.request_sync('textDocument/willSaveWaitUntil', params, 1000, ctx.buf)
+              client.request_sync(ms.textDocument_willSaveWaitUntil, params, 1000, ctx.buf)
             if result and result.result then
               util.apply_text_edits(result.result, ctx.buf, client.offset_encoding)
             elseif err then
@@ -1865,7 +1866,7 @@ function lsp.buf_attach_client(bufnr, client_id)
         for _, client in ipairs(lsp.get_clients({ bufnr = bufnr })) do
           changetracking.reset_buf(client, bufnr)
           if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
-            client.notify('textDocument/didClose', params)
+            client.notify(ms.textDocument_didClose, params)
           end
           text_document_did_open_handler(bufnr, client)
         end
@@ -1875,7 +1876,7 @@ function lsp.buf_attach_client(bufnr, client_id)
         for _, client in ipairs(lsp.get_clients({ bufnr = bufnr })) do
           changetracking.reset_buf(client, bufnr)
           if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
-            client.notify('textDocument/didClose', params)
+            client.notify(ms.textDocument_didClose, params)
           end
           client.attached_buffers[bufnr] = nil
         end
@@ -1940,7 +1941,7 @@ function lsp.buf_detach_client(bufnr, client_id)
   if vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'openClose') then
     local uri = vim.uri_from_bufnr(bufnr)
     local params = { textDocument = { uri = uri } }
-    client.notify('textDocument/didClose', params)
+    client.notify(ms.textDocument_didClose, params)
   end
 
   client.attached_buffers[bufnr] = nil
@@ -2294,7 +2295,7 @@ function lsp.omnifunc(findstart, base)
   end
 
   local bufnr = resolve_bufnr()
-  local clients = lsp.get_clients({ bufnr = bufnr, method = 'textDocument/completion' })
+  local clients = lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_completion })
   local remaining = #clients
   if remaining == 0 then
     return findstart == 1 and -1 or {}
@@ -2326,7 +2327,7 @@ function lsp.omnifunc(findstart, base)
 
   for _, client in ipairs(clients) do
     local params = util.make_position_params(win, client.offset_encoding)
-    client.request('textDocument/completion', params, function(err, result)
+    client.request(ms.textDocument_completion, params, function(err, result)
       if err then
         log.warn(err.message)
       end
@@ -2397,7 +2398,7 @@ function lsp.formatexpr(opts)
   end
   local bufnr = api.nvim_get_current_buf()
   for _, client in pairs(lsp.get_clients({ bufnr = bufnr })) do
-    if client.supports_method('textDocument/rangeFormatting') then
+    if client.supports_method(ms.textDocument_rangeFormatting) then
       local params = util.make_formatting_params()
       local end_line = vim.fn.getline(end_lnum) --[[@as string]]
       local end_col = util._str_utfindex_enc(end_line, nil, client.offset_encoding)
@@ -2412,7 +2413,7 @@ function lsp.formatexpr(opts)
         },
       }
       local response =
-        client.request_sync('textDocument/rangeFormatting', params, timeout_ms, bufnr)
+        client.request_sync(ms.textDocument_rangeFormatting, params, timeout_ms, bufnr)
       if response and response.result then
         lsp.util.apply_text_edits(response.result, 0, client.offset_encoding)
         return 0
diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
index b66f2f6f32..c271dc6e14 100644
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -1,6 +1,7 @@
 local bit = require('bit')
 local watch = require('vim._watch')
 local protocol = require('vim.lsp.protocol')
+local ms = protocol.Methods
 local lpeg = vim.lpeg
 
 local M = {}
@@ -190,7 +191,7 @@ function M.register(reg, ctx)
 
           if not queue_timers[client_id] then
             queue_timers[client_id] = vim.defer_fn(function()
-              client.notify('workspace/didChangeWatchedFiles', {
+              client.notify(ms.workspace_didChangeWatchedFiles, {
                 changes = change_queues[client_id],
               })
               queue_timers[client_id] = nil
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 5e0e429021..59afaf6fa0 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -2,6 +2,7 @@ local api = vim.api
 local validate = vim.validate
 local util = require('vim.lsp.util')
 local npcall = vim.F.npcall
+local ms = require('vim.lsp.protocol').Methods
 
 local M = {}
 
@@ -41,7 +42,7 @@ end
 --- window. Calling the function twice will jump into the floating window.
 function M.hover()
   local params = util.make_position_params()
-  request('textDocument/hover', params)
+  request(ms.textDocument_hover, params)
 end
 
 local function request_with_options(name, params, options)
@@ -64,7 +65,7 @@ end
 ---     - on_list: (function) handler for list results. See |lsp-on-list-handler|
 function M.declaration(options)
   local params = util.make_position_params()
-  request_with_options('textDocument/declaration', params, options)
+  request_with_options(ms.textDocument_declaration, params, options)
 end
 
 --- Jumps to the definition of the symbol under the cursor.
@@ -74,7 +75,7 @@ end
 ---     - on_list: (function) handler for list results. See |lsp-on-list-handler|
 function M.definition(options)
   local params = util.make_position_params()
-  request_with_options('textDocument/definition', params, options)
+  request_with_options(ms.textDocument_definition, params, options)
 end
 
 --- Jumps to the definition of the type of the symbol under the cursor.
@@ -84,7 +85,7 @@ end
 ---     - on_list: (function) handler for list results. See |lsp-on-list-handler|
 function M.type_definition(options)
   local params = util.make_position_params()
-  request_with_options('textDocument/typeDefinition', params, options)
+  request_with_options(ms.textDocument_typeDefinition, params, options)
 end
 
 --- Lists all the implementations for the symbol under the cursor in the
@@ -94,14 +95,14 @@ end
 ---     - on_list: (function) handler for list results. See |lsp-on-list-handler|
 function M.implementation(options)
   local params = util.make_position_params()
-  request_with_options('textDocument/implementation', params, options)
+  request_with_options(ms.textDocument_implementation, params, options)
 end
 
 --- Displays signature information about the symbol under the cursor in a
 --- floating window.
 function M.signature_help()
   local params = util.make_position_params()
-  request('textDocument/signatureHelp', params)
+  request(ms.textDocument_signatureHelp, params)
 end
 
 --- Retrieves the completion items at the current cursor position. Can only be
@@ -115,7 +116,7 @@ end
 function M.completion(context)
   local params = util.make_position_params()
   params.context = context
-  return request('textDocument/completion', params)
+  return request(ms.textDocument_completion, params)
 end
 
 ---@param bufnr integer
@@ -199,7 +200,7 @@ function M.format(options)
   if not range and mode == 'v' or mode == 'V' then
     range = range_from_selection(bufnr, mode)
   end
-  local method = range and 'textDocument/rangeFormatting' or 'textDocument/formatting'
+  local method = range and ms.textDocument_rangeFormatting or ms.textDocument_formatting
 
   local clients = vim.lsp.get_clients({
     id = options.id,
@@ -270,7 +271,7 @@ function M.rename(new_name, options)
     bufnr = bufnr,
     name = options.name,
     -- Clients must at least support rename, prepareRename is optional
-    method = 'textDocument/rename',
+    method = ms.textDocument_rename,
   })
   if options.filter then
     clients = vim.tbl_filter(options.filter, clients)
@@ -305,17 +306,17 @@ function M.rename(new_name, options)
     local function rename(name)
       local params = util.make_position_params(win, client.offset_encoding)
       params.newName = name
-      local handler = client.handlers['textDocument/rename']
-        or vim.lsp.handlers['textDocument/rename']
-      client.request('textDocument/rename', params, function(...)
+      local handler = client.handlers[ms.textDocument_rename]
+        or vim.lsp.handlers[ms.textDocument_rename]
+      client.request(ms.textDocument_rename, params, function(...)
         handler(...)
         try_use_client(next(clients, idx))
       end, bufnr)
     end
 
-    if client.supports_method('textDocument/prepareRename') then
+    if client.supports_method(ms.textDocument_prepareRename) then
       local params = util.make_position_params(win, client.offset_encoding)
-      client.request('textDocument/prepareRename', params, function(err, result)
+      client.request(ms.textDocument_prepareRename, params, function(err, result)
         if err or result == nil then
           if next(clients, idx) then
             try_use_client(next(clients, idx))
@@ -354,7 +355,7 @@ function M.rename(new_name, options)
       end, bufnr)
     else
       assert(
-        client.supports_method('textDocument/rename'),
+        client.supports_method(ms.textDocument_rename),
         'Client must support textDocument/rename'
       )
       if new_name then
@@ -390,7 +391,7 @@ function M.references(context, options)
   params.context = context or {
     includeDeclaration = true,
   }
-  request_with_options('textDocument/references', params, options)
+  request_with_options(ms.textDocument_references, params, options)
 end
 
 --- Lists all symbols in the current buffer in the quickfix window.
@@ -399,7 +400,7 @@ end
 ---     - on_list: (function) handler for list results. See |lsp-on-list-handler|
 function M.document_symbol(options)
   local params = { textDocument = util.make_text_document_params() }
-  request_with_options('textDocument/documentSymbol', params, options)
+  request_with_options(ms.textDocument_documentSymbol, params, options)
 end
 
 local function pick_call_hierarchy_item(call_hierarchy_items)
@@ -423,7 +424,7 @@ end
 
 local function call_hierarchy(method)
   local params = util.make_position_params()
-  request('textDocument/prepareCallHierarchy', params, function(err, result, ctx)
+  request(ms.textDocument_prepareCallHierarchy, params, function(err, result, ctx)
     if err then
       vim.notify(err.message, vim.log.levels.WARN)
       return
@@ -496,7 +497,7 @@ function M.add_workspace_folder(workspace_folder)
       end
     end
     if not found then
-      client.notify('workspace/didChangeWorkspaceFolders', params)
+      client.notify(ms.workspace_didChangeWorkspaceFolders, params)
       if not client.workspace_folders then
         client.workspace_folders = {}
       end
@@ -524,7 +525,7 @@ function M.remove_workspace_folder(workspace_folder)
   for _, client in pairs(vim.lsp.get_clients({ bufnr = bufnr })) do
     for idx, folder in pairs(client.workspace_folders) do
       if folder.name == workspace_folder then
-        client.notify('workspace/didChangeWorkspaceFolders', params)
+        client.notify(ms.workspace_didChangeWorkspaceFolders, params)
         client.workspace_folders[idx] = nil
         return
       end
@@ -548,7 +549,7 @@ function M.workspace_symbol(query, options)
     return
   end
   local params = { query = query }
-  request_with_options('workspace/symbol', params, options)
+  request_with_options(ms.workspace_symbol, params, options)
 end
 
 --- Send request to the server to resolve document highlights for the current
@@ -567,7 +568,7 @@ end
 ---         |hl-LspReferenceWrite|
 function M.document_highlight()
   local params = util.make_position_params()
-  request('textDocument/documentHighlight', params)
+  request(ms.textDocument_documentHighlight, params)
 end
 
 --- Removes document highlights from current buffer.
@@ -655,7 +656,7 @@ local function on_code_action_results(results, ctx, options)
     local client = vim.lsp.get_client_by_id(action_tuple[1])
     local action = action_tuple[2]
 
-    local reg = client.dynamic_capabilities:get('textDocument/codeAction', { bufnr = ctx.bufnr })
+    local reg = client.dynamic_capabilities:get(ms.textDocument_codeAction, { bufnr = ctx.bufnr })
 
     local supports_resolve = vim.tbl_get(reg or {}, 'registerOptions', 'resolveProvider')
       or client.supports_method('codeAction/resolve')
@@ -694,9 +695,8 @@ end
 --- with all aggregated results
 local function code_action_request(params, options)
   local bufnr = api.nvim_get_current_buf()
-  local method = 'textDocument/codeAction'
-  vim.lsp.buf_request_all(bufnr, method, params, function(results)
-    local ctx = { bufnr = bufnr, method = method, params = params }
+  vim.lsp.buf_request_all(bufnr, ms.textDocument_codeAction, params, function(results)
+    local ctx = { bufnr = bufnr, method = ms.textDocument_codeAction, params = params }
     on_code_action_results(results, ctx, options)
   end)
 end
@@ -776,7 +776,7 @@ function M.execute_command(command_params)
     arguments = command_params.arguments,
     workDoneToken = command_params.workDoneToken,
   }
-  request('workspace/executeCommand', command_params)
+  request(ms.workspace_executeCommand, command_params)
 end
 
 return M
diff --git a/runtime/lua/vim/lsp/codelens.lua b/runtime/lua/vim/lsp/codelens.lua
index a516238ae0..d581eb985f 100644
--- a/runtime/lua/vim/lsp/codelens.lua
+++ b/runtime/lua/vim/lsp/codelens.lua
@@ -1,5 +1,6 @@
 local util = require('vim.lsp.util')
 local log = require('vim.lsp.log')
+local ms = require('vim.lsp.protocol').Methods
 local api = vim.api
 local M = {}
 
@@ -33,7 +34,7 @@ local function execute_lens(lens, bufnr, client_id)
   local client = vim.lsp.get_client_by_id(client_id)
   assert(client, 'Client is required to execute lens, client_id=' .. client_id)
   client._exec_cmd(lens.command, { bufnr = bufnr }, function(...)
-    vim.lsp.handlers['workspace/executeCommand'](...)
+    vim.lsp.handlers[ms.workspace_executeCommand](...)
     M.refresh()
   end)
 end
@@ -267,7 +268,7 @@ function M.refresh()
     return
   end
   active_refreshes[bufnr] = true
-  vim.lsp.buf_request(0, 'textDocument/codeLens', params, M.on_codelens)
+  vim.lsp.buf_request(0, ms.textDocument_codeLens, params, M.on_codelens)
 end
 
 return M
diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index 44bb90d985..a0568bc09c 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -2,6 +2,7 @@
 
 local util = require('vim.lsp.util')
 local protocol = require('vim.lsp.protocol')
+local ms = protocol.Methods
 
 local api = vim.api
 
@@ -422,13 +423,13 @@ function M._enable(bufnr)
       buffer = bufnr,
       callback = function(opts)
         if
-          opts.data.method ~= 'textDocument/didChange'
-          and opts.data.method ~= 'textDocument/didOpen'
+          opts.data.method ~= ms.textDocument_didChange
+          and opts.data.method ~= ms.textDocument_didOpen
         then
           return
         end
         if bufstates[bufnr] and bufstates[bufnr].enabled then
-          util._refresh('textDocument/diagnostic', { bufnr = bufnr, only_visible = true })
+          util._refresh(ms.textDocument_diagnostic, { bufnr = bufnr, only_visible = true })
         end
       end,
       group = augroup,
@@ -437,7 +438,7 @@ function M._enable(bufnr)
     api.nvim_buf_attach(bufnr, false, {
       on_reload = function()
         if bufstates[bufnr] and bufstates[bufnr].enabled then
-          util._refresh('textDocument/diagnostic', { bufnr = bufnr })
+          util._refresh(ms.textDocument_diagnostic, { bufnr = bufnr })
         end
       end,
       on_detach = function()
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index d887183972..6fe4b7f939 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -1,5 +1,6 @@
 local log = require('vim.lsp.log')
 local protocol = require('vim.lsp.protocol')
+local ms = protocol.Methods
 local util = require('vim.lsp.util')
 local api = vim.api
 
@@ -15,14 +16,14 @@ local function err_message(...)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_executeCommand
-M['workspace/executeCommand'] = function(_, _, _, _)
+M[ms.workspace_executeCommand] = function(_, _, _, _)
   -- Error handling is done implicitly by wrapping all handlers; see end of this file
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#progress
 ---@param result lsp.ProgressParams
 ---@param ctx lsp.HandlerContext
-M['$/progress'] = function(_, result, ctx)
+M[ms.dollar_progress] = function(_, result, ctx)
   local client = vim.lsp.get_client_by_id(ctx.client_id)
   if not client then
     err_message('LSP[id=', tostring(ctx.client_id), '] client has shut down during progress update')
@@ -58,7 +59,7 @@ end
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#window_workDoneProgress_create
 ---@param result lsp.WorkDoneProgressCreateParams
 ---@param ctx lsp.HandlerContext
-M['window/workDoneProgress/create'] = function(_, result, ctx)
+M[ms.window_workDoneProgress_create] = function(_, result, ctx)
   local client = vim.lsp.get_client_by_id(ctx.client_id)
   if not client then
     err_message('LSP[id=', tostring(ctx.client_id), '] client has shut down during progress update')
@@ -70,7 +71,7 @@ end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#window_showMessageRequest
 ---@param result lsp.ShowMessageRequestParams
-M['window/showMessageRequest'] = function(_, result)
+M[ms.window_showMessageRequest] = function(_, result)
   local actions = result.actions or {}
   local co, is_main = coroutine.running()
   if co and not is_main then
@@ -105,7 +106,7 @@ M['window/showMessageRequest'] = function(_, result)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#client_registerCapability
-M['client/registerCapability'] = function(_, result, ctx)
+M[ms.client_registerCapability] = function(_, result, ctx)
   local client_id = ctx.client_id
   ---@type lsp.Client
   local client = vim.lsp.get_client_by_id(client_id)
@@ -118,7 +119,7 @@ M['client/registerCapability'] = function(_, result, ctx)
   ---@type string[]
   local unsupported = {}
   for _, reg in ipairs(result.registrations) do
-    if reg.method == 'workspace/didChangeWatchedFiles' then
+    if reg.method == ms.workspace_didChangeWatchedFiles then
       require('vim.lsp._watchfiles').register(reg, ctx)
     elseif not client.dynamic_capabilities:supports_registration(reg.method) then
       unsupported[#unsupported + 1] = reg.method
@@ -136,13 +137,13 @@ M['client/registerCapability'] = function(_, result, ctx)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#client_unregisterCapability
-M['client/unregisterCapability'] = function(_, result, ctx)
+M[ms.client_unregisterCapability] = function(_, result, ctx)
   local client_id = ctx.client_id
   local client = vim.lsp.get_client_by_id(client_id)
   client.dynamic_capabilities:unregister(result.unregisterations)
 
   for _, unreg in ipairs(result.unregisterations) do
-    if unreg.method == 'workspace/didChangeWatchedFiles' then
+    if unreg.method == ms.workspace_didChangeWatchedFiles then
       require('vim.lsp._watchfiles').unregister(unreg, ctx)
     end
   end
@@ -150,7 +151,7 @@ M['client/unregisterCapability'] = function(_, result, ctx)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_applyEdit
-M['workspace/applyEdit'] = function(_, workspace_edit, ctx)
+M[ms.workspace_applyEdit] = function(_, workspace_edit, ctx)
   assert(
     workspace_edit,
     'workspace/applyEdit must be called with `ApplyWorkspaceEditParams`. Server is violating the specification'
@@ -170,7 +171,7 @@ M['workspace/applyEdit'] = function(_, workspace_edit, ctx)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_configuration
-M['workspace/configuration'] = function(_, result, ctx)
+M[ms.workspace_configuration] = function(_, result, ctx)
   local client_id = ctx.client_id
   local client = vim.lsp.get_client_by_id(client_id)
   if not client then
@@ -200,7 +201,7 @@ M['workspace/configuration'] = function(_, result, ctx)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_workspaceFolders
-M['workspace/workspaceFolders'] = function(_, _, ctx)
+M[ms.workspace_workspaceFolders] = function(_, _, ctx)
   local client_id = ctx.client_id
   local client = vim.lsp.get_client_by_id(client_id)
   if not client then
@@ -210,24 +211,24 @@ M['workspace/workspaceFolders'] = function(_, _, ctx)
   return client.workspace_folders or vim.NIL
 end
 
-M['textDocument/publishDiagnostics'] = function(...)
+M[ms.textDocument_publishDiagnostics] = function(...)
   return require('vim.lsp.diagnostic').on_publish_diagnostics(...)
 end
 
-M['textDocument/diagnostic'] = function(...)
+M[ms.textDocument_diagnostic] = function(...)
   return require('vim.lsp.diagnostic').on_diagnostic(...)
 end
 
-M['textDocument/codeLens'] = function(...)
+M[ms.textDocument_codeLens] = function(...)
   return require('vim.lsp.codelens').on_codelens(...)
 end
 
-M['textDocument/inlayHint'] = function(...)
+M[ms.textDocument_inlayHint] = function(...)
   return require('vim.lsp.inlay_hint').on_inlayhint(...)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_references
-M['textDocument/references'] = function(_, result, ctx, config)
+M[ms.textDocument_references] = function(_, result, ctx, config)
   if not result or vim.tbl_isempty(result) then
     vim.notify('No references found')
   else
@@ -283,7 +284,7 @@ local function response_to_list(map_result, entity, title_fn)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_documentSymbol
-M['textDocument/documentSymbol'] = response_to_list(
+M[ms.textDocument_documentSymbol] = response_to_list(
   util.symbols_to_items,
   'document symbols',
   function(ctx)
@@ -293,12 +294,12 @@ M['textDocument/documentSymbol'] = response_to_list(
 )
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_symbol
-M['workspace/symbol'] = response_to_list(util.symbols_to_items, 'symbols', function(ctx)
+M[ms.workspace_symbol] = response_to_list(util.symbols_to_items, 'symbols', function(ctx)
   return string.format("Symbols matching '%s'", ctx.params.query)
 end)
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_rename
-M['textDocument/rename'] = function(_, result, ctx, _)
+M[ms.textDocument_rename] = function(_, result, ctx, _)
   if not result then
     vim.notify("Language server couldn't provide rename result", vim.log.levels.INFO)
     return
@@ -308,7 +309,7 @@ M['textDocument/rename'] = function(_, result, ctx, _)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_rangeFormatting
-M['textDocument/rangeFormatting'] = function(_, result, ctx, _)
+M[ms.textDocument_rangeFormatting] = function(_, result, ctx, _)
   if not result then
     return
   end
@@ -317,7 +318,7 @@ M['textDocument/rangeFormatting'] = function(_, result, ctx, _)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_formatting
-M['textDocument/formatting'] = function(_, result, ctx, _)
+M[ms.textDocument_formatting] = function(_, result, ctx, _)
   if not result then
     return
   end
@@ -326,7 +327,7 @@ M['textDocument/formatting'] = function(_, result, ctx, _)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_completion
-M['textDocument/completion'] = function(_, result, _, _)
+M[ms.textDocument_completion] = function(_, result, _, _)
   if vim.tbl_isempty(result or {}) then
     return
   end
@@ -380,7 +381,7 @@ function M.hover(_, result, ctx, config)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover
-M['textDocument/hover'] = M.hover
+M[ms.textDocument_hover] = M.hover
 
 --- Jumps to a location. Used as a handler for multiple LSP methods.
 ---@param _ nil not used
@@ -420,13 +421,13 @@ local function location_handler(_, result, ctx, config)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_declaration
-M['textDocument/declaration'] = location_handler
+M[ms.textDocument_declaration] = location_handler
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_definition
-M['textDocument/definition'] = location_handler
+M[ms.textDocument_definition] = location_handler
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_typeDefinition
-M['textDocument/typeDefinition'] = location_handler
+M[ms.textDocument_typeDefinition] = location_handler
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_implementation
-M['textDocument/implementation'] = location_handler
+M[ms.textDocument_implementation] = location_handler
 
 --- |lsp-handler| for the method "textDocument/signatureHelp".
 --- The active parameter is highlighted with |hl-LspSignatureActiveParameter|.
@@ -477,10 +478,10 @@ function M.signature_help(_, result, ctx, config)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_signatureHelp
-M['textDocument/signatureHelp'] = M.signature_help
+M[ms.textDocument_signatureHelp] = M.signature_help
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_documentHighlight
-M['textDocument/documentHighlight'] = function(_, result, ctx, _)
+M[ms.textDocument_documentHighlight] = function(_, result, ctx, _)
   if not result then
     return
   end
@@ -523,13 +524,13 @@ local make_call_hierarchy_handler = function(direction)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#callHierarchy_incomingCalls
-M['callHierarchy/incomingCalls'] = make_call_hierarchy_handler('from')
+M[ms.callHierarchy_incomingCalls] = make_call_hierarchy_handler('from')
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#callHierarchy_outgoingCalls
-M['callHierarchy/outgoingCalls'] = make_call_hierarchy_handler('to')
+M[ms.callHierarchy_outgoingCalls] = make_call_hierarchy_handler('to')
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#window_logMessage
-M['window/logMessage'] = function(_, result, ctx, _)
+M[ms.window_logMessage] = function(_, result, ctx, _)
   local message_type = result.type
   local message = result.message
   local client_id = ctx.client_id
@@ -551,7 +552,7 @@ M['window/logMessage'] = function(_, result, ctx, _)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#window_showMessage
-M['window/showMessage'] = function(_, result, ctx, _)
+M[ms.window_showMessage] = function(_, result, ctx, _)
   local message_type = result.type
   local message = result.message
   local client_id = ctx.client_id
@@ -570,7 +571,7 @@ M['window/showMessage'] = function(_, result, ctx, _)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#window_showDocument
-M['window/showDocument'] = function(_, result, ctx, _)
+M[ms.window_showDocument] = function(_, result, ctx, _)
   local uri = result.uri
 
   if result.external then
@@ -611,7 +612,7 @@ M['window/showDocument'] = function(_, result, ctx, _)
 end
 
 ---@see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspace_inlayHint_refresh
-M['workspace/inlayHint/refresh'] = function(err, result, ctx, config)
+M[ms.workspace_inlayHint_refresh] = function(err, result, ctx, config)
   return require('vim.lsp.inlay_hint').on_refresh(err, result, ctx, config)
 end
 
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 2bf0fb9cb2..eb2f59b312 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -1,5 +1,6 @@
 local util = require('vim.lsp.util')
 local log = require('vim.lsp.log')
+local ms = require('vim.lsp.protocol').Methods
 local api = vim.api
 local M = {}
 
@@ -87,7 +88,7 @@ function M.on_refresh(err, _, ctx, _)
       if api.nvim_win_get_buf(winid) == bufnr then
         local bufstate = bufstates[bufnr]
         if bufstate then
-          util._refresh('textDocument/inlayHint', { bufnr = bufnr })
+          util._refresh(ms.textDocument_inlayHint, { bufnr = bufnr })
           break
         end
       end
@@ -143,24 +144,24 @@ local function enable(bufnr)
       buffer = bufnr,
       callback = function(opts)
         if
-          opts.data.method ~= 'textDocument/didChange'
-          and opts.data.method ~= 'textDocument/didOpen'
+          opts.data.method ~= ms.textDocument_didChange
+          and opts.data.method ~= ms.textDocument_didOpen
         then
           return
         end
         if bufstates[bufnr] and bufstates[bufnr].enabled then
-          util._refresh('textDocument/inlayHint', { bufnr = bufnr })
+          util._refresh(ms.textDocument_inlayHint, { bufnr = bufnr })
         end
       end,
       group = augroup,
     })
-    util._refresh('textDocument/inlayHint', { bufnr = bufnr })
+    util._refresh(ms.textDocument_inlayHint, { bufnr = bufnr })
     api.nvim_buf_attach(bufnr, false, {
       on_reload = function(_, cb_bufnr)
         clear(cb_bufnr)
         if bufstates[cb_bufnr] and bufstates[cb_bufnr].enabled then
           bufstates[cb_bufnr].applied = {}
-          util._refresh('textDocument/inlayHint', { bufnr = cb_bufnr })
+          util._refresh(ms.textDocument_inlayHint, { bufnr = cb_bufnr })
         end
       end,
       on_detach = function(_, cb_bufnr)
@@ -176,7 +177,7 @@ local function enable(bufnr)
     })
   else
     bufstate.enabled = true
-    util._refresh('textDocument/inlayHint', { bufnr = bufnr })
+    util._refresh(ms.textDocument_inlayHint, { bufnr = bufnr })
   end
 end
 
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 84723bbc05..bab1b23ee4 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -1,6 +1,7 @@
 local api = vim.api
 local bit = require('bit')
 local handlers = require('vim.lsp.handlers')
+local ms = require('vim.lsp.protocol').Methods
 local util = require('vim.lsp.util')
 local uv = vim.uv
 
@@ -292,7 +293,7 @@ function STHighlighter:send_request()
       local hasEditProvider = type(spec) == 'table' and spec.delta
 
       local params = { textDocument = util.make_text_document_params(self.bufnr) }
-      local method = 'textDocument/semanticTokens/full'
+      local method = ms.textDocument_semanticTokens_full
 
       if hasEditProvider and current_result.result_id then
         method = method .. '/delta'
@@ -755,7 +756,7 @@ end
 --- the BufWinEnter event should take care of it next time it's displayed.
 ---
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#semanticTokens_refreshRequest
-handlers['workspace/semanticTokens/refresh'] = function(err, _, ctx)
+handlers[ms.workspace_semanticTokens_refresh] = function(err, _, ctx)
   if err then
     return vim.NIL
   end
diff --git a/runtime/lua/vim/lsp/tagfunc.lua b/runtime/lua/vim/lsp/tagfunc.lua
index c70eb573c2..957449743b 100644
--- a/runtime/lua/vim/lsp/tagfunc.lua
+++ b/runtime/lua/vim/lsp/tagfunc.lua
@@ -1,5 +1,6 @@
 local lsp = vim.lsp
 local util = lsp.util
+local ms = lsp.protocol.Methods
 
 local function mk_tag_item(name, range, uri, offset_encoding)
   local bufnr = vim.uri_to_bufnr(uri)
@@ -14,7 +15,7 @@ end
 
 local function query_definition(pattern)
   local params = util.make_position_params()
-  local results_by_client, err = lsp.buf_request_sync(0, 'textDocument/definition', params, 1000)
+  local results_by_client, err = lsp.buf_request_sync(0, ms.textDocument_definition, params, 1000)
   if err then
     return {}
   end
@@ -42,7 +43,7 @@ end
 
 local function query_workspace_symbols(pattern)
   local results_by_client, err =
-    lsp.buf_request_sync(0, 'workspace/symbol', { query = pattern }, 1000)
+    lsp.buf_request_sync(0, ms.workspace_symbol, { query = pattern }, 1000)
   if err then
     return {}
   end
-- 
cgit 


From d2f81330247ee060d557330b2716ccea8f789a50 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Wed, 12 Jul 2023 19:27:14 +0200
Subject: docs: misc

Co-authored-by: Kevin Pham <keevan.pham@gmail.com>
---
 runtime/lua/vim/_meta/api.lua |  9 ++++-----
 runtime/lua/vim/iter.lua      | 23 ++++++++---------------
 runtime/lua/vim/shared.lua    | 10 ++++++----
 3 files changed, 18 insertions(+), 24 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 3622ba5d19..c0e4e35e7d 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -691,8 +691,8 @@ function vim.api.nvim_call_function(fn, args) end
 --- @param data string data to write. 8-bit clean: can contain NUL bytes.
 function vim.api.nvim_chan_send(chan, data) end
 
---- Clear all autocommands that match the corresponding {opts}. To delete a
---- particular autocmd, see `nvim_del_autocmd()`.
+--- Clears all autocommands selected by {opts}. To delete autocmds see
+--- `nvim_del_autocmd()`.
 ---
 --- @param opts vim.api.keyset.clear_autocmds Parameters
 ---             • event: (string|table) Examples:
@@ -919,10 +919,9 @@ function vim.api.nvim_del_augroup_by_id(id) end
 --- @param name string String The name of the group.
 function vim.api.nvim_del_augroup_by_name(name) end
 
---- Delete an autocommand by id.
---- NOTE: Only autocommands created via the API have an id.
+--- Deletes an autocommand by id.
 ---
---- @param id integer Integer The id returned by nvim_create_autocmd
+--- @param id integer Integer Autocommand id returned by `nvim_create_autocmd()`
 function vim.api.nvim_del_autocmd(id) end
 
 --- Deletes the current line.
diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index 7bffcc9c20..a278e96a5f 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -1,22 +1,15 @@
 ---@defgroup vim.iter
 ---
---- This module provides a generic interface for working with
---- iterables: tables, lists, iterator functions, pair()/ipair()-like iterators,
---- and \`vim.iter()\` objects.
----
---- \*vim.iter()\* wraps its table or function argument into an \*Iter\* object
---- with methods (such as |Iter:filter()| and |Iter:map()|) that transform the
---- underlying source data. These methods can be chained together to create
---- iterator "pipelines". Each pipeline stage receives as input the output
---- values from the prior stage. The values used in the first stage of the
---- pipeline depend on the type passed to this function:
+--- \*vim.iter()\* is an interface for |iterable|s: it wraps a table or function argument into an
+--- \*Iter\* object with methods (such as |Iter:filter()| and |Iter:map()|) that transform the
+--- underlying source data. These methods can be chained together to create iterator "pipelines".
+--- Each pipeline stage receives as input the output values from the prior stage. The values used in
+--- the first stage of the pipeline depend on the type passed to this function:
 ---
 --- - List tables pass only the value of each element
---- - Non-list tables pass both the key and value of each element
---- - Function iterators pass all of the values returned by their respective
----   function
---- - Tables with a metatable implementing __call are treated as function
----   iterators
+--- - Non-list (dict) tables pass both the key and value of each element
+--- - Function |iterator|s pass all of the values returned by their respective function
+--- - Tables with a metatable implementing |__call()| are treated as function iterators
 ---
 --- Examples:
 --- <pre>lua
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 291b003d87..5ce5b200d3 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -60,7 +60,8 @@ function vim.deepcopy(orig)
   return deepcopy(orig)
 end
 
---- Splits a string at each instance of a separator.
+--- Gets an |iterator| that splits a string at each instance of a separator, in "lazy" fashion
+--- (as opposed to |vim.split()| which is "eager").
 ---
 --- Example:
 ---   <pre>lua
@@ -159,7 +160,8 @@ function vim.gsplit(s, sep, opts)
   end
 end
 
---- Splits a string at each instance of a separator.
+--- Splits a string at each instance of a separator and returns the result as a table (unlike
+--- |vim.gsplit()|).
 ---
 --- Examples:
 --- <pre>lua
@@ -530,8 +532,8 @@ end
 ---
 ---@see Based on https://github.com/premake/premake-core/blob/master/src/base/table.lua
 ---
----@param t table List-like table
----@return iterator over sorted keys and their values
+---@param t table Dict-like table
+---@return # iterator over sorted keys and their values
 function vim.spairs(t)
   assert(type(t) == 'table', string.format('Expected table, got %s', type(t)))
 
-- 
cgit 


From b034378cf58bea18ea1bdb4d63692a1336b5752b Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Thu, 3 Aug 2023 08:35:10 -0700
Subject: docs: luaref cleanup #24541
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

- drop "luaref-" prefix in favor of "lua-" or nothing, where possible.
- remove redundant "luaref--lang…" and "luaref-api…" tags.
---
 runtime/lua/vim/_meta/regex.lua | 6 +++---
 runtime/lua/vim/shared.lua      | 4 ++--
 2 files changed, 5 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/regex.lua b/runtime/lua/vim/_meta/regex.lua
index 4bca67797a..ab4f46d43f 100644
--- a/runtime/lua/vim/_meta/regex.lua
+++ b/runtime/lua/vim/_meta/regex.lua
@@ -18,9 +18,9 @@ function vim.regex(re) end
 local regex = {} -- luacheck: no unused
 
 --- Match the string against the regex. If the string should match the regex
---- precisely, surround the regex with `^` and `$`. If the was a match, the
---- byte indices for the beginning and end of the match is returned. When
---- there is no match, `nil` is returned. As any integer is truth-y,
+--- precisely, surround the regex with `^` and `$`. If there was a match, the
+--- byte indices for the beginning and end of the match are returned. When
+--- there is no match, `nil` is returned. Because any integer is "truthy",
 --- `regex:match()` can be directly used as a condition in an if-statement.
 --- @param str string
 function regex:match_str(str) end
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 5ce5b200d3..32575a1cc9 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -80,7 +80,7 @@ end
 ---
 --- @see |string.gmatch()|
 --- @see |vim.split()|
---- @see |luaref-patterns|
+--- @see |lua-patterns|
 --- @see https://www.lua.org/pil/20.2.html
 --- @see http://lua-users.org/wiki/StringLibraryTutorial
 ---
@@ -660,7 +660,7 @@ end
 
 --- Trim whitespace (Lua pattern "%s") from both sides of a string.
 ---
----@see |luaref-patterns|
+---@see |lua-patterns|
 ---@see https://www.lua.org/pil/20.2.html
 ---@param s string String to trim
 ---@return string String with whitespace removed from its beginning and end
-- 
cgit 


From cc87dda31a5b5637ade7ddcfe5199f2df5fd47df Mon Sep 17 00:00:00 2001
From: Sean Dewar <seandewar@users.noreply.github.com>
Date: Fri, 4 Aug 2023 07:10:54 +0100
Subject: fix(lsp): do not assume client capability exists in watchfiles check
 (#24550)

PR #23689 assumes `client.config.capabilities.workspace.didChangeWatchedFiles`
exists when checking `dynamicRegistration`, but thats's true only if it was
passed to `vim.lsp.start{_client}`.

This caused #23806 (still an issue in v0.9.1; needs manual backport), but #23681
fixed it by defaulting `config.capabilities` to `make_client_capabilities` if
not passed to `vim.lsp.start{_client}`.

However, the bug resurfaces on HEAD if you provide a non-nil `capabilities` to
`vim.lsp.start{_client}` with missing fields (e.g: not made via
`make_client_capabilities`).

From what I see, the spec says such missing fields should be interpreted as an
absence of the capability (including those indicated by missing sub-fields):
https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#clientCapabilities

Also, suggest `vim.empty_dict()` for an empty dict in
`:h vim.lsp.start_client()` (`{[vim.type_idx]=vim.types.dictionary}`
no longer works anyway, probably since the cjson switch).
---
 runtime/lua/vim/lsp.lua             |  3 +--
 runtime/lua/vim/lsp/_watchfiles.lua | 15 +++++++++------
 2 files changed, 10 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index b4c853d3d4..ea6b386b28 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1027,8 +1027,7 @@ end
 ---       \|vim.lsp.protocol.make_client_capabilities()|, passed to the language
 ---       server on initialization. Hint: use make_client_capabilities() and modify
 ---       its result.
----       - Note: To send an empty dictionary use
----         `{[vim.type_idx]=vim.types.dictionary}`, else it will be encoded as an
+---       - Note: To send an empty dictionary use |vim.empty_dict()|, else it will be encoded as an
 ---         array.
 ---
 --- - handlers: Map of language server method names to |lsp-handler|
diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
index c271dc6e14..5dbd4a7199 100644
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -121,12 +121,15 @@ M._poll_exclude_pattern = parse('**/.git/{objects,subtree-cache}/**')
 function M.register(reg, ctx)
   local client_id = ctx.client_id
   local client = vim.lsp.get_client_by_id(client_id)
-  if
-    -- Ill-behaved servers may not honor the client capability and try to register
-    -- anyway, so ignore requests when the user has opted out of the feature.
-    not client.config.capabilities.workspace.didChangeWatchedFiles.dynamicRegistration
-    or not client.workspace_folders
-  then
+  -- Ill-behaved servers may not honor the client capability and try to register
+  -- anyway, so ignore requests when the user has opted out of the feature.
+  local has_capability = vim.tbl_get(
+    client.config.capabilities or {},
+    'workspace',
+    'didChangeWatchedFiles',
+    'dynamicRegistration'
+  )
+  if not has_capability or not client.workspace_folders then
     return
   end
   local watch_regs = {} --- @type table<string,{pattern:userdata,kind:integer}>
-- 
cgit 


From 6fa17da39b270bf230764859a9537124b18d3ed5 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Fri, 4 Aug 2023 21:26:53 +0100
Subject: docs(options): take ownership of options.txt (#24528)

* docs(options): take ownership of options.txt

- `src/nvim/options.lua` is now the source of truth
- generate runtime/lua/vim/_meta/options.lua

* fixup! zeer comments

* fixup! zeer comments (2)

* fixup! re-enable luacheck

* fixup! regen
---
 runtime/lua/vim/_meta/options.lua | 7908 +++++++++++++++++++++++++++++++++++++
 1 file changed, 7908 insertions(+)
 create mode 100644 runtime/lua/vim/_meta/options.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
new file mode 100644
index 0000000000..94e26742e6
--- /dev/null
+++ b/runtime/lua/vim/_meta/options.lua
@@ -0,0 +1,7908 @@
+--- @meta
+-- THIS FILE IS GENERATED
+-- DO NOT EDIT
+error('Cannot require a meta file')
+
+---@class vim.bo
+---@field [integer] vim.bo
+vim.bo = vim.bo
+
+---@class vim.wo
+---@field [integer] vim.wo
+vim.wo = vim.wo
+
+--- Allow CTRL-_ in Insert and Command-line mode.  This is default off, to
+--- avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
+--- into reverse Insert mode, and don't know how to get out.  See
+--- 'revins'.
+---
+--- @type boolean
+vim.o.allowrevins = false
+vim.o.ari = vim.o.allowrevins
+vim.go.allowrevins = vim.o.allowrevins
+vim.go.ari = vim.go.allowrevins
+
+--- Tells Vim what to do with characters with East Asian Width Class
+--- Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
+--- letters, Cyrillic letters).
+---
+--- There are currently two possible values:
+--- "single":	Use the same width as characters in US-ASCII.  This is
+--- 		expected by most users.
+--- "double":	Use twice the width of ASCII characters.
+--- 						*E834* *E835*
+--- The value "double" cannot be used if 'listchars' or 'fillchars'
+--- contains a character that would be double width.  These errors may
+--- also be given when calling setcellwidths().
+---
+--- The values are overruled for characters specified with
+--- `setcellwidths()`.
+---
+--- There are a number of CJK fonts for which the width of glyphs for
+--- those characters are solely based on how many octets they take in
+--- legacy/traditional CJK encodings.  In those encodings, Euro,
+--- Registered sign, Greek/Cyrillic letters are represented by two octets,
+--- therefore those fonts have "wide" glyphs for them.  This is also
+--- true of some line drawing characters used to make tables in text
+--- file.  Therefore, when a CJK font is used for GUI Vim or
+--- Vim is running inside a terminal (emulators) that uses a CJK font
+--- (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
+--- this option should be set to "double" to match the width perceived
+--- by Vim with the width of glyphs in the font.  Perhaps it also has
+--- to be set to "double" under CJK MS-Windows when the system locale is
+--- set to one of CJK locales.  See Unicode Standard Annex #11
+--- (https://www.unicode.org/reports/tr11).
+---
+--- @type string
+vim.o.ambiwidth = "single"
+vim.o.ambw = vim.o.ambiwidth
+vim.go.ambiwidth = vim.o.ambiwidth
+vim.go.ambw = vim.go.ambiwidth
+
+--- This option can be set to start editing Arabic text.
+--- Setting this option will:
+--- - Set the 'rightleft' option, unless 'termbidi' is set.
+--- - Set the 'arabicshape' option, unless 'termbidi' is set.
+--- - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
+---   between typing English and Arabic key mapping.
+--- - Set the 'delcombine' option
+---
+--- Resetting this option will:
+--- - Reset the 'rightleft' option.
+--- - Disable the use of 'keymap' (without changing its value).
+--- Note that 'arabicshape' and 'delcombine' are not reset (it is a global
+--- option).
+--- Also see `arabic.txt`.
+---
+--- @type boolean
+vim.o.arabic = false
+vim.o.arab = vim.o.arabic
+vim.wo.arabic = vim.o.arabic
+vim.wo.arab = vim.wo.arabic
+
+--- When on and 'termbidi' is off, the required visual character
+--- corrections that need to take place for displaying the Arabic language
+--- take effect.  Shaping, in essence, gets enabled; the term is a broad
+--- one which encompasses:
+---   a) the changing/morphing of characters based on their location
+---      within a word (initial, medial, final and stand-alone).
+---   b) the enabling of the ability to compose characters
+---   c) the enabling of the required combining of some characters
+--- When disabled the display shows each character's true stand-alone
+--- form.
+--- Arabic is a complex language which requires other settings, for
+--- further details see `arabic.txt`.
+---
+--- @type boolean
+vim.o.arabicshape = true
+vim.o.arshape = vim.o.arabicshape
+vim.go.arabicshape = vim.o.arabicshape
+vim.go.arshape = vim.go.arabicshape
+
+--- When on, Vim will change the current working directory whenever you
+--- open a file, switch buffers, delete a buffer or open/close a window.
+--- It will change to the directory containing the file which was opened
+--- or selected.  When a buffer has no name it also has no directory, thus
+--- the current directory won't change when navigating to it.
+--- Note: When this option is on some plugins may not work.
+---
+--- @type boolean
+vim.o.autochdir = false
+vim.o.acd = vim.o.autochdir
+vim.go.autochdir = vim.o.autochdir
+vim.go.acd = vim.go.autochdir
+
+--- Copy indent from current line when starting a new line (typing <CR>
+--- in Insert mode or when using the "o" or "O" command).  If you do not
+--- type anything on the new line except <BS> or CTRL-D and then type
+--- <Esc>, CTRL-O or <CR>, the indent is deleted again.  Moving the cursor
+--- to another line has the same effect, unless the 'I' flag is included
+--- in 'cpoptions'.
+--- When autoindent is on, formatting (with the "gq" command or when you
+--- reach 'textwidth' in Insert mode) uses the indentation of the first
+--- line.
+--- When 'smartindent' or 'cindent' is on the indent is changed in
+--- a different way.
+---
+--- @type boolean
+vim.o.autoindent = true
+vim.o.ai = vim.o.autoindent
+vim.bo.autoindent = vim.o.autoindent
+vim.bo.ai = vim.bo.autoindent
+
+--- When a file has been detected to have been changed outside of Vim and
+--- it has not been changed inside of Vim, automatically read it again.
+--- When the file has been deleted this is not done, so you have the text
+--- from before it was deleted.  When it appears again then it is read.
+--- `timestamp`
+--- If this option has a local value, use this command to switch back to
+--- using the global value:
+--- ```
+--- 	:set autoread<
+--- ```
+---
+--- @type boolean
+vim.o.autoread = true
+vim.o.ar = vim.o.autoread
+vim.bo.autoread = vim.o.autoread
+vim.bo.ar = vim.bo.autoread
+vim.go.autoread = vim.o.autoread
+vim.go.ar = vim.go.autoread
+
+--- Write the contents of the file, if it has been modified, on each
+--- `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
+--- `:suspend`, `:tag`, `:!`, `:make`, CTRL-] and CTRL-^ command; and when
+--- a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
+--- to another file.
+--- A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
+--- set to "hide" and `:next` is used.
+--- Note that for some commands the 'autowrite' option is not used, see
+--- 'autowriteall' for that.
+--- Some buffers will not be written, specifically when 'buftype' is
+--- "nowrite", "nofile", "terminal" or "prompt".
+--- USE WITH CARE: If you make temporary changes to a buffer that you
+--- don't want to be saved this option may cause it to be saved anyway.
+--- Renaming the buffer with ":file {name}" may help avoid this.
+---
+--- @type boolean
+vim.o.autowrite = false
+vim.o.aw = vim.o.autowrite
+vim.go.autowrite = vim.o.autowrite
+vim.go.aw = vim.go.autowrite
+
+--- Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
+--- ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
+--- Setting this option also implies that Vim behaves like 'autowrite' has
+--- been set.
+---
+--- @type boolean
+vim.o.autowriteall = false
+vim.o.awa = vim.o.autowriteall
+vim.go.autowriteall = vim.o.autowriteall
+vim.go.awa = vim.go.autowriteall
+
+--- When set to "dark" or "light", adjusts the default color groups for
+--- that background type.  The `TUI` or other UI sets this on startup
+--- (triggering `OptionSet`) if it can detect the background color.
+---
+--- This option does NOT change the background color, it tells Nvim what
+--- the "inherited" (terminal/GUI) background looks like.
+--- See `:hi-normal` if you want to set the background color explicitly.
+--- 					*g:colors_name*
+--- When a color scheme is loaded (the "g:colors_name" variable is set)
+--- setting 'background' will cause the color scheme to be reloaded.  If
+--- the color scheme adjusts to the value of 'background' this will work.
+--- However, if the color scheme sets 'background' itself the effect may
+--- be undone.  First delete the "g:colors_name" variable when needed.
+---
+--- Normally this option would be set in the vimrc file.  Possibly
+--- depending on the terminal name.  Example:
+--- ```
+--- 	:if $TERM ==# "xterm"
+--- 	:  set background=dark
+--- 	:endif
+--- ```
+--- When this option is set, the default settings for the highlight groups
+--- will change.  To use other settings, place ":highlight" commands AFTER
+--- the setting of the 'background' option.
+--- This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
+--- to select the colors for syntax highlighting.  After changing this
+--- option, you must load syntax.vim again to see the result.  This can be
+--- done with ":syntax on".
+---
+--- @type string
+vim.o.background = "dark"
+vim.o.bg = vim.o.background
+vim.go.background = vim.o.background
+vim.go.bg = vim.go.background
+
+--- Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
+--- mode.  This is a list of items, separated by commas.  Each item allows
+--- a way to backspace over something:
+--- value	effect	~
+--- indent	allow backspacing over autoindent
+--- eol	allow backspacing over line breaks (join lines)
+--- start	allow backspacing over the start of insert; CTRL-W and CTRL-U
+--- 	stop once at the start of insert.
+--- nostop	like start, except CTRL-W and CTRL-U do not stop at the start of
+--- 	insert.
+---
+--- When the value is empty, Vi compatible backspacing is used, none of
+--- the ways mentioned for the items above are possible.
+---
+--- @type string
+vim.o.backspace = "indent,eol,start"
+vim.o.bs = vim.o.backspace
+vim.go.backspace = vim.o.backspace
+vim.go.bs = vim.go.backspace
+
+--- Make a backup before overwriting a file.  Leave it around after the
+--- file has been successfully written.  If you do not want to keep the
+--- backup file, but you do want a backup while the file is being
+--- written, reset this option and set the 'writebackup' option (this is
+--- the default).  If you do not want a backup file at all reset both
+--- options (use this if your file system is almost full).  See the
+--- `backup-table` for more explanations.
+--- When the 'backupskip' pattern matches, a backup is not made anyway.
+--- When 'patchmode' is set, the backup may be renamed to become the
+--- oldest version of a file.
+---
+--- @type boolean
+vim.o.backup = false
+vim.o.bk = vim.o.backup
+vim.go.backup = vim.o.backup
+vim.go.bk = vim.go.backup
+
+--- When writing a file and a backup is made, this option tells how it's
+--- done.  This is a comma-separated list of words.
+---
+--- The main values are:
+--- "yes"	make a copy of the file and overwrite the original one
+--- "no"	rename the file and write a new one
+--- "auto"	one of the previous, what works best
+---
+--- Extra values that can be combined with the ones above are:
+--- "breaksymlink"	always break symlinks when writing
+--- "breakhardlink"	always break hardlinks when writing
+---
+--- Making a copy and overwriting the original file:
+--- - Takes extra time to copy the file.
+--- + When the file has special attributes, is a (hard/symbolic) link or
+---   has a resource fork, all this is preserved.
+--- - When the file is a link the backup will have the name of the link,
+---   not of the real file.
+---
+--- Renaming the file and writing a new one:
+--- + It's fast.
+--- - Sometimes not all attributes of the file can be copied to the new
+---   file.
+--- - When the file is a link the new file will not be a link.
+---
+--- The "auto" value is the middle way: When Vim sees that renaming the
+--- file is possible without side effects (the attributes can be passed on
+--- and the file is not a link) that is used.  When problems are expected,
+--- a copy will be made.
+---
+--- The "breaksymlink" and "breakhardlink" values can be used in
+--- combination with any of "yes", "no" and "auto".  When included, they
+--- force Vim to always break either symbolic or hard links by doing
+--- exactly what the "no" option does, renaming the original file to
+--- become the backup and writing a new file in its place.  This can be
+--- useful for example in source trees where all the files are symbolic or
+--- hard links and any changes should stay in the local source tree, not
+--- be propagated back to the original source.
+--- 						*crontab*
+--- One situation where "no" and "auto" will cause problems: A program
+--- that opens a file, invokes Vim to edit that file, and then tests if
+--- the open file was changed (through the file descriptor) will check the
+--- backup file instead of the newly created file.  "crontab -e" is an
+--- example.
+---
+--- When a copy is made, the original file is truncated and then filled
+--- with the new text.  This means that protection bits, owner and
+--- symbolic links of the original file are unmodified.  The backup file,
+--- however, is a new file, owned by the user who edited the file.  The
+--- group of the backup is set to the group of the original file.  If this
+--- fails, the protection bits for the group are made the same as for
+--- others.
+---
+--- When the file is renamed, this is the other way around: The backup has
+--- the same attributes of the original file, and the newly written file
+--- is owned by the current user.  When the file was a (hard/symbolic)
+--- link, the new file will not!  That's why the "auto" value doesn't
+--- rename when the file is a link.  The owner and group of the newly
+--- written file will be set to the same ones as the original file, but
+--- the system may refuse to do this.  In that case the "auto" value will
+--- again not rename the file.
+---
+--- @type string
+vim.o.backupcopy = "auto"
+vim.o.bkc = vim.o.backupcopy
+vim.bo.backupcopy = vim.o.backupcopy
+vim.bo.bkc = vim.bo.backupcopy
+vim.go.backupcopy = vim.o.backupcopy
+vim.go.bkc = vim.go.backupcopy
+
+--- List of directories for the backup file, separated with commas.
+--- - The backup file will be created in the first directory in the list
+---   where this is possible.  If none of the directories exist Nvim will
+---   attempt to create the last directory in the list.
+--- - Empty means that no backup file will be created ('patchmode' is
+---   impossible!).  Writing may fail because of this.
+--- - A directory "." means to put the backup file in the same directory
+---   as the edited file.
+--- - A directory starting with "./" (or ".\" for MS-Windows) means to put
+---   the backup file relative to where the edited file is.  The leading
+---   "." is replaced with the path name of the edited file.
+---   ("." inside a directory name has no special meaning).
+--- - Spaces after the comma are ignored, other spaces are considered part
+---   of the directory name.  To have a space at the start of a directory
+---   name, precede it with a backslash.
+--- - To include a comma in a directory name precede it with a backslash.
+--- - A directory name may end in an '/'.
+--- - For Unix and Win32, if a directory ends in two path separators "//",
+---   the swap file name will be built from the complete path to the file
+---   with all path separators changed to percent '%' signs. This will
+---   ensure file name uniqueness in the backup directory.
+---   On Win32, it is also possible to end with "\\".  However, When a
+---   separating comma is following, you must use "//", since "\\" will
+---   include the comma in the file name. Therefore it is recommended to
+---   use '//', instead of '\\'.
+--- - Environment variables are expanded `:set_env`.
+--- - Careful with '\' characters, type one before a space, type two to
+---   get one in the option (see `option-backslash`), for example:
+--- ```
+---     :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
+--- ```
+--- See also 'backup' and 'writebackup' options.
+--- If you want to hide your backup files on Unix, consider this value:
+--- ```
+--- 	:set backupdir=./.backup,~/.backup,.,/tmp
+--- ```
+--- You must create a ".backup" directory in each directory and in your
+--- home directory for this to work properly.
+--- The use of `:set+=` and `:set-=` is preferred when adding or removing
+--- directories from the list.  This avoids problems when a future version
+--- uses another default.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.backupdir = ".,$XDG_STATE_HOME/nvim/backup//"
+vim.o.bdir = vim.o.backupdir
+vim.go.backupdir = vim.o.backupdir
+vim.go.bdir = vim.go.backupdir
+
+--- String which is appended to a file name to make the name of the
+--- backup file.  The default is quite unusual, because this avoids
+--- accidentally overwriting existing files with a backup file.  You might
+--- prefer using ".bak", but make sure that you don't have files with
+--- ".bak" that you want to keep.
+--- Only normal file name characters can be used; `/\*?[|<>` are illegal.
+---
+--- If you like to keep a lot of backups, you could use a BufWritePre
+--- autocommand to change 'backupext' just before writing the file to
+--- include a timestamp.
+--- ```
+--- 	:au BufWritePre * let &bex = '-' .. strftime("%Y%b%d%X") .. '~'
+--- ```
+--- Use 'backupdir' to put the backup in a different directory.
+---
+--- @type string
+vim.o.backupext = "~"
+vim.o.bex = vim.o.backupext
+vim.go.backupext = vim.o.backupext
+vim.go.bex = vim.go.backupext
+
+--- A list of file patterns.  When one of the patterns matches with the
+--- name of the file which is written, no backup file is created.  Both
+--- the specified file name and the full path name of the file are used.
+--- The pattern is used like with `:autocmd`, see `autocmd-pattern`.
+--- Watch out for special characters, see `option-backslash`.
+--- When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
+--- default value.  "/tmp/*" is only used for Unix.
+---
+--- WARNING: Not having a backup file means that when Vim fails to write
+--- your buffer correctly and then, for whatever reason, Vim exits, you
+--- lose both the original file and what you were writing.  Only disable
+--- backups if you don't care about losing the file.
+---
+--- Note that environment variables are not expanded.  If you want to use
+--- $HOME you must expand it explicitly, e.g.:
+--- ```
+--- 	:let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
+---
+--- ```
+--- Note that the default also makes sure that "crontab -e" works (when a
+--- backup would be made by renaming the original file crontab won't see
+--- the newly created file).  Also see 'backupcopy' and `crontab`.
+---
+--- @type string
+vim.o.backupskip = "/tmp/*"
+vim.o.bsk = vim.o.backupskip
+vim.go.backupskip = vim.o.backupskip
+vim.go.bsk = vim.go.backupskip
+
+--- Specifies for which events the bell will not be rung. It is a comma-
+--- separated list of items. For each item that is present, the bell
+--- will be silenced. This is most useful to specify specific events in
+--- insert mode to be silenced.
+---
+--- item	    meaning when present	~
+--- all	    All events.
+--- backspace   When hitting <BS> or <Del> and deleting results in an
+--- 	    error.
+--- cursor	    Fail to move around using the cursor keys or
+--- 	    <PageUp>/<PageDown> in `Insert-mode`.
+--- complete    Error occurred when using `i_CTRL-X_CTRL-K` or
+--- 	    `i_CTRL-X_CTRL-T`.
+--- copy	    Cannot copy char from insert mode using `i_CTRL-Y` or
+--- 	    `i_CTRL-E`.
+--- ctrlg	    Unknown Char after <C-G> in Insert mode.
+--- error	    Other Error occurred (e.g. try to join last line)
+--- 	    (mostly used in `Normal-mode` or `Cmdline-mode`).
+--- esc	    hitting <Esc> in `Normal-mode`.
+--- hangul	    Ignored.
+--- lang	    Calling the beep module for Lua/Mzscheme/TCL.
+--- mess	    No output available for `g<`.
+--- showmatch   Error occurred for 'showmatch' function.
+--- operator    Empty region error `cpo-E`.
+--- register    Unknown register after <C-R> in `Insert-mode`.
+--- shell	    Bell from shell output `:!`.
+--- spell	    Error happened on spell suggest.
+--- wildmode    More matches in `cmdline-completion` available
+--- 	    (depends on the 'wildmode' setting).
+---
+--- This is most useful to fine tune when in Insert mode the bell should
+--- be rung. For Normal mode and Ex commands, the bell is often rung to
+--- indicate that an error occurred. It can be silenced by adding the
+--- "error" keyword.
+---
+--- @type string
+vim.o.belloff = "all"
+vim.o.bo = vim.o.belloff
+vim.go.belloff = vim.o.belloff
+vim.go.bo = vim.go.belloff
+
+--- This option should be set before editing a binary file.  You can also
+--- use the `-b` Vim argument.  When this option is switched on a few
+--- options will be changed (also when it already was on):
+--- 	'textwidth'  will be set to 0
+--- 	'wrapmargin' will be set to 0
+--- 	'modeline'   will be off
+--- 	'expandtab'  will be off
+--- Also, 'fileformat' and 'fileformats' options will not be used, the
+--- file is read and written like 'fileformat' was "unix" (a single <NL>
+--- separates lines).
+--- The 'fileencoding' and 'fileencodings' options will not be used, the
+--- file is read without conversion.
+--- NOTE: When you start editing a(nother) file while the 'bin' option is
+--- on, settings from autocommands may change the settings again (e.g.,
+--- 'textwidth'), causing trouble when editing.  You might want to set
+--- 'bin' again when the file has been loaded.
+--- The previous values of these options are remembered and restored when
+--- 'bin' is switched from on to off.  Each buffer has its own set of
+--- saved option values.
+--- To edit a file with 'binary' set you can use the `++bin` argument.
+--- This avoids you have to do ":set bin", which would have effect for all
+--- files you edit.
+--- When writing a file the <EOL> for the last line is only written if
+--- there was one in the original file (normally Vim appends an <EOL> to
+--- the last line if there is none; this would make the file longer).  See
+--- the 'endofline' option.
+---
+--- @type boolean
+vim.o.binary = false
+vim.o.bin = vim.o.binary
+vim.bo.binary = vim.o.binary
+vim.bo.bin = vim.bo.binary
+
+--- When writing a file and the following conditions are met, a BOM (Byte
+--- Order Mark) is prepended to the file:
+--- - this option is on
+--- - the 'binary' option is off
+--- - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
+---   endian variants.
+--- Some applications use the BOM to recognize the encoding of the file.
+--- Often used for UCS-2 files on MS-Windows.  For other applications it
+--- causes trouble, for example: "cat file1 file2" makes the BOM of file2
+--- appear halfway through the resulting file.  Gcc doesn't accept a BOM.
+--- When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
+--- check for the presence of the BOM is done and 'bomb' set accordingly.
+--- Unless 'binary' is set, it is removed from the first line, so that you
+--- don't see it when editing.  When you don't change the options, the BOM
+--- will be restored when writing the file.
+---
+--- @type boolean
+vim.o.bomb = false
+vim.bo.bomb = vim.o.bomb
+
+--- This option lets you choose which characters might cause a line
+--- break if 'linebreak' is on.  Only works for ASCII characters.
+---
+--- @type string
+vim.o.breakat = " \t!@*-+;:,./?"
+vim.o.brk = vim.o.breakat
+vim.go.breakat = vim.o.breakat
+vim.go.brk = vim.go.breakat
+
+--- Every wrapped line will continue visually indented (same amount of
+--- space as the beginning of that line), thus preserving horizontal blocks
+--- of text.
+---
+--- @type boolean
+vim.o.breakindent = false
+vim.o.bri = vim.o.breakindent
+vim.wo.breakindent = vim.o.breakindent
+vim.wo.bri = vim.wo.breakindent
+
+--- Settings for 'breakindent'. It can consist of the following optional
+--- items and must be separated by a comma:
+--- 	min:{n}	    Minimum text width that will be kept after
+--- 		    applying 'breakindent', even if the resulting
+--- 		    text should normally be narrower. This prevents
+--- 		    text indented almost to the right window border
+--- 		    occupying lot of vertical space when broken.
+--- 		    (default: 20)
+--- 	shift:{n}   After applying 'breakindent', the wrapped line's
+--- 		    beginning will be shifted by the given number of
+--- 		    characters.  It permits dynamic French paragraph
+--- 		    indentation (negative) or emphasizing the line
+--- 		    continuation (positive).
+--- 		    (default: 0)
+--- 	sbr	    Display the 'showbreak' value before applying the
+--- 		    additional indent.
+--- 		    (default: off)
+--- 	list:{n}    Adds an additional indent for lines that match a
+--- 		    numbered or bulleted list (using the
+--- 		    'formatlistpat' setting).
+--- 	list:-1	    Uses the length of a match with 'formatlistpat'
+--- 		    for indentation.
+--- 		    (default: 0)
+--- 	column:{n}  Indent at column {n}. Will overrule the other
+--- 		    sub-options. Note: an additional indent may be
+--- 		    added for the 'showbreak' setting.
+--- 		    (default: off)
+---
+--- @type string
+vim.o.breakindentopt = ""
+vim.o.briopt = vim.o.breakindentopt
+vim.wo.breakindentopt = vim.o.breakindentopt
+vim.wo.briopt = vim.wo.breakindentopt
+
+--- Which directory to use for the file browser:
+---    last		Use same directory as with last file browser, where a
+--- 		file was opened or saved.
+---    buffer	Use the directory of the related buffer.
+---    current	Use the current directory.
+---    {path}	Use the specified directory
+---
+--- @type string
+vim.o.browsedir = ""
+vim.o.bsdir = vim.o.browsedir
+vim.go.browsedir = vim.o.browsedir
+vim.go.bsdir = vim.go.browsedir
+
+--- This option specifies what happens when a buffer is no longer
+--- displayed in a window:
+---   <empty>	follow the global 'hidden' option
+---   hide		hide the buffer (don't unload it), even if 'hidden' is
+--- 		not set
+---   unload	unload the buffer, even if 'hidden' is set; the
+--- 		`:hide` command will also unload the buffer
+---   delete	delete the buffer from the buffer list, even if
+--- 		'hidden' is set; the `:hide` command will also delete
+--- 		the buffer, making it behave like `:bdelete`
+---   wipe		wipe the buffer from the buffer list, even if
+--- 		'hidden' is set; the `:hide` command will also wipe
+--- 		out the buffer, making it behave like `:bwipeout`
+---
+--- CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
+--- are lost without a warning.  Also, these values may break autocommands
+--- that switch between buffers temporarily.
+--- This option is used together with 'buftype' and 'swapfile' to specify
+--- special kinds of buffers.   See `special-buffers`.
+---
+--- @type string
+vim.o.bufhidden = ""
+vim.o.bh = vim.o.bufhidden
+vim.bo.bufhidden = vim.o.bufhidden
+vim.bo.bh = vim.bo.bufhidden
+
+--- When this option is set, the buffer shows up in the buffer list.  If
+--- it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
+--- This option is reset by Vim for buffers that are only used to remember
+--- a file name or marks.  Vim sets it when starting to edit a buffer.
+--- But not when moving to a buffer with ":buffer".
+---
+--- @type boolean
+vim.o.buflisted = true
+vim.o.bl = vim.o.buflisted
+vim.bo.buflisted = vim.o.buflisted
+vim.bo.bl = vim.bo.buflisted
+
+--- The value of this option specifies the type of a buffer:
+---   <empty>	normal buffer
+---   acwrite	buffer will always be written with `BufWriteCmd`s
+---   help		help buffer (do not set this manually)
+---   nofile	buffer is not related to a file, will not be written
+---   nowrite	buffer will not be written
+---   quickfix	list of errors `:cwindow` or locations `:lwindow`
+---   terminal	`terminal-emulator` buffer
+---   prompt	buffer where only the last line can be edited, meant
+--- 		to be used by a plugin, see `prompt-buffer`
+---
+--- This option is used together with 'bufhidden' and 'swapfile' to
+--- specify special kinds of buffers.   See `special-buffers`.
+--- Also see `win_gettype()`, which returns the type of the window.
+---
+--- Be careful with changing this option, it can have many side effects!
+--- One such effect is that Vim will not check the timestamp of the file,
+--- if the file is changed by another program this will not be noticed.
+---
+--- A "quickfix" buffer is only used for the error list and the location
+--- list.  This value is set by the `:cwindow` and `:lwindow` commands and
+--- you are not supposed to change it.
+---
+--- "nofile" and "nowrite" buffers are similar:
+--- both:		The buffer is not to be written to disk, ":w" doesn't
+--- 		work (":w filename" does work though).
+--- both:		The buffer is never considered to be `'modified'`.
+--- 		There is no warning when the changes will be lost, for
+--- 		example when you quit Vim.
+--- both:		A swap file is only created when using too much memory
+--- 		(when 'swapfile' has been reset there is never a swap
+--- 		file).
+--- nofile only:	The buffer name is fixed, it is not handled like a
+--- 		file name.  It is not modified in response to a `:cd`
+--- 		command.
+--- both:		When using ":e bufname" and already editing "bufname"
+--- 		the buffer is made empty and autocommands are
+--- 		triggered as usual for `:edit`.
+--- 						*E676*
+--- "acwrite" implies that the buffer name is not related to a file, like
+--- "nofile", but it will be written.  Thus, in contrast to "nofile" and
+--- "nowrite", ":w" does work and a modified buffer can't be abandoned
+--- without saving.  For writing there must be matching `BufWriteCmd|,
+--- |FileWriteCmd` or `FileAppendCmd` autocommands.
+---
+--- @type string
+vim.o.buftype = ""
+vim.o.bt = vim.o.buftype
+vim.bo.buftype = vim.o.buftype
+vim.bo.bt = vim.bo.buftype
+
+--- Specifies details about changing the case of letters.  It may contain
+--- these words, separated by a comma:
+--- internal	Use internal case mapping functions, the current
+--- 		locale does not change the case mapping. When
+--- 		"internal" is omitted, the towupper() and towlower()
+--- 		system library functions are used when available.
+--- keepascii	For the ASCII characters (0x00 to 0x7f) use the US
+--- 		case mapping, the current locale is not effective.
+--- 		This probably only matters for Turkish.
+---
+--- @type string
+vim.o.casemap = "internal,keepascii"
+vim.o.cmp = vim.o.casemap
+vim.go.casemap = vim.o.casemap
+vim.go.cmp = vim.go.casemap
+
+--- When on, `:cd`, `:tcd` and `:lcd` without an argument changes the
+--- current working directory to the `$HOME` directory like in Unix.
+--- When off, those commands just print the current directory name.
+--- On Unix this option has no effect.
+---
+--- @type boolean
+vim.o.cdhome = false
+vim.o.cdh = vim.o.cdhome
+vim.go.cdhome = vim.o.cdhome
+vim.go.cdh = vim.go.cdhome
+
+--- This is a list of directories which will be searched when using the
+--- `:cd`, `:tcd` and `:lcd` commands, provided that the directory being
+--- searched for has a relative path, not an absolute part starting with
+--- "/", "./" or "../", the 'cdpath' option is not used then.
+--- The 'cdpath' option's value has the same form and semantics as
+--- `'path'`.  Also see `file-searching`.
+--- The default value is taken from $CDPATH, with a "," prepended to look
+--- in the current directory first.
+--- If the default value taken from $CDPATH is not what you want, include
+--- a modified version of the following command in your vimrc file to
+--- override it:
+--- ```
+---   :let &cdpath = ',' .. substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
+--- ```
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+--- (parts of 'cdpath' can be passed to the shell to expand file names).
+---
+--- @type string
+vim.o.cdpath = ",,"
+vim.o.cd = vim.o.cdpath
+vim.go.cdpath = vim.o.cdpath
+vim.go.cd = vim.go.cdpath
+
+--- The key used in Command-line Mode to open the command-line window.
+--- Only non-printable keys are allowed.
+--- The key can be specified as a single character, but it is difficult to
+--- type.  The preferred way is to use the <> notation.  Examples:
+--- ```
+--- 	:exe "set cedit=\\<C-Y>"
+--- 	:exe "set cedit=\\<Esc>"
+--- ```
+--- `Nvi` also has this option, but it only uses the first character.
+--- See `cmdwin`.
+---
+--- @type string
+vim.o.cedit = "\6"
+vim.go.cedit = vim.o.cedit
+
+--- `channel` connected to the buffer, or 0 if no channel is connected.
+--- In a `:terminal` buffer this is the terminal channel.
+--- Read-only.
+---
+--- @type integer
+vim.o.channel = 0
+vim.bo.channel = vim.o.channel
+
+--- An expression that is used for character encoding conversion.  It is
+--- evaluated when a file that is to be read or has been written has a
+--- different encoding from what is desired.
+--- 'charconvert' is not used when the internal iconv() function is
+--- supported and is able to do the conversion.  Using iconv() is
+--- preferred, because it is much faster.
+--- 'charconvert' is not used when reading stdin `--`, because there is no
+--- file to convert from.  You will have to save the text in a file first.
+--- The expression must return zero, false or an empty string for success,
+--- non-zero or true for failure.
+--- See `encoding-names` for possible encoding names.
+--- Additionally, names given in 'fileencodings' and 'fileencoding' are
+--- used.
+--- Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
+--- is done internally by Vim, 'charconvert' is not used for this.
+--- Also used for Unicode conversion.
+--- Example:
+--- ```
+--- 	set charconvert=CharConvert()
+--- 	fun CharConvert()
+--- 	  system("recode "
+--- 		\ .. v:charconvert_from .. ".." .. v:charconvert_to
+--- 		\ .. " <" .. v:fname_in .. " >" .. v:fname_out)
+--- 	  return v:shell_error
+--- 	endfun
+--- ```
+--- The related Vim variables are:
+--- 	v:charconvert_from	name of the current encoding
+--- 	v:charconvert_to	name of the desired encoding
+--- 	v:fname_in		name of the input file
+--- 	v:fname_out		name of the output file
+--- Note that v:fname_in and v:fname_out will never be the same.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.charconvert = ""
+vim.o.ccv = vim.o.charconvert
+vim.go.charconvert = vim.o.charconvert
+vim.go.ccv = vim.go.charconvert
+
+--- Enables automatic C program indenting.  See 'cinkeys' to set the keys
+--- that trigger reindenting in insert mode and 'cinoptions' to set your
+--- preferred indent style.
+--- If 'indentexpr' is not empty, it overrules 'cindent'.
+--- If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
+--- the "=" operator indents using this algorithm rather than calling an
+--- external program.
+--- See `C-indenting`.
+--- When you don't like the way 'cindent' works, try the 'smartindent'
+--- option or 'indentexpr'.
+---
+--- @type boolean
+vim.o.cindent = false
+vim.o.cin = vim.o.cindent
+vim.bo.cindent = vim.o.cindent
+vim.bo.cin = vim.bo.cindent
+
+--- A list of keys that, when typed in Insert mode, cause reindenting of
+--- the current line.  Only used if 'cindent' is on and 'indentexpr' is
+--- empty.
+--- For the format of this option see `cinkeys-format`.
+--- See `C-indenting`.
+---
+--- @type string
+vim.o.cinkeys = "0{,0},0),0],:,0#,!^F,o,O,e"
+vim.o.cink = vim.o.cinkeys
+vim.bo.cinkeys = vim.o.cinkeys
+vim.bo.cink = vim.bo.cinkeys
+
+--- The 'cinoptions' affect the way 'cindent' reindents lines in a C
+--- program.  See `cinoptions-values` for the values of this option, and
+--- `C-indenting` for info on C indenting in general.
+---
+--- @type string
+vim.o.cinoptions = ""
+vim.o.cino = vim.o.cinoptions
+vim.bo.cinoptions = vim.o.cinoptions
+vim.bo.cino = vim.bo.cinoptions
+
+--- Keywords that are interpreted as a C++ scope declaration by `cino-g`.
+--- Useful e.g. for working with the Qt framework that defines additional
+--- scope declarations "signals", "public slots" and "private slots":
+--- ```
+--- 	set cinscopedecls+=signals,public\ slots,private\ slots
+--- ```
+---
+--- @type string
+vim.o.cinscopedecls = "public,protected,private"
+vim.o.cinsd = vim.o.cinscopedecls
+vim.bo.cinscopedecls = vim.o.cinscopedecls
+vim.bo.cinsd = vim.bo.cinscopedecls
+
+--- These keywords start an extra indent in the next line when
+--- 'smartindent' or 'cindent' is set.  For 'cindent' this is only done at
+--- an appropriate place (inside {}).
+--- Note that 'ignorecase' isn't used for 'cinwords'.  If case doesn't
+--- matter, include the keyword both the uppercase and lowercase:
+--- "if,If,IF".
+---
+--- @type string
+vim.o.cinwords = "if,else,while,do,for,switch"
+vim.o.cinw = vim.o.cinwords
+vim.bo.cinwords = vim.o.cinwords
+vim.bo.cinw = vim.bo.cinwords
+
+--- This option is a list of comma-separated names.
+--- These names are recognized:
+---
+--- 					*clipboard-unnamed*
+--- unnamed		When included, Vim will use the clipboard register "*"
+--- 		for all yank, delete, change and put operations which
+--- 		would normally go to the unnamed register.  When a
+--- 		register is explicitly specified, it will always be
+--- 		used regardless of whether "unnamed" is in 'clipboard'
+--- 		or not.  The clipboard register can always be
+--- 		explicitly accessed using the "* notation.  Also see
+--- 		`clipboard`.
+---
+--- 					*clipboard-unnamedplus*
+--- unnamedplus	A variant of the "unnamed" flag which uses the
+--- 		clipboard register "+" (`quoteplus`) instead of
+--- 		register "*" for all yank, delete, change and put
+--- 		operations which would normally go to the unnamed
+--- 		register.  When "unnamed" is also included to the
+--- 		option, yank and delete operations (but not put)
+--- 		will additionally copy the text into register
+--- 		"*". See `clipboard`.
+---
+--- @type string
+vim.o.clipboard = ""
+vim.o.cb = vim.o.clipboard
+vim.go.clipboard = vim.o.clipboard
+vim.go.cb = vim.go.clipboard
+
+--- Number of screen lines to use for the command-line.  Helps avoiding
+--- `hit-enter` prompts.
+--- The value of this option is stored with the tab page, so that each tab
+--- page can have a different value.
+---
+--- When 'cmdheight' is zero, there is no command-line unless it is being
+--- used.  The command-line will cover the last line of the screen when
+--- shown.
+---
+--- WARNING: `cmdheight=0` is considered experimental. Expect some
+--- unwanted behaviour. Some 'shortmess' flags and similar
+--- mechanism might fail to take effect, causing unwanted hit-enter
+--- prompts.  Some informative messages, both from Nvim itself and
+--- plugins, will not be displayed.
+---
+--- @type integer
+vim.o.cmdheight = 1
+vim.o.ch = vim.o.cmdheight
+vim.go.cmdheight = vim.o.cmdheight
+vim.go.ch = vim.go.cmdheight
+
+--- Number of screen lines to use for the command-line window. `cmdwin`
+---
+--- @type integer
+vim.o.cmdwinheight = 7
+vim.o.cwh = vim.o.cmdwinheight
+vim.go.cmdwinheight = vim.o.cmdwinheight
+vim.go.cwh = vim.go.cmdwinheight
+
+--- 'colorcolumn' is a comma-separated list of screen columns that are
+--- highlighted with ColorColumn `hl-ColorColumn`.  Useful to align
+--- text.  Will make screen redrawing slower.
+--- The screen column can be an absolute number, or a number preceded with
+--- '+' or '-', which is added to or subtracted from 'textwidth'.
+--- ```
+---
+--- 	:set cc=+1	  " highlight column after 'textwidth'
+--- 	:set cc=+1,+2,+3  " highlight three columns after 'textwidth'
+--- 	:hi ColorColumn ctermbg=lightgrey guibg=lightgrey
+--- ```
+--- When 'textwidth' is zero then the items with '-' and '+' are not used.
+--- A maximum of 256 columns are highlighted.
+---
+--- @type string
+vim.o.colorcolumn = ""
+vim.o.cc = vim.o.colorcolumn
+vim.wo.colorcolumn = vim.o.colorcolumn
+vim.wo.cc = vim.wo.colorcolumn
+
+--- Number of columns of the screen.  Normally this is set by the terminal
+--- initialization and does not have to be set by hand.
+--- When Vim is running in the GUI or in a resizable window, setting this
+--- option will cause the window size to be changed.  When you only want
+--- to use the size for the GUI, put the command in your `ginit.vim` file.
+--- When you set this option and Vim is unable to change the physical
+--- number of columns of the display, the display may be messed up.  For
+--- the GUI it is always possible and Vim limits the number of columns to
+--- what fits on the screen.  You can use this command to get the widest
+--- window possible:
+--- ```
+--- 	:set columns=9999
+--- ```
+--- Minimum value is 12, maximum value is 10000.
+---
+--- @type integer
+vim.o.columns = 80
+vim.o.co = vim.o.columns
+vim.go.columns = vim.o.columns
+vim.go.co = vim.go.columns
+
+--- A comma-separated list of strings that can start a comment line.  See
+--- `format-comments`.  See `option-backslash` about using backslashes to
+--- insert a space.
+---
+--- @type string
+vim.o.comments = "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-"
+vim.o.com = vim.o.comments
+vim.bo.comments = vim.o.comments
+vim.bo.com = vim.bo.comments
+
+--- A template for a comment.  The "%s" in the value is replaced with the
+--- comment text.  For example, C uses "/*%s*/". Currently only used to
+--- add markers for folding, see `fold-marker`.
+---
+--- @type string
+vim.o.commentstring = ""
+vim.o.cms = vim.o.commentstring
+vim.bo.commentstring = vim.o.commentstring
+vim.bo.cms = vim.bo.commentstring
+
+--- This option specifies how keyword completion `ins-completion` works
+--- when CTRL-P or CTRL-N are used.  It is also used for whole-line
+--- completion `i_CTRL-X_CTRL-L`.  It indicates the type of completion
+--- and the places to scan.  It is a comma-separated list of flags:
+--- .	scan the current buffer ('wrapscan' is ignored)
+--- w	scan buffers from other windows
+--- b	scan other loaded buffers that are in the buffer list
+--- u	scan the unloaded buffers that are in the buffer list
+--- U	scan the buffers that are not in the buffer list
+--- k	scan the files given with the 'dictionary' option
+--- kspell  use the currently active spell checking `spell`
+--- k{dict}	scan the file {dict}.  Several "k" flags can be given,
+--- 	patterns are valid too.  For example:
+--- ```
+--- 		:set cpt=k/usr/dict/*,k~/spanish
+--- ```
+--- s	scan the files given with the 'thesaurus' option
+--- s{tsr}	scan the file {tsr}.  Several "s" flags can be given, patterns
+--- 	are valid too.
+--- i	scan current and included files
+--- d	scan current and included files for defined name or macro
+--- 	`i_CTRL-X_CTRL-D`
+--- ]	tag completion
+--- t	same as "]"
+---
+--- Unloaded buffers are not loaded, thus their autocmds `:autocmd` are
+--- not executed, this may lead to unexpected completions from some files
+--- (gzipped files for example).  Unloaded buffers are not scanned for
+--- whole-line completion.
+---
+--- As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
+--- based expansion (e.g., dictionary `i_CTRL-X_CTRL-K`, included patterns
+--- `i_CTRL-X_CTRL-I`, tags `i_CTRL-X_CTRL-]` and normal expansions).
+---
+--- @type string
+vim.o.complete = ".,w,b,u,t"
+vim.o.cpt = vim.o.complete
+vim.bo.complete = vim.o.complete
+vim.bo.cpt = vim.bo.complete
+
+--- This option specifies a function to be used for Insert mode completion
+--- with CTRL-X CTRL-U. `i_CTRL-X_CTRL-U`
+--- See `complete-functions` for an explanation of how the function is
+--- invoked and what it should return.  The value can be the name of a
+--- function, a `lambda` or a `Funcref`. See `option-value-function` for
+--- more information.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.completefunc = ""
+vim.o.cfu = vim.o.completefunc
+vim.bo.completefunc = vim.o.completefunc
+vim.bo.cfu = vim.bo.completefunc
+
+--- A comma-separated list of options for Insert mode completion
+--- `ins-completion`.  The supported values are:
+---
+---    menu	    Use a popup menu to show the possible completions.  The
+--- 	    menu is only shown when there is more than one match and
+--- 	    sufficient colors are available.  `ins-completion-menu`
+---
+---    menuone  Use the popup menu also when there is only one match.
+--- 	    Useful when there is additional information about the
+--- 	    match, e.g., what file it comes from.
+---
+---    longest  Only insert the longest common text of the matches.  If
+--- 	    the menu is displayed you can use CTRL-L to add more
+--- 	    characters.  Whether case is ignored depends on the kind
+--- 	    of completion.  For buffer text the 'ignorecase' option is
+--- 	    used.
+---
+---    preview  Show extra information about the currently selected
+--- 	    completion in the preview window.  Only works in
+--- 	    combination with "menu" or "menuone".
+---
+---   noinsert  Do not insert any text for a match until the user selects
+--- 	    a match from the menu. Only works in combination with
+--- 	    "menu" or "menuone". No effect if "longest" is present.
+---
+---   noselect  Do not select a match in the menu, force the user to
+--- 	    select one from the menu. Only works in combination with
+--- 	    "menu" or "menuone".
+---
+--- @type string
+vim.o.completeopt = "menu,preview"
+vim.o.cot = vim.o.completeopt
+vim.go.completeopt = vim.o.completeopt
+vim.go.cot = vim.go.completeopt
+
+--- 		only for MS-Windows
+--- When this option is set it overrules 'shellslash' for completion:
+--- - When this option is set to "slash", a forward slash is used for path
+---   completion in insert mode. This is useful when editing HTML tag, or
+---   Makefile with 'noshellslash' on MS-Windows.
+--- - When this option is set to "backslash", backslash is used. This is
+---   useful when editing a batch file with 'shellslash' set on MS-Windows.
+--- - When this option is empty, same character is used as for
+---   'shellslash'.
+--- For Insert mode completion the buffer-local value is used.  For
+--- command line completion the global value is used.
+---
+--- @type string
+vim.o.completeslash = ""
+vim.o.csl = vim.o.completeslash
+vim.bo.completeslash = vim.o.completeslash
+vim.bo.csl = vim.bo.completeslash
+
+--- Sets the modes in which text in the cursor line can also be concealed.
+--- When the current mode is listed then concealing happens just like in
+--- other lines.
+---   n		Normal mode
+---   v		Visual mode
+---   i		Insert mode
+---   c		Command line editing, for 'incsearch'
+---
+--- 'v' applies to all lines in the Visual area, not only the cursor.
+--- A useful value is "nc".  This is used in help files.  So long as you
+--- are moving around text is concealed, but when starting to insert text
+--- or selecting a Visual area the concealed text is displayed, so that
+--- you can see what you are doing.
+--- Keep in mind that the cursor position is not always where it's
+--- displayed.  E.g., when moving vertically it may change column.
+---
+--- @type string
+vim.o.concealcursor = ""
+vim.o.cocu = vim.o.concealcursor
+vim.wo.concealcursor = vim.o.concealcursor
+vim.wo.cocu = vim.wo.concealcursor
+
+--- Determine how text with the "conceal" syntax attribute `:syn-conceal`
+--- is shown:
+---
+--- Value		Effect ~
+--- 0		Text is shown normally
+--- 1		Each block of concealed text is replaced with one
+--- 		character.  If the syntax item does not have a custom
+--- 		replacement character defined (see `:syn-cchar`) the
+--- 		character defined in 'listchars' is used.
+--- 		It is highlighted with the "Conceal" highlight group.
+--- 2		Concealed text is completely hidden unless it has a
+--- 		custom replacement character defined (see
+--- 		`:syn-cchar`).
+--- 3		Concealed text is completely hidden.
+---
+--- Note: in the cursor line concealed text is not hidden, so that you can
+--- edit and copy the text.  This can be changed with the 'concealcursor'
+--- option.
+---
+--- @type integer
+vim.o.conceallevel = 0
+vim.o.cole = vim.o.conceallevel
+vim.wo.conceallevel = vim.o.conceallevel
+vim.wo.cole = vim.wo.conceallevel
+
+--- When 'confirm' is on, certain operations that would normally
+--- fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
+--- instead raise a dialog asking if you wish to save the current
+--- file(s).  You can still use a ! to unconditionally `abandon` a buffer.
+--- If 'confirm' is off you can still activate confirmation for one
+--- command only (this is most useful in mappings) with the `:confirm`
+--- command.
+--- Also see the `confirm()` function and the 'v' flag in 'guioptions'.
+---
+--- @type boolean
+vim.o.confirm = false
+vim.o.cf = vim.o.confirm
+vim.go.confirm = vim.o.confirm
+vim.go.cf = vim.go.confirm
+
+--- Copy the structure of the existing lines indent when autoindenting a
+--- new line.  Normally the new indent is reconstructed by a series of
+--- tabs followed by spaces as required (unless `'expandtab'` is enabled,
+--- in which case only spaces are used).  Enabling this option makes the
+--- new line copy whatever characters were used for indenting on the
+--- existing line.  'expandtab' has no effect on these characters, a Tab
+--- remains a Tab.  If the new indent is greater than on the existing
+--- line, the remaining space is filled in the normal manner.
+--- See 'preserveindent'.
+---
+--- @type boolean
+vim.o.copyindent = false
+vim.o.ci = vim.o.copyindent
+vim.bo.copyindent = vim.o.copyindent
+vim.bo.ci = vim.bo.copyindent
+
+--- A sequence of single character flags.  When a character is present
+--- this indicates Vi-compatible behavior.  This is used for things where
+--- not being Vi-compatible is mostly or sometimes preferred.
+--- 'cpoptions' stands for "compatible-options".
+--- Commas can be added for readability.
+--- To avoid problems with flags that are added in the future, use the
+--- "+=" and "-=" feature of ":set" `add-option-flags`.
+---
+---     contains	behavior	~
+--- 							*cpo-a*
+--- 	a	When included, a ":read" command with a file name
+--- 		argument will set the alternate file name for the
+--- 		current window.
+--- 							*cpo-A*
+--- 	A	When included, a ":write" command with a file name
+--- 		argument will set the alternate file name for the
+--- 		current window.
+--- 							*cpo-b*
+--- 	b	"\|" in a ":map" command is recognized as the end of
+--- 		the map command.  The '\' is included in the mapping,
+--- 		the text after the '|' is interpreted as the next
+--- 		command.  Use a CTRL-V instead of a backslash to
+--- 		include the '|' in the mapping.  Applies to all
+--- 		mapping, abbreviation, menu and autocmd commands.
+--- 		See also `map_bar`.
+--- 							*cpo-B*
+--- 	B	A backslash has no special meaning in mappings,
+--- 		abbreviations, user commands and the "to" part of the
+--- 		menu commands.  Remove this flag to be able to use a
+--- 		backslash like a CTRL-V.  For example, the command
+--- 		":map X \\<Esc>" results in X being mapped to:
+--- 			'B' included:	"\^["	 (^[ is a real <Esc>)
+--- 			'B' excluded:	"<Esc>"  (5 characters)
+--- 							*cpo-c*
+--- 	c	Searching continues at the end of any match at the
+--- 		cursor position, but not further than the start of the
+--- 		next line.  When not present searching continues
+--- 		one character from the cursor position.  With 'c'
+--- 		"abababababab" only gets three matches when repeating
+--- 		"/abab", without 'c' there are five matches.
+--- 							*cpo-C*
+--- 	C	Do not concatenate sourced lines that start with a
+--- 		backslash.  See `line-continuation`.
+--- 							*cpo-d*
+--- 	d	Using "./" in the 'tags' option doesn't mean to use
+--- 		the tags file relative to the current file, but the
+--- 		tags file in the current directory.
+--- 							*cpo-D*
+--- 	D	Can't use CTRL-K to enter a digraph after Normal mode
+--- 		commands with a character argument, like `r`, `f` and
+--- 		`t`.
+--- 							*cpo-e*
+--- 	e	When executing a register with ":@r", always add a
+--- 		<CR> to the last line, also when the register is not
+--- 		linewise.  If this flag is not present, the register
+--- 		is not linewise and the last line does not end in a
+--- 		<CR>, then the last line is put on the command-line
+--- 		and can be edited before hitting <CR>.
+--- 							*cpo-E*
+--- 	E	It is an error when using "y", "d", "c", "g~", "gu" or
+--- 		"gU" on an Empty region.  The operators only work when
+--- 		at least one character is to be operated on.  Example:
+--- 		This makes "y0" fail in the first column.
+--- 							*cpo-f*
+--- 	f	When included, a ":read" command with a file name
+--- 		argument will set the file name for the current buffer,
+--- 		if the current buffer doesn't have a file name yet.
+--- 							*cpo-F*
+--- 	F	When included, a ":write" command with a file name
+--- 		argument will set the file name for the current
+--- 		buffer, if the current buffer doesn't have a file name
+--- 		yet.  Also see `cpo-P`.
+--- 							*cpo-i*
+--- 	i	When included, interrupting the reading of a file will
+--- 		leave it modified.
+--- 							*cpo-I*
+--- 	I	When moving the cursor up or down just after inserting
+--- 		indent for 'autoindent', do not delete the indent.
+--- 							*cpo-J*
+--- 	J	A `sentence` has to be followed by two spaces after
+--- 		the '.', '!' or '?'.  A <Tab> is not recognized as
+--- 		white space.
+--- 							*cpo-K*
+--- 	K	Don't wait for a key code to complete when it is
+--- 		halfway through a mapping.  This breaks mapping
+--- 		<F1><F1> when only part of the second <F1> has been
+--- 		read.  It enables cancelling the mapping by typing
+--- 		<F1><Esc>.
+--- 							*cpo-l*
+--- 	l	Backslash in a [] range in a search pattern is taken
+--- 		literally, only "\]", "\^", "\-" and "\\" are special.
+--- 		See `/[]`
+--- 		   'l' included: "/[ \t]"  finds <Space>, '\' and 't'
+--- 		   'l' excluded: "/[ \t]"  finds <Space> and <Tab>
+--- 							*cpo-L*
+--- 	L	When the 'list' option is set, 'wrapmargin',
+--- 		'textwidth', 'softtabstop' and Virtual Replace mode
+--- 		(see `gR`) count a <Tab> as two characters, instead of
+--- 		the normal behavior of a <Tab>.
+--- 							*cpo-m*
+--- 	m	When included, a showmatch will always wait half a
+--- 		second.  When not included, a showmatch will wait half
+--- 		a second or until a character is typed.  `'showmatch'`
+--- 							*cpo-M*
+--- 	M	When excluded, "%" matching will take backslashes into
+--- 		account.  Thus in "( \( )" and "\( ( \)" the outer
+--- 		parenthesis match.  When included "%" ignores
+--- 		backslashes, which is Vi compatible.
+--- 							*cpo-n*
+--- 	n	When included, the column used for 'number' and
+--- 		'relativenumber' will also be used for text of wrapped
+--- 		lines.
+--- 							*cpo-o*
+--- 	o	Line offset to search command is not remembered for
+--- 		next search.
+--- 							*cpo-O*
+--- 	O	Don't complain if a file is being overwritten, even
+--- 		when it didn't exist when editing it.  This is a
+--- 		protection against a file unexpectedly created by
+--- 		someone else.  Vi didn't complain about this.
+--- 							*cpo-p*
+--- 	p	Vi compatible Lisp indenting.  When not present, a
+--- 		slightly better algorithm is used.
+--- 							*cpo-P*
+--- 	P	When included, a ":write" command that appends to a
+--- 		file will set the file name for the current buffer, if
+--- 		the current buffer doesn't have a file name yet and
+--- 		the 'F' flag is also included `cpo-F`.
+--- 							*cpo-q*
+--- 	q	When joining multiple lines leave the cursor at the
+--- 		position where it would be when joining two lines.
+--- 							*cpo-r*
+--- 	r	Redo ("." command) uses "/" to repeat a search
+--- 		command, instead of the actually used search string.
+--- 							*cpo-R*
+--- 	R	Remove marks from filtered lines.  Without this flag
+--- 		marks are kept like `:keepmarks` was used.
+--- 							*cpo-s*
+--- 	s	Set buffer options when entering the buffer for the
+--- 		first time.  This is like it is in Vim version 3.0.
+--- 		And it is the default.  If not present the options are
+--- 		set when the buffer is created.
+--- 							*cpo-S*
+--- 	S	Set buffer options always when entering a buffer
+--- 		(except 'readonly', 'fileformat', 'filetype' and
+--- 		'syntax').  This is the (most) Vi compatible setting.
+--- 		The options are set to the values in the current
+--- 		buffer.  When you change an option and go to another
+--- 		buffer, the value is copied.  Effectively makes the
+--- 		buffer options global to all buffers.
+---
+--- 		's'    'S'     copy buffer options
+--- 		no     no      when buffer created
+--- 		yes    no      when buffer first entered (default)
+--- 		 X     yes     each time when buffer entered (vi comp.)
+--- 							*cpo-t*
+--- 	t	Search pattern for the tag command is remembered for
+--- 		"n" command.  Otherwise Vim only puts the pattern in
+--- 		the history for search pattern, but doesn't change the
+--- 		last used search pattern.
+--- 							*cpo-u*
+--- 	u	Undo is Vi compatible.  See `undo-two-ways`.
+--- 							*cpo-v*
+--- 	v	Backspaced characters remain visible on the screen in
+--- 		Insert mode.  Without this flag the characters are
+--- 		erased from the screen right away.  With this flag the
+--- 		screen newly typed text overwrites backspaced
+--- 		characters.
+--- 							*cpo-W*
+--- 	W	Don't overwrite a readonly file.  When omitted, ":w!"
+--- 		overwrites a readonly file, if possible.
+--- 							*cpo-x*
+--- 	x	<Esc> on the command-line executes the command-line.
+--- 		The default in Vim is to abandon the command-line,
+--- 		because <Esc> normally aborts a command.  `c_<Esc>`
+--- 							*cpo-X*
+--- 	X	When using a count with "R" the replaced text is
+--- 		deleted only once.  Also when repeating "R" with "."
+--- 		and a count.
+--- 							*cpo-y*
+--- 	y	A yank command can be redone with ".".  Think twice if
+--- 		you really want to use this, it may break some
+--- 		plugins, since most people expect "." to only repeat a
+--- 		change.
+--- 							*cpo-Z*
+--- 	Z	When using "w!" while the 'readonly' option is set,
+--- 		don't reset 'readonly'.
+--- 							*cpo-!*
+--- 	!	When redoing a filter command, use the last used
+--- 		external command, whatever it was.  Otherwise the last
+--- 		used -filter- command is used.
+--- 							*cpo-$*
+--- 	$	When making a change to one line, don't redisplay the
+--- 		line, but put a '$' at the end of the changed text.
+--- 		The changed text will be overwritten when you type the
+--- 		new text.  The line is redisplayed if you type any
+--- 		command that moves the cursor from the insertion
+--- 		point.
+--- 							*cpo-%*
+--- 	%	Vi-compatible matching is done for the "%" command.
+--- 		Does not recognize "#if", "#endif", etc.
+--- 		Does not recognize "/*" and "*/".
+--- 		Parens inside single and double quotes are also
+--- 		counted, causing a string that contains a paren to
+--- 		disturb the matching.  For example, in a line like
+--- 		"if (strcmp("foo(", s))" the first paren does not
+--- 		match the last one.  When this flag is not included,
+--- 		parens inside single and double quotes are treated
+--- 		specially.  When matching a paren outside of quotes,
+--- 		everything inside quotes is ignored.  When matching a
+--- 		paren inside quotes, it will find the matching one (if
+--- 		there is one).  This works very well for C programs.
+--- 		This flag is also used for other features, such as
+--- 		C-indenting.
+--- 							*cpo-+*
+--- 	+	When included, a ":write file" command will reset the
+--- 		'modified' flag of the buffer, even though the buffer
+--- 		itself may still be different from its file.
+--- 							*cpo->*
+--- 	>	When appending to a register, put a line break before
+--- 		the appended text.
+--- 							*cpo-;*
+--- 	;	When using `,` or `;` to repeat the last `t` search
+--- 		and the cursor is right in front of the searched
+--- 		character, the cursor won't move. When not included,
+--- 		the cursor would skip over it and jump to the
+--- 		following occurrence.
+--- 							*cpo-_*
+--- 	_	When using `cw` on a word, do not include the
+--- 		whitespace following the word in the motion.
+---
+--- @type string
+vim.o.cpoptions = "aABceFs_"
+vim.o.cpo = vim.o.cpoptions
+vim.go.cpoptions = vim.o.cpoptions
+vim.go.cpo = vim.go.cpoptions
+
+--- When this option is set, as the cursor in the current
+--- window moves other cursorbound windows (windows that also have
+--- this option set) move their cursors to the corresponding line and
+--- column.  This option is useful for viewing the
+--- differences between two versions of a file (see 'diff'); in diff mode,
+--- inserted and deleted lines (though not characters within a line) are
+--- taken into account.
+---
+--- @type boolean
+vim.o.cursorbind = false
+vim.o.crb = vim.o.cursorbind
+vim.wo.cursorbind = vim.o.cursorbind
+vim.wo.crb = vim.wo.cursorbind
+
+--- Highlight the screen column of the cursor with CursorColumn
+--- `hl-CursorColumn`.  Useful to align text.  Will make screen redrawing
+--- slower.
+--- If you only want the highlighting in the current window you can use
+--- these autocommands:
+--- ```
+--- 	au WinLeave * set nocursorline nocursorcolumn
+--- 	au WinEnter * set cursorline cursorcolumn
+--- ```
+---
+--- @type boolean
+vim.o.cursorcolumn = false
+vim.o.cuc = vim.o.cursorcolumn
+vim.wo.cursorcolumn = vim.o.cursorcolumn
+vim.wo.cuc = vim.wo.cursorcolumn
+
+--- Highlight the text line of the cursor with CursorLine `hl-CursorLine`.
+--- Useful to easily spot the cursor.  Will make screen redrawing slower.
+--- When Visual mode is active the highlighting isn't used to make it
+--- easier to see the selected text.
+---
+--- @type boolean
+vim.o.cursorline = false
+vim.o.cul = vim.o.cursorline
+vim.wo.cursorline = vim.o.cursorline
+vim.wo.cul = vim.wo.cursorline
+
+--- Comma-separated list of settings for how 'cursorline' is displayed.
+--- Valid values:
+--- "line"		Highlight the text line of the cursor with
+--- 		CursorLine `hl-CursorLine`.
+--- "screenline"	Highlight only the screen line of the cursor with
+--- 		CursorLine `hl-CursorLine`.
+--- "number"	Highlight the line number of the cursor with
+--- 		CursorLineNr `hl-CursorLineNr`.
+---
+--- Special value:
+--- "both"		Alias for the values "line,number".
+---
+--- "line" and "screenline" cannot be used together.
+---
+--- @type string
+vim.o.cursorlineopt = "both"
+vim.o.culopt = vim.o.cursorlineopt
+vim.wo.cursorlineopt = vim.o.cursorlineopt
+vim.wo.culopt = vim.wo.cursorlineopt
+
+--- These values can be used:
+--- msg	Error messages that would otherwise be omitted will be given
+--- 	anyway.
+--- throw	Error messages that would otherwise be omitted will be given
+--- 	anyway and also throw an exception and set `v:errmsg`.
+--- beep	A message will be given when otherwise only a beep would be
+--- 	produced.
+--- The values can be combined, separated by a comma.
+--- "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
+--- 'indentexpr'.
+---
+--- @type string
+vim.o.debug = ""
+vim.go.debug = vim.o.debug
+
+--- Pattern to be used to find a macro definition.  It is a search
+--- pattern, just like for the "/" command.  This option is used for the
+--- commands like "[i" and "[d" `include-search`.  The 'isident' option is
+--- used to recognize the defined name after the match:
+--- ```
+--- 	{match with 'define'}{non-ID chars}{defined name}{non-ID char}
+--- ```
+--- See `option-backslash` about inserting backslashes to include a space
+--- or backslash.
+--- For C++ this value would be useful, to include const type declarations:
+--- ```
+--- 	^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
+--- ```
+--- You can also use "\ze" just before the name and continue the pattern
+--- to check what is following.  E.g. for Javascript, if a function is
+--- defined with `func_name = function(args)`:
+--- ```
+--- 	^\s*\ze\i\+\s*=\s*function(
+--- ```
+--- If the function is defined with `func_name : function() {...`:
+--- ```
+---         ^\s*\ze\i\+\s*[:]\s*(*function\s*(
+--- ```
+--- When using the ":set" command, you need to double the backslashes!
+--- To avoid that use `:let` with a single quote string:
+--- ```
+--- 	let &l:define = '^\s*\ze\k\+\s*=\s*function('
+--- ```
+---
+--- @type string
+vim.o.define = ""
+vim.o.def = vim.o.define
+vim.bo.define = vim.o.define
+vim.bo.def = vim.bo.define
+vim.go.define = vim.o.define
+vim.go.def = vim.go.define
+
+--- If editing Unicode and this option is set, backspace and Normal mode
+--- "x" delete each combining character on its own.  When it is off (the
+--- default) the character along with its combining characters are
+--- deleted.
+--- Note: When 'delcombine' is set "xx" may work differently from "2x"!
+---
+--- This is useful for Arabic, Hebrew and many other languages where one
+--- may have combining characters overtop of base characters, and want
+--- to remove only the combining ones.
+---
+--- @type boolean
+vim.o.delcombine = false
+vim.o.deco = vim.o.delcombine
+vim.go.delcombine = vim.o.delcombine
+vim.go.deco = vim.go.delcombine
+
+--- List of file names, separated by commas, that are used to lookup words
+--- for keyword completion commands `i_CTRL-X_CTRL-K`.  Each file should
+--- contain a list of words.  This can be one word per line, or several
+--- words per line, separated by non-keyword characters (white space is
+--- preferred).  Maximum line length is 510 bytes.
+---
+--- When this option is empty or an entry "spell" is present, and spell
+--- checking is enabled, words in the word lists for the currently active
+--- 'spelllang' are used. See `spell`.
+---
+--- To include a comma in a file name precede it with a backslash.  Spaces
+--- after a comma are ignored, otherwise spaces are included in the file
+--- name.  See `option-backslash` about using backslashes.
+--- This has nothing to do with the `Dictionary` variable type.
+--- Where to find a list of words?
+--- - BSD/macOS include the "/usr/share/dict/words" file.
+--- - Try "apt install spell" to get the "/usr/share/dict/words" file on
+---   apt-managed systems (Debian/Ubuntu).
+--- The use of `:set+=` and `:set-=` is preferred when adding or removing
+--- directories from the list.  This avoids problems when a future version
+--- uses another default.
+--- Backticks cannot be used in this option for security reasons.
+---
+--- @type string
+vim.o.dictionary = ""
+vim.o.dict = vim.o.dictionary
+vim.bo.dictionary = vim.o.dictionary
+vim.bo.dict = vim.bo.dictionary
+vim.go.dictionary = vim.o.dictionary
+vim.go.dict = vim.go.dictionary
+
+--- Join the current window in the group of windows that shows differences
+--- between files.  See `diff-mode`.
+---
+--- @type boolean
+vim.o.diff = false
+vim.wo.diff = vim.o.diff
+
+--- Expression which is evaluated to obtain a diff file (either ed-style
+--- or unified-style) from two versions of a file.  See `diff-diffexpr`.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.diffexpr = ""
+vim.o.dex = vim.o.diffexpr
+vim.go.diffexpr = vim.o.diffexpr
+vim.go.dex = vim.go.diffexpr
+
+--- Option settings for diff mode.  It can consist of the following items.
+--- All are optional.  Items must be separated by a comma.
+---
+--- 	filler		Show filler lines, to keep the text
+--- 			synchronized with a window that has inserted
+--- 			lines at the same position.  Mostly useful
+--- 			when windows are side-by-side and 'scrollbind'
+--- 			is set.
+---
+--- 	context:{n}	Use a context of {n} lines between a change
+--- 			and a fold that contains unchanged lines.
+--- 			When omitted a context of six lines is used.
+--- 			When using zero the context is actually one,
+--- 			since folds require a line in between, also
+--- 			for a deleted line.
+--- 			See `fold-diff`.
+---
+--- 	iblank		Ignore changes where lines are all blank.  Adds
+--- 			the "-B" flag to the "diff" command if
+--- 			'diffexpr' is empty.  Check the documentation
+--- 			of the "diff" command for what this does
+--- 			exactly.
+--- 			NOTE: the diff windows will get out of sync,
+--- 			because no differences between blank lines are
+--- 			taken into account.
+---
+--- 	icase		Ignore changes in case of text.  "a" and "A"
+--- 			are considered the same.  Adds the "-i" flag
+--- 			to the "diff" command if 'diffexpr' is empty.
+---
+--- 	iwhite		Ignore changes in amount of white space.  Adds
+--- 			the "-b" flag to the "diff" command if
+--- 			'diffexpr' is empty.  Check the documentation
+--- 			of the "diff" command for what this does
+--- 			exactly.  It should ignore adding trailing
+--- 			white space, but not leading white space.
+---
+--- 	iwhiteall	Ignore all white space changes.  Adds
+--- 			the "-w" flag to the "diff" command if
+--- 			'diffexpr' is empty.  Check the documentation
+--- 			of the "diff" command for what this does
+--- 			exactly.
+---
+--- 	iwhiteeol	Ignore white space changes at end of line.
+--- 			Adds the "-Z" flag to the "diff" command if
+--- 			'diffexpr' is empty.  Check the documentation
+--- 			of the "diff" command for what this does
+--- 			exactly.
+---
+--- 	horizontal	Start diff mode with horizontal splits (unless
+--- 			explicitly specified otherwise).
+---
+--- 	vertical	Start diff mode with vertical splits (unless
+--- 			explicitly specified otherwise).
+---
+--- 	closeoff	When a window is closed where 'diff' is set
+--- 			and there is only one window remaining in the
+--- 			same tab page with 'diff' set, execute
+--- 			`:diffoff` in that window.  This undoes a
+--- 			`:diffsplit` command.
+---
+--- 	hiddenoff	Do not use diff mode for a buffer when it
+--- 			becomes hidden.
+---
+--- 	foldcolumn:{n}	Set the 'foldcolumn' option to {n} when
+--- 			starting diff mode.  Without this 2 is used.
+---
+--- 	followwrap	Follow the 'wrap' option and leave as it is.
+---
+--- 	internal	Use the internal diff library.  This is
+--- 			ignored when 'diffexpr' is set.  *E960*
+--- 			When running out of memory when writing a
+--- 			buffer this item will be ignored for diffs
+--- 			involving that buffer.  Set the 'verbose'
+--- 			option to see when this happens.
+---
+--- 	indent-heuristic
+--- 			Use the indent heuristic for the internal
+--- 			diff library.
+---
+--- 	linematch:{n}   Enable a second stage diff on each generated
+--- 			hunk in order to align lines. When the total
+--- 			number of lines in a hunk exceeds {n}, the
+--- 			second stage diff will not be performed as
+--- 			very large hunks can cause noticeable lag. A
+--- 			recommended setting is "linematch:60", as this
+--- 			will enable alignment for a 2 buffer diff with
+--- 			hunks of up to 30 lines each, or a 3 buffer
+--- 			diff with hunks of up to 20 lines each.
+---
+--- 	algorithm:{text} Use the specified diff algorithm with the
+--- 			internal diff engine. Currently supported
+--- 			algorithms are:
+--- 			myers      the default algorithm
+--- 			minimal    spend extra time to generate the
+--- 				   smallest possible diff
+--- 			patience   patience diff algorithm
+--- 			histogram  histogram diff algorithm
+---
+--- Examples:
+--- ```
+--- 	:set diffopt=internal,filler,context:4
+--- 	:set diffopt=
+--- 	:set diffopt=internal,filler,foldcolumn:3
+--- 	:set diffopt-=internal  " do NOT use the internal diff parser
+--- ```
+---
+--- @type string
+vim.o.diffopt = "internal,filler,closeoff"
+vim.o.dip = vim.o.diffopt
+vim.go.diffopt = vim.o.diffopt
+vim.go.dip = vim.go.diffopt
+
+--- Enable the entering of digraphs in Insert mode with {char1} <BS>
+--- {char2}.  See `digraphs`.
+---
+--- @type boolean
+vim.o.digraph = false
+vim.o.dg = vim.o.digraph
+vim.go.digraph = vim.o.digraph
+vim.go.dg = vim.go.digraph
+
+--- List of directory names for the swap file, separated with commas.
+---
+--- Possible items:
+--- - The swap file will be created in the first directory where this is
+---   possible.  If it is not possible in any directory, but last
+---   directory listed in the option does not exist, it is created.
+--- - Empty means that no swap file will be used (recovery is
+---   impossible!) and no `E303` error will be given.
+--- - A directory "." means to put the swap file in the same directory as
+---   the edited file.  On Unix, a dot is prepended to the file name, so
+---   it doesn't show in a directory listing.  On MS-Windows the "hidden"
+---   attribute is set and a dot prepended if possible.
+--- - A directory starting with "./" (or ".\" for MS-Windows) means to put
+---   the swap file relative to where the edited file is.  The leading "."
+---   is replaced with the path name of the edited file.
+--- - For Unix and Win32, if a directory ends in two path separators "//",
+---   the swap file name will be built from the complete path to the file
+---   with all path separators replaced by percent '%' signs (including
+---   the colon following the drive letter on Win32). This will ensure
+---   file name uniqueness in the preserve directory.
+---   On Win32, it is also possible to end with "\\".  However, When a
+---   separating comma is following, you must use "//", since "\\" will
+---   include the comma in the file name. Therefore it is recommended to
+---   use '//', instead of '\\'.
+--- - Spaces after the comma are ignored, other spaces are considered part
+---   of the directory name.  To have a space at the start of a directory
+---   name, precede it with a backslash.
+--- - To include a comma in a directory name precede it with a backslash.
+--- - A directory name may end in an ':' or '/'.
+--- - Environment variables are expanded `:set_env`.
+--- - Careful with '\' characters, type one before a space, type two to
+---   get one in the option (see `option-backslash`), for example:
+--- ```
+---     :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
+--- ```
+--- Editing the same file twice will result in a warning.  Using "/tmp" on
+--- is discouraged: if the system crashes you lose the swap file. And
+--- others on the computer may be able to see the files.
+--- Use `:set+=` and `:set-=` when adding or removing directories from the
+--- list, this avoids problems if the Nvim default is changed.
+---
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.directory = "$XDG_STATE_HOME/nvim/swap//"
+vim.o.dir = vim.o.directory
+vim.go.directory = vim.o.directory
+vim.go.dir = vim.go.directory
+
+--- Change the way text is displayed.  This is a comma-separated list of
+--- flags:
+--- lastline	When included, as much as possible of the last line
+--- 		in a window will be displayed.  "@@@" is put in the
+--- 		last columns of the last screen line to indicate the
+--- 		rest of the line is not displayed.
+--- truncate	Like "lastline", but "@@@" is displayed in the first
+--- 		column of the last screen line.  Overrules "lastline".
+--- uhex		Show unprintable characters hexadecimal as <xx>
+--- 		instead of using ^C and ~C.
+--- msgsep		Obsolete flag. Allowed but takes no effect. `msgsep`
+---
+--- When neither "lastline" nor "truncate" is included, a last line that
+--- doesn't fit is replaced with "@" lines.
+---
+--- The "@" character can be changed by setting the "lastline" item in
+--- 'fillchars'.  The character is highlighted with `hl-NonText`.
+---
+--- @type string
+vim.o.display = "lastline"
+vim.o.dy = vim.o.display
+vim.go.display = vim.o.display
+vim.go.dy = vim.go.display
+
+--- Tells when the 'equalalways' option applies:
+--- 	ver	vertically, width of windows is not affected
+--- 	hor	horizontally, height of windows is not affected
+--- 	both	width and height of windows is affected
+---
+--- @type string
+vim.o.eadirection = "both"
+vim.o.ead = vim.o.eadirection
+vim.go.eadirection = vim.o.eadirection
+vim.go.ead = vim.go.eadirection
+
+--- When on all Unicode emoji characters are considered to be full width.
+--- This excludes "text emoji" characters, which are normally displayed as
+--- single width.  Unfortunately there is no good specification for this
+--- and it has been determined on trial-and-error basis.  Use the
+--- `setcellwidths()` function to change the behavior.
+---
+--- @type boolean
+vim.o.emoji = true
+vim.o.emo = vim.o.emoji
+vim.go.emoji = vim.o.emoji
+vim.go.emo = vim.go.emoji
+
+--- String-encoding used internally and for `RPC` communication.
+--- Always UTF-8.
+---
+--- See 'fileencoding' to control file-content encoding.
+---
+--- @type string
+vim.o.encoding = "utf-8"
+vim.o.enc = vim.o.encoding
+vim.go.encoding = vim.o.encoding
+vim.go.enc = vim.go.encoding
+
+--- Indicates that a CTRL-Z character was found at the end of the file
+--- when reading it.  Normally only happens when 'fileformat' is "dos".
+--- When writing a file and this option is off and the 'binary' option
+--- is on, or 'fixeol' option is off, no CTRL-Z will be written at the
+--- end of the file.
+--- See `eol-and-eof` for example settings.
+---
+--- @type boolean
+vim.o.endoffile = false
+vim.o.eof = vim.o.endoffile
+vim.bo.endoffile = vim.o.endoffile
+vim.bo.eof = vim.bo.endoffile
+
+--- When writing a file and this option is off and the 'binary' option
+--- is on, or 'fixeol' option is off, no <EOL> will be written for the
+--- last line in the file.  This option is automatically set or reset when
+--- starting to edit a new file, depending on whether file has an <EOL>
+--- for the last line in the file.  Normally you don't have to set or
+--- reset this option.
+--- When 'binary' is off and 'fixeol' is on the value is not used when
+--- writing the file.  When 'binary' is on or 'fixeol' is off it is used
+--- to remember the presence of a <EOL> for the last line in the file, so
+--- that when you write the file the situation from the original file can
+--- be kept.  But you can change it if you want to.
+--- See `eol-and-eof` for example settings.
+---
+--- @type boolean
+vim.o.endofline = true
+vim.o.eol = vim.o.endofline
+vim.bo.endofline = vim.o.endofline
+vim.bo.eol = vim.bo.endofline
+
+--- When on, all the windows are automatically made the same size after
+--- splitting or closing a window.  This also happens the moment the
+--- option is switched on.  When off, splitting a window will reduce the
+--- size of the current window and leave the other windows the same.  When
+--- closing a window the extra lines are given to the window next to it
+--- (depending on 'splitbelow' and 'splitright').
+--- When mixing vertically and horizontally split windows, a minimal size
+--- is computed and some windows may be larger if there is room.  The
+--- 'eadirection' option tells in which direction the size is affected.
+--- Changing the height and width of a window can be avoided by setting
+--- 'winfixheight' and 'winfixwidth', respectively.
+--- If a window size is specified when creating a new window sizes are
+--- currently not equalized (it's complicated, but may be implemented in
+--- the future).
+---
+--- @type boolean
+vim.o.equalalways = true
+vim.o.ea = vim.o.equalalways
+vim.go.equalalways = vim.o.equalalways
+vim.go.ea = vim.go.equalalways
+
+--- External program to use for "=" command.  When this option is empty
+--- the internal formatting functions are used; either 'lisp', 'cindent'
+--- or 'indentexpr'.
+--- Environment variables are expanded `:set_env`.  See `option-backslash`
+--- about including spaces and backslashes.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.equalprg = ""
+vim.o.ep = vim.o.equalprg
+vim.bo.equalprg = vim.o.equalprg
+vim.bo.ep = vim.bo.equalprg
+vim.go.equalprg = vim.o.equalprg
+vim.go.ep = vim.go.equalprg
+
+--- Ring the bell (beep or screen flash) for error messages.  This only
+--- makes a difference for error messages, the bell will be used always
+--- for a lot of errors without a message (e.g., hitting <Esc> in Normal
+--- mode).  See 'visualbell' to make the bell behave like a screen flash
+--- or do nothing. See 'belloff' to finetune when to ring the bell.
+---
+--- @type boolean
+vim.o.errorbells = false
+vim.o.eb = vim.o.errorbells
+vim.go.errorbells = vim.o.errorbells
+vim.go.eb = vim.go.errorbells
+
+--- Name of the errorfile for the QuickFix mode (see `:cf`).
+--- When the "-q" command-line argument is used, 'errorfile' is set to the
+--- following argument.  See `-q`.
+--- NOT used for the ":make" command.  See 'makeef' for that.
+--- Environment variables are expanded `:set_env`.
+--- See `option-backslash` about including spaces and backslashes.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.errorfile = "errors.err"
+vim.o.ef = vim.o.errorfile
+vim.go.errorfile = vim.o.errorfile
+vim.go.ef = vim.go.errorfile
+
+--- Scanf-like description of the format for the lines in the error file
+--- (see `errorformat`).
+---
+--- @type string
+vim.o.errorformat = "%*[^\"]\"%f\"%*\\D%l: %m,\"%f\"%*\\D%l: %m,%-Gg%\\?make[%*\\d]: *** [%f:%l:%m,%-Gg%\\?make: *** [%f:%l:%m,%-G%f:%l: (Each undeclared identifier is reported only once,%-G%f:%l: for each function it appears in.),%-GIn file included from %f:%l:%c:,%-GIn file included from %f:%l:%c\\,,%-GIn file included from %f:%l:%c,%-GIn file included from %f:%l,%-G%*[ ]from %f:%l:%c,%-G%*[ ]from %f:%l:,%-G%*[ ]from %f:%l\\,,%-G%*[ ]from %f:%l,%f:%l:%c:%m,%f(%l):%m,%f:%l:%m,\"%f\"\\, line %l%*\\D%c%*[^ ] %m,%D%*\\a[%*\\d]: Entering directory %*[`']%f',%X%*\\a[%*\\d]: Leaving directory %*[`']%f',%D%*\\a: Entering directory %*[`']%f',%X%*\\a: Leaving directory %*[`']%f',%DMaking %*\\a in %f,%f|%l| %m"
+vim.o.efm = vim.o.errorformat
+vim.bo.errorformat = vim.o.errorformat
+vim.bo.efm = vim.bo.errorformat
+vim.go.errorformat = vim.o.errorformat
+vim.go.efm = vim.go.errorformat
+
+--- A list of autocommand event names, which are to be ignored.
+--- When set to "all" or when "all" is one of the items, all autocommand
+--- events are ignored, autocommands will not be executed.
+--- Otherwise this is a comma-separated list of event names.  Example:
+--- ```
+---     :set ei=WinEnter,WinLeave
+--- ```
+---
+--- @type string
+vim.o.eventignore = ""
+vim.o.ei = vim.o.eventignore
+vim.go.eventignore = vim.o.eventignore
+vim.go.ei = vim.go.eventignore
+
+--- In Insert mode: Use the appropriate number of spaces to insert a
+--- <Tab>.  Spaces are used in indents with the '>' and '<' commands and
+--- when 'autoindent' is on.  To insert a real tab when 'expandtab' is
+--- on, use CTRL-V<Tab>.  See also `:retab` and `ins-expandtab`.
+---
+--- @type boolean
+vim.o.expandtab = false
+vim.o.et = vim.o.expandtab
+vim.bo.expandtab = vim.o.expandtab
+vim.bo.et = vim.bo.expandtab
+
+--- Automatically execute .nvim.lua, .nvimrc, and .exrc files in the
+--- current directory, if the file is in the `trust` list. Use `:trust` to
+--- manage trusted files. See also `vim.secure.read()`.
+---
+--- Compare 'exrc' to `editorconfig`:
+--- - 'exrc' can execute any code; editorconfig only specifies settings.
+--- - 'exrc' is Nvim-specific; editorconfig works in other editors.
+---
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type boolean
+vim.o.exrc = false
+vim.o.ex = vim.o.exrc
+vim.go.exrc = vim.o.exrc
+vim.go.ex = vim.go.exrc
+
+--- File-content encoding for the current buffer. Conversion is done with
+--- iconv() or as specified with 'charconvert'.
+---
+--- When 'fileencoding' is not UTF-8, conversion will be done when
+--- writing the file.  For reading see below.
+--- When 'fileencoding' is empty, the file will be saved with UTF-8
+--- encoding (no conversion when reading or writing a file).
+---
+--- WARNING: Conversion to a non-Unicode encoding can cause loss of
+--- information!
+---
+--- See `encoding-names` for the possible values.  Additionally, values may be
+--- specified that can be handled by the converter, see
+--- `mbyte-conversion`.
+---
+--- When reading a file 'fileencoding' will be set from 'fileencodings'.
+--- To read a file in a certain encoding it won't work by setting
+--- 'fileencoding', use the `++enc` argument.  One exception: when
+--- 'fileencodings' is empty the value of 'fileencoding' is used.
+--- For a new file the global value of 'fileencoding' is used.
+---
+--- Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
+--- When the option is set, the value is converted to lowercase.  Thus
+--- you can set it with uppercase values too.  '_' characters are
+--- replaced with '-'.  If a name is recognized from the list at
+--- `encoding-names`, it is replaced by the standard name.  For example
+--- "ISO8859-2" becomes "iso-8859-2".
+---
+--- When this option is set, after starting to edit a file, the 'modified'
+--- option is set, because the file would be different when written.
+---
+--- Keep in mind that changing 'fenc' from a modeline happens
+--- AFTER the text has been read, thus it applies to when the file will be
+--- written.  If you do set 'fenc' in a modeline, you might want to set
+--- 'nomodified' to avoid not being able to ":q".
+---
+--- This option cannot be changed when 'modifiable' is off.
+---
+--- @type string
+vim.o.fileencoding = ""
+vim.o.fenc = vim.o.fileencoding
+vim.bo.fileencoding = vim.o.fileencoding
+vim.bo.fenc = vim.bo.fileencoding
+
+--- This is a list of character encodings considered when starting to edit
+--- an existing file.  When a file is read, Vim tries to use the first
+--- mentioned character encoding.  If an error is detected, the next one
+--- in the list is tried.  When an encoding is found that works,
+--- 'fileencoding' is set to it.  If all fail, 'fileencoding' is set to
+--- an empty string, which means that UTF-8 is used.
+--- 	WARNING: Conversion can cause loss of information! You can use
+--- 	the `++bad` argument to specify what is done with characters
+--- 	that can't be converted.
+--- For an empty file or a file with only ASCII characters most encodings
+--- will work and the first entry of 'fileencodings' will be used (except
+--- "ucs-bom", which requires the BOM to be present).  If you prefer
+--- another encoding use an BufReadPost autocommand event to test if your
+--- preferred encoding is to be used.  Example:
+--- ```
+--- 	au BufReadPost * if search('\S', 'w') == 0 |
+--- 		\ set fenc=iso-2022-jp | endif
+--- ```
+--- This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
+--- non-blank characters.
+--- When the `++enc` argument is used then the value of 'fileencodings' is
+--- not used.
+--- Note that 'fileencodings' is not used for a new file, the global value
+--- of 'fileencoding' is used instead.  You can set it with:
+--- ```
+--- 	:setglobal fenc=iso-8859-2
+--- ```
+--- This means that a non-existing file may get a different encoding than
+--- an empty file.
+--- The special value "ucs-bom" can be used to check for a Unicode BOM
+--- (Byte Order Mark) at the start of the file.  It must not be preceded
+--- by "utf-8" or another Unicode encoding for this to work properly.
+--- An entry for an 8-bit encoding (e.g., "latin1") should be the last,
+--- because Vim cannot detect an error, thus the encoding is always
+--- accepted.
+--- The special value "default" can be used for the encoding from the
+--- environment.  It is useful when your environment uses a non-latin1
+--- encoding, such as Russian.
+--- When a file contains an illegal UTF-8 byte sequence it won't be
+--- recognized as "utf-8".  You can use the `8g8` command to find the
+--- illegal byte sequence.
+--- WRONG VALUES:			WHAT'S WRONG:
+--- 	latin1,utf-8		"latin1" will always be used
+--- 	utf-8,ucs-bom,latin1	BOM won't be recognized in an utf-8
+--- 				file
+--- 	cp1250,latin1		"cp1250" will always be used
+--- If 'fileencodings' is empty, 'fileencoding' is not modified.
+--- See 'fileencoding' for the possible values.
+--- Setting this option does not have an effect until the next time a file
+--- is read.
+---
+--- @type string
+vim.o.fileencodings = "ucs-bom,utf-8,default,latin1"
+vim.o.fencs = vim.o.fileencodings
+vim.go.fileencodings = vim.o.fileencodings
+vim.go.fencs = vim.go.fileencodings
+
+--- This gives the <EOL> of the current buffer, which is used for
+--- reading/writing the buffer from/to a file:
+---     dos	    <CR><NL>
+---     unix    <NL>
+---     mac	    <CR>
+--- When "dos" is used, CTRL-Z at the end of a file is ignored.
+--- See `file-formats` and `file-read`.
+--- For the character encoding of the file see 'fileencoding'.
+--- When 'binary' is set, the value of 'fileformat' is ignored, file I/O
+--- works like it was set to "unix".
+--- This option is set automatically when starting to edit a file and
+--- 'fileformats' is not empty and 'binary' is off.
+--- When this option is set, after starting to edit a file, the 'modified'
+--- option is set, because the file would be different when written.
+--- This option cannot be changed when 'modifiable' is off.
+---
+--- @type string
+vim.o.fileformat = "unix"
+vim.o.ff = vim.o.fileformat
+vim.bo.fileformat = vim.o.fileformat
+vim.bo.ff = vim.bo.fileformat
+
+--- This gives the end-of-line (<EOL>) formats that will be tried when
+--- starting to edit a new buffer and when reading a file into an existing
+--- buffer:
+--- - When empty, the format defined with 'fileformat' will be used
+---   always.  It is not set automatically.
+--- - When set to one name, that format will be used whenever a new buffer
+---   is opened.  'fileformat' is set accordingly for that buffer.  The
+---   'fileformats' name will be used when a file is read into an existing
+---   buffer, no matter what 'fileformat' for that buffer is set to.
+--- - When more than one name is present, separated by commas, automatic
+---   <EOL> detection will be done when reading a file.  When starting to
+---   edit a file, a check is done for the <EOL>:
+---   1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
+---      'fileformat' is set to "dos".
+---   2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
+---      is set to "unix".  Note that when a <NL> is found without a
+---      preceding <CR>, "unix" is preferred over "dos".
+---   3. If 'fileformat' has not yet been set, and if a <CR> is found, and
+---      if 'fileformats' includes "mac", 'fileformat' is set to "mac".
+---      This means that "mac" is only chosen when:
+---       "unix" is not present or no <NL> is found in the file, and
+---       "dos" is not present or no <CR><NL> is found in the file.
+---      Except: if "unix" was chosen, but there is a <CR> before
+---      the first <NL>, and there appear to be more <CR>s than <NL>s in
+---      the first few lines, "mac" is used.
+---   4. If 'fileformat' is still not set, the first name from
+---      'fileformats' is used.
+---   When reading a file into an existing buffer, the same is done, but
+---   this happens like 'fileformat' has been set appropriately for that
+---   file only, the option is not changed.
+--- When 'binary' is set, the value of 'fileformats' is not used.
+---
+--- When Vim starts up with an empty buffer the first item is used.  You
+--- can overrule this by setting 'fileformat' in your .vimrc.
+---
+--- For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
+--- are ":source"ed and for vimrc files, automatic <EOL> detection may be
+--- done:
+--- - When 'fileformats' is empty, there is no automatic detection.  Dos
+---   format will be used.
+--- - When 'fileformats' is set to one or more names, automatic detection
+---   is done.  This is based on the first <NL> in the file: If there is a
+---   <CR> in front of it, Dos format is used, otherwise Unix format is
+---   used.
+--- Also see `file-formats`.
+---
+--- @type string
+vim.o.fileformats = "unix,dos"
+vim.o.ffs = vim.o.fileformats
+vim.go.fileformats = vim.o.fileformats
+vim.go.ffs = vim.go.fileformats
+
+--- When set case is ignored when using file names and directories.
+--- See 'wildignorecase' for only ignoring case when doing completion.
+---
+--- @type boolean
+vim.o.fileignorecase = false
+vim.o.fic = vim.o.fileignorecase
+vim.go.fileignorecase = vim.o.fileignorecase
+vim.go.fic = vim.go.fileignorecase
+
+--- When this option is set, the FileType autocommand event is triggered.
+--- All autocommands that match with the value of this option will be
+--- executed.  Thus the value of 'filetype' is used in place of the file
+--- name.
+--- Otherwise this option does not always reflect the current file type.
+--- This option is normally set when the file type is detected.  To enable
+--- this use the ":filetype on" command. `:filetype`
+--- Setting this option to a different value is most useful in a modeline,
+--- for a file for which the file type is not automatically recognized.
+--- Example, for in an IDL file:
+--- ```
+--- 	/* vim: set filetype=idl : */
+--- ```
+--- `FileType` `filetypes`
+--- When a dot appears in the value then this separates two filetype
+--- names.  Example:
+--- ```
+--- 	/* vim: set filetype=c.doxygen : */
+--- ```
+--- This will use the "c" filetype first, then the "doxygen" filetype.
+--- This works both for filetype plugins and for syntax files.  More than
+--- one dot may appear.
+--- This option is not copied to another buffer, independent of the 's' or
+--- 'S' flag in 'cpoptions'.
+--- Only normal file name characters can be used, `/\*?[|<>` are illegal.
+---
+--- @type string
+vim.o.filetype = ""
+vim.o.ft = vim.o.filetype
+vim.bo.filetype = vim.o.filetype
+vim.bo.ft = vim.bo.filetype
+
+--- Characters to fill the statuslines, vertical separators and special
+--- lines in the window.
+--- It is a comma-separated list of items.  Each item has a name, a colon
+--- and the value of that item:
+---
+---   item		default		Used for ~
+---   stl		' ' or '^'	statusline of the current window
+---   stlnc		' ' or '='	statusline of the non-current windows
+---   wbr		' '		window bar
+---   horiz		'─' or '-'	horizontal separators `:split`
+---   horizup	'┴' or '-'	upwards facing horizontal separator
+---   horizdown	'┬' or '-'	downwards facing horizontal separator
+---   vert		'│' or '|'	vertical separators `:vsplit`
+---   vertleft	'┤' or '|'	left facing vertical separator
+---   vertright	'├' or '|'	right facing vertical separator
+---   verthoriz	'┼' or '+'	overlapping vertical and horizontal
+--- 				separator
+---   fold		'·' or '-'	filling 'foldtext'
+---   foldopen	'-'		mark the beginning of a fold
+---   foldclose	'+'		show a closed fold
+---   foldsep	'│' or '|'      open fold middle marker
+---   diff		'-'		deleted lines of the 'diff' option
+---   msgsep	' '		message separator 'display'
+---   eob		'~'		empty lines at the end of a buffer
+---   lastline	'@'		'display' contains lastline/truncate
+---
+--- Any one that is omitted will fall back to the default.  For "stl" and
+--- "stlnc" the space will be used when there is highlighting, '^' or '='
+--- otherwise.
+---
+--- Note that "horiz", "horizup", "horizdown", "vertleft", "vertright" and
+--- "verthoriz" are only used when 'laststatus' is 3, since only vertical
+--- window separators are used otherwise.
+---
+--- If 'ambiwidth' is "double" then "horiz", "horizup", "horizdown",
+--- "vert", "vertleft", "vertright", "verthoriz", "foldsep" and "fold"
+--- default to single-byte alternatives.
+---
+--- Example:
+--- ```
+---     :set fillchars=stl:^,stlnc:=,vert:│,fold:·,diff:-
+--- ```
+--- This is similar to the default, except that these characters will also
+--- be used when there is highlighting.
+---
+--- For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
+--- single-byte and multibyte characters are supported.  But double-width
+--- characters are not supported.
+---
+--- The highlighting used for these items:
+---   item		highlight group ~
+---   stl		StatusLine		`hl-StatusLine`
+---   stlnc		StatusLineNC		`hl-StatusLineNC`
+---   wbr		WinBar			`hl-WinBar` or `hl-WinBarNC`
+---   horiz		WinSeparator		`hl-WinSeparator`
+---   horizup	WinSeparator		`hl-WinSeparator`
+---   horizdown	WinSeparator		`hl-WinSeparator`
+---   vert		WinSeparator		`hl-WinSeparator`
+---   vertleft	WinSeparator		`hl-WinSeparator`
+---   vertright	WinSeparator		`hl-WinSeparator`
+---   verthoriz	WinSeparator		`hl-WinSeparator`
+---   fold		Folded			`hl-Folded`
+---   diff		DiffDelete		`hl-DiffDelete`
+---   eob		EndOfBuffer		`hl-EndOfBuffer`
+---   lastline	NonText			`hl-NonText`
+---
+--- @type string
+vim.o.fillchars = ""
+vim.o.fcs = vim.o.fillchars
+vim.wo.fillchars = vim.o.fillchars
+vim.wo.fcs = vim.wo.fillchars
+vim.go.fillchars = vim.o.fillchars
+vim.go.fcs = vim.go.fillchars
+
+--- When writing a file and this option is on, <EOL> at the end of file
+--- will be restored if missing.  Turn this option off if you want to
+--- preserve the situation from the original file.
+--- When the 'binary' option is set the value of this option doesn't
+--- matter.
+--- See the 'endofline' option.
+--- See `eol-and-eof` for example settings.
+---
+--- @type boolean
+vim.o.fixendofline = true
+vim.o.fixeol = vim.o.fixendofline
+vim.bo.fixendofline = vim.o.fixendofline
+vim.bo.fixeol = vim.bo.fixendofline
+
+--- When set to "all", a fold is closed when the cursor isn't in it and
+--- its level is higher than 'foldlevel'.  Useful if you want folds to
+--- automatically close when moving out of them.
+---
+--- @type string
+vim.o.foldclose = ""
+vim.o.fcl = vim.o.foldclose
+vim.go.foldclose = vim.o.foldclose
+vim.go.fcl = vim.go.foldclose
+
+--- When and how to draw the foldcolumn. Valid values are:
+---     "auto":       resize to the minimum amount of folds to display.
+---     "auto:[1-9]": resize to accommodate multiple folds up to the
+--- 		  selected level
+---     0:            to disable foldcolumn
+---     "[1-9]":      to display a fixed number of columns
+--- See `folding`.
+---
+--- @type string
+vim.o.foldcolumn = "0"
+vim.o.fdc = vim.o.foldcolumn
+vim.wo.foldcolumn = vim.o.foldcolumn
+vim.wo.fdc = vim.wo.foldcolumn
+
+--- When off, all folds are open.  This option can be used to quickly
+--- switch between showing all text unfolded and viewing the text with
+--- folds (including manually opened or closed folds).  It can be toggled
+--- with the `zi` command.  The 'foldcolumn' will remain blank when
+--- 'foldenable' is off.
+--- This option is set by commands that create a new fold or close a fold.
+--- See `folding`.
+---
+--- @type boolean
+vim.o.foldenable = true
+vim.o.fen = vim.o.foldenable
+vim.wo.foldenable = vim.o.foldenable
+vim.wo.fen = vim.wo.foldenable
+
+--- The expression used for when 'foldmethod' is "expr".  It is evaluated
+--- for each line to obtain its fold level.  The context is set to the
+--- script where 'foldexpr' was set, script-local items can be accessed.
+--- See `fold-expr` for the usage.
+---
+--- The expression will be evaluated in the `sandbox` if set from a
+--- modeline, see `sandbox-option`.
+--- This option can't be set from a `modeline` when the 'diff' option is
+--- on or the 'modelineexpr' option is off.
+---
+--- It is not allowed to change text or jump to another window while
+--- evaluating 'foldexpr' `textlock`.
+---
+--- @type string
+vim.o.foldexpr = "0"
+vim.o.fde = vim.o.foldexpr
+vim.wo.foldexpr = vim.o.foldexpr
+vim.wo.fde = vim.wo.foldexpr
+
+--- Used only when 'foldmethod' is "indent".  Lines starting with
+--- characters in 'foldignore' will get their fold level from surrounding
+--- lines.  White space is skipped before checking for this character.
+--- The default "#" works well for C programs.  See `fold-indent`.
+---
+--- @type string
+vim.o.foldignore = "#"
+vim.o.fdi = vim.o.foldignore
+vim.wo.foldignore = vim.o.foldignore
+vim.wo.fdi = vim.wo.foldignore
+
+--- Sets the fold level: Folds with a higher level will be closed.
+--- Setting this option to zero will close all folds.  Higher numbers will
+--- close fewer folds.
+--- This option is set by commands like `zm`, `zM` and `zR`.
+--- See `fold-foldlevel`.
+---
+--- @type integer
+vim.o.foldlevel = 0
+vim.o.fdl = vim.o.foldlevel
+vim.wo.foldlevel = vim.o.foldlevel
+vim.wo.fdl = vim.wo.foldlevel
+
+--- Sets 'foldlevel' when starting to edit another buffer in a window.
+--- Useful to always start editing with all folds closed (value zero),
+--- some folds closed (one) or no folds closed (99).
+--- This is done before reading any modeline, thus a setting in a modeline
+--- overrules this option.  Starting to edit a file for `diff-mode` also
+--- ignores this option and closes all folds.
+--- It is also done before BufReadPre autocommands, to allow an autocmd to
+--- overrule the 'foldlevel' value for specific files.
+--- When the value is negative, it is not used.
+---
+--- @type integer
+vim.o.foldlevelstart = -1
+vim.o.fdls = vim.o.foldlevelstart
+vim.go.foldlevelstart = vim.o.foldlevelstart
+vim.go.fdls = vim.go.foldlevelstart
+
+--- The start and end marker used when 'foldmethod' is "marker".  There
+--- must be one comma, which separates the start and end marker.  The
+--- marker is a literal string (a regular expression would be too slow).
+--- See `fold-marker`.
+---
+--- @type string
+vim.o.foldmarker = "{{{,}}}"
+vim.o.fmr = vim.o.foldmarker
+vim.wo.foldmarker = vim.o.foldmarker
+vim.wo.fmr = vim.wo.foldmarker
+
+--- The kind of folding used for the current window.  Possible values:
+--- `fold-manual`	manual	    Folds are created manually.
+--- `fold-indent`	indent	    Lines with equal indent form a fold.
+--- `fold-expr`	expr	    'foldexpr' gives the fold level of a line.
+--- `fold-marker`	marker	    Markers are used to specify folds.
+--- `fold-syntax`	syntax	    Syntax highlighting items specify folds.
+--- `fold-diff`	diff	    Fold text that is not changed.
+---
+--- @type string
+vim.o.foldmethod = "manual"
+vim.o.fdm = vim.o.foldmethod
+vim.wo.foldmethod = vim.o.foldmethod
+vim.wo.fdm = vim.wo.foldmethod
+
+--- Sets the number of screen lines above which a fold can be displayed
+--- closed.  Also for manually closed folds.  With the default value of
+--- one a fold can only be closed if it takes up two or more screen lines.
+--- Set to zero to be able to close folds of just one screen line.
+--- Note that this only has an effect on what is displayed.  After using
+--- "zc" to close a fold, which is displayed open because it's smaller
+--- than 'foldminlines', a following "zc" may close a containing fold.
+---
+--- @type integer
+vim.o.foldminlines = 1
+vim.o.fml = vim.o.foldminlines
+vim.wo.foldminlines = vim.o.foldminlines
+vim.wo.fml = vim.wo.foldminlines
+
+--- Sets the maximum nesting of folds for the "indent" and "syntax"
+--- methods.  This avoids that too many folds will be created.  Using more
+--- than 20 doesn't work, because the internal limit is 20.
+---
+--- @type integer
+vim.o.foldnestmax = 20
+vim.o.fdn = vim.o.foldnestmax
+vim.wo.foldnestmax = vim.o.foldnestmax
+vim.wo.fdn = vim.wo.foldnestmax
+
+--- Specifies for which type of commands folds will be opened, if the
+--- command moves the cursor into a closed fold.  It is a comma-separated
+--- list of items.
+--- NOTE: When the command is part of a mapping this option is not used.
+--- Add the `zv` command to the mapping to get the same effect.
+--- (rationale: the mapping may want to control opening folds itself)
+---
+--- 	item		commands ~
+--- 	all		any
+--- 	block		(, {, [[, [{, etc.
+--- 	hor		horizontal movements: "l", "w", "fx", etc.
+--- 	insert		any command in Insert mode
+--- 	jump		far jumps: "G", "gg", etc.
+--- 	mark		jumping to a mark: "'m", CTRL-O, etc.
+--- 	percent		"%"
+--- 	quickfix	":cn", ":crew", ":make", etc.
+--- 	search		search for a pattern: "/", "n", "*", "gd", etc.
+--- 			(not for a search pattern in a ":" command)
+--- 			Also for `[s` and `]s`.
+--- 	tag		jumping to a tag: ":ta", CTRL-T, etc.
+--- 	undo		undo or redo: "u" and CTRL-R
+--- When a movement command is used for an operator (e.g., "dl" or "y%")
+--- this option is not used.  This means the operator will include the
+--- whole closed fold.
+--- Note that vertical movements are not here, because it would make it
+--- very difficult to move onto a closed fold.
+--- In insert mode the folds containing the cursor will always be open
+--- when text is inserted.
+--- To close folds you can re-apply 'foldlevel' with the `zx` command or
+--- set the 'foldclose' option to "all".
+---
+--- @type string
+vim.o.foldopen = "block,hor,mark,percent,quickfix,search,tag,undo"
+vim.o.fdo = vim.o.foldopen
+vim.go.foldopen = vim.o.foldopen
+vim.go.fdo = vim.go.foldopen
+
+--- An expression which is used to specify the text displayed for a closed
+--- fold.  The context is set to the script where 'foldexpr' was set,
+--- script-local items can be accessed.  See `fold-foldtext` for the
+--- usage.
+---
+--- The expression will be evaluated in the `sandbox` if set from a
+--- modeline, see `sandbox-option`.
+--- This option cannot be set in a modeline when 'modelineexpr' is off.
+---
+--- It is not allowed to change text or jump to another window while
+--- evaluating 'foldtext' `textlock`.
+---
+--- @type string
+vim.o.foldtext = "foldtext()"
+vim.o.fdt = vim.o.foldtext
+vim.wo.foldtext = vim.o.foldtext
+vim.wo.fdt = vim.wo.foldtext
+
+--- Expression which is evaluated to format a range of lines for the `gq`
+--- operator or automatic formatting (see 'formatoptions').  When this
+--- option is empty 'formatprg' is used.
+---
+--- The `v:lnum`  variable holds the first line to be formatted.
+--- The `v:count` variable holds the number of lines to be formatted.
+--- The `v:char`  variable holds the character that is going to be
+--- 	      inserted if the expression is being evaluated due to
+--- 	      automatic formatting.  This can be empty.  Don't insert
+--- 	      it yet!
+---
+--- Example:
+--- ```
+--- 	:set formatexpr=mylang#Format()
+--- ```
+--- This will invoke the mylang#Format() function in the
+--- autoload/mylang.vim file in 'runtimepath'. `autoload`
+---
+--- The expression is also evaluated when 'textwidth' is set and adding
+--- text beyond that limit.  This happens under the same conditions as
+--- when internal formatting is used.  Make sure the cursor is kept in the
+--- same spot relative to the text then!  The `mode()` function will
+--- return "i" or "R" in this situation.
+---
+--- When the expression evaluates to non-zero Vim will fall back to using
+--- the internal format mechanism.
+---
+--- If the expression starts with s: or `<SID>`, then it is replaced with
+--- the script ID (`local-function`). Example:
+--- ```
+--- 	set formatexpr=s:MyFormatExpr()
+--- 	set formatexpr=<SID>SomeFormatExpr()
+--- ```
+--- Otherwise, the expression is evaluated in the context of the script
+--- where the option was set, thus script-local items are available.
+---
+--- The expression will be evaluated in the `sandbox` when set from a
+--- modeline, see `sandbox-option`.  That stops the option from working,
+--- since changing the buffer text is not allowed.
+--- This option cannot be set in a modeline when 'modelineexpr' is off.
+--- NOTE: This option is set to "" when 'compatible' is set.
+---
+--- @type string
+vim.o.formatexpr = ""
+vim.o.fex = vim.o.formatexpr
+vim.bo.formatexpr = vim.o.formatexpr
+vim.bo.fex = vim.bo.formatexpr
+
+--- A pattern that is used to recognize a list header.  This is used for
+--- the "n" flag in 'formatoptions'.
+--- The pattern must match exactly the text that will be the indent for
+--- the line below it.  You can use `/\ze` to mark the end of the match
+--- while still checking more characters.  There must be a character
+--- following the pattern, when it matches the whole line it is handled
+--- like there is no match.
+--- The default recognizes a number, followed by an optional punctuation
+--- character and white space.
+---
+--- @type string
+vim.o.formatlistpat = "^\\s*\\d\\+[\\]:.)}\\t ]\\s*"
+vim.o.flp = vim.o.formatlistpat
+vim.bo.formatlistpat = vim.o.formatlistpat
+vim.bo.flp = vim.bo.formatlistpat
+
+--- This is a sequence of letters which describes how automatic
+--- formatting is to be done.  See `fo-table`.  Commas can be inserted for
+--- readability.
+--- To avoid problems with flags that are added in the future, use the
+--- "+=" and "-=" feature of ":set" `add-option-flags`.
+---
+--- @type string
+vim.o.formatoptions = "tcqj"
+vim.o.fo = vim.o.formatoptions
+vim.bo.formatoptions = vim.o.formatoptions
+vim.bo.fo = vim.bo.formatoptions
+
+--- The name of an external program that will be used to format the lines
+--- selected with the `gq` operator.  The program must take the input on
+--- stdin and produce the output on stdout.  The Unix program "fmt" is
+--- such a program.
+--- If the 'formatexpr' option is not empty it will be used instead.
+--- Otherwise, if 'formatprg' option is an empty string, the internal
+--- format function will be used `C-indenting`.
+--- Environment variables are expanded `:set_env`.  See `option-backslash`
+--- about including spaces and backslashes.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.formatprg = ""
+vim.o.fp = vim.o.formatprg
+vim.bo.formatprg = vim.o.formatprg
+vim.bo.fp = vim.bo.formatprg
+vim.go.formatprg = vim.o.formatprg
+vim.go.fp = vim.go.formatprg
+
+--- When on, the OS function fsync() will be called after saving a file
+--- (`:write`, `writefile()`, …), `swap-file`, `undo-persistence` and `shada-file`.
+--- This flushes the file to disk, ensuring that it is safely written.
+--- Slow on some systems: writing buffers, quitting Nvim, and other
+--- operations may sometimes take a few seconds.
+---
+--- Files are ALWAYS flushed ('fsync' is ignored) when:
+--- - `CursorHold` event is triggered
+--- - `:preserve` is called
+--- - system signals low battery life
+--- - Nvim exits abnormally
+---
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type boolean
+vim.o.fsync = false
+vim.o.fs = vim.o.fsync
+vim.go.fsync = vim.o.fsync
+vim.go.fs = vim.go.fsync
+
+--- When on, the ":substitute" flag 'g' is default on.  This means that
+--- all matches in a line are substituted instead of one.  When a 'g' flag
+--- is given to a ":substitute" command, this will toggle the substitution
+--- of all or one match.  See `complex-change`.
+---
+--- 	command		'gdefault' on	'gdefault' off	~
+--- 	:s///		  subst. all	  subst. one
+--- 	:s///g		  subst. one	  subst. all
+--- 	:s///gg		  subst. all	  subst. one
+---
+--- DEPRECATED: Setting this option may break plugins that are not aware
+--- of this option.  Also, many users get confused that adding the /g flag
+--- has the opposite effect of that it normally does.
+---
+--- @type boolean
+vim.o.gdefault = false
+vim.o.gd = vim.o.gdefault
+vim.go.gdefault = vim.o.gdefault
+vim.go.gd = vim.go.gdefault
+
+--- Format to recognize for the ":grep" command output.
+--- This is a scanf-like string that uses the same format as the
+--- 'errorformat' option: see `errorformat`.
+---
+--- @type string
+vim.o.grepformat = "%f:%l:%m,%f:%l%m,%f  %l%m"
+vim.o.gfm = vim.o.grepformat
+vim.go.grepformat = vim.o.grepformat
+vim.go.gfm = vim.go.grepformat
+
+--- Program to use for the `:grep` command.  This option may contain '%'
+--- and '#' characters, which are expanded like when used in a command-
+--- line.  The placeholder "$*" is allowed to specify where the arguments
+--- will be included.  Environment variables are expanded `:set_env`.  See
+--- `option-backslash` about including spaces and backslashes.
+--- When your "grep" accepts the "-H" argument, use this to make ":grep"
+--- also work well with a single file:
+--- ```
+--- 	:set grepprg=grep\ -nH
+--- ```
+--- Special value: When 'grepprg' is set to "internal" the `:grep` command
+--- works like `:vimgrep`, `:lgrep` like `:lvimgrep`, `:grepadd` like
+--- `:vimgrepadd` and `:lgrepadd` like `:lvimgrepadd`.
+--- See also the section `:make_makeprg`, since most of the comments there
+--- apply equally to 'grepprg'.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.grepprg = "grep -n $* /dev/null"
+vim.o.gp = vim.o.grepprg
+vim.bo.grepprg = vim.o.grepprg
+vim.bo.gp = vim.bo.grepprg
+vim.go.grepprg = vim.o.grepprg
+vim.go.gp = vim.go.grepprg
+
+--- Configures the cursor style for each mode. Works in the GUI and many
+--- terminals.  See `tui-cursor-shape`.
+---
+--- To disable cursor-styling, reset the option:
+--- ```
+--- 	:set guicursor=
+---
+--- ```
+--- To enable mode shapes, "Cursor" highlight, and blinking:
+--- ```
+--- 	:set guicursor=n-v-c:block,i-ci-ve:ver25,r-cr:hor20,o:hor50
+--- 	  \,a:blinkwait700-blinkoff400-blinkon250-Cursor/lCursor
+--- 	  \,sm:block-blinkwait175-blinkoff150-blinkon175
+---
+--- ```
+--- The option is a comma-separated list of parts.  Each part consists of a
+--- mode-list and an argument-list:
+--- 	mode-list:argument-list,mode-list:argument-list,..
+--- The mode-list is a dash separated list of these modes:
+--- 	n	Normal mode
+--- 	v	Visual mode
+--- 	ve	Visual mode with 'selection' "exclusive" (same as 'v',
+--- 		if not specified)
+--- 	o	Operator-pending mode
+--- 	i	Insert mode
+--- 	r	Replace mode
+--- 	c	Command-line Normal (append) mode
+--- 	ci	Command-line Insert mode
+--- 	cr	Command-line Replace mode
+--- 	sm	showmatch in Insert mode
+--- 	a	all modes
+--- The argument-list is a dash separated list of these arguments:
+--- 	hor{N}	horizontal bar, {N} percent of the character height
+--- 	ver{N}	vertical bar, {N} percent of the character width
+--- 	block	block cursor, fills the whole character
+--- 		- Only one of the above three should be present.
+--- 		- Default is "block" for each mode.
+--- 	blinkwait{N}				*cursor-blinking*
+--- 	blinkon{N}
+--- 	blinkoff{N}
+--- 		blink times for cursor: blinkwait is the delay before
+--- 		the cursor starts blinking, blinkon is the time that
+--- 		the cursor is shown and blinkoff is the time that the
+--- 		cursor is not shown.  Times are in msec.  When one of
+--- 		the numbers is zero, there is no blinking. E.g.:
+--- ```
+--- 			:set guicursor=n:blinkon0
+--- ```
+--- - Default is "blinkon0" for each mode.
+--- 	{group-name}
+--- 		Highlight group that decides the color and font of the
+--- 		cursor.
+--- 		In the `TUI`:
+--- 		- `inverse`/reverse and no group-name are interpreted
+--- 		  as "host-terminal default cursor colors" which
+--- 		  typically means "inverted bg and fg colors".
+--- 		- `ctermfg` and `guifg` are ignored.
+--- 	{group-name}/{group-name}
+--- 		Two highlight group names, the first is used when
+--- 		no language mappings are used, the other when they
+--- 		are. `language-mapping`
+---
+--- Examples of parts:
+---    n-c-v:block-nCursor	In Normal, Command-line and Visual mode, use a
+--- 			block cursor with colors from the "nCursor"
+--- 			highlight group
+---    n-v-c-sm:block,i-ci-ve:ver25-Cursor,r-cr-o:hor20
+--- 			In Normal et al. modes, use a block cursor
+--- 			with the default colors defined by the host
+--- 			terminal.  In Insert-likes modes, use
+--- 			a vertical bar cursor with colors from
+--- 			"Cursor" highlight group.  In Replace-likes
+--- 			modes, use a underline cursor with
+--- 			default colors.
+---    i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
+--- 			In Insert and Command-line Insert mode, use a
+--- 			30% vertical bar cursor with colors from the
+--- 			"iCursor" highlight group.  Blink a bit
+--- 			faster.
+---
+--- The 'a' mode is different.  It will set the given argument-list for
+--- all modes.  It does not reset anything to defaults.  This can be used
+--- to do a common setting for all modes.  For example, to switch off
+--- blinking: "a:blinkon0"
+---
+--- Examples of cursor highlighting:
+--- ```
+---     :highlight Cursor gui=reverse guifg=NONE guibg=NONE
+---     :highlight Cursor gui=NONE guifg=bg guibg=fg
+--- ```
+---
+--- @type string
+vim.o.guicursor = "n-v-c-sm:block,i-ci-ve:ver25,r-cr-o:hor20"
+vim.o.gcr = vim.o.guicursor
+vim.go.guicursor = vim.o.guicursor
+vim.go.gcr = vim.go.guicursor
+
+--- This is a list of fonts which will be used for the GUI version of Vim.
+--- In its simplest form the value is just one font name.  When
+--- the font cannot be found you will get an error message.  To try other
+--- font names a list can be specified, font names separated with commas.
+--- The first valid font is used.
+---
+--- Spaces after a comma are ignored.  To include a comma in a font name
+--- precede it with a backslash.  Setting an option requires an extra
+--- backslash before a space and a backslash.  See also
+--- `option-backslash`.  For example:
+--- ```
+---     :set guifont=Screen15,\ 7x13,font\\,with\\,commas
+--- ```
+--- will make Vim try to use the font "Screen15" first, and if it fails it
+--- will try to use "7x13" and then "font,with,commas" instead.
+---
+--- If none of the fonts can be loaded, Vim will keep the current setting.
+--- If an empty font list is given, Vim will try using other resource
+--- settings (for X, it will use the Vim.font resource), and finally it
+--- will try some builtin default which should always be there ("7x13" in
+--- the case of X).  The font names given should be "normal" fonts.  Vim
+--- will try to find the related bold and italic fonts.
+---
+--- For Win32 and Mac OS:
+--- ```
+---     :set guifont=*
+--- ```
+--- will bring up a font requester, where you can pick the font you want.
+---
+--- The font name depends on the GUI used.
+---
+--- For Mac OSX you can use something like this:
+--- ```
+---     :set guifont=Monaco:h10
+--- ```
+--- *E236*
+--- Note that the fonts must be mono-spaced (all characters have the same
+--- width).
+---
+--- To preview a font on X11, you might be able to use the "xfontsel"
+--- program.  The "xlsfonts" program gives a list of all available fonts.
+---
+--- For the Win32 GUI					*E244* *E245*
+--- - takes these options in the font name:
+--- 	hXX - height is XX (points, can be floating-point)
+--- 	wXX - width is XX (points, can be floating-point)
+--- 	b   - bold
+--- 	i   - italic
+--- 	u   - underline
+--- 	s   - strikeout
+--- 	cXX - character set XX.  Valid charsets are: ANSI, ARABIC,
+--- 	      BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
+--- 	      HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
+--- 	      SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
+--- 	      Normally you would use "cDEFAULT".
+---
+---   Use a ':' to separate the options.
+--- - A '_' can be used in the place of a space, so you don't need to use
+---   backslashes to escape the spaces.
+--- - Examples:
+--- ```
+---     :set guifont=courier_new:h12:w5:b:cRUSSIAN
+---     :set guifont=Andale_Mono:h7.5:w4.5
+--- ```
+---
+--- @type string
+vim.o.guifont = ""
+vim.o.gfn = vim.o.guifont
+vim.go.guifont = vim.o.guifont
+vim.go.gfn = vim.go.guifont
+
+--- Comma-separated list of fonts to be used for double-width characters.
+--- The first font that can be loaded is used.
+--- Note: The size of these fonts must be exactly twice as wide as the one
+--- specified with 'guifont' and the same height.
+---
+--- When 'guifont' has a valid font and 'guifontwide' is empty Vim will
+--- attempt to set 'guifontwide' to a matching double-width font.
+---
+--- @type string
+vim.o.guifontwide = ""
+vim.o.gfw = vim.o.guifontwide
+vim.go.guifontwide = vim.o.guifontwide
+vim.go.gfw = vim.go.guifontwide
+
+--- This option only has an effect in the GUI version of Vim.  It is a
+--- sequence of letters which describes what components and options of the
+--- GUI should be used.
+--- To avoid problems with flags that are added in the future, use the
+--- "+=" and "-=" feature of ":set" `add-option-flags`.
+---
+--- Valid letters are as follows:
+--- 						*guioptions_a* *'go-a'*
+---   'a'	Autoselect:  If present, then whenever VISUAL mode is started,
+--- 	or the Visual area extended, Vim tries to become the owner of
+--- 	the windowing system's global selection.  This means that the
+--- 	Visually highlighted text is available for pasting into other
+--- 	applications as well as into Vim itself.  When the Visual mode
+--- 	ends, possibly due to an operation on the text, or when an
+--- 	application wants to paste the selection, the highlighted text
+--- 	is automatically yanked into the "* selection register.
+--- 	Thus the selection is still available for pasting into other
+--- 	applications after the VISUAL mode has ended.
+--- 	    If not present, then Vim won't become the owner of the
+--- 	windowing system's global selection unless explicitly told to
+--- 	by a yank or delete operation for the "* register.
+--- 	The same applies to the modeless selection.
+--- 							*'go-P'*
+---   'P'	Like autoselect but using the "+ register instead of the "*
+--- 	register.
+--- 							*'go-A'*
+---   'A'	Autoselect for the modeless selection.  Like 'a', but only
+--- 	applies to the modeless selection.
+---
+--- 	    'guioptions'   autoselect Visual  autoselect modeless ~
+--- 		 ""		 -			 -
+--- 		 "a"		yes			yes
+--- 		 "A"		 -			yes
+--- 		 "aA"		yes			yes
+---
+--- 							*'go-c'*
+---   'c'	Use console dialogs instead of popup dialogs for simple
+--- 	choices.
+--- 							*'go-d'*
+---   'd'	Use dark theme variant if available.
+--- 							*'go-e'*
+---   'e'	Add tab pages when indicated with 'showtabline'.
+--- 	'guitablabel' can be used to change the text in the labels.
+--- 	When 'e' is missing a non-GUI tab pages line may be used.
+--- 	The GUI tabs are only supported on some systems, currently
+--- 	Mac OS/X and MS-Windows.
+--- 							*'go-i'*
+---   'i'	Use a Vim icon.
+--- 							*'go-m'*
+---   'm'	Menu bar is present.
+--- 							*'go-M'*
+---   'M'	The system menu "$VIMRUNTIME/menu.vim" is not sourced.  Note
+--- 	that this flag must be added in the vimrc file, before
+--- 	switching on syntax or filetype recognition (when the `gvimrc`
+--- 	file is sourced the system menu has already been loaded; the
+--- 	`:syntax on` and `:filetype on` commands load the menu too).
+--- 							*'go-g'*
+---   'g'	Grey menu items: Make menu items that are not active grey.  If
+--- 	'g' is not included inactive menu items are not shown at all.
+--- 							*'go-T'*
+---   'T'	Include Toolbar.  Currently only in Win32 GUI.
+--- 							*'go-r'*
+---   'r'	Right-hand scrollbar is always present.
+--- 							*'go-R'*
+---   'R'	Right-hand scrollbar is present when there is a vertically
+--- 	split window.
+--- 							*'go-l'*
+---   'l'	Left-hand scrollbar is always present.
+--- 							*'go-L'*
+---   'L'	Left-hand scrollbar is present when there is a vertically
+--- 	split window.
+--- 							*'go-b'*
+---   'b'	Bottom (horizontal) scrollbar is present.  Its size depends on
+--- 	the longest visible line, or on the cursor line if the 'h'
+--- 	flag is included. `gui-horiz-scroll`
+--- 							*'go-h'*
+---   'h'	Limit horizontal scrollbar size to the length of the cursor
+--- 	line.  Reduces computations. `gui-horiz-scroll`
+---
+--- And yes, you may even have scrollbars on the left AND the right if
+--- you really want to :-).  See `gui-scrollbars` for more information.
+---
+--- 							*'go-v'*
+---   'v'	Use a vertical button layout for dialogs.  When not included,
+--- 	a horizontal layout is preferred, but when it doesn't fit a
+--- 	vertical layout is used anyway.  Not supported in GTK 3.
+--- 							*'go-p'*
+---   'p'	Use Pointer callbacks for X11 GUI.  This is required for some
+--- 	window managers.  If the cursor is not blinking or hollow at
+--- 	the right moment, try adding this flag.  This must be done
+--- 	before starting the GUI.  Set it in your `gvimrc`.  Adding or
+--- 	removing it after the GUI has started has no effect.
+--- 							*'go-k'*
+---   'k'	Keep the GUI window size when adding/removing a scrollbar, or
+--- 	toolbar, tabline, etc.  Instead, the behavior is similar to
+--- 	when the window is maximized and will adjust 'lines' and
+--- 	'columns' to fit to the window.  Without the 'k' flag Vim will
+--- 	try to keep 'lines' and 'columns' the same when adding and
+--- 	removing GUI components.
+---
+--- @type string
+vim.o.guioptions = ""
+vim.o.go = vim.o.guioptions
+vim.go.guioptions = vim.o.guioptions
+vim.go.go = vim.go.guioptions
+
+--- When non-empty describes the text to use in a label of the GUI tab
+--- pages line.  When empty and when the result is empty Vim will use a
+--- default label.  See `setting-guitablabel` for more info.
+---
+--- The format of this option is like that of 'statusline'.
+--- 'guitabtooltip' is used for the tooltip, see below.
+--- The expression will be evaluated in the `sandbox` when set from a
+--- modeline, see `sandbox-option`.
+--- This option cannot be set in a modeline when 'modelineexpr' is off.
+---
+--- Only used when the GUI tab pages line is displayed.  'e' must be
+--- present in 'guioptions'.  For the non-GUI tab pages line 'tabline' is
+--- used.
+---
+--- @type string
+vim.o.guitablabel = ""
+vim.o.gtl = vim.o.guitablabel
+vim.go.guitablabel = vim.o.guitablabel
+vim.go.gtl = vim.go.guitablabel
+
+--- When non-empty describes the text to use in a tooltip for the GUI tab
+--- pages line.  When empty Vim will use a default tooltip.
+--- This option is otherwise just like 'guitablabel' above.
+--- You can include a line break.  Simplest method is to use `:let`:
+--- ```
+--- 	:let &guitabtooltip = "line one\nline two"
+--- ```
+---
+--- @type string
+vim.o.guitabtooltip = ""
+vim.o.gtt = vim.o.guitabtooltip
+vim.go.guitabtooltip = vim.o.guitabtooltip
+vim.go.gtt = vim.go.guitabtooltip
+
+--- Name of the main help file.  All distributed help files should be
+--- placed together in one directory.  Additionally, all "doc" directories
+--- in 'runtimepath' will be used.
+--- Environment variables are expanded `:set_env`.  For example:
+--- "$VIMRUNTIME/doc/help.txt".  If $VIMRUNTIME is not set, $VIM is also
+--- tried.  Also see `$VIMRUNTIME` and `option-backslash` about including
+--- spaces and backslashes.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.helpfile = "$VIMRUNTIME/doc/help.txt"
+vim.o.hf = vim.o.helpfile
+vim.go.helpfile = vim.o.helpfile
+vim.go.hf = vim.go.helpfile
+
+--- Minimal initial height of the help window when it is opened with the
+--- ":help" command.  The initial height of the help window is half of the
+--- current window, or (when the 'ea' option is on) the same as other
+--- windows.  When the height is less than 'helpheight', the height is
+--- set to 'helpheight'.  Set to zero to disable.
+---
+--- @type integer
+vim.o.helpheight = 20
+vim.o.hh = vim.o.helpheight
+vim.go.helpheight = vim.o.helpheight
+vim.go.hh = vim.go.helpheight
+
+--- Comma-separated list of languages.  Vim will use the first language
+--- for which the desired help can be found.  The English help will always
+--- be used as a last resort.  You can add "en" to prefer English over
+--- another language, but that will only find tags that exist in that
+--- language and not in the English help.
+--- Example:
+--- ```
+--- 	:set helplang=de,it
+--- ```
+--- This will first search German, then Italian and finally English help
+--- files.
+--- When using `CTRL-]` and ":help!" in a non-English help file Vim will
+--- try to find the tag in the current language before using this option.
+--- See `help-translated`.
+---
+--- @type string
+vim.o.helplang = ""
+vim.o.hlg = vim.o.helplang
+vim.go.helplang = vim.o.helplang
+vim.go.hlg = vim.go.helplang
+
+--- When off a buffer is unloaded (including loss of undo information)
+--- when it is `abandon`ed.  When on a buffer becomes hidden when it is
+--- `abandon`ed.  A buffer displayed in another window does not become
+--- hidden, of course.
+---
+--- Commands that move through the buffer list sometimes hide a buffer
+--- although the 'hidden' option is off when these three are true:
+--- - the buffer is modified
+--- - 'autowrite' is off or writing is not possible
+--- - the '!' flag was used
+--- Also see `windows`.
+---
+--- To hide a specific buffer use the 'bufhidden' option.
+--- 'hidden' is set for one command with ":hide {command}" `:hide`.
+---
+--- @type boolean
+vim.o.hidden = true
+vim.o.hid = vim.o.hidden
+vim.go.hidden = vim.o.hidden
+vim.go.hid = vim.go.hidden
+
+--- A history of ":" commands, and a history of previous search patterns
+--- is remembered.  This option decides how many entries may be stored in
+--- each of these histories (see `cmdline-editing`).
+--- The maximum value is 10000.
+---
+--- @type integer
+vim.o.history = 10000
+vim.o.hi = vim.o.history
+vim.go.history = vim.o.history
+vim.go.hi = vim.go.history
+
+--- When there is a previous search pattern, highlight all its matches.
+--- The `hl-Search` highlight group determines the highlighting for all
+--- matches not under the cursor while the `hl-CurSearch` highlight group
+--- (if defined) determines the highlighting for the match under the
+--- cursor. If `hl-CurSearch` is not defined, then `hl-Search` is used for
+--- both. Note that only the matching text is highlighted, any offsets
+--- are not applied.
+--- See also: 'incsearch' and `:match`.
+--- When you get bored looking at the highlighted matches, you can turn it
+--- off with `:nohlsearch`.  This does not change the option value, as
+--- soon as you use a search command, the highlighting comes back.
+--- 'redrawtime' specifies the maximum time spent on finding matches.
+--- When the search pattern can match an end-of-line, Vim will try to
+--- highlight all of the matched text.  However, this depends on where the
+--- search starts.  This will be the first line in the window or the first
+--- line below a closed fold.  A match in a previous line which is not
+--- drawn may not continue in a newly drawn line.
+--- You can specify whether the highlight status is restored on startup
+--- with the 'h' flag in 'shada' `shada-h`.
+---
+--- @type boolean
+vim.o.hlsearch = true
+vim.o.hls = vim.o.hlsearch
+vim.go.hlsearch = vim.o.hlsearch
+vim.go.hls = vim.go.hlsearch
+
+--- When on, the icon text of the window will be set to the value of
+--- 'iconstring' (if it is not empty), or to the name of the file
+--- currently being edited.  Only the last part of the name is used.
+--- Overridden by the 'iconstring' option.
+--- Only works if the terminal supports setting window icons.
+---
+--- @type boolean
+vim.o.icon = false
+vim.go.icon = vim.o.icon
+
+--- When this option is not empty, it will be used for the icon text of
+--- the window.  This happens only when the 'icon' option is on.
+--- Only works if the terminal supports setting window icon text
+--- When this option contains printf-style '%' items, they will be
+--- expanded according to the rules used for 'statusline'.  See
+--- 'titlestring' for example settings.
+--- This option cannot be set in a modeline when 'modelineexpr' is off.
+---
+--- @type string
+vim.o.iconstring = ""
+vim.go.iconstring = vim.o.iconstring
+
+--- Ignore case in search patterns.  Also used when searching in the tags
+--- file.
+--- Also see 'smartcase' and 'tagcase'.
+--- Can be overruled by using "\c" or "\C" in the pattern, see
+--- `/ignorecase`.
+---
+--- @type boolean
+vim.o.ignorecase = false
+vim.o.ic = vim.o.ignorecase
+vim.go.ignorecase = vim.o.ignorecase
+vim.go.ic = vim.go.ignorecase
+
+--- When set the Input Method is always on when starting to edit a command
+--- line, unless entering a search pattern (see 'imsearch' for that).
+--- Setting this option is useful when your input method allows entering
+--- English characters directly, e.g., when it's used to type accented
+--- characters with dead keys.
+---
+--- @type boolean
+vim.o.imcmdline = false
+vim.o.imc = vim.o.imcmdline
+vim.go.imcmdline = vim.o.imcmdline
+vim.go.imc = vim.go.imcmdline
+
+--- When set the Input Method is never used.  This is useful to disable
+--- the IM when it doesn't work properly.
+--- Currently this option is on by default for SGI/IRIX machines.  This
+--- may change in later releases.
+---
+--- @type boolean
+vim.o.imdisable = false
+vim.o.imd = vim.o.imdisable
+vim.go.imdisable = vim.o.imdisable
+vim.go.imd = vim.go.imdisable
+
+--- Specifies whether :lmap or an Input Method (IM) is to be used in
+--- Insert mode.  Valid values:
+--- 	0	:lmap is off and IM is off
+--- 	1	:lmap is ON and IM is off
+--- 	2	:lmap is off and IM is ON
+--- To always reset the option to zero when leaving Insert mode with <Esc>
+--- this can be used:
+--- ```
+--- 	:inoremap <ESC> <ESC>:set iminsert=0<CR>
+--- ```
+--- This makes :lmap and IM turn off automatically when leaving Insert
+--- mode.
+--- Note that this option changes when using CTRL-^ in Insert mode
+--- `i_CTRL-^`.
+--- The value is set to 1 when setting 'keymap' to a valid keymap name.
+--- It is also used for the argument of commands like "r" and "f".
+---
+--- @type integer
+vim.o.iminsert = 0
+vim.o.imi = vim.o.iminsert
+vim.bo.iminsert = vim.o.iminsert
+vim.bo.imi = vim.bo.iminsert
+
+--- Specifies whether :lmap or an Input Method (IM) is to be used when
+--- entering a search pattern.  Valid values:
+--- 	-1	the value of 'iminsert' is used, makes it look like
+--- 		'iminsert' is also used when typing a search pattern
+--- 	0	:lmap is off and IM is off
+--- 	1	:lmap is ON and IM is off
+--- 	2	:lmap is off and IM is ON
+--- Note that this option changes when using CTRL-^ in Command-line mode
+--- `c_CTRL-^`.
+--- The value is set to 1 when it is not -1 and setting the 'keymap'
+--- option to a valid keymap name.
+---
+--- @type integer
+vim.o.imsearch = -1
+vim.o.ims = vim.o.imsearch
+vim.bo.imsearch = vim.o.imsearch
+vim.bo.ims = vim.bo.imsearch
+
+--- When nonempty, shows the effects of `:substitute`, `:smagic|,
+--- |:snomagic` and user commands with the `:command-preview` flag as you
+--- type.
+---
+--- Possible values:
+--- 	nosplit	Shows the effects of a command incrementally in the
+--- 		buffer.
+--- 	split	Like "nosplit", but also shows partial off-screen
+--- 		results in a preview window.
+---
+--- If the preview for built-in commands is too slow (exceeds
+--- 'redrawtime') then 'inccommand' is automatically disabled until
+--- `Command-line-mode` is done.
+---
+--- @type string
+vim.o.inccommand = "nosplit"
+vim.o.icm = vim.o.inccommand
+vim.go.inccommand = vim.o.inccommand
+vim.go.icm = vim.go.inccommand
+
+--- Pattern to be used to find an include command.  It is a search
+--- pattern, just like for the "/" command (See `pattern`).  This option
+--- is used for the commands "[i", "]I", "[d", etc.
+--- Normally the 'isfname' option is used to recognize the file name that
+--- comes after the matched pattern.  But if "\zs" appears in the pattern
+--- then the text matched from "\zs" to the end, or until "\ze" if it
+--- appears, is used as the file name.  Use this to include characters
+--- that are not in 'isfname', such as a space.  You can then use
+--- 'includeexpr' to process the matched text.
+--- See `option-backslash` about including spaces and backslashes.
+---
+--- @type string
+vim.o.include = ""
+vim.o.inc = vim.o.include
+vim.bo.include = vim.o.include
+vim.bo.inc = vim.bo.include
+vim.go.include = vim.o.include
+vim.go.inc = vim.go.include
+
+--- Expression to be used to transform the string found with the 'include'
+--- option to a file name.  Mostly useful to change "." to "/" for Java:
+--- ```
+--- 	:setlocal includeexpr=substitute(v:fname,'\\.','/','g')
+--- ```
+--- The "v:fname" variable will be set to the file name that was detected.
+--- Note the double backslash: the `:set` command first halves them, then
+--- one remains in the value, where "\." matches a dot literally.  For
+--- simple character replacements `tr()` avoids the need for escaping:
+--- ```
+--- 	:setlocal includeexpr=tr(v:fname,'.','/')
+--- ```
+--- Also used for the `gf` command if an unmodified file name can't be
+--- found.  Allows doing "gf" on the name after an 'include' statement.
+--- Also used for `<cfile>`.
+---
+--- If the expression starts with s: or `<SID>`, then it is replaced with
+--- the script ID (`local-function`). Example:
+--- ```
+--- 	setlocal includeexpr=s:MyIncludeExpr(v:fname)
+--- 	setlocal includeexpr=<SID>SomeIncludeExpr(v:fname)
+--- ```
+--- Otherwise, the expression is evaluated in the context of the script
+--- where the option was set, thus script-local items are available.
+---
+--- The expression will be evaluated in the `sandbox` when set from a
+--- modeline, see `sandbox-option`.
+--- This option cannot be set in a modeline when 'modelineexpr' is off.
+---
+--- It is not allowed to change text or jump to another window while
+--- evaluating 'includeexpr' `textlock`.
+---
+--- @type string
+vim.o.includeexpr = ""
+vim.o.inex = vim.o.includeexpr
+vim.bo.includeexpr = vim.o.includeexpr
+vim.bo.inex = vim.bo.includeexpr
+
+--- While typing a search command, show where the pattern, as it was typed
+--- so far, matches.  The matched string is highlighted.  If the pattern
+--- is invalid or not found, nothing is shown.  The screen will be updated
+--- often, this is only useful on fast terminals.
+--- Note that the match will be shown, but the cursor will return to its
+--- original position when no match is found and when pressing <Esc>.  You
+--- still need to finish the search command with <Enter> to move the
+--- cursor to the match.
+--- You can use the CTRL-G and CTRL-T keys to move to the next and
+--- previous match. `c_CTRL-G` `c_CTRL-T`
+--- Vim only searches for about half a second.  With a complicated
+--- pattern and/or a lot of text the match may not be found.  This is to
+--- avoid that Vim hangs while you are typing the pattern.
+--- The `hl-IncSearch` highlight group determines the highlighting.
+--- When 'hlsearch' is on, all matched strings are highlighted too while
+--- typing a search command. See also: 'hlsearch'.
+--- If you don't want to turn 'hlsearch' on, but want to highlight all
+--- matches while searching, you can turn on and off 'hlsearch' with
+--- autocmd.  Example:
+--- ```
+--- 	augroup vimrc-incsearch-highlight
+--- 	  autocmd!
+--- 	  autocmd CmdlineEnter /,\? :set hlsearch
+--- 	  autocmd CmdlineLeave /,\? :set nohlsearch
+--- 	augroup END
+--- ```
+--- CTRL-L can be used to add one character from after the current match
+--- to the command line.  If 'ignorecase' and 'smartcase' are set and the
+--- command line has no uppercase characters, the added character is
+--- converted to lowercase.
+--- CTRL-R CTRL-W can be used to add the word at the end of the current
+--- match, excluding the characters that were already typed.
+---
+--- @type boolean
+vim.o.incsearch = true
+vim.o.is = vim.o.incsearch
+vim.go.incsearch = vim.o.incsearch
+vim.go.is = vim.go.incsearch
+
+--- Expression which is evaluated to obtain the proper indent for a line.
+--- It is used when a new line is created, for the `=` operator and
+--- in Insert mode as specified with the 'indentkeys' option.
+--- When this option is not empty, it overrules the 'cindent' and
+--- 'smartindent' indenting.  When 'lisp' is set, this option is
+--- is only used when 'lispoptions' contains "expr:1".
+--- The expression is evaluated with `v:lnum` set to the line number for
+--- which the indent is to be computed.  The cursor is also in this line
+--- when the expression is evaluated (but it may be moved around).
+---
+--- If the expression starts with s: or `<SID>`, then it is replaced with
+--- the script ID (`local-function`). Example:
+--- ```
+--- 	set indentexpr=s:MyIndentExpr()
+--- 	set indentexpr=<SID>SomeIndentExpr()
+--- ```
+--- Otherwise, the expression is evaluated in the context of the script
+--- where the option was set, thus script-local items are available.
+---
+--- The expression must return the number of spaces worth of indent.  It
+--- can return "-1" to keep the current indent (this means 'autoindent' is
+--- used for the indent).
+--- Functions useful for computing the indent are `indent()`, `cindent()`
+--- and `lispindent()`.
+--- The evaluation of the expression must not have side effects!  It must
+--- not change the text, jump to another window, etc.  Afterwards the
+--- cursor position is always restored, thus the cursor may be moved.
+--- Normally this option would be set to call a function:
+--- ```
+--- 	:set indentexpr=GetMyIndent()
+--- ```
+--- Error messages will be suppressed, unless the 'debug' option contains
+--- "msg".
+--- See `indent-expression`.
+---
+--- The expression will be evaluated in the `sandbox` when set from a
+--- modeline, see `sandbox-option`.
+--- This option cannot be set in a modeline when 'modelineexpr' is off.
+---
+--- It is not allowed to change text or jump to another window while
+--- evaluating 'indentexpr' `textlock`.
+---
+--- @type string
+vim.o.indentexpr = ""
+vim.o.inde = vim.o.indentexpr
+vim.bo.indentexpr = vim.o.indentexpr
+vim.bo.inde = vim.bo.indentexpr
+
+--- A list of keys that, when typed in Insert mode, cause reindenting of
+--- the current line.  Only happens if 'indentexpr' isn't empty.
+--- The format is identical to 'cinkeys', see `indentkeys-format`.
+--- See `C-indenting` and `indent-expression`.
+---
+--- @type string
+vim.o.indentkeys = "0{,0},0),0],:,0#,!^F,o,O,e"
+vim.o.indk = vim.o.indentkeys
+vim.bo.indentkeys = vim.o.indentkeys
+vim.bo.indk = vim.bo.indentkeys
+
+--- When doing keyword completion in insert mode `ins-completion`, and
+--- 'ignorecase' is also on, the case of the match is adjusted depending
+--- on the typed text.  If the typed text contains a lowercase letter
+--- where the match has an upper case letter, the completed part is made
+--- lowercase.  If the typed text has no lowercase letters and the match
+--- has a lowercase letter where the typed text has an uppercase letter,
+--- and there is a letter before it, the completed part is made uppercase.
+--- With 'noinfercase' the match is used as-is.
+---
+--- @type boolean
+vim.o.infercase = false
+vim.o.inf = vim.o.infercase
+vim.bo.infercase = vim.o.infercase
+vim.bo.inf = vim.bo.infercase
+
+--- The characters specified by this option are included in file names and
+--- path names.  Filenames are used for commands like "gf", "[i" and in
+--- the tags file.  It is also used for "\f" in a `pattern`.
+--- Multi-byte characters 256 and above are always included, only the
+--- characters up to 255 are specified with this option.
+--- For UTF-8 the characters 0xa0 to 0xff are included as well.
+--- Think twice before adding white space to this option.  Although a
+--- space may appear inside a file name, the effect will be that Vim
+--- doesn't know where a file name starts or ends when doing completion.
+--- It most likely works better without a space in 'isfname'.
+---
+--- Note that on systems using a backslash as path separator, Vim tries to
+--- do its best to make it work as you would expect.  That is a bit
+--- tricky, since Vi originally used the backslash to escape special
+--- characters.  Vim will not remove a backslash in front of a normal file
+--- name character on these systems, but it will on Unix and alikes.  The
+--- '&' and '^' are not included by default, because these are special for
+--- cmd.exe.
+---
+--- The format of this option is a list of parts, separated with commas.
+--- Each part can be a single character number or a range.  A range is two
+--- character numbers with '-' in between.  A character number can be a
+--- decimal number between 0 and 255 or the ASCII character itself (does
+--- not work for digits).  Example:
+--- 	"_,-,128-140,#-43"	(include '_' and '-' and the range
+--- 				128 to 140 and '#' to 43)
+--- If a part starts with '^', the following character number or range
+--- will be excluded from the option.  The option is interpreted from left
+--- to right.  Put the excluded character after the range where it is
+--- included.  To include '^' itself use it as the last character of the
+--- option or the end of a range.  Example:
+--- 	"^a-z,#,^"	(exclude 'a' to 'z', include '#' and '^')
+--- If the character is '@', all characters where isalpha() returns TRUE
+--- are included.  Normally these are the characters a to z and A to Z,
+--- plus accented characters.  To include '@' itself use "@-@".  Examples:
+--- 	"@,^a-z"	All alphabetic characters, excluding lower
+--- 			case ASCII letters.
+--- 	"a-z,A-Z,@-@"	All letters plus the '@' character.
+--- A comma can be included by using it where a character number is
+--- expected.  Example:
+--- 	"48-57,,,_"	Digits, comma and underscore.
+--- A comma can be excluded by prepending a '^'.  Example:
+--- 	" -~,^,,9"	All characters from space to '~', excluding
+--- 			comma, plus <Tab>.
+--- See `option-backslash` about including spaces and backslashes.
+---
+--- @type string
+vim.o.isfname = "@,48-57,/,.,-,_,+,,,#,$,%,~,="
+vim.o.isf = vim.o.isfname
+vim.go.isfname = vim.o.isfname
+vim.go.isf = vim.go.isfname
+
+--- The characters given by this option are included in identifiers.
+--- Identifiers are used in recognizing environment variables and after a
+--- match of the 'define' option.  It is also used for "\i" in a
+--- `pattern`.  See 'isfname' for a description of the format of this
+--- option.  For '@' only characters up to 255 are used.
+--- Careful: If you change this option, it might break expanding
+--- environment variables.  E.g., when '/' is included and Vim tries to
+--- expand "$HOME/.local/state/nvim/shada/main.shada".  Maybe you should
+--- change 'iskeyword' instead.
+---
+--- @type string
+vim.o.isident = "@,48-57,_,192-255"
+vim.o.isi = vim.o.isident
+vim.go.isident = vim.o.isident
+vim.go.isi = vim.go.isident
+
+--- Keywords are used in searching and recognizing with many commands:
+--- "w", "*", "[i", etc.  It is also used for "\k" in a `pattern`.  See
+--- 'isfname' for a description of the format of this option.  For '@'
+--- characters above 255 check the "word" character class (any character
+--- that is not white space or punctuation).
+--- For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
+--- For a help file it is set to all non-blank printable characters except
+--- "*", '"' and '|' (so that CTRL-] on a command finds the help for that
+--- command).
+--- When the 'lisp' option is on the '-' character is always included.
+--- This option also influences syntax highlighting, unless the syntax
+--- uses `:syn-iskeyword`.
+---
+--- @type string
+vim.o.iskeyword = "@,48-57,_,192-255"
+vim.o.isk = vim.o.iskeyword
+vim.bo.iskeyword = vim.o.iskeyword
+vim.bo.isk = vim.bo.iskeyword
+
+--- The characters given by this option are displayed directly on the
+--- screen.  It is also used for "\p" in a `pattern`.  The characters from
+--- space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
+--- even when they are not included in 'isprint' or excluded.  See
+--- 'isfname' for a description of the format of this option.
+---
+--- Non-printable characters are displayed with two characters:
+--- 	  0 -  31	"^@" - "^_"
+--- 	 32 - 126	always single characters
+--- 	   127		"^?"
+--- 	128 - 159	"~@" - "~_"
+--- 	160 - 254	"| " - "|~"
+--- 	   255		"~?"
+--- Illegal bytes from 128 to 255 (invalid UTF-8) are
+--- displayed as <xx>, with the hexadecimal value of the byte.
+--- When 'display' contains "uhex" all unprintable characters are
+--- displayed as <xx>.
+--- The SpecialKey highlighting will be used for unprintable characters.
+--- `hl-SpecialKey`
+---
+--- Multi-byte characters 256 and above are always included, only the
+--- characters up to 255 are specified with this option.  When a character
+--- is printable but it is not available in the current font, a
+--- replacement character will be shown.
+--- Unprintable and zero-width Unicode characters are displayed as <xxxx>.
+--- There is no option to specify these characters.
+---
+--- @type string
+vim.o.isprint = "@,161-255"
+vim.o.isp = vim.o.isprint
+vim.go.isprint = vim.o.isprint
+vim.go.isp = vim.go.isprint
+
+--- Insert two spaces after a '.', '?' and '!' with a join command.
+--- Otherwise only one space is inserted.
+---
+--- @type boolean
+vim.o.joinspaces = false
+vim.o.js = vim.o.joinspaces
+vim.go.joinspaces = vim.o.joinspaces
+vim.go.js = vim.go.joinspaces
+
+--- List of words that change the behavior of the `jumplist`.
+---   stack         Make the jumplist behave like the tagstack or like a
+---                 web browser.  Relative location of entries in the
+--- 		jumplist is preserved at the cost of discarding
+--- 		subsequent entries when navigating backwards in the
+--- 		jumplist and then jumping to a location.
+--- 		`jumplist-stack`
+---
+---   view          When moving through the jumplist, `changelist|,
+--- 		|alternate-file` or using `mark-motions` try to
+--- 		restore the `mark-view` in which the action occurred.
+---
+--- @type string
+vim.o.jumpoptions = ""
+vim.o.jop = vim.o.jumpoptions
+vim.go.jumpoptions = vim.o.jumpoptions
+vim.go.jop = vim.go.jumpoptions
+
+--- Name of a keyboard mapping.  See `mbyte-keymap`.
+--- Setting this option to a valid keymap name has the side effect of
+--- setting 'iminsert' to one, so that the keymap becomes effective.
+--- 'imsearch' is also set to one, unless it was -1
+--- Only normal file name characters can be used, `/\*?[|<>` are illegal.
+---
+--- @type string
+vim.o.keymap = ""
+vim.o.kmp = vim.o.keymap
+vim.bo.keymap = vim.o.keymap
+vim.bo.kmp = vim.bo.keymap
+
+--- List of comma-separated words, which enable special things that keys
+--- can do.  These values can be used:
+---    startsel	Using a shifted special key starts selection (either
+--- 		Select mode or Visual mode, depending on "key" being
+--- 		present in 'selectmode').
+---    stopsel	Using a not-shifted special key stops selection.
+--- Special keys in this context are the cursor keys, <End>, <Home>,
+--- <PageUp> and <PageDown>.
+---
+--- @type string
+vim.o.keymodel = ""
+vim.o.km = vim.o.keymodel
+vim.go.keymodel = vim.o.keymodel
+vim.go.km = vim.go.keymodel
+
+--- Program to use for the `K` command.  Environment variables are
+--- expanded `:set_env`.  ":help" may be used to access the Vim internal
+--- help.  (Note that previously setting the global option to the empty
+--- value did this, which is now deprecated.)
+--- When the first character is ":", the command is invoked as a Vim
+--- Ex command prefixed with [count].
+--- When "man" or "man -s" is used, Vim will automatically translate
+--- a [count] for the "K" command to a section number.
+--- See `option-backslash` about including spaces and backslashes.
+--- Example:
+--- ```
+--- 	:set keywordprg=man\ -s
+--- 	:set keywordprg=:Man
+--- ```
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.keywordprg = ":Man"
+vim.o.kp = vim.o.keywordprg
+vim.bo.keywordprg = vim.o.keywordprg
+vim.bo.kp = vim.bo.keywordprg
+vim.go.keywordprg = vim.o.keywordprg
+vim.go.kp = vim.go.keywordprg
+
+--- This option allows switching your keyboard into a special language
+--- mode.  When you are typing text in Insert mode the characters are
+--- inserted directly.  When in Normal mode the 'langmap' option takes
+--- care of translating these special characters to the original meaning
+--- of the key.  This means you don't have to change the keyboard mode to
+--- be able to execute Normal mode commands.
+--- This is the opposite of the 'keymap' option, where characters are
+--- mapped in Insert mode.
+--- Also consider setting 'langremap' to off, to prevent 'langmap' from
+--- applying to characters resulting from a mapping.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- Example (for Greek, in UTF-8):				*greek*
+--- ```
+---     :set langmap=ΑA,ΒB,ΨC,ΔD,ΕE,ΦF,ΓG,ΗH,ΙI,ΞJ,ΚK,ΛL,ΜM,ΝN,ΟO,ΠP,QQ,ΡR,ΣS,ΤT,ΘU,ΩV,WW,ΧX,ΥY,ΖZ,αa,βb,ψc,δd,εe,φf,γg,ηh,ιi,ξj,κk,λl,μm,νn,οo,πp,qq,ρr,σs,τt,θu,ωv,ςw,χx,υy,ζz
+--- ```
+--- Example (exchanges meaning of z and y for commands):
+--- ```
+---     :set langmap=zy,yz,ZY,YZ
+--- ```
+--- The 'langmap' option is a list of parts, separated with commas.  Each
+--- part can be in one of two forms:
+--- 1.  A list of pairs.  Each pair is a "from" character immediately
+---     followed by the "to" character.  Examples: "aA", "aAbBcC".
+--- 2.  A list of "from" characters, a semi-colon and a list of "to"
+---     characters.  Example: "abc;ABC"
+--- Example: "aA,fgh;FGH,cCdDeE"
+--- Special characters need to be preceded with a backslash.  These are
+--- ";", ',', '"', '|' and backslash itself.
+---
+--- This will allow you to activate vim actions without having to switch
+--- back and forth between the languages.  Your language characters will
+--- be understood as normal vim English characters (according to the
+--- langmap mappings) in the following cases:
+---  o Normal/Visual mode (commands, buffer/register names, user mappings)
+---  o Insert/Replace Mode: Register names after CTRL-R
+---  o Insert/Replace Mode: Mappings
+--- Characters entered in Command-line mode will NOT be affected by
+--- this option.   Note that this option can be changed at any time
+--- allowing to switch between mappings for different languages/encodings.
+--- Use a mapping to avoid having to type it each time!
+---
+--- @type string
+vim.o.langmap = ""
+vim.o.lmap = vim.o.langmap
+vim.go.langmap = vim.o.langmap
+vim.go.lmap = vim.go.langmap
+
+--- Language to use for menu translation.  Tells which file is loaded
+--- from the "lang" directory in 'runtimepath':
+--- ```
+--- 	"lang/menu_" .. &langmenu .. ".vim"
+--- ```
+--- (without the spaces).  For example, to always use the Dutch menus, no
+--- matter what $LANG is set to:
+--- ```
+--- 	:set langmenu=nl_NL.ISO_8859-1
+--- ```
+--- When 'langmenu' is empty, `v:lang` is used.
+--- Only normal file name characters can be used, `/\*?[|<>` are illegal.
+--- If your $LANG is set to a non-English language but you do want to use
+--- the English menus:
+--- ```
+--- 	:set langmenu=none
+--- ```
+--- This option must be set before loading menus, switching on filetype
+--- detection or syntax highlighting.  Once the menus are defined setting
+--- this option has no effect.  But you could do this:
+--- ```
+--- 	:source $VIMRUNTIME/delmenu.vim
+--- 	:set langmenu=de_DE.ISO_8859-1
+--- 	:source $VIMRUNTIME/menu.vim
+--- ```
+--- Warning: This deletes all menus that you defined yourself!
+---
+--- @type string
+vim.o.langmenu = ""
+vim.o.lm = vim.o.langmenu
+vim.go.langmenu = vim.o.langmenu
+vim.go.lm = vim.go.langmenu
+
+--- When off, setting 'langmap' does not apply to characters resulting from
+--- a mapping.  If setting 'langmap' disables some of your mappings, make
+--- sure this option is off.
+---
+--- @type boolean
+vim.o.langremap = false
+vim.o.lrm = vim.o.langremap
+vim.go.langremap = vim.o.langremap
+vim.go.lrm = vim.go.langremap
+
+--- The value of this option influences when the last window will have a
+--- status line:
+--- 	0: never
+--- 	1: only if there are at least two windows
+--- 	2: always
+--- 	3: always and ONLY the last window
+--- The screen looks nicer with a status line if you have several
+--- windows, but it takes another screen line. `status-line`
+---
+--- @type integer
+vim.o.laststatus = 2
+vim.o.ls = vim.o.laststatus
+vim.go.laststatus = vim.o.laststatus
+vim.go.ls = vim.go.laststatus
+
+--- When this option is set, the screen will not be redrawn while
+--- executing macros, registers and other commands that have not been
+--- typed.  Also, updating the window title is postponed.  To force an
+--- update use `:redraw`.
+--- This may occasionally cause display errors.  It is only meant to be set
+--- temporarily when performing an operation where redrawing may cause
+--- flickering or cause a slow down.
+---
+--- @type boolean
+vim.o.lazyredraw = false
+vim.o.lz = vim.o.lazyredraw
+vim.go.lazyredraw = vim.o.lazyredraw
+vim.go.lz = vim.go.lazyredraw
+
+--- If on, Vim will wrap long lines at a character in 'breakat' rather
+--- than at the last character that fits on the screen.  Unlike
+--- 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
+--- it only affects the way the file is displayed, not its contents.
+--- If 'breakindent' is set, line is visually indented. Then, the value
+--- of 'showbreak' is used to put in front of wrapped lines. This option
+--- is not used when the 'wrap' option is off.
+--- Note that <Tab> characters after an <EOL> are mostly not displayed
+--- with the right amount of white space.
+---
+--- @type boolean
+vim.o.linebreak = false
+vim.o.lbr = vim.o.linebreak
+vim.wo.linebreak = vim.o.linebreak
+vim.wo.lbr = vim.wo.linebreak
+
+--- Number of lines of the Vim window.
+--- Normally you don't need to set this.  It is done automatically by the
+--- terminal initialization code.
+--- When Vim is running in the GUI or in a resizable window, setting this
+--- option will cause the window size to be changed.  When you only want
+--- to use the size for the GUI, put the command in your `gvimrc` file.
+--- Vim limits the number of lines to what fits on the screen.  You can
+--- use this command to get the tallest window possible:
+--- ```
+--- 	:set lines=999
+--- ```
+--- Minimum value is 2, maximum value is 1000.
+---
+--- @type integer
+vim.o.lines = 24
+vim.go.lines = vim.o.lines
+
+--- 		only in the GUI
+--- Number of pixel lines inserted between characters.  Useful if the font
+--- uses the full character cell height, making lines touch each other.
+--- When non-zero there is room for underlining.
+--- With some fonts there can be too much room between lines (to have
+--- space for ascents and descents).  Then it makes sense to set
+--- 'linespace' to a negative value.  This may cause display problems
+--- though!
+---
+--- @type integer
+vim.o.linespace = 0
+vim.o.lsp = vim.o.linespace
+vim.go.linespace = vim.o.linespace
+vim.go.lsp = vim.go.linespace
+
+--- Lisp mode: When <Enter> is typed in insert mode set the indent for
+--- the next line to Lisp standards (well, sort of).  Also happens with
+--- "cc" or "S".  'autoindent' must also be on for this to work.  The 'p'
+--- flag in 'cpoptions' changes the method of indenting: Vi compatible or
+--- better.  Also see 'lispwords'.
+--- The '-' character is included in keyword characters.  Redefines the
+--- "=" operator to use this same indentation algorithm rather than
+--- calling an external program if 'equalprg' is empty.
+---
+--- @type boolean
+vim.o.lisp = false
+vim.bo.lisp = vim.o.lisp
+
+--- Comma-separated list of items that influence the Lisp indenting when
+--- enabled with the `'lisp'` option.  Currently only one item is
+--- supported:
+--- 	expr:1	use 'indentexpr' for Lisp indenting when it is set
+--- 	expr:0	do not use 'indentexpr' for Lisp indenting (default)
+--- Note that when using 'indentexpr' the `=` operator indents all the
+--- lines, otherwise the first line is not indented (Vi-compatible).
+---
+--- @type string
+vim.o.lispoptions = ""
+vim.o.lop = vim.o.lispoptions
+vim.bo.lispoptions = vim.o.lispoptions
+vim.bo.lop = vim.bo.lispoptions
+
+--- Comma-separated list of words that influence the Lisp indenting when
+--- enabled with the `'lisp'` option.
+---
+--- @type string
+vim.o.lispwords = "defun,define,defmacro,set!,lambda,if,case,let,flet,let*,letrec,do,do*,define-syntax,let-syntax,letrec-syntax,destructuring-bind,defpackage,defparameter,defstruct,deftype,defvar,do-all-symbols,do-external-symbols,do-symbols,dolist,dotimes,ecase,etypecase,eval-when,labels,macrolet,multiple-value-bind,multiple-value-call,multiple-value-prog1,multiple-value-setq,prog1,progv,typecase,unless,unwind-protect,when,with-input-from-string,with-open-file,with-open-stream,with-output-to-string,with-package-iterator,define-condition,handler-bind,handler-case,restart-bind,restart-case,with-simple-restart,store-value,use-value,muffle-warning,abort,continue,with-slots,with-slots*,with-accessors,with-accessors*,defclass,defmethod,print-unreadable-object"
+vim.o.lw = vim.o.lispwords
+vim.bo.lispwords = vim.o.lispwords
+vim.bo.lw = vim.bo.lispwords
+vim.go.lispwords = vim.o.lispwords
+vim.go.lw = vim.go.lispwords
+
+--- List mode: By default, show tabs as ">", trailing spaces as "-", and
+--- non-breakable space characters as "+". Useful to see the difference
+--- between tabs and spaces and for trailing blanks. Further changed by
+--- the 'listchars' option.
+---
+--- The cursor is displayed at the start of the space a Tab character
+--- occupies, not at the end as usual in Normal mode.  To get this cursor
+--- position while displaying Tabs with spaces, use:
+--- ```
+--- 	:set list lcs=tab:\ \
+--- ```
+--- Note that list mode will also affect formatting (set with 'textwidth'
+--- or 'wrapmargin') when 'cpoptions' includes 'L'.  See 'listchars' for
+--- changing the way tabs are displayed.
+---
+--- @type boolean
+vim.o.list = false
+vim.wo.list = vim.o.list
+
+--- Strings to use in 'list' mode and for the `:list` command.  It is a
+--- comma-separated list of string settings.
+---
+--- 						*lcs-eol*
+---   eol:c		Character to show at the end of each line.  When
+--- 		omitted, there is no extra character at the end of the
+--- 		line.
+--- 						*lcs-tab*
+---   tab:xy[z]	Two or three characters to be used to show a tab.
+--- 		The third character is optional.
+---
+---   tab:xy	The 'x' is always used, then 'y' as many times as will
+--- 		fit.  Thus "tab:>-" displays:
+--- ```
+---
+--- ```
+--- 			>-
+--- 			>--
+--- 			etc.
+--- ```
+---   tab:xyz	The 'z' is always used, then 'x' is prepended, and
+--- 		then 'y' is used as many times as will fit.  Thus
+--- 		"tab:<->" displays:
+--- ```
+---
+--- ```
+--- 			<>
+--- 			<->
+--- 			<-->
+--- 			etc.
+--- ```
+--- 		When "tab:" is omitted, a tab is shown as ^I.
+--- 						*lcs-space*
+---   space:c	Character to show for a space.  When omitted, spaces
+--- 		are left blank.
+--- 						*lcs-multispace*
+---   multispace:c...
+--- 		One or more characters to use cyclically to show for
+--- 		multiple consecutive spaces.  Overrides the "space"
+--- 		setting, except for single spaces.  When omitted, the
+--- 		"space" setting is used.  For example,
+--- 		`:set listchars=multispace:---+` shows ten consecutive
+--- 		spaces as:
+--- ```
+--- 			---+---+--
+--- ```
+--- 						*lcs-lead*
+---   lead:c	Character to show for leading spaces.  When omitted,
+--- 		leading spaces are blank.  Overrides the "space" and
+--- 		"multispace" settings for leading spaces.  You can
+--- 		combine it with "tab:", for example:
+--- ```
+--- 			:set listchars+=tab:>-,lead:.
+--- ```
+--- 						*lcs-leadmultispace*
+---   leadmultispace:c...
+--- 		Like the `lcs-multispace` value, but for leading
+--- 		spaces only.  Also overrides `lcs-lead` for leading
+--- 		multiple spaces.
+--- 		`:set listchars=leadmultispace:---+` shows ten
+--- 		consecutive leading spaces as:
+--- ```
+--- 			---+---+--XXX
+--- ```
+--- 		Where "XXX" denotes the first non-blank characters in
+--- 		the line.
+--- 						*lcs-trail*
+---   trail:c	Character to show for trailing spaces.  When omitted,
+--- 		trailing spaces are blank.  Overrides the "space" and
+--- 		"multispace" settings for trailing spaces.
+--- 						*lcs-extends*
+---   extends:c	Character to show in the last column, when 'wrap' is
+--- 		off and the line continues beyond the right of the
+--- 		screen.
+--- 						*lcs-precedes*
+---   precedes:c	Character to show in the first visible column of the
+--- 		physical line, when there is text preceding the
+--- 		character visible in the first column.
+--- 						*lcs-conceal*
+---   conceal:c	Character to show in place of concealed text, when
+--- 		'conceallevel' is set to 1.  A space when omitted.
+--- 						*lcs-nbsp*
+---   nbsp:c	Character to show for a non-breakable space character
+--- 		(0xA0 (160 decimal) and U+202F).  Left blank when
+--- 		omitted.
+---
+--- The characters ':' and ',' should not be used.  UTF-8 characters can
+--- be used.  All characters must be single width.
+---
+--- Each character can be specified as hex:
+--- ```
+--- 	set listchars=eol:\\x24
+--- 	set listchars=eol:\\u21b5
+--- 	set listchars=eol:\\U000021b5
+--- ```
+--- Note that a double backslash is used.  The number of hex characters
+--- must be exactly 2 for \\x, 4 for \\u and 8 for \\U.
+---
+--- Examples:
+--- ```
+---     :set lcs=tab:>-,trail:-
+---     :set lcs=tab:>-,eol:<,nbsp:%
+---     :set lcs=extends:>,precedes:<
+--- ```
+--- `hl-NonText` highlighting will be used for "eol", "extends" and
+--- "precedes". `hl-Whitespace` for "nbsp", "space", "tab", "multispace",
+--- "lead" and "trail".
+---
+--- @type string
+vim.o.listchars = "tab:> ,trail:-,nbsp:+"
+vim.o.lcs = vim.o.listchars
+vim.wo.listchars = vim.o.listchars
+vim.wo.lcs = vim.wo.listchars
+vim.go.listchars = vim.o.listchars
+vim.go.lcs = vim.go.listchars
+
+--- When on the plugin scripts are loaded when starting up `load-plugins`.
+--- This option can be reset in your `vimrc` file to disable the loading
+--- of plugins.
+--- Note that using the "-u NONE" and "--noplugin" command line arguments
+--- reset this option. `-u` `--noplugin`
+---
+--- @type boolean
+vim.o.loadplugins = true
+vim.o.lpl = vim.o.loadplugins
+vim.go.loadplugins = vim.o.loadplugins
+vim.go.lpl = vim.go.loadplugins
+
+--- Changes the special characters that can be used in search patterns.
+--- See `pattern`.
+--- WARNING: Switching this option off most likely breaks plugins!  That
+--- is because many patterns assume it's on and will fail when it's off.
+--- Only switch it off when working with old Vi scripts.  In any other
+--- situation write patterns that work when 'magic' is on.  Include "\M"
+--- when you want to `/\M`.
+---
+--- @type boolean
+vim.o.magic = true
+vim.go.magic = vim.o.magic
+
+--- Name of the errorfile for the `:make` command (see `:make_makeprg`)
+--- and the `:grep` command.
+--- When it is empty, an internally generated temp file will be used.
+--- When "##" is included, it is replaced by a number to make the name
+--- unique.  This makes sure that the ":make" command doesn't overwrite an
+--- existing file.
+--- NOT used for the ":cf" command.  See 'errorfile' for that.
+--- Environment variables are expanded `:set_env`.
+--- See `option-backslash` about including spaces and backslashes.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.makeef = ""
+vim.o.mef = vim.o.makeef
+vim.go.makeef = vim.o.makeef
+vim.go.mef = vim.go.makeef
+
+--- Encoding used for reading the output of external commands.  When empty,
+--- encoding is not converted.
+--- This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
+--- `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
+--- and `:laddfile`.
+---
+--- This would be mostly useful when you use MS-Windows.  If iconv is
+--- enabled, setting 'makeencoding' to "char" has the same effect as
+--- setting to the system locale encoding.  Example:
+--- ```
+--- 	:set makeencoding=char	" system locale is used
+--- ```
+---
+--- @type string
+vim.o.makeencoding = ""
+vim.o.menc = vim.o.makeencoding
+vim.bo.makeencoding = vim.o.makeencoding
+vim.bo.menc = vim.bo.makeencoding
+vim.go.makeencoding = vim.o.makeencoding
+vim.go.menc = vim.go.makeencoding
+
+--- Program to use for the ":make" command.  See `:make_makeprg`.
+--- This option may contain '%' and '#' characters (see  `:_%` and `:_#`),
+--- which are expanded to the current and alternate file name.  Use `::S`
+--- to escape file names in case they contain special characters.
+--- Environment variables are expanded `:set_env`.  See `option-backslash`
+--- about including spaces and backslashes.
+--- Note that a '|' must be escaped twice: once for ":set" and once for
+--- the interpretation of a command.  When you use a filter called
+--- "myfilter" do it like this:
+--- ```
+---     :set makeprg=gmake\ \\\|\ myfilter
+--- ```
+--- The placeholder "$*" can be given (even multiple times) to specify
+--- where the arguments will be included, for example:
+--- ```
+---     :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
+--- ```
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.makeprg = "make"
+vim.o.mp = vim.o.makeprg
+vim.bo.makeprg = vim.o.makeprg
+vim.bo.mp = vim.bo.makeprg
+vim.go.makeprg = vim.o.makeprg
+vim.go.mp = vim.go.makeprg
+
+--- Characters that form pairs.  The `%` command jumps from one to the
+--- other.
+--- Only character pairs are allowed that are different, thus you cannot
+--- jump between two double quotes.
+--- The characters must be separated by a colon.
+--- The pairs must be separated by a comma.  Example for including '<' and
+--- '>' (for HTML):
+--- ```
+--- 	:set mps+=<:>
+---
+--- ```
+--- A more exotic example, to jump between the '=' and ';' in an
+--- assignment, useful for languages like C and Java:
+--- ```
+--- 	:au FileType c,cpp,java set mps+==:;
+---
+--- ```
+--- For a more advanced way of using "%", see the matchit.vim plugin in
+--- the $VIMRUNTIME/plugin directory. `add-local-help`
+---
+--- @type string
+vim.o.matchpairs = "(:),{:},[:]"
+vim.o.mps = vim.o.matchpairs
+vim.bo.matchpairs = vim.o.matchpairs
+vim.bo.mps = vim.bo.matchpairs
+
+--- Tenths of a second to show the matching paren, when 'showmatch' is
+--- set.  Note that this is not in milliseconds, like other options that
+--- set a time.  This is to be compatible with Nvi.
+---
+--- @type integer
+vim.o.matchtime = 5
+vim.o.mat = vim.o.matchtime
+vim.go.matchtime = vim.o.matchtime
+vim.go.mat = vim.go.matchtime
+
+--- Maximum depth of function calls for user functions.  This normally
+--- catches endless recursion.  When using a recursive function with
+--- more depth, set 'maxfuncdepth' to a bigger number.  But this will use
+--- more memory, there is the danger of failing when memory is exhausted.
+--- Increasing this limit above 200 also changes the maximum for Ex
+--- command recursion, see `E169`.
+--- See also `:function`.
+---
+--- @type integer
+vim.o.maxfuncdepth = 100
+vim.o.mfd = vim.o.maxfuncdepth
+vim.go.maxfuncdepth = vim.o.maxfuncdepth
+vim.go.mfd = vim.go.maxfuncdepth
+
+--- Maximum number of times a mapping is done without resulting in a
+--- character to be used.  This normally catches endless mappings, like
+--- ":map x y" with ":map y x".  It still does not catch ":map g wg",
+--- because the 'w' is used before the next mapping is done.  See also
+--- `key-mapping`.
+---
+--- @type integer
+vim.o.maxmapdepth = 1000
+vim.o.mmd = vim.o.maxmapdepth
+vim.go.maxmapdepth = vim.o.maxmapdepth
+vim.go.mmd = vim.go.maxmapdepth
+
+--- Maximum amount of memory (in Kbyte) to use for pattern matching.
+--- The maximum value is about 2000000.  Use this to work without a limit.
+--- 						*E363*
+--- When Vim runs into the limit it gives an error message and mostly
+--- behaves like CTRL-C was typed.
+--- Running into the limit often means that the pattern is very
+--- inefficient or too complex.  This may already happen with the pattern
+--- "\(.\)*" on a very long line.  ".*" works much better.
+--- Might also happen on redraw, when syntax rules try to match a complex
+--- text structure.
+--- Vim may run out of memory before hitting the 'maxmempattern' limit, in
+--- which case you get an "Out of memory" error instead.
+---
+--- @type integer
+vim.o.maxmempattern = 1000
+vim.o.mmp = vim.o.maxmempattern
+vim.go.maxmempattern = vim.o.maxmempattern
+vim.go.mmp = vim.go.maxmempattern
+
+--- Maximum number of items to use in a menu.  Used for menus that are
+--- generated from a list of items, e.g., the Buffers menu.  Changing this
+--- option has no direct effect, the menu must be refreshed first.
+---
+--- @type integer
+vim.o.menuitems = 25
+vim.o.mis = vim.o.menuitems
+vim.go.menuitems = vim.o.menuitems
+vim.go.mis = vim.go.menuitems
+
+--- Parameters for `:mkspell`.  This tunes when to start compressing the
+--- word tree.  Compression can be slow when there are many words, but
+--- it's needed to avoid running out of memory.  The amount of memory used
+--- per word depends very much on how similar the words are, that's why
+--- this tuning is complicated.
+---
+--- There are three numbers, separated by commas:
+--- ```
+--- 	{start},{inc},{added}
+--- ```
+--- For most languages the uncompressed word tree fits in memory.  {start}
+--- gives the amount of memory in Kbyte that can be used before any
+--- compression is done.  It should be a bit smaller than the amount of
+--- memory that is available to Vim.
+---
+--- When going over the {start} limit the {inc} number specifies the
+--- amount of memory in Kbyte that can be allocated before another
+--- compression is done.  A low number means compression is done after
+--- less words are added, which is slow.  A high number means more memory
+--- will be allocated.
+---
+--- After doing compression, {added} times 1024 words can be added before
+--- the {inc} limit is ignored and compression is done when any extra
+--- amount of memory is needed.  A low number means there is a smaller
+--- chance of hitting the {inc} limit, less memory is used but it's
+--- slower.
+---
+--- The languages for which these numbers are important are Italian and
+--- Hungarian.  The default works for when you have about 512 Mbyte.  If
+--- you have 1 Gbyte you could use:
+--- ```
+--- 	:set mkspellmem=900000,3000,800
+--- ```
+--- If you have less than 512 Mbyte `:mkspell` may fail for some
+--- languages, no matter what you set 'mkspellmem' to.
+---
+--- This option cannot be set from a `modeline` or in the `sandbox`.
+---
+--- @type string
+vim.o.mkspellmem = "460000,2000,500"
+vim.o.msm = vim.o.mkspellmem
+vim.go.mkspellmem = vim.o.mkspellmem
+vim.go.msm = vim.go.mkspellmem
+
+--- If 'modeline' is on 'modelines' gives the number of lines that is
+--- checked for set commands.  If 'modeline' is off or 'modelines' is zero
+--- no lines are checked.  See `modeline`.
+---
+--- @type boolean
+vim.o.modeline = true
+vim.o.ml = vim.o.modeline
+vim.bo.modeline = vim.o.modeline
+vim.bo.ml = vim.bo.modeline
+
+--- When on allow some options that are an expression to be set in the
+--- modeline.  Check the option for whether it is affected by
+--- 'modelineexpr'.  Also see `modeline`.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type boolean
+vim.o.modelineexpr = false
+vim.o.mle = vim.o.modelineexpr
+vim.go.modelineexpr = vim.o.modelineexpr
+vim.go.mle = vim.go.modelineexpr
+
+--- If 'modeline' is on 'modelines' gives the number of lines that is
+--- checked for set commands.  If 'modeline' is off or 'modelines' is zero
+--- no lines are checked.  See `modeline`.
+---
+---
+--- @type integer
+vim.o.modelines = 5
+vim.o.mls = vim.o.modelines
+vim.go.modelines = vim.o.modelines
+vim.go.mls = vim.go.modelines
+
+--- When off the buffer contents cannot be changed.  The 'fileformat' and
+--- 'fileencoding' options also can't be changed.
+--- Can be reset on startup with the `-M` command line argument.
+---
+--- @type boolean
+vim.o.modifiable = true
+vim.o.ma = vim.o.modifiable
+vim.bo.modifiable = vim.o.modifiable
+vim.bo.ma = vim.bo.modifiable
+
+--- When on, the buffer is considered to be modified.  This option is set
+--- when:
+--- 1. A change was made to the text since it was last written.  Using the
+---    `undo` command to go back to the original text will reset the
+---    option.  But undoing changes that were made before writing the
+---    buffer will set the option again, since the text is different from
+---    when it was written.
+--- 2. 'fileformat' or 'fileencoding' is different from its original
+---    value.  The original value is set when the buffer is read or
+---    written.  A ":set nomodified" command also resets the original
+---    values to the current values and the 'modified' option will be
+---    reset.
+---    Similarly for 'eol' and 'bomb'.
+--- This option is not set when a change is made to the buffer as the
+--- result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
+--- FileAppendPost or VimLeave autocommand event.  See `gzip-example` for
+--- an explanation.
+--- When 'buftype' is "nowrite" or "nofile" this option may be set, but
+--- will be ignored.
+--- Note that the text may actually be the same, e.g. 'modified' is set
+--- when using "rA" on an "A".
+---
+--- @type boolean
+vim.o.modified = false
+vim.o.mod = vim.o.modified
+vim.bo.modified = vim.o.modified
+vim.bo.mod = vim.bo.modified
+
+--- When on, listings pause when the whole screen is filled.  You will get
+--- the `more-prompt`.  When this option is off there are no pauses, the
+--- listing continues until finished.
+---
+--- @type boolean
+vim.o.more = true
+vim.go.more = vim.o.more
+
+--- Enables mouse support. For example, to enable the mouse in Normal mode
+--- and Visual mode:
+--- ```
+--- 	:set mouse=nv
+--- ```
+--- To temporarily disable mouse support, hold the shift key while using
+--- the mouse.
+---
+--- Mouse support can be enabled for different modes:
+--- 	n	Normal mode
+--- 	v	Visual mode
+--- 	i	Insert mode
+--- 	c	Command-line mode
+--- 	h	all previous modes when editing a help file
+--- 	a	all previous modes
+--- 	r	for `hit-enter` and `more-prompt` prompt
+---
+--- Left-click anywhere in a text buffer to place the cursor there.  This
+--- works with operators too, e.g. type `d` then left-click to delete text
+--- from the current cursor position to the position where you clicked.
+---
+--- Drag the `status-line` or vertical separator of a window to resize it.
+---
+--- If enabled for "v" (Visual mode) then double-click selects word-wise,
+--- triple-click makes it line-wise, and quadruple-click makes it
+--- rectangular block-wise.
+---
+--- For scrolling with a mouse wheel see `scroll-mouse-wheel`.
+---
+--- Note: When enabling the mouse in a terminal, copy/paste will use the
+--- "* register if possible. See also 'clipboard'.
+---
+--- Related options:
+--- 'mousefocus'	window focus follows mouse pointer
+--- 'mousemodel'	what mouse button does which action
+--- 'mousehide'	hide mouse pointer while typing text
+--- 'selectmode'	whether to start Select mode or Visual mode
+---
+--- @type string
+vim.o.mouse = "nvi"
+vim.go.mouse = vim.o.mouse
+
+--- The window that the mouse pointer is on is automatically activated.
+--- When changing the window layout or window focus in another way, the
+--- mouse pointer is moved to the window with keyboard focus.  Off is the
+--- default because it makes using the pull down menus a little goofy, as
+--- a pointer transit may activate a window unintentionally.
+---
+--- @type boolean
+vim.o.mousefocus = false
+vim.o.mousef = vim.o.mousefocus
+vim.go.mousefocus = vim.o.mousefocus
+vim.go.mousef = vim.go.mousefocus
+
+--- 		only in the GUI
+--- When on, the mouse pointer is hidden when characters are typed.
+--- The mouse pointer is restored when the mouse is moved.
+---
+--- @type boolean
+vim.o.mousehide = true
+vim.o.mh = vim.o.mousehide
+vim.go.mousehide = vim.o.mousehide
+vim.go.mh = vim.go.mousehide
+
+--- Sets the model to use for the mouse.  The name mostly specifies what
+--- the right mouse button is used for:
+---    extend	Right mouse button extends a selection.  This works
+--- 		like in an xterm.
+---    popup	Right mouse button pops up a menu.  The shifted left
+--- 		mouse button extends a selection.  This works like
+--- 		with Microsoft Windows.
+---    popup_setpos Like "popup", but the cursor will be moved to the
+--- 		position where the mouse was clicked, and thus the
+--- 		selected operation will act upon the clicked object.
+--- 		If clicking inside a selection, that selection will
+--- 		be acted upon, i.e. no cursor move.  This implies of
+--- 		course, that right clicking outside a selection will
+--- 		end Visual mode.
+--- Overview of what button does what for each model:
+--- mouse		    extend		popup(_setpos) ~
+--- left click	    place cursor	place cursor
+--- left drag	    start selection	start selection
+--- shift-left	    search word		extend selection
+--- right click	    extend selection	popup menu (place cursor)
+--- right drag	    extend selection	-
+--- middle click	    paste		paste
+---
+--- In the "popup" model the right mouse button produces a pop-up menu.
+--- Nvim creates a default `popup-menu` but you can redefine it.
+---
+--- Note that you can further refine the meaning of buttons with mappings.
+--- See `mouse-overview`.  But mappings are NOT used for modeless selection.
+---
+--- Example:
+--- ```
+---    :map <S-LeftMouse>     <RightMouse>
+---    :map <S-LeftDrag>      <RightDrag>
+---    :map <S-LeftRelease>   <RightRelease>
+---    :map <2-S-LeftMouse>   <2-RightMouse>
+---    :map <2-S-LeftDrag>    <2-RightDrag>
+---    :map <2-S-LeftRelease> <2-RightRelease>
+---    :map <3-S-LeftMouse>   <3-RightMouse>
+---    :map <3-S-LeftDrag>    <3-RightDrag>
+---    :map <3-S-LeftRelease> <3-RightRelease>
+---    :map <4-S-LeftMouse>   <4-RightMouse>
+---    :map <4-S-LeftDrag>    <4-RightDrag>
+---    :map <4-S-LeftRelease> <4-RightRelease>
+--- ```
+--- Mouse commands requiring the CTRL modifier can be simulated by typing
+--- the "g" key before using the mouse:
+---     "g<LeftMouse>"  is "<C-LeftMouse>	(jump to tag under mouse click)
+---     "g<RightMouse>" is "<C-RightMouse>	("CTRL-T")
+---
+--- @type string
+vim.o.mousemodel = "popup_setpos"
+vim.o.mousem = vim.o.mousemodel
+vim.go.mousemodel = vim.o.mousemodel
+vim.go.mousem = vim.go.mousemodel
+
+--- When on, mouse move events are delivered to the input queue and are
+--- available for mapping. The default, off, avoids the mouse movement
+--- overhead except when needed.
+--- Warning: Setting this option can make pending mappings to be aborted
+--- when the mouse is moved.
+---
+--- @type boolean
+vim.o.mousemoveevent = false
+vim.o.mousemev = vim.o.mousemoveevent
+vim.go.mousemoveevent = vim.o.mousemoveevent
+vim.go.mousemev = vim.go.mousemoveevent
+
+--- This option controls the number of lines / columns to scroll by when
+--- scrolling with a mouse. The option is a comma separated list of parts.
+--- Each part consists of a direction and a count as follows:
+--- 	direction:count,direction:count
+--- Direction is one of either "hor" or "ver". "hor" controls horizontal
+--- scrolling and "ver" controls vertical scrolling. Count sets the amount
+--- to scroll by for the given direction, it should be a non negative
+--- integer. Each direction should be set at most once. If a direction
+--- is omitted, a default value is used (6 for horizontal scrolling and 3
+--- for vertical scrolling). You can disable mouse scrolling by using
+--- a count of 0.
+---
+--- Example:
+--- ```
+--- 	:set mousescroll=ver:5,hor:2
+--- ```
+--- Will make Nvim scroll 5 lines at a time when scrolling vertically, and
+--- scroll 2 columns at a time when scrolling horizontally.
+---
+--- @type string
+vim.o.mousescroll = "ver:3,hor:6"
+vim.go.mousescroll = vim.o.mousescroll
+
+--- This option tells Vim what the mouse pointer should look like in
+--- different modes.  The option is a comma-separated list of parts, much
+--- like used for 'guicursor'.  Each part consist of a mode/location-list
+--- and an argument-list:
+--- 	mode-list:shape,mode-list:shape,..
+--- The mode-list is a dash separated list of these modes/locations:
+--- 		In a normal window: ~
+--- 	n	Normal mode
+--- 	v	Visual mode
+--- 	ve	Visual mode with 'selection' "exclusive" (same as 'v',
+--- 		if not specified)
+--- 	o	Operator-pending mode
+--- 	i	Insert mode
+--- 	r	Replace mode
+---
+--- 		Others: ~
+--- 	c	appending to the command-line
+--- 	ci	inserting in the command-line
+--- 	cr	replacing in the command-line
+--- 	m	at the 'Hit ENTER' or 'More' prompts
+--- 	ml	idem, but cursor in the last line
+--- 	e	any mode, pointer below last window
+--- 	s	any mode, pointer on a status line
+--- 	sd	any mode, while dragging a status line
+--- 	vs	any mode, pointer on a vertical separator line
+--- 	vd	any mode, while dragging a vertical separator line
+--- 	a	everywhere
+---
+--- The shape is one of the following:
+--- avail	name		looks like ~
+--- w x	arrow		Normal mouse pointer
+--- w x	blank		no pointer at all (use with care!)
+--- w x	beam		I-beam
+--- w x	updown		up-down sizing arrows
+--- w x	leftright	left-right sizing arrows
+--- w x	busy		The system's usual busy pointer
+--- w x	no		The system's usual "no input" pointer
+---   x	udsizing	indicates up-down resizing
+---   x	lrsizing	indicates left-right resizing
+---   x	crosshair	like a big thin +
+---   x	hand1		black hand
+---   x	hand2		white hand
+---   x	pencil		what you write with
+---   x	question	big ?
+---   x	rightup-arrow	arrow pointing right-up
+--- w x	up-arrow	arrow pointing up
+---   x	<number>	any X11 pointer number (see X11/cursorfont.h)
+---
+--- The "avail" column contains a 'w' if the shape is available for Win32,
+--- x for X11.
+--- Any modes not specified or shapes not available use the normal mouse
+--- pointer.
+---
+--- Example:
+--- ```
+--- 	:set mouseshape=s:udsizing,m:no
+--- ```
+--- will make the mouse turn to a sizing arrow over the status lines and
+--- indicate no input when the hit-enter prompt is displayed (since
+--- clicking the mouse has no effect in this state.)
+---
+--- @type string
+vim.o.mouseshape = ""
+vim.o.mouses = vim.o.mouseshape
+vim.go.mouseshape = vim.o.mouseshape
+vim.go.mouses = vim.go.mouseshape
+
+--- Defines the maximum time in msec between two mouse clicks for the
+--- second click to be recognized as a multi click.
+---
+--- @type integer
+vim.o.mousetime = 500
+vim.o.mouset = vim.o.mousetime
+vim.go.mousetime = vim.o.mousetime
+vim.go.mouset = vim.go.mousetime
+
+--- This defines what bases Vim will consider for numbers when using the
+--- CTRL-A and CTRL-X commands for adding to and subtracting from a number
+--- respectively; see `CTRL-A` for more info on these commands.
+--- alpha	If included, single alphabetical characters will be
+--- 	incremented or decremented.  This is useful for a list with a
+--- 	letter index a), b), etc.		*octal-nrformats*
+--- octal	If included, numbers that start with a zero will be considered
+--- 	to be octal.  Example: Using CTRL-A on "007" results in "010".
+--- hex	If included, numbers starting with "0x" or "0X" will be
+--- 	considered to be hexadecimal.  Example: Using CTRL-X on
+--- 	"0x100" results in "0x0ff".
+--- bin	If included, numbers starting with "0b" or "0B" will be
+--- 	considered to be binary.  Example: Using CTRL-X on
+--- 	"0b1000" subtracts one, resulting in "0b0111".
+--- unsigned    If included, numbers are recognized as unsigned. Thus a
+--- 	leading dash or negative sign won't be considered as part of
+--- 	the number.  Examples:
+--- 	    Using CTRL-X on "2020" in "9-2020" results in "9-2019"
+--- 	    (without "unsigned" it would become "9-2021").
+--- 	    Using CTRL-A on "2020" in "9-2020" results in "9-2021"
+--- 	    (without "unsigned" it would become "9-2019").
+--- 	    Using CTRL-X on "0" or CTRL-A on "18446744073709551615"
+--- 	    (2^64 - 1) has no effect, overflow is prevented.
+--- Numbers which simply begin with a digit in the range 1-9 are always
+--- considered decimal.  This also happens for numbers that are not
+--- recognized as octal or hex.
+---
+--- @type string
+vim.o.nrformats = "bin,hex"
+vim.o.nf = vim.o.nrformats
+vim.bo.nrformats = vim.o.nrformats
+vim.bo.nf = vim.bo.nrformats
+
+--- Print the line number in front of each line.  When the 'n' option is
+--- excluded from 'cpoptions' a wrapped line will not use the column of
+--- line numbers.
+--- Use the 'numberwidth' option to adjust the room for the line number.
+--- When a long, wrapped line doesn't start with the first character, '-'
+--- characters are put before the number.
+--- For highlighting see `hl-LineNr`, `hl-CursorLineNr`, and the
+--- `:sign-define` "numhl" argument.
+--- 					*number_relativenumber*
+--- The 'relativenumber' option changes the displayed number to be
+--- relative to the cursor.  Together with 'number' there are these
+--- four combinations (cursor in line 3):
+---
+--- 	'nonu'          'nu'            'nonu'          'nu'
+--- 	'nornu'         'nornu'         'rnu'           'rnu'
+--- ```
+---     |apple          |  1 apple      |  2 apple      |  2 apple
+---     |pear           |  2 pear       |  1 pear       |  1 pear
+---     |nobody         |  3 nobody     |  0 nobody     |3   nobody
+---     |there          |  4 there      |  1 there      |  1 there
+--- ```
+---
+--- @type boolean
+vim.o.number = false
+vim.o.nu = vim.o.number
+vim.wo.number = vim.o.number
+vim.wo.nu = vim.wo.number
+
+--- Minimal number of columns to use for the line number.  Only relevant
+--- when the 'number' or 'relativenumber' option is set or printing lines
+--- with a line number. Since one space is always between the number and
+--- the text, there is one less character for the number itself.
+--- The value is the minimum width.  A bigger width is used when needed to
+--- fit the highest line number in the buffer respectively the number of
+--- rows in the window, depending on whether 'number' or 'relativenumber'
+--- is set. Thus with the Vim default of 4 there is room for a line number
+--- up to 999. When the buffer has 1000 lines five columns will be used.
+--- The minimum value is 1, the maximum value is 20.
+---
+--- @type integer
+vim.o.numberwidth = 4
+vim.o.nuw = vim.o.numberwidth
+vim.wo.numberwidth = vim.o.numberwidth
+vim.wo.nuw = vim.wo.numberwidth
+
+--- This option specifies a function to be used for Insert mode omni
+--- completion with CTRL-X CTRL-O. `i_CTRL-X_CTRL-O`
+--- See `complete-functions` for an explanation of how the function is
+--- invoked and what it should return.  The value can be the name of a
+--- function, a `lambda` or a `Funcref`. See `option-value-function` for
+--- more information.
+--- This option is usually set by a filetype plugin:
+--- `:filetype-plugin-on`
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.omnifunc = ""
+vim.o.ofu = vim.o.omnifunc
+vim.bo.omnifunc = vim.o.omnifunc
+vim.bo.ofu = vim.bo.omnifunc
+
+--- 		only for Windows
+--- Enable reading and writing from devices.  This may get Vim stuck on a
+--- device that can be opened but doesn't actually do the I/O.  Therefore
+--- it is off by default.
+--- Note that on Windows editing "aux.h", "lpt1.txt" and the like also
+--- result in editing a device.
+---
+--- @type boolean
+vim.o.opendevice = false
+vim.o.odev = vim.o.opendevice
+vim.go.opendevice = vim.o.opendevice
+vim.go.odev = vim.go.opendevice
+
+--- This option specifies a function to be called by the `g@` operator.
+--- See `:map-operator` for more info and an example.  The value can be
+--- the name of a function, a `lambda` or a `Funcref`. See
+--- `option-value-function` for more information.
+---
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.operatorfunc = ""
+vim.o.opfunc = vim.o.operatorfunc
+vim.go.operatorfunc = vim.o.operatorfunc
+vim.go.opfunc = vim.go.operatorfunc
+
+--- Directories used to find packages.
+--- See `packages` and `packages-runtimepath`.
+---
+--- @type string
+vim.o.packpath = "..."
+vim.o.pp = vim.o.packpath
+vim.go.packpath = vim.o.packpath
+vim.go.pp = vim.go.packpath
+
+--- Specifies the nroff macros that separate paragraphs.  These are pairs
+--- of two letters (see `object-motions`).
+---
+--- @type string
+vim.o.paragraphs = "IPLPPPQPP TPHPLIPpLpItpplpipbp"
+vim.o.para = vim.o.paragraphs
+vim.go.paragraphs = vim.o.paragraphs
+vim.go.para = vim.go.paragraphs
+
+--- Expression which is evaluated to apply a patch to a file and generate
+--- the resulting new version of the file.  See `diff-patchexpr`.
+---
+--- @type string
+vim.o.patchexpr = ""
+vim.o.pex = vim.o.patchexpr
+vim.go.patchexpr = vim.o.patchexpr
+vim.go.pex = vim.go.patchexpr
+
+--- When non-empty the oldest version of a file is kept.  This can be used
+--- to keep the original version of a file if you are changing files in a
+--- source distribution.  Only the first time that a file is written a
+--- copy of the original file will be kept.  The name of the copy is the
+--- name of the original file with the string in the 'patchmode' option
+--- appended.  This option should start with a dot.  Use a string like
+--- ".orig" or ".org".  'backupdir' must not be empty for this to work
+--- (Detail: The backup file is renamed to the patchmode file after the
+--- new file has been successfully written, that's why it must be possible
+--- to write a backup file).  If there was no file to be backed up, an
+--- empty file is created.
+--- When the 'backupskip' pattern matches, a patchmode file is not made.
+--- Using 'patchmode' for compressed files appends the extension at the
+--- end (e.g., "file.gz.orig"), thus the resulting name isn't always
+--- recognized as a compressed file.
+--- Only normal file name characters can be used, `/\*?[|<>` are illegal.
+---
+--- @type string
+vim.o.patchmode = ""
+vim.o.pm = vim.o.patchmode
+vim.go.patchmode = vim.o.patchmode
+vim.go.pm = vim.go.patchmode
+
+--- This is a list of directories which will be searched when using the
+--- `gf`, [f, ]f, ^Wf, `:find`, `:sfind`, `:tabfind` and other commands,
+--- provided that the file being searched for has a relative path (not
+--- starting with "/", "./" or "../").  The directories in the 'path'
+--- option may be relative or absolute.
+--- - Use commas to separate directory names:
+--- ```
+--- 	:set path=.,/usr/local/include,/usr/include
+--- ```
+--- - To include a comma in a directory name precede it with an extra
+---   backslash:
+--- ```
+--- 	:set path=.,/dir/with\\,comma
+--- ```
+--- - To search relative to the directory of the current file, use:
+--- ```
+--- 	:set path=.
+--- ```
+--- - To search in the current directory use an empty string between two
+---   commas:
+--- ```
+--- 	:set path=,,
+--- ```
+--- - A directory name may end in a ':' or '/'.
+--- - Environment variables are expanded `:set_env`.
+--- - When using `netrw.vim` URLs can be used.  For example, adding
+---   "https://www.vim.org" will make ":find index.html" work.
+--- - Search upwards and downwards in a directory tree using "*", "**" and
+---   ";".  See `file-searching` for info and syntax.
+--- - Careful with '\' characters, type two to get one in the option:
+--- ```
+--- 	:set path=.,c:\\include
+--- ```
+--- Or just use '/' instead:
+--- ```
+--- 	:set path=.,c:/include
+--- ```
+--- Don't forget "." or files won't even be found in the same directory as
+--- the file!
+--- The maximum length is limited.  How much depends on the system, mostly
+--- it is something like 256 or 1024 characters.
+--- You can check if all the include files are found, using the value of
+--- 'path', see `:checkpath`.
+--- The use of `:set+=` and `:set-=` is preferred when adding or removing
+--- directories from the list.  This avoids problems when a future version
+--- uses another default.  To remove the current directory use:
+--- ```
+--- 	:set path-=
+--- ```
+--- To add the current directory use:
+--- ```
+--- 	:set path+=
+--- ```
+--- To use an environment variable, you probably need to replace the
+--- separator.  Here is an example to append $INCL, in which directory
+--- names are separated with a semi-colon:
+--- ```
+--- 	:let &path = &path .. "," .. substitute($INCL, ';', ',', 'g')
+--- ```
+--- Replace the ';' with a ':' or whatever separator is used.  Note that
+--- this doesn't work when $INCL contains a comma or white space.
+---
+--- @type string
+vim.o.path = ".,,"
+vim.o.pa = vim.o.path
+vim.bo.path = vim.o.path
+vim.bo.pa = vim.bo.path
+vim.go.path = vim.o.path
+vim.go.pa = vim.go.path
+
+--- When changing the indent of the current line, preserve as much of the
+--- indent structure as possible.  Normally the indent is replaced by a
+--- series of tabs followed by spaces as required (unless `'expandtab'` is
+--- enabled, in which case only spaces are used).  Enabling this option
+--- means the indent will preserve as many existing characters as possible
+--- for indenting, and only add additional tabs or spaces as required.
+--- 'expandtab' does not apply to the preserved white space, a Tab remains
+--- a Tab.
+--- NOTE: When using ">>" multiple times the resulting indent is a mix of
+--- tabs and spaces.  You might not like this.
+--- Also see 'copyindent'.
+--- Use `:retab` to clean up white space.
+---
+--- @type boolean
+vim.o.preserveindent = false
+vim.o.pi = vim.o.preserveindent
+vim.bo.preserveindent = vim.o.preserveindent
+vim.bo.pi = vim.bo.preserveindent
+
+--- Default height for a preview window.  Used for `:ptag` and associated
+--- commands.  Used for `CTRL-W_}` when no count is given.
+---
+--- @type integer
+vim.o.previewheight = 12
+vim.o.pvh = vim.o.previewheight
+vim.go.previewheight = vim.o.previewheight
+vim.go.pvh = vim.go.previewheight
+
+--- Identifies the preview window.  Only one window can have this option
+--- set.  It's normally not set directly, but by using one of the commands
+--- `:ptag`, `:pedit`, etc.
+---
+--- @type boolean
+vim.o.previewwindow = false
+vim.o.pvw = vim.o.previewwindow
+vim.wo.previewwindow = vim.o.previewwindow
+vim.wo.pvw = vim.wo.previewwindow
+
+--- Enables pseudo-transparency for the `popup-menu`. Valid values are in
+--- the range of 0 for fully opaque popupmenu (disabled) to 100 for fully
+--- transparent background. Values between 0-30 are typically most useful.
+---
+--- It is possible to override the level for individual highlights within
+--- the popupmenu using `highlight-blend`. For instance, to enable
+--- transparency but force the current selected element to be fully opaque:
+--- ```
+---
+--- 	:set pumblend=15
+--- 	:hi PmenuSel blend=0
+--- ```
+--- UI-dependent. Works best with RGB colors. 'termguicolors'
+---
+--- @type integer
+vim.o.pumblend = 0
+vim.o.pb = vim.o.pumblend
+vim.go.pumblend = vim.o.pumblend
+vim.go.pb = vim.go.pumblend
+
+--- Maximum number of items to show in the popup menu
+--- (`ins-completion-menu`). Zero means "use available screen space".
+---
+--- @type integer
+vim.o.pumheight = 0
+vim.o.ph = vim.o.pumheight
+vim.go.pumheight = vim.o.pumheight
+vim.go.ph = vim.go.pumheight
+
+--- Minimum width for the popup menu (`ins-completion-menu`).  If the
+--- cursor column + 'pumwidth' exceeds screen width, the popup menu is
+--- nudged to fit on the screen.
+---
+--- @type integer
+vim.o.pumwidth = 15
+vim.o.pw = vim.o.pumwidth
+vim.go.pumwidth = vim.o.pumwidth
+vim.go.pw = vim.go.pumwidth
+
+--- Specifies the python version used for pyx* functions and commands
+--- `python_x`.  As only Python 3 is supported, this always has the value
+--- `3`. Setting any other value is an error.
+---
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type integer
+vim.o.pyxversion = 3
+vim.o.pyx = vim.o.pyxversion
+vim.go.pyxversion = vim.o.pyxversion
+vim.go.pyx = vim.go.pyxversion
+
+--- This option specifies a function to be used to get the text to display
+--- in the quickfix and location list windows.  This can be used to
+--- customize the information displayed in the quickfix or location window
+--- for each entry in the corresponding quickfix or location list.  See
+--- `quickfix-window-function` for an explanation of how to write the
+--- function and an example.  The value can be the name of a function, a
+--- `lambda` or a `Funcref`. See `option-value-function` for more
+--- information.
+---
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.quickfixtextfunc = ""
+vim.o.qftf = vim.o.quickfixtextfunc
+vim.go.quickfixtextfunc = vim.o.quickfixtextfunc
+vim.go.qftf = vim.go.quickfixtextfunc
+
+--- The characters that are used to escape quotes in a string.  Used for
+--- objects like a', a" and a` `a'`.
+--- When one of the characters in this option is found inside a string,
+--- the following character will be skipped.  The default value makes the
+--- text "foo\"bar\\" considered to be one string.
+---
+--- @type string
+vim.o.quoteescape = "\\"
+vim.o.qe = vim.o.quoteescape
+vim.bo.quoteescape = vim.o.quoteescape
+vim.bo.qe = vim.bo.quoteescape
+
+--- If on, writes fail unless you use a '!'.  Protects you from
+--- accidentally overwriting a file.  Default on when Vim is started
+--- in read-only mode ("vim -R") or when the executable is called "view".
+--- When using ":w!" the 'readonly' option is reset for the current
+--- buffer, unless the 'Z' flag is in 'cpoptions'.
+--- When using the ":view" command the 'readonly' option is set for the
+--- newly edited buffer.
+--- See 'modifiable' for disallowing changes to the buffer.
+---
+--- @type boolean
+vim.o.readonly = false
+vim.o.ro = vim.o.readonly
+vim.bo.readonly = vim.o.readonly
+vim.bo.ro = vim.bo.readonly
+
+--- Flags to change the way redrawing works, for debugging purposes.
+--- Most useful with 'writedelay' set to some reasonable value.
+--- Supports the following flags:
+---     compositor	Indicate each redraw event handled by the compositor
+--- 		by briefly flashing the redrawn regions in colors
+--- 		indicating the redraw type. These are the highlight
+--- 		groups used (and their default colors):
+--- 	RedrawDebugNormal   gui=reverse   normal redraw passed through
+--- 	RedrawDebugClear    guibg=Yellow  clear event passed through
+--- 	RedrawDebugComposed guibg=Green   redraw event modified by the
+--- 					  compositor (due to
+--- 					  overlapping grids, etc)
+--- 	RedrawDebugRecompose guibg=Red    redraw generated by the
+--- 					  compositor itself, due to a
+--- 					  grid being moved or deleted.
+---     line	introduce a delay after each line drawn on the screen.
+--- 		When using the TUI or another single-grid UI, "compositor"
+--- 		gives more information and should be preferred (every
+--- 		line is processed as a separate event by the compositor)
+---     flush	introduce a delay after each "flush" event.
+---     nothrottle	Turn off throttling of the message grid. This is an
+--- 		optimization that joins many small scrolls to one
+--- 		larger scroll when drawing the message area (with
+--- 		'display' msgsep flag active).
+---     invalid	Enable stricter checking (abort) of inconsistencies
+--- 		of the internal screen state. This is mostly
+--- 		useful when running nvim inside a debugger (and
+--- 		the test suite).
+---     nodelta	Send all internally redrawn cells to the UI, even if
+--- 		they are unchanged from the already displayed state.
+---
+--- @type string
+vim.o.redrawdebug = ""
+vim.o.rdb = vim.o.redrawdebug
+vim.go.redrawdebug = vim.o.redrawdebug
+vim.go.rdb = vim.go.redrawdebug
+
+--- Time in milliseconds for redrawing the display.  Applies to
+--- 'hlsearch', 'inccommand', `:match` highlighting and syntax
+--- highlighting.
+--- When redrawing takes more than this many milliseconds no further
+--- matches will be highlighted.
+--- For syntax highlighting the time applies per window.  When over the
+--- limit syntax highlighting is disabled until `CTRL-L` is used.
+--- This is used to avoid that Vim hangs when using a very complicated
+--- pattern.
+---
+--- @type integer
+vim.o.redrawtime = 2000
+vim.o.rdt = vim.o.redrawtime
+vim.go.redrawtime = vim.o.redrawtime
+vim.go.rdt = vim.go.redrawtime
+
+--- This selects the default regexp engine. `two-engines`
+--- The possible values are:
+--- 	0	automatic selection
+--- 	1	old engine
+--- 	2	NFA engine
+--- Note that when using the NFA engine and the pattern contains something
+--- that is not supported the pattern will not match.  This is only useful
+--- for debugging the regexp engine.
+--- Using automatic selection enables Vim to switch the engine, if the
+--- default engine becomes too costly.  E.g., when the NFA engine uses too
+--- many states.  This should prevent Vim from hanging on a combination of
+--- a complex pattern with long text.
+---
+--- @type integer
+vim.o.regexpengine = 0
+vim.o.re = vim.o.regexpengine
+vim.go.regexpengine = vim.o.regexpengine
+vim.go.re = vim.go.regexpengine
+
+--- Show the line number relative to the line with the cursor in front of
+--- each line. Relative line numbers help you use the `count` you can
+--- precede some vertical motion commands (e.g. j k + -) with, without
+--- having to calculate it yourself. Especially useful in combination with
+--- other commands (e.g. y d c < > gq gw =).
+--- When the 'n' option is excluded from 'cpoptions' a wrapped
+--- line will not use the column of line numbers.
+--- The 'numberwidth' option can be used to set the room used for the line
+--- number.
+--- When a long, wrapped line doesn't start with the first character, '-'
+--- characters are put before the number.
+--- See `hl-LineNr`  and `hl-CursorLineNr` for the highlighting used for
+--- the number.
+---
+--- The number in front of the cursor line also depends on the value of
+--- 'number', see `number_relativenumber` for all combinations of the two
+--- options.
+---
+--- @type boolean
+vim.o.relativenumber = false
+vim.o.rnu = vim.o.relativenumber
+vim.wo.relativenumber = vim.o.relativenumber
+vim.wo.rnu = vim.wo.relativenumber
+
+--- Threshold for reporting number of lines changed.  When the number of
+--- changed lines is more than 'report' a message will be given for most
+--- ":" commands.  If you want it always, set 'report' to 0.
+--- For the ":substitute" command the number of substitutions is used
+--- instead of the number of lines.
+---
+--- @type integer
+vim.o.report = 2
+vim.go.report = vim.o.report
+
+--- Inserting characters in Insert mode will work backwards.  See "typing
+--- backwards" `ins-reverse`.  This option can be toggled with the CTRL-_
+--- command in Insert mode, when 'allowrevins' is set.
+---
+--- @type boolean
+vim.o.revins = false
+vim.o.ri = vim.o.revins
+vim.go.revins = vim.o.revins
+vim.go.ri = vim.go.revins
+
+--- When on, display orientation becomes right-to-left, i.e., characters
+--- that are stored in the file appear from the right to the left.
+--- Using this option, it is possible to edit files for languages that
+--- are written from the right to the left such as Hebrew and Arabic.
+--- This option is per window, so it is possible to edit mixed files
+--- simultaneously, or to view the same file in both ways (this is
+--- useful whenever you have a mixed text file with both right-to-left
+--- and left-to-right strings so that both sets are displayed properly
+--- in different windows).  Also see `rileft.txt`.
+---
+--- @type boolean
+vim.o.rightleft = false
+vim.o.rl = vim.o.rightleft
+vim.wo.rightleft = vim.o.rightleft
+vim.wo.rl = vim.wo.rightleft
+
+--- Each word in this option enables the command line editing to work in
+--- right-to-left mode for a group of commands:
+---
+--- 	search		"/" and "?" commands
+---
+--- This is useful for languages such as Hebrew, Arabic and Farsi.
+--- The 'rightleft' option must be set for 'rightleftcmd' to take effect.
+---
+--- @type string
+vim.o.rightleftcmd = "search"
+vim.o.rlc = vim.o.rightleftcmd
+vim.wo.rightleftcmd = vim.o.rightleftcmd
+vim.wo.rlc = vim.wo.rightleftcmd
+
+--- Show the line and column number of the cursor position, separated by a
+--- comma.  When there is room, the relative position of the displayed
+--- text in the file is shown on the far right:
+--- 	Top	first line is visible
+--- 	Bot	last line is visible
+--- 	All	first and last line are visible
+--- 	45%	relative position in the file
+--- If 'rulerformat' is set, it will determine the contents of the ruler.
+--- Each window has its own ruler.  If a window has a status line, the
+--- ruler is shown there.  If a window doesn't have a status line and
+--- 'cmdheight' is zero, the ruler is not shown.  Otherwise it is shown in
+--- the last line of the screen.  If the statusline is given by
+--- 'statusline' (i.e. not empty), this option takes precedence over
+--- 'ruler' and 'rulerformat'.
+--- If the number of characters displayed is different from the number of
+--- bytes in the text (e.g., for a TAB or a multibyte character), both
+--- the text column (byte number) and the screen column are shown,
+--- separated with a dash.
+--- For an empty line "0-1" is shown.
+--- For an empty buffer the line number will also be zero: "0,0-1".
+--- If you don't want to see the ruler all the time but want to know where
+--- you are, use "g CTRL-G" `g_CTRL-G`.
+---
+--- @type boolean
+vim.o.ruler = true
+vim.o.ru = vim.o.ruler
+vim.go.ruler = vim.o.ruler
+vim.go.ru = vim.go.ruler
+
+--- When this option is not empty, it determines the content of the ruler
+--- string, as displayed for the 'ruler' option.
+--- The format of this option is like that of 'statusline'.
+--- This option cannot be set in a modeline when 'modelineexpr' is off.
+---
+--- The default ruler width is 17 characters.  To make the ruler 15
+--- characters wide, put "%15(" at the start and "%)" at the end.
+--- Example:
+--- ```
+--- 	:set rulerformat=%15(%c%V\ %p%%%)
+--- ```
+---
+--- @type string
+vim.o.rulerformat = ""
+vim.o.ruf = vim.o.rulerformat
+vim.go.rulerformat = vim.o.rulerformat
+vim.go.ruf = vim.go.rulerformat
+
+--- List of directories to be searched for these runtime files:
+---   filetype.lua	filetypes `new-filetype`
+---   autoload/	automatically loaded scripts `autoload-functions`
+---   colors/	color scheme files `:colorscheme`
+---   compiler/	compiler files `:compiler`
+---   doc/		documentation `write-local-help`
+---   ftplugin/	filetype plugins `write-filetype-plugin`
+---   indent/	indent scripts `indent-expression`
+---   keymap/	key mapping files `mbyte-keymap`
+---   lang/		menu translations `:menutrans`
+---   lua/		`Lua` plugins
+---   menu.vim	GUI menus `menu.vim`
+---   pack/		packages `:packadd`
+---   parser/	`treesitter` syntax parsers
+---   plugin/	plugin scripts `write-plugin`
+---   queries/	`treesitter` queries
+---   rplugin/	`remote-plugin` scripts
+---   spell/	spell checking files `spell`
+---   syntax/	syntax files `mysyntaxfile`
+---   tutor/	tutorial files `:Tutor`
+---
+--- And any other file searched for with the `:runtime` command.
+---
+--- Defaults are setup to search these locations:
+--- 1. Your home directory, for personal preferences.
+---    Given by `stdpath("config")`.  `$XDG_CONFIG_HOME`
+--- 2. Directories which must contain configuration files according to
+---    `xdg` ($XDG_CONFIG_DIRS, defaults to /etc/xdg).  This also contains
+---    preferences from system administrator.
+--- 3. Data home directory, for plugins installed by user.
+---    Given by `stdpath("data")/site`.  `$XDG_DATA_HOME`
+--- 4. nvim/site subdirectories for each directory in $XDG_DATA_DIRS.
+---    This is for plugins which were installed by system administrator,
+---    but are not part of the Nvim distribution. XDG_DATA_DIRS defaults
+---    to /usr/local/share/:/usr/share/, so system administrators are
+---    expected to install site plugins to /usr/share/nvim/site.
+--- 5. Session state directory, for state data such as swap, backupdir,
+---    viewdir, undodir, etc.
+---    Given by `stdpath("state")`.  `$XDG_STATE_HOME`
+--- 6. $VIMRUNTIME, for files distributed with Nvim.
+--- 						*after-directory*
+--- 7, 8, 9, 10. In after/ subdirectories of 1, 2, 3 and 4, with reverse
+---    ordering.  This is for preferences to overrule or add to the
+---    distributed defaults or system-wide settings (rarely needed).
+---
+--- 						*packages-runtimepath*
+--- "start" packages will also be searched (`runtime-search-path`) for
+--- runtime files after these, though such packages are not explicitly
+--- reported in &runtimepath. But "opt" packages are explicitly added to
+--- &runtimepath by `:packadd`.
+---
+--- Note that, unlike 'path', no wildcards like "**" are allowed.  Normal
+--- wildcards are allowed, but can significantly slow down searching for
+--- runtime files.  For speed, use as few items as possible and avoid
+--- wildcards.
+--- See `:runtime`.
+--- Example:
+--- ```
+--- 	:set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
+--- ```
+--- This will use the directory "~/vimruntime" first (containing your
+--- personal Nvim runtime files), then "/mygroup/vim", and finally
+--- "$VIMRUNTIME" (the default runtime files).
+--- You can put a directory before $VIMRUNTIME to find files which replace
+--- distributed runtime files.  You can put a directory after $VIMRUNTIME
+--- to find files which add to distributed runtime files.
+---
+--- With `--clean` the home directory entries are not included.
+---
+--- @type string
+vim.o.runtimepath = "..."
+vim.o.rtp = vim.o.runtimepath
+vim.go.runtimepath = vim.o.runtimepath
+vim.go.rtp = vim.go.runtimepath
+
+--- Number of lines to scroll with CTRL-U and CTRL-D commands.  Will be
+--- set to half the number of lines in the window when the window size
+--- changes.  This may happen when enabling the `status-line` or
+--- 'tabline' option after setting the 'scroll' option.
+--- If you give a count to the CTRL-U or CTRL-D command it will
+--- be used as the new value for 'scroll'.  Reset to half the window
+--- height with ":set scroll=0".
+---
+--- @type integer
+vim.o.scroll = 0
+vim.o.scr = vim.o.scroll
+vim.wo.scroll = vim.o.scroll
+vim.wo.scr = vim.wo.scroll
+
+--- Maximum number of lines kept beyond the visible screen. Lines at the
+--- top are deleted if new lines exceed this limit.
+--- Minimum is 1, maximum is 100000.
+--- Only in `terminal` buffers.
+---
+--- Note: Lines that are not visible and kept in scrollback are not
+--- reflown when the terminal buffer is resized horizontally.
+---
+--- @type integer
+vim.o.scrollback = -1
+vim.o.scbk = vim.o.scrollback
+vim.bo.scrollback = vim.o.scrollback
+vim.bo.scbk = vim.bo.scrollback
+
+--- See also `scroll-binding`.  When this option is set, the current
+--- window scrolls as other scrollbind windows (windows that also have
+--- this option set) scroll.  This option is useful for viewing the
+--- differences between two versions of a file, see 'diff'.
+--- See `'scrollopt'` for options that determine how this option should be
+--- interpreted.
+--- This option is mostly reset when splitting a window to edit another
+--- file.  This means that ":split | edit file" results in two windows
+--- with scroll-binding, but ":split file" does not.
+---
+--- @type boolean
+vim.o.scrollbind = false
+vim.o.scb = vim.o.scrollbind
+vim.wo.scrollbind = vim.o.scrollbind
+vim.wo.scb = vim.wo.scrollbind
+
+--- Minimal number of lines to scroll when the cursor gets off the
+--- screen (e.g., with "j").  Not used for scroll commands (e.g., CTRL-E,
+--- CTRL-D).  Useful if your terminal scrolls very slowly.
+--- When set to a negative number from -1 to -100 this is used as the
+--- percentage of the window height.  Thus -50 scrolls half the window
+--- height.
+---
+--- @type integer
+vim.o.scrolljump = 1
+vim.o.sj = vim.o.scrolljump
+vim.go.scrolljump = vim.o.scrolljump
+vim.go.sj = vim.go.scrolljump
+
+--- Minimal number of screen lines to keep above and below the cursor.
+--- This will make some context visible around where you are working.  If
+--- you set it to a very large value (999) the cursor line will always be
+--- in the middle of the window (except at the start or end of the file or
+--- when long lines wrap).
+--- After using the local value, go back the global value with one of
+--- these two:
+--- ```
+--- 	setlocal scrolloff<
+--- 	setlocal scrolloff=-1
+--- ```
+--- For scrolling horizontally see 'sidescrolloff'.
+---
+--- @type integer
+vim.o.scrolloff = 0
+vim.o.so = vim.o.scrolloff
+vim.wo.scrolloff = vim.o.scrolloff
+vim.wo.so = vim.wo.scrolloff
+vim.go.scrolloff = vim.o.scrolloff
+vim.go.so = vim.go.scrolloff
+
+--- This is a comma-separated list of words that specifies how
+--- 'scrollbind' windows should behave.  'sbo' stands for ScrollBind
+--- Options.
+--- The following words are available:
+---     ver		Bind vertical scrolling for 'scrollbind' windows
+---     hor		Bind horizontal scrolling for 'scrollbind' windows
+---     jump	Applies to the offset between two windows for vertical
+--- 		scrolling.  This offset is the difference in the first
+--- 		displayed line of the bound windows.  When moving
+--- 		around in a window, another 'scrollbind' window may
+--- 		reach a position before the start or after the end of
+--- 		the buffer.  The offset is not changed though, when
+--- 		moving back the 'scrollbind' window will try to scroll
+--- 		to the desired position when possible.
+--- 		When now making that window the current one, two
+--- 		things can be done with the relative offset:
+--- 		1. When "jump" is not included, the relative offset is
+--- 		   adjusted for the scroll position in the new current
+--- 		   window.  When going back to the other window, the
+--- 		   new relative offset will be used.
+--- 		2. When "jump" is included, the other windows are
+--- 		   scrolled to keep the same relative offset.  When
+--- 		   going back to the other window, it still uses the
+--- 		   same relative offset.
+--- Also see `scroll-binding`.
+--- When 'diff' mode is active there always is vertical scroll binding,
+--- even when "ver" isn't there.
+---
+--- @type string
+vim.o.scrollopt = "ver,jump"
+vim.o.sbo = vim.o.scrollopt
+vim.go.scrollopt = vim.o.scrollopt
+vim.go.sbo = vim.go.scrollopt
+
+--- Specifies the nroff macros that separate sections.  These are pairs of
+--- two letters (See `object-motions`).  The default makes a section start
+--- at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
+---
+--- @type string
+vim.o.sections = "SHNHH HUnhsh"
+vim.o.sect = vim.o.sections
+vim.go.sections = vim.o.sections
+vim.go.sect = vim.go.sections
+
+--- This option defines the behavior of the selection.  It is only used
+--- in Visual and Select mode.
+--- Possible values:
+---    value	past line     inclusive ~
+---    old		   no		yes
+---    inclusive	   yes		yes
+---    exclusive	   yes		no
+--- "past line" means that the cursor is allowed to be positioned one
+--- character past the line.
+--- "inclusive" means that the last character of the selection is included
+--- in an operation.  For example, when "x" is used to delete the
+--- selection.
+--- When "old" is used and 'virtualedit' allows the cursor to move past
+--- the end of line the line break still isn't included.
+--- Note that when "exclusive" is used and selecting from the end
+--- backwards, you cannot include the last character of a line, when
+--- starting in Normal mode and 'virtualedit' empty.
+---
+--- @type string
+vim.o.selection = "inclusive"
+vim.o.sel = vim.o.selection
+vim.go.selection = vim.o.selection
+vim.go.sel = vim.go.selection
+
+--- This is a comma-separated list of words, which specifies when to start
+--- Select mode instead of Visual mode, when a selection is started.
+--- Possible values:
+---    mouse	when using the mouse
+---    key		when using shifted special keys
+---    cmd		when using "v", "V" or CTRL-V
+--- See `Select-mode`.
+---
+--- @type string
+vim.o.selectmode = ""
+vim.o.slm = vim.o.selectmode
+vim.go.selectmode = vim.o.selectmode
+vim.go.slm = vim.go.selectmode
+
+--- Changes the effect of the `:mksession` command.  It is a comma-
+--- separated list of words.  Each word enables saving and restoring
+--- something:
+---    word		save and restore ~
+---    blank	empty windows
+---    buffers	hidden and unloaded buffers, not just those in windows
+---    curdir	the current directory
+---    folds	manually created folds, opened/closed folds and local
+--- 		fold options
+---    globals	global variables that start with an uppercase letter
+--- 		and contain at least one lowercase letter.  Only
+--- 		String and Number types are stored.
+---    help		the help window
+---    localoptions	options and mappings local to a window or buffer (not
+--- 		global values for local options)
+---    options	all options and mappings (also global values for local
+--- 		options)
+---    skiprtp	exclude 'runtimepath' and 'packpath' from the options
+---    resize	size of the Vim window: 'lines' and 'columns'
+---    sesdir	the directory in which the session file is located
+--- 		will become the current directory (useful with
+--- 		projects accessed over a network from different
+--- 		systems)
+---    tabpages	all tab pages; without this only the current tab page
+--- 		is restored, so that you can make a session for each
+--- 		tab page separately
+---    terminal	include terminal windows where the command can be
+--- 		restored
+---    winpos	position of the whole Vim window
+---    winsize	window sizes
+---    slash	`deprecated` Always enabled. Uses "/" in filenames.
+---    unix		`deprecated` Always enabled. Uses "\n" line endings.
+---
+--- Don't include both "curdir" and "sesdir". When neither is included
+--- filenames are stored as absolute paths.
+--- If you leave out "options" many things won't work well after restoring
+--- the session.
+---
+--- @type string
+vim.o.sessionoptions = "blank,buffers,curdir,folds,help,tabpages,winsize,terminal"
+vim.o.ssop = vim.o.sessionoptions
+vim.go.sessionoptions = vim.o.sessionoptions
+vim.go.ssop = vim.go.sessionoptions
+
+--- When non-empty, the shada file is read upon startup and written
+--- when exiting Vim (see `shada-file`).  The string should be a comma-
+--- separated list of parameters, each consisting of a single character
+--- identifying the particular parameter, followed by a number or string
+--- which specifies the value of that parameter.  If a particular
+--- character is left out, then the default value is used for that
+--- parameter.  The following is a list of the identifying characters and
+--- the effect of their value.
+--- CHAR	VALUE	~
+--- 						*shada-!*
+--- !	When included, save and restore global variables that start
+--- 	with an uppercase letter, and don't contain a lowercase
+--- 	letter.  Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
+--- 	and "_K_L_M" are not.  Nested List and Dict items may not be
+--- 	read back correctly, you end up with an empty item.
+--- 						*shada-quote*
+--- "	Maximum number of lines saved for each register.  Old name of
+--- 	the '<' item, with the disadvantage that you need to put a
+--- 	backslash before the ", otherwise it will be recognized as the
+--- 	start of a comment!
+--- 						*shada-%*
+--- %	When included, save and restore the buffer list.  If Vim is
+--- 	started with a file name argument, the buffer list is not
+--- 	restored.  If Vim is started without a file name argument, the
+--- 	buffer list is restored from the shada file.  Quickfix
+--- 	('buftype'), unlisted ('buflisted'), unnamed and buffers on
+--- 	removable media (`shada-r`) are not saved.
+--- 	When followed by a number, the number specifies the maximum
+--- 	number of buffers that are stored.  Without a number all
+--- 	buffers are stored.
+--- 						*shada-'*
+--- '	Maximum number of previously edited files for which the marks
+--- 	are remembered.  This parameter must always be included when
+--- 	'shada' is non-empty.
+--- 	Including this item also means that the `jumplist` and the
+--- 	`changelist` are stored in the shada file.
+--- 						*shada-/*
+--- /	Maximum number of items in the search pattern history to be
+--- 	saved.  If non-zero, then the previous search and substitute
+--- 	patterns are also saved.  When not included, the value of
+--- 	'history' is used.
+--- 						*shada-:*
+--- :	Maximum number of items in the command-line history to be
+--- 	saved.  When not included, the value of 'history' is used.
+--- 						*shada-<*
+--- \<	Maximum number of lines saved for each register.  If zero then
+--- 	registers are not saved.  When not included, all lines are
+--- 	saved.  '"' is the old name for this item.
+--- 	Also see the 's' item below: limit specified in KiB.
+--- 						*shada-@*
+--- @	Maximum number of items in the input-line history to be
+--- 	saved.  When not included, the value of 'history' is used.
+--- 						*shada-c*
+--- c	Dummy option, kept for compatibility reasons.  Has no actual
+--- 	effect: ShaDa always uses UTF-8 and 'encoding' value is fixed
+--- 	to UTF-8 as well.
+--- 						*shada-f*
+--- f	Whether file marks need to be stored.  If zero, file marks ('0
+--- 	to '9, 'A to 'Z) are not stored.  When not present or when
+--- 	non-zero, they are all stored.  '0 is used for the current
+--- 	cursor position (when exiting or when doing `:wshada`).
+--- 						*shada-h*
+--- h	Disable the effect of 'hlsearch' when loading the shada
+--- 	file.  When not included, it depends on whether ":nohlsearch"
+--- 	has been used since the last search command.
+--- 						*shada-n*
+--- n	Name of the shada file.  The name must immediately follow
+--- 	the 'n'.  Must be at the end of the option!  If the
+--- 	'shadafile' option is set, that file name overrides the one
+--- 	given here with 'shada'.  Environment variables are
+--- 	expanded when opening the file, not when setting the option.
+--- 						*shada-r*
+--- r	Removable media.  The argument is a string (up to the next
+--- 	',').  This parameter can be given several times.  Each
+--- 	specifies the start of a path for which no marks will be
+--- 	stored.  This is to avoid removable media.  For Windows you
+--- 	could use "ra:,rb:".  You can also use it for temp files,
+--- 	e.g., for Unix: "r/tmp".  Case is ignored.
+--- 						*shada-s*
+--- s	Maximum size of an item contents in KiB.  If zero then nothing
+--- 	is saved.  Unlike Vim this applies to all items, except for
+--- 	the buffer list and header.  Full item size is off by three
+--- 	unsigned integers: with `s10` maximum item size may be 1 byte
+--- 	(type: 7-bit integer) + 9 bytes (timestamp: up to 64-bit
+--- 	integer) + 3 bytes (item size: up to 16-bit integer because
+--- 	2^8 < 10240 < 2^16) + 10240 bytes (requested maximum item
+--- 	contents size) = 10253 bytes.
+---
+--- Example:
+--- ```
+---     :set shada='50,<1000,s100,:0,n~/nvim/shada
+--- ```
+--- '50		Marks will be remembered for the last 50 files you
+--- 		edited.
+--- <1000		Contents of registers (up to 1000 lines each) will be
+--- 		remembered.
+--- s100		Items with contents occupying more then 100 KiB are
+--- 		skipped.
+--- :0		Command-line history will not be saved.
+--- n~/nvim/shada	The name of the file to use is "~/nvim/shada".
+--- no /		Since '/' is not specified, the default will be used,
+--- 		that is, save all of the search history, and also the
+--- 		previous search and substitute patterns.
+--- no %		The buffer list will not be saved nor read back.
+--- no h		'hlsearch' highlighting will be restored.
+---
+--- When setting 'shada' from an empty value you can use `:rshada` to
+--- load the contents of the file, this is not done automatically.
+---
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.shada = "!,'100,<50,s10,h"
+vim.o.sd = vim.o.shada
+vim.go.shada = vim.o.shada
+vim.go.sd = vim.go.shada
+
+--- When non-empty, overrides the file name used for `shada` (viminfo).
+--- When equal to "NONE" no shada file will be read or written.
+--- This option can be set with the `-i` command line flag.  The `--clean`
+--- command line flag sets it to "NONE".
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.shadafile = ""
+vim.o.sdf = vim.o.shadafile
+vim.go.shadafile = vim.o.shadafile
+vim.go.sdf = vim.go.shadafile
+
+--- Name of the shell to use for ! and :! commands.  When changing the
+--- value also check these options: 'shellpipe', 'shellslash'
+--- 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
+--- It is allowed to give an argument to the command, e.g.  "csh -f".
+--- See `option-backslash` about including spaces and backslashes.
+--- Environment variables are expanded `:set_env`.
+---
+--- If the name of the shell contains a space, you need to enclose it in
+--- quotes.  Example with quotes:
+--- ```
+--- 	:set shell=\"c:\program\ files\unix\sh.exe\"\ -f
+--- ```
+--- Note the backslash before each quote (to avoid starting a comment) and
+--- each space (to avoid ending the option value), so better use `:let-&`
+--- like this:
+--- ```
+--- 	:let &shell='"C:\Program Files\unix\sh.exe" -f'
+--- ```
+--- Also note that the "-f" is not inside the quotes, because it is not
+--- part of the command name.
+--- 						*shell-unquoting*
+--- Rules regarding quotes:
+--- 1. Option is split on space and tab characters that are not inside
+---    quotes: "abc def" runs shell named "abc" with additional argument
+---    "def", '"abc def"' runs shell named "abc def" with no additional
+---    arguments (here and below: additional means “additional to
+---    'shellcmdflag'”).
+--- 2. Quotes in option may be present in any position and any number:
+---    '"abc"', '"a"bc', 'a"b"c', 'ab"c"' and '"a"b"c"' are all equivalent
+---    to just "abc".
+--- 3. Inside quotes backslash preceding backslash means one backslash.
+---    Backslash preceding quote means one quote. Backslash preceding
+---    anything else means backslash and next character literally:
+---    '"a\\b"' is the same as "a\b", '"a\\"b"' runs shell named literally
+---    'a"b', '"a\b"' is the same as "a\b" again.
+--- 4. Outside of quotes backslash always means itself, it cannot be used
+---    to escape quote: 'a\"b"' is the same as "a\b".
+--- Note that such processing is done after `:set` did its own round of
+--- unescaping, so to keep yourself sane use `:let-&` like shown above.
+--- 						*shell-powershell*
+--- To use PowerShell:
+--- ```
+--- 	let &shell = executable('pwsh') ? 'pwsh' : 'powershell'
+--- 	let &shellcmdflag = '-NoLogo -ExecutionPolicy RemoteSigned -Command [Console]::InputEncoding=[Console]::OutputEncoding=[System.Text.UTF8Encoding]::new();$PSDefaultParameterValues[''Out-File:Encoding'']=''utf8'';Remove-Alias -Force -ErrorAction SilentlyContinue tee;'
+--- 	let &shellredir = '2>&1 | %%{ "$_" } | Out-File %s; exit $LastExitCode'
+--- 	let &shellpipe  = '2>&1 | %%{ "$_" } | tee %s; exit $LastExitCode'
+--- 	set shellquote= shellxquote=
+---
+--- ```
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.shell = "sh"
+vim.o.sh = vim.o.shell
+vim.go.shell = vim.o.shell
+vim.go.sh = vim.go.shell
+
+--- Flag passed to the shell to execute "!" and ":!" commands; e.g.,
+--- `bash.exe -c ls` or `cmd.exe /s /c "dir"`.  For MS-Windows, the
+--- default is set according to the value of 'shell', to reduce the need
+--- to set this option by the user.
+--- On Unix it can have more than one flag.  Each white space separated
+--- part is passed as an argument to the shell command.
+--- See `option-backslash` about including spaces and backslashes.
+--- See `shell-unquoting` which talks about separating this option into
+--- multiple arguments.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.shellcmdflag = "-c"
+vim.o.shcf = vim.o.shellcmdflag
+vim.go.shellcmdflag = vim.o.shellcmdflag
+vim.go.shcf = vim.go.shellcmdflag
+
+--- String to be used to put the output of the ":make" command in the
+--- error file.  See also `:make_makeprg`.  See `option-backslash` about
+--- including spaces and backslashes.
+--- The name of the temporary file can be represented by "%s" if necessary
+--- (the file name is appended automatically if no %s appears in the value
+--- of this option).
+--- For MS-Windows the default is "2>&1| tee".  The stdout and stderr are
+--- saved in a file and echoed to the screen.
+--- For Unix the default is "| tee".  The stdout of the compiler is saved
+--- in a file and echoed to the screen.  If the 'shell' option is "csh" or
+--- "tcsh" after initializations, the default becomes "|& tee".  If the
+--- 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
+--- "bash", "fish", "ash" or "dash" the default becomes "2>&1| tee".  This
+--- means that stderr is also included.  Before using the 'shell' option a
+--- path is removed, thus "/bin/sh" uses "sh".
+--- The initialization of this option is done after reading the vimrc
+--- and the other initializations, so that when the 'shell' option is set
+--- there, the 'shellpipe' option changes automatically, unless it was
+--- explicitly set before.
+--- When 'shellpipe' is set to an empty string, no redirection of the
+--- ":make" output will be done.  This is useful if you use a 'makeprg'
+--- that writes to 'makeef' by itself.  If you want no piping, but do
+--- want to include the 'makeef', set 'shellpipe' to a single space.
+--- Don't forget to precede the space with a backslash: ":set sp=\ ".
+--- In the future pipes may be used for filtering and this option will
+--- become obsolete (at least for Unix).
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.shellpipe = "| tee"
+vim.o.sp = vim.o.shellpipe
+vim.go.shellpipe = vim.o.shellpipe
+vim.go.sp = vim.go.shellpipe
+
+--- Quoting character(s), put around the command passed to the shell, for
+--- the "!" and ":!" commands.  The redirection is kept outside of the
+--- quoting.  See 'shellxquote' to include the redirection.  It's
+--- probably not useful to set both options.
+--- This is an empty string by default.  Only known to be useful for
+--- third-party shells on Windows systems, such as the MKS Korn Shell
+--- or bash, where it should be "\"".  The default is adjusted according
+--- the value of 'shell', to reduce the need to set this option by the
+--- user.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.shellquote = ""
+vim.o.shq = vim.o.shellquote
+vim.go.shellquote = vim.o.shellquote
+vim.go.shq = vim.go.shellquote
+
+--- String to be used to put the output of a filter command in a temporary
+--- file.  See also `:!`.  See `option-backslash` about including spaces
+--- and backslashes.
+--- The name of the temporary file can be represented by "%s" if necessary
+--- (the file name is appended automatically if no %s appears in the value
+--- of this option).
+--- The default is ">".  For Unix, if the 'shell' option is "csh" or
+--- "tcsh" during initializations, the default becomes ">&".  If the
+--- 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
+--- "bash" or "fish", the default becomes ">%s 2>&1".  This means that
+--- stderr is also included.  For Win32, the Unix checks are done and
+--- additionally "cmd" is checked for, which makes the default ">%s 2>&1".
+--- Also, the same names with ".exe" appended are checked for.
+--- The initialization of this option is done after reading the vimrc
+--- and the other initializations, so that when the 'shell' option is set
+--- there, the 'shellredir' option changes automatically unless it was
+--- explicitly set before.
+--- In the future pipes may be used for filtering and this option will
+--- become obsolete (at least for Unix).
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.shellredir = ">"
+vim.o.srr = vim.o.shellredir
+vim.go.shellredir = vim.o.shellredir
+vim.go.srr = vim.go.shellredir
+
+--- 		only for MS-Windows
+--- When set, a forward slash is used when expanding file names.  This is
+--- useful when a Unix-like shell is used instead of cmd.exe.  Backward
+--- slashes can still be typed, but they are changed to forward slashes by
+--- Vim.
+--- Note that setting or resetting this option has no effect for some
+--- existing file names, thus this option needs to be set before opening
+--- any file for best results.  This might change in the future.
+--- 'shellslash' only works when a backslash can be used as a path
+--- separator.  To test if this is so use:
+--- ```
+--- 	if exists('+shellslash')
+--- ```
+--- Also see 'completeslash'.
+---
+--- @type boolean
+vim.o.shellslash = false
+vim.o.ssl = vim.o.shellslash
+vim.go.shellslash = vim.o.shellslash
+vim.go.ssl = vim.go.shellslash
+
+--- When on, use temp files for shell commands.  When off use a pipe.
+--- When using a pipe is not possible temp files are used anyway.
+--- The advantage of using a pipe is that nobody can read the temp file
+--- and the 'shell' command does not need to support redirection.
+--- The advantage of using a temp file is that the file type and encoding
+--- can be detected.
+--- The `FilterReadPre`, `FilterReadPost` and `FilterWritePre|,
+--- |FilterWritePost` autocommands event are not triggered when
+--- 'shelltemp' is off.
+--- `system()` does not respect this option, it always uses pipes.
+---
+--- @type boolean
+vim.o.shelltemp = true
+vim.o.stmp = vim.o.shelltemp
+vim.go.shelltemp = vim.o.shelltemp
+vim.go.stmp = vim.go.shelltemp
+
+--- When 'shellxquote' is set to "(" then the characters listed in this
+--- option will be escaped with a '^' character.  This makes it possible
+--- to execute most external commands with cmd.exe.
+---
+--- @type string
+vim.o.shellxescape = ""
+vim.o.sxe = vim.o.shellxescape
+vim.go.shellxescape = vim.o.shellxescape
+vim.go.sxe = vim.go.shellxescape
+
+--- Quoting character(s), put around the command passed to the shell, for
+--- the "!" and ":!" commands.  Includes the redirection.  See
+--- 'shellquote' to exclude the redirection.  It's probably not useful
+--- to set both options.
+--- When the value is '(' then ')' is appended. When the value is '"('
+--- then ')"' is appended.
+--- When the value is '(' then also see 'shellxescape'.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.shellxquote = ""
+vim.o.sxq = vim.o.shellxquote
+vim.go.shellxquote = vim.o.shellxquote
+vim.go.sxq = vim.go.shellxquote
+
+--- Round indent to multiple of 'shiftwidth'.  Applies to > and <
+--- commands.  CTRL-T and CTRL-D in Insert mode always round the indent to
+--- a multiple of 'shiftwidth' (this is Vi compatible).
+---
+--- @type boolean
+vim.o.shiftround = false
+vim.o.sr = vim.o.shiftround
+vim.go.shiftround = vim.o.shiftround
+vim.go.sr = vim.go.shiftround
+
+--- Number of spaces to use for each step of (auto)indent.  Used for
+--- `'cindent'`, `>>`, `<<`, etc.
+--- When zero the 'tabstop' value will be used.  Use the `shiftwidth()`
+--- function to get the effective shiftwidth value.
+---
+--- @type integer
+vim.o.shiftwidth = 8
+vim.o.sw = vim.o.shiftwidth
+vim.bo.shiftwidth = vim.o.shiftwidth
+vim.bo.sw = vim.bo.shiftwidth
+
+--- This option helps to avoid all the `hit-enter` prompts caused by file
+--- messages, for example  with CTRL-G, and to avoid some other messages.
+--- It is a list of flags:
+---  flag	meaning when present	~
+---   f	use "(3 of 5)" instead of "(file 3 of 5)"		*shm-f*
+---   i	use "[noeol]" instead of "[Incomplete last line]"	*shm-i*
+---   l	use "999L, 888B" instead of "999 lines, 888 bytes"	*shm-l*
+---   m	use "[+]" instead of "[Modified]"			*shm-m*
+---   n	use "[New]" instead of "[New File]"			*shm-n*
+---   r	use "[RO]" instead of "[readonly]"			*shm-r*
+---   w	use "[w]" instead of "written" for file write message	*shm-w*
+--- 	and "[a]" instead of "appended" for ':w >> file' command
+---   x	use "[dos]" instead of "[dos format]", "[unix]"		*shm-x*
+--- 	instead of "[unix format]" and "[mac]" instead of "[mac
+--- 	format]"
+---   a	all of the above abbreviations				*shm-a*
+---
+---   o	overwrite message for writing a file with subsequent	*shm-o*
+--- 	message for reading a file (useful for ":wn" or when
+--- 	'autowrite' on)
+---   O	message for reading a file overwrites any previous	*shm-O*
+--- 	message;  also for quickfix message (e.g., ":cn")
+---   s	don't give "search hit BOTTOM, continuing at TOP" or	*shm-s*
+--- 	"search hit TOP, continuing at BOTTOM" messages; when using
+--- 	the search count do not show "W" after the count message (see
+--- 	S below)
+---   t	truncate file message at the start if it is too long	*shm-t*
+--- 	to fit on the command-line, "<" will appear in the left most
+--- 	column; ignored in Ex mode
+---   T	truncate other messages in the middle if they are too	*shm-T*
+--- 	long to fit on the command line; "..." will appear in the
+--- 	middle; ignored in Ex mode
+---   W	don't give "written" or "[w]" when writing a file	*shm-W*
+---   A	don't give the "ATTENTION" message when an existing	*shm-A*
+--- 	swap file is found
+---   I	don't give the intro message when starting Vim,		*shm-I*
+--- 	see `:intro`
+---   c	don't give `ins-completion-menu` messages; for		*shm-c*
+--- 	example, "-- XXX completion (YYY)", "match 1 of 2", "The only
+--- 	match", "Pattern not found", "Back at original", etc.
+---   C	don't give messages while scanning for ins-completion	*shm-C*
+--- 	items, for instance "scanning tags"
+---   q	use "recording" instead of "recording @a"		*shm-q*
+---   F	don't give the file info when editing a file, like	*shm-F*
+--- 	`:silent` was used for the command
+---   S	do not show search count message when searching, e.g.	*shm-S*
+--- 	"[1/5]"
+---
+--- This gives you the opportunity to avoid that a change between buffers
+--- requires you to hit <Enter>, but still gives as useful a message as
+--- possible for the space available.  To get the whole message that you
+--- would have got with 'shm' empty, use ":file!"
+--- Useful values:
+---     shm=	No abbreviation of message.
+---     shm=a	Abbreviation, but no loss of information.
+---     shm=at	Abbreviation, and truncate message when necessary.
+---
+--- @type string
+vim.o.shortmess = "filnxtToOCF"
+vim.o.shm = vim.o.shortmess
+vim.go.shortmess = vim.o.shortmess
+vim.go.shm = vim.go.shortmess
+
+--- String to put at the start of lines that have been wrapped.  Useful
+--- values are "> " or "+++ ":
+--- ```
+--- 	:let &showbreak = "> "
+--- 	:let &showbreak = '+++ '
+--- ```
+--- Only printable single-cell characters are allowed, excluding <Tab> and
+--- comma (in a future version the comma might be used to separate the
+--- part that is shown at the end and at the start of a line).
+--- The `hl-NonText` highlight group determines the highlighting.
+--- Note that tabs after the showbreak will be displayed differently.
+--- If you want the 'showbreak' to appear in between line numbers, add the
+--- "n" flag to 'cpoptions'.
+--- A window-local value overrules a global value.  If the global value is
+--- set and you want no value in the current window use NONE:
+--- ```
+--- 	:setlocal showbreak=NONE
+--- ```
+---
+--- @type string
+vim.o.showbreak = ""
+vim.o.sbr = vim.o.showbreak
+vim.wo.showbreak = vim.o.showbreak
+vim.wo.sbr = vim.wo.showbreak
+vim.go.showbreak = vim.o.showbreak
+vim.go.sbr = vim.go.showbreak
+
+--- Show (partial) command in the last line of the screen.  Set this
+--- option off if your terminal is slow.
+--- In Visual mode the size of the selected area is shown:
+--- - When selecting characters within a line, the number of characters.
+---   If the number of bytes is different it is also displayed: "2-6"
+---   means two characters and six bytes.
+--- - When selecting more than one line, the number of lines.
+--- - When selecting a block, the size in screen characters:
+---   {lines}x{columns}.
+--- This information can be displayed in an alternative location using the
+--- 'showcmdloc' option, useful when 'cmdheight' is 0.
+---
+--- @type boolean
+vim.o.showcmd = true
+vim.o.sc = vim.o.showcmd
+vim.go.showcmd = vim.o.showcmd
+vim.go.sc = vim.go.showcmd
+
+--- This option can be used to display the (partially) entered command in
+--- another location.  Possible values are:
+---   last		Last line of the screen (default).
+---   statusline	Status line of the current window.
+---   tabline	First line of the screen if 'showtabline' is enabled.
+--- Setting this option to "statusline" or "tabline" means that these will
+--- be redrawn whenever the command changes, which can be on every key
+--- pressed.
+--- The %S 'statusline' item can be used in 'statusline' or 'tabline' to
+--- place the text.  Without a custom 'statusline' or 'tabline' it will be
+--- displayed in a convenient location.
+---
+--- @type string
+vim.o.showcmdloc = "last"
+vim.o.sloc = vim.o.showcmdloc
+vim.go.showcmdloc = vim.o.showcmdloc
+vim.go.sloc = vim.go.showcmdloc
+
+--- When completing a word in insert mode (see `ins-completion`) from the
+--- tags file, show both the tag name and a tidied-up form of the search
+--- pattern (if there is one) as possible matches.  Thus, if you have
+--- matched a C function, you can see a template for what arguments are
+--- required (coding style permitting).
+--- Note that this doesn't work well together with having "longest" in
+--- 'completeopt', because the completion from the search pattern may not
+--- match the typed text.
+---
+--- @type boolean
+vim.o.showfulltag = false
+vim.o.sft = vim.o.showfulltag
+vim.go.showfulltag = vim.o.showfulltag
+vim.go.sft = vim.go.showfulltag
+
+--- When a bracket is inserted, briefly jump to the matching one.  The
+--- jump is only done if the match can be seen on the screen.  The time to
+--- show the match can be set with 'matchtime'.
+--- A Beep is given if there is no match (no matter if the match can be
+--- seen or not).
+--- When the 'm' flag is not included in 'cpoptions', typing a character
+--- will immediately move the cursor back to where it belongs.
+--- See the "sm" field in 'guicursor' for setting the cursor shape and
+--- blinking when showing the match.
+--- The 'matchpairs' option can be used to specify the characters to show
+--- matches for.  'rightleft' and 'revins' are used to look for opposite
+--- matches.
+--- Also see the matchparen plugin for highlighting the match when moving
+--- around `pi_paren.txt`.
+--- Note: Use of the short form is rated PG.
+---
+--- @type boolean
+vim.o.showmatch = false
+vim.o.sm = vim.o.showmatch
+vim.go.showmatch = vim.o.showmatch
+vim.go.sm = vim.go.showmatch
+
+--- If in Insert, Replace or Visual mode put a message on the last line.
+--- The `hl-ModeMsg` highlight group determines the highlighting.
+--- The option has no effect when 'cmdheight' is zero.
+---
+--- @type boolean
+vim.o.showmode = true
+vim.o.smd = vim.o.showmode
+vim.go.showmode = vim.o.showmode
+vim.go.smd = vim.go.showmode
+
+--- The value of this option specifies when the line with tab page labels
+--- will be displayed:
+--- 	0: never
+--- 	1: only if there are at least two tab pages
+--- 	2: always
+--- This is both for the GUI and non-GUI implementation of the tab pages
+--- line.
+--- See `tab-page` for more information about tab pages.
+---
+--- @type integer
+vim.o.showtabline = 1
+vim.o.stal = vim.o.showtabline
+vim.go.showtabline = vim.o.showtabline
+vim.go.stal = vim.go.showtabline
+
+--- The minimal number of columns to scroll horizontally.  Used only when
+--- the 'wrap' option is off and the cursor is moved off of the screen.
+--- When it is zero the cursor will be put in the middle of the screen.
+--- When using a slow terminal set it to a large number or 0.  Not used
+--- for "zh" and "zl" commands.
+---
+--- @type integer
+vim.o.sidescroll = 1
+vim.o.ss = vim.o.sidescroll
+vim.go.sidescroll = vim.o.sidescroll
+vim.go.ss = vim.go.sidescroll
+
+--- The minimal number of screen columns to keep to the left and to the
+--- right of the cursor if 'nowrap' is set.  Setting this option to a
+--- value greater than 0 while having `'sidescroll'` also at a non-zero
+--- value makes some context visible in the line you are scrolling in
+--- horizontally (except at beginning of the line).  Setting this option
+--- to a large value (like 999) has the effect of keeping the cursor
+--- horizontally centered in the window, as long as one does not come too
+--- close to the beginning of the line.
+--- After using the local value, go back the global value with one of
+--- these two:
+--- ```
+--- 	setlocal sidescrolloff<
+--- 	setlocal sidescrolloff=-1
+--- ```
+--- Example: Try this together with 'sidescroll' and 'listchars' as
+--- 	 in the following example to never allow the cursor to move
+--- 	 onto the "extends" character:
+--- ```
+---
+--- 	 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
+--- 	 :set sidescrolloff=1
+--- ```
+---
+--- @type integer
+vim.o.sidescrolloff = 0
+vim.o.siso = vim.o.sidescrolloff
+vim.wo.sidescrolloff = vim.o.sidescrolloff
+vim.wo.siso = vim.wo.sidescrolloff
+vim.go.sidescrolloff = vim.o.sidescrolloff
+vim.go.siso = vim.go.sidescrolloff
+
+--- When and how to draw the signcolumn. Valid values are:
+---    "auto"	only when there is a sign to display
+---    "auto:[1-9]" resize to accommodate multiple signs up to the
+---                 given number (maximum 9), e.g. "auto:4"
+---    "auto:[1-8]-[2-9]"
+---                 resize to accommodate multiple signs up to the
+--- 		given maximum number (maximum 9) while keeping
+--- 		at least the given minimum (maximum 8) fixed
+--- 		space. The minimum number should always be less
+--- 		than the maximum number, e.g. "auto:2-5"
+---    "no"		never
+---    "yes"	always
+---    "yes:[1-9]"  always, with fixed space for signs up to the given
+---                 number (maximum 9), e.g. "yes:3"
+---    "number"	display signs in the 'number' column. If the number
+--- 		column is not present, then behaves like "auto".
+---
+--- Note regarding "orphaned signs": with signcolumn numbers higher than
+--- 1, deleting lines will also remove the associated signs automatically,
+--- in contrast to the default Vim behavior of keeping and grouping them.
+--- This is done in order for the signcolumn appearance not appear weird
+--- during line deletion.
+---
+--- @type string
+vim.o.signcolumn = "auto"
+vim.o.scl = vim.o.signcolumn
+vim.wo.signcolumn = vim.o.signcolumn
+vim.wo.scl = vim.wo.signcolumn
+
+--- Override the 'ignorecase' option if the search pattern contains upper
+--- case characters.  Only used when the search pattern is typed and
+--- 'ignorecase' option is on.  Used for the commands "/", "?", "n", "N",
+--- ":g" and ":s".  Not used for "*", "#", "gd", tag search, etc.  After
+--- "*" and "#" you can make 'smartcase' used by doing a "/" command,
+--- recalling the search pattern from history and hitting <Enter>.
+---
+--- @type boolean
+vim.o.smartcase = false
+vim.o.scs = vim.o.smartcase
+vim.go.smartcase = vim.o.smartcase
+vim.go.scs = vim.go.smartcase
+
+--- Do smart autoindenting when starting a new line.  Works for C-like
+--- programs, but can also be used for other languages.  'cindent' does
+--- something like this, works better in most cases, but is more strict,
+--- see `C-indenting`.  When 'cindent' is on or 'indentexpr' is set,
+--- setting 'si' has no effect.  'indentexpr' is a more advanced
+--- alternative.
+--- Normally 'autoindent' should also be on when using 'smartindent'.
+--- An indent is automatically inserted:
+--- - After a line ending in "{".
+--- - After a line starting with a keyword from 'cinwords'.
+--- - Before a line starting with "}" (only with the "O" command).
+--- When typing '}' as the first character in a new line, that line is
+--- given the same indent as the matching "{".
+--- When typing '#' as the first character in a new line, the indent for
+--- that line is removed, the '#' is put in the first column.  The indent
+--- is restored for the next line.  If you don't want this, use this
+--- mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
+--- When using the ">>" command, lines starting with '#' are not shifted
+--- right.
+---
+--- @type boolean
+vim.o.smartindent = false
+vim.o.si = vim.o.smartindent
+vim.bo.smartindent = vim.o.smartindent
+vim.bo.si = vim.bo.smartindent
+
+--- When on, a <Tab> in front of a line inserts blanks according to
+--- 'shiftwidth'.  'tabstop' or 'softtabstop' is used in other places.  A
+--- <BS> will delete a 'shiftwidth' worth of space at the start of the
+--- line.
+--- When off, a <Tab> always inserts blanks according to 'tabstop' or
+--- 'softtabstop'.  'shiftwidth' is only used for shifting text left or
+--- right `shift-left-right`.
+--- What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
+--- option.  Also see `ins-expandtab`.  When 'expandtab' is not set, the
+--- number of spaces is minimized by using <Tab>s.
+---
+--- @type boolean
+vim.o.smarttab = true
+vim.o.sta = vim.o.smarttab
+vim.go.smarttab = vim.o.smarttab
+vim.go.sta = vim.go.smarttab
+
+--- Scrolling works with screen lines.  When 'wrap' is set and the first
+--- line in the window wraps part of it may not be visible, as if it is
+--- above the window. "<<<" is displayed at the start of the first line,
+--- highlighted with `hl-NonText`.
+--- You may also want to add "lastline" to the 'display' option to show as
+--- much of the last line as possible.
+--- NOTE: only partly implemented, currently works with CTRL-E, CTRL-Y
+--- and scrolling with the mouse.
+---
+--- @type boolean
+vim.o.smoothscroll = false
+vim.o.sms = vim.o.smoothscroll
+vim.wo.smoothscroll = vim.o.smoothscroll
+vim.wo.sms = vim.wo.smoothscroll
+
+--- Number of spaces that a <Tab> counts for while performing editing
+--- operations, like inserting a <Tab> or using <BS>.  It "feels" like
+--- <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
+--- used.  This is useful to keep the 'ts' setting at its standard value
+--- of 8, while being able to edit like it is set to 'sts'.  However,
+--- commands like "x" still work on the actual characters.
+--- When 'sts' is zero, this feature is off.
+--- When 'sts' is negative, the value of 'shiftwidth' is used.
+--- See also `ins-expandtab`.  When 'expandtab' is not set, the number of
+--- spaces is minimized by using <Tab>s.
+--- The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
+--- set.
+---
+--- The value of 'softtabstop' will be ignored if `'varsofttabstop'` is set
+--- to anything other than an empty string.
+---
+--- @type integer
+vim.o.softtabstop = 0
+vim.o.sts = vim.o.softtabstop
+vim.bo.softtabstop = vim.o.softtabstop
+vim.bo.sts = vim.bo.softtabstop
+
+--- When on spell checking will be done.  See `spell`.
+--- The languages are specified with 'spelllang'.
+---
+--- @type boolean
+vim.o.spell = false
+vim.wo.spell = vim.o.spell
+
+--- Pattern to locate the end of a sentence.  The following word will be
+--- checked to start with a capital letter.  If not then it is highlighted
+--- with SpellCap `hl-SpellCap` (unless the word is also badly spelled).
+--- When this check is not wanted make this option empty.
+--- Only used when 'spell' is set.
+--- Be careful with special characters, see `option-backslash` about
+--- including spaces and backslashes.
+--- To set this option automatically depending on the language, see
+--- `set-spc-auto`.
+---
+--- @type string
+vim.o.spellcapcheck = "[.?!]\\_[\\])'\"\\t ]\\+"
+vim.o.spc = vim.o.spellcapcheck
+vim.bo.spellcapcheck = vim.o.spellcapcheck
+vim.bo.spc = vim.bo.spellcapcheck
+
+--- Name of the word list file where words are added for the `zg` and `zw`
+--- commands.  It must end in ".{encoding}.add".  You need to include the
+--- path, otherwise the file is placed in the current directory.
+--- The path may include characters from 'isfname', space, comma and '@'.
+--- 							*E765*
+--- It may also be a comma-separated list of names.  A count before the
+--- `zg` and `zw` commands can be used to access each.  This allows using
+--- a personal word list file and a project word list file.
+--- When a word is added while this option is empty Vim will set it for
+--- you: Using the first directory in 'runtimepath' that is writable.  If
+--- there is no "spell" directory yet it will be created.  For the file
+--- name the first language name that appears in 'spelllang' is used,
+--- ignoring the region.
+--- The resulting ".spl" file will be used for spell checking, it does not
+--- have to appear in 'spelllang'.
+--- Normally one file is used for all regions, but you can add the region
+--- name if you want to.  However, it will then only be used when
+--- 'spellfile' is set to it, for entries in 'spelllang' only files
+--- without region name will be found.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.spellfile = ""
+vim.o.spf = vim.o.spellfile
+vim.bo.spellfile = vim.o.spellfile
+vim.bo.spf = vim.bo.spellfile
+
+--- A comma-separated list of word list names.  When the 'spell' option is
+--- on spellchecking will be done for these languages.  Example:
+--- ```
+--- 	set spelllang=en_us,nl,medical
+--- ```
+--- This means US English, Dutch and medical words are recognized.  Words
+--- that are not recognized will be highlighted.
+--- The word list name must consist of alphanumeric characters, a dash or
+--- an underscore.  It should not include a comma or dot.  Using a dash is
+--- recommended to separate the two letter language name from a
+--- specification.  Thus "en-rare" is used for rare English words.
+--- A region name must come last and have the form "_xx", where "xx" is
+--- the two-letter, lower case region name.  You can use more than one
+--- region by listing them: "en_us,en_ca" supports both US and Canadian
+--- English, but not words specific for Australia, New Zealand or Great
+--- Britain. (Note: currently en_au and en_nz dictionaries are older than
+--- en_ca, en_gb and en_us).
+--- If the name "cjk" is included East Asian characters are excluded from
+--- spell checking.  This is useful when editing text that also has Asian
+--- words.
+--- Note that the "medical" dictionary does not exist, it is just an
+--- example of a longer name.
+--- 						*E757*
+--- As a special case the name of a .spl file can be given as-is.  The
+--- first "_xx" in the name is removed and used as the region name
+--- (_xx is an underscore, two letters and followed by a non-letter).
+--- This is mainly for testing purposes.  You must make sure the correct
+--- encoding is used, Vim doesn't check it.
+--- How the related spell files are found is explained here: `spell-load`.
+---
+--- If the `spellfile.vim` plugin is active and you use a language name
+--- for which Vim cannot find the .spl file in 'runtimepath' the plugin
+--- will ask you if you want to download the file.
+---
+--- After this option has been set successfully, Vim will source the files
+--- "spell/LANG.vim" in 'runtimepath'.  "LANG" is the value of 'spelllang'
+--- up to the first character that is not an ASCII letter or number and
+--- not a dash.  Also see `set-spc-auto`.
+---
+--- @type string
+vim.o.spelllang = "en"
+vim.o.spl = vim.o.spelllang
+vim.bo.spelllang = vim.o.spelllang
+vim.bo.spl = vim.bo.spelllang
+
+--- A comma-separated list of options for spell checking:
+--- camel		When a word is CamelCased, assume "Cased" is a
+--- 		separate word: every upper-case character in a word
+--- 		that comes after a lower case character indicates the
+--- 		start of a new word.
+--- noplainbuffer	Only spellcheck a buffer when 'syntax' is enabled,
+--- 		or when extmarks are set within the buffer. Only
+--- 		designated regions of the buffer are spellchecked in
+--- 		this case.
+---
+--- @type string
+vim.o.spelloptions = ""
+vim.o.spo = vim.o.spelloptions
+vim.bo.spelloptions = vim.o.spelloptions
+vim.bo.spo = vim.bo.spelloptions
+
+--- Methods used for spelling suggestions.  Both for the `z=` command and
+--- the `spellsuggest()` function.  This is a comma-separated list of
+--- items:
+---
+--- best		Internal method that works best for English.  Finds
+--- 		changes like "fast" and uses a bit of sound-a-like
+--- 		scoring to improve the ordering.
+---
+--- double		Internal method that uses two methods and mixes the
+--- 		results.  The first method is "fast", the other method
+--- 		computes how much the suggestion sounds like the bad
+--- 		word.  That only works when the language specifies
+--- 		sound folding.  Can be slow and doesn't always give
+--- 		better results.
+---
+--- fast		Internal method that only checks for simple changes:
+--- 		character inserts/deletes/swaps.  Works well for
+--- 		simple typing mistakes.
+---
+--- {number}	The maximum number of suggestions listed for `z=`.
+--- 		Not used for `spellsuggest()`.  The number of
+--- 		suggestions is never more than the value of 'lines'
+--- 		minus two.
+---
+--- timeout:{millisec}   Limit the time searching for suggestions to
+--- 		{millisec} milli seconds.  Applies to the following
+--- 		methods.  When omitted the limit is 5000. When
+--- 		negative there is no limit.
+---
+--- file:{filename} Read file {filename}, which must have two columns,
+--- 		separated by a slash.  The first column contains the
+--- 		bad word, the second column the suggested good word.
+--- 		Example:
+--- 			theribal/terrible ~
+--- 		Use this for common mistakes that do not appear at the
+--- 		top of the suggestion list with the internal methods.
+--- 		Lines without a slash are ignored, use this for
+--- 		comments.
+--- 		The word in the second column must be correct,
+--- 		otherwise it will not be used.  Add the word to an
+--- 		".add" file if it is currently flagged as a spelling
+--- 		mistake.
+--- 		The file is used for all languages.
+---
+--- expr:{expr}	Evaluate expression {expr}.  Use a function to avoid
+--- 		trouble with spaces.  `v:val` holds the badly spelled
+--- 		word.  The expression must evaluate to a List of
+--- 		Lists, each with a suggestion and a score.
+--- 		Example:
+--- 			[['the', 33], ['that', 44]] ~
+--- 		Set 'verbose' and use `z=` to see the scores that the
+--- 		internal methods use.  A lower score is better.
+--- 		This may invoke `spellsuggest()` if you temporarily
+--- 		set 'spellsuggest' to exclude the "expr:" part.
+--- 		Errors are silently ignored, unless you set the
+--- 		'verbose' option to a non-zero value.
+---
+--- Only one of "best", "double" or "fast" may be used.  The others may
+--- appear several times in any order.  Example:
+--- ```
+--- 	:set sps=file:~/.config/nvim/sugg,best,expr:MySuggest()
+--- ```
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.spellsuggest = "best"
+vim.o.sps = vim.o.spellsuggest
+vim.go.spellsuggest = vim.o.spellsuggest
+vim.go.sps = vim.go.spellsuggest
+
+--- When on, splitting a window will put the new window below the current
+--- one. `:split`
+---
+--- @type boolean
+vim.o.splitbelow = false
+vim.o.sb = vim.o.splitbelow
+vim.go.splitbelow = vim.o.splitbelow
+vim.go.sb = vim.go.splitbelow
+
+--- The value of this option determines the scroll behavior when opening,
+--- closing or resizing horizontal splits.
+---
+--- Possible values are:
+---   cursor	Keep the same relative cursor position.
+---   screen	Keep the text on the same screen line.
+---   topline	Keep the topline the same.
+---
+--- For the "screen" and "topline" values, the cursor position will be
+--- changed when necessary. In this case, the jumplist will be populated
+--- with the previous cursor position. For "screen", the text cannot always
+--- be kept on the same screen line when 'wrap' is enabled.
+---
+--- @type string
+vim.o.splitkeep = "cursor"
+vim.o.spk = vim.o.splitkeep
+vim.go.splitkeep = vim.o.splitkeep
+vim.go.spk = vim.go.splitkeep
+
+--- When on, splitting a window will put the new window right of the
+--- current one. `:vsplit`
+---
+--- @type boolean
+vim.o.splitright = false
+vim.o.spr = vim.o.splitright
+vim.go.splitright = vim.o.splitright
+vim.go.spr = vim.go.splitright
+
+--- When "on" the commands listed below move the cursor to the first
+--- non-blank of the line.  When off the cursor is kept in the same column
+--- (if possible).  This applies to the commands:
+--- - CTRL-D, CTRL-U, CTRL-B, CTRL-F, "G", "H", "M", "L", "gg"
+--- - "d", "<<" and ">>" with a linewise operator
+--- - "%" with a count
+--- - buffer changing commands (CTRL-^, :bnext, :bNext, etc.)
+--- - Ex commands that only have a line number, e.g., ":25" or ":+".
+--- In case of buffer changing commands the cursor is placed at the column
+--- where it was the last time the buffer was edited.
+---
+--- @type boolean
+vim.o.startofline = false
+vim.o.sol = vim.o.startofline
+vim.go.startofline = vim.o.startofline
+vim.go.sol = vim.go.startofline
+
+--- EXPERIMENTAL
+--- When non-empty, this option determines the content of the area to the
+--- side of a window, normally containing the fold, sign and number columns.
+--- The format of this option is like that of 'statusline'.
+---
+--- Some of the items from the 'statusline' format are different for
+--- 'statuscolumn':
+---
+--- %l	line number of currently drawn line
+--- %r	relative line number of currently drawn line
+--- %s	sign column for currently drawn line
+--- %C	fold column for currently drawn line
+---
+--- NOTE: To draw the sign and fold columns, their items must be included in
+--- 'statuscolumn'. Even when they are not included, the status column width
+--- will adapt to the 'signcolumn' and 'foldcolumn' width.
+---
+--- The `v:lnum`    variable holds the line number to be drawn.
+--- The `v:relnum`  variable holds the relative line number to be drawn.
+--- The `v:virtnum` variable is negative when drawing virtual lines, zero
+--- 	      when drawing the actual buffer line, and positive when
+--- 	      drawing the wrapped part of a buffer line.
+---
+--- NOTE: The %@ click execute function item is supported as well but the
+--- specified function will be the same for each row in the same column.
+--- It cannot be switched out through a dynamic 'statuscolumn' format, the
+--- handler should be written with this in mind.
+---
+--- Examples:
+--- ```vim
+--- 	" Relative number with bar separator and click handlers:
+--- 	:set statuscolumn=%@SignCb@%s%=%T%@NumCb@%r│%T
+---
+--- 	" Right aligned relative cursor line number:
+--- 	:let &stc='%=%{v:relnum?v:relnum:v:lnum} '
+---
+--- 	" Line numbers in hexadecimal for non wrapped part of lines:
+--- 	:let &stc='%=%{v:virtnum>0?"":printf("%x",v:lnum)} '
+---
+--- 	" Human readable line numbers with thousands separator:
+--- 	:let &stc='%{substitute(v:lnum,"\\d\\zs\\ze\\'
+--- 		   . '%(\\d\\d\\d\\)\\+$",",","g")}'
+---
+--- 	" Both relative and absolute line numbers with different
+--- 	" highlighting for odd and even relative numbers:
+--- 	:let &stc='%#NonText#%{&nu?v:lnum:""}' .
+--- 	 '%=%{&rnu&&(v:lnum%2)?"\ ".v:relnum:""}' .
+--- 	 '%#LineNr#%{&rnu&&!(v:lnum%2)?"\ ".v:relnum:""}'
+---
+--- ```
+--- WARNING: this expression is evaluated for each screen line so defining
+--- an expensive expression can negatively affect render performance.
+---
+--- @type string
+vim.o.statuscolumn = ""
+vim.o.stc = vim.o.statuscolumn
+vim.wo.statuscolumn = vim.o.statuscolumn
+vim.wo.stc = vim.wo.statuscolumn
+
+--- When non-empty, this option determines the content of the status line.
+--- Also see `status-line`.
+---
+--- The option consists of printf style '%' items interspersed with
+--- normal text.  Each status line item is of the form:
+---   %-0{minwid}.{maxwid}{item}
+--- All fields except the {item} are optional.  A single percent sign can
+--- be given as "%%".
+---
+--- When the option starts with "%!" then it is used as an expression,
+--- evaluated and the result is used as the option value.  Example:
+--- ```
+--- 	:set statusline=%!MyStatusLine()
+--- ```
+--- The *g:statusline_winid* variable will be set to the `window-ID` of the
+--- window that the status line belongs to.
+--- The result can contain %{} items that will be evaluated too.
+--- Note that the "%!" expression is evaluated in the context of the
+--- current window and buffer, while %{} items are evaluated in the
+--- context of the window that the statusline belongs to.
+---
+--- When there is error while evaluating the option then it will be made
+--- empty to avoid further errors.  Otherwise screen updating would loop.
+--- When the result contains unprintable characters the result is
+--- unpredictable.
+---
+--- Note that the only effect of 'ruler' when this option is set (and
+--- 'laststatus' is 2 or 3) is controlling the output of `CTRL-G`.
+---
+--- field	    meaning ~
+--- -	    Left justify the item.  The default is right justified
+--- 	    when minwid is larger than the length of the item.
+--- 0	    Leading zeroes in numeric items.  Overridden by "-".
+--- minwid	    Minimum width of the item, padding as set by "-" & "0".
+--- 	    Value must be 50 or less.
+--- maxwid	    Maximum width of the item.  Truncation occurs with a "<"
+--- 	    on the left for text items.  Numeric items will be
+--- 	    shifted down to maxwid-2 digits followed by ">"number
+--- 	    where number is the amount of missing digits, much like
+--- 	    an exponential notation.
+--- item	    A one letter code as described below.
+---
+--- Following is a description of the possible statusline items.  The
+--- second character in "item" is the type:
+--- 	N for number
+--- 	S for string
+--- 	F for flags as described below
+--- 	- not applicable
+---
+--- item  meaning ~
+--- f S   Path to the file in the buffer, as typed or relative to current
+---       directory.
+--- F S   Full path to the file in the buffer.
+--- t S   File name (tail) of file in the buffer.
+--- m F   Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
+--- M F   Modified flag, text is ",+" or ",-".
+--- r F   Readonly flag, text is "[RO]".
+--- R F   Readonly flag, text is ",RO".
+--- h F   Help buffer flag, text is "[help]".
+--- H F   Help buffer flag, text is ",HLP".
+--- w F   Preview window flag, text is "[Preview]".
+--- W F   Preview window flag, text is ",PRV".
+--- y F   Type of file in the buffer, e.g., "[vim]".  See 'filetype'.
+--- Y F   Type of file in the buffer, e.g., ",VIM".  See 'filetype'.
+--- q S   "[Quickfix List]", "[Location List]" or empty.
+--- k S   Value of "b:keymap_name" or 'keymap' when `:lmap` mappings are
+---       being used: "<keymap>"
+--- n N   Buffer number.
+--- b N   Value of character under cursor.
+--- B N   As above, in hexadecimal.
+--- o N   Byte number in file of byte under cursor, first byte is 1.
+---       Mnemonic: Offset from start of file (with one added)
+--- O N   As above, in hexadecimal.
+--- l N   Line number.
+--- L N   Number of lines in buffer.
+--- c N   Column number (byte index).
+--- v N   Virtual column number (screen column).
+--- V N   Virtual column number as -{num}.  Not displayed if equal to 'c'.
+--- p N   Percentage through file in lines as in `CTRL-G`.
+--- P S   Percentage through file of displayed window.  This is like the
+---       percentage described for 'ruler'.  Always 3 in length, unless
+---       translated.
+--- S S   'showcmd' content, see 'showcmdloc'.
+--- a S   Argument list status as in default title.  ({current} of {max})
+---       Empty if the argument file count is zero or one.
+--- { NF  Evaluate expression between "%{" and "}" and substitute result.
+---       Note that there is no "%" before the closing "}".  The
+---       expression cannot contain a "}" character, call a function to
+---       work around that.  See `stl-%{` below.
+--- `{%` -  This is almost same as "{" except the result of the expression is
+---       re-evaluated as a statusline format string.  Thus if the
+---       return value of expr contains "%" items they will get expanded.
+---       The expression can contain the "}" character, the end of
+---       expression is denoted by "%}".
+---       For example:
+--- ```
+--- 	func! Stl_filename() abort
+--- 	    return "%t"
+--- 	endfunc
+--- ```
+--- `stl=%{Stl_filename()}`   results in `"%t"`
+---         `stl=%{%Stl_filename()%}` results in `"Name of current file"`
+--- %} -  End of "{%" expression
+--- ( -   Start of item group.  Can be used for setting the width and
+---       alignment of a section.  Must be followed by %) somewhere.
+--- ) -   End of item group.  No width fields allowed.
+--- T N   For 'tabline': start of tab page N label.  Use %T or %X to end
+---       the label.  Clicking this label with left mouse button switches
+---       to the specified tab page.
+--- X N   For 'tabline': start of close tab N label.  Use %X or %T to end
+---       the label, e.g.: %3Xclose%X.  Use %999X for a "close current
+---       tab" label.    Clicking this label with left mouse button closes
+---       specified tab page.
+--- @ N   Start of execute function label. Use %X or %T to
+---       end the label, e.g.: %10@SwitchBuffer@foo.c%X.  Clicking this
+---       label runs specified function: in the example when clicking once
+---       using left mouse button on "foo.c" "SwitchBuffer(10, 1, 'l',
+---       '    ')" expression will be run.  Function receives the
+---       following arguments in order:
+---       1. minwid field value or zero if no N was specified
+---       2. number of mouse clicks to detect multiple clicks
+---       3. mouse button used: "l", "r" or "m" for left, right or middle
+---          button respectively; one should not rely on third argument
+---          being only "l", "r" or "m": any other non-empty string value
+---          that contains only ASCII lower case letters may be expected
+---          for other mouse buttons
+---       4. modifiers pressed: string which contains "s" if shift
+---          modifier was pressed, "c" for control, "a" for alt and "m"
+---          for meta; currently if modifier is not pressed string
+---          contains space instead, but one should not rely on presence
+---          of spaces or specific order of modifiers: use `stridx()` to
+---          test whether some modifier is present; string is guaranteed
+---          to contain only ASCII letters and spaces, one letter per
+---          modifier; "?" modifier may also be present, but its presence
+---          is a bug that denotes that new mouse button recognition was
+---          added without modifying code that reacts on mouse clicks on
+---          this label.
+---       Use `getmousepos()`.winid in the specified function to get the
+---       corresponding window id of the clicked item.
+--- \< -   Where to truncate line if too long.  Default is at the start.
+---       No width fields allowed.
+--- = -   Separation point between alignment sections.  Each section will
+---       be separated by an equal number of spaces.  With one %= what
+---       comes after it will be right-aligned.  With two %= there is a
+---       middle part, with white space left and right of it.
+---       No width fields allowed.
+--- # -   Set highlight group.  The name must follow and then a # again.
+---       Thus use %#HLname# for highlight group HLname.  The same
+---       highlighting is used, also for the statusline of non-current
+---       windows.
+--- * -   Set highlight group to User{N}, where {N} is taken from the
+---       minwid field, e.g. %1*.  Restore normal highlight with %* or %0*.
+---       The difference between User{N} and StatusLine will be applied to
+---       StatusLineNC for the statusline of non-current windows.
+---       The number N must be between 1 and 9.  See `hl-User1..9`
+---
+--- When displaying a flag, Vim removes the leading comma, if any, when
+--- that flag comes right after plaintext.  This will make a nice display
+--- when flags are used like in the examples below.
+---
+--- When all items in a group becomes an empty string (i.e. flags that are
+--- not set) and a minwid is not set for the group, the whole group will
+--- become empty.  This will make a group like the following disappear
+--- completely from the statusline when none of the flags are set.
+--- ```
+--- 	:set statusline=...%(\ [%M%R%H]%)...
+--- ```
+--- Beware that an expression is evaluated each and every time the status
+--- line is displayed.
+--- 			*stl-%{* *g:actual_curbuf* *g:actual_curwin*
+--- While evaluating %{} the current buffer and current window will be set
+--- temporarily to that of the window (and buffer) whose statusline is
+--- currently being drawn.  The expression will evaluate in this context.
+--- The variable "g:actual_curbuf" is set to the `bufnr()` number of the
+--- real current buffer and "g:actual_curwin" to the `window-ID` of the
+--- real current window.  These values are strings.
+---
+--- The 'statusline' option will be evaluated in the `sandbox` if set from
+--- a modeline, see `sandbox-option`.
+--- This option cannot be set in a modeline when 'modelineexpr' is off.
+---
+--- It is not allowed to change text or jump to another window while
+--- evaluating 'statusline' `textlock`.
+---
+--- If the statusline is not updated when you want it (e.g., after setting
+--- a variable that's used in an expression), you can force an update by
+--- using `:redrawstatus`.
+---
+--- A result of all digits is regarded a number for display purposes.
+--- Otherwise the result is taken as flag text and applied to the rules
+--- described above.
+---
+--- Watch out for errors in expressions.  They may render Vim unusable!
+--- If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
+--- edit your vimrc or whatever with "vim --clean" to get it right.
+---
+--- Examples:
+--- Emulate standard status line with 'ruler' set
+--- ```
+---   :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
+--- ```
+--- Similar, but add ASCII value of char under the cursor (like "ga")
+--- ```
+---   :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
+--- ```
+--- Display byte count and byte value, modified flag in red.
+--- ```
+---   :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
+---   :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
+--- ```
+--- Display a ,GZ flag if a compressed file is loaded
+--- ```
+---   :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
+--- ```
+--- In the `:autocmd`'s:
+--- ```
+---   :let b:gzflag = 1
+--- ```
+--- And:
+--- ```
+---   :unlet b:gzflag
+--- ```
+--- And define this function:
+--- ```
+---   :function VarExists(var, val)
+---   :    if exists(a:var) | return a:val | else | return '' | endif
+---   :endfunction
+--- ```
+---
+--- @type string
+vim.o.statusline = ""
+vim.o.stl = vim.o.statusline
+vim.wo.statusline = vim.o.statusline
+vim.wo.stl = vim.wo.statusline
+vim.go.statusline = vim.o.statusline
+vim.go.stl = vim.go.statusline
+
+--- Files with these suffixes get a lower priority when multiple files
+--- match a wildcard.  See `suffixes`.  Commas can be used to separate the
+--- suffixes.  Spaces after the comma are ignored.  A dot is also seen as
+--- the start of a suffix.  To avoid a dot or comma being recognized as a
+--- separator, precede it with a backslash (see `option-backslash` about
+--- including spaces and backslashes).
+--- See 'wildignore' for completely ignoring files.
+--- The use of `:set+=` and `:set-=` is preferred when adding or removing
+--- suffixes from the list.  This avoids problems when a future version
+--- uses another default.
+---
+--- @type string
+vim.o.suffixes = ".bak,~,.o,.h,.info,.swp,.obj"
+vim.o.su = vim.o.suffixes
+vim.go.suffixes = vim.o.suffixes
+vim.go.su = vim.go.suffixes
+
+--- Comma-separated list of suffixes, which are used when searching for a
+--- file for the "gf", "[I", etc. commands.  Example:
+--- ```
+--- 	:set suffixesadd=.java
+--- ```
+---
+--- @type string
+vim.o.suffixesadd = ""
+vim.o.sua = vim.o.suffixesadd
+vim.bo.suffixesadd = vim.o.suffixesadd
+vim.bo.sua = vim.bo.suffixesadd
+
+--- Use a swapfile for the buffer.  This option can be reset when a
+--- swapfile is not wanted for a specific buffer.  For example, with
+--- confidential information that even root must not be able to access.
+--- Careful: All text will be in memory:
+--- 	- Don't use this for big files.
+--- 	- Recovery will be impossible!
+--- A swapfile will only be present when `'updatecount'` is non-zero and
+--- 'swapfile' is set.
+--- When 'swapfile' is reset, the swap file for the current buffer is
+--- immediately deleted.  When 'swapfile' is set, and 'updatecount' is
+--- non-zero, a swap file is immediately created.
+--- Also see `swap-file`.
+--- If you want to open a new buffer without creating a swap file for it,
+--- use the `:noswapfile` modifier.
+--- See 'directory' for where the swap file is created.
+---
+--- This option is used together with 'bufhidden' and 'buftype' to
+--- specify special kinds of buffers.   See `special-buffers`.
+---
+--- @type boolean
+vim.o.swapfile = true
+vim.o.swf = vim.o.swapfile
+vim.bo.swapfile = vim.o.swapfile
+vim.bo.swf = vim.bo.swapfile
+
+--- This option controls the behavior when switching between buffers.
+--- This option is checked, when
+--- - jumping to errors with the `quickfix` commands (`:cc`, `:cn`, `:cp`,
+---   etc.)
+--- - jumping to a tag using the `:stag` command.
+--- - opening a file using the `CTRL-W_f` or `CTRL-W_F` command.
+--- - jumping to a buffer using a buffer split command (e.g.  `:sbuffer`,
+---   `:sbnext`, or `:sbrewind`).
+--- Possible values (comma-separated list):
+---    useopen	If included, jump to the first open window in the
+--- 		current tab page that contains the specified buffer
+--- 		(if there is one).  Otherwise: Do not examine other
+--- 		windows.
+---    usetab	Like "useopen", but also consider windows in other tab
+--- 		pages.
+---    split	If included, split the current window before loading
+--- 		a buffer for a `quickfix` command that display errors.
+--- 		Otherwise: do not split, use current window (when used
+--- 		in the quickfix window: the previously used window or
+--- 		split if there is no other window).
+---    vsplit	Just like "split" but split vertically.
+---    newtab	Like "split", but open a new tab page.  Overrules
+--- 		"split" when both are present.
+---    uselast	If included, jump to the previously used window when
+--- 		jumping to errors with `quickfix` commands.
+---
+--- @type string
+vim.o.switchbuf = "uselast"
+vim.o.swb = vim.o.switchbuf
+vim.go.switchbuf = vim.o.switchbuf
+vim.go.swb = vim.go.switchbuf
+
+--- Maximum column in which to search for syntax items.  In long lines the
+--- text after this column is not highlighted and following lines may not
+--- be highlighted correctly, because the syntax state is cleared.
+--- This helps to avoid very slow redrawing for an XML file that is one
+--- long line.
+--- Set to zero to remove the limit.
+---
+--- @type integer
+vim.o.synmaxcol = 3000
+vim.o.smc = vim.o.synmaxcol
+vim.bo.synmaxcol = vim.o.synmaxcol
+vim.bo.smc = vim.bo.synmaxcol
+
+--- When this option is set, the syntax with this name is loaded, unless
+--- syntax highlighting has been switched off with ":syntax off".
+--- Otherwise this option does not always reflect the current syntax (the
+--- b:current_syntax variable does).
+--- This option is most useful in a modeline, for a file which syntax is
+--- not automatically recognized.  Example, in an IDL file:
+--- ```
+--- 	/* vim: set syntax=idl : */
+--- ```
+--- When a dot appears in the value then this separates two filetype
+--- names.  Example:
+--- ```
+--- 	/* vim: set syntax=c.doxygen : */
+--- ```
+--- This will use the "c" syntax first, then the "doxygen" syntax.
+--- Note that the second one must be prepared to be loaded as an addition,
+--- otherwise it will be skipped.  More than one dot may appear.
+--- To switch off syntax highlighting for the current file, use:
+--- ```
+--- 	:set syntax=OFF
+--- ```
+--- To switch syntax highlighting on according to the current value of the
+--- 'filetype' option:
+--- ```
+--- 	:set syntax=ON
+--- ```
+--- What actually happens when setting the 'syntax' option is that the
+--- Syntax autocommand event is triggered with the value as argument.
+--- This option is not copied to another buffer, independent of the 's' or
+--- 'S' flag in 'cpoptions'.
+--- Only normal file name characters can be used, `/\*?[|<>` are illegal.
+---
+--- @type string
+vim.o.syntax = ""
+vim.o.syn = vim.o.syntax
+vim.bo.syntax = vim.o.syntax
+vim.bo.syn = vim.bo.syntax
+
+--- When non-empty, this option determines the content of the tab pages
+--- line at the top of the Vim window.  When empty Vim will use a default
+--- tab pages line.  See `setting-tabline` for more info.
+---
+--- The tab pages line only appears as specified with the 'showtabline'
+--- option and only when there is no GUI tab line.  When 'e' is in
+--- 'guioptions' and the GUI supports a tab line 'guitablabel' is used
+--- instead.  Note that the two tab pages lines are very different.
+---
+--- The value is evaluated like with 'statusline'.  You can use
+--- `tabpagenr()`, `tabpagewinnr()` and `tabpagebuflist()` to figure out
+--- the text to be displayed.  Use "%1T" for the first label, "%2T" for
+--- the second one, etc.  Use "%X" items for closing labels.
+---
+--- When changing something that is used in 'tabline' that does not
+--- trigger it to be updated, use `:redrawtabline`.
+--- This option cannot be set in a modeline when 'modelineexpr' is off.
+---
+--- Keep in mind that only one of the tab pages is the current one, others
+--- are invisible and you can't jump to their windows.
+---
+--- @type string
+vim.o.tabline = ""
+vim.o.tal = vim.o.tabline
+vim.go.tabline = vim.o.tabline
+vim.go.tal = vim.go.tabline
+
+--- Maximum number of tab pages to be opened by the `-p` command line
+--- argument or the ":tab all" command. `tabpage`
+---
+--- @type integer
+vim.o.tabpagemax = 50
+vim.o.tpm = vim.o.tabpagemax
+vim.go.tabpagemax = vim.o.tabpagemax
+vim.go.tpm = vim.go.tabpagemax
+
+--- Number of spaces that a <Tab> in the file counts for.  Also see
+--- the `:retab` command, and the 'softtabstop' option.
+---
+--- Note: Setting 'tabstop' to any other value than 8 can make your file
+--- appear wrong in many places.
+--- The value must be more than 0 and less than 10000.
+---
+--- There are four main ways to use tabs in Vim:
+--- 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
+---    (or 3 or whatever you prefer) and use 'noexpandtab'.  Then Vim
+---    will use a mix of tabs and spaces, but typing <Tab> and <BS> will
+---    behave like a tab appears every 4 (or 3) characters.
+---    This is the recommended way, the file will look the same with other
+---    tools and when listing it in a terminal.
+--- 2. Set 'softtabstop' and 'shiftwidth' to whatever you prefer and use
+---    'expandtab'.  This way you will always insert spaces.  The
+---    formatting will never be messed up when 'tabstop' is changed (leave
+---    it at 8 just in case).  The file will be a bit larger.
+---    You do need to check if no Tabs exist in the file.  You can get rid
+---    of them by first setting 'expandtab' and using `%retab!`, making
+---    sure the value of 'tabstop' is set correctly.
+--- 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
+---    'expandtab'.  This way you will always insert spaces.  The
+---    formatting will never be messed up when 'tabstop' is changed.
+---    You do need to check if no Tabs exist in the file, just like in the
+---    item just above.
+--- 4. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
+---    `modeline` to set these values when editing the file again.  Only
+---    works when using Vim to edit the file, other tools assume a tabstop
+---    is worth 8 spaces.
+--- 5. Always set 'tabstop' and 'shiftwidth' to the same value, and
+---    'noexpandtab'.  This should then work (for initial indents only)
+---    for any tabstop setting that people use.  It might be nice to have
+---    tabs after the first non-blank inserted as spaces if you do this
+---    though.  Otherwise aligned comments will be wrong when 'tabstop' is
+---    changed.
+---
+--- The value of 'tabstop' will be ignored if `'vartabstop'` is set to
+--- anything other than an empty string.
+---
+--- @type integer
+vim.o.tabstop = 8
+vim.o.ts = vim.o.tabstop
+vim.bo.tabstop = vim.o.tabstop
+vim.bo.ts = vim.bo.tabstop
+
+--- When searching for a tag (e.g., for the `:ta` command), Vim can either
+--- use a binary search or a linear search in a tags file.  Binary
+--- searching makes searching for a tag a LOT faster, but a linear search
+--- will find more tags if the tags file wasn't properly sorted.
+--- Vim normally assumes that your tags files are sorted, or indicate that
+--- they are not sorted.  Only when this is not the case does the
+--- 'tagbsearch' option need to be switched off.
+---
+--- When 'tagbsearch' is on, binary searching is first used in the tags
+--- files.  In certain situations, Vim will do a linear search instead for
+--- certain files, or retry all files with a linear search.  When
+--- 'tagbsearch' is off, only a linear search is done.
+---
+--- Linear searching is done anyway, for one file, when Vim finds a line
+--- at the start of the file indicating that it's not sorted:
+--- ```
+---    !_TAG_FILE_SORTED	0	/some comment/
+--- ```
+--- [The whitespace before and after the '0' must be a single <Tab>]
+---
+--- When a binary search was done and no match was found in any of the
+--- files listed in 'tags', and case is ignored or a pattern is used
+--- instead of a normal tag name, a retry is done with a linear search.
+--- Tags in unsorted tags files, and matches with different case will only
+--- be found in the retry.
+---
+--- If a tag file indicates that it is case-fold sorted, the second,
+--- linear search can be avoided when case is ignored.  Use a value of '2'
+--- in the "!_TAG_FILE_SORTED" line for this.  A tag file can be case-fold
+--- sorted with the -f switch to "sort" in most unices, as in the command:
+--- "sort -f -o tags tags".  For Universal ctags and Exuberant ctags
+--- version 5.x or higher (at least 5.5) the --sort=foldcase switch can be
+--- used for this as well.  Note that case must be folded to uppercase for
+--- this to work.
+---
+--- By default, tag searches are case-sensitive.  Case is ignored when
+--- 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
+--- "ignore".
+--- Also when 'tagcase' is "followscs" and 'smartcase' is set, or
+--- 'tagcase' is "smart", and the pattern contains only lowercase
+--- characters.
+---
+--- When 'tagbsearch' is off, tags searching is slower when a full match
+--- exists, but faster when no full match exists.  Tags in unsorted tags
+--- files may only be found with 'tagbsearch' off.
+--- When the tags file is not sorted, or sorted in a wrong way (not on
+--- ASCII byte value), 'tagbsearch' should be off, or the line given above
+--- must be included in the tags file.
+--- This option doesn't affect commands that find all matching tags (e.g.,
+--- command-line completion and ":help").
+---
+--- @type boolean
+vim.o.tagbsearch = true
+vim.o.tbs = vim.o.tagbsearch
+vim.go.tagbsearch = vim.o.tagbsearch
+vim.go.tbs = vim.go.tagbsearch
+
+--- This option specifies how case is handled when searching the tags
+--- file:
+---    followic	Follow the 'ignorecase' option
+---    followscs    Follow the 'smartcase' and 'ignorecase' options
+---    ignore	Ignore case
+---    match	Match case
+---    smart	Ignore case unless an upper case letter is used
+---
+--- @type string
+vim.o.tagcase = "followic"
+vim.o.tc = vim.o.tagcase
+vim.bo.tagcase = vim.o.tagcase
+vim.bo.tc = vim.bo.tagcase
+vim.go.tagcase = vim.o.tagcase
+vim.go.tc = vim.go.tagcase
+
+--- This option specifies a function to be used to perform tag searches.
+--- The function gets the tag pattern and should return a List of matching
+--- tags.  See `tag-function` for an explanation of how to write the
+--- function and an example.  The value can be the name of a function, a
+--- `lambda` or a `Funcref`. See `option-value-function` for more
+--- information.
+---
+--- @type string
+vim.o.tagfunc = ""
+vim.o.tfu = vim.o.tagfunc
+vim.bo.tagfunc = vim.o.tagfunc
+vim.bo.tfu = vim.bo.tagfunc
+
+--- If non-zero, tags are significant up to this number of characters.
+---
+--- @type integer
+vim.o.taglength = 0
+vim.o.tl = vim.o.taglength
+vim.go.taglength = vim.o.taglength
+vim.go.tl = vim.go.taglength
+
+--- If on and using a tags file in another directory, file names in that
+--- tags file are relative to the directory where the tags file is.
+---
+--- @type boolean
+vim.o.tagrelative = true
+vim.o.tr = vim.o.tagrelative
+vim.go.tagrelative = vim.o.tagrelative
+vim.go.tr = vim.go.tagrelative
+
+--- Filenames for the tag command, separated by spaces or commas.  To
+--- include a space or comma in a file name, precede it with a backslash
+--- (see `option-backslash` about including spaces and backslashes).
+--- When a file name starts with "./", the '.' is replaced with the path
+--- of the current file.  But only when the 'd' flag is not included in
+--- 'cpoptions'.  Environment variables are expanded `:set_env`.  Also see
+--- `tags-option`.
+--- "*", "**" and other wildcards can be used to search for tags files in
+--- a directory tree.  See `file-searching`.  E.g., "/lib/**/tags" will
+--- find all files named "tags" below "/lib".  The filename itself cannot
+--- contain wildcards, it is used as-is.  E.g., "/lib/**/tags?" will find
+--- files called "tags?".
+--- The `tagfiles()` function can be used to get a list of the file names
+--- actually used.
+--- The use of `:set+=` and `:set-=` is preferred when adding or removing
+--- file names from the list.  This avoids problems when a future version
+--- uses another default.
+---
+--- @type string
+vim.o.tags = "./tags;,tags"
+vim.o.tag = vim.o.tags
+vim.bo.tags = vim.o.tags
+vim.bo.tag = vim.bo.tags
+vim.go.tags = vim.o.tags
+vim.go.tag = vim.go.tags
+
+--- When on, the `tagstack` is used normally.  When off, a ":tag" or
+--- ":tselect" command with an argument will not push the tag onto the
+--- tagstack.  A following ":tag" without an argument, a ":pop" command or
+--- any other command that uses the tagstack will use the unmodified
+--- tagstack, but does change the pointer to the active entry.
+--- Resetting this option is useful when using a ":tag" command in a
+--- mapping which should not change the tagstack.
+---
+--- @type boolean
+vim.o.tagstack = true
+vim.o.tgst = vim.o.tagstack
+vim.go.tagstack = vim.o.tagstack
+vim.go.tgst = vim.go.tagstack
+
+--- The terminal is in charge of Bi-directionality of text (as specified
+--- by Unicode).  The terminal is also expected to do the required shaping
+--- that some languages (such as Arabic) require.
+--- Setting this option implies that 'rightleft' will not be set when
+--- 'arabic' is set and the value of 'arabicshape' will be ignored.
+--- Note that setting 'termbidi' has the immediate effect that
+--- 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
+--- For further details see `arabic.txt`.
+---
+--- @type boolean
+vim.o.termbidi = false
+vim.o.tbidi = vim.o.termbidi
+vim.go.termbidi = vim.o.termbidi
+vim.go.tbidi = vim.go.termbidi
+
+--- Enables 24-bit RGB color in the `TUI`.  Uses "gui" `:highlight`
+--- attributes instead of "cterm" attributes. `guifg`
+--- Requires an ISO-8613-3 compatible terminal.
+---
+--- @type boolean
+vim.o.termguicolors = false
+vim.o.tgc = vim.o.termguicolors
+vim.go.termguicolors = vim.o.termguicolors
+vim.go.tgc = vim.go.termguicolors
+
+--- A comma-separated list of options for specifying control characters
+--- to be removed from the text pasted into the terminal window. The
+--- supported values are:
+---
+---    BS	    Backspace
+---
+---    HT	    TAB
+---
+---    FF	    Form feed
+---
+---    ESC	    Escape
+---
+---    DEL	    DEL
+---
+---    C0	    Other control characters, excluding Line feed and
+--- 	    Carriage return < ' '
+---
+---    C1	    Control characters 0x80...0x9F
+---
+--- @type string
+vim.o.termpastefilter = "BS,HT,ESC,DEL"
+vim.o.tpf = vim.o.termpastefilter
+vim.go.termpastefilter = vim.o.termpastefilter
+vim.go.tpf = vim.go.termpastefilter
+
+--- Maximum width of text that is being inserted.  A longer line will be
+--- broken after white space to get this width.  A zero value disables
+--- this.
+--- When 'textwidth' is zero, 'wrapmargin' may be used.  See also
+--- 'formatoptions' and `ins-textwidth`.
+--- When 'formatexpr' is set it will be used to break the line.
+---
+--- @type integer
+vim.o.textwidth = 0
+vim.o.tw = vim.o.textwidth
+vim.bo.textwidth = vim.o.textwidth
+vim.bo.tw = vim.bo.textwidth
+
+--- List of file names, separated by commas, that are used to lookup words
+--- for thesaurus completion commands `i_CTRL-X_CTRL-T`.  See
+--- `compl-thesaurus`.
+---
+--- This option is not used if 'thesaurusfunc' is set, either for the
+--- buffer or globally.
+---
+--- To include a comma in a file name precede it with a backslash.  Spaces
+--- after a comma are ignored, otherwise spaces are included in the file
+--- name.  See `option-backslash` about using backslashes.  The use of
+--- `:set+=` and `:set-=` is preferred when adding or removing directories
+--- from the list.  This avoids problems when a future version uses
+--- another default.  Backticks cannot be used in this option for security
+--- reasons.
+---
+--- @type string
+vim.o.thesaurus = ""
+vim.o.tsr = vim.o.thesaurus
+vim.bo.thesaurus = vim.o.thesaurus
+vim.bo.tsr = vim.bo.thesaurus
+vim.go.thesaurus = vim.o.thesaurus
+vim.go.tsr = vim.go.thesaurus
+
+--- This option specifies a function to be used for thesaurus completion
+--- with CTRL-X CTRL-T. `i_CTRL-X_CTRL-T` See `compl-thesaurusfunc`.
+--- The value can be the name of a function, a `lambda` or a `Funcref`.
+--- See `option-value-function` for more information.
+---
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.thesaurusfunc = ""
+vim.o.tsrfu = vim.o.thesaurusfunc
+vim.bo.thesaurusfunc = vim.o.thesaurusfunc
+vim.bo.tsrfu = vim.bo.thesaurusfunc
+vim.go.thesaurusfunc = vim.o.thesaurusfunc
+vim.go.tsrfu = vim.go.thesaurusfunc
+
+--- When on: The tilde command "~" behaves like an operator.
+---
+--- @type boolean
+vim.o.tildeop = false
+vim.o.top = vim.o.tildeop
+vim.go.tildeop = vim.o.tildeop
+vim.go.top = vim.go.tildeop
+
+--- This option and 'timeoutlen' determine the behavior when part of a
+--- mapped key sequence has been received. For example, if <c-f> is
+--- pressed and 'timeout' is set, Nvim will wait 'timeoutlen' milliseconds
+--- for any key that can follow <c-f> in a mapping.
+---
+--- @type boolean
+vim.o.timeout = true
+vim.o.to = vim.o.timeout
+vim.go.timeout = vim.o.timeout
+vim.go.to = vim.go.timeout
+
+--- Time in milliseconds to wait for a mapped sequence to complete.
+---
+--- @type integer
+vim.o.timeoutlen = 1000
+vim.o.tm = vim.o.timeoutlen
+vim.go.timeoutlen = vim.o.timeoutlen
+vim.go.tm = vim.go.timeoutlen
+
+--- When on, the title of the window will be set to the value of
+--- 'titlestring' (if it is not empty), or to:
+--- 	filename [+=-] (path) - NVIM
+--- Where:
+--- 	filename	the name of the file being edited
+--- 	-		indicates the file cannot be modified, 'ma' off
+--- 	+		indicates the file was modified
+--- 	=		indicates the file is read-only
+--- 	=+		indicates the file is read-only and modified
+--- 	(path)		is the path of the file being edited
+--- 	- NVIM		the server name `v:servername` or "NVIM"
+---
+--- @type boolean
+vim.o.title = false
+vim.go.title = vim.o.title
+
+--- Gives the percentage of 'columns' to use for the length of the window
+--- title.  When the title is longer, only the end of the path name is
+--- shown.  A '<' character before the path name is used to indicate this.
+--- Using a percentage makes this adapt to the width of the window.  But
+--- it won't work perfectly, because the actual number of characters
+--- available also depends on the font used and other things in the title
+--- bar.  When 'titlelen' is zero the full path is used.  Otherwise,
+--- values from 1 to 30000 percent can be used.
+--- 'titlelen' is also used for the 'titlestring' option.
+---
+--- @type integer
+vim.o.titlelen = 85
+vim.go.titlelen = vim.o.titlelen
+
+--- If not empty, this option will be used to set the window title when
+--- exiting.  Only if 'title' is enabled.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.titleold = ""
+vim.go.titleold = vim.o.titleold
+
+--- When this option is not empty, it will be used for the title of the
+--- window.  This happens only when the 'title' option is on.
+---
+--- When this option contains printf-style '%' items, they will be
+--- expanded according to the rules used for 'statusline'.
+--- This option cannot be set in a modeline when 'modelineexpr' is off.
+---
+--- Example:
+--- ```
+---     :auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
+---     :set title titlestring=%<%F%=%l/%L-%P titlelen=70
+--- ```
+--- The value of 'titlelen' is used to align items in the middle or right
+--- of the available space.
+--- Some people prefer to have the file name first:
+--- ```
+---     :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
+--- ```
+--- Note the use of "%{ }" and an expression to get the path of the file,
+--- without the file name.  The "%( %)" constructs are used to add a
+--- separating space only when needed.
+--- NOTE: Use of special characters in 'titlestring' may cause the display
+--- to be garbled (e.g., when it contains a CR or NL character).
+---
+--- @type string
+vim.o.titlestring = ""
+vim.go.titlestring = vim.o.titlestring
+
+--- This option and 'ttimeoutlen' determine the behavior when part of a
+--- key code sequence has been received by the `TUI`.
+---
+--- For example if <Esc> (the \x1b byte) is received and 'ttimeout' is
+--- set, Nvim waits 'ttimeoutlen' milliseconds for the terminal to
+--- complete a key code sequence. If no input arrives before the timeout,
+--- a single <Esc> is assumed. Many TUI cursor key codes start with <Esc>.
+---
+--- On very slow systems this may fail, causing cursor keys not to work
+--- sometimes.  If you discover this problem you can ":set ttimeoutlen=9999".
+--- Nvim will wait for the next character to arrive after an <Esc>.
+---
+--- @type boolean
+vim.o.ttimeout = true
+vim.go.ttimeout = vim.o.ttimeout
+
+--- Time in milliseconds to wait for a key code sequence to complete. Also
+--- used for CTRL-\ CTRL-N and CTRL-\ CTRL-G when part of a command has
+--- been typed.
+---
+--- @type integer
+vim.o.ttimeoutlen = 50
+vim.o.ttm = vim.o.ttimeoutlen
+vim.go.ttimeoutlen = vim.o.ttimeoutlen
+vim.go.ttm = vim.go.ttimeoutlen
+
+--- List of directory names for undo files, separated with commas.
+--- See 'backupdir' for details of the format.
+--- "." means using the directory of the file.  The undo file name for
+--- "file.txt" is ".file.txt.un~".
+--- For other directories the file name is the full path of the edited
+--- file, with path separators replaced with "%".
+--- When writing: The first directory that exists is used.  "." always
+--- works, no directories after "." will be used for writing.  If none of
+--- the directories exist Nvim will attempt to create the last directory in
+--- the list.
+--- When reading all entries are tried to find an undo file.  The first
+--- undo file that exists is used.  When it cannot be read an error is
+--- given, no further entry is used.
+--- See `undo-persistence`.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- Note that unlike 'directory' and 'backupdir', 'undodir' always acts as
+--- though the trailing slashes are present (see 'backupdir' for what this
+--- means).
+---
+--- @type string
+vim.o.undodir = "$XDG_STATE_HOME/nvim/undo//"
+vim.o.udir = vim.o.undodir
+vim.go.undodir = vim.o.undodir
+vim.go.udir = vim.go.undodir
+
+--- When on, Vim automatically saves undo history to an undo file when
+--- writing a buffer to a file, and restores undo history from the same
+--- file on buffer read.
+--- The directory where the undo file is stored is specified by 'undodir'.
+--- For more information about this feature see `undo-persistence`.
+--- The undo file is not read when 'undoreload' causes the buffer from
+--- before a reload to be saved for undo.
+--- When 'undofile' is turned off the undo file is NOT deleted.
+---
+--- @type boolean
+vim.o.undofile = false
+vim.o.udf = vim.o.undofile
+vim.bo.undofile = vim.o.undofile
+vim.bo.udf = vim.bo.undofile
+
+--- Maximum number of changes that can be undone.  Since undo information
+--- is kept in memory, higher numbers will cause more memory to be used.
+--- Nevertheless, a single change can already use a large amount of memory.
+--- Set to 0 for Vi compatibility: One level of undo and "u" undoes
+--- itself:
+--- ```
+--- 	set ul=0
+--- ```
+--- But you can also get Vi compatibility by including the 'u' flag in
+--- 'cpoptions', and still be able to use CTRL-R to repeat undo.
+--- Also see `undo-two-ways`.
+--- Set to -1 for no undo at all.  You might want to do this only for the
+--- current buffer:
+--- ```
+--- 	setlocal ul=-1
+--- ```
+--- This helps when you run out of memory for a single change.
+---
+--- The local value is set to -123456 when the global value is to be used.
+---
+--- Also see `clear-undo`.
+---
+--- @type integer
+vim.o.undolevels = 1000
+vim.o.ul = vim.o.undolevels
+vim.bo.undolevels = vim.o.undolevels
+vim.bo.ul = vim.bo.undolevels
+vim.go.undolevels = vim.o.undolevels
+vim.go.ul = vim.go.undolevels
+
+--- Save the whole buffer for undo when reloading it.  This applies to the
+--- ":e!" command and reloading for when the buffer changed outside of
+--- Vim. `FileChangedShell`
+--- The save only happens when this option is negative or when the number
+--- of lines is smaller than the value of this option.
+--- Set this option to zero to disable undo for a reload.
+---
+--- When saving undo for a reload, any undo file is not read.
+---
+--- Note that this causes the whole buffer to be stored in memory.  Set
+--- this option to a lower value if you run out of memory.
+---
+--- @type integer
+vim.o.undoreload = 10000
+vim.o.ur = vim.o.undoreload
+vim.go.undoreload = vim.o.undoreload
+vim.go.ur = vim.go.undoreload
+
+--- After typing this many characters the swap file will be written to
+--- disk.  When zero, no swap file will be created at all (see chapter on
+--- recovery `crash-recovery`).  'updatecount' is set to zero by starting
+--- Vim with the "-n" option, see `startup`.  When editing in readonly
+--- mode this option will be initialized to 10000.
+--- The swapfile can be disabled per buffer with `'swapfile'`.
+--- When 'updatecount' is set from zero to non-zero, swap files are
+--- created for all buffers that have 'swapfile' set.  When 'updatecount'
+--- is set to zero, existing swap files are not deleted.
+--- This option has no meaning in buffers where `'buftype'` is "nofile"
+--- or "nowrite".
+---
+--- @type integer
+vim.o.updatecount = 200
+vim.o.uc = vim.o.updatecount
+vim.go.updatecount = vim.o.updatecount
+vim.go.uc = vim.go.updatecount
+
+--- If this many milliseconds nothing is typed the swap file will be
+--- written to disk (see `crash-recovery`).  Also used for the
+--- `CursorHold` autocommand event.
+---
+--- @type integer
+vim.o.updatetime = 4000
+vim.o.ut = vim.o.updatetime
+vim.go.updatetime = vim.o.updatetime
+vim.go.ut = vim.go.updatetime
+
+--- A list of the number of spaces that a <Tab> counts for while editing,
+--- such as inserting a <Tab> or using <BS>.  It "feels" like variable-
+--- width <Tab>s are being inserted, while in fact a mixture of spaces
+--- and <Tab>s is used.  Tab widths are separated with commas, with the
+--- final value applying to all subsequent tabs.
+---
+--- For example, when editing assembly language files where statements
+--- start in the 9th column and comments in the 41st, it may be useful
+--- to use the following:
+--- ```
+--- 	:set varsofttabstop=8,32,8
+--- ```
+--- This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
+--- for every column thereafter.
+---
+--- Note that the value of `'softtabstop'` will be ignored while
+--- 'varsofttabstop' is set.
+---
+--- @type string
+vim.o.varsofttabstop = ""
+vim.o.vsts = vim.o.varsofttabstop
+vim.bo.varsofttabstop = vim.o.varsofttabstop
+vim.bo.vsts = vim.bo.varsofttabstop
+
+--- A list of the number of spaces that a <Tab> in the file counts for,
+--- separated by commas.  Each value corresponds to one tab, with the
+--- final value applying to all subsequent tabs. For example:
+--- ```
+--- 	:set vartabstop=4,20,10,8
+--- ```
+--- This will make the first tab 4 spaces wide, the second 20 spaces,
+--- the third 10 spaces, and all following tabs 8 spaces.
+---
+--- Note that the value of `'tabstop'` will be ignored while 'vartabstop'
+--- is set.
+---
+--- @type string
+vim.o.vartabstop = ""
+vim.o.vts = vim.o.vartabstop
+vim.bo.vartabstop = vim.o.vartabstop
+vim.bo.vts = vim.bo.vartabstop
+
+--- Sets the verbosity level.  Also set by `-V` and `:verbose`.
+---
+--- Tracing of options in Lua scripts is activated at level 1; Lua scripts
+--- are not traced with verbose=0, for performance.
+---
+--- If greater than or equal to a given level, Nvim produces the following
+--- messages:
+---
+--- Level   Messages ~
+--- ----------------------------------------------------------------------
+--- 1	Lua assignments to options, mappings, etc.
+--- 2	When a file is ":source"'ed, or `shada` file is read or written.
+--- 3	UI info, terminal capabilities.
+--- 4	Shell commands.
+--- 5	Every searched tags file and include file.
+--- 8	Files for which a group of autocommands is executed.
+--- 9	Executed autocommands.
+--- 11	Finding items in a path.
+--- 12	Vimscript function calls.
+--- 13	When an exception is thrown, caught, finished, or discarded.
+--- 14	Anything pending in a ":finally" clause.
+--- 15	Ex commands from a script (truncated at 200 characters).
+--- 16	Ex commands.
+---
+--- If 'verbosefile' is set then the verbose messages are not displayed.
+---
+--- @type integer
+vim.o.verbose = 0
+vim.o.vbs = vim.o.verbose
+vim.go.verbose = vim.o.verbose
+vim.go.vbs = vim.go.verbose
+
+--- When not empty all messages are written in a file with this name.
+--- When the file exists messages are appended.
+--- Writing to the file ends when Vim exits or when 'verbosefile' is made
+--- empty.  Writes are buffered, thus may not show up for some time.
+--- Setting 'verbosefile' to a new value is like making it empty first.
+--- The difference with `:redir` is that verbose messages are not
+--- displayed when 'verbosefile' is set.
+---
+--- @type string
+vim.o.verbosefile = ""
+vim.o.vfile = vim.o.verbosefile
+vim.go.verbosefile = vim.o.verbosefile
+vim.go.vfile = vim.go.verbosefile
+
+--- Name of the directory where to store files for `:mkview`.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
+---
+--- @type string
+vim.o.viewdir = "$XDG_STATE_HOME/nvim/view//"
+vim.o.vdir = vim.o.viewdir
+vim.go.viewdir = vim.o.viewdir
+vim.go.vdir = vim.go.viewdir
+
+--- Changes the effect of the `:mkview` command.  It is a comma-separated
+--- list of words.  Each word enables saving and restoring something:
+---    word		save and restore ~
+---    cursor	cursor position in file and in window
+---    curdir	local current directory, if set with `:lcd`
+---    folds	manually created folds, opened/closed folds and local
+--- 		fold options
+---    options	options and mappings local to a window or buffer (not
+--- 		global values for local options)
+---    localoptions same as "options"
+---    slash	`deprecated` Always enabled. Uses "/" in filenames.
+---    unix		`deprecated` Always enabled. Uses "\n" line endings.
+---
+--- @type string
+vim.o.viewoptions = "folds,cursor,curdir"
+vim.o.vop = vim.o.viewoptions
+vim.go.viewoptions = vim.o.viewoptions
+vim.go.vop = vim.go.viewoptions
+
+--- A comma-separated list of these words:
+---     block	Allow virtual editing in Visual block mode.
+---     insert	Allow virtual editing in Insert mode.
+---     all		Allow virtual editing in all modes.
+---     onemore	Allow the cursor to move just past the end of the line
+---     none	When used as the local value, do not allow virtual
+--- 		editing even when the global value is set.  When used
+--- 		as the global value, "none" is the same as "".
+---     NONE	Alternative spelling of "none".
+---
+--- Virtual editing means that the cursor can be positioned where there is
+--- no actual character.  This can be halfway into a tab or beyond the end
+--- of the line.  Useful for selecting a rectangle in Visual mode and
+--- editing a table.
+--- "onemore" is not the same, it will only allow moving the cursor just
+--- after the last character of the line.  This makes some commands more
+--- consistent.  Previously the cursor was always past the end of the line
+--- if the line was empty.  But it is far from Vi compatible.  It may also
+--- break some plugins or Vim scripts.  For example because `l` can move
+--- the cursor after the last character.  Use with care!
+--- Using the `$` command will move to the last character in the line, not
+--- past it.  This may actually move the cursor to the left!
+--- The `g$` command will move to the end of the screen line.
+--- It doesn't make sense to combine "all" with "onemore", but you will
+--- not get a warning for it.
+--- When combined with other words, "none" is ignored.
+---
+--- @type string
+vim.o.virtualedit = ""
+vim.o.ve = vim.o.virtualedit
+vim.wo.virtualedit = vim.o.virtualedit
+vim.wo.ve = vim.wo.virtualedit
+vim.go.virtualedit = vim.o.virtualedit
+vim.go.ve = vim.go.virtualedit
+
+--- Use visual bell instead of beeping.  Also see 'errorbells'.
+---
+--- @type boolean
+vim.o.visualbell = false
+vim.o.vb = vim.o.visualbell
+vim.go.visualbell = vim.o.visualbell
+vim.go.vb = vim.go.visualbell
+
+--- Give a warning message when a shell command is used while the buffer
+--- has been changed.
+---
+--- @type boolean
+vim.o.warn = true
+vim.go.warn = vim.o.warn
+
+--- Allow specified keys that move the cursor left/right to move to the
+--- previous/next line when the cursor is on the first/last character in
+--- the line.  Concatenate characters to allow this for these keys:
+--- 	char   key	  mode	~
+--- 	 b    <BS>	 Normal and Visual
+--- 	 s    <Space>	 Normal and Visual
+--- 	 h    "h"	 Normal and Visual (not recommended)
+--- 	 l    "l"	 Normal and Visual (not recommended)
+--- 	 <    <Left>	 Normal and Visual
+--- 	 >    <Right>	 Normal and Visual
+--- 	 ~    "~"	 Normal
+--- 	 [    <Left>	 Insert and Replace
+--- 	 ]    <Right>	 Insert and Replace
+--- For example:
+--- ```
+--- 	:set ww=<,>,[,]
+--- ```
+--- allows wrap only when cursor keys are used.
+--- When the movement keys are used in combination with a delete or change
+--- operator, the <EOL> also counts for a character.  This makes "3h"
+--- different from "3dh" when the cursor crosses the end of a line.  This
+--- is also true for "x" and "X", because they do the same as "dl" and
+--- "dh".  If you use this, you may also want to use the mapping
+--- ":map <BS> X" to make backspace delete the character in front of the
+--- cursor.
+--- When 'l' is included and it is used after an operator at the end of a
+--- line (not an empty line) then it will not move to the next line.  This
+--- makes "dl", "cl", "yl" etc. work normally.
+---
+--- @type string
+vim.o.whichwrap = "b,s"
+vim.o.ww = vim.o.whichwrap
+vim.go.whichwrap = vim.o.whichwrap
+vim.go.ww = vim.go.whichwrap
+
+--- Character you have to type to start wildcard expansion in the
+--- command-line, as specified with 'wildmode'.
+--- More info here: `cmdline-completion`.
+--- The character is not recognized when used inside a macro.  See
+--- 'wildcharm' for that.
+--- Some keys will not work, such as CTRL-C, <CR> and Enter.
+--- Although 'wc' is a number option, you can set it to a special key:
+--- ```
+--- 	:set wc=<Tab>
+--- ```
+---
+--- @type integer
+vim.o.wildchar = 9
+vim.o.wc = vim.o.wildchar
+vim.go.wildchar = vim.o.wildchar
+vim.go.wc = vim.go.wildchar
+
+--- 'wildcharm' works exactly like 'wildchar', except that it is
+--- recognized when used inside a macro.  You can find "spare" command-line
+--- keys suitable for this option by looking at `ex-edit-index`.  Normally
+--- you'll never actually type 'wildcharm', just use it in mappings that
+--- automatically invoke completion mode, e.g.:
+--- ```
+--- 	:set wcm=<C-Z>
+--- 	:cnoremap ss so $vim/sessions/*.vim<C-Z>
+--- ```
+--- Then after typing :ss you can use CTRL-P & CTRL-N.
+---
+--- @type integer
+vim.o.wildcharm = 0
+vim.o.wcm = vim.o.wildcharm
+vim.go.wildcharm = vim.o.wildcharm
+vim.go.wcm = vim.go.wildcharm
+
+--- A list of file patterns.  A file that matches with one of these
+--- patterns is ignored when expanding `wildcards`, completing file or
+--- directory names, and influences the result of `expand()`, `glob()` and
+--- `globpath()` unless a flag is passed to disable this.
+--- The pattern is used like with `:autocmd`, see `autocmd-pattern`.
+--- Also see 'suffixes'.
+--- Example:
+--- ```
+--- 	:set wildignore=*.o,*.obj
+--- ```
+--- The use of `:set+=` and `:set-=` is preferred when adding or removing
+--- a pattern from the list.  This avoids problems when a future version
+--- uses another default.
+---
+--- @type string
+vim.o.wildignore = ""
+vim.o.wig = vim.o.wildignore
+vim.go.wildignore = vim.o.wildignore
+vim.go.wig = vim.go.wildignore
+
+--- When set case is ignored when completing file names and directories.
+--- Has no effect when 'fileignorecase' is set.
+--- Does not apply when the shell is used to expand wildcards, which
+--- happens when there are special characters.
+---
+--- @type boolean
+vim.o.wildignorecase = false
+vim.o.wic = vim.o.wildignorecase
+vim.go.wildignorecase = vim.o.wildignorecase
+vim.go.wic = vim.go.wildignorecase
+
+--- When 'wildmenu' is on, command-line completion operates in an enhanced
+--- mode.  On pressing 'wildchar' (usually <Tab>) to invoke completion,
+--- the possible matches are shown.
+--- When 'wildoptions' contains "pum", then the completion matches are
+--- shown in a popup menu.  Otherwise they are displayed just above the
+--- command line, with the first match highlighted (overwriting the status
+--- line, if there is one).
+--- Keys that show the previous/next match, such as <Tab> or
+--- CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
+--- 'wildmode' must specify "full": "longest" and "list" do not start
+--- 'wildmenu' mode. You can check the current mode with `wildmenumode()`.
+--- The menu is cancelled when a key is hit that is not used for selecting
+--- a completion.
+---
+--- While the menu is active these keys have special meanings:
+---
+--- CTRL-Y		- accept the currently selected match and stop
+--- 		  completion.
+--- CTRL-E		- end completion, go back to what was there before
+--- 		  selecting a match.
+--- <Left> <Right>	- select previous/next match (like CTRL-P/CTRL-N)
+--- <Down>		- in filename/menu name completion: move into a
+--- 		  subdirectory or submenu.
+--- <CR>		- in menu completion, when the cursor is just after a
+--- 		  dot: move into a submenu.
+--- <Up>		- in filename/menu name completion: move up into
+--- 		  parent directory or parent menu.
+---
+--- If you want <Left> and <Right> to move the cursor instead of selecting
+--- a different match, use this:
+--- ```
+--- 	:cnoremap <Left> <Space><BS><Left>
+--- 	:cnoremap <Right> <Space><BS><Right>
+--- ```
+--- `hl-WildMenu` highlights the current match.
+---
+--- @type boolean
+vim.o.wildmenu = true
+vim.o.wmnu = vim.o.wildmenu
+vim.go.wildmenu = vim.o.wildmenu
+vim.go.wmnu = vim.go.wildmenu
+
+--- Completion mode that is used for the character specified with
+--- 'wildchar'.  It is a comma-separated list of up to four parts.  Each
+--- part specifies what to do for each consecutive use of 'wildchar'.  The
+--- first part specifies the behavior for the first use of 'wildchar',
+--- The second part for the second use, etc.
+---
+--- Each part consists of a colon separated list consisting of the
+--- following possible values:
+--- ""		Complete only the first match.
+--- "full"		Complete the next full match.  After the last match,
+--- 		the original string is used and then the first match
+--- 		again.  Will also start 'wildmenu' if it is enabled.
+--- "longest"	Complete till longest common string.  If this doesn't
+--- 		result in a longer string, use the next part.
+--- "list"		When more than one match, list all matches.
+--- "lastused"	When completing buffer names and more than one buffer
+--- 		matches, sort buffers by time last used (other than
+--- 		the current buffer).
+--- When there is only a single match, it is fully completed in all cases.
+---
+--- Examples of useful colon-separated values:
+--- "longest:full"	Like "longest", but also start 'wildmenu' if it is
+--- 		enabled.  Will not complete to the next full match.
+--- "list:full"	When more than one match, list all matches and
+--- 		complete first match.
+--- "list:longest"	When more than one match, list all matches and
+--- 		complete till longest common string.
+--- "list:lastused" When more than one buffer matches, list all matches
+--- 		and sort buffers by time last used (other than the
+--- 		current buffer).
+---
+--- Examples:
+--- ```
+--- 	:set wildmode=full
+--- ```
+--- Complete first full match, next match, etc.  (the default)
+--- ```
+--- 	:set wildmode=longest,full
+--- ```
+--- Complete longest common string, then each full match
+--- ```
+--- 	:set wildmode=list:full
+--- ```
+--- List all matches and complete each full match
+--- ```
+--- 	:set wildmode=list,full
+--- ```
+--- List all matches without completing, then each full match
+--- ```
+--- 	:set wildmode=longest,list
+--- ```
+--- Complete longest common string, then list alternatives.
+--- More info here: `cmdline-completion`.
+---
+--- @type string
+vim.o.wildmode = "full"
+vim.o.wim = vim.o.wildmode
+vim.go.wildmode = vim.o.wildmode
+vim.go.wim = vim.go.wildmode
+
+--- A list of words that change how `cmdline-completion` is done.
+--- The following values are supported:
+---   fuzzy		Use `fuzzy-matching` to find completion matches. When
+--- 		this value is specified, wildcard expansion will not
+--- 		be used for completion.  The matches will be sorted by
+--- 		the "best match" rather than alphabetically sorted.
+--- 		This will find more matches than the wildcard
+--- 		expansion. Currently fuzzy matching based completion
+--- 		is not supported for file and directory names and
+--- 		instead wildcard expansion is used.
+---   pum		Display the completion matches using the popup menu
+--- 		in the same style as the `ins-completion-menu`.
+---   tagfile	When using CTRL-D to list matching tags, the kind of
+--- 		tag and the file of the tag is listed.	Only one match
+--- 		is displayed per line.  Often used tag kinds are:
+--- 			d	#define
+--- 			f	function
+---
+--- @type string
+vim.o.wildoptions = "pum,tagfile"
+vim.o.wop = vim.o.wildoptions
+vim.go.wildoptions = vim.o.wildoptions
+vim.go.wop = vim.go.wildoptions
+
+--- 		only used in Win32
+--- Some GUI versions allow the access to menu entries by using the ALT
+--- key in combination with a character that appears underlined in the
+--- menu.  This conflicts with the use of the ALT key for mappings and
+--- entering special characters.  This option tells what to do:
+---   no	Don't use ALT keys for menus.  ALT key combinations can be
+--- 	mapped, but there is no automatic handling.
+---   yes	ALT key handling is done by the windowing system.  ALT key
+--- 	combinations cannot be mapped.
+---   menu	Using ALT in combination with a character that is a menu
+--- 	shortcut key, will be handled by the windowing system.  Other
+--- 	keys can be mapped.
+--- If the menu is disabled by excluding 'm' from 'guioptions', the ALT
+--- key is never used for the menu.
+--- This option is not used for <F10>; on Win32.
+---
+--- @type string
+vim.o.winaltkeys = "menu"
+vim.o.wak = vim.o.winaltkeys
+vim.go.winaltkeys = vim.o.winaltkeys
+vim.go.wak = vim.go.winaltkeys
+
+--- When non-empty, this option enables the window bar and determines its
+--- contents. The window bar is a bar that's shown at the top of every
+--- window with it enabled. The value of 'winbar' is evaluated like with
+--- 'statusline'.
+---
+--- When changing something that is used in 'winbar' that does not trigger
+--- it to be updated, use `:redrawstatus`.
+---
+--- Floating windows do not use the global value of 'winbar'. The
+--- window-local value of 'winbar' must be set for a floating window to
+--- have a window bar.
+---
+--- This option cannot be set in a modeline when 'modelineexpr' is off.
+---
+--- @type string
+vim.o.winbar = ""
+vim.o.wbr = vim.o.winbar
+vim.wo.winbar = vim.o.winbar
+vim.wo.wbr = vim.wo.winbar
+vim.go.winbar = vim.o.winbar
+vim.go.wbr = vim.go.winbar
+
+--- Enables pseudo-transparency for a floating window. Valid values are in
+--- the range of 0 for fully opaque window (disabled) to 100 for fully
+--- transparent background. Values between 0-30 are typically most useful.
+---
+--- UI-dependent. Works best with RGB colors. 'termguicolors'
+---
+--- @type integer
+vim.o.winblend = 0
+vim.o.winbl = vim.o.winblend
+vim.wo.winblend = vim.o.winblend
+vim.wo.winbl = vim.wo.winblend
+
+--- Window height used for `CTRL-F` and `CTRL-B` when there is only one
+--- window and the value is smaller than 'lines' minus one.  The screen
+--- will scroll 'window' minus two lines, with a minimum of one.
+--- When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
+--- in a much smarter way, taking care of wrapping lines.
+--- When resizing the Vim window, the value is smaller than 1 or more than
+--- or equal to 'lines' it will be set to 'lines' minus 1.
+--- Note: Do not confuse this with the height of the Vim window, use
+--- 'lines' for that.
+---
+--- @type integer
+vim.o.window = 0
+vim.o.wi = vim.o.window
+vim.go.window = vim.o.window
+vim.go.wi = vim.go.window
+
+--- Keep the window height when windows are opened or closed and
+--- 'equalalways' is set.  Also for `CTRL-W_=`.  Set by default for the
+--- `preview-window` and `quickfix-window`.
+--- The height may be changed anyway when running out of room.
+---
+--- @type boolean
+vim.o.winfixheight = false
+vim.o.wfh = vim.o.winfixheight
+vim.wo.winfixheight = vim.o.winfixheight
+vim.wo.wfh = vim.wo.winfixheight
+
+--- Keep the window width when windows are opened or closed and
+--- 'equalalways' is set.  Also for `CTRL-W_=`.
+--- The width may be changed anyway when running out of room.
+---
+--- @type boolean
+vim.o.winfixwidth = false
+vim.o.wfw = vim.o.winfixwidth
+vim.wo.winfixwidth = vim.o.winfixwidth
+vim.wo.wfw = vim.wo.winfixwidth
+
+--- Minimal number of lines for the current window.  This is not a hard
+--- minimum, Vim will use fewer lines if there is not enough room.  If the
+--- focus goes to a window that is smaller, its size is increased, at the
+--- cost of the height of other windows.
+--- Set 'winheight' to a small number for normal editing.
+--- Set it to 999 to make the current window fill most of the screen.
+--- Other windows will be only 'winminheight' high.  This has the drawback
+--- that ":all" will create only two windows.  To avoid "vim -o 1 2 3 4"
+--- to create only two windows, set the option after startup is done,
+--- using the `VimEnter` event:
+--- ```
+--- 	au VimEnter * set winheight=999
+--- ```
+--- Minimum value is 1.
+--- The height is not adjusted after one of the commands that change the
+--- height of the current window.
+--- 'winheight' applies to the current window.  Use 'winminheight' to set
+--- the minimal height for other windows.
+---
+--- @type integer
+vim.o.winheight = 1
+vim.o.wh = vim.o.winheight
+vim.go.winheight = vim.o.winheight
+vim.go.wh = vim.go.winheight
+
+--- Window-local highlights.  Comma-delimited list of highlight
+--- `group-name` pairs "{hl-from}:{hl-to},..." where each {hl-from} is
+--- a `highlight-groups` item to be overridden by {hl-to} group in
+--- the window.
+---
+--- Note: highlight namespaces take precedence over 'winhighlight'.
+--- See `nvim_win_set_hl_ns()` and `nvim_set_hl()`.
+---
+--- Highlights of vertical separators are determined by the window to the
+--- left of the separator.  The 'tabline' highlight of a tabpage is
+--- decided by the last-focused window of the tabpage.  Highlights of
+--- the popupmenu are determined by the current window.  Highlights in the
+--- message area cannot be overridden.
+---
+--- Example: show a different color for non-current windows:
+--- ```
+--- 	set winhighlight=Normal:MyNormal,NormalNC:MyNormalNC
+--- ```
+---
+--- @type string
+vim.o.winhighlight = ""
+vim.o.winhl = vim.o.winhighlight
+vim.wo.winhighlight = vim.o.winhighlight
+vim.wo.winhl = vim.wo.winhighlight
+
+--- The minimal height of a window, when it's not the current window.
+--- This is a hard minimum, windows will never become smaller.
+--- When set to zero, windows may be "squashed" to zero lines (i.e. just a
+--- status bar) if necessary.  They will return to at least one line when
+--- they become active (since the cursor has to have somewhere to go.)
+--- Use 'winheight' to set the minimal height of the current window.
+--- This option is only checked when making a window smaller.  Don't use a
+--- large number, it will cause errors when opening more than a few
+--- windows.  A value of 0 to 3 is reasonable.
+---
+--- @type integer
+vim.o.winminheight = 1
+vim.o.wmh = vim.o.winminheight
+vim.go.winminheight = vim.o.winminheight
+vim.go.wmh = vim.go.winminheight
+
+--- The minimal width of a window, when it's not the current window.
+--- This is a hard minimum, windows will never become smaller.
+--- When set to zero, windows may be "squashed" to zero columns (i.e. just
+--- a vertical separator) if necessary.  They will return to at least one
+--- line when they become active (since the cursor has to have somewhere
+--- to go.)
+--- Use 'winwidth' to set the minimal width of the current window.
+--- This option is only checked when making a window smaller.  Don't use a
+--- large number, it will cause errors when opening more than a few
+--- windows.  A value of 0 to 12 is reasonable.
+---
+--- @type integer
+vim.o.winminwidth = 1
+vim.o.wmw = vim.o.winminwidth
+vim.go.winminwidth = vim.o.winminwidth
+vim.go.wmw = vim.go.winminwidth
+
+--- Minimal number of columns for the current window.  This is not a hard
+--- minimum, Vim will use fewer columns if there is not enough room.  If
+--- the current window is smaller, its size is increased, at the cost of
+--- the width of other windows.  Set it to 999 to make the current window
+--- always fill the screen.  Set it to a small number for normal editing.
+--- The width is not adjusted after one of the commands to change the
+--- width of the current window.
+--- 'winwidth' applies to the current window.  Use 'winminwidth' to set
+--- the minimal width for other windows.
+---
+--- @type integer
+vim.o.winwidth = 20
+vim.o.wiw = vim.o.winwidth
+vim.go.winwidth = vim.o.winwidth
+vim.go.wiw = vim.go.winwidth
+
+--- This option changes how text is displayed.  It doesn't change the text
+--- in the buffer, see 'textwidth' for that.
+--- When on, lines longer than the width of the window will wrap and
+--- displaying continues on the next line.  When off lines will not wrap
+--- and only part of long lines will be displayed.  When the cursor is
+--- moved to a part that is not shown, the screen will scroll
+--- horizontally.
+--- The line will be broken in the middle of a word if necessary.  See
+--- 'linebreak' to get the break at a word boundary.
+--- To make scrolling horizontally a bit more useful, try this:
+--- ```
+--- 	:set sidescroll=5
+--- 	:set listchars+=precedes:<,extends:>
+--- ```
+--- See 'sidescroll', 'listchars' and `wrap-off`.
+--- This option can't be set from a `modeline` when the 'diff' option is
+--- on.
+---
+--- @type boolean
+vim.o.wrap = true
+vim.wo.wrap = vim.o.wrap
+
+--- Number of characters from the right window border where wrapping
+--- starts.  When typing text beyond this limit, an <EOL> will be inserted
+--- and inserting continues on the next line.
+--- Options that add a margin, such as 'number' and 'foldcolumn', cause
+--- the text width to be further reduced.
+--- When 'textwidth' is non-zero, this option is not used.
+--- See also 'formatoptions' and `ins-textwidth`.
+---
+--- @type integer
+vim.o.wrapmargin = 0
+vim.o.wm = vim.o.wrapmargin
+vim.bo.wrapmargin = vim.o.wrapmargin
+vim.bo.wm = vim.bo.wrapmargin
+
+--- Searches wrap around the end of the file.  Also applies to `]s` and
+--- `[s`, searching for spelling mistakes.
+---
+--- @type boolean
+vim.o.wrapscan = true
+vim.o.ws = vim.o.wrapscan
+vim.go.wrapscan = vim.o.wrapscan
+vim.go.ws = vim.go.wrapscan
+
+--- Allows writing files.  When not set, writing a file is not allowed.
+--- Can be used for a view-only mode, where modifications to the text are
+--- still allowed.  Can be reset with the `-m` or `-M` command line
+--- argument.  Filtering text is still possible, even though this requires
+--- writing a temporary file.
+---
+--- @type boolean
+vim.o.write = true
+vim.go.write = vim.o.write
+
+--- Allows writing to any file with no need for "!" override.
+---
+--- @type boolean
+vim.o.writeany = false
+vim.o.wa = vim.o.writeany
+vim.go.writeany = vim.o.writeany
+vim.go.wa = vim.go.writeany
+
+--- Make a backup before overwriting a file.  The backup is removed after
+--- the file was successfully written, unless the 'backup' option is
+--- also on.
+--- WARNING: Switching this option off means that when Vim fails to write
+--- your buffer correctly and then, for whatever reason, Vim exits, you
+--- lose both the original file and what you were writing.  Only reset
+--- this option if your file system is almost full and it makes the write
+--- fail (and make sure not to exit Vim until the write was successful).
+--- See `backup-table` for another explanation.
+--- When the 'backupskip' pattern matches, a backup is not made anyway.
+--- Depending on 'backupcopy' the backup is a new file or the original
+--- file renamed (and a new file is written).
+---
+--- @type boolean
+vim.o.writebackup = true
+vim.o.wb = vim.o.writebackup
+vim.go.writebackup = vim.o.writebackup
+vim.go.wb = vim.go.writebackup
+
+--- Only takes effect together with 'redrawdebug'.
+--- The number of milliseconds to wait after each line or each flush
+---
+--- @type integer
+vim.o.writedelay = 0
+vim.o.wd = vim.o.writedelay
+vim.go.writedelay = vim.o.writedelay
+vim.go.wd = vim.go.writedelay
-- 
cgit 


From 42630923fc00633d806af97c1792b2ed4a71e1cc Mon Sep 17 00:00:00 2001
From: Raphael <glephunter@gmail.com>
Date: Sat, 5 Aug 2023 17:03:57 +0800
Subject: refactor(lsp): use protocol.Methods instead of strings #24570

---
 runtime/lua/vim/lsp.lua     | 6 +++---
 runtime/lua/vim/lsp/buf.lua | 8 ++++----
 2 files changed, 7 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index ea6b386b28..bfba275c33 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1612,7 +1612,7 @@ function lsp.start_client(config)
         data = { client_id = client_id, request_id = id, request = request },
       })
     end
-    return rpc.notify('$/cancelRequest', { id = id })
+    return rpc.notify(ms.dollar_cancelRequest, { id = id })
   end
 
   -- Track this so that we can escalate automatically if we've already tried a
@@ -1636,9 +1636,9 @@ function lsp.start_client(config)
       return
     end
     -- Sending a signal after a process has exited is acceptable.
-    rpc.request('shutdown', nil, function(err, _)
+    rpc.request(ms.shutdown, nil, function(err, _)
       if err == nil then
-        rpc.notify('exit')
+        rpc.notify(ms.exit)
       else
         -- If there was an error in the shutdown request, then term to be safe.
         rpc.terminate()
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 59afaf6fa0..3b1654d11f 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -446,14 +446,14 @@ end
 --- |quickfix| window. If the symbol can resolve to multiple
 --- items, the user can pick one in the |inputlist()|.
 function M.incoming_calls()
-  call_hierarchy('callHierarchy/incomingCalls')
+  call_hierarchy(ms.callHierarchy_incomingCalls)
 end
 
 --- Lists all the items that are called by the symbol under the
 --- cursor in the |quickfix| window. If the symbol can resolve to
 --- multiple items, the user can pick one in the |inputlist()|.
 function M.outgoing_calls()
-  call_hierarchy('callHierarchy/outgoingCalls')
+  call_hierarchy(ms.callHierarchy_outgoingCalls)
 end
 
 --- List workspace folders.
@@ -659,10 +659,10 @@ local function on_code_action_results(results, ctx, options)
     local reg = client.dynamic_capabilities:get(ms.textDocument_codeAction, { bufnr = ctx.bufnr })
 
     local supports_resolve = vim.tbl_get(reg or {}, 'registerOptions', 'resolveProvider')
-      or client.supports_method('codeAction/resolve')
+      or client.supports_method(ms.codeAction_resolve)
 
     if not action.edit and client and supports_resolve then
-      client.request('codeAction/resolve', action, function(err, resolved_action)
+      client.request(ms.codeAction_resolve, action, function(err, resolved_action)
         if err then
           vim.notify(err.code .. ': ' .. err.message, vim.log.levels.ERROR)
           return
-- 
cgit 


From 51c754b62e795c49cfcf9df3ab492bdd53c61482 Mon Sep 17 00:00:00 2001
From: bfredl <bjorn.linse@gmail.com>
Date: Wed, 2 Aug 2023 13:15:30 +0200
Subject: feat(lua): use keyset type information

---
 runtime/lua/vim/_meta/api_keysets.lua | 302 +++++++++++++++++-----------------
 1 file changed, 151 insertions(+), 151 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index 184eb7a060..5f8cb93144 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -4,112 +4,112 @@
 error('Cannot require a meta file')
 
 --- @class vim.api.keyset.clear_autocmds
---- @field buffer any
+--- @field buffer integer
 --- @field event any
 --- @field group any
 --- @field pattern any
 
 --- @class vim.api.keyset.cmd
---- @field cmd any
---- @field range any
---- @field count any
---- @field reg any
---- @field bang any
---- @field args any
---- @field magic any
---- @field mods any
+--- @field cmd string
+--- @field range any[]
+--- @field count integer
+--- @field reg string
+--- @field bang boolean
+--- @field args any[]
+--- @field magic table<string,any>
+--- @field mods table<string,any>
 --- @field nargs any
 --- @field addr any
 --- @field nextcmd any
 
 --- @class vim.api.keyset.cmd_magic
---- @field file any
---- @field bar any
+--- @field file boolean
+--- @field bar boolean
 
 --- @class vim.api.keyset.cmd_mods
---- @field silent any
---- @field emsg_silent any
---- @field unsilent any
---- @field filter any
---- @field sandbox any
---- @field noautocmd any
---- @field browse any
---- @field confirm any
---- @field hide any
---- @field horizontal any
---- @field keepalt any
---- @field keepjumps any
---- @field keepmarks any
---- @field keeppatterns any
---- @field lockmarks any
---- @field noswapfile any
---- @field tab any
---- @field verbose any
---- @field vertical any
---- @field split any
+--- @field silent boolean
+--- @field emsg_silent boolean
+--- @field unsilent boolean
+--- @field filter table<string,any>
+--- @field sandbox boolean
+--- @field noautocmd boolean
+--- @field browse boolean
+--- @field confirm boolean
+--- @field hide boolean
+--- @field horizontal boolean
+--- @field keepalt boolean
+--- @field keepjumps boolean
+--- @field keepmarks boolean
+--- @field keeppatterns boolean
+--- @field lockmarks boolean
+--- @field noswapfile boolean
+--- @field tab integer
+--- @field verbose integer
+--- @field vertical boolean
+--- @field split string
 
 --- @class vim.api.keyset.cmd_mods_filter
---- @field pattern any
---- @field force any
+--- @field pattern string
+--- @field force boolean
 
 --- @class vim.api.keyset.cmd_opts
---- @field output any
+--- @field output boolean
 
 --- @class vim.api.keyset.context
---- @field types any
+--- @field types any[]
 
 --- @class vim.api.keyset.create_augroup
 --- @field clear any
 
 --- @class vim.api.keyset.create_autocmd
---- @field buffer any
+--- @field buffer integer
 --- @field callback any
---- @field command any
---- @field desc any
+--- @field command string
+--- @field desc string
 --- @field group any
---- @field nested any
---- @field once any
+--- @field nested boolean
+--- @field once boolean
 --- @field pattern any
 
 --- @class vim.api.keyset.echo_opts
---- @field verbose any
+--- @field verbose boolean
 
 --- @class vim.api.keyset.eval_statusline
---- @field winid any
---- @field maxwidth any
---- @field fillchar any
---- @field highlights any
---- @field use_winbar any
---- @field use_tabline any
---- @field use_statuscol_lnum any
+--- @field winid integer
+--- @field maxwidth integer
+--- @field fillchar string
+--- @field highlights boolean
+--- @field use_winbar boolean
+--- @field use_tabline boolean
+--- @field use_statuscol_lnum integer
 
 --- @class vim.api.keyset.exec_autocmds
---- @field buffer any
+--- @field buffer integer
 --- @field group any
---- @field modeline any
+--- @field modeline boolean
 --- @field pattern any
 --- @field data any
 
 --- @class vim.api.keyset.exec_opts
---- @field output any
+--- @field output boolean
 
 --- @class vim.api.keyset.float_config
---- @field row any
---- @field col any
---- @field width any
---- @field height any
---- @field anchor any
---- @field relative any
---- @field win any
---- @field bufpos any
---- @field external any
---- @field focusable any
---- @field zindex any
+--- @field row number
+--- @field col number
+--- @field width integer
+--- @field height integer
+--- @field anchor string
+--- @field relative string
+--- @field win integer
+--- @field bufpos any[]
+--- @field external boolean
+--- @field focusable boolean
+--- @field zindex integer
 --- @field border any
 --- @field title any
---- @field title_pos any
---- @field style any
---- @field noautocmd any
+--- @field title_pos string
+--- @field style string
+--- @field noautocmd boolean
 
 --- @class vim.api.keyset.get_autocmds
 --- @field event any
@@ -118,27 +118,27 @@ error('Cannot require a meta file')
 --- @field buffer any
 
 --- @class vim.api.keyset.get_commands
---- @field builtin any
+--- @field builtin boolean
 
 --- @class vim.api.keyset.get_highlight
---- @field id any
---- @field name any
---- @field link any
+--- @field id integer
+--- @field name string
+--- @field link boolean
 
 --- @class vim.api.keyset.highlight
---- @field bold any
---- @field standout any
---- @field strikethrough any
---- @field underline any
---- @field undercurl any
---- @field underdouble any
---- @field underdotted any
---- @field underdashed any
---- @field italic any
---- @field reverse any
---- @field altfont any
---- @field nocombine any
---- @field default_ any
+--- @field bold boolean
+--- @field standout boolean
+--- @field strikethrough boolean
+--- @field underline boolean
+--- @field undercurl boolean
+--- @field underdouble boolean
+--- @field underdotted boolean
+--- @field underdashed boolean
+--- @field italic boolean
+--- @field reverse boolean
+--- @field altfont boolean
+--- @field nocombine boolean
+--- @field default boolean
 --- @field cterm any
 --- @field foreground any
 --- @field fg any
@@ -150,100 +150,100 @@ error('Cannot require a meta file')
 --- @field sp any
 --- @field link any
 --- @field global_link any
---- @field fallback any
---- @field blend any
---- @field fg_indexed any
---- @field bg_indexed any
+--- @field fallback boolean
+--- @field blend integer
+--- @field fg_indexed boolean
+--- @field bg_indexed boolean
 
 --- @class vim.api.keyset.highlight_cterm
---- @field bold any
---- @field standout any
---- @field strikethrough any
---- @field underline any
---- @field undercurl any
---- @field underdouble any
---- @field underdotted any
---- @field underdashed any
---- @field italic any
---- @field reverse any
---- @field altfont any
---- @field nocombine any
+--- @field bold boolean
+--- @field standout boolean
+--- @field strikethrough boolean
+--- @field underline boolean
+--- @field undercurl boolean
+--- @field underdouble boolean
+--- @field underdotted boolean
+--- @field underdashed boolean
+--- @field italic boolean
+--- @field reverse boolean
+--- @field altfont boolean
+--- @field nocombine boolean
 
 --- @class vim.api.keyset.keymap
---- @field noremap any
---- @field nowait any
---- @field silent any
---- @field script any
---- @field expr any
---- @field unique any
---- @field callback any
---- @field desc any
---- @field replace_keycodes any
+--- @field noremap boolean
+--- @field nowait boolean
+--- @field silent boolean
+--- @field script boolean
+--- @field expr boolean
+--- @field unique boolean
+--- @field callback function
+--- @field desc string
+--- @field replace_keycodes boolean
 
 --- @class vim.api.keyset.option
---- @field scope any
---- @field win any
---- @field buf any
---- @field filetype any
+--- @field scope string
+--- @field win integer
+--- @field buf integer
+--- @field filetype string
 
 --- @class vim.api.keyset.runtime
---- @field is_lua any
---- @field do_source any
+--- @field is_lua boolean
+--- @field do_source boolean
 
 --- @class vim.api.keyset.set_decoration_provider
---- @field on_start any
---- @field on_buf any
---- @field on_win any
---- @field on_line any
---- @field on_end any
---- @field _on_hl_def any
---- @field _on_spell_nav any
+--- @field on_start function
+--- @field on_buf function
+--- @field on_win function
+--- @field on_line function
+--- @field on_end function
+--- @field _on_hl_def function
+--- @field _on_spell_nav function
 
 --- @class vim.api.keyset.set_extmark
---- @field id any
---- @field end_line any
---- @field end_row any
---- @field end_col any
+--- @field id integer
+--- @field end_line integer
+--- @field end_row integer
+--- @field end_col integer
 --- @field hl_group any
---- @field virt_text any
---- @field virt_text_pos any
---- @field virt_text_win_col any
---- @field virt_text_hide any
---- @field hl_eol any
---- @field hl_mode any
---- @field ephemeral any
---- @field priority any
---- @field right_gravity any
---- @field end_right_gravity any
---- @field virt_lines any
---- @field virt_lines_above any
---- @field virt_lines_leftcol any
---- @field strict any
---- @field sign_text any
+--- @field virt_text any[]
+--- @field virt_text_pos string
+--- @field virt_text_win_col integer
+--- @field virt_text_hide boolean
+--- @field hl_eol boolean
+--- @field hl_mode string
+--- @field ephemeral boolean
+--- @field priority integer
+--- @field right_gravity boolean
+--- @field end_right_gravity boolean
+--- @field virt_lines any[]
+--- @field virt_lines_above boolean
+--- @field virt_lines_leftcol boolean
+--- @field strict boolean
+--- @field sign_text string
 --- @field sign_hl_group any
 --- @field number_hl_group any
 --- @field line_hl_group any
 --- @field cursorline_hl_group any
---- @field conceal any
---- @field spell any
---- @field ui_watched any
+--- @field conceal string
+--- @field spell boolean
+--- @field ui_watched boolean
 
 --- @class vim.api.keyset.user_command
 --- @field addr any
---- @field bang any
---- @field bar any
+--- @field bang boolean
+--- @field bar boolean
 --- @field complete any
 --- @field count any
 --- @field desc any
---- @field force any
---- @field keepscript any
+--- @field force boolean
+--- @field keepscript boolean
 --- @field nargs any
 --- @field preview any
 --- @field range any
---- @field register_ any
+--- @field register boolean
 
 --- @class vim.api.keyset.win_text_height
---- @field start_row any
---- @field end_row any
---- @field start_vcol any
---- @field end_vcol any
+--- @field start_row integer
+--- @field end_row integer
+--- @field start_vcol integer
+--- @field end_vcol integer
-- 
cgit 


From 369f58797dbd3c0e18035d26e6f5d6634be7a2a9 Mon Sep 17 00:00:00 2001
From: ObserverOfTime <chronobserver@disroot.org>
Date: Mon, 7 Aug 2023 16:16:12 +0300
Subject: fix(treesitter): escape quotes in :InspectTree view #24582

Problem: Anonymous nodes containing double quotes break the highlighting.
Solution: Escape double quotes in anonymous nodes.
---
 runtime/lua/vim/treesitter/dev.lua | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index 1bb5a08205..e94e8f08dc 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -152,6 +152,12 @@ local function get_range_str(lnum, col, end_lnum, end_col)
   return string.format('[%d:%d - %d:%d]', lnum + 1, col + 1, end_lnum + 1, end_col)
 end
 
+---@param text string
+---@return string
+local function escape_quotes(text)
+  return string.format('"%s"', text:sub(2, #text - 1):gsub('"', '\\"'))
+end
+
 --- Write the contents of this View into {bufnr}.
 ---
 ---@param bufnr integer Buffer number to write into.
@@ -164,8 +170,9 @@ function TSTreeView:draw(bufnr)
   for _, item in self:iter() do
     local range_str = get_range_str(item.lnum, item.col, item.end_lnum, item.end_col)
     local lang_str = self.opts.lang and string.format(' %s', item.lang) or ''
+    local text = item.named and item.text or escape_quotes(item.text)
     local line =
-      string.format('%s%s ; %s%s', string.rep(' ', item.depth), item.text, range_str, lang_str)
+      string.format('%s%s ; %s%s', string.rep(' ', item.depth), text, range_str, lang_str)
 
     if self.opts.lang then
       lang_hl_marks[#lang_hl_marks + 1] = {
-- 
cgit 


From 832459219b4cbf3151e48b43187f1ab0c94ea285 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Mon, 7 Aug 2023 06:35:06 -0700
Subject: docs(lsp): fix references to protocol.constants #24578

---
 runtime/lua/vim/lsp/buf.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 3b1654d11f..6cd0aa1e95 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -112,7 +112,7 @@ end
 --- about the context in which a completion was triggered (how it was triggered,
 --- and by which trigger character, if applicable)
 ---
----@see vim.lsp.protocol.constants.CompletionTriggerKind
+---@see vim.lsp.protocol.CompletionTriggerKind
 function M.completion(context)
   local params = util.make_position_params()
   params.context = context
@@ -728,7 +728,7 @@ end
 ---           using mark-like indexing. See |api-indexing|
 ---
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_codeAction
----@see vim.lsp.protocol.constants.CodeActionTriggerKind
+---@see vim.lsp.protocol.CodeActionTriggerKind
 function M.code_action(options)
   validate({ options = { options, 't', true } })
   options = options or {}
-- 
cgit 


From c0beb8173fe2f8a8f71cd5a3a6cdfed145a1d973 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 7 Aug 2023 16:27:53 +0100
Subject: feat: add .luarc.json (#24592)

---
 runtime/lua/vim/_meta.lua | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta.lua b/runtime/lua/vim/_meta.lua
index 839830294e..5e4f390ca3 100644
--- a/runtime/lua/vim/_meta.lua
+++ b/runtime/lua/vim/_meta.lua
@@ -1,5 +1,8 @@
 --- @meta
 
+---@type uv
+vim.uv = ...
+
 --- The following modules are loaded specially in _init_packages.lua
 
 vim.F = require('vim.F')
@@ -15,6 +18,7 @@ vim.loader = require('vim.loader')
 vim.lsp = require('vim.lsp')
 vim.re = require('vim.re')
 vim.secure = require('vim.secure')
+vim.treesitter = require('vim.treesitter')
 vim.ui = require('vim.ui')
 vim.version = require('vim.version')
 
-- 
cgit 


From ce792db5b806b41d5d687e3b09da9ab2b6be0307 Mon Sep 17 00:00:00 2001
From: ObserverOfTime <chronobserver@disroot.org>
Date: Mon, 7 Aug 2023 19:44:52 +0300
Subject: vim-patch:9.0.1678: blade files are not recognized (#24601)

Problem:    Blade files are not recognized.
Solution:   Add a pattern for Blade files. (closes vim/vim#12650)

https://github.com/vim/vim/commit/ad34abee258322826146d597ac5b5fd2111c2b79

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 40f72a217d..66e224ce69 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1809,6 +1809,7 @@ local pattern = {
   ['.*/build/conf/.*%.conf'] = 'bitbake',
   ['.*/meta/conf/.*%.conf'] = 'bitbake',
   ['.*/meta%-.*/conf/.*%.conf'] = 'bitbake',
+  ['.*%.blade%.php'] = 'blade',
   ['bzr_log%..*'] = 'bzr',
   ['.*enlightenment/.*%.cfg'] = 'c',
   ['${HOME}/cabal%.config'] = 'cabalconfig',
-- 
cgit 


From 0211f889b9538f7df5fbcb06273d273fb071efff Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 7 Aug 2023 18:22:36 +0100
Subject: fix(treesitter): make sure injections don't return empty ranges
 (#24595)

When an injection has not set include children, make sure not to add
the injection if no ranges are determined.

This could happen when there is an injection with a child that has the
same range as itself. e.g. consider this Makefile snippet

```make
foo:
  $(VAR)
```

Line 2 has an injection for bash and a make variable reference. If
include-children isn't set (default), then there is no range on line 2
to inject since the variable reference needs to be excluded.

This caused the language tree to return an empty range, which the parser
now interprets to mean the full buffer. This caused makefiles to have
completely broken highlighting.
---
 runtime/lua/vim/treesitter/languagetree.lua | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 0d4a1a54dd..4b2628609a 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -110,6 +110,10 @@ function LanguageTree.new(source, lang, opts)
   ---@type LanguageTreeOpts
   opts = opts or {}
 
+  if source == 0 then
+    source = vim.api.nvim_get_current_buf()
+  end
+
   local injections = opts.injections or {}
   local self = setmetatable({
     _source = source,
@@ -561,11 +565,13 @@ end
 ---@param node TSNode
 ---@param source string|integer
 ---@param metadata TSMetadata
+---@param include_children boolean
 ---@return Range6[]
 local function get_node_ranges(node, source, metadata, include_children)
   local range = vim.treesitter.get_range(node, source, metadata)
+  local child_count = node:named_child_count()
 
-  if include_children then
+  if include_children or child_count == 0 then
     return { range }
   end
 
@@ -573,7 +579,8 @@ local function get_node_ranges(node, source, metadata, include_children)
 
   local srow, scol, sbyte, erow, ecol, ebyte = Range.unpack6(range)
 
-  for i = 0, node:named_child_count() - 1 do
+  -- We are excluding children so we need to mask out their ranges
+  for i = 0, child_count - 1 do
     local child = node:named_child(i)
     local c_srow, c_scol, c_sbyte, c_erow, c_ecol, c_ebyte = child:range(true)
     if c_srow > srow or c_scol > scol then
@@ -604,7 +611,10 @@ end
 ---@param combined boolean
 ---@param ranges Range6[]
 local function add_injection(t, tree_index, pattern, lang, combined, ranges)
-  assert(type(lang) == 'string')
+  if #ranges == 0 then
+    -- Make sure not to add an empty range set as this is interpreted to mean the whole buffer.
+    return
+  end
 
   -- Each tree index should be isolated from the other nodes.
   if not t[tree_index] then
-- 
cgit 


From 628763fbd82d0fab292b7e92b553c6b1ed53e556 Mon Sep 17 00:00:00 2001
From: bfredl <bjorn.linse@gmail.com>
Date: Tue, 8 Aug 2023 10:40:43 +0200
Subject: docs(lua): the keyset nilocalypse

This is needed to give recent LuaLS the right idea about optional fields.
---
 runtime/lua/vim/_meta/api_keysets.lua | 386 +++++++++++++++++-----------------
 1 file changed, 193 insertions(+), 193 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index 5f8cb93144..941780202e 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -4,246 +4,246 @@
 error('Cannot require a meta file')
 
 --- @class vim.api.keyset.clear_autocmds
---- @field buffer integer
---- @field event any
---- @field group any
---- @field pattern any
+--- @field buffer? integer
+--- @field event? any
+--- @field group? any
+--- @field pattern? any
 
 --- @class vim.api.keyset.cmd
---- @field cmd string
---- @field range any[]
---- @field count integer
---- @field reg string
---- @field bang boolean
---- @field args any[]
---- @field magic table<string,any>
---- @field mods table<string,any>
---- @field nargs any
---- @field addr any
---- @field nextcmd any
+--- @field cmd? string
+--- @field range? any[]
+--- @field count? integer
+--- @field reg? string
+--- @field bang? boolean
+--- @field args? any[]
+--- @field magic? table<string,any>
+--- @field mods? table<string,any>
+--- @field nargs? any
+--- @field addr? any
+--- @field nextcmd? any
 
 --- @class vim.api.keyset.cmd_magic
---- @field file boolean
---- @field bar boolean
+--- @field file? boolean
+--- @field bar? boolean
 
 --- @class vim.api.keyset.cmd_mods
---- @field silent boolean
---- @field emsg_silent boolean
---- @field unsilent boolean
---- @field filter table<string,any>
---- @field sandbox boolean
---- @field noautocmd boolean
---- @field browse boolean
---- @field confirm boolean
---- @field hide boolean
---- @field horizontal boolean
---- @field keepalt boolean
---- @field keepjumps boolean
---- @field keepmarks boolean
---- @field keeppatterns boolean
---- @field lockmarks boolean
---- @field noswapfile boolean
---- @field tab integer
---- @field verbose integer
---- @field vertical boolean
---- @field split string
+--- @field silent? boolean
+--- @field emsg_silent? boolean
+--- @field unsilent? boolean
+--- @field filter? table<string,any>
+--- @field sandbox? boolean
+--- @field noautocmd? boolean
+--- @field browse? boolean
+--- @field confirm? boolean
+--- @field hide? boolean
+--- @field horizontal? boolean
+--- @field keepalt? boolean
+--- @field keepjumps? boolean
+--- @field keepmarks? boolean
+--- @field keeppatterns? boolean
+--- @field lockmarks? boolean
+--- @field noswapfile? boolean
+--- @field tab? integer
+--- @field verbose? integer
+--- @field vertical? boolean
+--- @field split? string
 
 --- @class vim.api.keyset.cmd_mods_filter
---- @field pattern string
---- @field force boolean
+--- @field pattern? string
+--- @field force? boolean
 
 --- @class vim.api.keyset.cmd_opts
---- @field output boolean
+--- @field output? boolean
 
 --- @class vim.api.keyset.context
---- @field types any[]
+--- @field types? any[]
 
 --- @class vim.api.keyset.create_augroup
---- @field clear any
+--- @field clear? any
 
 --- @class vim.api.keyset.create_autocmd
---- @field buffer integer
---- @field callback any
---- @field command string
---- @field desc string
---- @field group any
---- @field nested boolean
---- @field once boolean
---- @field pattern any
+--- @field buffer? integer
+--- @field callback? any
+--- @field command? string
+--- @field desc? string
+--- @field group? any
+--- @field nested? boolean
+--- @field once? boolean
+--- @field pattern? any
 
 --- @class vim.api.keyset.echo_opts
---- @field verbose boolean
+--- @field verbose? boolean
 
 --- @class vim.api.keyset.eval_statusline
---- @field winid integer
---- @field maxwidth integer
---- @field fillchar string
---- @field highlights boolean
---- @field use_winbar boolean
---- @field use_tabline boolean
---- @field use_statuscol_lnum integer
+--- @field winid? integer
+--- @field maxwidth? integer
+--- @field fillchar? string
+--- @field highlights? boolean
+--- @field use_winbar? boolean
+--- @field use_tabline? boolean
+--- @field use_statuscol_lnum? integer
 
 --- @class vim.api.keyset.exec_autocmds
---- @field buffer integer
---- @field group any
---- @field modeline boolean
---- @field pattern any
---- @field data any
+--- @field buffer? integer
+--- @field group? any
+--- @field modeline? boolean
+--- @field pattern? any
+--- @field data? any
 
 --- @class vim.api.keyset.exec_opts
---- @field output boolean
+--- @field output? boolean
 
 --- @class vim.api.keyset.float_config
---- @field row number
---- @field col number
---- @field width integer
---- @field height integer
---- @field anchor string
---- @field relative string
---- @field win integer
---- @field bufpos any[]
---- @field external boolean
---- @field focusable boolean
---- @field zindex integer
---- @field border any
---- @field title any
---- @field title_pos string
---- @field style string
---- @field noautocmd boolean
+--- @field row? number
+--- @field col? number
+--- @field width? integer
+--- @field height? integer
+--- @field anchor? string
+--- @field relative? string
+--- @field win? integer
+--- @field bufpos? any[]
+--- @field external? boolean
+--- @field focusable? boolean
+--- @field zindex? integer
+--- @field border? any
+--- @field title? any
+--- @field title_pos? string
+--- @field style? string
+--- @field noautocmd? boolean
 
 --- @class vim.api.keyset.get_autocmds
---- @field event any
---- @field group any
---- @field pattern any
---- @field buffer any
+--- @field event? any
+--- @field group? any
+--- @field pattern? any
+--- @field buffer? any
 
 --- @class vim.api.keyset.get_commands
---- @field builtin boolean
+--- @field builtin? boolean
 
 --- @class vim.api.keyset.get_highlight
---- @field id integer
---- @field name string
---- @field link boolean
+--- @field id? integer
+--- @field name? string
+--- @field link? boolean
 
 --- @class vim.api.keyset.highlight
---- @field bold boolean
---- @field standout boolean
---- @field strikethrough boolean
---- @field underline boolean
---- @field undercurl boolean
---- @field underdouble boolean
---- @field underdotted boolean
---- @field underdashed boolean
---- @field italic boolean
---- @field reverse boolean
---- @field altfont boolean
---- @field nocombine boolean
---- @field default boolean
---- @field cterm any
---- @field foreground any
---- @field fg any
---- @field background any
---- @field bg any
---- @field ctermfg any
---- @field ctermbg any
---- @field special any
---- @field sp any
---- @field link any
---- @field global_link any
---- @field fallback boolean
---- @field blend integer
---- @field fg_indexed boolean
---- @field bg_indexed boolean
+--- @field bold? boolean
+--- @field standout? boolean
+--- @field strikethrough? boolean
+--- @field underline? boolean
+--- @field undercurl? boolean
+--- @field underdouble? boolean
+--- @field underdotted? boolean
+--- @field underdashed? boolean
+--- @field italic? boolean
+--- @field reverse? boolean
+--- @field altfont? boolean
+--- @field nocombine? boolean
+--- @field default? boolean
+--- @field cterm? any
+--- @field foreground? any
+--- @field fg? any
+--- @field background? any
+--- @field bg? any
+--- @field ctermfg? any
+--- @field ctermbg? any
+--- @field special? any
+--- @field sp? any
+--- @field link? any
+--- @field global_link? any
+--- @field fallback? boolean
+--- @field blend? integer
+--- @field fg_indexed? boolean
+--- @field bg_indexed? boolean
 
 --- @class vim.api.keyset.highlight_cterm
---- @field bold boolean
---- @field standout boolean
---- @field strikethrough boolean
---- @field underline boolean
---- @field undercurl boolean
---- @field underdouble boolean
---- @field underdotted boolean
---- @field underdashed boolean
---- @field italic boolean
---- @field reverse boolean
---- @field altfont boolean
---- @field nocombine boolean
+--- @field bold? boolean
+--- @field standout? boolean
+--- @field strikethrough? boolean
+--- @field underline? boolean
+--- @field undercurl? boolean
+--- @field underdouble? boolean
+--- @field underdotted? boolean
+--- @field underdashed? boolean
+--- @field italic? boolean
+--- @field reverse? boolean
+--- @field altfont? boolean
+--- @field nocombine? boolean
 
 --- @class vim.api.keyset.keymap
---- @field noremap boolean
---- @field nowait boolean
---- @field silent boolean
---- @field script boolean
---- @field expr boolean
---- @field unique boolean
---- @field callback function
---- @field desc string
---- @field replace_keycodes boolean
+--- @field noremap? boolean
+--- @field nowait? boolean
+--- @field silent? boolean
+--- @field script? boolean
+--- @field expr? boolean
+--- @field unique? boolean
+--- @field callback? function
+--- @field desc? string
+--- @field replace_keycodes? boolean
 
 --- @class vim.api.keyset.option
---- @field scope string
---- @field win integer
---- @field buf integer
---- @field filetype string
+--- @field scope? string
+--- @field win? integer
+--- @field buf? integer
+--- @field filetype? string
 
 --- @class vim.api.keyset.runtime
---- @field is_lua boolean
---- @field do_source boolean
+--- @field is_lua? boolean
+--- @field do_source? boolean
 
 --- @class vim.api.keyset.set_decoration_provider
---- @field on_start function
---- @field on_buf function
---- @field on_win function
---- @field on_line function
---- @field on_end function
---- @field _on_hl_def function
---- @field _on_spell_nav function
+--- @field on_start? function
+--- @field on_buf? function
+--- @field on_win? function
+--- @field on_line? function
+--- @field on_end? function
+--- @field _on_hl_def? function
+--- @field _on_spell_nav? function
 
 --- @class vim.api.keyset.set_extmark
---- @field id integer
---- @field end_line integer
---- @field end_row integer
---- @field end_col integer
---- @field hl_group any
---- @field virt_text any[]
---- @field virt_text_pos string
---- @field virt_text_win_col integer
---- @field virt_text_hide boolean
---- @field hl_eol boolean
---- @field hl_mode string
---- @field ephemeral boolean
---- @field priority integer
---- @field right_gravity boolean
---- @field end_right_gravity boolean
---- @field virt_lines any[]
---- @field virt_lines_above boolean
---- @field virt_lines_leftcol boolean
---- @field strict boolean
---- @field sign_text string
---- @field sign_hl_group any
---- @field number_hl_group any
---- @field line_hl_group any
---- @field cursorline_hl_group any
---- @field conceal string
---- @field spell boolean
---- @field ui_watched boolean
+--- @field id? integer
+--- @field end_line? integer
+--- @field end_row? integer
+--- @field end_col? integer
+--- @field hl_group? any
+--- @field virt_text? any[]
+--- @field virt_text_pos? string
+--- @field virt_text_win_col? integer
+--- @field virt_text_hide? boolean
+--- @field hl_eol? boolean
+--- @field hl_mode? string
+--- @field ephemeral? boolean
+--- @field priority? integer
+--- @field right_gravity? boolean
+--- @field end_right_gravity? boolean
+--- @field virt_lines? any[]
+--- @field virt_lines_above? boolean
+--- @field virt_lines_leftcol? boolean
+--- @field strict? boolean
+--- @field sign_text? string
+--- @field sign_hl_group? any
+--- @field number_hl_group? any
+--- @field line_hl_group? any
+--- @field cursorline_hl_group? any
+--- @field conceal? string
+--- @field spell? boolean
+--- @field ui_watched? boolean
 
 --- @class vim.api.keyset.user_command
---- @field addr any
---- @field bang boolean
---- @field bar boolean
---- @field complete any
---- @field count any
---- @field desc any
---- @field force boolean
---- @field keepscript boolean
---- @field nargs any
---- @field preview any
---- @field range any
---- @field register boolean
+--- @field addr? any
+--- @field bang? boolean
+--- @field bar? boolean
+--- @field complete? any
+--- @field count? any
+--- @field desc? any
+--- @field force? boolean
+--- @field keepscript? boolean
+--- @field nargs? any
+--- @field preview? any
+--- @field range? any
+--- @field register? boolean
 
 --- @class vim.api.keyset.win_text_height
---- @field start_row integer
---- @field end_row integer
---- @field start_vcol integer
---- @field end_vcol integer
+--- @field start_row? integer
+--- @field end_row? integer
+--- @field start_vcol? integer
+--- @field end_vcol? integer
-- 
cgit 


From 37c58226a8fd02afe9836f2fe43b31570fc50bb9 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 8 Aug 2023 11:58:29 +0100
Subject: fix(lua): vim.fs typing (#24608)

---
 runtime/lua/vim/fs.lua | 28 ++++++++++++++++++++--------
 1 file changed, 20 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index 92966523c0..7cd9e3cf04 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -20,7 +20,9 @@ local iswin = vim.uv.os_uname().sysname == 'Windows_NT'
 --- </pre>
 ---
 ---@param start (string) Initial path.
----@return function Iterator
+---@return fun(_, dir: string): string? # Iterator
+---@return nil
+---@return string|nil
 function M.parents(start)
   return function(_, dir)
     local parent = M.dirname(dir)
@@ -120,6 +122,7 @@ function M.dir(path, opts)
   return coroutine.wrap(function()
     local dirs = { { path, 1 } }
     while #dirs > 0 do
+      --- @type string, integer
       local dir0, level = unpack(table.remove(dirs, 1))
       local dir = level == 1 and dir0 or M.joinpath(path, dir0)
       local fs = vim.uv.fs_scandir(M.normalize(dir))
@@ -143,6 +146,13 @@ function M.dir(path, opts)
   end)
 end
 
+--- @class vim.fs.find.opts
+--- @field path string
+--- @field upward boolean
+--- @field stop string
+--- @field type string
+--- @field limit number
+
 --- Find files or directories (or other items as specified by `opts.type`) in the given path.
 ---
 --- Finds items given in {names} starting from {path}. If {upward} is "true"
@@ -175,7 +185,7 @@ end
 --- end, {limit = math.huge, type = 'file'})
 --- </pre>
 ---
----@param names (string|table|fun(name: string, path: string): boolean) Names of the items to find.
+---@param names (string|string[]|fun(name: string, path: string): boolean) Names of the items to find.
 ---             Must be base names, paths and globs are not supported when {names} is a string or a table.
 ---             If {names} is a function, it is called for each traversed item with args:
 ---             - name: base name of the current item
@@ -196,9 +206,9 @@ end
 ---                       - limit (number, default 1): Stop the search after
 ---                               finding this many matches. Use `math.huge` to
 ---                               place no limit on the number of matches.
----@return (table) Normalized paths |vim.fs.normalize()| of all matching items
+---@return (string[]) # Normalized paths |vim.fs.normalize()| of all matching items
 function M.find(names, opts)
-  opts = opts or {}
+  opts = opts or {} --[[@as vim.fs.find.opts]]
   vim.validate({
     names = { names, { 's', 't', 'f' } },
     path = { opts.path, 's', true },
@@ -208,13 +218,15 @@ function M.find(names, opts)
     limit = { opts.limit, 'n', true },
   })
 
-  names = type(names) == 'string' and { names } or names
+  if type(names) == 'string' then
+    names = { names }
+  end
 
   local path = opts.path or vim.uv.cwd()
   local stop = opts.stop
   local limit = opts.limit or 1
 
-  local matches = {}
+  local matches = {} --- @type string[]
 
   local function add(match)
     matches[#matches + 1] = M.normalize(match)
@@ -224,7 +236,7 @@ function M.find(names, opts)
   end
 
   if opts.upward then
-    local test
+    local test --- @type fun(p: string): string[]
 
     if type(names) == 'function' then
       test = function(p)
@@ -238,7 +250,7 @@ function M.find(names, opts)
       end
     else
       test = function(p)
-        local t = {}
+        local t = {} --- @type string[]
         for _, name in ipairs(names) do
           local f = M.joinpath(p, name)
           local stat = vim.uv.fs_stat(f)
-- 
cgit 


From c6c21db82b31ea43ce878ab3725dcd901db1e7a1 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 8 Aug 2023 16:36:06 +0100
Subject: fix(filetype): add typing and dry (#24573)

---
 runtime/lua/vim/_editor.lua         |    7 +
 runtime/lua/vim/filetype.lua        | 1205 +++++++++++++----------------------
 runtime/lua/vim/filetype/detect.lua |  546 ++++++++++------
 3 files changed, 815 insertions(+), 943 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 6182270708..d81464a3ca 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -428,10 +428,17 @@ vim.cmd = setmetatable({}, {
   end,
 })
 
+--- @class vim.var_accessor
+--- @field [string] any
+--- @field [integer] vim.var_accessor
+
 -- These are the vim.env/v/g/o/bo/wo variable magic accessors.
 do
   local validate = vim.validate
 
+  --- @param scope string
+  --- @param handle? false|integer
+  --- @return vim.var_accessor
   local function make_dict_accessor(scope, handle)
     validate({
       scope = { scope, 's' },
diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 66e224ce69..a53216f8ea 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1,7 +1,16 @@
 local api = vim.api
+local fn = vim.fn
 
 local M = {}
 
+--- @alias vim.filetype.mapfn fun(path:string,bufnr:integer, ...):string?, fun(b:integer)?
+--- @alias vim.filetype.maptbl {[1]:string|vim.filetype.mapfn, [2]:{priority:integer}}
+--- @alias vim.filetype.mapping.value string|vim.filetype.mapfn|vim.filetype.maptbl
+--- @alias vim.filetype.mapping table<string,vim.filetype.mapping.value>
+
+--- @param ft string|vim.filetype.mapfn
+--- @param opts? {priority:integer}
+--- @return vim.filetype.maptbl
 local function starsetf(ft, opts)
   return {
     function(path, bufnr)
@@ -23,36 +32,38 @@ local function starsetf(ft, opts)
 end
 
 ---@private
---- Get a single line or line range from the buffer.
---- If only start_lnum is specified, return a single line as a string.
---- If both start_lnum and end_lnum are omitted, return all lines from the buffer.
----
+--- Get a line range from the buffer.
 ---@param bufnr integer The buffer to get the lines from
 ---@param start_lnum integer|nil The line number of the first line (inclusive, 1-based)
 ---@param end_lnum integer|nil The line number of the last line (inclusive, 1-based)
----@return table<string>|string Array of lines, or string when end_lnum is omitted
-function M.getlines(bufnr, start_lnum, end_lnum)
-  if end_lnum then
-    -- Return a line range
-    return api.nvim_buf_get_lines(bufnr, start_lnum - 1, end_lnum, false)
-  end
+---@return string[] # Array of lines
+function M._getlines(bufnr, start_lnum, end_lnum)
   if start_lnum then
-    -- Return a single line
-    return api.nvim_buf_get_lines(bufnr, start_lnum - 1, start_lnum, false)[1] or ''
-  else
-    -- Return all lines
-    return api.nvim_buf_get_lines(bufnr, 0, -1, false)
+    return api.nvim_buf_get_lines(bufnr, start_lnum - 1, end_lnum or start_lnum, false)
   end
+
+  -- Return all lines
+  return api.nvim_buf_get_lines(bufnr, 0, -1, false)
+end
+
+---@private
+--- Get a single line from the buffer.
+---@param bufnr integer The buffer to get the lines from
+---@param start_lnum integer The line number of the first line (inclusive, 1-based)
+---@return string
+function M._getline(bufnr, start_lnum)
+  -- Return a single line
+  return api.nvim_buf_get_lines(bufnr, start_lnum - 1, start_lnum, false)[1] or ''
 end
 
 ---@private
 --- Check whether a string matches any of the given Lua patterns.
 ---
----@param s string The string to check
----@param patterns table<string> A list of Lua patterns
+---@param s string? The string to check
+---@param patterns string[] A list of Lua patterns
 ---@return boolean `true` if s matched a pattern, else `false`
-function M.findany(s, patterns)
-  if s == nil then
+function M._findany(s, patterns)
+  if not s then
     return false
   end
   for _, v in ipairs(patterns) do
@@ -69,8 +80,8 @@ end
 ---@param bufnr integer The buffer to get the line from
 ---@param start_lnum integer The line number of the first line to start from (inclusive, 1-based)
 ---@return string|nil The first non-blank line if found or `nil` otherwise
-function M.nextnonblank(bufnr, start_lnum)
-  for _, line in ipairs(M.getlines(bufnr, start_lnum, -1)) do
+function M._nextnonblank(bufnr, start_lnum)
+  for _, line in ipairs(M._getlines(bufnr, start_lnum, -1)) do
     if not line:find('^%s*$') then
       return line
     end
@@ -78,30 +89,93 @@ function M.nextnonblank(bufnr, start_lnum)
   return nil
 end
 
----@private
---- Check whether the given string matches the Vim regex pattern.
-M.matchregex = (function()
-  local cache = {}
-  return function(s, pattern)
-    if s == nil then
-      return nil
+do
+  --- @type table<string,vim.regex>
+  local regex_cache = {}
+
+  ---@private
+  --- Check whether the given string matches the Vim regex pattern.
+  --- @param s string?
+  --- @param pattern string
+  --- @return boolean
+  function M._matchregex(s, pattern)
+    if not s then
+      return false
+    end
+    if not regex_cache[pattern] then
+      regex_cache[pattern] = vim.regex(pattern)
+    end
+    return regex_cache[pattern]:match_str(s) ~= nil
+  end
+end
+
+--- @module 'vim.filetype.detect'
+local detect = setmetatable({}, {
+  --- @param k string
+  --- @param t table<string,function>
+  --- @return function
+  __index = function(t, k)
+    t[k] = function(...)
+      return require('vim.filetype.detect')[k](...)
+    end
+    return t[k]
+  end,
+})
+
+--- @param ... string|vim.filetype.mapfn
+--- @return vim.filetype.mapfn
+local function detect_seq(...)
+  local candidates = { ... }
+  return function(...)
+    for _, c in ipairs(candidates) do
+      if type(c) == 'string' then
+        return c
+      end
+      if type(c) == 'function' then
+        local r = c(...)
+        if r then
+          return r
+        end
+      end
     end
-    if not cache[pattern] then
-      cache[pattern] = vim.regex(pattern)
+  end
+end
+
+local function detect_noext(path, bufnr)
+  local root = fn.fnamemodify(path, ':r')
+  return M.match({ buf = bufnr, filename = root })
+end
+
+--- @param pat string
+--- @param a string?
+--- @param b string?
+--- @return vim.filetype.mapfn
+local function detect_line1(pat, a, b)
+  return function(_path, bufnr)
+    if M._getline(bufnr, 1):find(pat) then
+      return a
     end
-    return cache[pattern]:match_str(s)
+    return b
   end
-end)()
+end
+
+--- @type vim.filetype.mapfn
+local detect_rc = function(path, _bufnr)
+  if not path:find('/etc/Muttrc%.d/') then
+    return 'rc'
+  end
+end
 
 -- luacheck: push no unused args
 -- luacheck: push ignore 122
 
 -- Filetypes based on file extension
 ---@diagnostic disable: unused-local
+--- @type vim.filetype.mapping
 local extension = {
   -- BEGIN EXTENSION
   ['8th'] = '8th',
-  ['a65'] = 'a65',
+  a65 = 'a65',
   aap = 'aap',
   abap = 'abap',
   abc = 'abc',
@@ -127,51 +201,33 @@ local extension = {
     end
     return 'aspvbs'
   end,
-  asm = function(path, bufnr)
-    return require('vim.filetype.detect').asm(bufnr)
-  end,
-  lst = function(path, bufnr)
-    return require('vim.filetype.detect').asm(bufnr)
-  end,
-  mac = function(path, bufnr)
-    return require('vim.filetype.detect').asm(bufnr)
-  end,
-  ['asn1'] = 'asn',
+  asm = detect.asm,
+  lst = detect.asm,
+  mac = detect.asm,
+  asn1 = 'asn',
   asn = 'asn',
-  asp = function(path, bufnr)
-    return require('vim.filetype.detect').asp(bufnr)
-  end,
+  asp = detect.asp,
   astro = 'astro',
   atl = 'atlas',
   as = 'atlas',
   ahk = 'autohotkey',
-  ['au3'] = 'autoit',
+  au3 = 'autoit',
   ave = 'ave',
   gawk = 'awk',
   awk = 'awk',
   ref = 'b',
   imp = 'b',
   mch = 'b',
-  bas = function(path, bufnr)
-    return require('vim.filetype.detect').bas(bufnr)
-  end,
+  bas = detect.bas,
   bass = 'bass',
-  bi = function(path, bufnr)
-    return require('vim.filetype.detect').bas(bufnr)
-  end,
-  bm = function(path, bufnr)
-    return require('vim.filetype.detect').bas(bufnr)
-  end,
+  bi = detect.bas,
+  bm = detect.bas,
   bc = 'bc',
   bdf = 'bdf',
   beancount = 'beancount',
   bib = 'bib',
-  com = function(path, bufnr)
-    return require('vim.filetype.detect').bindzone(bufnr, 'dcl')
-  end,
-  db = function(path, bufnr)
-    return require('vim.filetype.detect').bindzone(bufnr)
-  end,
+  com = detect_seq(detect.bindzone, 'dcl'),
+  db = detect.bindzone,
   bicep = 'bicep',
   bb = 'bitbake',
   bbappend = 'bitbake',
@@ -201,9 +257,7 @@ local extension = {
   hgrc = 'cfg',
   chf = 'ch',
   chai = 'chaiscript',
-  ch = function(path, bufnr)
-    return require('vim.filetype.detect').change(bufnr)
-  end,
+  ch = detect.change,
   chs = 'chaskell',
   chatito = 'chatito',
   chopro = 'chordpro',
@@ -226,7 +280,7 @@ local extension = {
   atg = 'coco',
   recipe = 'conaryrecipe',
   hook = function(path, bufnr)
-    return M.getlines(bufnr, 1) == '[Trigger]' and 'conf'
+    return M._getline(bufnr, 1) == '[Trigger]' and 'conf' or nil
   end,
   nmconnection = 'confini',
   mklx = 'context',
@@ -234,16 +288,10 @@ local extension = {
   mkii = 'context',
   mkxl = 'context',
   mkvi = 'context',
-  control = function(path, bufnr)
-    return require('vim.filetype.detect').control(bufnr)
-  end,
-  copyright = function(path, bufnr)
-    return require('vim.filetype.detect').copyright(bufnr)
-  end,
+  control = detect.control,
+  copyright = detect.copyright,
   corn = 'corn',
-  csh = function(path, bufnr)
-    return require('vim.filetype.detect').csh(path, bufnr)
-  end,
+  csh = detect.csh,
   cpon = 'cpon',
   moc = 'cpp',
   hh = 'cpp',
@@ -261,12 +309,8 @@ local extension = {
   cppm = 'cpp',
   cxxm = 'cpp',
   ['c++m'] = 'cpp',
-  cpp = function(path, bufnr)
-    return vim.g.cynlib_syntax_for_cpp and 'cynlib' or 'cpp'
-  end,
-  cc = function(path, bufnr)
-    return vim.g.cynlib_syntax_for_cc and 'cynlib' or 'cpp'
-  end,
+  cpp = detect.cpp,
+  cc = detect.cpp,
   cql = 'cqlang',
   crm = 'crm',
   cr = 'crystal',
@@ -291,15 +335,9 @@ local extension = {
   drt = 'dart',
   ds = 'datascript',
   dcd = 'dcd',
-  decl = function(path, bufnr)
-    return require('vim.filetype.detect').decl(bufnr)
-  end,
-  dec = function(path, bufnr)
-    return require('vim.filetype.detect').decl(bufnr)
-  end,
-  dcl = function(path, bufnr)
-    return require('vim.filetype.detect').decl(bufnr) or 'clean'
-  end,
+  decl = detect.decl,
+  dec = detect.decl,
+  dcl = detect_seq(detect.decl, 'clean'),
   def = 'def',
   desc = 'desc',
   directory = 'desktop',
@@ -317,27 +355,19 @@ local extension = {
   drac = 'dracula',
   drc = 'dracula',
   dtd = 'dtd',
-  d = function(path, bufnr)
-    return require('vim.filetype.detect').dtrace(bufnr)
-  end,
+  d = detect.dtrace,
   dts = 'dts',
   dtsi = 'dts',
   dylan = 'dylan',
   intr = 'dylanintr',
   lid = 'dylanlid',
-  e = function(path, bufnr)
-    return require('vim.filetype.detect').e(bufnr)
-  end,
-  E = function(path, bufnr)
-    return require('vim.filetype.detect').e(bufnr)
-  end,
+  e = detect.e,
+  E = detect.e,
   ecd = 'ecd',
   edf = 'edif',
   edif = 'edif',
   edo = 'edif',
-  edn = function(path, bufnr)
-    return require('vim.filetype.detect').edn(bufnr)
-  end,
+  edn = detect.edn,
   eex = 'eelixir',
   leex = 'eelixir',
   am = 'elf',
@@ -345,9 +375,7 @@ local extension = {
   elm = 'elm',
   lc = 'elsa',
   elv = 'elvish',
-  ent = function(path, bufnr)
-    return require('vim.filetype.detect').ent(bufnr)
-  end,
+  ent = detect.ent,
   epp = 'epuppet',
   erl = 'erlang',
   hrl = 'erlang',
@@ -358,43 +386,23 @@ local extension = {
   ec = 'esqlc',
   EC = 'esqlc',
   strl = 'esterel',
-  eu = function(path, bufnr)
-    return vim.g.filetype_euphoria or 'euphoria3'
-  end,
-  EU = function(path, bufnr)
-    return vim.g.filetype_euphoria or 'euphoria3'
-  end,
-  ew = function(path, bufnr)
-    return vim.g.filetype_euphoria or 'euphoria3'
-  end,
-  EW = function(path, bufnr)
-    return vim.g.filetype_euphoria or 'euphoria3'
-  end,
-  EX = function(path, bufnr)
-    return vim.g.filetype_euphoria or 'euphoria3'
-  end,
-  exu = function(path, bufnr)
-    return vim.g.filetype_euphoria or 'euphoria3'
-  end,
-  EXU = function(path, bufnr)
-    return vim.g.filetype_euphoria or 'euphoria3'
-  end,
-  exw = function(path, bufnr)
-    return vim.g.filetype_euphoria or 'euphoria3'
-  end,
-  EXW = function(path, bufnr)
-    return vim.g.filetype_euphoria or 'euphoria3'
-  end,
-  ex = function(path, bufnr)
-    return require('vim.filetype.detect').ex(bufnr)
-  end,
+  eu = detect.euphoria,
+  EU = detect.euphoria,
+  ew = detect.euphoria,
+  EW = detect.euphoria,
+  EX = detect.euphoria,
+  exu = detect.euphoria,
+  EXU = detect.euphoria,
+  exw = detect.euphoria,
+  EXW = detect.euphoria,
+  ex = detect.ex,
   exp = 'expect',
   factor = 'factor',
   fal = 'falcon',
   fan = 'fan',
   fwt = 'fan',
   fnl = 'fennel',
-  ['m4gl'] = 'fgl',
+  m4gl = 'fgl',
   ['4gl'] = 'fgl',
   ['4gh'] = 'fgl',
   fir = 'firrtl',
@@ -404,33 +412,29 @@ local extension = {
   fth = 'forth',
   ft = 'forth',
   FOR = 'fortran',
-  ['f77'] = 'fortran',
-  ['f03'] = 'fortran',
+  f77 = 'fortran',
+  f03 = 'fortran',
   fortran = 'fortran',
-  ['F95'] = 'fortran',
-  ['f90'] = 'fortran',
-  ['F03'] = 'fortran',
+  F95 = 'fortran',
+  f90 = 'fortran',
+  F03 = 'fortran',
   fpp = 'fortran',
   FTN = 'fortran',
   ftn = 'fortran',
   ['for'] = 'fortran',
-  ['F90'] = 'fortran',
-  ['F77'] = 'fortran',
-  ['f95'] = 'fortran',
+  F90 = 'fortran',
+  F77 = 'fortran',
+  f95 = 'fortran',
   FPP = 'fortran',
   f = 'fortran',
   F = 'fortran',
-  ['F08'] = 'fortran',
-  ['f08'] = 'fortran',
+  F08 = 'fortran',
+  f08 = 'fortran',
   fpc = 'fpcmake',
   fsl = 'framescript',
-  frm = function(path, bufnr)
-    return require('vim.filetype.detect').frm(bufnr)
-  end,
+  frm = detect.frm,
   fb = 'freebasic',
-  fs = function(path, bufnr)
-    return require('vim.filetype.detect').fs(bufnr)
-  end,
+  fs = detect.fs,
   fsh = 'fsh',
   fsi = 'fsharp',
   fsx = 'fsharp',
@@ -478,9 +482,7 @@ local extension = {
   ht = 'haste',
   htpp = 'hastepreproc',
   hb = 'hb',
-  h = function(path, bufnr)
-    return require('vim.filetype.detect').header(bufnr)
-  end,
+  h = detect.header,
   sum = 'hercules',
   errsum = 'hercules',
   ev = 'hercules',
@@ -495,56 +497,28 @@ local extension = {
   hog = 'hog',
   hws = 'hollywood',
   hoon = 'hoon',
-  cpt = function(path, bufnr)
-    return require('vim.filetype.detect').html(bufnr)
-  end,
-  dtml = function(path, bufnr)
-    return require('vim.filetype.detect').html(bufnr)
-  end,
-  htm = function(path, bufnr)
-    return require('vim.filetype.detect').html(bufnr)
-  end,
-  html = function(path, bufnr)
-    return require('vim.filetype.detect').html(bufnr)
-  end,
-  pt = function(path, bufnr)
-    return require('vim.filetype.detect').html(bufnr)
-  end,
-  shtml = function(path, bufnr)
-    return require('vim.filetype.detect').html(bufnr)
-  end,
-  stm = function(path, bufnr)
-    return require('vim.filetype.detect').html(bufnr)
-  end,
+  cpt = detect.html,
+  dtml = detect.html,
+  htm = detect.html,
+  html = detect.html,
+  pt = detect.html,
+  shtml = detect.html,
+  stm = detect.html,
   htt = 'httest',
   htb = 'httest',
-  hw = function(path, bufnr)
-    return require('vim.filetype.detect').hw(bufnr)
-  end,
-  module = function(path, bufnr)
-    return require('vim.filetype.detect').hw(bufnr)
-  end,
-  pkg = function(path, bufnr)
-    return require('vim.filetype.detect').hw(bufnr)
-  end,
+  hw = detect.hw,
+  module = detect.hw,
+  pkg = detect.hw,
   iba = 'ibasic',
   ibi = 'ibasic',
   icn = 'icon',
-  idl = function(path, bufnr)
-    return require('vim.filetype.detect').idl(bufnr)
-  end,
-  inc = function(path, bufnr)
-    return require('vim.filetype.detect').inc(bufnr)
-  end,
+  idl = detect.idl,
+  inc = detect.inc,
   inf = 'inform',
   INF = 'inform',
   ii = 'initng',
-  inp = function(path, bufnr)
-    return require('vim.filetype.detect').inp(bufnr)
-  end,
-  ms = function(path, bufnr)
-    return require('vim.filetype.detect').nroff(bufnr) or 'xmath'
-  end,
+  inp = detect.inp,
+  ms = detect_seq(detect.nroff, 'xmath'),
   iss = 'iss',
   mst = 'ist',
   ist = 'ist',
@@ -566,7 +540,7 @@ local extension = {
   jsx = 'javascriptreact',
   clp = 'jess',
   jgr = 'jgraph',
-  ['j73'] = 'jovial',
+  j73 = 'jovial',
   jov = 'jovial',
   jovial = 'jovial',
   properties = 'jproperties',
@@ -628,29 +602,21 @@ local extension = {
   lou = 'lout',
   ulpc = 'lpc',
   lpc = 'lpc',
-  c = function(path, bufnr)
-    return require('vim.filetype.detect').lpc(bufnr)
-  end,
-  lsl = function(path, bufnr)
-    return require('vim.filetype.detect').lsl(bufnr)
-  end,
+  c = detect.lpc,
+  lsl = detect.lsl,
   lss = 'lss',
   nse = 'lua',
   rockspec = 'lua',
   lua = 'lua',
   luau = 'luau',
   lrc = 'lyrics',
-  m = function(path, bufnr)
-    return require('vim.filetype.detect').m(bufnr)
-  end,
+  m = detect.m,
   at = 'm4',
-  mc = function(path, bufnr)
-    return require('vim.filetype.detect').mc(bufnr)
-  end,
+  mc = detect.mc,
   quake = 'm3quake',
-  ['m4'] = function(path, bufnr)
+  m4 = function(path, bufnr)
     path = path:lower()
-    return not (path:find('html%.m4$') or path:find('fvwm2rc')) and 'm4'
+    return not (path:find('html%.m4$') or path:find('fvwm2rc')) and 'm4' or nil
   end,
   eml = 'mail',
   mk = 'make',
@@ -689,16 +655,12 @@ local extension = {
   mib = 'mib',
   mix = 'mix',
   mixal = 'mix',
-  mm = function(path, bufnr)
-    return require('vim.filetype.detect').mm(bufnr)
-  end,
+  mm = detect.mm,
   nb = 'mma',
   mmp = 'mmp',
-  mms = function(path, bufnr)
-    return require('vim.filetype.detect').mms(bufnr)
-  end,
+  mms = detect.mms,
   DEF = 'modula2',
-  ['m2'] = 'modula2',
+  m2 = 'modula2',
   mi = 'modula2',
   lm3 = 'modula3',
   ssc = 'monk',
@@ -709,28 +671,16 @@ local extension = {
   moon = 'moonscript',
   move = 'move',
   mp = 'mp',
-  mpiv = function(path, bufnr)
-    return 'mp', function(b)
-      vim.b[b].mp_metafun = 1
-    end
-  end,
-  mpvi = function(path, bufnr)
-    return 'mp', function(b)
-      vim.b[b].mp_metafun = 1
-    end
-  end,
-  mpxl = function(path, bufnr)
-    return 'mp', function(b)
-      vim.b[b].mp_metafun = 1
-    end
-  end,
+  mpiv = detect.mp,
+  mpvi = detect.mp,
+  mpxl = detect.mp,
   mof = 'msidl',
   odl = 'msidl',
   msql = 'msql',
   mu = 'mupad',
   mush = 'mush',
   mysql = 'mysql',
-  ['n1ql'] = 'n1ql',
+  n1ql = 'n1ql',
   nql = 'n1ql',
   nanorc = 'nanorc',
   ncf = 'ncf',
@@ -798,12 +748,10 @@ local extension = {
   pike = 'pike',
   pmod = 'pike',
   rcp = 'pilrc',
-  PL = function(path, bufnr)
-    return require('vim.filetype.detect').pl(bufnr)
-  end,
+  PL = detect.pl,
   pli = 'pli',
-  ['pl1'] = 'pli',
-  ['p36'] = 'plm',
+  pl1 = 'pli',
+  p36 = 'plm',
   plm = 'plm',
   pac = 'plm',
   plp = 'plp',
@@ -832,11 +780,11 @@ local extension = {
   pml = 'promela',
   proto = 'proto',
   prql = 'prql',
-  ['psd1'] = 'ps1',
-  ['psm1'] = 'ps1',
-  ['ps1'] = 'ps1',
+  psd1 = 'ps1',
+  psm1 = 'ps1',
+  ps1 = 'ps1',
   pssc = 'ps1',
-  ['ps1xml'] = 'ps1xml',
+  ps1xml = 'ps1xml',
   psf = 'psf',
   psl = 'psl',
   pug = 'pug',
@@ -850,22 +798,20 @@ local extension = {
   ql = 'ql',
   qll = 'ql',
   qmd = 'quarto',
-  R = function(path, bufnr)
-    return require('vim.filetype.detect').r(bufnr)
-  end,
+  R = detect.r,
   rkt = 'racket',
   rktd = 'racket',
   rktl = 'racket',
   rad = 'radiance',
   mat = 'radiance',
-  ['pod6'] = 'raku',
+  pod6 = 'raku',
   rakudoc = 'raku',
   rakutest = 'raku',
   rakumod = 'raku',
-  ['pm6'] = 'raku',
+  pm6 = 'raku',
   raku = 'raku',
-  ['t6'] = 'raku',
-  ['p6'] = 'raku',
+  t6 = 'raku',
+  p6 = 'raku',
   raml = 'raml',
   rbs = 'rbs',
   rego = 'rego',
@@ -938,34 +884,18 @@ local extension = {
   sdl = 'sdl',
   sed = 'sed',
   sexp = 'sexplib',
-  bash = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  ebuild = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  eclass = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  env = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr))
-  end,
-  ksh = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'ksh')
-  end,
-  sh = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr))
-  end,
+  bash = detect.bash,
+  ebuild = detect.bash,
+  eclass = detect.bash,
+  env = detect.sh,
+  ksh = detect.ksh,
+  sh = detect.sh,
   sieve = 'sieve',
   siv = 'sieve',
-  sig = function(path, bufnr)
-    return require('vim.filetype.detect').sig(bufnr)
-  end,
-  sil = function(path, bufnr)
-    return require('vim.filetype.detect').sil(bufnr)
-  end,
+  sig = detect.sig,
+  sil = detect.sil,
   sim = 'simula',
-  ['s85'] = 'sinda',
+  s85 = 'sinda',
   sin = 'sinda',
   ssm = 'sisu',
   sst = 'sisu',
@@ -1002,9 +932,7 @@ local extension = {
   spi = 'spyce',
   spy = 'spyce',
   tyc = 'sql',
-  typ = function(path, bufnr)
-    return require('vim.filetype.detect').typ(bufnr)
-  end,
+  typ = detect.typ,
   pkb = 'sql',
   tyb = 'sql',
   pks = 'sql',
@@ -1012,11 +940,11 @@ local extension = {
   sqi = 'sqr',
   sqr = 'sqr',
   nut = 'squirrel',
-  ['s28'] = 'srec',
-  ['s37'] = 'srec',
+  s28 = 'srec',
+  s37 = 'srec',
   srec = 'srec',
   mot = 'srec',
-  ['s19'] = 'srec',
+  s19 = 'srec',
   srt = 'srt',
   ssa = 'ssa',
   ass = 'ssa',
@@ -1056,9 +984,7 @@ local extension = {
   bbl = 'tex',
   latex = 'tex',
   sty = 'tex',
-  cls = function(path, bufnr)
-    return require('vim.filetype.detect').cls(bufnr)
-  end,
+  cls = detect.cls,
   texi = 'texinfo',
   txi = 'texinfo',
   texinfo = 'texinfo',
@@ -1077,9 +1003,7 @@ local extension = {
   tsv = 'tsv',
   tutor = 'tutor',
   twig = 'twig',
-  ts = function(path, bufnr)
-    return M.getlines(bufnr, 1):find('<%?xml') and 'xml' or 'typescript'
-  end,
+  ts = detect_line1('<%?xml', 'xml', 'typescript'),
   mts = 'typescript',
   cts = 'typescript',
   tsx = 'typescriptreact',
@@ -1104,9 +1028,7 @@ local extension = {
   vr = 'vera',
   vri = 'vera',
   vrh = 'vera',
-  v = function(path, bufnr)
-    return require('vim.filetype.detect').v(bufnr)
-  end,
+  v = detect.v,
   va = 'verilogams',
   vams = 'verilogams',
   vhdl = 'vhdl',
@@ -1136,7 +1058,7 @@ local extension = {
   xht = 'xhtml',
   msc = 'xmath',
   msf = 'xmath',
-  ['psc1'] = 'xml',
+  psc1 = 'xml',
   tpm = 'xml',
   xliff = 'xml',
   atom = 'xml',
@@ -1152,10 +1074,8 @@ local extension = {
   csproj = 'xml',
   wpl = 'xml',
   xmi = 'xml',
-  xpm = function(path, bufnr)
-    return M.getlines(bufnr, 1):find('XPM2') and 'xpm2' or 'xpm'
-  end,
-  ['xpm2'] = 'xpm2',
+  xpm = detect_line1('XPM2', 'xpm2', 'xpm'),
+  xpm2 = 'xpm2',
   xqy = 'xquery',
   xqm = 'xquery',
   xquery = 'xquery',
@@ -1172,7 +1092,7 @@ local extension = {
   yaml = 'yaml',
   yang = 'yang',
   yuck = 'yuck',
-  ['z8a'] = 'z8a',
+  z8a = 'z8a',
   zig = 'zig',
   zir = 'zir',
   zu = 'zimbu',
@@ -1180,183 +1100,69 @@ local extension = {
   zs = 'zserio',
   zsh = 'zsh',
   vala = 'vala',
-  web = function(path, bufnr)
-    return require('vim.filetype.detect').web(bufnr)
-  end,
-  pl = function(path, bufnr)
-    return require('vim.filetype.detect').pl(bufnr)
-  end,
-  pp = function(path, bufnr)
-    return require('vim.filetype.detect').pp(bufnr)
-  end,
-  i = function(path, bufnr)
-    return require('vim.filetype.detect').progress_asm(bufnr)
-  end,
-  w = function(path, bufnr)
-    return require('vim.filetype.detect').progress_cweb(bufnr)
-  end,
-  p = function(path, bufnr)
-    return require('vim.filetype.detect').progress_pascal(bufnr)
-  end,
-  pro = function(path, bufnr)
-    return require('vim.filetype.detect').proto(bufnr, 'idlang')
-  end,
-  patch = function(path, bufnr)
-    return require('vim.filetype.detect').patch(bufnr)
-  end,
-  r = function(path, bufnr)
-    return require('vim.filetype.detect').r(bufnr)
-  end,
-  rdf = function(path, bufnr)
-    return require('vim.filetype.detect').redif(bufnr)
-  end,
-  rules = function(path, bufnr)
-    return require('vim.filetype.detect').rules(path)
-  end,
-  sc = function(path, bufnr)
-    return require('vim.filetype.detect').sc(bufnr)
-  end,
-  scd = function(path, bufnr)
-    return require('vim.filetype.detect').scd(bufnr)
-  end,
+  web = detect.web,
+  pl = detect.pl,
+  pp = detect.pp,
+  i = detect.progress_asm,
+  w = detect.progress_cweb,
+  p = detect.progress_pascal,
+  pro = detect_seq(detect.proto, 'idlang'),
+  patch = detect.patch,
+  r = detect.r,
+  rdf = detect.redif,
+  rules = detect.rules,
+  sc = detect.sc,
+  scd = detect.scd,
   tcsh = function(path, bufnr)
-    return require('vim.filetype.detect').shell(path, M.getlines(bufnr), 'tcsh')
-  end,
-  sql = function(path, bufnr)
-    return vim.g.filetype_sql and vim.g.filetype_sql or 'sql'
-  end,
-  zsql = function(path, bufnr)
-    return vim.g.filetype_sql and vim.g.filetype_sql or 'sql'
-  end,
-  tex = function(path, bufnr)
-    return require('vim.filetype.detect').tex(path, bufnr)
-  end,
-  tf = function(path, bufnr)
-    return require('vim.filetype.detect').tf(bufnr)
-  end,
-  txt = function(path, bufnr)
-    return require('vim.filetype.detect').txt(bufnr)
-  end,
-  xml = function(path, bufnr)
-    return require('vim.filetype.detect').xml(bufnr)
-  end,
-  y = function(path, bufnr)
-    return require('vim.filetype.detect').y(bufnr)
-  end,
-  cmd = function(path, bufnr)
-    return M.getlines(bufnr, 1):find('^/%*') and 'rexx' or 'dosbatch'
-  end,
-  rul = function(path, bufnr)
-    return require('vim.filetype.detect').rul(bufnr)
-  end,
-  cpy = function(path, bufnr)
-    return M.getlines(bufnr, 1):find('^##') and 'python' or 'cobol'
-  end,
-  dsl = function(path, bufnr)
-    return M.getlines(bufnr, 1):find('^%s*<!') and 'dsl' or 'structurizr'
-  end,
-  smil = function(path, bufnr)
-    return M.getlines(bufnr, 1):find('<%?%s*xml.*%?>') and 'xml' or 'smil'
-  end,
-  smi = function(path, bufnr)
-    return require('vim.filetype.detect').smi(bufnr)
-  end,
-  install = function(path, bufnr)
-    return require('vim.filetype.detect').install(path, bufnr)
-  end,
-  pm = function(path, bufnr)
-    return require('vim.filetype.detect').pm(bufnr)
-  end,
-  me = function(path, bufnr)
-    return require('vim.filetype.detect').me(path)
-  end,
-  reg = function(path, bufnr)
-    return require('vim.filetype.detect').reg(bufnr)
-  end,
-  ttl = function(path, bufnr)
-    return require('vim.filetype.detect').ttl(bufnr)
-  end,
-  rc = function(path, bufnr)
-    if not path:find('/etc/Muttrc%.d/') then
-      return 'rc'
-    end
-  end,
-  rch = function(path, bufnr)
-    if not path:find('/etc/Muttrc%.d/') then
-      return 'rc'
-    end
-  end,
-  class = function(path, bufnr)
-    require('vim.filetype.detect').class(bufnr)
-  end,
-  sgml = function(path, bufnr)
-    return require('vim.filetype.detect').sgml(bufnr)
-  end,
-  sgm = function(path, bufnr)
-    return require('vim.filetype.detect').sgml(bufnr)
-  end,
-  t = function(path, bufnr)
-    local nroff = require('vim.filetype.detect').nroff(bufnr)
-    return nroff or require('vim.filetype.detect').perl(path, bufnr) or 'tads'
-  end,
+    return require('vim.filetype.detect').shell(path, M._getlines(bufnr), 'tcsh')
+  end,
+  sql = detect.sql,
+  zsql = detect.sql,
+  tex = detect.tex,
+  tf = detect.tf,
+  txt = detect.txt,
+  xml = detect.xml,
+  y = detect.y,
+  cmd = detect_line1('^/%*', 'rexx', 'dosbatch'),
+  rul = detect.rul,
+  cpy = detect_line1('^##', 'python', 'cobol'),
+  dsl = detect_line1('^%s*<!', 'dsl', 'structurizr'),
+  smil = detect_line1('<%?%s*xml.*%?>', 'xml', 'smil'),
+  smi = detect.smi,
+  install = detect.install,
+  pm = detect.pm,
+  me = detect.me,
+  reg = detect.reg,
+  ttl = detect.ttl,
+  rc = detect_rc,
+  rch = detect_rc,
+  class = detect.class,
+  sgml = detect.sgml,
+  sgm = detect.sgml,
+  t = detect_seq(detect.nroff, detect.perl, 'tads'),
   -- Ignored extensions
-  bak = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
-  ['dpkg-bak'] = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
-  ['dpkg-dist'] = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
-  ['dpkg-old'] = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
-  ['dpkg-new'] = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
+  bak = detect_noext,
+  ['dpkg-bak'] = detect_noext,
+  ['dpkg-dist'] = detect_noext,
+  ['dpkg-old'] = detect_noext,
+  ['dpkg-new'] = detect_noext,
   ['in'] = function(path, bufnr)
     if vim.fs.basename(path) ~= 'configure.in' then
-      local root = vim.fn.fnamemodify(path, ':r')
+      local root = fn.fnamemodify(path, ':r')
       return M.match({ buf = bufnr, filename = root })
     end
   end,
-  new = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
-  old = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
-  orig = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
-  pacsave = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
-  pacnew = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
-  rpmsave = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
-  rmpnew = function(path, bufnr)
-    local root = vim.fn.fnamemodify(path, ':r')
-    return M.match({ buf = bufnr, filename = root })
-  end,
+  new = detect_noext,
+  old = detect_noext,
+  orig = detect_noext,
+  pacsave = detect_noext,
+  pacnew = detect_noext,
+  rpmsave = detect_noext,
+  rmpnew = detect_noext,
   -- END EXTENSION
 }
 
+--- @type vim.filetype.mapping
 local filename = {
   -- BEGIN FILENAME
   ['a2psrc'] = 'a2ps',
@@ -1387,24 +1193,12 @@ local filename = {
   ['/etc/defaults/cdrdao'] = 'cdrdaoconf',
   ['cfengine.conf'] = 'cfengine',
   ['CMakeLists.txt'] = 'cmake',
-  ['.alias'] = function(path, bufnr)
-    return require('vim.filetype.detect').csh(path, bufnr)
-  end,
-  ['.cshrc'] = function(path, bufnr)
-    return require('vim.filetype.detect').csh(path, bufnr)
-  end,
-  ['.login'] = function(path, bufnr)
-    return require('vim.filetype.detect').csh(path, bufnr)
-  end,
-  ['csh.cshrc'] = function(path, bufnr)
-    return require('vim.filetype.detect').csh(path, bufnr)
-  end,
-  ['csh.login'] = function(path, bufnr)
-    return require('vim.filetype.detect').csh(path, bufnr)
-  end,
-  ['csh.logout'] = function(path, bufnr)
-    return require('vim.filetype.detect').csh(path, bufnr)
-  end,
+  ['.alias'] = detect.csh,
+  ['.cshrc'] = detect.csh,
+  ['.login'] = detect.csh,
+  ['csh.cshrc'] = detect.csh,
+  ['csh.login'] = detect.csh,
+  ['csh.logout'] = detect.csh,
   ['auto.master'] = 'conf',
   ['configure.in'] = 'config',
   ['configure.ac'] = 'config',
@@ -1444,18 +1238,10 @@ local filename = {
   ['exim.conf'] = 'exim',
   exports = 'exports',
   ['.fetchmailrc'] = 'fetchmail',
-  fvSchemes = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
-  fvSolution = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
-  fvConstraints = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
-  fvModels = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
+  fvSchemes = detect.foam,
+  fvSolution = detect.foam,
+  fvConstraints = detect.foam,
+  fvModels = detect.foam,
   fstab = 'fstab',
   mtab = 'fstab',
   ['.gdbinit'] = 'gdb',
@@ -1463,11 +1249,11 @@ local filename = {
   ['.gdbearlyinit'] = 'gdb',
   gdbearlyinit = 'gdb',
   ['lltxxxxx.txt'] = 'gedcom',
-  ['TAG_EDITMSG'] = 'gitcommit',
-  ['MERGE_MSG'] = 'gitcommit',
-  ['COMMIT_EDITMSG'] = 'gitcommit',
-  ['NOTES_EDITMSG'] = 'gitcommit',
-  ['EDIT_DESCRIPTION'] = 'gitcommit',
+  TAG_EDITMSG = 'gitcommit',
+  MERGE_MSG = 'gitcommit',
+  COMMIT_EDITMSG = 'gitcommit',
+  NOTES_EDITMSG = 'gitcommit',
+  EDIT_DESCRIPTION = 'gitcommit',
   ['.gitconfig'] = 'gitconfig',
   ['.gitmodules'] = 'gitconfig',
   ['.gitattributes'] = 'gitattributes',
@@ -1486,7 +1272,7 @@ local filename = {
   ['.gprc'] = 'gp',
   ['/.gnupg/gpg.conf'] = 'gpg',
   ['/.gnupg/options'] = 'gpg',
-  ['Jenkinsfile'] = 'groovy',
+  Jenkinsfile = 'groovy',
   ['/var/backups/gshadow.bak'] = 'group',
   ['/etc/gshadow'] = 'group',
   ['/etc/group-'] = 'group',
@@ -1536,9 +1322,7 @@ local filename = {
   ['.sawfishrc'] = 'lisp',
   ['/etc/login.access'] = 'loginaccess',
   ['/etc/login.defs'] = 'logindefs',
-  ['.lsl'] = function(path, bufnr)
-    return require('vim.filetype.detect').lsl(bufnr)
-  end,
+  ['.lsl'] = detect.lsl,
   ['.busted'] = 'lua',
   ['.luacheckrc'] = 'lua',
   ['lynx.cfg'] = 'lynx',
@@ -1568,9 +1352,7 @@ local filename = {
   ['/etc/nanorc'] = 'nanorc',
   Neomuttrc = 'neomuttrc',
   ['.netrc'] = 'netrc',
-  NEWS = function(path, bufnr)
-    return require('vim.filetype.detect').news(bufnr)
-  end,
+  NEWS = detect.news,
   ['env.nu'] = 'nu',
   ['config.nu'] = 'nu',
   ['.ocamlinit'] = 'ocaml',
@@ -1601,34 +1383,28 @@ local filename = {
   ['/etc/pinforc'] = 'pinfo',
   ['/.pinforc'] = 'pinfo',
   ['.povrayrc'] = 'povini',
-  ['printcap'] = function(path, bufnr)
+  printcap = function(path, bufnr)
     return 'ptcap', function(b)
       vim.b[b].ptcap_type = 'print'
     end
   end,
-  ['termcap'] = function(path, bufnr)
+  termcap = function(path, bufnr)
     return 'ptcap', function(b)
       vim.b[b].ptcap_type = 'term'
     end
   end,
   ['.procmailrc'] = 'procmail',
   ['.procmail'] = 'procmail',
-  ['indent.pro'] = function(path, bufnr)
-    return require('vim.filetype.detect').proto(bufnr, 'indent')
-  end,
+  ['indent.pro'] = detect_seq(detect.proto, 'indent'),
   ['/etc/protocols'] = 'protocols',
-  ['INDEX'] = function(path, bufnr)
-    return require('vim.filetype.detect').psf(bufnr)
-  end,
-  ['INFO'] = function(path, bufnr)
-    return require('vim.filetype.detect').psf(bufnr)
-  end,
+  INDEX = detect.psf,
+  INFO = detect.psf,
   ['.pythonstartup'] = 'python',
   ['.pythonrc'] = 'python',
   SConstruct = 'python',
   qmldir = 'qmldir',
   ['.Rprofile'] = 'r',
-  ['Rprofile'] = 'r',
+  Rprofile = 'r',
   ['Rprofile.site'] = 'r',
   ratpoisonrc = 'ratpoison',
   ['.ratpoisonrc'] = 'ratpoison',
@@ -1650,42 +1426,18 @@ local filename = {
   ['/etc/services'] = 'services',
   ['/etc/serial.conf'] = 'setserial',
   ['/etc/udev/cdsymlinks.conf'] = 'sh',
-  ['bash.bashrc'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  bashrc = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  ['.bashrc'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  ['.env'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr))
-  end,
-  ['.kshrc'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'ksh')
-  end,
-  ['.profile'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr))
-  end,
-  ['/etc/profile'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr))
-  end,
-  APKBUILD = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  PKGBUILD = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  ['.tcshrc'] = function(path, bufnr)
-    return require('vim.filetype.detect').shell(path, M.getlines(bufnr), 'tcsh')
-  end,
-  ['tcsh.login'] = function(path, bufnr)
-    return require('vim.filetype.detect').shell(path, M.getlines(bufnr), 'tcsh')
-  end,
-  ['tcsh.tcshrc'] = function(path, bufnr)
-    return require('vim.filetype.detect').shell(path, M.getlines(bufnr), 'tcsh')
-  end,
+  ['bash.bashrc'] = detect.bash,
+  bashrc = detect.bash,
+  ['.bashrc'] = detect.bash,
+  ['.env'] = detect.sh,
+  ['.kshrc'] = detect.ksh,
+  ['.profile'] = detect.sh,
+  ['/etc/profile'] = detect.sh,
+  APKBUILD = detect.bash,
+  PKGBUILD = detect.bash,
+  ['.tcshrc'] = detect.tcsh,
+  ['tcsh.login'] = detect.tcsh,
+  ['tcsh.tcshrc'] = detect.tcsh,
   ['/etc/slp.conf'] = 'slpconf',
   ['/etc/slp.reg'] = 'slpreg',
   ['/etc/slp.spi'] = 'slpspi',
@@ -1739,19 +1491,9 @@ local filename = {
   ['.Xpdefaults'] = 'xdefaults',
   ['xdm-config'] = 'xdefaults',
   ['.Xdefaults'] = 'xdefaults',
-  ['xorg.conf'] = function(path, bufnr)
-    return 'xf86conf', function(b)
-      vim.b[b].xf86conf_xfree86_version = 4
-    end
-  end,
-  ['xorg.conf-4'] = function(path, bufnr)
-    return 'xf86conf', function(b)
-      vim.b[b].xf86conf_xfree86_version = 4
-    end
-  end,
-  ['XF86Config'] = function(path, bufnr)
-    return require('vim.filetype.detect').xfree86()
-  end,
+  ['xorg.conf'] = detect.xfree86_v4,
+  ['xorg.conf-4'] = detect.xfree86_v4,
+  ['XF86Config'] = detect.xfree86_v3,
   ['/etc/xinetd.conf'] = 'xinetd',
   fglrxrc = 'xml',
   ['/etc/blkid.tab'] = 'xml',
@@ -1770,6 +1512,12 @@ local filename = {
   -- END FILENAME
 }
 
+-- Re-use closures as much as possible
+local detect_apache = starsetf('apache')
+local detect_muttrc = starsetf('muttrc')
+local detect_neomuttrc = starsetf('neomuttrc')
+
+--- @type vim.filetype.mapping
 local pattern = {
   -- BEGIN PATTERN
   ['.*/etc/a2ps/.*%.cfg'] = 'a2ps',
@@ -1778,31 +1526,27 @@ local pattern = {
   ['.*/etc/asound%.conf'] = 'alsaconf',
   ['.*/etc/apache2/sites%-.*/.*%.com'] = 'apache',
   ['.*/etc/httpd/.*%.conf'] = 'apache',
-  ['.*/etc/apache2/.*%.conf.*'] = starsetf('apache'),
-  ['.*/etc/apache2/conf%..*/.*'] = starsetf('apache'),
-  ['.*/etc/apache2/mods%-.*/.*'] = starsetf('apache'),
-  ['.*/etc/apache2/sites%-.*/.*'] = starsetf('apache'),
-  ['access%.conf.*'] = starsetf('apache'),
-  ['apache%.conf.*'] = starsetf('apache'),
-  ['apache2%.conf.*'] = starsetf('apache'),
-  ['httpd%.conf.*'] = starsetf('apache'),
-  ['srm%.conf.*'] = starsetf('apache'),
-  ['.*/etc/httpd/conf%..*/.*'] = starsetf('apache'),
-  ['.*/etc/httpd/conf%.d/.*%.conf.*'] = starsetf('apache'),
-  ['.*/etc/httpd/mods%-.*/.*'] = starsetf('apache'),
-  ['.*/etc/httpd/sites%-.*/.*'] = starsetf('apache'),
+  ['.*/etc/apache2/.*%.conf.*'] = detect_apache,
+  ['.*/etc/apache2/conf%..*/.*'] = detect_apache,
+  ['.*/etc/apache2/mods%-.*/.*'] = detect_apache,
+  ['.*/etc/apache2/sites%-.*/.*'] = detect_apache,
+  ['access%.conf.*'] = detect_apache,
+  ['apache%.conf.*'] = detect_apache,
+  ['apache2%.conf.*'] = detect_apache,
+  ['httpd%.conf.*'] = detect_apache,
+  ['srm%.conf.*'] = detect_apache,
+  ['.*/etc/httpd/conf%..*/.*'] = detect_apache,
+  ['.*/etc/httpd/conf%.d/.*%.conf.*'] = detect_apache,
+  ['.*/etc/httpd/mods%-.*/.*'] = detect_apache,
+  ['.*/etc/httpd/sites%-.*/.*'] = detect_apache,
   ['.*/etc/proftpd/.*%.conf.*'] = starsetf('apachestyle'),
   ['.*/etc/proftpd/conf%..*/.*'] = starsetf('apachestyle'),
   ['proftpd%.conf.*'] = starsetf('apachestyle'),
   ['.*asterisk/.*%.conf.*'] = starsetf('asterisk'),
   ['.*asterisk.*/.*voicemail%.conf.*'] = starsetf('asteriskvm'),
   ['.*/%.aptitude/config'] = 'aptconf',
-  ['.*%.[aA]'] = function(path, bufnr)
-    return require('vim.filetype.detect').asm(bufnr)
-  end,
-  ['.*%.[sS]'] = function(path, bufnr)
-    return require('vim.filetype.detect').asm(bufnr)
-  end,
+  ['.*%.[aA]'] = detect.asm,
+  ['.*%.[sS]'] = detect.asm,
   ['[mM]akefile%.am'] = 'automake',
   ['.*/bind/db%..*'] = starsetf('bindzone'),
   ['.*/named/db%..*'] = starsetf('bindzone'),
@@ -1825,16 +1569,12 @@ local pattern = {
   ['.*/etc/default/cdrdao'] = 'cdrdaoconf',
   ['.*hgrc'] = 'cfg',
   ['.*%.[Cc][Ff][Gg]'] = {
-    function(path, bufnr)
-      return require('vim.filetype.detect').cfg(bufnr)
-    end,
+    detect.cfg,
     -- Decrease priority to avoid conflicts with more specific patterns
     -- such as '.*/etc/a2ps/.*%.cfg', '.*enlightenment/.*%.cfg', etc.
     { priority = -1 },
   },
-  ['[cC]hange[lL]og.*'] = starsetf(function(path, bufnr)
-    return require('vim.filetype.detect').changelog(bufnr)
-  end),
+  ['[cC]hange[lL]og.*'] = starsetf(detect.changelog),
   ['.*%.%.ch'] = 'chill',
   ['.*%.cmake%.in'] = 'cmake',
   -- */cmus/rc and */.cmus/rc
@@ -1846,19 +1586,11 @@ local pattern = {
   ['.*/etc/hostname%..*'] = starsetf('config'),
   ['crontab%..*'] = starsetf('crontab'),
   ['.*/etc/cron%.d/.*'] = starsetf('crontab'),
-  ['%.cshrc.*'] = function(path, bufnr)
-    return require('vim.filetype.detect').csh(path, bufnr)
-  end,
-  ['%.login.*'] = function(path, bufnr)
-    return require('vim.filetype.detect').csh(path, bufnr)
-  end,
+  ['%.cshrc.*'] = detect.csh,
+  ['%.login.*'] = detect.csh,
   ['cvs%d+'] = 'cvs',
-  ['.*%.[Dd][Aa][Tt]'] = function(path, bufnr)
-    return require('vim.filetype.detect').dat(path, bufnr)
-  end,
-  ['.*/debian/patches/.*'] = function(path, bufnr)
-    return require('vim.filetype.detect').dep3patch(path, bufnr)
-  end,
+  ['.*%.[Dd][Aa][Tt]'] = detect.dat,
+  ['.*/debian/patches/.*'] = detect.dep3patch,
   ['.*/etc/dnsmasq%.d/.*'] = starsetf('dnsmasq'),
   ['Containerfile%..*'] = starsetf('dockerfile'),
   ['Dockerfile%..*'] = starsetf('dockerfile'),
@@ -1884,53 +1616,25 @@ local pattern = {
   ['.*/dtrace/.*%.d'] = 'dtrace',
   ['.*esmtprc'] = 'esmtprc',
   ['.*Eterm/.*%.cfg'] = 'eterm',
-  ['[a-zA-Z0-9].*Dict'] = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
-  ['[a-zA-Z0-9].*Dict%..*'] = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
-  ['[a-zA-Z].*Properties'] = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
-  ['[a-zA-Z].*Properties%..*'] = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
-  ['.*Transport%..*'] = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
-  ['.*/constant/g'] = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
-  ['.*/0/.*'] = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
-  ['.*/0%.orig/.*'] = function(path, bufnr)
-    return require('vim.filetype.detect').foam(bufnr)
-  end,
+  ['[a-zA-Z0-9].*Dict'] = detect.foam,
+  ['[a-zA-Z0-9].*Dict%..*'] = detect.foam,
+  ['[a-zA-Z].*Properties'] = detect.foam,
+  ['[a-zA-Z].*Properties%..*'] = detect.foam,
+  ['.*Transport%..*'] = detect.foam,
+  ['.*/constant/g'] = detect.foam,
+  ['.*/0/.*'] = detect.foam,
+  ['.*/0%.orig/.*'] = detect.foam,
   ['.*/%.fvwm/.*'] = starsetf('fvwm'),
-  ['.*fvwmrc.*'] = starsetf(function(path, bufnr)
-    return 'fvwm', function(b)
-      vim.b[b].fvwm_version = 1
-    end
-  end),
-  ['.*fvwm95.*%.hook'] = starsetf(function(path, bufnr)
-    return 'fvwm', function(b)
-      vim.b[b].fvwm_version = 1
-    end
-  end),
-  ['.*fvwm2rc.*'] = starsetf(function(path, bufnr)
-    return require('vim.filetype.detect').fvwm(path)
-  end),
+  ['.*fvwmrc.*'] = starsetf(detect.fvwm_v1),
+  ['.*fvwm95.*%.hook'] = starsetf(detect.fvwm_v1),
+  ['.*fvwm2rc.*'] = starsetf(detect.fvwm_v2),
   ['.*/tmp/lltmp.*'] = starsetf('gedcom'),
   ['.*/etc/gitconfig%.d/.*'] = starsetf('gitconfig'),
   ['.*/gitolite%-admin/conf/.*'] = starsetf('gitolite'),
   ['tmac%..*'] = starsetf('nroff'),
   ['.*/%.gitconfig%.d/.*'] = starsetf('gitconfig'),
   ['.*%.git/.*'] = {
-    function(path, bufnr)
-      return require('vim.filetype.detect').git(bufnr)
-    end,
+    detect.git,
     -- Decrease priority to run after simple pattern checks
     { priority = -1 },
   },
@@ -2093,15 +1797,13 @@ local pattern = {
   ['.*/log/news/news%.notice'] = 'messages',
   ['.*/log/syslog%.notice'] = 'messages',
   ['.*/log/user%.notice'] = 'messages',
-  ['.*%.[Mm][Oo][Dd]'] = function(path, bufnr)
-    return require('vim.filetype.detect').mod(path, bufnr)
-  end,
+  ['.*%.[Mm][Oo][Dd]'] = detect.mod,
   ['.*/etc/modules%.conf'] = 'modconf',
   ['.*/etc/conf%.modules'] = 'modconf',
   ['.*/etc/modules'] = 'modconf',
   ['.*/etc/modprobe%..*'] = starsetf('modconf'),
   ['.*/etc/modutils/.*'] = starsetf(function(path, bufnr)
-    if vim.fn.executable(vim.fn.expand(path)) ~= 1 then
+    if fn.executable(fn.expand(path)) ~= 1 then
       return 'modconf'
     end
   end),
@@ -2110,32 +1812,30 @@ local pattern = {
   ['Muttngrc'] = 'muttrc',
   ['.*/etc/Muttrc%.d/.*'] = starsetf('muttrc'),
   ['.*/%.mplayer/config'] = 'mplayerconf',
-  ['Muttrc.*'] = starsetf('muttrc'),
-  ['Muttngrc.*'] = starsetf('muttrc'),
+  ['Muttrc.*'] = detect_muttrc,
+  ['Muttngrc.*'] = detect_muttrc,
   -- muttrc* and .muttrc*
-  ['%.?muttrc.*'] = starsetf('muttrc'),
+  ['%.?muttrc.*'] = detect_muttrc,
   -- muttngrc* and .muttngrc*
-  ['%.?muttngrc.*'] = starsetf('muttrc'),
-  ['.*/%.mutt/muttrc.*'] = starsetf('muttrc'),
-  ['.*/%.muttng/muttrc.*'] = starsetf('muttrc'),
-  ['.*/%.muttng/muttngrc.*'] = starsetf('muttrc'),
+  ['%.?muttngrc.*'] = detect_muttrc,
+  ['.*/%.mutt/muttrc.*'] = detect_muttrc,
+  ['.*/%.muttng/muttrc.*'] = detect_muttrc,
+  ['.*/%.muttng/muttngrc.*'] = detect_muttrc,
   ['rndc.*%.conf'] = 'named',
   ['rndc.*%.key'] = 'named',
   ['named.*%.conf'] = 'named',
   ['.*/etc/nanorc'] = 'nanorc',
   ['.*%.NS[ACGLMNPS]'] = 'natural',
-  ['Neomuttrc.*'] = starsetf('neomuttrc'),
+  ['Neomuttrc.*'] = detect_neomuttrc,
   -- neomuttrc* and .neomuttrc*
-  ['%.?neomuttrc.*'] = starsetf('neomuttrc'),
-  ['.*/%.neomutt/neomuttrc.*'] = starsetf('neomuttrc'),
+  ['%.?neomuttrc.*'] = detect_neomuttrc,
+  ['.*/%.neomutt/neomuttrc.*'] = detect_neomuttrc,
   ['nginx.*%.conf'] = 'nginx',
   ['.*/etc/nginx/.*'] = 'nginx',
   ['.*nginx%.conf'] = 'nginx',
   ['.*/nginx/.*%.conf'] = 'nginx',
   ['.*/usr/local/nginx/conf/.*'] = 'nginx',
-  ['.*%.[1-9]'] = function(path, bufnr)
-    return require('vim.filetype.detect').nroff(bufnr)
-  end,
+  ['.*%.[1-9]'] = detect.nroff,
   ['.*%.ml%.cppo'] = 'ocaml',
   ['.*%.mli%.cppo'] = 'ocaml',
   ['.*%.opam%.template'] = 'opam',
@@ -2156,9 +1856,7 @@ local pattern = {
   ['.*%.php%d'] = 'php',
   ['.*/%.pinforc'] = 'pinfo',
   ['.*/etc/pinforc'] = 'pinfo',
-  ['.*%.[Pp][Rr][Gg]'] = function(path, bufnr)
-    return require('vim.filetype.detect').prg(bufnr)
-  end,
+  ['.*%.[Pp][Rr][Gg]'] = detect.prg,
   ['.*/etc/protocols'] = 'protocols',
   ['.*printcap.*'] = starsetf(function(path, bufnr)
     return require('vim.filetype.detect').printcap('print')
@@ -2178,30 +1876,14 @@ local pattern = {
   ['.*/etc/services'] = 'services',
   ['.*/etc/serial%.conf'] = 'setserial',
   ['.*/etc/udev/cdsymlinks%.conf'] = 'sh',
-  ['%.bash[_%-]aliases'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  ['%.bash[_%-]logout'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  ['%.bash[_%-]profile'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  ['%.kshrc.*'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'ksh')
-  end,
-  ['%.profile.*'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr))
-  end,
-  ['.*/etc/profile'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr))
-  end,
-  ['bash%-fc[%-%.].*'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'bash')
-  end,
-  ['%.tcshrc.*'] = function(path, bufnr)
-    return require('vim.filetype.detect').sh(path, M.getlines(bufnr), 'tcsh')
-  end,
+  ['%.bash[_%-]aliases'] = detect.bash,
+  ['%.bash[_%-]logout'] = detect.bash,
+  ['%.bash[_%-]profile'] = detect.bash,
+  ['%.kshrc.*'] = detect.ksh,
+  ['%.profile.*'] = detect.sh,
+  ['.*/etc/profile'] = detect.sh,
+  ['bash%-fc[%-%.].*'] = detect.bash,
+  ['%.tcshrc.*'] = detect.tcsh,
   ['.*/etc/sudoers%.d/.*'] = starsetf('sudoers'),
   ['.*%._sst%.meta'] = 'sisu',
   ['.*%.%-sst%.meta'] = 'sisu',
@@ -2213,17 +1895,13 @@ local pattern = {
   ['.*/%.ssh/config'] = 'sshconfig',
   ['.*/%.ssh/.*%.conf'] = 'sshconfig',
   ['.*/etc/ssh/sshd_config%.d/.*%.conf'] = 'sshdconfig',
-  ['.*%.[Ss][Rr][Cc]'] = function(path, bufnr)
-    return require('vim.filetype.detect').src(bufnr)
-  end,
+  ['.*%.[Ss][Rr][Cc]'] = detect.src,
   ['.*/etc/sudoers'] = 'sudoers',
   ['svn%-commit.*%.tmp'] = 'svn',
   ['.*/sway/config'] = 'swayconfig',
   ['.*/%.sway/config'] = 'swayconfig',
   ['.*%.swift%.gyb'] = 'swiftgyb',
-  ['.*%.[Ss][Yy][Ss]'] = function(path, bufnr)
-    return require('vim.filetype.detect').sys(bufnr)
-  end,
+  ['.*%.[Ss][Yy][Ss]'] = detect.sys,
   ['.*/etc/sysctl%.conf'] = 'sysctl',
   ['.*/etc/sysctl%.d/.*%.conf'] = 'sysctl',
   ['.*/systemd/.*%.automount'] = 'systemd',
@@ -2266,9 +1944,7 @@ local pattern = {
   ['.*/%.config/upstart/.*%.conf'] = 'upstart',
   ['.*/%.init/.*%.conf'] = 'upstart',
   ['.*/usr/share/upstart/.*%.override'] = 'upstart',
-  ['.*%.[Ll][Oo][Gg]'] = function(path, bufnr)
-    return require('vim.filetype.detect').log(path)
-  end,
+  ['.*%.[Ll][Oo][Gg]'] = detect.log,
   ['.*%.vhdl_[0-9].*'] = starsetf('vhdl'),
   ['.*%.ws[fc]'] = 'wsh',
   ['.*/Xresources/.*'] = starsetf('xdefaults'),
@@ -2286,20 +1962,10 @@ local pattern = {
   ['Xresources.*'] = starsetf('xdefaults'),
   ['.*/etc/xinetd%.d/.*'] = starsetf('xinetd'),
   ['.*xmodmap.*'] = starsetf('xmodmap'),
-  ['.*/xorg%.conf%.d/.*%.conf'] = function(path, bufnr)
-    return 'xf86config', function(b)
-      vim.b[b].xf86conf_xfree86_version = 4
-    end
-  end,
+  ['.*/xorg%.conf%.d/.*%.conf'] = detect.xfree86_v4,
   -- Increase priority to run before the pattern below
-  ['XF86Config%-4.*'] = starsetf(function(path, bufnr)
-    return 'xf86conf', function(b)
-      vim.b[b].xf86conf_xfree86_version = 4
-    end
-  end, { priority = -math.huge + 1 }),
-  ['XF86Config.*'] = starsetf(function(path, bufnr)
-    return require('vim.filetype.detect').xfree86()
-  end),
+  ['XF86Config%-4.*'] = starsetf(detect.xfree86_v4, { priority = -math.huge + 1 }),
+  ['XF86Config.*'] = starsetf(detect.xfree86_v3),
   ['%.zcompdump.*'] = starsetf('zsh'),
   -- .zlog* and zlog*
   ['%.?zlog.*'] = starsetf('zsh'),
@@ -2309,7 +1975,7 @@ local pattern = {
   ['.*~'] = function(path, bufnr)
     local short = path:gsub('~$', '', 1)
     if path ~= short and short ~= '' then
-      return M.match({ buf = bufnr, filename = vim.fn.fnameescape(short) })
+      return M.match({ buf = bufnr, filename = fn.fnameescape(short) })
     end
   end,
   -- END PATTERN
@@ -2317,8 +1983,10 @@ local pattern = {
 -- luacheck: pop
 -- luacheck: pop
 
+--- @param t vim.filetype.mapping
+--- @return vim.filetype.mapping[]
 local function sort_by_priority(t)
-  local sorted = {}
+  local sorted = {} --- @type vim.filetype.mapping[]
   for k, v in pairs(t) do
     local ft = type(v) == 'table' and v[1] or v
     assert(
@@ -2340,6 +2008,9 @@ end
 
 local pattern_sorted = sort_by_priority(pattern)
 
+--- @param path string
+--- @param as_pattern? true
+--- @return string
 local function normalize_path(path, as_pattern)
   local normal = path:gsub('\\', '/')
   if normal:find('^~') then
@@ -2348,12 +2019,17 @@ local function normalize_path(path, as_pattern)
       -- The rest of path should already be properly escaped.
       normal = vim.pesc(vim.env.HOME) .. normal:sub(2)
     else
-      normal = vim.env.HOME .. normal:sub(2)
+      normal = vim.env.HOME .. normal:sub(2) --- @type string
     end
   end
   return normal
 end
 
+--- @class vim.filetype.add.filetypes
+--- @field pattern vim.filetype.mapping
+--- @field extension vim.filetype.mapping
+--- @field filename vim.filetype.mapping
+
 --- Add new filetype mappings.
 ---
 --- Filetype mappings can be added either by extension or by filename (either
@@ -2423,10 +2099,10 @@ end
 ---     ['.*'] = {
 ---       priority = -math.huge,
 ---       function(path, bufnr)
----         local content = vim.filetype.getlines(bufnr, 1)
----         if vim.filetype.matchregex(content, [[^#!.*\\<mine\\>]]) then
+---         local content = vim.api.nvim_buf_get_lines(bufnr, 0, 1, false)[1] or ''
+---         if vim.regex([[^#!.*\\<mine\\>]]):match_str(content) ~= nil then
 ---           return 'mine'
----         elseif vim.filetype.matchregex(content, [[\\<drawing\\>]]) then
+---         elseif vim.regex([[\\<drawing\\>]]):match_str(content) ~= nil then
 ---           return 'drawing'
 ---         end
 ---       end,
@@ -2435,7 +2111,7 @@ end
 --- }
 --- </pre>
 ---
----@param filetypes table A table containing new filetype maps (see example).
+---@param filetypes vim.filetype.add.filetypes A table containing new filetype maps (see example).
 function M.add(filetypes)
   for k, v in pairs(filetypes.extension or {}) do
     extension[k] = v
@@ -2454,38 +2130,62 @@ function M.add(filetypes)
   end
 end
 
+--- @param ft vim.filetype.mapping.value
+--- @param path? string
+--- @param bufnr? integer
+--- @param ... any
+--- @return string?
+--- @return fun(b: integer)?
 local function dispatch(ft, path, bufnr, ...)
-  local on_detect
-  if type(ft) == 'function' then
-    if bufnr then
-      ft, on_detect = ft(path, bufnr, ...)
-    else
-      -- If bufnr is nil (meaning we are matching only against the filename), set it to an invalid
-      -- value (-1) and catch any errors from the filetype detection function. If the function tries
-      -- to use the buffer then it will fail, but this enables functions which do not need a buffer
-      -- to still work.
-      local ok
-      ok, ft, on_detect = pcall(ft, path, -1, ...)
-      if not ok then
-        return
-      end
+  if type(ft) == 'string' then
+    return ft
+  end
+
+  if type(ft) ~= 'function' then
+    return
+  end
+
+  assert(path)
+
+  ---@type string|false?, fun(b: integer)?
+  local ft0, on_detect
+  if bufnr then
+    ft0, on_detect = ft(path, bufnr, ...)
+  else
+    -- If bufnr is nil (meaning we are matching only against the filename), set it to an invalid
+    -- value (-1) and catch any errors from the filetype detection function. If the function tries
+    -- to use the buffer then it will fail, but this enables functions which do not need a buffer
+    -- to still work.
+    local ok
+    ok, ft0, on_detect = pcall(ft, path, -1, ...)
+    if not ok then
+      return
     end
   end
 
-  if type(ft) == 'string' then
-    return ft, on_detect
+  if not ft0 then
+    return
   end
+
+  return ft0, on_detect
 end
 
--- Lookup table/cache for patterns that contain an environment variable pattern, e.g. ${SOME_VAR}.
+--- Lookup table/cache for patterns that contain an environment variable pattern, e.g. ${SOME_VAR}.
+--- @type table<string,boolean>
 local expand_env_lookup = {}
 
+--- @param name string
+--- @param path string
+--- @param tail string
+--- @param pat string
+--- @return string|false?
 local function match_pattern(name, path, tail, pat)
   if expand_env_lookup[pat] == nil then
     expand_env_lookup[pat] = pat:find('%${') ~= nil
   end
   if expand_env_lookup[pat] then
-    local return_early
+    local return_early --- @type true?
+    --- @type string
     pat = pat:gsub('%${(%S-)}', function(env)
       -- If an environment variable is present in the pattern but not set, there is no match
       if not vim.env[env] then
@@ -2501,18 +2201,22 @@ local function match_pattern(name, path, tail, pat)
 
   -- If the pattern contains a / match against the full path, otherwise just the tail
   local fullpat = '^' .. pat .. '$'
-  local matches
+
   if pat:find('/') then
     -- Similar to |autocmd-pattern|, if the pattern contains a '/' then check for a match against
     -- both the short file name (as typed) and the full file name (after expanding to full path
     -- and resolving symlinks)
-    matches = name:match(fullpat) or path:match(fullpat)
-  else
-    matches = tail:match(fullpat)
+    return (name:match(fullpat) or path:match(fullpat))
   end
-  return matches
+
+  return (tail:match(fullpat))
 end
 
+--- @class vim.filetype.match.args
+--- @field buf? integer
+--- @field filename? string
+--- @field contents? string[]
+
 --- Perform filetype detection.
 ---
 --- The filetype can be detected using one of three methods:
@@ -2542,7 +2246,8 @@ end
 ---   vim.filetype.match({ contents = {'#!/usr/bin/env bash'} })
 --- </pre>
 ---
----@param args table Table specifying which matching strategy to use. Accepted keys are:
+---@param args vim.filetype.match.args Table specifying which matching strategy to use.
+---                 Accepted keys are:
 ---                   * buf (number): Buffer number to use for matching. Mutually exclusive with
 ---                                   {contents}
 ---                   * filename (string): Filename to use for matching. When {buf} is given,
@@ -2555,8 +2260,8 @@ end
 ---                   * contents (table): An array of lines representing file contents to use for
 ---                                       matching. Can be used with {filename}. Mutually exclusive
 ---                                       with {buf}.
----@return string|nil If a match was found, the matched filetype.
----@return function|nil A function that modifies buffer state when called (for example, to set some
+---@return string|nil # If a match was found, the matched filetype.
+---@return function|nil # A function that modifies buffer state when called (for example, to set some
 ---                     filetype specific buffer variables). The function accepts a buffer number as
 ---                     its only argument.
 function M.match(args)
@@ -2576,20 +2281,21 @@ function M.match(args)
     name = api.nvim_buf_get_name(bufnr)
   end
 
+  --- @type string?, fun(b: integer)?
   local ft, on_detect
 
   if name then
     name = normalize_path(name)
 
     -- First check for the simple case where the full path exists as a key
-    local path = vim.fn.fnamemodify(name, ':p')
+    local path = fn.fnamemodify(name, ':p')
     ft, on_detect = dispatch(filename[path], path, bufnr)
     if ft then
       return ft, on_detect
     end
 
     -- Next check against just the file name
-    local tail = vim.fn.fnamemodify(name, ':t')
+    local tail = fn.fnamemodify(name, ':t')
     ft, on_detect = dispatch(filename[tail], path, bufnr)
     if ft then
       return ft, on_detect
@@ -2616,7 +2322,7 @@ function M.match(args)
     end
 
     -- Next, check file extension
-    local ext = vim.fn.fnamemodify(name, ':e')
+    local ext = fn.fnamemodify(name, ':e')
     ft, on_detect = dispatch(extension[ext], path, bufnr)
     if ft then
       return ft, on_detect
@@ -2641,12 +2347,13 @@ function M.match(args)
   -- Finally, check file contents
   if contents or bufnr then
     if contents == nil then
+      assert(bufnr)
       if api.nvim_buf_line_count(bufnr) > 101 then
         -- only need first 100 and last line for current checks
-        contents = M.getlines(bufnr, 1, 100)
-        contents[#contents + 1] = M.getlines(bufnr, -1)
+        contents = M._getlines(bufnr, 1, 100)
+        contents[#contents + 1] = M._getline(bufnr, -1)
       else
-        contents = M.getlines(bufnr)
+        contents = M._getlines(bufnr)
       end
     end
     -- If name is nil, catch any errors from the contents filetype detection function.
diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index 4e18ed190a..59b50f2288 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -17,22 +17,26 @@
 --     Example:
 --     `if line =~ '^\s*unwind_protect\>'` => `if matchregex(line, [[\c^\s*unwind_protect\>]])`
 
+local fn = vim.fn
+
 local M = {}
 
-local getlines = vim.filetype.getlines
-local findany = vim.filetype.findany
-local nextnonblank = vim.filetype.nextnonblank
-local matchregex = vim.filetype.matchregex
+local getlines = vim.filetype._getlines
+local getline = vim.filetype._getline
+local findany = vim.filetype._findany
+local nextnonblank = vim.filetype._nextnonblank
+local matchregex = vim.filetype._matchregex
 
 -- luacheck: push no unused args
 -- luacheck: push ignore 122
 
 -- This function checks for the kind of assembly that is wanted by the user, or
 -- can be detected from the first five lines of the file.
-function M.asm(bufnr)
+--- @type vim.filetype.mapfn
+function M.asm(path, bufnr)
   local syntax = vim.b[bufnr].asmsyntax
   if not syntax or syntax == '' then
-    syntax = M.asm_syntax(bufnr)
+    syntax = M.asm_syntax(path, bufnr)
   end
 
   -- If b:asmsyntax still isn't set, default to asmsyntax or GNU
@@ -48,20 +52,21 @@ function M.asm(bufnr)
   end
 end
 
--- Active Server Pages (with Perl or Visual Basic Script)
-function M.asp(bufnr)
+--- Active Server Pages (with Perl or Visual Basic Script)
+--- @type vim.filetype.mapfn
+function M.asp(_, bufnr)
   if vim.g.filetype_asp then
     return vim.g.filetype_asp
   elseif table.concat(getlines(bufnr, 1, 3)):lower():find('perlscript') then
     return 'aspperl'
-  else
-    return 'aspvbs'
   end
+  return 'aspvbs'
 end
 
 -- Checks the first 5 lines for a asmsyntax=foo override.
 -- Only whitespace characters can be present immediately before or after this statement.
-function M.asm_syntax(bufnr)
+--- @type vim.filetype.mapfn
+function M.asm_syntax(_, bufnr)
   local lines = ' ' .. table.concat(getlines(bufnr, 1, 5), ' '):lower() .. ' '
   local match = lines:match('%sasmsyntax=([a-zA-Z0-9]+)%s')
   if match then
@@ -75,7 +80,8 @@ local visual_basic_content =
   { 'vb_name', 'begin vb%.form', 'begin vb%.mdiform', 'begin vb%.usercontrol' }
 
 -- See frm() for Visual Basic form file detection
-function M.bas(bufnr)
+--- @type vim.filetype.mapfn
+function M.bas(_, bufnr)
   if vim.g.filetype_bas then
     return vim.g.filetype_bas
   end
@@ -106,18 +112,21 @@ function M.bas(bufnr)
   return 'basic'
 end
 
-function M.bindzone(bufnr, default)
+--- @type vim.filetype.mapfn
+function M.bindzone(_, bufnr)
   local lines = table.concat(getlines(bufnr, 1, 4))
   if findany(lines, { '^; <<>> DiG [0-9%.]+.* <<>>', '%$ORIGIN', '%$TTL', 'IN%s+SOA' }) then
     return 'bindzone'
   end
-  return default
 end
 
 -- Returns true if file content looks like RAPID
+--- @param bufnr integer
+--- @param extension? string
+--- @return string|boolean?
 local function is_rapid(bufnr, extension)
   if extension == 'cfg' then
-    local line = getlines(bufnr, 1):lower()
+    local line = getline(bufnr, 1):lower()
     return findany(line, { 'eio:cfg', 'mmc:cfg', 'moc:cfg', 'proc:cfg', 'sio:cfg', 'sys:cfg' })
   end
   local line = nextnonblank(bufnr, 1)
@@ -128,23 +137,24 @@ local function is_rapid(bufnr, extension)
   return false
 end
 
-function M.cfg(bufnr)
+--- @type vim.filetype.mapfn
+function M.cfg(_, bufnr)
   if vim.g.filetype_cfg then
-    return vim.g.filetype_cfg
+    return vim.g.filetype_cfg --[[@as string]]
   elseif is_rapid(bufnr, 'cfg') then
     return 'rapid'
-  else
-    return 'cfg'
   end
+  return 'cfg'
 end
 
--- This function checks if one of the first ten lines start with a '@'.  In
--- that case it is probably a change file.
--- If the first line starts with # or ! it's probably a ch file.
--- If a line has "main", "include", "//" or "/*" it's probably ch.
--- Otherwise CHILL is assumed.
-function M.change(bufnr)
-  local first_line = getlines(bufnr, 1)
+--- This function checks if one of the first ten lines start with a '@'.  In
+--- that case it is probably a change file.
+--- If the first line starts with # or ! it's probably a ch file.
+--- If a line has "main", "include", "//" or "/*" it's probably ch.
+--- Otherwise CHILL is assumed.
+--- @type vim.filetype.mapfn
+function M.change(_, bufnr)
+  local first_line = getline(bufnr, 1)
   if findany(first_line, { '^#', '^!' }) then
     return 'ch'
   end
@@ -161,39 +171,42 @@ function M.change(bufnr)
   return 'chill'
 end
 
-function M.changelog(bufnr)
-  local line = getlines(bufnr, 1):lower()
+--- @type vim.filetype.mapfn
+function M.changelog(_, bufnr)
+  local line = getline(bufnr, 1):lower()
   if line:find('; urgency=') then
     return 'debchangelog'
   end
   return 'changelog'
 end
 
-function M.class(bufnr)
+--- @type vim.filetype.mapfn
+function M.class(_, bufnr)
   -- Check if not a Java class (starts with '\xca\xfe\xba\xbe')
-  if not getlines(bufnr, 1):find('^\202\254\186\190') then
+  if not getline(bufnr, 1):find('^\202\254\186\190') then
     return 'stata'
   end
 end
 
-function M.cls(bufnr)
+--- @type vim.filetype.mapfn
+function M.cls(_, bufnr)
   if vim.g.filetype_cls then
     return vim.g.filetype_cls
   end
-  local line = getlines(bufnr, 1)
+  local line = getline(bufnr, 1)
   if line:find('^[%%\\]') then
     return 'tex'
   elseif line:find('^#') and line:lower():find('rexx') then
     return 'rexx'
   elseif line == 'VERSION 1.0 CLASS' then
     return 'vb'
-  else
-    return 'st'
   end
+  return 'st'
 end
 
+--- @type vim.filetype.mapfn
 function M.conf(path, bufnr)
-  if vim.fn.did_filetype() ~= 0 or path:find(vim.g.ft_ignore_pat) then
+  if fn.did_filetype() ~= 0 or path:find(vim.g.ft_ignore_pat) then
     return
   end
   if path:find('%.conf$') then
@@ -206,22 +219,30 @@ function M.conf(path, bufnr)
   end
 end
 
--- Debian Control
-function M.control(bufnr)
-  if getlines(bufnr, 1):find('^Source:') then
+--- Debian Control
+--- @type vim.filetype.mapfn
+function M.control(_, bufnr)
+  if getline(bufnr, 1):find('^Source:') then
     return 'debcontrol'
   end
 end
 
--- Debian Copyright
-function M.copyright(bufnr)
-  if getlines(bufnr, 1):find('^Format:') then
+--- Debian Copyright
+--- @type vim.filetype.mapfn
+function M.copyright(_, bufnr)
+  if getline(bufnr, 1):find('^Format:') then
     return 'debcopyright'
   end
 end
 
+--- @type vim.filetype.mapfn
+function M.cpp(_, _)
+  return vim.g.cynlib_syntax_for_cpp and 'cynlib' or 'cpp'
+end
+
+--- @type vim.filetype.mapfn
 function M.csh(path, bufnr)
-  if vim.fn.did_filetype() ~= 0 then
+  if fn.did_filetype() ~= 0 then
     -- Filetype was already detected
     return
   end
@@ -235,6 +256,9 @@ function M.csh(path, bufnr)
   end
 end
 
+--- @param path string
+--- @param contents string[]
+--- @return string?
 local function cvs_diff(path, contents)
   for _, line in ipairs(contents) do
     if not line:find('^%? ') then
@@ -280,8 +304,9 @@ local function cvs_diff(path, contents)
   end
 end
 
+--- @type vim.filetype.mapfn
 function M.dat(path, bufnr)
-  local file_name = vim.fn.fnamemodify(path, ':t'):lower()
+  local file_name = fn.fnamemodify(path, ':t'):lower()
   -- Innovation data processing
   if findany(file_name, { '^upstream%.dat$', '^upstream%..*%.dat$', '^.*%.upstream%.dat$' }) then
     return 'upstreamdat'
@@ -296,7 +321,8 @@ function M.dat(path, bufnr)
   end
 end
 
-function M.decl(bufnr)
+--- @type vim.filetype.mapfn
+function M.decl(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 3)) do
     if line:lower():find('^<!sgml') then
       return 'sgmldecl'
@@ -306,8 +332,9 @@ end
 
 -- This function is called for all files under */debian/patches/*, make sure not
 -- to non-dep3patch files, such as README and other text files.
+--- @type vim.filetype.mapfn
 function M.dep3patch(path, bufnr)
-  local file_name = vim.fn.fnamemodify(path, ':t')
+  local file_name = fn.fnamemodify(path, ':t')
   if file_name == 'series' then
     return
   end
@@ -352,7 +379,7 @@ local function diff(contents)
   end
 end
 
-function M.dns_zone(contents)
+local function dns_zone(contents)
   if
     findany(
       contents[1] .. contents[2] .. contents[3] .. contents[4],
@@ -370,8 +397,9 @@ function M.dns_zone(contents)
   end
 end
 
-function M.dtrace(bufnr)
-  if vim.fn.did_filetype() ~= 0 then
+--- @type vim.filetype.mapfn
+function M.dtrace(_, bufnr)
+  if fn.did_filetype() ~= 0 then
     -- Filetype was already detected
     return
   end
@@ -386,7 +414,8 @@ function M.dtrace(bufnr)
   return 'd'
 end
 
-function M.e(bufnr)
+--- @type vim.filetype.mapfn
+function M.e(_, bufnr)
   if vim.g.filetype_euphoria then
     return vim.g.filetype_euphoria
   end
@@ -398,8 +427,9 @@ function M.e(bufnr)
   return 'eiffel'
 end
 
-function M.edn(bufnr)
-  local line = getlines(bufnr, 1)
+--- @type vim.filetype.mapfn
+function M.edn(_, bufnr)
+  local line = getline(bufnr, 1)
   if matchregex(line, [[\c^\s*(\s*edif\>]]) then
     return 'edif'
   else
@@ -410,7 +440,8 @@ end
 -- This function checks for valid cl syntax in the first five lines.
 -- Look for either an opening comment, '#', or a block start, '{'.
 -- If not found, assume SGML.
-function M.ent(bufnr)
+--- @type vim.filetype.mapfn
+function M.ent(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 5)) do
     if line:find('^%s*[#{]') then
       return 'cl'
@@ -423,7 +454,13 @@ function M.ent(bufnr)
   return 'dtd'
 end
 
-function M.ex(bufnr)
+--- @type vim.filetype.mapfn
+function M.euphoria(_, _)
+  return vim.g.filetype_euphoria or 'euphoria3'
+end
+
+--- @type vim.filetype.mapfn
+function M.ex(_, bufnr)
   if vim.g.filetype_euphoria then
     return vim.g.filetype_euphoria
   else
@@ -439,7 +476,8 @@ end
 -- This function checks the first 15 lines for appearance of 'FoamFile'
 -- and then 'object' in a following line.
 -- In that case, it's probably an OpenFOAM file
-function M.foam(bufnr)
+--- @type vim.filetype.mapfn
+function M.foam(_, bufnr)
   local foam_file = false
   for _, line in ipairs(getlines(bufnr, 1, 15)) do
     if line:find('^FoamFile') then
@@ -450,7 +488,8 @@ function M.foam(bufnr)
   end
 end
 
-function M.frm(bufnr)
+--- @type vim.filetype.mapfn
+function M.frm(_, bufnr)
   if vim.g.filetype_frm then
     return vim.g.filetype_frm
   end
@@ -462,8 +501,16 @@ function M.frm(bufnr)
   end
 end
 
-function M.fvwm(path)
-  if vim.fn.fnamemodify(path, ':e') == 'm4' then
+--- @type vim.filetype.mapfn
+function M.fvwm_1(_, _)
+  return 'fvwm', function(bufnr)
+    vim.b[bufnr].fvwm_version = 1
+  end
+end
+
+--- @type vim.filetype.mapfn
+function M.fvwm_v2(path, _)
+  if fn.fnamemodify(path, ':e') == 'm4' then
     return 'fvwm2m4'
   end
   return 'fvwm', function(bufnr)
@@ -472,7 +519,8 @@ function M.fvwm(path)
 end
 
 -- Distinguish between Forth and F#.
-function M.fs(bufnr)
+--- @type vim.filetype.mapfn
+function M.fs(_, bufnr)
   if vim.g.filetype_fs then
     return vim.g.filetype_fs
   end
@@ -484,14 +532,16 @@ function M.fs(bufnr)
   return 'fsharp'
 end
 
-function M.git(bufnr)
-  local line = getlines(bufnr, 1)
+--- @type vim.filetype.mapfn
+function M.git(_, bufnr)
+  local line = getline(bufnr, 1)
   if matchregex(line, [[^\x\{40,\}\>\|^ref: ]]) then
     return 'git'
   end
 end
 
-function M.header(bufnr)
+--- @type vim.filetype.mapfn
+function M.header(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 200)) do
     if findany(line:lower(), { '^@interface', '^@end', '^@class' }) then
       if vim.g.c_syntax_for_h then
@@ -510,7 +560,8 @@ function M.header(bufnr)
   end
 end
 
-function M.html(bufnr)
+--- @type vim.filetype.mapfn
+function M.html(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 10)) do
     if matchregex(line, [[\<DTD\s\+XHTML\s]]) then
       return 'xhtml'
@@ -522,14 +573,16 @@ function M.html(bufnr)
 end
 
 -- Virata Config Script File or Drupal module
-function M.hw(bufnr)
-  if getlines(bufnr, 1):lower():find('<%?php') then
+--- @type vim.filetype.mapfn
+function M.hw(_, bufnr)
+  if getline(bufnr, 1):lower():find('<%?php') then
     return 'php'
   end
   return 'virata'
 end
 
-function M.idl(bufnr)
+--- @type vim.filetype.mapfn
+function M.idl(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 50)) do
     if findany(line:lower(), { '^%s*import%s+"unknwn"%.idl', '^%s*import%s+"objidl"%.idl' }) then
       return 'msidl'
@@ -542,7 +595,8 @@ local pascal_comments = { '^%s*{', '^%s*%(%*', '^%s*//' }
 local pascal_keywords =
   [[\c^\s*\%(program\|unit\|library\|uses\|begin\|procedure\|function\|const\|type\|var\)\>]]
 
-function M.inc(bufnr)
+--- @type vim.filetype.mapfn
+function M.inc(path, bufnr)
   if vim.g.filetype_inc then
     return vim.g.filetype_inc
   end
@@ -560,7 +614,7 @@ function M.inc(bufnr)
   elseif findany(lines, { '^%s*inherit ', '^%s*require ', '^%s*%u[%w_:${}]*%s+%??[?:+]?= ' }) then
     return 'bitbake'
   else
-    local syntax = M.asm_syntax(bufnr)
+    local syntax = M.asm_syntax(path, bufnr)
     if not syntax or syntax == '' then
       return 'pov'
     end
@@ -570,8 +624,9 @@ function M.inc(bufnr)
   end
 end
 
-function M.inp(bufnr)
-  if getlines(bufnr, 1):find('^%*') then
+--- @type vim.filetype.mapfn
+function M.inp(_, bufnr)
+  if getline(bufnr, 1):find('^%*') then
     return 'abaqus'
   else
     for _, line in ipairs(getlines(bufnr, 1, 500)) do
@@ -582,16 +637,18 @@ function M.inp(bufnr)
   end
 end
 
+--- @type vim.filetype.mapfn
 function M.install(path, bufnr)
-  if getlines(bufnr, 1):lower():find('<%?php') then
+  if getline(bufnr, 1):lower():find('<%?php') then
     return 'php'
   end
-  return M.sh(path, getlines(bufnr), 'bash')
+  return M.bash(path, bufnr)
 end
 
--- Innovation Data Processing
--- (refactor of filetype.vim since the patterns are case-insensitive)
-function M.log(path)
+--- Innovation Data Processing
+--- (refactor of filetype.vim since the patterns are case-insensitive)
+--- @type vim.filetype.mapfn
+function M.log(path, _)
   path = path:lower()
   if
     findany(
@@ -614,7 +671,8 @@ function M.log(path)
   end
 end
 
-function M.lpc(bufnr)
+--- @type vim.filetype.mapfn
+function M.lpc(_, bufnr)
   if vim.g.lpc_syntax_for_c then
     for _, line in ipairs(getlines(bufnr, 1, 12)) do
       if
@@ -637,7 +695,8 @@ function M.lpc(bufnr)
   return 'c'
 end
 
-function M.lsl(bufnr)
+--- @type vim.filetype.mapfn
+function M.lsl(_, bufnr)
   if vim.g.filetype_lsl then
     return vim.g.filetype_lsl
   end
@@ -650,7 +709,8 @@ function M.lsl(bufnr)
   end
 end
 
-function M.m(bufnr)
+--- @type vim.filetype.mapfn
+function M.m(_, bufnr)
   if vim.g.filetype_m then
     return vim.g.filetype_m
   end
@@ -703,6 +763,8 @@ function M.m(bufnr)
   end
 end
 
+--- @param contents string[]
+--- @return string?
 local function m4(contents)
   for _, line in ipairs(contents) do
     if matchregex(line, [[^\s*dnl\>]]) then
@@ -715,9 +777,10 @@ local function m4(contents)
   end
 end
 
--- Rely on the file to start with a comment.
--- MS message text files use ';', Sendmail files use '#' or 'dnl'
-function M.mc(bufnr)
+--- Rely on the file to start with a comment.
+--- MS message text files use ';', Sendmail files use '#' or 'dnl'
+--- @type vim.filetype.mapfn
+function M.mc(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 20)) do
     if findany(line:lower(), { '^%s*#', '^%s*dnl' }) then
       -- Sendmail .mc file
@@ -730,14 +793,17 @@ function M.mc(bufnr)
   return 'm4'
 end
 
+--- @param path string
+--- @return string?
 function M.me(path)
-  local filename = vim.fn.fnamemodify(path, ':t'):lower()
+  local filename = fn.fnamemodify(path, ':t'):lower()
   if filename ~= 'read.me' and filename ~= 'click.me' then
     return 'nroff'
   end
 end
 
-function M.mm(bufnr)
+--- @type vim.filetype.mapfn
+function M.mm(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 20)) do
     if matchregex(line, [[\c^\s*\(#\s*\(include\|import\)\>\|@import\>\|/\*\)]]) then
       return 'objcpp'
@@ -746,7 +812,8 @@ function M.mm(bufnr)
   return 'nroff'
 end
 
-function M.mms(bufnr)
+--- @type vim.filetype.mapfn
+function M.mms(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 20)) do
     if findany(line, { '^%s*%%', '^%s*//', '^%*' }) then
       return 'mmix'
@@ -757,7 +824,9 @@ function M.mms(bufnr)
   return 'mmix'
 end
 
--- Returns true if file content looks like LambdaProlog
+--- Returns true if file content looks like LambdaProlog
+--- @param bufnr integer
+--- @return boolean
 local function is_lprolog(bufnr)
   -- Skip apparent comments and blank lines, what looks like
   -- LambdaProlog comment may be RAPID header
@@ -765,12 +834,14 @@ local function is_lprolog(bufnr)
     -- The second pattern matches a LambdaProlog comment
     if not findany(line, { '^%s*$', '^%s*%%' }) then
       -- The pattern must not catch a go.mod file
-      return matchregex(line, [[\c\<module\s\+\w\+\s*\.\s*\(%\|$\)]]) ~= nil
+      return matchregex(line, [[\c\<module\s\+\w\+\s*\.\s*\(%\|$\)]])
     end
   end
+  return false
 end
 
--- Determine if *.mod is ABB RAPID, LambdaProlog, Modula-2, Modsim III or go.mod
+--- Determine if *.mod is ABB RAPID, LambdaProlog, Modula-2, Modsim III or go.mod
+--- @type vim.filetype.mapfn
 function M.mod(path, bufnr)
   if vim.g.filetype_mod then
     return vim.g.filetype_mod
@@ -782,21 +853,30 @@ function M.mod(path, bufnr)
     return 'modula2'
   elseif is_rapid(bufnr) then
     return 'rapid'
-  else
-    -- Nothing recognized, assume modsim3
-    return 'modsim3'
+  end
+  -- Nothing recognized, assume modsim3
+  return 'modsim3'
+end
+
+--- Determine if *.mod is ABB RAPID, LambdaProlog, Modula-2, Modsim III or go.mod
+--- @type vim.filetype.mapfn
+function M.mp(_, _)
+  return 'mp', function(b)
+    vim.b[b].mp_metafun = 1
   end
 end
 
-function M.news(bufnr)
-  if getlines(bufnr, 1):lower():find('; urgency=') then
+--- @type vim.filetype.mapfn
+function M.news(_, bufnr)
+  if getline(bufnr, 1):lower():find('; urgency=') then
     return 'debchangelog'
   end
 end
 
--- This function checks if one of the first five lines start with a dot. In
--- that case it is probably an nroff file.
-function M.nroff(bufnr)
+--- This function checks if one of the first five lines start with a dot. In
+--- that case it is probably an nroff file.
+--- @type vim.filetype.mapfn
+function M.nroff(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 5)) do
     if line:find('^%.') then
       return 'nroff'
@@ -804,25 +884,26 @@ function M.nroff(bufnr)
   end
 end
 
-function M.patch(bufnr)
-  local firstline = getlines(bufnr, 1)
+--- @type vim.filetype.mapfn
+function M.patch(_, bufnr)
+  local firstline = getline(bufnr, 1)
   if string.find(firstline, '^From ' .. string.rep('%x', 40) .. '+ Mon Sep 17 00:00:00 2001$') then
     return 'gitsendemail'
-  else
-    return 'diff'
   end
+  return 'diff'
 end
 
--- If the file has an extension of 't' and is in a directory 't' or 'xt' then
--- it is almost certainly a Perl test file.
--- If the first line starts with '#' and contains 'perl' it's probably a Perl file.
--- (Slow test) If a file contains a 'use' statement then it is almost certainly a Perl file.
+--- If the file has an extension of 't' and is in a directory 't' or 'xt' then
+--- it is almost certainly a Perl test file.
+--- If the first line starts with '#' and contains 'perl' it's probably a Perl file.
+--- (Slow test) If a file contains a 'use' statement then it is almost certainly a Perl file.
+--- @type vim.filetype.mapfn
 function M.perl(path, bufnr)
   local dir_name = vim.fs.dirname(path)
-  if vim.fn.expand(path, '%:e') == 't' and (dir_name == 't' or dir_name == 'xt') then
+  if fn.expand(path, '%:e') == 't' and (dir_name == 't' or dir_name == 'xt') then
     return 'perl'
   end
-  local first_line = getlines(bufnr, 1)
+  local first_line = getline(bufnr, 1)
   if first_line:find('^#') and first_line:lower():find('perl') then
     return 'perl'
   end
@@ -833,7 +914,8 @@ function M.perl(path, bufnr)
   end
 end
 
-function M.pl(bufnr)
+--- @type vim.filetype.mapfn
+function M.pl(_, bufnr)
   if vim.g.filetype_pl then
     return vim.g.filetype_pl
   end
@@ -851,8 +933,9 @@ function M.pl(bufnr)
   end
 end
 
-function M.pm(bufnr)
-  local line = getlines(bufnr, 1)
+--- @type vim.filetype.mapfn
+function M.pm(_, bufnr)
+  local line = getline(bufnr, 1)
   if line:find('XPM2') then
     return 'xpm2'
   elseif line:find('XPM') then
@@ -862,7 +945,8 @@ function M.pm(bufnr)
   end
 end
 
-function M.pp(bufnr)
+--- @type vim.filetype.mapfn
+function M.pp(_, bufnr)
   if vim.g.filetype_pp then
     return vim.g.filetype_pp
   end
@@ -874,7 +958,8 @@ function M.pp(bufnr)
   end
 end
 
-function M.prg(bufnr)
+--- @type vim.filetype.mapfn
+function M.prg(_, bufnr)
   if vim.g.filetype_prg then
     return vim.g.filetype_prg
   elseif is_rapid(bufnr) then
@@ -886,7 +971,7 @@ function M.prg(bufnr)
 end
 
 function M.printcap(ptcap_type)
-  if vim.fn.did_filetype() == 0 then
+  if fn.did_filetype() == 0 then
     return 'ptcap', function(bufnr)
       vim.b[bufnr].ptcap_type = ptcap_type
     end
@@ -895,14 +980,15 @@ end
 
 -- This function checks for an assembly comment in the first ten lines.
 -- If not found, assume Progress.
-function M.progress_asm(bufnr)
+--- @type vim.filetype.mapfn
+function M.progress_asm(path, bufnr)
   if vim.g.filetype_i then
     return vim.g.filetype_i
   end
 
   for _, line in ipairs(getlines(bufnr, 1, 10)) do
     if line:find('^%s*;') or line:find('^/%*') then
-      return M.asm(bufnr)
+      return M.asm(path, bufnr)
     elseif not line:find('^%s*$') or line:find('^/%*') then
       -- Not an empty line: doesn't look like valid assembly code
       -- or it looks like a Progress /* comment.
@@ -912,13 +998,14 @@ function M.progress_asm(bufnr)
   return 'progress'
 end
 
-function M.progress_cweb(bufnr)
+--- @type vim.filetype.mapfn
+function M.progress_cweb(_, bufnr)
   if vim.g.filetype_w then
     return vim.g.filetype_w
   else
     if
-      getlines(bufnr, 1):lower():find('^&analyze')
-      or getlines(bufnr, 3):lower():find('^&global%-define')
+      getline(bufnr, 1):lower():find('^&analyze')
+      or getline(bufnr, 3):lower():find('^&global%-define')
     then
       return 'progress'
     else
@@ -930,7 +1017,8 @@ end
 -- This function checks for valid Pascal syntax in the first 10 lines.
 -- Look for either an opening comment or a program start.
 -- If not found, assume Progress.
-function M.progress_pascal(bufnr)
+--- @type vim.filetype.mapfn
+function M.progress_pascal(_, bufnr)
   if vim.g.filetype_p then
     return vim.g.filetype_p
   end
@@ -946,34 +1034,33 @@ function M.progress_pascal(bufnr)
   return 'progress'
 end
 
--- Distinguish between "default", Prolog and Cproto prototype file.
-function M.proto(bufnr, default)
+--- Distinguish between "default", Prolog and Cproto prototype file.
+--- @type vim.filetype.mapfn
+function M.proto(_, bufnr)
   -- Cproto files have a comment in the first line and a function prototype in
   -- the second line, it always ends in ";".  Indent files may also have
   -- comments, thus we can't match comments to see the difference.
   -- IDL files can have a single ';' in the second line, require at least one
   -- character before the ';'.
-  if getlines(bufnr, 2):find('.;$') then
+  if getline(bufnr, 2):find('.;$') then
     return 'cpp'
-  else
-    -- Recognize Prolog by specific text in the first non-empty line;
-    -- require a blank after the '%' because Perl uses "%list" and "%translate"
-    local line = nextnonblank(bufnr, 1)
-    if
-      line and line:find(':%-')
-      or matchregex(line, [[\c\<prolog\>]])
-      or findany(line, { '^%s*%%+%s', '^%s*%%+$', '^%s*/%*' })
-    then
-      return 'prolog'
-    else
-      return default
-    end
+  end
+  -- Recognize Prolog by specific text in the first non-empty line;
+  -- require a blank after the '%' because Perl uses "%list" and "%translate"
+  local line = nextnonblank(bufnr, 1)
+  if
+    line and line:find(':%-')
+    or matchregex(line, [[\c\<prolog\>]])
+    or findany(line, { '^%s*%%+%s', '^%s*%%+$', '^%s*/%*' })
+  then
+    return 'prolog'
   end
 end
 
 -- Software Distributor Product Specification File (POSIX 1387.2-1995)
-function M.psf(bufnr)
-  local line = getlines(bufnr, 1):lower()
+--- @type vim.filetype.mapfn
+function M.psf(_, bufnr)
+  local line = getline(bufnr, 1):lower()
   if
     findany(line, {
       '^%s*distribution%s*$',
@@ -987,7 +1074,8 @@ function M.psf(bufnr)
   end
 end
 
-function M.r(bufnr)
+--- @type vim.filetype.mapfn
+function M.r(_, bufnr)
   local lines = getlines(bufnr, 1, 50)
   -- Rebol is easy to recognize, check for that first
   if matchregex(table.concat(lines), [[\c\<rebol\>]]) then
@@ -1008,13 +1096,13 @@ function M.r(bufnr)
   -- Nothing recognized, use user default or assume R
   if vim.g.filetype_r then
     return vim.g.filetype_r
-  else
-    -- Rexx used to be the default, but R appears to be much more popular.
-    return 'r'
   end
+  -- Rexx used to be the default, but R appears to be much more popular.
+  return 'r'
 end
 
-function M.redif(bufnr)
+--- @type vim.filetype.mapfn
+function M.redif(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 5)) do
     if line:lower():find('^template%-type:') then
       return 'redif'
@@ -1022,8 +1110,9 @@ function M.redif(bufnr)
   end
 end
 
-function M.reg(bufnr)
-  local line = getlines(bufnr, 1):lower()
+--- @type vim.filetype.mapfn
+function M.reg(_, bufnr)
+  local line = getline(bufnr, 1):lower()
   if
     line:find('^regedit[0-9]*%s*$') or line:find('^windows registry editor version %d*%.%d*%s*$')
   then
@@ -1032,7 +1121,8 @@ function M.reg(bufnr)
 end
 
 -- Diva (with Skill) or InstallShield
-function M.rul(bufnr)
+--- @type vim.filetype.mapfn
+function M.rul(_, bufnr)
   if table.concat(getlines(bufnr, 1, 6)):lower():find('installshield') then
     return 'ishd'
   end
@@ -1040,6 +1130,7 @@ function M.rul(bufnr)
 end
 
 local udev_rules_pattern = '^%s*udev_rules%s*=%s*"([%^"]+)/*".*'
+--- @type vim.filetype.mapfn
 function M.rules(path)
   path = path:lower()
   if
@@ -1059,11 +1150,12 @@ function M.rules(path)
   elseif findany(path, { '^/etc/polkit%-1/rules%.d', '/usr/share/polkit%-1/rules%.d' }) then
     return 'javascript'
   else
-    local ok, config_lines = pcall(vim.fn.readfile, '/etc/udev/udev.conf')
+    local ok, config_lines = pcall(fn.readfile, '/etc/udev/udev.conf')
+    --- @cast config_lines +string[]
     if not ok then
       return 'hog'
     end
-    local dir = vim.fn.expand(path, ':h')
+    local dir = fn.expand(path, ':h')
     for _, line in ipairs(config_lines) do
       local match = line:match(udev_rules_pattern)
       if match then
@@ -1078,7 +1170,8 @@ function M.rules(path)
 end
 
 -- LambdaProlog and Standard ML signature files
-function M.sig(bufnr)
+--- @type vim.filetype.mapfn
+function M.sig(_, bufnr)
   if vim.g.filetype_sig then
     return vim.g.filetype_sig
   end
@@ -1096,7 +1189,8 @@ end
 
 -- This function checks the first 25 lines of file extension "sc" to resolve
 -- detection between scala and SuperCollider
-function M.sc(bufnr)
+--- @type vim.filetype.mapfn
+function M.sc(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 25)) do
     if
       findany(line, {
@@ -1116,18 +1210,19 @@ end
 
 -- This function checks the first line of file extension "scd" to resolve
 -- detection between scdoc and SuperCollider
-function M.scd(bufnr)
+--- @type vim.filetype.mapfn
+function M.scd(_, bufnr)
   local first = '^%S+%(%d[0-9A-Za-z]*%)'
   local opt = [[%s+"[^"]*"]]
-  local line = getlines(bufnr, 1)
+  local line = getline(bufnr, 1)
   if findany(line, { first .. '$', first .. opt .. '$', first .. opt .. opt .. '$' }) then
     return 'scdoc'
-  else
-    return 'supercollider'
   end
+  return 'supercollider'
 end
 
-function M.sgml(bufnr)
+--- @type vim.filetype.mapfn
+function M.sgml(_, bufnr)
   local lines = table.concat(getlines(bufnr, 1, 5))
   if lines:find('linuxdoc') then
     return 'smgllnx'
@@ -1142,15 +1237,17 @@ function M.sgml(bufnr)
   end
 end
 
-function M.sh(path, contents, name)
+--- @param path string
+--- @param contents string[]
+--- @param name? string
+--- @return string?, fun(b: integer)?
+local function sh(path, contents, name)
   -- Path may be nil, do not fail in that case
-  if vim.fn.did_filetype() ~= 0 or (path or ''):find(vim.g.ft_ignore_pat) then
+  if fn.did_filetype() ~= 0 or (path or ''):find(vim.g.ft_ignore_pat) then
     -- Filetype was already detected or detection should be skipped
     return
   end
 
-  local on_detect
-
   -- Get the name from the first line if not specified
   name = name or contents[1]
   if matchregex(name, [[\<csh\>]]) then
@@ -1162,7 +1259,11 @@ function M.sh(path, contents, name)
     -- Some .sh scripts contain #!/bin/zsh.
   elseif matchregex(name, [[\<zsh\>]]) then
     return M.shell(path, contents, 'zsh')
-  elseif matchregex(name, [[\<ksh\>]]) then
+  end
+
+  local on_detect --- @type fun(b: integer)?
+
+  if matchregex(name, [[\<ksh\>]]) then
     on_detect = function(b)
       vim.b[b].is_kornshell = 1
       vim.b[b].is_bash = nil
@@ -1185,9 +1286,26 @@ function M.sh(path, contents, name)
   return M.shell(path, contents, 'sh'), on_detect
 end
 
--- For shell-like file types, check for an "exec" command hidden in a comment, as used for Tcl.
+--- @param name? string
+--- @return vim.filetype.mapfn
+local function sh_with(name)
+  return function(path, bufnr)
+    return sh(path, getlines(bufnr), name)
+  end
+end
+
+M.sh = sh_with()
+M.bash = sh_with('bash')
+M.ksh = sh_with('ksh')
+M.tcsh = sh_with('tcsh')
+
+--- For shell-like file types, check for an "exec" command hidden in a comment, as used for Tcl.
+--- @param path string
+--- @param contents string[]
+--- @param name? string
+--- @return string?
 function M.shell(path, contents, name)
-  if vim.fn.did_filetype() ~= 0 or matchregex(path, vim.g.ft_ignore_pat) then
+  if fn.did_filetype() ~= 0 or matchregex(path, vim.g.ft_ignore_pat) then
     -- Filetype was already detected or detection should be skipped
     return
   end
@@ -1196,6 +1314,7 @@ function M.shell(path, contents, name)
   for line_nr, line in ipairs(contents) do
     -- Skip the first line
     if line_nr ~= 1 then
+      --- @type string
       line = line:lower()
       if line:find('%s*exec%s') and not prev_line:find('^%s*#.*\\$') then
         -- Found an "exec" line after a comment with continuation
@@ -1211,7 +1330,8 @@ function M.shell(path, contents, name)
 end
 
 -- Swift Intermediate Language or SILE
-function M.sil(bufnr)
+--- @type vim.filetype.mapfn
+function M.sil(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 100)) do
     if line:find('^%s*[\\%%]') then
       return 'sile'
@@ -1224,8 +1344,9 @@ function M.sil(bufnr)
 end
 
 -- SMIL or SNMP MIB file
-function M.smi(bufnr)
-  local line = getlines(bufnr, 1)
+--- @type vim.filetype.mapfn
+function M.smi(_, bufnr)
+  local line = getline(bufnr, 1)
   if matchregex(line, [[\c\<smil\>]]) then
     return 'smil'
   else
@@ -1233,8 +1354,14 @@ function M.smi(bufnr)
   end
 end
 
+--- @type vim.filetype.mapfn
+function M.sql(_, _)
+  return vim.g.filetype_sql and vim.g.filetype_sql or 'sql'
+end
+
 -- Determine if a *.src file is Kuka Robot Language
-function M.src(bufnr)
+--- @type vim.filetype.mapfn
+function M.src(_, bufnr)
   if vim.g.filetype_src then
     return vim.g.filetype_src
   end
@@ -1244,23 +1371,25 @@ function M.src(bufnr)
   end
 end
 
-function M.sys(bufnr)
+--- @type vim.filetype.mapfn
+function M.sys(_, bufnr)
   if vim.g.filetype_sys then
     return vim.g.filetype_sys
   elseif is_rapid(bufnr) then
     return 'rapid'
-  else
-    return 'bat'
   end
+  return 'bat'
 end
 
 -- Choose context, plaintex, or tex (LaTeX) based on these rules:
 -- 1. Check the first line of the file for "%&<format>".
 -- 2. Check the first 1000 non-comment lines for LaTeX or ConTeXt keywords.
 -- 3. Default to "plain" or to g:tex_flavor, can be set in user's vimrc.
+--- @type vim.filetype.mapfn
 function M.tex(path, bufnr)
-  local matched, _, format = getlines(bufnr, 1):find('^%%&%s*(%a+)')
+  local matched, _, format = getline(bufnr, 1):find('^%%&%s*(%a+)')
   if matched then
+    --- @type string
     format = format:lower():gsub('pdf', '', 1)
   elseif path:lower():find('tex/context/.*/.*%.tex') then
     return 'context'
@@ -1299,7 +1428,8 @@ function M.tex(path, bufnr)
 end
 
 -- Determine if a *.tf file is TF mud client or terraform
-function M.tf(bufnr)
+--- @type vim.filetype.mapfn
+function M.tf(_, bufnr)
   for _, line in ipairs(getlines(bufnr)) do
     -- Assume terraform file on a non-empty line (not whitespace-only)
     -- and when the first non-whitespace character is not a ; or /
@@ -1310,22 +1440,25 @@ function M.tf(bufnr)
   return 'tf'
 end
 
-function M.ttl(bufnr)
-  local line = getlines(bufnr, 1):lower()
+--- @type vim.filetype.mapfn
+function M.ttl(_, bufnr)
+  local line = getline(bufnr, 1):lower()
   if line:find('^@?prefix') or line:find('^@?base') then
     return 'turtle'
   end
   return 'teraterm'
 end
 
-function M.txt(bufnr)
+--- @type vim.filetype.mapfn
+function M.txt(_, bufnr)
   -- helpfiles match *.txt, but should have a modeline as last line
-  if not getlines(bufnr, -1):find('vim:.*ft=help') then
+  if not getline(bufnr, -1):find('vim:.*ft=help') then
     return 'text'
   end
 end
 
-function M.typ(bufnr)
+--- @type vim.filetype.mapfn
+function M.typ(_, bufnr)
   if vim.g.filetype_typ then
     return vim.g.filetype_typ
   end
@@ -1348,8 +1481,9 @@ function M.typ(bufnr)
 end
 
 -- Determine if a .v file is Verilog, V, or Coq
-function M.v(bufnr)
-  if vim.fn.did_filetype() ~= 0 then
+--- @type vim.filetype.mapfn
+function M.v(_, bufnr)
+  if fn.did_filetype() ~= 0 then
     -- Filetype was already detected
     return
   end
@@ -1367,7 +1501,8 @@ end
 
 -- WEB (*.web is also used for Winbatch: Guess, based on expecting "%" comment
 -- lines in a WEB file).
-function M.web(bufnr)
+--- @type vim.filetype.mapfn
+function M.web(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 5)) do
     if line:find('^%%') then
       return 'web'
@@ -1377,17 +1512,27 @@ function M.web(bufnr)
 end
 
 -- XFree86 config
-function M.xfree86()
+--- @type vim.filetype.mapfn
+function M.xfree86_v3(_, _)
   return 'xf86conf',
     function(bufnr)
-      local line = getlines(bufnr, 1)
+      local line = getline(bufnr, 1)
       if matchregex(line, [[\<XConfigurator\>]]) then
         vim.b[bufnr].xf86conf_xfree86_version = 3
       end
     end
 end
 
-function M.xml(bufnr)
+-- XFree86 config
+--- @type vim.filetype.mapfn
+function M.xfree86_v4(_, _)
+  return 'xf86conf', function(b)
+    vim.b[b].xf86conf_xfree86_version = 4
+  end
+end
+
+--- @type vim.filetype.mapfn
+function M.xml(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 100)) do
     local is_docbook4 = line:find('<!DOCTYPE.*DocBook')
     line = line:lower()
@@ -1406,7 +1551,8 @@ function M.xml(bufnr)
   return 'xml'
 end
 
-function M.y(bufnr)
+--- @type vim.filetype.mapfn
+function M.y(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 100)) do
     if line:find('^%s*%%') then
       return 'yacc'
@@ -1463,7 +1609,12 @@ local patterns_hashbang = {
 }
 
 ---@private
--- File starts with "#!".
+--- File starts with "#!".
+--- @param contents string[]
+--- @param path string
+--- @param dispatch_extension fun(name: string): string?, fun(b: integer)?
+--- @return string?
+--- @return fun(b: integer)?
 local function match_from_hashbang(contents, path, dispatch_extension)
   local first_line = contents[1]
   -- Check for a line like "#!/usr/bin/env {options} bash".  Turn it into
@@ -1475,7 +1626,7 @@ local function match_from_hashbang(contents, path, dispatch_extension)
       :gsub('%-%-ignore%-environment', '', 1)
       :gsub('%-%-split%-string', '', 1)
       :gsub('%-[iS]', '', 1)
-    first_line = vim.fn.substitute(first_line, [[\<env\s\+]], '', '')
+    first_line = fn.substitute(first_line, [[\<env\s\+]], '', '')
   end
 
   -- Get the program name.
@@ -1484,15 +1635,15 @@ local function match_from_hashbang(contents, path, dispatch_extension)
   -- "#!/usr/bin/env perl [path/args]"
   -- If there is no path use the first word: "#!perl [path/args]".
   -- Otherwise get the last word after a slash: "#!/usr/bin/perl [path/args]".
-  local name
+  local name --- @type string
   if first_line:find('^#!%s*%a:[/\\]') then
-    name = vim.fn.substitute(first_line, [[^#!.*[/\\]\(\i\+\).*]], '\\1', '')
+    name = fn.substitute(first_line, [[^#!.*[/\\]\(\i\+\).*]], '\\1', '')
   elseif matchregex(first_line, [[^#!.*\<env\>]]) then
-    name = vim.fn.substitute(first_line, [[^#!.*\<env\>\s\+\(\i\+\).*]], '\\1', '')
+    name = fn.substitute(first_line, [[^#!.*\<env\>\s\+\(\i\+\).*]], '\\1', '')
   elseif matchregex(first_line, [[^#!\s*[^/\\ ]*\>\([^/\\]\|$\)]]) then
-    name = vim.fn.substitute(first_line, [[^#!\s*\([^/\\ ]*\>\).*]], '\\1', '')
+    name = fn.substitute(first_line, [[^#!\s*\([^/\\ ]*\>\).*]], '\\1', '')
   else
-    name = vim.fn.substitute(first_line, [[^#!\s*\S*[/\\]\(\f\+\).*]], '\\1', '')
+    name = fn.substitute(first_line, [[^#!\s*\S*[/\\]\(\f\+\).*]], '\\1', '')
   end
 
   -- tcl scripts may have #!/bin/sh in the first line and "exec wish" in the
@@ -1503,11 +1654,11 @@ local function match_from_hashbang(contents, path, dispatch_extension)
 
   if matchregex(name, [[^\(bash\d*\|dash\|ksh\d*\|sh\)\>]]) then
     -- Bourne-like shell scripts: bash bash2 dash ksh ksh93 sh
-    return require('vim.filetype.detect').sh(path, contents, first_line)
+    return sh(path, contents, first_line)
   elseif matchregex(name, [[^csh\>]]) then
-    return require('vim.filetype.detect').shell(path, contents, vim.g.filetype_csh or 'csh')
+    return M.shell(path, contents, vim.g.filetype_csh or 'csh')
   elseif matchregex(name, [[^tcsh\>]]) then
-    return require('vim.filetype.detect').shell(path, contents, 'tcsh')
+    return M.shell(path, contents, 'tcsh')
   end
 
   for k, v in pairs(patterns_hashbang) do
@@ -1612,9 +1763,7 @@ local patterns_text = {
   ['S Y S T E M S   I M P R O V E D '] = { 'syndaout', { start_lnum = 3 } },
   ['Run Date: '] = { 'takcmp', { start_lnum = 6 } },
   ['Node    File  1'] = { 'sindacmp', { start_lnum = 9 } },
-  function(contents)
-    require('vim.filetype.detect').dns_zone(contents)
-  end,
+  dns_zone,
   -- Valgrind
   ['^==%d+== valgrind'] = 'valgrind',
   ['^==%d+== Using valgrind'] = { 'valgrind', { start_lnum = 3 } },
@@ -1653,11 +1802,15 @@ local patterns_text = {
 }
 
 ---@private
--- File does not start with "#!".
+--- File does not start with "#!".
+--- @param contents string[]
+--- @param path string
+--- @return string?
+--- @return fun(b: integer)?
 local function match_from_text(contents, path)
   if contents[1]:find('^:$') then
     -- Bourne-like shell scripts: sh ksh bash bash2
-    return M.sh(path, contents)
+    return sh(path, contents)
   elseif
     matchregex(
       '\n' .. table.concat(contents, '\n'),
@@ -1708,6 +1861,11 @@ local function match_from_text(contents, path)
   return cvs_diff(path, contents)
 end
 
+--- @param contents string[]
+--- @param path string
+--- @param dispatch_extension fun(name: string): string?, fun(b: integer)?
+--- @return string?
+--- @return fun(b: integer)?
 function M.match_contents(contents, path, dispatch_extension)
   local first_line = contents[1]
   if first_line:find('^#!') then
-- 
cgit 


From 4134cebb17dd0bfd2024f1816d6884e8213a620a Mon Sep 17 00:00:00 2001
From: Sean Dewar <seandewar@users.noreply.github.com>
Date: Tue, 8 Aug 2023 21:25:22 +0100
Subject: docs(builtin): fix some missing lines (#24615)

These two functions seem to have previously had their docs start on the same
line as the signature, which I guess contributed to the lines being lost (though
I checked all other such functions from before again and these were the only
two).
---
 runtime/lua/vim/_meta/vimfn.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index bb11e34a57..7c98ed8849 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -4115,6 +4115,7 @@ function vim.fn.iconv(string, from, to) end
 --- @return any
 function vim.fn.id(expr) end
 
+--- The result is a Number, which is indent of line {lnum} in the
 --- current buffer.  The indent is counted in spaces, the value
 --- of 'tabstop' is relevant.  {lnum} is used just like in
 --- |getline()|.
@@ -4712,6 +4713,7 @@ function vim.fn.keytrans(string) end
 --- @return any
 function vim.fn.last_buffer_nr() end
 
+--- The result is a Number, which is the length of the argument.
 --- When {expr} is a String or a Number the length in bytes is
 --- used, as with |strlen()|.
 --- When {expr} is a |List| the number of items in the |List| is
-- 
cgit 


From c43c745a14dced87a23227d7be4f1c33d4455193 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 9 Aug 2023 11:06:13 +0200
Subject: fix(lua): improve annotations for stricter luals diagnostics (#24609)

Problem: luals returns stricter diagnostics with bundled luarc.json
Solution: Improve some function and type annotations:

* use recognized uv.* types
* disable diagnostic for global `vim` in shared.lua
* docs: don't start comment lines with taglink (otherwise LuaLS will interpret it as a type)
* add type alias for lpeg pattern
* fix return annotation for `vim.secure.trust`
* rename local Range object in vim.version (shadows `Range` in vim.treesitter)
* fix some "missing fields" warnings
* add missing required fields for test functions in eval.lua
* rename lsp meta files for consistency
---
 runtime/lua/vim/_editor.lua             |    4 +-
 runtime/lua/vim/_system.lua             |   32 +-
 runtime/lua/vim/_watch.lua              |    4 +-
 runtime/lua/vim/diagnostic.lua          |   46 +-
 runtime/lua/vim/loader.lua              |    2 +-
 runtime/lua/vim/lsp.lua                 |    2 +-
 runtime/lua/vim/lsp/_meta.lua           |   22 +
 runtime/lua/vim/lsp/_meta/protocol.lua  | 4396 +++++++++++++++++++++++++++++++
 runtime/lua/vim/lsp/_watchfiles.lua     |    8 +-
 runtime/lua/vim/lsp/inlay_hint.lua      |    4 +-
 runtime/lua/vim/lsp/semantic_tokens.lua |   13 +-
 runtime/lua/vim/lsp/types.lua           |   21 -
 runtime/lua/vim/lsp/types/protocol.lua  | 4393 ------------------------------
 runtime/lua/vim/lsp/util.lua            |    4 +-
 runtime/lua/vim/secure.lua              |    5 +-
 runtime/lua/vim/shared.lua              |    3 +-
 runtime/lua/vim/treesitter/query.lua    |    2 +-
 runtime/lua/vim/version.lua             |   12 +-
 18 files changed, 4487 insertions(+), 4486 deletions(-)
 create mode 100644 runtime/lua/vim/lsp/_meta.lua
 create mode 100644 runtime/lua/vim/lsp/_meta/protocol.lua
 delete mode 100644 runtime/lua/vim/lsp/types.lua
 delete mode 100644 runtime/lua/vim/lsp/types/protocol.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index d81464a3ca..58fbc923e1 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -620,8 +620,8 @@ local on_key_cbs = {}
 ---
 ---@param fn fun(key: string) Function invoked on every key press. |i_CTRL-V|
 ---                   Returning nil removes the callback associated with namespace {ns_id}.
----@param ns_id integer? Namespace ID. If nil or 0, generates and returns a new
----                    |nvim_create_namespace()| id.
+---@param ns_id integer? Namespace ID. If nil or 0, generates and returns a
+---                     new |nvim_create_namespace()| id.
 ---
 ---@return integer Namespace id associated with {fn}. Or count of all callbacks
 ---if on_key() is called without arguments.
diff --git a/runtime/lua/vim/_system.lua b/runtime/lua/vim/_system.lua
index e6dab90425..6f5e95eb24 100644
--- a/runtime/lua/vim/_system.lua
+++ b/runtime/lua/vim/_system.lua
@@ -1,14 +1,13 @@
 local uv = vim.uv
 
 --- @class SystemOpts
---- @field cmd string[]
---- @field stdin string|string[]|true
---- @field stdout fun(err:string, data: string)|false
---- @field stderr fun(err:string, data: string)|false
+--- @field stdin? string|string[]|true
+--- @field stdout? fun(err:string, data: string)|false
+--- @field stderr? fun(err:string, data: string)|false
 --- @field cwd? string
 --- @field env? table<string,string|number>
 --- @field clear_env? boolean
---- @field text boolean?
+--- @field text? boolean
 --- @field timeout? integer Timeout in ms
 --- @field detach? boolean
 
@@ -19,15 +18,14 @@ local uv = vim.uv
 --- @field stderr? string
 
 --- @class SystemState
---- @field handle uv_process_t
---- @field timer uv_timer_t
---- @field pid integer
+--- @field handle? uv.uv_process_t
+--- @field timer?  uv.uv_timer_t
+--- @field pid? integer
 --- @field timeout? integer
---- @field done boolean
---- @field stdin uv_stream_t?
---- @field stdout uv_stream_t?
---- @field stderr uv_stream_t?
---- @field cmd string[]
+--- @field done? boolean
+--- @field stdin? uv.uv_stream_t
+--- @field stdout? uv.uv_stream_t
+--- @field stderr? uv.uv_stream_t
 --- @field result? SystemCompleted
 
 ---@param state SystemState
@@ -128,7 +126,7 @@ function SystemObj:is_closing()
 end
 
 ---@param output function|'false'
----@return uv_stream_t?
+---@return uv.uv_stream_t?
 ---@return function? Handler
 local function setup_output(output)
   if output == nil then
@@ -144,7 +142,7 @@ local function setup_output(output)
 end
 
 ---@param input string|string[]|true|nil
----@return uv_stream_t?
+---@return uv.uv_stream_t?
 ---@return string|string[]?
 local function setup_input(input)
   if not input then
@@ -189,7 +187,7 @@ local function setup_env(env, clear_env)
   return renv
 end
 
---- @param stream uv_stream_t
+--- @param stream uv.uv_stream_t
 --- @param text? boolean
 --- @param bucket string[]
 --- @return fun(err: string?, data: string?)
@@ -217,7 +215,7 @@ local M = {}
 --- @param opts uv.aliases.spawn_options
 --- @param on_exit fun(code: integer, signal: integer)
 --- @param on_error fun()
---- @return uv_process_t, integer
+--- @return uv.uv_process_t, integer
 local function spawn(cmd, opts, on_exit, on_error)
   local handle, pid_or_err = uv.spawn(cmd, opts, on_exit)
   if not handle then
diff --git a/runtime/lua/vim/_watch.lua b/runtime/lua/vim/_watch.lua
index dc5f59f38b..7230b31f6f 100644
--- a/runtime/lua/vim/_watch.lua
+++ b/runtime/lua/vim/_watch.lua
@@ -17,7 +17,7 @@ end
 
 --- Stops and closes a libuv |uv_fs_event_t| or |uv_fs_poll_t| handle
 ---
----@param handle (uv_fs_event_t|uv_fs_poll_t) The handle to stop
+---@param handle (uv.uv_fs_event_t|uv.uv_fs_poll_t) The handle to stop
 local function stop(handle)
   local _, stop_err = handle:stop()
   assert(not stop_err, stop_err)
@@ -79,7 +79,7 @@ local default_poll_interval_ms = 2000
 --- @field children? table<string,watch.Watches>
 --- @field cancel? fun()
 --- @field started? boolean
---- @field handle? uv_fs_poll_t
+--- @field handle? uv.uv_fs_poll_t
 
 --- @class watch.PollOpts
 --- @field interval? integer
diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index f0adc4104e..180b9ad3df 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -562,8 +562,8 @@ end
 ---@param opts table|nil When omitted or "nil", retrieve the current configuration. Otherwise, a
 ---                      configuration table with the following keys:
 ---       - underline: (default true) Use underline for diagnostics. Options:
----                    * severity: Only underline diagnostics matching the given severity
----                    |diagnostic-severity|
+---                    * severity: Only underline diagnostics matching the given
+---                    severity |diagnostic-severity|
 ---       - virtual_text: (default true) Use virtual text for diagnostics. If multiple diagnostics
 ---                       are set for a namespace, one prefix per diagnostic + the last diagnostic
 ---                       message are shown.
@@ -596,8 +596,8 @@ end
 ---                         end
 ---                       </pre>
 ---       - signs: (default true) Use signs for diagnostics. Options:
----                * severity: Only show signs for diagnostics matching the given severity
----                |diagnostic-severity|
+---                * severity: Only show signs for diagnostics matching the given
+---                severity |diagnostic-severity|
 ---                * priority: (number, default 10) Base priority to use for signs. When
 ---                {severity_sort} is used, the priority of a sign is adjusted based on
 ---                its severity. Otherwise, all signs use the same priority.
@@ -723,17 +723,17 @@ function M.get_namespaces()
 end
 
 ---@class Diagnostic
----@field bufnr integer
+---@field bufnr? integer
 ---@field lnum integer 0-indexed
----@field end_lnum nil|integer 0-indexed
+---@field end_lnum? integer 0-indexed
 ---@field col integer 0-indexed
----@field end_col nil|integer 0-indexed
----@field severity DiagnosticSeverity
+---@field end_col? integer 0-indexed
+---@field severity? DiagnosticSeverity
 ---@field message string
----@field source nil|string
----@field code nil|string
----@field _tags { deprecated: boolean, unnecessary: boolean}
----@field user_data nil|any arbitrary data plugins can add
+---@field source? string
+---@field code? string
+---@field _tags? { deprecated: boolean, unnecessary: boolean}
+---@field user_data? any arbitrary data plugins can add
 
 --- Get current diagnostics.
 ---
@@ -819,13 +819,13 @@ end
 ---
 ---@param opts table|nil Configuration table with the following keys:
 ---         - namespace: (number) Only consider diagnostics from the given namespace.
----         - cursor_position: (cursor position) Cursor position as a (row, col) tuple. See
----                          |nvim_win_get_cursor()|. Defaults to the current cursor position.
+---         - cursor_position: (cursor position) Cursor position as a (row, col) tuple.
+---                          See |nvim_win_get_cursor()|. Defaults to the current cursor position.
 ---         - wrap: (boolean, default true) Whether to loop around file or not. Similar to 'wrapscan'.
 ---         - severity: See |diagnostic-severity|.
 ---         - float: (boolean or table, default true) If "true", call |vim.diagnostic.open_float()|
----                    after moving. If a table, pass the table as the {opts} parameter to
----                    |vim.diagnostic.open_float()|. Unless overridden, the float will show
+---                    after moving. If a table, pass the table as the {opts} parameter
+---                    to |vim.diagnostic.open_float()|. Unless overridden, the float will show
 ---                    diagnostics at the new cursor position (as if "cursor" were passed to
 ---                    the "scope" option).
 ---         - win_id: (number, default 0) Window ID
@@ -1213,8 +1213,8 @@ end
 
 --- Show diagnostics in a floating window.
 ---
----@param opts table|nil Configuration table with the same keys as
----            |vim.lsp.util.open_floating_preview()| in addition to the following:
+---@param opts table|nil Configuration table with the same keys
+---            as |vim.lsp.util.open_floating_preview()| in addition to the following:
 ---            - bufnr: (number) Buffer number to show diagnostics from.
 ---                     Defaults to the current buffer.
 ---            - namespace: (number) Limit diagnostics to the given namespace
@@ -1227,16 +1227,15 @@ end
 ---                   otherwise, a (row, col) tuple.
 ---            - severity_sort: (default false) Sort diagnostics by severity. Overrides the setting
 ---                             from |vim.diagnostic.config()|.
----            - severity: See |diagnostic-severity|. Overrides the setting from
----                        |vim.diagnostic.config()|.
+---            - severity: See |diagnostic-severity|. Overrides the setting
+---                        from |vim.diagnostic.config()|.
 ---            - header: (string or table) String to use as the header for the floating window. If a
 ---                      table, it is interpreted as a [text, hl_group] tuple. Overrides the setting
 ---                      from |vim.diagnostic.config()|.
 ---            - source: (boolean or string) Include the diagnostic source in the message.
 ---                      Use "if_many" to only show sources if there is more than one source of
 ---                      diagnostics in the buffer. Otherwise, any truthy value means to always show
----                      the diagnostic source. Overrides the setting from
----                      |vim.diagnostic.config()|.
+---                      the diagnostic source. Overrides the setting from |vim.diagnostic.config()|.
 ---            - format: (function) A function that takes a diagnostic as input and returns a
 ---                      string. The return value is the text used to display the diagnostic.
 ---                      Overrides the setting from |vim.diagnostic.config()|.
@@ -1692,8 +1691,7 @@ end
 
 --- Convert a list of quickfix items to a list of diagnostics.
 ---
----@param list table A list of quickfix items from |getqflist()| or
----            |getloclist()|.
+---@param list table[] List of quickfix items from |getqflist()| or |getloclist()|.
 ---@return Diagnostic[] array of |diagnostic-structure|
 function M.fromqflist(list)
   vim.validate({
diff --git a/runtime/lua/vim/loader.lua b/runtime/lua/vim/loader.lua
index e08ccba701..ee01111337 100644
--- a/runtime/lua/vim/loader.lua
+++ b/runtime/lua/vim/loader.lua
@@ -18,7 +18,7 @@ local M = {}
 ---@class ModuleInfo
 ---@field modpath string Path of the module
 ---@field modname string Name of the module
----@field stat? uv_fs_t File stat of the module path
+---@field stat? uv.uv_fs_t File stat of the module path
 
 ---@alias LoaderStats table<string, {total:number, time:number, [string]:number?}?>
 
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index bfba275c33..0c4290d067 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -364,7 +364,7 @@ do
   --- @field lines string[] snapshot of buffer lines from last didChange
   --- @field lines_tmp string[]
   --- @field pending_changes table[] List of debounced changes in incremental sync mode
-  --- @field timer nil|uv_timer_t uv_timer
+  --- @field timer nil|uv.uv_timer_t uv_timer
   --- @field last_flush nil|number uv.hrtime of the last flush/didChange-notification
   --- @field needs_flush boolean true if buffer updates haven't been sent to clients/servers yet
   --- @field refs integer how many clients are using this group
diff --git a/runtime/lua/vim/lsp/_meta.lua b/runtime/lua/vim/lsp/_meta.lua
new file mode 100644
index 0000000000..acf799264e
--- /dev/null
+++ b/runtime/lua/vim/lsp/_meta.lua
@@ -0,0 +1,22 @@
+---@meta
+error('Cannot require a meta file')
+
+---@alias lsp-handler fun(err: lsp.ResponseError|nil, result: any, context: lsp.HandlerContext, config: table|nil): any?
+
+---@class lsp.HandlerContext
+---@field method string
+---@field client_id integer
+---@field bufnr? integer
+---@field params? any
+
+---@class lsp.ResponseError
+---@field code integer
+---@field message string
+---@field data string|number|boolean|table[]|table|nil
+
+--- @class lsp.DocumentFilter
+--- @field language? string
+--- @field scheme? string
+--- @field pattern? string
+
+--- @alias lsp.RegisterOptions any | lsp.StaticRegistrationOptions | lsp.TextDocumentRegistrationOptions
diff --git a/runtime/lua/vim/lsp/_meta/protocol.lua b/runtime/lua/vim/lsp/_meta/protocol.lua
new file mode 100644
index 0000000000..72b0f00f65
--- /dev/null
+++ b/runtime/lua/vim/lsp/_meta/protocol.lua
@@ -0,0 +1,4396 @@
+--[[
+This file is autogenerated from scripts/gen_lsp.lua
+Regenerate:
+nvim -l scripts/gen_lsp.lua gen --version 3.18 --runtime/lua/vim/lsp/_meta/protocol.lua
+--]]
+
+---@meta
+error('Cannot require a meta file')
+
+---@alias lsp.null nil
+---@alias uinteger integer
+---@alias lsp.decimal number
+---@alias lsp.DocumentUri string
+---@alias lsp.URI string
+---@alias lsp.LSPObject table<string, lsp.LSPAny>
+---@alias lsp.LSPArray lsp.LSPAny[]
+---@alias lsp.LSPAny lsp.LSPObject|lsp.LSPArray|string|number|boolean|nil
+
+---@class lsp.ImplementationParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---Represents a location inside a resource, such as a line
+---inside a text file.
+---@class lsp.Location
+---@field uri lsp.DocumentUri
+---@field range lsp.Range
+
+---@class lsp.ImplementationRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---@class lsp.TypeDefinitionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---@class lsp.TypeDefinitionRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---A workspace folder inside a client.
+---@class lsp.WorkspaceFolder
+---The associated URI for this workspace folder.
+---@field uri lsp.URI
+---The name of the workspace folder. Used to refer to this
+---workspace folder in the user interface.
+---@field name string
+
+---The parameters of a `workspace/didChangeWorkspaceFolders` notification.
+---@class lsp.DidChangeWorkspaceFoldersParams
+---The actual workspace folder change event.
+---@field event lsp.WorkspaceFoldersChangeEvent
+
+---The parameters of a configuration request.
+---@class lsp.ConfigurationParams
+---@field items lsp.ConfigurationItem[]
+
+---Parameters for a {@link DocumentColorRequest}.
+---@class lsp.DocumentColorParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---Represents a color range from a document.
+---@class lsp.ColorInformation
+---The range in the document where this color appears.
+---@field range lsp.Range
+---The actual color value for this color range.
+---@field color lsp.Color
+
+---@class lsp.DocumentColorRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---Parameters for a {@link ColorPresentationRequest}.
+---@class lsp.ColorPresentationParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The color to request presentations for.
+---@field color lsp.Color
+---The range where the color would be inserted. Serves as a context.
+---@field range lsp.Range
+
+---@class lsp.ColorPresentation
+---The label of this color presentation. It will be shown on the color
+---picker header. By default this is also the text that is inserted when selecting
+---this color presentation.
+---@field label string
+---An {@link TextEdit edit} which is applied to a document when selecting
+---this presentation for the color.  When `falsy` the {@link ColorPresentation.label label}
+---is used.
+---@field textEdit? lsp.TextEdit
+---An optional array of additional {@link TextEdit text edits} that are applied when
+---selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.
+---@field additionalTextEdits? lsp.TextEdit[]
+
+---@class lsp.WorkDoneProgressOptions
+---@field workDoneProgress? boolean
+
+---General text document registration options.
+---@class lsp.TextDocumentRegistrationOptions
+---A document selector to identify the scope of the registration. If set to null
+---the document selector provided on the client side will be used.
+---@field documentSelector lsp.DocumentSelector|lsp.null
+
+---Parameters for a {@link FoldingRangeRequest}.
+---@class lsp.FoldingRangeParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---Represents a folding range. To be valid, start and end line must be bigger than zero and smaller
+---than the number of lines in the document. Clients are free to ignore invalid ranges.
+---@class lsp.FoldingRange
+---The zero-based start line of the range to fold. The folded area starts after the line's last character.
+---To be valid, the end must be zero or larger and smaller than the number of lines in the document.
+---@field startLine uinteger
+---The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
+---@field startCharacter? uinteger
+---The zero-based end line of the range to fold. The folded area ends with the line's last character.
+---To be valid, the end must be zero or larger and smaller than the number of lines in the document.
+---@field endLine uinteger
+---The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
+---@field endCharacter? uinteger
+---Describes the kind of the folding range such as `comment' or 'region'. The kind
+---is used to categorize folding ranges and used by commands like 'Fold all comments'.
+---See {@link FoldingRangeKind} for an enumeration of standardized kinds.
+---@field kind? lsp.FoldingRangeKind
+---The text that the client should show when the specified range is
+---collapsed. If not defined or not supported by the client, a default
+---will be chosen by the client.
+---
+---@since 3.17.0
+---@field collapsedText? string
+
+---@class lsp.FoldingRangeRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---@class lsp.DeclarationParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---@class lsp.DeclarationRegistrationOptions: lsp.DeclarationOptions, lsp.StaticRegistrationOptions
+
+---A parameter literal used in selection range requests.
+---@class lsp.SelectionRangeParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The positions inside the text document.
+---@field positions lsp.Position[]
+
+---A selection range represents a part of a selection hierarchy. A selection range
+---may have a parent selection range that contains it.
+---@class lsp.SelectionRange
+---The {@link Range range} of this selection range.
+---@field range lsp.Range
+---The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.
+---@field parent? lsp.SelectionRange
+
+---@class lsp.SelectionRangeRegistrationOptions: lsp.SelectionRangeOptions, lsp.StaticRegistrationOptions
+
+---@class lsp.WorkDoneProgressCreateParams
+---The token to be used to report progress.
+---@field token lsp.ProgressToken
+
+---@class lsp.WorkDoneProgressCancelParams
+---The token to be used to report progress.
+---@field token lsp.ProgressToken
+
+---The parameter of a `textDocument/prepareCallHierarchy` request.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyPrepareParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+
+---Represents programming constructs like functions or constructors in the context
+---of call hierarchy.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyItem
+---The name of this item.
+---@field name string
+---The kind of this item.
+---@field kind lsp.SymbolKind
+---Tags for this item.
+---@field tags? lsp.SymbolTag[]
+---More detail for this item, e.g. the signature of a function.
+---@field detail? string
+---The resource identifier of this item.
+---@field uri lsp.DocumentUri
+---The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
+---@field range lsp.Range
+---The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function.
+---Must be contained by the {@link CallHierarchyItem.range `range`}.
+---@field selectionRange lsp.Range
+---A data entry field that is preserved between a call hierarchy prepare and
+---incoming calls or outgoing calls requests.
+---@field data? lsp.LSPAny
+
+---Call hierarchy options used during static or dynamic registration.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---The parameter of a `callHierarchy/incomingCalls` request.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyIncomingCallsParams
+---@field item lsp.CallHierarchyItem
+
+---Represents an incoming call, e.g. a caller of a method or constructor.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyIncomingCall
+---The item that makes the call.
+---@field from lsp.CallHierarchyItem
+---The ranges at which the calls appear. This is relative to the caller
+---denoted by {@link CallHierarchyIncomingCall.from `this.from`}.
+---@field fromRanges lsp.Range[]
+
+---The parameter of a `callHierarchy/outgoingCalls` request.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyOutgoingCallsParams
+---@field item lsp.CallHierarchyItem
+
+---Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyOutgoingCall
+---The item that is called.
+---@field to lsp.CallHierarchyItem
+---The range at which this item is called. This is the range relative to the caller, e.g the item
+---passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`}
+---and not {@link CallHierarchyOutgoingCall.to `this.to`}.
+---@field fromRanges lsp.Range[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---@since 3.16.0
+---@class lsp.SemanticTokens
+---An optional result id. If provided and clients support delta updating
+---the client will include the result id in the next semantic token request.
+---A server can then instead of computing all semantic tokens again simply
+---send a delta.
+---@field resultId? string
+---The actual tokens.
+---@field data uinteger[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensPartialResult
+---@field data uinteger[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---@since 3.16.0
+---@class lsp.SemanticTokensDeltaParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The result id of a previous response. The result Id can either point to a full response
+---or a delta response depending on what was received last.
+---@field previousResultId string
+
+---@since 3.16.0
+---@class lsp.SemanticTokensDelta
+---@field resultId? string
+---The semantic token edits to transform a previous result into a new result.
+---@field edits lsp.SemanticTokensEdit[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensDeltaPartialResult
+---@field edits lsp.SemanticTokensEdit[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensRangeParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The range the semantic tokens are requested for.
+---@field range lsp.Range
+
+---Params to show a resource in the UI.
+---
+---@since 3.16.0
+---@class lsp.ShowDocumentParams
+---The uri to show.
+---@field uri lsp.URI
+---Indicates to show the resource in an external program.
+---To show, for example, `https://code.visualstudio.com/`
+---in the default WEB browser set `external` to `true`.
+---@field external? boolean
+---An optional property to indicate whether the editor
+---showing the document should take focus or not.
+---Clients might ignore this property if an external
+---program is started.
+---@field takeFocus? boolean
+---An optional selection range if the document is a text
+---document. Clients might ignore the property if an
+---external program is started or the file is not a text
+---file.
+---@field selection? lsp.Range
+
+---The result of a showDocument request.
+---
+---@since 3.16.0
+---@class lsp.ShowDocumentResult
+---A boolean indicating if the show was successful.
+---@field success boolean
+
+---@class lsp.LinkedEditingRangeParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+
+---The result of a linked editing range request.
+---
+---@since 3.16.0
+---@class lsp.LinkedEditingRanges
+---A list of ranges that can be edited together. The ranges must have
+---identical length and contain identical text content. The ranges cannot overlap.
+---@field ranges lsp.Range[]
+---An optional word pattern (regular expression) that describes valid contents for
+---the given ranges. If no pattern is provided, the client configuration's word
+---pattern will be used.
+---@field wordPattern? string
+
+---@class lsp.LinkedEditingRangeRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---The parameters sent in notifications/requests for user-initiated creation of
+---files.
+---
+---@since 3.16.0
+---@class lsp.CreateFilesParams
+---An array of all files/folders created in this operation.
+---@field files lsp.FileCreate[]
+
+---A workspace edit represents changes to many resources managed in the workspace. The edit
+---should either provide `changes` or `documentChanges`. If documentChanges are present
+---they are preferred over `changes` if the client can handle versioned document edits.
+---
+---Since version 3.13.0 a workspace edit can contain resource operations as well. If resource
+---operations are present clients need to execute the operations in the order in which they
+---are provided. So a workspace edit for example can consist of the following two changes:
+---(1) a create file a.txt and (2) a text document edit which insert text into file a.txt.
+---
+---An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will
+---cause failure of the operation. How the client recovers from the failure is described by
+---the client capability: `workspace.workspaceEdit.failureHandling`
+---@class lsp.WorkspaceEdit
+---Holds changes to existing resources.
+---@field changes? table<lsp.DocumentUri, lsp.TextEdit[]>
+---Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes
+---are either an array of `TextDocumentEdit`s to express changes to n different text documents
+---where each text document edit addresses a specific version of a text document. Or it can contain
+---above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations.
+---
+---Whether a client supports versioned document edits is expressed via
+---`workspace.workspaceEdit.documentChanges` client capability.
+---
+---If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then
+---only plain `TextEdit`s using the `changes` property are supported.
+---@field documentChanges? lsp.TextDocumentEdit|lsp.CreateFile|lsp.RenameFile|lsp.DeleteFile[]
+---A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and
+---delete file / folder operations.
+---
+---Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`.
+---
+---@since 3.16.0
+---@field changeAnnotations? table<lsp.ChangeAnnotationIdentifier, lsp.ChangeAnnotation>
+
+---The options to register for file operations.
+---
+---@since 3.16.0
+---@class lsp.FileOperationRegistrationOptions
+---The actual filters.
+---@field filters lsp.FileOperationFilter[]
+
+---The parameters sent in notifications/requests for user-initiated renames of
+---files.
+---
+---@since 3.16.0
+---@class lsp.RenameFilesParams
+---An array of all files/folders renamed in this operation. When a folder is renamed, only
+---the folder will be included, and not its children.
+---@field files lsp.FileRename[]
+
+---The parameters sent in notifications/requests for user-initiated deletes of
+---files.
+---
+---@since 3.16.0
+---@class lsp.DeleteFilesParams
+---An array of all files/folders deleted in this operation.
+---@field files lsp.FileDelete[]
+
+---@class lsp.MonikerParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---Moniker definition to match LSIF 0.5 moniker definition.
+---
+---@since 3.16.0
+---@class lsp.Moniker
+---The scheme of the moniker. For example tsc or .Net
+---@field scheme string
+---The identifier of the moniker. The value is opaque in LSIF however
+---schema owners are allowed to define the structure if they want.
+---@field identifier string
+---The scope in which the moniker is unique
+---@field unique lsp.UniquenessLevel
+---The moniker kind if known.
+---@field kind? lsp.MonikerKind
+
+---@class lsp.MonikerRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameter of a `textDocument/prepareTypeHierarchy` request.
+---
+---@since 3.17.0
+---@class lsp.TypeHierarchyPrepareParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+
+---@since 3.17.0
+---@class lsp.TypeHierarchyItem
+---The name of this item.
+---@field name string
+---The kind of this item.
+---@field kind lsp.SymbolKind
+---Tags for this item.
+---@field tags? lsp.SymbolTag[]
+---More detail for this item, e.g. the signature of a function.
+---@field detail? string
+---The resource identifier of this item.
+---@field uri lsp.DocumentUri
+---The range enclosing this symbol not including leading/trailing whitespace
+---but everything else, e.g. comments and code.
+---@field range lsp.Range
+---The range that should be selected and revealed when this symbol is being
+---picked, e.g. the name of a function. Must be contained by the
+---{@link TypeHierarchyItem.range `range`}.
+---@field selectionRange lsp.Range
+---A data entry field that is preserved between a type hierarchy prepare and
+---supertypes or subtypes requests. It could also be used to identify the
+---type hierarchy in the server, helping improve the performance on
+---resolving supertypes and subtypes.
+---@field data? lsp.LSPAny
+
+---Type hierarchy options used during static or dynamic registration.
+---
+---@since 3.17.0
+---@class lsp.TypeHierarchyRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---The parameter of a `typeHierarchy/supertypes` request.
+---
+---@since 3.17.0
+---@class lsp.TypeHierarchySupertypesParams
+---@field item lsp.TypeHierarchyItem
+
+---The parameter of a `typeHierarchy/subtypes` request.
+---
+---@since 3.17.0
+---@class lsp.TypeHierarchySubtypesParams
+---@field item lsp.TypeHierarchyItem
+
+---A parameter literal used in inline value requests.
+---
+---@since 3.17.0
+---@class lsp.InlineValueParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The document range for which inline values should be computed.
+---@field range lsp.Range
+---Additional information about the context in which inline values were
+---requested.
+---@field context lsp.InlineValueContext
+
+---Inline value options used during static or dynamic registration.
+---
+---@since 3.17.0
+---@class lsp.InlineValueRegistrationOptions: lsp.InlineValueOptions, lsp.StaticRegistrationOptions
+
+---A parameter literal used in inlay hint requests.
+---
+---@since 3.17.0
+---@class lsp.InlayHintParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The document range for which inlay hints should be computed.
+---@field range lsp.Range
+
+---Inlay hint information.
+---
+---@since 3.17.0
+---@class lsp.InlayHint
+---The position of this hint.
+---@field position lsp.Position
+---The label of this hint. A human readable string or an array of
+---InlayHintLabelPart label parts.
+---
+---*Note* that neither the string nor the label part can be empty.
+---@field label string|lsp.InlayHintLabelPart[]
+---The kind of this hint. Can be omitted in which case the client
+---should fall back to a reasonable default.
+---@field kind? lsp.InlayHintKind
+---Optional text edits that are performed when accepting this inlay hint.
+---
+---*Note* that edits are expected to change the document so that the inlay
+---hint (or its nearest variant) is now part of the document and the inlay
+---hint itself is now obsolete.
+---@field textEdits? lsp.TextEdit[]
+---The tooltip text when you hover over this item.
+---@field tooltip? string|lsp.MarkupContent
+---Render padding before the hint.
+---
+---Note: Padding should use the editor's background color, not the
+---background color of the hint itself. That means padding can be used
+---to visually align/separate an inlay hint.
+---@field paddingLeft? boolean
+---Render padding after the hint.
+---
+---Note: Padding should use the editor's background color, not the
+---background color of the hint itself. That means padding can be used
+---to visually align/separate an inlay hint.
+---@field paddingRight? boolean
+---A data entry field that is preserved on an inlay hint between
+---a `textDocument/inlayHint` and a `inlayHint/resolve` request.
+---@field data? lsp.LSPAny
+
+---Inlay hint options used during static or dynamic registration.
+---
+---@since 3.17.0
+---@class lsp.InlayHintRegistrationOptions: lsp.InlayHintOptions, lsp.StaticRegistrationOptions
+
+---Parameters of the document diagnostic request.
+---
+---@since 3.17.0
+---@class lsp.DocumentDiagnosticParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The additional identifier  provided during registration.
+---@field identifier? string
+---The result id of a previous response if provided.
+---@field previousResultId? string
+
+---A partial result for a document diagnostic report.
+---
+---@since 3.17.0
+---@class lsp.DocumentDiagnosticReportPartialResult
+---@field relatedDocuments table<lsp.DocumentUri, lsp.FullDocumentDiagnosticReport|lsp.UnchangedDocumentDiagnosticReport>
+
+---Cancellation data returned from a diagnostic request.
+---
+---@since 3.17.0
+---@class lsp.DiagnosticServerCancellationData
+---@field retriggerRequest boolean
+
+---Diagnostic registration options.
+---
+---@since 3.17.0
+---@class lsp.DiagnosticRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
+
+---Parameters of the workspace diagnostic request.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceDiagnosticParams
+---The additional identifier provided during registration.
+---@field identifier? string
+---The currently known diagnostic reports with their
+---previous result ids.
+---@field previousResultIds lsp.PreviousResultId[]
+
+---A workspace diagnostic report.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceDiagnosticReport
+---@field items lsp.WorkspaceDocumentDiagnosticReport[]
+
+---A partial result for a workspace diagnostic report.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceDiagnosticReportPartialResult
+---@field items lsp.WorkspaceDocumentDiagnosticReport[]
+
+---The params sent in an open notebook document notification.
+---
+---@since 3.17.0
+---@class lsp.DidOpenNotebookDocumentParams
+---The notebook document that got opened.
+---@field notebookDocument lsp.NotebookDocument
+---The text documents that represent the content
+---of a notebook cell.
+---@field cellTextDocuments lsp.TextDocumentItem[]
+
+---The params sent in a change notebook document notification.
+---
+---@since 3.17.0
+---@class lsp.DidChangeNotebookDocumentParams
+---The notebook document that did change. The version number points
+---to the version after all provided changes have been applied. If
+---only the text document content of a cell changes the notebook version
+---doesn't necessarily have to change.
+---@field notebookDocument lsp.VersionedNotebookDocumentIdentifier
+---The actual changes to the notebook document.
+---
+---The changes describe single state changes to the notebook document.
+---So if there are two changes c1 (at array index 0) and c2 (at array
+---index 1) for a notebook in state S then c1 moves the notebook from
+---S to S' and c2 from S' to S''. So c1 is computed on the state S and
+---c2 is computed on the state S'.
+---
+---To mirror the content of a notebook using change events use the following approach:
+---- start with the same initial content
+---- apply the 'notebookDocument/didChange' notifications in the order you receive them.
+---- apply the `NotebookChangeEvent`s in a single notification in the order
+---  you receive them.
+---@field change lsp.NotebookDocumentChangeEvent
+
+---The params sent in a save notebook document notification.
+---
+---@since 3.17.0
+---@class lsp.DidSaveNotebookDocumentParams
+---The notebook document that got saved.
+---@field notebookDocument lsp.NotebookDocumentIdentifier
+
+---The params sent in a close notebook document notification.
+---
+---@since 3.17.0
+---@class lsp.DidCloseNotebookDocumentParams
+---The notebook document that got closed.
+---@field notebookDocument lsp.NotebookDocumentIdentifier
+---The text documents that represent the content
+---of a notebook cell that got closed.
+---@field cellTextDocuments lsp.TextDocumentIdentifier[]
+
+---A parameter literal used in inline completion requests.
+---
+---@since 3.18.0
+---@class lsp.InlineCompletionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+---Additional information about the context in which inline completions were
+---requested.
+---@field context lsp.InlineCompletionContext
+
+---Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.
+---@class lsp.InlineCompletionList
+---The inline completion items
+---@field items lsp.InlineCompletionItem[]
+
+---An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
+---
+---@since 3.18.0
+---@class lsp.InlineCompletionItem
+---The text to replace the range with. Must be set.
+---@field insertText string
+---The format of the insert text. The format applies to the `insertText`. If omitted defaults to `InsertTextFormat.PlainText`.
+---@field insertTextFormat? lsp.InsertTextFormat
+---A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used.
+---@field filterText? string
+---The range to replace. Must begin and end on the same line.
+---@field range? lsp.Range
+---An optional {@link Command} that is executed *after* inserting this completion.
+---@field command? lsp.Command
+
+---Inline completion options used during static or dynamic registration.
+---
+---@since 3.18.0
+---@class lsp.InlineCompletionRegistrationOptions: lsp.InlineCompletionOptions, lsp.StaticRegistrationOptions
+
+---@class lsp.RegistrationParams
+---@field registrations lsp.Registration[]
+
+---@class lsp.UnregistrationParams
+---@field unregisterations lsp.Unregistration[]
+
+---@class lsp.InitializeParams: lsp._InitializeParams
+
+---The result returned from an initialize request.
+---@class lsp.InitializeResult
+---The capabilities the language server provides.
+---@field capabilities lsp.ServerCapabilities
+---Information about the server.
+---
+---@since 3.15.0
+---@field serverInfo? anonym1
+
+---The data type of the ResponseError if the
+---initialize request fails.
+---@class lsp.InitializeError
+---Indicates whether the client execute the following retry logic:
+---(1) show the message provided by the ResponseError to the user
+---(2) user selects retry or cancel
+---(3) if user selected retry the initialize method is sent again.
+---@field retry boolean
+
+---@class lsp.InitializedParams
+
+---The parameters of a change configuration notification.
+---@class lsp.DidChangeConfigurationParams
+---The actual changed settings
+---@field settings lsp.LSPAny
+
+---@class lsp.DidChangeConfigurationRegistrationOptions
+---@field section? string|string[]
+
+---The parameters of a notification message.
+---@class lsp.ShowMessageParams
+---The message type. See {@link MessageType}
+---@field type lsp.MessageType
+---The actual message.
+---@field message string
+
+---@class lsp.ShowMessageRequestParams
+---The message type. See {@link MessageType}
+---@field type lsp.MessageType
+---The actual message.
+---@field message string
+---The message action items to present.
+---@field actions? lsp.MessageActionItem[]
+
+---@class lsp.MessageActionItem
+---A short title like 'Retry', 'Open Log' etc.
+---@field title string
+
+---The log message parameters.
+---@class lsp.LogMessageParams
+---The message type. See {@link MessageType}
+---@field type lsp.MessageType
+---The actual message.
+---@field message string
+
+---The parameters sent in an open text document notification
+---@class lsp.DidOpenTextDocumentParams
+---The document that was opened.
+---@field textDocument lsp.TextDocumentItem
+
+---The change text document notification's parameters.
+---@class lsp.DidChangeTextDocumentParams
+---The document that did change. The version number points
+---to the version after all provided content changes have
+---been applied.
+---@field textDocument lsp.VersionedTextDocumentIdentifier
+---The actual content changes. The content changes describe single state changes
+---to the document. So if there are two content changes c1 (at array index 0) and
+---c2 (at array index 1) for a document in state S then c1 moves the document from
+---S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed
+---on the state S'.
+---
+---To mirror the content of a document using change events use the following approach:
+---- start with the same initial content
+---- apply the 'textDocument/didChange' notifications in the order you receive them.
+---- apply the `TextDocumentContentChangeEvent`s in a single notification in the order
+---  you receive them.
+---@field contentChanges lsp.TextDocumentContentChangeEvent[]
+
+---Describe options to be used when registered for text document change events.
+---@class lsp.TextDocumentChangeRegistrationOptions: lsp.TextDocumentRegistrationOptions
+---How documents are synced to the server.
+---@field syncKind lsp.TextDocumentSyncKind
+
+---The parameters sent in a close text document notification
+---@class lsp.DidCloseTextDocumentParams
+---The document that was closed.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---The parameters sent in a save text document notification
+---@class lsp.DidSaveTextDocumentParams
+---The document that was saved.
+---@field textDocument lsp.TextDocumentIdentifier
+---Optional the content when saved. Depends on the includeText value
+---when the save notification was requested.
+---@field text? string
+
+---Save registration options.
+---@class lsp.TextDocumentSaveRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters sent in a will save text document notification.
+---@class lsp.WillSaveTextDocumentParams
+---The document that will be saved.
+---@field textDocument lsp.TextDocumentIdentifier
+---The 'TextDocumentSaveReason'.
+---@field reason lsp.TextDocumentSaveReason
+
+---A text edit applicable to a text document.
+---@class lsp.TextEdit
+---The range of the text document to be manipulated. To insert
+---text into a document create a range where start === end.
+---@field range lsp.Range
+---The string to be inserted. For delete operations use an
+---empty string.
+---@field newText string
+
+---The watched files change notification's parameters.
+---@class lsp.DidChangeWatchedFilesParams
+---The actual file events.
+---@field changes lsp.FileEvent[]
+
+---Describe options to be used when registered for text document change events.
+---@class lsp.DidChangeWatchedFilesRegistrationOptions
+---The watchers to register.
+---@field watchers lsp.FileSystemWatcher[]
+
+---The publish diagnostic notification's parameters.
+---@class lsp.PublishDiagnosticsParams
+---The URI for which diagnostic information is reported.
+---@field uri lsp.DocumentUri
+---Optional the version number of the document the diagnostics are published for.
+---
+---@since 3.15.0
+---@field version? integer
+---An array of diagnostic information items.
+---@field diagnostics lsp.Diagnostic[]
+
+---Completion parameters
+---@class lsp.CompletionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---The completion context. This is only available it the client specifies
+---to send this using the client capability `textDocument.completion.contextSupport === true`
+---@field context? lsp.CompletionContext
+
+---A completion item represents a text snippet that is
+---proposed to complete text that is being typed.
+---@class lsp.CompletionItem
+---The label of this completion item.
+---
+---The label property is also by default the text that
+---is inserted when selecting this completion.
+---
+---If label details are provided the label itself should
+---be an unqualified name of the completion item.
+---@field label string
+---Additional details for the label
+---
+---@since 3.17.0
+---@field labelDetails? lsp.CompletionItemLabelDetails
+---The kind of this completion item. Based of the kind
+---an icon is chosen by the editor.
+---@field kind? lsp.CompletionItemKind
+---Tags for this completion item.
+---
+---@since 3.15.0
+---@field tags? lsp.CompletionItemTag[]
+---A human-readable string with additional information
+---about this item, like type or symbol information.
+---@field detail? string
+---A human-readable string that represents a doc-comment.
+---@field documentation? string|lsp.MarkupContent
+---Indicates if this item is deprecated.
+---@deprecated Use `tags` instead.
+---@field deprecated? boolean
+---Select this item when showing.
+---
+---*Note* that only one completion item can be selected and that the
+---tool / client decides which item that is. The rule is that the *first*
+---item of those that match best is selected.
+---@field preselect? boolean
+---A string that should be used when comparing this item
+---with other items. When `falsy` the {@link CompletionItem.label label}
+---is used.
+---@field sortText? string
+---A string that should be used when filtering a set of
+---completion items. When `falsy` the {@link CompletionItem.label label}
+---is used.
+---@field filterText? string
+---A string that should be inserted into a document when selecting
+---this completion. When `falsy` the {@link CompletionItem.label label}
+---is used.
+---
+---The `insertText` is subject to interpretation by the client side.
+---Some tools might not take the string literally. For example
+---VS Code when code complete is requested in this example
+---`con<cursor position>` and a completion item with an `insertText` of
+---`console` is provided it will only insert `sole`. Therefore it is
+---recommended to use `textEdit` instead since it avoids additional client
+---side interpretation.
+---@field insertText? string
+---The format of the insert text. The format applies to both the
+---`insertText` property and the `newText` property of a provided
+---`textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.
+---
+---Please note that the insertTextFormat doesn't apply to
+---`additionalTextEdits`.
+---@field insertTextFormat? lsp.InsertTextFormat
+---How whitespace and indentation is handled during completion
+---item insertion. If not provided the clients default value depends on
+---the `textDocument.completion.insertTextMode` client capability.
+---
+---@since 3.16.0
+---@field insertTextMode? lsp.InsertTextMode
+---An {@link TextEdit edit} which is applied to a document when selecting
+---this completion. When an edit is provided the value of
+---{@link CompletionItem.insertText insertText} is ignored.
+---
+---Most editors support two different operations when accepting a completion
+---item. One is to insert a completion text and the other is to replace an
+---existing text with a completion text. Since this can usually not be
+---predetermined by a server it can report both ranges. Clients need to
+---signal support for `InsertReplaceEdits` via the
+---`textDocument.completion.insertReplaceSupport` client capability
+---property.
+---
+---*Note 1:* The text edit's range as well as both ranges from an insert
+---replace edit must be a [single line] and they must contain the position
+---at which completion has been requested.
+---*Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range
+---must be a prefix of the edit's replace range, that means it must be
+---contained and starting at the same position.
+---
+---@since 3.16.0 additional type `InsertReplaceEdit`
+---@field textEdit? lsp.TextEdit|lsp.InsertReplaceEdit
+---The edit text used if the completion item is part of a CompletionList and
+---CompletionList defines an item default for the text edit range.
+---
+---Clients will only honor this property if they opt into completion list
+---item defaults using the capability `completionList.itemDefaults`.
+---
+---If not provided and a list's default range is provided the label
+---property is used as a text.
+---
+---@since 3.17.0
+---@field textEditText? string
+---An optional array of additional {@link TextEdit text edits} that are applied when
+---selecting this completion. Edits must not overlap (including the same insert position)
+---with the main {@link CompletionItem.textEdit edit} nor with themselves.
+---
+---Additional text edits should be used to change text unrelated to the current cursor position
+---(for example adding an import statement at the top of the file if the completion item will
+---insert an unqualified type).
+---@field additionalTextEdits? lsp.TextEdit[]
+---An optional set of characters that when pressed while this completion is active will accept it first and
+---then type that character. *Note* that all commit characters should have `length=1` and that superfluous
+---characters will be ignored.
+---@field commitCharacters? string[]
+---An optional {@link Command command} that is executed *after* inserting this completion. *Note* that
+---additional modifications to the current document should be described with the
+---{@link CompletionItem.additionalTextEdits additionalTextEdits}-property.
+---@field command? lsp.Command
+---A data entry field that is preserved on a completion item between a
+---{@link CompletionRequest} and a {@link CompletionResolveRequest}.
+---@field data? lsp.LSPAny
+
+---Represents a collection of {@link CompletionItem completion items} to be presented
+---in the editor.
+---@class lsp.CompletionList
+---This list it not complete. Further typing results in recomputing this list.
+---
+---Recomputed lists have all their items replaced (not appended) in the
+---incomplete completion sessions.
+---@field isIncomplete boolean
+---In many cases the items of an actual completion result share the same
+---value for properties like `commitCharacters` or the range of a text
+---edit. A completion list can therefore define item defaults which will
+---be used if a completion item itself doesn't specify the value.
+---
+---If a completion list specifies a default value and a completion item
+---also specifies a corresponding value the one from the item is used.
+---
+---Servers are only allowed to return default values if the client
+---signals support for this via the `completionList.itemDefaults`
+---capability.
+---
+---@since 3.17.0
+---@field itemDefaults? anonym3
+---The completion items.
+---@field items lsp.CompletionItem[]
+
+---Registration options for a {@link CompletionRequest}.
+---@class lsp.CompletionRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link HoverRequest}.
+---@class lsp.HoverParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+
+---The result of a hover request.
+---@class lsp.Hover
+---The hover's content
+---@field contents lsp.MarkupContent|lsp.MarkedString|lsp.MarkedString[]
+---An optional range inside the text document that is used to
+---visualize the hover, e.g. by changing the background color.
+---@field range? lsp.Range
+
+---Registration options for a {@link HoverRequest}.
+---@class lsp.HoverRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link SignatureHelpRequest}.
+---@class lsp.SignatureHelpParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+---The signature help context. This is only available if the client specifies
+---to send this using the client capability `textDocument.signatureHelp.contextSupport === true`
+---
+---@since 3.15.0
+---@field context? lsp.SignatureHelpContext
+
+---Signature help represents the signature of something
+---callable. There can be multiple signature but only one
+---active and only one active parameter.
+---@class lsp.SignatureHelp
+---One or more signatures.
+---@field signatures lsp.SignatureInformation[]
+---The active signature. If omitted or the value lies outside the
+---range of `signatures` the value defaults to zero or is ignored if
+---the `SignatureHelp` has no signatures.
+---
+---Whenever possible implementors should make an active decision about
+---the active signature and shouldn't rely on a default value.
+---
+---In future version of the protocol this property might become
+---mandatory to better express this.
+---@field activeSignature? uinteger
+---The active parameter of the active signature. If omitted or the value
+---lies outside the range of `signatures[activeSignature].parameters`
+---defaults to 0 if the active signature has parameters. If
+---the active signature has no parameters it is ignored.
+---In future version of the protocol this property might become
+---mandatory to better express the active parameter if the
+---active signature does have any.
+---@field activeParameter? uinteger
+
+---Registration options for a {@link SignatureHelpRequest}.
+---@class lsp.SignatureHelpRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link DefinitionRequest}.
+---@class lsp.DefinitionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---Registration options for a {@link DefinitionRequest}.
+---@class lsp.DefinitionRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link ReferencesRequest}.
+---@class lsp.ReferenceParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+---@field context lsp.ReferenceContext
+
+---Registration options for a {@link ReferencesRequest}.
+---@class lsp.ReferenceRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link DocumentHighlightRequest}.
+---@class lsp.DocumentHighlightParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
+
+---A document highlight is a range inside a text document which deserves
+---special attention. Usually a document highlight is visualized by changing
+---the background color of its range.
+---@class lsp.DocumentHighlight
+---The range this highlight applies to.
+---@field range lsp.Range
+---The highlight kind, default is {@link DocumentHighlightKind.Text text}.
+---@field kind? lsp.DocumentHighlightKind
+
+---Registration options for a {@link DocumentHighlightRequest}.
+---@class lsp.DocumentHighlightRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---Parameters for a {@link DocumentSymbolRequest}.
+---@class lsp.DocumentSymbolParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---Represents information about programming constructs like variables, classes,
+---interfaces etc.
+---@class lsp.SymbolInformation: lsp.BaseSymbolInformation
+---Indicates if this symbol is deprecated.
+---
+---@deprecated Use tags instead
+---@field deprecated? boolean
+---The location of this symbol. The location's range is used by a tool
+---to reveal the location in the editor. If the symbol is selected in the
+---tool the range's start information is used to position the cursor. So
+---the range usually spans more than the actual symbol's name and does
+---normally include things like visibility modifiers.
+---
+---The range doesn't have to denote a node range in the sense of an abstract
+---syntax tree. It can therefore not be used to re-construct a hierarchy of
+---the symbols.
+---@field location lsp.Location
+
+---Represents programming constructs like variables, classes, interfaces etc.
+---that appear in a document. Document symbols can be hierarchical and they
+---have two ranges: one that encloses its definition and one that points to
+---its most interesting range, e.g. the range of an identifier.
+---@class lsp.DocumentSymbol
+---The name of this symbol. Will be displayed in the user interface and therefore must not be
+---an empty string or a string only consisting of white spaces.
+---@field name string
+---More detail for this symbol, e.g the signature of a function.
+---@field detail? string
+---The kind of this symbol.
+---@field kind lsp.SymbolKind
+---Tags for this document symbol.
+---
+---@since 3.16.0
+---@field tags? lsp.SymbolTag[]
+---Indicates if this symbol is deprecated.
+---
+---@deprecated Use tags instead
+---@field deprecated? boolean
+---The range enclosing this symbol not including leading/trailing whitespace but everything else
+---like comments. This information is typically used to determine if the clients cursor is
+---inside the symbol to reveal in the symbol in the UI.
+---@field range lsp.Range
+---The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
+---Must be contained by the `range`.
+---@field selectionRange lsp.Range
+---Children of this symbol, e.g. properties of a class.
+---@field children? lsp.DocumentSymbol[]
+
+---Registration options for a {@link DocumentSymbolRequest}.
+---@class lsp.DocumentSymbolRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link CodeActionRequest}.
+---@class lsp.CodeActionParams
+---The document in which the command was invoked.
+---@field textDocument lsp.TextDocumentIdentifier
+---The range for which the command was invoked.
+---@field range lsp.Range
+---Context carrying additional information.
+---@field context lsp.CodeActionContext
+
+---Represents a reference to a command. Provides a title which
+---will be used to represent a command in the UI and, optionally,
+---an array of arguments which will be passed to the command handler
+---function when invoked.
+---@class lsp.Command
+---Title of the command, like `save`.
+---@field title string
+---The identifier of the actual command handler.
+---@field command string
+---Arguments that the command handler should be
+---invoked with.
+---@field arguments? lsp.LSPAny[]
+
+---A code action represents a change that can be performed in code, e.g. to fix a problem or
+---to refactor code.
+---
+---A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
+---@class lsp.CodeAction
+---A short, human-readable, title for this code action.
+---@field title string
+---The kind of the code action.
+---
+---Used to filter code actions.
+---@field kind? lsp.CodeActionKind
+---The diagnostics that this code action resolves.
+---@field diagnostics? lsp.Diagnostic[]
+---Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted
+---by keybindings.
+---
+---A quick fix should be marked preferred if it properly addresses the underlying error.
+---A refactoring should be marked preferred if it is the most reasonable choice of actions to take.
+---
+---@since 3.15.0
+---@field isPreferred? boolean
+---Marks that the code action cannot currently be applied.
+---
+---Clients should follow the following guidelines regarding disabled code actions:
+---
+---  - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action)
+---    code action menus.
+---
+---  - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type
+---    of code action, such as refactorings.
+---
+---  - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions)
+---    that auto applies a code action and only disabled code actions are returned, the client should show the user an
+---    error message with `reason` in the editor.
+---
+---@since 3.16.0
+---@field disabled? anonym4
+---The workspace edit this code action performs.
+---@field edit? lsp.WorkspaceEdit
+---A command this code action executes. If a code action
+---provides an edit and a command, first the edit is
+---executed and then the command.
+---@field command? lsp.Command
+---A data entry field that is preserved on a code action between
+---a `textDocument/codeAction` and a `codeAction/resolve` request.
+---
+---@since 3.16.0
+---@field data? lsp.LSPAny
+
+---Registration options for a {@link CodeActionRequest}.
+---@class lsp.CodeActionRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link WorkspaceSymbolRequest}.
+---@class lsp.WorkspaceSymbolParams
+---A query string to filter symbols by. Clients may send an empty
+---string here to request all symbols.
+---@field query string
+
+---A special workspace symbol that supports locations without a range.
+---
+---See also SymbolInformation.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceSymbol: lsp.BaseSymbolInformation
+---The location of the symbol. Whether a server is allowed to
+---return a location without a range depends on the client
+---capability `workspace.symbol.resolveSupport`.
+---
+---See SymbolInformation#location for more details.
+---@field location lsp.Location|anonym5
+---A data entry field that is preserved on a workspace symbol between a
+---workspace symbol request and a workspace symbol resolve request.
+---@field data? lsp.LSPAny
+
+---Registration options for a {@link WorkspaceSymbolRequest}.
+---@class lsp.WorkspaceSymbolRegistrationOptions: lsp.WorkspaceSymbolOptions
+
+---The parameters of a {@link CodeLensRequest}.
+---@class lsp.CodeLensParams
+---The document to request code lens for.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---A code lens represents a {@link Command command} that should be shown along with
+---source text, like the number of references, a way to run tests, etc.
+---
+---A code lens is _unresolved_ when no command is associated to it. For performance
+---reasons the creation of a code lens and resolving should be done in two stages.
+---@class lsp.CodeLens
+---The range in which this code lens is valid. Should only span a single line.
+---@field range lsp.Range
+---The command this code lens represents.
+---@field command? lsp.Command
+---A data entry field that is preserved on a code lens item between
+---a {@link CodeLensRequest} and a [CodeLensResolveRequest]
+---(#CodeLensResolveRequest)
+---@field data? lsp.LSPAny
+
+---Registration options for a {@link CodeLensRequest}.
+---@class lsp.CodeLensRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link DocumentLinkRequest}.
+---@class lsp.DocumentLinkParams
+---The document to provide document links for.
+---@field textDocument lsp.TextDocumentIdentifier
+
+---A document link is a range in a text document that links to an internal or external resource, like another
+---text document or a web site.
+---@class lsp.DocumentLink
+---The range this link applies to.
+---@field range lsp.Range
+---The uri this link points to. If missing a resolve request is sent later.
+---@field target? lsp.URI
+---The tooltip text when you hover over this link.
+---
+---If a tooltip is provided, is will be displayed in a string that includes instructions on how to
+---trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,
+---user settings, and localization.
+---
+---@since 3.15.0
+---@field tooltip? string
+---A data entry field that is preserved on a document link between a
+---DocumentLinkRequest and a DocumentLinkResolveRequest.
+---@field data? lsp.LSPAny
+
+---Registration options for a {@link DocumentLinkRequest}.
+---@class lsp.DocumentLinkRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link DocumentFormattingRequest}.
+---@class lsp.DocumentFormattingParams
+---The document to format.
+---@field textDocument lsp.TextDocumentIdentifier
+---The format options.
+---@field options lsp.FormattingOptions
+
+---Registration options for a {@link DocumentFormattingRequest}.
+---@class lsp.DocumentFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link DocumentRangeFormattingRequest}.
+---@class lsp.DocumentRangeFormattingParams
+---The document to format.
+---@field textDocument lsp.TextDocumentIdentifier
+---The range to format
+---@field range lsp.Range
+---The format options
+---@field options lsp.FormattingOptions
+
+---Registration options for a {@link DocumentRangeFormattingRequest}.
+---@class lsp.DocumentRangeFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link DocumentRangesFormattingRequest}.
+---
+---@since 3.18.0
+---@proposed
+---@class lsp.DocumentRangesFormattingParams
+---The document to format.
+---@field textDocument lsp.TextDocumentIdentifier
+---The ranges to format
+---@field ranges lsp.Range[]
+---The format options
+---@field options lsp.FormattingOptions
+
+---The parameters of a {@link DocumentOnTypeFormattingRequest}.
+---@class lsp.DocumentOnTypeFormattingParams
+---The document to format.
+---@field textDocument lsp.TextDocumentIdentifier
+---The position around which the on type formatting should happen.
+---This is not necessarily the exact position where the character denoted
+---by the property `ch` got typed.
+---@field position lsp.Position
+---The character that has been typed that triggered the formatting
+---on type request. That is not necessarily the last character that
+---got inserted into the document since the client could auto insert
+---characters as well (e.g. like automatic brace completion).
+---@field ch string
+---The formatting options.
+---@field options lsp.FormattingOptions
+
+---Registration options for a {@link DocumentOnTypeFormattingRequest}.
+---@class lsp.DocumentOnTypeFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---The parameters of a {@link RenameRequest}.
+---@class lsp.RenameParams
+---The document to rename.
+---@field textDocument lsp.TextDocumentIdentifier
+---The position at which this request was sent.
+---@field position lsp.Position
+---The new name of the symbol. If the given name is not valid the
+---request must return a {@link ResponseError} with an
+---appropriate message set.
+---@field newName string
+
+---Registration options for a {@link RenameRequest}.
+---@class lsp.RenameRegistrationOptions: lsp.TextDocumentRegistrationOptions
+
+---@class lsp.PrepareRenameParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
+
+---The parameters of a {@link ExecuteCommandRequest}.
+---@class lsp.ExecuteCommandParams
+---The identifier of the actual command handler.
+---@field command string
+---Arguments that the command should be invoked with.
+---@field arguments? lsp.LSPAny[]
+
+---Registration options for a {@link ExecuteCommandRequest}.
+---@class lsp.ExecuteCommandRegistrationOptions: lsp.ExecuteCommandOptions
+
+---The parameters passed via an apply workspace edit request.
+---@class lsp.ApplyWorkspaceEditParams
+---An optional label of the workspace edit. This label is
+---presented in the user interface for example on an undo
+---stack to undo the workspace edit.
+---@field label? string
+---The edits to apply.
+---@field edit lsp.WorkspaceEdit
+
+---The result returned from the apply workspace edit request.
+---
+---@since 3.17 renamed from ApplyWorkspaceEditResponse
+---@class lsp.ApplyWorkspaceEditResult
+---Indicates whether the edit was applied or not.
+---@field applied boolean
+---An optional textual description for why the edit was not applied.
+---This may be used by the server for diagnostic logging or to provide
+---a suitable error for a request that triggered the edit.
+---@field failureReason? string
+---Depending on the client's failure handling strategy `failedChange` might
+---contain the index of the change that failed. This property is only available
+---if the client signals a `failureHandlingStrategy` in its client capabilities.
+---@field failedChange? uinteger
+
+---@class lsp.WorkDoneProgressBegin
+---@field kind "begin"
+---Mandatory title of the progress operation. Used to briefly inform about
+---the kind of operation being performed.
+---
+---Examples: "Indexing" or "Linking dependencies".
+---@field title string
+---Controls if a cancel button should show to allow the user to cancel the
+---long running operation. Clients that don't support cancellation are allowed
+---to ignore the setting.
+---@field cancellable? boolean
+---Optional, more detailed associated progress message. Contains
+---complementary information to the `title`.
+---
+---Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
+---If unset, the previous progress message (if any) is still valid.
+---@field message? string
+---Optional progress percentage to display (value 100 is considered 100%).
+---If not provided infinite progress is assumed and clients are allowed
+---to ignore the `percentage` value in subsequent in report notifications.
+---
+---The value should be steadily rising. Clients are free to ignore values
+---that are not following this rule. The value range is [0, 100].
+---@field percentage? uinteger
+
+---@class lsp.WorkDoneProgressReport
+---@field kind "report"
+---Controls enablement state of a cancel button.
+---
+---Clients that don't support cancellation or don't support controlling the button's
+---enablement state are allowed to ignore the property.
+---@field cancellable? boolean
+---Optional, more detailed associated progress message. Contains
+---complementary information to the `title`.
+---
+---Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
+---If unset, the previous progress message (if any) is still valid.
+---@field message? string
+---Optional progress percentage to display (value 100 is considered 100%).
+---If not provided infinite progress is assumed and clients are allowed
+---to ignore the `percentage` value in subsequent in report notifications.
+---
+---The value should be steadily rising. Clients are free to ignore values
+---that are not following this rule. The value range is [0, 100]
+---@field percentage? uinteger
+
+---@class lsp.WorkDoneProgressEnd
+---@field kind "end"
+---Optional, a final message indicating to for example indicate the outcome
+---of the operation.
+---@field message? string
+
+---@class lsp.SetTraceParams
+---@field value lsp.TraceValues
+
+---@class lsp.LogTraceParams
+---@field message string
+---@field verbose? string
+
+---@class lsp.CancelParams
+---The request id to cancel.
+---@field id integer|string
+
+---@class lsp.ProgressParams
+---The progress token provided by the client or server.
+---@field token lsp.ProgressToken
+---The progress data.
+---@field value lsp.LSPAny
+
+---A parameter literal used in requests to pass a text document and a position inside that
+---document.
+---@class lsp.TextDocumentPositionParams
+---The text document.
+---@field textDocument lsp.TextDocumentIdentifier
+---The position inside the text document.
+---@field position lsp.Position
+
+---@class lsp.WorkDoneProgressParams
+---An optional token that a server can use to report work done progress.
+---@field workDoneToken? lsp.ProgressToken
+
+---@class lsp.PartialResultParams
+---An optional token that a server can use to report partial results (e.g. streaming) to
+---the client.
+---@field partialResultToken? lsp.ProgressToken
+
+---Represents the connection of two locations. Provides additional metadata over normal {@link Location locations},
+---including an origin range.
+---@class lsp.LocationLink
+---Span of the origin of this link.
+---
+---Used as the underlined span for mouse interaction. Defaults to the word range at
+---the definition position.
+---@field originSelectionRange? lsp.Range
+---The target resource identifier of this link.
+---@field targetUri lsp.DocumentUri
+---The full target range of this link. If the target for example is a symbol then target range is the
+---range enclosing this symbol not including leading/trailing whitespace but everything else
+---like comments. This information is typically used to highlight the range in the editor.
+---@field targetRange lsp.Range
+---The range that should be selected and revealed when this link is being followed, e.g the name of a function.
+---Must be contained by the `targetRange`. See also `DocumentSymbol#range`
+---@field targetSelectionRange lsp.Range
+
+---A range in a text document expressed as (zero-based) start and end positions.
+---
+---If you want to specify a range that contains a line including the line ending
+---character(s) then use an end position denoting the start of the next line.
+---For example:
+---```ts
+---{
+---    start: { line: 5, character: 23 }
+---    end : { line 6, character : 0 }
+---}
+---```
+---@class lsp.Range
+---The range's start position.
+---@field start lsp.Position
+---The range's end position.
+---@field end lsp.Position
+
+---@class lsp.ImplementationOptions
+
+---Static registration options to be returned in the initialize
+---request.
+---@class lsp.StaticRegistrationOptions
+---The id used to register the request. The id can be used to deregister
+---the request again. See also Registration#id.
+---@field id? string
+
+---@class lsp.TypeDefinitionOptions
+
+---The workspace folder change event.
+---@class lsp.WorkspaceFoldersChangeEvent
+---The array of added workspace folders
+---@field added lsp.WorkspaceFolder[]
+---The array of the removed workspace folders
+---@field removed lsp.WorkspaceFolder[]
+
+---@class lsp.ConfigurationItem
+---The scope to get the configuration section for.
+---@field scopeUri? string
+---The configuration section asked for.
+---@field section? string
+
+---A literal to identify a text document in the client.
+---@class lsp.TextDocumentIdentifier
+---The text document's uri.
+---@field uri lsp.DocumentUri
+
+---Represents a color in RGBA space.
+---@class lsp.Color
+---The red component of this color in the range [0-1].
+---@field red decimal
+---The green component of this color in the range [0-1].
+---@field green decimal
+---The blue component of this color in the range [0-1].
+---@field blue decimal
+---The alpha component of this color in the range [0-1].
+---@field alpha decimal
+
+---@class lsp.DocumentColorOptions
+
+---@class lsp.FoldingRangeOptions
+
+---@class lsp.DeclarationOptions
+
+---Position in a text document expressed as zero-based line and character
+---offset. Prior to 3.17 the offsets were always based on a UTF-16 string
+---representation. So a string of the form `a𐐀b` the character offset of the
+---character `a` is 0, the character offset of `𐐀` is 1 and the character
+---offset of b is 3 since `𐐀` is represented using two code units in UTF-16.
+---Since 3.17 clients and servers can agree on a different string encoding
+---representation (e.g. UTF-8). The client announces it's supported encoding
+---via the client capability [`general.positionEncodings`](#clientCapabilities).
+---The value is an array of position encodings the client supports, with
+---decreasing preference (e.g. the encoding at index `0` is the most preferred
+---one). To stay backwards compatible the only mandatory encoding is UTF-16
+---represented via the string `utf-16`. The server can pick one of the
+---encodings offered by the client and signals that encoding back to the
+---client via the initialize result's property
+---[`capabilities.positionEncoding`](#serverCapabilities). If the string value
+---`utf-16` is missing from the client's capability `general.positionEncodings`
+---servers can safely assume that the client supports UTF-16. If the server
+---omits the position encoding in its initialize result the encoding defaults
+---to the string value `utf-16`. Implementation considerations: since the
+---conversion from one encoding into another requires the content of the
+---file / line the conversion is best done where the file is read which is
+---usually on the server side.
+---
+---Positions are line end character agnostic. So you can not specify a position
+---that denotes `\r|\n` or `\n|` where `|` represents the character offset.
+---
+---@since 3.17.0 - support for negotiated position encoding.
+---@class lsp.Position
+---Line position in a document (zero-based).
+---
+---If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document.
+---If a line number is negative, it defaults to 0.
+---@field line uinteger
+---Character offset on a line in a document (zero-based).
+---
+---The meaning of this offset is determined by the negotiated
+---`PositionEncodingKind`.
+---
+---If the character value is greater than the line length it defaults back to the
+---line length.
+---@field character uinteger
+
+---@class lsp.SelectionRangeOptions
+
+---Call hierarchy options used during static registration.
+---
+---@since 3.16.0
+---@class lsp.CallHierarchyOptions
+
+---@since 3.16.0
+---@class lsp.SemanticTokensOptions
+---The legend used by the server
+---@field legend lsp.SemanticTokensLegend
+---Server supports providing semantic tokens for a specific range
+---of a document.
+---@field range? boolean|anonym6
+---Server supports providing semantic tokens for a full document.
+---@field full? boolean|anonym7
+
+---@since 3.16.0
+---@class lsp.SemanticTokensEdit
+---The start offset of the edit.
+---@field start uinteger
+---The count of elements to remove.
+---@field deleteCount uinteger
+---The elements to insert.
+---@field data? uinteger[]
+
+---@class lsp.LinkedEditingRangeOptions
+
+---Represents information on a file/folder create.
+---
+---@since 3.16.0
+---@class lsp.FileCreate
+---A file:// URI for the location of the file/folder being created.
+---@field uri string
+
+---Describes textual changes on a text document. A TextDocumentEdit describes all changes
+---on a document version Si and after they are applied move the document to version Si+1.
+---So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any
+---kind of ordering. However the edits must be non overlapping.
+---@class lsp.TextDocumentEdit
+---The text document to change.
+---@field textDocument lsp.OptionalVersionedTextDocumentIdentifier
+---The edits to be applied.
+---
+---@since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a
+---client capability.
+---@field edits lsp.TextEdit|lsp.AnnotatedTextEdit[]
+
+---Create file operation.
+---@class lsp.CreateFile: lsp.ResourceOperation
+---A create
+---@field kind "create"
+---The resource to create.
+---@field uri lsp.DocumentUri
+---Additional options
+---@field options? lsp.CreateFileOptions
+
+---Rename file operation
+---@class lsp.RenameFile: lsp.ResourceOperation
+---A rename
+---@field kind "rename"
+---The old (existing) location.
+---@field oldUri lsp.DocumentUri
+---The new location.
+---@field newUri lsp.DocumentUri
+---Rename options.
+---@field options? lsp.RenameFileOptions
+
+---Delete file operation
+---@class lsp.DeleteFile: lsp.ResourceOperation
+---A delete
+---@field kind "delete"
+---The file to delete.
+---@field uri lsp.DocumentUri
+---Delete options.
+---@field options? lsp.DeleteFileOptions
+
+---Additional information that describes document changes.
+---
+---@since 3.16.0
+---@class lsp.ChangeAnnotation
+---A human-readable string describing the actual change. The string
+---is rendered prominent in the user interface.
+---@field label string
+---A flag which indicates that user confirmation is needed
+---before applying the change.
+---@field needsConfirmation? boolean
+---A human-readable string which is rendered less prominent in
+---the user interface.
+---@field description? string
+
+---A filter to describe in which file operation requests or notifications
+---the server is interested in receiving.
+---
+---@since 3.16.0
+---@class lsp.FileOperationFilter
+---A Uri scheme like `file` or `untitled`.
+---@field scheme? string
+---The actual file operation pattern.
+---@field pattern lsp.FileOperationPattern
+
+---Represents information on a file/folder rename.
+---
+---@since 3.16.0
+---@class lsp.FileRename
+---A file:// URI for the original location of the file/folder being renamed.
+---@field oldUri string
+---A file:// URI for the new location of the file/folder being renamed.
+---@field newUri string
+
+---Represents information on a file/folder delete.
+---
+---@since 3.16.0
+---@class lsp.FileDelete
+---A file:// URI for the location of the file/folder being deleted.
+---@field uri string
+
+---@class lsp.MonikerOptions
+
+---Type hierarchy options used during static registration.
+---
+---@since 3.17.0
+---@class lsp.TypeHierarchyOptions
+
+---@since 3.17.0
+---@class lsp.InlineValueContext
+---The stack frame (as a DAP Id) where the execution has stopped.
+---@field frameId integer
+---The document range where execution has stopped.
+---Typically the end position of the range denotes the line where the inline values are shown.
+---@field stoppedLocation lsp.Range
+
+---Provide inline value as text.
+---
+---@since 3.17.0
+---@class lsp.InlineValueText
+---The document range for which the inline value applies.
+---@field range lsp.Range
+---The text of the inline value.
+---@field text string
+
+---Provide inline value through a variable lookup.
+---If only a range is specified, the variable name will be extracted from the underlying document.
+---An optional variable name can be used to override the extracted name.
+---
+---@since 3.17.0
+---@class lsp.InlineValueVariableLookup
+---The document range for which the inline value applies.
+---The range is used to extract the variable name from the underlying document.
+---@field range lsp.Range
+---If specified the name of the variable to look up.
+---@field variableName? string
+---How to perform the lookup.
+---@field caseSensitiveLookup boolean
+
+---Provide an inline value through an expression evaluation.
+---If only a range is specified, the expression will be extracted from the underlying document.
+---An optional expression can be used to override the extracted expression.
+---
+---@since 3.17.0
+---@class lsp.InlineValueEvaluatableExpression
+---The document range for which the inline value applies.
+---The range is used to extract the evaluatable expression from the underlying document.
+---@field range lsp.Range
+---If specified the expression overrides the extracted expression.
+---@field expression? string
+
+---Inline value options used during static registration.
+---
+---@since 3.17.0
+---@class lsp.InlineValueOptions
+
+---An inlay hint label part allows for interactive and composite labels
+---of inlay hints.
+---
+---@since 3.17.0
+---@class lsp.InlayHintLabelPart
+---The value of this label part.
+---@field value string
+---The tooltip text when you hover over this label part. Depending on
+---the client capability `inlayHint.resolveSupport` clients might resolve
+---this property late using the resolve request.
+---@field tooltip? string|lsp.MarkupContent
+---An optional source code location that represents this
+---label part.
+---
+---The editor will use this location for the hover and for code navigation
+---features: This part will become a clickable link that resolves to the
+---definition of the symbol at the given location (not necessarily the
+---location itself), it shows the hover that shows at the given location,
+---and it shows a context menu with further code navigation commands.
+---
+---Depending on the client capability `inlayHint.resolveSupport` clients
+---might resolve this property late using the resolve request.
+---@field location? lsp.Location
+---An optional command for this label part.
+---
+---Depending on the client capability `inlayHint.resolveSupport` clients
+---might resolve this property late using the resolve request.
+---@field command? lsp.Command
+
+---A `MarkupContent` literal represents a string value which content is interpreted base on its
+---kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
+---
+---If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.
+---See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
+---
+---Here is an example how such a string can be constructed using JavaScript / TypeScript:
+---```ts
+---let markdown: MarkdownContent = {
+--- kind: MarkupKind.Markdown,
+--- value: [
+---   '# Header',
+---   'Some text',
+---   '```typescript',
+---   'someCode();',
+---   '```'
+--- ].join('\n')
+---};
+---```
+---
+---*Please Note* that clients might sanitize the return markdown. A client could decide to
+---remove HTML from the markdown to avoid script execution.
+---@class lsp.MarkupContent
+---The type of the Markup
+---@field kind lsp.MarkupKind
+---The content itself
+---@field value string
+
+---Inlay hint options used during static registration.
+---
+---@since 3.17.0
+---@class lsp.InlayHintOptions
+---The server provides support to resolve additional
+---information for an inlay hint item.
+---@field resolveProvider? boolean
+
+---A full diagnostic report with a set of related documents.
+---
+---@since 3.17.0
+---@class lsp.RelatedFullDocumentDiagnosticReport: lsp.FullDocumentDiagnosticReport
+---Diagnostics of related documents. This information is useful
+---in programming languages where code in a file A can generate
+---diagnostics in a file B which A depends on. An example of
+---such a language is C/C++ where marco definitions in a file
+---a.cpp and result in errors in a header file b.hpp.
+---
+---@since 3.17.0
+---@field relatedDocuments? table<lsp.DocumentUri, lsp.FullDocumentDiagnosticReport|lsp.UnchangedDocumentDiagnosticReport>
+
+---An unchanged diagnostic report with a set of related documents.
+---
+---@since 3.17.0
+---@class lsp.RelatedUnchangedDocumentDiagnosticReport: lsp.UnchangedDocumentDiagnosticReport
+---Diagnostics of related documents. This information is useful
+---in programming languages where code in a file A can generate
+---diagnostics in a file B which A depends on. An example of
+---such a language is C/C++ where marco definitions in a file
+---a.cpp and result in errors in a header file b.hpp.
+---
+---@since 3.17.0
+---@field relatedDocuments? table<lsp.DocumentUri, lsp.FullDocumentDiagnosticReport|lsp.UnchangedDocumentDiagnosticReport>
+
+---A diagnostic report with a full set of problems.
+---
+---@since 3.17.0
+---@class lsp.FullDocumentDiagnosticReport
+---A full document diagnostic report.
+---@field kind "full"
+---An optional result id. If provided it will
+---be sent on the next diagnostic request for the
+---same document.
+---@field resultId? string
+---The actual items.
+---@field items lsp.Diagnostic[]
+
+---A diagnostic report indicating that the last returned
+---report is still accurate.
+---
+---@since 3.17.0
+---@class lsp.UnchangedDocumentDiagnosticReport
+---A document diagnostic report indicating
+---no changes to the last result. A server can
+---only return `unchanged` if result ids are
+---provided.
+---@field kind "unchanged"
+---A result id which will be sent on the next
+---diagnostic request for the same document.
+---@field resultId string
+
+---Diagnostic options.
+---
+---@since 3.17.0
+---@class lsp.DiagnosticOptions
+---An optional identifier under which the diagnostics are
+---managed by the client.
+---@field identifier? string
+---Whether the language has inter file dependencies meaning that
+---editing code in one file can result in a different diagnostic
+---set in another file. Inter file dependencies are common for
+---most programming languages and typically uncommon for linters.
+---@field interFileDependencies boolean
+---The server provides support for workspace diagnostics as well.
+---@field workspaceDiagnostics boolean
+
+---A previous result id in a workspace pull request.
+---
+---@since 3.17.0
+---@class lsp.PreviousResultId
+---The URI for which the client knowns a
+---result id.
+---@field uri lsp.DocumentUri
+---The value of the previous result id.
+---@field value string
+
+---A notebook document.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocument
+---The notebook document's uri.
+---@field uri lsp.URI
+---The type of the notebook.
+---@field notebookType string
+---The version number of this document (it will increase after each
+---change, including undo/redo).
+---@field version integer
+---Additional metadata stored with the notebook
+---document.
+---
+---Note: should always be an object literal (e.g. LSPObject)
+---@field metadata? lsp.LSPObject
+---The cells of a notebook.
+---@field cells lsp.NotebookCell[]
+
+---An item to transfer a text document from the client to the
+---server.
+---@class lsp.TextDocumentItem
+---The text document's uri.
+---@field uri lsp.DocumentUri
+---The text document's language identifier.
+---@field languageId string
+---The version number of this document (it will increase after each
+---change, including undo/redo).
+---@field version integer
+---The content of the opened text document.
+---@field text string
+
+---A versioned notebook document identifier.
+---
+---@since 3.17.0
+---@class lsp.VersionedNotebookDocumentIdentifier
+---The version number of this notebook document.
+---@field version integer
+---The notebook document's uri.
+---@field uri lsp.URI
+
+---A change event for a notebook document.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentChangeEvent
+---The changed meta data if any.
+---
+---Note: should always be an object literal (e.g. LSPObject)
+---@field metadata? lsp.LSPObject
+---Changes to cells
+---@field cells? anonym10
+
+---A literal to identify a notebook document in the client.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentIdentifier
+---The notebook document's uri.
+---@field uri lsp.URI
+
+---Provides information about the context in which an inline completion was requested.
+---
+---@since 3.18.0
+---@class lsp.InlineCompletionContext
+---Describes how the inline completion was triggered.
+---@field triggerKind lsp.InlineCompletionTriggerKind
+---Provides information about the currently selected item in the autocomplete widget if it is visible.
+---@field selectedCompletionInfo? lsp.SelectedCompletionInfo
+
+---Inline completion options used during static registration.
+---
+---@since 3.18.0
+---@class lsp.InlineCompletionOptions
+
+---General parameters to to register for an notification or to register a provider.
+---@class lsp.Registration
+---The id used to register the request. The id can be used to deregister
+---the request again.
+---@field id string
+---The method / capability to register for.
+---@field method string
+---Options necessary for the registration.
+---@field registerOptions? lsp.LSPAny
+
+---General parameters to unregister a request or notification.
+---@class lsp.Unregistration
+---The id used to unregister the request or notification. Usually an id
+---provided during the register request.
+---@field id string
+---The method to unregister for.
+---@field method string
+
+---The initialize parameters
+---@class lsp._InitializeParams
+---The process Id of the parent process that started
+---the server.
+---
+---Is `null` if the process has not been started by another process.
+---If the parent process is not alive then the server should exit.
+---@field processId integer|lsp.null
+---Information about the client
+---
+---@since 3.15.0
+---@field clientInfo? anonym11
+---The locale the client is currently showing the user interface
+---in. This must not necessarily be the locale of the operating
+---system.
+---
+---Uses IETF language tags as the value's syntax
+---(See https://en.wikipedia.org/wiki/IETF_language_tag)
+---
+---@since 3.16.0
+---@field locale? string
+---The rootPath of the workspace. Is null
+---if no folder is open.
+---
+---@deprecated in favour of rootUri.
+---@field rootPath? string|lsp.null
+---The rootUri of the workspace. Is null if no
+---folder is open. If both `rootPath` and `rootUri` are set
+---`rootUri` wins.
+---
+---@deprecated in favour of workspaceFolders.
+---@field rootUri lsp.DocumentUri|lsp.null
+---The capabilities provided by the client (editor or tool)
+---@field capabilities lsp.ClientCapabilities
+---User provided initialization options.
+---@field initializationOptions? lsp.LSPAny
+---The initial trace setting. If omitted trace is disabled ('off').
+---@field trace? lsp.TraceValues
+
+---@class lsp.WorkspaceFoldersInitializeParams
+---The workspace folders configured in the client when the server starts.
+---
+---This property is only available if the client supports workspace folders.
+---It can be `null` if the client supports workspace folders but none are
+---configured.
+---
+---@since 3.6.0
+---@field workspaceFolders? lsp.WorkspaceFolder[]|lsp.null
+
+---Defines the capabilities provided by a language
+---server.
+---@class lsp.ServerCapabilities
+---The position encoding the server picked from the encodings offered
+---by the client via the client capability `general.positionEncodings`.
+---
+---If the client didn't provide any position encodings the only valid
+---value that a server can return is 'utf-16'.
+---
+---If omitted it defaults to 'utf-16'.
+---
+---@since 3.17.0
+---@field positionEncoding? lsp.PositionEncodingKind
+---Defines how text documents are synced. Is either a detailed structure
+---defining each notification or for backwards compatibility the
+---TextDocumentSyncKind number.
+---@field textDocumentSync? lsp.TextDocumentSyncOptions|lsp.TextDocumentSyncKind
+---Defines how notebook documents are synced.
+---
+---@since 3.17.0
+---@field notebookDocumentSync? lsp.NotebookDocumentSyncOptions|lsp.NotebookDocumentSyncRegistrationOptions
+---The server provides completion support.
+---@field completionProvider? lsp.CompletionOptions
+---The server provides hover support.
+---@field hoverProvider? boolean|lsp.HoverOptions
+---The server provides signature help support.
+---@field signatureHelpProvider? lsp.SignatureHelpOptions
+---The server provides Goto Declaration support.
+---@field declarationProvider? boolean|lsp.DeclarationOptions|lsp.DeclarationRegistrationOptions
+---The server provides goto definition support.
+---@field definitionProvider? boolean|lsp.DefinitionOptions
+---The server provides Goto Type Definition support.
+---@field typeDefinitionProvider? boolean|lsp.TypeDefinitionOptions|lsp.TypeDefinitionRegistrationOptions
+---The server provides Goto Implementation support.
+---@field implementationProvider? boolean|lsp.ImplementationOptions|lsp.ImplementationRegistrationOptions
+---The server provides find references support.
+---@field referencesProvider? boolean|lsp.ReferenceOptions
+---The server provides document highlight support.
+---@field documentHighlightProvider? boolean|lsp.DocumentHighlightOptions
+---The server provides document symbol support.
+---@field documentSymbolProvider? boolean|lsp.DocumentSymbolOptions
+---The server provides code actions. CodeActionOptions may only be
+---specified if the client states that it supports
+---`codeActionLiteralSupport` in its initial `initialize` request.
+---@field codeActionProvider? boolean|lsp.CodeActionOptions
+---The server provides code lens.
+---@field codeLensProvider? lsp.CodeLensOptions
+---The server provides document link support.
+---@field documentLinkProvider? lsp.DocumentLinkOptions
+---The server provides color provider support.
+---@field colorProvider? boolean|lsp.DocumentColorOptions|lsp.DocumentColorRegistrationOptions
+---The server provides workspace symbol support.
+---@field workspaceSymbolProvider? boolean|lsp.WorkspaceSymbolOptions
+---The server provides document formatting.
+---@field documentFormattingProvider? boolean|lsp.DocumentFormattingOptions
+---The server provides document range formatting.
+---@field documentRangeFormattingProvider? boolean|lsp.DocumentRangeFormattingOptions
+---The server provides document formatting on typing.
+---@field documentOnTypeFormattingProvider? lsp.DocumentOnTypeFormattingOptions
+---The server provides rename support. RenameOptions may only be
+---specified if the client states that it supports
+---`prepareSupport` in its initial `initialize` request.
+---@field renameProvider? boolean|lsp.RenameOptions
+---The server provides folding provider support.
+---@field foldingRangeProvider? boolean|lsp.FoldingRangeOptions|lsp.FoldingRangeRegistrationOptions
+---The server provides selection range support.
+---@field selectionRangeProvider? boolean|lsp.SelectionRangeOptions|lsp.SelectionRangeRegistrationOptions
+---The server provides execute command support.
+---@field executeCommandProvider? lsp.ExecuteCommandOptions
+---The server provides call hierarchy support.
+---
+---@since 3.16.0
+---@field callHierarchyProvider? boolean|lsp.CallHierarchyOptions|lsp.CallHierarchyRegistrationOptions
+---The server provides linked editing range support.
+---
+---@since 3.16.0
+---@field linkedEditingRangeProvider? boolean|lsp.LinkedEditingRangeOptions|lsp.LinkedEditingRangeRegistrationOptions
+---The server provides semantic tokens support.
+---
+---@since 3.16.0
+---@field semanticTokensProvider? lsp.SemanticTokensOptions|lsp.SemanticTokensRegistrationOptions
+---The server provides moniker support.
+---
+---@since 3.16.0
+---@field monikerProvider? boolean|lsp.MonikerOptions|lsp.MonikerRegistrationOptions
+---The server provides type hierarchy support.
+---
+---@since 3.17.0
+---@field typeHierarchyProvider? boolean|lsp.TypeHierarchyOptions|lsp.TypeHierarchyRegistrationOptions
+---The server provides inline values.
+---
+---@since 3.17.0
+---@field inlineValueProvider? boolean|lsp.InlineValueOptions|lsp.InlineValueRegistrationOptions
+---The server provides inlay hints.
+---
+---@since 3.17.0
+---@field inlayHintProvider? boolean|lsp.InlayHintOptions|lsp.InlayHintRegistrationOptions
+---The server has support for pull model diagnostics.
+---
+---@since 3.17.0
+---@field diagnosticProvider? lsp.DiagnosticOptions|lsp.DiagnosticRegistrationOptions
+---Inline completion options used during static registration.
+---
+---@since 3.18.0
+---@field inlineCompletionProvider? boolean|lsp.InlineCompletionOptions
+---Workspace specific server capabilities.
+---@field workspace? anonym12
+---Experimental server capabilities.
+---@field experimental? lsp.LSPAny
+
+---A text document identifier to denote a specific version of a text document.
+---@class lsp.VersionedTextDocumentIdentifier: lsp.TextDocumentIdentifier
+---The version number of this document.
+---@field version integer
+
+---Save options.
+---@class lsp.SaveOptions
+---The client is supposed to include the content on save.
+---@field includeText? boolean
+
+---An event describing a file change.
+---@class lsp.FileEvent
+---The file's uri.
+---@field uri lsp.DocumentUri
+---The change type.
+---@field type lsp.FileChangeType
+
+---@class lsp.FileSystemWatcher
+---The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.
+---
+---@since 3.17.0 support for relative patterns.
+---@field globPattern lsp.GlobPattern
+---The kind of events of interest. If omitted it defaults
+---to WatchKind.Create | WatchKind.Change | WatchKind.Delete
+---which is 7.
+---@field kind? lsp.WatchKind
+
+---Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
+---are only valid in the scope of a resource.
+---@class lsp.Diagnostic
+---The range at which the message applies
+---@field range lsp.Range
+---The diagnostic's severity. Can be omitted. If omitted it is up to the
+---client to interpret diagnostics as error, warning, info or hint.
+---@field severity? lsp.DiagnosticSeverity
+---The diagnostic's code, which usually appear in the user interface.
+---@field code? integer|string
+---An optional property to describe the error code.
+---Requires the code field (above) to be present/not null.
+---
+---@since 3.16.0
+---@field codeDescription? lsp.CodeDescription
+---A human-readable string describing the source of this
+---diagnostic, e.g. 'typescript' or 'super lint'. It usually
+---appears in the user interface.
+---@field source? string
+---The diagnostic's message. It usually appears in the user interface
+---@field message string
+---Additional metadata about the diagnostic.
+---
+---@since 3.15.0
+---@field tags? lsp.DiagnosticTag[]
+---An array of related diagnostic information, e.g. when symbol-names within
+---a scope collide all definitions can be marked via this property.
+---@field relatedInformation? lsp.DiagnosticRelatedInformation[]
+---A data entry field that is preserved between a `textDocument/publishDiagnostics`
+---notification and `textDocument/codeAction` request.
+---
+---@since 3.16.0
+---@field data? lsp.LSPAny
+
+---Contains additional information about the context in which a completion request is triggered.
+---@class lsp.CompletionContext
+---How the completion was triggered.
+---@field triggerKind lsp.CompletionTriggerKind
+---The trigger character (a single character) that has trigger code complete.
+---Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
+---@field triggerCharacter? string
+
+---Additional details for a completion item label.
+---
+---@since 3.17.0
+---@class lsp.CompletionItemLabelDetails
+---An optional string which is rendered less prominently directly after {@link CompletionItem.label label},
+---without any spacing. Should be used for function signatures and type annotations.
+---@field detail? string
+---An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used
+---for fully qualified names and file paths.
+---@field description? string
+
+---A special text edit to provide an insert and a replace operation.
+---
+---@since 3.16.0
+---@class lsp.InsertReplaceEdit
+---The string to be inserted.
+---@field newText string
+---The range if the insert is requested
+---@field insert lsp.Range
+---The range if the replace is requested.
+---@field replace lsp.Range
+
+---Completion options.
+---@class lsp.CompletionOptions
+---Most tools trigger completion request automatically without explicitly requesting
+---it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user
+---starts to type an identifier. For example if the user types `c` in a JavaScript file
+---code complete will automatically pop up present `console` besides others as a
+---completion item. Characters that make up identifiers don't need to be listed here.
+---
+---If code complete should automatically be trigger on characters not being valid inside
+---an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
+---@field triggerCharacters? string[]
+---The list of all possible characters that commit a completion. This field can be used
+---if clients don't support individual commit characters per completion item. See
+---`ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport`
+---
+---If a server provides both `allCommitCharacters` and commit characters on an individual
+---completion item the ones on the completion item win.
+---
+---@since 3.2.0
+---@field allCommitCharacters? string[]
+---The server provides support to resolve additional
+---information for a completion item.
+---@field resolveProvider? boolean
+---The server supports the following `CompletionItem` specific
+---capabilities.
+---
+---@since 3.17.0
+---@field completionItem? anonym13
+
+---Hover options.
+---@class lsp.HoverOptions
+
+---Additional information about the context in which a signature help request was triggered.
+---
+---@since 3.15.0
+---@class lsp.SignatureHelpContext
+---Action that caused signature help to be triggered.
+---@field triggerKind lsp.SignatureHelpTriggerKind
+---Character that caused signature help to be triggered.
+---
+---This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`
+---@field triggerCharacter? string
+---`true` if signature help was already showing when it was triggered.
+---
+---Retriggers occurs when the signature help is already active and can be caused by actions such as
+---typing a trigger character, a cursor move, or document content changes.
+---@field isRetrigger boolean
+---The currently active `SignatureHelp`.
+---
+---The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on
+---the user navigating through available signatures.
+---@field activeSignatureHelp? lsp.SignatureHelp
+
+---Represents the signature of something callable. A signature
+---can have a label, like a function-name, a doc-comment, and
+---a set of parameters.
+---@class lsp.SignatureInformation
+---The label of this signature. Will be shown in
+---the UI.
+---@field label string
+---The human-readable doc-comment of this signature. Will be shown
+---in the UI but can be omitted.
+---@field documentation? string|lsp.MarkupContent
+---The parameters of this signature.
+---@field parameters? lsp.ParameterInformation[]
+---The index of the active parameter.
+---
+---If provided, this is used in place of `SignatureHelp.activeParameter`.
+---
+---@since 3.16.0
+---@field activeParameter? uinteger
+
+---Server Capabilities for a {@link SignatureHelpRequest}.
+---@class lsp.SignatureHelpOptions
+---List of characters that trigger signature help automatically.
+---@field triggerCharacters? string[]
+---List of characters that re-trigger signature help.
+---
+---These trigger characters are only active when signature help is already showing. All trigger characters
+---are also counted as re-trigger characters.
+---
+---@since 3.15.0
+---@field retriggerCharacters? string[]
+
+---Server Capabilities for a {@link DefinitionRequest}.
+---@class lsp.DefinitionOptions
+
+---Value-object that contains additional information when
+---requesting references.
+---@class lsp.ReferenceContext
+---Include the declaration of the current symbol.
+---@field includeDeclaration boolean
+
+---Reference options.
+---@class lsp.ReferenceOptions
+
+---Provider options for a {@link DocumentHighlightRequest}.
+---@class lsp.DocumentHighlightOptions
+
+---A base for all symbol information.
+---@class lsp.BaseSymbolInformation
+---The name of this symbol.
+---@field name string
+---The kind of this symbol.
+---@field kind lsp.SymbolKind
+---Tags for this symbol.
+---
+---@since 3.16.0
+---@field tags? lsp.SymbolTag[]
+---The name of the symbol containing this symbol. This information is for
+---user interface purposes (e.g. to render a qualifier in the user interface
+---if necessary). It can't be used to re-infer a hierarchy for the document
+---symbols.
+---@field containerName? string
+
+---Provider options for a {@link DocumentSymbolRequest}.
+---@class lsp.DocumentSymbolOptions
+---A human-readable string that is shown when multiple outlines trees
+---are shown for the same document.
+---
+---@since 3.16.0
+---@field label? string
+
+---Contains additional diagnostic information about the context in which
+---a {@link CodeActionProvider.provideCodeActions code action} is run.
+---@class lsp.CodeActionContext
+---An array of diagnostics known on the client side overlapping the range provided to the
+---`textDocument/codeAction` request. They are provided so that the server knows which
+---errors are currently presented to the user for the given range. There is no guarantee
+---that these accurately reflect the error state of the resource. The primary parameter
+---to compute code actions is the provided range.
+---@field diagnostics lsp.Diagnostic[]
+---Requested kind of actions to return.
+---
+---Actions not of this kind are filtered out by the client before being shown. So servers
+---can omit computing them.
+---@field only? lsp.CodeActionKind[]
+---The reason why code actions were requested.
+---
+---@since 3.17.0
+---@field triggerKind? lsp.CodeActionTriggerKind
+
+---Provider options for a {@link CodeActionRequest}.
+---@class lsp.CodeActionOptions
+---CodeActionKinds that this server may return.
+---
+---The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server
+---may list out every specific kind they provide.
+---@field codeActionKinds? lsp.CodeActionKind[]
+---The server provides support to resolve additional
+---information for a code action.
+---
+---@since 3.16.0
+---@field resolveProvider? boolean
+
+---Server capabilities for a {@link WorkspaceSymbolRequest}.
+---@class lsp.WorkspaceSymbolOptions
+---The server provides support to resolve additional
+---information for a workspace symbol.
+---
+---@since 3.17.0
+---@field resolveProvider? boolean
+
+---Code Lens provider options of a {@link CodeLensRequest}.
+---@class lsp.CodeLensOptions
+---Code lens has a resolve provider as well.
+---@field resolveProvider? boolean
+
+---Provider options for a {@link DocumentLinkRequest}.
+---@class lsp.DocumentLinkOptions
+---Document links have a resolve provider as well.
+---@field resolveProvider? boolean
+
+---Value-object describing what options formatting should use.
+---@class lsp.FormattingOptions
+---Size of a tab in spaces.
+---@field tabSize uinteger
+---Prefer spaces over tabs.
+---@field insertSpaces boolean
+---Trim trailing whitespace on a line.
+---
+---@since 3.15.0
+---@field trimTrailingWhitespace? boolean
+---Insert a newline character at the end of the file if one does not exist.
+---
+---@since 3.15.0
+---@field insertFinalNewline? boolean
+---Trim all newlines after the final newline at the end of the file.
+---
+---@since 3.15.0
+---@field trimFinalNewlines? boolean
+
+---Provider options for a {@link DocumentFormattingRequest}.
+---@class lsp.DocumentFormattingOptions
+
+---Provider options for a {@link DocumentRangeFormattingRequest}.
+---@class lsp.DocumentRangeFormattingOptions
+---Whether the server supports formatting multiple ranges at once.
+---
+---@since 3.18.0
+---@proposed
+---@field rangesSupport? boolean
+
+---Provider options for a {@link DocumentOnTypeFormattingRequest}.
+---@class lsp.DocumentOnTypeFormattingOptions
+---A character on which formatting should be triggered, like `{`.
+---@field firstTriggerCharacter string
+---More trigger characters.
+---@field moreTriggerCharacter? string[]
+
+---Provider options for a {@link RenameRequest}.
+---@class lsp.RenameOptions
+---Renames should be checked and tested before being executed.
+---
+---@since version 3.12.0
+---@field prepareProvider? boolean
+
+---The server capabilities of a {@link ExecuteCommandRequest}.
+---@class lsp.ExecuteCommandOptions
+---The commands to be executed on the server
+---@field commands string[]
+
+---@since 3.16.0
+---@class lsp.SemanticTokensLegend
+---The token types a server uses.
+---@field tokenTypes string[]
+---The token modifiers a server uses.
+---@field tokenModifiers string[]
+
+---A text document identifier to optionally denote a specific version of a text document.
+---@class lsp.OptionalVersionedTextDocumentIdentifier: lsp.TextDocumentIdentifier
+---The version number of this document. If a versioned text document identifier
+---is sent from the server to the client and the file is not open in the editor
+---(the server has not received an open notification before) the server can send
+---`null` to indicate that the version is unknown and the content on disk is the
+---truth (as specified with document content ownership).
+---@field version integer|lsp.null
+
+---A special text edit with an additional change annotation.
+---
+---@since 3.16.0.
+---@class lsp.AnnotatedTextEdit: lsp.TextEdit
+---The actual identifier of the change annotation
+---@field annotationId lsp.ChangeAnnotationIdentifier
+
+---A generic resource operation.
+---@class lsp.ResourceOperation
+---The resource operation kind.
+---@field kind string
+---An optional annotation identifier describing the operation.
+---
+---@since 3.16.0
+---@field annotationId? lsp.ChangeAnnotationIdentifier
+
+---Options to create a file.
+---@class lsp.CreateFileOptions
+---Overwrite existing file. Overwrite wins over `ignoreIfExists`
+---@field overwrite? boolean
+---Ignore if exists.
+---@field ignoreIfExists? boolean
+
+---Rename file options
+---@class lsp.RenameFileOptions
+---Overwrite target if existing. Overwrite wins over `ignoreIfExists`
+---@field overwrite? boolean
+---Ignores if target exists.
+---@field ignoreIfExists? boolean
+
+---Delete file options
+---@class lsp.DeleteFileOptions
+---Delete the content recursively if a folder is denoted.
+---@field recursive? boolean
+---Ignore the operation if the file doesn't exist.
+---@field ignoreIfNotExists? boolean
+
+---A pattern to describe in which file operation requests or notifications
+---the server is interested in receiving.
+---
+---@since 3.16.0
+---@class lsp.FileOperationPattern
+---The glob pattern to match. Glob patterns can have the following syntax:
+---- `*` to match one or more characters in a path segment
+---- `?` to match on one character in a path segment
+---- `**` to match any number of path segments, including none
+---- `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+---@field glob string
+---Whether to match files or folders with this pattern.
+---
+---Matches both if undefined.
+---@field matches? lsp.FileOperationPatternKind
+---Additional options used during matching.
+---@field options? lsp.FileOperationPatternOptions
+
+---A full document diagnostic report for a workspace diagnostic result.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceFullDocumentDiagnosticReport: lsp.FullDocumentDiagnosticReport
+---The URI for which diagnostic information is reported.
+---@field uri lsp.DocumentUri
+---The version number for which the diagnostics are reported.
+---If the document is not marked as open `null` can be provided.
+---@field version integer|lsp.null
+
+---An unchanged document diagnostic report for a workspace diagnostic result.
+---
+---@since 3.17.0
+---@class lsp.WorkspaceUnchangedDocumentDiagnosticReport: lsp.UnchangedDocumentDiagnosticReport
+---The URI for which diagnostic information is reported.
+---@field uri lsp.DocumentUri
+---The version number for which the diagnostics are reported.
+---If the document is not marked as open `null` can be provided.
+---@field version integer|lsp.null
+
+---A notebook cell.
+---
+---A cell's document URI must be unique across ALL notebook
+---cells and can therefore be used to uniquely identify a
+---notebook cell or the cell's text document.
+---
+---@since 3.17.0
+---@class lsp.NotebookCell
+---The cell's kind
+---@field kind lsp.NotebookCellKind
+---The URI of the cell's text document
+---content.
+---@field document lsp.DocumentUri
+---Additional metadata stored with the cell.
+---
+---Note: should always be an object literal (e.g. LSPObject)
+---@field metadata? lsp.LSPObject
+---Additional execution summary information
+---if supported by the client.
+---@field executionSummary? lsp.ExecutionSummary
+
+---A change describing how to move a `NotebookCell`
+---array from state S to S'.
+---
+---@since 3.17.0
+---@class lsp.NotebookCellArrayChange
+---The start oftest of the cell that changed.
+---@field start uinteger
+---The deleted cells
+---@field deleteCount uinteger
+---The new cells, if any
+---@field cells? lsp.NotebookCell[]
+
+---Describes the currently selected completion item.
+---
+---@since 3.18.0
+---@class lsp.SelectedCompletionInfo
+---The range that will be replaced if this completion item is accepted.
+---@field range lsp.Range
+---The text the range will be replaced with if this completion is accepted.
+---@field text string
+
+---Defines the capabilities provided by the client.
+---@class lsp.ClientCapabilities
+---Workspace specific client capabilities.
+---@field workspace? lsp.WorkspaceClientCapabilities
+---Text document specific client capabilities.
+---@field textDocument? lsp.TextDocumentClientCapabilities
+---Capabilities specific to the notebook document support.
+---
+---@since 3.17.0
+---@field notebookDocument? lsp.NotebookDocumentClientCapabilities
+---Window specific client capabilities.
+---@field window? lsp.WindowClientCapabilities
+---General client capabilities.
+---
+---@since 3.16.0
+---@field general? lsp.GeneralClientCapabilities
+---Experimental client capabilities.
+---@field experimental? lsp.LSPAny
+
+---@class lsp.TextDocumentSyncOptions
+---Open and close notifications are sent to the server. If omitted open close notification should not
+---be sent.
+---@field openClose? boolean
+---Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
+---and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
+---@field change? lsp.TextDocumentSyncKind
+---If present will save notifications are sent to the server. If omitted the notification should not be
+---sent.
+---@field willSave? boolean
+---If present will save wait until requests are sent to the server. If omitted the request should not be
+---sent.
+---@field willSaveWaitUntil? boolean
+---If present save notifications are sent to the server. If omitted the notification should not be
+---sent.
+---@field save? boolean|lsp.SaveOptions
+
+---Options specific to a notebook plus its cells
+---to be synced to the server.
+---
+---If a selector provides a notebook document
+---filter but no cell selector all cells of a
+---matching notebook document will be synced.
+---
+---If a selector provides no notebook document
+---filter but only a cell selector all notebook
+---document that contain at least one matching
+---cell will be synced.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentSyncOptions
+---The notebooks to be synced
+---@field notebookSelector anonym15|anonym17[]
+---Whether save notification should be forwarded to
+---the server. Will only be honored if mode === `notebook`.
+---@field save? boolean
+
+---Registration options specific to a notebook.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentSyncRegistrationOptions: lsp.NotebookDocumentSyncOptions, lsp.StaticRegistrationOptions
+
+---@class lsp.WorkspaceFoldersServerCapabilities
+---The server has support for workspace folders
+---@field supported? boolean
+---Whether the server wants to receive workspace folder
+---change notifications.
+---
+---If a string is provided the string is treated as an ID
+---under which the notification is registered on the client
+---side. The ID can be used to unregister for these events
+---using the `client/unregisterCapability` request.
+---@field changeNotifications? string|boolean
+
+---Options for notifications/requests for user operations on files.
+---
+---@since 3.16.0
+---@class lsp.FileOperationOptions
+---The server is interested in receiving didCreateFiles notifications.
+---@field didCreate? lsp.FileOperationRegistrationOptions
+---The server is interested in receiving willCreateFiles requests.
+---@field willCreate? lsp.FileOperationRegistrationOptions
+---The server is interested in receiving didRenameFiles notifications.
+---@field didRename? lsp.FileOperationRegistrationOptions
+---The server is interested in receiving willRenameFiles requests.
+---@field willRename? lsp.FileOperationRegistrationOptions
+---The server is interested in receiving didDeleteFiles file notifications.
+---@field didDelete? lsp.FileOperationRegistrationOptions
+---The server is interested in receiving willDeleteFiles file requests.
+---@field willDelete? lsp.FileOperationRegistrationOptions
+
+---Structure to capture a description for an error code.
+---
+---@since 3.16.0
+---@class lsp.CodeDescription
+---An URI to open with more information about the diagnostic error.
+---@field href lsp.URI
+
+---Represents a related message and source code location for a diagnostic. This should be
+---used to point to code locations that cause or related to a diagnostics, e.g when duplicating
+---a symbol in a scope.
+---@class lsp.DiagnosticRelatedInformation
+---The location of this related diagnostic information.
+---@field location lsp.Location
+---The message of this related diagnostic information.
+---@field message string
+
+---Represents a parameter of a callable-signature. A parameter can
+---have a label and a doc-comment.
+---@class lsp.ParameterInformation
+---The label of this parameter information.
+---
+---Either a string or an inclusive start and exclusive end offsets within its containing
+---signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
+---string representation as `Position` and `Range` does.
+---
+---*Note*: a label of type string should be a substring of its containing signature label.
+---Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
+---@field label string|{ [1]: uinteger, [2]: uinteger }
+---The human-readable doc-comment of this parameter. Will be shown
+---in the UI but can be omitted.
+---@field documentation? string|lsp.MarkupContent
+
+---A notebook cell text document filter denotes a cell text
+---document by different properties.
+---
+---@since 3.17.0
+---@class lsp.NotebookCellTextDocumentFilter
+---A filter that matches against the notebook
+---containing the notebook cell. If a string
+---value is provided it matches against the
+---notebook type. '*' matches every notebook.
+---@field notebook string|lsp.NotebookDocumentFilter
+---A language id like `python`.
+---
+---Will be matched against the language id of the
+---notebook cell document. '*' matches every language.
+---@field language? string
+
+---Matching options for the file operation pattern.
+---
+---@since 3.16.0
+---@class lsp.FileOperationPatternOptions
+---The pattern should be matched ignoring casing.
+---@field ignoreCase? boolean
+
+---@class lsp.ExecutionSummary
+---A strict monotonically increasing value
+---indicating the execution order of a cell
+---inside a notebook.
+---@field executionOrder uinteger
+---Whether the execution was successful or
+---not if known by the client.
+---@field success? boolean
+
+---Workspace specific client capabilities.
+---@class lsp.WorkspaceClientCapabilities
+---The client supports applying batch edits
+---to the workspace by supporting the request
+---'workspace/applyEdit'
+---@field applyEdit? boolean
+---Capabilities specific to `WorkspaceEdit`s.
+---@field workspaceEdit? lsp.WorkspaceEditClientCapabilities
+---Capabilities specific to the `workspace/didChangeConfiguration` notification.
+---@field didChangeConfiguration? lsp.DidChangeConfigurationClientCapabilities
+---Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
+---@field didChangeWatchedFiles? lsp.DidChangeWatchedFilesClientCapabilities
+---Capabilities specific to the `workspace/symbol` request.
+---@field symbol? lsp.WorkspaceSymbolClientCapabilities
+---Capabilities specific to the `workspace/executeCommand` request.
+---@field executeCommand? lsp.ExecuteCommandClientCapabilities
+---The client has support for workspace folders.
+---
+---@since 3.6.0
+---@field workspaceFolders? boolean
+---The client supports `workspace/configuration` requests.
+---
+---@since 3.6.0
+---@field configuration? boolean
+---Capabilities specific to the semantic token requests scoped to the
+---workspace.
+---
+---@since 3.16.0.
+---@field semanticTokens? lsp.SemanticTokensWorkspaceClientCapabilities
+---Capabilities specific to the code lens requests scoped to the
+---workspace.
+---
+---@since 3.16.0.
+---@field codeLens? lsp.CodeLensWorkspaceClientCapabilities
+---The client has support for file notifications/requests for user operations on files.
+---
+---Since 3.16.0
+---@field fileOperations? lsp.FileOperationClientCapabilities
+---Capabilities specific to the inline values requests scoped to the
+---workspace.
+---
+---@since 3.17.0.
+---@field inlineValue? lsp.InlineValueWorkspaceClientCapabilities
+---Capabilities specific to the inlay hint requests scoped to the
+---workspace.
+---
+---@since 3.17.0.
+---@field inlayHint? lsp.InlayHintWorkspaceClientCapabilities
+---Capabilities specific to the diagnostic requests scoped to the
+---workspace.
+---
+---@since 3.17.0.
+---@field diagnostics? lsp.DiagnosticWorkspaceClientCapabilities
+
+---Text document specific client capabilities.
+---@class lsp.TextDocumentClientCapabilities
+---Defines which synchronization capabilities the client supports.
+---@field synchronization? lsp.TextDocumentSyncClientCapabilities
+---Capabilities specific to the `textDocument/completion` request.
+---@field completion? lsp.CompletionClientCapabilities
+---Capabilities specific to the `textDocument/hover` request.
+---@field hover? lsp.HoverClientCapabilities
+---Capabilities specific to the `textDocument/signatureHelp` request.
+---@field signatureHelp? lsp.SignatureHelpClientCapabilities
+---Capabilities specific to the `textDocument/declaration` request.
+---
+---@since 3.14.0
+---@field declaration? lsp.DeclarationClientCapabilities
+---Capabilities specific to the `textDocument/definition` request.
+---@field definition? lsp.DefinitionClientCapabilities
+---Capabilities specific to the `textDocument/typeDefinition` request.
+---
+---@since 3.6.0
+---@field typeDefinition? lsp.TypeDefinitionClientCapabilities
+---Capabilities specific to the `textDocument/implementation` request.
+---
+---@since 3.6.0
+---@field implementation? lsp.ImplementationClientCapabilities
+---Capabilities specific to the `textDocument/references` request.
+---@field references? lsp.ReferenceClientCapabilities
+---Capabilities specific to the `textDocument/documentHighlight` request.
+---@field documentHighlight? lsp.DocumentHighlightClientCapabilities
+---Capabilities specific to the `textDocument/documentSymbol` request.
+---@field documentSymbol? lsp.DocumentSymbolClientCapabilities
+---Capabilities specific to the `textDocument/codeAction` request.
+---@field codeAction? lsp.CodeActionClientCapabilities
+---Capabilities specific to the `textDocument/codeLens` request.
+---@field codeLens? lsp.CodeLensClientCapabilities
+---Capabilities specific to the `textDocument/documentLink` request.
+---@field documentLink? lsp.DocumentLinkClientCapabilities
+---Capabilities specific to the `textDocument/documentColor` and the
+---`textDocument/colorPresentation` request.
+---
+---@since 3.6.0
+---@field colorProvider? lsp.DocumentColorClientCapabilities
+---Capabilities specific to the `textDocument/formatting` request.
+---@field formatting? lsp.DocumentFormattingClientCapabilities
+---Capabilities specific to the `textDocument/rangeFormatting` request.
+---@field rangeFormatting? lsp.DocumentRangeFormattingClientCapabilities
+---Capabilities specific to the `textDocument/onTypeFormatting` request.
+---@field onTypeFormatting? lsp.DocumentOnTypeFormattingClientCapabilities
+---Capabilities specific to the `textDocument/rename` request.
+---@field rename? lsp.RenameClientCapabilities
+---Capabilities specific to the `textDocument/foldingRange` request.
+---
+---@since 3.10.0
+---@field foldingRange? lsp.FoldingRangeClientCapabilities
+---Capabilities specific to the `textDocument/selectionRange` request.
+---
+---@since 3.15.0
+---@field selectionRange? lsp.SelectionRangeClientCapabilities
+---Capabilities specific to the `textDocument/publishDiagnostics` notification.
+---@field publishDiagnostics? lsp.PublishDiagnosticsClientCapabilities
+---Capabilities specific to the various call hierarchy requests.
+---
+---@since 3.16.0
+---@field callHierarchy? lsp.CallHierarchyClientCapabilities
+---Capabilities specific to the various semantic token request.
+---
+---@since 3.16.0
+---@field semanticTokens? lsp.SemanticTokensClientCapabilities
+---Capabilities specific to the `textDocument/linkedEditingRange` request.
+---
+---@since 3.16.0
+---@field linkedEditingRange? lsp.LinkedEditingRangeClientCapabilities
+---Client capabilities specific to the `textDocument/moniker` request.
+---
+---@since 3.16.0
+---@field moniker? lsp.MonikerClientCapabilities
+---Capabilities specific to the various type hierarchy requests.
+---
+---@since 3.17.0
+---@field typeHierarchy? lsp.TypeHierarchyClientCapabilities
+---Capabilities specific to the `textDocument/inlineValue` request.
+---
+---@since 3.17.0
+---@field inlineValue? lsp.InlineValueClientCapabilities
+---Capabilities specific to the `textDocument/inlayHint` request.
+---
+---@since 3.17.0
+---@field inlayHint? lsp.InlayHintClientCapabilities
+---Capabilities specific to the diagnostic pull model.
+---
+---@since 3.17.0
+---@field diagnostic? lsp.DiagnosticClientCapabilities
+---Client capabilities specific to inline completions.
+---
+---@since 3.18.0
+---@field inlineCompletion? lsp.InlineCompletionClientCapabilities
+
+---Capabilities specific to the notebook document support.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentClientCapabilities
+---Capabilities specific to notebook document synchronization
+---
+---@since 3.17.0
+---@field synchronization lsp.NotebookDocumentSyncClientCapabilities
+
+---@class lsp.WindowClientCapabilities
+---It indicates whether the client supports server initiated
+---progress using the `window/workDoneProgress/create` request.
+---
+---The capability also controls Whether client supports handling
+---of progress notifications. If set servers are allowed to report a
+---`workDoneProgress` property in the request specific server
+---capabilities.
+---
+---@since 3.15.0
+---@field workDoneProgress? boolean
+---Capabilities specific to the showMessage request.
+---
+---@since 3.16.0
+---@field showMessage? lsp.ShowMessageRequestClientCapabilities
+---Capabilities specific to the showDocument request.
+---
+---@since 3.16.0
+---@field showDocument? lsp.ShowDocumentClientCapabilities
+
+---General client capabilities.
+---
+---@since 3.16.0
+---@class lsp.GeneralClientCapabilities
+---Client capability that signals how the client
+---handles stale requests (e.g. a request
+---for which the client will not process the response
+---anymore since the information is outdated).
+---
+---@since 3.17.0
+---@field staleRequestSupport? anonym18
+---Client capabilities specific to regular expressions.
+---
+---@since 3.16.0
+---@field regularExpressions? lsp.RegularExpressionsClientCapabilities
+---Client capabilities specific to the client's markdown parser.
+---
+---@since 3.16.0
+---@field markdown? lsp.MarkdownClientCapabilities
+---The position encodings supported by the client. Client and server
+---have to agree on the same position encoding to ensure that offsets
+---(e.g. character position in a line) are interpreted the same on both
+---sides.
+---
+---To keep the protocol backwards compatible the following applies: if
+---the value 'utf-16' is missing from the array of position encodings
+---servers can assume that the client supports UTF-16. UTF-16 is
+---therefore a mandatory encoding.
+---
+---If omitted it defaults to ['utf-16'].
+---
+---Implementation considerations: since the conversion from one encoding
+---into another requires the content of the file / line the conversion
+---is best done where the file is read which is usually on the server
+---side.
+---
+---@since 3.17.0
+---@field positionEncodings? lsp.PositionEncodingKind[]
+
+---A relative pattern is a helper to construct glob patterns that are matched
+---relatively to a base URI. The common value for a `baseUri` is a workspace
+---folder root, but it can be another absolute URI as well.
+---
+---@since 3.17.0
+---@class lsp.RelativePattern
+---A workspace folder or a base URI to which this pattern will be matched
+---against relatively.
+---@field baseUri lsp.WorkspaceFolder|lsp.URI
+---The actual glob pattern;
+---@field pattern lsp.Pattern
+
+---@class lsp.WorkspaceEditClientCapabilities
+---The client supports versioned document changes in `WorkspaceEdit`s
+---@field documentChanges? boolean
+---The resource operations the client supports. Clients should at least
+---support 'create', 'rename' and 'delete' files and folders.
+---
+---@since 3.13.0
+---@field resourceOperations? lsp.ResourceOperationKind[]
+---The failure handling strategy of a client if applying the workspace edit
+---fails.
+---
+---@since 3.13.0
+---@field failureHandling? lsp.FailureHandlingKind
+---Whether the client normalizes line endings to the client specific
+---setting.
+---If set to `true` the client will normalize line ending characters
+---in a workspace edit to the client-specified new line
+---character.
+---
+---@since 3.16.0
+---@field normalizesLineEndings? boolean
+---Whether the client in general supports change annotations on text edits,
+---create file, rename file and delete file changes.
+---
+---@since 3.16.0
+---@field changeAnnotationSupport? anonym19
+
+---@class lsp.DidChangeConfigurationClientCapabilities
+---Did change configuration notification supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---@class lsp.DidChangeWatchedFilesClientCapabilities
+---Did change watched files notification supports dynamic registration. Please note
+---that the current protocol doesn't support static configuration for file changes
+---from the server side.
+---@field dynamicRegistration? boolean
+---Whether the client has support for {@link  RelativePattern relative pattern}
+---or not.
+---
+---@since 3.17.0
+---@field relativePatternSupport? boolean
+
+---Client capabilities for a {@link WorkspaceSymbolRequest}.
+---@class lsp.WorkspaceSymbolClientCapabilities
+---Symbol request supports dynamic registration.
+---@field dynamicRegistration? boolean
+---Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
+---@field symbolKind? anonym20
+---The client supports tags on `SymbolInformation`.
+---Clients supporting tags have to handle unknown tags gracefully.
+---
+---@since 3.16.0
+---@field tagSupport? anonym21
+---The client support partial workspace symbols. The client will send the
+---request `workspaceSymbol/resolve` to the server to resolve additional
+---properties.
+---
+---@since 3.17.0
+---@field resolveSupport? anonym22
+
+---The client capabilities of a {@link ExecuteCommandRequest}.
+---@class lsp.ExecuteCommandClientCapabilities
+---Execute command supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---@since 3.16.0
+---@class lsp.SemanticTokensWorkspaceClientCapabilities
+---Whether the client implementation supports a refresh request sent from
+---the server to the client.
+---
+---Note that this event is global and will force the client to refresh all
+---semantic tokens currently shown. It should be used with absolute care
+---and is useful for situation where a server for example detects a project
+---wide change that requires such a calculation.
+---@field refreshSupport? boolean
+
+---@since 3.16.0
+---@class lsp.CodeLensWorkspaceClientCapabilities
+---Whether the client implementation supports a refresh request sent from the
+---server to the client.
+---
+---Note that this event is global and will force the client to refresh all
+---code lenses currently shown. It should be used with absolute care and is
+---useful for situation where a server for example detect a project wide
+---change that requires such a calculation.
+---@field refreshSupport? boolean
+
+---Capabilities relating to events from file operations by the user in the client.
+---
+---These events do not come from the file system, they come from user operations
+---like renaming a file in the UI.
+---
+---@since 3.16.0
+---@class lsp.FileOperationClientCapabilities
+---Whether the client supports dynamic registration for file requests/notifications.
+---@field dynamicRegistration? boolean
+---The client has support for sending didCreateFiles notifications.
+---@field didCreate? boolean
+---The client has support for sending willCreateFiles requests.
+---@field willCreate? boolean
+---The client has support for sending didRenameFiles notifications.
+---@field didRename? boolean
+---The client has support for sending willRenameFiles requests.
+---@field willRename? boolean
+---The client has support for sending didDeleteFiles notifications.
+---@field didDelete? boolean
+---The client has support for sending willDeleteFiles requests.
+---@field willDelete? boolean
+
+---Client workspace capabilities specific to inline values.
+---
+---@since 3.17.0
+---@class lsp.InlineValueWorkspaceClientCapabilities
+---Whether the client implementation supports a refresh request sent from the
+---server to the client.
+---
+---Note that this event is global and will force the client to refresh all
+---inline values currently shown. It should be used with absolute care and is
+---useful for situation where a server for example detects a project wide
+---change that requires such a calculation.
+---@field refreshSupport? boolean
+
+---Client workspace capabilities specific to inlay hints.
+---
+---@since 3.17.0
+---@class lsp.InlayHintWorkspaceClientCapabilities
+---Whether the client implementation supports a refresh request sent from
+---the server to the client.
+---
+---Note that this event is global and will force the client to refresh all
+---inlay hints currently shown. It should be used with absolute care and
+---is useful for situation where a server for example detects a project wide
+---change that requires such a calculation.
+---@field refreshSupport? boolean
+
+---Workspace client capabilities specific to diagnostic pull requests.
+---
+---@since 3.17.0
+---@class lsp.DiagnosticWorkspaceClientCapabilities
+---Whether the client implementation supports a refresh request sent from
+---the server to the client.
+---
+---Note that this event is global and will force the client to refresh all
+---pulled diagnostics currently shown. It should be used with absolute care and
+---is useful for situation where a server for example detects a project wide
+---change that requires such a calculation.
+---@field refreshSupport? boolean
+
+---@class lsp.TextDocumentSyncClientCapabilities
+---Whether text document synchronization supports dynamic registration.
+---@field dynamicRegistration? boolean
+---The client supports sending will save notifications.
+---@field willSave? boolean
+---The client supports sending a will save request and
+---waits for a response providing text edits which will
+---be applied to the document before it is saved.
+---@field willSaveWaitUntil? boolean
+---The client supports did save notifications.
+---@field didSave? boolean
+
+---Completion client capabilities
+---@class lsp.CompletionClientCapabilities
+---Whether completion supports dynamic registration.
+---@field dynamicRegistration? boolean
+---The client supports the following `CompletionItem` specific
+---capabilities.
+---@field completionItem? anonym26
+---@field completionItemKind? anonym27
+---Defines how the client handles whitespace and indentation
+---when accepting a completion item that uses multi line
+---text in either `insertText` or `textEdit`.
+---
+---@since 3.17.0
+---@field insertTextMode? lsp.InsertTextMode
+---The client supports to send additional context information for a
+---`textDocument/completion` request.
+---@field contextSupport? boolean
+---The client supports the following `CompletionList` specific
+---capabilities.
+---
+---@since 3.17.0
+---@field completionList? anonym28
+
+---@class lsp.HoverClientCapabilities
+---Whether hover supports dynamic registration.
+---@field dynamicRegistration? boolean
+---Client supports the following content formats for the content
+---property. The order describes the preferred format of the client.
+---@field contentFormat? lsp.MarkupKind[]
+
+---Client Capabilities for a {@link SignatureHelpRequest}.
+---@class lsp.SignatureHelpClientCapabilities
+---Whether signature help supports dynamic registration.
+---@field dynamicRegistration? boolean
+---The client supports the following `SignatureInformation`
+---specific properties.
+---@field signatureInformation? anonym30
+---The client supports to send additional context information for a
+---`textDocument/signatureHelp` request. A client that opts into
+---contextSupport will also support the `retriggerCharacters` on
+---`SignatureHelpOptions`.
+---
+---@since 3.15.0
+---@field contextSupport? boolean
+
+---@since 3.14.0
+---@class lsp.DeclarationClientCapabilities
+---Whether declaration supports dynamic registration. If this is set to `true`
+---the client supports the new `DeclarationRegistrationOptions` return value
+---for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---The client supports additional metadata in the form of declaration links.
+---@field linkSupport? boolean
+
+---Client Capabilities for a {@link DefinitionRequest}.
+---@class lsp.DefinitionClientCapabilities
+---Whether definition supports dynamic registration.
+---@field dynamicRegistration? boolean
+---The client supports additional metadata in the form of definition links.
+---
+---@since 3.14.0
+---@field linkSupport? boolean
+
+---Since 3.6.0
+---@class lsp.TypeDefinitionClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `TypeDefinitionRegistrationOptions` return value
+---for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---The client supports additional metadata in the form of definition links.
+---
+---Since 3.14.0
+---@field linkSupport? boolean
+
+---@since 3.6.0
+---@class lsp.ImplementationClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `ImplementationRegistrationOptions` return value
+---for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---The client supports additional metadata in the form of definition links.
+---
+---@since 3.14.0
+---@field linkSupport? boolean
+
+---Client Capabilities for a {@link ReferencesRequest}.
+---@class lsp.ReferenceClientCapabilities
+---Whether references supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---Client Capabilities for a {@link DocumentHighlightRequest}.
+---@class lsp.DocumentHighlightClientCapabilities
+---Whether document highlight supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---Client Capabilities for a {@link DocumentSymbolRequest}.
+---@class lsp.DocumentSymbolClientCapabilities
+---Whether document symbol supports dynamic registration.
+---@field dynamicRegistration? boolean
+---Specific capabilities for the `SymbolKind` in the
+---`textDocument/documentSymbol` request.
+---@field symbolKind? anonym31
+---The client supports hierarchical document symbols.
+---@field hierarchicalDocumentSymbolSupport? boolean
+---The client supports tags on `SymbolInformation`. Tags are supported on
+---`DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true.
+---Clients supporting tags have to handle unknown tags gracefully.
+---
+---@since 3.16.0
+---@field tagSupport? anonym32
+---The client supports an additional label presented in the UI when
+---registering a document symbol provider.
+---
+---@since 3.16.0
+---@field labelSupport? boolean
+
+---The Client Capabilities of a {@link CodeActionRequest}.
+---@class lsp.CodeActionClientCapabilities
+---Whether code action supports dynamic registration.
+---@field dynamicRegistration? boolean
+---The client support code action literals of type `CodeAction` as a valid
+---response of the `textDocument/codeAction` request. If the property is not
+---set the request can only return `Command` literals.
+---
+---@since 3.8.0
+---@field codeActionLiteralSupport? anonym34
+---Whether code action supports the `isPreferred` property.
+---
+---@since 3.15.0
+---@field isPreferredSupport? boolean
+---Whether code action supports the `disabled` property.
+---
+---@since 3.16.0
+---@field disabledSupport? boolean
+---Whether code action supports the `data` property which is
+---preserved between a `textDocument/codeAction` and a
+---`codeAction/resolve` request.
+---
+---@since 3.16.0
+---@field dataSupport? boolean
+---Whether the client supports resolving additional code action
+---properties via a separate `codeAction/resolve` request.
+---
+---@since 3.16.0
+---@field resolveSupport? anonym35
+---Whether the client honors the change annotations in
+---text edits and resource operations returned via the
+---`CodeAction#edit` property by for example presenting
+---the workspace edit in the user interface and asking
+---for confirmation.
+---
+---@since 3.16.0
+---@field honorsChangeAnnotations? boolean
+
+---The client capabilities  of a {@link CodeLensRequest}.
+---@class lsp.CodeLensClientCapabilities
+---Whether code lens supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---The client capabilities of a {@link DocumentLinkRequest}.
+---@class lsp.DocumentLinkClientCapabilities
+---Whether document link supports dynamic registration.
+---@field dynamicRegistration? boolean
+---Whether the client supports the `tooltip` property on `DocumentLink`.
+---
+---@since 3.15.0
+---@field tooltipSupport? boolean
+
+---@class lsp.DocumentColorClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `DocumentColorRegistrationOptions` return value
+---for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+
+---Client capabilities of a {@link DocumentFormattingRequest}.
+---@class lsp.DocumentFormattingClientCapabilities
+---Whether formatting supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---Client capabilities of a {@link DocumentRangeFormattingRequest}.
+---@class lsp.DocumentRangeFormattingClientCapabilities
+---Whether range formatting supports dynamic registration.
+---@field dynamicRegistration? boolean
+---Whether the client supports formatting multiple ranges at once.
+---
+---@since 3.18.0
+---@proposed
+---@field rangesSupport? boolean
+
+---Client capabilities of a {@link DocumentOnTypeFormattingRequest}.
+---@class lsp.DocumentOnTypeFormattingClientCapabilities
+---Whether on type formatting supports dynamic registration.
+---@field dynamicRegistration? boolean
+
+---@class lsp.RenameClientCapabilities
+---Whether rename supports dynamic registration.
+---@field dynamicRegistration? boolean
+---Client supports testing for validity of rename operations
+---before execution.
+---
+---@since 3.12.0
+---@field prepareSupport? boolean
+---Client supports the default behavior result.
+---
+---The value indicates the default behavior used by the
+---client.
+---
+---@since 3.16.0
+---@field prepareSupportDefaultBehavior? lsp.PrepareSupportDefaultBehavior
+---Whether the client honors the change annotations in
+---text edits and resource operations returned via the
+---rename request's workspace edit by for example presenting
+---the workspace edit in the user interface and asking
+---for confirmation.
+---
+---@since 3.16.0
+---@field honorsChangeAnnotations? boolean
+
+---@class lsp.FoldingRangeClientCapabilities
+---Whether implementation supports dynamic registration for folding range
+---providers. If this is set to `true` the client supports the new
+---`FoldingRangeRegistrationOptions` return value for the corresponding
+---server capability as well.
+---@field dynamicRegistration? boolean
+---The maximum number of folding ranges that the client prefers to receive
+---per document. The value serves as a hint, servers are free to follow the
+---limit.
+---@field rangeLimit? uinteger
+---If set, the client signals that it only supports folding complete lines.
+---If set, client will ignore specified `startCharacter` and `endCharacter`
+---properties in a FoldingRange.
+---@field lineFoldingOnly? boolean
+---Specific options for the folding range kind.
+---
+---@since 3.17.0
+---@field foldingRangeKind? anonym36
+---Specific options for the folding range.
+---
+---@since 3.17.0
+---@field foldingRange? anonym37
+
+---@class lsp.SelectionRangeClientCapabilities
+---Whether implementation supports dynamic registration for selection range providers. If this is set to `true`
+---the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server
+---capability as well.
+---@field dynamicRegistration? boolean
+
+---The publish diagnostic client capabilities.
+---@class lsp.PublishDiagnosticsClientCapabilities
+---Whether the clients accepts diagnostics with related information.
+---@field relatedInformation? boolean
+---Client supports the tag property to provide meta data about a diagnostic.
+---Clients supporting tags have to handle unknown tags gracefully.
+---
+---@since 3.15.0
+---@field tagSupport? anonym38
+---Whether the client interprets the version property of the
+---`textDocument/publishDiagnostics` notification's parameter.
+---
+---@since 3.15.0
+---@field versionSupport? boolean
+---Client supports a codeDescription property
+---
+---@since 3.16.0
+---@field codeDescriptionSupport? boolean
+---Whether code action supports the `data` property which is
+---preserved between a `textDocument/publishDiagnostics` and
+---`textDocument/codeAction` request.
+---
+---@since 3.16.0
+---@field dataSupport? boolean
+
+---@since 3.16.0
+---@class lsp.CallHierarchyClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+
+---@since 3.16.0
+---@class lsp.SemanticTokensClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---Which requests the client supports and might send to the server
+---depending on the server's capability. Please note that clients might not
+---show semantic tokens or degrade some of the user experience if a range
+---or full request is advertised by the client but not provided by the
+---server. If for example the client capability `requests.full` and
+---`request.range` are both set to true but the server only provides a
+---range provider the client might not render a minimap correctly or might
+---even decide to not show any semantic tokens at all.
+---@field requests anonym41
+---The token types that the client supports.
+---@field tokenTypes string[]
+---The token modifiers that the client supports.
+---@field tokenModifiers string[]
+---The token formats the clients supports.
+---@field formats lsp.TokenFormat[]
+---Whether the client supports tokens that can overlap each other.
+---@field overlappingTokenSupport? boolean
+---Whether the client supports tokens that can span multiple lines.
+---@field multilineTokenSupport? boolean
+---Whether the client allows the server to actively cancel a
+---semantic token request, e.g. supports returning
+---LSPErrorCodes.ServerCancelled. If a server does the client
+---needs to retrigger the request.
+---
+---@since 3.17.0
+---@field serverCancelSupport? boolean
+---Whether the client uses semantic tokens to augment existing
+---syntax tokens. If set to `true` client side created syntax
+---tokens and semantic tokens are both used for colorization. If
+---set to `false` the client only uses the returned semantic tokens
+---for colorization.
+---
+---If the value is `undefined` then the client behavior is not
+---specified.
+---
+---@since 3.17.0
+---@field augmentsSyntaxTokens? boolean
+
+---Client capabilities for the linked editing range request.
+---
+---@since 3.16.0
+---@class lsp.LinkedEditingRangeClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+
+---Client capabilities specific to the moniker request.
+---
+---@since 3.16.0
+---@class lsp.MonikerClientCapabilities
+---Whether moniker supports dynamic registration. If this is set to `true`
+---the client supports the new `MonikerRegistrationOptions` return value
+---for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+
+---@since 3.17.0
+---@class lsp.TypeHierarchyClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+
+---Client capabilities specific to inline values.
+---
+---@since 3.17.0
+---@class lsp.InlineValueClientCapabilities
+---Whether implementation supports dynamic registration for inline value providers.
+---@field dynamicRegistration? boolean
+
+---Inlay hint client capabilities.
+---
+---@since 3.17.0
+---@class lsp.InlayHintClientCapabilities
+---Whether inlay hints support dynamic registration.
+---@field dynamicRegistration? boolean
+---Indicates which properties a client can resolve lazily on an inlay
+---hint.
+---@field resolveSupport? anonym42
+
+---Client capabilities specific to diagnostic pull requests.
+---
+---@since 3.17.0
+---@class lsp.DiagnosticClientCapabilities
+---Whether implementation supports dynamic registration. If this is set to `true`
+---the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---Whether the clients supports related documents for document diagnostic pulls.
+---@field relatedDocumentSupport? boolean
+
+---Client capabilities specific to inline completions.
+---
+---@since 3.18.0
+---@class lsp.InlineCompletionClientCapabilities
+---Whether implementation supports dynamic registration for inline completion providers.
+---@field dynamicRegistration? boolean
+
+---Notebook specific client capabilities.
+---
+---@since 3.17.0
+---@class lsp.NotebookDocumentSyncClientCapabilities
+---Whether implementation supports dynamic registration. If this is
+---set to `true` the client supports the new
+---`(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
+---return value for the corresponding server capability as well.
+---@field dynamicRegistration? boolean
+---The client supports sending execution summary data per cell.
+---@field executionSummarySupport? boolean
+
+---Show message request client capabilities
+---@class lsp.ShowMessageRequestClientCapabilities
+---Capabilities specific to the `MessageActionItem` type.
+---@field messageActionItem? anonym43
+
+---Client capabilities for the showDocument request.
+---
+---@since 3.16.0
+---@class lsp.ShowDocumentClientCapabilities
+---The client has support for the showDocument
+---request.
+---@field support boolean
+
+---Client capabilities specific to regular expressions.
+---
+---@since 3.16.0
+---@class lsp.RegularExpressionsClientCapabilities
+---The engine's name.
+---@field engine string
+---The engine's version.
+---@field version? string
+
+---Client capabilities specific to the used markdown parser.
+---
+---@since 3.16.0
+---@class lsp.MarkdownClientCapabilities
+---The name of the parser.
+---@field parser string
+---The version of the parser.
+---@field version? string
+---A list of HTML tags that the client allows / supports in
+---Markdown.
+---
+---@since 3.17.0
+---@field allowedTags? string[]
+
+---A set of predefined token types. This set is not fixed
+---an clients can specify additional token types via the
+---corresponding client capabilities.
+---
+---@since 3.16.0
+---@alias lsp.SemanticTokenTypes
+---| "namespace" # namespace
+---| "type" # type
+---| "class" # class
+---| "enum" # enum
+---| "interface" # interface
+---| "struct" # struct
+---| "typeParameter" # typeParameter
+---| "parameter" # parameter
+---| "variable" # variable
+---| "property" # property
+---| "enumMember" # enumMember
+---| "event" # event
+---| "function" # function
+---| "method" # method
+---| "macro" # macro
+---| "keyword" # keyword
+---| "modifier" # modifier
+---| "comment" # comment
+---| "string" # string
+---| "number" # number
+---| "regexp" # regexp
+---| "operator" # operator
+---| "decorator" # decorator
+
+---A set of predefined token modifiers. This set is not fixed
+---an clients can specify additional token types via the
+---corresponding client capabilities.
+---
+---@since 3.16.0
+---@alias lsp.SemanticTokenModifiers
+---| "declaration" # declaration
+---| "definition" # definition
+---| "readonly" # readonly
+---| "static" # static
+---| "deprecated" # deprecated
+---| "abstract" # abstract
+---| "async" # async
+---| "modification" # modification
+---| "documentation" # documentation
+---| "defaultLibrary" # defaultLibrary
+
+---The document diagnostic report kinds.
+---
+---@since 3.17.0
+---@alias lsp.DocumentDiagnosticReportKind
+---| "full" # Full
+---| "unchanged" # Unchanged
+
+---Predefined error codes.
+---@alias lsp.ErrorCodes
+---| -32700 # ParseError
+---| -32600 # InvalidRequest
+---| -32601 # MethodNotFound
+---| -32602 # InvalidParams
+---| -32603 # InternalError
+---| -32002 # ServerNotInitialized
+---| -32001 # UnknownErrorCode
+
+---@alias lsp.LSPErrorCodes
+---| -32803 # RequestFailed
+---| -32802 # ServerCancelled
+---| -32801 # ContentModified
+---| -32800 # RequestCancelled
+
+---A set of predefined range kinds.
+---@alias lsp.FoldingRangeKind
+---| "comment" # Comment
+---| "imports" # Imports
+---| "region" # Region
+
+---A symbol kind.
+---@alias lsp.SymbolKind
+---| 1 # File
+---| 2 # Module
+---| 3 # Namespace
+---| 4 # Package
+---| 5 # Class
+---| 6 # Method
+---| 7 # Property
+---| 8 # Field
+---| 9 # Constructor
+---| 10 # Enum
+---| 11 # Interface
+---| 12 # Function
+---| 13 # Variable
+---| 14 # Constant
+---| 15 # String
+---| 16 # Number
+---| 17 # Boolean
+---| 18 # Array
+---| 19 # Object
+---| 20 # Key
+---| 21 # Null
+---| 22 # EnumMember
+---| 23 # Struct
+---| 24 # Event
+---| 25 # Operator
+---| 26 # TypeParameter
+
+---Symbol tags are extra annotations that tweak the rendering of a symbol.
+---
+---@since 3.16
+---@alias lsp.SymbolTag
+---| 1 # Deprecated
+
+---Moniker uniqueness level to define scope of the moniker.
+---
+---@since 3.16.0
+---@alias lsp.UniquenessLevel
+---| "document" # document
+---| "project" # project
+---| "group" # group
+---| "scheme" # scheme
+---| "global" # global
+
+---The moniker kind.
+---
+---@since 3.16.0
+---@alias lsp.MonikerKind
+---| "import" # import
+---| "export" # export
+---| "local" # local
+
+---Inlay hint kinds.
+---
+---@since 3.17.0
+---@alias lsp.InlayHintKind
+---| 1 # Type
+---| 2 # Parameter
+
+---Defines whether the insert text in a completion item should be interpreted as
+---plain text or a snippet.
+---@alias lsp.InsertTextFormat
+---| 1 # PlainText
+---| 2 # Snippet
+
+---The message type
+---@alias lsp.MessageType
+---| 1 # Error
+---| 2 # Warning
+---| 3 # Info
+---| 4 # Log
+
+---Defines how the host (editor) should sync
+---document changes to the language server.
+---@alias lsp.TextDocumentSyncKind
+---| 0 # None
+---| 1 # Full
+---| 2 # Incremental
+
+---Represents reasons why a text document is saved.
+---@alias lsp.TextDocumentSaveReason
+---| 1 # Manual
+---| 2 # AfterDelay
+---| 3 # FocusOut
+
+---The kind of a completion entry.
+---@alias lsp.CompletionItemKind
+---| 1 # Text
+---| 2 # Method
+---| 3 # Function
+---| 4 # Constructor
+---| 5 # Field
+---| 6 # Variable
+---| 7 # Class
+---| 8 # Interface
+---| 9 # Module
+---| 10 # Property
+---| 11 # Unit
+---| 12 # Value
+---| 13 # Enum
+---| 14 # Keyword
+---| 15 # Snippet
+---| 16 # Color
+---| 17 # File
+---| 18 # Reference
+---| 19 # Folder
+---| 20 # EnumMember
+---| 21 # Constant
+---| 22 # Struct
+---| 23 # Event
+---| 24 # Operator
+---| 25 # TypeParameter
+
+---Completion item tags are extra annotations that tweak the rendering of a completion
+---item.
+---
+---@since 3.15.0
+---@alias lsp.CompletionItemTag
+---| 1 # Deprecated
+
+---How whitespace and indentation is handled during completion
+---item insertion.
+---
+---@since 3.16.0
+---@alias lsp.InsertTextMode
+---| 1 # asIs
+---| 2 # adjustIndentation
+
+---A document highlight kind.
+---@alias lsp.DocumentHighlightKind
+---| 1 # Text
+---| 2 # Read
+---| 3 # Write
+
+---A set of predefined code action kinds
+---@alias lsp.CodeActionKind
+---| "" # Empty
+---| "quickfix" # QuickFix
+---| "refactor" # Refactor
+---| "refactor.extract" # RefactorExtract
+---| "refactor.inline" # RefactorInline
+---| "refactor.rewrite" # RefactorRewrite
+---| "source" # Source
+---| "source.organizeImports" # SourceOrganizeImports
+---| "source.fixAll" # SourceFixAll
+
+---@alias lsp.TraceValues
+---| "off" # Off
+---| "messages" # Messages
+---| "verbose" # Verbose
+
+---Describes the content type that a client supports in various
+---result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
+---
+---Please note that `MarkupKinds` must not start with a `$`. This kinds
+---are reserved for internal usage.
+---@alias lsp.MarkupKind
+---| "plaintext" # PlainText
+---| "markdown" # Markdown
+
+---Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
+---
+---@since 3.18.0
+---@alias lsp.InlineCompletionTriggerKind
+---| 0 # Invoked
+---| 1 # Automatic
+
+---A set of predefined position encoding kinds.
+---
+---@since 3.17.0
+---@alias lsp.PositionEncodingKind
+---| "utf-8" # UTF8
+---| "utf-16" # UTF16
+---| "utf-32" # UTF32
+
+---The file event type
+---@alias lsp.FileChangeType
+---| 1 # Created
+---| 2 # Changed
+---| 3 # Deleted
+
+---@alias lsp.WatchKind
+---| 1 # Create
+---| 2 # Change
+---| 4 # Delete
+
+---The diagnostic's severity.
+---@alias lsp.DiagnosticSeverity
+---| 1 # Error
+---| 2 # Warning
+---| 3 # Information
+---| 4 # Hint
+
+---The diagnostic tags.
+---
+---@since 3.15.0
+---@alias lsp.DiagnosticTag
+---| 1 # Unnecessary
+---| 2 # Deprecated
+
+---How a completion was triggered
+---@alias lsp.CompletionTriggerKind
+---| 1 # Invoked
+---| 2 # TriggerCharacter
+---| 3 # TriggerForIncompleteCompletions
+
+---How a signature help was triggered.
+---
+---@since 3.15.0
+---@alias lsp.SignatureHelpTriggerKind
+---| 1 # Invoked
+---| 2 # TriggerCharacter
+---| 3 # ContentChange
+
+---The reason why code actions were requested.
+---
+---@since 3.17.0
+---@alias lsp.CodeActionTriggerKind
+---| 1 # Invoked
+---| 2 # Automatic
+
+---A pattern kind describing if a glob pattern matches a file a folder or
+---both.
+---
+---@since 3.16.0
+---@alias lsp.FileOperationPatternKind
+---| "file" # file
+---| "folder" # folder
+
+---A notebook cell kind.
+---
+---@since 3.17.0
+---@alias lsp.NotebookCellKind
+---| 1 # Markup
+---| 2 # Code
+
+---@alias lsp.ResourceOperationKind
+---| "create" # Create
+---| "rename" # Rename
+---| "delete" # Delete
+
+---@alias lsp.FailureHandlingKind
+---| "abort" # Abort
+---| "transactional" # Transactional
+---| "textOnlyTransactional" # TextOnlyTransactional
+---| "undo" # Undo
+
+---@alias lsp.PrepareSupportDefaultBehavior
+---| 1 # Identifier
+
+---@alias lsp.TokenFormat
+---| "relative" # Relative
+
+---The definition of a symbol represented as one or many {@link Location locations}.
+---For most programming languages there is only one location at which a symbol is
+---defined.
+---
+---Servers should prefer returning `DefinitionLink` over `Definition` if supported
+---by the client.
+---@alias lsp.Definition lsp.Location|lsp.Location[]
+
+---Information about where a symbol is defined.
+---
+---Provides additional metadata over normal {@link Location location} definitions, including the range of
+---the defining symbol
+---@alias lsp.DefinitionLink lsp.LocationLink
+
+---LSP arrays.
+---@since 3.17.0
+---@alias lsp.LSPArray lsp.LSPAny[]
+
+---The LSP any type.
+---Please note that strictly speaking a property with the value `undefined`
+---can't be converted into JSON preserving the property name. However for
+---convenience it is allowed and assumed that all these properties are
+---optional as well.
+---@since 3.17.0
+---@alias lsp.LSPAny lsp.LSPObject|lsp.LSPArray|string|integer|uinteger|decimal|boolean|lsp.null
+
+---The declaration of a symbol representation as one or many {@link Location locations}.
+---@alias lsp.Declaration lsp.Location|lsp.Location[]
+
+---Information about where a symbol is declared.
+---
+---Provides additional metadata over normal {@link Location location} declarations, including the range of
+---the declaring symbol.
+---
+---Servers should prefer returning `DeclarationLink` over `Declaration` if supported
+---by the client.
+---@alias lsp.DeclarationLink lsp.LocationLink
+
+---Inline value information can be provided by different means:
+---- directly as a text value (class InlineValueText).
+---- as a name to use for a variable lookup (class InlineValueVariableLookup)
+---- as an evaluatable expression (class InlineValueEvaluatableExpression)
+---The InlineValue types combines all inline value types into one type.
+---
+---@since 3.17.0
+---@alias lsp.InlineValue lsp.InlineValueText|lsp.InlineValueVariableLookup|lsp.InlineValueEvaluatableExpression
+
+---The result of a document diagnostic pull request. A report can
+---either be a full report containing all diagnostics for the
+---requested document or an unchanged report indicating that nothing
+---has changed in terms of diagnostics in comparison to the last
+---pull request.
+---
+---@since 3.17.0
+---@alias lsp.DocumentDiagnosticReport lsp.RelatedFullDocumentDiagnosticReport|lsp.RelatedUnchangedDocumentDiagnosticReport
+
+---@alias lsp.PrepareRenameResult lsp.Range|anonym44|anonym45
+
+---A document selector is the combination of one or many document filters.
+---
+---@sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;
+---
+---The use of a string as a document filter is deprecated @since 3.16.0.
+---@alias lsp.DocumentSelector lsp.DocumentFilter[]
+
+---@alias lsp.ProgressToken integer|string
+
+---An identifier to refer to a change annotation stored with a workspace edit.
+---@alias lsp.ChangeAnnotationIdentifier string
+
+---A workspace diagnostic document report.
+---
+---@since 3.17.0
+---@alias lsp.WorkspaceDocumentDiagnosticReport lsp.WorkspaceFullDocumentDiagnosticReport|lsp.WorkspaceUnchangedDocumentDiagnosticReport
+
+---An event describing a change to a text document. If only a text is provided
+---it is considered to be the full content of the document.
+---@alias lsp.TextDocumentContentChangeEvent anonym46|anonym47
+
+---MarkedString can be used to render human readable text. It is either a markdown string
+---or a code-block that provides a language and a code snippet. The language identifier
+---is semantically equal to the optional language identifier in fenced code blocks in GitHub
+---issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
+---
+---The pair of a language and a value is an equivalent to markdown:
+---```${language}
+---${value}
+---```
+---
+---Note that markdown strings will be sanitized - that means html will be escaped.
+---@deprecated use MarkupContent instead.
+---@alias lsp.MarkedString string|anonym48
+
+---A document filter describes a top level text document or
+---a notebook cell document.
+---
+---@since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
+---@alias lsp.DocumentFilter lsp.TextDocumentFilter|lsp.NotebookCellTextDocumentFilter
+
+---LSP object definition.
+---@since 3.17.0
+---@alias lsp.LSPObject table<string, lsp.LSPAny>
+
+---The glob pattern. Either a string pattern or a relative pattern.
+---
+---@since 3.17.0
+---@alias lsp.GlobPattern lsp.Pattern|lsp.RelativePattern
+
+---A document filter denotes a document by different properties like
+---the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of
+---its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
+---
+---Glob patterns can have the following syntax:
+---- `*` to match one or more characters in a path segment
+---- `?` to match on one character in a path segment
+---- `**` to match any number of path segments, including none
+---- `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+---
+---@sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
+---@sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
+---
+---@since 3.17.0
+---@alias lsp.TextDocumentFilter anonym49|anonym50|anonym51
+
+---A notebook document filter denotes a notebook document by
+---different properties. The properties will be match
+---against the notebook's URI (same as with documents)
+---
+---@since 3.17.0
+---@alias lsp.NotebookDocumentFilter anonym52|anonym53|anonym54
+
+---The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
+---- `*` to match one or more characters in a path segment
+---- `?` to match on one character in a path segment
+---- `**` to match any number of path segments, including none
+---- `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
+---- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
+---- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
+---
+---@since 3.17.0
+---@alias lsp.Pattern string
+
+---@class anonym1
+---The name of the server as defined by the server.
+---@field name string
+---The server's version as defined by the server.
+---@field version? string
+
+---@class anonym3
+---@field insert lsp.Range
+---@field replace lsp.Range
+
+---@class anonym2
+---A default commit character set.
+---
+---@since 3.17.0
+---@field commitCharacters? string[]
+---A default edit range.
+---
+---@since 3.17.0
+---@field editRange? lsp.Range|anonym3
+---A default insert text format.
+---
+---@since 3.17.0
+---@field insertTextFormat? lsp.InsertTextFormat
+---A default insert text mode.
+---
+---@since 3.17.0
+---@field insertTextMode? lsp.InsertTextMode
+---A default data value.
+---
+---@since 3.17.0
+---@field data? lsp.LSPAny
+
+---@class anonym4
+---Human readable description of why the code action is currently disabled.
+---
+---This is displayed in the code actions UI.
+---@field reason string
+
+---@class anonym5
+---@field uri lsp.DocumentUri
+
+---@class anonym6
+
+---@class anonym7
+---The server supports deltas for full documents.
+---@field delta? boolean
+
+---@class anonym9
+---The change to the cell array.
+---@field array lsp.NotebookCellArrayChange
+---Additional opened cell text documents.
+---@field didOpen? lsp.TextDocumentItem[]
+---Additional closed cell text documents.
+---@field didClose? lsp.TextDocumentIdentifier[]
+
+---@class anonym10
+---@field document lsp.VersionedTextDocumentIdentifier
+---@field changes lsp.TextDocumentContentChangeEvent[]
+
+---@class anonym8
+---Changes to the cell structure to add or
+---remove cells.
+---@field structure? anonym9
+---Changes to notebook cells properties like its
+---kind, execution summary or metadata.
+---@field data? lsp.NotebookCell[]
+---Changes to the text content of notebook cells.
+---@field textContent? anonym10[]
+
+---@class anonym11
+---The name of the client as defined by the client.
+---@field name string
+---The client's version as defined by the client.
+---@field version? string
+
+---@class anonym12
+---The server supports workspace folder.
+---
+---@since 3.6.0
+---@field workspaceFolders? lsp.WorkspaceFoldersServerCapabilities
+---The server is interested in notifications/requests for operations on files.
+---
+---@since 3.16.0
+---@field fileOperations? lsp.FileOperationOptions
+
+---@class anonym13
+---The server has support for completion item label
+---details (see also `CompletionItemLabelDetails`) when
+---receiving a completion item in a resolve call.
+---
+---@since 3.17.0
+---@field labelDetailsSupport? boolean
+
+---@class anonym15
+---@field language string
+
+---@class anonym14
+---The notebook to be synced If a string
+---value is provided it matches against the
+---notebook type. '*' matches every notebook.
+---@field notebook string|lsp.NotebookDocumentFilter
+---The cells of the matching notebook to be synced.
+---@field cells? anonym15[]
+
+---@class anonym17
+---@field language string
+
+---@class anonym16
+---The notebook to be synced If a string
+---value is provided it matches against the
+---notebook type. '*' matches every notebook.
+---@field notebook? string|lsp.NotebookDocumentFilter
+---The cells of the matching notebook to be synced.
+---@field cells anonym17[]
+
+---@class anonym18
+---The client will actively cancel the request.
+---@field cancel boolean
+---The list of requests for which the client
+---will retry the request if it receives a
+---response with error code `ContentModified`
+---@field retryOnContentModified string[]
+
+---@class anonym19
+---Whether the client groups edits with equal labels into tree nodes,
+---for instance all edits labelled with "Changes in Strings" would
+---be a tree node.
+---@field groupsOnLabel? boolean
+
+---@class anonym20
+---The symbol kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---
+---If this property is not present the client only supports
+---the symbol kinds from `File` to `Array` as defined in
+---the initial version of the protocol.
+---@field valueSet? lsp.SymbolKind[]
+
+---@class anonym21
+---The tags supported by the client.
+---@field valueSet lsp.SymbolTag[]
+
+---@class anonym22
+---The properties that a client can resolve lazily. Usually
+---`location.range`
+---@field properties string[]
+
+---@class anonym24
+---The tags supported by the client.
+---@field valueSet lsp.CompletionItemTag[]
+
+---@class anonym25
+---The properties that a client can resolve lazily.
+---@field properties string[]
+
+---@class anonym26
+---@field valueSet lsp.InsertTextMode[]
+
+---@class anonym23
+---Client supports snippets as insert text.
+---
+---A snippet can define tab stops and placeholders with `$1`, `$2`
+---and `${3:foo}`. `$0` defines the final tab stop, it defaults to
+---the end of the snippet. Placeholders with equal identifiers are linked,
+---that is typing in one will update others too.
+---@field snippetSupport? boolean
+---Client supports commit characters on a completion item.
+---@field commitCharactersSupport? boolean
+---Client supports the following content formats for the documentation
+---property. The order describes the preferred format of the client.
+---@field documentationFormat? lsp.MarkupKind[]
+---Client supports the deprecated property on a completion item.
+---@field deprecatedSupport? boolean
+---Client supports the preselect property on a completion item.
+---@field preselectSupport? boolean
+---Client supports the tag property on a completion item. Clients supporting
+---tags have to handle unknown tags gracefully. Clients especially need to
+---preserve unknown tags when sending a completion item back to the server in
+---a resolve call.
+---
+---@since 3.15.0
+---@field tagSupport? anonym24
+---Client support insert replace edit to control different behavior if a
+---completion item is inserted in the text or should replace text.
+---
+---@since 3.16.0
+---@field insertReplaceSupport? boolean
+---Indicates which properties a client can resolve lazily on a completion
+---item. Before version 3.16.0 only the predefined properties `documentation`
+---and `details` could be resolved lazily.
+---
+---@since 3.16.0
+---@field resolveSupport? anonym25
+---The client supports the `insertTextMode` property on
+---a completion item to override the whitespace handling mode
+---as defined by the client (see `insertTextMode`).
+---
+---@since 3.16.0
+---@field insertTextModeSupport? anonym26
+---The client has support for completion item label
+---details (see also `CompletionItemLabelDetails`).
+---
+---@since 3.17.0
+---@field labelDetailsSupport? boolean
+
+---@class anonym27
+---The completion item kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---
+---If this property is not present the client only supports
+---the completion items kinds from `Text` to `Reference` as defined in
+---the initial version of the protocol.
+---@field valueSet? lsp.CompletionItemKind[]
+
+---@class anonym28
+---The client supports the following itemDefaults on
+---a completion list.
+---
+---The value lists the supported property names of the
+---`CompletionList.itemDefaults` object. If omitted
+---no properties are supported.
+---
+---@since 3.17.0
+---@field itemDefaults? string[]
+
+---@class anonym30
+---The client supports processing label offsets instead of a
+---simple label string.
+---
+---@since 3.14.0
+---@field labelOffsetSupport? boolean
+
+---@class anonym29
+---Client supports the following content formats for the documentation
+---property. The order describes the preferred format of the client.
+---@field documentationFormat? lsp.MarkupKind[]
+---Client capabilities specific to parameter information.
+---@field parameterInformation? anonym30
+---The client supports the `activeParameter` property on `SignatureInformation`
+---literal.
+---
+---@since 3.16.0
+---@field activeParameterSupport? boolean
+
+---@class anonym31
+---The symbol kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---
+---If this property is not present the client only supports
+---the symbol kinds from `File` to `Array` as defined in
+---the initial version of the protocol.
+---@field valueSet? lsp.SymbolKind[]
+
+---@class anonym32
+---The tags supported by the client.
+---@field valueSet lsp.SymbolTag[]
+
+---@class anonym34
+---The code action kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---@field valueSet lsp.CodeActionKind[]
+
+---@class anonym33
+---The code action kind is support with the following value
+---set.
+---@field codeActionKind anonym34
+
+---@class anonym35
+---The properties that a client can resolve lazily.
+---@field properties string[]
+
+---@class anonym36
+---The folding range kind values the client supports. When this
+---property exists the client also guarantees that it will
+---handle values outside its set gracefully and falls back
+---to a default value when unknown.
+---@field valueSet? lsp.FoldingRangeKind[]
+
+---@class anonym37
+---If set, the client signals that it supports setting collapsedText on
+---folding ranges to display custom labels instead of the default text.
+---
+---@since 3.17.0
+---@field collapsedText? boolean
+
+---@class anonym38
+---The tags supported by the client.
+---@field valueSet lsp.DiagnosticTag[]
+
+---@class anonym40
+
+---@class anonym41
+---The client will send the `textDocument/semanticTokens/full/delta` request if
+---the server provides a corresponding handler.
+---@field delta? boolean
+
+---@class anonym39
+---The client will send the `textDocument/semanticTokens/range` request if
+---the server provides a corresponding handler.
+---@field range? boolean|anonym40
+---The client will send the `textDocument/semanticTokens/full` request if
+---the server provides a corresponding handler.
+---@field full? boolean|anonym41
+
+---@class anonym42
+---The properties that a client can resolve lazily.
+---@field properties string[]
+
+---@class anonym43
+---Whether the client supports additional attributes which
+---are preserved and send back to the server in the
+---request's response.
+---@field additionalPropertiesSupport? boolean
+
+---@class anonym44
+---@field range lsp.Range
+---@field placeholder string
+
+---@class anonym45
+---@field defaultBehavior boolean
+
+---@class anonym46
+---The range of the document that changed.
+---@field range lsp.Range
+---The optional length of the range that got replaced.
+---
+---@deprecated use range instead.
+---@field rangeLength? uinteger
+---The new text for the provided range.
+---@field text string
+
+---@class anonym47
+---The new text of the whole document.
+---@field text string
+
+---@class anonym48
+---@field language string
+---@field value string
+
+---@class anonym49
+---A language id, like `typescript`.
+---@field language string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---A glob pattern, like `*.{ts,js}`.
+---@field pattern? string
+
+---@class anonym50
+---A language id, like `typescript`.
+---@field language? string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme string
+---A glob pattern, like `*.{ts,js}`.
+---@field pattern? string
+
+---@class anonym51
+---A language id, like `typescript`.
+---@field language? string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---A glob pattern, like `*.{ts,js}`.
+---@field pattern string
+
+---@class anonym52
+---The type of the enclosing notebook.
+---@field notebookType string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---A glob pattern.
+---@field pattern? string
+
+---@class anonym53
+---The type of the enclosing notebook.
+---@field notebookType? string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme string
+---A glob pattern.
+---@field pattern? string
+
+---@class anonym54
+---The type of the enclosing notebook.
+---@field notebookType? string
+---A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
+---@field scheme? string
+---A glob pattern.
+---@field pattern string
diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
index 5dbd4a7199..1a4909b3f3 100644
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -6,11 +6,13 @@ local lpeg = vim.lpeg
 
 local M = {}
 
+---@alias lpeg userdata
+
 --- Parses the raw pattern into an |lpeg| pattern. LPeg patterns natively support the "this" or "that"
 --- alternative constructions described in the LSP spec that cannot be expressed in a standard Lua pattern.
 ---
 ---@param pattern string The raw glob pattern
----@return userdata An |lpeg| representation of the pattern, or nil if the pattern is invalid.
+---@return lpeg An |lpeg| representation of the pattern, or nil if the pattern is invalid.
 local function parse(pattern)
   local l = lpeg
 
@@ -109,7 +111,7 @@ local to_lsp_change_type = {
 
 --- Default excludes the same as VSCode's `files.watcherExclude` setting.
 --- https://github.com/microsoft/vscode/blob/eef30e7165e19b33daa1e15e92fa34ff4a5df0d3/src/vs/workbench/contrib/files/browser/files.contribution.ts#L261
----@type Lpeg pattern
+---@type lpeg parsed Lpeg pattern
 M._poll_exclude_pattern = parse('**/.git/{objects,subtree-cache}/**')
   + parse('**/node_modules/*/**')
   + parse('**/.hg/store/**')
@@ -132,7 +134,7 @@ function M.register(reg, ctx)
   if not has_capability or not client.workspace_folders then
     return
   end
-  local watch_regs = {} --- @type table<string,{pattern:userdata,kind:integer}>
+  local watch_regs = {} --- @type table<string,{pattern:lpeg,kind:integer}>
   for _, w in ipairs(reg.registerOptions.watchers) do
     local relative_pattern = false
     local glob_patterns = {} --- @type {baseUri:string, pattern: string}[]
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index eb2f59b312..8407105d47 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -5,8 +5,8 @@ local api = vim.api
 local M = {}
 
 ---@class lsp.inlay_hint.bufstate
----@field version integer
----@field client_hint table<integer, table<integer, lsp.InlayHint[]>> client_id -> (lnum -> hints)
+---@field version? integer
+---@field client_hint? 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, lsp.inlay_hint.bufstate>
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index bab1b23ee4..5b20344bd3 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -14,11 +14,11 @@ local uv = vim.uv
 --- @field marked boolean whether this token has had extmarks applied
 ---
 --- @class STCurrentResult
---- @field version integer document version associated with this result
---- @field result_id string resultId from the server; used with delta requests
---- @field highlights STTokenRange[] cache of highlight ranges for this document version
---- @field tokens integer[] raw token array as received by the server. used for calculating delta responses
---- @field namespace_cleared boolean whether the namespace was cleared for this result yet
+--- @field version? integer document version associated with this result
+--- @field result_id? string resultId from the server; used with delta requests
+--- @field highlights? STTokenRange[] cache of highlight ranges for this document version
+--- @field tokens? integer[] raw token array as received by the server. used for calculating delta responses
+--- @field namespace_cleared? boolean whether the namespace was cleared for this result yet
 ---
 --- @class STActiveRequest
 --- @field request_id integer the LSP request ID of the most recent request sent to the server
@@ -717,8 +717,7 @@ end
 --- mark will be deleted by the semantic token engine when appropriate; for
 --- example, when the LSP sends updated tokens. This function is intended for
 --- use inside |LspTokenUpdate| callbacks.
----@param token (table) a semantic token, found as `args.data.token` in
----       |LspTokenUpdate|.
+---@param token (table) a semantic token, found as `args.data.token` in |LspTokenUpdate|.
 ---@param bufnr (integer) the buffer to highlight
 ---@param client_id (integer) The ID of the |vim.lsp.client|
 ---@param hl_group (string) Highlight group name
diff --git a/runtime/lua/vim/lsp/types.lua b/runtime/lua/vim/lsp/types.lua
deleted file mode 100644
index 98e948c945..0000000000
--- a/runtime/lua/vim/lsp/types.lua
+++ /dev/null
@@ -1,21 +0,0 @@
----@meta
-
----@alias lsp-handler fun(err: lsp.ResponseError|nil, result: any, context: lsp.HandlerContext, config: table|nil): any?
-
----@class lsp.HandlerContext
----@field method string
----@field client_id integer
----@field bufnr? integer
----@field params? any
-
----@class lsp.ResponseError
----@field code integer
----@field message string
----@field data string|number|boolean|table[]|table|nil
-
---- @class lsp.DocumentFilter
---- @field language? string
---- @field scheme? string
---- @field pattern? string
-
---- @alias lsp.RegisterOptions any | lsp.StaticRegistrationOptions | lsp.TextDocumentRegistrationOptions
diff --git a/runtime/lua/vim/lsp/types/protocol.lua b/runtime/lua/vim/lsp/types/protocol.lua
deleted file mode 100644
index e1ed8dbcc3..0000000000
--- a/runtime/lua/vim/lsp/types/protocol.lua
+++ /dev/null
@@ -1,4393 +0,0 @@
---[[
-This file is autogenerated from scripts/gen_lsp.lua
-Regenerate:
-nvim -l scripts/gen_lsp.lua gen --version 3.18 --runtime/lua/vim/lsp/types/protocol.lua
---]]
-
----@alias lsp.null nil
----@alias uinteger integer
----@alias lsp.decimal number
----@alias lsp.DocumentUri string
----@alias lsp.URI string
----@alias lsp.LSPObject table<string, lsp.LSPAny>
----@alias lsp.LSPArray lsp.LSPAny[]
----@alias lsp.LSPAny lsp.LSPObject|lsp.LSPArray|string|number|boolean|nil
-
----@class lsp.ImplementationParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
-
----Represents a location inside a resource, such as a line
----inside a text file.
----@class lsp.Location
----@field uri lsp.DocumentUri
----@field range lsp.Range
-
----@class lsp.ImplementationRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
-
----@class lsp.TypeDefinitionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
-
----@class lsp.TypeDefinitionRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
-
----A workspace folder inside a client.
----@class lsp.WorkspaceFolder
----The associated URI for this workspace folder.
----@field uri lsp.URI
----The name of the workspace folder. Used to refer to this
----workspace folder in the user interface.
----@field name string
-
----The parameters of a `workspace/didChangeWorkspaceFolders` notification.
----@class lsp.DidChangeWorkspaceFoldersParams
----The actual workspace folder change event.
----@field event lsp.WorkspaceFoldersChangeEvent
-
----The parameters of a configuration request.
----@class lsp.ConfigurationParams
----@field items lsp.ConfigurationItem[]
-
----Parameters for a {@link DocumentColorRequest}.
----@class lsp.DocumentColorParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
-
----Represents a color range from a document.
----@class lsp.ColorInformation
----The range in the document where this color appears.
----@field range lsp.Range
----The actual color value for this color range.
----@field color lsp.Color
-
----@class lsp.DocumentColorRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
-
----Parameters for a {@link ColorPresentationRequest}.
----@class lsp.ColorPresentationParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
----The color to request presentations for.
----@field color lsp.Color
----The range where the color would be inserted. Serves as a context.
----@field range lsp.Range
-
----@class lsp.ColorPresentation
----The label of this color presentation. It will be shown on the color
----picker header. By default this is also the text that is inserted when selecting
----this color presentation.
----@field label string
----An {@link TextEdit edit} which is applied to a document when selecting
----this presentation for the color.  When `falsy` the {@link ColorPresentation.label label}
----is used.
----@field textEdit? lsp.TextEdit
----An optional array of additional {@link TextEdit text edits} that are applied when
----selecting this color presentation. Edits must not overlap with the main {@link ColorPresentation.textEdit edit} nor with themselves.
----@field additionalTextEdits? lsp.TextEdit[]
-
----@class lsp.WorkDoneProgressOptions
----@field workDoneProgress? boolean
-
----General text document registration options.
----@class lsp.TextDocumentRegistrationOptions
----A document selector to identify the scope of the registration. If set to null
----the document selector provided on the client side will be used.
----@field documentSelector lsp.DocumentSelector|lsp.null
-
----Parameters for a {@link FoldingRangeRequest}.
----@class lsp.FoldingRangeParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
-
----Represents a folding range. To be valid, start and end line must be bigger than zero and smaller
----than the number of lines in the document. Clients are free to ignore invalid ranges.
----@class lsp.FoldingRange
----The zero-based start line of the range to fold. The folded area starts after the line's last character.
----To be valid, the end must be zero or larger and smaller than the number of lines in the document.
----@field startLine uinteger
----The zero-based character offset from where the folded range starts. If not defined, defaults to the length of the start line.
----@field startCharacter? uinteger
----The zero-based end line of the range to fold. The folded area ends with the line's last character.
----To be valid, the end must be zero or larger and smaller than the number of lines in the document.
----@field endLine uinteger
----The zero-based character offset before the folded range ends. If not defined, defaults to the length of the end line.
----@field endCharacter? uinteger
----Describes the kind of the folding range such as `comment' or 'region'. The kind
----is used to categorize folding ranges and used by commands like 'Fold all comments'.
----See {@link FoldingRangeKind} for an enumeration of standardized kinds.
----@field kind? lsp.FoldingRangeKind
----The text that the client should show when the specified range is
----collapsed. If not defined or not supported by the client, a default
----will be chosen by the client.
----
----@since 3.17.0
----@field collapsedText? string
-
----@class lsp.FoldingRangeRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
-
----@class lsp.DeclarationParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
-
----@class lsp.DeclarationRegistrationOptions: lsp.DeclarationOptions, lsp.StaticRegistrationOptions
-
----A parameter literal used in selection range requests.
----@class lsp.SelectionRangeParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
----The positions inside the text document.
----@field positions lsp.Position[]
-
----A selection range represents a part of a selection hierarchy. A selection range
----may have a parent selection range that contains it.
----@class lsp.SelectionRange
----The {@link Range range} of this selection range.
----@field range lsp.Range
----The parent selection range containing this range. Therefore `parent.range` must contain `this.range`.
----@field parent? lsp.SelectionRange
-
----@class lsp.SelectionRangeRegistrationOptions: lsp.SelectionRangeOptions, lsp.StaticRegistrationOptions
-
----@class lsp.WorkDoneProgressCreateParams
----The token to be used to report progress.
----@field token lsp.ProgressToken
-
----@class lsp.WorkDoneProgressCancelParams
----The token to be used to report progress.
----@field token lsp.ProgressToken
-
----The parameter of a `textDocument/prepareCallHierarchy` request.
----
----@since 3.16.0
----@class lsp.CallHierarchyPrepareParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
-
----Represents programming constructs like functions or constructors in the context
----of call hierarchy.
----
----@since 3.16.0
----@class lsp.CallHierarchyItem
----The name of this item.
----@field name string
----The kind of this item.
----@field kind lsp.SymbolKind
----Tags for this item.
----@field tags? lsp.SymbolTag[]
----More detail for this item, e.g. the signature of a function.
----@field detail? string
----The resource identifier of this item.
----@field uri lsp.DocumentUri
----The range enclosing this symbol not including leading/trailing whitespace but everything else, e.g. comments and code.
----@field range lsp.Range
----The range that should be selected and revealed when this symbol is being picked, e.g. the name of a function.
----Must be contained by the {@link CallHierarchyItem.range `range`}.
----@field selectionRange lsp.Range
----A data entry field that is preserved between a call hierarchy prepare and
----incoming calls or outgoing calls requests.
----@field data? lsp.LSPAny
-
----Call hierarchy options used during static or dynamic registration.
----
----@since 3.16.0
----@class lsp.CallHierarchyRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
-
----The parameter of a `callHierarchy/incomingCalls` request.
----
----@since 3.16.0
----@class lsp.CallHierarchyIncomingCallsParams
----@field item lsp.CallHierarchyItem
-
----Represents an incoming call, e.g. a caller of a method or constructor.
----
----@since 3.16.0
----@class lsp.CallHierarchyIncomingCall
----The item that makes the call.
----@field from lsp.CallHierarchyItem
----The ranges at which the calls appear. This is relative to the caller
----denoted by {@link CallHierarchyIncomingCall.from `this.from`}.
----@field fromRanges lsp.Range[]
-
----The parameter of a `callHierarchy/outgoingCalls` request.
----
----@since 3.16.0
----@class lsp.CallHierarchyOutgoingCallsParams
----@field item lsp.CallHierarchyItem
-
----Represents an outgoing call, e.g. calling a getter from a method or a method from a constructor etc.
----
----@since 3.16.0
----@class lsp.CallHierarchyOutgoingCall
----The item that is called.
----@field to lsp.CallHierarchyItem
----The range at which this item is called. This is the range relative to the caller, e.g the item
----passed to {@link CallHierarchyItemProvider.provideCallHierarchyOutgoingCalls `provideCallHierarchyOutgoingCalls`}
----and not {@link CallHierarchyOutgoingCall.to `this.to`}.
----@field fromRanges lsp.Range[]
-
----@since 3.16.0
----@class lsp.SemanticTokensParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
-
----@since 3.16.0
----@class lsp.SemanticTokens
----An optional result id. If provided and clients support delta updating
----the client will include the result id in the next semantic token request.
----A server can then instead of computing all semantic tokens again simply
----send a delta.
----@field resultId? string
----The actual tokens.
----@field data uinteger[]
-
----@since 3.16.0
----@class lsp.SemanticTokensPartialResult
----@field data uinteger[]
-
----@since 3.16.0
----@class lsp.SemanticTokensRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
-
----@since 3.16.0
----@class lsp.SemanticTokensDeltaParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
----The result id of a previous response. The result Id can either point to a full response
----or a delta response depending on what was received last.
----@field previousResultId string
-
----@since 3.16.0
----@class lsp.SemanticTokensDelta
----@field resultId? string
----The semantic token edits to transform a previous result into a new result.
----@field edits lsp.SemanticTokensEdit[]
-
----@since 3.16.0
----@class lsp.SemanticTokensDeltaPartialResult
----@field edits lsp.SemanticTokensEdit[]
-
----@since 3.16.0
----@class lsp.SemanticTokensRangeParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
----The range the semantic tokens are requested for.
----@field range lsp.Range
-
----Params to show a resource in the UI.
----
----@since 3.16.0
----@class lsp.ShowDocumentParams
----The uri to show.
----@field uri lsp.URI
----Indicates to show the resource in an external program.
----To show, for example, `https://code.visualstudio.com/`
----in the default WEB browser set `external` to `true`.
----@field external? boolean
----An optional property to indicate whether the editor
----showing the document should take focus or not.
----Clients might ignore this property if an external
----program is started.
----@field takeFocus? boolean
----An optional selection range if the document is a text
----document. Clients might ignore the property if an
----external program is started or the file is not a text
----file.
----@field selection? lsp.Range
-
----The result of a showDocument request.
----
----@since 3.16.0
----@class lsp.ShowDocumentResult
----A boolean indicating if the show was successful.
----@field success boolean
-
----@class lsp.LinkedEditingRangeParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
-
----The result of a linked editing range request.
----
----@since 3.16.0
----@class lsp.LinkedEditingRanges
----A list of ranges that can be edited together. The ranges must have
----identical length and contain identical text content. The ranges cannot overlap.
----@field ranges lsp.Range[]
----An optional word pattern (regular expression) that describes valid contents for
----the given ranges. If no pattern is provided, the client configuration's word
----pattern will be used.
----@field wordPattern? string
-
----@class lsp.LinkedEditingRangeRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
-
----The parameters sent in notifications/requests for user-initiated creation of
----files.
----
----@since 3.16.0
----@class lsp.CreateFilesParams
----An array of all files/folders created in this operation.
----@field files lsp.FileCreate[]
-
----A workspace edit represents changes to many resources managed in the workspace. The edit
----should either provide `changes` or `documentChanges`. If documentChanges are present
----they are preferred over `changes` if the client can handle versioned document edits.
----
----Since version 3.13.0 a workspace edit can contain resource operations as well. If resource
----operations are present clients need to execute the operations in the order in which they
----are provided. So a workspace edit for example can consist of the following two changes:
----(1) a create file a.txt and (2) a text document edit which insert text into file a.txt.
----
----An invalid sequence (e.g. (1) delete file a.txt and (2) insert text into file a.txt) will
----cause failure of the operation. How the client recovers from the failure is described by
----the client capability: `workspace.workspaceEdit.failureHandling`
----@class lsp.WorkspaceEdit
----Holds changes to existing resources.
----@field changes? table<lsp.DocumentUri, lsp.TextEdit[]>
----Depending on the client capability `workspace.workspaceEdit.resourceOperations` document changes
----are either an array of `TextDocumentEdit`s to express changes to n different text documents
----where each text document edit addresses a specific version of a text document. Or it can contain
----above `TextDocumentEdit`s mixed with create, rename and delete file / folder operations.
----
----Whether a client supports versioned document edits is expressed via
----`workspace.workspaceEdit.documentChanges` client capability.
----
----If a client neither supports `documentChanges` nor `workspace.workspaceEdit.resourceOperations` then
----only plain `TextEdit`s using the `changes` property are supported.
----@field documentChanges? lsp.TextDocumentEdit|lsp.CreateFile|lsp.RenameFile|lsp.DeleteFile[]
----A map of change annotations that can be referenced in `AnnotatedTextEdit`s or create, rename and
----delete file / folder operations.
----
----Whether clients honor this property depends on the client capability `workspace.changeAnnotationSupport`.
----
----@since 3.16.0
----@field changeAnnotations? table<lsp.ChangeAnnotationIdentifier, lsp.ChangeAnnotation>
-
----The options to register for file operations.
----
----@since 3.16.0
----@class lsp.FileOperationRegistrationOptions
----The actual filters.
----@field filters lsp.FileOperationFilter[]
-
----The parameters sent in notifications/requests for user-initiated renames of
----files.
----
----@since 3.16.0
----@class lsp.RenameFilesParams
----An array of all files/folders renamed in this operation. When a folder is renamed, only
----the folder will be included, and not its children.
----@field files lsp.FileRename[]
-
----The parameters sent in notifications/requests for user-initiated deletes of
----files.
----
----@since 3.16.0
----@class lsp.DeleteFilesParams
----An array of all files/folders deleted in this operation.
----@field files lsp.FileDelete[]
-
----@class lsp.MonikerParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
-
----Moniker definition to match LSIF 0.5 moniker definition.
----
----@since 3.16.0
----@class lsp.Moniker
----The scheme of the moniker. For example tsc or .Net
----@field scheme string
----The identifier of the moniker. The value is opaque in LSIF however
----schema owners are allowed to define the structure if they want.
----@field identifier string
----The scope in which the moniker is unique
----@field unique lsp.UniquenessLevel
----The moniker kind if known.
----@field kind? lsp.MonikerKind
-
----@class lsp.MonikerRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----The parameter of a `textDocument/prepareTypeHierarchy` request.
----
----@since 3.17.0
----@class lsp.TypeHierarchyPrepareParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
-
----@since 3.17.0
----@class lsp.TypeHierarchyItem
----The name of this item.
----@field name string
----The kind of this item.
----@field kind lsp.SymbolKind
----Tags for this item.
----@field tags? lsp.SymbolTag[]
----More detail for this item, e.g. the signature of a function.
----@field detail? string
----The resource identifier of this item.
----@field uri lsp.DocumentUri
----The range enclosing this symbol not including leading/trailing whitespace
----but everything else, e.g. comments and code.
----@field range lsp.Range
----The range that should be selected and revealed when this symbol is being
----picked, e.g. the name of a function. Must be contained by the
----{@link TypeHierarchyItem.range `range`}.
----@field selectionRange lsp.Range
----A data entry field that is preserved between a type hierarchy prepare and
----supertypes or subtypes requests. It could also be used to identify the
----type hierarchy in the server, helping improve the performance on
----resolving supertypes and subtypes.
----@field data? lsp.LSPAny
-
----Type hierarchy options used during static or dynamic registration.
----
----@since 3.17.0
----@class lsp.TypeHierarchyRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
-
----The parameter of a `typeHierarchy/supertypes` request.
----
----@since 3.17.0
----@class lsp.TypeHierarchySupertypesParams
----@field item lsp.TypeHierarchyItem
-
----The parameter of a `typeHierarchy/subtypes` request.
----
----@since 3.17.0
----@class lsp.TypeHierarchySubtypesParams
----@field item lsp.TypeHierarchyItem
-
----A parameter literal used in inline value requests.
----
----@since 3.17.0
----@class lsp.InlineValueParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
----The document range for which inline values should be computed.
----@field range lsp.Range
----Additional information about the context in which inline values were
----requested.
----@field context lsp.InlineValueContext
-
----Inline value options used during static or dynamic registration.
----
----@since 3.17.0
----@class lsp.InlineValueRegistrationOptions: lsp.InlineValueOptions, lsp.StaticRegistrationOptions
-
----A parameter literal used in inlay hint requests.
----
----@since 3.17.0
----@class lsp.InlayHintParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
----The document range for which inlay hints should be computed.
----@field range lsp.Range
-
----Inlay hint information.
----
----@since 3.17.0
----@class lsp.InlayHint
----The position of this hint.
----@field position lsp.Position
----The label of this hint. A human readable string or an array of
----InlayHintLabelPart label parts.
----
----*Note* that neither the string nor the label part can be empty.
----@field label string|lsp.InlayHintLabelPart[]
----The kind of this hint. Can be omitted in which case the client
----should fall back to a reasonable default.
----@field kind? lsp.InlayHintKind
----Optional text edits that are performed when accepting this inlay hint.
----
----*Note* that edits are expected to change the document so that the inlay
----hint (or its nearest variant) is now part of the document and the inlay
----hint itself is now obsolete.
----@field textEdits? lsp.TextEdit[]
----The tooltip text when you hover over this item.
----@field tooltip? string|lsp.MarkupContent
----Render padding before the hint.
----
----Note: Padding should use the editor's background color, not the
----background color of the hint itself. That means padding can be used
----to visually align/separate an inlay hint.
----@field paddingLeft? boolean
----Render padding after the hint.
----
----Note: Padding should use the editor's background color, not the
----background color of the hint itself. That means padding can be used
----to visually align/separate an inlay hint.
----@field paddingRight? boolean
----A data entry field that is preserved on an inlay hint between
----a `textDocument/inlayHint` and a `inlayHint/resolve` request.
----@field data? lsp.LSPAny
-
----Inlay hint options used during static or dynamic registration.
----
----@since 3.17.0
----@class lsp.InlayHintRegistrationOptions: lsp.InlayHintOptions, lsp.StaticRegistrationOptions
-
----Parameters of the document diagnostic request.
----
----@since 3.17.0
----@class lsp.DocumentDiagnosticParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
----The additional identifier  provided during registration.
----@field identifier? string
----The result id of a previous response if provided.
----@field previousResultId? string
-
----A partial result for a document diagnostic report.
----
----@since 3.17.0
----@class lsp.DocumentDiagnosticReportPartialResult
----@field relatedDocuments table<lsp.DocumentUri, lsp.FullDocumentDiagnosticReport|lsp.UnchangedDocumentDiagnosticReport>
-
----Cancellation data returned from a diagnostic request.
----
----@since 3.17.0
----@class lsp.DiagnosticServerCancellationData
----@field retriggerRequest boolean
-
----Diagnostic registration options.
----
----@since 3.17.0
----@class lsp.DiagnosticRegistrationOptions: lsp.TextDocumentRegistrationOptions, lsp.StaticRegistrationOptions
-
----Parameters of the workspace diagnostic request.
----
----@since 3.17.0
----@class lsp.WorkspaceDiagnosticParams
----The additional identifier provided during registration.
----@field identifier? string
----The currently known diagnostic reports with their
----previous result ids.
----@field previousResultIds lsp.PreviousResultId[]
-
----A workspace diagnostic report.
----
----@since 3.17.0
----@class lsp.WorkspaceDiagnosticReport
----@field items lsp.WorkspaceDocumentDiagnosticReport[]
-
----A partial result for a workspace diagnostic report.
----
----@since 3.17.0
----@class lsp.WorkspaceDiagnosticReportPartialResult
----@field items lsp.WorkspaceDocumentDiagnosticReport[]
-
----The params sent in an open notebook document notification.
----
----@since 3.17.0
----@class lsp.DidOpenNotebookDocumentParams
----The notebook document that got opened.
----@field notebookDocument lsp.NotebookDocument
----The text documents that represent the content
----of a notebook cell.
----@field cellTextDocuments lsp.TextDocumentItem[]
-
----The params sent in a change notebook document notification.
----
----@since 3.17.0
----@class lsp.DidChangeNotebookDocumentParams
----The notebook document that did change. The version number points
----to the version after all provided changes have been applied. If
----only the text document content of a cell changes the notebook version
----doesn't necessarily have to change.
----@field notebookDocument lsp.VersionedNotebookDocumentIdentifier
----The actual changes to the notebook document.
----
----The changes describe single state changes to the notebook document.
----So if there are two changes c1 (at array index 0) and c2 (at array
----index 1) for a notebook in state S then c1 moves the notebook from
----S to S' and c2 from S' to S''. So c1 is computed on the state S and
----c2 is computed on the state S'.
----
----To mirror the content of a notebook using change events use the following approach:
----- start with the same initial content
----- apply the 'notebookDocument/didChange' notifications in the order you receive them.
----- apply the `NotebookChangeEvent`s in a single notification in the order
----  you receive them.
----@field change lsp.NotebookDocumentChangeEvent
-
----The params sent in a save notebook document notification.
----
----@since 3.17.0
----@class lsp.DidSaveNotebookDocumentParams
----The notebook document that got saved.
----@field notebookDocument lsp.NotebookDocumentIdentifier
-
----The params sent in a close notebook document notification.
----
----@since 3.17.0
----@class lsp.DidCloseNotebookDocumentParams
----The notebook document that got closed.
----@field notebookDocument lsp.NotebookDocumentIdentifier
----The text documents that represent the content
----of a notebook cell that got closed.
----@field cellTextDocuments lsp.TextDocumentIdentifier[]
-
----A parameter literal used in inline completion requests.
----
----@since 3.18.0
----@class lsp.InlineCompletionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
----Additional information about the context in which inline completions were
----requested.
----@field context lsp.InlineCompletionContext
-
----Represents a collection of {@link InlineCompletionItem inline completion items} to be presented in the editor.
----@class lsp.InlineCompletionList
----The inline completion items
----@field items lsp.InlineCompletionItem[]
-
----An inline completion item represents a text snippet that is proposed inline to complete text that is being typed.
----
----@since 3.18.0
----@class lsp.InlineCompletionItem
----The text to replace the range with. Must be set.
----@field insertText string
----The format of the insert text. The format applies to the `insertText`. If omitted defaults to `InsertTextFormat.PlainText`.
----@field insertTextFormat? lsp.InsertTextFormat
----A text that is used to decide if this inline completion should be shown. When `falsy` the {@link InlineCompletionItem.insertText} is used.
----@field filterText? string
----The range to replace. Must begin and end on the same line.
----@field range? lsp.Range
----An optional {@link Command} that is executed *after* inserting this completion.
----@field command? lsp.Command
-
----Inline completion options used during static or dynamic registration.
----
----@since 3.18.0
----@class lsp.InlineCompletionRegistrationOptions: lsp.InlineCompletionOptions, lsp.StaticRegistrationOptions
-
----@class lsp.RegistrationParams
----@field registrations lsp.Registration[]
-
----@class lsp.UnregistrationParams
----@field unregisterations lsp.Unregistration[]
-
----@class lsp.InitializeParams: lsp._InitializeParams
-
----The result returned from an initialize request.
----@class lsp.InitializeResult
----The capabilities the language server provides.
----@field capabilities lsp.ServerCapabilities
----Information about the server.
----
----@since 3.15.0
----@field serverInfo? anonym1
-
----The data type of the ResponseError if the
----initialize request fails.
----@class lsp.InitializeError
----Indicates whether the client execute the following retry logic:
----(1) show the message provided by the ResponseError to the user
----(2) user selects retry or cancel
----(3) if user selected retry the initialize method is sent again.
----@field retry boolean
-
----@class lsp.InitializedParams
-
----The parameters of a change configuration notification.
----@class lsp.DidChangeConfigurationParams
----The actual changed settings
----@field settings lsp.LSPAny
-
----@class lsp.DidChangeConfigurationRegistrationOptions
----@field section? string|string[]
-
----The parameters of a notification message.
----@class lsp.ShowMessageParams
----The message type. See {@link MessageType}
----@field type lsp.MessageType
----The actual message.
----@field message string
-
----@class lsp.ShowMessageRequestParams
----The message type. See {@link MessageType}
----@field type lsp.MessageType
----The actual message.
----@field message string
----The message action items to present.
----@field actions? lsp.MessageActionItem[]
-
----@class lsp.MessageActionItem
----A short title like 'Retry', 'Open Log' etc.
----@field title string
-
----The log message parameters.
----@class lsp.LogMessageParams
----The message type. See {@link MessageType}
----@field type lsp.MessageType
----The actual message.
----@field message string
-
----The parameters sent in an open text document notification
----@class lsp.DidOpenTextDocumentParams
----The document that was opened.
----@field textDocument lsp.TextDocumentItem
-
----The change text document notification's parameters.
----@class lsp.DidChangeTextDocumentParams
----The document that did change. The version number points
----to the version after all provided content changes have
----been applied.
----@field textDocument lsp.VersionedTextDocumentIdentifier
----The actual content changes. The content changes describe single state changes
----to the document. So if there are two content changes c1 (at array index 0) and
----c2 (at array index 1) for a document in state S then c1 moves the document from
----S to S' and c2 from S' to S''. So c1 is computed on the state S and c2 is computed
----on the state S'.
----
----To mirror the content of a document using change events use the following approach:
----- start with the same initial content
----- apply the 'textDocument/didChange' notifications in the order you receive them.
----- apply the `TextDocumentContentChangeEvent`s in a single notification in the order
----  you receive them.
----@field contentChanges lsp.TextDocumentContentChangeEvent[]
-
----Describe options to be used when registered for text document change events.
----@class lsp.TextDocumentChangeRegistrationOptions: lsp.TextDocumentRegistrationOptions
----How documents are synced to the server.
----@field syncKind lsp.TextDocumentSyncKind
-
----The parameters sent in a close text document notification
----@class lsp.DidCloseTextDocumentParams
----The document that was closed.
----@field textDocument lsp.TextDocumentIdentifier
-
----The parameters sent in a save text document notification
----@class lsp.DidSaveTextDocumentParams
----The document that was saved.
----@field textDocument lsp.TextDocumentIdentifier
----Optional the content when saved. Depends on the includeText value
----when the save notification was requested.
----@field text? string
-
----Save registration options.
----@class lsp.TextDocumentSaveRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----The parameters sent in a will save text document notification.
----@class lsp.WillSaveTextDocumentParams
----The document that will be saved.
----@field textDocument lsp.TextDocumentIdentifier
----The 'TextDocumentSaveReason'.
----@field reason lsp.TextDocumentSaveReason
-
----A text edit applicable to a text document.
----@class lsp.TextEdit
----The range of the text document to be manipulated. To insert
----text into a document create a range where start === end.
----@field range lsp.Range
----The string to be inserted. For delete operations use an
----empty string.
----@field newText string
-
----The watched files change notification's parameters.
----@class lsp.DidChangeWatchedFilesParams
----The actual file events.
----@field changes lsp.FileEvent[]
-
----Describe options to be used when registered for text document change events.
----@class lsp.DidChangeWatchedFilesRegistrationOptions
----The watchers to register.
----@field watchers lsp.FileSystemWatcher[]
-
----The publish diagnostic notification's parameters.
----@class lsp.PublishDiagnosticsParams
----The URI for which diagnostic information is reported.
----@field uri lsp.DocumentUri
----Optional the version number of the document the diagnostics are published for.
----
----@since 3.15.0
----@field version? integer
----An array of diagnostic information items.
----@field diagnostics lsp.Diagnostic[]
-
----Completion parameters
----@class lsp.CompletionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
----The completion context. This is only available it the client specifies
----to send this using the client capability `textDocument.completion.contextSupport === true`
----@field context? lsp.CompletionContext
-
----A completion item represents a text snippet that is
----proposed to complete text that is being typed.
----@class lsp.CompletionItem
----The label of this completion item.
----
----The label property is also by default the text that
----is inserted when selecting this completion.
----
----If label details are provided the label itself should
----be an unqualified name of the completion item.
----@field label string
----Additional details for the label
----
----@since 3.17.0
----@field labelDetails? lsp.CompletionItemLabelDetails
----The kind of this completion item. Based of the kind
----an icon is chosen by the editor.
----@field kind? lsp.CompletionItemKind
----Tags for this completion item.
----
----@since 3.15.0
----@field tags? lsp.CompletionItemTag[]
----A human-readable string with additional information
----about this item, like type or symbol information.
----@field detail? string
----A human-readable string that represents a doc-comment.
----@field documentation? string|lsp.MarkupContent
----Indicates if this item is deprecated.
----@deprecated Use `tags` instead.
----@field deprecated? boolean
----Select this item when showing.
----
----*Note* that only one completion item can be selected and that the
----tool / client decides which item that is. The rule is that the *first*
----item of those that match best is selected.
----@field preselect? boolean
----A string that should be used when comparing this item
----with other items. When `falsy` the {@link CompletionItem.label label}
----is used.
----@field sortText? string
----A string that should be used when filtering a set of
----completion items. When `falsy` the {@link CompletionItem.label label}
----is used.
----@field filterText? string
----A string that should be inserted into a document when selecting
----this completion. When `falsy` the {@link CompletionItem.label label}
----is used.
----
----The `insertText` is subject to interpretation by the client side.
----Some tools might not take the string literally. For example
----VS Code when code complete is requested in this example
----`con<cursor position>` and a completion item with an `insertText` of
----`console` is provided it will only insert `sole`. Therefore it is
----recommended to use `textEdit` instead since it avoids additional client
----side interpretation.
----@field insertText? string
----The format of the insert text. The format applies to both the
----`insertText` property and the `newText` property of a provided
----`textEdit`. If omitted defaults to `InsertTextFormat.PlainText`.
----
----Please note that the insertTextFormat doesn't apply to
----`additionalTextEdits`.
----@field insertTextFormat? lsp.InsertTextFormat
----How whitespace and indentation is handled during completion
----item insertion. If not provided the clients default value depends on
----the `textDocument.completion.insertTextMode` client capability.
----
----@since 3.16.0
----@field insertTextMode? lsp.InsertTextMode
----An {@link TextEdit edit} which is applied to a document when selecting
----this completion. When an edit is provided the value of
----{@link CompletionItem.insertText insertText} is ignored.
----
----Most editors support two different operations when accepting a completion
----item. One is to insert a completion text and the other is to replace an
----existing text with a completion text. Since this can usually not be
----predetermined by a server it can report both ranges. Clients need to
----signal support for `InsertReplaceEdits` via the
----`textDocument.completion.insertReplaceSupport` client capability
----property.
----
----*Note 1:* The text edit's range as well as both ranges from an insert
----replace edit must be a [single line] and they must contain the position
----at which completion has been requested.
----*Note 2:* If an `InsertReplaceEdit` is returned the edit's insert range
----must be a prefix of the edit's replace range, that means it must be
----contained and starting at the same position.
----
----@since 3.16.0 additional type `InsertReplaceEdit`
----@field textEdit? lsp.TextEdit|lsp.InsertReplaceEdit
----The edit text used if the completion item is part of a CompletionList and
----CompletionList defines an item default for the text edit range.
----
----Clients will only honor this property if they opt into completion list
----item defaults using the capability `completionList.itemDefaults`.
----
----If not provided and a list's default range is provided the label
----property is used as a text.
----
----@since 3.17.0
----@field textEditText? string
----An optional array of additional {@link TextEdit text edits} that are applied when
----selecting this completion. Edits must not overlap (including the same insert position)
----with the main {@link CompletionItem.textEdit edit} nor with themselves.
----
----Additional text edits should be used to change text unrelated to the current cursor position
----(for example adding an import statement at the top of the file if the completion item will
----insert an unqualified type).
----@field additionalTextEdits? lsp.TextEdit[]
----An optional set of characters that when pressed while this completion is active will accept it first and
----then type that character. *Note* that all commit characters should have `length=1` and that superfluous
----characters will be ignored.
----@field commitCharacters? string[]
----An optional {@link Command command} that is executed *after* inserting this completion. *Note* that
----additional modifications to the current document should be described with the
----{@link CompletionItem.additionalTextEdits additionalTextEdits}-property.
----@field command? lsp.Command
----A data entry field that is preserved on a completion item between a
----{@link CompletionRequest} and a {@link CompletionResolveRequest}.
----@field data? lsp.LSPAny
-
----Represents a collection of {@link CompletionItem completion items} to be presented
----in the editor.
----@class lsp.CompletionList
----This list it not complete. Further typing results in recomputing this list.
----
----Recomputed lists have all their items replaced (not appended) in the
----incomplete completion sessions.
----@field isIncomplete boolean
----In many cases the items of an actual completion result share the same
----value for properties like `commitCharacters` or the range of a text
----edit. A completion list can therefore define item defaults which will
----be used if a completion item itself doesn't specify the value.
----
----If a completion list specifies a default value and a completion item
----also specifies a corresponding value the one from the item is used.
----
----Servers are only allowed to return default values if the client
----signals support for this via the `completionList.itemDefaults`
----capability.
----
----@since 3.17.0
----@field itemDefaults? anonym3
----The completion items.
----@field items lsp.CompletionItem[]
-
----Registration options for a {@link CompletionRequest}.
----@class lsp.CompletionRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----Parameters for a {@link HoverRequest}.
----@class lsp.HoverParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
-
----The result of a hover request.
----@class lsp.Hover
----The hover's content
----@field contents lsp.MarkupContent|lsp.MarkedString|lsp.MarkedString[]
----An optional range inside the text document that is used to
----visualize the hover, e.g. by changing the background color.
----@field range? lsp.Range
-
----Registration options for a {@link HoverRequest}.
----@class lsp.HoverRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----Parameters for a {@link SignatureHelpRequest}.
----@class lsp.SignatureHelpParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
----The signature help context. This is only available if the client specifies
----to send this using the client capability `textDocument.signatureHelp.contextSupport === true`
----
----@since 3.15.0
----@field context? lsp.SignatureHelpContext
-
----Signature help represents the signature of something
----callable. There can be multiple signature but only one
----active and only one active parameter.
----@class lsp.SignatureHelp
----One or more signatures.
----@field signatures lsp.SignatureInformation[]
----The active signature. If omitted or the value lies outside the
----range of `signatures` the value defaults to zero or is ignored if
----the `SignatureHelp` has no signatures.
----
----Whenever possible implementors should make an active decision about
----the active signature and shouldn't rely on a default value.
----
----In future version of the protocol this property might become
----mandatory to better express this.
----@field activeSignature? uinteger
----The active parameter of the active signature. If omitted or the value
----lies outside the range of `signatures[activeSignature].parameters`
----defaults to 0 if the active signature has parameters. If
----the active signature has no parameters it is ignored.
----In future version of the protocol this property might become
----mandatory to better express the active parameter if the
----active signature does have any.
----@field activeParameter? uinteger
-
----Registration options for a {@link SignatureHelpRequest}.
----@class lsp.SignatureHelpRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----Parameters for a {@link DefinitionRequest}.
----@class lsp.DefinitionParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
-
----Registration options for a {@link DefinitionRequest}.
----@class lsp.DefinitionRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----Parameters for a {@link ReferencesRequest}.
----@class lsp.ReferenceParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
----@field context lsp.ReferenceContext
-
----Registration options for a {@link ReferencesRequest}.
----@class lsp.ReferenceRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----Parameters for a {@link DocumentHighlightRequest}.
----@class lsp.DocumentHighlightParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams, lsp.PartialResultParams
-
----A document highlight is a range inside a text document which deserves
----special attention. Usually a document highlight is visualized by changing
----the background color of its range.
----@class lsp.DocumentHighlight
----The range this highlight applies to.
----@field range lsp.Range
----The highlight kind, default is {@link DocumentHighlightKind.Text text}.
----@field kind? lsp.DocumentHighlightKind
-
----Registration options for a {@link DocumentHighlightRequest}.
----@class lsp.DocumentHighlightRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----Parameters for a {@link DocumentSymbolRequest}.
----@class lsp.DocumentSymbolParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
-
----Represents information about programming constructs like variables, classes,
----interfaces etc.
----@class lsp.SymbolInformation: lsp.BaseSymbolInformation
----Indicates if this symbol is deprecated.
----
----@deprecated Use tags instead
----@field deprecated? boolean
----The location of this symbol. The location's range is used by a tool
----to reveal the location in the editor. If the symbol is selected in the
----tool the range's start information is used to position the cursor. So
----the range usually spans more than the actual symbol's name and does
----normally include things like visibility modifiers.
----
----The range doesn't have to denote a node range in the sense of an abstract
----syntax tree. It can therefore not be used to re-construct a hierarchy of
----the symbols.
----@field location lsp.Location
-
----Represents programming constructs like variables, classes, interfaces etc.
----that appear in a document. Document symbols can be hierarchical and they
----have two ranges: one that encloses its definition and one that points to
----its most interesting range, e.g. the range of an identifier.
----@class lsp.DocumentSymbol
----The name of this symbol. Will be displayed in the user interface and therefore must not be
----an empty string or a string only consisting of white spaces.
----@field name string
----More detail for this symbol, e.g the signature of a function.
----@field detail? string
----The kind of this symbol.
----@field kind lsp.SymbolKind
----Tags for this document symbol.
----
----@since 3.16.0
----@field tags? lsp.SymbolTag[]
----Indicates if this symbol is deprecated.
----
----@deprecated Use tags instead
----@field deprecated? boolean
----The range enclosing this symbol not including leading/trailing whitespace but everything else
----like comments. This information is typically used to determine if the clients cursor is
----inside the symbol to reveal in the symbol in the UI.
----@field range lsp.Range
----The range that should be selected and revealed when this symbol is being picked, e.g the name of a function.
----Must be contained by the `range`.
----@field selectionRange lsp.Range
----Children of this symbol, e.g. properties of a class.
----@field children? lsp.DocumentSymbol[]
-
----Registration options for a {@link DocumentSymbolRequest}.
----@class lsp.DocumentSymbolRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----The parameters of a {@link CodeActionRequest}.
----@class lsp.CodeActionParams
----The document in which the command was invoked.
----@field textDocument lsp.TextDocumentIdentifier
----The range for which the command was invoked.
----@field range lsp.Range
----Context carrying additional information.
----@field context lsp.CodeActionContext
-
----Represents a reference to a command. Provides a title which
----will be used to represent a command in the UI and, optionally,
----an array of arguments which will be passed to the command handler
----function when invoked.
----@class lsp.Command
----Title of the command, like `save`.
----@field title string
----The identifier of the actual command handler.
----@field command string
----Arguments that the command handler should be
----invoked with.
----@field arguments? lsp.LSPAny[]
-
----A code action represents a change that can be performed in code, e.g. to fix a problem or
----to refactor code.
----
----A CodeAction must set either `edit` and/or a `command`. If both are supplied, the `edit` is applied first, then the `command` is executed.
----@class lsp.CodeAction
----A short, human-readable, title for this code action.
----@field title string
----The kind of the code action.
----
----Used to filter code actions.
----@field kind? lsp.CodeActionKind
----The diagnostics that this code action resolves.
----@field diagnostics? lsp.Diagnostic[]
----Marks this as a preferred action. Preferred actions are used by the `auto fix` command and can be targeted
----by keybindings.
----
----A quick fix should be marked preferred if it properly addresses the underlying error.
----A refactoring should be marked preferred if it is the most reasonable choice of actions to take.
----
----@since 3.15.0
----@field isPreferred? boolean
----Marks that the code action cannot currently be applied.
----
----Clients should follow the following guidelines regarding disabled code actions:
----
----  - Disabled code actions are not shown in automatic [lightbulbs](https://code.visualstudio.com/docs/editor/editingevolved#_code-action)
----    code action menus.
----
----  - Disabled actions are shown as faded out in the code action menu when the user requests a more specific type
----    of code action, such as refactorings.
----
----  - If the user has a [keybinding](https://code.visualstudio.com/docs/editor/refactoring#_keybindings-for-code-actions)
----    that auto applies a code action and only disabled code actions are returned, the client should show the user an
----    error message with `reason` in the editor.
----
----@since 3.16.0
----@field disabled? anonym4
----The workspace edit this code action performs.
----@field edit? lsp.WorkspaceEdit
----A command this code action executes. If a code action
----provides an edit and a command, first the edit is
----executed and then the command.
----@field command? lsp.Command
----A data entry field that is preserved on a code action between
----a `textDocument/codeAction` and a `codeAction/resolve` request.
----
----@since 3.16.0
----@field data? lsp.LSPAny
-
----Registration options for a {@link CodeActionRequest}.
----@class lsp.CodeActionRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----The parameters of a {@link WorkspaceSymbolRequest}.
----@class lsp.WorkspaceSymbolParams
----A query string to filter symbols by. Clients may send an empty
----string here to request all symbols.
----@field query string
-
----A special workspace symbol that supports locations without a range.
----
----See also SymbolInformation.
----
----@since 3.17.0
----@class lsp.WorkspaceSymbol: lsp.BaseSymbolInformation
----The location of the symbol. Whether a server is allowed to
----return a location without a range depends on the client
----capability `workspace.symbol.resolveSupport`.
----
----See SymbolInformation#location for more details.
----@field location lsp.Location|anonym5
----A data entry field that is preserved on a workspace symbol between a
----workspace symbol request and a workspace symbol resolve request.
----@field data? lsp.LSPAny
-
----Registration options for a {@link WorkspaceSymbolRequest}.
----@class lsp.WorkspaceSymbolRegistrationOptions: lsp.WorkspaceSymbolOptions
-
----The parameters of a {@link CodeLensRequest}.
----@class lsp.CodeLensParams
----The document to request code lens for.
----@field textDocument lsp.TextDocumentIdentifier
-
----A code lens represents a {@link Command command} that should be shown along with
----source text, like the number of references, a way to run tests, etc.
----
----A code lens is _unresolved_ when no command is associated to it. For performance
----reasons the creation of a code lens and resolving should be done in two stages.
----@class lsp.CodeLens
----The range in which this code lens is valid. Should only span a single line.
----@field range lsp.Range
----The command this code lens represents.
----@field command? lsp.Command
----A data entry field that is preserved on a code lens item between
----a {@link CodeLensRequest} and a [CodeLensResolveRequest]
----(#CodeLensResolveRequest)
----@field data? lsp.LSPAny
-
----Registration options for a {@link CodeLensRequest}.
----@class lsp.CodeLensRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----The parameters of a {@link DocumentLinkRequest}.
----@class lsp.DocumentLinkParams
----The document to provide document links for.
----@field textDocument lsp.TextDocumentIdentifier
-
----A document link is a range in a text document that links to an internal or external resource, like another
----text document or a web site.
----@class lsp.DocumentLink
----The range this link applies to.
----@field range lsp.Range
----The uri this link points to. If missing a resolve request is sent later.
----@field target? lsp.URI
----The tooltip text when you hover over this link.
----
----If a tooltip is provided, is will be displayed in a string that includes instructions on how to
----trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS,
----user settings, and localization.
----
----@since 3.15.0
----@field tooltip? string
----A data entry field that is preserved on a document link between a
----DocumentLinkRequest and a DocumentLinkResolveRequest.
----@field data? lsp.LSPAny
-
----Registration options for a {@link DocumentLinkRequest}.
----@class lsp.DocumentLinkRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----The parameters of a {@link DocumentFormattingRequest}.
----@class lsp.DocumentFormattingParams
----The document to format.
----@field textDocument lsp.TextDocumentIdentifier
----The format options.
----@field options lsp.FormattingOptions
-
----Registration options for a {@link DocumentFormattingRequest}.
----@class lsp.DocumentFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----The parameters of a {@link DocumentRangeFormattingRequest}.
----@class lsp.DocumentRangeFormattingParams
----The document to format.
----@field textDocument lsp.TextDocumentIdentifier
----The range to format
----@field range lsp.Range
----The format options
----@field options lsp.FormattingOptions
-
----Registration options for a {@link DocumentRangeFormattingRequest}.
----@class lsp.DocumentRangeFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----The parameters of a {@link DocumentRangesFormattingRequest}.
----
----@since 3.18.0
----@proposed
----@class lsp.DocumentRangesFormattingParams
----The document to format.
----@field textDocument lsp.TextDocumentIdentifier
----The ranges to format
----@field ranges lsp.Range[]
----The format options
----@field options lsp.FormattingOptions
-
----The parameters of a {@link DocumentOnTypeFormattingRequest}.
----@class lsp.DocumentOnTypeFormattingParams
----The document to format.
----@field textDocument lsp.TextDocumentIdentifier
----The position around which the on type formatting should happen.
----This is not necessarily the exact position where the character denoted
----by the property `ch` got typed.
----@field position lsp.Position
----The character that has been typed that triggered the formatting
----on type request. That is not necessarily the last character that
----got inserted into the document since the client could auto insert
----characters as well (e.g. like automatic brace completion).
----@field ch string
----The formatting options.
----@field options lsp.FormattingOptions
-
----Registration options for a {@link DocumentOnTypeFormattingRequest}.
----@class lsp.DocumentOnTypeFormattingRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----The parameters of a {@link RenameRequest}.
----@class lsp.RenameParams
----The document to rename.
----@field textDocument lsp.TextDocumentIdentifier
----The position at which this request was sent.
----@field position lsp.Position
----The new name of the symbol. If the given name is not valid the
----request must return a {@link ResponseError} with an
----appropriate message set.
----@field newName string
-
----Registration options for a {@link RenameRequest}.
----@class lsp.RenameRegistrationOptions: lsp.TextDocumentRegistrationOptions
-
----@class lsp.PrepareRenameParams: lsp.TextDocumentPositionParams, lsp.WorkDoneProgressParams
-
----The parameters of a {@link ExecuteCommandRequest}.
----@class lsp.ExecuteCommandParams
----The identifier of the actual command handler.
----@field command string
----Arguments that the command should be invoked with.
----@field arguments? lsp.LSPAny[]
-
----Registration options for a {@link ExecuteCommandRequest}.
----@class lsp.ExecuteCommandRegistrationOptions: lsp.ExecuteCommandOptions
-
----The parameters passed via an apply workspace edit request.
----@class lsp.ApplyWorkspaceEditParams
----An optional label of the workspace edit. This label is
----presented in the user interface for example on an undo
----stack to undo the workspace edit.
----@field label? string
----The edits to apply.
----@field edit lsp.WorkspaceEdit
-
----The result returned from the apply workspace edit request.
----
----@since 3.17 renamed from ApplyWorkspaceEditResponse
----@class lsp.ApplyWorkspaceEditResult
----Indicates whether the edit was applied or not.
----@field applied boolean
----An optional textual description for why the edit was not applied.
----This may be used by the server for diagnostic logging or to provide
----a suitable error for a request that triggered the edit.
----@field failureReason? string
----Depending on the client's failure handling strategy `failedChange` might
----contain the index of the change that failed. This property is only available
----if the client signals a `failureHandlingStrategy` in its client capabilities.
----@field failedChange? uinteger
-
----@class lsp.WorkDoneProgressBegin
----@field kind "begin"
----Mandatory title of the progress operation. Used to briefly inform about
----the kind of operation being performed.
----
----Examples: "Indexing" or "Linking dependencies".
----@field title string
----Controls if a cancel button should show to allow the user to cancel the
----long running operation. Clients that don't support cancellation are allowed
----to ignore the setting.
----@field cancellable? boolean
----Optional, more detailed associated progress message. Contains
----complementary information to the `title`.
----
----Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
----If unset, the previous progress message (if any) is still valid.
----@field message? string
----Optional progress percentage to display (value 100 is considered 100%).
----If not provided infinite progress is assumed and clients are allowed
----to ignore the `percentage` value in subsequent in report notifications.
----
----The value should be steadily rising. Clients are free to ignore values
----that are not following this rule. The value range is [0, 100].
----@field percentage? uinteger
-
----@class lsp.WorkDoneProgressReport
----@field kind "report"
----Controls enablement state of a cancel button.
----
----Clients that don't support cancellation or don't support controlling the button's
----enablement state are allowed to ignore the property.
----@field cancellable? boolean
----Optional, more detailed associated progress message. Contains
----complementary information to the `title`.
----
----Examples: "3/25 files", "project/src/module2", "node_modules/some_dep".
----If unset, the previous progress message (if any) is still valid.
----@field message? string
----Optional progress percentage to display (value 100 is considered 100%).
----If not provided infinite progress is assumed and clients are allowed
----to ignore the `percentage` value in subsequent in report notifications.
----
----The value should be steadily rising. Clients are free to ignore values
----that are not following this rule. The value range is [0, 100]
----@field percentage? uinteger
-
----@class lsp.WorkDoneProgressEnd
----@field kind "end"
----Optional, a final message indicating to for example indicate the outcome
----of the operation.
----@field message? string
-
----@class lsp.SetTraceParams
----@field value lsp.TraceValues
-
----@class lsp.LogTraceParams
----@field message string
----@field verbose? string
-
----@class lsp.CancelParams
----The request id to cancel.
----@field id integer|string
-
----@class lsp.ProgressParams
----The progress token provided by the client or server.
----@field token lsp.ProgressToken
----The progress data.
----@field value lsp.LSPAny
-
----A parameter literal used in requests to pass a text document and a position inside that
----document.
----@class lsp.TextDocumentPositionParams
----The text document.
----@field textDocument lsp.TextDocumentIdentifier
----The position inside the text document.
----@field position lsp.Position
-
----@class lsp.WorkDoneProgressParams
----An optional token that a server can use to report work done progress.
----@field workDoneToken? lsp.ProgressToken
-
----@class lsp.PartialResultParams
----An optional token that a server can use to report partial results (e.g. streaming) to
----the client.
----@field partialResultToken? lsp.ProgressToken
-
----Represents the connection of two locations. Provides additional metadata over normal {@link Location locations},
----including an origin range.
----@class lsp.LocationLink
----Span of the origin of this link.
----
----Used as the underlined span for mouse interaction. Defaults to the word range at
----the definition position.
----@field originSelectionRange? lsp.Range
----The target resource identifier of this link.
----@field targetUri lsp.DocumentUri
----The full target range of this link. If the target for example is a symbol then target range is the
----range enclosing this symbol not including leading/trailing whitespace but everything else
----like comments. This information is typically used to highlight the range in the editor.
----@field targetRange lsp.Range
----The range that should be selected and revealed when this link is being followed, e.g the name of a function.
----Must be contained by the `targetRange`. See also `DocumentSymbol#range`
----@field targetSelectionRange lsp.Range
-
----A range in a text document expressed as (zero-based) start and end positions.
----
----If you want to specify a range that contains a line including the line ending
----character(s) then use an end position denoting the start of the next line.
----For example:
----```ts
----{
----    start: { line: 5, character: 23 }
----    end : { line 6, character : 0 }
----}
----```
----@class lsp.Range
----The range's start position.
----@field start lsp.Position
----The range's end position.
----@field end lsp.Position
-
----@class lsp.ImplementationOptions
-
----Static registration options to be returned in the initialize
----request.
----@class lsp.StaticRegistrationOptions
----The id used to register the request. The id can be used to deregister
----the request again. See also Registration#id.
----@field id? string
-
----@class lsp.TypeDefinitionOptions
-
----The workspace folder change event.
----@class lsp.WorkspaceFoldersChangeEvent
----The array of added workspace folders
----@field added lsp.WorkspaceFolder[]
----The array of the removed workspace folders
----@field removed lsp.WorkspaceFolder[]
-
----@class lsp.ConfigurationItem
----The scope to get the configuration section for.
----@field scopeUri? string
----The configuration section asked for.
----@field section? string
-
----A literal to identify a text document in the client.
----@class lsp.TextDocumentIdentifier
----The text document's uri.
----@field uri lsp.DocumentUri
-
----Represents a color in RGBA space.
----@class lsp.Color
----The red component of this color in the range [0-1].
----@field red decimal
----The green component of this color in the range [0-1].
----@field green decimal
----The blue component of this color in the range [0-1].
----@field blue decimal
----The alpha component of this color in the range [0-1].
----@field alpha decimal
-
----@class lsp.DocumentColorOptions
-
----@class lsp.FoldingRangeOptions
-
----@class lsp.DeclarationOptions
-
----Position in a text document expressed as zero-based line and character
----offset. Prior to 3.17 the offsets were always based on a UTF-16 string
----representation. So a string of the form `a𐐀b` the character offset of the
----character `a` is 0, the character offset of `𐐀` is 1 and the character
----offset of b is 3 since `𐐀` is represented using two code units in UTF-16.
----Since 3.17 clients and servers can agree on a different string encoding
----representation (e.g. UTF-8). The client announces it's supported encoding
----via the client capability [`general.positionEncodings`](#clientCapabilities).
----The value is an array of position encodings the client supports, with
----decreasing preference (e.g. the encoding at index `0` is the most preferred
----one). To stay backwards compatible the only mandatory encoding is UTF-16
----represented via the string `utf-16`. The server can pick one of the
----encodings offered by the client and signals that encoding back to the
----client via the initialize result's property
----[`capabilities.positionEncoding`](#serverCapabilities). If the string value
----`utf-16` is missing from the client's capability `general.positionEncodings`
----servers can safely assume that the client supports UTF-16. If the server
----omits the position encoding in its initialize result the encoding defaults
----to the string value `utf-16`. Implementation considerations: since the
----conversion from one encoding into another requires the content of the
----file / line the conversion is best done where the file is read which is
----usually on the server side.
----
----Positions are line end character agnostic. So you can not specify a position
----that denotes `\r|\n` or `\n|` where `|` represents the character offset.
----
----@since 3.17.0 - support for negotiated position encoding.
----@class lsp.Position
----Line position in a document (zero-based).
----
----If a line number is greater than the number of lines in a document, it defaults back to the number of lines in the document.
----If a line number is negative, it defaults to 0.
----@field line uinteger
----Character offset on a line in a document (zero-based).
----
----The meaning of this offset is determined by the negotiated
----`PositionEncodingKind`.
----
----If the character value is greater than the line length it defaults back to the
----line length.
----@field character uinteger
-
----@class lsp.SelectionRangeOptions
-
----Call hierarchy options used during static registration.
----
----@since 3.16.0
----@class lsp.CallHierarchyOptions
-
----@since 3.16.0
----@class lsp.SemanticTokensOptions
----The legend used by the server
----@field legend lsp.SemanticTokensLegend
----Server supports providing semantic tokens for a specific range
----of a document.
----@field range? boolean|anonym6
----Server supports providing semantic tokens for a full document.
----@field full? boolean|anonym7
-
----@since 3.16.0
----@class lsp.SemanticTokensEdit
----The start offset of the edit.
----@field start uinteger
----The count of elements to remove.
----@field deleteCount uinteger
----The elements to insert.
----@field data? uinteger[]
-
----@class lsp.LinkedEditingRangeOptions
-
----Represents information on a file/folder create.
----
----@since 3.16.0
----@class lsp.FileCreate
----A file:// URI for the location of the file/folder being created.
----@field uri string
-
----Describes textual changes on a text document. A TextDocumentEdit describes all changes
----on a document version Si and after they are applied move the document to version Si+1.
----So the creator of a TextDocumentEdit doesn't need to sort the array of edits or do any
----kind of ordering. However the edits must be non overlapping.
----@class lsp.TextDocumentEdit
----The text document to change.
----@field textDocument lsp.OptionalVersionedTextDocumentIdentifier
----The edits to be applied.
----
----@since 3.16.0 - support for AnnotatedTextEdit. This is guarded using a
----client capability.
----@field edits lsp.TextEdit|lsp.AnnotatedTextEdit[]
-
----Create file operation.
----@class lsp.CreateFile: lsp.ResourceOperation
----A create
----@field kind "create"
----The resource to create.
----@field uri lsp.DocumentUri
----Additional options
----@field options? lsp.CreateFileOptions
-
----Rename file operation
----@class lsp.RenameFile: lsp.ResourceOperation
----A rename
----@field kind "rename"
----The old (existing) location.
----@field oldUri lsp.DocumentUri
----The new location.
----@field newUri lsp.DocumentUri
----Rename options.
----@field options? lsp.RenameFileOptions
-
----Delete file operation
----@class lsp.DeleteFile: lsp.ResourceOperation
----A delete
----@field kind "delete"
----The file to delete.
----@field uri lsp.DocumentUri
----Delete options.
----@field options? lsp.DeleteFileOptions
-
----Additional information that describes document changes.
----
----@since 3.16.0
----@class lsp.ChangeAnnotation
----A human-readable string describing the actual change. The string
----is rendered prominent in the user interface.
----@field label string
----A flag which indicates that user confirmation is needed
----before applying the change.
----@field needsConfirmation? boolean
----A human-readable string which is rendered less prominent in
----the user interface.
----@field description? string
-
----A filter to describe in which file operation requests or notifications
----the server is interested in receiving.
----
----@since 3.16.0
----@class lsp.FileOperationFilter
----A Uri scheme like `file` or `untitled`.
----@field scheme? string
----The actual file operation pattern.
----@field pattern lsp.FileOperationPattern
-
----Represents information on a file/folder rename.
----
----@since 3.16.0
----@class lsp.FileRename
----A file:// URI for the original location of the file/folder being renamed.
----@field oldUri string
----A file:// URI for the new location of the file/folder being renamed.
----@field newUri string
-
----Represents information on a file/folder delete.
----
----@since 3.16.0
----@class lsp.FileDelete
----A file:// URI for the location of the file/folder being deleted.
----@field uri string
-
----@class lsp.MonikerOptions
-
----Type hierarchy options used during static registration.
----
----@since 3.17.0
----@class lsp.TypeHierarchyOptions
-
----@since 3.17.0
----@class lsp.InlineValueContext
----The stack frame (as a DAP Id) where the execution has stopped.
----@field frameId integer
----The document range where execution has stopped.
----Typically the end position of the range denotes the line where the inline values are shown.
----@field stoppedLocation lsp.Range
-
----Provide inline value as text.
----
----@since 3.17.0
----@class lsp.InlineValueText
----The document range for which the inline value applies.
----@field range lsp.Range
----The text of the inline value.
----@field text string
-
----Provide inline value through a variable lookup.
----If only a range is specified, the variable name will be extracted from the underlying document.
----An optional variable name can be used to override the extracted name.
----
----@since 3.17.0
----@class lsp.InlineValueVariableLookup
----The document range for which the inline value applies.
----The range is used to extract the variable name from the underlying document.
----@field range lsp.Range
----If specified the name of the variable to look up.
----@field variableName? string
----How to perform the lookup.
----@field caseSensitiveLookup boolean
-
----Provide an inline value through an expression evaluation.
----If only a range is specified, the expression will be extracted from the underlying document.
----An optional expression can be used to override the extracted expression.
----
----@since 3.17.0
----@class lsp.InlineValueEvaluatableExpression
----The document range for which the inline value applies.
----The range is used to extract the evaluatable expression from the underlying document.
----@field range lsp.Range
----If specified the expression overrides the extracted expression.
----@field expression? string
-
----Inline value options used during static registration.
----
----@since 3.17.0
----@class lsp.InlineValueOptions
-
----An inlay hint label part allows for interactive and composite labels
----of inlay hints.
----
----@since 3.17.0
----@class lsp.InlayHintLabelPart
----The value of this label part.
----@field value string
----The tooltip text when you hover over this label part. Depending on
----the client capability `inlayHint.resolveSupport` clients might resolve
----this property late using the resolve request.
----@field tooltip? string|lsp.MarkupContent
----An optional source code location that represents this
----label part.
----
----The editor will use this location for the hover and for code navigation
----features: This part will become a clickable link that resolves to the
----definition of the symbol at the given location (not necessarily the
----location itself), it shows the hover that shows at the given location,
----and it shows a context menu with further code navigation commands.
----
----Depending on the client capability `inlayHint.resolveSupport` clients
----might resolve this property late using the resolve request.
----@field location? lsp.Location
----An optional command for this label part.
----
----Depending on the client capability `inlayHint.resolveSupport` clients
----might resolve this property late using the resolve request.
----@field command? lsp.Command
-
----A `MarkupContent` literal represents a string value which content is interpreted base on its
----kind flag. Currently the protocol supports `plaintext` and `markdown` as markup kinds.
----
----If the kind is `markdown` then the value can contain fenced code blocks like in GitHub issues.
----See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
----
----Here is an example how such a string can be constructed using JavaScript / TypeScript:
----```ts
----let markdown: MarkdownContent = {
---- kind: MarkupKind.Markdown,
---- value: [
----   '# Header',
----   'Some text',
----   '```typescript',
----   'someCode();',
----   '```'
---- ].join('\n')
----};
----```
----
----*Please Note* that clients might sanitize the return markdown. A client could decide to
----remove HTML from the markdown to avoid script execution.
----@class lsp.MarkupContent
----The type of the Markup
----@field kind lsp.MarkupKind
----The content itself
----@field value string
-
----Inlay hint options used during static registration.
----
----@since 3.17.0
----@class lsp.InlayHintOptions
----The server provides support to resolve additional
----information for an inlay hint item.
----@field resolveProvider? boolean
-
----A full diagnostic report with a set of related documents.
----
----@since 3.17.0
----@class lsp.RelatedFullDocumentDiagnosticReport: lsp.FullDocumentDiagnosticReport
----Diagnostics of related documents. This information is useful
----in programming languages where code in a file A can generate
----diagnostics in a file B which A depends on. An example of
----such a language is C/C++ where marco definitions in a file
----a.cpp and result in errors in a header file b.hpp.
----
----@since 3.17.0
----@field relatedDocuments? table<lsp.DocumentUri, lsp.FullDocumentDiagnosticReport|lsp.UnchangedDocumentDiagnosticReport>
-
----An unchanged diagnostic report with a set of related documents.
----
----@since 3.17.0
----@class lsp.RelatedUnchangedDocumentDiagnosticReport: lsp.UnchangedDocumentDiagnosticReport
----Diagnostics of related documents. This information is useful
----in programming languages where code in a file A can generate
----diagnostics in a file B which A depends on. An example of
----such a language is C/C++ where marco definitions in a file
----a.cpp and result in errors in a header file b.hpp.
----
----@since 3.17.0
----@field relatedDocuments? table<lsp.DocumentUri, lsp.FullDocumentDiagnosticReport|lsp.UnchangedDocumentDiagnosticReport>
-
----A diagnostic report with a full set of problems.
----
----@since 3.17.0
----@class lsp.FullDocumentDiagnosticReport
----A full document diagnostic report.
----@field kind "full"
----An optional result id. If provided it will
----be sent on the next diagnostic request for the
----same document.
----@field resultId? string
----The actual items.
----@field items lsp.Diagnostic[]
-
----A diagnostic report indicating that the last returned
----report is still accurate.
----
----@since 3.17.0
----@class lsp.UnchangedDocumentDiagnosticReport
----A document diagnostic report indicating
----no changes to the last result. A server can
----only return `unchanged` if result ids are
----provided.
----@field kind "unchanged"
----A result id which will be sent on the next
----diagnostic request for the same document.
----@field resultId string
-
----Diagnostic options.
----
----@since 3.17.0
----@class lsp.DiagnosticOptions
----An optional identifier under which the diagnostics are
----managed by the client.
----@field identifier? string
----Whether the language has inter file dependencies meaning that
----editing code in one file can result in a different diagnostic
----set in another file. Inter file dependencies are common for
----most programming languages and typically uncommon for linters.
----@field interFileDependencies boolean
----The server provides support for workspace diagnostics as well.
----@field workspaceDiagnostics boolean
-
----A previous result id in a workspace pull request.
----
----@since 3.17.0
----@class lsp.PreviousResultId
----The URI for which the client knowns a
----result id.
----@field uri lsp.DocumentUri
----The value of the previous result id.
----@field value string
-
----A notebook document.
----
----@since 3.17.0
----@class lsp.NotebookDocument
----The notebook document's uri.
----@field uri lsp.URI
----The type of the notebook.
----@field notebookType string
----The version number of this document (it will increase after each
----change, including undo/redo).
----@field version integer
----Additional metadata stored with the notebook
----document.
----
----Note: should always be an object literal (e.g. LSPObject)
----@field metadata? lsp.LSPObject
----The cells of a notebook.
----@field cells lsp.NotebookCell[]
-
----An item to transfer a text document from the client to the
----server.
----@class lsp.TextDocumentItem
----The text document's uri.
----@field uri lsp.DocumentUri
----The text document's language identifier.
----@field languageId string
----The version number of this document (it will increase after each
----change, including undo/redo).
----@field version integer
----The content of the opened text document.
----@field text string
-
----A versioned notebook document identifier.
----
----@since 3.17.0
----@class lsp.VersionedNotebookDocumentIdentifier
----The version number of this notebook document.
----@field version integer
----The notebook document's uri.
----@field uri lsp.URI
-
----A change event for a notebook document.
----
----@since 3.17.0
----@class lsp.NotebookDocumentChangeEvent
----The changed meta data if any.
----
----Note: should always be an object literal (e.g. LSPObject)
----@field metadata? lsp.LSPObject
----Changes to cells
----@field cells? anonym10
-
----A literal to identify a notebook document in the client.
----
----@since 3.17.0
----@class lsp.NotebookDocumentIdentifier
----The notebook document's uri.
----@field uri lsp.URI
-
----Provides information about the context in which an inline completion was requested.
----
----@since 3.18.0
----@class lsp.InlineCompletionContext
----Describes how the inline completion was triggered.
----@field triggerKind lsp.InlineCompletionTriggerKind
----Provides information about the currently selected item in the autocomplete widget if it is visible.
----@field selectedCompletionInfo? lsp.SelectedCompletionInfo
-
----Inline completion options used during static registration.
----
----@since 3.18.0
----@class lsp.InlineCompletionOptions
-
----General parameters to to register for an notification or to register a provider.
----@class lsp.Registration
----The id used to register the request. The id can be used to deregister
----the request again.
----@field id string
----The method / capability to register for.
----@field method string
----Options necessary for the registration.
----@field registerOptions? lsp.LSPAny
-
----General parameters to unregister a request or notification.
----@class lsp.Unregistration
----The id used to unregister the request or notification. Usually an id
----provided during the register request.
----@field id string
----The method to unregister for.
----@field method string
-
----The initialize parameters
----@class lsp._InitializeParams
----The process Id of the parent process that started
----the server.
----
----Is `null` if the process has not been started by another process.
----If the parent process is not alive then the server should exit.
----@field processId integer|lsp.null
----Information about the client
----
----@since 3.15.0
----@field clientInfo? anonym11
----The locale the client is currently showing the user interface
----in. This must not necessarily be the locale of the operating
----system.
----
----Uses IETF language tags as the value's syntax
----(See https://en.wikipedia.org/wiki/IETF_language_tag)
----
----@since 3.16.0
----@field locale? string
----The rootPath of the workspace. Is null
----if no folder is open.
----
----@deprecated in favour of rootUri.
----@field rootPath? string|lsp.null
----The rootUri of the workspace. Is null if no
----folder is open. If both `rootPath` and `rootUri` are set
----`rootUri` wins.
----
----@deprecated in favour of workspaceFolders.
----@field rootUri lsp.DocumentUri|lsp.null
----The capabilities provided by the client (editor or tool)
----@field capabilities lsp.ClientCapabilities
----User provided initialization options.
----@field initializationOptions? lsp.LSPAny
----The initial trace setting. If omitted trace is disabled ('off').
----@field trace? lsp.TraceValues
-
----@class lsp.WorkspaceFoldersInitializeParams
----The workspace folders configured in the client when the server starts.
----
----This property is only available if the client supports workspace folders.
----It can be `null` if the client supports workspace folders but none are
----configured.
----
----@since 3.6.0
----@field workspaceFolders? lsp.WorkspaceFolder[]|lsp.null
-
----Defines the capabilities provided by a language
----server.
----@class lsp.ServerCapabilities
----The position encoding the server picked from the encodings offered
----by the client via the client capability `general.positionEncodings`.
----
----If the client didn't provide any position encodings the only valid
----value that a server can return is 'utf-16'.
----
----If omitted it defaults to 'utf-16'.
----
----@since 3.17.0
----@field positionEncoding? lsp.PositionEncodingKind
----Defines how text documents are synced. Is either a detailed structure
----defining each notification or for backwards compatibility the
----TextDocumentSyncKind number.
----@field textDocumentSync? lsp.TextDocumentSyncOptions|lsp.TextDocumentSyncKind
----Defines how notebook documents are synced.
----
----@since 3.17.0
----@field notebookDocumentSync? lsp.NotebookDocumentSyncOptions|lsp.NotebookDocumentSyncRegistrationOptions
----The server provides completion support.
----@field completionProvider? lsp.CompletionOptions
----The server provides hover support.
----@field hoverProvider? boolean|lsp.HoverOptions
----The server provides signature help support.
----@field signatureHelpProvider? lsp.SignatureHelpOptions
----The server provides Goto Declaration support.
----@field declarationProvider? boolean|lsp.DeclarationOptions|lsp.DeclarationRegistrationOptions
----The server provides goto definition support.
----@field definitionProvider? boolean|lsp.DefinitionOptions
----The server provides Goto Type Definition support.
----@field typeDefinitionProvider? boolean|lsp.TypeDefinitionOptions|lsp.TypeDefinitionRegistrationOptions
----The server provides Goto Implementation support.
----@field implementationProvider? boolean|lsp.ImplementationOptions|lsp.ImplementationRegistrationOptions
----The server provides find references support.
----@field referencesProvider? boolean|lsp.ReferenceOptions
----The server provides document highlight support.
----@field documentHighlightProvider? boolean|lsp.DocumentHighlightOptions
----The server provides document symbol support.
----@field documentSymbolProvider? boolean|lsp.DocumentSymbolOptions
----The server provides code actions. CodeActionOptions may only be
----specified if the client states that it supports
----`codeActionLiteralSupport` in its initial `initialize` request.
----@field codeActionProvider? boolean|lsp.CodeActionOptions
----The server provides code lens.
----@field codeLensProvider? lsp.CodeLensOptions
----The server provides document link support.
----@field documentLinkProvider? lsp.DocumentLinkOptions
----The server provides color provider support.
----@field colorProvider? boolean|lsp.DocumentColorOptions|lsp.DocumentColorRegistrationOptions
----The server provides workspace symbol support.
----@field workspaceSymbolProvider? boolean|lsp.WorkspaceSymbolOptions
----The server provides document formatting.
----@field documentFormattingProvider? boolean|lsp.DocumentFormattingOptions
----The server provides document range formatting.
----@field documentRangeFormattingProvider? boolean|lsp.DocumentRangeFormattingOptions
----The server provides document formatting on typing.
----@field documentOnTypeFormattingProvider? lsp.DocumentOnTypeFormattingOptions
----The server provides rename support. RenameOptions may only be
----specified if the client states that it supports
----`prepareSupport` in its initial `initialize` request.
----@field renameProvider? boolean|lsp.RenameOptions
----The server provides folding provider support.
----@field foldingRangeProvider? boolean|lsp.FoldingRangeOptions|lsp.FoldingRangeRegistrationOptions
----The server provides selection range support.
----@field selectionRangeProvider? boolean|lsp.SelectionRangeOptions|lsp.SelectionRangeRegistrationOptions
----The server provides execute command support.
----@field executeCommandProvider? lsp.ExecuteCommandOptions
----The server provides call hierarchy support.
----
----@since 3.16.0
----@field callHierarchyProvider? boolean|lsp.CallHierarchyOptions|lsp.CallHierarchyRegistrationOptions
----The server provides linked editing range support.
----
----@since 3.16.0
----@field linkedEditingRangeProvider? boolean|lsp.LinkedEditingRangeOptions|lsp.LinkedEditingRangeRegistrationOptions
----The server provides semantic tokens support.
----
----@since 3.16.0
----@field semanticTokensProvider? lsp.SemanticTokensOptions|lsp.SemanticTokensRegistrationOptions
----The server provides moniker support.
----
----@since 3.16.0
----@field monikerProvider? boolean|lsp.MonikerOptions|lsp.MonikerRegistrationOptions
----The server provides type hierarchy support.
----
----@since 3.17.0
----@field typeHierarchyProvider? boolean|lsp.TypeHierarchyOptions|lsp.TypeHierarchyRegistrationOptions
----The server provides inline values.
----
----@since 3.17.0
----@field inlineValueProvider? boolean|lsp.InlineValueOptions|lsp.InlineValueRegistrationOptions
----The server provides inlay hints.
----
----@since 3.17.0
----@field inlayHintProvider? boolean|lsp.InlayHintOptions|lsp.InlayHintRegistrationOptions
----The server has support for pull model diagnostics.
----
----@since 3.17.0
----@field diagnosticProvider? lsp.DiagnosticOptions|lsp.DiagnosticRegistrationOptions
----Inline completion options used during static registration.
----
----@since 3.18.0
----@field inlineCompletionProvider? boolean|lsp.InlineCompletionOptions
----Workspace specific server capabilities.
----@field workspace? anonym12
----Experimental server capabilities.
----@field experimental? lsp.LSPAny
-
----A text document identifier to denote a specific version of a text document.
----@class lsp.VersionedTextDocumentIdentifier: lsp.TextDocumentIdentifier
----The version number of this document.
----@field version integer
-
----Save options.
----@class lsp.SaveOptions
----The client is supposed to include the content on save.
----@field includeText? boolean
-
----An event describing a file change.
----@class lsp.FileEvent
----The file's uri.
----@field uri lsp.DocumentUri
----The change type.
----@field type lsp.FileChangeType
-
----@class lsp.FileSystemWatcher
----The glob pattern to watch. See {@link GlobPattern glob pattern} for more detail.
----
----@since 3.17.0 support for relative patterns.
----@field globPattern lsp.GlobPattern
----The kind of events of interest. If omitted it defaults
----to WatchKind.Create | WatchKind.Change | WatchKind.Delete
----which is 7.
----@field kind? lsp.WatchKind
-
----Represents a diagnostic, such as a compiler error or warning. Diagnostic objects
----are only valid in the scope of a resource.
----@class lsp.Diagnostic
----The range at which the message applies
----@field range lsp.Range
----The diagnostic's severity. Can be omitted. If omitted it is up to the
----client to interpret diagnostics as error, warning, info or hint.
----@field severity? lsp.DiagnosticSeverity
----The diagnostic's code, which usually appear in the user interface.
----@field code? integer|string
----An optional property to describe the error code.
----Requires the code field (above) to be present/not null.
----
----@since 3.16.0
----@field codeDescription? lsp.CodeDescription
----A human-readable string describing the source of this
----diagnostic, e.g. 'typescript' or 'super lint'. It usually
----appears in the user interface.
----@field source? string
----The diagnostic's message. It usually appears in the user interface
----@field message string
----Additional metadata about the diagnostic.
----
----@since 3.15.0
----@field tags? lsp.DiagnosticTag[]
----An array of related diagnostic information, e.g. when symbol-names within
----a scope collide all definitions can be marked via this property.
----@field relatedInformation? lsp.DiagnosticRelatedInformation[]
----A data entry field that is preserved between a `textDocument/publishDiagnostics`
----notification and `textDocument/codeAction` request.
----
----@since 3.16.0
----@field data? lsp.LSPAny
-
----Contains additional information about the context in which a completion request is triggered.
----@class lsp.CompletionContext
----How the completion was triggered.
----@field triggerKind lsp.CompletionTriggerKind
----The trigger character (a single character) that has trigger code complete.
----Is undefined if `triggerKind !== CompletionTriggerKind.TriggerCharacter`
----@field triggerCharacter? string
-
----Additional details for a completion item label.
----
----@since 3.17.0
----@class lsp.CompletionItemLabelDetails
----An optional string which is rendered less prominently directly after {@link CompletionItem.label label},
----without any spacing. Should be used for function signatures and type annotations.
----@field detail? string
----An optional string which is rendered less prominently after {@link CompletionItem.detail}. Should be used
----for fully qualified names and file paths.
----@field description? string
-
----A special text edit to provide an insert and a replace operation.
----
----@since 3.16.0
----@class lsp.InsertReplaceEdit
----The string to be inserted.
----@field newText string
----The range if the insert is requested
----@field insert lsp.Range
----The range if the replace is requested.
----@field replace lsp.Range
-
----Completion options.
----@class lsp.CompletionOptions
----Most tools trigger completion request automatically without explicitly requesting
----it using a keyboard shortcut (e.g. Ctrl+Space). Typically they do so when the user
----starts to type an identifier. For example if the user types `c` in a JavaScript file
----code complete will automatically pop up present `console` besides others as a
----completion item. Characters that make up identifiers don't need to be listed here.
----
----If code complete should automatically be trigger on characters not being valid inside
----an identifier (for example `.` in JavaScript) list them in `triggerCharacters`.
----@field triggerCharacters? string[]
----The list of all possible characters that commit a completion. This field can be used
----if clients don't support individual commit characters per completion item. See
----`ClientCapabilities.textDocument.completion.completionItem.commitCharactersSupport`
----
----If a server provides both `allCommitCharacters` and commit characters on an individual
----completion item the ones on the completion item win.
----
----@since 3.2.0
----@field allCommitCharacters? string[]
----The server provides support to resolve additional
----information for a completion item.
----@field resolveProvider? boolean
----The server supports the following `CompletionItem` specific
----capabilities.
----
----@since 3.17.0
----@field completionItem? anonym13
-
----Hover options.
----@class lsp.HoverOptions
-
----Additional information about the context in which a signature help request was triggered.
----
----@since 3.15.0
----@class lsp.SignatureHelpContext
----Action that caused signature help to be triggered.
----@field triggerKind lsp.SignatureHelpTriggerKind
----Character that caused signature help to be triggered.
----
----This is undefined when `triggerKind !== SignatureHelpTriggerKind.TriggerCharacter`
----@field triggerCharacter? string
----`true` if signature help was already showing when it was triggered.
----
----Retriggers occurs when the signature help is already active and can be caused by actions such as
----typing a trigger character, a cursor move, or document content changes.
----@field isRetrigger boolean
----The currently active `SignatureHelp`.
----
----The `activeSignatureHelp` has its `SignatureHelp.activeSignature` field updated based on
----the user navigating through available signatures.
----@field activeSignatureHelp? lsp.SignatureHelp
-
----Represents the signature of something callable. A signature
----can have a label, like a function-name, a doc-comment, and
----a set of parameters.
----@class lsp.SignatureInformation
----The label of this signature. Will be shown in
----the UI.
----@field label string
----The human-readable doc-comment of this signature. Will be shown
----in the UI but can be omitted.
----@field documentation? string|lsp.MarkupContent
----The parameters of this signature.
----@field parameters? lsp.ParameterInformation[]
----The index of the active parameter.
----
----If provided, this is used in place of `SignatureHelp.activeParameter`.
----
----@since 3.16.0
----@field activeParameter? uinteger
-
----Server Capabilities for a {@link SignatureHelpRequest}.
----@class lsp.SignatureHelpOptions
----List of characters that trigger signature help automatically.
----@field triggerCharacters? string[]
----List of characters that re-trigger signature help.
----
----These trigger characters are only active when signature help is already showing. All trigger characters
----are also counted as re-trigger characters.
----
----@since 3.15.0
----@field retriggerCharacters? string[]
-
----Server Capabilities for a {@link DefinitionRequest}.
----@class lsp.DefinitionOptions
-
----Value-object that contains additional information when
----requesting references.
----@class lsp.ReferenceContext
----Include the declaration of the current symbol.
----@field includeDeclaration boolean
-
----Reference options.
----@class lsp.ReferenceOptions
-
----Provider options for a {@link DocumentHighlightRequest}.
----@class lsp.DocumentHighlightOptions
-
----A base for all symbol information.
----@class lsp.BaseSymbolInformation
----The name of this symbol.
----@field name string
----The kind of this symbol.
----@field kind lsp.SymbolKind
----Tags for this symbol.
----
----@since 3.16.0
----@field tags? lsp.SymbolTag[]
----The name of the symbol containing this symbol. This information is for
----user interface purposes (e.g. to render a qualifier in the user interface
----if necessary). It can't be used to re-infer a hierarchy for the document
----symbols.
----@field containerName? string
-
----Provider options for a {@link DocumentSymbolRequest}.
----@class lsp.DocumentSymbolOptions
----A human-readable string that is shown when multiple outlines trees
----are shown for the same document.
----
----@since 3.16.0
----@field label? string
-
----Contains additional diagnostic information about the context in which
----a {@link CodeActionProvider.provideCodeActions code action} is run.
----@class lsp.CodeActionContext
----An array of diagnostics known on the client side overlapping the range provided to the
----`textDocument/codeAction` request. They are provided so that the server knows which
----errors are currently presented to the user for the given range. There is no guarantee
----that these accurately reflect the error state of the resource. The primary parameter
----to compute code actions is the provided range.
----@field diagnostics lsp.Diagnostic[]
----Requested kind of actions to return.
----
----Actions not of this kind are filtered out by the client before being shown. So servers
----can omit computing them.
----@field only? lsp.CodeActionKind[]
----The reason why code actions were requested.
----
----@since 3.17.0
----@field triggerKind? lsp.CodeActionTriggerKind
-
----Provider options for a {@link CodeActionRequest}.
----@class lsp.CodeActionOptions
----CodeActionKinds that this server may return.
----
----The list of kinds may be generic, such as `CodeActionKind.Refactor`, or the server
----may list out every specific kind they provide.
----@field codeActionKinds? lsp.CodeActionKind[]
----The server provides support to resolve additional
----information for a code action.
----
----@since 3.16.0
----@field resolveProvider? boolean
-
----Server capabilities for a {@link WorkspaceSymbolRequest}.
----@class lsp.WorkspaceSymbolOptions
----The server provides support to resolve additional
----information for a workspace symbol.
----
----@since 3.17.0
----@field resolveProvider? boolean
-
----Code Lens provider options of a {@link CodeLensRequest}.
----@class lsp.CodeLensOptions
----Code lens has a resolve provider as well.
----@field resolveProvider? boolean
-
----Provider options for a {@link DocumentLinkRequest}.
----@class lsp.DocumentLinkOptions
----Document links have a resolve provider as well.
----@field resolveProvider? boolean
-
----Value-object describing what options formatting should use.
----@class lsp.FormattingOptions
----Size of a tab in spaces.
----@field tabSize uinteger
----Prefer spaces over tabs.
----@field insertSpaces boolean
----Trim trailing whitespace on a line.
----
----@since 3.15.0
----@field trimTrailingWhitespace? boolean
----Insert a newline character at the end of the file if one does not exist.
----
----@since 3.15.0
----@field insertFinalNewline? boolean
----Trim all newlines after the final newline at the end of the file.
----
----@since 3.15.0
----@field trimFinalNewlines? boolean
-
----Provider options for a {@link DocumentFormattingRequest}.
----@class lsp.DocumentFormattingOptions
-
----Provider options for a {@link DocumentRangeFormattingRequest}.
----@class lsp.DocumentRangeFormattingOptions
----Whether the server supports formatting multiple ranges at once.
----
----@since 3.18.0
----@proposed
----@field rangesSupport? boolean
-
----Provider options for a {@link DocumentOnTypeFormattingRequest}.
----@class lsp.DocumentOnTypeFormattingOptions
----A character on which formatting should be triggered, like `{`.
----@field firstTriggerCharacter string
----More trigger characters.
----@field moreTriggerCharacter? string[]
-
----Provider options for a {@link RenameRequest}.
----@class lsp.RenameOptions
----Renames should be checked and tested before being executed.
----
----@since version 3.12.0
----@field prepareProvider? boolean
-
----The server capabilities of a {@link ExecuteCommandRequest}.
----@class lsp.ExecuteCommandOptions
----The commands to be executed on the server
----@field commands string[]
-
----@since 3.16.0
----@class lsp.SemanticTokensLegend
----The token types a server uses.
----@field tokenTypes string[]
----The token modifiers a server uses.
----@field tokenModifiers string[]
-
----A text document identifier to optionally denote a specific version of a text document.
----@class lsp.OptionalVersionedTextDocumentIdentifier: lsp.TextDocumentIdentifier
----The version number of this document. If a versioned text document identifier
----is sent from the server to the client and the file is not open in the editor
----(the server has not received an open notification before) the server can send
----`null` to indicate that the version is unknown and the content on disk is the
----truth (as specified with document content ownership).
----@field version integer|lsp.null
-
----A special text edit with an additional change annotation.
----
----@since 3.16.0.
----@class lsp.AnnotatedTextEdit: lsp.TextEdit
----The actual identifier of the change annotation
----@field annotationId lsp.ChangeAnnotationIdentifier
-
----A generic resource operation.
----@class lsp.ResourceOperation
----The resource operation kind.
----@field kind string
----An optional annotation identifier describing the operation.
----
----@since 3.16.0
----@field annotationId? lsp.ChangeAnnotationIdentifier
-
----Options to create a file.
----@class lsp.CreateFileOptions
----Overwrite existing file. Overwrite wins over `ignoreIfExists`
----@field overwrite? boolean
----Ignore if exists.
----@field ignoreIfExists? boolean
-
----Rename file options
----@class lsp.RenameFileOptions
----Overwrite target if existing. Overwrite wins over `ignoreIfExists`
----@field overwrite? boolean
----Ignores if target exists.
----@field ignoreIfExists? boolean
-
----Delete file options
----@class lsp.DeleteFileOptions
----Delete the content recursively if a folder is denoted.
----@field recursive? boolean
----Ignore the operation if the file doesn't exist.
----@field ignoreIfNotExists? boolean
-
----A pattern to describe in which file operation requests or notifications
----the server is interested in receiving.
----
----@since 3.16.0
----@class lsp.FileOperationPattern
----The glob pattern to match. Glob patterns can have the following syntax:
----- `*` to match one or more characters in a path segment
----- `?` to match on one character in a path segment
----- `**` to match any number of path segments, including none
----- `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
----- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
----- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
----@field glob string
----Whether to match files or folders with this pattern.
----
----Matches both if undefined.
----@field matches? lsp.FileOperationPatternKind
----Additional options used during matching.
----@field options? lsp.FileOperationPatternOptions
-
----A full document diagnostic report for a workspace diagnostic result.
----
----@since 3.17.0
----@class lsp.WorkspaceFullDocumentDiagnosticReport: lsp.FullDocumentDiagnosticReport
----The URI for which diagnostic information is reported.
----@field uri lsp.DocumentUri
----The version number for which the diagnostics are reported.
----If the document is not marked as open `null` can be provided.
----@field version integer|lsp.null
-
----An unchanged document diagnostic report for a workspace diagnostic result.
----
----@since 3.17.0
----@class lsp.WorkspaceUnchangedDocumentDiagnosticReport: lsp.UnchangedDocumentDiagnosticReport
----The URI for which diagnostic information is reported.
----@field uri lsp.DocumentUri
----The version number for which the diagnostics are reported.
----If the document is not marked as open `null` can be provided.
----@field version integer|lsp.null
-
----A notebook cell.
----
----A cell's document URI must be unique across ALL notebook
----cells and can therefore be used to uniquely identify a
----notebook cell or the cell's text document.
----
----@since 3.17.0
----@class lsp.NotebookCell
----The cell's kind
----@field kind lsp.NotebookCellKind
----The URI of the cell's text document
----content.
----@field document lsp.DocumentUri
----Additional metadata stored with the cell.
----
----Note: should always be an object literal (e.g. LSPObject)
----@field metadata? lsp.LSPObject
----Additional execution summary information
----if supported by the client.
----@field executionSummary? lsp.ExecutionSummary
-
----A change describing how to move a `NotebookCell`
----array from state S to S'.
----
----@since 3.17.0
----@class lsp.NotebookCellArrayChange
----The start oftest of the cell that changed.
----@field start uinteger
----The deleted cells
----@field deleteCount uinteger
----The new cells, if any
----@field cells? lsp.NotebookCell[]
-
----Describes the currently selected completion item.
----
----@since 3.18.0
----@class lsp.SelectedCompletionInfo
----The range that will be replaced if this completion item is accepted.
----@field range lsp.Range
----The text the range will be replaced with if this completion is accepted.
----@field text string
-
----Defines the capabilities provided by the client.
----@class lsp.ClientCapabilities
----Workspace specific client capabilities.
----@field workspace? lsp.WorkspaceClientCapabilities
----Text document specific client capabilities.
----@field textDocument? lsp.TextDocumentClientCapabilities
----Capabilities specific to the notebook document support.
----
----@since 3.17.0
----@field notebookDocument? lsp.NotebookDocumentClientCapabilities
----Window specific client capabilities.
----@field window? lsp.WindowClientCapabilities
----General client capabilities.
----
----@since 3.16.0
----@field general? lsp.GeneralClientCapabilities
----Experimental client capabilities.
----@field experimental? lsp.LSPAny
-
----@class lsp.TextDocumentSyncOptions
----Open and close notifications are sent to the server. If omitted open close notification should not
----be sent.
----@field openClose? boolean
----Change notifications are sent to the server. See TextDocumentSyncKind.None, TextDocumentSyncKind.Full
----and TextDocumentSyncKind.Incremental. If omitted it defaults to TextDocumentSyncKind.None.
----@field change? lsp.TextDocumentSyncKind
----If present will save notifications are sent to the server. If omitted the notification should not be
----sent.
----@field willSave? boolean
----If present will save wait until requests are sent to the server. If omitted the request should not be
----sent.
----@field willSaveWaitUntil? boolean
----If present save notifications are sent to the server. If omitted the notification should not be
----sent.
----@field save? boolean|lsp.SaveOptions
-
----Options specific to a notebook plus its cells
----to be synced to the server.
----
----If a selector provides a notebook document
----filter but no cell selector all cells of a
----matching notebook document will be synced.
----
----If a selector provides no notebook document
----filter but only a cell selector all notebook
----document that contain at least one matching
----cell will be synced.
----
----@since 3.17.0
----@class lsp.NotebookDocumentSyncOptions
----The notebooks to be synced
----@field notebookSelector anonym15|anonym17[]
----Whether save notification should be forwarded to
----the server. Will only be honored if mode === `notebook`.
----@field save? boolean
-
----Registration options specific to a notebook.
----
----@since 3.17.0
----@class lsp.NotebookDocumentSyncRegistrationOptions: lsp.NotebookDocumentSyncOptions, lsp.StaticRegistrationOptions
-
----@class lsp.WorkspaceFoldersServerCapabilities
----The server has support for workspace folders
----@field supported? boolean
----Whether the server wants to receive workspace folder
----change notifications.
----
----If a string is provided the string is treated as an ID
----under which the notification is registered on the client
----side. The ID can be used to unregister for these events
----using the `client/unregisterCapability` request.
----@field changeNotifications? string|boolean
-
----Options for notifications/requests for user operations on files.
----
----@since 3.16.0
----@class lsp.FileOperationOptions
----The server is interested in receiving didCreateFiles notifications.
----@field didCreate? lsp.FileOperationRegistrationOptions
----The server is interested in receiving willCreateFiles requests.
----@field willCreate? lsp.FileOperationRegistrationOptions
----The server is interested in receiving didRenameFiles notifications.
----@field didRename? lsp.FileOperationRegistrationOptions
----The server is interested in receiving willRenameFiles requests.
----@field willRename? lsp.FileOperationRegistrationOptions
----The server is interested in receiving didDeleteFiles file notifications.
----@field didDelete? lsp.FileOperationRegistrationOptions
----The server is interested in receiving willDeleteFiles file requests.
----@field willDelete? lsp.FileOperationRegistrationOptions
-
----Structure to capture a description for an error code.
----
----@since 3.16.0
----@class lsp.CodeDescription
----An URI to open with more information about the diagnostic error.
----@field href lsp.URI
-
----Represents a related message and source code location for a diagnostic. This should be
----used to point to code locations that cause or related to a diagnostics, e.g when duplicating
----a symbol in a scope.
----@class lsp.DiagnosticRelatedInformation
----The location of this related diagnostic information.
----@field location lsp.Location
----The message of this related diagnostic information.
----@field message string
-
----Represents a parameter of a callable-signature. A parameter can
----have a label and a doc-comment.
----@class lsp.ParameterInformation
----The label of this parameter information.
----
----Either a string or an inclusive start and exclusive end offsets within its containing
----signature label. (see SignatureInformation.label). The offsets are based on a UTF-16
----string representation as `Position` and `Range` does.
----
----*Note*: a label of type string should be a substring of its containing signature label.
----Its intended use case is to highlight the parameter label part in the `SignatureInformation.label`.
----@field label string|{ [1]: uinteger, [2]: uinteger }
----The human-readable doc-comment of this parameter. Will be shown
----in the UI but can be omitted.
----@field documentation? string|lsp.MarkupContent
-
----A notebook cell text document filter denotes a cell text
----document by different properties.
----
----@since 3.17.0
----@class lsp.NotebookCellTextDocumentFilter
----A filter that matches against the notebook
----containing the notebook cell. If a string
----value is provided it matches against the
----notebook type. '*' matches every notebook.
----@field notebook string|lsp.NotebookDocumentFilter
----A language id like `python`.
----
----Will be matched against the language id of the
----notebook cell document. '*' matches every language.
----@field language? string
-
----Matching options for the file operation pattern.
----
----@since 3.16.0
----@class lsp.FileOperationPatternOptions
----The pattern should be matched ignoring casing.
----@field ignoreCase? boolean
-
----@class lsp.ExecutionSummary
----A strict monotonically increasing value
----indicating the execution order of a cell
----inside a notebook.
----@field executionOrder uinteger
----Whether the execution was successful or
----not if known by the client.
----@field success? boolean
-
----Workspace specific client capabilities.
----@class lsp.WorkspaceClientCapabilities
----The client supports applying batch edits
----to the workspace by supporting the request
----'workspace/applyEdit'
----@field applyEdit? boolean
----Capabilities specific to `WorkspaceEdit`s.
----@field workspaceEdit? lsp.WorkspaceEditClientCapabilities
----Capabilities specific to the `workspace/didChangeConfiguration` notification.
----@field didChangeConfiguration? lsp.DidChangeConfigurationClientCapabilities
----Capabilities specific to the `workspace/didChangeWatchedFiles` notification.
----@field didChangeWatchedFiles? lsp.DidChangeWatchedFilesClientCapabilities
----Capabilities specific to the `workspace/symbol` request.
----@field symbol? lsp.WorkspaceSymbolClientCapabilities
----Capabilities specific to the `workspace/executeCommand` request.
----@field executeCommand? lsp.ExecuteCommandClientCapabilities
----The client has support for workspace folders.
----
----@since 3.6.0
----@field workspaceFolders? boolean
----The client supports `workspace/configuration` requests.
----
----@since 3.6.0
----@field configuration? boolean
----Capabilities specific to the semantic token requests scoped to the
----workspace.
----
----@since 3.16.0.
----@field semanticTokens? lsp.SemanticTokensWorkspaceClientCapabilities
----Capabilities specific to the code lens requests scoped to the
----workspace.
----
----@since 3.16.0.
----@field codeLens? lsp.CodeLensWorkspaceClientCapabilities
----The client has support for file notifications/requests for user operations on files.
----
----Since 3.16.0
----@field fileOperations? lsp.FileOperationClientCapabilities
----Capabilities specific to the inline values requests scoped to the
----workspace.
----
----@since 3.17.0.
----@field inlineValue? lsp.InlineValueWorkspaceClientCapabilities
----Capabilities specific to the inlay hint requests scoped to the
----workspace.
----
----@since 3.17.0.
----@field inlayHint? lsp.InlayHintWorkspaceClientCapabilities
----Capabilities specific to the diagnostic requests scoped to the
----workspace.
----
----@since 3.17.0.
----@field diagnostics? lsp.DiagnosticWorkspaceClientCapabilities
-
----Text document specific client capabilities.
----@class lsp.TextDocumentClientCapabilities
----Defines which synchronization capabilities the client supports.
----@field synchronization? lsp.TextDocumentSyncClientCapabilities
----Capabilities specific to the `textDocument/completion` request.
----@field completion? lsp.CompletionClientCapabilities
----Capabilities specific to the `textDocument/hover` request.
----@field hover? lsp.HoverClientCapabilities
----Capabilities specific to the `textDocument/signatureHelp` request.
----@field signatureHelp? lsp.SignatureHelpClientCapabilities
----Capabilities specific to the `textDocument/declaration` request.
----
----@since 3.14.0
----@field declaration? lsp.DeclarationClientCapabilities
----Capabilities specific to the `textDocument/definition` request.
----@field definition? lsp.DefinitionClientCapabilities
----Capabilities specific to the `textDocument/typeDefinition` request.
----
----@since 3.6.0
----@field typeDefinition? lsp.TypeDefinitionClientCapabilities
----Capabilities specific to the `textDocument/implementation` request.
----
----@since 3.6.0
----@field implementation? lsp.ImplementationClientCapabilities
----Capabilities specific to the `textDocument/references` request.
----@field references? lsp.ReferenceClientCapabilities
----Capabilities specific to the `textDocument/documentHighlight` request.
----@field documentHighlight? lsp.DocumentHighlightClientCapabilities
----Capabilities specific to the `textDocument/documentSymbol` request.
----@field documentSymbol? lsp.DocumentSymbolClientCapabilities
----Capabilities specific to the `textDocument/codeAction` request.
----@field codeAction? lsp.CodeActionClientCapabilities
----Capabilities specific to the `textDocument/codeLens` request.
----@field codeLens? lsp.CodeLensClientCapabilities
----Capabilities specific to the `textDocument/documentLink` request.
----@field documentLink? lsp.DocumentLinkClientCapabilities
----Capabilities specific to the `textDocument/documentColor` and the
----`textDocument/colorPresentation` request.
----
----@since 3.6.0
----@field colorProvider? lsp.DocumentColorClientCapabilities
----Capabilities specific to the `textDocument/formatting` request.
----@field formatting? lsp.DocumentFormattingClientCapabilities
----Capabilities specific to the `textDocument/rangeFormatting` request.
----@field rangeFormatting? lsp.DocumentRangeFormattingClientCapabilities
----Capabilities specific to the `textDocument/onTypeFormatting` request.
----@field onTypeFormatting? lsp.DocumentOnTypeFormattingClientCapabilities
----Capabilities specific to the `textDocument/rename` request.
----@field rename? lsp.RenameClientCapabilities
----Capabilities specific to the `textDocument/foldingRange` request.
----
----@since 3.10.0
----@field foldingRange? lsp.FoldingRangeClientCapabilities
----Capabilities specific to the `textDocument/selectionRange` request.
----
----@since 3.15.0
----@field selectionRange? lsp.SelectionRangeClientCapabilities
----Capabilities specific to the `textDocument/publishDiagnostics` notification.
----@field publishDiagnostics? lsp.PublishDiagnosticsClientCapabilities
----Capabilities specific to the various call hierarchy requests.
----
----@since 3.16.0
----@field callHierarchy? lsp.CallHierarchyClientCapabilities
----Capabilities specific to the various semantic token request.
----
----@since 3.16.0
----@field semanticTokens? lsp.SemanticTokensClientCapabilities
----Capabilities specific to the `textDocument/linkedEditingRange` request.
----
----@since 3.16.0
----@field linkedEditingRange? lsp.LinkedEditingRangeClientCapabilities
----Client capabilities specific to the `textDocument/moniker` request.
----
----@since 3.16.0
----@field moniker? lsp.MonikerClientCapabilities
----Capabilities specific to the various type hierarchy requests.
----
----@since 3.17.0
----@field typeHierarchy? lsp.TypeHierarchyClientCapabilities
----Capabilities specific to the `textDocument/inlineValue` request.
----
----@since 3.17.0
----@field inlineValue? lsp.InlineValueClientCapabilities
----Capabilities specific to the `textDocument/inlayHint` request.
----
----@since 3.17.0
----@field inlayHint? lsp.InlayHintClientCapabilities
----Capabilities specific to the diagnostic pull model.
----
----@since 3.17.0
----@field diagnostic? lsp.DiagnosticClientCapabilities
----Client capabilities specific to inline completions.
----
----@since 3.18.0
----@field inlineCompletion? lsp.InlineCompletionClientCapabilities
-
----Capabilities specific to the notebook document support.
----
----@since 3.17.0
----@class lsp.NotebookDocumentClientCapabilities
----Capabilities specific to notebook document synchronization
----
----@since 3.17.0
----@field synchronization lsp.NotebookDocumentSyncClientCapabilities
-
----@class lsp.WindowClientCapabilities
----It indicates whether the client supports server initiated
----progress using the `window/workDoneProgress/create` request.
----
----The capability also controls Whether client supports handling
----of progress notifications. If set servers are allowed to report a
----`workDoneProgress` property in the request specific server
----capabilities.
----
----@since 3.15.0
----@field workDoneProgress? boolean
----Capabilities specific to the showMessage request.
----
----@since 3.16.0
----@field showMessage? lsp.ShowMessageRequestClientCapabilities
----Capabilities specific to the showDocument request.
----
----@since 3.16.0
----@field showDocument? lsp.ShowDocumentClientCapabilities
-
----General client capabilities.
----
----@since 3.16.0
----@class lsp.GeneralClientCapabilities
----Client capability that signals how the client
----handles stale requests (e.g. a request
----for which the client will not process the response
----anymore since the information is outdated).
----
----@since 3.17.0
----@field staleRequestSupport? anonym18
----Client capabilities specific to regular expressions.
----
----@since 3.16.0
----@field regularExpressions? lsp.RegularExpressionsClientCapabilities
----Client capabilities specific to the client's markdown parser.
----
----@since 3.16.0
----@field markdown? lsp.MarkdownClientCapabilities
----The position encodings supported by the client. Client and server
----have to agree on the same position encoding to ensure that offsets
----(e.g. character position in a line) are interpreted the same on both
----sides.
----
----To keep the protocol backwards compatible the following applies: if
----the value 'utf-16' is missing from the array of position encodings
----servers can assume that the client supports UTF-16. UTF-16 is
----therefore a mandatory encoding.
----
----If omitted it defaults to ['utf-16'].
----
----Implementation considerations: since the conversion from one encoding
----into another requires the content of the file / line the conversion
----is best done where the file is read which is usually on the server
----side.
----
----@since 3.17.0
----@field positionEncodings? lsp.PositionEncodingKind[]
-
----A relative pattern is a helper to construct glob patterns that are matched
----relatively to a base URI. The common value for a `baseUri` is a workspace
----folder root, but it can be another absolute URI as well.
----
----@since 3.17.0
----@class lsp.RelativePattern
----A workspace folder or a base URI to which this pattern will be matched
----against relatively.
----@field baseUri lsp.WorkspaceFolder|lsp.URI
----The actual glob pattern;
----@field pattern lsp.Pattern
-
----@class lsp.WorkspaceEditClientCapabilities
----The client supports versioned document changes in `WorkspaceEdit`s
----@field documentChanges? boolean
----The resource operations the client supports. Clients should at least
----support 'create', 'rename' and 'delete' files and folders.
----
----@since 3.13.0
----@field resourceOperations? lsp.ResourceOperationKind[]
----The failure handling strategy of a client if applying the workspace edit
----fails.
----
----@since 3.13.0
----@field failureHandling? lsp.FailureHandlingKind
----Whether the client normalizes line endings to the client specific
----setting.
----If set to `true` the client will normalize line ending characters
----in a workspace edit to the client-specified new line
----character.
----
----@since 3.16.0
----@field normalizesLineEndings? boolean
----Whether the client in general supports change annotations on text edits,
----create file, rename file and delete file changes.
----
----@since 3.16.0
----@field changeAnnotationSupport? anonym19
-
----@class lsp.DidChangeConfigurationClientCapabilities
----Did change configuration notification supports dynamic registration.
----@field dynamicRegistration? boolean
-
----@class lsp.DidChangeWatchedFilesClientCapabilities
----Did change watched files notification supports dynamic registration. Please note
----that the current protocol doesn't support static configuration for file changes
----from the server side.
----@field dynamicRegistration? boolean
----Whether the client has support for {@link  RelativePattern relative pattern}
----or not.
----
----@since 3.17.0
----@field relativePatternSupport? boolean
-
----Client capabilities for a {@link WorkspaceSymbolRequest}.
----@class lsp.WorkspaceSymbolClientCapabilities
----Symbol request supports dynamic registration.
----@field dynamicRegistration? boolean
----Specific capabilities for the `SymbolKind` in the `workspace/symbol` request.
----@field symbolKind? anonym20
----The client supports tags on `SymbolInformation`.
----Clients supporting tags have to handle unknown tags gracefully.
----
----@since 3.16.0
----@field tagSupport? anonym21
----The client support partial workspace symbols. The client will send the
----request `workspaceSymbol/resolve` to the server to resolve additional
----properties.
----
----@since 3.17.0
----@field resolveSupport? anonym22
-
----The client capabilities of a {@link ExecuteCommandRequest}.
----@class lsp.ExecuteCommandClientCapabilities
----Execute command supports dynamic registration.
----@field dynamicRegistration? boolean
-
----@since 3.16.0
----@class lsp.SemanticTokensWorkspaceClientCapabilities
----Whether the client implementation supports a refresh request sent from
----the server to the client.
----
----Note that this event is global and will force the client to refresh all
----semantic tokens currently shown. It should be used with absolute care
----and is useful for situation where a server for example detects a project
----wide change that requires such a calculation.
----@field refreshSupport? boolean
-
----@since 3.16.0
----@class lsp.CodeLensWorkspaceClientCapabilities
----Whether the client implementation supports a refresh request sent from the
----server to the client.
----
----Note that this event is global and will force the client to refresh all
----code lenses currently shown. It should be used with absolute care and is
----useful for situation where a server for example detect a project wide
----change that requires such a calculation.
----@field refreshSupport? boolean
-
----Capabilities relating to events from file operations by the user in the client.
----
----These events do not come from the file system, they come from user operations
----like renaming a file in the UI.
----
----@since 3.16.0
----@class lsp.FileOperationClientCapabilities
----Whether the client supports dynamic registration for file requests/notifications.
----@field dynamicRegistration? boolean
----The client has support for sending didCreateFiles notifications.
----@field didCreate? boolean
----The client has support for sending willCreateFiles requests.
----@field willCreate? boolean
----The client has support for sending didRenameFiles notifications.
----@field didRename? boolean
----The client has support for sending willRenameFiles requests.
----@field willRename? boolean
----The client has support for sending didDeleteFiles notifications.
----@field didDelete? boolean
----The client has support for sending willDeleteFiles requests.
----@field willDelete? boolean
-
----Client workspace capabilities specific to inline values.
----
----@since 3.17.0
----@class lsp.InlineValueWorkspaceClientCapabilities
----Whether the client implementation supports a refresh request sent from the
----server to the client.
----
----Note that this event is global and will force the client to refresh all
----inline values currently shown. It should be used with absolute care and is
----useful for situation where a server for example detects a project wide
----change that requires such a calculation.
----@field refreshSupport? boolean
-
----Client workspace capabilities specific to inlay hints.
----
----@since 3.17.0
----@class lsp.InlayHintWorkspaceClientCapabilities
----Whether the client implementation supports a refresh request sent from
----the server to the client.
----
----Note that this event is global and will force the client to refresh all
----inlay hints currently shown. It should be used with absolute care and
----is useful for situation where a server for example detects a project wide
----change that requires such a calculation.
----@field refreshSupport? boolean
-
----Workspace client capabilities specific to diagnostic pull requests.
----
----@since 3.17.0
----@class lsp.DiagnosticWorkspaceClientCapabilities
----Whether the client implementation supports a refresh request sent from
----the server to the client.
----
----Note that this event is global and will force the client to refresh all
----pulled diagnostics currently shown. It should be used with absolute care and
----is useful for situation where a server for example detects a project wide
----change that requires such a calculation.
----@field refreshSupport? boolean
-
----@class lsp.TextDocumentSyncClientCapabilities
----Whether text document synchronization supports dynamic registration.
----@field dynamicRegistration? boolean
----The client supports sending will save notifications.
----@field willSave? boolean
----The client supports sending a will save request and
----waits for a response providing text edits which will
----be applied to the document before it is saved.
----@field willSaveWaitUntil? boolean
----The client supports did save notifications.
----@field didSave? boolean
-
----Completion client capabilities
----@class lsp.CompletionClientCapabilities
----Whether completion supports dynamic registration.
----@field dynamicRegistration? boolean
----The client supports the following `CompletionItem` specific
----capabilities.
----@field completionItem? anonym26
----@field completionItemKind? anonym27
----Defines how the client handles whitespace and indentation
----when accepting a completion item that uses multi line
----text in either `insertText` or `textEdit`.
----
----@since 3.17.0
----@field insertTextMode? lsp.InsertTextMode
----The client supports to send additional context information for a
----`textDocument/completion` request.
----@field contextSupport? boolean
----The client supports the following `CompletionList` specific
----capabilities.
----
----@since 3.17.0
----@field completionList? anonym28
-
----@class lsp.HoverClientCapabilities
----Whether hover supports dynamic registration.
----@field dynamicRegistration? boolean
----Client supports the following content formats for the content
----property. The order describes the preferred format of the client.
----@field contentFormat? lsp.MarkupKind[]
-
----Client Capabilities for a {@link SignatureHelpRequest}.
----@class lsp.SignatureHelpClientCapabilities
----Whether signature help supports dynamic registration.
----@field dynamicRegistration? boolean
----The client supports the following `SignatureInformation`
----specific properties.
----@field signatureInformation? anonym30
----The client supports to send additional context information for a
----`textDocument/signatureHelp` request. A client that opts into
----contextSupport will also support the `retriggerCharacters` on
----`SignatureHelpOptions`.
----
----@since 3.15.0
----@field contextSupport? boolean
-
----@since 3.14.0
----@class lsp.DeclarationClientCapabilities
----Whether declaration supports dynamic registration. If this is set to `true`
----the client supports the new `DeclarationRegistrationOptions` return value
----for the corresponding server capability as well.
----@field dynamicRegistration? boolean
----The client supports additional metadata in the form of declaration links.
----@field linkSupport? boolean
-
----Client Capabilities for a {@link DefinitionRequest}.
----@class lsp.DefinitionClientCapabilities
----Whether definition supports dynamic registration.
----@field dynamicRegistration? boolean
----The client supports additional metadata in the form of definition links.
----
----@since 3.14.0
----@field linkSupport? boolean
-
----Since 3.6.0
----@class lsp.TypeDefinitionClientCapabilities
----Whether implementation supports dynamic registration. If this is set to `true`
----the client supports the new `TypeDefinitionRegistrationOptions` return value
----for the corresponding server capability as well.
----@field dynamicRegistration? boolean
----The client supports additional metadata in the form of definition links.
----
----Since 3.14.0
----@field linkSupport? boolean
-
----@since 3.6.0
----@class lsp.ImplementationClientCapabilities
----Whether implementation supports dynamic registration. If this is set to `true`
----the client supports the new `ImplementationRegistrationOptions` return value
----for the corresponding server capability as well.
----@field dynamicRegistration? boolean
----The client supports additional metadata in the form of definition links.
----
----@since 3.14.0
----@field linkSupport? boolean
-
----Client Capabilities for a {@link ReferencesRequest}.
----@class lsp.ReferenceClientCapabilities
----Whether references supports dynamic registration.
----@field dynamicRegistration? boolean
-
----Client Capabilities for a {@link DocumentHighlightRequest}.
----@class lsp.DocumentHighlightClientCapabilities
----Whether document highlight supports dynamic registration.
----@field dynamicRegistration? boolean
-
----Client Capabilities for a {@link DocumentSymbolRequest}.
----@class lsp.DocumentSymbolClientCapabilities
----Whether document symbol supports dynamic registration.
----@field dynamicRegistration? boolean
----Specific capabilities for the `SymbolKind` in the
----`textDocument/documentSymbol` request.
----@field symbolKind? anonym31
----The client supports hierarchical document symbols.
----@field hierarchicalDocumentSymbolSupport? boolean
----The client supports tags on `SymbolInformation`. Tags are supported on
----`DocumentSymbol` if `hierarchicalDocumentSymbolSupport` is set to true.
----Clients supporting tags have to handle unknown tags gracefully.
----
----@since 3.16.0
----@field tagSupport? anonym32
----The client supports an additional label presented in the UI when
----registering a document symbol provider.
----
----@since 3.16.0
----@field labelSupport? boolean
-
----The Client Capabilities of a {@link CodeActionRequest}.
----@class lsp.CodeActionClientCapabilities
----Whether code action supports dynamic registration.
----@field dynamicRegistration? boolean
----The client support code action literals of type `CodeAction` as a valid
----response of the `textDocument/codeAction` request. If the property is not
----set the request can only return `Command` literals.
----
----@since 3.8.0
----@field codeActionLiteralSupport? anonym34
----Whether code action supports the `isPreferred` property.
----
----@since 3.15.0
----@field isPreferredSupport? boolean
----Whether code action supports the `disabled` property.
----
----@since 3.16.0
----@field disabledSupport? boolean
----Whether code action supports the `data` property which is
----preserved between a `textDocument/codeAction` and a
----`codeAction/resolve` request.
----
----@since 3.16.0
----@field dataSupport? boolean
----Whether the client supports resolving additional code action
----properties via a separate `codeAction/resolve` request.
----
----@since 3.16.0
----@field resolveSupport? anonym35
----Whether the client honors the change annotations in
----text edits and resource operations returned via the
----`CodeAction#edit` property by for example presenting
----the workspace edit in the user interface and asking
----for confirmation.
----
----@since 3.16.0
----@field honorsChangeAnnotations? boolean
-
----The client capabilities  of a {@link CodeLensRequest}.
----@class lsp.CodeLensClientCapabilities
----Whether code lens supports dynamic registration.
----@field dynamicRegistration? boolean
-
----The client capabilities of a {@link DocumentLinkRequest}.
----@class lsp.DocumentLinkClientCapabilities
----Whether document link supports dynamic registration.
----@field dynamicRegistration? boolean
----Whether the client supports the `tooltip` property on `DocumentLink`.
----
----@since 3.15.0
----@field tooltipSupport? boolean
-
----@class lsp.DocumentColorClientCapabilities
----Whether implementation supports dynamic registration. If this is set to `true`
----the client supports the new `DocumentColorRegistrationOptions` return value
----for the corresponding server capability as well.
----@field dynamicRegistration? boolean
-
----Client capabilities of a {@link DocumentFormattingRequest}.
----@class lsp.DocumentFormattingClientCapabilities
----Whether formatting supports dynamic registration.
----@field dynamicRegistration? boolean
-
----Client capabilities of a {@link DocumentRangeFormattingRequest}.
----@class lsp.DocumentRangeFormattingClientCapabilities
----Whether range formatting supports dynamic registration.
----@field dynamicRegistration? boolean
----Whether the client supports formatting multiple ranges at once.
----
----@since 3.18.0
----@proposed
----@field rangesSupport? boolean
-
----Client capabilities of a {@link DocumentOnTypeFormattingRequest}.
----@class lsp.DocumentOnTypeFormattingClientCapabilities
----Whether on type formatting supports dynamic registration.
----@field dynamicRegistration? boolean
-
----@class lsp.RenameClientCapabilities
----Whether rename supports dynamic registration.
----@field dynamicRegistration? boolean
----Client supports testing for validity of rename operations
----before execution.
----
----@since 3.12.0
----@field prepareSupport? boolean
----Client supports the default behavior result.
----
----The value indicates the default behavior used by the
----client.
----
----@since 3.16.0
----@field prepareSupportDefaultBehavior? lsp.PrepareSupportDefaultBehavior
----Whether the client honors the change annotations in
----text edits and resource operations returned via the
----rename request's workspace edit by for example presenting
----the workspace edit in the user interface and asking
----for confirmation.
----
----@since 3.16.0
----@field honorsChangeAnnotations? boolean
-
----@class lsp.FoldingRangeClientCapabilities
----Whether implementation supports dynamic registration for folding range
----providers. If this is set to `true` the client supports the new
----`FoldingRangeRegistrationOptions` return value for the corresponding
----server capability as well.
----@field dynamicRegistration? boolean
----The maximum number of folding ranges that the client prefers to receive
----per document. The value serves as a hint, servers are free to follow the
----limit.
----@field rangeLimit? uinteger
----If set, the client signals that it only supports folding complete lines.
----If set, client will ignore specified `startCharacter` and `endCharacter`
----properties in a FoldingRange.
----@field lineFoldingOnly? boolean
----Specific options for the folding range kind.
----
----@since 3.17.0
----@field foldingRangeKind? anonym36
----Specific options for the folding range.
----
----@since 3.17.0
----@field foldingRange? anonym37
-
----@class lsp.SelectionRangeClientCapabilities
----Whether implementation supports dynamic registration for selection range providers. If this is set to `true`
----the client supports the new `SelectionRangeRegistrationOptions` return value for the corresponding server
----capability as well.
----@field dynamicRegistration? boolean
-
----The publish diagnostic client capabilities.
----@class lsp.PublishDiagnosticsClientCapabilities
----Whether the clients accepts diagnostics with related information.
----@field relatedInformation? boolean
----Client supports the tag property to provide meta data about a diagnostic.
----Clients supporting tags have to handle unknown tags gracefully.
----
----@since 3.15.0
----@field tagSupport? anonym38
----Whether the client interprets the version property of the
----`textDocument/publishDiagnostics` notification's parameter.
----
----@since 3.15.0
----@field versionSupport? boolean
----Client supports a codeDescription property
----
----@since 3.16.0
----@field codeDescriptionSupport? boolean
----Whether code action supports the `data` property which is
----preserved between a `textDocument/publishDiagnostics` and
----`textDocument/codeAction` request.
----
----@since 3.16.0
----@field dataSupport? boolean
-
----@since 3.16.0
----@class lsp.CallHierarchyClientCapabilities
----Whether implementation supports dynamic registration. If this is set to `true`
----the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
----return value for the corresponding server capability as well.
----@field dynamicRegistration? boolean
-
----@since 3.16.0
----@class lsp.SemanticTokensClientCapabilities
----Whether implementation supports dynamic registration. If this is set to `true`
----the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
----return value for the corresponding server capability as well.
----@field dynamicRegistration? boolean
----Which requests the client supports and might send to the server
----depending on the server's capability. Please note that clients might not
----show semantic tokens or degrade some of the user experience if a range
----or full request is advertised by the client but not provided by the
----server. If for example the client capability `requests.full` and
----`request.range` are both set to true but the server only provides a
----range provider the client might not render a minimap correctly or might
----even decide to not show any semantic tokens at all.
----@field requests anonym41
----The token types that the client supports.
----@field tokenTypes string[]
----The token modifiers that the client supports.
----@field tokenModifiers string[]
----The token formats the clients supports.
----@field formats lsp.TokenFormat[]
----Whether the client supports tokens that can overlap each other.
----@field overlappingTokenSupport? boolean
----Whether the client supports tokens that can span multiple lines.
----@field multilineTokenSupport? boolean
----Whether the client allows the server to actively cancel a
----semantic token request, e.g. supports returning
----LSPErrorCodes.ServerCancelled. If a server does the client
----needs to retrigger the request.
----
----@since 3.17.0
----@field serverCancelSupport? boolean
----Whether the client uses semantic tokens to augment existing
----syntax tokens. If set to `true` client side created syntax
----tokens and semantic tokens are both used for colorization. If
----set to `false` the client only uses the returned semantic tokens
----for colorization.
----
----If the value is `undefined` then the client behavior is not
----specified.
----
----@since 3.17.0
----@field augmentsSyntaxTokens? boolean
-
----Client capabilities for the linked editing range request.
----
----@since 3.16.0
----@class lsp.LinkedEditingRangeClientCapabilities
----Whether implementation supports dynamic registration. If this is set to `true`
----the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
----return value for the corresponding server capability as well.
----@field dynamicRegistration? boolean
-
----Client capabilities specific to the moniker request.
----
----@since 3.16.0
----@class lsp.MonikerClientCapabilities
----Whether moniker supports dynamic registration. If this is set to `true`
----the client supports the new `MonikerRegistrationOptions` return value
----for the corresponding server capability as well.
----@field dynamicRegistration? boolean
-
----@since 3.17.0
----@class lsp.TypeHierarchyClientCapabilities
----Whether implementation supports dynamic registration. If this is set to `true`
----the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
----return value for the corresponding server capability as well.
----@field dynamicRegistration? boolean
-
----Client capabilities specific to inline values.
----
----@since 3.17.0
----@class lsp.InlineValueClientCapabilities
----Whether implementation supports dynamic registration for inline value providers.
----@field dynamicRegistration? boolean
-
----Inlay hint client capabilities.
----
----@since 3.17.0
----@class lsp.InlayHintClientCapabilities
----Whether inlay hints support dynamic registration.
----@field dynamicRegistration? boolean
----Indicates which properties a client can resolve lazily on an inlay
----hint.
----@field resolveSupport? anonym42
-
----Client capabilities specific to diagnostic pull requests.
----
----@since 3.17.0
----@class lsp.DiagnosticClientCapabilities
----Whether implementation supports dynamic registration. If this is set to `true`
----the client supports the new `(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
----return value for the corresponding server capability as well.
----@field dynamicRegistration? boolean
----Whether the clients supports related documents for document diagnostic pulls.
----@field relatedDocumentSupport? boolean
-
----Client capabilities specific to inline completions.
----
----@since 3.18.0
----@class lsp.InlineCompletionClientCapabilities
----Whether implementation supports dynamic registration for inline completion providers.
----@field dynamicRegistration? boolean
-
----Notebook specific client capabilities.
----
----@since 3.17.0
----@class lsp.NotebookDocumentSyncClientCapabilities
----Whether implementation supports dynamic registration. If this is
----set to `true` the client supports the new
----`(TextDocumentRegistrationOptions & StaticRegistrationOptions)`
----return value for the corresponding server capability as well.
----@field dynamicRegistration? boolean
----The client supports sending execution summary data per cell.
----@field executionSummarySupport? boolean
-
----Show message request client capabilities
----@class lsp.ShowMessageRequestClientCapabilities
----Capabilities specific to the `MessageActionItem` type.
----@field messageActionItem? anonym43
-
----Client capabilities for the showDocument request.
----
----@since 3.16.0
----@class lsp.ShowDocumentClientCapabilities
----The client has support for the showDocument
----request.
----@field support boolean
-
----Client capabilities specific to regular expressions.
----
----@since 3.16.0
----@class lsp.RegularExpressionsClientCapabilities
----The engine's name.
----@field engine string
----The engine's version.
----@field version? string
-
----Client capabilities specific to the used markdown parser.
----
----@since 3.16.0
----@class lsp.MarkdownClientCapabilities
----The name of the parser.
----@field parser string
----The version of the parser.
----@field version? string
----A list of HTML tags that the client allows / supports in
----Markdown.
----
----@since 3.17.0
----@field allowedTags? string[]
-
----A set of predefined token types. This set is not fixed
----an clients can specify additional token types via the
----corresponding client capabilities.
----
----@since 3.16.0
----@alias lsp.SemanticTokenTypes
----| "namespace" # namespace
----| "type" # type
----| "class" # class
----| "enum" # enum
----| "interface" # interface
----| "struct" # struct
----| "typeParameter" # typeParameter
----| "parameter" # parameter
----| "variable" # variable
----| "property" # property
----| "enumMember" # enumMember
----| "event" # event
----| "function" # function
----| "method" # method
----| "macro" # macro
----| "keyword" # keyword
----| "modifier" # modifier
----| "comment" # comment
----| "string" # string
----| "number" # number
----| "regexp" # regexp
----| "operator" # operator
----| "decorator" # decorator
-
----A set of predefined token modifiers. This set is not fixed
----an clients can specify additional token types via the
----corresponding client capabilities.
----
----@since 3.16.0
----@alias lsp.SemanticTokenModifiers
----| "declaration" # declaration
----| "definition" # definition
----| "readonly" # readonly
----| "static" # static
----| "deprecated" # deprecated
----| "abstract" # abstract
----| "async" # async
----| "modification" # modification
----| "documentation" # documentation
----| "defaultLibrary" # defaultLibrary
-
----The document diagnostic report kinds.
----
----@since 3.17.0
----@alias lsp.DocumentDiagnosticReportKind
----| "full" # Full
----| "unchanged" # Unchanged
-
----Predefined error codes.
----@alias lsp.ErrorCodes
----| -32700 # ParseError
----| -32600 # InvalidRequest
----| -32601 # MethodNotFound
----| -32602 # InvalidParams
----| -32603 # InternalError
----| -32002 # ServerNotInitialized
----| -32001 # UnknownErrorCode
-
----@alias lsp.LSPErrorCodes
----| -32803 # RequestFailed
----| -32802 # ServerCancelled
----| -32801 # ContentModified
----| -32800 # RequestCancelled
-
----A set of predefined range kinds.
----@alias lsp.FoldingRangeKind
----| "comment" # Comment
----| "imports" # Imports
----| "region" # Region
-
----A symbol kind.
----@alias lsp.SymbolKind
----| 1 # File
----| 2 # Module
----| 3 # Namespace
----| 4 # Package
----| 5 # Class
----| 6 # Method
----| 7 # Property
----| 8 # Field
----| 9 # Constructor
----| 10 # Enum
----| 11 # Interface
----| 12 # Function
----| 13 # Variable
----| 14 # Constant
----| 15 # String
----| 16 # Number
----| 17 # Boolean
----| 18 # Array
----| 19 # Object
----| 20 # Key
----| 21 # Null
----| 22 # EnumMember
----| 23 # Struct
----| 24 # Event
----| 25 # Operator
----| 26 # TypeParameter
-
----Symbol tags are extra annotations that tweak the rendering of a symbol.
----
----@since 3.16
----@alias lsp.SymbolTag
----| 1 # Deprecated
-
----Moniker uniqueness level to define scope of the moniker.
----
----@since 3.16.0
----@alias lsp.UniquenessLevel
----| "document" # document
----| "project" # project
----| "group" # group
----| "scheme" # scheme
----| "global" # global
-
----The moniker kind.
----
----@since 3.16.0
----@alias lsp.MonikerKind
----| "import" # import
----| "export" # export
----| "local" # local
-
----Inlay hint kinds.
----
----@since 3.17.0
----@alias lsp.InlayHintKind
----| 1 # Type
----| 2 # Parameter
-
----Defines whether the insert text in a completion item should be interpreted as
----plain text or a snippet.
----@alias lsp.InsertTextFormat
----| 1 # PlainText
----| 2 # Snippet
-
----The message type
----@alias lsp.MessageType
----| 1 # Error
----| 2 # Warning
----| 3 # Info
----| 4 # Log
-
----Defines how the host (editor) should sync
----document changes to the language server.
----@alias lsp.TextDocumentSyncKind
----| 0 # None
----| 1 # Full
----| 2 # Incremental
-
----Represents reasons why a text document is saved.
----@alias lsp.TextDocumentSaveReason
----| 1 # Manual
----| 2 # AfterDelay
----| 3 # FocusOut
-
----The kind of a completion entry.
----@alias lsp.CompletionItemKind
----| 1 # Text
----| 2 # Method
----| 3 # Function
----| 4 # Constructor
----| 5 # Field
----| 6 # Variable
----| 7 # Class
----| 8 # Interface
----| 9 # Module
----| 10 # Property
----| 11 # Unit
----| 12 # Value
----| 13 # Enum
----| 14 # Keyword
----| 15 # Snippet
----| 16 # Color
----| 17 # File
----| 18 # Reference
----| 19 # Folder
----| 20 # EnumMember
----| 21 # Constant
----| 22 # Struct
----| 23 # Event
----| 24 # Operator
----| 25 # TypeParameter
-
----Completion item tags are extra annotations that tweak the rendering of a completion
----item.
----
----@since 3.15.0
----@alias lsp.CompletionItemTag
----| 1 # Deprecated
-
----How whitespace and indentation is handled during completion
----item insertion.
----
----@since 3.16.0
----@alias lsp.InsertTextMode
----| 1 # asIs
----| 2 # adjustIndentation
-
----A document highlight kind.
----@alias lsp.DocumentHighlightKind
----| 1 # Text
----| 2 # Read
----| 3 # Write
-
----A set of predefined code action kinds
----@alias lsp.CodeActionKind
----| "" # Empty
----| "quickfix" # QuickFix
----| "refactor" # Refactor
----| "refactor.extract" # RefactorExtract
----| "refactor.inline" # RefactorInline
----| "refactor.rewrite" # RefactorRewrite
----| "source" # Source
----| "source.organizeImports" # SourceOrganizeImports
----| "source.fixAll" # SourceFixAll
-
----@alias lsp.TraceValues
----| "off" # Off
----| "messages" # Messages
----| "verbose" # Verbose
-
----Describes the content type that a client supports in various
----result literals like `Hover`, `ParameterInfo` or `CompletionItem`.
----
----Please note that `MarkupKinds` must not start with a `$`. This kinds
----are reserved for internal usage.
----@alias lsp.MarkupKind
----| "plaintext" # PlainText
----| "markdown" # Markdown
-
----Describes how an {@link InlineCompletionItemProvider inline completion provider} was triggered.
----
----@since 3.18.0
----@alias lsp.InlineCompletionTriggerKind
----| 0 # Invoked
----| 1 # Automatic
-
----A set of predefined position encoding kinds.
----
----@since 3.17.0
----@alias lsp.PositionEncodingKind
----| "utf-8" # UTF8
----| "utf-16" # UTF16
----| "utf-32" # UTF32
-
----The file event type
----@alias lsp.FileChangeType
----| 1 # Created
----| 2 # Changed
----| 3 # Deleted
-
----@alias lsp.WatchKind
----| 1 # Create
----| 2 # Change
----| 4 # Delete
-
----The diagnostic's severity.
----@alias lsp.DiagnosticSeverity
----| 1 # Error
----| 2 # Warning
----| 3 # Information
----| 4 # Hint
-
----The diagnostic tags.
----
----@since 3.15.0
----@alias lsp.DiagnosticTag
----| 1 # Unnecessary
----| 2 # Deprecated
-
----How a completion was triggered
----@alias lsp.CompletionTriggerKind
----| 1 # Invoked
----| 2 # TriggerCharacter
----| 3 # TriggerForIncompleteCompletions
-
----How a signature help was triggered.
----
----@since 3.15.0
----@alias lsp.SignatureHelpTriggerKind
----| 1 # Invoked
----| 2 # TriggerCharacter
----| 3 # ContentChange
-
----The reason why code actions were requested.
----
----@since 3.17.0
----@alias lsp.CodeActionTriggerKind
----| 1 # Invoked
----| 2 # Automatic
-
----A pattern kind describing if a glob pattern matches a file a folder or
----both.
----
----@since 3.16.0
----@alias lsp.FileOperationPatternKind
----| "file" # file
----| "folder" # folder
-
----A notebook cell kind.
----
----@since 3.17.0
----@alias lsp.NotebookCellKind
----| 1 # Markup
----| 2 # Code
-
----@alias lsp.ResourceOperationKind
----| "create" # Create
----| "rename" # Rename
----| "delete" # Delete
-
----@alias lsp.FailureHandlingKind
----| "abort" # Abort
----| "transactional" # Transactional
----| "textOnlyTransactional" # TextOnlyTransactional
----| "undo" # Undo
-
----@alias lsp.PrepareSupportDefaultBehavior
----| 1 # Identifier
-
----@alias lsp.TokenFormat
----| "relative" # Relative
-
----The definition of a symbol represented as one or many {@link Location locations}.
----For most programming languages there is only one location at which a symbol is
----defined.
----
----Servers should prefer returning `DefinitionLink` over `Definition` if supported
----by the client.
----@alias lsp.Definition lsp.Location|lsp.Location[]
-
----Information about where a symbol is defined.
----
----Provides additional metadata over normal {@link Location location} definitions, including the range of
----the defining symbol
----@alias lsp.DefinitionLink lsp.LocationLink
-
----LSP arrays.
----@since 3.17.0
----@alias lsp.LSPArray lsp.LSPAny[]
-
----The LSP any type.
----Please note that strictly speaking a property with the value `undefined`
----can't be converted into JSON preserving the property name. However for
----convenience it is allowed and assumed that all these properties are
----optional as well.
----@since 3.17.0
----@alias lsp.LSPAny lsp.LSPObject|lsp.LSPArray|string|integer|uinteger|decimal|boolean|lsp.null
-
----The declaration of a symbol representation as one or many {@link Location locations}.
----@alias lsp.Declaration lsp.Location|lsp.Location[]
-
----Information about where a symbol is declared.
----
----Provides additional metadata over normal {@link Location location} declarations, including the range of
----the declaring symbol.
----
----Servers should prefer returning `DeclarationLink` over `Declaration` if supported
----by the client.
----@alias lsp.DeclarationLink lsp.LocationLink
-
----Inline value information can be provided by different means:
----- directly as a text value (class InlineValueText).
----- as a name to use for a variable lookup (class InlineValueVariableLookup)
----- as an evaluatable expression (class InlineValueEvaluatableExpression)
----The InlineValue types combines all inline value types into one type.
----
----@since 3.17.0
----@alias lsp.InlineValue lsp.InlineValueText|lsp.InlineValueVariableLookup|lsp.InlineValueEvaluatableExpression
-
----The result of a document diagnostic pull request. A report can
----either be a full report containing all diagnostics for the
----requested document or an unchanged report indicating that nothing
----has changed in terms of diagnostics in comparison to the last
----pull request.
----
----@since 3.17.0
----@alias lsp.DocumentDiagnosticReport lsp.RelatedFullDocumentDiagnosticReport|lsp.RelatedUnchangedDocumentDiagnosticReport
-
----@alias lsp.PrepareRenameResult lsp.Range|anonym44|anonym45
-
----A document selector is the combination of one or many document filters.
----
----@sample `let sel:DocumentSelector = [{ language: 'typescript' }, { language: 'json', pattern: '**∕tsconfig.json' }]`;
----
----The use of a string as a document filter is deprecated @since 3.16.0.
----@alias lsp.DocumentSelector lsp.DocumentFilter[]
-
----@alias lsp.ProgressToken integer|string
-
----An identifier to refer to a change annotation stored with a workspace edit.
----@alias lsp.ChangeAnnotationIdentifier string
-
----A workspace diagnostic document report.
----
----@since 3.17.0
----@alias lsp.WorkspaceDocumentDiagnosticReport lsp.WorkspaceFullDocumentDiagnosticReport|lsp.WorkspaceUnchangedDocumentDiagnosticReport
-
----An event describing a change to a text document. If only a text is provided
----it is considered to be the full content of the document.
----@alias lsp.TextDocumentContentChangeEvent anonym46|anonym47
-
----MarkedString can be used to render human readable text. It is either a markdown string
----or a code-block that provides a language and a code snippet. The language identifier
----is semantically equal to the optional language identifier in fenced code blocks in GitHub
----issues. See https://help.github.com/articles/creating-and-highlighting-code-blocks/#syntax-highlighting
----
----The pair of a language and a value is an equivalent to markdown:
----```${language}
----${value}
----```
----
----Note that markdown strings will be sanitized - that means html will be escaped.
----@deprecated use MarkupContent instead.
----@alias lsp.MarkedString string|anonym48
-
----A document filter describes a top level text document or
----a notebook cell document.
----
----@since 3.17.0 - proposed support for NotebookCellTextDocumentFilter.
----@alias lsp.DocumentFilter lsp.TextDocumentFilter|lsp.NotebookCellTextDocumentFilter
-
----LSP object definition.
----@since 3.17.0
----@alias lsp.LSPObject table<string, lsp.LSPAny>
-
----The glob pattern. Either a string pattern or a relative pattern.
----
----@since 3.17.0
----@alias lsp.GlobPattern lsp.Pattern|lsp.RelativePattern
-
----A document filter denotes a document by different properties like
----the {@link TextDocument.languageId language}, the {@link Uri.scheme scheme} of
----its resource, or a glob-pattern that is applied to the {@link TextDocument.fileName path}.
----
----Glob patterns can have the following syntax:
----- `*` to match one or more characters in a path segment
----- `?` to match on one character in a path segment
----- `**` to match any number of path segments, including none
----- `{}` to group sub patterns into an OR expression. (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
----- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
----- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
----
----@sample A language filter that applies to typescript files on disk: `{ language: 'typescript', scheme: 'file' }`
----@sample A language filter that applies to all package.json paths: `{ language: 'json', pattern: '**package.json' }`
----
----@since 3.17.0
----@alias lsp.TextDocumentFilter anonym49|anonym50|anonym51
-
----A notebook document filter denotes a notebook document by
----different properties. The properties will be match
----against the notebook's URI (same as with documents)
----
----@since 3.17.0
----@alias lsp.NotebookDocumentFilter anonym52|anonym53|anonym54
-
----The glob pattern to watch relative to the base path. Glob patterns can have the following syntax:
----- `*` to match one or more characters in a path segment
----- `?` to match on one character in a path segment
----- `**` to match any number of path segments, including none
----- `{}` to group conditions (e.g. `**​/*.{ts,js}` matches all TypeScript and JavaScript files)
----- `[]` to declare a range of characters to match in a path segment (e.g., `example.[0-9]` to match on `example.0`, `example.1`, …)
----- `[!...]` to negate a range of characters to match in a path segment (e.g., `example.[!0-9]` to match on `example.a`, `example.b`, but not `example.0`)
----
----@since 3.17.0
----@alias lsp.Pattern string
-
----@class anonym1
----The name of the server as defined by the server.
----@field name string
----The server's version as defined by the server.
----@field version? string
-
----@class anonym3
----@field insert lsp.Range
----@field replace lsp.Range
-
----@class anonym2
----A default commit character set.
----
----@since 3.17.0
----@field commitCharacters? string[]
----A default edit range.
----
----@since 3.17.0
----@field editRange? lsp.Range|anonym3
----A default insert text format.
----
----@since 3.17.0
----@field insertTextFormat? lsp.InsertTextFormat
----A default insert text mode.
----
----@since 3.17.0
----@field insertTextMode? lsp.InsertTextMode
----A default data value.
----
----@since 3.17.0
----@field data? lsp.LSPAny
-
----@class anonym4
----Human readable description of why the code action is currently disabled.
----
----This is displayed in the code actions UI.
----@field reason string
-
----@class anonym5
----@field uri lsp.DocumentUri
-
----@class anonym6
-
----@class anonym7
----The server supports deltas for full documents.
----@field delta? boolean
-
----@class anonym9
----The change to the cell array.
----@field array lsp.NotebookCellArrayChange
----Additional opened cell text documents.
----@field didOpen? lsp.TextDocumentItem[]
----Additional closed cell text documents.
----@field didClose? lsp.TextDocumentIdentifier[]
-
----@class anonym10
----@field document lsp.VersionedTextDocumentIdentifier
----@field changes lsp.TextDocumentContentChangeEvent[]
-
----@class anonym8
----Changes to the cell structure to add or
----remove cells.
----@field structure? anonym9
----Changes to notebook cells properties like its
----kind, execution summary or metadata.
----@field data? lsp.NotebookCell[]
----Changes to the text content of notebook cells.
----@field textContent? anonym10[]
-
----@class anonym11
----The name of the client as defined by the client.
----@field name string
----The client's version as defined by the client.
----@field version? string
-
----@class anonym12
----The server supports workspace folder.
----
----@since 3.6.0
----@field workspaceFolders? lsp.WorkspaceFoldersServerCapabilities
----The server is interested in notifications/requests for operations on files.
----
----@since 3.16.0
----@field fileOperations? lsp.FileOperationOptions
-
----@class anonym13
----The server has support for completion item label
----details (see also `CompletionItemLabelDetails`) when
----receiving a completion item in a resolve call.
----
----@since 3.17.0
----@field labelDetailsSupport? boolean
-
----@class anonym15
----@field language string
-
----@class anonym14
----The notebook to be synced If a string
----value is provided it matches against the
----notebook type. '*' matches every notebook.
----@field notebook string|lsp.NotebookDocumentFilter
----The cells of the matching notebook to be synced.
----@field cells? anonym15[]
-
----@class anonym17
----@field language string
-
----@class anonym16
----The notebook to be synced If a string
----value is provided it matches against the
----notebook type. '*' matches every notebook.
----@field notebook? string|lsp.NotebookDocumentFilter
----The cells of the matching notebook to be synced.
----@field cells anonym17[]
-
----@class anonym18
----The client will actively cancel the request.
----@field cancel boolean
----The list of requests for which the client
----will retry the request if it receives a
----response with error code `ContentModified`
----@field retryOnContentModified string[]
-
----@class anonym19
----Whether the client groups edits with equal labels into tree nodes,
----for instance all edits labelled with "Changes in Strings" would
----be a tree node.
----@field groupsOnLabel? boolean
-
----@class anonym20
----The symbol kind values the client supports. When this
----property exists the client also guarantees that it will
----handle values outside its set gracefully and falls back
----to a default value when unknown.
----
----If this property is not present the client only supports
----the symbol kinds from `File` to `Array` as defined in
----the initial version of the protocol.
----@field valueSet? lsp.SymbolKind[]
-
----@class anonym21
----The tags supported by the client.
----@field valueSet lsp.SymbolTag[]
-
----@class anonym22
----The properties that a client can resolve lazily. Usually
----`location.range`
----@field properties string[]
-
----@class anonym24
----The tags supported by the client.
----@field valueSet lsp.CompletionItemTag[]
-
----@class anonym25
----The properties that a client can resolve lazily.
----@field properties string[]
-
----@class anonym26
----@field valueSet lsp.InsertTextMode[]
-
----@class anonym23
----Client supports snippets as insert text.
----
----A snippet can define tab stops and placeholders with `$1`, `$2`
----and `${3:foo}`. `$0` defines the final tab stop, it defaults to
----the end of the snippet. Placeholders with equal identifiers are linked,
----that is typing in one will update others too.
----@field snippetSupport? boolean
----Client supports commit characters on a completion item.
----@field commitCharactersSupport? boolean
----Client supports the following content formats for the documentation
----property. The order describes the preferred format of the client.
----@field documentationFormat? lsp.MarkupKind[]
----Client supports the deprecated property on a completion item.
----@field deprecatedSupport? boolean
----Client supports the preselect property on a completion item.
----@field preselectSupport? boolean
----Client supports the tag property on a completion item. Clients supporting
----tags have to handle unknown tags gracefully. Clients especially need to
----preserve unknown tags when sending a completion item back to the server in
----a resolve call.
----
----@since 3.15.0
----@field tagSupport? anonym24
----Client support insert replace edit to control different behavior if a
----completion item is inserted in the text or should replace text.
----
----@since 3.16.0
----@field insertReplaceSupport? boolean
----Indicates which properties a client can resolve lazily on a completion
----item. Before version 3.16.0 only the predefined properties `documentation`
----and `details` could be resolved lazily.
----
----@since 3.16.0
----@field resolveSupport? anonym25
----The client supports the `insertTextMode` property on
----a completion item to override the whitespace handling mode
----as defined by the client (see `insertTextMode`).
----
----@since 3.16.0
----@field insertTextModeSupport? anonym26
----The client has support for completion item label
----details (see also `CompletionItemLabelDetails`).
----
----@since 3.17.0
----@field labelDetailsSupport? boolean
-
----@class anonym27
----The completion item kind values the client supports. When this
----property exists the client also guarantees that it will
----handle values outside its set gracefully and falls back
----to a default value when unknown.
----
----If this property is not present the client only supports
----the completion items kinds from `Text` to `Reference` as defined in
----the initial version of the protocol.
----@field valueSet? lsp.CompletionItemKind[]
-
----@class anonym28
----The client supports the following itemDefaults on
----a completion list.
----
----The value lists the supported property names of the
----`CompletionList.itemDefaults` object. If omitted
----no properties are supported.
----
----@since 3.17.0
----@field itemDefaults? string[]
-
----@class anonym30
----The client supports processing label offsets instead of a
----simple label string.
----
----@since 3.14.0
----@field labelOffsetSupport? boolean
-
----@class anonym29
----Client supports the following content formats for the documentation
----property. The order describes the preferred format of the client.
----@field documentationFormat? lsp.MarkupKind[]
----Client capabilities specific to parameter information.
----@field parameterInformation? anonym30
----The client supports the `activeParameter` property on `SignatureInformation`
----literal.
----
----@since 3.16.0
----@field activeParameterSupport? boolean
-
----@class anonym31
----The symbol kind values the client supports. When this
----property exists the client also guarantees that it will
----handle values outside its set gracefully and falls back
----to a default value when unknown.
----
----If this property is not present the client only supports
----the symbol kinds from `File` to `Array` as defined in
----the initial version of the protocol.
----@field valueSet? lsp.SymbolKind[]
-
----@class anonym32
----The tags supported by the client.
----@field valueSet lsp.SymbolTag[]
-
----@class anonym34
----The code action kind values the client supports. When this
----property exists the client also guarantees that it will
----handle values outside its set gracefully and falls back
----to a default value when unknown.
----@field valueSet lsp.CodeActionKind[]
-
----@class anonym33
----The code action kind is support with the following value
----set.
----@field codeActionKind anonym34
-
----@class anonym35
----The properties that a client can resolve lazily.
----@field properties string[]
-
----@class anonym36
----The folding range kind values the client supports. When this
----property exists the client also guarantees that it will
----handle values outside its set gracefully and falls back
----to a default value when unknown.
----@field valueSet? lsp.FoldingRangeKind[]
-
----@class anonym37
----If set, the client signals that it supports setting collapsedText on
----folding ranges to display custom labels instead of the default text.
----
----@since 3.17.0
----@field collapsedText? boolean
-
----@class anonym38
----The tags supported by the client.
----@field valueSet lsp.DiagnosticTag[]
-
----@class anonym40
-
----@class anonym41
----The client will send the `textDocument/semanticTokens/full/delta` request if
----the server provides a corresponding handler.
----@field delta? boolean
-
----@class anonym39
----The client will send the `textDocument/semanticTokens/range` request if
----the server provides a corresponding handler.
----@field range? boolean|anonym40
----The client will send the `textDocument/semanticTokens/full` request if
----the server provides a corresponding handler.
----@field full? boolean|anonym41
-
----@class anonym42
----The properties that a client can resolve lazily.
----@field properties string[]
-
----@class anonym43
----Whether the client supports additional attributes which
----are preserved and send back to the server in the
----request's response.
----@field additionalPropertiesSupport? boolean
-
----@class anonym44
----@field range lsp.Range
----@field placeholder string
-
----@class anonym45
----@field defaultBehavior boolean
-
----@class anonym46
----The range of the document that changed.
----@field range lsp.Range
----The optional length of the range that got replaced.
----
----@deprecated use range instead.
----@field rangeLength? uinteger
----The new text for the provided range.
----@field text string
-
----@class anonym47
----The new text of the whole document.
----@field text string
-
----@class anonym48
----@field language string
----@field value string
-
----@class anonym49
----A language id, like `typescript`.
----@field language string
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme? string
----A glob pattern, like `*.{ts,js}`.
----@field pattern? string
-
----@class anonym50
----A language id, like `typescript`.
----@field language? string
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme string
----A glob pattern, like `*.{ts,js}`.
----@field pattern? string
-
----@class anonym51
----A language id, like `typescript`.
----@field language? string
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme? string
----A glob pattern, like `*.{ts,js}`.
----@field pattern string
-
----@class anonym52
----The type of the enclosing notebook.
----@field notebookType string
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme? string
----A glob pattern.
----@field pattern? string
-
----@class anonym53
----The type of the enclosing notebook.
----@field notebookType? string
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme string
----A glob pattern.
----@field pattern? string
-
----@class anonym54
----The type of the enclosing notebook.
----@field notebookType? string
----A Uri {@link Uri.scheme scheme}, like `file` or `untitled`.
----@field scheme? string
----A glob pattern.
----@field pattern string
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 738e23ff28..633cddca2d 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -715,8 +715,8 @@ end
 --- Turns the result of a `textDocument/completion` request into vim-compatible
 --- |complete-items|.
 ---
----@param result table The result of a `textDocument/completion` call, e.g. from
----|vim.lsp.buf.completion()|, which may be one of `CompletionItem[]`,
+---@param result table The result of a `textDocument/completion` call, e.g.
+--- from |vim.lsp.buf.completion()|, which may be one of `CompletionItem[]`,
 --- `CompletionList` or `null`
 ---@param prefix (string) the prefix to filter the completion items
 ---@return table { matches = complete-items table, incomplete = bool }
diff --git a/runtime/lua/vim/secure.lua b/runtime/lua/vim/secure.lua
index 837738c041..893b3e1877 100644
--- a/runtime/lua/vim/secure.lua
+++ b/runtime/lua/vim/secure.lua
@@ -119,9 +119,8 @@ end
 ---    - path (string|nil): Path to a file to update. Mutually exclusive with {bufnr}.
 ---      Cannot be used when {action} is "allow".
 ---    - bufnr (number|nil): Buffer number to update. Mutually exclusive with {path}.
----@return (boolean, string) success, msg:
----    - true and full path of target file if operation was successful
----    - false and error message on failure
+---@return boolean success true if operation was successful
+---@return string msg full path if operation was successful, else error message
 function M.trust(opts)
   vim.validate({
     path = { opts.path, 's', true },
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 32575a1cc9..422d49d746 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -6,6 +6,7 @@
 -- or the test suite. (Eventually the test suite will be run in a worker process,
 -- so this wouldn't be a separate case to consider)
 
+---@diagnostic disable-next-line: lowercase-global
 vim = vim or {}
 
 local function _id(v)
@@ -533,7 +534,7 @@ end
 ---@see Based on https://github.com/premake/premake-core/blob/master/src/base/table.lua
 ---
 ---@param t table Dict-like table
----@return # iterator over sorted keys and their values
+---@return function iterator over sorted keys and their values
 function vim.spairs(t)
   assert(type(t) == 'table', string.format('Expected table, got %s', type(t)))
 
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 08186468a5..3b7e74c0cf 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -434,7 +434,7 @@ local predicate_handlers = {
 predicate_handlers['vim-match?'] = predicate_handlers['match?']
 
 ---@class TSMetadata
----@field range Range
+---@field range? Range
 ---@field [integer] TSMetadata
 ---@field [string] integer|string
 
diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index 96889438eb..056e1678ff 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -212,15 +212,15 @@ function M.last(versions)
   return last
 end
 
----@class Range
+---@class VersionRange
 ---@field from Version
 ---@field to? Version
-local Range = {}
+local VersionRange = {}
 
 --- @private
 ---
 ---@param version string|Version
-function Range:has(version)
+function VersionRange:has(version)
   if type(version) == 'string' then
     ---@diagnostic disable-next-line: cast-local-type
     version = M.parse(version)
@@ -266,7 +266,7 @@ end
 --- @param spec string Version range "spec"
 function M.range(spec) -- Adapted from https://github.com/folke/lazy.nvim
   if spec == '*' or spec == '' then
-    return setmetatable({ from = M.parse('0.0.0') }, { __index = Range })
+    return setmetatable({ from = M.parse('0.0.0') }, { __index = VersionRange })
   end
 
   ---@type number?
@@ -280,7 +280,7 @@ function M.range(spec) -- Adapted from https://github.com/folke/lazy.nvim
     return setmetatable({
       from = ra and ra.from,
       to = rb and (#parts == 3 and rb.from or rb.to),
-    }, { __index = Range })
+    }, { __index = VersionRange })
   end
   ---@type string, string
   local mods, version = spec:lower():match('^([%^=<>~]*)(.*)$')
@@ -326,7 +326,7 @@ function M.range(spec) -- Adapted from https://github.com/folke/lazy.nvim
         end
       end
     end
-    return setmetatable({ from = from, to = to }, { __index = Range })
+    return setmetatable({ from = from, to = to }, { __index = VersionRange })
   end
 end
 
-- 
cgit 


From 68f12e7fcb1fb8b95ca0b1207683d929574c0555 Mon Sep 17 00:00:00 2001
From: Kyuuhachi <1547062+Kyuuhachi@users.noreply.github.com>
Date: Wed, 9 Aug 2023 19:06:42 +0200
Subject: fix(lua): annotate that TSNode functions can return nil (#24621)

---
 runtime/lua/vim/treesitter/_meta.lua | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index 9ca4b560c6..36b1a9bbf8 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -14,15 +14,15 @@
 ---@field extra fun(self: TSNode): boolean
 ---@field child_count fun(self: TSNode): integer
 ---@field named_child_count fun(self: TSNode): integer
----@field child fun(self: TSNode, integer): TSNode
----@field named_child fun(self: TSNode, integer): TSNode
----@field descendant_for_range fun(self: TSNode, integer, integer, integer, integer): TSNode
----@field named_descendant_for_range fun(self: TSNode, integer, integer, integer, integer): TSNode
----@field parent fun(self: TSNode): TSNode
----@field next_sibling fun(self: TSNode): TSNode
----@field prev_sibling fun(self: TSNode): TSNode
----@field next_named_sibling fun(self: TSNode): TSNode
----@field prev_named_sibling fun(self: TSNode): TSNode
+---@field child fun(self: TSNode, integer): TSNode?
+---@field named_child fun(self: TSNode, integer): TSNode?
+---@field descendant_for_range fun(self: TSNode, integer, integer, integer, integer): TSNode?
+---@field named_descendant_for_range fun(self: TSNode, integer, integer, integer, integer): TSNode?
+---@field parent fun(self: TSNode): TSNode?
+---@field next_sibling fun(self: TSNode): TSNode?
+---@field prev_sibling fun(self: TSNode): TSNode?
+---@field next_named_sibling fun(self: TSNode): TSNode?
+---@field prev_named_sibling fun(self: TSNode): TSNode?
 ---@field named_children fun(self: TSNode): TSNode[]
 ---@field has_changes fun(self: TSNode): boolean
 ---@field equal fun(self: TSNode, other: TSNode): boolean
-- 
cgit 


From 164370a4cb92f5063280d4748e1e67fafc79df34 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 9 Aug 2023 19:13:59 +0200
Subject: vim-patch:c2bd205254c8

Change "the" to "then" under ':help bufload()' (vim/vim#12662)

https://github.com/vim/vim/commit/c2bd205254c89ecf46e08965f53d7991315d9c98

N/A commits:
vim-patch:64dea84bb05a (we have our own manpager at home)
vim-patch:958e15bb1c7d (we have our own editorconfig syntax file)
vim-patch:c41b3c9f95ac (we don't have defaults.vim)

Co-authored-by: Daniel Steinberg <dstein64@users.noreply.github.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 7c98ed8849..14aae99971 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -534,7 +534,7 @@ function vim.fn.buflisted(buf) end
 --- refers to an existing file then the file is read.  Otherwise
 --- the buffer will be empty.  If the buffer was already loaded
 --- then there is no change.  If the buffer is not related to a
---- file the no file is read (e.g., when 'buftype' is "nofile").
+--- file then no file is read (e.g., when 'buftype' is "nofile").
 --- If there is an existing swap file for the file of the buffer,
 --- there will be no dialog, the buffer will be loaded anyway.
 --- The {buf} argument is used like with |bufexists()|.
-- 
cgit 


From ceb501c1c664953392fff4c14bb106efa2bf049e Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 9 Aug 2023 22:33:41 +0200
Subject: vim-patch:a13eb2b14791 (#24622)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Add WebGPU Shading Language (WGSL) filetype (vim/vim#12723)

The current W3C Working Draft for the WebGPU Shading Language (WGSL) specifies
'text/wgsl' media type for WGSL modules with the '.wgsl' file extension:
https://www.w3.org/TR/WGSL/#text-wgsl-media-type

It has also been registered at the Internet Assigned Numbers Authority (IANA):
https://www.iana.org/assignments/media-types/text/wgsl

Neovim's nvim-lspconfig already associates wgsl language servers
with 'filetype wgsl':
https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#wgsl_analyzer

However currenly setting 'filetype wgsl' for *.wgsl files by defalut in Neovim
is blocked by adding this filetype to the vim project first:
https://github.com/neovim/neovim/pull/23331

This commit adds this missing wgsl filetype.

https://github.com/vim/vim/commit/a13eb2b147915e7e92a6de6c19ce448c7def4057

Co-authored-by: Gergő Sályi <87373293+gergo-salyi@users.noreply.github.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index a53216f8ea..634f5c6a58 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1049,6 +1049,7 @@ local extension = {
   wat = 'wat',
   wdl = 'wdl',
   wm = 'webmacro',
+  wgsl = 'wgsl',
   wbt = 'winbatch',
   wit = 'wit',
   wml = 'wml',
-- 
cgit 


From aaeb1a8cd18741ff17fd030eb05a132bb9f99430 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 9 Aug 2023 22:34:02 +0200
Subject: vim-patch:7159ac7fec28 (#24624)

Unison support (vim/vim#12715)

https://github.com/vim/vim/commit/7159ac7fec282ad7427795b4bcd5b769268c083d

Co-authored-by: Anton Parkhomenko <chuwy@users.noreply.github.com>
---
 runtime/lua/vim/filetype.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 634f5c6a58..6359f4a7c2 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1011,6 +1011,8 @@ local extension = {
   uit = 'uil',
   uil = 'uil',
   ungram = 'ungrammar',
+  u = 'unison',
+  uu = 'unison',
   url = 'urlshortcut',
   usd = 'usd',
   usda = 'usd',
-- 
cgit 


From 90ed7ee1123d128b817de5ff154dcd963ca1af3f Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 9 Aug 2023 22:34:39 +0200
Subject: vim-patch:44ff25d5243b (#24625)

* vim-patch:44ff25d5243b

PyPA manifest files are not recognized (vim/vim#12707)

Problem:    PyPA manifest files are not recognized.
Solution:   Add a pattern to match PyPA manifest files.

https://github.com/vim/vim/commit/44ff25d5243b6d4f7ee88b46d1254aec0b27f4eb

Co-authored-by: ObserverOfTime <chronobserver@disroot.org>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 6359f4a7c2..b415247293 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1402,6 +1402,7 @@ local filename = {
   ['/etc/protocols'] = 'protocols',
   INDEX = detect.psf,
   INFO = detect.psf,
+  ['MANIFEST.in'] = 'pymanifest',
   ['.pythonstartup'] = 'python',
   ['.pythonrc'] = 'python',
   SConstruct = 'python',
-- 
cgit 


From 2e8f38690faf3b031138371066a5376f681549b8 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 9 Aug 2023 22:35:43 +0200
Subject: vim-patch:b69b9d5e1753 (#24628)

Add filetype detection for eyaml files (vim/vim#12659)

https://github.com/voxpupuli/hiera-eyaml/ uses and produces the eyaml
format, which is simply yaml with some encrypted values.

It's convenient to edit the file without decrypting when not touching
encrypted values (or when you don't have access to the decryption key),
which is why vim should treat those files as yaml files.

https://github.com/vim/vim/commit/b69b9d5e175351c9a25507139954f6211f37fdd9

Co-authored-by: Max Gautier <mg@max.gautier.name>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index b415247293..98938ddbf3 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1093,6 +1093,7 @@ local extension = {
   yxx = 'yacc',
   yml = 'yaml',
   yaml = 'yaml',
+  eyaml = 'yaml',
   yang = 'yang',
   yuck = 'yuck',
   z8a = 'z8a',
-- 
cgit 


From 3c929fd1c2e0fd0f385f2cb82bd33145a7dd6a72 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 9 Aug 2023 22:35:57 +0200
Subject: vim-patch:077ade4f6703 (#24629)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

feat: recognize geojson extension as json filetype (vim/vim#12636)

https://github.com/vim/vim/commit/077ade4f67036e652b99f8f858c9ca1c1dd22245

Co-authored-by: Dominique Pellé <dominique.pelle@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 98938ddbf3..dd730c0744 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -548,6 +548,7 @@ local extension = {
   slnf = 'json',
   json = 'json',
   jsonp = 'json',
+  geojson = 'json',
   webmanifest = 'json',
   ipynb = 'json',
   ['json-patch'] = 'json',
-- 
cgit 


From 2ee8ace217b8e4405822d3ab1bed5a20bedc4b04 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 9 Aug 2023 15:41:45 -0500
Subject: fix(iter): make pipeline termination conditions consistent (#24614)

If an iterator pipeline stage returns nil as its first return value, the
other return values are ignored and it is treated as if that stage
returned only nil (the semantics of returning nil are different between
different stages). This is consistent with how for loops work in Lua
more generally, where the for loop breaks when the first return value
from the function iterator is nil (see :h for-in for details).
---
 runtime/lua/vim/iter.lua | 22 +++++++++++++++++-----
 1 file changed, 17 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index a278e96a5f..56c130dd0c 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -6,11 +6,14 @@
 --- Each pipeline stage receives as input the output values from the prior stage. The values used in
 --- the first stage of the pipeline depend on the type passed to this function:
 ---
---- - List tables pass only the value of each element
---- - Non-list (dict) tables pass both the key and value of each element
+--- - List tables (arrays) pass only the value of each element
+--- - Non-list tables (dictionaries) pass both the key and value of each element
 --- - Function |iterator|s pass all of the values returned by their respective function
 --- - Tables with a metatable implementing |__call()| are treated as function iterators
 ---
+--- The iterator pipeline terminates when the original table or function iterator runs out of values
+--- (for function iterators, this means that the first value returned by the function is nil).
+---
 --- Examples:
 --- <pre>lua
 ---   local it = vim.iter({ 1, 2, 3, 4, 5 })
@@ -22,6 +25,7 @@
 ---   it:totable()
 ---   -- { 9, 6, 3 }
 ---
+---   -- ipairs() is a function iterator which returns both the index (i) and the value (v)
 ---   vim.iter(ipairs({ 1, 2, 3, 4, 5 })):map(function(i, v)
 ---     if i > 2 then return v end
 ---   end):totable()
@@ -111,7 +115,7 @@ end
 ---@return boolean True if the iterator stage should continue, false otherwise
 ---@return any Function arguments.
 local function continue(...)
-  if select('#', ...) > 0 then
+  if select(1, ...) ~= nil then
     return false, ...
   end
   return true
@@ -127,7 +131,7 @@ end
 ---@return boolean True if the iterator pipeline should continue, false otherwise
 ---@return any Return values of f
 local function apply(f, ...)
-  if select('#', ...) > 0 then
+  if select(1, ...) ~= nil then
     return continue(f(...))
   end
   return false
@@ -258,7 +262,7 @@ end
 ---                       in the pipeline as arguments.
 function Iter.each(self, f)
   local function fn(...)
-    if select('#', ...) > 0 then
+    if select(1, ...) ~= nil then
       f(...)
       return true
     end
@@ -740,6 +744,12 @@ end
 ---@param last number
 ---@return Iter
 function Iter.slice(self, first, last) -- luacheck: no unused args
+  error('slice() requires a list-like table')
+  return self
+end
+
+---@private
+function ListIter.slice(self, first, last)
   return self:skip(math.max(0, first - 1)):skipback(math.max(0, self._tail - last - 1))
 end
 
@@ -912,6 +922,8 @@ function Iter.new(src, ...)
 
     --- Use a closure to handle var args returned from iterator
     local function fn(...)
+      -- Per the Lua 5.1 reference manual, an iterator is complete when the first returned value is
+      -- nil (even if there are other, non-nil return values). See |for-in|.
       if select(1, ...) ~= nil then
         var = select(1, ...)
         return ...
-- 
cgit 


From f060f03304ca5f3b8adf5d5b46bdd01dc413d985 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 9 Aug 2023 23:35:10 +0200
Subject: vim-patch:2eb413f89b97 (#24627)

* vim-patch:2eb413f89b97

detect filetype for `*.vsh` and `*.vv` files (vim/vim#12692)

Co-authored-by: Turiiya <34311583+tobealive@users.noreply.github.com>

https://github.com/vim/vim/commit/2eb413f89b97a498679fbe68c7564b9e41c5af7f

Co-authored-by: Turiiya <34311583+ttytm@users.noreply.github.com>
Co-authored-by: zeertzjq <zeertzjq@outlook.com>
---
 runtime/lua/vim/filetype.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index dd730c0744..bee210aacb 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1017,6 +1017,8 @@ local extension = {
   url = 'urlshortcut',
   usd = 'usd',
   usda = 'usd',
+  vsh = 'v',
+  vv = 'v',
   sba = 'vb',
   vb = 'vb',
   dsm = 'vb',
-- 
cgit 


From e6947bb1e80aa61ec43446f43dcc7c8a022f5b78 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Wed, 9 Aug 2023 14:50:52 -0700
Subject: fix(types): make filetype.add parameters optional

---
 runtime/lua/vim/filetype.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index bee210aacb..1bbe88f06d 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -2034,9 +2034,9 @@ local function normalize_path(path, as_pattern)
 end
 
 --- @class vim.filetype.add.filetypes
---- @field pattern vim.filetype.mapping
---- @field extension vim.filetype.mapping
---- @field filename vim.filetype.mapping
+--- @field pattern? vim.filetype.mapping
+--- @field extension? vim.filetype.mapping
+--- @field filename? vim.filetype.mapping
 
 --- Add new filetype mappings.
 ---
-- 
cgit 


From 1d81d7a268f5805bedc077f80582a89afe1bfe84 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Wed, 9 Aug 2023 15:33:53 -0700
Subject: feat(defaults): treat "•" as a list item prefix #24623
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Problem:
Nvim docs use "•" as a list item prefix but `gw{motion}` doesn't format
such lists by default.

Solution:
Change the 'comments' option to include "fb:•" by default.
---
 runtime/lua/vim/_meta/options.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 94e26742e6..8edb87df91 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -956,7 +956,7 @@ vim.go.co = vim.go.columns
 --- insert a space.
 ---
 --- @type string
-vim.o.comments = "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-"
+vim.o.comments = "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-,fb:•"
 vim.o.com = vim.o.comments
 vim.bo.comments = vim.o.comments
 vim.bo.com = vim.bo.comments
-- 
cgit 


From 3d948a4dc4b2cd3c8d3ac497caf3dfe25adfb90d Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 10 Aug 2023 17:45:36 +0800
Subject: vim-patch:9.0.1683: Updated runtime files (#24638)

This is a collection of various PRs from github that all require a minor
patch number:

1) https://github.com/vim/vim/pull/12612

    Do not conflate dictionary key with end of block

2) https://github.com/vim/vim/pull/12729:

    When saving and restoring 'undolevels', the constructs `&undolevels` and
    `:set undolevels` are problematic.

    The construct `&undolevels` reads an unpredictable value; it will be the
    local option value (if one has been set), or the global option value
    (otherwise), making it unsuitable for saving a value for later
    restoration.

    Similarly, if a local option value has been set for 'undolevels',
    temporarily modifying the option via `:set undolevels` changes the local
    value as well as the global value, requiring extra work to restore both
    values.

    Saving and restoring the option value in one step via the construct
    `:let &undolevels = &undolevels` appears to make no changes to the
    'undolevels' option, but if a local option has been set to a different
    value than the global option, it has the unintended effect of changing
    the global 'undolevels' value to the local value.

    Update the documentation to explain these issues and recommend explicit
    use of global and local option values when saving and restoring.  Update
    some unit tests to use `g:undolevels`.

3) https://github.com/vim/vim/pull/12702:

    Problem:    Pip requirements files are not recognized.
    Solution:   Add a pattern to match pip requirements files.

4) https://github.com/vim/vim/pull/12688:

    Add indent file and tests for ABB Rapid

5) https://github.com/vim/vim/pull/12668:

    Use Lua 5.1 numeric escapes in tests and add to CI

    Only Lua 5.2+ and LuaJIT understand hexadecimal escapes in strings.  Lua
    5.1 only supports decimal escapes:

    > A character in a string can also be specified by its numerical value
    > using the escape sequence \ddd, where ddd is a sequence of up to three
    > decimal digits. (Note that if a numerical escape is to be followed by a
    > digit, it must be expressed using exactly three digits.) Strings in Lua
    > can contain any 8-bit value, including embedded zeros, which can be
    > specified as '\0'.

    To make sure this works with Lua 5.4 and Lua 5.1 change the Vim CI to
    run with Lua 5.1 as well as Lua 5.4

6) https://github.com/vim/vim/pull/12631:

    Add hurl filetype detection

7) https://github.com/vim/vim/pull/12573:

    Problem:   Files for haskell persistent library are not recognized
    Solution:  Add pattern persistentmodels for haskell persistent library

closes: vim/vim#12612
closes: vim/vim#12729
closes: vim/vim#12702
closes: vim/vim#12688
closes: vim/vim#12668
closes: vim/vim#12631
closes: vim/vim#12573

Already ported but wasn't marked: vim-patch:ad34abee2583

https://github.com/vim/vim/commit/6efb1980336ff324e9c57a4e282530b952fca816

Co-authored-by: Christian Brabandt <cb@256bit.org>
Co-authored-by: lacygoill <lacygoill@lacygoill.me>
Co-authored-by: Michael Henry <drmikehenry@drmikehenry.com>
Co-authored-by: ObserverOfTime <chronobserver@disroot.org>
Co-authored-by: KnoP-01 <knosowski@graeffrobotics.de>
Co-authored-by: James McCoy <jamessan@jamessan.com>
Co-authored-by: Jacob Pfeifer <jacob@pfeifer.dev>
Co-authored-by: Borys Lykah <lykahb@fastmail.com>
---
 runtime/lua/vim/filetype.lua | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 1bbe88f06d..1ea88ebc06 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -479,15 +479,16 @@ local extension = {
   hsig = 'haskell',
   hsc = 'haskell',
   hs = 'haskell',
+  persistentmodels = 'haskellpersistent',
   ht = 'haste',
   htpp = 'hastepreproc',
+  hcl = 'hcl',
   hb = 'hb',
   h = detect.header,
   sum = 'hercules',
   errsum = 'hercules',
   ev = 'hercules',
   vc = 'hercules',
-  hcl = 'hcl',
   heex = 'heex',
   hex = 'hex',
   ['h32'] = 'hex',
@@ -506,6 +507,7 @@ local extension = {
   stm = detect.html,
   htt = 'httest',
   htb = 'httest',
+  hurl = 'hurl',
   hw = detect.hw,
   module = detect.hw,
   pkg = detect.hw,
@@ -818,6 +820,7 @@ local extension = {
   rego = 'rego',
   rem = 'remind',
   remind = 'remind',
+  pip = 'requirements',
   res = 'rescript',
   resi = 'rescript',
   frt = 'reva',
@@ -1419,6 +1422,7 @@ local filename = {
   inputrc = 'readline',
   ['.inputrc'] = 'readline',
   ['.reminders'] = 'remind',
+  ['requirements.txt'] = 'requirements',
   ['resolv.conf'] = 'resolv',
   ['robots.txt'] = 'robots',
   Gemfile = 'ruby',
-- 
cgit 


From 3fb372eba48796b5d0a7758f91e168be8e70e183 Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Thu, 10 Aug 2023 09:53:56 -0500
Subject: Use Lua autocommand and make TermClose autocommand global

---
 runtime/lua/vim/_editor.lua | 17 +++++++++++++++--
 1 file changed, 15 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 58fbc923e1..8c10cc7da3 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -1107,13 +1107,26 @@ end
 
 function vim._init_default_autocmds()
   local nvim_terminal_augroup = vim.api.nvim_create_augroup('nvim_terminal', {})
-  vim.api.nvim_create_autocmd({ 'bufreadcmd' }, {
+  vim.api.nvim_create_autocmd({ 'BufReadCmd' }, {
     pattern = 'term://*',
     group = nvim_terminal_augroup,
     nested = true,
     command = "if !exists('b:term_title')|call termopen(matchstr(expand(\"<amatch>\"), '\\c\\mterm://\\%(.\\{-}//\\%(\\d\\+:\\)\\?\\)\\?\\zs.*'), {'cwd': expand(get(matchlist(expand(\"<amatch>\"), '\\c\\mterm://\\(.\\{-}\\)//'), 1, ''))})",
   })
-  vim.api.nvim_create_autocmd({ 'cmdwinenter' }, {
+  vim.api.nvim_create_autocmd({ 'TermClose' }, {
+    group = nvim_terminal_augroup,
+    desc = 'Automatically close terminal buffers when started with no arguments and exiting without an error',
+    callback = function(args)
+      if vim.v.event.status == 0 then
+        local info = vim.api.nvim_get_chan_info(vim.bo[args.buf].channel)
+        local argv = info.argv or {}
+        if #argv == 1 and argv[1] == vim.o.shell then
+          vim.cmd({ cmd = 'bdelete', args = { args.buf }, bang = true })
+        end
+      end
+    end,
+  })
+  vim.api.nvim_create_autocmd({ 'CmdwinEnter' }, {
     pattern = '[:>]',
     group = vim.api.nvim_create_augroup('nvim_cmdwin', {}),
     command = 'syntax sync minlines=1 maxlines=1',
-- 
cgit 


From 72e64a1afef0df1bd244bfb31dfc8619d91ff709 Mon Sep 17 00:00:00 2001
From: Raphael <glephunter@gmail.com>
Date: Fri, 11 Aug 2023 20:20:05 +0800
Subject: fix(lsp): extra "." when completing with tsserver #24646

Problem:
With tsserver LSP, omni completion after "." inserts an extra "."

Solution:
Apply adjust_start_col() regardless of `filterText`.
adjust_start_col() is explained here:
https://github.com/neovim/neovim/blob/0ea8dfeb3dc347579753169d9e3588f6306ab703/runtime/lua/vim/lsp.lua#L2334-L2351

The `filterText` field is used in the following situations rather than as
a condition for obtaining column values:
1. Real-time filtering: When the user types characters in the editor, the
   language server can use the filterText field to filter the list of
   suggestions and only return suggestions that match the typed characters. This
   helps to provide more precise recommendations.
2. Fuzzy matching: The filterText field can be used to perform fuzzy matching,
   allowing matching in the middle or beginning of input characters, not limited
   to prefix matching. This can provide a more flexible code completion
   experience.

Inspecting usage of `filtertext` in vim-lsp and coc and lsp-mode:
- vim-lsp uses a `refresh_pattern` to judge filterText as completionitem word
  (although I think this is not the correct usage).
- coc uses it for filtering.

Fix #22803
---
 runtime/lua/vim/lsp.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 0c4290d067..2a16bafbfc 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -2262,7 +2262,7 @@ end
 local function adjust_start_col(lnum, line, items, encoding)
   local min_start_char = nil
   for _, item in pairs(items) do
-    if item.filterText == nil and item.textEdit and item.textEdit.range.start.line == lnum - 1 then
+    if item.textEdit and item.textEdit.range.start.line == lnum - 1 then
       if min_start_char and min_start_char ~= item.textEdit.range.start.character then
         return nil
       end
-- 
cgit 


From 31c4ed26bc278282898123ad21bb6fead401fd6f Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 11 Aug 2023 17:05:17 +0200
Subject: feat(treesitter): add injection language fallback (#24659)

* feat(treesitter): add injection language fallback

Problem: injection languages are often specified via aliases (e.g.,
filetype or in upper case), requiring custom directives.

Solution: include lookup logic (try as parser name, then filetype, then
lowercase) in LanguageTree itself and remove `#inject-language`
directive.

Co-authored-by: Lewis Russell <me@lewisr.dev>
---
 runtime/lua/vim/treesitter/languagetree.lua | 27 +++++++++++++++++++++++++--
 runtime/lua/vim/treesitter/query.lua        | 27 ---------------------------
 2 files changed, 25 insertions(+), 29 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 4b2628609a..7f1d6d1111 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -635,6 +635,29 @@ local function add_injection(t, tree_index, pattern, lang, combined, ranges)
   table.insert(t[tree_index][lang][pattern].regions, ranges)
 end
 
+-- TODO(clason): replace by refactored `ts.has_parser` API (without registering)
+---@param lang string parser name
+---@return boolean # true if parser for {lang} exists on rtp
+local has_parser = function(lang)
+  return vim._ts_has_language(lang)
+    or #vim.api.nvim_get_runtime_file('parser/' .. lang .. '.*', false) > 0
+end
+
+--- Return parser name for language (if exists) or filetype (if registered and exists)
+---
+---@param alias string language or filetype name
+---@return string? # resolved parser name
+local function resolve_lang(alias)
+  if has_parser(alias) then
+    return alias
+  end
+
+  local lang = vim.treesitter.language.get_lang(alias)
+  if lang and has_parser(lang) then
+    return lang
+  end
+end
+
 ---@private
 --- Extract injections according to:
 --- https://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection
@@ -649,10 +672,10 @@ function LanguageTree:_get_injection(match, metadata)
 
   for id, node in pairs(match) do
     local name = self._injection_query.captures[id]
-
     -- Lang should override any other language tag
     if name == 'injection.language' then
-      lang = vim.treesitter.get_node_text(node, self._source, { metadata = metadata[id] })
+      local text = vim.treesitter.get_node_text(node, self._source, { metadata = metadata[id] })
+      lang = resolve_lang(text) or resolve_lang(text:lower())
     elseif name == 'injection.content' then
       ranges = get_node_ranges(node, self._source, metadata[id], include_children)
     end
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 3b7e74c0cf..c3213e0192 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -541,33 +541,6 @@ local directive_handlers = {
       metadata.range = { start_row, start_col, end_row, end_col }
     end
   end,
-  -- Set injection language from node text, interpreted first as language and then as filetype
-  -- Example: (#inject-language! @_lang)
-  ['inject-language!'] = function(match, _, bufnr, pred, metadata)
-    local id = pred[2]
-    local node = match[id]
-    if not node then
-      return
-    end
-
-    -- TODO(clason): replace by refactored `ts.has_parser` API
-    local has_parser = function(lang)
-      return vim._ts_has_language(lang)
-        or #vim.api.nvim_get_runtime_file('parser/' .. lang .. '.*', false) > 0
-    end
-
-    local alias = vim.treesitter.get_node_text(node, bufnr, { metadata = metadata[id] })
-    if not alias then
-      return
-    elseif has_parser(alias) then
-      metadata['injection.language'] = alias
-    else
-      local lang = vim.treesitter.language.get_lang(alias)
-      if lang and has_parser(lang) then
-        metadata['injection.language'] = lang
-      end
-    end
-  end,
 }
 
 --- Adds a new predicate to be used in queries
-- 
cgit 


From 6e0c36ba0e6691401726fd4215f89729138ba82f Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sat, 12 Aug 2023 05:51:49 +0800
Subject: vim-patch:9.0.1686: undotree() only works for the current buffer
 (#24665)

Problem:    undotree() only works for the current buffer
Solution:   Add an optional "buffer number" parameter to undotree().  If
            omitted, use the current buffer for backwards compatibility.

closes: vim/vim#4001
closes: vim/vim#12292

https://github.com/vim/vim/commit/5fee11114975b7405b7ccd3ee8758e54bf559760

Co-authored-by: Devin J. Pohly <djpohly@gmail.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 14aae99971..bf80ccab45 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -9733,8 +9733,9 @@ function vim.fn.type(expr) end
 --- @return string
 function vim.fn.undofile(name) end
 
---- Return the current state of the undo tree in a dictionary with
---- the following items:
+--- Return the current state of the undo tree for the current
+--- buffer, or for a specific buffer if {buf} is given.  The
+--- result is a dictionary with the following items:
 ---   "seq_last"  The highest undo sequence number used.
 ---   "seq_cur"  The sequence number of the current position in
 ---     the undo tree.  This differs from "seq_last"
@@ -9775,8 +9776,9 @@ function vim.fn.undofile(name) end
 ---     blocks.  Each item may again have an "alt"
 ---     item.
 ---
+--- @param buf? any
 --- @return any
-function vim.fn.undotree() end
+function vim.fn.undotree(buf) end
 
 --- Remove second and succeeding copies of repeated adjacent
 --- {list} items in-place.  Returns {list}.  If you want a list
-- 
cgit 


From 6c07a189f2d10a533af8a51819ea96c45e0c567e Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sat, 12 Aug 2023 08:19:06 +0800
Subject: vim-patch:9.0.1688: cannot store custom data in quickfix list
 (#24673)

Problem: cannot store custom data in quickfix list
Solution: add `user_data` field for the quickfix list

closes: vim/vim#11818

https://github.com/vim/vim/commit/ca6ac99077d2e6d020a34267aa5e0fbc4d23dc38

Co-authored-by: Tom Praschan <13141438+tom-anders@users.noreply.github.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index bf80ccab45..d5d9229ffb 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -3309,6 +3309,9 @@ function vim.fn.getpos(expr) end
 ---   text  description of the error
 ---   type  type of the error, 'E', '1', etc.
 ---   valid  |TRUE|: recognized error message
+---   user_data
+---     custom data associated with the item, can be
+---     any type.
 ---
 --- When there is no error list or it's empty, an empty list is
 --- returned. Quickfix list entries with a non-existing buffer
@@ -7595,6 +7598,9 @@ function vim.fn.setpos(expr, list) end
 ---     text  description of the error
 ---     type  single-character error type, 'E', 'W', etc.
 ---     valid  recognized error message
+---     user_data
+---     custom data associated with the item, can be
+---     any type.
 ---
 --- The "col", "vcol", "nr", "type" and "text" entries are
 --- optional.  Either "lnum" or "pattern" entry can be used to
-- 
cgit 


From 2ca076e45fb3f1c08f6a1a374834df0701b8d778 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 10 Aug 2023 14:21:56 +0100
Subject: feat(treesitter)!: incremental injection parsing

Problem:

Treesitter highlighting is slow for large files with lots of injections.

Solution:

Only parse injections we are going to render during a redraw cycle.

---

- `LanguageTree:parse()` will no longer parse injections by default and
  now requires an explicit range argument to be passed.

- `TSHighlighter` now parses injections incrementally during on_win
  callbacks for the line range being rendered.

- Plugins which require certain injections to be parsed must run
  `parser:parse({ start_row, end_row })` before using the tree.
---
 runtime/lua/vim/treesitter/_fold.lua        |   7 +-
 runtime/lua/vim/treesitter/_meta.lua        |   7 +-
 runtime/lua/vim/treesitter/_range.lua       |   9 +-
 runtime/lua/vim/treesitter/dev.lua          |   2 +-
 runtime/lua/vim/treesitter/highlighter.lua  |  24 ++--
 runtime/lua/vim/treesitter/languagetree.lua | 207 +++++++++++++++++++---------
 runtime/lua/vim/treesitter/query.lua        |   1 +
 7 files changed, 173 insertions(+), 84 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index a02d0a584d..912a6e8a9f 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -147,11 +147,14 @@ local function normalise_erow(bufnr, erow)
   return math.min(erow or max_erow, max_erow)
 end
 
+-- TODO(lewis6991): Setup a decor provider so injections folds can be parsed
+-- as the window is redrawn
 ---@param bufnr integer
 ---@param info TS.FoldInfo
 ---@param srow integer?
 ---@param erow integer?
-local function get_folds_levels(bufnr, info, srow, erow)
+---@param parse_injections? boolean
+local function get_folds_levels(bufnr, info, srow, erow, parse_injections)
   srow = srow or 0
   erow = normalise_erow(bufnr, erow)
 
@@ -162,7 +165,7 @@ local function get_folds_levels(bufnr, info, srow, erow)
 
   local parser = ts.get_parser(bufnr)
 
-  parser:parse()
+  parser:parse(parse_injections and { srow, erow } or nil)
 
   parser:for_each_tree(function(tree, ltree)
     local query = ts.query.get(ltree:lang(), 'folds')
diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index 36b1a9bbf8..d8babc9402 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -1,6 +1,6 @@
 ---@meta
 
----@class TSNode
+---@class TSNode: userdata
 ---@field id fun(self: TSNode): integer
 ---@field tree fun(self: TSNode): TSTree
 ---@field range fun(self: TSNode, include_bytes: false?): integer, integer, integer, integer
@@ -51,7 +51,7 @@ function TSNode:_rawquery(query, captures, start, end_, opts) end
 ---@field parse fun(self: TSParser, tree: TSTree?, source: integer|string, include_bytes: boolean?): TSTree, integer[]
 ---@field reset fun(self: TSParser)
 ---@field included_ranges fun(self: TSParser, include_bytes: boolean?): integer[]
----@field set_included_ranges fun(self: TSParser, ranges: Range6[])
+---@field set_included_ranges fun(self: TSParser, ranges: (Range6|TSNode)[])
 ---@field set_timeout fun(self: TSParser, timeout: integer)
 ---@field timeout fun(self: TSParser): integer
 ---@field _set_logger fun(self: TSParser, lex: boolean, parse: boolean, cb: TSLoggerCallback)
@@ -61,7 +61,8 @@ function TSNode:_rawquery(query, captures, start, end_, opts) end
 ---@field root fun(self: TSTree): TSNode
 ---@field edit fun(self: TSTree, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _: integer, _:integer)
 ---@field copy fun(self: TSTree): TSTree
----@field included_ranges fun(self: TSTree, include_bytes: boolean?): integer[]
+---@field included_ranges fun(self: TSTree, include_bytes: true): Range6[]
+---@field included_ranges fun(self: TSTree, include_bytes: false): Range4[]
 
 ---@return integer
 vim._ts_get_language_version = function() end
diff --git a/runtime/lua/vim/treesitter/_range.lua b/runtime/lua/vim/treesitter/_range.lua
index 35081c6400..8d727c3c52 100644
--- a/runtime/lua/vim/treesitter/_range.lua
+++ b/runtime/lua/vim/treesitter/_range.lua
@@ -2,6 +2,10 @@ local api = vim.api
 
 local M = {}
 
+---@class Range2
+---@field [1] integer start row
+---@field [2] integer end row
+
 ---@class Range4
 ---@field [1] integer start row
 ---@field [2] integer start column
@@ -16,7 +20,7 @@ local M = {}
 ---@field [5] integer end column
 ---@field [6] integer end bytes
 
----@alias Range Range4|Range6
+---@alias Range Range2|Range4|Range6
 
 ---@private
 ---@param a_row integer
@@ -111,6 +115,9 @@ end
 ---@param r Range
 ---@return integer, integer, integer, integer
 function M.unpack4(r)
+  if #r == 2 then
+    return r[1], 0, r[2], 0
+  end
   local off_1 = #r == 6 and 1 or 0
   return r[1], r[2], r[3 + off_1], r[4 + off_1]
 end
diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index e94e8f08dc..f7625eb94b 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -99,7 +99,7 @@ function TSTreeView:new(bufnr, lang)
   -- For each child tree (injected language), find the root of the tree and locate the node within
   -- the primary tree that contains that root. Add a mapping from the node in the primary tree to
   -- the root in the child tree to the {injections} table.
-  local root = parser:parse()[1]:root()
+  local root = parser:parse(true)[1]:root()
   local injections = {} ---@type table<integer,table>
   parser:for_each_child(function(child, lang_)
     child:for_each_tree(function(tree)
diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index f8ec5b175d..56b075b723 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -1,5 +1,6 @@
 local api = vim.api
 local query = vim.treesitter.query
+local Range = require('vim.treesitter._range')
 
 ---@alias TSHlIter fun(): integer, TSNode, TSMetadata
 
@@ -14,6 +15,7 @@ local query = vim.treesitter.query
 ---@field _highlight_states table<TSTree,TSHighlightState>
 ---@field _queries table<string,TSHighlighterQuery>
 ---@field tree LanguageTree
+---@field redraw_count integer
 local TSHighlighter = rawget(vim.treesitter, 'TSHighlighter') or {}
 TSHighlighter.__index = TSHighlighter
 
@@ -139,6 +141,7 @@ function TSHighlighter.new(tree, opts)
   return self
 end
 
+--- @nodoc
 --- Removes all internal references to the highlighter
 function TSHighlighter:destroy()
   if TSHighlighter.active[self.bufnr] then
@@ -186,7 +189,7 @@ function TSHighlighter:on_detach()
 end
 
 ---@package
----@param changes Range6[][]
+---@param changes Range6[]
 function TSHighlighter:on_changedtree(changes)
   for _, ch in ipairs(changes) do
     api.nvim__buf_redraw_range(self.bufnr, ch[1], ch[4] + 1)
@@ -245,7 +248,7 @@ local function on_line_impl(self, buf, line, is_spell_nav)
       end
 
       local range = vim.treesitter.get_range(node, buf, metadata[capture])
-      local start_row, start_col, _, end_row, end_col, _ = unpack(range)
+      local start_row, start_col, end_row, end_col = Range.unpack4(range)
       local hl = highlighter_query.hl_cache[capture]
 
       local capture_name = highlighter_query:query().captures[capture]
@@ -309,32 +312,23 @@ function TSHighlighter._on_spell_nav(_, _, buf, srow, _, erow, _)
   end
 end
 
----@private
----@param buf integer
-function TSHighlighter._on_buf(_, buf)
-  local self = TSHighlighter.active[buf]
-  if self then
-    self.tree:parse()
-  end
-end
-
 ---@private
 ---@param _win integer
 ---@param buf integer
----@param _topline integer
-function TSHighlighter._on_win(_, _win, buf, _topline)
+---@param topline integer
+---@param botline integer
+function TSHighlighter._on_win(_, _win, buf, topline, botline)
   local self = TSHighlighter.active[buf]
   if not self then
     return false
   end
-
+  self.tree:parse({ topline, botline })
   self:reset_highlight_state()
   self.redraw_count = self.redraw_count + 1
   return true
 end
 
 api.nvim_set_decoration_provider(ns, {
-  on_buf = TSHighlighter._on_buf,
   on_win = TSHighlighter._on_win,
   on_line = TSHighlighter._on_line,
   _on_spell_nav = TSHighlighter._on_spell_nav,
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 7f1d6d1111..f274edf961 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -18,7 +18,7 @@
 --- Whenever you need to access the current syntax tree, parse the buffer:
 ---
 --- <pre>lua
----     local tree = parser:parse()
+---     local tree = parser:parse({ start_row, end_row })
 --- </pre>
 ---
 --- This returns a table of immutable |treesitter-tree| objects representing the current state of
@@ -74,6 +74,7 @@ local TSCallbackNames = {
 ---@field package _callbacks_rec table<TSCallbackName,function[]> Callback handlers (recursive)
 ---@field private _children table<string,LanguageTree> Injected languages
 ---@field private _injection_query Query Queries defining injected languages
+---@field private _injections_processed boolean
 ---@field private _opts table Options
 ---@field private _parser TSParser Parser for language
 ---@field private _has_regions boolean
@@ -115,7 +116,9 @@ function LanguageTree.new(source, lang, opts)
   end
 
   local injections = opts.injections or {}
-  local self = setmetatable({
+
+  --- @type LanguageTree
+  local self = {
     _source = source,
     _lang = lang,
     _children = {},
@@ -123,14 +126,19 @@ function LanguageTree.new(source, lang, opts)
     _opts = opts,
     _injection_query = injections[lang] and query.parse(lang, injections[lang])
       or query.get(lang, 'injections'),
+    _has_regions = false,
+    _injections_processed = false,
     _valid = false,
     _parser = vim._create_ts_parser(lang),
     _callbacks = {},
     _callbacks_rec = {},
-  }, LanguageTree)
+  }
+
+  setmetatable(self, LanguageTree)
 
   if vim.g.__ts_debug and type(vim.g.__ts_debug) == 'number' then
     self:_set_logger()
+    self:_log('START')
   end
 
   for _, name in pairs(TSCallbackNames) do
@@ -141,6 +149,7 @@ function LanguageTree.new(source, lang, opts)
   return self
 end
 
+--- @private
 function LanguageTree:_set_logger()
   local source = self:source()
   source = type(source) == 'string' and 'text' or tostring(source)
@@ -171,7 +180,7 @@ end
 ---Measure execution time of a function
 ---@generic R1, R2, R3
 ---@param f fun(): R1, R2, R2
----@return integer, R1, R2, R3
+---@return number, R1, R2, R3
 local function tcall(f, ...)
   local start = vim.uv.hrtime()
   ---@diagnostic disable-next-line
@@ -219,7 +228,7 @@ function LanguageTree:invalidate(reload)
 
   -- buffer was reloaded, reparse all trees
   if reload then
-    for _, t in ipairs(self._trees) do
+    for _, t in pairs(self._trees) do
       self:_do_callback('changedtree', t:included_ranges(true), t)
     end
     self._trees = {}
@@ -250,14 +259,18 @@ function LanguageTree:is_valid(exclude_children)
   local valid = self._valid
 
   if type(valid) == 'table' then
-    for _, v in ipairs(valid) do
-      if not v then
+    for i = 1, #self:included_regions() do
+      if not valid[i] then
         return false
       end
     end
   end
 
   if not exclude_children then
+    if not self._injections_processed then
+      return false
+    end
+
     for _, child in pairs(self._children) do
       if not child:is_valid(exclude_children) then
         return false
@@ -265,9 +278,12 @@ function LanguageTree:is_valid(exclude_children)
     end
   end
 
-  assert(type(valid) == 'boolean')
+  if type(valid) == 'boolean' then
+    return valid
+  end
 
-  return valid
+  self._valid = true
+  return true
 end
 
 --- Returns a map of language to child tree.
@@ -280,47 +296,72 @@ function LanguageTree:source()
   return self._source
 end
 
---- Parses all defined regions using a treesitter parser
---- for the language this tree represents.
---- This will run the injection query for this language to
---- determine if any child languages should be created.
----
----@return TSTree[]
-function LanguageTree:parse()
-  if self:is_valid() then
-    self:_log('valid')
-    return self._trees
+--- @param region Range6[]
+--- @param range? boolean|Range
+--- @return boolean
+local function intercepts_region(region, range)
+  if #region == 0 then
+    return true
   end
 
-  local changes = {}
+  if range == nil then
+    return false
+  end
 
-  -- Collect some stats
-  local regions_parsed = 0
+  if type(range) == 'boolean' then
+    return range
+  end
+
+  for _, r in ipairs(region) do
+    if Range.intercepts(r, range) then
+      return true
+    end
+  end
+
+  return false
+end
+
+--- @private
+--- @param range boolean|Range?
+--- @return integer[] changes
+--- @return integer no_regions_parsed
+--- @return number total_parse_time
+function LanguageTree:_parse_regions(range)
+  local changes = {}
+  local no_regions_parsed = 0
   local total_parse_time = 0
 
-  --- At least 1 region is invalid
-  if not self:is_valid(true) then
-    -- If there are no ranges, set to an empty list
-    -- so the included ranges in the parser are cleared.
-    for i, ranges in ipairs(self:included_regions()) do
-      if not self._valid or not self._valid[i] then
-        self._parser:set_included_ranges(ranges)
-        local parse_time, tree, tree_changes =
-          tcall(self._parser.parse, self._parser, self._trees[i], self._source, true)
-
-        -- Pass ranges if this is an initial parse
-        local cb_changes = self._trees[i] and tree_changes or tree:included_ranges(true)
-
-        self:_do_callback('changedtree', cb_changes, tree)
-        self._trees[i] = tree
-        vim.list_extend(changes, tree_changes)
-
-        total_parse_time = total_parse_time + parse_time
-        regions_parsed = regions_parsed + 1
-      end
+  if type(self._valid) ~= 'table' then
+    self._valid = {}
+  end
+
+  -- If there are no ranges, set to an empty list
+  -- so the included ranges in the parser are cleared.
+  for i, ranges in pairs(self:included_regions()) do
+    if not self._valid[i] and intercepts_region(ranges, range) then
+      self._parser:set_included_ranges(ranges)
+      local parse_time, tree, tree_changes =
+        tcall(self._parser.parse, self._parser, self._trees[i], self._source, true)
+
+      -- Pass ranges if this is an initial parse
+      local cb_changes = self._trees[i] and tree_changes or tree:included_ranges(true)
+
+      self:_do_callback('changedtree', cb_changes, tree)
+      self._trees[i] = tree
+      vim.list_extend(changes, tree_changes)
+
+      total_parse_time = total_parse_time + parse_time
+      no_regions_parsed = no_regions_parsed + 1
+      self._valid[i] = true
     end
   end
 
+  return changes, no_regions_parsed, total_parse_time
+end
+
+--- @private
+--- @return number
+function LanguageTree:_add_injections()
   local seen_langs = {} ---@type table<string,boolean>
 
   local query_time, injections_by_lang = tcall(self._get_injections, self)
@@ -348,19 +389,60 @@ function LanguageTree:parse()
     end
   end
 
+  return query_time
+end
+
+--- Recursively parse all regions in the language tree using |treesitter-parsers|
+--- for the corresponding languages and run injection queries on the parsed trees
+--- to determine whether child trees should be created and parsed.
+---
+--- Any region with empty range (`{}`, typically only the root tree) is always parsed;
+--- otherwise (typically injections) only if it intersects {range} (or if {range} is `true`).
+---
+--- @param range boolean|Range|nil: Parse this range in the parser's source.
+---     Set to `true` to run a complete parse of the source (Note: Can be slow!)
+---     Set to `false|nil` to only parse regions with empty ranges (typically
+---     only the root tree without injections).
+--- @return TSTree[]
+function LanguageTree:parse(range)
+  if self:is_valid() then
+    self:_log('valid')
+    return self._trees
+  end
+
+  local changes --- @type Range6?
+
+  -- Collect some stats
+  local no_regions_parsed = 0
+  local query_time = 0
+  local total_parse_time = 0
+
+  --- At least 1 region is invalid
+  if not self:is_valid(true) then
+    changes, no_regions_parsed, total_parse_time = self:_parse_regions(range)
+    -- Need to run injections when we parsed something
+    if no_regions_parsed > 0 then
+      self._injections_processed = false
+    end
+  end
+
+  if not self._injections_processed and range ~= false and range ~= nil then
+    query_time = self:_add_injections()
+    self._injections_processed = true
+  end
+
   self:_log({
-    changes = changes,
-    regions_parsed = regions_parsed,
+    changes = changes and #changes > 0 and changes or nil,
+    regions_parsed = no_regions_parsed,
     parse_time = total_parse_time,
     query_time = query_time,
+    range = range,
   })
 
   self:for_each_child(function(child)
-    child:parse()
+    child:parse(range)
   end)
 
-  self._valid = true
-
   return self._trees
 end
 
@@ -384,7 +466,7 @@ end
 ---
 ---@param fn fun(tree: TSTree, ltree: LanguageTree)
 function LanguageTree:for_each_tree(fn)
-  for _, tree in ipairs(self._trees) do
+  for _, tree in pairs(self._trees) do
     fn(tree, self)
   end
 
@@ -466,18 +548,17 @@ function LanguageTree:_iter_regions(fn)
     return
   end
 
-  if type(self._valid) ~= 'table' then
+  local was_valid = type(self._valid) ~= 'table'
+
+  if was_valid then
+    self:_log('was valid', self._valid)
     self._valid = {}
   end
 
   local all_valid = true
 
   for i, region in ipairs(self:included_regions()) do
-    if self._valid[i] == nil then
-      self._valid[i] = true
-    end
-
-    if self._valid[i] then
+    if was_valid or self._valid[i] then
       self._valid[i] = fn(i, region)
       if not self._valid[i] then
         self:_log(function()
@@ -521,6 +602,8 @@ function LanguageTree:set_included_regions(new_regions)
     for i, range in ipairs(region) do
       if type(range) == 'table' and #range == 4 then
         region[i] = Range.add_bytes(self._source, range)
+      elseif type(range) == 'userdata' then
+        region[i] = { range:range(true) }
       end
     end
   end
@@ -542,7 +625,7 @@ function LanguageTree:set_included_regions(new_regions)
 end
 
 ---Gets the set of included regions
----@return integer[][]
+---@return Range6[][]
 function LanguageTree:included_regions()
   if self._regions then
     return self._regions
@@ -581,7 +664,7 @@ local function get_node_ranges(node, source, metadata, include_children)
 
   -- We are excluding children so we need to mask out their ranges
   for i = 0, child_count - 1 do
-    local child = node:named_child(i)
+    local child = assert(node:named_child(i))
     local c_srow, c_scol, c_sbyte, c_erow, c_ecol, c_ebyte = child:range(true)
     if c_srow > srow or c_scol > scol then
       ranges[#ranges + 1] = { srow, scol, sbyte, c_srow, c_scol, c_sbyte }
@@ -749,8 +832,8 @@ end
 ---
 --- TODO: Allow for an offset predicate to tailor the injection range
 ---       instead of using the entire nodes range.
----@private
----@return table<string, Range6[][]>
+--- @private
+--- @return table<string, Range6[][]>
 function LanguageTree:_get_injections()
   if not self._injection_query then
     return {}
@@ -759,7 +842,7 @@ function LanguageTree:_get_injections()
   ---@type table<integer,TSInjection>
   local injections = {}
 
-  for tree_index, tree in ipairs(self._trees) do
+  for index, tree in pairs(self._trees) do
     local root_node = tree:root()
     local start_line, _, end_line, _ = root_node:range()
 
@@ -771,7 +854,7 @@ function LanguageTree:_get_injections()
         -- TODO(lewis6991): remove after 0.9 (#20434)
         lang, combined, ranges = self:_get_injection_deprecated(match, metadata)
       end
-      add_injection(injections, tree_index, pattern, lang, combined, ranges)
+      add_injection(injections, index, pattern, lang, combined, ranges)
     end
   end
 
@@ -794,7 +877,7 @@ function LanguageTree:_get_injections()
           end, entry.regions)
           table.insert(result[lang], regions)
         else
-          for _, ranges in ipairs(entry.regions) do
+          for _, ranges in pairs(entry.regions) do
             table.insert(result[lang], ranges)
           end
         end
@@ -828,7 +911,7 @@ function LanguageTree:_edit(
   end_row_new,
   end_col_new
 )
-  for _, tree in ipairs(self._trees) do
+  for _, tree in pairs(self._trees) do
     tree:edit(
       start_byte,
       end_byte_old,
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index c3213e0192..3093657313 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -435,6 +435,7 @@ predicate_handlers['vim-match?'] = predicate_handlers['match?']
 
 ---@class TSMetadata
 ---@field range? Range
+---@field conceal? string
 ---@field [integer] TSMetadata
 ---@field [string] integer|string
 
-- 
cgit 


From 8179d68dc1a90f47bfb307d73e71adc98883ae00 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 13 Aug 2023 08:03:56 +0100
Subject: fix(treesitter): logger memory leak

---
 runtime/lua/vim/treesitter/languagetree.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index f274edf961..b4c9027794 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -156,6 +156,7 @@ function LanguageTree:_set_logger()
 
   local lang = self:lang()
 
+  vim.fn.mkdir(vim.fn.stdpath('log'), 'p')
   local logfilename = vim.fs.joinpath(vim.fn.stdpath('log'), 'treesitter.log')
 
   local logfile, openerr = io.open(logfilename, 'a+')
@@ -208,7 +209,8 @@ function LanguageTree:_log(...)
 
   local info = debug.getinfo(2, 'nl')
   local nregions = #self:included_regions()
-  local prefix = string.format('%s:%d: (#regions=%d) ', info.name, info.currentline, nregions)
+  local prefix =
+    string.format('%s:%d: (#regions=%d) ', info.name or '???', info.currentline or 0, nregions)
 
   local msg = { prefix }
   for _, x in ipairs(args) do
-- 
cgit 


From fc0ee871de2f56dbb80879c912203a6372c54e1c Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 12 Aug 2023 17:54:04 +0200
Subject: fix(treesitter)!: remove deprecated legacy injection format

---
 runtime/lua/vim/treesitter/languagetree.lua | 67 ++---------------------------
 1 file changed, 4 insertions(+), 63 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index b4c9027794..4b419c4744 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -769,65 +769,6 @@ function LanguageTree:_get_injection(match, metadata)
   return lang, combined, ranges
 end
 
----@private
----@param match table<integer,TSNode>
----@param metadata TSMetadata
----@return string, boolean, Range6[]
-function LanguageTree:_get_injection_deprecated(match, metadata)
-  local lang = nil ---@type string
-  local ranges = {} ---@type Range6[]
-  local combined = metadata.combined ~= nil
-
-  -- Directives can configure how injections are captured as well as actual node captures.
-  -- This allows more advanced processing for determining ranges and language resolution.
-  if metadata.content then
-    local content = metadata.content ---@type any
-
-    -- Allow for captured nodes to be used
-    if type(content) == 'number' then
-      content = { match[content]:range() }
-    end
-
-    if type(content) == 'table' and #content >= 4 then
-      vim.list_extend(ranges, content)
-    end
-  end
-
-  local mlang = metadata.language
-  if mlang ~= nil then
-    assert(type(mlang) == 'string')
-    lang = mlang
-  end
-
-  -- You can specify the content and language together
-  -- using a tag with the language, for example
-  -- @javascript
-  for id, node in pairs(match) do
-    local name = self._injection_query.captures[id]
-
-    -- Lang should override any other language tag
-    if name == 'language' and not lang then
-      lang = vim.treesitter.get_node_text(node, self._source, { metadata = metadata[id] })
-    elseif name == 'combined' then
-      combined = true
-    elseif name == 'content' and #ranges == 0 then
-      ranges[#ranges + 1] = vim.treesitter.get_range(node, self._source, metadata[id])
-      -- Ignore any tags that start with "_"
-      -- Allows for other tags to be used in matches
-    elseif string.sub(name, 1, 1) ~= '_' then
-      if not lang then
-        lang = name
-      end
-
-      if #ranges == 0 then
-        ranges[#ranges + 1] = vim.treesitter.get_range(node, self._source, metadata[id])
-      end
-    end
-  end
-
-  return lang, combined, ranges
-end
-
 --- Gets language injection points by language.
 ---
 --- This is where most of the injection processing occurs.
@@ -852,11 +793,11 @@ function LanguageTree:_get_injections()
       self._injection_query:iter_matches(root_node, self._source, start_line, end_line + 1)
     do
       local lang, combined, ranges = self:_get_injection(match, metadata)
-      if not lang then
-        -- TODO(lewis6991): remove after 0.9 (#20434)
-        lang, combined, ranges = self:_get_injection_deprecated(match, metadata)
+      if lang then
+        add_injection(injections, index, pattern, lang, combined, ranges)
+      else
+        self:_log('match from injection query failed for pattern', pattern)
       end
-      add_injection(injections, index, pattern, lang, combined, ranges)
     end
   end
 
-- 
cgit 


From 842a47d6a4103a75e33c2c0023dbae5ad2c0f534 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 15 Aug 2023 19:16:19 +0800
Subject: vim-patch:9.0.1704: Cannot use positional arguments for printf()
 (#24719)

Problem: Cannot use positional arguments for printf()
Solution: Support positional arguments in string formatting

closes: vim/vim#12140

https://github.com/vim/vim/commit/0c6181fec4c362eb9682d5af583341eb20cb1af5

Co-authored-by: Christ van Willegen <cvwillegen@gmail.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 111 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 110 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index d5d9229ffb..acf1b3a0f5 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -5989,7 +5989,11 @@ function vim.fn.prevnonblank(lnum) end
 --- The "%" starts a conversion specification.  The following
 --- arguments appear in sequence:
 ---
----   %  [flags]  [field-width]  [.precision]  type
+---   % [pos-argument] [flags] [field-width] [.precision] type
+---
+--- pos-argument
+---   At most one positional argument specifier. These
+---   take the form {n$}, where n is >= 1.
 ---
 --- flags
 ---   Zero or more of the following flags:
@@ -6058,6 +6062,13 @@ function vim.fn.prevnonblank(lnum) end
 --- <This limits the length of the text used from "line" to
 --- "width" bytes.
 ---
+--- If the argument to be formatted is specified using a posional
+--- argument specifier, and a '*' is used to indicate that a
+--- number argument is to be used to specify the width or
+--- precision, the argument(s) to be used must also be specified
+--- using a {n$} positional argument specifier. See |printf-$|.
+---
+---
 --- The conversion specifiers and their meanings are:
 ---
 ---     *printf-d* *printf-b* *printf-B* *printf-o* *printf-x* *printf-X*
@@ -6145,6 +6156,104 @@ function vim.fn.prevnonblank(lnum) end
 --- of "%" items.  If there are not sufficient or too many
 --- arguments an error is given.  Up to 18 arguments can be used.
 ---
+---           *printf-$*
+--- In certain languages, error and informative messages are
+--- more readable when the order of words is different from the
+--- corresponding message in English. To accomodate translations
+--- having a different word order, positional arguments may be
+--- used to indicate this. For instance: >vim
+---
+---   #, c-format
+---   msgid "%s returning %s"
+---   msgstr "waarde %2$s komt terug van %1$s"
+--- <
+--- In this example, the sentence has its 2 string arguments reversed
+--- in the output. >vim
+---
+---   echo printf(
+---     "In The Netherlands, vim's creator's name is: %1$s %2$s",
+---     "Bram", "Moolenaar")
+--- <  In The Netherlands, vim's creator's name is: Bram Moolenaar >vim
+---
+---   echo printf(
+---     "In Belgium, vim's creator's name is: %2$s %1$s",
+---     "Bram", "Moolenaar")
+--- <  In Belgium, vim's creator's name is: Moolenaar Bram
+---
+--- Width (and precision) can be specified using the '*' specifier.
+--- In this case, you must specify the field width position in the
+--- argument list. >vim
+---
+---   echo printf("%1$*2$.*3$d", 1, 2, 3)
+--- <  001 >vim
+---   echo printf("%2$*3$.*1$d", 1, 2, 3)
+--- <    2 >vim
+---   echo printf("%3$*1$.*2$d", 1, 2, 3)
+--- <  03 >vim
+---   echo printf("%1$*2$.*3$g", 1.4142, 2, 3)
+--- <  1.414
+---
+--- You can mix specifying the width and/or precision directly
+--- and via positional arguments: >vim
+---
+---   echo printf("%1$4.*2$f", 1.4142135, 6)
+--- <  1.414214 >vim
+---   echo printf("%1$*2$.4f", 1.4142135, 6)
+--- <  1.4142 >vim
+---   echo printf("%1$*2$.*3$f", 1.4142135, 6, 2)
+--- <    1.41
+---
+---           *E1400*
+--- You cannot mix positional and non-positional arguments: >vim
+---   echo printf("%s%1$s", "One", "Two")
+--- <  E1400: Cannot mix positional and non-positional
+---   arguments: %s%1$s
+---
+---           *E1401*
+--- You cannot skip a positional argument in a format string: >vim
+---   echo printf("%3$s%1$s", "One", "Two", "Three")
+--- <  E1401: format argument 2 unused in $-style
+---   format: %3$s%1$s
+---
+---           *E1402*
+--- You can re-use a [field-width] (or [precision]) argument: >vim
+---   echo printf("%1$d at width %2$d is: %01$*2$d", 1, 2)
+--- <  1 at width 2 is: 01
+---
+--- However, you can't use it as a different type: >vim
+---   echo printf("%1$d at width %2$ld is: %01$*2$d", 1, 2)
+--- <  E1402: Positional argument 2 used as field
+---   width reused as different type: long int/int
+---
+---           *E1403*
+--- When a positional argument is used, but not the correct number
+--- or arguments is given, an error is raised: >vim
+---   echo printf("%1$d at width %2$d is: %01$*2$.*3$d", 1, 2)
+--- <  E1403: Positional argument 3 out of bounds:
+---   %1$d at width %2$d is: %01$*2$.*3$d
+---
+--- Only the first error is reported: >vim
+---   echo printf("%01$*2$.*3$d %4$d", 1, 2)
+--- <  E1403: Positional argument 3 out of bounds:
+---   %01$*2$.*3$d %4$d
+---
+---           *E1404*
+--- A positional argument can be used more than once: >vim
+---   echo printf("%1$s %2$s %1$s", "One", "Two")
+--- <  One Two One
+---
+--- However, you can't use a different type the second time: >vim
+---   echo printf("%1$s %2$s %1$d", "One", "Two")
+--- <  E1404: Positional argument 1 type used
+---   inconsistently: int/string
+---
+---           *E1405*
+--- Various other errors that lead to a format string being
+--- wrongly formatted lead to: >vim
+---   echo printf("%1$d at width %2$d is: %01$*2$.3$d", 1, 2)
+--- <  E1405: Invalid format specifier:
+---   %1$d at width %2$d is: %01$*2$.3$d
+---
 --- @param fmt any
 --- @param expr1? any
 --- @return any
-- 
cgit 


From a245dd79a267c8b56866023e84b49d0ecffca65b Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Wed, 16 Aug 2023 06:28:52 +0800
Subject: vim-patch:9.0.1717: virtcol2col returns last byte of a multi-byte
 char (#24729)

Problem: virtcol2col returns last byte of a multi-byte char
Solution: Make it return the first byte for a multi-byte char

closes: vim/vim#12786
closes: vim/vim#12799

https://github.com/vim/vim/commit/b209b86e6636a16088ccacdac98213416c065bf2

Co-authored-by: Yegappan Lakshmanan <yegappan@yahoo.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index acf1b3a0f5..d1173e8a42 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -10016,6 +10016,9 @@ function vim.fn.virtcol(expr, list) end
 --- {lnum}, then the byte index of the character at the last
 --- virtual column is returned.
 ---
+--- For a multi-byte character, the column number of the first
+--- byte in the character is returned.
+---
 --- The {winid} argument can be the window number or the
 --- |window-ID|. If this is zero, then the current window is used.
 ---
-- 
cgit 


From 54be7d6b45a9ae51c218c0e5c1c20dd608b97297 Mon Sep 17 00:00:00 2001
From: Pham Huy Hoang <hoangtun0810@gmail.com>
Date: Wed, 16 Aug 2023 15:02:15 +0900
Subject: docs(lua): add missing fields to treesitter/_meta

According to `:h TSNode` docs, there's also `TSNode:sexpr()` and
`TSNode:has_error()` that is part of `TSNode` class, but this wasn't
documented in `treesitter/_meta.lua`.

Adding missing fields in so the types is similar to `:h TSNode`
---
 runtime/lua/vim/treesitter/_meta.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index d8babc9402..9a94f12c16 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -25,6 +25,8 @@
 ---@field prev_named_sibling fun(self: TSNode): TSNode?
 ---@field named_children fun(self: TSNode): TSNode[]
 ---@field has_changes fun(self: TSNode): boolean
+---@field has_error fun(self: TSNode): boolean
+---@field sexpr fun(self: TSNode): string
 ---@field equal fun(self: TSNode, other: TSNode): boolean
 ---@field iter_children fun(self: TSNode): fun(): TSNode, string
 local TSNode = {}
-- 
cgit 


From 9cb7e00b9748b08fce661f8cbeb06c5994c749ae Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 16 Aug 2023 08:21:32 -0500
Subject: feat(diagnostic): provide more control over virtual text display
 (#24724)

Allow users to pass virtual text options to nvim_buf_set_extmark through
the "virtual_text" table in vim.diagnostic.config().

Fixes: https://github.com/neovim/neovim/issues/16545
---
 runtime/lua/vim/diagnostic.lua | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index 180b9ad3df..1391dafd75 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -566,7 +566,9 @@ end
 ---                    severity |diagnostic-severity|
 ---       - virtual_text: (default true) Use virtual text for diagnostics. If multiple diagnostics
 ---                       are set for a namespace, one prefix per diagnostic + the last diagnostic
----                       message are shown.
+---                       message are shown. In addition to the options listed below, the
+---                       "virt_text" options of |nvim_buf_set_extmark()| may also be used here
+---                       (e.g. "virt_text_pos" and "hl_mode").
 ---                       Options:
 ---                       * severity: Only show virtual text for diagnostics matching the given
 ---                       severity |diagnostic-severity|
@@ -1008,8 +1010,11 @@ M.handlers.virtual_text = {
 
       if virt_texts then
         api.nvim_buf_set_extmark(bufnr, virt_text_ns, line, 0, {
-          hl_mode = 'combine',
+          hl_mode = opts.virtual_text.hl_mode or 'combine',
           virt_text = virt_texts,
+          virt_text_pos = opts.virtual_text.virt_text_pos,
+          virt_text_hide = opts.virtual_text.virt_text_hide,
+          virt_text_win_col = opts.virtual_text.virt_text_win_col,
         })
       end
     end
-- 
cgit 


From e7801775060e2d8f9f20572fac687f438e81caa0 Mon Sep 17 00:00:00 2001
From: Michael Strobel <71396679+Kibadda@users.noreply.github.com>
Date: Wed, 16 Aug 2023 15:49:14 +0200
Subject: feat(diagnostic): filter diagnostics by specific severities (#24736)

Allow users to filter diagnostics by specifying severities
---
 runtime/lua/vim/diagnostic.lua | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index 1391dafd75..96d1cb7629 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -94,11 +94,22 @@ local function filter_by_severity(severity, diagnostics)
     end, diagnostics)
   end
 
-  local min_severity = to_severity(severity.min) or M.severity.HINT
-  local max_severity = to_severity(severity.max) or M.severity.ERROR
+  if severity.min or severity.max then
+    local min_severity = to_severity(severity.min) or M.severity.HINT
+    local max_severity = to_severity(severity.max) or M.severity.ERROR
+
+    return vim.tbl_filter(function(t)
+      return t.severity <= min_severity and t.severity >= max_severity
+    end, diagnostics)
+  end
+
+  local severities = {}
+  for _, s in ipairs(severity) do
+    severities[to_severity(s)] = true
+  end
 
   return vim.tbl_filter(function(t)
-    return t.severity <= min_severity and t.severity >= max_severity
+    return severities[t.severity]
   end, diagnostics)
 end
 
-- 
cgit 


From 8cbb2477cf70ea29105e3df17308e6d6a067c8e6 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 17 Aug 2023 09:43:00 +0800
Subject: vim-patch:8.2.1969: Vim9: map() may change the list or dict item type

Problem:    Vim9: map() may change the list or dict item type.
Solution:   Add mapnew().

https://github.com/vim/vim/commit/ea696852e7abcdebaf7f17a7f23dc90df1f5e2ed

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/_meta/vimfn.lua | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index d1173e8a42..3782f4bf2f 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -4922,6 +4922,8 @@ function vim.fn.log10(expr) end
 --- {expr1} must be a |List|, |Blob| or |Dictionary|.
 --- Replace each item in {expr1} with the result of evaluating
 --- {expr2}.  For a |Blob| each byte is replaced.
+--- If the item type changes you may want to use |mapnew()| to
+--- create a new List or Dictionary.
 ---
 --- {expr2} must be a |string| or |Funcref|.
 ---
@@ -5078,6 +5080,15 @@ function vim.fn.maparg(name, mode, abbr, dict) end
 --- @return any
 function vim.fn.mapcheck(name, mode, abbr) end
 
+--- Like |map()| but instead of replacing items in {expr1} a new
+--- List or Dictionary is created and returned.  {expr1} remains
+--- unchanged.
+---
+--- @param expr1 any
+--- @param expr2 any
+--- @return any
+function vim.fn.mapnew(expr1, expr2) end
+
 --- Restore a mapping from a dictionary returned by |maparg()|.
 --- {mode} and {abbr} should be the same as for the call to
 --- |maparg()|. *E460*
-- 
cgit 


From 3117dc70f1e60569f5c3cc0eee5f5005081722b5 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 17 Aug 2023 11:08:21 +0800
Subject: vim-patch:1b884a005398

Update runtime files.

https://github.com/vim/vim/commit/1b884a0053982335f644eec6c71027706bf3c522

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/_meta/vimfn.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 3782f4bf2f..b48e2beb8d 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -5082,7 +5082,8 @@ function vim.fn.mapcheck(name, mode, abbr) end
 
 --- Like |map()| but instead of replacing items in {expr1} a new
 --- List or Dictionary is created and returned.  {expr1} remains
---- unchanged.
+--- unchanged.  Items can still be changed by {expr2}, if you
+--- don't want that use |deepcopy()| first.
 ---
 --- @param expr1 any
 --- @param expr2 any
-- 
cgit 


From d9e7dad13945ce1f4110c37d5388b5c532dec0d3 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 17 Aug 2023 12:37:52 +0800
Subject: vim-patch:8.2.3818: cannot filter or map characters in a string

Problem:    Cannot filter or map characters in a string.
Solution:   Make filter() and map() work on a string. (Naruhiko Nishino,
            closes vim/vim#9327)

https://github.com/vim/vim/commit/c479ce032f5d4d14bab9e479acbf42d758879893

Co-authored-by: rbtnn <naru123456789@gmail.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 47 +++++++++++++++++++++++------------------
 1 file changed, 27 insertions(+), 20 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index b48e2beb8d..4b90a9e3c0 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -2005,10 +2005,11 @@ function vim.fn.filereadable(file) end
 --- @return 0|1
 function vim.fn.filewritable(file) end
 
---- {expr1} must be a |List|, |Blob|, or a |Dictionary|.
+--- {expr1} must be a |List|, |String|, |Blob| or |Dictionary|.
 --- For each item in {expr1} evaluate {expr2} and when the result
---- is zero remove the item from the |List| or |Dictionary|. For a
---- |Blob| each byte is removed.
+--- is zero or false remove the item from the |List| or
+--- |Dictionary|.  Similarly for each byte in a |Blob| and each
+--- character in a |String|.
 ---
 --- {expr2} must be a |string| or |Funcref|.
 ---
@@ -2044,14 +2045,16 @@ function vim.fn.filewritable(file) end
 --- <If you do not use "val" you can leave it out: >vim
 ---   call filter(myList, {idx -> idx % 2 == 1})
 --- <
---- The operation is done in-place.  If you want a |List| or
---- |Dictionary| to remain unmodified make a copy first: >vim
+--- For a |List| and a |Dictionary| the operation is done
+--- in-place.  If you want it to remain unmodified make a copy
+--- first: >vim
 ---   let l = filter(copy(mylist), 'v:val =~ "KEEP"')
 ---
---- <Returns {expr1}, the |List|, |Blob| or |Dictionary| that was
---- filtered.  When an error is encountered while evaluating
---- {expr2} no further items in {expr1} are processed.  When
---- {expr2} is a Funcref errors inside a function are ignored,
+--- <Returns {expr1}, the |List| or |Dictionary| that was filtered,
+--- or a new |Blob| or |String|.
+--- When an error is encountered while evaluating {expr2} no
+--- further items in {expr1} are processed.
+--- When {expr2} is a Funcref errors inside a function are ignored,
 --- unless it was defined with the "abort" flag.
 ---
 --- @param expr1 any
@@ -4919,15 +4922,18 @@ function vim.fn.log(expr) end
 --- @return any
 function vim.fn.log10(expr) end
 
---- {expr1} must be a |List|, |Blob| or |Dictionary|.
---- Replace each item in {expr1} with the result of evaluating
---- {expr2}.  For a |Blob| each byte is replaced.
+--- {expr1} must be a |List|, |String|, |Blob| or |Dictionary|.
+--- When {expr1} is a |List|| or |Dictionary|, replace each
+--- item in {expr1} with the result of evaluating {expr2}.
+--- For a |Blob| each byte is replaced.
+--- For a |String|, each character, including composing
+--- characters, is replaced.
 --- If the item type changes you may want to use |mapnew()| to
 --- create a new List or Dictionary.
 ---
---- {expr2} must be a |string| or |Funcref|.
+--- {expr2} must be a |String| or |Funcref|.
 ---
---- If {expr2} is a |string|, inside {expr2} |v:val| has the value
+--- If {expr2} is a |String|, inside {expr2} |v:val| has the value
 --- of the current item.  For a |Dictionary| |v:key| has the key
 --- of the current item and for a |List| |v:key| has the index of
 --- the current item.  For a |Blob| |v:key| has the index of the
@@ -4957,14 +4963,15 @@ function vim.fn.log10(expr) end
 --- <If you do not use "key" you can use a short name: >vim
 ---   call map(myDict, {_, val -> 'item: ' .. val})
 --- <
---- The operation is done in-place.  If you want a |List| or
---- |Dictionary| to remain unmodified make a copy first: >vim
+--- The operation is done in-place for a |List| and |Dictionary|.
+--- If you want it to remain unmodified make a copy first: >vim
 ---   let tlist = map(copy(mylist), ' v:val .. "\t"')
 ---
---- <Returns {expr1}, the |List|, |Blob| or |Dictionary| that was
---- filtered.  When an error is encountered while evaluating
---- {expr2} no further items in {expr1} are processed.  When
---- {expr2} is a Funcref errors inside a function are ignored,
+--- <Returns {expr1}, the |List| or |Dictionary| that was filtered,
+--- or a new |Blob| or |String|.
+--- When an error is encountered while evaluating {expr2} no
+--- further items in {expr1} are processed.
+--- When {expr2} is a Funcref errors inside a function are ignored,
 --- unless it was defined with the "abort" flag.
 ---
 --- @param expr1 any
-- 
cgit 


From c5576fcc8003280489c0aa0323a966e6de33e31f Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 17 Aug 2023 13:41:43 +0800
Subject: vim-patch:8.2.3848: cannot use reduce() for a string

Problem:    Cannot use reduce() for a string.
Solution:   Make reduce() work with a string. (Naruhiko Nishino, closes vim/vim#9366)

https://github.com/vim/vim/commit/0ccb5842f5fb103763d106c7aa364d758343c35a

Omit tv_get_first_char() as it doesn't really save much code.

Co-authored-by: rbtnn <naru123456789@gmail.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 4b90a9e3c0..4fe9093666 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -6551,9 +6551,9 @@ function vim.fn.readdir(directory, expr) end
 function vim.fn.readfile(fname, type, max) end
 
 --- {func} is called for every item in {object}, which can be a
---- |List| or a |Blob|.  {func} is called with two arguments: the
---- result so far and current item.  After processing all items
---- the result is returned.
+--- |String|, |List| or a |Blob|.  {func} is called with two arguments:
+--- the result so far and current item.  After processing all
+--- items the result is returned.
 ---
 --- {initial} is the initial result.  When omitted, the first item
 --- in {object} is used and {func} is first called for the second
@@ -6564,6 +6564,7 @@ function vim.fn.readfile(fname, type, max) end
 ---   echo reduce([1, 3, 5], { acc, val -> acc + val })
 ---   echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a')
 ---   echo reduce(0z1122, { acc, val -> 2 * acc + val })
+---   echo reduce('xyz', { acc, val -> acc .. ',' .. val })
 --- <
 ---
 --- @param object any
-- 
cgit 


From b193674b4a1dce1b348489fa13dd42254b9a3ebb Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 17 Aug 2023 14:12:24 +0800
Subject: vim-patch:partial:8.2.3849: functions implementing reduce and map are
 too long

Problem:    Functions implementing reduce and map are too long.
Solution:   Use a function for each type of value.  Add a few more test cases
            and add to the help. (Yegappan Lakshmanan, closes vim/vim#9370)

https://github.com/vim/vim/commit/389b72196e6aaeafe3f907c73d271f2c6b931140

Partial port as this doesn't include handling for non-materialized List.

Co-authored-by: Yegappan Lakshmanan <yegappan@yahoo.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 13 +++++++------
 1 file changed, 7 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 4fe9093666..17eda634e0 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -2017,8 +2017,8 @@ function vim.fn.filewritable(file) end
 --- of the current item.  For a |Dictionary| |v:key| has the key
 --- of the current item and for a |List| |v:key| has the index of
 --- the current item.  For a |Blob| |v:key| has the index of the
---- current byte.
----
+--- current byte. For a |String| |v:key| has the index of the
+--- current character.
 --- Examples: >vim
 ---   call filter(mylist, 'v:val !~ "OLD"')
 --- <Removes the items where "OLD" appears. >vim
@@ -4937,7 +4937,8 @@ function vim.fn.log10(expr) end
 --- of the current item.  For a |Dictionary| |v:key| has the key
 --- of the current item and for a |List| |v:key| has the index of
 --- the current item.  For a |Blob| |v:key| has the index of the
---- current byte.
+--- current byte. For a |String| |v:key| has the index of the
+--- current character.
 --- Example: >vim
 ---   call map(mylist, '"> " .. v:val .. " <"')
 --- <This puts "> " before and " <" after each item in "mylist".
@@ -6551,9 +6552,9 @@ function vim.fn.readdir(directory, expr) end
 function vim.fn.readfile(fname, type, max) end
 
 --- {func} is called for every item in {object}, which can be a
---- |String|, |List| or a |Blob|.  {func} is called with two arguments:
---- the result so far and current item.  After processing all
---- items the result is returned.
+--- |String|, |List| or a |Blob|.  {func} is called with two
+--- arguments: the result so far and current item.  After
+--- processing all items the result is returned.
 ---
 --- {initial} is the initial result.  When omitted, the first item
 --- in {object} is used and {func} is first called for the second
-- 
cgit 


From 6267996f13c5fd2ae8023b85c48e0e207e278cd9 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 17 Aug 2023 15:42:36 +0800
Subject: vim-patch:8.2.4455: accepting one and zero for second sort() argument
 is strange

Problem:    Accepting one and zero for the second sort() argument is strange.
Solution:   Disallow using one and zero in Vim9 script.

https://github.com/vim/vim/commit/2007dd49f5cb36f944cab1cfbceb0f864e625f74

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/_meta/vimfn.lua | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 17eda634e0..d1c90249ed 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -8531,15 +8531,16 @@ function vim.fn.sockconnect(mode, address, opts) end
 --- If you want a list to remain unmodified make a copy first: >vim
 ---   let sortedlist = sort(copy(mylist))
 ---
---- <When {func} is omitted, is empty or zero, then sort() uses the
+--- <When {how} is omitted or is a string, then sort() uses the
 --- string representation of each item to sort on.  Numbers sort
 --- after Strings, |Lists| after Numbers.  For sorting text in the
 --- current buffer use |:sort|.
 ---
---- When {func} is given and it is '1' or 'i' then case is
---- ignored.
+--- When {how} is given and it is 'i' then case is ignored.
+--- For backwards compatibility, the value one can be used to
+--- ignore case.  Zero means to not ignore case.
 ---
---- When {func} is given and it is 'l' then the current collation
+--- When {how} is given and it is 'l' then the current collation
 --- locale is used for ordering. Implementation details: strcoll()
 --- is used to compare strings. See |:language| check or set the
 --- collation locale. |v:collate| can also be used to check the
@@ -8556,19 +8557,19 @@ function vim.fn.sockconnect(mode, address, opts) end
 --- <  ['n', 'o', 'O', 'p', 'z', 'ö'] ~
 --- This does not work properly on Mac.
 ---
---- When {func} is given and it is 'n' then all items will be
+--- When {how} is given and it is 'n' then all items will be
 --- sorted numerical (Implementation detail: this uses the
 --- strtod() function to parse numbers, Strings, Lists, Dicts and
 --- Funcrefs will be considered as being 0).
 ---
---- When {func} is given and it is 'N' then all items will be
+--- When {how} is given and it is 'N' then all items will be
 --- sorted numerical. This is like 'n' but a string containing
 --- digits will be used as the number they represent.
 ---
---- When {func} is given and it is 'f' then all items will be
+--- When {how} is given and it is 'f' then all items will be
 --- sorted numerical. All values must be a Number or a Float.
 ---
---- When {func} is a |Funcref| or a function name, this function
+--- When {how} is a |Funcref| or a function name, this function
 --- is called to compare items.  The function is invoked with two
 --- items as argument and must return zero if they are equal, 1 or
 --- bigger if the first one sorts after the second one, -1 or
@@ -8598,10 +8599,10 @@ function vim.fn.sockconnect(mode, address, opts) end
 --- <
 ---
 --- @param list any
---- @param func? any
+--- @param how? any
 --- @param dict? any
 --- @return any
-function vim.fn.sort(list, func, dict) end
+function vim.fn.sort(list, how, dict) end
 
 --- Return the sound-folded equivalent of {word}.  Uses the first
 --- language in 'spelllang' for the current window that supports
-- 
cgit 


From 88887a7be707773f908dd6e597f0293d3c1a0faa Mon Sep 17 00:00:00 2001
From: Sean Dewar <seandewar@users.noreply.github.com>
Date: Thu, 17 Aug 2023 16:38:56 +0100
Subject: docs(builtin): fix some missing lines (#24759)

Some things got chopped off in the PR that removed method syntax examples.
These were all that I found.
---
 runtime/lua/vim/_meta/vimfn.lua | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index d1c90249ed..ce325ce1f8 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -570,6 +570,8 @@ function vim.fn.bufloaded(buf) end
 --- with a listed buffer, that one is returned.  Next unlisted
 --- buffers are searched for.
 --- If the {buf} is a String, but you want to use it as a buffer
+--- number, force it to be a Number by adding zero to it: >vim
+---   echo bufname("3" + 0)
 --- <If the buffer doesn't exist, or doesn't have a name, an empty
 --- string is returned. >vim
 ---   echo bufname("#")  " alternate buffer name
@@ -4426,6 +4428,9 @@ function vim.fn.insert(object, item, idx) end
 function vim.fn.interrupt() end
 
 --- Bitwise invert.  The argument is converted to a number.  A
+--- List, Dict or Float argument causes an error.  Example: >vim
+---   let bits = invert(bits)
+--- <
 ---
 --- @param expr any
 --- @return any
@@ -6761,6 +6766,9 @@ function vim.fn.resolve(filename) end
 --- {object} can be a |List| or a |Blob|.
 --- Returns {object}.
 --- Returns zero if {object} is not a List or a Blob.
+--- If you want an object to remain unmodified make a copy first: >vim
+---   let revlist = reverse(copy(mylist))
+--- <
 ---
 --- @param object any
 --- @return any
-- 
cgit 


From f8afa8023ee032dfb2aa9a6489f51484fb276732 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Fri, 18 Aug 2023 08:42:45 +0800
Subject: vim-patch:9.0.1728: missing winid argument for virtcol() (#24770)

Problem: missing winid argument for virtcol()
Solution: Add a {winid} argument to virtcol()

Other functions col(), charcol() and virtcol2col() support a {winid}
argument, so it makes sense for virtcol() to also support than.

Also add test for virtcol2col() with 'showbreak' and {winid}.

closes: vim/vim#12633

https://github.com/vim/vim/commit/825cf813fa0fddf085fcbd3194781e875320ff63
---
 runtime/lua/vim/_meta/vimfn.lua | 14 +++++++++-----
 1 file changed, 9 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index ce325ce1f8..8ae6dd5f10 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -10013,10 +10013,13 @@ function vim.fn.values(dict) end
 ---       returns the cursor position.  Differs from |'<| in
 ---       that it's updated right away.
 ---
---- If {list} is present and non-zero then virtcol() returns a List
---- with the first and last screen position occupied by the
+--- If {list} is present and non-zero then virtcol() returns a
+--- List with the first and last screen position occupied by the
 --- character.
 ---
+--- With the optional {winid} argument the values are obtained for
+--- that window instead of the current window.
+---
 --- Note that only marks in the current file can be used.
 --- Examples: >vim
 ---   " With text "foo^Lbar" and cursor on the "^L":
@@ -10028,15 +10031,16 @@ function vim.fn.values(dict) end
 ---   " With text "    there", with 't at 'h':
 ---
 ---   echo virtcol("'t")  " returns 6
---- <Techo he first column is 1.  0 is returned for an error.
---- A echo more advanced example that echoes the maximum length of
+--- <The first column is 1.  0 or [0, 0] is returned for an error.
+--- A more advanced example that echoes the maximum length of
 --- all lines: >vim
 ---     echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
 ---
 --- @param expr any
 --- @param list? any
+--- @param winid? integer
 --- @return any
-function vim.fn.virtcol(expr, list) end
+function vim.fn.virtcol(expr, list, winid) end
 
 --- The result is a Number, which is the byte index of the
 --- character in window {winid} at buffer line {lnum} and virtual
-- 
cgit 


From 4c7df98e4eeed20f8a9c461729935b79743d7752 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sat, 19 Aug 2023 17:44:19 +0800
Subject: vim-patch:9.0.1515: reverse() does not work for a String

Problem:    reverse() does not work for a String.
Solution:   Implement reverse() for a String. (Yegappan Lakshmanan,
            closes vim/vim#12179)

https://github.com/vim/vim/commit/03ff1c2dde7f15eca5c9baa6dafbda9b49bedc3b

vim-patch:9.0.1738: Duplicate code to reverse a string

Problem:  Duplicate code to reverse a string
Solution: Move reverse_text() to strings.c and remove string_reverse().

closes: vim/vim#12847

https://github.com/vim/vim/commit/4dd266cb66d901cf5324f09405cfea3f004bd29f

Co-authored-by: Yegappan Lakshmanan <yegappan@yahoo.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 12 +++++++-----
 1 file changed, 7 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 8ae6dd5f10..030f268f81 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -6762,11 +6762,13 @@ vim.fn['repeat'] = function(expr, count) end
 --- @return any
 function vim.fn.resolve(filename) end
 
---- Reverse the order of items in {object} in-place.
---- {object} can be a |List| or a |Blob|.
---- Returns {object}.
---- Returns zero if {object} is not a List or a Blob.
---- If you want an object to remain unmodified make a copy first: >vim
+--- Reverse the order of items in {object}.  {object} can be a
+--- |List|, a |Blob| or a |String|.  For a List and a Blob the
+--- items are reversed in-place and {object} is returned.
+--- For a String a new String is returned.
+--- Returns zero if {object} is not a List, Blob or a String.
+--- If you want a List or Blob to remain unmodified make a copy
+--- first: >vim
 ---   let revlist = reverse(copy(mylist))
 --- <
 ---
-- 
cgit 


From 694814cdd54ac245d1f4d2c28dce7e9132fcb616 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 21 Aug 2023 07:29:49 +0800
Subject: vim-patch:9.0.1774: no support for custom cmdline completion (#24808)

Problem:  no support for custom cmdline completion
Solution: Add new vimscript functions

Add the following two functions:
- getcmdcompltype() returns custom and customlist functions

- getcompletion() supports both custom and customlist

closes: vim/vim#12228

https://github.com/vim/vim/commit/92997dda789ad8061841128cbc99b15ec0374411

Co-authored-by: Shougo Matsushita <Shougo.Matsu@gmail.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 030f268f81..300210b296 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -2871,7 +2871,9 @@ function vim.fn.getcmdwintype() end
 --- color    color schemes
 --- command    Ex command
 --- compiler  compilers
---- diff_buffer     |:diffget| and |:diffput| completion
+--- custom,{func}  custom completion, defined via {func}
+--- customlist,{func} custom completion, defined via {func}
+--- diff_buffer  |:diffget| and |:diffput| completion
 --- dir    directory names
 --- environment  environment variable names
 --- event    autocommand events
-- 
cgit 


From a5b6468e9bc19d3e01846c9a6a47a766b8b81a5a Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Mon, 21 Aug 2023 09:46:44 +0900
Subject: vim-patch:9.0.1766: Runtime: Missing QML support

Problem:  Runtime: Missing QML support
Solution: Add QML support to Vim

closes: vim/vim#12810

https://github.com/vim/vim/commit/bedc69f9d67b117ab05aa735c701cd3899d1ae2d

Co-authored-by: ChaseKnowlden <haroldknowlden@gmail.com>
---
 runtime/lua/vim/filetype.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 1ea88ebc06..bb7d9f174a 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -800,6 +800,8 @@ local extension = {
   ptl = 'python',
   ql = 'ql',
   qll = 'ql',
+  qml = 'qml',
+  qbs = 'qml',
   qmd = 'quarto',
   R = detect.r,
   rkt = 'racket',
-- 
cgit 


From eaad2f7806a3f2ff29997e0533a09cf78397cf1c Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Mon, 21 Aug 2023 09:49:04 +0900
Subject: vim-patch:9.0.1768: Runtime: no support for bicep files

Problem:  Runtime: no support for bicep files
Solution: Add filetype support for bicepparam

closes: vim/vim#12784

https://github.com/vim/vim/commit/2d0988ef93c6e8e59381c9cd123efbc2cd1faf92

Co-authored-by: Scott McKendry <scott.c.mckendry@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index bb7d9f174a..ffb284cca7 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -229,6 +229,7 @@ local extension = {
   com = detect_seq(detect.bindzone, 'dcl'),
   db = detect.bindzone,
   bicep = 'bicep',
+  bicepparam = 'bicep',
   bb = 'bitbake',
   bbappend = 'bitbake',
   bbclass = 'bitbake',
-- 
cgit 


From 64ccfdaafef56b451e3a5eed94367fad93978ec8 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 21 Aug 2023 11:22:25 +0800
Subject: vim-patch:8.1.2047: cannot check the current state

Problem:    Cannot check the current state.
Solution:   Add the state() function.

https://github.com/vim/vim/commit/0e57dd859ecb1e8a3b91509d2f4343e839340eb8

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/_meta/vimfn.lua | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 300210b296..4665f71052 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -5713,6 +5713,7 @@ function vim.fn.mkdir(name, flags, prot) end
 --- If [expr] is supplied and it evaluates to a non-zero Number or
 --- a non-empty String (|non-zero-arg|), then the full mode is
 --- returned, otherwise only the first letter is returned.
+--- Also see |state()|.
 ---
 ---    n      Normal
 ---    no      Operator-pending
@@ -8744,6 +8745,34 @@ function vim.fn.sqrt(expr) end
 --- @return any
 function vim.fn.srand(expr) end
 
+--- Return a string which contains characters indicating the
+--- current state.  Mostly useful in callbacks that want to do
+--- work that may not always be safe.  Roughly this works like:
+--- - callback uses state() to check if work is safe to do.
+---   If yes, then do it right away.
+---   Otherwise add to work queue and add SafeState autocommand.
+--- - When SafeState is triggered, check with state() if the work
+---   can be done now, and if yes remove it from the queue and
+---   execute.
+--- Also see |mode()|.
+---
+--- When {what} is given only characters in this string will be
+--- added.  E.g, this checks if the screen has scrolled: >vim
+---   if state('s') != ''
+---
+--- These characters indicate the state:
+---     m  halfway a mapping, :normal command, feedkeys() or
+---        stuffed command
+---     o  operator pending or waiting for a command argument
+---     a  Insert mode autocomplete active
+---     x  executing an autocommand
+---     c  callback invoked (repeats for recursiveness up to "ccc")
+---     s  screen has scrolled for messages
+---
+--- @param what? string
+--- @return any
+function vim.fn.state(what) end
+
 --- With |--headless| this opens stdin and stdout as a |channel|.
 --- May be called only once. See |channel-stdio|. stderr is not
 --- handled by this function, see |v:stderr|.
-- 
cgit 


From 7ce2acd59be89e5e6d2ac778ad074a9ae42951cd Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 21 Aug 2023 12:16:33 +0800
Subject: vim-patch:8.1.2053: SafeStateAgain not triggered if callback uses
 feedkeys()

Problem:    SafeStateAgain not triggered if callback uses feedkeys().
Solution:   Check for safe state in the input loop.  Make log messages easier
            to find. Add 'S' flag to state().

https://github.com/vim/vim/commit/d103ee78432f9036d243b18dd5aac1263d3b7dc9

Include misc1.c change from patch 8.1.2062.

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/_meta/vimfn.lua | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 4665f71052..70d1aa4a79 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -8760,13 +8760,16 @@ function vim.fn.srand(expr) end
 --- added.  E.g, this checks if the screen has scrolled: >vim
 ---   if state('s') != ''
 ---
---- These characters indicate the state:
+--- These characters indicate the state, generally indicating that
+--- something is busy:
 ---     m  halfway a mapping, :normal command, feedkeys() or
 ---        stuffed command
 ---     o  operator pending or waiting for a command argument
 ---     a  Insert mode autocomplete active
 ---     x  executing an autocommand
----     c  callback invoked (repeats for recursiveness up to "ccc")
+---     S  not triggering SafeState
+---     c  callback invoked, including timer (repeats for
+---        recursiveness up to "ccc")
 ---     s  screen has scrolled for messages
 ---
 --- @param what? string
-- 
cgit 


From 0f48173ab531a9012321714bbc29ae4cd57b7ac7 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 21 Aug 2023 17:09:31 +0800
Subject: vim-patch:589edb340454

Updte runtime files

https://github.com/vim/vim/commit/589edb340454e7f1b19358f129287a636d53d0e1

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/_meta/vimfn.lua | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 70d1aa4a79..86d3dd21a1 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -8749,27 +8749,30 @@ function vim.fn.srand(expr) end
 --- current state.  Mostly useful in callbacks that want to do
 --- work that may not always be safe.  Roughly this works like:
 --- - callback uses state() to check if work is safe to do.
----   If yes, then do it right away.
----   Otherwise add to work queue and add SafeState autocommand.
---- - When SafeState is triggered, check with state() if the work
----   can be done now, and if yes remove it from the queue and
----   execute.
+---   Yes: then do it right away.
+---   No:  add to work queue and add a |SafeState| autocommand.
+--- - When SafeState is triggered and executes your autocommand,
+---   check with `state()` if the work can be done now, and if yes
+---   remove it from the queue and execute.
+---   Remove the autocommand if the queue is now empty.
 --- Also see |mode()|.
 ---
 --- When {what} is given only characters in this string will be
 --- added.  E.g, this checks if the screen has scrolled: >vim
----   if state('s') != ''
+---   if state('s') == ''
+---      " screen has not scrolled
 ---
 --- These characters indicate the state, generally indicating that
 --- something is busy:
 ---     m  halfway a mapping, :normal command, feedkeys() or
----        stuffed command
----     o  operator pending or waiting for a command argument
+---   stuffed command
+---     o  operator pending or waiting for a command argument,
+---   e.g. after |f|
 ---     a  Insert mode autocomplete active
 ---     x  executing an autocommand
 ---     S  not triggering SafeState
 ---     c  callback invoked, including timer (repeats for
----        recursiveness up to "ccc")
+---   recursiveness up to "ccc")
 ---     s  screen has scrolled for messages
 ---
 --- @param what? string
-- 
cgit 


From 6bdfb890fd26408408e85b5e0ea4a1fbeb8b048d Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 21 Aug 2023 17:18:10 +0800
Subject: vim-patch:e46a44050562

Runtime file updates

https://github.com/vim/vim/commit/e46a4405056276b4cbdacee76b11f85c8ea1830b

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/_meta/vimfn.lua | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 86d3dd21a1..e393844724 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -3230,7 +3230,7 @@ function vim.fn.getmarklist(buf) end
 --- @return any
 function vim.fn.getmatches(win) end
 
---- Returns a Dictionary with the last known position of the
+--- Returns a |Dictionary| with the last known position of the
 --- mouse.  This can be used in a mapping for a mouse click.  The
 --- items are:
 ---   screenrow  screen row
@@ -6878,7 +6878,7 @@ function vim.fn.screenattr(row, col) end
 --- @return any
 function vim.fn.screenchar(row, col) end
 
---- The result is a List of Numbers.  The first number is the same
+--- The result is a |List| of Numbers.  The first number is the same
 --- as what |screenchar()| returns.  Further numbers are
 --- composing characters on top of the base character.
 --- This is mainly to be used for testing.
@@ -7069,7 +7069,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
 --- without the "S" flag in 'shortmess'.  This works even if
 --- 'shortmess' does contain the "S" flag.
 ---
---- This returns a Dictionary. The dictionary is empty if the
+--- This returns a |Dictionary|. The dictionary is empty if the
 --- previous pattern was not set and "pattern" was not specified.
 ---
 ---   key    type    meaning ~
@@ -7151,7 +7151,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
 ---   " search again
 ---   call searchcount()
 --- <
---- {options} must be a Dictionary. It can contain:
+--- {options} must be a |Dictionary|. It can contain:
 ---   key    type    meaning ~
 ---   recompute  |Boolean|  if |TRUE|, recompute the count
 ---         like |n| or |N| was executed.
@@ -8766,11 +8766,10 @@ function vim.fn.srand(expr) end
 --- something is busy:
 ---     m  halfway a mapping, :normal command, feedkeys() or
 ---   stuffed command
----     o  operator pending or waiting for a command argument,
----   e.g. after |f|
+---     o  operator pending, e.g. after |d|
 ---     a  Insert mode autocomplete active
 ---     x  executing an autocommand
----     S  not triggering SafeState
+---     S  not triggering SafeState, e.g. after |f| or a count
 ---     c  callback invoked, including timer (repeats for
 ---   recursiveness up to "ccc")
 ---     s  screen has scrolled for messages
-- 
cgit 


From 09910d5b35f2432a22374e59560a1bbd08907d57 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 22 Aug 2023 18:21:15 +0800
Subject: vim-patch:9.0.0837: append() reports failure when not appending
 anything

Problem:    append() reports failure when not appending anything.
Solution:   Only report failure when appending something. (closes vim/vim#11498)

https://github.com/vim/vim/commit/cd9c8d400c1eb9cbb4ff6a33be02f91a30ab13b2

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/_meta/vimfn.lua | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index e393844724..126abb29ac 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -79,7 +79,8 @@ function vim.fn.api_info() end
 --- {lnum} can be zero to insert a line before the first one.
 --- {lnum} is used like with |getline()|.
 --- Returns 1 for failure ({lnum} out of range or out of memory),
---- 0 for success.  Example: >vim
+--- 0 for success.  When {text} is an empty list zero is returned,
+--- no matter the value of {lnum}.  Example: >vim
 ---   let failed = append(line('$'), "# THE END")
 ---   let failed = append(0, ["Chapter 1", "the beginning"])
 --- <
@@ -106,7 +107,8 @@ function vim.fn.append(lnum, text) end
 --- If {buf} is not a valid buffer or {lnum} is not valid, an
 --- error message is given. Example: >vim
 ---   let failed = appendbufline(13, 0, "# THE START")
---- <
+--- <However, when {text} is an empty list then no error is given
+--- for an invalid {lnum}, since {lnum} isn't actually used.
 ---
 --- @param buf any
 --- @param lnum integer
@@ -7398,9 +7400,10 @@ function vim.fn.serverstop(address) end
 ---
 --- To insert lines use |appendbufline()|.
 ---
---- {text} can be a string to set one line, or a list of strings
---- to set multiple lines.  If the list extends below the last
---- line then those lines are added.
+--- {text} can be a string to set one line, or a List of strings
+--- to set multiple lines.  If the List extends below the last
+--- line then those lines are added.  If the List is empty then
+--- nothing is changed and zero is returned.
 ---
 --- For the use of {buf}, see |bufname()| above.
 ---
@@ -7602,7 +7605,8 @@ function vim.fn.setfperm(fname, mode) end
 --- When {lnum} is just below the last line the {text} will be
 --- added below the last line.
 --- {text} can be any type or a List of any type, each item is
---- converted to a String.
+--- converted to a String.  When {text} is an empty List then
+--- nothing is changed and FALSE is returned.
 ---
 --- If this succeeds, FALSE is returned.  If this fails (most likely
 --- because {lnum} is invalid) TRUE is returned.
-- 
cgit 


From 21152f7905b5e2f472b1a745109f6316a7e5994d Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Thu, 17 Aug 2023 11:10:06 +0100
Subject: fix(types): add more annotations to eval.lua

---
 runtime/lua/vim/_meta/vimfn.lua | 146 ++++++++++++++++++++--------------------
 1 file changed, 73 insertions(+), 73 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 126abb29ac..255f49ba3f 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -1600,7 +1600,7 @@ function vim.fn.eventhandler() end
 --- |exepath()| can be used to get the full path of an executable.
 ---
 --- @param expr any
---- @return any
+--- @return 0|1|-1
 function vim.fn.executable(expr) end
 
 --- Execute {command} and capture its output.
@@ -8957,7 +8957,7 @@ function vim.fn.strcharpart(src, start, len, skipcc) end
 ---
 --- @param string string
 --- @param skipcc? any
---- @return any
+--- @return integer
 function vim.fn.strchars(string, skipcc) end
 
 --- The result is a Number, which is the number of display cells
@@ -8975,7 +8975,7 @@ function vim.fn.strchars(string, skipcc) end
 ---
 --- @param string string
 --- @param col? integer
---- @return any
+--- @return integer
 function vim.fn.strdisplaywidth(string, col) end
 
 --- The result is a String, which is a formatted date and time, as
@@ -8996,7 +8996,7 @@ function vim.fn.strdisplaywidth(string, col) end
 ---
 --- @param format any
 --- @param time? any
---- @return any
+--- @return string
 function vim.fn.strftime(format, time) end
 
 --- Get a Number corresponding to the character at {index} in
@@ -9007,9 +9007,9 @@ function vim.fn.strftime(format, time) end
 --- Returns -1 if {index} is invalid.
 --- Also see |strcharpart()| and |strchars()|.
 ---
---- @param str any
---- @param index any
---- @return any
+--- @param str string
+--- @param index integer
+--- @return integer
 function vim.fn.strgetchar(str, index) end
 
 --- The result is a Number, which gives the byte index in
@@ -9030,10 +9030,10 @@ function vim.fn.strgetchar(str, index) end
 --- stridx() works similar to the C function strstr().  When used
 --- with a single character it works similar to strchr().
 ---
---- @param haystack any
---- @param needle any
---- @param start? any
---- @return any
+--- @param haystack string
+--- @param needle string
+--- @param start? integer
+--- @return integer
 function vim.fn.stridx(haystack, needle, start) end
 
 --- Return {expr} converted to a String.  If {expr} is a Number,
@@ -9060,7 +9060,7 @@ function vim.fn.stridx(haystack, needle, start) end
 --- share data with other application.
 ---
 --- @param expr any
---- @return any
+--- @return string
 function vim.fn.string(expr) end
 
 --- The result is a Number, which is the length of the String
@@ -9072,7 +9072,7 @@ function vim.fn.string(expr) end
 --- Also see |len()|, |strdisplaywidth()| and |strwidth()|.
 ---
 --- @param string string
---- @return any
+--- @return integer
 function vim.fn.strlen(string) end
 
 --- The result is a String, which is part of {src}, starting from
@@ -9099,11 +9099,11 @@ function vim.fn.strlen(string) end
 --- <
 --- Returns an empty string on error.
 ---
---- @param src any
---- @param start any
---- @param len? any
---- @param chars? any
---- @return any
+--- @param src string
+--- @param start integer
+--- @param len? integer
+--- @param chars? 0|1
+--- @return string
 function vim.fn.strpart(src, start, len, chars) end
 
 --- The result is a Number, which is a unix timestamp representing
@@ -9129,9 +9129,9 @@ function vim.fn.strpart(src, start, len, chars) end
 ---   echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
 --- <  Sun Apr 27 12:53:55 1997
 ---
---- @param format any
---- @param timestring any
---- @return any
+--- @param format string
+--- @param timestring string
+--- @return integer
 function vim.fn.strptime(format, timestring) end
 
 --- The result is a Number, which gives the byte index in
@@ -9151,10 +9151,10 @@ function vim.fn.strptime(format, timestring) end
 --- When used with a single character it works similar to the C
 --- function strrchr().
 ---
---- @param haystack any
---- @param needle any
---- @param start? any
---- @return any
+--- @param haystack string
+--- @param needle string
+--- @param start? integer
+--- @return integer
 function vim.fn.strridx(haystack, needle, start) end
 
 --- The result is a String, which is {string} with all unprintable
@@ -9167,7 +9167,7 @@ function vim.fn.strridx(haystack, needle, start) end
 --- Returns an empty string on error.
 ---
 --- @param string string
---- @return any
+--- @return string
 function vim.fn.strtrans(string) end
 
 --- The result is a Number, which is the number of UTF-16 code
@@ -9189,8 +9189,8 @@ function vim.fn.strtrans(string) end
 ---     echo strutf16len('ą́', v:true)  " returns 3
 ---
 --- @param string string
---- @param countcc? any
---- @return any
+--- @param countcc? 0|1
+--- @return integer
 function vim.fn.strutf16len(string, countcc) end
 
 --- The result is a Number, which is the number of display cells
@@ -9202,7 +9202,7 @@ function vim.fn.strutf16len(string, countcc) end
 --- Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
 ---
 --- @param string string
---- @return any
+--- @return integer
 function vim.fn.strwidth(string) end
 
 --- Only for an expression in a |:substitute| command or
@@ -9233,8 +9233,8 @@ function vim.fn.strwidth(string) end
 --- A line break is included as a newline character.
 ---
 --- @param nr integer
---- @param list? any
---- @return any
+--- @param list? integer
+--- @return string|string[]
 function vim.fn.submatch(nr, list) end
 
 --- The result is a String, which is a copy of {string}, in which
@@ -9280,10 +9280,10 @@ function vim.fn.submatch(nr, list) end
 --- <Returns an empty string on error.
 ---
 --- @param string string
---- @param pat any
---- @param sub any
+--- @param pat string
+--- @param sub string
 --- @param flags string
---- @return any
+--- @return string
 function vim.fn.substitute(string, pat, sub, flags) end
 
 --- Returns a list of swap file names, like what "vim -r" shows.
@@ -9296,7 +9296,7 @@ function vim.fn.substitute(string, pat, sub, flags) end
 ---   let swapfiles = swapfilelist()
 ---   let &directory = save_dir
 ---
---- @return any
+--- @return string[]
 function vim.fn.swapfilelist() end
 
 --- The result is a dictionary, which holds information about the
@@ -9326,8 +9326,8 @@ function vim.fn.swapinfo(fname) end
 --- |:swapname| (unless there is no swap file).
 --- If buffer {buf} has no swap file, returns an empty string.
 ---
---- @param buf any
---- @return any
+--- @param buf integer|string
+--- @return string
 function vim.fn.swapname(buf) end
 
 --- The result is a Number, which is the syntax ID at the position
@@ -9357,8 +9357,8 @@ function vim.fn.swapname(buf) end
 ---
 --- @param lnum integer
 --- @param col integer
---- @param trans any
---- @return any
+--- @param trans 0|1
+--- @return integer
 function vim.fn.synID(lnum, col, trans) end
 
 --- The result is a String, which is the {what} attribute of
@@ -9406,10 +9406,10 @@ function vim.fn.synID(lnum, col, trans) end
 ---   echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
 --- <
 ---
---- @param synID any
---- @param what any
+--- @param synID integer
+--- @param what string
 --- @param mode? string
---- @return any
+--- @return string
 function vim.fn.synIDattr(synID, what, mode) end
 
 --- The result is a Number, which is the translated syntax ID of
@@ -9419,8 +9419,8 @@ function vim.fn.synIDattr(synID, what, mode) end
 ---
 --- Returns zero on error.
 ---
---- @param synID any
---- @return any
+--- @param synID integer
+--- @return integer
 function vim.fn.synIDtrans(synID) end
 
 --- The result is a |List| with currently three items:
@@ -9450,7 +9450,7 @@ function vim.fn.synIDtrans(synID) end
 ---
 --- @param lnum integer
 --- @param col integer
---- @return any
+--- @return {[1]: integer, [2]: string, [3]: integer}[]
 function vim.fn.synconcealed(lnum, col) end
 
 --- Return a |List|, which is the stack of syntax items at the
@@ -9473,7 +9473,7 @@ function vim.fn.synconcealed(lnum, col) end
 ---
 --- @param lnum integer
 --- @param col integer
---- @return any
+--- @return integer[]
 function vim.fn.synstack(lnum, col) end
 
 --- Note: Prefer |vim.system()| in Lua.
@@ -9524,9 +9524,9 @@ function vim.fn.synstack(lnum, col) end
 --- <Unlike ":!cmd" there is no automatic check for changed files.
 --- Use |:checktime| to force a check.
 ---
---- @param cmd any
---- @param input? any
---- @return any
+--- @param cmd string|string[]
+--- @param input? string|string[]|integer
+--- @return string
 function vim.fn.system(cmd, input) end
 
 --- Same as |system()|, but returns a |List| with lines (parts of
@@ -9542,10 +9542,10 @@ function vim.fn.system(cmd, input) end
 --- <
 --- Returns an empty string on error.
 ---
---- @param cmd any
---- @param input? any
---- @param keepempty? any
---- @return any
+--- @param cmd string|string[]
+--- @param input? string|string[]|integer
+--- @param keepempty? integer
+--- @return string[]
 function vim.fn.systemlist(cmd, input, keepempty) end
 
 --- The result is a |List|, where each item is the number of the
@@ -9577,8 +9577,8 @@ function vim.fn.tabpagebuflist(arg) end
 ---
 --- Returns zero on error.
 ---
---- @param arg? any
---- @return any
+--- @param arg? '$'|'#'
+--- @return integer
 function vim.fn.tabpagenr(arg) end
 
 --- Like |winnr()| but for tab page {tabarg}.
@@ -9593,15 +9593,15 @@ function vim.fn.tabpagenr(arg) end
 ---     tabpagewinnr(4, '$')    " number of windows in tab page 4
 --- <When {tabarg} is invalid zero is returned.
 ---
---- @param tabarg any
---- @param arg? any
---- @return any
+--- @param tabarg integer
+--- @param arg? '$'|'#'
+--- @return integer
 function vim.fn.tabpagewinnr(tabarg, arg) end
 
 --- Returns a |List| with the file names used to search for tags
 --- for the current buffer.  This is the 'tags' option expanded.
 ---
---- @return any
+--- @return string[]
 function vim.fn.tagfiles() end
 
 --- Returns a |List| of tags matching the regular expression {expr}.
@@ -9647,7 +9647,7 @@ function vim.fn.tagfiles() end
 --- the tags file generated by the different ctags tools.
 ---
 --- @param expr any
---- @param filename? any
+--- @param filename? string
 --- @return any
 function vim.fn.taglist(expr, filename) end
 
@@ -9661,8 +9661,8 @@ function vim.fn.taglist(expr, filename) end
 ---   echo tan(-4.01)
 --- <  -1.181502
 ---
---- @param expr any
---- @return any
+--- @param expr number
+--- @return number
 function vim.fn.tan(expr) end
 
 --- Return the hyperbolic tangent of {expr} as a |Float| in the
@@ -9675,8 +9675,8 @@ function vim.fn.tan(expr) end
 ---   echo tanh(-1)
 --- <  -0.761594
 ---
---- @param expr any
---- @return any
+--- @param expr number
+--- @return number
 function vim.fn.tanh(expr) end
 
 --- Generates a (non-existent) filename located in the Nvim root
@@ -9824,10 +9824,10 @@ function vim.fn.toupper(expr) end
 ---   echo tr("<blob>", "<>", "{}")
 --- <returns "{blob}"
 ---
---- @param src any
---- @param fromstr any
---- @param tostr any
---- @return any
+--- @param src string
+--- @param fromstr string
+--- @param tostr string
+--- @return string
 function vim.fn.tr(src, fromstr, tostr) end
 
 --- Return {text} as a String where any character in {mask} is
@@ -9855,8 +9855,8 @@ function vim.fn.tr(src, fromstr, tostr) end
 --- <returns "  vim"
 ---
 --- @param text any
---- @param mask? any
---- @param dir? string
+--- @param mask? string
+--- @param dir? 0|1|2
 --- @return string
 function vim.fn.trim(text, mask, dir) end
 
@@ -9873,7 +9873,7 @@ function vim.fn.trim(text, mask, dir) end
 --- <  4.0
 ---
 --- @param expr any
---- @return any
+--- @return integer
 function vim.fn.trunc(expr) end
 
 --- The result is a Number representing the type of {expr}.
@@ -9903,7 +9903,7 @@ function vim.fn.trunc(expr) end
 ---   if exists('v:t_number') | endif
 ---
 --- @param expr any
---- @return any
+--- @return integer
 function vim.fn.type(expr) end
 
 --- Return the name of the undo file that would be used for a file
@@ -9963,7 +9963,7 @@ function vim.fn.undofile(name) end
 ---     blocks.  Each item may again have an "alt"
 ---     item.
 ---
---- @param buf? any
+--- @param buf? integer|string
 --- @return any
 function vim.fn.undotree(buf) end
 
-- 
cgit 


From 08fa71fd274530be23b6ae6b10222afee0b57522 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Wed, 23 Aug 2023 19:32:11 +0800
Subject: vim-patch:9.0.1773: cannot distinguish Forth and Fortran *.f files
 (#24841)

Problem:  cannot distinguish Forth and Fortran *.f files
Solution: Add Filetype detection Code

Also add *.4th as a Forth filetype

closes: vim/vim#12251

https://github.com/vim/vim/commit/19a3bc3addf9b4aa8150a01b11b4249c67d15d3b

Don't remove filetype files from Vim patches:
- filetype.vim, script.vim, ft.vim usually contain useful changes
- script.vim and ft.vim don't even have their paths spelled correctly

Co-authored-by: Doug Kearns <dougkearns@gmail.com>
---
 runtime/lua/vim/filetype.lua        |  5 +++--
 runtime/lua/vim/filetype/detect.lua | 40 ++++++++++++++++++++++++++++++++-----
 2 files changed, 38 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index ffb284cca7..c310eb3e42 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -398,6 +398,7 @@ local extension = {
   EXW = detect.euphoria,
   ex = detect.ex,
   exp = 'expect',
+  f = detect.f,
   factor = 'factor',
   fal = 'falcon',
   fan = 'fan',
@@ -410,8 +411,9 @@ local extension = {
   fish = 'fish',
   focexec = 'focexec',
   fex = 'focexec',
-  fth = 'forth',
   ft = 'forth',
+  fth = 'forth',
+  ['4th'] = 'forth',
   FOR = 'fortran',
   f77 = 'fortran',
   f03 = 'fortran',
@@ -427,7 +429,6 @@ local extension = {
   F77 = 'fortran',
   f95 = 'fortran',
   FPP = 'fortran',
-  f = 'fortran',
   F = 'fortran',
   F08 = 'fortran',
   f08 = 'fortran',
diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index 59b50f2288..4a7a1cbefe 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -473,6 +473,38 @@ function M.ex(_, bufnr)
   end
 end
 
+--- @param bufnr integer
+--- @return boolean
+local function is_forth(bufnr)
+  local first_line = nextnonblank(bufnr, 1)
+
+  -- SwiftForth block comment (line is usually filled with '-' or '=') or
+  -- OPTIONAL (sometimes precedes the header comment)
+  if first_line and findany(first_line:lower(), { '^%{%s', '^%{$', '^optional%s' }) then
+    return true
+  end
+
+  for _, line in ipairs(getlines(bufnr, 1, 100)) do
+    -- Forth comments and colon definitions
+    if line:find('^[:(\\] ') then
+      return true
+    end
+  end
+  return false
+end
+
+-- Distinguish between Forth and Fortran
+--- @type vim.filetype.mapfn
+function M.f(_, bufnr)
+  if vim.g.filetype_f then
+    return vim.g.filetype_f
+  end
+  if is_forth(bufnr) then
+    return 'forth'
+  end
+  return 'fortran'
+end
+
 -- This function checks the first 15 lines for appearance of 'FoamFile'
 -- and then 'object' in a following line.
 -- In that case, it's probably an OpenFOAM file
@@ -518,16 +550,14 @@ function M.fvwm_v2(path, _)
   end
 end
 
--- Distinguish between Forth and F#.
+-- Distinguish between Forth and F#
 --- @type vim.filetype.mapfn
 function M.fs(_, bufnr)
   if vim.g.filetype_fs then
     return vim.g.filetype_fs
   end
-  for _, line in ipairs(getlines(bufnr, 1, 100)) do
-    if line:find('^[:(\\] ') then
-      return 'forth'
-    end
+  if is_forth(bufnr) then
+    return 'forth'
   end
   return 'fsharp'
 end
-- 
cgit 


From c6ec7fa8d741d6301701067ecd095bf02e7a741a Mon Sep 17 00:00:00 2001
From: Amaan Qureshi <amaanq12@gmail.com>
Date: Tue, 22 Aug 2023 00:51:38 -0400
Subject: feat(treesitter): add 'injection.self' and 'injection.parent'

Co-authored-by: ObserverOfTime <chronobserver@disroot.org>
---
 runtime/lua/vim/treesitter/languagetree.lua | 11 ++++++++---
 1 file changed, 8 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 4b419c4744..e81778b269 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -82,6 +82,7 @@ local TSCallbackNames = {
 ---List of regions this tree should manage and parse. If nil then regions are
 ---taken from _trees. This is mostly a short-lived cache for included_regions()
 ---@field private _lang string Language name
+---@field private _parent_lang? string Parent language name
 ---@field private _source (integer|string) Buffer or string to parse
 ---@field private _trees TSTree[] Reference to parsed tree (one for each language)
 ---@field private _valid boolean|table<integer,boolean> If the parsed tree is valid
@@ -105,8 +106,9 @@ LanguageTree.__index = LanguageTree
 ---@param opts (table|nil) Optional arguments:
 ---             - injections table Map of language to injection query strings. Overrides the
 ---                                built-in runtime file searching for language injections.
+---@param parent_lang? string Parent language name of this tree
 ---@return LanguageTree parser object
-function LanguageTree.new(source, lang, opts)
+function LanguageTree.new(source, lang, opts, parent_lang)
   language.add(lang)
   ---@type LanguageTreeOpts
   opts = opts or {}
@@ -121,6 +123,7 @@ function LanguageTree.new(source, lang, opts)
   local self = {
     _source = source,
     _lang = lang,
+    _parent_lang = parent_lang,
     _children = {},
     _trees = {},
     _opts = opts,
@@ -489,7 +492,7 @@ function LanguageTree:add_child(lang)
     self:remove_child(lang)
   end
 
-  local child = LanguageTree.new(self._source, lang, self._opts)
+  local child = LanguageTree.new(self._source, lang, self._opts, self:lang())
 
   -- Inherit recursive callbacks
   for nm, cb in pairs(self._callbacks_rec) do
@@ -752,7 +755,9 @@ end
 function LanguageTree:_get_injection(match, metadata)
   local ranges = {} ---@type Range6[]
   local combined = metadata['injection.combined'] ~= nil
-  local lang = metadata['injection.language'] --[[@as string?]]
+  local lang = metadata['injection.self'] ~= nil and self:lang()
+    or metadata['injection.parent'] ~= nil and self._parent_lang
+    or metadata['injection.language'] --[[@as string?]]
   local include_children = metadata['injection.include-children'] ~= nil
 
   for id, node in pairs(match) do
-- 
cgit 


From daf7abbc4238dc269e22dd431bc4b1627ef9b6a1 Mon Sep 17 00:00:00 2001
From: Sean Dewar <seandewar@users.noreply.github.com>
Date: Thu, 24 Aug 2023 13:29:40 +0100
Subject: docs(builtin): small fixes (#24861)

Also make gen_eval_files.lua render vimdoc helpExamples properly if the line
begins with the `>` marker.
---
 runtime/lua/vim/_meta/vimfn.lua | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 255f49ba3f..0ac8985274 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -3853,7 +3853,7 @@ function vim.fn.globpath(path, expr, nosuf, list, allinks) end
 ---   clipboard  |clipboard| provider is available.
 ---   fname_case  Case in file names matters (for Darwin and MS-Windows
 ---       this is not present).
----                         gui_running  Nvim has a GUI.
+---   gui_running  Nvim has a GUI.
 ---   iconv    Can use |iconv()| for conversion.
 ---   linux    Linux system.
 ---   mac    MacOS system.
@@ -8765,7 +8765,7 @@ function vim.fn.srand(expr) end
 --- added.  E.g, this checks if the screen has scrolled: >vim
 ---   if state('s') == ''
 ---      " screen has not scrolled
----
+--- <
 --- These characters indicate the state, generally indicating that
 --- something is busy:
 ---     m  halfway a mapping, :normal command, feedkeys() or
@@ -9446,7 +9446,6 @@ function vim.fn.synIDtrans(synID) end
 ---   synconcealed(lnum, 4)   [1, 'X', 2]
 ---   synconcealed(lnum, 5)   [1, 'X', 2]
 ---   synconcealed(lnum, 6)   [0, '', 0]
---- <
 ---
 --- @param lnum integer
 --- @param col integer
-- 
cgit 


From 020d1f626a3fbda84b84b2f57e8a85662a792a1a Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Thu, 24 Aug 2023 12:48:21 -0500
Subject: fix(filetype): call on_detect before setting buffer filetype

The on_detect functions returned by filetype.lua set buffer local
variables which are often used by filetype plugins. For example, the
on_detect function for shell buffers sets variables such as b:is_bash or
b:is_sh, which are used by the sh ftplugin.

When called after setting the buffer's filetype, these variables cannot
be used by the ftplugin (because they are not yet defined). Instead,
call on_detect before setting the buffer filetype so that any buffer
variables set by on_detect can be used in the ftplugin.
---
 runtime/lua/vim/filetype.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index c310eb3e42..a05c1075eb 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -2061,7 +2061,8 @@ end
 --- pattern, if any) and should return a string that will be used as the
 --- buffer's filetype. Optionally, the function can return a second function
 --- value which, when called, modifies the state of the buffer. This can be used
---- to, for example, set filetype-specific buffer variables.
+--- to, for example, set filetype-specific buffer variables. This function will
+--- be called by Nvim before setting the buffer's filetype.
 ---
 --- Filename patterns can specify an optional priority to resolve cases when a
 --- file path matches multiple patterns. Higher priorities are matched first.
-- 
cgit 


From af38b46a2574f59358bc3bf54dd7c34b5c0f396d Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Thu, 24 Aug 2023 12:56:24 -0500
Subject: fix(filetype): return on_detect function when matching by file
 contents

---
 runtime/lua/vim/filetype.lua | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index a05c1075eb..193c9b0199 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -2377,11 +2377,16 @@ function M.match(args)
     -- If the function tries to use the filename that is nil then it will fail,
     -- but this enables checks which do not need a filename to still work.
     local ok
-    ok, ft = pcall(require('vim.filetype.detect').match_contents, contents, name, function(ext)
-      return dispatch(extension[ext], name, bufnr)
-    end)
-    if ok and ft then
-      return ft
+    ok, ft, on_detect = pcall(
+      require('vim.filetype.detect').match_contents,
+      contents,
+      name,
+      function(ext)
+        return dispatch(extension[ext], name, bufnr)
+      end
+    )
+    if ok then
+      return ft, on_detect
     end
   end
 end
-- 
cgit 


From 5d8ab32f3871b0232972cac1116ac7cba98389e5 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Fri, 25 Aug 2023 11:17:36 -0700
Subject: feat(treesitter): add a query editor (#24703)

---
 runtime/lua/vim/treesitter.lua     |  11 ++-
 runtime/lua/vim/treesitter/dev.lua | 198 +++++++++++++++++++++++++++++++++----
 2 files changed, 188 insertions(+), 21 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 04420c81e3..4f84fc2e0f 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -472,8 +472,8 @@ end
 --- Open a window that displays a textual representation of the nodes in the language tree.
 ---
 --- While in the window, press "a" to toggle display of anonymous nodes, "I" to toggle the
---- display of the source language of each node, and press <Enter> to jump to the node under the
---- cursor in the source buffer.
+--- display of the source language of each node, "o" to toggle the query previewer, and press
+--- <Enter> to jump to the node under the cursor in the source buffer.
 ---
 --- Can also be shown with `:InspectTree`. *:InspectTree*
 ---
@@ -494,6 +494,13 @@ function M.inspect_tree(opts)
   require('vim.treesitter.dev').inspect_tree(opts)
 end
 
+--- Open a window for live editing of a treesitter query.
+---
+--- Can also be shown with `:PreviewQuery`. *:PreviewQuery*
+function M.preview_query()
+  require('vim.treesitter.dev').preview_query()
+end
+
 --- Returns the fold level for {lnum} in the current buffer. Can be set directly to 'foldexpr':
 --- <pre>lua
 --- vim.wo.foldexpr = 'v:lua.vim.treesitter.foldexpr()'
diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index f7625eb94b..b7f2c0e473 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -124,7 +124,7 @@ function TSTreeView:new(bufnr, lang)
   end
 
   local t = {
-    ns = api.nvim_create_namespace(''),
+    ns = api.nvim_create_namespace('treesitter/dev-inspect'),
     nodes = nodes,
     named = named,
     opts = {
@@ -158,6 +158,29 @@ local function escape_quotes(text)
   return string.format('"%s"', text:sub(2, #text - 1):gsub('"', '\\"'))
 end
 
+---@param w integer
+---@return boolean closed Whether the window was closed.
+local function close_win(w)
+  if api.nvim_win_is_valid(w) then
+    api.nvim_win_close(w, true)
+    return true
+  end
+
+  return false
+end
+
+---@param w integer
+---@param b integer
+local function set_dev_properties(w, b)
+  vim.wo[w].scrolloff = 5
+  vim.wo[w].wrap = false
+  vim.wo[w].foldmethod = 'manual' -- disable folding
+  vim.bo[b].buflisted = false
+  vim.bo[b].buftype = 'nofile'
+  vim.bo[b].bufhidden = 'wipe'
+  vim.bo[b].filetype = 'query'
+end
+
 --- Write the contents of this View into {bufnr}.
 ---
 ---@param bufnr integer Buffer number to write into.
@@ -247,12 +270,9 @@ function M.inspect_tree(opts)
   local win = api.nvim_get_current_win()
   local pg = assert(TSTreeView:new(buf, opts.lang))
 
-  -- Close any existing dev window
-  if vim.b[buf].dev then
-    local w = vim.b[buf].dev
-    if api.nvim_win_is_valid(w) then
-      api.nvim_win_close(w, true)
-    end
+  -- Close any existing inspector window
+  if vim.b[buf].dev_inspect then
+    close_win(vim.b[buf].dev_inspect)
   end
 
   local w = opts.winid
@@ -268,16 +288,10 @@ function M.inspect_tree(opts)
     b = api.nvim_win_get_buf(w)
   end
 
-  vim.b[buf].dev = w
-
-  vim.wo[w].scrolloff = 5
-  vim.wo[w].wrap = false
-  vim.wo[w].foldmethod = 'manual' -- disable folding
-  vim.bo[b].buflisted = false
-  vim.bo[b].buftype = 'nofile'
-  vim.bo[b].bufhidden = 'wipe'
+  vim.b[buf].dev_inspect = w
+  vim.b[b].dev_base = win -- base window handle
   vim.b[b].disable_query_linter = true
-  vim.bo[b].filetype = 'query'
+  set_dev_properties(w, b)
 
   local title --- @type string?
   local opts_title = opts.title
@@ -306,7 +320,7 @@ function M.inspect_tree(opts)
   api.nvim_buf_set_keymap(b, 'n', 'a', '', {
     desc = 'Toggle anonymous nodes',
     callback = function()
-      local row, col = unpack(api.nvim_win_get_cursor(w))
+      local row, col = unpack(api.nvim_win_get_cursor(w)) ---@type integer, integer
       local curnode = pg:get(row)
       while curnode and not curnode.named do
         row = row - 1
@@ -336,6 +350,15 @@ function M.inspect_tree(opts)
       pg:draw(b)
     end,
   })
+  api.nvim_buf_set_keymap(b, 'n', 'o', '', {
+    desc = 'Toggle query previewer',
+    callback = function()
+      local preview_w = vim.b[buf].dev_preview
+      if not preview_w or not close_win(preview_w) then
+        M.preview_query()
+      end
+    end,
+  })
 
   local group = api.nvim_create_augroup('treesitter/dev', {})
 
@@ -436,11 +459,148 @@ function M.inspect_tree(opts)
     buffer = buf,
     once = true,
     callback = function()
-      if api.nvim_win_is_valid(w) then
-        api.nvim_win_close(w, true)
+      close_win(w)
+    end,
+  })
+end
+
+local preview_ns = api.nvim_create_namespace('treesitter/dev-preview')
+
+---@param query_win integer
+---@param base_win integer
+local function update_preview_highlights(query_win, base_win)
+  local base_buf = api.nvim_win_get_buf(base_win)
+  local query_buf = api.nvim_win_get_buf(query_win)
+  local parser = vim.treesitter.get_parser(base_buf)
+  local lang = parser:lang()
+  api.nvim_buf_clear_namespace(base_buf, preview_ns, 0, -1)
+  local query_content = table.concat(api.nvim_buf_get_lines(query_buf, 0, -1, false), '\n')
+
+  local ok_query, query = pcall(vim.treesitter.query.parse, lang, query_content)
+  if not ok_query then
+    return
+  end
+
+  local cursor_word = vim.fn.expand('<cword>') --[[@as string]]
+  -- Only highlight captures if the cursor is on a capture name
+  if cursor_word:find('^@') == nil then
+    return
+  end
+  -- Remove the '@' from the cursor word
+  cursor_word = cursor_word:sub(2)
+  local topline, botline = vim.fn.line('w0', base_win), vim.fn.line('w$', base_win)
+  for id, node in query:iter_captures(parser:trees()[1]:root(), base_buf, topline - 1, botline) do
+    local capture_name = query.captures[id]
+    if capture_name == cursor_word then
+      local lnum, col, end_lnum, end_col = node:range()
+      api.nvim_buf_set_extmark(base_buf, preview_ns, lnum, col, {
+        end_row = end_lnum,
+        end_col = end_col,
+        hl_group = 'Visual',
+        virt_text = {
+          { capture_name, 'Title' },
+        },
+      })
+    end
+  end
+end
+
+--- @private
+function M.preview_query()
+  local buf = api.nvim_get_current_buf()
+  local win = api.nvim_get_current_win()
+
+  -- Close any existing previewer window
+  if vim.b[buf].dev_preview then
+    close_win(vim.b[buf].dev_preview)
+  end
+
+  local cmd = '60vnew'
+  -- If the inspector is open, place the previewer above it.
+  local base_win = vim.b[buf].dev_base ---@type integer?
+  local base_buf = base_win and api.nvim_win_get_buf(base_win)
+  local inspect_win = base_buf and vim.b[base_buf].dev_inspect
+  if base_win and base_buf and api.nvim_win_is_valid(inspect_win) then
+    vim.api.nvim_set_current_win(inspect_win)
+    buf = base_buf
+    win = base_win
+    cmd = 'new'
+  end
+  vim.cmd(cmd)
+
+  local ok, parser = pcall(vim.treesitter.get_parser, buf)
+  if not ok then
+    return nil, 'No parser available for the given buffer'
+  end
+  local lang = parser:lang()
+
+  local query_win = api.nvim_get_current_win()
+  local query_buf = api.nvim_win_get_buf(query_win)
+
+  vim.b[buf].dev_preview = query_win
+  vim.bo[query_buf].omnifunc = 'v:lua.vim.treesitter.query.omnifunc'
+  set_dev_properties(query_win, query_buf)
+
+  -- Note that omnifunc guesses the language based on the containing folder,
+  -- so we add the parser's language to the buffer's name so that omnifunc
+  -- can infer the language later.
+  api.nvim_buf_set_name(query_buf, string.format('%s/query_previewer.scm', lang))
+
+  local group = api.nvim_create_augroup('treesitter/dev-preview', {})
+  api.nvim_create_autocmd({ 'TextChanged', 'InsertLeave' }, {
+    group = group,
+    buffer = query_buf,
+    desc = 'Update query previewer diagnostics when the query changes',
+    callback = function()
+      vim.treesitter.query.lint(query_buf, { langs = lang, clear = false })
+    end,
+  })
+  api.nvim_create_autocmd({ 'TextChanged', 'InsertLeave', 'CursorMoved', 'BufEnter' }, {
+    group = group,
+    buffer = query_buf,
+    desc = 'Update query previewer highlights when the cursor moves',
+    callback = function()
+      update_preview_highlights(query_win, win)
+    end,
+  })
+  api.nvim_create_autocmd('BufLeave', {
+    group = group,
+    buffer = query_buf,
+    desc = 'Clear the query previewer highlights when leaving the previewer',
+    callback = function()
+      api.nvim_buf_clear_namespace(buf, preview_ns, 0, -1)
+    end,
+  })
+  api.nvim_create_autocmd('BufLeave', {
+    group = group,
+    buffer = buf,
+    desc = 'Clear the query previewer highlights when leaving the source buffer',
+    callback = function()
+      if not api.nvim_buf_is_loaded(query_buf) then
+        return true
       end
+
+      api.nvim_buf_clear_namespace(query_buf, preview_ns, 0, -1)
+    end,
+  })
+  api.nvim_create_autocmd('BufHidden', {
+    group = group,
+    buffer = buf,
+    desc = 'Close the previewer window when the source buffer is hidden',
+    once = true,
+    callback = function()
+      close_win(query_win)
     end,
   })
+
+  api.nvim_buf_set_lines(query_buf, 0, -1, false, {
+    ';; Write your query here. Use @captures to highlight matches in the source buffer.',
+    ';; Completion for grammar nodes is available (see :h compl-omni)',
+    '',
+    '',
+  })
+  vim.cmd('normal! G')
+  vim.cmd.startinsert()
 end
 
 return M
-- 
cgit 


From b1cfb299df2ef412339f594173ed23c75c090c8a Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sat, 26 Aug 2023 08:35:05 +0800
Subject: docs: various clarifications (#24876)

---
 runtime/lua/vim/_meta/builtin.lua |  6 +++---
 runtime/lua/vim/_meta/options.lua |  5 +++--
 runtime/lua/vim/_meta/vimfn.lua   | 18 +++++++++---------
 3 files changed, 15 insertions(+), 14 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/builtin.lua b/runtime/lua/vim/_meta/builtin.lua
index a5508bdc04..d7b76a803c 100644
--- a/runtime/lua/vim/_meta/builtin.lua
+++ b/runtime/lua/vim/_meta/builtin.lua
@@ -132,7 +132,7 @@ function vim.str_utf_pos(str) end
 ---
 --- Examples:
 --- <pre>lua
---- -- The character 'æ' are equal to the bytes '\xc3\xa6' (using UTF-8)
+--- -- The character 'æ' is stored as the bytes '\xc3\xa6' (using UTF-8)
 ---
 --- -- Returns 0 because the index is pointing at the first byte of a character
 --- vim.str_utf_start('æ', 1)
@@ -151,12 +151,12 @@ function vim.str_utf_start(str, index) end
 ---
 --- Examples:
 --- <pre>lua
---- -- The character 'æ' are equal to the bytes '\xc3\xa6' (using UTF-8)
+--- -- The character 'æ' is stored as the bytes '\xc3\xa6' (using UTF-8)
 ---
 --- -- Returns 0 because the index is pointing at the last byte of a character
 --- vim.str_utf_end('æ', 2)
 ---
---- -- Returns 1 because the index is pointing at the second last byte of a character
+--- -- Returns 1 because the index is pointing at the penultimate byte of a character
 --- vim.str_utf_end('æ', 1)
 --- </pre>
 ---
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 8edb87df91..4fb3141df0 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -4323,8 +4323,9 @@ vim.go.mousemoveevent = vim.o.mousemoveevent
 vim.go.mousemev = vim.go.mousemoveevent
 
 --- This option controls the number of lines / columns to scroll by when
---- scrolling with a mouse. The option is a comma separated list of parts.
---- Each part consists of a direction and a count as follows:
+--- scrolling with a mouse wheel (`scroll-mouse-wheel`). The option is
+--- a comma-separated list. Each part consists of a direction and a count
+--- as follows:
 --- 	direction:count,direction:count
 --- Direction is one of either "hor" or "ver". "hor" controls horizontal
 --- scrolling and "ver" controls vertical scrolling. Count sets the amount
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 0ac8985274..ebd74046ce 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -9878,15 +9878,15 @@ function vim.fn.trunc(expr) end
 --- The result is a Number representing the type of {expr}.
 --- Instead of using the number directly, it is better to use the
 --- v:t_ variable that has the value:
----         Number:     0 (|v:t_number|)
----   String:     1 (|v:t_string|)
----   Funcref:    2 (|v:t_func|)
----   List:       3 (|v:t_list|)
----   Dictionary: 4 (|v:t_dict|)
----   Float:      5 (|v:t_float|)
----   Boolean:    6 (|v:true| and |v:false|)
----   Null:       7 (|v:null|)
----   Blob:      10 (|v:t_blob|)
+---   Number:      0  |v:t_number|
+---   String:      1  |v:t_string|
+---   Funcref:    2  |v:t_func|
+---   List:      3  |v:t_list|
+---   Dictionary: 4  |v:t_dict|
+---   Float:      5  |v:t_float|
+---   Boolean:    6  |v:t_bool| (|v:false| and |v:true|)
+---   Null:      7  (|v:null|)
+---   Blob:     10  |v:t_blob|
 --- For backward compatibility, this method can be used: >vim
 ---   if type(myvar) == type(0) | endif
 ---   if type(myvar) == type("") | endif
-- 
cgit 


From b46e93c5fd2c73b99b618d4954ab8d1c71ad3fb0 Mon Sep 17 00:00:00 2001
From: Alisue <lambdalisue@gmail.com>
Date: Mon, 7 Aug 2023 00:19:51 +0900
Subject: docs(msgpack_rpc): add "msgpack-rpc" client type

---
 runtime/lua/vim/_meta/api.lua | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index c0e4e35e7d..fdf5016b68 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1679,7 +1679,11 @@ function vim.api.nvim_select_popupmenu_item(item, insert, finish, opts) end
 --- @param type string Must be one of the following values. Client libraries
 ---                   should default to "remote" unless overridden by the
 ---                   user.
----                   • "remote" remote client connected to Nvim.
+---                   • "remote" remote client connected "Nvim flavored"
+---                     MessagePack-RPC (responses must be in reverse order of
+---                     requests). `msgpack-rpc`
+---                   • "msgpack-rpc" remote client connected to Nvim via
+---                     fully MessagePack-RPC compliant protocol.
 ---                   • "ui" gui frontend
 ---                   • "embedder" application using Nvim as a component (for
 ---                     example, IDE/editor implementing a vim mode).
-- 
cgit 


From 35570e4a11bef061777d741929f74fa66ba3f45a Mon Sep 17 00:00:00 2001
From: Evgeni Chasnovski <evgeni.chasnovski@gmail.com>
Date: Fri, 25 Aug 2023 10:53:35 +0300
Subject: feat(float): implement footer

Problem: Now way to show text at the bottom part of floating window
  border (a.k.a. "footer").

Solution: Allows `footer` and `footer_pos` config fields similar to
  `title` and `title_pos`.
---
 runtime/lua/vim/_meta/api.lua         | 17 ++++++++++++-----
 runtime/lua/vim/_meta/api_keysets.lua |  2 ++
 2 files changed, 14 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index fdf5016b68..7704a60cf8 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1551,11 +1551,18 @@ function vim.api.nvim_open_term(buffer, opts) end
 ---                   specified by character: [ ["+", "MyCorner"], ["x",
 ---                   "MyBorder"] ].
 ---
----               • title: Title (optional) in window border, String or list.
----                 List is [text, highlight] tuples. if is string the default
----                 highlight group is `FloatTitle`.
----               • title_pos: Title position must set with title option.
----                 value can be of `left` `center` `right` default is left.
+---               • title: Title (optional) in window border, string or list.
+---                 List should consist of `[text, highlight]` tuples. If
+---                 string, the default highlight group is `FloatTitle`.
+---               • title_pos: Title position. Must be set with `title`
+---                 option. Value can be one of "left", "center", or "right".
+---                 Default is `"left"`.
+---               • footer: Footer (optional) in window border, string or
+---                 list. List should consist of `[text, highlight]` tuples.
+---                 If string, the default highlight group is `FloatTitle`.
+---               • footer_pos: Footer position. Must be set with `footer`
+---                 option. Value can be one of "left", "center", or "right".
+---                 Default is `"left"`.
 ---               • noautocmd: If true then no buffer-related autocommand
 ---                 events such as `BufEnter`, `BufLeave` or `BufWinEnter` may
 ---                 fire from calling this function.
diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index 941780202e..08c29ebe7a 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -108,6 +108,8 @@ error('Cannot require a meta file')
 --- @field border? any
 --- @field title? any
 --- @field title_pos? string
+--- @field footer? any
+--- @field footer_pos? string
 --- @field style? string
 --- @field noautocmd? boolean
 
-- 
cgit 


From 986bf7e78d09286e198b696630254eb097ad0875 Mon Sep 17 00:00:00 2001
From: Evgeni Chasnovski <evgeni.chasnovski@gmail.com>
Date: Fri, 25 Aug 2023 10:53:39 +0300
Subject: feat(highlight): add `FloatFooter` highlight group

Problem: No clear separation of floating title and footer highlighting.

Solution: Add new `FloatFooter` highlight group.
---
 runtime/lua/vim/_meta/api.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 7704a60cf8..dd67fdb38b 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1559,7 +1559,7 @@ function vim.api.nvim_open_term(buffer, opts) end
 ---                 Default is `"left"`.
 ---               • footer: Footer (optional) in window border, string or
 ---                 list. List should consist of `[text, highlight]` tuples.
----                 If string, the default highlight group is `FloatTitle`.
+---                 If string, the default highlight group is `FloatFooter`.
 ---               • footer_pos: Footer position. Must be set with `footer`
 ---                 option. Value can be one of "left", "center", or "right".
 ---                 Default is `"left"`.
-- 
cgit 


From 2bf3e82676d5caf674cf5ed1eb9677376d9cfa35 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sat, 26 Aug 2023 13:24:29 -0700
Subject: fix(treesitter): validate window before updating preview highlights

---
 runtime/lua/vim/treesitter/dev.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index b7f2c0e473..72b6e3db4a 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -560,7 +560,9 @@ function M.preview_query()
     buffer = query_buf,
     desc = 'Update query previewer highlights when the cursor moves',
     callback = function()
-      update_preview_highlights(query_win, win)
+      if api.nvim_win_is_valid(win) then
+        update_preview_highlights(query_win, win)
+      end
     end,
   })
   api.nvim_create_autocmd('BufLeave', {
-- 
cgit 


From b7d5b55f74fd589dee27d8356d45b31c552705c3 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sun, 27 Aug 2023 01:41:32 -0700
Subject: fix(types): add some return/parameter type annotations (#24867)

* fix(types): add some return/parameter type annotations

* fix(types): narrow stdpath parameter further
---
 runtime/lua/vim/_editor.lua     | 1 +
 runtime/lua/vim/_meta/vimfn.lua | 8 ++++----
 2 files changed, 5 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 8c10cc7da3..96ac379368 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -188,6 +188,7 @@ end
 ---@see |vim.print()|
 ---@see https://github.com/kikito/inspect.lua
 ---@see https://github.com/mpeterv/vinspect
+---@return string
 vim.inspect = vim.inspect
 
 do
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index ebd74046ce..d9d3c92a44 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -3297,8 +3297,8 @@ function vim.fn.getpid() end
 ---   call setpos("'a", save_a_mark)
 --- <Also see |getcharpos()|, |getcurpos()| and |setpos()|.
 ---
---- @param expr any
---- @return any
+--- @param expr string
+--- @return integer[]
 function vim.fn.getpos(expr) end
 
 --- Returns a |List| with all the current quickfix errors.  Each
@@ -8827,8 +8827,8 @@ function vim.fn.stdioopen(opts) end
 ---   echo stdpath("config")
 --- <
 ---
---- @param what any
---- @return any
+--- @param what 'cache'|'config'|'config_dirs'|'data'|'data_dirs'|'log'|'run'|'state'
+--- @return string|string[]
 function vim.fn.stdpath(what) end
 
 --- Convert String {string} to a Float.  This mostly works the
-- 
cgit 


From d3d7d763f3e12211fe40192696b29b209a6c7b85 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 27 Aug 2023 10:57:33 +0100
Subject: feat(builtin): improve types

---
 runtime/lua/vim/_meta/builtin_types.lua | 129 ++++++++++++++++++++++++++++++++
 runtime/lua/vim/_meta/vimfn.lua         |  66 ++++++++--------
 2 files changed, 162 insertions(+), 33 deletions(-)
 create mode 100644 runtime/lua/vim/_meta/builtin_types.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/builtin_types.lua b/runtime/lua/vim/_meta/builtin_types.lua
new file mode 100644
index 0000000000..6beaee90cc
--- /dev/null
+++ b/runtime/lua/vim/_meta/builtin_types.lua
@@ -0,0 +1,129 @@
+--- @class vim.fn.sign
+--- @field group string
+--- @field id integer
+--- @field lnum integer
+--- @field name string
+--- @field priority integer
+
+--- @class vim.fn.getbufinfo.dict
+--- @field buflisted? 0|1
+--- @field bufloaded? 0|1
+--- @field bufmodified? 0|1
+
+--- @class vim.fn.getbufinfo.ret.item
+--- @field bufnr integer
+--- @field changed 0|1
+--- @field changedtick integer
+--- @field hidden 0|1
+--- @field lastused integer
+--- @field linecount integer
+--- @field listed 0|1
+--- @field lnum integer
+--- @field loaded 0|1
+--- @field name string
+--- @field signs vim.fn.sign[]
+--- @field variables table<string,any>
+--- @field windows integer[]
+
+--- @alias vim.fn.getjumplist.ret {[1]: vim.fn.getjumplist.ret.item[], [2]: integer}
+
+--- @class vim.fn.getjumplist.ret.item
+--- @field bufnr integer
+--- @field col integer
+--- @field coladd integer
+--- @field filename? string
+--- @field lnum integer
+
+--- @class vim.fn.getmousepos.ret
+--- @field screenrow integer
+--- @field screencol integer
+--- @field winid integer
+--- @field winrow integer
+--- @field wincol integer
+--- @field line integer
+--- @field column integer
+
+--- @class vim.fn.getwininfo.ret.item
+--- @field botline integer
+--- @field bufnr integer
+--- @field height integer
+--- @field loclist integer
+--- @field quickfix integer
+--- @field tabnr integer
+--- @field terminal integer
+--- @field textoff integer
+--- @field topline integer
+--- @field variables table<string,any>
+--- @field width integer
+--- @field winbar integer
+--- @field wincol integer
+--- @field winid integer
+--- @field winnr integer
+--- @field winrow integer
+
+--- @class vim.fn.sign_define.dict
+--- @field icon string
+--- @field linehl? string
+--- @field numhl? string
+--- @field text? string
+--- @field texthl? string
+--- @field culhl? string
+
+--- @class vim.fn.sign_getdefined.ret.item
+--- @field name string
+--- @field text string
+--- @field icon? string
+--- @field texthl? string
+--- @field culhl? string
+--- @field numhl? string
+--- @field linehl? string
+
+--- @class vim.fn.sign_getplaced.dict
+--- @field group? string
+--- @field id? integer
+--- @field lnum? string
+
+--- @class vim.fn.sign_getplaced.ret.item
+--- @field buf integer
+--- @field signs vim.fn.sign[]
+
+--- @class vim.fn.sign_place.dict
+--- @field lnum? integer
+--- @field priority? integer
+
+--- @class vim.fn.sign_placelist.list.item
+--- @field buffer integer|string
+--- @field group? string
+--- @field id? integer
+--- @field lnum integer
+--- @field name string
+--- @field priority? integer
+
+--- @class vim.fn.sign_unplace.dict
+--- @field buffer? integer|string
+--- @field id? integer
+
+--- @class vim.fn.sign_unplacelist.list.item
+--- @field buffer? integer|string
+--- @field group? string
+--- @field id? integer
+
+--- @class vim.fn.winrestview.dict
+--- @field col? integer
+--- @field coladd? integer
+--- @field curswant? integer
+--- @field leftcol? integer
+--- @field lnum? integer
+--- @field skipcol? integer
+--- @field topfill? integer
+--- @field topline? integer
+
+--- @class vim.fn.winsaveview.ret
+--- @field col integer
+--- @field coladd integer
+--- @field curswant integer
+--- @field leftcol integer
+--- @field lnum integer
+--- @field skipcol integer
+--- @field topfill integer
+--- @field topline integer
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index d9d3c92a44..3f891bdb45 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -2489,7 +2489,7 @@ function vim.fn.get(dict, key, default) end
 function vim.fn.get(func, what) end
 
 --- @param buf? integer|string
---- @return any
+--- @return vim.fn.getbufinfo.ret.item[]
 function vim.fn.getbufinfo(buf) end
 
 --- Get information about buffers as a List of Dictionaries.
@@ -2557,8 +2557,8 @@ function vim.fn.getbufinfo(buf) end
 ---   getbufvar({bufnr}, '&option_name')
 --- <
 ---
---- @param dict? table<string,any>
---- @return any
+--- @param dict? vim.fn.getbufinfo.dict
+--- @return vim.fn.getbufinfo.ret.item[]
 function vim.fn.getbufinfo(dict) end
 
 --- Return a |List| with the lines starting from {lnum} to {end}
@@ -2594,9 +2594,9 @@ function vim.fn.getbufline(buf, lnum, end_) end
 --- Just like `getbufline()` but only get one line and return it
 --- as a string.
 ---
---- @param buf any
+--- @param buf integer|string
 --- @param lnum integer
---- @return any
+--- @return string
 function vim.fn.getbufoneline(buf, lnum) end
 
 --- The result is the value of option or local buffer variable
@@ -3107,7 +3107,7 @@ function vim.fn.getftype(fname) end
 ---
 --- @param winnr? integer
 --- @param tabnr? integer
---- @return any
+--- @return vim.fn.getjumplist.ret
 function vim.fn.getjumplist(winnr, tabnr) end
 
 --- Without {end} the result is a String, which is line {lnum}
@@ -3260,7 +3260,7 @@ function vim.fn.getmatches(win) end
 --- When using |getchar()| the Vim variables |v:mouse_lnum|,
 --- |v:mouse_col| and |v:mouse_winid| also provide these values.
 ---
---- @return any
+--- @return vim.fn.getmousepos.ret
 function vim.fn.getmousepos() end
 
 --- Return a Number which is the process ID of the Vim process.
@@ -3659,7 +3659,7 @@ function vim.fn.gettext(text) end
 ---       "row" from |win_screenpos()|
 ---
 --- @param winid? integer
---- @return any
+--- @return vim.fn.getwininfo.ret.item[]
 function vim.fn.getwininfo(winid) end
 
 --- The result is a |List| with two numbers, the result of
@@ -8048,8 +8048,8 @@ function vim.fn.shellescape(string, special) end
 function vim.fn.shiftwidth(col) end
 
 --- @param name string
---- @param dict? any
---- @return any
+--- @param dict? vim.fn.sign_define.dict
+--- @return 0|-1
 function vim.fn.sign_define(name, dict) end
 
 --- Define a new sign named {name} or modify the attributes of an
@@ -8097,8 +8097,8 @@ function vim.fn.sign_define(name, dict) end
 ---     \ ])
 --- <
 ---
---- @param list any
---- @return any
+--- @param list vim.fn.sign_define.dict[]
+--- @return (0|-1)[]
 function vim.fn.sign_define(list) end
 
 --- Get a list of defined signs and their attributes.
@@ -8137,7 +8137,7 @@ function vim.fn.sign_define(list) end
 --- <
 ---
 --- @param name? string
---- @return any
+--- @return vim.fn.sign_getdefined.ret.item[]
 function vim.fn.sign_getdefined(name) end
 
 --- Return a list of signs placed in a buffer or all the buffers.
@@ -8201,8 +8201,8 @@ function vim.fn.sign_getdefined(name) end
 --- <
 ---
 --- @param buf? any
---- @param dict? any
---- @return any
+--- @param dict? vim.fn.sign_getplaced.dict
+--- @return vim.fn.sign_getplaced.ret.item[]
 function vim.fn.sign_getplaced(buf, dict) end
 
 --- Open the buffer {buf} or jump to the window that contains
@@ -8220,10 +8220,10 @@ function vim.fn.sign_getplaced(buf, dict) end
 ---   call sign_jump(10, '', '')
 --- <
 ---
---- @param id any
---- @param group any
---- @param buf any
---- @return any
+--- @param id integer
+--- @param group string
+--- @param buf integer|string
+--- @return integer
 function vim.fn.sign_jump(id, group, buf) end
 
 --- Place the sign defined as {name} at line {lnum} in file or
@@ -8278,8 +8278,8 @@ function vim.fn.sign_jump(id, group, buf) end
 --- @param group any
 --- @param name string
 --- @param buf any
---- @param dict? any
---- @return any
+--- @param dict? vim.fn.sign_place.dict
+--- @return integer
 function vim.fn.sign_place(id, group, name, buf, dict) end
 
 --- Place one or more signs.  This is similar to the
@@ -8340,12 +8340,12 @@ function vim.fn.sign_place(id, group, name, buf, dict) end
 ---     \ ])
 --- <
 ---
---- @param list any
---- @return any
+--- @param list vim.fn.sign_placelist.list.item[]
+--- @return integer[]
 function vim.fn.sign_placelist(list) end
 
 --- @param name? string
---- @return any
+--- @return 0|-1
 function vim.fn.sign_undefine(name) end
 
 --- Deletes a previously defined sign {name}. This is similar to
@@ -8370,8 +8370,8 @@ function vim.fn.sign_undefine(name) end
 ---   call sign_undefine()
 --- <
 ---
---- @param list? any
---- @return any
+--- @param list? string[]
+--- @return integer[]
 function vim.fn.sign_undefine(list) end
 
 --- Remove a previously placed sign in one or more buffers.  This
@@ -8415,9 +8415,9 @@ function vim.fn.sign_undefine(list) end
 ---   " Remove all the placed signs from all the buffers
 ---   call sign_unplace('*')
 ---
---- @param group any
---- @param dict? any
---- @return any
+--- @param group string
+--- @param dict? vim.fn.sign_unplace.dict
+--- @return 0|-1
 function vim.fn.sign_unplace(group, dict) end
 
 --- Remove previously placed signs from one or more buffers.  This
@@ -8448,8 +8448,8 @@ function vim.fn.sign_unplace(group, dict) end
 ---     \ ])
 --- <
 ---
---- @param list any
---- @return any
+--- @param list vim.fn.sign_unplacelist.list.item
+--- @return (0|-1)[]
 function vim.fn.sign_unplacelist(list) end
 
 --- Simplify the file name as much as possible without changing
@@ -10469,7 +10469,7 @@ function vim.fn.winrestcmd() end
 --- If you have changed the values the result is unpredictable.
 --- If the window size changed the result won't be the same.
 ---
---- @param dict any
+--- @param dict vim.fn.winrestview.dict
 --- @return any
 function vim.fn.winrestview(dict) end
 
@@ -10499,7 +10499,7 @@ function vim.fn.winrestview(dict) end
 ---   skipcol    columns skipped
 --- Note that no option values are saved.
 ---
---- @return any
+--- @return vim.fn.winsaveview.ret
 function vim.fn.winsaveview() end
 
 --- The result is a Number, which is the width of window {nr}.
-- 
cgit 


From ffb340bf63af42ac347e23e0488898adc4391328 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Thu, 24 Aug 2023 17:32:43 +0900
Subject: fix(treesitter): update folds only once on InsertLeave

Problem:
With treesitter fold, InsertLeave can be slow, because a single session
of insert mode may schedule multiple fold updates in on_bytes and
on_changedtree.

Solution:
Don't create duplicate autocmds.
---
 runtime/lua/vim/treesitter/_fold.lua | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index 912a6e8a9f..d82e04a5a8 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -235,6 +235,8 @@ local M = {}
 ---@type table<integer,TS.FoldInfo>
 local foldinfos = {}
 
+local group = api.nvim_create_augroup('treesitter/fold', {})
+
 --- Update the folds in the windows that contain the buffer and use expr foldmethod (assuming that
 --- the user doesn't use different foldexpr for the same buffer).
 ---
@@ -253,7 +255,15 @@ local function foldupdate(bufnr)
 
   if api.nvim_get_mode().mode == 'i' then
     -- foldUpdate() is guarded in insert mode. So update folds on InsertLeave
+    if #(api.nvim_get_autocmds({
+      group = group,
+      buffer = bufnr,
+    })) > 0 then
+      return
+    end
     api.nvim_create_autocmd('InsertLeave', {
+      group = group,
+      buffer = bufnr,
       once = true,
       callback = do_update,
     })
-- 
cgit 


From da7178cbbf4ea87e0759a5f46c2be93732d901af Mon Sep 17 00:00:00 2001
From: Jongwook Choi <wookayin@gmail.com>
Date: Wed, 30 Aug 2023 00:10:41 -0400
Subject: fix(builtin): fix incorrect optional fields for fn.sign_define

The field `icon` is not a mandatory field.
---
 runtime/lua/vim/_meta/builtin_types.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/builtin_types.lua b/runtime/lua/vim/_meta/builtin_types.lua
index 6beaee90cc..ef0452c649 100644
--- a/runtime/lua/vim/_meta/builtin_types.lua
+++ b/runtime/lua/vim/_meta/builtin_types.lua
@@ -62,10 +62,10 @@
 --- @field winrow integer
 
 --- @class vim.fn.sign_define.dict
---- @field icon string
+--- @field text string
+--- @field icon? string
 --- @field linehl? string
 --- @field numhl? string
---- @field text? string
 --- @field texthl? string
 --- @field culhl? string
 
-- 
cgit 


From 497cf996eb1cef54f049e1cca3661c063949be09 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 31 Aug 2023 04:38:01 +0800
Subject: vim-patch:9.0.1803: runtime(filetype): Add norg language detection
 (#24948)

runtime(filetype): Add norg markup language detection

closes: vim/vim#12913

https://github.com/vim/vim/commit/03e44a1d70e914504e6151fe88ad1e574cbf0a59

Co-authored-by: NTBBloodbath <bloodbathalchemist@protonmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 193c9b0199..35a10b6bdc 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -695,6 +695,7 @@ local extension = {
   nimble = 'nim',
   ninja = 'ninja',
   nix = 'nix',
+  norg = 'norg',
   nqc = 'nqc',
   roff = 'nroff',
   tmac = 'nroff',
-- 
cgit 


From 64631168188b76bfb5b57fb36e57cfd1114cf7f7 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 31 Aug 2023 04:38:28 +0800
Subject: vim-patch:9.0.1807: runtime: crystal scripts not recognised (#24949)

Problem:  runtime: crystal scripts not recognised
Solution: Filetype detect Crystal scripts by shebang line

closes: vim/vim#12935

https://github.com/vim/vim/commit/9b73902dbe6f7940326bcd8dbc89d010d85d69c5

Co-authored-by: Doug Kearns <dougkearns@gmail.com>
---
 runtime/lua/vim/filetype/detect.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index 4a7a1cbefe..af6d77ecbf 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -1636,6 +1636,7 @@ local patterns_hashbang = {
   ['icon\\>'] = { 'icon', { vim_regex = true } },
   guile = 'scheme',
   ['nix%-shell'] = 'nix',
+  ['crystal\\>'] = { 'crystal', { vim_regex = true } },
 }
 
 ---@private
-- 
cgit 


From 79148813567909aae8bc733e585d7713f6069401 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 31 Aug 2023 07:44:33 +0800
Subject: vim-patch:9.0.1797: Vimball/Visual Basic filetype detection conflict
 (#24947)

Problem:  Vimball/Visual Basic filetype detection conflict
Solution: runtime(vb): Improve Vimball and Visual Basic detection logic

Only run Vimball Archiver's BufEnter autocommand on Vimball archives.
Fixes vim/vim#2694.

closes: vim/vim#12899

https://github.com/vim/vim/commit/f97f6bbf56408c0c97b4ddbe81fba858d7455b0d

Co-authored-by: Doug Kearns <dougkearns@gmail.com>
---
 runtime/lua/vim/filetype.lua        | 12 ++++++++----
 runtime/lua/vim/filetype/detect.lua | 31 +++++++++++++++++++++----------
 2 files changed, 29 insertions(+), 14 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 35a10b6bdc..0e8ecf1b07 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -351,6 +351,7 @@ local extension = {
   bat = 'dosbatch',
   wrap = 'dosini',
   ini = 'dosini',
+  vbp = 'dosini',
   dot = 'dot',
   gv = 'dot',
   drac = 'dracula',
@@ -1025,13 +1026,18 @@ local extension = {
   url = 'urlshortcut',
   usd = 'usd',
   usda = 'usd',
+  v = detect.v,
   vsh = 'v',
   vv = 'v',
+  ctl = 'vb',
+  dob = 'vb',
+  dsm = 'vb',
+  dsr = 'vb',
+  pag = 'vb',
   sba = 'vb',
   vb = 'vb',
-  dsm = 'vb',
-  ctl = 'vb',
   vbs = 'vb',
+  vba = detect.vba,
   vdf = 'vdf',
   vdmpp = 'vdmpp',
   vpp = 'vdmpp',
@@ -1041,7 +1047,6 @@ local extension = {
   vr = 'vera',
   vri = 'vera',
   vrh = 'vera',
-  v = detect.v,
   va = 'verilogams',
   vams = 'verilogams',
   vhdl = 'vhdl',
@@ -1052,7 +1057,6 @@ local extension = {
   vbe = 'vhdl',
   tape = 'vhs',
   vim = 'vim',
-  vba = 'vim',
   mar = 'vmasm',
   cm = 'voscm',
   wrl = 'vrml',
diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index af6d77ecbf..0609ac5513 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -77,7 +77,7 @@ function M.asm_syntax(_, bufnr)
 end
 
 local visual_basic_content =
-  { 'vb_name', 'begin vb%.form', 'begin vb%.mdiform', 'begin vb%.usercontrol' }
+  [[\c^\s*\%(Attribute\s\+VB_Name\|Begin\s\+\%(VB\.\|{\%(\x\+-\)\+\x\+}\)\)]]
 
 -- See frm() for Visual Basic form file detection
 --- @type vim.filetype.mapfn
@@ -97,7 +97,7 @@ function M.bas(_, bufnr)
   local qb64_preproc = [[\c^\s*\%($\a\+\|option\s\+\%(_explicit\|_\=explicitarray\)\>\)]]
 
   for _, line in ipairs(getlines(bufnr, 1, 100)) do
-    if findany(line:lower(), visual_basic_content) then
+    if matchregex(line, visual_basic_content) then
       return 'vb'
     elseif
       line:find(fb_comment)
@@ -193,12 +193,12 @@ function M.cls(_, bufnr)
   if vim.g.filetype_cls then
     return vim.g.filetype_cls
   end
-  local line = getline(bufnr, 1)
-  if line:find('^[%%\\]') then
+  local line1 = getline(bufnr, 1)
+  if line1:find('^[%%\\]') then
     return 'tex'
-  elseif line:find('^#') and line:lower():find('rexx') then
+  elseif line1:find('^#') and line1:lower():find('rexx') then
     return 'rexx'
-  elseif line == 'VERSION 1.0 CLASS' then
+  elseif line1 == 'VERSION 1.0 CLASS' then
     return 'vb'
   end
   return 'st'
@@ -525,12 +525,15 @@ function M.frm(_, bufnr)
   if vim.g.filetype_frm then
     return vim.g.filetype_frm
   end
-  local lines = table.concat(getlines(bufnr, 1, 5)):lower()
-  if findany(lines, visual_basic_content) then
+  if getline(bufnr, 1) == 'VERSION 5.00' then
     return 'vb'
-  else
-    return 'form'
   end
+  for _, line in ipairs(getlines(bufnr, 1, 5)) do
+    if matchregex(line, visual_basic_content) then
+      return 'vb'
+    end
+  end
+  return 'form'
 end
 
 --- @type vim.filetype.mapfn
@@ -1529,6 +1532,14 @@ function M.v(_, bufnr)
   return 'v'
 end
 
+--- @type vim.filetype.mapfn
+function M.vba(_, bufnr)
+  if getline(bufnr, 1):find('^["#] Vimball Archiver') then
+    return 'vim'
+  end
+  return 'vb'
+end
+
 -- WEB (*.web is also used for Winbatch: Guess, based on expecting "%" comment
 -- lines in a WEB file).
 --- @type vim.filetype.mapfn
-- 
cgit 


From 5d49542b561e7f4826e28f7a0aeca94d47b3e0b7 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 31 Aug 2023 08:20:00 +0800
Subject: vim-patch:9.0.1820: Rexx files may not be recognised (#24956)

Problem:  Rexx files may not be recognised
Solution: Add shebang detection and improve disambiguation of *.cls
	  files

closes: vim/vim#12951

https://github.com/vim/vim/commit/e06afb7860805537ccd69966bc03169852c9b378

Co-authored-by: Doug Kearns <dougkearns@gmail.com>
---
 runtime/lua/vim/filetype/detect.lua | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index 0609ac5513..934b02dcdd 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -194,13 +194,18 @@ function M.cls(_, bufnr)
     return vim.g.filetype_cls
   end
   local line1 = getline(bufnr, 1)
-  if line1:find('^[%%\\]') then
-    return 'tex'
-  elseif line1:find('^#') and line1:lower():find('rexx') then
+  if matchregex(line1, [[^#!.*\<\%(rexx\|regina\)\>]]) then
     return 'rexx'
   elseif line1 == 'VERSION 1.0 CLASS' then
     return 'vb'
   end
+
+  local nonblank1 = nextnonblank(bufnr, 1)
+  if nonblank1 and nonblank1:find('^[%%\\]') then
+    return 'tex'
+  elseif nonblank1 and findany(nonblank1, { '^%s*/%*', '^%s*::%w' }) then
+    return 'rexx'
+  end
   return 'st'
 end
 
@@ -1648,6 +1653,7 @@ local patterns_hashbang = {
   guile = 'scheme',
   ['nix%-shell'] = 'nix',
   ['crystal\\>'] = { 'crystal', { vim_regex = true } },
+  ['^\\%(rexx\\|regina\\)\\>'] = { 'rexx', { vim_regex = true } },
 }
 
 ---@private
-- 
cgit 


From c235959fd909d75248c066a781475e207606c5aa Mon Sep 17 00:00:00 2001
From: Chris AtLee <chris.atlee@shopify.com>
Date: Thu, 31 Aug 2023 04:00:24 -0400
Subject: fix(lsp): only disable inlay hints / diagnostics if no other clients
 are connected (#24535)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

This fixes the issue where the LspNotify handlers for inlay_hint /
diagnostics would end up refreshing all attached clients.

The handler would call util._refresh, which called
vim.lsp.buf_request, which calls the method on all attached clients.

Now util._refresh takes an optional client_id parameter, which is used
to specify a specific client to update.

This commit also fixes util._refresh's handling of the `only_visible`
flag. Previously if `only_visible` was false, two requests would be made
to the server: one for the visible region, and one for the entire file.

Co-authored-by: Stanislav Asunkin <1353637+stasjok@users.noreply.github.com>
Co-authored-by: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
---
 runtime/lua/vim/lsp.lua            |  2 +-
 runtime/lua/vim/lsp/diagnostic.lua | 26 ++++++++++++++++---
 runtime/lua/vim/lsp/inlay_hint.lua | 30 ++++++++++++++++-----
 runtime/lua/vim/lsp/util.lua       | 53 +++++++++++++++++++++++++-------------
 4 files changed, 82 insertions(+), 29 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 2a16bafbfc..1990c09561 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -2118,7 +2118,7 @@ api.nvim_create_autocmd('VimLeavePre', {
 ---@param bufnr (integer) Buffer handle, or 0 for current.
 ---@param method (string) LSP method name
 ---@param params table|nil Parameters to send to the server
----@param handler lsp-handler See |lsp-handler|
+---@param handler? lsp-handler See |lsp-handler|
 ---       If nil, follows resolution strategy defined in |lsp-handler-configuration|
 ---
 ---@return table<integer, integer> client_request_ids Map of client-id:request-id pairs
diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index a0568bc09c..2a77992c4d 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -408,6 +408,16 @@ local function disable(bufnr)
   clear(bufnr)
 end
 
+--- Refresh diagnostics, only if we have attached clients that support it
+---@param bufnr (integer) buffer number
+---@param opts? table Additional options to pass to util._refresh
+---@private
+local function _refresh(bufnr, opts)
+  opts = opts or {}
+  opts['bufnr'] = bufnr
+  util._refresh(ms.textDocument_diagnostic, opts)
+end
+
 --- Enable pull diagnostics for a buffer
 ---@param bufnr (integer) Buffer handle, or 0 for current
 ---@private
@@ -429,7 +439,7 @@ function M._enable(bufnr)
           return
         end
         if bufstates[bufnr] and bufstates[bufnr].enabled then
-          util._refresh(ms.textDocument_diagnostic, { bufnr = bufnr, only_visible = true })
+          _refresh(bufnr, { only_visible = true, client_id = opts.data.client_id })
         end
       end,
       group = augroup,
@@ -438,7 +448,7 @@ function M._enable(bufnr)
     api.nvim_buf_attach(bufnr, false, {
       on_reload = function()
         if bufstates[bufnr] and bufstates[bufnr].enabled then
-          util._refresh(ms.textDocument_diagnostic, { bufnr = bufnr })
+          _refresh(bufnr)
         end
       end,
       on_detach = function()
@@ -448,8 +458,16 @@ function M._enable(bufnr)
 
     api.nvim_create_autocmd('LspDetach', {
       buffer = bufnr,
-      callback = function()
-        disable(bufnr)
+      callback = function(args)
+        local clients = vim.lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_diagnostic })
+
+        if
+          not vim.iter(clients):any(function(c)
+            return c.id ~= args.data.client_id
+          end)
+        then
+          disable(bufnr)
+        end
       end,
       group = augroup,
     })
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 8407105d47..7b58188c53 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -131,6 +131,16 @@ local function disable(bufnr)
   end
 end
 
+--- Refresh inlay hints, only if we have attached clients that support it
+---@param bufnr (integer) Buffer handle, or 0 for current
+---@param opts? table Additional options to pass to util._refresh
+---@private
+local function _refresh(bufnr, opts)
+  opts = opts or {}
+  opts['bufnr'] = bufnr
+  util._refresh(ms.textDocument_inlayHint, opts)
+end
+
 --- Enable inlay hints for a buffer
 ---@param bufnr (integer) Buffer handle, or 0 for current
 local function enable(bufnr)
@@ -150,18 +160,18 @@ local function enable(bufnr)
           return
         end
         if bufstates[bufnr] and bufstates[bufnr].enabled then
-          util._refresh(ms.textDocument_inlayHint, { bufnr = bufnr })
+          _refresh(bufnr, { client_id = opts.data.client_id })
         end
       end,
       group = augroup,
     })
-    util._refresh(ms.textDocument_inlayHint, { bufnr = bufnr })
+    _refresh(bufnr)
     api.nvim_buf_attach(bufnr, false, {
       on_reload = function(_, cb_bufnr)
         clear(cb_bufnr)
         if bufstates[cb_bufnr] and bufstates[cb_bufnr].enabled then
           bufstates[cb_bufnr].applied = {}
-          util._refresh(ms.textDocument_inlayHint, { bufnr = cb_bufnr })
+          _refresh(cb_bufnr)
         end
       end,
       on_detach = function(_, cb_bufnr)
@@ -170,14 +180,22 @@ local function enable(bufnr)
     })
     api.nvim_create_autocmd('LspDetach', {
       buffer = bufnr,
-      callback = function()
-        disable(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
-    util._refresh(ms.textDocument_inlayHint, { bufnr = bufnr })
+    _refresh(bufnr)
   end
 end
 
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 633cddca2d..2e376f9093 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -2122,6 +2122,7 @@ end
 function M.make_workspace_params(added, removed)
   return { event = { added = added, removed = removed } }
 end
+
 --- Returns indentation size.
 ---
 ---@see 'shiftwidth'
@@ -2192,32 +2193,46 @@ end
 ---@private
 --- Request updated LSP information for a buffer.
 ---
+---@class lsp.util.RefreshOptions
+---@field bufnr integer? Buffer to refresh (default: 0)
+---@field only_visible? boolean Whether to only refresh for the visible regions of the buffer (default: false)
+---@field client_id? integer Client ID to refresh (default: all clients)
+--
 ---@param method string LSP method to call
----@param opts (nil|table) Optional arguments
----  - bufnr (integer, default: 0): Buffer to refresh
----  - only_visible (boolean, default: false): Whether to only refresh for the visible regions of the buffer
+---@param opts? lsp.util.RefreshOptions Options table
 function M._refresh(method, opts)
   opts = opts or {}
   local bufnr = opts.bufnr
   if bufnr == nil or bufnr == 0 then
     bufnr = api.nvim_get_current_buf()
   end
+
+  local clients = vim.lsp.get_clients({ bufnr = bufnr, method = method, id = opts.client_id })
+
+  if #clients == 0 then
+    return
+  end
+
   local only_visible = opts.only_visible or false
-  for _, window in ipairs(api.nvim_list_wins()) do
-    if api.nvim_win_get_buf(window) == bufnr then
-      local first = vim.fn.line('w0', window)
-      local last = vim.fn.line('w$', window)
-      local params = {
-        textDocument = M.make_text_document_params(bufnr),
-        range = {
-          start = { line = first - 1, character = 0 },
-          ['end'] = { line = last, character = 0 },
-        },
-      }
-      vim.lsp.buf_request(bufnr, method, params)
+
+  if only_visible then
+    for _, window in ipairs(api.nvim_list_wins()) do
+      if api.nvim_win_get_buf(window) == bufnr then
+        local first = vim.fn.line('w0', window)
+        local last = vim.fn.line('w$', window)
+        local params = {
+          textDocument = M.make_text_document_params(bufnr),
+          range = {
+            start = { line = first - 1, character = 0 },
+            ['end'] = { line = last, character = 0 },
+          },
+        }
+        for _, client in ipairs(clients) do
+          client.request(method, params, nil, bufnr)
+        end
+      end
     end
-  end
-  if not only_visible then
+  else
     local params = {
       textDocument = M.make_text_document_params(bufnr),
       range = {
@@ -2225,7 +2240,9 @@ function M._refresh(method, opts)
         ['end'] = { line = api.nvim_buf_line_count(bufnr), character = 0 },
       },
     }
-    vim.lsp.buf_request(bufnr, method, params)
+    for _, client in ipairs(clients) do
+      client.request(method, params, nil, bufnr)
+    end
   end
 end
 
-- 
cgit 


From 0e7e25af20cf98a19f4f50ee80774fce07cef12e Mon Sep 17 00:00:00 2001
From: Jongwook Choi <wookayin@gmail.com>
Date: Thu, 31 Aug 2023 04:14:20 -0400
Subject: refactor(lsp): add type annotation for lsp.Client.server_capabilities
 (#24925)

The class `lsp.Client` has a public member `server_capabilities`,
which is assumed to be non-nil once initialized, as documented in
`:help vim.lsp.client`. Due to the possibility that it may be nil
before initialization, `lsp.Client` was not having a proper lua type
annotations on the field `server_capabilities`.

Instead of having a nil `server_capabilities` until initialized in
the RPC response callback, we can have an initial value of empty table.
This CHANGES the behavior of the `server_capabilities` field in a way
that it is no longer `nil` until initialization. Note that, as
already documented, `server_capabilities` should never be nil when
it is once initialized and thus ready to be used in user configs.
---
 runtime/lua/vim/lsp.lua | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 1990c09561..b0caf5af35 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -397,8 +397,7 @@ do
   ---@return CTGroup
   local function get_group(client)
     local allow_inc_sync = if_nil(client.config.flags.allow_incremental_sync, true)
-    local change_capability =
-      vim.tbl_get(client.server_capabilities or {}, 'textDocumentSync', 'change')
+    local change_capability = vim.tbl_get(client.server_capabilities, 'textDocumentSync', 'change')
     local sync_kind = change_capability or protocol.TextDocumentSyncKind.None
     if not allow_inc_sync and change_capability == protocol.TextDocumentSyncKind.Incremental then
       sync_kind = protocol.TextDocumentSyncKind.Full
@@ -1312,6 +1311,9 @@ function lsp.start_client(config)
     --- - lsp.WorkDoneProgressEnd    (extended with title from Begin)
     progress = vim.ringbuf(50),
 
+    --- @type lsp.ServerCapabilities
+    server_capabilities = {},
+
     ---@deprecated use client.progress instead
     messages = { name = name, messages = {}, progress = {}, status = {} },
     dynamic_capabilities = require('vim.lsp._dynamic').new(client_id),
@@ -1401,7 +1403,7 @@ function lsp.start_client(config)
       if not required_capability then
         return true
       end
-      if vim.tbl_get(client.server_capabilities or {}, unpack(required_capability)) then
+      if vim.tbl_get(client.server_capabilities, unpack(required_capability)) then
         return true
       else
         if client.dynamic_capabilities:supports_registration(method) then
-- 
cgit 


From 597355deae2ebddcb8b930da9a8b45a65d05d09b Mon Sep 17 00:00:00 2001
From: TheBlob42 <hessenmobbel@web.de>
Date: Fri, 1 Sep 2023 13:31:05 +0200
Subject: fix(lsp): wrong iterator in registerCapability handler (#24971)

---
 runtime/lua/vim/lsp/handlers.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 6fe4b7f939..a6b70ac911 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -112,7 +112,7 @@ M[ms.client_registerCapability] = function(_, result, ctx)
   local client = vim.lsp.get_client_by_id(client_id)
 
   client.dynamic_capabilities:register(result.registrations)
-  for bufnr, _ in ipairs(client.attached_buffers) do
+  for bufnr, _ in pairs(client.attached_buffers) do
     vim.lsp._set_defaults(client, bufnr)
   end
 
-- 
cgit 


From c431d820e7be1c511d3d16e89cdffaa21b7909fa Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 4 Sep 2023 08:49:50 +0800
Subject: vim-patch:9.0.1856: issues with formatting positional arguments
 (#25013)

Problem:  issues with formatting positional arguments
Solution: fix them, add tests and documentation

closes: vim/vim#12140
closes: vim/vim#12985

Tentatively fix message_test. Check NULL ptr.

https://github.com/vim/vim/commit/aa90d4f031f73a34aaef5746931ea746849a2231

Co-authored-by: Christ van Willegen <cvwillegen@gmail.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 3f891bdb45..6209ce0c73 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -6115,8 +6115,13 @@ function vim.fn.prevnonblank(lnum) end
 ---   than the field width, the field is expanded to contain
 ---   the conversion result.
 ---   The 'h' modifier indicates the argument is 16 bits.
----   The 'l' modifier indicates the argument is 32 bits.
----   The 'L' modifier indicates the argument is 64 bits.
+---   The 'l' modifier indicates the argument is a long
+---   integer.  The size will be 32 bits or 64 bits
+---   depending on your platform.
+---   The "ll" modifier indicates the argument is 64 bits.
+---   The b and B conversion specifiers never take a width
+---   modifier and always assume their argument is a 64 bit
+---   integer.
 ---   Generally, these modifiers are not useful. They are
 ---   ignored when type is known from the argument.
 ---
-- 
cgit 


From 54d357dce0e13408b819a1fe98b6417fad2cdd4c Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Mon, 4 Sep 2023 22:42:47 +0200
Subject: build: bump lpeg to 1.1.0 (#25016)

Release notes indicates it has better UTF8 handling which is relevant
for us.
---
 runtime/lua/vim/re.lua | 34 ++++++++++++++++++----------------
 1 file changed, 18 insertions(+), 16 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/re.lua b/runtime/lua/vim/re.lua
index dffe37186a..007eb27ed8 100644
--- a/runtime/lua/vim/re.lua
+++ b/runtime/lua/vim/re.lua
@@ -1,6 +1,8 @@
--- $Id: re.lua $
--- vendored from lpeg-1.0.2
--- Copyright © 2007-2019 Lua.org, PUC-Rio.
+--
+-- Copyright 2007-2023, Lua.org & PUC-Rio  (see 'lpeg.html' for license)
+-- written by Roberto Ierusalimschy
+--
+--- vendored from lpeg-1.1.0
 
 -- imported functions and modules
 local tonumber, type, print, error = tonumber, type, print, error
@@ -12,14 +14,14 @@ local m = require"lpeg"
 -- on 'mm'
 local mm = m
 
--- pattern's metatable
+-- patterns' metatable
 local mt = getmetatable(mm.P(0))
 
 
+local version = _VERSION
 
 -- No more global accesses after this point
-local version = _VERSION
-if version == "Lua 5.2" then _ENV = nil end
+_ENV = nil     -- does no harm in Lua 5.1
 
 
 local any = m.P(1)
@@ -144,7 +146,7 @@ local item = (defined + Range + m.C(any)) / m.P
 local Class =
     "["
   * (m.C(m.P"^"^-1))    -- optional complement symbol
-  * m.Cf(item * (item - "]")^0, mt.__add) /
+  * (item * ((item % mt.__add) - "]")^0) /
                           function (c, p) return c == "^" and any - p or p end
   * "]"
 
@@ -170,13 +172,13 @@ end
 
 local exp = m.P{ "Exp",
   Exp = S * ( m.V"Grammar"
-            + m.Cf(m.V"Seq" * ("/" * S * m.V"Seq")^0, mt.__add) );
-  Seq = m.Cf(m.Cc(m.P"") * m.V"Prefix"^0 , mt.__mul)
+            + m.V"Seq" * ("/" * S * m.V"Seq" % mt.__add)^0 );
+  Seq = (m.Cc(m.P"") * (m.V"Prefix" % mt.__mul)^0)
         * (#seq_follow + patt_error);
   Prefix = "&" * S * m.V"Prefix" / mt.__len
          + "!" * S * m.V"Prefix" / mt.__unm
          + m.V"Suffix";
-  Suffix = m.Cf(m.V"Primary" * S *
+  Suffix = m.V"Primary" * S *
           ( ( m.P"+" * m.Cc(1, mt.__pow)
             + m.P"*" * m.Cc(0, mt.__pow)
             + m.P"?" * m.Cc(-1, mt.__pow)
@@ -187,10 +189,11 @@ local exp = m.P{ "Exp",
                          + m.P"{}" * m.Cc(nil, m.Ct)
                          + defwithfunc(mt.__div)
                          )
-            + "=>" * S * defwithfunc(m.Cmt)
-            + "~>" * S * defwithfunc(m.Cf)
-            ) * S
-          )^0, function (a,b,f) return f(a,b) end );
+            + "=>" * S * defwithfunc(mm.Cmt)
+            + ">>" * S * defwithfunc(mt.__mod)
+            + "~>" * S * defwithfunc(mm.Cf)
+            ) % function (a,b,f) return f(a,b) end * S
+          )^0;
   Primary = "(" * m.V"Exp" * ")"
             + String / mm.P
             + Class
@@ -206,8 +209,7 @@ local exp = m.P{ "Exp",
             + (name * -arrow + "<" * name * ">") * m.Cb("G") / NT;
   Definition = name * arrow * m.V"Exp";
   Grammar = m.Cg(m.Cc(true), "G") *
-            m.Cf(m.V"Definition" / firstdef * m.Cg(m.V"Definition")^0,
-              adddef) / mm.P
+            ((m.V"Definition" / firstdef) * (m.V"Definition" % adddef)^0) / mm.P
 }
 
 local pattern = S * m.Cg(m.Cc(false), "G") * exp / mm.P * (-any + patt_error)
-- 
cgit 


From a44521f46e6f79171d034e5cce1a4dc266d23e49 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sun, 3 Sep 2023 10:17:24 +0100
Subject: fix(vim.system): let on_exit handle cleanup after kill

Fixes #25000
---
 runtime/lua/vim/_system.lua | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_system.lua b/runtime/lua/vim/_system.lua
index 6f5e95eb24..ba3fc34e78 100644
--- a/runtime/lua/vim/_system.lua
+++ b/runtime/lua/vim/_system.lua
@@ -18,6 +18,7 @@ local uv = vim.uv
 --- @field stderr? string
 
 --- @class SystemState
+--- @field cmd string[]
 --- @field handle? uv.uv_process_t
 --- @field timer?  uv.uv_timer_t
 --- @field pid? integer
@@ -63,11 +64,9 @@ local function new_systemobj(state)
   }, { __index = SystemObj })
 end
 
---- @param signal integer
+--- @param signal integer|string
 function SystemObj:kill(signal)
-  local state = self._state
-  state.handle:kill(signal)
-  close_handles(state)
+  self._state.handle:kill(signal)
 end
 
 local MAX_TIMEOUT = 2 ^ 31
@@ -159,7 +158,7 @@ end
 
 --- @return table<string,string>
 local function base_env()
-  local env = vim.fn.environ()
+  local env = vim.fn.environ() --- @type table<string,string>
   env['NVIM'] = vim.v.servername
   env['NVIM_LISTEN_ADDRESS'] = nil
   return env
@@ -212,7 +211,7 @@ end
 local M = {}
 
 --- @param cmd string
---- @param opts uv.aliases.spawn_options
+--- @param opts uv.spawn.options
 --- @param on_exit fun(code: integer, signal: integer)
 --- @param on_error fun()
 --- @return uv.uv_process_t, integer
-- 
cgit 


From 6d5f12efd286c684de8608c07bb0f76a9d594b5b Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 4 Sep 2023 11:30:16 +0100
Subject: fix(vim.system): make timeout work properly

Mimic the behaviour of timeout(1) from coreutils.
---
 runtime/lua/vim/_editor.lua |   8 ++--
 runtime/lua/vim/_system.lua | 102 +++++++++++++++++++++++++++-----------------
 2 files changed, 69 insertions(+), 41 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 96ac379368..ba0345cdd5 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -107,7 +107,8 @@ vim.log = {
 ---     Handle output from stdout. When passed as a function must have the signature `fun(err: string, data: string)`.
 ---     Defaults to `true`.
 ---   - text: (boolean) Handle stdout and stderr as text. Replaces `\r\n` with `\n`.
----   - timeout: (integer)
+---   - timeout: (integer) Run the command with a time limit. Upon timeout the process is sent the
+---     TERM signal (15) and the exit code is set to 124.
 ---   - detach: (boolean) If true, spawn the child process in a detached state - this will make it
 ---     a process group leader, and will effectively enable the child to keep running after the
 ---     parent exits. Note that the child process will still keep the parent's event loop alive
@@ -118,13 +119,14 @@ vim.log = {
 ---
 --- @return SystemObj Object with the fields:
 ---   - pid (integer) Process ID
----   - wait (fun(timeout: integer|nil): SystemCompleted)
+---   - wait (fun(timeout: integer|nil): SystemCompleted) Wait for the process to complete. Upon
+---     timeout the process is sent the KILL signal (9) and the exit code is set to 124.
 ---     - SystemCompleted is an object with the fields:
 ---      - code: (integer)
 ---      - signal: (integer)
 ---      - stdout: (string), nil if stdout argument is passed
 ---      - stderr: (string), nil if stderr argument is passed
----   - kill (fun(signal: integer))
+---   - kill (fun(signal: integer|string))
 ---   - write (fun(data: string|nil)) Requires `stdin=true`. Pass `nil` to close the stream.
 ---   - is_closing (fun(): boolean)
 function vim.system(cmd, opts, on_exit)
diff --git a/runtime/lua/vim/_system.lua b/runtime/lua/vim/_system.lua
index ba3fc34e78..7bd7ff91f9 100644
--- a/runtime/lua/vim/_system.lua
+++ b/runtime/lua/vim/_system.lua
@@ -2,8 +2,8 @@ local uv = vim.uv
 
 --- @class SystemOpts
 --- @field stdin? string|string[]|true
---- @field stdout? fun(err:string, data: string)|false
---- @field stderr? fun(err:string, data: string)|false
+--- @field stdout? fun(err:string?, data: string?)|false
+--- @field stderr? fun(err:string?, data: string?)|false
 --- @field cwd? string
 --- @field env? table<string,string|number>
 --- @field clear_env? boolean
@@ -18,39 +18,46 @@ local uv = vim.uv
 --- @field stderr? string
 
 --- @class SystemState
---- @field cmd string[]
 --- @field handle? uv.uv_process_t
 --- @field timer?  uv.uv_timer_t
 --- @field pid? integer
 --- @field timeout? integer
---- @field done? boolean
+--- @field done? boolean|'timeout'
 --- @field stdin? uv.uv_stream_t
 --- @field stdout? uv.uv_stream_t
 --- @field stderr? uv.uv_stream_t
 --- @field result? SystemCompleted
 
----@param state SystemState
-local function close_handles(state)
-  for _, handle in pairs({ state.handle, state.stdin, state.stdout, state.stderr }) do
-    if not handle:is_closing() then
-      handle:close()
-    end
+--- @enum vim.SystemSig
+local SIG = {
+  HUP = 1, -- Hangup
+  INT = 2, -- Interrupt from keyboard
+  KILL = 9, -- Kill signal
+  TERM = 15, -- Termination signal
+  -- STOP = 17,19,23  -- Stop the process
+}
+
+---@param handle uv.uv_handle_t?
+local function close_handle(handle)
+  if handle and not handle:is_closing() then
+    handle:close()
   end
 end
 
---- @param cmd string[]
---- @return SystemCompleted
-local function timeout_result(cmd)
-  local cmd_str = table.concat(cmd, ' ')
-  local err = string.format("Command timed out: '%s'", cmd_str)
-  return { code = 0, signal = 2, stdout = '', stderr = err }
+---@param state SystemState
+local function close_handles(state)
+  close_handle(state.handle)
+  close_handle(state.stdin)
+  close_handle(state.stdout)
+  close_handle(state.stderr)
+  close_handle(state.timer)
 end
 
 --- @class SystemObj
 --- @field pid integer
 --- @field private _state SystemState
 --- @field wait fun(self: SystemObj, timeout?: integer): SystemCompleted
---- @field kill fun(self: SystemObj, signal: integer)
+--- @field kill fun(self: SystemObj, signal: integer|string)
 --- @field write fun(self: SystemObj, data?: string|string[])
 --- @field is_closing fun(self: SystemObj): boolean?
 local SystemObj = {}
@@ -69,6 +76,13 @@ function SystemObj:kill(signal)
   self._state.handle:kill(signal)
 end
 
+--- @package
+--- @param signal? vim.SystemSig
+function SystemObj:_timeout(signal)
+  self._state.done = 'timeout'
+  self:kill(signal or SIG.TERM)
+end
+
 local MAX_TIMEOUT = 2 ^ 31
 
 --- @param timeout? integer
@@ -76,13 +90,16 @@ local MAX_TIMEOUT = 2 ^ 31
 function SystemObj:wait(timeout)
   local state = self._state
 
-  vim.wait(timeout or state.timeout or MAX_TIMEOUT, function()
-    return state.done
+  local done = vim.wait(timeout or state.timeout or MAX_TIMEOUT, function()
+    return state.result ~= nil
   end)
 
-  if not state.done then
-    self:kill(6) -- 'sigint'
-    state.result = timeout_result(state.cmd)
+  if not done then
+    -- Send sigkill since this cannot be caught
+    self:_timeout(SIG.KILL)
+    vim.wait(timeout or state.timeout or MAX_TIMEOUT, function()
+      return state.result ~= nil
+    end)
   end
 
   return state.result
@@ -124,9 +141,9 @@ function SystemObj:is_closing()
   return handle == nil or handle:is_closing()
 end
 
----@param output function|'false'
+---@param output fun(err:string?, data: string?)|false
 ---@return uv.uv_stream_t?
----@return function? Handler
+---@return fun(err:string?, data: string?)? Handler
 local function setup_output(output)
   if output == nil then
     return assert(uv.new_pipe(false)), nil
@@ -224,6 +241,19 @@ local function spawn(cmd, opts, on_exit, on_error)
   return handle, pid_or_err --[[@as integer]]
 end
 
+---@param timeout integer
+---@param cb fun()
+---@return uv.uv_timer_t
+local function timer_oneshot(timeout, cb)
+  local timer = assert(uv.new_timer())
+  timer:start(timeout, 0, function()
+    timer:stop()
+    timer:close()
+    cb()
+  end)
+  return timer
+end
+
 --- Run a system command
 ---
 --- @param cmd string[]
@@ -267,10 +297,6 @@ function M.run(cmd, opts, on_exit)
     hide = true,
   }, function(code, signal)
     close_handles(state)
-    if state.timer then
-      state.timer:stop()
-      state.timer:close()
-    end
 
     local check = assert(uv.new_check())
 
@@ -283,7 +309,14 @@ function M.run(cmd, opts, on_exit)
       check:stop()
       check:close()
 
-      state.done = true
+      if state.done == nil then
+        state.done = true
+      end
+
+      if code == 0 and state.done == 'timeout' then
+        code = 124
+      end
+
       state.result = {
         code = code,
         signal = signal,
@@ -317,16 +350,9 @@ function M.run(cmd, opts, on_exit)
   end
 
   if opts.timeout then
-    state.timer = assert(uv.new_timer())
-    state.timer:start(opts.timeout, 0, function()
-      state.timer:stop()
-      state.timer:close()
+    state.timer = timer_oneshot(opts.timeout, function()
       if state.handle and state.handle:is_active() then
-        obj:kill(6) --- 'sigint'
-        state.result = timeout_result(state.cmd)
-        if on_exit then
-          on_exit(state.result)
-        end
+        obj:_timeout()
       end
     end)
   end
-- 
cgit 


From 80d1333b7317460c562a982ac21f900d9fbd89f6 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Mon, 4 Sep 2023 12:03:03 +0100
Subject: refactor(vim.system): factor out on_exit handling

---
 runtime/lua/vim/_editor.lua |   2 +-
 runtime/lua/vim/_system.lua | 121 +++++++++++++++++++++++---------------------
 runtime/lua/vim/lsp/rpc.lua |   4 +-
 runtime/lua/vim/ui.lua      |   2 +-
 4 files changed, 68 insertions(+), 61 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index ba0345cdd5..68992a16bb 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -117,7 +117,7 @@ vim.log = {
 --- @param on_exit (function|nil) Called when subprocess exits. When provided, the command runs
 ---   asynchronously. Receives SystemCompleted object, see return of SystemObj:wait().
 ---
---- @return SystemObj Object with the fields:
+--- @return vim.SystemObj Object with the fields:
 ---   - pid (integer) Process ID
 ---   - wait (fun(timeout: integer|nil): SystemCompleted) Wait for the process to complete. Upon
 ---     timeout the process is sent the KILL signal (9) and the exit code is set to 124.
diff --git a/runtime/lua/vim/_system.lua b/runtime/lua/vim/_system.lua
index 7bd7ff91f9..5ea0071215 100644
--- a/runtime/lua/vim/_system.lua
+++ b/runtime/lua/vim/_system.lua
@@ -11,13 +11,13 @@ local uv = vim.uv
 --- @field timeout? integer Timeout in ms
 --- @field detach? boolean
 
---- @class SystemCompleted
+--- @class vim.SystemCompleted
 --- @field code integer
 --- @field signal integer
 --- @field stdout? string
 --- @field stderr? string
 
---- @class SystemState
+--- @class vim.SystemState
 --- @field handle? uv.uv_process_t
 --- @field timer?  uv.uv_timer_t
 --- @field pid? integer
@@ -26,7 +26,9 @@ local uv = vim.uv
 --- @field stdin? uv.uv_stream_t
 --- @field stdout? uv.uv_stream_t
 --- @field stderr? uv.uv_stream_t
---- @field result? SystemCompleted
+--- @field stdout_data? string[]
+--- @field stderr_data? string[]
+--- @field result? vim.SystemCompleted
 
 --- @enum vim.SystemSig
 local SIG = {
@@ -44,7 +46,7 @@ local function close_handle(handle)
   end
 end
 
----@param state SystemState
+---@param state vim.SystemState
 local function close_handles(state)
   close_handle(state.handle)
   close_handle(state.stdin)
@@ -53,17 +55,17 @@ local function close_handles(state)
   close_handle(state.timer)
 end
 
---- @class SystemObj
+--- @class vim.SystemObj
 --- @field pid integer
---- @field private _state SystemState
---- @field wait fun(self: SystemObj, timeout?: integer): SystemCompleted
---- @field kill fun(self: SystemObj, signal: integer|string)
---- @field write fun(self: SystemObj, data?: string|string[])
---- @field is_closing fun(self: SystemObj): boolean?
+--- @field private _state vim.SystemState
+--- @field wait fun(self: vim.SystemObj, timeout?: integer): vim.SystemCompleted
+--- @field kill fun(self: vim.SystemObj, signal: integer|string)
+--- @field write fun(self: vim.SystemObj, data?: string|string[])
+--- @field is_closing fun(self: vim.SystemObj): boolean?
 local SystemObj = {}
 
---- @param state SystemState
---- @return SystemObj
+--- @param state vim.SystemState
+--- @return vim.SystemObj
 local function new_systemobj(state)
   return setmetatable({
     pid = state.pid,
@@ -86,7 +88,7 @@ end
 local MAX_TIMEOUT = 2 ^ 31
 
 --- @param timeout? integer
---- @return SystemCompleted
+--- @return vim.SystemCompleted
 function SystemObj:wait(timeout)
   local state = self._state
 
@@ -254,12 +256,53 @@ local function timer_oneshot(timeout, cb)
   return timer
 end
 
+--- @param state vim.SystemState
+--- @param code integer
+--- @param signal integer
+--- @param on_exit fun(result: vim.SystemCompleted)?
+local function _on_exit(state, code, signal, on_exit)
+  close_handles(state)
+
+  local check = assert(uv.new_check())
+  check:start(function()
+    for _, pipe in pairs({ state.stdin, state.stdout, state.stderr }) do
+      if not pipe:is_closing() then
+        return
+      end
+    end
+    check:stop()
+    check:close()
+
+    if state.done == nil then
+      state.done = true
+    end
+
+    if code == 0 and state.done == 'timeout' then
+      code = 124
+    end
+
+    local stdout_data = state.stdout_data
+    local stderr_data = state.stderr_data
+
+    state.result = {
+      code = code,
+      signal = signal,
+      stdout = stdout_data and table.concat(stdout_data) or nil,
+      stderr = stderr_data and table.concat(stderr_data) or nil,
+    }
+
+    if on_exit then
+      on_exit(state.result)
+    end
+  end)
+end
+
 --- Run a system command
 ---
 --- @param cmd string[]
 --- @param opts? SystemOpts
---- @param on_exit? fun(out: SystemCompleted)
---- @return SystemObj
+--- @param on_exit? fun(out: vim.SystemCompleted)
+--- @return vim.SystemObj
 function M.run(cmd, opts, on_exit)
   vim.validate({
     cmd = { cmd, 'table' },
@@ -273,7 +316,7 @@ function M.run(cmd, opts, on_exit)
   local stderr, stderr_handler = setup_output(opts.stderr)
   local stdin, towrite = setup_input(opts.stdin)
 
-  --- @type SystemState
+  --- @type vim.SystemState
   local state = {
     done = false,
     cmd = cmd,
@@ -283,11 +326,6 @@ function M.run(cmd, opts, on_exit)
     stderr = stderr,
   }
 
-  -- Define data buckets as tables and concatenate the elements at the end as
-  -- one operation.
-  --- @type string[], string[]
-  local stdout_data, stderr_data
-
   state.handle, state.pid = spawn(cmd[1], {
     args = vim.list_slice(cmd, 2),
     stdio = { stdin, stdout, stderr },
@@ -296,50 +334,19 @@ function M.run(cmd, opts, on_exit)
     detached = opts.detach,
     hide = true,
   }, function(code, signal)
-    close_handles(state)
-
-    local check = assert(uv.new_check())
-
-    check:start(function()
-      for _, pipe in pairs({ state.stdin, state.stdout, state.stderr }) do
-        if not pipe:is_closing() then
-          return
-        end
-      end
-      check:stop()
-      check:close()
-
-      if state.done == nil then
-        state.done = true
-      end
-
-      if code == 0 and state.done == 'timeout' then
-        code = 124
-      end
-
-      state.result = {
-        code = code,
-        signal = signal,
-        stdout = stdout_data and table.concat(stdout_data) or nil,
-        stderr = stderr_data and table.concat(stderr_data) or nil,
-      }
-
-      if on_exit then
-        on_exit(state.result)
-      end
-    end)
+    _on_exit(state, code, signal, on_exit)
   end, function()
     close_handles(state)
   end)
 
   if stdout then
-    stdout_data = {}
-    stdout:read_start(stdout_handler or default_handler(stdout, opts.text, stdout_data))
+    state.stdout_data = {}
+    stdout:read_start(stdout_handler or default_handler(stdout, opts.text, state.stdout_data))
   end
 
   if stderr then
-    stderr_data = {}
-    stderr:read_start(stderr_handler or default_handler(stderr, opts.text, stderr_data))
+    state.stderr_data = {}
+    stderr:read_start(stderr_handler or default_handler(stderr, opts.text, state.stderr_data))
   end
 
   local obj = new_systemobj(state)
diff --git a/runtime/lua/vim/lsp/rpc.lua b/runtime/lua/vim/lsp/rpc.lua
index a77af937b3..6ab5708721 100644
--- a/runtime/lua/vim/lsp/rpc.lua
+++ b/runtime/lua/vim/lsp/rpc.lua
@@ -648,7 +648,7 @@ function M.start(cmd, cmd_args, dispatchers, extra_spawn_params)
 
   dispatchers = merge_dispatchers(dispatchers)
 
-  local sysobj ---@type SystemObj
+  local sysobj ---@type vim.SystemObj
 
   local client = new_client(dispatchers, {
     write = function(msg)
@@ -708,7 +708,7 @@ function M.start(cmd, cmd_args, dispatchers, extra_spawn_params)
     return
   end
 
-  sysobj = sysobj_or_err --[[@as SystemObj]]
+  sysobj = sysobj_or_err --[[@as vim.SystemObj]]
 
   return public_client(client)
 end
diff --git a/runtime/lua/vim/ui.lua b/runtime/lua/vim/ui.lua
index 87b52787a0..cd90886489 100644
--- a/runtime/lua/vim/ui.lua
+++ b/runtime/lua/vim/ui.lua
@@ -118,7 +118,7 @@ end
 ---
 ---@param path string Path or URL to open
 ---
----@return SystemCompleted|nil # Command result, or nil if not found.
+---@return vim.SystemCompleted|nil # Command result, or nil if not found.
 ---@return string|nil # Error message on failure
 ---
 ---@see |vim.system()|
-- 
cgit 


From be8b15200d7093726b0999ccfd4a3e9952656d47 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 5 Sep 2023 14:38:57 +0100
Subject: fix: windows timeouts have exit code 1

---
 runtime/lua/vim/_system.lua | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_system.lua b/runtime/lua/vim/_system.lua
index 5ea0071215..9279febddf 100644
--- a/runtime/lua/vim/_system.lua
+++ b/runtime/lua/vim/_system.lua
@@ -277,7 +277,9 @@ local function _on_exit(state, code, signal, on_exit)
       state.done = true
     end
 
-    if code == 0 and state.done == 'timeout' then
+    if (code == 0 or code == 1) and state.done == 'timeout' then
+      -- Unix: code == 0
+      -- Windows: code == 1
       code = 124
     end
 
@@ -326,10 +328,12 @@ function M.run(cmd, opts, on_exit)
     stderr = stderr,
   }
 
+  --- @diagnostic disable-next-line:missing-fields
   state.handle, state.pid = spawn(cmd[1], {
     args = vim.list_slice(cmd, 2),
     stdio = { stdin, stdout, stderr },
     cwd = opts.cwd,
+    --- @diagnostic disable-next-line:assign-type-mismatch
     env = setup_env(opts.env, opts.clear_env),
     detached = opts.detach,
     hide = true,
-- 
cgit 


From d27214331815324ea5762b5aa22996b9019085c6 Mon Sep 17 00:00:00 2001
From: Evgeni Chasnovski <evgeni.chasnovski@gmail.com>
Date: Wed, 6 Sep 2023 20:54:18 +0300
Subject: fix(diagnostic): always return copies of diagnostic items (#25010)

---
 runtime/lua/vim/diagnostic.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index 96d1cb7629..a1f3020c88 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -386,6 +386,7 @@ local function get_diagnostics(bufnr, opts, clamp)
 
   local function add(b, d)
     if not opts.lnum or d.lnum == opts.lnum then
+      d = vim.deepcopy(d)
       if clamp and api.nvim_buf_is_loaded(b) then
         local line_count = buf_line_count[b] - 1
         if
@@ -396,7 +397,6 @@ local function get_diagnostics(bufnr, opts, clamp)
           or d.col < 0
           or d.end_col < 0
         then
-          d = vim.deepcopy(d)
           d.lnum = math.max(math.min(d.lnum, line_count), 0)
           d.end_lnum = math.max(math.min(d.end_lnum, line_count), 0)
           d.col = math.max(d.col, 0)
@@ -750,6 +750,8 @@ end
 
 --- Get current diagnostics.
 ---
+--- Modifying diagnostics in the returned table has no effect. To set diagnostics in a buffer, use |vim.diagnostic.set()|.
+---
 ---@param bufnr integer|nil Buffer number to get diagnostics from. Use 0 for
 ---                        current buffer or nil for all buffers.
 ---@param opts table|nil A table with the following keys:
-- 
cgit 


From 131a1ee82d15ce9d1356a46117c9a1651947d4b8 Mon Sep 17 00:00:00 2001
From: Tom Praschan <13141438+tom-anders@users.noreply.github.com>
Date: Thu, 7 Sep 2023 10:12:02 +0200
Subject: feat(lsp): add original LSP Location as item's user_data in
 locations_to_items (#23743)

---
 runtime/lua/vim/lsp/util.lua | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 2e376f9093..a6d17afa1b 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1812,6 +1812,9 @@ end)
 --- Returns the items with the byte position calculated correctly and in sorted
 --- order, for display in quickfix and location lists.
 ---
+--- The `user_data` field of each resulting item will contain the original
+--- `Location` or `LocationLink` it was computed from.
+---
 --- The result can be passed to the {list} argument of |setqflist()| or
 --- |setloclist()|.
 ---
@@ -1840,7 +1843,7 @@ function M.locations_to_items(locations, offset_encoding)
     -- locations may be Location or LocationLink
     local uri = d.uri or d.targetUri
     local range = d.range or d.targetSelectionRange
-    table.insert(grouped[uri], { start = range.start })
+    table.insert(grouped[uri], { start = range.start, location = d })
   end
 
   local keys = vim.tbl_keys(grouped)
@@ -1872,6 +1875,7 @@ function M.locations_to_items(locations, offset_encoding)
         lnum = row + 1,
         col = col + 1,
         text = line,
+        user_data = temp.location,
       })
     end
   end
-- 
cgit 


From d0d4160dd13fad952338b8582e2db8838172bbf1 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Fri, 8 Sep 2023 21:05:35 +0800
Subject: feat(runtime): highlight hl groups in syntax.txt (#25050)

- Add runtime/lua/vim/vimhelp.lua, which is a translation of Vim's
  runtime/import/dist/vimhelp.vim.
- Unlike Vim, run the highlighting from an ftplugin file instead of a
  syntax file, so that it is run even if using treesitter.
---
 runtime/lua/vim/vimhelp.lua | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 runtime/lua/vim/vimhelp.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/vimhelp.lua b/runtime/lua/vim/vimhelp.lua
new file mode 100644
index 0000000000..a4d6a50b12
--- /dev/null
+++ b/runtime/lua/vim/vimhelp.lua
@@ -0,0 +1,31 @@
+-- Extra functionality for displaying Vim help.
+
+local M = {}
+
+-- Called when editing the doc/syntax.txt file
+function M.highlight_groups()
+  local save_cursor = vim.fn.getcurpos()
+
+  local start_lnum = vim.fn.search([[\*highlight-groups\*]], 'c')
+  if start_lnum == 0 then
+    return
+  end
+  local end_lnum = vim.fn.search('^======')
+  if end_lnum == 0 then
+    return
+  end
+
+  local ns = vim.api.nvim_create_namespace('vimhelp')
+  vim.api.nvim_buf_clear_namespace(0, ns, 0, -1)
+
+  for lnum = start_lnum, end_lnum do
+    local word = vim.api.nvim_buf_get_lines(0, lnum - 1, lnum, true)[1]:match('^(%w+)\t')
+    if vim.fn.hlexists(word) ~= 0 then
+      vim.api.nvim_buf_set_extmark(0, ns, lnum - 1, 0, { end_col = #word, hl_group = word })
+    end
+  end
+
+  vim.fn.setpos('.', save_cursor)
+end
+
+return M
-- 
cgit 


From 8afb3a49c0762eb60368aee0314e6de261daa6ef Mon Sep 17 00:00:00 2001
From: glepnir <glephunter@gmail.com>
Date: Thu, 7 Sep 2023 18:42:38 +0800
Subject: fix(highlight): add create param in nvim_get_hl

---
 runtime/lua/vim/_meta/api.lua         | 2 ++
 runtime/lua/vim/_meta/api_keysets.lua | 1 +
 2 files changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index dd67fdb38b..c46b604b90 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1193,6 +1193,8 @@ function vim.api.nvim_get_current_win() end
 ---              • id: (integer) Get a highlight definition by id.
 ---              • link: (boolean, default true) Show linked group name
 ---                instead of effective definition `:hi-link`.
+---              • create: (boolean, default true) When highlight group
+---                doesn't exist create it.
 --- @return table<string,any>
 function vim.api.nvim_get_hl(ns_id, opts) end
 
diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index 08c29ebe7a..8f36edba77 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -126,6 +126,7 @@ error('Cannot require a meta file')
 --- @field id? integer
 --- @field name? string
 --- @field link? boolean
+--- @field create? boolean
 
 --- @class vim.api.keyset.highlight
 --- @field bold? boolean
-- 
cgit 


From 5e3cf9fb4bc7f236c858f609ca83c57fb1779ab0 Mon Sep 17 00:00:00 2001
From: Grace Petryk <gracepetryk99@gmail.com>
Date: Sun, 10 Sep 2023 01:02:23 -0700
Subject: feat(lsp): improve control over placement of floating windows
 (#24494)

---
 runtime/lua/vim/lsp/handlers.lua |  4 ++--
 runtime/lua/vim/lsp/util.lua     | 24 ++++++++++++++++++++++--
 2 files changed, 24 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index a6b70ac911..81d4d6cceb 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -355,7 +355,7 @@ end
 ---@param config table Configuration table.
 ---     - border:     (default=nil)
 ---         - Add borders to the floating window
----         - See |nvim_open_win()|
+---         - See |vim.lsp.util.open_floating_preview()| for more options.
 function M.hover(_, result, ctx, config)
   config = config or {}
   config.focus_id = ctx.method
@@ -442,7 +442,7 @@ M[ms.textDocument_implementation] = location_handler
 ---@param config table Configuration table.
 ---     - border:     (default=nil)
 ---         - Add borders to the floating window
----         - See |nvim_open_win()|
+---         - See |vim.lsp.util.open_floating_preview()| for more options
 function M.signature_help(_, result, ctx, config)
   config = config or {}
   config.focus_id = ctx.method
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index a6d17afa1b..e76fd15612 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1087,6 +1087,12 @@ end
 ---        - focusable (string or table) override `focusable`
 ---        - zindex (string or table) override `zindex`, defaults to 50
 ---        - relative ("mouse"|"cursor") defaults to "cursor"
+---        - anchor_bias ("auto"|"above"|"below") defaults to "auto"
+---          - "auto": place window based on which side of the cursor has more lines
+---          - "above": place the window above the cursor unless there are not enough lines
+---            to display the full window height.
+---          - "below": place the window below the cursor unless there are not enough lines
+---            to display the full window height.
 ---@return table Options
 function M.make_floating_popup_options(width, height, opts)
   validate({
@@ -1105,7 +1111,20 @@ function M.make_floating_popup_options(width, height, opts)
     or vim.fn.winline() - 1
   local lines_below = vim.fn.winheight(0) - lines_above
 
-  if lines_above < lines_below then
+  local anchor_bias = opts.anchor_bias or 'auto'
+
+  local anchor_below
+
+  if anchor_bias == 'below' then
+    anchor_below = (lines_below > lines_above) or (height <= lines_below)
+  elseif anchor_bias == 'above' then
+    local anchor_above = (lines_above > lines_below) or (height <= lines_above)
+    anchor_below = not anchor_above
+  else
+    anchor_below = lines_below > lines_above
+  end
+
+  if anchor_below then
     anchor = anchor .. 'N'
     height = math.min(lines_below, height)
     row = 1
@@ -1635,7 +1654,8 @@ end
 ---
 ---@param contents table of lines to show in window
 ---@param syntax string of syntax to set for opened buffer
----@param opts table with optional fields (additional keys are passed on to |nvim_open_win()|)
+---@param opts table with optional fields (additional keys are filtered with |vim.lsp.util.make_floating_popup_options()|
+---                  before they are passed on to |nvim_open_win()|)
 ---             - height: (integer) height of floating window
 ---             - width: (integer) width of floating window
 ---             - wrap: (boolean, default true) wrap long lines
-- 
cgit 


From d22172f36bbe147f3aa6b76a1c43ae445f481c2e Mon Sep 17 00:00:00 2001
From: Sergey Slipchenko <faergeek@gmail.com>
Date: Mon, 11 Sep 2023 08:16:03 +0400
Subject: fix(api): more intuitive cursor updates in nvim_buf_set_text

Fixes #22526
---
 runtime/lua/vim/_meta/api.lua |  1 +
 runtime/lua/vim/lsp/util.lua  | 42 ------------------------------------------
 2 files changed, 1 insertion(+), 42 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index c46b604b90..6c4e6c04d9 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -621,6 +621,7 @@ function vim.api.nvim_buf_set_option(buffer, name, value) end
 --- range, use `replacement = {}`.
 --- Prefer `nvim_buf_set_lines()` if you are only adding or deleting entire
 --- lines.
+--- Prefer `nvim_put()` if you want to insert text at the cursor position.
 ---
 --- @param buffer integer Buffer handle, or 0 for current buffer
 --- @param start_row integer First line index
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index e76fd15612..54721865b7 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -454,23 +454,6 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
     end
   end)
 
-  -- Some LSP servers are depending on the VSCode behavior.
-  -- The VSCode will re-locate the cursor position after applying TextEdit so we also do it.
-  local is_current_buf = api.nvim_get_current_buf() == bufnr or bufnr == 0
-  local cursor = (function()
-    if not is_current_buf then
-      return {
-        row = -1,
-        col = -1,
-      }
-    end
-    local cursor = api.nvim_win_get_cursor(0)
-    return {
-      row = cursor[1] - 1,
-      col = cursor[2],
-    }
-  end)()
-
   -- save and restore local marks since they get deleted by nvim_buf_set_lines
   local marks = {}
   for _, m in pairs(vim.fn.getmarklist(bufnr or vim.api.nvim_get_current_buf())) do
@@ -480,7 +463,6 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
   end
 
   -- Apply text edits.
-  local is_cursor_fixed = false
   local has_eol_text_edit = false
   for _, text_edit in ipairs(text_edits) do
     -- Normalize line ending
@@ -527,20 +509,6 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
       e.end_col = math.min(last_line_len, e.end_col)
 
       api.nvim_buf_set_text(bufnr, e.start_row, e.start_col, e.end_row, e.end_col, e.text)
-
-      -- Fix cursor position.
-      local row_count = (e.end_row - e.start_row) + 1
-      if e.end_row < cursor.row then
-        cursor.row = cursor.row + (#e.text - row_count)
-        is_cursor_fixed = true
-      elseif e.end_row == cursor.row and e.end_col <= cursor.col then
-        cursor.row = cursor.row + (#e.text - row_count)
-        cursor.col = #e.text[#e.text] + (cursor.col - e.end_col)
-        if #e.text == 1 then
-          cursor.col = cursor.col + e.start_col
-        end
-        is_cursor_fixed = true
-      end
     end
   end
 
@@ -560,16 +528,6 @@ function M.apply_text_edits(text_edits, bufnr, offset_encoding)
     end
   end
 
-  -- Apply fixed cursor position.
-  if is_cursor_fixed then
-    local is_valid_cursor = true
-    is_valid_cursor = is_valid_cursor and cursor.row < max
-    is_valid_cursor = is_valid_cursor and cursor.col <= #(get_line(bufnr, cursor.row) or '')
-    if is_valid_cursor then
-      api.nvim_win_set_cursor(0, { cursor.row + 1, cursor.col })
-    end
-  end
-
   -- Remove final line if needed
   local fix_eol = has_eol_text_edit
   fix_eol = fix_eol and (vim.bo[bufnr].eol or (vim.bo[bufnr].fixeol and not vim.bo[bufnr].binary))
-- 
cgit 


From 60e5d0fbcc8dfb942480aa2d9e4b45f4a255d952 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sun, 10 Sep 2023 18:59:08 +0200
Subject: vim-patch:9.0.1891: No runtime support for Mojo

Problem:  No runtime support for Mojo
Solution: Add basic filetype and syntax plugins

closes: vim/vim#13062
closes: vim/vim#13063

https://github.com/vim/vim/commit/0ce2c594d0704f27a16d2c13fce85d596cc91489

Co-authored-by: Mahmoud Abduljawad <mahmoud@masaar.com>
---
 runtime/lua/vim/filetype.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 0e8ecf1b07..6fb6f475bc 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -669,6 +669,8 @@ local extension = {
   m2 = 'modula2',
   mi = 'modula2',
   lm3 = 'modula3',
+  mojo = 'mojo',
+  ['🔥'] = 'mojo', -- 🙄
   ssc = 'monk',
   monk = 'monk',
   tsc = 'monk',
-- 
cgit 


From 65738202f8be3ca63b75197d48f2c7a9324c035b Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Tue, 12 Sep 2023 04:29:39 +0900
Subject: fix(decorations): better approximation of botline #24794

Problem:
* The guessed botline might be smaller than the actual botline e.g. when
  there are folds and the user is typing in insert mode. This may result
  in incorrect treesitter highlights for injections.
* botline can be larger than the last line number of the buffer, which
  results in errors when placing extmarks.

Solution:
* Take a more conservative approximation. I am not sure if it is
  sufficient to guarantee correctness, but it seems to be good enough
  for the case mentioned above.
* Clamp it to the last line number.

Co-authored-by: Lewis Russell <me@lewisr.dev>
---
 runtime/lua/vim/_meta/api.lua              | 4 +++-
 runtime/lua/vim/treesitter/highlighter.lua | 2 +-
 2 files changed, 4 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 6c4e6c04d9..bfff16933a 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1777,7 +1777,9 @@ function vim.api.nvim_set_current_win(window) end
 ---              • on_buf: called for each buffer being redrawn (before window
 ---                callbacks) ["buf", bufnr, tick]
 ---              • on_win: called when starting to redraw a specific window.
----                ["win", winid, bufnr, topline, botline_guess]
+---                botline_guess is an approximation that does not exceed the
+---                last line number. ["win", winid, bufnr, topline,
+---                botline_guess]
 ---              • on_line: called for each buffer line being redrawn. (The
 ---                interaction with fold lines is subject to change) ["win",
 ---                winid, bufnr, row]
diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index 56b075b723..8d4d6a9337 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -322,7 +322,7 @@ function TSHighlighter._on_win(_, _win, buf, topline, botline)
   if not self then
     return false
   end
-  self.tree:parse({ topline, botline })
+  self.tree:parse({ topline, botline + 1 })
   self:reset_highlight_state()
   self.redraw_count = self.redraw_count + 1
   return true
-- 
cgit 


From 6b5f44817e93c2985f3ea32122f1dc0047054018 Mon Sep 17 00:00:00 2001
From: L Lllvvuu <git@llllvvuu.dev>
Date: Mon, 11 Sep 2023 23:15:24 -0700
Subject: fix(languagetree): remove double recursion in LanguageTree:parse

`LanguageTree:parse` is recursive, and calls
`LanguageTree:for_each_child`, which is also recursive.

That means that, starting from the third level (child of child of root),
nodes will be parsed twice.

Which then means that if the tree is N layers deep, there will be ~2^N
parses even if the branching factor is 1.

Now, why was the tree deepening with each character inserted? And why
did this only regress in #24647? These are mysteries for another time.

Fixes: #25104
---
 runtime/lua/vim/treesitter/languagetree.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index e81778b269..3c60da7643 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -444,9 +444,9 @@ function LanguageTree:parse(range)
     range = range,
   })
 
-  self:for_each_child(function(child)
+  for _, child in pairs(self._children) do
     child:parse(range)
-  end)
+  end
 
   return self._trees
 end
-- 
cgit 


From b04286a187d57c50f01cd36cd4668b7a69026579 Mon Sep 17 00:00:00 2001
From: bfredl <bjorn.linse@gmail.com>
Date: Sun, 22 Nov 2020 10:10:37 +0100
Subject: feat(extmark): support proper multiline ranges

The removes the previous restriction that nvim_buf_set_extmark()
could not be used to highlight arbitrary multi-line regions

The problem can be summarized as follows: let's assume an extmark with a
hl_group is placed covering the region (5,0) to (50,0) Now, consider
what happens if nvim needs to redraw a window covering the lines 20-30.
It needs to be able to ask the marktree what extmarks cover this region,
even if they don't begin or end here.

Therefore the marktree needs to be augmented with the information covers
a point, not just what marks begin or end there. To do this, we augment
each node with a field "intersect" which is a set the ids of the
marks which overlap this node, but only if it is not part of the set of
any parent. This ensures the number of nodes that need to be explicitly
marked grows only logarithmically with the total number of explicitly
nodes (and thus the number of of overlapping marks).

Thus we can quickly iterate all marks which overlaps any query position
by looking up what leaf node contains that position. Then we only need
to consider all "start" marks within that leaf node, and the "intersect"
set of that node and all its parents.

Now, and the major source of complexity is that the tree restructuring
operations (to ensure that each node has T-1 <= size <= 2*T-1) also need
to update these sets. If a full inner node is split in two, one of the
new parents might start to completely overlap some ranges and its ids
will need to be moved from its children's sets to its own set.
Similarly, if two undersized nodes gets joined into one, it might no
longer completely overlap some ranges, and now the children which do
needs to have the have the ids in its set instead. And then there are
the pivots! Yes the pivot operations when a child gets moved from one
parent to another.
---
 runtime/lua/vim/_meta/api.lua         | 18 +++++++++++++++++-
 runtime/lua/vim/_meta/api_keysets.lua |  7 +++++++
 runtime/lua/vim/highlight.lua         |  3 +++
 3 files changed, 27 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index bfff16933a..7cd0d825a1 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -5,6 +5,13 @@ error('Cannot require a meta file')
 
 vim.api = {}
 
+--- @private
+--- @param buffer integer
+--- @param keys boolean
+--- @param dot boolean
+--- @return string
+function vim.api.nvim__buf_debug_extmarks(buffer, keys, dot) end
+
 --- @private
 --- @param buffer integer
 --- @param first integer
@@ -313,6 +320,9 @@ function vim.api.nvim_buf_get_extmark_by_id(buffer, ns_id, id, opts) end
 --- ```
 --- If `end` is less than `start`, traversal works backwards. (Useful with
 --- `limit`, to get the first marks prior to a given position.)
+--- Note: when using extmark ranges (marks with a end_row/end_col position)
+--- the `overlap` option might be useful. Otherwise only the start position of
+--- an extmark will be considered.
 --- Example:
 --- ```lua
 ---   local api = vim.api
@@ -337,11 +347,13 @@ function vim.api.nvim_buf_get_extmark_by_id(buffer, ns_id, id, opts) end
 --- @param end_ any End of range (inclusive): a 0-indexed (row, col) or valid
 ---               extmark id (whose position defines the bound).
 ---               `api-indexing`
---- @param opts table<string,any> Optional parameters. Keys:
+--- @param opts vim.api.keyset.get_extmarks Optional parameters. Keys:
 ---               • limit: Maximum number of marks to return
 ---               • details: Whether to include the details dict
 ---               • hl_name: Whether to include highlight group name instead
 ---                 of id, true if omitted
+---               • overlap: Also include marks which overlap the range, even
+---                 if their start position is less than `start`
 ---               • type: Filter marks by type: "highlight", "sign",
 ---                 "virt_text" and "virt_lines"
 --- @return any[]
@@ -457,6 +469,10 @@ function vim.api.nvim_buf_line_count(buffer) end
 --- waiting for the return value.)
 --- Using the optional arguments, it is possible to use this to highlight a
 --- range of text, and also to associate virtual text to the mark.
+--- If present, the position defined by `end_col` and `end_row` should be
+--- after the start position in order for the extmark to cover a range. An
+--- earlier end position is not an error, but then it behaves like an empty
+--- range (no highlighting).
 ---
 --- @param buffer integer Buffer handle, or 0 for current buffer
 --- @param ns_id integer Namespace id from `nvim_create_namespace()`
diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index 8f36edba77..4d08563ce2 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -122,6 +122,13 @@ error('Cannot require a meta file')
 --- @class vim.api.keyset.get_commands
 --- @field builtin? boolean
 
+--- @class vim.api.keyset.get_extmarks
+--- @field limit? integer
+--- @field details? boolean
+--- @field hl_name? boolean
+--- @field overlap? boolean
+--- @field type? string
+
 --- @class vim.api.keyset.get_highlight
 --- @field id? integer
 --- @field name? string
diff --git a/runtime/lua/vim/highlight.lua b/runtime/lua/vim/highlight.lua
index 14b0e71312..fd4fb54a5b 100644
--- a/runtime/lua/vim/highlight.lua
+++ b/runtime/lua/vim/highlight.lua
@@ -55,6 +55,9 @@ function M.range(bufnr, ns, higroup, start, finish, opts)
   local inclusive = opts.inclusive or false
   local priority = opts.priority or M.priorities.user
 
+  -- TODO: in case of 'v', 'V' (not block), this should calculate equivalent
+  -- bounds (row, col, end_row, end_col) as multiline regions are natively
+  -- supported now
   local region = vim.region(bufnr, start, finish, regtype, inclusive)
   for linenr, cols in pairs(region) do
     local end_row
-- 
cgit 


From 7a76fb8547548304450b59624f9c75a554396504 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 12 Sep 2023 11:38:31 +0100
Subject: fix(treesitter): remove more double recursion

Do not call `for_each_child` in functions that are already recursive.
---
 runtime/lua/vim/treesitter/dev.lua          | 20 ++++++--------
 runtime/lua/vim/treesitter/languagetree.lua | 43 ++++++++++++++++++-----------
 2 files changed, 36 insertions(+), 27 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index 72b6e3db4a..67aa8670ba 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -101,17 +101,15 @@ function TSTreeView:new(bufnr, lang)
   -- the root in the child tree to the {injections} table.
   local root = parser:parse(true)[1]:root()
   local injections = {} ---@type table<integer,table>
-  parser:for_each_child(function(child, lang_)
-    child:for_each_tree(function(tree)
-      local r = tree:root()
-      local node = root:named_descendant_for_range(r:range())
-      if node then
-        injections[node:id()] = {
-          lang = lang_,
-          root = r,
-        }
-      end
-    end)
+  parser:for_each_tree(function(tree, ltree)
+    local r = tree:root()
+    local node = root:named_descendant_for_range(r:range())
+    if node then
+      injections[node:id()] = {
+        lang = ltree:lang(),
+        root = r,
+      }
+    end
   end)
 
   local nodes = traverse(root, 0, parser:lang(), injections, {})
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 3c60da7643..6037b17b20 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -897,6 +897,20 @@ function LanguageTree:_edit(
     end
     return true
   end)
+
+  for _, child in pairs(self._children) do
+    child:_edit(
+      start_byte,
+      end_byte_old,
+      end_byte_new,
+      start_row,
+      start_col,
+      end_row_old,
+      end_col_old,
+      end_row_new,
+      end_col_new
+    )
+  end
 end
 
 ---@package
@@ -943,20 +957,17 @@ function LanguageTree:_on_bytes(
   )
 
   -- Edit trees together BEFORE emitting a bytes callback.
-  ---@private
-  self:for_each_child(function(child)
-    child:_edit(
-      start_byte,
-      start_byte + old_byte,
-      start_byte + new_byte,
-      start_row,
-      start_col,
-      start_row + old_row,
-      old_end_col,
-      start_row + new_row,
-      new_end_col
-    )
-  end, true)
+  self:_edit(
+    start_byte,
+    start_byte + old_byte,
+    start_byte + new_byte,
+    start_row,
+    start_col,
+    start_row + old_row,
+    old_end_col,
+    start_row + new_row,
+    new_end_col
+  )
 
   self:_do_callback(
     'bytes',
@@ -1017,9 +1028,9 @@ function LanguageTree:register_cbs(cbs, recursive)
   end
 
   if recursive then
-    self:for_each_child(function(child)
+    for _, child in pairs(self._children) do
       child:register_cbs(cbs, true)
-    end)
+    end
   end
 end
 
-- 
cgit 


From 1f551e068f728ff38bd7fdcfa3a6daf362bab9da Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 12 Sep 2023 15:26:57 +0100
Subject: fix(treesitter): fixup for InspectTree

Fixes #25120
---
 runtime/lua/vim/treesitter/dev.lua | 22 ++++++++++++----------
 1 file changed, 12 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index 67aa8670ba..e7af259d28 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -101,16 +101,18 @@ function TSTreeView:new(bufnr, lang)
   -- the root in the child tree to the {injections} table.
   local root = parser:parse(true)[1]:root()
   local injections = {} ---@type table<integer,table>
-  parser:for_each_tree(function(tree, ltree)
-    local r = tree:root()
-    local node = root:named_descendant_for_range(r:range())
-    if node then
-      injections[node:id()] = {
-        lang = ltree:lang(),
-        root = r,
-      }
-    end
-  end)
+  for _, child in pairs(parser:children()) do
+    child:for_each_tree(function(tree, ltree)
+      local r = tree:root()
+      local node = root:named_descendant_for_range(r:range())
+      if node then
+        injections[node:id()] = {
+          lang = ltree:lang(),
+          root = r,
+        }
+      end
+    end)
+  end
 
   local nodes = traverse(root, 0, parser:lang(), injections, {})
 
-- 
cgit 


From 4607807f9fcb83d4e183f6f67e705ffd7f451077 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sun, 20 Aug 2023 14:17:45 +0900
Subject: fix(treesitter): don't update fold if tree is unchanged

Problem:
Folds are opened when the visible range changes even if there are no
modifications to the buffer, e.g, when using zM for the first time. If
the parsed tree was invalid, on_win re-parses and gets empty tree
changes, which triggers fold updates.

Solution:
Don't update folds in on_changedtree if there are no changes.
---
 runtime/lua/vim/treesitter/_fold.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index d82e04a5a8..8bc08c9c2e 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -299,7 +299,9 @@ local function on_changedtree(bufnr, foldinfo, tree_changes)
       local srow, _, erow = Range.unpack4(change)
       get_folds_levels(bufnr, foldinfo, srow, erow)
     end
-    foldupdate(bufnr)
+    if #tree_changes > 0 then
+      foldupdate(bufnr)
+    end
   end)
 end
 
-- 
cgit 


From 27a566f3f8e07a4cebb426674800bdf9a7f4f222 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 13 Sep 2023 08:38:28 -0500
Subject: feat(vimdoc): support Markdown code blocks (#25127)

Support Markdown code blocks in addition to <pre> blocks in Doxygen doc
comments.

Update doc comments in iter.lua as a test.
---
 runtime/lua/vim/iter.lua | 187 ++++++++++++++++++++++++++---------------------
 1 file changed, 105 insertions(+), 82 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index 56c130dd0c..595baa7019 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -15,44 +15,45 @@
 --- (for function iterators, this means that the first value returned by the function is nil).
 ---
 --- Examples:
---- <pre>lua
----   local it = vim.iter({ 1, 2, 3, 4, 5 })
----   it:map(function(v)
----     return v * 3
----   end)
----   it:rev()
----   it:skip(2)
----   it:totable()
----   -- { 9, 6, 3 }
----
----   -- ipairs() is a function iterator which returns both the index (i) and the value (v)
----   vim.iter(ipairs({ 1, 2, 3, 4, 5 })):map(function(i, v)
----     if i > 2 then return v end
----   end):totable()
----   -- { 3, 4, 5 }
----
----   local it = vim.iter(vim.gsplit('1,2,3,4,5', ','))
----   it:map(function(s) return tonumber(s) end)
----   for i, d in it:enumerate() do
----     print(string.format("Column %d is %d", i, d))
----   end
----   -- Column 1 is 1
----   -- Column 2 is 2
----   -- Column 3 is 3
----   -- Column 4 is 4
----   -- Column 5 is 5
----
----   vim.iter({ a = 1, b = 2, c = 3, z = 26 }):any(function(k, v)
----     return k == 'z'
----   end)
----   -- true
----
----   local rb = vim.ringbuf(3)
----   rb:push("a")
----   rb:push("b")
----   vim.iter(rb):totable()
----   -- { "a", "b" }
---- </pre>
+---
+--- ```lua
+--- local it = vim.iter({ 1, 2, 3, 4, 5 })
+--- it:map(function(v)
+---   return v * 3
+--- end)
+--- it:rev()
+--- it:skip(2)
+--- it:totable()
+--- -- { 9, 6, 3 }
+---
+--- -- ipairs() is a function iterator which returns both the index (i) and the value (v)
+--- vim.iter(ipairs({ 1, 2, 3, 4, 5 })):map(function(i, v)
+---   if i > 2 then return v end
+--- end):totable()
+--- -- { 3, 4, 5 }
+---
+--- local it = vim.iter(vim.gsplit('1,2,3,4,5', ','))
+--- it:map(function(s) return tonumber(s) end)
+--- for i, d in it:enumerate() do
+---   print(string.format("Column %d is %d", i, d))
+--- end
+--- -- Column 1 is 1
+--- -- Column 2 is 2
+--- -- Column 3 is 3
+--- -- Column 4 is 4
+--- -- Column 5 is 5
+---
+--- vim.iter({ a = 1, b = 2, c = 3, z = 26 }):any(function(k, v)
+---   return k == 'z'
+--- end)
+--- -- true
+---
+--- local rb = vim.ringbuf(3)
+--- rb:push("a")
+--- rb:push("b")
+--- vim.iter(rb):totable()
+--- -- { "a", "b" }
+--- ```
 ---
 --- In addition to the |vim.iter()| function, the |vim.iter| module provides
 --- convenience functions like |vim.iter.filter()| and |vim.iter.totable()|.
@@ -140,9 +141,10 @@ end
 --- Add a filter step to the iterator pipeline.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 --- local bufs = vim.iter(vim.api.nvim_list_bufs()):filter(vim.api.nvim_buf_is_loaded)
---- </pre>
+--- ```
 ---
 ---@param f function(...):bool Takes all values returned from the previous stage
 ---                            in the pipeline and returns false or nil if the
@@ -176,7 +178,8 @@ end
 --- If the map function returns nil, the value is filtered from the iterator.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 --- local it = vim.iter({ 1, 2, 3, 4 }):map(function(v)
 ---   if v % 2 == 0 then
 ---     return v * 3
@@ -184,7 +187,7 @@ end
 --- end)
 --- it:totable()
 --- -- { 6, 12 }
---- </pre>
+--- ```
 ---
 ---@param f function(...):any Mapping function. Takes all values returned from
 ---                           the previous stage in the pipeline as arguments
@@ -288,7 +291,8 @@ end
 --- pipeline, each value will be included in a table.
 ---
 --- Examples:
---- <pre>lua
+---
+--- ```lua
 --- vim.iter(string.gmatch('100 20 50', '%d+')):map(tonumber):totable()
 --- -- { 100, 20, 50 }
 ---
@@ -297,7 +301,7 @@ end
 ---
 --- vim.iter({ a = 1, b = 2, c = 3 }):filter(function(k, v) return v % 2 ~= 0 end):totable()
 --- -- { { 'a', 1 }, { 'c', 3 } }
---- </pre>
+--- ```
 ---
 --- The generated table is a list-like table with consecutive, numeric indices.
 --- To create a map-like table with arbitrary keys, use |Iter:fold()|.
@@ -352,7 +356,8 @@ end
 --- Fold ("reduce") an iterator or table into a single value.
 ---
 --- Examples:
---- <pre>lua
+---
+--- ```lua
 --- -- Create a new table with only even values
 --- local t = { a = 1, b = 2, c = 3, d = 4 }
 --- local it = vim.iter(t)
@@ -362,7 +367,7 @@ end
 ---   return t
 --- end)
 --- -- { b = 2, d = 4 }
---- </pre>
+--- ```
 ---
 ---@generic A
 ---
@@ -398,7 +403,8 @@ end
 --- Return the next value from the iterator.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 ---
 --- local it = vim.iter(string.gmatch('1 2 3', '%d+')):map(tonumber)
 --- it:next()
@@ -408,7 +414,7 @@ end
 --- it:next()
 --- -- 3
 ---
---- </pre>
+--- ```
 ---
 ---@return any
 function Iter.next(self) -- luacheck: no unused args
@@ -431,13 +437,14 @@ end
 --- Only supported for iterators on list-like tables.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 ---
 --- local it = vim.iter({ 3, 6, 9, 12 }):rev()
 --- it:totable()
 --- -- { 12, 9, 6, 3 }
 ---
---- </pre>
+--- ```
 ---
 ---@return Iter
 function Iter.rev(self)
@@ -457,7 +464,8 @@ end
 --- Only supported for iterators on list-like tables.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 ---
 --- local it = vim.iter({ 3, 6, 9, 12 })
 --- it:peek()
@@ -467,7 +475,7 @@ end
 --- it:next()
 --- -- 3
 ---
---- </pre>
+--- ```
 ---
 ---@return any
 function Iter.peek(self) -- luacheck: no unused args
@@ -486,7 +494,8 @@ end
 --- Advances the iterator. Returns nil and drains the iterator if no value is found.
 ---
 --- Examples:
---- <pre>lua
+---
+--- ```lua
 ---
 --- local it = vim.iter({ 3, 6, 9, 12 })
 --- it:find(12)
@@ -500,7 +509,7 @@ end
 --- it:find(function(v) return v % 4 == 0 end)
 --- -- 12
 ---
---- </pre>
+--- ```
 ---
 ---@return any
 function Iter.find(self, f)
@@ -536,7 +545,8 @@ end
 --- Only supported for iterators on list-like tables.
 ---
 --- Examples:
---- <pre>lua
+---
+--- ```lua
 ---
 --- local it = vim.iter({ 1, 2, 3, 2, 1 }):enumerate()
 --- it:rfind(1)
@@ -544,7 +554,7 @@ end
 --- it:rfind(1)
 --- -- 1	1
 ---
---- </pre>
+--- ```
 ---
 ---@see Iter.find
 ---
@@ -578,13 +588,14 @@ end
 --- Only supported for iterators on list-like tables.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 --- local it = vim.iter({1, 2, 3, 4})
 --- it:nextback()
 --- -- 4
 --- it:nextback()
 --- -- 3
---- </pre>
+--- ```
 ---
 ---@return any
 function Iter.nextback(self) -- luacheck: no unused args
@@ -604,7 +615,8 @@ end
 --- Only supported for iterators on list-like tables.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 --- local it = vim.iter({1, 2, 3, 4})
 --- it:peekback()
 --- -- 4
@@ -612,7 +624,7 @@ end
 --- -- 4
 --- it:nextback()
 --- -- 4
---- </pre>
+--- ```
 ---
 ---@return any
 function Iter.peekback(self) -- luacheck: no unused args
@@ -629,13 +641,14 @@ end
 --- Skip values in the iterator.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 ---
 --- local it = vim.iter({ 3, 6, 9, 12 }):skip(2)
 --- it:next()
 --- -- 9
 ---
---- </pre>
+--- ```
 ---
 ---@param n number Number of values to skip.
 ---@return Iter
@@ -661,13 +674,14 @@ end
 --- Only supported for iterators on list-like tables.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 --- local it = vim.iter({ 1, 2, 3, 4, 5 }):skipback(2)
 --- it:next()
 --- -- 1
 --- it:nextback()
 --- -- 3
---- </pre>
+--- ```
 ---
 ---@param n number Number of values to skip.
 ---@return Iter
@@ -691,7 +705,8 @@ end
 --- This function advances the iterator.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 ---
 --- local it = vim.iter({ 3, 6, 9, 12 })
 --- it:nth(2)
@@ -699,7 +714,7 @@ end
 --- it:nth(2)
 --- -- 12
 ---
---- </pre>
+--- ```
 ---
 ---@param n number The index of the value to return.
 ---@return any
@@ -716,7 +731,8 @@ end
 --- Only supported for iterators on list-like tables.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 ---
 --- local it = vim.iter({ 3, 6, 9, 12 })
 --- it:nthback(2)
@@ -724,7 +740,7 @@ end
 --- it:nthback(2)
 --- -- 3
 ---
---- </pre>
+--- ```
 ---
 ---@param n number The index of the value to return.
 ---@return any
@@ -805,7 +821,8 @@ end
 --- Drains the iterator.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 ---
 --- local it = vim.iter(vim.gsplit('abcdefg', ''))
 --- it:last()
@@ -815,7 +832,7 @@ end
 --- it:last()
 --- -- 15
 ---
---- </pre>
+--- ```
 ---
 ---@return any
 function Iter.last(self)
@@ -839,19 +856,22 @@ end
 --- Add an iterator stage that returns the current iterator count as well as the iterator value.
 ---
 --- For list tables, prefer
---- <pre>lua
+---
+--- ```lua
 --- vim.iter(ipairs(t))
---- </pre>
+--- ```
 ---
 --- over
---- <pre>lua
+---
+--- ```lua
 --- vim.iter(t):enumerate()
---- </pre>
+--- ```
 ---
 --- as the former is faster.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 ---
 --- local it = vim.iter(vim.gsplit('abc', '')):enumerate()
 --- it:next()
@@ -861,7 +881,7 @@ end
 --- it:next()
 --- -- 3	'c'
 ---
---- </pre>
+--- ```
 ---
 ---@return Iter
 function Iter.enumerate(self)
@@ -959,9 +979,10 @@ end
 --- Collect an iterator into a table.
 ---
 --- This is a convenience function that performs:
---- <pre>lua
+---
+--- ```lua
 --- vim.iter(f):totable()
---- </pre>
+--- ```
 ---
 ---@param f function Iterator function
 ---@return table
@@ -972,9 +993,10 @@ end
 --- Filter a table or iterator.
 ---
 --- This is a convenience function that performs:
---- <pre>lua
+---
+--- ```lua
 --- vim.iter(src):filter(f):totable()
---- </pre>
+--- ```
 ---
 ---@see |Iter:filter()|
 ---
@@ -990,9 +1012,10 @@ end
 --- Map and filter a table or iterator.
 ---
 --- This is a convenience function that performs:
---- <pre>lua
+---
+--- ```lua
 --- vim.iter(src):map(f):totable()
---- </pre>
+--- ```
 ---
 ---@see |Iter:map()|
 ---
-- 
cgit 


From a6e74c1f0a2bbf03f5b99c167b549018f4c8fb0d Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Thu, 14 Sep 2023 06:05:27 +0200
Subject: docs: fix typos and other small fixes (#25005)

Co-authored-by: nuid64 <lvkuzvesov@proton.me>
Co-authored-by: Mike Smith <10135646+mikesmithgh@users.noreply.github.com>
Co-authored-by: XTY <xty@xty.io>
Co-authored-by: Empa <emanuel@empa.xyz>
Co-authored-by: kyu08 <49891479+kyu08@users.noreply.github.com>
---
 runtime/lua/vim/_editor.lua       | 2 +-
 runtime/lua/vim/_meta/options.lua | 6 +++---
 runtime/lua/vim/_meta/regex.lua   | 2 +-
 runtime/lua/vim/_meta/vimfn.lua   | 2 +-
 4 files changed, 6 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 68992a16bb..64aeb64736 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -104,7 +104,7 @@ vim.log = {
 ---     Handle output from stdout. When passed as a function must have the signature `fun(err: string, data: string)`.
 ---     Defaults to `true`
 ---   - stderr: (boolean|function)
----     Handle output from stdout. When passed as a function must have the signature `fun(err: string, data: string)`.
+---     Handle output from stderr. When passed as a function must have the signature `fun(err: string, data: string)`.
 ---     Defaults to `true`.
 ---   - text: (boolean) Handle stdout and stderr as text. Replaces `\r\n` with `\n`.
 ---   - timeout: (integer) Run the command with a time limit. Upon timeout the process is sent the
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 4fb3141df0..92dc4b2c7f 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -2697,10 +2697,10 @@ vim.go.gp = vim.go.grepprg
 ---    n-v-c-sm:block,i-ci-ve:ver25-Cursor,r-cr-o:hor20
 --- 			In Normal et al. modes, use a block cursor
 --- 			with the default colors defined by the host
---- 			terminal.  In Insert-likes modes, use
+--- 			terminal.  In Insert-like modes, use
 --- 			a vertical bar cursor with colors from
---- 			"Cursor" highlight group.  In Replace-likes
---- 			modes, use a underline cursor with
+--- 			"Cursor" highlight group.  In Replace-like
+--- 			modes, use an underline cursor with
 --- 			default colors.
 ---    i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
 --- 			In Insert and Command-line Insert mode, use a
diff --git a/runtime/lua/vim/_meta/regex.lua b/runtime/lua/vim/_meta/regex.lua
index ab4f46d43f..58aa2be8c2 100644
--- a/runtime/lua/vim/_meta/regex.lua
+++ b/runtime/lua/vim/_meta/regex.lua
@@ -21,7 +21,7 @@ local regex = {} -- luacheck: no unused
 --- precisely, surround the regex with `^` and `$`. If there was a match, the
 --- byte indices for the beginning and end of the match are returned. When
 --- there is no match, `nil` is returned. Because any integer is "truthy",
---- `regex:match()` can be directly used as a condition in an if-statement.
+--- `regex:match_str()` can be directly used as a condition in an if-statement.
 --- @param str string
 function regex:match_str(str) end
 
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 6209ce0c73..efb779ad41 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -6194,7 +6194,7 @@ function vim.fn.prevnonblank(lnum) end
 ---           *printf-$*
 --- In certain languages, error and informative messages are
 --- more readable when the order of words is different from the
---- corresponding message in English. To accomodate translations
+--- corresponding message in English. To accommodate translations
 --- having a different word order, positional arguments may be
 --- used to indicate this. For instance: >vim
 ---
-- 
cgit 


From a49924a318520a3b5c2f210f22a8d450165e89b5 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Thu, 14 Sep 2023 08:40:53 +0200
Subject: feat(lsp): remove notify from vim.lsp.buf_detach_client (#25140)

Closes https://github.com/neovim/neovim/issues/19838
---
 runtime/lua/vim/lsp.lua | 2 --
 1 file changed, 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index b0caf5af35..c25358e557 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -1955,8 +1955,6 @@ function lsp.buf_detach_client(bufnr, client_id)
 
   local namespace = lsp.diagnostic.get_namespace(client_id)
   vim.diagnostic.reset(namespace, bufnr)
-
-  vim.notify(string.format('Detached buffer (id: %d) from client (id: %d)', bufnr, client_id))
 end
 
 --- Checks if a buffer is attached for a particular client.
-- 
cgit 


From a4743487b71b54f05063465d5f8cde8014bcb73c Mon Sep 17 00:00:00 2001
From: L Lllvvuu <git@llllvvuu.dev>
Date: Thu, 14 Sep 2023 00:08:43 -0700
Subject: fix(treesitter): `language.add` - only register parser if it exists

Fixes: #24531
---
 runtime/lua/vim/treesitter/language.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/language.lua b/runtime/lua/vim/treesitter/language.lua
index 9695e2c41c..15bf666a1e 100644
--- a/runtime/lua/vim/treesitter/language.lua
+++ b/runtime/lua/vim/treesitter/language.lua
@@ -82,9 +82,8 @@ function M.add(lang, opts)
     filetype = { filetype, { 'string', 'table' }, true },
   })
 
-  M.register(lang, filetype)
-
   if vim._ts_has_language(lang) then
+    M.register(lang, filetype)
     return
   end
 
@@ -102,6 +101,7 @@ function M.add(lang, opts)
   end
 
   vim._ts_add_language(path, lang, symbol_name)
+  M.register(lang, filetype)
 end
 
 --- @param x string|string[]
-- 
cgit 


From 9fc321c9768d1a18893e14f46b0ebacef1be1db4 Mon Sep 17 00:00:00 2001
From: LW <git@llllvvuu.dev>
Date: Thu, 14 Sep 2023 03:36:16 -0700
Subject: refactor(treesitter): deprecate for_each_child #25118

The name for_each_child is misleading and caused bugs.
After #25111, #25115, there are no more usages of `for_each_child` in Nvim.

In the future if we want to restore this functionality we can consider a
generalized vim.traverse(node, key, visitor) function.
---
 runtime/lua/vim/treesitter/languagetree.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 6037b17b20..1ea0f6b2b9 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -451,11 +451,14 @@ function LanguageTree:parse(range)
   return self._trees
 end
 
+---@deprecated Misleading name. Use `LanguageTree:children()` (non-recursive) instead,
+---            add recursion yourself if needed.
 --- Invokes the callback for each |LanguageTree| and its children recursively
 ---
 ---@param fn fun(tree: LanguageTree, lang: string)
 ---@param include_self boolean|nil Whether to include the invoking tree in the results
 function LanguageTree:for_each_child(fn, include_self)
+  vim.deprecate('LanguageTree:for_each_child()', 'LanguageTree:children()', '0.11')
   if include_self then
     fn(self, self._lang)
   end
-- 
cgit 


From 2e92065686f62851318150a315591c30b8306a4b Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Thu, 14 Sep 2023 08:23:01 -0500
Subject: docs: replace <pre> with ``` (#25136)

---
 runtime/lua/vim/F.lua                       |   5 +-
 runtime/lua/vim/_editor.lua                 |  96 ++++++------
 runtime/lua/vim/_meta/api.lua               |  96 +++++++-----
 runtime/lua/vim/_meta/builtin.lua           |  48 +++---
 runtime/lua/vim/_meta/diff.lua              |  35 +++--
 runtime/lua/vim/_meta/json.lua              |  37 +++--
 runtime/lua/vim/_meta/misc.lua              |   8 +-
 runtime/lua/vim/_meta/options.lua           |  52 +++++--
 runtime/lua/vim/_meta/spell.lua             |  15 +-
 runtime/lua/vim/_options.lua                | 231 ++++++++++++++++------------
 runtime/lua/vim/diagnostic.lua              |  32 ++--
 runtime/lua/vim/filetype.lua                | 101 ++++++------
 runtime/lua/vim/fs.lua                      |  27 ++--
 runtime/lua/vim/highlight.lua               |  31 ++--
 runtime/lua/vim/keymap.lua                  |  39 ++---
 runtime/lua/vim/lsp.lua                     |  17 +-
 runtime/lua/vim/lsp/buf.lua                 |  23 ++-
 runtime/lua/vim/lsp/codelens.lua            |   6 +-
 runtime/lua/vim/lsp/diagnostic.lua          |  10 +-
 runtime/lua/vim/lsp/handlers.lua            |  43 +++---
 runtime/lua/vim/lsp/semantic_tokens.lua     |   7 +-
 runtime/lua/vim/shared.lua                  | 120 ++++++++-------
 runtime/lua/vim/treesitter.lua              |  11 +-
 runtime/lua/vim/treesitter/languagetree.lua |  12 +-
 runtime/lua/vim/treesitter/query.lua        |  18 ++-
 runtime/lua/vim/ui.lua                      |  54 +++----
 runtime/lua/vim/version.lua                 | 131 ++++++++--------
 27 files changed, 723 insertions(+), 582 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/F.lua b/runtime/lua/vim/F.lua
index 16c834b371..5ed60ca8ab 100644
--- a/runtime/lua/vim/F.lua
+++ b/runtime/lua/vim/F.lua
@@ -5,13 +5,14 @@ local F = {}
 --- If all arguments are nil, returns nil.
 ---
 --- Examples:
---- <pre>
+---
+--- ```lua
 --- local a = nil
 --- local b = nil
 --- local c = 42
 --- local d = true
 --- assert(vim.F.if_nil(a, b, c, d) == 42)
---- </pre>
+--- ```
 ---
 ---@param ... any
 ---@return any
diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 64aeb64736..0215cae0cb 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -70,23 +70,24 @@ vim.log = {
 --- Run a system command
 ---
 --- Examples:
---- <pre>lua
 ---
----   local on_exit = function(obj)
----     print(obj.code)
----     print(obj.signal)
----     print(obj.stdout)
----     print(obj.stderr)
----   end
+--- ```lua
 ---
----   -- Run asynchronously
----   vim.system({'echo', 'hello'}, { text = true }, on_exit)
+--- local on_exit = function(obj)
+---   print(obj.code)
+---   print(obj.signal)
+---   print(obj.stdout)
+---   print(obj.stderr)
+--- end
 ---
----   -- Run synchronously
----   local obj = vim.system({'echo', 'hello'}, { text = true }):wait()
----   -- { code = 0, signal = 0, stdout = 'hello', stderr = '' }
+--- -- Run asynchronously
+--- vim.system({'echo', 'hello'}, { text = true }, on_exit)
 ---
---- </pre>
+--- -- Run synchronously
+--- local obj = vim.system({'echo', 'hello'}, { text = true }):wait()
+--- -- { code = 0, signal = 0, stdout = 'hello', stderr = '' }
+---
+--- ```
 ---
 --- See |uv.spawn()| for more details.
 ---
@@ -200,7 +201,8 @@ do
   --- (such as the |TUI|) pastes text into the editor.
   ---
   --- Example: To remove ANSI color codes when pasting:
-  --- <pre>lua
+  ---
+  --- ```lua
   --- vim.paste = (function(overridden)
   ---   return function(lines, phase)
   ---     for i,line in ipairs(lines) do
@@ -210,7 +212,7 @@ do
   ---     overridden(lines, phase)
   ---   end
   --- end)(vim.paste)
-  --- </pre>
+  --- ```
   ---
   ---@see |paste|
   ---@alias paste_phase -1 | 1 | 2 | 3
@@ -361,32 +363,33 @@ local VIM_CMD_ARG_MAX = 20
 --- command.
 ---
 --- Example:
---- <pre>lua
----   vim.cmd('echo 42')
----   vim.cmd([[
----     augroup My_group
----       autocmd!
----       autocmd FileType c setlocal cindent
----     augroup END
----   ]])
 ---
----   -- Ex command :echo "foo"
----   -- Note string literals need to be double quoted.
----   vim.cmd('echo "foo"')
----   vim.cmd { cmd = 'echo', args = { '"foo"' } }
----   vim.cmd.echo({ args = { '"foo"' } })
----   vim.cmd.echo('"foo"')
+--- ```lua
+--- vim.cmd('echo 42')
+--- vim.cmd([[
+---   augroup My_group
+---     autocmd!
+---     autocmd FileType c setlocal cindent
+---   augroup END
+--- ]])
+---
+--- -- Ex command :echo "foo"
+--- -- Note string literals need to be double quoted.
+--- vim.cmd('echo "foo"')
+--- vim.cmd { cmd = 'echo', args = { '"foo"' } }
+--- vim.cmd.echo({ args = { '"foo"' } })
+--- vim.cmd.echo('"foo"')
 ---
----   -- Ex command :write! myfile.txt
----   vim.cmd('write! myfile.txt')
----   vim.cmd { cmd = 'write', args = { "myfile.txt" }, bang = true }
----   vim.cmd.write { args = { "myfile.txt" }, bang = true }
----   vim.cmd.write { "myfile.txt", bang = true }
+--- -- Ex command :write! myfile.txt
+--- vim.cmd('write! myfile.txt')
+--- vim.cmd { cmd = 'write', args = { "myfile.txt" }, bang = true }
+--- vim.cmd.write { args = { "myfile.txt" }, bang = true }
+--- vim.cmd.write { "myfile.txt", bang = true }
 ---
----   -- Ex command :colorscheme blue
----   vim.cmd('colorscheme blue')
----   vim.cmd.colorscheme('blue')
---- </pre>
+--- -- Ex command :colorscheme blue
+--- vim.cmd('colorscheme blue')
+--- vim.cmd.colorscheme('blue')
+--- ```
 ---
 ---@param command string|table Command(s) to execute.
 ---                            If a string, executes multiple lines of Vim script at once. In this
@@ -871,9 +874,10 @@ end
 --- "Pretty prints" the given arguments and returns them unmodified.
 ---
 --- Example:
---- <pre>lua
----   local hl_normal = vim.print(vim.api.nvim_get_hl_by_name('Normal', true))
---- </pre>
+---
+--- ```lua
+--- local hl_normal = vim.print(vim.api.nvim_get_hl_by_name('Normal', true))
+--- ```
 ---
 --- @see |vim.inspect()|
 --- @see |:=|
@@ -900,10 +904,12 @@ end
 --- Translate keycodes.
 ---
 --- Example:
---- <pre>lua
----   local k = vim.keycode
----   vim.g.mapleader = k'<bs>'
---- </pre>
+---
+--- ```lua
+--- local k = vim.keycode
+--- vim.g.mapleader = k'<bs>'
+--- ```
+---
 --- @param str string String to be converted.
 --- @return string
 --- @see |nvim_replace_termcodes()|
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 7cd0d825a1..6573c68493 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -127,11 +127,16 @@ function vim.api.nvim__unpack(str) end
 function vim.api.nvim_buf_add_highlight(buffer, ns_id, hl_group, line, col_start, col_end) end
 
 --- Activates buffer-update events on a channel, or as Lua callbacks.
---- Example (Lua): capture buffer updates in a global `events` variable (use "vim.print(events)" to see its contents):
+--- Example (Lua): capture buffer updates in a global `events` variable (use
+--- "vim.print(events)" to see its contents):
+---
 --- ```lua
----   events = {}
----   vim.api.nvim_buf_attach(0, false, {
----     on_lines=function(...) table.insert(events, {...}) end})
+---     events = {}
+---     vim.api.nvim_buf_attach(0, false, {
+---       on_lines = function(...)
+---         table.insert(events, {...})
+---       end,
+---     })
 --- ```
 ---
 --- @param buffer integer Buffer handle, or 0 for current buffer
@@ -314,29 +319,32 @@ function vim.api.nvim_buf_get_extmark_by_id(buffer, ns_id, id, opts) end
 --- Region can be given as (row,col) tuples, or valid extmark ids (whose
 --- positions define the bounds). 0 and -1 are understood as (0,0) and (-1,-1)
 --- respectively, thus the following are equivalent:
+---
 --- ```lua
----   vim.api.nvim_buf_get_extmarks(0, my_ns, 0, -1, {})
----   vim.api.nvim_buf_get_extmarks(0, my_ns, {0,0}, {-1,-1}, {})
+---     vim.api.nvim_buf_get_extmarks(0, my_ns, 0, -1, {})
+---     vim.api.nvim_buf_get_extmarks(0, my_ns, {0,0}, {-1,-1}, {})
 --- ```
+---
 --- If `end` is less than `start`, traversal works backwards. (Useful with
 --- `limit`, to get the first marks prior to a given position.)
 --- Note: when using extmark ranges (marks with a end_row/end_col position)
 --- the `overlap` option might be useful. Otherwise only the start position of
 --- an extmark will be considered.
 --- Example:
+---
 --- ```lua
----   local api = vim.api
----   local pos = api.nvim_win_get_cursor(0)
----   local ns  = api.nvim_create_namespace('my-plugin')
----   -- Create new extmark at line 1, column 1.
----   local m1  = api.nvim_buf_set_extmark(0, ns, 0, 0, {})
----   -- Create new extmark at line 3, column 1.
----   local m2  = api.nvim_buf_set_extmark(0, ns, 2, 0, {})
----   -- Get extmarks only from line 3.
----   local ms  = api.nvim_buf_get_extmarks(0, ns, {2,0}, {2,0}, {})
----   -- Get all marks in this buffer + namespace.
----   local all = api.nvim_buf_get_extmarks(0, ns, 0, -1, {})
----   vim.print(ms)
+---     local api = vim.api
+---     local pos = api.nvim_win_get_cursor(0)
+---     local ns  = api.nvim_create_namespace('my-plugin')
+---     -- Create new extmark at line 1, column 1.
+---     local m1  = api.nvim_buf_set_extmark(0, ns, 0, 0, {})
+---     -- Create new extmark at line 3, column 1.
+---     local m2  = api.nvim_buf_set_extmark(0, ns, 2, 0, {})
+---     -- Get extmarks only from line 3.
+---     local ms  = api.nvim_buf_get_extmarks(0, ns, {2,0}, {2,0}, {})
+---     -- Get all marks in this buffer + namespace.
+---     local all = api.nvim_buf_get_extmarks(0, ns, 0, -1, {})
+---     vim.print(ms)
 --- ```
 ---
 --- @param buffer integer Buffer handle, or 0 for current buffer
@@ -775,6 +783,7 @@ function vim.api.nvim_command_output(command) end
 
 --- Create or get an autocommand group `autocmd-groups`.
 --- To get an existing group id, do:
+---
 --- ```lua
 ---     local id = vim.api.nvim_create_augroup("MyGroup", {
 ---         clear = false
@@ -790,6 +799,7 @@ function vim.api.nvim_create_augroup(name, opts) end
 
 --- Creates an `autocommand` event handler, defined by `callback` (Lua function or Vimscript function name string) or `command` (Ex command string).
 --- Example using Lua callback:
+---
 --- ```lua
 ---     vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, {
 ---       pattern = {"*.c", "*.h"},
@@ -798,17 +808,21 @@ function vim.api.nvim_create_augroup(name, opts) end
 ---       end
 ---     })
 --- ```
+---
 --- Example using an Ex command as the handler:
+---
 --- ```lua
 ---     vim.api.nvim_create_autocmd({"BufEnter", "BufWinEnter"}, {
 ---       pattern = {"*.c", "*.h"},
 ---       command = "echo 'Entering a C or C++ file'",
 ---     })
 --- ```
---- Note: `pattern` is NOT automatically expanded (unlike with `:autocmd`), thus names like
---- "$HOME" and "~" must be expanded explicitly:
+---
+--- Note: `pattern` is NOT automatically expanded (unlike with `:autocmd`),
+--- thus names like "$HOME" and "~" must be expanded explicitly:
+---
 --- ```lua
----   pattern = vim.fn.expand("~") .. "/some/path/*.py"
+---     pattern = vim.fn.expand("~") .. "/some/path/*.py"
 --- ```
 ---
 --- @param event any (string|array) Event(s) that will trigger the handler
@@ -870,10 +884,11 @@ function vim.api.nvim_create_namespace(name) end
 --- Creates a global `user-commands` command.
 --- For Lua usage see `lua-guide-commands-create`.
 --- Example:
+---
 --- ```vim
----    :call nvim_create_user_command('SayHello', 'echo "Hello world!"', {'bang': v:true})
----    :SayHello
----    Hello world!
+---     :call nvim_create_user_command('SayHello', 'echo "Hello world!"', {'bang': v:true})
+---     :SayHello
+---     Hello world!
 --- ```
 ---
 --- @param name string Name of the new user command. Must begin with an uppercase
@@ -1084,6 +1099,7 @@ function vim.api.nvim_execute_lua(code, args) end
 --- with escape_ks=false) to replace `keycodes`, then pass the result to
 --- nvim_feedkeys().
 --- Example:
+---
 --- ```vim
 ---     :let key = nvim_replace_termcodes("<C-o>", v:true, v:false, v:true)
 ---     :call nvim_feedkeys(key, 'n', v:false)
@@ -1111,19 +1127,21 @@ function vim.api.nvim_get_api_info() end
 
 --- Get all autocommands that match the corresponding {opts}.
 --- These examples will get autocommands matching ALL the given criteria:
+---
 --- ```lua
----   -- Matches all criteria
----   autocommands = vim.api.nvim_get_autocmds({
----     group = "MyGroup",
----     event = {"BufEnter", "BufWinEnter"},
----     pattern = {"*.c", "*.h"}
----   })
----
----   -- All commands from one group
----   autocommands = vim.api.nvim_get_autocmds({
----     group = "MyGroup",
----   })
+---     -- Matches all criteria
+---     autocommands = vim.api.nvim_get_autocmds({
+---       group = "MyGroup",
+---       event = {"BufEnter", "BufWinEnter"},
+---       pattern = {"*.c", "*.h"}
+---     })
+---
+---     -- All commands from one group
+---     autocommands = vim.api.nvim_get_autocmds({
+---       group = "MyGroup",
+---     })
 --- ```
+---
 --- NOTE: When multiple patterns or events are provided, it will find all the
 --- autocommands that match any combination of them.
 ---
@@ -1149,6 +1167,7 @@ function vim.api.nvim_get_chan_info(chan) end
 --- Returns the 24-bit RGB value of a `nvim_get_color_map()` color name or
 --- "#rrggbb" hexadecimal string.
 --- Example:
+---
 --- ```vim
 ---     :echo nvim_get_color_by_name("Pink")
 ---     :echo nvim_get_color_by_name("#cbcbcb")
@@ -1471,14 +1490,18 @@ function vim.api.nvim_open_term(buffer, opts) end
 --- could let floats hover outside of the main window like a tooltip, but this
 --- should not be used to specify arbitrary WM screen positions.
 --- Example (Lua): window-relative float
+---
 --- ```lua
 ---     vim.api.nvim_open_win(0, false,
 ---       {relative='win', row=3, col=3, width=12, height=3})
 --- ```
+---
 --- Example (Lua): buffer-relative float (travels as buffer is scrolled)
+---
 --- ```lua
 ---     vim.api.nvim_open_win(0, false,
 ---       {relative='win', width=12, height=3, bufpos={100,10}})
+---     })
 --- ```
 ---
 --- @param buffer integer Buffer to display, or 0 for current buffer
@@ -1856,10 +1879,13 @@ function vim.api.nvim_set_hl_ns_fast(ns_id) end
 --- Unlike `:map`, leading/trailing whitespace is accepted as part of the
 --- {lhs} or {rhs}. Empty {rhs} is `<Nop>`. `keycodes` are replaced as usual.
 --- Example:
+---
 --- ```vim
 ---     call nvim_set_keymap('n', ' <NL>', '', {'nowait': v:true})
 --- ```
+---
 --- is equivalent to:
+---
 --- ```vim
 ---     nmap <nowait> <Space><NL> <Nop>
 --- ```
diff --git a/runtime/lua/vim/_meta/builtin.lua b/runtime/lua/vim/_meta/builtin.lua
index d7b76a803c..0a6dd3e151 100644
--- a/runtime/lua/vim/_meta/builtin.lua
+++ b/runtime/lua/vim/_meta/builtin.lua
@@ -131,7 +131,8 @@ function vim.str_utf_pos(str) end
 --- The result can be added to {index} to get the starting byte of a character.
 ---
 --- Examples:
---- <pre>lua
+---
+--- ```lua
 --- -- The character 'æ' is stored as the bytes '\xc3\xa6' (using UTF-8)
 ---
 --- -- Returns 0 because the index is pointing at the first byte of a character
@@ -139,7 +140,7 @@ function vim.str_utf_pos(str) end
 ---
 --- -- Returns -1 because the index is pointing at the second byte of a character
 --- vim.str_utf_start('æ', 2)
---- </pre>
+--- ```
 ---
 --- @param str string
 --- @param index number
@@ -150,7 +151,8 @@ function vim.str_utf_start(str, index) end
 --- to.
 ---
 --- Examples:
---- <pre>lua
+---
+--- ```lua
 --- -- The character 'æ' is stored as the bytes '\xc3\xa6' (using UTF-8)
 ---
 --- -- Returns 0 because the index is pointing at the last byte of a character
@@ -158,7 +160,7 @@ function vim.str_utf_start(str, index) end
 ---
 --- -- Returns 1 because the index is pointing at the penultimate byte of a character
 --- vim.str_utf_end('æ', 1)
---- </pre>
+--- ```
 ---
 --- @param str string
 --- @param index number
@@ -204,7 +206,8 @@ function vim.schedule(callback) end
 --- this time.
 ---
 --- Examples:
---- <pre>lua
+---
+--- ```lua
 ---
 --- ---
 --- -- Wait for 100 ms, allowing other events to process
@@ -226,7 +229,7 @@ function vim.schedule(callback) end
 --- if vim.wait(10000, function() return vim.g.timer_result end) then
 ---   print('Only waiting a little bit of time!')
 --- end
---- </pre>
+--- ```
 ---
 --- @param time integer Number of milliseconds to wait
 --- @param callback? fun(): boolean Optional callback. Waits until {callback} returns true
@@ -258,22 +261,23 @@ function vim.wait(time, callback, interval, fast_only) end
 --- likewise experimental).
 ---
 --- Example (stub for a |ui-popupmenu| implementation):
---- <pre>lua
----
----   ns = vim.api.nvim_create_namespace('my_fancy_pum')
----
----   vim.ui_attach(ns, {ext_popupmenu=true}, function(event, ...)
----     if event == "popupmenu_show" then
----       local items, selected, row, col, grid = ...
----       print("display pum ", #items)
----     elseif event == "popupmenu_select" then
----       local selected = ...
----       print("selected", selected)
----     elseif event == "popupmenu_hide" then
----       print("FIN")
----     end
----   end)
---- </pre>
+---
+--- ```lua
+--- ns = vim.api.nvim_create_namespace('my_fancy_pum')
+---
+--- vim.ui_attach(ns, {ext_popupmenu=true}, function(event, ...)
+---   if event == "popupmenu_show" then
+---     local items, selected, row, col, grid = ...
+---     print("display pum ", #items)
+---   elseif event == "popupmenu_select" then
+---     local selected = ...
+---     print("selected", selected)
+---   elseif event == "popupmenu_hide" then
+---     print("FIN")
+---   end
+--- end)
+--- ```
+---
 --- @param ns integer
 --- @param options table<string, any>
 --- @param callback fun()
diff --git a/runtime/lua/vim/_meta/diff.lua b/runtime/lua/vim/_meta/diff.lua
index 246ac0c75a..f265139448 100644
--- a/runtime/lua/vim/_meta/diff.lua
+++ b/runtime/lua/vim/_meta/diff.lua
@@ -6,24 +6,25 @@
 --- either directly or via callback arguments, are 1-based.
 ---
 --- Examples:
---- <pre>lua
----     vim.diff('a\\n', 'b\\nc\\n')
----     -- =>
----     -- @@ -1 +1,2 @@
----     -- -a
----     -- +b
----     -- +c
 ---
----     vim.diff('a\\n', 'b\\nc\\n', {result_type = 'indices'})
----     -- =>
----     -- {
----     --   {1, 1, 1, 2}
----     -- }
---- </pre>
+--- ```lua
+--- vim.diff('a\n', 'b\nc\n')
+--- -- =>
+--- -- @@ -1 +1,2 @@
+--- -- -a
+--- -- +b
+--- -- +c
 ---
---- @param a string First string to compare
---- @param b string Second string to compare
---- @param opts table<string,any> Optional parameters:
+--- vim.diff('a\n', 'b\nc\n', {result_type = 'indices'})
+--- -- =>
+--- -- {
+--- --   {1, 1, 1, 2}
+--- -- }
+--- ```
+---
+---@param a string First string to compare
+---@param b string Second string to compare
+---@param opts table<string,any> Optional parameters:
 ---     - `on_hunk` (callback):
 ---       Invoked for each hunk in the diff. Return a negative number
 ---       to cancel the callback for any remaining hunks.
@@ -64,6 +65,6 @@
 ---       Use the indent heuristic for the internal
 ---       diff library.
 ---
---- @return string|table|nil
+---@return string|table|nil
 ---     See {opts.result_type}. `nil` if {opts.on_hunk} is given.
 function vim.diff(a, b, opts) end
diff --git a/runtime/lua/vim/_meta/json.lua b/runtime/lua/vim/_meta/json.lua
index 76a6c7b733..edf905c7c6 100644
--- a/runtime/lua/vim/_meta/json.lua
+++ b/runtime/lua/vim/_meta/json.lua
@@ -1,8 +1,8 @@
---- @meta
+---@meta
 
 -- luacheck: no unused args
 
---- @defgroup vim.json
+---@defgroup vim.json
 ---
 --- This module provides encoding and decoding of Lua objects to and
 --- from JSON-encoded strings. Supports |vim.NIL| and |vim.empty_dict()|.
@@ -14,24 +14,23 @@
 --- - Decodes empty array as `{}` (empty Lua table).
 ---
 --- Example:
---- <pre>lua
---- :lua vim.print(vim.json.decode('{"bar":[],"foo":{},"zub":null}'))
---- --> { bar = {}, foo = vim.empty_dict(), zub = vim.NIL }
---- </pre>
---- Parameters: ~
----   • {str}    Stringified JSON data.
----   • {opts}   Options map keys:
----              • luanil: { object: bool, array: bool }
----                • `luanil.object=true` converts `null` in JSON objects to
----                  Lua `nil` instead of `vim.NIL`.
----                • `luanil.array=true` converts `null` in JSON arrays to Lua
----                  `nil` instead of `vim.NIL`.
---- @param str string
---- @param opts? table<string, any>
---- @return any
+---
+--- ```lua
+--- vim.print(vim.json.decode('{"bar":[],"foo":{},"zub":null}'))
+--- -- { bar = {}, foo = vim.empty_dict(), zub = vim.NIL }
+--- ```
+---
+---@param str string Stringified JSON data.
+---@param opts? table<string,any> Options table with keys:
+---                                 - luanil: (table) Table with keys:
+---                                   * object: (boolean) When true, converts `null` in JSON objects
+---                                                       to Lua `nil` instead of |vim.NIL|.
+---                                   * array: (boolean) When true, converts `null` in JSON arrays
+---                                                      to Lua `nil` instead of |vim.NIL|.
+---@return any
 function vim.json.decode(str, opts) end
 
 --- Encodes (or "packs") Lua object {obj} as JSON in a Lua string.
---- @param obj any
---- @return string
+---@param obj any
+---@return string
 function vim.json.encode(obj) end
diff --git a/runtime/lua/vim/_meta/misc.lua b/runtime/lua/vim/_meta/misc.lua
index 8a76755962..0d70e16314 100644
--- a/runtime/lua/vim/_meta/misc.lua
+++ b/runtime/lua/vim/_meta/misc.lua
@@ -5,9 +5,11 @@
 --- Invokes |vim-function| or |user-function| {func} with arguments {...}.
 --- See also |vim.fn|.
 --- Equivalent to:
---- <pre>lua
----     vim.fn[func]({...})
---- </pre>
+---
+--- ```lua
+--- vim.fn[func]({...})
+--- ```
+---
 --- @param func fun()
 --- @param ... any
 function vim.call(func, ...) end
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 92dc4b2c7f..af676fa961 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -141,6 +141,7 @@ vim.bo.ai = vim.bo.autoindent
 --- 	:set autoread<
 --- ```
 ---
+---
 --- @type boolean
 vim.o.autoread = true
 vim.o.ar = vim.o.autoread
@@ -354,6 +355,7 @@ vim.go.bkc = vim.go.backupcopy
 --- ```
 ---     :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
 --- ```
+---
 --- See also 'backup' and 'writebackup' options.
 --- If you want to hide your backup files on Unix, consider this value:
 --- ```
@@ -409,9 +411,9 @@ vim.go.bex = vim.go.backupext
 ---
 --- Note that environment variables are not expanded.  If you want to use
 --- $HOME you must expand it explicitly, e.g.:
---- ```
---- 	:let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
 ---
+--- ```vim
+--- 	:let &backupskip = escape(expand('$HOME'), '\') .. '/tmp/*'
 --- ```
 --- Note that the default also makes sure that "crontab -e" works (when a
 --- backup would be made by renaming the original file crontab won't see
@@ -833,6 +835,7 @@ vim.bo.cino = vim.bo.cinoptions
 --- 	set cinscopedecls+=signals,public\ slots,private\ slots
 --- ```
 ---
+---
 --- @type string
 vim.o.cinscopedecls = "public,protected,private"
 vim.o.cinsd = vim.o.cinscopedecls
@@ -916,11 +919,11 @@ vim.go.cwh = vim.go.cmdwinheight
 --- The screen column can be an absolute number, or a number preceded with
 --- '+' or '-', which is added to or subtracted from 'textwidth'.
 --- ```
----
 --- 	:set cc=+1	  " highlight column after 'textwidth'
 --- 	:set cc=+1,+2,+3  " highlight three columns after 'textwidth'
 --- 	:hi ColorColumn ctermbg=lightgrey guibg=lightgrey
 --- ```
+---
 --- When 'textwidth' is zero then the items with '-' and '+' are not used.
 --- A maximum of 256 columns are highlighted.
 ---
@@ -1418,6 +1421,7 @@ vim.wo.crb = vim.wo.cursorbind
 --- 	au WinEnter * set cursorline cursorcolumn
 --- ```
 ---
+---
 --- @type boolean
 vim.o.cursorcolumn = false
 vim.o.cuc = vim.o.cursorcolumn
@@ -1499,6 +1503,7 @@ vim.go.debug = vim.o.debug
 --- 	let &l:define = '^\s*\ze\k\+\s*=\s*function('
 --- ```
 ---
+---
 --- @type string
 vim.o.define = ""
 vim.o.def = vim.o.define
@@ -1679,6 +1684,7 @@ vim.go.dex = vim.go.diffexpr
 --- 	:set diffopt-=internal  " do NOT use the internal diff parser
 --- ```
 ---
+---
 --- @type string
 vim.o.diffopt = "internal,filler,closeoff"
 vim.o.dip = vim.o.diffopt
@@ -1729,6 +1735,7 @@ vim.go.dg = vim.go.digraph
 --- ```
 ---     :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
 --- ```
+---
 --- Editing the same file twice will result in a warning.  Using "/tmp" on
 --- is discouraged: if the system crashes you lose the swap file. And
 --- others on the computer may be able to see the files.
@@ -1917,6 +1924,7 @@ vim.go.efm = vim.go.errorformat
 ---     :set ei=WinEnter,WinLeave
 --- ```
 ---
+---
 --- @type string
 vim.o.eventignore = ""
 vim.o.ei = vim.o.eventignore
@@ -2634,14 +2642,12 @@ vim.go.gp = vim.go.grepprg
 --- To disable cursor-styling, reset the option:
 --- ```
 --- 	:set guicursor=
----
 --- ```
 --- To enable mode shapes, "Cursor" highlight, and blinking:
 --- ```
 --- 	:set guicursor=n-v-c:block,i-ci-ve:ver25,r-cr:hor20,o:hor50
 --- 	  \,a:blinkwait700-blinkoff400-blinkon250-Cursor/lCursor
 --- 	  \,sm:block-blinkwait175-blinkoff150-blinkon175
----
 --- ```
 --- The option is a comma-separated list of parts.  Each part consists of a
 --- mode-list and an argument-list:
@@ -2719,6 +2725,7 @@ vim.go.gp = vim.go.grepprg
 ---     :highlight Cursor gui=NONE guifg=bg guibg=fg
 --- ```
 ---
+---
 --- @type string
 vim.o.guicursor = "n-v-c-sm:block,i-ci-ve:ver25,r-cr-o:hor20"
 vim.o.gcr = vim.o.guicursor
@@ -2790,6 +2797,7 @@ vim.go.gcr = vim.go.guicursor
 ---     :set guifont=Andale_Mono:h7.5:w4.5
 --- ```
 ---
+---
 --- @type string
 vim.o.guifont = ""
 vim.o.gfn = vim.o.guifont
@@ -2944,6 +2952,7 @@ vim.go.gtl = vim.go.guitablabel
 --- 	:let &guitabtooltip = "line one\nline two"
 --- ```
 ---
+---
 --- @type string
 vim.o.guitabtooltip = ""
 vim.o.gtt = vim.o.guitabtooltip
@@ -3206,6 +3215,7 @@ vim.go.inc = vim.go.include
 --- ```
 --- 	:setlocal includeexpr=tr(v:fname,'.','/')
 --- ```
+---
 --- Also used for the `gf` command if an unmodified file name can't be
 --- found.  Allows doing "gf" on the name after an 'include' statement.
 --- Also used for `<cfile>`.
@@ -3258,6 +3268,7 @@ vim.bo.inex = vim.bo.includeexpr
 --- 	  autocmd CmdlineLeave /,\? :set nohlsearch
 --- 	augroup END
 --- ```
+---
 --- CTRL-L can be used to add one character from after the current match
 --- to the command line.  If 'ignorecase' and 'smartcase' are set and the
 --- command line has no uppercase characters, the added character is
@@ -3565,6 +3576,7 @@ vim.go.kp = vim.go.keywordprg
 --- ```
 ---     :set langmap=zy,yz,ZY,YZ
 --- ```
+---
 --- The 'langmap' option is a list of parts, separated with commas.  Each
 --- part can be in one of two forms:
 --- 1.  A list of pairs.  Each pair is a "from" character immediately
@@ -3762,6 +3774,7 @@ vim.go.lw = vim.go.lispwords
 --- ```
 --- 	:set list lcs=tab:\ \
 --- ```
+---
 --- Note that list mode will also affect formatting (set with 'textwidth'
 --- or 'wrapmargin') when 'cpoptions' includes 'L'.  See 'listchars' for
 --- changing the way tabs are displayed.
@@ -3790,6 +3803,7 @@ vim.wo.list = vim.o.list
 --- 			>--
 --- 			etc.
 --- ```
+---
 ---   tab:xyz	The 'z' is always used, then 'x' is prepended, and
 --- 		then 'y' is used as many times as will fit.  Thus
 --- 		"tab:<->" displays:
@@ -3801,6 +3815,7 @@ vim.wo.list = vim.o.list
 --- 			<-->
 --- 			etc.
 --- ```
+---
 --- 		When "tab:" is omitted, a tab is shown as ^I.
 --- 						*lcs-space*
 ---   space:c	Character to show for a space.  When omitted, spaces
@@ -3816,6 +3831,7 @@ vim.wo.list = vim.o.list
 --- ```
 --- 			---+---+--
 --- ```
+---
 --- 						*lcs-lead*
 ---   lead:c	Character to show for leading spaces.  When omitted,
 --- 		leading spaces are blank.  Overrides the "space" and
@@ -3824,6 +3840,7 @@ vim.wo.list = vim.o.list
 --- ```
 --- 			:set listchars+=tab:>-,lead:.
 --- ```
+---
 --- 						*lcs-leadmultispace*
 ---   leadmultispace:c...
 --- 		Like the `lcs-multispace` value, but for leading
@@ -3834,6 +3851,7 @@ vim.wo.list = vim.o.list
 --- ```
 --- 			---+---+--XXX
 --- ```
+---
 --- 		Where "XXX" denotes the first non-blank characters in
 --- 		the line.
 --- 						*lcs-trail*
@@ -3941,6 +3959,7 @@ vim.go.mef = vim.go.makeef
 --- 	:set makeencoding=char	" system locale is used
 --- ```
 ---
+---
 --- @type string
 vim.o.makeencoding = ""
 vim.o.menc = vim.o.makeencoding
@@ -3986,13 +4005,11 @@ vim.go.mp = vim.go.makeprg
 --- '>' (for HTML):
 --- ```
 --- 	:set mps+=<:>
----
 --- ```
 --- A more exotic example, to jump between the '=' and ';' in an
 --- assignment, useful for languages like C and Java:
 --- ```
 --- 	:au FileType c,cpp,java set mps+==:;
----
 --- ```
 --- For a more advanced way of using "%", see the matchit.vim plugin in
 --- the $VIMRUNTIME/plugin directory. `add-local-help`
@@ -4078,6 +4095,7 @@ vim.go.mis = vim.go.menuitems
 --- ```
 --- 	{start},{inc},{added}
 --- ```
+---
 --- For most languages the uncompressed word tree fits in memory.  {start}
 --- gives the amount of memory in Kbyte that can be used before any
 --- compression is done.  It should be a bit smaller than the amount of
@@ -4196,6 +4214,7 @@ vim.go.more = vim.o.more
 --- ```
 --- 	:set mouse=nv
 --- ```
+---
 --- To temporarily disable mouse support, hold the shift key while using
 --- the mouse.
 ---
@@ -4299,6 +4318,7 @@ vim.go.mh = vim.go.mousehide
 ---    :map <4-S-LeftDrag>    <4-RightDrag>
 ---    :map <4-S-LeftRelease> <4-RightRelease>
 --- ```
+---
 --- Mouse commands requiring the CTRL modifier can be simulated by typing
 --- the "g" key before using the mouse:
 ---     "g<LeftMouse>"  is "<C-LeftMouse>	(jump to tag under mouse click)
@@ -4477,6 +4497,7 @@ vim.bo.nf = vim.bo.nrformats
 ---     |there          |  4 there      |  1 there      |  1 there
 --- ```
 ---
+---
 --- @type boolean
 vim.o.number = false
 vim.o.nu = vim.o.number
@@ -4710,10 +4731,10 @@ vim.wo.pvw = vim.wo.previewwindow
 --- the popupmenu using `highlight-blend`. For instance, to enable
 --- transparency but force the current selected element to be fully opaque:
 --- ```
----
 --- 	:set pumblend=15
 --- 	:hi PmenuSel blend=0
 --- ```
+---
 --- UI-dependent. Works best with RGB colors. 'termguicolors'
 ---
 --- @type integer
@@ -4986,6 +5007,7 @@ vim.go.ru = vim.go.ruler
 --- 	:set rulerformat=%15(%c%V\ %p%%%)
 --- ```
 ---
+---
 --- @type string
 vim.o.rulerformat = ""
 vim.o.ruf = vim.o.rulerformat
@@ -5363,6 +5385,7 @@ vim.go.ssop = vim.go.sessionoptions
 --- ```
 ---     :set shada='50,<1000,s100,:0,n~/nvim/shada
 --- ```
+---
 --- '50		Marks will be remembered for the last 50 files you
 --- 		edited.
 --- <1000		Contents of registers (up to 1000 lines each) will be
@@ -5449,7 +5472,6 @@ vim.go.sdf = vim.go.shadafile
 --- 	let &shellredir = '2>&1 | %%{ "$_" } | Out-File %s; exit $LastExitCode'
 --- 	let &shellpipe  = '2>&1 | %%{ "$_" } | tee %s; exit $LastExitCode'
 --- 	set shellquote= shellxquote=
----
 --- ```
 --- This option cannot be set from a `modeline` or in the `sandbox`, for
 --- security reasons.
@@ -5726,6 +5748,7 @@ vim.go.shm = vim.go.shortmess
 --- 	:setlocal showbreak=NONE
 --- ```
 ---
+---
 --- @type string
 vim.o.showbreak = ""
 vim.o.sbr = vim.o.showbreak
@@ -5858,15 +5881,16 @@ vim.go.ss = vim.go.sidescroll
 --- 	setlocal sidescrolloff<
 --- 	setlocal sidescrolloff=-1
 --- ```
+---
 --- Example: Try this together with 'sidescroll' and 'listchars' as
 --- 	 in the following example to never allow the cursor to move
 --- 	 onto the "extends" character:
 --- ```
----
 --- 	 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
 --- 	 :set sidescrolloff=1
 --- ```
 ---
+---
 --- @type integer
 vim.o.sidescrolloff = 0
 vim.o.siso = vim.o.sidescrolloff
@@ -6171,6 +6195,7 @@ vim.bo.spo = vim.bo.spelloptions
 --- ```
 --- 	:set sps=file:~/.config/nvim/sugg,best,expr:MySuggest()
 --- ```
+---
 --- This option cannot be set from a `modeline` or in the `sandbox`, for
 --- security reasons.
 ---
@@ -6263,6 +6288,7 @@ vim.go.sol = vim.go.startofline
 --- handler should be written with this in mind.
 ---
 --- Examples:
+---
 --- ```vim
 --- 	" Relative number with bar separator and click handlers:
 --- 	:set statuscolumn=%@SignCb@%s%=%T%@NumCb@%r│%T
@@ -6282,7 +6308,6 @@ vim.go.sol = vim.go.startofline
 --- 	:let &stc='%#NonText#%{&nu?v:lnum:""}' .
 --- 	 '%=%{&rnu&&(v:lnum%2)?"\ ".v:relnum:""}' .
 --- 	 '%#LineNr#%{&rnu&&!(v:lnum%2)?"\ ".v:relnum:""}'
----
 --- ```
 --- WARNING: this expression is evaluated for each screen line so defining
 --- an expensive expression can negatively affect render performance.
@@ -6522,6 +6547,7 @@ vim.wo.stc = vim.wo.statuscolumn
 ---   :endfunction
 --- ```
 ---
+---
 --- @type string
 vim.o.statusline = ""
 vim.o.stl = vim.o.statusline
@@ -6553,6 +6579,7 @@ vim.go.su = vim.go.suffixes
 --- 	:set suffixesadd=.java
 --- ```
 ---
+---
 --- @type string
 vim.o.suffixesadd = ""
 vim.o.sua = vim.o.suffixesadd
@@ -7445,6 +7472,7 @@ vim.go.ww = vim.go.whichwrap
 --- 	:set wc=<Tab>
 --- ```
 ---
+---
 --- @type integer
 vim.o.wildchar = 9
 vim.o.wc = vim.o.wildchar
@@ -7533,6 +7561,7 @@ vim.go.wic = vim.go.wildignorecase
 --- 	:cnoremap <Left> <Space><BS><Left>
 --- 	:cnoremap <Right> <Space><BS><Right>
 --- ```
+---
 --- `hl-WildMenu` highlights the current match.
 ---
 --- @type boolean
@@ -7762,6 +7791,7 @@ vim.go.wh = vim.go.winheight
 --- 	set winhighlight=Normal:MyNormal,NormalNC:MyNormalNC
 --- ```
 ---
+---
 --- @type string
 vim.o.winhighlight = ""
 vim.o.winhl = vim.o.winhighlight
diff --git a/runtime/lua/vim/_meta/spell.lua b/runtime/lua/vim/_meta/spell.lua
index d55867f769..57f2180895 100644
--- a/runtime/lua/vim/_meta/spell.lua
+++ b/runtime/lua/vim/_meta/spell.lua
@@ -10,13 +10,14 @@
 --- the buffer. Consider calling this with |nvim_buf_call()|.
 ---
 --- Example:
---- <pre>lua
----     vim.spell.check("the quik brown fox")
----     -- =>
----     -- {
----     --     {'quik', 'bad', 5}
----     -- }
---- </pre>
+---
+--- ```lua
+--- vim.spell.check("the quik brown fox")
+--- -- =>
+--- -- {
+--- --     {'quik', 'bad', 5}
+--- -- }
+--- ```
 ---
 --- @param str string
 --- @return {[1]: string, [2]: string, [3]: string}[]
diff --git a/runtime/lua/vim/_options.lua b/runtime/lua/vim/_options.lua
index e1c125baf2..7b44f6b35f 100644
--- a/runtime/lua/vim/_options.lua
+++ b/runtime/lua/vim/_options.lua
@@ -7,11 +7,12 @@
 ---"references". |lua-guide-variables| For example, using \`vim.fn.remove()\` on
 ---a Lua list copies the list object to Vimscript and does NOT modify the Lua
 ---list:
----<pre>lua
----    local list = { 1, 2, 3 }
----    vim.fn.remove(list, 0)
----    vim.print(list)  --> "{ 1, 2, 3 }"
----</pre>
+---
+--- ```lua
+--- local list = { 1, 2, 3 }
+--- vim.fn.remove(list, 0)
+--- vim.print(list)  --> "{ 1, 2, 3 }"
+--- ```
 
 ---@addtogroup lua-vimscript
 ---@brief <pre>help
@@ -131,13 +132,17 @@ local function get_options_info(name)
   return info
 end
 
----Environment variables defined in the editor session.
----See |expand-env| and |:let-environment| for the Vimscript behavior.
----Invalid or unset key returns `nil`.
----Example: <pre>lua
----    vim.env.FOO = 'bar'
----    print(vim.env.TERM)
----</pre>
+--- Environment variables defined in the editor session.
+--- See |expand-env| and |:let-environment| for the Vimscript behavior.
+--- Invalid or unset key returns `nil`.
+---
+--- Example:
+---
+--- ```lua
+--- vim.env.FOO = 'bar'
+--- print(vim.env.TERM)
+--- ```
+---
 ---@param var string
 vim.env = setmetatable({}, {
   __index = function(_, k)
@@ -226,16 +231,18 @@ end
 ---global value of a |global-local| option, see |:setglobal|.
 ---</pre>
 
----Get or set |options|. Like `:set`. Invalid key is an error.
+--- Get or set |options|. Like `:set`. Invalid key is an error.
 ---
----Note: this works on both buffer-scoped and window-scoped options using the
----current buffer and window.
+--- Note: this works on both buffer-scoped and window-scoped options using the
+--- current buffer and window.
 ---
----Example: <pre>lua
----    vim.o.cmdheight = 4
----    print(vim.o.columns)
----    print(vim.o.foo)     -- error: invalid key
----</pre>
+--- Example:
+---
+--- ```lua
+--- vim.o.cmdheight = 4
+--- print(vim.o.columns)
+--- print(vim.o.foo)     -- error: invalid key
+--- ```
 vim.o = setmetatable({}, {
   __index = function(_, k)
     return api.nvim_get_option_value(k, {})
@@ -245,18 +252,20 @@ vim.o = setmetatable({}, {
   end,
 })
 
----Get or set global |options|. Like `:setglobal`. Invalid key is
----an error.
+--- Get or set global |options|. Like `:setglobal`. Invalid key is
+--- an error.
 ---
----Note: this is different from |vim.o| because this accesses the global
----option value and thus is mostly useful for use with |global-local|
----options.
+--- Note: this is different from |vim.o| because this accesses the global
+--- option value and thus is mostly useful for use with |global-local|
+--- options.
 ---
----Example: <pre>lua
----    vim.go.cmdheight = 4
----    print(vim.go.columns)
----    print(vim.go.bar)     -- error: invalid key
----</pre>
+--- Example:
+---
+--- ```lua
+--- vim.go.cmdheight = 4
+--- print(vim.go.columns)
+--- print(vim.go.bar)     -- error: invalid key
+--- ```
 vim.go = setmetatable({}, {
   __index = function(_, k)
     return api.nvim_get_option_value(k, { scope = 'global' })
@@ -266,37 +275,39 @@ vim.go = setmetatable({}, {
   end,
 })
 
----Get or set buffer-scoped |options| for the buffer with number {bufnr}.
----Like `:set` and `:setlocal`. If [{bufnr}] is omitted then the current
----buffer is used. Invalid {bufnr} or key is an error.
+--- Get or set buffer-scoped |options| for the buffer with number {bufnr}.
+--- Like `:set` and `:setlocal`. If [{bufnr}] is omitted then the current
+--- buffer is used. Invalid {bufnr} or key is an error.
 ---
----Note: this is equivalent to both `:set` and `:setlocal`.
+--- Note: this is equivalent to both `:set` and `:setlocal`.
 ---
----Example: <pre>lua
----    local bufnr = vim.api.nvim_get_current_buf()
----    vim.bo[bufnr].buflisted = true    -- same as vim.bo.buflisted = true
----    print(vim.bo.comments)
----    print(vim.bo.baz)                 -- error: invalid key
----</pre>
----@param bufnr integer|nil
+--- Example:
+---
+--- ```lua
+--- local bufnr = vim.api.nvim_get_current_buf()
+--- vim.bo[bufnr].buflisted = true    -- same as vim.bo.buflisted = true
+--- print(vim.bo.comments)
+--- print(vim.bo.baz)                 -- error: invalid key
+--- ```
 vim.bo = new_buf_opt_accessor()
 
----Get or set window-scoped |options| for the window with handle {winid} and
----buffer with number {bufnr}. Like `:setlocal` if {bufnr} is provided, like
----`:set` otherwise. If [{winid}] is omitted then the current window is
----used. Invalid {winid}, {bufnr} or key is an error.
+--- Get or set window-scoped |options| for the window with handle {winid} and
+--- buffer with number {bufnr}. Like `:setlocal` if {bufnr} is provided, like
+--- `:set` otherwise. If [{winid}] is omitted then the current window is
+--- used. Invalid {winid}, {bufnr} or key is an error.
 ---
----Note: only {bufnr} with value `0` (the current buffer in the window) is
----supported.
+--- Note: only {bufnr} with value `0` (the current buffer in the window) is
+--- supported.
 ---
----Example: <pre>lua
----    local winid = vim.api.nvim_get_current_win()
----    vim.wo[winid].number = true    -- same as vim.wo.number = true
----    print(vim.wo.foldmarker)
----    print(vim.wo.quux)             -- error: invalid key
----    vim.wo[winid][0].spell = false -- like ':setlocal nospell'
+--- Example:
 ---
----</pre>
+--- ```lua
+--- local winid = vim.api.nvim_get_current_win()
+--- vim.wo[winid].number = true    -- same as vim.wo.number = true
+--- print(vim.wo.foldmarker)
+--- print(vim.wo.quux)             -- error: invalid key
+--- vim.wo[winid][0].spell = false -- like ':setlocal nospell'
+--- ```
 vim.wo = new_win_opt_accessor()
 
 ---@brief [[
@@ -795,77 +806,93 @@ end
 --- @diagnostic disable-next-line:unused-local used for gen_vimdoc
 local Option = {} -- luacheck: no unused
 
----Returns a Lua-representation of the option. Boolean, number and string
----values will be returned in exactly the same fashion.
+--- Returns a Lua-representation of the option. Boolean, number and string
+--- values will be returned in exactly the same fashion.
 ---
----For values that are comma-separated lists, an array will be returned with
----the values as entries in the array: <pre>lua
----    vim.cmd [[set wildignore=*.pyc,*.o]]
+--- For values that are comma-separated lists, an array will be returned with
+--- the values as entries in the array:
 ---
----    vim.print(vim.opt.wildignore:get())
----    -- { "*.pyc", "*.o", }
+--- ```lua
+--- vim.cmd [[set wildignore=*.pyc,*.o]]
 ---
----    for _, ignore_pattern in ipairs(vim.opt.wildignore:get()) do
----        print("Will ignore:", ignore_pattern)
----    end
----    -- Will ignore: *.pyc
----    -- Will ignore: *.o
----</pre>
+--- vim.print(vim.opt.wildignore:get())
+--- -- { "*.pyc", "*.o", }
 ---
----For values that are comma-separated maps, a table will be returned with
----the names as keys and the values as entries: <pre>lua
----    vim.cmd [[set listchars=space:_,tab:>~]]
+--- for _, ignore_pattern in ipairs(vim.opt.wildignore:get()) do
+---     print("Will ignore:", ignore_pattern)
+--- end
+--- -- Will ignore: *.pyc
+--- -- Will ignore: *.o
+--- ```
 ---
----    vim.print(vim.opt.listchars:get())
----    --  { space = "_", tab = ">~", }
+--- For values that are comma-separated maps, a table will be returned with
+--- the names as keys and the values as entries:
 ---
----    for char, representation in pairs(vim.opt.listchars:get()) do
----        print(char, "=>", representation)
----    end
----</pre>
+--- ```lua
+--- vim.cmd [[set listchars=space:_,tab:>~]]
 ---
----For values that are lists of flags, a set will be returned with the flags
----as keys and `true` as entries. <pre>lua
----    vim.cmd [[set formatoptions=njtcroql]]
+--- vim.print(vim.opt.listchars:get())
+--- --  { space = "_", tab = ">~", }
 ---
----    vim.print(vim.opt.formatoptions:get())
----    -- { n = true, j = true, c = true, ... }
+--- for char, representation in pairs(vim.opt.listchars:get()) do
+---     print(char, "=>", representation)
+--- end
+--- ```
+---
+--- For values that are lists of flags, a set will be returned with the flags
+--- as keys and `true` as entries.
+---
+--- ```lua
+--- vim.cmd [[set formatoptions=njtcroql]]
+---
+--- vim.print(vim.opt.formatoptions:get())
+--- -- { n = true, j = true, c = true, ... }
+---
+--- local format_opts = vim.opt.formatoptions:get()
+--- if format_opts.j then
+---     print("J is enabled!")
+--- end
+--- ```
 ---
----    local format_opts = vim.opt.formatoptions:get()
----    if format_opts.j then
----        print("J is enabled!")
----    end
----</pre>
 ---@return string|integer|boolean|nil value of option
 ---@diagnostic disable-next-line:unused-local used for gen_vimdoc
 function Option:get() end
 
----Append a value to string-style options. See |:set+=|
+--- Append a value to string-style options. See |:set+=|
+---
+--- These are equivalent:
+---
+--- ```lua
+--- vim.opt.formatoptions:append('j')
+--- vim.opt.formatoptions = vim.opt.formatoptions + 'j'
+--- ```
 ---
----These are equivalent: <pre>lua
----    vim.opt.formatoptions:append('j')
----    vim.opt.formatoptions = vim.opt.formatoptions + 'j'
----</pre>
 ---@param value string Value to append
---- @diagnostic disable-next-line:unused-local used for gen_vimdoc
+---@diagnostic disable-next-line:unused-local used for gen_vimdoc
 function Option:append(value) end -- luacheck: no unused
 
----Prepend a value to string-style options. See |:set^=|
+--- Prepend a value to string-style options. See |:set^=|
+---
+--- These are equivalent:
+---
+--- ```lua
+--- vim.opt.wildignore:prepend('*.o')
+--- vim.opt.wildignore = vim.opt.wildignore ^ '*.o'
+--- ```
 ---
----These are equivalent: <pre>lua
----    vim.opt.wildignore:prepend('*.o')
----    vim.opt.wildignore = vim.opt.wildignore ^ '*.o'
----</pre>
 ---@param value string Value to prepend
 ---@diagnostic disable-next-line:unused-local used for gen_vimdoc
 function Option:prepend(value) end -- luacheck: no unused
 
----Remove a value from string-style options. See |:set-=|
+--- Remove a value from string-style options. See |:set-=|
+---
+--- These are equivalent:
+---
+--- ```lua
+--- vim.opt.wildignore:remove('*.pyc')
+--- vim.opt.wildignore = vim.opt.wildignore - '*.pyc'
+--- ```
 ---
----These are equivalent: <pre>lua
----    vim.opt.wildignore:remove('*.pyc')
----    vim.opt.wildignore = vim.opt.wildignore - '*.pyc'
----</pre>
 ---@param value string Value to remove
 ---@diagnostic disable-next-line:unused-local used for gen_vimdoc
 function Option:remove(value) end -- luacheck: no unused
diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index a1f3020c88..b8d3906b7f 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -553,14 +553,16 @@ end
 --- followed by namespace configuration, and finally global configuration.
 ---
 --- For example, if a user enables virtual text globally with
---- <pre>lua
----   vim.diagnostic.config({ virtual_text = true })
---- </pre>
+---
+--- ```lua
+--- vim.diagnostic.config({ virtual_text = true })
+--- ```
 ---
 --- and a diagnostic producer sets diagnostics with
---- <pre>lua
----   vim.diagnostic.set(ns, 0, diagnostics, { virtual_text = false })
---- </pre>
+---
+--- ```lua
+--- vim.diagnostic.set(ns, 0, diagnostics, { virtual_text = false })
+--- ```
 ---
 --- then virtual text will not be enabled for those diagnostics.
 ---
@@ -1601,18 +1603,20 @@ end
 --- Parse a diagnostic from a string.
 ---
 --- For example, consider a line of output from a linter:
---- <pre>
+---
+--- ```
 --- WARNING filename:27:3: Variable 'foo' does not exist
---- </pre>
+--- ```
 ---
 --- This can be parsed into a diagnostic |diagnostic-structure|
 --- with:
---- <pre>lua
----   local s = "WARNING filename:27:3: Variable 'foo' does not exist"
----   local pattern = "^(%w+) %w+:(%d+):(%d+): (.+)$"
----   local groups = { "severity", "lnum", "col", "message" }
----   vim.diagnostic.match(s, pattern, groups, { WARNING = vim.diagnostic.WARN })
---- </pre>
+---
+--- ```lua
+--- local s = "WARNING filename:27:3: Variable 'foo' does not exist"
+--- local pattern = "^(%w+) %w+:(%d+):(%d+): (.+)$"
+--- local groups = { "severity", "lnum", "col", "message" }
+--- vim.diagnostic.match(s, pattern, groups, { WARNING = vim.diagnostic.WARN })
+--- ```
 ---
 ---@param str string String to parse diagnostics from.
 ---@param pat string Lua pattern with capture groups.
diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 6fb6f475bc..d847c28f5c 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -2081,43 +2081,45 @@ end
 --- See $VIMRUNTIME/lua/vim/filetype.lua for more examples.
 ---
 --- Example:
---- <pre>lua
----  vim.filetype.add({
----    extension = {
----      foo = 'fooscript',
----      bar = function(path, bufnr)
----        if some_condition() then
----          return 'barscript', function(bufnr)
----            -- Set a buffer variable
----            vim.b[bufnr].barscript_version = 2
----          end
----        end
----        return 'bar'
----      end,
----    },
----    filename = {
----      ['.foorc'] = 'toml',
----      ['/etc/foo/config'] = 'toml',
----    },
----    pattern = {
----      ['.*/etc/foo/.*'] = 'fooscript',
----      -- Using an optional priority
----      ['.*/etc/foo/.*%.conf'] = { 'dosini', { priority = 10 } },
----      -- A pattern containing an environment variable
----      ['${XDG_CONFIG_HOME}/foo/git'] = 'git',
----      ['README.(%a+)$'] = function(path, bufnr, ext)
----        if ext == 'md' then
----          return 'markdown'
----        elseif ext == 'rst' then
----          return 'rst'
----        end
----      end,
----    },
----  })
---- </pre>
+---
+--- ```lua
+--- vim.filetype.add({
+---   extension = {
+---     foo = 'fooscript',
+---     bar = function(path, bufnr)
+---       if some_condition() then
+---         return 'barscript', function(bufnr)
+---           -- Set a buffer variable
+---           vim.b[bufnr].barscript_version = 2
+---         end
+---       end
+---       return 'bar'
+---     end,
+---   },
+---   filename = {
+---     ['.foorc'] = 'toml',
+---     ['/etc/foo/config'] = 'toml',
+---   },
+---   pattern = {
+---     ['.*/etc/foo/.*'] = 'fooscript',
+---     -- Using an optional priority
+---     ['.*/etc/foo/.*%.conf'] = { 'dosini', { priority = 10 } },
+---     -- A pattern containing an environment variable
+---     ['${XDG_CONFIG_HOME}/foo/git'] = 'git',
+---     ['README.(%a+)$'] = function(path, bufnr, ext)
+---       if ext == 'md' then
+---         return 'markdown'
+---       elseif ext == 'rst' then
+---         return 'rst'
+---       end
+---     end,
+---   },
+--- })
+--- ```
 ---
 --- To add a fallback match on contents, use
---- <pre>lua
+---
+--- ```lua
 --- vim.filetype.add {
 ---   pattern = {
 ---     ['.*'] = {
@@ -2133,7 +2135,7 @@ end
 ---     },
 ---   },
 --- }
---- </pre>
+--- ```
 ---
 ---@param filetypes vim.filetype.add.filetypes A table containing new filetype maps (see example).
 function M.add(filetypes)
@@ -2256,19 +2258,19 @@ end
 --- Each of the three options is specified using a key to the single argument of this function.
 --- Example:
 ---
---- <pre>lua
----   -- Using a buffer number
----   vim.filetype.match({ buf = 42 })
+--- ```lua
+--- -- Using a buffer number
+--- vim.filetype.match({ buf = 42 })
 ---
----   -- Override the filename of the given buffer
----   vim.filetype.match({ buf = 42, filename = 'foo.c' })
+--- -- Override the filename of the given buffer
+--- vim.filetype.match({ buf = 42, filename = 'foo.c' })
 ---
----   -- Using a filename without a buffer
----   vim.filetype.match({ filename = 'main.lua' })
+--- -- Using a filename without a buffer
+--- vim.filetype.match({ filename = 'main.lua' })
 ---
----   -- Using file contents
----   vim.filetype.match({ contents = {'#!/usr/bin/env bash'} })
---- </pre>
+--- -- Using file contents
+--- vim.filetype.match({ contents = {'#!/usr/bin/env bash'} })
+--- ```
 ---
 ---@param args vim.filetype.match.args Table specifying which matching strategy to use.
 ---                 Accepted keys are:
@@ -2404,9 +2406,10 @@ end
 --- is set, meaning it should respect all FileType autocmds and ftplugin files.
 ---
 --- Example:
---- <pre>lua
----   vim.filetype.get_option('vim', 'commentstring')
---- </pre>
+---
+--- ```lua
+--- vim.filetype.get_option('vim', 'commentstring')
+--- ```
 ---
 --- Note: this uses |nvim_get_option_value()| but caches the result.
 --- This means |ftplugin| and |FileType| autocommands are only
diff --git a/runtime/lua/vim/fs.lua b/runtime/lua/vim/fs.lua
index 7cd9e3cf04..22612a7255 100644
--- a/runtime/lua/vim/fs.lua
+++ b/runtime/lua/vim/fs.lua
@@ -5,7 +5,8 @@ local iswin = vim.uv.os_uname().sysname == 'Windows_NT'
 --- Iterate over all the parents of the given path.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 --- local root_dir
 --- for dir in vim.fs.parents(vim.api.nvim_buf_get_name(0)) do
 ---   if vim.fn.isdirectory(dir .. "/.git") == 1 then
@@ -17,7 +18,7 @@ local iswin = vim.uv.os_uname().sysname == 'Windows_NT'
 --- if root_dir then
 ---   print("Found git repository at", root_dir)
 --- end
---- </pre>
+--- ```
 ---
 ---@param start (string) Initial path.
 ---@return fun(_, dir: string): string? # Iterator
@@ -165,7 +166,8 @@ end
 --- to narrow the search to find only that type.
 ---
 --- Examples:
---- <pre>lua
+---
+--- ```lua
 --- -- location of Cargo.toml from the current buffer's path
 --- local cargo = vim.fs.find('Cargo.toml', {
 ---   upward = true,
@@ -183,7 +185,7 @@ end
 --- local cpp_hpp = vim.fs.find(function(name, path)
 ---   return name:match('.*%.[ch]pp$') and path:match('[/\\\\]lib$')
 --- end, {limit = math.huge, type = 'file'})
---- </pre>
+--- ```
 ---
 ---@param names (string|string[]|fun(name: string, path: string): boolean) Names of the items to find.
 ---             Must be base names, paths and globs are not supported when {names} is a string or a table.
@@ -322,16 +324,17 @@ end
 --- variables are also expanded.
 ---
 --- Examples:
---- <pre>lua
----   vim.fs.normalize('C:\\\\Users\\\\jdoe')
----   --> 'C:/Users/jdoe'
 ---
----   vim.fs.normalize('~/src/neovim')
----   --> '/home/jdoe/src/neovim'
+--- ```lua
+--- vim.fs.normalize('C:\\\\Users\\\\jdoe')
+--- -- 'C:/Users/jdoe'
+---
+--- vim.fs.normalize('~/src/neovim')
+--- -- '/home/jdoe/src/neovim'
 ---
----   vim.fs.normalize('$XDG_CONFIG_HOME/nvim/init.vim')
----   --> '/Users/jdoe/.config/nvim/init.vim'
---- </pre>
+--- vim.fs.normalize('$XDG_CONFIG_HOME/nvim/init.vim')
+--- -- '/Users/jdoe/.config/nvim/init.vim'
+--- ```
 ---
 ---@param path (string) Path to normalize
 ---@param opts table|nil Options:
diff --git a/runtime/lua/vim/highlight.lua b/runtime/lua/vim/highlight.lua
index fd4fb54a5b..fc2fd43c97 100644
--- a/runtime/lua/vim/highlight.lua
+++ b/runtime/lua/vim/highlight.lua
@@ -1,23 +1,24 @@
 ---@defgroup vim.highlight
 ---
----@brief
----Nvim includes a function for highlighting a selection on yank.
+--- Nvim includes a function for highlighting a selection on yank.
 ---
----To enable it, add the following to your `init.vim`:
----<pre>vim
----    au TextYankPost * silent! lua vim.highlight.on_yank()
----</pre>
+--- To enable it, add the following to your `init.vim`:
 ---
----You can customize the highlight group and the duration of
----the highlight via:
----<pre>vim
----    au TextYankPost * silent! lua vim.highlight.on_yank {higroup="IncSearch", timeout=150}
----</pre>
+--- ```vim
+--- au TextYankPost * silent! lua vim.highlight.on_yank()
+--- ```
 ---
----If you want to exclude visual selections from highlighting on yank, use:
----<pre>vim
----    au TextYankPost * silent! lua vim.highlight.on_yank {on_visual=false}
----</pre>
+--- You can customize the highlight group and the duration of the highlight via:
+---
+--- ```vim
+--- au TextYankPost * silent! lua vim.highlight.on_yank {higroup="IncSearch", timeout=150}
+--- ```
+---
+--- If you want to exclude visual selections from highlighting on yank, use:
+---
+--- ```vim
+--- au TextYankPost * silent! lua vim.highlight.on_yank {on_visual=false}
+--- ```
 
 local api = vim.api
 
diff --git a/runtime/lua/vim/keymap.lua b/runtime/lua/vim/keymap.lua
index 2b55ddc787..df593be097 100644
--- a/runtime/lua/vim/keymap.lua
+++ b/runtime/lua/vim/keymap.lua
@@ -2,20 +2,21 @@ local keymap = {}
 
 --- Adds a new |mapping|.
 --- Examples:
---- <pre>lua
----   -- Map to a Lua function:
----   vim.keymap.set('n', 'lhs', function() print("real lua function") end)
----   -- Map to multiple modes:
----   vim.keymap.set({'n', 'v'}, '<leader>lr', vim.lsp.buf.references, { buffer = true })
----   -- Buffer-local mapping:
----   vim.keymap.set('n', '<leader>w', "<cmd>w<cr>", { silent = true, buffer = 5 })
----   -- Expr mapping:
----   vim.keymap.set('i', '<Tab>', function()
----     return vim.fn.pumvisible() == 1 and "<C-n>" or "<Tab>"
----   end, { expr = true })
----   -- <Plug> mapping:
----   vim.keymap.set('n', '[%%', '<Plug>(MatchitNormalMultiBackward)')
---- </pre>
+---
+--- ```lua
+--- -- Map to a Lua function:
+--- vim.keymap.set('n', 'lhs', function() print("real lua function") end)
+--- -- Map to multiple modes:
+--- vim.keymap.set({'n', 'v'}, '<leader>lr', vim.lsp.buf.references, { buffer = true })
+--- -- Buffer-local mapping:
+--- vim.keymap.set('n', '<leader>w', "<cmd>w<cr>", { silent = true, buffer = 5 })
+--- -- Expr mapping:
+--- vim.keymap.set('i', '<Tab>', function()
+---   return vim.fn.pumvisible() == 1 and "<C-n>" or "<Tab>"
+--- end, { expr = true })
+--- -- <Plug> mapping:
+--- vim.keymap.set('n', '[%%', '<Plug>(MatchitNormalMultiBackward)')
+--- ```
 ---
 ---@param mode string|table    Mode short-name, see |nvim_set_keymap()|.
 ---                            Can also be list of modes to create mapping on multiple modes.
@@ -80,11 +81,13 @@ end
 
 --- Remove an existing mapping.
 --- Examples:
---- <pre>lua
----   vim.keymap.del('n', 'lhs')
 ---
----   vim.keymap.del({'n', 'i', 'v'}, '<leader>w', { buffer = 5 })
---- </pre>
+--- ```lua
+--- vim.keymap.del('n', 'lhs')
+---
+--- vim.keymap.del({'n', 'i', 'v'}, '<leader>w', { buffer = 5 })
+--- ```
+---
 ---@param opts table|nil A table of optional arguments:
 ---                      - "buffer": (number|boolean) Remove a mapping from the given buffer.
 ---                        When `0` or `true`, use the current buffer.
diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index c25358e557..f68ca7e88c 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -809,13 +809,14 @@ end
 --- Attaches the current buffer to the client.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 --- vim.lsp.start({
 ---    name = 'my-server-name',
 ---    cmd = {'name-of-language-server-executable'},
 ---    root_dir = vim.fs.dirname(vim.fs.find({'pyproject.toml', 'setup.py'}, { upward = true })[1]),
 --- })
---- </pre>
+--- ```
 ---
 --- See |vim.lsp.start_client()| for all available options. The most important are:
 ---
@@ -1988,9 +1989,10 @@ end
 ---
 --- You can also use the `stop()` function on a |vim.lsp.client| object.
 --- To stop all clients:
---- <pre>lua
+---
+--- ```lua
 --- vim.lsp.stop_client(vim.lsp.get_clients())
---- </pre>
+--- ```
 ---
 --- By default asks the server to shutdown, unless stop was requested
 --- already for this client, then force-shutdown is attempted.
@@ -2502,12 +2504,7 @@ end
 ---@param bufnr integer Buffer number
 ---@param fn function Function to run on each client attached to buffer
 ---                   {bufnr}. The function takes the client, client ID, and
----                   buffer number as arguments. Example:
----             <pre>lua
----               vim.lsp.for_each_buffer_client(0, function(client, client_id, bufnr)
----                 vim.print(client)
----               end)
----             </pre>
+---                   buffer number as arguments.
 ---@deprecated use lsp.get_clients({ bufnr = bufnr }) with regular loop
 function lsp.for_each_buffer_client(bufnr, fn)
   return for_each_buffer_client(bufnr, fn)
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 6cd0aa1e95..8a29fac2b5 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -168,13 +168,11 @@ end
 ---
 ---     - filter (function|nil):
 ---         Predicate used to filter clients. Receives a client as argument and must return a
----         boolean. Clients matching the predicate are included. Example:
----
----         <pre>lua
----           -- Never request typescript-language-server for formatting
----           vim.lsp.buf.format {
----             filter = function(client) return client.name ~= "tsserver" end
----           }
+---         boolean. Clients matching the predicate are included. Example: <pre>lua
+---                     -- Never request typescript-language-server for formatting
+---                     vim.lsp.buf.format {
+---                       filter = function(client) return client.name ~= "tsserver" end
+---                     }
 ---         </pre>
 ---
 ---     - async boolean|nil
@@ -555,11 +553,12 @@ end
 --- Send request to the server to resolve document highlights for the current
 --- text document position. This request can be triggered by a  key mapping or
 --- by events such as `CursorHold`, e.g.:
---- <pre>vim
----   autocmd CursorHold  <buffer> lua vim.lsp.buf.document_highlight()
----   autocmd CursorHoldI <buffer> lua vim.lsp.buf.document_highlight()
----   autocmd CursorMoved <buffer> lua vim.lsp.buf.clear_references()
---- </pre>
+---
+--- ```vim
+--- autocmd CursorHold  <buffer> lua vim.lsp.buf.document_highlight()
+--- autocmd CursorHoldI <buffer> lua vim.lsp.buf.document_highlight()
+--- autocmd CursorMoved <buffer> lua vim.lsp.buf.clear_references()
+--- ```
 ---
 --- Note: Usage of |vim.lsp.buf.document_highlight()| requires the following highlight groups
 ---       to be defined or you won't be able to see the actual highlights.
diff --git a/runtime/lua/vim/lsp/codelens.lua b/runtime/lua/vim/lsp/codelens.lua
index d581eb985f..384d09ee48 100644
--- a/runtime/lua/vim/lsp/codelens.lua
+++ b/runtime/lua/vim/lsp/codelens.lua
@@ -255,10 +255,10 @@ end
 --- It is recommended to trigger this using an autocmd or via keymap.
 ---
 --- Example:
---- <pre>vim
----   autocmd BufEnter,CursorHold,InsertLeave <buffer> lua vim.lsp.codelens.refresh()
---- </pre>
 ---
+--- ```vim
+--- autocmd BufEnter,CursorHold,InsertLeave <buffer> lua vim.lsp.codelens.refresh()
+--- ```
 function M.refresh()
   local params = {
     textDocument = util.make_text_document_params(),
diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index 2a77992c4d..73ffa1a46c 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -203,7 +203,8 @@ end
 ---
 --- See |vim.diagnostic.config()| for configuration options. Handler-specific
 --- configuration can be set using |vim.lsp.with()|:
---- <pre>lua
+---
+--- ```lua
 --- vim.lsp.handlers["textDocument/publishDiagnostics"] = vim.lsp.with(
 ---   vim.lsp.diagnostic.on_publish_diagnostics, {
 ---     -- Enable underline, use default values
@@ -221,7 +222,7 @@ end
 ---     update_in_insert = false,
 ---   }
 --- )
---- </pre>
+--- ```
 ---
 ---@param config table Configuration table (see |vim.diagnostic.config()|).
 function M.on_publish_diagnostics(_, result, ctx, config)
@@ -263,7 +264,8 @@ end
 ---
 --- See |vim.diagnostic.config()| for configuration options. Handler-specific
 --- configuration can be set using |vim.lsp.with()|:
---- <pre>lua
+---
+--- ```lua
 --- vim.lsp.handlers["textDocument/diagnostic"] = vim.lsp.with(
 ---   vim.lsp.diagnostic.on_diagnostic, {
 ---     -- Enable underline, use default values
@@ -281,7 +283,7 @@ end
 ---     update_in_insert = false,
 ---   }
 --- )
---- </pre>
+--- ```
 ---
 ---@param config table Configuration table (see |vim.diagnostic.config()|).
 function M.on_diagnostic(_, result, ctx, config)
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 81d4d6cceb..4ea3dde81c 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -342,16 +342,18 @@ M[ms.textDocument_completion] = function(_, result, _, _)
 end
 
 --- |lsp-handler| for the method "textDocument/hover"
---- <pre>lua
----   vim.lsp.handlers["textDocument/hover"] = vim.lsp.with(
----     vim.lsp.handlers.hover, {
----       -- Use a sharp border with `FloatBorder` highlights
----       border = "single",
----       -- add the title in hover float window
----       title = "hover"
----     }
----   )
---- </pre>
+---
+--- ```lua
+--- vim.lsp.handlers["textDocument/hover"] = vim.lsp.with(
+---   vim.lsp.handlers.hover, {
+---     -- Use a sharp border with `FloatBorder` highlights
+---     border = "single",
+---     -- add the title in hover float window
+---     title = "hover"
+---   }
+--- )
+--- ```
+---
 ---@param config table Configuration table.
 ---     - border:     (default=nil)
 ---         - Add borders to the floating window
@@ -430,15 +432,20 @@ M[ms.textDocument_typeDefinition] = location_handler
 M[ms.textDocument_implementation] = location_handler
 
 --- |lsp-handler| for the method "textDocument/signatureHelp".
+---
 --- The active parameter is highlighted with |hl-LspSignatureActiveParameter|.
---- <pre>lua
----   vim.lsp.handlers["textDocument/signatureHelp"] = vim.lsp.with(
----     vim.lsp.handlers.signature_help, {
----       -- Use a sharp border with `FloatBorder` highlights
----       border = "single"
----     }
----   )
---- </pre>
+---
+--- ```lua
+--- vim.lsp.handlers["textDocument/signatureHelp"] = vim.lsp.with(
+---   vim.lsp.handlers.signature_help, {
+---     -- Use a sharp border with `FloatBorder` highlights
+---     border = "single"
+---   }
+--- )
+--- ```
+---
+---@param result table Response from the language server
+---@param ctx table Client context
 ---@param config table Configuration table.
 ---     - border:     (default=nil)
 ---         - Add borders to the floating window
diff --git a/runtime/lua/vim/lsp/semantic_tokens.lua b/runtime/lua/vim/lsp/semantic_tokens.lua
index 5b20344bd3..a5831c0beb 100644
--- a/runtime/lua/vim/lsp/semantic_tokens.lua
+++ b/runtime/lua/vim/lsp/semantic_tokens.lua
@@ -555,9 +555,10 @@ local M = {}
 --- delete the semanticTokensProvider table from the {server_capabilities} of
 --- your client in your |LspAttach| callback or your configuration's
 --- `on_attach` callback:
---- <pre>lua
----   client.server_capabilities.semanticTokensProvider = nil
---- </pre>
+---
+--- ```lua
+--- client.server_capabilities.semanticTokensProvider = nil
+--- ```
 ---
 ---@param bufnr integer
 ---@param client_id integer
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 422d49d746..0c38fa955a 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -65,19 +65,21 @@ end
 --- (as opposed to |vim.split()| which is "eager").
 ---
 --- Example:
----   <pre>lua
----   for s in vim.gsplit(':aa::b:', ':', {plain=true}) do
----     print(s)
----   end
----   </pre>
+---
+--- ```lua
+--- for s in vim.gsplit(':aa::b:', ':', {plain=true}) do
+---   print(s)
+--- end
+--- ```
 ---
 --- If you want to also inspect the separator itself (instead of discarding it), use
 --- |string.gmatch()|. Example:
----   <pre>lua
----   for word, num in ('foo111bar222'):gmatch('([^0-9]*)(%d*)') do
----     print(('word: %s num: %s'):format(word, num))
----   end
----   </pre>
+---
+--- ```lua
+--- for word, num in ('foo111bar222'):gmatch('([^0-9]*)(%d*)') do
+---   print(('word: %s num: %s'):format(word, num))
+--- end
+--- ```
 ---
 --- @see |string.gmatch()|
 --- @see |vim.split()|
@@ -165,12 +167,13 @@ end
 --- |vim.gsplit()|).
 ---
 --- Examples:
---- <pre>lua
----  split(":aa::b:", ":")                   --> {'','aa','','b',''}
----  split("axaby", "ab?")                   --> {'','x','y'}
----  split("x*yz*o", "*", {plain=true})      --> {'x','yz','o'}
----  split("|x|y|z|", "|", {trimempty=true}) --> {'x', 'y', 'z'}
---- </pre>
+---
+--- ```lua
+--- split(":aa::b:", ":")                   --> {'','aa','','b',''}
+--- split("axaby", "ab?")                   --> {'','x','y'}
+--- split("x*yz*o", "*", {plain=true})      --> {'x','yz','o'}
+--- split("|x|y|z|", "|", {trimempty=true}) --> {'x', 'y', 'z'}
+--- ```
 ---
 ---@see |vim.gsplit()|
 ---@see |string.gmatch()|
@@ -259,12 +262,13 @@ end
 --- a predicate that is checked for each value.
 ---
 --- Example:
---- <pre>lua
----  vim.tbl_contains({ 'a', { 'b', 'c' } }, function(v)
----    return vim.deep_equal(v, { 'b', 'c' })
----  end, { predicate = true })
----  -- true
---- </pre>
+---
+--- ```lua
+--- vim.tbl_contains({ 'a', { 'b', 'c' } }, function(v)
+---   return vim.deep_equal(v, { 'b', 'c' })
+--- end, { predicate = true })
+--- -- true
+--- ```
 ---
 ---@see |vim.list_contains()| for checking values in list-like tables
 ---
@@ -455,10 +459,11 @@ end
 --- Return `nil` if the key does not exist.
 ---
 --- Examples:
---- <pre>lua
----  vim.tbl_get({ key = { nested_key = true }}, 'key', 'nested_key') == true
----  vim.tbl_get({ key = {}}, 'key', 'nested_key') == nil
---- </pre>
+---
+--- ```lua
+--- vim.tbl_get({ key = { nested_key = true }}, 'key', 'nested_key') == true
+--- vim.tbl_get({ key = {}}, 'key', 'nested_key') == nil
+--- ```
 ---
 ---@param o table Table to index
 ---@param ... any Optional keys (0 or more, variadic) via which to index the table
@@ -626,10 +631,10 @@ end
 
 --- Counts the number of non-nil values in table `t`.
 ---
---- <pre>lua
+--- ```lua
 --- vim.tbl_count({ a=1, b=2 })  --> 2
 --- vim.tbl_count({ 1, 2 })      --> 2
---- </pre>
+--- ```
 ---
 ---@see https://github.com/Tieske/Penlight/blob/master/lua/pl/tablex.lua
 ---@param t table Table
@@ -703,38 +708,41 @@ end
 --- Validates a parameter specification (types and values).
 ---
 --- Usage example:
---- <pre>lua
----  function user.new(name, age, hobbies)
----    vim.validate{
----      name={name, 'string'},
----      age={age, 'number'},
----      hobbies={hobbies, 'table'},
----    }
----    ...
----  end
---- </pre>
+---
+--- ```lua
+--- function user.new(name, age, hobbies)
+---   vim.validate{
+---     name={name, 'string'},
+---     age={age, 'number'},
+---     hobbies={hobbies, 'table'},
+---   }
+---   ...
+--- end
+--- ```
 ---
 --- Examples with explicit argument values (can be run directly):
---- <pre>lua
----  vim.validate{arg1={{'foo'}, 'table'}, arg2={'foo', 'string'}}
----     --> NOP (success)
 ---
----  vim.validate{arg1={1, 'table'}}
----     --> error('arg1: expected table, got number')
+--- ```lua
+--- vim.validate{arg1={{'foo'}, 'table'}, arg2={'foo', 'string'}}
+---    --> NOP (success)
 ---
----  vim.validate{arg1={3, function(a) return (a % 2) == 0 end, 'even number'}}
----     --> error('arg1: expected even number, got 3')
---- </pre>
+--- vim.validate{arg1={1, 'table'}}
+---    --> error('arg1: expected table, got number')
+---
+--- vim.validate{arg1={3, function(a) return (a % 2) == 0 end, 'even number'}}
+---    --> error('arg1: expected even number, got 3')
+--- ```
 ---
 --- If multiple types are valid they can be given as a list.
---- <pre>lua
----  vim.validate{arg1={{'foo'}, {'table', 'string'}}, arg2={'foo', {'table', 'string'}}}
----     --> NOP (success)
 ---
----  vim.validate{arg1={1, {'string', 'table'}}}
----     --> error('arg1: expected string|table, got number')
+--- ```lua
+--- vim.validate{arg1={{'foo'}, {'table', 'string'}}, arg2={'foo', {'table', 'string'}}}
+--- -- NOP (success)
+---
+--- vim.validate{arg1={1, {'string', 'table'}}}
+--- -- error('arg1: expected string|table, got number')
 ---
---- </pre>
+--- ```
 ---
 ---@param opt table Names of parameters to validate. Each key is a parameter
 ---          name; each value is a tuple in one of these forms:
@@ -866,10 +874,10 @@ end
 --- If {create} is `nil`, this will create a defaulttable whose constructor function is
 --- this function, effectively allowing to create nested tables on the fly:
 ---
---- <pre>lua
+--- ```lua
 --- local a = vim.defaulttable()
 --- a.b.c = 1
---- </pre>
+--- ```
 ---
 ---@param create function?(key:any):any The function called to create a missing value.
 ---@return table Empty table with metamethod
@@ -938,7 +946,7 @@ do
   --- Create a ring buffer limited to a maximal number of items.
   --- Once the buffer is full, adding a new entry overrides the oldest entry.
   ---
-  --- <pre>
+  --- ```lua
   ---   local ringbuf = vim.ringbuf(4)
   ---   ringbuf:push("a")
   ---   ringbuf:push("b")
@@ -952,7 +960,7 @@ do
   ---   for val in ringbuf do
   ---     print(val)
   ---   end
-  --- </pre>
+  --- ```
   ---
   --- Returns a Ringbuf instance with the following methods:
   ---
diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 4f84fc2e0f..169aa6c269 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -441,14 +441,15 @@ end
 --- In this case, add ``vim.bo.syntax = 'on'`` after the call to `start`.
 ---
 --- Example:
---- <pre>lua
+---
+--- ```lua
 --- vim.api.nvim_create_autocmd( 'FileType', { pattern = 'tex',
 ---     callback = function(args)
 ---         vim.treesitter.start(args.buf, 'latex')
 ---         vim.bo[args.buf].syntax = 'on'  -- only if additional legacy syntax is needed
 ---     end
 --- })
---- </pre>
+--- ```
 ---
 ---@param bufnr (integer|nil) Buffer to be highlighted (default: current buffer)
 ---@param lang (string|nil) Language of the parser (default: buffer filetype)
@@ -502,9 +503,11 @@ function M.preview_query()
 end
 
 --- Returns the fold level for {lnum} in the current buffer. Can be set directly to 'foldexpr':
---- <pre>lua
+---
+--- ```lua
 --- vim.wo.foldexpr = 'v:lua.vim.treesitter.foldexpr()'
---- </pre>
+--- ```
+---
 ---@param lnum integer|nil Line number to calculate fold level for
 ---@return string
 function M.foldexpr(lnum)
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 1ea0f6b2b9..79f36a27fd 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -7,9 +7,9 @@
 ---
 --- To create a LanguageTree (parser object) for a given buffer and language, use:
 ---
---- <pre>lua
----     local parser = vim.treesitter.get_parser(bufnr, lang)
---- </pre>
+--- ```lua
+--- local parser = vim.treesitter.get_parser(bufnr, lang)
+--- ```
 ---
 --- (where `bufnr=0` means current buffer). `lang` defaults to 'filetype'.
 --- Note: currently the parser is retained for the lifetime of a buffer but this may change;
@@ -17,9 +17,9 @@
 ---
 --- Whenever you need to access the current syntax tree, parse the buffer:
 ---
---- <pre>lua
----     local tree = parser:parse({ start_row, end_row })
---- </pre>
+--- ```lua
+--- local tree = parser:parse({ start_row, end_row })
+--- ```
 ---
 --- This returns a table of immutable |treesitter-tree| objects representing the current state of
 --- the buffer. When the plugin wants to access the state after a (possible) edit it must call
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 3093657313..350ccba7e4 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -692,7 +692,8 @@ end
 --- The iterator returns three values: a numeric id identifying the capture,
 --- the captured node, and metadata from any directives processing the match.
 --- The following example shows how to get captures by name:
---- <pre>lua
+---
+--- ```lua
 --- for id, node, metadata in query:iter_captures(tree:root(), bufnr, first, last) do
 ---   local name = query.captures[id] -- name of the capture in the query
 ---   -- typically useful info about the node:
@@ -700,7 +701,7 @@ end
 ---   local row1, col1, row2, col2 = node:range() -- range of the capture
 ---   -- ... use the info here ...
 --- end
---- </pre>
+--- ```
 ---
 ---@param node TSNode under which the search will occur
 ---@param source (integer|string) Source buffer or string to extract text from
@@ -743,7 +744,8 @@ end
 --- If the query has more than one pattern, the capture table might be sparse
 --- and e.g. `pairs()` method should be used over `ipairs`.
 --- Here is an example iterating over all captures in every match:
---- <pre>lua
+---
+--- ```lua
 --- for pattern, match, metadata in cquery:iter_matches(tree:root(), bufnr, first, last) do
 ---   for id, node in pairs(match) do
 ---     local name = query.captures[id]
@@ -754,7 +756,7 @@ end
 ---     -- ... use the info here ...
 ---   end
 --- end
---- </pre>
+--- ```
 ---
 ---@param node TSNode under which the search will occur
 ---@param source (integer|string) Source buffer or string to search
@@ -824,9 +826,11 @@ end
 --- Omnifunc for completing node names and predicates in treesitter queries.
 ---
 --- Use via
---- <pre>lua
----   vim.bo.omnifunc = 'v:lua.vim.treesitter.query.omnifunc'
---- </pre>
+---
+--- ```lua
+--- vim.bo.omnifunc = 'v:lua.vim.treesitter.query.omnifunc'
+--- ```
+---
 function M.omnifunc(findstart, base)
   return require('vim.treesitter._query_linter').omnifunc(findstart, base)
 end
diff --git a/runtime/lua/vim/ui.lua b/runtime/lua/vim/ui.lua
index cd90886489..b6ddf337ce 100644
--- a/runtime/lua/vim/ui.lua
+++ b/runtime/lua/vim/ui.lua
@@ -3,6 +3,23 @@ local M = {}
 --- Prompts the user to pick from a list of items, allowing arbitrary (potentially asynchronous)
 --- work until `on_choice`.
 ---
+--- Example:
+---
+--- ```lua
+--- vim.ui.select({ 'tabs', 'spaces' }, {
+---     prompt = 'Select tabs or spaces:',
+---     format_item = function(item)
+---         return "I'd like to choose " .. item
+---     end,
+--- }, function(choice)
+---     if choice == 'spaces' then
+---         vim.o.expandtab = true
+---     else
+---         vim.o.expandtab = false
+---     end
+--- end)
+--- ```
+---
 ---@param items table Arbitrary items
 ---@param opts table Additional options
 ---     - prompt (string|nil)
@@ -19,23 +36,6 @@ local M = {}
 ---               Called once the user made a choice.
 ---               `idx` is the 1-based index of `item` within `items`.
 ---               `nil` if the user aborted the dialog.
----
----
---- Example:
---- <pre>lua
---- vim.ui.select({ 'tabs', 'spaces' }, {
----     prompt = 'Select tabs or spaces:',
----     format_item = function(item)
----         return "I'd like to choose " .. item
----     end,
---- }, function(choice)
----     if choice == 'spaces' then
----         vim.o.expandtab = true
----     else
----         vim.o.expandtab = false
----     end
---- end)
---- </pre>
 function M.select(items, opts, on_choice)
   vim.validate({
     items = { items, 'table', false },
@@ -58,6 +58,14 @@ end
 --- Prompts the user for input, allowing arbitrary (potentially asynchronous) work until
 --- `on_confirm`.
 ---
+--- Example:
+---
+--- ```lua
+--- vim.ui.input({ prompt = 'Enter value for shiftwidth: ' }, function(input)
+---     vim.o.shiftwidth = tonumber(input)
+--- end)
+--- ```
+---
 ---@param opts table Additional options. See |input()|
 ---     - prompt (string|nil)
 ---               Text of the prompt
@@ -77,13 +85,6 @@ end
 ---               `input` is what the user typed (it might be
 ---               an empty string if nothing was entered), or
 ---               `nil` if the user aborted the dialog.
----
---- Example:
---- <pre>lua
---- vim.ui.input({ prompt = 'Enter value for shiftwidth: ' }, function(input)
----     vim.o.shiftwidth = tonumber(input)
---- end)
---- </pre>
 function M.input(opts, on_confirm)
   vim.validate({
     on_confirm = { on_confirm, 'function', false },
@@ -110,11 +111,12 @@ end
 --- Expands "~/" and environment variables in filesystem paths.
 ---
 --- Examples:
---- <pre>lua
+---
+--- ```lua
 --- vim.ui.open("https://neovim.io/")
 --- vim.ui.open("~/path/to/file")
 --- vim.ui.open("$VIMRUNTIME")
---- </pre>
+--- ```
 ---
 ---@param path string Path or URL to open
 ---
diff --git a/runtime/lua/vim/version.lua b/runtime/lua/vim/version.lua
index 056e1678ff..306eef90d3 100644
--- a/runtime/lua/vim/version.lua
+++ b/runtime/lua/vim/version.lua
@@ -5,12 +5,13 @@
 --- available tools and dependencies on the current system.
 ---
 --- Example:
----   <pre>lua
----   local v = vim.version.parse(vim.fn.system({'tmux', '-V'}), {strict=false})
----   if vim.version.gt(v, {3, 2, 0}) then
----     -- ...
----   end
----   </pre>
+---
+--- ```lua
+--- local v = vim.version.parse(vim.fn.system({'tmux', '-V'}), {strict=false})
+--- if vim.version.gt(v, {3, 2, 0}) then
+---   -- ...
+--- end
+--- ```
 ---
 --- \*vim.version()\* returns the version of the current Nvim process.
 ---
@@ -21,35 +22,36 @@
 ---
 --- Supported range specs are shown in the following table.
 --- Note: suffixed versions (1.2.3-rc1) are not matched.
----   <pre>
----   1.2.3             is 1.2.3
----   =1.2.3            is 1.2.3
----   >1.2.3            greater than 1.2.3
----   <1.2.3            before 1.2.3
----   >=1.2.3           at least 1.2.3
----   ~1.2.3            is >=1.2.3 <1.3.0       "reasonably close to 1.2.3"
----   ^1.2.3            is >=1.2.3 <2.0.0       "compatible with 1.2.3"
----   ^0.2.3            is >=0.2.3 <0.3.0       (0.x.x is special)
----   ^0.0.1            is =0.0.1               (0.0.x is special)
----   ^1.2              is >=1.2.0 <2.0.0       (like ^1.2.0)
----   ~1.2              is >=1.2.0 <1.3.0       (like ~1.2.0)
----   ^1                is >=1.0.0 <2.0.0       "compatible with 1"
----   ~1                same                    "reasonably close to 1"
----   1.x               same
----   1.*               same
----   1                 same
----   *                 any version
----   x                 same
 ---
----   1.2.3 - 2.3.4     is >=1.2.3 <=2.3.4
+--- ```
+--- 1.2.3             is 1.2.3
+--- =1.2.3            is 1.2.3
+--- >1.2.3            greater than 1.2.3
+--- <1.2.3            before 1.2.3
+--- >=1.2.3           at least 1.2.3
+--- ~1.2.3            is >=1.2.3 <1.3.0       "reasonably close to 1.2.3"
+--- ^1.2.3            is >=1.2.3 <2.0.0       "compatible with 1.2.3"
+--- ^0.2.3            is >=0.2.3 <0.3.0       (0.x.x is special)
+--- ^0.0.1            is =0.0.1               (0.0.x is special)
+--- ^1.2              is >=1.2.0 <2.0.0       (like ^1.2.0)
+--- ~1.2              is >=1.2.0 <1.3.0       (like ~1.2.0)
+--- ^1                is >=1.0.0 <2.0.0       "compatible with 1"
+--- ~1                same                    "reasonably close to 1"
+--- 1.x               same
+--- 1.*               same
+--- 1                 same
+--- *                 any version
+--- x                 same
+---
+--- 1.2.3 - 2.3.4     is >=1.2.3 <=2.3.4
 ---
----   Partial right: missing pieces treated as x (2.3 => 2.3.x).
----   1.2.3 - 2.3       is >=1.2.3 <2.4.0
----   1.2.3 - 2         is >=1.2.3 <3.0.0
+--- Partial right: missing pieces treated as x (2.3 => 2.3.x).
+--- 1.2.3 - 2.3       is >=1.2.3 <2.4.0
+--- 1.2.3 - 2         is >=1.2.3 <3.0.0
 ---
----   Partial left: missing pieces treated as 0 (1.2 => 1.2.0).
----   1.2 - 2.3.0       is 1.2.0 - 2.3.0
----   </pre>
+--- Partial left: missing pieces treated as 0 (1.2 => 1.2.0).
+--- 1.2 - 2.3.0       is 1.2.0 - 2.3.0
+--- ```
 
 local M = {}
 
@@ -237,29 +239,32 @@ function VersionRange:has(version)
 end
 
 --- Parses a semver |version-range| "spec" and returns a range object:
----   <pre>
----   {
----     from: Version
----     to: Version
----     has(v: string|Version)
----   }
----   </pre>
+---
+--- ```
+--- {
+---   from: Version
+---   to: Version
+---   has(v: string|Version)
+--- }
+--- ```
 ---
 --- `:has()` checks if a version is in the range (inclusive `from`, exclusive `to`).
 ---
 --- Example:
----   <pre>lua
----   local r = vim.version.range('1.0.0 - 2.0.0')
----   print(r:has('1.9.9'))       -- true
----   print(r:has('2.0.0'))       -- false
----   print(r:has(vim.version())) -- check against current Nvim version
----   </pre>
+---
+--- ```lua
+--- local r = vim.version.range('1.0.0 - 2.0.0')
+--- print(r:has('1.9.9'))       -- true
+--- print(r:has('2.0.0'))       -- false
+--- print(r:has(vim.version())) -- check against current Nvim version
+--- ```
 ---
 --- Or use cmp(), eq(), lt(), and gt() to compare `.to` and `.from` directly:
----   <pre>lua
----   local r = vim.version.range('1.0.0 - 2.0.0')
----   print(vim.version.gt({1,0,3}, r.from) and vim.version.lt({1,0,3}, r.to))
----   </pre>
+---
+--- ```lua
+--- local r = vim.version.range('1.0.0 - 2.0.0')
+--- print(vim.version.gt({1,0,3}, r.from) and vim.version.lt({1,0,3}, r.to))
+--- ```
 ---
 --- @see # https://github.com/npm/node-semver#ranges
 ---
@@ -345,16 +350,17 @@ end
 --- specified literally as a `{major, minor, patch}` tuple, e.g. `{1, 0, 3}`).
 ---
 --- Example:
---- <pre>lua
----   if vim.version.cmp({1,0,3}, {0,2,1}) == 0 then
----     -- ...
----   end
----   local v1 = vim.version.parse('1.0.3-pre')
----   local v2 = vim.version.parse('0.2.1')
----   if vim.version.cmp(v1, v2) == 0 then
----     -- ...
----   end
---- </pre>
+---
+--- ```lua
+--- if vim.version.cmp({1,0,3}, {0,2,1}) == 0 then
+---   -- ...
+--- end
+--- local v1 = vim.version.parse('1.0.3-pre')
+--- local v2 = vim.version.parse('0.2.1')
+--- if vim.version.cmp(v1, v2) == 0 then
+---   -- ...
+--- end
+--- ```
 ---
 --- @note Per semver, build metadata is ignored when comparing two otherwise-equivalent versions.
 ---
@@ -399,9 +405,10 @@ end
 
 --- Parses a semantic version string and returns a version object which can be used with other
 --- `vim.version` functions. For example "1.0.1-rc1+build.2" returns:
---- <pre>
----   { major = 1, minor = 0, patch = 1, prerelease = "rc1", build = "build.2" }
---- </pre>
+---
+--- ```
+--- { major = 1, minor = 0, patch = 1, prerelease = "rc1", build = "build.2" }
+--- ```
 ---
 --- @see # https://semver.org/spec/v2.0.0.html
 ---
-- 
cgit 


From 28233bcb49067aaa70fa6e5fec14e2cc4bcaa315 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Fri, 15 Sep 2023 03:10:55 -0700
Subject: refactor(treesitter): rename "preview" => "edit" #25161

"Edit" more closely describes the generic application than "Preview", though
the buffer contents don't (yet) map to an actual file on disk.

https://github.com/neovim/neovim/pull/24703#discussion_r1321719133
---
 runtime/lua/vim/treesitter.lua       |  9 +------
 runtime/lua/vim/treesitter/dev.lua   | 48 ++++++++++++++++++------------------
 runtime/lua/vim/treesitter/query.lua |  9 +++++++
 3 files changed, 34 insertions(+), 32 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 169aa6c269..cc8be72670 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -473,7 +473,7 @@ end
 --- Open a window that displays a textual representation of the nodes in the language tree.
 ---
 --- While in the window, press "a" to toggle display of anonymous nodes, "I" to toggle the
---- display of the source language of each node, "o" to toggle the query previewer, and press
+--- display of the source language of each node, "o" to toggle the query editor, and press
 --- <Enter> to jump to the node under the cursor in the source buffer.
 ---
 --- Can also be shown with `:InspectTree`. *:InspectTree*
@@ -495,13 +495,6 @@ function M.inspect_tree(opts)
   require('vim.treesitter.dev').inspect_tree(opts)
 end
 
---- Open a window for live editing of a treesitter query.
----
---- Can also be shown with `:PreviewQuery`. *:PreviewQuery*
-function M.preview_query()
-  require('vim.treesitter.dev').preview_query()
-end
-
 --- Returns the fold level for {lnum} in the current buffer. Can be set directly to 'foldexpr':
 ---
 --- ```lua
diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index e7af259d28..bc54853103 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -351,11 +351,11 @@ function M.inspect_tree(opts)
     end,
   })
   api.nvim_buf_set_keymap(b, 'n', 'o', '', {
-    desc = 'Toggle query previewer',
+    desc = 'Toggle query editor',
     callback = function()
-      local preview_w = vim.b[buf].dev_preview
-      if not preview_w or not close_win(preview_w) then
-        M.preview_query()
+      local edit_w = vim.b[buf].dev_edit
+      if not edit_w or not close_win(edit_w) then
+        M.edit_query()
       end
     end,
   })
@@ -464,16 +464,16 @@ function M.inspect_tree(opts)
   })
 end
 
-local preview_ns = api.nvim_create_namespace('treesitter/dev-preview')
+local edit_ns = api.nvim_create_namespace('treesitter/dev-edit')
 
 ---@param query_win integer
 ---@param base_win integer
-local function update_preview_highlights(query_win, base_win)
+local function update_editor_highlights(query_win, base_win)
   local base_buf = api.nvim_win_get_buf(base_win)
   local query_buf = api.nvim_win_get_buf(query_win)
   local parser = vim.treesitter.get_parser(base_buf)
   local lang = parser:lang()
-  api.nvim_buf_clear_namespace(base_buf, preview_ns, 0, -1)
+  api.nvim_buf_clear_namespace(base_buf, edit_ns, 0, -1)
   local query_content = table.concat(api.nvim_buf_get_lines(query_buf, 0, -1, false), '\n')
 
   local ok_query, query = pcall(vim.treesitter.query.parse, lang, query_content)
@@ -493,7 +493,7 @@ local function update_preview_highlights(query_win, base_win)
     local capture_name = query.captures[id]
     if capture_name == cursor_word then
       local lnum, col, end_lnum, end_col = node:range()
-      api.nvim_buf_set_extmark(base_buf, preview_ns, lnum, col, {
+      api.nvim_buf_set_extmark(base_buf, edit_ns, lnum, col, {
         end_row = end_lnum,
         end_col = end_col,
         hl_group = 'Visual',
@@ -506,17 +506,17 @@ local function update_preview_highlights(query_win, base_win)
 end
 
 --- @private
-function M.preview_query()
+function M.edit_query()
   local buf = api.nvim_get_current_buf()
   local win = api.nvim_get_current_win()
 
-  -- Close any existing previewer window
-  if vim.b[buf].dev_preview then
-    close_win(vim.b[buf].dev_preview)
+  -- Close any existing editor window
+  if vim.b[buf].dev_edit then
+    close_win(vim.b[buf].dev_edit)
   end
 
   local cmd = '60vnew'
-  -- If the inspector is open, place the previewer above it.
+  -- If the inspector is open, place the editor above it.
   local base_win = vim.b[buf].dev_base ---@type integer?
   local base_buf = base_win and api.nvim_win_get_buf(base_win)
   local inspect_win = base_buf and vim.b[base_buf].dev_inspect
@@ -537,20 +537,20 @@ function M.preview_query()
   local query_win = api.nvim_get_current_win()
   local query_buf = api.nvim_win_get_buf(query_win)
 
-  vim.b[buf].dev_preview = query_win
+  vim.b[buf].dev_edit = query_win
   vim.bo[query_buf].omnifunc = 'v:lua.vim.treesitter.query.omnifunc'
   set_dev_properties(query_win, query_buf)
 
   -- Note that omnifunc guesses the language based on the containing folder,
   -- so we add the parser's language to the buffer's name so that omnifunc
   -- can infer the language later.
-  api.nvim_buf_set_name(query_buf, string.format('%s/query_previewer.scm', lang))
+  api.nvim_buf_set_name(query_buf, string.format('%s/query_editor.scm', lang))
 
-  local group = api.nvim_create_augroup('treesitter/dev-preview', {})
+  local group = api.nvim_create_augroup('treesitter/dev-edit', {})
   api.nvim_create_autocmd({ 'TextChanged', 'InsertLeave' }, {
     group = group,
     buffer = query_buf,
-    desc = 'Update query previewer diagnostics when the query changes',
+    desc = 'Update query editor diagnostics when the query changes',
     callback = function()
       vim.treesitter.query.lint(query_buf, { langs = lang, clear = false })
     end,
@@ -558,37 +558,37 @@ function M.preview_query()
   api.nvim_create_autocmd({ 'TextChanged', 'InsertLeave', 'CursorMoved', 'BufEnter' }, {
     group = group,
     buffer = query_buf,
-    desc = 'Update query previewer highlights when the cursor moves',
+    desc = 'Update query editor highlights when the cursor moves',
     callback = function()
       if api.nvim_win_is_valid(win) then
-        update_preview_highlights(query_win, win)
+        update_editor_highlights(query_win, win)
       end
     end,
   })
   api.nvim_create_autocmd('BufLeave', {
     group = group,
     buffer = query_buf,
-    desc = 'Clear the query previewer highlights when leaving the previewer',
+    desc = 'Clear highlights when leaving the query editor',
     callback = function()
-      api.nvim_buf_clear_namespace(buf, preview_ns, 0, -1)
+      api.nvim_buf_clear_namespace(buf, edit_ns, 0, -1)
     end,
   })
   api.nvim_create_autocmd('BufLeave', {
     group = group,
     buffer = buf,
-    desc = 'Clear the query previewer highlights when leaving the source buffer',
+    desc = 'Clear the query editor highlights when leaving the source buffer',
     callback = function()
       if not api.nvim_buf_is_loaded(query_buf) then
         return true
       end
 
-      api.nvim_buf_clear_namespace(query_buf, preview_ns, 0, -1)
+      api.nvim_buf_clear_namespace(query_buf, edit_ns, 0, -1)
     end,
   })
   api.nvim_create_autocmd('BufHidden', {
     group = group,
     buffer = buf,
-    desc = 'Close the previewer window when the source buffer is hidden',
+    desc = 'Close the editor window when the source buffer is hidden',
     once = true,
     callback = function()
       close_win(query_win)
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 350ccba7e4..d7973cc48f 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -835,4 +835,13 @@ function M.omnifunc(findstart, base)
   return require('vim.treesitter._query_linter').omnifunc(findstart, base)
 end
 
+--- Open a window for live editing of a treesitter query.
+---
+--- Can also be shown with `:EditQuery`. *:EditQuery*
+---
+--- Note that the editor opens a scratch buffer, and so queries aren't persisted on disk.
+function M.edit()
+  require('vim.treesitter.dev').edit_query()
+end
+
 return M
-- 
cgit 


From 6debb1852355e0112ce75a5b4aed714ba1469ddb Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Fri, 15 Sep 2023 12:45:40 -0700
Subject: refactor(treesitter): remove duplicated diagnostic code (#24976)

* refactor(treesitter): remove duplicated diagnostic code

* fixup!: fix type errors

* fixup!: add type namespace
---
 runtime/lua/vim/treesitter/_query_linter.lua | 177 ++++++++-------------------
 1 file changed, 48 insertions(+), 129 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_query_linter.lua b/runtime/lua/vim/treesitter/_query_linter.lua
index 3dd0177a81..abf0bf345d 100644
--- a/runtime/lua/vim/treesitter/_query_linter.lua
+++ b/runtime/lua/vim/treesitter/_query_linter.lua
@@ -1,8 +1,6 @@
 local api = vim.api
 
 local namespace = api.nvim_create_namespace('vim.treesitter.query_linter')
--- those node names exist for every language
-local BUILT_IN_NODE_NAMES = { '_', 'ERROR' }
 
 local M = {}
 
@@ -10,11 +8,13 @@ local M = {}
 --- @field langs string[]
 --- @field clear boolean
 
+--- @alias vim.treesitter.ParseError {msg: string, range: Range4}
+
 --- @private
 --- Caches parse results for queries for each language.
 --- Entries of parse_cache[lang][query_text] will either be true for successful parse or contain the
---- error message of the parse
---- @type table<string,table<string,string|true>>
+--- message and range of the parse error.
+--- @type table<string,table<string,vim.treesitter.ParseError|true>>
 local parse_cache = {}
 
 --- Contains language dependent context for the query linter
@@ -26,20 +26,16 @@ local parse_cache = {}
 --- @private
 --- Adds a diagnostic for node in the query buffer
 --- @param diagnostics Diagnostic[]
---- @param node TSNode
---- @param buf integer
+--- @param range Range4
 --- @param lint string
 --- @param lang string?
-local function add_lint_for_node(diagnostics, node, buf, lint, lang)
-  local node_text = vim.treesitter.get_node_text(node, buf):gsub('\n', ' ')
-  --- @type string
-  local message = lint .. ': ' .. node_text
-  local error_range = { node:range() }
+local function add_lint_for_node(diagnostics, range, lint, lang)
+  local message = lint:gsub('\n', ' ')
   diagnostics[#diagnostics + 1] = {
-    lnum = error_range[1],
-    end_lnum = error_range[3],
-    col = error_range[2],
-    end_col = error_range[4],
+    lnum = range[1],
+    end_lnum = range[3],
+    col = range[2],
+    end_col = range[4],
     severity = vim.diagnostic.ERROR,
     message = message,
     source = lang,
@@ -91,6 +87,31 @@ local lint_query = [[;; query
   (ERROR) @error
 ]]
 
+--- @private
+--- @param err string
+--- @param node TSNode
+--- @return vim.treesitter.ParseError
+local function get_error_entry(err, node)
+  local start_line, start_col = node:range()
+  local line_offset, col_offset, msg = err:gmatch('.-:%d+: Query error at (%d+):(%d+)%. ([^:]+)')() ---@type string, string, string
+  start_line, start_col =
+    start_line + tonumber(line_offset) - 1, start_col + tonumber(col_offset) - 1
+  local end_line, end_col = start_line, start_col
+  if msg:match('^Invalid syntax') or msg:match('^Impossible') then
+    -- Use the length of the underlined node
+    local underlined = vim.split(err, '\n')[2]
+    end_col = end_col + #underlined
+  elseif msg:match('^Invalid') then
+    -- Use the length of the problematic type/capture/field
+    end_col = end_col + #msg:match('"([^"]+)"')
+  end
+
+  return {
+    msg = msg,
+    range = { start_line, start_col, end_line, end_col },
+  }
+end
+
 --- @private
 --- @param node TSNode
 --- @param buf integer
@@ -106,104 +127,19 @@ local function check_toplevel(node, buf, lang, diagnostics)
   local lang_cache = parse_cache[lang]
 
   if lang_cache[query_text] == nil then
-    local ok, err = pcall(vim.treesitter.query.parse, lang, query_text)
+    local cache_val, err = pcall(vim.treesitter.query.parse, lang, query_text) ---@type boolean|vim.treesitter.ParseError, string|Query
 
-    if not ok and type(err) == 'string' then
-      err = err:match('.-:%d+: (.+)')
+    if not cache_val and type(err) == 'string' then
+      cache_val = get_error_entry(err, node)
     end
 
-    lang_cache[query_text] = ok or err
+    lang_cache[query_text] = cache_val
   end
 
   local cache_entry = lang_cache[query_text]
 
-  if type(cache_entry) == 'string' then
-    add_lint_for_node(diagnostics, node, buf, cache_entry, lang)
-  end
-end
-
---- @private
---- @param node TSNode
---- @param buf integer
---- @param lang string
---- @param parser_info table
---- @param diagnostics Diagnostic[]
-local function check_field(node, buf, lang, parser_info, diagnostics)
-  local field_name = vim.treesitter.get_node_text(node, buf)
-  if not vim.tbl_contains(parser_info.fields, field_name) then
-    add_lint_for_node(diagnostics, node, buf, 'Invalid field', lang)
-  end
-end
-
---- @private
---- @param node TSNode
---- @param buf integer
---- @param lang string
---- @param parser_info (table)
---- @param diagnostics Diagnostic[]
-local function check_node(node, buf, lang, parser_info, diagnostics)
-  local node_type = vim.treesitter.get_node_text(node, buf)
-  local is_named = node_type:sub(1, 1) ~= '"'
-
-  if not is_named then
-    node_type = node_type:gsub('"(.*)".*$', '%1'):gsub('\\(.)', '%1')
-  end
-
-  local found = vim.tbl_contains(BUILT_IN_NODE_NAMES, node_type)
-    or vim.tbl_contains(parser_info.symbols, function(s)
-      return vim.deep_equal(s, { node_type, is_named })
-    end, { predicate = true })
-
-  if not found then
-    add_lint_for_node(diagnostics, node, buf, 'Invalid node type', lang)
-  end
-end
-
---- @private
---- @param node TSNode
---- @param buf integer
---- @param is_predicate boolean
---- @return string
-local function get_predicate_name(node, buf, is_predicate)
-  local name = vim.treesitter.get_node_text(node, buf)
-  if is_predicate then
-    if vim.startswith(name, 'not-') then
-      --- @type string
-      name = name:sub(string.len('not-') + 1)
-    end
-    return name .. '?'
-  end
-  return name .. '!'
-end
-
---- @private
---- @param predicate_node TSNode
---- @param predicate_type_node TSNode
---- @param buf integer
---- @param lang string?
---- @param diagnostics Diagnostic[]
-local function check_predicate(predicate_node, predicate_type_node, buf, lang, diagnostics)
-  local type_string = vim.treesitter.get_node_text(predicate_type_node, buf)
-
-  -- Quirk of the query grammar that directives are also predicates!
-  if type_string == '?' then
-    if
-      not vim.tbl_contains(
-        vim.treesitter.query.list_predicates(),
-        get_predicate_name(predicate_node, buf, true)
-      )
-    then
-      add_lint_for_node(diagnostics, predicate_node, buf, 'Unknown predicate', lang)
-    end
-  elseif type_string == '!' then
-    if
-      not vim.tbl_contains(
-        vim.treesitter.query.list_directives(),
-        get_predicate_name(predicate_node, buf, false)
-      )
-    then
-      add_lint_for_node(diagnostics, predicate_node, buf, 'Unknown directive', lang)
-    end
+  if type(cache_entry) ~= 'boolean' then
+    add_lint_for_node(diagnostics, cache_entry.range, cache_entry.msg, lang)
   end
 end
 
@@ -214,8 +150,6 @@ end
 --- @param lang_context QueryLinterLanguageContext
 --- @param diagnostics Diagnostic[]
 local function lint_match(buf, match, query, lang_context, diagnostics)
-  local predicate --- @type TSNode
-  local predicate_type --- @type TSNode
   local lang = lang_context.lang
   local parser_info = lang_context.parser_info
 
@@ -223,31 +157,16 @@ local function lint_match(buf, match, query, lang_context, diagnostics)
     local cap_id = query.captures[id]
 
     -- perform language-independent checks only for first lang
-    if lang_context.is_first_lang then
-      if cap_id == 'error' then
-        add_lint_for_node(diagnostics, node, buf, 'Syntax error')
-      elseif cap_id == 'predicate.name' then
-        predicate = node
-      elseif cap_id == 'predicate.type' then
-        predicate_type = node
-      end
+    if lang_context.is_first_lang and cap_id == 'error' then
+      local node_text = vim.treesitter.get_node_text(node, buf):gsub('\n', ' ')
+      add_lint_for_node(diagnostics, { node:range() }, 'Syntax error: ' .. node_text)
     end
 
     -- other checks rely on Neovim parser introspection
-    if lang and parser_info then
-      if cap_id == 'toplevel' then
-        check_toplevel(node, buf, lang, diagnostics)
-      elseif cap_id == 'field' then
-        check_field(node, buf, lang, parser_info, diagnostics)
-      elseif cap_id == 'node.named' or cap_id == 'node.anonymous' then
-        check_node(node, buf, lang, parser_info, diagnostics)
-      end
+    if lang and parser_info and cap_id == 'toplevel' then
+      check_toplevel(node, buf, lang, diagnostics)
     end
   end
-
-  if predicate and predicate_type then
-    check_predicate(predicate, predicate_type, buf, lang, diagnostics)
-  end
 end
 
 --- @private
@@ -339,7 +258,7 @@ function M.omnifunc(findstart, base)
     end
   end
   for _, s in pairs(parser_info.symbols) do
-    local text = s[2] and s[1] or '"' .. s[1]:gsub([[\]], [[\\]]) .. '"'
+    local text = s[2] and s[1] or '"' .. s[1]:gsub([[\]], [[\\]]) .. '"' ---@type string
     if text:find(base, 1, true) then
       table.insert(items, text)
     end
-- 
cgit 


From 908843df61fc80f160392edc0af0d1672a8f9a68 Mon Sep 17 00:00:00 2001
From: L Lllvvuu <git@llllvvuu.dev>
Date: Wed, 13 Sep 2023 16:51:54 -0700
Subject: fix(languagetree): apply `resolve_lang` to
 `metadata['injection.language']`

`resolve_lang` is applied to `@injection.language` when it's supplied as a
capture:

https://github.com/neovim/neovim/blob/f5953edbac14febce9d4f8a3c35bdec1eae26fbe/runtime/lua/vim/treesitter/languagetree.lua#L766-L768

If we want to support `metadata['injection.language']` (as per #22518 and
[tree-sitter upstream](https://tree-sitter.github.io/tree-sitter/syntax-highlighting#language-injection))
then the behavior should be consistent.

Fixes: nvim-treesitter/nvim-treesitter#4918
---
 runtime/lua/vim/treesitter/languagetree.lua | 17 ++++++++++++++---
 1 file changed, 14 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 79f36a27fd..4dd5a18396 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -734,7 +734,8 @@ local has_parser = function(lang)
     or #vim.api.nvim_get_runtime_file('parser/' .. lang .. '.*', false) > 0
 end
 
---- Return parser name for language (if exists) or filetype (if registered and exists)
+--- Return parser name for language (if exists) or filetype (if registered and exists).
+--- Also attempts with the input lower-cased.
 ---
 ---@param alias string language or filetype name
 ---@return string? # resolved parser name
@@ -743,10 +744,19 @@ local function resolve_lang(alias)
     return alias
   end
 
+  if has_parser(alias:lower()) then
+    return alias:lower()
+  end
+
   local lang = vim.treesitter.language.get_lang(alias)
   if lang and has_parser(lang) then
     return lang
   end
+
+  lang = vim.treesitter.language.get_lang(alias:lower())
+  if lang and has_parser(lang) then
+    return lang
+  end
 end
 
 ---@private
@@ -758,9 +768,10 @@ end
 function LanguageTree:_get_injection(match, metadata)
   local ranges = {} ---@type Range6[]
   local combined = metadata['injection.combined'] ~= nil
+  local injection_lang = metadata['injection.language'] --[[@as string?]]
   local lang = metadata['injection.self'] ~= nil and self:lang()
     or metadata['injection.parent'] ~= nil and self._parent_lang
-    or metadata['injection.language'] --[[@as string?]]
+    or (injection_lang and resolve_lang(injection_lang))
   local include_children = metadata['injection.include-children'] ~= nil
 
   for id, node in pairs(match) do
@@ -768,7 +779,7 @@ function LanguageTree:_get_injection(match, metadata)
     -- Lang should override any other language tag
     if name == 'injection.language' then
       local text = vim.treesitter.get_node_text(node, self._source, { metadata = metadata[id] })
-      lang = resolve_lang(text) or resolve_lang(text:lower())
+      lang = resolve_lang(text)
     elseif name == 'injection.content' then
       ranges = get_node_ranges(node, self._source, metadata[id], include_children)
     end
-- 
cgit 


From 07080f67fe7e526576d5d50777fb122a99b3e183 Mon Sep 17 00:00:00 2001
From: L Lllvvuu <git@llllvvuu.dev>
Date: Sat, 16 Sep 2023 02:48:49 -0700
Subject: perf(treesitter): do not scan past given line for predicate match

Problem
---
If a highlighter query returns a significant number of predicate
non-matches, the highlighter will scan well past the end of the window.

Solution
---
In the iterator returned from `iter_captures`, accept an optional
parameter `end_line`. If no parameter provided, the behavior is
unchanged, hence this is a non-invasive tweak.

Fixes: #25113 nvim-treesitter/nvim-treesitter#5057
---
 runtime/lua/vim/treesitter/highlighter.lua | 63 ++++++++++++++++--------------
 runtime/lua/vim/treesitter/query.lua       | 10 +++--
 2 files changed, 40 insertions(+), 33 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/highlighter.lua b/runtime/lua/vim/treesitter/highlighter.lua
index 8d4d6a9337..496193c6ed 100644
--- a/runtime/lua/vim/treesitter/highlighter.lua
+++ b/runtime/lua/vim/treesitter/highlighter.lua
@@ -2,7 +2,7 @@ local api = vim.api
 local query = vim.treesitter.query
 local Range = require('vim.treesitter._range')
 
----@alias TSHlIter fun(): integer, TSNode, TSMetadata
+---@alias TSHlIter fun(end_line: integer|nil): integer, TSNode, TSMetadata
 
 ---@class TSHighlightState
 ---@field next_row integer
@@ -241,40 +241,43 @@ local function on_line_impl(self, buf, line, is_spell_nav)
     end
 
     while line >= state.next_row do
-      local capture, node, metadata = state.iter()
+      local capture, node, metadata = state.iter(line)
 
-      if capture == nil then
-        break
+      local range = { root_end_row + 1, 0, root_end_row + 1, 0 }
+      if node then
+        range = vim.treesitter.get_range(node, buf, metadata and metadata[capture])
       end
-
-      local range = vim.treesitter.get_range(node, buf, metadata[capture])
       local start_row, start_col, end_row, end_col = Range.unpack4(range)
-      local hl = highlighter_query.hl_cache[capture]
-
-      local capture_name = highlighter_query:query().captures[capture]
-      local spell = nil ---@type boolean?
-      if capture_name == 'spell' then
-        spell = true
-      elseif capture_name == 'nospell' then
-        spell = false
-      end
 
-      -- Give nospell a higher priority so it always overrides spell captures.
-      local spell_pri_offset = capture_name == 'nospell' and 1 or 0
-
-      if hl and end_row >= line and (not is_spell_nav or spell ~= nil) then
-        local priority = (tonumber(metadata.priority) or vim.highlight.priorities.treesitter)
-          + spell_pri_offset
-        api.nvim_buf_set_extmark(buf, ns, start_row, start_col, {
-          end_line = end_row,
-          end_col = end_col,
-          hl_group = hl,
-          ephemeral = true,
-          priority = priority,
-          conceal = metadata.conceal,
-          spell = spell,
-        })
+      if capture then
+        local hl = highlighter_query.hl_cache[capture]
+
+        local capture_name = highlighter_query:query().captures[capture]
+        local spell = nil ---@type boolean?
+        if capture_name == 'spell' then
+          spell = true
+        elseif capture_name == 'nospell' then
+          spell = false
+        end
+
+        -- Give nospell a higher priority so it always overrides spell captures.
+        local spell_pri_offset = capture_name == 'nospell' and 1 or 0
+
+        if hl and end_row >= line and (not is_spell_nav or spell ~= nil) then
+          local priority = (tonumber(metadata.priority) or vim.highlight.priorities.treesitter)
+            + spell_pri_offset
+          api.nvim_buf_set_extmark(buf, ns, start_row, start_col, {
+            end_line = end_row,
+            end_col = end_col,
+            hl_group = hl,
+            ephemeral = true,
+            priority = priority,
+            conceal = metadata.conceal,
+            spell = spell,
+          })
+        end
       end
+
       if start_row > line then
         state.next_row = start_row
       end
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index d7973cc48f..6d9b214d4a 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -708,7 +708,8 @@ end
 ---@param start integer Starting line for the search
 ---@param stop integer Stopping line for the search (end-exclusive)
 ---
----@return (fun(): integer, TSNode, TSMetadata): capture id, capture node, metadata
+---@return (fun(end_line: integer|nil): integer, TSNode, TSMetadata):
+---        capture id, capture node, metadata
 function Query:iter_captures(node, source, start, stop)
   if type(source) == 'number' and source == 0 then
     source = api.nvim_get_current_buf()
@@ -717,7 +718,7 @@ function Query:iter_captures(node, source, start, stop)
   start, stop = value_or_node_range(start, stop, node)
 
   local raw_iter = node:_rawquery(self.query, true, start, stop)
-  local function iter()
+  local function iter(end_line)
     local capture, captured_node, match = raw_iter()
     local metadata = {}
 
@@ -725,7 +726,10 @@ function Query:iter_captures(node, source, start, stop)
       local active = self:match_preds(match, match.pattern, source)
       match.active = active
       if not active then
-        return iter() -- tail call: try next match
+        if end_line and captured_node:range() > end_line then
+          return nil, captured_node, nil
+        end
+        return iter(end_line) -- tail call: try next match
       end
 
       self:apply_directives(match, match.pattern, source, metadata)
-- 
cgit 


From b3342171d533f3d9dd33bbe5ff09f0d7b007f5a3 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sat, 16 Sep 2023 11:43:02 +0100
Subject: fix(typing): vim.fn.execute

---
 runtime/lua/vim/_meta/vimfn.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index efb779ad41..2062e96b21 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -1630,9 +1630,9 @@ function vim.fn.executable(expr) end
 --- To execute a command in another window than the current one
 --- use `win_execute()`.
 ---
---- @param command any
---- @param silent? boolean
---- @return any
+--- @param command string|string[]
+--- @param silent? ''|'silent'|'silent!'
+--- @return string
 function vim.fn.execute(command, silent) end
 
 --- Returns the full path of {expr} if it is an executable and
-- 
cgit 


From f40a109716d7f748dd9e9f70b57e4d0bb285518b Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Wed, 13 Sep 2023 10:39:34 +0100
Subject: fix(treesitter): fix trim predicate

---
 runtime/lua/vim/treesitter/query.lua | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 6d9b214d4a..e83ad00eeb 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -514,7 +514,10 @@ local directive_handlers = {
   -- Example: (#trim! @fold)
   -- TODO(clason): generalize to arbitrary whitespace removal
   ['trim!'] = function(match, _, bufnr, pred, metadata)
-    local node = match[pred[2]]
+    local capture_id = pred[2]
+    assert(type(capture_id) == 'number')
+
+    local node = match[capture_id]
     if not node then
       return
     end
@@ -526,9 +529,9 @@ local directive_handlers = {
       return
     end
 
-    while true do
+    while end_row >= start_row do
       -- As we only care when end_col == 0, always inspect one line above end_row.
-      local end_line = vim.api.nvim_buf_get_lines(bufnr, end_row - 1, end_row, true)[1]
+      local end_line = api.nvim_buf_get_lines(bufnr, end_row - 1, end_row, true)[1]
 
       if end_line ~= '' then
         break
@@ -539,7 +542,8 @@ local directive_handlers = {
 
     -- If this produces an invalid range, we just skip it.
     if start_row < end_row or (start_row == end_row and start_col <= end_col) then
-      metadata.range = { start_row, start_col, end_row, end_col }
+      metadata[capture_id] = metadata[capture_id] or {}
+      metadata[capture_id].range = { start_row, start_col, end_row, end_col }
     end
   end,
 }
-- 
cgit 


From 7e5ce42977d7b2f223ca57e0237db778b8e424ea Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sat, 16 Sep 2023 23:43:22 +0900
Subject: fix(treesitter): properly combine injection.combined regions

Problem:
It doesn't make much sense to flatten each region (= list of ranges).
This coincidentally worked for region with a single range.

Solution:
Custom function for combining regions.
---
 runtime/lua/vim/treesitter/languagetree.lua | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 4dd5a18396..b555ee231b 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -788,6 +788,19 @@ function LanguageTree:_get_injection(match, metadata)
   return lang, combined, ranges
 end
 
+--- Can't use vim.tbl_flatten since a range is just a table.
+---@param regions Range6[][]
+---@return Range6[]
+local function combine_regions(regions)
+  local result = {} ---@type Range6[]
+  for _, region in ipairs(regions) do
+    for _, range in ipairs(region) do
+      result[#result + 1] = range
+    end
+  end
+  return result
+end
+
 --- Gets language injection points by language.
 ---
 --- This is where most of the injection processing occurs.
@@ -833,11 +846,7 @@ function LanguageTree:_get_injections()
 
       for _, entry in pairs(patterns) do
         if entry.combined then
-          ---@diagnostic disable-next-line:no-unknown
-          local regions = vim.tbl_map(function(e)
-            return vim.tbl_flatten(e)
-          end, entry.regions)
-          table.insert(result[lang], regions)
+          table.insert(result[lang], combine_regions(entry.regions))
         else
           for _, ranges in pairs(entry.regions) do
             table.insert(result[lang], ranges)
-- 
cgit 


From 28f54a78782318cb9c356a372b9e52a3a6b1f8dd Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sat, 16 Sep 2023 10:05:59 -0700
Subject: feat(treesitter): add lang parameter to the query editor (#25181)

---
 runtime/lua/vim/treesitter/dev.lua   | 15 ++++++++-------
 runtime/lua/vim/treesitter/query.lua |  6 ++++--
 2 files changed, 12 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index bc54853103..7f24ba8590 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -468,11 +468,11 @@ local edit_ns = api.nvim_create_namespace('treesitter/dev-edit')
 
 ---@param query_win integer
 ---@param base_win integer
-local function update_editor_highlights(query_win, base_win)
+---@param lang string
+local function update_editor_highlights(query_win, base_win, lang)
   local base_buf = api.nvim_win_get_buf(base_win)
   local query_buf = api.nvim_win_get_buf(query_win)
-  local parser = vim.treesitter.get_parser(base_buf)
-  local lang = parser:lang()
+  local parser = vim.treesitter.get_parser(base_buf, lang)
   api.nvim_buf_clear_namespace(base_buf, edit_ns, 0, -1)
   local query_content = table.concat(api.nvim_buf_get_lines(query_buf, 0, -1, false), '\n')
 
@@ -506,7 +506,8 @@ local function update_editor_highlights(query_win, base_win)
 end
 
 --- @private
-function M.edit_query()
+--- @param lang? string language to open the query editor for.
+function M.edit_query(lang)
   local buf = api.nvim_get_current_buf()
   local win = api.nvim_get_current_win()
 
@@ -528,11 +529,11 @@ function M.edit_query()
   end
   vim.cmd(cmd)
 
-  local ok, parser = pcall(vim.treesitter.get_parser, buf)
+  local ok, parser = pcall(vim.treesitter.get_parser, buf, lang)
   if not ok then
     return nil, 'No parser available for the given buffer'
   end
-  local lang = parser:lang()
+  lang = parser:lang()
 
   local query_win = api.nvim_get_current_win()
   local query_buf = api.nvim_win_get_buf(query_win)
@@ -561,7 +562,7 @@ function M.edit_query()
     desc = 'Update query editor highlights when the cursor moves',
     callback = function()
       if api.nvim_win_is_valid(win) then
-        update_editor_highlights(query_win, win)
+        update_editor_highlights(query_win, win, lang)
       end
     end,
   })
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index e83ad00eeb..44ed37d64e 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -848,8 +848,10 @@ end
 --- Can also be shown with `:EditQuery`. *:EditQuery*
 ---
 --- Note that the editor opens a scratch buffer, and so queries aren't persisted on disk.
-function M.edit()
-  require('vim.treesitter.dev').edit_query()
+---
+--- @param lang? string language to open the query editor for. If omitted, inferred from the current buffer's filetype.
+function M.edit(lang)
+  require('vim.treesitter.dev').edit_query(lang)
 end
 
 return M
-- 
cgit 


From 4ab9c5fa46845807a2dc6dd91fc5fb78ccc70856 Mon Sep 17 00:00:00 2001
From: Phelipe Teles <39670535+phelipetls@users.noreply.github.com>
Date: Sat, 16 Sep 2023 19:35:12 -0300
Subject: fix(lua): not using global value in vim.opt_global (#25196)

---
 runtime/lua/vim/_options.lua | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_options.lua b/runtime/lua/vim/_options.lua
index 7b44f6b35f..6a3413b597 100644
--- a/runtime/lua/vim/_options.lua
+++ b/runtime/lua/vim/_options.lua
@@ -727,7 +727,10 @@ local function create_option_accessor(scope)
 
   return setmetatable({}, {
     __index = function(_, k)
-      return make_option(k, api.nvim_get_option_value(k, {}))
+      -- vim.opt_global must get global value only
+      -- vim.opt_local may fall back to global value like vim.opt
+      local opts = { scope = scope == 'global' and 'global' or nil }
+      return make_option(k, api.nvim_get_option_value(k, opts))
     end,
 
     __newindex = function(_, k, v)
-- 
cgit 


From 71d9b7d15c9b2e0df7db69a172aea0723a40bb71 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Sun, 17 Sep 2023 17:54:30 +0900
Subject: fix(treesitter): _trees may not be list-like

Problem:
With incremental injection parsing, injected languages' parsers parse
only the relevant regions and stores the result in _trees with the index
of the corresponding region. Therefore, there can be holes in _trees.

Solution:
* Use generic table functions where appropriate.
* Fix type annotations and docs.
---
 runtime/lua/vim/treesitter/_meta.lua        |  3 +-
 runtime/lua/vim/treesitter/languagetree.lua | 57 +++++++++++++++++------------
 2 files changed, 36 insertions(+), 24 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index 9a94f12c16..d01b7be3b0 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -50,7 +50,8 @@ function TSNode:_rawquery(query, captures, start, end_, opts) end
 ---@alias TSLoggerCallback fun(logtype: 'parse'|'lex', msg: string)
 
 ---@class TSParser
----@field parse fun(self: TSParser, tree: TSTree?, source: integer|string, include_bytes: boolean?): TSTree, integer[]
+---@field parse fun(self: TSParser, tree: TSTree?, source: integer|string, include_bytes: true): TSTree, Range6[]
+---@field parse fun(self: TSParser, tree: TSTree?, source: integer|string, include_bytes: false|nil): TSTree, Range4[]
 ---@field reset fun(self: TSParser)
 ---@field included_ranges fun(self: TSParser, include_bytes: boolean?): integer[]
 ---@field set_included_ranges fun(self: TSParser, ranges: (Range6|TSNode)[])
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index b555ee231b..f931291ed7 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -78,13 +78,14 @@ local TSCallbackNames = {
 ---@field private _opts table Options
 ---@field private _parser TSParser Parser for language
 ---@field private _has_regions boolean
----@field private _regions Range6[][]?
+---@field private _regions table<integer, Range6[]>?
 ---List of regions this tree should manage and parse. If nil then regions are
 ---taken from _trees. This is mostly a short-lived cache for included_regions()
 ---@field private _lang string Language name
 ---@field private _parent_lang? string Parent language name
 ---@field private _source (integer|string) Buffer or string to parse
----@field private _trees TSTree[] Reference to parsed tree (one for each language)
+---@field private _trees table<integer, TSTree> Reference to parsed tree (one for each language).
+---Each key is the index of region, which is synced with _regions and _valid.
 ---@field private _valid boolean|table<integer,boolean> If the parsed tree is valid
 ---@field private _logger? fun(logtype: string, msg: string)
 ---@field private _logfile? file*
@@ -211,7 +212,7 @@ function LanguageTree:_log(...)
   end
 
   local info = debug.getinfo(2, 'nl')
-  local nregions = #self:included_regions()
+  local nregions = vim.tbl_count(self:included_regions())
   local prefix =
     string.format('%s:%d: (#regions=%d) ', info.name or '???', info.currentline or 0, nregions)
 
@@ -244,8 +245,13 @@ function LanguageTree:invalidate(reload)
   end
 end
 
---- Returns all trees this language tree contains.
+--- Returns all trees of the regions parsed by this parser.
 --- Does not include child languages.
+--- The result is list-like if
+--- * this LanguageTree is the root, in which case the result is empty or a singleton list; or
+--- * the root LanguageTree is fully parsed.
+---
+---@return table<integer, TSTree>
 function LanguageTree:trees()
   return self._trees
 end
@@ -255,16 +261,15 @@ function LanguageTree:lang()
   return self._lang
 end
 
---- Determines whether this tree is valid.
---- If the tree is invalid, call `parse()`.
---- This will return the updated tree.
----@param exclude_children boolean|nil
+--- Returns whether this LanguageTree is valid, i.e., |LanguageTree:trees()| reflects the latest
+--- state of the source. If invalid, user should call |LanguageTree:parse()|.
+---@param exclude_children boolean|nil whether to ignore the validity of children (default `false`)
 ---@return boolean
 function LanguageTree:is_valid(exclude_children)
   local valid = self._valid
 
   if type(valid) == 'table' then
-    for i = 1, #self:included_regions() do
+    for i, _ in pairs(self:included_regions()) do
       if not valid[i] then
         return false
       end
@@ -328,7 +333,7 @@ end
 
 --- @private
 --- @param range boolean|Range?
---- @return integer[] changes
+--- @return Range6[] changes
 --- @return integer no_regions_parsed
 --- @return number total_parse_time
 function LanguageTree:_parse_regions(range)
@@ -370,7 +375,7 @@ function LanguageTree:_add_injections()
   local seen_langs = {} ---@type table<string,boolean>
 
   local query_time, injections_by_lang = tcall(self._get_injections, self)
-  for lang, injection_ranges in pairs(injections_by_lang) do
+  for lang, injection_regions in pairs(injections_by_lang) do
     local has_lang = pcall(language.add, lang)
 
     -- Child language trees should just be ignored if not found, since
@@ -383,7 +388,7 @@ function LanguageTree:_add_injections()
         child = self:add_child(lang)
       end
 
-      child:set_included_regions(injection_ranges)
+      child:set_included_regions(injection_regions)
       seen_langs[lang] = true
     end
   end
@@ -408,14 +413,14 @@ end
 ---     Set to `true` to run a complete parse of the source (Note: Can be slow!)
 ---     Set to `false|nil` to only parse regions with empty ranges (typically
 ---     only the root tree without injections).
---- @return TSTree[]
+--- @return table<integer, TSTree>
 function LanguageTree:parse(range)
   if self:is_valid() then
     self:_log('valid')
     return self._trees
   end
 
-  local changes --- @type Range6?
+  local changes --- @type Range6[]?
 
   -- Collect some stats
   local no_regions_parsed = 0
@@ -565,7 +570,7 @@ function LanguageTree:_iter_regions(fn)
 
   local all_valid = true
 
-  for i, region in ipairs(self:included_regions()) do
+  for i, region in pairs(self:included_regions()) do
     if was_valid or self._valid[i] then
       self._valid[i] = fn(i, region)
       if not self._valid[i] then
@@ -601,7 +606,7 @@ end
 --- nodes, which is useful for templating languages like ERB and EJS.
 ---
 ---@private
----@param new_regions Range6[][] List of regions this tree should manage and parse.
+---@param new_regions (Range4|Range6|TSNode)[][] List of regions this tree should manage and parse.
 function LanguageTree:set_included_regions(new_regions)
   self._has_regions = true
 
@@ -609,16 +614,20 @@ function LanguageTree:set_included_regions(new_regions)
   for _, region in ipairs(new_regions) do
     for i, range in ipairs(region) do
       if type(range) == 'table' and #range == 4 then
-        region[i] = Range.add_bytes(self._source, range)
+        region[i] = Range.add_bytes(self._source, range --[[@as Range4]])
       elseif type(range) == 'userdata' then
         region[i] = { range:range(true) }
       end
     end
   end
 
+  -- included_regions is not guaranteed to be list-like, but this is still sound, i.e. if
+  -- new_regions is different from included_regions, then outdated regions in included_regions are
+  -- invalidated. For example, if included_regions = new_regions ++ hole ++ outdated_regions, then
+  -- outdated_regions is invalidated by _iter_regions in else branch.
   if #self:included_regions() ~= #new_regions then
     -- TODO(lewis6991): inefficient; invalidate trees incrementally
-    for _, t in ipairs(self._trees) do
+    for _, t in pairs(self._trees) do
       self:_do_callback('changedtree', t:included_ranges(true), t)
     end
     self._trees = {}
@@ -632,20 +641,22 @@ function LanguageTree:set_included_regions(new_regions)
   self._regions = new_regions
 end
 
----Gets the set of included regions
----@return Range6[][]
+---Gets the set of included regions managed by this LanguageTree. This can be different from the
+---regions set by injection query, because a partial |LanguageTree:parse()| drops the regions
+---outside the requested range.
+---@return table<integer, Range6[]>
 function LanguageTree:included_regions()
   if self._regions then
     return self._regions
   end
 
-  if not self._has_regions or #self._trees == 0 then
+  if not self._has_regions or next(self._trees) == nil then
     -- treesitter.c will default empty ranges to { -1, -1, -1, -1, -1, -1}
     return { {} }
   end
 
   local regions = {} ---@type Range6[][]
-  for i, _ in ipairs(self._trees) do
+  for i, _ in pairs(self._trees) do
     regions[i] = self._trees[i]:included_ranges(true)
   end
 
@@ -801,7 +812,7 @@ local function combine_regions(regions)
   return result
 end
 
---- Gets language injection points by language.
+--- Gets language injection regions by language.
 ---
 --- This is where most of the injection processing occurs.
 ---
-- 
cgit 


From ed45aa835c31408947acda08f605949bcea6b99d Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sun, 17 Sep 2023 19:18:21 +0200
Subject: vim-patch:9.0.1907: No support for liquidsoap filetypes

Problem:  No support for liquidsoap filetypes
Solution: Add liquidsoap filetype detection code

closes: vim/vim#13111

https://github.com/vim/vim/commit/6b5efcdd8e976d2ab2554b22c4220c5e88de4717

Co-authored-by: Romain Beauxis <toots@rastageeks.org>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index d847c28f5c..c7f025f9e7 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -592,6 +592,7 @@ local extension = {
   ly = 'lilypond',
   ily = 'lilypond',
   liquid = 'liquid',
+  liq = 'liquidsoap',
   cl = 'lisp',
   L = 'lisp',
   lisp = 'lisp',
-- 
cgit 


From fd08fd3de3020647c8ae73f1c7d2cf9a4926c828 Mon Sep 17 00:00:00 2001
From: glepnir <glephunter@gmail.com>
Date: Thu, 14 Sep 2023 13:30:51 +0800
Subject: fix(float): add fixd option

---
 runtime/lua/vim/_meta/api.lua         | 2 ++
 runtime/lua/vim/_meta/api_keysets.lua | 1 +
 2 files changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 7cd0d825a1..392f733112 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1585,6 +1585,8 @@ function vim.api.nvim_open_term(buffer, opts) end
 ---               • noautocmd: If true then no buffer-related autocommand
 ---                 events such as `BufEnter`, `BufLeave` or `BufWinEnter` may
 ---                 fire from calling this function.
+---               • fixed: If true when anchor is NW or SW, the float window
+---                 would be kept fixed even if the window would be truncated.
 --- @return integer
 function vim.api.nvim_open_win(buffer, enter, config) end
 
diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index 4d08563ce2..b249f6629f 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -112,6 +112,7 @@ error('Cannot require a meta file')
 --- @field footer_pos? string
 --- @field style? string
 --- @field noautocmd? boolean
+--- @field fixed? boolean
 
 --- @class vim.api.keyset.get_autocmds
 --- @field event? any
-- 
cgit 


From 8da986ea877b07a5eb117446f410f2a7fc8cd9cb Mon Sep 17 00:00:00 2001
From: bfredl <bjorn.linse@gmail.com>
Date: Wed, 13 Sep 2023 13:39:18 +0200
Subject: refactor(grid): change schar_T representation to be more compact

Previously, a screen cell would occupy 28+4=32 bytes per cell
as we always made space for up to MAX_MCO+1 codepoints in a cell.

As an example, even a pretty modest 50*80 screen would consume

50*80*2*32 = 256000, i e a quarter megabyte

With the factor of two due to the TUI side buffer, and even more when
using msg_grid and/or ext_multigrid.

This instead stores a 4-byte union of either:
- a valid UTF-8 sequence up to 4 bytes
- an escape char which is invalid UTF-8 (0xFF) plus a 24-bit index to a
  glyph cache

This avoids allocating space for huge composed glyphs _upfront_, while
still keeping rendering such glyphs reasonably fast (1 hash table lookup
+ one plain index lookup). If the same large glyphs are using repeatedly
on the screen, this is still a net reduction of memory/cache
consumption. The only case which really gets worse is if you blast
the screen full with crazy emojis and zalgo text and even this case
only leads to 4 extra bytes per char.

When only <= 4-byte glyphs are used, plus the 4-byte attribute code,
i e 8 bytes in total there is a factor of four reduction of memory use.
Memory which will be quite hot in cache as the screen buffer is scanned
over in win_line() buffer text drawing

A slight complication is that the representation depends on host byte
order. I've tested this manually by compling and running this
in qemu-s390x and it works fine. We might add a qemu based solution
to CI at some point.
---
 runtime/lua/vim/_meta/api.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 6573c68493..c0c8cabfb9 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -79,6 +79,9 @@ function vim.api.nvim__id_float(flt) end
 --- @return any[]
 function vim.api.nvim__inspect_cell(grid, row, col) end
 
+--- @private
+function vim.api.nvim__invalidate_glyph_cache() end
+
 --- @private
 --- @return any[]
 function vim.api.nvim__runtime_inspect() end
-- 
cgit 


From cfd4a9dfaf5fd900264a946ca33c4a4f26f66a49 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Tue, 12 Sep 2023 20:51:21 -0700
Subject: feat(lsp): use treesitter for stylize markdown

---
 runtime/lua/vim/lsp/handlers.lua |  15 +++-
 runtime/lua/vim/lsp/util.lua     | 177 ++++++++++++++++++++++++++-------------
 2 files changed, 130 insertions(+), 62 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index 4ea3dde81c..f8407be159 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -371,15 +371,22 @@ function M.hover(_, result, ctx, config)
     end
     return
   end
-  local markdown_lines = util.convert_input_to_markdown_lines(result.contents)
-  markdown_lines = util.trim_empty_lines(markdown_lines)
-  if vim.tbl_isempty(markdown_lines) then
+  local format = 'markdown'
+  local contents ---@type string[]
+  if type(result.contents) == 'table' and result.contents.kind == 'plaintext' then
+    format = 'plaintext'
+    contents = { result.contents.value or '' }
+  else
+    contents = util.convert_input_to_markdown_lines(result.contents)
+  end
+  contents = util.trim_empty_lines(contents)
+  if vim.tbl_isempty(contents) then
     if config.silent ~= true then
       vim.notify('No information available')
     end
     return
   end
-  return util.open_floating_preview(markdown_lines, 'markdown', config)
+  return util.open_floating_preview(contents, format, config)
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 54721865b7..32e85578d3 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -877,9 +877,12 @@ end
 --- window for `textDocument/hover`, for parsing the result of
 --- `textDocument/signatureHelp`, and potentially others.
 ---
+--- Note that if the input is of type `MarkupContent` and its kind is `plaintext`,
+--- then the corresponding value is returned without further modifications.
+---
 ---@param input (`MarkedString` | `MarkedString[]` | `MarkupContent`)
 ---@param contents (table|nil) List of strings to extend with converted lines. Defaults to {}.
----@return table {contents} extended with lines of converted markdown.
+---@return string[] extended with lines of converted markdown.
 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover
 function M.convert_input_to_markdown_lines(input, contents)
   contents = contents or {}
@@ -887,27 +890,13 @@ function M.convert_input_to_markdown_lines(input, contents)
   if type(input) == 'string' then
     list_extend(contents, split_lines(input))
   else
-    assert(type(input) == 'table', 'Expected a table for Hover.contents')
+    assert(type(input) == 'table', 'Expected a table for LSP input')
     -- MarkupContent
     if input.kind then
-      -- The kind can be either plaintext or markdown.
-      -- If it's plaintext, then wrap it in a <text></text> block
-
-      -- Some servers send input.value as empty, so let's ignore this :(
       local value = input.value or ''
-
-      if input.kind == 'plaintext' then
-        -- wrap this in a <text></text> block so that stylize_markdown
-        -- can properly process it as plaintext
-        value = string.format('<text>\n%s\n</text>', value)
-      end
-
-      -- assert(type(value) == 'string')
       list_extend(contents, split_lines(value))
       -- MarkupString variation 2
     elseif input.language then
-      -- Some servers send input.value as empty, so let's ignore this :(
-      -- assert(type(input.value) == 'string')
       table.insert(contents, '```' .. input.language)
       list_extend(contents, split_lines(input.value or ''))
       table.insert(contents, '```')
@@ -925,7 +914,7 @@ function M.convert_input_to_markdown_lines(input, contents)
   return contents
 end
 
---- Converts `textDocument/SignatureHelp` response to markdown lines.
+--- Converts `textDocument/signatureHelp` response to markdown lines.
 ---
 ---@param signature_help table Response of `textDocument/SignatureHelp`
 ---@param ft string|nil filetype that will be use as the `lang` for the label markdown code block
@@ -955,7 +944,7 @@ function M.convert_signature_help_to_markdown_lines(signature_help, ft, triggers
   end
   local label = signature.label
   if ft then
-    -- wrap inside a code block so stylize_markdown can render it properly
+    -- wrap inside a code block for proper rendering
     label = ('```%s\n%s\n```'):format(ft, label)
   end
   list_extend(contents, split(label, '\n', { plain = true }))
@@ -1223,7 +1212,7 @@ function M.preview_location(location, opts)
   local syntax = vim.bo[bufnr].syntax
   if syntax == '' then
     -- When no syntax is set, we use filetype as fallback. This might not result
-    -- in a valid syntax definition. See also ft detection in stylize_markdown.
+    -- in a valid syntax definition.
     -- An empty syntax is more common now with TreeSitter, since TS disables syntax.
     syntax = vim.bo[bufnr].filetype
   end
@@ -1240,36 +1229,65 @@ local function find_window_by_var(name, value)
   end
 end
 
---- Trims empty lines from input and pad top and bottom with empty lines
----
----@param contents table of lines to trim and pad
----@param opts table with optional fields
----             - pad_top    number of lines to pad contents at top (default 0)
----             - pad_bottom number of lines to pad contents at bottom (default 0)
----@return table table of trimmed and padded lines
-function M._trim(contents, opts)
-  validate({
-    contents = { contents, 't' },
-    opts = { opts, 't', true },
-  })
-  opts = opts or {}
-  contents = M.trim_empty_lines(contents)
-  if opts.pad_top then
-    for _ = 1, opts.pad_top do
-      table.insert(contents, 1, '')
+---Returns true if the line is empty or only contains whitespace.
+---@param line string
+---@return boolean
+local function is_blank_line(line)
+  return line and line:match('^%s*$')
+end
+
+---Returns true if the line corresponds to a Markdown thematic break.
+---@param line string
+---@return boolean
+local function is_separator_line(line)
+  return line and line:match('^ ? ? ?%-%-%-+%s*$')
+end
+
+---Replaces separator lines by the given divider and removing surrounding blank lines.
+---@param contents string[]
+---@param divider string
+---@return string[]
+local function replace_separators(contents, divider)
+  local trimmed = {}
+  local l = 1
+  while l <= #contents do
+    local line = contents[l]
+    if is_separator_line(line) then
+      if l > 1 and is_blank_line(contents[l - 1]) then
+        table.remove(trimmed)
+      end
+      table.insert(trimmed, divider)
+      if is_blank_line(contents[l + 1]) then
+        l = l + 1
+      end
+    else
+      table.insert(trimmed, line)
     end
+    l = l + 1
   end
-  if opts.pad_bottom then
-    for _ = 1, opts.pad_bottom do
-      table.insert(contents, '')
+
+  return trimmed
+end
+
+---Collapses successive blank lines in the input table into a single one.
+---@param contents string[]
+---@return string[]
+local function collapse_blank_lines(contents)
+  local collapsed = {}
+  local l = 1
+  while l <= #contents do
+    local line = contents[l]
+    if is_blank_line(line) then
+      while is_blank_line(contents[l + 1]) do
+        l = l + 1
+      end
     end
+    table.insert(collapsed, line)
+    l = l + 1
   end
-  return contents
+  return collapsed
 end
 
---- Generates a table mapping markdown code block lang to vim syntax,
---- based on g:markdown_fenced_languages
----@return table table of lang -> syntax mappings
 local function get_markdown_fences()
   local fences = {}
   for _, fence in pairs(vim.g.markdown_fenced_languages or {}) do
@@ -1297,8 +1315,6 @@ end
 ---  - wrap_at   character to wrap at for computing height
 ---  - max_width  maximal width of floating window
 ---  - max_height maximal height of floating window
----  - pad_top    number of lines to pad contents at top
----  - pad_bottom number of lines to pad contents at bottom
 ---  - separator insert separator after code block
 ---@return table stripped content
 function M.stylize_markdown(bufnr, contents, opts)
@@ -1335,7 +1351,7 @@ function M.stylize_markdown(bufnr, contents, opts)
   end
 
   -- Clean up
-  contents = M._trim(contents, opts)
+  contents = M.trim_empty_lines(contents)
 
   local stripped = {}
   local highlights = {}
@@ -1484,6 +1500,49 @@ function M.stylize_markdown(bufnr, contents, opts)
   return stripped
 end
 
+--- @class lsp.util.NormalizeMarkdownOptions
+--- @field width integer Thematic breaks are expanded to this size. Defaults to 80.
+
+--- Normalizes Markdown input to a canonical form.
+---
+--- The returned Markdown adheres to the GitHub Flavored Markdown (GFM)
+--- specification.
+---
+--- The following transformations are made:
+---
+---   1. Empty lines at the beginning or end of the content are removed
+---   2. Carriage returns ('\r') are removed
+---   3. Successive empty lines are collapsed into a single empty line
+---   4. Thematic breaks are expanded to the given width
+---
+---@private
+---@param contents string[]
+---@param opts? lsp.util.NormalizeMarkdownOptions
+---@return string[] table of lines containing normalized Markdown
+---@see https://github.github.com/gfm
+function M._normalize_markdown(contents, opts)
+  validate({
+    contents = { contents, 't' },
+    opts = { opts, 't', true },
+  })
+  opts = opts or {}
+
+  -- 1. Empty lines at the beginning or end of the content are removed
+  contents = M.trim_empty_lines(contents)
+
+  -- 2. Carriage returns are removed
+  contents = vim.split(table.concat(contents, '\n'):gsub('\r', ''), '\n')
+
+  -- 3. Successive empty lines are collapsed into a single empty line
+  contents = collapse_blank_lines(contents)
+
+  -- 4. Thematic breaks are expanded to the given width
+  local divider = string.rep('─', opts.width or 80)
+  contents = replace_separators(contents, divider)
+
+  return contents
+end
+
 --- Closes the preview window
 ---
 ---@param winnr integer window id of preview window
@@ -1620,8 +1679,6 @@ end
 ---             - wrap_at: (integer) character to wrap at for computing height when wrap is enabled
 ---             - max_width: (integer) maximal width of floating window
 ---             - max_height: (integer) maximal height of floating window
----             - pad_top: (integer) number of lines to pad contents at top
----             - pad_bottom: (integer) number of lines to pad contents at bottom
 ---             - focus_id: (string) if a popup with this id is opened, then focus it
 ---             - close_events: (table) list of events that closes the floating window
 ---             - focusable: (boolean, default true) Make float focusable
@@ -1629,8 +1686,7 @@ end
 ---                      is also `true`, focus an existing floating window with the same
 ---                      {focus_id}
 ---@return integer bufnr of newly created float window
----@return integer winid of newly created float window
----preview window
+---@return integer winid of newly created float window preview window
 function M.open_floating_preview(contents, syntax, opts)
   validate({
     contents = { contents, 't' },
@@ -1639,7 +1695,6 @@ function M.open_floating_preview(contents, syntax, opts)
   })
   opts = opts or {}
   opts.wrap = opts.wrap ~= false -- wrapping by default
-  opts.stylize_markdown = opts.stylize_markdown ~= false and vim.g.syntax_on ~= nil
   opts.focus = opts.focus ~= false
   opts.close_events = opts.close_events or { 'CursorMoved', 'CursorMovedI', 'InsertCharPre' }
 
@@ -1671,16 +1726,21 @@ function M.open_floating_preview(contents, syntax, opts)
     api.nvim_win_close(existing_float, true)
   end
 
+  -- Create the buffer
   local floating_bufnr = api.nvim_create_buf(false, true)
-  local do_stylize = syntax == 'markdown' and opts.stylize_markdown
-
-  -- Clean up input: trim empty lines from the end, pad
-  contents = M._trim(contents, opts)
 
+  -- Set up the contents, using treesitter for markdown
+  local do_stylize = syntax == 'markdown' and vim.g.syntax_on ~= nil
   if do_stylize then
-    -- applies the syntax and sets the lines to the buffer
-    contents = M.stylize_markdown(floating_bufnr, contents, opts)
+    local width = M._make_floating_popup_size(contents, opts)
+    contents = M._normalize_markdown(contents, { width = width })
+    vim.bo[floating_bufnr].filetype = 'markdown'
+    vim.treesitter.start(floating_bufnr)
+    api.nvim_buf_set_lines(floating_bufnr, 0, -1, false, contents)
   else
+    -- Clean up input: trim empty lines from the end, pad
+    contents = M.trim_empty_lines(contents)
+
     if syntax then
       vim.bo[floating_bufnr].syntax = syntax
     end
@@ -1697,9 +1757,9 @@ function M.open_floating_preview(contents, syntax, opts)
 
   local float_option = M.make_floating_popup_options(width, height, opts)
   local floating_winnr = api.nvim_open_win(floating_bufnr, false, float_option)
+
   if do_stylize then
     vim.wo[floating_winnr].conceallevel = 2
-    vim.wo[floating_winnr].concealcursor = 'n'
   end
   -- disable folding
   vim.wo[floating_winnr].foldenable = false
@@ -1708,6 +1768,7 @@ function M.open_floating_preview(contents, syntax, opts)
 
   vim.bo[floating_bufnr].modifiable = false
   vim.bo[floating_bufnr].bufhidden = 'wipe'
+
   api.nvim_buf_set_keymap(
     floating_bufnr,
     'n',
-- 
cgit 


From 5a363ccac8ff5889332bafbf68e7e8d20bca316c Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Mon, 18 Sep 2023 11:04:01 -0700
Subject: fix(lsp)!: deprecate trim_empty_lines

---
 runtime/lua/vim/lsp/handlers.lua |  4 +---
 runtime/lua/vim/lsp/util.lua     | 29 +++++++++++++----------------
 2 files changed, 14 insertions(+), 19 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index f8407be159..d43d9a7cfa 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -375,11 +375,10 @@ function M.hover(_, result, ctx, config)
   local contents ---@type string[]
   if type(result.contents) == 'table' and result.contents.kind == 'plaintext' then
     format = 'plaintext'
-    contents = { result.contents.value or '' }
+    contents = vim.split(result.contents.value or '', '\n', { trimempty = true })
   else
     contents = util.convert_input_to_markdown_lines(result.contents)
   end
-  contents = util.trim_empty_lines(contents)
   if vim.tbl_isempty(contents) then
     if config.silent ~= true then
       vim.notify('No information available')
@@ -477,7 +476,6 @@ function M.signature_help(_, result, ctx, config)
     vim.tbl_get(client.server_capabilities, 'signatureHelpProvider', 'triggerCharacters')
   local ft = vim.bo[ctx.bufnr].filetype
   local lines, hl = util.convert_signature_help_to_markdown_lines(result, ft, triggers)
-  lines = util.trim_empty_lines(lines)
   if vim.tbl_isempty(lines) then
     if config.silent ~= true then
       print('No signature help available')
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 32e85578d3..988057f5f9 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -102,7 +102,7 @@ end
 
 local function split_lines(value)
   value = string.gsub(value, '\r\n?', '\n')
-  return split(value, '\n', { plain = true })
+  return split(value, '\n', { plain = true, trimempty = true })
 end
 
 local function create_window_without_focus()
@@ -947,7 +947,7 @@ function M.convert_signature_help_to_markdown_lines(signature_help, ft, triggers
     -- wrap inside a code block for proper rendering
     label = ('```%s\n%s\n```'):format(ft, label)
   end
-  list_extend(contents, split(label, '\n', { plain = true }))
+  list_extend(contents, split(label, '\n', { plain = true, trimempty = true }))
   if signature.documentation then
     -- if LSP returns plain string, we treat it as plaintext. This avoids
     -- special characters like underscore or similar from being interpreted
@@ -1351,7 +1351,7 @@ function M.stylize_markdown(bufnr, contents, opts)
   end
 
   -- Clean up
-  contents = M.trim_empty_lines(contents)
+  contents = vim.split(table.concat(contents, '\n'), '\n', { trimempty = true })
 
   local stripped = {}
   local highlights = {}
@@ -1510,10 +1510,9 @@ end
 ---
 --- The following transformations are made:
 ---
----   1. Empty lines at the beginning or end of the content are removed
----   2. Carriage returns ('\r') are removed
----   3. Successive empty lines are collapsed into a single empty line
----   4. Thematic breaks are expanded to the given width
+---   1. Carriage returns ('\r') and empty lines at the beginning and end are removed
+---   2. Successive empty lines are collapsed into a single empty line
+---   3. Thematic breaks are expanded to the given width
 ---
 ---@private
 ---@param contents string[]
@@ -1527,16 +1526,13 @@ function M._normalize_markdown(contents, opts)
   })
   opts = opts or {}
 
-  -- 1. Empty lines at the beginning or end of the content are removed
-  contents = M.trim_empty_lines(contents)
+  -- 1. Carriage returns are removed
+  contents = vim.split(table.concat(contents, '\n'):gsub('\r', ''), '\n', { trimempty = true })
 
-  -- 2. Carriage returns are removed
-  contents = vim.split(table.concat(contents, '\n'):gsub('\r', ''), '\n')
-
-  -- 3. Successive empty lines are collapsed into a single empty line
+  -- 2. Successive empty lines are collapsed into a single empty line
   contents = collapse_blank_lines(contents)
 
-  -- 4. Thematic breaks are expanded to the given width
+  -- 3. Thematic breaks are expanded to the given width
   local divider = string.rep('─', opts.width or 80)
   contents = replace_separators(contents, divider)
 
@@ -1738,8 +1734,8 @@ function M.open_floating_preview(contents, syntax, opts)
     vim.treesitter.start(floating_bufnr)
     api.nvim_buf_set_lines(floating_bufnr, 0, -1, false, contents)
   else
-    -- Clean up input: trim empty lines from the end, pad
-    contents = M.trim_empty_lines(contents)
+    -- Clean up input: trim empty lines
+    contents = vim.split(table.concat(contents, '\n'), '\n', { trimempty = true })
 
     if syntax then
       vim.bo[floating_bufnr].syntax = syntax
@@ -1969,6 +1965,7 @@ function M.symbols_to_items(symbols, bufnr)
 end
 
 --- Removes empty lines from the beginning and end.
+---@deprecated use `vim.split()` with `trimempty` instead
 ---@param lines table list of lines to trim
 ---@return table trimmed list of lines
 function M.trim_empty_lines(lines)
-- 
cgit 


From 1b55f51d0d8468ca357514a868ac8e188b0c8722 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Wed, 20 Sep 2023 04:15:23 -0700
Subject: docs: misc #24561

fix #24699
fix #25253
---
 runtime/lua/vim/_meta/api.lua        |   2 +-
 runtime/lua/vim/_meta/options.lua    |   5 +-
 runtime/lua/vim/_meta/vimfn.lua      |   2 +-
 runtime/lua/vim/shared.lua           | 153 +++++++++++++++++------------------
 runtime/lua/vim/treesitter/dev.lua   |   5 +-
 runtime/lua/vim/treesitter/query.lua |   8 +-
 6 files changed, 88 insertions(+), 87 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 41bb5636b8..81fa7ce7ec 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1903,7 +1903,7 @@ function vim.api.nvim_set_hl_ns_fast(ns_id) end
 --- @param rhs string Right-hand-side `{rhs}` of the mapping.
 --- @param opts vim.api.keyset.keymap Optional parameters map: Accepts all `:map-arguments` as keys
 ---             except `<buffer>`, values are booleans (default false). Also:
----             • "noremap" non-recursive mapping `:noremap`
+---             • "noremap" disables `recursive_mapping`, like `:noremap`
 ---             • "desc" human-readable description.
 ---             • "callback" Lua function called in place of {rhs}.
 ---             • "replace_keycodes" (boolean) When "expr" is true, replace
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index af676fa961..734096a755 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -3088,9 +3088,8 @@ vim.go.icon = vim.o.icon
 vim.o.iconstring = ""
 vim.go.iconstring = vim.o.iconstring
 
---- Ignore case in search patterns.  Also used when searching in the tags
---- file.
---- Also see 'smartcase' and 'tagcase'.
+--- Ignore case in search patterns, completion, and when searching the tags file.
+--- See also 'smartcase' and 'tagcase'.
 --- Can be overruled by using "\c" or "\C" in the pattern, see
 --- `/ignorecase`.
 ---
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 2062e96b21..4113797759 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -4528,7 +4528,7 @@ function vim.fn.jobresize(job, width, height) end
 --- @return any
 function vim.fn.jobsend(...) end
 
---- Note: Prefer |vim.system()| in Lua.
+--- Note: Prefer |vim.system()| in Lua (unless using the `pty` option).
 ---
 --- Spawns {cmd} as a job.
 --- If {cmd} is a List it runs directly (no 'shell').
diff --git a/runtime/lua/vim/shared.lua b/runtime/lua/vim/shared.lua
index 0c38fa955a..9542d93789 100644
--- a/runtime/lua/vim/shared.lua
+++ b/runtime/lua/vim/shared.lua
@@ -534,12 +534,12 @@ function vim.tbl_flatten(t)
   return result
 end
 
---- Enumerate a table sorted by its keys.
+--- Enumerates key-value pairs of a table, ordered by key.
 ---
 ---@see Based on https://github.com/premake/premake-core/blob/master/src/base/table.lua
 ---
 ---@param t table Dict-like table
----@return function iterator over sorted keys and their values
+---@return function # |for-in| iterator over sorted keys and their values
 function vim.spairs(t)
   assert(type(t) == 'table', string.format('Expected table, got %s', type(t)))
 
@@ -551,7 +551,6 @@ function vim.spairs(t)
   table.sort(keys)
 
   -- Return the iterator function.
-  -- TODO(justinmk): Return "iterator function, table {t}, and nil", like pairs()?
   local i = 0
   return function()
     i = i + 1
@@ -561,11 +560,14 @@ function vim.spairs(t)
   end
 end
 
---- Tests if a Lua table can be treated as an array (a table indexed by integers).
+--- Tests if `t` is an "array": a table indexed _only_ by integers (potentially non-contiguous).
 ---
---- Empty table `{}` is assumed to be an array, unless it was created by
---- |vim.empty_dict()| or returned as a dict-like |API| or Vimscript result,
---- for example from |rpcrequest()| or |vim.fn|.
+--- If the indexes start from 1 and are contiguous then the array is also a list. |vim.tbl_islist()|
+---
+--- Empty table `{}` is an array, unless it was created by |vim.empty_dict()| or returned as
+--- a dict-like |API| or Vimscript result, for example from |rpcrequest()| or |vim.fn|.
+---
+---@see https://github.com/openresty/luajit2#tableisarray
 ---
 ---@param t table
 ---@return boolean `true` if array-like table, else `false`.
@@ -597,11 +599,13 @@ function vim.tbl_isarray(t)
   end
 end
 
---- Tests if a Lua table can be treated as a list (a table indexed by consecutive integers starting from 1).
+--- Tests if `t` is a "list": a table indexed _only_ by contiguous integers starting from 1 (what
+--- |lua-length| calls a "regular array").
+---
+--- Empty table `{}` is a list, unless it was created by |vim.empty_dict()| or returned as
+--- a dict-like |API| or Vimscript result, for example from |rpcrequest()| or |vim.fn|.
 ---
---- Empty table `{}` is assumed to be an list, unless it was created by
---- |vim.empty_dict()| or returned as a dict-like |API| or Vimscript result,
---- for example from |rpcrequest()| or |vim.fn|.
+---@see |vim.tbl_isarray()|
 ---
 ---@param t table
 ---@return boolean `true` if list-like table, else `false`.
@@ -705,61 +709,6 @@ function vim.endswith(s, suffix)
   return #suffix == 0 or s:sub(-#suffix) == suffix
 end
 
---- Validates a parameter specification (types and values).
----
---- Usage example:
----
---- ```lua
---- function user.new(name, age, hobbies)
----   vim.validate{
----     name={name, 'string'},
----     age={age, 'number'},
----     hobbies={hobbies, 'table'},
----   }
----   ...
---- end
---- ```
----
---- Examples with explicit argument values (can be run directly):
----
---- ```lua
---- vim.validate{arg1={{'foo'}, 'table'}, arg2={'foo', 'string'}}
----    --> NOP (success)
----
---- vim.validate{arg1={1, 'table'}}
----    --> error('arg1: expected table, got number')
----
---- vim.validate{arg1={3, function(a) return (a % 2) == 0 end, 'even number'}}
----    --> error('arg1: expected even number, got 3')
---- ```
----
---- If multiple types are valid they can be given as a list.
----
---- ```lua
---- vim.validate{arg1={{'foo'}, {'table', 'string'}}, arg2={'foo', {'table', 'string'}}}
---- -- NOP (success)
----
---- vim.validate{arg1={1, {'string', 'table'}}}
---- -- error('arg1: expected string|table, got number')
----
---- ```
----
----@param opt table Names of parameters to validate. Each key is a parameter
----          name; each value is a tuple in one of these forms:
----          1. (arg_value, type_name, optional)
----             - arg_value: argument value
----             - type_name: string|table type name, one of: ("table", "t", "string",
----               "s", "number", "n", "boolean", "b", "function", "f", "nil",
----               "thread", "userdata") or list of them.
----             - optional: (optional) boolean, if true, `nil` is valid
----          2. (arg_value, fn, msg)
----             - arg_value: argument value
----             - fn: any function accepting one argument, returns true if and
----               only if the argument is valid. Can optionally return an additional
----               informative error message as the second returned value.
----             - msg: (optional) error string if validation fails
-function vim.validate(opt) end -- luacheck: no unused
-
 do
   local type_names = {
     ['table'] = 'table',
@@ -844,6 +793,59 @@ do
     return true, nil
   end
 
+  --- Validates a parameter specification (types and values).
+  ---
+  --- Usage example:
+  ---
+  --- ```lua
+  ---  function user.new(name, age, hobbies)
+  ---    vim.validate{
+  ---      name={name, 'string'},
+  ---      age={age, 'number'},
+  ---      hobbies={hobbies, 'table'},
+  ---    }
+  ---    ...
+  ---  end
+  --- ```
+  ---
+  --- Examples with explicit argument values (can be run directly):
+  ---
+  --- ```lua
+  ---  vim.validate{arg1={{'foo'}, 'table'}, arg2={'foo', 'string'}}
+  ---     --> NOP (success)
+  ---
+  ---  vim.validate{arg1={1, 'table'}}
+  ---     --> error('arg1: expected table, got number')
+  ---
+  ---  vim.validate{arg1={3, function(a) return (a % 2) == 0 end, 'even number'}}
+  ---     --> error('arg1: expected even number, got 3')
+  --- ```
+  ---
+  --- If multiple types are valid they can be given as a list.
+  ---
+  --- ```lua
+  ---  vim.validate{arg1={{'foo'}, {'table', 'string'}}, arg2={'foo', {'table', 'string'}}}
+  ---  -- NOP (success)
+  ---
+  ---  vim.validate{arg1={1, {'string', 'table'}}}
+  ---  -- error('arg1: expected string|table, got number')
+  ---
+  --- ```
+  ---
+  ---@param opt table Names of parameters to validate. Each key is a parameter
+  ---          name; each value is a tuple in one of these forms:
+  ---          1. (arg_value, type_name, optional)
+  ---             - arg_value: argument value
+  ---             - type_name: string|table type name, one of: ("table", "t", "string",
+  ---               "s", "number", "n", "boolean", "b", "function", "f", "nil",
+  ---               "thread", "userdata") or list of them.
+  ---             - optional: (optional) boolean, if true, `nil` is valid
+  ---          2. (arg_value, fn, msg)
+  ---             - arg_value: argument value
+  ---             - fn: any function accepting one argument, returns true if and
+  ---               only if the argument is valid. Can optionally return an additional
+  ---               informative error message as the second returned value.
+  ---             - msg: (optional) error string if validation fails
   function vim.validate(opt)
     local ok, err_msg = is_valid(opt)
     if not ok then
@@ -866,28 +868,25 @@ function vim.is_callable(f)
   return type(m.__call) == 'function'
 end
 
---- Creates a table whose members are automatically created when accessed, if they don't already
---- exist.
----
---- They mimic defaultdict in python.
+--- Creates a table whose missing keys are provided by {createfn} (like Python's "defaultdict").
 ---
---- If {create} is `nil`, this will create a defaulttable whose constructor function is
---- this function, effectively allowing to create nested tables on the fly:
+--- If {createfn} is `nil` it defaults to defaulttable() itself, so accessing nested keys creates
+--- nested tables:
 ---
 --- ```lua
 --- local a = vim.defaulttable()
 --- a.b.c = 1
 --- ```
 ---
----@param create function?(key:any):any The function called to create a missing value.
----@return table Empty table with metamethod
-function vim.defaulttable(create)
-  create = create or function(_)
+---@param createfn function?(key:any):any Provides the value for a missing `key`.
+---@return table # Empty table with `__index` metamethod.
+function vim.defaulttable(createfn)
+  createfn = createfn or function(_)
     return vim.defaulttable()
   end
   return setmetatable({}, {
     __index = function(tbl, key)
-      rawset(tbl, key, create(key))
+      rawset(tbl, key, createfn(key))
       return rawget(tbl, key)
     end,
   })
diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index 7f24ba8590..61d84017d4 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -597,8 +597,9 @@ function M.edit_query(lang)
   })
 
   api.nvim_buf_set_lines(query_buf, 0, -1, false, {
-    ';; Write your query here. Use @captures to highlight matches in the source buffer.',
-    ';; Completion for grammar nodes is available (see :h compl-omni)',
+    ';; Write queries here (see $VIMRUNTIME/queries/ for examples).',
+    ';; Move cursor to a capture ("@foo") to highlight matches in the source buffer.',
+    ';; Completion for grammar nodes is available (:help compl-omni)',
     '',
     '',
   })
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 44ed37d64e..313d837d5c 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -843,11 +843,13 @@ function M.omnifunc(findstart, base)
   return require('vim.treesitter._query_linter').omnifunc(findstart, base)
 end
 
---- Open a window for live editing of a treesitter query.
+--- Opens a live editor to query the buffer you started from.
 ---
---- Can also be shown with `:EditQuery`. *:EditQuery*
+--- Can also be shown with *:EditQuery*.
 ---
---- Note that the editor opens a scratch buffer, and so queries aren't persisted on disk.
+--- If you move the cursor to a capture name ("@foo"), text matching the capture is highlighted in
+--- the source buffer. The query editor is a scratch buffer, use `:write` to save it. You can find
+--- example queries at `$VIMRUNTIME/queries/`.
 ---
 --- @param lang? string language to open the query editor for. If omitted, inferred from the current buffer's filetype.
 function M.edit(lang)
-- 
cgit 


From 877d04d0fb83b5fc602dbab22b58f26a793ec236 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Sat, 16 Sep 2023 23:10:30 +0100
Subject: feat(lua): add vim.func._memoize

Memoizes a function, using a custom function to hash the arguments.

Private for now until:

- There are other places in the codebase that could benefit from this
  (e.g. LSP), but might require other changes to accommodate.
- Invalidation of the cache needs to be controllable. Using weak tables
  is an acceptable invalidation policy, but it shouldn't be the only
  one.
- I don't think the story around `hash_fn` is completely thought out. We
  may be able to have a good default hash_fn by hashing each argument,
  so basically a better 'concat'.
---
 runtime/lua/vim/_editor.lua                  |  1 +
 runtime/lua/vim/_meta.lua                    |  1 +
 runtime/lua/vim/func.lua                     | 41 +++++++++++++++++++
 runtime/lua/vim/func/_memoize.lua            | 59 ++++++++++++++++++++++++++++
 runtime/lua/vim/treesitter/_query_linter.lua | 54 ++++++++-----------------
 runtime/lua/vim/treesitter/languagetree.lua  | 10 +++--
 runtime/lua/vim/treesitter/query.lua         | 34 ++--------------
 7 files changed, 129 insertions(+), 71 deletions(-)
 create mode 100644 runtime/lua/vim/func.lua
 create mode 100644 runtime/lua/vim/func/_memoize.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 0215cae0cb..8322777633 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -29,6 +29,7 @@ for k, v in pairs({
   treesitter = true,
   filetype = true,
   loader = true,
+  func = true,
   F = true,
   lsp = true,
   highlight = true,
diff --git a/runtime/lua/vim/_meta.lua b/runtime/lua/vim/_meta.lua
index 5e4f390ca3..ddd0a0eb49 100644
--- a/runtime/lua/vim/_meta.lua
+++ b/runtime/lua/vim/_meta.lua
@@ -10,6 +10,7 @@ vim._watch = require('vim._watch')
 vim.diagnostic = require('vim.diagnostic')
 vim.filetype = require('vim.filetype')
 vim.fs = require('vim.fs')
+vim.func = require('vim.func')
 vim.health = require('vim.health')
 vim.highlight = require('vim.highlight')
 vim.iter = require('vim.iter')
diff --git a/runtime/lua/vim/func.lua b/runtime/lua/vim/func.lua
new file mode 100644
index 0000000000..206d1bae95
--- /dev/null
+++ b/runtime/lua/vim/func.lua
@@ -0,0 +1,41 @@
+local M = {}
+
+-- TODO(lewis6991): Private for now until:
+-- - There are other places in the codebase that could benefit from this
+--   (e.g. LSP), but might require other changes to accommodate.
+-- - Invalidation of the cache needs to be controllable. Using weak tables
+--   is an acceptable invalidation policy, but it shouldn't be the only
+--   one.
+-- - I don't think the story around `hash` is completely thought out. We
+--   may be able to have a good default hash by hashing each argument,
+--   so basically a better 'concat'.
+-- - Need to support multi level caches. Can be done by allow `hash` to
+--   return multiple values.
+--
+--- Memoizes a function {fn} using {hash} to hash the arguments.
+---
+--- Internally uses a |lua-weaktable| to cache the results of {fn} meaning the
+--- cache will be invalidated whenever Lua does garbage collection.
+---
+--- The memoized function returns shared references so be wary about
+--- mutating return values.
+---
+--- @generic F: function
+--- @param hash integer|string|function Hash function to create a hash to use as a key to
+---     store results. Possible values:
+---     - When integer, refers to the index of an argument of {fn} to hash.
+---     This argument can have any type.
+---     - When function, is evaluated using the same arguments passed to {fn}.
+---     - When `concat`, the hash is determined by string concatenating all the
+---     arguments passed to {fn}.
+---     - When `concat-n`, the hash is determined by string concatenating the
+---     first n arguments passed to {fn}.
+---
+--- @param fn F Function to memoize.
+--- @return F # Memoized version of {fn}
+--- @nodoc
+function M._memoize(hash, fn)
+  return require('vim.func._memoize')(hash, fn)
+end
+
+return M
diff --git a/runtime/lua/vim/func/_memoize.lua b/runtime/lua/vim/func/_memoize.lua
new file mode 100644
index 0000000000..835bf64c93
--- /dev/null
+++ b/runtime/lua/vim/func/_memoize.lua
@@ -0,0 +1,59 @@
+--- Module for private utility functions
+
+--- @param argc integer?
+--- @return fun(...): any
+local function concat_hash(argc)
+  return function(...)
+    return table.concat({ ... }, '%%', 1, argc)
+  end
+end
+
+--- @param idx integer
+--- @return fun(...): any
+local function idx_hash(idx)
+  return function(...)
+    return select(idx, ...)
+  end
+end
+
+--- @param hash integer|string|fun(...): any
+--- @return fun(...): any
+local function resolve_hash(hash)
+  if type(hash) == 'number' then
+    hash = idx_hash(hash)
+  elseif type(hash) == 'string' then
+    local c = hash == 'concat' or hash:match('^concat%-(%d+)')
+    if c then
+      hash = concat_hash(tonumber(c))
+    else
+      error('invalid value for hash: ' .. hash)
+    end
+  end
+  --- @cast hash -integer
+  return hash
+end
+
+--- @generic F: function
+--- @param hash integer|string|fun(...): any
+--- @param fn F
+--- @return F
+return function(hash, fn)
+  vim.validate({
+    hash = { hash, { 'number', 'string', 'function' } },
+    fn = { fn, 'function' },
+  })
+
+  ---@type table<any,table<any,any>>
+  local cache = setmetatable({}, { __mode = 'kv' })
+
+  hash = resolve_hash(hash)
+
+  return function(...)
+    local key = hash(...)
+    if cache[key] == nil then
+      cache[key] = vim.F.pack_len(fn(...))
+    end
+
+    return vim.F.unpack_len(cache[key])
+  end
+end
diff --git a/runtime/lua/vim/treesitter/_query_linter.lua b/runtime/lua/vim/treesitter/_query_linter.lua
index abf0bf345d..87d74789a3 100644
--- a/runtime/lua/vim/treesitter/_query_linter.lua
+++ b/runtime/lua/vim/treesitter/_query_linter.lua
@@ -10,20 +10,12 @@ local M = {}
 
 --- @alias vim.treesitter.ParseError {msg: string, range: Range4}
 
---- @private
---- Caches parse results for queries for each language.
---- Entries of parse_cache[lang][query_text] will either be true for successful parse or contain the
---- message and range of the parse error.
---- @type table<string,table<string,vim.treesitter.ParseError|true>>
-local parse_cache = {}
-
 --- Contains language dependent context for the query linter
 --- @class QueryLinterLanguageContext
 --- @field lang string? Current `lang` of the targeted parser
 --- @field parser_info table? Parser info returned by vim.treesitter.language.inspect
 --- @field is_first_lang boolean Whether this is the first language of a linter run checking queries for multiple `langs`
 
---- @private
 --- Adds a diagnostic for node in the query buffer
 --- @param diagnostics Diagnostic[]
 --- @param range Range4
@@ -42,7 +34,6 @@ local function add_lint_for_node(diagnostics, range, lint, lang)
   }
 end
 
---- @private
 --- Determines the target language of a query file by its path: <lang>/<query_type>.scm
 --- @param buf integer
 --- @return string?
@@ -53,7 +44,6 @@ local function guess_query_lang(buf)
   end
 end
 
---- @private
 --- @param buf integer
 --- @param opts QueryLinterOpts|QueryLinterNormalizedOpts|nil
 --- @return QueryLinterNormalizedOpts
@@ -87,7 +77,6 @@ local lint_query = [[;; query
   (ERROR) @error
 ]]
 
---- @private
 --- @param err string
 --- @param node TSNode
 --- @return vim.treesitter.ParseError
@@ -112,38 +101,26 @@ local function get_error_entry(err, node)
   }
 end
 
---- @private
 --- @param node TSNode
 --- @param buf integer
 --- @param lang string
---- @param diagnostics Diagnostic[]
-local function check_toplevel(node, buf, lang, diagnostics)
-  local query_text = vim.treesitter.get_node_text(node, buf)
-
-  if not parse_cache[lang] then
-    parse_cache[lang] = {}
-  end
-
-  local lang_cache = parse_cache[lang]
-
-  if lang_cache[query_text] == nil then
-    local cache_val, err = pcall(vim.treesitter.query.parse, lang, query_text) ---@type boolean|vim.treesitter.ParseError, string|Query
-
-    if not cache_val and type(err) == 'string' then
-      cache_val = get_error_entry(err, node)
-    end
-
-    lang_cache[query_text] = cache_val
-  end
+local function hash_parse(node, buf, lang)
+  return tostring(node:id()) .. tostring(buf) .. tostring(vim.b[buf].changedtick) .. lang
+end
 
-  local cache_entry = lang_cache[query_text]
+--- @param node TSNode
+--- @param buf integer
+--- @param lang string
+--- @return vim.treesitter.ParseError?
+local parse = vim.func._memoize(hash_parse, function(node, buf, lang)
+  local query_text = vim.treesitter.get_node_text(node, buf)
+  local ok, err = pcall(vim.treesitter.query.parse, lang, query_text) ---@type boolean|vim.treesitter.ParseError, string|Query
 
-  if type(cache_entry) ~= 'boolean' then
-    add_lint_for_node(diagnostics, cache_entry.range, cache_entry.msg, lang)
+  if not ok and type(err) == 'string' then
+    return get_error_entry(err, node)
   end
-end
+end)
 
---- @private
 --- @param buf integer
 --- @param match table<integer,TSNode>
 --- @param query Query
@@ -164,7 +141,10 @@ local function lint_match(buf, match, query, lang_context, diagnostics)
 
     -- other checks rely on Neovim parser introspection
     if lang and parser_info and cap_id == 'toplevel' then
-      check_toplevel(node, buf, lang, diagnostics)
+      local err = parse(node, buf, lang)
+      if err then
+        add_lint_for_node(diagnostics, err.range, err.msg, lang)
+      end
     end
   end
 end
diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index f931291ed7..b2c4e9167d 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -738,12 +738,14 @@ local function add_injection(t, tree_index, pattern, lang, combined, ranges)
 end
 
 -- TODO(clason): replace by refactored `ts.has_parser` API (without registering)
----@param lang string parser name
----@return boolean # true if parser for {lang} exists on rtp
-local has_parser = function(lang)
+--- The result of this function is cached to prevent nvim_get_runtime_file from being
+--- called too often
+--- @param lang string parser name
+--- @return boolean # true if parser for {lang} exists on rtp
+local has_parser = vim.func._memoize(1, function(lang)
   return vim._ts_has_language(lang)
     or #vim.api.nvim_get_runtime_file('parser/' .. lang .. '.*', false) > 0
-end
+end)
 
 --- Return parser name for language (if exists) or filetype (if registered and exists).
 --- Also attempts with the input lower-cased.
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index 313d837d5c..8cbbffcd60 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -191,12 +191,6 @@ function M.set(lang, query_name, text)
   explicit_queries[lang][query_name] = M.parse(lang, text)
 end
 
---- `false` if query files didn't exist or were empty
----@type table<string, table<string, Query|false>>
-local query_get_cache = vim.defaulttable(function()
-  return setmetatable({}, { __mode = 'v' })
-end)
-
 ---@deprecated
 function M.get_query(...)
   vim.deprecate('vim.treesitter.query.get_query()', 'vim.treesitter.query.get()', '0.10')
@@ -209,34 +203,19 @@ end
 ---@param query_name string Name of the query (e.g. "highlights")
 ---
 ---@return Query|nil Parsed query
-function M.get(lang, query_name)
+M.get = vim.func._memoize('concat-2', function(lang, query_name)
   if explicit_queries[lang][query_name] then
     return explicit_queries[lang][query_name]
   end
 
-  local cached = query_get_cache[lang][query_name]
-  if cached then
-    return cached
-  elseif cached == false then
-    return nil
-  end
-
   local query_files = M.get_files(lang, query_name)
   local query_string = read_query_files(query_files)
 
   if #query_string == 0 then
-    query_get_cache[lang][query_name] = false
     return nil
   end
 
-  local query = M.parse(lang, query_string)
-  query_get_cache[lang][query_name] = query
-  return query
-end
-
----@type table<string, table<string, Query>>
-local query_parse_cache = vim.defaulttable(function()
-  return setmetatable({}, { __mode = 'v' })
+  return M.parse(lang, query_string)
 end)
 
 ---@deprecated
@@ -262,20 +241,15 @@ end
 ---@param query string Query in s-expr syntax
 ---
 ---@return Query Parsed query
-function M.parse(lang, query)
+M.parse = vim.func._memoize('concat-2', function(lang, query)
   language.add(lang)
-  local cached = query_parse_cache[lang][query]
-  if cached then
-    return cached
-  end
 
   local self = setmetatable({}, Query)
   self.query = vim._ts_parse_query(lang, query)
   self.info = self.query:inspect()
   self.captures = self.info.captures
-  query_parse_cache[lang][query] = self
   return self
-end
+end)
 
 ---@deprecated
 function M.get_range(...)
-- 
cgit 


From 473d0aa3e6ab22eb8e10c88c3971764f1b069825 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 20 Sep 2023 23:42:25 +0200
Subject: vim-patch:9.0.1918

patch 9.0.1918: No filetype detection for Authzed filetypes

Problem:  No filetype detection for Authzed filetypes
Solution: Detect the *.zed file extension as authzed filetype

closes: vim/vim#13129

https://github.com/vim/vim/commit/5790a54166793554d16f6a85d8824632860b8b37

Co-authored-by: Matt Polzin <mpolzin@workwithopal.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index c7f025f9e7..5ae4e508ef 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -210,6 +210,7 @@ local extension = {
   astro = 'astro',
   atl = 'atlas',
   as = 'atlas',
+  zed = 'authzed',
   ahk = 'autohotkey',
   au3 = 'autoit',
   ave = 'ave',
-- 
cgit 


From f094db0e5ccaddca2b5db05bf9545d55f3eededf Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 21 Sep 2023 07:37:03 +0800
Subject: vim-patch:9.0.1921: not possible to use the jumplist like a stack
 (#25278)

Problem:  not possible to use the jumplist like a stack
Solution: Add the 'jumpoptions' setting to make the jumplist
          a stack.

Add an option for using jumplist like tag stack

related: vim/vim#7738
closes: vim/vim#13134

ported from NeoVim:

- https://neovim.io/doc/user/motion.html#jumplist-stack
- neovim/neovim@39094b3
- https://vi.stackexchange.com/questions/18344/how-to-change-jumplist-behavior

Based on the feedback in the previous PR, it looks like many people like
this option.

https://github.com/vim/vim/commit/87018255e3ad0f4dfa03e20318836d24af721caf

Co-authored-by: Yegappan Lakshmanan <yegappan@yahoo.com>
Co-authored-by: butwerenotthereyet <58348703+butwerenotthereyet@users.noreply.github.com>
---
 runtime/lua/vim/_meta/options.lua | 11 +++++------
 1 file changed, 5 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 734096a755..b8bdfbc3f7 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -3485,12 +3485,11 @@ vim.go.joinspaces = vim.o.joinspaces
 vim.go.js = vim.go.joinspaces
 
 --- List of words that change the behavior of the `jumplist`.
----   stack         Make the jumplist behave like the tagstack or like a
----                 web browser.  Relative location of entries in the
---- 		jumplist is preserved at the cost of discarding
---- 		subsequent entries when navigating backwards in the
---- 		jumplist and then jumping to a location.
---- 		`jumplist-stack`
+---   stack         Make the jumplist behave like the tagstack.
+--- 		Relative location of entries in the jumplist is
+--- 		preserved at the cost of discarding subsequent entries
+--- 		when navigating backwards in the jumplist and then
+--- 		jumping to a location.  `jumplist-stack`
 ---
 ---   view          When moving through the jumplist, `changelist|,
 --- 		|alternate-file` or using `mark-motions` try to
-- 
cgit 


From 8bd6f7c20b403e8031a94f3a158a10c90b5c3efd Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Thu, 21 Sep 2023 16:56:15 +0900
Subject: fix(lsp): clear codelens on LspDetach (#24903)

Also fix incorrect parameters in on_detach callback.
---
 runtime/lua/vim/lsp/codelens.lua | 39 ++++++++++++++++++++++++++++++++-------
 1 file changed, 32 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/codelens.lua b/runtime/lua/vim/lsp/codelens.lua
index 384d09ee48..9cccaa1d66 100644
--- a/runtime/lua/vim/lsp/codelens.lua
+++ b/runtime/lua/vim/lsp/codelens.lua
@@ -8,6 +8,7 @@ local M = {}
 --- to throttle refreshes to at most one at a time
 local active_refreshes = {}
 
+---@type table<integer, table<integer, lsp.CodeLens[]>>
 --- bufnr -> client_id -> lenses
 local lens_cache_by_buf = setmetatable({}, {
   __index = function(t, b)
@@ -16,6 +17,8 @@ local lens_cache_by_buf = setmetatable({}, {
   end,
 })
 
+---@type table<integer, integer>
+---client_id -> namespace
 local namespaces = setmetatable({}, {
   __index = function(t, key)
     local value = api.nvim_create_namespace('vim_lsp_codelens:' .. key)
@@ -27,6 +30,18 @@ local namespaces = setmetatable({}, {
 ---@private
 M.__namespaces = namespaces
 
+local augroup = api.nvim_create_augroup('vim_lsp_codelens', {})
+
+api.nvim_create_autocmd('LspDetach', {
+  group = augroup,
+  callback = function(ev)
+    M.clear(ev.data.client_id, ev.buf)
+  end,
+})
+
+---@param lens lsp.CodeLens
+---@param bufnr integer
+---@param client_id integer
 local function execute_lens(lens, bufnr, client_id)
   local line = lens.range.start.line
   api.nvim_buf_clear_namespace(bufnr, namespaces[client_id], line, line + 1)
@@ -42,7 +57,7 @@ end
 --- Return all lenses for the given buffer
 ---
 ---@param bufnr integer  Buffer number. 0 can be used for the current buffer.
----@return table (`CodeLens[]`)
+---@return lsp.CodeLens[]
 function M.get(bufnr)
   local lenses_by_client = lens_cache_by_buf[bufnr or 0]
   if not lenses_by_client then
@@ -98,12 +113,17 @@ end
 ---@param client_id integer|nil filter by client_id. All clients if nil
 ---@param bufnr integer|nil filter by buffer. All buffers if nil
 function M.clear(client_id, bufnr)
-  local buffers = bufnr and { resolve_bufnr(bufnr) } or vim.tbl_keys(lens_cache_by_buf)
+  bufnr = bufnr and resolve_bufnr(bufnr)
+  local buffers = bufnr and { bufnr }
+    or vim.tbl_filter(api.nvim_buf_is_loaded, api.nvim_list_bufs())
   for _, iter_bufnr in pairs(buffers) do
     local client_ids = client_id and { client_id } or vim.tbl_keys(namespaces)
     for _, iter_client_id in pairs(client_ids) do
       local ns = namespaces[iter_client_id]
-      lens_cache_by_buf[iter_bufnr][iter_client_id] = {}
+      -- there can be display()ed lenses, which are not stored in cache
+      if lens_cache_by_buf[iter_bufnr] then
+        lens_cache_by_buf[iter_bufnr][iter_client_id] = {}
+      end
       api.nvim_buf_clear_namespace(iter_bufnr, ns, 0, -1)
     end
   end
@@ -111,7 +131,7 @@ end
 
 --- Display the lenses using virtual text
 ---
----@param lenses table of lenses to display (`CodeLens[] | null`)
+---@param lenses? lsp.CodeLens[] lenses to display
 ---@param bufnr integer
 ---@param client_id integer
 function M.display(lenses, bufnr, client_id)
@@ -124,7 +144,8 @@ function M.display(lenses, bufnr, client_id)
     api.nvim_buf_clear_namespace(bufnr, ns, 0, -1)
     return
   end
-  local lenses_by_lnum = {}
+
+  local lenses_by_lnum = {} ---@type table<integer, lsp.CodeLens[]>
   for _, lens in pairs(lenses) do
     local line_lenses = lenses_by_lnum[lens.range.start.line]
     if not line_lenses then
@@ -160,7 +181,7 @@ end
 
 --- Store lenses for a specific buffer and client
 ---
----@param lenses table of lenses to store (`CodeLens[] | null`)
+---@param lenses? lsp.CodeLens[] lenses to store
 ---@param bufnr integer
 ---@param client_id integer
 function M.save(lenses, bufnr, client_id)
@@ -174,7 +195,7 @@ function M.save(lenses, bufnr, client_id)
     lens_cache_by_buf[bufnr] = lenses_by_client
     local ns = namespaces[client_id]
     api.nvim_buf_attach(bufnr, false, {
-      on_detach = function(b)
+      on_detach = function(_, b)
         lens_cache_by_buf[b] = nil
       end,
       on_lines = function(_, b, _, first_lnum, last_lnum)
@@ -185,6 +206,10 @@ function M.save(lenses, bufnr, client_id)
   lenses_by_client[client_id] = lenses
 end
 
+---@param lenses? lsp.CodeLens[]
+---@param bufnr integer
+---@param client_id integer
+---@param callback fun()
 local function resolve_lenses(lenses, bufnr, client_id, callback)
   lenses = lenses or {}
   local num_lens = vim.tbl_count(lenses)
-- 
cgit 


From 345bd91db28ecfc4deb308f4971253b534f82d49 Mon Sep 17 00:00:00 2001
From: Sergey Slipchenko <faergeek@gmail.com>
Date: Thu, 21 Sep 2023 14:06:40 +0400
Subject: fix(lsp): handle absence of a trailing newline #25194

Fixes #24339

rust-analyzer sends "Invalid offset" error in such cases. Some other
servers handle it specially.

LSP spec mentions that "A range is comparable to a selection in an
editor". Most editors don't handle trailing newlines the same way
Neovim/Vim does, it's clearly visible if it's present or not. With that
in mind it's understandable why sending end position as simply the start
of the line after the last one is considered invalid in such cases.
---
 runtime/lua/vim/lsp/util.lua | 60 ++++++++++++++++++++++++++++++++------------
 1 file changed, 44 insertions(+), 16 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 988057f5f9..0d1e3cc0d1 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -2230,6 +2230,35 @@ function M.lookup_section(settings, section)
   return settings
 end
 
+--- Converts line range (0-based, end-inclusive) to lsp range,
+--- handles absence of a trailing newline
+---
+---@param bufnr integer
+---@param start_line integer
+---@param end_line integer
+---@param offset_encoding lsp.PositionEncodingKind
+---@return lsp.Range
+local function make_line_range_params(bufnr, start_line, end_line, offset_encoding)
+  local last_line = api.nvim_buf_line_count(bufnr) - 1
+
+  ---@type lsp.Position
+  local end_pos
+
+  if end_line == last_line and not vim.api.nvim_get_option_value('endofline', { buf = bufnr }) then
+    end_pos = {
+      line = end_line,
+      character = M.character_offset(bufnr, end_line, #get_line(bufnr, end_line), offset_encoding),
+    }
+  else
+    end_pos = { line = end_line + 1, character = 0 }
+  end
+
+  return {
+    start = { line = start_line, character = 0 },
+    ['end'] = end_pos,
+  }
+end
+
 ---@private
 --- Request updated LSP information for a buffer.
 ---
@@ -2253,6 +2282,8 @@ function M._refresh(method, opts)
     return
   end
 
+  local textDocument = M.make_text_document_params(bufnr)
+
   local only_visible = opts.only_visible or false
 
   if only_visible then
@@ -2260,28 +2291,25 @@ function M._refresh(method, opts)
       if api.nvim_win_get_buf(window) == bufnr then
         local first = vim.fn.line('w0', window)
         local last = vim.fn.line('w$', window)
-        local params = {
-          textDocument = M.make_text_document_params(bufnr),
-          range = {
-            start = { line = first - 1, character = 0 },
-            ['end'] = { line = last, character = 0 },
-          },
-        }
         for _, client in ipairs(clients) do
-          client.request(method, params, nil, bufnr)
+          client.request(method, {
+            textDocument = textDocument,
+            range = make_line_range_params(bufnr, first - 1, last - 1, client.offset_encoding),
+          }, nil, bufnr)
         end
       end
     end
   else
-    local params = {
-      textDocument = M.make_text_document_params(bufnr),
-      range = {
-        start = { line = 0, character = 0 },
-        ['end'] = { line = api.nvim_buf_line_count(bufnr), character = 0 },
-      },
-    }
     for _, client in ipairs(clients) do
-      client.request(method, params, nil, bufnr)
+      client.request(method, {
+        textDocument = textDocument,
+        range = make_line_range_params(
+          bufnr,
+          0,
+          api.nvim_buf_line_count(bufnr) - 1,
+          client.offset_encoding
+        ),
+      }, nil, bufnr)
     end
   end
 end
-- 
cgit 


From f413597f44f62a62675a3a7149e34a63f16e4821 Mon Sep 17 00:00:00 2001
From: Oliver Marriott <hello@omarriott.com>
Date: Thu, 21 Sep 2023 15:53:05 +1000
Subject: docs: clarify vim.schedule_wrap behaviour

- Remove the usage of the term "defer" to avoid confusion with
  `vim.defer_fn`, which also calls `vim.schedule_wrap` internally.
- Explicitly state that `vim.schedule_wrap` returns a function in the
  text.
- Mention that arguments are passed along.
- Include a usage example.
- Rename param to `fn`.
---
 runtime/lua/vim/_editor.lua | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 8322777633..e4a2dadb09 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -316,18 +316,29 @@ do
   end
 end
 
---- Defers callback `cb` until the Nvim API is safe to call.
+--- Returns a function which calls {fn} via |vim.schedule()|.
+---
+--- The returned function passes all arguments to {fn}.
+---
+--- Example:
+---
+--- ```lua
+--- function notify_readable(_err, readable)
+---   vim.notify("readable? " .. tostring(readable))
+--- end
+--- vim.uv.fs_access(vim.fn.stdpath("config"), "R", vim.schedule_wrap(notify_readable))
+--- ```
 ---
 ---@see |lua-loop-callbacks|
 ---@see |vim.schedule()|
 ---@see |vim.in_fast_event()|
----@param cb function
+---@param fn function
 ---@return function
-function vim.schedule_wrap(cb)
+function vim.schedule_wrap(fn)
   return function(...)
     local args = vim.F.pack_len(...)
     vim.schedule(function()
-      cb(vim.F.unpack_len(args))
+      fn(vim.F.unpack_len(args))
     end)
   end
 end
-- 
cgit 


From e353c869cea4541d00d627ec82724d3f247225a3 Mon Sep 17 00:00:00 2001
From: L Lllvvuu <git@llllvvuu.dev>
Date: Tue, 19 Sep 2023 21:41:07 -0700
Subject: fix(languagetree): don't treat unparsed nodes as occupying full range

This is incorrect in the following scenario:
1. The language tree is Lua > Vim > Lua.
2. An edit simultaneously wipes out the `_regions` of all nodes, while
   taking the Vim injection off-screen.
3. The Vim injection is not re-parsed, so the child Lua `_regions` is
   still `nil`.
4. The child Lua is assumed, incorrectly, to occupy the whole document.
5. This causes the injections to be parsed again, resulting in Lua > Vim
   > Lua > Vim.
6. Now, by the same process, Vim ends up with its range assumed over the
   whole document. Now the parse is broken and results in broken
   highlighting and poor performance.

It should be fine to instead treat an unparsed node as occupying
nothing (i.e. effectively non-existent). Since, either:
- The parent was just parsed, hence defining `_regions`
- The parent was not just parsed, in which case this node doesn't need
  to be parsed either.

Also, the name `has_regions` is confusing; it seems to simply
mean the opposite of "root" or "full_document". However, this PR does
not touch it.
---
 runtime/lua/vim/treesitter/languagetree.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index b2c4e9167d..670f2797b7 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -650,8 +650,8 @@ function LanguageTree:included_regions()
     return self._regions
   end
 
-  if not self._has_regions or next(self._trees) == nil then
-    -- treesitter.c will default empty ranges to { -1, -1, -1, -1, -1, -1}
+  if not self._has_regions then
+    -- treesitter.c will default empty ranges to { -1, -1, -1, -1, -1, -1} (the full range)
     return { {} }
   end
 
-- 
cgit 


From 44f698bb1afccb90fd8835fa7e35bfcebbd6d828 Mon Sep 17 00:00:00 2001
From: Oliver Marriott <hello@omarriott.com>
Date: Thu, 21 Sep 2023 22:34:56 +1000
Subject: docs: update vim.schedule param name and type

Per https://github.com/neovim/neovim/pull/25286#discussion_r1332861721
and https://github.com/neovim/neovim/pull/25286#discussion_r1334318352
---
 runtime/lua/vim/_meta/builtin.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/builtin.lua b/runtime/lua/vim/_meta/builtin.lua
index 0a6dd3e151..92c23f7764 100644
--- a/runtime/lua/vim/_meta/builtin.lua
+++ b/runtime/lua/vim/_meta/builtin.lua
@@ -194,10 +194,10 @@ function vim.str_utfindex(str, index) end
 --- @return string|nil Converted string if conversion succeeds, `nil` otherwise.
 function vim.iconv(str, from, to, opts) end
 
---- Schedules {callback} to be invoked soon by the main event-loop. Useful
+--- Schedules {fn} to be invoked soon by the main event-loop. Useful
 --- to avoid |textlock| or other temporary restrictions.
---- @param callback fun()
-function vim.schedule(callback) end
+--- @param fn function
+function vim.schedule(fn) end
 
 --- Wait for {time} in milliseconds until {callback} returns `true`.
 ---
-- 
cgit 


From dae6770b761a5e760c6c4d7e618bb13afa961376 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Fri, 22 Sep 2023 13:00:31 -0700
Subject: fix(meta): include vim.json

---
 runtime/lua/vim/_meta/json.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/json.lua b/runtime/lua/vim/_meta/json.lua
index edf905c7c6..e010086615 100644
--- a/runtime/lua/vim/_meta/json.lua
+++ b/runtime/lua/vim/_meta/json.lua
@@ -1,5 +1,8 @@
 ---@meta
 
+---@nodoc
+vim.json = {}
+
 -- luacheck: no unused args
 
 ---@defgroup vim.json
-- 
cgit 


From f7da4722570617bd8927e7aa533fa9a608c45bba Mon Sep 17 00:00:00 2001
From: bfredl <bjorn.linse@gmail.com>
Date: Sat, 23 Sep 2023 16:42:47 +0200
Subject: refactor(options)!: graduate shortmess+=f flag

Not everything needs to be crazy overconfigurable.

Also fixes a warning in latest clang which didn't approve of
the funky math switch statement in  append_arg_number
---
 runtime/lua/vim/_meta/options.lua | 1 -
 1 file changed, 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index b8bdfbc3f7..baf53c5ccc 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -5668,7 +5668,6 @@ vim.bo.sw = vim.bo.shiftwidth
 --- messages, for example  with CTRL-G, and to avoid some other messages.
 --- It is a list of flags:
 ---  flag	meaning when present	~
----   f	use "(3 of 5)" instead of "(file 3 of 5)"		*shm-f*
 ---   i	use "[noeol]" instead of "[Incomplete last line]"	*shm-i*
 ---   l	use "999L, 888B" instead of "999 lines, 888 bytes"	*shm-l*
 ---   m	use "[+]" instead of "[Modified]"			*shm-m*
-- 
cgit 


From bc0bf9d030bbcb01db69c44cf88b95ca41dd3065 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Wed, 20 Sep 2023 19:03:40 -0700
Subject: docs: fix type warnings

---
 runtime/lua/vim/keymap.lua         | 18 ++++++++++--------
 runtime/lua/vim/secure.lua         | 21 ++++++++++++++-------
 runtime/lua/vim/treesitter.lua     |  5 +++--
 runtime/lua/vim/treesitter/dev.lua |  2 +-
 runtime/lua/vim/uri.lua            |  9 ++++-----
 5 files changed, 32 insertions(+), 23 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/keymap.lua b/runtime/lua/vim/keymap.lua
index df593be097..bdea95f9ab 100644
--- a/runtime/lua/vim/keymap.lua
+++ b/runtime/lua/vim/keymap.lua
@@ -28,7 +28,7 @@ local keymap = {}
 ---                        - "replace_keycodes" defaults to `true` if "expr" is `true`.
 ---                        - "noremap": inverse of "remap" (see below).
 ---                      - Also accepts:
----                        - "buffer": (number|boolean) Creates buffer-local mapping, `0` or `true`
+---                        - "buffer": (integer|boolean) Creates buffer-local mapping, `0` or `true`
 ---                        for current buffer.
 ---                        - "remap": (boolean) Make the mapping recursive. Inverse of "noremap".
 ---                        Defaults to `false`.
@@ -44,7 +44,9 @@ function keymap.set(mode, lhs, rhs, opts)
     opts = { opts, 't', true },
   })
 
-  opts = vim.deepcopy(opts) or {}
+  opts = vim.deepcopy(opts or {})
+
+  ---@cast mode string[]
   mode = type(mode) == 'string' and { mode } or mode
 
   if opts.expr and opts.replace_keycodes ~= false then
@@ -57,7 +59,7 @@ function keymap.set(mode, lhs, rhs, opts)
   else
     -- remaps behavior is opposite of noremap option.
     opts.noremap = not opts.remap
-    opts.remap = nil
+    opts.remap = nil ---@type boolean?
   end
 
   if type(rhs) == 'function' then
@@ -66,8 +68,8 @@ function keymap.set(mode, lhs, rhs, opts)
   end
 
   if opts.buffer then
-    local bufnr = opts.buffer == true and 0 or opts.buffer
-    opts.buffer = nil
+    local bufnr = opts.buffer == true and 0 or opts.buffer --[[@as integer]]
+    opts.buffer = nil ---@type integer?
     for _, m in ipairs(mode) do
       vim.api.nvim_buf_set_keymap(bufnr, m, lhs, rhs, opts)
     end
@@ -89,7 +91,7 @@ end
 --- ```
 ---
 ---@param opts table|nil A table of optional arguments:
----                      - "buffer": (number|boolean) Remove a mapping from the given buffer.
+---                      - "buffer": (integer|boolean) Remove a mapping from the given buffer.
 ---                        When `0` or `true`, use the current buffer.
 ---@see |vim.keymap.set()|
 ---
@@ -103,9 +105,9 @@ function keymap.del(modes, lhs, opts)
   opts = opts or {}
   modes = type(modes) == 'string' and { modes } or modes
 
-  local buffer = false
+  local buffer = false ---@type false|integer
   if opts.buffer ~= nil then
-    buffer = opts.buffer == true and 0 or opts.buffer
+    buffer = opts.buffer == true and 0 or opts.buffer --[[@as integer]]
   end
 
   if buffer == false then
diff --git a/runtime/lua/vim/secure.lua b/runtime/lua/vim/secure.lua
index 893b3e1877..d29c356af3 100644
--- a/runtime/lua/vim/secure.lua
+++ b/runtime/lua/vim/secure.lua
@@ -2,9 +2,9 @@ local M = {}
 
 --- Reads trust database from $XDG_STATE_HOME/nvim/trust.
 ---
----@return (table) Contents of trust database, if it exists. Empty table otherwise.
+---@return table<string, string> Contents of trust database, if it exists. Empty table otherwise.
 local function read_trust()
-  local trust = {}
+  local trust = {} ---@type table<string, string>
   local f = io.open(vim.fn.stdpath('state') .. '/trust', 'r')
   if f then
     local contents = f:read('*a')
@@ -24,12 +24,12 @@ end
 --- Writes provided {trust} table to trust database at
 --- $XDG_STATE_HOME/nvim/trust.
 ---
----@param trust (table) Trust table to write
+---@param trust table<string, string> Trust table to write
 local function write_trust(trust)
   vim.validate({ trust = { trust, 't' } })
   local f = assert(io.open(vim.fn.stdpath('state') .. '/trust', 'w'))
 
-  local t = {}
+  local t = {} ---@type string[]
   for p, h in pairs(trust) do
     t[#t + 1] = string.format('%s %s\n', h, p)
   end
@@ -61,7 +61,7 @@ function M.read(path)
     return nil
   end
 
-  local contents
+  local contents ---@type string?
   do
     local f = io.open(fullpath, 'r')
     if not f then
@@ -108,6 +108,11 @@ function M.read(path)
   return contents
 end
 
+---@class vim.trust.opts
+---@field action string
+---@field path? string
+---@field bufnr? integer
+
 --- Manage the trust database.
 ---
 --- The trust database is located at |$XDG_STATE_HOME|/nvim/trust.
@@ -134,6 +139,7 @@ function M.trust(opts)
     },
   })
 
+  ---@cast opts vim.trust.opts
   local path = opts.path
   local bufnr = opts.bufnr
   local action = opts.action
@@ -144,7 +150,7 @@ function M.trust(opts)
     assert(not path, '"path" is not valid when action is "allow"')
   end
 
-  local fullpath
+  local fullpath ---@type string?
   if path then
     fullpath = vim.uv.fs_realpath(vim.fs.normalize(path))
   elseif bufnr then
@@ -165,7 +171,8 @@ function M.trust(opts)
 
   if action == 'allow' then
     local newline = vim.bo[bufnr].fileformat == 'unix' and '\n' or '\r\n'
-    local contents = table.concat(vim.api.nvim_buf_get_lines(bufnr, 0, -1, false), newline)
+    local contents =
+      table.concat(vim.api.nvim_buf_get_lines(bufnr --[[@as integer]], 0, -1, false), newline)
     if vim.bo[bufnr].endofline then
       contents = contents .. newline
     end
diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index cc8be72670..0e34cbcbcc 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -127,6 +127,7 @@ function M.get_parser(bufnr, lang, opts)
       )
     end
   elseif parsers[bufnr] == nil or parsers[bufnr]:lang() ~= lang then
+    assert(lang, 'lang should be valid')
     parsers[bufnr] = M._create_parser(bufnr, lang, opts)
   end
 
@@ -162,7 +163,7 @@ function M.is_ancestor(dest, source)
     return false
   end
 
-  local current = source
+  local current = source ---@type TSNode?
   while current ~= nil do
     if current == dest then
       return true
@@ -491,7 +492,7 @@ end
 ---                        function, it accepts the buffer number of the source buffer as its only
 ---                        argument and should return a string.
 function M.inspect_tree(opts)
-  ---@cast opts InspectTreeOpts
+  ---@diagnostic disable-next-line: invisible
   require('vim.treesitter.dev').inspect_tree(opts)
 end
 
diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index 61d84017d4..db30d638af 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -258,7 +258,7 @@ end
 
 --- @private
 ---
---- @param opts InspectTreeOpts
+--- @param opts InspectTreeOpts?
 function M.inspect_tree(opts)
   vim.validate({
     opts = { opts, 't', true },
diff --git a/runtime/lua/vim/uri.lua b/runtime/lua/vim/uri.lua
index 9dce80b77e..2dc817c5c1 100644
--- a/runtime/lua/vim/uri.lua
+++ b/runtime/lua/vim/uri.lua
@@ -60,7 +60,7 @@ end
 ---@param path string Path to file
 ---@return string URI
 function M.uri_from_fname(path)
-  local volume_path, fname = path:match('^([a-zA-Z]:)(.*)')
+  local volume_path, fname = path:match('^([a-zA-Z]:)(.*)') ---@type string?
   local is_windows = volume_path ~= nil
   if is_windows then
     path = volume_path .. M.uri_encode(fname:gsub('\\', '/'))
@@ -82,7 +82,7 @@ function M.uri_from_bufnr(bufnr)
   local fname = vim.api.nvim_buf_get_name(bufnr)
   local volume_path = fname:match('^([a-zA-Z]:).*')
   local is_windows = volume_path ~= nil
-  local scheme
+  local scheme ---@type string?
   if is_windows then
     fname = fname:gsub('\\', '/')
     scheme = fname:match(WINDOWS_URI_SCHEME_PATTERN)
@@ -107,10 +107,9 @@ function M.uri_to_fname(uri)
   uri = M.uri_decode(uri)
   --TODO improve this.
   if is_windows_file_uri(uri) then
-    uri = uri:gsub('^file:/+', '')
-    uri = uri:gsub('/', '\\')
+    uri = uri:gsub('^file:/+', ''):gsub('/', '\\')
   else
-    uri = uri:gsub('^file:/+', '/')
+    uri = uri:gsub('^file:/+', '/') ---@type string
   end
   return uri
 end
-- 
cgit 


From 046c9a83f7ed2694c19d915a63ef0dfed9d29dc5 Mon Sep 17 00:00:00 2001
From: tj-moody <92702993+tj-moody@users.noreply.github.com>
Date: Sat, 23 Sep 2023 22:49:47 -0400
Subject: fix(ui): always use stl/stlnc fillchars when drawing statusline
 (#25267)

---
 runtime/lua/vim/_meta/options.lua | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index baf53c5ccc..f8a51da9b5 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -2181,8 +2181,8 @@ vim.bo.ft = vim.bo.filetype
 --- and the value of that item:
 ---
 ---   item		default		Used for ~
----   stl		' ' or '^'	statusline of the current window
----   stlnc		' ' or '='	statusline of the non-current windows
+---   stl		' '		statusline of the current window
+---   stlnc		' '		statusline of the non-current windows
 ---   wbr		' '		window bar
 ---   horiz		'─' or '-'	horizontal separators `:split`
 ---   horizup	'┴' or '-'	upwards facing horizontal separator
@@ -2201,9 +2201,7 @@ vim.bo.ft = vim.bo.filetype
 ---   eob		'~'		empty lines at the end of a buffer
 ---   lastline	'@'		'display' contains lastline/truncate
 ---
---- Any one that is omitted will fall back to the default.  For "stl" and
---- "stlnc" the space will be used when there is highlighting, '^' or '='
---- otherwise.
+--- Any one that is omitted will fall back to the default.
 ---
 --- Note that "horiz", "horizup", "horizdown", "vertleft", "vertright" and
 --- "verthoriz" are only used when 'laststatus' is 3, since only vertical
-- 
cgit 


From 6fb1e0d499b33534152f09744f967f355a9e2a24 Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Sun, 24 Sep 2023 09:09:18 -0500
Subject: docs: remove "f" from default 'shortmess' value

The "f" flag was removed in f7da4722570617bd8927e7aa533fa9a608c45bba.
The value of the "f" flag is no longer listed in the 'shortmess'
description and it cannot be disabled, so having it in the default value
is pointless and confusing.
---
 runtime/lua/vim/_meta/options.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index f8a51da9b5..461bf95610 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -5719,7 +5719,7 @@ vim.bo.sw = vim.bo.shiftwidth
 ---     shm=at	Abbreviation, and truncate message when necessary.
 ---
 --- @type string
-vim.o.shortmess = "filnxtToOCF"
+vim.o.shortmess = "ilnxtToOCF"
 vim.o.shm = vim.o.shortmess
 vim.go.shortmess = vim.o.shortmess
 vim.go.shm = vim.go.shortmess
-- 
cgit 


From d1bc6fca7123d77ebf03d0badd63f930a5b74064 Mon Sep 17 00:00:00 2001
From: Bogdan Grigoruță <43993819+krady21@users.noreply.github.com>
Date: Sun, 24 Sep 2023 21:43:16 +0300
Subject: feat(health): list attached buffers in LSP report #23561

Problem:
Users using `vim.lsp.start` directly (instead of nvim-lspconfig) need
more visibility for troubleshooting. For example, troubleshooting
unnecesary servers or servers that aren't attaching to expected buffers.

Solution:
Mention attached buffers in the `:checkhealth lsp` report.

Example:

    vim.lsp: Active Clients ~
    - clangd (id=1, root_dir=~/dev/neovim, attached_to=[7])
    - lua_ls (id=2, root_dir=~/dev/neovim, attached_to=[10])
---
 runtime/lua/vim/lsp/health.lua | 9 ++++++++-
 1 file changed, 8 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/health.lua b/runtime/lua/vim/lsp/health.lua
index 023b1c26be..fe06006108 100644
--- a/runtime/lua/vim/lsp/health.lua
+++ b/runtime/lua/vim/lsp/health.lua
@@ -32,8 +32,15 @@ function M.check()
   vim.health.start('vim.lsp: Active Clients')
   if next(clients) then
     for _, client in pairs(clients) do
+      local attached_to = table.concat(vim.tbl_keys(client.attached_buffers or {}), ',')
       report_info(
-        string.format('%s (id=%s, root_dir=%s)', client.name, client.id, client.config.root_dir)
+        string.format(
+          '%s (id=%s, root_dir=%s, attached_to=[%s])',
+          client.name,
+          client.id,
+          vim.fn.fnamemodify(client.config.root_dir, ':~'),
+          attached_to
+        )
       )
     end
   else
-- 
cgit 


From f9944a78bcd305e73053819ce763d8fb1bc7619c Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Fri, 22 Sep 2023 15:25:06 -0700
Subject: feat(meta): add types for vim.lpeg

---
 runtime/lua/vim/_meta/lpeg.lua | 328 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 328 insertions(+)
 create mode 100644 runtime/lua/vim/_meta/lpeg.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/lpeg.lua b/runtime/lua/vim/_meta/lpeg.lua
new file mode 100644
index 0000000000..415bffdfdc
--- /dev/null
+++ b/runtime/lua/vim/_meta/lpeg.lua
@@ -0,0 +1,328 @@
+--- @meta
+
+-- These types were taken from https://github.com/LuaCATS/lpeg, with types being renamed to include
+-- the vim namespace and with some descriptions made less verbose.
+
+--- *LPeg* is a new pattern-matching library for Lua, based on [Parsing Expression Grammars](https://bford.info/packrat/) (PEGs).
+vim.lpeg = {}
+
+--- @class vim.lpeg.Pattern
+--- @operator add(vim.lpeg.Pattern): vim.lpeg.Pattern
+--- @operator mul(vim.lpeg.Pattern): vim.lpeg.Pattern
+--- @operator mul(vim.lpeg.Capture): vim.lpeg.Pattern
+--- @operator div(string): vim.lpeg.Capture
+--- @operator div(number): vim.lpeg.Capture
+--- @operator div(table): vim.lpeg.Capture
+--- @operator div(function): vim.lpeg.Capture
+--- @operator pow(number): vim.lpeg.Pattern
+local Pattern = {}
+
+--- @alias vim.lpeg.Capture vim.lpeg.Pattern
+--- @operator add(vim.lpeg.Capture): vim.lpeg.Pattern
+--- @operator mul(vim.lpeg.Capture): vim.lpeg.Pattern
+--- @operator mul(vim.lpeg.Pattern): vim.lpeg.Pattern
+--- @operator div(string): vim.lpeg.Capture
+--- @operator div(number): vim.lpeg.Capture
+--- @operator div(table): vim.lpeg.Capture
+--- @operator div(function): vim.lpeg.Capture
+--- @operator pow(number): vim.lpeg.Pattern
+
+--- Matches the given `pattern` against the `subject` string. If the match succeeds, returns the index in the
+--- subject of the first character after the match, or the captured values (if the pattern captured any value).
+--- An optional numeric argument `init` makes the match start at that position in the subject string. As usual
+--- in Lua libraries, a negative value counts from the end. Unlike typical pattern-matching functions, `match`
+--- works only in anchored mode; that is, it tries to match the pattern with a prefix of the given subject
+--- string (at position `init`), not with an arbitrary substring of the subject. So, if we want to find a
+--- pattern anywhere in a string, we must either write a loop in Lua or write a pattern that
+--- matches anywhere.
+---
+--- Example:
+--- ```lua
+--- local pattern = lpeg.R("az") ^ 1 * -1
+--- assert(pattern:match("hello") == 6)
+--- assert(lpeg.match(pattern, "hello") == 6)
+--- assert(pattern:match("1 hello") == nil)
+--- ```
+---
+--- @param pattern vim.lpeg.Pattern
+--- @param subject string
+--- @param init? integer
+--- @return integer|vim.lpeg.Capture
+function vim.lpeg.match(pattern, subject, init) end
+
+--- Matches the given `pattern` against the `subject` string. If the match succeeds, returns the
+--- index in the subject of the first character after the match, or the captured values (if the
+--- pattern captured any value). An optional numeric argument `init` makes the match start at
+--- that position in the subject string. As usual in Lua libraries, a negative value counts from the end.
+--- Unlike typical pattern-matching functions, `match` works only in anchored mode; that is, it tries
+--- to match the pattern with a prefix of the given subject string (at position `init`), not with
+--- an arbitrary substring of the subject. So, if we want to find a pattern anywhere in a string,
+--- we must either write a loop in Lua or write a pattern that matches anywhere.
+---
+--- Example:
+--- ```lua
+--- local pattern = lpeg.R("az") ^ 1 * -1
+--- assert(pattern:match("hello") == 6)
+--- assert(lpeg.match(pattern, "hello") == 6)
+--- assert(pattern:match("1 hello") == nil)
+--- ```
+---
+--- @param subject string
+--- @param init? integer
+--- @return integer|vim.lpeg.Capture
+function Pattern:match(subject, init) end
+
+--- Returns the string `"pattern"` if the given value is a pattern, otherwise `nil`.
+---
+--- @return 'pattern'|nil
+function vim.lpeg.type(value) end
+
+--- Returns a string with the running version of LPeg.
+--- @return string
+function vim.lpeg.version() end
+
+--- Sets a limit for the size of the backtrack stack used by LPeg to track calls and choices.
+--- The default limit is `400`. Most well-written patterns need little backtrack levels and
+--- therefore you seldom need to change this limit; before changing it you should try to rewrite
+--- your pattern to avoid the need for extra space. Nevertheless, a few useful patterns may overflow.
+--- Also, with recursive grammars, subjects with deep recursion may also need larger limits.
+---
+--- @param max integer
+function vim.lpeg.setmaxstack(max) end
+
+--- Converts the given value into a proper pattern. This following rules are applied:
+--- * If the argument is a pattern, it is returned unmodified.
+--- * If the argument is a string, it is translated to a pattern that matches the string literally.
+--- * If the argument is a non-negative number `n`, the result is a pattern that matches exactly `n` characters.
+--- * If the argument is a negative number `-n`, the result is a pattern that succeeds only if
+--- the input string has less than `n` characters left: `lpeg.P(-n)` is equivalent to `-lpeg.P(n)`
+--- (see the unary minus operation).
+--- * If the argument is a boolean, the result is a pattern that always succeeds or always fails
+--- (according to the boolean value), without consuming any input.
+--- * If the argument is a table, it is interpreted as a grammar (see Grammars).
+--- * If the argument is a function, returns a pattern equivalent to a match-time captureover the empty string.
+---
+--- @param value vim.lpeg.Pattern|string|integer|boolean|table|function
+--- @return vim.lpeg.Pattern
+function vim.lpeg.P(value) end
+
+--- Returns a pattern that matches only if the input string at the current position is preceded by `patt`.
+--- Pattern `patt` must match only strings with some fixed length, and it cannot contain captures.
+--- Like the and predicate, this pattern never consumes any input, independently of success or failure.
+---
+--- @param pattern vim.lpeg.Pattern
+--- @return vim.lpeg.Pattern
+function vim.lpeg.B(pattern) end
+
+--- Returns a pattern that matches any single character belonging to one of the given ranges.
+--- Each `range` is a string `xy` of length 2, representing all characters with code between the codes of
+--- `x` and `y` (both inclusive). As an example, the pattern `lpeg.R("09")` matches any digit, and
+--- `lpeg.R("az", "AZ")` matches any ASCII letter.
+---
+--- Example:
+--- ```lua
+--- local pattern = lpeg.R("az") ^ 1 * -1
+--- assert(pattern:match("hello") == 6)
+--- ```
+---
+--- @param ... string
+--- @return vim.lpeg.Pattern
+function vim.lpeg.R(...) end
+
+--- Returns a pattern that matches any single character that appears in the given string (the `S` stands for Set).
+--- As an example, the pattern `lpeg.S("+-*/")` matches any arithmetic operator. Note that, if `s` is a character
+--- (that is, a string of length 1), then `lpeg.P(s)` is equivalent to `lpeg.S(s)` which is equivalent to
+--- `lpeg.R(s..s)`. Note also that both `lpeg.S("")` and `lpeg.R()` are patterns that always fail.
+---
+--- @param string string
+--- @return vim.lpeg.Pattern
+function vim.lpeg.S(string) end
+
+--- Creates a non-terminal (a variable) for a grammar. This operation creates a non-terminal (a variable)
+--- for a grammar. The created non-terminal refers to the rule indexed by `v` in the enclosing grammar.
+---
+--- Example:
+--- ```lua
+--- local b = lpeg.P({"(" * ((1 - lpeg.S "()") + lpeg.V(1)) ^ 0 * ")"})
+--- assert(b:match('((string))') == 11)
+--- assert(b:match('(') == nil)
+--- ```
+---
+--- @param v string|integer
+--- @return vim.lpeg.Pattern
+function vim.lpeg.V(v) end
+
+--- @class vim.lpeg.Locale
+--- @field alnum userdata
+--- @field alpha userdata
+--- @field cntrl userdata
+--- @field digit userdata
+--- @field graph userdata
+--- @field lower userdata
+--- @field print userdata
+--- @field punct userdata
+--- @field space userdata
+--- @field upper userdata
+--- @field xdigit userdata
+
+--- Returns a table with patterns for matching some character classes according to the current locale.
+--- The table has fields named `alnum`, `alpha`, `cntrl`, `digit`, `graph`, `lower`, `print`, `punct`,
+--- `space`, `upper`, and `xdigit`, each one containing a correspondent pattern. Each pattern matches
+--- any single character that belongs to its class.
+--- If called with an argument `table`, then it creates those fields inside the given table and returns
+--- that table.
+---
+--- Example:
+--- ```lua
+--- lpeg.locale(lpeg)
+--- local space = lpeg.space^0
+--- local name = lpeg.C(lpeg.alpha^1) * space
+--- local sep = lpeg.S(",;") * space
+--- local pair = lpeg.Cg(name * "=" * space * name) * sep^-1
+--- local list = lpeg.Cf(lpeg.Ct("") * pair^0, rawset)
+--- local t = list:match("a=b, c = hi; next = pi")
+--- assert(t.a == 'b')
+--- assert(t.c == 'hi')
+--- assert(t.next == 'pi')
+--- local locale = lpeg.locale()
+--- assert(type(locale.digit) == 'userdata')
+--- ```
+---
+--- @param tab? table
+--- @return vim.lpeg.Locale
+function vim.lpeg.locale(tab) end
+
+--- Creates a simple capture, which captures the substring of the subject that matches `patt`.
+--- The captured value is a string. If `patt` has other captures, their values are returned after this one.
+---
+--- Example:
+--- ```lua
+--- local function split (s, sep)
+---   sep = lpeg.P(sep)
+---   local elem = lpeg.C((1 - sep)^0)
+---   local p = elem * (sep * elem)^0
+---   return lpeg.match(p, s)
+--- end
+--- local a, b, c = split('a,b,c', ',')
+--- assert(a == 'a')
+--- assert(b == 'b')
+--- assert(c == 'c')
+--- ```
+---
+--- @param patt vim.lpeg.Pattern
+--- @return vim.lpeg.Capture
+function vim.lpeg.C(patt) end
+
+--- Creates an argument capture. This pattern matches the empty string and produces the value given as the
+--- nth extra argument given in the call to `lpeg.match`.
+--- @param n integer
+--- @return vim.lpeg.Capture
+function vim.lpeg.Carg(n) end
+
+--- Creates a back capture. This pattern matches the empty string and produces the values produced by the most recent
+--- group capture named `name` (where `name` can be any Lua value). Most recent means the last complete outermost
+--- group capture with the given name. A Complete capture means that the entire pattern corresponding to the capture
+--- has matched. An Outermost capture means that the capture is not inside another complete capture.
+--- In the same way that LPeg does not specify when it evaluates captures, it does not specify whether it reuses
+--- values previously produced by the group or re-evaluates them.
+---
+--- @param name any
+--- @return vim.lpeg.Capture
+function vim.lpeg.Cb(name) end
+
+--- Creates a constant capture. This pattern matches the empty string and produces all given values as its captured values.
+---
+--- @param ... any
+--- @return vim.lpeg.Capture
+function vim.lpeg.Cc(...) end
+
+--- Creates a fold capture. If `patt` produces a list of captures C1 C2 ... Cn, this capture will produce the value
+--- `func(...func(func(C1, C2), C3)...,Cn)`, that is, it will fold (or accumulate, or reduce) the captures from
+--- `patt` using function `func`. This capture assumes that `patt` should produce at least one capture with at
+--- least one value (of any type), which becomes the initial value of an accumulator. (If you need a specific
+--- initial value, you may prefix a constant captureto `patt`.) For each subsequent capture, LPeg calls `func`
+--- with this accumulator as the first argument and all values produced by the capture as extra arguments;
+--- the first result from this call becomes the new value for the accumulator. The final value of the accumulator
+--- becomes the captured value.
+---
+--- Example:
+--- ```lua
+--- local number = lpeg.R("09") ^ 1 / tonumber
+--- local list = number * ("," * number) ^ 0
+--- local function add(acc, newvalue) return acc + newvalue end
+--- local sum = lpeg.Cf(list, add)
+--- assert(sum:match("10,30,43") == 83)
+--- ```
+---
+--- @param patt vim.lpeg.Pattern
+--- @param func fun(acc, newvalue)
+--- @return vim.lpeg.Capture
+function vim.lpeg.Cf(patt, func) end
+
+--- Creates a group capture. It groups all values returned by `patt` into a single capture.
+--- The group may be anonymous (if no name is given) or named with the given name (which
+--- can be any non-nil Lua value).
+---
+--- @param patt vim.lpeg.Pattern
+--- @param name? string
+--- @return vim.lpeg.Capture
+function vim.lpeg.Cg(patt, name) end
+
+--- Creates a position capture. It matches the empty string and captures the position in the
+--- subject where the match occurs. The captured value is a number.
+---
+--- Example:
+--- ```lua
+--- local I = lpeg.Cp()
+--- local function anywhere(p) return lpeg.P({I * p * I + 1 * lpeg.V(1)}) end
+--- local match_start, match_end = anywhere("world"):match("hello world!")
+--- assert(match_start == 7)
+--- assert(match_end == 12)
+--- ```
+---
+--- @return vim.lpeg.Capture
+function vim.lpeg.Cp() end
+
+--- Creates a substitution capture. This function creates a substitution capture, which
+--- captures the substring of the subject that matches `patt`, with substitutions.
+--- For any capture inside `patt` with a value, the substring that matched the capture
+--- is replaced by the capture value (which should be a string). The final captured
+--- value is the string resulting from all replacements.
+---
+--- Example:
+--- ```lua
+--- local function gsub (s, patt, repl)
+---   patt = lpeg.P(patt)
+---   patt = lpeg.Cs((patt / repl + 1)^0)
+---   return lpeg.match(patt, s)
+--- end
+--- assert(gsub('Hello, xxx!', 'xxx', 'World') == 'Hello, World!')
+--- ```
+---
+--- @param patt vim.lpeg.Pattern
+--- @return vim.lpeg.Capture
+function vim.lpeg.Cs(patt) end
+
+--- Creates a table capture. This capture returns a table with all values from all anonymous captures
+--- made by `patt` inside this table in successive integer keys, starting at 1.
+--- Moreover, for each named capture group created by `patt`, the first value of the group is put into
+--- the table with the group name as its key. The captured value is only the table.
+---
+--- @param patt vim.lpeg.Pattern|''
+--- @return vim.lpeg.Capture
+function vim.lpeg.Ct(patt) end
+
+--- Creates a match-time capture. Unlike all other captures, this one is evaluated immediately when a match occurs
+--- (even if it is part of a larger pattern that fails later). It forces the immediate evaluation of all its nested captures
+--- and then calls `function`. The given function gets as arguments the entire subject, the current position
+--- (after the match of `patt`), plus any capture values produced by `patt`. The first value returned by `function`
+--- defines how the match happens. If the call returns a number, the match succeeds and the returned number
+--- becomes the new current position. (Assuming a subject sand current position i, the returned number must be
+--- in the range [i, len(s) + 1].) If the call returns true, the match succeeds without consuming any input
+--- (so, to return true is equivalent to return i). If the call returns false, nil, or no value, the match fails.
+--- Any extra values returned by the function become the values produced by the capture.
+---
+--- @param patt vim.lpeg.Pattern
+--- @param fn function
+--- @return vim.lpeg.Capture
+function vim.lpeg.Cmt(patt, fn) end
-- 
cgit 


From 57b84f6d640a13e0f1aed5e713609b366400c48f Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 25 Sep 2023 06:37:54 +0800
Subject: vim-patch:790f9a890cee

runtime(doc): Add a missing '<' to the help of strutf16len() (vim/vim#13168)

https://github.com/vim/vim/commit/790f9a890ceeb9539776265cba0f026fb2c96790

Co-authored-by: a5ob7r <12132068+a5ob7r@users.noreply.github.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 4113797759..6686661a27 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -9192,6 +9192,7 @@ function vim.fn.strtrans(string) end
 ---     echo strutf16len('😊')    " returns 2
 ---     echo strutf16len('ą́')    " returns 1
 ---     echo strutf16len('ą́', v:true)  " returns 3
+--- <
 ---
 --- @param string string
 --- @param countcc? 0|1
-- 
cgit 


From db51548036ebe4b01c5b78aeca7a76aa71ab4fbe Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sun, 24 Sep 2023 21:39:59 -0700
Subject: docs: do not use deprecated functions #25334

---
 runtime/lua/vim/_editor.lua   | 2 +-
 runtime/lua/vim/_meta/api.lua | 7 +++++++
 runtime/lua/vim/_options.lua  | 2 +-
 3 files changed, 9 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index e4a2dadb09..7f09fc8038 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -888,7 +888,7 @@ end
 --- Example:
 ---
 --- ```lua
---- local hl_normal = vim.print(vim.api.nvim_get_hl_by_name('Normal', true))
+--- local hl_normal = vim.print(vim.api.nvim_get_hl(0, { name = 'Normal' }))
 --- ```
 ---
 --- @see |vim.inspect()|
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 81fa7ce7ec..5c51fbd146 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -425,6 +425,7 @@ function vim.api.nvim_buf_get_number(buffer) end
 --- @return integer
 function vim.api.nvim_buf_get_offset(buffer, index) end
 
+--- @deprecated
 --- @param buffer integer
 --- @param name string
 --- @return any
@@ -632,6 +633,7 @@ function vim.api.nvim_buf_set_mark(buffer, name, line, col, opts) end
 --- @param name string Buffer name
 function vim.api.nvim_buf_set_name(buffer, name) end
 
+--- @deprecated
 --- @param buffer integer
 --- @param name string
 --- @param value any
@@ -1283,10 +1285,12 @@ function vim.api.nvim_get_mode() end
 --- @return table<string,any>
 function vim.api.nvim_get_namespaces() end
 
+--- @deprecated
 --- @param name string
 --- @return any
 function vim.api.nvim_get_option(name) end
 
+--- @deprecated
 --- @param name string
 --- @return table<string,any>
 function vim.api.nvim_get_option_info(name) end
@@ -1912,6 +1916,7 @@ function vim.api.nvim_set_hl_ns_fast(ns_id) end
 ---               "callback" is equivalent to returning an empty string.
 function vim.api.nvim_set_keymap(mode, lhs, rhs, opts) end
 
+--- @deprecated
 --- @param name string
 --- @param value any
 function vim.api.nvim_set_option(name, value) end
@@ -2115,6 +2120,7 @@ function vim.api.nvim_win_get_height(window) end
 --- @return integer
 function vim.api.nvim_win_get_number(window) end
 
+--- @deprecated
 --- @param window integer
 --- @param name string
 --- @return any
@@ -2197,6 +2203,7 @@ function vim.api.nvim_win_set_height(window, height) end
 --- @param ns_id integer the namespace to use
 function vim.api.nvim_win_set_hl_ns(window, ns_id) end
 
+--- @deprecated
 --- @param window integer
 --- @param name string
 --- @param value any
diff --git a/runtime/lua/vim/_options.lua b/runtime/lua/vim/_options.lua
index 6a3413b597..b83a8dd4b1 100644
--- a/runtime/lua/vim/_options.lua
+++ b/runtime/lua/vim/_options.lua
@@ -127,7 +127,7 @@ end
 
 --- @param name string
 local function get_options_info(name)
-  local info = api.nvim_get_option_info(name)
+  local info = api.nvim_get_option_info2(name, {})
   info.metatype = get_option_metatype(name, info)
   return info
 end
-- 
cgit 


From c3d1d9445c70846d43d1f091ee0762e16513e225 Mon Sep 17 00:00:00 2001
From: bfredl <bjorn.linse@gmail.com>
Date: Mon, 25 Sep 2023 12:21:35 +0200
Subject: refactor(options)!: graduate some more shortmess flags

A lot of updated places in the docs were already incorrect since long
since they did not reflect the default behaviour.

"[dos format]" could've been argued being better for discoverability
but that ship has already sailed as it is no longer displayed by default.
---
 runtime/lua/vim/_meta/options.lua | 7 +------
 1 file changed, 1 insertion(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 461bf95610..6ef3cf57e1 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -5666,16 +5666,11 @@ vim.bo.sw = vim.bo.shiftwidth
 --- messages, for example  with CTRL-G, and to avoid some other messages.
 --- It is a list of flags:
 ---  flag	meaning when present	~
----   i	use "[noeol]" instead of "[Incomplete last line]"	*shm-i*
 ---   l	use "999L, 888B" instead of "999 lines, 888 bytes"	*shm-l*
 ---   m	use "[+]" instead of "[Modified]"			*shm-m*
----   n	use "[New]" instead of "[New File]"			*shm-n*
 ---   r	use "[RO]" instead of "[readonly]"			*shm-r*
 ---   w	use "[w]" instead of "written" for file write message	*shm-w*
 --- 	and "[a]" instead of "appended" for ':w >> file' command
----   x	use "[dos]" instead of "[dos format]", "[unix]"		*shm-x*
---- 	instead of "[unix format]" and "[mac]" instead of "[mac
---- 	format]"
 ---   a	all of the above abbreviations				*shm-a*
 ---
 ---   o	overwrite message for writing a file with subsequent	*shm-o*
@@ -5719,7 +5714,7 @@ vim.bo.sw = vim.bo.shiftwidth
 ---     shm=at	Abbreviation, and truncate message when necessary.
 ---
 --- @type string
-vim.o.shortmess = "ilnxtToOCF"
+vim.o.shortmess = "ltToOCF"
 vim.o.shm = vim.o.shortmess
 vim.go.shortmess = vim.o.shortmess
 vim.go.shm = vim.go.shortmess
-- 
cgit 


From 5198a2555de4917177f229e4a0496e2448d9fb84 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sun, 24 Sep 2023 21:20:10 -0700
Subject: fix(meta): cleanup lpeg operators

---
 runtime/lua/vim/_meta/lpeg.lua | 11 +++--------
 1 file changed, 3 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/lpeg.lua b/runtime/lua/vim/_meta/lpeg.lua
index 415bffdfdc..42e77aaaba 100644
--- a/runtime/lua/vim/_meta/lpeg.lua
+++ b/runtime/lua/vim/_meta/lpeg.lua
@@ -7,7 +7,9 @@
 vim.lpeg = {}
 
 --- @class vim.lpeg.Pattern
+--- @operator unm: vim.lpeg.Pattern
 --- @operator add(vim.lpeg.Pattern): vim.lpeg.Pattern
+--- @operator sub(vim.lpeg.Pattern): vim.lpeg.Pattern
 --- @operator mul(vim.lpeg.Pattern): vim.lpeg.Pattern
 --- @operator mul(vim.lpeg.Capture): vim.lpeg.Pattern
 --- @operator div(string): vim.lpeg.Capture
@@ -15,17 +17,10 @@ vim.lpeg = {}
 --- @operator div(table): vim.lpeg.Capture
 --- @operator div(function): vim.lpeg.Capture
 --- @operator pow(number): vim.lpeg.Pattern
+--- @operator mod(function): nil
 local Pattern = {}
 
 --- @alias vim.lpeg.Capture vim.lpeg.Pattern
---- @operator add(vim.lpeg.Capture): vim.lpeg.Pattern
---- @operator mul(vim.lpeg.Capture): vim.lpeg.Pattern
---- @operator mul(vim.lpeg.Pattern): vim.lpeg.Pattern
---- @operator div(string): vim.lpeg.Capture
---- @operator div(number): vim.lpeg.Capture
---- @operator div(table): vim.lpeg.Capture
---- @operator div(function): vim.lpeg.Capture
---- @operator pow(number): vim.lpeg.Pattern
 
 --- Matches the given `pattern` against the `subject` string. If the match succeeds, returns the index in the
 --- subject of the first character after the match, or the captured values (if the pattern captured any value).
-- 
cgit 


From 4db77017fb7ab9321817674a5f5533df4cd03f3f Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sun, 24 Sep 2023 23:14:06 -0700
Subject: fix(meta): add nil return types to lpeg functions

---
 runtime/lua/vim/_meta/lpeg.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/lpeg.lua b/runtime/lua/vim/_meta/lpeg.lua
index 42e77aaaba..42c9a6449e 100644
--- a/runtime/lua/vim/_meta/lpeg.lua
+++ b/runtime/lua/vim/_meta/lpeg.lua
@@ -42,7 +42,7 @@ local Pattern = {}
 --- @param pattern vim.lpeg.Pattern
 --- @param subject string
 --- @param init? integer
---- @return integer|vim.lpeg.Capture
+--- @return integer|vim.lpeg.Capture|nil
 function vim.lpeg.match(pattern, subject, init) end
 
 --- Matches the given `pattern` against the `subject` string. If the match succeeds, returns the
@@ -64,7 +64,7 @@ function vim.lpeg.match(pattern, subject, init) end
 ---
 --- @param subject string
 --- @param init? integer
---- @return integer|vim.lpeg.Capture
+--- @return integer|vim.lpeg.Capture|nil
 function Pattern:match(subject, init) end
 
 --- Returns the string `"pattern"` if the given value is a pattern, otherwise `nil`.
-- 
cgit 


From f8ea49cfe1f4f3ed30da160d346553f0949ec1de Mon Sep 17 00:00:00 2001
From: glepnir <glephunter@gmail.com>
Date: Mon, 18 Sep 2023 14:50:27 +0800
Subject: fix(highlight): add force in nvim_set_hl

---
 runtime/lua/vim/_meta/api.lua         | 2 ++
 runtime/lua/vim/_meta/api_keysets.lua | 1 +
 2 files changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 6573c68493..3822e5ff5b 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1857,6 +1857,8 @@ function vim.api.nvim_set_decoration_provider(ns_id, opts) end
 ---              • cterm: cterm attribute map, like `highlight-args`. If not
 ---                set, cterm attributes will match those from the attribute
 ---                map documented above.
+---              • force: if true force update the highlight group when it
+---                exists.
 function vim.api.nvim_set_hl(ns_id, name, val) end
 
 --- Set active namespace for highlights defined with `nvim_set_hl()`. This can
diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index 4d08563ce2..349c68f8f9 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -164,6 +164,7 @@ error('Cannot require a meta file')
 --- @field blend? integer
 --- @field fg_indexed? boolean
 --- @field bg_indexed? boolean
+--- @field force? boolean
 
 --- @class vim.api.keyset.highlight_cterm
 --- @field bold? boolean
-- 
cgit 


From 86b7d8a9f54d572e6866d6a24476d2369a288f79 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 28 Sep 2023 05:22:09 +0800
Subject: vim-patch:5277cfaf8afe (#25397)

runtime(doc): mention mouse scrolling in scrollbind-quickadj (vim/vim#13190)

https://github.com/vim/vim/commit/5277cfaf8afe847b7d4dcde6057fbecb001ab64e
---
 runtime/lua/vim/_meta/options.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 6ef3cf57e1..ed0d844748 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -5113,9 +5113,9 @@ vim.o.scbk = vim.o.scrollback
 vim.bo.scrollback = vim.o.scrollback
 vim.bo.scbk = vim.bo.scrollback
 
---- See also `scroll-binding`.  When this option is set, the current
---- window scrolls as other scrollbind windows (windows that also have
---- this option set) scroll.  This option is useful for viewing the
+--- See also `scroll-binding`.  When this option is set, scrolling the
+--- current window also scrolls other scrollbind windows (windows that
+--- also have this option set).  This option is useful for viewing the
 --- differences between two versions of a file, see 'diff'.
 --- See `'scrollopt'` for options that determine how this option should be
 --- interpreted.
-- 
cgit 


From 7ec20a4082f2e62e0ae90d464e0d62aa4ffdacf4 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Fri, 29 Sep 2023 06:52:02 +0800
Subject: vim-patch:9.0.1950: Vim9: error codes spread out (#25405)

Problem:  Vim9: error codes spread out
Solution: group them together and reserve 100
          more for future use

Reserve 100 error codes for future enhancements to the Vim9 class
support

closes: vim/vim#13207

https://github.com/vim/vim/commit/413f83990f15d5d59d27ab741670f527a7a3feb8

Co-authored-by: Yegappan Lakshmanan <yegappan@yahoo.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 6686661a27..86e8781160 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -6238,55 +6238,55 @@ function vim.fn.prevnonblank(lnum) end
 ---   echo printf("%1$*2$.*3$f", 1.4142135, 6, 2)
 --- <    1.41
 ---
----           *E1400*
+---           *E1500*
 --- You cannot mix positional and non-positional arguments: >vim
 ---   echo printf("%s%1$s", "One", "Two")
---- <  E1400: Cannot mix positional and non-positional
+--- <  E1500: Cannot mix positional and non-positional
 ---   arguments: %s%1$s
 ---
----           *E1401*
+---           *E1501*
 --- You cannot skip a positional argument in a format string: >vim
 ---   echo printf("%3$s%1$s", "One", "Two", "Three")
---- <  E1401: format argument 2 unused in $-style
+--- <  E1501: format argument 2 unused in $-style
 ---   format: %3$s%1$s
 ---
----           *E1402*
+---           *E1502*
 --- You can re-use a [field-width] (or [precision]) argument: >vim
 ---   echo printf("%1$d at width %2$d is: %01$*2$d", 1, 2)
 --- <  1 at width 2 is: 01
 ---
 --- However, you can't use it as a different type: >vim
 ---   echo printf("%1$d at width %2$ld is: %01$*2$d", 1, 2)
---- <  E1402: Positional argument 2 used as field
+--- <  E1502: Positional argument 2 used as field
 ---   width reused as different type: long int/int
 ---
----           *E1403*
+---           *E1503*
 --- When a positional argument is used, but not the correct number
 --- or arguments is given, an error is raised: >vim
 ---   echo printf("%1$d at width %2$d is: %01$*2$.*3$d", 1, 2)
---- <  E1403: Positional argument 3 out of bounds:
+--- <  E1503: Positional argument 3 out of bounds:
 ---   %1$d at width %2$d is: %01$*2$.*3$d
 ---
 --- Only the first error is reported: >vim
 ---   echo printf("%01$*2$.*3$d %4$d", 1, 2)
---- <  E1403: Positional argument 3 out of bounds:
+--- <  E1503: Positional argument 3 out of bounds:
 ---   %01$*2$.*3$d %4$d
 ---
----           *E1404*
+---           *E1504*
 --- A positional argument can be used more than once: >vim
 ---   echo printf("%1$s %2$s %1$s", "One", "Two")
 --- <  One Two One
 ---
 --- However, you can't use a different type the second time: >vim
 ---   echo printf("%1$s %2$s %1$d", "One", "Two")
---- <  E1404: Positional argument 1 type used
+--- <  E1504: Positional argument 1 type used
 ---   inconsistently: int/string
 ---
----           *E1405*
+---           *E1505*
 --- Various other errors that lead to a format string being
 --- wrongly formatted lead to: >vim
 ---   echo printf("%1$d at width %2$d is: %01$*2$.3$d", 1, 2)
---- <  E1405: Invalid format specifier:
+--- <  E1505: Invalid format specifier:
 ---   %1$d at width %2$d is: %01$*2$.3$d
 ---
 --- @param fmt any
-- 
cgit 


From 9ed830a3ca5847a9152b91fca5e1eaf712bed55b Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Fri, 29 Sep 2023 08:37:14 -0700
Subject: refactor(lsp): deprecate util methods (#25400)

---
 runtime/lua/vim/lsp/util.lua | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 0d1e3cc0d1..51ed87219c 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -168,10 +168,12 @@ end
 
 local _str_utfindex_enc = M._str_utfindex_enc
 local _str_byteindex_enc = M._str_byteindex_enc
+
 --- Replaces text in a range with new text.
 ---
 --- CAUTION: Changes in-place!
 ---
+---@deprecated
 ---@param lines (table) Original list of strings
 ---@param A (table) Start position; a 2-tuple of {line,col} numbers
 ---@param B (table) End position; a 2-tuple of {line,col} numbers
@@ -320,9 +322,7 @@ local function get_line(bufnr, row)
 end
 
 --- Position is a https://microsoft.github.io/language-server-protocol/specifications/specification-current/#position
---- Returns a zero-indexed column, since set_lines() does the conversion to
 ---@param offset_encoding string|nil utf-8|utf-16|utf-32
---- 1-indexed
 ---@return integer
 local function get_line_byte_from_position(bufnr, position, offset_encoding)
   -- LSP's line and characters are 0-indexed
@@ -1991,6 +1991,7 @@ end
 ---
 --- CAUTION: Modifies the input in-place!
 ---
+---@deprecated
 ---@param lines table list of lines
 ---@return string filetype or "markdown" if it was unchanged.
 function M.try_trim_markdown_code_blocks(lines)
-- 
cgit 


From 4200a0f1678c06c6da4e4cfb0184c29c1174ed21 Mon Sep 17 00:00:00 2001
From: glepnir <glephunter@gmail.com>
Date: Wed, 27 Sep 2023 17:23:42 +0800
Subject: feat(float): support toggle show float window

---
 runtime/lua/vim/_meta/api.lua         | 1 +
 runtime/lua/vim/_meta/api_keysets.lua | 1 +
 2 files changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 68ef54eb2f..0575c13443 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1617,6 +1617,7 @@ function vim.api.nvim_open_term(buffer, opts) end
 ---                 fire from calling this function.
 ---               • fixed: If true when anchor is NW or SW, the float window
 ---                 would be kept fixed even if the window would be truncated.
+---               • hide: If true the floating window will be hidden.
 --- @return integer
 function vim.api.nvim_open_win(buffer, enter, config) end
 
diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index eaaa32d7b3..698e706171 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -113,6 +113,7 @@ error('Cannot require a meta file')
 --- @field style? string
 --- @field noautocmd? boolean
 --- @field fixed? boolean
+--- @field hide? boolean
 
 --- @class vim.api.keyset.get_autocmds
 --- @field event? any
-- 
cgit 


From 2615ed879e66a3d05920c47177e77383adc7aca0 Mon Sep 17 00:00:00 2001
From: Daniel Steinberg <dstein64@users.noreply.github.com>
Date: Tue, 18 Jul 2023 17:02:45 -0400
Subject: feat(ui): allow to get the highlight namespace

---
 runtime/lua/vim/_meta/api.lua         | 10 ++++++++++
 runtime/lua/vim/_meta/api_keysets.lua |  3 +++
 2 files changed, 13 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 68ef54eb2f..f0101eb6a4 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1258,6 +1258,16 @@ function vim.api.nvim_get_hl_by_name(name, rgb) end
 --- @return integer
 function vim.api.nvim_get_hl_id_by_name(name) end
 
+--- Gets the active highlight namespace.
+---
+--- @param opts vim.api.keyset.get_ns Optional parameters
+---             • winid: (number) `window-ID` for retrieving a window's
+---               highlight namespace. A value of -1 is returned when
+---               `nvim_win_set_hl_ns()` has not been called for the window
+---               (or was called with a namespace of -1).
+--- @return integer
+function vim.api.nvim_get_hl_ns(opts) end
+
 --- Gets a list of global (non-buffer-local) `mapping` definitions.
 ---
 --- @param mode string Mode short-name ("n", "i", "v", ...)
diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index eaaa32d7b3..88de2f58d0 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -136,6 +136,9 @@ error('Cannot require a meta file')
 --- @field link? boolean
 --- @field create? boolean
 
+--- @class vim.api.keyset.get_ns
+--- @field winid? integer
+
 --- @class vim.api.keyset.highlight
 --- @field bold? boolean
 --- @field standout? boolean
-- 
cgit 


From 9ce1623837a817c3f4f5deff9c8ba862578b6009 Mon Sep 17 00:00:00 2001
From: Till Bungert <tillbungert@gmail.com>
Date: Sun, 1 Oct 2023 21:10:51 +0200
Subject: feat(treesitter): add foldtext with treesitter highlighting (#25391)

---
 runtime/lua/vim/treesitter.lua       | 12 +++++
 runtime/lua/vim/treesitter/_fold.lua | 92 ++++++++++++++++++++++++++++++++++++
 2 files changed, 104 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index 0e34cbcbcc..f863942d3b 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -508,4 +508,16 @@ function M.foldexpr(lnum)
   return require('vim.treesitter._fold').foldexpr(lnum)
 end
 
+--- Returns the highlighted content of the first line of the fold or falls back to |foldtext()|
+--- if no treesitter parser is found. Can be set directly to 'foldtext':
+---
+--- ```lua
+--- vim.wo.foldtext = 'v:lua.vim.treesitter.foldtext()'
+--- ```
+---
+---@return { [1]: string, [2]: string[] }[] | string
+function M.foldtext()
+  return require('vim.treesitter._fold').foldtext()
+end
+
 return M
diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index 8bc08c9c2e..c6a4b48d4f 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -361,4 +361,96 @@ function M.foldexpr(lnum)
   return foldinfos[bufnr].levels[lnum] or '0'
 end
 
+---@package
+---@return { [1]: string, [2]: string[] }[]|string
+function M.foldtext()
+  local foldstart = vim.v.foldstart
+  local bufnr = api.nvim_get_current_buf()
+
+  ---@type boolean, LanguageTree
+  local ok, parser = pcall(ts.get_parser, bufnr)
+  if not ok then
+    return vim.fn.foldtext()
+  end
+
+  local query = ts.query.get(parser:lang(), 'highlights')
+  if not query then
+    return vim.fn.foldtext()
+  end
+
+  local tree = parser:parse({ foldstart - 1, foldstart })[1]
+
+  local line = api.nvim_buf_get_lines(bufnr, foldstart - 1, foldstart, false)[1]
+  if not line then
+    return vim.fn.foldtext()
+  end
+
+  ---@type { [1]: string, [2]: string[], range: { [1]: integer, [2]: integer } }[] | { [1]: string, [2]: string[] }[]
+  local result = {}
+
+  local line_pos = 0
+
+  for id, node, metadata in query:iter_captures(tree:root(), 0, foldstart - 1, foldstart) do
+    local name = query.captures[id]
+    local start_row, start_col, end_row, end_col = node:range()
+
+    local priority = tonumber(metadata.priority or vim.highlight.priorities.treesitter)
+
+    if start_row == foldstart - 1 and end_row == foldstart - 1 then
+      -- check for characters ignored by treesitter
+      if start_col > line_pos then
+        table.insert(result, {
+          line:sub(line_pos + 1, start_col),
+          { { 'Folded', priority } },
+          range = { line_pos, start_col },
+        })
+      end
+      line_pos = end_col
+
+      local text = line:sub(start_col + 1, end_col)
+      table.insert(result, { text, { { '@' .. name, priority } }, range = { start_col, end_col } })
+    end
+  end
+
+  local i = 1
+  while i <= #result do
+    -- find first capture that is not in current range and apply highlights on the way
+    local j = i + 1
+    while
+      j <= #result
+      and result[j].range[1] >= result[i].range[1]
+      and result[j].range[2] <= result[i].range[2]
+    do
+      for k, v in ipairs(result[i][2]) do
+        if not vim.tbl_contains(result[j][2], v) then
+          table.insert(result[j][2], k, v)
+        end
+      end
+      j = j + 1
+    end
+
+    -- remove the parent capture if it is split into children
+    if j > i + 1 then
+      table.remove(result, i)
+    else
+      -- highlights need to be sorted by priority, on equal prio, the deeper nested capture (earlier
+      -- in list) should be considered higher prio
+      if #result[i][2] > 1 then
+        table.sort(result[i][2], function(a, b)
+          return a[2] < b[2]
+        end)
+      end
+
+      result[i][2] = vim.tbl_map(function(tbl)
+        return tbl[1]
+      end, result[i][2])
+      result[i] = { result[i][1], result[i][2] }
+
+      i = i + 1
+    end
+  end
+
+  return result
+end
+
 return M
-- 
cgit 


From 4a09c178a19097c295521892c889f1f196fff100 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Mon, 2 Oct 2023 22:14:19 +0200
Subject: feat(lsp): fallback to code-action command on resolve failure
 (#25464)

The haskell-language-server supports resolve only for a subset of code
actions. For many code actions trying to resolve the `edit` property
results in an error, but the unresolved action already contains a
command that can be executed without issue.

The protocol specification is unfortunately a bit vague about this,
and what the haskell-language-server does seems to be valid.

Example:

    newtype Dummy = Dummy Int
    instance Num Dummy where

Triggering code actions on "Num Dummy" and choosing "Add placeholders
for all missing methods" resulted in:

    -32601: No plugin enabled for SMethod_CodeActionResolve, potentially available: explicit-fields, importLens, hlint, overloaded-record-dot

With this change it will insert the missing methods:

    instance Num Dummy where
      (+) = _
      (-) = _
      (*) = _
      negate = _
      abs = _
      signum = _
      fromInteger = _
---
 runtime/lua/vim/lsp/buf.lua | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 8a29fac2b5..a906512e24 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -652,7 +652,7 @@ local function on_code_action_results(results, ctx, options)
     --  arguments?: any[]
     --
     ---@type lsp.Client
-    local client = vim.lsp.get_client_by_id(action_tuple[1])
+    local client = assert(vim.lsp.get_client_by_id(action_tuple[1]))
     local action = action_tuple[2]
 
     local reg = client.dynamic_capabilities:get(ms.textDocument_codeAction, { bufnr = ctx.bufnr })
@@ -663,10 +663,14 @@ local function on_code_action_results(results, ctx, options)
     if not action.edit and client and supports_resolve then
       client.request(ms.codeAction_resolve, action, function(err, resolved_action)
         if err then
-          vim.notify(err.code .. ': ' .. err.message, vim.log.levels.ERROR)
-          return
+          if action.command then
+            apply_action(action, client)
+          else
+            vim.notify(err.code .. ': ' .. err.message, vim.log.levels.ERROR)
+          end
+        else
+          apply_action(resolved_action, client)
         end
-        apply_action(resolved_action, client)
       end, ctx.bufnr)
     else
       apply_action(action, client)
-- 
cgit 


From f736b075d371dd15fa6fffc907db7952bc19bb9d Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sun, 1 Oct 2023 09:53:18 -0700
Subject: feat(lsp): snippet parsing using lpeg

---
 runtime/lua/vim/lsp/_snippet_grammar.lua | 143 +++++++++++++++++++++++++++++++
 1 file changed, 143 insertions(+)
 create mode 100644 runtime/lua/vim/lsp/_snippet_grammar.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_snippet_grammar.lua b/runtime/lua/vim/lsp/_snippet_grammar.lua
new file mode 100644
index 0000000000..86f00fea51
--- /dev/null
+++ b/runtime/lua/vim/lsp/_snippet_grammar.lua
@@ -0,0 +1,143 @@
+--- Grammar for LSP snippets, based on https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#snippet_syntax
+
+local lpeg = vim.lpeg
+local P, S, R, V = lpeg.P, lpeg.S, lpeg.R, lpeg.V
+local C, Cg, Ct = lpeg.C, lpeg.Cg, lpeg.Ct
+
+local M = {}
+
+local alpha = R('az', 'AZ')
+local backslash = P('\\')
+local colon = P(':')
+local dollar = P('$')
+local int = R('09') ^ 1
+local l_brace, r_brace = P('{'), P('}')
+local pipe = P('|')
+local slash = P('/')
+local underscore = P('_')
+local var = Cg((underscore + alpha) * ((underscore + alpha + int) ^ 0), 'name')
+local format_capture = Cg(int / tonumber, 'capture')
+local format_modifier = Cg(P('upcase') + P('downcase') + P('capitalize'), 'modifier')
+local tabstop = Cg(int / tonumber, 'tabstop')
+
+--- Returns a function that unescapes occurrences of "special" characters.
+---
+--- @param special string
+--- @return fun(match: string): string
+local function escape_text(special)
+  return function(match)
+    local escaped = match:gsub('\\(.)', function(c)
+      return special:find(c) and c or '\\' .. c
+    end)
+    return escaped
+  end
+end
+
+-- Text nodes match "any character", but $, \, and } must be escaped.
+local escapable = '$}\\'
+local text = (backslash * S(escapable)) + (P(1) - S(escapable))
+local text_0, text_1 = (text ^ 0) / escape_text(escapable), text ^ 1
+-- Within choice nodes, \ also escapes comma and pipe characters.
+local choice_text = C(((backslash * S(escapable .. ',|')) + (P(1) - S(escapable .. ',|'))) ^ 1)
+  / escape_text(escapable .. ',|')
+local if_text, else_text = Cg(text_0, 'if_text'), Cg(text_0, 'else_text')
+-- Within format nodes, make sure we stop at /
+local format_text = C(((backslash * S(escapable)) + (P(1) - S(escapable .. '/'))) ^ 1)
+  / escape_text(escapable)
+-- Within ternary condition format nodes, make sure we stop at :
+local if_till_colon_text = Cg(
+  C(((backslash * S(escapable)) + (P(1) - S(escapable .. ':'))) ^ 1) / escape_text(escapable),
+  'if_text'
+)
+
+-- Matches the string inside //, allowing escaping of the closing slash.
+local regex = Cg(((backslash * slash) + (P(1) - slash)) ^ 1, 'regex')
+
+-- Regex constructor flags (see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp#parameters).
+local options = Cg(S('dgimsuvy') ^ 0, 'options')
+
+--- @enum vim.snippet.Type
+local Type = {
+  Tabstop = 1,
+  Placeholder = 2,
+  Choice = 3,
+  Variable = 4,
+  Format = 5,
+  Text = 6,
+  Snippet = 7,
+}
+M.NodeType = Type
+
+--- @class vim.snippet.Node<T>: { type: vim.snippet.Type, data: T }
+--- @class vim.snippet.TabstopData: { tabstop: number }
+--- @class vim.snippet.TextData: { text: string }
+--- @class vim.snippet.PlaceholderData: { tabstop: vim.snippet.TabstopData, value: vim.snippet.Node<any> }
+--- @class vim.snippet.ChoiceData: { tabstop: vim.snippet.TabstopData, values: string[] }
+--- @class vim.snippet.VariableData: { name: string, default?: vim.snippet.Node<any>, regex?: string, format?: vim.snippet.Node<vim.snippet.FormatData|vim.snippet.TextData>[], options?: string }
+--- @class vim.snippet.FormatData: { capture: number, modifier?: string, if_text?: string, else_text?: string }
+--- @class vim.snippet.SnippetData: { children: vim.snippet.Node<any>[] }
+
+--- Returns a function that constructs a snippet node of the given type.
+---
+--- @generic T
+--- @param type vim.snippet.Type
+--- @return fun(data: T): vim.snippet.Node<T>
+local function node(type)
+  return function(data)
+    return { type = type, data = data }
+  end
+end
+
+-- stylua: ignore
+local G = P({
+  'snippet';
+  snippet = Ct(Cg(
+    Ct((
+      V('any') +
+      (Ct(Cg(text_1 / escape_text(escapable), 'text')) / node(Type.Text))
+    ) ^ 1), 'children'
+  )) / node(Type.Snippet),
+  any_or_text = V('any') + (Ct(Cg(text_0 / escape_text(escapable), 'text')) / node(Type.Text)),
+  any = V('placeholder') + V('tabstop') + V('choice') + V('variable'),
+  tabstop = Ct(dollar * (tabstop + (l_brace * tabstop * r_brace))) / node(Type.Tabstop),
+  placeholder = Ct(dollar * l_brace * tabstop * colon * Cg(V('any_or_text'), 'value') * r_brace) / node(Type.Placeholder),
+  choice = Ct(dollar *
+    l_brace *
+    tabstop *
+    pipe *
+    Cg(Ct(choice_text * (P(',') * choice_text) ^ 0), 'values') *
+    pipe *
+    r_brace) / node(Type.Choice),
+  variable = Ct(dollar * (
+    var + (
+    l_brace * var * (
+      r_brace +
+      (colon * Cg(V('any_or_text'), 'default') * r_brace) +
+      (slash * regex * slash * Cg(Ct((V('format') + (C(format_text) / node(Type.Text))) ^ 1), 'format') * slash * options * r_brace)
+    ))
+  )) / node(Type.Variable),
+  format = Ct(dollar * (
+    format_capture + (
+    l_brace * format_capture * (
+      r_brace +
+      (colon * (
+        (slash * format_modifier * r_brace) +
+        (P('+') * if_text * r_brace) +
+        (P('?') * if_till_colon_text * colon * else_text * r_brace) +
+        (P('-') * else_text * r_brace) +
+        (else_text * r_brace)
+      ))
+    ))
+  )) / node(Type.Format),
+})
+
+--- Parses the given input into a snippet tree.
+--- @param input string
+--- @return vim.snippet.Node<vim.snippet.SnippetData>
+function M.parse(input)
+  local snippet = G:match(input)
+  assert(snippet, 'snippet parsing failed')
+  return snippet --- @type vim.snippet.Node<vim.snippet.SnippetData>
+end
+
+return M
-- 
cgit 


From eb1f0e8fcca756a00d287e23bf87554e0e7f6dfd Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sun, 1 Oct 2023 09:54:04 -0700
Subject: feat(lsp)!: replace snippet parser by lpeg grammar

---
 runtime/lua/vim/lsp/_snippet.lua | 500 ---------------------------------------
 runtime/lua/vim/lsp/util.lua     |  35 ++-
 2 files changed, 32 insertions(+), 503 deletions(-)
 delete mode 100644 runtime/lua/vim/lsp/_snippet.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_snippet.lua b/runtime/lua/vim/lsp/_snippet.lua
deleted file mode 100644
index e7ada5415f..0000000000
--- a/runtime/lua/vim/lsp/_snippet.lua
+++ /dev/null
@@ -1,500 +0,0 @@
-local P = {}
-
----Take characters until the target characters (The escape sequence is '\' + char)
----@param targets string[] The character list for stop consuming text.
----@param specials string[] If the character isn't contained in targets/specials, '\' will be left.
-P.take_until = function(targets, specials)
-  targets = targets or {}
-  specials = specials or {}
-
-  return function(input, pos)
-    local new_pos = pos
-    local raw = {}
-    local esc = {}
-    while new_pos <= #input do
-      local c = string.sub(input, new_pos, new_pos)
-      if c == '\\' then
-        table.insert(raw, '\\')
-        new_pos = new_pos + 1
-        c = string.sub(input, new_pos, new_pos)
-        if not vim.list_contains(targets, c) and not vim.list_contains(specials, c) then
-          table.insert(esc, '\\')
-        end
-        table.insert(raw, c)
-        table.insert(esc, c)
-        new_pos = new_pos + 1
-      else
-        if vim.list_contains(targets, c) then
-          break
-        end
-        table.insert(raw, c)
-        table.insert(esc, c)
-        new_pos = new_pos + 1
-      end
-    end
-
-    if new_pos == pos then
-      return P.unmatch(pos)
-    end
-
-    return {
-      parsed = true,
-      value = {
-        raw = table.concat(raw, ''),
-        esc = table.concat(esc, ''),
-      },
-      pos = new_pos,
-    }
-  end
-end
-
-P.unmatch = function(pos)
-  return {
-    parsed = false,
-    value = nil,
-    pos = pos,
-  }
-end
-
-P.map = function(parser, map)
-  return function(input, pos)
-    local result = parser(input, pos)
-    if result.parsed then
-      return {
-        parsed = true,
-        value = map(result.value),
-        pos = result.pos,
-      }
-    end
-    return P.unmatch(pos)
-  end
-end
-
-P.lazy = function(factory)
-  return function(input, pos)
-    return factory()(input, pos)
-  end
-end
-
-P.token = function(token)
-  return function(input, pos)
-    local maybe_token = string.sub(input, pos, pos + #token - 1)
-    if token == maybe_token then
-      return {
-        parsed = true,
-        value = maybe_token,
-        pos = pos + #token,
-      }
-    end
-    return P.unmatch(pos)
-  end
-end
-
-P.pattern = function(p)
-  return function(input, pos)
-    local maybe_match = string.match(string.sub(input, pos), '^' .. p)
-    if maybe_match then
-      return {
-        parsed = true,
-        value = maybe_match,
-        pos = pos + #maybe_match,
-      }
-    end
-    return P.unmatch(pos)
-  end
-end
-
-P.many = function(parser)
-  return function(input, pos)
-    local values = {}
-    local new_pos = pos
-    while new_pos <= #input do
-      local result = parser(input, new_pos)
-      if not result.parsed then
-        break
-      end
-      table.insert(values, result.value)
-      new_pos = result.pos
-    end
-    if #values > 0 then
-      return {
-        parsed = true,
-        value = values,
-        pos = new_pos,
-      }
-    end
-    return P.unmatch(pos)
-  end
-end
-
-P.any = function(...)
-  local parsers = { ... }
-  return function(input, pos)
-    for _, parser in ipairs(parsers) do
-      local result = parser(input, pos)
-      if result.parsed then
-        return result
-      end
-    end
-    return P.unmatch(pos)
-  end
-end
-
-P.opt = function(parser)
-  return function(input, pos)
-    local result = parser(input, pos)
-    return {
-      parsed = true,
-      value = result.value,
-      pos = result.pos,
-    }
-  end
-end
-
-P.seq = function(...)
-  local parsers = { ... }
-  return function(input, pos)
-    local values = {}
-    local new_pos = pos
-    for i, parser in ipairs(parsers) do
-      local result = parser(input, new_pos)
-      if result.parsed then
-        values[i] = result.value
-        new_pos = result.pos
-      else
-        return P.unmatch(pos)
-      end
-    end
-    return {
-      parsed = true,
-      value = values,
-      pos = new_pos,
-    }
-  end
-end
-
-local Node = {}
-
-Node.Type = {
-  SNIPPET = 0,
-  TABSTOP = 1,
-  PLACEHOLDER = 2,
-  VARIABLE = 3,
-  CHOICE = 4,
-  TRANSFORM = 5,
-  FORMAT = 6,
-  TEXT = 7,
-}
-
-function Node:__tostring()
-  local insert_text = {}
-  if self.type == Node.Type.SNIPPET then
-    for _, c in ipairs(self.children) do
-      table.insert(insert_text, tostring(c))
-    end
-  elseif self.type == Node.Type.CHOICE then
-    table.insert(insert_text, self.items[1])
-  elseif self.type == Node.Type.PLACEHOLDER then
-    for _, c in ipairs(self.children or {}) do
-      table.insert(insert_text, tostring(c))
-    end
-  elseif self.type == Node.Type.TEXT then
-    table.insert(insert_text, self.esc)
-  end
-  return table.concat(insert_text, '')
-end
-
---@see https://code.visualstudio.com/docs/editor/userdefinedsnippets#_grammar
-
-local S = {}
-S.dollar = P.token('$')
-S.open = P.token('{')
-S.close = P.token('}')
-S.colon = P.token(':')
-S.slash = P.token('/')
-S.comma = P.token(',')
-S.pipe = P.token('|')
-S.plus = P.token('+')
-S.minus = P.token('-')
-S.question = P.token('?')
-S.int = P.map(P.pattern('[0-9]+'), function(value)
-  return tonumber(value, 10)
-end)
-S.var = P.pattern('[%a_][%w_]+')
-S.text = function(targets, specials)
-  return P.map(P.take_until(targets, specials), function(value)
-    return setmetatable({
-      type = Node.Type.TEXT,
-      raw = value.raw,
-      esc = value.esc,
-    }, Node)
-  end)
-end
-
-S.toplevel = P.lazy(function()
-  return P.any(S.placeholder, S.tabstop, S.variable, S.choice)
-end)
-
-S.format = P.any(
-  P.map(P.seq(S.dollar, S.int), function(values)
-    return setmetatable({
-      type = Node.Type.FORMAT,
-      capture_index = values[2],
-    }, Node)
-  end),
-  P.map(P.seq(S.dollar, S.open, S.int, S.close), function(values)
-    return setmetatable({
-      type = Node.Type.FORMAT,
-      capture_index = values[3],
-    }, Node)
-  end),
-  P.map(
-    P.seq(
-      S.dollar,
-      S.open,
-      S.int,
-      S.colon,
-      S.slash,
-      P.any(
-        P.token('upcase'),
-        P.token('downcase'),
-        P.token('capitalize'),
-        P.token('camelcase'),
-        P.token('pascalcase')
-      ),
-      S.close
-    ),
-    function(values)
-      return setmetatable({
-        type = Node.Type.FORMAT,
-        capture_index = values[3],
-        modifier = values[6],
-      }, Node)
-    end
-  ),
-  P.map(
-    P.seq(
-      S.dollar,
-      S.open,
-      S.int,
-      S.colon,
-      P.seq(
-        S.question,
-        P.opt(P.take_until({ ':' }, { '\\' })),
-        S.colon,
-        P.opt(P.take_until({ '}' }, { '\\' }))
-      ),
-      S.close
-    ),
-    function(values)
-      return setmetatable({
-        type = Node.Type.FORMAT,
-        capture_index = values[3],
-        if_text = values[5][2] and values[5][2].esc or '',
-        else_text = values[5][4] and values[5][4].esc or '',
-      }, Node)
-    end
-  ),
-  P.map(
-    P.seq(
-      S.dollar,
-      S.open,
-      S.int,
-      S.colon,
-      P.seq(S.plus, P.opt(P.take_until({ '}' }, { '\\' }))),
-      S.close
-    ),
-    function(values)
-      return setmetatable({
-        type = Node.Type.FORMAT,
-        capture_index = values[3],
-        if_text = values[5][2] and values[5][2].esc or '',
-        else_text = '',
-      }, Node)
-    end
-  ),
-  P.map(
-    P.seq(
-      S.dollar,
-      S.open,
-      S.int,
-      S.colon,
-      S.minus,
-      P.opt(P.take_until({ '}' }, { '\\' })),
-      S.close
-    ),
-    function(values)
-      return setmetatable({
-        type = Node.Type.FORMAT,
-        capture_index = values[3],
-        if_text = '',
-        else_text = values[6] and values[6].esc or '',
-      }, Node)
-    end
-  ),
-  P.map(
-    P.seq(S.dollar, S.open, S.int, S.colon, P.opt(P.take_until({ '}' }, { '\\' })), S.close),
-    function(values)
-      return setmetatable({
-        type = Node.Type.FORMAT,
-        capture_index = values[3],
-        if_text = '',
-        else_text = values[5] and values[5].esc or '',
-      }, Node)
-    end
-  )
-)
-
-S.transform = P.map(
-  P.seq(
-    S.slash,
-    P.take_until({ '/' }, { '\\' }),
-    S.slash,
-    P.many(P.any(S.format, S.text({ '$', '/' }, { '\\' }))),
-    S.slash,
-    P.opt(P.pattern('[ig]+'))
-  ),
-  function(values)
-    return setmetatable({
-      type = Node.Type.TRANSFORM,
-      pattern = values[2].raw,
-      format = values[4],
-      option = values[6],
-    }, Node)
-  end
-)
-
-S.tabstop = P.any(
-  P.map(P.seq(S.dollar, S.int), function(values)
-    return setmetatable({
-      type = Node.Type.TABSTOP,
-      tabstop = values[2],
-    }, Node)
-  end),
-  P.map(P.seq(S.dollar, S.open, S.int, S.close), function(values)
-    return setmetatable({
-      type = Node.Type.TABSTOP,
-      tabstop = values[3],
-    }, Node)
-  end),
-  P.map(P.seq(S.dollar, S.open, S.int, S.transform, S.close), function(values)
-    return setmetatable({
-      type = Node.Type.TABSTOP,
-      tabstop = values[3],
-      transform = values[4],
-    }, Node)
-  end)
-)
-
-S.placeholder = P.any(
-  P.map(
-    P.seq(
-      S.dollar,
-      S.open,
-      S.int,
-      S.colon,
-      P.opt(P.many(P.any(S.toplevel, S.text({ '$', '}' }, { '\\' })))),
-      S.close
-    ),
-    function(values)
-      return setmetatable({
-        type = Node.Type.PLACEHOLDER,
-        tabstop = values[3],
-        -- insert empty text if opt did not match.
-        children = values[5] or {
-          setmetatable({
-            type = Node.Type.TEXT,
-            raw = '',
-            esc = '',
-          }, Node),
-        },
-      }, Node)
-    end
-  )
-)
-
-S.choice = P.map(
-  P.seq(
-    S.dollar,
-    S.open,
-    S.int,
-    S.pipe,
-    P.many(P.map(P.seq(S.text({ ',', '|' }), P.opt(S.comma)), function(values)
-      return values[1].esc
-    end)),
-    S.pipe,
-    S.close
-  ),
-  function(values)
-    return setmetatable({
-      type = Node.Type.CHOICE,
-      tabstop = values[3],
-      items = values[5],
-    }, Node)
-  end
-)
-
-S.variable = P.any(
-  P.map(P.seq(S.dollar, S.var), function(values)
-    return setmetatable({
-      type = Node.Type.VARIABLE,
-      name = values[2],
-    }, Node)
-  end),
-  P.map(P.seq(S.dollar, S.open, S.var, S.close), function(values)
-    return setmetatable({
-      type = Node.Type.VARIABLE,
-      name = values[3],
-    }, Node)
-  end),
-  P.map(P.seq(S.dollar, S.open, S.var, S.transform, S.close), function(values)
-    return setmetatable({
-      type = Node.Type.VARIABLE,
-      name = values[3],
-      transform = values[4],
-    }, Node)
-  end),
-  P.map(
-    P.seq(
-      S.dollar,
-      S.open,
-      S.var,
-      S.colon,
-      P.many(P.any(S.toplevel, S.text({ '$', '}' }, { '\\' }))),
-      S.close
-    ),
-    function(values)
-      return setmetatable({
-        type = Node.Type.VARIABLE,
-        name = values[3],
-        children = values[5],
-      }, Node)
-    end
-  )
-)
-
-S.snippet = P.map(P.many(P.any(S.toplevel, S.text({ '$' }, { '}', '\\' }))), function(values)
-  return setmetatable({
-    type = Node.Type.SNIPPET,
-    children = values,
-  }, Node)
-end)
-
-local M = {}
-
----The snippet node type enum
----@types table<string, integer>
-M.NodeType = Node.Type
-
----Parse snippet string and returns the AST
----@param input string
----@return table
-function M.parse(input)
-  local result = S.snippet(input, 1)
-  if not result.parsed then
-    error('snippet parsing failed.')
-  end
-  return result.value
-end
-
-return M
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 51ed87219c..a4c8959b99 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1,5 +1,5 @@
 local protocol = require('vim.lsp.protocol')
-local snippet = require('vim.lsp._snippet')
+local snippet = require('vim.lsp._snippet_grammar')
 local validate = vim.validate
 local api = vim.api
 local list_extend = vim.list_extend
@@ -610,12 +610,41 @@ end
 ---@return string parsed snippet
 function M.parse_snippet(input)
   local ok, parsed = pcall(function()
-    return tostring(snippet.parse(input))
+    return snippet.parse(input)
   end)
   if not ok then
     return input
   end
-  return parsed
+
+  --- @param node vim.snippet.Node<any>
+  --- @return string
+  local function node_to_string(node)
+    local insert_text = {}
+    if node.type == snippet.NodeType.Snippet then
+      for _, child in
+        ipairs((node.data --[[@as vim.snippet.SnippetData]]).children)
+      do
+        table.insert(insert_text, node_to_string(child))
+      end
+    elseif node.type == snippet.NodeType.Choice then
+      table.insert(insert_text, (node.data --[[@as vim.snippet.ChoiceData]]).values[1])
+    elseif node.type == snippet.NodeType.Placeholder then
+      table.insert(
+        insert_text,
+        node_to_string((node.data --[[@as vim.snippet.PlaceholderData]]).value)
+      )
+    elseif node.type == snippet.NodeType.Text then
+      table.insert(
+        insert_text,
+        node
+          .data --[[@as vim.snippet.TextData]]
+          .text
+      )
+    end
+    return table.concat(insert_text)
+  end
+
+  return node_to_string(parsed)
 end
 
 --- Sorts by CompletionItem.sortText.
-- 
cgit 


From 19b49b063c28f7d246bf1b452e5ad59a44345c9d Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 3 Oct 2023 06:21:59 +0800
Subject: vim-patch:20f48d5b2ddb

runtime(doc): mention how to disable folding in diff mode (vim/vim#13242)

https://github.com/vim/vim/commit/20f48d5b2ddb9fdc29e83f0da6f31f895eaeab47

Co-authored-by: dundargoc <33953936+dundargoc@users.noreply.github.com>
---
 runtime/lua/vim/_meta/options.lua | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index ed0d844748..08ee1f97ba 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -1591,7 +1591,8 @@ vim.go.dex = vim.go.diffexpr
 --- 			When omitted a context of six lines is used.
 --- 			When using zero the context is actually one,
 --- 			since folds require a line in between, also
---- 			for a deleted line.
+--- 			for a deleted line. Set it to a very large
+--- 			value (999999) to disable folding completely.
 --- 			See `fold-diff`.
 ---
 --- 	iblank		Ignore changes where lines are all blank.  Adds
-- 
cgit 


From e0d669ffdb69582558f594c4b7cdc18634013f48 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 3 Oct 2023 06:24:20 +0800
Subject: vim-patch:cd39b69b0200

runtime(doc): add missing error numbers in the help.  (vim/vim#13241)

closes: vim/vim#13240

https://github.com/vim/vim/commit/cd39b69b0200005622db7291bbacff95bd03a3d0

Co-authored-by: Yegappan Lakshmanan <4298407+yegappan@users.noreply.github.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 86e8781160..55c324d739 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -6099,6 +6099,7 @@ function vim.fn.prevnonblank(lnum) end
 --- using a {n$} positional argument specifier. See |printf-$|.
 ---
 ---
+---             *E1520*
 --- The conversion specifiers and their meanings are:
 ---
 ---     *printf-d* *printf-b* *printf-B* *printf-o* *printf-x* *printf-X*
-- 
cgit 


From 3af59a415c98afc42755308e56912b302ad5eb3d Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 3 Oct 2023 13:07:03 +0800
Subject: fix(treesitter): make Visual hl work consistently with foldtext
 (#25484)

Problem:  Visual highlight is inconsistent on a folded line with
          treesitter foldtext.
Solution: Don't added Folded highlight as it is already in background.
---
 runtime/lua/vim/treesitter/_fold.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_fold.lua b/runtime/lua/vim/treesitter/_fold.lua
index c6a4b48d4f..5c1cc06908 100644
--- a/runtime/lua/vim/treesitter/_fold.lua
+++ b/runtime/lua/vim/treesitter/_fold.lua
@@ -401,7 +401,7 @@ function M.foldtext()
       if start_col > line_pos then
         table.insert(result, {
           line:sub(line_pos + 1, start_col),
-          { { 'Folded', priority } },
+          {},
           range = { line_pos, start_col },
         })
       end
-- 
cgit 


From 29fe883aa9166bdbcae3f935523c75a8aa56fe45 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Wed, 4 Oct 2023 06:31:25 -0700
Subject: feat: ignore swapfile for running Nvim processes #25336

Problem:
The swapfile "E325: ATTENTION" dialog is displayed when editing a file
already open in another (running) Nvim. Usually this behavior is
annoying and irrelevant:
- "Recover" and the other options ("Open readonly", "Quit", "Abort") are
  almost never wanted.
- swapfiles are less relevant for "multi-Nvim" since 'autoread' is
  enabled by default.
  - Even less relevant if user enables 'autowrite'.

Solution:
Define a default SwapExists handler which does the following:
1. If the swapfile is owned by a running Nvim process, automatically
   chooses "(E)dit anyway" (caveat: this creates a new, extra swapfile,
   which is mostly harmless and ignored except by `:recover` or `nvim -r`.
2. Shows a 1-line "ignoring swapfile..." message.
3. Users can disable the default SwapExists handler via `autocmd! nvim_swapfile`.
---
 runtime/lua/vim/_editor.lua     | 17 +++++++++++++++++
 runtime/lua/vim/_meta/vimfn.lua |  4 ++--
 2 files changed, 19 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 7f09fc8038..1ba7d6163d 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -1147,11 +1147,28 @@ function vim._init_default_autocmds()
       end
     end,
   })
+
   vim.api.nvim_create_autocmd({ 'CmdwinEnter' }, {
     pattern = '[:>]',
     group = vim.api.nvim_create_augroup('nvim_cmdwin', {}),
     command = 'syntax sync minlines=1 maxlines=1',
   })
+
+  vim.api.nvim_create_autocmd({ 'SwapExists' }, {
+    pattern = '*',
+    group = vim.api.nvim_create_augroup('nvim_swapfile', {}),
+    callback = function()
+      local info = vim.fn.swapinfo(vim.v.swapname)
+      local user = vim.uv.os_get_passwd().username
+      local iswin = 1 == vim.fn.has('win32')
+      if info.error or info.pid <= 0 or (not iswin and info.user ~= user) then
+        vim.v.swapchoice = '' -- Show the prompt.
+        return
+      end
+      vim.v.swapchoice = 'e' -- Choose "(E)dit".
+      vim.notify(('W325: Ignoring swapfile from Nvim process %d'):format(info.pid))
+    end,
+  })
 end
 
 function vim._init_defaults()
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 55c324d739..5a3a5f3890 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -9312,8 +9312,8 @@ function vim.fn.swapfilelist() end
 ---   user  user name
 ---   host  host name
 ---   fname  original file name
----   pid  PID of the Vim process that created the swap
----     file
+---   pid  PID of the Nvim process that created the swap
+---     file, or zero if not running.
 ---   mtime  last modification time in seconds
 ---   inode  Optional: INODE number of the file
 ---   dirty  1 if file was modified, 0 if not
-- 
cgit 


From 1338140ee3ea9355a9cc756f77b8fc71fd27eda5 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Thu, 5 Oct 2023 14:42:38 +0200
Subject: vim-patch:9.0.1978: No filetype detection for just files

Problem:  No filetype detection for just files
Solution: Detect just files (*.just, justfile, etc)

closes: vim/vim#13271

https://github.com/vim/vim/commit/3d90f71b764e67b1eb12fc6a9a4b9e2fca6dc087

vim-patch:b6d01f13: runtime(just): Correct filetype detection pattern and style

Co-authored-by: dundargoc <gocdundar@gmail.com>
---
 runtime/lua/vim/filetype.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 5ae4e508ef..c412364461 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -565,6 +565,7 @@ local extension = {
   libsonnet = 'jsonnet',
   jsp = 'jsp',
   jl = 'julia',
+  just = 'just',
   kdl = 'kdl',
   kv = 'kivy',
   kix = 'kix',
@@ -1331,6 +1332,7 @@ local filename = {
   ['.jsfmtrc'] = 'jsonc',
   ['.jshintrc'] = 'jsonc',
   ['.swrc'] = 'jsonc',
+  ['.justfile'] = 'just',
   Kconfig = 'kconfig',
   ['Kconfig.debug'] = 'kconfig',
   ['lftp.conf'] = 'lftp',
@@ -1715,6 +1717,7 @@ local pattern = {
   ['org%.eclipse%..*%.prefs'] = 'jproperties',
   ['.*%.properties_.._.._.*'] = starsetf('jproperties'),
   ['[jt]sconfig.*%.json'] = 'jsonc',
+  ['[jJ]ustfile'] = 'just',
   ['Kconfig%..*'] = starsetf('kconfig'),
   ['.*%.[Ss][Uu][Bb]'] = 'krl',
   ['lilo%.conf.*'] = starsetf('lilo'),
-- 
cgit 


From 5db076c7ccfef6732516074252ac4b21b12fc629 Mon Sep 17 00:00:00 2001
From: Aayush Ojha <aayushojha12@gmail.com>
Date: Fri, 6 Oct 2023 05:44:50 -0700
Subject: fix(lua): vim.region on linewise selection #25467

fixes #18155
---
 runtime/lua/vim/_editor.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 1ba7d6163d..bbe93bfbc8 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -548,6 +548,9 @@ function vim.region(bufnr, pos1, pos2, regtype, inclusive)
       else
         c2 = #bufline + 1
       end
+    elseif regtype == 'V' then -- linewise selection, always return whole line
+      c1 = 0
+      c2 = -1
     else
       c1 = (l == pos1[1]) and pos1[2] or 0
       c2 = (l == pos2[1]) and (pos2[2] + (inclusive and 1 or 0)) or -1
-- 
cgit 


From 8bb0878013a4507620201fa5aceb4c18e413bebe Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Fri, 6 Oct 2023 07:21:40 +0800
Subject: vim-patch:9.0.1990: strange error number

Problem:  strange error number
Solution: change error number,
          add doc tag for E1507

closes: vim/vim#13270

https://github.com/vim/vim/commit/ea746f9e862092aef3d4e95c64d116759b9fabe0

Co-authored-by: Christ van Willegen <cvwillegen@gmail.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 7 +++++++
 1 file changed, 7 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 5a3a5f3890..bc81322a76 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -6290,6 +6290,13 @@ function vim.fn.prevnonblank(lnum) end
 --- <  E1505: Invalid format specifier:
 ---   %1$d at width %2$d is: %01$*2$.3$d
 ---
+---           *E1507*
+--- This internal error indicates that the logic to
+--- parse a positional format error ran into a problem
+--- that couldn't be otherwise reported. Please file a
+--- bug against vim if you run into this, copying the
+--- exact format string and parameters that were used.
+---
 --- @param fmt any
 --- @param expr1? any
 --- @return any
-- 
cgit 


From 92df389f1bc1709e56f3eaa0a4e0f3155dd86c97 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sat, 7 Oct 2023 05:52:13 +0800
Subject: vim-patch:27e12c7669e3

runtime(doc): remove E1520 tag (vim/vim#13289)

https://github.com/vim/vim/commit/27e12c7669e36a8f60fefa9db9a08024efeb06e8
---
 runtime/lua/vim/_meta/vimfn.lua | 12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index bc81322a76..06de2fdd1c 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -6098,8 +6098,6 @@ function vim.fn.prevnonblank(lnum) end
 --- precision, the argument(s) to be used must also be specified
 --- using a {n$} positional argument specifier. See |printf-$|.
 ---
----
----             *E1520*
 --- The conversion specifiers and their meanings are:
 ---
 ---     *printf-d* *printf-b* *printf-B* *printf-o* *printf-x* *printf-X*
@@ -6291,11 +6289,11 @@ function vim.fn.prevnonblank(lnum) end
 ---   %1$d at width %2$d is: %01$*2$.3$d
 ---
 ---           *E1507*
---- This internal error indicates that the logic to
---- parse a positional format error ran into a problem
---- that couldn't be otherwise reported. Please file a
---- bug against vim if you run into this, copying the
---- exact format string and parameters that were used.
+--- This internal error indicates that the logic to parse a
+--- positional format argument ran into a problem that couldn't be
+--- otherwise reported.  Please file a bug against Vim if you run
+--- into this, copying the exact format string and parameters that
+--- were used.
 ---
 --- @param fmt any
 --- @param expr1? any
-- 
cgit 


From 9abced6ad95f6300ae80cd8b8aa124ebcf511b50 Mon Sep 17 00:00:00 2001
From: LW <git@llllvvuu.dev>
Date: Sun, 8 Oct 2023 01:09:25 -0700
Subject: fix(lsp): account for border height in max floating popup height
 (#25539)

---
 runtime/lua/vim/lsp/util.lua | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index a4c8959b99..ec0a1b0ab0 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1100,13 +1100,14 @@ function M.make_floating_popup_options(width, height, opts)
     anchor_below = lines_below > lines_above
   end
 
+  local border_height = get_border_size(opts).height
   if anchor_below then
     anchor = anchor .. 'N'
-    height = math.min(lines_below, height)
+    height = math.max(math.min(lines_below - border_height, height), 0)
     row = 1
   else
     anchor = anchor .. 'S'
-    height = math.min(lines_above, height)
+    height = math.max(math.min(lines_above - border_height, height), 0)
     row = 0
   end
 
-- 
cgit 


From c80a3976cb34c2b3c7f6f01e9ad2db41a4f67796 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Mon, 9 Oct 2023 15:34:48 -0700
Subject: docs: miscellaneous doc and type fixes (#25554)

---
 runtime/lua/vim/_meta/api.lua         | 2 +-
 runtime/lua/vim/_meta/api_keysets.lua | 2 +-
 runtime/lua/vim/_meta/options.lua     | 4 ++--
 runtime/lua/vim/_meta/vimfn.lua       | 4 ++--
 4 files changed, 6 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index bdcc68d7cd..5a9b0b53ce 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1,4 +1,4 @@
---- @meta
+--- @meta _
 -- THIS FILE IS GENERATED
 -- DO NOT EDIT
 error('Cannot require a meta file')
diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index ebd164712c..467409505e 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -1,4 +1,4 @@
---- @meta
+--- @meta _
 -- THIS FILE IS GENERATED
 -- DO NOT EDIT
 error('Cannot require a meta file')
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 08ee1f97ba..e90a85ae0a 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -1,4 +1,4 @@
---- @meta
+--- @meta _
 -- THIS FILE IS GENERATED
 -- DO NOT EDIT
 error('Cannot require a meta file')
@@ -2276,7 +2276,7 @@ vim.go.fcl = vim.go.foldclose
 ---     "auto":       resize to the minimum amount of folds to display.
 ---     "auto:[1-9]": resize to accommodate multiple folds up to the
 --- 		  selected level
----     0:            to disable foldcolumn
+---     "0":          to disable foldcolumn
 ---     "[1-9]":      to display a fixed number of columns
 --- See `folding`.
 ---
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 06de2fdd1c..481ffd1831 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -1,4 +1,4 @@
---- @meta
+--- @meta _
 -- THIS FILE IS GENERATED
 -- DO NOT EDIT
 error('Cannot require a meta file')
@@ -8055,7 +8055,7 @@ function vim.fn.shellescape(string, special) end
 --- will be assumed.
 ---
 --- @param col? integer
---- @return any
+--- @return integer
 function vim.fn.shiftwidth(col) end
 
 --- @param name string
-- 
cgit 


From f5eabaa9407ae3d1ccf6592337453c423eff3d9a Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 10 Oct 2023 08:22:32 +0800
Subject: fix(path): restore space separation in 'path' (#25571)

Removing this behavior causes more inconsistencies and bugs.
---
 runtime/lua/vim/_meta/options.lua | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index e90a85ae0a..4f6408b136 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -4621,6 +4621,12 @@ vim.go.pm = vim.go.patchmode
 --- ```
 --- 	:set path=.,/usr/local/include,/usr/include
 --- ```
+--- - Spaces can also be used to separate directory names.  To have a
+---   space in a directory name, precede it with an extra backslash, and
+---   escape the space:
+--- ```
+--- 	:set path=.,/dir/with\\\ space
+--- ```
 --- - To include a comma in a directory name precede it with an extra
 ---   backslash:
 --- ```
-- 
cgit 


From c40a1c0f41ad2557b1e1e1850244eca2d895a07d Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 10 Oct 2023 09:15:21 +0800
Subject: vim-patch:9.0.2009: cmdline-completion for comma-separated options
 wrong (#25569)

Problem:  cmdline-completion for comma-separated options wrong
Solution: Fix command-line expansions for options with filenames with
          commas

Fix command-line expansions for options with filenames with commas

Cmdline expansion for option values that take a comma-separated list
of file names is currently not handling file names with commas as the
commas are not escaped. For such options, the commas in file names need
to be escaped (to differentiate from a comma that delimit the list
items). The escaped comma is unescaped in `copy_option_part()` during
option parsing.

Fix as follows:
- Cmdline completion for option values with comma-separated file/folder
  names will not start a new match when seeing `\\,` and will instead
  consider it as one value.
- File/folder regex matching will strip the `\\` when seeing `\\,` to
  make sure it can match the correct files/folders.
- The expanded value will escape `,` with `\\,`, similar to how spaces
  are escaped to make sure the option value is correct on the cmdline.

This fix also takes into account the fact that Win32 Vim handles file
name escaping differently. Typing '\,' for a file name results in it
being handled literally but in other platforms '\,' is interpreted as a
simple ',' and commas need to be escaped using '\\,' instead.

Also, make sure this new logic only applies to comma-separated options
like 'path'. Non-list options like 'set makeprg=<Tab>' and regular ex
commands like `:edit <Tab>` do not require escaping and will continue to
work.

Also fix up documentation to be clearer. The original docs are slightly
misleading in how it discusses triple slashes for 'tags'.

closes: vim/vim#13303
related: vim/vim#13301

https://github.com/vim/vim/commit/54844857fd6933fa4f6678e47610c4b9c9f7a091

Co-authored-by: Yee Cheng Chin <ychin.git@gmail.com>
---
 runtime/lua/vim/_meta/options.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 4f6408b136..a4e0e61248 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -6877,8 +6877,8 @@ vim.go.tagrelative = vim.o.tagrelative
 vim.go.tr = vim.go.tagrelative
 
 --- Filenames for the tag command, separated by spaces or commas.  To
---- include a space or comma in a file name, precede it with a backslash
---- (see `option-backslash` about including spaces and backslashes).
+--- include a space or comma in a file name, precede it with backslashes
+--- (see `option-backslash` about including spaces/commas and backslashes).
 --- When a file name starts with "./", the '.' is replaced with the path
 --- of the current file.  But only when the 'd' flag is not included in
 --- 'cpoptions'.  Environment variables are expanded `:set_env`.  Also see
-- 
cgit 


From c3d21ad1bccd9a2975be73b1115213fd884eada3 Mon Sep 17 00:00:00 2001
From: dundargoc <gocdundar@gmail.com>
Date: Fri, 15 Sep 2023 09:43:48 +0200
Subject: docs: small fixes

Co-authored-by: Wansmer <wansmer@gmail.com>
Co-authored-by: Andrew Voynov <andrewvoynov.b@gmail.com>
Co-authored-by: David Moberg <david.moberg@mediatek.com>
---
 runtime/lua/vim/treesitter/_meta.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index d01b7be3b0..cd8462bcb7 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -29,6 +29,7 @@
 ---@field sexpr fun(self: TSNode): string
 ---@field equal fun(self: TSNode, other: TSNode): boolean
 ---@field iter_children fun(self: TSNode): fun(): TSNode, string
+---@field field fun(self: TSNode, name: string): TSNode[]
 local TSNode = {}
 
 ---@param query userdata
-- 
cgit 


From 2fde6295df8cdfb36ed02ef5f9a3b6a523b1ac23 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Wed, 11 Oct 2023 13:38:58 -0700
Subject: fix(lsp): display initialization errors (#25409)

---
 runtime/lua/vim/lsp.lua | 33 +++++++++++++++++++++++----------
 1 file changed, 23 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index f68ca7e88c..4b1da94d77 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -189,7 +189,9 @@ lsp.client_errors = tbl_extend(
   'error',
   lsp_rpc.client_errors,
   vim.tbl_add_reverse_lookup({
-    ON_INIT_CALLBACK_ERROR = table.maxn(lsp_rpc.client_errors) + 1,
+    BEFORE_INIT_CALLBACK_ERROR = table.maxn(lsp_rpc.client_errors) + 1,
+    ON_INIT_CALLBACK_ERROR = table.maxn(lsp_rpc.client_errors) + 2,
+    ON_ATTACH_ERROR = table.maxn(lsp_rpc.client_errors) + 3,
   })
 )
 
@@ -1172,6 +1174,16 @@ function lsp.start_client(config)
     return nil, lsp.rpc_response_error(protocol.ErrorCodes.MethodNotFound)
   end
 
+  --- Logs the given error to the LSP log and to the error buffer.
+  --- @param code integer Error code
+  --- @param err any Error arguments
+  local function write_error(code, err)
+    if log.error() then
+      log.error(log_prefix, 'on_error', { code = lsp.client_errors[code], err = err })
+    end
+    err_message(log_prefix, ': Error ', lsp.client_errors[code], ': ', vim.inspect(err))
+  end
+
   ---@private
   --- Invoked when the client operation throws an error.
   ---
@@ -1180,10 +1192,7 @@ function lsp.start_client(config)
   ---@see vim.lsp.rpc.client_errors for possible errors. Use
   ---`vim.lsp.rpc.client_errors[code]` to get a human-friendly name.
   function dispatch.on_error(code, err)
-    if log.error() then
-      log.error(log_prefix, 'on_error', { code = lsp.client_errors[code], err = err })
-    end
-    err_message(log_prefix, ': Error ', lsp.client_errors[code], ': ', vim.inspect(err))
+    write_error(code, err)
     if config.on_error then
       local status, usererr = pcall(config.on_error, code, err)
       if not status then
@@ -1391,8 +1400,10 @@ function lsp.start_client(config)
       trace = valid_traces[config.trace] or 'off',
     }
     if config.before_init then
-      -- TODO(ashkan) handle errors here.
-      pcall(config.before_init, initialize_params, config)
+      local status, err = pcall(config.before_init, initialize_params, config)
+      if not status then
+        write_error(lsp.client_errors.BEFORE_INIT_CALLBACK_ERROR, err)
+      end
     end
 
     --- @param method string
@@ -1440,7 +1451,7 @@ function lsp.start_client(config)
       if config.on_init then
         local status, err = pcall(config.on_init, client, result)
         if not status then
-          pcall(handlers.on_error, lsp.client_errors.ON_INIT_CALLBACK_ERROR, err)
+          write_error(lsp.client_errors.ON_INIT_CALLBACK_ERROR, err)
         end
       end
       local _ = log.info()
@@ -1714,8 +1725,10 @@ function lsp.start_client(config)
     })
 
     if config.on_attach then
-      -- TODO(ashkan) handle errors.
-      pcall(config.on_attach, client, bufnr)
+      local status, err = pcall(config.on_attach, client, bufnr)
+      if not status then
+        write_error(lsp.client_errors.ON_ATTACH_ERROR, err)
+      end
     end
 
     -- schedule the initialization of semantic tokens to give the above
-- 
cgit 


From 7474874baa3ea960fab38b66db36870b797afd5b Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Wed, 11 Oct 2023 22:01:32 +0200
Subject: vim-patch:9.0.2011: INI files not detected

Problem:  INI files not detected
Solution: detect uppercase .INI as dosini files

It previo~1 only worked for lower-case .ini files, but upperc~1 .INI is
also somewhat common on account of DOS' old 8.3 upperc~2 only filena~1.

closes: vim/vim#13316

https://github.com/vim/vim/commit/4a82bdfaa8022402b1ca0f0000c94c47a13f1014

Co-authored-by: Martin Tournoij <martin@arp242.net>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index c412364461..b2fbea5405 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -352,6 +352,7 @@ local extension = {
   bat = 'dosbatch',
   wrap = 'dosini',
   ini = 'dosini',
+  INI = 'dosini',
   vbp = 'dosini',
   dot = 'dot',
   gv = 'dot',
-- 
cgit 


From 840e1864c2de2b4b192a4df1865b69093904b139 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 12 Oct 2023 15:39:39 +0800
Subject: fix(lsp): handle NUL bytes in popup text (#25612)

Fix #25610
---
 runtime/lua/vim/lsp/util.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index ec0a1b0ab0..7e6855528a 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1647,7 +1647,7 @@ function M._make_floating_popup_size(contents, opts)
     width = 0
     for i, line in ipairs(contents) do
       -- TODO(ashkan) use nvim_strdisplaywidth if/when that is introduced.
-      line_widths[i] = vim.fn.strdisplaywidth(line)
+      line_widths[i] = vim.fn.strdisplaywidth(line:gsub('%z', '\n'))
       width = math.max(line_widths[i], width)
     end
   end
@@ -1676,7 +1676,7 @@ function M._make_floating_popup_size(contents, opts)
       height = 0
       if vim.tbl_isempty(line_widths) then
         for _, line in ipairs(contents) do
-          local line_width = vim.fn.strdisplaywidth(line)
+          local line_width = vim.fn.strdisplaywidth(line:gsub('%z', '\n'))
           height = height + math.ceil(line_width / wrap_at)
         end
       else
-- 
cgit 


From ee156ca60ede95c95160cb8dff0197d40cb1a491 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sat, 14 Oct 2023 00:06:40 -0700
Subject: fix(lsp): refactor escaping snippet text (#25611)

---
 runtime/lua/vim/lsp/_snippet_grammar.lua | 48 ++++++++++++++++++++------------
 1 file changed, 30 insertions(+), 18 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_snippet_grammar.lua b/runtime/lua/vim/lsp/_snippet_grammar.lua
index 86f00fea51..eb72efdf39 100644
--- a/runtime/lua/vim/lsp/_snippet_grammar.lua
+++ b/runtime/lua/vim/lsp/_snippet_grammar.lua
@@ -20,11 +20,15 @@ local format_capture = Cg(int / tonumber, 'capture')
 local format_modifier = Cg(P('upcase') + P('downcase') + P('capitalize'), 'modifier')
 local tabstop = Cg(int / tonumber, 'tabstop')
 
+-- These characters are always escapable in text nodes no matter the context.
+local escapable = '$}\\'
+
 --- Returns a function that unescapes occurrences of "special" characters.
 ---
---- @param special string
+--- @param special? string
 --- @return fun(match: string): string
 local function escape_text(special)
+  special = special or escapable
   return function(match)
     local escaped = match:gsub('\\(.)', function(c)
       return special:find(c) and c or '\\' .. c
@@ -33,25 +37,33 @@ local function escape_text(special)
   end
 end
 
--- Text nodes match "any character", but $, \, and } must be escaped.
-local escapable = '$}\\'
-local text = (backslash * S(escapable)) + (P(1) - S(escapable))
-local text_0, text_1 = (text ^ 0) / escape_text(escapable), text ^ 1
+--- Returns a pattern for text nodes. Will match characters in `escape` when preceded by a backslash,
+--- and will stop with characters in `stop_with`.
+---
+--- @param escape string
+--- @param stop_with? string
+--- @return vim.lpeg.Pattern
+local function text(escape, stop_with)
+  stop_with = stop_with or escape
+  return (backslash * S(escape)) + (P(1) - S(stop_with))
+end
+
+-- For text nodes inside curly braces. It stops parsing when reaching an escapable character.
+local braced_text = (text(escapable) ^ 0) / escape_text()
+
 -- Within choice nodes, \ also escapes comma and pipe characters.
-local choice_text = C(((backslash * S(escapable .. ',|')) + (P(1) - S(escapable .. ',|'))) ^ 1)
-  / escape_text(escapable .. ',|')
-local if_text, else_text = Cg(text_0, 'if_text'), Cg(text_0, 'else_text')
+local choice_text = C(text(escapable .. ',|') ^ 1) / escape_text(escapable .. ',|')
+
 -- Within format nodes, make sure we stop at /
-local format_text = C(((backslash * S(escapable)) + (P(1) - S(escapable .. '/'))) ^ 1)
-  / escape_text(escapable)
+local format_text = C(text(escapable, escapable .. '/') ^ 1) / escape_text()
+
+local if_text, else_text = Cg(braced_text, 'if_text'), Cg(braced_text, 'else_text')
+
 -- Within ternary condition format nodes, make sure we stop at :
-local if_till_colon_text = Cg(
-  C(((backslash * S(escapable)) + (P(1) - S(escapable .. ':'))) ^ 1) / escape_text(escapable),
-  'if_text'
-)
+local if_till_colon_text = Cg(C(text(escapable, escapable .. ':') ^ 1) / escape_text(), 'if_text')
 
 -- Matches the string inside //, allowing escaping of the closing slash.
-local regex = Cg(((backslash * slash) + (P(1) - slash)) ^ 1, 'regex')
+local regex = Cg(text('/') ^ 1, 'regex')
 
 -- Regex constructor flags (see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp#parameters).
 local options = Cg(S('dgimsuvy') ^ 0, 'options')
@@ -94,11 +106,11 @@ local G = P({
   snippet = Ct(Cg(
     Ct((
       V('any') +
-      (Ct(Cg(text_1 / escape_text(escapable), 'text')) / node(Type.Text))
+      (Ct(Cg((text(escapable, '$') ^ 1) / escape_text(), 'text')) / node(Type.Text))
     ) ^ 1), 'children'
-  )) / node(Type.Snippet),
-  any_or_text = V('any') + (Ct(Cg(text_0 / escape_text(escapable), 'text')) / node(Type.Text)),
+  ) * -P(1)) / node(Type.Snippet),
   any = V('placeholder') + V('tabstop') + V('choice') + V('variable'),
+  any_or_text = V('any') + (Ct(Cg(braced_text, 'text')) / node(Type.Text)),
   tabstop = Ct(dollar * (tabstop + (l_brace * tabstop * r_brace))) / node(Type.Tabstop),
   placeholder = Ct(dollar * l_brace * tabstop * colon * Cg(V('any_or_text'), 'value') * r_brace) / node(Type.Placeholder),
   choice = Ct(dollar *
-- 
cgit 


From 712adacdf546fbaccd9f2134534889a3f6f36dbc Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sat, 14 Oct 2023 09:47:20 +0200
Subject: refactor(lsp): make is_pull in lsp.diagnostic.get_namespace optional
 (#25156)

Follw up to https://github.com/neovim/neovim/commit/63b3408551561127f7845470eb51404bcd6f547b

`is_pull` should be optional, otherwise it is an API change that
introduces warnings in consumers.

Also fixes the type annotation of `_client_pull_namespaces` where the
key is a string.
---
 runtime/lua/vim/lsp/diagnostic.lua | 41 +++++++++++++++++++-------------------
 1 file changed, 21 insertions(+), 20 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index 73ffa1a46c..73444d8c6a 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -159,44 +159,45 @@ local function diagnostic_vim_to_lsp(diagnostics)
   end, diagnostics)
 end
 
----@type table<integer,integer>
+---@type table<integer, integer>
 local _client_push_namespaces = {}
----@type table<integer,integer>
+
+---@type table<string, integer>
 local _client_pull_namespaces = {}
 
 --- Get the diagnostic namespace associated with an LSP client |vim.diagnostic| for diagnostics
 ---
 ---@param client_id integer The id of the LSP client
----@param is_pull boolean Whether the namespace is for a pull or push client
+---@param is_pull boolean? Whether the namespace is for a pull or push client. Defaults to push
 function M.get_namespace(client_id, is_pull)
   vim.validate({ client_id = { client_id, 'n' } })
 
-  local namespace_table
-  local key
-  local name
   local client = vim.lsp.get_client_by_id(client_id)
-
   if is_pull then
-    namespace_table = _client_pull_namespaces
-    local server_id = vim.tbl_get(client.server_capabilities, 'diagnosticProvider', 'identifier')
-    key = string.format('%d:%s', client_id, server_id or 'nil')
-    name = string.format(
+    local server_id =
+      vim.tbl_get((client or {}).server_capabilities, 'diagnosticProvider', 'identifier')
+    local key = string.format('%d:%s', client_id, server_id or 'nil')
+    local name = string.format(
       'vim.lsp.%s.%d.%s',
       client and client.name or 'unknown',
       client_id,
       server_id or 'nil'
     )
+    local ns = _client_pull_namespaces[key]
+    if not ns then
+      ns = api.nvim_create_namespace(name)
+      _client_pull_namespaces[key] = ns
+    end
+    return ns
   else
-    namespace_table = _client_push_namespaces
-    key = client_id
-    name = string.format('vim.lsp.%s.%d', client and client.name or 'unknown', client_id)
-  end
-
-  if not namespace_table[key] then
-    namespace_table[key] = api.nvim_create_namespace(name)
+    local name = string.format('vim.lsp.%s.%d', client and client.name or 'unknown', client_id)
+    local ns = _client_push_namespaces[client_id]
+    if not ns then
+      ns = api.nvim_create_namespace(name)
+      _client_push_namespaces[client_id] = ns
+    end
+    return ns
   end
-
-  return namespace_table[key]
 end
 
 --- |lsp-handler| for the method "textDocument/publishDiagnostics"
-- 
cgit 


From 57ce9b6a92977fb11269d99be0bb06eab18eda75 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sat, 14 Oct 2023 11:31:16 +0200
Subject: refactor(lsp): fix luals warnings in tagfunc and add type annotations
 (#25150)

---
 runtime/lua/vim/lsp/tagfunc.lua | 35 ++++++++++++++++++++++-------------
 1 file changed, 22 insertions(+), 13 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/tagfunc.lua b/runtime/lua/vim/lsp/tagfunc.lua
index 957449743b..4ad50e4a58 100644
--- a/runtime/lua/vim/lsp/tagfunc.lua
+++ b/runtime/lua/vim/lsp/tagfunc.lua
@@ -2,6 +2,11 @@ local lsp = vim.lsp
 local util = lsp.util
 local ms = lsp.protocol.Methods
 
+---@param name string
+---@param range lsp.Range
+---@param uri string
+---@param offset_encoding string
+---@return {name: string, filename: string, cmd: string, kind?: string}
 local function mk_tag_item(name, range, uri, offset_encoding)
   local bufnr = vim.uri_to_bufnr(uri)
   -- This is get_line_byte_from_position is 0-indexed, call cursor expects a 1-indexed position
@@ -13,6 +18,8 @@ local function mk_tag_item(name, range, uri, offset_encoding)
   }
 end
 
+---@param pattern string
+---@return table[]
 local function query_definition(pattern)
   local params = util.make_position_params()
   local results_by_client, err = lsp.buf_request_sync(0, ms.textDocument_definition, params, 1000)
@@ -23,17 +30,19 @@ local function query_definition(pattern)
   local add = function(range, uri, offset_encoding)
     table.insert(results, mk_tag_item(pattern, range, uri, offset_encoding))
   end
-  for client_id, lsp_results in pairs(results_by_client) do
+  for client_id, lsp_results in pairs(assert(results_by_client)) do
     local client = lsp.get_client_by_id(client_id)
+    local offset_encoding = client and client.offset_encoding or 'utf-16'
     local result = lsp_results.result or {}
     if result.range then -- Location
       add(result.range, result.uri)
-    else -- Location[] or LocationLink[]
+    else
+      result = result --[[@as (lsp.Location[]|lsp.LocationLink[])]]
       for _, item in pairs(result) do
         if item.range then -- Location
-          add(item.range, item.uri, client.offset_encoding)
+          add(item.range, item.uri, offset_encoding)
         else -- LocationLink
-          add(item.targetSelectionRange, item.targetUri, client.offset_encoding)
+          add(item.targetSelectionRange, item.targetUri, offset_encoding)
         end
       end
     end
@@ -41,6 +50,8 @@ local function query_definition(pattern)
   return results
 end
 
+---@param pattern string
+---@return table[]
 local function query_workspace_symbols(pattern)
   local results_by_client, err =
     lsp.buf_request_sync(0, ms.workspace_symbol, { query = pattern }, 1000)
@@ -48,11 +59,13 @@ local function query_workspace_symbols(pattern)
     return {}
   end
   local results = {}
-  for client_id, symbols in pairs(results_by_client) do
+  for client_id, responses in pairs(assert(results_by_client)) do
     local client = lsp.get_client_by_id(client_id)
-    for _, symbol in pairs(symbols.result or {}) do
+    local offset_encoding = client and client.offset_encoding or 'utf-16'
+    local symbols = responses.result --[[@as lsp.SymbolInformation[]|nil]]
+    for _, symbol in pairs(symbols or {}) do
       local loc = symbol.location
-      local item = mk_tag_item(symbol.name, loc.range, loc.uri, client.offset_encoding)
+      local item = mk_tag_item(symbol.name, loc.range, loc.uri, offset_encoding)
       item.kind = lsp.protocol.SymbolKind[symbol.kind] or 'Unknown'
       table.insert(results, item)
     end
@@ -61,12 +74,8 @@ local function query_workspace_symbols(pattern)
 end
 
 local function tagfunc(pattern, flags)
-  local matches
-  if string.match(flags, 'c') then
-    matches = query_definition(pattern)
-  else
-    matches = query_workspace_symbols(pattern)
-  end
+  local matches = string.match(flags, 'c') and query_definition(pattern)
+    or query_workspace_symbols(pattern)
   -- fall back to tags if no matches
   return #matches > 0 and matches or vim.NIL
 end
-- 
cgit 


From bcda800933f6de09392c3c91e290077952989722 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sat, 14 Oct 2023 19:18:25 +0800
Subject: vim-patch:9.0.2022: getmousepos() returns wrong index for TAB char
 (#25636)

Problem:  When clicking in the middle of a TAB, getmousepos() returns
          the column of the next char instead of the TAB.
Solution: Break out of the loop when the vcol to find is inside current
          char. Fix invalid memory access when calling virtcol2col() on
          an empty line.

closes: vim/vim#13321

https://github.com/vim/vim/commit/b583eda7031b1f6a3469a2537d0c10ca5fa5568e
---
 runtime/lua/vim/_meta/vimfn.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 481ffd1831..a2d9ce5bc4 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -10099,6 +10099,8 @@ function vim.fn.virtcol(expr, list, winid) end
 --- character in window {winid} at buffer line {lnum} and virtual
 --- column {col}.
 ---
+--- If buffer line {lnum} is an empty line, 0 is returned.
+---
 --- If {col} is greater than the last virtual column in line
 --- {lnum}, then the byte index of the character at the last
 --- virtual column is returned.
-- 
cgit 


From 20dacacf374d93d9bef45626d5851265d1075841 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sat, 14 Oct 2023 19:28:41 +0800
Subject: vim-patch:2bbd0d30eebd (#25637)

runtime(doc): Improve command-line completion docs (vim/vim#13331)

* Improve command-line completion docs

Add more details about 'ignorecase' and its effect on cmdline
completion.

Make sure keys used in wildmenu are properly documented and linked in the
keys' documentation entries, and in `:h index` for proper
cross-referencing, as wildmenu popup is slightly different from
insert-mode popup menu.

* Fix docs typos

https://github.com/vim/vim/commit/2bbd0d30eebdea66c0da3895e83d999ed6ad83fb

Co-authored-by: Yee Cheng Chin <ychin.git@gmail.com>
---
 runtime/lua/vim/_meta/options.lua | 21 ++++++++++++---------
 1 file changed, 12 insertions(+), 9 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index a4e0e61248..3d4f911f96 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -3087,8 +3087,8 @@ vim.go.icon = vim.o.icon
 vim.o.iconstring = ""
 vim.go.iconstring = vim.o.iconstring
 
---- Ignore case in search patterns, completion, and when searching the tags file.
---- See also 'smartcase' and 'tagcase'.
+--- Ignore case in search patterns, `cmdline-completion`, when
+--- searching in the tags file, and `expr-==`.
 --- Can be overruled by using "\c" or "\C" in the pattern, see
 --- `/ignorecase`.
 ---
@@ -7539,18 +7539,21 @@ vim.go.wic = vim.go.wildignorecase
 --- a completion.
 ---
 --- While the menu is active these keys have special meanings:
----
---- CTRL-Y		- accept the currently selected match and stop
---- 		  completion.
---- CTRL-E		- end completion, go back to what was there before
---- 		  selecting a match.
+--- CTRL-P		- go to the previous entry
+--- CTRL-N		- go to the next entry
 --- <Left> <Right>	- select previous/next match (like CTRL-P/CTRL-N)
+--- <PageUp>	- select a match several entries back
+--- <PageDown>	- select a match several entries further
+--- <Up>		- in filename/menu name completion: move up into
+--- 		  parent directory or parent menu.
 --- <Down>		- in filename/menu name completion: move into a
 --- 		  subdirectory or submenu.
 --- <CR>		- in menu completion, when the cursor is just after a
 --- 		  dot: move into a submenu.
---- <Up>		- in filename/menu name completion: move up into
---- 		  parent directory or parent menu.
+--- CTRL-E		- end completion, go back to what was there before
+--- 		  selecting a match.
+--- CTRL-Y		- accept the currently selected match and stop
+--- 		  completion.
 ---
 --- If you want <Left> and <Right> to move the cursor instead of selecting
 --- a different match, use this:
-- 
cgit 


From 729a9c4c61c13db80d42e6d875893b4a79ef4381 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 14 Oct 2023 16:04:57 +0200
Subject: vim-patch:9.0.2024: no filetype detection for Debian sources

Problem:  no filetype detection for Debian sources
Solution: Add new deb822sources filetype

closes: vim/vim#13320

https://github.com/vim/vim/commit/bd734c3bead9e167eb6875f62cc06fab2379c422

Co-authored-by: James McCoy <jamessan@jamessan.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index b2fbea5405..2058a4dcba 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1629,6 +1629,7 @@ local pattern = {
   ['.*/debian/copyright'] = 'debcopyright',
   ['.*/etc/apt/sources%.list%.d/.*%.list'] = 'debsources',
   ['.*/etc/apt/sources%.list'] = 'debsources',
+  ['.*/etc/apt/sources%.list%.d/.*%.sources'] = 'deb822sources',
   ['.*%.directory'] = 'desktop',
   ['.*%.desktop'] = 'desktop',
   ['dictd.*%.conf'] = 'dictdconf',
-- 
cgit 


From aa62579a684277d86b1f4a7588464e0ec4227b94 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sun, 15 Oct 2023 09:05:27 +0800
Subject: docs: restore accidentally removed line in :h 'ignorecase' (#25651)

---
 runtime/lua/vim/_meta/options.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 3d4f911f96..c0c4d7f8be 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -3089,6 +3089,7 @@ vim.go.iconstring = vim.o.iconstring
 
 --- Ignore case in search patterns, `cmdline-completion`, when
 --- searching in the tags file, and `expr-==`.
+--- Also see 'smartcase' and 'tagcase'.
 --- Can be overruled by using "\c" or "\C" in the pattern, see
 --- `/ignorecase`.
 ---
-- 
cgit 


From e5a424d78ed72613dd5ccc161578f9f6f853a0e8 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sun, 15 Oct 2023 17:02:17 +0800
Subject: vim-patch:9.0.2030: no max callback recursion limit (#25655)

Problem:  no max callback recursion limit
Solution: bail out, if max call recursion for callback functions
          has been reached.

This checks the 'maxfuncdepth' setting and throws E169 when a callback
function recursively calls itself.

closes: vim/vim#13337
closes: vim/vim#13339

https://github.com/vim/vim/commit/47510f3d6598a1218958c03ed11337a43b73f48d

Co-authored-by: Christian Brabandt <cb@256bit.org>
---
 runtime/lua/vim/_meta/options.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index c0c4d7f8be..50146bac50 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -4035,6 +4035,7 @@ vim.go.mat = vim.go.matchtime
 --- Increasing this limit above 200 also changes the maximum for Ex
 --- command recursion, see `E169`.
 --- See also `:function`.
+--- Also used for maximum depth of callback functions.
 ---
 --- @type integer
 vim.o.maxfuncdepth = 100
-- 
cgit 


From d974a3dcbb3757ebeb78fa64054c795ab7acdf1a Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sun, 15 Oct 2023 17:19:01 +0800
Subject: vim-patch:9.0.2032: cannot get mouse click pos for tab or virt text
 (#25653)

Problem:  Cannot accurately get mouse clicking position when clicking on
          a TAB or with virtual text.
Solution: Add a "coladd" field to getmousepos() result.

closes: vim/vim#13335

https://github.com/vim/vim/commit/f5a94d5165bb9e390797da50a1fa7a87df3fbee4
---
 runtime/lua/vim/_meta/vimfn.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index a2d9ce5bc4..2b79feec8e 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -3242,6 +3242,8 @@ function vim.fn.getmatches(win) end
 ---   wincol    column inside "winid"
 ---   line    text line inside "winid"
 ---   column    text column inside "winid"
+---   coladd    offset (in screen columns) from the
+---       start of the clicked char
 --- All numbers are 1-based.
 ---
 --- If not over a window, e.g. when in the command line, then only
-- 
cgit 


From c46a6c065e8d830adb8a2f410d3c92cf5bd4455b Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Mon, 16 Oct 2023 08:13:37 -0700
Subject: docs: do not hardcode LSP version in URL #25648

---
 runtime/lua/vim/lsp/_snippet_grammar.lua | 2 +-
 runtime/lua/vim/lsp/buf.lua              | 2 +-
 runtime/lua/vim/lsp/handlers.lua         | 2 +-
 runtime/lua/vim/lsp/sync.lua             | 2 +-
 runtime/lua/vim/lsp/util.lua             | 2 +-
 5 files changed, 5 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_snippet_grammar.lua b/runtime/lua/vim/lsp/_snippet_grammar.lua
index eb72efdf39..0a4d669fb9 100644
--- a/runtime/lua/vim/lsp/_snippet_grammar.lua
+++ b/runtime/lua/vim/lsp/_snippet_grammar.lua
@@ -1,4 +1,4 @@
---- Grammar for LSP snippets, based on https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#snippet_syntax
+--- Grammar for LSP snippets, based on https://microsoft.github.io/language-server-protocol/specification/#snippet_syntax
 
 local lpeg = vim.lpeg
 local P, S, R, V = lpeg.P, lpeg.S, lpeg.R, lpeg.V
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index a906512e24..9436fbbf56 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -159,7 +159,7 @@ end
 ---     - formatting_options (table|nil):
 ---         Can be used to specify FormattingOptions. Some unspecified options will be
 ---         automatically derived from the current Nvim options.
----         See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#formattingOptions
+---         See https://microsoft.github.io/language-server-protocol/specification/#formattingOptions
 ---     - timeout_ms (integer|nil, default 1000):
 ---         Time in milliseconds to block for formatting requests. No effect if async=true
 ---     - bufnr (number|nil):
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index d43d9a7cfa..d3b199b866 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -623,7 +623,7 @@ M[ms.window_showDocument] = function(_, result, ctx, _)
   return { success = success or false }
 end
 
----@see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#workspace_inlayHint_refresh
+---@see https://microsoft.github.io/language-server-protocol/specification/#workspace_inlayHint_refresh
 M[ms.workspace_inlayHint_refresh] = function(err, result, ctx, config)
   return require('vim.lsp.inlay_hint').on_refresh(err, result, ctx, config)
 end
diff --git a/runtime/lua/vim/lsp/sync.lua b/runtime/lua/vim/lsp/sync.lua
index 9c1bbf3892..ca01cdc08b 100644
--- a/runtime/lua/vim/lsp/sync.lua
+++ b/runtime/lua/vim/lsp/sync.lua
@@ -387,7 +387,7 @@ end
 ---@param lastline integer line to begin search in old_lines for last difference
 ---@param new_lastline integer line to begin search in new_lines for last difference
 ---@param offset_encoding string encoding requested by language server
----@return table TextDocumentContentChangeEvent see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentContentChangeEvent
+---@return table TextDocumentContentChangeEvent see https://microsoft.github.io/language-server-protocol/specification/#textDocumentContentChangeEvent
 function M.compute_diff(
   prev_lines,
   curr_lines,
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 7e6855528a..d525cae4c0 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -1829,7 +1829,7 @@ do --[[ References ]]
   ---@param bufnr integer Buffer id
   ---@param references table List of `DocumentHighlight` objects to highlight
   ---@param offset_encoding string One of "utf-8", "utf-16", "utf-32".
-  ---@see https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#textDocumentContentChangeEvent
+  ---@see https://microsoft.github.io/language-server-protocol/specification/#textDocumentContentChangeEvent
   function M.buf_highlight_references(bufnr, references, offset_encoding)
     validate({
       bufnr = { bufnr, 'n', true },
-- 
cgit 


From 2eecb1b85dbb0e02ec40e95d28d3cc4720040f01 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Mon, 16 Oct 2023 08:52:48 -0700
Subject: fix(lsp): highlight active parameter in signature help #25663

Fixes #25662
---
 runtime/lua/vim/lsp/handlers.lua | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index d3b199b866..d153b956ee 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -476,7 +476,7 @@ function M.signature_help(_, result, ctx, config)
     vim.tbl_get(client.server_capabilities, 'signatureHelpProvider', 'triggerCharacters')
   local ft = vim.bo[ctx.bufnr].filetype
   local lines, hl = util.convert_signature_help_to_markdown_lines(result, ft, triggers)
-  if vim.tbl_isempty(lines) then
+  if not lines or vim.tbl_isempty(lines) then
     if config.silent ~= true then
       print('No signature help available')
     end
@@ -484,7 +484,9 @@ function M.signature_help(_, result, ctx, config)
   end
   local fbuf, fwin = util.open_floating_preview(lines, 'markdown', config)
   if hl then
-    api.nvim_buf_add_highlight(fbuf, -1, 'LspSignatureActiveParameter', 0, unpack(hl))
+    -- Highlight the second line if the signature is wrapped in a Markdown code block.
+    local line = vim.startswith(lines[1], '```') and 1 or 0
+    api.nvim_buf_add_highlight(fbuf, -1, 'LspSignatureActiveParameter', line, unpack(hl))
   end
   return fbuf, fwin
 end
-- 
cgit 


From 35f475d0a51aad03abfc005a0224d315c45ffd67 Mon Sep 17 00:00:00 2001
From: Jaehwang Jung <tomtomjhj@gmail.com>
Date: Tue, 17 Oct 2023 10:51:36 +0900
Subject: fix(diagnostics): if buffer not loaded, skip handlers that set
 extmark (#25628)

Problem:
When enabling diagnostics, there can be diagnostics for unloaded buffer,
but some handlers nevertheless attempt to set extmarks in such buffers.

Solution:
* Exit underline/virtual_text handler if buffer is not loaded.
* Don't require is_loaded as precondition for show(), because handlers
  don't necessarily depend on it.
---
 runtime/lua/vim/diagnostic.lua | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index b8d3906b7f..9e9b09ed1d 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -652,16 +652,14 @@ function M.config(opts, namespace)
 
   if namespace then
     for bufnr, v in pairs(diagnostic_cache) do
-      if api.nvim_buf_is_loaded(bufnr) and v[namespace] then
+      if v[namespace] then
         M.show(namespace, bufnr)
       end
     end
   else
     for bufnr, v in pairs(diagnostic_cache) do
-      if api.nvim_buf_is_loaded(bufnr) then
-        for ns in pairs(v) do
-          M.show(ns, bufnr)
-        end
+      for ns in pairs(v) do
+        M.show(ns, bufnr)
       end
     end
   end
@@ -693,9 +691,7 @@ function M.set(namespace, bufnr, diagnostics, opts)
     set_diagnostic_cache(namespace, bufnr, diagnostics)
   end
 
-  if api.nvim_buf_is_loaded(bufnr) then
-    M.show(namespace, bufnr, nil, opts)
-  end
+  M.show(namespace, bufnr, nil, opts)
 
   api.nvim_exec_autocmds('DiagnosticChanged', {
     modeline = false,
@@ -928,6 +924,10 @@ M.handlers.underline = {
     bufnr = get_bufnr(bufnr)
     opts = opts or {}
 
+    if not vim.api.nvim_buf_is_loaded(bufnr) then
+      return
+    end
+
     if opts.underline and opts.underline.severity then
       diagnostics = filter_by_severity(opts.underline.severity, diagnostics)
     end
@@ -994,6 +994,10 @@ M.handlers.virtual_text = {
     bufnr = get_bufnr(bufnr)
     opts = opts or {}
 
+    if not vim.api.nvim_buf_is_loaded(bufnr) then
+      return
+    end
+
     local severity
     if opts.virtual_text then
       if opts.virtual_text.format then
-- 
cgit 


From 272ef271153b0f66410b0e59ce31e05d211b44fd Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 17 Oct 2023 22:43:42 +0800
Subject: vim-patch:9.0.2035: [security] use-after-free with wildmenu (#25687)

Problem:  [security] use-after-free with wildmenu
Solution: properly clean up the wildmenu when exiting

Fix wildchar/wildmenu/pum memory corruption with special wildchar's

Currently, using `wildchar=<Esc>` or `wildchar=<C-\>` can lead to a
memory corruption if using wildmenu+pum, or wrong states if only using
wildmenu. This is due to the code only using one single place inside the
cmdline process loop to perform wild menu clean up (by checking
`end_wildmenu`) but there are other odd situations where the loop could
have exited and we need a post-loop clean up just to be sure. If the
clean up was not done you would have a stale popup menu referring to
invalid memory, or if not using popup menu, incorrect status line (if
`laststatus=0`).

For example, if you hit `<Esc>` two times when it's wildchar, there's a
hard-coded behavior to exit command-line as a failsafe for user, and if
you hit `<C-\><C-\><C-N>` it will also exit command-line, but the clean
up code would not have hit because of specialized `<C-\>` handling.

Fix Ctrl-E / Ctrl-Y to not cancel/accept wildmenu if they are also
used for 'wildchar'/'wildcharm'. Currently they don't behave properly,
and also have potentially memory unsafe behavior as the logic is
currently not accounting for this situation and try to do both.
(Previous patch that addressed this: vim/vim#11677)

Also, correctly document Escape key behavior (double-hit it to escape)
in wildchar docs as it's previously undocumented.

In addition, block known invalid chars to be set in `wildchar` option,
such as Ctrl-C and `<CR>`. This is just to make it clear to the user
they shouldn't be set, and is not required for this bug fix.

closes: vim/vim#13361

https://github.com/vim/vim/commit/8f4fb007e4d472b09ff6bed9ffa485e0c3093699

Co-authored-by: Yee Cheng Chin <ychin.git@gmail.com>
---
 runtime/lua/vim/_meta/options.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 50146bac50..cc013112b3 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -7466,6 +7466,8 @@ vim.go.ww = vim.go.whichwrap
 --- The character is not recognized when used inside a macro.  See
 --- 'wildcharm' for that.
 --- Some keys will not work, such as CTRL-C, <CR> and Enter.
+--- <Esc> can be used, but hitting it twice in a row will still exit
+--- command-line as a failsafe measure.
 --- Although 'wc' is a number option, you can set it to a special key:
 --- ```
 --- 	:set wc=<Tab>
-- 
cgit 


From 3fd7449d5abe9a75fed8fb6b68c5958bd1a9ee12 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Tue, 17 Oct 2023 13:34:39 -0700
Subject: fix(treesitter): check that buf is loaded in autocommands (#25679)

---
 runtime/lua/vim/treesitter/dev.lua | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index db30d638af..d9f0a21106 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -366,6 +366,10 @@ function M.inspect_tree(opts)
     group = group,
     buffer = b,
     callback = function()
+      if not api.nvim_buf_is_loaded(buf) then
+        return true
+      end
+
       api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
       local row = api.nvim_win_get_cursor(w)[1]
       local pos = pg:get(row)
@@ -438,6 +442,9 @@ function M.inspect_tree(opts)
     group = group,
     buffer = b,
     callback = function()
+      if not api.nvim_buf_is_loaded(buf) then
+        return true
+      end
       api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
     end,
   })
@@ -449,7 +456,6 @@ function M.inspect_tree(opts)
       if not api.nvim_buf_is_loaded(b) then
         return true
       end
-
       api.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
     end,
   })
-- 
cgit 


From bc5dfda441dd1b3de56bd64059b0a1df4075f050 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Wed, 18 Oct 2023 06:08:14 +0800
Subject: vim-patch:9.0.2041: trim(): hard to use default mask (#25692)

Problem:  trim(): hard to use default mask (partly revert v9.0.2040)
Solution: use default mask when it is empty

The default 'mask' value is pretty complex, as it includes many
characters.  Yet, if one needs to specify the trimming direction, the
third argument, 'trim()' currently requires the 'mask' value to be
provided explicitly.

Currently, an empty 'mask' will make 'trim()' call return 'text' value
that is passed in unmodified.  It is unlikely that someone is using it,
so the chances of scripts being broken by this change are low.

Also, this reverts commit 9.0.2040 (which uses v:none for the default
and requires to use an empty string instead).

closes: vim/vim#13358

https://github.com/vim/vim/commit/8079917447e7436dccc2e4cd4a4a56ae0a4712f2

vim-patch:9.0.2040: trim(): hard to use default mask

Problem:  trim(): hard to use default mask
Solution: Use default 'mask' when it is v:none

The default 'mask' value is pretty complex, as it includes many
characters.  Yet, if one needs to specify the trimming direction, the
third argument, 'trim()' currently requires the 'mask' value to be
provided explicitly.

'v:none' is already used to mean "use the default argument value" in
user defined functions.  See |none-function_argument| in help.

closes: vim/vim#13363

https://github.com/vim/vim/commit/6e6386716f9494ae86027c6d34f657fd03dfec42

Co-authored-by: Illia Bobyr <illia.bobyr@gmail.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 2b79feec8e..2c594e049f 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -9845,15 +9845,18 @@ function vim.fn.tr(src, fromstr, tostr) end
 
 --- Return {text} as a String where any character in {mask} is
 --- removed from the beginning and/or end of {text}.
---- If {mask} is not given, {mask} is all characters up to 0x20,
---- which includes Tab, space, NL and CR, plus the non-breaking
---- space character 0xa0.
+---
+--- If {mask} is not given, or is an empty string, {mask} is all
+--- characters up to 0x20, which includes Tab, space, NL and CR,
+--- plus the non-breaking space character 0xa0.
+---
 --- The optional {dir} argument specifies where to remove the
 --- characters:
 ---   0  remove from the beginning and end of {text}
 ---   1  remove only at the beginning of {text}
 ---   2  remove only at the end of {text}
 --- When omitted both ends are trimmed.
+---
 --- This function deals with multibyte characters properly.
 --- Returns an empty string on error.
 ---
-- 
cgit 


From ae7020c667b5314fe832d2a8897fb16d57194bdf Mon Sep 17 00:00:00 2001
From: Pham Huy Hoang <hoangtun0810@gmail.com>
Date: Fri, 6 Oct 2023 16:27:10 +0900
Subject: fix(docs): fix TSNode incorrect signatures

---
 runtime/lua/vim/treesitter/_meta.lua | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index cd8462bcb7..e6dcbc7a62 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -14,10 +14,10 @@
 ---@field extra fun(self: TSNode): boolean
 ---@field child_count fun(self: TSNode): integer
 ---@field named_child_count fun(self: TSNode): integer
----@field child fun(self: TSNode, integer): TSNode?
----@field named_child fun(self: TSNode, integer): TSNode?
----@field descendant_for_range fun(self: TSNode, integer, integer, integer, integer): TSNode?
----@field named_descendant_for_range fun(self: TSNode, integer, integer, integer, integer): TSNode?
+---@field child fun(self: TSNode, index: integer): TSNode?
+---@field named_child fun(self: TSNode, index: integer): TSNode?
+---@field descendant_for_range fun(self: TSNode, start_row: integer, start_col: integer, end_row: integer, end_col: integer): TSNode?
+---@field named_descendant_for_range fun(self: TSNode, start_row: integer, start_col: integer, end_row: integer, end_col: integer): TSNode?
 ---@field parent fun(self: TSNode): TSNode?
 ---@field next_sibling fun(self: TSNode): TSNode?
 ---@field prev_sibling fun(self: TSNode): TSNode?
-- 
cgit 


From 315c711700a87fe3fa546906ab39557ebba19baf Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Wed, 18 Oct 2023 21:18:24 -0700
Subject: fix(treesitter): set cursor position when opening inspector

---
 runtime/lua/vim/treesitter/dev.lua | 64 ++++++++++++++++++++++++--------------
 1 file changed, 40 insertions(+), 24 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index d9f0a21106..39c03cd1a5 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -181,6 +181,42 @@ local function set_dev_properties(w, b)
   vim.bo[b].filetype = 'query'
 end
 
+--- Updates the cursor position in the inspector to match the node under the cursor.
+---
+--- @param pg TSTreeView
+--- @param lang string
+--- @param source_buf integer
+--- @param inspect_buf integer
+--- @param inspect_win integer
+--- @param pos? { [1]: integer, [2]: integer }
+local function set_inspector_cursor(pg, lang, source_buf, inspect_buf, inspect_win, pos)
+  api.nvim_buf_clear_namespace(inspect_buf, pg.ns, 0, -1)
+
+  local cursor_node = vim.treesitter.get_node({
+    bufnr = source_buf,
+    lang = lang,
+    pos = pos,
+    ignore_injections = false,
+  })
+  if not cursor_node then
+    return
+  end
+
+  local cursor_node_id = cursor_node:id()
+  for i, v in pg:iter() do
+    if v.id == cursor_node_id then
+      local start = v.depth
+      local end_col = start + #v.text
+      api.nvim_buf_set_extmark(inspect_buf, pg.ns, i - 1, start, {
+        end_col = end_col,
+        hl_group = 'Visual',
+      })
+      api.nvim_win_set_cursor(inspect_win, { i, 0 })
+      break
+    end
+  end
+end
+
 --- Write the contents of this View into {bufnr}.
 ---
 ---@param bufnr integer Buffer number to write into.
@@ -307,6 +343,9 @@ function M.inspect_tree(opts)
 
   pg:draw(b)
 
+  local cursor = api.nvim_win_get_cursor(win)
+  set_inspector_cursor(pg, opts.lang, buf, b, w, { cursor[1] - 1, cursor[2] })
+
   api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
   api.nvim_buf_set_keymap(b, 'n', '<CR>', '', {
     desc = 'Jump to the node under the cursor in the source buffer',
@@ -398,30 +437,7 @@ function M.inspect_tree(opts)
         return true
       end
 
-      api.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
-
-      local cursor_node = vim.treesitter.get_node({
-        bufnr = buf,
-        lang = opts.lang,
-        ignore_injections = false,
-      })
-      if not cursor_node then
-        return
-      end
-
-      local cursor_node_id = cursor_node:id()
-      for i, v in pg:iter() do
-        if v.id == cursor_node_id then
-          local start = v.depth
-          local end_col = start + #v.text
-          api.nvim_buf_set_extmark(b, pg.ns, i - 1, start, {
-            end_col = end_col,
-            hl_group = 'Visual',
-          })
-          api.nvim_win_set_cursor(w, { i, 0 })
-          break
-        end
-      end
+      set_inspector_cursor(pg, opts.lang, buf, b, w)
     end,
   })
 
-- 
cgit 


From e6d352d8d7d8a987d0bd9b2e13bfd395e1127c3e Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Thu, 19 Oct 2023 10:20:12 -0500
Subject: vim-patch:e08bfef88bd0

runtime(zig): Update Zig runtime files (vim/vim#13388)

Update runtime files from upstream (https://github.com/zig/zig.vim) at
commit 54c216e5306a5c3878a60596aacb94dca8652ab9.

https://github.com/vim/vim/commit/e08bfef88bd05a9d27ee16c57cd10173e280f600

Co-authored-by: Gregory Anders <8965202+gpanders@users.noreply.github.com>
---
 runtime/lua/vim/filetype.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 2058a4dcba..6dbfd7e64d 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1119,7 +1119,7 @@ local extension = {
   yuck = 'yuck',
   z8a = 'z8a',
   zig = 'zig',
-  zir = 'zir',
+  zon = 'zig',
   zu = 'zimbu',
   zut = 'zimbutempl',
   zs = 'zserio',
-- 
cgit 


From 330444994616e48e5e4d15bbf72d7c5346943565 Mon Sep 17 00:00:00 2001
From: Jorge Mederos <46798594+jmederosalvarado@users.noreply.github.com>
Date: Sat, 21 Oct 2023 08:47:14 +0200
Subject: fix(lsp): log unknown diagnostic tags instead of showing a warning
 (#25705)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

To be more in line with the specification:

> To support the evolution of enumerations the using side of an enumeration shouldn’t fail on an enumeration value it doesn’t know. It should simply ignore it as a value it can use and try to do its best to preserve the value on round trips
---
 runtime/lua/vim/lsp/diagnostic.lua | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index 73444d8c6a..b6f0cfa0b3 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -2,6 +2,7 @@
 
 local util = require('vim.lsp.util')
 local protocol = require('vim.lsp.protocol')
+local log = require('vim.lsp.log')
 local ms = protocol.Methods
 
 local api = vim.api
@@ -88,10 +89,7 @@ local function tags_lsp_to_vim(diagnostic, client_id)
       tags = tags or {}
       tags.deprecated = true
     else
-      vim.notify_once(
-        string.format('Unknown DiagnosticTag %d from LSP client %d', tag, client_id),
-        vim.log.levels.WARN
-      )
+      log.info(string.format('Unknown DiagnosticTag %d from LSP client %d', tag, client_id))
     end
   end
   return tags
-- 
cgit 


From f1775da07fe48da629468bcfcc2a8a6c4c3f40ed Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Fri, 20 Oct 2023 23:51:26 -0700
Subject: feat(lsp): add snippet API (#25301)

---
 runtime/lua/vim/_editor.lua              |   1 +
 runtime/lua/vim/_meta.lua                |   1 +
 runtime/lua/vim/lsp/_snippet_grammar.lua |  34 +-
 runtime/lua/vim/lsp/protocol.lua         |   1 -
 runtime/lua/vim/lsp/util.lua             |  30 +-
 runtime/lua/vim/snippet.lua              | 535 +++++++++++++++++++++++++++++++
 6 files changed, 568 insertions(+), 34 deletions(-)
 create mode 100644 runtime/lua/vim/snippet.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index bbe93bfbc8..e0c7de87b3 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -38,6 +38,7 @@ for k, v in pairs({
   ui = true,
   health = true,
   secure = true,
+  snippet = true,
   _watch = true,
 }) do
   vim._submodules[k] = v
diff --git a/runtime/lua/vim/_meta.lua b/runtime/lua/vim/_meta.lua
index ddd0a0eb49..e3b99f6b3d 100644
--- a/runtime/lua/vim/_meta.lua
+++ b/runtime/lua/vim/_meta.lua
@@ -19,6 +19,7 @@ vim.loader = require('vim.loader')
 vim.lsp = require('vim.lsp')
 vim.re = require('vim.re')
 vim.secure = require('vim.secure')
+vim.snippet = require('vim.snippet')
 vim.treesitter = require('vim.treesitter')
 vim.ui = require('vim.ui')
 vim.version = require('vim.version')
diff --git a/runtime/lua/vim/lsp/_snippet_grammar.lua b/runtime/lua/vim/lsp/_snippet_grammar.lua
index 0a4d669fb9..9318fefcbc 100644
--- a/runtime/lua/vim/lsp/_snippet_grammar.lua
+++ b/runtime/lua/vim/lsp/_snippet_grammar.lua
@@ -81,14 +81,40 @@ local Type = {
 M.NodeType = Type
 
 --- @class vim.snippet.Node<T>: { type: vim.snippet.Type, data: T }
---- @class vim.snippet.TabstopData: { tabstop: number }
+--- @class vim.snippet.TabstopData: { tabstop: integer }
 --- @class vim.snippet.TextData: { text: string }
---- @class vim.snippet.PlaceholderData: { tabstop: vim.snippet.TabstopData, value: vim.snippet.Node<any> }
---- @class vim.snippet.ChoiceData: { tabstop: vim.snippet.TabstopData, values: string[] }
+--- @class vim.snippet.PlaceholderData: { tabstop: integer, value: vim.snippet.Node<any> }
+--- @class vim.snippet.ChoiceData: { tabstop: integer, values: string[] }
 --- @class vim.snippet.VariableData: { name: string, default?: vim.snippet.Node<any>, regex?: string, format?: vim.snippet.Node<vim.snippet.FormatData|vim.snippet.TextData>[], options?: string }
 --- @class vim.snippet.FormatData: { capture: number, modifier?: string, if_text?: string, else_text?: string }
 --- @class vim.snippet.SnippetData: { children: vim.snippet.Node<any>[] }
 
+--- @type vim.snippet.Node<any>
+local Node = {}
+
+--- @return string
+--- @diagnostic disable-next-line: inject-field
+function Node:__tostring()
+  local node_text = {}
+  local type, data = self.type, self.data
+  if type == Type.Snippet then
+    --- @cast data vim.snippet.SnippetData
+    for _, child in ipairs(data.children) do
+      table.insert(node_text, tostring(child))
+    end
+  elseif type == Type.Choice then
+    --- @cast data vim.snippet.ChoiceData
+    table.insert(node_text, data.values[1])
+  elseif type == Type.Placeholder then
+    --- @cast data vim.snippet.PlaceholderData
+    table.insert(node_text, tostring(data.value))
+  elseif type == Type.Text then
+    --- @cast data vim.snippet.TextData
+    table.insert(node_text, data.text)
+  end
+  return table.concat(node_text)
+end
+
 --- Returns a function that constructs a snippet node of the given type.
 ---
 --- @generic T
@@ -96,7 +122,7 @@ M.NodeType = Type
 --- @return fun(data: T): vim.snippet.Node<T>
 local function node(type)
   return function(data)
-    return { type = type, data = data }
+    return setmetatable({ type = type, data = data }, Node)
   end
 end
 
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 0755fa991f..3a1b16c450 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -742,7 +742,6 @@ function protocol.make_client_capabilities()
           -- this should be disabled out of the box.
           -- However, users can turn this back on if they have a snippet plugin.
           snippetSupport = false,
-
           commitCharactersSupport = false,
           preselectSupport = false,
           deprecatedSupport = false,
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index d525cae4c0..42c1508cbf 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -616,35 +616,7 @@ function M.parse_snippet(input)
     return input
   end
 
-  --- @param node vim.snippet.Node<any>
-  --- @return string
-  local function node_to_string(node)
-    local insert_text = {}
-    if node.type == snippet.NodeType.Snippet then
-      for _, child in
-        ipairs((node.data --[[@as vim.snippet.SnippetData]]).children)
-      do
-        table.insert(insert_text, node_to_string(child))
-      end
-    elseif node.type == snippet.NodeType.Choice then
-      table.insert(insert_text, (node.data --[[@as vim.snippet.ChoiceData]]).values[1])
-    elseif node.type == snippet.NodeType.Placeholder then
-      table.insert(
-        insert_text,
-        node_to_string((node.data --[[@as vim.snippet.PlaceholderData]]).value)
-      )
-    elseif node.type == snippet.NodeType.Text then
-      table.insert(
-        insert_text,
-        node
-          .data --[[@as vim.snippet.TextData]]
-          .text
-      )
-    end
-    return table.concat(insert_text)
-  end
-
-  return node_to_string(parsed)
+  return tostring(parsed)
 end
 
 --- Sorts by CompletionItem.sortText.
diff --git a/runtime/lua/vim/snippet.lua b/runtime/lua/vim/snippet.lua
new file mode 100644
index 0000000000..3d739bd3af
--- /dev/null
+++ b/runtime/lua/vim/snippet.lua
@@ -0,0 +1,535 @@
+local G = require('vim.lsp._snippet_grammar')
+local snippet_group = vim.api.nvim_create_augroup('vim/snippet', {})
+local snippet_ns = vim.api.nvim_create_namespace('vim/snippet')
+
+--- Returns the 0-based cursor position.
+---
+--- @return integer, integer
+local function cursor_pos()
+  local cursor = vim.api.nvim_win_get_cursor(0)
+  return cursor[1] - 1, cursor[2]
+end
+
+--- Resolves variables (like `$name` or `${name:default}`) as follows:
+--- - When a variable is unknown (i.e.: its name is not recognized in any of the cases below), return `nil`.
+--- - When a variable isn't set, return its default (if any) or an empty string.
+---
+--- Note that in some cases, the default is ignored since it's not clear how to distinguish an empty
+--- value from an unset value (e.g.: `TM_CURRENT_LINE`).
+---
+--- @param var string
+--- @param default string
+--- @return string?
+local function resolve_variable(var, default)
+  --- @param str string
+  --- @return string
+  local function expand_or_default(str)
+    local expansion = vim.fn.expand(str) --[[@as string]]
+    return expansion == '' and default or expansion
+  end
+
+  if var == 'TM_SELECTED_TEXT' then
+    -- Snippets are expanded in insert mode only, so there's no selection.
+    return default
+  elseif var == 'TM_CURRENT_LINE' then
+    return vim.api.nvim_get_current_line()
+  elseif var == 'TM_CURRENT_WORD' then
+    return expand_or_default('<cword>')
+  elseif var == 'TM_LINE_INDEX' then
+    return tostring(vim.fn.line('.') - 1)
+  elseif var == 'TM_LINE_NUMBER' then
+    return tostring(vim.fn.line('.'))
+  elseif var == 'TM_FILENAME' then
+    return expand_or_default('%:t')
+  elseif var == 'TM_FILENAME_BASE' then
+    -- Not using '%:t:r' since we want to remove all extensions.
+    local filename_base = expand_or_default('%:t'):gsub('%.[^%.]*$', '')
+    return filename_base
+  elseif var == 'TM_DIRECTORY' then
+    return expand_or_default('%:p:h:t')
+  elseif var == 'TM_FILEPATH' then
+    return expand_or_default('%:p')
+  end
+
+  -- Unknown variable.
+  return nil
+end
+
+--- Transforms the given text into an array of lines (so no line contains `\n`).
+---
+--- @param text string|string[]
+--- @return string[]
+local function text_to_lines(text)
+  text = type(text) == 'string' and { text } or text
+  --- @cast text string[]
+  return vim.split(table.concat(text), '\n', { plain = true })
+end
+
+--- Computes the 0-based position of a tabstop located at the end of `snippet` and spanning
+--- `placeholder` (if given).
+---
+--- @param snippet string[]
+--- @param placeholder string?
+--- @return Range4
+local function compute_tabstop_range(snippet, placeholder)
+  local cursor_row, cursor_col = cursor_pos()
+  local snippet_text = text_to_lines(snippet)
+  local placeholder_text = text_to_lines(placeholder or '')
+  local start_row = cursor_row + #snippet_text - 1
+  local start_col = #(snippet_text[#snippet_text] or '')
+
+  -- Add the cursor's column offset to the first line.
+  if start_row == cursor_row then
+    start_col = start_col + cursor_col
+  end
+
+  local end_row = start_row + #placeholder_text - 1
+  local end_col = (start_row == end_row and start_col or 0)
+    + #(placeholder_text[#placeholder_text] or '')
+
+  return { start_row, start_col, end_row, end_col }
+end
+
+--- @class vim.snippet.Tabstop
+--- @field extmark_id integer
+--- @field index integer
+--- @field bufnr integer
+local Tabstop = {}
+
+--- Creates a new tabstop.
+---
+--- @package
+--- @param index integer
+--- @param bufnr integer
+--- @param range Range4
+--- @return vim.snippet.Tabstop
+function Tabstop.new(index, bufnr, range)
+  local extmark_id = vim.api.nvim_buf_set_extmark(bufnr, snippet_ns, range[1], range[2], {
+    right_gravity = false,
+    end_right_gravity = true,
+    end_line = range[3],
+    end_col = range[4],
+    hl_group = 'SnippetTabstop',
+  })
+
+  local self = setmetatable(
+    { index = index, bufnr = bufnr, extmark_id = extmark_id },
+    { __index = Tabstop }
+  )
+
+  return self
+end
+
+--- Returns the tabstop's range.
+---
+--- @package
+--- @return Range4
+function Tabstop:get_range()
+  local mark =
+    vim.api.nvim_buf_get_extmark_by_id(self.bufnr, snippet_ns, self.extmark_id, { details = true })
+
+  --- @diagnostic disable-next-line: undefined-field
+  return { mark[1], mark[2], mark[3].end_row, mark[3].end_col }
+end
+
+--- Returns the text spanned by the tabstop.
+---
+--- @package
+--- @return string
+function Tabstop:get_text()
+  local range = self:get_range()
+  return table.concat(
+    vim.api.nvim_buf_get_text(self.bufnr, range[1], range[2], range[3], range[4], {}),
+    '\n'
+  )
+end
+
+--- Sets the tabstop's text.
+---
+--- @package
+--- @param text string
+function Tabstop:set_text(text)
+  local range = self:get_range()
+  vim.api.nvim_buf_set_text(self.bufnr, range[1], range[2], range[3], range[4], text_to_lines(text))
+end
+
+--- @class vim.snippet.Session
+--- @field bufnr integer
+--- @field tabstops table<integer, vim.snippet.Tabstop[]>
+--- @field current_tabstop vim.snippet.Tabstop
+local Session = {}
+
+--- Creates a new snippet session in the current buffer.
+---
+--- @package
+--- @return vim.snippet.Session
+function Session.new()
+  local bufnr = vim.api.nvim_get_current_buf()
+  local self = setmetatable({
+    bufnr = bufnr,
+    tabstops = {},
+    current_tabstop = Tabstop.new(0, bufnr, { 0, 0, 0, 0 }),
+  }, { __index = Session })
+
+  return self
+end
+
+--- Creates the session tabstops.
+---
+--- @package
+--- @param tabstop_ranges table<integer, Range4[]>
+function Session:set_tabstops(tabstop_ranges)
+  for index, ranges in pairs(tabstop_ranges) do
+    for _, range in ipairs(ranges) do
+      self.tabstops[index] = self.tabstops[index] or {}
+      table.insert(self.tabstops[index], Tabstop.new(index, self.bufnr, range))
+    end
+  end
+end
+
+--- Returns the destination tabstop index when jumping in the given direction.
+---
+--- @package
+--- @param direction vim.snippet.Direction
+--- @return integer?
+function Session:get_dest_index(direction)
+  local tabstop_indexes = vim.tbl_keys(self.tabstops) --- @type integer[]
+  table.sort(tabstop_indexes)
+  for i, index in ipairs(tabstop_indexes) do
+    if index == self.current_tabstop.index then
+      local dest_index = tabstop_indexes[i + direction] --- @type integer?
+      -- When jumping forwards, $0 is the last tabstop.
+      if not dest_index and direction == 1 then
+        dest_index = 0
+      end
+      -- When jumping backwards, make sure we don't think that $0 is the first tabstop.
+      if dest_index == 0 and direction == -1 then
+        dest_index = nil
+      end
+      return dest_index
+    end
+  end
+end
+
+--- @class vim.snippet.Snippet
+--- @field private _session? vim.snippet.Session
+local M = { session = nil }
+
+--- Select the given tabstop range.
+---
+--- @param tabstop vim.snippet.Tabstop
+local function select_tabstop(tabstop)
+  --- @param keys string
+  local function feedkeys(keys)
+    keys = vim.api.nvim_replace_termcodes(keys, true, false, true)
+    vim.api.nvim_feedkeys(keys, 'n', true)
+  end
+
+  --- NOTE: We don't use `vim.api.nvim_win_set_cursor` here because it causes the cursor to end
+  --- at the end of the selection instead of the start.
+  ---
+  --- @param row integer
+  --- @param col integer
+  local function move_cursor_to(row, col)
+    local line = vim.fn.getline(row) --[[ @as string ]]
+    col = math.max(vim.fn.strchars(line:sub(1, col)) - 1, 0)
+    feedkeys(string.format('%sG0%s', row, string.rep('<Right>', col)))
+  end
+
+  local range = tabstop:get_range()
+  local mode = vim.fn.mode()
+
+  -- Move the cursor to the start of the tabstop.
+  vim.api.nvim_win_set_cursor(0, { range[1] + 1, range[2] })
+
+  -- For empty and the final tabstop, start insert mode at the end of the range.
+  if tabstop.index == 0 or (range[1] == range[3] and range[2] == range[4]) then
+    if mode ~= 'i' then
+      if mode == 's' then
+        feedkeys('<Esc>')
+      end
+      vim.cmd.startinsert({ bang = range[4] >= #vim.api.nvim_get_current_line() })
+    end
+  else
+    -- Else, select the tabstop's text.
+    if mode ~= 'n' then
+      feedkeys('<Esc>')
+    end
+    move_cursor_to(range[1] + 1, range[2] + 1)
+    feedkeys('v')
+    move_cursor_to(range[3] + 1, range[4])
+    feedkeys('o<c-g>')
+  end
+end
+
+--- Sets up the necessary autocommands for snippet expansion.
+---
+--- @param bufnr integer
+local function setup_autocmds(bufnr)
+  vim.api.nvim_create_autocmd({ 'CursorMoved', 'CursorMovedI' }, {
+    group = snippet_group,
+    desc = 'Update snippet state when the cursor moves',
+    buffer = bufnr,
+    callback = function()
+      -- Just update the tabstop in insert and select modes.
+      if not vim.fn.mode():match('^[isS]') then
+        return
+      end
+
+      -- Update the current tabstop to be the one containing the cursor.
+      local cursor_row, cursor_col = cursor_pos()
+      for tabstop_index, tabstops in pairs(M._session.tabstops) do
+        for _, tabstop in ipairs(tabstops) do
+          local range = tabstop:get_range()
+          if
+            (cursor_row > range[1] or (cursor_row == range[1] and cursor_col >= range[2]))
+            and (cursor_row < range[3] or (cursor_row == range[3] and cursor_col <= range[4]))
+          then
+            M._session.current_tabstop = tabstop
+            if tabstop_index ~= 0 then
+              return
+            end
+          end
+        end
+      end
+
+      -- The cursor is either not on a tabstop or we reached the end, so exit the session.
+      M.exit()
+      return true
+    end,
+  })
+
+  vim.api.nvim_create_autocmd({ 'TextChanged', 'TextChangedI' }, {
+    group = snippet_group,
+    desc = 'Update active tabstops when buffer text changes',
+    buffer = bufnr,
+    callback = function()
+      if not M.active() then
+        return true
+      end
+
+      -- Sync the tabstops in the current group.
+      local current_tabstop = M._session.current_tabstop
+      local current_text = current_tabstop:get_text()
+      for _, tabstop in ipairs(M._session.tabstops[current_tabstop.index]) do
+        if tabstop.extmark_id ~= current_tabstop.extmark_id then
+          tabstop:set_text(current_text)
+        end
+      end
+    end,
+  })
+end
+
+--- Expands the given snippet text.
+--- Refer to https://microsoft.github.io/language-server-protocol/specification/#snippet_syntax
+--- for the specification of valid input.
+---
+--- Tabstops are highlighted with hl-SnippetTabstop.
+---
+--- @param input string
+function M.expand(input)
+  local snippet = G.parse(input)
+  local snippet_text = {}
+
+  M._session = Session.new()
+
+  -- Get the placeholders we should use for each tabstop index.
+  --- @type table<integer, string>
+  local placeholders = {}
+  for _, child in ipairs(snippet.data.children) do
+    local type, data = child.type, child.data
+    if type == G.NodeType.Placeholder then
+      --- @cast data vim.snippet.PlaceholderData
+      local tabstop, value = data.tabstop, tostring(data.value)
+      if placeholders[tabstop] and placeholders[tabstop] ~= value then
+        error('Snippet has multiple placeholders for tabstop $' .. tabstop)
+      end
+      placeholders[tabstop] = value
+    end
+  end
+
+  -- Keep track of tabstop nodes during expansion.
+  --- @type table<integer, Range4[]>
+  local tabstop_ranges = {}
+
+  --- @param index integer
+  --- @param placeholder string?
+  local function add_tabstop(index, placeholder)
+    tabstop_ranges[index] = tabstop_ranges[index] or {}
+    table.insert(tabstop_ranges[index], compute_tabstop_range(snippet_text, placeholder))
+  end
+
+  --- Appends the given text to the snippet, taking care of indentation.
+  ---
+  --- @param text string|string[]
+  local function append_to_snippet(text)
+    -- Get the base indentation based on the current line and the last line of the snippet.
+    local base_indent = vim.api.nvim_get_current_line():match('^%s*') or ''
+    if #snippet_text > 0 then
+      base_indent = base_indent .. (snippet_text[#snippet_text]:match('^%s*') or '') --- @type string
+    end
+
+    local lines = vim.iter.map(function(i, line)
+      -- Replace tabs by spaces.
+      if vim.o.expandtab then
+        line = line:gsub('\t', (' '):rep(vim.fn.shiftwidth())) --- @type string
+      end
+      -- Add the base indentation.
+      if i > 1 then
+        line = base_indent .. line
+      end
+      return line
+    end, ipairs(text_to_lines(text)))
+
+    table.insert(snippet_text, table.concat(lines, '\n'))
+  end
+
+  for _, child in ipairs(snippet.data.children) do
+    local type, data = child.type, child.data
+    if type == G.NodeType.Tabstop then
+      --- @cast data vim.snippet.TabstopData
+      local placeholder = placeholders[data.tabstop]
+      add_tabstop(data.tabstop, placeholder)
+      if placeholder then
+        append_to_snippet(placeholder)
+      end
+    elseif type == G.NodeType.Placeholder then
+      --- @cast data vim.snippet.PlaceholderData
+      local value = placeholders[data.tabstop]
+      add_tabstop(data.tabstop, value)
+      append_to_snippet(value)
+    elseif type == G.NodeType.Choice then
+      --- @cast data vim.snippet.ChoiceData
+      append_to_snippet(data.values[1])
+    elseif type == G.NodeType.Variable then
+      --- @cast data vim.snippet.VariableData
+      -- Try to get the variable's value.
+      local value = resolve_variable(data.name, data.default and tostring(data.default) or '')
+      if not value then
+        -- Unknown variable, make this a tabstop and use the variable name as a placeholder.
+        value = data.name
+        local tabstop_indexes = vim.tbl_keys(tabstop_ranges)
+        local index = math.max(unpack((#tabstop_indexes == 0 and { 0 }) or tabstop_indexes)) + 1
+        add_tabstop(index, value)
+      end
+      append_to_snippet(value)
+    elseif type == G.NodeType.Text then
+      --- @cast data vim.snippet.TextData
+      append_to_snippet(data.text)
+    end
+  end
+
+  -- $0, which defaults to the end of the snippet, defines the final cursor position.
+  -- Make sure the snippet has exactly one of these.
+  if vim.tbl_contains(vim.tbl_keys(tabstop_ranges), 0) then
+    assert(#tabstop_ranges[0] == 1, 'Snippet has multiple $0 tabstops')
+  else
+    add_tabstop(0)
+  end
+
+  -- Insert the snippet text.
+  local cursor_row, cursor_col = cursor_pos()
+  vim.api.nvim_buf_set_text(
+    M._session.bufnr,
+    cursor_row,
+    cursor_col,
+    cursor_row,
+    cursor_col,
+    text_to_lines(snippet_text)
+  )
+
+  -- Create the tabstops.
+  M._session:set_tabstops(tabstop_ranges)
+
+  -- Jump to the first tabstop.
+  M.jump(1)
+end
+
+--- @alias vim.snippet.Direction -1 | 1
+
+--- Returns `true` if there is an active snippet which can be jumped in the given direction.
+--- You can use this function to navigate a snippet as follows:
+---
+--- ```lua
+--- vim.keymap.set({ 'i', 's' }, '<Tab>', function()
+---    if vim.snippet.jumpable(1) then
+---      return '<cmd>lua vim.snippet.jump(1)<cr>'
+---    else
+---      return '<Tab>'
+---    end
+---  end, { expr = true })
+--- ```
+---
+--- @param direction (vim.snippet.Direction) Navigation direction. -1 for previous, 1 for next.
+--- @return boolean
+function M.jumpable(direction)
+  if not M.active() then
+    return false
+  end
+
+  return M._session:get_dest_index(direction) ~= nil
+end
+
+--- Jumps within the active snippet in the given direction.
+--- If the jump isn't possible, the function call does nothing.
+---
+--- You can use this function to navigate a snippet as follows:
+---
+--- ```lua
+--- vim.keymap.set({ 'i', 's' }, '<Tab>', function()
+---    if vim.snippet.jumpable(1) then
+---      return '<cmd>lua vim.snippet.jump(1)<cr>'
+---    else
+---      return '<Tab>'
+---    end
+---  end, { expr = true })
+--- ```
+---
+--- @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)
+  if not dest_index then
+    return
+  end
+
+  -- Find the tabstop with the lowest range.
+  local tabstops = M._session.tabstops[dest_index]
+  local dest = tabstops[1]
+  for _, tabstop in ipairs(tabstops) do
+    local dest_range, range = dest:get_range(), tabstop:get_range()
+    if (range[1] < dest_range[1]) or (range[1] == dest_range[1] and range[2] < dest_range[2]) then
+      dest = tabstop
+    end
+  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 })
+
+  M._session.current_tabstop = dest
+  select_tabstop(dest)
+
+  -- Restore the autocommands.
+  setup_autocmds(M._session.bufnr)
+end
+
+--- Returns `true` if there's an active snippet in the current buffer.
+---
+--- @return boolean
+function M.active()
+  return M._session ~= nil and M._session.bufnr == vim.api.nvim_get_current_buf()
+end
+
+--- Exits the current snippet.
+function M.exit()
+  if not M.active() then
+    return
+  end
+
+  vim.api.nvim_clear_autocmds({ group = snippet_group, buffer = M._session.bufnr })
+  vim.api.nvim_buf_clear_namespace(M._session.bufnr, snippet_ns, 0, -1)
+
+  M._session = nil
+end
+
+return M
-- 
cgit 


From 1e10310f4cc70cf95a68457c2be9e7459b5bbba6 Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Sat, 21 Oct 2023 09:47:24 +0200
Subject: refactor(lsp): move completion logic into _completion module

To reduce cross-chatter between modules and for https://github.com/neovim/neovim/issues/25272
Also preparing for https://github.com/neovim/neovim/issues/25714
---
 runtime/lua/vim/lsp.lua             |  95 +---------------
 runtime/lua/vim/lsp/_completion.lua | 210 ++++++++++++++++++++++++++++++++++++
 runtime/lua/vim/lsp/protocol.lua    |   1 +
 runtime/lua/vim/lsp/util.lua        |  93 +---------------
 4 files changed, 215 insertions(+), 184 deletions(-)
 create mode 100644 runtime/lua/vim/lsp/_completion.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 4b1da94d77..82a88772bd 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -2273,24 +2273,6 @@ function lsp.buf_notify(bufnr, method, params)
   return resp
 end
 
----@private
-local function adjust_start_col(lnum, line, items, encoding)
-  local min_start_char = nil
-  for _, item in pairs(items) do
-    if item.textEdit and item.textEdit.range.start.line == lnum - 1 then
-      if min_start_char and min_start_char ~= item.textEdit.range.start.character then
-        return nil
-      end
-      min_start_char = item.textEdit.range.start.character
-    end
-  end
-  if min_start_char then
-    return util._str_byteindex_enc(line, min_start_char, encoding)
-  else
-    return nil
-  end
-end
-
 --- Implements 'omnifunc' compatible LSP completion.
 ---
 ---@see |complete-functions|
@@ -2307,82 +2289,7 @@ function lsp.omnifunc(findstart, base)
   if log.debug() then
     log.debug('omnifunc.findstart', { findstart = findstart, base = base })
   end
-
-  local bufnr = resolve_bufnr()
-  local clients = lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_completion })
-  local remaining = #clients
-  if remaining == 0 then
-    return findstart == 1 and -1 or {}
-  end
-
-  -- Then, perform standard completion request
-  if log.info() then
-    log.info('base ', base)
-  end
-
-  local win = api.nvim_get_current_win()
-  local pos = api.nvim_win_get_cursor(win)
-  local line = api.nvim_get_current_line()
-  local line_to_cursor = line:sub(1, pos[2])
-  local _ = log.trace() and log.trace('omnifunc.line', pos, line)
-
-  -- Get the start position of the current keyword
-  local match_pos = vim.fn.match(line_to_cursor, '\\k*$') + 1
-  local items = {}
-
-  local startbyte
-
-  local function on_done()
-    local mode = api.nvim_get_mode()['mode']
-    if mode == 'i' or mode == 'ic' then
-      vim.fn.complete(startbyte or match_pos, items)
-    end
-  end
-
-  for _, client in ipairs(clients) do
-    local params = util.make_position_params(win, client.offset_encoding)
-    client.request(ms.textDocument_completion, params, function(err, result)
-      if err then
-        log.warn(err.message)
-      end
-      if result and vim.fn.mode() == 'i' then
-        -- Completion response items may be relative to a position different than `textMatch`.
-        -- Concrete example, with sumneko/lua-language-server:
-        --
-        -- require('plenary.asy|
-        --         ▲       ▲   ▲
-        --         │       │   └── cursor_pos: 20
-        --         │       └────── textMatch: 17
-        --         └────────────── textEdit.range.start.character: 9
-        --                                 .newText = 'plenary.async'
-        --                  ^^^
-        --                  prefix (We'd remove everything not starting with `asy`,
-        --                  so we'd eliminate the `plenary.async` result
-        --
-        -- `adjust_start_col` is used to prefer the language server boundary.
-        --
-        local encoding = client.offset_encoding
-        local candidates = util.extract_completion_items(result)
-        local curstartbyte = adjust_start_col(pos[1], line, candidates, encoding)
-        if startbyte == nil then
-          startbyte = curstartbyte
-        elseif curstartbyte ~= nil and curstartbyte ~= startbyte then
-          startbyte = match_pos
-        end
-        local prefix = startbyte and line:sub(startbyte + 1) or line_to_cursor:sub(match_pos)
-        local matches = util.text_document_completion_list_to_complete_items(result, prefix)
-        vim.list_extend(items, matches)
-      end
-      remaining = remaining - 1
-      if remaining == 0 then
-        vim.schedule(on_done)
-      end
-    end, bufnr)
-  end
-
-  -- Return -2 to signal that we should continue completion so that we can
-  -- async complete.
-  return -2
+  return require('vim.lsp._completion').omnifunc(findstart, base)
 end
 
 --- Provides an interface between the built-in client and a `formatexpr` function.
diff --git a/runtime/lua/vim/lsp/_completion.lua b/runtime/lua/vim/lsp/_completion.lua
new file mode 100644
index 0000000000..efd1aaacf7
--- /dev/null
+++ b/runtime/lua/vim/lsp/_completion.lua
@@ -0,0 +1,210 @@
+local M = {}
+local api = vim.api
+local lsp = vim.lsp
+local protocol = lsp.protocol
+local ms = protocol.Methods
+
+---@param input string unparsed snippet
+---@return string parsed snippet
+local function parse_snippet(input)
+  local ok, parsed = pcall(function()
+    return require('vim.lsp._snippet_grammar').parse(input)
+  end)
+  return ok and tostring(parsed) or input
+end
+
+--- Returns text that should be inserted when selecting completion item. The
+--- precedence is as follows: textEdit.newText > insertText > label
+---
+--- See https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_completion
+---
+---@param item lsp.CompletionItem
+---@return string
+local function get_completion_word(item)
+  if item.textEdit ~= nil and item.textEdit.newText ~= nil and item.textEdit.newText ~= '' then
+    if item.insertTextFormat == protocol.InsertTextFormat.PlainText then
+      return item.textEdit.newText
+    else
+      return parse_snippet(item.textEdit.newText)
+    end
+  elseif item.insertText ~= nil and item.insertText ~= '' then
+    if item.insertTextFormat == protocol.InsertTextFormat.PlainText then
+      return item.insertText
+    else
+      return parse_snippet(item.insertText)
+    end
+  end
+  return item.label
+end
+
+---@param result lsp.CompletionList|lsp.CompletionItem[]
+---@return lsp.CompletionItem[]
+local function get_items(result)
+  if result.items then
+    return result.items
+  end
+  return result
+end
+
+--- Turns the result of a `textDocument/completion` request into vim-compatible
+--- |complete-items|.
+---
+---@param result lsp.CompletionList|lsp.CompletionItem[] Result of `textDocument/completion`
+---@param prefix string prefix to filter the completion items
+---@return table[]
+---@see complete-items
+function M._lsp_to_complete_items(result, prefix)
+  local items = get_items(result)
+  if vim.tbl_isempty(items) then
+    return {}
+  end
+
+  local function matches_prefix(item)
+    return vim.startswith(get_completion_word(item), prefix)
+  end
+
+  items = vim.tbl_filter(matches_prefix, items) --[[@as lsp.CompletionItem[]|]]
+  table.sort(items, function(a, b)
+    return (a.sortText or a.label) < (b.sortText or b.label)
+  end)
+
+  local matches = {}
+  for _, item in ipairs(items) do
+    local info = ''
+    local documentation = item.documentation
+    if documentation then
+      if type(documentation) == 'string' and documentation ~= '' then
+        info = documentation
+      elseif type(documentation) == 'table' and type(documentation.value) == 'string' then
+        info = documentation.value
+      else
+        vim.notify(
+          ('invalid documentation value %s'):format(vim.inspect(documentation)),
+          vim.log.levels.WARN
+        )
+      end
+    end
+    local word = get_completion_word(item)
+    table.insert(matches, {
+      word = word,
+      abbr = item.label,
+      kind = protocol.CompletionItemKind[item.kind] or 'Unknown',
+      menu = item.detail or '',
+      info = #info > 0 and info or nil,
+      icase = 1,
+      dup = 1,
+      empty = 1,
+      user_data = {
+        nvim = {
+          lsp = {
+            completion_item = item,
+          },
+        },
+      },
+    })
+  end
+  return matches
+end
+
+---@param items lsp.CompletionItem[]
+local function adjust_start_col(lnum, line, items, encoding)
+  local min_start_char = nil
+  for _, item in pairs(items) do
+    if item.textEdit and item.textEdit.range.start.line == lnum - 1 then
+      if min_start_char and min_start_char ~= item.textEdit.range.start.character then
+        return nil
+      end
+      min_start_char = item.textEdit.range.start.character
+    end
+  end
+  if min_start_char then
+    return vim.lsp.util._str_byteindex_enc(line, min_start_char, encoding)
+  else
+    return nil
+  end
+end
+
+---@param findstart integer 0 or 1, decides behavior
+---@param base integer findstart=0, text to match against
+---@return integer|table Decided by {findstart}:
+--- - findstart=0: column where the completion starts, or -2 or -3
+--- - findstart=1: list of matches (actually just calls |complete()|)
+function M.omnifunc(findstart, base)
+  local bufnr = api.nvim_get_current_buf()
+  local clients = lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_completion })
+  local remaining = #clients
+  if remaining == 0 then
+    return findstart == 1 and -1 or {}
+  end
+
+  local log = require('vim.lsp.log')
+  -- Then, perform standard completion request
+  if log.info() then
+    log.info('base ', base)
+  end
+
+  local win = api.nvim_get_current_win()
+  local pos = api.nvim_win_get_cursor(win)
+  local line = api.nvim_get_current_line()
+  local line_to_cursor = line:sub(1, pos[2])
+  log.trace('omnifunc.line', pos, line)
+
+  local word_boundary = vim.fn.match(line_to_cursor, '\\k*$') + 1 --[[@as integer]]
+  local items = {}
+  local startbyte = nil
+
+  local function on_done()
+    local mode = api.nvim_get_mode()['mode']
+    if mode == 'i' or mode == 'ic' then
+      vim.fn.complete(startbyte or word_boundary, items)
+    end
+  end
+
+  local util = vim.lsp.util
+  for _, client in ipairs(clients) do
+    local params = util.make_position_params(win, client.offset_encoding)
+    client.request(ms.textDocument_completion, params, function(err, result)
+      if err then
+        log.warn(err.message)
+      end
+      if result and vim.fn.mode() == 'i' then
+        -- Completion response items may be relative to a position different than `textMatch`.
+        -- Concrete example, with sumneko/lua-language-server:
+        --
+        -- require('plenary.asy|
+        --         ▲       ▲   ▲
+        --         │       │   └── cursor_pos: 20
+        --         │       └────── textMatch: 17
+        --         └────────────── textEdit.range.start.character: 9
+        --                                 .newText = 'plenary.async'
+        --                  ^^^
+        --                  prefix (We'd remove everything not starting with `asy`,
+        --                  so we'd eliminate the `plenary.async` result
+        --
+        -- `adjust_start_col` is used to prefer the language server boundary.
+        --
+        local encoding = client.offset_encoding
+        local candidates = get_items(result)
+        local curstartbyte = adjust_start_col(pos[1], line, candidates, encoding)
+        if startbyte == nil then
+          startbyte = curstartbyte
+        elseif curstartbyte ~= nil and curstartbyte ~= startbyte then
+          startbyte = word_boundary
+        end
+        local prefix = startbyte and line:sub(startbyte + 1) or line_to_cursor:sub(word_boundary)
+        local matches = M._lsp_to_complete_items(result, prefix)
+        vim.list_extend(items, matches)
+      end
+      remaining = remaining - 1
+      if remaining == 0 then
+        vim.schedule(on_done)
+      end
+    end, bufnr)
+  end
+
+  -- Return -2 to signal that we should continue completion so that we can
+  -- async complete.
+  return -2
+end
+
+return M
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 3a1b16c450..7a48c800c6 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -242,6 +242,7 @@ local constants = {
 
   -- Defines whether the insert text in a completion item should be interpreted as
   -- plain text or a snippet.
+  --- @enum lsp.InsertTextFormat
   InsertTextFormat = {
     -- The primary text to be inserted is treated as a plain string.
     PlainText = 1,
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 42c1508cbf..7ccb8a38b1 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -548,7 +548,7 @@ end
 --- `textDocument/completion` request, which may return one of
 --- `CompletionItem[]`, `CompletionList` or null.
 ---@param result table The result of a `textDocument/completion` request
----@return table List of completion items
+---@return lsp.CompletionItem[] List of completion items
 ---@see https://microsoft.github.io/language-server-protocol/specification#textDocument_completion
 function M.extract_completion_items(result)
   if type(result) == 'table' and result.items then
@@ -619,47 +619,6 @@ function M.parse_snippet(input)
   return tostring(parsed)
 end
 
---- Sorts by CompletionItem.sortText.
----
---see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_completion
-local function sort_completion_items(items)
-  table.sort(items, function(a, b)
-    return (a.sortText or a.label) < (b.sortText or b.label)
-  end)
-end
-
---- Returns text that should be inserted when selecting completion item. The
---- precedence is as follows: textEdit.newText > insertText > label
---see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_completion
-local function get_completion_word(item)
-  if item.textEdit ~= nil and item.textEdit.newText ~= nil and item.textEdit.newText ~= '' then
-    local insert_text_format = protocol.InsertTextFormat[item.insertTextFormat]
-    if insert_text_format == 'PlainText' or insert_text_format == nil then
-      return item.textEdit.newText
-    else
-      return M.parse_snippet(item.textEdit.newText)
-    end
-  elseif item.insertText ~= nil and item.insertText ~= '' then
-    local insert_text_format = protocol.InsertTextFormat[item.insertTextFormat]
-    if insert_text_format == 'PlainText' or insert_text_format == nil then
-      return item.insertText
-    else
-      return M.parse_snippet(item.insertText)
-    end
-  end
-  return item.label
-end
-
---- Some language servers return complementary candidates whose prefixes do not
---- match are also returned. So we exclude completion candidates whose prefix
---- does not match.
-local function remove_unmatch_completion_items(items, prefix)
-  return vim.tbl_filter(function(item)
-    local word = get_completion_word(item)
-    return vim.startswith(word, prefix)
-  end, items)
-end
-
 --- According to LSP spec, if the client set `completionItemKind.valueSet`,
 --- the client must handle it properly even if it receives a value outside the
 --- specification.
@@ -678,56 +637,10 @@ end
 --- from |vim.lsp.buf.completion()|, which may be one of `CompletionItem[]`,
 --- `CompletionList` or `null`
 ---@param prefix (string) the prefix to filter the completion items
----@return table { matches = complete-items table, incomplete = bool }
+---@return table[] items
 ---@see complete-items
 function M.text_document_completion_list_to_complete_items(result, prefix)
-  local items = M.extract_completion_items(result)
-  if vim.tbl_isempty(items) then
-    return {}
-  end
-
-  items = remove_unmatch_completion_items(items, prefix)
-  sort_completion_items(items)
-
-  local matches = {}
-
-  for _, completion_item in ipairs(items) do
-    local info = ''
-    local documentation = completion_item.documentation
-    if documentation then
-      if type(documentation) == 'string' and documentation ~= '' then
-        info = documentation
-      elseif type(documentation) == 'table' and type(documentation.value) == 'string' then
-        info = documentation.value
-      else
-        vim.notify(
-          ('invalid documentation value %s'):format(vim.inspect(documentation)),
-          vim.log.levels.WARN
-        )
-      end
-    end
-
-    local word = get_completion_word(completion_item)
-    table.insert(matches, {
-      word = word,
-      abbr = completion_item.label,
-      kind = M._get_completion_item_kind_name(completion_item.kind),
-      menu = completion_item.detail or '',
-      info = #info > 0 and info or nil,
-      icase = 1,
-      dup = 1,
-      empty = 1,
-      user_data = {
-        nvim = {
-          lsp = {
-            completion_item = completion_item,
-          },
-        },
-      },
-    })
-  end
-
-  return matches
+  return require('vim.lsp._completion')._lsp_to_complete_items(result, prefix)
 end
 
 --- Like vim.fn.bufwinid except it works across tabpages.
-- 
cgit 


From 195301c60969c7ce97b1ef3a3caaf4965da1abd5 Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Sat, 21 Oct 2023 09:57:50 +0200
Subject: refactor(lsp): deprecate completion util methods

Relates to https://github.com/neovim/neovim/issues/25272
---
 runtime/lua/vim/lsp/util.lua | 17 ++++++-----------
 1 file changed, 6 insertions(+), 11 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 7ccb8a38b1..32b220746f 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -547,10 +547,12 @@ end
 --- Can be used to extract the completion items from a
 --- `textDocument/completion` request, which may return one of
 --- `CompletionItem[]`, `CompletionList` or null.
+---@deprecated
 ---@param result table The result of a `textDocument/completion` request
 ---@return lsp.CompletionItem[] List of completion items
 ---@see https://microsoft.github.io/language-server-protocol/specification#textDocument_completion
 function M.extract_completion_items(result)
+  vim.deprecate('vim.lsp.util.extract_completion_items', nil, '0.11')
   if type(result) == 'table' and result.items then
     -- result is a `CompletionList`
     return result.items
@@ -606,9 +608,11 @@ end
 
 --- Parses snippets in a completion entry.
 ---
+---@deprecated
 ---@param input string unparsed snippet
 ---@return string parsed snippet
 function M.parse_snippet(input)
+  vim.deprecate('vim.lsp.util.parse_snippet', nil, '0.11')
   local ok, parsed = pcall(function()
     return snippet.parse(input)
   end)
@@ -619,20 +623,10 @@ function M.parse_snippet(input)
   return tostring(parsed)
 end
 
---- According to LSP spec, if the client set `completionItemKind.valueSet`,
---- the client must handle it properly even if it receives a value outside the
---- specification.
----
----@param completion_item_kind (`vim.lsp.protocol.completionItemKind`)
----@return (`vim.lsp.protocol.completionItemKind`)
----@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_completion
-function M._get_completion_item_kind_name(completion_item_kind)
-  return protocol.CompletionItemKind[completion_item_kind] or 'Unknown'
-end
-
 --- Turns the result of a `textDocument/completion` request into vim-compatible
 --- |complete-items|.
 ---
+---@deprecated
 ---@param result table The result of a `textDocument/completion` call, e.g.
 --- from |vim.lsp.buf.completion()|, which may be one of `CompletionItem[]`,
 --- `CompletionList` or `null`
@@ -640,6 +634,7 @@ end
 ---@return table[] items
 ---@see complete-items
 function M.text_document_completion_list_to_complete_items(result, prefix)
+  vim.deprecate('vim.lsp.util.text_document_completion_list_to_complete_items', nil, '0.11')
   return require('vim.lsp._completion')._lsp_to_complete_items(result, prefix)
 end
 
-- 
cgit 


From ae4ca4edf89ece433b61e8bf92c412298b58d9ea Mon Sep 17 00:00:00 2001
From: glepnir <glephunter@gmail.com>
Date: Fri, 13 Oct 2023 14:49:01 +0800
Subject: feat(complete): support f flag for complete buffer part

---
 runtime/lua/vim/_meta/options.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index cc013112b3..83b30838ab 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -998,6 +998,7 @@ vim.bo.cms = vim.bo.commentstring
 --- 	`i_CTRL-X_CTRL-D`
 --- ]	tag completion
 --- t	same as "]"
+--- f	scan the buffer names (as opposed to buffer contents)
 ---
 --- Unloaded buffers are not loaded, thus their autocmds `:autocmd` are
 --- not executed, this may lead to unexpected completions from some files
-- 
cgit 


From 5e5f5174e3faa862a9bc353aa7da41487911140b Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Sat, 21 Oct 2023 13:44:53 +0200
Subject: fix(lsp): fix off-by-one error for omnifunc word boundary

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

I initially wanted to split this into a refactor commit to make it more
testable, but it appears that already accidentally fixed the issue by
normalizing lnum/col to 0-indexing
---
 runtime/lua/vim/lsp/_completion.lua | 104 ++++++++++++++++++++++--------------
 1 file changed, 64 insertions(+), 40 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_completion.lua b/runtime/lua/vim/lsp/_completion.lua
index efd1aaacf7..f0e3af7f03 100644
--- a/runtime/lua/vim/lsp/_completion.lua
+++ b/runtime/lua/vim/lsp/_completion.lua
@@ -106,11 +106,12 @@ function M._lsp_to_complete_items(result, prefix)
   return matches
 end
 
+---@param lnum integer 0-indexed
 ---@param items lsp.CompletionItem[]
 local function adjust_start_col(lnum, line, items, encoding)
   local min_start_char = nil
   for _, item in pairs(items) do
-    if item.textEdit and item.textEdit.range.start.line == lnum - 1 then
+    if item.textEdit and item.textEdit.range.start.line == lnum then
       if min_start_char and min_start_char ~= item.textEdit.range.start.character then
         return nil
       end
@@ -124,12 +125,57 @@ local function adjust_start_col(lnum, line, items, encoding)
   end
 end
 
+---@private
+---@param line string line content
+---@param lnum integer 0-indexed line number
+---@param client_start_boundary integer 0-indexed word boundary
+---@param server_start_boundary? integer 0-indexed word boundary, based on textEdit.range.start.character
+---@param result lsp.CompletionList|lsp.CompletionItem[]
+---@param encoding string
+---@return table[] matches
+---@return integer? server_start_boundary
+function M._convert_results(
+  line,
+  lnum,
+  client_start_boundary,
+  server_start_boundary,
+  result,
+  encoding
+)
+  -- Completion response items may be relative to a position different than `client_start_boundary`.
+  -- Concrete example, with lua-language-server:
+  --
+  -- require('plenary.asy|
+  --         ▲       ▲   ▲
+  --         │       │   └── cursor_pos:                     20
+  --         │       └────── client_start_boundary:          17
+  --         └────────────── textEdit.range.start.character: 9
+  --                                 .newText = 'plenary.async'
+  --                  ^^^
+  --                  prefix (We'd remove everything not starting with `asy`,
+  --                  so we'd eliminate the `plenary.async` result
+  --
+  -- `adjust_start_col` is used to prefer the language server boundary.
+  --
+  local candidates = get_items(result)
+  local curstartbyte = adjust_start_col(lnum, line, candidates, encoding)
+  if server_start_boundary == nil then
+    server_start_boundary = curstartbyte
+  elseif curstartbyte ~= nil and curstartbyte ~= server_start_boundary then
+    server_start_boundary = client_start_boundary
+  end
+  local prefix = line:sub((server_start_boundary or client_start_boundary) + 1)
+  local matches = M._lsp_to_complete_items(result, prefix)
+  return matches, server_start_boundary
+end
+
 ---@param findstart integer 0 or 1, decides behavior
 ---@param base integer findstart=0, text to match against
 ---@return integer|table Decided by {findstart}:
 --- - findstart=0: column where the completion starts, or -2 or -3
 --- - findstart=1: list of matches (actually just calls |complete()|)
 function M.omnifunc(findstart, base)
+  assert(base) -- silence luals
   local bufnr = api.nvim_get_current_buf()
   local clients = lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_completion })
   local remaining = #clients
@@ -137,26 +183,20 @@ function M.omnifunc(findstart, base)
     return findstart == 1 and -1 or {}
   end
 
-  local log = require('vim.lsp.log')
-  -- Then, perform standard completion request
-  if log.info() then
-    log.info('base ', base)
-  end
-
   local win = api.nvim_get_current_win()
-  local pos = api.nvim_win_get_cursor(win)
+  local cursor = api.nvim_win_get_cursor(win)
+  local lnum = cursor[1] - 1
+  local cursor_col = cursor[2]
   local line = api.nvim_get_current_line()
-  local line_to_cursor = line:sub(1, pos[2])
-  log.trace('omnifunc.line', pos, line)
-
-  local word_boundary = vim.fn.match(line_to_cursor, '\\k*$') + 1 --[[@as integer]]
+  local line_to_cursor = line:sub(1, cursor_col)
+  local client_start_boundary = vim.fn.match(line_to_cursor, '\\k*$') --[[@as integer]]
+  local server_start_boundary = nil
   local items = {}
-  local startbyte = nil
 
   local function on_done()
     local mode = api.nvim_get_mode()['mode']
     if mode == 'i' or mode == 'ic' then
-      vim.fn.complete(startbyte or word_boundary, items)
+      vim.fn.complete((server_start_boundary or client_start_boundary) + 1, items)
     end
   end
 
@@ -165,34 +205,18 @@ function M.omnifunc(findstart, base)
     local params = util.make_position_params(win, client.offset_encoding)
     client.request(ms.textDocument_completion, params, function(err, result)
       if err then
-        log.warn(err.message)
+        require('vim.lsp.log').warn(err.message)
       end
       if result and vim.fn.mode() == 'i' then
-        -- Completion response items may be relative to a position different than `textMatch`.
-        -- Concrete example, with sumneko/lua-language-server:
-        --
-        -- require('plenary.asy|
-        --         ▲       ▲   ▲
-        --         │       │   └── cursor_pos: 20
-        --         │       └────── textMatch: 17
-        --         └────────────── textEdit.range.start.character: 9
-        --                                 .newText = 'plenary.async'
-        --                  ^^^
-        --                  prefix (We'd remove everything not starting with `asy`,
-        --                  so we'd eliminate the `plenary.async` result
-        --
-        -- `adjust_start_col` is used to prefer the language server boundary.
-        --
-        local encoding = client.offset_encoding
-        local candidates = get_items(result)
-        local curstartbyte = adjust_start_col(pos[1], line, candidates, encoding)
-        if startbyte == nil then
-          startbyte = curstartbyte
-        elseif curstartbyte ~= nil and curstartbyte ~= startbyte then
-          startbyte = word_boundary
-        end
-        local prefix = startbyte and line:sub(startbyte + 1) or line_to_cursor:sub(word_boundary)
-        local matches = M._lsp_to_complete_items(result, prefix)
+        local matches
+        matches, server_start_boundary = M._convert_results(
+          line,
+          lnum,
+          client_start_boundary,
+          server_start_boundary,
+          result,
+          client.offset_encoding
+        )
         vim.list_extend(items, matches)
       end
       remaining = remaining - 1
-- 
cgit 


From 370232dbefb91b7ee773ee9a61a9b1ad77d7f1af Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sun, 22 Oct 2023 21:21:02 -0700
Subject: fix(lsp): track snippet deletion

---
 runtime/lua/vim/snippet.lua | 70 ++++++++++++++++++++++++++++-----------------
 1 file changed, 43 insertions(+), 27 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/snippet.lua b/runtime/lua/vim/snippet.lua
index 3d739bd3af..3fe8ab2d48 100644
--- a/runtime/lua/vim/snippet.lua
+++ b/runtime/lua/vim/snippet.lua
@@ -90,6 +90,18 @@ local function compute_tabstop_range(snippet, placeholder)
   return { start_row, start_col, end_row, end_col }
 end
 
+--- Returns the range spanned by the respective extmark.
+---
+--- @param bufnr integer
+--- @param extmark_id integer
+--- @return Range4
+local function get_extmark_range(bufnr, extmark_id)
+  local mark = vim.api.nvim_buf_get_extmark_by_id(bufnr, snippet_ns, extmark_id, { details = true })
+
+  --- @diagnostic disable-next-line: undefined-field
+  return { mark[1], mark[2], mark[3].end_row, mark[3].end_col }
+end
+
 --- @class vim.snippet.Tabstop
 --- @field extmark_id integer
 --- @field index integer
@@ -125,11 +137,7 @@ end
 --- @package
 --- @return Range4
 function Tabstop:get_range()
-  local mark =
-    vim.api.nvim_buf_get_extmark_by_id(self.bufnr, snippet_ns, self.extmark_id, { details = true })
-
-  --- @diagnostic disable-next-line: undefined-field
-  return { mark[1], mark[2], mark[3].end_row, mark[3].end_col }
+  return get_extmark_range(self.bufnr, self.extmark_id)
 end
 
 --- Returns the text spanned by the tabstop.
@@ -155,6 +163,7 @@ end
 
 --- @class vim.snippet.Session
 --- @field bufnr integer
+--- @field extmark_id integer
 --- @field tabstops table<integer, vim.snippet.Tabstop[]>
 --- @field current_tabstop vim.snippet.Tabstop
 local Session = {}
@@ -162,29 +171,27 @@ local Session = {}
 --- Creates a new snippet session in the current buffer.
 ---
 --- @package
+--- @param bufnr integer
+--- @param snippet_extmark integer
+--- @param tabstop_ranges table<integer, Range4[]>
 --- @return vim.snippet.Session
-function Session.new()
-  local bufnr = vim.api.nvim_get_current_buf()
+function Session.new(bufnr, snippet_extmark, tabstop_ranges)
   local self = setmetatable({
     bufnr = bufnr,
+    extmark_id = snippet_extmark,
     tabstops = {},
     current_tabstop = Tabstop.new(0, bufnr, { 0, 0, 0, 0 }),
   }, { __index = Session })
 
-  return self
-end
-
---- Creates the session tabstops.
----
---- @package
---- @param tabstop_ranges table<integer, Range4[]>
-function Session:set_tabstops(tabstop_ranges)
+  -- Create the tabstops.
   for index, ranges in pairs(tabstop_ranges) do
     for _, range in ipairs(ranges) do
       self.tabstops[index] = self.tabstops[index] or {}
       table.insert(self.tabstops[index], Tabstop.new(index, self.bufnr, range))
     end
   end
+
+  return self
 end
 
 --- Returns the destination tabstop index when jumping in the given direction.
@@ -304,6 +311,15 @@ local function setup_autocmds(bufnr)
     desc = 'Update active tabstops when buffer text changes',
     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)
+      if
+        (snippet_range[1] == snippet_range[3] and snippet_range[2] == snippet_range[4])
+        or snippet_range[3] + 1 > vim.fn.line('$')
+      then
+        M.exit()
+      end
+
       if not M.active() then
         return true
       end
@@ -331,8 +347,6 @@ function M.expand(input)
   local snippet = G.parse(input)
   local snippet_text = {}
 
-  M._session = Session.new()
-
   -- Get the placeholders we should use for each tabstop index.
   --- @type table<integer, string>
   local placeholders = {}
@@ -427,19 +441,21 @@ function M.expand(input)
     add_tabstop(0)
   end
 
+  snippet_text = text_to_lines(snippet_text)
+
   -- Insert the snippet text.
+  local bufnr = vim.api.nvim_get_current_buf()
   local cursor_row, cursor_col = cursor_pos()
-  vim.api.nvim_buf_set_text(
-    M._session.bufnr,
-    cursor_row,
-    cursor_col,
-    cursor_row,
-    cursor_col,
-    text_to_lines(snippet_text)
-  )
+  vim.api.nvim_buf_set_text(bufnr, cursor_row, cursor_col, cursor_row, cursor_col, snippet_text)
 
-  -- Create the tabstops.
-  M._session:set_tabstops(tabstop_ranges)
+  -- Create the session.
+  local snippet_extmark = vim.api.nvim_buf_set_extmark(bufnr, snippet_ns, cursor_row, cursor_col, {
+    end_line = cursor_row + #snippet_text - 1,
+    end_col = #snippet_text > 1 and #snippet_text[#snippet_text] or cursor_col + #snippet_text[1],
+    right_gravity = false,
+    end_right_gravity = true,
+  })
+  M._session = Session.new(bufnr, snippet_extmark, tabstop_ranges)
 
   -- Jump to the first tabstop.
   M.jump(1)
-- 
cgit 


From 94127cb5df0a513e66777d18a2c7fa6219404280 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Sun, 22 Oct 2023 22:38:11 -0700
Subject: fix(lsp): do not add extra indentation

---
 runtime/lua/vim/snippet.lua | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/snippet.lua b/runtime/lua/vim/snippet.lua
index 3fe8ab2d48..7680d2e216 100644
--- a/runtime/lua/vim/snippet.lua
+++ b/runtime/lua/vim/snippet.lua
@@ -346,6 +346,7 @@ end
 function M.expand(input)
   local snippet = G.parse(input)
   local snippet_text = {}
+  local base_indent = vim.api.nvim_get_current_line():match('^%s*') or ''
 
   -- Get the placeholders we should use for each tabstop index.
   --- @type table<integer, string>
@@ -377,10 +378,10 @@ function M.expand(input)
   ---
   --- @param text string|string[]
   local function append_to_snippet(text)
+    local snippet_lines = text_to_lines(snippet_text)
     -- Get the base indentation based on the current line and the last line of the snippet.
-    local base_indent = vim.api.nvim_get_current_line():match('^%s*') or ''
-    if #snippet_text > 0 then
-      base_indent = base_indent .. (snippet_text[#snippet_text]:match('^%s*') or '') --- @type string
+    if #snippet_lines > 0 then
+      base_indent = base_indent .. (snippet_lines[#snippet_lines]:match('(^%s*)%S') or '') --- @type string
     end
 
     local lines = vim.iter.map(function(i, line)
-- 
cgit 


From 5f0224e848740eaf8fa68fe9cd89b060b31616fc Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Mon, 23 Oct 2023 19:19:58 +0200
Subject: vim-patch:9.0.2060: *.{gn,gni} files are not recognized

Problem:  *.{gn,gni} files are not recognized
Solution: Detect some as gn filetype (without adding an extra filetype)

Those come from: https://gn.googlesource.com/gn/

closes: vim/vim#13405

https://github.com/vim/vim/commit/84394f2be4a750f1e26b478e36de041663f4b5a4

Co-authored-by: Amaan Qureshi <amaanq12@gmail.com>
---
 runtime/lua/vim/filetype.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 6dbfd7e64d..ec3f89da32 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -459,6 +459,8 @@ local extension = {
   gift = 'gift',
   gleam = 'gleam',
   glsl = 'glsl',
+  gn = 'gn',
+  gni = 'gn',
   gpi = 'gnuplot',
   go = 'go',
   gp = 'gp',
-- 
cgit 


From 94fee354465d7d8636f454a9bcca9080ef9e50bd Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Mon, 23 Oct 2023 19:24:52 +0200
Subject: vim-patch:9.0.2061: not able to detect xkb filetypes

Problem:  not able to detect xkb filetypes
Solution: Detect files below /u/s/X11/xkb as xkb files (without adding
          an extra filetype)

Those files are used from the X11 xkb extension

closes: vim/vim#13401

https://github.com/vim/vim/commit/ae9021a840db3253b0e0cb84186faae73368afd7

Co-authored-by: Guido Cella <guido@guidocella.xyz>
---
 runtime/lua/vim/filetype.lua | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index ec3f89da32..763ed99914 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1982,6 +1982,11 @@ local pattern = {
   ['.*/Xresources/.*'] = starsetf('xdefaults'),
   ['.*/app%-defaults/.*'] = starsetf('xdefaults'),
   ['.*/etc/xinetd%.conf'] = 'xinetd',
+  ['.*/usr/share/X11/xkb/compat/.*'] = starsetf('xkb'),
+  ['.*/usr/share/X11/xkb/geometry/.*'] = starsetf('xkb'),
+  ['.*/usr/share/X11/xkb/keycodes/.*'] = starsetf('xkb'),
+  ['.*/usr/share/X11/xkb/symbols/.*'] = starsetf('xkb'),
+  ['.*/usr/share/X11/xkb/types/.*'] = starsetf('xkb'),
   ['.*/etc/blkid%.tab'] = 'xml',
   ['.*/etc/blkid%.tab%.old'] = 'xml',
   ['.*%.vbproj%.user'] = 'xml',
-- 
cgit 


From 4f0adb6a783e2d92301d5391c4b35a62268d2a00 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Mon, 23 Oct 2023 19:30:44 +0200
Subject: vim-patch:9.0.2062: Janet files are not recognised

Problem:  Janet files are not recognised
Solution: Add filename and shebang detection (without
          adding an extra filetype plugin)

Those are used by the Janet language:
http://www.janet-lang.org

closes: vim/vim#13400

https://github.com/vim/vim/commit/c038427d2a27445e612761f19c92b2b8b05afdea

Co-authored-by: Doug Kearns <dougkearns@gmail.com>
---
 runtime/lua/vim/filetype.lua        | 1 +
 runtime/lua/vim/filetype/detect.lua | 3 ++-
 2 files changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 763ed99914..3c3e2a7b5b 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -536,6 +536,7 @@ local extension = {
   jal = 'jal',
   jpr = 'jam',
   jpl = 'jam',
+  janet = 'janet',
   jav = 'java',
   java = 'java',
   jj = 'javacc',
diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index 934b02dcdd..e53ff08536 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -1652,8 +1652,9 @@ local patterns_hashbang = {
   ['icon\\>'] = { 'icon', { vim_regex = true } },
   guile = 'scheme',
   ['nix%-shell'] = 'nix',
-  ['crystal\\>'] = { 'crystal', { vim_regex = true } },
+  ['^crystal\\>'] = { 'crystal', { vim_regex = true } },
   ['^\\%(rexx\\|regina\\)\\>'] = { 'rexx', { vim_regex = true } },
+  ['^janet\\>'] = { 'janet', { vim_regex = true } },
 }
 
 ---@private
-- 
cgit 


From 0b1ec3b162cb160da9b876113ec219a8bac17f70 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Mon, 23 Oct 2023 19:32:42 +0200
Subject: vim-patch:9.0.2063: pacman hooks are detected as conf filetype

Problem:  pacman hooks are detected as conf filetype
Solution: make it consistent to pacman.conf and detect those
          hooks as confini

Because confini has much better syntax highlighting than conf.

For reference, I identified pacman.conf and pacman hooks as dosini in
https://github.com/vim/vim/pull/6335, then
https://github.com/vim/vim/pull/10213 changed them to conf, then
https://github.com/vim/vim/pull/10518 changed pacman.conf to confini but
forgot to change hooks.

closes: vim/vim#13399

https://github.com/vim/vim/commit/7d254dbc2db35badc65668db85f826f605486986

Co-authored-by: Guido Cella <guido@guidocella.xyz>
---
 runtime/lua/vim/filetype.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 3c3e2a7b5b..627732f164 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -282,7 +282,7 @@ local extension = {
   atg = 'coco',
   recipe = 'conaryrecipe',
   hook = function(path, bufnr)
-    return M._getline(bufnr, 1) == '[Trigger]' and 'conf' or nil
+    return M._getline(bufnr, 1) == '[Trigger]' and 'confini' or nil
   end,
   nmconnection = 'confini',
   mklx = 'context',
-- 
cgit 


From bfe8a39512bc4dbf4921c56158c61a172e8f10cf Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 26 Oct 2023 06:41:54 +0800
Subject: vim-patch:partial:5985879e3c36 (#25780)

runtime(doc): Fix typos in several documents (vim/vim#13420)

* Fix typos in several documents
* Update runtime/doc/terminal.txt

https://github.com/vim/vim/commit/5985879e3c36383155f84649fa42d06813a1893e

Skip runtime/doc/indent.txt: not ported yet

Co-authored-by: h_east <h.east.727@gmail.com>
Co-authored-by: K.Takata <kentkt@csc.jp>
---
 runtime/lua/vim/_meta/options.lua | 2 +-
 runtime/lua/vim/_meta/vimfn.lua   | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 83b30838ab..967cf36da0 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -6614,7 +6614,7 @@ vim.bo.swf = vim.bo.swapfile
 --- This option controls the behavior when switching between buffers.
 --- This option is checked, when
 --- - jumping to errors with the `quickfix` commands (`:cc`, `:cn`, `:cp`,
----   etc.)
+---   etc.).
 --- - jumping to a tag using the `:stag` command.
 --- - opening a file using the `CTRL-W_f` or `CTRL-W_F` command.
 --- - jumping to a buffer using a buffer split command (e.g.  `:sbuffer`,
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 2c594e049f..1830e1796b 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -3507,7 +3507,7 @@ function vim.fn.getregtype(regname) end
 ---     Note that this is a copy, the value of
 ---     script-local variables cannot be changed using
 ---     this dictionary.
----     version  Vimscript version, always 1
+---     version  Vim script version, always 1
 ---
 --- Examples: >vim
 ---   echo getscriptinfo({'name': 'myscript'})
-- 
cgit 


From 15983cf2c64c527fc13681925d0d00c070c30640 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Wed, 25 Oct 2023 22:29:05 -0700
Subject: fix(lsp): cancel session when leaving snippet region (#25762)

---
 runtime/lua/vim/snippet.lua | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/snippet.lua b/runtime/lua/vim/snippet.lua
index 7680d2e216..14f73bff5c 100644
--- a/runtime/lua/vim/snippet.lua
+++ b/runtime/lua/vim/snippet.lua
@@ -278,13 +278,26 @@ local function setup_autocmds(bufnr)
     desc = 'Update snippet state when the cursor moves',
     buffer = bufnr,
     callback = function()
+      local cursor_row, cursor_col = cursor_pos()
+
+      -- The cursor left the snippet region.
+      local snippet_range = get_extmark_range(bufnr, M._session.extmark_id)
+      if
+        cursor_row < snippet_range[1]
+        or (cursor_row == snippet_range[1] and cursor_col < snippet_range[2])
+        or cursor_row > snippet_range[3]
+        or (cursor_row == snippet_range[3] and cursor_col > snippet_range[4])
+      then
+        M.exit()
+        return true
+      end
+
       -- Just update the tabstop in insert and select modes.
       if not vim.fn.mode():match('^[isS]') then
         return
       end
 
       -- Update the current tabstop to be the one containing the cursor.
-      local cursor_row, cursor_col = cursor_pos()
       for tabstop_index, tabstops in pairs(M._session.tabstops) do
         for _, tabstop in ipairs(tabstops) do
           local range = tabstop:get_range()
-- 
cgit 


From ba6761eafe615a7f904c585dba3b7d6e98f665e1 Mon Sep 17 00:00:00 2001
From: Lajos Koszti <ajnasz@ajnasz.hu>
Date: Thu, 26 Oct 2023 22:40:36 +0200
Subject: fix(lsp): fix omnicomplete in middle of the line (#25787)

Fixes a regression from 5e5f5174e3faa862a9bc353aa7da41487911140b

Until that commit we had a logic like this:
`local prefix = startbyte and line:sub(startbyte + 1) or line_to_cursor:sub(word_boundary)`

The commit changed the logic and no longer cut off the line at the cursor,  resulting in a prefix that included trailing characters
---
 runtime/lua/vim/lsp/_completion.lua | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_completion.lua b/runtime/lua/vim/lsp/_completion.lua
index f0e3af7f03..7a607d6c13 100644
--- a/runtime/lua/vim/lsp/_completion.lua
+++ b/runtime/lua/vim/lsp/_completion.lua
@@ -137,6 +137,7 @@ end
 function M._convert_results(
   line,
   lnum,
+  cursor_col,
   client_start_boundary,
   server_start_boundary,
   result,
@@ -164,7 +165,7 @@ function M._convert_results(
   elseif curstartbyte ~= nil and curstartbyte ~= server_start_boundary then
     server_start_boundary = client_start_boundary
   end
-  local prefix = line:sub((server_start_boundary or client_start_boundary) + 1)
+  local prefix = line:sub((server_start_boundary or client_start_boundary) + 1, cursor_col)
   local matches = M._lsp_to_complete_items(result, prefix)
   return matches, server_start_boundary
 end
@@ -212,6 +213,7 @@ function M.omnifunc(findstart, base)
         matches, server_start_boundary = M._convert_results(
           line,
           lnum,
+          cursor_col,
           client_start_boundary,
           server_start_boundary,
           result,
-- 
cgit 


From 5753e5e7ebb60d26d78aa3c99a8b0e2ee8023056 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Fri, 27 Oct 2023 09:37:48 +0200
Subject: vim-patch:9.0.2071: objdump files not recognized

Problem:  objdump files not recognized
Solution: detect *.objdump files, add a filetype plugin

Added the objdump file/text format

closes: vim/vim#13425

https://github.com/vim/vim/commit/10407df7a95d0311c7d2eb920d3b72020db5b301

Co-authored-by: Colin Kennedy <colinvfx@gmail.com>
---
 runtime/lua/vim/filetype.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 627732f164..35ad8e21b8 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -716,6 +716,8 @@ local extension = {
   nsi = 'nsis',
   nsh = 'nsis',
   obj = 'obj',
+  objdump = 'objdump',
+  cppobjdump = 'objdump',
   obl = 'obse',
   obse = 'obse',
   oblivion = 'obse',
-- 
cgit 


From add1b10b79011d1af61419a63cc8ef4645f45bbf Mon Sep 17 00:00:00 2001
From: Jongwook Choi <wookayin@gmail.com>
Date: Fri, 27 Oct 2023 09:17:46 -0400
Subject: fix(diagnostic): virtual_text prefix function should have index and
 total (#25801)

The prefix option of the diagnostic virtual text can be a function,
but previously it was only a function of diagnostic.

This function should also have additional parameters index and total,
more consistently and similarily as in the prefix function for
`vim.diagnostic.open_float()`.

These additional parameters will be useful when there are too many
number of diagnostics in a single line.
---
 runtime/lua/vim/diagnostic.lua | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua
index 9e9b09ed1d..99448982b4 100644
--- a/runtime/lua/vim/diagnostic.lua
+++ b/runtime/lua/vim/diagnostic.lua
@@ -592,8 +592,10 @@ end
 ---                       * spacing: (number) Amount of empty spaces inserted at the beginning
 ---                                  of the virtual text.
 ---                       * prefix: (string or function) prepend diagnostic message with prefix.
----                                 If a function, it must have the signature (diagnostic) -> string,
----                                 where {diagnostic} is of type |diagnostic-structure|. This can be
+---                                 If a function, it must have the signature (diagnostic, i, total)
+---                                 -> string, where {diagnostic} is of type |diagnostic-structure|,
+---                                 {i} is the index of the diagnostic being evaluated, and {total}
+---                                 is the total number of diagnostics for the line. This can be
 ---                                 used to render diagnostic symbols or error codes.
 ---                       * suffix: (string or function) Append diagnostic message with suffix.
 ---                                 If a function, it must have the signature (diagnostic) ->
@@ -1072,7 +1074,7 @@ function M._get_virt_text_chunks(line_diags, opts)
   for i = 1, #line_diags do
     local resolved_prefix = prefix
     if type(prefix) == 'function' then
-      resolved_prefix = prefix(line_diags[i]) or ''
+      resolved_prefix = prefix(line_diags[i], i, #line_diags) or ''
     end
     table.insert(
       virt_texts,
-- 
cgit 


From a2a1a65b98ad88d69906b9c372dca1c3063100ef Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sun, 29 Oct 2023 06:15:13 +0800
Subject: vim-patch:8ebdbc9e6d80 (#25816)

runtime(doc): all secure options should note this restriction in the documentation (vim/vim#13448)

Problem:  Not all secure options document their status
Solution: Describe secure context :set restrictions in each help entry

https://github.com/vim/vim/commit/8ebdbc9e6d80b707c2b2d923e702dc86bf902923

Co-authored-by: dkearns <dougkearns@gmail.com>
---
 runtime/lua/vim/_meta/options.lua | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 967cf36da0..a986cd752c 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -694,6 +694,8 @@ vim.go.cmp = vim.go.casemap
 --- current working directory to the `$HOME` directory like in Unix.
 --- When off, those commands just print the current directory name.
 --- On Unix this option has no effect.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
 ---
 --- @type boolean
 vim.o.cdhome = false
@@ -4122,7 +4124,8 @@ vim.go.mis = vim.go.menuitems
 --- If you have less than 512 Mbyte `:mkspell` may fail for some
 --- languages, no matter what you set 'mkspellmem' to.
 ---
---- This option cannot be set from a `modeline` or in the `sandbox`.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
 ---
 --- @type string
 vim.o.mkspellmem = "460000,2000,500"
@@ -4567,6 +4570,8 @@ vim.go.opfunc = vim.go.operatorfunc
 
 --- Directories used to find packages.
 --- See `packages` and `packages-runtimepath`.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
 ---
 --- @type string
 vim.o.packpath = "..."
@@ -4585,6 +4590,8 @@ vim.go.para = vim.go.paragraphs
 
 --- Expression which is evaluated to apply a patch to a file and generate
 --- the resulting new version of the file.  See `diff-patchexpr`.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
 ---
 --- @type string
 vim.o.patchexpr = ""
@@ -5628,6 +5635,8 @@ vim.go.stmp = vim.go.shelltemp
 --- When 'shellxquote' is set to "(" then the characters listed in this
 --- option will be escaped with a '^' character.  This makes it possible
 --- to execute most external commands with cmd.exe.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
 ---
 --- @type string
 vim.o.shellxescape = ""
@@ -6855,6 +6864,8 @@ vim.go.tc = vim.go.tagcase
 --- function and an example.  The value can be the name of a function, a
 --- `lambda` or a `Funcref`. See `option-value-function` for more
 --- information.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
 ---
 --- @type string
 vim.o.tagfunc = ""
@@ -7340,6 +7351,8 @@ vim.go.vbs = vim.go.verbose
 --- Setting 'verbosefile' to a new value is like making it empty first.
 --- The difference with `:redir` is that verbose messages are not
 --- displayed when 'verbosefile' is set.
+--- This option cannot be set from a `modeline` or in the `sandbox`, for
+--- security reasons.
 ---
 --- @type string
 vim.o.verbosefile = ""
-- 
cgit 


From c34e81660884f1b6a50536ce39dbab7cd66b502f Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 28 Oct 2023 23:51:02 +0200
Subject: vim-patch:9.0.2079: Not all Dart files detected

Problem:  Not all Dart files detected
Solution: Add shebang filetype detection for Dart

closes: vim/vim#13449

https://github.com/vim/vim/commit/c1c177a47bfe1b9a524ede2743a689e461668d14

Co-authored-by: Doug Kearns <dougkearns@gmail.com>
---
 runtime/lua/vim/filetype/detect.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index e53ff08536..2232183888 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -1655,6 +1655,7 @@ local patterns_hashbang = {
   ['^crystal\\>'] = { 'crystal', { vim_regex = true } },
   ['^\\%(rexx\\|regina\\)\\>'] = { 'rexx', { vim_regex = true } },
   ['^janet\\>'] = { 'janet', { vim_regex = true } },
+  ['^dart\\>'] = { 'dart', { vim_regex = true } },
 }
 
 ---@private
-- 
cgit 


From 2dc9ceb99c018b15dcf0c443cad46efecccaf94e Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Sun, 29 Oct 2023 09:02:32 +0100
Subject: docs: small fixes (#25585)

Co-authored-by: tmummert <doczook@gmx.de>
Co-authored-by: parikshit adhikari <parikshitadhikari@gmail.com>
---
 runtime/lua/vim/_meta/api.lua   | 2 +-
 runtime/lua/vim/_meta/vimfn.lua | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 5a9b0b53ce..691da62f4f 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1594,7 +1594,7 @@ function vim.api.nvim_open_term(buffer, opts) end
 ---                 • "shadow": A drop shadow effect by blending with the
 ---                   background.
 ---                 • If it is an array, it should have a length of eight or
----                   any divisor of eight. The array will specifify the eight
+---                   any divisor of eight. The array will specify the eight
 ---                   chars building up the border in a clockwise fashion
 ---                   starting with the top-left corner. As an example, the
 ---                   double box style could be specified as [ "╔", "═" ,"╗",
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 1830e1796b..0563f9dd5f 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -8530,7 +8530,7 @@ function vim.fn.slice(expr, start, end_) end
 --- {address} should be the path of a local domain socket (on
 --- unix) or named pipe (on Windows). If {mode} is "tcp" then
 --- {address} should be of the form "host:port" where the host
---- should be an ip adderess or host name, and port the port
+--- should be an ip address or host name, and port the port
 --- number.
 ---
 --- For "pipe" mode, see |luv-pipe-handle|. For "tcp" mode, see
-- 
cgit 


From 0fe0cf5adaab06b92250eb350306de63c4d4f36f Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Mon, 30 Oct 2023 04:58:28 -0700
Subject: fix(lsp): do not cancel snippet when selecting placeholder (#25835)

---
 runtime/lua/vim/snippet.lua | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/snippet.lua b/runtime/lua/vim/snippet.lua
index 14f73bff5c..94c69795a4 100644
--- a/runtime/lua/vim/snippet.lua
+++ b/runtime/lua/vim/snippet.lua
@@ -278,6 +278,11 @@ local function setup_autocmds(bufnr)
     desc = 'Update snippet state when the cursor moves',
     buffer = bufnr,
     callback = function()
+      -- Just update the tabstop in insert and select modes.
+      if not vim.fn.mode():match('^[isS]') then
+        return
+      end
+
       local cursor_row, cursor_col = cursor_pos()
 
       -- The cursor left the snippet region.
@@ -292,11 +297,6 @@ local function setup_autocmds(bufnr)
         return true
       end
 
-      -- Just update the tabstop in insert and select modes.
-      if not vim.fn.mode():match('^[isS]') then
-        return
-      end
-
       -- Update the current tabstop to be the one containing the cursor.
       for tabstop_index, tabstops in pairs(M._session.tabstops) do
         for _, tabstop in ipairs(tabstops) do
-- 
cgit 


From adbe7f368397da21465f27181e254dd3694820e9 Mon Sep 17 00:00:00 2001
From: Evgeni Chasnovski <evgeni.chasnovski@gmail.com>
Date: Tue, 31 Oct 2023 14:18:44 +0200
Subject: fix(lsp): call `on_list()` even for single location (#25830)

Problem: Currently there is no way of customizing behavior of
  `declaration`, `definition`, `typeDefinition`, and `implementation`
  methods in `vim.lsp.buf` when LSP server returns `Location`. Instead,
  cursor jumps to that location directly.

Solution: Normalize LSP response to be `Location[]` for those four cases.
---
 runtime/lua/vim/lsp/buf.lua      | 12 ++++++++----
 runtime/lua/vim/lsp/handlers.lua | 31 +++++++++++++++----------------
 2 files changed, 23 insertions(+), 20 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index 9436fbbf56..b9b7aefae6 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -62,7 +62,8 @@ end
 ---
 ---@param options table|nil additional options
 ---     - reuse_win: (boolean) Jump to existing window if buffer is already open.
----     - on_list: (function) handler for list results. See |lsp-on-list-handler|
+---     - on_list: (function) |lsp-on-list-handler| replacing the default handler.
+---        Called for any non-empty result.
 function M.declaration(options)
   local params = util.make_position_params()
   request_with_options(ms.textDocument_declaration, params, options)
@@ -72,7 +73,8 @@ end
 ---
 ---@param options table|nil additional options
 ---     - reuse_win: (boolean) Jump to existing window if buffer is already open.
----     - on_list: (function) handler for list results. See |lsp-on-list-handler|
+---     - on_list: (function) |lsp-on-list-handler| replacing the default handler.
+---       Called for any non-empty result.
 function M.definition(options)
   local params = util.make_position_params()
   request_with_options(ms.textDocument_definition, params, options)
@@ -82,7 +84,8 @@ end
 ---
 ---@param options table|nil additional options
 ---     - reuse_win: (boolean) Jump to existing window if buffer is already open.
----     - on_list: (function) handler for list results. See |lsp-on-list-handler|
+---     - on_list: (function) |lsp-on-list-handler| replacing the default handler.
+---       Called for any non-empty result.
 function M.type_definition(options)
   local params = util.make_position_params()
   request_with_options(ms.textDocument_typeDefinition, params, options)
@@ -92,7 +95,8 @@ end
 --- quickfix window.
 ---
 ---@param options table|nil additional options
----     - on_list: (function) handler for list results. See |lsp-on-list-handler|
+---     - on_list: (function) |lsp-on-list-handler| replacing the default handler.
+---       Called for any non-empty result.
 function M.implementation(options)
   local params = util.make_position_params()
   request_with_options(ms.textDocument_implementation, params, options)
diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua
index d153b956ee..6fde55cf04 100644
--- a/runtime/lua/vim/lsp/handlers.lua
+++ b/runtime/lua/vim/lsp/handlers.lua
@@ -407,25 +407,24 @@ local function location_handler(_, result, ctx, config)
 
   -- textDocument/definition can return Location or Location[]
   -- https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_definition
+  if not vim.tbl_islist(result) then
+    result = { result }
+  end
 
-  if vim.tbl_islist(result) then
-    local title = 'LSP locations'
-    local items = util.locations_to_items(result, client.offset_encoding)
+  local title = 'LSP locations'
+  local items = util.locations_to_items(result, client.offset_encoding)
 
-    if config.on_list then
-      assert(type(config.on_list) == 'function', 'on_list is not a function')
-      config.on_list({ title = title, items = items })
-    else
-      if #result == 1 then
-        util.jump_to_location(result[1], client.offset_encoding, config.reuse_win)
-        return
-      end
-      vim.fn.setqflist({}, ' ', { title = title, items = items })
-      api.nvim_command('botright copen')
-    end
-  else
-    util.jump_to_location(result, client.offset_encoding, config.reuse_win)
+  if config.on_list then
+    assert(type(config.on_list) == 'function', 'on_list is not a function')
+    config.on_list({ title = title, items = items })
+    return
+  end
+  if #result == 1 then
+    util.jump_to_location(result[1], client.offset_encoding, config.reuse_win)
+    return
   end
+  vim.fn.setqflist({}, ' ', { title = title, items = items })
+  api.nvim_command('botright copen')
 end
 
 --see: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_declaration
-- 
cgit 


From 224f303ee54c54d2147f03010385e8cc48e42869 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Tue, 31 Oct 2023 09:15:32 -0500
Subject: feat(stdlib): add vim.base64 module (#25843)

Add base64 encode() and decode() functions to a vim.base64 module.
---
 runtime/lua/vim/_meta/base64.lua | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 runtime/lua/vim/_meta/base64.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/base64.lua b/runtime/lua/vim/_meta/base64.lua
new file mode 100644
index 0000000000..f25b4af234
--- /dev/null
+++ b/runtime/lua/vim/_meta/base64.lua
@@ -0,0 +1,13 @@
+--- @meta
+
+--- Encode {str} using Base64.
+---
+--- @param str string String to encode
+--- @return string Encoded string
+function vim.base64.encode(str) end
+
+--- Decode a Base64 encoded string.
+---
+--- @param str string Base64 encoded string
+--- @return string Decoded string
+function vim.base64.decode(str) end
-- 
cgit 


From 5a2543c1598a0cf97b8eca0573139c9c20d6c93a Mon Sep 17 00:00:00 2001
From: dundargoc <33953936+dundargoc@users.noreply.github.com>
Date: Fri, 3 Nov 2023 00:22:02 +0100
Subject: docs: small fixes (#25831)

Co-authored-by: Peter Aronoff <peter@aronoff.org>
---
 runtime/lua/vim/_editor.lua | 21 +++++++++++----------
 1 file changed, 11 insertions(+), 10 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index e0c7de87b3..0da127b18f 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -69,7 +69,7 @@ vim.log = {
 }
 
 -- TODO(lewis6991): document that the signature is system({cmd}, [{opts},] {on_exit})
---- Run a system command
+--- Runs a system command or throws an error if {cmd} cannot be run.
 ---
 --- Examples:
 ---
@@ -82,16 +82,17 @@ vim.log = {
 ---   print(obj.stderr)
 --- end
 ---
---- -- Run asynchronously
+--- -- Runs asynchronously:
 --- vim.system({'echo', 'hello'}, { text = true }, on_exit)
 ---
---- -- Run synchronously
+--- -- Runs synchronously:
 --- local obj = vim.system({'echo', 'hello'}, { text = true }):wait()
 --- -- { code = 0, signal = 0, stdout = 'hello', stderr = '' }
 ---
 --- ```
 ---
---- See |uv.spawn()| for more details.
+--- See |uv.spawn()| for more details. Note: unlike |uv.spawn()|, vim.system
+--- throws an error if {cmd} cannot be run.
 ---
 --- @param cmd (string[]) Command to execute
 --- @param opts (SystemOpts|nil) Options:
@@ -370,7 +371,7 @@ end
 
 local VIM_CMD_ARG_MAX = 20
 
---- Execute Vim script commands.
+--- Executes Vim script commands.
 ---
 --- Note that `vim.cmd` can be indexed with a command name to return a callable function to the
 --- command.
@@ -587,7 +588,7 @@ function vim.defer_fn(fn, timeout)
   return timer
 end
 
---- Display a notification to the user.
+--- Displays a notification to the user.
 ---
 --- This function can be overridden by plugins to display notifications using a
 --- custom provider (such as the system notification provider). By default,
@@ -609,7 +610,7 @@ end
 do
   local notified = {}
 
-  --- Display a notification only one time.
+  --- Displays a notification only one time.
   ---
   --- Like |vim.notify()|, but subsequent calls with the same message will not
   --- display a notification.
@@ -690,7 +691,7 @@ function vim._on_key(char)
   end
 end
 
---- Generate a list of possible completions for the string.
+--- Generates a list of possible completions for the string.
 --- String has the pattern.
 ---
 ---     1. Can we get it to just return things in the global namespace with that name prefix
@@ -917,7 +918,7 @@ function vim.print(...)
   return ...
 end
 
---- Translate keycodes.
+--- Translates keycodes.
 ---
 --- Example:
 ---
@@ -1030,7 +1031,7 @@ function vim.deprecate(name, alternative, version, plugin, backtrace)
   return displayed and msg or nil
 end
 
---- Create builtin mappings (incl. menus).
+--- Creates builtin mappings (incl. menus).
 --- Called once on startup.
 function vim._init_default_mappings()
   -- mappings
-- 
cgit 


From 9281edb334a374e7753d4a6b7a05e31120e39772 Mon Sep 17 00:00:00 2001
From: Mathias Fussenegger <f.mathias@zignar.net>
Date: Thu, 2 Nov 2023 09:59:41 +0100
Subject: fix(lsp): create per client params in lsp.buf.code_action

`code_action` used the same parameters for all clients, which led to the
following warning and incorrect start/end column locations if using
clients with mixed encodings:

    warning: multiple different client offset_encodings detected for
    buffer, this is not supported yet
---
 runtime/lua/vim/lsp/buf.lua | 141 ++++++++++++++++++++++++++++----------------
 1 file changed, 91 insertions(+), 50 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
index b9b7aefae6..cf9acc0808 100644
--- a/runtime/lua/vim/lsp/buf.lua
+++ b/runtime/lua/vim/lsp/buf.lua
@@ -579,6 +579,17 @@ function M.clear_references()
   util.buf_clear_references()
 end
 
+---@class vim.lsp.CodeActionResultEntry
+---@field error? lsp.ResponseError
+---@field result? (lsp.Command|lsp.CodeAction)[]
+---@field ctx lsp.HandlerContext
+
+---@class vim.lsp.buf.code_action.opts
+---@field context? lsp.CodeActionContext
+---@field filter? fun(x: lsp.CodeAction|lsp.Command):boolean
+---@field apply? boolean
+---@field range? {start: integer[], end: integer[]}
+
 --- This is not public because the main extension point is
 --- vim.ui.select which can be overridden independently.
 ---
@@ -587,17 +598,18 @@ end
 --- from multiple clients to have 1 single UI prompt for the user, yet we still
 --- need to be able to link a `CodeAction|Command` to the right client for
 --- `codeAction/resolve`
-local function on_code_action_results(results, ctx, options)
-  local action_tuples = {}
-
+---@param results table<integer, vim.lsp.CodeActionResultEntry>
+---@param opts? vim.lsp.buf.code_action.opts
+local function on_code_action_results(results, opts)
+  ---@param a lsp.Command|lsp.CodeAction
   local function action_filter(a)
     -- filter by specified action kind
-    if options and options.context and options.context.only then
+    if opts and opts.context and opts.context.only then
       if not a.kind then
         return false
       end
       local found = false
-      for _, o in ipairs(options.context.only) do
+      for _, o in ipairs(opts.context.only) do
         -- action kinds are hierarchical with . as a separator: when requesting only 'type-annotate'
         -- this filter allows both 'type-annotate' and 'type-annotate.foo', for example
         if a.kind == o or vim.startswith(a.kind, o .. '.') then
@@ -610,26 +622,31 @@ local function on_code_action_results(results, ctx, options)
       end
     end
     -- filter by user function
-    if options and options.filter and not options.filter(a) then
+    if opts and opts.filter and not opts.filter(a) then
       return false
     end
     -- no filter removed this action
     return true
   end
 
-  for client_id, result in pairs(results) do
+  ---@type {action: lsp.Command|lsp.CodeAction, ctx: lsp.HandlerContext}[]
+  local actions = {}
+  for _, result in pairs(results) do
     for _, action in pairs(result.result or {}) do
       if action_filter(action) then
-        table.insert(action_tuples, { client_id, action })
+        table.insert(actions, { action = action, ctx = result.ctx })
       end
     end
   end
-  if #action_tuples == 0 then
+  if #actions == 0 then
     vim.notify('No code actions available', vim.log.levels.INFO)
     return
   end
 
-  local function apply_action(action, client)
+  ---@param action lsp.Command|lsp.CodeAction
+  ---@param client lsp.Client
+  ---@param ctx lsp.HandlerContext
+  local function apply_action(action, client, ctx)
     if action.edit then
       util.apply_workspace_edit(action.edit, client.offset_encoding)
     end
@@ -639,8 +656,9 @@ local function on_code_action_results(results, ctx, options)
     end
   end
 
-  local function on_user_choice(action_tuple)
-    if not action_tuple then
+  ---@param choice {action: lsp.Command|lsp.CodeAction, ctx: lsp.HandlerContext}
+  local function on_user_choice(choice)
+    if not choice then
       return
     end
     -- textDocument/codeAction can return either Command[] or CodeAction[]
@@ -656,10 +674,11 @@ local function on_code_action_results(results, ctx, options)
     --  arguments?: any[]
     --
     ---@type lsp.Client
-    local client = assert(vim.lsp.get_client_by_id(action_tuple[1]))
-    local action = action_tuple[2]
+    local client = assert(vim.lsp.get_client_by_id(choice.ctx.client_id))
+    local action = choice.action
+    local bufnr = assert(choice.ctx.bufnr, 'Must have buffer number')
 
-    local reg = client.dynamic_capabilities:get(ms.textDocument_codeAction, { bufnr = ctx.bufnr })
+    local reg = client.dynamic_capabilities:get(ms.textDocument_codeAction, { bufnr = bufnr })
 
     local supports_resolve = vim.tbl_get(reg or {}, 'registerOptions', 'resolveProvider')
       or client.supports_method(ms.codeAction_resolve)
@@ -668,44 +687,37 @@ local function on_code_action_results(results, ctx, options)
       client.request(ms.codeAction_resolve, action, function(err, resolved_action)
         if err then
           if action.command then
-            apply_action(action, client)
+            apply_action(action, client, choice.ctx)
           else
             vim.notify(err.code .. ': ' .. err.message, vim.log.levels.ERROR)
           end
         else
-          apply_action(resolved_action, client)
+          apply_action(resolved_action, client, choice.ctx)
         end
-      end, ctx.bufnr)
+      end, bufnr)
     else
-      apply_action(action, client)
+      apply_action(action, client, choice.ctx)
     end
   end
 
   -- If options.apply is given, and there are just one remaining code action,
   -- apply it directly without querying the user.
-  if options and options.apply and #action_tuples == 1 then
-    on_user_choice(action_tuples[1])
+  if opts and opts.apply and #actions == 1 then
+    on_user_choice(actions[1])
     return
   end
 
-  vim.ui.select(action_tuples, {
+  ---@param item {action: lsp.Command|lsp.CodeAction}
+  local function format_item(item)
+    local title = item.action.title:gsub('\r\n', '\\r\\n')
+    return title:gsub('\n', '\\n')
+  end
+  local select_opts = {
     prompt = 'Code actions:',
     kind = 'codeaction',
-    format_item = function(action_tuple)
-      local title = action_tuple[2].title:gsub('\r\n', '\\r\\n')
-      return title:gsub('\n', '\\n')
-    end,
-  }, on_user_choice)
-end
-
---- Requests code actions from all clients and calls the handler exactly once
---- with all aggregated results
-local function code_action_request(params, options)
-  local bufnr = api.nvim_get_current_buf()
-  vim.lsp.buf_request_all(bufnr, ms.textDocument_codeAction, params, function(results)
-    local ctx = { bufnr = bufnr, method = ms.textDocument_codeAction, params = params }
-    on_code_action_results(results, ctx, options)
-  end)
+    format_item = format_item,
+  }
+  vim.ui.select(actions, select_opts, on_user_choice)
 end
 
 --- Selects a code action available at the current
@@ -752,21 +764,50 @@ function M.code_action(options)
     local bufnr = api.nvim_get_current_buf()
     context.diagnostics = vim.lsp.diagnostic.get_line_diagnostics(bufnr)
   end
-  local params
   local mode = api.nvim_get_mode().mode
-  if options.range then
-    assert(type(options.range) == 'table', 'code_action range must be a table')
-    local start = assert(options.range.start, 'range must have a `start` property')
-    local end_ = assert(options.range['end'], 'range must have a `end` property')
-    params = util.make_given_range_params(start, end_)
-  elseif mode == 'v' or mode == 'V' then
-    local range = range_from_selection(0, mode)
-    params = util.make_given_range_params(range.start, range['end'])
-  else
-    params = util.make_range_params()
+  local bufnr = api.nvim_get_current_buf()
+  local win = api.nvim_get_current_win()
+  local clients = vim.lsp.get_clients({ bufnr = bufnr, method = ms.textDocument_codeAction })
+  local remaining = #clients
+  if remaining == 0 then
+    if next(vim.lsp.get_clients({ bufnr = bufnr })) then
+      vim.notify(vim.lsp._unsupported_method(ms.textDocument_codeAction), vim.log.levels.WARN)
+    end
+    return
+  end
+
+  ---@type table<integer, vim.lsp.CodeActionResultEntry>
+  local results = {}
+
+  ---@param err? lsp.ResponseError
+  ---@param result? (lsp.Command|lsp.CodeAction)[]
+  ---@param ctx lsp.HandlerContext
+  local function on_result(err, result, ctx)
+    results[ctx.client_id] = { error = err, result = result, ctx = ctx }
+    remaining = remaining - 1
+    if remaining == 0 then
+      on_code_action_results(results, options)
+    end
+  end
+
+  for _, client in ipairs(clients) do
+    ---@type lsp.CodeActionParams
+    local params
+    if options.range then
+      assert(type(options.range) == 'table', 'code_action range must be a table')
+      local start = assert(options.range.start, 'range must have a `start` property')
+      local end_ = assert(options.range['end'], 'range must have a `end` property')
+      params = util.make_given_range_params(start, end_, bufnr, client.offset_encoding)
+    elseif mode == 'v' or mode == 'V' then
+      local range = range_from_selection(bufnr, mode)
+      params =
+        util.make_given_range_params(range.start, range['end'], bufnr, client.offset_encoding)
+    else
+      params = util.make_range_params(win, client.offset_encoding)
+    end
+    params.context = context
+    client.request(ms.textDocument_codeAction, params, on_result, bufnr)
   end
-  params.context = context
-  code_action_request(params, options)
 end
 
 --- Executes an LSP server command.
-- 
cgit 


From e960fa2412948bfc8f059bff9ddb5397d7ee35d7 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 4 Nov 2023 11:40:10 +0100
Subject: vim-patch:2f54c13292af

runtime(script.vim): make strace ft check less strict (vim/vim#13482)

Strace output, depending on parameters (-ttf this time), can dump both
times and pid:
  1038  07:14:20.959262 execve("./e.py", ["./e.py"], 0x7ffca1422840 /* 51 vars */) = 0 <0.000150>

So loose the regexp matching this, so that the above is matched too.

Fixes vim/vim#13481.

https://github.com/vim/vim/commit/2f54c13292af053ec00c18e5fded87b1bc602822

Co-authored-by: Jiri Slaby <jirislaby@gmail.com>
Co-authored-by: Jiri Slaby (SUSE) <jirislaby@kernel.org>
---
 runtime/lua/vim/filetype/detect.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index 2232183888..5479608148 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -1798,7 +1798,7 @@ local patterns_text = {
   function(lines)
     if
       -- inaccurate fast match first, then use accurate slow match
-      (lines[1]:find('execve%(') and lines[1]:find('^[0-9:%.]* *execve%('))
+      (lines[1]:find('execve%(') and lines[1]:find('^[0-9:%. ]*execve%('))
       or lines[1]:find('^__libc_start_main')
     then
       return 'strace'
-- 
cgit 


From 6c150e0b9312ece13f13b7ff2e9743592bc9d431 Mon Sep 17 00:00:00 2001
From: L Lllvvuu <git@llllvvuu.dev>
Date: Wed, 27 Sep 2023 02:51:42 -0700
Subject: docs(treesitter): add disclaimer about needing to parse before
 `get_node()`

Problem:
---
Misuse of `get_node()` is common:
https://github.com/search?q=get_node_at_cursor+language%3Alua&type=code

Solution:
---
Add a note clarifying proper usage.
---
 runtime/lua/vim/treesitter.lua | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter.lua b/runtime/lua/vim/treesitter.lua
index f863942d3b..e7a66c00b2 100644
--- a/runtime/lua/vim/treesitter.lua
+++ b/runtime/lua/vim/treesitter.lua
@@ -350,6 +350,14 @@ end
 
 --- Returns the smallest named node at the given position
 ---
+--- NOTE: Calling this on an unparsed tree can yield an invalid node.
+--- If the tree is not known to be parsed by, e.g., an active highlighter,
+--- parse the tree first via
+---
+--- ```lua
+--- vim.treesitter.get_parser(bufnr):parse(range)
+--- ```
+---
 ---@param opts table|nil Optional keyword arguments:
 ---             - bufnr integer|nil Buffer number (nil or 0 for current buffer)
 ---             - pos table|nil 0-indexed (row, col) tuple. Defaults to cursor position in the
-- 
cgit 


From 56627ca2423e9d6084f87f5bc4639f06d10ecf91 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Mon, 6 Nov 2023 12:42:40 -0600
Subject: feat(tui): use TermResponse event for OSC responses (#25868)

When the terminal emulator sends an OSC sequence to Nvim (as a response
to another OSC sequence that was first sent by Nvim), populate the OSC
sequence in the v:termresponse variable and fire the TermResponse event.
The escape sequence is also included in the "data" field of the
autocommand callback when the autocommand is defined in Lua.

This makes use of the already documented but unimplemented TermResponse
event. This event exists in Vim but is only fired when Vim receives a
primary device attributes response.

Fixes: https://github.com/neovim/neovim/issues/25856
---
 runtime/lua/vim/_meta/api.lua | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 691da62f4f..0bee27970d 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -2059,6 +2059,17 @@ function vim.api.nvim_ui_set_focus(gained) end
 --- @param value any
 function vim.api.nvim_ui_set_option(name, value) end
 
+--- Tells Nvim when a terminal event has occurred.
+--- The following terminal events are supported:
+---
+--- • "osc_response": The terminal sent a OSC response sequence to Nvim. The
+---   payload is the received OSC sequence.
+---
+---
+--- @param event string Event name
+--- @param value any
+function vim.api.nvim_ui_term_event(event, value) end
+
 --- @param width integer
 --- @param height integer
 function vim.api.nvim_ui_try_resize(width, height) end
-- 
cgit 


From 3198038224209c41932a305e2a2dee708d4e3ec8 Mon Sep 17 00:00:00 2001
From: altermo <107814000+altermo@users.noreply.github.com>
Date: Tue, 7 Nov 2023 01:33:38 +0100
Subject: fix(lua): correct return value for on_key with no arguments (#25911)

---
 runtime/lua/vim/_editor.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 0da127b18f..0bdf0c90a5 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -650,7 +650,7 @@ local on_key_cbs = {}
 ---if on_key() is called without arguments.
 function vim.on_key(fn, ns_id)
   if fn == nil and ns_id == nil then
-    return #on_key_cbs
+    return vim.tbl_count(on_key_cbs)
   end
 
   vim.validate({
-- 
cgit 


From 748bc4d22d35b40f0795015e5d93113b526adf22 Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Mon, 30 Oct 2023 13:23:55 -0500
Subject: feat(clipboard): add OSC 52 clipboard support

This is opt-in as not all terminal emulators support OSC 52, so it is up
to the user to enable it explicitly.
---
 runtime/lua/vim/clipboard/osc52.lua | 38 +++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 runtime/lua/vim/clipboard/osc52.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/clipboard/osc52.lua b/runtime/lua/vim/clipboard/osc52.lua
new file mode 100644
index 0000000000..0e8f9d378f
--- /dev/null
+++ b/runtime/lua/vim/clipboard/osc52.lua
@@ -0,0 +1,38 @@
+local M = {}
+
+function M.copy(lines)
+  local s = table.concat(lines, '\n')
+  io.stdout:write(string.format('\x1b]52;;%s\x1b\\', vim.base64.encode(s)))
+end
+
+function M.paste()
+  local contents = nil
+  local id = vim.api.nvim_create_autocmd('TermResponse', {
+    callback = function(args)
+      local resp = args.data ---@type string
+      local encoded = resp:match('\x1b%]52;%w?;([A-Za-z0-9+/=]*)')
+      if encoded then
+        contents = vim.base64.decode(encoded)
+        return true
+      end
+    end,
+  })
+
+  io.stdout:write('\x1b]52;;?\x1b\\')
+
+  vim.wait(1000, function()
+    return contents ~= nil
+  end)
+
+  -- Delete the autocommand if it didn't already delete itself
+  pcall(vim.api.nvim_del_autocmd, id)
+
+  if contents then
+    return vim.split(contents, '\n')
+  end
+
+  vim.notify('Timed out waiting for a clipboard response from the terminal', vim.log.levels.WARN)
+  return 0
+end
+
+return M
-- 
cgit 


From 4e6f559b8c5f77924fdbe2e5abd9c6aa8efad13f Mon Sep 17 00:00:00 2001
From: Luuk van Baal <luukvbaal@gmail.com>
Date: Tue, 24 Oct 2023 13:32:00 +0200
Subject: feat(extmarks): add 'invalidate' property to extmarks

Problem:  No way to have extmarks automatically removed when the range it
          is attached to is deleted.
Solution: Add new 'invalidate' property that will hide a mark when the
          entirety of its range is deleted. When "undo_restore" is set
          to false, delete the mark from the buffer instead.
---
 runtime/lua/vim/_meta/api.lua         | 8 +++++++-
 runtime/lua/vim/_meta/api_keysets.lua | 2 ++
 2 files changed, 9 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 691da62f4f..6c6e11a0d3 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -554,6 +554,12 @@ function vim.api.nvim_buf_line_count(buffer) end
 ---                 the extmark end position (if it exists) will be shifted in
 ---                 when new text is inserted (true for right, false for
 ---                 left). Defaults to false.
+---               • undo_restore : Restore the exact position of the mark if
+---                 text around the mark was deleted and then restored by
+---                 undo. Defaults to true.
+---               • invalidate : boolean that indicates whether to hide the
+---                 extmark if the entirety of its range is deleted. If
+---                 "undo_restore" is false, the extmark is deleted instead.
 ---               • priority: a priority value for the highlight group or sign
 ---                 attribute. For example treesitter highlighting uses a
 ---                 value of 100.
@@ -1812,7 +1818,7 @@ function vim.api.nvim_set_current_win(window) end
 --- `nvim_buf_set_extmark()` can be called to add marks on a per-window or
 --- per-lines basis. Use the `ephemeral` key to only use the mark for the
 --- current screen redraw (the callback will be called again for the next
---- redraw ).
+--- redraw).
 --- Note: this function should not be called often. Rather, the callbacks
 --- themselves can be used to throttle unneeded callbacks. the `on_start`
 --- callback can return `false` to disable the provider until the next redraw.
diff --git a/runtime/lua/vim/_meta/api_keysets.lua b/runtime/lua/vim/_meta/api_keysets.lua
index 467409505e..f69e5a92c7 100644
--- a/runtime/lua/vim/_meta/api_keysets.lua
+++ b/runtime/lua/vim/_meta/api_keysets.lua
@@ -227,6 +227,7 @@ error('Cannot require a meta file')
 --- @field virt_text_hide? boolean
 --- @field hl_eol? boolean
 --- @field hl_mode? string
+--- @field invalidate? boolean
 --- @field ephemeral? boolean
 --- @field priority? integer
 --- @field right_gravity? boolean
@@ -243,6 +244,7 @@ error('Cannot require a meta file')
 --- @field conceal? string
 --- @field spell? boolean
 --- @field ui_watched? boolean
+--- @field undo_restore? boolean
 
 --- @class vim.api.keyset.user_command
 --- @field addr? any
-- 
cgit 


From 08847a9ea15a50aba041ee621d71b9884f5fea97 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 8 Nov 2023 09:33:37 -0600
Subject: refactor: move defaults into separate module (#25929)

Move default mappings and autocommands into a separate module and add
comments and docstrings to document each of the defaults.
---
 runtime/lua/vim/_defaults.lua | 166 ++++++++++++++++++++++++++++++++++++++++++
 runtime/lua/vim/_editor.lua   | 150 --------------------------------------
 2 files changed, 166 insertions(+), 150 deletions(-)
 create mode 100644 runtime/lua/vim/_defaults.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_defaults.lua b/runtime/lua/vim/_defaults.lua
new file mode 100644
index 0000000000..c1b50e6950
--- /dev/null
+++ b/runtime/lua/vim/_defaults.lua
@@ -0,0 +1,166 @@
+--- Default mappings
+do
+  --- Default maps for * and # in visual mode.
+  ---
+  --- See |v_star-default| and |v_#-default|
+  do
+    local function region_chunks(region)
+      local chunks = {}
+      local maxcol = vim.v.maxcol
+      for line, cols in vim.spairs(region) do
+        local endcol = cols[2] == maxcol and -1 or cols[2]
+        local chunk = vim.api.nvim_buf_get_text(0, line, cols[1], line, endcol, {})[1]
+        table.insert(chunks, chunk)
+      end
+      return chunks
+    end
+
+    local function _visual_search(cmd)
+      assert(cmd == '/' or cmd == '?')
+      local region = vim.region(
+        0,
+        '.',
+        'v',
+        vim.api.nvim_get_mode().mode:sub(1, 1),
+        vim.o.selection == 'inclusive'
+      )
+      local chunks = region_chunks(region)
+      local esc_chunks = vim
+        .iter(chunks)
+        :map(function(v)
+          return vim.fn.escape(v, cmd == '/' and [[/\]] or [[?\]])
+        end)
+        :totable()
+      local esc_pat = table.concat(esc_chunks, [[\n]])
+      local search_cmd = ([[%s\V%s%s]]):format(cmd, esc_pat, '\n')
+      return '\27' .. search_cmd
+    end
+
+    vim.keymap.set('x', '*', function()
+      return _visual_search('/')
+    end, { desc = ':help v_star-default', expr = true, silent = true })
+    vim.keymap.set('x', '#', function()
+      return _visual_search('?')
+    end, { desc = ':help v_#-default', expr = true, silent = true })
+  end
+
+  --- Map Y to y$. This mimics the behavior of D and C. See |Y-default|
+  vim.keymap.set('n', 'Y', 'y$', { desc = ':help Y-default' })
+
+  --- Use normal! <C-L> to prevent inserting raw <C-L> when using i_<C-O>. #17473
+  ---
+  --- See |CTRL-L-default|
+  vim.keymap.set('n', '<C-L>', '<Cmd>nohlsearch<Bar>diffupdate<Bar>normal! <C-L><CR>', {
+    desc = ':help CTRL-L-default',
+  })
+
+  --- Set undo points when deleting text in insert mode.
+  ---
+  --- See |i_CTRL-U-default| and |i_CTRL-W-default|
+  vim.keymap.set('i', '<C-U>', '<C-G>u<C-U>', { desc = ':help i_CTRL-U-default' })
+  vim.keymap.set('i', '<C-W>', '<C-G>u<C-W>', { desc = ':help i_CTRL-W-default' })
+
+  --- Use the same flags as the previous substitution with &.
+  ---
+  --- Use : instead of <Cmd> so that ranges are supported. #19365
+  ---
+  --- See |&-default|
+  vim.keymap.set('n', '&', ':&&<CR>', { desc = ':help &-default' })
+
+  --- Map |gx| to call |vim.ui.open| on the identifier under the cursor
+  do
+    -- TODO: use vim.region() when it lands... #13896 #16843
+    local function get_visual_selection()
+      local save_a = vim.fn.getreginfo('a')
+      vim.cmd([[norm! "ay]])
+      local selection = vim.fn.getreg('a', 1)
+      vim.fn.setreg('a', save_a)
+      return selection
+    end
+
+    local function do_open(uri)
+      local _, err = vim.ui.open(uri)
+      if err then
+        vim.notify(err, vim.log.levels.ERROR)
+      end
+    end
+
+    local gx_desc =
+      'Opens filepath or URI under cursor with the system handler (file explorer, web browser, …)'
+    vim.keymap.set({ 'n' }, 'gx', function()
+      do_open(vim.fn.expand('<cfile>'))
+    end, { desc = gx_desc })
+    vim.keymap.set({ 'x' }, 'gx', function()
+      do_open(get_visual_selection())
+    end, { desc = gx_desc })
+  end
+end
+
+--- Default menus
+do
+  --- Right click popup menu
+  -- TODO VimScript, no l10n
+  vim.cmd([[
+    aunmenu *
+    vnoremenu PopUp.Cut                     "+x
+    vnoremenu PopUp.Copy                    "+y
+    anoremenu PopUp.Paste                   "+gP
+    vnoremenu PopUp.Paste                   "+P
+    vnoremenu PopUp.Delete                  "_x
+    nnoremenu PopUp.Select\ All             ggVG
+    vnoremenu PopUp.Select\ All             gg0oG$
+    inoremenu PopUp.Select\ All             <C-Home><C-O>VG
+    anoremenu PopUp.-1-                     <Nop>
+    anoremenu PopUp.How-to\ disable\ mouse  <Cmd>help disable-mouse<CR>
+  ]])
+end
+
+--- Default autocommands. See |default-autocmds|
+do
+  local nvim_terminal_augroup = vim.api.nvim_create_augroup('nvim_terminal', {})
+  vim.api.nvim_create_autocmd('BufReadCmd', {
+    pattern = 'term://*',
+    group = nvim_terminal_augroup,
+    desc = 'Treat term:// buffers as terminal buffers',
+    nested = true,
+    command = "if !exists('b:term_title')|call termopen(matchstr(expand(\"<amatch>\"), '\\c\\mterm://\\%(.\\{-}//\\%(\\d\\+:\\)\\?\\)\\?\\zs.*'), {'cwd': expand(get(matchlist(expand(\"<amatch>\"), '\\c\\mterm://\\(.\\{-}\\)//'), 1, ''))})",
+  })
+
+  vim.api.nvim_create_autocmd({ 'TermClose' }, {
+    group = nvim_terminal_augroup,
+    desc = 'Automatically close terminal buffers when started with no arguments and exiting without an error',
+    callback = function(args)
+      if vim.v.event.status == 0 then
+        local info = vim.api.nvim_get_chan_info(vim.bo[args.buf].channel)
+        local argv = info.argv or {}
+        if #argv == 1 and argv[1] == vim.o.shell then
+          vim.cmd({ cmd = 'bdelete', args = { args.buf }, bang = true })
+        end
+      end
+    end,
+  })
+
+  vim.api.nvim_create_autocmd('CmdwinEnter', {
+    pattern = '[:>]',
+    desc = 'Limit syntax sync to maxlines=1 in the command window',
+    group = vim.api.nvim_create_augroup('nvim_cmdwin', {}),
+    command = 'syntax sync minlines=1 maxlines=1',
+  })
+
+  vim.api.nvim_create_autocmd('SwapExists', {
+    pattern = '*',
+    desc = 'Skip the swapfile prompt when the swapfile is owned by a running Nvim process',
+    group = vim.api.nvim_create_augroup('nvim_swapfile', {}),
+    callback = function()
+      local info = vim.fn.swapinfo(vim.v.swapname)
+      local user = vim.uv.os_get_passwd().username
+      local iswin = 1 == vim.fn.has('win32')
+      if info.error or info.pid <= 0 or (not iswin and info.user ~= user) then
+        vim.v.swapchoice = '' -- Show the prompt.
+        return
+      end
+      vim.v.swapchoice = 'e' -- Choose "(E)dit".
+      vim.notify(('W325: Ignoring swapfile from Nvim process %d'):format(info.pid))
+    end,
+  })
+end
diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 0bdf0c90a5..98a1ce79ed 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -1031,156 +1031,6 @@ function vim.deprecate(name, alternative, version, plugin, backtrace)
   return displayed and msg or nil
 end
 
---- Creates builtin mappings (incl. menus).
---- Called once on startup.
-function vim._init_default_mappings()
-  -- mappings
-
-  local function region_chunks(region)
-    local chunks = {}
-    local maxcol = vim.v.maxcol
-    for line, cols in vim.spairs(region) do
-      local endcol = cols[2] == maxcol and -1 or cols[2]
-      local chunk = vim.api.nvim_buf_get_text(0, line, cols[1], line, endcol, {})[1]
-      table.insert(chunks, chunk)
-    end
-    return chunks
-  end
-
-  local function _visual_search(cmd)
-    assert(cmd == '/' or cmd == '?')
-    local region = vim.region(
-      0,
-      '.',
-      'v',
-      vim.api.nvim_get_mode().mode:sub(1, 1),
-      vim.o.selection == 'inclusive'
-    )
-    local chunks = region_chunks(region)
-    local esc_chunks = vim
-      .iter(chunks)
-      :map(function(v)
-        return vim.fn.escape(v, cmd == '/' and [[/\]] or [[?\]])
-      end)
-      :totable()
-    local esc_pat = table.concat(esc_chunks, [[\n]])
-    local search_cmd = ([[%s\V%s%s]]):format(cmd, esc_pat, '\n')
-    return '\27' .. search_cmd
-  end
-
-  local function map(mode, lhs, rhs)
-    vim.keymap.set(mode, lhs, rhs, { desc = 'Nvim builtin' })
-  end
-
-  map('n', 'Y', 'y$')
-  -- Use normal! <C-L> to prevent inserting raw <C-L> when using i_<C-O>. #17473
-  map('n', '<C-L>', '<Cmd>nohlsearch<Bar>diffupdate<Bar>normal! <C-L><CR>')
-  map('i', '<C-U>', '<C-G>u<C-U>')
-  map('i', '<C-W>', '<C-G>u<C-W>')
-  vim.keymap.set('x', '*', function()
-    return _visual_search('/')
-  end, { desc = ':help v_star-default', expr = true, silent = true })
-  vim.keymap.set('x', '#', function()
-    return _visual_search('?')
-  end, { desc = ':help v_#-default', expr = true, silent = true })
-  -- Use : instead of <Cmd> so that ranges are supported. #19365
-  map('n', '&', ':&&<CR>')
-
-  -- gx
-
-  -- TODO: use vim.region() when it lands... #13896 #16843
-  local function get_visual_selection()
-    local save_a = vim.fn.getreginfo('a')
-    vim.cmd([[norm! "ay]])
-    local selection = vim.fn.getreg('a', 1)
-    vim.fn.setreg('a', save_a)
-    return selection
-  end
-
-  local function do_open(uri)
-    local _, err = vim.ui.open(uri)
-    if err then
-      vim.notify(err, vim.log.levels.ERROR)
-    end
-  end
-
-  local gx_desc =
-    'Opens filepath or URI under cursor with the system handler (file explorer, web browser, …)'
-  vim.keymap.set({ 'n' }, 'gx', function()
-    do_open(vim.fn.expand('<cfile>'))
-  end, { desc = gx_desc })
-  vim.keymap.set({ 'x' }, 'gx', function()
-    do_open(get_visual_selection())
-  end, { desc = gx_desc })
-
-  -- menus
-
-  -- TODO VimScript, no l10n
-  vim.cmd([[
-    aunmenu *
-    vnoremenu PopUp.Cut                     "+x
-    vnoremenu PopUp.Copy                    "+y
-    anoremenu PopUp.Paste                   "+gP
-    vnoremenu PopUp.Paste                   "+P
-    vnoremenu PopUp.Delete                  "_x
-    nnoremenu PopUp.Select\ All             ggVG
-    vnoremenu PopUp.Select\ All             gg0oG$
-    inoremenu PopUp.Select\ All             <C-Home><C-O>VG
-    anoremenu PopUp.-1-                     <Nop>
-    anoremenu PopUp.How-to\ disable\ mouse  <Cmd>help disable-mouse<CR>
-  ]])
-end
-
-function vim._init_default_autocmds()
-  local nvim_terminal_augroup = vim.api.nvim_create_augroup('nvim_terminal', {})
-  vim.api.nvim_create_autocmd({ 'BufReadCmd' }, {
-    pattern = 'term://*',
-    group = nvim_terminal_augroup,
-    nested = true,
-    command = "if !exists('b:term_title')|call termopen(matchstr(expand(\"<amatch>\"), '\\c\\mterm://\\%(.\\{-}//\\%(\\d\\+:\\)\\?\\)\\?\\zs.*'), {'cwd': expand(get(matchlist(expand(\"<amatch>\"), '\\c\\mterm://\\(.\\{-}\\)//'), 1, ''))})",
-  })
-  vim.api.nvim_create_autocmd({ 'TermClose' }, {
-    group = nvim_terminal_augroup,
-    desc = 'Automatically close terminal buffers when started with no arguments and exiting without an error',
-    callback = function(args)
-      if vim.v.event.status == 0 then
-        local info = vim.api.nvim_get_chan_info(vim.bo[args.buf].channel)
-        local argv = info.argv or {}
-        if #argv == 1 and argv[1] == vim.o.shell then
-          vim.cmd({ cmd = 'bdelete', args = { args.buf }, bang = true })
-        end
-      end
-    end,
-  })
-
-  vim.api.nvim_create_autocmd({ 'CmdwinEnter' }, {
-    pattern = '[:>]',
-    group = vim.api.nvim_create_augroup('nvim_cmdwin', {}),
-    command = 'syntax sync minlines=1 maxlines=1',
-  })
-
-  vim.api.nvim_create_autocmd({ 'SwapExists' }, {
-    pattern = '*',
-    group = vim.api.nvim_create_augroup('nvim_swapfile', {}),
-    callback = function()
-      local info = vim.fn.swapinfo(vim.v.swapname)
-      local user = vim.uv.os_get_passwd().username
-      local iswin = 1 == vim.fn.has('win32')
-      if info.error or info.pid <= 0 or (not iswin and info.user ~= user) then
-        vim.v.swapchoice = '' -- Show the prompt.
-        return
-      end
-      vim.v.swapchoice = 'e' -- Choose "(E)dit".
-      vim.notify(('W325: Ignoring swapfile from Nvim process %d'):format(info.pid))
-    end,
-  })
-end
-
-function vim._init_defaults()
-  vim._init_default_mappings()
-  vim._init_default_autocmds()
-end
-
 require('vim._options')
 
 -- Remove at Nvim 1.0
-- 
cgit 


From 3128cff6b198daabfddeedd382c0b8707319504f Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 8 Nov 2023 12:42:47 -0600
Subject: fix(clipboard): increase OSC 52 wait timeout (#25936)

When pasting with OSC 52 some terminals show a prompt to the user asking
for permission to read from the system clipboard. When this prompt
appears, 1s is not long enough to wait.

Increase the timeout to 10s and show a message to the user indicating
how to interrupt the wait after 1s.
---
 runtime/lua/vim/clipboard/osc52.lua | 36 +++++++++++++++++++++++++++++-------
 1 file changed, 29 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/clipboard/osc52.lua b/runtime/lua/vim/clipboard/osc52.lua
index 0e8f9d378f..78f5754c30 100644
--- a/runtime/lua/vim/clipboard/osc52.lua
+++ b/runtime/lua/vim/clipboard/osc52.lua
@@ -20,19 +20,41 @@ function M.paste()
 
   io.stdout:write('\x1b]52;;?\x1b\\')
 
-  vim.wait(1000, function()
+  local ok, res
+
+  -- Wait 1s first for terminals that respond quickly
+  ok, res = vim.wait(1000, function()
     return contents ~= nil
   end)
 
-  -- Delete the autocommand if it didn't already delete itself
-  pcall(vim.api.nvim_del_autocmd, id)
+  if res == -1 then
+    -- If no response was received after 1s, print a message and keep waiting
+    vim.api.nvim_echo(
+      { { 'Waiting for OSC 52 response from the terminal. Press Ctrl-C to interrupt...' } },
+      false,
+      {}
+    )
+    ok, res = vim.wait(9000, function()
+      return contents ~= nil
+    end)
+  end
 
-  if contents then
-    return vim.split(contents, '\n')
+  if not ok then
+    vim.api.nvim_del_autocmd(id)
+    if res == -1 then
+      vim.notify(
+        'Timed out waiting for a clipboard response from the terminal',
+        vim.log.levels.WARN
+      )
+    elseif res == -2 then
+      -- Clear message area
+      vim.api.nvim_echo({ { '' } }, false, {})
+    end
+    return 0
   end
 
-  vim.notify('Timed out waiting for a clipboard response from the terminal', vim.log.levels.WARN)
-  return 0
+  -- If we get here, contents should be non-nil
+  return vim.split(assert(contents), '\n')
 end
 
 return M
-- 
cgit 


From f7b2ea59a633309aba1ca5286e33d789a45cb13f Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 9 Nov 2023 06:34:34 +0800
Subject: vim-patch:9.0.2095: statusline may look different than expected
 (#25941)

Problem:  statusline may look different than expected
Solution: do not check for highlighting of stl and stlnc characters

statusline fillchar may be different than expected

If the highlighting group for the statusline for the current window
|hl-StatusLine| or the non-current window |hl-StatusLineNC| are cleared
(or do not differ from each other), than Vim will use the hard-coded
fallback values '^' (for the non-current windows) or '=' (for the
current window).  I believe this was done, to make sure the statusline
will always be visible and be distinguishable from the rest of the
window.

However, this may be unexpected, if a user explicitly defined those
fillchar characters just to notice that those values are then not used
by Vim.

So, let's assume users know what they are doing and just always return
the configured stl and stlnc values.  And if they want the statusline to
be non-distinguishable from the rest of the window space, so be it.  It
is their responsibility and Vim shall not know better what to use.

fixes: vim/vim#13366
closes: vim/vim#13488

https://github.com/vim/vim/commit/6a650bf696f1df3214b3d788947447c5bbf1a77d

Co-authored-by: Christian Brabandt <cb@256bit.org>
---
 runtime/lua/vim/_meta/options.lua | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index a986cd752c..53f7166b3d 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -2217,10 +2217,8 @@ vim.bo.ft = vim.bo.filetype
 ---
 --- Example:
 --- ```
----     :set fillchars=stl:^,stlnc:=,vert:│,fold:·,diff:-
+---     :set fillchars=stl:\ ,stlnc:\ ,vert:│,fold:·,diff:-
 --- ```
---- This is similar to the default, except that these characters will also
---- be used when there is highlighting.
 ---
 --- For the "stl", "stlnc", "foldopen", "foldclose" and "foldsep" items
 --- single-byte and multibyte characters are supported.  But double-width
-- 
cgit 


From a4b80c71eae09a5f6f76bce46be46efd247c7223 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 9 Nov 2023 15:17:53 +0800
Subject: vim-patch:8.2.4140: maparg() does not indicate the type of script

Problem:    maparg() does not indicate the type of script where it was defined.
Solution:   Add "scriptversion".

https://github.com/vim/vim/commit/a9528b39a666dbaa026320f73bae4b1628a7fe51

Co-authored-by: Bram Moolenaar <Bram@vim.org>
---
 runtime/lua/vim/_meta/vimfn.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 0563f9dd5f..817841eb46 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -5041,6 +5041,7 @@ function vim.fn.map(expr1, expr2) end
 ---          (|mapmode-ic|)
 ---   "sid"       The script local ID, used for <sid> mappings
 ---        (|<SID>|).  Negative for special contexts.
+---   "scriptversion"  The version of the script, always 1.
 ---   "lnum"     The line number in "sid", zero if unknown.
 ---   "nowait"   Do not wait for other, longer mappings.
 ---        (|:map-<nowait>|).
-- 
cgit 


From 2dfcd5a22b8f26091aa7398fdb8b0ea70ed7b28d Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 9 Nov 2023 18:16:49 +0800
Subject: vim-patch:8.2.4820: not simple programmatic way to find a specific
 mapping

Problem:    Not simple programmatic way to find a specific mapping.
Solution:   Add getmappings(). (Ernie Rael, closes vim/vim#10273)

https://github.com/vim/vim/commit/659c240cf769925ff432b88df8719e7ace4629b0

Co-authored-by: Ernie Rael <errael@raelity.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 817841eb46..f54606b225 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -3175,6 +3175,18 @@ function vim.fn.getline(lnum, end_) end
 --- @return any
 function vim.fn.getloclist(nr, what) end
 
+--- Returns a |List| of all mappings.  Each List item is a |Dict|,
+--- the same as what is returned by |maparg()|, see
+--- |mapping-dict|.
+---
+--- Example to show all mappings with "MultiMatch" in rhs: >
+---   echo getmappings()->filter({_, m ->
+---     \ match(get(m, 'rhs', ''), 'MultiMatch') >= 0
+---     \ })
+---
+--- @return any
+function vim.fn.getmappings() end
+
 --- Without the {buf} argument returns a |List| with information
 --- about all the global marks. |mark|
 ---
@@ -5022,7 +5034,7 @@ function vim.fn.map(expr1, expr2) end
 ---
 --- When {dict} is there and it is |TRUE| return a dictionary
 --- containing all the information of the mapping with the
---- following items:
+--- following items:      *mapping-dict*
 ---   "lhs"       The {lhs} of the mapping as it would be typed
 ---   "lhsraw"   The {lhs} of the mapping as raw bytes
 ---   "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate
-- 
cgit 


From d4dbfb092b370bced6728e07a38661a579ff5e4b Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 9 Nov 2023 19:36:58 +0800
Subject: vim-patch:8.2.4825: can only get a list of mappings

Problem:    Can only get a list of mappings.
Solution:   Add the optional {abbr} argument. (Ernie Rael, closes vim/vim#10277)
            Rename to maplist().  Rename test file.

https://github.com/vim/vim/commit/09661203ecefbee6a6f09438afcff1843e9dbfb4

Co-authored-by: Ernie Rael <errael@raelity.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 28 +++++++++++++++-------------
 1 file changed, 15 insertions(+), 13 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index f54606b225..3293b71977 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -3175,18 +3175,6 @@ function vim.fn.getline(lnum, end_) end
 --- @return any
 function vim.fn.getloclist(nr, what) end
 
---- Returns a |List| of all mappings.  Each List item is a |Dict|,
---- the same as what is returned by |maparg()|, see
---- |mapping-dict|.
----
---- Example to show all mappings with "MultiMatch" in rhs: >
----   echo getmappings()->filter({_, m ->
----     \ match(get(m, 'rhs', ''), 'MultiMatch') >= 0
----     \ })
----
---- @return any
-function vim.fn.getmappings() end
-
 --- Without the {buf} argument returns a |List| with information
 --- about all the global marks. |mark|
 ---
@@ -5006,7 +4994,8 @@ function vim.fn.map(expr1, expr2) end
 --- When {dict} is omitted or zero: Return the rhs of mapping
 --- {name} in mode {mode}.  The returned String has special
 --- characters translated like in the output of the ":map" command
---- listing.
+--- listing. When {dict} is TRUE a dictionary is returned, see
+--- below. To get a list of all mappings see |maplist()|.
 ---
 --- When there is no mapping for {name}, an empty String is
 --- returned if {dict} is FALSE, otherwise returns an empty Dict.
@@ -5112,6 +5101,19 @@ function vim.fn.maparg(name, mode, abbr, dict) end
 --- @return any
 function vim.fn.mapcheck(name, mode, abbr) end
 
+--- Returns a |List| of all mappings.  Each List item is a |Dict|,
+--- the same as what is returned by |maparg()|, see
+--- |mapping-dict|.  When {abbr} is there and it is |TRUE| use
+--- abbreviations instead of mappings.
+---
+--- Example to show all mappings with "MultiMatch" in rhs: >vim
+---   echo maplist()->filter({_, m ->
+---     \ match(get(m, 'rhs', ''), 'MultiMatch') >= 0
+---     \ })
+---
+--- @return any
+function vim.fn.maplist() end
+
 --- Like |map()| but instead of replacing items in {expr1} a new
 --- List or Dictionary is created and returned.  {expr1} remains
 --- unchanged.  Items can still be changed by {expr2}, if you
-- 
cgit 


From f748a73a357710db6094d4a428cd056f5df226a9 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 9 Nov 2023 19:48:50 +0800
Subject: vim-patch:8.2.4861: it is not easy to restore saved mappings

Problem:    It is not easy to restore saved mappings.
Solution:   Make mapset() accept a dict argument. (Ernie Rael, closes vim/vim#10295)

https://github.com/vim/vim/commit/51d04d16f21e19d6eded98f9530d84089102f925

Co-authored-by: Ernie Rael <errael@raelity.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 36 +++++++++++++++++++++++++++++-------
 1 file changed, 29 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 3293b71977..dea2e476b6 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -5046,6 +5046,7 @@ function vim.fn.map(expr1, expr2) end
 ---   "lnum"     The line number in "sid", zero if unknown.
 ---   "nowait"   Do not wait for other, longer mappings.
 ---        (|:map-<nowait>|).
+---   "abbr"     True if this is an |abbreviation|.
 ---
 --- The dictionary can be used to restore a mapping with
 --- |mapset()|.
@@ -5124,9 +5125,17 @@ function vim.fn.maplist() end
 --- @return any
 function vim.fn.mapnew(expr1, expr2) end
 
---- Restore a mapping from a dictionary returned by |maparg()|.
---- {mode} and {abbr} should be the same as for the call to
---- |maparg()|. *E460*
+--- Restore a mapping from a dictionary, possibly returned by
+--- |maparg()| or |maplist()|.  A buffer mapping, when dict.buffer
+--- is true, is set on the current buffer; it is up to the caller
+--- to ensure that the intended buffer is the current buffer. This
+--- feature allows copying mappings from one buffer to another.
+--- The dict.mode value may restore a single mapping that covers
+--- more than one mode, like with mode values of '!', ' ', "nox",
+--- or 'v'. *E1276*
+---
+--- In the first form, {mode} and {abbr} should be the same as
+--- for the call to |maparg()|. *E460*
 --- {mode} is used to define the mode in which the mapping is set,
 --- not the "mode" entry in {dict}.
 --- Example for saving and restoring a mapping: >vim
@@ -5135,12 +5144,25 @@ function vim.fn.mapnew(expr1, expr2) end
 ---   " ...
 ---   call mapset('n', 0, save_map)
 --- <Note that if you are going to replace a map in several modes,
---- e.g. with `:map!`, you need to save the mapping for all of
---- them, since they can differ.
+--- e.g. with `:map!`, you need to save/restore the mapping for
+--- all of them, when they might differ.
+---
+--- In the second form, with {dict} as the only argument, mode
+--- and abbr are taken from the dict.
+--- Example: >vim
+---   let save_maps = maplist()->filter(
+---         \ {_, m -> m.lhs == 'K'})
+---   nnoremap K somethingelse
+---   cnoremap K somethingelse2
+---   " ...
+---   unmap K
+---   for d in save_maps
+---       call mapset(d)
+---   endfor
 ---
 --- @param mode string
---- @param abbr any
---- @param dict any
+--- @param abbr? any
+--- @param dict? any
 --- @return any
 function vim.fn.mapset(mode, abbr, dict) end
 
-- 
cgit 


From 04d299c17014b0802c79613252e4de26da84a7c9 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Thu, 9 Nov 2023 20:42:55 +0800
Subject: vim-patch:8.2.4932: not easy to filter the output of maplist()

Problem:    Not easy to filter the output of maplist().
Solution:   Add mode_bits to the dictionary. (Ernie Rael, closes vim/vim#10356)

https://github.com/vim/vim/commit/d8f5f766219273a8579947cc80b92580b6988a4b

Co-authored-by: Ernie Rael <errael@raelity.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index dea2e476b6..d1e676ef70 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -5047,6 +5047,11 @@ function vim.fn.map(expr1, expr2) end
 ---   "nowait"   Do not wait for other, longer mappings.
 ---        (|:map-<nowait>|).
 ---   "abbr"     True if this is an |abbreviation|.
+---   "mode_bits" Nvim's internal binary representation of "mode".
+---        |mapset()| ignores this; only "mode" is used.
+---        See |maplist()| for usage examples. The values
+---        are from src/nvim/vim.h and may change in the
+---        future.
 ---
 --- The dictionary can be used to restore a mapping with
 --- |mapset()|.
@@ -5111,6 +5116,26 @@ function vim.fn.mapcheck(name, mode, abbr) end
 ---   echo maplist()->filter({_, m ->
 ---     \ match(get(m, 'rhs', ''), 'MultiMatch') >= 0
 ---     \ })
+--- <It can be tricky to find mappings for particular |:map-modes|.
+--- |mapping-dict|'s "mode_bits" can simplify this. For example,
+--- the mode_bits for Normal, Insert or Command-line modes are
+--- 0x19. To find all the mappings available in those modes you
+--- can do: >vim
+---   let saved_maps = []
+---   for m in maplist()
+---       if and(m.mode_bits, 0x19) != 0
+---     eval saved_maps->add(m)
+---       endif
+---   endfor
+---   echo saved_maps->mapnew({_, m -> m.lhs})
+--- <The values of the mode_bits are defined in Nvim's
+--- src/nvim/vim.h file and they can be discovered at runtime
+--- using |:map-commands| and "maplist()". Example: >vim
+---   omap xyzzy <Nop>
+---   let op_bit = maplist()->filter(
+---       \ {_, m -> m.lhs == 'xyzzy'})[0].mode_bits
+---   ounmap xyzzy
+---   echo printf("Operator-pending mode bit: 0x%x", op_bit)
 ---
 --- @return any
 function vim.fn.maplist() end
-- 
cgit 


From 84688ec3728dc73bea4d63e6a758c199e0884f00 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 11 Nov 2023 14:30:11 +0100
Subject: vim-patch:9.0.2097: No support for cypher files

Problem:  No support for cypher files
Solution: Add cypher filetype detection

Cypher query language support to work with (mostly) graph databases.

Already existing lsp support in Neovim's nvim-lspconfig:
https://github.com/neovim/nvim-lspconfig/blob/master/doc/server_configurations.md#cypher_ls

closes: vim/vim#13516

https://github.com/vim/vim/commit/8f0fe20ff1a13b468fdfaf85c434475f75c7a615

Co-authored-by: Gerrit Meier <meistermeier@gmail.com>
---
 runtime/lua/vim/filetype.lua | 1 +
 1 file changed, 1 insertion(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 35ad8e21b8..b418eba294 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -333,6 +333,7 @@ local extension = {
   pld = 'cupl',
   si = 'cuplsim',
   cyn = 'cynpp',
+  cypher = 'cypher',
   dart = 'dart',
   drt = 'dart',
   ds = 'datascript',
-- 
cgit 


From 2494009885b6d8073017ee3c7e16bcc1796c4c99 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Sun, 12 Nov 2023 07:49:57 +0800
Subject: vim-patch:1b08d2cd0789 (#25993)

runtime(doc): clarify when formatoptions applies

closes: vim/vim#13503

https://github.com/vim/vim/commit/1b08d2cd0789fd9aaae148a64ff46342730022d7

Co-authored-by: Christian Brabandt <cb@256bit.org>
---
 runtime/lua/vim/_meta/options.lua | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 53f7166b3d..a8299b31d7 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -2528,8 +2528,9 @@ vim.bo.formatlistpat = vim.o.formatlistpat
 vim.bo.flp = vim.bo.formatlistpat
 
 --- This is a sequence of letters which describes how automatic
---- formatting is to be done.  See `fo-table`.  Commas can be inserted for
---- readability.
+--- formatting is to be done.
+--- See `fo-table` for possible values and `gq` for how to format text.
+--- Commas can be inserted for readability.
 --- To avoid problems with flags that are added in the future, use the
 --- "+=" and "-=" feature of ":set" `add-option-flags`.
 ---
-- 
cgit 


From c23dd7c9eff035d92830bb33eb9644d946a65d92 Mon Sep 17 00:00:00 2001
From: ObserverOfTime <chronobserver@disroot.org>
Date: Sun, 12 Nov 2023 01:51:25 +0200
Subject: vim-patch:9.0.2098: No filetype support for xcompose files (#25983)

Problem:  No filetype support for xcompose files
Solution: Add filetype detection

closes: vim/vim#13508

https://github.com/vim/vim/commit/4f9074b96cc7efb1c829ca74902a851551dcf4e8
---
 runtime/lua/vim/filetype.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index b418eba294..aae63af132 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1521,6 +1521,8 @@ local filename = {
   wget2rc = 'wget2',
   ['.wvdialrc'] = 'wvdial',
   ['wvdial.conf'] = 'wvdial',
+  ['.XCompose'] = 'xcompose',
+  ['Compose'] = 'xcompose',
   ['.Xresources'] = 'xdefaults',
   ['.Xpdefaults'] = 'xdefaults',
   ['xdm-config'] = 'xdefaults',
-- 
cgit 


From 448907f65d6709fa234d8366053e33311a01bdb9 Mon Sep 17 00:00:00 2001
From: LW <git@llllvvuu.dev>
Date: Sun, 12 Nov 2023 04:54:27 -0800
Subject: feat(lsp)!: vim.lsp.inlay_hint.get(), enable(), is_enabled() #25512

refactor!: `vim.lsp.inlay_hint()` -> `vim.lsp.inlay_hint.enable()`

Problem:
The LSP specification allows inlay hints to include tooltips, clickable
label parts, and code actions; but Neovim provides no API to query for
these.

Solution:
Add minimal viable extension point from which plugins can query for
inlay hints in a range, in order to build functionality on top of.

Possible Next Steps
---

- Add `virt_text_idx` field to `vim.fn.getmousepos()` return value, for
  usage in mappings of `<LeftMouse>`, `<C-LeftMouse>`, etc
---
 runtime/lua/vim/lsp.lua            |   8 +-
 runtime/lua/vim/lsp/inlay_hint.lua | 163 +++++++++++++++++++++++++++++--------
 runtime/lua/vim/lsp/protocol.lua   |   7 +-
 3 files changed, 138 insertions(+), 40 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua
index 82a88772bd..261a3aa5de 100644
--- a/runtime/lua/vim/lsp.lua
+++ b/runtime/lua/vim/lsp.lua
@@ -24,6 +24,7 @@ local lsp = {
   buf = require('vim.lsp.buf'),
   diagnostic = require('vim.lsp.diagnostic'),
   codelens = require('vim.lsp.codelens'),
+  inlay_hint = require('vim.lsp.inlay_hint'),
   semantic_tokens = semantic_tokens,
   util = util,
 
@@ -2439,13 +2440,6 @@ function lsp.with(handler, override_config)
   end
 end
 
---- Enable/disable/toggle inlay hints for a buffer
----@param bufnr (integer) Buffer handle, or 0 for current
----@param enable (boolean|nil) true/false to enable/disable, nil to toggle
-function lsp.inlay_hint(bufnr, enable)
-  return require('vim.lsp.inlay_hint')(bufnr, enable)
-end
-
 --- Helper function to use when implementing a handler.
 --- This will check that all of the keys in the user configuration
 --- are valid keys and make sense to include for this handler.
diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index 7b58188c53..cdda5dcc17 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -98,6 +98,107 @@ function M.on_refresh(err, _, ctx, _)
   return vim.NIL
 end
 
+--- @class vim.lsp.inlay_hint.get.filter
+--- @field bufnr integer?
+--- @field range lsp.Range?
+---
+--- @class vim.lsp.inlay_hint.get.ret
+--- @field bufnr integer
+--- @field client_id integer
+--- @field inlay_hint lsp.InlayHint
+
+--- Get the list of inlay hints, (optionally) restricted by buffer, client, or range.
+---
+--- Example usage:
+---
+--- ```lua
+--- 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
+--- vim.lsp.util.apply_text_edits(resolved_hint.textEdits, 0, client.encoding)
+---
+--- location = resolved_hint.label[1].location
+--- client.request('textDocument/hover', {
+---   textDocument = { uri = location.uri },
+---   position = location.range.start,
+--- })
+--- ```
+---
+--- @param filter vim.lsp.inlay_hint.get.filter?
+--- Optional filters |kwargs|:
+--- - bufnr (integer?): 0 for current buffer
+--- - range (lsp.Range?)
+---
+--- @return vim.lsp.inlay_hint.get.ret[]
+--- Each list item is a table with the following fields:
+---  - bufnr (integer)
+---  - client_id (integer)
+---  - inlay_hint (lsp.InlayHint)
+function M.get(filter)
+  vim.validate({ filter = { filter, 'table', true } })
+  filter = filter or {}
+
+  local bufnr = filter.bufnr
+  if not bufnr then
+    --- @type vim.lsp.inlay_hint.get.ret[]
+    local hints = {}
+    --- @param buf integer
+    vim.tbl_map(function(buf)
+      vim.list_extend(hints, M.get(vim.tbl_extend('keep', { bufnr = buf }, filter)))
+    end, vim.api.nvim_list_bufs())
+    return hints
+  elseif bufnr == 0 then
+    bufnr = api.nvim_get_current_buf()
+  end
+
+  local bufstate = bufstates[bufnr]
+  if not (bufstate and bufstate.client_hint) then
+    return {}
+  end
+
+  local clients = vim.lsp.get_clients({
+    bufnr = bufnr,
+    method = ms.textDocument_inlayHint,
+  })
+  if #clients == 0 then
+    return {}
+  end
+
+  local range = filter.range
+  if not range then
+    range = {
+      start = { line = 0, character = 0 },
+      ['end'] = { line = api.nvim_buf_line_count(bufnr), character = 0 },
+    }
+  end
+
+  --- @type vim.lsp.inlay_hint.get.ret[]
+  local hints = {}
+  for _, client in pairs(clients) do
+    local hints_by_lnum = bufstate.client_hint[client.id]
+    if hints_by_lnum 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 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, {
+              bufnr = bufnr,
+              client_id = client.id,
+              inlay_hint = hint,
+            })
+          end
+        end
+      end
+    end
+  end
+  return hints
+end
+
 --- Clear inlay hints
 ---@param bufnr (integer) Buffer handle, or 0 for current
 local function clear(bufnr)
@@ -120,8 +221,8 @@ local function clear(bufnr)
 end
 
 --- Disable inlay hints for a buffer
----@param bufnr (integer) Buffer handle, or 0 for current
-local function disable(bufnr)
+---@param bufnr (integer|nil) Buffer handle, or 0 or nil for current
+local function _disable(bufnr)
   if bufnr == nil or bufnr == 0 then
     bufnr = api.nvim_get_current_buf()
   end
@@ -142,8 +243,8 @@ local function _refresh(bufnr, opts)
 end
 
 --- Enable inlay hints for a buffer
----@param bufnr (integer) Buffer handle, or 0 for current
-local function enable(bufnr)
+---@param bufnr (integer|nil) Buffer handle, or 0 or nil for current
+local function _enable(bufnr)
   if bufnr == nil or bufnr == 0 then
     bufnr = api.nvim_get_current_buf()
   end
@@ -175,7 +276,7 @@ local function enable(bufnr)
         end
       end,
       on_detach = function(_, cb_bufnr)
-        disable(cb_bufnr)
+        _disable(cb_bufnr)
       end,
     })
     api.nvim_create_autocmd('LspDetach', {
@@ -188,7 +289,7 @@ local function enable(bufnr)
             return c.id ~= args.data.client_id
           end)
         then
-          disable(bufnr)
+          _disable(bufnr)
         end
       end,
       group = augroup,
@@ -199,20 +300,6 @@ local function enable(bufnr)
   end
 end
 
---- Toggle inlay hints for a buffer
----@param bufnr (integer) Buffer handle, or 0 for current
-local function toggle(bufnr)
-  if bufnr == nil or bufnr == 0 then
-    bufnr = api.nvim_get_current_buf()
-  end
-  local bufstate = bufstates[bufnr]
-  if bufstate and bufstate.enabled then
-    disable(bufnr)
-  else
-    enable(bufnr)
-  end
-end
-
 api.nvim_set_decoration_provider(namespace, {
   on_win = function(_, _, bufnr, topline, botline)
     local bufstate = bufstates[bufnr]
@@ -260,15 +347,27 @@ api.nvim_set_decoration_provider(namespace, {
   end,
 })
 
-return setmetatable(M, {
-  __call = function(_, bufnr, enable_)
-    vim.validate({ enable = { enable_, { 'boolean', 'nil' } }, bufnr = { bufnr, 'number' } })
-    if enable_ then
-      enable(bufnr)
-    elseif enable_ == false then
-      disable(bufnr)
-    else
-      toggle(bufnr)
-    end
-  end,
-})
+--- @param bufnr (integer|nil) Buffer handle, or 0 or nil for current
+--- @return boolean
+function M.is_enabled(bufnr)
+  vim.validate({ bufnr = { bufnr, 'number', true } })
+  if bufnr == nil or bufnr == 0 then
+    bufnr = api.nvim_get_current_buf()
+  end
+  return bufstates[bufnr] and bufstates[bufnr].enabled or false
+end
+
+--- Enable/disable/toggle inlay hints for a buffer
+---
+--- @param bufnr (integer|nil) Buffer handle, or 0 or nil for current
+--- @param enable (boolean|nil) true/nil to enable, false to disable
+function M.enable(bufnr, enable)
+  vim.validate({ enable = { enable, 'boolean', true }, bufnr = { bufnr, 'number', true } })
+  if enable == false then
+    _disable(bufnr)
+  else
+    _enable(bufnr)
+  end
+end
+
+return M
diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index 7a48c800c6..e2396e9a5f 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -648,7 +648,12 @@ function protocol.make_client_capabilities()
       inlayHint = {
         dynamicRegistration = true,
         resolveSupport = {
-          properties = {},
+          properties = {
+            'textEdits',
+            'tooltip',
+            'location',
+            'command',
+          },
         },
       },
       semanticTokens = {
-- 
cgit 


From 6d14f3ddab33144966e46487b6039440ac7c43f2 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 13 Nov 2023 06:33:34 +0800
Subject: vim-patch:9.0.2103: recursive callback may cause issues on some archs
 (#26013)

Problem:  recursive callback may cause issues on some archs
Solution: Decrease the limit drastically to 20

Recursive callback limit causes problems on some architectures

Since commit 47510f3d6598a1218958c03ed11337a43b73f48d we have a test
that causes a recursive popup callback function to be executed. However
it seems the current limit of 'maxfuncdepth' option value is still too
recursive for some 32bit architectures (e.g. 32bit ARM).

So instead of allowing a default limit of 100 (default value for
'maxfuncdepth'), let's reduce this limit to 20. I don't think there is a
use case where one would need such a high recursive callback limit and a
limit of 20 seems reasonable (although it is currently hard-coded).

closes: vim/vim#13495
closes: vim/vim#13502

https://github.com/vim/vim/commit/2076463e383901cef44685aaf4b63e4306444f9e

Co-authored-by: Christian Brabandt <cb@256bit.org>
---
 runtime/lua/vim/_meta/options.lua | 1 -
 1 file changed, 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index a8299b31d7..0ef0fece90 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -4037,7 +4037,6 @@ vim.go.mat = vim.go.matchtime
 --- Increasing this limit above 200 also changes the maximum for Ex
 --- command recursion, see `E169`.
 --- See also `:function`.
---- Also used for maximum depth of callback functions.
 ---
 --- @type integer
 vim.o.maxfuncdepth = 100
-- 
cgit 


From d2983dcdb1ca003b5fd42d7d99fd98310aa1cd56 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Mon, 13 Nov 2023 07:27:45 +0800
Subject: fix(clipboard): make osc52 work with PUC Lua (#26014)

---
 runtime/lua/vim/clipboard/osc52.lua | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/clipboard/osc52.lua b/runtime/lua/vim/clipboard/osc52.lua
index 78f5754c30..035a6abb86 100644
--- a/runtime/lua/vim/clipboard/osc52.lua
+++ b/runtime/lua/vim/clipboard/osc52.lua
@@ -2,7 +2,7 @@ local M = {}
 
 function M.copy(lines)
   local s = table.concat(lines, '\n')
-  io.stdout:write(string.format('\x1b]52;;%s\x1b\\', vim.base64.encode(s)))
+  io.stdout:write(string.format('\027]52;;%s\027\\', vim.base64.encode(s)))
 end
 
 function M.paste()
@@ -10,7 +10,7 @@ function M.paste()
   local id = vim.api.nvim_create_autocmd('TermResponse', {
     callback = function(args)
       local resp = args.data ---@type string
-      local encoded = resp:match('\x1b%]52;%w?;([A-Za-z0-9+/=]*)')
+      local encoded = resp:match('\027%]52;%w?;([A-Za-z0-9+/=]*)')
       if encoded then
         contents = vim.base64.decode(encoded)
         return true
@@ -18,7 +18,7 @@ function M.paste()
     end,
   })
 
-  io.stdout:write('\x1b]52;;?\x1b\\')
+  io.stdout:write('\027]52;;?\027\\')
 
   local ok, res
 
-- 
cgit 


From 48bcc7b9710d6db619b05254ea87f4087cdd9764 Mon Sep 17 00:00:00 2001
From: Chris Simon <chris@devcycles.io>
Date: Tue, 14 Nov 2023 05:39:43 +1100
Subject: fix(lsp): advertise workspace.didChangeConfiguration capability
 (#26028)

This ensures workspace/didChangeConfiguration notification sent after init is correctly handled
---
 runtime/lua/vim/lsp/protocol.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/protocol.lua b/runtime/lua/vim/lsp/protocol.lua
index e2396e9a5f..a7c3914834 100644
--- a/runtime/lua/vim/lsp/protocol.lua
+++ b/runtime/lua/vim/lsp/protocol.lua
@@ -855,6 +855,9 @@ function protocol.make_client_capabilities()
         },
       },
       configuration = true,
+      didChangeConfiguration = {
+        dynamicRegistration = false,
+      },
       workspaceFolders = true,
       applyEdit = true,
       workspaceEdit = {
-- 
cgit 


From ab102f188e86bdbfce1d4de2ef633092a906e8fe Mon Sep 17 00:00:00 2001
From: Gregory Anders <greg@gpanders.com>
Date: Mon, 6 Nov 2023 15:46:44 -0600
Subject: refactor: move background color detection into Lua

---
 runtime/lua/vim/_defaults.lua | 130 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 130 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_defaults.lua b/runtime/lua/vim/_defaults.lua
index c1b50e6950..0d7b4f1884 100644
--- a/runtime/lua/vim/_defaults.lua
+++ b/runtime/lua/vim/_defaults.lua
@@ -164,3 +164,133 @@ do
     end,
   })
 end
+
+--- Guess value of 'background' based on terminal color.
+---
+--- We write Operating System Command (OSC) 11 to the terminal to request the
+--- terminal's background color. We then wait for a response. If the response
+--- matches `rgba:RRRR/GGGG/BBBB/AAAA` where R, G, B, and A are hex digits, then
+--- compute the luminance[1] of the RGB color and classify it as light/dark
+--- accordingly. Note that the color components may have anywhere from one to
+--- four hex digits, and require scaling accordingly as values out of 4, 8, 12,
+--- or 16 bits. Also note the A(lpha) component is optional, and is parsed but
+--- ignored in the calculations.
+---
+--- [1] https://en.wikipedia.org/wiki/Luma_%28video%29
+do
+  --- Parse a string of hex characters as a color.
+  ---
+  --- The string can contain 1 to 4 hex characters. The returned value is
+  --- between 0.0 and 1.0 (inclusive) representing the intensity of the color.
+  ---
+  --- For instance, if only a single hex char "a" is used, then this function
+  --- returns 0.625 (10 / 16), while a value of "aa" would return 0.664 (170 /
+  --- 256).
+  ---
+  --- @param c string Color as a string of hex chars
+  --- @return number? Intensity of the color
+  local function parsecolor(c)
+    local len = #c
+    assert(len > 0 and len <= 4, 'Invalid hex color string')
+    if not c:match('^0x') then
+      c = string.format('0x%s', c)
+    end
+
+    local max = tonumber(string.format('0x%s', string.rep('f', len)))
+    return tonumber(c) / max
+  end
+
+  --- Parse an OSC 11 response
+  ---
+  --- Either of the two formats below are accepted:
+  ---
+  ---   OSC 11 ; rgb:<red>/<green>/<blue>
+  ---
+  --- or
+  ---
+  ---   OSC 11 ; rgba:<red>/<green>/<blue>/<alpha>
+  ---
+  --- where
+  ---
+  ---   <red>, <green>, <blue>, <alpha> := h | hh | hhh | hhhh
+  ---
+  --- The alpha component is ignored, if present.
+  ---
+  --- @param resp string OSC 11 response
+  --- @return string? Red component
+  --- @return string? Green component
+  --- @return string? Blue component
+  local function parseosc11(resp)
+    local r, g, b
+    r, g, b = resp:match('^\027%]11;rgb:(%x+)/(%x+)/(%x+)$')
+    if not r and not g and not b then
+      local a
+      r, g, b, a = resp:match('^\027%]11;rgba:(%x+)/(%x+)/(%x+)/(%x+)$')
+      if not a or #a > 4 then
+        return nil, nil, nil
+      end
+    end
+
+    if r and g and b and #r <= 4 and #g <= 4 and #b <= 4 then
+      return r, g, b
+    end
+
+    return nil, nil, nil
+  end
+
+  local tty = false
+  for _, ui in ipairs(vim.api.nvim_list_uis()) do
+    if ui.chan == 1 and ui.stdout_tty then
+      tty = true
+      break
+    end
+  end
+
+  if tty then
+    local timer = assert(vim.uv.new_timer())
+
+    local id = vim.api.nvim_create_autocmd('TermResponse', {
+      nested = true,
+      callback = function(args)
+        if vim.api.nvim_get_option_info2('background', {}).was_set then
+          -- Don't do anything if 'background' is already set
+          timer:stop()
+          timer:close()
+          return true
+        end
+
+        local resp = args.data ---@type string
+        local r, g, b = parseosc11(resp)
+        if r and g and b then
+          local rr = parsecolor(r)
+          local gg = parsecolor(g)
+          local bb = parsecolor(b)
+
+          if rr and gg and bb then
+            local luminance = (0.299 * rr) + (0.587 * gg) + (0.114 * bb)
+            local bg = luminance < 0.5 and 'dark' or 'light'
+            if bg ~= vim.o.background then
+              vim.o.background = bg
+            end
+          end
+
+          timer:stop()
+          timer:close()
+
+          return true
+        end
+      end,
+    })
+
+    io.stdout:write('\027]11;?\027\\')
+
+    timer:start(1000, 0, function()
+      -- No response received. Delete the autocommand
+      vim.schedule(function()
+        -- Suppress error if autocommand has already been deleted
+        pcall(vim.api.nvim_del_autocmd, id)
+      end)
+      timer:close()
+    end)
+  end
+end
-- 
cgit 


From b73a829837bbc05840ae00cbe514fb1786695614 Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Tue, 14 Nov 2023 05:15:45 -0800
Subject: refactor: vim.ui.clipboard #26040

Problem:
Platform-specific UI providers should live in `vim.ui.*`. #24164

Solution:
- Move `vim.clipboard.osc52` module to `vim.ui.clipboard.osc52`.
- TODO: move all of `clipboard.vim` to `vim.ui.clipboard`.

ref #25872
---
 runtime/lua/vim/clipboard/osc52.lua    | 60 ----------------------------------
 runtime/lua/vim/ui/clipboard/osc52.lua | 60 ++++++++++++++++++++++++++++++++++
 2 files changed, 60 insertions(+), 60 deletions(-)
 delete mode 100644 runtime/lua/vim/clipboard/osc52.lua
 create mode 100644 runtime/lua/vim/ui/clipboard/osc52.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/clipboard/osc52.lua b/runtime/lua/vim/clipboard/osc52.lua
deleted file mode 100644
index 035a6abb86..0000000000
--- a/runtime/lua/vim/clipboard/osc52.lua
+++ /dev/null
@@ -1,60 +0,0 @@
-local M = {}
-
-function M.copy(lines)
-  local s = table.concat(lines, '\n')
-  io.stdout:write(string.format('\027]52;;%s\027\\', vim.base64.encode(s)))
-end
-
-function M.paste()
-  local contents = nil
-  local id = vim.api.nvim_create_autocmd('TermResponse', {
-    callback = function(args)
-      local resp = args.data ---@type string
-      local encoded = resp:match('\027%]52;%w?;([A-Za-z0-9+/=]*)')
-      if encoded then
-        contents = vim.base64.decode(encoded)
-        return true
-      end
-    end,
-  })
-
-  io.stdout:write('\027]52;;?\027\\')
-
-  local ok, res
-
-  -- Wait 1s first for terminals that respond quickly
-  ok, res = vim.wait(1000, function()
-    return contents ~= nil
-  end)
-
-  if res == -1 then
-    -- If no response was received after 1s, print a message and keep waiting
-    vim.api.nvim_echo(
-      { { 'Waiting for OSC 52 response from the terminal. Press Ctrl-C to interrupt...' } },
-      false,
-      {}
-    )
-    ok, res = vim.wait(9000, function()
-      return contents ~= nil
-    end)
-  end
-
-  if not ok then
-    vim.api.nvim_del_autocmd(id)
-    if res == -1 then
-      vim.notify(
-        'Timed out waiting for a clipboard response from the terminal',
-        vim.log.levels.WARN
-      )
-    elseif res == -2 then
-      -- Clear message area
-      vim.api.nvim_echo({ { '' } }, false, {})
-    end
-    return 0
-  end
-
-  -- If we get here, contents should be non-nil
-  return vim.split(assert(contents), '\n')
-end
-
-return M
diff --git a/runtime/lua/vim/ui/clipboard/osc52.lua b/runtime/lua/vim/ui/clipboard/osc52.lua
new file mode 100644
index 0000000000..035a6abb86
--- /dev/null
+++ b/runtime/lua/vim/ui/clipboard/osc52.lua
@@ -0,0 +1,60 @@
+local M = {}
+
+function M.copy(lines)
+  local s = table.concat(lines, '\n')
+  io.stdout:write(string.format('\027]52;;%s\027\\', vim.base64.encode(s)))
+end
+
+function M.paste()
+  local contents = nil
+  local id = vim.api.nvim_create_autocmd('TermResponse', {
+    callback = function(args)
+      local resp = args.data ---@type string
+      local encoded = resp:match('\027%]52;%w?;([A-Za-z0-9+/=]*)')
+      if encoded then
+        contents = vim.base64.decode(encoded)
+        return true
+      end
+    end,
+  })
+
+  io.stdout:write('\027]52;;?\027\\')
+
+  local ok, res
+
+  -- Wait 1s first for terminals that respond quickly
+  ok, res = vim.wait(1000, function()
+    return contents ~= nil
+  end)
+
+  if res == -1 then
+    -- If no response was received after 1s, print a message and keep waiting
+    vim.api.nvim_echo(
+      { { 'Waiting for OSC 52 response from the terminal. Press Ctrl-C to interrupt...' } },
+      false,
+      {}
+    )
+    ok, res = vim.wait(9000, function()
+      return contents ~= nil
+    end)
+  end
+
+  if not ok then
+    vim.api.nvim_del_autocmd(id)
+    if res == -1 then
+      vim.notify(
+        'Timed out waiting for a clipboard response from the terminal',
+        vim.log.levels.WARN
+      )
+    elseif res == -2 then
+      -- Clear message area
+      vim.api.nvim_echo({ { '' } }, false, {})
+    end
+    return 0
+  end
+
+  -- If we get here, contents should be non-nil
+  return vim.split(assert(contents), '\n')
+end
+
+return M
-- 
cgit 


From ac8ed77afb359694a716501d9e87b0c9949b2445 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Tue, 14 Nov 2023 08:53:58 -0600
Subject: feat(tui): add 'termsync' option (#25871)

The 'termsync' option enables a mode (provided the underlying terminal
supports it) where all screen updates during a redraw cycle are buffered
and drawn together when the redraw is complete. This eliminates tearing
or flickering in cases where Nvim redraws slower than the terminal
redraws the screen.
---
 runtime/lua/vim/_meta/options.lua | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 0ef0fece90..19ae786177 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -6978,6 +6978,15 @@ vim.o.tpf = vim.o.termpastefilter
 vim.go.termpastefilter = vim.o.termpastefilter
 vim.go.tpf = vim.go.termpastefilter
 
+--- If the host terminal supports it, buffer all screen updates
+--- made during a redraw cycle so that each screen is displayed in
+--- the terminal all at once. This can prevent tearing or flickering
+--- when the terminal updates faster than Nvim can redraw.
+---
+--- @type boolean
+vim.o.termsync = true
+vim.go.termsync = vim.o.termsync
+
 --- Maximum width of text that is being inserted.  A longer line will be
 --- broken after white space to get this width.  A zero value disables
 --- this.
-- 
cgit 


From 9e2248ab586c5e5854da68b5310755ea3557e6c9 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Tue, 14 Nov 2023 17:38:46 +0100
Subject: vim-patch:9.0.2104: wast filetype should be replaced by wat filetype

Problem:  wast filetype should be replaced by wat filetype
Solution: start using the official wat filetype name

runtime: rename `wast` filetype to `wat` (Wasm text format)

The problem is the name of the current filetype wast. When the plugin
was initially created, the file extension for Wasm text format was not
fixed and .wast was more popular.

However, recently .wat became the official file extension for
WebAssembly text (WAT) format and .wast is now a file extension for the
unofficial WAST format, which is a superset of .wat for the convenience
to describe the Wasm specification conformance tests.

https://webassembly.js.org/docs/contrib-wat-vs-wast.html

However for now, let's keep using the `wat` filetype even for the .wast
extension, so that we at least do not lose the filetype settings and
syntax highlighting. This can be adjusted later, if it turns out to have
a separate need for.

closes: vim/vim#13533

https://github.com/vim/vim/commit/bc8f79d36a456054ed29f46585830af6d71f57c8

Co-authored-by: rhysd <lin90162@yahoo.co.jp>
---
 runtime/lua/vim/filetype.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index aae63af132..217f673b5e 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -1074,7 +1074,7 @@ local extension = {
   wrl = 'vrml',
   vroom = 'vroom',
   vue = 'vue',
-  wast = 'wast',
+  wast = 'wat',
   wat = 'wat',
   wdl = 'wdl',
   wm = 'webmacro',
-- 
cgit 


From ba58c6f8a44c9c37e97fce1d802dc5b5defceb3d Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Tue, 14 Nov 2023 17:02:57 -0600
Subject: fix: only attempt to close timer if not already closing (#26047)

This fixes an error that can occur in certain pathological cases when
the autocommand fires at just the right time such that it attempts to
close the timer after the timer has already exited, but before the
scheduled callback has fired.

We now let the timer continue to run even when the autocommand deletes
itself to avoid having to repeat the cleanup code multiple times. There
is no harm in letting the timer execute if the autocommand does not
exist, as the pcall will catch the error.
---
 runtime/lua/vim/_defaults.lua | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_defaults.lua b/runtime/lua/vim/_defaults.lua
index 0d7b4f1884..870603c9f3 100644
--- a/runtime/lua/vim/_defaults.lua
+++ b/runtime/lua/vim/_defaults.lua
@@ -254,8 +254,6 @@ do
       callback = function(args)
         if vim.api.nvim_get_option_info2('background', {}).was_set then
           -- Don't do anything if 'background' is already set
-          timer:stop()
-          timer:close()
           return true
         end
 
@@ -274,9 +272,6 @@ do
             end
           end
 
-          timer:stop()
-          timer:close()
-
           return true
         end
       end,
@@ -290,7 +285,10 @@ do
         -- Suppress error if autocommand has already been deleted
         pcall(vim.api.nvim_del_autocmd, id)
       end)
-      timer:close()
+
+      if not timer:is_closing() then
+        timer:close()
+      end
     end)
   end
 end
-- 
cgit 


From b4b7ca2d548a1cc1a2cd8c48e5c93478811bd275 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Thu, 16 Nov 2023 11:12:42 -0600
Subject: feat(tui): support DCS responses in TermResponse event (#26061)

---
 runtime/lua/vim/_meta/api.lua | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 2142a429a2..0c8979054f 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -2065,11 +2065,12 @@ function vim.api.nvim_ui_set_focus(gained) end
 --- @param value any
 function vim.api.nvim_ui_set_option(name, value) end
 
---- Tells Nvim when a terminal event has occurred.
+--- Tells Nvim when a terminal event has occurred
 --- The following terminal events are supported:
 ---
---- • "osc_response": The terminal sent a OSC response sequence to Nvim. The
----   payload is the received OSC sequence.
+--- • "termresponse": The terminal sent an OSC or DCS response sequence to
+---   Nvim. The payload is the received response. Sets `v:termresponse` and
+---   fires `TermResponse`.
 ---
 ---
 --- @param event string Event name
-- 
cgit 


From 4bf47222c973c4bc935d6fde106329f8a0e103e3 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Thu, 16 Nov 2023 11:35:54 -0600
Subject: feat: add vim.text module (#26069)

---
 runtime/lua/vim/_init_packages.lua |  1 +
 runtime/lua/vim/text.lua           | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 33 insertions(+)
 create mode 100644 runtime/lua/vim/text.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_init_packages.lua b/runtime/lua/vim/_init_packages.lua
index 8750afba34..4a961970cc 100644
--- a/runtime/lua/vim/_init_packages.lua
+++ b/runtime/lua/vim/_init_packages.lua
@@ -57,6 +57,7 @@ vim._submodules = {
   fs = true,
   iter = true,
   re = true,
+  text = true,
 }
 
 -- These are for loading runtime modules in the vim namespace lazily.
diff --git a/runtime/lua/vim/text.lua b/runtime/lua/vim/text.lua
new file mode 100644
index 0000000000..cfb0f9b821
--- /dev/null
+++ b/runtime/lua/vim/text.lua
@@ -0,0 +1,32 @@
+--- Text processing functions.
+
+local M = {}
+
+--- Hex encode a string.
+---
+--- @param str string String to encode
+--- @return string Hex encoded string
+function M.hexencode(str)
+  local bytes = { str:byte(1, #str) }
+  local enc = {} ---@type string[]
+  for i = 1, #bytes do
+    enc[i] = string.format('%02X', bytes[i])
+  end
+  return table.concat(enc)
+end
+
+--- Hex decode a string.
+---
+--- @param enc string String to decode
+--- @return string Decoded string
+function M.hexdecode(enc)
+  assert(#enc % 2 == 0, 'string must have an even number of hex characters')
+  local str = {} ---@type string[]
+  for i = 1, #enc, 2 do
+    local n = assert(tonumber(enc:sub(i, i + 1), 16))
+    str[#str + 1] = string.char(n)
+  end
+  return table.concat(str)
+end
+
+return M
-- 
cgit 


From db57df04b6af03ad9dd0447ffc8e881c97a39732 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Thu, 16 Nov 2023 12:21:24 -0600
Subject: feat(clipboard): enable OSC 52 clipboard provider by default (#26064)

Use the XTGETTCAP sequence to determine if the host terminal supports
the OSC 52 sequence and, if it does, enable the OSC 52 clipboard
provider by default.

This is only done automatically when all of the following are true:

  1. Nvim is running in the TUI
  2. 'clipboard' is not set to unnamed or unnamedplus
  3. g:clipboard is unset
  4. Nvim is running in an SSH connection ($SSH_TTY is set)
  5. Nvim is not running inside tmux ($TMUX is unset)
---
 runtime/lua/vim/termcap.lua            |  60 ++++++++++++++++++
 runtime/lua/vim/ui/clipboard/osc52.lua | 107 +++++++++++++++++++--------------
 2 files changed, 121 insertions(+), 46 deletions(-)
 create mode 100644 runtime/lua/vim/termcap.lua

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/termcap.lua b/runtime/lua/vim/termcap.lua
new file mode 100644
index 0000000000..0eefc5eee4
--- /dev/null
+++ b/runtime/lua/vim/termcap.lua
@@ -0,0 +1,60 @@
+local M = {}
+
+--- Query the host terminal emulator for terminfo capabilities.
+---
+--- This function sends the XTGETTCAP DCS sequence to the host terminal emulator asking the terminal
+--- to send us its terminal capabilities. These are strings that are normally taken from a terminfo
+--- file, however an up to date terminfo database is not always available (particularly on remote
+--- machines), and many terminals continue to misidentify themselves or do not provide their own
+--- terminfo file, making the terminfo database unreliable.
+---
+--- Querying the terminal guarantees that we get a truthful answer, but only if the host terminal
+--- emulator supports the XTGETTCAP sequence.
+---
+--- @param caps string|table A terminal capability or list of capabilities to query
+--- @param cb function(cap:string, seq:string) Function to call when a response is received
+function M.query(caps, cb)
+  vim.validate({
+    caps = { caps, { 'string', 'table' } },
+    cb = { cb, 'f' },
+  })
+
+  if type(caps) ~= 'table' then
+    caps = { caps }
+  end
+
+  local count = #caps
+
+  vim.api.nvim_create_autocmd('TermResponse', {
+    callback = function(args)
+      local resp = args.data ---@type string
+      local k, v = resp:match('^\027P1%+r(%x+)=(%x+)$')
+      if k and v then
+        local cap = vim.text.hexdecode(k)
+        local seq =
+          vim.text.hexdecode(v):gsub('\\E', '\027'):gsub('%%p%d', ''):gsub('\\(%d+)', string.char)
+
+        -- TODO: When libtermkey is patched to accept BEL as an OSC terminator, this workaround can
+        -- be removed
+        seq = seq:gsub('\007$', '\027\\')
+
+        cb(cap, seq)
+
+        count = count - 1
+        if count == 0 then
+          return true
+        end
+      end
+    end,
+  })
+
+  local encoded = {} ---@type string[]
+  for i = 1, #caps do
+    encoded[i] = vim.text.hexencode(caps[i])
+  end
+
+  local query = string.format('\027P+q%s\027\\', table.concat(encoded, ';'))
+  io.stdout:write(query)
+end
+
+return M
diff --git a/runtime/lua/vim/ui/clipboard/osc52.lua b/runtime/lua/vim/ui/clipboard/osc52.lua
index 035a6abb86..f1d454010f 100644
--- a/runtime/lua/vim/ui/clipboard/osc52.lua
+++ b/runtime/lua/vim/ui/clipboard/osc52.lua
@@ -1,60 +1,75 @@
 local M = {}
 
-function M.copy(lines)
-  local s = table.concat(lines, '\n')
-  io.stdout:write(string.format('\027]52;;%s\027\\', vim.base64.encode(s)))
+--- Return the OSC 52 escape sequence
+---
+--- @param clipboard string The clipboard to read from or write to
+--- @param contents string The Base64 encoded contents to write to the clipboard, or '?' to read
+---                        from the clipboard
+local function osc52(clipboard, contents)
+  return string.format('\027]52;%s;%s\027\\', clipboard, contents)
 end
 
-function M.paste()
-  local contents = nil
-  local id = vim.api.nvim_create_autocmd('TermResponse', {
-    callback = function(args)
-      local resp = args.data ---@type string
-      local encoded = resp:match('\027%]52;%w?;([A-Za-z0-9+/=]*)')
-      if encoded then
-        contents = vim.base64.decode(encoded)
-        return true
-      end
-    end,
-  })
-
-  io.stdout:write('\027]52;;?\027\\')
-
-  local ok, res
-
-  -- Wait 1s first for terminals that respond quickly
-  ok, res = vim.wait(1000, function()
-    return contents ~= nil
-  end)
-
-  if res == -1 then
-    -- If no response was received after 1s, print a message and keep waiting
-    vim.api.nvim_echo(
-      { { 'Waiting for OSC 52 response from the terminal. Press Ctrl-C to interrupt...' } },
-      false,
-      {}
-    )
-    ok, res = vim.wait(9000, function()
+function M.copy(reg)
+  local clipboard = reg == '+' and 'c' or 's'
+  return function(lines)
+    local s = table.concat(lines, '\n')
+    io.stdout:write(osc52(clipboard, vim.base64.encode(s)))
+  end
+end
+
+function M.paste(reg)
+  local clipboard = reg == '+' and 'c' or 's'
+  return function()
+    local contents = nil
+    local id = vim.api.nvim_create_autocmd('TermResponse', {
+      callback = function(args)
+        local resp = args.data ---@type string
+        local encoded = resp:match('\027%]52;%w?;([A-Za-z0-9+/=]*)')
+        if encoded then
+          contents = vim.base64.decode(encoded)
+          return true
+        end
+      end,
+    })
+
+    io.stdout:write(osc52(clipboard, '?'))
+
+    local ok, res
+
+    -- Wait 1s first for terminals that respond quickly
+    ok, res = vim.wait(1000, function()
       return contents ~= nil
     end)
-  end
 
-  if not ok then
-    vim.api.nvim_del_autocmd(id)
     if res == -1 then
-      vim.notify(
-        'Timed out waiting for a clipboard response from the terminal',
-        vim.log.levels.WARN
+      -- If no response was received after 1s, print a message and keep waiting
+      vim.api.nvim_echo(
+        { { 'Waiting for OSC 52 response from the terminal. Press Ctrl-C to interrupt...' } },
+        false,
+        {}
       )
-    elseif res == -2 then
-      -- Clear message area
-      vim.api.nvim_echo({ { '' } }, false, {})
+      ok, res = vim.wait(9000, function()
+        return contents ~= nil
+      end)
+    end
+
+    if not ok then
+      vim.api.nvim_del_autocmd(id)
+      if res == -1 then
+        vim.notify(
+          'Timed out waiting for a clipboard response from the terminal',
+          vim.log.levels.WARN
+        )
+      elseif res == -2 then
+        -- Clear message area
+        vim.api.nvim_echo({ { '' } }, false, {})
+      end
+      return 0
     end
-    return 0
-  end
 
-  -- If we get here, contents should be non-nil
-  return vim.split(assert(contents), '\n')
+    -- If we get here, contents should be non-nil
+    return vim.split(assert(contents), '\n')
+  end
 end
 
 return M
-- 
cgit 


From 2f64546dc1cf0816b032af2ce7ded72ce4e581b3 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Thu, 16 Nov 2023 12:25:50 -0600
Subject: refactor: use optional base argument of tonumber (#26070)

---
 runtime/lua/vim/_defaults.lua | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_defaults.lua b/runtime/lua/vim/_defaults.lua
index 870603c9f3..09d6d43e7a 100644
--- a/runtime/lua/vim/_defaults.lua
+++ b/runtime/lua/vim/_defaults.lua
@@ -190,14 +190,17 @@ do
   --- @param c string Color as a string of hex chars
   --- @return number? Intensity of the color
   local function parsecolor(c)
-    local len = #c
-    assert(len > 0 and len <= 4, 'Invalid hex color string')
-    if not c:match('^0x') then
-      c = string.format('0x%s', c)
+    if #c == 0 or #c > 4 then
+      return nil
     end
 
-    local max = tonumber(string.format('0x%s', string.rep('f', len)))
-    return tonumber(c) / max
+    local val = tonumber(c, 16)
+    if not val then
+      return nil
+    end
+
+    local max = tonumber(string.rep('f', #c), 16)
+    return val / max
   end
 
   --- Parse an OSC 11 response
-- 
cgit 


From 86c2213b5e451b0c80c2d7adc356c7cebe4bb7f8 Mon Sep 17 00:00:00 2001
From: Tomasz N <przepompownia@users.noreply.github.com>
Date: Fri, 17 Nov 2023 02:52:22 +0100
Subject: fix(osc52): use `p` for primary selection instead of `s` (#26076)

Co-authored-by: Gregory Anders <greg@gpanders.com>
---
 runtime/lua/vim/ui/clipboard/osc52.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/ui/clipboard/osc52.lua b/runtime/lua/vim/ui/clipboard/osc52.lua
index f1d454010f..6483f0387d 100644
--- a/runtime/lua/vim/ui/clipboard/osc52.lua
+++ b/runtime/lua/vim/ui/clipboard/osc52.lua
@@ -10,7 +10,7 @@ local function osc52(clipboard, contents)
 end
 
 function M.copy(reg)
-  local clipboard = reg == '+' and 'c' or 's'
+  local clipboard = reg == '+' and 'c' or 'p'
   return function(lines)
     local s = table.concat(lines, '\n')
     io.stdout:write(osc52(clipboard, vim.base64.encode(s)))
@@ -18,7 +18,7 @@ function M.copy(reg)
 end
 
 function M.paste(reg)
-  local clipboard = reg == '+' and 'c' or 's'
+  local clipboard = reg == '+' and 'c' or 'p'
   return function()
     local contents = nil
     local id = vim.api.nvim_create_autocmd('TermResponse', {
-- 
cgit 


From b522cb1ac3fbdf6e68eed5d0b6e1cbeaf3ac2254 Mon Sep 17 00:00:00 2001
From: bfredl <bjorn.linse@gmail.com>
Date: Mon, 6 Nov 2023 14:52:27 +0100
Subject: refactor(grid): make screen rendering more multibyte than ever before

Problem: buffer text with composing chars are converted from UTF-8
to an array of up to seven UTF-32 values and then converted back
to UTF-8 strings.

Solution: Convert buffer text directly to UTF-8 based schar_T values.

The limit of the text size is now in schar_T bytes, which is currently
31+1 but easily could be raised as it no longer multiplies the size
of the entire screen grid when not used, the full size is only required
for temporary scratch buffers.

Also does some general cleanup to win_line text handling, which was
unnecessarily complicated due to multibyte rendering being an "opt-in"
feature long ago. Nowadays, a char is just a char, regardless if it consists
of one ASCII byte or multiple bytes.
---
 runtime/lua/vim/_meta/options.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 19ae786177..be4a4dd49c 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -2576,7 +2576,7 @@ vim.go.fp = vim.go.formatprg
 --- security reasons.
 ---
 --- @type boolean
-vim.o.fsync = false
+vim.o.fsync = true
 vim.o.fs = vim.o.fsync
 vim.go.fsync = vim.o.fsync
 vim.go.fs = vim.go.fsync
-- 
cgit 


From c4afb9788c4f139eb2e3b7aa4d6a6a20b67ba156 Mon Sep 17 00:00:00 2001
From: Luuk van Baal <luukvbaal@gmail.com>
Date: Sat, 11 Nov 2023 00:52:50 +0100
Subject: refactor(sign): move legacy signs to extmarks

Problem:  The legacy signlist data structures and associated functions are
          redundant since the introduction of extmark signs.
Solution: Store signs defined through the legacy commands in a hashmap, placed
          signs in the extmark tree. Replace signlist associated functions.

Usage of the legacy sign commands should yield no change in behavior with the
exception of:
  - "orphaned signs" are now always removed when the line it is placed on is
    deleted. This used to depend on the value of 'signcolumn'.
  - It is no longer possible to place multiple signs with the same identifier
    in a single group on multiple lines. This will now move the sign instead.

Moreover, both signs placed through the legacy sign commands and through
|nvim_buf_set_extmark()|:
  - Will show up in both |sign-place| and |nvim_buf_get_extmarks()|.
  - Are displayed by increasing sign identifier, left to right.
    Extmark signs used to be ordered decreasingly as opposed to legacy signs.
---
 runtime/lua/vim/_meta/api.lua     | 4 ++--
 runtime/lua/vim/_meta/options.lua | 6 ------
 2 files changed, 2 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 2142a429a2..70a8b0aec2 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -317,8 +317,8 @@ function vim.api.nvim_buf_get_commands(buffer, opts) end
 --- @return integer[]
 function vim.api.nvim_buf_get_extmark_by_id(buffer, ns_id, id, opts) end
 
---- Gets `extmarks` in "traversal order" from a `charwise` region defined by
---- buffer positions (inclusive, 0-indexed `api-indexing`).
+--- Gets `extmarks` (including `signs`) in "traversal order" from a `charwise`
+--- region defined by buffer positions (inclusive, 0-indexed `api-indexing`).
 --- Region can be given as (row,col) tuples, or valid extmark ids (whose
 --- positions define the bounds). 0 and -1 are understood as (0,0) and (-1,-1)
 --- respectively, thus the following are equivalent:
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 19ae786177..6d693ca036 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -5923,12 +5923,6 @@ vim.go.siso = vim.go.sidescrolloff
 ---    "number"	display signs in the 'number' column. If the number
 --- 		column is not present, then behaves like "auto".
 ---
---- Note regarding "orphaned signs": with signcolumn numbers higher than
---- 1, deleting lines will also remove the associated signs automatically,
---- in contrast to the default Vim behavior of keeping and grouping them.
---- This is done in order for the signcolumn appearance not appear weird
---- during line deletion.
----
 --- @type string
 vim.o.signcolumn = "auto"
 vim.o.scl = vim.o.signcolumn
-- 
cgit 


From 7e36c8e972f0b2e07c6186aa5dca2f70d95a77f2 Mon Sep 17 00:00:00 2001
From: Maria José Solano <majosolano99@gmail.com>
Date: Thu, 26 Oct 2023 22:53:38 -0700
Subject: feat(lsp): support for choice snippet nodes

---
 runtime/lua/vim/snippet.lua | 72 ++++++++++++++++++++++++++++++---------------
 1 file changed, 49 insertions(+), 23 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/snippet.lua b/runtime/lua/vim/snippet.lua
index 94c69795a4..32a8ea0b0d 100644
--- a/runtime/lua/vim/snippet.lua
+++ b/runtime/lua/vim/snippet.lua
@@ -104,8 +104,9 @@ end
 
 --- @class vim.snippet.Tabstop
 --- @field extmark_id integer
---- @field index integer
 --- @field bufnr integer
+--- @field index integer
+--- @field choices? string[]
 local Tabstop = {}
 
 --- Creates a new tabstop.
@@ -114,8 +115,9 @@ local Tabstop = {}
 --- @param index integer
 --- @param bufnr integer
 --- @param range Range4
+--- @param choices? string[]
 --- @return vim.snippet.Tabstop
-function Tabstop.new(index, bufnr, range)
+function Tabstop.new(index, bufnr, range, choices)
   local extmark_id = vim.api.nvim_buf_set_extmark(bufnr, snippet_ns, range[1], range[2], {
     right_gravity = false,
     end_right_gravity = true,
@@ -125,7 +127,7 @@ function Tabstop.new(index, bufnr, range)
   })
 
   local self = setmetatable(
-    { index = index, bufnr = bufnr, extmark_id = extmark_id },
+    { extmark_id = extmark_id, bufnr = bufnr, index = index, choices = choices },
     { __index = Tabstop }
   )
 
@@ -173,9 +175,9 @@ local Session = {}
 --- @package
 --- @param bufnr integer
 --- @param snippet_extmark integer
---- @param tabstop_ranges table<integer, Range4[]>
+--- @param tabstop_data table<integer, { range: Range4, choices?: string[] }[]>
 --- @return vim.snippet.Session
-function Session.new(bufnr, snippet_extmark, tabstop_ranges)
+function Session.new(bufnr, snippet_extmark, tabstop_data)
   local self = setmetatable({
     bufnr = bufnr,
     extmark_id = snippet_extmark,
@@ -184,10 +186,10 @@ function Session.new(bufnr, snippet_extmark, tabstop_ranges)
   }, { __index = Session })
 
   -- Create the tabstops.
-  for index, ranges in pairs(tabstop_ranges) do
-    for _, range in ipairs(ranges) do
+  for index, ranges in pairs(tabstop_data) do
+    for _, data in ipairs(ranges) do
       self.tabstops[index] = self.tabstops[index] or {}
-      table.insert(self.tabstops[index], Tabstop.new(index, self.bufnr, range))
+      table.insert(self.tabstops[index], Tabstop.new(index, self.bufnr, data.range, data.choices))
     end
   end
 
@@ -222,6 +224,22 @@ end
 --- @field private _session? vim.snippet.Session
 local M = { session = nil }
 
+--- Displays the choices for the given tabstop as completion items.
+---
+--- @param tabstop vim.snippet.Tabstop
+local function display_choices(tabstop)
+  assert(tabstop.choices, 'Tabstop has no choices')
+
+  local start_col = tabstop:get_range()[2] + 1
+  local matches = vim.iter.map(function(choice)
+    return { word = choice }
+  end, tabstop.choices)
+
+  vim.defer_fn(function()
+    vim.fn.complete(start_col, matches)
+  end, 100)
+end
+
 --- Select the given tabstop range.
 ---
 --- @param tabstop vim.snippet.Tabstop
@@ -246,17 +264,25 @@ local function select_tabstop(tabstop)
   local range = tabstop:get_range()
   local mode = vim.fn.mode()
 
+  if vim.fn.pumvisible() ~= 0 then
+    -- Close the choice completion menu if open.
+    vim.fn.complete(vim.fn.col('.'), {})
+  end
+
   -- Move the cursor to the start of the tabstop.
   vim.api.nvim_win_set_cursor(0, { range[1] + 1, range[2] })
 
-  -- For empty and the final tabstop, start insert mode at the end of the range.
-  if tabstop.index == 0 or (range[1] == range[3] and range[2] == range[4]) then
+  -- For empty, choice and the final tabstops, start insert mode at the end of the range.
+  if tabstop.choices or tabstop.index == 0 or (range[1] == range[3] and range[2] == range[4]) then
     if mode ~= 'i' then
       if mode == 's' then
         feedkeys('<Esc>')
       end
       vim.cmd.startinsert({ bang = range[4] >= #vim.api.nvim_get_current_line() })
     end
+    if tabstop.choices then
+      display_choices(tabstop)
+    end
   else
     -- Else, select the tabstop's text.
     if mode ~= 'n' then
@@ -297,7 +323,6 @@ local function setup_autocmds(bufnr)
         return true
       end
 
-      -- Update the current tabstop to be the one containing the cursor.
       for tabstop_index, tabstops in pairs(M._session.tabstops) do
         for _, tabstop in ipairs(tabstops) do
           local range = tabstop:get_range()
@@ -305,7 +330,6 @@ local function setup_autocmds(bufnr)
             (cursor_row > range[1] or (cursor_row == range[1] and cursor_col >= range[2]))
             and (cursor_row < range[3] or (cursor_row == range[3] and cursor_col <= range[4]))
           then
-            M._session.current_tabstop = tabstop
             if tabstop_index ~= 0 then
               return
             end
@@ -377,14 +401,16 @@ function M.expand(input)
   end
 
   -- Keep track of tabstop nodes during expansion.
-  --- @type table<integer, Range4[]>
-  local tabstop_ranges = {}
+  --- @type table<integer, { range: Range4, choices?: string[] }[]>
+  local tabstop_data = {}
 
   --- @param index integer
-  --- @param placeholder string?
-  local function add_tabstop(index, placeholder)
-    tabstop_ranges[index] = tabstop_ranges[index] or {}
-    table.insert(tabstop_ranges[index], compute_tabstop_range(snippet_text, placeholder))
+  --- @param placeholder? string
+  --- @param choices? string[]
+  local function add_tabstop(index, placeholder, choices)
+    tabstop_data[index] = tabstop_data[index] or {}
+    local range = compute_tabstop_range(snippet_text, placeholder)
+    table.insert(tabstop_data[index], { range = range, choices = choices })
   end
 
   --- Appends the given text to the snippet, taking care of indentation.
@@ -428,7 +454,7 @@ function M.expand(input)
       append_to_snippet(value)
     elseif type == G.NodeType.Choice then
       --- @cast data vim.snippet.ChoiceData
-      append_to_snippet(data.values[1])
+      add_tabstop(data.tabstop, nil, data.values)
     elseif type == G.NodeType.Variable then
       --- @cast data vim.snippet.VariableData
       -- Try to get the variable's value.
@@ -436,7 +462,7 @@ function M.expand(input)
       if not value then
         -- Unknown variable, make this a tabstop and use the variable name as a placeholder.
         value = data.name
-        local tabstop_indexes = vim.tbl_keys(tabstop_ranges)
+        local tabstop_indexes = vim.tbl_keys(tabstop_data)
         local index = math.max(unpack((#tabstop_indexes == 0 and { 0 }) or tabstop_indexes)) + 1
         add_tabstop(index, value)
       end
@@ -449,8 +475,8 @@ function M.expand(input)
 
   -- $0, which defaults to the end of the snippet, defines the final cursor position.
   -- Make sure the snippet has exactly one of these.
-  if vim.tbl_contains(vim.tbl_keys(tabstop_ranges), 0) then
-    assert(#tabstop_ranges[0] == 1, 'Snippet has multiple $0 tabstops')
+  if vim.tbl_contains(vim.tbl_keys(tabstop_data), 0) then
+    assert(#tabstop_data[0] == 1, 'Snippet has multiple $0 tabstops')
   else
     add_tabstop(0)
   end
@@ -469,7 +495,7 @@ function M.expand(input)
     right_gravity = false,
     end_right_gravity = true,
   })
-  M._session = Session.new(bufnr, snippet_extmark, tabstop_ranges)
+  M._session = Session.new(bufnr, snippet_extmark, tabstop_data)
 
   -- Jump to the first tabstop.
   M.jump(1)
-- 
cgit 


From de28a0f84c577e264f37cd001b03d640db7d5ef9 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Sun, 19 Nov 2023 14:25:32 +0100
Subject: perf(lsp): replace file polling on linux with per dir watcher 
 (#26108)

Should help with https://github.com/neovim/neovim/issues/23291

On linux `new_fs_event` doesn't support recursive watching, but we can
still use it to watch folders.

The downside of this approach is that we may end up sending some false
`Deleted` events. For example, if you save a file named `foo` there will
be a intermediate `foo~` due to the save mechanism of neovim.

The events we get from vim.uv in that case are:

- rename: foo~
- rename: foo~
- rename: foo
- rename: foo
- change: foo
- change: foo

The mechanism in this PR uses a debounce to reduce this to:

- deleted: foo~
- changed: foo

`foo~` will be the false positive.
I suspect that for the LSP case this is good enough. If not, we may need
to follow up on this and keep a table in memory that tracks available
files.
---
 runtime/lua/vim/_watch.lua | 208 +++++++++++++++++++++++----------------------
 1 file changed, 106 insertions(+), 102 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_watch.lua b/runtime/lua/vim/_watch.lua
index 7230b31f6f..7870e1e867 100644
--- a/runtime/lua/vim/_watch.lua
+++ b/runtime/lua/vim/_watch.lua
@@ -1,11 +1,15 @@
 local M = {}
+local uv = vim.uv
 
---- Enumeration describing the types of events watchers will emit.
-M.FileChangeType = vim.tbl_add_reverse_lookup({
+---@enum vim._watch.FileChangeType
+local FileChangeType = {
   Created = 1,
   Changed = 2,
   Deleted = 3,
-})
+}
+
+--- Enumeration describing the types of events watchers will emit.
+M.FileChangeType = vim.tbl_add_reverse_lookup(FileChangeType)
 
 --- Joins filepath elements by static '/' separator
 ---
@@ -72,120 +76,120 @@ function M.watch(path, opts, callback)
   end
 end
 
-local default_poll_interval_ms = 2000
-
---- @class watch.Watches
---- @field is_dir boolean
---- @field children? table<string,watch.Watches>
---- @field cancel? fun()
---- @field started? boolean
---- @field handle? uv.uv_fs_poll_t
-
 --- @class watch.PollOpts
---- @field interval? integer
---- @field include_pattern? userdata
---- @field exclude_pattern? userdata
+--- @field debounce? integer
+--- @field include_pattern? vim.lpeg.Pattern
+--- @field exclude_pattern? vim.lpeg.Pattern
 
---- Implementation for poll, hiding internally-used parameters.
----
 ---@param path string
 ---@param opts watch.PollOpts
----@param callback fun(patch: string, filechangetype: integer)
----@param watches (watch.Watches|nil) A tree structure to maintain state for recursive watches.
----     - handle (uv_fs_poll_t)
----               The libuv handle
----     - cancel (function)
----               A function that cancels the handle and all children's handles
----     - is_dir (boolean)
----               Indicates whether the path is a directory (and the poll should
----               be invoked recursively)
----     - children (table|nil)
----               A mapping of directory entry name to its recursive watches
----     - started (boolean|nil)
----               Whether or not the watcher has first been initialized. Used
----               to prevent a flood of Created events on startup.
----@return fun() Cancel function
-local function poll_internal(path, opts, callback, watches)
-  path = vim.fs.normalize(path)
-  local interval = opts and opts.interval or default_poll_interval_ms
-  watches = watches or {
-    is_dir = true,
-  }
-  watches.cancel = function()
-    if watches.children then
-      for _, w in pairs(watches.children) do
-        w.cancel()
-      end
-    end
-    if watches.handle then
-      stop(watches.handle)
-    end
+---@param callback function Called on new events
+---@return function cancel stops the watcher
+local function recurse_watch(path, opts, callback)
+  opts = opts or {}
+  local debounce = opts.debounce or 500
+  local uvflags = {}
+  ---@type table<string, uv.uv_fs_event_t> handle by fullpath
+  local handles = {}
+
+  local timer = assert(uv.new_timer())
+
+  ---@type table[]
+  local changesets = {}
+
+  local function is_included(filepath)
+    return opts.include_pattern and opts.include_pattern:match(filepath)
   end
-
-  local function incl_match()
-    return not opts.include_pattern or opts.include_pattern:match(path) ~= nil
-  end
-  local function excl_match()
-    return opts.exclude_pattern and opts.exclude_pattern:match(path) ~= nil
+  local function is_excluded(filepath)
+    return opts.exclude_pattern and opts.exclude_pattern:match(filepath)
   end
-  if not watches.is_dir and not incl_match() or excl_match() then
-    return watches.cancel
+
+  local process_changes = function()
+    assert(false, "Replaced later. I'm only here as forward reference")
   end
 
-  if not watches.handle then
-    local poll, new_err = vim.uv.new_fs_poll()
-    assert(not new_err, new_err)
-    watches.handle = poll
-    local _, start_err = poll:start(
-      path,
-      interval,
-      vim.schedule_wrap(function(err)
-        if err == 'ENOENT' then
-          return
-        end
-        assert(not err, err)
-        poll_internal(path, opts, callback, watches)
-        callback(path, M.FileChangeType.Changed)
-      end)
-    )
-    assert(not start_err, start_err)
-    if watches.started then
-      callback(path, M.FileChangeType.Created)
+  local function create_on_change(filepath)
+    return function(err, filename, events)
+      assert(not err, err)
+      local fullpath = vim.fs.joinpath(filepath, filename)
+      if is_included(fullpath) and not is_excluded(filepath) then
+        table.insert(changesets, {
+          fullpath = fullpath,
+          events = events,
+        })
+        timer:start(debounce, 0, process_changes)
+      end
     end
   end
 
-  if watches.is_dir then
-    watches.children = watches.children or {}
-    local exists = {} --- @type table<string,true>
-    for name, ftype in vim.fs.dir(path) do
-      exists[name] = true
-      if not watches.children[name] then
-        watches.children[name] = {
-          is_dir = ftype == 'directory',
-          started = watches.started,
-        }
-        poll_internal(filepath_join(path, name), opts, callback, watches.children[name])
+  process_changes = function()
+    ---@type table<string, table[]>
+    local filechanges = vim.defaulttable()
+    for i, change in ipairs(changesets) do
+      changesets[i] = nil
+      if is_included(change.fullpath) and not is_excluded(change.fullpath) then
+        table.insert(filechanges[change.fullpath], change.events)
       end
     end
-
-    local newchildren = {} ---@type table<string,watch.Watches>
-    for name, watch in pairs(watches.children) do
-      if exists[name] then
-        newchildren[name] = watch
+    for fullpath, events_list in pairs(filechanges) do
+      local stat = uv.fs_stat(fullpath)
+      ---@type vim._watch.FileChangeType
+      local change_type
+      if stat then
+        change_type = FileChangeType.Created
+        for _, event in ipairs(events_list) do
+          if event.change then
+            change_type = FileChangeType.Changed
+          end
+        end
+        if stat.type == 'directory' then
+          local handle = handles[fullpath]
+          if not handle then
+            handle = assert(uv.new_fs_event())
+            handles[fullpath] = handle
+            handle:start(fullpath, uvflags, create_on_change(fullpath))
+          end
+        end
       else
-        watch.cancel()
-        watches.children[name] = nil
-        if watch.handle then
-          callback(path .. '/' .. name, M.FileChangeType.Deleted)
+        local handle = handles[fullpath]
+        if handle then
+          if not handle:is_closing() then
+            handle:close()
+          end
+          handles[fullpath] = nil
         end
+        change_type = FileChangeType.Deleted
       end
+      callback(fullpath, change_type)
     end
-    watches.children = newchildren
   end
-
-  watches.started = true
-
-  return watches.cancel
+  local root_handle = assert(uv.new_fs_event())
+  handles[path] = root_handle
+  root_handle:start(path, uvflags, create_on_change(path))
+
+  --- "640K ought to be enough for anyone"
+  --- Who has folders this deep?
+  local max_depth = 100
+
+  for name, type in vim.fs.dir(path, { depth = max_depth }) do
+    local filepath = vim.fs.joinpath(path, name)
+    if type == 'directory' and not is_excluded(filepath) then
+      local handle = assert(uv.new_fs_event())
+      handles[filepath] = handle
+      handle:start(filepath, uvflags, create_on_change(filepath))
+    end
+  end
+  local function cancel()
+    for fullpath, handle in pairs(handles) do
+      if not handle:is_closing() then
+        handle:close()
+      end
+      handles[fullpath] = nil
+    end
+    timer:stop()
+    timer:close()
+  end
+  return cancel
 end
 
 --- Initializes and starts a |uv_fs_poll_t| recursively watching every file underneath the
@@ -193,8 +197,8 @@ end
 ---
 ---@param path (string) The path to watch. Must refer to a directory.
 ---@param opts (table|nil) Additional options
----     - interval (number|nil)
----                Polling interval in ms as passed to |uv.fs_poll_start()|. Defaults to 2000.
+---     - debounce (number|nil)
+---                Time events are debounced in ms. Defaults to 500
 ---     - include_pattern (LPeg pattern|nil)
 ---                An |lpeg| pattern. Only changes to files whose full paths match the pattern
 ---                will be reported. Only matches against non-directoriess, all directories will
@@ -212,7 +216,7 @@ function M.poll(path, opts, callback)
     opts = { opts, 'table', true },
     callback = { callback, 'function', false },
   })
-  return poll_internal(path, opts, callback, nil)
+  return recurse_watch(path, opts, callback)
 end
 
 return M
-- 
cgit 


From ec79ff893d5906e1f0d90953cffa535ffae47823 Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Mon, 20 Nov 2023 17:19:41 +0100
Subject: refactor(lsp): add type annotations to _watchfiles (#26109)

---
 runtime/lua/vim/lsp/_watchfiles.lua | 108 ++++++++++++++++++------------------
 1 file changed, 53 insertions(+), 55 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/_watchfiles.lua b/runtime/lua/vim/lsp/_watchfiles.lua
index 1a4909b3f3..1fd112631d 100644
--- a/runtime/lua/vim/lsp/_watchfiles.lua
+++ b/runtime/lua/vim/lsp/_watchfiles.lua
@@ -6,13 +6,11 @@ local lpeg = vim.lpeg
 
 local M = {}
 
----@alias lpeg userdata
-
 --- Parses the raw pattern into an |lpeg| pattern. LPeg patterns natively support the "this" or "that"
 --- alternative constructions described in the LSP spec that cannot be expressed in a standard Lua pattern.
 ---
 ---@param pattern string The raw glob pattern
----@return lpeg An |lpeg| representation of the pattern, or nil if the pattern is invalid.
+---@return vim.lpeg.Pattern? pattern An |lpeg| representation of the pattern, or nil if the pattern is invalid.
 local function parse(pattern)
   local l = lpeg
 
@@ -73,36 +71,38 @@ local function parse(pattern)
     End = P(-1) * Cc(l.P(-1)),
   })
 
-  return p:match(pattern)
+  return p:match(pattern) --[[@as vim.lpeg.Pattern?]]
 end
 
 ---@private
 --- Implementation of LSP 3.17.0's pattern matching: https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#pattern
 ---
----@param pattern string|table The glob pattern (raw or parsed) to match.
+---@param pattern string|vim.lpeg.Pattern The glob pattern (raw or parsed) to match.
 ---@param s string The string to match against pattern.
 ---@return boolean Whether or not pattern matches s.
 function M._match(pattern, s)
   if type(pattern) == 'string' then
-    pattern = parse(pattern)
+    local p = assert(parse(pattern))
+    return p:match(s) ~= nil
   end
   return pattern:match(s) ~= nil
 end
 
 M._watchfunc = (vim.fn.has('win32') == 1 or vim.fn.has('mac') == 1) and watch.watch or watch.poll
 
----@type table<number, table<number, function[]>> client id -> registration id -> cancel function
+---@type table<integer, table<string, function[]>> client id -> registration id -> cancel function
 local cancels = vim.defaulttable()
 
 local queue_timeout_ms = 100
----@type table<number, uv.uv_timer_t> client id -> libuv timer which will send queued changes at its timeout
+---@type table<integer, uv.uv_timer_t> client id -> libuv timer which will send queued changes at its timeout
 local queue_timers = {}
----@type table<number, lsp.FileEvent[]> client id -> set of queued changes to send in a single LSP notification
+---@type table<integer, lsp.FileEvent[]> client id -> set of queued changes to send in a single LSP notification
 local change_queues = {}
----@type table<number, table<string, lsp.FileChangeType>> client id -> URI -> last type of change processed
+---@type table<integer, table<string, lsp.FileChangeType>> client id -> URI -> last type of change processed
 --- Used to prune consecutive events of the same type for the same file
 local change_cache = vim.defaulttable()
 
+---@type table<vim._watch.FileChangeType, lsp.FileChangeType>
 local to_lsp_change_type = {
   [watch.FileChangeType.Created] = protocol.FileChangeType.Created,
   [watch.FileChangeType.Changed] = protocol.FileChangeType.Changed,
@@ -111,18 +111,18 @@ local to_lsp_change_type = {
 
 --- Default excludes the same as VSCode's `files.watcherExclude` setting.
 --- https://github.com/microsoft/vscode/blob/eef30e7165e19b33daa1e15e92fa34ff4a5df0d3/src/vs/workbench/contrib/files/browser/files.contribution.ts#L261
----@type lpeg parsed Lpeg pattern
+---@type vim.lpeg.Pattern parsed Lpeg pattern
 M._poll_exclude_pattern = parse('**/.git/{objects,subtree-cache}/**')
   + parse('**/node_modules/*/**')
   + parse('**/.hg/store/**')
 
 --- Registers the workspace/didChangeWatchedFiles capability dynamically.
 ---
----@param reg table LSP Registration object.
----@param ctx table Context from the |lsp-handler|.
+---@param reg lsp.Registration LSP Registration object.
+---@param ctx lsp.HandlerContext Context from the |lsp-handler|.
 function M.register(reg, ctx)
   local client_id = ctx.client_id
-  local client = vim.lsp.get_client_by_id(client_id)
+  local client = assert(vim.lsp.get_client_by_id(client_id), 'Client must be running')
   -- Ill-behaved servers may not honor the client capability and try to register
   -- anyway, so ignore requests when the user has opted out of the feature.
   local has_capability = vim.tbl_get(
@@ -134,57 +134,53 @@ function M.register(reg, ctx)
   if not has_capability or not client.workspace_folders then
     return
   end
-  local watch_regs = {} --- @type table<string,{pattern:lpeg,kind:integer}>
-  for _, w in ipairs(reg.registerOptions.watchers) do
-    local relative_pattern = false
-    local glob_patterns = {} --- @type {baseUri:string, pattern: string}[]
-    if type(w.globPattern) == 'string' then
+  local register_options = reg.registerOptions --[[@as lsp.DidChangeWatchedFilesRegistrationOptions]]
+  ---@type table<string, {pattern: vim.lpeg.Pattern, kind: lsp.WatchKind}[]> by base_dir
+  local watch_regs = vim.defaulttable()
+  for _, w in ipairs(register_options.watchers) do
+    local kind = w.kind
+      or (protocol.WatchKind.Create + protocol.WatchKind.Change + protocol.WatchKind.Delete)
+    local glob_pattern = w.globPattern
+
+    if type(glob_pattern) == 'string' then
+      local pattern = parse(glob_pattern)
+      if not pattern then
+        error('Cannot parse pattern: ' .. glob_pattern)
+      end
       for _, folder in ipairs(client.workspace_folders) do
-        table.insert(glob_patterns, { baseUri = folder.uri, pattern = w.globPattern })
+        local base_dir = vim.uri_to_fname(folder.uri)
+        table.insert(watch_regs[base_dir], { pattern = pattern, kind = kind })
       end
     else
-      relative_pattern = true
-      table.insert(glob_patterns, w.globPattern)
-    end
-    for _, glob_pattern in ipairs(glob_patterns) do
-      local base_dir = nil ---@type string?
-      if type(glob_pattern.baseUri) == 'string' then
-        base_dir = glob_pattern.baseUri
-      elseif type(glob_pattern.baseUri) == 'table' then
-        base_dir = glob_pattern.baseUri.uri
-      end
-      assert(base_dir, "couldn't identify root of watch")
-      base_dir = vim.uri_to_fname(base_dir)
-
-      ---@type integer
-      local kind = w.kind
-        or protocol.WatchKind.Create + protocol.WatchKind.Change + protocol.WatchKind.Delete
-
+      local base_uri = glob_pattern.baseUri
+      local uri = type(base_uri) == 'string' and base_uri or base_uri.uri
+      local base_dir = vim.uri_to_fname(uri)
       local pattern = parse(glob_pattern.pattern)
-      assert(pattern, 'invalid pattern: ' .. glob_pattern.pattern)
-      if relative_pattern then
-        pattern = lpeg.P(base_dir .. '/') * pattern
+      if not pattern then
+        error('Cannot parse pattern: ' .. glob_pattern.pattern)
       end
-
-      watch_regs[base_dir] = watch_regs[base_dir] or {}
-      table.insert(watch_regs[base_dir], {
-        pattern = pattern,
-        kind = kind,
-      })
+      pattern = lpeg.P(base_dir .. '/') * pattern
+      table.insert(watch_regs[base_dir], { pattern = pattern, kind = kind })
     end
   end
 
+  ---@param base_dir string
   local callback = function(base_dir)
     return function(fullpath, change_type)
-      for _, w in ipairs(watch_regs[base_dir]) do
-        change_type = to_lsp_change_type[change_type]
+      local registrations = watch_regs[base_dir]
+      for _, w in ipairs(registrations) do
+        local lsp_change_type = assert(
+          to_lsp_change_type[change_type],
+          'Must receive change type Created, Changed or Deleted'
+        )
         -- e.g. match kind with Delete bit (0b0100) to Delete change_type (3)
-        local kind_mask = bit.lshift(1, change_type - 1)
+        local kind_mask = bit.lshift(1, lsp_change_type - 1)
         local change_type_match = bit.band(w.kind, kind_mask) == kind_mask
-        if M._match(w.pattern, fullpath) and change_type_match then
+        if w.pattern:match(fullpath) ~= nil and change_type_match then
+          ---@type lsp.FileEvent
           local change = {
             uri = vim.uri_from_fname(fullpath),
-            type = change_type,
+            type = lsp_change_type,
           }
 
           local last_type = change_cache[client_id][change.uri]
@@ -196,9 +192,11 @@ function M.register(reg, ctx)
 
           if not queue_timers[client_id] then
             queue_timers[client_id] = vim.defer_fn(function()
-              client.notify(ms.workspace_didChangeWatchedFiles, {
+              ---@type lsp.DidChangeWatchedFilesParams
+              local params = {
                 changes = change_queues[client_id],
-              })
+              }
+              client.notify(ms.workspace_didChangeWatchedFiles, params)
               queue_timers[client_id] = nil
               change_queues[client_id] = nil
               change_cache[client_id] = nil
@@ -235,8 +233,8 @@ end
 
 --- Unregisters the workspace/didChangeWatchedFiles capability dynamically.
 ---
----@param unreg table LSP Unregistration object.
----@param ctx table Context from the |lsp-handler|.
+---@param unreg lsp.Unregistration LSP Unregistration object.
+---@param ctx lsp.HandlerContext Context from the |lsp-handler|.
 function M.unregister(unreg, ctx)
   local client_id = ctx.client_id
   local client_cancels = cancels[client_id]
-- 
cgit 


From fec5e3ab247bcc1ced67f1d0aa7fa10f694f933b Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 21 Nov 2023 14:25:45 +0800
Subject: fix(vim.region): handle multibyte inclusive selection properly
 (#26129)

---
 runtime/lua/vim/_editor.lua | 17 ++++++++++-------
 1 file changed, 10 insertions(+), 7 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 98a1ce79ed..12b632075d 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -492,7 +492,7 @@ end
 ---@param pos1 integer[]|string Start of region as a (line, column) tuple or |getpos()|-compatible string
 ---@param pos2 integer[]|string End of region as a (line, column) tuple or |getpos()|-compatible string
 ---@param regtype string \|setreg()|-style selection type
----@param inclusive boolean Controls whether `pos2` column is inclusive (see also 'selection').
+---@param inclusive boolean Controls whether the ending column is inclusive (see also 'selection').
 ---@return table region Dict of the form `{linenr = {startcol,endcol}}`. `endcol` is exclusive, and
 ---whole lines are returned as `{startcol,endcol} = {0,-1}`.
 function vim.region(bufnr, pos1, pos2, regtype, inclusive)
@@ -502,11 +502,11 @@ function vim.region(bufnr, pos1, pos2, regtype, inclusive)
 
   if type(pos1) == 'string' then
     local pos = vim.fn.getpos(pos1)
-    pos1 = { pos[2] - 1, pos[3] - 1 + pos[4] }
+    pos1 = { pos[2] - 1, pos[3] - 1 }
   end
   if type(pos2) == 'string' then
     local pos = vim.fn.getpos(pos2)
-    pos2 = { pos[2] - 1, pos[3] - 1 + pos[4] }
+    pos2 = { pos[2] - 1, pos[3] - 1 }
   end
 
   if pos1[1] > pos2[1] or (pos1[1] == pos2[1] and pos1[2] > pos2[2]) then
@@ -525,9 +525,8 @@ function vim.region(bufnr, pos1, pos2, regtype, inclusive)
 
   -- in case of block selection, columns need to be adjusted for non-ASCII characters
   -- TODO: handle double-width characters
-  local bufline
   if regtype:byte() == 22 then
-    bufline = vim.api.nvim_buf_get_lines(bufnr, pos1[1], pos1[1] + 1, true)[1]
+    local bufline = vim.api.nvim_buf_get_lines(bufnr, pos1[1], pos1[1] + 1, true)[1]
     pos1[2] = vim.str_utfindex(bufline, pos1[2])
   end
 
@@ -538,7 +537,7 @@ function vim.region(bufnr, pos1, pos2, regtype, inclusive)
       c1 = pos1[2]
       c2 = c1 + regtype:sub(2)
       -- and adjust for non-ASCII characters
-      bufline = vim.api.nvim_buf_get_lines(bufnr, l, l + 1, true)[1]
+      local bufline = vim.api.nvim_buf_get_lines(bufnr, l, l + 1, true)[1]
       local utflen = vim.str_utfindex(bufline, #bufline)
       if c1 <= utflen then
         c1 = vim.str_byteindex(bufline, c1)
@@ -555,7 +554,11 @@ function vim.region(bufnr, pos1, pos2, regtype, inclusive)
       c2 = -1
     else
       c1 = (l == pos1[1]) and pos1[2] or 0
-      c2 = (l == pos2[1]) and (pos2[2] + (inclusive and 1 or 0)) or -1
+      if inclusive and l == pos2[1] then
+        local bufline = vim.api.nvim_buf_get_lines(bufnr, pos2[1], pos2[1] + 1, true)[1]
+        pos2[2] = vim.fn.byteidx(bufline, vim.fn.charidx(bufline, pos2[2]) + 1)
+      end
+      c2 = (l == pos2[1]) and pos2[2] or -1
     end
     table.insert(region, l, { c1, c2 })
   end
-- 
cgit 


From 7e97c773e3ba78fcddbb2a0b9b0d572c8210c83e Mon Sep 17 00:00:00 2001
From: Mathias Fußenegger <mfussenegger@users.noreply.github.com>
Date: Tue, 21 Nov 2023 17:46:19 +0100
Subject: perf(lsp): use async fs_stat for file watching on linux (#26123)

---
 runtime/lua/vim/_watch.lua | 51 +++++++++++++++++++++++-----------------------
 1 file changed, 26 insertions(+), 25 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_watch.lua b/runtime/lua/vim/_watch.lua
index 7870e1e867..43fce3bf7f 100644
--- a/runtime/lua/vim/_watch.lua
+++ b/runtime/lua/vim/_watch.lua
@@ -132,35 +132,36 @@ local function recurse_watch(path, opts, callback)
       end
     end
     for fullpath, events_list in pairs(filechanges) do
-      local stat = uv.fs_stat(fullpath)
-      ---@type vim._watch.FileChangeType
-      local change_type
-      if stat then
-        change_type = FileChangeType.Created
-        for _, event in ipairs(events_list) do
-          if event.change then
-            change_type = FileChangeType.Changed
+      uv.fs_stat(fullpath, function(_, stat)
+        ---@type vim._watch.FileChangeType
+        local change_type
+        if stat then
+          change_type = FileChangeType.Created
+          for _, event in ipairs(events_list) do
+            if event.change then
+              change_type = FileChangeType.Changed
+            end
           end
-        end
-        if stat.type == 'directory' then
-          local handle = handles[fullpath]
-          if not handle then
-            handle = assert(uv.new_fs_event())
-            handles[fullpath] = handle
-            handle:start(fullpath, uvflags, create_on_change(fullpath))
+          if stat.type == 'directory' then
+            local handle = handles[fullpath]
+            if not handle then
+              handle = assert(uv.new_fs_event())
+              handles[fullpath] = handle
+              handle:start(fullpath, uvflags, create_on_change(fullpath))
+            end
           end
-        end
-      else
-        local handle = handles[fullpath]
-        if handle then
-          if not handle:is_closing() then
-            handle:close()
+        else
+          local handle = handles[fullpath]
+          if handle then
+            if not handle:is_closing() then
+              handle:close()
+            end
+            handles[fullpath] = nil
           end
-          handles[fullpath] = nil
+          change_type = FileChangeType.Deleted
         end
-        change_type = FileChangeType.Deleted
-      end
-      callback(fullpath, change_type)
+        callback(fullpath, change_type)
+      end)
     end
   end
   local root_handle = assert(uv.new_fs_event())
-- 
cgit 


From 820823c76d44c4d1fc350e68d9d75c65c80c72f7 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Wed, 22 Nov 2023 10:46:11 +0800
Subject: vim-patch:596a9f29c83a (#26146)

runtime(doc): Fix whitespace and formatting of some help files (vim/vim#13549)

https://github.com/vim/vim/commit/596a9f29c83af85ace1a2702c88591851ad14df8

N/A patch:
vim-patch:aabca259fa48

Co-authored-by: h_east <h.east.727@gmail.com>
---
 runtime/lua/vim/_meta/vimfn.lua | 104 ++++++++++++++++++++--------------------
 1 file changed, 52 insertions(+), 52 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index d1e676ef70..b443fb5d78 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -6261,96 +6261,96 @@ function vim.fn.prevnonblank(lnum) end
 --- having a different word order, positional arguments may be
 --- used to indicate this. For instance: >vim
 ---
----   #, c-format
----   msgid "%s returning %s"
----   msgstr "waarde %2$s komt terug van %1$s"
+---     #, c-format
+---     msgid "%s returning %s"
+---     msgstr "waarde %2$s komt terug van %1$s"
 --- <
---- In this example, the sentence has its 2 string arguments reversed
---- in the output. >vim
+--- In this example, the sentence has its 2 string arguments
+--- reversed in the output. >vim
 ---
----   echo printf(
----     "In The Netherlands, vim's creator's name is: %1$s %2$s",
----     "Bram", "Moolenaar")
---- <  In The Netherlands, vim's creator's name is: Bram Moolenaar >vim
+---     echo printf(
+---   "In The Netherlands, vim's creator's name is: %1$s %2$s",
+---   "Bram", "Moolenaar")
+--- <    In The Netherlands, vim's creator's name is: Bram Moolenaar >vim
 ---
----   echo printf(
----     "In Belgium, vim's creator's name is: %2$s %1$s",
----     "Bram", "Moolenaar")
---- <  In Belgium, vim's creator's name is: Moolenaar Bram
+---     echo printf(
+---   "In Belgium, vim's creator's name is: %2$s %1$s",
+---   "Bram", "Moolenaar")
+--- <    In Belgium, vim's creator's name is: Moolenaar Bram
 ---
 --- Width (and precision) can be specified using the '*' specifier.
 --- In this case, you must specify the field width position in the
 --- argument list. >vim
 ---
----   echo printf("%1$*2$.*3$d", 1, 2, 3)
---- <  001 >vim
----   echo printf("%2$*3$.*1$d", 1, 2, 3)
---- <    2 >vim
----   echo printf("%3$*1$.*2$d", 1, 2, 3)
---- <  03 >vim
----   echo printf("%1$*2$.*3$g", 1.4142, 2, 3)
---- <  1.414
+---     echo printf("%1$*2$.*3$d", 1, 2, 3)
+--- <    001 >vim
+---     echo printf("%2$*3$.*1$d", 1, 2, 3)
+--- <      2 >vim
+---     echo printf("%3$*1$.*2$d", 1, 2, 3)
+--- <    03 >vim
+---     echo printf("%1$*2$.*3$g", 1.4142, 2, 3)
+--- <    1.414
 ---
 --- You can mix specifying the width and/or precision directly
 --- and via positional arguments: >vim
 ---
----   echo printf("%1$4.*2$f", 1.4142135, 6)
---- <  1.414214 >vim
----   echo printf("%1$*2$.4f", 1.4142135, 6)
---- <  1.4142 >vim
----   echo printf("%1$*2$.*3$f", 1.4142135, 6, 2)
---- <    1.41
+---     echo printf("%1$4.*2$f", 1.4142135, 6)
+--- <    1.414214 >vim
+---     echo printf("%1$*2$.4f", 1.4142135, 6)
+--- <    1.4142 >vim
+---     echo printf("%1$*2$.*3$f", 1.4142135, 6, 2)
+--- <      1.41
 ---
 ---           *E1500*
 --- You cannot mix positional and non-positional arguments: >vim
----   echo printf("%s%1$s", "One", "Two")
---- <  E1500: Cannot mix positional and non-positional
----   arguments: %s%1$s
+---     echo printf("%s%1$s", "One", "Two")
+--- <    E1500: Cannot mix positional and non-positional arguments:
+---     %s%1$s
 ---
 ---           *E1501*
 --- You cannot skip a positional argument in a format string: >vim
----   echo printf("%3$s%1$s", "One", "Two", "Three")
---- <  E1501: format argument 2 unused in $-style
----   format: %3$s%1$s
+---     echo printf("%3$s%1$s", "One", "Two", "Three")
+--- <    E1501: format argument 2 unused in $-style format:
+---     %3$s%1$s
 ---
 ---           *E1502*
 --- You can re-use a [field-width] (or [precision]) argument: >vim
----   echo printf("%1$d at width %2$d is: %01$*2$d", 1, 2)
---- <  1 at width 2 is: 01
+---     echo printf("%1$d at width %2$d is: %01$*2$d", 1, 2)
+--- <    1 at width 2 is: 01
 ---
 --- However, you can't use it as a different type: >vim
----   echo printf("%1$d at width %2$ld is: %01$*2$d", 1, 2)
---- <  E1502: Positional argument 2 used as field
----   width reused as different type: long int/int
+---     echo printf("%1$d at width %2$ld is: %01$*2$d", 1, 2)
+--- <    E1502: Positional argument 2 used as field width reused as
+---     different type: long int/int
 ---
 ---           *E1503*
 --- When a positional argument is used, but not the correct number
 --- or arguments is given, an error is raised: >vim
----   echo printf("%1$d at width %2$d is: %01$*2$.*3$d", 1, 2)
---- <  E1503: Positional argument 3 out of bounds:
----   %1$d at width %2$d is: %01$*2$.*3$d
+---     echo printf("%1$d at width %2$d is: %01$*2$.*3$d", 1, 2)
+--- <    E1503: Positional argument 3 out of bounds: %1$d at width
+---     %2$d is: %01$*2$.*3$d
 ---
 --- Only the first error is reported: >vim
----   echo printf("%01$*2$.*3$d %4$d", 1, 2)
---- <  E1503: Positional argument 3 out of bounds:
----   %01$*2$.*3$d %4$d
+---     echo printf("%01$*2$.*3$d %4$d", 1, 2)
+--- <    E1503: Positional argument 3 out of bounds: %01$*2$.*3$d
+---     %4$d
 ---
 ---           *E1504*
 --- A positional argument can be used more than once: >vim
----   echo printf("%1$s %2$s %1$s", "One", "Two")
---- <  One Two One
+---     echo printf("%1$s %2$s %1$s", "One", "Two")
+--- <    One Two One
 ---
 --- However, you can't use a different type the second time: >vim
----   echo printf("%1$s %2$s %1$d", "One", "Two")
---- <  E1504: Positional argument 1 type used
----   inconsistently: int/string
+---     echo printf("%1$s %2$s %1$d", "One", "Two")
+--- <    E1504: Positional argument 1 type used inconsistently:
+---     int/string
 ---
 ---           *E1505*
 --- Various other errors that lead to a format string being
 --- wrongly formatted lead to: >vim
----   echo printf("%1$d at width %2$d is: %01$*2$.3$d", 1, 2)
---- <  E1505: Invalid format specifier:
----   %1$d at width %2$d is: %01$*2$.3$d
+---     echo printf("%1$d at width %2$d is: %01$*2$.3$d", 1, 2)
+--- <    E1505: Invalid format specifier: %1$d at width %2$d is:
+---     %01$*2$.3$d
 ---
 ---           *E1507*
 --- This internal error indicates that the logic to parse a
-- 
cgit 


From fc4385ad94c0a12d2ce8b6d275d8336a740b04fd Mon Sep 17 00:00:00 2001
From: "Justin M. Keyes" <justinkz@gmail.com>
Date: Sat, 25 Nov 2023 06:35:31 -0800
Subject: docs: vim.iter #26169

closes #24141
closes #24746
---
 runtime/lua/vim/iter.lua | 117 +++++++++++++++++++----------------------------
 1 file changed, 47 insertions(+), 70 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/iter.lua b/runtime/lua/vim/iter.lua
index 595baa7019..874bdfb437 100644
--- a/runtime/lua/vim/iter.lua
+++ b/runtime/lua/vim/iter.lua
@@ -2,17 +2,23 @@
 ---
 --- \*vim.iter()\* is an interface for |iterable|s: it wraps a table or function argument into an
 --- \*Iter\* object with methods (such as |Iter:filter()| and |Iter:map()|) that transform the
---- underlying source data. These methods can be chained together to create iterator "pipelines".
---- Each pipeline stage receives as input the output values from the prior stage. The values used in
---- the first stage of the pipeline depend on the type passed to this function:
+--- underlying source data. These methods can be chained to create iterator "pipelines": the output
+--- of each pipeline stage is input to the next stage. The first stage depends on the type passed to
+--- `vim.iter()`:
 ---
---- - List tables (arrays) pass only the value of each element
---- - Non-list tables (dictionaries) pass both the key and value of each element
---- - Function |iterator|s pass all of the values returned by their respective function
---- - Tables with a metatable implementing |__call()| are treated as function iterators
+--- - List tables (arrays, |lua-list|) yield only the value of each element.
+---   - Use |Iter:enumerate()| to also pass the index to the next stage.
+---   - Or initialize with ipairs(): `vim.iter(ipairs(…))`.
+--- - Non-list tables (|lua-dict|) yield both the key and value of each element.
+--- - Function |iterator|s yield all values returned by the underlying function.
+--- - Tables with a |__call()| metamethod are treated as function iterators.
 ---
---- The iterator pipeline terminates when the original table or function iterator runs out of values
---- (for function iterators, this means that the first value returned by the function is nil).
+--- The iterator pipeline terminates when the underlying |iterable| is exhausted (for function
+--- iterators this means it returned nil).
+---
+--- Note: `vim.iter()` scans table input to decide if it is a list or a dict; to avoid this cost you
+--- can wrap the table with an iterator e.g. `vim.iter(ipairs({…}))`, but that precludes the use of
+--- |list-iterator| operations such as |Iter:rev()|).
 ---
 --- Examples:
 ---
@@ -138,7 +144,7 @@ local function apply(f, ...)
   return false
 end
 
---- Add a filter step to the iterator pipeline.
+--- Filters an iterator pipeline.
 ---
 --- Example:
 ---
@@ -173,7 +179,7 @@ function ListIter.filter(self, f)
   return self
 end
 
---- Add a map step to the iterator pipeline.
+--- Maps the items of an iterator pipeline to the values returned by `f`.
 ---
 --- If the map function returns nil, the value is filtered from the iterator.
 ---
@@ -253,12 +259,9 @@ function ListIter.map(self, f)
   return self
 end
 
---- Call a function once for each item in the pipeline.
----
---- This is used for functions which have side effects. To modify the values in
---- the iterator, use |Iter:map()|.
+--- Calls a function once for each item in the pipeline, draining the iterator.
 ---
---- This function drains the iterator.
+--- For functions with side effects. To modify the values in the iterator, use |Iter:map()|.
 ---
 ---@param f function(...) Function to execute for each item in the pipeline.
 ---                       Takes all of the values returned by the previous stage
@@ -353,7 +356,7 @@ function ListIter.totable(self)
   return self._table
 end
 
---- Fold ("reduce") an iterator or table into a single value.
+--- Folds ("reduces") an iterator into a single value.
 ---
 --- Examples:
 ---
@@ -400,7 +403,7 @@ function ListIter.fold(self, init, f)
   return acc
 end
 
---- Return the next value from the iterator.
+--- Gets the next value from the iterator.
 ---
 --- Example:
 ---
@@ -432,9 +435,7 @@ function ListIter.next(self)
   end
 end
 
---- Reverse an iterator.
----
---- Only supported for iterators on list-like tables.
+--- Reverses a |list-iterator| pipeline.
 ---
 --- Example:
 ---
@@ -459,9 +460,7 @@ function ListIter.rev(self)
   return self
 end
 
---- Peek at the next value in the iterator without consuming it.
----
---- Only supported for iterators on list-like tables.
+--- Gets the next value in a |list-iterator| without consuming it.
 ---
 --- Example:
 ---
@@ -538,12 +537,10 @@ function Iter.find(self, f)
   return unpack(result)
 end
 
---- Find the first value in the iterator that satisfies the given predicate, starting from the end.
+--- Gets the first value in a |list-iterator| that satisfies a predicate, starting from the end.
 ---
 --- Advances the iterator. Returns nil and drains the iterator if no value is found.
 ---
---- Only supported for iterators on list-like tables.
----
 --- Examples:
 ---
 --- ```lua
@@ -583,9 +580,7 @@ function ListIter.rfind(self, f) -- luacheck: no unused args
   self._head = self._tail
 end
 
---- Return the next value from the end of the iterator.
----
---- Only supported for iterators on list-like tables.
+--- "Pops" a value from a |list-iterator| (gets the last value and decrements the tail).
 ---
 --- Example:
 ---
@@ -610,9 +605,9 @@ function ListIter.nextback(self)
   end
 end
 
---- Return the next value from the end of the iterator without consuming it.
+--- Gets the last value of a |list-iterator| without consuming it.
 ---
---- Only supported for iterators on list-like tables.
+--- See also |Iter:last()|.
 ---
 --- Example:
 ---
@@ -638,7 +633,7 @@ function ListIter.peekback(self)
   end
 end
 
---- Skip values in the iterator.
+--- Skips `n` values of an iterator pipeline.
 ---
 --- Example:
 ---
@@ -669,9 +664,7 @@ function ListIter.skip(self, n)
   return self
 end
 
---- Skip values in the iterator starting from the end.
----
---- Only supported for iterators on list-like tables.
+--- Skips `n` values backwards from the end of a |list-iterator| pipeline.
 ---
 --- Example:
 ---
@@ -700,9 +693,7 @@ function ListIter.skipback(self, n)
   return self
 end
 
---- Return the nth value in the iterator.
----
---- This function advances the iterator.
+--- Gets the nth value of an iterator (and advances to it).
 ---
 --- Example:
 ---
@@ -724,11 +715,7 @@ function Iter.nth(self, n)
   end
 end
 
---- Return the nth value from the end of the iterator.
----
---- This function advances the iterator.
----
---- Only supported for iterators on list-like tables.
+--- Gets the nth value from the end of a |list-iterator| (and advances to it).
 ---
 --- Example:
 ---
@@ -750,11 +737,9 @@ function Iter.nthback(self, n)
   end
 end
 
---- Slice an iterator, changing its start and end positions.
+--- Sets the start and end of a |list-iterator| pipeline.
 ---
---- This is equivalent to :skip(first - 1):skipback(len - last + 1)
----
---- Only supported for iterators on list-like tables.
+--- Equivalent to `:skip(first - 1):skipback(len - last + 1)`.
 ---
 ---@param first number
 ---@param last number
@@ -769,7 +754,7 @@ function ListIter.slice(self, first, last)
   return self:skip(math.max(0, first - 1)):skipback(math.max(0, self._tail - last - 1))
 end
 
---- Return true if any of the items in the iterator match the given predicate.
+--- Returns true if any of the items in the iterator match the given predicate.
 ---
 ---@param pred function(...):bool Predicate function. Takes all values returned from the previous
 ---                                stage in the pipeline as arguments and returns true if the
@@ -793,7 +778,7 @@ function Iter.any(self, pred)
   return any
 end
 
---- Return true if all of the items in the iterator match the given predicate.
+--- Returns true if all items in the iterator match the given predicate.
 ---
 ---@param pred function(...):bool Predicate function. Takes all values returned from the previous
 ---                                stage in the pipeline as arguments and returns true if the
@@ -816,9 +801,7 @@ function Iter.all(self, pred)
   return all
 end
 
---- Return the last item in the iterator.
----
---- Drains the iterator.
+--- Drains the iterator and returns the last item.
 ---
 --- Example:
 ---
@@ -853,22 +836,20 @@ function ListIter.last(self)
   return v
 end
 
---- Add an iterator stage that returns the current iterator count as well as the iterator value.
+--- Yields the item index (count) and value for each item of an iterator pipeline.
 ---
---- For list tables, prefer
+--- For list tables, this is more efficient:
 ---
 --- ```lua
 --- vim.iter(ipairs(t))
 --- ```
 ---
---- over
+--- instead of:
 ---
 --- ```lua
 --- vim.iter(t):enumerate()
 --- ```
 ---
---- as the former is faster.
----
 --- Example:
 ---
 --- ```lua
@@ -902,7 +883,7 @@ function ListIter.enumerate(self)
   return self
 end
 
---- Create a new Iter object from a table or iterator.
+--- Creates a new Iter object from a table or other |iterable|.
 ---
 ---@param src table|function Table or iterator to drain values from
 ---@return Iter
@@ -923,8 +904,7 @@ function Iter.new(src, ...)
 
     local t = {}
 
-    -- Check if source table can be treated like a list (indices are consecutive integers
-    -- starting from 1)
+    -- O(n): scan the source table to decide if it is a list (consecutive integer indices 1…n).
     local count = 0
     for _ in pairs(src) do
       count = count + 1
@@ -976,11 +956,10 @@ function ListIter.new(t)
   return it
 end
 
---- Collect an iterator into a table.
----
---- This is a convenience function that performs:
+--- Collects an |iterable| into a table.
 ---
 --- ```lua
+--- -- Equivalent to:
 --- vim.iter(f):totable()
 --- ```
 ---
@@ -990,11 +969,10 @@ function M.totable(f, ...)
   return Iter.new(f, ...):totable()
 end
 
---- Filter a table or iterator.
----
---- This is a convenience function that performs:
+--- Filters a table or other |iterable|.
 ---
 --- ```lua
+--- -- Equivalent to:
 --- vim.iter(src):filter(f):totable()
 --- ```
 ---
@@ -1009,11 +987,10 @@ function M.filter(f, src, ...)
   return Iter.new(src, ...):filter(f):totable()
 end
 
---- Map and filter a table or iterator.
----
---- This is a convenience function that performs:
+--- Maps a table or other |iterable|.
 ---
 --- ```lua
+--- -- Equivalent to:
 --- vim.iter(src):map(f):totable()
 --- ```
 ---
-- 
cgit 


From 38e98754a556404b54d3c28b4272bcacbc3b6b0e Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Sat, 25 Nov 2023 16:06:58 +0100
Subject: vim-patch:9.0.2128: runtime(swig): add syntax and filetype plugins
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Add syntax and filetype plugins for SWIG (Simplified Wrapper Interface
Generator) description files.

The default syntax for .i files highlights comments in a reverse
color scheme which doesn't look well.  This syntax builds
on vim's c++ syntax by adding highlighting for common swig
directives and user defined directives.  For an alternative
syntax, see vimscript vim/vim#1247 (which I found after writing this).

closes: vim/vim#13562

https://github.com/vim/vim/commit/2e31065a650015892179e520038bf2083a9519b6

Co-authored-by: Julien Marrec <julien.marrec@gmail.com>
Co-authored-by: Matěj Cepl <mcepl@cepl.eu>
---
 runtime/lua/vim/filetype.lua        |  4 +++-
 runtime/lua/vim/filetype/detect.lua | 45 ++++++++++++++++++++-----------------
 2 files changed, 28 insertions(+), 21 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index 217f673b5e..cb2656d9ba 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -984,6 +984,8 @@ local extension = {
   svelte = 'svelte',
   svg = 'svg',
   swift = 'swift',
+  swig = 'swig',
+  swg = 'swig',
   svh = 'systemverilog',
   sv = 'systemverilog',
   cmm = 'trace32',
@@ -1134,7 +1136,7 @@ local extension = {
   web = detect.web,
   pl = detect.pl,
   pp = detect.pp,
-  i = detect.progress_asm,
+  i = detect.i,
   w = detect.progress_cweb,
   p = detect.progress_pascal,
   pro = detect_seq(detect.proto, 'idlang'),
diff --git a/runtime/lua/vim/filetype/detect.lua b/runtime/lua/vim/filetype/detect.lua
index 5479608148..9d0f1bd3ab 100644
--- a/runtime/lua/vim/filetype/detect.lua
+++ b/runtime/lua/vim/filetype/detect.lua
@@ -619,6 +619,31 @@ function M.hw(_, bufnr)
   return 'virata'
 end
 
+-- This function checks for an assembly comment or a SWIG keyword or verbatim
+-- block in the first 50 lines.
+-- If not found, assume Progress.
+--- @type vim.filetype.mapfn
+function M.i(path, bufnr)
+  if vim.g.filetype_i then
+    return vim.g.filetype_i
+  end
+
+  -- These include the leading '%' sign
+  local ft_swig_keywords =
+    [[^\s*%\%(addmethods\|apply\|beginfile\|clear\|constant\|define\|echo\|enddef\|endoffile\|extend\|feature\|fragment\|ignore\|import\|importfile\|include\|includefile\|inline\|insert\|keyword\|module\|name\|namewarn\|native\|newobject\|parms\|pragma\|rename\|template\|typedef\|typemap\|types\|varargs\|warn\)]]
+  -- This is the start/end of a block that is copied literally to the processor file (C/C++)
+  local ft_swig_verbatim_block_start = '^%s*%%{'
+
+  for _, line in ipairs(getlines(bufnr, 1, 50)) do
+    if line:find('^%s*;') or line:find('^%*') then
+      return M.asm(path, bufnr)
+    elseif matchregex(line, ft_swig_keywords) or line:find(ft_swig_verbatim_block_start) then
+      return 'swig'
+    end
+  end
+  return 'progress'
+end
+
 --- @type vim.filetype.mapfn
 function M.idl(_, bufnr)
   for _, line in ipairs(getlines(bufnr, 1, 50)) do
@@ -1016,26 +1041,6 @@ function M.printcap(ptcap_type)
   end
 end
 
--- This function checks for an assembly comment in the first ten lines.
--- If not found, assume Progress.
---- @type vim.filetype.mapfn
-function M.progress_asm(path, bufnr)
-  if vim.g.filetype_i then
-    return vim.g.filetype_i
-  end
-
-  for _, line in ipairs(getlines(bufnr, 1, 10)) do
-    if line:find('^%s*;') or line:find('^/%*') then
-      return M.asm(path, bufnr)
-    elseif not line:find('^%s*$') or line:find('^/%*') then
-      -- Not an empty line: doesn't look like valid assembly code
-      -- or it looks like a Progress /* comment.
-      break
-    end
-  end
-  return 'progress'
-end
-
 --- @type vim.filetype.mapfn
 function M.progress_cweb(_, bufnr)
   if vim.g.filetype_w then
-- 
cgit 


From 84bbe4b0ca935db1f6202db339aee5594a3b3908 Mon Sep 17 00:00:00 2001
From: Lewis Russell <lewis6991@gmail.com>
Date: Tue, 21 Nov 2023 11:24:30 +0000
Subject: fix(lua): disallow vim.wait() in fast contexts

`vim.wait()` cannot be called in a fast callback since the main loop
cannot be run in that context as it is not reentrant

Fixes #26122
---
 runtime/lua/vim/_editor.lua       | 3 ++-
 runtime/lua/vim/_meta/builtin.lua | 4 ++--
 2 files changed, 4 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_editor.lua b/runtime/lua/vim/_editor.lua
index 12b632075d..6cccbe8313 100644
--- a/runtime/lua/vim/_editor.lua
+++ b/runtime/lua/vim/_editor.lua
@@ -124,7 +124,8 @@ vim.log = {
 --- @return vim.SystemObj Object with the fields:
 ---   - pid (integer) Process ID
 ---   - wait (fun(timeout: integer|nil): SystemCompleted) Wait for the process to complete. Upon
----     timeout the process is sent the KILL signal (9) and the exit code is set to 124.
+---     timeout the process is sent the KILL signal (9) and the exit code is set to 124. Cannot
+---     be called in |api-fast|.
 ---     - SystemCompleted is an object with the fields:
 ---      - code: (integer)
 ---      - signal: (integer)
diff --git a/runtime/lua/vim/_meta/builtin.lua b/runtime/lua/vim/_meta/builtin.lua
index 92c23f7764..eeba356672 100644
--- a/runtime/lua/vim/_meta/builtin.lua
+++ b/runtime/lua/vim/_meta/builtin.lua
@@ -205,6 +205,8 @@ function vim.schedule(fn) end
 --- milliseconds (default 200). Nvim still processes other events during
 --- this time.
 ---
+--- Cannot be called while in an |api-fast| event.
+---
 --- Examples:
 ---
 --- ```lua
@@ -235,8 +237,6 @@ function vim.schedule(fn) end
 --- @param callback? fun(): boolean Optional callback. Waits until {callback} returns true
 --- @param interval? integer (Approximate) number of milliseconds to wait between polls
 --- @param fast_only? boolean If true, only |api-fast| events will be processed.
----                           If called from while in an |api-fast| event, will
----                           automatically be set to `true`.
 --- @return boolean, nil|-1|-2
 ---     - If {callback} returns `true` during the {time}: `true, nil`
 ---     - If {callback} never returns `true` during the {time}: `false, -1`
-- 
cgit 


From 72ed99319dd662f0e35b58e888b57f98ac3b3eec Mon Sep 17 00:00:00 2001
From: Dmytro Soltys <soap@slotos.net>
Date: Mon, 27 Nov 2023 13:34:32 +0100
Subject: fix(treesitter): don't invalidate parser when discovering injections

When parsing with a range, languagetree looks up injections and adds
them if needed. This explicitly invalidates parser, making `is_valid`
report `false` both when including and excluding children.

This is an attempt to describe desired behaviour of `is_valid` in tests,
with what ended up being a single line change to satisfy them.
---
 runtime/lua/vim/treesitter/languagetree.lua | 2 --
 1 file changed, 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/languagetree.lua b/runtime/lua/vim/treesitter/languagetree.lua
index 670f2797b7..0171b416cd 100644
--- a/runtime/lua/vim/treesitter/languagetree.lua
+++ b/runtime/lua/vim/treesitter/languagetree.lua
@@ -508,7 +508,6 @@ function LanguageTree:add_child(lang)
   end
 
   self._children[lang] = child
-  self:invalidate()
   self:_do_callback('child_added', self._children[lang])
 
   return self._children[lang]
@@ -524,7 +523,6 @@ function LanguageTree:remove_child(lang)
   if child then
     self._children[lang] = nil
     child:destroy()
-    self:invalidate()
     self:_do_callback('child_removed', child)
   end
 end
-- 
cgit 


From 9fa9b3cad94a1ea7fced128fed2cd5ac3ff7bc44 Mon Sep 17 00:00:00 2001
From: LW <git@llllvvuu.dev>
Date: Mon, 27 Nov 2023 08:23:04 -0800
Subject: docs: support @since for api level #25574

close #25416
---
 runtime/lua/vim/lsp/inlay_hint.lua | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/lsp/inlay_hint.lua b/runtime/lua/vim/lsp/inlay_hint.lua
index cdda5dcc17..4f7a3b0076 100644
--- a/runtime/lua/vim/lsp/inlay_hint.lua
+++ b/runtime/lua/vim/lsp/inlay_hint.lua
@@ -107,7 +107,7 @@ end
 --- @field client_id integer
 --- @field inlay_hint lsp.InlayHint
 
---- Get the list of inlay hints, (optionally) restricted by buffer, client, or range.
+--- Get the list of inlay hints, (optionally) restricted by buffer or range.
 ---
 --- Example usage:
 ---
@@ -135,6 +135,8 @@ end
 ---  - bufnr (integer)
 ---  - client_id (integer)
 ---  - inlay_hint (lsp.InlayHint)
+---
+--- @since 12
 function M.get(filter)
   vim.validate({ filter = { filter, 'table', true } })
   filter = filter or {}
@@ -349,6 +351,7 @@ api.nvim_set_decoration_provider(namespace, {
 
 --- @param bufnr (integer|nil) Buffer handle, or 0 or nil for current
 --- @return boolean
+--- @since 12
 function M.is_enabled(bufnr)
   vim.validate({ bufnr = { bufnr, 'number', true } })
   if bufnr == nil or bufnr == 0 then
@@ -361,6 +364,7 @@ end
 ---
 --- @param bufnr (integer|nil) Buffer handle, or 0 or nil for current
 --- @param enable (boolean|nil) true/nil to enable, false to disable
+--- @since 12
 function M.enable(bufnr, enable)
   vim.validate({ enable = { enable, 'boolean', true }, bufnr = { bufnr, 'number', true } })
   if enable == false then
-- 
cgit 


From a314703cf1b9ccc654162c5d55b819aee66aa8b6 Mon Sep 17 00:00:00 2001
From: Christian Clason <c.clason@uni-graz.at>
Date: Tue, 28 Nov 2023 00:58:31 +0100
Subject: vim-patch:9.0.2131: not all nushell files detected (#26260)

Problem:  not all nushell files detected
Solution: use *.nu to detect nushell files

closes: vim/vim#13586

https://github.com/vim/vim/commit/b9efc72c2432f2d2a633c12d3a5b9fc3efb7b6e7

Co-authored-by: Daniel Buch Hansen <boogiewasthere@gmail.com>
---
 runtime/lua/vim/filetype.lua | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua
index cb2656d9ba..c6200f16bb 100644
--- a/runtime/lua/vim/filetype.lua
+++ b/runtime/lua/vim/filetype.lua
@@ -716,6 +716,7 @@ local extension = {
   tr = 'nroff',
   nsi = 'nsis',
   nsh = 'nsis',
+  nu = 'nu',
   obj = 'obj',
   objdump = 'objdump',
   cppobjdump = 'objdump',
@@ -1387,8 +1388,6 @@ local filename = {
   Neomuttrc = 'neomuttrc',
   ['.netrc'] = 'netrc',
   NEWS = detect.news,
-  ['env.nu'] = 'nu',
-  ['config.nu'] = 'nu',
   ['.ocamlinit'] = 'ocaml',
   ['.octaverc'] = 'octave',
   octaverc = 'octave',
-- 
cgit 


From e6d38c7dac2e079d9b0f1621fef193bca858664f Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 28 Nov 2023 11:46:20 +0800
Subject: vim-patch:9.0.2133: Cannot detect overstrike mode in Cmdline mode
 (#26263)

Problem:  Cannot detect overstrike mode in Cmdline mode
Solution: Make mode() return "cr" for overstrike

closes: vim/vim#13569

https://github.com/vim/vim/commit/d1c3ef1f47c87d1da056c56564e1985fe6f2931d
---
 runtime/lua/vim/_meta/vimfn.lua | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index b443fb5d78..de2896e094 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -5812,7 +5812,9 @@ function vim.fn.mkdir(name, flags, prot) end
 ---    Rvc      Virtual Replace mode completion |compl-generic|
 ---    Rvx      Virtual Replace mode |i_CTRL-X| completion
 ---    c      Command-line editing
+---    cr      Command-line while in overstrike mode |c_<Insert>|
 ---    cv      Vim Ex mode |gQ|
+---    cvr      Vim Ex while in overstrike mode |c_<Insert>|
 ---    r      Hit-enter prompt
 ---    rm      The -- more -- prompt
 ---    r?      A |:confirm| query of some sort
-- 
cgit 


From 570367ac83cdceeee7d43dadcff7652bd5cc93c5 Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 28 Nov 2023 13:52:17 +0800
Subject: docs(lua): don't include remote-only API functions (#26266)

---
 runtime/lua/vim/_meta/api.lua | 179 ------------------------------------------
 1 file changed, 179 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 006996ad4e..c863aa4929 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -286,12 +286,6 @@ function vim.api.nvim_buf_del_var(buffer, name) end
 ---               • unload: Unloaded only, do not delete. See `:bunload`
 function vim.api.nvim_buf_delete(buffer, opts) end
 
---- Deactivates buffer-update events on the channel.
----
---- @param buffer integer Buffer handle, or 0 for current buffer
---- @return boolean
-function vim.api.nvim_buf_detach(buffer) end
-
 --- Gets a changed tick of a buffer
 ---
 --- @param buffer integer Buffer handle, or 0 for current buffer
@@ -682,22 +676,6 @@ function vim.api.nvim_buf_set_var(buffer, name, value) end
 --- @return integer
 function vim.api.nvim_buf_set_virtual_text(buffer, src_id, line, chunks, opts) end
 
---- Calls many API methods atomically.
---- This has two main usages:
---- 1. To perform several requests from an async context atomically, i.e.
----    without interleaving redraws, RPC requests from other clients, or user
----    interactions (however API methods may trigger autocommands or event
----    processing which have such side effects, e.g. `:sleep` may wake
----    timers).
---- 2. To minimize RPC overhead (roundtrips) of a sequence of many requests.
----
----
---- @param calls any[] an array of calls, where each call is described by an array
----              with two elements: the request name, and an array of
----              arguments.
---- @return any[]
-function vim.api.nvim_call_atomic(calls) end
-
 --- Calls a Vimscript `Dictionary-function` with the given arguments.
 --- On execution error: fails with Vimscript error, updates v:errmsg.
 ---
@@ -1019,10 +997,6 @@ function vim.api.nvim_err_write(str) end
 --- @param str string Message
 function vim.api.nvim_err_writeln(str) end
 
---- @param lvl integer
---- @param data string
-function vim.api.nvim_error_event(lvl, data) end
-
 --- Evaluates a Vimscript `expression`. Dictionaries and Lists are recursively
 --- expanded.
 --- On execution error: fails with Vimscript error, updates v:errmsg.
@@ -1087,22 +1061,6 @@ function vim.api.nvim_exec2(src, opts) end
 ---                callback. See `nvim_create_autocmd()` for details.
 function vim.api.nvim_exec_autocmds(event, opts) end
 
---- Execute Lua code. Parameters (if any) are available as `...` inside the
---- chunk. The chunk can return a value.
---- Only statements are executed. To evaluate an expression, prefix it with
---- `return`: return my_function(...)
----
---- @param code string Lua code to execute
---- @param args any[] Arguments to the code
---- @return any
-function vim.api.nvim_exec_lua(code, args) end
-
---- @deprecated
---- @param code string
---- @param args any[]
---- @return any
-function vim.api.nvim_execute_lua(code, args) end
-
 --- Sends input-keys to Nvim, subject to various quirks controlled by `mode`
 --- flags. This is a blocking call, unlike `nvim_input()`.
 --- On execution error: does not fail, but updates v:errmsg.
@@ -1130,12 +1088,6 @@ function vim.api.nvim_feedkeys(keys, mode, escape_ks) end
 --- @return table<string,any>
 function vim.api.nvim_get_all_options_info() end
 
---- Returns a 2-tuple (Array), where item 0 is the current channel id and item
---- 1 is the `api-metadata` map (Dictionary).
----
---- @return any[]
-function vim.api.nvim_get_api_info() end
-
 --- Get all autocommands that match the corresponding {opts}.
 --- These examples will get autocommands matching ALL the given criteria:
 ---
@@ -1733,59 +1685,6 @@ function vim.api.nvim_replace_termcodes(str, from_part, do_lt, special) end
 --- @param opts table<string,any> Optional parameters. Reserved for future use.
 function vim.api.nvim_select_popupmenu_item(item, insert, finish, opts) end
 
---- Self-identifies the client.
---- The client/plugin/application should call this after connecting, to
---- provide hints about its identity and purpose, for debugging and
---- orchestration.
---- Can be called more than once; the caller should merge old info if
---- appropriate. Example: library first identifies the channel, then a plugin
---- using that library later identifies itself.
----
---- @param name string Short name for the connected client
---- @param version table<string,any> Dictionary describing the version, with these (optional)
----                   keys:
----                   • "major" major version (defaults to 0 if not set, for
----                     no release yet)
----                   • "minor" minor version
----                   • "patch" patch number
----                   • "prerelease" string describing a prerelease, like
----                     "dev" or "beta1"
----                   • "commit" hash or similar identifier of commit
---- @param type string Must be one of the following values. Client libraries
----                   should default to "remote" unless overridden by the
----                   user.
----                   • "remote" remote client connected "Nvim flavored"
----                     MessagePack-RPC (responses must be in reverse order of
----                     requests). `msgpack-rpc`
----                   • "msgpack-rpc" remote client connected to Nvim via
----                     fully MessagePack-RPC compliant protocol.
----                   • "ui" gui frontend
----                   • "embedder" application using Nvim as a component (for
----                     example, IDE/editor implementing a vim mode).
----                   • "host" plugin host, typically started by nvim
----                   • "plugin" single plugin, started by nvim
---- @param methods table<string,any> Builtin methods in the client. For a host, this does not
----                   include plugin methods which will be discovered later.
----                   The key should be the method name, the values are dicts
----                   with these (optional) keys (more keys may be added in
----                   future versions of Nvim, thus unknown keys are ignored.
----                   Clients must only use keys defined in this or later
----                   versions of Nvim):
----                   • "async" if true, send as a notification. If false or
----                     unspecified, use a blocking request
----                   • "nargs" Number of arguments. Could be a single integer
----                     or an array of two integers, minimum and maximum
----                     inclusive.
---- @param attributes table<string,any> Arbitrary string:string map of informal client
----                   properties. Suggested keys:
----                   • "website": Client homepage URL (e.g. GitHub
----                     repository)
----                   • "license": License description ("Apache 2", "GPLv3",
----                     "MIT", …)
----                   • "logo": URI or path to image, preferably small logo or
----                     icon. .png or .svg format is preferred.
-function vim.api.nvim_set_client_info(name, version, type, methods, attributes) end
-
 --- Sets the current buffer.
 ---
 --- @param buffer integer Buffer handle
@@ -1973,11 +1872,6 @@ function vim.api.nvim_set_vvar(name, value) end
 --- @return integer
 function vim.api.nvim_strwidth(text) end
 
---- Subscribes to event broadcasts.
----
---- @param event string Event type string
-function vim.api.nvim_subscribe(event) end
-
 --- Removes a tab-scoped (t:) variable
 ---
 --- @param tabpage integer Tabpage handle, or 0 for current tabpage
@@ -2022,79 +1916,6 @@ function vim.api.nvim_tabpage_list_wins(tabpage) end
 --- @param value any Variable value
 function vim.api.nvim_tabpage_set_var(tabpage, name, value) end
 
---- Activates UI events on the channel.
---- Entry point of all UI clients. Allows `--embed` to continue startup.
---- Implies that the client is ready to show the UI. Adds the client to the
---- list of UIs. `nvim_list_uis()`
----
---- @param width integer Requested screen columns
---- @param height integer Requested screen rows
---- @param options table<string,any> `ui-option` map
-function vim.api.nvim_ui_attach(width, height, options) end
-
---- Deactivates UI events on the channel.
---- Removes the client from the list of UIs. `nvim_list_uis()`
----
-function vim.api.nvim_ui_detach() end
-
---- Tells Nvim the geometry of the popupmenu, to align floating windows with
---- an external popup menu.
---- Note that this method is not to be confused with
---- `nvim_ui_pum_set_height()`, which sets the number of visible items in the
---- popup menu, while this function sets the bounding box of the popup menu,
---- including visual elements such as borders and sliders. Floats need not use
---- the same font size, nor be anchored to exact grid corners, so one can set
---- floating-point numbers to the popup menu geometry.
----
---- @param width number Popupmenu width.
---- @param height number Popupmenu height.
---- @param row number Popupmenu row.
---- @param col number Popupmenu height.
-function vim.api.nvim_ui_pum_set_bounds(width, height, row, col) end
-
---- Tells Nvim the number of elements displaying in the popupmenu, to decide
---- <PageUp> and <PageDown> movement.
----
---- @param height integer Popupmenu height, must be greater than zero.
-function vim.api.nvim_ui_pum_set_height(height) end
-
---- @param gained boolean
-function vim.api.nvim_ui_set_focus(gained) end
-
---- @param name string
---- @param value any
-function vim.api.nvim_ui_set_option(name, value) end
-
---- Tells Nvim when a terminal event has occurred
---- The following terminal events are supported:
----
---- • "termresponse": The terminal sent an OSC or DCS response sequence to
----   Nvim. The payload is the received response. Sets `v:termresponse` and
----   fires `TermResponse`.
----
----
---- @param event string Event name
---- @param value any
-function vim.api.nvim_ui_term_event(event, value) end
-
---- @param width integer
---- @param height integer
-function vim.api.nvim_ui_try_resize(width, height) end
-
---- Tell Nvim to resize a grid. Triggers a grid_resize event with the
---- requested grid size or the maximum size if it exceeds size limits.
---- On invalid grid handle, fails with error.
----
---- @param grid integer The handle of the grid to be changed.
---- @param width integer The new requested width.
---- @param height integer The new requested height.
-function vim.api.nvim_ui_try_resize_grid(grid, width, height) end
-
---- Unsubscribes to event broadcasts.
----
---- @param event string Event type string
-function vim.api.nvim_unsubscribe(event) end
-
 --- Calls a function with window as temporary current window.
 ---
 --- @param window integer Window handle, or 0 for current window
-- 
cgit 


From ae3685798deaf51f14422c568998998c03f91f2c Mon Sep 17 00:00:00 2001
From: bfredl <bjorn.linse@gmail.com>
Date: Sun, 26 Nov 2023 21:07:29 +0100
Subject: feat(decoration): allow conceal_char to be a composing char

decor->text.str pointer must go. This removes it for conceal char,
in preparation for a larger PR which will also handle the sign case.

By actually allowing composing chars for a conceal chars, this
becomes a feature and not just a refactor, as a bonus.
---
 runtime/lua/vim/_meta/api.lua | 3 +++
 1 file changed, 3 insertions(+)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 006996ad4e..b5975e0d42 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -80,6 +80,9 @@ function vim.api.nvim__id_float(flt) end
 function vim.api.nvim__inspect_cell(grid, row, col) end
 
 --- @private
+--- For testing. The condition in schar_cache_clear_if_full is hard to reach,
+--- so this function can be used to force a cache clear in a test.
+---
 function vim.api.nvim__invalidate_glyph_cache() end
 
 --- @private
-- 
cgit 


From b7831c7f996b769544d2bdc536ef601eb46b4918 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Tue, 28 Nov 2023 16:34:18 -0600
Subject: fix(termcap): use tmux passthrough sequence when running in tmux
 (#26281)

tmux intercepts and ignores XTGETTCAP so wrap the query in the tmux
passthrough sequence to make sure the query arrives at the "host"
terminal.

Users must still set the 'allow-passthrough' option in their tmux.conf.
---
 runtime/lua/vim/termcap.lua | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/termcap.lua b/runtime/lua/vim/termcap.lua
index 0eefc5eee4..2117f287cb 100644
--- a/runtime/lua/vim/termcap.lua
+++ b/runtime/lua/vim/termcap.lua
@@ -34,10 +34,6 @@ function M.query(caps, cb)
         local seq =
           vim.text.hexdecode(v):gsub('\\E', '\027'):gsub('%%p%d', ''):gsub('\\(%d+)', string.char)
 
-        -- TODO: When libtermkey is patched to accept BEL as an OSC terminator, this workaround can
-        -- be removed
-        seq = seq:gsub('\007$', '\027\\')
-
         cb(cap, seq)
 
         count = count - 1
@@ -54,6 +50,12 @@ function M.query(caps, cb)
   end
 
   local query = string.format('\027P+q%s\027\\', table.concat(encoded, ';'))
+
+  -- If running in tmux, wrap with the passthrough sequence
+  if os.getenv('TMUX') then
+    query = string.format('\027Ptmux;\027%s\027\\', query)
+  end
+
   io.stdout:write(query)
 end
 
-- 
cgit 


From aa9d9cafd0da58745178fa5a9b0773dcce96f30e Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Wed, 29 Nov 2023 06:51:00 +0800
Subject: vim-patch:9.0.2135: No test for mode() when executing Ex commands
 (#26282)

Problem:  No test for mode() when executing Ex commands
Solution: Add some test cases and simplify several other test cases.
          Also add a few more test cases for ModeChanged.

closes: vim/vim#13588

https://github.com/vim/vim/commit/fcaeb3d42b228e73c669b2fce78f1d3fe112769f
---
 runtime/lua/vim/_meta/vimfn.lua | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index de2896e094..947424c4ad 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -5812,9 +5812,9 @@ function vim.fn.mkdir(name, flags, prot) end
 ---    Rvc      Virtual Replace mode completion |compl-generic|
 ---    Rvx      Virtual Replace mode |i_CTRL-X| completion
 ---    c      Command-line editing
----    cr      Command-line while in overstrike mode |c_<Insert>|
+---    cr      Command-line editing overstrike mode |c_<Insert>|
 ---    cv      Vim Ex mode |gQ|
----    cvr      Vim Ex while in overstrike mode |c_<Insert>|
+---    cvr      Vim Ex mode while in overstrike mode |c_<Insert>|
 ---    r      Hit-enter prompt
 ---    rm      The -- more -- prompt
 ---    r?      A |:confirm| query of some sort
-- 
cgit 


From a6cba103cebce535279db197f9efeb34e9d1171f Mon Sep 17 00:00:00 2001
From: zeertzjq <zeertzjq@outlook.com>
Date: Wed, 29 Nov 2023 20:32:40 +0800
Subject: refactor: move some constants out of vim_defs.h (#26298)

---
 runtime/lua/vim/_meta/vimfn.lua | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 947424c4ad..05e5b2b871 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -5050,8 +5050,8 @@ function vim.fn.map(expr1, expr2) end
 ---   "mode_bits" Nvim's internal binary representation of "mode".
 ---        |mapset()| ignores this; only "mode" is used.
 ---        See |maplist()| for usage examples. The values
----        are from src/nvim/vim.h and may change in the
----        future.
+---        are from src/nvim/state_defs.h and may change in
+---        the future.
 ---
 --- The dictionary can be used to restore a mapping with
 --- |mapset()|.
@@ -5129,8 +5129,8 @@ function vim.fn.mapcheck(name, mode, abbr) end
 ---   endfor
 ---   echo saved_maps->mapnew({_, m -> m.lhs})
 --- <The values of the mode_bits are defined in Nvim's
---- src/nvim/vim.h file and they can be discovered at runtime
---- using |:map-commands| and "maplist()". Example: >vim
+--- src/nvim/state_defs.h file and they can be discovered at
+--- runtime using |:map-commands| and "maplist()". Example: >vim
 ---   omap xyzzy <Nop>
 ---   let op_bit = maplist()->filter(
 ---       \ {_, m -> m.lhs == 'xyzzy'})[0].mode_bits
-- 
cgit 


From 7bc5ee7f9327e8210c78bd21935130840aaf63f2 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 29 Nov 2023 08:10:02 -0600
Subject: fix(treesitter): use proper query syntax for inspector (#26274)

---
 runtime/lua/vim/treesitter/dev.lua | 69 ++++++++++++++++++--------------------
 1 file changed, 33 insertions(+), 36 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index 39c03cd1a5..1c581e3f29 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -55,12 +55,12 @@ local function traverse(node, depth, lang, injections, tree)
     local text ---@type string
     if named then
       if field then
-        text = string.format('%s: (%s)', field, type)
+        text = string.format('%s: (%s', field, type)
       else
-        text = string.format('(%s)', type)
+        text = string.format('(%s', type)
       end
     else
-      text = string.format('"%s"', type:gsub('\n', '\\n'))
+      text = string.format('"%s"', type:gsub('\n', '\\n'):gsub('"', '\\"'))
     end
 
     table.insert(tree, {
@@ -76,6 +76,10 @@ local function traverse(node, depth, lang, injections, tree)
     })
 
     traverse(child, depth + 1, lang, injections, tree)
+
+    if named then
+      tree[#tree].text = string.format('%s)', tree[#tree].text)
+    end
   end
 
   return tree
@@ -152,12 +156,6 @@ local function get_range_str(lnum, col, end_lnum, end_col)
   return string.format('[%d:%d - %d:%d]', lnum + 1, col + 1, end_lnum + 1, end_col)
 end
 
----@param text string
----@return string
-local function escape_quotes(text)
-  return string.format('"%s"', text:sub(2, #text - 1):gsub('"', '\\"'))
-end
-
 ---@param w integer
 ---@return boolean closed Whether the window was closed.
 local function close_win(w)
@@ -183,14 +181,14 @@ end
 
 --- Updates the cursor position in the inspector to match the node under the cursor.
 ---
---- @param pg TSTreeView
+--- @param treeview TSTreeView
 --- @param lang string
 --- @param source_buf integer
 --- @param inspect_buf integer
 --- @param inspect_win integer
 --- @param pos? { [1]: integer, [2]: integer }
-local function set_inspector_cursor(pg, lang, source_buf, inspect_buf, inspect_win, pos)
-  api.nvim_buf_clear_namespace(inspect_buf, pg.ns, 0, -1)
+local function set_inspector_cursor(treeview, lang, source_buf, inspect_buf, inspect_win, pos)
+  api.nvim_buf_clear_namespace(inspect_buf, treeview.ns, 0, -1)
 
   local cursor_node = vim.treesitter.get_node({
     bufnr = source_buf,
@@ -203,11 +201,11 @@ local function set_inspector_cursor(pg, lang, source_buf, inspect_buf, inspect_w
   end
 
   local cursor_node_id = cursor_node:id()
-  for i, v in pg:iter() do
+  for i, v in treeview:iter() do
     if v.id == cursor_node_id then
       local start = v.depth
       local end_col = start + #v.text
-      api.nvim_buf_set_extmark(inspect_buf, pg.ns, i - 1, start, {
+      api.nvim_buf_set_extmark(inspect_buf, treeview.ns, i - 1, start, {
         end_col = end_col,
         hl_group = 'Visual',
       })
@@ -229,9 +227,8 @@ function TSTreeView:draw(bufnr)
   for _, item in self:iter() do
     local range_str = get_range_str(item.lnum, item.col, item.end_lnum, item.end_col)
     local lang_str = self.opts.lang and string.format(' %s', item.lang) or ''
-    local text = item.named and item.text or escape_quotes(item.text)
     local line =
-      string.format('%s%s ; %s%s', string.rep(' ', item.depth), text, range_str, lang_str)
+      string.format('%s%s ; %s%s', string.rep('  ', item.depth), item.text, range_str, lang_str)
 
     if self.opts.lang then
       lang_hl_marks[#lang_hl_marks + 1] = {
@@ -304,7 +301,7 @@ function M.inspect_tree(opts)
 
   local buf = api.nvim_get_current_buf()
   local win = api.nvim_get_current_win()
-  local pg = assert(TSTreeView:new(buf, opts.lang))
+  local treeview = assert(TSTreeView:new(buf, opts.lang))
 
   -- Close any existing inspector window
   if vim.b[buf].dev_inspect then
@@ -341,17 +338,17 @@ function M.inspect_tree(opts)
   assert(type(title) == 'string', 'Window title must be a string')
   api.nvim_buf_set_name(b, title)
 
-  pg:draw(b)
+  treeview:draw(b)
 
   local cursor = api.nvim_win_get_cursor(win)
-  set_inspector_cursor(pg, opts.lang, buf, b, w, { cursor[1] - 1, cursor[2] })
+  set_inspector_cursor(treeview, opts.lang, buf, b, w, { cursor[1] - 1, cursor[2] })
 
-  api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
+  api.nvim_buf_clear_namespace(buf, treeview.ns, 0, -1)
   api.nvim_buf_set_keymap(b, 'n', '<CR>', '', {
     desc = 'Jump to the node under the cursor in the source buffer',
     callback = function()
       local row = api.nvim_win_get_cursor(w)[1]
-      local pos = pg:get(row)
+      local pos = treeview:get(row)
       api.nvim_set_current_win(win)
       api.nvim_win_set_cursor(win, { pos.lnum + 1, pos.col })
     end,
@@ -360,21 +357,21 @@ function M.inspect_tree(opts)
     desc = 'Toggle anonymous nodes',
     callback = function()
       local row, col = unpack(api.nvim_win_get_cursor(w)) ---@type integer, integer
-      local curnode = pg:get(row)
+      local curnode = treeview:get(row)
       while curnode and not curnode.named do
         row = row - 1
-        curnode = pg:get(row)
+        curnode = treeview:get(row)
       end
 
-      pg.opts.anon = not pg.opts.anon
-      pg:draw(b)
+      treeview.opts.anon = not treeview.opts.anon
+      treeview:draw(b)
 
       if not curnode then
         return
       end
 
       local id = curnode.id
-      for i, node in pg:iter() do
+      for i, node in treeview:iter() do
         if node.id == id then
           api.nvim_win_set_cursor(w, { i, col })
           break
@@ -385,8 +382,8 @@ function M.inspect_tree(opts)
   api.nvim_buf_set_keymap(b, 'n', 'I', '', {
     desc = 'Toggle language display',
     callback = function()
-      pg.opts.lang = not pg.opts.lang
-      pg:draw(b)
+      treeview.opts.lang = not treeview.opts.lang
+      treeview:draw(b)
     end,
   })
   api.nvim_buf_set_keymap(b, 'n', 'o', '', {
@@ -409,10 +406,10 @@ function M.inspect_tree(opts)
         return true
       end
 
-      api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
+      api.nvim_buf_clear_namespace(buf, treeview.ns, 0, -1)
       local row = api.nvim_win_get_cursor(w)[1]
-      local pos = pg:get(row)
-      api.nvim_buf_set_extmark(buf, pg.ns, pos.lnum, pos.col, {
+      local pos = treeview:get(row)
+      api.nvim_buf_set_extmark(buf, treeview.ns, pos.lnum, pos.col, {
         end_row = pos.end_lnum,
         end_col = math.max(0, pos.end_col),
         hl_group = 'Visual',
@@ -437,7 +434,7 @@ function M.inspect_tree(opts)
         return true
       end
 
-      set_inspector_cursor(pg, opts.lang, buf, b, w)
+      set_inspector_cursor(treeview, opts.lang, buf, b, w)
     end,
   })
 
@@ -449,8 +446,8 @@ function M.inspect_tree(opts)
         return true
       end
 
-      pg = assert(TSTreeView:new(buf, opts.lang))
-      pg:draw(b)
+      treeview = assert(TSTreeView:new(buf, opts.lang))
+      treeview:draw(b)
     end,
   })
 
@@ -461,7 +458,7 @@ function M.inspect_tree(opts)
       if not api.nvim_buf_is_loaded(buf) then
         return true
       end
-      api.nvim_buf_clear_namespace(buf, pg.ns, 0, -1)
+      api.nvim_buf_clear_namespace(buf, treeview.ns, 0, -1)
     end,
   })
 
@@ -472,7 +469,7 @@ function M.inspect_tree(opts)
       if not api.nvim_buf_is_loaded(b) then
         return true
       end
-      api.nvim_buf_clear_namespace(b, pg.ns, 0, -1)
+      api.nvim_buf_clear_namespace(b, treeview.ns, 0, -1)
     end,
   })
 
-- 
cgit 


From b6e339eb90e1a04f407f381739e46ad3c84f69c5 Mon Sep 17 00:00:00 2001
From: Pham Huy Hoang <hoangtun0810@gmail.com>
Date: Wed, 29 Nov 2023 23:16:52 +0900
Subject: fix(treesitter): make InspectTree correctly handle nested injections
 (#26085)

Problem: Only injections under the top level tree are found.

Solution: Iterate through all trees to find injections. When two
injections are contained within the same node in the parent tree, prefer
the injection with the larger byte length.
---
 runtime/lua/vim/treesitter/dev.lua | 29 +++++++++++++++++------------
 1 file changed, 17 insertions(+), 12 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index 1c581e3f29..aa4331946a 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -105,18 +105,23 @@ function TSTreeView:new(bufnr, lang)
   -- the root in the child tree to the {injections} table.
   local root = parser:parse(true)[1]:root()
   local injections = {} ---@type table<integer,table>
-  for _, child in pairs(parser:children()) do
-    child:for_each_tree(function(tree, ltree)
-      local r = tree:root()
-      local node = root:named_descendant_for_range(r:range())
-      if node then
-        injections[node:id()] = {
-          lang = ltree:lang(),
-          root = r,
-        }
-      end
-    end)
-  end
+
+  parser:for_each_tree(function(parent_tree, parent_ltree)
+    local parent = parent_tree:root()
+    for _, child in pairs(parent_ltree:children()) do
+      child:for_each_tree(function(tree, ltree)
+        local r = tree:root()
+        local node = assert(parent:named_descendant_for_range(r:range()))
+        local id = node:id()
+        if not injections[id] or r:byte_length() > injections[id].root:byte_length() then
+          injections[id] = {
+            lang = ltree:lang(),
+            root = r,
+          }
+        end
+      end)
+    end
+  end)
 
   local nodes = traverse(root, 0, parser:lang(), injections, {})
 
-- 
cgit 


From 18c1fd8e9d759da6806747910320dce6bea2ab42 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 29 Nov 2023 08:59:36 -0600
Subject: docs: document TSNode:byte_length() (#26287)

Also update the type annotation of TSNode:id(), which returns a string,
not an integer.
---
 runtime/lua/vim/treesitter/_meta.lua |  3 ++-
 runtime/lua/vim/treesitter/dev.lua   | 10 +++++++---
 2 files changed, 9 insertions(+), 4 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/_meta.lua b/runtime/lua/vim/treesitter/_meta.lua
index e6dcbc7a62..80c998b555 100644
--- a/runtime/lua/vim/treesitter/_meta.lua
+++ b/runtime/lua/vim/treesitter/_meta.lua
@@ -1,7 +1,7 @@
 ---@meta
 
 ---@class TSNode: userdata
----@field id fun(self: TSNode): integer
+---@field id fun(self: TSNode): string
 ---@field tree fun(self: TSNode): TSTree
 ---@field range fun(self: TSNode, include_bytes: false?): integer, integer, integer, integer
 ---@field range fun(self: TSNode, include_bytes: true): integer, integer, integer, integer, integer, integer
@@ -30,6 +30,7 @@
 ---@field equal fun(self: TSNode, other: TSNode): boolean
 ---@field iter_children fun(self: TSNode): fun(): TSNode, string
 ---@field field fun(self: TSNode, name: string): TSNode[]
+---@field byte_length fun(self: TSNode): integer
 local TSNode = {}
 
 ---@param query userdata
diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index aa4331946a..d6825eb024 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -24,6 +24,10 @@ local TSTreeView = {}
 ---@field lang string Source language of this node
 ---@field root TSNode
 
+---@class TSP.Injection
+---@field lang string Source language of this injection
+---@field root TSNode Root node of the injection
+
 --- Traverse all child nodes starting at {node}.
 ---
 --- This is a recursive function. The {depth} parameter indicates the current recursion level.
@@ -39,8 +43,8 @@ local TSTreeView = {}
 ---@param node TSNode Starting node to begin traversal |tsnode|
 ---@param depth integer Current recursion depth
 ---@param lang string Language of the tree currently being traversed
----@param injections table<integer,TSP.Node> Mapping of node ids to root nodes of injected language trees (see
----                        explanation above)
+---@param injections table<string, TSP.Injection> Mapping of node ids to root nodes
+---                  of injected language trees (see explanation above)
 ---@param tree TSP.Node[] Output table containing a list of tables each representing a node in the tree
 local function traverse(node, depth, lang, injections, tree)
   local injection = injections[node:id()]
@@ -104,7 +108,7 @@ function TSTreeView:new(bufnr, lang)
   -- the primary tree that contains that root. Add a mapping from the node in the primary tree to
   -- the root in the child tree to the {injections} table.
   local root = parser:parse(true)[1]:root()
-  local injections = {} ---@type table<integer,table>
+  local injections = {} ---@type table<string, TSP.Injection>
 
   parser:for_each_tree(function(parent_tree, parent_ltree)
     local parent = parent_tree:root()
-- 
cgit 


From 9b4b23493d6976613fc3e8b561c34bb4b808399c Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 29 Nov 2023 09:43:11 -0600
Subject: fix(defaults): wait until VimEnter to set background (#26284)

The OptionSet autocommand does not fire until Vim has finished starting,
so setting 'background' before the VimEnter event would not fire the
OptionSet event. The prior implementation also waited until VimEnter to
set 'background', so this was a regression introduced when moving
background detection into Lua.
---
 runtime/lua/vim/_defaults.lua | 33 +++++++++++++++++++++++++--------
 1 file changed, 25 insertions(+), 8 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/_defaults.lua b/runtime/lua/vim/_defaults.lua
index 09d6d43e7a..cc872dea83 100644
--- a/runtime/lua/vim/_defaults.lua
+++ b/runtime/lua/vim/_defaults.lua
@@ -252,14 +252,33 @@ do
   if tty then
     local timer = assert(vim.uv.new_timer())
 
+    ---@param bg string New value of the 'background' option
+    local function setbg(bg)
+      if vim.api.nvim_get_option_info2('background', {}).was_set then
+        -- Don't do anything if 'background' is already set
+        return
+      end
+
+      -- Wait until Nvim is finished starting to set 'background' to ensure the
+      -- OptionSet event fires.
+      if vim.v.vim_did_enter == 1 then
+        if vim.o.background ~= bg then
+          vim.o.background = bg
+        end
+      else
+        vim.api.nvim_create_autocmd('VimEnter', {
+          once = true,
+          nested = true,
+          callback = function()
+            setbg(bg)
+          end,
+        })
+      end
+    end
+
     local id = vim.api.nvim_create_autocmd('TermResponse', {
       nested = true,
       callback = function(args)
-        if vim.api.nvim_get_option_info2('background', {}).was_set then
-          -- Don't do anything if 'background' is already set
-          return true
-        end
-
         local resp = args.data ---@type string
         local r, g, b = parseosc11(resp)
         if r and g and b then
@@ -270,9 +289,7 @@ do
           if rr and gg and bb then
             local luminance = (0.299 * rr) + (0.587 * gg) + (0.114 * bb)
             local bg = luminance < 0.5 and 'dark' or 'light'
-            if bg ~= vim.o.background then
-              vim.o.background = bg
-            end
+            setbg(bg)
           end
 
           return true
-- 
cgit 


From 400b7842a98355bc3fcf2ecfaeda8ccf259d917a Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 29 Nov 2023 09:49:44 -0600
Subject: fix(termcap): escape escapes in passthrough sequence (#26301)

When using the tmux passthrough sequence any escape characters in the
inner sequence must be escaped by adding another escape character.
---
 runtime/lua/vim/termcap.lua | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/termcap.lua b/runtime/lua/vim/termcap.lua
index 2117f287cb..862cc52149 100644
--- a/runtime/lua/vim/termcap.lua
+++ b/runtime/lua/vim/termcap.lua
@@ -53,7 +53,7 @@ function M.query(caps, cb)
 
   -- If running in tmux, wrap with the passthrough sequence
   if os.getenv('TMUX') then
-    query = string.format('\027Ptmux;\027%s\027\\', query)
+    query = string.format('\027Ptmux;%s\027\\', query:gsub('\027', '\027\027'))
   end
 
   io.stdout:write(query)
-- 
cgit 


From 4a8bf24ac690004aedf5540fa440e788459e5e34 Mon Sep 17 00:00:00 2001
From: Gregory Anders <8965202+gpanders@users.noreply.github.com>
Date: Wed, 29 Nov 2023 10:17:53 -0600
Subject: fix(treesitter): adjust indentation in inspector highlights (#26302)

---
 runtime/lua/vim/treesitter/dev.lua | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

(limited to 'runtime/lua/vim')

diff --git a/runtime/lua/vim/treesitter/dev.lua b/runtime/lua/vim/treesitter/dev.lua
index d6825eb024..69ddc9b558 100644
--- a/runtime/lua/vim/treesitter/dev.lua
+++ b/runtime/lua/vim/treesitter/dev.lua
@@ -8,6 +8,7 @@ local M = {}
 ---@field opts table Options table with the following keys:
 ---                  - anon (boolean): If true, display anonymous nodes
 ---                  - lang (boolean): If true, display the language alongside each node
+---                  - indent (number): Number of spaces to indent nested lines. Default is 2.
 ---@field nodes TSP.Node[]
 ---@field named TSP.Node[]
 local TSTreeView = {}
@@ -143,6 +144,7 @@ function TSTreeView:new(bufnr, lang)
     opts = {
       anon = false,
       lang = false,
+      indent = 2,
     },
   }
 
@@ -212,7 +214,7 @@ local function set_inspector_cursor(treeview, lang, source_buf, inspect_buf, ins
   local cursor_node_id = cursor_node:id()
   for i, v in treeview:iter() do
     if v.id == cursor_node_id then
-      local start = v.depth
+      local start = v.depth * treeview.opts.indent ---@type integer
       local end_col = start + #v.text
       api.nvim_buf_set_extmark(inspect_buf, treeview.ns, i - 1, start, {
         end_col = end_col,
@@ -236,8 +238,13 @@ function TSTreeView:draw(bufnr)
   for _, item in self:iter() do
     local range_str = get_range_str(item.lnum, item.col, item.end_lnum, item.end_col)
     local lang_str = self.opts.lang and string.format(' %s', item.lang) or ''
-    local line =
-      string.format('%s%s ; %s%s', string.rep('  ', item.depth), item.text, range_str, lang_str)
+    local line = string.format(
+      '%s%s ; %s%s',
+      string.rep(' ', item.depth * self.opts.indent),
+      item.text,
+      range_str,
+      lang_str
+    )
 
     if self.opts.lang then
       lang_hl_marks[#lang_hl_marks + 1] = {
-- 
cgit