mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-12-16 03:15:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

vim-patch:9.1.0120: hard to get visual region using Vim script

Browse Source 
Problem:  hard to get visual region using Vim script
Solution: Add getregion() Vim script function
          (Shougo Matsushita, Jakub Łuczyński)

closes: vim/vim#13998
closes: vim/vim#11579

3f905ab3c4

Cherry-pick changes from patch 9.1.0122, with :echom instead of :echow.

Co-authored-by: Shougo Matsushita <Shougo.Matsu@gmail.com>
Co-authored-by: Jakub Łuczyński <doubleloop@o2.pl>
This commit is contained in:
zeertzjq
2024-02-22 20:32:52 +08:00
parent bb15fa0356
commit 20e4001eee
8 changed files with 500 additions and 78 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -3525,6 +3525,46 @@ function vim.fn.getreg(regname, list) end
--- @return table
function vim.fn.getreginfo(regname) end
--- Returns the list of strings from {pos1} to {pos2} as if it's
--- selected in visual mode of {type}.
--- For possible values of {pos1} and {pos2} see |line()|.
--- {type} is the selection type:
--- "v" for |charwise| mode
--- "V" for |linewise| mode
--- "<CTRL-V>" for |blockwise-visual| mode
--- You can get the last selection type by |visualmode()|.
--- If Visual mode is active, use |mode()| to get the Visual mode
--- (e.g., in a |:vmap|).
--- This function uses the line and column number from the
--- specified position.
--- It is useful to get text starting and ending in different
--- columns, such as |charwise-visual| selection.
---
--- Note that:
--- - Order of {pos1} and {pos2} doesn't matter, it will always
--- return content from the upper left position to the lower
--- right position.
--- - If 'virtualedit' is enabled and selection is past the end of
--- line, resulting lines are filled with blanks.
--- - If the selection starts or ends in the middle of a multibyte
--- character, it is not included but its selected part is
--- substituted with spaces.
--- - If {pos1} or {pos2} equals "v" (see |line()|) and it is not in
--- |visual-mode|, an empty list is returned.
--- - If {pos1}, {pos2} or {type} is an invalid string, an empty
--- list is returned.
---
--- Examples: >
--- :xnoremap <CR>
--- \ <Cmd>echom getregion('v', '.', mode())<CR>
--- <
---
--- @param pos1 string
--- @param pos2 string
--- @param type string
--- @return string[]
function vim.fn.getregion(pos1, pos2, type) end
--- The result is a String, which is type of register {regname}.
--- The value will be one of:
--- "v" for |charwise| text