adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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: #13998
closes: #11579

Co-authored-by: =?UTF-8?q?Jakub=20=C5=81uczy=C5=84ski?= <doubleloop@o2.pl>
Co-authored-by: Shougo Matsushita <Shougo.Matsu@gmail.com>
Signed-off-by: Shougo Matsushita <Shougo.Matsu@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Shougo Matsushita
2024-02-21 00:02:45 +01:00
committed by Christian Brabandt
parent f865895c87
commit 3f905ab3c4
11 changed files with 474 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
runtime/doc/builtin.txt
View File

@ -263,6 +263,8 @@ getqflist({what}) Dict get specific quickfix list properties
getreg([{regname} [, 1 [, {list}]]])
String or List contents of a register
getreginfo([{regname}]) Dict information about a register
getregion({pos1}, {pos2}, {type})
List get the text from {pos1} to {pos2}
getregtype([{regname}]) String type of a register
getscriptinfo([{opts}]) List list of sourced scripts
gettabinfo([{expr}]) List list of tab pages
@ -4266,6 +4268,43 @@ getreginfo([{regname}]) *getreginfo()*
Can also be used as a |method|: >
GetRegname()->getreginfo()
getregion({pos1}, {pos2}, {type}) *getregion()*
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 |characterwise| 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 |characterwise-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>echo getregion('v', '.', mode())<CR>
<
Can also be used as a |method|: >
'.'->getregion("'a', 'v')
<
getregtype([{regname}]) *getregtype()*
The result is a String, which is type of register {regname}.
The value will be one of: