vim: runtime/doc/builtin.txt annotate

annotate runtime/doc/builtin.txt @ 35507:1a7250350167 draft default tip

runtime(doc): In builtin overview use {buf} as param for appendbufline/setbufline (#15089) Commit: https://github.com/vim/vim/commit/f0837ba0b9dba9d30e3dc2626d4f690a2d51103e Author: errael <errael@raelity.com> Date: Mon Jun 24 12:27:01 2024 -0700 runtime(doc): In builtin overview use {buf} as param for appendbufline/setbufline (https://github.com/vim/vim/issues/15089) Signed-off-by: Ernie Rael <errael@raelity.com> Signed-off-by: Christian Brabandt <cb@256bit.org>

author	Christian Brabandt <cb@256bit.org>
date	Mon, 24 Jun 2024 21:30:08 +0200
parents	04563887d70e
children

rev	line source
35507 1a7250350167 runtime(doc): In builtin overview use {buf} as param for appendbufline/setbufline (#15089) Christian Brabandt <cb@256bit.org> parents: 35484 diff changeset	1 builtin.txt For Vim version 9.1. Last change: 2024 Jun 23
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4 VIM REFERENCE MANUAL by Bram Moolenaar
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7 Builtin functions builtin-functions
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9 Note: Expression evaluation can be disabled at compile time, the builtin
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10 functions are not available then. See \|+eval\| and \|no-eval-feature\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12 For functions grouped by what they are used for see \|function-list\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	13
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	14 1. Overview \|builtin-function-list\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	15 2. Details \|builtin-function-details\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	16 3. Feature list \|feature-list\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	17 4. Matching a pattern in a String \|string-match\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	18
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	19 ==============================================================================
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	20 1. Overview builtin-function-list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	21
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	22 Use CTRL-] on the function name to jump to the full explanation.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	23
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	24 USAGE RESULT DESCRIPTION ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	25
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	26 abs({expr}) Float or Number absolute value of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	27 acos({expr}) Float arc cosine of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	28 add({object}, {item}) List/Blob append {item} to {object}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	29 and({expr}, {expr}) Number bitwise AND
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	30 append({lnum}, {text}) Number append {text} below line {lnum}
35507 1a7250350167 runtime(doc): In builtin overview use {buf} as param for appendbufline/setbufline (#15089) Christian Brabandt <cb@256bit.org> parents: 35484 diff changeset	31 appendbufline({buf}, {lnum}, {text})
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	32 Number append {text} below line {lnum}
35507 1a7250350167 runtime(doc): In builtin overview use {buf} as param for appendbufline/setbufline (#15089) Christian Brabandt <cb@256bit.org> parents: 35484 diff changeset	33 in buffer {buf}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	34 argc([{winid}]) Number number of files in the argument list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	35 argidx() Number current index in the argument list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	36 arglistid([{winnr} [, {tabnr}]]) Number argument list id
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	37 argv({nr} [, {winid}]) String {nr} entry of the argument list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	38 argv([-1, {winid}]) List the argument list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	39 asin({expr}) Float arc sine of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	40 assert_beeps({cmd}) Number assert {cmd} causes a beep
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	41 assert_equal({exp}, {act} [, {msg}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	42 Number assert {exp} is equal to {act}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	43 assert_equalfile({fname-one}, {fname-two} [, {msg}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	44 Number assert file contents are equal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	45 assert_exception({error} [, {msg}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	46 Number assert {error} is in v:exception
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	47 assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	48 Number assert {cmd} fails
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	49 assert_false({actual} [, {msg}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	50 Number assert {actual} is false
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	51 assert_inrange({lower}, {upper}, {actual} [, {msg}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	52 Number assert {actual} is inside the range
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	53 assert_match({pat}, {text} [, {msg}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	54 Number assert {pat} matches {text}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	55 assert_nobeep({cmd}) Number assert {cmd} does not cause a beep
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	56 assert_notequal({exp}, {act} [, {msg}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	57 Number assert {exp} is not equal {act}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	58 assert_notmatch({pat}, {text} [, {msg}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	59 Number assert {pat} not matches {text}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	60 assert_report({msg}) Number report a test failure
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	61 assert_true({actual} [, {msg}]) Number assert {actual} is true
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	62 atan({expr}) Float arc tangent of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	63 atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	64 autocmd_add({acmds}) Bool add a list of autocmds and groups
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	65 autocmd_delete({acmds}) Bool delete a list of autocmds and groups
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	66 autocmd_get([{opts}]) List return a list of autocmds
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	67 balloon_gettext() String current text in the balloon
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	68 balloon_show({expr}) none show {expr} inside the balloon
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	69 balloon_split({msg}) List split {msg} as used for a balloon
35484 04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	70 bindtextdomain({package}, {path})
04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	71 none bind text domain to specied path
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	72 blob2list({blob}) List convert {blob} into a list of numbers
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	73 browse({save}, {title}, {initdir}, {default})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	74 String put up a file requester
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	75 browsedir({title}, {initdir}) String put up a directory requester
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	76 bufadd({name}) Number add a buffer to the buffer list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	77 bufexists({buf}) Number \|TRUE\| if buffer {buf} exists
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	78 buflisted({buf}) Number \|TRUE\| if buffer {buf} is listed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	79 bufload({buf}) Number load buffer {buf} if not loaded yet
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	80 bufloaded({buf}) Number \|TRUE\| if buffer {buf} is loaded
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	81 bufname([{buf}]) String Name of the buffer {buf}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	82 bufnr([{buf} [, {create}]]) Number Number of the buffer {buf}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	83 bufwinid({buf}) Number window ID of buffer {buf}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	84 bufwinnr({buf}) Number window number of buffer {buf}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	85 byte2line({byte}) Number line number at byte count {byte}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	86 byteidx({expr}, {nr} [, {utf16}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	87 Number byte index of {nr}'th char in {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	88 byteidxcomp({expr}, {nr} [, {utf16}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	89 Number byte index of {nr}'th char in {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	90 call({func}, {arglist} [, {dict}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	91 any call {func} with arguments {arglist}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	92 ceil({expr}) Float round {expr} up
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	93 ch_canread({handle}) Number check if there is something to read
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	94 ch_close({handle}) none close {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	95 ch_close_in({handle}) none close in part of {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	96 ch_evalexpr({handle}, {expr} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	97 any evaluate {expr} on JSON {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	98 ch_evalraw({handle}, {string} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	99 any evaluate {string} on raw {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	100 ch_getbufnr({handle}, {what}) Number get buffer number for {handle}/{what}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	101 ch_getjob({channel}) Job get the Job of {channel}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	102 ch_info({handle}) String info about channel {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	103 ch_log({msg} [, {handle}]) none write {msg} in the channel log file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	104 ch_logfile({fname} [, {mode}]) none start logging channel activity
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	105 ch_open({address} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	106 Channel open a channel to {address}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	107 ch_read({handle} [, {options}]) String read from {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	108 ch_readblob({handle} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	109 Blob read Blob from {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	110 ch_readraw({handle} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	111 String read raw from {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	112 ch_sendexpr({handle}, {expr} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	113 any send {expr} over JSON {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	114 ch_sendraw({handle}, {expr} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	115 any send {expr} over raw {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	116 ch_setoptions({handle}, {options})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	117 none set options for {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	118 ch_status({handle} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	119 String status of channel {handle}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	120 changenr() Number current change number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	121 char2nr({expr} [, {utf8}]) Number ASCII/UTF-8 value of first char in {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	122 charclass({string}) Number character class of {string}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	123 charcol({expr} [, {winid}]) Number column number of cursor or mark
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	124 charidx({string}, {idx} [, {countcc} [, {utf16}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	125 Number char index of byte {idx} in {string}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	126 chdir({dir}) String change current working directory
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	127 cindent({lnum}) Number C indent for line {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	128 clearmatches([{win}]) none clear all matches
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	129 col({expr} [, {winid}]) Number column byte index of cursor or mark
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	130 complete({startcol}, {matches}) none set Insert mode completion
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	131 complete_add({expr}) Number add completion match
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	132 complete_check() Number check for key typed during completion
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	133 complete_info([{what}]) Dict get current completion information
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	134 confirm({msg} [, {choices} [, {default} [, {type}]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	135 Number number of choice picked by user
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	136 copy({expr}) any make a shallow copy of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	137 cos({expr}) Float cosine of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	138 cosh({expr}) Float hyperbolic cosine of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	139 count({comp}, {expr} [, {ic} [, {start}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	140 Number count how many {expr} are in {comp}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	141 cscope_connection([{num}, {dbpath} [, {prepend}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	142 Number checks existence of cscope connection
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	143 cursor({lnum}, {col} [, {off}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	144 Number move cursor to {lnum}, {col}, {off}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	145 cursor({list}) Number move cursor to position in {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	146 debugbreak({pid}) Number interrupt process being debugged
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	147 deepcopy({expr} [, {noref}]) any make a full copy of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	148 delete({fname} [, {flags}]) Number delete the file or directory {fname}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	149 deletebufline({buf}, {first} [, {last}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	150 Number delete lines from buffer {buf}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	151 did_filetype() Number \|TRUE\| if FileType autocmd event used
34264 cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	152 diff({fromlist}, {tolist} [, {options}])
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	153 List diff two Lists of strings
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	154 diff_filler({lnum}) Number diff filler lines about {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	155 diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	156 digraph_get({chars}) String get the \|digraph\| of {chars}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	157 digraph_getlist([{listall}]) List get all \|digraph\|s
35461 5301104f466a patch 9.1.0500: cannot switch buffer in a popup Christian Brabandt <cb@256bit.org> parents: 35446 diff changeset	158 digraph_set({chars}, {digraph}) Bool register \|digraph\|
5301104f466a patch 9.1.0500: cannot switch buffer in a popup Christian Brabandt <cb@256bit.org> parents: 35446 diff changeset	159 digraph_setlist({digraphlist}) Bool register multiple \|digraph\|s
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	160 echoraw({expr}) none output {expr} as-is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	161 empty({expr}) Number \|TRUE\| if {expr} is empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	162 environ() Dict return environment variables
32828 656c54d276d5 patch 9.0.1727: minor problems with the teapot Christian Brabandt <cb@256bit.org> parents: 32801 diff changeset	163 err_teapot([{expr}]) none give E418, or E503 if {expr} is \|TRUE\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	164 escape({string}, {chars}) String escape {chars} in {string} with '\'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	165 eval({string}) any evaluate {string} into its value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	166 eventhandler() Number \|TRUE\| if inside an event handler
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	167 executable({expr}) Number 1 if executable {expr} exists
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	168 execute({command}) String execute {command} and get the output
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	169 exepath({expr}) String full path of the command {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	170 exists({expr}) Number \|TRUE\| if {expr} exists
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	171 exists_compiled({expr}) Number \|TRUE\| if {expr} exists at compile time
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	172 exp({expr}) Float exponential of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	173 expand({expr} [, {nosuf} [, {list}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	174 any expand special keywords in {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	175 expandcmd({string} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	176 String expand {string} like with `:edit`
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	177 extend({expr1}, {expr2} [, {expr3}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	178 List/Dict insert items of {expr2} into {expr1}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	179 extendnew({expr1}, {expr2} [, {expr3}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	180 List/Dict like \|extend()\| but creates a new
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	181 List or Dictionary
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	182 feedkeys({string} [, {mode}]) Number add key sequence to typeahead buffer
35326 a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	183 filecopy({from}, {to}) Number \|TRUE\| if copying file {from} to {to}
a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	184 worked
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	185 filereadable({file}) Number \|TRUE\| if {file} is a readable file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	186 filewritable({file}) Number \|TRUE\| if {file} is a writable file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	187 filter({expr1}, {expr2}) List/Dict/Blob/String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	188 remove items from {expr1} where
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	189 {expr2} is 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	190 finddir({name} [, {path} [, {count}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	191 String find directory {name} in {path}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	192 findfile({name} [, {path} [, {count}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	193 String find file {name} in {path}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	194 flatten({list} [, {maxdepth}]) List flatten {list} up to {maxdepth} levels
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	195 flattennew({list} [, {maxdepth}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	196 List flatten a copy of {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	197 float2nr({expr}) Number convert Float {expr} to a Number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	198 floor({expr}) Float round {expr} down
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	199 fmod({expr1}, {expr2}) Float remainder of {expr1} / {expr2}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	200 fnameescape({fname}) String escape special characters in {fname}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	201 fnamemodify({fname}, {mods}) String modify file name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	202 foldclosed({lnum}) Number first line of fold at {lnum} if closed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	203 foldclosedend({lnum}) Number last line of fold at {lnum} if closed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	204 foldlevel({lnum}) Number fold level at {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	205 foldtext() String line displayed for closed fold
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	206 foldtextresult({lnum}) String text for closed fold at {lnum}
34126 da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	207 foreach({expr1}, {expr2}) List/Dict/Blob/String
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	208 for each item in {expr1} call {expr2}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	209 foreground() Number bring the Vim window to the foreground
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	210 fullcommand({name} [, {vim9}]) String get full command from {name}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	211 funcref({name} [, {arglist}] [, {dict}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	212 Funcref reference to function {name}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	213 function({name} [, {arglist}] [, {dict}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	214 Funcref named reference to function {name}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	215 garbagecollect([{atexit}]) none free memory, breaking cyclic references
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	216 get({list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	217 get({dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	218 get({func}, {what}) any get property of funcref/partial {func}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	219 getbufinfo([{buf}]) List information about buffers
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	220 getbufline({buf}, {lnum} [, {end}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	221 List lines {lnum} to {end} of buffer {buf}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	222 getbufoneline({buf}, {lnum}) String line {lnum} of buffer {buf}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	223 getbufvar({buf}, {varname} [, {def}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	224 any variable {varname} in buffer {buf}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	225 getcellwidths() List get character cell width overrides
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	226 getchangelist([{buf}]) List list of change list items
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	227 getchar([{expr}]) Number or String
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	228 get one character from the user
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	229 getcharmod() Number modifiers for the last typed character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	230 getcharpos({expr}) List position of cursor, mark, etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	231 getcharsearch() Dict last character search
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	232 getcharstr([{expr}]) String get one character from the user
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	233 getcmdcompltype() String return the type of the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	234 command-line completion
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	235 getcmdline() String return the current command-line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	236 getcmdpos() Number return cursor position in command-line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	237 getcmdscreenpos() Number return cursor screen position in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	238 command-line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	239 getcmdtype() String return current command-line type
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	240 getcmdwintype() String return current command-line window type
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	241 getcompletion({pat}, {type} [, {filtered}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	242 List list of cmdline completion matches
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	243 getcurpos([{winnr}]) List position of the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	244 getcursorcharpos([{winnr}]) List character position of the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	245 getcwd([{winnr} [, {tabnr}]]) String get the current working directory
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	246 getenv({name}) String return environment variable
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	247 getfontname([{name}]) String name of font being used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	248 getfperm({fname}) String file permissions of file {fname}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	249 getfsize({fname}) Number size in bytes of file {fname}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	250 getftime({fname}) Number last modification time of file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	251 getftype({fname}) String description of type of file {fname}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	252 getimstatus() Number \|TRUE\| if the IME status is active
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	253 getjumplist([{winnr} [, {tabnr}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	254 List list of jump list items
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	255 getline({lnum}) String line {lnum} of current buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	256 getline({lnum}, {end}) List lines {lnum} to {end} of current buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	257 getloclist({nr}) List list of location list items
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	258 getloclist({nr}, {what}) Dict get specific location list properties
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	259 getmarklist([{buf}]) List list of global/local marks
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	260 getmatches([{win}]) List list of current matches
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	261 getmousepos() Dict last known mouse position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	262 getmouseshape() String current mouse shape name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	263 getpid() Number process ID of Vim
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	264 getpos({expr}) List position of cursor, mark, etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	265 getqflist() List list of quickfix items
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	266 getqflist({what}) Dict get specific quickfix list properties
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	267 getreg([{regname} [, 1 [, {list}]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	268 String or List contents of a register
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	269 getreginfo([{regname}]) Dict information about a register
34451 d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	270 getregion({pos1}, {pos2} [, {opts}])
34387 e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	271 List get the text from {pos1} to {pos2}
35125 9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	272 getregionpos({pos1}, {pos2} [, {opts}])
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	273 List get a list of positions for a region
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	274 getregtype([{regname}]) String type of a register
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	275 getscriptinfo([{opts}]) List list of sourced scripts
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	276 gettabinfo([{expr}]) List list of tab pages
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	277 gettabvar({nr}, {varname} [, {def}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	278 any variable {varname} in tab {nr} or {def}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	279 gettabwinvar({tabnr}, {winnr}, {name} [, {def}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	280 any {name} in {winnr} in tab page {tabnr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	281 gettagstack([{nr}]) Dict get the tag stack of window {nr}
35484 04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	282 gettext({text} [, {package}])
04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	283 String lookup translation of {text}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	284 getwininfo([{winid}]) List list of info about each window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	285 getwinpos([{timeout}]) List X and Y coord in pixels of Vim window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	286 getwinposx() Number X coord in pixels of the Vim window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	287 getwinposy() Number Y coord in pixels of the Vim window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	288 getwinvar({nr}, {varname} [, {def}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	289 any variable {varname} in window {nr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	290 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	291 any expand file wildcards in {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	292 glob2regpat({expr}) String convert a glob pat into a search pat
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	293 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	294 String do glob({expr}) for all dirs in {path}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	295 has({feature} [, {check}]) Number \|TRUE\| if feature {feature} supported
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	296 has_key({dict}, {key}) Number \|TRUE\| if {dict} has entry {key}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	297 haslocaldir([{winnr} [, {tabnr}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	298 Number \|TRUE\| if the window executed \|:lcd\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	299 or \|:tcd\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	300 hasmapto({what} [, {mode} [, {abbr}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	301 Number \|TRUE\| if mapping to {what} exists
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	302 histadd({history}, {item}) Number add an item to a history
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	303 histdel({history} [, {item}]) Number remove an item from a history
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	304 histget({history} [, {index}]) String get the item {index} from a history
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	305 histnr({history}) Number highest index of a history
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	306 hlID({name}) Number syntax ID of highlight group {name}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	307 hlexists({name}) Number \|TRUE\| if highlight group {name} exists
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	308 hlget([{name} [, {resolve}]]) List get highlight group attributes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	309 hlset({list}) Number set highlight group attributes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	310 hostname() String name of the machine Vim is running on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	311 iconv({expr}, {from}, {to}) String convert encoding of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	312 indent({lnum}) Number indent of line {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	313 index({object}, {expr} [, {start} [, {ic}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	314 Number index in {object} where {expr} appears
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	315 indexof({object}, {expr} [, {opts}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	316 Number index in {object} where {expr} is true
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	317 input({prompt} [, {text} [, {completion}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	318 String get input from the user
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	319 inputdialog({prompt} [, {text} [, {cancelreturn}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	320 String like input() but in a GUI dialog
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	321 inputlist({textlist}) Number let the user pick from a choice list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	322 inputrestore() Number restore typeahead
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	323 inputsave() Number save and clear typeahead
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	324 inputsecret({prompt} [, {text}]) String like input() but hiding the text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	325 insert({object}, {item} [, {idx}]) List insert {item} in {object} [before {idx}]
32972 e4851934751a patch 9.0.1786: Vim9: need instanceof() function Christian Brabandt <cb@256bit.org> parents: 32947 diff changeset	326 instanceof({object}, {class}) Number \|TRUE\| if {object} is an instance of {class}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	327 interrupt() none interrupt script execution
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	328 invert({expr}) Number bitwise invert
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	329 isabsolutepath({path}) Number \|TRUE\| if {path} is an absolute path
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	330 isdirectory({directory}) Number \|TRUE\| if {directory} is a directory
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	331 isinf({expr}) Number determine if {expr} is infinity value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	332 (positive or negative)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	333 islocked({expr}) Number \|TRUE\| if {expr} is locked
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	334 isnan({expr}) Number \|TRUE\| if {expr} is NaN
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	335 items({dict}) List key-value pairs in {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	336 job_getchannel({job}) Channel get the channel handle for {job}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	337 job_info([{job}]) Dict get information about {job}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	338 job_setoptions({job}, {options}) none set options for {job}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	339 job_start({command} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	340 Job start a job
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	341 job_status({job}) String get the status of {job}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	342 job_stop({job} [, {how}]) Number stop {job}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	343 join({list} [, {sep}]) String join {list} items into one String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	344 js_decode({string}) any decode JS style JSON
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	345 js_encode({expr}) String encode JS style JSON
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	346 json_decode({string}) any decode JSON
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	347 json_encode({expr}) String encode JSON
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	348 keys({dict}) List keys in {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	349 keytrans({string}) String translate internal keycodes to a form
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	350 that can be used by \|:map\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	351 len({expr}) Number the length of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	352 libcall({lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	353 libcallnr({lib}, {func}, {arg}) Number idem, but return a Number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	354 line({expr} [, {winid}]) Number line nr of cursor, last line or mark
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	355 line2byte({lnum}) Number byte count of line {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	356 lispindent({lnum}) Number Lisp indent for line {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	357 list2blob({list}) Blob turn {list} of numbers into a Blob
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	358 list2str({list} [, {utf8}]) String turn {list} of numbers into a String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	359 listener_add({callback} [, {buf}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	360 Number add a callback to listen to changes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	361 listener_flush([{buf}]) none invoke listener callbacks
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	362 listener_remove({id}) none remove a listener callback
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	363 localtime() Number current time
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	364 log({expr}) Float natural logarithm (base e) of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	365 log10({expr}) Float logarithm of Float {expr} to base 10
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	366 luaeval({expr} [, {expr}]) any evaluate \|Lua\| expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	367 map({expr1}, {expr2}) List/Dict/Blob/String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	368 change each item in {expr1} to {expr2}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	369 maparg({name} [, {mode} [, {abbr} [, {dict}]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	370 String or Dict
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	371 rhs of mapping {name} in mode {mode}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	372 mapcheck({name} [, {mode} [, {abbr}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	373 String check for mappings matching {name}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	374 maplist([{abbr}]) List list of all mappings, a dict for each
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	375 mapnew({expr1}, {expr2}) List/Dict/Blob/String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	376 like \|map()\| but creates a new List or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	377 Dictionary
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	378 mapset({mode}, {abbr}, {dict}) none restore mapping from \|maparg()\| result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	379 match({expr}, {pat} [, {start} [, {count}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	380 Number position where {pat} matches in {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	381 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	382 Number highlight {pattern} with {group}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	383 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	384 Number highlight positions with {group}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	385 matcharg({nr}) List arguments of \|:match\|
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	386 matchbufline({buf}, {pat}, {lnum}, {end}, [, {dict})
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	387 List all the {pat} matches in buffer {buf}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	388 matchdelete({id} [, {win}]) Number delete match identified by {id}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	389 matchend({expr}, {pat} [, {start} [, {count}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	390 Number position where {pat} ends in {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	391 matchfuzzy({list}, {str} [, {dict}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	392 List fuzzy match {str} in {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	393 matchfuzzypos({list}, {str} [, {dict}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	394 List fuzzy match {str} in {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	395 matchlist({expr}, {pat} [, {start} [, {count}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	396 List match and submatches of {pat} in {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	397 matchstr({expr}, {pat} [, {start} [, {count}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	398 String {count}'th match of {pat} in {expr}
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	399 matchstrlist({list}, {pat} [, {dict})
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	400 List all the {pat} matches in {list}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	401 matchstrpos({expr}, {pat} [, {start} [, {count}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	402 List {count}'th match of {pat} in {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	403 max({expr}) Number maximum value of items in {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	404 menu_info({name} [, {mode}]) Dict get menu item information
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	405 min({expr}) Number minimum value of items in {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	406 mkdir({name} [, {flags} [, {prot}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	407 Number create directory {name}
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	408 mode([{expr}]) String current editing mode
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	409 mzeval({expr}) any evaluate \|MzScheme\| expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	410 nextnonblank({lnum}) Number line nr of non-blank line >= {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	411 nr2char({expr} [, {utf8}]) String single char with ASCII/UTF-8 value {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	412 or({expr}, {expr}) Number bitwise OR
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	413 pathshorten({expr} [, {len}]) String shorten directory names in a path
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	414 perleval({expr}) any evaluate \|Perl\| expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	415 popup_atcursor({what}, {options}) Number create popup window near the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	416 popup_beval({what}, {options}) Number create popup window for 'ballooneval'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	417 popup_clear() none close all popup windows
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	418 popup_close({id} [, {result}]) none close popup window {id}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	419 popup_create({what}, {options}) Number create a popup window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	420 popup_dialog({what}, {options}) Number create a popup window used as a dialog
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	421 popup_filter_menu({id}, {key}) Number filter for a menu popup window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	422 popup_filter_yesno({id}, {key}) Number filter for a dialog popup window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	423 popup_findecho() Number get window ID of popup for `:echowin`
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	424 popup_findinfo() Number get window ID of info popup window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	425 popup_findpreview() Number get window ID of preview popup window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	426 popup_getoptions({id}) Dict get options of popup window {id}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	427 popup_getpos({id}) Dict get position of popup window {id}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	428 popup_hide({id}) none hide popup menu {id}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	429 popup_list() List get a list of window IDs of all popups
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	430 popup_locate({row}, {col}) Number get window ID of popup at position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	431 popup_menu({what}, {options}) Number create a popup window used as a menu
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	432 popup_move({id}, {options}) none set position of popup window {id}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	433 popup_notification({what}, {options})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	434 Number create a notification popup window
35461 5301104f466a patch 9.1.0500: cannot switch buffer in a popup Christian Brabandt <cb@256bit.org> parents: 35446 diff changeset	435 popup_setbuf({id}, {buf}) Bool set the buffer for the popup window {id}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	436 popup_setoptions({id}, {options})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	437 none set options for popup window {id}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	438 popup_settext({id}, {text}) none set the text of popup window {id}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	439 popup_show({id}) none unhide popup window {id}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	440 pow({x}, {y}) Float {x} to the power of {y}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	441 prevnonblank({lnum}) Number line nr of non-blank line <= {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	442 printf({fmt}, {expr1}...) String format text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	443 prompt_getprompt({buf}) String get prompt text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	444 prompt_setcallback({buf}, {expr}) none set prompt callback function
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	445 prompt_setinterrupt({buf}, {text}) none set prompt interrupt function
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	446 prompt_setprompt({buf}, {text}) none set prompt text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	447 prop_add({lnum}, {col}, {props}) none add one text property
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	448 prop_add_list({props}, [[{lnum}, {col}, {end-lnum}, {end-col}], ...])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	449 none add multiple text properties
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	450 prop_clear({lnum} [, {lnum-end} [, {props}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	451 none remove all text properties
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	452 prop_find({props} [, {direction}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	453 Dict search for a text property
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	454 prop_list({lnum} [, {props}]) List text properties in {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	455 prop_remove({props} [, {lnum} [, {lnum-end}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	456 Number remove a text property
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	457 prop_type_add({name}, {props}) none define a new property type
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	458 prop_type_change({name}, {props})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	459 none change an existing property type
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	460 prop_type_delete({name} [, {props}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	461 none delete a property type
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	462 prop_type_get({name} [, {props}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	463 Dict get property type values
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	464 prop_type_list([{props}]) List get list of property types
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	465 pum_getpos() Dict position and size of pum if visible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	466 pumvisible() Number whether popup menu is visible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	467 py3eval({expr}) any evaluate \|python3\| expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	468 pyeval({expr}) any evaluate \|Python\| expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	469 pyxeval({expr}) any evaluate \|python_x\| expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	470 rand([{expr}]) Number get pseudo-random number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	471 range({expr} [, {max} [, {stride}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	472 List items from {expr} to {max}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	473 readblob({fname} [, {offset} [, {size}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	474 Blob read a \|Blob\| from {fname}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	475 readdir({dir} [, {expr} [, {dict}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	476 List file names in {dir} selected by {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	477 readdirex({dir} [, {expr} [, {dict}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	478 List file info in {dir} selected by {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	479 readfile({fname} [, {type} [, {max}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	480 List get list of lines from file {fname}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	481 reduce({object}, {func} [, {initial}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	482 any reduce {object} using {func}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	483 reg_executing() String get the executing register name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	484 reg_recording() String get the recording register name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	485 reltime([{start} [, {end}]]) List get time value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	486 reltimefloat({time}) Float turn the time value into a Float
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	487 reltimestr({time}) String turn time value into a String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	488 remote_expr({server}, {string} [, {idvar} [, {timeout}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	489 String send expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	490 remote_foreground({server}) Number bring Vim server to the foreground
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	491 remote_peek({serverid} [, {retvar}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	492 Number check for reply string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	493 remote_read({serverid} [, {timeout}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	494 String read reply string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	495 remote_send({server}, {string} [, {idvar}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	496 String send key sequence
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	497 remote_startserver({name}) none become server {name}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	498 remove({list}, {idx} [, {end}]) any/List
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	499 remove items {idx}-{end} from {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	500 remove({blob}, {idx} [, {end}]) Number/Blob
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	501 remove bytes {idx}-{end} from {blob}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	502 remove({dict}, {key}) any remove entry {key} from {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	503 rename({from}, {to}) Number rename (move) file from {from} to {to}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	504 repeat({expr}, {count}) List/Blob/String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	505 repeat {expr} {count} times
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	506 resolve({filename}) String get filename a shortcut points to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	507 reverse({obj}) List/Blob/String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	508 reverse {obj}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	509 round({expr}) Float round off {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	510 rubyeval({expr}) any evaluate \|Ruby\| expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	511 screenattr({row}, {col}) Number attribute at screen position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	512 screenchar({row}, {col}) Number character at screen position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	513 screenchars({row}, {col}) List List of characters at screen position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	514 screencol() Number current cursor column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	515 screenpos({winid}, {lnum}, {col}) Dict screen row and col of a text character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	516 screenrow() Number current cursor row
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	517 screenstring({row}, {col}) String characters at screen position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	518 search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	519 Number search for {pattern}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	520 searchcount([{options}]) Dict get or update search stats
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	521 searchdecl({name} [, {global} [, {thisblock}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	522 Number search for variable declaration
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	523 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	524 Number search for other end of start/end pair
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	525 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	526 List search for other end of start/end pair
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	527 searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	528 List search for {pattern}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	529 server2client({clientid}, {string})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	530 Number send reply string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	531 serverlist() String get a list of available servers
35507 1a7250350167 runtime(doc): In builtin overview use {buf} as param for appendbufline/setbufline (#15089) Christian Brabandt <cb@256bit.org> parents: 35484 diff changeset	532 setbufline({buf}, {lnum}, {text})
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	533 Number set line {lnum} to {text} in buffer
35507 1a7250350167 runtime(doc): In builtin overview use {buf} as param for appendbufline/setbufline (#15089) Christian Brabandt <cb@256bit.org> parents: 35484 diff changeset	534 {buf}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	535 setbufvar({buf}, {varname}, {val})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	536 none set {varname} in buffer {buf} to {val}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	537 setcellwidths({list}) none set character cell width overrides
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	538 setcharpos({expr}, {list}) Number set the {expr} position to {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	539 setcharsearch({dict}) Dict set character search from {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	540 setcmdline({str} [, {pos}]) Number set command-line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	541 setcmdpos({pos}) Number set cursor position in command-line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	542 setcursorcharpos({list}) Number move cursor to position in {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	543 setenv({name}, {val}) none set environment variable
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	544 setfperm({fname}, {mode}) Number set {fname} file permissions to {mode}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	545 setline({lnum}, {line}) Number set line {lnum} to {line}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	546 setloclist({nr}, {list} [, {action}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	547 Number modify location list using {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	548 setloclist({nr}, {list}, {action}, {what})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	549 Number modify specific location list props
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	550 setmatches({list} [, {win}]) Number restore a list of matches
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	551 setpos({expr}, {list}) Number set the {expr} position to {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	552 setqflist({list} [, {action}]) Number modify quickfix list using {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	553 setqflist({list}, {action}, {what})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	554 Number modify specific quickfix list props
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	555 setreg({n}, {v} [, {opt}]) Number set register to value and type
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	556 settabvar({nr}, {varname}, {val}) none set {varname} in tab page {nr} to {val}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	557 settabwinvar({tabnr}, {winnr}, {varname}, {val})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	558 none set {varname} in window {winnr} in tab
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	559 page {tabnr} to {val}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	560 settagstack({nr}, {dict} [, {action}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	561 Number modify tag stack using {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	562 setwinvar({nr}, {varname}, {val}) none set {varname} in window {nr} to {val}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	563 sha256({string}) String SHA256 checksum of {string}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	564 shellescape({string} [, {special}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	565 String escape {string} for use as shell
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	566 command argument
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	567 shiftwidth([{col}]) Number effective value of 'shiftwidth'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	568 sign_define({name} [, {dict}]) Number define or update a sign
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	569 sign_define({list}) List define or update a list of signs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	570 sign_getdefined([{name}]) List get a list of defined signs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	571 sign_getplaced([{buf} [, {dict}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	572 List get a list of placed signs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	573 sign_jump({id}, {group}, {buf})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	574 Number jump to a sign
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	575 sign_place({id}, {group}, {name}, {buf} [, {dict}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	576 Number place a sign
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	577 sign_placelist({list}) List place a list of signs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	578 sign_undefine([{name}]) Number undefine a sign
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	579 sign_undefine({list}) List undefine a list of signs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	580 sign_unplace({group} [, {dict}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	581 Number unplace a sign
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	582 sign_unplacelist({list}) List unplace a list of signs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	583 simplify({filename}) String simplify filename as much as possible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	584 sin({expr}) Float sine of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	585 sinh({expr}) Float hyperbolic sine of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	586 slice({expr}, {start} [, {end}]) String, List or Blob
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	587 slice of a String, List or Blob
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	588 sort({list} [, {how} [, {dict}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	589 List sort {list}, compare with {how}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	590 sound_clear() none stop playing all sounds
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	591 sound_playevent({name} [, {callback}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	592 Number play an event sound
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	593 sound_playfile({path} [, {callback}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	594 Number play sound file {path}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	595 sound_stop({id}) none stop playing sound {id}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	596 soundfold({word}) String sound-fold {word}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	597 spellbadword() String badly spelled word at cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	598 spellsuggest({word} [, {max} [, {capital}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	599 List spelling suggestions
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	600 split({expr} [, {pat} [, {keepempty}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	601 List make \|List\| from {pat} separated {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	602 sqrt({expr}) Float square root of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	603 srand([{expr}]) List get seed for \|rand()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	604 state([{what}]) String current state of Vim
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	605 str2float({expr} [, {quoted}]) Float convert String to Float
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	606 str2list({expr} [, {utf8}]) List convert each character of {expr} to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	607 ASCII/UTF-8 value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	608 str2nr({expr} [, {base} [, {quoted}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	609 Number convert String to Number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	610 strcharlen({expr}) Number character length of the String {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	611 strcharpart({str}, {start} [, {len} [, {skipcc}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	612 String {len} characters of {str} at
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	613 character {start}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	614 strchars({expr} [, {skipcc}]) Number character count of the String {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	615 strdisplaywidth({expr} [, {col}]) Number display length of the String {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	616 strftime({format} [, {time}]) String format time with a specified format
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	617 strgetchar({str}, {index}) Number get char {index} from {str}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	618 stridx({haystack}, {needle} [, {start}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	619 Number index of {needle} in {haystack}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	620 string({expr}) String String representation of {expr} value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	621 strlen({expr}) Number length of the String {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	622 strpart({str}, {start} [, {len} [, {chars}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	623 String {len} bytes/chars of {str} at
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	624 byte {start}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	625 strptime({format}, {timestring})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	626 Number Convert {timestring} to unix timestamp
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	627 strridx({haystack}, {needle} [, {start}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	628 Number last index of {needle} in {haystack}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	629 strtrans({expr}) String translate string to make it printable
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	630 strutf16len({string} [, {countcc}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	631 Number number of UTF-16 code units in {string}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	632 strwidth({expr}) Number display cell length of the String {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	633 submatch({nr} [, {list}]) String or List
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	634 specific match in ":s" or substitute()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	635 substitute({expr}, {pat}, {sub}, {flags})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	636 String all {pat} in {expr} replaced with {sub}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	637 swapfilelist() List swap files found in 'directory'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	638 swapinfo({fname}) Dict information about swap file {fname}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	639 swapname({buf}) String swap file of buffer {buf}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	640 synID({lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	641 synIDattr({synID}, {what} [, {mode}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	642 String attribute {what} of syntax ID {synID}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	643 synIDtrans({synID}) Number translated syntax ID of {synID}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	644 synconcealed({lnum}, {col}) List info about concealing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	645 synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	646 system({expr} [, {input}]) String output of shell command/filter {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	647 systemlist({expr} [, {input}]) List output of shell command/filter {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	648 tabpagebuflist([{arg}]) List list of buffer numbers in tab page
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	649 tabpagenr([{arg}]) Number number of current or last tab page
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	650 tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	651 tagfiles() List tags files used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	652 taglist({expr} [, {filename}]) List list of tags matching {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	653 tan({expr}) Float tangent of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	654 tanh({expr}) Float hyperbolic tangent of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	655 tempname() String name for a temporary file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	656 term_dumpdiff({filename}, {filename} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	657 Number display difference between two dumps
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	658 term_dumpload({filename} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	659 Number displaying a screen dump
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	660 term_dumpwrite({buf}, {filename} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	661 none dump terminal window contents
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	662 term_getaltscreen({buf}) Number get the alternate screen flag
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	663 term_getansicolors({buf}) List get ANSI palette in GUI color mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	664 term_getattr({attr}, {what}) Number get the value of attribute {what}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	665 term_getcursor({buf}) List get the cursor position of a terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	666 term_getjob({buf}) Job get the job associated with a terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	667 term_getline({buf}, {row}) String get a line of text from a terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	668 term_getscrolled({buf}) Number get the scroll count of a terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	669 term_getsize({buf}) List get the size of a terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	670 term_getstatus({buf}) String get the status of a terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	671 term_gettitle({buf}) String get the title of a terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	672 term_gettty({buf}, [{input}]) String get the tty name of a terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	673 term_list() List get the list of terminal buffers
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	674 term_scrape({buf}, {row}) List get row of a terminal screen
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	675 term_sendkeys({buf}, {keys}) none send keystrokes to a terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	676 term_setansicolors({buf}, {colors})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	677 none set ANSI palette in GUI color mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	678 term_setapi({buf}, {expr}) none set \|terminal-api\| function name prefix
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	679 term_setkill({buf}, {how}) none set signal to stop job in terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	680 term_setrestore({buf}, {command}) none set command to restore terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	681 term_setsize({buf}, {rows}, {cols})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	682 none set the size of a terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	683 term_start({cmd} [, {options}]) Number open a terminal window and run a job
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	684 term_wait({buf} [, {time}]) Number wait for screen to be updated
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	685 terminalprops() Dict properties of the terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	686 test_alloc_fail({id}, {countdown}, {repeat})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	687 none make memory allocation fail
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	688 test_autochdir() none enable 'autochdir' during startup
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	689 test_feedinput({string}) none add key sequence to input buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	690 test_garbagecollect_now() none free memory right now for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	691 test_garbagecollect_soon() none free memory soon for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	692 test_getvalue({string}) any get value of an internal variable
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	693 test_gui_event({event}, {args}) bool generate a GUI event for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	694 test_ignore_error({expr}) none ignore a specific error
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	695 test_mswin_event({event}, {args})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	696 bool generate MS-Windows event for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	697 test_null_blob() Blob null value for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	698 test_null_channel() Channel null value for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	699 test_null_dict() Dict null value for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	700 test_null_function() Funcref null value for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	701 test_null_job() Job null value for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	702 test_null_list() List null value for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	703 test_null_partial() Funcref null value for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	704 test_null_string() String null value for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	705 test_option_not_set({name}) none reset flag indicating option was set
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	706 test_override({expr}, {val}) none test with Vim internal overrides
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	707 test_refcount({expr}) Number get the reference count of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	708 test_setmouse({row}, {col}) none set the mouse position for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	709 test_settime({expr}) none set current time for testing
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	710 test_srand_seed([{seed}]) none set seed for testing srand()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	711 test_unknown() any unknown value for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	712 test_void() any void value for testing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	713 timer_info([{id}]) List information about timers
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	714 timer_pause({id}, {pause}) none pause or unpause a timer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	715 timer_start({time}, {callback} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	716 Number create a timer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	717 timer_stop({timer}) none stop a timer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	718 timer_stopall() none stop all timers
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	719 tolower({expr}) String the String {expr} switched to lowercase
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	720 toupper({expr}) String the String {expr} switched to uppercase
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	721 tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	722 to chars in {tostr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	723 trim({text} [, {mask} [, {dir}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	724 String trim characters in {mask} from {text}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	725 trunc({expr}) Float truncate Float {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	726 type({expr}) Number type of value {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	727 typename({expr}) String representation of the type of {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	728 undofile({name}) String undo file name for {name}
32732 257ab4ee8e4a patch 9.0.1686: undotree() only works for the current buffer Christian Brabandt <cb@256bit.org> parents: 32711 diff changeset	729 undotree([{buf}]) List undo file tree for buffer {buf}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	730 uniq({list} [, {func} [, {dict}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	731 List remove adjacent duplicates from a list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	732 utf16idx({string}, {idx} [, {countcc} [, {charidx}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	733 Number UTF-16 index of byte {idx} in {string}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	734 values({dict}) List values in {dict}
32830 6e53cf9745f4 patch 9.0.1728: missing winid argument for virtcol() Christian Brabandt <cb@256bit.org> parents: 32828 diff changeset	735 virtcol({expr} [, {list} [, {winid}])
6e53cf9745f4 patch 9.0.1728: missing winid argument for virtcol() Christian Brabandt <cb@256bit.org> parents: 32828 diff changeset	736 Number or List
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	737 screen column of cursor or mark
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	738 virtcol2col({winid}, {lnum}, {col})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	739 Number byte index of a character on screen
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	740 visualmode([{expr}]) String last visual mode used
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	741 wildmenumode() Number whether 'wildmenu' mode is active
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	742 win_execute({id}, {command} [, {silent}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	743 String execute {command} in window {id}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	744 win_findbuf({bufnr}) List find windows containing {bufnr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	745 win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	746 win_gettype([{nr}]) String type of window {nr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	747 win_gotoid({expr}) Number go to window with ID {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	748 win_id2tabwin({expr}) List get tab and window nr from window ID
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	749 win_id2win({expr}) Number get window nr from window ID
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	750 win_move_separator({nr}) Number move window vertical separator
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	751 win_move_statusline({nr}) Number move window status line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	752 win_screenpos({nr}) List get screen position of window {nr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	753 win_splitmove({nr}, {target} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	754 Number move window {nr} to split of {target}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	755 winbufnr({nr}) Number buffer number of window {nr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	756 wincol() Number window column of the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	757 windowsversion() String MS-Windows OS version
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	758 winheight({nr}) Number height of window {nr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	759 winlayout([{tabnr}]) List layout of windows in tab {tabnr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	760 winline() Number window line of the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	761 winnr([{expr}]) Number number of current window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	762 winrestcmd() String returns command to restore window sizes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	763 winrestview({dict}) none restore view of current window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	764 winsaveview() Dict save view of current window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	765 winwidth({nr}) Number width of window {nr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	766 wordcount() Dict get byte/char/word statistics
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	767 writefile({object}, {fname} [, {flags}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	768 Number write \|Blob\| or \|List\| of lines to file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	769 xor({expr}, {expr}) Number bitwise XOR
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	770
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	771 ==============================================================================
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	772 2. Details builtin-function-details
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	773
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	774 Not all functions are here, some have been moved to a help file covering the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	775 specific functionality.
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	776 Return type specifies the type for \|Vim9-script\|, see \|vim9-types\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	777
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	778 abs({expr}) abs()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	779 Return the absolute value of {expr}. When {expr} evaluates to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	780 a \|Float\| abs() returns a \|Float\|. When {expr} can be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	781 converted to a \|Number\| abs() returns a \|Number\|. Otherwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	782 abs() gives an error message and returns -1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	783 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	784 echo abs(1.456)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	785 < 1.456 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	786 echo abs(-5.456)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	787 < 5.456 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	788 echo abs(-4)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	789 < 4
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	790
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	791 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	792 Compute()->abs()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	793 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	794 Return type: \|Number\| or \|Float\| depending on {expr}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	795
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	796
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	797 acos({expr}) acos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	798 Return the arc cosine of {expr} measured in radians, as a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	799 \|Float\| in the range of [0, pi].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	800 {expr} must evaluate to a \|Float\| or a \|Number\| in the range
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	801 [-1, 1]. Otherwise acos() returns "nan".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	802 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	803 :echo acos(0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	804 < 1.570796 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	805 :echo acos(-0.5)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	806 < 2.094395
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	807
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	808 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	809 Compute()->acos()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	810 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	811 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	812
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	813
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	814 add({object}, {expr}) add()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	815 Append the item {expr} to \|List\| or \|Blob\| {object}. Returns
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	816 the resulting \|List\| or \|Blob\|. Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	817 :let alist = add([1, 2, 3], item)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	818 :call add(mylist, "woodstock")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	819 < Note that when {expr} is a \|List\| it is appended as a single
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	820 item. Use \|extend()\| to concatenate \|Lists\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	821 When {object} is a \|Blob\| then {expr} must be a number.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	822 Use \|insert()\| to add an item at another position.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	823 Returns 1 if {object} is not a \|List\| or a \|Blob\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	824
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	825 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	826 mylist->add(val1)->add(val2)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	827 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	828 Return type: list<{type}> (depending on the given \|List\|) or
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	829 \|Blob\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	830
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	831
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	832 and({expr}, {expr}) and()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	833 Bitwise AND on the two arguments. The arguments are converted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	834 to a number. A List, Dict or Float argument causes an error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	835 Also see `or()` and `xor()`.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	836 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	837 :let flag = and(bits, 0x80)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	838 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	839 :let flag = bits->and(0x80)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	840 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	841 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	842
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	843
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	844 append({lnum}, {text}) append()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	845 When {text} is a \|List\|: Append each item of the \|List\| as a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	846 text line below line {lnum} in the current buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	847 Otherwise append {text} as one text line below line {lnum} in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	848 the current buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	849 Any type of item is accepted and converted to a String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	850 {lnum} can be zero to insert a line before the first one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	851 {lnum} is used like with \|getline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	852 Returns 1 for failure ({lnum} out of range or out of memory),
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	853 0 for success. When {text} is an empty list zero is returned,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	854 no matter the value of {lnum}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	855 In \|Vim9\| script an invalid argument or negative number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	856 results in an error. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	857 :let failed = append(line('$'), "# THE END")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	858 :let failed = append(0, ["Chapter 1", "the beginning"])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	859
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	860 < Can also be used as a \|method\| after a List, the base is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	861 passed as the second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	862 mylist->append(lnum)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	863 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	864 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	865
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	866
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	867 appendbufline({buf}, {lnum}, {text}) appendbufline()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	868 Like \|append()\| but append the text in buffer {buf}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	869
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	870 This function works only for loaded buffers. First call
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	871 \|bufload()\| if needed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	872
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	873 For the use of {buf}, see \|bufname()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	874
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	875 {lnum} is the line number to append below. Note that using
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	876 \|line()\| would use the current buffer, not the one appending
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	877 to. Use "$" to append at the end of the buffer. Other string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	878 values are not supported.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	879
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	880 On success 0 is returned, on failure 1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	881 In \|Vim9\| script an error is given for an invalid {lnum}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	882
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	883 If {buf} is not a valid buffer or {lnum} is not valid, an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	884 error message is given. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	885 :let failed = appendbufline(13, 0, "# THE START")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	886 < However, when {text} is an empty list then no error is given
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	887 for an invalid {lnum}, since {lnum} isn't actually used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	888
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	889 Can also be used as a \|method\| after a List, the base is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	890 passed as the second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	891 mylist->appendbufline(buf, lnum)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	892 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	893 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	894
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	895
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	896 argc([{winid}]) argc()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	897 The result is the number of files in the argument list. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	898 \|arglist\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	899 If {winid} is not supplied, the argument list of the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	900 window is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	901 If {winid} is -1, the global argument list is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	902 Otherwise {winid} specifies the window of which the argument
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	903 list is used: either the window number or the window ID.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	904 Returns -1 if the {winid} argument is invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	905
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	906 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	907
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	908 argidx()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	909 argidx() The result is the current index in the argument list. 0 is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	910 the first file. argc() - 1 is the last one. See \|arglist\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	911
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	912 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	913
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	914 arglistid()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	915 arglistid([{winnr} [, {tabnr}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	916 Return the argument list ID. This is a number which
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	917 identifies the argument list being used. Zero is used for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	918 global argument list. See \|arglist\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	919 Returns -1 if the arguments are invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	920
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	921 Without arguments use the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	922 With {winnr} only use this window in the current tab page.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	923 With {winnr} and {tabnr} use the window in the specified tab
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	924 page.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	925 {winnr} can be the window number or the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	926
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	927 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	928
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	929 argv()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	930 argv([{nr} [, {winid}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	931 The result is the {nr}th file in the argument list. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	932 \|arglist\|. "argv(0)" is the first one. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	933 :let i = 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	934 :while i < argc()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	935 : let f = escape(fnameescape(argv(i)), '.')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	936 : exe 'amenu Arg.' .. f .. ' :e ' .. f .. '<CR>'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	937 : let i = i + 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	938 :endwhile
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	939 < Without the {nr} argument, or when {nr} is -1, a \|List\| with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	940 the whole \|arglist\| is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	941
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	942 The {winid} argument specifies the window ID, see \|argc()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	943 For the Vim command line arguments see \|v:argv\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	944
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	945 Returns an empty string if {nr}th argument is not present in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	946 the argument list. Returns an empty List if the {winid}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	947 argument is invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	948
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	949 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	950
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	951
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	952 asin({expr}) asin()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	953 Return the arc sine of {expr} measured in radians, as a \|Float\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	954 in the range of [-pi/2, pi/2].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	955 {expr} must evaluate to a \|Float\| or a \|Number\| in the range
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	956 [-1, 1].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	957 Returns "nan" if {expr} is outside the range [-1, 1]. Returns
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	958 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	959 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	960 :echo asin(0.8)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	961 < 0.927295 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	962 :echo asin(-0.5)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	963 < -0.523599
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	964
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	965 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	966 Compute()->asin()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	967 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	968 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	969
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	970 assert_ functions are documented here: \|assert-functions-details\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	971
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	972
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	973 atan({expr}) atan()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	974 Return the principal value of the arc tangent of {expr}, in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	975 the range [-pi/2, +pi/2] radians, as a \|Float\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	976 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	977 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	978 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	979 :echo atan(100)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	980 < 1.560797 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	981 :echo atan(-4.01)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	982 < -1.326405
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	983
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	984 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	985 Compute()->atan()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	986 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	987 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	988
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	989
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	990 atan2({expr1}, {expr2}) atan2()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	991 Return the arc tangent of {expr1} / {expr2}, measured in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	992 radians, as a \|Float\| in the range [-pi, pi].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	993 {expr1} and {expr2} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	994 Returns 0.0 if {expr1} or {expr2} is not a \|Float\| or a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	995 \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	996 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	997 :echo atan2(-1, 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	998 < -0.785398 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	999 :echo atan2(1, -1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1000 < 2.356194
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1001
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1002 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1003 Compute()->atan2(1)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1004 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1005 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1006
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1007
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1008 autocmd_add({acmds}) autocmd_add()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1009 Adds a List of autocmds and autocmd groups.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1010
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1011 The {acmds} argument is a List where each item is a Dict with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1012 the following optional items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1013 bufnr buffer number to add a buffer-local autocmd.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1014 If this item is specified, then the "pattern"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1015 item is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1016 cmd Ex command to execute for this autocmd event
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1017 event autocmd event name. Refer to \|autocmd-events\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1018 This can be either a String with a single
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1019 event name or a List of event names.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1020 group autocmd group name. Refer to \|autocmd-groups\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1021 If this group doesn't exist then it is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1022 created. If not specified or empty, then the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1023 default group is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1024 nested boolean flag, set to v:true to add a nested
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1025 autocmd. Refer to \|autocmd-nested\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1026 once boolean flag, set to v:true to add an autocmd
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1027 which executes only once. Refer to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1028 \|autocmd-once\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1029 pattern autocmd pattern string. Refer to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1030 \|autocmd-patterns\|. If "bufnr" item is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1031 present, then this item is ignored. This can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1032 be a String with a single pattern or a List of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1033 patterns.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1034 replace boolean flag, set to v:true to remove all the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1035 commands associated with the specified autocmd
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1036 event and group and add the {cmd}. This is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1037 useful to avoid adding the same command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1038 multiple times for an autocmd event in a group.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1039
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1040 Returns v:true on success and v:false on failure.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1041 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1042 " Create a buffer-local autocmd for buffer 5
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1043 let acmd = {}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1044 let acmd.group = 'MyGroup'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1045 let acmd.event = 'BufEnter'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1046 let acmd.bufnr = 5
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1047 let acmd.cmd = 'call BufEnterFunc()'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1048 call autocmd_add([acmd])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1049 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1050 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1051 GetAutocmdList()->autocmd_add()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1052 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1053 Return type: \|vim9-boolean\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1054
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1055
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1056 autocmd_delete({acmds}) autocmd_delete()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1057 Deletes a List of autocmds and autocmd groups.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1058
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1059 The {acmds} argument is a List where each item is a Dict with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1060 the following optional items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1061 bufnr buffer number to delete a buffer-local autocmd.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1062 If this item is specified, then the "pattern"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1063 item is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1064 cmd Ex command for this autocmd event
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1065 event autocmd event name. Refer to \|autocmd-events\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1066 If '*' then all the autocmd events in this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1067 group are deleted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1068 group autocmd group name. Refer to \|autocmd-groups\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1069 If not specified or empty, then the default
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1070 group is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1071 nested set to v:true for a nested autocmd.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1072 Refer to \|autocmd-nested\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1073 once set to v:true for an autocmd which executes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1074 only once. Refer to \|autocmd-once\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1075 pattern autocmd pattern string. Refer to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1076 \|autocmd-patterns\|. If "bufnr" item is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1077 present, then this item is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1078
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1079 If only {group} is specified in a {acmds} entry and {event},
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1080 {pattern} and {cmd} are not specified, then that autocmd group
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1081 is deleted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1082
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1083 Returns \|v:true\| on success and \|v:false\| on failure.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1084 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1085 " :autocmd! BufLeave *.vim
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1086 let acmd = #{event: 'BufLeave', pattern: '*.vim'}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1087 call autocmd_delete([acmd]})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1088 " :autocmd! MyGroup1 BufLeave
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1089 let acmd = #{group: 'MyGroup1', event: 'BufLeave'}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1090 call autocmd_delete([acmd])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1091 " :autocmd! MyGroup2 BufEnter *.c
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1092 let acmd = #{group: 'MyGroup2', event: 'BufEnter',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1093 \ pattern: '*.c'}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1094 " :autocmd! MyGroup2 * *.c
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1095 let acmd = #{group: 'MyGroup2', event: '*',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1096 \ pattern: '*.c'}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1097 call autocmd_delete([acmd])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1098 " :autocmd! MyGroup3
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1099 let acmd = #{group: 'MyGroup3'}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1100 call autocmd_delete([acmd])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1101 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1102 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1103 GetAutocmdList()->autocmd_delete()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1104 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1105 Return type: \|vim9-boolean\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1106
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1107
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1108 autocmd_get([{opts}]) autocmd_get()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1109 Returns a \|List\| of autocmds. If {opts} is not supplied, then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1110 returns the autocmds for all the events in all the groups.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1111
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1112 The optional {opts} Dict argument supports the following
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1113 items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1114 group Autocmd group name. If specified, returns only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1115 the autocmds defined in this group. If the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1116 specified group doesn't exist, results in an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1117 error message. If set to an empty string,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1118 then the default autocmd group is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1119 event Autocmd event name. If specified, returns only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1120 the autocmds defined for this event. If set
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1121 to "*", then returns autocmds for all the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1122 events. If the specified event doesn't exist,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1123 results in an error message.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1124 pattern Autocmd pattern. If specified, returns only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1125 the autocmds defined for this pattern.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1126 A combination of the above three times can be supplied in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1127 {opts}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1128
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1129 Each Dict in the returned List contains the following items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1130 bufnr For buffer-local autocmds, buffer number where
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1131 the autocmd is defined.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1132 cmd Command executed for this autocmd.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1133 event Autocmd event name.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1134 group Autocmd group name.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1135 nested Boolean flag, set to v:true for a nested
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1136 autocmd. See \|autocmd-nested\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1137 once Boolean flag, set to v:true, if the autocmd
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1138 will be executed only once. See \|autocmd-once\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1139 pattern Autocmd pattern. For a buffer-local
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1140 autocmd, this will be of the form "<buffer=n>".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1141 If there are multiple commands for an autocmd event in a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1142 group, then separate items are returned for each command.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1143
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1144 Returns an empty List if an autocmd with the specified group
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1145 or event or pattern is not found.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1146
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1147 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1148 " :autocmd MyGroup
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1149 echo autocmd_get(#{group: 'Mygroup'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1150 " :autocmd G BufUnload
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1151 echo autocmd_get(#{group: 'G', event: 'BufUnload'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1152 " :autocmd G * *.ts
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1153 let acmd = #{group: 'G', event: '', pattern: '.ts'}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1154 echo autocmd_get(acmd)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1155 " :autocmd Syntax
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1156 echo autocmd_get(#{event: 'Syntax'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1157 " :autocmd G BufEnter *.ts
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1158 let acmd = #{group: 'G', event: 'BufEnter',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1159 \ pattern: '*.ts'}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1160 echo autocmd_get(acmd)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1161 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1162 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1163 Getopts()->autocmd_get()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1164 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1165 Return type: list<dict<any>>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1166
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1167
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1168 balloon_gettext() balloon_gettext()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1169 Return the current text in the balloon. Only for the string,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1170 not used for the List. Returns an empty string if balloon
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1171 is not present.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1172
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1173 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1174
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1175
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1176 balloon_show({expr}) balloon_show()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1177 Show {expr} inside the balloon. For the GUI {expr} is used as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1178 a string. For a terminal {expr} can be a list, which contains
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1179 the lines of the balloon. If {expr} is not a list it will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1180 split with \|balloon_split()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1181 If {expr} is an empty string any existing balloon is removed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1182
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1183 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1184 func GetBalloonContent()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1185 " ... initiate getting the content
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1186 return ''
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1187 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1188 set balloonexpr=GetBalloonContent()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1189
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1190 func BalloonCallback(result)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1191 call balloon_show(a:result)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1192 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1193 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1194 GetText()->balloon_show()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1195 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1196 The intended use is that fetching the content of the balloon
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1197 is initiated from 'balloonexpr'. It will invoke an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1198 asynchronous method, in which a callback invokes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1199 balloon_show(). The 'balloonexpr' itself can return an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1200 empty string or a placeholder, e.g. "loading...".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1201
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1202 When showing a balloon is not possible then nothing happens,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1203 no error message is given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1204 {only available when compiled with the \|+balloon_eval\| or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1205 \|+balloon_eval_term\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1206
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1207 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1208
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1209
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1210 balloon_split({msg}) balloon_split()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1211 Split String {msg} into lines to be displayed in a balloon.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1212 The splits are made for the current window size and optimize
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1213 to show debugger output.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1214 Returns a \|List\| with the split lines. Returns an empty List
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1215 on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1216 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1217 GetText()->balloon_split()->balloon_show()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1218
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1219 < {only available when compiled with the \|+balloon_eval_term\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1220 feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1221
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1222 Return type: list<any> or list<string>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1223
35484 04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	1224 bindtextdomain({package}, {path}) bindtextdomain()
04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	1225 Bind a specific {package} to a {path} so that the
04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	1226 \|gettext()\| function can be used to get language-specific
04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	1227 translations for a package. {path} is the directory name
04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	1228 for the translations. See \|package-create\|.
04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	1229
04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	1230 Return type: none
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1231
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1232 blob2list({blob}) blob2list()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1233 Return a List containing the number value of each byte in Blob
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1234 {blob}. Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1235 blob2list(0z0102.0304) returns [1, 2, 3, 4]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1236 blob2list(0z) returns []
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1237 < Returns an empty List on error. \|list2blob()\| does the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1238 opposite.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1239
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1240 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1241 GetBlob()->blob2list()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1242 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1243 Return type: list<any> or list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1244
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1245 browse()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1246 browse({save}, {title}, {initdir}, {default})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1247 Put up a file requester. This only works when "has("browse")"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1248 returns \|TRUE\| (only in some GUI versions).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1249 The input fields are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1250 {save} when \|TRUE\|, select file to write
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1251 {title} title for the requester
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1252 {initdir} directory to start browsing in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1253 {default} default file name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1254 An empty string is returned when the "Cancel" button is hit,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1255 something went wrong, or browsing is not possible.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1256
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1257 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1258
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1259
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1260 browsedir({title}, {initdir}) browsedir()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1261 Put up a directory requester. This only works when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1262 "has("browse")" returns \|TRUE\| (only in some GUI versions).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1263 On systems where a directory browser is not supported a file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1264 browser is used. In that case: select a file in the directory
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1265 to be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1266 The input fields are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1267 {title} title for the requester
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1268 {initdir} directory to start browsing in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1269 When the "Cancel" button is hit, something went wrong, or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1270 browsing is not possible, an empty string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1271
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1272 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1273
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1274
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1275 bufadd({name}) bufadd()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1276 Add a buffer to the buffer list with name {name} (must be a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1277 String).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1278 If a buffer for file {name} already exists, return that buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1279 number. Otherwise return the buffer number of the newly
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1280 created buffer. When {name} is an empty string then a new
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1281 buffer is always created.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1282 The buffer will not have 'buflisted' set and not be loaded
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1283 yet. To add some text to the buffer use this: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1284 let bufnr = bufadd('someName')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1285 call bufload(bufnr)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1286 call setbufline(bufnr, 1, ['some', 'text'])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1287 < Returns 0 on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1288 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1289 let bufnr = 'somename'->bufadd()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1290 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1291 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1292
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1293
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1294 bufexists({buf}) bufexists()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1295 The result is a Number, which is \|TRUE\| if a buffer called
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1296 {buf} exists.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1297 If the {buf} argument is a number, buffer numbers are used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1298 Number zero is the alternate buffer for the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1299
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1300 If the {buf} argument is a string it must match a buffer name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1301 exactly. The name can be:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1302 - Relative to the current directory.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1303 - A full path.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1304 - The name of a buffer with 'buftype' set to "nofile".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1305 - A URL name.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1306 Unlisted buffers will be found.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1307 Note that help files are listed by their short name in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1308 output of \|:buffers\|, but bufexists() requires using their
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1309 long name to be able to find them.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1310 bufexists() may report a buffer exists, but to use the name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1311 with a \|:buffer\| command you may need to use \|expand()\|. Esp
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1312 for MS-Windows 8.3 names in the form "c:\DOCUME~1"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1313 Use "bufexists(0)" to test for the existence of an alternate
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1314 file name.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1315
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1316 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1317 let exists = 'somename'->bufexists()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1318 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1319 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1320
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1321 Obsolete name: buffer_exists(). buffer_exists()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1322
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1323
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1324 buflisted({buf}) buflisted()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1325 The result is a Number, which is \|TRUE\| if a buffer called
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1326 {buf} exists and is listed (has the 'buflisted' option set).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1327 The {buf} argument is used like with \|bufexists()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1328
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1329 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1330 let listed = 'somename'->buflisted()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1331 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1332 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1333
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1334
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1335 bufload({buf}) bufload()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1336 Ensure the buffer {buf} is loaded. When the buffer name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1337 refers to an existing file then the file is read. Otherwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1338 the buffer will be empty. If the buffer was already loaded
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1339 then there is no change. If the buffer is not related to a
32711 f970e6f29e7d Change "the" to "then" under ':help bufload()' (#12662) Christian Brabandt <cb@256bit.org> parents: 32687 diff changeset	1340 file then no file is read (e.g., when 'buftype' is "nofile").
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1341 If there is an existing swap file for the file of the buffer,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1342 there will be no dialog, the buffer will be loaded anyway.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1343 The {buf} argument is used like with \|bufexists()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1344
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1345 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1346 eval 'somename'->bufload()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1347 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1348 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1349
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1350
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1351 bufloaded({buf}) bufloaded()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1352 The result is a Number, which is \|TRUE\| if a buffer called
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1353 {buf} exists and is loaded (shown in a window or hidden).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1354 The {buf} argument is used like with \|bufexists()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1355
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1356 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1357 let loaded = 'somename'->bufloaded()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1358 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1359 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1360
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1361
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1362 bufname([{buf}]) bufname()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1363 The result is the name of a buffer. Mostly as it is displayed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1364 by the `:ls` command, but not using special names such as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1365 "[No Name]".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1366 If {buf} is omitted the current buffer is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1367 If {buf} is a Number, that buffer number's name is given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1368 Number zero is the alternate buffer for the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1369 If {buf} is a String, it is used as a \|file-pattern\| to match
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1370 with the buffer names. This is always done like 'magic' is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1371 set and 'cpoptions' is empty. When there is more than one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1372 match an empty string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1373 "" or "%" can be used for the current buffer, "#" for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1374 alternate buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1375 A full match is preferred, otherwise a match at the start, end
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1376 or middle of the buffer name is accepted. If you only want a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1377 full match then put "^" at the start and "$" at the end of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1378 pattern.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1379 Listed buffers are found first. If there is a single match
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1380 with a listed buffer, that one is returned. Next unlisted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1381 buffers are searched for.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1382 If the {buf} is a String, but you want to use it as a buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1383 number, force it to be a Number by adding zero to it: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1384 :echo bufname("3" + 0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1385 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1386 echo bufnr->bufname()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1387
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1388 < If the buffer doesn't exist, or doesn't have a name, an empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1389 string is returned. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1390 bufname("#") alternate buffer name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1391 bufname(3) name of buffer 3
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1392 bufname("%") name of current buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1393 bufname("file2") name of buffer where "file2" matches.
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1394 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1395 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1396 buffer_name()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1397 Obsolete name: buffer_name().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1398
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1399
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1400 bufnr([{buf} [, {create}]]) bufnr()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1401 The result is the number of a buffer, as it is displayed by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1402 the `:ls` command. For the use of {buf}, see \|bufname()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1403 above.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1404
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1405 If the buffer doesn't exist, -1 is returned. Or, if the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1406 {create} argument is present and TRUE, a new, unlisted,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1407 buffer is created and its number is returned. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1408 let newbuf = bufnr('Scratch001', 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1409 < Using an empty name uses the current buffer. To create a new
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1410 buffer with an empty name use \|bufadd()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1411
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1412 bufnr("$") is the last buffer: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1413 :let last_buffer = bufnr("$")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1414 < The result is a Number, which is the highest buffer number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1415 of existing buffers. Note that not all buffers with a smaller
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1416 number necessarily exist, because ":bwipeout" may have removed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1417 them. Use bufexists() to test for the existence of a buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1418
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1419 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1420 echo bufref->bufnr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1421 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1422 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1423
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1424 Obsolete name: buffer_number(). buffer_number()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1425 last_buffer_nr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1426 Obsolete name for bufnr("$"): last_buffer_nr().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1427
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1428
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1429 bufwinid({buf}) bufwinid()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1430 The result is a Number, which is the \|window-ID\| of the first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1431 window associated with buffer {buf}. For the use of {buf},
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1432 see \|bufname()\| above. If buffer {buf} doesn't exist or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1433 there is no such window, -1 is returned. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1434
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1435 echo "A window containing buffer 1 is " .. (bufwinid(1))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1436 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1437 Only deals with the current tab page. See \|win_findbuf()\| for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1438 finding more.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1439
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1440 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1441 FindBuffer()->bufwinid()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1442 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1443 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1444
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1445
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1446 bufwinnr({buf}) bufwinnr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1447 Like \|bufwinid()\| but return the window number instead of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1448 \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1449 If buffer {buf} doesn't exist or there is no such window, -1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1450 is returned. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1451
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1452 echo "A window containing buffer 1 is " .. (bufwinnr(1))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1453
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1454 < The number can be used with \|CTRL-W_w\| and ":wincmd w"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1455 \|:wincmd\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1456
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1457 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1458 FindBuffer()->bufwinnr()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1459 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1460 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1461
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1462
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1463 byte2line({byte}) byte2line()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1464 Return the line number that contains the character at byte
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1465 count {byte} in the current buffer. This includes the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1466 end-of-line character, depending on the 'fileformat' option
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1467 for the current buffer. The first character has byte count
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1468 one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1469 Also see \|line2byte()\|, \|go\| and \|:goto\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1470
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1471 Returns -1 if the {byte} value is invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1472
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1473 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1474 GetOffset()->byte2line()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1475 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1476 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1477
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1478 {not available when compiled without the \|+byte_offset\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1479 feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1480
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1481
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1482 byteidx({expr}, {nr} [, {utf16}]) byteidx()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1483 Return byte index of the {nr}'th character in the String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1484 {expr}. Use zero for the first character, it then returns
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1485 zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1486 If there are no multibyte characters the returned value is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1487 equal to {nr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1488 Composing characters are not counted separately, their byte
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1489 length is added to the preceding base character. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1490 \|byteidxcomp()\| below for counting composing characters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1491 separately.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1492 When {utf16} is present and TRUE, {nr} is used as the UTF-16
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1493 index in the String {expr} instead of as the character index.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1494 The UTF-16 index is the index in the string when it is encoded
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1495 with 16-bit words. If the specified UTF-16 index is in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1496 middle of a character (e.g. in a 4-byte character), then the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1497 byte index of the first byte in the character is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1498 Refer to \|string-offset-encoding\| for more information.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1499 Example : >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1500 echo matchstr(str, ".", byteidx(str, 3))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1501 < will display the fourth character. Another way to do the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1502 same: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1503 let s = strpart(str, byteidx(str, 3))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1504 echo strpart(s, 0, byteidx(s, 1))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1505 < Also see \|strgetchar()\| and \|strcharpart()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1506
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1507 If there are less than {nr} characters -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1508 If there are exactly {nr} characters the length of the string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1509 in bytes is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1510 See \|charidx()\| and \|utf16idx()\| for getting the character and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1511 UTF-16 index respectively from the byte index.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1512 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1513 echo byteidx('a😊😊', 2) returns 5
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1514 echo byteidx('a😊😊', 2, 1) returns 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1515 echo byteidx('a😊😊', 3, 1) returns 5
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1516 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1517 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1518 GetName()->byteidx(idx)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1519 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1520 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1521
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1522
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1523 byteidxcomp({expr}, {nr} [, {utf16}]) byteidxcomp()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1524 Like byteidx(), except that a composing character is counted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1525 as a separate character. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1526 let s = 'e' .. nr2char(0x301)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1527 echo byteidx(s, 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1528 echo byteidxcomp(s, 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1529 echo byteidxcomp(s, 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1530 < The first and third echo result in 3 ('e' plus composing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1531 character is 3 bytes), the second echo results in 1 ('e' is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1532 one byte).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1533 Only works differently from byteidx() when 'encoding' is set
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1534 to a Unicode encoding.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1535
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1536 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1537 GetName()->byteidxcomp(idx)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1538 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1539 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1540
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1541
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1542 call({func}, {arglist} [, {dict}]) call() E699
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1543 Call function {func} with the items in \|List\| {arglist} as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1544 arguments.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1545 {func} can either be a \|Funcref\| or the name of a function.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1546 a:firstline and a:lastline are set to the cursor line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1547 Returns the return value of the called function.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1548 {dict} is for functions with the "dict" attribute. It will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1549 used to set the local variable "self". \|Dictionary-function\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1550
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1551 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1552 GetFunc()->call([arg, arg], dict)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1553 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1554 Return type: any, depending on {func}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1555
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1556
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1557 ceil({expr}) ceil()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1558 Return the smallest integral value greater than or equal to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1559 {expr} as a \|Float\| (round up).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1560 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1561 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1562 echo ceil(1.456)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1563 < 2.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1564 echo ceil(-5.456)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1565 < -5.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1566 echo ceil(4.0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1567 < 4.0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1568
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1569 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1570
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1571 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1572 Compute()->ceil()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1573 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1574 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1575
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1576
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1577 ch_ functions are documented here: \|channel-functions-details\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1578
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1579
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1580 changenr() changenr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1581 Return the number of the most recent change. This is the same
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1582 number as what is displayed with \|:undolist\| and can be used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1583 with the \|:undo\| command.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1584 When a change was made it is the number of that change. After
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1585 redo it is the number of the redone change. After undo it is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1586 one less than the number of the undone change.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1587 Returns 0 if the undo list is empty.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1588
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1589 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1590
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1591
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1592 char2nr({string} [, {utf8}]) char2nr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1593 Return Number value of the first char in {string}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1594 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1595 char2nr(" ") returns 32
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1596 char2nr("ABC") returns 65
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1597 < When {utf8} is omitted or zero, the current 'encoding' is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1598 Example for "utf-8": >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1599 char2nr("á") returns 225
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1600 char2nr("á"[0]) returns 195
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1601 < When {utf8} is TRUE, always treat as UTF-8 characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1602 A combining character is a separate character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1603 \|nr2char()\| does the opposite.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1604 To turn a string into a list of character numbers: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1605 let str = "ABC"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1606 let list = map(split(str, '\zs'), {_, val -> char2nr(val)})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1607 < Result: [65, 66, 67]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1608
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1609 Returns 0 if {string} is not a \|String\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1610
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1611 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1612 GetChar()->char2nr()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1613 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1614 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1615
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1616
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1617 charclass({string}) charclass()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1618 Return the character class of the first character in {string}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1619 The character class is one of:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1620 0 blank
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1621 1 punctuation
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1622 2 word character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1623 3 emoji
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1624 other specific Unicode class
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1625 The class is used in patterns and word motions.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1626 Returns 0 if {string} is not a \|String\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1627
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1628 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1629
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1630
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1631 charcol({expr} [, {winid}]) charcol()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1632 Same as \|col()\| but returns the character index of the column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1633 position given with {expr} instead of the byte position.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1634
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1635 Example:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1636 With the cursor on '세' in line 5 with text "여보세요": >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1637 charcol('.') returns 3
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1638 col('.') returns 7
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1639
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1640 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1641 GetPos()->col()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1642 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1643 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1644
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1645 charidx()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1646 charidx({string}, {idx} [, {countcc} [, {utf16}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1647 Return the character index of the byte at {idx} in {string}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1648 The index of the first character is zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1649 If there are no multibyte characters the returned value is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1650 equal to {idx}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1651
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1652 When {countcc} is omitted or \|FALSE\|, then composing characters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1653 are not counted separately, their byte length is added to the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1654 preceding base character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1655 When {countcc} is \|TRUE\|, then composing characters are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1656 counted as separate characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1657
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1658 When {utf16} is present and TRUE, {idx} is used as the UTF-16
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1659 index in the String {expr} instead of as the byte index.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1660
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1661 Returns -1 if the arguments are invalid or if there are less
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1662 than {idx} bytes. If there are exactly {idx} bytes the length
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1663 of the string in characters is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1664
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1665 An error is given and -1 is returned if the first argument is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1666 not a string, the second argument is not a number or when the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1667 third argument is present and is not zero or one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1668
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1669 See \|byteidx()\| and \|byteidxcomp()\| for getting the byte index
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1670 from the character index and \|utf16idx()\| for getting the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1671 UTF-16 index from the character index.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1672 Refer to \|string-offset-encoding\| for more information.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1673 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1674 echo charidx('áb́ć', 3) returns 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1675 echo charidx('áb́ć', 6, 1) returns 4
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1676 echo charidx('áb́ć', 16) returns -1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1677 echo charidx('a😊😊', 4, 0, 1) returns 2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1678 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1679 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1680 GetName()->charidx(idx)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1681 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1682 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1683
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1684
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1685 chdir({dir}) chdir()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1686 Change the current working directory to {dir}. The scope of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1687 the directory change depends on the directory of the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1688 window:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1689 - If the current window has a window-local directory
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1690 (\|:lcd\|), then changes the window local directory.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1691 - Otherwise, if the current tabpage has a local
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1692 directory (\|:tcd\|) then changes the tabpage local
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1693 directory.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1694 - Otherwise, changes the global directory.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1695 {dir} must be a String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1696 If successful, returns the previous working directory. Pass
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1697 this to another chdir() to restore the directory.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1698 On failure, returns an empty string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1699
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1700 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1701 let save_dir = chdir(newdir)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1702 if save_dir != ""
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1703 " ... do some work
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1704 call chdir(save_dir)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1705 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1706
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1707 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1708 GetDir()->chdir()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1709 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1710 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1711
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1712
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1713 cindent({lnum}) cindent()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1714 Get the amount of indent for line {lnum} according the C
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1715 indenting rules, as with 'cindent'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1716 The indent is counted in spaces, the value of 'tabstop' is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1717 relevant. {lnum} is used just like in \|getline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1718 When {lnum} is invalid -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1719 See \|C-indenting\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1720
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1721 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1722 GetLnum()->cindent()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1723 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1724 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1725
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1726
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1727 clearmatches([{win}]) clearmatches()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1728 Clears all matches previously defined for the current window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1729 by \|matchadd()\| and the \|:match\| commands.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1730 If {win} is specified, use the window with this number or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1731 window ID instead of the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1732
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1733 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1734 GetWin()->clearmatches()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1735 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1736 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1737
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1738
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1739 col({expr} [, {winid}]) col()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1740 The result is a Number, which is the byte index of the column
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	1741 position given with {expr}.
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	1742 For accepted positions see \|getpos()\|.
35386 57a8e2f92efd runtime(doc): restore description of "$" in col() and virtcol() (#14981) Christian Brabandt <cb@256bit.org> parents: 35385 diff changeset	1743 When {expr} is "$", it means the end of the cursor line, so
57a8e2f92efd runtime(doc): restore description of "$" in col() and virtcol() (#14981) Christian Brabandt <cb@256bit.org> parents: 35385 diff changeset	1744 the result is the number of bytes in the cursor line plus one.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1745 Additionally {expr} can be [lnum, col]: a \|List\| with the line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1746 and column number. Most useful when the column is "$", to get
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1747 the last column of a specific line. When "lnum" or "col" is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1748 out of range then col() returns zero.
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	1749
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1750 With the optional {winid} argument the values are obtained for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1751 that window instead of the current window.
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	1752
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1753 To get the line number use \|line()\|. To get both use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1754 \|getpos()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1755 For the screen column position use \|virtcol()\|. For the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1756 character position use \|charcol()\|.
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	1757
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1758 Note that only marks in the current file can be used.
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	1759
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1760 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1761 col(".") column of cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1762 col("$") length of cursor line plus one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1763 col("'t") column of mark t
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1764 col("'" .. markname) column of mark markname
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	1765 <
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	1766 The first column is 1. Returns 0 if {expr} is invalid or when
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1767 the window with ID {winid} is not found.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1768 For an uppercase mark the column may actually be in another
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1769 buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1770 For the cursor position, when 'virtualedit' is active, the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1771 column is one higher if the cursor is after the end of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1772 line. Also, when using a <Cmd> mapping the cursor isn't
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1773 moved, this can be used to obtain the column in Insert mode: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1774 :imap <F2> <Cmd>echowin col(".")<CR>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1775
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1776 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1777 GetPos()->col()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1778 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1779 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1780
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1781
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1782 complete({startcol}, {matches}) complete() E785
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1783 Set the matches for Insert mode completion.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1784 Can only be used in Insert mode. You need to use a mapping
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1785 with CTRL-R = (see \|i_CTRL-R\|). It does not work after CTRL-O
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1786 or with an expression mapping.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1787 {startcol} is the byte offset in the line where the completed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1788 text start. The text up to the cursor is the original text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1789 that will be replaced by the matches. Use col('.') for an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1790 empty string. "col('.') - 1" will replace one character by a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1791 match.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1792 {matches} must be a \|List\|. Each \|List\| item is one match.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1793 See \|complete-items\| for the kind of items that are possible.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1794 "longest" in 'completeopt' is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1795 Note that the after calling this function you need to avoid
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1796 inserting anything that would cause completion to stop.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1797 The match can be selected with CTRL-N and CTRL-P as usual with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1798 Insert mode completion. The popup menu will appear if
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1799 specified, see \|ins-completion-menu\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1800 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1801 inoremap <F5> <C-R>=ListMonths()<CR>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1802
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1803 func ListMonths()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1804 call complete(col('.'), ['January', 'February', 'March',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1805 \ 'April', 'May', 'June', 'July', 'August', 'September',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1806 \ 'October', 'November', 'December'])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1807 return ''
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1808 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1809 < This isn't very useful, but it shows how it works. Note that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1810 an empty string is returned to avoid a zero being inserted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1811
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1812 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1813 second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1814 GetMatches()->complete(col('.'))
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1815 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1816 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1817
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1818
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1819 complete_add({expr}) complete_add()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1820 Add {expr} to the list of matches. Only to be used by the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1821 function specified with the 'completefunc' option.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1822 Returns 0 for failure (empty string or out of memory),
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1823 1 when the match was added, 2 when the match was already in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1824 the list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1825 See \|complete-functions\| for an explanation of {expr}. It is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1826 the same as one item in the list that 'omnifunc' would return.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1827
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1828 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1829 GetMoreMatches()->complete_add()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1830 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1831 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1832
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1833
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1834 complete_check() complete_check()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1835 Check for a key typed while looking for completion matches.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1836 This is to be used when looking for matches takes some time.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1837 Returns \|TRUE\| when searching for matches is to be aborted,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1838 zero otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1839 Only to be used by the function specified with the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1840 'completefunc' option.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1841
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1842 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1843
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1844
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1845 complete_info([{what}]) complete_info()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1846 Returns a \|Dictionary\| with information about Insert mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1847 completion. See \|ins-completion\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1848 The items are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1849 mode Current completion mode name string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1850 See \|complete_info_mode\| for the values.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1851 pum_visible \|TRUE\| if popup menu is visible.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1852 See \|pumvisible()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1853 items List of completion matches. Each item is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1854 dictionary containing the entries "word",
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1855 "abbr", "menu", "kind", "info" and "user_data".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1856 See \|complete-items\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1857 selected Selected item index. First index is zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1858 Index is -1 if no item is selected (showing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1859 typed text only, or the last completion after
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1860 no item is selected when using the <Up> or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1861 <Down> keys)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1862 inserted Inserted string. [NOT IMPLEMENTED YET]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1863
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1864 complete_info_mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1865 mode values are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1866 "" Not in completion mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1867 "keyword" Keyword completion \|i_CTRL-X_CTRL-N\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1868 "ctrl_x" Just pressed CTRL-X \|i_CTRL-X\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1869 "scroll" Scrolling with \|i_CTRL-X_CTRL-E\| or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1870 \|i_CTRL-X_CTRL-Y\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1871 "whole_line" Whole lines \|i_CTRL-X_CTRL-L\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1872 "files" File names \|i_CTRL-X_CTRL-F\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1873 "tags" Tags \|i_CTRL-X_CTRL-]\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1874 "path_defines" Definition completion \|i_CTRL-X_CTRL-D\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1875 "path_patterns" Include completion \|i_CTRL-X_CTRL-I\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1876 "dictionary" Dictionary \|i_CTRL-X_CTRL-K\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1877 "thesaurus" Thesaurus \|i_CTRL-X_CTRL-T\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1878 "cmdline" Vim Command line \|i_CTRL-X_CTRL-V\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1879 "function" User defined completion \|i_CTRL-X_CTRL-U\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1880 "omni" Omni completion \|i_CTRL-X_CTRL-O\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1881 "spell" Spelling suggestions \|i_CTRL-X_s\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1882 "eval" \|complete()\| completion
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1883 "unknown" Other internal modes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1884
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1885 If the optional {what} list argument is supplied, then only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1886 the items listed in {what} are returned. Unsupported items in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1887 {what} are silently ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1888
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1889 To get the position and size of the popup menu, see
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1890 \|pum_getpos()\|. It's also available in \|v:event\| during the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1891 \|CompleteChanged\| event.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1892
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1893 Returns an empty \|Dictionary\| on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1894
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1895 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1896 " Get all items
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1897 call complete_info()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1898 " Get only 'mode'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1899 call complete_info(['mode'])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1900 " Get only 'mode' and 'pum_visible'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1901 call complete_info(['mode', 'pum_visible'])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1902
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1903 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1904 GetItems()->complete_info()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1905 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1906 Return type: dict<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1907
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1908 confirm()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1909 confirm({msg} [, {choices} [, {default} [, {type}]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1910 confirm() offers the user a dialog, from which a choice can be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1911 made. It returns the number of the choice. For the first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1912 choice this is 1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1913 Note: confirm() is only supported when compiled with dialog
34780 54890be01c00 patch 9.1.0265: console dialog cannot save unnamed buffers Christian Brabandt <cb@256bit.org> parents: 34779 diff changeset	1914 support, see \|+dialog_con\| \|+dialog_con_gui\| and \|+dialog_gui\|.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1915
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1916 {msg} is displayed in a \|dialog\| with {choices} as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1917 alternatives. When {choices} is missing or empty, "&OK" is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1918 used (and translated).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1919 {msg} is a String, use '\n' to include a newline. Only on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1920 some systems the string is wrapped when it doesn't fit.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1921
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1922 {choices} is a String, with the individual choices separated
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1923 by '\n', e.g. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1924 confirm("Save changes?", "&Yes\n&No\n&Cancel")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1925 < The letter after the '&' is the shortcut key for that choice.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1926 Thus you can type 'c' to select "Cancel". The shortcut does
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1927 not need to be the first letter: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1928 confirm("file has been modified", "&Save\nSave &All")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1929 < For the console, the first letter of each choice is used as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1930 the default shortcut key. Case is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1931
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1932 The optional {default} argument is the number of the choice
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1933 that is made if the user hits <CR>. Use 1 to make the first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1934 choice the default one. Use 0 to not set a default. If
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1935 {default} is omitted, 1 is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1936
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1937 The optional {type} String argument gives the type of dialog.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1938 This is only used for the icon of the GTK, Mac, Motif and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1939 Win32 GUI. It can be one of these values: "Error",
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1940 "Question", "Info", "Warning" or "Generic". Only the first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1941 character is relevant. When {type} is omitted, "Generic" is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1942 used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1943
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1944 If the user aborts the dialog by pressing <Esc>, CTRL-C,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1945 or another valid interrupt key, confirm() returns 0.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1946
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1947 An example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1948 let choice = confirm("What do you want?",
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1949 \ "&Apples\n&Oranges\n&Bananas", 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1950 if choice == 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1951 echo "make up your mind!"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1952 elseif choice == 3
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1953 echo "tasteful"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1954 else
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1955 echo "I prefer bananas myself."
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1956 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1957 < In a GUI dialog, buttons are used. The layout of the buttons
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1958 depends on the 'v' flag in 'guioptions'. If it is included,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1959 the buttons are always put vertically. Otherwise, confirm()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1960 tries to put the buttons in one horizontal line. If they
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1961 don't fit, a vertical layout is used anyway. For some systems
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1962 the horizontal layout is always used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1963
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1964 Can also be used as a \|method\|in: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1965 BuildMessage()->confirm("&Yes\n&No")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1966 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1967 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1968
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1969
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1970 copy({expr}) copy()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1971 Make a copy of {expr}. For Numbers and Strings this isn't
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1972 different from using {expr} directly.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1973 When {expr} is a \|List\| a shallow copy is created. This means
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1974 that the original \|List\| can be changed without changing the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1975 copy, and vice versa. But the items are identical, thus
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1976 changing an item changes the contents of both \|Lists\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1977 A \|Dictionary\| is copied in a similar way as a \|List\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1978 Also see \|deepcopy()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1979 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1980 mylist->copy()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1981 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1982 Return type: any, depending on {expr}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1983
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1984
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1985 cos({expr}) cos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1986 Return the cosine of {expr}, measured in radians, as a \|Float\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1987 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1988 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1989 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1990 :echo cos(100)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1991 < 0.862319 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1992 :echo cos(-4.01)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1993 < -0.646043
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1994
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1995 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1996 Compute()->cos()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1997 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	1998 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	1999
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2000
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2001 cosh({expr}) cosh()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2002 Return the hyperbolic cosine of {expr} as a \|Float\| in the range
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2003 [1, inf].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2004 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2005 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2006 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2007 :echo cosh(0.5)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2008 < 1.127626 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2009 :echo cosh(-0.5)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2010 < -1.127626
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2011
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2012 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2013 Compute()->cosh()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2014 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2015 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2016
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2017
33436 3f96c75df76d runtime(doc): add missing error numbers in the help. (#13241) Christian Brabandt <cb@256bit.org> parents: 33408 diff changeset	2018 count({comp}, {expr} [, {ic} [, {start}]]) count() E706
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2019 Return the number of times an item with value {expr} appears
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2020 in \|String\|, \|List\| or \|Dictionary\| {comp}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2021
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2022 If {start} is given then start with the item with this index.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2023 {start} can only be used with a \|List\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2024
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2025 When {ic} is given and it's \|TRUE\| then case is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2026
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2027 When {comp} is a string then the number of not overlapping
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2028 occurrences of {expr} is returned. Zero is returned when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2029 {expr} is an empty string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2030
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2031 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2032 mylist->count(val)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2033 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2034 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2035
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2036 cscope_connection()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2037 cscope_connection([{num} , {dbpath} [, {prepend}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2038 Checks for the existence of a \|cscope\| connection. If no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2039 parameters are specified, then the function returns:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2040 0, if cscope was not available (not compiled in), or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2041 if there are no cscope connections;
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2042 1, if there is at least one cscope connection.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2043
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2044 If parameters are specified, then the value of {num}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2045 determines how existence of a cscope connection is checked:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2046
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2047 {num} Description of existence check
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2048 ----- ------------------------------
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2049 0 Same as no parameters (e.g., "cscope_connection()").
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2050 1 Ignore {prepend}, and use partial string matches for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2051 {dbpath}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2052 2 Ignore {prepend}, and use exact string matches for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2053 {dbpath}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2054 3 Use {prepend}, use partial string matches for both
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2055 {dbpath} and {prepend}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2056 4 Use {prepend}, use exact string matches for both
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2057 {dbpath} and {prepend}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2058
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2059 Note: All string comparisons are case sensitive!
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2060
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2061 Examples. Suppose we had the following (from ":cs show"): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2062
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2063 # pid database name prepend path
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2064 0 27664 cscope.out /usr/local
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2065 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2066 Invocation Return Val ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2067 ---------- ---------- >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2068 cscope_connection() 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2069 cscope_connection(1, "out") 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2070 cscope_connection(2, "out") 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2071 cscope_connection(3, "out") 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2072 cscope_connection(3, "out", "local") 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2073 cscope_connection(4, "out") 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2074 cscope_connection(4, "out", "local") 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2075 cscope_connection(4, "cscope.out", "/usr/local") 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2076 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2077 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2078
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2079
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2080 cursor({lnum}, {col} [, {off}]) cursor()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2081 cursor({list})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2082 Positions the cursor at the column (byte count) {col} in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2083 line {lnum}. The first column is one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2084
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2085 When there is one argument {list} this is used as a \|List\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2086 with two, three or four item:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2087 [{lnum}, {col}]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2088 [{lnum}, {col}, {off}]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2089 [{lnum}, {col}, {off}, {curswant}]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2090 This is like the return value of \|getpos()\| or \|getcurpos()\|,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2091 but without the first item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2092
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2093 To position the cursor using {col} as the character count, use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2094 \|setcursorcharpos()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2095
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2096 Does not change the jumplist.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2097 {lnum} is used like with \|getline()\|, except that if {lnum} is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2098 zero, the cursor will stay in the current line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2099 If {lnum} is greater than the number of lines in the buffer,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2100 the cursor will be positioned at the last line in the buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2101 If {col} is greater than the number of bytes in the line,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2102 the cursor will be positioned at the last character in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2103 line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2104 If {col} is zero, the cursor will stay in the current column.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2105 If {curswant} is given it is used to set the preferred column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2106 for vertical movement. Otherwise {col} is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2107
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2108 When 'virtualedit' is used {off} specifies the offset in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2109 screen columns from the start of the character. E.g., a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2110 position within a <Tab> or after the last character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2111 Returns 0 when the position could be set, -1 otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2112
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2113 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2114 GetCursorPos()->cursor()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2115 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2116 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2117
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2118
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2119 debugbreak({pid}) debugbreak()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2120 Specifically used to interrupt a program being debugged. It
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2121 will cause process {pid} to get a SIGTRAP. Behavior for other
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2122 processes is undefined. See \|terminal-debugger\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2123 {only available on MS-Windows}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2124
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2125 Returns \|TRUE\| if successfully interrupted the program.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2126 Otherwise returns \|FALSE\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2127
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2128 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2129 GetPid()->debugbreak()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2130 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2131 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2132
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2133
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2134 deepcopy({expr} [, {noref}]) deepcopy() E698
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2135 Make a copy of {expr}. For Numbers and Strings this isn't
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2136 different from using {expr} directly.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2137 When {expr} is a \|List\| a full copy is created. This means
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2138 that the original \|List\| can be changed without changing the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2139 copy, and vice versa. When an item is a \|List\| or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2140 \|Dictionary\|, a copy for it is made, recursively. Thus
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2141 changing an item in the copy does not change the contents of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2142 the original \|List\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2143 A \|Dictionary\| is copied in a similar way as a \|List\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2144
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2145 When {noref} is omitted or zero a contained \|List\| or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2146 \|Dictionary\| is only copied once. All references point to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2147 this single copy. With {noref} set to 1 every occurrence of a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2148 \|List\| or \|Dictionary\| results in a new copy. This also means
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2149 that a cyclic reference causes deepcopy() to fail.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2150 E724
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2151 Nesting is possible up to 100 levels. When there is an item
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2152 that refers back to a higher level making a deep copy with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2153 {noref} set to 1 will fail.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2154 Also see \|copy()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2155
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2156 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2157 GetObject()->deepcopy()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2158 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2159 Return type: any, depending on {expr}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2160
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2161
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2162 delete({fname} [, {flags}]) delete()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2163 Without {flags} or with {flags} empty: Deletes the file by the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2164 name {fname}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2165
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2166 This also works when {fname} is a symbolic link. The symbolic
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2167 link itself is deleted, not what it points to.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2168
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2169 When {flags} is "d": Deletes the directory by the name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2170 {fname}. This fails when directory {fname} is not empty.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2171
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2172 When {flags} is "rf": Deletes the directory by the name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2173 {fname} and everything in it, recursively. BE CAREFUL!
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2174 Note: on MS-Windows it is not possible to delete a directory
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2175 that is being used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2176
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2177 The result is a Number, which is 0/false if the delete
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2178 operation was successful and -1/true when the deletion failed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2179 or partly failed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2180
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2181 Use \|remove()\| to delete an item from a \|List\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2182 To delete a line from the buffer use \|:delete\| or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2183 \|deletebufline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2184
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2185 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2186 GetName()->delete()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2187 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2188 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2189
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2190
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2191 deletebufline({buf}, {first} [, {last}]) deletebufline()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2192 Delete lines {first} to {last} (inclusive) from buffer {buf}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2193 If {last} is omitted then delete line {first} only.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2194 On success 0 is returned, on failure 1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2195
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2196 This function works only for loaded buffers. First call
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2197 \|bufload()\| if needed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2198
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2199 For the use of {buf}, see \|bufname()\| above.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2200
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2201 {first} and {last} are used like with \|getline()\|. Note that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2202 when using \|line()\| this refers to the current buffer. Use "$"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2203 to refer to the last line in buffer {buf}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2204
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2205 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2206 GetBuffer()->deletebufline(1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2207 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2208 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2209
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2210 did_filetype()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2211 did_filetype() Returns \|TRUE\| when autocommands are being executed and the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2212 FileType event has been triggered at least once. Can be used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2213 to avoid triggering the FileType event again in the scripts
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2214 that detect the file type. \|FileType\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2215 Returns \|FALSE\| when `:setf FALLBACK` was used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2216 When editing another file, the counter is reset, thus this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2217 really checks if the FileType event has been triggered for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2218 current buffer. This allows an autocommand that starts
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2219 editing another buffer to set 'filetype' and load a syntax
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2220 file.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2221
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2222 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2223
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2224
34264 cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2225 diff({fromlist}, {tolist} [, {options}]) diff()
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2226 Returns a String or a List containing the diff between the
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2227 strings in {fromlist} and {tolist}. Uses the Vim internal
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2228 diff library to compute the diff.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2229
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2230 E106
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2231 The optional "output" item in {options} specifies the returned
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2232 diff format. The following values are supported:
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2233 indices Return a List of the starting and ending
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2234 indices and a count of the strings in each
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2235 diff hunk.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2236 unified Return the unified diff output as a String.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2237 This is the default.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2238
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2239 If the "output" item in {options} is "indices", then a List is
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2240 returned. Each List item contains a Dict with the following
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2241 items for each diff hunk:
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2242 from_idx start index in {fromlist} for this diff hunk.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2243 from_count number of strings in {fromlist} that are
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2244 added/removed/modified in this diff hunk.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2245 to_idx start index in {tolist} for this diff hunk.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2246 to_count number of strings in {tolist} that are
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2247 added/removed/modified in this diff hunk.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2248
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2249 The {options} Dict argument also specifies diff options
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2250 (similar to 'diffopt') and supports the following items:
34324 6d9f59e88fc2 patch 9.1.0096: diff() function uses 'diffexpr' Christian Brabandt <cb@256bit.org> parents: 34288 diff changeset	2251 algorithm Dict specifying the diff algorithm to
6d9f59e88fc2 patch 9.1.0096: diff() function uses 'diffexpr' Christian Brabandt <cb@256bit.org> parents: 34288 diff changeset	2252 use. Supported boolean items are
6d9f59e88fc2 patch 9.1.0096: diff() function uses 'diffexpr' Christian Brabandt <cb@256bit.org> parents: 34288 diff changeset	2253 "myers", "minimal", "patience" and
6d9f59e88fc2 patch 9.1.0096: diff() function uses 'diffexpr' Christian Brabandt <cb@256bit.org> parents: 34288 diff changeset	2254 "histogram".
34332 7ccaadd7cf0b patch 9.1.0099: Not able to use diff() with 'diffexpr' Christian Brabandt <cb@256bit.org> parents: 34324 diff changeset	2255 context diff context length. Default is 0.
34264 cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2256 iblank ignore changes where lines are all
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2257 blank.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2258 icase ignore changes in case of text.
34324 6d9f59e88fc2 patch 9.1.0096: diff() function uses 'diffexpr' Christian Brabandt <cb@256bit.org> parents: 34288 diff changeset	2259 indent-heuristic use the indent heuristic for the
6d9f59e88fc2 patch 9.1.0096: diff() function uses 'diffexpr' Christian Brabandt <cb@256bit.org> parents: 34288 diff changeset	2260 internal diff library.
34264 cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2261 iwhite ignore changes in amount of white
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2262 space.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2263 iwhiteall ignore all white space changes.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2264 iwhiteeol ignore white space changes at end of
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2265 line.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2266 For more information about these options, refer to 'diffopt'.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2267
34332 7ccaadd7cf0b patch 9.1.0099: Not able to use diff() with 'diffexpr' Christian Brabandt <cb@256bit.org> parents: 34324 diff changeset	2268 To compute the unified diff, all the items in {fromlist} are
7ccaadd7cf0b patch 9.1.0099: Not able to use diff() with 'diffexpr' Christian Brabandt <cb@256bit.org> parents: 34324 diff changeset	2269 concatenated into a string using a newline separator and the
7ccaadd7cf0b patch 9.1.0099: Not able to use diff() with 'diffexpr' Christian Brabandt <cb@256bit.org> parents: 34324 diff changeset	2270 same for {tolist}. The unified diff output uses line numbers.
7ccaadd7cf0b patch 9.1.0099: Not able to use diff() with 'diffexpr' Christian Brabandt <cb@256bit.org> parents: 34324 diff changeset	2271
34264 cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2272 Returns an empty List or String if {fromlist} and {tolist} are
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2273 identical.
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2274
34288 6df143135376 patch 9.1.0080: unexpected error for modifying final list using += Christian Brabandt <cb@256bit.org> parents: 34264 diff changeset	2275 Examples: >
34264 cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2276 :echo diff(['abc'], ['xxx'])
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2277 @@ -1 +1 @@
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2278 -abc
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2279 +xxx
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2280
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2281 :echo diff(['abc'], ['xxx'], {'output': 'indices'})
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2282 [{'from_idx': 0, 'from_count': 1, 'to_idx': 0, 'to_count': 1}]
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2283 :echo diff(readfile('oldfile'), readfile('newfile'))
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2284 :echo diff(getbufline(5, 1, '$'), getbufline(6, 1, '$'))
34288 6df143135376 patch 9.1.0080: unexpected error for modifying final list using += Christian Brabandt <cb@256bit.org> parents: 34264 diff changeset	2285 <
34264 cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2286 For more examples, refer to \|diff-func-examples\|
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2287
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2288 Can also be used as a \|method\|: >
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2289 GetFromList->diff(to_list)
cce6b834635c patch 9.1.0071: Need a diff() Vim script function Christian Brabandt <cb@256bit.org> parents: 34238 diff changeset	2290 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2291 Return type: \|String\| or list<dict<number>> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2292 depending on {options}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2293
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2294
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2295 diff_filler({lnum}) diff_filler()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2296 Returns the number of filler lines above line {lnum}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2297 These are the lines that were inserted at this point in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2298 another diff'ed window. These filler lines are shown in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2299 display but don't exist in the buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2300 {lnum} is used like with \|getline()\|. Thus "." is the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2301 line, "'m" mark m, etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2302 Returns 0 if the current window is not in diff mode.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2303
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2304 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2305 GetLnum()->diff_filler()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2306 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2307 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2308
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2309
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2310 diff_hlID({lnum}, {col}) diff_hlID()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2311 Returns the highlight ID for diff mode at line {lnum} column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2312 {col} (byte index). When the current line does not have a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2313 diff change zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2314 {lnum} is used like with \|getline()\|. Thus "." is the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2315 line, "'m" mark m, etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2316 {col} is 1 for the leftmost column, {lnum} is 1 for the first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2317 line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2318 The highlight ID can be used with \|synIDattr()\| to obtain
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2319 syntax information about the highlighting.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2320
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2321 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2322 GetLnum()->diff_hlID(col)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2323 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2324 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2325
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2326
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2327 digraph_get({chars}) digraph_get() E1214
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2328 Return the digraph of {chars}. This should be a string with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2329 exactly two characters. If {chars} are not just two
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2330 characters, or the digraph of {chars} does not exist, an error
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2331 is given and an empty string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2332
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2333 The character will be converted from Unicode to 'encoding'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2334 when needed. This does require the conversion to be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2335 available, it might fail.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2336
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2337 Also see \|digraph_getlist()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2338
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2339 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2340 " Get a built-in digraph
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2341 :echo digraph_get('00') " Returns '∞'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2342
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2343 " Get a user-defined digraph
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2344 :call digraph_set('aa', 'あ')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2345 :echo digraph_get('aa') " Returns 'あ'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2346 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2347 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2348 GetChars()->digraph_get()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2349 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2350 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2351
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2352 This function works only when compiled with the \|+digraphs\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2353 feature. If this feature is disabled, this function will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2354 display an error message.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2355
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2356
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2357 digraph_getlist([{listall}]) digraph_getlist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2358 Return a list of digraphs. If the {listall} argument is given
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2359 and it is TRUE, return all digraphs, including the default
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2360 digraphs. Otherwise, return only user-defined digraphs.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2361
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2362 The characters will be converted from Unicode to 'encoding'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2363 when needed. This does require the conservation to be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2364 available, it might fail.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2365
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2366 Also see \|digraph_get()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2367
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2368 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2369 " Get user-defined digraphs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2370 :echo digraph_getlist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2371
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2372 " Get all the digraphs, including default digraphs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2373 :echo digraph_getlist(1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2374 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2375 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2376 GetNumber()->digraph_getlist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2377 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2378 Return type: list<list<string>>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2379
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2380 This function works only when compiled with the \|+digraphs\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2381 feature. If this feature is disabled, this function will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2382 display an error message.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2383
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2384
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2385 digraph_set({chars}, {digraph}) digraph_set()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2386 Add digraph {chars} to the list. {chars} must be a string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2387 with two characters. {digraph} is a string with one UTF-8
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2388 encoded character. E1215
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2389 Be careful, composing characters are NOT ignored. This
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2390 function is similar to \|:digraphs\| command, but useful to add
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2391 digraphs start with a white space.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2392
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2393 The function returns v:true if \|digraph\| is registered. If
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2394 this fails an error message is given and v:false is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2395
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2396 If you want to define multiple digraphs at once, you can use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2397 \|digraph_setlist()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2398
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2399 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2400 call digraph_set(' ', 'あ')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2401 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2402 Can be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2403 GetString()->digraph_set('あ')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2404 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2405 Return type: \|vim9-boolean\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2406
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2407 This function works only when compiled with the \|+digraphs\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2408 feature. If this feature is disabled, this function will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2409 display an error message.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2410
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2411
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2412 digraph_setlist({digraphlist}) digraph_setlist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2413 Similar to \|digraph_set()\| but this function can add multiple
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2414 digraphs at once. {digraphlist} is a list composed of lists,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2415 where each list contains two strings with {chars} and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2416 {digraph} as in \|digraph_set()\|. E1216
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2417 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2418 call digraph_setlist([['aa', 'あ'], ['ii', 'い']])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2419 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2420 It is similar to the following: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2421 for [chars, digraph] in [['aa', 'あ'], ['ii', 'い']]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2422 call digraph_set(chars, digraph)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2423 endfor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2424 < Except that the function returns after the first error,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2425 following digraphs will not be added.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2426
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2427 Can be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2428 GetList()->digraph_setlist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2429 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2430 Return type: \|vim9-boolean\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2431
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2432 This function works only when compiled with the \|+digraphs\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2433 feature. If this feature is disabled, this function will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2434 display an error message.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2435
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2436
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2437 echoraw({string}) echoraw()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2438 Output {string} as-is, including unprintable characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2439 This can be used to output a terminal code. For example, to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2440 disable modifyOtherKeys: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2441 call echoraw(&t_TE)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2442 < and to enable it again: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2443 call echoraw(&t_TI)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2444 < Use with care, you can mess up the terminal this way.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2445
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2446 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2447
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2448
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2449 empty({expr}) empty()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2450 Return the Number 1 if {expr} is empty, zero otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2451 - A \|List\| or \|Dictionary\| is empty when it does not have any
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2452 items.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2453 - A \|String\| is empty when its length is zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2454 - A \|Number\| and \|Float\| are empty when their value is zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2455 - \|v:false\|, \|v:none\| and \|v:null\| are empty, \|v:true\| is not.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2456 - A \|Job\| is empty when it failed to start.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2457 - A \|Channel\| is empty when it is closed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2458 - A \|Blob\| is empty when its length is zero.
34694 009989ec3ff6 runtime(doc): Improve docs for empty(), len(), and string() on objects Christian Brabandt <cb@256bit.org> parents: 34676 diff changeset	2459 - An \|Object\| is empty, when the empty() method in the object
009989ec3ff6 runtime(doc): Improve docs for empty(), len(), and string() on objects Christian Brabandt <cb@256bit.org> parents: 34676 diff changeset	2460 (if present) returns true. \|object-empty()\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2461
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2462 For a long \|List\| this is much faster than comparing the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2463 length with zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2464
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2465 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2466 mylist->empty()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2467 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2468 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2469
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2470
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2471 environ() environ()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2472 Return all of environment variables as dictionary. You can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2473 check if an environment variable exists like this: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2474 :echo has_key(environ(), 'HOME')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2475 < Note that the variable name may be CamelCase; to ignore case
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2476 use this: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2477 :echo index(keys(environ()), 'HOME', 0, 1) != -1
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2478 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2479 Return type: dict<string>
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2480
32687 6aff98e1c5f0 patch 9.0.1674: help for builtin functions is not sorted properly Bram Moolenaar <Bram@vim.org> parents: 32685 diff changeset	2481
6aff98e1c5f0 patch 9.0.1674: help for builtin functions is not sorted properly Bram Moolenaar <Bram@vim.org> parents: 32685 diff changeset	2482 err_teapot([{expr}]) err_teapot()
6aff98e1c5f0 patch 9.0.1674: help for builtin functions is not sorted properly Bram Moolenaar <Bram@vim.org> parents: 32685 diff changeset	2483 Produce an error with number 418, needed for implementation of
33223 def9fc5c92d1 patch 9.0.1886: Various Typos Christian Brabandt <cb@256bit.org> parents: 33148 diff changeset	2484 RFC 2324.
32687 6aff98e1c5f0 patch 9.0.1674: help for builtin functions is not sorted properly Bram Moolenaar <Bram@vim.org> parents: 32685 diff changeset	2485 If {expr} is present and it is TRUE error 503 is given,
6aff98e1c5f0 patch 9.0.1674: help for builtin functions is not sorted properly Bram Moolenaar <Bram@vim.org> parents: 32685 diff changeset	2486 indicating that coffee is temporarily not available.
6aff98e1c5f0 patch 9.0.1674: help for builtin functions is not sorted properly Bram Moolenaar <Bram@vim.org> parents: 32685 diff changeset	2487 If {expr} is present it must be a String.
6aff98e1c5f0 patch 9.0.1674: help for builtin functions is not sorted properly Bram Moolenaar <Bram@vim.org> parents: 32685 diff changeset	2488
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2489 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2490
32687 6aff98e1c5f0 patch 9.0.1674: help for builtin functions is not sorted properly Bram Moolenaar <Bram@vim.org> parents: 32685 diff changeset	2491
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2492 escape({string}, {chars}) escape()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2493 Escape the characters in {chars} that occur in {string} with a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2494 backslash. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2495 :echo escape('c:\program files\vim', ' \')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2496 < results in: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2497 c:\\program\ files\\vim
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2498 < Also see \|shellescape()\| and \|fnameescape()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2499
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2500 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2501 GetText()->escape(' \')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2502 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2503 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2504
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2505 eval()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2506 eval({string}) Evaluate {string} and return the result. Especially useful to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2507 turn the result of \|string()\| back into the original value.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2508 This works for Numbers, Floats, Strings, Blobs and composites
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2509 of them. Also works for \|Funcref\|s that refer to existing
34779 5914f369ff5b runtime(doc): Fill in a few details regarding :enums (#14349) Christian Brabandt <cb@256bit.org> parents: 34709 diff changeset	2510 functions. In \|Vim9\| script, it can be used to obtain \|enum\|
5914f369ff5b runtime(doc): Fill in a few details regarding :enums (#14349) Christian Brabandt <cb@256bit.org> parents: 34709 diff changeset	2511 values from their fully qualified names.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2512
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2513 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2514 argv->join()->eval()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2515 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2516 Return type: any, depending on {string}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2517
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2518
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2519 eventhandler() eventhandler()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2520 Returns 1 when inside an event handler. That is that Vim got
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2521 interrupted while waiting for the user to type a character,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2522 e.g., when dropping a file on Vim. This means interactive
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2523 commands cannot be used. Otherwise zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2524
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2525 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2526
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2527
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2528 executable({expr}) executable()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2529 This function checks if an executable with the name {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2530 exists. {expr} must be the name of the program without any
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2531 arguments.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2532 executable() uses the value of $PATH and/or the normal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2533 searchpath for programs. PATHEXT
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2534 On MS-Windows the ".exe", ".bat", etc. can optionally be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2535 included. Then the extensions in $PATHEXT are tried. Thus if
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2536 "foo.exe" does not exist, "foo.exe.bat" can be found. If
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2537 $PATHEXT is not set then ".com;.exe;.bat;.cmd" is used. A dot
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2538 by itself can be used in $PATHEXT to try using the name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2539 without an extension. When 'shell' looks like a Unix shell,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2540 then the name is also tried without adding an extension.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2541 On MS-Windows it only checks if the file exists and is not a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2542 directory, not if it's really executable.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2543 On MS-Windows an executable in the same directory as Vim is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2544 normally found. Since this directory is added to $PATH it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2545 should also work to execute it \|win32-PATH\|. This can be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2546 disabled by setting the $NoDefaultCurrentDirectoryInExePath
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2547 environment variable. NoDefaultCurrentDirectoryInExePath
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2548 The result is a Number:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2549 1 exists
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2550 0 does not exist
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2551 -1 not implemented on this system
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2552 \|exepath()\| can be used to get the full path of an executable.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2553
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2554 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2555 GetCommand()->executable()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2556 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2557 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2558
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2559
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2560 execute({command} [, {silent}]) execute()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2561 Execute an Ex command or commands and return the output as a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2562 string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2563 {command} can be a string or a List. In case of a List the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2564 lines are executed one by one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2565 This is more or less equivalent to: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2566 redir => var
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2567 {command}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2568 redir END
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2569 < Except that line continuation in {command} is not recognized.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2570
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2571 The optional {silent} argument can have these values:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2572 "" no `:silent` used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2573 "silent" `:silent` used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2574 "silent!" `:silent!` used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2575 The default is "silent". Note that with "silent!", unlike
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2576 `:redir`, error messages are dropped. When using an external
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2577 command the screen may be messed up, use `system()` instead.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2578 E930
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2579 It is not possible to use `:redir` anywhere in {command}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2580
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2581 To get a list of lines use `split()` on the result: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2582 execute('args')->split("\n")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2583
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2584 < To execute a command in another window than the current one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2585 use `win_execute()`.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2586
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2587 When used recursively the output of the recursive call is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2588 included in the output of the higher level call.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2589
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2590 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2591 GetCommand()->execute()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2592 <
35468 dac5372649a7 runtime(doc): wrong return type for execute() function Christian Brabandt <cb@256bit.org> parents: 35461 diff changeset	2593 Return type: \|String\|
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2594
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2595
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2596 exepath({expr}) exepath()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2597 If {expr} is an executable and is either an absolute path, a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2598 relative path or found in $PATH, return the full path.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2599 Note that the current directory is used when {expr} starts
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2600 with "./", which may be a problem for Vim: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2601 echo exepath(v:progpath)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2602 < If {expr} cannot be found in $PATH or is not executable then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2603 an empty string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2604
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2605 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2606 GetCommand()->exepath()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2607 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2608 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2609
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2610
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2611 exists({expr}) exists()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2612 The result is a Number, which is \|TRUE\| if {expr} is defined,
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2613 zero otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2614
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2615 Note: In a compiled \|:def\| function the evaluation is done at
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2616 runtime. Use `exists_compiled()` to evaluate the expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2617 at compile time.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2618
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2619 For checking for a supported feature use \|has()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2620 For checking if a file exists use \|filereadable()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2621
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2622 The {expr} argument is a string, which contains one of these:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2623 varname internal variable (see
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2624 dict.key \|internal-variables\|). Also works
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2625 list[i] for \|curly-braces-names\|, \|Dictionary\|
34427 2c0b18822510 patch 9.1.0136: Vim9: need more test for exists() methods Christian Brabandt <cb@256bit.org> parents: 34411 diff changeset	2626 import.Func entries, \|List\| items, class and
2c0b18822510 patch 9.1.0136: Vim9: need more test for exists() methods Christian Brabandt <cb@256bit.org> parents: 34411 diff changeset	2627 class.Func object methods, imported items, etc.
2c0b18822510 patch 9.1.0136: Vim9: need more test for exists() methods Christian Brabandt <cb@256bit.org> parents: 34411 diff changeset	2628 object.Func Does not work for local variables in a
2c0b18822510 patch 9.1.0136: Vim9: need more test for exists() methods Christian Brabandt <cb@256bit.org> parents: 34411 diff changeset	2629 class.varname compiled `:def` function.
2c0b18822510 patch 9.1.0136: Vim9: need more test for exists() methods Christian Brabandt <cb@256bit.org> parents: 34411 diff changeset	2630 object.varname Also works for a function in \|Vim9\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2631 script, since it can be used as a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2632 function reference.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2633 Beware that evaluating an index may
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2634 cause an error message for an invalid
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2635 expression. E.g.: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2636 :let l = [1, 2, 3]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2637 :echo exists("l[5]")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2638 < 0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2639 :echo exists("l[xx]")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2640 < E121: Undefined variable: xx
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2641 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2642 &option-name Vim option (only checks if it exists,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2643 not if it really works)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2644 +option-name Vim option that works.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2645 $ENVNAME environment variable (could also be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2646 done by comparing with an empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2647 string)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2648 *funcname built-in function (see \|functions\|)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2649 or user defined function (see
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2650 \|user-functions\|) that is implemented.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2651 Also works for a variable that is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2652 Funcref.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2653 ?funcname built-in function that could be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2654 implemented; to be used to check if
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2655 "funcname" is valid
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2656 :cmdname Ex command: built-in command, user
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2657 command or command modifier \|:command\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2658 Returns:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2659 1 for match with start of a command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2660 2 full match with a command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2661 3 matches several user commands
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2662 To check for a supported command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2663 always check the return value to be 2.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2664 :2match The \|:2match\| command.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2665 :3match The \|:3match\| command (but you
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2666 probably should not use it, it is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2667 reserved for internal usage)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2668 #event autocommand defined for this event
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2669 #event#pattern autocommand defined for this event and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2670 pattern (the pattern is taken
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2671 literally and compared to the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2672 autocommand patterns character by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2673 character)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2674 #group autocommand group exists
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2675 #group#event autocommand defined for this group and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2676 event.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2677 #group#event#pattern
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2678 autocommand defined for this group,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2679 event and pattern.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2680 ##event autocommand for this event is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2681 supported.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2682
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2683 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2684 exists("&shortname")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2685 exists("$HOSTNAME")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2686 exists("*strftime")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2687 exists("*s:MyFunc") " only for legacy script
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2688 exists("*MyFunc")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2689 exists("bufcount")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2690 exists(":Make")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2691 exists("#CursorHold")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2692 exists("#BufReadPre#*.gz")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2693 exists("#filetypeindent")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2694 exists("#filetypeindent#FileType")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2695 exists("#filetypeindent#FileType#*")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2696 exists("##ColorScheme")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2697 < There must be no space between the symbol (&/$/*/#) and the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2698 name.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2699 There must be no extra characters after the name, although in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2700 a few cases this is ignored. That may become stricter in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2701 future, thus don't count on it!
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2702 Working example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2703 exists(":make")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2704 < NOT working example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2705 exists(":make install")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2706
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2707 < Note that the argument must be a string, not the name of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2708 variable itself. For example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2709 exists(bufcount)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2710 < This doesn't check for existence of the "bufcount" variable,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2711 but gets the value of "bufcount", and checks if that exists.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2712
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2713 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2714 Varname()->exists()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2715 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2716 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2717
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2718
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2719 exists_compiled({expr}) exists_compiled()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2720 Like `exists()` but evaluated at compile time. This is useful
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2721 to skip a block where a function is used that would otherwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2722 give an error: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2723 if exists_compiled('*ThatFunction')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2724 ThatFunction('works')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2725 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2726 < If `exists()` were used then a compilation error would be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2727 given if ThatFunction() is not defined.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2728
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2729 {expr} must be a literal string. E1232
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2730 Can only be used in a \|:def\| function. E1233
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2731 This does not work to check for arguments or local variables.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2732
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2733 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2734
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2735
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2736 exp({expr}) exp()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2737 Return the exponential of {expr} as a \|Float\| in the range
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2738 [0, inf].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2739 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2740 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2741 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2742 :echo exp(2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2743 < 7.389056 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2744 :echo exp(-1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2745 < 0.367879
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2746
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2747 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2748 Compute()->exp()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2749 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2750 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2751
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2752
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2753 expand({string} [, {nosuf} [, {list}]]) expand()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2754 Expand wildcards and the following special keywords in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2755 {string}. 'wildignorecase' applies.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2756
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2757 If {list} is given and it is \|TRUE\|, a List will be returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2758 Otherwise the result is a String and when there are several
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2759 matches, they are separated by <NL> characters. [Note: in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2760 version 5.0 a space was used, which caused problems when a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2761 file name contains a space]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2762
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2763 If the expansion fails, the result is an empty string. A name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2764 for a non-existing file is not included, unless {string} does
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2765 not start with '%', '#' or '<', see below.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2766
34396 b0f19afada63 runtime(doc): clarify expand() for :terminal windows Christian Brabandt <cb@256bit.org> parents: 34392 diff changeset	2767 For a \|:terminal\| window '%' expands to a '!' followed by
35121 28f2e09012ac runtime(doc): Fix typos in help documents Christian Brabandt <cb@256bit.org> parents: 35116 diff changeset	2768 the command or shell that is run. \|terminal-bufname\|
34396 b0f19afada63 runtime(doc): clarify expand() for :terminal windows Christian Brabandt <cb@256bit.org> parents: 34392 diff changeset	2769
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2770 When {string} starts with '%', '#' or '<', the expansion is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2771 done like for the \|cmdline-special\| variables with their
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2772 associated modifiers. Here is a short overview:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2773
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2774 % current file name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2775 # alternate file name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2776 #n alternate file name n
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2777 <cfile> file name under the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2778 <afile> autocmd file name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2779 <abuf> autocmd buffer number (as a String!)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2780 <amatch> autocmd matched name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2781 <cexpr> C expression under the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2782 <sfile> sourced script file or function name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2783 <slnum> sourced script line number or function
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2784 line number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2785 <sflnum> script file line number, also when in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2786 a function
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2787 <SID> "<SNR>123_" where "123" is the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2788 current script ID \|<SID>\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2789 <script> sourced script file, or script file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2790 where the current function was defined
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2791 <stack> call stack
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2792 <cword> word under the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2793 <cWORD> WORD under the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2794 <client> the {clientid} of the last received
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2795 message \|server2client()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2796 Modifiers:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2797 :p expand to full path
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2798 :h head (last path component removed)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2799 :t tail (last path component only)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2800 :r root (one extension removed)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2801 :e extension only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2802
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2803 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2804 :let &tags = expand("%:p:h") .. "/tags"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2805 < Note that when expanding a string that starts with '%', '#' or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2806 '<', any following text is ignored. This does NOT work: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2807 :let doesntwork = expand("%:h.bak")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2808 < Use this: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2809 :let doeswork = expand("%:h") .. ".bak"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2810 < Also note that expanding "<cfile>" and others only returns the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2811 referenced file name without further expansion. If "<cfile>"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2812 is "~/.cshrc", you need to do another expand() to have the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2813 "~/" expanded into the path of the home directory: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2814 :echo expand(expand("<cfile>"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2815 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2816 There cannot be white space between the variables and the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2817 following modifier. The \|fnamemodify()\| function can be used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2818 to modify normal file names.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2819
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2820 When using '%' or '#', and the current or alternate file name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2821 is not defined, an empty string is used. Using "%:p" in a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2822 buffer with no name, results in the current directory, with a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2823 '/' added.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2824 When 'verbose' is set then expanding '%', '#' and <> items
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2825 will result in an error message if the argument cannot be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2826 expanded.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2827
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2828 When {string} does not start with '%', '#' or '<', it is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2829 expanded like a file name is expanded on the command line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2830 'suffixes' and 'wildignore' are used, unless the optional
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2831 {nosuf} argument is given and it is \|TRUE\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2832 Names for non-existing files are included. The "**" item can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2833 be used to search in a directory tree. For example, to find
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2834 all "README" files in the current directory and below: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2835 :echo expand("**/README")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2836 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2837 expand() can also be used to expand variables and environment
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2838 variables that are only known in a shell. But this can be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2839 slow, because a shell may be used to do the expansion. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2840 \|expr-env-expand\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2841 The expanded variable is still handled like a list of file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2842 names. When an environment variable cannot be expanded, it is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2843 left unchanged. Thus ":echo expand('$FOOBAR')" results in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2844 "$FOOBAR".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2845
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2846 See \|glob()\| for finding existing files. See \|system()\| for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2847 getting the raw output of an external command.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2848
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2849 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2850 Getpattern()->expand()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2851 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2852 Return type: \|String\| or list<string> depending on {list}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2853
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2854
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2855 expandcmd({string} [, {options}]) expandcmd()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2856 Expand special items in String {string} like what is done for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2857 an Ex command such as `:edit`. This expands special keywords,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2858 like with \|expand()\|, and environment variables, anywhere in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2859 {string}. "~user" and "~/path" are only expanded at the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2860 start.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2861
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2862 The following items are supported in the {options} Dict
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2863 argument:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2864 errmsg If set to TRUE, error messages are displayed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2865 if an error is encountered during expansion.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2866 By default, error messages are not displayed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2867
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2868 Returns the expanded string. If an error is encountered
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2869 during expansion, the unmodified {string} is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2870
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2871 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2872 :echo expandcmd('make %<.o')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2873 make /path/runtime/doc/builtin.o
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2874 :echo expandcmd('make %<.o', {'errmsg': v:true})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2875 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2876 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2877 GetCommand()->expandcmd()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2878 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2879 Return type: \|String\| or list<string> depending on {list}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2880
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2881 extend({expr1}, {expr2} [, {expr3}]) extend()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2882 {expr1} and {expr2} must be both \|Lists\| or both
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2883 \|Dictionaries\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2884
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2885 If they are \|Lists\|: Append {expr2} to {expr1}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2886 If {expr3} is given insert the items of {expr2} before the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2887 item with index {expr3} in {expr1}. When {expr3} is zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2888 insert before the first item. When {expr3} is equal to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2889 len({expr1}) then {expr2} is appended.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2890 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2891 :echo sort(extend(mylist, [7, 5]))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2892 :call extend(mylist, [2, 3], 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2893 < When {expr1} is the same List as {expr2} then the number of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2894 items copied is equal to the original length of the List.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2895 E.g., when {expr3} is 1 you get N new copies of the first item
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2896 (where N is the original length of the List).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2897 Use \|add()\| to concatenate one item to a list. To concatenate
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2898 two lists into a new list use the + operator: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2899 :let newlist = [1, 2, 3] + [4, 5]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2900 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2901 If they are \|Dictionaries\|:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2902 Add all entries from {expr2} to {expr1}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2903 If a key exists in both {expr1} and {expr2} then {expr3} is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2904 used to decide what to do:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2905 {expr3} = "keep": keep the value of {expr1}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2906 {expr3} = "force": use the value of {expr2}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2907 {expr3} = "error": give an error message E737
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2908 When {expr3} is omitted then "force" is assumed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2909
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2910 {expr1} is changed when {expr2} is not empty. If necessary
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2911 make a copy of {expr1} first.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2912 {expr2} remains unchanged.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2913 When {expr1} is locked and {expr2} is not empty the operation
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2914 fails.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2915 Returns {expr1}. Returns 0 on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2916
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2917 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2918 mylist->extend(otherlist)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2919 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2920 Return type: list<{type}> or dict<{type}> depending on {expr1}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2921 and {expr2}, in case of error: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2922
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2923
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2924 extendnew({expr1}, {expr2} [, {expr3}]) extendnew()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2925 Like \|extend()\| but instead of adding items to {expr1} a new
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2926 List or Dictionary is created and returned. {expr1} remains
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2927 unchanged.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2928
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2929 Return type: list<{type}> or dict<{type}> depending on {expr1}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2930 and {expr2}, in case of error: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2931
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2932
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2933 feedkeys({string} [, {mode}]) feedkeys()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2934 Characters in {string} are queued for processing as if they
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2935 come from a mapping or were typed by the user.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2936
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2937 By default the string is added to the end of the typeahead
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2938 buffer, thus if a mapping is still being executed the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2939 characters come after them. Use the 'i' flag to insert before
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2940 other characters, they will be executed next, before any
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2941 characters from a mapping.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2942
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2943 The function does not wait for processing of keys contained in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2944 {string}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2945
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2946 To include special keys into {string}, use double-quotes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2947 and "\..." notation \|expr-quote\|. For example,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2948 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2949 feedkeys('\<CR>') pushes 5 characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2950 A special code that might be useful is <Ignore>, it exits the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2951 wait for a character without doing anything. <Ignore>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2952
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2953 {mode} is a String, which can contain these character flags:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2954 'm' Remap keys. This is default. If {mode} is absent,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2955 keys are remapped.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2956 'n' Do not remap keys.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2957 't' Handle keys as if typed; otherwise they are handled as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2958 if coming from a mapping. This matters for undo,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2959 opening folds, etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2960 'L' Lowlevel input. Only works for Unix or when using the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2961 GUI. Keys are used as if they were coming from the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2962 terminal. Other flags are not used. E980
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2963 When a CTRL-C interrupts and 't' is included it sets
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2964 the internal "got_int" flag.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2965 'i' Insert the string instead of appending (see above).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2966 'x' Execute commands until typeahead is empty. This is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2967 similar to using ":normal!". You can call feedkeys()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2968 several times without 'x' and then one time with 'x'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2969 (possibly with an empty {string}) to execute all the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2970 typeahead. Note that when Vim ends in Insert mode it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2971 will behave as if <Esc> is typed, to avoid getting
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2972 stuck, waiting for a character to be typed before the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2973 script continues.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2974 Note that if you manage to call feedkeys() while
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2975 executing commands, thus calling it recursively, then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2976 all typeahead will be consumed by the last call.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2977 'c' Remove any script context when executing, so that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2978 legacy script syntax applies, "s:var" does not work,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2979 etc. Note that if the string being fed sets a script
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2980 context this still applies.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2981 '!' When used with 'x' will not end Insert mode. Can be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2982 used in a test when a timer is set to exit Insert mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2983 a little later. Useful for testing CursorHoldI.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2984
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2985 Return value is always 0.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2986
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2987 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2988 GetInput()->feedkeys()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2989 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2990 Return type: \|String\| or list<string> depending on {list}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	2991
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	2992
35326 a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	2993 filecopy({from}, {to}) filecopy()
a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	2994 Copy the file pointed to by the name {from} to {to}. The
a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	2995 result is a Number, which is \|TRUE\| if the file was copied
a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	2996 successfully, and \|FALSE\| when it failed.
a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	2997 If a file with name {to} already exists, it will fail.
a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	2998 Note that it does not handle directories (yet).
a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	2999
a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	3000 This function is not available in the \|sandbox\|.
a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	3001
a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	3002 Can also be used as a \|method\|: >
a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	3003 GetOldName()->filecopy(newname)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3004 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3005 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3006
35326 a9e6d02f003c patch 9.1.0465: missing filecopy() function Christian Brabandt <cb@256bit.org> parents: 35272 diff changeset	3007
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3008 filereadable({file}) filereadable()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3009 The result is a Number, which is \|TRUE\| when a file with the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3010 name {file} exists, and can be read. If {file} doesn't exist,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3011 or is a directory, the result is \|FALSE\|. {file} is any
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3012 expression, which is used as a String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3013 If you don't care about the file being readable you can use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3014 \|glob()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3015 {file} is used as-is, you may want to expand wildcards first: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3016 echo filereadable('~/.vimrc')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3017 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3018 echo filereadable(expand('~/.vimrc'))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3019 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3020
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3021 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3022 GetName()->filereadable()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3023 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3024 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3025
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3026 file_readable()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3027 Obsolete name: file_readable().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3028
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3029
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3030 filewritable({file}) filewritable()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3031 The result is a Number, which is 1 when a file with the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3032 name {file} exists, and can be written. If {file} doesn't
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3033 exist, or is not writable, the result is 0. If {file} is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3034 directory, and we can write to it, the result is 2.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3035
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3036 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3037 GetName()->filewritable()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3038 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3039 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3040
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3041
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3042 filter({expr1}, {expr2}) filter()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3043 {expr1} must be a \|List\|, \|String\|, \|Blob\| or \|Dictionary\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3044 For each item in {expr1} evaluate {expr2} and when the result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3045 is zero or false remove the item from the \|List\| or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3046 \|Dictionary\|. Similarly for each byte in a \|Blob\| and each
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3047 character in a \|String\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3048
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3049 {expr2} must be a \|string\| or \|Funcref\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3050
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3051 If {expr2} is a \|string\|, inside {expr2} \|v:val\| has the value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3052 of the current item. For a \|Dictionary\| \|v:key\| has the key
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3053 of the current item and for a \|List\| \|v:key\| has the index of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3054 the current item. For a \|Blob\| \|v:key\| has the index of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3055 current byte. For a \|String\| \|v:key\| has the index of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3056 current character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3057 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3058 call filter(mylist, 'v:val !~ "OLD"')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3059 < Removes the items where "OLD" appears. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3060 call filter(mydict, 'v:key >= 8')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3061 < Removes the items with a key below 8. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3062 call filter(var, 0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3063 < Removes all the items, thus clears the \|List\| or \|Dictionary\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3064
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3065 Note that {expr2} is the result of expression and is then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3066 used as an expression again. Often it is good to use a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3067 \|literal-string\| to avoid having to double backslashes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3068
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3069 If {expr2} is a \|Funcref\| it must take two arguments:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3070 1. the key or the index of the current item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3071 2. the value of the current item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3072 The function must return \|TRUE\| if the item should be kept.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3073 Example that keeps the odd items of a list: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3074 func Odd(idx, val)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3075 return a:idx % 2 == 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3076 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3077 call filter(mylist, function('Odd'))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3078 < It is shorter when using a \|lambda\|. In \|Vim9\| syntax: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3079 call filter(myList, (idx, val) => idx * val <= 42)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3080 < In legacy script syntax: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3081 call filter(myList, {idx, val -> idx * val <= 42})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3082 < If you do not use "val" you can leave it out: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3083 call filter(myList, {idx -> idx % 2 == 1})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3084 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3085 In \|Vim9\| script the result must be true, false, zero or one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3086 Other values will result in a type error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3087
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3088 For a \|List\| and a \|Dictionary\| the operation is done
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3089 in-place. If you want it to remain unmodified make a copy
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3090 first: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3091 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3092
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3093 < Returns {expr1}, the \|List\| or \|Dictionary\| that was filtered,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3094 or a new \|Blob\| or \|String\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3095 When an error is encountered while evaluating {expr2} no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3096 further items in {expr1} are processed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3097 When {expr2} is a Funcref errors inside a function are ignored,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3098 unless it was defined with the "abort" flag.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3099
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3100 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3101 mylist->filter(expr2)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3102 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3103 Return type: \|String\|, \|Blob\|, list<{type}> or dict<{type}>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3104 depending on {expr1}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3105
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3106
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3107 finddir({name} [, {path} [, {count}]]) finddir()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3108 Find directory {name} in {path}. Supports both downwards and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3109 upwards recursive directory searches. See \|file-searching\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3110 for the syntax of {path}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3111
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3112 Returns the path of the first found match. When the found
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3113 directory is below the current directory a relative path is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3114 returned. Otherwise a full path is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3115 If {path} is omitted or empty then 'path' is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3116
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3117 If the optional {count} is given, find {count}'s occurrence of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3118 {name} in {path} instead of the first one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3119 When {count} is negative return all the matches in a \|List\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3120
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3121 Returns an empty string if the directory is not found.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3122
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3123 This is quite similar to the ex-command `:find`.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3124
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3125 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3126 GetName()->finddir()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3127 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3128 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3129
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3130
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3131 findfile({name} [, {path} [, {count}]]) findfile()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3132 Just like \|finddir()\|, but find a file instead of a directory.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3133 Uses 'suffixesadd'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3134 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3135 :echo findfile("tags.vim", ".;")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3136 < Searches from the directory of the current file upwards until
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3137 it finds the file "tags.vim".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3138
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3139 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3140 GetName()->findfile()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3141 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3142 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3143
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3144
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3145 flatten({list} [, {maxdepth}]) flatten()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3146 Flatten {list} up to {maxdepth} levels. Without {maxdepth}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3147 the result is a \|List\| without nesting, as if {maxdepth} is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3148 a very large number.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3149 The {list} is changed in place, use \|flattennew()\| if you do
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3150 not want that.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3151 In Vim9 script flatten() cannot be used, you must always use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3152 \|flattennew()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3153 E900
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3154 {maxdepth} means how deep in nested lists changes are made.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3155 {list} is not modified when {maxdepth} is 0.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3156 {maxdepth} must be positive number.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3157
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3158 If there is an error the number zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3159
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3160 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3161 :echo flatten([1, [2, [3, 4]], 5])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3162 < [1, 2, 3, 4, 5] >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3163 :echo flatten([1, [2, [3, 4]], 5], 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3164 < [1, 2, [3, 4], 5]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3165
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3166 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3167 mylist->flatten()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3168 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3169 Return type: list<{type}>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3170
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3171
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3172 flattennew({list} [, {maxdepth}]) flattennew()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3173 Like \|flatten()\| but first make a copy of {list}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3174
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3175 Return type: list<{type}>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3176
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3177
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3178 float2nr({expr}) float2nr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3179 Convert {expr} to a Number by omitting the part after the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3180 decimal point.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3181 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3182 Returns 0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3183 When the value of {expr} is out of range for a \|Number\| the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3184 result is truncated to 0x7fffffff or -0x7fffffff (or when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3185 64-bit Number support is enabled, 0x7fffffffffffffff or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3186 -0x7fffffffffffffff). NaN results in -0x80000000 (or when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3187 64-bit Number support is enabled, -0x8000000000000000).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3188 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3189 echo float2nr(3.95)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3190 < 3 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3191 echo float2nr(-23.45)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3192 < -23 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3193 echo float2nr(1.0e100)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3194 < 2147483647 (or 9223372036854775807) >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3195 echo float2nr(-1.0e150)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3196 < -2147483647 (or -9223372036854775807) >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3197 echo float2nr(1.0e-100)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3198 < 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3199
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3200 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3201 Compute()->float2nr()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3202 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3203 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3204
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3205
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3206 floor({expr}) floor()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3207 Return the largest integral value less than or equal to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3208 {expr} as a \|Float\| (round down).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3209 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3210 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3211 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3212 echo floor(1.856)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3213 < 1.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3214 echo floor(-5.456)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3215 < -6.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3216 echo floor(4.0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3217 < 4.0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3218
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3219 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3220 Compute()->floor()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3221 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3222 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3223
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3224
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3225 fmod({expr1}, {expr2}) fmod()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3226 Return the remainder of {expr1} / {expr2}, even if the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3227 division is not representable. Returns {expr1} - i * {expr2}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3228 for some integer i such that if {expr2} is non-zero, the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3229 result has the same sign as {expr1} and magnitude less than
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3230 the magnitude of {expr2}. If {expr2} is zero, the value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3231 returned is zero. The value returned is a \|Float\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3232 {expr1} and {expr2} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3233 Returns 0.0 if {expr1} or {expr2} is not a \|Float\| or a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3234 \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3235 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3236 :echo fmod(12.33, 1.22)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3237 < 0.13 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3238 :echo fmod(-12.33, 1.22)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3239 < -0.13
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3240
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3241 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3242 Compute()->fmod(1.22)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3243 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3244 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3245
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3246
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3247 fnameescape({string}) fnameescape()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3248 Escape {string} for use as file name command argument. All
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3249 characters that have a special meaning, such as '%' and '\|'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3250 are escaped with a backslash.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3251 For most systems the characters escaped are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3252 " \t\n*?[{`$\\%#'\"\|!<". For systems where a backslash
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3253 appears in a filename, it depends on the value of 'isfname'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3254 A leading '+' and '>' is also escaped (special after \|:edit\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3255 and \|:write\|). And a "-" by itself (special after \|:cd\|).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3256 Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3257 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3258 :let fname = '+some str%nge\|name'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3259 :exe "edit " .. fnameescape(fname)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3260 < results in executing: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3261 edit \+some\ str\%nge\\|name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3262 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3263 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3264 GetName()->fnameescape()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3265 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3266 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3267
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3268
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3269 fnamemodify({fname}, {mods}) fnamemodify()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3270 Modify file name {fname} according to {mods}. {mods} is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3271 string of characters like it is used for file names on the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3272 command line. See \|filename-modifiers\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3273 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3274 :echo fnamemodify("main.c", ":p:h")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3275 < results in: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3276 /home/user/vim/vim/src
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3277 < If {mods} is empty or an unsupported modifier is used then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3278 {fname} is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3279 When {fname} is empty then with {mods} ":h" returns ".", so
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3280 that `:cd` can be used with it. This is different from
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3281 expand('%:h') without a buffer name, which returns an empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3282 string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3283 Note: Environment variables don't work in {fname}, use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3284 \|expand()\| first then.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3285
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3286 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3287 GetName()->fnamemodify(':p:h')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3288 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3289 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3290
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3291
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3292 foldclosed({lnum}) foldclosed()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3293 The result is a Number. If the line {lnum} is in a closed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3294 fold, the result is the number of the first line in that fold.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3295 If the line {lnum} is not in a closed fold, -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3296 {lnum} is used like with \|getline()\|. Thus "." is the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3297 line, "'m" mark m, etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3298
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3299 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3300 GetLnum()->foldclosed()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3301 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3302 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3303
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3304
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3305 foldclosedend({lnum}) foldclosedend()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3306 The result is a Number. If the line {lnum} is in a closed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3307 fold, the result is the number of the last line in that fold.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3308 If the line {lnum} is not in a closed fold, -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3309 {lnum} is used like with \|getline()\|. Thus "." is the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3310 line, "'m" mark m, etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3311
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3312 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3313 GetLnum()->foldclosedend()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3314 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3315 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3316
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3317
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3318 foldlevel({lnum}) foldlevel()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3319 The result is a Number, which is the foldlevel of line {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3320 in the current buffer. For nested folds the deepest level is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3321 returned. If there is no fold at line {lnum}, zero is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3322 returned. It doesn't matter if the folds are open or closed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3323 When used while updating folds (from 'foldexpr') -1 is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3324 returned for lines where folds are still to be updated and the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3325 foldlevel is unknown. As a special case the level of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3326 previous line is usually available.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3327 {lnum} is used like with \|getline()\|. Thus "." is the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3328 line, "'m" mark m, etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3329
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3330 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3331 GetLnum()->foldlevel()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3332 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3333 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3334
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3335 foldtext()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3336 foldtext() Returns a String, to be displayed for a closed fold. This is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3337 the default function used for the 'foldtext' option and should
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3338 only be called from evaluating 'foldtext'. It uses the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3339 \|v:foldstart\|, \|v:foldend\| and \|v:folddashes\| variables.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3340 The returned string looks like this: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3341 +-- 45 lines: abcdef
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3342 < The number of leading dashes depends on the foldlevel. The
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3343 "45" is the number of lines in the fold. "abcdef" is the text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3344 in the first non-blank line of the fold. Leading white space,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3345 "//" or "/*" and the text from the 'foldmarker' and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3346 'commentstring' options is removed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3347 When used to draw the actual foldtext, the rest of the line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3348 will be filled with the fold char from the 'fillchars'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3349 setting.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3350 Returns an empty string when there is no fold.
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3351
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3352 Return type: \|String\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3353 {not available when compiled without the \|+folding\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3354
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3355
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3356 foldtextresult({lnum}) foldtextresult()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3357 Returns the text that is displayed for the closed fold at line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3358 {lnum}. Evaluates 'foldtext' in the appropriate context.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3359 When there is no closed fold at {lnum} an empty string is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3360 returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3361 {lnum} is used like with \|getline()\|. Thus "." is the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3362 line, "'m" mark m, etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3363 Useful when exporting folded text, e.g., to HTML.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3364 {not available when compiled without the \|+folding\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3365
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3366
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3367 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3368 GetLnum()->foldtextresult()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3369 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3370 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3371
34126 da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3372
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3373 foreach({expr1}, {expr2}) foreach()
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3374 {expr1} must be a \|List\|, \|String\|, \|Blob\| or \|Dictionary\|.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3375 For each item in {expr1} execute {expr2}. {expr1} is not
34128 575b6a99b81c runtime(help): delete duplicate help tag E741 (#13861) Christian Brabandt <cb@256bit.org> parents: 34126 diff changeset	3376 modified; its values may be, as with \|:lockvar\| 1. \|E741\|
34126 da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3377 See \|map()\| and \|filter()\| to modify {expr1}.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3378
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3379 {expr2} must be a \|string\| or \|Funcref\|.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3380
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3381 If {expr2} is a \|string\|, inside {expr2} \|v:val\| has the value
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3382 of the current item. For a \|Dictionary\| \|v:key\| has the key
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3383 of the current item and for a \|List\| \|v:key\| has the index of
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3384 the current item. For a \|Blob\| \|v:key\| has the index of the
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3385 current byte. For a \|String\| \|v:key\| has the index of the
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3386 current character.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3387 Examples: >
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3388 call foreach(mylist, 'used[v:val] = true')
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3389 < This records the items that are in the {expr1} list.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3390
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3391 Note that {expr2} is the result of expression and is then used
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3392 as a command. Often it is good to use a \|literal-string\| to
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3393 avoid having to double backslashes.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3394
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3395 If {expr2} is a \|Funcref\| it must take two arguments:
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3396 1. the key or the index of the current item.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3397 2. the value of the current item.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3398 With a legacy script lambda you don't get an error if it only
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3399 accepts one argument, but with a Vim9 lambda you get "E1106:
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3400 One argument too many", the number of arguments must match.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3401 If the function returns a value, it is ignored.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3402
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3403 Returns {expr1} in all cases.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3404 When an error is encountered while executing {expr2} no
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3405 further items in {expr1} are processed.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3406 When {expr2} is a Funcref errors inside a function are ignored,
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3407 unless it was defined with the "abort" flag.
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3408
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3409 Can also be used as a \|method\|: >
da670b1549b3 patch 9.1.0027: Vim is missing a foreach() func Christian Brabandt <cb@256bit.org> parents: 34087 diff changeset	3410 mylist->foreach(expr2)
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3411 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3412 Return type: \|String\|, \|Blob\| list<{type}> or dict<{type}>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3413 depending on {expr1}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3414
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3415 foreground()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3416 foreground() Move the Vim window to the foreground. Useful when sent from
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3417 a client to a Vim server. \|remote_send()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3418 On Win32 systems this might not work, the OS does not always
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3419 allow a window to bring itself to the foreground. Use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3420 \|remote_foreground()\| instead.
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3421
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3422 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3423 {only in the Win32, Motif and GTK GUI versions and the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3424 Win32 console version}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3425
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3426 fullcommand({name} [, {vim9}]) fullcommand()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3427 Get the full command name from a short abbreviated command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3428 name; see \|20.2\| for details on command abbreviations.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3429
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3430 The string argument {name} may start with a `:` and can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3431 include a [range], these are skipped and not returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3432 Returns an empty string if a command doesn't exist, if it's
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3433 ambiguous (for user-defined commands) or cannot be shortened
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3434 this way. \|vim9-no-shorten\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3435
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3436 Without the {vim9} argument uses the current script version.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3437 If {vim9} is present and FALSE then legacy script rules are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3438 used. When {vim9} is present and TRUE then Vim9 rules are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3439 used, e.g. "en" is not a short form of "endif".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3440
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3441 For example `fullcommand('s')`, `fullcommand('sub')`,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3442 `fullcommand(':%substitute')` all return "substitute".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3443
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3444 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3445 GetName()->fullcommand()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3446 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3447 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3448
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3449
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3450 funcref({name} [, {arglist}] [, {dict}]) funcref()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3451 Just like \|function()\|, but the returned Funcref will lookup
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3452 the function by reference, not by name. This matters when the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3453 function {name} is redefined later.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3454
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3455 Unlike \|function()\|, {name} must be an existing user function.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3456 It only works for an autoloaded function if it has already
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3457 been loaded (to avoid mistakenly loading the autoload script
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3458 when only intending to use the function name, use \|function()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3459 instead). {name} cannot be a builtin function.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3460 Returns 0 on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3461
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3462 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3463 GetFuncname()->funcref([arg])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3464 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3465 Return type: func(...): any or \|Number\| on error
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3466
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3467 function() partial E700 E923
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3468 function({name} [, {arglist}] [, {dict}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3469 Return a \|Funcref\| variable that refers to function {name}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3470 {name} can be the name of a user defined function or an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3471 internal function.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3472
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3473 {name} can also be a Funcref or a partial. When it is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3474 partial the dict stored in it will be used and the {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3475 argument is not allowed. E.g.: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3476 let FuncWithArg = function(dict.Func, [arg])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3477 let Broken = function(dict.Func, [arg], dict)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3478 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3479 When using the Funcref the function will be found by {name},
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3480 also when it was redefined later. Use \|funcref()\| to keep the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3481 same function.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3482
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3483 When {arglist} or {dict} is present this creates a partial.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3484 That means the argument list and/or the dictionary is stored in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3485 the Funcref and will be used when the Funcref is called.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3486
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3487 The arguments are passed to the function in front of other
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3488 arguments, but after any argument from \|method\|. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3489 func Callback(arg1, arg2, name)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3490 ...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3491 let Partial = function('Callback', ['one', 'two'])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3492 ...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3493 call Partial('name')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3494 < Invokes the function as with: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3495 call Callback('one', 'two', 'name')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3496
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3497 < With a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3498 func Callback(one, two, three)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3499 ...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3500 let Partial = function('Callback', ['two'])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3501 ...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3502 eval 'one'->Partial('three')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3503 < Invokes the function as with: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3504 call Callback('one', 'two', 'three')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3505
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3506 < The function() call can be nested to add more arguments to the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3507 Funcref. The extra arguments are appended to the list of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3508 arguments. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3509 func Callback(arg1, arg2, name)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3510 "...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3511 let Func = function('Callback', ['one'])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3512 let Func2 = function(Func, ['two'])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3513 "...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3514 call Func2('name')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3515 < Invokes the function as with: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3516 call Callback('one', 'two', 'name')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3517
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3518 < The Dictionary is only useful when calling a "dict" function.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3519 In that case the {dict} is passed in as "self". Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3520 function Callback() dict
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3521 echo "called for " .. self.name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3522 endfunction
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3523 "...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3524 let context = {"name": "example"}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3525 let Func = function('Callback', context)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3526 "...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3527 call Func() " will echo: called for example
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3528 < The use of function() is not needed when there are no extra
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3529 arguments, these two are equivalent, if Callback() is defined
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3530 as context.Callback(): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3531 let Func = function('Callback', context)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3532 let Func = context.Callback
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3533
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3534 < The argument list and the Dictionary can be combined: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3535 function Callback(arg1, count) dict
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3536 "...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3537 let context = {"name": "example"}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3538 let Func = function('Callback', ['one'], context)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3539 "...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3540 call Func(500)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3541 < Invokes the function as with: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3542 call context.Callback('one', 500)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3543 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3544 Returns 0 on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3545
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3546 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3547 GetFuncname()->function([arg])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3548
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3549 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3550 Return type: func(...): any or \|Number\| on error
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3551
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3552
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3553 garbagecollect([{atexit}]) garbagecollect()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3554 Cleanup unused \|Lists\|, \|Dictionaries\|, \|Channels\| and \|Jobs\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3555 that have circular references.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3556
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3557 There is hardly ever a need to invoke this function, as it is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3558 automatically done when Vim runs out of memory or is waiting
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3559 for the user to press a key after 'updatetime'. Items without
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3560 circular references are always freed when they become unused.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3561 This is useful if you have deleted a very big \|List\| and/or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3562 \|Dictionary\| with circular references in a script that runs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3563 for a long time.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3564
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3565 When the optional {atexit} argument is one, garbage
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3566 collection will also be done when exiting Vim, if it wasn't
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3567 done before. This is useful when checking for memory leaks.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3568
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3569 The garbage collection is not done immediately but only when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3570 it's safe to perform. This is when waiting for the user to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3571 type a character. To force garbage collection immediately use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3572 \|test_garbagecollect_now()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3573
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3574 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3575
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3576
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3577 get({list}, {idx} [, {default}]) get()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3578 Get item {idx} from \|List\| {list}. When this item is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3579 available return {default}. Return zero when {default} is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3580 omitted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3581 Preferably used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3582 mylist->get(idx)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3583 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3584 Return type: any, depending on {list}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3585
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3586 get({blob}, {idx} [, {default}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3587 Get byte {idx} from \|Blob\| {blob}. When this byte is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3588 available return {default}. Return -1 when {default} is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3589 omitted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3590 Preferably used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3591 myblob->get(idx)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3592 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3593 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3594
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3595 get({dict}, {key} [, {default}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3596 Get item with key {key} from \|Dictionary\| {dict}. When this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3597 item is not available return {default}. Return zero when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3598 {default} is omitted. Useful example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3599 let val = get(g:, 'var_name', 'default')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3600 < This gets the value of g:var_name if it exists, and uses
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3601 'default' when it does not exist.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3602 Preferably used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3603 mydict->get(key)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3604 <
35446 9d1bc7b46c10 runtime(doc): Fix typos in several documents Christian Brabandt <cb@256bit.org> parents: 35445 diff changeset	3605 Return type: any, depending on {dict}
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3606
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3607 get({func}, {what})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3608 Get item {what} from Funcref {func}. Possible values for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3609 {what} are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3610 "name" The function name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3611 "func" The function
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3612 "dict" The dictionary
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3613 "args" The list with arguments
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3614 Returns zero on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3615 Preferably used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3616 myfunc->get(what)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3617 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3618 Return type: any, depending on {func}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3619
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3620 getbufinfo()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3621 getbufinfo([{buf}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3622 getbufinfo([{dict}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3623 Get information about buffers as a List of Dictionaries.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3624
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3625 Without an argument information about all the buffers is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3626 returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3627
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3628 When the argument is a \|Dictionary\| only the buffers matching
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3629 the specified criteria are returned. The following keys can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3630 be specified in {dict}:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3631 buflisted include only listed buffers.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3632 bufloaded include only loaded buffers.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3633 bufmodified include only modified buffers.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3634
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3635 Otherwise, {buf} specifies a particular buffer to return
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3636 information for. For the use of {buf}, see \|bufname()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3637 above. If the buffer is found the returned List has one item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3638 Otherwise the result is an empty list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3639
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3640 Each returned List item is a dictionary with the following
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3641 entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3642 bufnr Buffer number.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3643 changed TRUE if the buffer is modified.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3644 changedtick Number of changes made to the buffer.
34198 08e6a44e5c77 patch 9.1.0049: Make "[Command Line]" a special buffer name Christian Brabandt <cb@256bit.org> parents: 34135 diff changeset	3645 command TRUE if the buffer belongs to the
08e6a44e5c77 patch 9.1.0049: Make "[Command Line]" a special buffer name Christian Brabandt <cb@256bit.org> parents: 34135 diff changeset	3646 command-line window \|cmdwin\|.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3647 hidden TRUE if the buffer is hidden.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3648 lastused Timestamp in seconds, like
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3649 \|localtime()\|, when the buffer was
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3650 last used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3651 {only with the \|+viminfo\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3652 listed TRUE if the buffer is listed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3653 lnum Line number used for the buffer when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3654 opened in the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3655 Only valid if the buffer has been
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3656 displayed in the window in the past.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3657 If you want the line number of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3658 last known cursor position in a given
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3659 window, use \|line()\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3660 :echo line('.', {winid})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3661 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3662 linecount Number of lines in the buffer (only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3663 valid when loaded)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3664 loaded TRUE if the buffer is loaded.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3665 name Full path to the file in the buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3666 signs List of signs placed in the buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3667 Each list item is a dictionary with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3668 the following fields:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3669 id sign identifier
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3670 lnum line number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3671 name sign name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3672 variables A reference to the dictionary with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3673 buffer-local variables.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3674 windows List of \|window-ID\|s that display this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3675 buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3676 popups List of popup \|window-ID\|s that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3677 display this buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3678
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3679 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3680 for buf in getbufinfo()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3681 echo buf.name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3682 endfor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3683 for buf in getbufinfo({'buflisted':1})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3684 if buf.changed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3685 ....
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3686 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3687 endfor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3688 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3689 To get buffer-local options use: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3690 getbufvar({bufnr}, '&option_name')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3691 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3692 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3693 GetBufnr()->getbufinfo()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3694 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3695 Return type: list<dict<any>>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3696
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3697
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3698 getbufline()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3699 getbufline({buf}, {lnum} [, {end}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3700 Return a \|List\| with the lines starting from {lnum} to {end}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3701 (inclusive) in the buffer {buf}. If {end} is omitted, a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3702 \|List\| with only the line {lnum} is returned. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3703 `getbufoneline()` for only getting the line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3704
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3705 For the use of {buf}, see \|bufname()\| above.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3706
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3707 For {lnum} and {end} "$" can be used for the last line of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3708 buffer. Otherwise a number must be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3709
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3710 When {lnum} is smaller than 1 or bigger than the number of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3711 lines in the buffer, an empty \|List\| is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3712
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3713 When {end} is greater than the number of lines in the buffer,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3714 it is treated as {end} is set to the number of lines in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3715 buffer. When {end} is before {lnum} an empty \|List\| is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3716 returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3717
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3718 This function works only for loaded buffers. For unloaded and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3719 non-existing buffers, an empty \|List\| is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3720
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3721 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3722 :let lines = getbufline(bufnr("myfile"), 1, "$")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3723
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3724 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3725 GetBufnr()->getbufline(lnum)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3726 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3727 Return type: list<string>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3728
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3729 getbufoneline()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3730 getbufoneline({buf}, {lnum})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3731 Just like `getbufline()` but only get one line and return it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3732 as a string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3733
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3734 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3735
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3736
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3737 getbufvar({buf}, {varname} [, {def}]) getbufvar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3738 The result is the value of option or local buffer variable
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3739 {varname} in buffer {buf}. Note that the name without "b:"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3740 must be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3741 The {varname} argument is a string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3742 When {varname} is empty returns a \|Dictionary\| with all the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3743 buffer-local variables.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3744 When {varname} is equal to "&" returns a \|Dictionary\| with all
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3745 the buffer-local options.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3746 Otherwise, when {varname} starts with "&" returns the value of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3747 a buffer-local option.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3748 This also works for a global or buffer-local option, but it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3749 doesn't work for a global variable, window-local variable or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3750 window-local option.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3751 For the use of {buf}, see \|bufname()\| above.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3752 When the buffer or variable doesn't exist {def} or an empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3753 string is returned, there is no error message.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3754 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3755 :let bufmodified = getbufvar(1, "&mod")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3756 :echo "todo myvar = " .. getbufvar("todo", "myvar")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3757
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3758 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3759 GetBufnr()->getbufvar(varname)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3760 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3761 Return type: any, depending on {varname}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3762
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3763
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3764 getcellwidths() getcellwidths()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3765 Returns a \|List\| of cell widths of character ranges overridden
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3766 by \|setcellwidths()\|. The format is equal to the argument of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3767 \|setcellwidths()\|. If no character ranges have their cell
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3768 widths overridden, an empty List is returned.
35446 9d1bc7b46c10 runtime(doc): Fix typos in several documents Christian Brabandt <cb@256bit.org> parents: 35445 diff changeset	3769
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3770 Return type: list<any>
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3771
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3772
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3773 getchangelist([{buf}]) getchangelist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3774 Returns the \|changelist\| for the buffer {buf}. For the use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3775 of {buf}, see \|bufname()\| above. If buffer {buf} doesn't
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3776 exist, an empty list is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3777
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3778 The returned list contains two entries: a list with the change
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3779 locations and the current position in the list. Each
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3780 entry in the change list is a dictionary with the following
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3781 entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3782 col column number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3783 coladd column offset for 'virtualedit'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3784 lnum line number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3785 If buffer {buf} is the current buffer, then the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3786 position refers to the position in the list. For other
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3787 buffers, it is set to the length of the list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3788
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3789 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3790 GetBufnr()->getchangelist()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3791 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3792 Return type: list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3793
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3794
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	3795 getchar([{expr}]) getchar()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3796 Get a single character from the user or input stream.
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	3797 If {expr} is omitted, wait until a character is available.
4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	3798 If {expr} is 0, only get a character when one is available.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3799 Return zero otherwise.
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	3800 If {expr} is 1, only check if a character is available, it is
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3801 not consumed. Return zero if no character available.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3802 If you prefer always getting a string use \|getcharstr()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3803
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	3804 Without {expr} and when {expr} is 0 a whole character or
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3805 special key is returned. If it is a single character, the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3806 result is a Number. Use \|nr2char()\| to convert it to a String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3807 Otherwise a String is returned with the encoded character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3808 For a special key it's a String with a sequence of bytes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3809 starting with 0x80 (decimal: 128). This is the same value as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3810 the String "\<Key>", e.g., "\<Left>". The returned value is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3811 also a String when a modifier (shift, control, alt) was used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3812 that is not included in the character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3813
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	3814 When {expr} is 0 and Esc is typed, there will be a short delay
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3815 while Vim waits to see if this is the start of an escape
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3816 sequence.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3817
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	3818 When {expr} is 1 only the first byte is returned. For a
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3819 one-byte character it is the character itself as a number.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3820 Use nr2char() to convert it to a String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3821
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3822 Use getcharmod() to obtain any additional modifiers.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3823
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3824 When the user clicks a mouse button, the mouse event will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3825 returned. The position can then be found in \|v:mouse_col\|,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3826 \|v:mouse_lnum\|, \|v:mouse_winid\| and \|v:mouse_win\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3827 \|getmousepos()\| can also be used. Mouse move events will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3828 ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3829 This example positions the mouse as it would normally happen: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3830 let c = getchar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3831 if c == "\<LeftMouse>" && v:mouse_win > 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3832 exe v:mouse_win .. "wincmd w"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3833 exe v:mouse_lnum
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3834 exe "normal " .. v:mouse_col .. "\|"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3835 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3836 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3837 When using bracketed paste only the first character is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3838 returned, the rest of the pasted text is dropped.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3839 \|xterm-bracketed-paste\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3840
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3841 There is no prompt, you will somehow have to make clear to the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3842 user that a character has to be typed. The screen is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3843 redrawn, e.g. when resizing the window. When using a popup
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3844 window it should work better with a \|popup-filter\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3845
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3846 There is no mapping for the character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3847 Key codes are replaced, thus when the user presses the <Del>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3848 key you get the code for the <Del> key, not the raw character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3849 sequence. Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3850 getchar() == "\<Del>"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3851 getchar() == "\<S-Left>"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3852 < This example redefines "f" to ignore case: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3853 :nmap f :call FindChar()<CR>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3854 :function FindChar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3855 : let c = nr2char(getchar())
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3856 : while col('.') < col('$') - 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3857 : normal l
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3858 : if getline('.')[col('.') - 1] ==? c
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3859 : break
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3860 : endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3861 : endwhile
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3862 :endfunction
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3863 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3864 You may also receive synthetic characters, such as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3865 \|<CursorHold>\|. Often you will want to ignore this and get
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3866 another character: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3867 :function GetKey()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3868 : let c = getchar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3869 : while c == "\<CursorHold>"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3870 : let c = getchar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3871 : endwhile
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3872 : return c
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3873 :endfunction
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3874 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3875 Return type: \|Number\| or \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3876
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3877
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3878 getcharmod() getcharmod()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3879 The result is a Number which is the state of the modifiers for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3880 the last obtained character with getchar() or in another way.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3881 These values are added together:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3882 2 shift
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3883 4 control
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3884 8 alt (meta)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3885 16 meta (when it's different from ALT)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3886 32 mouse double click
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3887 64 mouse triple click
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3888 96 mouse quadruple click (== 32 + 64)
34219 a0a4a774117b patch 9.1.0058: Cannot map Super Keys in GTK UI Christian Brabandt <cb@256bit.org> parents: 34198 diff changeset	3889 128 command (Mac) or super (GTK)
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3890 Only the modifiers that have not been included in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3891 character itself are obtained. Thus Shift-a results in "A"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3892 without a modifier. Returns 0 if no modifiers are used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3893
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3894 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3895
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3896
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3897 getcharpos({expr}) getcharpos()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3898 Get the position for String {expr}. Same as \|getpos()\| but the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3899 column number in the returned List is a character index
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3900 instead of a byte index.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3901 If \|getpos()\| returns a very large column number, equal to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3902 \|v:maxcol\|, then getcharpos() will return the character index
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3903 of the last character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3904
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3905 Example:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3906 With the cursor on '세' in line 5 with text "여보세요": >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3907 getcharpos('.') returns [0, 5, 3, 0]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3908 getpos('.') returns [0, 5, 7, 0]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3909 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3910 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3911 GetMark()->getcharpos()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3912 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3913 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3914
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3915
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3916 getcharsearch() getcharsearch()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3917 Return the current character search information as a {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3918 with the following entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3919
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3920 char character previously used for a character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3921 search (\|t\|, \|f\|, \|T\|, or \|F\|); empty string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3922 if no character search has been performed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3923 forward direction of character search; 1 for forward,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3924 0 for backward
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3925 until type of character search; 1 for a \|t\| or \|T\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3926 character search, 0 for an \|f\| or \|F\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3927 character search
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3928
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3929 This can be useful to always have \|;\| and \|,\| search
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3930 forward/backward regardless of the direction of the previous
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3931 character search: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3932 :nnoremap <expr> ; getcharsearch().forward ? ';' : ','
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3933 :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3934 < Also see \|setcharsearch()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3935
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3936 Return type: dict<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3937
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3938
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	3939 getcharstr([{expr}]) getcharstr()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3940 Get a single character from the user or input stream as a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3941 string.
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	3942 If {expr} is omitted, wait until a character is available.
4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	3943 If {expr} is 0 or false, only get a character when one is
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3944 available. Return an empty string otherwise.
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	3945 If {expr} is 1 or true, only check if a character is
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3946 available, it is not consumed. Return an empty string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3947 if no character is available.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3948 Otherwise this works like \|getchar()\|, except that a number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3949 result is converted to a string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3950
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3951 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3952
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3953
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3954 getcmdcompltype() getcmdcompltype()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3955 Return the type of the current command-line completion.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3956 Only works when the command line is being edited, thus
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3957 requires use of \|c_CTRL-\_e\| or \|c_CTRL-R_=\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3958 See \|:command-completion\| for the return string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3959 Also see \|getcmdtype()\|, \|setcmdpos()\|, \|getcmdline()\| and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3960 \|setcmdline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3961 Returns an empty string when completion is not defined.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3962
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3963 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3964
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3965
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3966 getcmdline() getcmdline()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3967 Return the current command-line. Only works when the command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3968 line is being edited, thus requires use of \|c_CTRL-\_e\| or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3969 \|c_CTRL-R_=\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3970 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3971 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3972 < Also see \|getcmdtype()\|, \|getcmdpos()\|, \|setcmdpos()\| and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3973 \|setcmdline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3974 Returns an empty string when entering a password or using
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3975 \|inputsecret()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3976
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3977 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3978
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3979
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3980 getcmdpos() getcmdpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3981 Return the position of the cursor in the command line as a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3982 byte count. The first column is 1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3983 Only works when editing the command line, thus requires use of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3984 \|c_CTRL-\_e\| or \|c_CTRL-R_=\| or an expression mapping.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3985 Returns 0 otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3986 Also see \|getcmdtype()\|, \|setcmdpos()\|, \|getcmdline()\| and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3987 \|setcmdline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3988
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3989 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3990
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	3991
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3992 getcmdscreenpos() getcmdscreenpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3993 Return the screen position of the cursor in the command line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3994 as a byte count. The first column is 1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3995 Instead of \|getcmdpos()\|, it adds the prompt position.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3996 Only works when editing the command line, thus requires use of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3997 \|c_CTRL-\_e\| or \|c_CTRL-R_=\| or an expression mapping.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3998 Returns 0 otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	3999 Also see \|getcmdpos()\|, \|setcmdpos()\|, \|getcmdline()\| and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4000 \|setcmdline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4001
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4002 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4003
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4004
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4005 getcmdtype() getcmdtype()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4006 Return the current command-line type. Possible return values
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4007 are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4008 : normal Ex command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4009 > debug mode command \|debug-mode\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4010 / forward search command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4011 ? backward search command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4012 @ \|input()\| command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4013 - \|:insert\| or \|:append\| command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4014 = \|i_CTRL-R_=\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4015 Only works when editing the command line, thus requires use of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4016 \|c_CTRL-\_e\| or \|c_CTRL-R_=\| or an expression mapping.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4017 Returns an empty string otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4018 Also see \|getcmdpos()\|, \|setcmdpos()\| and \|getcmdline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4019
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4020 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4021
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4022
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4023 getcmdwintype() getcmdwintype()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4024 Return the current \|command-line-window\| type. Possible return
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4025 values are the same as \|getcmdtype()\|. Returns an empty string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4026 when not in the command-line window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4027
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4028 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4029
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4030
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4031 getcompletion({pat}, {type} [, {filtered}]) getcompletion()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4032 Return a list of command-line completion matches. The String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4033 {type} argument specifies what for. The following completion
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4034 types are supported:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4035
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4036 arglist file names in argument list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4037 augroup autocmd groups
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4038 buffer buffer names
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4039 behave \|:behave\| suboptions
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4040 breakpoint \|:breakadd\| and \|:breakdel\| suboptions
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4041 color color schemes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4042 command Ex command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4043 cmdline \|cmdline-completion\| result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4044 compiler compilers
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4045 cscope \|:cscope\| suboptions
32947 306f51627f50 commit 92997dda789ad8061841128cbc99b15ec0374411 Christian Brabandt <cb@256bit.org> parents: 32936 diff changeset	4046 custom,{func} custom completion, defined via {func}
306f51627f50 commit 92997dda789ad8061841128cbc99b15ec0374411 Christian Brabandt <cb@256bit.org> parents: 32936 diff changeset	4047 customlist,{func} custom completion, defined via {func}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4048 diff_buffer \|:diffget\| and \|:diffput\| completion
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4049 dir directory names
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4050 environment environment variable names
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4051 event autocommand events
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4052 expression Vim expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4053 file file and directory names
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4054 file_in_path file and directory names in \|'path'\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4055 filetype filetype names \|'filetype'\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4056 function function name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4057 help help subjects
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4058 highlight highlight groups
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4059 history \|:history\| suboptions
34082 a197265a2e07 patch 9.1.0010: Keymap completion is not available Christian Brabandt <cb@256bit.org> parents: 34080 diff changeset	4060 keymap keyboard mappings
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4061 locale locale names (as output of locale -a)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4062 mapclear buffer argument
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4063 mapping mapping name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4064 menu menus
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4065 messages \|:messages\| suboptions
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4066 option options
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4067 packadd optional package \|pack-add\| names
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4068 runtime \|:runtime\| completion
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4069 scriptnames sourced script names \|:scriptnames\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4070 shellcmd Shell command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4071 sign \|:sign\| suboptions
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4072 syntax syntax file names \|'syntax'\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4073 syntime \|:syntime\| suboptions
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4074 tag tags
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4075 tag_listfiles tags, file names
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4076 user user names
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4077 var user variables
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4078
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4079 If {pat} is an empty string, then all the matches are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4080 returned. Otherwise only items matching {pat} are returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4081 See \|wildcards\| for the use of special characters in {pat}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4082
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4083 If the optional {filtered} flag is set to 1, then 'wildignore'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4084 is applied to filter the results. Otherwise all the matches
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4085 are returned. The 'wildignorecase' option always applies.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4086
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4087 If the 'wildoptions' option contains 'fuzzy', then fuzzy
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4088 matching is used to get the completion matches. Otherwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4089 regular expression matching is used. Thus this function
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4090 follows the user preference, what happens on the command line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4091 If you do not want this you can make 'wildoptions' empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4092 before calling getcompletion() and restore it afterwards.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4093
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4094 If {type} is "cmdline", then the \|cmdline-completion\| result is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4095 returned. For example, to complete the possible values after
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4096 a ":call" command: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4097 echo getcompletion('call ', 'cmdline')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4098 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4099 If there are no matches, an empty list is returned. An
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4100 invalid value for {type} produces an error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4101
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4102 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4103 GetPattern()->getcompletion('color')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4104 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4105 Return type: list<string>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4106
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4107 getcurpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4108 getcurpos([{winid}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4109 Get the position of the cursor. This is like getpos('.'), but
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4110 includes an extra "curswant" item in the list:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4111 [0, lnum, col, off, curswant] ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4112 The "curswant" number is the preferred column when moving the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4113 cursor vertically. After \|$\| command it will be a very large
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4114 number equal to \|v:maxcol\|. Also see \|getcursorcharpos()\| and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4115 \|getpos()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4116 The first "bufnum" item is always zero. The byte position of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4117 the cursor is returned in 'col'. To get the character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4118 position, use \|getcursorcharpos()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4119
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4120 The optional {winid} argument can specify the window. It can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4121 be the window number or the \|window-ID\|. The last known
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4122 cursor position is returned, this may be invalid for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4123 current value of the buffer if it is not the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4124 If {winid} is invalid a list with zeroes is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4125
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4126 This can be used to save and restore the cursor position: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4127 let save_cursor = getcurpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4128 MoveTheCursorAround
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4129 call setpos('.', save_cursor)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4130 < Note that this only works within the window. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4131 \|winrestview()\| for restoring more state.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4132
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4133 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4134 GetWinid()->getcurpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4135 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4136 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4137
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4138
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4139 getcursorcharpos([{winid}]) getcursorcharpos()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4140 Same as \|getcurpos()\| but the column number in the returned
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4141 List is a character index instead of a byte index.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4142
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4143 Example:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4144 With the cursor on '보' in line 3 with text "여보세요": >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4145 getcursorcharpos() returns [0, 3, 2, 0, 3]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4146 getcurpos() returns [0, 3, 4, 0, 3]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4147 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4148 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4149 GetWinid()->getcursorcharpos()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4150 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4151 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4152
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4153
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4154 getcwd([{winnr} [, {tabnr}]]) getcwd()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4155 The result is a String, which is the name of the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4156 working directory. 'autochdir' is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4157
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4158 With {winnr} return the local current directory of this window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4159 in the current tab page. {winnr} can be the window number or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4160 the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4161 If {winnr} is -1 return the name of the global working
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4162 directory. See also \|haslocaldir()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4163
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4164 With {winnr} and {tabnr} return the local current directory of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4165 the window in the specified tab page. If {winnr} is -1 return
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4166 the working directory of the tabpage.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4167 If {winnr} is zero use the current window, if {tabnr} is zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4168 use the current tabpage.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4169 Without any arguments, return the actual working directory of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4170 the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4171 Return an empty string if the arguments are invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4172
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4173 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4174 " Get the working directory of the current window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4175 :echo getcwd()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4176 :echo getcwd(0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4177 :echo getcwd(0, 0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4178 " Get the working directory of window 3 in tabpage 2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4179 :echo getcwd(3, 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4180 " Get the global working directory
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4181 :echo getcwd(-1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4182 " Get the working directory of tabpage 3
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4183 :echo getcwd(-1, 3)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4184 " Get the working directory of current tabpage
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4185 :echo getcwd(-1, 0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4186
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4187 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4188 GetWinnr()->getcwd()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4189 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4190 Return type: \|String\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4191
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4192 getenv({name}) getenv()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4193 Return the value of environment variable {name}. The {name}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4194 argument is a string, without a leading '$'. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4195 myHome = getenv('HOME')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4196
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4197 < When the variable does not exist \|v:null\| is returned. That
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4198 is different from a variable set to an empty string, although
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4199 some systems interpret the empty value as the variable being
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4200 deleted. See also \|expr-env\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4201
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4202 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4203 GetVarname()->getenv()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4204 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4205 Return type: \|String\| or \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4206
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4207
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4208 getfontname([{name}]) getfontname()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4209 Without an argument returns the name of the normal font being
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4210 used. Like what is used for the Normal highlight group
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4211 \|hl-Normal\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4212 With an argument a check is done whether String {name} is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4213 valid font name. If not then an empty string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4214 Otherwise the actual font name is returned, or {name} if the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4215 GUI does not support obtaining the real name.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4216 Only works when the GUI is running, thus not in your vimrc or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4217 gvimrc file. Use the \|GUIEnter\| autocommand to use this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4218 function just after the GUI has started.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4219 Note that the GTK GUI accepts any font name, thus checking for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4220 a valid name does not work.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4221
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4222 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4223
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4224
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4225 getfperm({fname}) getfperm()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4226 The result is a String, which is the read, write, and execute
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4227 permissions of the given file {fname}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4228 If {fname} does not exist or its directory cannot be read, an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4229 empty string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4230 The result is of the form "rwxrwxrwx", where each group of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4231 "rwx" flags represent, in turn, the permissions of the owner
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4232 of the file, the group the file belongs to, and other users.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4233 If a user does not have a given permission the flag for this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4234 is replaced with the string "-". Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4235 :echo getfperm("/etc/passwd")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4236 :echo getfperm(expand("~/.vimrc"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4237 < This will hopefully (from a security point of view) display
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4238 the string "rw-r--r--" or even "rw-------".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4239
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4240 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4241 GetFilename()->getfperm()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4242 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4243 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4244
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4245 For setting permissions use \|setfperm()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4246
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4247
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4248 getfsize({fname}) getfsize()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4249 The result is a Number, which is the size in bytes of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4250 given file {fname}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4251 If {fname} is a directory, 0 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4252 If the file {fname} can't be found, -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4253 If the size of {fname} is too big to fit in a Number then -2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4254 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4255
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4256 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4257 GetFilename()->getfsize()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4258 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4259 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4260
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4261
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4262 getftime({fname}) getftime()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4263 The result is a Number, which is the last modification time of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4264 the given file {fname}. The value is measured as seconds
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4265 since 1st Jan 1970, and may be passed to strftime(). See also
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4266 \|localtime()\| and \|strftime()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4267 If the file {fname} can't be found -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4268
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4269 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4270 GetFilename()->getftime()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4271 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4272 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4273
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4274
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4275 getftype({fname}) getftype()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4276 The result is a String, which is a description of the kind of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4277 file of the given file {fname}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4278 If {fname} does not exist an empty string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4279 Here is a table over different kinds of files and their
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4280 results:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4281 Normal file "file"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4282 Directory "dir"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4283 Symbolic link "link"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4284 Block device "bdev"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4285 Character device "cdev"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4286 Socket "socket"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4287 FIFO "fifo"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4288 All other "other"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4289 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4290 getftype("/home")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4291 < Note that a type such as "link" will only be returned on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4292 systems that support it. On some systems only "dir" and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4293 "file" are returned. On MS-Windows a symbolic link to a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4294 directory returns "dir" instead of "link".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4295
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4296 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4297 GetFilename()->getftype()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4298 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4299 Return type: \|String\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4300
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4301 getimstatus() getimstatus()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4302 The result is a Number, which is \|TRUE\| when the IME status is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4303 active and \|FALSE\| otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4304 See 'imstatusfunc'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4305
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4306 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4307
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4308
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4309 getjumplist([{winnr} [, {tabnr}]]) getjumplist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4310 Returns the \|jumplist\| for the specified window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4311
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4312 Without arguments use the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4313 With {winnr} only use this window in the current tab page.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4314 {winnr} can also be a \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4315 With {winnr} and {tabnr} use the window in the specified tab
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4316 page. If {winnr} or {tabnr} is invalid, an empty list is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4317 returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4318
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4319 The returned list contains two entries: a list with the jump
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4320 locations and the last used jump position number in the list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4321 Each entry in the jump location list is a dictionary with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4322 the following entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4323 bufnr buffer number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4324 col column number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4325 coladd column offset for 'virtualedit'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4326 filename filename if available
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4327 lnum line number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4328
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4329 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4330 GetWinnr()->getjumplist()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4331 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4332 Return type: list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4333
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4334 getline()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4335 getline({lnum} [, {end}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4336 Without {end} the result is a String, which is line {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4337 from the current buffer. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4338 getline(1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4339 < When {lnum} is a String that doesn't start with a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4340 digit, \|line()\| is called to translate the String into a Number.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4341 To get the line under the cursor: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4342 getline(".")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4343 < When {lnum} is a number smaller than 1 or bigger than the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4344 number of lines in the buffer, an empty string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4345
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4346 When {end} is given the result is a \|List\| where each item is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4347 a line from the current buffer in the range {lnum} to {end},
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4348 including line {end}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4349 {end} is used in the same way as {lnum}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4350 Non-existing lines are silently omitted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4351 When {end} is before {lnum} an empty \|List\| is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4352 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4353 :let start = line('.')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4354 :let end = search("^$") - 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4355 :let lines = getline(start, end)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4356
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4357 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4358 ComputeLnum()->getline()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4359 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4360 Return type: list<string> or \|String\| depending on {end}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4361
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4362 To get lines from another buffer see \|getbufline()\| and
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4363 \|getbufoneline()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4364
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4365 getloclist({nr} [, {what}]) getloclist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4366 Returns a \|List\| with all the entries in the location list for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4367 window {nr}. {nr} can be the window number or the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4368 When {nr} is zero the current window is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4369
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4370 For a location list window, the displayed location list is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4371 returned. For an invalid window number {nr}, an empty list is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4372 returned. Otherwise, same as \|getqflist()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4373
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4374 If the optional {what} dictionary argument is supplied, then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4375 returns the items listed in {what} as a dictionary. Refer to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4376 \|getqflist()\| for the supported items in {what}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4377
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4378 In addition to the items supported by \|getqflist()\| in {what},
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4379 the following item is supported by \|getloclist()\|:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4380
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4381 filewinid id of the window used to display files
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4382 from the location list. This field is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4383 applicable only when called from a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4384 location list window. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4385 \|location-list-file-window\| for more
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4386 details.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4387
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4388 Returns a \|Dictionary\| with default values if there is no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4389 location list for the window {nr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4390 Returns an empty Dictionary if window {nr} does not exist.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4391
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4392 Examples (See also \|getqflist-examples\|): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4393 :echo getloclist(3, {'all': 0})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4394 :echo getloclist(5, {'filewinid': 0})
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4395 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4396 Return type: list<dict<any>> or list<any>
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4397
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4398
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4399 getmarklist([{buf}]) getmarklist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4400 Without the {buf} argument returns a \|List\| with information
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4401 about all the global marks. \|mark\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4402
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4403 If the optional {buf} argument is specified, returns the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4404 local marks defined in buffer {buf}. For the use of {buf},
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4405 see \|bufname()\|. If {buf} is invalid, an empty list is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4406 returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4407
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4408 Each item in the returned List is a \|Dict\| with the following:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4409 mark name of the mark prefixed by "'"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4410 pos a \|List\| with the position of the mark:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4411 [bufnum, lnum, col, off]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4412 Refer to \|getpos()\| for more information.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4413 file file name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4414
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4415 Refer to \|getpos()\| for getting information about a specific
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4416 mark.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4417
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4418 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4419 GetBufnr()->getmarklist()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4420 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4421 Return type: list<dict<any>> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4422
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4423
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4424 getmatches([{win}]) getmatches()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4425 Returns a \|List\| with all matches previously defined for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4426 current window by \|matchadd()\| and the \|:match\| commands.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4427 \|getmatches()\| is useful in combination with \|setmatches()\|,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4428 as \|setmatches()\| can restore a list of matches saved by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4429 \|getmatches()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4430 If {win} is specified, use the window with this number or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4431 window ID instead of the current window. If {win} is invalid,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4432 an empty list is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4433 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4434 :echo getmatches()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4435 < [{'group': 'MyGroup1', 'pattern': 'TODO',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4436 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4437 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4438 :let m = getmatches()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4439 :call clearmatches()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4440 :echo getmatches()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4441 < [] >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4442 :call setmatches(m)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4443 :echo getmatches()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4444 < [{'group': 'MyGroup1', 'pattern': 'TODO',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4445 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4446 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4447 :unlet m
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4448 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4449 Return type: list<dict<any>> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4450
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4451
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4452 getmousepos() getmousepos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4453 Returns a \|Dictionary\| with the last known position of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4454 mouse. This can be used in a mapping for a mouse click or in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4455 a filter of a popup window. The items are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4456 screenrow screen row
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4457 screencol screen column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4458 winid Window ID of the click
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4459 winrow row inside "winid"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4460 wincol column inside "winid"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4461 line text line inside "winid"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4462 column text column inside "winid"
33575 8fc442c731ca patch 9.0.2032: cannot get mouse click pos for tab or virt text Christian Brabandt <cb@256bit.org> parents: 33549 diff changeset	4463 coladd offset (in screen columns) from the
8fc442c731ca patch 9.0.2032: cannot get mouse click pos for tab or virt text Christian Brabandt <cb@256bit.org> parents: 33549 diff changeset	4464 start of the clicked char
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4465 All numbers are 1-based.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4466
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4467 If not over a window, e.g. when in the command line, then only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4468 "screenrow" and "screencol" are valid, the others are zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4469
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4470 When on the status line below a window or the vertical
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4471 separator right of a window, the "line" and "column" values
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4472 are zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4473
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4474 When the position is after the text then "column" is the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4475 length of the text in bytes plus one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4476
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4477 If the mouse is over a popup window then that window is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4478
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4479 When using \|getchar()\| the Vim variables \|v:mouse_lnum\|,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4480 \|v:mouse_col\| and \|v:mouse_winid\| also provide these values.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4481
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4482 Return type: dict<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4483
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4484
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4485 getmouseshape() getmouseshape()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4486 Returns the name of the currently showing mouse pointer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4487 When the \|+mouseshape\| feature is not supported or the shape
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4488 is unknown an empty string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4489 This function is mainly intended for testing.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4490
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4491 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4492
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4493
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4494 getpid() getpid()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4495 Return a Number which is the process ID of the Vim process.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4496 On Unix and MS-Windows this is a unique number, until Vim
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4497 exits.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4498
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4499 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4500
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4501
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4502 getpos({expr}) getpos()
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4503 Get the position for String {expr}.
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4504 The accepted values for {expr} are: E1209
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4505 . The cursor position.
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4506 $ The last line in the current buffer.
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4507 'x Position of mark x (if the mark is not set, 0 is
35386 57a8e2f92efd runtime(doc): restore description of "$" in col() and virtcol() (#14981) Christian Brabandt <cb@256bit.org> parents: 35385 diff changeset	4508 returned for all values).
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4509 w0 First line visible in current window (one if the
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4510 display isn't updated, e.g. in silent Ex mode).
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4511 w$ Last line visible in current window (this is one
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4512 less than "w0" if no lines are visible).
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4513 v When not in Visual mode, returns the cursor
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4514 position. In Visual mode, returns the other end
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4515 of the Visual area. A good way to think about
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4516 this is that in Visual mode "v" and "." complement
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4517 each other. While "." refers to the cursor
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4518 position, "v" refers to where \|v_o\| would move the
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4519 cursor. As a result, you can use "v" and "."
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4520 together to work on all of a selection in
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4521 characterwise Visual mode. If the cursor is at
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4522 the end of a characterwise Visual area, "v" refers
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4523 to the start of the same Visual area. And if the
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4524 cursor is at the start of a characterwise Visual
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4525 area, "v" refers to the end of the same Visual
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4526 area. "v" differs from \|'<\| and \|'>\| in that it's
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4527 updated right away.
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4528 Note that a mark in another file can be used. The line number
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4529 then applies to another buffer.
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4530
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4531 The result is a \|List\| with four numbers:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4532 [bufnum, lnum, col, off]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4533 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4534 is the buffer number of the mark.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4535 "lnum" and "col" are the position in the buffer. The first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4536 column is 1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4537 The "off" number is zero, unless 'virtualedit' is used. Then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4538 it is the offset in screen columns from the start of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4539 character. E.g., a position within a <Tab> or after the last
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4540 character.
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4541
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4542 For getting the cursor position see \|getcurpos()\|.
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4543 The column number in the returned List is the byte position
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4544 within the line. To get the character position in the line,
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4545 use \|getcharpos()\|.
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4546
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4547 Note that for '< and '> Visual mode matters: when it is "V"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4548 (visual line mode) the column of '< is zero and the column of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4549 '> is a large number equal to \|v:maxcol\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4550 A very large column number equal to \|v:maxcol\| can be returned,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4551 in which case it means "after the end of the line".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4552 If {expr} is invalid, returns a list with all zeros.
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	4553
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4554 This can be used to save and restore the position of a mark: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4555 let save_a_mark = getpos("'a")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4556 ...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4557 call setpos("'a", save_a_mark)
35386 57a8e2f92efd runtime(doc): restore description of "$" in col() and virtcol() (#14981) Christian Brabandt <cb@256bit.org> parents: 35385 diff changeset	4558 <
57a8e2f92efd runtime(doc): restore description of "$" in col() and virtcol() (#14981) Christian Brabandt <cb@256bit.org> parents: 35385 diff changeset	4559 Also see \|getcharpos()\|, \|getcurpos()\| and \|setpos()\|.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4560
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4561 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4562 GetMark()->getpos()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4563 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4564 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4565
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4566
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4567 getqflist([{what}]) getqflist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4568 Returns a \|List\| with all the current quickfix errors. Each
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4569 list item is a dictionary with these entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4570 bufnr number of buffer that has the file name, use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4571 bufname() to get the name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4572 module module name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4573 lnum line number in the buffer (first line is 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4574 end_lnum
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4575 end of line number if the item is multiline
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4576 col column number (first column is 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4577 end_col end of column number if the item has range
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4578 vcol \|TRUE\|: "col" is visual column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4579 \|FALSE\|: "col" is byte index
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4580 nr error number
35446 9d1bc7b46c10 runtime(doc): Fix typos in several documents Christian Brabandt <cb@256bit.org> parents: 35445 diff changeset	4581 pattern search pattern used to locate the error
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4582 text description of the error
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4583 type type of the error, 'E', '1', etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4584 valid \|TRUE\|: recognized error message
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	4585 user_data
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	4586 custom data associated with the item, can be
32738 05188ca69e43 patch 9.0.1688: cannot store custom data in quickfix list Christian Brabandt <cb@256bit.org> parents: 32732 diff changeset	4587 any type.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4588
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4589 When there is no error list or it's empty, an empty list is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4590 returned. Quickfix list entries with a non-existing buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4591 number are returned with "bufnr" set to zero (Note: some
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4592 functions accept buffer number zero for the alternate buffer,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4593 you may need to explicitly check for zero).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4594
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4595 Useful application: Find pattern matches in multiple files and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4596 do something with them: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4597 :vimgrep /theword/jg *.c
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4598 :for d in getqflist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4599 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4600 :endfor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4601 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4602 If the optional {what} dictionary argument is supplied, then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4603 returns only the items listed in {what} as a dictionary. The
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4604 following string items are supported in {what}:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4605 changedtick get the total number of changes made
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4606 to the list \|quickfix-changedtick\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4607 context get the \|quickfix-context\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4608 efm errorformat to use when parsing "lines". If
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4609 not present, then the 'errorformat' option
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4610 value is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4611 id get information for the quickfix list with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4612 \|quickfix-ID\|; zero means the id for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4613 current list or the list specified by "nr"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4614 idx get information for the quickfix entry at this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4615 index in the list specified by 'id' or 'nr'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4616 If set to zero, then uses the current entry.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4617 See \|quickfix-index\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4618 items quickfix list entries
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4619 lines parse a list of lines using 'efm' and return
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4620 the resulting entries. Only a \|List\| type is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4621 accepted. The current quickfix list is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4622 modified. See \|quickfix-parse\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4623 nr get information for this quickfix list; zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4624 means the current quickfix list and "$" means
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4625 the last quickfix list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4626 qfbufnr number of the buffer displayed in the quickfix
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4627 window. Returns 0 if the quickfix buffer is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4628 not present. See \|quickfix-buffer\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4629 size number of entries in the quickfix list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4630 title get the list title \|quickfix-title\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4631 winid get the quickfix \|window-ID\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4632 all all of the above quickfix properties
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4633 Non-string items in {what} are ignored. To get the value of a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4634 particular item, set it to zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4635 If "nr" is not present then the current quickfix list is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4636 If both "nr" and a non-zero "id" are specified, then the list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4637 specified by "id" is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4638 To get the number of lists in the quickfix stack, set "nr" to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4639 "$" in {what}. The "nr" value in the returned dictionary
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4640 contains the quickfix stack size.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4641 When "lines" is specified, all the other items except "efm"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4642 are ignored. The returned dictionary contains the entry
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4643 "items" with the list of entries.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4644
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4645 The returned dictionary contains the following entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4646 changedtick total number of changes made to the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4647 list \|quickfix-changedtick\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4648 context quickfix list context. See \|quickfix-context\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4649 If not present, set to "".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4650 id quickfix list ID \|quickfix-ID\|. If not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4651 present, set to 0.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4652 idx index of the quickfix entry in the list. If not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4653 present, set to 0.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4654 items quickfix list entries. If not present, set to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4655 an empty list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4656 nr quickfix list number. If not present, set to 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4657 qfbufnr number of the buffer displayed in the quickfix
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4658 window. If not present, set to 0.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4659 size number of entries in the quickfix list. If not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4660 present, set to 0.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4661 title quickfix list title text. If not present, set
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4662 to "".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4663 winid quickfix \|window-ID\|. If not present, set to 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4664
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4665 Examples (See also \|getqflist-examples\|): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4666 :echo getqflist({'all': 1})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4667 :echo getqflist({'nr': 2, 'title': 1})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4668 :echo getqflist({'lines' : ["F1:10:L10"]})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4669 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4670 Return type: list<dict<any>> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4671
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4672
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4673 getreg([{regname} [, 1 [, {list}]]]) getreg()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4674 The result is a String, which is the contents of register
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4675 {regname}. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4676 :let cliptext = getreg('*')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4677 < When register {regname} was not set the result is an empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4678 string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4679 The {regname} argument must be a string. E1162
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4680
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4681 getreg('=') returns the last evaluated value of the expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4682 register. (For use in maps.)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4683 getreg('=', 1) returns the expression itself, so that it can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4684 be restored with \|setreg()\|. For other registers the extra
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4685 argument is ignored, thus you can always give it.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4686
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4687 If {list} is present and \|TRUE\|, the result type is changed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4688 to \|List\|. Each list item is one text line. Use it if you care
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4689 about zero bytes possibly present inside register: without
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4690 third argument both NLs and zero bytes are represented as NLs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4691 (see \|NL-used-for-Nul\|).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4692 When the register was not set an empty list is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4693
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4694 If {regname} is "", the unnamed register '"' is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4695 If {regname} is not specified, \|v:register\| is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4696 In \|Vim9-script\| {regname} must be one character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4697
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4698 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4699 GetRegname()->getreg()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4700 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4701 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4702
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4703
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4704 getreginfo([{regname}]) getreginfo()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4705 Returns detailed information about register {regname} as a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4706 Dictionary with the following entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4707 regcontents List of lines contained in register
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4708 {regname}, like
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4709 \|getreg\|({regname}, 1, 1).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4710 regtype the type of register {regname}, as in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4711 \|getregtype()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4712 isunnamed Boolean flag, v:true if this register
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4713 is currently pointed to by the unnamed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4714 register.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4715 points_to for the unnamed register, gives the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4716 single letter name of the register
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4717 currently pointed to (see \|quotequote\|).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4718 For example, after deleting a line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4719 with `dd`, this field will be "1",
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4720 which is the register that got the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4721 deleted text.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4722
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4723 The {regname} argument is a string. If {regname} is invalid
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4724 or not set, an empty Dictionary will be returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4725 If {regname} is "" or "@", the unnamed register '"' is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4726 If {regname} is not specified, \|v:register\| is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4727 The returned Dictionary can be passed to \|setreg()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4728 In \|Vim9-script\| {regname} must be one character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4729
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4730 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4731 GetRegname()->getreginfo()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4732 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4733 Return type: dict<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4734
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4735
34451 d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4736 getregion({pos1}, {pos2} [, {opts}]) getregion()
34497 7cc0b2479fad patch 9.1.0155: can only get getregion() from current buffer Christian Brabandt <cb@256bit.org> parents: 34472 diff changeset	4737 Returns the list of strings from {pos1} to {pos2} from a
34451 d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4738 buffer.
d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4739
d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4740 {pos1} and {pos2} must both be \|List\|s with four numbers.
34497 7cc0b2479fad patch 9.1.0155: can only get getregion() from current buffer Christian Brabandt <cb@256bit.org> parents: 34472 diff changeset	4741 See \|getpos()\| for the format of the list. It's possible
7cc0b2479fad patch 9.1.0155: can only get getregion() from current buffer Christian Brabandt <cb@256bit.org> parents: 34472 diff changeset	4742 to specify positions from a different buffer, but please
34502 bb8b21242cff patch 9.1.0157: Duplicate assignment in f_getregion() Christian Brabandt <cb@256bit.org> parents: 34497 diff changeset	4743 note the limitations at \|getregion-notes\|.
34451 d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4744
d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4745 The optional argument {opts} is a Dict and supports the
d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4746 following items:
d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4747
35270 2d25137c6f44 patch 9.1.0443: Can't use blockwise selection with width for getregion() Christian Brabandt <cb@256bit.org> parents: 35264 diff changeset	4748 type Specify the region's selection type.
2d25137c6f44 patch 9.1.0443: Can't use blockwise selection with width for getregion() Christian Brabandt <cb@256bit.org> parents: 35264 diff changeset	4749 See \|getregtype()\| for possible values,
35272 590b2d5b5b1a patch 9.1.0444: Not enough tests for getregion() with multibyte chars Christian Brabandt <cb@256bit.org> parents: 35270 diff changeset	4750 except that the width can be omitted
590b2d5b5b1a patch 9.1.0444: Not enough tests for getregion() with multibyte chars Christian Brabandt <cb@256bit.org> parents: 35270 diff changeset	4751 and an empty string cannot be used.
35270 2d25137c6f44 patch 9.1.0443: Can't use blockwise selection with width for getregion() Christian Brabandt <cb@256bit.org> parents: 35264 diff changeset	4752 (default: "v")
34451 d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4753
34463 4944acf6b46f runtime(doc): some improvements to getregion() docs (#14122) Christian Brabandt <cb@256bit.org> parents: 34451 diff changeset	4754 exclusive If \|TRUE\|, use exclusive selection
35270 2d25137c6f44 patch 9.1.0443: Can't use blockwise selection with width for getregion() Christian Brabandt <cb@256bit.org> parents: 35264 diff changeset	4755 for the end position.
34463 4944acf6b46f runtime(doc): some improvements to getregion() docs (#14122) Christian Brabandt <cb@256bit.org> parents: 34451 diff changeset	4756 (default: follow 'selection')
34451 d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4757
34387 e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4758 You can get the last selection type by \|visualmode()\|.
e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4759 If Visual mode is active, use \|mode()\| to get the Visual mode
e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4760 (e.g., in a \|:vmap\|).
34463 4944acf6b46f runtime(doc): some improvements to getregion() docs (#14122) Christian Brabandt <cb@256bit.org> parents: 34451 diff changeset	4761 This function is useful to get text starting and ending in
4944acf6b46f runtime(doc): some improvements to getregion() docs (#14122) Christian Brabandt <cb@256bit.org> parents: 34451 diff changeset	4762 different columns, such as a \|characterwise-visual\| selection.
34387 e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4763
34497 7cc0b2479fad patch 9.1.0155: can only get getregion() from current buffer Christian Brabandt <cb@256bit.org> parents: 34472 diff changeset	4764 getregion-notes
34387 e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4765 Note that:
e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4766 - Order of {pos1} and {pos2} doesn't matter, it will always
e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4767 return content from the upper left position to the lower
e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4768 right position.
34463 4944acf6b46f runtime(doc): some improvements to getregion() docs (#14122) Christian Brabandt <cb@256bit.org> parents: 34451 diff changeset	4769 - If 'virtualedit' is enabled and the region is past the end
4944acf6b46f runtime(doc): some improvements to getregion() docs (#14122) Christian Brabandt <cb@256bit.org> parents: 34451 diff changeset	4770 of the lines, resulting lines are padded with spaces.
4944acf6b46f runtime(doc): some improvements to getregion() docs (#14122) Christian Brabandt <cb@256bit.org> parents: 34451 diff changeset	4771 - If the region is blockwise and it starts or ends in the
4944acf6b46f runtime(doc): some improvements to getregion() docs (#14122) Christian Brabandt <cb@256bit.org> parents: 34451 diff changeset	4772 middle of a multi-cell character, it is not included but
4944acf6b46f runtime(doc): some improvements to getregion() docs (#14122) Christian Brabandt <cb@256bit.org> parents: 34451 diff changeset	4773 its selected part is substituted with spaces.
34497 7cc0b2479fad patch 9.1.0155: can only get getregion() from current buffer Christian Brabandt <cb@256bit.org> parents: 34472 diff changeset	4774 - If {pos1} and {pos2} are not in the same buffer, an empty
34403 940c794b6ba7 patch 9.1.0126: Internal error when using upper-case mark in getregion() Christian Brabandt <cb@256bit.org> parents: 34396 diff changeset	4775 list is returned.
34497 7cc0b2479fad patch 9.1.0155: can only get getregion() from current buffer Christian Brabandt <cb@256bit.org> parents: 34472 diff changeset	4776 - {pos1} and {pos2} must belong to a \|bufloaded()\| buffer.
34502 bb8b21242cff patch 9.1.0157: Duplicate assignment in f_getregion() Christian Brabandt <cb@256bit.org> parents: 34497 diff changeset	4777 - It is evaluated in current window context, which makes a
bb8b21242cff patch 9.1.0157: Duplicate assignment in f_getregion() Christian Brabandt <cb@256bit.org> parents: 34497 diff changeset	4778 difference if the buffer is displayed in a window with
bb8b21242cff patch 9.1.0157: Duplicate assignment in f_getregion() Christian Brabandt <cb@256bit.org> parents: 34497 diff changeset	4779 different 'virtualedit' or 'list' values.
34387 e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4780
e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4781 Examples: >
e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4782 :xnoremap <CR>
34451 d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4783 \ <Cmd>echow getregion(
d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4784 \ getpos('v'), getpos('.'), #{ type: mode() })<CR>
d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4785 <
d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4786 Can also be used as a \|method\|: >
d06ffca91441 patch 9.1.0142: getregion() can be improved Christian Brabandt <cb@256bit.org> parents: 34427 diff changeset	4787 getpos('.')->getregion(getpos("'a"))
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4788
34387 e6defaa1e46a patch 9.1.0120: hard to get visual region using Vim script Christian Brabandt <cb@256bit.org> parents: 34381 diff changeset	4789 <
35125 9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4790 getregionpos({pos1}, {pos2} [, {opts}]) getregionpos()
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4791 Same as \|getregion()\|, but returns a list of positions
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4792 describing the buffer text segments bound by {pos1} and
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4793 {pos2}.
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4794 The segments are a pair of positions for every line: >
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4795 [[{start_pos}, {end_pos}], ...]
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4796 <
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4797 The position is a \|List\| with four numbers:
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4798 [bufnum, lnum, col, off]
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4799 "bufnum" is the buffer number.
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4800 "lnum" and "col" are the position in the buffer. The first
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4801 column is 1.
35214 ef167a7e3c7a patch 9.1.0423: getregionpos() wrong with blockwise mode and multibyte Christian Brabandt <cb@256bit.org> parents: 35200 diff changeset	4802 If the "off" number of a starting position is non-zero, it is
ef167a7e3c7a patch 9.1.0423: getregionpos() wrong with blockwise mode and multibyte Christian Brabandt <cb@256bit.org> parents: 35200 diff changeset	4803 the offset in screen columns from the start of the character.
ef167a7e3c7a patch 9.1.0423: getregionpos() wrong with blockwise mode and multibyte Christian Brabandt <cb@256bit.org> parents: 35200 diff changeset	4804 E.g., a position within a <Tab> or after the last character.
ef167a7e3c7a patch 9.1.0423: getregionpos() wrong with blockwise mode and multibyte Christian Brabandt <cb@256bit.org> parents: 35200 diff changeset	4805 If the "off" number of an ending position is non-zero, it is
35239 d3c4f1dcd956 patch 9.1.0430: getregionpos() doesn't handle one char selection Christian Brabandt <cb@256bit.org> parents: 35214 diff changeset	4806 the offset of the character's first cell not included in the
d3c4f1dcd956 patch 9.1.0430: getregionpos() doesn't handle one char selection Christian Brabandt <cb@256bit.org> parents: 35214 diff changeset	4807 selection, otherwise all its cells are included.
35125 9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4808
35264 7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4809 Apart from the options supported by \|getregion()\|, {opts} also
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4810 supports the following:
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4811
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4812 eol If \|TRUE\|, indicate positions beyond
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4813 the end of a line with "col" values
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4814 one more than the length of the line.
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4815 If \|FALSE\|, positions are limited
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4816 within their lines, and if a line is
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4817 empty or the selection is entirely
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4818 beyond the end of a line, a "col"
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4819 value of 0 is used for both positions.
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4820 (default: \|FALSE\|)
7cad6356f2af patch 9.1.0441: getregionpos() can't properly indicate positions beyond eol Christian Brabandt <cb@256bit.org> parents: 35239 diff changeset	4821
35125 9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4822 Can also be used as a \|method\|: >
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4823 getpos('.')->getregionpos(getpos("'a"))
9322493ebe58 patch 9.1.0394: Cannot get a list of positions describing a region Christian Brabandt <cb@256bit.org> parents: 35121 diff changeset	4824 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4825 Return type: list<string>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4826
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4827
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4828 getregtype([{regname}]) getregtype()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4829 The result is a String, which is type of register {regname}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4830 The value will be one of:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4831 "v" for \|characterwise\| text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4832 "V" for \|linewise\| text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4833 "<CTRL-V>{width}" for \|blockwise-visual\| text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4834 "" for an empty or unknown register
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4835 <CTRL-V> is one character with value 0x16.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4836 The {regname} argument is a string. If {regname} is "", the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4837 unnamed register '"' is used. If {regname} is not specified,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4838 \|v:register\| is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4839 In \|Vim9-script\| {regname} must be one character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4840
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4841 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4842 GetRegname()->getregtype()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4843 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4844 Return type: \|String\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4845
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4846 getscriptinfo([{opts}]) getscriptinfo()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4847 Returns a \|List\| with information about all the sourced Vim
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4848 scripts in the order they were sourced, like what
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4849 `:scriptnames` shows.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4850
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4851 The optional Dict argument {opts} supports the following
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4852 optional items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4853 name Script name match pattern. If specified,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4854 and "sid" is not specified, information about
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4855 scripts with a name that match the pattern
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4856 "name" are returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4857 sid Script ID \|<SID>\|. If specified, only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4858 information about the script with ID "sid" is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4859 returned and "name" is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4860
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4861 Each item in the returned List is a \|Dict\| with the following
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4862 items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4863 autoload Set to TRUE for a script that was used with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4864 `import autoload` but was not actually sourced
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4865 yet (see \|import-autoload\|).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4866 functions List of script-local function names defined in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4867 the script. Present only when a particular
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4868 script is specified using the "sid" item in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4869 {opts}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4870 name Vim script file name.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4871 sid Script ID \|<SID>\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4872 sourced Script ID of the actually sourced script that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4873 this script name links to, if any, otherwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4874 zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4875 variables A dictionary with the script-local variables.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4876 Present only when a particular script is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4877 specified using the "sid" item in {opts}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4878 Note that this is a copy, the value of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4879 script-local variables cannot be changed using
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4880 this dictionary.
33649 88cad94caef9 runtime(doc): Fix typos in several documents (#13420) Christian Brabandt <cb@256bit.org> parents: 33594 diff changeset	4881 version Vim script version (\|scriptversion\|)
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4882
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4883 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4884 :echo getscriptinfo({'name': 'myscript'})
35116 0085eaac614f runtime(doc): correct getscriptinfo() example (#14718) Christian Brabandt <cb@256bit.org> parents: 35051 diff changeset	4885 :echo getscriptinfo({'sid': 15})[0].variables
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4886 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4887 Return type: list<dict<any>>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4888
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4889
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4890 gettabinfo([{tabnr}]) gettabinfo()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4891 If {tabnr} is not specified, then information about all the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4892 tab pages is returned as a \|List\|. Each List item is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4893 \|Dictionary\|. Otherwise, {tabnr} specifies the tab page
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4894 number and information about that one is returned. If the tab
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4895 page does not exist an empty List is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4896
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4897 Each List item is a \|Dictionary\| with the following entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4898 tabnr tab page number.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4899 variables a reference to the dictionary with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4900 tabpage-local variables
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4901 windows List of \|window-ID\|s in the tab page.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4902
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4903 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4904 GetTabnr()->gettabinfo()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4905 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4906 Return type: list<dict<any>>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4907
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4908
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4909 gettabvar({tabnr}, {varname} [, {def}]) gettabvar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4910 Get the value of a tab-local variable {varname} in tab page
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4911 {tabnr}. \|t:var\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4912 Tabs are numbered starting with one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4913 The {varname} argument is a string. When {varname} is empty a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4914 dictionary with all tab-local variables is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4915 Note that the name without "t:" must be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4916 When the tab or variable doesn't exist {def} or an empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4917 string is returned, there is no error message.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4918
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4919 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4920 GetTabnr()->gettabvar(varname)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4921 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4922 Return type: any, depending on {varname}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4923
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4924
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4925 gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) gettabwinvar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4926 Get the value of window-local variable {varname} in window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4927 {winnr} in tab page {tabnr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4928 The {varname} argument is a string. When {varname} is empty a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4929 dictionary with all window-local variables is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4930 When {varname} is equal to "&" get the values of all
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4931 window-local options in a \|Dictionary\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4932 Otherwise, when {varname} starts with "&" get the value of a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4933 window-local option.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4934 Note that {varname} must be the name without "w:".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4935 Tabs are numbered starting with one. For the current tabpage
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4936 use \|getwinvar()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4937 {winnr} can be the window number or the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4938 When {winnr} is zero the current window is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4939 This also works for a global option, buffer-local option and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4940 window-local option, but it doesn't work for a global variable
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4941 or buffer-local variable.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4942 When the tab, window or variable doesn't exist {def} or an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4943 empty string is returned, there is no error message.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4944 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4945 :let list_is_on = gettabwinvar(1, 2, '&list')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4946 :echo "myvar = " .. gettabwinvar(3, 1, 'myvar')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4947 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4948 To obtain all window-local variables use: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4949 gettabwinvar({tabnr}, {winnr}, '&')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4950
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4951 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4952 GetTabnr()->gettabwinvar(winnr, varname)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4953 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4954 Return type: any, depending on {varname}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4955
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4956
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4957 gettagstack([{winnr}]) gettagstack()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4958 The result is a Dict, which is the tag stack of window {winnr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4959 {winnr} can be the window number or the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4960 When {winnr} is not specified, the current window is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4961 When window {winnr} doesn't exist, an empty Dict is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4962
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4963 The returned dictionary contains the following entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4964 curidx Current index in the stack. When at
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4965 top of the stack, set to (length + 1).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4966 Index of bottom of the stack is 1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4967 items List of items in the stack. Each item
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4968 is a dictionary containing the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4969 entries described below.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4970 length Number of entries in the stack.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4971
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4972 Each item in the stack is a dictionary with the following
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4973 entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4974 bufnr buffer number of the current jump
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4975 from cursor position before the tag jump.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4976 See \|getpos()\| for the format of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4977 returned list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4978 matchnr current matching tag number. Used when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4979 multiple matching tags are found for a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4980 name.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4981 tagname name of the tag
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4982
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4983 See \|tagstack\| for more information about the tag stack.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4984
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4985 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4986 GetWinnr()->gettagstack()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4987 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	4988 Return type: dict<any>
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4989
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4990
35484 04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	4991 gettext({text} [, {package}]) gettext()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4992 Translate String {text} if possible.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4993 This is mainly for use in the distributed Vim scripts. When
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4994 generating message translations the {text} is extracted by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4995 xgettext, the translator can add the translated message in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4996 .po file and Vim will lookup the translation when gettext() is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4997 called.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4998 For {text} double quoted strings are preferred, because
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	4999 xgettext does not understand escaping in single quoted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5000 strings.
35484 04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	5001 When the {package} is specified, the translation is looked up
04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	5002 for that specific package. You need to specify the path to
04563887d70e patch 9.1.0509: not possible to translate Vim script messages Christian Brabandt <cb@256bit.org> parents: 35468 diff changeset	5003 look for translations with the \|bindtextdomain()\| function.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5004
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5005 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5006
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5007
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5008 getwininfo([{winid}]) getwininfo()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5009 Returns information about windows as a \|List\| with Dictionaries.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5010
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5011 If {winid} is given Information about the window with that ID
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5012 is returned, as a \|List\| with one item. If the window does not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5013 exist the result is an empty list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5014
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5015 Without {winid} information about all the windows in all the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5016 tab pages is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5017
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5018 Each List item is a \|Dictionary\| with the following entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5019 botline last complete displayed buffer line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5020 bufnr number of buffer in the window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5021 height window height (excluding winbar)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5022 loclist 1 if showing a location list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5023 {only with the +quickfix feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5024 quickfix 1 if quickfix or location list window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5025 {only with the +quickfix feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5026 terminal 1 if a terminal window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5027 {only with the +terminal feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5028 tabnr tab page number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5029 topline first displayed buffer line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5030 variables a reference to the dictionary with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5031 window-local variables
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5032 width window width
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5033 winbar 1 if the window has a toolbar, 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5034 otherwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5035 wincol leftmost screen column of the window;
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5036 "col" from \|win_screenpos()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5037 textoff number of columns occupied by any
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5038 'foldcolumn', 'signcolumn' and line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5039 number in front of the text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5040 winid \|window-ID\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5041 winnr window number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5042 winrow topmost screen line of the window;
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5043 "row" from \|win_screenpos()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5044
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5045 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5046 GetWinnr()->getwininfo()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5047 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5048 Return type: list<dict<any>>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5049
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5050
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5051 getwinpos([{timeout}]) getwinpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5052 The result is a \|List\| with two numbers, the result of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5053 \|getwinposx()\| and \|getwinposy()\| combined:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5054 [x-pos, y-pos]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5055 {timeout} can be used to specify how long to wait in msec for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5056 a response from the terminal. When omitted 100 msec is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5057 Use a longer time for a remote terminal.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5058 When using a value less than 10 and no response is received
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5059 within that time, a previously reported position is returned,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5060 if available. This can be used to poll for the position and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5061 do some work in the meantime: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5062 while 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5063 let res = getwinpos(1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5064 if res[0] >= 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5065 break
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5066 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5067 " Do some work here
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5068 endwhile
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5069 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5070
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5071 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5072 GetTimeout()->getwinpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5073 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5074 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5075
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5076
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5077 getwinposx() getwinposx()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5078 The result is a Number, which is the X coordinate in pixels of
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5079 the left hand side of the GUI Vim window. Also works for an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5080 xterm (uses a timeout of 100 msec).
34238 995b539939c4 patch 9.1.0064: No Wayland support Christian Brabandt <cb@256bit.org> parents: 34219 diff changeset	5081 The result will be -1 if the information is not available
995b539939c4 patch 9.1.0064: No Wayland support Christian Brabandt <cb@256bit.org> parents: 34219 diff changeset	5082 (e.g. on the Wayland backend).
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5083 The value can be used with `:winpos`.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5084
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5085 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5086
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5087
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5088 getwinposy() getwinposy()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5089 The result is a Number, which is the Y coordinate in pixels of
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5090 the top of the GUI Vim window. Also works for an xterm (uses
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5091 a timeout of 100 msec).
34238 995b539939c4 patch 9.1.0064: No Wayland support Christian Brabandt <cb@256bit.org> parents: 34219 diff changeset	5092 The result will be -1 if the information is not available
995b539939c4 patch 9.1.0064: No Wayland support Christian Brabandt <cb@256bit.org> parents: 34219 diff changeset	5093 (e.g. on the Wayland backend).
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5094 The value can be used with `:winpos`.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5095
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5096 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5097
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5098
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5099 getwinvar({winnr}, {varname} [, {def}]) getwinvar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5100 Like \|gettabwinvar()\| for the current tabpage.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5101 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5102 :let list_is_on = getwinvar(2, '&list')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5103 :echo "myvar = " .. getwinvar(1, 'myvar')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5104
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5105 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5106 GetWinnr()->getwinvar(varname)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5107 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5108 Return type: any, depending on {varname}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5109
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5110
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5111 glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) glob()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5112 Expand the file wildcards in {expr}. See \|wildcards\| for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5113 use of special characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5114
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5115 Unless the optional {nosuf} argument is given and is \|TRUE\|,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5116 the 'suffixes' and 'wildignore' options apply: Names matching
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5117 one of the patterns in 'wildignore' will be skipped and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5118 'suffixes' affect the ordering of matches.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5119 'wildignorecase' always applies.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5120
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5121 When {list} is present and it is \|TRUE\| the result is a \|List\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5122 with all matching files. The advantage of using a List is,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5123 you also get filenames containing newlines correctly.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5124 Otherwise the result is a String and when there are several
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5125 matches, they are separated by <NL> characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5126
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5127 If the expansion fails, the result is an empty String or List.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5128
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5129 You can also use \|readdir()\| if you need to do complicated
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5130 things, such as limiting the number of matches.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5131
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5132 A name for a non-existing file is not included. A symbolic
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5133 link is only included if it points to an existing file.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5134 However, when the {alllinks} argument is present and it is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5135 \|TRUE\| then all symbolic links are included.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5136
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5137 For most systems backticks can be used to get files names from
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5138 any external command. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5139 :let tagfiles = glob("`find . -name tags -print`")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5140 :let &tags = substitute(tagfiles, "\n", ",", "g")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5141 < The result of the program inside the backticks should be one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5142 item per line. Spaces inside an item are allowed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5143
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5144 See \|expand()\| for expanding special Vim variables. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5145 \|system()\| for getting the raw output of an external command.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5146
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5147 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5148 GetExpr()->glob()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5149 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5150 Return type: \|String\| or list<string> or list<any> depending
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5151 on {list}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5152
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5153
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5154 glob2regpat({string}) glob2regpat()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5155 Convert a file pattern, as used by glob(), into a search
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5156 pattern. The result can be used to match with a string that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5157 is a file name. E.g. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5158 if filename =~ glob2regpat('Make*.mak')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5159 < This is equivalent to: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5160 if filename =~ '^Make.*\.mak$'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5161 < When {string} is an empty string the result is "^$", match an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5162 empty string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5163 Note that the result depends on the system. On MS-Windows
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5164 a backslash usually means a path separator.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5165
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5166 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5167 GetExpr()->glob2regpat()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5168 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5169 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5170
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5171 globpath()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5172 globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5173 Perform glob() for String {expr} on all directories in {path}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5174 and concatenate the results. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5175 :echo globpath(&rtp, "syntax/c.vim")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5176 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5177 {path} is a comma-separated list of directory names. Each
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5178 directory name is prepended to {expr} and expanded like with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5179 \|glob()\|. A path separator is inserted when needed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5180 To add a comma inside a directory name escape it with a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5181 backslash. Note that on MS-Windows a directory may have a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5182 trailing backslash, remove it if you put a comma after it.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5183 If the expansion fails for one of the directories, there is no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5184 error message.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5185
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5186 Unless the optional {nosuf} argument is given and is \|TRUE\|,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5187 the 'suffixes' and 'wildignore' options apply: Names matching
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5188 one of the patterns in 'wildignore' will be skipped and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5189 'suffixes' affect the ordering of matches.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5190
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5191 When {list} is present and it is \|TRUE\| the result is a \|List\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5192 with all matching files. The advantage of using a List is, you
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5193 also get filenames containing newlines correctly. Otherwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5194 the result is a String and when there are several matches,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5195 they are separated by <NL> characters. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5196 :echo globpath(&rtp, "syntax/c.vim", 0, 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5197 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5198 {alllinks} is used as with \|glob()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5199
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5200 The "**" item can be used to search in a directory tree.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5201 For example, to find all "README.txt" files in the directories
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5202 in 'runtimepath' and below: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5203 :echo globpath(&rtp, "**/README.txt")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5204 < Upwards search and limiting the depth of "**" is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5205 supported, thus using 'path' will not always work properly.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5206
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5207 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5208 second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5209 GetExpr()->globpath(&rtp)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5210 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5211 Return type: \|String\| or list<string> or list<any> depending
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5212 on {list}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5213
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5214
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5215 has({feature} [, {check}]) has()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5216 When {check} is omitted or is zero: The result is a Number,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5217 which is 1 if the feature {feature} is supported, zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5218 otherwise. The {feature} argument is a string, case is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5219 ignored. See \|feature-list\| below.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5220
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5221 When {check} is present and not zero: The result is a Number,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5222 which is 1 if the feature {feature} could ever be supported,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5223 zero otherwise. This is useful to check for a typo in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5224 {feature} and to detect dead code. Keep in mind that an older
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5225 Vim version will not know about a feature added later and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5226 features that have been abandoned will not be known by the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5227 current Vim version.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5228
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5229 Also see \|exists()\| and \|exists_compiled()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5230
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5231 Note that to skip code that has a syntax error when the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5232 feature is not available, Vim may skip the rest of the line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5233 and miss a following `endif`. Therefore put the `endif` on a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5234 separate line: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5235 if has('feature')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5236 let x = this->breaks->without->the->feature
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5237 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5238 < If the `endif` would be moved to the second line as "\| endif" it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5239 would not be found.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5240
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5241 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5242
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5243
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5244 has_key({dict}, {key}) has_key()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5245 The result is a Number, which is TRUE if \|Dictionary\| {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5246 has an entry with key {key}. FALSE otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5247 The {key} argument is a string. In \|Vim9\| script a number is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5248 also accepted (and converted to a string) but no other types.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5249 In legacy script the usual automatic conversion to string is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5250 done.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5251
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5252 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5253 mydict->has_key(key)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5254 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5255 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5256
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5257
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5258 haslocaldir([{winnr} [, {tabnr}]]) haslocaldir()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5259 The result is a Number:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5260 1 when the window has set a local directory via \|:lcd\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5261 2 when the tab-page has set a local directory via \|:tcd\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5262 0 otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5263
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5264 Without arguments use the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5265 With {winnr} use this window in the current tab page.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5266 With {winnr} and {tabnr} use the window in the specified tab
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5267 page.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5268 {winnr} can be the window number or the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5269 If {winnr} is -1 it is ignored and only the tabpage is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5270 Return 0 if the arguments are invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5271 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5272 if haslocaldir() == 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5273 " window local directory case
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5274 elseif haslocaldir() == 2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5275 " tab-local directory case
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5276 else
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5277 " global directory case
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5278 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5279
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5280 " current window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5281 :echo haslocaldir()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5282 :echo haslocaldir(0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5283 :echo haslocaldir(0, 0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5284 " window n in current tab page
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5285 :echo haslocaldir(n)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5286 :echo haslocaldir(n, 0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5287 " window n in tab page m
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5288 :echo haslocaldir(n, m)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5289 " tab page m
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5290 :echo haslocaldir(-1, m)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5291 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5292 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5293 GetWinnr()->haslocaldir()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5294 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5295 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5296
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5297
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5298 hasmapto({what} [, {mode} [, {abbr}]]) hasmapto()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5299 The result is a Number, which is TRUE if there is a mapping
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5300 that contains {what} in somewhere in the rhs (what it is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5301 mapped to) and this mapping exists in one of the modes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5302 indicated by {mode}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5303 The arguments {what} and {mode} are strings.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5304 When {abbr} is there and it is \|TRUE\| use abbreviations
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5305 instead of mappings. Don't forget to specify Insert and/or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5306 Command-line mode.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5307 Both the global mappings and the mappings local to the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5308 buffer are checked for a match.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5309 If no matching mapping is found FALSE is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5310 The following characters are recognized in {mode}:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5311 n Normal mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5312 v Visual and Select mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5313 x Visual mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5314 s Select mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5315 o Operator-pending mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5316 i Insert mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5317 l Language-Argument ("r", "f", "t", etc.)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5318 c Command-line mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5319 When {mode} is omitted, "nvo" is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5320
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5321 This function is useful to check if a mapping already exists
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5322 to a function in a Vim script. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5323 :if !hasmapto('\ABCdoit')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5324 : map <Leader>d \ABCdoit
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5325 :endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5326 < This installs the mapping to "\ABCdoit" only if there isn't
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5327 already a mapping to "\ABCdoit".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5328
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5329 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5330 GetRHS()->hasmapto()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5331 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5332 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5333
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5334
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5335 histadd({history}, {item}) histadd()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5336 Add the String {item} to the history {history} which can be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5337 one of: hist-names
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5338 "cmd" or ":" command line history
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5339 "search" or "/" search pattern history
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5340 "expr" or "=" typed expression history
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5341 "input" or "@" input line history
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5342 "debug" or ">" debug command history
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5343 empty the current or last used history
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5344 The {history} string does not need to be the whole name, one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5345 character is sufficient.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5346 If {item} does already exist in the history, it will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5347 shifted to become the newest entry.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5348 The result is a Number: TRUE if the operation was successful,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5349 otherwise FALSE is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5350
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5351 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5352 :call histadd("input", strftime("%Y %b %d"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5353 :let date=input("Enter date: ")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5354 < This function is not available in the \|sandbox\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5355
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5356 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5357 second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5358 GetHistory()->histadd('search')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5359 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5360 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5361
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5362
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5363 histdel({history} [, {item}]) histdel()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5364 Clear {history}, i.e. delete all its entries. See \|hist-names\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5365 for the possible values of {history}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5366
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5367 If the parameter {item} evaluates to a String, it is used as a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5368 regular expression. All entries matching that expression will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5369 be removed from the history (if there are any).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5370 Upper/lowercase must match, unless "\c" is used \|/\c\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5371 If {item} evaluates to a Number, it will be interpreted as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5372 an index, see \|:history-indexing\|. The respective entry will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5373 be removed if it exists.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5374
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5375 The result is TRUE for a successful operation, otherwise FALSE
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5376 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5377
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5378 Examples:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5379 Clear expression register history: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5380 :call histdel("expr")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5381 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5382 Remove all entries starting with "*" from the search history: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5383 :call histdel("/", '^\*')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5384 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5385 The following three are equivalent: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5386 :call histdel("search", histnr("search"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5387 :call histdel("search", -1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5388 :call histdel("search", '^' .. histget("search", -1) .. '$')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5389 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5390 To delete the last search pattern and use the last-but-one for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5391 the "n" command and 'hlsearch': >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5392 :call histdel("search", -1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5393 :let @/ = histget("search", -1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5394 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5395 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5396 GetHistory()->histdel()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5397 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5398 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5399
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5400
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5401 histget({history} [, {index}]) histget()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5402 The result is a String, the entry with Number {index} from
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5403 {history}. See \|hist-names\| for the possible values of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5404 {history}, and \|:history-indexing\| for {index}. If there is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5405 no such entry, an empty String is returned. When {index} is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5406 omitted, the most recent item from the history is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5407
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5408 Examples:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5409 Redo the second last search from history. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5410 :execute '/' .. histget("search", -2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5411
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5412 < Define an Ex command ":H {num}" that supports re-execution of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5413 the {num}th entry from the output of \|:history\|. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5414 :command -nargs=1 H execute histget("cmd", 0+<args>)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5415 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5416 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5417 GetHistory()->histget()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5418 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5419 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5420
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5421
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5422 histnr({history}) histnr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5423 The result is the Number of the current entry in {history}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5424 See \|hist-names\| for the possible values of {history}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5425 If an error occurred, -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5426
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5427 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5428 :let inp_index = histnr("expr")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5429
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5430 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5431 GetHistory()->histnr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5432 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5433 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5434
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5435 hlexists({name}) hlexists()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5436 The result is a Number, which is TRUE if a highlight group
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5437 called {name} exists. This is when the group has been
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5438 defined in some way. Not necessarily when highlighting has
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5439 been defined for it, it may also have been used for a syntax
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5440 item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5441 highlight_exists()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5442 Obsolete name: highlight_exists().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5443
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5444 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5445 GetName()->hlexists()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5446 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5447 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5448
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5449
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5450 hlget([{name} [, {resolve}]]) hlget()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5451 Returns a List of all the highlight group attributes. If the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5452 optional {name} is specified, then returns a List with only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5453 the attributes of the specified highlight group. Returns an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5454 empty List if the highlight group {name} is not present.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5455
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5456 If the optional {resolve} argument is set to v:true and the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5457 highlight group {name} is linked to another group, then the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5458 link is resolved recursively and the attributes of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5459 resolved highlight group are returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5460
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5461 Each entry in the returned List is a Dictionary with the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5462 following items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5463 cleared boolean flag, set to v:true if the highlight
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5464 group attributes are cleared or not yet
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5465 specified. See \|highlight-clear\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5466 cterm cterm attributes. See \|highlight-cterm\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5467 ctermbg cterm background color.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5468 See \|highlight-ctermbg\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5469 ctermfg cterm foreground color.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5470 See \|highlight-ctermfg\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5471 ctermul cterm underline color. See \|highlight-ctermul\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5472 default boolean flag, set to v:true if the highlight
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5473 group link is a default link. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5474 \|highlight-default\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5475 font highlight group font. See \|highlight-font\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5476 gui gui attributes. See \|highlight-gui\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5477 guibg gui background color. See \|highlight-guibg\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5478 guifg gui foreground color. See \|highlight-guifg\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5479 guisp gui special color. See \|highlight-guisp\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5480 id highlight group ID.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5481 linksto linked highlight group name.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5482 See \|:highlight-link\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5483 name highlight group name. See \|group-name\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5484 start start terminal keycode. See \|highlight-start\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5485 stop stop terminal keycode. See \|highlight-stop\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5486 term term attributes. See \|highlight-term\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5487
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5488 The 'term', 'cterm' and 'gui' items in the above Dictionary
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5489 have a dictionary value with the following optional boolean
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5490 items: 'bold', 'standout', 'underline', 'undercurl', 'italic',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5491 'reverse', 'inverse' and 'strikethrough'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5492
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5493 Example(s): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5494 :echo hlget()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5495 :echo hlget('ModeMsg')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5496 :echo hlget('Number', v:true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5497 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5498 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5499 GetName()->hlget()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5500 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5501 Return type: list<dict<any>>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5502
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5503
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5504 hlset({list}) hlset()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5505 Creates or modifies the attributes of a List of highlight
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5506 groups. Each item in {list} is a dictionary containing the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5507 attributes of a highlight group. See \|hlget()\| for the list of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5508 supported items in this dictionary.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5509
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5510 In addition to the items described in \|hlget()\|, the following
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5511 additional items are supported in the dictionary:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5512
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5513 force boolean flag to force the creation of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5514 a link for an existing highlight group
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5515 with attributes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5516
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5517 The highlight group is identified using the 'name' item and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5518 the 'id' item (if supplied) is ignored. If a highlight group
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5519 with a specified name doesn't exist, then it is created.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5520 Otherwise the attributes of an existing highlight group are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5521 modified.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5522
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5523 If an empty dictionary value is used for the 'term' or 'cterm'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5524 or 'gui' entries, then the corresponding attributes are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5525 cleared. If the 'cleared' item is set to v:true, then all the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5526 attributes of the highlight group are cleared.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5527
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5528 The 'linksto' item can be used to link a highlight group to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5529 another highlight group. See \|:highlight-link\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5530
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5531 Returns zero for success, -1 for failure.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5532
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5533 Example(s): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5534 " add bold attribute to the Visual highlight group
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5535 :call hlset([#{name: 'Visual',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5536 \ term: #{reverse: 1 , bold: 1}}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5537 :call hlset([#{name: 'Type', guifg: 'DarkGreen'}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5538 :let l = hlget()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5539 :call hlset(l)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5540 " clear the Search highlight group
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5541 :call hlset([#{name: 'Search', cleared: v:true}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5542 " clear the 'term' attributes for a highlight group
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5543 :call hlset([#{name: 'Title', term: {}}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5544 " create the MyHlg group linking it to DiffAdd
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5545 :call hlset([#{name: 'MyHlg', linksto: 'DiffAdd'}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5546 " remove the MyHlg group link
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5547 :call hlset([#{name: 'MyHlg', linksto: 'NONE'}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5548 " clear the attributes and a link
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5549 :call hlset([#{name: 'MyHlg', cleared: v:true,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5550 \ linksto: 'NONE'}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5551 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5552 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5553 GetAttrList()->hlset()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5554 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5555 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5556
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5557 hlID({name}) hlID()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5558 The result is a Number, which is the ID of the highlight group
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5559 with name {name}. When the highlight group doesn't exist,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5560 zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5561 This can be used to retrieve information about the highlight
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5562 group. For example, to get the background color of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5563 "Comment" group: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5564 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5565 < highlightID()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5566 Obsolete name: highlightID().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5567
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5568 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5569 GetName()->hlID()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5570 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5571 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5572
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5573
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5574 hostname() hostname()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5575 The result is a String, which is the name of the machine on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5576 which Vim is currently running. Machine names greater than
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5577 256 characters long are truncated.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5578
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5579 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5580
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5581
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5582 iconv({string}, {from}, {to}) iconv()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5583 The result is a String, which is the text {string} converted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5584 from encoding {from} to encoding {to}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5585 When the conversion completely fails an empty string is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5586 returned. When some characters could not be converted they
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5587 are replaced with "?".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5588 The encoding names are whatever the iconv() library function
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5589 can accept, see ":!man 3 iconv".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5590 Most conversions require Vim to be compiled with the \|+iconv\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5591 feature. Otherwise only UTF-8 to latin1 conversion and back
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5592 can be done.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5593 This can be used to display messages with special characters,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5594 no matter what 'encoding' is set to. Write the message in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5595 UTF-8 and use: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5596 echo iconv(utf8_str, "utf-8", &enc)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5597 < Note that Vim uses UTF-8 for all Unicode encodings, conversion
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5598 from/to UCS-2 is automatically changed to use UTF-8. You
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5599 cannot use UCS-2 in a string anyway, because of the NUL bytes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5600
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5601 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5602 GetText()->iconv('latin1', 'utf-8')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5603 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5604 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5605
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5606
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5607 indent({lnum}) indent()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5608 The result is a Number, which is indent of line {lnum} in the
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5609 current buffer. The indent is counted in spaces, the value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5610 of 'tabstop' is relevant. {lnum} is used just like in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5611 \|getline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5612 When {lnum} is invalid -1 is returned. In \|Vim9\| script an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5613 error is given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5614
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5615 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5616 GetLnum()->indent()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5617 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5618 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5619
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5620
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5621 index({object}, {expr} [, {start} [, {ic}]]) index()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5622 Find {expr} in {object} and return its index. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5623 \|indexof()\| for using a lambda to select the item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5624
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5625 If {object} is a \|List\| return the lowest index where the item
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5626 has a value equal to {expr}. There is no automatic
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5627 conversion, so the String "4" is different from the Number 4.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5628 And the number 4 is different from the Float 4.0. The value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5629 of 'ignorecase' is not used here, case matters as indicated by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5630 the {ic} argument.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5631
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5632 If {object} is \|Blob\| return the lowest index where the byte
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5633 value is equal to {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5634
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5635 If {start} is given then start looking at the item with index
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5636 {start} (may be negative for an item relative to the end).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5637
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5638 When {ic} is given and it is \|TRUE\|, ignore case. Otherwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5639 case must match.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5640
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5641 -1 is returned when {expr} is not found in {object}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5642 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5643 :let idx = index(words, "the")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5644 :if index(numbers, 123) >= 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5645
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5646 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5647 GetObject()->index(what)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5648 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5649 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5650
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5651
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5652 indexof({object}, {expr} [, {opts}]) indexof()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5653 Returns the index of an item in {object} where {expr} is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5654 v:true. {object} must be a \|List\| or a \|Blob\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5655
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5656 If {object} is a \|List\|, evaluate {expr} for each item in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5657 List until the expression is v:true and return the index of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5658 this item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5659
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5660 If {object} is a \|Blob\| evaluate {expr} for each byte in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5661 Blob until the expression is v:true and return the index of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5662 this byte.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5663
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5664 {expr} must be a \|string\| or \|Funcref\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5665
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5666 If {expr} is a \|string\|: If {object} is a \|List\|, inside
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5667 {expr} \|v:key\| has the index of the current List item and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5668 \|v:val\| has the value of the item. If {object} is a \|Blob\|,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5669 inside {expr} \|v:key\| has the index of the current byte and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5670 \|v:val\| has the byte value.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5671
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5672 If {expr} is a \|Funcref\| it must take two arguments:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5673 1. the key or the index of the current item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5674 2. the value of the current item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5675 The function must return \|TRUE\| if the item is found and the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5676 search should stop.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5677
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5678 The optional argument {opts} is a Dict and supports the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5679 following items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5680 startidx start evaluating {expr} at the item with this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5681 index; may be negative for an item relative to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5682 the end
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5683 Returns -1 when {expr} evaluates to v:false for all the items.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5684 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5685 :let l = [#{n: 10}, #{n: 20}, #{n: 30}]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5686 :echo indexof(l, "v:val.n == 20")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5687 :echo indexof(l, {i, v -> v.n == 30})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5688 :echo indexof(l, "v:val.n == 20", #{startidx: 1})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5689
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5690 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5691 mylist->indexof(expr)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5692 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5693 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5694
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5695
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5696 input({prompt} [, {text} [, {completion}]]) input()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5697 The result is a String, which is whatever the user typed on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5698 the command-line. The {prompt} argument is either a prompt
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5699 string, or a blank string (for no prompt). A '\n' can be used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5700 in the prompt to start a new line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5701 The highlighting set with \|:echohl\| is used for the prompt.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5702 The input is entered just like a command-line, with the same
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5703 editing commands and mappings. There is a separate history
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5704 for lines typed for input().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5705 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5706 :if input("Coffee or beer? ") == "beer"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5707 : echo "Cheers!"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5708 :endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5709 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5710 If the optional {text} argument is present and not empty, this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5711 is used for the default reply, as if the user typed this.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5712 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5713 :let color = input("Color? ", "white")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5714
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5715 < The optional {completion} argument specifies the type of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5716 completion supported for the input. Without it completion is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5717 not performed. The supported completion types are the same as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5718 that can be supplied to a user-defined command using the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5719 "-complete=" argument. Refer to \|:command-completion\| for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5720 more information. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5721 let fname = input("File: ", "", "file")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5722 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5723 NOTE: This function must not be used in a startup file, for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5724 the versions that only run in GUI mode (e.g., the Win32 GUI).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5725 Note: When input() is called from within a mapping it will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5726 consume remaining characters from that mapping, because a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5727 mapping is handled like the characters were typed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5728 Use \|inputsave()\| before input() and \|inputrestore()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5729 after input() to avoid that. Another solution is to avoid
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5730 that further characters follow in the mapping, e.g., by using
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5731 \|:execute\| or \|:normal\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5732
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5733 Example with a mapping: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5734 :nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5735 :function GetFoo()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5736 : call inputsave()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5737 : let g:Foo = input("enter search pattern: ")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5738 : call inputrestore()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5739 :endfunction
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5740
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5741 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5742 GetPrompt()->input()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5743 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5744 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5745
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5746
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5747 inputdialog({prompt} [, {text} [, {cancelreturn}]]) inputdialog()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5748 Like \|input()\|, but when the GUI is running and text dialogs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5749 are supported, a dialog window pops up to input the text.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5750 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5751 :let n = inputdialog("value for shiftwidth", shiftwidth())
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5752 :if n != ""
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5753 : let &sw = n
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5754 :endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5755 < When the dialog is cancelled {cancelreturn} is returned. When
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5756 omitted an empty string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5757 Hitting <Enter> works like pressing the OK button. Hitting
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5758 <Esc> works like pressing the Cancel button.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5759 NOTE: Command-line completion is not supported.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5760
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5761 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5762 GetPrompt()->inputdialog()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5763 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5764 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5765
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5766
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5767 inputlist({textlist}) inputlist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5768 {textlist} must be a \|List\| of strings. This \|List\| is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5769 displayed, one string per line. The user will be prompted to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5770 enter a number, which is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5771 The user can also select an item by clicking on it with the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5772 mouse, if the mouse is enabled in the command line ('mouse' is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5773 "a" or includes "c"). For the first string 0 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5774 When clicking above the first item a negative number is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5775 returned. When clicking on the prompt one more than the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5776 length of {textlist} is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5777 Make sure {textlist} has less than 'lines' entries, otherwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5778 it won't work. It's a good idea to put the entry number at
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5779 the start of the string. And put a prompt in the first item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5780 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5781 let color = inputlist(['Select color:', '1. red',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5782 \ '2. green', '3. blue'])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5783
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5784 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5785 GetChoices()->inputlist()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5786 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5787 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5788
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5789
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5790 inputrestore() inputrestore()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5791 Restore typeahead that was saved with a previous \|inputsave()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5792 Should be called the same number of times inputsave() is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5793 called. Calling it more often is harmless though.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5794 Returns TRUE when there is nothing to restore, FALSE otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5795
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5796 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5797
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5798
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5799 inputsave() inputsave()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5800 Preserve typeahead (also from mappings) and clear it, so that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5801 a following prompt gets input from the user. Should be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5802 followed by a matching inputrestore() after the prompt. Can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5803 be used several times, in which case there must be just as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5804 many inputrestore() calls.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5805 Returns TRUE when out of memory, FALSE otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5806
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5807 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5808
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5809
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5810 inputsecret({prompt} [, {text}]) inputsecret()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5811 This function acts much like the \|input()\| function with but
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5812 two exceptions:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5813 a) the user's response will be displayed as a sequence of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5814 asterisks ("*") thereby keeping the entry secret, and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5815 b) the user's response will not be recorded on the input
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5816 \|history\| stack.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5817 The result is a String, which is whatever the user actually
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5818 typed on the command-line in response to the issued prompt.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5819 NOTE: Command-line completion is not supported.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5820
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5821 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5822 GetPrompt()->inputsecret()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5823 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5824 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5825
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5826
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5827 insert({object}, {item} [, {idx}]) insert()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5828 When {object} is a \|List\| or a \|Blob\| insert {item} at the start
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5829 of it.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5830
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5831 If {idx} is specified insert {item} before the item with index
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5832 {idx}. If {idx} is zero it goes before the first item, just
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5833 like omitting {idx}. A negative {idx} is also possible, see
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5834 \|list-index\|. -1 inserts just before the last item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5835
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5836 Returns the resulting \|List\| or \|Blob\|. Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5837 :let mylist = insert([2, 3, 5], 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5838 :call insert(mylist, 4, -1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5839 :call insert(mylist, 6, len(mylist))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5840 < The last example can be done simpler with \|add()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5841 Note that when {item} is a \|List\| it is inserted as a single
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5842 item. Use \|extend()\| to concatenate \|Lists\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5843
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5844 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5845 mylist->insert(item)
33436 3f96c75df76d runtime(doc): add missing error numbers in the help. (#13241) Christian Brabandt <cb@256bit.org> parents: 33408 diff changeset	5846 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5847 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5848
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5849
33436 3f96c75df76d runtime(doc): add missing error numbers in the help. (#13241) Christian Brabandt <cb@256bit.org> parents: 33408 diff changeset	5850 instanceof() E614 E616 E693
3f96c75df76d runtime(doc): add missing error numbers in the help. (#13241) Christian Brabandt <cb@256bit.org> parents: 33408 diff changeset	5851 instanceof({object}, {class})
3f96c75df76d runtime(doc): add missing error numbers in the help. (#13241) Christian Brabandt <cb@256bit.org> parents: 33408 diff changeset	5852 The result is a Number, which is \|TRUE\| when the {object}
33924 ccdb948c7273 patch 9.0.2160: instanceof() should use varargs as second arg Christian Brabandt <cb@256bit.org> parents: 33848 diff changeset	5853 argument is a direct or indirect instance of a \|Class\|,
ccdb948c7273 patch 9.0.2160: instanceof() should use varargs as second arg Christian Brabandt <cb@256bit.org> parents: 33848 diff changeset	5854 \|Interface\|, or class \|:type\| alias specified by {class}.
ccdb948c7273 patch 9.0.2160: instanceof() should use varargs as second arg Christian Brabandt <cb@256bit.org> parents: 33848 diff changeset	5855 If {class} is varargs, the function returns \|TRUE\| when
33436 3f96c75df76d runtime(doc): add missing error numbers in the help. (#13241) Christian Brabandt <cb@256bit.org> parents: 33408 diff changeset	5856 {object} is an instance of any of the specified classes.
32972 e4851934751a patch 9.0.1786: Vim9: need instanceof() function Christian Brabandt <cb@256bit.org> parents: 32947 diff changeset	5857 Example: >
33924 ccdb948c7273 patch 9.0.2160: instanceof() should use varargs as second arg Christian Brabandt <cb@256bit.org> parents: 33848 diff changeset	5858 instanceof(animal, Dog, Cat)
32972 e4851934751a patch 9.0.1786: Vim9: need instanceof() function Christian Brabandt <cb@256bit.org> parents: 32947 diff changeset	5859
e4851934751a patch 9.0.1786: Vim9: need instanceof() function Christian Brabandt <cb@256bit.org> parents: 32947 diff changeset	5860 < Can also be used as a \|method\|: >
e4851934751a patch 9.0.1786: Vim9: need instanceof() function Christian Brabandt <cb@256bit.org> parents: 32947 diff changeset	5861 myobj->instanceof(mytype)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5862 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5863 Return type: \|Number\|
32972 e4851934751a patch 9.0.1786: Vim9: need instanceof() function Christian Brabandt <cb@256bit.org> parents: 32947 diff changeset	5864
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5865 interrupt() interrupt()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5866 Interrupt script execution. It works more or less like the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5867 user typing CTRL-C, most commands won't execute and control
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5868 returns to the user. This is useful to abort execution
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5869 from lower down, e.g. in an autocommand. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5870 :function s:check_typoname(file)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5871 : if fnamemodify(a:file, ':t') == '['
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5872 : echomsg 'Maybe typo'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5873 : call interrupt()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5874 : endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5875 :endfunction
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5876 :au BufWritePre * call s:check_typoname(expand('<amatch>'))
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5877 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5878 Return type: void
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5879
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5880 invert({expr}) invert()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5881 Bitwise invert. The argument is converted to a number. A
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5882 List, Dict or Float argument causes an error. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5883 :let bits = invert(bits)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5884 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5885 :let bits = bits->invert()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5886 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5887 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5888
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5889
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5890 isabsolutepath({path}) isabsolutepath()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5891 The result is a Number, which is \|TRUE\| when {path} is an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5892 absolute path.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5893 On Unix, a path is considered absolute when it starts with '/'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5894 On MS-Windows, it is considered absolute when it starts with an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5895 optional drive prefix and is followed by a '\' or '/'. UNC paths
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5896 are always absolute.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5897 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5898 echo isabsolutepath('/usr/share/') " 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5899 echo isabsolutepath('./foobar') " 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5900 echo isabsolutepath('C:\Windows') " 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5901 echo isabsolutepath('foobar') " 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5902 echo isabsolutepath('\\remote\file') " 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5903 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5904 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5905 GetName()->isabsolutepath()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5906 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5907 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5908
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5909
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5910 isdirectory({directory}) isdirectory()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5911 The result is a Number, which is \|TRUE\| when a directory
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5912 with the name {directory} exists. If {directory} doesn't
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5913 exist, or isn't a directory, the result is \|FALSE\|. {directory}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5914 is any expression, which is used as a String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5915
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5916 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5917 GetName()->isdirectory()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5918 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5919 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5920
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5921
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5922 isinf({expr}) isinf()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5923 Return 1 if {expr} is a positive infinity, or -1 a negative
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5924 infinity, otherwise 0. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5925 :echo isinf(1.0 / 0.0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5926 < 1 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5927 :echo isinf(-1.0 / 0.0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5928 < -1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5929
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5930 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5931 Compute()->isinf()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5932 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5933 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5934
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5935
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5936 islocked({expr}) islocked() E786
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5937 The result is a Number, which is \|TRUE\| when {expr} is the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5938 name of a locked variable.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5939 The string argument {expr} must be the name of a variable,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5940 \|List\| item or \|Dictionary\| entry, not the variable itself!
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5941 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5942 :let alist = [0, ['a', 'b'], 2, 3]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5943 :lockvar 1 alist
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5944 :echo islocked('alist') " 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5945 :echo islocked('alist[1]') " 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5946
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5947 < When {expr} is a variable that does not exist -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5948 If {expr} uses a range, list or dict index that is out of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5949 range or does not exist you get an error message. Use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5950 \|exists()\| to check for existence.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5951 In Vim9 script it does not work for local function variables.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5952
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5953 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5954 GetName()->islocked()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5955 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5956 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5957
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5958
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5959 isnan({expr}) isnan()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5960 Return \|TRUE\| if {expr} is a float with value NaN. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5961 echo isnan(0.0 / 0.0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5962 < 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5963
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5964 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5965 Compute()->isnan()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5966 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5967 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5968
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5969
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5970 items({dict}) items()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5971 Return a \|List\| with all the key-value pairs of {dict}. Each
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5972 \|List\| item is a list with two items: the key of a {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5973 entry and the value of this entry. The \|List\| is in arbitrary
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5974 order. Also see \|keys()\| and \|values()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5975 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5976 for [key, value] in items(mydict)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5977 echo key .. ': ' .. value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5978 endfor
34011 62d771d915fe runtime(doc): list of new/changed features in version9.txt Christian Brabandt <cb@256bit.org> parents: 33945 diff changeset	5979 <
62d771d915fe runtime(doc): list of new/changed features in version9.txt Christian Brabandt <cb@256bit.org> parents: 33945 diff changeset	5980 A List or a String argument is also supported. In these
62d771d915fe runtime(doc): list of new/changed features in version9.txt Christian Brabandt <cb@256bit.org> parents: 33945 diff changeset	5981 cases, items() returns a List with the index and the value at
62d771d915fe runtime(doc): list of new/changed features in version9.txt Christian Brabandt <cb@256bit.org> parents: 33945 diff changeset	5982 the index.
62d771d915fe runtime(doc): list of new/changed features in version9.txt Christian Brabandt <cb@256bit.org> parents: 33945 diff changeset	5983
62d771d915fe runtime(doc): list of new/changed features in version9.txt Christian Brabandt <cb@256bit.org> parents: 33945 diff changeset	5984 Can also be used as a \|method\|: >
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5985 mydict->items()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5986 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5987 Return type: list<list<any>> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	5988
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5989
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5990 job_ functions are documented here: \|job-functions-details\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5991
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5992
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5993 join({list} [, {sep}]) join()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5994 Join the items in {list} together into one String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5995 When {sep} is specified it is put in between the items. If
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5996 {sep} is omitted a single space is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5997 Note that {sep} is not added at the end. You might want to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5998 add it there too: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	5999 let lines = join(mylist, "\n") .. "\n"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6000 < String items are used as-is. \|Lists\| and \|Dictionaries\| are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6001 converted into a string like with \|string()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6002 The opposite function is \|split()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6003
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6004 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6005 mylist->join()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6006 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6007 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6008
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6009
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6010 js_decode({string}) js_decode()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6011 This is similar to \|json_decode()\| with these differences:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6012 - Object key names do not have to be in quotes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6013 - Strings can be in single quotes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6014 - Empty items in an array (between two commas) are allowed and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6015 result in v:none items.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6016
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6017 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6018 ReadObject()->js_decode()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6019 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6020 Return type: any, depending on {varname}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6021
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6022
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6023 js_encode({expr}) js_encode()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6024 This is similar to \|json_encode()\| with these differences:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6025 - Object key names are not in quotes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6026 - v:none items in an array result in an empty item between
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6027 commas.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6028 For example, the Vim object:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6029 [1,v:none,{"one":1},v:none] ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6030 Will be encoded as:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6031 [1,,{one:1},,] ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6032 While json_encode() would produce:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6033 [1,null,{"one":1},null] ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6034 This encoding is valid for JavaScript. It is more efficient
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6035 than JSON, especially when using an array with optional items.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6036
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6037 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6038 GetObject()->js_encode()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6039 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6040 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6041
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6042
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6043 json_decode({string}) json_decode() E491
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6044 This parses a JSON formatted string and returns the equivalent
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6045 in Vim values. See \|json_encode()\| for the relation between
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6046 JSON and Vim values.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6047 The decoding is permissive:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6048 - A trailing comma in an array and object is ignored, e.g.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6049 "[1, 2, ]" is the same as "[1, 2]".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6050 - Integer keys are accepted in objects, e.g. {1:2} is the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6051 same as {"1":2}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6052 - More floating point numbers are recognized, e.g. "1." for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6053 "1.0", or "001.2" for "1.2". Special floating point values
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6054 "Infinity", "-Infinity" and "NaN" (capitalization ignored)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6055 are accepted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6056 - Leading zeroes in integer numbers are ignored, e.g. "012"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6057 for "12" or "-012" for "-12".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6058 - Capitalization is ignored in literal names null, true or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6059 false, e.g. "NULL" for "null", "True" for "true".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6060 - Control characters U+0000 through U+001F which are not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6061 escaped in strings are accepted, e.g. " " (tab
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6062 character in string) for "\t".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6063 - An empty JSON expression or made of only spaces is accepted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6064 and results in v:none.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6065 - Backslash in an invalid 2-character sequence escape is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6066 ignored, e.g. "\a" is decoded as "a".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6067 - A correct surrogate pair in JSON strings should normally be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6068 a 12 character sequence such as "\uD834\uDD1E", but
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6069 json_decode() silently accepts truncated surrogate pairs
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6070 such as "\uD834" or "\uD834\u"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6071 E938
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6072 A duplicate key in an object, valid in rfc7159, is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6073 accepted by json_decode() as the result must be a valid Vim
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6074 type, e.g. this fails: {"a":"b", "a":"c"}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6075
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6076 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6077 ReadObject()->json_decode()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6078 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6079 Return type: any, depending on {varname}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6080
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6081
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6082 json_encode({expr}) json_encode()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6083 Encode {expr} as JSON and return this as a string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6084 The encoding is specified in:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6085 https://tools.ietf.org/html/rfc7159.html
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6086 Vim values are converted as follows: E1161
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6087 \|Number\| decimal number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6088 \|Float\| floating point number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6089 Float nan "NaN"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6090 Float inf "Infinity"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6091 Float -inf "-Infinity"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6092 \|String\| in double quotes (possibly null)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6093 \|Funcref\| not possible, error
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6094 \|List\| as an array (possibly null); when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6095 used recursively: []
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6096 \|Dict\| as an object (possibly null); when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6097 used recursively: {}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6098 \|Blob\| as an array of the individual bytes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6099 v:false "false"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6100 v:true "true"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6101 v:none "null"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6102 v:null "null"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6103 Note that NaN and Infinity are passed on as values. This is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6104 missing in the JSON standard, but several implementations do
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6105 allow it. If not then you will get an error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6106 If a string contains an illegal character then the replacement
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6107 character 0xfffd is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6108
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6109 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6110 GetObject()->json_encode()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6111 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6112 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6113
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6114
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6115 keys({dict}) keys()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6116 Return a \|List\| with all the keys of {dict}. The \|List\| is in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6117 arbitrary order. Also see \|items()\| and \|values()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6118
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6119 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6120 mydict->keys()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6121 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6122 Return type: list<string>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6123
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6124
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6125 keytrans({string}) keytrans()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6126 Turn the internal byte representation of keys into a form that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6127 can be used for \|:map\|. E.g. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6128 :let xx = "\<C-Home>"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6129 :echo keytrans(xx)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6130 < <C-Home>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6131
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6132 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6133 "\<C-Home>"->keytrans()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6134 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6135 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6136
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6137
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6138 len({expr}) len() E701
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6139 The result is a Number, which is the length of the argument.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6140 When {expr} is a String or a Number the length in bytes is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6141 used, as with \|strlen()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6142 When {expr} is a \|List\| the number of items in the \|List\| is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6143 returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6144 When {expr} is a \|Blob\| the number of bytes is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6145 When {expr} is a \|Dictionary\| the number of entries in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6146 \|Dictionary\| is returned.
34694 009989ec3ff6 runtime(doc): Improve docs for empty(), len(), and string() on objects Christian Brabandt <cb@256bit.org> parents: 34676 diff changeset	6147 When {expr} is an \|Object\|, invokes the len() method in the
009989ec3ff6 runtime(doc): Improve docs for empty(), len(), and string() on objects Christian Brabandt <cb@256bit.org> parents: 34676 diff changeset	6148 object (if present) to get the length (\|object-len()\|).
009989ec3ff6 runtime(doc): Improve docs for empty(), len(), and string() on objects Christian Brabandt <cb@256bit.org> parents: 34676 diff changeset	6149 Otherwise returns zero.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6150
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6151 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6152 mylist->len()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6153 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6154 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6155
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6156
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6157 libcall() E364 E368
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6158 libcall({libname}, {funcname}, {argument})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6159 Call function {funcname} in the run-time library {libname}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6160 with single argument {argument}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6161 This is useful to call functions in a library that you
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6162 especially made to be used with Vim. Since only one argument
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6163 is possible, calling standard library functions is rather
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6164 limited.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6165 The result is the String returned by the function. If the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6166 function returns NULL, this will appear as an empty string ""
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6167 to Vim.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6168 If the function returns a number, use libcallnr()!
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6169 If {argument} is a number, it is passed to the function as an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6170 int; if {argument} is a string, it is passed as a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6171 null-terminated string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6172 This function will fail in \|restricted-mode\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6173
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6174 libcall() allows you to write your own 'plug-in' extensions to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6175 Vim without having to recompile the program. It is NOT a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6176 means to call system functions! If you try to do so Vim will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6177 very probably crash.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6178
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6179 For Win32, the functions you write must be placed in a DLL
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6180 and use the normal C calling convention (NOT Pascal which is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6181 used in Windows System DLLs). The function must take exactly
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6182 one parameter, either a character pointer or a long integer,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6183 and must return a character pointer or NULL. The character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6184 pointer returned must point to memory that will remain valid
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6185 after the function has returned (e.g. in static data in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6186 DLL). If it points to allocated memory, that memory will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6187 leak away. Using a static buffer in the function should work,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6188 it's then freed when the DLL is unloaded.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6189
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6190 WARNING: If the function returns a non-valid pointer, Vim may
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6191 crash! This also happens if the function returns a number,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6192 because Vim thinks it's a pointer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6193 For Win32 systems, {libname} should be the filename of the DLL
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6194 without the ".DLL" suffix. A full path is only required if
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6195 the DLL is not in the usual places.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6196 For Unix: When compiling your own plugins, remember that the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6197 object code must be compiled as position-independent ('PIC').
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6198 {only in Win32 and some Unix versions, when the \|+libcall\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6199 feature is present}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6200 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6201 :echo libcall("libc.so", "getenv", "HOME")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6202
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6203 < Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6204 third argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6205 GetValue()->libcall("libc.so", "getenv")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6206 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6207 libcallnr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6208 libcallnr({libname}, {funcname}, {argument})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6209 Just like \|libcall()\|, but used for a function that returns an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6210 int instead of a string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6211 {only in Win32 on some Unix versions, when the \|+libcall\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6212 feature is present}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6213 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6214 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6215 :call libcallnr("libc.so", "printf", "Hello World!\n")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6216 :call libcallnr("libc.so", "sleep", 10)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6217 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6218 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6219 third argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6220 GetValue()->libcallnr("libc.so", "printf")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6221 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6222 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6223
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6224
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6225 line({expr} [, {winid}]) line()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6226 The result is a Number, which is the line number of the file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6227 position given with {expr}. The {expr} argument is a string.
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	6228 See \|getpos()\| for accepted positions.
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	6229
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6230 To get the column number use \|col()\|. To get both use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6231 \|getpos()\|.
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	6232
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6233 With the optional {winid} argument the values are obtained for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6234 that window instead of the current window.
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	6235
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6236 Returns 0 for invalid values of {expr} and {winid}.
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	6237
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6238 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6239 line(".") line number of the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6240 line(".", winid) idem, in window "winid"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6241 line("'t") line number of mark t
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6242 line("'" .. marker) line number of mark marker
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6243 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6244 To jump to the last known position when opening a file see
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6245 \|last-position-jump\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6246
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6247 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6248 GetValue()->line()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6249 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6250 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6251
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6252
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6253 line2byte({lnum}) line2byte()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6254 Return the byte count from the start of the buffer for line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6255 {lnum}. This includes the end-of-line character, depending on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6256 the 'fileformat' option for the current buffer. The first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6257 line returns 1. 'encoding' matters, 'fileencoding' is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6258 This can also be used to get the byte count for the line just
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6259 below the last line: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6260 line2byte(line("$") + 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6261 < This is the buffer size plus one. If 'fileencoding' is empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6262 it is the file size plus one. {lnum} is used like with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6263 \|getline()\|. When {lnum} is invalid, or the \|+byte_offset\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6264 feature has been disabled at compile time, -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6265 Also see \|byte2line()\|, \|go\| and \|:goto\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6266
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6267 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6268 GetLnum()->line2byte()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6269 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6270 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6271
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6272
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6273 lispindent({lnum}) lispindent()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6274 Get the amount of indent for line {lnum} according the lisp
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6275 indenting rules, as with 'lisp'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6276 The indent is counted in spaces, the value of 'tabstop' is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6277 relevant. {lnum} is used just like in \|getline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6278 When {lnum} is invalid -1 is returned. In \|Vim9\| script an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6279 error is given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6280
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6281 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6282 GetLnum()->lispindent()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6283 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6284 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6285
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6286
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6287 list2blob({list}) list2blob()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6288 Return a Blob concatenating all the number values in {list}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6289 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6290 list2blob([1, 2, 3, 4]) returns 0z01020304
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6291 list2blob([]) returns 0z
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6292 < Returns an empty Blob on error. If one of the numbers is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6293 negative or more than 255 error E1239 is given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6294
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6295 \|blob2list()\| does the opposite.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6296
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6297 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6298 GetList()->list2blob()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6299 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6300 Return type: \|Blob\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6301
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6302
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6303 list2str({list} [, {utf8}]) list2str()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6304 Convert each number in {list} to a character string and
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6305 concatenates them all. Examples: >
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6306 list2str([32]) returns " "
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6307 list2str([65, 66, 67]) returns "ABC"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6308 < The same can be done (slowly) with: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6309 join(map(list, {nr, val -> nr2char(val)}), '')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6310 < \|str2list()\| does the opposite.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6311
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6312 When {utf8} is omitted or zero, the current 'encoding' is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6313 When {utf8} is TRUE, always return UTF-8 characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6314 With UTF-8 composing characters work as expected: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6315 list2str([97, 769]) returns "á"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6316 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6317 Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6318
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6319 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6320 GetList()->list2str()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6321 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6322 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6323
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6324
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6325 listener_add({callback} [, {buf}]) listener_add()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6326 Add a callback function that will be invoked when changes have
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6327 been made to buffer {buf}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6328 {buf} refers to a buffer name or number. For the accepted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6329 values, see \|bufname()\|. When {buf} is omitted the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6330 buffer is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6331 Returns a unique ID that can be passed to \|listener_remove()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6332
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6333 The {callback} is invoked with five arguments:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6334 bufnr the buffer that was changed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6335 start first changed line number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6336 end first line number below the change
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6337 added number of lines added, negative if lines were
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6338 deleted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6339 changes a List of items with details about the changes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6340
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6341 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6342 func Listener(bufnr, start, end, added, changes)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6343 echo 'lines ' .. a:start .. ' until ' .. a:end .. ' changed'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6344 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6345 call listener_add('Listener', bufnr)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6346
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6347 < The List cannot be changed. Each item in "changes" is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6348 dictionary with these entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6349 lnum the first line number of the change
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6350 end the first line below the change
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6351 added number of lines added; negative if lines were
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6352 deleted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6353 col first column in "lnum" that was affected by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6354 the change; one if unknown or the whole line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6355 was affected; this is a byte index, first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6356 character has a value of one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6357 When lines are inserted (not when a line is split, e.g. by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6358 typing CR in Insert mode) the values are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6359 lnum line above which the new line is added
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6360 end equal to "lnum"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6361 added number of lines inserted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6362 col 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6363 When lines are deleted the values are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6364 lnum the first deleted line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6365 end the line below the first deleted line, before
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6366 the deletion was done
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6367 added negative, number of lines deleted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6368 col 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6369 When lines are changed:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6370 lnum the first changed line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6371 end the line below the last changed line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6372 added 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6373 col first column with a change or 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6374
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6375 The entries are in the order the changes were made, thus the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6376 most recent change is at the end. The line numbers are valid
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6377 when the callback is invoked, but later changes may make them
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6378 invalid, thus keeping a copy for later might not work.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6379
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6380 The {callback} is invoked just before the screen is updated,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6381 when \|listener_flush()\| is called or when a change is being
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6382 made that changes the line count in a way it causes a line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6383 number in the list of changes to become invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6384
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6385 The {callback} is invoked with the text locked, see
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6386 \|textlock\|. If you do need to make changes to the buffer, use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6387 a timer to do this later \|timer_start()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6388
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6389 The {callback} is not invoked when the buffer is first loaded.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6390 Use the \|BufReadPost\| autocmd event to handle the initial text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6391 of a buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6392 The {callback} is also not invoked when the buffer is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6393 unloaded, use the \|BufUnload\| autocmd event for that.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6394
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6395 Returns zero if {callback} or {buf} is invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6396
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6397 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6398 second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6399 GetBuffer()->listener_add(callback)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6400 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6401 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6402
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6403
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6404 listener_flush([{buf}]) listener_flush()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6405 Invoke listener callbacks for buffer {buf}. If there are no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6406 pending changes then no callbacks are invoked.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6407
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6408 {buf} refers to a buffer name or number. For the accepted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6409 values, see \|bufname()\|. When {buf} is omitted the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6410 buffer is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6411
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6412 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6413 GetBuffer()->listener_flush()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6414 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6415 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6416
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6417
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6418 listener_remove({id}) listener_remove()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6419 Remove a listener previously added with listener_add().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6420 Returns FALSE when {id} could not be found, TRUE when {id} was
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6421 removed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6422
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6423 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6424 GetListenerId()->listener_remove()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6425 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6426 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6427
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6428
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6429 localtime() localtime()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6430 Return the current time, measured as seconds since 1st Jan
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6431 1970. See also \|strftime()\|, \|strptime()\| and \|getftime()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6432
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6433 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6434
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6435
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6436 log({expr}) log()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6437 Return the natural logarithm (base e) of {expr} as a \|Float\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6438 {expr} must evaluate to a \|Float\| or a \|Number\| in the range
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6439 (0, inf].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6440 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6441 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6442 :echo log(10)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6443 < 2.302585 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6444 :echo log(exp(5))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6445 < 5.0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6446
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6447 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6448 Compute()->log()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6449 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6450 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6451
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6452
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6453 log10({expr}) log10()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6454 Return the logarithm of Float {expr} to base 10 as a \|Float\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6455 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6456 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6457 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6458 :echo log10(1000)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6459 < 3.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6460 :echo log10(0.01)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6461 < -2.0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6462
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6463 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6464 Compute()->log10()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6465 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6466 Return type: \|Float\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6467
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6468
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6469 luaeval({expr} [, {expr}]) luaeval()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6470 Evaluate Lua expression {expr} and return its result converted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6471 to Vim data structures. Second {expr} may hold additional
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6472 argument accessible as _A inside first {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6473 Strings are returned as they are.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6474 Boolean objects are converted to numbers.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6475 Numbers are converted to \|Float\| values.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6476 Dictionaries and lists obtained by vim.eval() are returned
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6477 as-is.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6478 Other objects are returned as zero without any errors.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6479 See \|lua-luaeval\| for more details.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6480 Note that in a `:def` function local variables are not visible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6481 to {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6482
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6483 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6484 GetExpr()->luaeval()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6485 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6486 Return type: any, depending on {expr}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6487
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6488 {only available when compiled with the \|+lua\| feature}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6489
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6490
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6491 map({expr1}, {expr2}) map()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6492 {expr1} must be a \|List\|, \|String\|, \|Blob\| or \|Dictionary\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6493 When {expr1} is a \|List\| or \|Dictionary\|, replace each
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6494 item in {expr1} with the result of evaluating {expr2}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6495 For a \|Blob\| each byte is replaced.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6496 For a \|String\|, each character, including composing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6497 characters, is replaced.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6498 If the item type changes you may want to use \|mapnew()\| to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6499 create a new List or Dictionary. This is required when using
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6500 Vim9 script.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6501
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6502 {expr2} must be a \|String\| or \|Funcref\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6503
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6504 If {expr2} is a \|String\|, inside {expr2} \|v:val\| has the value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6505 of the current item. For a \|Dictionary\| \|v:key\| has the key
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6506 of the current item and for a \|List\| \|v:key\| has the index of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6507 the current item. For a \|Blob\| \|v:key\| has the index of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6508 current byte. For a \|String\| \|v:key\| has the index of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6509 current character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6510 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6511 :call map(mylist, '"> " .. v:val .. " <"')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6512 < This puts "> " before and " <" after each item in "mylist".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6513
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6514 Note that {expr2} is the result of an expression and is then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6515 used as an expression again. Often it is good to use a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6516 \|literal-string\| to avoid having to double backslashes. You
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6517 still have to double ' quotes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6518
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6519 If {expr2} is a \|Funcref\| it is called with two arguments:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6520 1. The key or the index of the current item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6521 2. the value of the current item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6522 With a legacy script lambda you don't get an error if it only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6523 accepts one argument, but with a Vim9 lambda you get "E1106:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6524 One argument too many", the number of arguments must match.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6525
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6526 The function must return the new value of the item. Example
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6527 that changes each value by "key-value": >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6528 func KeyValue(key, val)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6529 return a:key .. '-' .. a:val
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6530 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6531 call map(myDict, function('KeyValue'))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6532 < It is shorter when using a \|lambda\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6533 call map(myDict, {key, val -> key .. '-' .. val})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6534 < If you do not use "val" you can leave it out: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6535 call map(myDict, {key -> 'item: ' .. key})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6536 < If you do not use "key" you can use a short name: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6537 call map(myDict, {_, val -> 'item: ' .. val})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6538 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6539 The operation is done in-place for a \|List\| and \|Dictionary\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6540 If you want it to remain unmodified make a copy first: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6541 :let tlist = map(copy(mylist), ' v:val .. "\t"')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6542
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6543 < Returns {expr1}, the \|List\| or \|Dictionary\| that was filtered,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6544 or a new \|Blob\| or \|String\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6545 When an error is encountered while evaluating {expr2} no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6546 further items in {expr1} are processed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6547 When {expr2} is a Funcref errors inside a function are ignored,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6548 unless it was defined with the "abort" flag.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6549
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6550 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6551 mylist->map(expr2)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6552 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6553 Return type: \|String\|, \|Blob\|, list<{type}> or dict<{type}>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6554 depending on {expr1}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6555
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6556
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6557 maparg({name} [, {mode} [, {abbr} [, {dict}]]]) maparg()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6558 When {dict} is omitted or zero: Return the rhs of mapping
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6559 {name} in mode {mode}. The returned String has special
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6560 characters translated like in the output of the ":map" command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6561 listing. When {dict} is TRUE a dictionary is returned, see
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6562 below. To get a list of all mappings see \|maplist()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6563
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6564 When there is no mapping for {name}, an empty String is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6565 returned if {dict} is FALSE, otherwise returns an empty Dict.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6566 When the mapping for {name} is empty, then "<Nop>" is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6567 returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6568
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6569 The {name} can have special key names, like in the ":map"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6570 command.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6571
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6572 {mode} can be one of these strings:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6573 "n" Normal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6574 "v" Visual (including Select)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6575 "o" Operator-pending
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6576 "i" Insert
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6577 "c" Cmd-line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6578 "s" Select
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6579 "x" Visual
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6580 "l" langmap \|language-mapping\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6581 "t" Terminal-Job
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6582 "" Normal, Visual and Operator-pending
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6583 When {mode} is omitted, the modes for "" are used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6584
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6585 When {abbr} is there and it is \|TRUE\| use abbreviations
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6586 instead of mappings.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6587
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6588 When {dict} is there and it is \|TRUE\| return a dictionary
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6589 containing all the information of the mapping with the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6590 following items: mapping-dict
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6591 "lhs" The {lhs} of the mapping as it would be typed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6592 "lhsraw" The {lhs} of the mapping as raw bytes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6593 "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6594 form, only present when it differs from "lhsraw"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6595 "rhs" The {rhs} of the mapping as typed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6596 "silent" 1 for a \|:map-silent\| mapping, else 0.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6597 "noremap" 1 if the {rhs} of the mapping is not remappable.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6598 "script" 1 if mapping was defined with <script>.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6599 "expr" 1 for an expression mapping (\|:map-<expr>\|).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6600 "buffer" 1 for a buffer local mapping (\|:map-local\|).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6601 "mode" Modes for which the mapping is defined. In
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6602 addition to the modes mentioned above, these
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6603 characters will be used:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6604 " " Normal, Visual and Operator-pending
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6605 "!" Insert and Commandline mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6606 (\|mapmode-ic\|)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6607 "sid" The script local ID, used for <sid> mappings
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6608 (\|<SID>\|). Negative for special contexts.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6609 "scriptversion" The version of the script. 999999 for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6610 \|Vim9\| script.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6611 "lnum" The line number in "sid", zero if unknown.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6612 "nowait" Do not wait for other, longer mappings.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6613 (\|:map-<nowait>\|).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6614 "abbr" True if this is an abbreviation \|abbreviations\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6615 "mode_bits" Vim's internal binary representation of "mode".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6616 \|mapset()\| ignores this; only "mode" is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6617 See \|maplist()\| for usage examples. The values
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6618 are from src/vim.h and may change in the future.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6619
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6620 The dictionary can be used to restore a mapping with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6621 \|mapset()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6622
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6623 The mappings local to the current buffer are checked first,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6624 then the global mappings.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6625 This function can be used to map a key even when it's already
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6626 mapped, and have it do the original mapping too. Sketch: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6627 exe 'nnoremap <Tab> ==' .. maparg('<Tab>', 'n')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6628
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6629 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6630 GetKey()->maparg('n')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6631 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6632 Return type: \|String\| or dict<any> depending on {dict}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6633
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6634
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6635 mapcheck({name} [, {mode} [, {abbr}]]) mapcheck()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6636 Check if there is a mapping that matches with {name} in mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6637 {mode}. See \|maparg()\| for {mode} and special names in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6638 {name}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6639 When {abbr} is there and it is \|TRUE\| use abbreviations
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6640 instead of mappings.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6641 A match happens with a mapping that starts with {name} and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6642 with a mapping which is equal to the start of {name}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6643
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6644 matches mapping "a" "ab" "abc" ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6645 mapcheck("a") yes yes yes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6646 mapcheck("abc") yes yes yes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6647 mapcheck("ax") yes no no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6648 mapcheck("b") no no no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6649
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6650 The difference with maparg() is that mapcheck() finds a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6651 mapping that matches with {name}, while maparg() only finds a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6652 mapping for {name} exactly.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6653 When there is no mapping that starts with {name}, an empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6654 String is returned. If there is one, the RHS of that mapping
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6655 is returned. If there are several mappings that start with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6656 {name}, the RHS of one of them is returned. This will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6657 "<Nop>" if the RHS is empty.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6658 The mappings local to the current buffer are checked first,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6659 then the global mappings.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6660 This function can be used to check if a mapping can be added
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6661 without being ambiguous. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6662 :if mapcheck("_vv") == ""
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6663 : map _vv :set guifont=7x13<CR>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6664 :endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6665 < This avoids adding the "_vv" mapping when there already is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6666 mapping for "_v" or for "_vvv".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6667
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6668 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6669 GetKey()->mapcheck('n')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6670 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6671 Return type: \|String\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6672
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6673
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6674 maplist([{abbr}]) maplist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6675 Returns a \|List\| of all mappings. Each List item is a \|Dict\|,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6676 the same as what is returned by \|maparg()\|, see
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6677 \|mapping-dict\|. When {abbr} is there and it is \|TRUE\| use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6678 abbreviations instead of mappings.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6679
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6680 Example to show all mappings with 'MultiMatch' in rhs: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6681 vim9script
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6682 echo maplist()->filter(
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6683 (_, m) => match(m.rhs, 'MultiMatch') >= 0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6684 < It can be tricky to find mappings for particular \|:map-modes\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6685 \|mapping-dict\|'s "mode_bits" can simplify this. For example,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6686 the mode_bits for Normal, Insert or Command-line modes are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6687 0x19. To find all the mappings available in those modes you
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6688 can do: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6689 vim9script
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6690 var saved_maps = []
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6691 for m in maplist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6692 if and(m.mode_bits, 0x19) != 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6693 saved_maps->add(m)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6694 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6695 endfor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6696 echo saved_maps->mapnew((_, m) => m.lhs)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6697 < The values of the mode_bits are defined in Vim's src/vim.h
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6698 file and they can be discovered at runtime using
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6699 \|:map-commands\| and "maplist()". Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6700 vim9script
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6701 omap xyzzy <Nop>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6702 var op_bit = maplist()->filter(
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6703 (_, m) => m.lhs == 'xyzzy')[0].mode_bits
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6704 ounmap xyzzy
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6705 echo printf("Operator-pending mode bit: 0x%x", op_bit)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6706 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6707 Return type: list<dict<any>>
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6708
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6709
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6710 mapnew({expr1}, {expr2}) mapnew()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6711 Like \|map()\| but instead of replacing items in {expr1} a new
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6712 List or Dictionary is created and returned. {expr1} remains
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6713 unchanged. Items can still be changed by {expr2}, if you
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6714 don't want that use \|deepcopy()\| first.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6715
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6716 Return type: \|String\|, \|Blob\|, list<{type}> or dict<{type}>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6717 depending on {expr1}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6718
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6719
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6720 mapset({mode}, {abbr}, {dict}) mapset()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6721 mapset({dict})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6722 Restore a mapping from a dictionary, possibly returned by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6723 \|maparg()\| or \|maplist()\|. A buffer mapping, when dict.buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6724 is true, is set on the current buffer; it is up to the caller
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6725 to ensure that the intended buffer is the current buffer. This
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6726 feature allows copying mappings from one buffer to another.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6727 The dict.mode value may restore a single mapping that covers
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6728 more than one mode, like with mode values of '!', ' ', 'nox',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6729 or 'v'. E1276
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6730
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6731 In the first form, {mode} and {abbr} should be the same as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6732 for the call to \|maparg()\|. E460
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6733 {mode} is used to define the mode in which the mapping is set,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6734 not the "mode" entry in {dict}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6735 Example for saving and restoring a mapping: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6736 let save_map = maparg('K', 'n', 0, 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6737 nnoremap K somethingelse
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6738 ...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6739 call mapset('n', 0, save_map)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6740 < Note that if you are going to replace a map in several modes,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6741 e.g. with `:map!`, you need to save/restore the mapping for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6742 all of them, when they might differ.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6743
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6744 In the second form, with {dict} as the only argument, mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6745 and abbr are taken from the dict.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6746 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6747 vim9script
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6748 var save_maps = maplist()->filter(
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6749 (_, m) => m.lhs == 'K')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6750 nnoremap K somethingelse
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6751 cnoremap K somethingelse2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6752 # ...
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6753 unmap K
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6754 for d in save_maps
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6755 mapset(d)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6756 endfor
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6757 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6758 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6759
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6760
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6761 match({expr}, {pat} [, {start} [, {count}]]) match()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6762 When {expr} is a \|List\| then this returns the index of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6763 first item where {pat} matches. Each item is used as a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6764 String, \|Lists\| and \|Dictionaries\| are used as echoed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6765
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6766 Otherwise, {expr} is used as a String. The result is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6767 Number, which gives the index (byte offset) in {expr} where
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6768 {pat} matches.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6769
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6770 A match at the first character or \|List\| item returns zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6771 If there is no match -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6772
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6773 For getting submatches see \|matchlist()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6774 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6775 :echo match("testing", "ing") " results in 4
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6776 :echo match([1, 'x'], '\a') " results in 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6777 < See \|string-match\| for how {pat} is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6778 strpbrk()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6779 Vim doesn't have a strpbrk() function. But you can do: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6780 :let sepidx = match(line, '[.,;: \t]')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6781 < strcasestr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6782 Vim doesn't have a strcasestr() function. But you can add
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6783 "\c" to the pattern to ignore case: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6784 :let idx = match(haystack, '\cneedle')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6785 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6786 If {start} is given, the search starts from byte index
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6787 {start} in a String or item {start} in a \|List\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6788 The result, however, is still the index counted from the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6789 first character/item. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6790 :echo match("testing", "ing", 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6791 < result is again "4". >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6792 :echo match("testing", "ing", 4)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6793 < result is again "4". >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6794 :echo match("testing", "t", 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6795 < result is "3".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6796 For a String, if {start} > 0 then it is like the string starts
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6797 {start} bytes later, thus "^" will match at {start}. Except
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6798 when {count} is given, then it's like matches before the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6799 {start} byte are ignored (this is a bit complicated to keep it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6800 backwards compatible).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6801 For a String, if {start} < 0, it will be set to 0. For a list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6802 the index is counted from the end.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6803 If {start} is out of range ({start} > strlen({expr}) for a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6804 String or {start} > len({expr}) for a \|List\|) -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6805
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6806 When {count} is given use the {count}'th match. When a match
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6807 is found in a String the search for the next one starts one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6808 character further. Thus this example results in 1: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6809 echo match("testing", "..", 0, 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6810 < In a \|List\| the search continues in the next item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6811 Note that when {count} is added the way {start} works changes,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6812 see above.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6813
34411 7b6e286c89cb runtime(doc) Update help text for matchbufline() and matchstrlist() Christian Brabandt <cb@256bit.org> parents: 34403 diff changeset	6814 match-pattern
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6815 See \|pattern\| for the patterns that are accepted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6816 The 'ignorecase' option is used to set the ignore-caseness of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6817 the pattern. 'smartcase' is NOT used. The matching is always
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6818 done like 'magic' is set and 'cpoptions' is empty.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6819 Note that a match at the start is preferred, thus when the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6820 pattern is using "*" (any number of matches) it tends to find
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6821 zero matches at the start instead of a number of matches
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6822 further down in the text.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6823
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6824 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6825 GetText()->match('word')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6826 GetList()->match('word')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6827 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6828 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6829
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6830
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6831 matchadd() E290 E798 E799 E801 E957
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6832 matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6833 Defines a pattern to be highlighted in the current window (a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6834 "match"). It will be highlighted with {group}. Returns an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6835 identification number (ID), which can be used to delete the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6836 match using \|matchdelete()\|. The ID is bound to the window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6837 Matching is case sensitive and magic, unless case sensitivity
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6838 or magicness are explicitly overridden in {pattern}. The
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6839 'magic', 'smartcase' and 'ignorecase' options are not used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6840 The "Conceal" value is special, it causes the match to be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6841 concealed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6842
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6843 The optional {priority} argument assigns a priority to the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6844 match. A match with a high priority will have its
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6845 highlighting overrule that of a match with a lower priority.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6846 A priority is specified as an integer (negative numbers are no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6847 exception). If the {priority} argument is not specified, the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6848 default priority is 10. The priority of 'hlsearch' is zero,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6849 hence all matches with a priority greater than zero will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6850 overrule it. Syntax highlighting (see 'syntax') is a separate
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6851 mechanism, and regardless of the chosen priority a match will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6852 always overrule syntax highlighting.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6853
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6854 The optional {id} argument allows the request for a specific
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6855 match ID. If a specified ID is already taken, an error
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6856 message will appear and the match will not be added. An ID
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6857 is specified as a positive integer (zero excluded). IDs 1, 2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6858 and 3 are reserved for \|:match\|, \|:2match\| and \|:3match\|,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6859 respectively. 3 is reserved for use by the \|matchparen\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6860 plugin.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6861 If the {id} argument is not specified or -1, \|matchadd()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6862 automatically chooses a free ID, which is at least 1000.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6863
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6864 The optional {dict} argument allows for further custom
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6865 values. Currently this is used to specify a match specific
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6866 conceal character that will be shown for \|hl-Conceal\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6867 highlighted matches. The dict can have the following members:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6868
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6869 conceal Special character to show instead of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6870 match (only for \|hl-Conceal\| highlighted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6871 matches, see \|:syn-cchar\|)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6872 window Instead of the current window use the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6873 window with this number or window ID.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6874
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6875 The number of matches is not limited, as it is the case with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6876 the \|:match\| commands.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6877
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6878 Returns -1 on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6879
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6880 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6881 :highlight MyGroup ctermbg=green guibg=green
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6882 :let m = matchadd("MyGroup", "TODO")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6883 < Deletion of the pattern: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6884 :call matchdelete(m)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6885
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6886 < A list of matches defined by \|matchadd()\| and \|:match\| are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6887 available from \|getmatches()\|. All matches can be deleted in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6888 one operation by \|clearmatches()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6889
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6890 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6891 GetGroup()->matchadd('TODO')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6892 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6893 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6894
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6895
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6896 matchaddpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6897 matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6898 Same as \|matchadd()\|, but requires a list of positions {pos}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6899 instead of a pattern. This command is faster than \|matchadd()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6900 because it does not require to handle regular expressions and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6901 sets buffer line boundaries to redraw screen. It is supposed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6902 to be used when fast match additions and deletions are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6903 required, for example to highlight matching parentheses.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6904
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6905 {pos} is a list of positions. Each position can be one of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6906 these:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6907 - A number. This whole line will be highlighted. The first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6908 line has number 1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6909 - A list with one number, e.g., [23]. The whole line with this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6910 number will be highlighted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6911 - A list with two numbers, e.g., [23, 11]. The first number is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6912 the line number, the second one is the column number (first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6913 column is 1, the value must correspond to the byte index as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6914 \|col()\| would return). The character at this position will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6915 be highlighted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6916 - A list with three numbers, e.g., [23, 11, 3]. As above, but
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6917 the third number gives the length of the highlight in bytes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6918
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6919 Returns -1 on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6920
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6921 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6922 :highlight MyGroup ctermbg=green guibg=green
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6923 :let m = matchaddpos("MyGroup", [[23, 24], 34])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6924 < Deletion of the pattern: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6925 :call matchdelete(m)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6926
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6927 < Matches added by \|matchaddpos()\| are returned by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6928 \|getmatches()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6929
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6930 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6931 GetGroup()->matchaddpos([23, 11])
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6932 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6933 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6934
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6935
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6936 matcharg({nr}) matcharg()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6937 Selects the {nr} match item, as set with a \|:match\|,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6938 \|:2match\| or \|:3match\| command.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6939 Return a \|List\| with two elements:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6940 The name of the highlight group used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6941 The pattern used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6942 When {nr} is not 1, 2 or 3 returns an empty \|List\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6943 When there is no match item set returns ['', ''].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6944 This is useful to save and restore a \|:match\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6945 Highlighting matches using the \|:match\| commands are limited
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6946 to three matches. \|matchadd()\| does not have this limitation.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6947
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6948 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	6949 GetMatch()->matcharg()
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6950 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6951 Return type: list<string>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	6952
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6953 matchbufline()
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6954 matchbufline({buf}, {pat}, {lnum}, {end}, [, {dict}])
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6955 Returns the \|List\| of matches in lines from {lnum} to {end} in
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6956 buffer {buf} where {pat} matches.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6957
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6958 {lnum} and {end} can either be a line number or the string "$"
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6959 to refer to the last line in {buf}.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6960
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6961 The {dict} argument supports following items:
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6962 submatches include submatch information (\|/\(\|)
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6963
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6964 For each match, a \|Dict\| with the following items is returned:
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6965 byteidx starting byte index of the match
34135 65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6966 lnum line number where there is a match
65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6967 text matched string
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6968 Note that there can be multiple matches in a single line.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6969
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6970 This function works only for loaded buffers. First call
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6971 \|bufload()\| if needed.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6972
34411 7b6e286c89cb runtime(doc) Update help text for matchbufline() and matchstrlist() Christian Brabandt <cb@256bit.org> parents: 34403 diff changeset	6973 See \|match-pattern\| for information about the effect of some
7b6e286c89cb runtime(doc) Update help text for matchbufline() and matchstrlist() Christian Brabandt <cb@256bit.org> parents: 34403 diff changeset	6974 option settings on the pattern.
7b6e286c89cb runtime(doc) Update help text for matchbufline() and matchstrlist() Christian Brabandt <cb@256bit.org> parents: 34403 diff changeset	6975
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6976 When {buf} is not a valid buffer, the buffer is not loaded or
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6977 {lnum} or {end} is not valid then an error is given and an
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6978 empty \|List\| is returned.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6979
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6980 Examples: >
34135 65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6981 " Assuming line 3 in buffer 5 contains "a"
65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6982 :echo matchbufline(5, '\<\k\+\>', 3, 3)
65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6983 [{'lnum': 3, 'byteidx': 0, 'text': 'a'}]
65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6984 " Assuming line 4 in buffer 10 contains "tik tok"
65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6985 :echo matchbufline(10, '\<\k\+\>', 1, 4)
65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6986 [{'lnum': 4, 'byteidx': 0, 'text': 'tik'}, {'lnum': 4, 'byteidx': 4, 'text': 'tok'}]
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6987 <
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6988 If {submatch} is present and is v:true, then submatches like
34135 65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6989 "\1", "\2", etc. are also returned. Example: >
65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6990 " Assuming line 2 in buffer 2 contains "acd"
65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6991 :echo matchbufline(2, '$a$\?$b$\?$c$\?$.*$', 2, 2
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6992 \ {'submatches': v:true})
34135 65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	6993 [{'lnum': 2, 'byteidx': 0, 'text': 'acd', 'submatches': ['a', '', 'c', 'd', '', '', '', '', '']}]
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6994 < The "submatches" List always contains 9 items. If a submatch
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6995 is not found, then an empty string is returned for that
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6996 submatch.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6997
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6998 Can also be used as a \|method\|: >
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	6999 GetBuffer()->matchbufline('mypat', 1, '$')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7000 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7001 Return type: list<dict<any>> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7002
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7003
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7004 matchdelete({id} [, {win}) matchdelete() E802 E803
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7005 Deletes a match with ID {id} previously defined by \|matchadd()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7006 or one of the \|:match\| commands. Returns 0 if successful,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7007 otherwise -1. See example for \|matchadd()\|. All matches can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7008 be deleted in one operation by \|clearmatches()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7009 If {win} is specified, use the window with this number or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7010 window ID instead of the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7011
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7012 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7013 GetMatch()->matchdelete()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7014 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7015 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7016
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7017
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7018 matchend({expr}, {pat} [, {start} [, {count}]]) matchend()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7019 Same as \|match()\|, but return the index of first character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7020 after the match. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7021 :echo matchend("testing", "ing")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7022 < results in "7".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7023 strspn() strcspn()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7024 Vim doesn't have a strspn() or strcspn() function, but you can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7025 do it with matchend(): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7026 :let span = matchend(line, '[a-zA-Z]')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7027 :let span = matchend(line, '[^a-zA-Z]')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7028 < Except that -1 is returned when there are no matches.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7029
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7030 The {start}, if given, has the same meaning as for \|match()\|. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7031 :echo matchend("testing", "ing", 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7032 < results in "7". >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7033 :echo matchend("testing", "ing", 5)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7034 < result is "-1".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7035 When {expr} is a \|List\| the result is equal to \|match()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7036
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7037 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7038 GetText()->matchend('word')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7039 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7040 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7041
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7042
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7043 matchfuzzy({list}, {str} [, {dict}]) matchfuzzy()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7044 If {list} is a list of strings, then returns a \|List\| with all
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7045 the strings in {list} that fuzzy match {str}. The strings in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7046 the returned list are sorted based on the matching score.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7047
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7048 The optional {dict} argument always supports the following
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7049 items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7050 matchseq When this item is present return only matches
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7051 that contain the characters in {str} in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7052 given sequence.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7053 limit Maximum number of matches in {list} to be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7054 returned. Zero means no limit.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7055
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7056 If {list} is a list of dictionaries, then the optional {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7057 argument supports the following additional items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7058 key Key of the item which is fuzzy matched against
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7059 {str}. The value of this item should be a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7060 string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7061 text_cb \|Funcref\| that will be called for every item
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7062 in {list} to get the text for fuzzy matching.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7063 This should accept a dictionary item as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7064 argument and return the text for that item to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7065 use for fuzzy matching.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7066
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7067 {str} is treated as a literal string and regular expression
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7068 matching is NOT supported. The maximum supported {str} length
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7069 is 256.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7070
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7071 When {str} has multiple words each separated by white space,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7072 then the list of strings that have all the words is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7073
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7074 If there are no matching strings or there is an error, then an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7075 empty list is returned. If length of {str} is greater than
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7076 256, then returns an empty list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7077
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7078 When {limit} is given, matchfuzzy() will find up to this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7079 number of matches in {list} and return them in sorted order.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7080
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7081 Refer to \|fuzzy-matching\| for more information about fuzzy
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7082 matching strings.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7083
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7084 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7085 :echo matchfuzzy(["clay", "crow"], "cay")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7086 < results in ["clay"]. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7087 :echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7088 < results in a list of buffer names fuzzy matching "ndl". >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7089 :echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7090 < results in a list of buffer information dicts with buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7091 names fuzzy matching "ndl". >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7092 :echo getbufinfo()->matchfuzzy("spl",
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7093 \ {'text_cb' : {v -> v.name}})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7094 < results in a list of buffer information dicts with buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7095 names fuzzy matching "spl". >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7096 :echo v:oldfiles->matchfuzzy("test")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7097 < results in a list of file names fuzzy matching "test". >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7098 :let l = readfile("buffer.c")->matchfuzzy("str")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7099 < results in a list of lines in "buffer.c" fuzzy matching "str". >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7100 :echo ['one two', 'two one']->matchfuzzy('two one')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7101 < results in ['two one', 'one two']. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7102 :echo ['one two', 'two one']->matchfuzzy('two one',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7103 \ {'matchseq': 1})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7104 < results in ['two one'].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7105
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7106 Return type: list<string> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7107
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7108
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7109 matchfuzzypos({list}, {str} [, {dict}]) matchfuzzypos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7110 Same as \|matchfuzzy()\|, but returns the list of matched
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7111 strings, the list of character positions where characters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7112 in {str} matches and a list of matching scores. You can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7113 use \|byteidx()\| to convert a character position to a byte
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7114 position.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7115
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7116 If {str} matches multiple times in a string, then only the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7117 positions for the best match is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7118
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7119 If there are no matching strings or there is an error, then a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7120 list with three empty list items is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7121
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7122 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7123 :echo matchfuzzypos(['testing'], 'tsg')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7124 < results in [['testing'], [[0, 2, 6]], [99]] >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7125 :echo matchfuzzypos(['clay', 'lacy'], 'la')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7126 < results in [['lacy', 'clay'], [[0, 1], [1, 2]], [153, 133]] >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7127 :echo [{'text': 'hello', 'id' : 10}]->matchfuzzypos('ll', {'key' : 'text'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7128 < results in [[{'id': 10, 'text': 'hello'}], [[2, 3]], [127]]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7129
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7130 Return type: list<list<any>>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7131
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7132
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7133 matchlist({expr}, {pat} [, {start} [, {count}]]) matchlist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7134 Same as \|match()\|, but return a \|List\|. The first item in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7135 list is the matched string, same as what matchstr() would
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7136 return. Following items are submatches, like "\1", "\2", etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7137 in \|:substitute\|. When an optional submatch didn't match an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7138 empty string is used. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7139 echo matchlist('acd', '$a$\?$b$\?$c$\?$.*$')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7140 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7141 When there is no match an empty list is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7142
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7143 You can pass in a List, but that is not very useful.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7144
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7145 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7146 GetText()->matchlist('word')
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7147 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7148 Return type: list<string> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7149
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7150 matchstrlist()
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7151 matchstrlist({list}, {pat} [, {dict}])
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7152 Returns the \|List\| of matches in {list} where {pat} matches.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7153 {list} is a \|List\| of strings. {pat} is matched against each
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7154 string in {list}.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7155
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7156 The {dict} argument supports following items:
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7157 submatches include submatch information (\|/\(\|)
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7158
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7159 For each match, a \|Dict\| with the following items is returned:
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7160 byteidx starting byte index of the match.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7161 idx index in {list} of the match.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7162 text matched string
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7163 submatches a List of submatches. Present only if
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7164 "submatches" is set to v:true in {dict}.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7165
34411 7b6e286c89cb runtime(doc) Update help text for matchbufline() and matchstrlist() Christian Brabandt <cb@256bit.org> parents: 34403 diff changeset	7166 See \|match-pattern\| for information about the effect of some
7b6e286c89cb runtime(doc) Update help text for matchbufline() and matchstrlist() Christian Brabandt <cb@256bit.org> parents: 34403 diff changeset	7167 option settings on the pattern.
7b6e286c89cb runtime(doc) Update help text for matchbufline() and matchstrlist() Christian Brabandt <cb@256bit.org> parents: 34403 diff changeset	7168
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7169 Example: >
34135 65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	7170 :echo matchstrlist(['tik tok'], '\<\k\+\>')
65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	7171 [{'idx': 0, 'byteidx': 0, 'text': 'tik'}, {'idx': 0, 'byteidx': 4, 'text': 'tok'}]
65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	7172 :echo matchstrlist(['a', 'b'], '\<\k\+\>')
65a3e7bb12b7 runtime(doc): Replace non-breaking space with normal space (#13868) Christian Brabandt <cb@256bit.org> parents: 34128 diff changeset	7173 [{'idx': 0, 'byteidx': 0, 'text': 'a'}, {'idx': 1, 'byteidx': 0, 'text': 'b'}]
34080 034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7174 <
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7175 If "submatches" is present and is v:true, then submatches like
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7176 "\1", "\2", etc. are also returned. Example: >
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7177 :echo matchstrlist(['acd'], '$a$\?$b$\?$c$\?$.*$',
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7178 \ #{submatches: v:true})
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7179 [{'idx': 0, 'byteidx': 0, 'text': 'acd', 'submatches': ['a', '', 'c', 'd', '', '', '', '', '']}]
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7180 < The "submatches" List always contains 9 items. If a submatch
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7181 is not found, then an empty string is returned for that
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7182 submatch.
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7183
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7184 Can also be used as a \|method\|: >
034445b3af10 patch 9.1.0009: Cannot easily get the list of matches Christian Brabandt <cb@256bit.org> parents: 34057 diff changeset	7185 GetListOfStrings()->matchstrlist('mypat')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7186 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7187 Return type: list<dict<any>> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7188
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7189
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7190 matchstr({expr}, {pat} [, {start} [, {count}]]) matchstr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7191 Same as \|match()\|, but return the matched string. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7192 :echo matchstr("testing", "ing")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7193 < results in "ing".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7194 When there is no match "" is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7195 The {start}, if given, has the same meaning as for \|match()\|. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7196 :echo matchstr("testing", "ing", 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7197 < results in "ing". >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7198 :echo matchstr("testing", "ing", 5)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7199 < result is "".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7200 When {expr} is a \|List\| then the matching item is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7201 The type isn't changed, it's not necessarily a String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7202
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7203 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7204 GetText()->matchstr('word')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7205 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7206 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7207
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7208
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7209 matchstrpos({expr}, {pat} [, {start} [, {count}]]) matchstrpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7210 Same as \|matchstr()\|, but return the matched string, the start
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7211 position and the end position of the match. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7212 :echo matchstrpos("testing", "ing")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7213 < results in ["ing", 4, 7].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7214 When there is no match ["", -1, -1] is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7215 The {start}, if given, has the same meaning as for \|match()\|. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7216 :echo matchstrpos("testing", "ing", 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7217 < results in ["ing", 4, 7]. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7218 :echo matchstrpos("testing", "ing", 5)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7219 < result is ["", -1, -1].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7220 When {expr} is a \|List\| then the matching item, the index
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7221 of first item where {pat} matches, the start position and the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7222 end position of the match are returned. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7223 :echo matchstrpos([1, '__x'], '\a')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7224 < result is ["x", 1, 2, 3].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7225 The type isn't changed, it's not necessarily a String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7226
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7227 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7228 GetText()->matchstrpos('word')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7229 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7230 Return type: list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7231
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7232
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7233 max({expr}) max()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7234 Return the maximum value of all items in {expr}. Example: >
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7235 echo max([apples, pears, oranges])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7236
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7237 < {expr} can be a \|List\| or a \|Dictionary\|. For a Dictionary,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7238 it returns the maximum of all values in the Dictionary.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7239 If {expr} is neither a List nor a Dictionary, or one of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7240 items in {expr} cannot be used as a Number this results in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7241 an error. An empty \|List\| or \|Dictionary\| results in zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7242
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7243 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7244 mylist->max()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7245 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7246 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7247
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7248
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7249 menu_info({name} [, {mode}]) menu_info()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7250 Return information about the specified menu {name} in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7251 mode {mode}. The menu name should be specified without the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7252 shortcut character ('&'). If {name} is "", then the top-level
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7253 menu names are returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7254
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7255 {mode} can be one of these strings:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7256 "n" Normal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7257 "v" Visual (including Select)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7258 "o" Operator-pending
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7259 "i" Insert
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7260 "c" Cmd-line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7261 "s" Select
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7262 "x" Visual
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7263 "t" Terminal-Job
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7264 "" Normal, Visual and Operator-pending
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7265 "!" Insert and Cmd-line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7266 When {mode} is omitted, the modes for "" are used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7267
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7268 Returns a \|Dictionary\| containing the following items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7269 accel menu item accelerator text \|menu-text\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7270 display display name (name without '&')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7271 enabled v:true if this menu item is enabled
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7272 Refer to \|:menu-enable\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7273 icon name of the icon file (for toolbar)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7274 \|toolbar-icon\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7275 iconidx index of a built-in icon
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7276 modes modes for which the menu is defined. In
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7277 addition to the modes mentioned above, these
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7278 characters will be used:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7279 " " Normal, Visual and Operator-pending
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7280 name menu item name.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7281 noremenu v:true if the {rhs} of the menu item is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7282 remappable else v:false.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7283 priority menu order priority \|menu-priority\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7284 rhs right-hand-side of the menu item. The returned
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7285 string has special characters translated like
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7286 in the output of the ":menu" command listing.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7287 When the {rhs} of a menu item is empty, then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7288 "<Nop>" is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7289 script v:true if script-local remapping of {rhs} is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7290 allowed else v:false. See \|:menu-script\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7291 shortcut shortcut key (character after '&' in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7292 the menu name) \|menu-shortcut\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7293 silent v:true if the menu item is created
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7294 with <silent> argument \|:menu-silent\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7295 submenus \|List\| containing the names of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7296 all the submenus. Present only if the menu
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7297 item has submenus.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7298
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7299 Returns an empty dictionary if the menu item is not found.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7300
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7301 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7302 :echo menu_info('Edit.Cut')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7303 :echo menu_info('File.Save', 'n')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7304
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7305 " Display the entire menu hierarchy in a buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7306 func ShowMenu(name, pfx)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7307 let m = menu_info(a:name)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7308 call append(line('$'), a:pfx .. m.display)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7309 for child in m->get('submenus', [])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7310 call ShowMenu(a:name .. '.' .. escape(child, '.'),
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7311 \ a:pfx .. ' ')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7312 endfor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7313 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7314 new
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7315 for topmenu in menu_info('').submenus
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7316 call ShowMenu(topmenu, '')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7317 endfor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7318 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7319 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7320 GetMenuName()->menu_info('v')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7321 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7322 Return type: dict<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7323
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7324 min({expr}) min()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7325 Return the minimum value of all items in {expr}. Example: >
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7326 echo min([apples, pears, oranges])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7327
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7328 < {expr} can be a \|List\| or a \|Dictionary\|. For a Dictionary,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7329 it returns the minimum of all values in the Dictionary.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7330 If {expr} is neither a List nor a Dictionary, or one of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7331 items in {expr} cannot be used as a Number this results in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7332 an error. An empty \|List\| or \|Dictionary\| results in zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7333
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7334 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7335 mylist->min()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7336 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7337 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7338
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7339
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7340 mkdir({name} [, {flags} [, {prot}]]) mkdir() E739
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7341 Create directory {name}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7342
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7343 When {flags} is present it must be a string. An empty string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7344 has no effect.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7345
35402 327d5115ca92 runtime(doc): rewrite mkdir() doc and simplify {flags} meaning Christian Brabandt <cb@256bit.org> parents: 35386 diff changeset	7346 {flags} can contain these character flags:
327d5115ca92 runtime(doc): rewrite mkdir() doc and simplify {flags} meaning Christian Brabandt <cb@256bit.org> parents: 35386 diff changeset	7347 "p" intermediate directories will be created as necessary
327d5115ca92 runtime(doc): rewrite mkdir() doc and simplify {flags} meaning Christian Brabandt <cb@256bit.org> parents: 35386 diff changeset	7348 "D" {name} will be deleted at the end of the current
35409 9403f4e0bc6d runtime(doc): fix wrong helptag for :defer Christian Brabandt <cb@256bit.org> parents: 35402 diff changeset	7349 function, but not recursively \|:defer\|
35402 327d5115ca92 runtime(doc): rewrite mkdir() doc and simplify {flags} meaning Christian Brabandt <cb@256bit.org> parents: 35386 diff changeset	7350 "R" {name} will be deleted recursively at the end of the
35409 9403f4e0bc6d runtime(doc): fix wrong helptag for :defer Christian Brabandt <cb@256bit.org> parents: 35402 diff changeset	7351 current function \|:defer\|
35402 327d5115ca92 runtime(doc): rewrite mkdir() doc and simplify {flags} meaning Christian Brabandt <cb@256bit.org> parents: 35386 diff changeset	7352
327d5115ca92 runtime(doc): rewrite mkdir() doc and simplify {flags} meaning Christian Brabandt <cb@256bit.org> parents: 35386 diff changeset	7353 Note that when {name} has more than one part and "p" is used
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7354 some directories may already exist. Only the first one that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7355 is created and what it contains is scheduled to be deleted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7356 E.g. when using: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7357 call mkdir('subdir/tmp/autoload', 'pR')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7358 < and "subdir" already exists then "subdir/tmp" will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7359 scheduled for deletion, like with: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7360 defer delete('subdir/tmp', 'rf')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7361 < Note that if scheduling the defer fails the directory is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7362 deleted. This should only happen when out of memory.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7363
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7364 If {prot} is given it is used to set the protection bits of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7365 the new directory. The default is 0o755 (rwxr-xr-x: r/w for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7366 the user, readable for others). Use 0o700 to make it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7367 unreadable for others. This is only used for the last part of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7368 {name}. Thus if you create /tmp/foo/bar then /tmp/foo will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7369 created with 0o755.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7370 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7371 :call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7372
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7373 < This function is not available in the \|sandbox\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7374
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7375 There is no error if the directory already exists and the "p"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7376 flag is passed (since patch 8.0.1708). However, without the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7377 "p" option the call will fail.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7378
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7379 The function result is a Number, which is TRUE if the call was
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7380 successful or FALSE if the directory creation failed or partly
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7381 failed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7382
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7383 Not available on all systems. To check use: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7384 :if exists("*mkdir")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7385
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7386 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7387 GetName()->mkdir()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7388 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7389 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7390
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7391
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7392 mode([{expr}]) mode()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7393 Return a string that indicates the current mode.
34797 4a2350f8a68b runtime(doc): Normalise builtin-function optional parameter formatting Christian Brabandt <cb@256bit.org> parents: 34780 diff changeset	7394 If {expr} is supplied and it evaluates to a non-zero Number or
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7395 a non-empty String (\|non-zero-arg\|), then the full mode is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7396 returned, otherwise only the first letter is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7397 Also see \|state()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7398
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7399 n Normal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7400 no Operator-pending
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7401 nov Operator-pending (forced characterwise \|o_v\|)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7402 noV Operator-pending (forced linewise \|o_V\|)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7403 noCTRL-V Operator-pending (forced blockwise \|o_CTRL-V\|);
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7404 CTRL-V is one character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7405 niI Normal using \|i_CTRL-O\| in \|Insert-mode\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7406 niR Normal using \|i_CTRL-O\| in \|Replace-mode\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7407 niV Normal using \|i_CTRL-O\| in \|Virtual-Replace-mode\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7408 nt Terminal-Normal (insert goes to Terminal-Job mode)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7409 v Visual by character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7410 vs Visual by character using \|v_CTRL-O\| in Select mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7411 V Visual by line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7412 Vs Visual by line using \|v_CTRL-O\| in Select mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7413 CTRL-V Visual blockwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7414 CTRL-Vs Visual blockwise using \|v_CTRL-O\| in Select mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7415 s Select by character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7416 S Select by line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7417 CTRL-S Select blockwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7418 i Insert
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7419 ic Insert mode completion \|compl-generic\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7420 ix Insert mode \|i_CTRL-X\| completion
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7421 R Replace \|R\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7422 Rc Replace mode completion \|compl-generic\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7423 Rx Replace mode \|i_CTRL-X\| completion
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7424 Rv Virtual Replace \|gR\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7425 Rvc Virtual Replace mode completion \|compl-generic\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7426 Rvx Virtual Replace mode \|i_CTRL-X\| completion
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7427 c Command-line editing
33146 351d2bbfe921 patch 9.0.1855: mode() doesn't indicate command line for terminal Christian Brabandt <cb@256bit.org> parents: 32972 diff changeset	7428 ct Command-line editing via Terminal-Job mode
33848 c3804ff17204 patch 9.0.2135: No test for mode() when executing Ex commands Christian Brabandt <cb@256bit.org> parents: 33842 diff changeset	7429 cr Command-line editing overstrike mode \|c_<Insert>\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7430 cv Vim Ex mode \|gQ\|
33848 c3804ff17204 patch 9.0.2135: No test for mode() when executing Ex commands Christian Brabandt <cb@256bit.org> parents: 33842 diff changeset	7431 cvr Vim Ex mode while in overstrike mode \|c_<Insert>\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7432 ce Normal Ex mode \|Q\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7433 r Hit-enter prompt
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7434 rm The -- more -- prompt
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7435 r? A \|:confirm\| query of some sort
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7436 ! Shell or external command is executing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7437 t Terminal-Job mode: keys go to the job
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7438
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7439 This is useful in the 'statusline' option or when used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7440 with \|remote_expr()\| In most other places it always returns
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7441 "c" or "n".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7442 Note that in the future more modes and more specific modes may
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7443 be added. It's better not to compare the whole string but only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7444 the leading character(s).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7445 Also see \|visualmode()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7446
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7447 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7448 DoFull()->mode()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7449 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7450 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7451
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7452
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7453 mzeval({expr}) mzeval()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7454 Evaluate MzScheme expression {expr} and return its result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7455 converted to Vim data structures.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7456 Numbers and strings are returned as they are.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7457 Pairs (including lists and improper lists) and vectors are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7458 returned as Vim \|Lists\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7459 Hash tables are represented as Vim \|Dictionary\| type with keys
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7460 converted to strings.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7461 All other types are converted to string with display function.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7462 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7463 :mz (define l (list 1 2 3))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7464 :mz (define h (make-hash)) (hash-set! h "list" l)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7465 :echo mzeval("l")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7466 :echo mzeval("h")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7467 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7468 Note that in a `:def` function local variables are not visible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7469 to {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7470
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7471 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7472 GetExpr()->mzeval()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7473 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7474 Return type: any, depending on {expr}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7475
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7476 {only available when compiled with the \|+mzscheme\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7477
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7478
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7479 nextnonblank({lnum}) nextnonblank()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7480 Return the line number of the first line at or below {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7481 that is not blank. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7482 if getline(nextnonblank(1)) =~ "Java"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7483 < When {lnum} is invalid or there is no non-blank line at or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7484 below it, zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7485 {lnum} is used like with \|getline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7486 See also \|prevnonblank()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7487
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7488 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7489 GetLnum()->nextnonblank()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7490 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7491 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7492
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7493
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7494 nr2char({expr} [, {utf8}]) nr2char()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7495 Return a string with a single character, which has the number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7496 value {expr}. Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7497 nr2char(64) returns "@"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7498 nr2char(32) returns " "
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7499 < When {utf8} is omitted or zero, the current 'encoding' is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7500 Example for "utf-8": >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7501 nr2char(300) returns I with bow character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7502 < When {utf8} is TRUE, always return UTF-8 characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7503 Note that a NUL character in the file is specified with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7504 nr2char(10), because NULs are represented with newline
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7505 characters. nr2char(0) is a real NUL and terminates the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7506 string, thus results in an empty string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7507 To turn a list of character numbers into a string: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7508 let list = [65, 66, 67]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7509 let str = join(map(list, {_, val -> nr2char(val)}), '')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7510 < Result: "ABC"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7511
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7512 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7513 GetNumber()->nr2char()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7514 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7515 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7516
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7517
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7518 or({expr}, {expr}) or()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7519 Bitwise OR on the two arguments. The arguments are converted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7520 to a number. A List, Dict or Float argument causes an error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7521 Also see `and()` and `xor()`.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7522 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7523 :let bits = or(bits, 0x80)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7524 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7525 :let bits = bits->or(0x80)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7526
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7527 < Rationale: The reason this is a function and not using the "\|"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7528 character like many languages, is that Vi has always used "\|"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7529 to separate commands. In many places it would not be clear if
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7530 "\|" is an operator or a command separator.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7531
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7532 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7533
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7534
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7535 pathshorten({path} [, {len}]) pathshorten()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7536 Shorten directory names in the path {path} and return the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7537 result. The tail, the file name, is kept as-is. The other
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7538 components in the path are reduced to {len} letters in length.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7539 If {len} is omitted or smaller than 1 then 1 is used (single
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7540 letters). Leading '~' and '.' characters are kept. Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7541 :echo pathshorten('~/.vim/autoload/myfile.vim')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7542 < ~/.v/a/myfile.vim ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7543 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7544 :echo pathshorten('~/.vim/autoload/myfile.vim', 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7545 < ~/.vi/au/myfile.vim ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7546 It doesn't matter if the path exists or not.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7547 Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7548
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7549 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7550 GetDirectories()->pathshorten()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7551 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7552 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7553
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7554
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7555 perleval({expr}) perleval()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7556 Evaluate Perl expression {expr} in scalar context and return
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7557 its result converted to Vim data structures. If value can't be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7558 converted, it is returned as a string Perl representation.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7559 Note: If you want an array or hash, {expr} must return a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7560 reference to it.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7561 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7562 :echo perleval('[1 .. 4]')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7563 < [1, 2, 3, 4]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7564
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7565 Note that in a `:def` function local variables are not visible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7566 to {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7567
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7568 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7569 GetExpr()->perleval()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7570 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7571 Return type: any, depending on {expr}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7572
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7573 {only available when compiled with the \|+perl\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7574
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7575
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7576 popup_ functions are documented here: \|popup-functions\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7577
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7578
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7579 pow({x}, {y}) pow()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7580 Return the power of {x} to the exponent {y} as a \|Float\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7581 {x} and {y} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7582 Returns 0.0 if {x} or {y} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7583 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7584 :echo pow(3, 3)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7585 < 27.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7586 :echo pow(2, 16)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7587 < 65536.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7588 :echo pow(32, 0.20)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7589 < 2.0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7590
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7591 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7592 Compute()->pow(3)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7593 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7594 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7595
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7596
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7597 prevnonblank({lnum}) prevnonblank()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7598 Return the line number of the first line at or above {lnum}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7599 that is not blank. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7600 let ind = indent(prevnonblank(v:lnum - 1))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7601 < When {lnum} is invalid or there is no non-blank line at or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7602 above it, zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7603 {lnum} is used like with \|getline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7604 Also see \|nextnonblank()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7605
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7606 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7607 GetLnum()->prevnonblank()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7608 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7609 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7610
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7611
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7612 printf({fmt}, {expr1} ...) printf()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7613 Return a String with {fmt}, where "%" items are replaced by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7614 the formatted form of their respective arguments. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7615 printf("%4d: E%d %.30s", lnum, errno, msg)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7616 < May result in:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7617 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7618
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7619 When used as a \|method\| the base is passed as the second
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7620 argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7621 Compute()->printf("result: %d")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7622 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7623 You can use `call()` to pass the items as a list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7624
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7625 Often used items are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7626 %s string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7627 %6S string right-aligned in 6 display cells
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7628 %6s string right-aligned in 6 bytes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7629 %.9s string truncated to 9 bytes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7630 %c single byte
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7631 %d decimal number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7632 %5d decimal number padded with spaces to 5 characters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7633 %x hex number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7634 %04x hex number padded with zeros to at least 4 characters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7635 %X hex number using upper case letters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7636 %o octal number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7637 %08b binary number padded with zeros to at least 8 chars
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7638 %f floating point number as 12.23, inf, -inf or nan
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7639 %F floating point number as 12.23, INF, -INF or NAN
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7640 %e floating point number as 1.23e3, inf, -inf or nan
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7641 %E floating point number as 1.23E3, INF, -INF or NAN
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7642 %g floating point number, as %f or %e depending on value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7643 %G floating point number, as %F or %E depending on value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7644 %% the % character itself
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7645
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7646 Conversion specifications start with '%' and end with the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7647 conversion type. All other characters are copied unchanged to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7648 the result.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7649
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7650 The "%" starts a conversion specification. The following
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7651 arguments appear in sequence:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7652
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7653 % [pos-argument] [flags] [field-width] [.precision] type
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7654
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7655 pos-argument
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7656 At most one positional argument specifier. These
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7657 take the form {n$}, where n is >= 1.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7658
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7659 flags
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7660 Zero or more of the following flags:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7661
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7662 # The value should be converted to an "alternate
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7663 form". For c, d, and s conversions, this option
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7664 has no effect. For o conversions, the precision
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7665 of the number is increased to force the first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7666 character of the output string to a zero (except
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7667 if a zero value is printed with an explicit
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7668 precision of zero).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7669 For b and B conversions, a non-zero result has
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7670 the string "0b" (or "0B" for B conversions)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7671 prepended to it.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7672 For x and X conversions, a non-zero result has
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7673 the string "0x" (or "0X" for X conversions)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7674 prepended to it.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7675
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7676 0 (zero) Zero padding. For all conversions the converted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7677 value is padded on the left with zeros rather
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7678 than blanks. If a precision is given with a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7679 numeric conversion (d, b, B, o, x, and X), the 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7680 flag is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7681
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7682 - A negative field width flag; the converted value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7683 is to be left adjusted on the field boundary.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7684 The converted value is padded on the right with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7685 blanks, rather than on the left with blanks or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7686 zeros. A - overrides a 0 if both are given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7687
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7688 ' ' (space) A blank should be left before a positive
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7689 number produced by a signed conversion (d).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7690
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7691 + A sign must always be placed before a number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7692 produced by a signed conversion. A + overrides
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7693 a space if both are used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7694
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7695 field-width
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7696 An optional decimal digit string specifying a minimum
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7697 field width. If the converted value has fewer bytes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7698 than the field width, it will be padded with spaces on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7699 the left (or right, if the left-adjustment flag has
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7700 been given) to fill out the field width. For the S
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7701 conversion the count is in cells.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7702
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7703 .precision
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7704 An optional precision, in the form of a period '.'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7705 followed by an optional digit string. If the digit
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7706 string is omitted, the precision is taken as zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7707 This gives the minimum number of digits to appear for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7708 d, o, x, and X conversions, the maximum number of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7709 bytes to be printed from a string for s conversions,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7710 or the maximum number of cells to be printed from a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7711 string for S conversions.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7712 For floating point it is the number of digits after
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7713 the decimal point.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7714
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7715 type
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7716 A character that specifies the type of conversion to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7717 be applied, see below.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7718
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7719 A field width or precision, or both, may be indicated by an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7720 asterisk '*' instead of a digit string. In this case, a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7721 Number argument supplies the field width or precision. A
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7722 negative field width is treated as a left adjustment flag
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7723 followed by a positive field width; a negative precision is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7724 treated as though it were missing. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7725 :echo printf("%d: %.*s", nr, width, line)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7726 < This limits the length of the text used from "line" to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7727 "width" bytes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7728
33945 27746ed6cb05 runtime(doc): grammar & typo fixes Christian Brabandt <cb@256bit.org> parents: 33931 diff changeset	7729 If the argument to be formatted is specified using a
27746ed6cb05 runtime(doc): grammar & typo fixes Christian Brabandt <cb@256bit.org> parents: 33931 diff changeset	7730 positional argument specifier, and a '*' is used to indicate
27746ed6cb05 runtime(doc): grammar & typo fixes Christian Brabandt <cb@256bit.org> parents: 33931 diff changeset	7731 that a number argument is to be used to specify the width or
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7732 precision, the argument(s) to be used must also be specified
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7733 using a {n$} positional argument specifier. See \|printf-$\|.
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7734
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7735 The conversion specifiers and their meanings are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7736
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7737 printf-d printf-b printf-B printf-o
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7738 printf-x printf-X
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7739 dbBoxX The Number argument is converted to signed decimal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7740 (d), unsigned binary (b and B), unsigned octal (o), or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7741 unsigned hexadecimal (x and X) notation. The letters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7742 "abcdef" are used for x conversions; the letters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7743 "ABCDEF" are used for X conversions.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7744 The precision, if any, gives the minimum number of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7745 digits that must appear; if the converted value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7746 requires fewer digits, it is padded on the left with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7747 zeros.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7748 In no case does a non-existent or small field width
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7749 cause truncation of a numeric field; if the result of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7750 a conversion is wider than the field width, the field
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7751 is expanded to contain the conversion result.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7752 The 'h' modifier indicates the argument is 16 bits.
33148 7bc10151ce81 patch 9.0.1856: issues with formatting positional arguments Christian Brabandt <cb@256bit.org> parents: 33146 diff changeset	7753 The 'l' modifier indicates the argument is a long
7bc10151ce81 patch 9.0.1856: issues with formatting positional arguments Christian Brabandt <cb@256bit.org> parents: 33146 diff changeset	7754 integer. The size will be 32 bits or 64 bits
7bc10151ce81 patch 9.0.1856: issues with formatting positional arguments Christian Brabandt <cb@256bit.org> parents: 33146 diff changeset	7755 depending on your platform.
7bc10151ce81 patch 9.0.1856: issues with formatting positional arguments Christian Brabandt <cb@256bit.org> parents: 33146 diff changeset	7756 The "ll" modifier indicates the argument is 64 bits.
7bc10151ce81 patch 9.0.1856: issues with formatting positional arguments Christian Brabandt <cb@256bit.org> parents: 33146 diff changeset	7757 The b and B conversion specifiers never take a width
7bc10151ce81 patch 9.0.1856: issues with formatting positional arguments Christian Brabandt <cb@256bit.org> parents: 33146 diff changeset	7758 modifier and always assume their argument is a 64 bit
7bc10151ce81 patch 9.0.1856: issues with formatting positional arguments Christian Brabandt <cb@256bit.org> parents: 33146 diff changeset	7759 integer.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7760 Generally, these modifiers are not useful. They are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7761 ignored when type is known from the argument.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7762
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7763 i alias for d
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7764 D alias for ld
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7765 U alias for lu
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7766 O alias for lo
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7767
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7768 printf-c
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7769 c The Number argument is converted to a byte, and the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7770 resulting character is written.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7771
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7772 printf-s
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7773 s The text of the String argument is used. If a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7774 precision is specified, no more bytes than the number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7775 specified are used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7776 If the argument is not a String type, it is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7777 automatically converted to text with the same format
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7778 as ":echo".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7779 printf-S
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7780 S The text of the String argument is used. If a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7781 precision is specified, no more display cells than the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7782 number specified are used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7783
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7784 printf-f E807
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7785 f F The Float argument is converted into a string of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7786 form 123.456. The precision specifies the number of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7787 digits after the decimal point. When the precision is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7788 zero the decimal point is omitted. When the precision
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7789 is not specified 6 is used. A really big number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7790 (out of range or dividing by zero) results in "inf"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7791 or "-inf" with %f (INF or -INF with %F).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7792 "0.0 / 0.0" results in "nan" with %f (NAN with %F).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7793 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7794 echo printf("%.2f", 12.115)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7795 < 12.12
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7796 Note that roundoff depends on the system libraries.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7797 Use \|round()\| when in doubt.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7798
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7799 printf-e printf-E
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7800 e E The Float argument is converted into a string of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7801 form 1.234e+03 or 1.234E+03 when using 'E'. The
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7802 precision specifies the number of digits after the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7803 decimal point, like with 'f'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7804
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7805 printf-g printf-G
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7806 g G The Float argument is converted like with 'f' if the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7807 value is between 0.001 (inclusive) and 10000000.0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7808 (exclusive). Otherwise 'e' is used for 'g' and 'E'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7809 for 'G'. When no precision is specified superfluous
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7810 zeroes and '+' signs are removed, except for the zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7811 immediately after the decimal point. Thus 10000000.0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7812 results in 1.0e7.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7813
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7814 printf-%
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7815 % A '%' is written. No argument is converted. The
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7816 complete conversion specification is "%%".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7817
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7818 When a Number argument is expected a String argument is also
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7819 accepted and automatically converted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7820 When a Float or String argument is expected a Number argument
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7821 is also accepted and automatically converted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7822 Any other argument type results in an error message.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7823
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7824 E766 E767
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7825 The number of {exprN} arguments must exactly match the number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7826 of "%" items. If there are not sufficient or too many
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7827 arguments an error is given. Up to 18 arguments can be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7828
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7829 printf-$
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7830 In certain languages, error and informative messages are
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7831 more readable when the order of words is different from the
33223 def9fc5c92d1 patch 9.0.1886: Various Typos Christian Brabandt <cb@256bit.org> parents: 33148 diff changeset	7832 corresponding message in English. To accommodate translations
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7833 having a different word order, positional arguments may be
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7834 used to indicate this. For instance: >
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7835
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7836 #, c-format
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7837 msgid "%s returning %s"
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7838 msgstr "waarde %2$s komt terug van %1$s"
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7839 <
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7840 In this example, the sentence has its 2 string arguments
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7841 reversed in the output. >
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7842
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7843 echo printf(
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7844 "In The Netherlands, vim's creator's name is: %1$s %2$s",
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7845 "Bram", "Moolenaar")
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7846 < In The Netherlands, vim's creator's name is: Bram Moolenaar >
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7847
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7848 echo printf(
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7849 "In Belgium, vim's creator's name is: %2$s %1$s",
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7850 "Bram", "Moolenaar")
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7851 < In Belgium, vim's creator's name is: Moolenaar Bram
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7852
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7853 Width (and precision) can be specified using the '*' specifier.
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7854 In this case, you must specify the field width position in the
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7855 argument list. >
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7856
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7857 echo printf("%1$2$.3$d", 1, 2, 3)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7858 < 001 >
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7859 echo printf("%2$3$.1$d", 1, 2, 3)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7860 < 2 >
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7861 echo printf("%3$1$.2$d", 1, 2, 3)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7862 < 03 >
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7863 echo printf("%1$2$.3$g", 1.4142, 2, 3)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7864 < 1.414
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7865
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7866 You can mix specifying the width and/or precision directly
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7867 and via positional arguments: >
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7868
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7869 echo printf("%1$4.*2$f", 1.4142135, 6)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7870 < 1.414214 >
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7871 echo printf("%1$*2$.4f", 1.4142135, 6)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7872 < 1.4142 >
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7873 echo printf("%1$2$.3$f", 1.4142135, 6, 2)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7874 < 1.41
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7875
34561 0adcad161c46 patch 9.1.0181: no overflow check for string formatting Christian Brabandt <cb@256bit.org> parents: 34548 diff changeset	7876 You will get an overflow error \|E1510\|, when the field-width
0adcad161c46 patch 9.1.0181: no overflow check for string formatting Christian Brabandt <cb@256bit.org> parents: 34548 diff changeset	7877 or precision will result in a string longer than 6400 chars.
0adcad161c46 patch 9.1.0181: no overflow check for string formatting Christian Brabandt <cb@256bit.org> parents: 34548 diff changeset	7878
33383 5c12ca4dcd45 patch 9.0.1950: Vim9: error codes spread out Christian Brabandt <cb@256bit.org> parents: 33334 diff changeset	7879 E1500
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7880 You cannot mix positional and non-positional arguments: >
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7881 echo printf("%s%1$s", "One", "Two")
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7882 < E1500: Cannot mix positional and non-positional arguments:
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7883 %s%1$s
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7884
33383 5c12ca4dcd45 patch 9.0.1950: Vim9: error codes spread out Christian Brabandt <cb@256bit.org> parents: 33334 diff changeset	7885 E1501
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7886 You cannot skip a positional argument in a format string: >
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7887 echo printf("%3$s%1$s", "One", "Two", "Three")
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7888 < E1501: format argument 2 unused in $-style format:
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7889 %3$s%1$s
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7890
33383 5c12ca4dcd45 patch 9.0.1950: Vim9: error codes spread out Christian Brabandt <cb@256bit.org> parents: 33334 diff changeset	7891 E1502
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7892 You can re-use a [field-width] (or [precision]) argument: >
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7893 echo printf("%1$d at width %2$d is: %01$*2$d", 1, 2)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7894 < 1 at width 2 is: 01
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7895
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7896 However, you can't use it as a different type: >
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7897 echo printf("%1$d at width %2$ld is: %01$*2$d", 1, 2)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7898 < E1502: Positional argument 2 used as field width reused as
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7899 different type: long int/int
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7900
33383 5c12ca4dcd45 patch 9.0.1950: Vim9: error codes spread out Christian Brabandt <cb@256bit.org> parents: 33334 diff changeset	7901 E1503
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7902 When a positional argument is used, but not the correct number
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7903 or arguments is given, an error is raised: >
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7904 echo printf("%1$d at width %2$d is: %01$2$.3$d", 1, 2)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7905 < E1503: Positional argument 3 out of bounds: %1$d at width
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7906 %2$d is: %01$2$.3$d
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7907
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7908 Only the first error is reported: >
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7909 echo printf("%01$2$.3$d %4$d", 1, 2)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7910 < E1503: Positional argument 3 out of bounds: %01$2$.3$d
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7911 %4$d
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7912
33383 5c12ca4dcd45 patch 9.0.1950: Vim9: error codes spread out Christian Brabandt <cb@256bit.org> parents: 33334 diff changeset	7913 E1504
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7914 A positional argument can be used more than once: >
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7915 echo printf("%1$s %2$s %1$s", "One", "Two")
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7916 < One Two One
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7917
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7918 However, you can't use a different type the second time: >
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7919 echo printf("%1$s %2$s %1$d", "One", "Two")
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7920 < E1504: Positional argument 1 type used inconsistently:
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7921 int/string
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7922
33383 5c12ca4dcd45 patch 9.0.1950: Vim9: error codes spread out Christian Brabandt <cb@256bit.org> parents: 33334 diff changeset	7923 E1505
32775 2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7924 Various other errors that lead to a format string being
2d5e8c46508b patch 9.0.1704: Cannot use positional arguments for printf() Christian Brabandt <cb@256bit.org> parents: 32738 diff changeset	7925 wrongly formatted lead to: >
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7926 echo printf("%1$d at width %2$d is: %01$*2$.3$d", 1, 2)
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7927 < E1505: Invalid format specifier: %1$d at width %2$d is:
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	7928 %01$*2$.3$d
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7929
33478 26a606faa9cb patch 9.0.1990: strange error number Christian Brabandt <cb@256bit.org> parents: 33436 diff changeset	7930 E1507
33493 6c369db2e3be runtime(doc): remove E1520 tag (#13289) Christian Brabandt <cb@256bit.org> parents: 33478 diff changeset	7931 This internal error indicates that the logic to parse a
6c369db2e3be runtime(doc): remove E1520 tag (#13289) Christian Brabandt <cb@256bit.org> parents: 33478 diff changeset	7932 positional format argument ran into a problem that couldn't be
6c369db2e3be runtime(doc): remove E1520 tag (#13289) Christian Brabandt <cb@256bit.org> parents: 33478 diff changeset	7933 otherwise reported. Please file a bug against Vim if you run
6c369db2e3be runtime(doc): remove E1520 tag (#13289) Christian Brabandt <cb@256bit.org> parents: 33478 diff changeset	7934 into this, copying the exact format string and parameters that
6c369db2e3be runtime(doc): remove E1520 tag (#13289) Christian Brabandt <cb@256bit.org> parents: 33478 diff changeset	7935 were used.
33478 26a606faa9cb patch 9.0.1990: strange error number Christian Brabandt <cb@256bit.org> parents: 33436 diff changeset	7936
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7937 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7938
33478 26a606faa9cb patch 9.0.1990: strange error number Christian Brabandt <cb@256bit.org> parents: 33436 diff changeset	7939
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7940 prompt_getprompt({buf}) prompt_getprompt()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7941 Returns the effective prompt text for buffer {buf}. {buf} can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7942 be a buffer name or number. See \|prompt-buffer\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7943
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7944 If the buffer doesn't exist or isn't a prompt buffer, an empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7945 string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7946
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7947 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7948 GetBuffer()->prompt_getprompt()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7949 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7950 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7951
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	7952 {only available when compiled with the \|+channel\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7953
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7954
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7955 prompt_setcallback({buf}, {expr}) prompt_setcallback()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7956 Set prompt callback for buffer {buf} to {expr}. When {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7957 is an empty string the callback is removed. This has only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7958 effect if {buf} has 'buftype' set to "prompt".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7959
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7960 The callback is invoked when pressing Enter. The current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7961 buffer will always be the prompt buffer. A new line for a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7962 prompt is added before invoking the callback, thus the prompt
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7963 for which the callback was invoked will be in the last but one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7964 line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7965 If the callback wants to add text to the buffer, it must
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7966 insert it above the last line, since that is where the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7967 prompt is. This can also be done asynchronously.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7968 The callback is invoked with one argument, which is the text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7969 that was entered at the prompt. This can be an empty string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7970 if the user only typed Enter.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7971 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7972 func s:TextEntered(text)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7973 if a:text == 'exit' \|\| a:text == 'quit'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7974 stopinsert
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7975 " Reset 'modified' to allow the buffer to be closed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7976 " We assume there is nothing useful to be saved.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7977 set nomodified
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7978 close
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7979 else
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7980 " Do something useful with "a:text". In this example
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7981 " we just repeat it.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7982 call append(line('$') - 1, 'Entered: "' .. a:text .. '"')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7983 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7984 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7985 call prompt_setcallback(bufnr(), function('s:TextEntered'))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7986
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7987 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7988 GetBuffer()->prompt_setcallback(callback)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7989
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7990 < {only available when compiled with the \|+channel\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7991
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7992 prompt_setinterrupt({buf}, {expr}) prompt_setinterrupt()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7993 Set a callback for buffer {buf} to {expr}. When {expr} is an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7994 empty string the callback is removed. This has only effect if
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7995 {buf} has 'buftype' set to "prompt".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7996
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7997 This callback will be invoked when pressing CTRL-C in Insert
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7998 mode. Without setting a callback Vim will exit Insert mode,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	7999 as in any buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8000
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8001 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8002 GetBuffer()->prompt_setinterrupt(callback)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8003 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8004 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8005
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8006 {only available when compiled with the \|+channel\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8007
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8008 prompt_setprompt({buf}, {text}) prompt_setprompt()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8009 Set prompt for buffer {buf} to {text}. You most likely want
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8010 {text} to end in a space.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8011 The result is only visible if {buf} has 'buftype' set to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8012 "prompt". Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8013 call prompt_setprompt(bufnr(), 'command: ')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8014 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8015 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8016 GetBuffer()->prompt_setprompt('command: ')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8017 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8018 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8019
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8020 {only available when compiled with the \|+channel\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8021
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8022 prop_ functions are documented here: \|text-prop-functions\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8023
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8024 pum_getpos() pum_getpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8025 If the popup menu (see \|ins-completion-menu\|) is not visible,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8026 returns an empty \|Dictionary\|, otherwise, returns a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8027 \|Dictionary\| with the following keys:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8028 height nr of items visible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8029 width screen cells
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8030 row top screen row (0 first row)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8031 col leftmost screen column (0 first col)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8032 size total nr of items
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8033 scrollbar \|TRUE\| if scrollbar is visible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8034
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8035 The values are the same as in \|v:event\| during
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8036 \|CompleteChanged\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8037
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8038 Return type: dict<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8039
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8040
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8041 pumvisible() pumvisible()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8042 Returns non-zero when the popup menu is visible, zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8043 otherwise. See \|ins-completion-menu\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8044 This can be used to avoid some things that would remove the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8045 popup menu.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8046
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8047 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8048
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8049
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8050 py3eval({expr}) py3eval()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8051 Evaluate Python expression {expr} and return its result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8052 converted to Vim data structures.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8053 Numbers and strings are returned as they are (strings are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8054 copied though, Unicode strings are additionally converted to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8055 'encoding').
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8056 Lists are represented as Vim \|List\| type.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8057 Dictionaries are represented as Vim \|Dictionary\| type with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8058 keys converted to strings.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8059 Note that in a `:def` function local variables are not visible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8060 to {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8061
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8062 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8063 GetExpr()->py3eval()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8064 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8065 Return type: any, depending on {expr}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8066
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8067 {only available when compiled with the \|+python3\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8068
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8069 E858 E859
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8070 pyeval({expr}) pyeval()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8071 Evaluate Python expression {expr} and return its result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8072 converted to Vim data structures.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8073 Numbers and strings are returned as they are (strings are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8074 copied though).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8075 Lists are represented as Vim \|List\| type.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8076 Dictionaries are represented as Vim \|Dictionary\| type,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8077 non-string keys result in error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8078 Note that in a `:def` function local variables are not visible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8079 to {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8080
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8081 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8082 GetExpr()->pyeval()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8083 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8084 Return type: any, depending on {expr}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8085
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8086 {only available when compiled with the \|+python\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8087
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8088 pyxeval({expr}) pyxeval()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8089 Evaluate Python expression {expr} and return its result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8090 converted to Vim data structures.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8091 Uses Python 2 or 3, see \|python_x\| and 'pyxversion'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8092 See also: \|pyeval()\|, \|py3eval()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8093
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8094 Can also be used as a \|method\|: >
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8095 < GetExpr()->pyxeval()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8096 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8097 Return type: any, depending on {expr}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8098
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8099 {only available when compiled with the \|+python\| or the
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8100 \|+python3\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8101
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8102 rand([{expr}]) rand() random
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8103 Return a pseudo-random Number generated with an xoshiro128**
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8104 algorithm using seed {expr}. The returned number is 32 bits,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8105 also on 64 bits systems, for consistency.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8106 {expr} can be initialized by \|srand()\| and will be updated by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8107 rand(). If {expr} is omitted, an internal seed value is used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8108 and updated.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8109 Returns -1 if {expr} is invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8110
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8111 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8112 :echo rand()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8113 :let seed = srand()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8114 :echo rand(seed)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8115 :echo rand(seed) % 16 " random number 0 - 15
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8116 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8117 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8118
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8119 E726 E727
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8120 range({expr} [, {max} [, {stride}]]) range()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8121 Returns a \|List\| with Numbers:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8122 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8123 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8124 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8125 {max}] (increasing {expr} with {stride} each time, not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8126 producing a value past {max}).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8127 When the maximum is one before the start the result is an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8128 empty list. When the maximum is more than one before the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8129 start this is an error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8130 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8131 range(4) " [0, 1, 2, 3]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8132 range(2, 4) " [2, 3, 4]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8133 range(2, 9, 3) " [2, 5, 8]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8134 range(2, -2, -1) " [2, 1, 0, -1, -2]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8135 range(0) " []
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8136 range(2, 0) " error!
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8137 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8138 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8139 GetExpr()->range()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8140 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8141 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8142
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8143
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8144 readblob({fname} [, {offset} [, {size}]]) readblob()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8145 Read file {fname} in binary mode and return a \|Blob\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8146 If {offset} is specified, read the file from the specified
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8147 offset. If it is a negative value, it is used as an offset
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8148 from the end of the file. E.g., to read the last 12 bytes: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8149 readblob('file.bin', -12)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8150 < If {size} is specified, only the specified size will be read.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8151 E.g. to read the first 100 bytes of a file: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8152 readblob('file.bin', 0, 100)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8153 < If {size} is -1 or omitted, the whole data starting from
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8154 {offset} will be read.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8155 This can be also used to read the data from a character device
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8156 on Unix when {size} is explicitly set. Only if the device
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8157 supports seeking {offset} can be used. Otherwise it should be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8158 zero. E.g. to read 10 bytes from a serial console: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8159 readblob('/dev/ttyS0', 0, 10)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8160 < When the file can't be opened an error message is given and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8161 the result is an empty \|Blob\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8162 When the offset is beyond the end of the file the result is an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8163 empty blob.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8164 When trying to read more bytes than are available the result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8165 is truncated.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8166 Also see \|readfile()\| and \|writefile()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8167
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8168 Return type: \|Blob\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8169
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8170
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8171 readdir({directory} [, {expr} [, {dict}]]) readdir()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8172 Return a list with file and directory names in {directory}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8173 You can also use \|glob()\| if you don't need to do complicated
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8174 things, such as limiting the number of matches.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8175 The list will be sorted (case sensitive), see the {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8176 argument below for changing the sort order.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8177
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8178 When {expr} is omitted all entries are included.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8179 When {expr} is given, it is evaluated to check what to do:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8180 If {expr} results in -1 then no further entries will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8181 be handled.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8182 If {expr} results in 0 then this entry will not be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8183 added to the list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8184 If {expr} results in 1 then this entry will be added
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8185 to the list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8186 The entries "." and ".." are always excluded.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8187 Each time {expr} is evaluated \|v:val\| is set to the entry name.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8188 When {expr} is a function the name is passed as the argument.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8189 For example, to get a list of files ending in ".txt": >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8190 readdir(dirname, {n -> n =~ '.txt$'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8191 < To skip hidden and backup files: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8192 readdir(dirname, {n -> n !~ '^\.\\|\~$'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8193 < E857
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8194 The optional {dict} argument allows for further custom
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8195 values. Currently this is used to specify if and how sorting
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8196 should be performed. The dict can have the following members:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8197
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8198 sort How to sort the result returned from the system.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8199 Valid values are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8200 "none" do not sort (fastest method)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8201 "case" sort case sensitive (byte value of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8202 each character, technically, using
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8203 strcmp()) (default)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8204 "icase" sort case insensitive (technically
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8205 using strcasecmp())
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8206 "collate" sort using the collation order
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8207 of the "POSIX" or "C" \|locale\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8208 (technically using strcoll())
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8209 Other values are silently ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8210
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8211 For example, to get a list of all files in the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8212 directory without sorting the individual entries: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8213 readdir('.', '1', #{sort: 'none'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8214 < If you want to get a directory tree: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8215 function! s:tree(dir)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8216 return {a:dir : map(readdir(a:dir),
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8217 \ {_, x -> isdirectory(x) ?
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8218 \ {x : s:tree(a:dir .. '/' .. x)} : x})}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8219 endfunction
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8220 echo s:tree(".")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8221 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8222 Returns an empty List on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8223
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8224 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8225 GetDirName()->readdir()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8226 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8227 Return type: list<string> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8228
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8229
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8230 readdirex({directory} [, {expr} [, {dict}]]) readdirex()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8231 Extended version of \|readdir()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8232 Return a list of Dictionaries with file and directory
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8233 information in {directory}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8234 This is useful if you want to get the attributes of file and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8235 directory at the same time as getting a list of a directory.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8236 This is much faster than calling \|readdir()\| then calling
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8237 \|getfperm()\|, \|getfsize()\|, \|getftime()\| and \|getftype()\| for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8238 each file and directory especially on MS-Windows.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8239 The list will by default be sorted by name (case sensitive),
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8240 the sorting can be changed by using the optional {dict}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8241 argument, see \|readdir()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8242
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8243 The Dictionary for file and directory information has the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8244 following items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8245 group Group name of the entry. (Only on Unix)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8246 name Name of the entry.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8247 perm Permissions of the entry. See \|getfperm()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8248 size Size of the entry. See \|getfsize()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8249 time Timestamp of the entry. See \|getftime()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8250 type Type of the entry.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8251 On Unix, almost same as \|getftype()\| except:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8252 Symlink to a dir "linkd"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8253 Other symlink "link"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8254 On MS-Windows:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8255 Normal file "file"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8256 Directory "dir"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8257 Junction "junction"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8258 Symlink to a dir "linkd"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8259 Other symlink "link"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8260 Other reparse point "reparse"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8261 user User name of the entry's owner. (Only on Unix)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8262 On Unix, if the entry is a symlink, the Dictionary includes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8263 the information of the target (except the "type" item).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8264 On MS-Windows, it includes the information of the symlink
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8265 itself because of performance reasons.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8266
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8267 When {expr} is omitted all entries are included.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8268 When {expr} is given, it is evaluated to check what to do:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8269 If {expr} results in -1 then no further entries will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8270 be handled.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8271 If {expr} results in 0 then this entry will not be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8272 added to the list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8273 If {expr} results in 1 then this entry will be added
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8274 to the list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8275 The entries "." and ".." are always excluded.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8276 Each time {expr} is evaluated \|v:val\| is set to a \|Dictionary\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8277 of the entry.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8278 When {expr} is a function the entry is passed as the argument.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8279 For example, to get a list of files ending in ".txt": >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8280 readdirex(dirname, {e -> e.name =~ '.txt$'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8281 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8282 For example, to get a list of all files in the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8283 directory without sorting the individual entries: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8284 readdirex(dirname, '1', #{sort: 'none'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8285 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8286 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8287 GetDirName()->readdirex()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8288 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8289 Return type: list<dict<any>> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8290
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8291
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8292 readfile()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8293 readfile({fname} [, {type} [, {max}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8294 Read file {fname} and return a \|List\|, each line of the file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8295 as an item. Lines are broken at NL characters. Macintosh
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8296 files separated with CR will result in a single long line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8297 (unless a NL appears somewhere).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8298 All NUL characters are replaced with a NL character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8299 When {type} contains "b" binary mode is used:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8300 - When the last line ends in a NL an extra empty list item is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8301 added.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8302 - No CR characters are removed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8303 Otherwise:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8304 - CR characters that appear before a NL are removed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8305 - Whether the last line ends in a NL or not does not matter.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8306 - When 'encoding' is Unicode any UTF-8 byte order mark is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8307 removed from the text.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8308 When {max} is given this specifies the maximum number of lines
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8309 to be read. Useful if you only want to check the first ten
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8310 lines of a file: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8311 :for line in readfile(fname, '', 10)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8312 : if line =~ 'Date' \| echo line \| endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8313 :endfor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8314 < When {max} is negative -{max} lines from the end of the file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8315 are returned, or as many as there are.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8316 When {max} is zero the result is an empty list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8317 Note that without {max} the whole file is read into memory.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8318 Also note that there is no recognition of encoding. Read a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8319 file into a buffer if you need to.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8320 Deprecated (use \|readblob()\| instead): When {type} contains
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8321 "B" a \|Blob\| is returned with the binary data of the file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8322 unmodified.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8323 When the file can't be opened an error message is given and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8324 the result is an empty list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8325 Also see \|writefile()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8326
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8327 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8328 GetFileName()->readfile()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8329 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8330 Return type: list<string> or list<any>
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8331
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8332 reduce({object}, {func} [, {initial}]) reduce() E998
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8333 {func} is called for every item in {object}, which can be a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8334 \|String\|, \|List\| or a \|Blob\|. {func} is called with two
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8335 arguments: the result so far and current item. After
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8336 processing all items the result is returned. E1132
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8337
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8338 {initial} is the initial result. When omitted, the first item
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8339 in {object} is used and {func} is first called for the second
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8340 item. If {initial} is not given and {object} is empty no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8341 result can be computed, an E998 error is given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8342
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8343 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8344 echo reduce([1, 3, 5], { acc, val -> acc + val })
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8345 echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8346 echo reduce(0z1122, { acc, val -> 2 * acc + val })
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8347 echo reduce('xyz', { acc, val -> acc .. ',' .. val })
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8348 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8349 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8350 echo mylist->reduce({ acc, val -> acc + val }, 0)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8351 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8352 Return type: \|String\|, \|Blob\|, list<{type}> or dict<{type}>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8353 depending on {object} and {func}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8354
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8355
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8356 reg_executing() reg_executing()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8357 Returns the single letter name of the register being executed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8358 Returns an empty string when no register is being executed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8359 See \|@\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8360
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8361 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8362
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8363
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8364 reg_recording() reg_recording()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8365 Returns the single letter name of the register being recorded.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8366 Returns an empty string when not recording. See \|q\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8367
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8368 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8369
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8370
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8371 reltime() reltime()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8372 reltime({start})
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8373 reltime({start}, {end})
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8374 Return an item that represents a time value. The item is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8375 list with items that depend on the system. In Vim 9 script
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8376 the type list<any> can be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8377 The item can be passed to \|reltimestr()\| to convert it to a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8378 string or \|reltimefloat()\| to convert to a Float. For
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8379 example, to see the time spent in function Work(): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8380 var startTime = reltime()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8381 Work()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8382 echo startTime->reltime()->reltimestr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8383 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8384 Without an argument reltime() returns the current time (the
34087 630e70746a1f runtime(doc): Fix typos in reltime() help. (#13818) Christian Brabandt <cb@256bit.org> parents: 34082 diff changeset	8385 representation is system-dependent, it cannot be used as the
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8386 wall-clock time, see \|localtime()\| for that).
34087 630e70746a1f runtime(doc): Fix typos in reltime() help. (#13818) Christian Brabandt <cb@256bit.org> parents: 34082 diff changeset	8387 With one argument it returns the time passed since the time
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8388 specified in the argument.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8389 With two arguments it returns the time passed between {start}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8390 and {end}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8391
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8392 The {start} and {end} arguments must be values returned by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8393 reltime(). If there is an error an empty List is returned in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8394 legacy script, in Vim9 script an error is given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8395
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8396 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8397 GetStart()->reltime()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8398 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8399 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8400
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8401 {only available when compiled with the \|+reltime\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8402
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8403
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8404 reltimefloat({time}) reltimefloat()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8405 Return a Float that represents the time value of {time}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8406 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8407 let start = reltime()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8408 call MyFunction()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8409 let seconds = reltimefloat(reltime(start))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8410 < See the note of reltimestr() about overhead.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8411 Also see \|profiling\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8412 If there is an error 0.0 is returned in legacy script, in Vim9
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8413 script an error is given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8414
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8415 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8416 reltime(start)->reltimefloat()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8417 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8418 Return type: \|Float\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8419
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8420 {only available when compiled with the \|+reltime\| feature}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8421
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8422
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8423 reltimestr({time}) reltimestr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8424 Return a String that represents the time value of {time}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8425 This is the number of seconds, a dot and the number of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8426 microseconds. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8427 let start = reltime()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8428 call MyFunction()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8429 echo reltimestr(reltime(start))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8430 < Note that overhead for the commands will be added to the time.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8431 The accuracy depends on the system. Use reltimefloat() for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8432 greatest accuracy which is nanoseconds on some systems.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8433 Leading spaces are used to make the string align nicely. You
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8434 can use split() to remove it. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8435 echo split(reltimestr(reltime(start)))[0]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8436 < Also see \|profiling\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8437 If there is an error an empty string is returned in legacy
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8438 script, in Vim9 script an error is given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8439
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8440 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8441 reltime(start)->reltimestr()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8442 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8443 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8444
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8445 {only available when compiled with the \|+reltime\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8446
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8447 remote_expr() E449
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8448 remote_expr({server}, {string} [, {idvar} [, {timeout}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8449 Send the {string} to {server}. The {server} argument is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8450 string, also see \|{server}\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8451
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8452 The string is sent as an expression and the result is returned
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8453 after evaluation. The result must be a String or a \|List\|. A
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8454 \|List\| is turned into a String by joining the items with a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8455 line break in between (not at the end), like with join(expr,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8456 "\n").
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8457
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8458 If {idvar} is present and not empty, it is taken as the name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8459 of a variable and a {serverid} for later use with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8460 \|remote_read()\| is stored there.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8461
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8462 If {timeout} is given the read times out after this many
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8463 seconds. Otherwise a timeout of 600 seconds is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8464
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8465 See also \|clientserver\| \|RemoteReply\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8466 This function is not available in the \|sandbox\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8467 {only available when compiled with the \|+clientserver\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8468 Note: Any errors will cause a local error message to be issued
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8469 and the result will be the empty string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8470
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8471 Variables will be evaluated in the global namespace,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8472 independent of a function currently being active. Except
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8473 when in debug mode, then local function variables and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8474 arguments can be evaluated.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8475
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8476 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8477 :echo remote_expr("gvim", "2+2")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8478 :echo remote_expr("gvim1", "b:current_syntax")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8479 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8480 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8481 ServerName()->remote_expr(expr)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8482 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8483 Return type: \|String\| or list<{type}>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8484
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8485
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8486 remote_foreground({server}) remote_foreground()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8487 Move the Vim server with the name {server} to the foreground.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8488 The {server} argument is a string, also see \|{server}\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8489 This works like: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8490 remote_expr({server}, "foreground()")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8491 < Except that on Win32 systems the client does the work, to work
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8492 around the problem that the OS doesn't always allow the server
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8493 to bring itself to the foreground.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8494 Note: This does not restore the window if it was minimized,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8495 like foreground() does.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8496 This function is not available in the \|sandbox\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8497
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8498 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8499 ServerName()->remote_foreground()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8500 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8501 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8502
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8503 {only in the Win32, Motif and GTK GUI versions and the
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8504 Win32 console version}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8505
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8506
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8507 remote_peek({serverid} [, {retvar}]) remote_peek()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8508 Returns a positive number if there are available strings
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8509 from {serverid}. Copies any reply string into the variable
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8510 {retvar} if specified. {retvar} must be a string with the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8511 name of a variable.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8512 Returns zero if none are available.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8513 Returns -1 if something is wrong.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8514 See also \|clientserver\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8515 This function is not available in the \|sandbox\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8516 {only available when compiled with the \|+clientserver\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8517 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8518 :let repl = ""
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8519 :echo "PEEK: " .. remote_peek(id, "repl") .. ": " .. repl
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8520
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8521 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8522 ServerId()->remote_peek()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8523 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8524 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8525
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8526
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8527 remote_read({serverid}, [{timeout}]) remote_read()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8528 Return the oldest available reply from {serverid} and consume
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8529 it. Unless a {timeout} in seconds is given, it blocks until a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8530 reply is available. Returns an empty string, if a reply is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8531 not available or on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8532 See also \|clientserver\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8533 This function is not available in the \|sandbox\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8534 {only available when compiled with the \|+clientserver\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8535 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8536 :echo remote_read(id)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8537
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8538 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8539 ServerId()->remote_read()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8540 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8541 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8542
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8543
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8544 remote_send({server}, {string} [, {idvar}]) remote_send() E241
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8545 Send the {string} to {server}. The {server} argument is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8546 string, also see \|{server}\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8547
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8548 The string is sent as input keys and the function returns
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8549 immediately. At the Vim server the keys are not mapped
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8550 \|:map\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8551
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8552 If {idvar} is present, it is taken as the name of a variable
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8553 and a {serverid} for later use with remote_read() is stored
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8554 there.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8555
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8556 See also \|clientserver\| \|RemoteReply\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8557 This function is not available in the \|sandbox\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8558 {only available when compiled with the \|+clientserver\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8559
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8560 Note: Any errors will be reported in the server and may mess
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8561 up the display.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8562 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8563 :echo remote_send("gvim", ":DropAndReply " .. file, "serverid") ..
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8564 \ remote_read(serverid)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8565
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8566 :autocmd NONE RemoteReply *
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8567 \ echo remote_read(expand("<amatch>"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8568 :echo remote_send("gvim", ":sleep 10 \| echo " ..
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8569 \ 'server2client(expand("<client>"), "HELLO")<CR>')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8570 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8571 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8572 ServerName()->remote_send(keys)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8573 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8574 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8575
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8576
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8577 remote_startserver({name}) remote_startserver() E941 E942
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8578 Become the server {name}. {name} must be a non-empty string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8579 This fails if already running as a server, when \|v:servername\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8580 is not empty.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8581
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8582 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8583 ServerName()->remote_startserver()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8584 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8585 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8586
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8587 {only available when compiled with the \|+clientserver\| feature}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8588
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8589
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8590 remove({list}, {idx}) remove()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8591 remove({list}, {idx}, {end})
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8592 Without {end}: Remove the item at {idx} from \|List\| {list} and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8593 return the item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8594 With {end}: Remove items from {idx} to {end} (inclusive) and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8595 return a \|List\| with these items. When {idx} points to the same
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8596 item as {end} a list with one item is returned. When {end}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8597 points to an item before {idx} this is an error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8598 See \|list-index\| for possible values of {idx} and {end}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8599 Returns zero on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8600 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8601 :echo "last item: " .. remove(mylist, -1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8602 :call remove(mylist, 0, 9)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8603 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8604 Use \|delete()\| to remove a file.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8605
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8606 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8607 mylist->remove(idx)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8608 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8609 Return type: any, depending on {list}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8610
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8611
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8612 remove({blob}, {idx})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8613 remove({blob}, {idx}, {end})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8614 Without {end}: Remove the byte at {idx} from \|Blob\| {blob} and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8615 return the byte.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8616 With {end}: Remove bytes from {idx} to {end} (inclusive) and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8617 return a \|Blob\| with these bytes. When {idx} points to the same
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8618 byte as {end} a \|Blob\| with one byte is returned. When {end}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8619 points to a byte before {idx} this is an error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8620 Returns zero on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8621 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8622 :echo "last byte: " .. remove(myblob, -1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8623 :call remove(mylist, 0, 9)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8624 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8625 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8626
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8627 remove({dict}, {key})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8628 Remove the entry from {dict} with key {key} and return it.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8629 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8630 :echo "removed " .. remove(dict, "one")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8631 < If there is no {key} in {dict} this is an error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8632 Returns zero on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8633
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8634 Return type: any, depending on {dict}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8635
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8636
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8637 rename({from}, {to}) rename()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8638 Rename the file by the name {from} to the name {to}. This
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8639 should also work to move files across file systems. The
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8640 result is a Number, which is 0 if the file was renamed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8641 successfully, and non-zero when the renaming failed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8642 NOTE: If {to} exists it is overwritten without warning.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8643 This function is not available in the \|sandbox\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8644
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8645 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8646 GetOldName()->rename(newname)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8647 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8648 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8649
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8650
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8651 repeat({expr}, {count}) repeat()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8652 Repeat {expr} {count} times and return the concatenated
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8653 result. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8654 :let separator = repeat('-', 80)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8655 < When {count} is zero or negative the result is empty.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8656 When {expr} is a \|List\| or a \|Blob\| the result is {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8657 concatenated {count} times. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8658 :let longlist = repeat(['a', 'b'], 3)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8659 < Results in ['a', 'b', 'a', 'b', 'a', 'b'].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8660
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8661 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8662 mylist->repeat(count)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8663 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8664 Return type: \|String\|, \|Blob\| or list<{type}> depending on
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8665 {expr}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8666
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8667
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8668 resolve({filename}) resolve() E655
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8669 On MS-Windows, when {filename} is a shortcut (a .lnk file),
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8670 returns the path the shortcut points to in a simplified form.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8671 When {filename} is a symbolic link or junction point, return
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8672 the full path to the target. If the target of junction is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8673 removed, return {filename}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8674 On Unix, repeat resolving symbolic links in all path
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8675 components of {filename} and return the simplified result.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8676 To cope with link cycles, resolving of symbolic links is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8677 stopped after 100 iterations.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8678 On other systems, return the simplified {filename}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8679 The simplification step is done as by \|simplify()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8680 resolve() keeps a leading path component specifying the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8681 current directory (provided the result is still a relative
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8682 path name) and also keeps a trailing path separator.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8683
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8684 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8685 GetName()->resolve()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8686 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8687 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8688
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8689
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8690 reverse({object}) reverse()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8691 Reverse the order of items in {object}. {object} can be a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8692 \|List\|, a \|Blob\| or a \|String\|. For a List and a Blob the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8693 items are reversed in-place and {object} is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8694 For a String a new String is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8695 Returns zero if {object} is not a List, Blob or a String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8696 If you want a List or Blob to remain unmodified make a copy
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8697 first: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8698 :let revlist = reverse(copy(mylist))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8699 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8700 mylist->reverse()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8701 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8702 Return type: \|String\|, \|Blob\| or list<{type}> depending on
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8703 {object}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8704
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8705
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8706 round({expr}) round()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8707 Round off {expr} to the nearest integral value and return it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8708 as a \|Float\|. If {expr} lies halfway between two integral
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8709 values, then use the larger one (away from zero).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8710 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8711 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8712 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8713 echo round(0.456)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8714 < 0.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8715 echo round(4.5)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8716 < 5.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8717 echo round(-4.5)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8718 < -5.0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8719
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8720 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8721 Compute()->round()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8722 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8723 Return type: \|Float\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8724
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8725
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8726 rubyeval({expr}) rubyeval()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8727 Evaluate Ruby expression {expr} and return its result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8728 converted to Vim data structures.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8729 Numbers, floats and strings are returned as they are (strings
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8730 are copied though).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8731 Arrays are represented as Vim \|List\| type.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8732 Hashes are represented as Vim \|Dictionary\| type.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8733 Other objects are represented as strings resulted from their
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8734 "Object#to_s" method.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8735 Note that in a `:def` function local variables are not visible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8736 to {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8737
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8738 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8739 GetRubyExpr()->rubyeval()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8740 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8741 Return type: any, depending on {expr}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8742
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8743 {only available when compiled with the \|+ruby\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8744
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8745 screenattr({row}, {col}) screenattr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8746 Like \|screenchar()\|, but return the attribute. This is a rather
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8747 arbitrary number that can only be used to compare to the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8748 attribute at other positions.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8749 Returns -1 when row or col is out of range.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8750
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8751 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8752 GetRow()->screenattr(col)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8753 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8754 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8755
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8756
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8757 screenchar({row}, {col}) screenchar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8758 The result is a Number, which is the character at position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8759 [row, col] on the screen. This works for every possible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8760 screen position, also status lines, window separators and the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8761 command line. The top left position is row one, column one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8762 The character excludes composing characters. For double-byte
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8763 encodings it may only be the first byte.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8764 This is mainly to be used for testing.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8765 Returns -1 when row or col is out of range.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8766
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8767 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8768 GetRow()->screenchar(col)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8769 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8770 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8771
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8772
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8773 screenchars({row}, {col}) screenchars()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8774 The result is a \|List\| of Numbers. The first number is the same
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8775 as what \|screenchar()\| returns. Further numbers are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8776 composing characters on top of the base character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8777 This is mainly to be used for testing.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8778 Returns an empty List when row or col is out of range.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8779
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8780 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8781 GetRow()->screenchars(col)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8782 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8783 Return type: list<number> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8784
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8785
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8786 screencol() screencol()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8787 The result is a Number, which is the current screen column of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8788 the cursor. The leftmost column has number 1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8789 This function is mainly used for testing.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8790
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8791 Note: Always returns the current screen column, thus if used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8792 in a command (e.g. ":echo screencol()") it will return the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8793 column inside the command line, which is 1 when the command is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8794 executed. To get the cursor position in the file use one of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8795 the following mappings: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8796 nnoremap <expr> GG ":echom " .. screencol() .. "\n"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8797 nnoremap <silent> GG :echom screencol()<CR>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8798 nnoremap GG <Cmd>echom screencol()<CR>
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8799 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8800 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8801
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8802
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8803 screenpos({winid}, {lnum}, {col}) screenpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8804 The result is a Dict with the screen position of the text
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8805 character in window {winid} at buffer line {lnum} and column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8806 {col}. {col} is a one-based byte index.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8807 The Dict has these members:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8808 row screen row
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8809 col first screen column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8810 endcol last screen column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8811 curscol cursor screen column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8812 If the specified position is not visible, all values are zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8813 The "endcol" value differs from "col" when the character
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8814 occupies more than one screen cell. E.g. for a Tab "col" can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8815 be 1 and "endcol" can be 8.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8816 The "curscol" value is where the cursor would be placed. For
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8817 a Tab it would be the same as "endcol", while for a double
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8818 width character it would be the same as "col".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8819 The \|conceal\| feature is ignored here, the column numbers are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8820 as if 'conceallevel' is zero. You can set the cursor to the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8821 right position and use \|screencol()\| to get the value with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8822 \|conceal\| taken into account.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8823 If the position is in a closed fold the screen position of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8824 first character is returned, {col} is not used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8825 Returns an empty Dict if {winid} is invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8826
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8827 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8828 GetWinid()->screenpos(lnum, col)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8829 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8830 Return type: dict<number> or dict<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8831
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8832
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8833 screenrow() screenrow()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8834 The result is a Number, which is the current screen row of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8835 cursor. The top line has number one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8836 This function is mainly used for testing.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8837 Alternatively you can use \|winline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8838
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8839 Note: Same restrictions as with \|screencol()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8840
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8841 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8842
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8843
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8844 screenstring({row}, {col}) screenstring()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8845 The result is a String that contains the base character and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8846 any composing characters at position [row, col] on the screen.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8847 This is like \|screenchars()\| but returning a String with the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8848 characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8849 This is mainly to be used for testing.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8850 Returns an empty String when row or col is out of range.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8851
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8852 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8853 GetRow()->screenstring(col)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8854 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8855 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8856
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8857 search()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8858 search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8859 Search for regexp pattern {pattern}. The search starts at the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8860 cursor position (you can use \|cursor()\| to set it).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8861
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8862 When a match has been found its line number is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8863 If there is no match a 0 is returned and the cursor doesn't
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8864 move. No error message is given.
34542 cf167a352bea runtime(doc): add reference to matchbufline() at :h search() Christian Brabandt <cb@256bit.org> parents: 34536 diff changeset	8865 To get the matched string, use \|matchbufline()\|.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8866
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8867 {flags} is a String, which can contain these character flags:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8868 'b' search Backward instead of forward
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8869 'c' accept a match at the Cursor position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8870 'e' move to the End of the match
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8871 'n' do Not move the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8872 'p' return number of matching sub-Pattern (see below)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8873 's' Set the ' mark at the previous location of the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8874 'w' Wrap around the end of the file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8875 'W' don't Wrap around the end of the file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8876 'z' start searching at the cursor column instead of zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8877 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8878
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8879 If the 's' flag is supplied, the ' mark is set, only if the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8880 cursor is moved. The 's' flag cannot be combined with the 'n'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8881 flag.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8882
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8883 'ignorecase', 'smartcase' and 'magic' are used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8884
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8885 When the 'z' flag is not given, forward searching always
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8886 starts in column zero and then matches before the cursor are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8887 skipped. When the 'c' flag is present in 'cpo' the next
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8888 search starts after the match. Without the 'c' flag the next
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8889 search starts one column after the start of the match. This
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8890 matters for overlapping matches. See \|cpo-c\|. You can also
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8891 insert "\ze" to change where the match ends, see \|/\ze\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8892
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8893 When searching backwards and the 'z' flag is given then the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8894 search starts in column zero, thus no match in the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8895 line will be found (unless wrapping around the end of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8896 file).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8897
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8898 When the {stopline} argument is given then the search stops
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8899 after searching this line. This is useful to restrict the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8900 search to a range of lines. Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8901 let match = search('(', 'b', line("w0"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8902 let end = search('END', '', line("w$"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8903 < When {stopline} is used and it is not zero this also implies
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8904 that the search does not wrap around the end of the file.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8905 A zero value is equal to not giving the argument.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8906 E1285 E1286 E1287 E1288 E1289
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8907 When the {timeout} argument is given the search stops when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8908 more than this many milliseconds have passed. Thus when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8909 {timeout} is 500 the search stops after half a second.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8910 The value must not be negative. A zero value is like not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8911 giving the argument.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8912 {only available when compiled with the \|+reltime\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8913
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8914 If the {skip} expression is given it is evaluated with the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8915 cursor positioned on the start of a match. If it evaluates to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8916 non-zero this match is skipped. This can be used, for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8917 example, to skip a match in a comment or a string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8918 {skip} can be a string, which is evaluated as an expression, a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8919 function reference or a lambda.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8920 When {skip} is omitted or empty, every match is accepted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8921 When evaluating {skip} causes an error the search is aborted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8922 and -1 returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8923 search()-sub-match
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8924 With the 'p' flag the returned value is one more than the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8925 first sub-match in . One if none of them matched but the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8926 whole pattern did match.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8927 To get the column number too use \|searchpos()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8928
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8929 The cursor will be positioned at the match, unless the 'n'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8930 flag is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8931
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8932 Example (goes over all files in the argument list): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8933 :let n = 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8934 :while n <= argc() " loop over all files in arglist
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8935 : exe "argument " .. n
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8936 : " start at the last char in the file and wrap for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8937 : " first search to find match at start of file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8938 : normal G$
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8939 : let flags = "w"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8940 : while search("foo", flags) > 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8941 : s/foo/bar/g
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8942 : let flags = "W"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8943 : endwhile
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8944 : update " write the file if modified
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8945 : let n = n + 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8946 :endwhile
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8947 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8948 Example for using some flags: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8949 :echo search('\<if\\|$else$\\|$endif$', 'ncpe')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8950 < This will search for the keywords "if", "else", and "endif"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8951 under or after the cursor. Because of the 'p' flag, it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8952 returns 1, 2, or 3 depending on which keyword is found, or 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8953 if the search fails. With the cursor on the first word of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8954 line:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8955 if (foo == 0) \| let foo = foo + 1 \| endif ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8956 the function returns 1. Without the 'c' flag, the function
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8957 finds the "endif" and returns 3. The same thing happens
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8958 without the 'e' flag if the cursor is on the "f" of "if".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8959 The 'n' flag tells the function not to move the cursor.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8960
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8961 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8962 GetPattern()->search()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8963 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8964 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	8965
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8966
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8967 searchcount([{options}]) searchcount()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8968 Get or update the last search count, like what is displayed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8969 without the "S" flag in 'shortmess'. This works even if
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8970 'shortmess' does contain the "S" flag.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8971
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8972 This returns a \|Dictionary\|. The dictionary is empty if the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8973 previous pattern was not set and "pattern" was not specified.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8974
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8975 key type meaning ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8976 current \|Number\| current position of match;
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8977 0 if the cursor position is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8978 before the first match
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8979 exact_match \|Boolean\| 1 if "current" is matched on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8980 "pos", otherwise 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8981 total \|Number\| total count of matches found
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8982 incomplete \|Number\| 0: search was fully completed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8983 1: recomputing was timed out
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8984 2: max count exceeded
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8985
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8986 For {options} see further down.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8987
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8988 To get the last search count when \|n\| or \|N\| was pressed, call
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8989 this function with `recompute: 0` . This sometimes returns
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8990 wrong information because \|n\| and \|N\|'s maximum count is 99.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8991 If it exceeded 99 the result must be max count + 1 (100). If
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8992 you want to get correct information, specify `recompute: 1`: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8993
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8994 " result == maxcount + 1 (100) when many matches
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8995 let result = searchcount(#{recompute: 0})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8996
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8997 " Below returns correct result (recompute defaults
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8998 " to 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	8999 let result = searchcount()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9000 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9001 The function is useful to add the count to 'statusline': >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9002 function! LastSearchCount() abort
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9003 let result = searchcount(#{recompute: 0})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9004 if empty(result)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9005 return ''
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9006 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9007 if result.incomplete ==# 1 " timed out
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9008 return printf(' /%s [?/??]', @/)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9009 elseif result.incomplete ==# 2 " max count exceeded
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9010 if result.total > result.maxcount &&
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9011 \ result.current > result.maxcount
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9012 return printf(' /%s [>%d/>%d]', @/,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9013 \ result.current, result.total)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9014 elseif result.total > result.maxcount
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9015 return printf(' /%s [%d/>%d]', @/,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9016 \ result.current, result.total)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9017 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9018 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9019 return printf(' /%s [%d/%d]', @/,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9020 \ result.current, result.total)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9021 endfunction
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9022 let &statusline ..= '%{LastSearchCount()}'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9023
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9024 " Or if you want to show the count only when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9025 " 'hlsearch' was on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9026 " let &statusline ..=
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9027 " \ '%{v:hlsearch ? LastSearchCount() : ""}'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9028 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9029 You can also update the search count, which can be useful in a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9030 \|CursorMoved\| or \|CursorMovedI\| autocommand: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9031
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9032 autocmd CursorMoved,CursorMovedI *
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9033 \ let s:searchcount_timer = timer_start(
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9034 \ 200, function('s:update_searchcount'))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9035 function! s:update_searchcount(timer) abort
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9036 if a:timer ==# s:searchcount_timer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9037 call searchcount(#{
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9038 \ recompute: 1, maxcount: 0, timeout: 100})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9039 redrawstatus
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9040 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9041 endfunction
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9042 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9043 This can also be used to count matched texts with specified
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9044 pattern in the current buffer using "pattern": >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9045
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9046 " Count '\<foo\>' in this buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9047 " (Note that it also updates search count)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9048 let result = searchcount(#{pattern: '\<foo\>'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9049
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9050 " To restore old search count by old pattern,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9051 " search again
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9052 call searchcount()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9053 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9054 {options} must be a \|Dictionary\|. It can contain:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9055 key type meaning ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9056 recompute \|Boolean\| if \|TRUE\|, recompute the count
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9057 like \|n\| or \|N\| was executed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9058 otherwise returns the last
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9059 computed result (when \|n\| or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9060 \|N\| was used when "S" is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9061 in 'shortmess', or this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9062 function was called).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9063 (default: \|TRUE\|)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9064 pattern \|String\| recompute if this was given
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9065 and different with \|@/\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9066 this works as same as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9067 below command is executed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9068 before calling this function >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9069 let @/ = pattern
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9070 < (default: \|@/\|)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9071 timeout \|Number\| 0 or negative number is no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9072 timeout. timeout milliseconds
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9073 for recomputing the result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9074 (default: 0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9075 maxcount \|Number\| 0 or negative number is no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9076 limit. max count of matched
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9077 text while recomputing the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9078 result. if search exceeded
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9079 total count, "total" value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9080 becomes `maxcount + 1`
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9081 (default: 99)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9082 pos \|List\| `[lnum, col, off]` value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9083 when recomputing the result.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9084 this changes "current" result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9085 value. see \|cursor()\|,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9086 \|getpos()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9087 (default: cursor's position)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9088
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9089 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9090 GetSearchOpts()->searchcount()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9091 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9092 Return type: dict<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9093
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9094
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9095 searchdecl({name} [, {global} [, {thisblock}]]) searchdecl()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9096 Search for the declaration of {name}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9097
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9098 With a non-zero {global} argument it works like \|gD\|, find
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9099 first match in the file. Otherwise it works like \|gd\|, find
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9100 first match in the function.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9101
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9102 With a non-zero {thisblock} argument matches in a {} block
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9103 that ends before the cursor position are ignored. Avoids
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9104 finding variable declarations only valid in another scope.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9105
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9106 Moves the cursor to the found match.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9107 Returns zero for success, non-zero for failure.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9108 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9109 if searchdecl('myvar') == 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9110 echo getline('.')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9111 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9112 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9113 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9114 GetName()->searchdecl()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9115 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9116 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9117
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9118 searchpair()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9119 searchpair({start}, {middle}, {end} [, {flags} [, {skip}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9120 [, {stopline} [, {timeout}]]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9121 Search for the match of a nested start-end pair. This can be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9122 used to find the "endif" that matches an "if", while other
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9123 if/endif pairs in between are ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9124 The search starts at the cursor. The default is to search
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9125 forward, include 'b' in {flags} to search backward.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9126 If a match is found, the cursor is positioned at it and the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9127 line number is returned. If no match is found 0 or -1 is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9128 returned and the cursor doesn't move. No error message is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9129 given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9130
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9131 {start}, {middle} and {end} are patterns, see \|pattern\|. They
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9132 must not contain pairs. Use of \%( \) is allowed. When
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9133 {middle} is not empty, it is found when searching from either
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9134 direction, but only when not in a nested start-end pair. A
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9135 typical use is: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9136 searchpair('\<if\>', '\<else\>', '\<endif\>')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9137 < By leaving {middle} empty the "else" is skipped.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9138
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9139 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9140 \|search()\|. Additionally:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9141 'r' Repeat until no more matches found; will find the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9142 outer pair. Implies the 'W' flag.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9143 'm' Return number of matches instead of line number with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9144 the match; will be > 1 when 'r' is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9145 Note: it's nearly always a good idea to use the 'W' flag, to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9146 avoid wrapping around the end of the file.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9147
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9148 When a match for {start}, {middle} or {end} is found, the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9149 {skip} expression is evaluated with the cursor positioned on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9150 the start of the match. It should return non-zero if this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9151 match is to be skipped. E.g., because it is inside a comment
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9152 or a string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9153 When {skip} is omitted or empty, every match is accepted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9154 When evaluating {skip} causes an error the search is aborted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9155 and -1 returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9156 {skip} can be a string, a lambda, a funcref or a partial.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9157 Anything else makes the function fail.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9158 In a `:def` function when the {skip} argument is a string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9159 constant it is compiled into instructions.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9160
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9161 For {stopline} and {timeout} see \|search()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9162
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9163 The value of 'ignorecase' is used. 'magic' is ignored, the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9164 patterns are used like it's on.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9165
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9166 The search starts exactly at the cursor. A match with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9167 {start}, {middle} or {end} at the next character, in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9168 direction of searching, is the first one found. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9169 if 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9170 if 2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9171 endif 2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9172 endif 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9173 < When starting at the "if 2", with the cursor on the "i", and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9174 searching forwards, the "endif 2" is found. When starting on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9175 the character just before the "if 2", the "endif 1" will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9176 found. That's because the "if 2" will be found first, and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9177 then this is considered to be a nested if/endif from "if 2" to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9178 "endif 2".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9179 When searching backwards and {end} is more than one character,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9180 it may be useful to put "\zs" at the end of the pattern, so
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9181 that when the cursor is inside a match with the end it finds
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9182 the matching start.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9183
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9184 Example, to find the "endif" command in a Vim script: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9185
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9186 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9187 \ 'getline(".") =~ "^\\s*\""')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9188
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9189 < The cursor must be at or after the "if" for which a match is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9190 to be found. Note that single-quote strings are used to avoid
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9191 having to double the backslashes. The skip expression only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9192 catches comments at the start of a line, not after a command.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9193 Also, a word "en" or "if" halfway a line is considered a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9194 match.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9195 Another example, to search for the matching "{" of a "}": >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9196
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9197 :echo searchpair('{', '', '}', 'bW')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9198
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9199 < This works when the cursor is at or before the "}" for which a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9200 match is to be found. To reject matches that syntax
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9201 highlighting recognized as strings: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9202
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9203 :echo searchpair('{', '', '}', 'bW',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9204 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9205 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9206 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9207
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9208 searchpairpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9209 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9210 [, {stopline} [, {timeout}]]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9211 Same as \|searchpair()\|, but returns a \|List\| with the line and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9212 column position of the match. The first element of the \|List\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9213 is the line number and the second element is the byte index of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9214 the column position of the match. If no match is found,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9215 returns [0, 0]. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9216
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9217 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9218 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9219 See \|match-parens\| for a bigger and more useful example.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9220
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9221 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9222
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9223 searchpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9224 searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9225 Same as \|search()\|, but returns a \|List\| with the line and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9226 column position of the match. The first element of the \|List\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9227 is the line number and the second element is the byte index of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9228 the column position of the match. If no match is found,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9229 returns [0, 0].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9230 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9231 :let [lnum, col] = searchpos('mypattern', 'n')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9232
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9233 < When the 'p' flag is given then there is an extra item with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9234 the sub-pattern match number \|search()-sub-match\|. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9235 :let [lnum, col, submatch] = searchpos('$\l$\\|$\u$', 'np')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9236 < In this example "submatch" is 2 when a lowercase letter is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9237 found \|/\l\|, 3 when an uppercase letter is found \|/\u\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9238
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9239 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9240 GetPattern()->searchpos()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9241 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9242 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9243
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9244
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9245 server2client({clientid}, {string}) server2client()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9246 Send a reply string to {clientid}. The most recent {clientid}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9247 that sent a string can be retrieved with expand("<client>").
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9248 {only available when compiled with the \|+clientserver\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9249 Returns zero for success, -1 for failure.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9250 Note:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9251 This id has to be stored before the next command can be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9252 received. I.e. before returning from the received command and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9253 before calling any commands that waits for input.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9254 See also \|clientserver\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9255 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9256 :echo server2client(expand("<client>"), "HELLO")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9257
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9258 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9259 GetClientId()->server2client(string)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9260 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9261 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9262
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9263
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9264 serverlist() serverlist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9265 Return a list of available server names, one per line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9266 When there are no servers or the information is not available
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9267 an empty string is returned. See also \|clientserver\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9268 {only available when compiled with the \|+clientserver\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9269 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9270 :echo serverlist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9271 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9272 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9273
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9274
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9275 setbufline({buf}, {lnum}, {text}) setbufline()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9276 Set line {lnum} to {text} in buffer {buf}. This works like
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9277 \|setline()\| for the specified buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9278
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9279 This function works only for loaded buffers. First call
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9280 \|bufload()\| if needed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9281
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9282 To insert lines use \|appendbufline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9283 Any text properties in {lnum} are cleared.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9284
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9285 {text} can be a string to set one line, or a List of strings
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9286 to set multiple lines. If the List extends below the last
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9287 line then those lines are added. If the List is empty then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9288 nothing is changed and zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9289
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9290 For the use of {buf}, see \|bufname()\| above.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9291
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9292 {lnum} is used like with \|setline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9293 Use "$" to refer to the last line in buffer {buf}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9294 When {lnum} is just below the last line the {text} will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9295 added below the last line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9296
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9297 When {buf} is not a valid buffer, the buffer is not loaded or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9298 {lnum} is not valid then 1 is returned. In \|Vim9\| script an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9299 error is given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9300 On success 0 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9301
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9302 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9303 third argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9304 GetText()->setbufline(buf, lnum)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9305 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9306 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9307
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9308
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9309 setbufvar({buf}, {varname}, {val}) setbufvar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9310 Set option or local variable {varname} in buffer {buf} to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9311 {val}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9312 This also works for a global or local window option, but it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9313 doesn't work for a global or local window variable.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9314 For a local window option the global value is unchanged.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9315 For the use of {buf}, see \|bufname()\| above.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9316 The {varname} argument is a string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9317 Note that the variable name without "b:" must be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9318 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9319 :call setbufvar(1, "&mod", 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9320 :call setbufvar("todo", "myvar", "foobar")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9321 < This function is not available in the \|sandbox\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9322
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9323 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9324 third argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9325 GetValue()->setbufvar(buf, varname)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9326 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9327 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9328
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9329
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9330 setcellwidths({list}) setcellwidths()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9331 Specify overrides for cell widths of character ranges. This
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9332 tells Vim how wide characters are when displayed in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9333 terminal, counted in screen cells. The values override
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9334 'ambiwidth'. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9335 call setcellwidths([
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9336 \ [0x111, 0x111, 1],
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9337 \ [0x2194, 0x2199, 2],
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9338 \ ])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9339
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9340 < The {list} argument is a List of Lists with each three
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9341 numbers: [{low}, {high}, {width}]. E1109 E1110
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9342 {low} and {high} can be the same, in which case this refers to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9343 one character. Otherwise it is the range of characters from
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9344 {low} to {high} (inclusive). E1111 E1114
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9345 Only characters with value 0x80 and higher can be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9346
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9347 {width} must be either 1 or 2, indicating the character width
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9348 in screen cells. E1112
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9349 An error is given if the argument is invalid, also when a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9350 range overlaps with another. E1113
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9351
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9352 If the new value causes 'fillchars' or 'listchars' to become
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9353 invalid it is rejected and an error is given.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9354
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9355 To clear the overrides pass an empty {list}: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9356 setcellwidths([]);
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9357
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9358 < You can use the script $VIMRUNTIME/tools/emoji_list.vim to see
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9359 the effect for known emoji characters. Move the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9360 through the text to check if the cell widths of your terminal
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9361 match with what Vim knows about each emoji. If it doesn't
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9362 look right you need to adjust the {list} argument.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9363
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9364 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9365
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9366
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9367 setcharpos({expr}, {list}) setcharpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9368 Same as \|setpos()\| but uses the specified column number as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9369 character index instead of the byte index in the line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9370
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9371 Example:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9372 With the text "여보세요" in line 8: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9373 call setcharpos('.', [0, 8, 4, 0])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9374 < positions the cursor on the fourth character '요'. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9375 call setpos('.', [0, 8, 4, 0])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9376 < positions the cursor on the second character '보'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9377
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9378 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9379 GetPosition()->setcharpos('.')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9380 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9381 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9382
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9383
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9384 setcharsearch({dict}) setcharsearch()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9385 Set the current character search information to {dict},
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9386 which contains one or more of the following entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9387
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9388 char character which will be used for a subsequent
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9389 \|,\| or \|;\| command; an empty string clears the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9390 character search
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9391 forward direction of character search; 1 for forward,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9392 0 for backward
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9393 until type of character search; 1 for a \|t\| or \|T\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9394 character search, 0 for an \|f\| or \|F\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9395 character search
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9396
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9397 This can be useful to save/restore a user's character search
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9398 from a script: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9399 :let prevsearch = getcharsearch()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9400 :" Perform a command which clobbers user's search
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9401 :call setcharsearch(prevsearch)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9402 < Also see \|getcharsearch()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9403
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9404 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9405 SavedSearch()->setcharsearch()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9406 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9407 Return type: dict<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9408
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9409
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9410 setcmdline({str} [, {pos}]) setcmdline()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9411 Set the command line to {str} and set the cursor position to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9412 {pos}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9413 If {pos} is omitted, the cursor is positioned after the text.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9414 Returns 0 when successful, 1 when not editing the command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9415 line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9416
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9417 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9418 GetText()->setcmdline()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9419 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9420 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9421
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9422
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9423 setcmdpos({pos}) setcmdpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9424 Set the cursor position in the command line to byte position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9425 {pos}. The first position is 1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9426 Use \|getcmdpos()\| to obtain the current position.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9427 Only works while editing the command line, thus you must use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9428 \|c_CTRL-\_e\|, \|c_CTRL-R_=\| or \|c_CTRL-R_CTRL-R\| with '='. For
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9429 \|c_CTRL-\_e\| and \|c_CTRL-R_CTRL-R\| with '=' the position is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9430 set after the command line is set to the expression. For
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9431 \|c_CTRL-R_=\| it is set after evaluating the expression but
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9432 before inserting the resulting text.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9433 When the number is too big the cursor is put at the end of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9434 line. A number smaller than one has undefined results.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9435 Returns 0 when successful, 1 when not editing the command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9436 line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9437
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9438 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9439 GetPos()->setcmdpos()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9440 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9441 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9442
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9443
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9444 setcursorcharpos({lnum}, {col} [, {off}]) setcursorcharpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9445 setcursorcharpos({list})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9446 Same as \|cursor()\| but uses the specified column number as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9447 character index instead of the byte index in the line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9448
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9449 Example:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9450 With the text "여보세요" in line 4: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9451 call setcursorcharpos(4, 3)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9452 < positions the cursor on the third character '세'. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9453 call cursor(4, 3)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9454 < positions the cursor on the first character '여'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9455
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9456 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9457 GetCursorPos()->setcursorcharpos()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9458 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9459 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9460
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9461
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9462 setenv({name}, {val}) setenv()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9463 Set environment variable {name} to {val}. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9464 call setenv('HOME', '/home/myhome')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9465
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9466 < When {val} is \|v:null\| the environment variable is deleted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9467 See also \|expr-env\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9468
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9469 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9470 second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9471 GetPath()->setenv('PATH')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9472 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9473 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9474
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9475
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9476 setfperm({fname}, {mode}) setfperm() chmod
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9477 Set the file permissions for {fname} to {mode}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9478 {mode} must be a string with 9 characters. It is of the form
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9479 "rwxrwxrwx", where each group of "rwx" flags represent, in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9480 turn, the permissions of the owner of the file, the group the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9481 file belongs to, and other users. A '-' character means the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9482 permission is off, any other character means on. Multi-byte
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9483 characters are not supported.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9484
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9485 For example "rw-r-----" means read-write for the user,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9486 readable by the group, not accessible by others. "xx-x-----"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9487 would do the same thing.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9488
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9489 Returns non-zero for success, zero for failure.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9490
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9491 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9492 GetFilename()->setfperm(mode)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9493 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9494 To read permissions see \|getfperm()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9495
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9496 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9497
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9498
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9499 setline({lnum}, {text}) setline()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9500 Set line {lnum} of the current buffer to {text}. To insert
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9501 lines use \|append()\|. To set lines in another buffer use
35445 125046175f23 runtime(doc): clarify when text properties are cleared Christian Brabandt <cb@256bit.org> parents: 35409 diff changeset	9502 \|setbufline()\|.
125046175f23 runtime(doc): clarify when text properties are cleared Christian Brabandt <cb@256bit.org> parents: 35409 diff changeset	9503 Any text properties in {lnum} are cleared \|text-prop-cleared\|.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9504
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9505 {lnum} is used like with \|getline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9506 When {lnum} is just below the last line the {text} will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9507 added below the last line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9508 {text} can be any type or a List of any type, each item is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9509 converted to a String. When {text} is an empty List then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9510 nothing is changed and FALSE is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9511
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9512 If this succeeds, FALSE is returned. If this fails (most likely
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9513 because {lnum} is invalid) TRUE is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9514 In \|Vim9\| script an error is given if {lnum} is invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9515
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9516 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9517 :call setline(5, strftime("%c"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9518
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9519 < When {text} is a \|List\| then line {lnum} and following lines
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9520 will be set to the items in the list. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9521 :call setline(5, ['aaa', 'bbb', 'ccc'])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9522 < This is equivalent to: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9523 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9524 : call setline(n, l)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9525 :endfor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9526
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9527 < Note: The '[ and '] marks are not set.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9528
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9529 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9530 second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9531 GetText()->setline(lnum)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9532 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9533 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9534
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9535
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9536 setloclist({nr}, {list} [, {action} [, {what}]]) setloclist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9537 Create or replace or add to the location list for window {nr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9538 {nr} can be the window number or the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9539 When {nr} is zero the current window is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9540
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9541 For a location list window, the displayed location list is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9542 modified. For an invalid window number {nr}, -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9543 Otherwise, same as \|setqflist()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9544 Also see \|location-list\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9545
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9546 For {action} see \|setqflist-action\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9547
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9548 If the optional {what} dictionary argument is supplied, then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9549 only the items listed in {what} are set. Refer to \|setqflist()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9550 for the list of supported keys in {what}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9551
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9552 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9553 second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9554 GetLoclist()->setloclist(winnr)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9555 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9556 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9557
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9558
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9559 setmatches({list} [, {win}]) setmatches()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9560 Restores a list of matches saved by \|getmatches()\| for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9561 current window. Returns 0 if successful, otherwise -1. All
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9562 current matches are cleared before the list is restored. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9563 example for \|getmatches()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9564 If {win} is specified, use the window with this number or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9565 window ID instead of the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9566
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9567 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9568 GetMatches()->setmatches()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9569 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9570 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9571
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9572
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9573 setpos({expr}, {list}) setpos()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9574 Set the position for String {expr}. Possible values:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9575 . the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9576 'x mark x
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9577
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9578 {list} must be a \|List\| with four or five numbers:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9579 [bufnum, lnum, col, off]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9580 [bufnum, lnum, col, off, curswant]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9581
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9582 "bufnum" is the buffer number. Zero can be used for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9583 current buffer. When setting an uppercase mark "bufnum" is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9584 used for the mark position. For other marks it specifies the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9585 buffer to set the mark in. You can use the \|bufnr()\| function
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9586 to turn a file name into a buffer number.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9587 For setting the cursor and the ' mark "bufnum" is ignored,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9588 since these are associated with a window, not a buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9589 Does not change the jumplist.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9590
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9591 "lnum" and "col" are the position in the buffer. The first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9592 column is 1. Use a zero "lnum" to delete a mark. If "col" is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9593 smaller than 1 then 1 is used. To use the character count
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9594 instead of the byte count, use \|setcharpos()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9595
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9596 The "off" number is only used when 'virtualedit' is set. Then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9597 it is the offset in screen columns from the start of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9598 character. E.g., a position within a <Tab> or after the last
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9599 character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9600
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9601 The "curswant" number is only used when setting the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9602 position. It sets the preferred column for when moving the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9603 cursor vertically. When the "curswant" number is missing the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9604 preferred column is not set. When it is present and setting a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9605 mark position it is not used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9606
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9607 Note that for '< and '> changing the line number may result in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9608 the marks to be effectively be swapped, so that '< is always
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9609 before '>.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9610
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9611 Returns 0 when the position could be set, -1 otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9612 An error message is given if {expr} is invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9613
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9614 Also see \|setcharpos()\|, \|getpos()\| and \|getcurpos()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9615
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9616 This does not restore the preferred column for moving
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9617 vertically; if you set the cursor position with this, \|j\| and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9618 \|k\| motions will jump to previous columns! Use \|cursor()\| to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9619 also set the preferred column. Also see the "curswant" key in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9620 \|winrestview()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9621
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9622 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9623 GetPosition()->setpos('.')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9624 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9625 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9626
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9627
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9628 setqflist({list} [, {action} [, {what}]]) setqflist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9629 Create or replace or add to the quickfix list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9630
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9631 If the optional {what} dictionary argument is supplied, then
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9632 only the items listed in {what} are set. The first {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9633 argument is ignored. See below for the supported items in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9634 {what}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9635 setqflist-what
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9636 When {what} is not present, the items in {list} are used. Each
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9637 item must be a dictionary. Non-dictionary items in {list} are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9638 ignored. Each dictionary item can contain the following
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9639 entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9640
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9641 bufnr buffer number; must be the number of a valid
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9642 buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9643 filename name of a file; only used when "bufnr" is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9644 present or it is invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9645 module name of a module; if given it will be used in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9646 quickfix error window instead of the filename.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9647 lnum line number in the file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9648 end_lnum end of lines, if the item spans multiple lines
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9649 pattern search pattern used to locate the error
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9650 col column number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9651 vcol when non-zero: "col" is visual column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9652 when zero: "col" is byte index
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9653 end_col end column, if the item spans multiple columns
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9654 nr error number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9655 text description of the error
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9656 type single-character error type, 'E', 'W', etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9657 valid recognized error message
32738 05188ca69e43 patch 9.0.1688: cannot store custom data in quickfix list Christian Brabandt <cb@256bit.org> parents: 32732 diff changeset	9658 user_data custom data associated with the item, can be
05188ca69e43 patch 9.0.1688: cannot store custom data in quickfix list Christian Brabandt <cb@256bit.org> parents: 32732 diff changeset	9659 any type.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9660
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9661 The "col", "vcol", "nr", "type" and "text" entries are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9662 optional. Either "lnum" or "pattern" entry can be used to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9663 locate a matching error line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9664 If the "filename" and "bufnr" entries are not present or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9665 neither the "lnum" or "pattern" entries are present, then the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9666 item will not be handled as an error line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9667 If both "pattern" and "lnum" are present then "pattern" will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9668 be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9669 If the "valid" entry is not supplied, then the valid flag is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9670 set when "bufnr" is a valid buffer or "filename" exists.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9671 If you supply an empty {list}, the quickfix list will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9672 cleared.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9673 Note that the list is not exactly the same as what
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9674 \|getqflist()\| returns.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9675
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9676 {action} values: setqflist-action E927
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9677 'a' The items from {list} are added to the existing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9678 quickfix list. If there is no existing list, then a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9679 new list is created.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9680
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9681 'r' The items from the current quickfix list are replaced
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9682 with the items from {list}. This can also be used to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9683 clear the list: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9684 :call setqflist([], 'r')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9685 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9686 'f' All the quickfix lists in the quickfix stack are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9687 freed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9688
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9689 If {action} is not present or is set to ' ', then a new list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9690 is created. The new quickfix list is added after the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9691 quickfix list in the stack and all the following lists are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9692 freed. To add a new quickfix list at the end of the stack,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9693 set "nr" in {what} to "$".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9694
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9695 The following items can be specified in dictionary {what}:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9696 context quickfix list context. See \|quickfix-context\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9697 efm errorformat to use when parsing text from
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9698 "lines". If this is not present, then the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9699 'errorformat' option value is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9700 See \|quickfix-parse\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9701 id quickfix list identifier \|quickfix-ID\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9702 idx index of the current entry in the quickfix
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9703 list specified by 'id' or 'nr'. If set to '$',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9704 then the last entry in the list is set as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9705 current entry. See \|quickfix-index\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9706 items list of quickfix entries. Same as the {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9707 argument.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9708 lines use 'errorformat' to parse a list of lines and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9709 add the resulting entries to the quickfix list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9710 {nr} or {id}. Only a \|List\| value is supported.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9711 See \|quickfix-parse\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9712 nr list number in the quickfix stack; zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9713 means the current quickfix list and "$" means
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9714 the last quickfix list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9715 quickfixtextfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9716 function to get the text to display in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9717 quickfix window. The value can be the name of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9718 a function or a funcref or a lambda. Refer to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9719 \|quickfix-window-function\| for an explanation
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9720 of how to write the function and an example.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9721 title quickfix list title text. See \|quickfix-title\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9722 Unsupported keys in {what} are ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9723 If the "nr" item is not present, then the current quickfix list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9724 is modified. When creating a new quickfix list, "nr" can be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9725 set to a value one greater than the quickfix stack size.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9726 When modifying a quickfix list, to guarantee that the correct
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9727 list is modified, "id" should be used instead of "nr" to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9728 specify the list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9729
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9730 Examples (See also \|setqflist-examples\|): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9731 :call setqflist([], 'r', {'title': 'My search'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9732 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9733 :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9734 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9735 Returns zero for success, -1 for failure.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9736
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9737 This function can be used to create a quickfix list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9738 independent of the 'errorformat' setting. Use a command like
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9739 `:cc 1` to jump to the first position.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9740
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9741 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9742 second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9743 GetErrorlist()->setqflist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9744 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9745 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9746
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9747
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9748 setreg({regname}, {value} [, {options}]) setreg()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9749 Set the register {regname} to {value}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9750 If {regname} is "" or "@", the unnamed register '"' is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9751 The {regname} argument is a string. In \|Vim9-script\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9752 {regname} must be one character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9753
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9754 {value} may be any value returned by \|getreg()\| or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9755 \|getreginfo()\|, including a \|List\| or \|Dict\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9756 If {options} contains "a" or {regname} is upper case,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9757 then the value is appended.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9758
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9759 {options} can also contain a register type specification:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9760 "c" or "v" \|characterwise\| mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9761 "l" or "V" \|linewise\| mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9762 "b" or "<CTRL-V>" \|blockwise-visual\| mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9763 If a number immediately follows "b" or "<CTRL-V>" then this is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9764 used as the width of the selection - if it is not specified
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9765 then the width of the block is set to the number of characters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9766 in the longest line (counting a <Tab> as 1 character).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9767
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9768 If {options} contains no register settings, then the default
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9769 is to use character mode unless {value} ends in a <NL> for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9770 string {value} and linewise mode for list {value}. Blockwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9771 mode is never selected automatically.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9772 Returns zero for success, non-zero for failure.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9773
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9774 E883
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9775 Note: you may not use \|List\| containing more than one item to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9776 set search and expression registers. Lists containing no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9777 items act like empty strings.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9778
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9779 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9780 :call setreg(v:register, @*)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9781 :call setreg('*', @%, 'ac')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9782 :call setreg('a', "1\n2\n3", 'b5')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9783 :call setreg('"', { 'points_to': 'a'})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9784
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9785 < This example shows using the functions to save and restore a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9786 register: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9787 :let var_a = getreginfo()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9788 :call setreg('a', var_a)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9789 < or: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9790 :let var_a = getreg('a', 1, 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9791 :let var_amode = getregtype('a')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9792 ....
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9793 :call setreg('a', var_a, var_amode)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9794 < Note: you may not reliably restore register value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9795 without using the third argument to \|getreg()\| as without it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9796 newlines are represented as newlines AND Nul bytes are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9797 represented as newlines as well, see \|NL-used-for-Nul\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9798
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9799 You can also change the type of a register by appending
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9800 nothing: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9801 :call setreg('a', '', 'al')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9802
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9803 < Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9804 second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9805 GetText()->setreg('a')
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9806 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9807 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9808
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9809
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9810 settabvar({tabnr}, {varname}, {val}) settabvar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9811 Set tab-local variable {varname} to {val} in tab page {tabnr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9812 \|t:var\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9813 The {varname} argument is a string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9814 Note that autocommands are blocked, side effects may not be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9815 triggered, e.g. when setting 'filetype'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9816 Note that the variable name without "t:" must be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9817 Tabs are numbered starting with one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9818 This function is not available in the \|sandbox\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9819
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9820 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9821 third argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9822 GetValue()->settabvar(tab, name)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9823 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9824 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9825
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9826
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9827 settabwinvar({tabnr}, {winnr}, {varname}, {val}) settabwinvar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9828 Set option or local variable {varname} in window {winnr} to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9829 {val}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9830 Tabs are numbered starting with one. For the current tabpage
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9831 use \|setwinvar()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9832 {winnr} can be the window number or the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9833 When {winnr} is zero the current window is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9834 Note that autocommands are blocked, side effects may not be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9835 triggered, e.g. when setting 'filetype' or 'syntax'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9836 This also works for a global or local buffer option, but it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9837 doesn't work for a global or local buffer variable.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9838 For a local buffer option the global value is unchanged.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9839 Note that the variable name without "w:" must be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9840 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9841 :call settabwinvar(1, 1, "&list", 0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9842 :call settabwinvar(3, 2, "myvar", "foobar")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9843 < This function is not available in the \|sandbox\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9844
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9845 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9846 fourth argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9847 GetValue()->settabwinvar(tab, winnr, name)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9848 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9849 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9850
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9851
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9852 settagstack({nr}, {dict} [, {action}]) settagstack()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9853 Modify the tag stack of the window {nr} using {dict}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9854 {nr} can be the window number or the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9855
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9856 For a list of supported items in {dict}, refer to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9857 \|gettagstack()\|. "curidx" takes effect before changing the tag
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9858 stack.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9859 E962
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9860 How the tag stack is modified depends on the {action}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9861 argument:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9862 - If {action} is not present or is set to 'r', then the tag
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9863 stack is replaced.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9864 - If {action} is set to 'a', then new entries from {dict} are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9865 pushed (added) onto the tag stack.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9866 - If {action} is set to 't', then all the entries from the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9867 current entry in the tag stack or "curidx" in {dict} are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9868 removed and then new entries are pushed to the stack.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9869
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9870 The current index is set to one after the length of the tag
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9871 stack after the modification.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9872
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9873 Returns zero for success, -1 for failure.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9874
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9875 Examples (for more examples see \|tagstack-examples\|):
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9876 Empty the tag stack of window 3: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9877 call settagstack(3, {'items' : []})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9878
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9879 < Save and restore the tag stack: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9880 let stack = gettagstack(1003)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9881 " do something else
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9882 call settagstack(1003, stack)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9883 unlet stack
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9884 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9885 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9886 second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9887 GetStack()->settagstack(winnr)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9888 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9889 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9890
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9891
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9892 setwinvar({winnr}, {varname}, {val}) setwinvar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9893 Like \|settabwinvar()\| for the current tab page.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9894 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9895 :call setwinvar(1, "&list", 0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9896 :call setwinvar(2, "myvar", "foobar")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9897
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9898 < Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9899 third argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9900 GetValue()->setwinvar(winnr, name)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9901 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9902 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9903
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9904
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9905 sha256({string}) sha256()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9906 Returns a String with 64 hex characters, which is the SHA256
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9907 checksum of {string}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9908
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9909 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9910 GetText()->sha256()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9911 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9912 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9913
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9914 {only available when compiled with the \|+cryptv\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9915
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9916 shellescape({string} [, {special}]) shellescape()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9917 Escape {string} for use as a shell command argument.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9918 When the 'shell' contains powershell (MS-Windows) or pwsh
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9919 (MS-Windows, Linux, and macOS) then it will enclose {string}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9920 in single quotes and will double up all internal single
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9921 quotes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9922 On MS-Windows, when 'shellslash' is not set, it will enclose
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9923 {string} in double quotes and double all double quotes within
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9924 {string}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9925 Otherwise it will enclose {string} in single quotes and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9926 replace all "'" with "'\''".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9927
35184 0a80fe1a9125 runtime(doc): clarify {special} argument for shellescape() Christian Brabandt <cb@256bit.org> parents: 35125 diff changeset	9928 The {special} argument adds additional escaping of keywords
0a80fe1a9125 runtime(doc): clarify {special} argument for shellescape() Christian Brabandt <cb@256bit.org> parents: 35125 diff changeset	9929 used in Vim commands. When it is not omitted and a non-zero
35185 3a4fd6867abf runtime(doc): Remove trailing spaces (#14784) Christian Brabandt <cb@256bit.org> parents: 35184 diff changeset	9930 number or a non-empty String (\|non-zero-arg\|), then special
3a4fd6867abf runtime(doc): Remove trailing spaces (#14784) Christian Brabandt <cb@256bit.org> parents: 35184 diff changeset	9931 items such as "!", "%", "#" and "<cword>" (as listed in
3a4fd6867abf runtime(doc): Remove trailing spaces (#14784) Christian Brabandt <cb@256bit.org> parents: 35184 diff changeset	9932 \|expand()\|) will be preceded by a backslash.
35184 0a80fe1a9125 runtime(doc): clarify {special} argument for shellescape() Christian Brabandt <cb@256bit.org> parents: 35125 diff changeset	9933 This backslash will be removed again by the \|:!\| command.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9934
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9935 The "!" character will be escaped (again with a \|non-zero-arg\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9936 {special}) when 'shell' contains "csh" in the tail. That is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9937 because for csh and tcsh "!" is used for history replacement
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9938 even when inside single quotes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9939
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9940 With a \|non-zero-arg\| {special} the <NL> character is also
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9941 escaped. When 'shell' containing "csh" in the tail it's
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9942 escaped a second time.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9943
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9944 The "\" character will be escaped when 'shell' contains "fish"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9945 in the tail. That is because for fish "\" is used as an escape
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9946 character inside single quotes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9947
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9948 Example of use with a \|:!\| command: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9949 :exe '!dir ' .. shellescape(expand('<cfile>'), 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9950 < This results in a directory listing for the file under the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9951 cursor. Example of use with \|system()\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9952 :call system("chmod +w -- " .. shellescape(expand("%")))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9953 < See also \|::S\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9954
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9955 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9956 GetCommand()->shellescape()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9957 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9958 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9959
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9960
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9961 shiftwidth([{col}]) shiftwidth()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9962 Returns the effective value of 'shiftwidth'. This is the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9963 'shiftwidth' value unless it is zero, in which case it is the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9964 'tabstop' value. This function was introduced with patch
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9965 7.3.694 in 2012, everybody should have it by now (however it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9966 did not allow for the optional {col} argument until 8.1.542).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9967
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9968 When there is one argument {col} this is used as column number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9969 for which to return the 'shiftwidth' value. This matters for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9970 'vartabstop' feature. If the 'vartabstop' setting is enabled and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9971 no {col} argument is given, column 1 will be assumed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9972
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9973 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9974 GetColumn()->shiftwidth()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9975 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	9976 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9977
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9978 sign_ functions are documented here: \|sign-functions-details\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9979
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9980
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9981 simplify({filename}) simplify()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9982 Simplify the file name as much as possible without changing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9983 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9984 Unix) are not resolved. If the first path component in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9985 {filename} designates the current directory, this will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9986 valid for the result as well. A trailing path separator is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9987 not removed either. On Unix "//path" is unchanged, but
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9988 "///path" is simplified to "/path" (this follows the Posix
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9989 standard).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9990 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9991 simplify("./dir/.././/file/") == "./file/"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9992 < Note: The combination "dir/.." is only removed if "dir" is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9993 a searchable directory or does not exist. On Unix, it is also
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9994 removed when "dir" is a symbolic link within the same
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9995 directory. In order to resolve all the involved symbolic
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9996 links before simplifying the path name, use \|resolve()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9997
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9998 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	9999 GetName()->simplify()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10000 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10001 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10002
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10003
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10004 sin({expr}) sin()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10005 Return the sine of {expr}, measured in radians, as a \|Float\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10006 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10007 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10008 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10009 :echo sin(100)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10010 < -0.506366 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10011 :echo sin(-4.01)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10012 < 0.763301
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10013
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10014 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10015 Compute()->sin()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10016 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10017 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10018
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10019
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10020 sinh({expr}) sinh()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10021 Return the hyperbolic sine of {expr} as a \|Float\| in the range
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10022 [-inf, inf].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10023 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10024 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10025 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10026 :echo sinh(0.5)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10027 < 0.521095 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10028 :echo sinh(-0.9)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10029 < -1.026517
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10030
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10031 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10032 Compute()->sinh()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10033 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10034 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10035
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10036
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10037 slice({expr}, {start} [, {end}]) slice()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10038 Similar to using a \|slice\| "expr[start : end]", but "end" is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10039 used exclusive. And for a string the indexes are used as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10040 character indexes instead of byte indexes, like in
34620 abc7a647c83b patch 9.1.0199: Not enough tests for the slice() function Christian Brabandt <cb@256bit.org> parents: 34561 diff changeset	10041 \|vim9script\|. Also, composing characters are treated as a
abc7a647c83b patch 9.1.0199: Not enough tests for the slice() function Christian Brabandt <cb@256bit.org> parents: 34561 diff changeset	10042 part of the preceding base character.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10043 When {end} is omitted the slice continues to the last item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10044 When {end} is -1 the last item is omitted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10045 Returns an empty value if {start} or {end} are invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10046
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10047 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10048 GetList()->slice(offset)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10049 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10050 Return type: list<{type}>
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10051
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10052
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10053 sort({list} [, {how} [, {dict}]]) sort() E702
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10054 Sort the items in {list} in-place. Returns {list}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10055
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10056 If you want a list to remain unmodified make a copy first: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10057 :let sortedlist = sort(copy(mylist))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10058
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10059 < When {how} is omitted or is a string, then sort() uses the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10060 string representation of each item to sort on. Numbers sort
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10061 after Strings, \|Lists\| after Numbers. For sorting text in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10062 current buffer use \|:sort\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10063
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10064 When {how} is given and it is 'i' then case is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10065 In legacy script, for backwards compatibility, the value one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10066 can be used to ignore case. Zero means to not ignore case.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10067
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10068 When {how} is given and it is 'l' then the current collation
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10069 locale is used for ordering. Implementation details: strcoll()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10070 is used to compare strings. See \|:language\| check or set the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10071 collation locale. \|v:collate\| can also be used to check the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10072 current locale. Sorting using the locale typically ignores
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10073 case. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10074 " ö is sorted similarly to o with English locale.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10075 :language collate en_US.UTF8
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10076 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10077 < ['n', 'o', 'O', 'ö', 'p', 'z'] ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10078 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10079 " ö is sorted after z with Swedish locale.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10080 :language collate sv_SE.UTF8
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10081 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10082 < ['n', 'o', 'O', 'p', 'z', 'ö'] ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10083 This does not work properly on Mac.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10084
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10085 When {how} is given and it is 'n' then all items will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10086 sorted numerical (Implementation detail: this uses the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10087 strtod() function to parse numbers. Strings, Lists, Dicts and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10088 Funcrefs will be considered as being 0). Note that this won't
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10089 sort a list of strings with numbers!
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10090
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10091 When {how} is given and it is 'N' then all items will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10092 sorted numerical. This is like 'n' but a string containing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10093 digits will be used as the number they represent.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10094
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10095 When {how} is given and it is 'f' then all items will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10096 sorted numerical. All values must be a Number or a Float.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10097
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10098 When {how} is a \|Funcref\| or a function name, this function
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10099 is called to compare items. The function is invoked with two
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10100 items as argument and must return zero if they are equal, 1 or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10101 bigger if the first one sorts after the second one, -1 or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10102 smaller if the first one sorts before the second one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10103
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10104 {dict} is for functions with the "dict" attribute. It will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10105 used to set the local variable "self". \|Dictionary-function\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10106
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10107 The sort is stable, items which compare equal (as number or as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10108 string) will keep their relative position. E.g., when sorting
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10109 on numbers, text strings will sort next to each other, in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10110 same order as they were originally.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10111
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10112 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10113 mylist->sort()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10114
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10115 < Also see \|uniq()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10116
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10117 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10118 func MyCompare(i1, i2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10119 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10120 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10121 eval mylist->sort("MyCompare")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10122 < A shorter compare version for this specific simple case, which
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10123 ignores overflow: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10124 func MyCompare(i1, i2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10125 return a:i1 - a:i2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10126 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10127 < For a simple expression you can use a lambda: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10128 eval mylist->sort({i1, i2 -> i1 - i2})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10129 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10130 Return type: list<{type}>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10131
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10132
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10133 sound_clear() sound_clear()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10134 Stop playing all sounds.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10135
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10136 On some Linux systems you may need the libcanberra-pulse
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10137 package, otherwise sound may not stop.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10138
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10139 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10140
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10141 {only available when compiled with the \|+sound\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10142
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10143 sound_playevent()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10144 sound_playevent({name} [, {callback}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10145 Play a sound identified by {name}. Which event names are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10146 supported depends on the system. Often the XDG sound names
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10147 are used. On Ubuntu they may be found in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10148 /usr/share/sounds/freedesktop/stereo. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10149 call sound_playevent('bell')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10150 < On MS-Windows, {name} can be SystemAsterisk, SystemDefault,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10151 SystemExclamation, SystemExit, SystemHand, SystemQuestion,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10152 SystemStart, SystemWelcome, etc.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10153 On macOS, {name} refers to files located in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10154 /System/Library/Sounds (e.g. "Tink"). It will also work for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10155 custom installed sounds in folders like ~/Library/Sounds.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10156
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10157 When {callback} is specified it is invoked when the sound is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10158 finished. The first argument is the sound ID, the second
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10159 argument is the status:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10160 0 sound was played to the end
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10161 1 sound was interrupted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10162 2 error occurred after sound started
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10163 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10164 func Callback(id, status)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10165 echomsg "sound " .. a:id .. " finished with " .. a:status
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10166 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10167 call sound_playevent('bell', 'Callback')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10168
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10169 < MS-Windows: {callback} doesn't work for this function.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10170
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10171 Returns the sound ID, which can be passed to `sound_stop()`.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10172 Returns zero if the sound could not be played.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10173
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10174 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10175 GetSoundName()->sound_playevent()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10176 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10177 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10178
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10179 {only available when compiled with the \|+sound\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10180
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10181 sound_playfile()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10182 sound_playfile({path} [, {callback}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10183 Like `sound_playevent()` but play sound file {path}. {path}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10184 must be a full path. On Ubuntu you may find files to play
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10185 with this command: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10186 :!find /usr/share/sounds -type f \| grep -v index.theme
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10187
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10188 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10189 GetSoundPath()->sound_playfile()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10190 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10191 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10192
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10193 {only available when compiled with the \|+sound\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10194
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10195
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10196 sound_stop({id}) sound_stop()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10197 Stop playing sound {id}. {id} must be previously returned by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10198 `sound_playevent()` or `sound_playfile()`.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10199
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10200 On some Linux systems you may need the libcanberra-pulse
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10201 package, otherwise sound may not stop.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10202
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10203 On MS-Windows, this does not work for event sound started by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10204 `sound_playevent()`. To stop event sounds, use `sound_clear()`.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10205
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10206 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10207 soundid->sound_stop()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10208 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10209 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10210
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10211 {only available when compiled with the \|+sound\| feature}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10212
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10213 soundfold()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10214 soundfold({word})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10215 Return the sound-folded equivalent of {word}. Uses the first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10216 language in 'spelllang' for the current window that supports
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10217 soundfolding. 'spell' must be set. When no sound folding is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10218 possible the {word} is returned unmodified.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10219 This can be used for making spelling suggestions. Note that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10220 the method can be quite slow.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10221
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10222 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10223 GetWord()->soundfold()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10224 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10225 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10226
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10227
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10228 spellbadword([{sentence}]) spellbadword()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10229 Without argument: The result is the badly spelled word under
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10230 or after the cursor. The cursor is moved to the start of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10231 bad word. When no bad word is found in the cursor line the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10232 result is an empty string and the cursor doesn't move.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10233
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10234 With argument: The result is the first word in {sentence} that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10235 is badly spelled. If there are no spelling mistakes the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10236 result is an empty string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10237
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10238 The return value is a list with two items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10239 - The badly spelled word or an empty string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10240 - The type of the spelling error:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10241 "bad" spelling mistake
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10242 "rare" rare word
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10243 "local" word only valid in another region
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10244 "caps" word should start with Capital
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10245 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10246 echo spellbadword("the quik brown fox")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10247 < ['quik', 'bad'] ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10248
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10249 The spelling information for the current window and the value
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10250 of 'spelllang' are used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10251
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10252 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10253 GetText()->spellbadword()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10254 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10255 Return type: list<string>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10256
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10257
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10258 spellsuggest({word} [, {max} [, {capital}]]) spellsuggest()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10259 Return a \|List\| with spelling suggestions to replace {word}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10260 When {max} is given up to this number of suggestions are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10261 returned. Otherwise up to 25 suggestions are returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10262
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10263 When the {capital} argument is given and it's non-zero only
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10264 suggestions with a leading capital will be given. Use this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10265 after a match with 'spellcapcheck'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10266
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10267 {word} can be a badly spelled word followed by other text.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10268 This allows for joining two words that were split. The
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10269 suggestions also include the following text, thus you can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10270 replace a line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10271
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10272 {word} may also be a good word. Similar words will then be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10273 returned. {word} itself is not included in the suggestions,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10274 although it may appear capitalized.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10275
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10276 The spelling information for the current window is used. The
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10277 values of 'spelllang' and 'spellsuggest' are used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10278
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10279 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10280 GetWord()->spellsuggest()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10281 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10282 Return type: list<string> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10283
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10284
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10285 split({string} [, {pattern} [, {keepempty}]]) split()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10286 Make a \|List\| out of {string}. When {pattern} is omitted or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10287 empty each white-separated sequence of characters becomes an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10288 item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10289 Otherwise the string is split where {pattern} matches,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10290 removing the matched characters. 'ignorecase' is not used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10291 here, add \c to ignore case. \|/\c\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10292 When the first or last item is empty it is omitted, unless the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10293 {keepempty} argument is given and it's non-zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10294 Other empty items are kept when {pattern} matches at least one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10295 character or when {keepempty} is non-zero.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10296 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10297 :let words = split(getline('.'), '\W\+')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10298 < To split a string in individual characters: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10299 :for c in split(mystring, '\zs')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10300 < If you want to keep the separator you can also use '\zs' at
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10301 the end of the pattern: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10302 :echo split('abc:def:ghi', ':\zs')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10303 < ['abc:', 'def:', 'ghi'] ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10304 Splitting a table where the first element can be empty: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10305 :let items = split(line, ':', 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10306 < The opposite function is \|join()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10307
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10308 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10309 GetString()->split()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10310 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10311 Return type: list<string>
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10312
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10313 sqrt({expr}) sqrt()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10314 Return the non-negative square root of Float {expr} as a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10315 \|Float\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10316 {expr} must evaluate to a \|Float\| or a \|Number\|. When {expr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10317 is negative the result is NaN (Not a Number). Returns 0.0 if
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10318 {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10319 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10320 :echo sqrt(100)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10321 < 10.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10322 :echo sqrt(-4.01)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10323 < nan
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10324 "nan" may be different, it depends on system libraries.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10325
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10326 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10327 Compute()->sqrt()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10328 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10329 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10330
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10331
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10332 srand([{expr}]) srand()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10333 Initialize seed used by \|rand()\|:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10334 - If {expr} is not given, seed values are initialized by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10335 reading from /dev/urandom, if possible, or using time(NULL)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10336 a.k.a. epoch time otherwise; this only has second accuracy.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10337 - If {expr} is given it must be a Number. It is used to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10338 initialize the seed values. This is useful for testing or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10339 when a predictable sequence is intended.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10340
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10341 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10342 :let seed = srand()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10343 :let seed = srand(userinput)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10344 :echo rand(seed)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10345 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10346 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10347
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10348
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10349 state([{what}]) state()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10350 Return a string which contains characters indicating the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10351 current state. Mostly useful in callbacks that want to do
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10352 work that may not always be safe. Roughly this works like:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10353 - callback uses state() to check if work is safe to do.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10354 Yes: then do it right away.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10355 No: add to work queue and add a \|SafeState\| and/or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10356 \|SafeStateAgain\| autocommand (\|SafeState\| triggers at
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10357 toplevel, \|SafeStateAgain\| triggers after handling
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10358 messages and callbacks).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10359 - When SafeState or SafeStateAgain is triggered and executes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10360 your autocommand, check with `state()` if the work can be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10361 done now, and if yes remove it from the queue and execute.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10362 Remove the autocommand if the queue is now empty.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10363 Also see \|mode()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10364
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10365 When {what} is given only characters in this string will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10366 added. E.g, this checks if the screen has scrolled: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10367 if state('s') == ''
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10368 " screen has not scrolled
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10369 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10370 These characters indicate the state, generally indicating that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10371 something is busy:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10372 m halfway a mapping, :normal command, feedkeys() or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10373 stuffed command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10374 o operator pending, e.g. after \|d\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10375 a Insert mode autocomplete active
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10376 x executing an autocommand
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10377 w blocked on waiting, e.g. ch_evalexpr(), ch_read() and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10378 ch_readraw() when reading json
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10379 S not triggering SafeState or SafeStateAgain, e.g. after
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10380 \|f\| or a count
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10381 c callback invoked, including timer (repeats for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10382 recursiveness up to "ccc")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10383 s screen has scrolled for messages
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10384
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10385 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10386
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10387
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10388 str2float({string} [, {quoted}]) str2float()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10389 Convert String {string} to a Float. This mostly works the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10390 same as when using a floating point number in an expression,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10391 see \|floating-point-format\|. But it's a bit more permissive.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10392 E.g., "1e40" is accepted, while in an expression you need to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10393 write "1.0e40". The hexadecimal form "0x123" is also
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10394 accepted, but not others, like binary or octal.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10395 When {quoted} is present and non-zero then embedded single
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10396 quotes before the dot are ignored, thus "1'000.0" is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10397 thousand.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10398 Text after the number is silently ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10399 The decimal point is always '.', no matter what the locale is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10400 set to. A comma ends the number: "12,345.67" is converted to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10401 12.0. You can strip out thousands separators with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10402 \|substitute()\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10403 let f = str2float(substitute(text, ',', '', 'g'))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10404 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10405 Returns 0.0 if the conversion fails.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10406
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10407 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10408 let f = text->substitute(',', '', 'g')->str2float()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10409 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10410 Return type: \|Float\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10411
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10412
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10413 str2list({string} [, {utf8}]) str2list()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10414 Return a list containing the number values which represent
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10415 each character in String {string}. Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10416 str2list(" ") returns [32]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10417 str2list("ABC") returns [65, 66, 67]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10418 < \|list2str()\| does the opposite.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10419
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10420 When {utf8} is omitted or zero, the current 'encoding' is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10421 When {utf8} is TRUE, always treat the String as UTF-8
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10422 characters. With UTF-8 composing characters are handled
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10423 properly: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10424 str2list("á") returns [97, 769]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10425
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10426 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10427 GetString()->str2list()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10428 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10429 Return type: list<number>
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10430
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10431
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10432 str2nr({string} [, {base} [, {quoted}]]) str2nr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10433 Convert string {string} to a number.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10434 {base} is the conversion base, it can be 2, 8, 10 or 16.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10435 When {quoted} is present and non-zero then embedded single
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10436 quotes are ignored, thus "1'000'000" is a million.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10437
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10438 When {base} is omitted base 10 is used. This also means that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10439 a leading zero doesn't cause octal conversion to be used, as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10440 with the default String to Number conversion. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10441 let nr = str2nr('0123')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10442 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10443 When {base} is 16 a leading "0x" or "0X" is ignored. With a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10444 different base the result will be zero. Similarly, when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10445 {base} is 8 a leading "0", "0o" or "0O" is ignored, and when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10446 {base} is 2 a leading "0b" or "0B" is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10447 Text after the number is silently ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10448
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10449 Returns 0 if {string} is empty or on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10450
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10451 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10452 GetText()->str2nr()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10453 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10454 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10455
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10456
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10457 strcharlen({string}) strcharlen()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10458 The result is a Number, which is the number of characters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10459 in String {string}. Composing characters are ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10460 \|strchars()\| can count the number of characters, counting
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10461 composing characters separately.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10462
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10463 Returns 0 if {string} is empty or on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10464
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10465 Also see \|strlen()\|, \|strdisplaywidth()\| and \|strwidth()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10466
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10467 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10468 GetText()->strcharlen()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10469 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10470 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10471
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10472
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10473 strcharpart({src}, {start} [, {len} [, {skipcc}]]) strcharpart()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10474 Like \|strpart()\| but using character index and length instead
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10475 of byte index and length.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10476 When {skipcc} is omitted or zero, composing characters are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10477 counted separately.
34620 abc7a647c83b patch 9.1.0199: Not enough tests for the slice() function Christian Brabandt <cb@256bit.org> parents: 34561 diff changeset	10478 When {skipcc} set to 1, composing characters are treated as a
abc7a647c83b patch 9.1.0199: Not enough tests for the slice() function Christian Brabandt <cb@256bit.org> parents: 34561 diff changeset	10479 part of the preceding base character, similar to \|slice()\|.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10480 When a character index is used where a character does not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10481 exist it is omitted and counted as one character. For
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10482 example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10483 strcharpart('abc', -1, 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10484 < results in 'a'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10485
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10486 Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10487
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10488 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10489 GetText()->strcharpart(5)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10490 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10491 Return type: \|String\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10492
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10493
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10494 strchars({string} [, {skipcc}]) strchars()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10495 The result is a Number, which is the number of characters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10496 in String {string}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10497 When {skipcc} is omitted or zero, composing characters are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10498 counted separately.
34620 abc7a647c83b patch 9.1.0199: Not enough tests for the slice() function Christian Brabandt <cb@256bit.org> parents: 34561 diff changeset	10499 When {skipcc} set to 1, composing characters are ignored.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10500 \|strcharlen()\| always does this.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10501
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10502 Returns zero on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10503
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10504 Also see \|strlen()\|, \|strdisplaywidth()\| and \|strwidth()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10505
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10506 {skipcc} is only available after 7.4.755. For backward
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10507 compatibility, you can define a wrapper function: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10508 if has("patch-7.4.755")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10509 function s:strchars(str, skipcc)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10510 return strchars(a:str, a:skipcc)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10511 endfunction
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10512 else
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10513 function s:strchars(str, skipcc)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10514 if a:skipcc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10515 return strlen(substitute(a:str, ".", "x", "g"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10516 else
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10517 return strchars(a:str)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10518 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10519 endfunction
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10520 endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10521 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10522 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10523 GetText()->strchars()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10524 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10525 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10526
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10527
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10528 strdisplaywidth({string} [, {col}]) strdisplaywidth()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10529 The result is a Number, which is the number of display cells
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10530 String {string} occupies on the screen when it starts at {col}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10531 (first column is zero). When {col} is omitted zero is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10532 Otherwise it is the screen column where to start. This
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10533 matters for Tab characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10534 The option settings of the current window are used. This
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10535 matters for anything that's displayed differently, such as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10536 'tabstop' and 'display'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10537 When {string} contains characters with East Asian Width Class
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10538 Ambiguous, this function's return value depends on 'ambiwidth'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10539 Returns zero on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10540 Also see \|strlen()\|, \|strwidth()\| and \|strchars()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10541
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10542 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10543 GetText()->strdisplaywidth()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10544 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10545 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10546
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10547
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10548 strftime({format} [, {time}]) strftime()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10549 The result is a String, which is a formatted date and time, as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10550 specified by the {format} string. The given {time} is used,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10551 or the current time if no time is given. The accepted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10552 {format} depends on your system, thus this is not portable!
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10553 See the manual page of the C function strftime() for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10554 format. The maximum length of the result is 80 characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10555 See also \|localtime()\|, \|getftime()\| and \|strptime()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10556 The language can be changed with the \|:language\| command.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10557 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10558 :echo strftime("%c") Sun Apr 27 11:49:23 1997
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10559 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10560 :echo strftime("%y%m%d %T") 970427 11:53:55
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10561 :echo strftime("%H:%M") 11:55
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10562 :echo strftime("%c", getftime("file.c"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10563 Show mod time of file.c.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10564 < Not available on all systems. To check use: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10565 :if exists("*strftime")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10566
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10567 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10568 GetFormat()->strftime()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10569 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10570 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10571
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10572
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10573 strgetchar({str}, {index}) strgetchar()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10574 Get a Number corresponding to the character at {index} in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10575 {str}. This uses a zero-based character index, not a byte
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10576 index. Composing characters are considered separate
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10577 characters here. Use \|nr2char()\| to convert the Number to a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10578 String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10579 Returns -1 if {index} is invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10580 Also see \|strcharpart()\| and \|strchars()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10581
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10582 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10583 GetText()->strgetchar(5)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10584 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10585 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10586
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10587
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10588 stridx({haystack}, {needle} [, {start}]) stridx()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10589 The result is a Number, which gives the byte index in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10590 {haystack} of the first occurrence of the String {needle}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10591 If {start} is specified, the search starts at index {start}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10592 This can be used to find a second match: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10593 :let colon1 = stridx(line, ":")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10594 :let colon2 = stridx(line, ":", colon1 + 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10595 < The search is done case-sensitive.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10596 For pattern searches use \|match()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10597 -1 is returned if the {needle} does not occur in {haystack}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10598 See also \|strridx()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10599 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10600 :echo stridx("An Example", "Example") 3
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10601 :echo stridx("Starting point", "Start") 0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10602 :echo stridx("Starting point", "start") -1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10603 < strstr() strchr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10604 stridx() works similar to the C function strstr(). When used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10605 with a single character it works similar to strchr().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10606
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10607 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10608 GetHaystack()->stridx(needle)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10609 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10610 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10611
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10612
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10613 string({expr}) string()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10614 Return {expr} converted to a String. If {expr} is a Number,
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10615 Float, String, Blob or a composition of them, then the result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10616 can be parsed back with \|eval()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10617 {expr} type result ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10618 String 'string' (single quotes are doubled)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10619 Number 123
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10620 Float 123.123456 or 1.123456e8
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10621 Funcref function('name')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10622 Blob 0z00112233.44556677.8899
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10623 List [item, item]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10624 Dictionary {key: value, key: value}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10625 Class class SomeName
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10626 Object object of SomeName {lnum: 1, col: 3}
34676 5b25ec43f208 patch 9.1.0219: Vim9: No enum support Christian Brabandt <cb@256bit.org> parents: 34620 diff changeset	10627 Enum enum EnumName
34709 a1d0ef54a24b patch 9.1.0233: Vim9: string() output of enum is problematic Christian Brabandt <cb@256bit.org> parents: 34694 diff changeset	10628 EnumValue enum name.value {name: str, ordinal: nr}
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10629
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10630 When a \|List\| or \|Dictionary\| has a recursive reference it is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10631 replaced by "[...]" or "{...}". Using eval() on the result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10632 will then fail.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10633
34694 009989ec3ff6 runtime(doc): Improve docs for empty(), len(), and string() on objects Christian Brabandt <cb@256bit.org> parents: 34676 diff changeset	10634 For an object, invokes the string() method to get a textual
34472 5c1a025192ed patch 9.1.0148: Vim9: can't call internal methods with objects Christian Brabandt <cb@256bit.org> parents: 34463 diff changeset	10635 representation of the object. If the method is not present,
34694 009989ec3ff6 runtime(doc): Improve docs for empty(), len(), and string() on objects Christian Brabandt <cb@256bit.org> parents: 34676 diff changeset	10636 then the default representation is used. \|object-string()\|
34472 5c1a025192ed patch 9.1.0148: Vim9: can't call internal methods with objects Christian Brabandt <cb@256bit.org> parents: 34463 diff changeset	10637
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10638 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10639 mylist->string()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10640
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10641 < Also see \|strtrans()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10642
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10643 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10644
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10645
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10646 strlen({string}) strlen()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10647 The result is a Number, which is the length of the String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10648 {string} in bytes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10649 If the argument is a Number it is first converted to a String.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10650 For other types an error is given and zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10651 If you want to count the number of multibyte characters use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10652 \|strchars()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10653 Also see \|len()\|, \|strdisplaywidth()\| and \|strwidth()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10654
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10655 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10656 GetString()->strlen()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10657 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10658 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10659
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10660
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10661 strpart({src}, {start} [, {len} [, {chars}]]) strpart()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10662 The result is a String, which is part of {src}, starting from
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10663 byte {start}, with the byte length {len}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10664 When {chars} is present and TRUE then {len} is the number of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10665 characters positions (composing characters are not counted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10666 separately, thus "1" means one base character and any
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10667 following composing characters).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10668 To count {start} as characters instead of bytes use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10669 \|strcharpart()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10670
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10671 When bytes are selected which do not exist, this doesn't
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10672 result in an error, the bytes are simply omitted.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10673 If {len} is missing, the copy continues from {start} till the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10674 end of the {src}. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10675 strpart("abcdefg", 3, 2) == "de"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10676 strpart("abcdefg", -2, 4) == "ab"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10677 strpart("abcdefg", 5, 4) == "fg"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10678 strpart("abcdefg", 3) == "defg"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10679
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10680 < Note: To get the first character, {start} must be 0. For
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10681 example, to get the character under the cursor: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10682 strpart(getline("."), col(".") - 1, 1, v:true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10683 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10684 Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10685
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10686 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10687 GetText()->strpart(5)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10688 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10689 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10690
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10691
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10692 strptime({format}, {timestring}) strptime()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10693 The result is a Number, which is a unix timestamp representing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10694 the date and time in {timestring}, which is expected to match
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10695 the format specified in {format}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10696
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10697 The accepted {format} depends on your system, thus this is not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10698 portable! See the manual page of the C function strptime()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10699 for the format. Especially avoid "%c". The value of $TZ also
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10700 matters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10701
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10702 If the {timestring} cannot be parsed with {format} zero is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10703 returned. If you do not know the format of {timestring} you
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10704 can try different {format} values until you get a non-zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10705 result.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10706
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10707 See also \|strftime()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10708 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10709 :echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10710 < 862156163 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10711 :echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10712 < Sun Apr 27 11:53:55 1997 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10713 :echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10714 < Sun Apr 27 12:53:55 1997
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10715
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10716 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10717 GetFormat()->strptime(timestring)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10718 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10719 Not available on all systems. To check use: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10720 :if exists("*strptime")
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10721 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10722 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10723
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10724
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10725 strridx({haystack}, {needle} [, {start}]) strridx()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10726 The result is a Number, which gives the byte index in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10727 {haystack} of the last occurrence of the String {needle}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10728 When {start} is specified, matches beyond this index are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10729 ignored. This can be used to find a match before a previous
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10730 match: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10731 :let lastcomma = strridx(line, ",")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10732 :let comma2 = strridx(line, ",", lastcomma - 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10733 < The search is done case-sensitive.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10734 For pattern searches use \|match()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10735 -1 is returned if the {needle} does not occur in {haystack}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10736 If the {needle} is empty the length of {haystack} is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10737 See also \|stridx()\|. Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10738 :echo strridx("an angry armadillo", "an") 3
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10739 < strrchr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10740 When used with a single character it works similar to the C
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10741 function strrchr().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10742
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10743 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10744 GetHaystack()->strridx(needle)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10745 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10746 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10747
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10748
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10749 strtrans({string}) strtrans()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10750 The result is a String, which is {string} with all unprintable
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10751 characters translated into printable characters \|'isprint'\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10752 Like they are shown in a window. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10753 echo strtrans(@a)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10754 < This displays a newline in register a as "^@" instead of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10755 starting a new line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10756
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10757 Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10758
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10759 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10760 GetString()->strtrans()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10761 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10762 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10763
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10764
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10765 strutf16len({string} [, {countcc}]) strutf16len()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10766 The result is a Number, which is the number of UTF-16 code
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10767 units in String {string} (after converting it to UTF-16).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10768
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10769 When {countcc} is TRUE, composing characters are counted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10770 separately.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10771 When {countcc} is omitted or FALSE, composing characters are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10772 ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10773
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10774 Returns zero on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10775
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10776 Also see \|strlen()\| and \|strcharlen()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10777 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10778 echo strutf16len('a') returns 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10779 echo strutf16len('©') returns 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10780 echo strutf16len('😊') returns 2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10781 echo strutf16len('ą́') returns 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10782 echo strutf16len('ą́', v:true) returns 3
33334 472bf147d4ed runtime(doc): Add a missing '<' to the help of strutf16len() (#13168) Christian Brabandt <cb@256bit.org> parents: 33223 diff changeset	10783 <
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10784 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10785 GetText()->strutf16len()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10786 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10787 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10788
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10789
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10790 strwidth({string}) strwidth()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10791 The result is a Number, which is the number of display cells
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10792 String {string} occupies. A Tab character is counted as one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10793 cell, alternatively use \|strdisplaywidth()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10794 When {string} contains characters with East Asian Width Class
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10795 Ambiguous, this function's return value depends on 'ambiwidth'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10796 Returns zero on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10797 Also see \|strlen()\|, \|strdisplaywidth()\| and \|strchars()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10798
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10799 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10800 GetString()->strwidth()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10801 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10802 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10803
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10804
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10805 submatch({nr} [, {list}]) submatch() E935
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10806 Only for an expression in a \|:substitute\| command or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10807 substitute() function.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10808 Returns the {nr}'th submatch of the matched text. When {nr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10809 is 0 the whole matched text is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10810 Note that a NL in the string can stand for a line break of a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10811 multi-line match or a NUL character in the text.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10812 Also see \|sub-replace-expression\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10813
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10814 If {list} is present and non-zero then submatch() returns
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10815 a list of strings, similar to \|getline()\| with two arguments.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10816 NL characters in the text represent NUL characters in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10817 text.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10818 Only returns more than one item for \|:substitute\|, inside
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10819 \|substitute()\| this list will always contain one or zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10820 items, since there are no real line breaks.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10821
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10822 When substitute() is used recursively only the submatches in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10823 the current (deepest) call can be obtained.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10824
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10825 Returns an empty string or list on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10826
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10827 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10828 :s/\d\+/\=submatch(0) + 1/
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10829 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10830 < This finds the first number in the line and adds one to it.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10831 A line break is included as a newline character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10832
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10833 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10834 GetNr()->submatch()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10835 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10836 Return type: \|String\| or list<string> depending on {list}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10837
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10838
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10839 substitute({string}, {pat}, {sub}, {flags}) substitute()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10840 The result is a String, which is a copy of {string}, in which
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10841 the first match of {pat} is replaced with {sub}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10842 When {flags} is "g", all matches of {pat} in {string} are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10843 replaced. Otherwise {flags} should be "".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10844
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10845 This works like the ":substitute" command (without any flags).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10846 But the matching with {pat} is always done like the 'magic'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10847 option is set and 'cpoptions' is empty (to make scripts
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10848 portable). 'ignorecase' is still relevant, use \|/\c\| or \|/\C\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10849 if you want to ignore or match case and ignore 'ignorecase'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10850 'smartcase' is not used. See \|string-match\| for how {pat} is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10851 used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10852
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10853 A "~" in {sub} is not replaced with the previous {sub}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10854 Note that some codes in {sub} have a special meaning
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10855 \|sub-replace-special\|. For example, to replace something with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10856 "\n" (two characters), use "\\\\n" or '\\n'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10857
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10858 When {pat} does not match in {string}, {string} is returned
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10859 unmodified.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10860
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10861 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10862 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10863 < This removes the last component of the 'path' option. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10864 :echo substitute("testing", ".*", "\\U\\0", "")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10865 < results in "TESTING".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10866
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10867 When {sub} starts with "\=", the remainder is interpreted as
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10868 an expression. See \|sub-replace-expression\|. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10869 :echo substitute(s, '%$\x\x$',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10870 \ '\=nr2char("0x" .. submatch(1))', 'g')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10871
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10872 < When {sub} is a Funcref that function is called, with one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10873 optional argument. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10874 :echo substitute(s, '%$\x\x$', SubNr, 'g')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10875 < The optional argument is a list which contains the whole
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10876 matched string and up to nine submatches, like what
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10877 \|submatch()\| returns. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10878 :echo substitute(s, '%$\x\x$', {m -> '0x' .. m[1]}, 'g')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10879
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10880 < Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10881
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10882 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10883 GetString()->substitute(pat, sub, flags)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10884 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10885 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10886
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10887
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10888 swapfilelist() swapfilelist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10889 Returns a list of swap file names, like what "vim -r" shows.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10890 See the \|-r\| command argument. The 'directory' option is used
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10891 for the directories to inspect. If you only want to get a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10892 list of swap files in the current directory then temporarily
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10893 set 'directory' to a dot: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10894 let save_dir = &directory
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10895 let &directory = '.'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10896 let swapfiles = swapfilelist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10897 let &directory = save_dir
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10898 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10899 Return type: list<string>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10900
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10901
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10902 swapinfo({fname}) swapinfo()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10903 The result is a dictionary, which holds information about the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10904 swapfile {fname}. The available fields are:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10905 version Vim version
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10906 user user name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10907 host host name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10908 fname original file name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10909 pid PID of the Vim process that created the swap
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10910 file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10911 mtime last modification time in seconds
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10912 inode Optional: INODE number of the file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10913 dirty 1 if file was modified, 0 if not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10914 Note that "user" and "host" are truncated to at most 39 bytes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10915 In case of failure an "error" item is added with the reason:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10916 Cannot open file: file not found or in accessible
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10917 Cannot read file: cannot read first block
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10918 Not a swap file: does not contain correct block ID
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10919 Magic number mismatch: Info in first block is invalid
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10920
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10921 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10922 GetFilename()->swapinfo()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10923 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10924 Return type: dict<any> or dict<string>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10925
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10926
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10927 swapname({buf}) swapname()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10928 The result is the swap file path of the buffer {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10929 For the use of {buf}, see \|bufname()\| above.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10930 If buffer {buf} is the current buffer, the result is equal to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10931 \|:swapname\| (unless there is no swap file).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10932 If buffer {buf} has no swap file, returns an empty string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10933
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10934 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10935 GetBufname()->swapname()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10936 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10937 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10938
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10939
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10940 synID({lnum}, {col}, {trans}) synID()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10941 The result is a Number, which is the syntax ID at the position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10942 {lnum} and {col} in the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10943 The syntax ID can be used with \|synIDattr()\| and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10944 \|synIDtrans()\| to obtain syntax information about text.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10945
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10946 {col} is 1 for the leftmost column, {lnum} is 1 for the first
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10947 line. 'synmaxcol' applies, in a longer line zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10948 Note that when the position is after the last character,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10949 that's where the cursor can be in Insert mode, synID() returns
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10950 zero. {lnum} is used like with \|getline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10951
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10952 When {trans} is \|TRUE\|, transparent items are reduced to the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10953 item that they reveal. This is useful when wanting to know
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10954 the effective color. When {trans} is \|FALSE\|, the transparent
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10955 item is returned. This is useful when wanting to know which
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10956 syntax item is effective (e.g. inside parens).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10957 Warning: This function can be very slow. Best speed is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10958 obtained by going through the file in forward direction.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10959
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10960 Returns zero on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10961
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10962 Example (echoes the name of the syntax item under the cursor): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10963 :echo synIDattr(synID(line("."), col("."), 1), "name")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10964 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10965 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	10966
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10967
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10968 synIDattr({synID}, {what} [, {mode}]) synIDattr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10969 The result is a String, which is the {what} attribute of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10970 syntax ID {synID}. This can be used to obtain information
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10971 about a syntax item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10972 {mode} can be "gui", "cterm" or "term", to get the attributes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10973 for that mode. When {mode} is omitted, or an invalid value is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10974 used, the attributes for the currently active highlighting are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10975 used (GUI, cterm or term).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10976 Use synIDtrans() to follow linked highlight groups.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10977 {what} result
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10978 "name" the name of the syntax item
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10979 "fg" foreground color (GUI: color name used to set
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10980 the color, cterm: color number as a string,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10981 term: empty string)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10982 "bg" background color (as with "fg")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10983 "font" font name (only available in the GUI)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10984 \|highlight-font\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10985 "sp" special color for the GUI (as with "fg")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10986 \|highlight-guisp\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10987 "ul" underline color for cterm: number as a string
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10988 "fg#" like "fg", but for the GUI and the GUI is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10989 running the name in "#RRGGBB" form
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10990 "bg#" like "fg#" for "bg"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10991 "sp#" like "fg#" for "sp"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10992 "bold" "1" if bold
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10993 "italic" "1" if italic
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10994 "reverse" "1" if reverse
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10995 "inverse" "1" if inverse (= reverse)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10996 "standout" "1" if standout
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10997 "underline" "1" if underlined
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10998 "undercurl" "1" if undercurled
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	10999 "strike" "1" if strikethrough
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11000 "nocombine" "1" if nocombine
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11001
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11002 Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11003
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11004 Example (echoes the color of the syntax item under the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11005 cursor): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11006 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11007 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11008 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11009 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11010 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11011 Return type: \|String\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11012
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11013
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11014 synIDtrans({synID}) synIDtrans()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11015 The result is a Number, which is the translated syntax ID of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11016 {synID}. This is the syntax group ID of what is being used to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11017 highlight the character. Highlight links given with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11018 ":highlight link" are followed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11019
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11020 Returns zero on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11021
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11022 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11023 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11024 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11025 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11026
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11027
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11028 synconcealed({lnum}, {col}) synconcealed()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11029 The result is a \|List\| with currently three items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11030 1. The first item in the list is 0 if the character at the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11031 position {lnum} and {col} is not part of a concealable
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11032 region, 1 if it is. {lnum} is used like with \|getline()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11033 2. The second item in the list is a string. If the first item
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11034 is 1, the second item contains the text which will be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11035 displayed in place of the concealed text, depending on the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11036 current setting of 'conceallevel' and 'listchars'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11037 3. The third and final item in the list is a number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11038 representing the specific syntax region matched in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11039 line. When the character is not concealed the value is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11040 zero. This allows detection of the beginning of a new
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11041 concealable region if there are two consecutive regions
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11042 with the same replacement character. For an example, if
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11043 the text is "123456" and both "23" and "45" are concealed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11044 and replaced by the character "X", then:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11045 call returns ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11046 synconcealed(lnum, 1) [0, '', 0]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11047 synconcealed(lnum, 2) [1, 'X', 1]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11048 synconcealed(lnum, 3) [1, 'X', 1]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11049 synconcealed(lnum, 4) [1, 'X', 2]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11050 synconcealed(lnum, 5) [1, 'X', 2]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11051 synconcealed(lnum, 6) [0, '', 0]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11052
35051 9d38950096be runtime(doc): clarify syntax vs matching mechanism Christian Brabandt <cb@256bit.org> parents: 34797 diff changeset	11053 Note: Doesn't consider \|matchadd()\| highlighting items,
9d38950096be runtime(doc): clarify syntax vs matching mechanism Christian Brabandt <cb@256bit.org> parents: 34797 diff changeset	11054 since syntax and matching highlighting are two different
9d38950096be runtime(doc): clarify syntax vs matching mechanism Christian Brabandt <cb@256bit.org> parents: 34797 diff changeset	11055 mechanisms \|syntax-vs-match\|.
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11056 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11057 Return type: list<any>
35051 9d38950096be runtime(doc): clarify syntax vs matching mechanism Christian Brabandt <cb@256bit.org> parents: 34797 diff changeset	11058
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11059
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11060 synstack({lnum}, {col}) synstack()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11061 Return a \|List\|, which is the stack of syntax items at the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11062 position {lnum} and {col} in the current window. {lnum} is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11063 used like with \|getline()\|. Each item in the List is an ID
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11064 like what \|synID()\| returns.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11065 The first item in the List is the outer region, following are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11066 items contained in that one. The last one is what \|synID()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11067 returns, unless not the whole item is highlighted or it is a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11068 transparent item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11069 This function is useful for debugging a syntax file.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11070 Example that shows the syntax stack under the cursor: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11071 for id in synstack(line("."), col("."))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11072 echo synIDattr(id, "name")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11073 endfor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11074 < When the position specified with {lnum} and {col} is invalid
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11075 an empty List is returned. The position just after the last
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11076 character in a line and the first column in an empty line are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11077 valid positions.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11078
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11079 Return type: list<number> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11080
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11081
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11082 system({expr} [, {input}]) system() E677
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11083 Get the output of the shell command {expr} as a \|String\|. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11084 \|systemlist()\| to get the output as a \|List\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11085
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11086 When {input} is given and is a \|String\| this string is written
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11087 to a file and passed as stdin to the command. The string is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11088 written as-is, you need to take care of using the correct line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11089 separators yourself.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11090 If {input} is given and is a \|List\| it is written to the file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11091 in a way \|writefile()\| does with {binary} set to "b" (i.e.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11092 with a newline between each list item with newlines inside
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11093 list items converted to NULs).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11094 When {input} is given and is a number that is a valid id for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11095 an existing buffer then the content of the buffer is written
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11096 to the file line by line, each line terminated by a NL and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11097 NULs characters where the text has a NL.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11098
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11099 Pipes are not used, the 'shelltemp' option is not used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11100
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11101 When prepended by \|:silent\| the terminal will not be set to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11102 cooked mode. This is meant to be used for commands that do
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11103 not need the user to type. It avoids stray characters showing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11104 up on the screen which require \|CTRL-L\| to remove. >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11105 :silent let f = system('ls *.vim')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11106 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11107 Note: Use \|shellescape()\| or \|::S\| with \|expand()\| or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11108 \|fnamemodify()\| to escape special characters in a command
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11109 argument. Newlines in {expr} may cause the command to fail.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11110 The characters in 'shellquote' and 'shellxquote' may also
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11111 cause trouble.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11112 This is not to be used for interactive commands.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11113
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11114 The result is a String. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11115 :let files = system('ls ' .. shellescape(expand('%:h')))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11116 :let files = system('ls ' .. expand('%:h:S'))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11117
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11118 < To make the result more system-independent, the shell output
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11119 is filtered to replace <CR> with <NL> for Macintosh, and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11120 <CR><NL> with <NL> for DOS-like systems.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11121 To avoid the string being truncated at a NUL, all NUL
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11122 characters are replaced with SOH (0x01).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11123
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11124 The command executed is constructed using several options:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11125 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11126 ({tmp} is an automatically generated file name).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11127 For Unix, braces are put around {expr} to allow for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11128 concatenated commands.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11129
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11130 The command will be executed in "cooked" mode, so that a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11131 CTRL-C will interrupt the command (on Unix at least).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11132
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11133 The resulting error code can be found in \|v:shell_error\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11134 This function will fail in \|restricted-mode\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11135
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11136 Note that any wrong value in the options mentioned above may
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11137 make the function fail. It has also been reported to fail
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11138 when using a security agent application.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11139 Unlike ":!cmd" there is no automatic check for changed files.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11140 Use \|:checktime\| to force a check.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11141
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11142 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11143 :echo GetCmd()->system()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11144 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11145 Return type: \|String\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11146
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11147
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11148 systemlist({expr} [, {input}]) systemlist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11149 Same as \|system()\|, but returns a \|List\| with lines (parts of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11150 output separated by NL) with NULs transformed into NLs. Output
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11151 is the same as \|readfile()\| will output with {binary} argument
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11152 set to "b", except that there is no extra empty item when the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11153 result ends in a NL.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11154 Note that on MS-Windows you may get trailing CR characters.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11155
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11156 To see the difference between "echo hello" and "echo -n hello"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11157 use \|system()\| and \|split()\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11158 echo system('echo hello')->split('\n', 1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11159 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11160 Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11161
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11162 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11163 :echo GetCmd()->systemlist()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11164 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11165 Return type: list<string>
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11166
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11167
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11168 tabpagebuflist([{arg}]) tabpagebuflist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11169 The result is a \|List\|, where each item is the number of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11170 buffer associated with each window in the current tab page.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11171 {arg} specifies the number of the tab page to be used. When
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11172 omitted the current tab page is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11173 When {arg} is invalid the number zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11174 To get a list of all buffers in all tabs use this: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11175 let buflist = []
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11176 for i in range(tabpagenr('$'))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11177 call extend(buflist, tabpagebuflist(i + 1))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11178 endfor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11179 < Note that a buffer may appear in more than one window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11180
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11181 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11182 GetTabpage()->tabpagebuflist()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11183 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11184 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11185
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11186
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11187 tabpagenr([{arg}]) tabpagenr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11188 The result is a Number, which is the number of the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11189 tab page. The first tab page has number 1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11190
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11191 The optional argument {arg} supports the following values:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11192 $ the number of the last tab page (the tab page
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11193 count).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11194 # the number of the last accessed tab page
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11195 (where \|g<Tab>\| goes to). if there is no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11196 previous tab page 0 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11197 The number can be used with the \|:tab\| command.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11198
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11199 Returns zero on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11200
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11201 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11202
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11203
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11204 tabpagewinnr({tabarg} [, {arg}]) tabpagewinnr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11205 Like \|winnr()\| but for tab page {tabarg}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11206 {tabarg} specifies the number of tab page to be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11207 {arg} is used like with \|winnr()\|:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11208 - When omitted the current window number is returned. This is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11209 the window which will be used when going to this tab page.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11210 - When "$" the number of windows is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11211 - When "#" the previous window nr is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11212 Useful examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11213 tabpagewinnr(1) " current window of tab page 1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11214 tabpagewinnr(4, '$') " number of windows in tab page 4
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11215 < When {tabarg} is invalid zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11216
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11217 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11218 GetTabpage()->tabpagewinnr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11219 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11220 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11221
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11222
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11223 tagfiles() tagfiles()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11224 Returns a \|List\| with the file names used to search for tags
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11225 for the current buffer. This is the 'tags' option expanded.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11226
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11227 Return type: list<string> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11228
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11229
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11230 taglist({expr} [, {filename}]) taglist()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11231 Returns a \|List\| of tags matching the regular expression {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11232
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11233 If {filename} is passed it is used to prioritize the results
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11234 in the same way that \|:tselect\| does. See \|tag-priority\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11235 {filename} should be the full path of the file.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11236
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11237 Each list item is a dictionary with at least the following
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11238 entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11239 name Name of the tag.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11240 filename Name of the file where the tag is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11241 defined. It is either relative to the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11242 current directory or a full path.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11243 cmd Ex command used to locate the tag in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11244 the file.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11245 kind Type of the tag. The value for this
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11246 entry depends on the language specific
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11247 kind values. Only available when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11248 using a tags file generated by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11249 Universal/Exuberant ctags or hdrtag.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11250 static A file specific tag. Refer to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11251 \|static-tag\| for more information.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11252 More entries may be present, depending on the content of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11253 tags file: access, implementation, inherits and signature.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11254 Refer to the ctags documentation for information about these
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11255 fields. For C code the fields "struct", "class" and "enum"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11256 may appear, they give the name of the entity the tag is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11257 contained in.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11258
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11259 The ex-command "cmd" can be either an ex search pattern, a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11260 line number or a line number followed by a byte number.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11261
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11262 If there are no matching tags, then an empty list is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11263
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11264 To get an exact tag match, the anchors '^' and '$' should be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11265 used in {expr}. This also make the function work faster.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11266 Refer to \|tag-regexp\| for more information about the tag
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11267 search regular expression pattern.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11268
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11269 Refer to \|'tags'\| for information about how the tags file is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11270 located by Vim. Refer to \|tags-file-format\| for the format of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11271 the tags file generated by the different ctags tools.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11272
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11273 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11274 GetTagpattern()->taglist()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11275 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11276 Return type: list<dict<any>> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11277
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11278
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11279 tan({expr}) tan()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11280 Return the tangent of {expr}, measured in radians, as a \|Float\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11281 in the range [-inf, inf].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11282 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11283 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11284 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11285 :echo tan(10)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11286 < 0.648361 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11287 :echo tan(-4.01)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11288 < -1.181502
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11289
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11290 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11291 Compute()->tan()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11292 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11293 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11294
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11295
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11296 tanh({expr}) tanh()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11297 Return the hyperbolic tangent of {expr} as a \|Float\| in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11298 range [-1, 1].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11299 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11300 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11301 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11302 :echo tanh(0.5)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11303 < 0.462117 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11304 :echo tanh(-1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11305 < -0.761594
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11306
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11307 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11308 Compute()->tanh()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11309 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11310 Return type: \|Float\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11311
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11312
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11313 tempname() tempname() temp-file-name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11314 The result is a String, which is the name of a file that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11315 doesn't exist. It can be used for a temporary file. The name
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11316 is different for at least 26 consecutive calls. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11317 :let tmpfile = tempname()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11318 :exe "redir > " .. tmpfile
35200 7f5de3ce54c8 runtime(doc): clarify temporary file clean up Christian Brabandt <cb@256bit.org> parents: 35185 diff changeset	11319 < For Unix, the file will be in a private directory \|tempfile\|
7f5de3ce54c8 runtime(doc): clarify temporary file clean up Christian Brabandt <cb@256bit.org> parents: 35185 diff changeset	11320 that is recursively deleted when Vim exits, on other systems
7f5de3ce54c8 runtime(doc): clarify temporary file clean up Christian Brabandt <cb@256bit.org> parents: 35185 diff changeset	11321 temporary files are not cleaned up automatically on exit.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11322 For MS-Windows forward slashes are used when the 'shellslash'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11323 option is set, or when 'shellcmdflag' starts with '-' and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11324 'shell' does not contain powershell or pwsh.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11325
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11326 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11327
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11328
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11329 term_ functions are documented here: \|terminal-function-details\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11330
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11331
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11332 terminalprops() terminalprops()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11333 Returns a \|Dictionary\| with properties of the terminal that Vim
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11334 detected from the response to \|t_RV\| request. See
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11335 \|v:termresponse\| for the response itself. If \|v:termresponse\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11336 is empty most values here will be 'u' for unknown.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11337 cursor_style whether sending \|t_RS\| works **
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11338 cursor_blink_mode whether sending \|t_RC\| works **
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11339 underline_rgb whether \|t_8u\| works **
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11340 mouse mouse type supported
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11341 kitty whether Kitty terminal was detected
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11342
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11343 ** value 'u' for unknown, 'y' for yes, 'n' for no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11344
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11345 If the \|+termresponse\| feature is missing then the result is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11346 an empty dictionary.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11347
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11348 If "cursor_style" is 'y' then \|t_RS\| will be sent to request the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11349 current cursor style.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11350 If "cursor_blink_mode" is 'y' then \|t_RC\| will be sent to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11351 request the cursor blink status.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11352 "cursor_style" and "cursor_blink_mode" are also set if \|t_u7\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11353 is not empty, Vim will detect the working of sending \|t_RS\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11354 and \|t_RC\| on startup.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11355
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11356 When "underline_rgb" is not 'y', then \|t_8u\| will be made empty.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11357 This avoids sending it to xterm, which would clear the colors.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11358
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11359 For "mouse" the value 'u' is unknown
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11360
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11361 Also see:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11362 - 'ambiwidth' - detected by using \|t_u7\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11363 - \|v:termstyleresp\| and \|v:termblinkresp\| for the response to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11364 \|t_RS\| and \|t_RC\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11365
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11366 Return type: dict<string>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11367
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11368
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11369 test_ functions are documented here: \|test-functions-details\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11370
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11371
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11372 timer_info()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11373 timer_info([{id}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11374 Return a list with information about timers.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11375 When {id} is given only information about this timer is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11376 returned. When timer {id} does not exist an empty list is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11377 returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11378 When {id} is omitted information about all timers is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11379
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11380 For each timer the information is stored in a \|Dictionary\| with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11381 these items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11382 "id" the timer ID
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11383 "time" time the timer was started with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11384 "remaining" time until the timer fires
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11385 "repeat" number of times the timer will still fire;
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11386 -1 means forever
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11387 "callback" the callback
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11388 "paused" 1 if the timer is paused, 0 otherwise
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11389
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11390 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11391 GetTimer()->timer_info()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11392 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11393 Return type: list<dict<any>> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11394
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11395 {only available when compiled with the \|+timers\| feature}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11396
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11397
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11398 timer_pause({timer}, {paused}) timer_pause()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11399 Pause or unpause a timer. A paused timer does not invoke its
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11400 callback when its time expires. Unpausing a timer may cause
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11401 the callback to be invoked almost immediately if enough time
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11402 has passed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11403
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11404 Pausing a timer is useful to avoid the callback to be called
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11405 for a short time.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11406
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11407 If {paused} evaluates to a non-zero Number or a non-empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11408 String, then the timer is paused, otherwise it is unpaused.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11409 See \|non-zero-arg\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11410
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11411 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11412 GetTimer()->timer_pause(1)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11413 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11414 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11415
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11416 {only available when compiled with the \|+timers\| feature}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11417
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11418
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11419 timer_start() timer timers
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11420 timer_start({time}, {callback} [, {options}])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11421 Create a timer and return the timer ID.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11422
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11423 {time} is the waiting time in milliseconds. This is the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11424 minimum time before invoking the callback. When the system is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11425 busy or Vim is not waiting for input the time will be longer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11426 Zero can be used to execute the callback when Vim is back in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11427 the main loop.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11428
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11429 {callback} is the function to call. It can be the name of a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11430 function or a \|Funcref\|. It is called with one argument, which
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11431 is the timer ID. The callback is only invoked when Vim is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11432 waiting for input.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11433 If you want to show a message look at \|popup_notification()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11434 to avoid interfering with what the user is doing.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11435
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11436 {options} is a dictionary. Supported entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11437 "repeat" Number of times to repeat calling the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11438 callback. -1 means forever. When not present
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11439 the callback will be called once.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11440 If the timer causes an error three times in a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11441 row the repeat is cancelled. This avoids that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11442 Vim becomes unusable because of all the error
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11443 messages.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11444
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11445 Returns -1 on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11446
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11447 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11448 func MyHandler(timer)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11449 echo 'Handler called'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11450 endfunc
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11451 let timer = timer_start(500, 'MyHandler',
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11452 \ {'repeat': 3})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11453 < This will invoke MyHandler() three times at 500 msec
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11454 intervals.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11455
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11456 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11457 GetMsec()->timer_start(callback)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11458
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11459 < Not available in the \|sandbox\|.
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11460
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11461 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11462
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11463 {only available when compiled with the \|+timers\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11464
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11465
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11466 timer_stop({timer}) timer_stop()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11467 Stop a timer. The timer callback will no longer be invoked.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11468 {timer} is an ID returned by timer_start(), thus it must be a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11469 Number. If {timer} does not exist there is no error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11470
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11471 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11472 GetTimer()->timer_stop()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11473 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11474 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11475
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11476 {only available when compiled with the \|+timers\| feature}
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11477
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11478
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11479 timer_stopall() timer_stopall()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11480 Stop all timers. The timer callbacks will no longer be
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11481 invoked. Useful if a timer is misbehaving. If there are no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11482 timers there is no error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11483
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11484 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11485
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11486 {only available when compiled with the \|+timers\| feature}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11487
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11488
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11489 tolower({expr}) tolower()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11490 The result is a copy of the String given, with all uppercase
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11491 characters turned into lowercase (just like applying \|gu\| to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11492 the string). Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11493
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11494 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11495 GetText()->tolower()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11496 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11497 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11498
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11499
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11500 toupper({expr}) toupper()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11501 The result is a copy of the String given, with all lowercase
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11502 characters turned into uppercase (just like applying \|gU\| to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11503 the string). Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11504
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11505 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11506 GetText()->toupper()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11507 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11508 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11509
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11510
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11511 tr({src}, {fromstr}, {tostr}) tr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11512 The result is a copy of the {src} string with all characters
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11513 which appear in {fromstr} replaced by the character in that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11514 position in the {tostr} string. Thus the first character in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11515 {fromstr} is translated into the first character in {tostr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11516 and so on. Exactly like the unix "tr" command.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11517 This code also deals with multibyte characters properly.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11518
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11519 Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11520
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11521 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11522 echo tr("hello there", "ht", "HT")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11523 < returns "Hello THere" >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11524 echo tr("<blob>", "<>", "{}")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11525 < returns "{blob}"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11526
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11527 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11528 GetText()->tr(from, to)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11529 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11530 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11531
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11532
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11533 trim({text} [, {mask} [, {dir}]]) trim()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11534 Return {text} as a String where any character in {mask} is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11535 removed from the beginning and/or end of {text}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11536
33594 e9c70470fe94 patch 9.0.2041: trim(): hard to use default mask Christian Brabandt <cb@256bit.org> parents: 33591 diff changeset	11537 If {mask} is not given, or is an empty string, {mask} is all
e9c70470fe94 patch 9.0.2041: trim(): hard to use default mask Christian Brabandt <cb@256bit.org> parents: 33591 diff changeset	11538 characters up to 0x20, which includes Tab, space, NL and CR,
e9c70470fe94 patch 9.0.2041: trim(): hard to use default mask Christian Brabandt <cb@256bit.org> parents: 33591 diff changeset	11539 plus the non-breaking space character 0xa0.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11540
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11541 The optional {dir} argument specifies where to remove the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11542 characters:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11543 0 remove from the beginning and end of {text}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11544 1 remove only at the beginning of {text}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11545 2 remove only at the end of {text}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11546 When omitted both ends are trimmed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11547
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11548 This function deals with multibyte characters properly.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11549 Returns an empty string on error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11550
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11551 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11552 echo trim(" some text ")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11553 < returns "some text" >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11554 echo trim(" \r\t\t\r RESERVE \t\n\x0B\xA0") .. "_TAIL"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11555 < returns "RESERVE_TAIL" >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11556 echo trim("rm<Xrm<>X>rrm", "rm<>")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11557 < returns "Xrm<>X" (characters in the middle are not removed) >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11558 echo trim(" vim ", " ", 2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11559 < returns " vim"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11560
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11561 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11562 GetText()->trim()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11563 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11564 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11565
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11566
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11567 trunc({expr}) trunc()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11568 Return the largest integral value with magnitude less than or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11569 equal to {expr} as a \|Float\| (truncate towards zero).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11570 {expr} must evaluate to a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11571 Returns 0.0 if {expr} is not a \|Float\| or a \|Number\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11572 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11573 echo trunc(1.456)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11574 < 1.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11575 echo trunc(-5.456)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11576 < -5.0 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11577 echo trunc(4.0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11578 < 4.0
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11579
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11580 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11581 Compute()->trunc()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11582 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11583 Return type: \|Float\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11584
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11585
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11586 type()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11587 type({expr}) The result is a Number representing the type of {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11588 Instead of using the number directly, it is better to use the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11589 v:t_ variable that has the value:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11590 Number: 0 \|v:t_number\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11591 String: 1 \|v:t_string\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11592 Funcref: 2 \|v:t_func\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11593 List: 3 \|v:t_list\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11594 Dictionary: 4 \|v:t_dict\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11595 Float: 5 \|v:t_float\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11596 Boolean: 6 \|v:t_bool\| (v:false and v:true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11597 None: 7 \|v:t_none\| (v:null and v:none)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11598 Job: 8 \|v:t_job\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11599 Channel: 9 \|v:t_channel\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11600 Blob: 10 \|v:t_blob\|
33798 af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	11601 Class: 12 \|v:t_class\|
af1b18018eeb runtime(doc): Fix whitespace and formatting of some help files (#13549) Christian Brabandt <cb@256bit.org> parents: 33649 diff changeset	11602 Object: 13 \|v:t_object\|
33931 050160b94f02 patch 9.0.2162: Vim9: type documentation out-dated Christian Brabandt <cb@256bit.org> parents: 33924 diff changeset	11603 Typealias: 14 \|v:t_typealias\|
34676 5b25ec43f208 patch 9.1.0219: Vim9: No enum support Christian Brabandt <cb@256bit.org> parents: 34620 diff changeset	11604 Enum: 15 \|v:t_enum\|
5b25ec43f208 patch 9.1.0219: Vim9: No enum support Christian Brabandt <cb@256bit.org> parents: 34620 diff changeset	11605 EnumValue: 16 \|v:t_enumvalue\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11606 For backward compatibility, this method can be used: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11607 :if type(myvar) == type(0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11608 :if type(myvar) == type("")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11609 :if type(myvar) == type(function("tr"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11610 :if type(myvar) == type([])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11611 :if type(myvar) == type({})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11612 :if type(myvar) == type(0.0)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11613 :if type(myvar) == type(v:false)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11614 :if type(myvar) == type(v:none)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11615 < To check if the v:t_ variables exist use this: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11616 :if exists('v:t_number')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11617
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11618 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11619 mylist->type()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11620 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11621 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11622
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11623
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11624 typename({expr}) typename()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11625 Return a string representation of the type of {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11626 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11627 echo typename([1, 2, 3])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11628 < list<number> ~
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11629
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11630 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11631
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11632
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11633 undofile({name}) undofile()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11634 Return the name of the undo file that would be used for a file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11635 with name {name} when writing. This uses the 'undodir'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11636 option, finding directories that exist. It does not check if
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11637 the undo file exists.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11638 {name} is always expanded to the full path, since that is what
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11639 is used internally.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11640 If {name} is empty undofile() returns an empty string, since a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11641 buffer without a file name will not write an undo file.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11642 Useful in combination with \|:wundo\| and \|:rundo\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11643 When compiled without the \|+persistent_undo\| option this always
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11644 returns an empty string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11645
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11646 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11647 GetFilename()->undofile()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11648 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11649 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11650
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11651
32732 257ab4ee8e4a patch 9.0.1686: undotree() only works for the current buffer Christian Brabandt <cb@256bit.org> parents: 32711 diff changeset	11652 undotree([{buf}]) undotree()
257ab4ee8e4a patch 9.0.1686: undotree() only works for the current buffer Christian Brabandt <cb@256bit.org> parents: 32711 diff changeset	11653 Return the current state of the undo tree for the current
257ab4ee8e4a patch 9.0.1686: undotree() only works for the current buffer Christian Brabandt <cb@256bit.org> parents: 32711 diff changeset	11654 buffer, or for a specific buffer if {buf} is given. The
257ab4ee8e4a patch 9.0.1686: undotree() only works for the current buffer Christian Brabandt <cb@256bit.org> parents: 32711 diff changeset	11655 result is a dictionary with the following items:
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11656 "seq_last" The highest undo sequence number used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11657 "seq_cur" The sequence number of the current position in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11658 the undo tree. This differs from "seq_last"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11659 when some changes were undone.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11660 "time_cur" Time last used for \|:earlier\| and related
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11661 commands. Use \|strftime()\| to convert to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11662 something readable.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11663 "save_last" Number of the last file write. Zero when no
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11664 write yet.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11665 "save_cur" Number of the current position in the undo
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11666 tree.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11667 "synced" Non-zero when the last undo block was synced.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11668 This happens when waiting from input from the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11669 user. See \|undo-blocks\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11670 "entries" A list of dictionaries with information about
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11671 undo blocks.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11672
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11673 The first item in the "entries" list is the oldest undo item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11674 Each List item is a \|Dictionary\| with these items:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11675 "seq" Undo sequence number. Same as what appears in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11676 \|:undolist\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11677 "time" Timestamp when the change happened. Use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11678 \|strftime()\| to convert to something readable.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11679 "newhead" Only appears in the item that is the last one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11680 that was added. This marks the last change
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11681 and where further changes will be added.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11682 "curhead" Only appears in the item that is the last one
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11683 that was undone. This marks the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11684 position in the undo tree, the block that will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11685 be used by a redo command. When nothing was
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11686 undone after the last change this item will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11687 not appear anywhere.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11688 "save" Only appears on the last block before a file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11689 write. The number is the write count. The
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11690 first write has number 1, the last one the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11691 "save_last" mentioned above.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11692 "alt" Alternate entry. This is again a List of undo
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11693 blocks. Each item may again have an "alt"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11694 item.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11695
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11696 Return type: dict<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11697
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11698
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11699 uniq({list} [, {func} [, {dict}]]) uniq() E882
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11700 Remove second and succeeding copies of repeated adjacent
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11701 {list} items in-place. Returns {list}. If you want a list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11702 to remain unmodified make a copy first: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11703 :let newlist = uniq(copy(mylist))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11704 < The default compare function uses the string representation of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11705 each item. For the use of {func} and {dict} see \|sort()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11706
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11707 Returns zero if {list} is not a \|List\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11708
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11709 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11710 mylist->uniq()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11711 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11712 Return type: list<{type}>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11713
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11714
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11715 utf16idx()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11716 utf16idx({string}, {idx} [, {countcc} [, {charidx}]])
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11717 Same as \|charidx()\| but returns the UTF-16 code unit index of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11718 the byte at {idx} in {string} (after converting it to UTF-16).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11719
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11720 When {charidx} is present and TRUE, {idx} is used as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11721 character index in the String {string} instead of as the byte
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11722 index.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11723 An {idx} in the middle of a UTF-8 sequence is rounded
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11724 downwards to the beginning of that sequence.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11725
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11726 Returns -1 if the arguments are invalid or if there are less
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11727 than {idx} bytes in {string}. If there are exactly {idx} bytes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11728 the length of the string in UTF-16 code units is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11729
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11730 See \|byteidx()\| and \|byteidxcomp()\| for getting the byte index
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11731 from the UTF-16 index and \|charidx()\| for getting the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11732 character index from the UTF-16 index.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11733 Refer to \|string-offset-encoding\| for more information.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11734 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11735 echo utf16idx('a😊😊', 3) returns 2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11736 echo utf16idx('a😊😊', 7) returns 4
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11737 echo utf16idx('a😊😊', 1, 0, 1) returns 2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11738 echo utf16idx('a😊😊', 2, 0, 1) returns 4
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11739 echo utf16idx('aą́c', 6) returns 2
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11740 echo utf16idx('aą́c', 6, 1) returns 4
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11741 echo utf16idx('a😊😊', 9) returns -1
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11742 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11743 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11744 GetName()->utf16idx(idx)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11745 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11746 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11747
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11748
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11749 values({dict}) values()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11750 Return a \|List\| with all the values of {dict}. The \|List\| is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11751 in arbitrary order. Also see \|items()\| and \|keys()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11752 Returns zero if {dict} is not a \|Dict\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11753
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11754 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11755 mydict->values()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11756 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11757 Return type: list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11758
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11759
32830 6e53cf9745f4 patch 9.0.1728: missing winid argument for virtcol() Christian Brabandt <cb@256bit.org> parents: 32828 diff changeset	11760 virtcol({expr} [, {list} [, {winid}]]) virtcol()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11761 The result is a Number, which is the screen column of the file
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11762 position given with {expr}. That is, the last screen position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11763 occupied by the character at that position, when the screen
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11764 would be of unlimited width. When there is a <Tab> at the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11765 position, the returned Number will be the column at the end of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11766 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11767 set to 8, it returns 8. \|conceal\| is ignored.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11768 For the byte position use \|col()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11769
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	11770 For the use of {expr} see \|getpos()\| and \|col()\|.
35386 57a8e2f92efd runtime(doc): restore description of "$" in col() and virtcol() (#14981) Christian Brabandt <cb@256bit.org> parents: 35385 diff changeset	11771 When {expr} is "$", it means the end of the cursor line, so
57a8e2f92efd runtime(doc): restore description of "$" in col() and virtcol() (#14981) Christian Brabandt <cb@256bit.org> parents: 35385 diff changeset	11772 the result is the number of cells in the cursor line plus one.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11773
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11774 When 'virtualedit' is used {expr} can be [lnum, col, off],
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11775 where "off" is the offset in screen columns from the start of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11776 the character. E.g., a position within a <Tab> or after the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11777 last character. When "off" is omitted zero is used. When
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11778 Virtual editing is active in the current mode, a position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11779 beyond the end of the line can be returned. Also see
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11780 \|'virtualedit'\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11781
32830 6e53cf9745f4 patch 9.0.1728: missing winid argument for virtcol() Christian Brabandt <cb@256bit.org> parents: 32828 diff changeset	11782 If {list} is present and non-zero then virtcol() returns a
6e53cf9745f4 patch 9.0.1728: missing winid argument for virtcol() Christian Brabandt <cb@256bit.org> parents: 32828 diff changeset	11783 List with the first and last screen position occupied by the
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11784 character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11785
32830 6e53cf9745f4 patch 9.0.1728: missing winid argument for virtcol() Christian Brabandt <cb@256bit.org> parents: 32828 diff changeset	11786 With the optional {winid} argument the values are obtained for
6e53cf9745f4 patch 9.0.1728: missing winid argument for virtcol() Christian Brabandt <cb@256bit.org> parents: 32828 diff changeset	11787 that window instead of the current window.
6e53cf9745f4 patch 9.0.1728: missing winid argument for virtcol() Christian Brabandt <cb@256bit.org> parents: 32828 diff changeset	11788
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11789 Note that only marks in the current file can be used.
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	11790
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11791 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11792 " With text "foo^Lbar" and cursor on the "^L":
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11793
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11794 virtcol(".") " returns 5
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11795 virtcol(".", 1) " returns [4, 5]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11796 virtcol("$") " returns 9
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11797
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11798 " With text " there", with 't at 'h':
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11799
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11800 virtcol("'t") " returns 6
35385 c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	11801 <
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	11802 The first column is 1. 0 or [0, 0] is returned for an error.
c4a1643cbd0d runtime(doc): deduplicate getpos(), line(), col(), virtcol() Christian Brabandt <cb@256bit.org> parents: 35373 diff changeset	11803
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11804 A more advanced example that echoes the maximum length of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11805 all lines: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11806 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11807
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11808 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11809 GetPos()->virtcol()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11810 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11811 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11812
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11813
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11814 virtcol2col({winid}, {lnum}, {col}) virtcol2col()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11815 The result is a Number, which is the byte index of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11816 character in window {winid} at buffer line {lnum} and virtual
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11817 column {col}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11818
33549 bfe07ef45143 patch 9.0.2022: getmousepos() returns wrong index for TAB char Christian Brabandt <cb@256bit.org> parents: 33493 diff changeset	11819 If buffer line {lnum} is an empty line, 0 is returned.
bfe07ef45143 patch 9.0.2022: getmousepos() returns wrong index for TAB char Christian Brabandt <cb@256bit.org> parents: 33493 diff changeset	11820
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11821 If {col} is greater than the last virtual column in line
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11822 {lnum}, then the byte index of the character at the last
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11823 virtual column is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11824
32801 6e1734ac14eb patch 9.0.1717: virtcol2col returns last byte of a multi-byte char Christian Brabandt <cb@256bit.org> parents: 32775 diff changeset	11825 For a multi-byte character, the column number of the first
6e1734ac14eb patch 9.0.1717: virtcol2col returns last byte of a multi-byte char Christian Brabandt <cb@256bit.org> parents: 32775 diff changeset	11826 byte in the character is returned.
6e1734ac14eb patch 9.0.1717: virtcol2col returns last byte of a multi-byte char Christian Brabandt <cb@256bit.org> parents: 32775 diff changeset	11827
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11828 The {winid} argument can be the window number or the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11829 \|window-ID\|. If this is zero, then the current window is used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11830
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11831 Returns -1 if the window {winid} doesn't exist or the buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11832 line {lnum} or virtual column {col} is invalid.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11833
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11834 See also \|screenpos()\|, \|virtcol()\| and \|col()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11835
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11836 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11837 GetWinid()->virtcol2col(lnum, col)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11838 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11839 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11840
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11841
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11842 visualmode([{expr}]) visualmode()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11843 The result is a String, which describes the last Visual mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11844 used in the current buffer. Initially it returns an empty
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11845 string, but once Visual mode has been used, it returns "v",
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11846 "V", or "<CTRL-V>" (a single CTRL-V character) for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11847 character-wise, line-wise, or block-wise Visual mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11848 respectively.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11849 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11850 :exe "normal " .. visualmode()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11851 < This enters the same Visual mode as before. It is also useful
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11852 in scripts if you wish to act differently depending on the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11853 Visual mode that was used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11854 If Visual mode is active, use \|mode()\| to get the Visual mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11855 (e.g., in a \|:vmap\|).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11856 If {expr} is supplied and it evaluates to a non-zero Number or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11857 a non-empty String, then the Visual mode will be cleared and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11858 the old value is returned. See \|non-zero-arg\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11859
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11860 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11861
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11862
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11863 wildmenumode() wildmenumode()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11864 Returns \|TRUE\| when the wildmenu is active and \|FALSE\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11865 otherwise. See 'wildmenu' and 'wildmode'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11866 This can be used in mappings to handle the 'wildcharm' option
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11867 gracefully. (Makes only sense with \|mapmode-c\| mappings).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11868
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11869 For example to make <c-j> work like <down> in wildmode, use: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11870 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11871 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11872 (Note, this needs the 'wildcharm' option set appropriately).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11873
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11874 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11875
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11876
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11877 win_execute({id}, {command} [, {silent}]) win_execute()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11878 Like `execute()` but in the context of window {id}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11879 The window will temporarily be made the current window,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11880 without triggering autocommands or changing directory. When
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11881 executing {command} autocommands will be triggered, this may
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11882 have unexpected side effects. Use `:noautocmd` if needed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11883 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11884 call win_execute(winid, 'set syntax=python')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11885 < Doing the same with `setwinvar()` would not trigger
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11886 autocommands and not actually show syntax highlighting.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11887 E994
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11888 Not all commands are allowed in popup windows.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11889 When window {id} does not exist then no error is given and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11890 an empty string is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11891
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11892 Can also be used as a \|method\|, the base is passed as the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11893 second argument: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11894 GetCommand()->win_execute(winid)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11895 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11896 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11897
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11898
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11899 win_findbuf({bufnr}) win_findbuf()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11900 Returns a \|List\| with \|window-ID\|s for windows that contain
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11901 buffer {bufnr}. When there is none the list is empty.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11902
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11903 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11904 GetBufnr()->win_findbuf()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11905 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11906 Return type: list<number> or list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11907
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11908
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11909 win_getid([{win} [, {tab}]]) win_getid()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11910 Get the \|window-ID\| for the specified window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11911 When {win} is missing use the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11912 With {win} this is the window number. The top window has
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11913 number 1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11914 Without {tab} use the current tab, otherwise the tab with
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11915 number {tab}. The first tab has number one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11916 Return zero if the window cannot be found.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11917
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11918 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11919 GetWinnr()->win_getid()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11920 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11921 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11922
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11923
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11924 win_gettype([{nr}]) win_gettype()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11925 Return the type of the window:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11926 "autocmd" autocommand window. Temporary window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11927 used to execute autocommands.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11928 "command" command-line window \|cmdwin\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11929 (empty) normal window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11930 "loclist" \|location-list-window\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11931 "popup" popup window \|popup\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11932 "preview" preview window \|preview-window\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11933 "quickfix" \|quickfix-window\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11934 "unknown" window {nr} not found
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11935
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11936 When {nr} is omitted return the type of the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11937 When {nr} is given return the type of this window by number or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11938 \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11939
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11940 Also see the 'buftype' option. When running a terminal in a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11941 popup window then 'buftype' is "terminal" and win_gettype()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11942 returns "popup".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11943
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11944 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11945 GetWinid()->win_gettype()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11946 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11947 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11948
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11949
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11950 win_gotoid({expr}) win_gotoid()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11951 Go to window with ID {expr}. This may also change the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11952 tabpage.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11953 Return TRUE if successful, FALSE if the window cannot be found.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11954
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11955 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11956 GetWinid()->win_gotoid()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11957 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11958 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11959
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11960
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11961 win_id2tabwin({expr}) win_id2tabwin()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11962 Return a list with the tab number and window number of window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11963 with ID {expr}: [tabnr, winnr].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11964 Return [0, 0] if the window cannot be found.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11965
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11966 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11967 GetWinid()->win_id2tabwin()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11968 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11969 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11970
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11971
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11972 win_id2win({expr}) win_id2win()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11973 Return the window number of window with ID {expr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11974 Return 0 if the window cannot be found in the current tabpage.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11975
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11976 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11977 GetWinid()->win_id2win()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11978 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11979 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11980
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11981
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11982 win_move_separator({nr}, {offset}) win_move_separator()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11983 Move window {nr}'s vertical separator (i.e., the right border)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11984 by {offset} columns, as if being dragged by the mouse. {nr}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11985 can be a window number or \|window-ID\|. A positive {offset}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11986 moves right and a negative {offset} moves left. Moving a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11987 window's vertical separator will change the width of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11988 window and the width of other windows adjacent to the vertical
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11989 separator. The magnitude of movement may be smaller than
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11990 specified (e.g., as a consequence of maintaining
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11991 'winminwidth'). Returns TRUE if the window can be found and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11992 FALSE otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11993 This will fail for the rightmost window and a full-width
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11994 window, since it has no separator on the right.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11995 Only works for the current tab page. E1308
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11996
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11997 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	11998 GetWinnr()->win_move_separator(offset)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	11999 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12000 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12001
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12002
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12003 win_move_statusline({nr}, {offset}) win_move_statusline()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12004 Move window {nr}'s status line (i.e., the bottom border) by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12005 {offset} rows, as if being dragged by the mouse. {nr} can be a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12006 window number or \|window-ID\|. A positive {offset} moves down
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12007 and a negative {offset} moves up. Moving a window's status
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12008 line will change the height of the window and the height of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12009 other windows adjacent to the status line. The magnitude of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12010 movement may be smaller than specified (e.g., as a consequence
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12011 of maintaining 'winminheight'). Returns TRUE if the window can
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12012 be found and FALSE otherwise.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12013 Only works for the current tab page.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12014
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12015 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12016 GetWinnr()->win_move_statusline(offset)
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12017 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12018 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12019
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12020
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12021 win_screenpos({nr}) win_screenpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12022 Return the screen position of window {nr} as a list with two
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12023 numbers: [row, col]. The first window always has position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12024 [1, 1], unless there is a tabline, then it is [2, 1].
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12025 {nr} can be the window number or the \|window-ID\|. Use zero
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12026 for the current window.
34548 db67c09ccd53 patch 9.1.0175: wrong window positions with 'winfix{width,height}' Christian Brabandt <cb@256bit.org> parents: 34542 diff changeset	12027 Returns [0, 0] if the window cannot be found.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12028
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12029 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12030 GetWinid()->win_screenpos()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12031 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12032 Return type: list<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12033
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12034
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12035 win_splitmove({nr}, {target} [, {options}]) win_splitmove()
34381 4e0da2b33607 patch 9.1.0117: Stop split-moving from firing WinNew and WinNewPre autocommands Christian Brabandt <cb@256bit.org> parents: 34332 diff changeset	12036 Temporarily switch to window {target}, then move window {nr}
4e0da2b33607 patch 9.1.0117: Stop split-moving from firing WinNew and WinNewPre autocommands Christian Brabandt <cb@256bit.org> parents: 34332 diff changeset	12037 to a new split adjacent to {target}.
4e0da2b33607 patch 9.1.0117: Stop split-moving from firing WinNew and WinNewPre autocommands Christian Brabandt <cb@256bit.org> parents: 34332 diff changeset	12038 Unlike commands such as \|:split\|, no new windows are created
4e0da2b33607 patch 9.1.0117: Stop split-moving from firing WinNew and WinNewPre autocommands Christian Brabandt <cb@256bit.org> parents: 34332 diff changeset	12039 (the \|window-ID\| of window {nr} is unchanged after the move).
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12040
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12041 Both {nr} and {target} can be window numbers or \|window-ID\|s.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12042 Both must be in the current tab page.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12043
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12044 Returns zero for success, non-zero for failure.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12045
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12046 {options} is a \|Dictionary\| with the following optional entries:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12047 "vertical" When TRUE, the split is created vertically,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12048 like with \|:vsplit\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12049 "rightbelow" When TRUE, the split is made below or to the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12050 right (if vertical). When FALSE, it is done
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12051 above or to the left (if vertical). When not
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12052 present, the values of 'splitbelow' and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12053 'splitright' are used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12054
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12055 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12056 GetWinid()->win_splitmove(target)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12057 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12058 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12059
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12060
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12061 winbufnr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12062 winbufnr({nr}) The result is a Number, which is the number of the buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12063 associated with window {nr}. {nr} can be the window number or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12064 the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12065 When {nr} is zero, the number of the buffer in the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12066 window is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12067 When window {nr} doesn't exist, -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12068 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12069 :echo "The file in the current window is " . bufname(winbufnr(0))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12070 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12071 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12072 FindWindow()->winbufnr()->bufname()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12073 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12074 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12075
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12076
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12077 wincol()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12078 wincol() The result is a Number, which is the virtual column of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12079 cursor in the window. This is counting screen cells from the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12080 left side of the window. The leftmost column is one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12081
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12082 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12083
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12084
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12085 windowsversion()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12086 windowsversion()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12087 The result is a String. For MS-Windows it indicates the OS
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12088 version. E.g, Windows 10 is "10.0", Windows 8 is "6.2",
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12089 Windows XP is "5.1". For non-MS-Windows systems the result is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12090 an empty string.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12091
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12092 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12093
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12094 winheight({nr}) winheight()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12095 The result is a Number, which is the height of window {nr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12096 {nr} can be the window number or the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12097 When {nr} is zero, the height of the current window is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12098 returned. When window {nr} doesn't exist, -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12099 An existing window always has a height of zero or more.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12100 This excludes any window toolbar line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12101 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12102 :echo "The current window has " .. winheight(0) .. " lines."
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12103
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12104 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12105 GetWinid()->winheight()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12106 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12107 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12108
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12109
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12110 winlayout([{tabnr}]) winlayout()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12111 The result is a nested List containing the layout of windows
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12112 in a tabpage.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12113
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12114 Without {tabnr} use the current tabpage, otherwise the tabpage
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12115 with number {tabnr}. If the tabpage {tabnr} is not found,
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12116 returns an empty list.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12117
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12118 For a leaf window, it returns:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12119 ['leaf', {winid}]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12120 For horizontally split windows, which form a column, it
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12121 returns:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12122 ['col', [{nested list of windows}]]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12123 For vertically split windows, which form a row, it returns:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12124 ['row', [{nested list of windows}]]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12125
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12126 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12127 " Only one window in the tab page
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12128 :echo winlayout()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12129 ['leaf', 1000]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12130 " Two horizontally split windows
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12131 :echo winlayout()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12132 ['col', [['leaf', 1000], ['leaf', 1001]]]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12133 " The second tab page, with three horizontally split
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12134 " windows, with two vertically split windows in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12135 " middle window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12136 :echo winlayout(2)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12137 ['col', [['leaf', 1002], ['row', [['leaf', 1003],
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12138 ['leaf', 1001]]], ['leaf', 1000]]]
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12139 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12140 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12141 GetTabnr()->winlayout()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12142 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12143 Return type: list<any>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12144
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12145
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12146 winline() winline()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12147 The result is a Number, which is the screen line of the cursor
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12148 in the window. This is counting screen lines from the top of
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12149 the window. The first line is one.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12150 If the cursor was moved the view on the file will be updated
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12151 first, this may cause a scroll.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12152
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12153 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12154
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12155
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12156 winnr([{arg}]) winnr()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12157 The result is a Number, which is the number of the current
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12158 window. The top window has number 1.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12159 Returns zero for a popup window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12160
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12161 The optional argument {arg} supports the following values:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12162 $ the number of the last window (the window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12163 count).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12164 # the number of the last accessed window (where
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12165 \|CTRL-W_p\| goes to). If there is no previous
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12166 window or it is in another tab page 0 is
34536 ad6cd802579d patch 9.1.0170: Re-allow curwin == prevwin, but document it instead Christian Brabandt <cb@256bit.org> parents: 34502 diff changeset	12167 returned. May refer to the current window in
ad6cd802579d patch 9.1.0170: Re-allow curwin == prevwin, but document it instead Christian Brabandt <cb@256bit.org> parents: 34502 diff changeset	12168 some cases (e.g. when evaluating 'statusline'
ad6cd802579d patch 9.1.0170: Re-allow curwin == prevwin, but document it instead Christian Brabandt <cb@256bit.org> parents: 34502 diff changeset	12169 expressions).
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12170 {N}j the number of the Nth window below the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12171 current window (where \|CTRL-W_j\| goes to).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12172 {N}k the number of the Nth window above the current
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12173 window (where \|CTRL-W_k\| goes to).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12174 {N}h the number of the Nth window left of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12175 current window (where \|CTRL-W_h\| goes to).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12176 {N}l the number of the Nth window right of the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12177 current window (where \|CTRL-W_l\| goes to).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12178 The number can be used with \|CTRL-W_w\| and ":wincmd w"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12179 \|:wincmd\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12180 When {arg} is invalid an error is given and zero is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12181 Also see \|tabpagewinnr()\| and \|win_getid()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12182 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12183 let window_count = winnr('$')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12184 let prev_window = winnr('#')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12185 let wnum = winnr('3k')
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12186
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12187 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12188 GetWinval()->winnr()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12189 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12190 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12191
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12192
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12193 winrestcmd() winrestcmd()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12194 Returns a sequence of \|:resize\| commands that should restore
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12195 the current window sizes. Only works properly when no windows
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12196 are opened or closed and the current window and tab page is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12197 unchanged.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12198 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12199 :let cmd = winrestcmd()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12200 :call MessWithWindowSizes()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12201 :exe cmd
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12202 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12203 Return type: \|String\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12204
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12205
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12206 winrestview({dict}) winrestview()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12207 Uses the \|Dictionary\| returned by \|winsaveview()\| to restore
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12208 the view of the current window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12209 Note: The {dict} does not have to contain all values, that are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12210 returned by \|winsaveview()\|. If values are missing, those
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12211 settings won't be restored. So you can use: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12212 :call winrestview({'curswant': 4})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12213 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12214 This will only set the curswant value (the column the cursor
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12215 wants to move on vertical movements) of the cursor to column 5
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12216 (yes, that is 5), while all other settings will remain the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12217 same. This is useful, if you set the cursor position manually.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12218
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12219 If you have changed the values the result is unpredictable.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12220 If the window size changed the result won't be the same.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12221
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12222 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12223 GetView()->winrestview()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12224 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12225 Return type: \|Number\|
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12226
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12227
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12228 winsaveview() winsaveview()
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12229 Returns a \|Dictionary\| that contains information to restore
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12230 the view of the current window. Use \|winrestview()\| to
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12231 restore the view.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12232 This is useful if you have a mapping that jumps around in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12233 buffer and you want to go back to the original view.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12234 This does not save fold information. Use the 'foldenable'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12235 option to temporarily switch off folding, so that folds are
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12236 not opened when moving around. This may have side effects.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12237 The return value includes:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12238 lnum cursor line number
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12239 col cursor column (Note: the first column
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12240 zero, as opposed to what \|getcurpos()\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12241 returns)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12242 coladd cursor column offset for 'virtualedit'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12243 curswant column for vertical movement (Note:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12244 the first column is zero, as opposed
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12245 to what \|getcurpos()\| returns). After
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12246 \|$\| command it will be a very large
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12247 number equal to \|v:maxcol\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12248 topline first line in the window
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12249 topfill filler lines, only in diff mode
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12250 leftcol first column displayed; only used when
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12251 'wrap' is off
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12252 skipcol columns skipped
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12253 Note that no option values are saved.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12254
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12255 Return type: dict<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12256
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12257
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12258 winwidth({nr}) winwidth()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12259 The result is a Number, which is the width of window {nr}.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12260 {nr} can be the window number or the \|window-ID\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12261 When {nr} is zero, the width of the current window is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12262 returned. When window {nr} doesn't exist, -1 is returned.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12263 An existing window always has a width of zero or more.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12264 Examples: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12265 :echo "The current window has " .. winwidth(0) .. " columns."
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12266 :if winwidth(0) <= 50
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12267 : 50 wincmd \|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12268 :endif
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12269 < For getting the terminal or screen size, see the 'columns'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12270 option.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12271
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12272 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12273 GetWinid()->winwidth()
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12274 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12275 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12276
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12277
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12278 wordcount() wordcount()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12279 The result is a dictionary of byte/chars/word statistics for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12280 the current buffer. This is the same info as provided by
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12281 \|g_CTRL-G\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12282 The return value includes:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12283 bytes Number of bytes in the buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12284 chars Number of chars in the buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12285 words Number of words in the buffer
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12286 cursor_bytes Number of bytes before cursor position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12287 (not in Visual mode)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12288 cursor_chars Number of chars before cursor position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12289 (not in Visual mode)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12290 cursor_words Number of words before cursor position
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12291 (not in Visual mode)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12292 visual_bytes Number of bytes visually selected
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12293 (only in Visual mode)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12294 visual_chars Number of chars visually selected
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12295 (only in Visual mode)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12296 visual_words Number of words visually selected
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12297 (only in Visual mode)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12298
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12299 Return type: dict<number>
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12300
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12301
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12302 writefile({object}, {fname} [, {flags}]) writefile()
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12303 When {object} is a \|List\| write it to file {fname}. Each list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12304 item is separated with a NL. Each list item must be a String
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12305 or Number.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12306 All NL characters are replaced with a NUL character.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12307 Inserting CR characters needs to be done before passing {list}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12308 to writefile().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12309
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12310 When {object} is a \|Blob\| write the bytes to file {fname}
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12311 unmodified, also when binary mode is not specified.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12312
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12313 {flags} must be a String. These characters are recognized:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12314
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12315 'b' Binary mode is used: There will not be a NL after the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12316 last list item. An empty item at the end does cause the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12317 last line in the file to end in a NL.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12318
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12319 'a' Append mode is used, lines are appended to the file: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12320 :call writefile(["foo"], "event.log", "a")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12321 :call writefile(["bar"], "event.log", "a")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12322 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12323 'D' Delete the file when the current function ends. This
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12324 works like: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12325 :defer delete({fname})
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12326 < Fails when not in a function. Also see \|:defer\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12327
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12328 's' fsync() is called after writing the file. This flushes
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12329 the file to disk, if possible. This takes more time but
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12330 avoids losing the file if the system crashes.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12331
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12332 'S' fsync() is not called, even when 'fsync' is set.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12333
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12334 When {flags} does not contain "S" or "s" then fsync() is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12335 called if the 'fsync' option is set.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12336
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12337 An existing file is overwritten, if possible.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12338
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12339 When the write fails -1 is returned, otherwise 0. There is an
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12340 error message if the file can't be created or when writing
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12341 fails.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12342
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12343 Also see \|readfile()\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12344 To copy a file byte for byte: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12345 :let fl = readfile("foo", "b")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12346 :call writefile(fl, "foocopy", "b")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12347
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12348 < Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12349 GetText()->writefile("thefile")
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12350 <
a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12351 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12352
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12353
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12354 xor({expr}, {expr}) xor()
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12355 Bitwise XOR on the two arguments. The arguments are converted
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12356 to a number. A List, Dict or Float argument causes an error.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12357 Also see `and()` and `or()`.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12358 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12359 :let bits = xor(bits, 0x80)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12360 <
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12361 Can also be used as a \|method\|: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12362 :let bits = bits->xor(0x80)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12363 <
35350 a631a31adafd runtime(doc): add return type info for Vim function descriptions Christian Brabandt <cb@256bit.org> parents: 35326 diff changeset	12364 Return type: \|Number\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12365
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12366 ==============================================================================
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12367 3. Feature list feature-list
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12368
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12369 There are three types of features:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12370 1. Features that are only supported when they have been enabled when Vim
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12371 was compiled \|+feature-list\|. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12372 :if has("cindent")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12373 < gui_running
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12374 2. Features that are only supported when certain conditions have been met.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12375 Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12376 :if has("gui_running")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12377 < has-patch
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12378 3. Beyond a certain version or at a certain version and including a specific
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12379 patch. The "patch-7.4.248" feature means that the Vim version is 7.5 or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12380 later, or it is version 7.4 and patch 248 was included. Example: >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12381 :if has("patch-7.4.248")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12382 < Note that it's possible for patch 248 to be omitted even though 249 is
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12383 included. Only happens when cherry-picking patches.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12384 Note that this form only works for patch 7.4.237 and later, before that
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12385 you need to check for the patch and the v:version. Example (checking
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12386 version 6.2.148 or later): >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12387 :if v:version > 602 \|\| (v:version == 602 && has("patch148"))
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12388
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12389 Hint: To find out if Vim supports backslashes in a file name (MS-Windows),
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12390 use: `if exists('+shellslash')`
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12391
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12392
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12393 acl Compiled with \|ACL\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12394 all_builtin_terms Compiled with all builtin terminals enabled. (always
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12395 true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12396 amiga Amiga version of Vim.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12397 arabic Compiled with Arabic support \|Arabic\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12398 arp Compiled with ARP support (Amiga).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12399 autocmd Compiled with autocommand support. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12400 autochdir Compiled with support for 'autochdir'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12401 autoservername Automatically enable \|clientserver\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12402 balloon_eval Compiled with \|balloon-eval\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12403 balloon_multiline GUI supports multiline balloons.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12404 beos BeOS version of Vim.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12405 browse Compiled with \|:browse\| support, and browse() will
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12406 work.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12407 browsefilter Compiled with support for \|browsefilter\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12408 bsd Compiled on an OS in the BSD family (excluding macOS).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12409 builtin_terms Compiled with some builtin terminals. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12410 byte_offset Compiled with support for 'o' in 'statusline'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12411 channel Compiled with support for \|channel\| and \|job\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12412 cindent Compiled with 'cindent' support. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12413 clientserver Compiled with remote invocation support \|clientserver\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12414 clipboard Compiled with 'clipboard' support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12415 clipboard_working Compiled with 'clipboard' support and it can be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12416 cmdline_compl Compiled with \|cmdline-completion\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12417 cmdline_hist Compiled with \|cmdline-history\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12418 cmdline_info Compiled with 'showcmd' and 'ruler' support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12419 comments Compiled with \|'comments'\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12420 compatible Compiled to be very Vi compatible.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12421 conpty Platform where \|ConPTY\| can be used.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12422 cryptv Compiled with encryption support \|encryption\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12423 cscope Compiled with \|cscope\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12424 cursorbind Compiled with \|'cursorbind'\| (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12425 debug Compiled with "DEBUG" defined.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12426 dialog_con Compiled with console dialog support.
34780 54890be01c00 patch 9.1.0265: console dialog cannot save unnamed buffers Christian Brabandt <cb@256bit.org> parents: 34779 diff changeset	12427 dialog_con_gui Compiled with console and GUI dialog support.
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12428 dialog_gui Compiled with GUI dialog support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12429 diff Compiled with \|vimdiff\| and 'diff' support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12430 digraphs Compiled with support for digraphs.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12431 directx Compiled with support for DirectX and 'renderoptions'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12432 dnd Compiled with support for the "~ register \|quote_~\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12433 drop_file Compiled with \|drop_file\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12434 ebcdic Compiled on a machine with ebcdic character set.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12435 emacs_tags Compiled with support for Emacs tags.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12436 eval Compiled with expression evaluation support. Always
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12437 true, of course!
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12438 ex_extra \|+ex_extra\| (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12439 extra_search Compiled with support for \|'incsearch'\| and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12440 \|'hlsearch'\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12441 farsi Support for Farsi was removed \|farsi\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12442 file_in_path Compiled with support for \|gf\| and \|<cfile>\| (always
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12443 true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12444 filterpipe When 'shelltemp' is off pipes are used for shell
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12445 read/write/filter commands
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12446 find_in_path Compiled with support for include file searches
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12447 \|+find_in_path\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12448 float Compiled with support for \|Float\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12449 fname_case Case in file names matters (for Amiga and MS-Windows
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12450 this is not present).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12451 folding Compiled with \|folding\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12452 footer Compiled with GUI footer support. \|gui-footer\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12453 fork Compiled to use fork()/exec() instead of system().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12454 gettext Compiled with message translation \|multi-lang\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12455 gui Compiled with GUI enabled.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12456 gui_athena Compiled with Athena GUI (always false).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12457 gui_gnome Compiled with Gnome support (gui_gtk is also defined).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12458 gui_gtk Compiled with GTK+ GUI (any version).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12459 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12460 gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12461 gui_haiku Compiled with Haiku GUI.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12462 gui_mac Compiled with Macintosh GUI.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12463 gui_motif Compiled with Motif GUI.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12464 gui_photon Compiled with Photon GUI.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12465 gui_running Vim is running in the GUI, or it will start soon.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12466 gui_win32 Compiled with MS-Windows Win32 GUI.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12467 gui_win32s idem, and Win32s system being used (Windows 3.1)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12468 haiku Haiku version of Vim.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12469 hangul_input Compiled with Hangul input support. \|hangul\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12470 hpux HP-UX version of Vim.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12471 iconv Can use iconv() for conversion.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12472 insert_expand Compiled with support for CTRL-X expansion commands in
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12473 Insert mode. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12474 job Compiled with support for \|channel\| and \|job\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12475 ipv6 Compiled with support for IPv6 networking in \|channel\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12476 jumplist Compiled with \|jumplist\| support. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12477 keymap Compiled with 'keymap' support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12478 lambda Compiled with \|lambda\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12479 langmap Compiled with 'langmap' support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12480 libcall Compiled with \|libcall()\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12481 linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12482 'breakindent' support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12483 linux Linux version of Vim.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12484 lispindent Compiled with support for lisp indenting.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12485 (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12486 listcmds Compiled with commands for the buffer list \|:files\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12487 and the argument list \|arglist\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12488 localmap Compiled with local mappings and abbr. \|:map-local\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12489 lua Compiled with Lua interface \|Lua\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12490 mac Any Macintosh version of Vim cf. osx
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12491 macunix Synonym for osxdarwin
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12492 menu Compiled with support for \|:menu\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12493 mksession Compiled with support for \|:mksession\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12494 modify_fname Compiled with file name modifiers. \|filename-modifiers\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12495 (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12496 mouse Compiled with support for mouse.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12497 mouse_dec Compiled with support for Dec terminal mouse.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12498 mouse_gpm Compiled with support for gpm (Linux console mouse)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12499 mouse_gpm_enabled GPM mouse is working
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12500 mouse_netterm Compiled with support for netterm mouse.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12501 mouse_pterm Compiled with support for qnx pterm mouse.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12502 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12503 mouse_sgr Compiled with support for sgr mouse.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12504 mouse_urxvt Compiled with support for urxvt mouse.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12505 mouse_xterm Compiled with support for xterm mouse.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12506 mouseshape Compiled with support for 'mouseshape'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12507 multi_byte Compiled with support for 'encoding' (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12508 multi_byte_encoding 'encoding' is set to a multibyte encoding.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12509 multi_byte_ime Compiled with support for IME input method.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12510 multi_lang Compiled with support for multiple languages.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12511 mzscheme Compiled with MzScheme interface \|mzscheme\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12512 nanotime Compiled with sub-second time stamp checks.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12513 netbeans_enabled Compiled with support for \|netbeans\| and connected.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12514 netbeans_intg Compiled with support for \|netbeans\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12515 num64 Compiled with 64-bit \|Number\| support. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12516 ole Compiled with OLE automation support for Win32.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12517 osx Compiled for macOS cf. mac
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12518 osxdarwin Compiled for macOS, with \|mac-darwin-feature\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12519 packages Compiled with \|packages\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12520 path_extra Compiled with up/downwards search in 'path' and 'tags'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12521 perl Compiled with Perl interface.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12522 persistent_undo Compiled with support for persistent undo history.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12523 postscript Compiled with PostScript file printing.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12524 printer Compiled with \|:hardcopy\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12525 profile Compiled with \|:profile\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12526 prof_nsec Profile results are in nanoseconds.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12527 python Python 2.x interface available. \|has-python\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12528 python_compiled Compiled with Python 2.x interface. \|has-python\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12529 python_dynamic Python 2.x interface is dynamically loaded. \|has-python\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12530 python3 Python 3.x interface available. \|has-python\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12531 python3_compiled Compiled with Python 3.x interface. \|has-python\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12532 python3_dynamic Python 3.x interface is dynamically loaded. \|has-python\|
32936 c517845bd10e patch 9.0.1776: No support for stable Python 3 ABI Christian Brabandt <cb@256bit.org> parents: 32830 diff changeset	12533 python3_stable Python 3.x interface is using Python Stable ABI. \|has-python\|
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12534 pythonx Python 2.x and/or 3.x interface available. \|python_x\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12535 qnx QNX version of Vim.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12536 quickfix Compiled with \|quickfix\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12537 reltime Compiled with \|reltime()\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12538 rightleft Compiled with 'rightleft' support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12539 ruby Compiled with Ruby interface \|ruby\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12540 scrollbind Compiled with 'scrollbind' support. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12541 showcmd Compiled with 'showcmd' support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12542 signs Compiled with \|:sign\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12543 smartindent Compiled with 'smartindent' support. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12544 sodium Compiled with libsodium for better crypt support
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12545 sound Compiled with sound support, e.g. `sound_playevent()`
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12546 spell Compiled with spell checking support \|spell\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12547 startuptime Compiled with \|--startuptime\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12548 statusline Compiled with support for 'statusline', 'rulerformat'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12549 and special formats of 'titlestring' and 'iconstring'.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12550 sun SunOS version of Vim.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12551 sun_workshop Support for Sun \|workshop\| has been removed.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12552 syntax Compiled with syntax highlighting support \|syntax\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12553 syntax_items There are active syntax highlighting items for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12554 current buffer.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12555 system Compiled to use system() instead of fork()/exec().
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12556 tag_binary Compiled with binary searching in tags files
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12557 \|tag-binary-search\|. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12558 tag_old_static Support for old static tags was removed, see
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12559 \|tag-old-static\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12560 tcl Compiled with Tcl interface.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12561 termguicolors Compiled with true color in terminal support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12562 terminal Compiled with \|terminal\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12563 terminfo Compiled with terminfo instead of termcap.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12564 termresponse Compiled with support for \|t_RV\| and \|v:termresponse\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12565 textobjects Compiled with support for \|text-objects\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12566 textprop Compiled with support for \|text-properties\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12567 tgetent Compiled with tgetent support, able to use a termcap
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12568 or terminfo file.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12569 timers Compiled with \|timer_start()\| support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12570 title Compiled with window title support \|'title'\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12571 (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12572 toolbar Compiled with support for \|gui-toolbar\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12573 ttyin input is a terminal (tty)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12574 ttyout output is a terminal (tty)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12575 unix Unix version of Vim. +unix
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12576 unnamedplus Compiled with support for "unnamedplus" in 'clipboard'
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12577 user_commands User-defined commands. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12578 vartabs Compiled with variable tabstop support \|'vartabstop'\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12579 vcon Win32: Virtual console support is working, can use
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12580 'termguicolors'. Also see \|+vtp\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12581 vertsplit Compiled with vertically split windows \|:vsplit\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12582 (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12583 vim_starting True while initial source'ing takes place. \|startup\|
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12584 vim_starting
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12585 vim9script Compiled with \|Vim9\| script support
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12586 viminfo Compiled with viminfo support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12587 vimscript-1 Compiled Vim script version 1 support
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12588 vimscript-2 Compiled Vim script version 2 support
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12589 vimscript-3 Compiled Vim script version 3 support
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12590 vimscript-4 Compiled Vim script version 4 support
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12591 virtualedit Compiled with 'virtualedit' option. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12592 visual Compiled with Visual mode. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12593 visualextra Compiled with extra Visual mode commands. (always
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12594 true) \|blockwise-operators\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12595 vms VMS version of Vim.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12596 vreplace Compiled with \|gR\| and \|gr\| commands. (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12597 vtp Compiled for vcon support \|+vtp\| (check vcon to find
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12598 out if it works in the current console).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12599 wildignore Compiled with 'wildignore' option.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12600 wildmenu Compiled with 'wildmenu' option.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12601 win16 old version for MS-Windows 3.1 (always false)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12602 win32 Win32 version of Vim (MS-Windows 95 and later, 32 or
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12603 64 bits)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12604 win32unix Win32 version of Vim, using Unix files (Cygwin)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12605 win64 Win64 version of Vim (MS-Windows 64 bit).
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12606 win95 Win32 version for MS-Windows 95/98/ME (always false)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12607 winaltkeys Compiled with 'winaltkeys' option.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12608 windows Compiled with support for more than one window.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12609 (always true)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12610 writebackup Compiled with 'writebackup' default on.
33408 dcfbfe57141c patch 9.0.1962: No support for writing extended attributes Christian Brabandt <cb@256bit.org> parents: 33383 diff changeset	12611 xattr Compiled with extended attributes support \|xattr\|
dcfbfe57141c patch 9.0.1962: No support for writing extended attributes Christian Brabandt <cb@256bit.org> parents: 33383 diff changeset	12612 (currently only supported on Linux).
32670 695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12613 xfontset Compiled with X fontset support \|xfontset\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12614 xim Compiled with X input method support \|xim\|.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12615 xpm Compiled with pixmap support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12616 xpm_w32 Compiled with pixmap support for Win32. (Only for
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12617 backward compatibility. Use "xpm" instead.)
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12618 xsmp Compiled with X session management support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12619 xsmp_interact Compiled with interactive X session management support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12620 xterm_clipboard Compiled with support for xterm clipboard.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12621 xterm_save Compiled with support for saving and restoring the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12622 xterm screen.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12623 x11 Compiled with X11 support.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12624
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12625
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12626 ==============================================================================
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12627 4. Matching a pattern in a String string-match
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12628
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12629 This is common between several functions. A regexp pattern as explained at
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12630 \|pattern\| is normally used to find a match in the buffer lines. When a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12631 pattern is used to find a match in a String, almost everything works in the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12632 same way. The difference is that a String is handled like it is one line.
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12633 When it contains a "\n" character, this is not seen as a line break for the
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12634 pattern. It can be matched with a "\n" in the pattern, or with ".". Example:
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12635 >
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12636 :let a = "aaaa\nxxxx"
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12637 :echo matchstr(a, "..\n..")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12638 aa
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12639 xx
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12640 :echo matchstr(a, "a.x")
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12641 a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12642 x
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12643
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12644 Don't forget that "^" will only match at the first character of the String and
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12645 "$" at the last character of the string. They don't match after or before a
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12646 "\n".
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12647
695b50472e85 Fix line endings issue Christian Brabandt <cb@256bit.org> parents: 32669 diff changeset	12648 vim:tw=78:ts=8:noet:ft=help:norl:

Mercurial > vim

annotate runtime/doc/builtin.txt @ 35507:1a7250350167 draft default tip