refactor(indent): backport improvements from main

* replace ts_utils.memoize_by_buftick by simpler implementation
* simplify construction of hash map
* prefer Neovim APIs
This commit is contained in:
Christian Clason 2023-05-17 13:27:49 +02:00
parent aa44e5fc5f
commit fa23ff4bd7

View file

@ -1,7 +1,5 @@
local parsers = require "nvim-treesitter.parsers"
local queries = require "nvim-treesitter.query"
local tsutils = require "nvim-treesitter.ts_utils"
local ts = vim.treesitter
local parsers = require "lua.nvim-treesitter.parsers"
local M = {}
@ -15,6 +13,10 @@ M.comment_parsers = {
phpdoc = true,
}
local function getline(lnum)
return vim.api.nvim_buf_get_lines(0, lnum - 1, lnum, false)[1] or ""
end
---@param root TSNode
---@param lnum integer
---@param col? integer
@ -29,10 +31,18 @@ end
---@param col? integer
---@return TSNode
local function get_last_node_at_line(root, lnum, col)
col = col or (#vim.fn.getline(lnum) - 1)
col = col or (#getline(lnum) - 1)
return root:descendant_for_range(lnum - 1, col, lnum - 1, col)
end
---@param node TSNode
---@return number
local function node_length(node)
local _, _, start_byte = node:start()
local _, _, end_byte = node:end_()
return end_byte - start_byte
end
---@param bufnr integer
---@param node TSNode
---@param delimiter string
@ -52,42 +62,50 @@ local function find_delimiter(bufnr, node, delimiter)
end
end
local get_indents = tsutils.memoize_by_buf_tick(function(bufnr, root, lang)
---Memoize a function using hash_fn to hash the arguments.
---@generic F: function
---@param fn F
---@param hash_fn fun(...): any
---@return F
local function memoize(fn, hash_fn)
local cache = setmetatable({}, { __mode = "kv" }) ---@type table<any,any>
return function(...)
local key = hash_fn(...)
if cache[key] == nil then
local v = fn(...) ---@type any
cache[key] = v ~= nil and v or vim.NIL
end
local v = cache[key]
return v ~= vim.NIL and v or nil
end
end
local get_indents = memoize(function(bufnr, root, lang)
local map = {
indent = {
auto = {},
begin = {},
["end"] = {},
dedent = {},
branch = {},
ignore = {},
align = {},
zero = {},
},
["indent.auto"] = {},
["indent.begin"] = {},
["indent.end"] = {},
["indent.dedent"] = {},
["indent.branch"] = {},
["indent.ignore"] = {},
["indent.align"] = {},
["indent.zero"] = {},
}
local function split(to_split)
local t = {}
for str in string.gmatch(to_split, "([^.]+)") do
table.insert(t, str)
--TODO(clason): remove when dropping Nvim 0.8 compat
local query = (ts.query.get or ts.get_query)(lang, "indents")
for id, node, metadata in query:iter_captures(root, bufnr) do
if query.captures[id]:sub(1, 1) ~= "_" then
map[query.captures[id]][node:id()] = metadata or {}
end
return t
end
for name, node, metadata in queries.iter_captures(bufnr, "indents", root, lang) do
local path = split(name)
-- node may contain a period so append directly.
table.insert(path, node:id())
queries.insert_to_path(map, path, metadata or {})
end
return map
end, {
-- Memoize by bufnr and lang together.
key = function(bufnr, root, lang)
return tostring(bufnr) .. root:id() .. "_" .. lang
end,
})
end, function(bufnr, root, lang)
return tostring(bufnr) .. root:id() .. "_" .. lang
end)
---@param lnum number (1-indexed)
function M.get_indent(lnum)
@ -97,6 +115,7 @@ function M.get_indent(lnum)
return -1
end
--TODO(clason): replace when dropping Nvim 0.8 compat
local root_lang = parsers.get_buf_lang(bufnr)
-- some languages like Python will actually have worse results when re-parsing at opened new line
@ -113,7 +132,7 @@ function M.get_indent(lnum)
end
local local_root = tstree:root()
if ts.is_in_node_range(local_root, lnum - 1, 0) then
if not root or tsutils.node_length(root) >= tsutils.node_length(local_root) then
if not root or node_length(root) >= node_length(local_root) then
root = local_root
lang_tree = tree
end
@ -126,12 +145,12 @@ function M.get_indent(lnum)
end
local q = get_indents(vim.api.nvim_get_current_buf(), root, lang_tree:lang())
local is_empty_line = string.match(vim.fn.getline(lnum), "^%s*$") ~= nil
local is_empty_line = string.match(getline(lnum), "^%s*$") ~= nil
local node ---@type TSNode
if is_empty_line then
local prevlnum = vim.fn.prevnonblank(lnum)
local indent = vim.fn.indent(prevlnum)
local prevline = vim.trim(vim.fn.getline(prevlnum))
local prevline = vim.trim(getline(prevlnum))
-- The final position can be trailing spaces, which should not affect indentation
node = get_last_node_at_line(root, prevlnum, indent + #prevline - 1)
if node:type():match "comment" then
@ -147,7 +166,7 @@ function M.get_indent(lnum)
node = get_last_node_at_line(root, prevlnum, col)
end
end
if q.indent["end"][node:id()] then
if q["indent.end"][node:id()] then
node = get_first_node_at_line(root, lnum)
end
else
@ -165,16 +184,16 @@ function M.get_indent(lnum)
-- tracks to ensure multiple indent levels are not applied for same line
local is_processed_by_row = {}
if q.indent.zero[node:id()] then
if q["indent.zero"][node:id()] then
return 0
end
while node do
-- do 'autoindent' if not marked as @indent
if
not q.indent.begin[node:id()]
and not q.indent.align[node:id()]
and q.indent.auto[node:id()]
not q["indent.begin"][node:id()]
and not q["indent.align"][node:id()]
and q["indent.auto"][node:id()]
and node:start() < lnum - 1
and lnum - 1 <= node:end_()
then
@ -185,8 +204,8 @@ function M.get_indent(lnum)
-- If a node spans from L1,C1 to L2,C2, we know that lines where L1 < line <= L2 would
-- have their indentations contained by the node.
if
not q.indent.begin[node:id()]
and q.indent.ignore[node:id()]
not q["indent.begin"][node:id()]
and q["indent.ignore"][node:id()]
and node:start() < lnum - 1
and lnum - 1 <= node:end_()
then
@ -199,7 +218,7 @@ function M.get_indent(lnum)
if
not is_processed_by_row[srow]
and ((q.indent.branch[node:id()] and srow == lnum - 1) or (q.indent.dedent[node:id()] and srow ~= lnum - 1))
and ((q["indent.branch"][node:id()] and srow == lnum - 1) or (q["indent.dedent"][node:id()] and srow ~= lnum - 1))
then
indent = indent - indent_size
is_processed = true
@ -215,16 +234,16 @@ function M.get_indent(lnum)
if
should_process
and (
q.indent.begin[node:id()]
and (srow ~= erow or is_in_err or q.indent.begin[node:id()]["indent.immediate"])
and (srow ~= lnum - 1 or q.indent.begin[node:id()]["indent.start_at_same_line"])
q["indent.begin"][node:id()]
and (srow ~= erow or is_in_err or q["indent.begin"][node:id()]["indent.immediate"])
and (srow ~= lnum - 1 or q["indent.begin"][node:id()]["indent.start_at_same_line"])
)
then
indent = indent + indent_size
is_processed = true
end
if is_in_err and not q.indent.align[node:id()] then
if is_in_err and not q["indent.align"][node:id()] then
-- only when the node is in error, promote the
-- first child's aligned indent to the error node
-- to work around ((ERROR "X" . (_)) @aligned_indent (#set! "delimeter" "AB"))
@ -232,15 +251,15 @@ function M.get_indent(lnum)
-- (ERROR "X" @aligned_indent (#set! "delimeter" "AB") . (_))
-- and we will fish it out here.
for c in node:iter_children() do
if q.indent.align[c:id()] then
q.indent.align[node:id()] = q.indent.align[c:id()]
if q["indent.align"][c:id()] then
q["indent.align"][node:id()] = q["indent.align"][c:id()]
break
end
end
end
-- do not indent for nodes that starts-and-ends on same line and starts on target line (lnum)
if should_process and q.indent.align[node:id()] and (srow ~= erow or is_in_err) and (srow ~= lnum - 1) then
local metadata = q.indent.align[node:id()]
if should_process and q["indent.align"][node:id()] and (srow ~= erow or is_in_err) and (srow ~= lnum - 1) then
local metadata = q["indent.align"][node:id()]
local o_delim_node, o_is_last_in_line ---@type TSNode|nil, boolean|nil
local c_delim_node, c_is_last_in_line ---@type TSNode|nil, boolean|nil, boolean|nil
local indent_is_absolute = false