mirror of
https://github.com/neovim/neovim.git
synced 2026-01-29 16:40:59 +10: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`.
31 lines
1.0 KiB
C
31 lines
1.0 KiB
C
#pragma once
|
|
|
|
#include <stdbool.h>
|
|
|
|
#include "nvim/api/private/defs.h"
|
|
|
|
typedef struct {
|
|
String text;
|
|
int hl_id;
|
|
} HlMessageChunk;
|
|
|
|
typedef kvec_t(HlMessageChunk) HlMessage;
|
|
#define MsgID Union(Integer, String)
|
|
|
|
typedef struct msg_data {
|
|
Integer percent; ///< Progress percentage
|
|
String title; ///< Title for progress message
|
|
String status; ///< Status for progress message
|
|
DictOf(String, Object) data; ///< Extra info for 'echo' messages
|
|
} MessageData;
|
|
/// Message history for `:messages`
|
|
typedef struct msg_hist {
|
|
struct msg_hist *next; ///< Next message.
|
|
struct msg_hist *prev; ///< Previous message.
|
|
HlMessage msg; ///< Highlighted message.
|
|
const char *kind; ///< Message kind (for msg_ext)
|
|
bool temp; ///< Temporary message since last command ("g<")
|
|
bool append; ///< Message should be appended to previous entry, as opposed
|
|
///< to on a new line (|ui-messages|->msg_show->append).
|
|
} MessageHistoryEntry;
|