mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-07-14 21:30:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(lsp)!: always require position_encoding

Browse Source
This commit is contained in:
Yi Ming
2026-05-11 20:37:56 +08:00
parent fd51fb3fa0
commit 9e5982f071
2 changed files with 31 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
runtime/doc/lsp.txt
View File

@@ -2892,7 +2892,7 @@ apply_text_document_edit({text_document_edit}, {index}, {position_encoding},
• {text_document_edit} (`lsp.TextDocumentEdit`)
• {index} (`integer?`) Optional index of the edit, if from
a list of edits (or nil, if not from a list)
• {position_encoding} (`'utf-8'|'utf-16'|'utf-32'?`)
• {position_encoding} (`'utf-8'|'utf-16'|'utf-32'`)
• {change_annotations} (`table<string, lsp.ChangeAnnotation>?`)
See also: ~
@@ -2943,18 +2943,17 @@ buf_highlight_references({bufnr}, {references}, {position_encoding})
• https://microsoft.github.io/language-server-protocol/specification/#textDocumentContentChangeEvent
*vim.lsp.util.character_offset()*
character_offset({buf}, {row}, {col}, {offset_encoding})
character_offset({buf}, {row}, {col}, {position_encoding})
Returns the UTF-32 and UTF-16 offsets for a position in a certain buffer.
Parameters: ~
• {buf} (`integer`) buffer number (0 for current)
• {row} (`integer`) 0-indexed line
• {col} (`integer`) 0-indexed byte offset in line
• {offset_encoding} (`'utf-8'|'utf-16'|'utf-32'?`) defaults to
`offset_encoding` of first client of `buf`
• {buf} (`integer`) buffer number (0 for current)
• {row} (`integer`) 0-indexed line
• {col} (`integer`) 0-indexed byte offset in line
• {position_encoding} (`'utf-8'|'utf-16'|'utf-32'`)
Return: ~
(`integer`) `offset_encoding` index of the character in line {row}
(`integer`) `position_encoding` index of the character in line {row}
column {col} in buffer {buf}
*vim.lsp.util.convert_input_to_markdown_lines()*
@@ -3024,8 +3023,7 @@ locations_to_items({locations}, {position_encoding})
Parameters: ~
• {locations} (`lsp.Location[]|lsp.LocationLink[]`)
• {position_encoding} (`'utf-8'|'utf-16'|'utf-32'?`) default to first
client of buffer
• {position_encoding} (`'utf-8'|'utf-16'|'utf-32'`)
Return: ~
(`vim.quickfix.entry[]`) See |setqflist()| for the format
@@ -3191,7 +3189,7 @@ show_document({location}, {position_encoding}, {opts})
Parameters: ~
• {location} (`lsp.Location|lsp.LocationLink`)
• {position_encoding} (`'utf-8'|'utf-16'|'utf-32'?`)
• {position_encoding} (`'utf-8'|'utf-16'|'utf-32'`)
• {opts} (`table?`) A table with the following fields:
• {focus}? (`boolean`) Whether to focus/jump to
location if possible. (defaults: true)
@@ -3210,8 +3208,7 @@ symbols_to_items({symbols}, {bufnr}, {position_encoding})
list of symbols
• {bufnr} (`integer?`) buffer handle or 0 for current,
defaults to current
• {position_encoding} (`'utf-8'|'utf-16'|'utf-32'?`) default to first
client of buffer
• {position_encoding} (`'utf-8'|'utf-16'|'utf-32'`)
Return: ~
(`vim.quickfix.entry[]`) See |setqflist()| for the format

75
runtime/lua/vim/lsp/util.lua
View File

@@ -450,7 +450,7 @@ end
---
---@param text_document_edit lsp.TextDocumentEdit
---@param index? integer: Optional index of the edit, if from a list of edits (or nil, if not from a list)
---@param position_encoding? 'utf-8'|'utf-16'|'utf-32'
---@param position_encoding 'utf-8'|'utf-16'|'utf-32'
---@param change_annotations? table<string, lsp.ChangeAnnotation>
---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocumentEdit
function M.apply_text_document_edit(
@@ -459,15 +459,10 @@ function M.apply_text_document_edit(
position_encoding,
change_annotations
)
vim.validate('position_encoding', position_encoding, 'string')
local text_document = text_document_edit.textDocument
local bufnr = vim.uri_to_bufnr(text_document.uri)
if position_encoding == nil then
vim.notify_once(
'apply_text_document_edit must be called with valid position encoding',
vim.log.levels.WARN
)
return
end
-- `VersionedTextDocumentIdentifier`s version may be null
-- https://microsoft.github.io/language-server-protocol/specification#versionedTextDocumentIdentifier
@@ -647,13 +642,8 @@ end
---@param position_encoding 'utf-8'|'utf-16'|'utf-32' (required)
---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#workspace_applyEdit
function M.apply_workspace_edit(workspace_edit, position_encoding)
if position_encoding == nil then
vim.notify_once(
'apply_workspace_edit must be called with valid position encoding',
vim.log.levels.WARN
)
return
end
vim.validate('position_encoding', position_encoding, 'string')
if workspace_edit.documentChanges then
for idx, change in ipairs(workspace_edit.documentChanges) do
if change.kind == 'rename' then
@@ -962,22 +952,17 @@ end
--- Shows document and optionally jumps to the location.
---
---@param location lsp.Location|lsp.LocationLink
---@param position_encoding 'utf-8'|'utf-16'|'utf-32'?
---@param position_encoding 'utf-8'|'utf-16'|'utf-32'
---@param opts? vim.lsp.util.show_document.Opts
---@return boolean `true` if succeeded
function M.show_document(location, position_encoding, opts)
vim.validate('position_encoding', position_encoding, 'string')
-- location may be Location or LocationLink
local uri = location.uri or location.targetUri
if uri == nil then
return false
end
if position_encoding == nil then
vim.notify_once(
'show_document must be called with valid position encoding',
vim.log.levels.WARN
)
return false
end
local bufnr = vim.uri_to_bufnr(uri)
opts = opts or {}
@@ -1818,17 +1803,10 @@ end)
--- |setloclist()|.
---
---@param locations lsp.Location[]|lsp.LocationLink[]
---@param position_encoding? 'utf-8'|'utf-16'|'utf-32'
--- default to first client of buffer
---@param position_encoding 'utf-8'|'utf-16'|'utf-32'
---@return vim.quickfix.entry[] # See |setqflist()| for the format
function M.locations_to_items(locations, position_encoding)
if position_encoding == nil then
vim.notify_once(
'locations_to_items must be called with valid position encoding',
vim.log.levels.WARN
)
position_encoding = vim.lsp.get_clients({ bufnr = 0 })[1].offset_encoding
end
vim.validate('position_encoding', position_encoding, 'string')
local items = {} --- @type vim.quickfix.entry[]
@@ -1885,18 +1863,12 @@ end
---
---@param symbols lsp.DocumentSymbol[]|lsp.SymbolInformation[]|lsp.WorkspaceSymbol[] list of symbols
---@param bufnr? integer buffer handle or 0 for current, defaults to current
---@param position_encoding? 'utf-8'|'utf-16'|'utf-32'
--- default to first client of buffer
---@param position_encoding 'utf-8'|'utf-16'|'utf-32'
---@return vim.quickfix.entry[] # See |setqflist()| for the format
function M.symbols_to_items(symbols, bufnr, position_encoding)
vim.validate('position_encoding', position_encoding, 'string')
bufnr = vim._resolve_bufnr(bufnr)
if position_encoding == nil then
vim.notify_once(
'symbols_to_items must be called with valid position encoding',
vim.log.levels.WARN
)
position_encoding = assert(vim.lsp.get_clients({ bufnr = bufnr })[1]).offset_encoding
end
local items = {} --- @type vim.quickfix.entry[]
for _, symbol in ipairs(symbols) do
@@ -2015,7 +1987,8 @@ end
function M.make_given_range_params(start_pos, end_pos, bufnr, position_encoding)
validate('start_pos', start_pos, 'table', true)
validate('end_pos', end_pos, 'table', true)
validate('position_encoding', position_encoding, 'string', true)
validate('position_encoding', position_encoding, 'string')
bufnr = vim._resolve_bufnr(bufnr)
--- @type [integer, integer]
local A = { unpack(start_pos or api.nvim_buf_get_mark(bufnr, '<')) }
@@ -2097,19 +2070,13 @@ end
---@param buf integer buffer number (0 for current)
---@param row integer 0-indexed line
---@param col integer 0-indexed byte offset in line
---@param offset_encoding? '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)
---@param position_encoding 'utf-8'|'utf-16'|'utf-32'
---@return integer `position_encoding` index of the character in line {row} column {col} in buffer {buf}
function M.character_offset(buf, row, col, position_encoding)
vim.validate('position_encoding', position_encoding, 'string')
local line = get_line(buf, row)
if offset_encoding == nil then
vim.notify_once(
'character_offset must be called with valid offset encoding',
vim.log.levels.WARN
)
offset_encoding = assert(vim.lsp.get_clients({ bufnr = buf })[1]).offset_encoding
end
return vim.str_utfindex(line, offset_encoding, col, false)
return vim.str_utfindex(line, position_encoding, col, false)
end
--- Converts line range (0-based, end-inclusive) to lsp range,