mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-11-30 22:20:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #24820 from zeertzjq/vim-589edb340454

Browse Source 
vim-patch:589edb340454,e46a44050562
This commit is contained in:
zeertzjq
2023-08-21 17:37:15 +08:00
committed by GitHub
parent 8cd0ca1ce7 6bdfb890fd
commit 4a1fb37108
3 changed files with 58 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
runtime/doc/builtin.txt generated
View File

@@ -2662,7 +2662,7 @@ getmatches([{win}]) *getmatches()*
< <
getmousepos() *getmousepos()* getmousepos() *getmousepos()*
Returns a Dictionary with the last known position of the Returns a |Dictionary| with the last known position of the
mouse. This can be used in a mapping for a mouse click. The mouse. This can be used in a mapping for a mouse click. The
items are: items are:
screenrow screen row screenrow screen row
@@ -5741,7 +5741,7 @@ screenchar({row}, {col}) *screenchar()*
Returns -1 when row or col is out of range. Returns -1 when row or col is out of range.
screenchars({row}, {col}) *screenchars()* screenchars({row}, {col}) *screenchars()*
The result is a List of Numbers. The first number is the same The result is a |List| of Numbers. The first number is the same
as what |screenchar()| returns. Further numbers are as what |screenchar()| returns. Further numbers are
composing characters on top of the base character. composing characters on top of the base character.
This is mainly to be used for testing. This is mainly to be used for testing.
@@ -5908,7 +5908,7 @@ searchcount([{options}]) *searchcount()*
without the "S" flag in 'shortmess'. This works even if without the "S" flag in 'shortmess'. This works even if
'shortmess' does contain the "S" flag. 'shortmess' does contain the "S" flag.
This returns a Dictionary. The dictionary is empty if the This returns a |Dictionary|. The dictionary is empty if the
previous pattern was not set and "pattern" was not specified. previous pattern was not set and "pattern" was not specified.
key type meaning ~ key type meaning ~
@@ -5990,7 +5990,7 @@ searchcount([{options}]) *searchcount()*
" search again " search again
call searchcount() call searchcount()
< <
{options} must be a Dictionary. It can contain: {options} must be a |Dictionary|. It can contain:
key type meaning ~ key type meaning ~
recompute |Boolean| if |TRUE|, recompute the count recompute |Boolean| if |TRUE|, recompute the count
like |n| or |N| was executed. like |n| or |N| was executed.
@@ -7374,25 +7374,27 @@ state([{what}]) *state()*
current state. Mostly useful in callbacks that want to do current state. Mostly useful in callbacks that want to do
work that may not always be safe. Roughly this works like: work that may not always be safe. Roughly this works like:
- callback uses state() to check if work is safe to do. - callback uses state() to check if work is safe to do.
If yes, then do it right away. Yes: then do it right away.
Otherwise add to work queue and add SafeState autocommand. No: add to work queue and add a |SafeState| autocommand.
- When SafeState is triggered, check with state() if the work - When SafeState is triggered and executes your autocommand,
can be done now, and if yes remove it from the queue and check with `state()` if the work can be done now, and if yes
execute. remove it from the queue and execute.
Remove the autocommand if the queue is now empty.
Also see |mode()|. Also see |mode()|.
When {what} is given only characters in this string will be When {what} is given only characters in this string will be
added. E.g, this checks if the screen has scrolled: >vim added. E.g, this checks if the screen has scrolled: >vim
if state('s') != '' if state('s') == ''
" screen has not scrolled
These characters indicate the state, generally indicating that These characters indicate the state, generally indicating that
something is busy: something is busy:
m halfway a mapping, :normal command, feedkeys() or m halfway a mapping, :normal command, feedkeys() or
stuffed command stuffed command
o operator pending or waiting for a command argument o operator pending, e.g. after |d|
a Insert mode autocomplete active a Insert mode autocomplete active
x executing an autocommand x executing an autocommand
S not triggering SafeState S not triggering SafeState, e.g. after |f| or a count
c callback invoked, including timer (repeats for c callback invoked, including timer (repeats for
recursiveness up to "ccc") recursiveness up to "ccc")
s screen has scrolled for messages s screen has scrolled for messages

26
runtime/lua/vim/_meta/vimfn.lua generated
View File

@@ -3230,7 +3230,7 @@ function vim.fn.getmarklist(buf) end
--- @return any --- @return any
function vim.fn.getmatches(win) end function vim.fn.getmatches(win) end
--- Returns a Dictionary with the last known position of the --- Returns a |Dictionary| with the last known position of the
--- mouse. This can be used in a mapping for a mouse click. The --- mouse. This can be used in a mapping for a mouse click. The
--- items are: --- items are:
--- screenrow screen row --- screenrow screen row
@@ -6878,7 +6878,7 @@ function vim.fn.screenattr(row, col) end
--- @return any --- @return any
function vim.fn.screenchar(row, col) end function vim.fn.screenchar(row, col) end
--- The result is a List of Numbers. The first number is the same --- The result is a |List| of Numbers. The first number is the same
--- as what |screenchar()| returns. Further numbers are --- as what |screenchar()| returns. Further numbers are
--- composing characters on top of the base character. --- composing characters on top of the base character.
--- This is mainly to be used for testing. --- This is mainly to be used for testing.
@@ -7069,7 +7069,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
--- without the "S" flag in 'shortmess'. This works even if --- without the "S" flag in 'shortmess'. This works even if
--- 'shortmess' does contain the "S" flag. --- 'shortmess' does contain the "S" flag.
--- ---
--- This returns a Dictionary. The dictionary is empty if the --- This returns a |Dictionary|. The dictionary is empty if the
--- previous pattern was not set and "pattern" was not specified. --- previous pattern was not set and "pattern" was not specified.
--- ---
--- key type meaning ~ --- key type meaning ~
@@ -7151,7 +7151,7 @@ function vim.fn.search(pattern, flags, stopline, timeout, skip) end
--- " search again --- " search again
--- call searchcount() --- call searchcount()
--- < --- <
--- {options} must be a Dictionary. It can contain: --- {options} must be a |Dictionary|. It can contain:
--- key type meaning ~ --- key type meaning ~
--- recompute |Boolean| if |TRUE|, recompute the count --- recompute |Boolean| if |TRUE|, recompute the count
--- like |n| or |N| was executed. --- like |n| or |N| was executed.
@@ -8749,25 +8749,27 @@ function vim.fn.srand(expr) end
--- current state. Mostly useful in callbacks that want to do --- current state. Mostly useful in callbacks that want to do
--- work that may not always be safe. Roughly this works like: --- work that may not always be safe. Roughly this works like:
--- - callback uses state() to check if work is safe to do. --- - callback uses state() to check if work is safe to do.
--- If yes, then do it right away. --- Yes: then do it right away.
--- Otherwise add to work queue and add SafeState autocommand. --- No: add to work queue and add a |SafeState| autocommand.
--- - When SafeState is triggered, check with state() if the work --- - When SafeState is triggered and executes your autocommand,
--- can be done now, and if yes remove it from the queue and --- check with `state()` if the work can be done now, and if yes
--- execute. --- remove it from the queue and execute.
--- Remove the autocommand if the queue is now empty.
--- Also see |mode()|. --- Also see |mode()|.
--- ---
--- When {what} is given only characters in this string will be --- When {what} is given only characters in this string will be
--- added. E.g, this checks if the screen has scrolled: >vim --- added. E.g, this checks if the screen has scrolled: >vim
--- if state('s') != '' --- if state('s') == ''
--- " screen has not scrolled
--- ---
--- These characters indicate the state, generally indicating that --- These characters indicate the state, generally indicating that
--- something is busy: --- something is busy:
--- m halfway a mapping, :normal command, feedkeys() or --- m halfway a mapping, :normal command, feedkeys() or
--- stuffed command --- stuffed command
--- o operator pending or waiting for a command argument --- o operator pending, e.g. after |d|
--- a Insert mode autocomplete active --- a Insert mode autocomplete active
--- x executing an autocommand --- x executing an autocommand
--- S not triggering SafeState --- S not triggering SafeState, e.g. after |f| or a count
--- c callback invoked, including timer (repeats for --- c callback invoked, including timer (repeats for
--- recursiveness up to "ccc") --- recursiveness up to "ccc")
--- s screen has scrolled for messages --- s screen has scrolled for messages

26
src/nvim/eval.lua
View File

@@ -4012,7 +4012,7 @@ M.funcs = {
}, },
getmousepos = { getmousepos = {
desc = [=[ desc = [=[
Returns a Dictionary with the last known position of the Returns a |Dictionary| with the last known position of the
mouse. This can be used in a mapping for a mouse click. The mouse. This can be used in a mapping for a mouse click. The
items are: items are:
screenrow screen row screenrow screen row
@@ -8296,7 +8296,7 @@ M.funcs = {
args = 2, args = 2,
base = 1, base = 1,
desc = [=[ desc = [=[
The result is a List of Numbers. The first number is the same The result is a |List| of Numbers. The first number is the same
as what |screenchar()| returns. Further numbers are as what |screenchar()| returns. Further numbers are
composing characters on top of the base character. composing characters on top of the base character.
This is mainly to be used for testing. This is mainly to be used for testing.
@@ -8511,7 +8511,7 @@ M.funcs = {
without the "S" flag in 'shortmess'. This works even if without the "S" flag in 'shortmess'. This works even if
'shortmess' does contain the "S" flag. 'shortmess' does contain the "S" flag.
This returns a Dictionary. The dictionary is empty if the This returns a |Dictionary|. The dictionary is empty if the
previous pattern was not set and "pattern" was not specified. previous pattern was not set and "pattern" was not specified.
key type meaning ~ key type meaning ~
@@ -8593,7 +8593,7 @@ M.funcs = {
" search again " search again
call searchcount() call searchcount()
< <
{options} must be a Dictionary. It can contain: {options} must be a |Dictionary|. It can contain:
key type meaning ~ key type meaning ~
recompute |Boolean| if |TRUE|, recompute the count recompute |Boolean| if |TRUE|, recompute the count
like |n| or |N| was executed. like |n| or |N| was executed.
@@ -10460,25 +10460,27 @@ M.funcs = {
current state. Mostly useful in callbacks that want to do current state. Mostly useful in callbacks that want to do
work that may not always be safe. Roughly this works like: work that may not always be safe. Roughly this works like:
- callback uses state() to check if work is safe to do. - callback uses state() to check if work is safe to do.
If yes, then do it right away. Yes: then do it right away.
Otherwise add to work queue and add SafeState autocommand. No: add to work queue and add a |SafeState| autocommand.
- When SafeState is triggered, check with state() if the work - When SafeState is triggered and executes your autocommand,
can be done now, and if yes remove it from the queue and check with `state()` if the work can be done now, and if yes
execute. remove it from the queue and execute.
Remove the autocommand if the queue is now empty.
Also see |mode()|. Also see |mode()|.
When {what} is given only characters in this string will be When {what} is given only characters in this string will be
added. E.g, this checks if the screen has scrolled: >vim added. E.g, this checks if the screen has scrolled: >vim
if state('s') != '' if state('s') == ''
" screen has not scrolled
These characters indicate the state, generally indicating that These characters indicate the state, generally indicating that
something is busy: something is busy:
m halfway a mapping, :normal command, feedkeys() or m halfway a mapping, :normal command, feedkeys() or
stuffed command stuffed command
o operator pending or waiting for a command argument o operator pending, e.g. after |d|
a Insert mode autocomplete active a Insert mode autocomplete active
x executing an autocommand x executing an autocommand
S not triggering SafeState S not triggering SafeState, e.g. after |f| or a count
c callback invoked, including timer (repeats for c callback invoked, including timer (repeats for
recursiveness up to "ccc") recursiveness up to "ccc")
s screen has scrolled for messages s screen has scrolled for messages