diff options
| author | Sean Dewar <seandewar@users.noreply.github.com> | 2023-07-23 19:50:20 +0100 |
|---|---|---|
| committer | Sean Dewar <seandewar@users.noreply.github.com> | 2023-07-26 20:44:46 +0100 |
| commit | 6b4970f6e0ac36021b2a8bd0533f5078040d31f7 (patch) | |
| tree | 32475f64281855f8a1cb6a62d3f232a1906cf9bd /runtime | |
| parent | ccf328172bac2b02f9bd19fa58e105958514a28a (diff) | |
| download | rneovim-6b4970f6e0ac36021b2a8bd0533f5078040d31f7.tar.gz rneovim-6b4970f6e0ac36021b2a8bd0533f5078040d31f7.tar.bz2 rneovim-6b4970f6e0ac36021b2a8bd0533f5078040d31f7.zip | |
feat(api): allow open_win/win_set_buf in the cmdwin in some cases
Problem: As discussed on Matrix, there was some interest in having
`nvim_open_win` again be able to open floats in the cmdwin (e.g: displaying a
hover doc related to what's in the cmdwin). After #23228, this was disallowed.
Solution: Allow `nvim_open_win` in the cmdwin as long as `!enter` and
`buffer != curbuf` (the former can cause all sorts of issues, and the latter
can crash Nvim after closing cmdwin). Also allow `nvim_win_set_buf` in a similar
fashion.
Note that we're not *entirely* sure if this is 100% safe (cmdwin is a
global-state-using-main-loop-calling beast), but this seems to work OK..?
Also:
- Check the buffer argument of `nvim_open_win` earlier, and abort if it's
invalid (it used to still open a window in this case).
- Untranslate `e_cmdwin` errors in the API (other errors in the API are not
translated: although not detailed in the API contract yet, errors are
supposed to be stable).
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/api.txt | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt index 5b6a901970..1e5b6b0b40 100644 --- a/runtime/doc/api.txt +++ b/runtime/doc/api.txt @@ -2915,7 +2915,7 @@ nvim_win_set_buf({window}, {buffer}) *nvim_win_set_buf()* Sets the current buffer in a window, without side effects Attributes: ~ - not allowed when |textlock| is active or in the |cmdwin| + not allowed when |textlock| is active Parameters: ~ • {window} Window handle, or 0 for current window @@ -3036,7 +3036,7 @@ nvim_open_win({buffer}, {enter}, {*config}) *nvim_open_win()* < Attributes: ~ - not allowed when |textlock| is active or in the |cmdwin| + not allowed when |textlock| is active Parameters: ~ • {buffer} Buffer to display, or 0 for current buffer |