aboutsummaryrefslogtreecommitdiff
path: root/runtime
diff options
context:
space:
mode:
authorSean Dewar <seandewar@users.noreply.github.com>2023-04-20 21:17:25 +0100
committerSean Dewar <seandewar@users.noreply.github.com>2023-07-05 08:31:52 +0100
commit77118d0da8badc4135be430f4cbb15bc95bc760f (patch)
treee1168e881f49751b807524559720e5212661244e /runtime
parentb2e8c0df2062f765a4cf7d96379c5f0f19393dfd (diff)
downloadrneovim-77118d0da8badc4135be430f4cbb15bc95bc760f.tar.gz
rneovim-77118d0da8badc4135be430f4cbb15bc95bc760f.tar.bz2
rneovim-77118d0da8badc4135be430f4cbb15bc95bc760f.zip
fix(api): use text_locked() to check textlock
Problem: some API functions that check textlock (usually those that can change curwin or curbuf) can break the cmdwin. Solution: make FUNC_API_CHECK_TEXTLOCK call text_locked() instead, which already checks for textlock, cmdwin and `<expr>` status. Add FUNC_API_TEXTLOCK_ALLOW_CMDWIN to allow such functions to be usable in the cmdwin if they can work properly there; the opt-in nature of this attribute should hopefully help mitigate future bugs. Also fix a regression in #22634 that made functions checking textlock usable in `<expr>` mappings, and rename FUNC_API_CHECK_TEXTLOCK to FUNC_API_TEXTLOCK.
Diffstat (limited to 'runtime')
-rw-r--r--runtime/doc/api.txt14
1 files changed, 7 insertions, 7 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 87ea000047..203468cc8a 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -1365,7 +1365,7 @@ nvim_set_current_buf({buffer}) *nvim_set_current_buf()*
Sets the current buffer.
Attributes: ~
- not allowed when |textlock| is active
+ not allowed when |textlock| is active or in the |cmdwin|
Parameters: ~
• {buffer} Buffer handle
@@ -1389,7 +1389,7 @@ nvim_set_current_tabpage({tabpage}) *nvim_set_current_tabpage()*
Sets the current tabpage.
Attributes: ~
- not allowed when |textlock| is active
+ not allowed when |textlock| is active or in the |cmdwin|
Parameters: ~
• {tabpage} Tabpage handle
@@ -1398,7 +1398,7 @@ nvim_set_current_win({window}) *nvim_set_current_win()*
Sets the current window.
Attributes: ~
- not allowed when |textlock| is active
+ not allowed when |textlock| is active or in the |cmdwin|
Parameters: ~
• {window} Window handle
@@ -2163,7 +2163,7 @@ nvim_buf_delete({buffer}, {opts}) *nvim_buf_delete()*
Deletes the buffer. See |:bwipeout|
Attributes: ~
- not allowed when |textlock| is active
+ not allowed when |textlock| is active or in the |cmdwin|
Parameters: ~
• {buffer} Buffer handle, or 0 for current buffer
@@ -2894,7 +2894,7 @@ nvim_win_hide({window}) *nvim_win_hide()*
or |nvim_win_close()|, which will close the buffer.
Attributes: ~
- not allowed when |textlock| is active
+ not allowed when |textlock| is active or in the |cmdwin|
Parameters: ~
• {window} Window handle, or 0 for current window
@@ -2912,7 +2912,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
+ not allowed when |textlock| is active or in the |cmdwin|
Parameters: ~
• {window} Window handle, or 0 for current window
@@ -2999,7 +2999,7 @@ nvim_open_win({buffer}, {enter}, {*config}) *nvim_open_win()*
<
Attributes: ~
- not allowed when |textlock| is active
+ not allowed when |textlock| is active or in the |cmdwin|
Parameters: ~
• {buffer} Buffer to display, or 0 for current buffer