mirror of
https://github.com/neovim/neovim.git
synced 2026-03-31 04:42:03 +00:00
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.
103 lines
2.6 KiB
Lua
103 lines
2.6 KiB
Lua
-- Test suite for vim.range
|
|
local t = require('test.testutil')
|
|
local n = require('test.functional.testnvim')()
|
|
local eq = t.eq
|
|
|
|
local clear = n.clear
|
|
local exec_lua = n.exec_lua
|
|
local insert = n.insert
|
|
|
|
describe('vim.range', function()
|
|
before_each(clear)
|
|
|
|
it('creates a range with or without optional fields', function()
|
|
local range = exec_lua(function()
|
|
return vim.range(3, 5, 4, 6)
|
|
end)
|
|
eq(3, range[1])
|
|
eq(5, range[2])
|
|
eq(4, range[3])
|
|
eq(6, range[4])
|
|
eq(nil, range[5])
|
|
local buf = exec_lua(function()
|
|
return vim.api.nvim_create_buf(false, true)
|
|
end)
|
|
range = exec_lua(function()
|
|
return vim.range(3, 5, 4, 6, { buf = buf })
|
|
end)
|
|
eq(buf, range[5])
|
|
end)
|
|
|
|
it('creates a range from two positions when optional fields are not matched', function()
|
|
local range = exec_lua(function()
|
|
return vim.range(vim.pos(3, 5), vim.pos(4, 6))
|
|
end)
|
|
eq(3, range[1])
|
|
eq(5, range[2])
|
|
eq(4, range[3])
|
|
eq(6, range[4])
|
|
eq(nil, range[5])
|
|
|
|
local buf1 = exec_lua(function()
|
|
return vim.api.nvim_create_buf(false, true)
|
|
end)
|
|
range = exec_lua(function()
|
|
return vim.range(vim.pos(3, 5, { buf = buf1 }), vim.pos(4, 6, { buf = buf1 }))
|
|
end)
|
|
eq(buf1, range[5])
|
|
|
|
local buf2 = exec_lua(function()
|
|
return vim.api.nvim_create_buf(false, true)
|
|
end)
|
|
local success = exec_lua(function()
|
|
return pcall(function()
|
|
return vim.range(vim.pos(3, 5, { buf = buf1 }), vim.pos(4, 6, { buf = buf2 }))
|
|
end)
|
|
end)
|
|
eq(success, false)
|
|
end)
|
|
|
|
it('converts between vim.Range and lsp.Range', function()
|
|
local buf = exec_lua(function()
|
|
return vim.api.nvim_get_current_buf()
|
|
end)
|
|
insert('Neovim 是 Vim 的分支,专注于扩展性和可用性。')
|
|
local lsp_range = exec_lua(function()
|
|
local range = vim.range(0, 10, 0, 36, { buf = buf })
|
|
return range:to_lsp('utf-16')
|
|
end)
|
|
eq({
|
|
['start'] = { line = 0, character = 8 },
|
|
['end'] = { line = 0, character = 20 },
|
|
}, lsp_range)
|
|
local range = exec_lua(function()
|
|
return vim.range.lsp(buf, lsp_range, 'utf-16')
|
|
end)
|
|
eq({
|
|
0,
|
|
10,
|
|
0,
|
|
36,
|
|
buf,
|
|
}, range)
|
|
end)
|
|
|
|
it('checks whether a range contains a position', function()
|
|
eq(
|
|
true,
|
|
exec_lua(function()
|
|
return vim.range(0, 0, 1, 5):has(vim.pos(0, 1))
|
|
end)
|
|
)
|
|
end)
|
|
|
|
it('checks whether a range does not contain an empty range just outside it', function()
|
|
eq(
|
|
false,
|
|
exec_lua(function()
|
|
return vim.range(0, 0, 0, 4):has(vim.range(0, 0, 0, 0))
|
|
end)
|
|
)
|
|
end)
|
|
end)
|