diff options
| author | Lewis Russell <lewis6991@gmail.com> | 2023-08-01 09:57:52 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-01 09:57:52 +0100 |
| commit | 9b5f58185e1ff0597c7e95b7205d9ec11be1848c (patch) | |
| tree | 10c93b683b66a0c809f47c891c194c4ca6932f87 /runtime/doc | |
| parent | 12ccea59674602ddf44d6e2394bf9da87b6feeb9 (diff) | |
| download | rneovim-9b5f58185e1ff0597c7e95b7205d9ec11be1848c.tar.gz rneovim-9b5f58185e1ff0597c7e95b7205d9ec11be1848c.tar.bz2 rneovim-9b5f58185e1ff0597c7e95b7205d9ec11be1848c.zip | |
docs(builtin): fix and annotate language blocks (#24506)
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/builtin.txt | 2857 |
1 files changed, 1553 insertions, 1304 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 0e49c70470..3033435ee6 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -17,16 +17,17 @@ abs({expr}) *abs()* a |Float| abs() returns a |Float|. When {expr} can be converted to a |Number| abs() returns a |Number|. Otherwise abs() gives an error message and returns -1. - Examples: > + Examples: >vim echo abs(1.456) -< 1.456 > +< 1.456 >vim echo abs(-5.456) -< 5.456 > +< 5.456 >vim echo abs(-4) < 4 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->abs() +< acos({expr}) *acos()* Return the arc cosine of {expr} measured in radians, as a @@ -35,43 +36,47 @@ acos({expr}) *acos()* [-1, 1]. Returns NaN if {expr} is outside the range [-1, 1]. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo acos(0) -< 1.570796 > - :echo acos(-0.5) + Examples: >vim + echo acos(0) +< 1.570796 >vim + echo acos(-0.5) < 2.094395 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->acos() +< add({object}, {expr}) *add()* Append the item {expr} to |List| or |Blob| {object}. Returns - the resulting |List| or |Blob|. Examples: > - :let alist = add([1, 2, 3], item) - :call add(mylist, "woodstock") + the resulting |List| or |Blob|. Examples: >vim + let alist = add([1, 2, 3], item) + call add(mylist, "woodstock") < Note that when {expr} is a |List| it is appended as a single item. Use |extend()| to concatenate |Lists|. When {object} is a |Blob| then {expr} must be a number. Use |insert()| to add an item at another position. Returns 1 if {object} is not a |List| or a |Blob|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->add(val1)->add(val2) +< and({expr}, {expr}) *and()* Bitwise AND on the two arguments. The arguments are converted to a number. A List, Dict or Float argument causes an error. Also see `or()` and `xor()`. - Example: > - :let flag = and(bits, 0x80) -< Can also be used as a |method|: > - :let flag = bits->and(0x80) + Example: >vim + let flag = and(bits, 0x80) +< Can also be used as a |method|: >vim + let flag = bits->and(0x80) +< api_info() *api_info()* Returns Dictionary of |api-metadata|. - View it in a nice human-readable format: > - :lua vim.print(vim.fn.api_info()) + View it in a nice human-readable format: >vim + lua vim.print(vim.fn.api_info()) +< append({lnum}, {text}) *append()* When {text} is a |List|: Append each item of the |List| as a @@ -82,12 +87,13 @@ append({lnum}, {text}) *append()* {lnum} can be zero to insert a line before the first one. {lnum} is used like with |getline()|. Returns 1 for failure ({lnum} out of range or out of memory), - 0 for success. Example: > - :let failed = append(line('$'), "# THE END") - :let failed = append(0, ["Chapter 1", "the beginning"]) + 0 for success. Example: >vim + let failed = append(line('$'), "# THE END") + let failed = append(0, ["Chapter 1", "the beginning"]) -< Can also be used as a |method| after a List: > +< Can also be used as a |method| after a List: >vim mylist->append(lnum) +< appendbufline({buf}, {lnum}, {text}) *appendbufline()* Like |append()| but append the text in buffer {expr}. @@ -105,11 +111,12 @@ appendbufline({buf}, {lnum}, {text}) *appendbufline()* On success 0 is returned, on failure 1 is returned. If {buf} is not a valid buffer or {lnum} is not valid, an - error message is given. Example: > - :let failed = appendbufline(13, 0, "# THE START") + error message is given. Example: >vim + let failed = appendbufline(13, 0, "# THE START") < - Can also be used as a |method| after a List: > + Can also be used as a |method| after a List: >vim mylist->appendbufline(buf, lnum) +< argc([{winid}]) *argc()* The result is the number of files in the argument list. See @@ -139,13 +146,13 @@ arglistid([{winnr} [, {tabnr}]]) *arglistid()* argv([{nr} [, {winid}]]) *argv()* The result is the {nr}th file in the argument list. See - |arglist|. "argv(0)" is the first one. Example: > - :let i = 0 - :while i < argc() - : let f = escape(fnameescape(argv(i)), '.') - : exe 'amenu Arg.' .. f .. ' :e ' .. f .. '<CR>' - : let i = i + 1 - :endwhile + |arglist|. "argv(0)" is the first one. Example: >vim + let i = 0 + while i < argc() + let f = escape(fnameescape(argv(i)), '.') + exe 'amenu Arg.' .. f .. ' :e ' .. f .. '<CR>' + let i = i + 1 + endwhile < Without the {nr} argument, or when {nr} is -1, a |List| with the whole |arglist| is returned. @@ -163,13 +170,13 @@ asin({expr}) *asin()* [-1, 1]. Returns NaN if {expr} is outside the range [-1, 1]. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo asin(0.8) -< 0.927295 > - :echo asin(-0.5) + Examples: >vim + echo asin(0.8) +< 0.927295 >vim + echo asin(-0.5) < -0.523599 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->asin() < @@ -179,7 +186,7 @@ assert_beeps({cmd}) *assert_beeps()* Also see |assert_fails()|, |assert_nobeep()| and |assert-return|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetCmd()->assert_beeps() < @@ -194,13 +201,14 @@ assert_equal({expected}, {actual} [, {msg}]) *assert_equal()* from the Number 4. And the number 4 is different from the Float 4.0. The value of 'ignorecase' is not used here, case always matters. - Example: > + Example: >vim assert_equal('foo', 'bar') < Will result in a string to be added to |v:errors|: test.vim line 12: Expected 'foo' but got 'bar' ~ - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->assert_equal([1, 2, 3]) +< assert_equalfile({fname-one}, {fname-two}) *assert_equalfile()* When the files {fname-one} and {fname-two} do not contain @@ -209,15 +217,16 @@ assert_equalfile({fname-one}, {fname-two}) *assert_equalfile()* When {fname-one} or {fname-two} does not exist the error will mention that. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLog()->assert_equalfile('expected.log') +< assert_exception({error} [, {msg}]) *assert_exception()* When v:exception does not contain the string {error} an error message is added to |v:errors|. Also see |assert-return|. This can be used to assert that a command throws an exception. Using the error number, followed by a colon, avoids problems - with translations: > + with translations: >vim try commandthatfails call assert_false(1, 'command should have failed') @@ -234,16 +243,16 @@ assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]]) When {error} is a string it must be found literally in the first reported error. Most often this will be the error code, - including the colon, e.g. "E123:". > + including the colon, e.g. "E123:". >vim assert_fails('bad cmd', 'E987:') < When {error} is a |List| with one or two strings, these are used as patterns. The first pattern is matched against the - first reported error: > + first reported error: >vim assert_fails('cmd', ['E987:.*expected bool']) < The second pattern, if present, is matched against the last reported error. To only match the last error use an empty - string for the first error: > + string for the first error: >vim assert_fails('cmd', ['', 'E987:']) < If {msg} is empty then it is not used. Do this to get the @@ -261,8 +270,9 @@ assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]]) Note that beeping is not considered an error, and some failing commands only beep. Use |assert_beeps()| for those. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetCmd()->assert_fails('E99:') +< assert_false({actual} [, {msg}]) *assert_false()* When {actual} is not false an error message is added to @@ -274,8 +284,9 @@ assert_false({actual} [, {msg}]) *assert_false()* A value is false when it is zero. When {actual} is not a number the assert fails. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetResult()->assert_false() +< assert_inrange({lower}, {upper}, {actual} [, {msg}]) *assert_inrange()* This asserts number and |Float| values. When {actual} is lower @@ -299,12 +310,12 @@ assert_match({pattern}, {actual} [, {msg}]) *assert_match()* Use "^" and "$" to match with the start and end of the text. Use both to match the whole text. - Example: > + Example: >vim assert_match('^f.*o$', 'foobar') < Will result in a string to be added to |v:errors|: test.vim line 12: Pattern '^f.*o$' does not match 'foobar' ~ - Can also be used as a |method|: > + Can also be used as a |method|: >vim getFile()->assert_match('foo.*') < @@ -313,7 +324,7 @@ assert_nobeep({cmd}) *assert_nobeep()* produces a beep or visual bell. Also see |assert_beeps()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetCmd()->assert_nobeep() < @@ -322,9 +333,8 @@ assert_notequal({expected}, {actual} [, {msg}]) *assert_notequal()* |v:errors| when {expected} and {actual} are equal. Also see |assert-return|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->assert_notequal([1, 2, 3]) - < assert_notmatch({pattern}, {actual} [, {msg}]) *assert_notmatch()* @@ -332,7 +342,7 @@ assert_notmatch({pattern}, {actual} [, {msg}]) *assert_notmatch()* |v:errors| when {pattern} matches {actual}. Also see |assert-return|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim getFile()->assert_notmatch('bar.*') < @@ -340,7 +350,7 @@ assert_report({msg}) *assert_report()* Report a test failure directly, using String {msg}. Always returns one. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetMessage()->assert_report() < @@ -352,7 +362,7 @@ assert_true({actual} [, {msg}]) *assert_true()* When {actual} is not a number or |v:true| the assert fails. When {msg} is given it precedes the default message. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetResult()->assert_true() < @@ -361,14 +371,15 @@ atan({expr}) *atan()* the range [-pi/2, +pi/2] radians, as a |Float|. {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo atan(100) -< 1.560797 > - :echo atan(-4.01) + Examples: >vim + echo atan(100) +< 1.560797 >vim + echo atan(-4.01) < -1.326405 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->atan() +< atan2({expr1}, {expr2}) *atan2()* Return the arc tangent of {expr1} / {expr2}, measured in @@ -376,24 +387,25 @@ atan2({expr1}, {expr2}) *atan2()* {expr1} and {expr2} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr1} or {expr2} is not a |Float| or a |Number|. - Examples: > - :echo atan2(-1, 1) -< -0.785398 > - :echo atan2(1, -1) + Examples: >vim + echo atan2(-1, 1) +< -0.785398 >vim + echo atan2(1, -1) < 2.356194 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->atan2(1) +< blob2list({blob}) *blob2list()* Return a List containing the number value of each byte in Blob - {blob}. Examples: > - blob2list(0z0102.0304) returns [1, 2, 3, 4] - blob2list(0z) returns [] + {blob}. Examples: >vim + blob2list(0z0102.0304) " returns [1, 2, 3, 4] + blob2list(0z) " returns [] < Returns an empty List on error. |list2blob()| does the opposite. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetBlob()->blob2list() < @@ -428,13 +440,14 @@ bufadd({name}) *bufadd()* created buffer. When {name} is an empty string then a new buffer is always created. The buffer will not have 'buflisted' set and not be loaded - yet. To add some text to the buffer use this: > + yet. To add some text to the buffer use this: >vim let bufnr = bufadd('someName') call bufload(bufnr) call setbufline(bufnr, 1, ['some', 'text']) < Returns 0 on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim let bufnr = 'somename'->bufadd() +< bufexists({buf}) *bufexists()* The result is a Number, which is |TRUE| if a buffer called @@ -458,16 +471,18 @@ bufexists({buf}) *bufexists()* Use "bufexists(0)" to test for the existence of an alternate file name. - Can also be used as a |method|: > + Can also be used as a |method|: >vim let exists = 'somename'->bufexists() +< buflisted({buf}) *buflisted()* The result is a Number, which is |TRUE| if a buffer called {buf} exists and is listed (has the 'buflisted' option set). The {buf} argument is used like with |bufexists()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim let listed = 'somename'->buflisted() +< bufload({buf}) *bufload()* Ensure the buffer {buf} is loaded. When the buffer name @@ -479,16 +494,18 @@ bufload({buf}) *bufload()* there will be no dialog, the buffer will be loaded anyway. The {buf} argument is used like with |bufexists()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim eval 'somename'->bufload() +< bufloaded({buf}) *bufloaded()* The result is a Number, which is |TRUE| if a buffer called {buf} exists and is loaded (shown in a window or hidden). The {buf} argument is used like with |bufexists()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim let loaded = 'somename'->bufloaded() +< bufname([{buf}]) *bufname()* The result is the name of a buffer. Mostly as it is displayed @@ -511,17 +528,17 @@ bufname([{buf}]) *bufname()* with a listed buffer, that one is returned. Next unlisted buffers are searched for. If the {buf} is a String, but you want to use it as a buffer - number, force it to be a Number by adding zero to it: > - :echo bufname("3" + 0) -< Can also be used as a |method|: > + number, force it to be a Number by adding zero to it: >vim + echo bufname("3" + 0) +< Can also be used as a |method|: >vim echo bufnr->bufname() < If the buffer doesn't exist, or doesn't have a name, an empty - string is returned. > - bufname("#") alternate buffer name - bufname(3) name of buffer 3 - bufname("%") name of current buffer - bufname("file2") name of buffer where "file2" matches. + string is returned. >vim + echo bufname("#") " alternate buffer name + echo bufname(3) " name of buffer 3 + echo bufname("%") " name of current buffer + echo bufname("file2") " name of buffer where "file2" matches. < bufnr([{buf} [, {create}]]) *bufnr()* @@ -531,43 +548,46 @@ bufnr([{buf} [, {create}]]) *bufnr()* If the buffer doesn't exist, -1 is returned. Or, if the {create} argument is present and TRUE, a new, unlisted, buffer is created and its number is returned. - bufnr("$") is the last buffer: > - :let last_buffer = bufnr("$") + bufnr("$") is the last buffer: >vim + let last_buffer = bufnr("$") < The result is a Number, which is the highest buffer number of existing buffers. Note that not all buffers with a smaller number necessarily exist, because ":bwipeout" may have removed them. Use bufexists() to test for the existence of a buffer. - Can also be used as a |method|: > + Can also be used as a |method|: >vim echo bufref->bufnr() +< bufwinid({buf}) *bufwinid()* The result is a Number, which is the |window-ID| of the first window associated with buffer {buf}. For the use of {buf}, see |bufname()| above. If buffer {buf} doesn't exist or - there is no such window, -1 is returned. Example: > + there is no such window, -1 is returned. Example: >vim echo "A window containing buffer 1 is " .. (bufwinid(1)) < Only deals with the current tab page. See |win_findbuf()| for finding more. - Can also be used as a |method|: > + Can also be used as a |method|: >vim FindBuffer()->bufwinid() +< bufwinnr({buf}) *bufwinnr()* Like |bufwinid()| but return the window number instead of the |window-ID|. If buffer {buf} doesn't exist or there is no such window, -1 - is returned. Example: > + is returned. Example: >vim echo "A window containing buffer 1 is " .. (bufwinnr(1)) < The number can be used with |CTRL-W_w| and ":wincmd w" |:wincmd|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim FindBuffer()->bufwinnr() +< byte2line({byte}) *byte2line()* Return the line number that contains the character at byte @@ -579,8 +599,9 @@ byte2line({byte}) *byte2line()* Returns -1 if the {byte} value is invalid. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetOffset()->byte2line() +< byteidx({expr}, {nr} [, {utf16}]) *byteidx()* Return byte index of the {nr}th character in the String @@ -599,10 +620,10 @@ byteidx({expr}, {nr} [, {utf16}]) *byteidx()* middle of a character (e.g. in a 4-byte character), then the byte index of the first byte in the character is returned. Refer to |string-offset-encoding| for more information. - Example : > + Example : >vim echo matchstr(str, ".", byteidx(str, 3)) < will display the fourth character. Another way to do the - same: > + same: >vim let s = strpart(str, byteidx(str, 3)) echo strpart(s, 0, byteidx(s, 1)) < Also see |strgetchar()| and |strcharpart()|. @@ -612,17 +633,18 @@ byteidx({expr}, {nr} [, {utf16}]) *byteidx()* in bytes is returned. See |charidx()| and |utf16idx()| for getting the character and UTF-16 index respectively from the byte index. - Examples: > - echo byteidx('aππ', 2) returns 5 - echo byteidx('aππ', 2, 1) returns 1 - echo byteidx('aππ', 3, 1) returns 5 + Examples: >vim + echo byteidx('aππ', 2) " returns 5 + echo byteidx('aππ', 2, 1) " returns 1 + echo byteidx('aππ', 3, 1) " returns 5 < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->byteidx(idx) +< byteidxcomp({expr}, {nr} [, {utf16}]) *byteidxcomp()* Like byteidx(), except that a composing character is counted - as a separate character. Example: > + as a separate character. Example: >vim let s = 'e' .. nr2char(0x301) echo byteidx(s, 1) echo byteidxcomp(s, 1) @@ -631,8 +653,9 @@ byteidxcomp({expr}, {nr} [, {utf16}]) *byteidxcomp()* character is 3 bytes), the second echo results in 1 ('e' is one byte). - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->byteidxcomp(idx) +< call({func}, {arglist} [, {dict}]) *call()* *E699* Call function {func} with the items in |List| {arglist} as @@ -643,7 +666,7 @@ call({func}, {arglist} [, {dict}]) *call()* *E699* {dict} is for functions with the "dict" attribute. It will be used to set the local variable "self". |Dictionary-function| - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFunc()->call([arg, arg], dict) < @@ -651,17 +674,17 @@ ceil({expr}) *ceil()* Return the smallest integral value greater than or equal to {expr} as a |Float| (round up). {expr} must evaluate to a |Float| or a |Number|. - Examples: > + Examples: >vim echo ceil(1.456) -< 2.0 > +< 2.0 >vim echo ceil(-5.456) -< -5.0 > +< -5.0 >vim echo ceil(4.0) < 4.0 Returns 0.0 if {expr} is not a |Float| or a |Number|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->ceil() < @@ -694,8 +717,8 @@ chansend({id}, {data}) *chansend()* {data} may be a string, string convertible, |Blob|, or a list. If {data} is a list, the items will be joined by newlines; any newlines in an item will be sent as NUL. To send a final - newline, include a final empty string. Example: > - :call chansend(id, ["abc", "123\n456", ""]) + newline, include a final empty string. Example: >vim + call chansend(id, ["abc", "123\n456", ""]) < will send "abc<NL>123<NUL>456<NL>". chansend() writes raw data, not RPC messages. If the channel @@ -704,12 +727,12 @@ chansend({id}, {data}) *chansend()* char2nr({string} [, {utf8}]) *char2nr()* Return Number value of the first char in {string}. - Examples: > - char2nr(" ") returns 32 - char2nr("ABC") returns 65 - char2nr("Γ‘") returns 225 - char2nr("Γ‘"[0]) returns 195 - char2nr("\<M-x>") returns 128 + Examples: >vim + echo char2nr(" ") " returns 32 + echo char2nr("ABC") " returns 65 + echo char2nr("Γ‘") " returns 225 + echo char2nr("Γ‘"[0]) " returns 195 + echo char2nr("\<M-x>") " returns 128 < Non-ASCII characters are always treated as UTF-8 characters. {utf8} is ignored, it exists only for backwards-compatibility. A combining character is a separate character. @@ -717,8 +740,9 @@ char2nr({string} [, {utf8}]) *char2nr()* Returns 0 if {string} is not a |String|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetChar()->char2nr() +< charclass({string}) *charclass()* Return the character class of the first character in {string}. @@ -736,11 +760,11 @@ charcol({expr} [, {winid}]) *charcol()* position given with {expr} instead of the byte position. Example: - With the cursor on 'μΈ' in line 5 with text "μ¬λ³΄μΈμ": > - charcol('.') returns 3 - col('.') returns 7 + With the cursor on 'μΈ' in line 5 with text "μ¬λ³΄μΈμ": >vim + echo charcol('.') " returns 3 + echo col('.') " returns 7 -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetPos()->col() < @@ -771,14 +795,15 @@ charidx({string}, {idx} [, {countcc} [, {utf16}]]) *charidx()* from the character index and |utf16idx()| for getting the UTF-16 index from the character index. Refer to |string-offset-encoding| for more information. - Examples: > - echo charidx('aΜbΜcΜ', 3) returns 1 - echo charidx('aΜbΜcΜ', 6, 1) returns 4 - echo charidx('aΜbΜcΜ', 16) returns -1 - echo charidx('aππ', 4, 0, 1) returns 2 + Examples: >vim + echo charidx('aΜbΜcΜ', 3) " returns 1 + echo charidx('aΜbΜcΜ', 6, 1) " returns 4 + echo charidx('aΜbΜcΜ', 16) " returns -1 + echo charidx('aππ', 4, 0, 1) " returns 2 < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->charidx(idx) +< chdir({dir}) *chdir()* Change the current working directory to {dir}. The scope of @@ -795,14 +820,14 @@ chdir({dir}) *chdir()* this to another chdir() to restore the directory. On failure, returns an empty string. - Example: > + Example: >vim let save_dir = chdir(newdir) if save_dir != "" " ... do some work call chdir(save_dir) endif -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetDir()->chdir() < @@ -814,8 +839,9 @@ cindent({lnum}) *cindent()* When {lnum} is invalid -1 is returned. See |C-indenting|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->cindent() +< clearmatches([{win}]) *clearmatches()* Clears all matches previously defined for the current window @@ -823,7 +849,7 @@ clearmatches([{win}]) *clearmatches()* If {win} is specified, use the window with this number or window ID instead of the current window. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWin()->clearmatches() < @@ -850,11 +876,11 @@ col({expr} [, {winid}]) *col()* For the screen column position use |virtcol()|. For the character position use |charcol()|. Note that only marks in the current file can be used. - Examples: > - col(".") column of cursor - col("$") length of cursor line plus one - col("'t") column of mark t - col("'" .. markname) column of mark markname + Examples: >vim + echo col(".") " column of cursor + echo col("$") " length of cursor line plus one + echo col("'t") " column of mark t + echo col("'" .. markname) " column of mark markname < The first column is 1. Returns 0 if {expr} is invalid or when the window with ID {winid} is not found. For an uppercase mark the column may actually be in another @@ -862,10 +888,10 @@ col({expr} [, {winid}]) *col()* For the cursor position, when 'virtualedit' is active, the column is one higher if the cursor is after the end of the line. Also, when using a <Cmd> mapping the cursor isn't - moved, this can be used to obtain the column in Insert mode: > - :imap <F2> <Cmd>echo col(".").."\n"<CR> + moved, this can be used to obtain the column in Insert mode: >vim + imap <F2> <Cmd>echo col(".").."\n"<CR> -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetPos()->col() < @@ -887,7 +913,7 @@ complete({startcol}, {matches}) *complete()* *E785* The match can be selected with CTRL-N and CTRL-P as usual with Insert mode completion. The popup menu will appear if specified, see |ins-completion-menu|. - Example: > + Example: >vim inoremap <F5> <C-R>=ListMonths()<CR> func ListMonths() @@ -900,8 +926,9 @@ complete({startcol}, {matches}) *complete()* *E785* an empty string is returned to avoid a zero being inserted. Can also be used as a |method|, the base is passed as the - second argument: > + second argument: >vim GetMatches()->complete(col('.')) +< complete_add({expr}) *complete_add()* Add {expr} to the list of matches. Only to be used by the @@ -912,8 +939,9 @@ complete_add({expr}) *complete_add()* See |complete-functions| for an explanation of {expr}. It is the same as one item in the list that 'omnifunc' would return. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetMoreMatches()->complete_add() +< complete_check() *complete_check()* Check for a key typed while looking for completion matches. @@ -973,7 +1001,7 @@ complete_info([{what}]) *complete_info()* Returns an empty |Dictionary| on error. - Examples: > + Examples: >vim " Get all items call complete_info() " Get only 'mode' @@ -981,7 +1009,7 @@ complete_info([{what}]) *complete_info()* " Get only 'mode' and 'pum_visible' call complete_info(['mode', 'pum_visible']) -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetItems()->complete_info() < @@ -997,11 +1025,11 @@ confirm({msg} [, {choices} [, {default} [, {type}]]]) *confirm()* some systems the string is wrapped when it doesn't fit. {choices} is a String, with the individual choices separated - by '\n', e.g. > + by '\n', e.g. >vim confirm("Save changes?", "&Yes\n&No\n&Cancel") < The letter after the '&' is the shortcut key for that choice. Thus you can type 'c' to select "Cancel". The shortcut does - not need to be the first letter: > + not need to be the first letter: >vim confirm("file has been modified", "&Save\nSave &All") < For the console, the first letter of each choice is used as the default shortcut key. Case is ignored. @@ -1020,7 +1048,7 @@ confirm({msg} [, {choices} [, {default} [, {type}]]]) *confirm()* If the user aborts the dialog by pressing <Esc>, CTRL-C, or another valid interrupt key, confirm() returns 0. - An example: > + An example: >vim let choice = confirm("What do you want?", \ "&Apples\n&Oranges\n&Bananas", 2) if choice == 0 @@ -1037,7 +1065,7 @@ confirm({msg} [, {choices} [, {default} [, {type}]]]) *confirm()* don't fit, a vertical layout is used anyway. For some systems the horizontal layout is always used. - Can also be used as a |method|in: > + Can also be used as a |method|in: >vim BuildMessage()->confirm("&Yes\n&No") < @@ -1050,35 +1078,38 @@ copy({expr}) *copy()* changing an item changes the contents of both |Lists|. A |Dictionary| is copied in a similar way as a |List|. Also see |deepcopy()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->copy() +< cos({expr}) *cos()* Return the cosine of {expr}, measured in radians, as a |Float|. {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo cos(100) -< 0.862319 > - :echo cos(-4.01) + Examples: >vim + echo cos(100) +< 0.862319 >vim + echo cos(-4.01) < -0.646043 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->cos() +< cosh({expr}) *cosh()* Return the hyperbolic cosine of {expr} as a |Float| in the range [1, inf]. {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo cosh(0.5) -< 1.127626 > - :echo cosh(-0.5) + Examples: >vim + echo cosh(0.5) +< 1.127626 >vim + echo cosh(-0.5) < -1.127626 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->cosh() +< count({comp}, {expr} [, {ic} [, {start}]]) *count()* Return the number of times an item with value {expr} appears @@ -1093,7 +1124,7 @@ count({comp}, {expr} [, {ic} [, {start}]]) *count()* occurrences of {expr} is returned. Zero is returned when {expr} is an empty string. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->count(val) < @@ -1155,8 +1186,9 @@ cursor({list}) *cursor()* position within a <Tab> or after the last character. Returns 0 when the position could be set, -1 otherwise. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetCursorPos()->cursor() +< debugbreak({pid}) *debugbreak()* Specifically used to interrupt a program being debugged. It @@ -1167,7 +1199,7 @@ debugbreak({pid}) *debugbreak()* Returns |TRUE| if successfully interrupted the program. Otherwise returns |FALSE|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetPid()->debugbreak() < @@ -1191,8 +1223,9 @@ deepcopy({expr} [, {noref}]) *deepcopy()* *E698* {noref} set to 1 will fail. Also see |copy()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetObject()->deepcopy() +< delete({fname} [, {flags}]) *delete()* Without {flags} or with {flags} empty: Deletes the file by the @@ -1213,8 +1246,9 @@ delete({fname} [, {flags}]) *delete()* operation was successful and -1/true when the deletion failed or partly failed. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->delete() +< deletebufline({buf}, {first} [, {last}]) *deletebufline()* Delete lines {first} to {last} (inclusive) from buffer {buf}. @@ -1230,7 +1264,7 @@ deletebufline({buf}, {first} [, {last}]) *deletebufline()* when using |line()| this refers to the current buffer. Use "$" to refer to the last line in buffer {buf}. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetBuffer()->deletebufline(1) < @@ -1245,7 +1279,7 @@ dictwatcheradd({dict}, {pattern}, {callback}) *dictwatcheradd()* After this is called, every change on {dict} and on keys matching {pattern} will result in {callback} being invoked. - For example, to watch all global variables: > + For example, to watch all global variables: >vim silent! call dictwatcherdel(g:, '*', 'OnDictChanged') function! OnDictChanged(d,k,z) echomsg string(a:k) string(a:z) @@ -1300,8 +1334,9 @@ diff_filler({lnum}) *diff_filler()* line, "'m" mark m, etc. Returns 0 if the current window is not in diff mode. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->diff_filler() +< diff_hlID({lnum}, {col}) *diff_hlID()* Returns the highlight ID for diff mode at line {lnum} column @@ -1314,7 +1349,7 @@ diff_hlID({lnum}, {col}) *diff_hlID()* The highlight ID can be used with |synIDattr()| to obtain syntax information about the highlighting. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->diff_hlID(col) < @@ -1326,15 +1361,15 @@ digraph_get({chars}) *digraph_get()* *E1214* Also see |digraph_getlist()|. - Examples: > + Examples: >vim " Get a built-in digraph - :echo digraph_get('00') " Returns 'β' + echo digraph_get('00') " Returns 'β' " Get a user-defined digraph - :call digraph_set('aa', 'γ') - :echo digraph_get('aa') " Returns 'γ' + call digraph_set('aa', 'γ') + echo digraph_get('aa') " Returns 'γ' < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetChars()->digraph_get() < @@ -1345,14 +1380,14 @@ digraph_getlist([{listall}]) *digraph_getlist()* Also see |digraph_get()|. - Examples: > + Examples: >vim " Get user-defined digraphs - :echo digraph_getlist() + echo digraph_getlist() " Get all the digraphs, including default digraphs - :echo digraph_getlist(1) + echo digraph_getlist(1) < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetNumber()->digraph_getlist() < @@ -1370,10 +1405,10 @@ digraph_set({chars}, {digraph}) *digraph_set()* If you want to define multiple digraphs at once, you can use |digraph_setlist()|. - Example: > + Example: >vim call digraph_set(' ', 'γ') < - Can be used as a |method|: > + Can be used as a |method|: >vim GetString()->digraph_set('γ') < @@ -1382,17 +1417,17 @@ digraph_setlist({digraphlist}) *digraph_setlist()* digraphs at once. {digraphlist} is a list composed of lists, where each list contains two strings with {chars} and {digraph} as in |digraph_set()|. *E1216* - Example: > + Example: >vim call digraph_setlist([['aa', 'γ'], ['ii', 'γ']]) < - It is similar to the following: > + It is similar to the following: >vim for [chars, digraph] in [['aa', 'γ'], ['ii', 'γ']] call digraph_set(chars, digraph) endfor < Except that the function returns after the first error, following digraphs will not be added. - Can be used as a |method|: > + Can be used as a |method|: >vim GetList()->digraph_setlist() < @@ -1405,26 +1440,28 @@ empty({expr}) *empty()* - |v:false| and |v:null| are empty, |v:true| is not. - A |Blob| is empty when its length is zero. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->empty() +< environ() *environ()* Return all of environment variables as dictionary. You can - check if an environment variable exists like this: > - :echo has_key(environ(), 'HOME') + check if an environment variable exists like this: >vim + echo has_key(environ(), 'HOME') < Note that the variable name may be CamelCase; to ignore case - use this: > - :echo index(keys(environ()), 'HOME', 0, 1) != -1 + use this: >vim + echo index(keys(environ()), 'HOME', 0, 1) != -1 +< escape({string}, {chars}) *escape()* Escape the characters in {chars} that occur in {string} with a - backslash. Example: > - :echo escape('c:\program files\vim', ' \') + backslash. Example: >vim + echo escape('c:\program files\vim', ' \') < results in: > c:\\program\ files\\vim < Also see |shellescape()| and |fnameescape()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->escape(' \') < @@ -1435,8 +1472,9 @@ eval({string}) *eval()* of them. Also works for |Funcref|s that refer to existing functions. - Can also be used as a |method|: > + Can also be used as a |method|: >vim argv->join()->eval() +< eventhandler() *eventhandler()* Returns 1 when inside an event handler. That is that Vim got @@ -1467,17 +1505,18 @@ executable({expr}) *executable()* -1 not implemented on this system |exepath()| can be used to get the full path of an executable. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetCommand()->executable() +< execute({command} [, {silent}]) *execute()* Execute {command} and capture its output. If {command} is a |String|, returns {command} output. If {command} is a |List|, returns concatenated outputs. Line continuations in {command} are not recognized. - Examples: > + Examples: >vim echo execute('echon "foo"') -< foo > +< foo >vim echo execute(['echon "foo"', 'echon "bar"']) < foobar @@ -1488,7 +1527,7 @@ execute({command} [, {silent}]) *execute()* The default is "silent". Note that with "silent!", unlike `:redir`, error messages are dropped. - To get a list of lines use `split()` on the result: > + To get a list of lines use `split()` on the result: >vim execute('args')->split("\n") < This function is not available in the |sandbox|. @@ -1498,8 +1537,9 @@ execute({command} [, {silent}]) *execute()* To execute a command in another window than the current one use `win_execute()`. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetCommand()->execute() +< exepath({expr}) *exepath()* Returns the full path of {expr} if it is an executable and @@ -1507,7 +1547,7 @@ exepath({expr}) *exepath()* Returns empty string otherwise. If {expr} starts with "./" the |current-directory| is used. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetCommand()->exepath() < @@ -1525,11 +1565,11 @@ exists({expr}) *exists()* entries, |List| items, etc. Beware that evaluating an index may cause an error message for an invalid - expression. E.g.: > - :let l = [1, 2, 3] - :echo exists("l[5]") -< 0 > - :echo exists("l[xx]") + expression. E.g.: >vim + let l = [1, 2, 3] + echo exists("l[5]") +< 0 >vim + echo exists("l[xx]") < E121: Undefined variable: xx 0 &option-name Vim option (only checks if it exists, @@ -1569,52 +1609,54 @@ exists({expr}) *exists()* ##event autocommand for this event is supported. - Examples: > - exists("&mouse") - exists("$HOSTNAME") - exists("*strftime") - exists("*s:MyFunc") - exists("*MyFunc") - exists("bufcount") - exists(":Make") - exists("#CursorHold") - exists("#BufReadPre#*.gz") - exists("#filetypeindent") - exists("#filetypeindent#FileType") - exists("#filetypeindent#FileType#*") - exists("##ColorScheme") + Examples: >vim + echo exists("&mouse") + echo exists("$HOSTNAME") + echo exists("*strftime") + echo exists("*s:MyFunc") + echo exists("*MyFunc") + echo exists("bufcount") + echo exists(":Make") + echo exists("#CursorHold") + echo exists("#BufReadPre#*.gz") + echo exists("#filetypeindent") + echo exists("#filetypeindent#FileType") + echo exists("#filetypeindent#FileType#*") + echo exists("##ColorScheme") < There must be no space between the symbol (&/$/*/#) and the name. There must be no extra characters after the name, although in a few cases this is ignored. That may become stricter in the future, thus don't count on it! - Working example: > - exists(":make") - <NOT working example: > - exists(":make install") + Working example: >vim + echo exists(":make") + <NOT working example: >vim + echo exists(":make install") < Note that the argument must be a string, not the name of the - variable itself. For example: > - exists(bufcount) + variable itself. For example: >vim + echo exists(bufcount) < This doesn't check for existence of the "bufcount" variable, but gets the value of "bufcount", and checks if that exists. - Can also be used as a |method|: > + Can also be used as a |method|: >vim Varname()->exists() +< exp({expr}) *exp()* Return the exponential of {expr} as a |Float| in the range [0, inf]. {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo exp(2) -< 7.389056 > - :echo exp(-1) + Examples: >vim + echo exp(2) +< 7.389056 >vim + echo exp(-1) < 0.367879 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->exp() +< expand({string} [, {nosuf} [, {list}]]) *expand()* Expand wildcards and the following special keywords in @@ -1661,18 +1703,18 @@ expand({string} [, {nosuf} [, {list}]]) *expand()* :r root (one extension removed) :e extension only - Example: > - :let &tags = expand("%:p:h") .. "/tags" + Example: >vim + let &tags = expand("%:p:h") .. "/tags" < Note that when expanding a string that starts with '%', '#' or - '<', any following text is ignored. This does NOT work: > - :let doesntwork = expand("%:h.bak") -< Use this: > - :let doeswork = expand("%:h") .. ".bak" + '<', any following text is ignored. This does NOT work: >vim + let doesntwork = expand("%:h.bak") +< Use this: >vim + let doeswork = expand("%:h") .. ".bak" < Also note that expanding "<cfile>" and others only returns the referenced file name without further expansion. If "<cfile>" is "~/.cshrc", you need to do another expand() to have the - "~/" expanded into the path of the home directory: > - :echo expand(expand("<cfile>")) + "~/" expanded into the path of the home directory: >vim + echo expand(expand("<cfile>")) < There cannot be white space between the variables and the following modifier. The |fnamemodify()| function can be used @@ -1692,8 +1734,8 @@ expand({string} [, {nosuf} [, {list}]]) *expand()* {nosuf} argument is given and it is |TRUE|. Names for non-existing files are included. The "**" item can be used to search in a directory tree. For example, to find - all "README" files in the current directory and below: > - :echo expand("**/README") + all "README" files in the current directory and below: >vim + echo expand("**/README") < expand() can also be used to expand variables and environment variables that are only known in a shell. But this can be @@ -1707,8 +1749,9 @@ expand({string} [, {nosuf} [, {list}]]) *expand()* See |glob()| for finding existing files. See |system()| for getting the raw output of an external command. - Can also be used as a |method|: > + Can also be used as a |method|: >vim Getpattern()->expand() +< expandcmd({string} [, {options}]) *expandcmd()* Expand special items in String {string} like what is done for @@ -1726,12 +1769,14 @@ expandcmd({string} [, {options}]) *expandcmd()* Returns the expanded string. If an error is encountered during expansion, the unmodified {string} is returned. - Example: > - :echo expandcmd('make %<.o') + Example: >vim + echo expandcmd('make %<.o') +< > make /path/runtime/doc/builtin.o - :echo expandcmd('make %<.o', {'errmsg': v:true}) +< >vim + echo expandcmd('make %<.o', {'errmsg': v:true}) < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetCommand()->expandcmd() < @@ -1744,16 +1789,16 @@ extend({expr1}, {expr2} [, {expr3}]) *extend()* item with index {expr3} in {expr1}. When {expr3} is zero insert before the first item. When {expr3} is equal to len({expr1}) then {expr2} is appended. - Examples: > - :echo sort(extend(mylist, [7, 5])) - :call extend(mylist, [2, 3], 1) + Examples: >vim + echo sort(extend(mylist, [7, 5])) + call extend(mylist, [2, 3], 1) < When {expr1} is the same List as {expr2} then the number of items copied is equal to the original length of the List. E.g., when {expr3} is 1 you get N new copies of the first item (where N is the original length of the List). Use |add()| to concatenate one item to a list. To concatenate - two lists into a new list use the + operator: > - :let newlist = [1, 2, 3] + [4, 5] + two lists into a new list use the + operator: >vim + let newlist = [1, 2, 3] + [4, 5] < If they are |Dictionaries|: Add all entries from {expr2} to {expr1}. @@ -1771,7 +1816,7 @@ extend({expr1}, {expr2} [, {expr3}]) *extend()* fails. Returns {expr1}. Returns 0 on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->extend(otherlist) < @@ -1825,8 +1870,9 @@ feedkeys({string} [, {mode}]) *feedkeys()* Return value is always 0. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetInput()->feedkeys() +< filereadable({file}) *filereadable()* The result is a Number, which is |TRUE| when a file with the @@ -1835,14 +1881,19 @@ filereadable({file}) *filereadable()* expression, which is used as a String. If you don't care about the file being readable you can use |glob()|. - {file} is used as-is, you may want to expand wildcards first: > + {file} is used as-is, you may want to expand wildcards first: >vim echo filereadable('~/.vimrc') +< > 0 +< >vim echo filereadable(expand('~/.vimrc')) +< > 1 +< -< Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->filereadable() +< filewritable({file}) *filewritable()* The result is a Number, which is 1 when a file with the @@ -1850,8 +1901,9 @@ filewritable({file}) *filewritable()* exist, or is not writable, the result is 0. If {file} is a directory, and we can write to it, the result is 2. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->filewritable() +< filter({expr1}, {expr2}) *filter()* {expr1} must be a |List|, |Blob|, or a |Dictionary|. @@ -1867,11 +1919,11 @@ filter({expr1}, {expr2}) *filter()* the current item. For a |Blob| |v:key| has the index of the current byte. - Examples: > + Examples: >vim call filter(mylist, 'v:val !~ "OLD"') -< Removes the items where "OLD" appears. > +< Removes the items where "OLD" appears. >vim call filter(mydict, 'v:key >= 8') -< Removes the items with a key below 8. > +< Removes the items with a key below 8. >vim call filter(var, 0) < Removes all the items, thus clears the |List| or |Dictionary|. @@ -1883,19 +1935,19 @@ filter({expr1}, {expr2}) *filter()* 1. the key or the index of the current item. 2. the value of the current item. The function must return |TRUE| if the item should be kept. - Example that keeps the odd items of a list: > + Example that keeps the odd items of a list: >vim func Odd(idx, val) return a:idx % 2 == 1 endfunc call filter(mylist, function('Odd')) -< It is shorter when using a |lambda|: > +< It is shorter when using a |lambda|: >vim call filter(myList, {idx, val -> idx * val <= 42}) -< If you do not use "val" you can leave it out: > +< If you do not use "val" you can leave it out: >vim call filter(myList, {idx -> idx % 2 == 1}) < The operation is done in-place. If you want a |List| or - |Dictionary| to remain unmodified make a copy first: > - :let l = filter(copy(mylist), 'v:val =~ "KEEP"') + |Dictionary| to remain unmodified make a copy first: >vim + let l = filter(copy(mylist), 'v:val =~ "KEEP"') < Returns {expr1}, the |List|, |Blob| or |Dictionary| that was filtered. When an error is encountered while evaluating @@ -1903,8 +1955,9 @@ filter({expr1}, {expr2}) *filter()* {expr2} is a Funcref errors inside a function are ignored, unless it was defined with the "abort" flag. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->filter(expr2) +< finddir({name} [, {path} [, {count}]]) *finddir()* Find directory {name} in {path}. Supports both downwards and @@ -1924,19 +1977,21 @@ finddir({name} [, {path} [, {count}]]) *finddir()* This is quite similar to the ex-command `:find`. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->finddir() +< findfile({name} [, {path} [, {count}]]) *findfile()* Just like |finddir()|, but find a file instead of a directory. Uses 'suffixesadd'. - Example: > - :echo findfile("tags.vim", ".;") + Example: >vim + echo findfile("tags.vim", ".;") < Searches from the directory of the current file upwards until it finds the file "tags.vim". - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->findfile() +< flatten({list} [, {maxdepth}]) *flatten()* Flatten {list} up to {maxdepth} levels. Without {maxdepth} @@ -1951,13 +2006,13 @@ flatten({list} [, {maxdepth}]) *flatten()* If there is an error the number zero is returned. - Example: > - :echo flatten([1, [2, [3, 4]], 5]) -< [1, 2, 3, 4, 5] > - :echo flatten([1, [2, [3, 4]], 5], 1) + Example: >vim + echo flatten([1, [2, [3, 4]], 5]) +< [1, 2, 3, 4, 5] >vim + echo flatten([1, [2, [3, 4]], 5], 1) < [1, 2, [3, 4], 5] - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->flatten() < @@ -1974,36 +2029,38 @@ float2nr({expr}) *float2nr()* 64-bit Number support is enabled, 0x7fffffffffffffff or -0x7fffffffffffffff). NaN results in -0x80000000 (or when 64-bit Number support is enabled, -0x8000000000000000). - Examples: > + Examples: >vim echo float2nr(3.95) -< 3 > +< 3 >vim echo float2nr(-23.45) -< -23 > +< -23 >vim echo float2nr(1.0e100) -< 2147483647 (or 9223372036854775807) > +< 2147483647 (or 9223372036854775807) >vim echo float2nr(-1.0e150) -< -2147483647 (or -9223372036854775807) > +< -2147483647 (or -9223372036854775807) >vim echo float2nr(1.0e-100) < 0 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->float2nr() +< floor({expr}) *floor()* Return the largest integral value less than or equal to {expr} as a |Float| (round down). {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > + Examples: >vim echo floor(1.856) -< 1.0 > +< 1.0 >vim echo floor(-5.456) -< -6.0 > +< -6.0 >vim echo floor(4.0) < 4.0 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->floor() +< fmod({expr1}, {expr2}) *fmod()* Return the remainder of {expr1} / {expr2}, even if the @@ -2015,18 +2072,19 @@ fmod({expr1}, {expr2}) *fmod()* {expr1} and {expr2} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr1} or {expr2} is not a |Float| or a |Number|. - Examples: > - :echo fmod(12.33, 1.22) -< 0.13 > - :echo fmod(-12.33, 1.22) + Examples: >vim + echo fmod(12.33, 1.22) +< 0.13 >vim + echo fmod(-12.33, 1.22) < -0.13 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->fmod(1.22) +< fnameescape({string}) *fnameescape()* Escape {string} for use as file name command argument. All - characters that have a special meaning, such as '%' and '|' + characters that have a special meaning, such as `'%'` and `'|'` are escaped with a backslash. For most systems the characters escaped are " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash @@ -2034,21 +2092,22 @@ fnameescape({string}) *fnameescape()* A leading '+' and '>' is also escaped (special after |:edit| and |:write|). And a "-" by itself (special after |:cd|). Returns an empty string on error. - Example: > - :let fname = '+some str%nge|name' - :exe "edit " .. fnameescape(fname) -< results in executing: > + Example: >vim + let fname = '+some str%nge|name' + exe "edit " .. fnameescape(fname) +< results in executing: >vim edit \+some\ str\%nge\|name < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->fnameescape() +< fnamemodify({fname}, {mods}) *fnamemodify()* Modify file name {fname} according to {mods}. {mods} is a string of characters like it is used for file names on the command line. See |filename-modifiers|. - Example: > - :echo fnamemodify("main.c", ":p:h") + Example: >vim + echo fnamemodify("main.c", ":p:h") < results in: > /home/user/vim/vim/src < If {mods} is empty or an unsupported modifier is used then @@ -2060,8 +2119,9 @@ fnamemodify({fname}, {mods}) *fnamemodify()* Note: Environment variables don't work in {fname}, use |expand()| first then. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->fnamemodify(':p:h') +< foldclosed({lnum}) *foldclosed()* The result is a Number. If the line {lnum} is in a closed @@ -2070,8 +2130,9 @@ foldclosed({lnum}) *foldclosed()* {lnum} is used like with |getline()|. Thus "." is the current line, "'m" mark m, etc. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->foldclosed() +< foldclosedend({lnum}) *foldclosedend()* The result is a Number. If the line {lnum} is in a closed @@ -2080,8 +2141,9 @@ foldclosedend({lnum}) *foldclosedend()* {lnum} is used like with |getline()|. Thus "." is the current line, "'m" mark m, etc. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->foldclosedend() +< foldlevel({lnum}) *foldlevel()* The result is a Number, which is the foldlevel of line {lnum} @@ -2095,7 +2157,7 @@ foldlevel({lnum}) *foldlevel()* {lnum} is used like with |getline()|. Thus "." is the current line, "'m" mark m, etc. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->foldlevel() < @@ -2125,7 +2187,7 @@ foldtextresult({lnum}) *foldtextresult()* line, "'m" mark m, etc. Useful when exporting folded text, e.g., to HTML. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->foldtextresult() < @@ -2141,7 +2203,7 @@ fullcommand({name}) *fullcommand()* For example `fullcommand('s')`, `fullcommand('sub')`, `fullcommand(':%substitute')` all return "substitute". - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->fullcommand() < @@ -2157,7 +2219,7 @@ funcref({name} [, {arglist}] [, {dict}]) *funcref()* instead). {name} cannot be a builtin function. Returns 0 on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFuncname()->funcref([arg]) < @@ -2168,7 +2230,7 @@ function({name} [, {arglist}] [, {dict}]) *function()* *partial* *E700* *E923* {name} can also be a Funcref or a partial. When it is a partial the dict stored in it will be used and the {dict} - argument is not allowed. E.g.: > + argument is not allowed. E.g.: >vim let FuncWithArg = function(dict.Func, [arg]) let Broken = function(dict.Func, [arg], dict) < @@ -2181,38 +2243,41 @@ function({name} [, {arglist}] [, {dict}]) *function()* *partial* *E700* *E923* the Funcref and will be used when the Funcref is called. The arguments are passed to the function in front of other - arguments, but after any argument from |method|. Example: > + arguments, but after any argument from |method|. Example: >vim func Callback(arg1, arg2, name) "... + endfunc let Partial = function('Callback', ['one', 'two']) "... call Partial('name') -< Invokes the function as with: > +< Invokes the function as with: >vim call Callback('one', 'two', 'name') -< With a |method|: > +< With a |method|: >vim func Callback(one, two, three) "... + endfunc let Partial = function('Callback', ['two']) "... eval 'one'->Partial('three') -< Invokes the function as with: > +< Invokes the function as with: >vim call Callback('one', 'two', 'three') < The function() call can be nested to add more arguments to the Funcref. The extra arguments are appended to the list of - arguments. Example: > + arguments. Example: >vim func Callback(arg1, arg2, name) "... + endfunc let Func = function('Callback', ['one']) let Func2 = function(Func, ['two']) "... call Func2('name') -< Invokes the function as with: > +< Invokes the function as with: >vim call Callback('one', 'two', 'name') < The Dictionary is only useful when calling a "dict" function. - In that case the {dict} is passed in as "self". Example: > + In that case the {dict} is passed in as "self". Example: >vim function Callback() dict echo "called for " .. self.name endfunction @@ -2223,24 +2288,26 @@ function({name} [, {arglist}] [, {dict}]) *function()* *partial* *E700* *E923* call Func() " will echo: called for example < The use of function() is not needed when there are no extra arguments, these two are equivalent, if Callback() is defined - as context.Callback(): > + as context.Callback(): >vim let Func = function('Callback', context) let Func = context.Callback -< The argument list and the Dictionary can be combined: > +< The argument list and the Dictionary can be combined: >vim function Callback(arg1, count) dict "... + endfunction let context = {"name": "example"} let Func = function('Callback', ['one'], context) "... call Func(500) -< Invokes the function as with: > +< Invokes the function as with: >vim call context.Callback('one', 500) < Returns 0 on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFuncname()->function([arg]) +< garbagecollect([{atexit}]) *garbagecollect()* Cleanup unused |Lists| and |Dictionaries| that have circular @@ -2266,8 +2333,9 @@ get({list}, {idx} [, {default}]) *get()* Get item {idx} from |List| {list}. When this item is not available return {default}. Return zero when {default} is omitted. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->get(idx) +< get({blob}, {idx} [, {default}]) Get byte {idx} from |Blob| {blob}. When this byte is not @@ -2277,7 +2345,7 @@ get({blob}, {idx} [, {default}]) get({dict}, {key} [, {default}]) Get item with key {key} from |Dictionary| {dict}. When this item is not available return {default}. Return zero when - {default} is omitted. Useful example: > + {default} is omitted. Useful example: >vim let val = get(g:, 'var_name', 'default') < This gets the value of g:var_name if it exists, and uses "default" when it does not exist. @@ -2326,8 +2394,8 @@ getbufinfo([{dict}]) *getbufinfo()* displayed in the window in the past. If you want the line number of the last known cursor position in a given - window, use |line()|: > - :echo line('.', {winid}) + window, use |line()|: >vim + echo line('.', {winid}) < linecount Number of lines in the buffer (only valid when loaded) @@ -2344,20 +2412,20 @@ getbufinfo([{dict}]) *getbufinfo()* windows List of |window-ID|s that display this buffer - Examples: > + Examples: >vim for buf in getbufinfo() echo buf.name endfor for buf in getbufinfo({'buflisted':1}) if buf.changed - .... + " .... endif endfor < - To get buffer-local options use: > + To get buffer-local options use: >vim getbufvar({bufnr}, '&option_name') < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetBufnr()->getbufinfo() < @@ -2383,10 +2451,10 @@ getbufline({buf}, {lnum} [, {end}]) *getbufline()* This function works only for loaded buffers. For unloaded and non-existing buffers, an empty |List| is returned. - Example: > - :let lines = getbufline(bufnr("myfile"), 1, "$") + Example: >vim + let lines = getbufline(bufnr("myfile"), 1, "$") -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetBufnr()->getbufline(lnum) < @@ -2411,11 +2479,11 @@ getbufvar({buf}, {varname} [, {def}]) *getbufvar()* For the use of {buf}, see |bufname()| above. When the buffer or variable doesn't exist {def} or an empty string is returned, there is no error message. - Examples: > - :let bufmodified = getbufvar(1, "&mod") - :echo "todo myvar = " .. getbufvar("todo", "myvar") + Examples: >vim + let bufmodified = getbufvar(1, "&mod") + echo "todo myvar = " .. getbufvar("todo", "myvar") -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetBufnr()->getbufvar(varname) < @@ -2441,8 +2509,9 @@ getchangelist([{buf}]) *getchangelist()* position refers to the position in the list. For other buffers, it is set to the length of the list. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetBufnr()->getchangelist() +< getchar([expr]) *getchar()* Get a single character from the user or input stream. @@ -2478,7 +2547,7 @@ getchar([expr]) *getchar()* |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|. |getmousepos()| can also be used. Mouse move events will be ignored. - This example positions the mouse as it would normally happen: > + This example positions the mouse as it would normally happen: >vim let c = getchar() if c == "\<LeftMouse>" && v:mouse_win > 0 exe v:mouse_win .. "wincmd w" @@ -2493,20 +2562,20 @@ getchar([expr]) *getchar()* There is no mapping for the character. Key codes are replaced, thus when the user presses the <Del> key you get the code for the <Del> key, not the raw character - sequence. Examples: > + sequence. Examples: >vim getchar() == "\<Del>" getchar() == "\<S-Left>" -< This example redefines "f" to ignore case: > - :nmap f :call FindChar()<CR> - :function FindChar() - : let c = nr2char(getchar()) - : while col('.') < col('$') - 1 - : normal l - : if getline('.')[col('.') - 1] ==? c - : break - : endif - : endwhile - :endfunction +< This example redefines "f" to ignore case: >vim + nmap f :call FindChar()<CR> + function FindChar() + let c = nr2char(getchar()) + while col('.') < col('$') - 1 + normal l + if getline('.')[col('.') - 1] ==? c + break + endif + endwhile + endfunction < getcharmod() *getcharmod()* @@ -2534,12 +2603,13 @@ getcharpos({expr}) *getcharpos()* of the last character. Example: - With the cursor on 'μΈ' in line 5 with text "μ¬λ³΄μΈμ": > + With the cursor on 'μΈ' in line 5 with text "μ¬λ³΄μΈμ": >vim getcharpos('.') returns [0, 5, 3, 0] getpos('.') returns [0, 5, 7, 0] < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetMark()->getcharpos() +< getcharsearch() *getcharsearch()* Return the current character search information as a {dict} @@ -2556,9 +2626,9 @@ getcharsearch() *getcharsearch()* This can be useful to always have |;| and |,| search forward/backward regardless of the direction of the previous - character search: > - :nnoremap <expr> ; getcharsearch().forward ? ';' : ',' - :nnoremap <expr> , getcharsearch().forward ? ',' : ';' + character search: >vim + nnoremap <expr> ; getcharsearch().forward ? ';' : ',' + nnoremap <expr> , getcharsearch().forward ? ',' : ';' < Also see |setcharsearch()|. getcharstr([expr]) *getcharstr()* @@ -2586,8 +2656,8 @@ getcmdline() *getcmdline()* Return the current command-line. Only works when the command line is being edited, thus requires use of |c_CTRL-\_e| or |c_CTRL-R_=|. - Example: > - :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> + Example: >vim + cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR> < Also see |getcmdtype()|, |getcmdpos()|, |setcmdpos()| and |setcmdline()|. Returns an empty string when entering a password or using @@ -2692,13 +2762,13 @@ getcompletion({pat}, {type} [, {filtered}]) *getcompletion()* If {type} is "cmdline", then the |cmdline-completion| result is returned. For example, to complete the possible values after - a ":call" command: > + a ":call" command: >vim echo getcompletion('call ', 'cmdline') < If there are no matches, an empty list is returned. An invalid value for {type} produces an error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetPattern()->getcompletion('color') < @@ -2720,14 +2790,14 @@ getcurpos([{winid}]) *getcurpos()* current value of the buffer if it is not the current window. If {winid} is invalid a list with zeroes is returned. - This can be used to save and restore the cursor position: > + This can be used to save and restore the cursor position: >vim let save_cursor = getcurpos() MoveTheCursorAround call setpos('.', save_cursor) < Note that this only works within the window. See |winrestview()| for restoring more state. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinid()->getcurpos() < @@ -2736,12 +2806,13 @@ getcursorcharpos([{winid}]) *getcursorcharpos()* List is a character index instead of a byte index. Example: - With the cursor on '보' in line 3 with text "μ¬λ³΄μΈμ": > - getcursorcharpos() returns [0, 3, 2, 0, 3] - getcurpos() returns [0, 3, 4, 0, 3] + With the cursor on '보' in line 3 with text "μ¬λ³΄μΈμ": >vim + getcursorcharpos() " returns [0, 3, 2, 0, 3] + getcurpos() " returns [0, 3, 4, 0, 3] < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinid()->getcursorcharpos() +< getcwd([{winnr} [, {tabnr}]]) *getcwd()* With no arguments, returns the name of the effective @@ -2750,7 +2821,7 @@ getcwd([{winnr} [, {tabnr}]]) *getcwd()* ignored. Tabs and windows are identified by their respective numbers, 0 means current tab or window. Missing tab number implies 0. - Thus the following are equivalent: > + Thus the following are equivalent: >vim getcwd(0) getcwd(0, 0) < If {winnr} is -1 it is ignored, only the tab is resolved. @@ -2759,20 +2830,22 @@ getcwd([{winnr} [, {tabnr}]]) *getcwd()* directory is returned. Throw error if the arguments are invalid. |E5000| |E5001| |E5002| - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinnr()->getcwd() +< getenv({name}) *getenv()* Return the value of environment variable {name}. The {name} - argument is a string, without a leading '$'. Example: > + argument is a string, without a leading '$'. Example: >vim myHome = getenv('HOME') < When the variable does not exist |v:null| is returned. That is different from a variable set to an empty string. See also |expr-env|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetVarname()->getenv() +< getfontname([{name}]) *getfontname()* Without an argument returns the name of the normal font being @@ -2795,13 +2868,13 @@ getfperm({fname}) *getfperm()* "rwx" flags represent, in turn, the permissions of the owner of the file, the group the file belongs to, and other users. If a user does not have a given permission the flag for this - is replaced with the string "-". Examples: > - :echo getfperm("/etc/passwd") - :echo getfperm(expand("~/.config/nvim/init.vim")) + is replaced with the string "-". Examples: >vim + echo getfperm("/etc/passwd") + echo getfperm(expand("~/.config/nvim/init.vim")) < This will hopefully (from a security point of view) display the string "rw-r--r--" or even "rw-------". - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFilename()->getfperm() < For setting permissions use |setfperm()|. @@ -2814,8 +2887,9 @@ getfsize({fname}) *getfsize()* If the size of {fname} is too big to fit in a Number then -2 is returned. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFilename()->getfsize() +< getftime({fname}) *getftime()* The result is a Number, which is the last modification time of @@ -2824,8 +2898,9 @@ getftime({fname}) *getftime()* |localtime()| and |strftime()|. If the file {fname} can't be found -1 is returned. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFilename()->getftime() +< getftype({fname}) *getftype()* The result is a String, which is a description of the kind of @@ -2841,14 +2916,15 @@ getftype({fname}) *getftype()* Socket "socket" FIFO "fifo" All other "other" - Example: > + Example: >vim getftype("/home") < Note that a type such as "link" will only be returned on systems that support it. On some systems only "dir" and "file" are returned. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFilename()->getftype() +< getjumplist([{winnr} [, {tabnr}]]) *getjumplist()* Returns the |jumplist| for the specified window. @@ -2870,17 +2946,17 @@ getjumplist([{winnr} [, {tabnr}]]) *getjumplist()* filename filename if available lnum line number - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinnr()->getjumplist() < getline({lnum} [, {end}]) *getline()* Without {end} the result is a String, which is line {lnum} - from the current buffer. Example: > + from the current buffer. Example: >vim getline(1) < When {lnum} is a String that doesn't start with a digit, |line()| is called to translate the String into a Number. - To get the line under the cursor: > + To get the line under the cursor: >vim getline(".") < When {lnum} is a number smaller than 1 or bigger than the number of lines in the buffer, an empty string is returned. @@ -2891,12 +2967,12 @@ getline({lnum} [, {end}]) *getline()* {end} is used in the same way as {lnum}. Non-existing lines are silently omitted. When {end} is before {lnum} an empty |List| is returned. - Example: > - :let start = line('.') - :let end = search("^$") - 1 - :let lines = getline(start, end) + Example: >vim + let start = line('.') + let end = search("^$") - 1 + let lines = getline(start, end) -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim ComputeLnum()->getline() < To get lines from another buffer see |getbufline()| and @@ -2929,9 +3005,9 @@ getloclist({nr} [, {what}]) *getloclist()* location list for the window {nr}. Returns an empty Dictionary if window {nr} does not exist. - Examples (See also |getqflist-examples|): > - :echo getloclist(3, {'all': 0}) - :echo getloclist(5, {'filewinid': 0}) + Examples (See also |getqflist-examples|): >vim + echo getloclist(3, {'all': 0}) + echo getloclist(5, {'filewinid': 0}) < getmarklist([{buf}]) *getmarklist()* @@ -2953,8 +3029,9 @@ getmarklist([{buf}]) *getmarklist()* Refer to |getpos()| for getting information about a specific mark. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetBufnr()->getmarklist() +< getmatches([{win}]) *getmatches()* Returns a |List| with all matches previously defined for the @@ -2966,26 +3043,26 @@ getmatches([{win}]) *getmatches()* window ID instead of the current window. If {win} is invalid, an empty list is returned. Example: >vim - :echo getmatches() + echo getmatches() < > [{"group": "MyGroup1", "pattern": "TODO", "priority": 10, "id": 1}, {"group": "MyGroup2", "pattern": "FIXME", "priority": 10, "id": 2}] < >vim - :let m = getmatches() - :call clearmatches() - :echo getmatches() + let m = getmatches() + call clearmatches() + echo getmatches() < > [] < >vim - :call setmatches(m) - :echo getmatches() + call setmatches(m) + echo getmatches() < > [{"group": "MyGroup1", "pattern": "TODO", "priority": 10, "id": 1}, {"group": "MyGroup2", "pattern": "FIXME", "priority": 10, "id": 2}] < >vim - :unlet m + unlet m < getmousepos() *getmousepos()* @@ -3044,14 +3121,15 @@ getpos({expr}) *getpos()* A very large column number equal to |v:maxcol| can be returned, in which case it means "after the end of the line". If {expr} is invalid, returns a list with all zeros. - This can be used to save and restore the position of a mark: > + This can be used to save and restore the position of a mark: >vim let save_a_mark = getpos("'a") - ... + " ... call setpos("'a", save_a_mark) < Also see |getcharpos()|, |getcurpos()| and |setpos()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetMark()->getpos() +< getqflist([{what}]) *getqflist()* Returns a |List| with all the current quickfix errors. Each @@ -3079,11 +3157,11 @@ getqflist([{what}]) *getqflist()* you may need to explicitly check for zero). Useful application: Find pattern matches in multiple files and - do something with them: > - :vimgrep /theword/jg *.c - :for d in getqflist() - : echo bufname(d.bufnr) ':' d.lnum '=' d.text - :endfor + do something with them: >vim + vimgrep /theword/jg *.c + for d in getqflist() + echo bufname(d.bufnr) ':' d.lnum '=' d.text + endfor < If the optional {what} dictionary argument is supplied, then returns only the items listed in {what} as a dictionary. The @@ -3148,16 +3226,16 @@ getqflist([{what}]) *getqflist()* to "". winid quickfix |window-ID|. If not present, set to 0 - Examples (See also |getqflist-examples|): > - :echo getqflist({'all': 1}) - :echo getqflist({'nr': 2, 'title': 1}) - :echo getqflist({'lines' : ["F1:10:L10"]}) + Examples (See also |getqflist-examples|): >vim + echo getqflist({'all': 1}) + echo getqflist({'nr': 2, 'title': 1}) + echo getqflist({'lines' : ["F1:10:L10"]}) < getreg([{regname} [, 1 [, {list}]]]) *getreg()* The result is a String, which is the contents of register - {regname}. Example: > - :let cliptext = getreg('*') + {regname}. Example: >vim + let cliptext = getreg('*') < When register {regname} was not set the result is an empty string. The {regname} argument must be a string. @@ -3177,8 +3255,9 @@ getreg([{regname} [, 1 [, {list}]]]) *getreg()* If {regname} is not specified, |v:register| is used. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetRegname()->getreg() +< getreginfo([{regname}]) *getreginfo()* Returns detailed information about register {regname} as a @@ -3204,8 +3283,9 @@ getreginfo([{regname}]) *getreginfo()* If {regname} is not specified, |v:register| is used. The returned Dictionary can be passed to |setreg()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetRegname()->getreginfo() +< getregtype([{regname}]) *getregtype()* The result is a String, which is type of register {regname}. @@ -3218,8 +3298,9 @@ getregtype([{regname}]) *getregtype()* The {regname} argument is a string. If {regname} is not specified, |v:register| is used. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetRegname()->getregtype() +< getscriptinfo([{opts}]) *getscriptinfo()* Returns a |List| with information about all the sourced Vim @@ -3253,9 +3334,9 @@ getscriptinfo([{opts}]) *getscriptinfo()* this dictionary. version Vimscript version, always 1 - Examples: > - :echo getscriptinfo({'name': 'myscript'}) - :echo getscriptinfo({'sid': 15}).variables + Examples: >vim + echo getscriptinfo({'name': 'myscript'}) + echo getscriptinfo({'sid': 15}).variables < gettabinfo([{tabnr}]) *gettabinfo()* @@ -3271,8 +3352,9 @@ gettabinfo([{tabnr}]) *gettabinfo()* tabpage-local variables windows List of |window-ID|s in the tab page. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetTabnr()->gettabinfo() +< gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* Get the value of a tab-local variable {varname} in tab page @@ -3284,8 +3366,9 @@ gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()* When the tab or variable doesn't exist {def} or an empty string is returned, there is no error message. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetTabnr()->gettabvar(varname) +< gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* Get the value of window-local variable {varname} in window @@ -3306,15 +3389,16 @@ gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()* or buffer-local variable. When the tab, window or variable doesn't exist {def} or an empty string is returned, there is no error message. - Examples: > - :let list_is_on = gettabwinvar(1, 2, '&list') - :echo "myvar = " .. gettabwinvar(3, 1, 'myvar') + Examples: >vim + let list_is_on = gettabwinvar(1, 2, '&list') + echo "myvar = " .. gettabwinvar(3, 1, 'myvar') < - To obtain all window-local variables use: > + To obtain all window-local variables use: >vim gettabwinvar({tabnr}, {winnr}, '&') < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetTabnr()->gettabwinvar(winnr, varname) +< gettagstack([{winnr}]) *gettagstack()* The result is a Dict, which is the tag stack of window {winnr}. @@ -3344,7 +3428,7 @@ gettagstack([{winnr}]) *gettagstack()* See |tagstack| for more information about the tag stack. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinnr()->gettagstack() < @@ -3393,8 +3477,9 @@ getwininfo([{winid}]) *getwininfo()* winrow topmost screen line of the window; "row" from |win_screenpos()| - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinnr()->getwininfo() +< getwinpos([{timeout}]) *getwinpos()* The result is a |List| with two numbers, the result of @@ -3407,7 +3492,7 @@ getwinpos([{timeout}]) *getwinpos()* When using a value less than 10 and no response is received within that time, a previously reported position is returned, if available. This can be used to poll for the position and - do some work in the meantime: > + do some work in the meantime: >vim while 1 let res = getwinpos(1) if res[0] >= 0 @@ -3416,7 +3501,7 @@ getwinpos([{timeout}]) *getwinpos()* " Do some work here endwhile < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetTimeout()->getwinpos() < @@ -3434,11 +3519,11 @@ getwinposy() *getwinposy()* getwinvar({winnr}, {varname} [, {def}]) *getwinvar()* Like |gettabwinvar()| for the current tabpage. - Examples: > - :let list_is_on = getwinvar(2, '&list') - :echo "myvar = " .. getwinvar(1, 'myvar') + Examples: >vim + let list_is_on = getwinvar(2, '&list') + echo "myvar = " .. getwinvar(1, 'myvar') -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetWinnr()->getwinvar(varname) < @@ -3469,38 +3554,43 @@ glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()* |TRUE| then all symbolic links are included. For most systems backticks can be used to get files names from - any external command. Example: > - :let tagfiles = glob("`find . -name tags -print`") - :let &tags = substitute(tagfiles, "\n", ",", "g") + any external command. Example: >vim + let tagfiles = glob("`find . -name tags -print`") + let &tags = substitute(tagfiles, "\n", ",", "g") < The result of the program inside the backticks should be one item per line. Spaces inside an item are allowed. See |expand()| for expanding special Vim variables. See |system()| for getting the raw output of an external command. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetExpr()->glob() +< glob2regpat({string}) *glob2regpat()* Convert a file pattern, as used by glob(), into a search pattern. The result can be used to match with a string that - is a file name. E.g. > + is a file name. E.g. >vim if filename =~ glob2regpat('Make*.mak') -< This is equivalent to: > + " ... + endif +< This is equivalent to: >vim if filename =~ '^Make.*\.mak$' + " ... + endif < When {string} is an empty string the result is "^$", match an empty string. Note that the result depends on the system. On MS-Windows a backslash usually means a path separator. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetExpr()->glob2regpat() < globpath({path}, {expr} [, {nosuf} [, {list} [, {allinks}]]]) *globpath()* Perform glob() for String {expr} on all directories in {path} - and concatenate the results. Example: > - :echo globpath(&rtp, "syntax/c.vim") + and concatenate the results. Example: >vim + echo globpath(&rtp, "syntax/c.vim") < {path} is a comma-separated list of directory names. Each directory name is prepended to {expr} and expanded like with @@ -3520,20 +3610,20 @@ globpath({path}, {expr} [, {nosuf} [, {list} [, {allinks}]]]) *globpath()* with all matching files. The advantage of using a List is, you also get filenames containing newlines correctly. Otherwise the result is a String and when there are several matches, - they are separated by <NL> characters. Example: > - :echo globpath(&rtp, "syntax/c.vim", 0, 1) + they are separated by <NL> characters. Example: >vim + echo globpath(&rtp, "syntax/c.vim", 0, 1) < {allinks} is used as with |glob()|. The "**" item can be used to search in a directory tree. For example, to find all "README.txt" files in the directories - in 'runtimepath' and below: > - :echo globpath(&rtp, "**/README.txt") + in 'runtimepath' and below: >vim + echo globpath(&rtp, "**/README.txt") < Upwards search and limiting the depth of "**" is not supported, thus using 'path' will not always work properly. Can also be used as a |method|, the base is passed as the - second argument: > + second argument: >vim GetExpr()->globpath(&rtp) < @@ -3547,9 +3637,9 @@ has({feature}) *has()* < If the code has a syntax error then Vimscript may skip the rest of the line. Put |:if| and |:endif| on separate lines to - avoid the syntax error: > + avoid the syntax error: >vim if has('feature') - let x = this->breaks->without->the->feature + let x = this_breaks_without_the_feature() endif < Vim's compile-time feature-names (prefixed with "+") are not @@ -3558,12 +3648,16 @@ has({feature}) *has()* Feature names can be: 1. Nvim version. For example the "nvim-0.2.1" feature means - that Nvim is version 0.2.1 or later: > - :if has("nvim-0.2.1") + that Nvim is version 0.2.1 or later: >vim + if has("nvim-0.2.1") + " ... + endif < 2. Runtime condition or other pseudo-feature. For example the - "win32" feature checks if the current system is Windows: > - :if has("win32") + "win32" feature checks if the current system is Windows: >vim + if has("win32") + " ... + endif < *feature-list* List of supported pseudo-feature names: acl |ACL| support. @@ -3589,12 +3683,16 @@ has({feature}) *has()* *has-patch* 3. Vim patch. For example the "patch123" feature means that - Vim patch 123 at the current |v:version| was included: > - :if v:version > 602 || v:version == 602 && has("patch148") + Vim patch 123 at the current |v:version| was included: >vim + if v:version > 602 || v:version == 602 && has("patch148") + " ... + endif < 4. Vim version. For example the "patch-7.4.237" feature means - that Nvim is Vim-compatible to version 7.4.237 or later. > - :if has("patch-7.4.237") + that Nvim is Vim-compatible to version 7.4.237 or later. >vim + if has("patch-7.4.237") + " ... + endif < has_key({dict}, {key}) *has_key()* @@ -3602,8 +3700,9 @@ has_key({dict}, {key}) *has_key()* has an entry with key {key}. FALSE otherwise. The {key} argument is a string. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mydict->has_key(key) +< haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()* The result is a Number, which is 1 when the window has set a @@ -3612,18 +3711,19 @@ haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()* Tabs and windows are identified by their respective numbers, 0 means current tab or window. Missing argument implies 0. - Thus the following are equivalent: > - haslocaldir() - haslocaldir(0) - haslocaldir(0, 0) + Thus the following are equivalent: >vim + echo haslocaldir() + echo haslocaldir(0) + echo haslocaldir(0, 0) < With {winnr} use that window in the current tabpage. With {winnr} and {tabnr} use the window in that tabpage. {winnr} can be the window number or the |window-ID|. If {winnr} is -1 it is ignored, only the tab is resolved. Throw error if the arguments are invalid. |E5000| |E5001| |E5002| - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinnr()->haslocaldir() +< hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* The result is a Number, which is TRUE if there is a mapping @@ -3649,15 +3749,16 @@ hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()* When {mode} is omitted, "nvo" is used. This function is useful to check if a mapping already exists - to a function in a Vim script. Example: > - :if !hasmapto('\ABCdoit') - : map <Leader>d \ABCdoit - :endif + to a function in a Vim script. Example: >vim + if !hasmapto('\ABCdoit') + map <Leader>d \ABCdoit + endif < This installs the mapping to "\ABCdoit" only if there isn't already a mapping to "\ABCdoit". - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetRHS()->hasmapto() +< histadd({history}, {item}) *histadd()* Add the String {item} to the history {history} which can be @@ -3675,14 +3776,15 @@ histadd({history}, {item}) *histadd()* The result is a Number: TRUE if the operation was successful, otherwise FALSE is returned. - Example: > - :call histadd("input", strftime("%Y %b %d")) - :let date=input("Enter date: ") + Example: >vim + call histadd("input", strftime("%Y %b %d")) + let date=input("Enter date: ") < This function is not available in the |sandbox|. Can also be used as a |method|, the base is passed as the - second argument: > + second argument: >vim GetHistory()->histadd('search') +< histdel({history} [, {item}]) *histdel()* Clear {history}, i.e. delete all its entries. See |hist-names| @@ -3700,24 +3802,25 @@ histdel({history} [, {item}]) *histdel()* is returned. Examples: - Clear expression register history: > - :call histdel("expr") + Clear expression register history: >vim + call histdel("expr") < - Remove all entries starting with "*" from the search history: > - :call histdel("/", '^\*') + Remove all entries starting with "*" from the search history: >vim + call histdel("/", '^\*') < - The following three are equivalent: > - :call histdel("search", histnr("search")) - :call histdel("search", -1) - :call histdel("search", '^' .. histget("search", -1) .. '$') + The following three are equivalent: >vim + call histdel("search", histnr("search")) + call histdel("search", -1) + call histdel("search", '^' .. histget("search", -1) .. '$') < To delete the last search pattern and use the last-but-one for - the "n" command and 'hlsearch': > - :call histdel("search", -1) - :let @/ = histget("search", -1) + the "n" command and 'hlsearch': >vim + call histdel("search", -1) + let @/ = histget("search", -1) < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetHistory()->histdel() +< histget({history} [, {index}]) *histget()* The result is a String, the entry with Number {index} from @@ -3727,25 +3830,26 @@ histget({history} [, {index}]) *histget()* omitted, the most recent item from the history is used. Examples: - Redo the second last search from history. > - :execute '/' .. histget("search", -2) + Redo the second last search from history. >vim + execute '/' .. histget("search", -2) < Define an Ex command ":H {num}" that supports re-execution of - the {num}th entry from the output of |:history|. > - :command -nargs=1 H execute histget("cmd", 0+<args>) + the {num}th entry from the output of |:history|. >vim + command -nargs=1 H execute histget("cmd", 0+<args>) < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetHistory()->histget() +< histnr({history}) *histnr()* The result is the Number of the current entry in {history}. See |hist-names| for the possible values of {history}. If an error occurred, -1 is returned. - Example: > - :let inp_index = histnr("expr") + Example: >vim + let inp_index = histnr("expr") -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetHistory()->histnr() < @@ -3755,11 +3859,12 @@ hlID({name}) *hlID()* zero is returned. This can be used to retrieve information about the highlight group. For example, to get the background color of the - "Comment" group: > - :echo synIDattr(synIDtrans(hlID("Comment")), "bg") + "Comment" group: >vim + echo synIDattr(synIDtrans(hlID("Comment")), "bg") < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->hlID() +< hlexists({name}) *hlexists()* The result is a Number, which is TRUE if a highlight group @@ -3768,7 +3873,7 @@ hlexists({name}) *hlexists()* been defined for it, it may also have been used for a syntax item. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->hlexists() < @@ -3789,7 +3894,7 @@ iconv({string}, {from}, {to}) *iconv()* from/to UCS-2 is automatically changed to use UTF-8. You cannot use UCS-2 in a string anyway, because of the NUL bytes. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->iconv('latin1', 'utf-8') < @@ -3798,8 +3903,8 @@ id({expr}) *id()* container type (|List|, |Dict|, |Blob| and |Partial|). It is guaranteed that for the mentioned types `id(v1) ==# id(v2)` returns true iff `type(v1) == type(v2) && v1 is v2`. - Note that |v:_null_string|, |v:_null_list|, |v:_null_dict| and - |v:_null_blob| have the same `id()` with different types + Note that `v:_null_string`, `v:_null_list`, `v:_null_dict` and + `v:_null_blob` have the same `id()` with different types because they are internally represented as NULL pointers. `id()` returns a hexadecimal representanion of the pointers to the containers (i.e. like `0x994a40`), same as `printf("%p", @@ -3816,8 +3921,9 @@ indent({lnum}) *indent()* |getline()|. When {lnum} is invalid -1 is returned. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->indent() +< index({object}, {expr} [, {start} [, {ic}]]) *index()* Find {expr} in {object} and return its index. See @@ -3840,12 +3946,15 @@ index({object}, {expr} [, {start} [, {ic}]]) *index()* case must match. -1 is returned when {expr} is not found in {object}. - Example: > - :let idx = index(words, "the") - :if index(numbers, 123) >= 0 + Example: >vim + let idx = index(words, "the") + if index(numbers, 123) >= 0 + " ... + endif -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetObject()->index(what) +< indexof({object}, {expr} [, {opts}]) *indexof()* Returns the index of an item in {object} where {expr} is @@ -3879,14 +3988,15 @@ indexof({object}, {expr} [, {opts}]) *indexof()* index; may be negative for an item relative to the end Returns -1 when {expr} evaluates to v:false for all the items. - Example: > - :let l = [#{n: 10}, #{n: 20}, #{n: 30}] - :echo indexof(l, "v:val.n == 20") - :echo indexof(l, {i, v -> v.n == 30}) - :echo indexof(l, "v:val.n == 20", #{startidx: 1}) + Example: >vim + let l = [#{n: 10}, #{n: 20}, #{n: 30}] + echo indexof(l, "v:val.n == 20") + echo indexof(l, {i, v -> v.n == 30}) + echo indexof(l, "v:val.n == 20", #{startidx: 1}) -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim mylist->indexof(expr) +< input({prompt} [, {text} [, {completion}]]) *input()* @@ -3911,22 +4021,22 @@ input({opts}) The input is entered just like a command-line, with the same editing commands and mappings. There is a separate history for lines typed for input(). - Example: > - :if input("Coffee or beer? ") == "beer" - : echo "Cheers!" - :endif + Example: >vim + if input("Coffee or beer? ") == "beer" + echo "Cheers!" + endif < If the optional {text} argument is present and not empty, this is used for the default reply, as if the user typed this. - Example: > - :let color = input("Color? ", "white") + Example: >vim + let color = input("Color? ", "white") < The optional {completion} argument specifies the type of completion supported for the input. Without it completion is not performed. The supported completion types are the same as that can be supplied to a user-defined command using the "-complete=" argument. Refer to |:command-completion| for - more information. Example: > + more information. Example: >vim let fname = input("File: ", "", "file") < *input()-highlight* *E5400* *E5402* @@ -3947,7 +4057,7 @@ input({opts}) sections must be ordered so that next hl_start_col is greater then or equal to previous hl_end_col. - Example (try some input with parentheses): > + Example (try some input with parentheses): >vim highlight RBP1 guibg=Red ctermbg=red highlight RBP2 guibg=Yellow ctermbg=yellow highlight RBP3 guibg=Green ctermbg=green @@ -3992,16 +4102,17 @@ input({opts}) that further characters follow in the mapping, e.g., by using |:execute| or |:normal|. - Example with a mapping: > - :nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR> - :function GetFoo() - : call inputsave() - : let g:Foo = input("enter search pattern: ") - : call inputrestore() - :endfunction + Example with a mapping: >vim + nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR> + function GetFoo() + call inputsave() + let g:Foo = input("enter search pattern: ") + call inputrestore() + endfunction -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetPrompt()->input() +< inputlist({textlist}) *inputlist()* {textlist} must be a |List| of strings. This |List| is @@ -4016,12 +4127,13 @@ inputlist({textlist}) *inputlist()* Make sure {textlist} has less than 'lines' entries, otherwise it won't work. It's a good idea to put the entry number at the start of the string. And put a prompt in the first item. - Example: > + Example: >vim let color = inputlist(['Select color:', '1. red', \ '2. green', '3. blue']) -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetChoices()->inputlist() +< inputrestore() *inputrestore()* Restore typeahead that was saved with a previous |inputsave()|. @@ -4048,8 +4160,9 @@ inputsecret({prompt} [, {text}]) *inputsecret()* typed on the command-line in response to the issued prompt. NOTE: Command-line completion is not supported. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetPrompt()->inputsecret() +< insert({object}, {item} [, {idx}]) *insert()* When {object} is a |List| or a |Blob| insert {item} at the start @@ -4060,36 +4173,39 @@ insert({object}, {item} [, {idx}]) *insert()* like omitting {idx}. A negative {idx} is also possible, see |list-index|. -1 inserts just before the last item. - Returns the resulting |List| or |Blob|. Examples: > - :let mylist = insert([2, 3, 5], 1) - :call insert(mylist, 4, -1) - :call insert(mylist, 6, len(mylist)) + Returns the resulting |List| or |Blob|. Examples: >vim + let mylist = insert([2, 3, 5], 1) + call insert(mylist, 4, -1) + call insert(mylist, 6, len(mylist)) < The last example can be done simpler with |add()|. Note that when {item} is a |List| it is inserted as a single item. Use |extend()| to concatenate |Lists|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->insert(item) +< interrupt() *interrupt()* Interrupt script execution. It works more or less like the user typing CTRL-C, most commands won't execute and control returns to the user. This is useful to abort execution - from lower down, e.g. in an autocommand. Example: > - :function s:check_typoname(file) - : if fnamemodify(a:file, ':t') == '[' - : echomsg 'Maybe typo' - : call interrupt() - : endif - :endfunction - :au BufWritePre * call s:check_typoname(expand('<amatch>')) + from lower down, e.g. in an autocommand. Example: >vim + function s:check_typoname(file) + if fnamemodify(a:file, ':t') == '[' + echomsg 'Maybe typo' + call interrupt() + endif + endfunction + au BufWritePre * call s:check_typoname(expand('<amatch>')) +< invert({expr}) *invert()* Bitwise invert. The argument is converted to a number. A - List, Dict or Float argument causes an error. Example: > - :let bits = invert(bits) -< Can also be used as a |method|: > - :let bits = bits->invert() + List, Dict or Float argument causes an error. Example: >vim + let bits = invert(bits) +< Can also be used as a |method|: >vim + let bits = bits->invert() +< isdirectory({directory}) *isdirectory()* The result is a Number, which is |TRUE| when a directory @@ -4097,57 +4213,62 @@ isdirectory({directory}) *isdirectory()* exist, or isn't a directory, the result is |FALSE|. {directory} is any expression, which is used as a String. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->isdirectory() +< isinf({expr}) *isinf()* Return 1 if {expr} is a positive infinity, or -1 a negative - infinity, otherwise 0. > - :echo isinf(1.0 / 0.0) -< 1 > - :echo isinf(-1.0 / 0.0) + infinity, otherwise 0. >vim + echo isinf(1.0 / 0.0) +< 1 >vim + echo isinf(-1.0 / 0.0) < -1 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->isinf() +< islocked({expr}) *islocked()* *E786* The result is a Number, which is |TRUE| when {expr} is the name of a locked variable. The string argument {expr} must be the name of a variable, |List| item or |Dictionary| entry, not the variable itself! - Example: > - :let alist = [0, ['a', 'b'], 2, 3] - :lockvar 1 alist - :echo islocked('alist') " 1 - :echo islocked('alist[1]') " 0 + Example: >vim + let alist = [0, ['a', 'b'], 2, 3] + lockvar 1 alist + echo islocked('alist') " 1 + echo islocked('alist[1]') " 0 < When {expr} is a variable that does not exist you get an error message. Use |exists()| to check for existence. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->islocked() +< isnan({expr}) *isnan()* - Return |TRUE| if {expr} is a float with value NaN. > + Return |TRUE| if {expr} is a float with value NaN. >vim echo isnan(0.0 / 0.0) < 1 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->isnan() +< items({dict}) *items()* Return a |List| with all the key-value pairs of {dict}. Each |List| item is a list with two items: the key of a {dict} entry and the value of this entry. The |List| is in arbitrary order. Also see |keys()| and |values()|. - Example: > + Example: >vim for [key, value] in items(mydict) echo key .. ': ' .. value endfor -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim mydict->items() +< jobpid({job}) *jobpid()* Return the PID (process id) of |job-id| {job}. @@ -4162,12 +4283,12 @@ jobstart({cmd} [, {opts}]) *jobstart()* Spawns {cmd} as a job. If {cmd} is a List it runs directly (no 'shell'). - If {cmd} is a String it runs in the 'shell', like this: > - :call jobstart(split(&shell) + split(&shellcmdflag) + ['{cmd}']) + If {cmd} is a String it runs in the 'shell', like this: >vim + call jobstart(split(&shell) + split(&shellcmdflag) + ['{cmd}']) < (See |shell-unquoting| for details.) - Example: > - :call jobstart('nvim -h', {'on_stdout':{j,d,e->append(line('.'),d)}}) + Example: >vim + call jobstart('nvim -h', {'on_stdout':{j,d,e->append(line('.'),d)}}) < Returns |job-id| on success, 0 on invalid arguments (or job table is full), -1 if {cmd}[0] or 'shell' is not executable. @@ -4180,10 +4301,10 @@ jobstart({cmd} [, {opts}]) *jobstart()* NOTE: on Windows if {cmd} is a List: - cmd[0] must be an executable (not a "built-in"). If it is - in $PATH it can be called by name, without an extension: > - :call jobstart(['ping', 'neovim.io']) -< If it is a full or partial path, extension is required: > - :call jobstart(['System32\ping.exe', 'neovim.io']) + in $PATH it can be called by name, without an extension: >vim + call jobstart(['ping', 'neovim.io']) +< If it is a full or partial path, extension is required: >vim + call jobstart(['System32\ping.exe', 'neovim.io']) < - {cmd} is collapsed to a string of quoted args as expected by CommandLineToArgvW https://msdn.microsoft.com/bb776391 unless cmd[0] is some form of "cmd.exe". @@ -4260,7 +4381,7 @@ jobwait({jobs} [, {timeout}]) *jobwait()* {timeout} is the maximum waiting time in milliseconds. If omitted or -1, wait forever. - Timeout of 0 can be used to check the status of a job: > + Timeout of 0 can be used to check the status of a job: >vim let running = jobwait([{job-id}], 0)[0] == -1 < During jobwait() callbacks for jobs not in the {jobs} list may @@ -4279,14 +4400,15 @@ join({list} [, {sep}]) *join()* When {sep} is specified it is put in between the items. If {sep} is omitted a single space is used. Note that {sep} is not added at the end. You might want to - add it there too: > + add it there too: >vim let lines = join(mylist, "\n") .. "\n" < String items are used as-is. |Lists| and |Dictionaries| are converted into a string like with |string()|. The opposite function is |split()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->join() +< json_decode({expr}) *json_decode()* Convert {expr} from JSON object. Accepts |readfile()|-style @@ -4304,8 +4426,9 @@ json_decode({expr}) *json_decode()* recommended and the only one required to be supported. Non-UTF-8 characters are an error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim ReadObject()->json_decode() +< json_encode({expr}) *json_encode()* Convert {expr} into a JSON string. Accepts @@ -4319,24 +4442,26 @@ json_encode({expr}) *json_encode()* or special escapes like "\t", other are dumped as-is. |Blob|s are converted to arrays of the individual bytes. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetObject()->json_encode() +< keys({dict}) *keys()* Return a |List| with all the keys of {dict}. The |List| is in arbitrary order. Also see |items()| and |values()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mydict->keys() +< keytrans({string}) *keytrans()* Turn the internal byte representation of keys into a form that - can be used for |:map|. E.g. > - :let xx = "\<C-Home>" - :echo keytrans(xx) + can be used for |:map|. E.g. >vim + let xx = "\<C-Home>" + echo keytrans(xx) < <C-Home> - Can also be used as a |method|: > + Can also be used as a |method|: >vim "\<C-Home>"->keytrans() < @@ -4350,7 +4475,7 @@ len({expr}) *len()* *E701* |Dictionary| is returned. Otherwise an error is given and returns zero. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->len() < @@ -4393,24 +4518,24 @@ libcall({libname}, {funcname}, {argument}) *libcall()* *E364* *E368* the DLL is not in the usual places. For Unix: When compiling your own plugins, remember that the object code must be compiled as position-independent ('PIC'). - Examples: > - :echo libcall("libc.so", "getenv", "HOME") + Examples: >vim + echo libcall("libc.so", "getenv", "HOME") < Can also be used as a |method|, the base is passed as the - third argument: > + third argument: >vim GetValue()->libcall("libc.so", "getenv") < libcallnr({libname}, {funcname}, {argument}) *libcallnr()* Just like |libcall()|, but used for a function that returns an int instead of a string. - Examples: > - :echo libcallnr("/usr/lib/libc.so", "getpid", "") - :call libcallnr("libc.so", "printf", "Hello World!\n") - :call libcallnr("libc.so", "sleep", 10) + Examples: >vim + echo libcallnr("/usr/lib/libc.so", "getpid", "") + call libcallnr("libc.so", "printf", "Hello World!\n") + call libcallnr("libc.so", "sleep", 10) < Can also be used as a |method|, the base is passed as the - third argument: > + third argument: >vim GetValue()->libcallnr("libc.so", "printf") < @@ -4437,17 +4562,18 @@ line({expr} [, {winid}]) *line()* With the optional {winid} argument the values are obtained for that window instead of the current window. Returns 0 for invalid values of {expr} and {winid}. - Examples: > - line(".") line number of the cursor - line(".", winid) idem, in window "winid" - line("'t") line number of mark t - line("'" .. marker) line number of mark marker + Examples: >vim + echo line(".") " line number of the cursor + echo line(".", winid) " idem, in window "winid" + echo line("'t") " line number of mark t + echo line("'" .. marker) " line number of mark marker < To jump to the last known position when opening a file see |last-position-jump|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetValue()->line() +< line2byte({lnum}) *line2byte()* Return the byte count from the start of the buffer for line @@ -4455,15 +4581,16 @@ line2byte({lnum}) *line2byte()* the 'fileformat' option for the current buffer. The first line returns 1. UTF-8 encoding is used, 'fileencoding' is ignored. This can also be used to get the byte count for the - line just below the last line: > - line2byte(line("$") + 1) + line just below the last line: >vim + echo line2byte(line("$") + 1) < This is the buffer size plus one. If 'fileencoding' is empty it is the file size plus one. {lnum} is used like with |getline()|. When {lnum} is invalid -1 is returned. Also see |byte2line()|, |go| and |:goto|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->line2byte() +< lispindent({lnum}) *lispindent()* Get the amount of indent for line {lnum} according the lisp @@ -4472,40 +4599,43 @@ lispindent({lnum}) *lispindent()* relevant. {lnum} is used just like in |getline()|. When {lnum} is invalid, -1 is returned. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->lispindent() +< list2blob({list}) *list2blob()* Return a Blob concatenating all the number values in {list}. - Examples: > - list2blob([1, 2, 3, 4]) returns 0z01020304 - list2blob([]) returns 0z + Examples: >vim + echo list2blob([1, 2, 3, 4]) " returns 0z01020304 + echo list2blob([]) " returns 0z < Returns an empty Blob on error. If one of the numbers is negative or more than 255 error *E1239* is given. |blob2list()| does the opposite. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetList()->list2blob() +< list2str({list} [, {utf8}]) *list2str()* Convert each number in {list} to a character string can - concatenate them all. Examples: > - list2str([32]) returns " " - list2str([65, 66, 67]) returns "ABC" -< The same can be done (slowly) with: > - join(map(list, {nr, val -> nr2char(val)}), '') + concatenate them all. Examples: >vim + echo list2str([32]) " returns " " + echo list2str([65, 66, 67]) " returns "ABC" +< The same can be done (slowly) with: >vim + echo join(map(list, {nr, val -> nr2char(val)}), '') < |str2list()| does the opposite. UTF-8 encoding is always used, {utf8} option has no effect, and exists only for backwards-compatibility. - With UTF-8 composing characters work as expected: > - list2str([97, 769]) returns "aΜ" + With UTF-8 composing characters work as expected: >vim + echo list2str([97, 769]) " returns "aΜ" < Returns an empty string on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetList()->list2str() +< localtime() *localtime()* Return the current time, measured as seconds since 1st Jan @@ -4516,33 +4646,35 @@ log({expr}) *log()* {expr} must evaluate to a |Float| or a |Number| in the range (0, inf]. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo log(10) -< 2.302585 > - :echo log(exp(5)) + Examples: >vim + echo log(10) +< 2.302585 >vim + echo log(exp(5)) < 5.0 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->log() +< log10({expr}) *log10()* Return the logarithm of Float {expr} to base 10 as a |Float|. {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo log10(1000) -< 3.0 > - :echo log10(0.01) + Examples: >vim + echo log10(1000) +< 3.0 >vim + echo log10(0.01) < -2.0 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->log10() +< luaeval({expr} [, {expr}]) *luaeval()* Evaluate Lua expression {expr} and return its result converted to Vim data structures. See |lua-eval| for more details. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetExpr()->luaeval() < @@ -4558,8 +4690,8 @@ map({expr1}, {expr2}) *map()* of the current item and for a |List| |v:key| has the index of the current item. For a |Blob| |v:key| has the index of the current byte. - Example: > - :call map(mylist, '"> " .. v:val .. " <"') + Example: >vim + call map(mylist, '"> " .. v:val .. " <"') < This puts "> " before and " <" after each item in "mylist". Note that {expr2} is the result of an expression and is then @@ -4571,21 +4703,21 @@ map({expr1}, {expr2}) *map()* 1. The key or the index of the current item. 2. the value of the current item. The function must return the new value of the item. Example - that changes each value by "key-value": > + that changes each value by "key-value": >vim func KeyValue(key, val) return a:key .. '-' .. a:val endfunc call map(myDict, function('KeyValue')) -< It is shorter when using a |lambda|: > +< It is shorter when using a |lambda|: >vim call map(myDict, {key, val -> key .. '-' .. val}) -< If you do not use "val" you can leave it out: > +< If you do not use "val" you can leave it out: >vim call map(myDict, {key -> 'item: ' .. key}) -< If you do not use "key" you can use a short name: > +< If you do not use "key" you can use a short name: >vim call map(myDict, {_, val -> 'item: ' .. val}) < The operation is done in-place. If you want a |List| or - |Dictionary| to remain unmodified make a copy first: > - :let tlist = map(copy(mylist), ' v:val .. "\t"') + |Dictionary| to remain unmodified make a copy first: >vim + let tlist = map(copy(mylist), ' v:val .. "\t"') < Returns {expr1}, the |List|, |Blob| or |Dictionary| that was filtered. When an error is encountered while evaluating @@ -4593,7 +4725,7 @@ map({expr1}, {expr2}) *map()* {expr2} is a Funcref errors inside a function are ignored, unless it was defined with the "abort" flag. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->map(expr2) < @@ -4658,11 +4790,12 @@ maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()* The mappings local to the current buffer are checked first, then the global mappings. This function can be used to map a key even when it's already - mapped, and have it do the original mapping too. Sketch: > + mapped, and have it do the original mapping too. Sketch: >vim exe 'nnoremap <Tab> ==' .. maparg('<Tab>', 'n') -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetKey()->maparg('n') +< mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()* Check if there is a mapping that matches with {name} in mode @@ -4690,15 +4823,16 @@ mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()* The mappings local to the current buffer are checked first, then the global mappings. This function can be used to check if a mapping can be added - without being ambiguous. Example: > - :if mapcheck("_vv") == "" - : map _vv :set guifont=7x13<CR> - :endif + without being ambiguous. Example: >vim + if mapcheck("_vv") == "" + map _vv :set guifont=7x13<CR> + endif < This avoids adding the "_vv" mapping when there already is a mapping for "_v" or for "_vvv". - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetKey()->mapcheck('n') +< mapset({mode}, {abbr}, {dict}) *mapset()* Restore a mapping from a dictionary returned by |maparg()|. @@ -4706,10 +4840,10 @@ mapset({mode}, {abbr}, {dict}) *mapset()* |maparg()|. *E460* {mode} is used to define the mode in which the mapping is set, not the "mode" entry in {dict}. - Example for saving and restoring a mapping: > + Example for saving and restoring a mapping: >vim let save_map = maparg('K', 'n', 0, 1) nnoremap K somethingelse - ... + " ... call mapset('n', 0, save_map) < Note that if you are going to replace a map in several modes, e.g. with `:map!`, you need to save the mapping for all of @@ -4728,27 +4862,27 @@ match({expr}, {pat} [, {start} [, {count}]]) *match()* If there is no match -1 is returned. For getting submatches see |matchlist()|. - Example: > - :echo match("testing", "ing") " results in 4 - :echo match([1, 'x'], '\a') " results in 1 + Example: >vim + echo match("testing", "ing") " results in 4 + echo match([1, 'x'], '\a') " results in 1 < See |string-match| for how {pat} is used. *strpbrk()* - Vim doesn't have a strpbrk() function. But you can do: > - :let sepidx = match(line, '[.,;: \t]') + Vim doesn't have a strpbrk() function. But you can do: >vim + let sepidx = match(line, '[.,;: \t]') < *strcasestr()* Vim doesn't have a strcasestr() function. But you can add - "\c" to the pattern to ignore case: > - :let idx = match(haystack, '\cneedle') + "\c" to the pattern to ignore case: >vim + let idx = match(haystack, '\cneedle') < If {start} is given, the search starts from byte index {start} in a String or item {start} in a |List|. The result, however, is still the index counted from the - first character/item. Example: > - :echo match("testing", "ing", 2) -< result is again "4". > - :echo match("testing", "ing", 4) -< result is again "4". > - :echo match("testing", "t", 2) + first character/item. Example: >vim + echo match("testing", "ing", 2) +< result is again "4". >vim + echo match("testing", "ing", 4) +< result is again "4". >vim + echo match("testing", "t", 2) < result is "3". For a String, if {start} > 0 then it is like the string starts {start} bytes later, thus "^" will match at {start}. Except @@ -4762,7 +4896,7 @@ match({expr}, {pat} [, {start} [, {count}]]) *match()* When {count} is given use the {count}th match. When a match is found in a String the search for the next one starts one - character further. Thus this example results in 1: > + character further. Thus this example results in 1: >vim echo match("testing", "..", 0, 2) < In a |List| the search continues in the next item. Note that when {count} is added the way {start} works changes, @@ -4777,7 +4911,7 @@ match({expr}, {pat} [, {start} [, {count}]]) *match()* zero matches at the start instead of a number of matches further down in the text. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->match('word') GetList()->match('word') < @@ -4831,17 +4965,17 @@ matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]]) Returns -1 on error. - Example: > - :highlight MyGroup ctermbg=green guibg=green - :let m = matchadd("MyGroup", "TODO") -< Deletion of the pattern: > - :call matchdelete(m) + Example: >vim + highlight MyGroup ctermbg=green guibg=green + let m = matchadd("MyGroup", "TODO") +< Deletion of the pattern: >vim + call matchdelete(m) < A list of matches defined by |matchadd()| and |:match| are available from |getmatches()|. All matches can be deleted in one operation by |clearmatches()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetGroup()->matchadd('TODO') < @@ -4873,17 +5007,18 @@ matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) *matchaddpos()* Returns -1 on error. - Example: > - :highlight MyGroup ctermbg=green guibg=green - :let m = matchaddpos("MyGroup", [[23, 24], 34]) -< Deletion of the pattern: > - :call matchdelete(m) + Example: >vim + highlight MyGroup ctermbg=green guibg=green + let m = matchaddpos("MyGroup", [[23, 24], 34]) +< Deletion of the pattern: >vim + call matchdelete(m) < Matches added by |matchaddpos()| are returned by |getmatches()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetGroup()->matchaddpos([23, 11]) +< matcharg({nr}) *matcharg()* Selects the {nr} match item, as set with a |:match|, @@ -4897,8 +5032,9 @@ matcharg({nr}) *matcharg()* Highlighting matches using the |:match| commands are limited to three matches. |matchadd()| does not have this limitation. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetMatch()->matcharg() +< matchdelete({id} [, {win}]) *matchdelete()* *E802* *E803* Deletes a match with ID {id} previously defined by |matchadd()| @@ -4908,30 +5044,32 @@ matchdelete({id} [, {win}]) *matchdelete()* *E802* *E803* If {win} is specified, use the window with this number or window ID instead of the current window. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetMatch()->matchdelete() +< matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()* Same as |match()|, but return the index of first character - after the match. Example: > - :echo matchend("testing", "ing") + after the match. Example: >vim + echo matchend("testing", "ing") < results in "7". *strspn()* *strcspn()* Vim doesn't have a strspn() or strcspn() function, but you can - do it with matchend(): > - :let span = matchend(line, '[a-zA-Z]') - :let span = matchend(line, '[^a-zA-Z]') + do it with matchend(): >vim + let span = matchend(line, '[a-zA-Z]') + let span = matchend(line, '[^a-zA-Z]') < Except that -1 is returned when there are no matches. - The {start}, if given, has the same meaning as for |match()|. > - :echo matchend("testing", "ing", 2) -< results in "7". > - :echo matchend("testing", "ing", 5) + The {start}, if given, has the same meaning as for |match()|. >vim + echo matchend("testing", "ing", 2) +< results in "7". >vim + echo matchend("testing", "ing", 5) < result is "-1". When {expr} is a |List| the result is equal to |match()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->matchend('word') +< matchfuzzy({list}, {str} [, {dict}]) *matchfuzzy()* If {list} is a list of strings, then returns a |List| with all @@ -4974,25 +5112,25 @@ matchfuzzy({list}, {str} [, {dict}]) *matchfuzzy()* Refer to |fuzzy-matching| for more information about fuzzy matching strings. - Example: > - :echo matchfuzzy(["clay", "crow"], "cay") -< results in ["clay"]. > - :echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl") -< results in a list of buffer names fuzzy matching "ndl". > - :echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'}) + Example: >vim + echo matchfuzzy(["clay", "crow"], "cay") +< results in ["clay"]. >vim + echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl") +< results in a list of buffer names fuzzy matching "ndl". >vim + echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'}) < results in a list of buffer information dicts with buffer - names fuzzy matching "ndl". > - :echo getbufinfo()->matchfuzzy("spl", + names fuzzy matching "ndl". >vim + echo getbufinfo()->matchfuzzy("spl", \ {'text_cb' : {v -> v.name}}) < results in a list of buffer information dicts with buffer - names fuzzy matching "spl". > - :echo v:oldfiles->matchfuzzy("test") -< results in a list of file names fuzzy matching "test". > - :let l = readfile("buffer.c")->matchfuzzy("str") -< results in a list of lines in "buffer.c" fuzzy matching "str". > - :echo ['one two', 'two one']->matchfuzzy('two one') -< results in `['two one', 'one two']` . > - :echo ['one two', 'two one']->matchfuzzy('two one', + names fuzzy matching "spl". >vim + echo v:oldfiles->matchfuzzy("test") +< results in a list of file names fuzzy matching "test". >vim + let l = readfile("buffer.c")->matchfuzzy("str") +< results in a list of lines in "buffer.c" fuzzy matching "str". >vim + echo ['one two', 'two one']->matchfuzzy('two one') +< results in `['two one', 'one two']` . >vim + echo ['one two', 'two one']->matchfuzzy('two one', \ {'matchseq': 1}) < results in `['two one']`. @@ -5009,12 +5147,12 @@ matchfuzzypos({list}, {str} [, {dict}]) *matchfuzzypos()* If there are no matching strings or there is an error, then a list with three empty list items is returned. - Example: > - :echo matchfuzzypos(['testing'], 'tsg') -< results in [["testing"], [[0, 2, 6]], [99]] > - :echo matchfuzzypos(['clay', 'lacy'], 'la') -< results in [["lacy", "clay"], [[0, 1], [1, 2]], [153, 133]] > - :echo [{'text': 'hello', 'id' : 10}] + Example: >vim + echo matchfuzzypos(['testing'], 'tsg') +< results in [["testing"], [[0, 2, 6]], [99]] >vim + echo matchfuzzypos(['clay', 'lacy'], 'la') +< results in [["lacy", "clay"], [[0, 1], [1, 2]], [153, 133]] >vim + echo [{'text': 'hello', 'id' : 10}] \ ->matchfuzzypos('ll', {'key' : 'text'}) < results in `[[{"id": 10, "text": "hello"}], [[2, 3]], [127]]` @@ -5023,56 +5161,58 @@ matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()* list is the matched string, same as what matchstr() would return. Following items are submatches, like "\1", "\2", etc. in |:substitute|. When an optional submatch didn't match an - empty string is used. Example: > + empty string is used. Example: >vim echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)') < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] When there is no match an empty list is returned. You can pass in a List, but that is not very useful. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->matchlist('word') +< matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()* - Same as |match()|, but return the matched string. Example: > - :echo matchstr("testing", "ing") + Same as |match()|, but return the matched string. Example: >vim + echo matchstr("testing", "ing") < results in "ing". When there is no match "" is returned. - The {start}, if given, has the same meaning as for |match()|. > - :echo matchstr("testing", "ing", 2) -< results in "ing". > - :echo matchstr("testing", "ing", 5) + The {start}, if given, has the same meaning as for |match()|. >vim + echo matchstr("testing", "ing", 2) +< results in "ing". >vim + echo matchstr("testing", "ing", 5) < result is "". When {expr} is a |List| then the matching item is returned. The type isn't changed, it's not necessarily a String. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->matchstr('word') +< matchstrpos({expr}, {pat} [, {start} [, {count}]]) *matchstrpos()* Same as |matchstr()|, but return the matched string, the start - position and the end position of the match. Example: > - :echo matchstrpos("testing", "ing") + position and the end position of the match. Example: >vim + echo matchstrpos("testing", "ing") < results in ["ing", 4, 7]. When there is no match ["", -1, -1] is returned. - The {start}, if given, has the same meaning as for |match()|. > - :echo matchstrpos("testing", "ing", 2) -< results in ["ing", 4, 7]. > - :echo matchstrpos("testing", "ing", 5) + The {start}, if given, has the same meaning as for |match()|. >vim + echo matchstrpos("testing", "ing", 2) +< results in ["ing", 4, 7]. >vim + echo matchstrpos("testing", "ing", 5) < result is ["", -1, -1]. When {expr} is a |List| then the matching item, the index of first item where {pat} matches, the start position and the - end position of the match are returned. > - :echo matchstrpos([1, '__x'], '\a') + end position of the match are returned. >vim + echo matchstrpos([1, '__x'], '\a') < result is ["x", 1, 2, 3]. The type isn't changed, it's not necessarily a String. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->matchstrpos('word') < max({expr}) *max()* - Return the maximum value of all items in {expr}. Example: > + Return the maximum value of all items in {expr}. Example: >vim echo max([apples, pears, oranges]) < {expr} can be a |List| or a |Dictionary|. For a Dictionary, @@ -5081,7 +5221,7 @@ max({expr}) *max()* items in {expr} cannot be used as a Number this results in an error. An empty |List| or |Dictionary| results in zero. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->max() < @@ -5090,14 +5230,14 @@ menu_get({path} [, {modes}]) *menu_get()* by |:menu|, |:amenu|, β¦), including |hidden-menus|. {path} matches a menu by name, or all menus if {path} is an - empty string. Example: > - :echo menu_get('File','') - :echo menu_get('') + empty string. Example: >vim + echo menu_get('File','') + echo menu_get('') < {modes} is a string of zero or more modes (see |maparg()| or |creating-menus| for the list of modes). "a" means "all". - Example: > + Example: >vim nnoremenu &Test.Test inormal inoremenu Test.Test insert vnoremenu Test.Test x @@ -5183,9 +5323,9 @@ menu_info({name} [, {mode}]) *menu_info()* Returns an empty dictionary if the menu item is not found. - Examples: > - :echo menu_info('Edit.Cut') - :echo menu_info('File.Save', 'n') + Examples: >vim + echo menu_info('Edit.Cut') + echo menu_info('File.Save', 'n') " Display the entire menu hierarchy in a buffer func ShowMenu(name, pfx) @@ -5201,12 +5341,12 @@ menu_info({name} [, {mode}]) *menu_info()* call ShowMenu(topmenu, '') endfor < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetMenuName()->menu_info('v') < min({expr}) *min()* - Return the minimum value of all items in {expr}. Example: > + Return the minimum value of all items in {expr}. Example: >vim echo min([apples, pears, oranges]) < {expr} can be a |List| or a |Dictionary|. For a Dictionary, @@ -5215,7 +5355,7 @@ min({expr}) *min()* items in {expr} cannot be used as a Number this results in an error. An empty |List| or |Dictionary| results in zero. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->min() < @@ -5229,19 +5369,19 @@ mkdir({name} [, {flags} [, {prot}]]) *mkdir()* *E739* created as necessary. If {flags} contains "D" then {name} is deleted at the end of - the current function, as with: > + the current function, as with: >vim defer delete({name}, 'd') < If {flags} contains "R" then {name} is deleted recursively at - the end of the current function, as with: > + the end of the current function, as with: >vim defer delete({name}, 'rf') < Note that when {name} has more than one part and "p" is used some directories may already exist. Only the first one that is created and what it contains is scheduled to be deleted. - E.g. when using: > + E.g. when using: >vim call mkdir('subdir/tmp/autoload', 'pR') < and "subdir" already exists then "subdir/tmp" will be - scheduled for deletion, like with: > + scheduled for deletion, like with: >vim defer delete('subdir/tmp', 'rf') < If {prot} is given it is used to set the protection bits of @@ -5250,8 +5390,8 @@ mkdir({name} [, {flags} [, {prot}]]) *mkdir()* *E739* unreadable for others. {prot} is applied for all parts of {name}. Thus if you create - /tmp/foo/bar then /tmp/foo will be created with 0o700. Example: > - :call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700) + /tmp/foo/bar then /tmp/foo will be created with 0o700. Example: >vim + call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700) < This function is not available in the |sandbox|. @@ -5262,7 +5402,7 @@ mkdir({name} [, {flags} [, {prot}]]) *mkdir()* *E739* successful or FALSE if the directory creation failed or partly failed. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->mkdir() < @@ -5317,15 +5457,16 @@ mode([expr]) *mode()* the leading character(s). Also see |visualmode()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim DoFull()->mode() +< msgpackdump({list} [, {type}]) *msgpackdump()* Convert a list of Vimscript objects to msgpack. Returned value is a |readfile()|-style list. When {type} contains "B", a |Blob| is - returned instead. Example: > + returned instead. Example: >vim call writefile(msgpackdump([{}]), 'fname.mpack', 'b') -< or, using a |Blob|: > +< or, using a |Blob|: >vim call writefile(msgpackdump([{}], 'B'), 'fname.mpack') < This will write the single 0x80 byte to a `fname.mpack` file @@ -5342,7 +5483,7 @@ msgpackdump({list} [, {type}]) *msgpackdump()* msgpackparse({data}) *msgpackparse()* Convert a |readfile()|-style list or a |Blob| to a list of Vimscript objects. - Example: > + Example: >vim let fname = expand('~/.config/nvim/shada/main.shada') let mpack = readfile(fname, 'b') let shada_objects = msgpackparse(mpack) @@ -5415,31 +5556,33 @@ msgpackparse({data}) *msgpackparse()* nextnonblank({lnum}) *nextnonblank()* Return the line number of the first line at or below {lnum} - that is not blank. Example: > - if getline(nextnonblank(1)) =~ "Java" + that is not blank. Example: >vim + if getline(nextnonblank(1)) =~ "Java" | endif < When {lnum} is invalid or there is no non-blank line at or below it, zero is returned. {lnum} is used like with |getline()|. See also |prevnonblank()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->nextnonblank() +< nr2char({expr} [, {utf8}]) *nr2char()* Return a string with a single character, which has the number - value {expr}. Examples: > - nr2char(64) returns "@" - nr2char(32) returns " " -< Example for "utf-8": > - nr2char(300) returns I with bow character - <UTF-8 encoding is always used, {utf8} option has no effect, + value {expr}. Examples: >vim + echo nr2char(64) " returns '@' + echo nr2char(32) " returns ' ' +< Example for "utf-8": >vim + echo nr2char(300) " returns I with bow character +< + UTF-8 encoding is always used, {utf8} option has no effect, and exists only for backwards-compatibility. Note that a NUL character in the file is specified with nr2char(10), because NULs are represented with newline characters. nr2char(0) is a real NUL and terminates the string, thus results in an empty string. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetNumber()->nr2char() < @@ -5458,10 +5601,10 @@ or({expr}, {expr}) *or()* Bitwise OR on the two arguments. The arguments are converted to a number. A List, Dict or Float argument causes an error. Also see `and()` and `xor()`. - Example: > - :let bits = or(bits, 0x80) -< Can also be used as a |method|: > - :let bits = bits->or(0x80) + Example: >vim + let bits = or(bits, 0x80) +< Can also be used as a |method|: >vim + let bits = bits->or(0x80) < Rationale: The reason this is a function and not using the "|" character like many languages, is that Vi has always used "|" @@ -5473,17 +5616,18 @@ pathshorten({path} [, {len}]) *pathshorten()* result. The tail, the file name, is kept as-is. The other components in the path are reduced to {len} letters in length. If {len} is omitted or smaller than 1 then 1 is used (single - letters). Leading '~' and '.' characters are kept. Examples: > - :echo pathshorten('~/.config/nvim/autoload/file1.vim') + letters). Leading '~' and '.' characters are kept. Examples: >vim + echo pathshorten('~/.config/nvim/autoload/file1.vim') < ~/.c/n/a/file1.vim ~ - > - :echo pathshorten('~/.config/nvim/autoload/file2.vim', 2) + >vim + echo pathshorten('~/.config/nvim/autoload/file2.vim', 2) < ~/.co/nv/au/file2.vim ~ It doesn't matter if the path exists or not. Returns an empty string on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetDirectories()->pathshorten() +< perleval({expr}) *perleval()* Evaluate |perl| expression {expr} and return its result @@ -5496,49 +5640,52 @@ perleval({expr}) *perleval()* Note: If you want an array or hash, {expr} must return a reference to it. - Example: > - :echo perleval('[1 .. 4]') + Example: >vim + echo perleval('[1 .. 4]') < [1, 2, 3, 4] - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetExpr()->perleval() +< pow({x}, {y}) *pow()* Return the power of {x} to the exponent {y} as a |Float|. {x} and {y} must evaluate to a |Float| or a |Number|. Returns 0.0 if {x} or {y} is not a |Float| or a |Number|. - Examples: > - :echo pow(3, 3) -< 27.0 > - :echo pow(2, 16) -< 65536.0 > - :echo pow(32, 0.20) + Examples: >vim + echo pow(3, 3) +< 27.0 >vim + echo pow(2, 16) +< 65536.0 >vim + echo pow(32, 0.20) < 2.0 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->pow(3) +< prevnonblank({lnum}) *prevnonblank()* Return the line number of the first line at or above {lnum} - that is not blank. Example: > + that is not blank. Example: >vim let ind = indent(prevnonblank(v:lnum - 1)) < When {lnum} is invalid or there is no non-blank line at or above it, zero is returned. {lnum} is used like with |getline()|. Also see |nextnonblank()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetLnum()->prevnonblank() +< printf({fmt}, {expr1} ...) *printf()* Return a String with {fmt}, where "%" items are replaced by - the formatted form of their respective arguments. Example: > - printf("%4d: E%d %.30s", lnum, errno, msg) + the formatted form of their respective arguments. Example: >vim + echo printf("%4d: E%d %.30s", lnum, errno, msg) < May result in: " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~ When used as a |method| the base is passed as the second - argument: > + argument: >vim Compute()->printf("result: %d") < You can use `call()` to pass the items as a list. @@ -5638,8 +5785,8 @@ printf({fmt}, {expr1} ...) *printf()* Number argument supplies the field width or precision. A negative field width is treated as a left adjustment flag followed by a positive field width; a negative precision is - treated as though it were missing. Example: > - :echo printf("%d: %.*s", nr, width, line) + treated as though it were missing. Example: >vim + echo printf("%d: %.*s", nr, width, line) < This limits the length of the text used from "line" to "width" bytes. @@ -5694,7 +5841,7 @@ printf({fmt}, {expr1} ...) *printf()* (out of range or dividing by zero) results in "inf" or "-inf" with %f (INF or -INF with %F). "0.0 / 0.0" results in "nan" with %f (NAN with %F). - Example: > + Example: >vim echo printf("%.2f", 12.115) < 12.12 Note that roundoff depends on the system libraries. @@ -5737,8 +5884,9 @@ prompt_getprompt({buf}) *prompt_getprompt()* If the buffer doesn't exist or isn't a prompt buffer, an empty string is returned. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetBuffer()->prompt_getprompt() +< prompt_setcallback({buf}, {expr}) *prompt_setcallback()* Set prompt callback for buffer {buf} to {expr}. When {expr} @@ -5756,7 +5904,7 @@ prompt_setcallback({buf}, {expr}) *prompt_setcallback()* The callback is invoked with one argument, which is the text that was entered at the prompt. This can be an empty string if the user only typed Enter. - Example: > + Example: >vim func s:TextEntered(text) if a:text == 'exit' || a:text == 'quit' stopinsert @@ -5772,8 +5920,9 @@ prompt_setcallback({buf}, {expr}) *prompt_setcallback()* endfunc call prompt_setcallback(bufnr(), function('s:TextEntered')) -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetBuffer()->prompt_setcallback(callback) +< prompt_setinterrupt({buf}, {expr}) *prompt_setinterrupt()* Set a callback for buffer {buf} to {expr}. When {expr} is an @@ -5784,18 +5933,20 @@ prompt_setinterrupt({buf}, {expr}) *prompt_setinterrupt()* mode. Without setting a callback Vim will exit Insert mode, as in any buffer. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetBuffer()->prompt_setinterrupt(callback) +< prompt_setprompt({buf}, {text}) *prompt_setprompt()* Set prompt for buffer {buf} to {text}. You most likely want {text} to end in a space. The result is only visible if {buf} has 'buftype' set to - "prompt". Example: > + "prompt". Example: >vim call prompt_setprompt(bufnr(''), 'command: ') < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetBuffer()->prompt_setprompt('command: ') +< pum_getpos() *pum_getpos()* If the popup menu (see |ins-completion-menu|) is not visible, @@ -5826,7 +5977,7 @@ py3eval({expr}) *py3eval()* Dictionaries are represented as Vim |Dictionary| type with keys converted to strings. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetExpr()->py3eval() < @@ -5839,8 +5990,9 @@ pyeval({expr}) *pyeval()* *E858* *E859* Dictionaries are represented as Vim |Dictionary| type, non-string keys result in error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetExpr()->pyeval() +< pyxeval({expr}) *pyxeval()* Evaluate Python expression {expr} and return its result @@ -5848,7 +6000,7 @@ pyxeval({expr}) *pyxeval()* Uses Python 2 or 3, see |python_x| and 'pyxversion'. See also: |pyeval()|, |py3eval()| - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetExpr()->pyxeval() < @@ -5861,13 +6013,13 @@ rand([{expr}]) *rand()* and updated. Returns -1 if {expr} is invalid. - Examples: > - :echo rand() - :let seed = srand() - :echo rand(seed) - :echo rand(seed) % 16 " random number 0 - 15 + Examples: >vim + echo rand() + let seed = srand() + echo rand(seed) + echo rand(seed) % 16 " random number 0 - 15 < - Can also be used as a |method|: > + Can also be used as a |method|: >vim seed->rand() < @@ -5881,15 +6033,15 @@ range({expr} [, {max} [, {stride}]]) *range()* *E726* *E727* When the maximum is one before the start the result is an empty list. When the maximum is more than one before the start this is an error. - Examples: > - range(4) " [0, 1, 2, 3] - range(2, 4) " [2, 3, 4] - range(2, 9, 3) " [2, 5, 8] - range(2, -2, -1) " [2, 1, 0, -1, -2] - range(0) " [] - range(2, 0) " error! -< - Can also be used as a |method|: > + Examples: >vim + echo range(4) " [0, 1, 2, 3] + echo range(2, 4) " [2, 3, 4] + echo range(2, 9, 3) " [2, 5, 8] + echo range(2, -2, -1) " [2, 1, 0, -1, -2] + echo range(0) " [] + echo range(2, 0) " error! +< + Can also be used as a |method|: >vim GetExpr()->range() < @@ -5897,18 +6049,18 @@ readblob({fname} [, {offset} [, {size}]]) *readblob()* Read file {fname} in binary mode and return a |Blob|. If {offset} is specified, read the file from the specified offset. If it is a negative value, it is used as an offset - from the end of the file. E.g., to read the last 12 bytes: > - readblob('file.bin', -12) + from the end of the file. E.g., to read the last 12 bytes: >vim + echo readblob('file.bin', -12) < If {size} is specified, only the specified size will be read. - E.g. to read the first 100 bytes of a file: > - readblob('file.bin', 0, 100) + E.g. to read the first 100 bytes of a file: >vim + echo readblob('file.bin', 0, 100) < If {size} is -1 or omitted, the whole data starting from {offset} will be read. This can be also used to read the data from a character device on Unix when {size} is explicitly set. Only if the device supports seeking {offset} can be used. Otherwise it should be - zero. E.g. to read 10 bytes from a serial console: > - readblob('/dev/ttyS0', 0, 10) + zero. E.g. to read 10 bytes from a serial console: >vim + echo readblob('/dev/ttyS0', 0, 10) < When the file can't be opened an error message is given and the result is an empty |Blob|. When the offset is beyond the end of the file the result is an @@ -5932,12 +6084,12 @@ readdir({directory} [, {expr}]) *readdir()* to the list. Each time {expr} is evaluated |v:val| is set to the entry name. When {expr} is a function the name is passed as the argument. - For example, to get a list of files ending in ".txt": > - readdir(dirname, {n -> n =~ '.txt$'}) -< To skip hidden and backup files: > - readdir(dirname, {n -> n !~ '^\.\|\~$'}) + For example, to get a list of files ending in ".txt": >vim + echo readdir(dirname, {n -> n =~ '.txt$'}) +< To skip hidden and backup files: >vim + echo readdir(dirname, {n -> n !~ '^\.\|\~$'}) -< If you want to get a directory tree: > +< If you want to get a directory tree: >vim function! s:tree(dir) return {a:dir : map(readdir(a:dir), \ {_, x -> isdirectory(x) ? @@ -5947,7 +6099,7 @@ readdir({directory} [, {expr}]) *readdir()* < Returns an empty List on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetDirName()->readdir() < @@ -5967,10 +6119,10 @@ readfile({fname} [, {type} [, {max}]]) *readfile()* - Any UTF-8 byte order mark is removed from the text. When {max} is given this specifies the maximum number of lines to be read. Useful if you only want to check the first ten - lines of a file: > - :for line in readfile(fname, '', 10) - : if line =~ 'Date' | echo line | endif - :endfor + lines of a file: >vim + for line in readfile(fname, '', 10) + if line =~ 'Date' | echo line | endif + endfor < When {max} is negative -{max} lines from the end of the file are returned, or as many as there are. When {max} is zero the result is an empty list. @@ -5984,7 +6136,7 @@ readfile({fname} [, {type} [, {max}]]) *readfile()* the result is an empty list. Also see |writefile()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFileName()->readfile() < @@ -5999,13 +6151,14 @@ reduce({object}, {func} [, {initial}]) *reduce()* *E998* item. If {initial} is not given and {object} is empty no result can be computed, an E998 error is given. - Examples: > + Examples: >vim echo reduce([1, 3, 5], { acc, val -> acc + val }) echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a') echo reduce(0z1122, { acc, val -> 2 * acc + val }) < - Can also be used as a |method|: > + Can also be used as a |method|: >vim echo mylist->reduce({ acc, val -> acc + val }, 0) +< reg_executing() *reg_executing()* Returns the single letter name of the register being executed. @@ -6041,7 +6194,7 @@ reltime({start}, {end}) *reltime()* The {start} and {end} arguments must be values returned by reltime(). Returns zero on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetStart()->reltime() < Note: |localtime()| returns the current (non-relative) time. @@ -6057,25 +6210,26 @@ reltimefloat({time}) *reltimefloat()* Also see |profiling|. If there is an error an empty string is returned - Can also be used as a |method|: > + Can also be used as a |method|: >vim reltime(start)->reltimefloat() +< reltimestr({time}) *reltimestr()* Return a String that represents the time value of {time}. This is the number of seconds, a dot and the number of - microseconds. Example: > + microseconds. Example: >vim let start = reltime() call MyFunction() echo reltimestr(reltime(start)) < Note that overhead for the commands will be added to the time. Leading spaces are used to make the string align nicely. You - can use split() to remove it. > + can use split() to remove it. >vim echo split(reltimestr(reltime(start)))[0] < Also see |profiling|. If there is an error an empty string is returned - Can also be used as a |method|: > - reltime(start)->reltimestr() + Can also be used as a |method|: >vim + echo reltime(start)->reltimestr() < remove({list}, {idx}) @@ -6088,14 +6242,15 @@ remove({list}, {idx}, {end}) *remove()* points to an item before {idx} this is an error. See |list-index| for possible values of {idx} and {end}. Returns zero on error. - Example: > - :echo "last item: " .. remove(mylist, -1) - :call remove(mylist, 0, 9) + Example: >vim + echo "last item: " .. remove(mylist, -1) + call remove(mylist, 0, 9) < Use |delete()| to remove a file. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->remove(idx) +< remove({blob}, {idx}) remove({blob}, {idx}, {end}) @@ -6106,14 +6261,15 @@ remove({blob}, {idx}, {end}) byte as {end} a |Blob| with one byte is returned. When {end} points to a byte before {idx} this is an error. Returns zero on error. - Example: > - :echo "last byte: " .. remove(myblob, -1) - :call remove(mylist, 0, 9) + Example: >vim + echo "last byte: " .. remove(myblob, -1) + call remove(mylist, 0, 9) +< remove({dict}, {key}) Remove the entry from {dict} with key {key} and return it. - Example: > - :echo "removed " .. remove(dict, "one") + Example: >vim + echo "removed " .. remove(dict, "one") < If there is no {key} in {dict} this is an error. Returns zero on error. @@ -6125,20 +6281,21 @@ rename({from}, {to}) *rename()* NOTE: If {to} exists it is overwritten without warning. This function is not available in the |sandbox|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetOldName()->rename(newname) +< repeat({expr}, {count}) *repeat()* Repeat {expr} {count} times and return the concatenated - result. Example: > - :let separator = repeat('-', 80) + result. Example: >vim + let separator = repeat('-', 80) < When {count} is zero or negative the result is empty. When {expr} is a |List| or a |Blob| the result is {expr} - concatenated {count} times. Example: > - :let longlist = repeat(['a', 'b'], 3) + concatenated {count} times. Example: >vim + let longlist = repeat(['a', 'b'], 3) < Results in ['a', 'b', 'a', 'b', 'a', 'b']. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->repeat(count) < @@ -6155,7 +6312,7 @@ resolve({filename}) *resolve()* *E655* current directory (provided the result is still a relative path name) and also keeps a trailing path separator. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->resolve() < @@ -6164,10 +6321,11 @@ reverse({object}) *reverse()* {object} can be a |List| or a |Blob|. Returns {object}. Returns zero if {object} is not a List or a Blob. - If you want an object to remain unmodified make a copy first: > - :let revlist = reverse(copy(mylist)) -< Can also be used as a |method|: > + If you want an object to remain unmodified make a copy first: >vim + let revlist = reverse(copy(mylist)) +< Can also be used as a |method|: >vim mylist->reverse() +< round({expr}) *round()* Round off {expr} to the nearest integral value and return it @@ -6175,34 +6333,38 @@ round({expr}) *round()* values, then use the larger one (away from zero). {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > + Examples: >vim echo round(0.456) -< 0.0 > +< 0.0 >vim echo round(4.5) -< 5.0 > +< 5.0 >vim echo round(-4.5) < -5.0 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->round() +< rpcnotify({channel}, {event} [, {args}...]) *rpcnotify()* Sends {event} to {channel} via |RPC| and returns immediately. If {channel} is 0, the event is broadcast to all channels. - Example: > - :au VimLeave call rpcnotify(0, "leaving") + Example: >vim + au VimLeave call rpcnotify(0, "leaving") +< rpcrequest({channel}, {method} [, {args}...]) *rpcrequest()* Sends a request to {channel} to invoke {method} via |RPC| and blocks until a response is received. - Example: > - :let result = rpcrequest(rpc_chan, "func", 1, 2, 3) + Example: >vim + let result = rpcrequest(rpc_chan, "func", 1, 2, 3) +< rpcstart({prog} [, {argv}]) *rpcstart()* - Deprecated. Replace > - :let id = rpcstart('prog', ['arg1', 'arg2']) -< with > - :let id = jobstart(['prog', 'arg1', 'arg2'], {'rpc': v:true}) + Deprecated. Replace >vim + let id = rpcstart('prog', ['arg1', 'arg2']) +< with >vim + let id = jobstart(['prog', 'arg1', 'arg2'], {'rpc': v:true}) +< rubyeval({expr}) *rubyeval()* Evaluate Ruby expression {expr} and return its result @@ -6214,8 +6376,9 @@ rubyeval({expr}) *rubyeval()* Other objects are represented as strings resulted from their "Object#to_s" method. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetRubyExpr()->rubyeval() +< screenattr({row}, {col}) *screenattr()* Like |screenchar()|, but return the attribute. This is a rather @@ -6223,8 +6386,9 @@ screenattr({row}, {col}) *screenattr()* attribute at other positions. Returns -1 when row or col is out of range. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetRow()->screenattr(col) +< screenchar({row}, {col}) *screenchar()* The result is a Number, which is the character at position @@ -6236,8 +6400,9 @@ screenchar({row}, {col}) *screenchar()* This is mainly to be used for testing. Returns -1 when row or col is out of range. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetRow()->screenchar(col) +< screenchars({row}, {col}) *screenchars()* The result is a List of Numbers. The first number is the same @@ -6246,8 +6411,9 @@ screenchars({row}, {col}) *screenchars()* This is mainly to be used for testing. Returns an empty List when row or col is out of range. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetRow()->screenchars(col) +< screencol() *screencol()* The result is a Number, which is the current screen column of @@ -6258,7 +6424,7 @@ screencol() *screencol()* in a command (e.g. ":echo screencol()") it will return the column inside the command line, which is 1 when the command is executed. To get the cursor position in the file use one of - the following mappings: > + the following mappings: >vim nnoremap <expr> GG ":echom " .. screencol() .. "\n" nnoremap <silent> GG :echom screencol()<CR> noremap GG <Cmd>echom screencol()<Cr> @@ -6288,8 +6454,9 @@ screenpos({winid}, {lnum}, {col}) *screenpos()* first character is returned, {col} is not used. Returns an empty Dict if {winid} is invalid. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinid()->screenpos(lnum, col) +< screenrow() *screenrow()* The result is a Number, which is the current screen row of the @@ -6307,7 +6474,7 @@ screenstring({row}, {col}) *screenstring()* This is mainly to be used for testing. Returns an empty String when row or col is out of range. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetRow()->screenstring(col) < @@ -6352,7 +6519,7 @@ search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) *search()* When the {stopline} argument is given then the search stops after searching this line. This is useful to restrict the - search to a range of lines. Examples: > + search to a range of lines. Examples: >vim let match = search('(', 'b', line("w0")) let end = search('END', '', line("w$")) < When {stopline} is used and it is not zero this also implies @@ -6383,24 +6550,24 @@ search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) *search()* The cursor will be positioned at the match, unless the 'n' flag is used. - Example (goes over all files in the argument list): > - :let n = 1 - :while n <= argc() " loop over all files in arglist - : exe "argument " .. n - : " start at the last char in the file and wrap for the - : " first search to find match at start of file - : normal G$ - : let flags = "w" - : while search("foo", flags) > 0 - : s/foo/bar/g - : let flags = "W" - : endwhile - : update " write the file if modified - : let n = n + 1 - :endwhile -< - Example for using some flags: > - :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') + Example (goes over all files in the argument list): >vim + let n = 1 + while n <= argc() " loop over all files in arglist + exe "argument " .. n + " start at the last char in the file and wrap for the + " first search to find match at start of file + normal G$ + let flags = "w" + while search("foo", flags) > 0 + s/foo/bar/g + let flags = "W" + endwhile + update " write the file if modified + let n = n + 1 + endwhile +< + Example for using some flags: >vim + echo search('\<if\|\(else\)\|\(endif\)', 'ncpe') < This will search for the keywords "if", "else", and "endif" under or after the cursor. Because of the 'p' flag, it returns 1, 2, or 3 depending on which keyword is found, or 0 @@ -6412,8 +6579,9 @@ search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) *search()* without the 'e' flag if the cursor is on the "f" of "if". The 'n' flag tells the function not to move the cursor. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetPattern()->search() +< searchcount([{options}]) *searchcount()* Get or update the last search count, like what is displayed @@ -6440,7 +6608,7 @@ searchcount([{options}]) *searchcount()* this function with `recompute: 0` . This sometimes returns wrong information because |n| and |N|'s maximum count is 99. If it exceeded 99 the result must be max count + 1 (100). If - you want to get correct information, specify `recompute: 1`: > + you want to get correct information, specify `recompute: 1`: >vim " result == maxcount + 1 (100) when many matches let result = searchcount(#{recompute: 0}) @@ -6449,7 +6617,7 @@ searchcount([{options}]) *searchcount()* " to 1) let result = searchcount() < - The function is useful to add the count to 'statusline': > + The function is useful to add the count to 'statusline': >vim function! LastSearchCount() abort let result = searchcount(#{recompute: 0}) if empty(result) @@ -6478,7 +6646,7 @@ searchcount([{options}]) *searchcount()* " \ '%{v:hlsearch ? LastSearchCount() : ""}' < You can also update the search count, which can be useful in a - |CursorMoved| or |CursorMovedI| autocommand: > + |CursorMoved| or |CursorMovedI| autocommand: >vim autocmd CursorMoved,CursorMovedI * \ let s:searchcount_timer = timer_start( @@ -6492,7 +6660,7 @@ searchcount([{options}]) *searchcount()* endfunction < This can also be used to count matched texts with specified - pattern in the current buffer using "pattern": > + pattern in the current buffer using "pattern": >vim " Count '\<foo\>' in this buffer " (Note that it also updates search count) @@ -6516,7 +6684,7 @@ searchcount([{options}]) *searchcount()* and different with |@/|. this works as same as the below command is executed - before calling this function > + before calling this function >vim let @/ = pattern < (default: |@/|) timeout |Number| 0 or negative number is no @@ -6536,7 +6704,7 @@ searchcount([{options}]) *searchcount()* value. see |cursor()|, |getpos()| (default: cursor's position) - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetSearchOpts()->searchcount() < @@ -6553,12 +6721,12 @@ searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()* Moves the cursor to the found match. Returns zero for success, non-zero for failure. - Example: > + Example: >vim if searchdecl('myvar') == 0 echo getline('.') endif < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->searchdecl() < @@ -6578,8 +6746,8 @@ searchpair({start}, {middle}, {end} [, {flags} [, {skip} [, {stopline} [, {timeo must not contain \( \) pairs. Use of \%( \) is allowed. When {middle} is not empty, it is found when searching from either direction, but only when not in a nested start-end pair. A - typical use is: > - searchpair('\<if\>', '\<else\>', '\<endif\>') + typical use is: >vim + echo searchpair('\<if\>', '\<else\>', '\<endif\>') < By leaving {middle} empty the "else" is skipped. {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with @@ -6609,7 +6777,7 @@ searchpair({start}, {middle}, {end} [, {flags} [, {skip} [, {stopline} [, {timeo The search starts exactly at the cursor. A match with {start}, {middle} or {end} at the next character, in the - direction of searching, is the first one found. Example: > + direction of searching, is the first one found. Example: >vim if 1 if 2 endif 2 @@ -6625,9 +6793,9 @@ searchpair({start}, {middle}, {end} [, {flags} [, {skip} [, {stopline} [, {timeo that when the cursor is inside a match with the end it finds the matching start. - Example, to find the "endif" command in a Vim script: > + Example, to find the "endif" command in a Vim script: >vim - :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', + echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W', \ 'getline(".") =~ "^\\s*\""') < The cursor must be at or after the "if" for which a match is @@ -6636,15 +6804,15 @@ searchpair({start}, {middle}, {end} [, {flags} [, {skip} [, {stopline} [, {timeo catches comments at the start of a line, not after a command. Also, a word "en" or "if" halfway through a line is considered a match. - Another example, to search for the matching "{" of a "}": > + Another example, to search for the matching "{" of a "}": >vim - :echo searchpair('{', '', '}', 'bW') + echo searchpair('{', '', '}', 'bW') < This works when the cursor is at or before the "}" for which a match is to be found. To reject matches that syntax - highlighting recognized as strings: > + highlighting recognized as strings: >vim - :echo searchpair('{', '', '}', 'bW', + echo searchpair('{', '', '}', 'bW', \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"') < @@ -6654,9 +6822,9 @@ searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [, {stopline} [, {ti column position of the match. The first element of the |List| is the line number and the second element is the byte index of the column position of the match. If no match is found, - returns [0, 0]. > + returns [0, 0]. >vim - :let [lnum,col] = searchpairpos('{', '', '}', 'n') + let [lnum,col] = searchpairpos('{', '', '}', 'n') < See |match-parens| for a bigger and more useful example. @@ -6667,23 +6835,25 @@ searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) is the line number and the second element is the byte index of the column position of the match. If no match is found, returns [0, 0]. - Example: > - :let [lnum, col] = searchpos('mypattern', 'n') + Example: >vim + let [lnum, col] = searchpos('mypattern', 'n') < When the 'p' flag is given then there is an extra item with - the sub-pattern match number |search()-sub-match|. Example: > - :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') + the sub-pattern match number |search()-sub-match|. Example: >vim + let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np') < In this example "submatch" is 2 when a lowercase letter is found |/\l|, 3 when an uppercase letter is found |/\u|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetPattern()->searchpos() +< serverlist() *serverlist()* Returns a list of server addresses, or empty if all servers were stopped. |serverstart()| |serverstop()| - Example: > - :echo serverlist() + Example: >vim + echo serverlist() +< serverstart([{address}]) *serverstart()* Opens a socket or named pipe at {address} and listens for @@ -6698,24 +6868,26 @@ serverstart([{address}]) *serverstart()* assigns a random port). - Else {address} is the path to a named pipe (except on Windows). - If {address} has no slashes ("/") it is treated as the - "name" part of a generated path in this format: > + "name" part of a generated path in this format: >vim stdpath("run").."/{name}.{pid}.{counter}" -< - If {address} is omitted the name is "nvim". > - :echo serverstart() +< - If {address} is omitted the name is "nvim". >vim + echo serverstart() +< > => /tmp/nvim.bram/oknANW/nvim.15430.5 - -< Example bash command to list all Nvim servers: > +< + Example bash command to list all Nvim servers: >bash ls ${XDG_RUNTIME_DIR:-${TMPDIR}nvim.${USER}}/*/nvim.*.0 -< Example named pipe: > +< Example named pipe: >vim if has('win32') echo serverstart('\\.\pipe\nvim-pipe-1234') else echo serverstart('nvim.sock') endif < - Example TCP/IP address: > + Example TCP/IP address: >vim echo serverstart('::1:12345') +< serverstop({address}) *serverstop()* Closes the pipe or socket at {address}. @@ -6748,8 +6920,9 @@ setbufline({buf}, {lnum}, {text}) *setbufline()* error message is given. Can also be used as a |method|, the base is passed as the - third argument: > + third argument: >vim GetText()->setbufline(buf, lnum) +< setbufvar({buf}, {varname}, {val}) *setbufvar()* Set option or local variable {varname} in buffer {buf} to @@ -6760,13 +6933,13 @@ setbufvar({buf}, {varname}, {val}) *setbufvar()* For the use of {buf}, see |bufname()| above. The {varname} argument is a string. Note that the variable name without "b:" must be used. - Examples: > - :call setbufvar(1, "&mod", 1) - :call setbufvar("todo", "myvar", "foobar") + Examples: >vim + call setbufvar(1, "&mod", 1) + call setbufvar("todo", "myvar", "foobar") < This function is not available in the |sandbox|. Can also be used as a |method|, the base is passed as the - third argument: > + third argument: >vim GetValue()->setbufvar(buf, varname) < @@ -6774,7 +6947,7 @@ setcellwidths({list}) *setcellwidths()* Specify overrides for cell widths of character ranges. This tells Vim how wide characters are when displayed in the terminal, counted in screen cells. The values override - 'ambiwidth'. Example: > + 'ambiwidth'. Example: >vim call setcellwidths([ \ [0x111, 0x111, 1], \ [0x2194, 0x2199, 2], @@ -6795,7 +6968,7 @@ setcellwidths({list}) *setcellwidths()* If the new value causes 'fillchars' or 'listchars' to become invalid it is rejected and an error is given. - To clear the overrides pass an empty {list}: > + To clear the overrides pass an empty {list}: >vim call setcellwidths([]) < You can use the script $VIMRUNTIME/tools/emoji_list.vim to see @@ -6809,14 +6982,15 @@ setcharpos({expr}, {list}) *setcharpos()* character index instead of the byte index in the line. Example: - With the text "μ¬λ³΄μΈμ" in line 8: > + With the text "μ¬λ³΄μΈμ" in line 8: >vim call setcharpos('.', [0, 8, 4, 0]) -< positions the cursor on the fourth character 'μ'. > +< positions the cursor on the fourth character 'μ'. >vim call setpos('.', [0, 8, 4, 0]) < positions the cursor on the second character '보'. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetPosition()->setcharpos('.') +< setcharsearch({dict}) *setcharsearch()* Set the current character search information to {dict}, @@ -6832,14 +7006,15 @@ setcharsearch({dict}) *setcharsearch()* character search This can be useful to save/restore a user's character search - from a script: > - :let prevsearch = getcharsearch() - :" Perform a command which clobbers user's search - :call setcharsearch(prevsearch) + from a script: >vim + let prevsearch = getcharsearch() + " Perform a command which clobbers user's search + call setcharsearch(prevsearch) < Also see |getcharsearch()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim SavedSearch()->setcharsearch() +< setcmdline({str} [, {pos}]) *setcmdline()* Set the command line to {str} and set the cursor position to @@ -6848,8 +7023,9 @@ setcmdline({str} [, {pos}]) *setcmdline()* Returns 0 when successful, 1 when not editing the command line. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->setcmdline() +< setcmdpos({pos}) *setcmdpos()* Set the cursor position in the command line to byte position @@ -6866,8 +7042,9 @@ setcmdpos({pos}) *setcmdpos()* Returns 0 when successful, 1 when not editing the command line. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetPos()->setcmdpos() +< setcursorcharpos({lnum}, {col} [, {off}]) setcursorcharpos({list}) *setcursorcharpos()* @@ -6875,24 +7052,25 @@ setcursorcharpos({list}) *setcursorcharpos()* character index instead of the byte index in the line. Example: - With the text "μ¬λ³΄μΈμ" in line 4: > + With the text "μ¬λ³΄μΈμ" in line 4: >vim call setcursorcharpos(4, 3) -< positions the cursor on the third character 'μΈ'. > +< positions the cursor on the third character 'μΈ'. >vim call cursor(4, 3) < positions the cursor on the first character 'μ¬'. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetCursorPos()->setcursorcharpos() +< setenv({name}, {val}) *setenv()* - Set environment variable {name} to {val}. Example: > + Set environment variable {name} to {val}. Example: >vim call setenv('HOME', '/home/myhome') < When {val} is |v:null| the environment variable is deleted. See also |expr-env|. Can also be used as a |method|, the base is passed as the - second argument: > + second argument: >vim GetPath()->setenv('PATH') < @@ -6911,7 +7089,7 @@ setfperm({fname}, {mode}) *setfperm()* *chmod* Returns non-zero for success, zero for failure. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFilename()->setfperm(mode) < To read permissions see |getfperm()|. @@ -6930,22 +7108,23 @@ setline({lnum}, {text}) *setline()* If this succeeds, FALSE is returned. If this fails (most likely because {lnum} is invalid) TRUE is returned. - Example: > - :call setline(5, strftime("%c")) + Example: >vim + call setline(5, strftime("%c")) < When {text} is a |List| then line {lnum} and following lines - will be set to the items in the list. Example: > - :call setline(5, ['aaa', 'bbb', 'ccc']) -< This is equivalent to: > - :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] - : call setline(n, l) - :endfor + will be set to the items in the list. Example: >vim + call setline(5, ['aaa', 'bbb', 'ccc']) +< This is equivalent to: >vim + for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']] + call setline(n, l) + endfor < Note: The '[ and '] marks are not set. Can also be used as a |method|, the base is passed as the - second argument: > + second argument: >vim GetText()->setline(lnum) +< setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()* Create or replace or add to the location list for window {nr}. @@ -6964,8 +7143,9 @@ setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()* for the list of supported keys in {what}. Can also be used as a |method|, the base is passed as the - second argument: > + second argument: >vim GetLoclist()->setloclist(winnr) +< setmatches({list} [, {win}]) *setmatches()* Restores a list of matches saved by |getmatches()| for the @@ -6975,7 +7155,7 @@ setmatches({list} [, {win}]) *setmatches()* If {win} is specified, use the window with this number or window ID instead of the current window. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetMatches()->setmatches() < @@ -7028,8 +7208,9 @@ setpos({expr}, {list}) *setpos()* also set the preferred column. Also see the "curswant" key in |winrestview()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetPosition()->setpos('.') +< setqflist({list} [, {action} [, {what}]]) *setqflist()* Create or replace or add to the quickfix list. @@ -7084,8 +7265,8 @@ setqflist({list} [, {action} [, {what}]]) *setqflist()* 'r' The items from the current quickfix list are replaced with the items from {list}. This can also be used to - clear the list: > - :call setqflist([], 'r') + clear the list: >vim + call setqflist([], 'r') < 'f' All the quickfix lists in the quickfix stack are freed. @@ -7131,10 +7312,10 @@ setqflist({list} [, {action} [, {what}]]) *setqflist()* list is modified, "id" should be used instead of "nr" to specify the list. - Examples (See also |setqflist-examples|): > - :call setqflist([], 'r', {'title': 'My search'}) - :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'}) - :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]}) + Examples (See also |setqflist-examples|): >vim + call setqflist([], 'r', {'title': 'My search'}) + call setqflist([], 'r', {'nr': 2, 'title': 'Errors'}) + call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]}) < Returns zero for success, -1 for failure. @@ -7143,7 +7324,7 @@ setqflist({list} [, {action} [, {what}]]) *setqflist()* `:cc 1` to jump to the first position. Can also be used as a |method|, the base is passed as the - second argument: > + second argument: >vim GetErrorlist()->setqflist() < @@ -7179,33 +7360,34 @@ setreg({regname}, {value} [, {options}]) *setreg()* set search and expression registers. Lists containing no items act like empty strings. - Examples: > - :call setreg(v:register, @*) - :call setreg('*', @%, 'ac') - :call setreg('a', "1\n2\n3", 'b5') - :call setreg('"', { 'points_to': 'a'}) + Examples: >vim + call setreg(v:register, @*) + call setreg('*', @%, 'ac') + call setreg('a', "1\n2\n3", 'b5') + call setreg('"', { 'points_to': 'a'}) < This example shows using the functions to save and restore a - register: > - :let var_a = getreginfo() - :call setreg('a', var_a) -< or: > - :let var_a = getreg('a', 1, 1) - :let var_amode = getregtype('a') - .... - :call setreg('a', var_a, var_amode) + register: >vim + let var_a = getreginfo() + call setreg('a', var_a) +< or: >vim + let var_a = getreg('a', 1, 1) + let var_amode = getregtype('a') + " .... + call setreg('a', var_a, var_amode) < Note: you may not reliably restore register value without using the third argument to |getreg()| as without it newlines are represented as newlines AND Nul bytes are represented as newlines as well, see |NL-used-for-Nul|. You can also change the type of a register by appending - nothing: > - :call setreg('a', '', 'al') + nothing: >vim + call setreg('a', '', 'al') < Can also be used as a |method|, the base is passed as the - second argument: > + second argument: >vim GetText()->setreg('a') +< settabvar({tabnr}, {varname}, {val}) *settabvar()* Set tab-local variable {varname} to {val} in tab page {tabnr}. @@ -7216,8 +7398,9 @@ settabvar({tabnr}, {varname}, {val}) *settabvar()* This function is not available in the |sandbox|. Can also be used as a |method|, the base is passed as the - third argument: > + third argument: >vim GetValue()->settabvar(tab, name) +< settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* Set option or local variable {varname} in window {winnr} to @@ -7230,14 +7413,15 @@ settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()* doesn't work for a global or local buffer variable. For a local buffer option the global value is unchanged. Note that the variable name without "w:" must be used. - Examples: > - :call settabwinvar(1, 1, "&list", 0) - :call settabwinvar(3, 2, "myvar", "foobar") + Examples: >vim + call settabwinvar(1, 1, "&list", 0) + call settabwinvar(3, 2, "myvar", "foobar") < This function is not available in the |sandbox|. Can also be used as a |method|, the base is passed as the - fourth argument: > + fourth argument: >vim GetValue()->settabwinvar(tab, winnr, name) +< settagstack({nr}, {dict} [, {action}]) *settagstack()* Modify the tag stack of the window {nr} using {dict}. @@ -7263,35 +7447,38 @@ settagstack({nr}, {dict} [, {action}]) *settagstack()* Returns zero for success, -1 for failure. Examples (for more examples see |tagstack-examples|): - Empty the tag stack of window 3: > + Empty the tag stack of window 3: >vim call settagstack(3, {'items' : []}) -< Save and restore the tag stack: > +< Save and restore the tag stack: >vim let stack = gettagstack(1003) " do something else call settagstack(1003, stack) unlet stack < Can also be used as a |method|, the base is passed as the - second argument: > + second argument: >vim GetStack()->settagstack(winnr) +< setwinvar({nr}, {varname}, {val}) *setwinvar()* Like |settabwinvar()| for the current tab page. - Examples: > - :call setwinvar(1, "&list", 0) - :call setwinvar(2, "myvar", "foobar") + Examples: >vim + call setwinvar(1, "&list", 0) + call setwinvar(2, "myvar", "foobar") < Can also be used as a |method|, the base is passed as the - third argument: > + third argument: >vim GetValue()->setwinvar(winnr, name) +< sha256({string}) *sha256()* Returns a String with 64 hex characters, which is the SHA256 checksum of {string}. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->sha256() +< shellescape({string} [, {special}]) *shellescape()* Escape {string} for use as a shell command argument. @@ -7317,21 +7504,22 @@ shellescape({string} [, {special}]) *shellescape()* be escaped because in fish it is used as an escape character inside single quotes. - Example of use with a |:!| command: > - :exe '!dir ' .. shellescape(expand('<cfile>'), 1) + Example of use with a |:!| command: >vim + exe '!dir ' .. shellescape(expand('<cfile>'), 1) < This results in a directory listing for the file under the - cursor. Example of use with |system()|: > - :call system("chmod +w -- " .. shellescape(expand("%"))) + cursor. Example of use with |system()|: >vim + call system("chmod +w -- " .. shellescape(expand("%"))) < See also |::S|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetCommand()->shellescape() +< shiftwidth([{col}]) *shiftwidth()* Returns the effective value of 'shiftwidth'. This is the 'shiftwidth' value unless it is zero, in which case it is the 'tabstop' value. To be backwards compatible in indent - plugins, use this: > + plugins, use this: >vim if exists('*shiftwidth') func s:sw() return shiftwidth() @@ -7348,10 +7536,9 @@ shiftwidth([{col}]) *shiftwidth()* 'vartabstop' feature. If no {col} argument is given, column 1 will be assumed. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetColumn()->shiftwidth() - - sign_ functions are documented here: |sign-functions-details| +< sign_define({name} [, {dict}]) sign_define({list}) *sign_define()* @@ -7387,7 +7574,7 @@ sign_define({list}) *sign_define()* {list} is used, then returns a List of values one for each defined sign. - Examples: > + Examples: >vim call sign_define("mySign", { \ "text" : "=>", \ "texthl" : "Error", @@ -7399,8 +7586,9 @@ sign_define({list}) *sign_define()* \ 'text' : '!!'} \ ]) < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetSignList()->sign_define() +< sign_getdefined([{name}]) *sign_getdefined()* Get a list of defined signs and their attributes. @@ -7430,15 +7618,16 @@ sign_getdefined([{name}]) *sign_getdefined()* Returns an empty List if there are no signs and when {name} is not found. - Examples: > + Examples: >vim " Get a list of all the defined signs echo sign_getdefined() " Get the attribute of the sign named mySign echo sign_getdefined("mySign") < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetSignList()->sign_getdefined() +< sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()* Return a list of signs placed in a buffer or all the buffers. @@ -7479,7 +7668,7 @@ sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()* Returns an empty list on failure or if there are no placed signs. - Examples: > + Examples: >vim " Get a List of signs placed in eval.c in the " global group echo sign_getplaced("eval.c") @@ -7500,7 +7689,7 @@ sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()* " Get a List of all the placed signs echo sign_getplaced() < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetBufname()->sign_getplaced() < @@ -7515,11 +7704,11 @@ sign_jump({id}, {group}, {buf}) *sign_jump()* Returns the line number of the sign. Returns -1 if the arguments are invalid. - Example: > + Example: >vim " Jump to sign 10 in the current buffer call sign_jump(10, '', '') < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetSignid()->sign_jump() < @@ -7552,7 +7741,7 @@ sign_place({id}, {group}, {name}, {buf} [, {dict}]) *sign_place()* Returns the sign identifier on success and -1 on failure. - Examples: > + Examples: >vim " Place a sign named sign1 with id 5 at line 20 in " buffer json.c call sign_place(5, '', 'sign1', 'json.c', @@ -7571,7 +7760,7 @@ sign_place({id}, {group}, {name}, {buf} [, {dict}]) *sign_place()* call sign_place(10, 'g3', 'sign4', 'json.c', \ {'lnum' : 40, 'priority' : 90}) < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetSignid()->sign_place(group, name, expr) < @@ -7608,7 +7797,7 @@ sign_placelist({list}) *sign_placelist()* Returns a List of sign identifiers. If failed to place a sign, the corresponding list item is set to -1. - Examples: > + Examples: >vim " Place sign s1 with id 5 at line 20 and id 10 at line " 30 in buffer a.c let [n1, n2] = sign_placelist([ @@ -7633,8 +7822,9 @@ sign_placelist({list}) *sign_placelist()* \ 'lnum' : 50} \ ]) < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetSignlist()->sign_placelist() +< sign_undefine([{name}]) sign_undefine({list}) *sign_undefine()* @@ -7649,7 +7839,7 @@ sign_undefine({list}) *sign_undefine()* {list} call, returns a list of values one for each undefined sign. - Examples: > + Examples: >vim " Delete a sign named mySign call sign_undefine("mySign") @@ -7659,8 +7849,9 @@ sign_undefine({list}) *sign_undefine()* " Delete all the signs call sign_undefine() < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetSignlist()->sign_undefine() +< sign_unplace({group} [, {dict}]) *sign_unplace()* Remove a previously placed sign in one or more buffers. This @@ -7679,7 +7870,7 @@ sign_unplace({group} [, {dict}]) *sign_unplace()* Returns 0 on success and -1 on failure. - Examples: > + Examples: >vim " Remove sign 10 from buffer a.vim call sign_unplace('', {'buffer' : "a.vim", 'id' : 10}) @@ -7704,7 +7895,7 @@ sign_unplace({group} [, {dict}]) *sign_unplace()* " Remove all the placed signs from all the buffers call sign_unplace('*') -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetSigngroup()->sign_unplace() < @@ -7728,7 +7919,7 @@ sign_unplacelist({list}) *sign_unplacelist()* Returns a List where an entry is set to 0 if the corresponding sign was successfully removed or -1 on failure. - Example: > + Example: >vim " Remove sign with id 10 from buffer a.vim and sign " with id 20 from buffer b.vim call sign_unplacelist([ @@ -7736,7 +7927,7 @@ sign_unplacelist({list}) *sign_unplacelist()* \ {'id' : 20, 'buffer' : 'b.vim'}, \ ]) < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetSignlist()->sign_unplacelist() < @@ -7749,7 +7940,7 @@ simplify({filename}) *simplify()* not removed either. On Unix "//path" is unchanged, but "///path" is simplified to "/path" (this follows the Posix standard). - Example: > + Example: >vim simplify("./dir/.././/file/") == "./file/" < Note: The combination "dir/.." is only removed if "dir" is a searchable directory or does not exist. On Unix, it is also @@ -7757,35 +7948,38 @@ simplify({filename}) *simplify()* directory. In order to resolve all the involved symbolic links before simplifying the path name, use |resolve()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetName()->simplify() +< sin({expr}) *sin()* Return the sine of {expr}, measured in radians, as a |Float|. {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo sin(100) -< -0.506366 > - :echo sin(-4.01) + Examples: >vim + echo sin(100) +< -0.506366 >vim + echo sin(-4.01) < 0.763301 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->sin() +< sinh({expr}) *sinh()* Return the hyperbolic sine of {expr} as a |Float| in the range [-inf, inf]. {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo sinh(0.5) -< 0.521095 > - :echo sinh(-0.9) + Examples: >vim + echo sinh(0.5) +< 0.521095 >vim + echo sinh(-0.9) < -1.026517 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->sinh() +< slice({expr}, {start} [, {end}]) *slice()* Similar to using a |slice| "expr[start : end]", but "end" is @@ -7796,7 +7990,7 @@ slice({expr}, {start} [, {end}]) *slice()* When {end} is -1 the last item is omitted. Returns an empty value if {start} or {end} are invalid. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetList()->slice(offset) < @@ -7828,8 +8022,8 @@ sockconnect({mode}, {address} [, {opts}]) *sockconnect()* sort({list} [, {func} [, {dict}]]) *sort()* *E702* Sort the items in {list} in-place. Returns {list}. - If you want a list to remain unmodified make a copy first: > - :let sortedlist = sort(copy(mylist)) + If you want a list to remain unmodified make a copy first: >vim + let sortedlist = sort(copy(mylist)) < When {func} is omitted, is empty or zero, then sort() uses the string representation of each item to sort on. Numbers sort @@ -7844,15 +8038,15 @@ sort({list} [, {func} [, {dict}]]) *sort()* *E702* is used to compare strings. See |:language| check or set the collation locale. |v:collate| can also be used to check the current locale. Sorting using the locale typically ignores - case. Example: > + case. Example: >vim " ΓΆ is sorted similarly to o with English locale. - :language collate en_US.UTF8 - :echo sort(['n', 'o', 'O', 'ΓΆ', 'p', 'z'], 'l') + language collate en_US.UTF8 + echo sort(['n', 'o', 'O', 'ΓΆ', 'p', 'z'], 'l') < ['n', 'o', 'O', 'ΓΆ', 'p', 'z'] ~ - > + >vim " ΓΆ is sorted after z with Swedish locale. - :language collate sv_SE.UTF8 - :echo sort(['n', 'o', 'O', 'ΓΆ', 'p', 'z'], 'l') + language collate sv_SE.UTF8 + echo sort(['n', 'o', 'O', 'ΓΆ', 'p', 'z'], 'l') < ['n', 'o', 'O', 'p', 'z', 'ΓΆ'] ~ This does not work properly on Mac. @@ -7882,22 +8076,22 @@ sort({list} [, {func} [, {dict}]]) *sort()* *E702* on numbers, text strings will sort next to each other, in the same order as they were originally. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->sort() < Also see |uniq()|. - Example: > + Example: >vim func MyCompare(i1, i2) return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1 endfunc eval mylist->sort("MyCompare") < A shorter compare version for this specific simple case, which - ignores overflow: > + ignores overflow: >vim func MyCompare(i1, i2) return a:i1 - a:i2 endfunc -< For a simple expression you can use a lambda: > +< For a simple expression you can use a lambda: >vim eval mylist->sort({i1, i2 -> i1 - i2}) < @@ -7909,7 +8103,7 @@ soundfold({word}) *soundfold()* This can be used for making spelling suggestions. Note that the method can be quite slow. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWord()->soundfold() < @@ -7930,14 +8124,14 @@ spellbadword([{sentence}]) *spellbadword()* "rare" rare word "local" word only valid in another region "caps" word should start with Capital - Example: > + Example: >vim echo spellbadword("the quik brown fox") < ['quik', 'bad'] ~ The spelling information for the current window and the value of 'spelllang' are used. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->spellbadword() < @@ -7962,8 +8156,9 @@ spellsuggest({word} [, {max} [, {capital}]]) *spellsuggest()* The spelling information for the current window is used. The values of 'spelllang' and 'spellsuggest' are used. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWord()->spellsuggest() +< split({string} [, {pattern} [, {keepempty}]]) *split()* Make a |List| out of {string}. When {pattern} is omitted or @@ -7976,20 +8171,23 @@ split({string} [, {pattern} [, {keepempty}]]) *split()* {keepempty} argument is given and it's non-zero. Other empty items are kept when {pattern} matches at least one character or when {keepempty} is non-zero. - Example: > - :let words = split(getline('.'), '\W\+') -< To split a string in individual characters: > - :for c in split(mystring, '\zs') + Example: >vim + let words = split(getline('.'), '\W\+') +< To split a string in individual characters: >vim + for c in split(mystring, '\zs') | endfor < If you want to keep the separator you can also use '\zs' at - the end of the pattern: > - :echo split('abc:def:ghi', ':\zs') -< ['abc:', 'def:', 'ghi'] ~ - Splitting a table where the first element can be empty: > - :let items = split(line, ':', 1) + the end of the pattern: >vim + echo split('abc:def:ghi', ':\zs') +< > + ['abc:', 'def:', 'ghi'] +< + Splitting a table where the first element can be empty: >vim + let items = split(line, ':', 1) < The opposite function is |join()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetString()->split() +< sqrt({expr}) *sqrt()* Return the non-negative square root of Float {expr} as a @@ -7997,15 +8195,16 @@ sqrt({expr}) *sqrt()* {expr} must evaluate to a |Float| or a |Number|. When {expr} is negative the result is NaN (Not a Number). Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo sqrt(100) -< 10.0 > - :echo sqrt(-4.01) + Examples: >vim + echo sqrt(100) +< 10.0 >vim + echo sqrt(-4.01) < str2float("nan") NaN may be different, it depends on system libraries. - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->sqrt() +< srand([{expr}]) *srand()* Initialize seed used by |rand()|: @@ -8016,13 +8215,14 @@ srand([{expr}]) *srand()* initialize the seed values. This is useful for testing or when a predictable sequence is intended. - Examples: > - :let seed = srand() - :let seed = srand(userinput) - :echo rand(seed) + Examples: >vim + let seed = srand() + let seed = srand(userinput) + echo rand(seed) < - Can also be used as a |method|: > + Can also be used as a |method|: >vim userinput->srand() +< stdioopen({opts}) *stdioopen()* With |--headless| this opens stdin and stdout as a |channel|. @@ -8063,8 +8263,8 @@ stdpath({what}) *stdpath()* *E6100* state String Session state directory: storage for file drafts, swap, undo, |shada|. - Example: > - :echo stdpath("config") + Example: >vim + echo stdpath("config") < str2float({string} [, {quoted}]) *str2float()* @@ -8081,28 +8281,30 @@ str2float({string} [, {quoted}]) *str2float()* The decimal point is always '.', no matter what the locale is set to. A comma ends the number: "12,345.67" is converted to 12.0. You can strip out thousands separators with - |substitute()|: > + |substitute()|: >vim let f = str2float(substitute(text, ',', '', 'g')) < Returns 0.0 if the conversion fails. - Can also be used as a |method|: > + Can also be used as a |method|: >vim let f = text->substitute(',', '', 'g')->str2float() +< str2list({string} [, {utf8}]) *str2list()* Return a list containing the number values which represent - each character in String {string}. Examples: > - str2list(" ") returns [32] - str2list("ABC") returns [65, 66, 67] + each character in String {string}. Examples: >vim + echo str2list(" ") " returns [32] + echo str2list("ABC") " returns [65, 66, 67] < |list2str()| does the opposite. UTF-8 encoding is always used, {utf8} option has no effect, and exists only for backwards-compatibility. - With UTF-8 composing characters are handled properly: > - str2list("aΜ") returns [97, 769] + With UTF-8 composing characters are handled properly: >vim + echo str2list("aΜ") " returns [97, 769] -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetString()->str2list() +< str2nr({string} [, {base}]) *str2nr()* Convert string {string} to a number. @@ -8112,7 +8314,7 @@ str2nr({string} [, {base}]) *str2nr()* When {base} is omitted base 10 is used. This also means that a leading zero doesn't cause octal conversion to be used, as - with the default String to Number conversion. Example: > + with the default String to Number conversion. Example: >vim let nr = str2nr('0123') < When {base} is 16 a leading "0x" or "0X" is ignored. With a @@ -8123,7 +8325,7 @@ str2nr({string} [, {base}]) *str2nr()* Returns 0 if {string} is empty or on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->str2nr() < @@ -8137,7 +8339,7 @@ strcharlen({string}) *strcharlen()* Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->strcharlen() < @@ -8150,13 +8352,13 @@ strcharpart({src}, {start} [, {len} [, {skipcc}]]) *strcharpart()* similar to |slice()|. When a character index is used where a character does not exist it is omitted and counted as one character. For - example: > - strcharpart('abc', -1, 2) + example: >vim + echo strcharpart('abc', -1, 2) < results in 'a'. Returns an empty string on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->strcharpart(5) < @@ -8173,7 +8375,7 @@ strchars({string} [, {skipcc}]) *strchars()* Also see |strlen()|, |strdisplaywidth()| and |strwidth()|. {skipcc} is only available after 7.4.755. For backward - compatibility, you can define a wrapper function: > + compatibility, you can define a wrapper function: >vim if has("patch-7.4.755") function s:strchars(str, skipcc) return strchars(a:str, a:skipcc) @@ -8188,8 +8390,9 @@ strchars({string} [, {skipcc}]) *strchars()* endfunction endif < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->strchars() +< strdisplaywidth({string} [, {col}]) *strdisplaywidth()* The result is a Number, which is the number of display cells @@ -8205,8 +8408,9 @@ strdisplaywidth({string} [, {col}]) *strdisplaywidth()* Returns zero on error. Also see |strlen()|, |strwidth()| and |strchars()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->strdisplaywidth() +< strftime({format} [, {time}]) *strftime()* The result is a String, which is a formatted date and time, as @@ -8217,16 +8421,17 @@ strftime({format} [, {time}]) *strftime()* format. The maximum length of the result is 80 characters. See also |localtime()|, |getftime()| and |strptime()|. The language can be changed with the |:language| command. - Examples: > - :echo strftime("%c") Sun Apr 27 11:49:23 1997 - :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25 - :echo strftime("%y%m%d %T") 970427 11:53:55 - :echo strftime("%H:%M") 11:55 - :echo strftime("%c", getftime("file.c")) - Show mod time of file.c. - -< Can also be used as a |method|: > + Examples: >vim + echo strftime("%c") " Sun Apr 27 11:49:23 1997 + echo strftime("%Y %b %d %X") " 1997 Apr 27 11:53:25 + echo strftime("%y%m%d %T") " 970427 11:53:55 + echo strftime("%H:%M") " 11:55 + echo strftime("%c", getftime("file.c")) + " Show mod time of file.c. + +< Can also be used as a |method|: >vim GetFormat()->strftime() +< strgetchar({str}, {index}) *strgetchar()* Get a Number corresponding to the character at {index} in @@ -8237,29 +8442,30 @@ strgetchar({str}, {index}) *strgetchar()* Returns -1 if {index} is invalid. Also see |strcharpart()| and |strchars()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->strgetchar(5) +< stridx({haystack}, {needle} [, {start}]) *stridx()* The result is a Number, which gives the byte index in {haystack} of the first occurrence of the String {needle}. If {start} is specified, the search starts at index {start}. - This can be used to find a second match: > - :let colon1 = stridx(line, ":") - :let colon2 = stridx(line, ":", colon1 + 1) + This can be used to find a second match: >vim + let colon1 = stridx(line, ":") + let colon2 = stridx(line, ":", colon1 + 1) < The search is done case-sensitive. For pattern searches use |match()|. -1 is returned if the {needle} does not occur in {haystack}. See also |strridx()|. - Examples: > - :echo stridx("An Example", "Example") 3 - :echo stridx("Starting point", "Start") 0 - :echo stridx("Starting point", "start") -1 + Examples: >vim + echo stridx("An Example", "Example") " 3 + echo stridx("Starting point", "Start") " 0 + echo stridx("Starting point", "start") " -1 < *strstr()* *strchr()* stridx() works similar to the C function strstr(). When used with a single character it works similar to strchr(). - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetHaystack()->stridx(needle) < @@ -8287,8 +8493,9 @@ string({expr}) *string()* method, use |msgpackdump()| or |json_encode()| if you need to share data with other application. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->string() +< strlen({string}) *strlen()* The result is a Number, which is the length of the String @@ -8299,8 +8506,9 @@ strlen({string}) *strlen()* |strchars()|. Also see |len()|, |strdisplaywidth()| and |strwidth()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetString()->strlen() +< strpart({src}, {start} [, {len} [, {chars}]]) *strpart()* The result is a String, which is part of {src}, starting from @@ -8315,20 +8523,21 @@ strpart({src}, {start} [, {len} [, {chars}]]) *strpart()* When bytes are selected which do not exist, this doesn't result in an error, the bytes are simply omitted. If {len} is missing, the copy continues from {start} till the - end of the {src}. > - strpart("abcdefg", 3, 2) == "de" - strpart("abcdefg", -2, 4) == "ab" - strpart("abcdefg", 5, 4) == "fg" - strpart("abcdefg", 3) == "defg" + end of the {src}. >vim + echo strpart("abcdefg", 3, 2) " returns 'de' + echo strpart("abcdefg", -2, 4) " returns 'ab' + echo strpart("abcdefg", 5, 4) " returns 'fg' + echo strpart("abcdefg", 3) " returns 'defg' < Note: To get the first character, {start} must be 0. For - example, to get the character under the cursor: > + example, to get the character under the cursor: >vim strpart(getline("."), col(".") - 1, 1, v:true) < Returns an empty string on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->strpart(5) +< strptime({format}, {timestring}) *strptime()* The result is a Number, which is a unix timestamp representing @@ -8346,15 +8555,15 @@ strptime({format}, {timestring}) *strptime()* result. See also |strftime()|. - Examples: > - :echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23") -< 862156163 > - :echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55")) -< Sun Apr 27 11:53:55 1997 > - :echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600) + Examples: >vim + echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23") +< 862156163 >vim + echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55")) +< Sun Apr 27 11:53:55 1997 >vim + echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600) < Sun Apr 27 12:53:55 1997 - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFormat()->strptime(timestring) < @@ -8363,34 +8572,36 @@ strridx({haystack}, {needle} [, {start}]) *strridx()* {haystack} of the last occurrence of the String {needle}. When {start} is specified, matches beyond this index are ignored. This can be used to find a match before a previous - match: > - :let lastcomma = strridx(line, ",") - :let comma2 = strridx(line, ",", lastcomma - 1) + match: >vim + let lastcomma = strridx(line, ",") + let comma2 = strridx(line, ",", lastcomma - 1) < The search is done case-sensitive. For pattern searches use |match()|. -1 is returned if the {needle} does not occur in {haystack}. If the {needle} is empty the length of {haystack} is returned. - See also |stridx()|. Examples: > - :echo strridx("an angry armadillo", "an") 3 + See also |stridx()|. Examples: >vim + echo strridx("an angry armadillo", "an") 3 < *strrchr()* When used with a single character it works similar to the C function strrchr(). - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetHaystack()->strridx(needle) +< strtrans({string}) *strtrans()* The result is a String, which is {string} with all unprintable characters translated into printable characters |'isprint'|. - Like they are shown in a window. Example: > + Like they are shown in a window. Example: >vim echo strtrans(@a) < This displays a newline in register a as "^@" instead of starting a new line. Returns an empty string on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetString()->strtrans() +< strutf16len({string} [, {countcc}]) *strutf16len()* The result is a Number, which is the number of UTF-16 code @@ -8404,14 +8615,14 @@ strutf16len({string} [, {countcc}]) *strutf16len()* Returns zero on error. Also see |strlen()| and |strcharlen()|. - Examples: > - echo strutf16len('a') returns 1 - echo strutf16len('Β©') returns 1 - echo strutf16len('π') returns 2 - echo strutf16len('aΜ¨Μ') returns 1 - echo strutf16len('aΜ¨Μ', v:true) returns 3 - - Can also be used as a |method|: > + Examples: >vim + echo strutf16len('a') " returns 1 + echo strutf16len('Β©') " returns 1 + echo strutf16len('π') " returns 2 + echo strutf16len('aΜ¨Μ') " returns 1 + echo strutf16len('aΜ¨Μ', v:true) " returns 3 + + Can also be used as a |method|: >vim GetText()->strutf16len() < @@ -8424,8 +8635,9 @@ strwidth({string}) *strwidth()* Returns zero on error. Also see |strlen()|, |strdisplaywidth()| and |strchars()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetString()->strwidth() +< submatch({nr} [, {list}]) *submatch()* *E935* Only for an expression in a |:substitute| command or @@ -8449,14 +8661,15 @@ submatch({nr} [, {list}]) *submatch()* *E935* Returns an empty string or list on error. - Examples: > - :s/\d\+/\=submatch(0) + 1/ - :echo substitute(text, '\d\+', '\=submatch(0) + 1', '') + Examples: >vim + s/\d\+/\=submatch(0) + 1/ + echo substitute(text, '\d\+', '\=submatch(0) + 1', '') < This finds the first number in the line and adds one to it. A line break is included as a newline character. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetNr()->submatch() +< substitute({string}, {pat}, {sub}, {flags}) *substitute()* The result is a String, which is a copy of {string}, in which @@ -8480,36 +8693,37 @@ substitute({string}, {pat}, {sub}, {flags}) *substitute()* When {pat} does not match in {string}, {string} is returned unmodified. - Example: > - :let &path = substitute(&path, ",\\=[^,]*$", "", "") -< This removes the last component of the 'path' option. > - :echo substitute("testing", ".*", "\\U\\0", "") + Example: >vim + let &path = substitute(&path, ",\\=[^,]*$", "", "") +< This removes the last component of the 'path' option. >vim + echo substitute("testing", ".*", "\\U\\0", "") < results in "TESTING". When {sub} starts with "\=", the remainder is interpreted as - an expression. See |sub-replace-expression|. Example: > - :echo substitute(s, '%\(\x\x\)', + an expression. See |sub-replace-expression|. Example: >vim + echo substitute(s, '%\(\x\x\)', \ '\=nr2char("0x" .. submatch(1))', 'g') < When {sub} is a Funcref that function is called, with one - optional argument. Example: > - :echo substitute(s, '%\(\x\x\)', SubNr, 'g') + optional argument. Example: >vim + echo substitute(s, '%\(\x\x\)', SubNr, 'g') < The optional argument is a list which contains the whole matched string and up to nine submatches, like what - |submatch()| returns. Example: > - :echo substitute(s, '%\(\x\x\)', {m -> '0x' .. m[1]}, 'g') + |submatch()| returns. Example: >vim + echo substitute(s, '%\(\x\x\)', {m -> '0x' .. m[1]}, 'g') < Returns an empty string on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetString()->substitute(pat, sub, flags) +< swapfilelist() *swapfilelist()* Returns a list of swap file names, like what "vim -r" shows. See the |-r| command argument. The 'directory' option is used for the directories to inspect. If you only want to get a list of swap files in the current directory then temporarily - set 'directory' to a dot: > + set 'directory' to a dot: >vim let save_dir = &directory let &directory = '.' let swapfiles = swapfilelist() @@ -8533,8 +8747,9 @@ swapinfo({fname}) *swapinfo()* Not a swap file: does not contain correct block ID Magic number mismatch: Info in first block is invalid - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFilename()->swapinfo() +< swapname({buf}) *swapname()* The result is the swap file path of the buffer {buf}. @@ -8543,8 +8758,9 @@ swapname({buf}) *swapname()* |:swapname| (unless there is no swap file). If buffer {buf} has no swap file, returns an empty string. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetBufname()->swapname() +< synID({lnum}, {col}, {trans}) *synID()* The result is a Number, which is the syntax ID at the position @@ -8568,8 +8784,8 @@ synID({lnum}, {col}, {trans}) *synID()* Returns zero on error. - Example (echoes the name of the syntax item under the cursor): > - :echo synIDattr(synID(line("."), col("."), 1), "name") + Example (echoes the name of the syntax item under the cursor): >vim + echo synIDattr(synID(line("."), col("."), 1), "name") < synIDattr({synID}, {what} [, {mode}]) *synIDattr()* @@ -8611,11 +8827,12 @@ synIDattr({synID}, {what} [, {mode}]) *synIDattr()* Returns an empty string on error. Example (echoes the color of the syntax item under the - cursor): > - :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") + cursor): >vim + echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg") +< + Can also be used as a |method|: >vim + echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg") < - Can also be used as a |method|: > - :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg") synIDtrans({synID}) *synIDtrans()* The result is a Number, which is the translated syntax ID of @@ -8625,8 +8842,9 @@ synIDtrans({synID}) *synIDtrans()* Returns zero on error. - Can also be used as a |method|: > - :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg") + Can also be used as a |method|: >vim + echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg") +< synconcealed({lnum}, {col}) *synconcealed()* The result is a |List| with currently three items: @@ -8664,7 +8882,7 @@ synstack({lnum}, {col}) *synstack()* returns, unless not the whole item is highlighted or it is a transparent item. This function is useful for debugging a syntax file. - Example that shows the syntax stack under the cursor: > + Example that shows the syntax stack under the cursor: >vim for id in synstack(line("."), col(".")) echo synIDattr(id, "name") endfor @@ -8680,8 +8898,8 @@ system({cmd} [, {input}]) *system()* *E677* a |List|) and sets |v:shell_error| to the error code. {cmd} is treated as in |jobstart()|: If {cmd} is a List it runs directly (no 'shell'). - If {cmd} is a String it runs in the 'shell', like this: > - :call jobstart(split(&shell) + split(&shellcmdflag) + ['{cmd}']) + If {cmd} is a String it runs in the 'shell', like this: >vim + call jobstart(split(&shell) + split(&shellcmdflag) + ['{cmd}']) < Not to be used for interactive commands. @@ -8689,8 +8907,8 @@ system({cmd} [, {input}]) *system()* *E677* - <CR><NL> is replaced with <NL> - NUL characters are replaced with SOH (0x01) - Example: > - :echo system(['ls', expand('%:h')]) + Example: >vim + echo system(['ls', expand('%:h')]) < If {input} is a string it is written to a pipe and passed as stdin to the command. The string is written as-is, line @@ -8704,8 +8922,8 @@ system({cmd} [, {input}]) *system()* *E677* terminated by NL (and NUL where the text has NL). *E5677* Note: system() cannot write to or read from backgrounded ("&") - shell commands, e.g.: > - :echo system("cat - &", "foo") + shell commands, e.g.: >vim + echo system("cat - &", "foo") < which is equivalent to: > $ echo foo | bash -c 'cat - &' < The pipes are disconnected (unless overridden by shell @@ -8715,15 +8933,16 @@ system({cmd} [, {input}]) *system()* *E677* Note: Use |shellescape()| or |::S| with |expand()| or |fnamemodify()| to escape special characters in a command argument. 'shellquote' and 'shellxquote' must be properly - configured. Example: > - :echo system('ls '..shellescape(expand('%:h'))) - :echo system('ls '..expand('%:h:S')) + configured. Example: >vim + echo system('ls '..shellescape(expand('%:h'))) + echo system('ls '..expand('%:h:S')) < Unlike ":!cmd" there is no automatic check for changed files. Use |:checktime| to force a check. - Can also be used as a |method|: > - :echo GetCmd()->system() + Can also be used as a |method|: >vim + echo GetCmd()->system() +< systemlist({cmd} [, {input} [, {keepempty}]]) *systemlist()* Same as |system()|, but returns a |List| with lines (parts of @@ -8734,13 +8953,14 @@ systemlist({cmd} [, {input} [, {keepempty}]]) *systemlist()* Note that on MS-Windows you may get trailing CR characters. To see the difference between "echo hello" and "echo -n hello" - use |system()| and |split()|: > + use |system()| and |split()|: >vim echo split(system('echo hello'), '\n', 1) < Returns an empty string on error. - Can also be used as a |method|: > - :echo GetCmd()->systemlist() + Can also be used as a |method|: >vim + echo GetCmd()->systemlist() +< tabpagebuflist([{arg}]) *tabpagebuflist()* The result is a |List|, where each item is the number of the @@ -8748,15 +8968,16 @@ tabpagebuflist([{arg}]) *tabpagebuflist()* {arg} specifies the number of the tab page to be used. When omitted the current tab page is used. When {arg} is invalid the number zero is returned. - To get a list of all buffers in all tabs use this: > + To get a list of all buffers in all tabs use this: >vim let buflist = [] for i in range(tabpagenr('$')) call extend(buflist, tabpagebuflist(i + 1)) endfor < Note that a buffer may appear in more than one window. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetTabpage()->tabpagebuflist() +< tabpagenr([{arg}]) *tabpagenr()* The result is a Number, which is the number of the current @@ -8780,12 +9001,12 @@ tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()* the window which will be used when going to this tab page. - When "$" the number of windows is returned. - When "#" the previous window nr is returned. - Useful examples: > + Useful examples: >vim tabpagewinnr(1) " current window of tab page 1 tabpagewinnr(4, '$') " number of windows in tab page 4 < When {tabarg} is invalid zero is returned. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetTabpage()->tabpagewinnr() < @@ -8836,7 +9057,7 @@ taglist({expr} [, {filename}]) *taglist()* located by Vim. Refer to |tags-file-format| for the format of the tags file generated by the different ctags tools. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetTagpattern()->taglist() tan({expr}) *tan()* @@ -8844,36 +9065,38 @@ tan({expr}) *tan()* in the range [-inf, inf]. {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo tan(10) -< 0.648361 > - :echo tan(-4.01) + Examples: >vim + echo tan(10) +< 0.648361 >vim + echo tan(-4.01) < -1.181502 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->tan() +< tanh({expr}) *tanh()* Return the hyperbolic tangent of {expr} as a |Float| in the range [-1, 1]. {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > - :echo tanh(0.5) -< 0.462117 > - :echo tanh(-1) + Examples: >vim + echo tanh(0.5) +< 0.462117 >vim + echo tanh(-1) < -0.761594 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->tanh() < tempname() *tempname()* Generates a (non-existent) filename located in the Nvim root |tempdir|. Scripts can use the filename as a temporary file. - Example: > - :let tmpfile = tempname() - :exe "redir > " .. tmpfile + Example: >vim + let tmpfile = tempname() + exe "redir > " .. tmpfile +< termopen({cmd} [, {opts}]) *termopen()* Spawns {cmd} in a new pseudo-terminal session connected @@ -8905,7 +9128,7 @@ timer_info([{id}]) *timer_info()* -1 means forever "callback" the callback - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetTimer()->timer_info() < @@ -8922,7 +9145,7 @@ timer_pause({timer}, {paused}) *timer_pause()* String, then the timer is paused, otherwise it is unpaused. See |non-zero-arg|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetTimer()->timer_pause(1) < @@ -8948,7 +9171,7 @@ timer_start({time}, {callback} [, {options}]) *timer_start()* *timer* Returns -1 on error. - Example: > + Example: >vim func MyHandler(timer) echo 'Handler called' endfunc @@ -8956,7 +9179,7 @@ timer_start({time}, {callback} [, {options}]) *timer_start()* *timer* \ {'repeat': 3}) < This invokes MyHandler() three times at 500 msec intervals. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetMsec()->timer_start(callback) < Not available in the |sandbox|. @@ -8966,7 +9189,7 @@ timer_stop({timer}) *timer_stop()* {timer} is an ID returned by timer_start(), thus it must be a Number. If {timer} does not exist there is no error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetTimer()->timer_stop() < @@ -8980,16 +9203,18 @@ tolower({expr}) *tolower()* characters turned into lowercase (just like applying |gu| to the string). Returns an empty string on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->tolower() +< toupper({expr}) *toupper()* The result is a copy of the String given, with all lowercase characters turned into uppercase (just like applying |gU| to the string). Returns an empty string on error. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->toupper() +< tr({src}, {fromstr}, {tostr}) *tr()* The result is a copy of the {src} string with all characters @@ -9001,14 +9226,15 @@ tr({src}, {fromstr}, {tostr}) *tr()* Returns an empty string on error. - Examples: > + Examples: >vim echo tr("hello there", "ht", "HT") -< returns "Hello THere" > +< returns "Hello THere" >vim echo tr("<blob>", "<>", "{}") < returns "{blob}" - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->tr(from, to) +< trim({text} [, {mask} [, {dir}]]) *trim()* Return {text} as a String where any character in {mask} is @@ -9025,34 +9251,36 @@ trim({text} [, {mask} [, {dir}]]) *trim()* This function deals with multibyte characters properly. Returns an empty string on error. - Examples: > + Examples: >vim echo trim(" some text ") -< returns "some text" > +< returns "some text" >vim echo trim(" \r\t\t\r RESERVE \t\n\x0B\xA0") .. "_TAIL" -< returns "RESERVE_TAIL" > +< returns "RESERVE_TAIL" >vim echo trim("rm<Xrm<>X>rrm", "rm<>") -< returns "Xrm<>X" (characters in the middle are not removed) > +< returns "Xrm<>X" (characters in the middle are not removed) >vim echo trim(" vim ", " ", 2) < returns " vim" - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetText()->trim() +< trunc({expr}) *trunc()* Return the largest integral value with magnitude less than or equal to {expr} as a |Float| (truncate towards zero). {expr} must evaluate to a |Float| or a |Number|. Returns 0.0 if {expr} is not a |Float| or a |Number|. - Examples: > + Examples: >vim echo trunc(1.456) -< 1.0 > +< 1.0 >vim echo trunc(-5.456) -< -5.0 > +< -5.0 >vim echo trunc(4.0) < 4.0 - Can also be used as a |method|: > + Can also be used as a |method|: >vim Compute()->trunc() +< type({expr}) *type()* The result is a Number representing the type of {expr}. @@ -9067,22 +9295,23 @@ type({expr}) *type()* Boolean: 6 (|v:true| and |v:false|) Null: 7 (|v:null|) Blob: 10 (|v:t_blob|) - For backward compatibility, this method can be used: > - :if type(myvar) == type(0) - :if type(myvar) == type("") - :if type(myvar) == type(function("tr")) - :if type(myvar) == type([]) - :if type(myvar) == type({}) - :if type(myvar) == type(0.0) - :if type(myvar) == type(v:true) + For backward compatibility, this method can be used: >vim + if type(myvar) == type(0) | endif + if type(myvar) == type("") | endif + if type(myvar) == type(function("tr")) | endif + if type(myvar) == type([]) | endif + if type(myvar) == type({}) | endif + if type(myvar) == type(0.0) | endif + if type(myvar) == type(v:true) | endif < In place of checking for |v:null| type it is better to check - for |v:null| directly as it is the only value of this type: > - :if myvar is v:null -< To check if the v:t_ variables exist use this: > - :if exists('v:t_number') + for |v:null| directly as it is the only value of this type: >vim + if myvar is v:null | endif +< To check if the v:t_ variables exist use this: >vim + if exists('v:t_number') | endif -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim mylist->type() +< undofile({name}) *undofile()* Return the name of the undo file that would be used for a file @@ -9095,8 +9324,9 @@ undofile({name}) *undofile()* buffer without a file name will not write an undo file. Useful in combination with |:wundo| and |:rundo|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetFilename()->undofile() +< undotree() *undotree()* Return the current state of the undo tree in a dictionary with @@ -9144,14 +9374,14 @@ undotree() *undotree()* uniq({list} [, {func} [, {dict}]]) *uniq()* *E882* Remove second and succeeding copies of repeated adjacent {list} items in-place. Returns {list}. If you want a list - to remain unmodified make a copy first: > - :let newlist = uniq(copy(mylist)) + to remain unmodified make a copy first: >vim + let newlist = uniq(copy(mylist)) < The default compare function uses the string representation of each item. For the use of {func} and {dict} see |sort()|. Returns zero if {list} is not a |List|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mylist->uniq() < @@ -9173,16 +9403,16 @@ utf16idx({string}, {idx} [, {countcc} [, {charidx}]]) *utf16idx()* from the UTF-16 index and |charidx()| for getting the character index from the UTF-16 index. Refer to |string-offset-encoding| for more information. - Examples: > - echo utf16idx('aππ', 3) returns 2 - echo utf16idx('aππ', 7) returns 4 - echo utf16idx('aππ', 1, 0, 1) returns 2 - echo utf16idx('aππ', 2, 0, 1) returns 4 - echo utf16idx('aaΜ¨Μc', 6) returns 2 - echo utf16idx('aaΜ¨Μc', 6, 1) returns 4 - echo utf16idx('aππ', 9) returns -1 -< - Can also be used as a |method|: > + Examples: >vim + echo utf16idx('aππ', 3) " returns 2 + echo utf16idx('aππ', 7) " returns 4 + echo utf16idx('aππ', 1, 0, 1) " returns 2 + echo utf16idx('aππ', 2, 0, 1) " returns 4 + echo utf16idx('aaΜ¨Μc', 6) " returns 2 + echo utf16idx('aaΜ¨Μc', 6, 1) " returns 4 + echo utf16idx('aππ', 9) " returns -1 +< + Can also be used as a |method|: >vim GetName()->utf16idx(idx) < @@ -9191,8 +9421,9 @@ values({dict}) *values()* in arbitrary order. Also see |items()| and |keys()|. Returns zero if {dict} is not a |Dict|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim mydict->values() +< virtcol({expr} [, {list}]) *virtcol()* The result is a Number, which is the screen column of the file @@ -9231,23 +9462,24 @@ virtcol({expr} [, {list}]) *virtcol()* character. Note that only marks in the current file can be used. - Examples: > + Examples: >vim " With text "foo^Lbar" and cursor on the "^L": - virtcol(".") " returns 5 - virtcol(".", 1) " returns [4, 5] - virtcol("$") " returns 9 + echo virtcol(".") " returns 5 + echo virtcol(".", 1) " returns [4, 5] + echo virtcol("$") " returns 9 " With text " there", with 't at 'h': - virtcol("'t") " returns 6 -< The first column is 1. 0 is returned for an error. - A more advanced example that echoes the maximum length of - all lines: > + echo virtcol("'t") " returns 6 +< Techo he first column is 1. 0 is returned for an error. + A echo more advanced example that echoes the maximum length of + all lines: >vim echo max(map(range(1, line('$')), "virtcol([v:val, '$'])")) -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetPos()->virtcol() +< virtcol2col({winid}, {lnum}, {col}) *virtcol2col()* The result is a Number, which is the byte index of the @@ -9266,8 +9498,9 @@ virtcol2col({winid}, {lnum}, {col}) *virtcol2col()* See also |screenpos()|, |virtcol()| and |col()|. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinid()->virtcol2col(lnum, col) +< visualmode([{expr}]) *visualmode()* The result is a String, which describes the last Visual mode @@ -9276,8 +9509,8 @@ visualmode([{expr}]) *visualmode()* "V", or "<CTRL-V>" (a single CTRL-V character) for character-wise, line-wise, or block-wise Visual mode respectively. - Example: > - :exe "normal " .. visualmode() + Example: >vim + exe "normal " .. visualmode() < This enters the same Visual mode as before. It is also useful in scripts if you wish to act differently depending on the Visual mode that was used. @@ -9309,8 +9542,8 @@ wildmenumode() *wildmenumode()* This can be used in mappings to handle the 'wildcharm' option gracefully. (Makes only sense with |mapmode-c| mappings). - For example to make <c-j> work like <down> in wildmode, use: > - :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" + For example to make <c-j> work like <down> in wildmode, use: >vim + cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>" < (Note, this needs the 'wildcharm' option set appropriately). @@ -9320,7 +9553,7 @@ win_execute({id}, {command} [, {silent}]) *win_execute()* without triggering autocommands or changing directory. When executing {command} autocommands will be triggered, this may have unexpected side effects. Use `:noautocmd` if needed. - Example: > + Example: >vim call win_execute(winid, 'syntax enable') < Doing the same with `setwinvar()` would not trigger autocommands and not actually show syntax highlighting. @@ -9329,15 +9562,17 @@ win_execute({id}, {command} [, {silent}]) *win_execute()* an empty string is returned. Can also be used as a |method|, the base is passed as the - second argument: > + second argument: >vim GetCommand()->win_execute(winid) +< win_findbuf({bufnr}) *win_findbuf()* Returns a |List| with |window-ID|s for windows that contain buffer {bufnr}. When there is none the list is empty. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetBufnr()->win_findbuf() +< win_getid([{win} [, {tab}]]) *win_getid()* Get the |window-ID| for the specified window. @@ -9348,8 +9583,9 @@ win_getid([{win} [, {tab}]]) *win_getid()* number {tab}. The first tab has number one. Return zero if the window cannot be found. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinnr()->win_getid() +< win_gettype([{nr}]) *win_gettype()* Return the type of the window: @@ -9369,7 +9605,7 @@ win_gettype([{nr}]) *win_gettype()* Also see the 'buftype' option. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinid()->win_gettype() < @@ -9378,23 +9614,26 @@ win_gotoid({expr}) *win_gotoid()* tabpage. Return TRUE if successful, FALSE if the window cannot be found. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinid()->win_gotoid() +< win_id2tabwin({expr}) *win_id2tabwin()* Return a list with the tab number and window number of window with ID {expr}: [tabnr, winnr]. Return [0, 0] if the window cannot be found. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinid()->win_id2tabwin() +< win_id2win({expr}) *win_id2win()* Return the window number of window with ID {expr}. Return 0 if the window cannot be found in the current tabpage. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinid()->win_id2win() +< win_move_separator({nr}, {offset}) *win_move_separator()* Move window {nr}'s vertical separator (i.e., the right border) @@ -9411,8 +9650,9 @@ win_move_separator({nr}, {offset}) *win_move_separator()* window, since it has no separator on the right. Only works for the current tab page. *E1308* - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinnr()->win_move_separator(offset) +< win_move_statusline({nr}, {offset}) *win_move_statusline()* Move window {nr}'s status line (i.e., the bottom border) by @@ -9426,8 +9666,9 @@ win_move_statusline({nr}, {offset}) *win_move_statusline()* be found and FALSE otherwise. Only works for the current tab page. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinnr()->win_move_statusline(offset) +< win_screenpos({nr}) *win_screenpos()* Return the screen position of window {nr} as a list with two @@ -9438,7 +9679,7 @@ win_screenpos({nr}) *win_screenpos()* Returns [0, 0] if the window cannot be found in the current tabpage. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinid()->win_screenpos() < @@ -9462,7 +9703,7 @@ win_splitmove({nr}, {target} [, {options}]) *win_splitmove()* present, the values of 'splitbelow' and 'splitright' are used. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinid()->win_splitmove(target) < @@ -9473,10 +9714,10 @@ winbufnr({nr}) *winbufnr()* When {nr} is zero, the number of the buffer in the current window is returned. When window {nr} doesn't exist, -1 is returned. - Example: > - :echo "The file in the current window is " .. bufname(winbufnr(0)) + Example: >vim + echo "The file in the current window is " .. bufname(winbufnr(0)) < - Can also be used as a |method|: > + Can also be used as a |method|: >vim FindWindow()->winbufnr()->bufname() < @@ -9498,10 +9739,10 @@ winheight({nr}) *winheight()* returned. When window {nr} doesn't exist, -1 is returned. An existing window always has a height of zero or more. This excludes any window toolbar line. - Examples: > - :echo "The current window has " .. winheight(0) .. " lines." + Examples: >vim + echo "The current window has " .. winheight(0) .. " lines." -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetWinid()->winheight() < @@ -9513,29 +9754,35 @@ winlayout([{tabnr}]) *winlayout()* with number {tabnr}. If the tabpage {tabnr} is not found, returns an empty list. - For a leaf window, it returns: + For a leaf window, it returns: > ["leaf", {winid}] +< For horizontally split windows, which form a column, it returns: > ["col", [{nested list of windows}]] < For vertically split windows, which form a row, it returns: > ["row", [{nested list of windows}]] < - Example: > + Example: >vim " Only one window in the tab page - :echo winlayout() + echo winlayout() +< > ['leaf', 1000] +< >vim " Two horizontally split windows - :echo winlayout() + echo winlayout() +< > ['col', [['leaf', 1000], ['leaf', 1001]]] +< >vim " The second tab page, with three horizontally split " windows, with two vertically split windows in the " middle window - :echo winlayout(2) + echo winlayout(2) +< > ['col', [['leaf', 1002], ['row', [['leaf', 1003], ['leaf', 1001]]], ['leaf', 1000]]] < - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetTabnr()->winlayout() < @@ -9570,12 +9817,12 @@ winnr([{arg}]) *winnr()* |:wincmd|. When {arg} is invalid an error is given and zero is returned. Also see |tabpagewinnr()| and |win_getid()|. - Examples: > + Examples: >vim let window_count = winnr('$') let prev_window = winnr('#') let wnum = winnr('3k') -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetWinval()->winnr() < @@ -9584,10 +9831,10 @@ winrestcmd() *winrestcmd()* the current window sizes. Only works properly when no windows are opened or closed and the current window and tab page is unchanged. - Example: > - :let cmd = winrestcmd() - :call MessWithWindowSizes() - :exe cmd + Example: >vim + let cmd = winrestcmd() + call MessWithWindowSizes() + exe cmd < winrestview({dict}) *winrestview()* @@ -9595,8 +9842,8 @@ winrestview({dict}) *winrestview()* the view of the current window. Note: The {dict} does not have to contain all values, that are returned by |winsaveview()|. If values are missing, those - settings won't be restored. So you can use: > - :call winrestview({'curswant': 4}) + settings won't be restored. So you can use: >vim + call winrestview({'curswant': 4}) < This will only set the curswant value (the column the cursor wants to move on vertical movements) of the cursor to column 5 @@ -9606,7 +9853,7 @@ winrestview({dict}) *winrestview()* If you have changed the values the result is unpredictable. If the window size changed the result won't be the same. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetView()->winrestview() < @@ -9643,16 +9890,17 @@ winwidth({nr}) *winwidth()* When {nr} is zero, the width of the current window is returned. When window {nr} doesn't exist, -1 is returned. An existing window always has a width of zero or more. - Examples: > - :echo "The current window has " .. winwidth(0) .. " columns." - :if winwidth(0) <= 50 - : 50 wincmd | - :endif + Examples: >vim + echo "The current window has " .. winwidth(0) .. " columns." + if winwidth(0) <= 50 + 50 wincmd | + endif < For getting the terminal or screen size, see the 'columns' option. - Can also be used as a |method|: > + Can also be used as a |method|: >vim GetWinid()->winwidth() +< wordcount() *wordcount()* The result is a dictionary of byte/chars/word statistics for @@ -9692,13 +9940,13 @@ writefile({object}, {fname} [, {flags}]) *writefile()* last list item. An empty item at the end does cause the last line in the file to end in a NL. - 'a' Append mode is used, lines are appended to the file: > - :call writefile(["foo"], "event.log", "a") - :call writefile(["bar"], "event.log", "a") + 'a' Append mode is used, lines are appended to the file: >vim + call writefile(["foo"], "event.log", "a") + call writefile(["bar"], "event.log", "a") < 'D' Delete the file when the current function ends. This - works like: > - :defer delete({fname}) + works like: >vim + defer delete({fname}) < Fails when not in a function. Also see |:defer|. 's' fsync() is called after writing the file. This flushes @@ -9717,22 +9965,23 @@ writefile({object}, {fname} [, {flags}]) *writefile()* fails. Also see |readfile()|. - To copy a file byte for byte: > - :let fl = readfile("foo", "b") - :call writefile(fl, "foocopy", "b") + To copy a file byte for byte: >vim + let fl = readfile("foo", "b") + call writefile(fl, "foocopy", "b") -< Can also be used as a |method|: > +< Can also be used as a |method|: >vim GetText()->writefile("thefile") +< xor({expr}, {expr}) *xor()* Bitwise XOR on the two arguments. The arguments are converted to a number. A List, Dict or Float argument causes an error. Also see `and()` and `or()`. - Example: > - :let bits = xor(bits, 0x80) + Example: >vim + let bits = xor(bits, 0x80) < - Can also be used as a |method|: > - :let bits = bits->xor(0x80) + Can also be used as a |method|: >vim + let bits = bits->xor(0x80) < ============================================================================== @@ -9744,14 +9993,14 @@ pattern is used to find a match in a String, almost everything works in the same way. The difference is that a String is handled like it is one line. When it contains a "\n" character, this is not seen as a line break for the pattern. It can be matched with a "\n" in the pattern, or with ".". Example: -> - :let a = "aaaa\nxxxx" - :echo matchstr(a, "..\n..") - aa - xx - :echo matchstr(a, "a.x") - a - x +>vim + let a = "aaaa\nxxxx" + echo matchstr(a, "..\n..") + " aa + " xx + echo matchstr(a, "a.x") + " a + " x Don't forget that "^" will only match at the first character of the String and "$" at the last character of the string. They don't match after or before a |