feat: extend vim.Pos, vim.Range #36397

Problem:
Using nested `vim.Pos` objects to represent each `vim.Range` object
requires 3 tables for each `vim.Range`, which may be undesirable in
performance critical code. Using key-value tables performs worse than
using array-like tables (lists).

Solution:
Use array-like indices for the internal fields of both `vim.Pos` and
`vim.Range` objects. Use a metatable to allow users to access them like
if they were key-value tables.

---

Problem:
The `vim.Pos` conversion interface for `extmark` indexing does not take
into account the difference in how a position on top of a newline is
represented in `vim.Pos` and `extmark`.
- `vim.Pos`: for a newline at the end of row `n`, `row` takes the value
  `n + 1` and `col` takes the value `0`.
- `extmark`: for a newline at the end of for `n`, `row` takes the value
  `n` and `col` takes the value `#row_text`.

Solution:
Handle this in the `extmark` interface.

---

Problem:
Not all `to_xxx` interfaces have wrapping objects like `to_lsp`.

Solution:
Return unwrapped values in `to_xxx` interfaces where it makes sense.
Accept unwrapped values in "from" interfaces where it makes sense.

---

Problem:
`start` and `end` positions have different semantics, so they can't be
compared. `vim.Range` relies on comparing the `end` and `start` of two
ranges to decide which one is greater, which doesn't work as expected
because this of the different semantics.

For example, for the ranges:

    local a = {
      start = { row = 0, col = 22, },
      end_ = { row = 0, col = 24, },
    }
    local b = {
      start = { row = 0, col = 17, },
      end_ = { row = 0, col = 22, },
    }

in this code:

    local foo, bar = "foo",  "bar"
    --               |---||-|
    --                 b  a

The range `b` is smaller than the range `a`, but the current
implementation compares `b._end` (`col = 22`) and `a.start` (`col = 22`)
and concludes that, since `b.col` is not smaller than `a.col`, `b`
should be greater than `a`.

Solution:
- Use a `to_inclusive_pos` to normalize end positions inside of
  `vim.Range` whenever a comparison between a start and an end position
  is necessary.

1 files changed, 46 insertions, 18 deletions

diff --git a/runtime/lua/vim/pos.lua b/runtime/lua/vim/pos.lua
index cb793053a2..5f704a4f5d 100644
--- a/runtime/lua/vim/pos.lua
+++ b/runtime/lua/vim/pos.lua
@@ -42,8 +42,25 @@ local validate = vim.validate
 --- When specified, it indicates that this position belongs to a specific buffer.
 --- This field is required when performing position conversions.
 ---@field buf? integer
+---@field private [1] integer underlying representation of row
+---@field private [2] integer underlying representation of col
+---@field private [3] integer underlying representation of buf
 local Pos = {}
-Pos.__index = Pos
+
+---@private
+---@param pos vim.Pos
+---@param key any
+function Pos.__index(pos, key)
+  if key == 'row' then
+    return pos[1]
+  elseif key == 'col' then
+    return pos[2]
+  elseif key == 'buf' then
+    return pos[3]
+  end
+
+  return Pos[key]
+end
 
 ---@class vim.Pos.Optional
 ---@inlinedoc
@@ -62,9 +79,9 @@ function Pos.new(row, col, opts)
 
   ---@type vim.Pos
   local self = setmetatable({
-    row = row,
-    col = col,
-    buf = opts.buf,
+    row,
+    col,
+    opts.buf,
   }, Pos)
 
   return self
@@ -176,31 +193,42 @@ function Pos.lsp(buf, pos, position_encoding)
   return Pos.new(row, col, { buf = buf })
 end
 
---- Converts |vim.Pos| to cursor position.
+--- Converts |vim.Pos| to cursor position (see |api-indexing|).
 ---@param pos vim.Pos
----@return [integer, integer]
+---@return integer, integer
 function Pos.to_cursor(pos)
-  return { pos.row + 1, pos.col }
+  return pos.row + 1, pos.col
 end
 
---- Creates a new |vim.Pos| from cursor position.
+--- Creates a new |vim.Pos| from cursor position (see |api-indexing|).
 ---@param pos [integer, integer]
-function Pos.cursor(pos)
-  return Pos.new(pos[1] - 1, pos[2])
+---@param opts vim.Pos.Optional|nil
+function Pos.cursor(pos, opts)
+  return Pos.new(pos[1] - 1, pos[2], opts)
 end
 
---- Converts |vim.Pos| to extmark position.
+--- Converts |vim.Pos| to extmark position (see |api-indexing|).
 ---@param pos vim.Pos
----@return [integer, integer]
+---@return integer, integer
 function Pos.to_extmark(pos)
-  return { pos.row, pos.col }
+  local line_num = #api.nvim_buf_get_lines(pos.buf, 0, -1, true)
+
+  local row = pos.row
+  local col = pos.col
+  if pos.col == 0 and pos.row == line_num then
+    row = row - 1
+    col = #get_line(pos.buf, row)
+  end
+
+  return row, col
 end
 
---- Creates a new |vim.Pos| from extmark position.
----@param pos [integer, integer]
-function Pos.extmark(pos)
-  local row, col = unpack(pos)
-  return Pos.new(row, col)
+--- Creates a new |vim.Pos| from extmark position (see |api-indexing|).
+---@param row integer
+---@param col integer
+---@param opts vim.Pos.Optional|nil
+function Pos.extmark(row, col, opts)
+  return Pos.new(row, col, opts)
 end
 
 -- Overload `Range.new` to allow calling this module as a function.