neovim

editor.lua (41201B)

---

-- Nvim-Lua stdlib: the `vim` module (:help lua-stdlib)
--

-- These are for loading runtime modules lazily since they aren't available in
-- the nvim binary as specified in executor.c
for k, v in pairs({
 treesitter = true,
 filetype = true,
 loader = true,
 func = true,
 F = true,
 lsp = true,
 hl = true,
 diagnostic = true,
 keymap = true,
 ui = true,
 health = true,
 secure = true,
 snippet = true,
 pack = true,
 _watch = true,
 net = true,
 pos = true,
 range = true,
}) do
 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,
}

--- @nodoc
vim.log = {
 --- @enum vim.log.levels
 levels = {
   TRACE = 0,
   DEBUG = 1,
   INFO = 2,
   WARN = 3,
   ERROR = 4,
   OFF = 5,
 },
}

local utfs = {
 ['utf-8'] = true,
 ['utf-16'] = true,
 ['utf-32'] = true,
}

-- Gets process info from the `ps` command.
-- Used by nvim_get_proc() as a fallback.
function vim._os_proc_info(pid)
 if pid == nil or pid <= 0 or type(pid) ~= 'number' then
   error('invalid pid')
 end
 local cmd = { 'ps', '-p', pid, '-o', 'comm=' }
 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 r.code ~= 0 then
   error('command failed: ' .. vim.fn.string(cmd))
 end
 local ppid_string = assert(vim.system({ 'ps', '-p', pid, '-o', 'ppid=' }):wait().stdout)
 -- Remove trailing whitespace.
 name = vim.trim(name):gsub('^.*/', '')
 local ppid = tonumber(ppid_string) or -1
 return {
   name = name,
   pid = pid,
   ppid = ppid,
 }
end

-- Gets process children from the `pgrep` command.
-- Used by nvim_get_proc_children() as a fallback.
function vim._os_proc_children(ppid)
 if ppid == nil or ppid <= 0 or type(ppid) ~= 'number' then
   error('invalid ppid')
 end
 local cmd = { 'pgrep', '-P', ppid }
 local r = vim.system(cmd):wait()
 if r.code == 1 and vim.trim(r.stdout) == '' then
   return {} -- Process not found.
 elseif r.code ~= 0 then
   error('command failed: ' .. vim.fn.string(cmd))
 end
 local children = {}
 for s in r.stdout:gmatch('%S+') do
   local i = tonumber(s)
   if i ~= nil then
     table.insert(children, i)
   end
 end
 return children
end

--- @nodoc
--- @class vim.inspect.Opts
--- @field depth? integer
--- @field newline? string
--- @field process? fun(item:any, path: string[]): any

--- 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
---@return string
---@overload fun(x: any, opts?: vim.inspect.Opts): string
vim.inspect = vim.inspect

do
 local startpos, tdots, tick, got_line1, undo_started, trailing_nl = nil, 0, 0, false, false, false

 --- Paste handler, invoked by |nvim_paste()|.
 ---
 --- Note: This is provided only as a "hook", don't call it directly; call |nvim_paste()| instead,
 --- which arranges redo (dot-repeat) and invokes `vim.paste`.
 ---
 --- Example: To remove ANSI color codes when pasting:
 ---
 --- ```lua
 --- vim.paste = (function(overridden)
 ---   return function(lines, phase)
 ---     for i,line in ipairs(lines) do
 ---       -- Scrub ANSI color codes from paste input.
 ---       lines[i] = line:gsub('\27%[[0-9;mK]+', '')
 ---     end
 ---     return overridden(lines, phase)
 ---   end
 --- end)(vim.paste)
 --- ```
 ---
 ---@see |paste|
 ---
 ---@param lines  string[] # |readfile()|-style list of lines to paste. |channel-lines|
 ---@param phase (-1|1|2|3)  -1: "non-streaming" paste: the call contains all lines.
 ---              If paste is "streamed", `phase` indicates the stream state:
 ---                - 1: starts the paste (exactly once)
 ---                - 2: continues the paste (zero or more times)
 ---                - 3: ends the paste (exactly once)
 ---@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
   local is_last_chunk = phase == -1 or phase == 3
   if is_first_chunk then -- Reset flags.
     tdots, tick, got_line1, undo_started, trailing_nl = now, 0, false, false, false
   end
   if #lines == 0 then
     lines = { '' }
   end
   if #lines == 1 and lines[1] == '' and not is_last_chunk then
     -- An empty chunk can cause some edge cases in streamed pasting,
     -- so don't do anything unless it is the last chunk.
     return true
   end
   -- Note: mode doesn't always start with "c" in cmdline mode, so use getcmdtype() instead.
   if vim.fn.getcmdtype() ~= '' then -- cmdline-mode: paste only 1 line.
     if not got_line1 then
       got_line1 = (#lines > 1)
       -- Escape control characters
       local line1 = lines[1]:gsub('(%c)', '\022%1')
       -- nvim_input() is affected by mappings,
       -- so use nvim_feedkeys() with "n" flag to ignore mappings.
       -- "t" flag is also needed so the pasted text is saved in cmdline history.
       vim.api.nvim_feedkeys(line1, 'nt', true)
     end
     return true
   end
   local mode = vim.api.nvim_get_mode().mode
   if undo_started then
     vim.api.nvim_command('undojoin')
   end
   if mode:find('^i') or mode:find('^n?t') then -- Insert mode or Terminal buffer
     vim.api.nvim_put(lines, 'c', false, true)
   elseif phase < 2 and mode:find('^R') and not mode:find('^Rv') then -- Replace mode
     -- TODO: implement Replace mode streamed pasting
     -- TODO: support Virtual Replace mode
     local nchars = 0
     for _, line in ipairs(lines) do
       nchars = nchars + line:len()
     end
     --- @type integer, integer
     local row, col = unpack(vim.api.nvim_win_get_cursor(0))
     local bufline = vim.api.nvim_buf_get_lines(0, row - 1, row, true)[1]
     local firstline = lines[1]
     firstline = bufline:sub(1, col) .. firstline
     lines[1] = firstline
     lines[#lines] = lines[#lines] .. bufline:sub(col + nchars + 1, bufline:len())
     vim.api.nvim_buf_set_lines(0, row - 1, row, false, lines)
   elseif mode:find('^[nvV\22sS\19]') then -- Normal or Visual or Select mode
     if mode:find('^n') then -- Normal mode
       -- When there was a trailing new line in the previous chunk,
       -- the cursor is on the first character of the next line,
       -- so paste before the cursor instead of after it.
       vim.api.nvim_put(lines, 'c', not trailing_nl, false)
     else -- Visual or Select mode
       vim.api.nvim_command([[exe "silent normal! \<Del>"]])
       local del_start = vim.fn.getpos("'[")
       local cursor_pos = vim.fn.getpos('.')
       if mode:find('^[VS]') then -- linewise
         if cursor_pos[2] < del_start[2] then -- replacing lines at eof
           -- create a new line
           vim.api.nvim_put({ '' }, 'l', true, true)
         end
         vim.api.nvim_put(lines, 'c', false, false)
       else
         -- paste after cursor when replacing text at eol, otherwise paste before cursor
         vim.api.nvim_put(lines, 'c', cursor_pos[3] < del_start[3], false)
       end
     end
     -- put cursor at the end of the text instead of one character after it
     vim.fn.setpos('.', vim.fn.getpos("']"))
     trailing_nl = lines[#lines] == ''
   else -- Don't know what to do in other modes
     return false
   end
   undo_started = true
   if not is_last_chunk and (now - tdots >= 100) then
     local dots = ('.'):rep(tick % 4)
     tdots = now
     tick = tick + 1
     -- Use :echo because Lua print('') is a no-op, and we want to clear the
     -- message when there are zero dots.
     vim.api.nvim_command(('echo "%s"'):format(dots))
   end
   if startpos == nil then
     startpos = vim.fn.getpos("'[")
   else
     vim.fn.setpos("'[", startpos)
   end
   if is_last_chunk then
     startpos = nil
     vim.api.nvim_command('redraw' .. (tick > 1 and '|echo ""' or ''))
   end
   return true -- Paste will not continue if not returning `true`.
 end
end

--- 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 fn function
---@return function
function vim.schedule_wrap(fn)
 return function(...)
   local args = vim.F.pack_len(...)
   vim.schedule(function()
     fn(vim.F.unpack_len(args))
   end)
 end
end

-- vim.fn.{func}(...)
---@nodoc
vim.fn = setmetatable({}, {
 --- @param t table<string,function>
 --- @param key string
 --- @return function
 __index = function(t, key)
   local _fn --- @type function
   if vim.api[key] ~= nil then
     _fn = function()
       error(string.format('Tried to call API function with vim.fn: use vim.api.%s instead', key))
     end
   else
     _fn = function(...)
       return vim.call(key, ...)
     end
   end
   t[key] = _fn
   return _fn
 end,
})

--- @private
vim.funcref = function(viml_func_name)
 return vim.fn[viml_func_name]
end

local VIM_CMD_ARG_MAX = 20

--- Executes Vimscript (|Ex-commands|).
---
--- Can be indexed with a command name to get a function, thus you can write `vim.cmd.echo(…)`
--- instead of `vim.cmd{cmd='echo',…}`.
---
--- Examples:
---
--- ```lua
--- -- Single command:
--- vim.cmd('echo 42')
--- -- Multiline script:
--- vim.cmd([[
---   augroup my.group
---     autocmd!
---     autocmd FileType c setlocal cindent
---   augroup END
--- ]])
---
--- -- Ex command :echo "foo". Note: string literals must 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 :vertical resize +2
--- vim.cmd.resize({ '+2', mods = { vertical = true } })
--- ```
---
---@diagnostic disable-next-line: undefined-doc-param
---@param command string|table Command(s) to execute.
---       - The string form supports multiline Vimscript (alias to |nvim_exec2()|, behaves
---         like |:source|).
---       - The table form executes a single command (alias to |nvim_cmd()|).
---@see |ex-cmd-index|
vim.cmd = setmetatable({}, {
 __call = function(_, command)
   if type(command) == 'table' then
     return vim.api.nvim_cmd(command, {})
   else
     vim.api.nvim_exec2(command, {})
     return ''
   end
 end,
 --- @param t table<string,function>
 __index = function(t, command)
   t[command] = function(...)
     local opts --- @type vim.api.keyset.cmd
     if select('#', ...) == 1 and type(select(1, ...)) == 'table' then
       --- @type vim.api.keyset.cmd
       opts = select(1, ...)

       -- Move indexed positions in opts to opt.args
       if opts[1] and not opts.args then
         opts.args = {}
         for i = 1, VIM_CMD_ARG_MAX do
           if not opts[i] then
             break
           end
           opts.args[i] = opts[i]
           --- @diagnostic disable-next-line: no-unknown
           opts[i] = nil
         end
       end
     else
       opts = { args = { ... } }
     end
     opts.cmd = command
     return vim.api.nvim_cmd(opts, {})
   end
   return t[command]
 end,
})

--- @class (private) vim.var_accessor
--- @field [string] any
--- @field [integer] vim.var_accessor

--- @class (private) vim.g: { [string]: any }
--- @class (private) vim.b: vim.var_accessor
--- @class (private) vim.w: vim.var_accessor
--- @class (private) vim.t: vim.var_accessor

-- These are the vim.env/v/g/o/bo/wo variable magic accessors.
do
 --- @param scope string
 --- @param handle? false|integer
 --- @return vim.var_accessor
 local function make_dict_accessor(scope, handle)
   vim.validate('scope', scope, 'string')
   local mt = {}
   function mt:__newindex(k, v)
     return vim._setvar(scope, handle or 0, k, v)
   end
   function mt:__index(k)
     if handle == nil and type(k) == 'number' then
       return make_dict_accessor(scope, k)
     end
     return vim._getvar(scope, handle or 0, k)
   end
   return setmetatable({}, mt)
 end

 vim.g = make_dict_accessor('g', false) --[[@as vim.g]]
 vim.v = make_dict_accessor('v', false) --[[@as vim.v]]
 vim.b = make_dict_accessor('b') --[[@as vim.b]]
 vim.w = make_dict_accessor('w') --[[@as vim.w]]
 vim.t = make_dict_accessor('t') --[[@as vim.t]]
end

--- @deprecated
--- Gets a dict of line segment ("chunk") positions for the region from `pos1` to `pos2`.
---
--- 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 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)
 vim.deprecate('vim.region', 'vim.fn.getregionpos()', '0.13')

 if not vim.api.nvim_buf_is_loaded(bufnr) then
   vim.fn.bufload(bufnr)
 end

 if type(pos1) == 'string' then
   local pos = vim.fn.getpos(pos1)
   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 }
 end

 if pos1[1] > pos2[1] or (pos1[1] == pos2[1] and pos1[2] > pos2[2]) then
   pos1, pos2 = pos2, pos1 --- @type [integer, integer], [integer, integer]
 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)
 pos2[1] = math.min(pos2[1], buf_line_count - 1)

 -- in case of block selection, columns need to be adjusted for non-ASCII characters
 -- TODO: handle double-width characters
 if regtype:byte() == 22 then
   local bufline = vim.api.nvim_buf_get_lines(bufnr, pos1[1], pos1[1] + 1, true)[1]
   pos1[2] = vim.str_utfindex(bufline, 'utf-32', pos1[2])
 end

 local region = {}
 for l = pos1[1], pos2[1] do
   local c1 --- @type number
   local c2 --- @type number
   if regtype:byte() == 22 then -- block selection: take width from regtype
     c1 = pos1[2]
     c2 = c1 + tonumber(regtype:sub(2))
     -- and adjust for non-ASCII characters
     local bufline = vim.api.nvim_buf_get_lines(bufnr, l, l + 1, true)[1]
     local utflen = vim.str_utfindex(bufline, 'utf-32', #bufline)
     if c1 <= utflen then
       c1 = assert(tonumber(vim.str_byteindex(bufline, 'utf-32', c1)))
     else
       c1 = #bufline + 1
     end
     if c2 <= utflen then
       c2 = assert(tonumber(vim.str_byteindex(bufline, 'utf-32', c2)))
     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
     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
 return region
end

--- Defers calling {fn} until {timeout} ms passes.
---
--- Use to do a one-shot timer that calls {fn}
--- Note: The {fn} is |vim.schedule()|d automatically, so API functions are
--- safe to call.
---@param fn function Callback to call once `timeout` expires
---@param timeout integer Number of milliseconds to wait before calling `fn`
---@return uv.uv_timer_t timer luv timer object
function vim.defer_fn(fn, timeout)
 vim.validate('fn', fn, 'callable', true)

 local timer = assert(vim.uv.new_timer())
 timer:start(timeout, 0, function()
   local _, err = vim.schedule(function()
     if not timer:is_closing() then
       timer:close()
     end

     fn()
   end)

   if err then
     timer:close()
   end
 end)

 return timer
end

--- 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,
--- writes to |:messages|.
---@param msg string Content of the notification to show to the user.
---@param level integer|nil One of the values from |vim.log.levels|.
---@param opts table|nil Optional parameters. Unused by default.
---@diagnostic disable-next-line: unused-local
function vim.notify(msg, level, opts) -- luacheck: no unused args
 local chunks = { { msg, level == vim.log.levels.WARN and 'WarningMsg' or nil } }
 vim.api.nvim_echo(chunks, true, { err = level == vim.log.levels.ERROR })
end

do
 local notified = {} --- @type table<string,true>

 --- Displays a notification only one time.
 ---
 --- Like |vim.notify()|, but subsequent calls with the same message will not
 --- display a notification.
 ---
 ---@param msg string Content of the notification to show to the user.
 ---@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)
   if not notified[msg] then
     vim.notify(msg, level, opts)
     notified[msg] = true
     return true
   end
   return false
 end
end

local on_key_cbs = {} --- @type table<integer,[function, table]>

--- Adds Lua function {fn} with namespace id {ns_id} as a listener to every,
--- yes every, input key.
---
--- The Nvim command-line option |-w| is related but does not support callbacks
--- and cannot be toggled dynamically.
---
---@note {fn} will be removed on error.
---@note {fn} won't be invoked recursively, i.e. if {fn} itself consumes input,
---           it won't be invoked for those keys.
---@note {fn} will not be cleared by |nvim_buf_clear_namespace()|
---
---@param fn nil|fun(key: string, typed: string): string? Function invoked for every input key,
---          after mappings have been applied but before further processing. Arguments
---          {key} and {typed} are raw keycodes, where {key} is the key after mappings
---          are applied, and {typed} is the key(s) before mappings are applied.
---          {typed} may be empty if {key} is produced by non-typed key(s) or by the
---          same typed key(s) that produced a previous {key}.
---          If {fn} returns an empty string, {key} is discarded/ignored, and if {key}
---          is [<Cmd>] then the "[<Cmd>]…[<CR>]" sequence is discarded as a whole.
---          When {fn} is `nil`, the callback associated with namespace {ns_id} is removed.
---@param ns_id integer? Namespace ID. If nil or 0, generates and returns a
---                      new |nvim_create_namespace()| id.
---@param opts table? Optional parameters
---
---@see |keytrans()|
---
---@return integer Namespace id associated with {fn}. Or count of all callbacks
---if on_key() is called without arguments.
function vim.on_key(fn, ns_id, opts)
 if fn == nil and ns_id == nil then
   return vim.tbl_count(on_key_cbs)
 end

 vim.validate('fn', fn, 'callable', true)
 vim.validate('ns_id', ns_id, 'number', true)
 vim.validate('opts', opts, 'table', true)
 opts = opts or {}

 if ns_id == nil or ns_id == 0 then
   ns_id = vim.api.nvim_create_namespace('')
 end

 on_key_cbs[ns_id] = fn and { fn, opts }
 return ns_id
end

--- Executes the on_key callbacks.
---@private
function vim._on_key(buf, typed_buf)
 local failed = {} ---@type [integer, string][]
 local discard = false
 for k, v in pairs(on_key_cbs) do
   local fn = v[1]
   --- @type boolean, any
   local ok, rv = xpcall(function()
     return fn(buf, typed_buf)
   end, debug.traceback)
   if ok and rv ~= nil then
     if type(rv) == 'string' and #rv == 0 then
       discard = true
       -- break   -- Without break deliver to all callbacks even when it eventually discards.
       -- "break" does not make sense unless callbacks are sorted by ???.
     else
       ok = false
       rv = 'return string must be empty'
     end
   end
   if not ok then
     vim.on_key(nil, k)
     table.insert(failed, { k, rv })
   end
 end

 if #failed > 0 then
   local errmsg = ''
   for _, v in ipairs(failed) do
     errmsg = errmsg .. string.format('\nWith ns_id %d: %s', v[1], v[2])
   end
   error(errmsg)
 end
 return discard
end

--- Convert UTF-32, UTF-16 or UTF-8 {index} to byte index.
--- If {strict_indexing} is false
--- then an out of range index will return byte length
--- instead of throwing an error.
---
--- Invalid UTF-8 and NUL is treated like in |vim.str_utfindex()|.
--- An {index} in the middle of a UTF-16 sequence is rounded upwards to
--- the end of that sequence.
---@param s string
---@param encoding "utf-8"|"utf-16"|"utf-32"
---@param index integer
---@param strict_indexing? boolean # default: true
---@return integer
function vim.str_byteindex(s, encoding, index, strict_indexing)
 if type(encoding) == 'number' then
   -- Legacy support for old API
   -- Parameters: ~
   --   • {str}        (`string`)
   --   • {index}      (`integer`)
   --   • {use_utf16}  (`boolean?`)
   vim.deprecate(
     'vim.str_byteindex',
     'vim.str_byteindex(s, encoding, index, strict_indexing)',
     '1.0'
   )
   local old_index = encoding
   local use_utf16 = index or false
   return vim._str_byteindex(s, old_index, use_utf16) or error('index out of range')
 end

 -- Avoid vim.validate for performance.
 if type(s) ~= 'string' or type(index) ~= 'number' then
   vim.validate('s', s, 'string')
   vim.validate('index', index, 'number')
 end

 local len = #s

 if index == 0 or len == 0 then
   return 0
 end

 if not utfs[encoding] then
   vim.validate('encoding', encoding, function(v)
     return utfs[v], 'invalid encoding'
   end)
 end

 if strict_indexing ~= nil and type(strict_indexing) ~= 'boolean' then
   vim.validate('strict_indexing', strict_indexing, 'boolean', true)
 end
 if strict_indexing == nil then
   strict_indexing = true
 end

 if encoding == 'utf-8' then
   if index > len then
     return strict_indexing and error('index out of range') or len
   end
   return index
 end
 return vim._str_byteindex(s, index, encoding == 'utf-16')
   or strict_indexing and error('index out of range')
   or len
end

--- Convert byte index to UTF-32, UTF-16 or UTF-8 indices. If {index} is not
--- supplied, the length of the string is used. All indices are zero-based.
---
--- If {strict_indexing} is false then an out of range index will return string
--- length instead of throwing an error.
--- 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 s string
---@param encoding "utf-8"|"utf-16"|"utf-32"
---@param index? integer
---@param strict_indexing? boolean # default: true
---@return integer
function vim.str_utfindex(s, encoding, index, strict_indexing)
 if encoding == nil or type(encoding) == 'number' then
   -- Legacy support for old API
   -- Parameters: ~
   --   • {str}    (`string`)
   --   • {index}  (`integer?`)
   vim.deprecate(
     'vim.str_utfindex',
     'vim.str_utfindex(s, encoding, index, strict_indexing)',
     '1.0'
   )
   local old_index = encoding
   local col32, col16 = vim._str_utfindex(s, old_index) --[[@as integer,integer]]
   if not col32 or not col16 then
     error('index out of range')
   end
   -- Return (multiple): ~
   --     (`integer`) UTF-32 index
   --     (`integer`) UTF-16 index
   --- @diagnostic disable-next-line: redundant-return-value
   return col32, col16
 end

 if type(s) ~= 'string' or (index ~= nil and type(index) ~= 'number') then
   vim.validate('s', s, 'string')
   vim.validate('index', index, 'number', true)
 end

 if not index then
   index = math.huge
   strict_indexing = false
 end

 if index == 0 then
   return 0
 end

 if not utfs[encoding] then
   vim.validate('encoding', encoding, function(v)
     return utfs[v], 'invalid encoding'
   end)
 end

 if strict_indexing ~= nil and type(strict_indexing) ~= 'boolean' then
   vim.validate('strict_indexing', strict_indexing, 'boolean', true)
 end
 if strict_indexing == nil then
   strict_indexing = true
 end

 if encoding == 'utf-8' then
   local len = #s
   return index <= len and index or (strict_indexing and error('index out of range') or len)
 end
 local col32, col16 = vim._str_utfindex(s, index) --[[@as integer?,integer?]]
 local col = encoding == 'utf-16' and col16 or col32
 if col then
   return col
 end
 if strict_indexing then
   error('index out of range')
 end
 local max32, max16 = vim._str_utfindex(s)--[[@as integer integer]]
 return encoding == 'utf-16' and max16 or max32
end

--- Generates a list of possible completions for the str
--- 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.
---
--- @param pat string
--- @return any[], integer
function vim._expand_pat(pat, env)
 env = env or _G

 if pat == '' then
   local result = vim.tbl_keys(env)
   table.sort(result)
   return result, 0
 end

 -- TODO: We can handle spaces in [] ONLY.
 --    We should probably do that at some point, just for cooler completion.
 -- TODO: We can suggest the variable names to go in []
 --    This would be difficult as well.
 --    Probably just need to do a smarter match than just `:match`

 -- Get the last part of the pattern
 local last_part = pat:match('[%w.:_%[%]\'"]+$')
 if not last_part then
   return {}, 0
 end

 local parts, search_index = vim._expand_pat_get_parts(last_part)

 local match_part = string.sub(last_part, search_index, #last_part)
 local prefix_match_pat = string.sub(pat, 1, #pat - #match_part) or ''
 local last_char = string.sub(last_part, #last_part)

 local final_env = env

 --- Allows submodules to be defined on a `vim.<module>` table without eager-loading the module.
 ---
 --- Cmdline completion (`:lua vim.lsp.c<tab>`) accesses `vim.lsp._submodules` when no other candidates.
 --- Cmdline completion (`:lua vim.lsp.completion.g<tab>`) will eager-load the module anyway. #33007
 ---
 --- @param m table
 --- @param k string
 --- @return any
 local function safe_tbl_get(m, k)
   local val = rawget(m, k)
   if val ~= nil then
     return val
   end

   local mt = getmetatable(m)
   if not mt then
     return m == vim and vim._extra[k] or nil
   end

   -- use mt.__index, _submodules as fallback
   if type(mt.__index) == 'table' then
     return rawget(mt.__index, k)
   end

   local sub = rawget(m, '_submodules')
   if sub and type(sub) == 'table' and rawget(sub, k) then
     -- Access the module to force _defer_require() to load the module.
     return m[k]
   end
 end

 for _, part in ipairs(parts) do
   if type(final_env) ~= 'table' then
     return {}, 0
   end
   local key --- @type any

   -- Normally, we just have a string
   -- Just attempt to get the string directly from the environment
   if type(part) == 'string' then
     key = part
   else
     -- However, sometimes you want to use a variable, and complete on it
     --    With this, you have the power.

     -- MY_VAR = "api"
     -- vim[MY_VAR]
     -- -> _G[MY_VAR] -> "api"
     local result_key = part[1]
     if not result_key then
       return {}, 0
     end

     local result = rawget(env, result_key)

     if result == nil then
       return {}, 0
     end

     key = result
   end
   final_env = safe_tbl_get(final_env, key)

   if not final_env then
     return {}, 0
   end
 end

 local keys = {} --- @type table<string,true>

 --- @param obj table<any,any>
 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
       and k:match('^[_%w]+$') ~= nil -- filter out invalid identifiers for field, e.g. 'foo#bar'
       and (last_char ~= '.' or string.sub(k, 1, 1) ~= '_') -- don't include private fields after '.'
     then
       keys[k] = true
     end
   end
 end
 ---@param acc table<string,any>
 local function _fold_to_map(acc, k, v)
   acc[k] = (v or true)
   return acc
 end

 if type(final_env) == 'table' then
   insert_keys(final_env)
   local sub = rawget(final_env, '_submodules')
   if type(sub) == 'table' then
     insert_keys(sub)
   end
   if final_env == vim then
     insert_keys(vim._extra)
   end
 end

 local mt = getmetatable(final_env)
 if mt and type(mt.__index) == 'table' then
   insert_keys(mt.__index)
 end

 -- Completion for dict accessors (special vim variables and vim.fn)
 if mt and vim.tbl_contains({ vim.g, vim.t, vim.w, vim.b, vim.v, vim.env, vim.fn }, final_env) then
   local prefix, type = unpack(
     vim.fn == final_env and { '', 'function' }
       or vim.g == final_env and { 'g:', 'var' }
       or vim.t == final_env and { 't:', 'var' }
       or vim.w == final_env and { 'w:', 'var' }
       or vim.b == final_env and { 'b:', 'var' }
       or vim.v == final_env and { 'v:', 'var' }
       or vim.env == final_env and { '', 'environment' }
       or { nil, nil }
   )
   assert(prefix and type, "Can't resolve final_env")
   local vars = vim.fn.getcompletion(prefix .. match_part, type) --- @type string[]
   insert_keys(vim
     .iter(vars)
     :map(function(s) ---@param s string
       s = s:gsub('[()]+$', '') -- strip '(' and ')' for function completions
       return s:sub(#prefix + 1) -- strip the prefix, e.g., 'g:foo' => 'foo'
     end)
     :fold({}, _fold_to_map))
 end

 -- Completion for option accessors (full names only)
 if
   mt
   and vim.tbl_contains(
     { vim.o, vim.go, vim.bo, vim.wo, vim.opt, vim.opt_local, vim.opt_global },
     final_env
   )
 then
   --- @type fun(option_name: string, option: vim.api.keyset.get_option_info): boolean
   local filter = function(_, _)
     return true
   end
   if vim.bo == final_env then
     filter = function(_, option)
       return option.scope == 'buf'
     end
   elseif vim.wo == final_env then
     filter = function(_, option)
       return option.scope == 'win'
     end
   end

   --- @type table<string, vim.api.keyset.get_option_info>
   local options = vim.api.nvim_get_all_options_info()
   insert_keys(vim.iter(options):filter(filter):fold({}, _fold_to_map))
 end

 keys = vim.tbl_keys(keys)
 table.sort(keys)

 return keys, #prefix_match_pat
end

--- @param lua_string string
--- @return (string|string[])[], integer
vim._expand_pat_get_parts = function(lua_string)
 local parts = {}

 local accumulator, search_index = '', 1
 local in_brackets = false
 local bracket_end = -1 --- @type integer?
 local string_char = nil
 for idx = 1, #lua_string do
   local s = lua_string:sub(idx, idx)

   if not in_brackets and (s == '.' or s == ':') then
     table.insert(parts, accumulator)
     accumulator = ''

     search_index = idx + 1
   elseif s == '[' then
     in_brackets = true

     table.insert(parts, accumulator)
     accumulator = ''

     search_index = idx + 1
   elseif in_brackets then
     if idx == bracket_end then
       in_brackets = false
       search_index = idx + 1

       if string_char == 'VAR' then
         table.insert(parts, { accumulator })
         accumulator = ''

         string_char = nil
       end
     elseif not string_char then
       bracket_end = string.find(lua_string, ']', idx, true)

       if s == '"' or s == "'" then
         string_char = s
       elseif s ~= ' ' then
         string_char = 'VAR'
         accumulator = s
       end
     elseif string_char then
       if string_char ~= s then
         accumulator = accumulator .. s
       else
         table.insert(parts, accumulator)
         accumulator = ''

         string_char = nil
       end
     end
   else
     accumulator = accumulator .. s
   end
 end

 --- @param val any[]
 parts = vim.tbl_filter(function(val)
   return #val > 0
 end, parts)

 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 --- @type any[]

 --- 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.
 --- @param find_start 1|0
 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

--- @param inspect_strings boolean use vim.inspect() for strings
function vim._print(inspect_strings, ...)
 local msg = {}
 for i = 1, select('#', ...) do
   local o = select(i, ...)
   if not inspect_strings and type(o) == 'string' then
     table.insert(msg, o)
   else
     table.insert(msg, vim.inspect(o, { newline = '\n', indent = '  ' }))
   end
 end
 print(table.concat(msg, '\n'))
 return ...
end

--- "Pretty prints" the given arguments and returns them unmodified.
---
--- Example:
---
--- ```lua
--- local hl_normal = vim.print(vim.api.nvim_get_hl(0, { name = 'Normal' }))
--- ```
---
--- @see |vim.inspect()|
--- @see |:=|
--- @param ... any
--- @return any # given arguments.
function vim.print(...)
 return vim._print(false, ...)
end

--- Translates keycodes.
---
--- Example:
---
--- ```lua
--- local k = vim.keycode
--- vim.g.mapleader = k'<bs>'
--- ```
---
--- @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

--- @param server_addr string
--- @param connect_error string
function vim._cs_remote(rcid, server_addr, connect_error, args)
 --- @return string
 local function connection_failure_errmsg(consequence)
   local explanation --- @type string
   if server_addr == '' then
     explanation = 'No server specified with --server'
   else
     explanation = "Failed to connect to '" .. server_addr .. "'"
     if connect_error ~= '' then
       explanation = explanation .. ': ' .. connect_error
     end
   end
   return 'E247: ' .. explanation .. '. ' .. consequence
 end

 local f_silent = false
 local f_tab = false

 local subcmd = string.sub(args[1], 10)
 if subcmd == 'tab' then
   f_tab = true
 elseif subcmd == 'silent' then
   f_silent = true
 elseif
   subcmd == 'wait'
   or subcmd == 'wait-silent'
   or subcmd == 'tab-wait'
   or subcmd == 'tab-wait-silent'
 then
   return { errmsg = 'E5600: Wait commands not yet implemented in Nvim' }
 elseif subcmd == 'tab-silent' then
   f_tab = true
   f_silent = true
 elseif subcmd == 'send' then
   if rcid == 0 then
     return { errmsg = connection_failure_errmsg('Send failed.') }
   end
   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 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: ' .. tostring(args[1]) }
 end

 if rcid == 0 then
   if not f_silent then
     vim.notify(connection_failure_errmsg('Editing locally'), vim.log.levels.WARN)
   end
 else
   local command = {}
   if f_tab then
     table.insert(command, 'tab')
   end
   table.insert(command, 'drop')
   for i = 2, #args do
     table.insert(command, vim.fn.fnameescape(args[i]))
   end
   vim.fn.rpcrequest(rcid, 'nvim_command', table.concat(command, ' '))
 end

 return {
   should_exit = rcid ~= 0,
   tabbed = f_tab,
 }
end

do
 local function truncated_echo(msg)
   -- Truncate message to avoid hit-enter-prompt
   local max_width = vim.o.columns * math.max(vim.o.cmdheight - 1, 0) + vim.v.echospace
   local msg_truncated = string.sub(msg, 1, max_width)
   vim.api.nvim_echo({ { msg_truncated, 'WarningMsg' } }, true, {})
 end

 local notified = false

 function vim._truncated_echo_once(msg)
   if not notified then
     truncated_echo(msg)
     notified = true
     return true
   end
   return false
 end
end

--- This is basically the same as debug.traceback(), except the full paths are shown.
local function traceback()
 local level = 4
 local backtrace = { 'stack traceback:' }
 while true do
   local info = debug.getinfo(level, 'Sl')
   if not info then
     break
   end
   local msg = ('  %s:%s'):format(info.source:gsub('^@', ''), info.currentline)
   table.insert(backtrace, msg)
   level = level + 1
 end
 return table.concat(backtrace, '\n')
end

--- Shows a deprecation message to the user.
---
---@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.
---
---@return string|nil # Deprecated message, or nil if no message was shown.
function vim.deprecate(name, alternative, version, plugin, backtrace)
 plugin = plugin or 'Nvim'
 if plugin == 'Nvim' then
   require('vim.deprecated.health').add(name, version, traceback(), alternative)

   -- Show a warning only if feature is hard-deprecated (see MAINTAIN.md).
   -- Example: if removal `version` is 0.12 (soft-deprecated since 0.10-dev), show warnings
   -- starting at 0.11, including 0.11-dev.
   local major, minor = version:match('(%d+)%.(%d+)')
   major, minor = tonumber(major), tonumber(minor)
   local nvim_major = 0 --- Current Nvim major version.

   -- We can't "subtract" from a major version, so:
   --  * Always treat `major > nvim_major` as soft-deprecation.
   --  * Compare `minor - 1` if `major == nvim_major`.
   if major > nvim_major then
     return -- Always soft-deprecation (see MAINTAIN.md).
   end

   local hard_deprecated_since = string.format('nvim-%d.%d', major, minor - 1)
   if major == nvim_major and vim.fn.has(hard_deprecated_since) == 0 then
     return
   end

   local msg = ('%s is deprecated. Run ":checkhealth vim.deprecated" for more information'):format(
     name
   )

   local displayed = vim._truncated_echo_once(msg)
   return displayed and msg or nil
 else
   vim.validate('name', name, 'string')
   vim.validate('alternative', alternative, 'string', true)
   vim.validate('version', version, 'string', true)
   vim.validate('plugin', plugin, 'string', true)

   local msg = ('%s is deprecated'):format(name)
   msg = alternative and ('%s, use %s instead.'):format(msg, alternative) or (msg .. '.')
   msg = ('%s\nFeature will be removed in %s %s'):format(msg, 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
   return displayed and msg or nil
 end
end

require('vim._core.options')

--- Remove at Nvim 1.0
---@deprecated
vim.loop = vim.uv

-- Deprecated. Remove at Nvim 2.0
vim.highlight = vim._defer_deprecated_module('vim.highlight', 'vim.hl')

return vim