mirror of
https://github.com/neovim/neovim.git
synced 2025-10-05 01:16:31 +00:00
8b171852a9
Problem:
Nvim does not have a core concept for indicating "progress" of
long-running tasks. The LspProgress event is specific to LSP.
Solution:
- `nvim_echo` can emit `kind="progress"` messages.
- Emits a `Progress` event.
- Includes new fields (id, status, percent) in the `msg_show` ui-event.
- The UI is expected to overwrite any message having the same id.
- Messages have a globally unique ID.
- `nvim_echo` returns the message ID.
- `nvim_echo(… {id=…})` updates existing messages.
Example:
local grp = vim.api.nvim_create_augroup("Msg", {clear = true})
vim.api.nvim_create_autocmd('Progress', {
pattern={"term"},
group = grp,
callback = function(ev)
print(string.format('event fired: %s', vim.inspect(ev))..'\n')
end
})
-- require('vim._extui').enable({enable=true, msg={target='msg', timeout=1000}})
vim.api.nvim_echo({{'searching'}}, true, {kind='progress', percent=80, status='running', title="terminal(ripgrep)"})
local id = vim.api.nvim_echo({{'searching'}}, true, {kind='progress', status='running', percent=10, title="terminal(ripgrep)"})
vim.api.nvim_echo({}, true, {id = id, kind='progress', percent=20, status = 'running', title='find tests'})
vim.api.nvim_echo({}, true, {id = id, kind='progress', status='running', percent=70})
vim.api.nvim_echo({{'complete'}}, true, {id = id, kind='progress', status='success', percent=100, title="find tests"})
Followups:
- Integrate with 'statusline' by listening to the Progress autocmd event.
- Integrate progress ui-event with `vim._extui`.
191 lines
7.8 KiB
C
191 lines
7.8 KiB
C
#pragma once
|
|
|
|
// This file is not compiled, just parsed for definitions
|
|
#error "don't include this file, include nvim/ui.h"
|
|
|
|
#include "nvim/api/private/defs.h"
|
|
#include "nvim/func_attr.h"
|
|
#include "nvim/ui.h"
|
|
|
|
void mode_info_set(Boolean enabled, Array cursor_styles)
|
|
FUNC_API_SINCE(3);
|
|
void update_menu(void)
|
|
FUNC_API_SINCE(3);
|
|
void busy_start(void)
|
|
FUNC_API_SINCE(3);
|
|
void busy_stop(void)
|
|
FUNC_API_SINCE(3);
|
|
void mouse_on(void)
|
|
FUNC_API_SINCE(3);
|
|
void mouse_off(void)
|
|
FUNC_API_SINCE(3);
|
|
void mode_change(String mode, Integer mode_idx)
|
|
FUNC_API_SINCE(3);
|
|
void bell(void)
|
|
FUNC_API_SINCE(3);
|
|
void visual_bell(void)
|
|
FUNC_API_SINCE(3);
|
|
void flush(void)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_IMPL;
|
|
void connect(Array args)
|
|
FUNC_API_SINCE(14) FUNC_API_REMOTE_ONLY FUNC_API_REMOTE_IMPL FUNC_API_CLIENT_IMPL;
|
|
void restart(String progpath, Array argv)
|
|
FUNC_API_SINCE(14) FUNC_API_REMOTE_ONLY FUNC_API_REMOTE_IMPL FUNC_API_CLIENT_IMPL;
|
|
void suspend(void)
|
|
FUNC_API_SINCE(3);
|
|
void set_title(String title)
|
|
FUNC_API_SINCE(3);
|
|
void set_icon(String icon)
|
|
FUNC_API_SINCE(3);
|
|
void screenshot(String path)
|
|
FUNC_API_SINCE(7);
|
|
void option_set(String name, Object value)
|
|
FUNC_API_SINCE(4);
|
|
void chdir(String path)
|
|
FUNC_API_SINCE(12);
|
|
// Stop event is not exported as such, represented by EOF in the msgpack stream.
|
|
void stop(void)
|
|
FUNC_API_NOEXPORT;
|
|
void ui_send(String content)
|
|
FUNC_API_SINCE(14) FUNC_API_REMOTE_IMPL;
|
|
|
|
// First revision of the grid protocol, used by default
|
|
void update_fg(Integer fg)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void update_bg(Integer bg)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void update_sp(Integer sp)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void resize(Integer width, Integer height)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void clear(void)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void eol_clear(void)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void cursor_goto(Integer row, Integer col)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void highlight_set(HlAttrs attrs)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY FUNC_API_REMOTE_IMPL;
|
|
void put(String str)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void set_scroll_region(Integer top, Integer bot, Integer left, Integer right)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void scroll(Integer count)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
|
|
// Second revision of the grid protocol, used with ext_linegrid ui option
|
|
void default_colors_set(Integer rgb_fg, Integer rgb_bg, Integer rgb_sp, Integer cterm_fg,
|
|
Integer cterm_bg)
|
|
FUNC_API_SINCE(4) FUNC_API_REMOTE_IMPL;
|
|
void hl_attr_define(Integer id, HlAttrs rgb_attrs, HlAttrs cterm_attrs, Array info)
|
|
FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL;
|
|
void hl_group_set(String name, Integer id)
|
|
FUNC_API_SINCE(6) FUNC_API_CLIENT_IGNORE;
|
|
void grid_resize(Integer grid, Integer width, Integer height)
|
|
FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL FUNC_API_CLIENT_IMPL;
|
|
void grid_clear(Integer grid)
|
|
FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL;
|
|
void grid_cursor_goto(Integer grid, Integer row, Integer col)
|
|
FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL;
|
|
void grid_line(Integer grid, Integer row, Integer col_start, Array data, Boolean wrap)
|
|
FUNC_API_SINCE(5) FUNC_API_REMOTE_ONLY FUNC_API_CLIENT_IMPL;
|
|
void grid_scroll(Integer grid, Integer top, Integer bot, Integer left, Integer right, Integer rows,
|
|
Integer cols)
|
|
FUNC_API_SINCE(5) FUNC_API_REMOTE_IMPL FUNC_API_COMPOSITOR_IMPL;
|
|
void grid_destroy(Integer grid)
|
|
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
|
|
|
|
// For performance and simplicity, we use the dense screen representation
|
|
// in internal code, such as compositor and TUI. The remote_ui module will
|
|
// translate this in to the public grid_line format.
|
|
void raw_line(Integer grid, Integer row, Integer startcol, Integer endcol, Integer clearcol,
|
|
Integer clearattr, LineFlags flags, const schar_T *chunk, const sattr_T *attrs)
|
|
FUNC_API_NOEXPORT FUNC_API_COMPOSITOR_IMPL;
|
|
|
|
void win_pos(Integer grid, Window win, Integer startrow, Integer startcol, Integer width,
|
|
Integer height)
|
|
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
|
|
void win_float_pos(Integer grid, Window win, String anchor, Integer anchor_grid, Float anchor_row,
|
|
Float anchor_col, Boolean mouse_enabled, Integer zindex, Integer compindex,
|
|
Integer screen_row, Integer screen_col)
|
|
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
|
|
void win_external_pos(Integer grid, Window win)
|
|
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
|
|
void win_hide(Integer grid)
|
|
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
|
|
void win_close(Integer grid)
|
|
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
|
|
|
|
void msg_set_pos(Integer grid, Integer row, Boolean scrolled, String sep_char, Integer zindex,
|
|
Integer compindex)
|
|
FUNC_API_SINCE(6) FUNC_API_COMPOSITOR_IMPL FUNC_API_CLIENT_IGNORE;
|
|
|
|
void win_viewport(Integer grid, Window win, Integer topline, Integer botline, Integer curline,
|
|
Integer curcol, Integer line_count, Integer scroll_delta)
|
|
FUNC_API_SINCE(7) FUNC_API_CLIENT_IGNORE;
|
|
|
|
void win_viewport_margins(Integer grid, Window win, Integer top, Integer bottom, Integer left,
|
|
Integer right)
|
|
FUNC_API_SINCE(12) FUNC_API_CLIENT_IGNORE;
|
|
|
|
void win_extmark(Integer grid, Window win, Integer ns_id, Integer mark_id, Integer row, Integer col)
|
|
FUNC_API_SINCE(10) FUNC_API_REMOTE_ONLY;
|
|
|
|
void popupmenu_show(Array items, Integer selected, Integer row, Integer col, Integer grid)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void popupmenu_hide(void)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void popupmenu_select(Integer selected)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
|
|
void tabline_update(Tabpage current, Array tabs, Buffer current_buffer, Array buffers)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
|
|
void cmdline_show(Array content, Integer pos, String firstc, String prompt, Integer indent,
|
|
Integer level, Integer hl_id)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void cmdline_pos(Integer pos, Integer level)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void cmdline_special_char(String c, Boolean shift, Integer level)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void cmdline_hide(Integer level, Boolean abort)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void cmdline_block_show(Array lines)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void cmdline_block_append(Array lines)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void cmdline_block_hide(void)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
|
|
void wildmenu_show(Array items)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void wildmenu_select(Integer selected)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
void wildmenu_hide(void)
|
|
FUNC_API_SINCE(3) FUNC_API_REMOTE_ONLY;
|
|
|
|
void msg_show(String kind, Array content, Boolean replace_last, Boolean history, Boolean append,
|
|
Object id, Dict progress)
|
|
FUNC_API_SINCE(6) FUNC_API_FAST FUNC_API_REMOTE_ONLY;
|
|
void msg_clear(void)
|
|
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
|
|
void msg_showcmd(Array content)
|
|
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
|
|
void msg_showmode(Array content)
|
|
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
|
|
void msg_ruler(Array content)
|
|
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
|
|
void msg_history_show(Array entries, Boolean prev_cmd)
|
|
FUNC_API_SINCE(6) FUNC_API_REMOTE_ONLY;
|
|
|
|
// This UI event is currently undocumented.
|
|
// - When the server needs to intentionally exit with an exit code, and there is no
|
|
// message in server stderr for the user, this event is sent with positive `status`
|
|
// argument, to indicate that the UI should exit normally with `status`.
|
|
// - When the server has crashed or there is a message in server stderr for the user,
|
|
// this event is not sent, and the UI should make server stderr visible.
|
|
// - When :detach is used on the server, this event is sent with a zero `status`
|
|
// argument, to indicate that the UI shouldn't wait for server exit.
|
|
void error_exit(Integer status)
|
|
FUNC_API_SINCE(12) FUNC_API_CLIENT_IMPL;
|