blob: 5928929258fb5249264692598cb0520349992599 [file] [log] [blame]
Bram Moolenaareb490412022-06-28 13:44:46 +01001*builtin.txt* For Vim version 9.0. Last change: 2022 Jun 27
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Builtin functions *builtin-functions*
8
9Note: Expression evaluation can be disabled at compile time. If this has been
10done, the builtin functions are not available. See |+eval| and
11|no-eval-feature|.
12
131. Overview |builtin-function-list|
142. Details |builtin-function-details|
153. Feature list |feature-list|
164. Matching a pattern in a String |string-match|
17
18==============================================================================
191. Overview *builtin-function-list*
20
21Use CTRL-] on the function name to jump to the full explanation.
22
23USAGE RESULT DESCRIPTION ~
24
25abs({expr}) Float or Number absolute value of {expr}
26acos({expr}) Float arc cosine of {expr}
27add({object}, {item}) List/Blob append {item} to {object}
28and({expr}, {expr}) Number bitwise AND
29append({lnum}, {text}) Number append {text} below line {lnum}
30appendbufline({expr}, {lnum}, {text})
31 Number append {text} below line {lnum}
32 in buffer {expr}
33argc([{winid}]) Number number of files in the argument list
34argidx() Number current index in the argument list
35arglistid([{winnr} [, {tabnr}]]) Number argument list id
36argv({nr} [, {winid}]) String {nr} entry of the argument list
37argv([-1, {winid}]) List the argument list
38asin({expr}) Float arc sine of {expr}
39assert_beeps({cmd}) Number assert {cmd} causes a beep
40assert_equal({exp}, {act} [, {msg}])
41 Number assert {exp} is equal to {act}
42assert_equalfile({fname-one}, {fname-two} [, {msg}])
43 Number assert file contents are equal
44assert_exception({error} [, {msg}])
45 Number assert {error} is in v:exception
46assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
47 Number assert {cmd} fails
48assert_false({actual} [, {msg}])
49 Number assert {actual} is false
50assert_inrange({lower}, {upper}, {actual} [, {msg}])
51 Number assert {actual} is inside the range
52assert_match({pat}, {text} [, {msg}])
53 Number assert {pat} matches {text}
54assert_nobeep({cmd}) Number assert {cmd} does not cause a beep
55assert_notequal({exp}, {act} [, {msg}])
56 Number assert {exp} is not equal {act}
57assert_notmatch({pat}, {text} [, {msg}])
58 Number assert {pat} not matches {text}
59assert_report({msg}) Number report a test failure
60assert_true({actual} [, {msg}]) Number assert {actual} is true
61atan({expr}) Float arc tangent of {expr}
62atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2}
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +010063autocmd_add({acmds}) Bool add a list of autocmds and groups
64autocmd_delete({acmds}) Bool delete a list of autocmds and groups
65autocmd_get([{opts}]) List return a list of autocmds
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000066balloon_gettext() String current text in the balloon
67balloon_show({expr}) none show {expr} inside the balloon
68balloon_split({msg}) List split {msg} as used for a balloon
69blob2list({blob}) List convert {blob} into a list of numbers
70browse({save}, {title}, {initdir}, {default})
71 String put up a file requester
72browsedir({title}, {initdir}) String put up a directory requester
73bufadd({name}) Number add a buffer to the buffer list
74bufexists({buf}) Number |TRUE| if buffer {buf} exists
75buflisted({buf}) Number |TRUE| if buffer {buf} is listed
76bufload({buf}) Number load buffer {buf} if not loaded yet
77bufloaded({buf}) Number |TRUE| if buffer {buf} is loaded
78bufname([{buf}]) String Name of the buffer {buf}
79bufnr([{buf} [, {create}]]) Number Number of the buffer {buf}
80bufwinid({buf}) Number window ID of buffer {buf}
81bufwinnr({buf}) Number window number of buffer {buf}
82byte2line({byte}) Number line number at byte count {byte}
83byteidx({expr}, {nr}) Number byte index of {nr}'th char in {expr}
84byteidxcomp({expr}, {nr}) Number byte index of {nr}'th char in {expr}
85call({func}, {arglist} [, {dict}])
86 any call {func} with arguments {arglist}
87ceil({expr}) Float round {expr} up
88ch_canread({handle}) Number check if there is something to read
89ch_close({handle}) none close {handle}
90ch_close_in({handle}) none close in part of {handle}
91ch_evalexpr({handle}, {expr} [, {options}])
92 any evaluate {expr} on JSON {handle}
93ch_evalraw({handle}, {string} [, {options}])
94 any evaluate {string} on raw {handle}
95ch_getbufnr({handle}, {what}) Number get buffer number for {handle}/{what}
96ch_getjob({channel}) Job get the Job of {channel}
97ch_info({handle}) String info about channel {handle}
98ch_log({msg} [, {handle}]) none write {msg} in the channel log file
99ch_logfile({fname} [, {mode}]) none start logging channel activity
100ch_open({address} [, {options}])
101 Channel open a channel to {address}
102ch_read({handle} [, {options}]) String read from {handle}
103ch_readblob({handle} [, {options}])
104 Blob read Blob from {handle}
105ch_readraw({handle} [, {options}])
106 String read raw from {handle}
107ch_sendexpr({handle}, {expr} [, {options}])
108 any send {expr} over JSON {handle}
109ch_sendraw({handle}, {expr} [, {options}])
110 any send {expr} over raw {handle}
111ch_setoptions({handle}, {options})
112 none set options for {handle}
113ch_status({handle} [, {options}])
114 String status of channel {handle}
115changenr() Number current change number
116char2nr({expr} [, {utf8}]) Number ASCII/UTF-8 value of first char in {expr}
117charclass({string}) Number character class of {string}
118charcol({expr}) Number column number of cursor or mark
119charidx({string}, {idx} [, {countcc}])
120 Number char index of byte {idx} in {string}
121chdir({dir}) String change current working directory
122cindent({lnum}) Number C indent for line {lnum}
123clearmatches([{win}]) none clear all matches
124col({expr}) Number column byte index of cursor or mark
125complete({startcol}, {matches}) none set Insert mode completion
126complete_add({expr}) Number add completion match
127complete_check() Number check for key typed during completion
128complete_info([{what}]) Dict get current completion information
129confirm({msg} [, {choices} [, {default} [, {type}]]])
130 Number number of choice picked by user
131copy({expr}) any make a shallow copy of {expr}
132cos({expr}) Float cosine of {expr}
133cosh({expr}) Float hyperbolic cosine of {expr}
134count({comp}, {expr} [, {ic} [, {start}]])
135 Number count how many {expr} are in {comp}
136cscope_connection([{num}, {dbpath} [, {prepend}]])
137 Number checks existence of cscope connection
138cursor({lnum}, {col} [, {off}])
139 Number move cursor to {lnum}, {col}, {off}
140cursor({list}) Number move cursor to position in {list}
141debugbreak({pid}) Number interrupt process being debugged
142deepcopy({expr} [, {noref}]) any make a full copy of {expr}
143delete({fname} [, {flags}]) Number delete the file or directory {fname}
144deletebufline({buf}, {first} [, {last}])
145 Number delete lines from buffer {buf}
146did_filetype() Number |TRUE| if FileType autocmd event used
147diff_filler({lnum}) Number diff filler lines about {lnum}
148diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col}
149digraph_get({chars}) String get the |digraph| of {chars}
150digraph_getlist([{listall}]) List get all |digraph|s
151digraph_set({chars}, {digraph}) Boolean register |digraph|
152digraph_setlist({digraphlist}) Boolean register multiple |digraph|s
153echoraw({expr}) none output {expr} as-is
154empty({expr}) Number |TRUE| if {expr} is empty
155environ() Dict return environment variables
156escape({string}, {chars}) String escape {chars} in {string} with '\'
157eval({string}) any evaluate {string} into its value
158eventhandler() Number |TRUE| if inside an event handler
159executable({expr}) Number 1 if executable {expr} exists
160execute({command}) String execute {command} and get the output
161exepath({expr}) String full path of the command {expr}
162exists({expr}) Number |TRUE| if {expr} exists
163exists_compiled({expr}) Number |TRUE| if {expr} exists at compile time
164exp({expr}) Float exponential of {expr}
165expand({expr} [, {nosuf} [, {list}]])
166 any expand special keywords in {expr}
Yegappan Lakshmanan2b74b682022-04-03 21:30:32 +0100167expandcmd({string} [, {options}])
168 String expand {string} like with `:edit`
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000169extend({expr1}, {expr2} [, {expr3}])
170 List/Dict insert items of {expr2} into {expr1}
171extendnew({expr1}, {expr2} [, {expr3}])
172 List/Dict like |extend()| but creates a new
173 List or Dictionary
174feedkeys({string} [, {mode}]) Number add key sequence to typeahead buffer
175filereadable({file}) Number |TRUE| if {file} is a readable file
176filewritable({file}) Number |TRUE| if {file} is a writable file
177filter({expr1}, {expr2}) List/Dict/Blob/String
178 remove items from {expr1} where
179 {expr2} is 0
180finddir({name} [, {path} [, {count}]])
181 String find directory {name} in {path}
182findfile({name} [, {path} [, {count}]])
183 String find file {name} in {path}
184flatten({list} [, {maxdepth}]) List flatten {list} up to {maxdepth} levels
185flattennew({list} [, {maxdepth}])
186 List flatten a copy of {list}
187float2nr({expr}) Number convert Float {expr} to a Number
188floor({expr}) Float round {expr} down
189fmod({expr1}, {expr2}) Float remainder of {expr1} / {expr2}
190fnameescape({fname}) String escape special characters in {fname}
191fnamemodify({fname}, {mods}) String modify file name
192foldclosed({lnum}) Number first line of fold at {lnum} if closed
193foldclosedend({lnum}) Number last line of fold at {lnum} if closed
194foldlevel({lnum}) Number fold level at {lnum}
195foldtext() String line displayed for closed fold
196foldtextresult({lnum}) String text for closed fold at {lnum}
197foreground() Number bring the Vim window to the foreground
198fullcommand({name}) String get full command from {name}
199funcref({name} [, {arglist}] [, {dict}])
200 Funcref reference to function {name}
201function({name} [, {arglist}] [, {dict}])
202 Funcref named reference to function {name}
203garbagecollect([{atexit}]) none free memory, breaking cyclic references
204get({list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
205get({dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
206get({func}, {what}) any get property of funcref/partial {func}
207getbufinfo([{buf}]) List information about buffers
208getbufline({buf}, {lnum} [, {end}])
209 List lines {lnum} to {end} of buffer {buf}
210getbufvar({buf}, {varname} [, {def}])
211 any variable {varname} in buffer {buf}
212getchangelist([{buf}]) List list of change list items
213getchar([expr]) Number or String
214 get one character from the user
215getcharmod() Number modifiers for the last typed character
216getcharpos({expr}) List position of cursor, mark, etc.
217getcharsearch() Dict last character search
218getcharstr([expr]) String get one character from the user
Shougo Matsushita79d599b2022-05-07 12:48:29 +0100219getcmdcompltype() String return the type of the current
220 command-line completion
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000221getcmdline() String return the current command-line
222getcmdpos() Number return cursor position in command-line
Shougo Matsushita79d599b2022-05-07 12:48:29 +0100223getcmdscreenpos() Number return cursor screen position in
224 command-line
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000225getcmdtype() String return current command-line type
226getcmdwintype() String return current command-line window type
227getcompletion({pat}, {type} [, {filtered}])
228 List list of cmdline completion matches
229getcurpos([{winnr}]) List position of the cursor
230getcursorcharpos([{winnr}]) List character position of the cursor
231getcwd([{winnr} [, {tabnr}]]) String get the current working directory
232getenv({name}) String return environment variable
233getfontname([{name}]) String name of font being used
234getfperm({fname}) String file permissions of file {fname}
235getfsize({fname}) Number size in bytes of file {fname}
236getftime({fname}) Number last modification time of file
237getftype({fname}) String description of type of file {fname}
238getimstatus() Number |TRUE| if the IME status is active
239getjumplist([{winnr} [, {tabnr}]])
240 List list of jump list items
241getline({lnum}) String line {lnum} of current buffer
242getline({lnum}, {end}) List lines {lnum} to {end} of current buffer
243getloclist({nr}) List list of location list items
244getloclist({nr}, {what}) Dict get specific location list properties
245getmarklist([{buf}]) List list of global/local marks
246getmatches([{win}]) List list of current matches
247getmousepos() Dict last known mouse position
248getpid() Number process ID of Vim
249getpos({expr}) List position of cursor, mark, etc.
250getqflist() List list of quickfix items
251getqflist({what}) Dict get specific quickfix list properties
252getreg([{regname} [, 1 [, {list}]]])
253 String or List contents of a register
254getreginfo([{regname}]) Dict information about a register
255getregtype([{regname}]) String type of a register
Bram Moolenaar753885b2022-08-24 16:30:36 +0100256getscriptinfo() List list of sourced scripts
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000257gettabinfo([{expr}]) List list of tab pages
258gettabvar({nr}, {varname} [, {def}])
259 any variable {varname} in tab {nr} or {def}
260gettabwinvar({tabnr}, {winnr}, {name} [, {def}])
261 any {name} in {winnr} in tab page {tabnr}
262gettagstack([{nr}]) Dict get the tag stack of window {nr}
263gettext({text}) String lookup translation of {text}
264getwininfo([{winid}]) List list of info about each window
265getwinpos([{timeout}]) List X and Y coord in pixels of the Vim window
266getwinposx() Number X coord in pixels of the Vim window
267getwinposy() Number Y coord in pixels of the Vim window
268getwinvar({nr}, {varname} [, {def}])
269 any variable {varname} in window {nr}
270glob({expr} [, {nosuf} [, {list} [, {alllinks}]]])
271 any expand file wildcards in {expr}
272glob2regpat({expr}) String convert a glob pat into a search pat
273globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
274 String do glob({expr}) for all dirs in {path}
275has({feature} [, {check}]) Number |TRUE| if feature {feature} supported
276has_key({dict}, {key}) Number |TRUE| if {dict} has entry {key}
277haslocaldir([{winnr} [, {tabnr}]])
278 Number |TRUE| if the window executed |:lcd|
279 or |:tcd|
280hasmapto({what} [, {mode} [, {abbr}]])
281 Number |TRUE| if mapping to {what} exists
282histadd({history}, {item}) Number add an item to a history
283histdel({history} [, {item}]) Number remove an item from a history
284histget({history} [, {index}]) String get the item {index} from a history
285histnr({history}) Number highest index of a history
286hlID({name}) Number syntax ID of highlight group {name}
287hlexists({name}) Number |TRUE| if highlight group {name} exists
288hlget([{name} [, {resolve}]]) List get highlight group attributes
289hlset({list}) Number set highlight group attributes
290hostname() String name of the machine Vim is running on
291iconv({expr}, {from}, {to}) String convert encoding of {expr}
292indent({lnum}) Number indent of line {lnum}
293index({object}, {expr} [, {start} [, {ic}]])
294 Number index in {object} where {expr} appears
Yegappan Lakshmananb2186552022-08-13 13:09:20 +0100295indexof({object}, {expr} [, {opts}]])
296 Number index in {object} where {expr} is true
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000297input({prompt} [, {text} [, {completion}]])
298 String get input from the user
Bram Moolenaarb529cfb2022-07-25 15:42:07 +0100299inputdialog({prompt} [, {text} [, {cancelreturn}]])
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000300 String like input() but in a GUI dialog
301inputlist({textlist}) Number let the user pick from a choice list
302inputrestore() Number restore typeahead
303inputsave() Number save and clear typeahead
304inputsecret({prompt} [, {text}]) String like input() but hiding the text
305insert({object}, {item} [, {idx}]) List insert {item} in {object} [before {idx}]
306interrupt() none interrupt script execution
307invert({expr}) Number bitwise invert
LemonBoydca1d402022-04-28 15:26:33 +0100308isabsolutepath({path}) Number |TRUE| if {path} is an absolute path
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000309isdirectory({directory}) Number |TRUE| if {directory} is a directory
310isinf({expr}) Number determine if {expr} is infinity value
311 (positive or negative)
312islocked({expr}) Number |TRUE| if {expr} is locked
313isnan({expr}) Number |TRUE| if {expr} is NaN
314items({dict}) List key-value pairs in {dict}
315job_getchannel({job}) Channel get the channel handle for {job}
316job_info([{job}]) Dict get information about {job}
317job_setoptions({job}, {options}) none set options for {job}
318job_start({command} [, {options}])
319 Job start a job
320job_status({job}) String get the status of {job}
321job_stop({job} [, {how}]) Number stop {job}
322join({list} [, {sep}]) String join {list} items into one String
323js_decode({string}) any decode JS style JSON
324js_encode({expr}) String encode JS style JSON
325json_decode({string}) any decode JSON
326json_encode({expr}) String encode JSON
327keys({dict}) List keys in {dict}
328len({expr}) Number the length of {expr}
329libcall({lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
330libcallnr({lib}, {func}, {arg}) Number idem, but return a Number
331line({expr} [, {winid}]) Number line nr of cursor, last line or mark
332line2byte({lnum}) Number byte count of line {lnum}
333lispindent({lnum}) Number Lisp indent for line {lnum}
334list2blob({list}) Blob turn {list} of numbers into a Blob
335list2str({list} [, {utf8}]) String turn {list} of numbers into a String
336listener_add({callback} [, {buf}])
337 Number add a callback to listen to changes
338listener_flush([{buf}]) none invoke listener callbacks
339listener_remove({id}) none remove a listener callback
340localtime() Number current time
341log({expr}) Float natural logarithm (base e) of {expr}
342log10({expr}) Float logarithm of Float {expr} to base 10
343luaeval({expr} [, {expr}]) any evaluate |Lua| expression
344map({expr1}, {expr2}) List/Dict/Blob/String
345 change each item in {expr1} to {expr2}
346maparg({name} [, {mode} [, {abbr} [, {dict}]]])
347 String or Dict
348 rhs of mapping {name} in mode {mode}
349mapcheck({name} [, {mode} [, {abbr}]])
350 String check for mappings matching {name}
Ernie Rael09661202022-04-25 14:40:44 +0100351maplist([{abbr}]) List list of all mappings, a dict for each
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000352mapnew({expr1}, {expr2}) List/Dict/Blob/String
353 like |map()| but creates a new List or
354 Dictionary
355mapset({mode}, {abbr}, {dict}) none restore mapping from |maparg()| result
356match({expr}, {pat} [, {start} [, {count}]])
357 Number position where {pat} matches in {expr}
358matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
359 Number highlight {pattern} with {group}
360matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
361 Number highlight positions with {group}
362matcharg({nr}) List arguments of |:match|
363matchdelete({id} [, {win}]) Number delete match identified by {id}
364matchend({expr}, {pat} [, {start} [, {count}]])
365 Number position where {pat} ends in {expr}
366matchfuzzy({list}, {str} [, {dict}])
367 List fuzzy match {str} in {list}
368matchfuzzypos({list}, {str} [, {dict}])
369 List fuzzy match {str} in {list}
370matchlist({expr}, {pat} [, {start} [, {count}]])
371 List match and submatches of {pat} in {expr}
372matchstr({expr}, {pat} [, {start} [, {count}]])
373 String {count}'th match of {pat} in {expr}
374matchstrpos({expr}, {pat} [, {start} [, {count}]])
375 List {count}'th match of {pat} in {expr}
376max({expr}) Number maximum value of items in {expr}
377menu_info({name} [, {mode}]) Dict get menu item information
378min({expr}) Number minimum value of items in {expr}
379mkdir({name} [, {path} [, {prot}]])
380 Number create directory {name}
381mode([expr]) String current editing mode
382mzeval({expr}) any evaluate |MzScheme| expression
383nextnonblank({lnum}) Number line nr of non-blank line >= {lnum}
384nr2char({expr} [, {utf8}]) String single char with ASCII/UTF-8 value {expr}
385or({expr}, {expr}) Number bitwise OR
386pathshorten({expr} [, {len}]) String shorten directory names in a path
387perleval({expr}) any evaluate |Perl| expression
388popup_atcursor({what}, {options}) Number create popup window near the cursor
389popup_beval({what}, {options}) Number create popup window for 'ballooneval'
390popup_clear() none close all popup windows
391popup_close({id} [, {result}]) none close popup window {id}
392popup_create({what}, {options}) Number create a popup window
393popup_dialog({what}, {options}) Number create a popup window used as a dialog
394popup_filter_menu({id}, {key}) Number filter for a menu popup window
395popup_filter_yesno({id}, {key}) Number filter for a dialog popup window
396popup_findinfo() Number get window ID of info popup window
397popup_findpreview() Number get window ID of preview popup window
398popup_getoptions({id}) Dict get options of popup window {id}
399popup_getpos({id}) Dict get position of popup window {id}
400popup_hide({id}) none hide popup menu {id}
401popup_list() List get a list of window IDs of all popups
402popup_locate({row}, {col}) Number get window ID of popup at position
403popup_menu({what}, {options}) Number create a popup window used as a menu
404popup_move({id}, {options}) none set position of popup window {id}
405popup_notification({what}, {options})
406 Number create a notification popup window
407popup_setoptions({id}, {options})
408 none set options for popup window {id}
409popup_settext({id}, {text}) none set the text of popup window {id}
410popup_show({id}) none unhide popup window {id}
411pow({x}, {y}) Float {x} to the power of {y}
412prevnonblank({lnum}) Number line nr of non-blank line <= {lnum}
413printf({fmt}, {expr1}...) String format text
414prompt_getprompt({buf}) String get prompt text
415prompt_setcallback({buf}, {expr}) none set prompt callback function
416prompt_setinterrupt({buf}, {text}) none set prompt interrupt function
417prompt_setprompt({buf}, {text}) none set prompt text
418prop_add({lnum}, {col}, {props}) none add one text property
419prop_add_list({props}, [[{lnum}, {col}, {end-lnum}, {end-col}], ...])
420 none add multiple text properties
421prop_clear({lnum} [, {lnum-end} [, {props}]])
422 none remove all text properties
423prop_find({props} [, {direction}])
424 Dict search for a text property
425prop_list({lnum} [, {props}]) List text properties in {lnum}
426prop_remove({props} [, {lnum} [, {lnum-end}]])
427 Number remove a text property
428prop_type_add({name}, {props}) none define a new property type
429prop_type_change({name}, {props})
430 none change an existing property type
431prop_type_delete({name} [, {props}])
432 none delete a property type
433prop_type_get({name} [, {props}])
434 Dict get property type values
435prop_type_list([{props}]) List get list of property types
436pum_getpos() Dict position and size of pum if visible
437pumvisible() Number whether popup menu is visible
438py3eval({expr}) any evaluate |python3| expression
439pyeval({expr}) any evaluate |Python| expression
440pyxeval({expr}) any evaluate |python_x| expression
441rand([{expr}]) Number get pseudo-random number
442range({expr} [, {max} [, {stride}]])
443 List items from {expr} to {max}
444readblob({fname}) Blob read a |Blob| from {fname}
445readdir({dir} [, {expr} [, {dict}]])
446 List file names in {dir} selected by {expr}
447readdirex({dir} [, {expr} [, {dict}]])
448 List file info in {dir} selected by {expr}
449readfile({fname} [, {type} [, {max}]])
450 List get list of lines from file {fname}
451reduce({object}, {func} [, {initial}])
452 any reduce {object} using {func}
453reg_executing() String get the executing register name
454reg_recording() String get the recording register name
455reltime([{start} [, {end}]]) List get time value
456reltimefloat({time}) Float turn the time value into a Float
457reltimestr({time}) String turn time value into a String
458remote_expr({server}, {string} [, {idvar} [, {timeout}]])
459 String send expression
460remote_foreground({server}) Number bring Vim server to the foreground
461remote_peek({serverid} [, {retvar}])
462 Number check for reply string
463remote_read({serverid} [, {timeout}])
464 String read reply string
465remote_send({server}, {string} [, {idvar}])
466 String send key sequence
467remote_startserver({name}) none become server {name}
468remove({list}, {idx} [, {end}]) any/List
469 remove items {idx}-{end} from {list}
470remove({blob}, {idx} [, {end}]) Number/Blob
471 remove bytes {idx}-{end} from {blob}
472remove({dict}, {key}) any remove entry {key} from {dict}
473rename({from}, {to}) Number rename (move) file from {from} to {to}
474repeat({expr}, {count}) String repeat {expr} {count} times
475resolve({filename}) String get filename a shortcut points to
476reverse({list}) List reverse {list} in-place
477round({expr}) Float round off {expr}
478rubyeval({expr}) any evaluate |Ruby| expression
479screenattr({row}, {col}) Number attribute at screen position
480screenchar({row}, {col}) Number character at screen position
481screenchars({row}, {col}) List List of characters at screen position
482screencol() Number current cursor column
483screenpos({winid}, {lnum}, {col}) Dict screen row and col of a text character
484screenrow() Number current cursor row
485screenstring({row}, {col}) String characters at screen position
486search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
487 Number search for {pattern}
488searchcount([{options}]) Dict get or update search stats
489searchdecl({name} [, {global} [, {thisblock}]])
490 Number search for variable declaration
491searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
492 Number search for other end of start/end pair
493searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
494 List search for other end of start/end pair
495searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
496 List search for {pattern}
497server2client({clientid}, {string})
498 Number send reply string
499serverlist() String get a list of available servers
500setbufline({expr}, {lnum}, {text})
501 Number set line {lnum} to {text} in buffer
502 {expr}
503setbufvar({buf}, {varname}, {val})
504 none set {varname} in buffer {buf} to {val}
505setcellwidths({list}) none set character cell width overrides
506setcharpos({expr}, {list}) Number set the {expr} position to {list}
507setcharsearch({dict}) Dict set character search from {dict}
508setcmdpos({pos}) Number set cursor position in command-line
509setcursorcharpos({list}) Number move cursor to position in {list}
510setenv({name}, {val}) none set environment variable
511setfperm({fname}, {mode}) Number set {fname} file permissions to {mode}
512setline({lnum}, {line}) Number set line {lnum} to {line}
513setloclist({nr}, {list} [, {action}])
514 Number modify location list using {list}
515setloclist({nr}, {list}, {action}, {what})
516 Number modify specific location list props
517setmatches({list} [, {win}]) Number restore a list of matches
518setpos({expr}, {list}) Number set the {expr} position to {list}
519setqflist({list} [, {action}]) Number modify quickfix list using {list}
520setqflist({list}, {action}, {what})
521 Number modify specific quickfix list props
522setreg({n}, {v} [, {opt}]) Number set register to value and type
523settabvar({nr}, {varname}, {val}) none set {varname} in tab page {nr} to {val}
524settabwinvar({tabnr}, {winnr}, {varname}, {val})
525 none set {varname} in window {winnr} in tab
526 page {tabnr} to {val}
527settagstack({nr}, {dict} [, {action}])
528 Number modify tag stack using {dict}
529setwinvar({nr}, {varname}, {val}) none set {varname} in window {nr} to {val}
530sha256({string}) String SHA256 checksum of {string}
531shellescape({string} [, {special}])
532 String escape {string} for use as shell
533 command argument
534shiftwidth([{col}]) Number effective value of 'shiftwidth'
535sign_define({name} [, {dict}]) Number define or update a sign
536sign_define({list}) List define or update a list of signs
537sign_getdefined([{name}]) List get a list of defined signs
538sign_getplaced([{buf} [, {dict}]])
539 List get a list of placed signs
540sign_jump({id}, {group}, {buf})
541 Number jump to a sign
542sign_place({id}, {group}, {name}, {buf} [, {dict}])
543 Number place a sign
544sign_placelist({list}) List place a list of signs
545sign_undefine([{name}]) Number undefine a sign
546sign_undefine({list}) List undefine a list of signs
547sign_unplace({group} [, {dict}])
548 Number unplace a sign
549sign_unplacelist({list}) List unplace a list of signs
550simplify({filename}) String simplify filename as much as possible
551sin({expr}) Float sine of {expr}
552sinh({expr}) Float hyperbolic sine of {expr}
553slice({expr}, {start} [, {end}]) String, List or Blob
554 slice of a String, List or Blob
Bram Moolenaar2007dd42022-02-23 13:17:47 +0000555sort({list} [, {how} [, {dict}]])
556 List sort {list}, compare with {how}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000557sound_clear() none stop playing all sounds
558sound_playevent({name} [, {callback}])
559 Number play an event sound
560sound_playfile({path} [, {callback}])
561 Number play sound file {path}
562sound_stop({id}) none stop playing sound {id}
563soundfold({word}) String sound-fold {word}
564spellbadword() String badly spelled word at cursor
565spellsuggest({word} [, {max} [, {capital}]])
566 List spelling suggestions
567split({expr} [, {pat} [, {keepempty}]])
568 List make |List| from {pat} separated {expr}
569sqrt({expr}) Float square root of {expr}
570srand([{expr}]) List get seed for |rand()|
571state([{what}]) String current state of Vim
572str2float({expr} [, {quoted}]) Float convert String to Float
573str2list({expr} [, {utf8}]) List convert each character of {expr} to
574 ASCII/UTF-8 value
575str2nr({expr} [, {base} [, {quoted}]])
576 Number convert String to Number
577strcharlen({expr}) Number character length of the String {expr}
578strcharpart({str}, {start} [, {len} [, {skipcc}]])
579 String {len} characters of {str} at
580 character {start}
581strchars({expr} [, {skipcc}]) Number character count of the String {expr}
582strdisplaywidth({expr} [, {col}]) Number display length of the String {expr}
583strftime({format} [, {time}]) String format time with a specified format
584strgetchar({str}, {index}) Number get char {index} from {str}
585stridx({haystack}, {needle} [, {start}])
586 Number index of {needle} in {haystack}
587string({expr}) String String representation of {expr} value
588strlen({expr}) Number length of the String {expr}
589strpart({str}, {start} [, {len} [, {chars}]])
590 String {len} bytes/chars of {str} at
591 byte {start}
592strptime({format}, {timestring})
593 Number Convert {timestring} to unix timestamp
594strridx({haystack}, {needle} [, {start}])
595 Number last index of {needle} in {haystack}
596strtrans({expr}) String translate string to make it printable
597strwidth({expr}) Number display cell length of the String {expr}
598submatch({nr} [, {list}]) String or List
599 specific match in ":s" or substitute()
600substitute({expr}, {pat}, {sub}, {flags})
601 String all {pat} in {expr} replaced with {sub}
602swapinfo({fname}) Dict information about swap file {fname}
603swapname({buf}) String swap file of buffer {buf}
604synID({lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
605synIDattr({synID}, {what} [, {mode}])
606 String attribute {what} of syntax ID {synID}
607synIDtrans({synID}) Number translated syntax ID of {synID}
608synconcealed({lnum}, {col}) List info about concealing
609synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
610system({expr} [, {input}]) String output of shell command/filter {expr}
611systemlist({expr} [, {input}]) List output of shell command/filter {expr}
612tabpagebuflist([{arg}]) List list of buffer numbers in tab page
613tabpagenr([{arg}]) Number number of current or last tab page
614tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page
615tagfiles() List tags files used
616taglist({expr} [, {filename}]) List list of tags matching {expr}
617tan({expr}) Float tangent of {expr}
618tanh({expr}) Float hyperbolic tangent of {expr}
619tempname() String name for a temporary file
620term_dumpdiff({filename}, {filename} [, {options}])
621 Number display difference between two dumps
622term_dumpload({filename} [, {options}])
623 Number displaying a screen dump
624term_dumpwrite({buf}, {filename} [, {options}])
625 none dump terminal window contents
626term_getaltscreen({buf}) Number get the alternate screen flag
627term_getansicolors({buf}) List get ANSI palette in GUI color mode
628term_getattr({attr}, {what}) Number get the value of attribute {what}
629term_getcursor({buf}) List get the cursor position of a terminal
630term_getjob({buf}) Job get the job associated with a terminal
631term_getline({buf}, {row}) String get a line of text from a terminal
632term_getscrolled({buf}) Number get the scroll count of a terminal
633term_getsize({buf}) List get the size of a terminal
634term_getstatus({buf}) String get the status of a terminal
635term_gettitle({buf}) String get the title of a terminal
636term_gettty({buf}, [{input}]) String get the tty name of a terminal
637term_list() List get the list of terminal buffers
638term_scrape({buf}, {row}) List get row of a terminal screen
639term_sendkeys({buf}, {keys}) none send keystrokes to a terminal
640term_setansicolors({buf}, {colors})
641 none set ANSI palette in GUI color mode
642term_setapi({buf}, {expr}) none set |terminal-api| function name prefix
643term_setkill({buf}, {how}) none set signal to stop job in terminal
644term_setrestore({buf}, {command}) none set command to restore terminal
645term_setsize({buf}, {rows}, {cols})
646 none set the size of a terminal
647term_start({cmd} [, {options}]) Number open a terminal window and run a job
648term_wait({buf} [, {time}]) Number wait for screen to be updated
649terminalprops() Dict properties of the terminal
650test_alloc_fail({id}, {countdown}, {repeat})
651 none make memory allocation fail
652test_autochdir() none enable 'autochdir' during startup
653test_feedinput({string}) none add key sequence to input buffer
654test_garbagecollect_now() none free memory right now for testing
655test_garbagecollect_soon() none free memory soon for testing
656test_getvalue({string}) any get value of an internal variable
Yegappan Lakshmanan06011e12022-01-30 12:37:29 +0000657test_gui_event({event}, {args}) bool generate a GUI event for testing
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000658test_ignore_error({expr}) none ignore a specific error
659test_null_blob() Blob null value for testing
660test_null_channel() Channel null value for testing
661test_null_dict() Dict null value for testing
662test_null_function() Funcref null value for testing
663test_null_job() Job null value for testing
664test_null_list() List null value for testing
665test_null_partial() Funcref null value for testing
666test_null_string() String null value for testing
667test_option_not_set({name}) none reset flag indicating option was set
668test_override({expr}, {val}) none test with Vim internal overrides
669test_refcount({expr}) Number get the reference count of {expr}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000670test_setmouse({row}, {col}) none set the mouse position for testing
671test_settime({expr}) none set current time for testing
672test_srand_seed([seed]) none set seed for testing srand()
673test_unknown() any unknown value for testing
674test_void() any void value for testing
675timer_info([{id}]) List information about timers
676timer_pause({id}, {pause}) none pause or unpause a timer
677timer_start({time}, {callback} [, {options}])
678 Number create a timer
679timer_stop({timer}) none stop a timer
680timer_stopall() none stop all timers
681tolower({expr}) String the String {expr} switched to lowercase
682toupper({expr}) String the String {expr} switched to uppercase
683tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
684 to chars in {tostr}
685trim({text} [, {mask} [, {dir}]])
686 String trim characters in {mask} from {text}
687trunc({expr}) Float truncate Float {expr}
688type({expr}) Number type of value {expr}
689typename({expr}) String representation of the type of {expr}
690undofile({name}) String undo file name for {name}
691undotree() List undo file tree
692uniq({list} [, {func} [, {dict}]])
693 List remove adjacent duplicates from a list
694values({dict}) List values in {dict}
LemonBoy0f7a3e12022-05-26 12:10:37 +0100695virtcol({expr} [, {list}]) Number or List
696 screen column of cursor or mark
Bram Moolenaar5a6ec102022-05-27 21:58:00 +0100697virtcol2col({winid}, {lnum}, {col})
698 Number byte index of a character on screen
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000699visualmode([expr]) String last visual mode used
700wildmenumode() Number whether 'wildmenu' mode is active
701win_execute({id}, {command} [, {silent}])
702 String execute {command} in window {id}
703win_findbuf({bufnr}) List find windows containing {bufnr}
704win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab}
705win_gettype([{nr}]) String type of window {nr}
706win_gotoid({expr}) Number go to window with ID {expr}
707win_id2tabwin({expr}) List get tab and window nr from window ID
708win_id2win({expr}) Number get window nr from window ID
Daniel Steinbergee630312022-01-10 13:36:34 +0000709win_move_separator({nr}) Number move window vertical separator
710win_move_statusline({nr}) Number move window status line
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000711win_screenpos({nr}) List get screen position of window {nr}
712win_splitmove({nr}, {target} [, {options}])
713 Number move window {nr} to split of {target}
714winbufnr({nr}) Number buffer number of window {nr}
715wincol() Number window column of the cursor
716windowsversion() String MS-Windows OS version
717winheight({nr}) Number height of window {nr}
718winlayout([{tabnr}]) List layout of windows in tab {tabnr}
719winline() Number window line of the cursor
720winnr([{expr}]) Number number of current window
721winrestcmd() String returns command to restore window sizes
722winrestview({dict}) none restore view of current window
723winsaveview() Dict save view of current window
724winwidth({nr}) Number width of window {nr}
725wordcount() Dict get byte/char/word statistics
726writefile({object}, {fname} [, {flags}])
727 Number write |Blob| or |List| of lines to file
728xor({expr}, {expr}) Number bitwise XOR
729
730==============================================================================
7312. Details *builtin-function-details*
732
733Not all functions are here, some have been moved to a help file covering the
734specific functionality.
735
736abs({expr}) *abs()*
737 Return the absolute value of {expr}. When {expr} evaluates to
738 a |Float| abs() returns a |Float|. When {expr} can be
739 converted to a |Number| abs() returns a |Number|. Otherwise
740 abs() gives an error message and returns -1.
741 Examples: >
742 echo abs(1.456)
743< 1.456 >
744 echo abs(-5.456)
745< 5.456 >
746 echo abs(-4)
747< 4
748
749 Can also be used as a |method|: >
750 Compute()->abs()
751
752< {only available when compiled with the |+float| feature}
753
754
755acos({expr}) *acos()*
756 Return the arc cosine of {expr} measured in radians, as a
757 |Float| in the range of [0, pi].
758 {expr} must evaluate to a |Float| or a |Number| in the range
Bram Moolenaar016188f2022-06-06 20:52:59 +0100759 [-1, 1]. Otherwise acos() returns "nan".
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000760 Examples: >
761 :echo acos(0)
762< 1.570796 >
763 :echo acos(-0.5)
764< 2.094395
765
766 Can also be used as a |method|: >
767 Compute()->acos()
768
769< {only available when compiled with the |+float| feature}
770
771
772add({object}, {expr}) *add()*
773 Append the item {expr} to |List| or |Blob| {object}. Returns
774 the resulting |List| or |Blob|. Examples: >
775 :let alist = add([1, 2, 3], item)
776 :call add(mylist, "woodstock")
777< Note that when {expr} is a |List| it is appended as a single
778 item. Use |extend()| to concatenate |Lists|.
779 When {object} is a |Blob| then {expr} must be a number.
780 Use |insert()| to add an item at another position.
Bram Moolenaar016188f2022-06-06 20:52:59 +0100781 Returns 1 if {object} is not a |List| or a |Blob|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000782
783 Can also be used as a |method|: >
784 mylist->add(val1)->add(val2)
785
786
787and({expr}, {expr}) *and()*
788 Bitwise AND on the two arguments. The arguments are converted
789 to a number. A List, Dict or Float argument causes an error.
LemonBoy0f7a3e12022-05-26 12:10:37 +0100790 Also see `or()` and `xor()`.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000791 Example: >
792 :let flag = and(bits, 0x80)
793< Can also be used as a |method|: >
794 :let flag = bits->and(0x80)
795
796
797append({lnum}, {text}) *append()*
798 When {text} is a |List|: Append each item of the |List| as a
799 text line below line {lnum} in the current buffer.
800 Otherwise append {text} as one text line below line {lnum} in
801 the current buffer.
802 Any type of item is accepted and converted to a String.
803 {lnum} can be zero to insert a line before the first one.
804 {lnum} is used like with |getline()|.
805 Returns 1 for failure ({lnum} out of range or out of memory),
806 0 for success. In |Vim9| script an invalid argument or
807 negative number results in an error. Example: >
808 :let failed = append(line('$'), "# THE END")
809 :let failed = append(0, ["Chapter 1", "the beginning"])
810
811< Can also be used as a |method| after a List, the base is
812 passed as the second argument: >
813 mylist->append(lnum)
814
815
816appendbufline({buf}, {lnum}, {text}) *appendbufline()*
817 Like |append()| but append the text in buffer {buf}.
818
819 This function works only for loaded buffers. First call
820 |bufload()| if needed.
821
822 For the use of {buf}, see |bufname()|.
823
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000824 {lnum} is the line number to append below. Note that using
825 |line()| would use the current buffer, not the one appending
826 to. Use "$" to append at the end of the buffer. Other string
827 values are not supported.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000828
829 On success 0 is returned, on failure 1 is returned.
830 In |Vim9| script an error is given for an invalid {lnum}.
831
832 If {buf} is not a valid buffer or {lnum} is not valid, an
833 error message is given. Example: >
834 :let failed = appendbufline(13, 0, "# THE START")
835<
836 Can also be used as a |method| after a List, the base is
837 passed as the second argument: >
838 mylist->appendbufline(buf, lnum)
839
840
841argc([{winid}]) *argc()*
842 The result is the number of files in the argument list. See
843 |arglist|.
844 If {winid} is not supplied, the argument list of the current
845 window is used.
846 If {winid} is -1, the global argument list is used.
847 Otherwise {winid} specifies the window of which the argument
848 list is used: either the window number or the window ID.
849 Returns -1 if the {winid} argument is invalid.
850
851 *argidx()*
852argidx() The result is the current index in the argument list. 0 is
853 the first file. argc() - 1 is the last one. See |arglist|.
854
855 *arglistid()*
856arglistid([{winnr} [, {tabnr}]])
857 Return the argument list ID. This is a number which
858 identifies the argument list being used. Zero is used for the
859 global argument list. See |arglist|.
860 Returns -1 if the arguments are invalid.
861
862 Without arguments use the current window.
863 With {winnr} only use this window in the current tab page.
864 With {winnr} and {tabnr} use the window in the specified tab
865 page.
866 {winnr} can be the window number or the |window-ID|.
867
868 *argv()*
869argv([{nr} [, {winid}]])
870 The result is the {nr}th file in the argument list. See
871 |arglist|. "argv(0)" is the first one. Example: >
872 :let i = 0
873 :while i < argc()
874 : let f = escape(fnameescape(argv(i)), '.')
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000875 : exe 'amenu Arg.' .. f .. ' :e ' .. f .. '<CR>'
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000876 : let i = i + 1
877 :endwhile
878< Without the {nr} argument, or when {nr} is -1, a |List| with
879 the whole |arglist| is returned.
880
881 The {winid} argument specifies the window ID, see |argc()|.
882 For the Vim command line arguments see |v:argv|.
883
Bram Moolenaar016188f2022-06-06 20:52:59 +0100884 Returns an empty string if {nr}th argument is not present in
885 the argument list. Returns an empty List if the {winid}
886 argument is invalid.
887
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000888asin({expr}) *asin()*
889 Return the arc sine of {expr} measured in radians, as a |Float|
890 in the range of [-pi/2, pi/2].
891 {expr} must evaluate to a |Float| or a |Number| in the range
892 [-1, 1].
Bram Moolenaar016188f2022-06-06 20:52:59 +0100893 Returns "nan" if {expr} is outside the range [-1, 1]. Returns
894 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000895 Examples: >
896 :echo asin(0.8)
897< 0.927295 >
898 :echo asin(-0.5)
899< -0.523599
900
901 Can also be used as a |method|: >
902 Compute()->asin()
903<
904 {only available when compiled with the |+float| feature}
905
906
907assert_ functions are documented here: |assert-functions-details|
908
909
910
911atan({expr}) *atan()*
912 Return the principal value of the arc tangent of {expr}, in
913 the range [-pi/2, +pi/2] radians, as a |Float|.
914 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar016188f2022-06-06 20:52:59 +0100915 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000916 Examples: >
917 :echo atan(100)
918< 1.560797 >
919 :echo atan(-4.01)
920< -1.326405
921
922 Can also be used as a |method|: >
923 Compute()->atan()
924<
925 {only available when compiled with the |+float| feature}
926
927
928atan2({expr1}, {expr2}) *atan2()*
929 Return the arc tangent of {expr1} / {expr2}, measured in
930 radians, as a |Float| in the range [-pi, pi].
931 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
Bram Moolenaar016188f2022-06-06 20:52:59 +0100932 Returns 0.0 if {expr1} or {expr2} is not a |Float| or a
933 |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000934 Examples: >
935 :echo atan2(-1, 1)
936< -0.785398 >
937 :echo atan2(1, -1)
938< 2.356194
939
940 Can also be used as a |method|: >
941 Compute()->atan2(1)
942<
943 {only available when compiled with the |+float| feature}
944
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +0100945
946autocmd_add({acmds}) *autocmd_add()*
947 Adds a List of autocmds and autocmd groups.
948
949 The {acmds} argument is a List where each item is a Dict with
950 the following optional items:
951 bufnr buffer number to add a buffer-local autocmd.
952 If this item is specified, then the "pattern"
953 item is ignored.
954 cmd Ex command to execute for this autocmd event
955 event autocmd event name. Refer to |autocmd-events|.
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +0100956 This can be either a String with a single
957 event name or a List of event names.
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +0100958 group autocmd group name. Refer to |autocmd-groups|.
959 If this group doesn't exist then it is
960 created. If not specified or empty, then the
961 default group is used.
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +0100962 nested boolean flag, set to v:true to add a nested
963 autocmd. Refer to |autocmd-nested|.
LemonBoy0f7a3e12022-05-26 12:10:37 +0100964 once boolean flag, set to v:true to add an autocmd
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +0100965 which executes only once. Refer to
966 |autocmd-once|.
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +0100967 pattern autocmd pattern string. Refer to
968 |autocmd-patterns|. If "bufnr" item is
Yegappan Lakshmanane0ff3a72022-05-27 18:05:33 +0100969 present, then this item is ignored. This can
970 be a String with a single pattern or a List of
971 patterns.
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +0100972 replace boolean flag, set to v:true to remove all the
973 commands associated with the specified autocmd
974 event and group and add the {cmd}. This is
975 useful to avoid adding the same command
LemonBoy0f7a3e12022-05-26 12:10:37 +0100976 multiple times for an autocmd event in a group.
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +0100977
978 Returns v:true on success and v:false on failure.
979 Examples: >
980 " Create a buffer-local autocmd for buffer 5
981 let acmd = {}
982 let acmd.group = 'MyGroup'
983 let acmd.event = 'BufEnter'
984 let acmd.bufnr = 5
985 let acmd.cmd = 'call BufEnterFunc()'
986 call autocmd_add([acmd])
987
988 Can also be used as a |method|: >
989 GetAutocmdList()->autocmd_add()
990<
991autocmd_delete({acmds}) *autocmd_delete()*
992 Deletes a List of autocmds and autocmd groups.
993
994 The {acmds} argument is a List where each item is a Dict with
995 the following optional items:
996 bufnr buffer number to delete a buffer-local autocmd.
997 If this item is specified, then the "pattern"
998 item is ignored.
999 cmd Ex command for this autocmd event
1000 event autocmd event name. Refer to |autocmd-events|.
1001 If '*' then all the autocmd events in this
1002 group are deleted.
1003 group autocmd group name. Refer to |autocmd-groups|.
1004 If not specified or empty, then the default
1005 group is used.
1006 nested set to v:true for a nested autocmd.
1007 Refer to |autocmd-nested|.
1008 once set to v:true for an autocmd which executes
1009 only once. Refer to |autocmd-once|.
1010 pattern autocmd pattern string. Refer to
1011 |autocmd-patterns|. If "bufnr" item is
1012 present, then this item is ignored.
1013
1014 If only {group} is specified in a {acmds} entry and {event},
1015 {pattern} and {cmd} are not specified, then that autocmd group
1016 is deleted.
1017
Bram Moolenaar016188f2022-06-06 20:52:59 +01001018 Returns |v:true| on success and |v:false| on failure.
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01001019 Examples: >
1020 " :autocmd! BufLeave *.vim
1021 let acmd = #{event: 'BufLeave', pattern: '*.vim'}
1022 call autocmd_delete([acmd]})
1023 " :autocmd! MyGroup1 BufLeave
1024 let acmd = #{group: 'MyGroup1', event: 'BufLeave'}
1025 call autocmd_delete([acmd])
1026 " :autocmd! MyGroup2 BufEnter *.c
1027 let acmd = #{group: 'MyGroup2', event: 'BufEnter',
1028 \ pattern: '*.c'}
1029 " :autocmd! MyGroup2 * *.c
1030 let acmd = #{group: 'MyGroup2', event: '*',
1031 \ pattern: '*.c'}
1032 call autocmd_delete([acmd])
1033 " :autocmd! MyGroup3
1034 let acmd = #{group: 'MyGroup3'}
1035 call autocmd_delete([acmd])
1036<
1037 Can also be used as a |method|: >
1038 GetAutocmdList()->autocmd_delete()
1039
1040autocmd_get([{opts}]) *autocmd_get()*
1041 Returns a |List| of autocmds. If {opts} is not supplied, then
1042 returns the autocmds for all the events in all the groups.
1043
1044 The optional {opts} Dict argument supports the following
1045 items:
1046 group Autocmd group name. If specified, returns only
1047 the autocmds defined in this group. If the
1048 specified group doesn't exist, results in an
1049 error message. If set to an empty string,
1050 then the default autocmd group is used.
1051 event Autocmd event name. If specified, returns only
1052 the autocmds defined for this event. If set
1053 to "*", then returns autocmds for all the
1054 events. If the specified event doesn't exist,
1055 results in an error message.
1056 pattern Autocmd pattern. If specified, returns only
1057 the autocmds defined for this pattern.
1058 A combination of the above three times can be supplied in
1059 {opts}.
1060
1061 Each Dict in the returned List contains the following items:
1062 bufnr For buffer-local autocmds, buffer number where
1063 the autocmd is defined.
1064 cmd Command executed for this autocmd.
1065 event Autocmd event name.
1066 group Autocmd group name.
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +01001067 nested Boolean flag, set to v:true for a nested
1068 autocmd. See |autocmd-nested|.
1069 once Boolean flag, set to v:true, if the autocmd
1070 will be executed only once. See |autocmd-once|.
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01001071 pattern Autocmd pattern. For a buffer-local
1072 autocmd, this will be of the form "<buffer=n>".
1073 If there are multiple commands for an autocmd event in a
1074 group, then separate items are returned for each command.
1075
Bram Moolenaar016188f2022-06-06 20:52:59 +01001076 Returns an empty List if an autocmd with the specified group
1077 or event or pattern is not found.
1078
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01001079 Examples: >
1080 " :autocmd MyGroup
1081 echo autocmd_get(#{group: 'Mygroup'})
1082 " :autocmd G BufUnload
1083 echo autocmd_get(#{group: 'G', event: 'BufUnload'})
1084 " :autocmd G * *.ts
1085 let acmd = #{group: 'G', event: '*', pattern: '*.ts'}
1086 echo autocmd_get(acmd)
1087 " :autocmd Syntax
1088 echo autocmd_get(#{event: 'Syntax'})
1089 " :autocmd G BufEnter *.ts
1090 let acmd = #{group: 'G', event: 'BufEnter',
1091 \ pattern: '*.ts'}
1092 echo autocmd_get(acmd)
1093<
1094 Can also be used as a |method|: >
1095 Getopts()->autocmd_get()
1096<
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001097balloon_gettext() *balloon_gettext()*
1098 Return the current text in the balloon. Only for the string,
Bram Moolenaar016188f2022-06-06 20:52:59 +01001099 not used for the List. Returns an empty string if balloon
1100 is not present.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001101
1102balloon_show({expr}) *balloon_show()*
1103 Show {expr} inside the balloon. For the GUI {expr} is used as
1104 a string. For a terminal {expr} can be a list, which contains
1105 the lines of the balloon. If {expr} is not a list it will be
1106 split with |balloon_split()|.
1107 If {expr} is an empty string any existing balloon is removed.
1108
1109 Example: >
1110 func GetBalloonContent()
1111 " ... initiate getting the content
1112 return ''
1113 endfunc
1114 set balloonexpr=GetBalloonContent()
1115
1116 func BalloonCallback(result)
1117 call balloon_show(a:result)
1118 endfunc
1119< Can also be used as a |method|: >
1120 GetText()->balloon_show()
1121<
1122 The intended use is that fetching the content of the balloon
1123 is initiated from 'balloonexpr'. It will invoke an
1124 asynchronous method, in which a callback invokes
1125 balloon_show(). The 'balloonexpr' itself can return an
Bram Moolenaar069a7d52022-06-27 22:16:08 +01001126 empty string or a placeholder, e.g. "loading...".
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001127
Bram Moolenaar069a7d52022-06-27 22:16:08 +01001128 When showing a balloon is not possible then nothing happens,
1129 no error message is given.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001130 {only available when compiled with the |+balloon_eval| or
1131 |+balloon_eval_term| feature}
1132
1133balloon_split({msg}) *balloon_split()*
1134 Split String {msg} into lines to be displayed in a balloon.
1135 The splits are made for the current window size and optimize
1136 to show debugger output.
Bram Moolenaar016188f2022-06-06 20:52:59 +01001137 Returns a |List| with the split lines. Returns an empty List
1138 on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001139 Can also be used as a |method|: >
1140 GetText()->balloon_split()->balloon_show()
1141
1142< {only available when compiled with the |+balloon_eval_term|
1143 feature}
1144
1145blob2list({blob}) *blob2list()*
1146 Return a List containing the number value of each byte in Blob
1147 {blob}. Examples: >
1148 blob2list(0z0102.0304) returns [1, 2, 3, 4]
1149 blob2list(0z) returns []
1150< Returns an empty List on error. |list2blob()| does the
1151 opposite.
1152
1153 Can also be used as a |method|: >
1154 GetBlob()->blob2list()
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01001155<
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001156 *browse()*
1157browse({save}, {title}, {initdir}, {default})
1158 Put up a file requester. This only works when "has("browse")"
1159 returns |TRUE| (only in some GUI versions).
1160 The input fields are:
1161 {save} when |TRUE|, select file to write
1162 {title} title for the requester
1163 {initdir} directory to start browsing in
1164 {default} default file name
1165 An empty string is returned when the "Cancel" button is hit,
1166 something went wrong, or browsing is not possible.
1167
1168 *browsedir()*
1169browsedir({title}, {initdir})
1170 Put up a directory requester. This only works when
1171 "has("browse")" returns |TRUE| (only in some GUI versions).
1172 On systems where a directory browser is not supported a file
1173 browser is used. In that case: select a file in the directory
1174 to be used.
1175 The input fields are:
1176 {title} title for the requester
1177 {initdir} directory to start browsing in
1178 When the "Cancel" button is hit, something went wrong, or
1179 browsing is not possible, an empty string is returned.
1180
1181bufadd({name}) *bufadd()*
1182 Add a buffer to the buffer list with String {name}.
1183 If a buffer for file {name} already exists, return that buffer
1184 number. Otherwise return the buffer number of the newly
1185 created buffer. When {name} is an empty string then a new
1186 buffer is always created.
1187 The buffer will not have 'buflisted' set and not be loaded
1188 yet. To add some text to the buffer use this: >
1189 let bufnr = bufadd('someName')
1190 call bufload(bufnr)
1191 call setbufline(bufnr, 1, ['some', 'text'])
Bram Moolenaar016188f2022-06-06 20:52:59 +01001192< Returns 0 on error.
1193 Can also be used as a |method|: >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001194 let bufnr = 'somename'->bufadd()
1195
1196bufexists({buf}) *bufexists()*
1197 The result is a Number, which is |TRUE| if a buffer called
1198 {buf} exists.
1199 If the {buf} argument is a number, buffer numbers are used.
1200 Number zero is the alternate buffer for the current window.
1201
1202 If the {buf} argument is a string it must match a buffer name
1203 exactly. The name can be:
1204 - Relative to the current directory.
1205 - A full path.
1206 - The name of a buffer with 'buftype' set to "nofile".
1207 - A URL name.
1208 Unlisted buffers will be found.
1209 Note that help files are listed by their short name in the
1210 output of |:buffers|, but bufexists() requires using their
1211 long name to be able to find them.
1212 bufexists() may report a buffer exists, but to use the name
1213 with a |:buffer| command you may need to use |expand()|. Esp
1214 for MS-Windows 8.3 names in the form "c:\DOCUME~1"
1215 Use "bufexists(0)" to test for the existence of an alternate
1216 file name.
1217
1218 Can also be used as a |method|: >
1219 let exists = 'somename'->bufexists()
1220<
1221 Obsolete name: buffer_exists(). *buffer_exists()*
1222
1223buflisted({buf}) *buflisted()*
1224 The result is a Number, which is |TRUE| if a buffer called
1225 {buf} exists and is listed (has the 'buflisted' option set).
1226 The {buf} argument is used like with |bufexists()|.
1227
1228 Can also be used as a |method|: >
1229 let listed = 'somename'->buflisted()
1230
1231bufload({buf}) *bufload()*
1232 Ensure the buffer {buf} is loaded. When the buffer name
1233 refers to an existing file then the file is read. Otherwise
1234 the buffer will be empty. If the buffer was already loaded
1235 then there is no change.
1236 If there is an existing swap file for the file of the buffer,
1237 there will be no dialog, the buffer will be loaded anyway.
1238 The {buf} argument is used like with |bufexists()|.
1239
1240 Can also be used as a |method|: >
1241 eval 'somename'->bufload()
1242
1243bufloaded({buf}) *bufloaded()*
1244 The result is a Number, which is |TRUE| if a buffer called
1245 {buf} exists and is loaded (shown in a window or hidden).
1246 The {buf} argument is used like with |bufexists()|.
1247
1248 Can also be used as a |method|: >
1249 let loaded = 'somename'->bufloaded()
1250
1251bufname([{buf}]) *bufname()*
1252 The result is the name of a buffer. Mostly as it is displayed
1253 by the `:ls` command, but not using special names such as
1254 "[No Name]".
1255 If {buf} is omitted the current buffer is used.
1256 If {buf} is a Number, that buffer number's name is given.
1257 Number zero is the alternate buffer for the current window.
1258 If {buf} is a String, it is used as a |file-pattern| to match
1259 with the buffer names. This is always done like 'magic' is
1260 set and 'cpoptions' is empty. When there is more than one
1261 match an empty string is returned.
1262 "" or "%" can be used for the current buffer, "#" for the
1263 alternate buffer.
1264 A full match is preferred, otherwise a match at the start, end
1265 or middle of the buffer name is accepted. If you only want a
1266 full match then put "^" at the start and "$" at the end of the
1267 pattern.
1268 Listed buffers are found first. If there is a single match
1269 with a listed buffer, that one is returned. Next unlisted
1270 buffers are searched for.
1271 If the {buf} is a String, but you want to use it as a buffer
1272 number, force it to be a Number by adding zero to it: >
1273 :echo bufname("3" + 0)
1274< Can also be used as a |method|: >
1275 echo bufnr->bufname()
1276
1277< If the buffer doesn't exist, or doesn't have a name, an empty
1278 string is returned. >
1279 bufname("#") alternate buffer name
1280 bufname(3) name of buffer 3
1281 bufname("%") name of current buffer
1282 bufname("file2") name of buffer where "file2" matches.
1283< *buffer_name()*
1284 Obsolete name: buffer_name().
1285
1286 *bufnr()*
1287bufnr([{buf} [, {create}]])
1288 The result is the number of a buffer, as it is displayed by
1289 the `:ls` command. For the use of {buf}, see |bufname()|
1290 above.
1291
1292 If the buffer doesn't exist, -1 is returned. Or, if the
1293 {create} argument is present and TRUE, a new, unlisted,
1294 buffer is created and its number is returned. Example: >
1295 let newbuf = bufnr('Scratch001', 1)
1296< Using an empty name uses the current buffer. To create a new
1297 buffer with an empty name use |bufadd()|.
1298
1299 bufnr("$") is the last buffer: >
1300 :let last_buffer = bufnr("$")
1301< The result is a Number, which is the highest buffer number
1302 of existing buffers. Note that not all buffers with a smaller
1303 number necessarily exist, because ":bwipeout" may have removed
1304 them. Use bufexists() to test for the existence of a buffer.
1305
1306 Can also be used as a |method|: >
1307 echo bufref->bufnr()
1308<
1309 Obsolete name: buffer_number(). *buffer_number()*
1310 *last_buffer_nr()*
1311 Obsolete name for bufnr("$"): last_buffer_nr().
1312
1313bufwinid({buf}) *bufwinid()*
1314 The result is a Number, which is the |window-ID| of the first
1315 window associated with buffer {buf}. For the use of {buf},
1316 see |bufname()| above. If buffer {buf} doesn't exist or
1317 there is no such window, -1 is returned. Example: >
1318
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001319 echo "A window containing buffer 1 is " .. (bufwinid(1))
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001320<
1321 Only deals with the current tab page.
1322
1323 Can also be used as a |method|: >
1324 FindBuffer()->bufwinid()
1325
1326bufwinnr({buf}) *bufwinnr()*
1327 Like |bufwinid()| but return the window number instead of the
1328 |window-ID|.
1329 If buffer {buf} doesn't exist or there is no such window, -1
1330 is returned. Example: >
1331
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001332 echo "A window containing buffer 1 is " .. (bufwinnr(1))
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001333
1334< The number can be used with |CTRL-W_w| and ":wincmd w"
1335 |:wincmd|.
1336
1337 Can also be used as a |method|: >
1338 FindBuffer()->bufwinnr()
1339
1340byte2line({byte}) *byte2line()*
1341 Return the line number that contains the character at byte
1342 count {byte} in the current buffer. This includes the
1343 end-of-line character, depending on the 'fileformat' option
1344 for the current buffer. The first character has byte count
1345 one.
1346 Also see |line2byte()|, |go| and |:goto|.
1347
Bram Moolenaar016188f2022-06-06 20:52:59 +01001348 Returns -1 if the {byte} value is invalid.
1349
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001350 Can also be used as a |method|: >
1351 GetOffset()->byte2line()
1352
1353< {not available when compiled without the |+byte_offset|
1354 feature}
1355
1356byteidx({expr}, {nr}) *byteidx()*
1357 Return byte index of the {nr}'th character in the String
1358 {expr}. Use zero for the first character, it then returns
1359 zero.
1360 If there are no multibyte characters the returned value is
1361 equal to {nr}.
1362 Composing characters are not counted separately, their byte
1363 length is added to the preceding base character. See
1364 |byteidxcomp()| below for counting composing characters
1365 separately.
1366 Example : >
1367 echo matchstr(str, ".", byteidx(str, 3))
1368< will display the fourth character. Another way to do the
1369 same: >
1370 let s = strpart(str, byteidx(str, 3))
1371 echo strpart(s, 0, byteidx(s, 1))
1372< Also see |strgetchar()| and |strcharpart()|.
1373
1374 If there are less than {nr} characters -1 is returned.
1375 If there are exactly {nr} characters the length of the string
1376 in bytes is returned.
1377
1378 Can also be used as a |method|: >
1379 GetName()->byteidx(idx)
1380
1381byteidxcomp({expr}, {nr}) *byteidxcomp()*
1382 Like byteidx(), except that a composing character is counted
1383 as a separate character. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001384 let s = 'e' .. nr2char(0x301)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001385 echo byteidx(s, 1)
1386 echo byteidxcomp(s, 1)
1387 echo byteidxcomp(s, 2)
1388< The first and third echo result in 3 ('e' plus composing
1389 character is 3 bytes), the second echo results in 1 ('e' is
1390 one byte).
1391 Only works differently from byteidx() when 'encoding' is set
1392 to a Unicode encoding.
1393
1394 Can also be used as a |method|: >
1395 GetName()->byteidxcomp(idx)
1396
1397call({func}, {arglist} [, {dict}]) *call()* *E699*
1398 Call function {func} with the items in |List| {arglist} as
1399 arguments.
1400 {func} can either be a |Funcref| or the name of a function.
1401 a:firstline and a:lastline are set to the cursor line.
1402 Returns the return value of the called function.
1403 {dict} is for functions with the "dict" attribute. It will be
1404 used to set the local variable "self". |Dictionary-function|
1405
1406 Can also be used as a |method|: >
1407 GetFunc()->call([arg, arg], dict)
1408
1409ceil({expr}) *ceil()*
1410 Return the smallest integral value greater than or equal to
1411 {expr} as a |Float| (round up).
1412 {expr} must evaluate to a |Float| or a |Number|.
1413 Examples: >
1414 echo ceil(1.456)
1415< 2.0 >
1416 echo ceil(-5.456)
1417< -5.0 >
1418 echo ceil(4.0)
1419< 4.0
1420
Bram Moolenaar016188f2022-06-06 20:52:59 +01001421 Returns 0.0 if {expr} is not a |Float| or a |Number|.
1422
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001423 Can also be used as a |method|: >
1424 Compute()->ceil()
1425<
1426 {only available when compiled with the |+float| feature}
1427
1428
1429ch_ functions are documented here: |channel-functions-details|
1430
1431
1432changenr() *changenr()*
1433 Return the number of the most recent change. This is the same
1434 number as what is displayed with |:undolist| and can be used
1435 with the |:undo| command.
1436 When a change was made it is the number of that change. After
1437 redo it is the number of the redone change. After undo it is
1438 one less than the number of the undone change.
Bram Moolenaar016188f2022-06-06 20:52:59 +01001439 Returns 0 if the undo list is empty.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001440
1441char2nr({string} [, {utf8}]) *char2nr()*
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01001442 Return Number value of the first char in {string}.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001443 Examples: >
1444 char2nr(" ") returns 32
1445 char2nr("ABC") returns 65
1446< When {utf8} is omitted or zero, the current 'encoding' is used.
1447 Example for "utf-8": >
1448 char2nr("á") returns 225
1449 char2nr("á"[0]) returns 195
1450< When {utf8} is TRUE, always treat as UTF-8 characters.
1451 A combining character is a separate character.
1452 |nr2char()| does the opposite.
1453 To turn a string into a list of character numbers: >
1454 let str = "ABC"
1455 let list = map(split(str, '\zs'), {_, val -> char2nr(val)})
1456< Result: [65, 66, 67]
1457
Bram Moolenaar016188f2022-06-06 20:52:59 +01001458 Returns 0 if {string} is not a |String|.
1459
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001460 Can also be used as a |method|: >
1461 GetChar()->char2nr()
1462
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001463charclass({string}) *charclass()*
1464 Return the character class of the first character in {string}.
1465 The character class is one of:
1466 0 blank
1467 1 punctuation
1468 2 word character
1469 3 emoji
1470 other specific Unicode class
1471 The class is used in patterns and word motions.
Bram Moolenaar016188f2022-06-06 20:52:59 +01001472 Returns 0 if {string} is not a |String|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001473
1474
1475charcol({expr}) *charcol()*
1476 Same as |col()| but returns the character index of the column
1477 position given with {expr} instead of the byte position.
1478
1479 Example:
1480 With the cursor on '세' in line 5 with text "여보세요": >
1481 charcol('.') returns 3
1482 col('.') returns 7
1483
1484< Can also be used as a |method|: >
1485 GetPos()->col()
1486<
1487 *charidx()*
1488charidx({string}, {idx} [, {countcc}])
1489 Return the character index of the byte at {idx} in {string}.
1490 The index of the first character is zero.
1491 If there are no multibyte characters the returned value is
1492 equal to {idx}.
1493 When {countcc} is omitted or |FALSE|, then composing characters
1494 are not counted separately, their byte length is
1495 added to the preceding base character.
1496 When {countcc} is |TRUE|, then composing characters are
1497 counted as separate characters.
1498 Returns -1 if the arguments are invalid or if {idx} is greater
1499 than the index of the last byte in {string}. An error is
1500 given if the first argument is not a string, the second
1501 argument is not a number or when the third argument is present
1502 and is not zero or one.
1503 See |byteidx()| and |byteidxcomp()| for getting the byte index
1504 from the character index.
1505 Examples: >
1506 echo charidx('áb́ć', 3) returns 1
1507 echo charidx('áb́ć', 6, 1) returns 4
1508 echo charidx('áb́ć', 16) returns -1
1509<
1510 Can also be used as a |method|: >
1511 GetName()->charidx(idx)
1512
1513chdir({dir}) *chdir()*
1514 Change the current working directory to {dir}. The scope of
1515 the directory change depends on the directory of the current
1516 window:
1517 - If the current window has a window-local directory
1518 (|:lcd|), then changes the window local directory.
1519 - Otherwise, if the current tabpage has a local
1520 directory (|:tcd|) then changes the tabpage local
1521 directory.
1522 - Otherwise, changes the global directory.
1523 {dir} must be a String.
1524 If successful, returns the previous working directory. Pass
1525 this to another chdir() to restore the directory.
1526 On failure, returns an empty string.
1527
1528 Example: >
1529 let save_dir = chdir(newdir)
1530 if save_dir != ""
1531 " ... do some work
1532 call chdir(save_dir)
1533 endif
1534
1535< Can also be used as a |method|: >
1536 GetDir()->chdir()
1537<
1538cindent({lnum}) *cindent()*
1539 Get the amount of indent for line {lnum} according the C
1540 indenting rules, as with 'cindent'.
1541 The indent is counted in spaces, the value of 'tabstop' is
1542 relevant. {lnum} is used just like in |getline()|.
Bram Moolenaar8e145b82022-05-21 20:17:31 +01001543 When {lnum} is invalid -1 is returned.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001544 See |C-indenting|.
1545
1546 Can also be used as a |method|: >
1547 GetLnum()->cindent()
1548
1549clearmatches([{win}]) *clearmatches()*
1550 Clears all matches previously defined for the current window
1551 by |matchadd()| and the |:match| commands.
1552 If {win} is specified, use the window with this number or
1553 window ID instead of the current window.
1554
1555 Can also be used as a |method|: >
1556 GetWin()->clearmatches()
1557<
1558 *col()*
1559col({expr}) The result is a Number, which is the byte index of the column
1560 position given with {expr}. The accepted positions are:
1561 . the cursor position
1562 $ the end of the cursor line (the result is the
1563 number of bytes in the cursor line plus one)
1564 'x position of mark x (if the mark is not set, 0 is
1565 returned)
1566 v In Visual mode: the start of the Visual area (the
1567 cursor is the end). When not in Visual mode
1568 returns the cursor position. Differs from |'<| in
1569 that it's updated right away.
1570 Additionally {expr} can be [lnum, col]: a |List| with the line
1571 and column number. Most useful when the column is "$", to get
1572 the last column of a specific line. When "lnum" or "col" is
1573 out of range then col() returns zero.
1574 To get the line number use |line()|. To get both use
1575 |getpos()|.
1576 For the screen column position use |virtcol()|. For the
1577 character position use |charcol()|.
1578 Note that only marks in the current file can be used.
1579 Examples: >
1580 col(".") column of cursor
1581 col("$") length of cursor line plus one
1582 col("'t") column of mark t
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001583 col("'" .. markname) column of mark markname
Bram Moolenaar016188f2022-06-06 20:52:59 +01001584< The first column is 1. Returns 0 if {expr} is invalid.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001585 For an uppercase mark the column may actually be in another
1586 buffer.
1587 For the cursor position, when 'virtualedit' is active, the
1588 column is one higher if the cursor is after the end of the
1589 line. This can be used to obtain the column in Insert mode: >
1590 :imap <F2> <C-O>:let save_ve = &ve<CR>
1591 \<C-O>:set ve=all<CR>
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001592 \<C-O>:echo col(".") .. "\n" <Bar>
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001593 \let &ve = save_ve<CR>
1594
1595< Can also be used as a |method|: >
1596 GetPos()->col()
1597<
1598
1599complete({startcol}, {matches}) *complete()* *E785*
1600 Set the matches for Insert mode completion.
1601 Can only be used in Insert mode. You need to use a mapping
1602 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O
1603 or with an expression mapping.
1604 {startcol} is the byte offset in the line where the completed
1605 text start. The text up to the cursor is the original text
1606 that will be replaced by the matches. Use col('.') for an
1607 empty string. "col('.') - 1" will replace one character by a
1608 match.
1609 {matches} must be a |List|. Each |List| item is one match.
1610 See |complete-items| for the kind of items that are possible.
1611 "longest" in 'completeopt' is ignored.
1612 Note that the after calling this function you need to avoid
1613 inserting anything that would cause completion to stop.
1614 The match can be selected with CTRL-N and CTRL-P as usual with
1615 Insert mode completion. The popup menu will appear if
1616 specified, see |ins-completion-menu|.
1617 Example: >
1618 inoremap <F5> <C-R>=ListMonths()<CR>
1619
1620 func! ListMonths()
1621 call complete(col('.'), ['January', 'February', 'March',
1622 \ 'April', 'May', 'June', 'July', 'August', 'September',
1623 \ 'October', 'November', 'December'])
1624 return ''
1625 endfunc
1626< This isn't very useful, but it shows how it works. Note that
1627 an empty string is returned to avoid a zero being inserted.
1628
1629 Can also be used as a |method|, the base is passed as the
1630 second argument: >
1631 GetMatches()->complete(col('.'))
1632
1633complete_add({expr}) *complete_add()*
1634 Add {expr} to the list of matches. Only to be used by the
1635 function specified with the 'completefunc' option.
1636 Returns 0 for failure (empty string or out of memory),
1637 1 when the match was added, 2 when the match was already in
1638 the list.
1639 See |complete-functions| for an explanation of {expr}. It is
1640 the same as one item in the list that 'omnifunc' would return.
1641
1642 Can also be used as a |method|: >
1643 GetMoreMatches()->complete_add()
1644
1645complete_check() *complete_check()*
1646 Check for a key typed while looking for completion matches.
1647 This is to be used when looking for matches takes some time.
1648 Returns |TRUE| when searching for matches is to be aborted,
1649 zero otherwise.
1650 Only to be used by the function specified with the
1651 'completefunc' option.
1652
1653
1654complete_info([{what}]) *complete_info()*
1655 Returns a |Dictionary| with information about Insert mode
1656 completion. See |ins-completion|.
1657 The items are:
1658 mode Current completion mode name string.
1659 See |complete_info_mode| for the values.
1660 pum_visible |TRUE| if popup menu is visible.
1661 See |pumvisible()|.
1662 items List of completion matches. Each item is a
1663 dictionary containing the entries "word",
1664 "abbr", "menu", "kind", "info" and "user_data".
1665 See |complete-items|.
1666 selected Selected item index. First index is zero.
1667 Index is -1 if no item is selected (showing
1668 typed text only, or the last completion after
1669 no item is selected when using the <Up> or
1670 <Down> keys)
1671 inserted Inserted string. [NOT IMPLEMENT YET]
1672
1673 *complete_info_mode*
1674 mode values are:
1675 "" Not in completion mode
1676 "keyword" Keyword completion |i_CTRL-X_CTRL-N|
1677 "ctrl_x" Just pressed CTRL-X |i_CTRL-X|
1678 "scroll" Scrolling with |i_CTRL-X_CTRL-E| or
1679 |i_CTRL-X_CTRL-Y|
1680 "whole_line" Whole lines |i_CTRL-X_CTRL-L|
1681 "files" File names |i_CTRL-X_CTRL-F|
1682 "tags" Tags |i_CTRL-X_CTRL-]|
1683 "path_defines" Definition completion |i_CTRL-X_CTRL-D|
1684 "path_patterns" Include completion |i_CTRL-X_CTRL-I|
1685 "dictionary" Dictionary |i_CTRL-X_CTRL-K|
1686 "thesaurus" Thesaurus |i_CTRL-X_CTRL-T|
1687 "cmdline" Vim Command line |i_CTRL-X_CTRL-V|
1688 "function" User defined completion |i_CTRL-X_CTRL-U|
1689 "omni" Omni completion |i_CTRL-X_CTRL-O|
1690 "spell" Spelling suggestions |i_CTRL-X_s|
1691 "eval" |complete()| completion
1692 "unknown" Other internal modes
1693
1694 If the optional {what} list argument is supplied, then only
1695 the items listed in {what} are returned. Unsupported items in
1696 {what} are silently ignored.
1697
1698 To get the position and size of the popup menu, see
1699 |pum_getpos()|. It's also available in |v:event| during the
1700 |CompleteChanged| event.
1701
Bram Moolenaar016188f2022-06-06 20:52:59 +01001702 Returns an empty |Dictionary| on error.
1703
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001704 Examples: >
1705 " Get all items
1706 call complete_info()
1707 " Get only 'mode'
1708 call complete_info(['mode'])
1709 " Get only 'mode' and 'pum_visible'
1710 call complete_info(['mode', 'pum_visible'])
1711
1712< Can also be used as a |method|: >
1713 GetItems()->complete_info()
1714<
1715 *confirm()*
1716confirm({msg} [, {choices} [, {default} [, {type}]]])
1717 confirm() offers the user a dialog, from which a choice can be
1718 made. It returns the number of the choice. For the first
1719 choice this is 1.
1720 Note: confirm() is only supported when compiled with dialog
1721 support, see |+dialog_con| and |+dialog_gui|.
1722
1723 {msg} is displayed in a |dialog| with {choices} as the
1724 alternatives. When {choices} is missing or empty, "&OK" is
1725 used (and translated).
1726 {msg} is a String, use '\n' to include a newline. Only on
1727 some systems the string is wrapped when it doesn't fit.
1728
1729 {choices} is a String, with the individual choices separated
1730 by '\n', e.g. >
1731 confirm("Save changes?", "&Yes\n&No\n&Cancel")
1732< The letter after the '&' is the shortcut key for that choice.
1733 Thus you can type 'c' to select "Cancel". The shortcut does
1734 not need to be the first letter: >
1735 confirm("file has been modified", "&Save\nSave &All")
1736< For the console, the first letter of each choice is used as
1737 the default shortcut key. Case is ignored.
1738
1739 The optional {default} argument is the number of the choice
1740 that is made if the user hits <CR>. Use 1 to make the first
1741 choice the default one. Use 0 to not set a default. If
1742 {default} is omitted, 1 is used.
1743
1744 The optional {type} String argument gives the type of dialog.
1745 This is only used for the icon of the GTK, Mac, Motif and
1746 Win32 GUI. It can be one of these values: "Error",
1747 "Question", "Info", "Warning" or "Generic". Only the first
1748 character is relevant. When {type} is omitted, "Generic" is
1749 used.
1750
1751 If the user aborts the dialog by pressing <Esc>, CTRL-C,
1752 or another valid interrupt key, confirm() returns 0.
1753
1754 An example: >
Bram Moolenaar46eea442022-03-30 10:51:39 +01001755 let choice = confirm("What do you want?",
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01001756 \ "&Apples\n&Oranges\n&Bananas", 2)
Bram Moolenaar46eea442022-03-30 10:51:39 +01001757 if choice == 0
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01001758 echo "make up your mind!"
Bram Moolenaar46eea442022-03-30 10:51:39 +01001759 elseif choice == 3
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01001760 echo "tasteful"
Bram Moolenaar46eea442022-03-30 10:51:39 +01001761 else
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01001762 echo "I prefer bananas myself."
Bram Moolenaar46eea442022-03-30 10:51:39 +01001763 endif
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001764< In a GUI dialog, buttons are used. The layout of the buttons
1765 depends on the 'v' flag in 'guioptions'. If it is included,
1766 the buttons are always put vertically. Otherwise, confirm()
1767 tries to put the buttons in one horizontal line. If they
1768 don't fit, a vertical layout is used anyway. For some systems
1769 the horizontal layout is always used.
1770
1771 Can also be used as a |method|in: >
1772 BuildMessage()->confirm("&Yes\n&No")
1773<
1774 *copy()*
1775copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
1776 different from using {expr} directly.
1777 When {expr} is a |List| a shallow copy is created. This means
1778 that the original |List| can be changed without changing the
1779 copy, and vice versa. But the items are identical, thus
1780 changing an item changes the contents of both |Lists|.
1781 A |Dictionary| is copied in a similar way as a |List|.
1782 Also see |deepcopy()|.
1783 Can also be used as a |method|: >
1784 mylist->copy()
1785
1786cos({expr}) *cos()*
1787 Return the cosine of {expr}, measured in radians, as a |Float|.
1788 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar016188f2022-06-06 20:52:59 +01001789 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001790 Examples: >
1791 :echo cos(100)
1792< 0.862319 >
1793 :echo cos(-4.01)
1794< -0.646043
1795
1796 Can also be used as a |method|: >
1797 Compute()->cos()
1798<
1799 {only available when compiled with the |+float| feature}
1800
1801
1802cosh({expr}) *cosh()*
1803 Return the hyperbolic cosine of {expr} as a |Float| in the range
1804 [1, inf].
1805 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar016188f2022-06-06 20:52:59 +01001806 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001807 Examples: >
1808 :echo cosh(0.5)
1809< 1.127626 >
1810 :echo cosh(-0.5)
1811< -1.127626
1812
1813 Can also be used as a |method|: >
1814 Compute()->cosh()
1815<
1816 {only available when compiled with the |+float| feature}
1817
1818
1819count({comp}, {expr} [, {ic} [, {start}]]) *count()*
1820 Return the number of times an item with value {expr} appears
1821 in |String|, |List| or |Dictionary| {comp}.
1822
1823 If {start} is given then start with the item with this index.
1824 {start} can only be used with a |List|.
1825
1826 When {ic} is given and it's |TRUE| then case is ignored.
1827
1828 When {comp} is a string then the number of not overlapping
1829 occurrences of {expr} is returned. Zero is returned when
1830 {expr} is an empty string.
1831
1832 Can also be used as a |method|: >
1833 mylist->count(val)
1834<
1835 *cscope_connection()*
1836cscope_connection([{num} , {dbpath} [, {prepend}]])
1837 Checks for the existence of a |cscope| connection. If no
1838 parameters are specified, then the function returns:
1839 0, if cscope was not available (not compiled in), or
1840 if there are no cscope connections;
1841 1, if there is at least one cscope connection.
1842
1843 If parameters are specified, then the value of {num}
1844 determines how existence of a cscope connection is checked:
1845
1846 {num} Description of existence check
1847 ----- ------------------------------
1848 0 Same as no parameters (e.g., "cscope_connection()").
1849 1 Ignore {prepend}, and use partial string matches for
1850 {dbpath}.
1851 2 Ignore {prepend}, and use exact string matches for
1852 {dbpath}.
1853 3 Use {prepend}, use partial string matches for both
1854 {dbpath} and {prepend}.
1855 4 Use {prepend}, use exact string matches for both
1856 {dbpath} and {prepend}.
1857
1858 Note: All string comparisons are case sensitive!
1859
1860 Examples. Suppose we had the following (from ":cs show"): >
1861
1862 # pid database name prepend path
1863 0 27664 cscope.out /usr/local
1864<
1865 Invocation Return Val ~
1866 ---------- ---------- >
1867 cscope_connection() 1
1868 cscope_connection(1, "out") 1
1869 cscope_connection(2, "out") 0
1870 cscope_connection(3, "out") 0
1871 cscope_connection(3, "out", "local") 1
1872 cscope_connection(4, "out") 0
1873 cscope_connection(4, "out", "local") 0
1874 cscope_connection(4, "cscope.out", "/usr/local") 1
1875<
1876cursor({lnum}, {col} [, {off}]) *cursor()*
1877cursor({list})
1878 Positions the cursor at the column (byte count) {col} in the
1879 line {lnum}. The first column is one.
1880
1881 When there is one argument {list} this is used as a |List|
1882 with two, three or four item:
1883 [{lnum}, {col}]
1884 [{lnum}, {col}, {off}]
1885 [{lnum}, {col}, {off}, {curswant}]
1886 This is like the return value of |getpos()| or |getcurpos()|,
1887 but without the first item.
1888
1889 To position the cursor using the character count, use
1890 |setcursorcharpos()|.
1891
1892 Does not change the jumplist.
1893 {lnum} is used like with |getline()|.
1894 If {lnum} is greater than the number of lines in the buffer,
1895 the cursor will be positioned at the last line in the buffer.
1896 If {lnum} is zero, the cursor will stay in the current line.
1897 If {col} is greater than the number of bytes in the line,
1898 the cursor will be positioned at the last character in the
1899 line.
1900 If {col} is zero, the cursor will stay in the current column.
1901 If {curswant} is given it is used to set the preferred column
1902 for vertical movement. Otherwise {col} is used.
1903
1904 When 'virtualedit' is used {off} specifies the offset in
1905 screen columns from the start of the character. E.g., a
1906 position within a <Tab> or after the last character.
1907 Returns 0 when the position could be set, -1 otherwise.
1908
1909 Can also be used as a |method|: >
1910 GetCursorPos()->cursor()
1911
1912debugbreak({pid}) *debugbreak()*
1913 Specifically used to interrupt a program being debugged. It
1914 will cause process {pid} to get a SIGTRAP. Behavior for other
1915 processes is undefined. See |terminal-debugger|.
1916 {only available on MS-Windows}
1917
Bram Moolenaar016188f2022-06-06 20:52:59 +01001918 Returns |TRUE| if successfully interrupted the program.
1919 Otherwise returns |FALSE|.
1920
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001921 Can also be used as a |method|: >
1922 GetPid()->debugbreak()
1923
1924deepcopy({expr} [, {noref}]) *deepcopy()* *E698*
1925 Make a copy of {expr}. For Numbers and Strings this isn't
1926 different from using {expr} directly.
1927 When {expr} is a |List| a full copy is created. This means
1928 that the original |List| can be changed without changing the
1929 copy, and vice versa. When an item is a |List| or
1930 |Dictionary|, a copy for it is made, recursively. Thus
1931 changing an item in the copy does not change the contents of
1932 the original |List|.
1933 A |Dictionary| is copied in a similar way as a |List|.
1934
1935 When {noref} is omitted or zero a contained |List| or
1936 |Dictionary| is only copied once. All references point to
1937 this single copy. With {noref} set to 1 every occurrence of a
1938 |List| or |Dictionary| results in a new copy. This also means
1939 that a cyclic reference causes deepcopy() to fail.
1940 *E724*
1941 Nesting is possible up to 100 levels. When there is an item
1942 that refers back to a higher level making a deep copy with
1943 {noref} set to 1 will fail.
1944 Also see |copy()|.
1945
1946 Can also be used as a |method|: >
1947 GetObject()->deepcopy()
1948
1949delete({fname} [, {flags}]) *delete()*
1950 Without {flags} or with {flags} empty: Deletes the file by the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001951 name {fname}.
1952
1953 This also works when {fname} is a symbolic link. The symbolic
1954 link itself is deleted, not what it points to.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001955
1956 When {flags} is "d": Deletes the directory by the name
1957 {fname}. This fails when directory {fname} is not empty.
1958
1959 When {flags} is "rf": Deletes the directory by the name
1960 {fname} and everything in it, recursively. BE CAREFUL!
1961 Note: on MS-Windows it is not possible to delete a directory
1962 that is being used.
1963
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001964 The result is a Number, which is 0/false if the delete
1965 operation was successful and -1/true when the deletion failed
1966 or partly failed.
1967
1968 Use |remove()| to delete an item from a |List|.
1969 To delete a line from the buffer use |:delete| or
1970 |deletebufline()|.
1971
1972 Can also be used as a |method|: >
1973 GetName()->delete()
1974
1975deletebufline({buf}, {first} [, {last}]) *deletebufline()*
1976 Delete lines {first} to {last} (inclusive) from buffer {buf}.
1977 If {last} is omitted then delete line {first} only.
1978 On success 0 is returned, on failure 1 is returned.
1979
1980 This function works only for loaded buffers. First call
1981 |bufload()| if needed.
1982
1983 For the use of {buf}, see |bufname()| above.
1984
1985 {first} and {last} are used like with |getline()|. Note that
1986 when using |line()| this refers to the current buffer. Use "$"
1987 to refer to the last line in buffer {buf}.
1988
1989 Can also be used as a |method|: >
1990 GetBuffer()->deletebufline(1)
1991<
1992 *did_filetype()*
1993did_filetype() Returns |TRUE| when autocommands are being executed and the
1994 FileType event has been triggered at least once. Can be used
1995 to avoid triggering the FileType event again in the scripts
1996 that detect the file type. |FileType|
1997 Returns |FALSE| when `:setf FALLBACK` was used.
1998 When editing another file, the counter is reset, thus this
1999 really checks if the FileType event has been triggered for the
2000 current buffer. This allows an autocommand that starts
2001 editing another buffer to set 'filetype' and load a syntax
2002 file.
2003
2004diff_filler({lnum}) *diff_filler()*
2005 Returns the number of filler lines above line {lnum}.
2006 These are the lines that were inserted at this point in
2007 another diff'ed window. These filler lines are shown in the
2008 display but don't exist in the buffer.
2009 {lnum} is used like with |getline()|. Thus "." is the current
2010 line, "'m" mark m, etc.
2011 Returns 0 if the current window is not in diff mode.
2012
2013 Can also be used as a |method|: >
2014 GetLnum()->diff_filler()
2015
2016diff_hlID({lnum}, {col}) *diff_hlID()*
2017 Returns the highlight ID for diff mode at line {lnum} column
2018 {col} (byte index). When the current line does not have a
2019 diff change zero is returned.
2020 {lnum} is used like with |getline()|. Thus "." is the current
2021 line, "'m" mark m, etc.
2022 {col} is 1 for the leftmost column, {lnum} is 1 for the first
2023 line.
2024 The highlight ID can be used with |synIDattr()| to obtain
2025 syntax information about the highlighting.
2026
2027 Can also be used as a |method|: >
2028 GetLnum()->diff_hlID(col)
2029<
2030
2031digraph_get({chars}) *digraph_get()* *E1214*
2032 Return the digraph of {chars}. This should be a string with
2033 exactly two characters. If {chars} are not just two
2034 characters, or the digraph of {chars} does not exist, an error
2035 is given and an empty string is returned.
2036
2037 The character will be converted from Unicode to 'encoding'
2038 when needed. This does require the conversion to be
2039 available, it might fail.
2040
2041 Also see |digraph_getlist()|.
2042
2043 Examples: >
2044 " Get a built-in digraph
2045 :echo digraph_get('00') " Returns '∞'
2046
2047 " Get a user-defined digraph
2048 :call digraph_set('aa', 'あ')
2049 :echo digraph_get('aa') " Returns 'あ'
2050<
2051 Can also be used as a |method|: >
2052 GetChars()->digraph_get()
2053<
2054 This function works only when compiled with the |+digraphs|
2055 feature. If this feature is disabled, this function will
2056 display an error message.
2057
2058
2059digraph_getlist([{listall}]) *digraph_getlist()*
2060 Return a list of digraphs. If the {listall} argument is given
2061 and it is TRUE, return all digraphs, including the default
2062 digraphs. Otherwise, return only user-defined digraphs.
2063
2064 The characters will be converted from Unicode to 'encoding'
2065 when needed. This does require the conservation to be
2066 available, it might fail.
2067
2068 Also see |digraph_get()|.
2069
2070 Examples: >
2071 " Get user-defined digraphs
2072 :echo digraph_getlist()
2073
2074 " Get all the digraphs, including default digraphs
2075 :echo digraph_getlist(1)
2076<
2077 Can also be used as a |method|: >
2078 GetNumber()->digraph_getlist()
2079<
2080 This function works only when compiled with the |+digraphs|
2081 feature. If this feature is disabled, this function will
2082 display an error message.
2083
2084
Bram Moolenaara2baa732022-02-04 16:09:54 +00002085digraph_set({chars}, {digraph}) *digraph_set()*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002086 Add digraph {chars} to the list. {chars} must be a string
2087 with two characters. {digraph} is a string with one UTF-8
Bram Moolenaara2baa732022-02-04 16:09:54 +00002088 encoded character. *E1215*
2089 Be careful, composing characters are NOT ignored. This
2090 function is similar to |:digraphs| command, but useful to add
2091 digraphs start with a white space.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002092
2093 The function result is v:true if |digraph| is registered. If
2094 this fails an error message is given and v:false is returned.
2095
2096 If you want to define multiple digraphs at once, you can use
2097 |digraph_setlist()|.
2098
2099 Example: >
2100 call digraph_set(' ', 'あ')
2101<
2102 Can be used as a |method|: >
2103 GetString()->digraph_set('あ')
2104<
2105 This function works only when compiled with the |+digraphs|
2106 feature. If this feature is disabled, this function will
2107 display an error message.
2108
2109
2110digraph_setlist({digraphlist}) *digraph_setlist()*
2111 Similar to |digraph_set()| but this function can add multiple
2112 digraphs at once. {digraphlist} is a list composed of lists,
2113 where each list contains two strings with {chars} and
Bram Moolenaara2baa732022-02-04 16:09:54 +00002114 {digraph} as in |digraph_set()|. *E1216*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002115 Example: >
2116 call digraph_setlist([['aa', 'あ'], ['ii', 'い']])
2117<
2118 It is similar to the following: >
2119 for [chars, digraph] in [['aa', 'あ'], ['ii', 'い']]
2120 call digraph_set(chars, digraph)
2121 endfor
2122< Except that the function returns after the first error,
2123 following digraphs will not be added.
2124
2125 Can be used as a |method|: >
2126 GetList()->digraph_setlist()
2127<
2128 This function works only when compiled with the |+digraphs|
2129 feature. If this feature is disabled, this function will
2130 display an error message.
2131
2132
2133echoraw({string}) *echoraw()*
2134 Output {string} as-is, including unprintable characters.
2135 This can be used to output a terminal code. For example, to
2136 disable modifyOtherKeys: >
2137 call echoraw(&t_TE)
2138< and to enable it again: >
2139 call echoraw(&t_TI)
2140< Use with care, you can mess up the terminal this way.
2141
2142
2143empty({expr}) *empty()*
2144 Return the Number 1 if {expr} is empty, zero otherwise.
2145 - A |List| or |Dictionary| is empty when it does not have any
2146 items.
2147 - A |String| is empty when its length is zero.
2148 - A |Number| and |Float| are empty when their value is zero.
2149 - |v:false|, |v:none| and |v:null| are empty, |v:true| is not.
2150 - A |Job| is empty when it failed to start.
2151 - A |Channel| is empty when it is closed.
2152 - A |Blob| is empty when its length is zero.
2153
2154 For a long |List| this is much faster than comparing the
2155 length with zero.
2156
2157 Can also be used as a |method|: >
2158 mylist->empty()
2159
2160environ() *environ()*
2161 Return all of environment variables as dictionary. You can
2162 check if an environment variable exists like this: >
2163 :echo has_key(environ(), 'HOME')
2164< Note that the variable name may be CamelCase; to ignore case
2165 use this: >
2166 :echo index(keys(environ()), 'HOME', 0, 1) != -1
2167
2168escape({string}, {chars}) *escape()*
2169 Escape the characters in {chars} that occur in {string} with a
2170 backslash. Example: >
2171 :echo escape('c:\program files\vim', ' \')
2172< results in: >
2173 c:\\program\ files\\vim
2174< Also see |shellescape()| and |fnameescape()|.
2175
2176 Can also be used as a |method|: >
2177 GetText()->escape(' \')
2178<
2179 *eval()*
2180eval({string}) Evaluate {string} and return the result. Especially useful to
2181 turn the result of |string()| back into the original value.
2182 This works for Numbers, Floats, Strings, Blobs and composites
2183 of them. Also works for |Funcref|s that refer to existing
2184 functions.
2185
2186 Can also be used as a |method|: >
2187 argv->join()->eval()
2188
2189eventhandler() *eventhandler()*
2190 Returns 1 when inside an event handler. That is that Vim got
2191 interrupted while waiting for the user to type a character,
2192 e.g., when dropping a file on Vim. This means interactive
2193 commands cannot be used. Otherwise zero is returned.
2194
2195executable({expr}) *executable()*
2196 This function checks if an executable with the name {expr}
2197 exists. {expr} must be the name of the program without any
2198 arguments.
2199 executable() uses the value of $PATH and/or the normal
2200 searchpath for programs. *PATHEXT*
2201 On MS-Windows the ".exe", ".bat", etc. can optionally be
2202 included. Then the extensions in $PATHEXT are tried. Thus if
2203 "foo.exe" does not exist, "foo.exe.bat" can be found. If
2204 $PATHEXT is not set then ".com;.exe;.bat;.cmd" is used. A dot
2205 by itself can be used in $PATHEXT to try using the name
2206 without an extension. When 'shell' looks like a Unix shell,
2207 then the name is also tried without adding an extension.
2208 On MS-Windows it only checks if the file exists and is not a
2209 directory, not if it's really executable.
2210 On MS-Windows an executable in the same directory as Vim is
Yasuhiro Matsumoto05cf63e2022-05-03 11:02:28 +01002211 normally found. Since this directory is added to $PATH it
2212 should also work to execute it |win32-PATH|. This can be
2213 disabled by setting the $NoDefaultCurrentDirectoryInExePath
2214 environment variable. *NoDefaultCurrentDirectoryInExePath*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002215 The result is a Number:
2216 1 exists
2217 0 does not exist
2218 -1 not implemented on this system
2219 |exepath()| can be used to get the full path of an executable.
2220
2221 Can also be used as a |method|: >
2222 GetCommand()->executable()
2223
2224execute({command} [, {silent}]) *execute()*
2225 Execute an Ex command or commands and return the output as a
2226 string.
2227 {command} can be a string or a List. In case of a List the
2228 lines are executed one by one.
2229 This is equivalent to: >
2230 redir => var
2231 {command}
2232 redir END
2233<
2234 The optional {silent} argument can have these values:
2235 "" no `:silent` used
2236 "silent" `:silent` used
2237 "silent!" `:silent!` used
2238 The default is "silent". Note that with "silent!", unlike
2239 `:redir`, error messages are dropped. When using an external
2240 command the screen may be messed up, use `system()` instead.
2241 *E930*
2242 It is not possible to use `:redir` anywhere in {command}.
2243
2244 To get a list of lines use |split()| on the result: >
Bram Moolenaar75ab5902022-04-18 15:36:40 +01002245 execute('args')->split("\n")
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002246
2247< To execute a command in another window than the current one
2248 use `win_execute()`.
2249
2250 When used recursively the output of the recursive call is not
2251 included in the output of the higher level call.
2252
2253 Can also be used as a |method|: >
2254 GetCommand()->execute()
2255
2256exepath({expr}) *exepath()*
2257 If {expr} is an executable and is either an absolute path, a
2258 relative path or found in $PATH, return the full path.
2259 Note that the current directory is used when {expr} starts
2260 with "./", which may be a problem for Vim: >
2261 echo exepath(v:progpath)
2262< If {expr} cannot be found in $PATH or is not executable then
2263 an empty string is returned.
2264
2265 Can also be used as a |method|: >
2266 GetCommand()->exepath()
2267<
2268 *exists()*
2269exists({expr}) The result is a Number, which is |TRUE| if {expr} is defined,
2270 zero otherwise.
2271
2272 Note: In a compiled |:def| function the evaluation is done at
2273 runtime. Use `exists_compiled()` to evaluate the expression
2274 at compile time.
2275
2276 For checking for a supported feature use |has()|.
2277 For checking if a file exists use |filereadable()|.
2278
2279 The {expr} argument is a string, which contains one of these:
Bram Moolenaarf10911e2022-01-29 22:20:48 +00002280 varname internal variable (see
2281 dict.key |internal-variables|). Also works
2282 list[i] for |curly-braces-names|, |Dictionary|
2283 import.Func entries, |List| items, imported
Bram Moolenaar944697a2022-02-20 19:48:20 +00002284 items, etc.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00002285 Does not work for local variables in a
2286 compiled `:def` function.
Bram Moolenaar944697a2022-02-20 19:48:20 +00002287 Also works for a function in |Vim9|
2288 script, since it can be used as a
2289 function reference.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00002290 Beware that evaluating an index may
2291 cause an error message for an invalid
2292 expression. E.g.: >
2293 :let l = [1, 2, 3]
2294 :echo exists("l[5]")
2295< 0 >
2296 :echo exists("l[xx]")
2297< E121: Undefined variable: xx
2298 0
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002299 &option-name Vim option (only checks if it exists,
2300 not if it really works)
2301 +option-name Vim option that works.
2302 $ENVNAME environment variable (could also be
2303 done by comparing with an empty
2304 string)
2305 *funcname built-in function (see |functions|)
2306 or user defined function (see
2307 |user-functions|) that is implemented.
2308 Also works for a variable that is a
2309 Funcref.
2310 ?funcname built-in function that could be
2311 implemented; to be used to check if
2312 "funcname" is valid
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002313 :cmdname Ex command: built-in command, user
2314 command or command modifier |:command|.
2315 Returns:
2316 1 for match with start of a command
2317 2 full match with a command
2318 3 matches several user commands
2319 To check for a supported command
2320 always check the return value to be 2.
2321 :2match The |:2match| command.
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01002322 :3match The |:3match| command (but you
2323 probably should not use it, it is
2324 reserved for internal usage)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002325 #event autocommand defined for this event
2326 #event#pattern autocommand defined for this event and
2327 pattern (the pattern is taken
2328 literally and compared to the
2329 autocommand patterns character by
2330 character)
2331 #group autocommand group exists
2332 #group#event autocommand defined for this group and
2333 event.
2334 #group#event#pattern
2335 autocommand defined for this group,
2336 event and pattern.
2337 ##event autocommand for this event is
2338 supported.
2339
2340 Examples: >
2341 exists("&shortname")
2342 exists("$HOSTNAME")
2343 exists("*strftime")
Bram Moolenaar944697a2022-02-20 19:48:20 +00002344 exists("*s:MyFunc") " only for legacy script
2345 exists("*MyFunc")
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002346 exists("bufcount")
2347 exists(":Make")
2348 exists("#CursorHold")
2349 exists("#BufReadPre#*.gz")
2350 exists("#filetypeindent")
2351 exists("#filetypeindent#FileType")
2352 exists("#filetypeindent#FileType#*")
2353 exists("##ColorScheme")
2354< There must be no space between the symbol (&/$/*/#) and the
2355 name.
2356 There must be no extra characters after the name, although in
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01002357 a few cases this is ignored. That may become stricter in the
2358 future, thus don't count on it!
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002359 Working example: >
2360 exists(":make")
2361< NOT working example: >
2362 exists(":make install")
2363
2364< Note that the argument must be a string, not the name of the
2365 variable itself. For example: >
2366 exists(bufcount)
2367< This doesn't check for existence of the "bufcount" variable,
2368 but gets the value of "bufcount", and checks if that exists.
2369
2370 Can also be used as a |method|: >
2371 Varname()->exists()
2372<
2373
2374exists_compiled({expr}) *exists_compiled()*
2375 Like `exists()` but evaluated at compile time. This is useful
2376 to skip a block where a function is used that would otherwise
2377 give an error: >
2378 if exists_compiled('*ThatFunction')
2379 ThatFunction('works')
2380 endif
2381< If `exists()` were used then a compilation error would be
2382 given if ThatFunction() is not defined.
2383
2384 {expr} must be a literal string. *E1232*
2385 Can only be used in a |:def| function. *E1233*
2386 This does not work to check for arguments or local variables.
2387
2388
2389exp({expr}) *exp()*
2390 Return the exponential of {expr} as a |Float| in the range
2391 [0, inf].
2392 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar016188f2022-06-06 20:52:59 +01002393 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002394 Examples: >
2395 :echo exp(2)
2396< 7.389056 >
2397 :echo exp(-1)
2398< 0.367879
2399
2400 Can also be used as a |method|: >
2401 Compute()->exp()
2402<
2403 {only available when compiled with the |+float| feature}
2404
2405
2406expand({string} [, {nosuf} [, {list}]]) *expand()*
2407 Expand wildcards and the following special keywords in
2408 {string}. 'wildignorecase' applies.
2409
2410 If {list} is given and it is |TRUE|, a List will be returned.
2411 Otherwise the result is a String and when there are several
2412 matches, they are separated by <NL> characters. [Note: in
2413 version 5.0 a space was used, which caused problems when a
2414 file name contains a space]
2415
2416 If the expansion fails, the result is an empty string. A name
2417 for a non-existing file is not included, unless {string} does
2418 not start with '%', '#' or '<', see below.
2419
2420 When {string} starts with '%', '#' or '<', the expansion is
2421 done like for the |cmdline-special| variables with their
2422 associated modifiers. Here is a short overview:
2423
2424 % current file name
2425 # alternate file name
2426 #n alternate file name n
2427 <cfile> file name under the cursor
2428 <afile> autocmd file name
2429 <abuf> autocmd buffer number (as a String!)
2430 <amatch> autocmd matched name
2431 <cexpr> C expression under the cursor
2432 <sfile> sourced script file or function name
2433 <slnum> sourced script line number or function
2434 line number
2435 <sflnum> script file line number, also when in
2436 a function
2437 <SID> "<SNR>123_" where "123" is the
2438 current script ID |<SID>|
Bram Moolenaar75ab5902022-04-18 15:36:40 +01002439 <script> sourced script file, or script file
2440 where the current function was defined
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002441 <stack> call stack
2442 <cword> word under the cursor
2443 <cWORD> WORD under the cursor
2444 <client> the {clientid} of the last received
2445 message |server2client()|
2446 Modifiers:
2447 :p expand to full path
2448 :h head (last path component removed)
2449 :t tail (last path component only)
2450 :r root (one extension removed)
2451 :e extension only
2452
2453 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00002454 :let &tags = expand("%:p:h") .. "/tags"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002455< Note that when expanding a string that starts with '%', '#' or
2456 '<', any following text is ignored. This does NOT work: >
2457 :let doesntwork = expand("%:h.bak")
2458< Use this: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00002459 :let doeswork = expand("%:h") .. ".bak"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002460< Also note that expanding "<cfile>" and others only returns the
2461 referenced file name without further expansion. If "<cfile>"
2462 is "~/.cshrc", you need to do another expand() to have the
2463 "~/" expanded into the path of the home directory: >
2464 :echo expand(expand("<cfile>"))
2465<
2466 There cannot be white space between the variables and the
2467 following modifier. The |fnamemodify()| function can be used
2468 to modify normal file names.
2469
2470 When using '%' or '#', and the current or alternate file name
2471 is not defined, an empty string is used. Using "%:p" in a
2472 buffer with no name, results in the current directory, with a
2473 '/' added.
Bram Moolenaar57544522022-04-12 12:54:11 +01002474 When 'verbose' is set then expanding '%', '#' and <> items
2475 will result in an error message if the argument cannot be
2476 expanded.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002477
2478 When {string} does not start with '%', '#' or '<', it is
2479 expanded like a file name is expanded on the command line.
2480 'suffixes' and 'wildignore' are used, unless the optional
2481 {nosuf} argument is given and it is |TRUE|.
2482 Names for non-existing files are included. The "**" item can
2483 be used to search in a directory tree. For example, to find
2484 all "README" files in the current directory and below: >
2485 :echo expand("**/README")
2486<
2487 expand() can also be used to expand variables and environment
2488 variables that are only known in a shell. But this can be
2489 slow, because a shell may be used to do the expansion. See
2490 |expr-env-expand|.
2491 The expanded variable is still handled like a list of file
2492 names. When an environment variable cannot be expanded, it is
2493 left unchanged. Thus ":echo expand('$FOOBAR')" results in
2494 "$FOOBAR".
2495
2496 See |glob()| for finding existing files. See |system()| for
2497 getting the raw output of an external command.
2498
2499 Can also be used as a |method|: >
2500 Getpattern()->expand()
2501
Yegappan Lakshmanan2b74b682022-04-03 21:30:32 +01002502expandcmd({string} [, {options}]) *expandcmd()*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002503 Expand special items in String {string} like what is done for
2504 an Ex command such as `:edit`. This expands special keywords,
2505 like with |expand()|, and environment variables, anywhere in
2506 {string}. "~user" and "~/path" are only expanded at the
2507 start.
Yegappan Lakshmanan2b74b682022-04-03 21:30:32 +01002508
2509 The following items are supported in the {options} Dict
2510 argument:
2511 errmsg If set to TRUE, error messages are displayed
2512 if an error is encountered during expansion.
2513 By default, error messages are not displayed.
2514
Yegappan Lakshmanan5018a832022-04-02 21:12:21 +01002515 Returns the expanded string. If an error is encountered
2516 during expansion, the unmodified {string} is returned.
Yegappan Lakshmanan2b74b682022-04-03 21:30:32 +01002517
Yegappan Lakshmanan5018a832022-04-02 21:12:21 +01002518 Example: >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002519 :echo expandcmd('make %<.o')
Yegappan Lakshmanan2b74b682022-04-03 21:30:32 +01002520 make /path/runtime/doc/builtin.o
2521 :echo expandcmd('make %<.o', {'errmsg': v:true})
2522<
Yegappan Lakshmanan5018a832022-04-02 21:12:21 +01002523 Can also be used as a |method|: >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002524 GetCommand()->expandcmd()
2525<
2526extend({expr1}, {expr2} [, {expr3}]) *extend()*
2527 {expr1} and {expr2} must be both |Lists| or both
2528 |Dictionaries|.
2529
2530 If they are |Lists|: Append {expr2} to {expr1}.
2531 If {expr3} is given insert the items of {expr2} before the
2532 item with index {expr3} in {expr1}. When {expr3} is zero
2533 insert before the first item. When {expr3} is equal to
2534 len({expr1}) then {expr2} is appended.
2535 Examples: >
2536 :echo sort(extend(mylist, [7, 5]))
2537 :call extend(mylist, [2, 3], 1)
2538< When {expr1} is the same List as {expr2} then the number of
2539 items copied is equal to the original length of the List.
2540 E.g., when {expr3} is 1 you get N new copies of the first item
2541 (where N is the original length of the List).
2542 Use |add()| to concatenate one item to a list. To concatenate
2543 two lists into a new list use the + operator: >
2544 :let newlist = [1, 2, 3] + [4, 5]
2545<
2546 If they are |Dictionaries|:
2547 Add all entries from {expr2} to {expr1}.
2548 If a key exists in both {expr1} and {expr2} then {expr3} is
2549 used to decide what to do:
2550 {expr3} = "keep": keep the value of {expr1}
2551 {expr3} = "force": use the value of {expr2}
2552 {expr3} = "error": give an error message *E737*
2553 When {expr3} is omitted then "force" is assumed.
2554
2555 {expr1} is changed when {expr2} is not empty. If necessary
2556 make a copy of {expr1} first.
2557 {expr2} remains unchanged.
2558 When {expr1} is locked and {expr2} is not empty the operation
2559 fails.
Bram Moolenaar016188f2022-06-06 20:52:59 +01002560 Returns {expr1}. Returns 0 on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002561
2562 Can also be used as a |method|: >
2563 mylist->extend(otherlist)
2564
2565
2566extendnew({expr1}, {expr2} [, {expr3}]) *extendnew()*
2567 Like |extend()| but instead of adding items to {expr1} a new
2568 List or Dictionary is created and returned. {expr1} remains
2569 unchanged. Items can still be changed by {expr2}, if you
2570 don't want that use |deepcopy()| first.
2571
2572
2573feedkeys({string} [, {mode}]) *feedkeys()*
2574 Characters in {string} are queued for processing as if they
2575 come from a mapping or were typed by the user.
2576
2577 By default the string is added to the end of the typeahead
2578 buffer, thus if a mapping is still being executed the
2579 characters come after them. Use the 'i' flag to insert before
2580 other characters, they will be executed next, before any
2581 characters from a mapping.
2582
2583 The function does not wait for processing of keys contained in
2584 {string}.
2585
2586 To include special keys into {string}, use double-quotes
2587 and "\..." notation |expr-quote|. For example,
2588 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
2589 feedkeys('\<CR>') pushes 5 characters.
2590 A special code that might be useful is <Ignore>, it exits the
2591 wait for a character without doing anything. *<Ignore>*
2592
2593 {mode} is a String, which can contain these character flags:
2594 'm' Remap keys. This is default. If {mode} is absent,
2595 keys are remapped.
2596 'n' Do not remap keys.
2597 't' Handle keys as if typed; otherwise they are handled as
2598 if coming from a mapping. This matters for undo,
2599 opening folds, etc.
2600 'L' Lowlevel input. Only works for Unix or when using the
2601 GUI. Keys are used as if they were coming from the
2602 terminal. Other flags are not used. *E980*
2603 When a CTRL-C interrupts and 't' is included it sets
2604 the internal "got_int" flag.
2605 'i' Insert the string instead of appending (see above).
2606 'x' Execute commands until typeahead is empty. This is
2607 similar to using ":normal!". You can call feedkeys()
2608 several times without 'x' and then one time with 'x'
2609 (possibly with an empty {string}) to execute all the
2610 typeahead. Note that when Vim ends in Insert mode it
2611 will behave as if <Esc> is typed, to avoid getting
2612 stuck, waiting for a character to be typed before the
2613 script continues.
2614 Note that if you manage to call feedkeys() while
2615 executing commands, thus calling it recursively, then
2616 all typeahead will be consumed by the last call.
Bram Moolenaara9725222022-01-16 13:30:33 +00002617 'c' Remove any script context when executing, so that
2618 legacy script syntax applies, "s:var" does not work,
Bram Moolenaard899e512022-05-07 21:54:03 +01002619 etc. Note that if the string being fed sets a script
Bram Moolenaarce001a32022-04-27 15:25:03 +01002620 context this still applies.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002621 '!' When used with 'x' will not end Insert mode. Can be
2622 used in a test when a timer is set to exit Insert mode
2623 a little later. Useful for testing CursorHoldI.
2624
2625 Return value is always 0.
2626
2627 Can also be used as a |method|: >
2628 GetInput()->feedkeys()
2629
2630filereadable({file}) *filereadable()*
2631 The result is a Number, which is |TRUE| when a file with the
2632 name {file} exists, and can be read. If {file} doesn't exist,
2633 or is a directory, the result is |FALSE|. {file} is any
2634 expression, which is used as a String.
2635 If you don't care about the file being readable you can use
2636 |glob()|.
2637 {file} is used as-is, you may want to expand wildcards first: >
2638 echo filereadable('~/.vimrc')
2639 0
2640 echo filereadable(expand('~/.vimrc'))
2641 1
2642
2643< Can also be used as a |method|: >
2644 GetName()->filereadable()
2645< *file_readable()*
2646 Obsolete name: file_readable().
2647
2648
2649filewritable({file}) *filewritable()*
2650 The result is a Number, which is 1 when a file with the
2651 name {file} exists, and can be written. If {file} doesn't
2652 exist, or is not writable, the result is 0. If {file} is a
2653 directory, and we can write to it, the result is 2.
2654
2655 Can also be used as a |method|: >
2656 GetName()->filewritable()
2657
2658
2659filter({expr1}, {expr2}) *filter()*
2660 {expr1} must be a |List|, |String|, |Blob| or |Dictionary|.
2661 For each item in {expr1} evaluate {expr2} and when the result
2662 is zero or false remove the item from the |List| or
2663 |Dictionary|. Similarly for each byte in a |Blob| and each
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00002664 character in a |String|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002665
2666 {expr2} must be a |string| or |Funcref|.
2667
2668 If {expr2} is a |string|, inside {expr2} |v:val| has the value
2669 of the current item. For a |Dictionary| |v:key| has the key
2670 of the current item and for a |List| |v:key| has the index of
2671 the current item. For a |Blob| |v:key| has the index of the
2672 current byte. For a |String| |v:key| has the index of the
2673 current character.
2674 Examples: >
2675 call filter(mylist, 'v:val !~ "OLD"')
2676< Removes the items where "OLD" appears. >
2677 call filter(mydict, 'v:key >= 8')
2678< Removes the items with a key below 8. >
2679 call filter(var, 0)
2680< Removes all the items, thus clears the |List| or |Dictionary|.
2681
2682 Note that {expr2} is the result of expression and is then
2683 used as an expression again. Often it is good to use a
2684 |literal-string| to avoid having to double backslashes.
2685
2686 If {expr2} is a |Funcref| it must take two arguments:
2687 1. the key or the index of the current item.
2688 2. the value of the current item.
2689 The function must return |TRUE| if the item should be kept.
2690 Example that keeps the odd items of a list: >
2691 func Odd(idx, val)
2692 return a:idx % 2 == 1
2693 endfunc
2694 call filter(mylist, function('Odd'))
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00002695< It is shorter when using a |lambda|. In |Vim9| syntax: >
2696 call filter(myList, (idx, val) => idx * val <= 42)
2697< In legacy script syntax: >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002698 call filter(myList, {idx, val -> idx * val <= 42})
2699< If you do not use "val" you can leave it out: >
2700 call filter(myList, {idx -> idx % 2 == 1})
2701<
2702 In |Vim9| script the result must be true, false, zero or one.
2703 Other values will result in a type error.
2704
2705 For a |List| and a |Dictionary| the operation is done
2706 in-place. If you want it to remain unmodified make a copy
2707 first: >
2708 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
2709
2710< Returns {expr1}, the |List| or |Dictionary| that was filtered,
naohiro ono56200ee2022-01-01 14:59:44 +00002711 or a new |Blob| or |String|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002712 When an error is encountered while evaluating {expr2} no
2713 further items in {expr1} are processed.
2714 When {expr2} is a Funcref errors inside a function are ignored,
2715 unless it was defined with the "abort" flag.
2716
2717 Can also be used as a |method|: >
2718 mylist->filter(expr2)
2719
2720finddir({name} [, {path} [, {count}]]) *finddir()*
2721 Find directory {name} in {path}. Supports both downwards and
2722 upwards recursive directory searches. See |file-searching|
2723 for the syntax of {path}.
2724
2725 Returns the path of the first found match. When the found
2726 directory is below the current directory a relative path is
2727 returned. Otherwise a full path is returned.
2728 If {path} is omitted or empty then 'path' is used.
2729
2730 If the optional {count} is given, find {count}'s occurrence of
2731 {name} in {path} instead of the first one.
2732 When {count} is negative return all the matches in a |List|.
2733
Bram Moolenaar016188f2022-06-06 20:52:59 +01002734 Returns an empty string if the directory is not found.
2735
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002736 This is quite similar to the ex-command `:find`.
2737 {only available when compiled with the |+file_in_path|
2738 feature}
2739
2740 Can also be used as a |method|: >
2741 GetName()->finddir()
2742
2743findfile({name} [, {path} [, {count}]]) *findfile()*
2744 Just like |finddir()|, but find a file instead of a directory.
2745 Uses 'suffixesadd'.
2746 Example: >
2747 :echo findfile("tags.vim", ".;")
2748< Searches from the directory of the current file upwards until
2749 it finds the file "tags.vim".
2750
2751 Can also be used as a |method|: >
2752 GetName()->findfile()
2753
2754flatten({list} [, {maxdepth}]) *flatten()*
2755 Flatten {list} up to {maxdepth} levels. Without {maxdepth}
2756 the result is a |List| without nesting, as if {maxdepth} is
2757 a very large number.
2758 The {list} is changed in place, use |flattennew()| if you do
2759 not want that.
2760 In Vim9 script flatten() cannot be used, you must always use
Bram Moolenaara2baa732022-02-04 16:09:54 +00002761 |flattennew()|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002762 *E900*
2763 {maxdepth} means how deep in nested lists changes are made.
2764 {list} is not modified when {maxdepth} is 0.
2765 {maxdepth} must be positive number.
2766
2767 If there is an error the number zero is returned.
2768
2769 Example: >
2770 :echo flatten([1, [2, [3, 4]], 5])
2771< [1, 2, 3, 4, 5] >
2772 :echo flatten([1, [2, [3, 4]], 5], 1)
2773< [1, 2, [3, 4], 5]
2774
2775 Can also be used as a |method|: >
2776 mylist->flatten()
2777<
2778flattennew({list} [, {maxdepth}]) *flattennew()*
2779 Like |flatten()| but first make a copy of {list}.
2780
2781
2782float2nr({expr}) *float2nr()*
2783 Convert {expr} to a Number by omitting the part after the
2784 decimal point.
2785 {expr} must evaluate to a |Float| or a Number.
Bram Moolenaar016188f2022-06-06 20:52:59 +01002786 Returns 0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002787 When the value of {expr} is out of range for a |Number| the
2788 result is truncated to 0x7fffffff or -0x7fffffff (or when
2789 64-bit Number support is enabled, 0x7fffffffffffffff or
2790 -0x7fffffffffffffff). NaN results in -0x80000000 (or when
2791 64-bit Number support is enabled, -0x8000000000000000).
2792 Examples: >
2793 echo float2nr(3.95)
2794< 3 >
2795 echo float2nr(-23.45)
2796< -23 >
2797 echo float2nr(1.0e100)
2798< 2147483647 (or 9223372036854775807) >
2799 echo float2nr(-1.0e150)
2800< -2147483647 (or -9223372036854775807) >
2801 echo float2nr(1.0e-100)
2802< 0
2803
2804 Can also be used as a |method|: >
2805 Compute()->float2nr()
2806<
2807 {only available when compiled with the |+float| feature}
2808
2809
2810floor({expr}) *floor()*
2811 Return the largest integral value less than or equal to
2812 {expr} as a |Float| (round down).
2813 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar016188f2022-06-06 20:52:59 +01002814 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002815 Examples: >
2816 echo floor(1.856)
2817< 1.0 >
2818 echo floor(-5.456)
2819< -6.0 >
2820 echo floor(4.0)
2821< 4.0
2822
2823 Can also be used as a |method|: >
2824 Compute()->floor()
2825<
2826 {only available when compiled with the |+float| feature}
2827
2828
2829fmod({expr1}, {expr2}) *fmod()*
2830 Return the remainder of {expr1} / {expr2}, even if the
2831 division is not representable. Returns {expr1} - i * {expr2}
2832 for some integer i such that if {expr2} is non-zero, the
2833 result has the same sign as {expr1} and magnitude less than
2834 the magnitude of {expr2}. If {expr2} is zero, the value
2835 returned is zero. The value returned is a |Float|.
2836 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
Bram Moolenaar016188f2022-06-06 20:52:59 +01002837 Returns 0.0 if {expr1} or {expr2} is not a |Float| or a
2838 |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002839 Examples: >
2840 :echo fmod(12.33, 1.22)
2841< 0.13 >
2842 :echo fmod(-12.33, 1.22)
2843< -0.13
2844
2845 Can also be used as a |method|: >
2846 Compute()->fmod(1.22)
2847<
2848 {only available when compiled with |+float| feature}
2849
2850
2851fnameescape({string}) *fnameescape()*
2852 Escape {string} for use as file name command argument. All
2853 characters that have a special meaning, such as '%' and '|'
2854 are escaped with a backslash.
2855 For most systems the characters escaped are
2856 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash
2857 appears in a filename, it depends on the value of 'isfname'.
2858 A leading '+' and '>' is also escaped (special after |:edit|
2859 and |:write|). And a "-" by itself (special after |:cd|).
Bram Moolenaar016188f2022-06-06 20:52:59 +01002860 Returns an empty string on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002861 Example: >
2862 :let fname = '+some str%nge|name'
Bram Moolenaarc51cf032022-02-26 12:25:45 +00002863 :exe "edit " .. fnameescape(fname)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002864< results in executing: >
2865 edit \+some\ str\%nge\|name
2866<
2867 Can also be used as a |method|: >
2868 GetName()->fnameescape()
2869
2870fnamemodify({fname}, {mods}) *fnamemodify()*
2871 Modify file name {fname} according to {mods}. {mods} is a
2872 string of characters like it is used for file names on the
2873 command line. See |filename-modifiers|.
2874 Example: >
2875 :echo fnamemodify("main.c", ":p:h")
2876< results in: >
Bram Moolenaard799daa2022-06-20 11:17:32 +01002877 /home/user/vim/vim/src
Bram Moolenaar016188f2022-06-06 20:52:59 +01002878< If {mods} is empty or an unsupported modifier is used then
2879 {fname} is returned.
Bram Moolenaar5ed11532022-07-06 13:18:11 +01002880 When {fname} is empty then with {mods} ":h" returns ".", so
2881 that `:cd` can be used with it. This is different from
2882 expand('%:h') without a buffer name, which returns an empty
2883 string.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002884 Note: Environment variables don't work in {fname}, use
2885 |expand()| first then.
2886
2887 Can also be used as a |method|: >
2888 GetName()->fnamemodify(':p:h')
2889
2890foldclosed({lnum}) *foldclosed()*
2891 The result is a Number. If the line {lnum} is in a closed
2892 fold, the result is the number of the first line in that fold.
2893 If the line {lnum} is not in a closed fold, -1 is returned.
2894 {lnum} is used like with |getline()|. Thus "." is the current
2895 line, "'m" mark m, etc.
2896
2897 Can also be used as a |method|: >
2898 GetLnum()->foldclosed()
2899
2900foldclosedend({lnum}) *foldclosedend()*
2901 The result is a Number. If the line {lnum} is in a closed
2902 fold, the result is the number of the last line in that fold.
2903 If the line {lnum} is not in a closed fold, -1 is returned.
2904 {lnum} is used like with |getline()|. Thus "." is the current
2905 line, "'m" mark m, etc.
2906
2907 Can also be used as a |method|: >
2908 GetLnum()->foldclosedend()
2909
2910foldlevel({lnum}) *foldlevel()*
2911 The result is a Number, which is the foldlevel of line {lnum}
2912 in the current buffer. For nested folds the deepest level is
2913 returned. If there is no fold at line {lnum}, zero is
2914 returned. It doesn't matter if the folds are open or closed.
2915 When used while updating folds (from 'foldexpr') -1 is
2916 returned for lines where folds are still to be updated and the
2917 foldlevel is unknown. As a special case the level of the
2918 previous line is usually available.
2919 {lnum} is used like with |getline()|. Thus "." is the current
2920 line, "'m" mark m, etc.
2921
2922 Can also be used as a |method|: >
2923 GetLnum()->foldlevel()
2924<
2925 *foldtext()*
2926foldtext() Returns a String, to be displayed for a closed fold. This is
2927 the default function used for the 'foldtext' option and should
2928 only be called from evaluating 'foldtext'. It uses the
2929 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
2930 The returned string looks like this: >
2931 +-- 45 lines: abcdef
2932< The number of leading dashes depends on the foldlevel. The
2933 "45" is the number of lines in the fold. "abcdef" is the text
2934 in the first non-blank line of the fold. Leading white space,
2935 "//" or "/*" and the text from the 'foldmarker' and
2936 'commentstring' options is removed.
2937 When used to draw the actual foldtext, the rest of the line
2938 will be filled with the fold char from the 'fillchars'
2939 setting.
Bram Moolenaar016188f2022-06-06 20:52:59 +01002940 Returns an empty string when there is no fold.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002941 {not available when compiled without the |+folding| feature}
2942
2943foldtextresult({lnum}) *foldtextresult()*
2944 Returns the text that is displayed for the closed fold at line
2945 {lnum}. Evaluates 'foldtext' in the appropriate context.
2946 When there is no closed fold at {lnum} an empty string is
2947 returned.
2948 {lnum} is used like with |getline()|. Thus "." is the current
2949 line, "'m" mark m, etc.
2950 Useful when exporting folded text, e.g., to HTML.
2951 {not available when compiled without the |+folding| feature}
2952
2953
2954 Can also be used as a |method|: >
2955 GetLnum()->foldtextresult()
2956<
2957 *foreground()*
2958foreground() Move the Vim window to the foreground. Useful when sent from
2959 a client to a Vim server. |remote_send()|
2960 On Win32 systems this might not work, the OS does not always
2961 allow a window to bring itself to the foreground. Use
2962 |remote_foreground()| instead.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002963 {only in the Win32, Motif and GTK GUI versions and the
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002964 Win32 console version}
2965
2966fullcommand({name}) *fullcommand()*
2967 Get the full command name from a short abbreviated command
2968 name; see |20.2| for details on command abbreviations.
2969
2970 The string argument {name} may start with a `:` and can
2971 include a [range], these are skipped and not returned.
2972 Returns an empty string if a command doesn't exist or if it's
2973 ambiguous (for user-defined commands).
2974
2975 For example `fullcommand('s')`, `fullcommand('sub')`,
2976 `fullcommand(':%substitute')` all return "substitute".
2977
2978 Can also be used as a |method|: >
2979 GetName()->fullcommand()
2980<
2981 *funcref()*
2982funcref({name} [, {arglist}] [, {dict}])
2983 Just like |function()|, but the returned Funcref will lookup
2984 the function by reference, not by name. This matters when the
2985 function {name} is redefined later.
2986
2987 Unlike |function()|, {name} must be an existing user function.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00002988 It only works for an autoloaded function if it has already
2989 been loaded (to avoid mistakenly loading the autoload script
2990 when only intending to use the function name, use |function()|
2991 instead). {name} cannot be a builtin function.
Bram Moolenaar016188f2022-06-06 20:52:59 +01002992 Returns 0 on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002993
2994 Can also be used as a |method|: >
2995 GetFuncname()->funcref([arg])
2996<
2997 *function()* *partial* *E700* *E922* *E923*
2998function({name} [, {arglist}] [, {dict}])
2999 Return a |Funcref| variable that refers to function {name}.
3000 {name} can be the name of a user defined function or an
3001 internal function.
3002
3003 {name} can also be a Funcref or a partial. When it is a
3004 partial the dict stored in it will be used and the {dict}
3005 argument is not allowed. E.g.: >
3006 let FuncWithArg = function(dict.Func, [arg])
3007 let Broken = function(dict.Func, [arg], dict)
3008<
3009 When using the Funcref the function will be found by {name},
3010 also when it was redefined later. Use |funcref()| to keep the
3011 same function.
3012
3013 When {arglist} or {dict} is present this creates a partial.
3014 That means the argument list and/or the dictionary is stored in
3015 the Funcref and will be used when the Funcref is called.
3016
3017 The arguments are passed to the function in front of other
3018 arguments, but after any argument from |method|. Example: >
3019 func Callback(arg1, arg2, name)
3020 ...
3021 let Partial = function('Callback', ['one', 'two'])
3022 ...
3023 call Partial('name')
3024< Invokes the function as with: >
3025 call Callback('one', 'two', 'name')
3026
3027< With a |method|: >
3028 func Callback(one, two, three)
3029 ...
3030 let Partial = function('Callback', ['two'])
3031 ...
3032 eval 'one'->Partial('three')
3033< Invokes the function as with: >
3034 call Callback('one', 'two', 'three')
3035
3036< The function() call can be nested to add more arguments to the
3037 Funcref. The extra arguments are appended to the list of
3038 arguments. Example: >
3039 func Callback(arg1, arg2, name)
3040 ...
3041 let Func = function('Callback', ['one'])
3042 let Func2 = function(Func, ['two'])
3043 ...
3044 call Func2('name')
3045< Invokes the function as with: >
3046 call Callback('one', 'two', 'name')
3047
3048< The Dictionary is only useful when calling a "dict" function.
3049 In that case the {dict} is passed in as "self". Example: >
3050 function Callback() dict
Bram Moolenaarc51cf032022-02-26 12:25:45 +00003051 echo "called for " .. self.name
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003052 endfunction
3053 ...
3054 let context = {"name": "example"}
3055 let Func = function('Callback', context)
3056 ...
3057 call Func() " will echo: called for example
3058< The use of function() is not needed when there are no extra
3059 arguments, these two are equivalent: >
3060 let Func = function('Callback', context)
3061 let Func = context.Callback
3062
3063< The argument list and the Dictionary can be combined: >
3064 function Callback(arg1, count) dict
3065 ...
3066 let context = {"name": "example"}
3067 let Func = function('Callback', ['one'], context)
3068 ...
3069 call Func(500)
3070< Invokes the function as with: >
3071 call context.Callback('one', 500)
3072<
Bram Moolenaar016188f2022-06-06 20:52:59 +01003073 Returns 0 on error.
3074
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003075 Can also be used as a |method|: >
3076 GetFuncname()->function([arg])
3077
3078
3079garbagecollect([{atexit}]) *garbagecollect()*
3080 Cleanup unused |Lists|, |Dictionaries|, |Channels| and |Jobs|
3081 that have circular references.
3082
3083 There is hardly ever a need to invoke this function, as it is
3084 automatically done when Vim runs out of memory or is waiting
3085 for the user to press a key after 'updatetime'. Items without
3086 circular references are always freed when they become unused.
3087 This is useful if you have deleted a very big |List| and/or
3088 |Dictionary| with circular references in a script that runs
3089 for a long time.
3090
3091 When the optional {atexit} argument is one, garbage
3092 collection will also be done when exiting Vim, if it wasn't
3093 done before. This is useful when checking for memory leaks.
3094
3095 The garbage collection is not done immediately but only when
3096 it's safe to perform. This is when waiting for the user to
3097 type a character. To force garbage collection immediately use
3098 |test_garbagecollect_now()|.
3099
3100get({list}, {idx} [, {default}]) *get()*
3101 Get item {idx} from |List| {list}. When this item is not
3102 available return {default}. Return zero when {default} is
3103 omitted.
3104 Preferably used as a |method|: >
3105 mylist->get(idx)
3106get({blob}, {idx} [, {default}])
3107 Get byte {idx} from |Blob| {blob}. When this byte is not
3108 available return {default}. Return -1 when {default} is
3109 omitted.
3110 Preferably used as a |method|: >
3111 myblob->get(idx)
3112get({dict}, {key} [, {default}])
3113 Get item with key {key} from |Dictionary| {dict}. When this
3114 item is not available return {default}. Return zero when
3115 {default} is omitted. Useful example: >
3116 let val = get(g:, 'var_name', 'default')
3117< This gets the value of g:var_name if it exists, and uses
3118 'default' when it does not exist.
3119 Preferably used as a |method|: >
3120 mydict->get(key)
3121get({func}, {what})
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003122 Get item {what} from Funcref {func}. Possible values for
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003123 {what} are:
3124 "name" The function name
3125 "func" The function
3126 "dict" The dictionary
3127 "args" The list with arguments
Bram Moolenaar016188f2022-06-06 20:52:59 +01003128 Returns zero on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003129 Preferably used as a |method|: >
3130 myfunc->get(what)
3131<
3132 *getbufinfo()*
3133getbufinfo([{buf}])
3134getbufinfo([{dict}])
3135 Get information about buffers as a List of Dictionaries.
3136
3137 Without an argument information about all the buffers is
3138 returned.
3139
3140 When the argument is a |Dictionary| only the buffers matching
3141 the specified criteria are returned. The following keys can
3142 be specified in {dict}:
3143 buflisted include only listed buffers.
3144 bufloaded include only loaded buffers.
3145 bufmodified include only modified buffers.
3146
3147 Otherwise, {buf} specifies a particular buffer to return
3148 information for. For the use of {buf}, see |bufname()|
3149 above. If the buffer is found the returned List has one item.
3150 Otherwise the result is an empty list.
3151
3152 Each returned List item is a dictionary with the following
3153 entries:
3154 bufnr Buffer number.
3155 changed TRUE if the buffer is modified.
3156 changedtick Number of changes made to the buffer.
3157 hidden TRUE if the buffer is hidden.
3158 lastused Timestamp in seconds, like
3159 |localtime()|, when the buffer was
3160 last used.
3161 {only with the |+viminfo| feature}
3162 listed TRUE if the buffer is listed.
3163 lnum Line number used for the buffer when
3164 opened in the current window.
3165 Only valid if the buffer has been
3166 displayed in the window in the past.
3167 If you want the line number of the
3168 last known cursor position in a given
3169 window, use |line()|: >
3170 :echo line('.', {winid})
3171<
3172 linecount Number of lines in the buffer (only
3173 valid when loaded)
3174 loaded TRUE if the buffer is loaded.
3175 name Full path to the file in the buffer.
3176 signs List of signs placed in the buffer.
3177 Each list item is a dictionary with
3178 the following fields:
3179 id sign identifier
3180 lnum line number
3181 name sign name
3182 variables A reference to the dictionary with
3183 buffer-local variables.
3184 windows List of |window-ID|s that display this
3185 buffer
3186 popups List of popup |window-ID|s that
3187 display this buffer
3188
3189 Examples: >
3190 for buf in getbufinfo()
3191 echo buf.name
3192 endfor
3193 for buf in getbufinfo({'buflisted':1})
3194 if buf.changed
3195 ....
3196 endif
3197 endfor
3198<
3199 To get buffer-local options use: >
3200 getbufvar({bufnr}, '&option_name')
3201<
3202 Can also be used as a |method|: >
3203 GetBufnr()->getbufinfo()
3204<
3205
3206 *getbufline()*
3207getbufline({buf}, {lnum} [, {end}])
3208 Return a |List| with the lines starting from {lnum} to {end}
3209 (inclusive) in the buffer {buf}. If {end} is omitted, a
3210 |List| with only the line {lnum} is returned.
3211
3212 For the use of {buf}, see |bufname()| above.
3213
3214 For {lnum} and {end} "$" can be used for the last line of the
3215 buffer. Otherwise a number must be used.
3216
3217 When {lnum} is smaller than 1 or bigger than the number of
3218 lines in the buffer, an empty |List| is returned.
3219
3220 When {end} is greater than the number of lines in the buffer,
3221 it is treated as {end} is set to the number of lines in the
3222 buffer. When {end} is before {lnum} an empty |List| is
3223 returned.
3224
3225 This function works only for loaded buffers. For unloaded and
3226 non-existing buffers, an empty |List| is returned.
3227
3228 Example: >
3229 :let lines = getbufline(bufnr("myfile"), 1, "$")
3230
3231< Can also be used as a |method|: >
3232 GetBufnr()->getbufline(lnum)
3233
3234getbufvar({buf}, {varname} [, {def}]) *getbufvar()*
3235 The result is the value of option or local buffer variable
3236 {varname} in buffer {buf}. Note that the name without "b:"
3237 must be used.
3238 The {varname} argument is a string.
3239 When {varname} is empty returns a |Dictionary| with all the
3240 buffer-local variables.
3241 When {varname} is equal to "&" returns a |Dictionary| with all
3242 the buffer-local options.
3243 Otherwise, when {varname} starts with "&" returns the value of
3244 a buffer-local option.
3245 This also works for a global or buffer-local option, but it
3246 doesn't work for a global variable, window-local variable or
3247 window-local option.
3248 For the use of {buf}, see |bufname()| above.
3249 When the buffer or variable doesn't exist {def} or an empty
3250 string is returned, there is no error message.
3251 Examples: >
3252 :let bufmodified = getbufvar(1, "&mod")
Bram Moolenaarc51cf032022-02-26 12:25:45 +00003253 :echo "todo myvar = " .. getbufvar("todo", "myvar")
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003254
3255< Can also be used as a |method|: >
3256 GetBufnr()->getbufvar(varname)
3257<
3258getchangelist([{buf}]) *getchangelist()*
3259 Returns the |changelist| for the buffer {buf}. For the use
3260 of {buf}, see |bufname()| above. If buffer {buf} doesn't
3261 exist, an empty list is returned.
3262
3263 The returned list contains two entries: a list with the change
3264 locations and the current position in the list. Each
3265 entry in the change list is a dictionary with the following
3266 entries:
3267 col column number
3268 coladd column offset for 'virtualedit'
3269 lnum line number
3270 If buffer {buf} is the current buffer, then the current
3271 position refers to the position in the list. For other
3272 buffers, it is set to the length of the list.
3273
3274 Can also be used as a |method|: >
3275 GetBufnr()->getchangelist()
3276
3277getchar([expr]) *getchar()*
3278 Get a single character from the user or input stream.
3279 If [expr] is omitted, wait until a character is available.
3280 If [expr] is 0, only get a character when one is available.
3281 Return zero otherwise.
3282 If [expr] is 1, only check if a character is available, it is
3283 not consumed. Return zero if no character available.
3284 If you prefer always getting a string use |getcharstr()|.
3285
3286 Without [expr] and when [expr] is 0 a whole character or
3287 special key is returned. If it is a single character, the
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01003288 result is a Number. Use |nr2char()| to convert it to a String.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003289 Otherwise a String is returned with the encoded character.
3290 For a special key it's a String with a sequence of bytes
3291 starting with 0x80 (decimal: 128). This is the same value as
3292 the String "\<Key>", e.g., "\<Left>". The returned value is
3293 also a String when a modifier (shift, control, alt) was used
3294 that is not included in the character.
3295
3296 When [expr] is 0 and Esc is typed, there will be a short delay
3297 while Vim waits to see if this is the start of an escape
3298 sequence.
3299
3300 When [expr] is 1 only the first byte is returned. For a
3301 one-byte character it is the character itself as a number.
3302 Use nr2char() to convert it to a String.
3303
3304 Use getcharmod() to obtain any additional modifiers.
3305
3306 When the user clicks a mouse button, the mouse event will be
3307 returned. The position can then be found in |v:mouse_col|,
3308 |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|.
3309 |getmousepos()| can also be used. Mouse move events will be
3310 ignored.
3311 This example positions the mouse as it would normally happen: >
3312 let c = getchar()
3313 if c == "\<LeftMouse>" && v:mouse_win > 0
Bram Moolenaarc51cf032022-02-26 12:25:45 +00003314 exe v:mouse_win .. "wincmd w"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003315 exe v:mouse_lnum
Bram Moolenaarc51cf032022-02-26 12:25:45 +00003316 exe "normal " .. v:mouse_col .. "|"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003317 endif
3318<
3319 When using bracketed paste only the first character is
3320 returned, the rest of the pasted text is dropped.
3321 |xterm-bracketed-paste|.
3322
3323 There is no prompt, you will somehow have to make clear to the
3324 user that a character has to be typed. The screen is not
3325 redrawn, e.g. when resizing the window. When using a popup
3326 window it should work better with a |popup-filter|.
3327
3328 There is no mapping for the character.
3329 Key codes are replaced, thus when the user presses the <Del>
3330 key you get the code for the <Del> key, not the raw character
3331 sequence. Examples: >
3332 getchar() == "\<Del>"
3333 getchar() == "\<S-Left>"
3334< This example redefines "f" to ignore case: >
3335 :nmap f :call FindChar()<CR>
3336 :function FindChar()
3337 : let c = nr2char(getchar())
3338 : while col('.') < col('$') - 1
3339 : normal l
3340 : if getline('.')[col('.') - 1] ==? c
3341 : break
3342 : endif
3343 : endwhile
3344 :endfunction
3345<
3346 You may also receive synthetic characters, such as
3347 |<CursorHold>|. Often you will want to ignore this and get
3348 another character: >
3349 :function GetKey()
3350 : let c = getchar()
3351 : while c == "\<CursorHold>"
3352 : let c = getchar()
3353 : endwhile
3354 : return c
3355 :endfunction
3356
3357getcharmod() *getcharmod()*
3358 The result is a Number which is the state of the modifiers for
3359 the last obtained character with getchar() or in another way.
3360 These values are added together:
3361 2 shift
3362 4 control
3363 8 alt (meta)
3364 16 meta (when it's different from ALT)
3365 32 mouse double click
3366 64 mouse triple click
3367 96 mouse quadruple click (== 32 + 64)
3368 128 command (Macintosh only)
3369 Only the modifiers that have not been included in the
3370 character itself are obtained. Thus Shift-a results in "A"
Bram Moolenaar016188f2022-06-06 20:52:59 +01003371 without a modifier. Returns 0 if no modifiers are used.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003372
3373 *getcharpos()*
3374getcharpos({expr})
3375 Get the position for String {expr}. Same as |getpos()| but the
3376 column number in the returned List is a character index
3377 instead of a byte index.
naohiro ono56200ee2022-01-01 14:59:44 +00003378 If |getpos()| returns a very large column number, equal to
3379 |v:maxcol|, then getcharpos() will return the character index
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003380 of the last character.
3381
3382 Example:
3383 With the cursor on '세' in line 5 with text "여보세요": >
3384 getcharpos('.') returns [0, 5, 3, 0]
3385 getpos('.') returns [0, 5, 7, 0]
3386<
3387 Can also be used as a |method|: >
3388 GetMark()->getcharpos()
3389
3390getcharsearch() *getcharsearch()*
3391 Return the current character search information as a {dict}
3392 with the following entries:
3393
3394 char character previously used for a character
3395 search (|t|, |f|, |T|, or |F|); empty string
3396 if no character search has been performed
3397 forward direction of character search; 1 for forward,
3398 0 for backward
3399 until type of character search; 1 for a |t| or |T|
3400 character search, 0 for an |f| or |F|
3401 character search
3402
3403 This can be useful to always have |;| and |,| search
3404 forward/backward regardless of the direction of the previous
3405 character search: >
3406 :nnoremap <expr> ; getcharsearch().forward ? ';' : ','
3407 :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
3408< Also see |setcharsearch()|.
3409
3410
3411getcharstr([expr]) *getcharstr()*
3412 Get a single character from the user or input stream as a
3413 string.
3414 If [expr] is omitted, wait until a character is available.
3415 If [expr] is 0 or false, only get a character when one is
3416 available. Return an empty string otherwise.
3417 If [expr] is 1 or true, only check if a character is
3418 available, it is not consumed. Return an empty string
3419 if no character is available.
3420 Otherwise this works like |getchar()|, except that a number
3421 result is converted to a string.
3422
Shougo Matsushita79d599b2022-05-07 12:48:29 +01003423getcmdcompltype() *getcmdcompltype()*
3424 Return the type of the current command-line completion.
3425 Only works when the command line is being edited, thus
3426 requires use of |c_CTRL-\_e| or |c_CTRL-R_=|.
Bram Moolenaar921bde82022-05-09 19:50:35 +01003427 See |:command-completion| for the return string.
Shougo Matsushita79d599b2022-05-07 12:48:29 +01003428 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
3429 Returns an empty string when completion is not defined.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003430
3431getcmdline() *getcmdline()*
3432 Return the current command-line. Only works when the command
3433 line is being edited, thus requires use of |c_CTRL-\_e| or
3434 |c_CTRL-R_=|.
3435 Example: >
3436 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
3437< Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
3438 Returns an empty string when entering a password or using
3439 |inputsecret()|.
3440
3441getcmdpos() *getcmdpos()*
3442 Return the position of the cursor in the command line as a
3443 byte count. The first column is 1.
3444 Only works when editing the command line, thus requires use of
3445 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
3446 Returns 0 otherwise.
3447 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
3448
Shougo Matsushita79d599b2022-05-07 12:48:29 +01003449getcmdscreenpos() *getcmdscreenpos()*
3450 Return the screen position of the cursor in the command line
3451 as a byte count. The first column is 1.
3452 Instead of |getcmdpos()|, it adds the prompt position.
3453 Only works when editing the command line, thus requires use of
3454 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
3455 Returns 0 otherwise.
3456 Also see |getcmdpos()|, |setcmdpos()|.
3457
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003458getcmdtype() *getcmdtype()*
3459 Return the current command-line type. Possible return values
3460 are:
3461 : normal Ex command
3462 > debug mode command |debug-mode|
3463 / forward search command
3464 ? backward search command
3465 @ |input()| command
3466 - |:insert| or |:append| command
3467 = |i_CTRL-R_=|
3468 Only works when editing the command line, thus requires use of
3469 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
3470 Returns an empty string otherwise.
3471 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
3472
3473getcmdwintype() *getcmdwintype()*
3474 Return the current |command-line-window| type. Possible return
3475 values are the same as |getcmdtype()|. Returns an empty string
3476 when not in the command-line window.
3477
3478getcompletion({pat}, {type} [, {filtered}]) *getcompletion()*
3479 Return a list of command-line completion matches. The String
3480 {type} argument specifies what for. The following completion
3481 types are supported:
3482
3483 arglist file names in argument list
3484 augroup autocmd groups
3485 buffer buffer names
Bram Moolenaar6e2e2cc2022-03-14 19:24:46 +00003486 behave |:behave| suboptions
3487 breakpoint |:breakadd| and |:breakdel| suboptions
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003488 color color schemes
3489 command Ex command
3490 cmdline |cmdline-completion| result
3491 compiler compilers
3492 cscope |:cscope| suboptions
3493 diff_buffer |:diffget| and |:diffput| completion
3494 dir directory names
3495 environment environment variable names
3496 event autocommand events
3497 expression Vim expression
3498 file file and directory names
3499 file_in_path file and directory names in |'path'|
3500 filetype filetype names |'filetype'|
3501 function function name
3502 help help subjects
3503 highlight highlight groups
Bram Moolenaar6e2e2cc2022-03-14 19:24:46 +00003504 history |:history| suboptions
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003505 locale locale names (as output of locale -a)
3506 mapclear buffer argument
3507 mapping mapping name
3508 menu menus
3509 messages |:messages| suboptions
3510 option options
3511 packadd optional package |pack-add| names
Yegappan Lakshmanan454ce672022-03-24 11:22:13 +00003512 scriptnames sourced script names |:scriptnames|
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003513 shellcmd Shell command
3514 sign |:sign| suboptions
3515 syntax syntax file names |'syntax'|
3516 syntime |:syntime| suboptions
3517 tag tags
3518 tag_listfiles tags, file names
3519 user user names
3520 var user variables
3521
3522 If {pat} is an empty string, then all the matches are
3523 returned. Otherwise only items matching {pat} are returned.
3524 See |wildcards| for the use of special characters in {pat}.
3525
3526 If the optional {filtered} flag is set to 1, then 'wildignore'
3527 is applied to filter the results. Otherwise all the matches
3528 are returned. The 'wildignorecase' option always applies.
3529
Yegappan Lakshmanane7dd0fa2022-03-22 16:06:31 +00003530 If the 'wildoptions' option contains 'fuzzy', then fuzzy
3531 matching is used to get the completion matches. Otherwise
Yegappan Lakshmanan454ce672022-03-24 11:22:13 +00003532 regular expression matching is used. Thus this function
3533 follows the user preference, what happens on the command line.
3534 If you do not want this you can make 'wildoptions' empty
3535 before calling getcompletion() and restore it afterwards.
Yegappan Lakshmanane7dd0fa2022-03-22 16:06:31 +00003536
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003537 If {type} is "cmdline", then the |cmdline-completion| result is
3538 returned. For example, to complete the possible values after
3539 a ":call" command: >
3540 echo getcompletion('call ', 'cmdline')
3541<
3542 If there are no matches, an empty list is returned. An
3543 invalid value for {type} produces an error.
3544
3545 Can also be used as a |method|: >
3546 GetPattern()->getcompletion('color')
3547<
3548 *getcurpos()*
3549getcurpos([{winid}])
3550 Get the position of the cursor. This is like getpos('.'), but
3551 includes an extra "curswant" item in the list:
3552 [0, lnum, col, off, curswant] ~
3553 The "curswant" number is the preferred column when moving the
naohiro ono56200ee2022-01-01 14:59:44 +00003554 cursor vertically. After |$| command it will be a very large
3555 number equal to |v:maxcol|. Also see |getcursorcharpos()| and
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003556 |getpos()|.
3557 The first "bufnum" item is always zero. The byte position of
3558 the cursor is returned in 'col'. To get the character
3559 position, use |getcursorcharpos()|.
3560
3561 The optional {winid} argument can specify the window. It can
3562 be the window number or the |window-ID|. The last known
3563 cursor position is returned, this may be invalid for the
3564 current value of the buffer if it is not the current window.
3565 If {winid} is invalid a list with zeroes is returned.
3566
3567 This can be used to save and restore the cursor position: >
3568 let save_cursor = getcurpos()
3569 MoveTheCursorAround
3570 call setpos('.', save_cursor)
3571< Note that this only works within the window. See
3572 |winrestview()| for restoring more state.
3573
3574 Can also be used as a |method|: >
3575 GetWinid()->getcurpos()
3576<
3577 *getcursorcharpos()*
3578getcursorcharpos([{winid}])
3579 Same as |getcurpos()| but the column number in the returned
3580 List is a character index instead of a byte index.
3581
3582 Example:
3583 With the cursor on '보' in line 3 with text "여보세요": >
3584 getcursorcharpos() returns [0, 3, 2, 0, 3]
3585 getcurpos() returns [0, 3, 4, 0, 3]
3586<
3587 Can also be used as a |method|: >
3588 GetWinid()->getcursorcharpos()
3589
3590< *getcwd()*
3591getcwd([{winnr} [, {tabnr}]])
3592 The result is a String, which is the name of the current
3593 working directory. 'autochdir' is ignored.
3594
3595 With {winnr} return the local current directory of this window
3596 in the current tab page. {winnr} can be the window number or
3597 the |window-ID|.
3598 If {winnr} is -1 return the name of the global working
3599 directory. See also |haslocaldir()|.
3600
3601 With {winnr} and {tabnr} return the local current directory of
3602 the window in the specified tab page. If {winnr} is -1 return
3603 the working directory of the tabpage.
3604 If {winnr} is zero use the current window, if {tabnr} is zero
3605 use the current tabpage.
3606 Without any arguments, return the actual working directory of
3607 the current window.
3608 Return an empty string if the arguments are invalid.
3609
3610 Examples: >
3611 " Get the working directory of the current window
3612 :echo getcwd()
3613 :echo getcwd(0)
3614 :echo getcwd(0, 0)
3615 " Get the working directory of window 3 in tabpage 2
3616 :echo getcwd(3, 2)
3617 " Get the global working directory
3618 :echo getcwd(-1)
3619 " Get the working directory of tabpage 3
3620 :echo getcwd(-1, 3)
3621 " Get the working directory of current tabpage
3622 :echo getcwd(-1, 0)
3623
3624< Can also be used as a |method|: >
3625 GetWinnr()->getcwd()
3626
3627getenv({name}) *getenv()*
3628 Return the value of environment variable {name}. The {name}
3629 argument is a string, without a leading '$'. Example: >
3630 myHome = getenv('HOME')
3631
3632< When the variable does not exist |v:null| is returned. That
3633 is different from a variable set to an empty string, although
3634 some systems interpret the empty value as the variable being
3635 deleted. See also |expr-env|.
3636
3637 Can also be used as a |method|: >
3638 GetVarname()->getenv()
3639
3640getfontname([{name}]) *getfontname()*
3641 Without an argument returns the name of the normal font being
3642 used. Like what is used for the Normal highlight group
3643 |hl-Normal|.
3644 With an argument a check is done whether String {name} is a
3645 valid font name. If not then an empty string is returned.
3646 Otherwise the actual font name is returned, or {name} if the
3647 GUI does not support obtaining the real name.
3648 Only works when the GUI is running, thus not in your vimrc or
3649 gvimrc file. Use the |GUIEnter| autocommand to use this
3650 function just after the GUI has started.
3651 Note that the GTK GUI accepts any font name, thus checking for
3652 a valid name does not work.
3653
3654getfperm({fname}) *getfperm()*
3655 The result is a String, which is the read, write, and execute
3656 permissions of the given file {fname}.
3657 If {fname} does not exist or its directory cannot be read, an
3658 empty string is returned.
3659 The result is of the form "rwxrwxrwx", where each group of
3660 "rwx" flags represent, in turn, the permissions of the owner
3661 of the file, the group the file belongs to, and other users.
3662 If a user does not have a given permission the flag for this
3663 is replaced with the string "-". Examples: >
3664 :echo getfperm("/etc/passwd")
3665 :echo getfperm(expand("~/.vimrc"))
3666< This will hopefully (from a security point of view) display
3667 the string "rw-r--r--" or even "rw-------".
3668
3669 Can also be used as a |method|: >
3670 GetFilename()->getfperm()
3671<
3672 For setting permissions use |setfperm()|.
3673
3674getfsize({fname}) *getfsize()*
3675 The result is a Number, which is the size in bytes of the
3676 given file {fname}.
3677 If {fname} is a directory, 0 is returned.
3678 If the file {fname} can't be found, -1 is returned.
3679 If the size of {fname} is too big to fit in a Number then -2
3680 is returned.
3681
3682 Can also be used as a |method|: >
3683 GetFilename()->getfsize()
3684
3685getftime({fname}) *getftime()*
3686 The result is a Number, which is the last modification time of
3687 the given file {fname}. The value is measured as seconds
3688 since 1st Jan 1970, and may be passed to strftime(). See also
3689 |localtime()| and |strftime()|.
3690 If the file {fname} can't be found -1 is returned.
3691
3692 Can also be used as a |method|: >
3693 GetFilename()->getftime()
3694
3695getftype({fname}) *getftype()*
3696 The result is a String, which is a description of the kind of
3697 file of the given file {fname}.
3698 If {fname} does not exist an empty string is returned.
3699 Here is a table over different kinds of files and their
3700 results:
3701 Normal file "file"
3702 Directory "dir"
3703 Symbolic link "link"
3704 Block device "bdev"
3705 Character device "cdev"
3706 Socket "socket"
3707 FIFO "fifo"
3708 All other "other"
3709 Example: >
3710 getftype("/home")
3711< Note that a type such as "link" will only be returned on
3712 systems that support it. On some systems only "dir" and
3713 "file" are returned. On MS-Windows a symbolic link to a
3714 directory returns "dir" instead of "link".
3715
3716 Can also be used as a |method|: >
3717 GetFilename()->getftype()
3718
3719getimstatus() *getimstatus()*
3720 The result is a Number, which is |TRUE| when the IME status is
Bram Moolenaar016188f2022-06-06 20:52:59 +01003721 active and |FALSE| otherwise.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003722 See 'imstatusfunc'.
3723
3724getjumplist([{winnr} [, {tabnr}]]) *getjumplist()*
3725 Returns the |jumplist| for the specified window.
3726
3727 Without arguments use the current window.
3728 With {winnr} only use this window in the current tab page.
3729 {winnr} can also be a |window-ID|.
3730 With {winnr} and {tabnr} use the window in the specified tab
Bram Moolenaar016188f2022-06-06 20:52:59 +01003731 page. If {winnr} or {tabnr} is invalid, an empty list is
3732 returned.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003733
3734 The returned list contains two entries: a list with the jump
3735 locations and the last used jump position number in the list.
3736 Each entry in the jump location list is a dictionary with
3737 the following entries:
3738 bufnr buffer number
3739 col column number
3740 coladd column offset for 'virtualedit'
3741 filename filename if available
3742 lnum line number
3743
3744 Can also be used as a |method|: >
3745 GetWinnr()->getjumplist()
3746
3747< *getline()*
3748getline({lnum} [, {end}])
3749 Without {end} the result is a String, which is line {lnum}
3750 from the current buffer. Example: >
3751 getline(1)
3752< When {lnum} is a String that doesn't start with a
3753 digit, |line()| is called to translate the String into a Number.
3754 To get the line under the cursor: >
3755 getline(".")
3756< When {lnum} is a number smaller than 1 or bigger than the
3757 number of lines in the buffer, an empty string is returned.
3758
3759 When {end} is given the result is a |List| where each item is
3760 a line from the current buffer in the range {lnum} to {end},
3761 including line {end}.
3762 {end} is used in the same way as {lnum}.
3763 Non-existing lines are silently omitted.
3764 When {end} is before {lnum} an empty |List| is returned.
3765 Example: >
3766 :let start = line('.')
3767 :let end = search("^$") - 1
3768 :let lines = getline(start, end)
3769
3770< Can also be used as a |method|: >
3771 ComputeLnum()->getline()
3772
3773< To get lines from another buffer see |getbufline()|
3774
3775getloclist({nr} [, {what}]) *getloclist()*
3776 Returns a |List| with all the entries in the location list for
3777 window {nr}. {nr} can be the window number or the |window-ID|.
3778 When {nr} is zero the current window is used.
3779
3780 For a location list window, the displayed location list is
3781 returned. For an invalid window number {nr}, an empty list is
3782 returned. Otherwise, same as |getqflist()|.
3783
3784 If the optional {what} dictionary argument is supplied, then
3785 returns the items listed in {what} as a dictionary. Refer to
3786 |getqflist()| for the supported items in {what}.
3787
3788 In addition to the items supported by |getqflist()| in {what},
3789 the following item is supported by |getloclist()|:
3790
3791 filewinid id of the window used to display files
3792 from the location list. This field is
3793 applicable only when called from a
3794 location list window. See
3795 |location-list-file-window| for more
3796 details.
3797
3798 Returns a |Dictionary| with default values if there is no
3799 location list for the window {nr}.
3800 Returns an empty Dictionary if window {nr} does not exist.
3801
3802 Examples (See also |getqflist-examples|): >
3803 :echo getloclist(3, {'all': 0})
3804 :echo getloclist(5, {'filewinid': 0})
3805
3806
3807getmarklist([{buf}]) *getmarklist()*
3808 Without the {buf} argument returns a |List| with information
3809 about all the global marks. |mark|
3810
3811 If the optional {buf} argument is specified, returns the
3812 local marks defined in buffer {buf}. For the use of {buf},
Bram Moolenaar016188f2022-06-06 20:52:59 +01003813 see |bufname()|. If {buf} is invalid, an empty list is
3814 returned.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003815
3816 Each item in the returned List is a |Dict| with the following:
3817 mark name of the mark prefixed by "'"
3818 pos a |List| with the position of the mark:
3819 [bufnum, lnum, col, off]
3820 Refer to |getpos()| for more information.
3821 file file name
3822
3823 Refer to |getpos()| for getting information about a specific
3824 mark.
3825
3826 Can also be used as a |method|: >
3827 GetBufnr()->getmarklist()
3828
3829getmatches([{win}]) *getmatches()*
3830 Returns a |List| with all matches previously defined for the
3831 current window by |matchadd()| and the |:match| commands.
3832 |getmatches()| is useful in combination with |setmatches()|,
3833 as |setmatches()| can restore a list of matches saved by
3834 |getmatches()|.
3835 If {win} is specified, use the window with this number or
Bram Moolenaar016188f2022-06-06 20:52:59 +01003836 window ID instead of the current window. If {win} is invalid,
3837 an empty list is returned.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003838 Example: >
3839 :echo getmatches()
3840< [{'group': 'MyGroup1', 'pattern': 'TODO',
3841 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
3842 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
3843 :let m = getmatches()
3844 :call clearmatches()
3845 :echo getmatches()
3846< [] >
3847 :call setmatches(m)
3848 :echo getmatches()
3849< [{'group': 'MyGroup1', 'pattern': 'TODO',
3850 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
3851 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
3852 :unlet m
3853<
3854getmousepos() *getmousepos()*
3855 Returns a |Dictionary| with the last known position of the
3856 mouse. This can be used in a mapping for a mouse click or in
3857 a filter of a popup window. The items are:
3858 screenrow screen row
3859 screencol screen column
3860 winid Window ID of the click
3861 winrow row inside "winid"
3862 wincol column inside "winid"
3863 line text line inside "winid"
3864 column text column inside "winid"
3865 All numbers are 1-based.
3866
3867 If not over a window, e.g. when in the command line, then only
3868 "screenrow" and "screencol" are valid, the others are zero.
3869
3870 When on the status line below a window or the vertical
3871 separator right of a window, the "line" and "column" values
3872 are zero.
3873
3874 When the position is after the text then "column" is the
3875 length of the text in bytes plus one.
3876
3877 If the mouse is over a popup window then that window is used.
3878
3879 When using |getchar()| the Vim variables |v:mouse_lnum|,
3880 |v:mouse_col| and |v:mouse_winid| also provide these values.
3881
3882 *getpid()*
3883getpid() Return a Number which is the process ID of the Vim process.
3884 On Unix and MS-Windows this is a unique number, until Vim
3885 exits.
3886
3887 *getpos()*
3888getpos({expr}) Get the position for String {expr}. For possible values of
3889 {expr} see |line()|. For getting the cursor position see
3890 |getcurpos()|.
3891 The result is a |List| with four numbers:
3892 [bufnum, lnum, col, off]
3893 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
3894 is the buffer number of the mark.
3895 "lnum" and "col" are the position in the buffer. The first
3896 column is 1.
3897 The "off" number is zero, unless 'virtualedit' is used. Then
3898 it is the offset in screen columns from the start of the
3899 character. E.g., a position within a <Tab> or after the last
3900 character.
3901 Note that for '< and '> Visual mode matters: when it is "V"
3902 (visual line mode) the column of '< is zero and the column of
naohiro ono56200ee2022-01-01 14:59:44 +00003903 '> is a large number equal to |v:maxcol|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003904 The column number in the returned List is the byte position
3905 within the line. To get the character position in the line,
3906 use |getcharpos()|.
naohiro ono56200ee2022-01-01 14:59:44 +00003907 A very large column number equal to |v:maxcol| can be returned,
3908 in which case it means "after the end of the line".
Bram Moolenaar016188f2022-06-06 20:52:59 +01003909 If {expr} is invalid, returns a list with all zeros.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003910 This can be used to save and restore the position of a mark: >
3911 let save_a_mark = getpos("'a")
3912 ...
3913 call setpos("'a", save_a_mark)
3914< Also see |getcharpos()|, |getcurpos()| and |setpos()|.
3915
3916 Can also be used as a |method|: >
3917 GetMark()->getpos()
3918
3919getqflist([{what}]) *getqflist()*
3920 Returns a |List| with all the current quickfix errors. Each
3921 list item is a dictionary with these entries:
3922 bufnr number of buffer that has the file name, use
3923 bufname() to get the name
3924 module module name
3925 lnum line number in the buffer (first line is 1)
3926 end_lnum
3927 end of line number if the item is multiline
3928 col column number (first column is 1)
3929 end_col end of column number if the item has range
3930 vcol |TRUE|: "col" is visual column
3931 |FALSE|: "col" is byte index
3932 nr error number
3933 pattern search pattern used to locate the error
3934 text description of the error
3935 type type of the error, 'E', '1', etc.
3936 valid |TRUE|: recognized error message
3937
3938 When there is no error list or it's empty, an empty list is
3939 returned. Quickfix list entries with a non-existing buffer
3940 number are returned with "bufnr" set to zero (Note: some
3941 functions accept buffer number zero for the alternate buffer,
3942 you may need to explicitly check for zero).
3943
3944 Useful application: Find pattern matches in multiple files and
3945 do something with them: >
3946 :vimgrep /theword/jg *.c
3947 :for d in getqflist()
3948 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
3949 :endfor
3950<
3951 If the optional {what} dictionary argument is supplied, then
3952 returns only the items listed in {what} as a dictionary. The
3953 following string items are supported in {what}:
3954 changedtick get the total number of changes made
3955 to the list |quickfix-changedtick|
3956 context get the |quickfix-context|
3957 efm errorformat to use when parsing "lines". If
3958 not present, then the 'errorformat' option
3959 value is used.
3960 id get information for the quickfix list with
3961 |quickfix-ID|; zero means the id for the
3962 current list or the list specified by "nr"
3963 idx get information for the quickfix entry at this
3964 index in the list specified by 'id' or 'nr'.
3965 If set to zero, then uses the current entry.
3966 See |quickfix-index|
3967 items quickfix list entries
3968 lines parse a list of lines using 'efm' and return
3969 the resulting entries. Only a |List| type is
3970 accepted. The current quickfix list is not
3971 modified. See |quickfix-parse|.
3972 nr get information for this quickfix list; zero
3973 means the current quickfix list and "$" means
3974 the last quickfix list
3975 qfbufnr number of the buffer displayed in the quickfix
3976 window. Returns 0 if the quickfix buffer is
3977 not present. See |quickfix-buffer|.
3978 size number of entries in the quickfix list
3979 title get the list title |quickfix-title|
3980 winid get the quickfix |window-ID|
3981 all all of the above quickfix properties
3982 Non-string items in {what} are ignored. To get the value of a
3983 particular item, set it to zero.
3984 If "nr" is not present then the current quickfix list is used.
3985 If both "nr" and a non-zero "id" are specified, then the list
3986 specified by "id" is used.
3987 To get the number of lists in the quickfix stack, set "nr" to
3988 "$" in {what}. The "nr" value in the returned dictionary
3989 contains the quickfix stack size.
3990 When "lines" is specified, all the other items except "efm"
3991 are ignored. The returned dictionary contains the entry
3992 "items" with the list of entries.
3993
3994 The returned dictionary contains the following entries:
3995 changedtick total number of changes made to the
3996 list |quickfix-changedtick|
3997 context quickfix list context. See |quickfix-context|
3998 If not present, set to "".
3999 id quickfix list ID |quickfix-ID|. If not
4000 present, set to 0.
4001 idx index of the quickfix entry in the list. If not
4002 present, set to 0.
4003 items quickfix list entries. If not present, set to
4004 an empty list.
4005 nr quickfix list number. If not present, set to 0
4006 qfbufnr number of the buffer displayed in the quickfix
4007 window. If not present, set to 0.
4008 size number of entries in the quickfix list. If not
4009 present, set to 0.
4010 title quickfix list title text. If not present, set
4011 to "".
4012 winid quickfix |window-ID|. If not present, set to 0
4013
4014 Examples (See also |getqflist-examples|): >
4015 :echo getqflist({'all': 1})
4016 :echo getqflist({'nr': 2, 'title': 1})
4017 :echo getqflist({'lines' : ["F1:10:L10"]})
4018<
4019getreg([{regname} [, 1 [, {list}]]]) *getreg()*
4020 The result is a String, which is the contents of register
4021 {regname}. Example: >
4022 :let cliptext = getreg('*')
4023< When register {regname} was not set the result is an empty
4024 string.
Bram Moolenaara2baa732022-02-04 16:09:54 +00004025 The {regname} argument must be a string. *E1162*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004026
4027 getreg('=') returns the last evaluated value of the expression
4028 register. (For use in maps.)
4029 getreg('=', 1) returns the expression itself, so that it can
4030 be restored with |setreg()|. For other registers the extra
4031 argument is ignored, thus you can always give it.
4032
4033 If {list} is present and |TRUE|, the result type is changed
4034 to |List|. Each list item is one text line. Use it if you care
4035 about zero bytes possibly present inside register: without
4036 third argument both NLs and zero bytes are represented as NLs
4037 (see |NL-used-for-Nul|).
4038 When the register was not set an empty list is returned.
4039
4040 If {regname} is "", the unnamed register '"' is used.
4041 If {regname} is not specified, |v:register| is used.
4042 In |Vim9-script| {regname} must be one character.
4043
4044 Can also be used as a |method|: >
4045 GetRegname()->getreg()
4046
4047getreginfo([{regname}]) *getreginfo()*
4048 Returns detailed information about register {regname} as a
4049 Dictionary with the following entries:
4050 regcontents List of lines contained in register
4051 {regname}, like
4052 |getreg|({regname}, 1, 1).
4053 regtype the type of register {regname}, as in
4054 |getregtype()|.
4055 isunnamed Boolean flag, v:true if this register
4056 is currently pointed to by the unnamed
4057 register.
4058 points_to for the unnamed register, gives the
4059 single letter name of the register
4060 currently pointed to (see |quotequote|).
4061 For example, after deleting a line
4062 with `dd`, this field will be "1",
4063 which is the register that got the
4064 deleted text.
4065
4066 The {regname} argument is a string. If {regname} is invalid
4067 or not set, an empty Dictionary will be returned.
4068 If {regname} is "" or "@", the unnamed register '"' is used.
4069 If {regname} is not specified, |v:register| is used.
4070 The returned Dictionary can be passed to |setreg()|.
4071 In |Vim9-script| {regname} must be one character.
4072
4073 Can also be used as a |method|: >
4074 GetRegname()->getreginfo()
4075
4076getregtype([{regname}]) *getregtype()*
4077 The result is a String, which is type of register {regname}.
4078 The value will be one of:
4079 "v" for |characterwise| text
4080 "V" for |linewise| text
4081 "<CTRL-V>{width}" for |blockwise-visual| text
4082 "" for an empty or unknown register
4083 <CTRL-V> is one character with value 0x16.
4084 The {regname} argument is a string. If {regname} is "", the
4085 unnamed register '"' is used. If {regname} is not specified,
4086 |v:register| is used.
4087 In |Vim9-script| {regname} must be one character.
4088
4089 Can also be used as a |method|: >
4090 GetRegname()->getregtype()
4091
Bram Moolenaar753885b2022-08-24 16:30:36 +01004092getscriptinfo() *getscriptinfo()*
Yegappan Lakshmananf768c3d2022-08-22 13:15:13 +01004093 Returns a |List| with information about all the sourced Vim
Bram Moolenaar753885b2022-08-24 16:30:36 +01004094 scripts in the order they were sourced, like what
4095 `:scriptnames` shows.
Yegappan Lakshmananf768c3d2022-08-22 13:15:13 +01004096
4097 Each item in the returned List is a |Dict| with the following
4098 items:
4099 autoload set to TRUE for a script that was used with
Bram Moolenaar753885b2022-08-24 16:30:36 +01004100 `import autoload` but was not actually sourced
4101 yet (see |import-autoload|).
Yegappan Lakshmananf768c3d2022-08-22 13:15:13 +01004102 name vim script file name.
4103 sid script ID |<SID>|.
Bram Moolenaar753885b2022-08-24 16:30:36 +01004104 sourced if this script is an alias this is the script
4105 ID of the actually sourced script, otherwise zero
Yegappan Lakshmananf768c3d2022-08-22 13:15:13 +01004106
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004107gettabinfo([{tabnr}]) *gettabinfo()*
4108 If {tabnr} is not specified, then information about all the
4109 tab pages is returned as a |List|. Each List item is a
4110 |Dictionary|. Otherwise, {tabnr} specifies the tab page
4111 number and information about that one is returned. If the tab
4112 page does not exist an empty List is returned.
4113
4114 Each List item is a |Dictionary| with the following entries:
4115 tabnr tab page number.
4116 variables a reference to the dictionary with
4117 tabpage-local variables
4118 windows List of |window-ID|s in the tab page.
4119
4120 Can also be used as a |method|: >
4121 GetTabnr()->gettabinfo()
4122
4123gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()*
4124 Get the value of a tab-local variable {varname} in tab page
4125 {tabnr}. |t:var|
4126 Tabs are numbered starting with one.
4127 The {varname} argument is a string. When {varname} is empty a
4128 dictionary with all tab-local variables is returned.
4129 Note that the name without "t:" must be used.
4130 When the tab or variable doesn't exist {def} or an empty
4131 string is returned, there is no error message.
4132
4133 Can also be used as a |method|: >
4134 GetTabnr()->gettabvar(varname)
4135
4136gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()*
4137 Get the value of window-local variable {varname} in window
4138 {winnr} in tab page {tabnr}.
4139 The {varname} argument is a string. When {varname} is empty a
4140 dictionary with all window-local variables is returned.
4141 When {varname} is equal to "&" get the values of all
4142 window-local options in a |Dictionary|.
4143 Otherwise, when {varname} starts with "&" get the value of a
4144 window-local option.
4145 Note that {varname} must be the name without "w:".
4146 Tabs are numbered starting with one. For the current tabpage
4147 use |getwinvar()|.
4148 {winnr} can be the window number or the |window-ID|.
4149 When {winnr} is zero the current window is used.
4150 This also works for a global option, buffer-local option and
4151 window-local option, but it doesn't work for a global variable
4152 or buffer-local variable.
4153 When the tab, window or variable doesn't exist {def} or an
4154 empty string is returned, there is no error message.
4155 Examples: >
4156 :let list_is_on = gettabwinvar(1, 2, '&list')
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004157 :echo "myvar = " .. gettabwinvar(3, 1, 'myvar')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004158<
4159 To obtain all window-local variables use: >
4160 gettabwinvar({tabnr}, {winnr}, '&')
4161
4162< Can also be used as a |method|: >
4163 GetTabnr()->gettabwinvar(winnr, varname)
4164
4165gettagstack([{winnr}]) *gettagstack()*
4166 The result is a Dict, which is the tag stack of window {winnr}.
4167 {winnr} can be the window number or the |window-ID|.
4168 When {winnr} is not specified, the current window is used.
4169 When window {winnr} doesn't exist, an empty Dict is returned.
4170
4171 The returned dictionary contains the following entries:
4172 curidx Current index in the stack. When at
4173 top of the stack, set to (length + 1).
4174 Index of bottom of the stack is 1.
4175 items List of items in the stack. Each item
4176 is a dictionary containing the
4177 entries described below.
4178 length Number of entries in the stack.
4179
4180 Each item in the stack is a dictionary with the following
4181 entries:
4182 bufnr buffer number of the current jump
4183 from cursor position before the tag jump.
4184 See |getpos()| for the format of the
4185 returned list.
4186 matchnr current matching tag number. Used when
4187 multiple matching tags are found for a
4188 name.
4189 tagname name of the tag
4190
4191 See |tagstack| for more information about the tag stack.
4192
4193 Can also be used as a |method|: >
4194 GetWinnr()->gettagstack()
4195
4196
4197gettext({text}) *gettext()*
4198 Translate String {text} if possible.
4199 This is mainly for use in the distributed Vim scripts. When
4200 generating message translations the {text} is extracted by
4201 xgettext, the translator can add the translated message in the
4202 .po file and Vim will lookup the translation when gettext() is
4203 called.
4204 For {text} double quoted strings are preferred, because
4205 xgettext does not understand escaping in single quoted
4206 strings.
4207
4208
4209getwininfo([{winid}]) *getwininfo()*
4210 Returns information about windows as a |List| with Dictionaries.
4211
4212 If {winid} is given Information about the window with that ID
4213 is returned, as a |List| with one item. If the window does not
4214 exist the result is an empty list.
4215
4216 Without {winid} information about all the windows in all the
4217 tab pages is returned.
4218
4219 Each List item is a |Dictionary| with the following entries:
4220 botline last complete displayed buffer line
4221 bufnr number of buffer in the window
4222 height window height (excluding winbar)
4223 loclist 1 if showing a location list
4224 {only with the +quickfix feature}
4225 quickfix 1 if quickfix or location list window
4226 {only with the +quickfix feature}
4227 terminal 1 if a terminal window
4228 {only with the +terminal feature}
4229 tabnr tab page number
4230 topline first displayed buffer line
4231 variables a reference to the dictionary with
4232 window-local variables
4233 width window width
4234 winbar 1 if the window has a toolbar, 0
4235 otherwise
4236 wincol leftmost screen column of the window;
4237 "col" from |win_screenpos()|
4238 textoff number of columns occupied by any
4239 'foldcolumn', 'signcolumn' and line
4240 number in front of the text
4241 winid |window-ID|
4242 winnr window number
4243 winrow topmost screen line of the window;
4244 "row" from |win_screenpos()|
4245
4246 Can also be used as a |method|: >
4247 GetWinnr()->getwininfo()
4248
4249getwinpos([{timeout}]) *getwinpos()*
4250 The result is a |List| with two numbers, the result of
4251 |getwinposx()| and |getwinposy()| combined:
4252 [x-pos, y-pos]
4253 {timeout} can be used to specify how long to wait in msec for
4254 a response from the terminal. When omitted 100 msec is used.
4255 Use a longer time for a remote terminal.
4256 When using a value less than 10 and no response is received
4257 within that time, a previously reported position is returned,
4258 if available. This can be used to poll for the position and
4259 do some work in the meantime: >
4260 while 1
4261 let res = getwinpos(1)
4262 if res[0] >= 0
4263 break
4264 endif
4265 " Do some work here
4266 endwhile
4267<
4268
4269 Can also be used as a |method|: >
4270 GetTimeout()->getwinpos()
4271<
4272 *getwinposx()*
4273getwinposx() The result is a Number, which is the X coordinate in pixels of
4274 the left hand side of the GUI Vim window. Also works for an
4275 xterm (uses a timeout of 100 msec).
4276 The result will be -1 if the information is not available.
4277 The value can be used with `:winpos`.
4278
4279 *getwinposy()*
4280getwinposy() The result is a Number, which is the Y coordinate in pixels of
4281 the top of the GUI Vim window. Also works for an xterm (uses
4282 a timeout of 100 msec).
4283 The result will be -1 if the information is not available.
4284 The value can be used with `:winpos`.
4285
4286getwinvar({winnr}, {varname} [, {def}]) *getwinvar()*
4287 Like |gettabwinvar()| for the current tabpage.
4288 Examples: >
4289 :let list_is_on = getwinvar(2, '&list')
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004290 :echo "myvar = " .. getwinvar(1, 'myvar')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004291
4292< Can also be used as a |method|: >
4293 GetWinnr()->getwinvar(varname)
4294<
4295glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()*
4296 Expand the file wildcards in {expr}. See |wildcards| for the
4297 use of special characters.
4298
4299 Unless the optional {nosuf} argument is given and is |TRUE|,
4300 the 'suffixes' and 'wildignore' options apply: Names matching
4301 one of the patterns in 'wildignore' will be skipped and
4302 'suffixes' affect the ordering of matches.
4303 'wildignorecase' always applies.
4304
4305 When {list} is present and it is |TRUE| the result is a |List|
4306 with all matching files. The advantage of using a List is,
4307 you also get filenames containing newlines correctly.
4308 Otherwise the result is a String and when there are several
4309 matches, they are separated by <NL> characters.
4310
4311 If the expansion fails, the result is an empty String or List.
4312
4313 You can also use |readdir()| if you need to do complicated
4314 things, such as limiting the number of matches.
4315
4316 A name for a non-existing file is not included. A symbolic
4317 link is only included if it points to an existing file.
4318 However, when the {alllinks} argument is present and it is
4319 |TRUE| then all symbolic links are included.
4320
4321 For most systems backticks can be used to get files names from
4322 any external command. Example: >
4323 :let tagfiles = glob("`find . -name tags -print`")
4324 :let &tags = substitute(tagfiles, "\n", ",", "g")
4325< The result of the program inside the backticks should be one
4326 item per line. Spaces inside an item are allowed.
4327
4328 See |expand()| for expanding special Vim variables. See
4329 |system()| for getting the raw output of an external command.
4330
4331 Can also be used as a |method|: >
4332 GetExpr()->glob()
4333
4334glob2regpat({string}) *glob2regpat()*
4335 Convert a file pattern, as used by glob(), into a search
4336 pattern. The result can be used to match with a string that
4337 is a file name. E.g. >
4338 if filename =~ glob2regpat('Make*.mak')
4339< This is equivalent to: >
4340 if filename =~ '^Make.*\.mak$'
4341< When {string} is an empty string the result is "^$", match an
4342 empty string.
4343 Note that the result depends on the system. On MS-Windows
4344 a backslash usually means a path separator.
4345
4346 Can also be used as a |method|: >
4347 GetExpr()->glob2regpat()
4348< *globpath()*
4349globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
4350 Perform glob() for String {expr} on all directories in {path}
4351 and concatenate the results. Example: >
4352 :echo globpath(&rtp, "syntax/c.vim")
4353<
4354 {path} is a comma-separated list of directory names. Each
4355 directory name is prepended to {expr} and expanded like with
4356 |glob()|. A path separator is inserted when needed.
4357 To add a comma inside a directory name escape it with a
4358 backslash. Note that on MS-Windows a directory may have a
4359 trailing backslash, remove it if you put a comma after it.
4360 If the expansion fails for one of the directories, there is no
4361 error message.
4362
4363 Unless the optional {nosuf} argument is given and is |TRUE|,
4364 the 'suffixes' and 'wildignore' options apply: Names matching
4365 one of the patterns in 'wildignore' will be skipped and
4366 'suffixes' affect the ordering of matches.
4367
4368 When {list} is present and it is |TRUE| the result is a |List|
4369 with all matching files. The advantage of using a List is, you
4370 also get filenames containing newlines correctly. Otherwise
4371 the result is a String and when there are several matches,
4372 they are separated by <NL> characters. Example: >
4373 :echo globpath(&rtp, "syntax/c.vim", 0, 1)
4374<
4375 {alllinks} is used as with |glob()|.
4376
4377 The "**" item can be used to search in a directory tree.
4378 For example, to find all "README.txt" files in the directories
4379 in 'runtimepath' and below: >
4380 :echo globpath(&rtp, "**/README.txt")
4381< Upwards search and limiting the depth of "**" is not
4382 supported, thus using 'path' will not always work properly.
4383
4384 Can also be used as a |method|, the base is passed as the
4385 second argument: >
4386 GetExpr()->globpath(&rtp)
4387<
4388 *has()*
4389has({feature} [, {check}])
4390 When {check} is omitted or is zero: The result is a Number,
4391 which is 1 if the feature {feature} is supported, zero
4392 otherwise. The {feature} argument is a string, case is
4393 ignored. See |feature-list| below.
4394
4395 When {check} is present and not zero: The result is a Number,
4396 which is 1 if the feature {feature} could ever be supported,
4397 zero otherwise. This is useful to check for a typo in
4398 {feature} and to detect dead code. Keep in mind that an older
4399 Vim version will not know about a feature added later and
4400 features that have been abandoned will not be known by the
4401 current Vim version.
4402
4403 Also see |exists()| and |exists_compiled()|.
4404
4405 Note that to skip code that has a syntax error when the
4406 feature is not available, Vim may skip the rest of the line
4407 and miss a following `endif`. Therefore put the `endif` on a
4408 separate line: >
4409 if has('feature')
4410 let x = this->breaks->without->the->feature
4411 endif
4412< If the `endif` would be moved to the second line as "| endif" it
4413 would not be found.
4414
4415
4416has_key({dict}, {key}) *has_key()*
4417 The result is a Number, which is TRUE if |Dictionary| {dict}
Bram Moolenaare8008642022-08-19 17:15:35 +01004418 has an entry with key {key}. FALSE otherwise.
4419 The {key} argument is a string. In |Vim9| script a number is
4420 also accepted (and converted to a string) but no other types.
4421 In legacy script the usual automatic conversion to string is
4422 done.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004423
4424 Can also be used as a |method|: >
4425 mydict->has_key(key)
4426
4427haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()*
4428 The result is a Number:
4429 1 when the window has set a local directory via |:lcd|
4430 2 when the tab-page has set a local directory via |:tcd|
4431 0 otherwise.
4432
4433 Without arguments use the current window.
4434 With {winnr} use this window in the current tab page.
4435 With {winnr} and {tabnr} use the window in the specified tab
4436 page.
4437 {winnr} can be the window number or the |window-ID|.
4438 If {winnr} is -1 it is ignored and only the tabpage is used.
4439 Return 0 if the arguments are invalid.
4440 Examples: >
4441 if haslocaldir() == 1
4442 " window local directory case
4443 elseif haslocaldir() == 2
4444 " tab-local directory case
4445 else
4446 " global directory case
4447 endif
4448
4449 " current window
4450 :echo haslocaldir()
4451 :echo haslocaldir(0)
4452 :echo haslocaldir(0, 0)
4453 " window n in current tab page
4454 :echo haslocaldir(n)
4455 :echo haslocaldir(n, 0)
4456 " window n in tab page m
4457 :echo haslocaldir(n, m)
4458 " tab page m
4459 :echo haslocaldir(-1, m)
4460<
4461 Can also be used as a |method|: >
4462 GetWinnr()->haslocaldir()
4463
4464hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
4465 The result is a Number, which is TRUE if there is a mapping
4466 that contains {what} in somewhere in the rhs (what it is
4467 mapped to) and this mapping exists in one of the modes
4468 indicated by {mode}.
4469 The arguments {what} and {mode} are strings.
4470 When {abbr} is there and it is |TRUE| use abbreviations
4471 instead of mappings. Don't forget to specify Insert and/or
4472 Command-line mode.
4473 Both the global mappings and the mappings local to the current
4474 buffer are checked for a match.
4475 If no matching mapping is found FALSE is returned.
4476 The following characters are recognized in {mode}:
4477 n Normal mode
4478 v Visual and Select mode
4479 x Visual mode
4480 s Select mode
4481 o Operator-pending mode
4482 i Insert mode
4483 l Language-Argument ("r", "f", "t", etc.)
4484 c Command-line mode
4485 When {mode} is omitted, "nvo" is used.
4486
4487 This function is useful to check if a mapping already exists
4488 to a function in a Vim script. Example: >
4489 :if !hasmapto('\ABCdoit')
4490 : map <Leader>d \ABCdoit
4491 :endif
4492< This installs the mapping to "\ABCdoit" only if there isn't
4493 already a mapping to "\ABCdoit".
4494
4495 Can also be used as a |method|: >
4496 GetRHS()->hasmapto()
4497
4498histadd({history}, {item}) *histadd()*
4499 Add the String {item} to the history {history} which can be
4500 one of: *hist-names*
4501 "cmd" or ":" command line history
4502 "search" or "/" search pattern history
4503 "expr" or "=" typed expression history
4504 "input" or "@" input line history
4505 "debug" or ">" debug command history
4506 empty the current or last used history
4507 The {history} string does not need to be the whole name, one
4508 character is sufficient.
4509 If {item} does already exist in the history, it will be
4510 shifted to become the newest entry.
4511 The result is a Number: TRUE if the operation was successful,
4512 otherwise FALSE is returned.
4513
4514 Example: >
4515 :call histadd("input", strftime("%Y %b %d"))
4516 :let date=input("Enter date: ")
4517< This function is not available in the |sandbox|.
4518
4519 Can also be used as a |method|, the base is passed as the
4520 second argument: >
4521 GetHistory()->histadd('search')
4522
4523histdel({history} [, {item}]) *histdel()*
4524 Clear {history}, i.e. delete all its entries. See |hist-names|
4525 for the possible values of {history}.
4526
4527 If the parameter {item} evaluates to a String, it is used as a
4528 regular expression. All entries matching that expression will
4529 be removed from the history (if there are any).
4530 Upper/lowercase must match, unless "\c" is used |/\c|.
4531 If {item} evaluates to a Number, it will be interpreted as
4532 an index, see |:history-indexing|. The respective entry will
4533 be removed if it exists.
4534
4535 The result is TRUE for a successful operation, otherwise FALSE
4536 is returned.
4537
4538 Examples:
4539 Clear expression register history: >
4540 :call histdel("expr")
4541<
4542 Remove all entries starting with "*" from the search history: >
4543 :call histdel("/", '^\*')
4544<
4545 The following three are equivalent: >
4546 :call histdel("search", histnr("search"))
4547 :call histdel("search", -1)
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004548 :call histdel("search", '^' .. histget("search", -1) .. '$')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004549<
4550 To delete the last search pattern and use the last-but-one for
4551 the "n" command and 'hlsearch': >
4552 :call histdel("search", -1)
4553 :let @/ = histget("search", -1)
4554<
4555 Can also be used as a |method|: >
4556 GetHistory()->histdel()
4557
4558histget({history} [, {index}]) *histget()*
4559 The result is a String, the entry with Number {index} from
4560 {history}. See |hist-names| for the possible values of
4561 {history}, and |:history-indexing| for {index}. If there is
4562 no such entry, an empty String is returned. When {index} is
4563 omitted, the most recent item from the history is used.
4564
4565 Examples:
4566 Redo the second last search from history. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004567 :execute '/' .. histget("search", -2)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004568
4569< Define an Ex command ":H {num}" that supports re-execution of
4570 the {num}th entry from the output of |:history|. >
4571 :command -nargs=1 H execute histget("cmd", 0+<args>)
4572<
4573 Can also be used as a |method|: >
4574 GetHistory()->histget()
4575
4576histnr({history}) *histnr()*
4577 The result is the Number of the current entry in {history}.
4578 See |hist-names| for the possible values of {history}.
4579 If an error occurred, -1 is returned.
4580
4581 Example: >
4582 :let inp_index = histnr("expr")
4583
4584< Can also be used as a |method|: >
4585 GetHistory()->histnr()
4586<
4587hlexists({name}) *hlexists()*
4588 The result is a Number, which is TRUE if a highlight group
4589 called {name} exists. This is when the group has been
4590 defined in some way. Not necessarily when highlighting has
4591 been defined for it, it may also have been used for a syntax
4592 item.
4593 *highlight_exists()*
4594 Obsolete name: highlight_exists().
4595
4596 Can also be used as a |method|: >
4597 GetName()->hlexists()
4598<
4599hlget([{name} [, {resolve}]]) *hlget()*
4600 Returns a List of all the highlight group attributes. If the
4601 optional {name} is specified, then returns a List with only
4602 the attributes of the specified highlight group. Returns an
4603 empty List if the highlight group {name} is not present.
4604
4605 If the optional {resolve} argument is set to v:true and the
4606 highlight group {name} is linked to another group, then the
4607 link is resolved recursively and the attributes of the
4608 resolved highlight group are returned.
4609
4610 Each entry in the returned List is a Dictionary with the
4611 following items:
4612 cleared boolean flag, set to v:true if the highlight
4613 group attributes are cleared or not yet
4614 specified. See |highlight-clear|.
4615 cterm cterm attributes. See |highlight-cterm|.
4616 ctermbg cterm background color.
4617 See |highlight-ctermbg|.
4618 ctermfg cterm foreground color.
4619 See |highlight-ctermfg|.
4620 ctermul cterm underline color. See |highlight-ctermul|.
4621 default boolean flag, set to v:true if the highlight
4622 group link is a default link. See
4623 |highlight-default|.
4624 font highlight group font. See |highlight-font|.
4625 gui gui attributes. See |highlight-gui|.
4626 guibg gui background color. See |highlight-guibg|.
4627 guifg gui foreground color. See |highlight-guifg|.
4628 guisp gui special color. See |highlight-guisp|.
4629 id highlight group ID.
4630 linksto linked highlight group name.
4631 See |:highlight-link|.
4632 name highlight group name. See |group-name|.
4633 start start terminal keycode. See |highlight-start|.
4634 stop stop terminal keycode. See |highlight-stop|.
4635 term term attributes. See |highlight-term|.
4636
4637 The 'term', 'cterm' and 'gui' items in the above Dictionary
4638 have a dictionary value with the following optional boolean
4639 items: 'bold', 'standout', 'underline', 'undercurl', 'italic',
4640 'reverse', 'inverse' and 'strikethrough'.
4641
4642 Example(s): >
4643 :echo hlget()
4644 :echo hlget('ModeMsg')
4645 :echo hlget('Number', v:true)
4646<
4647 Can also be used as a |method|: >
4648 GetName()->hlget()
4649<
4650hlset({list}) *hlset()*
4651 Creates or modifies the attributes of a List of highlight
4652 groups. Each item in {list} is a dictionary containing the
4653 attributes of a highlight group. See |hlget()| for the list of
4654 supported items in this dictionary.
4655
4656 In addition to the items described in |hlget()|, the following
4657 additional items are supported in the dictionary:
4658
4659 force boolean flag to force the creation of
4660 a link for an existing highlight group
4661 with attributes.
4662
4663 The highlight group is identified using the 'name' item and
4664 the 'id' item (if supplied) is ignored. If a highlight group
4665 with a specified name doesn't exist, then it is created.
4666 Otherwise the attributes of an existing highlight group are
4667 modified.
4668
4669 If an empty dictionary value is used for the 'term' or 'cterm'
4670 or 'gui' entries, then the corresponding attributes are
4671 cleared. If the 'cleared' item is set to v:true, then all the
4672 attributes of the highlight group are cleared.
4673
4674 The 'linksto' item can be used to link a highlight group to
4675 another highlight group. See |:highlight-link|.
4676
4677 Returns zero for success, -1 for failure.
4678
4679 Example(s): >
4680 " add bold attribute to the Visual highlight group
4681 :call hlset([#{name: 'Visual',
4682 \ term: #{reverse: 1 , bold: 1}}])
4683 :call hlset([#{name: 'Type', guifg: 'DarkGreen'}])
4684 :let l = hlget()
4685 :call hlset(l)
4686 " clear the Search highlight group
4687 :call hlset([#{name: 'Search', cleared: v:true}])
4688 " clear the 'term' attributes for a highlight group
4689 :call hlset([#{name: 'Title', term: {}}])
4690 " create the MyHlg group linking it to DiffAdd
4691 :call hlset([#{name: 'MyHlg', linksto: 'DiffAdd'}])
4692 " remove the MyHlg group link
4693 :call hlset([#{name: 'MyHlg', linksto: 'NONE'}])
4694 " clear the attributes and a link
4695 :call hlset([#{name: 'MyHlg', cleared: v:true,
4696 \ linksto: 'NONE'}])
4697<
4698 Can also be used as a |method|: >
4699 GetAttrList()->hlset()
4700<
4701 *hlID()*
4702hlID({name}) The result is a Number, which is the ID of the highlight group
4703 with name {name}. When the highlight group doesn't exist,
4704 zero is returned.
4705 This can be used to retrieve information about the highlight
4706 group. For example, to get the background color of the
4707 "Comment" group: >
4708 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
4709< *highlightID()*
4710 Obsolete name: highlightID().
4711
4712 Can also be used as a |method|: >
4713 GetName()->hlID()
4714
4715hostname() *hostname()*
4716 The result is a String, which is the name of the machine on
4717 which Vim is currently running. Machine names greater than
4718 256 characters long are truncated.
4719
4720iconv({string}, {from}, {to}) *iconv()*
4721 The result is a String, which is the text {string} converted
4722 from encoding {from} to encoding {to}.
4723 When the conversion completely fails an empty string is
4724 returned. When some characters could not be converted they
4725 are replaced with "?".
4726 The encoding names are whatever the iconv() library function
4727 can accept, see ":!man 3 iconv".
4728 Most conversions require Vim to be compiled with the |+iconv|
4729 feature. Otherwise only UTF-8 to latin1 conversion and back
4730 can be done.
4731 This can be used to display messages with special characters,
4732 no matter what 'encoding' is set to. Write the message in
4733 UTF-8 and use: >
4734 echo iconv(utf8_str, "utf-8", &enc)
4735< Note that Vim uses UTF-8 for all Unicode encodings, conversion
4736 from/to UCS-2 is automatically changed to use UTF-8. You
4737 cannot use UCS-2 in a string anyway, because of the NUL bytes.
4738
4739 Can also be used as a |method|: >
4740 GetText()->iconv('latin1', 'utf-8')
4741<
4742 *indent()*
4743indent({lnum}) The result is a Number, which is indent of line {lnum} in the
4744 current buffer. The indent is counted in spaces, the value
4745 of 'tabstop' is relevant. {lnum} is used just like in
4746 |getline()|.
4747 When {lnum} is invalid -1 is returned. In |Vim9| script an
4748 error is given.
4749
4750 Can also be used as a |method|: >
4751 GetLnum()->indent()
4752
4753index({object}, {expr} [, {start} [, {ic}]]) *index()*
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004754 Find {expr} in {object} and return its index. See
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004755 |indexof()| for using a lambda to select the item.
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004756
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004757 If {object} is a |List| return the lowest index where the item
4758 has a value equal to {expr}. There is no automatic
4759 conversion, so the String "4" is different from the Number 4.
4760 And the number 4 is different from the Float 4.0. The value
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004761 of 'ignorecase' is not used here, case matters as indicated by
4762 the {ic} argument.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004763
4764 If {object} is |Blob| return the lowest index where the byte
4765 value is equal to {expr}.
4766
4767 If {start} is given then start looking at the item with index
4768 {start} (may be negative for an item relative to the end).
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004769
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004770 When {ic} is given and it is |TRUE|, ignore case. Otherwise
4771 case must match.
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004772
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004773 -1 is returned when {expr} is not found in {object}.
4774 Example: >
4775 :let idx = index(words, "the")
4776 :if index(numbers, 123) >= 0
4777
4778< Can also be used as a |method|: >
4779 GetObject()->index(what)
4780
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004781indexof({object}, {expr} [, {opts}]) *indexof()*
4782 Returns the index of an item in {object} where {expr} is
4783 v:true. {object} must be a |List| or a |Blob|.
4784
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004785 If {object} is a |List|, evaluate {expr} for each item in the
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004786 List until the expression is v:true and return the index of
4787 this item.
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004788
4789 If {object} is a |Blob| evaluate {expr} for each byte in the
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004790 Blob until the expression is v:true and return the index of
4791 this byte.
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004792
4793 {expr} must be a |string| or |Funcref|.
4794
4795 If {expr} is a |string|: If {object} is a |List|, inside
4796 {expr} |v:key| has the index of the current List item and
4797 |v:val| has the value of the item. If {object} is a |Blob|,
4798 inside {expr} |v:key| has the index of the current byte and
4799 |v:val| has the byte value.
4800
4801 If {expr} is a |Funcref| it must take two arguments:
4802 1. the key or the index of the current item.
4803 2. the value of the current item.
4804 The function must return |TRUE| if the item is found and the
4805 search should stop.
4806
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004807 The optional argument {opts} is a Dict and supports the
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004808 following items:
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004809 startidx start evaluating {expr} at the item with this
4810 index; may be negative for an item relative to
4811 the end
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004812 Returns -1 when {expr} evaluates to v:false for all the items.
4813 Example: >
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004814 :let l = [#{n: 10}, #{n: 20}, #{n: 30}]
4815 :echo indexof(l, "v:val.n == 20")
4816 :echo indexof(l, {i, v -> v.n == 30})
4817 :echo indexof(l, "v:val.n == 20", #{startidx: 1})
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004818
4819< Can also be used as a |method|: >
4820 mylist->indexof(expr)
4821
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004822input({prompt} [, {text} [, {completion}]]) *input()*
4823 The result is a String, which is whatever the user typed on
4824 the command-line. The {prompt} argument is either a prompt
4825 string, or a blank string (for no prompt). A '\n' can be used
4826 in the prompt to start a new line.
4827 The highlighting set with |:echohl| is used for the prompt.
4828 The input is entered just like a command-line, with the same
4829 editing commands and mappings. There is a separate history
4830 for lines typed for input().
4831 Example: >
4832 :if input("Coffee or beer? ") == "beer"
4833 : echo "Cheers!"
4834 :endif
4835<
4836 If the optional {text} argument is present and not empty, this
4837 is used for the default reply, as if the user typed this.
4838 Example: >
4839 :let color = input("Color? ", "white")
4840
4841< The optional {completion} argument specifies the type of
4842 completion supported for the input. Without it completion is
4843 not performed. The supported completion types are the same as
4844 that can be supplied to a user-defined command using the
4845 "-complete=" argument. Refer to |:command-completion| for
4846 more information. Example: >
4847 let fname = input("File: ", "", "file")
4848<
4849 NOTE: This function must not be used in a startup file, for
4850 the versions that only run in GUI mode (e.g., the Win32 GUI).
4851 Note: When input() is called from within a mapping it will
4852 consume remaining characters from that mapping, because a
4853 mapping is handled like the characters were typed.
4854 Use |inputsave()| before input() and |inputrestore()|
4855 after input() to avoid that. Another solution is to avoid
4856 that further characters follow in the mapping, e.g., by using
4857 |:execute| or |:normal|.
4858
4859 Example with a mapping: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004860 :nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR>
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004861 :function GetFoo()
4862 : call inputsave()
4863 : let g:Foo = input("enter search pattern: ")
4864 : call inputrestore()
4865 :endfunction
4866
4867< Can also be used as a |method|: >
4868 GetPrompt()->input()
4869
4870inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
4871 Like |input()|, but when the GUI is running and text dialogs
4872 are supported, a dialog window pops up to input the text.
4873 Example: >
4874 :let n = inputdialog("value for shiftwidth", shiftwidth())
4875 :if n != ""
4876 : let &sw = n
4877 :endif
4878< When the dialog is cancelled {cancelreturn} is returned. When
4879 omitted an empty string is returned.
4880 Hitting <Enter> works like pressing the OK button. Hitting
4881 <Esc> works like pressing the Cancel button.
4882 NOTE: Command-line completion is not supported.
4883
4884 Can also be used as a |method|: >
4885 GetPrompt()->inputdialog()
4886
4887inputlist({textlist}) *inputlist()*
4888 {textlist} must be a |List| of strings. This |List| is
4889 displayed, one string per line. The user will be prompted to
4890 enter a number, which is returned.
4891 The user can also select an item by clicking on it with the
4892 mouse, if the mouse is enabled in the command line ('mouse' is
4893 "a" or includes "c"). For the first string 0 is returned.
4894 When clicking above the first item a negative number is
4895 returned. When clicking on the prompt one more than the
4896 length of {textlist} is returned.
4897 Make sure {textlist} has less than 'lines' entries, otherwise
4898 it won't work. It's a good idea to put the entry number at
4899 the start of the string. And put a prompt in the first item.
4900 Example: >
4901 let color = inputlist(['Select color:', '1. red',
4902 \ '2. green', '3. blue'])
4903
4904< Can also be used as a |method|: >
4905 GetChoices()->inputlist()
4906
4907inputrestore() *inputrestore()*
4908 Restore typeahead that was saved with a previous |inputsave()|.
4909 Should be called the same number of times inputsave() is
4910 called. Calling it more often is harmless though.
4911 Returns TRUE when there is nothing to restore, FALSE otherwise.
4912
4913inputsave() *inputsave()*
4914 Preserve typeahead (also from mappings) and clear it, so that
4915 a following prompt gets input from the user. Should be
4916 followed by a matching inputrestore() after the prompt. Can
4917 be used several times, in which case there must be just as
4918 many inputrestore() calls.
4919 Returns TRUE when out of memory, FALSE otherwise.
4920
4921inputsecret({prompt} [, {text}]) *inputsecret()*
4922 This function acts much like the |input()| function with but
4923 two exceptions:
4924 a) the user's response will be displayed as a sequence of
4925 asterisks ("*") thereby keeping the entry secret, and
4926 b) the user's response will not be recorded on the input
4927 |history| stack.
4928 The result is a String, which is whatever the user actually
4929 typed on the command-line in response to the issued prompt.
4930 NOTE: Command-line completion is not supported.
4931
4932 Can also be used as a |method|: >
4933 GetPrompt()->inputsecret()
4934
4935insert({object}, {item} [, {idx}]) *insert()*
4936 When {object} is a |List| or a |Blob| insert {item} at the start
4937 of it.
4938
4939 If {idx} is specified insert {item} before the item with index
4940 {idx}. If {idx} is zero it goes before the first item, just
4941 like omitting {idx}. A negative {idx} is also possible, see
4942 |list-index|. -1 inserts just before the last item.
4943
4944 Returns the resulting |List| or |Blob|. Examples: >
4945 :let mylist = insert([2, 3, 5], 1)
4946 :call insert(mylist, 4, -1)
4947 :call insert(mylist, 6, len(mylist))
4948< The last example can be done simpler with |add()|.
4949 Note that when {item} is a |List| it is inserted as a single
4950 item. Use |extend()| to concatenate |Lists|.
4951
4952 Can also be used as a |method|: >
4953 mylist->insert(item)
4954
4955interrupt() *interrupt()*
4956 Interrupt script execution. It works more or less like the
4957 user typing CTRL-C, most commands won't execute and control
4958 returns to the user. This is useful to abort execution
4959 from lower down, e.g. in an autocommand. Example: >
4960 :function s:check_typoname(file)
4961 : if fnamemodify(a:file, ':t') == '['
4962 : echomsg 'Maybe typo'
4963 : call interrupt()
4964 : endif
4965 :endfunction
4966 :au BufWritePre * call s:check_typoname(expand('<amatch>'))
4967
4968invert({expr}) *invert()*
4969 Bitwise invert. The argument is converted to a number. A
4970 List, Dict or Float argument causes an error. Example: >
4971 :let bits = invert(bits)
4972< Can also be used as a |method|: >
4973 :let bits = bits->invert()
4974
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004975isabsolutepath({path}) *isabsolutepath()*
LemonBoydca1d402022-04-28 15:26:33 +01004976 The result is a Number, which is |TRUE| when {path} is an
4977 absolute path.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004978 On Unix, a path is considered absolute when it starts with '/'.
LemonBoydca1d402022-04-28 15:26:33 +01004979 On MS-Windows, it is considered absolute when it starts with an
4980 optional drive prefix and is followed by a '\' or '/'. UNC paths
4981 are always absolute.
4982 Example: >
4983 echo isabsolutepath('/usr/share/') " 1
4984 echo isabsolutepath('./foobar') " 0
4985 echo isabsolutepath('C:\Windows') " 1
4986 echo isabsolutepath('foobar') " 0
4987 echo isabsolutepath('\\remote\file') " 1
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004988<
LemonBoydca1d402022-04-28 15:26:33 +01004989 Can also be used as a |method|: >
4990 GetName()->isabsolutepath()
4991
4992
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004993isdirectory({directory}) *isdirectory()*
4994 The result is a Number, which is |TRUE| when a directory
4995 with the name {directory} exists. If {directory} doesn't
4996 exist, or isn't a directory, the result is |FALSE|. {directory}
4997 is any expression, which is used as a String.
4998
4999 Can also be used as a |method|: >
5000 GetName()->isdirectory()
5001
5002isinf({expr}) *isinf()*
5003 Return 1 if {expr} is a positive infinity, or -1 a negative
5004 infinity, otherwise 0. >
5005 :echo isinf(1.0 / 0.0)
5006< 1 >
5007 :echo isinf(-1.0 / 0.0)
5008< -1
5009
5010 Can also be used as a |method|: >
5011 Compute()->isinf()
5012<
5013 {only available when compiled with the |+float| feature}
5014
5015islocked({expr}) *islocked()* *E786*
5016 The result is a Number, which is |TRUE| when {expr} is the
5017 name of a locked variable.
5018 The string argument {expr} must be the name of a variable,
5019 |List| item or |Dictionary| entry, not the variable itself!
5020 Example: >
5021 :let alist = [0, ['a', 'b'], 2, 3]
5022 :lockvar 1 alist
5023 :echo islocked('alist') " 1
5024 :echo islocked('alist[1]') " 0
5025
Bram Moolenaar9da17d72022-02-09 21:50:44 +00005026< When {expr} is a variable that does not exist -1 is returned.
5027 If {expr} uses a range, list or dict index that is out of
5028 range or does not exist you get an error message. Use
5029 |exists()| to check for existence.
5030 In Vim9 script it does not work for local function variables.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005031
5032 Can also be used as a |method|: >
5033 GetName()->islocked()
5034
5035isnan({expr}) *isnan()*
5036 Return |TRUE| if {expr} is a float with value NaN. >
5037 echo isnan(0.0 / 0.0)
5038< 1
5039
5040 Can also be used as a |method|: >
5041 Compute()->isnan()
5042<
5043 {only available when compiled with the |+float| feature}
5044
5045items({dict}) *items()*
5046 Return a |List| with all the key-value pairs of {dict}. Each
5047 |List| item is a list with two items: the key of a {dict}
5048 entry and the value of this entry. The |List| is in arbitrary
5049 order. Also see |keys()| and |values()|.
5050 Example: >
5051 for [key, value] in items(mydict)
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005052 echo key .. ': ' .. value
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005053 endfor
5054
5055< Can also be used as a |method|: >
5056 mydict->items()
5057
5058job_ functions are documented here: |job-functions-details|
5059
5060
5061join({list} [, {sep}]) *join()*
5062 Join the items in {list} together into one String.
5063 When {sep} is specified it is put in between the items. If
5064 {sep} is omitted a single space is used.
5065 Note that {sep} is not added at the end. You might want to
5066 add it there too: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005067 let lines = join(mylist, "\n") .. "\n"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005068< String items are used as-is. |Lists| and |Dictionaries| are
5069 converted into a string like with |string()|.
5070 The opposite function is |split()|.
5071
5072 Can also be used as a |method|: >
5073 mylist->join()
5074
5075js_decode({string}) *js_decode()*
5076 This is similar to |json_decode()| with these differences:
5077 - Object key names do not have to be in quotes.
5078 - Strings can be in single quotes.
5079 - Empty items in an array (between two commas) are allowed and
5080 result in v:none items.
5081
5082 Can also be used as a |method|: >
5083 ReadObject()->js_decode()
5084
5085js_encode({expr}) *js_encode()*
5086 This is similar to |json_encode()| with these differences:
5087 - Object key names are not in quotes.
5088 - v:none items in an array result in an empty item between
5089 commas.
5090 For example, the Vim object:
5091 [1,v:none,{"one":1},v:none] ~
5092 Will be encoded as:
5093 [1,,{one:1},,] ~
5094 While json_encode() would produce:
5095 [1,null,{"one":1},null] ~
5096 This encoding is valid for JavaScript. It is more efficient
5097 than JSON, especially when using an array with optional items.
5098
5099 Can also be used as a |method|: >
5100 GetObject()->js_encode()
5101
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00005102json_decode({string}) *json_decode()* *E491*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005103 This parses a JSON formatted string and returns the equivalent
5104 in Vim values. See |json_encode()| for the relation between
5105 JSON and Vim values.
5106 The decoding is permissive:
5107 - A trailing comma in an array and object is ignored, e.g.
5108 "[1, 2, ]" is the same as "[1, 2]".
5109 - Integer keys are accepted in objects, e.g. {1:2} is the
5110 same as {"1":2}.
5111 - More floating point numbers are recognized, e.g. "1." for
5112 "1.0", or "001.2" for "1.2". Special floating point values
5113 "Infinity", "-Infinity" and "NaN" (capitalization ignored)
5114 are accepted.
5115 - Leading zeroes in integer numbers are ignored, e.g. "012"
5116 for "12" or "-012" for "-12".
5117 - Capitalization is ignored in literal names null, true or
5118 false, e.g. "NULL" for "null", "True" for "true".
5119 - Control characters U+0000 through U+001F which are not
5120 escaped in strings are accepted, e.g. " " (tab
5121 character in string) for "\t".
5122 - An empty JSON expression or made of only spaces is accepted
5123 and results in v:none.
5124 - Backslash in an invalid 2-character sequence escape is
5125 ignored, e.g. "\a" is decoded as "a".
5126 - A correct surrogate pair in JSON strings should normally be
5127 a 12 character sequence such as "\uD834\uDD1E", but
5128 json_decode() silently accepts truncated surrogate pairs
5129 such as "\uD834" or "\uD834\u"
5130 *E938*
5131 A duplicate key in an object, valid in rfc7159, is not
5132 accepted by json_decode() as the result must be a valid Vim
5133 type, e.g. this fails: {"a":"b", "a":"c"}
5134
5135 Can also be used as a |method|: >
5136 ReadObject()->json_decode()
5137
5138json_encode({expr}) *json_encode()*
5139 Encode {expr} as JSON and return this as a string.
5140 The encoding is specified in:
5141 https://tools.ietf.org/html/rfc7159.html
Bram Moolenaara2baa732022-02-04 16:09:54 +00005142 Vim values are converted as follows: *E1161*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005143 |Number| decimal number
5144 |Float| floating point number
5145 Float nan "NaN"
5146 Float inf "Infinity"
5147 Float -inf "-Infinity"
5148 |String| in double quotes (possibly null)
5149 |Funcref| not possible, error
5150 |List| as an array (possibly null); when
5151 used recursively: []
5152 |Dict| as an object (possibly null); when
5153 used recursively: {}
5154 |Blob| as an array of the individual bytes
5155 v:false "false"
5156 v:true "true"
5157 v:none "null"
5158 v:null "null"
5159 Note that NaN and Infinity are passed on as values. This is
5160 missing in the JSON standard, but several implementations do
5161 allow it. If not then you will get an error.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005162 If a string contains an illegal character then the replacement
5163 character 0xfffd is used.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005164
5165 Can also be used as a |method|: >
5166 GetObject()->json_encode()
5167
5168keys({dict}) *keys()*
5169 Return a |List| with all the keys of {dict}. The |List| is in
5170 arbitrary order. Also see |items()| and |values()|.
5171
5172 Can also be used as a |method|: >
5173 mydict->keys()
5174
5175< *len()* *E701*
5176len({expr}) The result is a Number, which is the length of the argument.
5177 When {expr} is a String or a Number the length in bytes is
5178 used, as with |strlen()|.
5179 When {expr} is a |List| the number of items in the |List| is
5180 returned.
5181 When {expr} is a |Blob| the number of bytes is returned.
5182 When {expr} is a |Dictionary| the number of entries in the
5183 |Dictionary| is returned.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005184 Otherwise an error is given and returns zero.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005185
5186 Can also be used as a |method|: >
5187 mylist->len()
5188
5189< *libcall()* *E364* *E368*
5190libcall({libname}, {funcname}, {argument})
5191 Call function {funcname} in the run-time library {libname}
5192 with single argument {argument}.
5193 This is useful to call functions in a library that you
5194 especially made to be used with Vim. Since only one argument
5195 is possible, calling standard library functions is rather
5196 limited.
5197 The result is the String returned by the function. If the
5198 function returns NULL, this will appear as an empty string ""
5199 to Vim.
5200 If the function returns a number, use libcallnr()!
5201 If {argument} is a number, it is passed to the function as an
5202 int; if {argument} is a string, it is passed as a
5203 null-terminated string.
5204 This function will fail in |restricted-mode|.
5205
5206 libcall() allows you to write your own 'plug-in' extensions to
5207 Vim without having to recompile the program. It is NOT a
5208 means to call system functions! If you try to do so Vim will
5209 very probably crash.
5210
5211 For Win32, the functions you write must be placed in a DLL
5212 and use the normal C calling convention (NOT Pascal which is
5213 used in Windows System DLLs). The function must take exactly
5214 one parameter, either a character pointer or a long integer,
5215 and must return a character pointer or NULL. The character
5216 pointer returned must point to memory that will remain valid
5217 after the function has returned (e.g. in static data in the
5218 DLL). If it points to allocated memory, that memory will
5219 leak away. Using a static buffer in the function should work,
5220 it's then freed when the DLL is unloaded.
5221
5222 WARNING: If the function returns a non-valid pointer, Vim may
5223 crash! This also happens if the function returns a number,
5224 because Vim thinks it's a pointer.
5225 For Win32 systems, {libname} should be the filename of the DLL
5226 without the ".DLL" suffix. A full path is only required if
5227 the DLL is not in the usual places.
5228 For Unix: When compiling your own plugins, remember that the
5229 object code must be compiled as position-independent ('PIC').
5230 {only in Win32 and some Unix versions, when the |+libcall|
5231 feature is present}
5232 Examples: >
5233 :echo libcall("libc.so", "getenv", "HOME")
5234
5235< Can also be used as a |method|, the base is passed as the
5236 third argument: >
5237 GetValue()->libcall("libc.so", "getenv")
5238<
5239 *libcallnr()*
5240libcallnr({libname}, {funcname}, {argument})
5241 Just like |libcall()|, but used for a function that returns an
5242 int instead of a string.
5243 {only in Win32 on some Unix versions, when the |+libcall|
5244 feature is present}
5245 Examples: >
5246 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
5247 :call libcallnr("libc.so", "printf", "Hello World!\n")
5248 :call libcallnr("libc.so", "sleep", 10)
5249<
5250 Can also be used as a |method|, the base is passed as the
5251 third argument: >
5252 GetValue()->libcallnr("libc.so", "printf")
5253<
5254
5255line({expr} [, {winid}]) *line()*
5256 The result is a Number, which is the line number of the file
5257 position given with {expr}. The {expr} argument is a string.
Bram Moolenaara2baa732022-02-04 16:09:54 +00005258 The accepted positions are: *E1209*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005259 . the cursor position
5260 $ the last line in the current buffer
5261 'x position of mark x (if the mark is not set, 0 is
5262 returned)
5263 w0 first line visible in current window (one if the
5264 display isn't updated, e.g. in silent Ex mode)
5265 w$ last line visible in current window (this is one
5266 less than "w0" if no lines are visible)
5267 v In Visual mode: the start of the Visual area (the
5268 cursor is the end). When not in Visual mode
5269 returns the cursor position. Differs from |'<| in
5270 that it's updated right away.
5271 Note that a mark in another file can be used. The line number
5272 then applies to another buffer.
5273 To get the column number use |col()|. To get both use
5274 |getpos()|.
5275 With the optional {winid} argument the values are obtained for
5276 that window instead of the current window.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005277 Returns 0 for invalid values of {expr} and {winid}.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005278 Examples: >
5279 line(".") line number of the cursor
5280 line(".", winid) idem, in window "winid"
5281 line("'t") line number of mark t
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005282 line("'" .. marker) line number of mark marker
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005283<
5284 To jump to the last known position when opening a file see
5285 |last-position-jump|.
5286
5287 Can also be used as a |method|: >
5288 GetValue()->line()
5289
5290line2byte({lnum}) *line2byte()*
5291 Return the byte count from the start of the buffer for line
5292 {lnum}. This includes the end-of-line character, depending on
5293 the 'fileformat' option for the current buffer. The first
5294 line returns 1. 'encoding' matters, 'fileencoding' is ignored.
5295 This can also be used to get the byte count for the line just
5296 below the last line: >
5297 line2byte(line("$") + 1)
5298< This is the buffer size plus one. If 'fileencoding' is empty
5299 it is the file size plus one. {lnum} is used like with
5300 |getline()|. When {lnum} is invalid, or the |+byte_offset|
5301 feature has been disabled at compile time, -1 is returned.
5302 Also see |byte2line()|, |go| and |:goto|.
5303
5304 Can also be used as a |method|: >
5305 GetLnum()->line2byte()
5306
5307lispindent({lnum}) *lispindent()*
5308 Get the amount of indent for line {lnum} according the lisp
5309 indenting rules, as with 'lisp'.
5310 The indent is counted in spaces, the value of 'tabstop' is
5311 relevant. {lnum} is used just like in |getline()|.
Bram Moolenaar8e145b82022-05-21 20:17:31 +01005312 When {lnum} is invalid -1 is returned. In |Vim9| script an
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005313 error is given.
5314
5315 Can also be used as a |method|: >
5316 GetLnum()->lispindent()
5317
5318list2blob({list}) *list2blob()*
5319 Return a Blob concatenating all the number values in {list}.
5320 Examples: >
5321 list2blob([1, 2, 3, 4]) returns 0z01020304
5322 list2blob([]) returns 0z
5323< Returns an empty Blob on error. If one of the numbers is
5324 negative or more than 255 error *E1239* is given.
5325
5326 |blob2list()| does the opposite.
5327
5328 Can also be used as a |method|: >
5329 GetList()->list2blob()
5330
5331list2str({list} [, {utf8}]) *list2str()*
5332 Convert each number in {list} to a character string can
5333 concatenate them all. Examples: >
5334 list2str([32]) returns " "
5335 list2str([65, 66, 67]) returns "ABC"
5336< The same can be done (slowly) with: >
5337 join(map(list, {nr, val -> nr2char(val)}), '')
5338< |str2list()| does the opposite.
5339
5340 When {utf8} is omitted or zero, the current 'encoding' is used.
5341 When {utf8} is TRUE, always return UTF-8 characters.
5342 With UTF-8 composing characters work as expected: >
5343 list2str([97, 769]) returns "á"
5344<
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005345 Returns an empty string on error.
5346
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005347 Can also be used as a |method|: >
5348 GetList()->list2str()
5349
5350listener_add({callback} [, {buf}]) *listener_add()*
5351 Add a callback function that will be invoked when changes have
5352 been made to buffer {buf}.
5353 {buf} refers to a buffer name or number. For the accepted
5354 values, see |bufname()|. When {buf} is omitted the current
5355 buffer is used.
5356 Returns a unique ID that can be passed to |listener_remove()|.
5357
5358 The {callback} is invoked with five arguments:
Bram Moolenaar944697a2022-02-20 19:48:20 +00005359 bufnr the buffer that was changed
5360 start first changed line number
5361 end first line number below the change
5362 added number of lines added, negative if lines were
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005363 deleted
Bram Moolenaar944697a2022-02-20 19:48:20 +00005364 changes a List of items with details about the changes
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005365
5366 Example: >
5367 func Listener(bufnr, start, end, added, changes)
5368 echo 'lines ' .. a:start .. ' until ' .. a:end .. ' changed'
5369 endfunc
5370 call listener_add('Listener', bufnr)
5371
Bram Moolenaar944697a2022-02-20 19:48:20 +00005372< The List cannot be changed. Each item in "changes" is a
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005373 dictionary with these entries:
5374 lnum the first line number of the change
5375 end the first line below the change
5376 added number of lines added; negative if lines were
5377 deleted
5378 col first column in "lnum" that was affected by
5379 the change; one if unknown or the whole line
5380 was affected; this is a byte index, first
5381 character has a value of one.
5382 When lines are inserted the values are:
5383 lnum line above which the new line is added
5384 end equal to "lnum"
5385 added number of lines inserted
5386 col 1
5387 When lines are deleted the values are:
5388 lnum the first deleted line
5389 end the line below the first deleted line, before
5390 the deletion was done
5391 added negative, number of lines deleted
5392 col 1
5393 When lines are changed:
5394 lnum the first changed line
5395 end the line below the last changed line
5396 added 0
5397 col first column with a change or 1
5398
5399 The entries are in the order the changes were made, thus the
5400 most recent change is at the end. The line numbers are valid
5401 when the callback is invoked, but later changes may make them
5402 invalid, thus keeping a copy for later might not work.
5403
5404 The {callback} is invoked just before the screen is updated,
5405 when |listener_flush()| is called or when a change is being
5406 made that changes the line count in a way it causes a line
5407 number in the list of changes to become invalid.
5408
5409 The {callback} is invoked with the text locked, see
5410 |textlock|. If you do need to make changes to the buffer, use
5411 a timer to do this later |timer_start()|.
5412
5413 The {callback} is not invoked when the buffer is first loaded.
5414 Use the |BufReadPost| autocmd event to handle the initial text
5415 of a buffer.
5416 The {callback} is also not invoked when the buffer is
5417 unloaded, use the |BufUnload| autocmd event for that.
5418
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005419 Returns zero if {callback} or {buf} is invalid.
5420
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005421 Can also be used as a |method|, the base is passed as the
5422 second argument: >
5423 GetBuffer()->listener_add(callback)
5424
5425listener_flush([{buf}]) *listener_flush()*
5426 Invoke listener callbacks for buffer {buf}. If there are no
5427 pending changes then no callbacks are invoked.
5428
5429 {buf} refers to a buffer name or number. For the accepted
5430 values, see |bufname()|. When {buf} is omitted the current
5431 buffer is used.
5432
5433 Can also be used as a |method|: >
5434 GetBuffer()->listener_flush()
5435
5436listener_remove({id}) *listener_remove()*
5437 Remove a listener previously added with listener_add().
5438 Returns FALSE when {id} could not be found, TRUE when {id} was
5439 removed.
5440
5441 Can also be used as a |method|: >
5442 GetListenerId()->listener_remove()
5443
5444localtime() *localtime()*
5445 Return the current time, measured as seconds since 1st Jan
5446 1970. See also |strftime()|, |strptime()| and |getftime()|.
5447
5448
5449log({expr}) *log()*
5450 Return the natural logarithm (base e) of {expr} as a |Float|.
5451 {expr} must evaluate to a |Float| or a |Number| in the range
5452 (0, inf].
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005453 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005454 Examples: >
5455 :echo log(10)
5456< 2.302585 >
5457 :echo log(exp(5))
5458< 5.0
5459
5460 Can also be used as a |method|: >
5461 Compute()->log()
5462<
5463 {only available when compiled with the |+float| feature}
5464
5465
5466log10({expr}) *log10()*
5467 Return the logarithm of Float {expr} to base 10 as a |Float|.
5468 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005469 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005470 Examples: >
5471 :echo log10(1000)
5472< 3.0 >
5473 :echo log10(0.01)
5474< -2.0
5475
5476 Can also be used as a |method|: >
5477 Compute()->log10()
5478<
5479 {only available when compiled with the |+float| feature}
5480
5481luaeval({expr} [, {expr}]) *luaeval()*
5482 Evaluate Lua expression {expr} and return its result converted
5483 to Vim data structures. Second {expr} may hold additional
5484 argument accessible as _A inside first {expr}.
5485 Strings are returned as they are.
5486 Boolean objects are converted to numbers.
5487 Numbers are converted to |Float| values if vim was compiled
5488 with |+float| and to numbers otherwise.
5489 Dictionaries and lists obtained by vim.eval() are returned
5490 as-is.
5491 Other objects are returned as zero without any errors.
5492 See |lua-luaeval| for more details.
5493 Note that in a `:def` function local variables are not visible
5494 to {expr}.
5495
5496 Can also be used as a |method|: >
5497 GetExpr()->luaeval()
5498
5499< {only available when compiled with the |+lua| feature}
5500
5501map({expr1}, {expr2}) *map()*
5502 {expr1} must be a |List|, |String|, |Blob| or |Dictionary|.
Bram Moolenaar944697a2022-02-20 19:48:20 +00005503 When {expr1} is a |List| or |Dictionary|, replace each
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005504 item in {expr1} with the result of evaluating {expr2}.
5505 For a |Blob| each byte is replaced.
5506 For a |String|, each character, including composing
5507 characters, is replaced.
5508 If the item type changes you may want to use |mapnew()| to
5509 create a new List or Dictionary. This is required when using
5510 Vim9 script.
5511
5512 {expr2} must be a |String| or |Funcref|.
5513
5514 If {expr2} is a |String|, inside {expr2} |v:val| has the value
5515 of the current item. For a |Dictionary| |v:key| has the key
5516 of the current item and for a |List| |v:key| has the index of
5517 the current item. For a |Blob| |v:key| has the index of the
5518 current byte. For a |String| |v:key| has the index of the
5519 current character.
5520 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005521 :call map(mylist, '"> " .. v:val .. " <"')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005522< This puts "> " before and " <" after each item in "mylist".
5523
5524 Note that {expr2} is the result of an expression and is then
5525 used as an expression again. Often it is good to use a
5526 |literal-string| to avoid having to double backslashes. You
5527 still have to double ' quotes
5528
5529 If {expr2} is a |Funcref| it is called with two arguments:
5530 1. The key or the index of the current item.
5531 2. the value of the current item.
5532 The function must return the new value of the item. Example
5533 that changes each value by "key-value": >
5534 func KeyValue(key, val)
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005535 return a:key .. '-' .. a:val
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005536 endfunc
5537 call map(myDict, function('KeyValue'))
5538< It is shorter when using a |lambda|: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005539 call map(myDict, {key, val -> key .. '-' .. val})
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005540< If you do not use "val" you can leave it out: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005541 call map(myDict, {key -> 'item: ' .. key})
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005542< If you do not use "key" you can use a short name: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005543 call map(myDict, {_, val -> 'item: ' .. val})
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005544<
5545 The operation is done in-place for a |List| and |Dictionary|.
5546 If you want it to remain unmodified make a copy first: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005547 :let tlist = map(copy(mylist), ' v:val .. "\t"')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005548
5549< Returns {expr1}, the |List| or |Dictionary| that was filtered,
5550 or a new |Blob| or |String|.
5551 When an error is encountered while evaluating {expr2} no
5552 further items in {expr1} are processed.
5553 When {expr2} is a Funcref errors inside a function are ignored,
5554 unless it was defined with the "abort" flag.
5555
5556 Can also be used as a |method|: >
5557 mylist->map(expr2)
5558
5559
5560maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()*
5561 When {dict} is omitted or zero: Return the rhs of mapping
5562 {name} in mode {mode}. The returned String has special
5563 characters translated like in the output of the ":map" command
Ernie Rael09661202022-04-25 14:40:44 +01005564 listing. When {dict} is TRUE a dictionary is returned, see
5565 below. To get a list of all mappings see |maplist()|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005566
5567 When there is no mapping for {name}, an empty String is
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005568 returned if {dict} is FALSE, otherwise returns an empty Dict.
5569 When the mapping for {name} is empty, then "<Nop>" is
5570 returned.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005571
5572 The {name} can have special key names, like in the ":map"
5573 command.
5574
5575 {mode} can be one of these strings:
5576 "n" Normal
5577 "v" Visual (including Select)
5578 "o" Operator-pending
5579 "i" Insert
5580 "c" Cmd-line
5581 "s" Select
5582 "x" Visual
5583 "l" langmap |language-mapping|
5584 "t" Terminal-Job
5585 "" Normal, Visual and Operator-pending
5586 When {mode} is omitted, the modes for "" are used.
5587
5588 When {abbr} is there and it is |TRUE| use abbreviations
5589 instead of mappings.
5590
5591 When {dict} is there and it is |TRUE| return a dictionary
5592 containing all the information of the mapping with the
Ernie Rael659c2402022-04-24 18:40:28 +01005593 following items: *mapping-dict*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005594 "lhs" The {lhs} of the mapping as it would be typed
5595 "lhsraw" The {lhs} of the mapping as raw bytes
5596 "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate
5597 form, only present when it differs from "lhsraw"
5598 "rhs" The {rhs} of the mapping as typed.
5599 "silent" 1 for a |:map-silent| mapping, else 0.
5600 "noremap" 1 if the {rhs} of the mapping is not remappable.
5601 "script" 1 if mapping was defined with <script>.
5602 "expr" 1 for an expression mapping (|:map-<expr>|).
5603 "buffer" 1 for a buffer local mapping (|:map-local|).
5604 "mode" Modes for which the mapping is defined. In
5605 addition to the modes mentioned above, these
5606 characters will be used:
5607 " " Normal, Visual and Operator-pending
5608 "!" Insert and Commandline mode
5609 (|mapmode-ic|)
5610 "sid" The script local ID, used for <sid> mappings
5611 (|<SID>|).
Bram Moolenaara9528b32022-01-18 20:51:35 +00005612 "scriptversion" The version of the script. 999999 for
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005613 |Vim9| script.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005614 "lnum" The line number in "sid", zero if unknown.
5615 "nowait" Do not wait for other, longer mappings.
5616 (|:map-<nowait>|).
Bram Moolenaar921bde82022-05-09 19:50:35 +01005617 "abbr" True if this is an abbreviation |abbreviations|.
Ernie Raeld8f5f762022-05-10 17:50:39 +01005618 "mode_bits" Vim's internal binary representation of "mode".
5619 |mapset()| ignores this; only "mode" is used.
5620 See |maplist()| for usage examples. The values
5621 are from src/vim.h and may change in the future.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005622
5623 The dictionary can be used to restore a mapping with
5624 |mapset()|.
5625
5626 The mappings local to the current buffer are checked first,
5627 then the global mappings.
5628 This function can be used to map a key even when it's already
5629 mapped, and have it do the original mapping too. Sketch: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005630 exe 'nnoremap <Tab> ==' .. maparg('<Tab>', 'n')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005631
5632< Can also be used as a |method|: >
5633 GetKey()->maparg('n')
5634
5635mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()*
5636 Check if there is a mapping that matches with {name} in mode
5637 {mode}. See |maparg()| for {mode} and special names in
5638 {name}.
5639 When {abbr} is there and it is |TRUE| use abbreviations
5640 instead of mappings.
5641 A match happens with a mapping that starts with {name} and
5642 with a mapping which is equal to the start of {name}.
5643
5644 matches mapping "a" "ab" "abc" ~
5645 mapcheck("a") yes yes yes
5646 mapcheck("abc") yes yes yes
5647 mapcheck("ax") yes no no
5648 mapcheck("b") no no no
5649
5650 The difference with maparg() is that mapcheck() finds a
5651 mapping that matches with {name}, while maparg() only finds a
5652 mapping for {name} exactly.
5653 When there is no mapping that starts with {name}, an empty
5654 String is returned. If there is one, the RHS of that mapping
5655 is returned. If there are several mappings that start with
5656 {name}, the RHS of one of them is returned. This will be
5657 "<Nop>" if the RHS is empty.
5658 The mappings local to the current buffer are checked first,
5659 then the global mappings.
5660 This function can be used to check if a mapping can be added
5661 without being ambiguous. Example: >
5662 :if mapcheck("_vv") == ""
5663 : map _vv :set guifont=7x13<CR>
5664 :endif
5665< This avoids adding the "_vv" mapping when there already is a
5666 mapping for "_v" or for "_vvv".
5667
5668 Can also be used as a |method|: >
5669 GetKey()->mapcheck('n')
5670
5671
Ernie Rael09661202022-04-25 14:40:44 +01005672maplist([{abbr}]) *maplist()*
5673 Returns a |List| of all mappings. Each List item is a |Dict|,
5674 the same as what is returned by |maparg()|, see
5675 |mapping-dict|. When {abbr} is there and it is |TRUE| use
5676 abbreviations instead of mappings.
5677
5678 Example to show all mappings with 'MultiMatch' in rhs: >
5679 vim9script
5680 echo maplist()->filter(
5681 (_, m) => match(m.rhs, 'MultiMatch') >= 0)
Ernie Raeld8f5f762022-05-10 17:50:39 +01005682< It can be tricky to find mappings for particular |:map-modes|.
5683 |mapping-dict|'s "mode_bits" can simplify this. For example,
5684 the mode_bits for Normal, Insert or Command-line modes are
5685 0x19. To find all the mappings available in those modes you
5686 can do: >
5687 vim9script
5688 var saved_maps = []
5689 for m in maplist()
5690 if and(m.mode_bits, 0x19) != 0
5691 saved_maps->add(m)
5692 endif
5693 endfor
5694 echo saved_maps->mapnew((_, m) => m.lhs)
5695< The values of the mode_bits are defined in Vim's src/vim.h
5696 file and they can be discovered at runtime using
5697 |:map-commands| and "maplist()". Example: >
5698 vim9script
5699 omap xyzzy <Nop>
5700 var op_bit = maplist()->filter(
5701 (_, m) => m.lhs == 'xyzzy')[0].mode_bits
5702 ounmap xyzzy
5703 echo printf("Operator-pending mode bit: 0x%x", op_bit)
Ernie Rael09661202022-04-25 14:40:44 +01005704
5705
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005706mapnew({expr1}, {expr2}) *mapnew()*
5707 Like |map()| but instead of replacing items in {expr1} a new
5708 List or Dictionary is created and returned. {expr1} remains
5709 unchanged. Items can still be changed by {expr2}, if you
5710 don't want that use |deepcopy()| first.
5711
5712
5713mapset({mode}, {abbr}, {dict}) *mapset()*
Ernie Rael51d04d12022-05-04 15:40:22 +01005714mapset({dict})
5715 Restore a mapping from a dictionary, possibly returned by
5716 |maparg()| or |maplist()|. A buffer mapping, when dict.buffer
5717 is true, is set on the current buffer; it is up to the caller
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005718 to ensure that the intended buffer is the current buffer. This
Ernie Rael51d04d12022-05-04 15:40:22 +01005719 feature allows copying mappings from one buffer to another.
5720 The dict.mode value may restore a single mapping that covers
5721 more than one mode, like with mode values of '!', ' ', 'nox',
5722 or 'v'. *E1276*
5723
5724 In the first form, {mode} and {abbr} should be the same as
5725 for the call to |maparg()|. *E460*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005726 {mode} is used to define the mode in which the mapping is set,
5727 not the "mode" entry in {dict}.
5728 Example for saving and restoring a mapping: >
5729 let save_map = maparg('K', 'n', 0, 1)
5730 nnoremap K somethingelse
5731 ...
5732 call mapset('n', 0, save_map)
5733< Note that if you are going to replace a map in several modes,
Ernie Rael51d04d12022-05-04 15:40:22 +01005734 e.g. with `:map!`, you need to save/restore the mapping for
5735 all of them, when they might differ.
5736
5737 In the second form, with {dict} as the only argument, mode
5738 and abbr are taken from the dict.
5739 Example: >
5740 vim9script
5741 var save_maps = maplist()->filter(
5742 (_, m) => m.lhs == 'K')
5743 nnoremap K somethingelse
5744 cnoremap K somethingelse2
5745 # ...
5746 unmap K
5747 for d in save_maps
5748 mapset(d)
5749 endfor
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005750
5751
5752match({expr}, {pat} [, {start} [, {count}]]) *match()*
5753 When {expr} is a |List| then this returns the index of the
5754 first item where {pat} matches. Each item is used as a
5755 String, |Lists| and |Dictionaries| are used as echoed.
5756
5757 Otherwise, {expr} is used as a String. The result is a
5758 Number, which gives the index (byte offset) in {expr} where
5759 {pat} matches.
5760
5761 A match at the first character or |List| item returns zero.
5762 If there is no match -1 is returned.
5763
5764 For getting submatches see |matchlist()|.
5765 Example: >
5766 :echo match("testing", "ing") " results in 4
5767 :echo match([1, 'x'], '\a') " results in 1
5768< See |string-match| for how {pat} is used.
5769 *strpbrk()*
5770 Vim doesn't have a strpbrk() function. But you can do: >
5771 :let sepidx = match(line, '[.,;: \t]')
5772< *strcasestr()*
5773 Vim doesn't have a strcasestr() function. But you can add
5774 "\c" to the pattern to ignore case: >
5775 :let idx = match(haystack, '\cneedle')
5776<
5777 If {start} is given, the search starts from byte index
5778 {start} in a String or item {start} in a |List|.
5779 The result, however, is still the index counted from the
5780 first character/item. Example: >
5781 :echo match("testing", "ing", 2)
5782< result is again "4". >
5783 :echo match("testing", "ing", 4)
5784< result is again "4". >
5785 :echo match("testing", "t", 2)
5786< result is "3".
5787 For a String, if {start} > 0 then it is like the string starts
5788 {start} bytes later, thus "^" will match at {start}. Except
5789 when {count} is given, then it's like matches before the
5790 {start} byte are ignored (this is a bit complicated to keep it
5791 backwards compatible).
5792 For a String, if {start} < 0, it will be set to 0. For a list
5793 the index is counted from the end.
5794 If {start} is out of range ({start} > strlen({expr}) for a
5795 String or {start} > len({expr}) for a |List|) -1 is returned.
5796
5797 When {count} is given use the {count}'th match. When a match
5798 is found in a String the search for the next one starts one
5799 character further. Thus this example results in 1: >
5800 echo match("testing", "..", 0, 2)
5801< In a |List| the search continues in the next item.
5802 Note that when {count} is added the way {start} works changes,
5803 see above.
5804
5805 See |pattern| for the patterns that are accepted.
5806 The 'ignorecase' option is used to set the ignore-caseness of
5807 the pattern. 'smartcase' is NOT used. The matching is always
5808 done like 'magic' is set and 'cpoptions' is empty.
5809 Note that a match at the start is preferred, thus when the
5810 pattern is using "*" (any number of matches) it tends to find
5811 zero matches at the start instead of a number of matches
5812 further down in the text.
5813
5814 Can also be used as a |method|: >
5815 GetText()->match('word')
5816 GetList()->match('word')
5817<
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00005818 *matchadd()* *E290* *E798* *E799* *E801* *E957*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005819matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
5820 Defines a pattern to be highlighted in the current window (a
5821 "match"). It will be highlighted with {group}. Returns an
5822 identification number (ID), which can be used to delete the
5823 match using |matchdelete()|. The ID is bound to the window.
5824 Matching is case sensitive and magic, unless case sensitivity
5825 or magicness are explicitly overridden in {pattern}. The
5826 'magic', 'smartcase' and 'ignorecase' options are not used.
5827 The "Conceal" value is special, it causes the match to be
5828 concealed.
5829
5830 The optional {priority} argument assigns a priority to the
5831 match. A match with a high priority will have its
5832 highlighting overrule that of a match with a lower priority.
5833 A priority is specified as an integer (negative numbers are no
5834 exception). If the {priority} argument is not specified, the
5835 default priority is 10. The priority of 'hlsearch' is zero,
5836 hence all matches with a priority greater than zero will
5837 overrule it. Syntax highlighting (see 'syntax') is a separate
5838 mechanism, and regardless of the chosen priority a match will
5839 always overrule syntax highlighting.
5840
5841 The optional {id} argument allows the request for a specific
5842 match ID. If a specified ID is already taken, an error
5843 message will appear and the match will not be added. An ID
5844 is specified as a positive integer (zero excluded). IDs 1, 2
5845 and 3 are reserved for |:match|, |:2match| and |:3match|,
Bram Moolenaar2ecbe532022-07-29 21:36:21 +01005846 respectively. 3 is reserved for use by the |matchparen|
5847 plugin.
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005848 If the {id} argument is not specified or -1, |matchadd()|
5849 automatically chooses a free ID.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005850
5851 The optional {dict} argument allows for further custom
5852 values. Currently this is used to specify a match specific
5853 conceal character that will be shown for |hl-Conceal|
5854 highlighted matches. The dict can have the following members:
5855
5856 conceal Special character to show instead of the
5857 match (only for |hl-Conceal| highlighted
5858 matches, see |:syn-cchar|)
5859 window Instead of the current window use the
5860 window with this number or window ID.
5861
5862 The number of matches is not limited, as it is the case with
5863 the |:match| commands.
5864
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005865 Returns -1 on error.
5866
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005867 Example: >
5868 :highlight MyGroup ctermbg=green guibg=green
5869 :let m = matchadd("MyGroup", "TODO")
5870< Deletion of the pattern: >
5871 :call matchdelete(m)
5872
5873< A list of matches defined by |matchadd()| and |:match| are
5874 available from |getmatches()|. All matches can be deleted in
5875 one operation by |clearmatches()|.
5876
5877 Can also be used as a |method|: >
5878 GetGroup()->matchadd('TODO')
5879<
5880 *matchaddpos()*
5881matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
5882 Same as |matchadd()|, but requires a list of positions {pos}
5883 instead of a pattern. This command is faster than |matchadd()|
5884 because it does not require to handle regular expressions and
5885 sets buffer line boundaries to redraw screen. It is supposed
5886 to be used when fast match additions and deletions are
5887 required, for example to highlight matching parentheses.
5888
5889 {pos} is a list of positions. Each position can be one of
5890 these:
5891 - A number. This whole line will be highlighted. The first
5892 line has number 1.
5893 - A list with one number, e.g., [23]. The whole line with this
5894 number will be highlighted.
5895 - A list with two numbers, e.g., [23, 11]. The first number is
5896 the line number, the second one is the column number (first
5897 column is 1, the value must correspond to the byte index as
5898 |col()| would return). The character at this position will
5899 be highlighted.
5900 - A list with three numbers, e.g., [23, 11, 3]. As above, but
5901 the third number gives the length of the highlight in bytes.
5902
5903 The maximum number of positions in {pos} is 8.
5904
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005905 Returns -1 on error.
5906
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005907 Example: >
5908 :highlight MyGroup ctermbg=green guibg=green
5909 :let m = matchaddpos("MyGroup", [[23, 24], 34])
5910< Deletion of the pattern: >
5911 :call matchdelete(m)
5912
5913< Matches added by |matchaddpos()| are returned by
5914 |getmatches()|.
5915
5916 Can also be used as a |method|: >
5917 GetGroup()->matchaddpos([23, 11])
5918
5919matcharg({nr}) *matcharg()*
5920 Selects the {nr} match item, as set with a |:match|,
5921 |:2match| or |:3match| command.
5922 Return a |List| with two elements:
5923 The name of the highlight group used
5924 The pattern used.
5925 When {nr} is not 1, 2 or 3 returns an empty |List|.
5926 When there is no match item set returns ['', ''].
5927 This is useful to save and restore a |:match|.
5928 Highlighting matches using the |:match| commands are limited
5929 to three matches. |matchadd()| does not have this limitation.
5930
5931 Can also be used as a |method|: >
5932 GetMatch()->matcharg()
5933
5934matchdelete({id} [, {win}) *matchdelete()* *E802* *E803*
5935 Deletes a match with ID {id} previously defined by |matchadd()|
5936 or one of the |:match| commands. Returns 0 if successful,
5937 otherwise -1. See example for |matchadd()|. All matches can
5938 be deleted in one operation by |clearmatches()|.
5939 If {win} is specified, use the window with this number or
5940 window ID instead of the current window.
5941
5942 Can also be used as a |method|: >
5943 GetMatch()->matchdelete()
5944
5945matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()*
5946 Same as |match()|, but return the index of first character
5947 after the match. Example: >
5948 :echo matchend("testing", "ing")
5949< results in "7".
5950 *strspn()* *strcspn()*
5951 Vim doesn't have a strspn() or strcspn() function, but you can
5952 do it with matchend(): >
5953 :let span = matchend(line, '[a-zA-Z]')
5954 :let span = matchend(line, '[^a-zA-Z]')
5955< Except that -1 is returned when there are no matches.
5956
5957 The {start}, if given, has the same meaning as for |match()|. >
5958 :echo matchend("testing", "ing", 2)
5959< results in "7". >
5960 :echo matchend("testing", "ing", 5)
5961< result is "-1".
5962 When {expr} is a |List| the result is equal to |match()|.
5963
5964 Can also be used as a |method|: >
5965 GetText()->matchend('word')
5966
5967
5968matchfuzzy({list}, {str} [, {dict}]) *matchfuzzy()*
5969 If {list} is a list of strings, then returns a |List| with all
5970 the strings in {list} that fuzzy match {str}. The strings in
5971 the returned list are sorted based on the matching score.
5972
5973 The optional {dict} argument always supports the following
5974 items:
zeertzjq9af2bc02022-05-11 14:15:37 +01005975 matchseq When this item is present return only matches
5976 that contain the characters in {str} in the
5977 given sequence.
Kazuyuki Miyagi47f1a552022-06-17 18:30:03 +01005978 limit Maximum number of matches in {list} to be
5979 returned. Zero means no limit.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005980
5981 If {list} is a list of dictionaries, then the optional {dict}
5982 argument supports the following additional items:
Yasuhiro Matsumoto9029a6e2022-04-16 12:35:35 +01005983 key Key of the item which is fuzzy matched against
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005984 {str}. The value of this item should be a
5985 string.
5986 text_cb |Funcref| that will be called for every item
5987 in {list} to get the text for fuzzy matching.
5988 This should accept a dictionary item as the
5989 argument and return the text for that item to
5990 use for fuzzy matching.
5991
5992 {str} is treated as a literal string and regular expression
5993 matching is NOT supported. The maximum supported {str} length
5994 is 256.
5995
5996 When {str} has multiple words each separated by white space,
5997 then the list of strings that have all the words is returned.
5998
5999 If there are no matching strings or there is an error, then an
6000 empty list is returned. If length of {str} is greater than
6001 256, then returns an empty list.
6002
Yasuhiro Matsumoto9029a6e2022-04-16 12:35:35 +01006003 When {limit} is given, matchfuzzy() will find up to this
6004 number of matches in {list} and return them in sorted order.
6005
Bram Moolenaar1588bc82022-03-08 21:35:07 +00006006 Refer to |fuzzy-matching| for more information about fuzzy
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006007 matching strings.
6008
6009 Example: >
6010 :echo matchfuzzy(["clay", "crow"], "cay")
6011< results in ["clay"]. >
6012 :echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl")
6013< results in a list of buffer names fuzzy matching "ndl". >
6014 :echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'})
6015< results in a list of buffer information dicts with buffer
6016 names fuzzy matching "ndl". >
6017 :echo getbufinfo()->matchfuzzy("spl",
6018 \ {'text_cb' : {v -> v.name}})
6019< results in a list of buffer information dicts with buffer
6020 names fuzzy matching "spl". >
6021 :echo v:oldfiles->matchfuzzy("test")
6022< results in a list of file names fuzzy matching "test". >
6023 :let l = readfile("buffer.c")->matchfuzzy("str")
6024< results in a list of lines in "buffer.c" fuzzy matching "str". >
6025 :echo ['one two', 'two one']->matchfuzzy('two one')
6026< results in ['two one', 'one two']. >
6027 :echo ['one two', 'two one']->matchfuzzy('two one',
6028 \ {'matchseq': 1})
6029< results in ['two one'].
6030
6031matchfuzzypos({list}, {str} [, {dict}]) *matchfuzzypos()*
6032 Same as |matchfuzzy()|, but returns the list of matched
6033 strings, the list of character positions where characters
6034 in {str} matches and a list of matching scores. You can
6035 use |byteidx()| to convert a character position to a byte
6036 position.
6037
6038 If {str} matches multiple times in a string, then only the
6039 positions for the best match is returned.
6040
6041 If there are no matching strings or there is an error, then a
6042 list with three empty list items is returned.
6043
6044 Example: >
6045 :echo matchfuzzypos(['testing'], 'tsg')
6046< results in [['testing'], [[0, 2, 6]], [99]] >
6047 :echo matchfuzzypos(['clay', 'lacy'], 'la')
6048< results in [['lacy', 'clay'], [[0, 1], [1, 2]], [153, 133]] >
6049 :echo [{'text': 'hello', 'id' : 10}]->matchfuzzypos('ll', {'key' : 'text'})
6050< results in [[{'id': 10, 'text': 'hello'}], [[2, 3]], [127]]
6051
6052matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()*
6053 Same as |match()|, but return a |List|. The first item in the
6054 list is the matched string, same as what matchstr() would
6055 return. Following items are submatches, like "\1", "\2", etc.
6056 in |:substitute|. When an optional submatch didn't match an
6057 empty string is used. Example: >
6058 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
6059< Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
6060 When there is no match an empty list is returned.
6061
6062 You can pass in a List, but that is not very useful.
6063
6064 Can also be used as a |method|: >
6065 GetText()->matchlist('word')
6066
6067matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()*
6068 Same as |match()|, but return the matched string. Example: >
6069 :echo matchstr("testing", "ing")
6070< results in "ing".
6071 When there is no match "" is returned.
6072 The {start}, if given, has the same meaning as for |match()|. >
6073 :echo matchstr("testing", "ing", 2)
6074< results in "ing". >
6075 :echo matchstr("testing", "ing", 5)
6076< result is "".
6077 When {expr} is a |List| then the matching item is returned.
6078 The type isn't changed, it's not necessarily a String.
6079
6080 Can also be used as a |method|: >
6081 GetText()->matchstr('word')
6082
6083matchstrpos({expr}, {pat} [, {start} [, {count}]]) *matchstrpos()*
6084 Same as |matchstr()|, but return the matched string, the start
6085 position and the end position of the match. Example: >
6086 :echo matchstrpos("testing", "ing")
6087< results in ["ing", 4, 7].
6088 When there is no match ["", -1, -1] is returned.
6089 The {start}, if given, has the same meaning as for |match()|. >
6090 :echo matchstrpos("testing", "ing", 2)
6091< results in ["ing", 4, 7]. >
6092 :echo matchstrpos("testing", "ing", 5)
6093< result is ["", -1, -1].
6094 When {expr} is a |List| then the matching item, the index
6095 of first item where {pat} matches, the start position and the
6096 end position of the match are returned. >
6097 :echo matchstrpos([1, '__x'], '\a')
6098< result is ["x", 1, 2, 3].
6099 The type isn't changed, it's not necessarily a String.
6100
6101 Can also be used as a |method|: >
6102 GetText()->matchstrpos('word')
6103<
6104
6105 *max()*
6106max({expr}) Return the maximum value of all items in {expr}. Example: >
6107 echo max([apples, pears, oranges])
6108
6109< {expr} can be a |List| or a |Dictionary|. For a Dictionary,
6110 it returns the maximum of all values in the Dictionary.
6111 If {expr} is neither a List nor a Dictionary, or one of the
6112 items in {expr} cannot be used as a Number this results in
6113 an error. An empty |List| or |Dictionary| results in zero.
6114
6115 Can also be used as a |method|: >
6116 mylist->max()
6117
6118
6119menu_info({name} [, {mode}]) *menu_info()*
6120 Return information about the specified menu {name} in
6121 mode {mode}. The menu name should be specified without the
6122 shortcut character ('&'). If {name} is "", then the top-level
6123 menu names are returned.
6124
6125 {mode} can be one of these strings:
6126 "n" Normal
6127 "v" Visual (including Select)
6128 "o" Operator-pending
6129 "i" Insert
6130 "c" Cmd-line
6131 "s" Select
6132 "x" Visual
6133 "t" Terminal-Job
6134 "" Normal, Visual and Operator-pending
6135 "!" Insert and Cmd-line
6136 When {mode} is omitted, the modes for "" are used.
6137
6138 Returns a |Dictionary| containing the following items:
6139 accel menu item accelerator text |menu-text|
6140 display display name (name without '&')
6141 enabled v:true if this menu item is enabled
6142 Refer to |:menu-enable|
6143 icon name of the icon file (for toolbar)
6144 |toolbar-icon|
6145 iconidx index of a built-in icon
6146 modes modes for which the menu is defined. In
6147 addition to the modes mentioned above, these
6148 characters will be used:
6149 " " Normal, Visual and Operator-pending
6150 name menu item name.
6151 noremenu v:true if the {rhs} of the menu item is not
6152 remappable else v:false.
6153 priority menu order priority |menu-priority|
6154 rhs right-hand-side of the menu item. The returned
6155 string has special characters translated like
6156 in the output of the ":menu" command listing.
6157 When the {rhs} of a menu item is empty, then
6158 "<Nop>" is returned.
6159 script v:true if script-local remapping of {rhs} is
6160 allowed else v:false. See |:menu-script|.
6161 shortcut shortcut key (character after '&' in
6162 the menu name) |menu-shortcut|
6163 silent v:true if the menu item is created
6164 with <silent> argument |:menu-silent|
6165 submenus |List| containing the names of
6166 all the submenus. Present only if the menu
6167 item has submenus.
6168
6169 Returns an empty dictionary if the menu item is not found.
6170
6171 Examples: >
6172 :echo menu_info('Edit.Cut')
6173 :echo menu_info('File.Save', 'n')
6174
6175 " Display the entire menu hierarchy in a buffer
6176 func ShowMenu(name, pfx)
6177 let m = menu_info(a:name)
6178 call append(line('$'), a:pfx .. m.display)
6179 for child in m->get('submenus', [])
6180 call ShowMenu(a:name .. '.' .. escape(child, '.'),
6181 \ a:pfx .. ' ')
6182 endfor
6183 endfunc
6184 new
6185 for topmenu in menu_info('').submenus
6186 call ShowMenu(topmenu, '')
6187 endfor
6188<
6189 Can also be used as a |method|: >
6190 GetMenuName()->menu_info('v')
6191
6192
6193< *min()*
6194min({expr}) Return the minimum value of all items in {expr}. Example: >
6195 echo min([apples, pears, oranges])
6196
6197< {expr} can be a |List| or a |Dictionary|. For a Dictionary,
6198 it returns the minimum of all values in the Dictionary.
6199 If {expr} is neither a List nor a Dictionary, or one of the
6200 items in {expr} cannot be used as a Number this results in
6201 an error. An empty |List| or |Dictionary| results in zero.
6202
6203 Can also be used as a |method|: >
6204 mylist->min()
6205
6206< *mkdir()* *E739*
6207mkdir({name} [, {path} [, {prot}]])
6208 Create directory {name}.
6209
6210 If {path} is "p" then intermediate directories are created as
6211 necessary. Otherwise it must be "".
6212
6213 If {prot} is given it is used to set the protection bits of
6214 the new directory. The default is 0o755 (rwxr-xr-x: r/w for
6215 the user, readable for others). Use 0o700 to make it
6216 unreadable for others. This is only used for the last part of
6217 {name}. Thus if you create /tmp/foo/bar then /tmp/foo will be
6218 created with 0o755.
6219 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006220 :call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006221
6222< This function is not available in the |sandbox|.
6223
6224 There is no error if the directory already exists and the "p"
6225 flag is passed (since patch 8.0.1708). However, without the
6226 "p" option the call will fail.
6227
6228 The function result is a Number, which is TRUE if the call was
6229 successful or FALSE if the directory creation failed or partly
6230 failed.
6231
6232 Not available on all systems. To check use: >
6233 :if exists("*mkdir")
6234
6235< Can also be used as a |method|: >
6236 GetName()->mkdir()
6237<
6238 *mode()*
6239mode([expr]) Return a string that indicates the current mode.
6240 If [expr] is supplied and it evaluates to a non-zero Number or
6241 a non-empty String (|non-zero-arg|), then the full mode is
6242 returned, otherwise only the first letter is returned.
6243 Also see |state()|.
6244
6245 n Normal
6246 no Operator-pending
6247 nov Operator-pending (forced characterwise |o_v|)
6248 noV Operator-pending (forced linewise |o_V|)
6249 noCTRL-V Operator-pending (forced blockwise |o_CTRL-V|);
6250 CTRL-V is one character
6251 niI Normal using |i_CTRL-O| in |Insert-mode|
6252 niR Normal using |i_CTRL-O| in |Replace-mode|
6253 niV Normal using |i_CTRL-O| in |Virtual-Replace-mode|
6254 nt Terminal-Normal (insert goes to Terminal-Job mode)
6255 v Visual by character
6256 vs Visual by character using |v_CTRL-O| in Select mode
6257 V Visual by line
6258 Vs Visual by line using |v_CTRL-O| in Select mode
6259 CTRL-V Visual blockwise
6260 CTRL-Vs Visual blockwise using |v_CTRL-O| in Select mode
6261 s Select by character
6262 S Select by line
6263 CTRL-S Select blockwise
6264 i Insert
6265 ic Insert mode completion |compl-generic|
6266 ix Insert mode |i_CTRL-X| completion
6267 R Replace |R|
6268 Rc Replace mode completion |compl-generic|
6269 Rx Replace mode |i_CTRL-X| completion
6270 Rv Virtual Replace |gR|
6271 Rvc Virtual Replace mode completion |compl-generic|
6272 Rvx Virtual Replace mode |i_CTRL-X| completion
6273 c Command-line editing
6274 cv Vim Ex mode |gQ|
6275 ce Normal Ex mode |Q|
6276 r Hit-enter prompt
6277 rm The -- more -- prompt
6278 r? A |:confirm| query of some sort
6279 ! Shell or external command is executing
6280 t Terminal-Job mode: keys go to the job
6281
6282 This is useful in the 'statusline' option or when used
6283 with |remote_expr()| In most other places it always returns
6284 "c" or "n".
6285 Note that in the future more modes and more specific modes may
6286 be added. It's better not to compare the whole string but only
6287 the leading character(s).
6288 Also see |visualmode()|.
6289
6290 Can also be used as a |method|: >
6291 DoFull()->mode()
6292
6293mzeval({expr}) *mzeval()*
6294 Evaluate MzScheme expression {expr} and return its result
6295 converted to Vim data structures.
6296 Numbers and strings are returned as they are.
6297 Pairs (including lists and improper lists) and vectors are
6298 returned as Vim |Lists|.
6299 Hash tables are represented as Vim |Dictionary| type with keys
6300 converted to strings.
6301 All other types are converted to string with display function.
6302 Examples: >
6303 :mz (define l (list 1 2 3))
6304 :mz (define h (make-hash)) (hash-set! h "list" l)
6305 :echo mzeval("l")
6306 :echo mzeval("h")
6307<
6308 Note that in a `:def` function local variables are not visible
6309 to {expr}.
6310
6311 Can also be used as a |method|: >
6312 GetExpr()->mzeval()
6313<
6314 {only available when compiled with the |+mzscheme| feature}
6315
6316nextnonblank({lnum}) *nextnonblank()*
6317 Return the line number of the first line at or below {lnum}
6318 that is not blank. Example: >
6319 if getline(nextnonblank(1)) =~ "Java"
6320< When {lnum} is invalid or there is no non-blank line at or
6321 below it, zero is returned.
6322 {lnum} is used like with |getline()|.
6323 See also |prevnonblank()|.
6324
6325 Can also be used as a |method|: >
6326 GetLnum()->nextnonblank()
6327
6328nr2char({expr} [, {utf8}]) *nr2char()*
6329 Return a string with a single character, which has the number
6330 value {expr}. Examples: >
6331 nr2char(64) returns "@"
6332 nr2char(32) returns " "
6333< When {utf8} is omitted or zero, the current 'encoding' is used.
6334 Example for "utf-8": >
6335 nr2char(300) returns I with bow character
6336< When {utf8} is TRUE, always return UTF-8 characters.
6337 Note that a NUL character in the file is specified with
6338 nr2char(10), because NULs are represented with newline
6339 characters. nr2char(0) is a real NUL and terminates the
6340 string, thus results in an empty string.
6341 To turn a list of character numbers into a string: >
6342 let list = [65, 66, 67]
6343 let str = join(map(list, {_, val -> nr2char(val)}), '')
6344< Result: "ABC"
6345
6346 Can also be used as a |method|: >
6347 GetNumber()->nr2char()
6348
6349or({expr}, {expr}) *or()*
6350 Bitwise OR on the two arguments. The arguments are converted
6351 to a number. A List, Dict or Float argument causes an error.
Bram Moolenaar5a6ec102022-05-27 21:58:00 +01006352 Also see `and()` and `xor()`.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006353 Example: >
6354 :let bits = or(bits, 0x80)
6355< Can also be used as a |method|: >
6356 :let bits = bits->or(0x80)
6357
Bram Moolenaar5a6ec102022-05-27 21:58:00 +01006358< Rationale: The reason this is a function and not using the "|"
6359 character like many languages, is that Vi has always used "|"
6360 to separate commands. In many places it would not be clear if
6361 "|" is an operator or a command separator.
6362
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006363
6364pathshorten({path} [, {len}]) *pathshorten()*
6365 Shorten directory names in the path {path} and return the
6366 result. The tail, the file name, is kept as-is. The other
6367 components in the path are reduced to {len} letters in length.
6368 If {len} is omitted or smaller than 1 then 1 is used (single
6369 letters). Leading '~' and '.' characters are kept. Examples: >
6370 :echo pathshorten('~/.vim/autoload/myfile.vim')
6371< ~/.v/a/myfile.vim ~
6372>
6373 :echo pathshorten('~/.vim/autoload/myfile.vim', 2)
6374< ~/.vi/au/myfile.vim ~
6375 It doesn't matter if the path exists or not.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01006376 Returns an empty string on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006377
6378 Can also be used as a |method|: >
6379 GetDirectories()->pathshorten()
6380
6381perleval({expr}) *perleval()*
6382 Evaluate Perl expression {expr} in scalar context and return
6383 its result converted to Vim data structures. If value can't be
6384 converted, it is returned as a string Perl representation.
6385 Note: If you want an array or hash, {expr} must return a
6386 reference to it.
6387 Example: >
6388 :echo perleval('[1 .. 4]')
6389< [1, 2, 3, 4]
6390
6391 Note that in a `:def` function local variables are not visible
6392 to {expr}.
6393
6394 Can also be used as a |method|: >
6395 GetExpr()->perleval()
6396
6397< {only available when compiled with the |+perl| feature}
6398
6399
6400popup_ functions are documented here: |popup-functions|
6401
6402
6403pow({x}, {y}) *pow()*
6404 Return the power of {x} to the exponent {y} as a |Float|.
6405 {x} and {y} must evaluate to a |Float| or a |Number|.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01006406 Returns 0.0 if {x} or {y} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006407 Examples: >
6408 :echo pow(3, 3)
6409< 27.0 >
6410 :echo pow(2, 16)
6411< 65536.0 >
6412 :echo pow(32, 0.20)
6413< 2.0
6414
6415 Can also be used as a |method|: >
6416 Compute()->pow(3)
6417<
6418 {only available when compiled with the |+float| feature}
6419
6420prevnonblank({lnum}) *prevnonblank()*
6421 Return the line number of the first line at or above {lnum}
6422 that is not blank. Example: >
6423 let ind = indent(prevnonblank(v:lnum - 1))
6424< When {lnum} is invalid or there is no non-blank line at or
6425 above it, zero is returned.
6426 {lnum} is used like with |getline()|.
6427 Also see |nextnonblank()|.
6428
6429 Can also be used as a |method|: >
6430 GetLnum()->prevnonblank()
6431
6432printf({fmt}, {expr1} ...) *printf()*
6433 Return a String with {fmt}, where "%" items are replaced by
6434 the formatted form of their respective arguments. Example: >
6435 printf("%4d: E%d %.30s", lnum, errno, msg)
6436< May result in:
6437 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
6438
6439 When used as a |method| the base is passed as the second
6440 argument: >
6441 Compute()->printf("result: %d")
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006442<
6443 You can use `call()` to pass the items as a list.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006444
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006445 Often used items are:
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006446 %s string
6447 %6S string right-aligned in 6 display cells
6448 %6s string right-aligned in 6 bytes
6449 %.9s string truncated to 9 bytes
6450 %c single byte
6451 %d decimal number
6452 %5d decimal number padded with spaces to 5 characters
6453 %x hex number
6454 %04x hex number padded with zeros to at least 4 characters
6455 %X hex number using upper case letters
6456 %o octal number
6457 %08b binary number padded with zeros to at least 8 chars
6458 %f floating point number as 12.23, inf, -inf or nan
6459 %F floating point number as 12.23, INF, -INF or NAN
6460 %e floating point number as 1.23e3, inf, -inf or nan
6461 %E floating point number as 1.23E3, INF, -INF or NAN
6462 %g floating point number, as %f or %e depending on value
6463 %G floating point number, as %F or %E depending on value
6464 %% the % character itself
6465
6466 Conversion specifications start with '%' and end with the
6467 conversion type. All other characters are copied unchanged to
6468 the result.
6469
6470 The "%" starts a conversion specification. The following
6471 arguments appear in sequence:
6472
6473 % [flags] [field-width] [.precision] type
6474
6475 flags
6476 Zero or more of the following flags:
6477
6478 # The value should be converted to an "alternate
6479 form". For c, d, and s conversions, this option
6480 has no effect. For o conversions, the precision
6481 of the number is increased to force the first
6482 character of the output string to a zero (except
6483 if a zero value is printed with an explicit
6484 precision of zero).
6485 For b and B conversions, a non-zero result has
6486 the string "0b" (or "0B" for B conversions)
6487 prepended to it.
6488 For x and X conversions, a non-zero result has
6489 the string "0x" (or "0X" for X conversions)
6490 prepended to it.
6491
6492 0 (zero) Zero padding. For all conversions the converted
6493 value is padded on the left with zeros rather
6494 than blanks. If a precision is given with a
6495 numeric conversion (d, b, B, o, x, and X), the 0
6496 flag is ignored.
6497
6498 - A negative field width flag; the converted value
6499 is to be left adjusted on the field boundary.
6500 The converted value is padded on the right with
6501 blanks, rather than on the left with blanks or
6502 zeros. A - overrides a 0 if both are given.
6503
6504 ' ' (space) A blank should be left before a positive
6505 number produced by a signed conversion (d).
6506
6507 + A sign must always be placed before a number
6508 produced by a signed conversion. A + overrides
6509 a space if both are used.
6510
6511 field-width
6512 An optional decimal digit string specifying a minimum
6513 field width. If the converted value has fewer bytes
6514 than the field width, it will be padded with spaces on
6515 the left (or right, if the left-adjustment flag has
6516 been given) to fill out the field width. For the S
6517 conversion the count is in cells.
6518
6519 .precision
6520 An optional precision, in the form of a period '.'
6521 followed by an optional digit string. If the digit
6522 string is omitted, the precision is taken as zero.
6523 This gives the minimum number of digits to appear for
6524 d, o, x, and X conversions, the maximum number of
6525 bytes to be printed from a string for s conversions,
6526 or the maximum number of cells to be printed from a
6527 string for S conversions.
6528 For floating point it is the number of digits after
6529 the decimal point.
6530
6531 type
6532 A character that specifies the type of conversion to
6533 be applied, see below.
6534
6535 A field width or precision, or both, may be indicated by an
6536 asterisk '*' instead of a digit string. In this case, a
6537 Number argument supplies the field width or precision. A
6538 negative field width is treated as a left adjustment flag
6539 followed by a positive field width; a negative precision is
6540 treated as though it were missing. Example: >
6541 :echo printf("%d: %.*s", nr, width, line)
6542< This limits the length of the text used from "line" to
6543 "width" bytes.
6544
6545 The conversion specifiers and their meanings are:
6546
6547 *printf-d* *printf-b* *printf-B* *printf-o*
6548 *printf-x* *printf-X*
6549 dbBoxX The Number argument is converted to signed decimal
6550 (d), unsigned binary (b and B), unsigned octal (o), or
6551 unsigned hexadecimal (x and X) notation. The letters
6552 "abcdef" are used for x conversions; the letters
6553 "ABCDEF" are used for X conversions.
6554 The precision, if any, gives the minimum number of
6555 digits that must appear; if the converted value
6556 requires fewer digits, it is padded on the left with
6557 zeros.
6558 In no case does a non-existent or small field width
6559 cause truncation of a numeric field; if the result of
6560 a conversion is wider than the field width, the field
6561 is expanded to contain the conversion result.
6562 The 'h' modifier indicates the argument is 16 bits.
6563 The 'l' modifier indicates the argument is 32 bits.
6564 The 'L' modifier indicates the argument is 64 bits.
6565 Generally, these modifiers are not useful. They are
6566 ignored when type is known from the argument.
6567
6568 i alias for d
6569 D alias for ld
6570 U alias for lu
6571 O alias for lo
6572
6573 *printf-c*
6574 c The Number argument is converted to a byte, and the
6575 resulting character is written.
6576
6577 *printf-s*
6578 s The text of the String argument is used. If a
6579 precision is specified, no more bytes than the number
6580 specified are used.
6581 If the argument is not a String type, it is
6582 automatically converted to text with the same format
6583 as ":echo".
6584 *printf-S*
6585 S The text of the String argument is used. If a
6586 precision is specified, no more display cells than the
6587 number specified are used.
6588
6589 *printf-f* *E807*
6590 f F The Float argument is converted into a string of the
6591 form 123.456. The precision specifies the number of
6592 digits after the decimal point. When the precision is
6593 zero the decimal point is omitted. When the precision
6594 is not specified 6 is used. A really big number
6595 (out of range or dividing by zero) results in "inf"
6596 or "-inf" with %f (INF or -INF with %F).
6597 "0.0 / 0.0" results in "nan" with %f (NAN with %F).
6598 Example: >
6599 echo printf("%.2f", 12.115)
6600< 12.12
6601 Note that roundoff depends on the system libraries.
6602 Use |round()| when in doubt.
6603
6604 *printf-e* *printf-E*
6605 e E The Float argument is converted into a string of the
6606 form 1.234e+03 or 1.234E+03 when using 'E'. The
6607 precision specifies the number of digits after the
6608 decimal point, like with 'f'.
6609
6610 *printf-g* *printf-G*
6611 g G The Float argument is converted like with 'f' if the
6612 value is between 0.001 (inclusive) and 10000000.0
6613 (exclusive). Otherwise 'e' is used for 'g' and 'E'
6614 for 'G'. When no precision is specified superfluous
6615 zeroes and '+' signs are removed, except for the zero
6616 immediately after the decimal point. Thus 10000000.0
6617 results in 1.0e7.
6618
6619 *printf-%*
6620 % A '%' is written. No argument is converted. The
6621 complete conversion specification is "%%".
6622
6623 When a Number argument is expected a String argument is also
6624 accepted and automatically converted.
6625 When a Float or String argument is expected a Number argument
6626 is also accepted and automatically converted.
6627 Any other argument type results in an error message.
6628
6629 *E766* *E767*
6630 The number of {exprN} arguments must exactly match the number
6631 of "%" items. If there are not sufficient or too many
6632 arguments an error is given. Up to 18 arguments can be used.
6633
6634
6635prompt_getprompt({buf}) *prompt_getprompt()*
6636 Returns the effective prompt text for buffer {buf}. {buf} can
6637 be a buffer name or number. See |prompt-buffer|.
6638
6639 If the buffer doesn't exist or isn't a prompt buffer, an empty
6640 string is returned.
6641
6642 Can also be used as a |method|: >
6643 GetBuffer()->prompt_getprompt()
6644
6645< {only available when compiled with the |+channel| feature}
6646
6647
6648prompt_setcallback({buf}, {expr}) *prompt_setcallback()*
6649 Set prompt callback for buffer {buf} to {expr}. When {expr}
6650 is an empty string the callback is removed. This has only
6651 effect if {buf} has 'buftype' set to "prompt".
6652
6653 The callback is invoked when pressing Enter. The current
6654 buffer will always be the prompt buffer. A new line for a
6655 prompt is added before invoking the callback, thus the prompt
6656 for which the callback was invoked will be in the last but one
6657 line.
6658 If the callback wants to add text to the buffer, it must
6659 insert it above the last line, since that is where the current
6660 prompt is. This can also be done asynchronously.
6661 The callback is invoked with one argument, which is the text
6662 that was entered at the prompt. This can be an empty string
6663 if the user only typed Enter.
6664 Example: >
6665 call prompt_setcallback(bufnr(), function('s:TextEntered'))
6666 func s:TextEntered(text)
6667 if a:text == 'exit' || a:text == 'quit'
6668 stopinsert
6669 close
6670 else
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006671 call append(line('$') - 1, 'Entered: "' .. a:text .. '"')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006672 " Reset 'modified' to allow the buffer to be closed.
6673 set nomodified
6674 endif
6675 endfunc
6676
6677< Can also be used as a |method|: >
6678 GetBuffer()->prompt_setcallback(callback)
6679
6680< {only available when compiled with the |+channel| feature}
6681
6682prompt_setinterrupt({buf}, {expr}) *prompt_setinterrupt()*
6683 Set a callback for buffer {buf} to {expr}. When {expr} is an
6684 empty string the callback is removed. This has only effect if
6685 {buf} has 'buftype' set to "prompt".
6686
6687 This callback will be invoked when pressing CTRL-C in Insert
6688 mode. Without setting a callback Vim will exit Insert mode,
6689 as in any buffer.
6690
6691 Can also be used as a |method|: >
6692 GetBuffer()->prompt_setinterrupt(callback)
6693
6694< {only available when compiled with the |+channel| feature}
6695
6696prompt_setprompt({buf}, {text}) *prompt_setprompt()*
6697 Set prompt for buffer {buf} to {text}. You most likely want
6698 {text} to end in a space.
6699 The result is only visible if {buf} has 'buftype' set to
6700 "prompt". Example: >
6701 call prompt_setprompt(bufnr(), 'command: ')
6702<
6703 Can also be used as a |method|: >
6704 GetBuffer()->prompt_setprompt('command: ')
6705
6706< {only available when compiled with the |+channel| feature}
6707
6708prop_ functions are documented here: |text-prop-functions|
6709
6710pum_getpos() *pum_getpos()*
6711 If the popup menu (see |ins-completion-menu|) is not visible,
6712 returns an empty |Dictionary|, otherwise, returns a
6713 |Dictionary| with the following keys:
6714 height nr of items visible
6715 width screen cells
6716 row top screen row (0 first row)
6717 col leftmost screen column (0 first col)
6718 size total nr of items
6719 scrollbar |TRUE| if scrollbar is visible
6720
6721 The values are the same as in |v:event| during
6722 |CompleteChanged|.
6723
6724pumvisible() *pumvisible()*
6725 Returns non-zero when the popup menu is visible, zero
6726 otherwise. See |ins-completion-menu|.
6727 This can be used to avoid some things that would remove the
6728 popup menu.
6729
6730py3eval({expr}) *py3eval()*
6731 Evaluate Python expression {expr} and return its result
6732 converted to Vim data structures.
6733 Numbers and strings are returned as they are (strings are
6734 copied though, Unicode strings are additionally converted to
6735 'encoding').
6736 Lists are represented as Vim |List| type.
6737 Dictionaries are represented as Vim |Dictionary| type with
6738 keys converted to strings.
6739 Note that in a `:def` function local variables are not visible
6740 to {expr}.
6741
6742 Can also be used as a |method|: >
6743 GetExpr()->py3eval()
6744
6745< {only available when compiled with the |+python3| feature}
6746
6747 *E858* *E859*
6748pyeval({expr}) *pyeval()*
6749 Evaluate Python expression {expr} and return its result
6750 converted to Vim data structures.
6751 Numbers and strings are returned as they are (strings are
6752 copied though).
6753 Lists are represented as Vim |List| type.
6754 Dictionaries are represented as Vim |Dictionary| type,
6755 non-string keys result in error.
6756 Note that in a `:def` function local variables are not visible
6757 to {expr}.
6758
6759 Can also be used as a |method|: >
6760 GetExpr()->pyeval()
6761
6762< {only available when compiled with the |+python| feature}
6763
6764pyxeval({expr}) *pyxeval()*
6765 Evaluate Python expression {expr} and return its result
6766 converted to Vim data structures.
6767 Uses Python 2 or 3, see |python_x| and 'pyxversion'.
6768 See also: |pyeval()|, |py3eval()|
6769
6770 Can also be used as a |method|: >
6771 GetExpr()->pyxeval()
6772
6773< {only available when compiled with the |+python| or the
6774 |+python3| feature}
6775
6776rand([{expr}]) *rand()* *random*
6777 Return a pseudo-random Number generated with an xoshiro128**
6778 algorithm using seed {expr}. The returned number is 32 bits,
6779 also on 64 bits systems, for consistency.
6780 {expr} can be initialized by |srand()| and will be updated by
6781 rand(). If {expr} is omitted, an internal seed value is used
6782 and updated.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01006783 Returns -1 if {expr} is invalid.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006784
6785 Examples: >
6786 :echo rand()
6787 :let seed = srand()
6788 :echo rand(seed)
6789 :echo rand(seed) % 16 " random number 0 - 15
6790<
6791
6792 *E726* *E727*
6793range({expr} [, {max} [, {stride}]]) *range()*
6794 Returns a |List| with Numbers:
6795 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
6796 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
6797 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
6798 {max}] (increasing {expr} with {stride} each time, not
6799 producing a value past {max}).
6800 When the maximum is one before the start the result is an
6801 empty list. When the maximum is more than one before the
6802 start this is an error.
6803 Examples: >
6804 range(4) " [0, 1, 2, 3]
6805 range(2, 4) " [2, 3, 4]
6806 range(2, 9, 3) " [2, 5, 8]
6807 range(2, -2, -1) " [2, 1, 0, -1, -2]
6808 range(0) " []
6809 range(2, 0) " error!
6810<
6811 Can also be used as a |method|: >
6812 GetExpr()->range()
6813<
6814
6815readblob({fname}) *readblob()*
6816 Read file {fname} in binary mode and return a |Blob|.
6817 When the file can't be opened an error message is given and
6818 the result is an empty |Blob|.
6819 Also see |readfile()| and |writefile()|.
6820
6821
6822readdir({directory} [, {expr} [, {dict}]]) *readdir()*
6823 Return a list with file and directory names in {directory}.
6824 You can also use |glob()| if you don't need to do complicated
6825 things, such as limiting the number of matches.
6826 The list will be sorted (case sensitive), see the {dict}
6827 argument below for changing the sort order.
6828
6829 When {expr} is omitted all entries are included.
6830 When {expr} is given, it is evaluated to check what to do:
6831 If {expr} results in -1 then no further entries will
6832 be handled.
6833 If {expr} results in 0 then this entry will not be
6834 added to the list.
6835 If {expr} results in 1 then this entry will be added
6836 to the list.
6837 The entries "." and ".." are always excluded.
6838 Each time {expr} is evaluated |v:val| is set to the entry name.
6839 When {expr} is a function the name is passed as the argument.
6840 For example, to get a list of files ending in ".txt": >
6841 readdir(dirname, {n -> n =~ '.txt$'})
6842< To skip hidden and backup files: >
6843 readdir(dirname, {n -> n !~ '^\.\|\~$'})
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006844< *E857*
6845 The optional {dict} argument allows for further custom
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006846 values. Currently this is used to specify if and how sorting
6847 should be performed. The dict can have the following members:
6848
6849 sort How to sort the result returned from the system.
6850 Valid values are:
6851 "none" do not sort (fastest method)
6852 "case" sort case sensitive (byte value of
6853 each character, technically, using
6854 strcmp()) (default)
6855 "icase" sort case insensitive (technically
6856 using strcasecmp())
6857 "collate" sort using the collation order
6858 of the "POSIX" or "C" |locale|
6859 (technically using strcoll())
6860 Other values are silently ignored.
6861
6862 For example, to get a list of all files in the current
6863 directory without sorting the individual entries: >
6864 readdir('.', '1', #{sort: 'none'})
6865< If you want to get a directory tree: >
6866 function! s:tree(dir)
6867 return {a:dir : map(readdir(a:dir),
6868 \ {_, x -> isdirectory(x) ?
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006869 \ {x : s:tree(a:dir .. '/' .. x)} : x})}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006870 endfunction
6871 echo s:tree(".")
6872<
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01006873 Returns an empty List on error.
6874
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006875 Can also be used as a |method|: >
6876 GetDirName()->readdir()
6877<
6878readdirex({directory} [, {expr} [, {dict}]]) *readdirex()*
6879 Extended version of |readdir()|.
6880 Return a list of Dictionaries with file and directory
6881 information in {directory}.
6882 This is useful if you want to get the attributes of file and
6883 directory at the same time as getting a list of a directory.
6884 This is much faster than calling |readdir()| then calling
6885 |getfperm()|, |getfsize()|, |getftime()| and |getftype()| for
6886 each file and directory especially on MS-Windows.
6887 The list will by default be sorted by name (case sensitive),
6888 the sorting can be changed by using the optional {dict}
6889 argument, see |readdir()|.
6890
6891 The Dictionary for file and directory information has the
6892 following items:
6893 group Group name of the entry. (Only on Unix)
6894 name Name of the entry.
6895 perm Permissions of the entry. See |getfperm()|.
6896 size Size of the entry. See |getfsize()|.
6897 time Timestamp of the entry. See |getftime()|.
6898 type Type of the entry.
6899 On Unix, almost same as |getftype()| except:
6900 Symlink to a dir "linkd"
6901 Other symlink "link"
6902 On MS-Windows:
6903 Normal file "file"
6904 Directory "dir"
6905 Junction "junction"
6906 Symlink to a dir "linkd"
6907 Other symlink "link"
6908 Other reparse point "reparse"
6909 user User name of the entry's owner. (Only on Unix)
6910 On Unix, if the entry is a symlink, the Dictionary includes
6911 the information of the target (except the "type" item).
6912 On MS-Windows, it includes the information of the symlink
6913 itself because of performance reasons.
6914
6915 When {expr} is omitted all entries are included.
6916 When {expr} is given, it is evaluated to check what to do:
6917 If {expr} results in -1 then no further entries will
6918 be handled.
6919 If {expr} results in 0 then this entry will not be
6920 added to the list.
6921 If {expr} results in 1 then this entry will be added
6922 to the list.
6923 The entries "." and ".." are always excluded.
6924 Each time {expr} is evaluated |v:val| is set to a |Dictionary|
6925 of the entry.
6926 When {expr} is a function the entry is passed as the argument.
6927 For example, to get a list of files ending in ".txt": >
6928 readdirex(dirname, {e -> e.name =~ '.txt$'})
6929<
6930 For example, to get a list of all files in the current
6931 directory without sorting the individual entries: >
6932 readdirex(dirname, '1', #{sort: 'none'})
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006933<
6934 Can also be used as a |method|: >
6935 GetDirName()->readdirex()
6936<
6937
6938 *readfile()*
6939readfile({fname} [, {type} [, {max}]])
6940 Read file {fname} and return a |List|, each line of the file
6941 as an item. Lines are broken at NL characters. Macintosh
6942 files separated with CR will result in a single long line
6943 (unless a NL appears somewhere).
6944 All NUL characters are replaced with a NL character.
6945 When {type} contains "b" binary mode is used:
6946 - When the last line ends in a NL an extra empty list item is
6947 added.
6948 - No CR characters are removed.
6949 Otherwise:
6950 - CR characters that appear before a NL are removed.
6951 - Whether the last line ends in a NL or not does not matter.
6952 - When 'encoding' is Unicode any UTF-8 byte order mark is
6953 removed from the text.
6954 When {max} is given this specifies the maximum number of lines
6955 to be read. Useful if you only want to check the first ten
6956 lines of a file: >
6957 :for line in readfile(fname, '', 10)
6958 : if line =~ 'Date' | echo line | endif
6959 :endfor
6960< When {max} is negative -{max} lines from the end of the file
6961 are returned, or as many as there are.
6962 When {max} is zero the result is an empty list.
6963 Note that without {max} the whole file is read into memory.
6964 Also note that there is no recognition of encoding. Read a
6965 file into a buffer if you need to.
6966 Deprecated (use |readblob()| instead): When {type} contains
6967 "B" a |Blob| is returned with the binary data of the file
6968 unmodified.
6969 When the file can't be opened an error message is given and
6970 the result is an empty list.
6971 Also see |writefile()|.
6972
6973 Can also be used as a |method|: >
6974 GetFileName()->readfile()
6975
6976reduce({object}, {func} [, {initial}]) *reduce()* *E998*
6977 {func} is called for every item in {object}, which can be a
6978 |String|, |List| or a |Blob|. {func} is called with two
6979 arguments: the result so far and current item. After
Bram Moolenaarf10911e2022-01-29 22:20:48 +00006980 processing all items the result is returned. *E1132*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006981
6982 {initial} is the initial result. When omitted, the first item
6983 in {object} is used and {func} is first called for the second
6984 item. If {initial} is not given and {object} is empty no
6985 result can be computed, an E998 error is given.
6986
6987 Examples: >
6988 echo reduce([1, 3, 5], { acc, val -> acc + val })
6989 echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a')
6990 echo reduce(0z1122, { acc, val -> 2 * acc + val })
6991 echo reduce('xyz', { acc, val -> acc .. ',' .. val })
6992<
6993 Can also be used as a |method|: >
6994 echo mylist->reduce({ acc, val -> acc + val }, 0)
6995
6996
6997reg_executing() *reg_executing()*
6998 Returns the single letter name of the register being executed.
6999 Returns an empty string when no register is being executed.
7000 See |@|.
7001
7002reg_recording() *reg_recording()*
7003 Returns the single letter name of the register being recorded.
7004 Returns an empty string when not recording. See |q|.
7005
7006reltime([{start} [, {end}]]) *reltime()*
7007 Return an item that represents a time value. The item is a
7008 list with items that depend on the system. In Vim 9 script
7009 list<any> can be used.
7010 The item can be passed to |reltimestr()| to convert it to a
7011 string or |reltimefloat()| to convert to a Float.
7012
Bram Moolenaar016188f2022-06-06 20:52:59 +01007013 Without an argument reltime() returns the current time (the
Bram Moolenaareb490412022-06-28 13:44:46 +01007014 representation is system-dependent, it can not be used as the
Bram Moolenaar016188f2022-06-06 20:52:59 +01007015 wall-clock time, see |localtime()| for that).
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007016 With one argument is returns the time passed since the time
7017 specified in the argument.
7018 With two arguments it returns the time passed between {start}
7019 and {end}.
7020
7021 The {start} and {end} arguments must be values returned by
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007022 reltime(). If there is an error an empty List is returned in
7023 legacy script, in Vim9 script an error is given.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007024
7025 Can also be used as a |method|: >
7026 GetStart()->reltime()
7027<
7028 {only available when compiled with the |+reltime| feature}
7029
7030reltimefloat({time}) *reltimefloat()*
7031 Return a Float that represents the time value of {time}.
7032 Example: >
7033 let start = reltime()
7034 call MyFunction()
7035 let seconds = reltimefloat(reltime(start))
7036< See the note of reltimestr() about overhead.
7037 Also see |profiling|.
7038 If there is an error 0.0 is returned in legacy script, in Vim9
7039 script an error is given.
7040
7041 Can also be used as a |method|: >
7042 reltime(start)->reltimefloat()
7043
7044< {only available when compiled with the |+reltime| feature}
7045
7046reltimestr({time}) *reltimestr()*
7047 Return a String that represents the time value of {time}.
7048 This is the number of seconds, a dot and the number of
7049 microseconds. Example: >
7050 let start = reltime()
7051 call MyFunction()
7052 echo reltimestr(reltime(start))
7053< Note that overhead for the commands will be added to the time.
7054 The accuracy depends on the system.
7055 Leading spaces are used to make the string align nicely. You
7056 can use split() to remove it. >
7057 echo split(reltimestr(reltime(start)))[0]
7058< Also see |profiling|.
7059 If there is an error an empty string is returned in legacy
7060 script, in Vim9 script an error is given.
7061
7062 Can also be used as a |method|: >
7063 reltime(start)->reltimestr()
7064
7065< {only available when compiled with the |+reltime| feature}
7066
7067 *remote_expr()* *E449*
7068remote_expr({server}, {string} [, {idvar} [, {timeout}]])
Bram Moolenaar944697a2022-02-20 19:48:20 +00007069 Send the {string} to {server}. The {server} argument is a
7070 string, also see |{server}|.
7071
7072 The string is sent as an expression and the result is returned
7073 after evaluation. The result must be a String or a |List|. A
7074 |List| is turned into a String by joining the items with a
7075 line break in between (not at the end), like with join(expr,
7076 "\n").
7077
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007078 If {idvar} is present and not empty, it is taken as the name
7079 of a variable and a {serverid} for later use with
7080 |remote_read()| is stored there.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007081
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007082 If {timeout} is given the read times out after this many
7083 seconds. Otherwise a timeout of 600 seconds is used.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007084
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007085 See also |clientserver| |RemoteReply|.
7086 This function is not available in the |sandbox|.
7087 {only available when compiled with the |+clientserver| feature}
7088 Note: Any errors will cause a local error message to be issued
7089 and the result will be the empty string.
7090
7091 Variables will be evaluated in the global namespace,
7092 independent of a function currently being active. Except
7093 when in debug mode, then local function variables and
7094 arguments can be evaluated.
7095
7096 Examples: >
7097 :echo remote_expr("gvim", "2+2")
7098 :echo remote_expr("gvim1", "b:current_syntax")
7099<
7100 Can also be used as a |method|: >
7101 ServerName()->remote_expr(expr)
7102
7103remote_foreground({server}) *remote_foreground()*
7104 Move the Vim server with the name {server} to the foreground.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007105 The {server} argument is a string, also see |{server}|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007106 This works like: >
7107 remote_expr({server}, "foreground()")
7108< Except that on Win32 systems the client does the work, to work
7109 around the problem that the OS doesn't always allow the server
7110 to bring itself to the foreground.
7111 Note: This does not restore the window if it was minimized,
7112 like foreground() does.
7113 This function is not available in the |sandbox|.
7114
7115 Can also be used as a |method|: >
7116 ServerName()->remote_foreground()
7117
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007118< {only in the Win32, Motif and GTK GUI versions and the
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007119 Win32 console version}
7120
7121
7122remote_peek({serverid} [, {retvar}]) *remote_peek()*
7123 Returns a positive number if there are available strings
7124 from {serverid}. Copies any reply string into the variable
7125 {retvar} if specified. {retvar} must be a string with the
7126 name of a variable.
7127 Returns zero if none are available.
7128 Returns -1 if something is wrong.
7129 See also |clientserver|.
7130 This function is not available in the |sandbox|.
7131 {only available when compiled with the |+clientserver| feature}
7132 Examples: >
7133 :let repl = ""
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007134 :echo "PEEK: " .. remote_peek(id, "repl") .. ": " .. repl
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007135
7136< Can also be used as a |method|: >
7137 ServerId()->remote_peek()
7138
7139remote_read({serverid}, [{timeout}]) *remote_read()*
7140 Return the oldest available reply from {serverid} and consume
7141 it. Unless a {timeout} in seconds is given, it blocks until a
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007142 reply is available. Returns an empty string, if a reply is
7143 not available or on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007144 See also |clientserver|.
7145 This function is not available in the |sandbox|.
7146 {only available when compiled with the |+clientserver| feature}
7147 Example: >
7148 :echo remote_read(id)
7149
7150< Can also be used as a |method|: >
7151 ServerId()->remote_read()
7152<
7153 *remote_send()* *E241*
7154remote_send({server}, {string} [, {idvar}])
Bram Moolenaar944697a2022-02-20 19:48:20 +00007155 Send the {string} to {server}. The {server} argument is a
7156 string, also see |{server}|.
7157
7158 The string is sent as input keys and the function returns
7159 immediately. At the Vim server the keys are not mapped
7160 |:map|.
7161
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007162 If {idvar} is present, it is taken as the name of a variable
7163 and a {serverid} for later use with remote_read() is stored
7164 there.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007165
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007166 See also |clientserver| |RemoteReply|.
7167 This function is not available in the |sandbox|.
7168 {only available when compiled with the |+clientserver| feature}
7169
7170 Note: Any errors will be reported in the server and may mess
7171 up the display.
7172 Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007173 :echo remote_send("gvim", ":DropAndReply " .. file, "serverid") ..
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007174 \ remote_read(serverid)
7175
7176 :autocmd NONE RemoteReply *
7177 \ echo remote_read(expand("<amatch>"))
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007178 :echo remote_send("gvim", ":sleep 10 | echo " ..
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007179 \ 'server2client(expand("<client>"), "HELLO")<CR>')
7180<
7181 Can also be used as a |method|: >
7182 ServerName()->remote_send(keys)
7183<
7184 *remote_startserver()* *E941* *E942*
7185remote_startserver({name})
7186 Become the server {name}. This fails if already running as a
7187 server, when |v:servername| is not empty.
7188
7189 Can also be used as a |method|: >
7190 ServerName()->remote_startserver()
7191
7192< {only available when compiled with the |+clientserver| feature}
7193
7194remove({list}, {idx} [, {end}]) *remove()*
7195 Without {end}: Remove the item at {idx} from |List| {list} and
7196 return the item.
7197 With {end}: Remove items from {idx} to {end} (inclusive) and
7198 return a |List| with these items. When {idx} points to the same
7199 item as {end} a list with one item is returned. When {end}
7200 points to an item before {idx} this is an error.
7201 See |list-index| for possible values of {idx} and {end}.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007202 Returns zero on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007203 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007204 :echo "last item: " .. remove(mylist, -1)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007205 :call remove(mylist, 0, 9)
7206<
7207 Use |delete()| to remove a file.
7208
7209 Can also be used as a |method|: >
7210 mylist->remove(idx)
7211
7212remove({blob}, {idx} [, {end}])
7213 Without {end}: Remove the byte at {idx} from |Blob| {blob} and
7214 return the byte.
7215 With {end}: Remove bytes from {idx} to {end} (inclusive) and
7216 return a |Blob| with these bytes. When {idx} points to the same
7217 byte as {end} a |Blob| with one byte is returned. When {end}
7218 points to a byte before {idx} this is an error.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007219 Returns zero on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007220 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007221 :echo "last byte: " .. remove(myblob, -1)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007222 :call remove(mylist, 0, 9)
7223
7224remove({dict}, {key})
7225 Remove the entry from {dict} with key {key} and return it.
7226 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007227 :echo "removed " .. remove(dict, "one")
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007228< If there is no {key} in {dict} this is an error.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007229 Returns zero on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007230
7231rename({from}, {to}) *rename()*
7232 Rename the file by the name {from} to the name {to}. This
7233 should also work to move files across file systems. The
7234 result is a Number, which is 0 if the file was renamed
7235 successfully, and non-zero when the renaming failed.
7236 NOTE: If {to} exists it is overwritten without warning.
7237 This function is not available in the |sandbox|.
7238
7239 Can also be used as a |method|: >
7240 GetOldName()->rename(newname)
7241
7242repeat({expr}, {count}) *repeat()*
7243 Repeat {expr} {count} times and return the concatenated
7244 result. Example: >
7245 :let separator = repeat('-', 80)
7246< When {count} is zero or negative the result is empty.
7247 When {expr} is a |List| the result is {expr} concatenated
7248 {count} times. Example: >
7249 :let longlist = repeat(['a', 'b'], 3)
7250< Results in ['a', 'b', 'a', 'b', 'a', 'b'].
7251
7252 Can also be used as a |method|: >
7253 mylist->repeat(count)
7254
7255resolve({filename}) *resolve()* *E655*
7256 On MS-Windows, when {filename} is a shortcut (a .lnk file),
7257 returns the path the shortcut points to in a simplified form.
7258 When {filename} is a symbolic link or junction point, return
7259 the full path to the target. If the target of junction is
7260 removed, return {filename}.
7261 On Unix, repeat resolving symbolic links in all path
7262 components of {filename} and return the simplified result.
7263 To cope with link cycles, resolving of symbolic links is
7264 stopped after 100 iterations.
7265 On other systems, return the simplified {filename}.
7266 The simplification step is done as by |simplify()|.
7267 resolve() keeps a leading path component specifying the
7268 current directory (provided the result is still a relative
7269 path name) and also keeps a trailing path separator.
7270
7271 Can also be used as a |method|: >
7272 GetName()->resolve()
7273
7274reverse({object}) *reverse()*
7275 Reverse the order of items in {object} in-place.
7276 {object} can be a |List| or a |Blob|.
7277 Returns {object}.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007278 Returns zero if {object} is not a List or a Blob.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007279 If you want an object to remain unmodified make a copy first: >
7280 :let revlist = reverse(copy(mylist))
7281< Can also be used as a |method|: >
7282 mylist->reverse()
7283
7284round({expr}) *round()*
7285 Round off {expr} to the nearest integral value and return it
7286 as a |Float|. If {expr} lies halfway between two integral
7287 values, then use the larger one (away from zero).
7288 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007289 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007290 Examples: >
7291 echo round(0.456)
7292< 0.0 >
7293 echo round(4.5)
7294< 5.0 >
7295 echo round(-4.5)
7296< -5.0
7297
7298 Can also be used as a |method|: >
7299 Compute()->round()
7300<
7301 {only available when compiled with the |+float| feature}
7302
7303rubyeval({expr}) *rubyeval()*
7304 Evaluate Ruby expression {expr} and return its result
7305 converted to Vim data structures.
7306 Numbers, floats and strings are returned as they are (strings
7307 are copied though).
7308 Arrays are represented as Vim |List| type.
7309 Hashes are represented as Vim |Dictionary| type.
7310 Other objects are represented as strings resulted from their
7311 "Object#to_s" method.
7312 Note that in a `:def` function local variables are not visible
7313 to {expr}.
7314
7315 Can also be used as a |method|: >
7316 GetRubyExpr()->rubyeval()
7317
7318< {only available when compiled with the |+ruby| feature}
7319
7320screenattr({row}, {col}) *screenattr()*
7321 Like |screenchar()|, but return the attribute. This is a rather
7322 arbitrary number that can only be used to compare to the
7323 attribute at other positions.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007324 Returns -1 when row or col is out of range.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007325
7326 Can also be used as a |method|: >
7327 GetRow()->screenattr(col)
7328
7329screenchar({row}, {col}) *screenchar()*
7330 The result is a Number, which is the character at position
7331 [row, col] on the screen. This works for every possible
7332 screen position, also status lines, window separators and the
7333 command line. The top left position is row one, column one
7334 The character excludes composing characters. For double-byte
7335 encodings it may only be the first byte.
7336 This is mainly to be used for testing.
7337 Returns -1 when row or col is out of range.
7338
7339 Can also be used as a |method|: >
7340 GetRow()->screenchar(col)
7341
7342screenchars({row}, {col}) *screenchars()*
7343 The result is a |List| of Numbers. The first number is the same
7344 as what |screenchar()| returns. Further numbers are
7345 composing characters on top of the base character.
7346 This is mainly to be used for testing.
7347 Returns an empty List when row or col is out of range.
7348
7349 Can also be used as a |method|: >
7350 GetRow()->screenchars(col)
7351
7352screencol() *screencol()*
7353 The result is a Number, which is the current screen column of
7354 the cursor. The leftmost column has number 1.
7355 This function is mainly used for testing.
7356
7357 Note: Always returns the current screen column, thus if used
7358 in a command (e.g. ":echo screencol()") it will return the
7359 column inside the command line, which is 1 when the command is
7360 executed. To get the cursor position in the file use one of
7361 the following mappings: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007362 nnoremap <expr> GG ":echom " .. screencol() .. "\n"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007363 nnoremap <silent> GG :echom screencol()<CR>
7364 nnoremap GG <Cmd>echom screencol()<CR>
7365<
7366screenpos({winid}, {lnum}, {col}) *screenpos()*
7367 The result is a Dict with the screen position of the text
7368 character in window {winid} at buffer line {lnum} and column
7369 {col}. {col} is a one-based byte index.
7370 The Dict has these members:
7371 row screen row
7372 col first screen column
7373 endcol last screen column
7374 curscol cursor screen column
7375 If the specified position is not visible, all values are zero.
7376 The "endcol" value differs from "col" when the character
7377 occupies more than one screen cell. E.g. for a Tab "col" can
7378 be 1 and "endcol" can be 8.
7379 The "curscol" value is where the cursor would be placed. For
7380 a Tab it would be the same as "endcol", while for a double
7381 width character it would be the same as "col".
7382 The |conceal| feature is ignored here, the column numbers are
7383 as if 'conceallevel' is zero. You can set the cursor to the
7384 right position and use |screencol()| to get the value with
7385 |conceal| taken into account.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007386 If the position is in a closed fold the screen position of the
7387 first character is returned, {col} is not used.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007388 Returns an empty Dict if {winid} is invalid.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007389
7390 Can also be used as a |method|: >
7391 GetWinid()->screenpos(lnum, col)
7392
7393screenrow() *screenrow()*
7394 The result is a Number, which is the current screen row of the
7395 cursor. The top line has number one.
7396 This function is mainly used for testing.
7397 Alternatively you can use |winline()|.
7398
7399 Note: Same restrictions as with |screencol()|.
7400
7401screenstring({row}, {col}) *screenstring()*
7402 The result is a String that contains the base character and
7403 any composing characters at position [row, col] on the screen.
7404 This is like |screenchars()| but returning a String with the
7405 characters.
7406 This is mainly to be used for testing.
7407 Returns an empty String when row or col is out of range.
7408
7409 Can also be used as a |method|: >
7410 GetRow()->screenstring(col)
7411<
7412 *search()*
7413search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
7414 Search for regexp pattern {pattern}. The search starts at the
7415 cursor position (you can use |cursor()| to set it).
7416
7417 When a match has been found its line number is returned.
7418 If there is no match a 0 is returned and the cursor doesn't
7419 move. No error message is given.
7420
7421 {flags} is a String, which can contain these character flags:
7422 'b' search Backward instead of forward
7423 'c' accept a match at the Cursor position
7424 'e' move to the End of the match
7425 'n' do Not move the cursor
7426 'p' return number of matching sub-Pattern (see below)
7427 's' Set the ' mark at the previous location of the cursor
7428 'w' Wrap around the end of the file
7429 'W' don't Wrap around the end of the file
7430 'z' start searching at the cursor column instead of zero
7431 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
7432
7433 If the 's' flag is supplied, the ' mark is set, only if the
7434 cursor is moved. The 's' flag cannot be combined with the 'n'
7435 flag.
7436
7437 'ignorecase', 'smartcase' and 'magic' are used.
7438
7439 When the 'z' flag is not given, forward searching always
7440 starts in column zero and then matches before the cursor are
7441 skipped. When the 'c' flag is present in 'cpo' the next
7442 search starts after the match. Without the 'c' flag the next
7443 search starts one column further. This matters for
7444 overlapping matches.
7445 When searching backwards and the 'z' flag is given then the
7446 search starts in column zero, thus no match in the current
7447 line will be found (unless wrapping around the end of the
7448 file).
7449
7450 When the {stopline} argument is given then the search stops
7451 after searching this line. This is useful to restrict the
7452 search to a range of lines. Examples: >
7453 let match = search('(', 'b', line("w0"))
7454 let end = search('END', '', line("w$"))
7455< When {stopline} is used and it is not zero this also implies
7456 that the search does not wrap around the end of the file.
7457 A zero value is equal to not giving the argument.
Bram Moolenaar2ecbe532022-07-29 21:36:21 +01007458 *E1285* *E1286* *E1287* *E1288* *E1289*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007459 When the {timeout} argument is given the search stops when
7460 more than this many milliseconds have passed. Thus when
7461 {timeout} is 500 the search stops after half a second.
7462 The value must not be negative. A zero value is like not
7463 giving the argument.
7464 {only available when compiled with the |+reltime| feature}
7465
7466 If the {skip} expression is given it is evaluated with the
7467 cursor positioned on the start of a match. If it evaluates to
7468 non-zero this match is skipped. This can be used, for
7469 example, to skip a match in a comment or a string.
7470 {skip} can be a string, which is evaluated as an expression, a
7471 function reference or a lambda.
7472 When {skip} is omitted or empty, every match is accepted.
7473 When evaluating {skip} causes an error the search is aborted
7474 and -1 returned.
7475 *search()-sub-match*
7476 With the 'p' flag the returned value is one more than the
7477 first sub-match in \(\). One if none of them matched but the
7478 whole pattern did match.
7479 To get the column number too use |searchpos()|.
7480
7481 The cursor will be positioned at the match, unless the 'n'
7482 flag is used.
7483
7484 Example (goes over all files in the argument list): >
7485 :let n = 1
7486 :while n <= argc() " loop over all files in arglist
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007487 : exe "argument " .. n
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007488 : " start at the last char in the file and wrap for the
7489 : " first search to find match at start of file
7490 : normal G$
7491 : let flags = "w"
7492 : while search("foo", flags) > 0
7493 : s/foo/bar/g
7494 : let flags = "W"
7495 : endwhile
7496 : update " write the file if modified
7497 : let n = n + 1
7498 :endwhile
7499<
7500 Example for using some flags: >
7501 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
7502< This will search for the keywords "if", "else", and "endif"
7503 under or after the cursor. Because of the 'p' flag, it
7504 returns 1, 2, or 3 depending on which keyword is found, or 0
7505 if the search fails. With the cursor on the first word of the
7506 line:
7507 if (foo == 0) | let foo = foo + 1 | endif ~
7508 the function returns 1. Without the 'c' flag, the function
7509 finds the "endif" and returns 3. The same thing happens
7510 without the 'e' flag if the cursor is on the "f" of "if".
7511 The 'n' flag tells the function not to move the cursor.
7512
7513 Can also be used as a |method|: >
7514 GetPattern()->search()
7515
7516searchcount([{options}]) *searchcount()*
7517 Get or update the last search count, like what is displayed
7518 without the "S" flag in 'shortmess'. This works even if
7519 'shortmess' does contain the "S" flag.
7520
7521 This returns a |Dictionary|. The dictionary is empty if the
7522 previous pattern was not set and "pattern" was not specified.
7523
7524 key type meaning ~
7525 current |Number| current position of match;
7526 0 if the cursor position is
7527 before the first match
7528 exact_match |Boolean| 1 if "current" is matched on
7529 "pos", otherwise 0
7530 total |Number| total count of matches found
7531 incomplete |Number| 0: search was fully completed
7532 1: recomputing was timed out
7533 2: max count exceeded
7534
7535 For {options} see further down.
7536
7537 To get the last search count when |n| or |N| was pressed, call
7538 this function with `recompute: 0` . This sometimes returns
7539 wrong information because |n| and |N|'s maximum count is 99.
7540 If it exceeded 99 the result must be max count + 1 (100). If
7541 you want to get correct information, specify `recompute: 1`: >
7542
7543 " result == maxcount + 1 (100) when many matches
7544 let result = searchcount(#{recompute: 0})
7545
7546 " Below returns correct result (recompute defaults
7547 " to 1)
7548 let result = searchcount()
7549<
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01007550 The function is useful to add the count to 'statusline': >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007551 function! LastSearchCount() abort
7552 let result = searchcount(#{recompute: 0})
7553 if empty(result)
7554 return ''
7555 endif
7556 if result.incomplete ==# 1 " timed out
7557 return printf(' /%s [?/??]', @/)
7558 elseif result.incomplete ==# 2 " max count exceeded
7559 if result.total > result.maxcount &&
7560 \ result.current > result.maxcount
7561 return printf(' /%s [>%d/>%d]', @/,
7562 \ result.current, result.total)
7563 elseif result.total > result.maxcount
7564 return printf(' /%s [%d/>%d]', @/,
7565 \ result.current, result.total)
7566 endif
7567 endif
7568 return printf(' /%s [%d/%d]', @/,
7569 \ result.current, result.total)
7570 endfunction
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007571 let &statusline ..= '%{LastSearchCount()}'
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007572
7573 " Or if you want to show the count only when
7574 " 'hlsearch' was on
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007575 " let &statusline ..=
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007576 " \ '%{v:hlsearch ? LastSearchCount() : ""}'
7577<
7578 You can also update the search count, which can be useful in a
7579 |CursorMoved| or |CursorMovedI| autocommand: >
7580
7581 autocmd CursorMoved,CursorMovedI *
7582 \ let s:searchcount_timer = timer_start(
7583 \ 200, function('s:update_searchcount'))
7584 function! s:update_searchcount(timer) abort
7585 if a:timer ==# s:searchcount_timer
7586 call searchcount(#{
7587 \ recompute: 1, maxcount: 0, timeout: 100})
7588 redrawstatus
7589 endif
7590 endfunction
7591<
7592 This can also be used to count matched texts with specified
7593 pattern in the current buffer using "pattern": >
7594
7595 " Count '\<foo\>' in this buffer
7596 " (Note that it also updates search count)
7597 let result = searchcount(#{pattern: '\<foo\>'})
7598
7599 " To restore old search count by old pattern,
7600 " search again
7601 call searchcount()
7602<
7603 {options} must be a |Dictionary|. It can contain:
7604 key type meaning ~
7605 recompute |Boolean| if |TRUE|, recompute the count
7606 like |n| or |N| was executed.
7607 otherwise returns the last
7608 computed result (when |n| or
7609 |N| was used when "S" is not
7610 in 'shortmess', or this
7611 function was called).
7612 (default: |TRUE|)
7613 pattern |String| recompute if this was given
7614 and different with |@/|.
7615 this works as same as the
7616 below command is executed
7617 before calling this function >
7618 let @/ = pattern
7619< (default: |@/|)
7620 timeout |Number| 0 or negative number is no
7621 timeout. timeout milliseconds
7622 for recomputing the result
7623 (default: 0)
7624 maxcount |Number| 0 or negative number is no
7625 limit. max count of matched
7626 text while recomputing the
7627 result. if search exceeded
7628 total count, "total" value
7629 becomes `maxcount + 1`
7630 (default: 99)
7631 pos |List| `[lnum, col, off]` value
7632 when recomputing the result.
7633 this changes "current" result
7634 value. see |cursor()|,
7635 |getpos()|
7636 (default: cursor's position)
7637
7638 Can also be used as a |method|: >
7639 GetSearchOpts()->searchcount()
7640<
7641searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
7642 Search for the declaration of {name}.
7643
7644 With a non-zero {global} argument it works like |gD|, find
7645 first match in the file. Otherwise it works like |gd|, find
7646 first match in the function.
7647
7648 With a non-zero {thisblock} argument matches in a {} block
7649 that ends before the cursor position are ignored. Avoids
7650 finding variable declarations only valid in another scope.
7651
7652 Moves the cursor to the found match.
7653 Returns zero for success, non-zero for failure.
7654 Example: >
7655 if searchdecl('myvar') == 0
7656 echo getline('.')
7657 endif
7658<
7659 Can also be used as a |method|: >
7660 GetName()->searchdecl()
7661<
7662 *searchpair()*
7663searchpair({start}, {middle}, {end} [, {flags} [, {skip}
7664 [, {stopline} [, {timeout}]]]])
7665 Search for the match of a nested start-end pair. This can be
7666 used to find the "endif" that matches an "if", while other
7667 if/endif pairs in between are ignored.
7668 The search starts at the cursor. The default is to search
7669 forward, include 'b' in {flags} to search backward.
7670 If a match is found, the cursor is positioned at it and the
7671 line number is returned. If no match is found 0 or -1 is
7672 returned and the cursor doesn't move. No error message is
7673 given.
7674
7675 {start}, {middle} and {end} are patterns, see |pattern|. They
7676 must not contain \( \) pairs. Use of \%( \) is allowed. When
7677 {middle} is not empty, it is found when searching from either
7678 direction, but only when not in a nested start-end pair. A
7679 typical use is: >
7680 searchpair('\<if\>', '\<else\>', '\<endif\>')
7681< By leaving {middle} empty the "else" is skipped.
7682
7683 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
7684 |search()|. Additionally:
7685 'r' Repeat until no more matches found; will find the
7686 outer pair. Implies the 'W' flag.
7687 'm' Return number of matches instead of line number with
7688 the match; will be > 1 when 'r' is used.
7689 Note: it's nearly always a good idea to use the 'W' flag, to
7690 avoid wrapping around the end of the file.
7691
7692 When a match for {start}, {middle} or {end} is found, the
7693 {skip} expression is evaluated with the cursor positioned on
7694 the start of the match. It should return non-zero if this
7695 match is to be skipped. E.g., because it is inside a comment
7696 or a string.
7697 When {skip} is omitted or empty, every match is accepted.
7698 When evaluating {skip} causes an error the search is aborted
7699 and -1 returned.
7700 {skip} can be a string, a lambda, a funcref or a partial.
7701 Anything else makes the function fail.
7702 In a `:def` function when the {skip} argument is a string
7703 constant it is compiled into instructions.
7704
7705 For {stopline} and {timeout} see |search()|.
7706
7707 The value of 'ignorecase' is used. 'magic' is ignored, the
7708 patterns are used like it's on.
7709
7710 The search starts exactly at the cursor. A match with
7711 {start}, {middle} or {end} at the next character, in the
7712 direction of searching, is the first one found. Example: >
7713 if 1
7714 if 2
7715 endif 2
7716 endif 1
7717< When starting at the "if 2", with the cursor on the "i", and
7718 searching forwards, the "endif 2" is found. When starting on
7719 the character just before the "if 2", the "endif 1" will be
7720 found. That's because the "if 2" will be found first, and
7721 then this is considered to be a nested if/endif from "if 2" to
7722 "endif 2".
7723 When searching backwards and {end} is more than one character,
7724 it may be useful to put "\zs" at the end of the pattern, so
7725 that when the cursor is inside a match with the end it finds
7726 the matching start.
7727
7728 Example, to find the "endif" command in a Vim script: >
7729
7730 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
7731 \ 'getline(".") =~ "^\\s*\""')
7732
7733< The cursor must be at or after the "if" for which a match is
7734 to be found. Note that single-quote strings are used to avoid
7735 having to double the backslashes. The skip expression only
7736 catches comments at the start of a line, not after a command.
7737 Also, a word "en" or "if" halfway a line is considered a
7738 match.
7739 Another example, to search for the matching "{" of a "}": >
7740
7741 :echo searchpair('{', '', '}', 'bW')
7742
7743< This works when the cursor is at or before the "}" for which a
7744 match is to be found. To reject matches that syntax
7745 highlighting recognized as strings: >
7746
7747 :echo searchpair('{', '', '}', 'bW',
7748 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
7749<
7750 *searchpairpos()*
7751searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
7752 [, {stopline} [, {timeout}]]]])
7753 Same as |searchpair()|, but returns a |List| with the line and
7754 column position of the match. The first element of the |List|
7755 is the line number and the second element is the byte index of
7756 the column position of the match. If no match is found,
7757 returns [0, 0]. >
7758
7759 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
7760<
7761 See |match-parens| for a bigger and more useful example.
7762
7763 *searchpos()*
7764searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
7765 Same as |search()|, but returns a |List| with the line and
7766 column position of the match. The first element of the |List|
7767 is the line number and the second element is the byte index of
7768 the column position of the match. If no match is found,
7769 returns [0, 0].
7770 Example: >
7771 :let [lnum, col] = searchpos('mypattern', 'n')
7772
7773< When the 'p' flag is given then there is an extra item with
7774 the sub-pattern match number |search()-sub-match|. Example: >
7775 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
7776< In this example "submatch" is 2 when a lowercase letter is
7777 found |/\l|, 3 when an uppercase letter is found |/\u|.
7778
7779 Can also be used as a |method|: >
7780 GetPattern()->searchpos()
7781
7782server2client({clientid}, {string}) *server2client()*
7783 Send a reply string to {clientid}. The most recent {clientid}
7784 that sent a string can be retrieved with expand("<client>").
7785 {only available when compiled with the |+clientserver| feature}
7786 Returns zero for success, -1 for failure.
7787 Note:
7788 This id has to be stored before the next command can be
7789 received. I.e. before returning from the received command and
7790 before calling any commands that waits for input.
7791 See also |clientserver|.
7792 Example: >
7793 :echo server2client(expand("<client>"), "HELLO")
7794
7795< Can also be used as a |method|: >
7796 GetClientId()->server2client(string)
7797<
7798serverlist() *serverlist()*
7799 Return a list of available server names, one per line.
7800 When there are no servers or the information is not available
7801 an empty string is returned. See also |clientserver|.
7802 {only available when compiled with the |+clientserver| feature}
7803 Example: >
7804 :echo serverlist()
7805<
7806setbufline({buf}, {lnum}, {text}) *setbufline()*
7807 Set line {lnum} to {text} in buffer {buf}. This works like
7808 |setline()| for the specified buffer.
7809
7810 This function works only for loaded buffers. First call
7811 |bufload()| if needed.
7812
7813 To insert lines use |appendbufline()|.
7814 Any text properties in {lnum} are cleared.
7815
7816 {text} can be a string to set one line, or a list of strings
7817 to set multiple lines. If the list extends below the last
7818 line then those lines are added.
7819
7820 For the use of {buf}, see |bufname()| above.
7821
7822 {lnum} is used like with |setline()|.
7823 Use "$" to refer to the last line in buffer {buf}.
7824 When {lnum} is just below the last line the {text} will be
7825 added below the last line.
7826
7827 When {buf} is not a valid buffer, the buffer is not loaded or
7828 {lnum} is not valid then 1 is returned. In |Vim9| script an
7829 error is given.
7830 On success 0 is returned.
7831
7832 Can also be used as a |method|, the base is passed as the
7833 third argument: >
7834 GetText()->setbufline(buf, lnum)
7835
7836setbufvar({buf}, {varname}, {val}) *setbufvar()*
7837 Set option or local variable {varname} in buffer {buf} to
7838 {val}.
7839 This also works for a global or local window option, but it
7840 doesn't work for a global or local window variable.
7841 For a local window option the global value is unchanged.
7842 For the use of {buf}, see |bufname()| above.
7843 The {varname} argument is a string.
7844 Note that the variable name without "b:" must be used.
7845 Examples: >
7846 :call setbufvar(1, "&mod", 1)
7847 :call setbufvar("todo", "myvar", "foobar")
7848< This function is not available in the |sandbox|.
7849
7850 Can also be used as a |method|, the base is passed as the
7851 third argument: >
7852 GetValue()->setbufvar(buf, varname)
7853
7854
7855setcellwidths({list}) *setcellwidths()*
7856 Specify overrides for cell widths of character ranges. This
7857 tells Vim how wide characters are, counted in screen cells.
7858 This overrides 'ambiwidth'. Example: >
7859 setcellwidths([[0xad, 0xad, 1],
7860 \ [0x2194, 0x2199, 2]])
7861
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007862< *E1109* *E1110* *E1111* *E1112* *E1113* *E1114*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007863 The {list} argument is a list of lists with each three
7864 numbers. These three numbers are [low, high, width]. "low"
7865 and "high" can be the same, in which case this refers to one
7866 character. Otherwise it is the range of characters from "low"
7867 to "high" (inclusive). "width" is either 1 or 2, indicating
7868 the character width in screen cells.
7869 An error is given if the argument is invalid, also when a
7870 range overlaps with another.
7871 Only characters with value 0x100 and higher can be used.
7872
7873 If the new value causes 'fillchars' or 'listchars' to become
7874 invalid it is rejected and an error is given.
7875
7876 To clear the overrides pass an empty list: >
7877 setcellwidths([]);
7878< You can use the script $VIMRUNTIME/tools/emoji_list.vim to see
7879 the effect for known emoji characters.
7880
7881setcharpos({expr}, {list}) *setcharpos()*
7882 Same as |setpos()| but uses the specified column number as the
7883 character index instead of the byte index in the line.
7884
7885 Example:
7886 With the text "여보세요" in line 8: >
7887 call setcharpos('.', [0, 8, 4, 0])
7888< positions the cursor on the fourth character '요'. >
7889 call setpos('.', [0, 8, 4, 0])
7890< positions the cursor on the second character '보'.
7891
7892 Can also be used as a |method|: >
7893 GetPosition()->setcharpos('.')
7894
7895setcharsearch({dict}) *setcharsearch()*
7896 Set the current character search information to {dict},
7897 which contains one or more of the following entries:
7898
7899 char character which will be used for a subsequent
7900 |,| or |;| command; an empty string clears the
7901 character search
7902 forward direction of character search; 1 for forward,
7903 0 for backward
7904 until type of character search; 1 for a |t| or |T|
7905 character search, 0 for an |f| or |F|
7906 character search
7907
7908 This can be useful to save/restore a user's character search
7909 from a script: >
7910 :let prevsearch = getcharsearch()
7911 :" Perform a command which clobbers user's search
7912 :call setcharsearch(prevsearch)
7913< Also see |getcharsearch()|.
7914
7915 Can also be used as a |method|: >
7916 SavedSearch()->setcharsearch()
7917
7918setcmdpos({pos}) *setcmdpos()*
7919 Set the cursor position in the command line to byte position
7920 {pos}. The first position is 1.
7921 Use |getcmdpos()| to obtain the current position.
7922 Only works while editing the command line, thus you must use
7923 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
7924 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
7925 set after the command line is set to the expression. For
7926 |c_CTRL-R_=| it is set after evaluating the expression but
7927 before inserting the resulting text.
7928 When the number is too big the cursor is put at the end of the
7929 line. A number smaller than one has undefined results.
7930 Returns FALSE when successful, TRUE when not editing the
7931 command line.
7932
7933 Can also be used as a |method|: >
7934 GetPos()->setcmdpos()
7935
7936setcursorcharpos({lnum}, {col} [, {off}]) *setcursorcharpos()*
7937setcursorcharpos({list})
7938 Same as |cursor()| but uses the specified column number as the
7939 character index instead of the byte index in the line.
7940
7941 Example:
7942 With the text "여보세요" in line 4: >
7943 call setcursorcharpos(4, 3)
7944< positions the cursor on the third character '세'. >
7945 call cursor(4, 3)
7946< positions the cursor on the first character '여'.
7947
7948 Can also be used as a |method|: >
7949 GetCursorPos()->setcursorcharpos()
7950
7951
7952setenv({name}, {val}) *setenv()*
7953 Set environment variable {name} to {val}. Example: >
7954 call setenv('HOME', '/home/myhome')
7955
7956< When {val} is |v:null| the environment variable is deleted.
7957 See also |expr-env|.
7958
7959 Can also be used as a |method|, the base is passed as the
7960 second argument: >
7961 GetPath()->setenv('PATH')
7962
7963setfperm({fname}, {mode}) *setfperm()* *chmod*
7964 Set the file permissions for {fname} to {mode}.
7965 {mode} must be a string with 9 characters. It is of the form
7966 "rwxrwxrwx", where each group of "rwx" flags represent, in
7967 turn, the permissions of the owner of the file, the group the
7968 file belongs to, and other users. A '-' character means the
7969 permission is off, any other character means on. Multi-byte
7970 characters are not supported.
7971
7972 For example "rw-r-----" means read-write for the user,
7973 readable by the group, not accessible by others. "xx-x-----"
7974 would do the same thing.
7975
7976 Returns non-zero for success, zero for failure.
7977
7978 Can also be used as a |method|: >
7979 GetFilename()->setfperm(mode)
7980<
7981 To read permissions see |getfperm()|.
7982
7983
7984setline({lnum}, {text}) *setline()*
7985 Set line {lnum} of the current buffer to {text}. To insert
7986 lines use |append()|. To set lines in another buffer use
7987 |setbufline()|. Any text properties in {lnum} are cleared.
7988
7989 {lnum} is used like with |getline()|.
7990 When {lnum} is just below the last line the {text} will be
7991 added below the last line.
7992 {text} can be any type or a List of any type, each item is
7993 converted to a String.
7994
7995 If this succeeds, FALSE is returned. If this fails (most likely
7996 because {lnum} is invalid) TRUE is returned.
7997 In |Vim9| script an error is given if {lnum} is invalid.
7998
7999 Example: >
8000 :call setline(5, strftime("%c"))
8001
8002< When {text} is a |List| then line {lnum} and following lines
8003 will be set to the items in the list. Example: >
8004 :call setline(5, ['aaa', 'bbb', 'ccc'])
8005< This is equivalent to: >
8006 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
8007 : call setline(n, l)
8008 :endfor
8009
8010< Note: The '[ and '] marks are not set.
8011
8012 Can also be used as a |method|, the base is passed as the
8013 second argument: >
8014 GetText()->setline(lnum)
8015
8016setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()*
8017 Create or replace or add to the location list for window {nr}.
8018 {nr} can be the window number or the |window-ID|.
8019 When {nr} is zero the current window is used.
8020
8021 For a location list window, the displayed location list is
8022 modified. For an invalid window number {nr}, -1 is returned.
8023 Otherwise, same as |setqflist()|.
8024 Also see |location-list|.
8025
8026 For {action} see |setqflist-action|.
8027
8028 If the optional {what} dictionary argument is supplied, then
8029 only the items listed in {what} are set. Refer to |setqflist()|
8030 for the list of supported keys in {what}.
8031
8032 Can also be used as a |method|, the base is passed as the
8033 second argument: >
8034 GetLoclist()->setloclist(winnr)
8035
8036setmatches({list} [, {win}]) *setmatches()*
8037 Restores a list of matches saved by |getmatches()| for the
8038 current window. Returns 0 if successful, otherwise -1. All
8039 current matches are cleared before the list is restored. See
8040 example for |getmatches()|.
8041 If {win} is specified, use the window with this number or
8042 window ID instead of the current window.
8043
8044 Can also be used as a |method|: >
8045 GetMatches()->setmatches()
8046<
8047 *setpos()*
8048setpos({expr}, {list})
8049 Set the position for String {expr}. Possible values:
8050 . the cursor
8051 'x mark x
8052
8053 {list} must be a |List| with four or five numbers:
8054 [bufnum, lnum, col, off]
8055 [bufnum, lnum, col, off, curswant]
8056
8057 "bufnum" is the buffer number. Zero can be used for the
8058 current buffer. When setting an uppercase mark "bufnum" is
8059 used for the mark position. For other marks it specifies the
8060 buffer to set the mark in. You can use the |bufnr()| function
8061 to turn a file name into a buffer number.
8062 For setting the cursor and the ' mark "bufnum" is ignored,
8063 since these are associated with a window, not a buffer.
8064 Does not change the jumplist.
8065
8066 "lnum" and "col" are the position in the buffer. The first
8067 column is 1. Use a zero "lnum" to delete a mark. If "col" is
8068 smaller than 1 then 1 is used. To use the character count
8069 instead of the byte count, use |setcharpos()|.
8070
8071 The "off" number is only used when 'virtualedit' is set. Then
8072 it is the offset in screen columns from the start of the
8073 character. E.g., a position within a <Tab> or after the last
8074 character.
8075
8076 The "curswant" number is only used when setting the cursor
8077 position. It sets the preferred column for when moving the
8078 cursor vertically. When the "curswant" number is missing the
8079 preferred column is not set. When it is present and setting a
8080 mark position it is not used.
8081
8082 Note that for '< and '> changing the line number may result in
8083 the marks to be effectively be swapped, so that '< is always
8084 before '>.
8085
8086 Returns 0 when the position could be set, -1 otherwise.
8087 An error message is given if {expr} is invalid.
8088
8089 Also see |setcharpos()|, |getpos()| and |getcurpos()|.
8090
8091 This does not restore the preferred column for moving
8092 vertically; if you set the cursor position with this, |j| and
8093 |k| motions will jump to previous columns! Use |cursor()| to
8094 also set the preferred column. Also see the "curswant" key in
8095 |winrestview()|.
8096
8097 Can also be used as a |method|: >
8098 GetPosition()->setpos('.')
8099
8100setqflist({list} [, {action} [, {what}]]) *setqflist()*
8101 Create or replace or add to the quickfix list.
8102
8103 If the optional {what} dictionary argument is supplied, then
8104 only the items listed in {what} are set. The first {list}
8105 argument is ignored. See below for the supported items in
8106 {what}.
8107 *setqflist-what*
8108 When {what} is not present, the items in {list} are used. Each
8109 item must be a dictionary. Non-dictionary items in {list} are
8110 ignored. Each dictionary item can contain the following
8111 entries:
8112
8113 bufnr buffer number; must be the number of a valid
8114 buffer
8115 filename name of a file; only used when "bufnr" is not
8116 present or it is invalid.
8117 module name of a module; if given it will be used in
8118 quickfix error window instead of the filename.
8119 lnum line number in the file
Bram Moolenaara2baa732022-02-04 16:09:54 +00008120 end_lnum end of lines, if the item spans multiple lines
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008121 pattern search pattern used to locate the error
8122 col column number
8123 vcol when non-zero: "col" is visual column
8124 when zero: "col" is byte index
Bram Moolenaara2baa732022-02-04 16:09:54 +00008125 end_col end column, if the item spans multiple columns
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008126 nr error number
8127 text description of the error
8128 type single-character error type, 'E', 'W', etc.
8129 valid recognized error message
8130
8131 The "col", "vcol", "nr", "type" and "text" entries are
8132 optional. Either "lnum" or "pattern" entry can be used to
8133 locate a matching error line.
8134 If the "filename" and "bufnr" entries are not present or
8135 neither the "lnum" or "pattern" entries are present, then the
8136 item will not be handled as an error line.
8137 If both "pattern" and "lnum" are present then "pattern" will
8138 be used.
8139 If the "valid" entry is not supplied, then the valid flag is
8140 set when "bufnr" is a valid buffer or "filename" exists.
8141 If you supply an empty {list}, the quickfix list will be
8142 cleared.
8143 Note that the list is not exactly the same as what
8144 |getqflist()| returns.
8145
8146 {action} values: *setqflist-action* *E927*
8147 'a' The items from {list} are added to the existing
8148 quickfix list. If there is no existing list, then a
8149 new list is created.
8150
8151 'r' The items from the current quickfix list are replaced
8152 with the items from {list}. This can also be used to
8153 clear the list: >
8154 :call setqflist([], 'r')
8155<
8156 'f' All the quickfix lists in the quickfix stack are
8157 freed.
8158
8159 If {action} is not present or is set to ' ', then a new list
8160 is created. The new quickfix list is added after the current
8161 quickfix list in the stack and all the following lists are
8162 freed. To add a new quickfix list at the end of the stack,
8163 set "nr" in {what} to "$".
8164
8165 The following items can be specified in dictionary {what}:
8166 context quickfix list context. See |quickfix-context|
8167 efm errorformat to use when parsing text from
8168 "lines". If this is not present, then the
8169 'errorformat' option value is used.
8170 See |quickfix-parse|
8171 id quickfix list identifier |quickfix-ID|
8172 idx index of the current entry in the quickfix
8173 list specified by 'id' or 'nr'. If set to '$',
8174 then the last entry in the list is set as the
8175 current entry. See |quickfix-index|
8176 items list of quickfix entries. Same as the {list}
8177 argument.
8178 lines use 'errorformat' to parse a list of lines and
8179 add the resulting entries to the quickfix list
8180 {nr} or {id}. Only a |List| value is supported.
8181 See |quickfix-parse|
8182 nr list number in the quickfix stack; zero
8183 means the current quickfix list and "$" means
8184 the last quickfix list.
8185 quickfixtextfunc
8186 function to get the text to display in the
8187 quickfix window. The value can be the name of
8188 a function or a funcref or a lambda. Refer to
8189 |quickfix-window-function| for an explanation
8190 of how to write the function and an example.
8191 title quickfix list title text. See |quickfix-title|
8192 Unsupported keys in {what} are ignored.
8193 If the "nr" item is not present, then the current quickfix list
8194 is modified. When creating a new quickfix list, "nr" can be
8195 set to a value one greater than the quickfix stack size.
8196 When modifying a quickfix list, to guarantee that the correct
8197 list is modified, "id" should be used instead of "nr" to
8198 specify the list.
8199
8200 Examples (See also |setqflist-examples|): >
8201 :call setqflist([], 'r', {'title': 'My search'})
8202 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
8203 :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
8204<
8205 Returns zero for success, -1 for failure.
8206
8207 This function can be used to create a quickfix list
8208 independent of the 'errorformat' setting. Use a command like
8209 `:cc 1` to jump to the first position.
8210
8211 Can also be used as a |method|, the base is passed as the
8212 second argument: >
8213 GetErrorlist()->setqflist()
8214<
8215 *setreg()*
8216setreg({regname}, {value} [, {options}])
8217 Set the register {regname} to {value}.
8218 If {regname} is "" or "@", the unnamed register '"' is used.
8219 The {regname} argument is a string. In |Vim9-script|
8220 {regname} must be one character.
8221
8222 {value} may be any value returned by |getreg()| or
8223 |getreginfo()|, including a |List| or |Dict|.
8224 If {options} contains "a" or {regname} is upper case,
8225 then the value is appended.
8226
8227 {options} can also contain a register type specification:
8228 "c" or "v" |characterwise| mode
8229 "l" or "V" |linewise| mode
8230 "b" or "<CTRL-V>" |blockwise-visual| mode
8231 If a number immediately follows "b" or "<CTRL-V>" then this is
8232 used as the width of the selection - if it is not specified
8233 then the width of the block is set to the number of characters
8234 in the longest line (counting a <Tab> as 1 character).
8235
8236 If {options} contains no register settings, then the default
8237 is to use character mode unless {value} ends in a <NL> for
8238 string {value} and linewise mode for list {value}. Blockwise
8239 mode is never selected automatically.
8240 Returns zero for success, non-zero for failure.
8241
8242 *E883*
8243 Note: you may not use |List| containing more than one item to
8244 set search and expression registers. Lists containing no
8245 items act like empty strings.
8246
8247 Examples: >
8248 :call setreg(v:register, @*)
8249 :call setreg('*', @%, 'ac')
8250 :call setreg('a', "1\n2\n3", 'b5')
8251 :call setreg('"', { 'points_to': 'a'})
8252
8253< This example shows using the functions to save and restore a
8254 register: >
8255 :let var_a = getreginfo()
8256 :call setreg('a', var_a)
8257< or: >
8258 :let var_a = getreg('a', 1, 1)
8259 :let var_amode = getregtype('a')
8260 ....
8261 :call setreg('a', var_a, var_amode)
8262< Note: you may not reliably restore register value
8263 without using the third argument to |getreg()| as without it
8264 newlines are represented as newlines AND Nul bytes are
8265 represented as newlines as well, see |NL-used-for-Nul|.
8266
8267 You can also change the type of a register by appending
8268 nothing: >
8269 :call setreg('a', '', 'al')
8270
8271< Can also be used as a |method|, the base is passed as the
8272 second argument: >
8273 GetText()->setreg('a')
8274
8275settabvar({tabnr}, {varname}, {val}) *settabvar()*
8276 Set tab-local variable {varname} to {val} in tab page {tabnr}.
8277 |t:var|
8278 The {varname} argument is a string.
8279 Note that autocommands are blocked, side effects may not be
8280 triggered, e.g. when setting 'filetype'.
8281 Note that the variable name without "t:" must be used.
8282 Tabs are numbered starting with one.
8283 This function is not available in the |sandbox|.
8284
8285 Can also be used as a |method|, the base is passed as the
8286 third argument: >
8287 GetValue()->settabvar(tab, name)
8288
8289settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
8290 Set option or local variable {varname} in window {winnr} to
8291 {val}.
8292 Tabs are numbered starting with one. For the current tabpage
8293 use |setwinvar()|.
8294 {winnr} can be the window number or the |window-ID|.
8295 When {winnr} is zero the current window is used.
8296 Note that autocommands are blocked, side effects may not be
8297 triggered, e.g. when setting 'filetype' or 'syntax'.
8298 This also works for a global or local buffer option, but it
8299 doesn't work for a global or local buffer variable.
8300 For a local buffer option the global value is unchanged.
8301 Note that the variable name without "w:" must be used.
8302 Examples: >
8303 :call settabwinvar(1, 1, "&list", 0)
8304 :call settabwinvar(3, 2, "myvar", "foobar")
8305< This function is not available in the |sandbox|.
8306
8307 Can also be used as a |method|, the base is passed as the
8308 fourth argument: >
8309 GetValue()->settabwinvar(tab, winnr, name)
8310
8311settagstack({nr}, {dict} [, {action}]) *settagstack()*
8312 Modify the tag stack of the window {nr} using {dict}.
8313 {nr} can be the window number or the |window-ID|.
8314
8315 For a list of supported items in {dict}, refer to
8316 |gettagstack()|. "curidx" takes effect before changing the tag
8317 stack.
8318 *E962*
8319 How the tag stack is modified depends on the {action}
8320 argument:
8321 - If {action} is not present or is set to 'r', then the tag
8322 stack is replaced.
8323 - If {action} is set to 'a', then new entries from {dict} are
8324 pushed (added) onto the tag stack.
8325 - If {action} is set to 't', then all the entries from the
8326 current entry in the tag stack or "curidx" in {dict} are
8327 removed and then new entries are pushed to the stack.
8328
8329 The current index is set to one after the length of the tag
8330 stack after the modification.
8331
8332 Returns zero for success, -1 for failure.
8333
8334 Examples (for more examples see |tagstack-examples|):
8335 Empty the tag stack of window 3: >
8336 call settagstack(3, {'items' : []})
8337
8338< Save and restore the tag stack: >
8339 let stack = gettagstack(1003)
8340 " do something else
8341 call settagstack(1003, stack)
8342 unlet stack
8343<
8344 Can also be used as a |method|, the base is passed as the
8345 second argument: >
8346 GetStack()->settagstack(winnr)
8347
8348setwinvar({winnr}, {varname}, {val}) *setwinvar()*
8349 Like |settabwinvar()| for the current tab page.
8350 Examples: >
8351 :call setwinvar(1, "&list", 0)
8352 :call setwinvar(2, "myvar", "foobar")
8353
8354< Can also be used as a |method|, the base is passed as the
8355 third argument: >
8356 GetValue()->setwinvar(winnr, name)
8357
8358sha256({string}) *sha256()*
8359 Returns a String with 64 hex characters, which is the SHA256
8360 checksum of {string}.
8361
8362 Can also be used as a |method|: >
8363 GetText()->sha256()
8364
8365< {only available when compiled with the |+cryptv| feature}
8366
8367shellescape({string} [, {special}]) *shellescape()*
8368 Escape {string} for use as a shell command argument.
8369 When the 'shell' contains powershell (MS-Windows) or pwsh
Bram Moolenaar944697a2022-02-20 19:48:20 +00008370 (MS-Windows, Linux, and macOS) then it will enclose {string}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008371 in single quotes and will double up all internal single
8372 quotes.
8373 On MS-Windows, when 'shellslash' is not set, it will enclose
8374 {string} in double quotes and double all double quotes within
8375 {string}.
8376 Otherwise it will enclose {string} in single quotes and
8377 replace all "'" with "'\''".
8378
8379 When the {special} argument is present and it's a non-zero
8380 Number or a non-empty String (|non-zero-arg|), then special
8381 items such as "!", "%", "#" and "<cword>" will be preceded by
8382 a backslash. This backslash will be removed again by the |:!|
8383 command.
8384
8385 The "!" character will be escaped (again with a |non-zero-arg|
8386 {special}) when 'shell' contains "csh" in the tail. That is
8387 because for csh and tcsh "!" is used for history replacement
8388 even when inside single quotes.
8389
8390 With a |non-zero-arg| {special} the <NL> character is also
8391 escaped. When 'shell' containing "csh" in the tail it's
8392 escaped a second time.
8393
8394 The "\" character will be escaped when 'shell' contains "fish"
8395 in the tail. That is because for fish "\" is used as an escape
8396 character inside single quotes.
8397
8398 Example of use with a |:!| command: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008399 :exe '!dir ' .. shellescape(expand('<cfile>'), 1)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008400< This results in a directory listing for the file under the
8401 cursor. Example of use with |system()|: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008402 :call system("chmod +w -- " .. shellescape(expand("%")))
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008403< See also |::S|.
8404
8405 Can also be used as a |method|: >
8406 GetCommand()->shellescape()
8407
8408shiftwidth([{col}]) *shiftwidth()*
8409 Returns the effective value of 'shiftwidth'. This is the
8410 'shiftwidth' value unless it is zero, in which case it is the
8411 'tabstop' value. This function was introduced with patch
8412 7.3.694 in 2012, everybody should have it by now (however it
8413 did not allow for the optional {col} argument until 8.1.542).
8414
8415 When there is one argument {col} this is used as column number
8416 for which to return the 'shiftwidth' value. This matters for the
8417 'vartabstop' feature. If the 'vartabstop' setting is enabled and
8418 no {col} argument is given, column 1 will be assumed.
8419
8420 Can also be used as a |method|: >
8421 GetColumn()->shiftwidth()
8422
8423sign_ functions are documented here: |sign-functions-details|
8424
8425
8426simplify({filename}) *simplify()*
8427 Simplify the file name as much as possible without changing
8428 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
8429 Unix) are not resolved. If the first path component in
8430 {filename} designates the current directory, this will be
8431 valid for the result as well. A trailing path separator is
8432 not removed either. On Unix "//path" is unchanged, but
8433 "///path" is simplified to "/path" (this follows the Posix
8434 standard).
8435 Example: >
8436 simplify("./dir/.././/file/") == "./file/"
8437< Note: The combination "dir/.." is only removed if "dir" is
8438 a searchable directory or does not exist. On Unix, it is also
8439 removed when "dir" is a symbolic link within the same
8440 directory. In order to resolve all the involved symbolic
8441 links before simplifying the path name, use |resolve()|.
8442
8443 Can also be used as a |method|: >
8444 GetName()->simplify()
8445
8446sin({expr}) *sin()*
8447 Return the sine of {expr}, measured in radians, as a |Float|.
8448 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008449 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008450 Examples: >
8451 :echo sin(100)
8452< -0.506366 >
8453 :echo sin(-4.01)
8454< 0.763301
8455
8456 Can also be used as a |method|: >
8457 Compute()->sin()
8458<
8459 {only available when compiled with the |+float| feature}
8460
8461
8462sinh({expr}) *sinh()*
8463 Return the hyperbolic sine of {expr} as a |Float| in the range
8464 [-inf, inf].
8465 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008466 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008467 Examples: >
8468 :echo sinh(0.5)
8469< 0.521095 >
8470 :echo sinh(-0.9)
8471< -1.026517
8472
8473 Can also be used as a |method|: >
8474 Compute()->sinh()
8475<
8476 {only available when compiled with the |+float| feature}
8477
8478
8479slice({expr}, {start} [, {end}]) *slice()*
8480 Similar to using a |slice| "expr[start : end]", but "end" is
8481 used exclusive. And for a string the indexes are used as
8482 character indexes instead of byte indexes, like in
8483 |vim9script|. Also, composing characters are not counted.
8484 When {end} is omitted the slice continues to the last item.
8485 When {end} is -1 the last item is omitted.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008486 Returns an empty value if {start} or {end} are invalid.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008487
8488 Can also be used as a |method|: >
8489 GetList()->slice(offset)
8490
8491
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008492sort({list} [, {how} [, {dict}]]) *sort()* *E702*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008493 Sort the items in {list} in-place. Returns {list}.
8494
8495 If you want a list to remain unmodified make a copy first: >
8496 :let sortedlist = sort(copy(mylist))
8497
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01008498< When {how} is omitted or is a string, then sort() uses the
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008499 string representation of each item to sort on. Numbers sort
8500 after Strings, |Lists| after Numbers. For sorting text in the
8501 current buffer use |:sort|.
8502
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008503 When {how} is given and it is 'i' then case is ignored.
8504 In legacy script, for backwards compatibility, the value one
8505 can be used to ignore case. Zero means to not ignore case.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008506
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008507 When {how} is given and it is 'l' then the current collation
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008508 locale is used for ordering. Implementation details: strcoll()
8509 is used to compare strings. See |:language| check or set the
8510 collation locale. |v:collate| can also be used to check the
8511 current locale. Sorting using the locale typically ignores
8512 case. Example: >
8513 " ö is sorted similarly to o with English locale.
8514 :language collate en_US.UTF8
8515 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
8516< ['n', 'o', 'O', 'ö', 'p', 'z'] ~
8517>
8518 " ö is sorted after z with Swedish locale.
8519 :language collate sv_SE.UTF8
8520 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
8521< ['n', 'o', 'O', 'p', 'z', 'ö'] ~
8522 This does not work properly on Mac.
8523
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008524 When {how} is given and it is 'n' then all items will be
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008525 sorted numerical (Implementation detail: this uses the
8526 strtod() function to parse numbers, Strings, Lists, Dicts and
8527 Funcrefs will be considered as being 0).
8528
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008529 When {how} is given and it is 'N' then all items will be
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008530 sorted numerical. This is like 'n' but a string containing
8531 digits will be used as the number they represent.
8532
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008533 When {how} is given and it is 'f' then all items will be
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008534 sorted numerical. All values must be a Number or a Float.
8535
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008536 When {how} is a |Funcref| or a function name, this function
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008537 is called to compare items. The function is invoked with two
8538 items as argument and must return zero if they are equal, 1 or
8539 bigger if the first one sorts after the second one, -1 or
8540 smaller if the first one sorts before the second one.
8541
8542 {dict} is for functions with the "dict" attribute. It will be
8543 used to set the local variable "self". |Dictionary-function|
8544
8545 The sort is stable, items which compare equal (as number or as
8546 string) will keep their relative position. E.g., when sorting
8547 on numbers, text strings will sort next to each other, in the
8548 same order as they were originally.
8549
8550 Can also be used as a |method|: >
8551 mylist->sort()
8552
8553< Also see |uniq()|.
8554
8555 Example: >
8556 func MyCompare(i1, i2)
8557 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
8558 endfunc
8559 eval mylist->sort("MyCompare")
8560< A shorter compare version for this specific simple case, which
8561 ignores overflow: >
8562 func MyCompare(i1, i2)
8563 return a:i1 - a:i2
8564 endfunc
8565< For a simple expression you can use a lambda: >
8566 eval mylist->sort({i1, i2 -> i1 - i2})
8567<
8568sound_clear() *sound_clear()*
8569 Stop playing all sounds.
8570
8571 On some Linux systems you may need the libcanberra-pulse
8572 package, otherwise sound may not stop.
8573
8574 {only available when compiled with the |+sound| feature}
8575
8576 *sound_playevent()*
8577sound_playevent({name} [, {callback}])
8578 Play a sound identified by {name}. Which event names are
8579 supported depends on the system. Often the XDG sound names
8580 are used. On Ubuntu they may be found in
8581 /usr/share/sounds/freedesktop/stereo. Example: >
8582 call sound_playevent('bell')
8583< On MS-Windows, {name} can be SystemAsterisk, SystemDefault,
8584 SystemExclamation, SystemExit, SystemHand, SystemQuestion,
8585 SystemStart, SystemWelcome, etc.
8586
8587 When {callback} is specified it is invoked when the sound is
8588 finished. The first argument is the sound ID, the second
8589 argument is the status:
8590 0 sound was played to the end
8591 1 sound was interrupted
8592 2 error occurred after sound started
8593 Example: >
8594 func Callback(id, status)
8595 echomsg "sound " .. a:id .. " finished with " .. a:status
8596 endfunc
8597 call sound_playevent('bell', 'Callback')
8598
8599< MS-Windows: {callback} doesn't work for this function.
8600
8601 Returns the sound ID, which can be passed to `sound_stop()`.
8602 Returns zero if the sound could not be played.
8603
8604 Can also be used as a |method|: >
8605 GetSoundName()->sound_playevent()
8606
8607< {only available when compiled with the |+sound| feature}
8608
8609 *sound_playfile()*
8610sound_playfile({path} [, {callback}])
8611 Like `sound_playevent()` but play sound file {path}. {path}
8612 must be a full path. On Ubuntu you may find files to play
8613 with this command: >
8614 :!find /usr/share/sounds -type f | grep -v index.theme
8615
8616< Can also be used as a |method|: >
8617 GetSoundPath()->sound_playfile()
8618
Bram Moolenaar1588bc82022-03-08 21:35:07 +00008619< {only available when compiled with the |+sound| feature}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008620
8621
8622sound_stop({id}) *sound_stop()*
8623 Stop playing sound {id}. {id} must be previously returned by
8624 `sound_playevent()` or `sound_playfile()`.
8625
8626 On some Linux systems you may need the libcanberra-pulse
8627 package, otherwise sound may not stop.
8628
8629 On MS-Windows, this does not work for event sound started by
8630 `sound_playevent()`. To stop event sounds, use `sound_clear()`.
8631
8632 Can also be used as a |method|: >
8633 soundid->sound_stop()
8634
8635< {only available when compiled with the |+sound| feature}
8636
8637 *soundfold()*
8638soundfold({word})
8639 Return the sound-folded equivalent of {word}. Uses the first
8640 language in 'spelllang' for the current window that supports
8641 soundfolding. 'spell' must be set. When no sound folding is
8642 possible the {word} is returned unmodified.
8643 This can be used for making spelling suggestions. Note that
8644 the method can be quite slow.
8645
8646 Can also be used as a |method|: >
8647 GetWord()->soundfold()
8648<
8649 *spellbadword()*
8650spellbadword([{sentence}])
8651 Without argument: The result is the badly spelled word under
8652 or after the cursor. The cursor is moved to the start of the
8653 bad word. When no bad word is found in the cursor line the
8654 result is an empty string and the cursor doesn't move.
8655
8656 With argument: The result is the first word in {sentence} that
8657 is badly spelled. If there are no spelling mistakes the
8658 result is an empty string.
8659
8660 The return value is a list with two items:
8661 - The badly spelled word or an empty string.
8662 - The type of the spelling error:
8663 "bad" spelling mistake
8664 "rare" rare word
8665 "local" word only valid in another region
8666 "caps" word should start with Capital
8667 Example: >
8668 echo spellbadword("the quik brown fox")
8669< ['quik', 'bad'] ~
8670
8671 The spelling information for the current window and the value
8672 of 'spelllang' are used.
8673
8674 Can also be used as a |method|: >
8675 GetText()->spellbadword()
8676<
8677 *spellsuggest()*
8678spellsuggest({word} [, {max} [, {capital}]])
8679 Return a |List| with spelling suggestions to replace {word}.
8680 When {max} is given up to this number of suggestions are
8681 returned. Otherwise up to 25 suggestions are returned.
8682
8683 When the {capital} argument is given and it's non-zero only
8684 suggestions with a leading capital will be given. Use this
8685 after a match with 'spellcapcheck'.
8686
8687 {word} can be a badly spelled word followed by other text.
8688 This allows for joining two words that were split. The
8689 suggestions also include the following text, thus you can
8690 replace a line.
8691
8692 {word} may also be a good word. Similar words will then be
8693 returned. {word} itself is not included in the suggestions,
8694 although it may appear capitalized.
8695
8696 The spelling information for the current window is used. The
8697 values of 'spelllang' and 'spellsuggest' are used.
8698
8699 Can also be used as a |method|: >
8700 GetWord()->spellsuggest()
8701
8702split({string} [, {pattern} [, {keepempty}]]) *split()*
8703 Make a |List| out of {string}. When {pattern} is omitted or
8704 empty each white-separated sequence of characters becomes an
8705 item.
8706 Otherwise the string is split where {pattern} matches,
8707 removing the matched characters. 'ignorecase' is not used
8708 here, add \c to ignore case. |/\c|
8709 When the first or last item is empty it is omitted, unless the
8710 {keepempty} argument is given and it's non-zero.
8711 Other empty items are kept when {pattern} matches at least one
8712 character or when {keepempty} is non-zero.
8713 Example: >
8714 :let words = split(getline('.'), '\W\+')
8715< To split a string in individual characters: >
8716 :for c in split(mystring, '\zs')
8717< If you want to keep the separator you can also use '\zs' at
8718 the end of the pattern: >
8719 :echo split('abc:def:ghi', ':\zs')
8720< ['abc:', 'def:', 'ghi'] ~
8721 Splitting a table where the first element can be empty: >
8722 :let items = split(line, ':', 1)
8723< The opposite function is |join()|.
8724
8725 Can also be used as a |method|: >
8726 GetString()->split()
8727
8728sqrt({expr}) *sqrt()*
8729 Return the non-negative square root of Float {expr} as a
8730 |Float|.
8731 {expr} must evaluate to a |Float| or a |Number|. When {expr}
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008732 is negative the result is NaN (Not a Number). Returns 0.0 if
8733 {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008734 Examples: >
8735 :echo sqrt(100)
8736< 10.0 >
8737 :echo sqrt(-4.01)
8738< nan
8739 "nan" may be different, it depends on system libraries.
8740
8741 Can also be used as a |method|: >
8742 Compute()->sqrt()
8743<
8744 {only available when compiled with the |+float| feature}
8745
8746
8747srand([{expr}]) *srand()*
8748 Initialize seed used by |rand()|:
8749 - If {expr} is not given, seed values are initialized by
8750 reading from /dev/urandom, if possible, or using time(NULL)
8751 a.k.a. epoch time otherwise; this only has second accuracy.
8752 - If {expr} is given it must be a Number. It is used to
8753 initialize the seed values. This is useful for testing or
8754 when a predictable sequence is intended.
8755
8756 Examples: >
8757 :let seed = srand()
8758 :let seed = srand(userinput)
8759 :echo rand(seed)
8760
8761state([{what}]) *state()*
8762 Return a string which contains characters indicating the
8763 current state. Mostly useful in callbacks that want to do
8764 work that may not always be safe. Roughly this works like:
8765 - callback uses state() to check if work is safe to do.
8766 Yes: then do it right away.
8767 No: add to work queue and add a |SafeState| and/or
8768 |SafeStateAgain| autocommand (|SafeState| triggers at
8769 toplevel, |SafeStateAgain| triggers after handling
8770 messages and callbacks).
8771 - When SafeState or SafeStateAgain is triggered and executes
8772 your autocommand, check with `state()` if the work can be
8773 done now, and if yes remove it from the queue and execute.
8774 Remove the autocommand if the queue is now empty.
8775 Also see |mode()|.
8776
8777 When {what} is given only characters in this string will be
8778 added. E.g, this checks if the screen has scrolled: >
8779 if state('s') == ''
8780 " screen has not scrolled
8781<
8782 These characters indicate the state, generally indicating that
8783 something is busy:
8784 m halfway a mapping, :normal command, feedkeys() or
8785 stuffed command
8786 o operator pending, e.g. after |d|
8787 a Insert mode autocomplete active
8788 x executing an autocommand
8789 w blocked on waiting, e.g. ch_evalexpr(), ch_read() and
8790 ch_readraw() when reading json
8791 S not triggering SafeState or SafeStateAgain, e.g. after
8792 |f| or a count
8793 c callback invoked, including timer (repeats for
8794 recursiveness up to "ccc")
8795 s screen has scrolled for messages
8796
8797str2float({string} [, {quoted}]) *str2float()*
8798 Convert String {string} to a Float. This mostly works the
8799 same as when using a floating point number in an expression,
8800 see |floating-point-format|. But it's a bit more permissive.
8801 E.g., "1e40" is accepted, while in an expression you need to
8802 write "1.0e40". The hexadecimal form "0x123" is also
8803 accepted, but not others, like binary or octal.
8804 When {quoted} is present and non-zero then embedded single
8805 quotes before the dot are ignored, thus "1'000.0" is a
8806 thousand.
8807 Text after the number is silently ignored.
8808 The decimal point is always '.', no matter what the locale is
8809 set to. A comma ends the number: "12,345.67" is converted to
8810 12.0. You can strip out thousands separators with
8811 |substitute()|: >
8812 let f = str2float(substitute(text, ',', '', 'g'))
8813<
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008814 Returns 0.0 if the conversion fails.
8815
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008816 Can also be used as a |method|: >
8817 let f = text->substitute(',', '', 'g')->str2float()
8818<
8819 {only available when compiled with the |+float| feature}
8820
8821str2list({string} [, {utf8}]) *str2list()*
8822 Return a list containing the number values which represent
8823 each character in String {string}. Examples: >
8824 str2list(" ") returns [32]
8825 str2list("ABC") returns [65, 66, 67]
8826< |list2str()| does the opposite.
8827
8828 When {utf8} is omitted or zero, the current 'encoding' is used.
8829 When {utf8} is TRUE, always treat the String as UTF-8
8830 characters. With UTF-8 composing characters are handled
8831 properly: >
8832 str2list("á") returns [97, 769]
8833
8834< Can also be used as a |method|: >
8835 GetString()->str2list()
8836
8837
8838str2nr({string} [, {base} [, {quoted}]]) *str2nr()*
8839 Convert string {string} to a number.
8840 {base} is the conversion base, it can be 2, 8, 10 or 16.
8841 When {quoted} is present and non-zero then embedded single
8842 quotes are ignored, thus "1'000'000" is a million.
8843
8844 When {base} is omitted base 10 is used. This also means that
8845 a leading zero doesn't cause octal conversion to be used, as
8846 with the default String to Number conversion. Example: >
8847 let nr = str2nr('0123')
8848<
8849 When {base} is 16 a leading "0x" or "0X" is ignored. With a
8850 different base the result will be zero. Similarly, when
8851 {base} is 8 a leading "0", "0o" or "0O" is ignored, and when
8852 {base} is 2 a leading "0b" or "0B" is ignored.
8853 Text after the number is silently ignored.
8854
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008855 Returns 0 if {string} is empty or on error.
8856
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008857 Can also be used as a |method|: >
8858 GetText()->str2nr()
8859
8860
8861strcharlen({string}) *strcharlen()*
8862 The result is a Number, which is the number of characters
8863 in String {string}. Composing characters are ignored.
8864 |strchars()| can count the number of characters, counting
8865 composing characters separately.
8866
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008867 Returns 0 if {string} is empty or on error.
8868
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008869 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
8870
8871 Can also be used as a |method|: >
8872 GetText()->strcharlen()
8873
8874
8875strcharpart({src}, {start} [, {len} [, {skipcc}]]) *strcharpart()*
8876 Like |strpart()| but using character index and length instead
8877 of byte index and length.
8878 When {skipcc} is omitted or zero, composing characters are
8879 counted separately.
8880 When {skipcc} set to 1, Composing characters are ignored,
8881 similar to |slice()|.
8882 When a character index is used where a character does not
8883 exist it is omitted and counted as one character. For
8884 example: >
8885 strcharpart('abc', -1, 2)
8886< results in 'a'.
8887
Bram Moolenaard592deb2022-06-17 15:42:40 +01008888 Returns an empty string on error.
8889
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008890 Can also be used as a |method|: >
8891 GetText()->strcharpart(5)
8892
8893
8894strchars({string} [, {skipcc}]) *strchars()*
8895 The result is a Number, which is the number of characters
8896 in String {string}.
8897 When {skipcc} is omitted or zero, composing characters are
8898 counted separately.
8899 When {skipcc} set to 1, Composing characters are ignored.
8900 |strcharlen()| always does this.
8901
Bram Moolenaard592deb2022-06-17 15:42:40 +01008902 Returns zero on error.
8903
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008904 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
8905
8906 {skipcc} is only available after 7.4.755. For backward
8907 compatibility, you can define a wrapper function: >
8908 if has("patch-7.4.755")
8909 function s:strchars(str, skipcc)
8910 return strchars(a:str, a:skipcc)
8911 endfunction
8912 else
8913 function s:strchars(str, skipcc)
8914 if a:skipcc
8915 return strlen(substitute(a:str, ".", "x", "g"))
8916 else
8917 return strchars(a:str)
8918 endif
8919 endfunction
8920 endif
8921<
8922 Can also be used as a |method|: >
8923 GetText()->strchars()
8924
8925strdisplaywidth({string} [, {col}]) *strdisplaywidth()*
8926 The result is a Number, which is the number of display cells
8927 String {string} occupies on the screen when it starts at {col}
8928 (first column is zero). When {col} is omitted zero is used.
8929 Otherwise it is the screen column where to start. This
8930 matters for Tab characters.
8931 The option settings of the current window are used. This
8932 matters for anything that's displayed differently, such as
8933 'tabstop' and 'display'.
8934 When {string} contains characters with East Asian Width Class
8935 Ambiguous, this function's return value depends on 'ambiwidth'.
Bram Moolenaard592deb2022-06-17 15:42:40 +01008936 Returns zero on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008937 Also see |strlen()|, |strwidth()| and |strchars()|.
8938
8939 Can also be used as a |method|: >
8940 GetText()->strdisplaywidth()
8941
8942strftime({format} [, {time}]) *strftime()*
8943 The result is a String, which is a formatted date and time, as
8944 specified by the {format} string. The given {time} is used,
8945 or the current time if no time is given. The accepted
8946 {format} depends on your system, thus this is not portable!
8947 See the manual page of the C function strftime() for the
8948 format. The maximum length of the result is 80 characters.
8949 See also |localtime()|, |getftime()| and |strptime()|.
8950 The language can be changed with the |:language| command.
8951 Examples: >
8952 :echo strftime("%c") Sun Apr 27 11:49:23 1997
8953 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
8954 :echo strftime("%y%m%d %T") 970427 11:53:55
8955 :echo strftime("%H:%M") 11:55
8956 :echo strftime("%c", getftime("file.c"))
8957 Show mod time of file.c.
8958< Not available on all systems. To check use: >
8959 :if exists("*strftime")
8960
8961< Can also be used as a |method|: >
8962 GetFormat()->strftime()
8963
8964strgetchar({str}, {index}) *strgetchar()*
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01008965 Get a Number corresponding to the character at {index} in
8966 {str}. This uses a zero-based character index, not a byte
8967 index. Composing characters are considered separate
8968 characters here. Use |nr2char()| to convert the Number to a
8969 String.
Bram Moolenaard592deb2022-06-17 15:42:40 +01008970 Returns -1 if {index} is invalid.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008971 Also see |strcharpart()| and |strchars()|.
8972
8973 Can also be used as a |method|: >
8974 GetText()->strgetchar(5)
8975
8976stridx({haystack}, {needle} [, {start}]) *stridx()*
8977 The result is a Number, which gives the byte index in
8978 {haystack} of the first occurrence of the String {needle}.
8979 If {start} is specified, the search starts at index {start}.
8980 This can be used to find a second match: >
8981 :let colon1 = stridx(line, ":")
8982 :let colon2 = stridx(line, ":", colon1 + 1)
8983< The search is done case-sensitive.
8984 For pattern searches use |match()|.
8985 -1 is returned if the {needle} does not occur in {haystack}.
8986 See also |strridx()|.
8987 Examples: >
8988 :echo stridx("An Example", "Example") 3
8989 :echo stridx("Starting point", "Start") 0
8990 :echo stridx("Starting point", "start") -1
8991< *strstr()* *strchr()*
8992 stridx() works similar to the C function strstr(). When used
8993 with a single character it works similar to strchr().
8994
8995 Can also be used as a |method|: >
8996 GetHaystack()->stridx(needle)
8997<
8998 *string()*
8999string({expr}) Return {expr} converted to a String. If {expr} is a Number,
9000 Float, String, Blob or a composition of them, then the result
9001 can be parsed back with |eval()|.
9002 {expr} type result ~
9003 String 'string' (single quotes are doubled)
9004 Number 123
9005 Float 123.123456 or 1.123456e8
9006 Funcref function('name')
9007 Blob 0z00112233.44556677.8899
9008 List [item, item]
9009 Dictionary {key: value, key: value}
9010
9011 When a |List| or |Dictionary| has a recursive reference it is
9012 replaced by "[...]" or "{...}". Using eval() on the result
9013 will then fail.
9014
9015 Can also be used as a |method|: >
9016 mylist->string()
9017
9018< Also see |strtrans()|.
9019
9020
9021strlen({string}) *strlen()*
9022 The result is a Number, which is the length of the String
9023 {string} in bytes.
9024 If the argument is a Number it is first converted to a String.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009025 For other types an error is given and zero is returned.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009026 If you want to count the number of multibyte characters use
9027 |strchars()|.
9028 Also see |len()|, |strdisplaywidth()| and |strwidth()|.
9029
9030 Can also be used as a |method|: >
9031 GetString()->strlen()
9032
9033strpart({src}, {start} [, {len} [, {chars}]]) *strpart()*
9034 The result is a String, which is part of {src}, starting from
9035 byte {start}, with the byte length {len}.
9036 When {chars} is present and TRUE then {len} is the number of
9037 characters positions (composing characters are not counted
9038 separately, thus "1" means one base character and any
9039 following composing characters).
9040 To count {start} as characters instead of bytes use
9041 |strcharpart()|.
9042
9043 When bytes are selected which do not exist, this doesn't
9044 result in an error, the bytes are simply omitted.
9045 If {len} is missing, the copy continues from {start} till the
9046 end of the {src}. >
9047 strpart("abcdefg", 3, 2) == "de"
9048 strpart("abcdefg", -2, 4) == "ab"
9049 strpart("abcdefg", 5, 4) == "fg"
9050 strpart("abcdefg", 3) == "defg"
9051
9052< Note: To get the first character, {start} must be 0. For
9053 example, to get the character under the cursor: >
9054 strpart(getline("."), col(".") - 1, 1, v:true)
9055<
Bram Moolenaard592deb2022-06-17 15:42:40 +01009056 Returns an empty string on error.
9057
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009058 Can also be used as a |method|: >
9059 GetText()->strpart(5)
9060
9061strptime({format}, {timestring}) *strptime()*
9062 The result is a Number, which is a unix timestamp representing
9063 the date and time in {timestring}, which is expected to match
9064 the format specified in {format}.
9065
9066 The accepted {format} depends on your system, thus this is not
9067 portable! See the manual page of the C function strptime()
9068 for the format. Especially avoid "%c". The value of $TZ also
9069 matters.
9070
9071 If the {timestring} cannot be parsed with {format} zero is
9072 returned. If you do not know the format of {timestring} you
9073 can try different {format} values until you get a non-zero
9074 result.
9075
9076 See also |strftime()|.
9077 Examples: >
9078 :echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23")
9079< 862156163 >
9080 :echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55"))
9081< Sun Apr 27 11:53:55 1997 >
9082 :echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
9083< Sun Apr 27 12:53:55 1997
9084
9085 Can also be used as a |method|: >
9086 GetFormat()->strptime(timestring)
9087<
9088 Not available on all systems. To check use: >
9089 :if exists("*strptime")
9090
9091strridx({haystack}, {needle} [, {start}]) *strridx()*
9092 The result is a Number, which gives the byte index in
9093 {haystack} of the last occurrence of the String {needle}.
9094 When {start} is specified, matches beyond this index are
9095 ignored. This can be used to find a match before a previous
9096 match: >
9097 :let lastcomma = strridx(line, ",")
9098 :let comma2 = strridx(line, ",", lastcomma - 1)
9099< The search is done case-sensitive.
9100 For pattern searches use |match()|.
9101 -1 is returned if the {needle} does not occur in {haystack}.
9102 If the {needle} is empty the length of {haystack} is returned.
9103 See also |stridx()|. Examples: >
9104 :echo strridx("an angry armadillo", "an") 3
9105< *strrchr()*
9106 When used with a single character it works similar to the C
9107 function strrchr().
9108
9109 Can also be used as a |method|: >
9110 GetHaystack()->strridx(needle)
9111
9112strtrans({string}) *strtrans()*
9113 The result is a String, which is {string} with all unprintable
9114 characters translated into printable characters |'isprint'|.
9115 Like they are shown in a window. Example: >
9116 echo strtrans(@a)
9117< This displays a newline in register a as "^@" instead of
9118 starting a new line.
9119
Bram Moolenaard592deb2022-06-17 15:42:40 +01009120 Returns an empty string on error.
9121
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009122 Can also be used as a |method|: >
9123 GetString()->strtrans()
9124
9125strwidth({string}) *strwidth()*
9126 The result is a Number, which is the number of display cells
9127 String {string} occupies. A Tab character is counted as one
9128 cell, alternatively use |strdisplaywidth()|.
9129 When {string} contains characters with East Asian Width Class
9130 Ambiguous, this function's return value depends on 'ambiwidth'.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009131 Returns zero on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009132 Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
9133
9134 Can also be used as a |method|: >
9135 GetString()->strwidth()
9136
9137submatch({nr} [, {list}]) *submatch()* *E935*
9138 Only for an expression in a |:substitute| command or
9139 substitute() function.
9140 Returns the {nr}'th submatch of the matched text. When {nr}
9141 is 0 the whole matched text is returned.
9142 Note that a NL in the string can stand for a line break of a
9143 multi-line match or a NUL character in the text.
9144 Also see |sub-replace-expression|.
9145
9146 If {list} is present and non-zero then submatch() returns
9147 a list of strings, similar to |getline()| with two arguments.
9148 NL characters in the text represent NUL characters in the
9149 text.
9150 Only returns more than one item for |:substitute|, inside
9151 |substitute()| this list will always contain one or zero
9152 items, since there are no real line breaks.
9153
9154 When substitute() is used recursively only the submatches in
9155 the current (deepest) call can be obtained.
9156
Bram Moolenaard592deb2022-06-17 15:42:40 +01009157 Returns an empty string or list on error.
9158
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009159 Examples: >
9160 :s/\d\+/\=submatch(0) + 1/
9161 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
9162< This finds the first number in the line and adds one to it.
9163 A line break is included as a newline character.
9164
9165 Can also be used as a |method|: >
9166 GetNr()->submatch()
9167
9168substitute({string}, {pat}, {sub}, {flags}) *substitute()*
9169 The result is a String, which is a copy of {string}, in which
9170 the first match of {pat} is replaced with {sub}.
9171 When {flags} is "g", all matches of {pat} in {string} are
9172 replaced. Otherwise {flags} should be "".
9173
9174 This works like the ":substitute" command (without any flags).
9175 But the matching with {pat} is always done like the 'magic'
9176 option is set and 'cpoptions' is empty (to make scripts
9177 portable). 'ignorecase' is still relevant, use |/\c| or |/\C|
9178 if you want to ignore or match case and ignore 'ignorecase'.
9179 'smartcase' is not used. See |string-match| for how {pat} is
9180 used.
9181
9182 A "~" in {sub} is not replaced with the previous {sub}.
9183 Note that some codes in {sub} have a special meaning
9184 |sub-replace-special|. For example, to replace something with
9185 "\n" (two characters), use "\\\\n" or '\\n'.
9186
9187 When {pat} does not match in {string}, {string} is returned
9188 unmodified.
9189
9190 Example: >
9191 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
9192< This removes the last component of the 'path' option. >
9193 :echo substitute("testing", ".*", "\\U\\0", "")
9194< results in "TESTING".
9195
9196 When {sub} starts with "\=", the remainder is interpreted as
9197 an expression. See |sub-replace-expression|. Example: >
9198 :echo substitute(s, '%\(\x\x\)',
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009199 \ '\=nr2char("0x" .. submatch(1))', 'g')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009200
9201< When {sub} is a Funcref that function is called, with one
9202 optional argument. Example: >
9203 :echo substitute(s, '%\(\x\x\)', SubNr, 'g')
9204< The optional argument is a list which contains the whole
9205 matched string and up to nine submatches, like what
9206 |submatch()| returns. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009207 :echo substitute(s, '%\(\x\x\)', {m -> '0x' .. m[1]}, 'g')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009208
Bram Moolenaard592deb2022-06-17 15:42:40 +01009209< Returns an empty string on error.
9210
9211 Can also be used as a |method|: >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009212 GetString()->substitute(pat, sub, flags)
9213
9214swapinfo({fname}) *swapinfo()*
9215 The result is a dictionary, which holds information about the
9216 swapfile {fname}. The available fields are:
9217 version Vim version
9218 user user name
9219 host host name
9220 fname original file name
9221 pid PID of the Vim process that created the swap
9222 file
9223 mtime last modification time in seconds
9224 inode Optional: INODE number of the file
9225 dirty 1 if file was modified, 0 if not
9226 Note that "user" and "host" are truncated to at most 39 bytes.
9227 In case of failure an "error" item is added with the reason:
9228 Cannot open file: file not found or in accessible
9229 Cannot read file: cannot read first block
9230 Not a swap file: does not contain correct block ID
9231 Magic number mismatch: Info in first block is invalid
9232
9233 Can also be used as a |method|: >
9234 GetFilename()->swapinfo()
9235
9236swapname({buf}) *swapname()*
9237 The result is the swap file path of the buffer {expr}.
9238 For the use of {buf}, see |bufname()| above.
9239 If buffer {buf} is the current buffer, the result is equal to
9240 |:swapname| (unless there is no swap file).
9241 If buffer {buf} has no swap file, returns an empty string.
9242
9243 Can also be used as a |method|: >
9244 GetBufname()->swapname()
9245
9246synID({lnum}, {col}, {trans}) *synID()*
9247 The result is a Number, which is the syntax ID at the position
9248 {lnum} and {col} in the current window.
9249 The syntax ID can be used with |synIDattr()| and
9250 |synIDtrans()| to obtain syntax information about text.
9251
9252 {col} is 1 for the leftmost column, {lnum} is 1 for the first
9253 line. 'synmaxcol' applies, in a longer line zero is returned.
9254 Note that when the position is after the last character,
9255 that's where the cursor can be in Insert mode, synID() returns
9256 zero. {lnum} is used like with |getline()|.
9257
9258 When {trans} is |TRUE|, transparent items are reduced to the
9259 item that they reveal. This is useful when wanting to know
9260 the effective color. When {trans} is |FALSE|, the transparent
9261 item is returned. This is useful when wanting to know which
9262 syntax item is effective (e.g. inside parens).
9263 Warning: This function can be very slow. Best speed is
9264 obtained by going through the file in forward direction.
9265
Bram Moolenaard592deb2022-06-17 15:42:40 +01009266 Returns zero on error.
9267
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009268 Example (echoes the name of the syntax item under the cursor): >
9269 :echo synIDattr(synID(line("."), col("."), 1), "name")
9270<
9271
9272synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
9273 The result is a String, which is the {what} attribute of
9274 syntax ID {synID}. This can be used to obtain information
9275 about a syntax item.
9276 {mode} can be "gui", "cterm" or "term", to get the attributes
9277 for that mode. When {mode} is omitted, or an invalid value is
9278 used, the attributes for the currently active highlighting are
9279 used (GUI, cterm or term).
9280 Use synIDtrans() to follow linked highlight groups.
9281 {what} result
9282 "name" the name of the syntax item
9283 "fg" foreground color (GUI: color name used to set
9284 the color, cterm: color number as a string,
9285 term: empty string)
9286 "bg" background color (as with "fg")
9287 "font" font name (only available in the GUI)
9288 |highlight-font|
9289 "sp" special color for the GUI (as with "fg")
9290 |highlight-guisp|
9291 "ul" underline color for cterm: number as a string
9292 "fg#" like "fg", but for the GUI and the GUI is
9293 running the name in "#RRGGBB" form
9294 "bg#" like "fg#" for "bg"
9295 "sp#" like "fg#" for "sp"
9296 "bold" "1" if bold
9297 "italic" "1" if italic
9298 "reverse" "1" if reverse
9299 "inverse" "1" if inverse (= reverse)
9300 "standout" "1" if standout
9301 "underline" "1" if underlined
9302 "undercurl" "1" if undercurled
9303 "strike" "1" if strikethrough
Bram Moolenaarde786322022-07-30 14:56:17 +01009304 "nocombine" "1" if nocombine
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009305
Bram Moolenaard592deb2022-06-17 15:42:40 +01009306 Returns an empty string on error.
9307
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009308 Example (echoes the color of the syntax item under the
9309 cursor): >
9310 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
9311<
9312 Can also be used as a |method|: >
9313 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
9314
9315
9316synIDtrans({synID}) *synIDtrans()*
9317 The result is a Number, which is the translated syntax ID of
9318 {synID}. This is the syntax group ID of what is being used to
9319 highlight the character. Highlight links given with
9320 ":highlight link" are followed.
9321
Bram Moolenaard592deb2022-06-17 15:42:40 +01009322 Returns zero on error.
9323
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009324 Can also be used as a |method|: >
9325 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
9326
9327synconcealed({lnum}, {col}) *synconcealed()*
9328 The result is a |List| with currently three items:
9329 1. The first item in the list is 0 if the character at the
9330 position {lnum} and {col} is not part of a concealable
9331 region, 1 if it is. {lnum} is used like with |getline()|.
9332 2. The second item in the list is a string. If the first item
9333 is 1, the second item contains the text which will be
9334 displayed in place of the concealed text, depending on the
9335 current setting of 'conceallevel' and 'listchars'.
9336 3. The third and final item in the list is a number
9337 representing the specific syntax region matched in the
9338 line. When the character is not concealed the value is
9339 zero. This allows detection of the beginning of a new
9340 concealable region if there are two consecutive regions
9341 with the same replacement character. For an example, if
9342 the text is "123456" and both "23" and "45" are concealed
9343 and replaced by the character "X", then:
9344 call returns ~
9345 synconcealed(lnum, 1) [0, '', 0]
9346 synconcealed(lnum, 2) [1, 'X', 1]
9347 synconcealed(lnum, 3) [1, 'X', 1]
9348 synconcealed(lnum, 4) [1, 'X', 2]
9349 synconcealed(lnum, 5) [1, 'X', 2]
9350 synconcealed(lnum, 6) [0, '', 0]
9351
9352
9353synstack({lnum}, {col}) *synstack()*
9354 Return a |List|, which is the stack of syntax items at the
9355 position {lnum} and {col} in the current window. {lnum} is
9356 used like with |getline()|. Each item in the List is an ID
9357 like what |synID()| returns.
9358 The first item in the List is the outer region, following are
9359 items contained in that one. The last one is what |synID()|
9360 returns, unless not the whole item is highlighted or it is a
9361 transparent item.
9362 This function is useful for debugging a syntax file.
9363 Example that shows the syntax stack under the cursor: >
9364 for id in synstack(line("."), col("."))
9365 echo synIDattr(id, "name")
9366 endfor
9367< When the position specified with {lnum} and {col} is invalid
Bram Moolenaard592deb2022-06-17 15:42:40 +01009368 an empty List is returned. The position just after the last
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009369 character in a line and the first column in an empty line are
9370 valid positions.
9371
9372system({expr} [, {input}]) *system()* *E677*
9373 Get the output of the shell command {expr} as a |String|. See
9374 |systemlist()| to get the output as a |List|.
9375
9376 When {input} is given and is a |String| this string is written
9377 to a file and passed as stdin to the command. The string is
9378 written as-is, you need to take care of using the correct line
9379 separators yourself.
9380 If {input} is given and is a |List| it is written to the file
9381 in a way |writefile()| does with {binary} set to "b" (i.e.
9382 with a newline between each list item with newlines inside
9383 list items converted to NULs).
9384 When {input} is given and is a number that is a valid id for
9385 an existing buffer then the content of the buffer is written
9386 to the file line by line, each line terminated by a NL and
9387 NULs characters where the text has a NL.
9388
9389 Pipes are not used, the 'shelltemp' option is not used.
9390
9391 When prepended by |:silent| the terminal will not be set to
9392 cooked mode. This is meant to be used for commands that do
9393 not need the user to type. It avoids stray characters showing
9394 up on the screen which require |CTRL-L| to remove. >
9395 :silent let f = system('ls *.vim')
9396<
9397 Note: Use |shellescape()| or |::S| with |expand()| or
9398 |fnamemodify()| to escape special characters in a command
9399 argument. Newlines in {expr} may cause the command to fail.
9400 The characters in 'shellquote' and 'shellxquote' may also
9401 cause trouble.
9402 This is not to be used for interactive commands.
9403
9404 The result is a String. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009405 :let files = system('ls ' .. shellescape(expand('%:h')))
9406 :let files = system('ls ' .. expand('%:h:S'))
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009407
9408< To make the result more system-independent, the shell output
9409 is filtered to replace <CR> with <NL> for Macintosh, and
9410 <CR><NL> with <NL> for DOS-like systems.
9411 To avoid the string being truncated at a NUL, all NUL
9412 characters are replaced with SOH (0x01).
9413
9414 The command executed is constructed using several options:
9415 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
9416 ({tmp} is an automatically generated file name).
9417 For Unix, braces are put around {expr} to allow for
9418 concatenated commands.
9419
9420 The command will be executed in "cooked" mode, so that a
9421 CTRL-C will interrupt the command (on Unix at least).
9422
9423 The resulting error code can be found in |v:shell_error|.
9424 This function will fail in |restricted-mode|.
9425
9426 Note that any wrong value in the options mentioned above may
9427 make the function fail. It has also been reported to fail
9428 when using a security agent application.
9429 Unlike ":!cmd" there is no automatic check for changed files.
9430 Use |:checktime| to force a check.
9431
9432 Can also be used as a |method|: >
9433 :echo GetCmd()->system()
9434
9435
9436systemlist({expr} [, {input}]) *systemlist()*
9437 Same as |system()|, but returns a |List| with lines (parts of
9438 output separated by NL) with NULs transformed into NLs. Output
9439 is the same as |readfile()| will output with {binary} argument
9440 set to "b", except that there is no extra empty item when the
9441 result ends in a NL.
9442 Note that on MS-Windows you may get trailing CR characters.
9443
9444 To see the difference between "echo hello" and "echo -n hello"
9445 use |system()| and |split()|: >
9446 echo system('echo hello')->split('\n', 1)
9447<
9448 Returns an empty string on error.
9449
9450 Can also be used as a |method|: >
9451 :echo GetCmd()->systemlist()
9452
9453
9454tabpagebuflist([{arg}]) *tabpagebuflist()*
9455 The result is a |List|, where each item is the number of the
9456 buffer associated with each window in the current tab page.
9457 {arg} specifies the number of the tab page to be used. When
9458 omitted the current tab page is used.
9459 When {arg} is invalid the number zero is returned.
9460 To get a list of all buffers in all tabs use this: >
9461 let buflist = []
9462 for i in range(tabpagenr('$'))
9463 call extend(buflist, tabpagebuflist(i + 1))
9464 endfor
9465< Note that a buffer may appear in more than one window.
9466
9467 Can also be used as a |method|: >
9468 GetTabpage()->tabpagebuflist()
9469
9470tabpagenr([{arg}]) *tabpagenr()*
9471 The result is a Number, which is the number of the current
9472 tab page. The first tab page has number 1.
9473
9474 The optional argument {arg} supports the following values:
9475 $ the number of the last tab page (the tab page
9476 count).
9477 # the number of the last accessed tab page
9478 (where |g<Tab>| goes to). if there is no
9479 previous tab page 0 is returned.
9480 The number can be used with the |:tab| command.
9481
Bram Moolenaard592deb2022-06-17 15:42:40 +01009482 Returns zero on error.
9483
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009484
9485tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()*
9486 Like |winnr()| but for tab page {tabarg}.
9487 {tabarg} specifies the number of tab page to be used.
9488 {arg} is used like with |winnr()|:
9489 - When omitted the current window number is returned. This is
9490 the window which will be used when going to this tab page.
9491 - When "$" the number of windows is returned.
9492 - When "#" the previous window nr is returned.
9493 Useful examples: >
9494 tabpagewinnr(1) " current window of tab page 1
9495 tabpagewinnr(4, '$') " number of windows in tab page 4
9496< When {tabarg} is invalid zero is returned.
9497
9498 Can also be used as a |method|: >
9499 GetTabpage()->tabpagewinnr()
9500<
9501 *tagfiles()*
9502tagfiles() Returns a |List| with the file names used to search for tags
9503 for the current buffer. This is the 'tags' option expanded.
9504
9505
9506taglist({expr} [, {filename}]) *taglist()*
9507 Returns a |List| of tags matching the regular expression {expr}.
9508
9509 If {filename} is passed it is used to prioritize the results
9510 in the same way that |:tselect| does. See |tag-priority|.
9511 {filename} should be the full path of the file.
9512
9513 Each list item is a dictionary with at least the following
9514 entries:
9515 name Name of the tag.
9516 filename Name of the file where the tag is
9517 defined. It is either relative to the
9518 current directory or a full path.
9519 cmd Ex command used to locate the tag in
9520 the file.
9521 kind Type of the tag. The value for this
9522 entry depends on the language specific
9523 kind values. Only available when
9524 using a tags file generated by
Bram Moolenaar47c532e2022-03-19 15:18:53 +00009525 Universal/Exuberant ctags or hdrtag.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009526 static A file specific tag. Refer to
9527 |static-tag| for more information.
9528 More entries may be present, depending on the content of the
9529 tags file: access, implementation, inherits and signature.
9530 Refer to the ctags documentation for information about these
9531 fields. For C code the fields "struct", "class" and "enum"
9532 may appear, they give the name of the entity the tag is
9533 contained in.
9534
9535 The ex-command "cmd" can be either an ex search pattern, a
9536 line number or a line number followed by a byte number.
9537
9538 If there are no matching tags, then an empty list is returned.
9539
9540 To get an exact tag match, the anchors '^' and '$' should be
9541 used in {expr}. This also make the function work faster.
9542 Refer to |tag-regexp| for more information about the tag
9543 search regular expression pattern.
9544
9545 Refer to |'tags'| for information about how the tags file is
9546 located by Vim. Refer to |tags-file-format| for the format of
9547 the tags file generated by the different ctags tools.
9548
9549 Can also be used as a |method|: >
9550 GetTagpattern()->taglist()
9551
9552tan({expr}) *tan()*
9553 Return the tangent of {expr}, measured in radians, as a |Float|
9554 in the range [-inf, inf].
9555 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009556 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009557 Examples: >
9558 :echo tan(10)
9559< 0.648361 >
9560 :echo tan(-4.01)
9561< -1.181502
9562
9563 Can also be used as a |method|: >
9564 Compute()->tan()
9565<
9566 {only available when compiled with the |+float| feature}
9567
9568
9569tanh({expr}) *tanh()*
9570 Return the hyperbolic tangent of {expr} as a |Float| in the
9571 range [-1, 1].
9572 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009573 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009574 Examples: >
9575 :echo tanh(0.5)
9576< 0.462117 >
9577 :echo tanh(-1)
9578< -0.761594
9579
9580 Can also be used as a |method|: >
9581 Compute()->tanh()
9582<
9583 {only available when compiled with the |+float| feature}
9584
9585
9586tempname() *tempname()* *temp-file-name*
9587 The result is a String, which is the name of a file that
9588 doesn't exist. It can be used for a temporary file. The name
9589 is different for at least 26 consecutive calls. Example: >
9590 :let tmpfile = tempname()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009591 :exe "redir > " .. tmpfile
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009592< For Unix, the file will be in a private directory |tempfile|.
9593 For MS-Windows forward slashes are used when the 'shellslash'
9594 option is set, or when 'shellcmdflag' starts with '-' and
9595 'shell' does not contain powershell or pwsh.
9596
9597
9598term_ functions are documented here: |terminal-function-details|
9599
9600
9601terminalprops() *terminalprops()*
9602 Returns a |Dictionary| with properties of the terminal that Vim
9603 detected from the response to |t_RV| request. See
9604 |v:termresponse| for the response itself. If |v:termresponse|
9605 is empty most values here will be 'u' for unknown.
9606 cursor_style whether sending |t_RS| works **
9607 cursor_blink_mode whether sending |t_RC| works **
9608 underline_rgb whether |t_8u| works **
9609 mouse mouse type supported
9610
9611 ** value 'u' for unknown, 'y' for yes, 'n' for no
9612
9613 If the |+termresponse| feature is missing then the result is
9614 an empty dictionary.
9615
9616 If "cursor_style" is 'y' then |t_RS| will be sent to request the
9617 current cursor style.
9618 If "cursor_blink_mode" is 'y' then |t_RC| will be sent to
9619 request the cursor blink status.
9620 "cursor_style" and "cursor_blink_mode" are also set if |t_u7|
9621 is not empty, Vim will detect the working of sending |t_RS|
9622 and |t_RC| on startup.
9623
9624 When "underline_rgb" is not 'y', then |t_8u| will be made empty.
9625 This avoids sending it to xterm, which would clear the colors.
9626
9627 For "mouse" the value 'u' is unknown
9628
9629 Also see:
9630 - 'ambiwidth' - detected by using |t_u7|.
9631 - |v:termstyleresp| and |v:termblinkresp| for the response to
9632 |t_RS| and |t_RC|.
9633
9634
9635test_ functions are documented here: |test-functions-details|
9636
9637
9638 *timer_info()*
9639timer_info([{id}])
9640 Return a list with information about timers.
9641 When {id} is given only information about this timer is
9642 returned. When timer {id} does not exist an empty list is
9643 returned.
9644 When {id} is omitted information about all timers is returned.
9645
9646 For each timer the information is stored in a |Dictionary| with
9647 these items:
9648 "id" the timer ID
9649 "time" time the timer was started with
9650 "remaining" time until the timer fires
9651 "repeat" number of times the timer will still fire;
9652 -1 means forever
9653 "callback" the callback
9654 "paused" 1 if the timer is paused, 0 otherwise
9655
9656 Can also be used as a |method|: >
9657 GetTimer()->timer_info()
9658
9659< {only available when compiled with the |+timers| feature}
9660
9661timer_pause({timer}, {paused}) *timer_pause()*
9662 Pause or unpause a timer. A paused timer does not invoke its
9663 callback when its time expires. Unpausing a timer may cause
9664 the callback to be invoked almost immediately if enough time
9665 has passed.
9666
9667 Pausing a timer is useful to avoid the callback to be called
9668 for a short time.
9669
9670 If {paused} evaluates to a non-zero Number or a non-empty
9671 String, then the timer is paused, otherwise it is unpaused.
9672 See |non-zero-arg|.
9673
9674 Can also be used as a |method|: >
9675 GetTimer()->timer_pause(1)
9676
9677< {only available when compiled with the |+timers| feature}
9678
9679 *timer_start()* *timer* *timers*
9680timer_start({time}, {callback} [, {options}])
9681 Create a timer and return the timer ID.
9682
9683 {time} is the waiting time in milliseconds. This is the
9684 minimum time before invoking the callback. When the system is
9685 busy or Vim is not waiting for input the time will be longer.
9686
9687 {callback} is the function to call. It can be the name of a
9688 function or a |Funcref|. It is called with one argument, which
9689 is the timer ID. The callback is only invoked when Vim is
9690 waiting for input.
9691 If you want to show a message look at |popup_notification()|
9692 to avoid interfering with what the user is doing.
9693
9694 {options} is a dictionary. Supported entries:
9695 "repeat" Number of times to repeat calling the
9696 callback. -1 means forever. When not present
9697 the callback will be called once.
9698 If the timer causes an error three times in a
9699 row the repeat is cancelled. This avoids that
9700 Vim becomes unusable because of all the error
9701 messages.
9702
Bram Moolenaard592deb2022-06-17 15:42:40 +01009703 Returns -1 on error.
9704
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009705 Example: >
9706 func MyHandler(timer)
9707 echo 'Handler called'
9708 endfunc
9709 let timer = timer_start(500, 'MyHandler',
9710 \ {'repeat': 3})
9711< This will invoke MyHandler() three times at 500 msec
9712 intervals.
9713
9714 Can also be used as a |method|: >
9715 GetMsec()->timer_start(callback)
9716
9717< Not available in the |sandbox|.
9718 {only available when compiled with the |+timers| feature}
9719
9720timer_stop({timer}) *timer_stop()*
9721 Stop a timer. The timer callback will no longer be invoked.
9722 {timer} is an ID returned by timer_start(), thus it must be a
9723 Number. If {timer} does not exist there is no error.
9724
9725 Can also be used as a |method|: >
9726 GetTimer()->timer_stop()
9727
9728< {only available when compiled with the |+timers| feature}
9729
9730timer_stopall() *timer_stopall()*
9731 Stop all timers. The timer callbacks will no longer be
9732 invoked. Useful if a timer is misbehaving. If there are no
9733 timers there is no error.
9734
9735 {only available when compiled with the |+timers| feature}
9736
9737tolower({expr}) *tolower()*
9738 The result is a copy of the String given, with all uppercase
9739 characters turned into lowercase (just like applying |gu| to
Bram Moolenaard592deb2022-06-17 15:42:40 +01009740 the string). Returns an empty string on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009741
9742 Can also be used as a |method|: >
9743 GetText()->tolower()
9744
9745toupper({expr}) *toupper()*
9746 The result is a copy of the String given, with all lowercase
9747 characters turned into uppercase (just like applying |gU| to
Bram Moolenaard592deb2022-06-17 15:42:40 +01009748 the string). Returns an empty string on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009749
9750 Can also be used as a |method|: >
9751 GetText()->toupper()
9752
9753tr({src}, {fromstr}, {tostr}) *tr()*
9754 The result is a copy of the {src} string with all characters
9755 which appear in {fromstr} replaced by the character in that
9756 position in the {tostr} string. Thus the first character in
9757 {fromstr} is translated into the first character in {tostr}
9758 and so on. Exactly like the unix "tr" command.
9759 This code also deals with multibyte characters properly.
9760
Bram Moolenaard592deb2022-06-17 15:42:40 +01009761 Returns an empty string on error.
9762
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009763 Examples: >
9764 echo tr("hello there", "ht", "HT")
9765< returns "Hello THere" >
9766 echo tr("<blob>", "<>", "{}")
9767< returns "{blob}"
9768
9769 Can also be used as a |method|: >
9770 GetText()->tr(from, to)
9771
9772trim({text} [, {mask} [, {dir}]]) *trim()*
9773 Return {text} as a String where any character in {mask} is
9774 removed from the beginning and/or end of {text}.
9775
9776 If {mask} is not given, {mask} is all characters up to 0x20,
9777 which includes Tab, space, NL and CR, plus the non-breaking
9778 space character 0xa0.
9779
9780 The optional {dir} argument specifies where to remove the
9781 characters:
9782 0 remove from the beginning and end of {text}
9783 1 remove only at the beginning of {text}
9784 2 remove only at the end of {text}
9785 When omitted both ends are trimmed.
9786
9787 This function deals with multibyte characters properly.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009788 Returns an empty string on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009789
9790 Examples: >
9791 echo trim(" some text ")
9792< returns "some text" >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009793 echo trim(" \r\t\t\r RESERVE \t\n\x0B\xA0") .. "_TAIL"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009794< returns "RESERVE_TAIL" >
9795 echo trim("rm<Xrm<>X>rrm", "rm<>")
9796< returns "Xrm<>X" (characters in the middle are not removed) >
9797 echo trim(" vim ", " ", 2)
9798< returns " vim"
9799
9800 Can also be used as a |method|: >
9801 GetText()->trim()
9802
9803trunc({expr}) *trunc()*
9804 Return the largest integral value with magnitude less than or
9805 equal to {expr} as a |Float| (truncate towards zero).
9806 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009807 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009808 Examples: >
9809 echo trunc(1.456)
9810< 1.0 >
9811 echo trunc(-5.456)
9812< -5.0 >
9813 echo trunc(4.0)
9814< 4.0
9815
9816 Can also be used as a |method|: >
9817 Compute()->trunc()
9818<
9819 {only available when compiled with the |+float| feature}
9820
9821 *type()*
9822type({expr}) The result is a Number representing the type of {expr}.
9823 Instead of using the number directly, it is better to use the
9824 v:t_ variable that has the value:
9825 Number: 0 |v:t_number|
9826 String: 1 |v:t_string|
9827 Funcref: 2 |v:t_func|
9828 List: 3 |v:t_list|
9829 Dictionary: 4 |v:t_dict|
9830 Float: 5 |v:t_float|
9831 Boolean: 6 |v:t_bool| (v:false and v:true)
9832 None: 7 |v:t_none| (v:null and v:none)
9833 Job: 8 |v:t_job|
9834 Channel: 9 |v:t_channel|
9835 Blob: 10 |v:t_blob|
9836 For backward compatibility, this method can be used: >
9837 :if type(myvar) == type(0)
9838 :if type(myvar) == type("")
9839 :if type(myvar) == type(function("tr"))
9840 :if type(myvar) == type([])
9841 :if type(myvar) == type({})
9842 :if type(myvar) == type(0.0)
9843 :if type(myvar) == type(v:false)
9844 :if type(myvar) == type(v:none)
9845< To check if the v:t_ variables exist use this: >
9846 :if exists('v:t_number')
9847
9848< Can also be used as a |method|: >
9849 mylist->type()
9850
9851
9852typename({expr}) *typename()*
9853 Return a string representation of the type of {expr}.
9854 Example: >
9855 echo typename([1, 2, 3])
9856 list<number>
9857
9858
9859undofile({name}) *undofile()*
9860 Return the name of the undo file that would be used for a file
9861 with name {name} when writing. This uses the 'undodir'
9862 option, finding directories that exist. It does not check if
9863 the undo file exists.
9864 {name} is always expanded to the full path, since that is what
9865 is used internally.
9866 If {name} is empty undofile() returns an empty string, since a
9867 buffer without a file name will not write an undo file.
9868 Useful in combination with |:wundo| and |:rundo|.
9869 When compiled without the |+persistent_undo| option this always
9870 returns an empty string.
9871
9872 Can also be used as a |method|: >
9873 GetFilename()->undofile()
9874
9875undotree() *undotree()*
9876 Return the current state of the undo tree in a dictionary with
9877 the following items:
9878 "seq_last" The highest undo sequence number used.
9879 "seq_cur" The sequence number of the current position in
9880 the undo tree. This differs from "seq_last"
9881 when some changes were undone.
9882 "time_cur" Time last used for |:earlier| and related
9883 commands. Use |strftime()| to convert to
9884 something readable.
9885 "save_last" Number of the last file write. Zero when no
9886 write yet.
9887 "save_cur" Number of the current position in the undo
9888 tree.
9889 "synced" Non-zero when the last undo block was synced.
9890 This happens when waiting from input from the
9891 user. See |undo-blocks|.
9892 "entries" A list of dictionaries with information about
9893 undo blocks.
9894
9895 The first item in the "entries" list is the oldest undo item.
9896 Each List item is a |Dictionary| with these items:
9897 "seq" Undo sequence number. Same as what appears in
9898 |:undolist|.
9899 "time" Timestamp when the change happened. Use
9900 |strftime()| to convert to something readable.
9901 "newhead" Only appears in the item that is the last one
9902 that was added. This marks the last change
9903 and where further changes will be added.
9904 "curhead" Only appears in the item that is the last one
9905 that was undone. This marks the current
9906 position in the undo tree, the block that will
9907 be used by a redo command. When nothing was
9908 undone after the last change this item will
9909 not appear anywhere.
9910 "save" Only appears on the last block before a file
9911 write. The number is the write count. The
9912 first write has number 1, the last one the
9913 "save_last" mentioned above.
9914 "alt" Alternate entry. This is again a List of undo
9915 blocks. Each item may again have an "alt"
9916 item.
9917
9918uniq({list} [, {func} [, {dict}]]) *uniq()* *E882*
9919 Remove second and succeeding copies of repeated adjacent
9920 {list} items in-place. Returns {list}. If you want a list
9921 to remain unmodified make a copy first: >
9922 :let newlist = uniq(copy(mylist))
9923< The default compare function uses the string representation of
9924 each item. For the use of {func} and {dict} see |sort()|.
9925
Bram Moolenaard592deb2022-06-17 15:42:40 +01009926 Returns zero if {list} is not a |List|.
9927
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009928 Can also be used as a |method|: >
9929 mylist->uniq()
9930
9931values({dict}) *values()*
9932 Return a |List| with all the values of {dict}. The |List| is
9933 in arbitrary order. Also see |items()| and |keys()|.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009934 Returns zero if {dict} is not a |Dict|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009935
9936 Can also be used as a |method|: >
9937 mydict->values()
9938
LemonBoy0f7a3e12022-05-26 12:10:37 +01009939virtcol({expr} [, {list}]) *virtcol()*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009940 The result is a Number, which is the screen column of the file
9941 position given with {expr}. That is, the last screen position
9942 occupied by the character at that position, when the screen
9943 would be of unlimited width. When there is a <Tab> at the
9944 position, the returned Number will be the column at the end of
9945 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
9946 set to 8, it returns 8. |conceal| is ignored.
9947 For the byte position use |col()|.
LemonBoy0f7a3e12022-05-26 12:10:37 +01009948
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009949 For the use of {expr} see |col()|.
LemonBoy0f7a3e12022-05-26 12:10:37 +01009950
9951 When 'virtualedit' is used {expr} can be [lnum, col, off],
9952 where "off" is the offset in screen columns from the start of
9953 the character. E.g., a position within a <Tab> or after the
9954 last character. When "off" is omitted zero is used. When
9955 Virtual editing is active in the current mode, a position
9956 beyond the end of the line can be returned. Also see
9957 |'virtualedit'|
9958
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009959 The accepted positions are:
9960 . the cursor position
9961 $ the end of the cursor line (the result is the
9962 number of displayed characters in the cursor line
9963 plus one)
9964 'x position of mark x (if the mark is not set, 0 is
9965 returned)
9966 v In Visual mode: the start of the Visual area (the
9967 cursor is the end). When not in Visual mode
9968 returns the cursor position. Differs from |'<| in
9969 that it's updated right away.
LemonBoy0f7a3e12022-05-26 12:10:37 +01009970
9971 If {list} is present and non-zero then virtcol() returns a List
9972 with the first and last screen position occupied by the
9973 character.
9974
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009975 Note that only marks in the current file can be used.
9976 Examples: >
LemonBoy0f7a3e12022-05-26 12:10:37 +01009977 " With text "foo^Lbar" and cursor on the "^L":
9978
9979 virtcol(".") " returns 5
9980 virtcol(".", 1) " returns [4, 5]
9981 virtcol("$") " returns 9
9982
9983 " With text " there", with 't at 'h':
9984
9985 virtcol("'t") " returns 6
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009986< The first column is 1. 0 is returned for an error.
9987 A more advanced example that echoes the maximum length of
9988 all lines: >
9989 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
9990
9991< Can also be used as a |method|: >
9992 GetPos()->virtcol()
9993
Bram Moolenaar5a6ec102022-05-27 21:58:00 +01009994virtcol2col({winid}, {lnum}, {col}) *virtcol2col()*
9995 The result is a Number, which is the byte index of the
9996 character in window {winid} at buffer line {lnum} and virtual
9997 column {col}.
9998
9999 If {col} is greater than the last virtual column in line
10000 {lnum}, then the byte index of the character at the last
10001 virtual column is returned.
10002
10003 The {winid} argument can be the window number or the
10004 |window-ID|. If this is zero, then the current window is used.
10005
10006 Returns -1 if the window {winid} doesn't exist or the buffer
10007 line {lnum} or virtual column {col} is invalid.
10008
10009 See also |screenpos()|, |virtcol()| and |col()|.
10010
10011 Can also be used as a |method|: >
10012 GetWinid()->virtcol2col(lnum, col)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010013
10014visualmode([{expr}]) *visualmode()*
10015 The result is a String, which describes the last Visual mode
10016 used in the current buffer. Initially it returns an empty
10017 string, but once Visual mode has been used, it returns "v",
10018 "V", or "<CTRL-V>" (a single CTRL-V character) for
10019 character-wise, line-wise, or block-wise Visual mode
10020 respectively.
10021 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +000010022 :exe "normal " .. visualmode()
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010023< This enters the same Visual mode as before. It is also useful
10024 in scripts if you wish to act differently depending on the
10025 Visual mode that was used.
10026 If Visual mode is active, use |mode()| to get the Visual mode
10027 (e.g., in a |:vmap|).
10028 If {expr} is supplied and it evaluates to a non-zero Number or
10029 a non-empty String, then the Visual mode will be cleared and
10030 the old value is returned. See |non-zero-arg|.
10031
10032wildmenumode() *wildmenumode()*
10033 Returns |TRUE| when the wildmenu is active and |FALSE|
10034 otherwise. See 'wildmenu' and 'wildmode'.
10035 This can be used in mappings to handle the 'wildcharm' option
10036 gracefully. (Makes only sense with |mapmode-c| mappings).
10037
10038 For example to make <c-j> work like <down> in wildmode, use: >
10039 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
10040<
10041 (Note, this needs the 'wildcharm' option set appropriately).
10042
10043win_execute({id}, {command} [, {silent}]) *win_execute()*
10044 Like `execute()` but in the context of window {id}.
10045 The window will temporarily be made the current window,
10046 without triggering autocommands or changing directory. When
10047 executing {command} autocommands will be triggered, this may
10048 have unexpected side effects. Use |:noautocmd| if needed.
10049 Example: >
10050 call win_execute(winid, 'set syntax=python')
10051< Doing the same with `setwinvar()` would not trigger
10052 autocommands and not actually show syntax highlighting.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010053 *E994*
10054 Not all commands are allowed in popup windows.
10055 When window {id} does not exist then no error is given and
10056 an empty string is returned.
10057
10058 Can also be used as a |method|, the base is passed as the
10059 second argument: >
10060 GetCommand()->win_execute(winid)
10061
10062win_findbuf({bufnr}) *win_findbuf()*
10063 Returns a |List| with |window-ID|s for windows that contain
10064 buffer {bufnr}. When there is none the list is empty.
10065
10066 Can also be used as a |method|: >
10067 GetBufnr()->win_findbuf()
10068
10069win_getid([{win} [, {tab}]]) *win_getid()*
10070 Get the |window-ID| for the specified window.
10071 When {win} is missing use the current window.
10072 With {win} this is the window number. The top window has
10073 number 1.
10074 Without {tab} use the current tab, otherwise the tab with
10075 number {tab}. The first tab has number one.
10076 Return zero if the window cannot be found.
10077
10078 Can also be used as a |method|: >
10079 GetWinnr()->win_getid()
10080
10081
10082win_gettype([{nr}]) *win_gettype()*
10083 Return the type of the window:
10084 "autocmd" autocommand window. Temporary window
10085 used to execute autocommands.
10086 "command" command-line window |cmdwin|
10087 (empty) normal window
10088 "loclist" |location-list-window|
10089 "popup" popup window |popup|
10090 "preview" preview window |preview-window|
10091 "quickfix" |quickfix-window|
10092 "unknown" window {nr} not found
10093
10094 When {nr} is omitted return the type of the current window.
10095 When {nr} is given return the type of this window by number or
10096 |window-ID|.
10097
10098 Also see the 'buftype' option. When running a terminal in a
10099 popup window then 'buftype' is "terminal" and win_gettype()
10100 returns "popup".
10101
10102 Can also be used as a |method|: >
10103 GetWinid()->win_gettype()
10104<
10105win_gotoid({expr}) *win_gotoid()*
10106 Go to window with ID {expr}. This may also change the current
10107 tabpage.
10108 Return TRUE if successful, FALSE if the window cannot be found.
10109
10110 Can also be used as a |method|: >
10111 GetWinid()->win_gotoid()
10112
10113win_id2tabwin({expr}) *win_id2tabwin()*
10114 Return a list with the tab number and window number of window
10115 with ID {expr}: [tabnr, winnr].
10116 Return [0, 0] if the window cannot be found.
10117
10118 Can also be used as a |method|: >
10119 GetWinid()->win_id2tabwin()
10120
10121win_id2win({expr}) *win_id2win()*
10122 Return the window number of window with ID {expr}.
10123 Return 0 if the window cannot be found in the current tabpage.
10124
10125 Can also be used as a |method|: >
10126 GetWinid()->win_id2win()
10127
Daniel Steinbergee630312022-01-10 13:36:34 +000010128win_move_separator({nr}, {offset}) *win_move_separator()*
10129 Move window {nr}'s vertical separator (i.e., the right border)
10130 by {offset} columns, as if being dragged by the mouse. {nr}
10131 can be a window number or |window-ID|. A positive {offset}
10132 moves right and a negative {offset} moves left. Moving a
10133 window's vertical separator will change the width of the
10134 window and the width of other windows adjacent to the vertical
10135 separator. The magnitude of movement may be smaller than
10136 specified (e.g., as a consequence of maintaining
10137 'winminwidth'). Returns TRUE if the window can be found and
10138 FALSE otherwise.
Bram Moolenaard592deb2022-06-17 15:42:40 +010010139 This will fail for the rightmost window and a full-width
10140 window, since it has no separator on the right.
Daniel Steinbergee630312022-01-10 13:36:34 +000010141
10142 Can also be used as a |method|: >
10143 GetWinnr()->win_move_separator(offset)
10144
10145win_move_statusline({nr}, {offset}) *win_move_statusline()*
10146 Move window {nr}'s status line (i.e., the bottom border) by
10147 {offset} rows, as if being dragged by the mouse. {nr} can be a
10148 window number or |window-ID|. A positive {offset} moves down
10149 and a negative {offset} moves up. Moving a window's status
10150 line will change the height of the window and the height of
10151 other windows adjacent to the status line. The magnitude of
10152 movement may be smaller than specified (e.g., as a consequence
10153 of maintaining 'winminheight'). Returns TRUE if the window can
10154 be found and FALSE otherwise.
10155
10156 Can also be used as a |method|: >
10157 GetWinnr()->win_move_statusline(offset)
10158
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010159win_screenpos({nr}) *win_screenpos()*
10160 Return the screen position of window {nr} as a list with two
10161 numbers: [row, col]. The first window always has position
10162 [1, 1], unless there is a tabline, then it is [2, 1].
10163 {nr} can be the window number or the |window-ID|. Use zero
10164 for the current window.
10165 Returns [0, 0] if the window cannot be found in the current
10166 tabpage.
10167
10168 Can also be used as a |method|: >
10169 GetWinid()->win_screenpos()
10170<
10171win_splitmove({nr}, {target} [, {options}]) *win_splitmove()*
10172 Move the window {nr} to a new split of the window {target}.
10173 This is similar to moving to {target}, creating a new window
10174 using |:split| but having the same contents as window {nr}, and
10175 then closing {nr}.
10176
10177 Both {nr} and {target} can be window numbers or |window-ID|s.
10178 Both must be in the current tab page.
10179
10180 Returns zero for success, non-zero for failure.
10181
10182 {options} is a |Dictionary| with the following optional entries:
10183 "vertical" When TRUE, the split is created vertically,
10184 like with |:vsplit|.
10185 "rightbelow" When TRUE, the split is made below or to the
10186 right (if vertical). When FALSE, it is done
10187 above or to the left (if vertical). When not
10188 present, the values of 'splitbelow' and
10189 'splitright' are used.
10190
10191 Can also be used as a |method|: >
10192 GetWinid()->win_splitmove(target)
10193<
10194
10195 *winbufnr()*
10196winbufnr({nr}) The result is a Number, which is the number of the buffer
10197 associated with window {nr}. {nr} can be the window number or
10198 the |window-ID|.
10199 When {nr} is zero, the number of the buffer in the current
10200 window is returned.
10201 When window {nr} doesn't exist, -1 is returned.
10202 Example: >
10203 :echo "The file in the current window is " . bufname(winbufnr(0))
10204<
10205 Can also be used as a |method|: >
10206 FindWindow()->winbufnr()->bufname()
10207<
10208 *wincol()*
10209wincol() The result is a Number, which is the virtual column of the
10210 cursor in the window. This is counting screen cells from the
10211 left side of the window. The leftmost column is one.
10212
10213 *windowsversion()*
10214windowsversion()
10215 The result is a String. For MS-Windows it indicates the OS
10216 version. E.g, Windows 10 is "10.0", Windows 8 is "6.2",
10217 Windows XP is "5.1". For non-MS-Windows systems the result is
10218 an empty string.
10219
10220winheight({nr}) *winheight()*
10221 The result is a Number, which is the height of window {nr}.
10222 {nr} can be the window number or the |window-ID|.
10223 When {nr} is zero, the height of the current window is
10224 returned. When window {nr} doesn't exist, -1 is returned.
10225 An existing window always has a height of zero or more.
10226 This excludes any window toolbar line.
10227 Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +000010228 :echo "The current window has " .. winheight(0) .. " lines."
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010229
10230< Can also be used as a |method|: >
10231 GetWinid()->winheight()
10232<
10233winlayout([{tabnr}]) *winlayout()*
10234 The result is a nested List containing the layout of windows
10235 in a tabpage.
10236
10237 Without {tabnr} use the current tabpage, otherwise the tabpage
10238 with number {tabnr}. If the tabpage {tabnr} is not found,
10239 returns an empty list.
10240
10241 For a leaf window, it returns:
10242 ['leaf', {winid}]
10243 For horizontally split windows, which form a column, it
10244 returns:
10245 ['col', [{nested list of windows}]]
10246 For vertically split windows, which form a row, it returns:
10247 ['row', [{nested list of windows}]]
10248
10249 Example: >
10250 " Only one window in the tab page
10251 :echo winlayout()
10252 ['leaf', 1000]
10253 " Two horizontally split windows
10254 :echo winlayout()
10255 ['col', [['leaf', 1000], ['leaf', 1001]]]
10256 " The second tab page, with three horizontally split
10257 " windows, with two vertically split windows in the
10258 " middle window
10259 :echo winlayout(2)
10260 ['col', [['leaf', 1002], ['row', [['leaf', 1003],
10261 ['leaf', 1001]]], ['leaf', 1000]]]
10262<
10263 Can also be used as a |method|: >
10264 GetTabnr()->winlayout()
10265<
10266 *winline()*
10267winline() The result is a Number, which is the screen line of the cursor
10268 in the window. This is counting screen lines from the top of
10269 the window. The first line is one.
10270 If the cursor was moved the view on the file will be updated
10271 first, this may cause a scroll.
10272
10273 *winnr()*
10274winnr([{arg}]) The result is a Number, which is the number of the current
10275 window. The top window has number 1.
10276 Returns zero for a popup window.
10277
10278 The optional argument {arg} supports the following values:
10279 $ the number of the last window (the window
10280 count).
10281 # the number of the last accessed window (where
10282 |CTRL-W_p| goes to). If there is no previous
10283 window or it is in another tab page 0 is
10284 returned.
10285 {N}j the number of the Nth window below the
10286 current window (where |CTRL-W_j| goes to).
10287 {N}k the number of the Nth window above the current
10288 window (where |CTRL-W_k| goes to).
10289 {N}h the number of the Nth window left of the
10290 current window (where |CTRL-W_h| goes to).
10291 {N}l the number of the Nth window right of the
10292 current window (where |CTRL-W_l| goes to).
10293 The number can be used with |CTRL-W_w| and ":wincmd w"
10294 |:wincmd|.
Bram Moolenaar016188f2022-06-06 20:52:59 +010010295 When {arg} is invalid an error is given and zero is returned.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010296 Also see |tabpagewinnr()| and |win_getid()|.
10297 Examples: >
10298 let window_count = winnr('$')
10299 let prev_window = winnr('#')
10300 let wnum = winnr('3k')
10301
10302< Can also be used as a |method|: >
10303 GetWinval()->winnr()
10304<
10305 *winrestcmd()*
10306winrestcmd() Returns a sequence of |:resize| commands that should restore
10307 the current window sizes. Only works properly when no windows
10308 are opened or closed and the current window and tab page is
10309 unchanged.
10310 Example: >
10311 :let cmd = winrestcmd()
10312 :call MessWithWindowSizes()
10313 :exe cmd
10314<
10315 *winrestview()*
10316winrestview({dict})
10317 Uses the |Dictionary| returned by |winsaveview()| to restore
10318 the view of the current window.
10319 Note: The {dict} does not have to contain all values, that are
10320 returned by |winsaveview()|. If values are missing, those
10321 settings won't be restored. So you can use: >
10322 :call winrestview({'curswant': 4})
10323<
10324 This will only set the curswant value (the column the cursor
10325 wants to move on vertical movements) of the cursor to column 5
10326 (yes, that is 5), while all other settings will remain the
10327 same. This is useful, if you set the cursor position manually.
10328
10329 If you have changed the values the result is unpredictable.
10330 If the window size changed the result won't be the same.
10331
10332 Can also be used as a |method|: >
10333 GetView()->winrestview()
10334<
10335 *winsaveview()*
10336winsaveview() Returns a |Dictionary| that contains information to restore
10337 the view of the current window. Use |winrestview()| to
10338 restore the view.
10339 This is useful if you have a mapping that jumps around in the
10340 buffer and you want to go back to the original view.
10341 This does not save fold information. Use the 'foldenable'
10342 option to temporarily switch off folding, so that folds are
10343 not opened when moving around. This may have side effects.
10344 The return value includes:
10345 lnum cursor line number
10346 col cursor column (Note: the first column
naohiro ono56200ee2022-01-01 14:59:44 +000010347 zero, as opposed to what |getcurpos()|
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010348 returns)
10349 coladd cursor column offset for 'virtualedit'
naohiro ono56200ee2022-01-01 14:59:44 +000010350 curswant column for vertical movement (Note:
10351 the first column is zero, as opposed
10352 to what |getcurpos()| returns). After
10353 |$| command it will be a very large
10354 number equal to |v:maxcol|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010355 topline first line in the window
10356 topfill filler lines, only in diff mode
10357 leftcol first column displayed; only used when
10358 'wrap' is off
10359 skipcol columns skipped
10360 Note that no option values are saved.
10361
10362
10363winwidth({nr}) *winwidth()*
10364 The result is a Number, which is the width of window {nr}.
10365 {nr} can be the window number or the |window-ID|.
10366 When {nr} is zero, the width of the current window is
10367 returned. When window {nr} doesn't exist, -1 is returned.
10368 An existing window always has a width of zero or more.
10369 Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +000010370 :echo "The current window has " .. winwidth(0) .. " columns."
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010371 :if winwidth(0) <= 50
10372 : 50 wincmd |
10373 :endif
10374< For getting the terminal or screen size, see the 'columns'
10375 option.
10376
10377 Can also be used as a |method|: >
10378 GetWinid()->winwidth()
10379
10380
10381wordcount() *wordcount()*
10382 The result is a dictionary of byte/chars/word statistics for
10383 the current buffer. This is the same info as provided by
10384 |g_CTRL-G|
10385 The return value includes:
10386 bytes Number of bytes in the buffer
10387 chars Number of chars in the buffer
10388 words Number of words in the buffer
10389 cursor_bytes Number of bytes before cursor position
10390 (not in Visual mode)
10391 cursor_chars Number of chars before cursor position
10392 (not in Visual mode)
10393 cursor_words Number of words before cursor position
10394 (not in Visual mode)
10395 visual_bytes Number of bytes visually selected
10396 (only in Visual mode)
10397 visual_chars Number of chars visually selected
10398 (only in Visual mode)
10399 visual_words Number of words visually selected
10400 (only in Visual mode)
10401
10402
10403 *writefile()*
10404writefile({object}, {fname} [, {flags}])
10405 When {object} is a |List| write it to file {fname}. Each list
10406 item is separated with a NL. Each list item must be a String
10407 or Number.
10408 When {flags} contains "b" then binary mode is used: There will
10409 not be a NL after the last list item. An empty item at the
10410 end does cause the last line in the file to end in a NL.
10411
10412 When {object} is a |Blob| write the bytes to file {fname}
10413 unmodified.
10414
10415 When {flags} contains "a" then append mode is used, lines are
10416 appended to the file: >
10417 :call writefile(["foo"], "event.log", "a")
10418 :call writefile(["bar"], "event.log", "a")
10419<
10420 When {flags} contains "s" then fsync() is called after writing
10421 the file. This flushes the file to disk, if possible. This
10422 takes more time but avoids losing the file if the system
10423 crashes.
10424 When {flags} does not contain "S" or "s" then fsync() is
10425 called if the 'fsync' option is set.
10426 When {flags} contains "S" then fsync() is not called, even
10427 when 'fsync' is set.
10428
10429 All NL characters are replaced with a NUL character.
10430 Inserting CR characters needs to be done before passing {list}
10431 to writefile().
10432 An existing file is overwritten, if possible.
10433 When the write fails -1 is returned, otherwise 0. There is an
10434 error message if the file can't be created or when writing
10435 fails.
10436 Also see |readfile()|.
10437 To copy a file byte for byte: >
10438 :let fl = readfile("foo", "b")
10439 :call writefile(fl, "foocopy", "b")
10440
10441< Can also be used as a |method|: >
10442 GetText()->writefile("thefile")
10443
10444
10445xor({expr}, {expr}) *xor()*
10446 Bitwise XOR on the two arguments. The arguments are converted
10447 to a number. A List, Dict or Float argument causes an error.
Bram Moolenaar5a6ec102022-05-27 21:58:00 +010010448 Also see `and()` and `or()`.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010449 Example: >
10450 :let bits = xor(bits, 0x80)
10451<
10452 Can also be used as a |method|: >
10453 :let bits = bits->xor(0x80)
10454<
10455
10456==============================================================================
104573. Feature list *feature-list*
10458
10459There are three types of features:
104601. Features that are only supported when they have been enabled when Vim
10461 was compiled |+feature-list|. Example: >
10462 :if has("cindent")
10463< *gui_running*
104642. Features that are only supported when certain conditions have been met.
10465 Example: >
10466 :if has("gui_running")
10467< *has-patch*
104683. Beyond a certain version or at a certain version and including a specific
10469 patch. The "patch-7.4.248" feature means that the Vim version is 7.5 or
10470 later, or it is version 7.4 and patch 248 was included. Example: >
10471 :if has("patch-7.4.248")
10472< Note that it's possible for patch 248 to be omitted even though 249 is
10473 included. Only happens when cherry-picking patches.
10474 Note that this form only works for patch 7.4.237 and later, before that
10475 you need to check for the patch and the v:version. Example (checking
10476 version 6.2.148 or later): >
10477 :if v:version > 602 || (v:version == 602 && has("patch148"))
10478
10479Hint: To find out if Vim supports backslashes in a file name (MS-Windows),
10480use: `if exists('+shellslash')`
10481
10482
10483acl Compiled with |ACL| support.
10484all_builtin_terms Compiled with all builtin terminals enabled.
10485amiga Amiga version of Vim.
10486arabic Compiled with Arabic support |Arabic|.
10487arp Compiled with ARP support (Amiga).
10488autocmd Compiled with autocommand support. (always true)
10489autochdir Compiled with support for 'autochdir'
10490autoservername Automatically enable |clientserver|
10491balloon_eval Compiled with |balloon-eval| support.
10492balloon_multiline GUI supports multiline balloons.
10493beos BeOS version of Vim.
10494browse Compiled with |:browse| support, and browse() will
10495 work.
10496browsefilter Compiled with support for |browsefilter|.
10497bsd Compiled on an OS in the BSD family (excluding macOS).
10498builtin_terms Compiled with some builtin terminals.
10499byte_offset Compiled with support for 'o' in 'statusline'
10500channel Compiled with support for |channel| and |job|
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010501cindent Compiled with 'cindent' support. (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010502clientserver Compiled with remote invocation support |clientserver|.
10503clipboard Compiled with 'clipboard' support.
10504clipboard_working Compiled with 'clipboard' support and it can be used.
10505cmdline_compl Compiled with |cmdline-completion| support.
10506cmdline_hist Compiled with |cmdline-history| support.
10507cmdline_info Compiled with 'showcmd' and 'ruler' support.
10508comments Compiled with |'comments'| support.
10509compatible Compiled to be very Vi compatible.
10510conpty Platform where |ConPTY| can be used.
10511cryptv Compiled with encryption support |encryption|.
10512cscope Compiled with |cscope| support.
10513cursorbind Compiled with |'cursorbind'| (always true)
10514debug Compiled with "DEBUG" defined.
10515dialog_con Compiled with console dialog support.
10516dialog_gui Compiled with GUI dialog support.
10517diff Compiled with |vimdiff| and 'diff' support.
10518digraphs Compiled with support for digraphs.
10519directx Compiled with support for DirectX and 'renderoptions'.
10520dnd Compiled with support for the "~ register |quote_~|.
10521drop_file Compiled with |drop_file| support.
10522ebcdic Compiled on a machine with ebcdic character set.
10523emacs_tags Compiled with support for Emacs tags.
10524eval Compiled with expression evaluation support. Always
10525 true, of course!
10526ex_extra |+ex_extra| (always true)
10527extra_search Compiled with support for |'incsearch'| and
10528 |'hlsearch'|
10529farsi Support for Farsi was removed |farsi|.
10530file_in_path Compiled with support for |gf| and |<cfile>|
10531filterpipe When 'shelltemp' is off pipes are used for shell
10532 read/write/filter commands
10533find_in_path Compiled with support for include file searches
10534 |+find_in_path|.
10535float Compiled with support for |Float|.
10536fname_case Case in file names matters (for Amiga and MS-Windows
10537 this is not present).
10538folding Compiled with |folding| support.
10539footer Compiled with GUI footer support. |gui-footer|
10540fork Compiled to use fork()/exec() instead of system().
10541gettext Compiled with message translation |multi-lang|
10542gui Compiled with GUI enabled.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010010543gui_athena Compiled with Athena GUI (always false).
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010544gui_gnome Compiled with Gnome support (gui_gtk is also defined).
10545gui_gtk Compiled with GTK+ GUI (any version).
10546gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
10547gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined).
10548gui_haiku Compiled with Haiku GUI.
10549gui_mac Compiled with Macintosh GUI.
10550gui_motif Compiled with Motif GUI.
10551gui_photon Compiled with Photon GUI.
10552gui_running Vim is running in the GUI, or it will start soon.
10553gui_win32 Compiled with MS-Windows Win32 GUI.
10554gui_win32s idem, and Win32s system being used (Windows 3.1)
10555haiku Haiku version of Vim.
10556hangul_input Compiled with Hangul input support. |hangul|
10557hpux HP-UX version of Vim.
10558iconv Can use iconv() for conversion.
10559insert_expand Compiled with support for CTRL-X expansion commands in
10560 Insert mode. (always true)
10561job Compiled with support for |channel| and |job|
10562ipv6 Compiled with support for IPv6 networking in |channel|.
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010563jumplist Compiled with |jumplist| support. (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010564keymap Compiled with 'keymap' support.
10565lambda Compiled with |lambda| support.
10566langmap Compiled with 'langmap' support.
10567libcall Compiled with |libcall()| support.
10568linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and
10569 'breakindent' support.
10570linux Linux version of Vim.
10571lispindent Compiled with support for lisp indenting.
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010572 (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010573listcmds Compiled with commands for the buffer list |:files|
10574 and the argument list |arglist|.
10575localmap Compiled with local mappings and abbr. |:map-local|
10576lua Compiled with Lua interface |Lua|.
10577mac Any Macintosh version of Vim cf. osx
10578macunix Synonym for osxdarwin
10579menu Compiled with support for |:menu|.
10580mksession Compiled with support for |:mksession|.
10581modify_fname Compiled with file name modifiers. |filename-modifiers|
10582 (always true)
10583mouse Compiled with support for mouse.
10584mouse_dec Compiled with support for Dec terminal mouse.
10585mouse_gpm Compiled with support for gpm (Linux console mouse)
10586mouse_gpm_enabled GPM mouse is working
10587mouse_netterm Compiled with support for netterm mouse.
10588mouse_pterm Compiled with support for qnx pterm mouse.
10589mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
10590mouse_sgr Compiled with support for sgr mouse.
10591mouse_urxvt Compiled with support for urxvt mouse.
10592mouse_xterm Compiled with support for xterm mouse.
10593mouseshape Compiled with support for 'mouseshape'.
10594multi_byte Compiled with support for 'encoding' (always true)
10595multi_byte_encoding 'encoding' is set to a multibyte encoding.
10596multi_byte_ime Compiled with support for IME input method.
10597multi_lang Compiled with support for multiple languages.
10598mzscheme Compiled with MzScheme interface |mzscheme|.
10599nanotime Compiled with sub-second time stamp checks.
10600netbeans_enabled Compiled with support for |netbeans| and connected.
10601netbeans_intg Compiled with support for |netbeans|.
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010602num64 Compiled with 64-bit |Number| support. (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010603ole Compiled with OLE automation support for Win32.
10604osx Compiled for macOS cf. mac
10605osxdarwin Compiled for macOS, with |mac-darwin-feature|
10606packages Compiled with |packages| support.
10607path_extra Compiled with up/downwards search in 'path' and 'tags'
10608perl Compiled with Perl interface.
10609persistent_undo Compiled with support for persistent undo history.
10610postscript Compiled with PostScript file printing.
10611printer Compiled with |:hardcopy| support.
10612profile Compiled with |:profile| support.
10613python Python 2.x interface available. |has-python|
10614python_compiled Compiled with Python 2.x interface. |has-python|
10615python_dynamic Python 2.x interface is dynamically loaded. |has-python|
10616python3 Python 3.x interface available. |has-python|
10617python3_compiled Compiled with Python 3.x interface. |has-python|
10618python3_dynamic Python 3.x interface is dynamically loaded. |has-python|
10619pythonx Python 2.x and/or 3.x interface available. |python_x|
10620qnx QNX version of Vim.
10621quickfix Compiled with |quickfix| support.
10622reltime Compiled with |reltime()| support.
10623rightleft Compiled with 'rightleft' support.
10624ruby Compiled with Ruby interface |ruby|.
10625scrollbind Compiled with 'scrollbind' support. (always true)
10626showcmd Compiled with 'showcmd' support.
10627signs Compiled with |:sign| support.
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010628smartindent Compiled with 'smartindent' support. (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010629sodium Compiled with libsodium for better crypt support
10630sound Compiled with sound support, e.g. `sound_playevent()`
10631spell Compiled with spell checking support |spell|.
10632startuptime Compiled with |--startuptime| support.
10633statusline Compiled with support for 'statusline', 'rulerformat'
10634 and special formats of 'titlestring' and 'iconstring'.
10635sun SunOS version of Vim.
10636sun_workshop Support for Sun |workshop| has been removed.
10637syntax Compiled with syntax highlighting support |syntax|.
10638syntax_items There are active syntax highlighting items for the
10639 current buffer.
10640system Compiled to use system() instead of fork()/exec().
10641tag_binary Compiled with binary searching in tags files
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010642 |tag-binary-search|. (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010643tag_old_static Support for old static tags was removed, see
10644 |tag-old-static|.
10645tcl Compiled with Tcl interface.
10646termguicolors Compiled with true color in terminal support.
10647terminal Compiled with |terminal| support.
10648terminfo Compiled with terminfo instead of termcap.
10649termresponse Compiled with support for |t_RV| and |v:termresponse|.
10650textobjects Compiled with support for |text-objects|.
10651textprop Compiled with support for |text-properties|.
10652tgetent Compiled with tgetent support, able to use a termcap
10653 or terminfo file.
10654timers Compiled with |timer_start()| support.
10655title Compiled with window title support |'title'|.
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010656 (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010657toolbar Compiled with support for |gui-toolbar|.
10658ttyin input is a terminal (tty)
10659ttyout output is a terminal (tty)
10660unix Unix version of Vim. *+unix*
10661unnamedplus Compiled with support for "unnamedplus" in 'clipboard'
10662user_commands User-defined commands. (always true)
10663vartabs Compiled with variable tabstop support |'vartabstop'|.
10664vcon Win32: Virtual console support is working, can use
10665 'termguicolors'. Also see |+vtp|.
10666vertsplit Compiled with vertically split windows |:vsplit|.
10667 (always true)
10668vim_starting True while initial source'ing takes place. |startup|
10669 *vim_starting*
Bram Moolenaara6feb162022-01-02 12:06:33 +000010670vim9script Compiled with |Vim9| script support
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010671viminfo Compiled with viminfo support.
10672vimscript-1 Compiled Vim script version 1 support
10673vimscript-2 Compiled Vim script version 2 support
10674vimscript-3 Compiled Vim script version 3 support
Bram Moolenaar8a3b8052022-06-26 12:21:15 +010010675vimscript-4 Compiled Vim script version 4 support
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010676virtualedit Compiled with 'virtualedit' option. (always true)
10677visual Compiled with Visual mode. (always true)
10678visualextra Compiled with extra Visual mode commands. (always
10679 true) |blockwise-operators|.
10680vms VMS version of Vim.
10681vreplace Compiled with |gR| and |gr| commands. (always true)
10682vtp Compiled for vcon support |+vtp| (check vcon to find
10683 out if it works in the current console).
10684wildignore Compiled with 'wildignore' option.
10685wildmenu Compiled with 'wildmenu' option.
10686win16 old version for MS-Windows 3.1 (always false)
10687win32 Win32 version of Vim (MS-Windows 95 and later, 32 or
10688 64 bits)
10689win32unix Win32 version of Vim, using Unix files (Cygwin)
10690win64 Win64 version of Vim (MS-Windows 64 bit).
10691win95 Win32 version for MS-Windows 95/98/ME (always false)
10692winaltkeys Compiled with 'winaltkeys' option.
10693windows Compiled with support for more than one window.
10694 (always true)
10695writebackup Compiled with 'writebackup' default on.
10696xfontset Compiled with X fontset support |xfontset|.
10697xim Compiled with X input method support |xim|.
10698xpm Compiled with pixmap support.
10699xpm_w32 Compiled with pixmap support for Win32. (Only for
10700 backward compatibility. Use "xpm" instead.)
10701xsmp Compiled with X session management support.
10702xsmp_interact Compiled with interactive X session management support.
10703xterm_clipboard Compiled with support for xterm clipboard.
10704xterm_save Compiled with support for saving and restoring the
10705 xterm screen.
10706x11 Compiled with X11 support.
10707
10708
10709==============================================================================
107104. Matching a pattern in a String *string-match*
10711
10712This is common between several functions. A regexp pattern as explained at
10713|pattern| is normally used to find a match in the buffer lines. When a
10714pattern is used to find a match in a String, almost everything works in the
10715same way. The difference is that a String is handled like it is one line.
10716When it contains a "\n" character, this is not seen as a line break for the
10717pattern. It can be matched with a "\n" in the pattern, or with ".". Example:
10718>
10719 :let a = "aaaa\nxxxx"
10720 :echo matchstr(a, "..\n..")
10721 aa
10722 xx
10723 :echo matchstr(a, "a.x")
10724 a
10725 x
10726
10727Don't forget that "^" will only match at the first character of the String and
10728"$" at the last character of the string. They don't match after or before a
10729"\n".
10730
10731 vim:tw=78:ts=8:noet:ft=help:norl: