diff options
Diffstat (limited to 'runtime')
| -rw-r--r-- | runtime/doc/autocmd.txt | 21 | ||||
| -rw-r--r-- | runtime/doc/builtin.txt | 29 | ||||
| -rw-r--r-- | runtime/doc/vim_diff.txt | 1 | ||||
| -rw-r--r-- | runtime/lua/vim/_meta/vimfn.lua | 32 |
4 files changed, 83 insertions, 0 deletions
diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt index a7c28e25d0..90211fc5db 100644 --- a/runtime/doc/autocmd.txt +++ b/runtime/doc/autocmd.txt @@ -862,6 +862,27 @@ RecordingLeave When a macro stops recording. Sets these |v:event| keys: regcontents regname + *SafeState* +SafeState When nothing is pending, going to wait for the + user to type a character. + This will not be triggered when: + - an operator is pending + - a register was entered with "r + - halfway executing a command + - executing a mapping + - there is typeahead + - Insert mode completion is active + - Command line completion is active + You can use `mode()` to find out what state + Vim is in. That may be: + - VIsual mode + - Normal mode + - Insert mode + - Command-line mode + Depending on what you want to do, you may also + check more with `state()`, e.g. whether the + screen was scrolled for messages. + *SessionLoadPost* SessionLoadPost After loading the session file created using the |:mksession| command. diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 92cedbdc80..2ce66d8cc2 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -4753,6 +4753,7 @@ mode([expr]) *mode()* If [expr] is supplied and it evaluates to a non-zero Number or a non-empty String (|non-zero-arg|), then the full mode is returned, otherwise only the first letter is returned. + Also see |state()|. n Normal no Operator-pending @@ -7368,6 +7369,34 @@ srand([{expr}]) *srand()* echo rand(seed) < +state([{what}]) *state()* + Return a string which contains characters indicating the + current state. Mostly useful in callbacks that want to do + work that may not always be safe. Roughly this works like: + - callback uses state() to check if work is safe to do. + If yes, then do it right away. + Otherwise add to work queue and add SafeState autocommand. + - When SafeState is triggered, check with state() if the work + can be done now, and if yes remove it from the queue and + execute. + Also see |mode()|. + + When {what} is given only characters in this string will be + added. E.g, this checks if the screen has scrolled: >vim + if state('s') != '' + + These characters indicate the state, generally indicating that + something is busy: + m halfway a mapping, :normal command, feedkeys() or + stuffed command + o operator pending or waiting for a command argument + a Insert mode autocomplete active + x executing an autocommand + S not triggering SafeState + c callback invoked, including timer (repeats for + recursiveness up to "ccc") + s screen has scrolled for messages + stdioopen({opts}) *stdioopen()* With |--headless| this opens stdin and stdout as a |channel|. May be called only once. See |channel-stdio|. stderr is not diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt index b7bb52333d..29a7c50585 100644 --- a/runtime/doc/vim_diff.txt +++ b/runtime/doc/vim_diff.txt @@ -619,6 +619,7 @@ Eval: *v:sizeofpointer* Events: + *SafeStateAgain* *SigUSR1* Use |Signal| to detect `SIGUSR1` signal instead. Highlight groups: diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua index 300210b296..70d1aa4a79 100644 --- a/runtime/lua/vim/_meta/vimfn.lua +++ b/runtime/lua/vim/_meta/vimfn.lua @@ -5713,6 +5713,7 @@ function vim.fn.mkdir(name, flags, prot) end --- If [expr] is supplied and it evaluates to a non-zero Number or --- a non-empty String (|non-zero-arg|), then the full mode is --- returned, otherwise only the first letter is returned. +--- Also see |state()|. --- --- n Normal --- no Operator-pending @@ -8744,6 +8745,37 @@ function vim.fn.sqrt(expr) end --- @return any function vim.fn.srand(expr) end +--- Return a string which contains characters indicating the +--- current state. Mostly useful in callbacks that want to do +--- work that may not always be safe. Roughly this works like: +--- - callback uses state() to check if work is safe to do. +--- If yes, then do it right away. +--- Otherwise add to work queue and add SafeState autocommand. +--- - When SafeState is triggered, check with state() if the work +--- can be done now, and if yes remove it from the queue and +--- execute. +--- Also see |mode()|. +--- +--- When {what} is given only characters in this string will be +--- added. E.g, this checks if the screen has scrolled: >vim +--- if state('s') != '' +--- +--- These characters indicate the state, generally indicating that +--- something is busy: +--- m halfway a mapping, :normal command, feedkeys() or +--- stuffed command +--- o operator pending or waiting for a command argument +--- a Insert mode autocomplete active +--- x executing an autocommand +--- S not triggering SafeState +--- c callback invoked, including timer (repeats for +--- recursiveness up to "ccc") +--- s screen has scrolled for messages +--- +--- @param what? string +--- @return any +function vim.fn.state(what) end + --- With |--headless| this opens stdin and stdout as a |channel|. --- May be called only once. See |channel-stdio|. stderr is not --- handled by this function, see |v:stderr|. |