feat(lua): conversion between vim and lsp position/range

runtime/lua/vim/pos.lua

@@ -11,6 +11,7 @@
 --- Built on |vim.Pos| objects, this module offers operations
 --- that support comparisons and conversions between various types of positions.
 
+local api = vim.api
 local validate = vim.validate
 
 --- Represents a well-defined position.
@@ -110,6 +111,73 @@ function Pos.__eq(...)
   return cmp_pos(...) == 0
 end
 
+--- TODO(ofseed): Make it work for unloaded buffers. Check get_line() in vim.lsp.util.
+---@param buf integer
+---@param row integer
+local function get_line(buf, row)
+  return api.nvim_buf_get_lines(buf, row, row + 1, true)[1]
+end
+
+--- Converts |vim.Pos| to `lsp.Position`.
+---
+--- Example:
+--- ```lua
+--- -- `buf` is required for conversion to LSP position.
+--- local buf = vim.api.nvim_get_current_buf()
+--- local pos = vim.pos(3, 5, { buf = buf })
+---
+--- -- Convert to LSP position, you can call it in a method style.
+--- local lsp_pos = pos:lsp('utf-16')
+--- ```
+---@param pos vim.Pos
+---@param position_encoding lsp.PositionEncodingKind
+function Pos.to_lsp(pos, position_encoding)
+  validate('pos', pos, 'table')
+  validate('position_encoding', position_encoding, 'string')
+
+  local buf = assert(pos.buf, 'position is not a buffer position')
+  local row, col = pos.row, pos.col
+  -- When on the first character,
+  -- we can ignore the difference between byte and character.
+  if col > 0 then
+    col = vim.str_utfindex(get_line(buf, row), position_encoding, col, false)
+  end
+
+  ---@type lsp.Position
+  return { line = row, character = col }
+end
+
+--- Creates a new |vim.Pos| from `lsp.Position`.
+---
+--- Example:
+--- ```lua
+--- local buf = vim.api.nvim_get_current_buf()
+--- local lsp_pos = {
+---   line = 3,
+---   character = 5
+--- }
+---
+--- -- `buf` is mandatory, as LSP positions are always associated with a buffer.
+--- local pos = vim.pos.lsp(buf, lsp_pos, 'utf-16')
+--- ```
+---@param buf integer
+---@param pos lsp.Position
+---@param position_encoding lsp.PositionEncodingKind
+function Pos.lsp(buf, pos, position_encoding)
+  validate('buf', buf, 'number')
+  validate('pos', pos, 'table')
+  validate('position_encoding', position_encoding, 'string')
+
+  local row, col = pos.line, pos.character
+  -- When on the first character,
+  -- we can ignore the difference between byte and character.
+  if col > 0 then
+    col = vim.str_byteindex(get_line(buf, row), position_encoding, col)
+  end
+
+  return Pos.new(row, col, { buf = buf })
+end
+
 -- Overload `Range.new` to allow calling this module as a function.
 setmetatable(Pos, {
   __call = function(_, ...)

runtime/lua/vim/range.lua

@@ -129,6 +129,59 @@ function Range.intersect(r1, r2)
   return Range.new(rs.start, re.end_)
 end
 
+--- Converts |vim.Range| to `lsp.Range`.
+---
+--- Example:
+--- ```lua
+--- -- `buf` is required for conversion to LSP range.
+--- local buf = vim.api.nvim_get_current_buf()
+--- local range = vim.range(3, 5, 4, 0, { buf = buf })
+---
+--- -- Convert to LSP range, you can call it in a method style.
+--- local lsp_range = range:to_lsp('utf-16')
+--- ```
+---@param range vim.Range
+---@param position_encoding lsp.PositionEncodingKind
+function Range.to_lsp(range, position_encoding)
+  validate('range', range, 'table')
+  validate('position_encoding', position_encoding, 'string', true)
+
+  ---@type lsp.Range
+  return {
+    ['start'] = range.start:to_lsp(position_encoding),
+    ['end'] = range.end_:to_lsp(position_encoding),
+  }
+end
+
+--- Creates a new |vim.Range| from `lsp.Range`.
+---
+--- Example:
+--- ```lua
+--- local buf = vim.api.nvim_get_current_buf()
+--- local lsp_range = {
+---   ['start'] = { line = 3, character = 5 },
+---   ['end'] = { line = 4, character = 0 }
+--- }
+---
+--- -- `buf` is mandatory, as LSP ranges are always associated with a buffer.
+--- local range = vim.range.lsp(buf, lsp_range, 'utf-16')
+--- ```
+---@param buf integer
+---@param range lsp.Range
+---@param position_encoding lsp.PositionEncodingKind
+function Range.lsp(buf, range, position_encoding)
+  validate('buf', buf, 'number')
+  validate('range', range, 'table')
+  validate('position_encoding', position_encoding, 'string')
+
+  -- TODO(ofseed): avoid using `Pos:lsp()` here,
+  -- as they need reading files separately if buffer is unloaded.
+  local start = vim.pos.lsp(buf, range['start'], position_encoding)
+  local end_ = vim.pos.lsp(buf, range['end'], position_encoding)
+
+  return Range.new(start, end_)
+end
+
 -- Overload `Range.new` to allow calling this module as a function.
 setmetatable(Range, {
   __call = function(_, ...)