feat(api): add nvim__redraw for more granular redrawing

Experimental and subject to future changes.
Add a way to redraw certain elements that are not redrawn while Nvim is waiting
for input, or currently have no API to do so. This API covers all that can be
done with the :redraw* commands, in addition to the following new features:
- Immediately move the cursor to a (non-current) window.
- Target a specific window or buffer to mark for redraw.
- Mark a buffer range for redraw (replaces nvim__buf_redraw_range()).
- Redraw the 'statuscolumn'.
This commit is contained in:
Luuk van Baal
2024-04-10 11:42:46 +02:00
parent 7b14eb543d
commit 037ea6e786
17 changed files with 540 additions and 31 deletions

View File

@@ -12,12 +12,6 @@ vim.api = {}
--- @return string
function vim.api.nvim__buf_debug_extmarks(buffer, keys, dot) end
--- @private
--- @param buffer integer
--- @param first integer
--- @param last integer
function vim.api.nvim__buf_redraw_range(buffer, first, last) end
--- @private
--- @param buffer integer
--- @return table<string,any>
@@ -105,6 +99,32 @@ function vim.api.nvim__inspect_cell(grid, row, col) end
---
function vim.api.nvim__invalidate_glyph_cache() end
--- @private
--- EXPERIMENTAL: this API may change in the future.
---
--- Instruct Nvim to redraw various components.
---
--- @param opts vim.api.keyset.redraw Optional parameters.
--- • win: Target a specific `window-ID` as described below.
--- • buf: Target a specific buffer number as described below.
--- • flush: Update the screen with pending updates.
--- • valid: When present mark `win`, `buf`, or all windows for
--- redraw. When `true`, only redraw changed lines (useful for
--- decoration providers). When `false`, forcefully redraw.
--- • range: Redraw a range in `buf`, the buffer in `win` or the
--- current buffer (useful for decoration providers). Expects a
--- tuple `[first, last]` with the first and last line number of
--- the range, 0-based end-exclusive `api-indexing`.
--- • cursor: Immediately update cursor position on the screen in
--- `win` or the current window.
--- • statuscolumn: Redraw the 'statuscolumn' in `buf`, `win` or
--- all windows.
--- • statusline: Redraw the 'statusline' in `buf`, `win` or all
--- windows.
--- • winbar: Redraw the 'winbar' in `buf`, `win` or all windows.
--- • tabline: Redraw the 'tabline'.
function vim.api.nvim__redraw(opts) end
--- @private
--- @return any[]
function vim.api.nvim__runtime_inspect() end