mirror of
https://github.com/neovim/neovim.git
synced 2026-05-24 05:40:08 +00:00
3ace049c6a
Problem: vim.hl.on_yank() only works for TextYankPost, not TextPutPost. Solution: Introduce hl_op(). Deprecate on_yank().
233 lines
6.9 KiB
Lua
233 lines
6.9 KiB
Lua
local api = vim.api
|
|
|
|
local M = {}
|
|
|
|
--- Table with default priorities used for highlighting:
|
|
--- - `syntax`: `50`, used for standard syntax highlighting
|
|
--- - `treesitter`: `100`, used for treesitter-based highlighting
|
|
--- - `semantic_tokens`: `125`, used for LSP semantic token highlighting
|
|
--- - `diagnostics`: `150`, used for code analysis such as diagnostics
|
|
--- - `user`: `200`, used for user-triggered highlights such as LSP document
|
|
--- symbols or `hl_op` autocommands
|
|
M.priorities = {
|
|
syntax = 50,
|
|
treesitter = 100,
|
|
semantic_tokens = 125,
|
|
diagnostics = 150,
|
|
user = 200,
|
|
}
|
|
|
|
--- @class vim.hl.range.Opts
|
|
--- @inlinedoc
|
|
---
|
|
--- Type of range. See [getregtype()]
|
|
--- (default: `'v'` i.e. charwise)
|
|
--- @field regtype? string
|
|
---
|
|
--- Indicates whether the range is end-inclusive
|
|
--- (default: `false`)
|
|
--- @field inclusive? boolean
|
|
---
|
|
--- Highlight priority
|
|
--- (default: `vim.hl.priorities.user`)
|
|
--- @field priority? integer
|
|
---
|
|
--- Time in ms before highlight is cleared
|
|
--- (default: -1 no timeout)
|
|
--- @field timeout? integer
|
|
|
|
--- Apply highlight group to range of text.
|
|
---
|
|
---@param buf integer Buffer number to apply highlighting to
|
|
---@param ns integer Namespace to add highlight to
|
|
---@param higroup string Highlight group to use for highlighting
|
|
---@param start [integer,integer]|string Start of region as a (line, column) tuple or string accepted by |getpos()|
|
|
---@param finish [integer,integer]|string End of region as a (line, column) tuple or string accepted by |getpos()|
|
|
---@param opts? vim.hl.range.Opts
|
|
--- @return uv.uv_timer_t? range_timer A timer which manages how much time the
|
|
--- highlight has left
|
|
--- @return fun()? range_clear A function which allows clearing the highlight manually.
|
|
--- nil is returned if timeout is not specified
|
|
function M.range(buf, ns, higroup, start, finish, opts)
|
|
opts = opts or {}
|
|
local regtype = opts.regtype or 'v'
|
|
local inclusive = opts.inclusive or false
|
|
local priority = opts.priority or M.priorities.user
|
|
local timeout = opts.timeout or -1
|
|
|
|
local v_maxcol = vim.v.maxcol
|
|
|
|
local pos1 = type(start) == 'string' and vim.fn.getpos(start)
|
|
or {
|
|
buf,
|
|
start[1] + 1,
|
|
start[2] ~= -1 and start[2] ~= v_maxcol and start[2] + 1 or v_maxcol,
|
|
0,
|
|
}
|
|
local pos2 = type(finish) == 'string' and vim.fn.getpos(finish)
|
|
or {
|
|
buf,
|
|
finish[1] + 1,
|
|
finish[2] ~= -1 and start[2] ~= v_maxcol and finish[2] + 1 or v_maxcol,
|
|
0,
|
|
}
|
|
|
|
local buf_line_count = api.nvim_buf_line_count(buf)
|
|
pos1[2] = math.min(pos1[2], buf_line_count)
|
|
pos2[2] = math.min(pos2[2], buf_line_count)
|
|
|
|
if pos1[2] <= 0 or pos1[3] <= 0 or pos2[2] <= 0 or pos2[3] <= 0 then
|
|
return
|
|
end
|
|
|
|
vim._with({ buf = buf }, function()
|
|
if pos1[3] ~= v_maxcol then
|
|
local max_col1 = vim.fn.col({ pos1[2], '$' })
|
|
pos1[3] = math.min(pos1[3], max_col1)
|
|
end
|
|
if pos2[3] ~= v_maxcol then
|
|
local max_col2 = vim.fn.col({ pos2[2], '$' })
|
|
pos2[3] = math.min(pos2[3], max_col2)
|
|
end
|
|
end)
|
|
|
|
local region = vim.fn.getregionpos(pos1, pos2, {
|
|
type = regtype,
|
|
exclusive = not inclusive,
|
|
eol = true,
|
|
})
|
|
-- For non-blockwise selection, use a single extmark.
|
|
if regtype == 'v' or regtype == 'V' then
|
|
--- @type [ [integer, integer, integer, integer], [integer, integer, integer, integer]][]
|
|
region = { { assert(region[1])[1], assert(region[#region])[2] } }
|
|
local region1 = assert(region[1])
|
|
if
|
|
regtype == 'V'
|
|
or region1[2][2] == pos1[2] and pos1[3] == v_maxcol
|
|
or region1[2][2] == pos2[2] and pos2[3] == v_maxcol
|
|
then
|
|
region1[2][2] = region1[2][2] + 1
|
|
region1[2][3] = 0
|
|
end
|
|
end
|
|
|
|
local extmarks = {} --- @type integer[]
|
|
for _, res in ipairs(region) do
|
|
local start_row = res[1][2] - 1
|
|
local start_col = res[1][3] - 1
|
|
local end_row = res[2][2] - 1
|
|
local end_col = res[2][3]
|
|
table.insert(
|
|
extmarks,
|
|
api.nvim_buf_set_extmark(buf, ns, start_row, start_col, {
|
|
hl_group = higroup,
|
|
end_row = end_row,
|
|
end_col = end_col,
|
|
priority = priority,
|
|
strict = false,
|
|
})
|
|
)
|
|
end
|
|
|
|
local range_hl_clear = function()
|
|
if not api.nvim_buf_is_valid(buf) then
|
|
return
|
|
end
|
|
for _, mark in ipairs(extmarks) do
|
|
api.nvim_buf_del_extmark(buf, ns, mark)
|
|
end
|
|
end
|
|
|
|
if timeout ~= -1 then
|
|
local range_timer = vim.defer_fn(range_hl_clear, timeout)
|
|
return range_timer, range_hl_clear
|
|
end
|
|
end
|
|
|
|
---@private
|
|
---@class (private) vim.hl.OnEventState
|
|
---@field timer? uv.uv_timer_t Timer to clear the highlight.
|
|
---@field clear? fun() Function to clear the highlight immediately.
|
|
|
|
--- @type { [string]: vim.hl.OnEventState }
|
|
local hl_op_state = {}
|
|
|
|
local events_ns = api.nvim_create_namespace('nvim.hl.events')
|
|
|
|
--- Highlight the related text region during a |TextYankPost| or |TextPutPost|
|
|
--- event.
|
|
---
|
|
--- Add the following to your `init.vim`:
|
|
---
|
|
--- ```vim
|
|
--- autocmd TextYankPost * silent! lua vim.hl.hl_op {higroup='Visual', timeout=300}
|
|
--- autocmd TextPutPost * silent! lua vim.hl.hl_op {higroup='Visual', timeout=300}
|
|
--- ```
|
|
---
|
|
--- @param opts table|nil Optional parameters
|
|
--- - event event structure (default vim.v.event)
|
|
--- - higroup highlight group for the text region (default "IncSearch")
|
|
--- - on_macro highlight when executing macro (default false)
|
|
--- - on_visual highlight when the event is in |Visual| mode (default true)
|
|
--- - priority integer priority (default |vim.hl.priorities|`.user`)
|
|
--- - timeout time in ms before highlight is cleared (default 150)
|
|
function M.hl_op(opts)
|
|
vim.validate('opts', opts, 'table', true)
|
|
opts = opts or {}
|
|
local event = opts.event or vim.v.event
|
|
local on_macro = opts.on_macro or false
|
|
local on_visual = (opts.on_visual ~= false)
|
|
|
|
if not on_macro and vim.fn.reg_executing() ~= '' then
|
|
return
|
|
end
|
|
if event.regtype == '' then
|
|
return
|
|
end
|
|
if not on_visual and event.visual then
|
|
return
|
|
end
|
|
|
|
local state_key --- @type string
|
|
if event.operator == 'y' then
|
|
state_key = 'yank'
|
|
elseif event.operator == 'p' or event.operator == 'P' then
|
|
state_key = 'put'
|
|
else
|
|
return
|
|
end
|
|
|
|
local higroup = opts.higroup or 'IncSearch'
|
|
|
|
local bufnr = api.nvim_get_current_buf()
|
|
local winid = api.nvim_get_current_win()
|
|
|
|
local state = hl_op_state[state_key]
|
|
if state ~= nil and state.timer and not state.timer:is_closing() then
|
|
state.timer:close()
|
|
assert(state.clear)
|
|
state.clear()
|
|
end
|
|
|
|
api.nvim__ns_set(events_ns, { wins = { winid } })
|
|
local timer, clear = M.range(bufnr, events_ns, higroup, "'[", "']", {
|
|
regtype = event.regtype,
|
|
inclusive = true,
|
|
priority = opts.priority or M.priorities.user,
|
|
timeout = opts.timeout or 150,
|
|
})
|
|
|
|
hl_op_state[state_key] = {
|
|
timer = timer,
|
|
clear = clear,
|
|
}
|
|
end
|
|
|
|
--- @deprecated Please use |vim.hl.hl_op()| instead.
|
|
function M.on_yank(opts)
|
|
vim.deprecate('vim.hl.on_yank', 'vim.hl.hl_op', '0.13')
|
|
return M.hl_op(opts)
|
|
end
|
|
|
|
return M
|