blob: 00ae665f8b35dfcfb8c903df869dccddae8a65ae [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
Yegappan Lakshmananf768c3d2022-08-22 13:15:13 +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
Yegappan Lakshmananf768c3d2022-08-22 13:15:13 +01004092getscriptinfo() *getscriptinfo()*
4093 Returns a |List| with information about all the sourced Vim
4094 scripts in the order they were sourced. (|:scriptinfo|)
4095
4096 Each item in the returned List is a |Dict| with the following
4097 items:
4098 autoload set to TRUE for a script that was used with
4099 |import autoload| but was not actually sourced
4100 yet.
4101 name vim script file name.
4102 sid script ID |<SID>|.
4103
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004104gettabinfo([{tabnr}]) *gettabinfo()*
4105 If {tabnr} is not specified, then information about all the
4106 tab pages is returned as a |List|. Each List item is a
4107 |Dictionary|. Otherwise, {tabnr} specifies the tab page
4108 number and information about that one is returned. If the tab
4109 page does not exist an empty List is returned.
4110
4111 Each List item is a |Dictionary| with the following entries:
4112 tabnr tab page number.
4113 variables a reference to the dictionary with
4114 tabpage-local variables
4115 windows List of |window-ID|s in the tab page.
4116
4117 Can also be used as a |method|: >
4118 GetTabnr()->gettabinfo()
4119
4120gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()*
4121 Get the value of a tab-local variable {varname} in tab page
4122 {tabnr}. |t:var|
4123 Tabs are numbered starting with one.
4124 The {varname} argument is a string. When {varname} is empty a
4125 dictionary with all tab-local variables is returned.
4126 Note that the name without "t:" must be used.
4127 When the tab or variable doesn't exist {def} or an empty
4128 string is returned, there is no error message.
4129
4130 Can also be used as a |method|: >
4131 GetTabnr()->gettabvar(varname)
4132
4133gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()*
4134 Get the value of window-local variable {varname} in window
4135 {winnr} in tab page {tabnr}.
4136 The {varname} argument is a string. When {varname} is empty a
4137 dictionary with all window-local variables is returned.
4138 When {varname} is equal to "&" get the values of all
4139 window-local options in a |Dictionary|.
4140 Otherwise, when {varname} starts with "&" get the value of a
4141 window-local option.
4142 Note that {varname} must be the name without "w:".
4143 Tabs are numbered starting with one. For the current tabpage
4144 use |getwinvar()|.
4145 {winnr} can be the window number or the |window-ID|.
4146 When {winnr} is zero the current window is used.
4147 This also works for a global option, buffer-local option and
4148 window-local option, but it doesn't work for a global variable
4149 or buffer-local variable.
4150 When the tab, window or variable doesn't exist {def} or an
4151 empty string is returned, there is no error message.
4152 Examples: >
4153 :let list_is_on = gettabwinvar(1, 2, '&list')
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004154 :echo "myvar = " .. gettabwinvar(3, 1, 'myvar')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004155<
4156 To obtain all window-local variables use: >
4157 gettabwinvar({tabnr}, {winnr}, '&')
4158
4159< Can also be used as a |method|: >
4160 GetTabnr()->gettabwinvar(winnr, varname)
4161
4162gettagstack([{winnr}]) *gettagstack()*
4163 The result is a Dict, which is the tag stack of window {winnr}.
4164 {winnr} can be the window number or the |window-ID|.
4165 When {winnr} is not specified, the current window is used.
4166 When window {winnr} doesn't exist, an empty Dict is returned.
4167
4168 The returned dictionary contains the following entries:
4169 curidx Current index in the stack. When at
4170 top of the stack, set to (length + 1).
4171 Index of bottom of the stack is 1.
4172 items List of items in the stack. Each item
4173 is a dictionary containing the
4174 entries described below.
4175 length Number of entries in the stack.
4176
4177 Each item in the stack is a dictionary with the following
4178 entries:
4179 bufnr buffer number of the current jump
4180 from cursor position before the tag jump.
4181 See |getpos()| for the format of the
4182 returned list.
4183 matchnr current matching tag number. Used when
4184 multiple matching tags are found for a
4185 name.
4186 tagname name of the tag
4187
4188 See |tagstack| for more information about the tag stack.
4189
4190 Can also be used as a |method|: >
4191 GetWinnr()->gettagstack()
4192
4193
4194gettext({text}) *gettext()*
4195 Translate String {text} if possible.
4196 This is mainly for use in the distributed Vim scripts. When
4197 generating message translations the {text} is extracted by
4198 xgettext, the translator can add the translated message in the
4199 .po file and Vim will lookup the translation when gettext() is
4200 called.
4201 For {text} double quoted strings are preferred, because
4202 xgettext does not understand escaping in single quoted
4203 strings.
4204
4205
4206getwininfo([{winid}]) *getwininfo()*
4207 Returns information about windows as a |List| with Dictionaries.
4208
4209 If {winid} is given Information about the window with that ID
4210 is returned, as a |List| with one item. If the window does not
4211 exist the result is an empty list.
4212
4213 Without {winid} information about all the windows in all the
4214 tab pages is returned.
4215
4216 Each List item is a |Dictionary| with the following entries:
4217 botline last complete displayed buffer line
4218 bufnr number of buffer in the window
4219 height window height (excluding winbar)
4220 loclist 1 if showing a location list
4221 {only with the +quickfix feature}
4222 quickfix 1 if quickfix or location list window
4223 {only with the +quickfix feature}
4224 terminal 1 if a terminal window
4225 {only with the +terminal feature}
4226 tabnr tab page number
4227 topline first displayed buffer line
4228 variables a reference to the dictionary with
4229 window-local variables
4230 width window width
4231 winbar 1 if the window has a toolbar, 0
4232 otherwise
4233 wincol leftmost screen column of the window;
4234 "col" from |win_screenpos()|
4235 textoff number of columns occupied by any
4236 'foldcolumn', 'signcolumn' and line
4237 number in front of the text
4238 winid |window-ID|
4239 winnr window number
4240 winrow topmost screen line of the window;
4241 "row" from |win_screenpos()|
4242
4243 Can also be used as a |method|: >
4244 GetWinnr()->getwininfo()
4245
4246getwinpos([{timeout}]) *getwinpos()*
4247 The result is a |List| with two numbers, the result of
4248 |getwinposx()| and |getwinposy()| combined:
4249 [x-pos, y-pos]
4250 {timeout} can be used to specify how long to wait in msec for
4251 a response from the terminal. When omitted 100 msec is used.
4252 Use a longer time for a remote terminal.
4253 When using a value less than 10 and no response is received
4254 within that time, a previously reported position is returned,
4255 if available. This can be used to poll for the position and
4256 do some work in the meantime: >
4257 while 1
4258 let res = getwinpos(1)
4259 if res[0] >= 0
4260 break
4261 endif
4262 " Do some work here
4263 endwhile
4264<
4265
4266 Can also be used as a |method|: >
4267 GetTimeout()->getwinpos()
4268<
4269 *getwinposx()*
4270getwinposx() The result is a Number, which is the X coordinate in pixels of
4271 the left hand side of the GUI Vim window. Also works for an
4272 xterm (uses a timeout of 100 msec).
4273 The result will be -1 if the information is not available.
4274 The value can be used with `:winpos`.
4275
4276 *getwinposy()*
4277getwinposy() The result is a Number, which is the Y coordinate in pixels of
4278 the top of the GUI Vim window. Also works for an xterm (uses
4279 a timeout of 100 msec).
4280 The result will be -1 if the information is not available.
4281 The value can be used with `:winpos`.
4282
4283getwinvar({winnr}, {varname} [, {def}]) *getwinvar()*
4284 Like |gettabwinvar()| for the current tabpage.
4285 Examples: >
4286 :let list_is_on = getwinvar(2, '&list')
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004287 :echo "myvar = " .. getwinvar(1, 'myvar')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004288
4289< Can also be used as a |method|: >
4290 GetWinnr()->getwinvar(varname)
4291<
4292glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()*
4293 Expand the file wildcards in {expr}. See |wildcards| for the
4294 use of special characters.
4295
4296 Unless the optional {nosuf} argument is given and is |TRUE|,
4297 the 'suffixes' and 'wildignore' options apply: Names matching
4298 one of the patterns in 'wildignore' will be skipped and
4299 'suffixes' affect the ordering of matches.
4300 'wildignorecase' always applies.
4301
4302 When {list} is present and it is |TRUE| the result is a |List|
4303 with all matching files. The advantage of using a List is,
4304 you also get filenames containing newlines correctly.
4305 Otherwise the result is a String and when there are several
4306 matches, they are separated by <NL> characters.
4307
4308 If the expansion fails, the result is an empty String or List.
4309
4310 You can also use |readdir()| if you need to do complicated
4311 things, such as limiting the number of matches.
4312
4313 A name for a non-existing file is not included. A symbolic
4314 link is only included if it points to an existing file.
4315 However, when the {alllinks} argument is present and it is
4316 |TRUE| then all symbolic links are included.
4317
4318 For most systems backticks can be used to get files names from
4319 any external command. Example: >
4320 :let tagfiles = glob("`find . -name tags -print`")
4321 :let &tags = substitute(tagfiles, "\n", ",", "g")
4322< The result of the program inside the backticks should be one
4323 item per line. Spaces inside an item are allowed.
4324
4325 See |expand()| for expanding special Vim variables. See
4326 |system()| for getting the raw output of an external command.
4327
4328 Can also be used as a |method|: >
4329 GetExpr()->glob()
4330
4331glob2regpat({string}) *glob2regpat()*
4332 Convert a file pattern, as used by glob(), into a search
4333 pattern. The result can be used to match with a string that
4334 is a file name. E.g. >
4335 if filename =~ glob2regpat('Make*.mak')
4336< This is equivalent to: >
4337 if filename =~ '^Make.*\.mak$'
4338< When {string} is an empty string the result is "^$", match an
4339 empty string.
4340 Note that the result depends on the system. On MS-Windows
4341 a backslash usually means a path separator.
4342
4343 Can also be used as a |method|: >
4344 GetExpr()->glob2regpat()
4345< *globpath()*
4346globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
4347 Perform glob() for String {expr} on all directories in {path}
4348 and concatenate the results. Example: >
4349 :echo globpath(&rtp, "syntax/c.vim")
4350<
4351 {path} is a comma-separated list of directory names. Each
4352 directory name is prepended to {expr} and expanded like with
4353 |glob()|. A path separator is inserted when needed.
4354 To add a comma inside a directory name escape it with a
4355 backslash. Note that on MS-Windows a directory may have a
4356 trailing backslash, remove it if you put a comma after it.
4357 If the expansion fails for one of the directories, there is no
4358 error message.
4359
4360 Unless the optional {nosuf} argument is given and is |TRUE|,
4361 the 'suffixes' and 'wildignore' options apply: Names matching
4362 one of the patterns in 'wildignore' will be skipped and
4363 'suffixes' affect the ordering of matches.
4364
4365 When {list} is present and it is |TRUE| the result is a |List|
4366 with all matching files. The advantage of using a List is, you
4367 also get filenames containing newlines correctly. Otherwise
4368 the result is a String and when there are several matches,
4369 they are separated by <NL> characters. Example: >
4370 :echo globpath(&rtp, "syntax/c.vim", 0, 1)
4371<
4372 {alllinks} is used as with |glob()|.
4373
4374 The "**" item can be used to search in a directory tree.
4375 For example, to find all "README.txt" files in the directories
4376 in 'runtimepath' and below: >
4377 :echo globpath(&rtp, "**/README.txt")
4378< Upwards search and limiting the depth of "**" is not
4379 supported, thus using 'path' will not always work properly.
4380
4381 Can also be used as a |method|, the base is passed as the
4382 second argument: >
4383 GetExpr()->globpath(&rtp)
4384<
4385 *has()*
4386has({feature} [, {check}])
4387 When {check} is omitted or is zero: The result is a Number,
4388 which is 1 if the feature {feature} is supported, zero
4389 otherwise. The {feature} argument is a string, case is
4390 ignored. See |feature-list| below.
4391
4392 When {check} is present and not zero: The result is a Number,
4393 which is 1 if the feature {feature} could ever be supported,
4394 zero otherwise. This is useful to check for a typo in
4395 {feature} and to detect dead code. Keep in mind that an older
4396 Vim version will not know about a feature added later and
4397 features that have been abandoned will not be known by the
4398 current Vim version.
4399
4400 Also see |exists()| and |exists_compiled()|.
4401
4402 Note that to skip code that has a syntax error when the
4403 feature is not available, Vim may skip the rest of the line
4404 and miss a following `endif`. Therefore put the `endif` on a
4405 separate line: >
4406 if has('feature')
4407 let x = this->breaks->without->the->feature
4408 endif
4409< If the `endif` would be moved to the second line as "| endif" it
4410 would not be found.
4411
4412
4413has_key({dict}, {key}) *has_key()*
4414 The result is a Number, which is TRUE if |Dictionary| {dict}
Bram Moolenaare8008642022-08-19 17:15:35 +01004415 has an entry with key {key}. FALSE otherwise.
4416 The {key} argument is a string. In |Vim9| script a number is
4417 also accepted (and converted to a string) but no other types.
4418 In legacy script the usual automatic conversion to string is
4419 done.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004420
4421 Can also be used as a |method|: >
4422 mydict->has_key(key)
4423
4424haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()*
4425 The result is a Number:
4426 1 when the window has set a local directory via |:lcd|
4427 2 when the tab-page has set a local directory via |:tcd|
4428 0 otherwise.
4429
4430 Without arguments use the current window.
4431 With {winnr} use this window in the current tab page.
4432 With {winnr} and {tabnr} use the window in the specified tab
4433 page.
4434 {winnr} can be the window number or the |window-ID|.
4435 If {winnr} is -1 it is ignored and only the tabpage is used.
4436 Return 0 if the arguments are invalid.
4437 Examples: >
4438 if haslocaldir() == 1
4439 " window local directory case
4440 elseif haslocaldir() == 2
4441 " tab-local directory case
4442 else
4443 " global directory case
4444 endif
4445
4446 " current window
4447 :echo haslocaldir()
4448 :echo haslocaldir(0)
4449 :echo haslocaldir(0, 0)
4450 " window n in current tab page
4451 :echo haslocaldir(n)
4452 :echo haslocaldir(n, 0)
4453 " window n in tab page m
4454 :echo haslocaldir(n, m)
4455 " tab page m
4456 :echo haslocaldir(-1, m)
4457<
4458 Can also be used as a |method|: >
4459 GetWinnr()->haslocaldir()
4460
4461hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
4462 The result is a Number, which is TRUE if there is a mapping
4463 that contains {what} in somewhere in the rhs (what it is
4464 mapped to) and this mapping exists in one of the modes
4465 indicated by {mode}.
4466 The arguments {what} and {mode} are strings.
4467 When {abbr} is there and it is |TRUE| use abbreviations
4468 instead of mappings. Don't forget to specify Insert and/or
4469 Command-line mode.
4470 Both the global mappings and the mappings local to the current
4471 buffer are checked for a match.
4472 If no matching mapping is found FALSE is returned.
4473 The following characters are recognized in {mode}:
4474 n Normal mode
4475 v Visual and Select mode
4476 x Visual mode
4477 s Select mode
4478 o Operator-pending mode
4479 i Insert mode
4480 l Language-Argument ("r", "f", "t", etc.)
4481 c Command-line mode
4482 When {mode} is omitted, "nvo" is used.
4483
4484 This function is useful to check if a mapping already exists
4485 to a function in a Vim script. Example: >
4486 :if !hasmapto('\ABCdoit')
4487 : map <Leader>d \ABCdoit
4488 :endif
4489< This installs the mapping to "\ABCdoit" only if there isn't
4490 already a mapping to "\ABCdoit".
4491
4492 Can also be used as a |method|: >
4493 GetRHS()->hasmapto()
4494
4495histadd({history}, {item}) *histadd()*
4496 Add the String {item} to the history {history} which can be
4497 one of: *hist-names*
4498 "cmd" or ":" command line history
4499 "search" or "/" search pattern history
4500 "expr" or "=" typed expression history
4501 "input" or "@" input line history
4502 "debug" or ">" debug command history
4503 empty the current or last used history
4504 The {history} string does not need to be the whole name, one
4505 character is sufficient.
4506 If {item} does already exist in the history, it will be
4507 shifted to become the newest entry.
4508 The result is a Number: TRUE if the operation was successful,
4509 otherwise FALSE is returned.
4510
4511 Example: >
4512 :call histadd("input", strftime("%Y %b %d"))
4513 :let date=input("Enter date: ")
4514< This function is not available in the |sandbox|.
4515
4516 Can also be used as a |method|, the base is passed as the
4517 second argument: >
4518 GetHistory()->histadd('search')
4519
4520histdel({history} [, {item}]) *histdel()*
4521 Clear {history}, i.e. delete all its entries. See |hist-names|
4522 for the possible values of {history}.
4523
4524 If the parameter {item} evaluates to a String, it is used as a
4525 regular expression. All entries matching that expression will
4526 be removed from the history (if there are any).
4527 Upper/lowercase must match, unless "\c" is used |/\c|.
4528 If {item} evaluates to a Number, it will be interpreted as
4529 an index, see |:history-indexing|. The respective entry will
4530 be removed if it exists.
4531
4532 The result is TRUE for a successful operation, otherwise FALSE
4533 is returned.
4534
4535 Examples:
4536 Clear expression register history: >
4537 :call histdel("expr")
4538<
4539 Remove all entries starting with "*" from the search history: >
4540 :call histdel("/", '^\*')
4541<
4542 The following three are equivalent: >
4543 :call histdel("search", histnr("search"))
4544 :call histdel("search", -1)
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004545 :call histdel("search", '^' .. histget("search", -1) .. '$')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004546<
4547 To delete the last search pattern and use the last-but-one for
4548 the "n" command and 'hlsearch': >
4549 :call histdel("search", -1)
4550 :let @/ = histget("search", -1)
4551<
4552 Can also be used as a |method|: >
4553 GetHistory()->histdel()
4554
4555histget({history} [, {index}]) *histget()*
4556 The result is a String, the entry with Number {index} from
4557 {history}. See |hist-names| for the possible values of
4558 {history}, and |:history-indexing| for {index}. If there is
4559 no such entry, an empty String is returned. When {index} is
4560 omitted, the most recent item from the history is used.
4561
4562 Examples:
4563 Redo the second last search from history. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004564 :execute '/' .. histget("search", -2)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004565
4566< Define an Ex command ":H {num}" that supports re-execution of
4567 the {num}th entry from the output of |:history|. >
4568 :command -nargs=1 H execute histget("cmd", 0+<args>)
4569<
4570 Can also be used as a |method|: >
4571 GetHistory()->histget()
4572
4573histnr({history}) *histnr()*
4574 The result is the Number of the current entry in {history}.
4575 See |hist-names| for the possible values of {history}.
4576 If an error occurred, -1 is returned.
4577
4578 Example: >
4579 :let inp_index = histnr("expr")
4580
4581< Can also be used as a |method|: >
4582 GetHistory()->histnr()
4583<
4584hlexists({name}) *hlexists()*
4585 The result is a Number, which is TRUE if a highlight group
4586 called {name} exists. This is when the group has been
4587 defined in some way. Not necessarily when highlighting has
4588 been defined for it, it may also have been used for a syntax
4589 item.
4590 *highlight_exists()*
4591 Obsolete name: highlight_exists().
4592
4593 Can also be used as a |method|: >
4594 GetName()->hlexists()
4595<
4596hlget([{name} [, {resolve}]]) *hlget()*
4597 Returns a List of all the highlight group attributes. If the
4598 optional {name} is specified, then returns a List with only
4599 the attributes of the specified highlight group. Returns an
4600 empty List if the highlight group {name} is not present.
4601
4602 If the optional {resolve} argument is set to v:true and the
4603 highlight group {name} is linked to another group, then the
4604 link is resolved recursively and the attributes of the
4605 resolved highlight group are returned.
4606
4607 Each entry in the returned List is a Dictionary with the
4608 following items:
4609 cleared boolean flag, set to v:true if the highlight
4610 group attributes are cleared or not yet
4611 specified. See |highlight-clear|.
4612 cterm cterm attributes. See |highlight-cterm|.
4613 ctermbg cterm background color.
4614 See |highlight-ctermbg|.
4615 ctermfg cterm foreground color.
4616 See |highlight-ctermfg|.
4617 ctermul cterm underline color. See |highlight-ctermul|.
4618 default boolean flag, set to v:true if the highlight
4619 group link is a default link. See
4620 |highlight-default|.
4621 font highlight group font. See |highlight-font|.
4622 gui gui attributes. See |highlight-gui|.
4623 guibg gui background color. See |highlight-guibg|.
4624 guifg gui foreground color. See |highlight-guifg|.
4625 guisp gui special color. See |highlight-guisp|.
4626 id highlight group ID.
4627 linksto linked highlight group name.
4628 See |:highlight-link|.
4629 name highlight group name. See |group-name|.
4630 start start terminal keycode. See |highlight-start|.
4631 stop stop terminal keycode. See |highlight-stop|.
4632 term term attributes. See |highlight-term|.
4633
4634 The 'term', 'cterm' and 'gui' items in the above Dictionary
4635 have a dictionary value with the following optional boolean
4636 items: 'bold', 'standout', 'underline', 'undercurl', 'italic',
4637 'reverse', 'inverse' and 'strikethrough'.
4638
4639 Example(s): >
4640 :echo hlget()
4641 :echo hlget('ModeMsg')
4642 :echo hlget('Number', v:true)
4643<
4644 Can also be used as a |method|: >
4645 GetName()->hlget()
4646<
4647hlset({list}) *hlset()*
4648 Creates or modifies the attributes of a List of highlight
4649 groups. Each item in {list} is a dictionary containing the
4650 attributes of a highlight group. See |hlget()| for the list of
4651 supported items in this dictionary.
4652
4653 In addition to the items described in |hlget()|, the following
4654 additional items are supported in the dictionary:
4655
4656 force boolean flag to force the creation of
4657 a link for an existing highlight group
4658 with attributes.
4659
4660 The highlight group is identified using the 'name' item and
4661 the 'id' item (if supplied) is ignored. If a highlight group
4662 with a specified name doesn't exist, then it is created.
4663 Otherwise the attributes of an existing highlight group are
4664 modified.
4665
4666 If an empty dictionary value is used for the 'term' or 'cterm'
4667 or 'gui' entries, then the corresponding attributes are
4668 cleared. If the 'cleared' item is set to v:true, then all the
4669 attributes of the highlight group are cleared.
4670
4671 The 'linksto' item can be used to link a highlight group to
4672 another highlight group. See |:highlight-link|.
4673
4674 Returns zero for success, -1 for failure.
4675
4676 Example(s): >
4677 " add bold attribute to the Visual highlight group
4678 :call hlset([#{name: 'Visual',
4679 \ term: #{reverse: 1 , bold: 1}}])
4680 :call hlset([#{name: 'Type', guifg: 'DarkGreen'}])
4681 :let l = hlget()
4682 :call hlset(l)
4683 " clear the Search highlight group
4684 :call hlset([#{name: 'Search', cleared: v:true}])
4685 " clear the 'term' attributes for a highlight group
4686 :call hlset([#{name: 'Title', term: {}}])
4687 " create the MyHlg group linking it to DiffAdd
4688 :call hlset([#{name: 'MyHlg', linksto: 'DiffAdd'}])
4689 " remove the MyHlg group link
4690 :call hlset([#{name: 'MyHlg', linksto: 'NONE'}])
4691 " clear the attributes and a link
4692 :call hlset([#{name: 'MyHlg', cleared: v:true,
4693 \ linksto: 'NONE'}])
4694<
4695 Can also be used as a |method|: >
4696 GetAttrList()->hlset()
4697<
4698 *hlID()*
4699hlID({name}) The result is a Number, which is the ID of the highlight group
4700 with name {name}. When the highlight group doesn't exist,
4701 zero is returned.
4702 This can be used to retrieve information about the highlight
4703 group. For example, to get the background color of the
4704 "Comment" group: >
4705 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
4706< *highlightID()*
4707 Obsolete name: highlightID().
4708
4709 Can also be used as a |method|: >
4710 GetName()->hlID()
4711
4712hostname() *hostname()*
4713 The result is a String, which is the name of the machine on
4714 which Vim is currently running. Machine names greater than
4715 256 characters long are truncated.
4716
4717iconv({string}, {from}, {to}) *iconv()*
4718 The result is a String, which is the text {string} converted
4719 from encoding {from} to encoding {to}.
4720 When the conversion completely fails an empty string is
4721 returned. When some characters could not be converted they
4722 are replaced with "?".
4723 The encoding names are whatever the iconv() library function
4724 can accept, see ":!man 3 iconv".
4725 Most conversions require Vim to be compiled with the |+iconv|
4726 feature. Otherwise only UTF-8 to latin1 conversion and back
4727 can be done.
4728 This can be used to display messages with special characters,
4729 no matter what 'encoding' is set to. Write the message in
4730 UTF-8 and use: >
4731 echo iconv(utf8_str, "utf-8", &enc)
4732< Note that Vim uses UTF-8 for all Unicode encodings, conversion
4733 from/to UCS-2 is automatically changed to use UTF-8. You
4734 cannot use UCS-2 in a string anyway, because of the NUL bytes.
4735
4736 Can also be used as a |method|: >
4737 GetText()->iconv('latin1', 'utf-8')
4738<
4739 *indent()*
4740indent({lnum}) The result is a Number, which is indent of line {lnum} in the
4741 current buffer. The indent is counted in spaces, the value
4742 of 'tabstop' is relevant. {lnum} is used just like in
4743 |getline()|.
4744 When {lnum} is invalid -1 is returned. In |Vim9| script an
4745 error is given.
4746
4747 Can also be used as a |method|: >
4748 GetLnum()->indent()
4749
4750index({object}, {expr} [, {start} [, {ic}]]) *index()*
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004751 Find {expr} in {object} and return its index. See
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004752 |indexof()| for using a lambda to select the item.
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004753
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004754 If {object} is a |List| return the lowest index where the item
4755 has a value equal to {expr}. There is no automatic
4756 conversion, so the String "4" is different from the Number 4.
4757 And the number 4 is different from the Float 4.0. The value
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004758 of 'ignorecase' is not used here, case matters as indicated by
4759 the {ic} argument.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004760
4761 If {object} is |Blob| return the lowest index where the byte
4762 value is equal to {expr}.
4763
4764 If {start} is given then start looking at the item with index
4765 {start} (may be negative for an item relative to the end).
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004766
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004767 When {ic} is given and it is |TRUE|, ignore case. Otherwise
4768 case must match.
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004769
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004770 -1 is returned when {expr} is not found in {object}.
4771 Example: >
4772 :let idx = index(words, "the")
4773 :if index(numbers, 123) >= 0
4774
4775< Can also be used as a |method|: >
4776 GetObject()->index(what)
4777
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004778indexof({object}, {expr} [, {opts}]) *indexof()*
4779 Returns the index of an item in {object} where {expr} is
4780 v:true. {object} must be a |List| or a |Blob|.
4781
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004782 If {object} is a |List|, evaluate {expr} for each item in the
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004783 List until the expression is v:true and return the index of
4784 this item.
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004785
4786 If {object} is a |Blob| evaluate {expr} for each byte in the
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004787 Blob until the expression is v:true and return the index of
4788 this byte.
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004789
4790 {expr} must be a |string| or |Funcref|.
4791
4792 If {expr} is a |string|: If {object} is a |List|, inside
4793 {expr} |v:key| has the index of the current List item and
4794 |v:val| has the value of the item. If {object} is a |Blob|,
4795 inside {expr} |v:key| has the index of the current byte and
4796 |v:val| has the byte value.
4797
4798 If {expr} is a |Funcref| it must take two arguments:
4799 1. the key or the index of the current item.
4800 2. the value of the current item.
4801 The function must return |TRUE| if the item is found and the
4802 search should stop.
4803
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004804 The optional argument {opts} is a Dict and supports the
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004805 following items:
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004806 startidx start evaluating {expr} at the item with this
4807 index; may be negative for an item relative to
4808 the end
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004809 Returns -1 when {expr} evaluates to v:false for all the items.
4810 Example: >
Yegappan Lakshmanan3fbf6cd2022-08-13 21:35:13 +01004811 :let l = [#{n: 10}, #{n: 20}, #{n: 30}]
4812 :echo indexof(l, "v:val.n == 20")
4813 :echo indexof(l, {i, v -> v.n == 30})
4814 :echo indexof(l, "v:val.n == 20", #{startidx: 1})
Yegappan Lakshmananb2186552022-08-13 13:09:20 +01004815
4816< Can also be used as a |method|: >
4817 mylist->indexof(expr)
4818
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004819input({prompt} [, {text} [, {completion}]]) *input()*
4820 The result is a String, which is whatever the user typed on
4821 the command-line. The {prompt} argument is either a prompt
4822 string, or a blank string (for no prompt). A '\n' can be used
4823 in the prompt to start a new line.
4824 The highlighting set with |:echohl| is used for the prompt.
4825 The input is entered just like a command-line, with the same
4826 editing commands and mappings. There is a separate history
4827 for lines typed for input().
4828 Example: >
4829 :if input("Coffee or beer? ") == "beer"
4830 : echo "Cheers!"
4831 :endif
4832<
4833 If the optional {text} argument is present and not empty, this
4834 is used for the default reply, as if the user typed this.
4835 Example: >
4836 :let color = input("Color? ", "white")
4837
4838< The optional {completion} argument specifies the type of
4839 completion supported for the input. Without it completion is
4840 not performed. The supported completion types are the same as
4841 that can be supplied to a user-defined command using the
4842 "-complete=" argument. Refer to |:command-completion| for
4843 more information. Example: >
4844 let fname = input("File: ", "", "file")
4845<
4846 NOTE: This function must not be used in a startup file, for
4847 the versions that only run in GUI mode (e.g., the Win32 GUI).
4848 Note: When input() is called from within a mapping it will
4849 consume remaining characters from that mapping, because a
4850 mapping is handled like the characters were typed.
4851 Use |inputsave()| before input() and |inputrestore()|
4852 after input() to avoid that. Another solution is to avoid
4853 that further characters follow in the mapping, e.g., by using
4854 |:execute| or |:normal|.
4855
4856 Example with a mapping: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004857 :nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR>
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004858 :function GetFoo()
4859 : call inputsave()
4860 : let g:Foo = input("enter search pattern: ")
4861 : call inputrestore()
4862 :endfunction
4863
4864< Can also be used as a |method|: >
4865 GetPrompt()->input()
4866
4867inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
4868 Like |input()|, but when the GUI is running and text dialogs
4869 are supported, a dialog window pops up to input the text.
4870 Example: >
4871 :let n = inputdialog("value for shiftwidth", shiftwidth())
4872 :if n != ""
4873 : let &sw = n
4874 :endif
4875< When the dialog is cancelled {cancelreturn} is returned. When
4876 omitted an empty string is returned.
4877 Hitting <Enter> works like pressing the OK button. Hitting
4878 <Esc> works like pressing the Cancel button.
4879 NOTE: Command-line completion is not supported.
4880
4881 Can also be used as a |method|: >
4882 GetPrompt()->inputdialog()
4883
4884inputlist({textlist}) *inputlist()*
4885 {textlist} must be a |List| of strings. This |List| is
4886 displayed, one string per line. The user will be prompted to
4887 enter a number, which is returned.
4888 The user can also select an item by clicking on it with the
4889 mouse, if the mouse is enabled in the command line ('mouse' is
4890 "a" or includes "c"). For the first string 0 is returned.
4891 When clicking above the first item a negative number is
4892 returned. When clicking on the prompt one more than the
4893 length of {textlist} is returned.
4894 Make sure {textlist} has less than 'lines' entries, otherwise
4895 it won't work. It's a good idea to put the entry number at
4896 the start of the string. And put a prompt in the first item.
4897 Example: >
4898 let color = inputlist(['Select color:', '1. red',
4899 \ '2. green', '3. blue'])
4900
4901< Can also be used as a |method|: >
4902 GetChoices()->inputlist()
4903
4904inputrestore() *inputrestore()*
4905 Restore typeahead that was saved with a previous |inputsave()|.
4906 Should be called the same number of times inputsave() is
4907 called. Calling it more often is harmless though.
4908 Returns TRUE when there is nothing to restore, FALSE otherwise.
4909
4910inputsave() *inputsave()*
4911 Preserve typeahead (also from mappings) and clear it, so that
4912 a following prompt gets input from the user. Should be
4913 followed by a matching inputrestore() after the prompt. Can
4914 be used several times, in which case there must be just as
4915 many inputrestore() calls.
4916 Returns TRUE when out of memory, FALSE otherwise.
4917
4918inputsecret({prompt} [, {text}]) *inputsecret()*
4919 This function acts much like the |input()| function with but
4920 two exceptions:
4921 a) the user's response will be displayed as a sequence of
4922 asterisks ("*") thereby keeping the entry secret, and
4923 b) the user's response will not be recorded on the input
4924 |history| stack.
4925 The result is a String, which is whatever the user actually
4926 typed on the command-line in response to the issued prompt.
4927 NOTE: Command-line completion is not supported.
4928
4929 Can also be used as a |method|: >
4930 GetPrompt()->inputsecret()
4931
4932insert({object}, {item} [, {idx}]) *insert()*
4933 When {object} is a |List| or a |Blob| insert {item} at the start
4934 of it.
4935
4936 If {idx} is specified insert {item} before the item with index
4937 {idx}. If {idx} is zero it goes before the first item, just
4938 like omitting {idx}. A negative {idx} is also possible, see
4939 |list-index|. -1 inserts just before the last item.
4940
4941 Returns the resulting |List| or |Blob|. Examples: >
4942 :let mylist = insert([2, 3, 5], 1)
4943 :call insert(mylist, 4, -1)
4944 :call insert(mylist, 6, len(mylist))
4945< The last example can be done simpler with |add()|.
4946 Note that when {item} is a |List| it is inserted as a single
4947 item. Use |extend()| to concatenate |Lists|.
4948
4949 Can also be used as a |method|: >
4950 mylist->insert(item)
4951
4952interrupt() *interrupt()*
4953 Interrupt script execution. It works more or less like the
4954 user typing CTRL-C, most commands won't execute and control
4955 returns to the user. This is useful to abort execution
4956 from lower down, e.g. in an autocommand. Example: >
4957 :function s:check_typoname(file)
4958 : if fnamemodify(a:file, ':t') == '['
4959 : echomsg 'Maybe typo'
4960 : call interrupt()
4961 : endif
4962 :endfunction
4963 :au BufWritePre * call s:check_typoname(expand('<amatch>'))
4964
4965invert({expr}) *invert()*
4966 Bitwise invert. The argument is converted to a number. A
4967 List, Dict or Float argument causes an error. Example: >
4968 :let bits = invert(bits)
4969< Can also be used as a |method|: >
4970 :let bits = bits->invert()
4971
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004972isabsolutepath({path}) *isabsolutepath()*
LemonBoydca1d402022-04-28 15:26:33 +01004973 The result is a Number, which is |TRUE| when {path} is an
4974 absolute path.
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004975 On Unix, a path is considered absolute when it starts with '/'.
LemonBoydca1d402022-04-28 15:26:33 +01004976 On MS-Windows, it is considered absolute when it starts with an
4977 optional drive prefix and is followed by a '\' or '/'. UNC paths
4978 are always absolute.
4979 Example: >
4980 echo isabsolutepath('/usr/share/') " 1
4981 echo isabsolutepath('./foobar') " 0
4982 echo isabsolutepath('C:\Windows') " 1
4983 echo isabsolutepath('foobar') " 0
4984 echo isabsolutepath('\\remote\file') " 1
Bram Moolenaar8a3b8052022-06-26 12:21:15 +01004985<
LemonBoydca1d402022-04-28 15:26:33 +01004986 Can also be used as a |method|: >
4987 GetName()->isabsolutepath()
4988
4989
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004990isdirectory({directory}) *isdirectory()*
4991 The result is a Number, which is |TRUE| when a directory
4992 with the name {directory} exists. If {directory} doesn't
4993 exist, or isn't a directory, the result is |FALSE|. {directory}
4994 is any expression, which is used as a String.
4995
4996 Can also be used as a |method|: >
4997 GetName()->isdirectory()
4998
4999isinf({expr}) *isinf()*
5000 Return 1 if {expr} is a positive infinity, or -1 a negative
5001 infinity, otherwise 0. >
5002 :echo isinf(1.0 / 0.0)
5003< 1 >
5004 :echo isinf(-1.0 / 0.0)
5005< -1
5006
5007 Can also be used as a |method|: >
5008 Compute()->isinf()
5009<
5010 {only available when compiled with the |+float| feature}
5011
5012islocked({expr}) *islocked()* *E786*
5013 The result is a Number, which is |TRUE| when {expr} is the
5014 name of a locked variable.
5015 The string argument {expr} must be the name of a variable,
5016 |List| item or |Dictionary| entry, not the variable itself!
5017 Example: >
5018 :let alist = [0, ['a', 'b'], 2, 3]
5019 :lockvar 1 alist
5020 :echo islocked('alist') " 1
5021 :echo islocked('alist[1]') " 0
5022
Bram Moolenaar9da17d72022-02-09 21:50:44 +00005023< When {expr} is a variable that does not exist -1 is returned.
5024 If {expr} uses a range, list or dict index that is out of
5025 range or does not exist you get an error message. Use
5026 |exists()| to check for existence.
5027 In Vim9 script it does not work for local function variables.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005028
5029 Can also be used as a |method|: >
5030 GetName()->islocked()
5031
5032isnan({expr}) *isnan()*
5033 Return |TRUE| if {expr} is a float with value NaN. >
5034 echo isnan(0.0 / 0.0)
5035< 1
5036
5037 Can also be used as a |method|: >
5038 Compute()->isnan()
5039<
5040 {only available when compiled with the |+float| feature}
5041
5042items({dict}) *items()*
5043 Return a |List| with all the key-value pairs of {dict}. Each
5044 |List| item is a list with two items: the key of a {dict}
5045 entry and the value of this entry. The |List| is in arbitrary
5046 order. Also see |keys()| and |values()|.
5047 Example: >
5048 for [key, value] in items(mydict)
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005049 echo key .. ': ' .. value
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005050 endfor
5051
5052< Can also be used as a |method|: >
5053 mydict->items()
5054
5055job_ functions are documented here: |job-functions-details|
5056
5057
5058join({list} [, {sep}]) *join()*
5059 Join the items in {list} together into one String.
5060 When {sep} is specified it is put in between the items. If
5061 {sep} is omitted a single space is used.
5062 Note that {sep} is not added at the end. You might want to
5063 add it there too: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005064 let lines = join(mylist, "\n") .. "\n"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005065< String items are used as-is. |Lists| and |Dictionaries| are
5066 converted into a string like with |string()|.
5067 The opposite function is |split()|.
5068
5069 Can also be used as a |method|: >
5070 mylist->join()
5071
5072js_decode({string}) *js_decode()*
5073 This is similar to |json_decode()| with these differences:
5074 - Object key names do not have to be in quotes.
5075 - Strings can be in single quotes.
5076 - Empty items in an array (between two commas) are allowed and
5077 result in v:none items.
5078
5079 Can also be used as a |method|: >
5080 ReadObject()->js_decode()
5081
5082js_encode({expr}) *js_encode()*
5083 This is similar to |json_encode()| with these differences:
5084 - Object key names are not in quotes.
5085 - v:none items in an array result in an empty item between
5086 commas.
5087 For example, the Vim object:
5088 [1,v:none,{"one":1},v:none] ~
5089 Will be encoded as:
5090 [1,,{one:1},,] ~
5091 While json_encode() would produce:
5092 [1,null,{"one":1},null] ~
5093 This encoding is valid for JavaScript. It is more efficient
5094 than JSON, especially when using an array with optional items.
5095
5096 Can also be used as a |method|: >
5097 GetObject()->js_encode()
5098
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00005099json_decode({string}) *json_decode()* *E491*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005100 This parses a JSON formatted string and returns the equivalent
5101 in Vim values. See |json_encode()| for the relation between
5102 JSON and Vim values.
5103 The decoding is permissive:
5104 - A trailing comma in an array and object is ignored, e.g.
5105 "[1, 2, ]" is the same as "[1, 2]".
5106 - Integer keys are accepted in objects, e.g. {1:2} is the
5107 same as {"1":2}.
5108 - More floating point numbers are recognized, e.g. "1." for
5109 "1.0", or "001.2" for "1.2". Special floating point values
5110 "Infinity", "-Infinity" and "NaN" (capitalization ignored)
5111 are accepted.
5112 - Leading zeroes in integer numbers are ignored, e.g. "012"
5113 for "12" or "-012" for "-12".
5114 - Capitalization is ignored in literal names null, true or
5115 false, e.g. "NULL" for "null", "True" for "true".
5116 - Control characters U+0000 through U+001F which are not
5117 escaped in strings are accepted, e.g. " " (tab
5118 character in string) for "\t".
5119 - An empty JSON expression or made of only spaces is accepted
5120 and results in v:none.
5121 - Backslash in an invalid 2-character sequence escape is
5122 ignored, e.g. "\a" is decoded as "a".
5123 - A correct surrogate pair in JSON strings should normally be
5124 a 12 character sequence such as "\uD834\uDD1E", but
5125 json_decode() silently accepts truncated surrogate pairs
5126 such as "\uD834" or "\uD834\u"
5127 *E938*
5128 A duplicate key in an object, valid in rfc7159, is not
5129 accepted by json_decode() as the result must be a valid Vim
5130 type, e.g. this fails: {"a":"b", "a":"c"}
5131
5132 Can also be used as a |method|: >
5133 ReadObject()->json_decode()
5134
5135json_encode({expr}) *json_encode()*
5136 Encode {expr} as JSON and return this as a string.
5137 The encoding is specified in:
5138 https://tools.ietf.org/html/rfc7159.html
Bram Moolenaara2baa732022-02-04 16:09:54 +00005139 Vim values are converted as follows: *E1161*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005140 |Number| decimal number
5141 |Float| floating point number
5142 Float nan "NaN"
5143 Float inf "Infinity"
5144 Float -inf "-Infinity"
5145 |String| in double quotes (possibly null)
5146 |Funcref| not possible, error
5147 |List| as an array (possibly null); when
5148 used recursively: []
5149 |Dict| as an object (possibly null); when
5150 used recursively: {}
5151 |Blob| as an array of the individual bytes
5152 v:false "false"
5153 v:true "true"
5154 v:none "null"
5155 v:null "null"
5156 Note that NaN and Infinity are passed on as values. This is
5157 missing in the JSON standard, but several implementations do
5158 allow it. If not then you will get an error.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005159 If a string contains an illegal character then the replacement
5160 character 0xfffd is used.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005161
5162 Can also be used as a |method|: >
5163 GetObject()->json_encode()
5164
5165keys({dict}) *keys()*
5166 Return a |List| with all the keys of {dict}. The |List| is in
5167 arbitrary order. Also see |items()| and |values()|.
5168
5169 Can also be used as a |method|: >
5170 mydict->keys()
5171
5172< *len()* *E701*
5173len({expr}) The result is a Number, which is the length of the argument.
5174 When {expr} is a String or a Number the length in bytes is
5175 used, as with |strlen()|.
5176 When {expr} is a |List| the number of items in the |List| is
5177 returned.
5178 When {expr} is a |Blob| the number of bytes is returned.
5179 When {expr} is a |Dictionary| the number of entries in the
5180 |Dictionary| is returned.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005181 Otherwise an error is given and returns zero.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005182
5183 Can also be used as a |method|: >
5184 mylist->len()
5185
5186< *libcall()* *E364* *E368*
5187libcall({libname}, {funcname}, {argument})
5188 Call function {funcname} in the run-time library {libname}
5189 with single argument {argument}.
5190 This is useful to call functions in a library that you
5191 especially made to be used with Vim. Since only one argument
5192 is possible, calling standard library functions is rather
5193 limited.
5194 The result is the String returned by the function. If the
5195 function returns NULL, this will appear as an empty string ""
5196 to Vim.
5197 If the function returns a number, use libcallnr()!
5198 If {argument} is a number, it is passed to the function as an
5199 int; if {argument} is a string, it is passed as a
5200 null-terminated string.
5201 This function will fail in |restricted-mode|.
5202
5203 libcall() allows you to write your own 'plug-in' extensions to
5204 Vim without having to recompile the program. It is NOT a
5205 means to call system functions! If you try to do so Vim will
5206 very probably crash.
5207
5208 For Win32, the functions you write must be placed in a DLL
5209 and use the normal C calling convention (NOT Pascal which is
5210 used in Windows System DLLs). The function must take exactly
5211 one parameter, either a character pointer or a long integer,
5212 and must return a character pointer or NULL. The character
5213 pointer returned must point to memory that will remain valid
5214 after the function has returned (e.g. in static data in the
5215 DLL). If it points to allocated memory, that memory will
5216 leak away. Using a static buffer in the function should work,
5217 it's then freed when the DLL is unloaded.
5218
5219 WARNING: If the function returns a non-valid pointer, Vim may
5220 crash! This also happens if the function returns a number,
5221 because Vim thinks it's a pointer.
5222 For Win32 systems, {libname} should be the filename of the DLL
5223 without the ".DLL" suffix. A full path is only required if
5224 the DLL is not in the usual places.
5225 For Unix: When compiling your own plugins, remember that the
5226 object code must be compiled as position-independent ('PIC').
5227 {only in Win32 and some Unix versions, when the |+libcall|
5228 feature is present}
5229 Examples: >
5230 :echo libcall("libc.so", "getenv", "HOME")
5231
5232< Can also be used as a |method|, the base is passed as the
5233 third argument: >
5234 GetValue()->libcall("libc.so", "getenv")
5235<
5236 *libcallnr()*
5237libcallnr({libname}, {funcname}, {argument})
5238 Just like |libcall()|, but used for a function that returns an
5239 int instead of a string.
5240 {only in Win32 on some Unix versions, when the |+libcall|
5241 feature is present}
5242 Examples: >
5243 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
5244 :call libcallnr("libc.so", "printf", "Hello World!\n")
5245 :call libcallnr("libc.so", "sleep", 10)
5246<
5247 Can also be used as a |method|, the base is passed as the
5248 third argument: >
5249 GetValue()->libcallnr("libc.so", "printf")
5250<
5251
5252line({expr} [, {winid}]) *line()*
5253 The result is a Number, which is the line number of the file
5254 position given with {expr}. The {expr} argument is a string.
Bram Moolenaara2baa732022-02-04 16:09:54 +00005255 The accepted positions are: *E1209*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005256 . the cursor position
5257 $ the last line in the current buffer
5258 'x position of mark x (if the mark is not set, 0 is
5259 returned)
5260 w0 first line visible in current window (one if the
5261 display isn't updated, e.g. in silent Ex mode)
5262 w$ last line visible in current window (this is one
5263 less than "w0" if no lines are visible)
5264 v In Visual mode: the start of the Visual area (the
5265 cursor is the end). When not in Visual mode
5266 returns the cursor position. Differs from |'<| in
5267 that it's updated right away.
5268 Note that a mark in another file can be used. The line number
5269 then applies to another buffer.
5270 To get the column number use |col()|. To get both use
5271 |getpos()|.
5272 With the optional {winid} argument the values are obtained for
5273 that window instead of the current window.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005274 Returns 0 for invalid values of {expr} and {winid}.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005275 Examples: >
5276 line(".") line number of the cursor
5277 line(".", winid) idem, in window "winid"
5278 line("'t") line number of mark t
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005279 line("'" .. marker) line number of mark marker
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005280<
5281 To jump to the last known position when opening a file see
5282 |last-position-jump|.
5283
5284 Can also be used as a |method|: >
5285 GetValue()->line()
5286
5287line2byte({lnum}) *line2byte()*
5288 Return the byte count from the start of the buffer for line
5289 {lnum}. This includes the end-of-line character, depending on
5290 the 'fileformat' option for the current buffer. The first
5291 line returns 1. 'encoding' matters, 'fileencoding' is ignored.
5292 This can also be used to get the byte count for the line just
5293 below the last line: >
5294 line2byte(line("$") + 1)
5295< This is the buffer size plus one. If 'fileencoding' is empty
5296 it is the file size plus one. {lnum} is used like with
5297 |getline()|. When {lnum} is invalid, or the |+byte_offset|
5298 feature has been disabled at compile time, -1 is returned.
5299 Also see |byte2line()|, |go| and |:goto|.
5300
5301 Can also be used as a |method|: >
5302 GetLnum()->line2byte()
5303
5304lispindent({lnum}) *lispindent()*
5305 Get the amount of indent for line {lnum} according the lisp
5306 indenting rules, as with 'lisp'.
5307 The indent is counted in spaces, the value of 'tabstop' is
5308 relevant. {lnum} is used just like in |getline()|.
Bram Moolenaar8e145b82022-05-21 20:17:31 +01005309 When {lnum} is invalid -1 is returned. In |Vim9| script an
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005310 error is given.
5311
5312 Can also be used as a |method|: >
5313 GetLnum()->lispindent()
5314
5315list2blob({list}) *list2blob()*
5316 Return a Blob concatenating all the number values in {list}.
5317 Examples: >
5318 list2blob([1, 2, 3, 4]) returns 0z01020304
5319 list2blob([]) returns 0z
5320< Returns an empty Blob on error. If one of the numbers is
5321 negative or more than 255 error *E1239* is given.
5322
5323 |blob2list()| does the opposite.
5324
5325 Can also be used as a |method|: >
5326 GetList()->list2blob()
5327
5328list2str({list} [, {utf8}]) *list2str()*
5329 Convert each number in {list} to a character string can
5330 concatenate them all. Examples: >
5331 list2str([32]) returns " "
5332 list2str([65, 66, 67]) returns "ABC"
5333< The same can be done (slowly) with: >
5334 join(map(list, {nr, val -> nr2char(val)}), '')
5335< |str2list()| does the opposite.
5336
5337 When {utf8} is omitted or zero, the current 'encoding' is used.
5338 When {utf8} is TRUE, always return UTF-8 characters.
5339 With UTF-8 composing characters work as expected: >
5340 list2str([97, 769]) returns "á"
5341<
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005342 Returns an empty string on error.
5343
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005344 Can also be used as a |method|: >
5345 GetList()->list2str()
5346
5347listener_add({callback} [, {buf}]) *listener_add()*
5348 Add a callback function that will be invoked when changes have
5349 been made to buffer {buf}.
5350 {buf} refers to a buffer name or number. For the accepted
5351 values, see |bufname()|. When {buf} is omitted the current
5352 buffer is used.
5353 Returns a unique ID that can be passed to |listener_remove()|.
5354
5355 The {callback} is invoked with five arguments:
Bram Moolenaar944697a2022-02-20 19:48:20 +00005356 bufnr the buffer that was changed
5357 start first changed line number
5358 end first line number below the change
5359 added number of lines added, negative if lines were
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005360 deleted
Bram Moolenaar944697a2022-02-20 19:48:20 +00005361 changes a List of items with details about the changes
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005362
5363 Example: >
5364 func Listener(bufnr, start, end, added, changes)
5365 echo 'lines ' .. a:start .. ' until ' .. a:end .. ' changed'
5366 endfunc
5367 call listener_add('Listener', bufnr)
5368
Bram Moolenaar944697a2022-02-20 19:48:20 +00005369< The List cannot be changed. Each item in "changes" is a
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005370 dictionary with these entries:
5371 lnum the first line number of the change
5372 end the first line below the change
5373 added number of lines added; negative if lines were
5374 deleted
5375 col first column in "lnum" that was affected by
5376 the change; one if unknown or the whole line
5377 was affected; this is a byte index, first
5378 character has a value of one.
5379 When lines are inserted the values are:
5380 lnum line above which the new line is added
5381 end equal to "lnum"
5382 added number of lines inserted
5383 col 1
5384 When lines are deleted the values are:
5385 lnum the first deleted line
5386 end the line below the first deleted line, before
5387 the deletion was done
5388 added negative, number of lines deleted
5389 col 1
5390 When lines are changed:
5391 lnum the first changed line
5392 end the line below the last changed line
5393 added 0
5394 col first column with a change or 1
5395
5396 The entries are in the order the changes were made, thus the
5397 most recent change is at the end. The line numbers are valid
5398 when the callback is invoked, but later changes may make them
5399 invalid, thus keeping a copy for later might not work.
5400
5401 The {callback} is invoked just before the screen is updated,
5402 when |listener_flush()| is called or when a change is being
5403 made that changes the line count in a way it causes a line
5404 number in the list of changes to become invalid.
5405
5406 The {callback} is invoked with the text locked, see
5407 |textlock|. If you do need to make changes to the buffer, use
5408 a timer to do this later |timer_start()|.
5409
5410 The {callback} is not invoked when the buffer is first loaded.
5411 Use the |BufReadPost| autocmd event to handle the initial text
5412 of a buffer.
5413 The {callback} is also not invoked when the buffer is
5414 unloaded, use the |BufUnload| autocmd event for that.
5415
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005416 Returns zero if {callback} or {buf} is invalid.
5417
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005418 Can also be used as a |method|, the base is passed as the
5419 second argument: >
5420 GetBuffer()->listener_add(callback)
5421
5422listener_flush([{buf}]) *listener_flush()*
5423 Invoke listener callbacks for buffer {buf}. If there are no
5424 pending changes then no callbacks are invoked.
5425
5426 {buf} refers to a buffer name or number. For the accepted
5427 values, see |bufname()|. When {buf} is omitted the current
5428 buffer is used.
5429
5430 Can also be used as a |method|: >
5431 GetBuffer()->listener_flush()
5432
5433listener_remove({id}) *listener_remove()*
5434 Remove a listener previously added with listener_add().
5435 Returns FALSE when {id} could not be found, TRUE when {id} was
5436 removed.
5437
5438 Can also be used as a |method|: >
5439 GetListenerId()->listener_remove()
5440
5441localtime() *localtime()*
5442 Return the current time, measured as seconds since 1st Jan
5443 1970. See also |strftime()|, |strptime()| and |getftime()|.
5444
5445
5446log({expr}) *log()*
5447 Return the natural logarithm (base e) of {expr} as a |Float|.
5448 {expr} must evaluate to a |Float| or a |Number| in the range
5449 (0, inf].
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005450 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005451 Examples: >
5452 :echo log(10)
5453< 2.302585 >
5454 :echo log(exp(5))
5455< 5.0
5456
5457 Can also be used as a |method|: >
5458 Compute()->log()
5459<
5460 {only available when compiled with the |+float| feature}
5461
5462
5463log10({expr}) *log10()*
5464 Return the logarithm of Float {expr} to base 10 as a |Float|.
5465 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005466 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005467 Examples: >
5468 :echo log10(1000)
5469< 3.0 >
5470 :echo log10(0.01)
5471< -2.0
5472
5473 Can also be used as a |method|: >
5474 Compute()->log10()
5475<
5476 {only available when compiled with the |+float| feature}
5477
5478luaeval({expr} [, {expr}]) *luaeval()*
5479 Evaluate Lua expression {expr} and return its result converted
5480 to Vim data structures. Second {expr} may hold additional
5481 argument accessible as _A inside first {expr}.
5482 Strings are returned as they are.
5483 Boolean objects are converted to numbers.
5484 Numbers are converted to |Float| values if vim was compiled
5485 with |+float| and to numbers otherwise.
5486 Dictionaries and lists obtained by vim.eval() are returned
5487 as-is.
5488 Other objects are returned as zero without any errors.
5489 See |lua-luaeval| for more details.
5490 Note that in a `:def` function local variables are not visible
5491 to {expr}.
5492
5493 Can also be used as a |method|: >
5494 GetExpr()->luaeval()
5495
5496< {only available when compiled with the |+lua| feature}
5497
5498map({expr1}, {expr2}) *map()*
5499 {expr1} must be a |List|, |String|, |Blob| or |Dictionary|.
Bram Moolenaar944697a2022-02-20 19:48:20 +00005500 When {expr1} is a |List| or |Dictionary|, replace each
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005501 item in {expr1} with the result of evaluating {expr2}.
5502 For a |Blob| each byte is replaced.
5503 For a |String|, each character, including composing
5504 characters, is replaced.
5505 If the item type changes you may want to use |mapnew()| to
5506 create a new List or Dictionary. This is required when using
5507 Vim9 script.
5508
5509 {expr2} must be a |String| or |Funcref|.
5510
5511 If {expr2} is a |String|, inside {expr2} |v:val| has the value
5512 of the current item. For a |Dictionary| |v:key| has the key
5513 of the current item and for a |List| |v:key| has the index of
5514 the current item. For a |Blob| |v:key| has the index of the
5515 current byte. For a |String| |v:key| has the index of the
5516 current character.
5517 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005518 :call map(mylist, '"> " .. v:val .. " <"')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005519< This puts "> " before and " <" after each item in "mylist".
5520
5521 Note that {expr2} is the result of an expression and is then
5522 used as an expression again. Often it is good to use a
5523 |literal-string| to avoid having to double backslashes. You
5524 still have to double ' quotes
5525
5526 If {expr2} is a |Funcref| it is called with two arguments:
5527 1. The key or the index of the current item.
5528 2. the value of the current item.
5529 The function must return the new value of the item. Example
5530 that changes each value by "key-value": >
5531 func KeyValue(key, val)
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005532 return a:key .. '-' .. a:val
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005533 endfunc
5534 call map(myDict, function('KeyValue'))
5535< It is shorter when using a |lambda|: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005536 call map(myDict, {key, val -> key .. '-' .. val})
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005537< If you do not use "val" you can leave it out: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005538 call map(myDict, {key -> 'item: ' .. key})
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005539< If you do not use "key" you can use a short name: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005540 call map(myDict, {_, val -> 'item: ' .. val})
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005541<
5542 The operation is done in-place for a |List| and |Dictionary|.
5543 If you want it to remain unmodified make a copy first: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005544 :let tlist = map(copy(mylist), ' v:val .. "\t"')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005545
5546< Returns {expr1}, the |List| or |Dictionary| that was filtered,
5547 or a new |Blob| or |String|.
5548 When an error is encountered while evaluating {expr2} no
5549 further items in {expr1} are processed.
5550 When {expr2} is a Funcref errors inside a function are ignored,
5551 unless it was defined with the "abort" flag.
5552
5553 Can also be used as a |method|: >
5554 mylist->map(expr2)
5555
5556
5557maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()*
5558 When {dict} is omitted or zero: Return the rhs of mapping
5559 {name} in mode {mode}. The returned String has special
5560 characters translated like in the output of the ":map" command
Ernie Rael09661202022-04-25 14:40:44 +01005561 listing. When {dict} is TRUE a dictionary is returned, see
5562 below. To get a list of all mappings see |maplist()|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005563
5564 When there is no mapping for {name}, an empty String is
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005565 returned if {dict} is FALSE, otherwise returns an empty Dict.
5566 When the mapping for {name} is empty, then "<Nop>" is
5567 returned.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005568
5569 The {name} can have special key names, like in the ":map"
5570 command.
5571
5572 {mode} can be one of these strings:
5573 "n" Normal
5574 "v" Visual (including Select)
5575 "o" Operator-pending
5576 "i" Insert
5577 "c" Cmd-line
5578 "s" Select
5579 "x" Visual
5580 "l" langmap |language-mapping|
5581 "t" Terminal-Job
5582 "" Normal, Visual and Operator-pending
5583 When {mode} is omitted, the modes for "" are used.
5584
5585 When {abbr} is there and it is |TRUE| use abbreviations
5586 instead of mappings.
5587
5588 When {dict} is there and it is |TRUE| return a dictionary
5589 containing all the information of the mapping with the
Ernie Rael659c2402022-04-24 18:40:28 +01005590 following items: *mapping-dict*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005591 "lhs" The {lhs} of the mapping as it would be typed
5592 "lhsraw" The {lhs} of the mapping as raw bytes
5593 "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate
5594 form, only present when it differs from "lhsraw"
5595 "rhs" The {rhs} of the mapping as typed.
5596 "silent" 1 for a |:map-silent| mapping, else 0.
5597 "noremap" 1 if the {rhs} of the mapping is not remappable.
5598 "script" 1 if mapping was defined with <script>.
5599 "expr" 1 for an expression mapping (|:map-<expr>|).
5600 "buffer" 1 for a buffer local mapping (|:map-local|).
5601 "mode" Modes for which the mapping is defined. In
5602 addition to the modes mentioned above, these
5603 characters will be used:
5604 " " Normal, Visual and Operator-pending
5605 "!" Insert and Commandline mode
5606 (|mapmode-ic|)
5607 "sid" The script local ID, used for <sid> mappings
5608 (|<SID>|).
Bram Moolenaara9528b32022-01-18 20:51:35 +00005609 "scriptversion" The version of the script. 999999 for
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005610 |Vim9| script.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005611 "lnum" The line number in "sid", zero if unknown.
5612 "nowait" Do not wait for other, longer mappings.
5613 (|:map-<nowait>|).
Bram Moolenaar921bde82022-05-09 19:50:35 +01005614 "abbr" True if this is an abbreviation |abbreviations|.
Ernie Raeld8f5f762022-05-10 17:50:39 +01005615 "mode_bits" Vim's internal binary representation of "mode".
5616 |mapset()| ignores this; only "mode" is used.
5617 See |maplist()| for usage examples. The values
5618 are from src/vim.h and may change in the future.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005619
5620 The dictionary can be used to restore a mapping with
5621 |mapset()|.
5622
5623 The mappings local to the current buffer are checked first,
5624 then the global mappings.
5625 This function can be used to map a key even when it's already
5626 mapped, and have it do the original mapping too. Sketch: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005627 exe 'nnoremap <Tab> ==' .. maparg('<Tab>', 'n')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005628
5629< Can also be used as a |method|: >
5630 GetKey()->maparg('n')
5631
5632mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()*
5633 Check if there is a mapping that matches with {name} in mode
5634 {mode}. See |maparg()| for {mode} and special names in
5635 {name}.
5636 When {abbr} is there and it is |TRUE| use abbreviations
5637 instead of mappings.
5638 A match happens with a mapping that starts with {name} and
5639 with a mapping which is equal to the start of {name}.
5640
5641 matches mapping "a" "ab" "abc" ~
5642 mapcheck("a") yes yes yes
5643 mapcheck("abc") yes yes yes
5644 mapcheck("ax") yes no no
5645 mapcheck("b") no no no
5646
5647 The difference with maparg() is that mapcheck() finds a
5648 mapping that matches with {name}, while maparg() only finds a
5649 mapping for {name} exactly.
5650 When there is no mapping that starts with {name}, an empty
5651 String is returned. If there is one, the RHS of that mapping
5652 is returned. If there are several mappings that start with
5653 {name}, the RHS of one of them is returned. This will be
5654 "<Nop>" if the RHS is empty.
5655 The mappings local to the current buffer are checked first,
5656 then the global mappings.
5657 This function can be used to check if a mapping can be added
5658 without being ambiguous. Example: >
5659 :if mapcheck("_vv") == ""
5660 : map _vv :set guifont=7x13<CR>
5661 :endif
5662< This avoids adding the "_vv" mapping when there already is a
5663 mapping for "_v" or for "_vvv".
5664
5665 Can also be used as a |method|: >
5666 GetKey()->mapcheck('n')
5667
5668
Ernie Rael09661202022-04-25 14:40:44 +01005669maplist([{abbr}]) *maplist()*
5670 Returns a |List| of all mappings. Each List item is a |Dict|,
5671 the same as what is returned by |maparg()|, see
5672 |mapping-dict|. When {abbr} is there and it is |TRUE| use
5673 abbreviations instead of mappings.
5674
5675 Example to show all mappings with 'MultiMatch' in rhs: >
5676 vim9script
5677 echo maplist()->filter(
5678 (_, m) => match(m.rhs, 'MultiMatch') >= 0)
Ernie Raeld8f5f762022-05-10 17:50:39 +01005679< It can be tricky to find mappings for particular |:map-modes|.
5680 |mapping-dict|'s "mode_bits" can simplify this. For example,
5681 the mode_bits for Normal, Insert or Command-line modes are
5682 0x19. To find all the mappings available in those modes you
5683 can do: >
5684 vim9script
5685 var saved_maps = []
5686 for m in maplist()
5687 if and(m.mode_bits, 0x19) != 0
5688 saved_maps->add(m)
5689 endif
5690 endfor
5691 echo saved_maps->mapnew((_, m) => m.lhs)
5692< The values of the mode_bits are defined in Vim's src/vim.h
5693 file and they can be discovered at runtime using
5694 |:map-commands| and "maplist()". Example: >
5695 vim9script
5696 omap xyzzy <Nop>
5697 var op_bit = maplist()->filter(
5698 (_, m) => m.lhs == 'xyzzy')[0].mode_bits
5699 ounmap xyzzy
5700 echo printf("Operator-pending mode bit: 0x%x", op_bit)
Ernie Rael09661202022-04-25 14:40:44 +01005701
5702
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005703mapnew({expr1}, {expr2}) *mapnew()*
5704 Like |map()| but instead of replacing items in {expr1} a new
5705 List or Dictionary is created and returned. {expr1} remains
5706 unchanged. Items can still be changed by {expr2}, if you
5707 don't want that use |deepcopy()| first.
5708
5709
5710mapset({mode}, {abbr}, {dict}) *mapset()*
Ernie Rael51d04d12022-05-04 15:40:22 +01005711mapset({dict})
5712 Restore a mapping from a dictionary, possibly returned by
5713 |maparg()| or |maplist()|. A buffer mapping, when dict.buffer
5714 is true, is set on the current buffer; it is up to the caller
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005715 to ensure that the intended buffer is the current buffer. This
Ernie Rael51d04d12022-05-04 15:40:22 +01005716 feature allows copying mappings from one buffer to another.
5717 The dict.mode value may restore a single mapping that covers
5718 more than one mode, like with mode values of '!', ' ', 'nox',
5719 or 'v'. *E1276*
5720
5721 In the first form, {mode} and {abbr} should be the same as
5722 for the call to |maparg()|. *E460*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005723 {mode} is used to define the mode in which the mapping is set,
5724 not the "mode" entry in {dict}.
5725 Example for saving and restoring a mapping: >
5726 let save_map = maparg('K', 'n', 0, 1)
5727 nnoremap K somethingelse
5728 ...
5729 call mapset('n', 0, save_map)
5730< Note that if you are going to replace a map in several modes,
Ernie Rael51d04d12022-05-04 15:40:22 +01005731 e.g. with `:map!`, you need to save/restore the mapping for
5732 all of them, when they might differ.
5733
5734 In the second form, with {dict} as the only argument, mode
5735 and abbr are taken from the dict.
5736 Example: >
5737 vim9script
5738 var save_maps = maplist()->filter(
5739 (_, m) => m.lhs == 'K')
5740 nnoremap K somethingelse
5741 cnoremap K somethingelse2
5742 # ...
5743 unmap K
5744 for d in save_maps
5745 mapset(d)
5746 endfor
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005747
5748
5749match({expr}, {pat} [, {start} [, {count}]]) *match()*
5750 When {expr} is a |List| then this returns the index of the
5751 first item where {pat} matches. Each item is used as a
5752 String, |Lists| and |Dictionaries| are used as echoed.
5753
5754 Otherwise, {expr} is used as a String. The result is a
5755 Number, which gives the index (byte offset) in {expr} where
5756 {pat} matches.
5757
5758 A match at the first character or |List| item returns zero.
5759 If there is no match -1 is returned.
5760
5761 For getting submatches see |matchlist()|.
5762 Example: >
5763 :echo match("testing", "ing") " results in 4
5764 :echo match([1, 'x'], '\a') " results in 1
5765< See |string-match| for how {pat} is used.
5766 *strpbrk()*
5767 Vim doesn't have a strpbrk() function. But you can do: >
5768 :let sepidx = match(line, '[.,;: \t]')
5769< *strcasestr()*
5770 Vim doesn't have a strcasestr() function. But you can add
5771 "\c" to the pattern to ignore case: >
5772 :let idx = match(haystack, '\cneedle')
5773<
5774 If {start} is given, the search starts from byte index
5775 {start} in a String or item {start} in a |List|.
5776 The result, however, is still the index counted from the
5777 first character/item. Example: >
5778 :echo match("testing", "ing", 2)
5779< result is again "4". >
5780 :echo match("testing", "ing", 4)
5781< result is again "4". >
5782 :echo match("testing", "t", 2)
5783< result is "3".
5784 For a String, if {start} > 0 then it is like the string starts
5785 {start} bytes later, thus "^" will match at {start}. Except
5786 when {count} is given, then it's like matches before the
5787 {start} byte are ignored (this is a bit complicated to keep it
5788 backwards compatible).
5789 For a String, if {start} < 0, it will be set to 0. For a list
5790 the index is counted from the end.
5791 If {start} is out of range ({start} > strlen({expr}) for a
5792 String or {start} > len({expr}) for a |List|) -1 is returned.
5793
5794 When {count} is given use the {count}'th match. When a match
5795 is found in a String the search for the next one starts one
5796 character further. Thus this example results in 1: >
5797 echo match("testing", "..", 0, 2)
5798< In a |List| the search continues in the next item.
5799 Note that when {count} is added the way {start} works changes,
5800 see above.
5801
5802 See |pattern| for the patterns that are accepted.
5803 The 'ignorecase' option is used to set the ignore-caseness of
5804 the pattern. 'smartcase' is NOT used. The matching is always
5805 done like 'magic' is set and 'cpoptions' is empty.
5806 Note that a match at the start is preferred, thus when the
5807 pattern is using "*" (any number of matches) it tends to find
5808 zero matches at the start instead of a number of matches
5809 further down in the text.
5810
5811 Can also be used as a |method|: >
5812 GetText()->match('word')
5813 GetList()->match('word')
5814<
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00005815 *matchadd()* *E290* *E798* *E799* *E801* *E957*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005816matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
5817 Defines a pattern to be highlighted in the current window (a
5818 "match"). It will be highlighted with {group}. Returns an
5819 identification number (ID), which can be used to delete the
5820 match using |matchdelete()|. The ID is bound to the window.
5821 Matching is case sensitive and magic, unless case sensitivity
5822 or magicness are explicitly overridden in {pattern}. The
5823 'magic', 'smartcase' and 'ignorecase' options are not used.
5824 The "Conceal" value is special, it causes the match to be
5825 concealed.
5826
5827 The optional {priority} argument assigns a priority to the
5828 match. A match with a high priority will have its
5829 highlighting overrule that of a match with a lower priority.
5830 A priority is specified as an integer (negative numbers are no
5831 exception). If the {priority} argument is not specified, the
5832 default priority is 10. The priority of 'hlsearch' is zero,
5833 hence all matches with a priority greater than zero will
5834 overrule it. Syntax highlighting (see 'syntax') is a separate
5835 mechanism, and regardless of the chosen priority a match will
5836 always overrule syntax highlighting.
5837
5838 The optional {id} argument allows the request for a specific
5839 match ID. If a specified ID is already taken, an error
5840 message will appear and the match will not be added. An ID
5841 is specified as a positive integer (zero excluded). IDs 1, 2
5842 and 3 are reserved for |:match|, |:2match| and |:3match|,
Bram Moolenaar2ecbe532022-07-29 21:36:21 +01005843 respectively. 3 is reserved for use by the |matchparen|
5844 plugin.
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01005845 If the {id} argument is not specified or -1, |matchadd()|
5846 automatically chooses a free ID.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005847
5848 The optional {dict} argument allows for further custom
5849 values. Currently this is used to specify a match specific
5850 conceal character that will be shown for |hl-Conceal|
5851 highlighted matches. The dict can have the following members:
5852
5853 conceal Special character to show instead of the
5854 match (only for |hl-Conceal| highlighted
5855 matches, see |:syn-cchar|)
5856 window Instead of the current window use the
5857 window with this number or window ID.
5858
5859 The number of matches is not limited, as it is the case with
5860 the |:match| commands.
5861
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005862 Returns -1 on error.
5863
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005864 Example: >
5865 :highlight MyGroup ctermbg=green guibg=green
5866 :let m = matchadd("MyGroup", "TODO")
5867< Deletion of the pattern: >
5868 :call matchdelete(m)
5869
5870< A list of matches defined by |matchadd()| and |:match| are
5871 available from |getmatches()|. All matches can be deleted in
5872 one operation by |clearmatches()|.
5873
5874 Can also be used as a |method|: >
5875 GetGroup()->matchadd('TODO')
5876<
5877 *matchaddpos()*
5878matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
5879 Same as |matchadd()|, but requires a list of positions {pos}
5880 instead of a pattern. This command is faster than |matchadd()|
5881 because it does not require to handle regular expressions and
5882 sets buffer line boundaries to redraw screen. It is supposed
5883 to be used when fast match additions and deletions are
5884 required, for example to highlight matching parentheses.
5885
5886 {pos} is a list of positions. Each position can be one of
5887 these:
5888 - A number. This whole line will be highlighted. The first
5889 line has number 1.
5890 - A list with one number, e.g., [23]. The whole line with this
5891 number will be highlighted.
5892 - A list with two numbers, e.g., [23, 11]. The first number is
5893 the line number, the second one is the column number (first
5894 column is 1, the value must correspond to the byte index as
5895 |col()| would return). The character at this position will
5896 be highlighted.
5897 - A list with three numbers, e.g., [23, 11, 3]. As above, but
5898 the third number gives the length of the highlight in bytes.
5899
5900 The maximum number of positions in {pos} is 8.
5901
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01005902 Returns -1 on error.
5903
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005904 Example: >
5905 :highlight MyGroup ctermbg=green guibg=green
5906 :let m = matchaddpos("MyGroup", [[23, 24], 34])
5907< Deletion of the pattern: >
5908 :call matchdelete(m)
5909
5910< Matches added by |matchaddpos()| are returned by
5911 |getmatches()|.
5912
5913 Can also be used as a |method|: >
5914 GetGroup()->matchaddpos([23, 11])
5915
5916matcharg({nr}) *matcharg()*
5917 Selects the {nr} match item, as set with a |:match|,
5918 |:2match| or |:3match| command.
5919 Return a |List| with two elements:
5920 The name of the highlight group used
5921 The pattern used.
5922 When {nr} is not 1, 2 or 3 returns an empty |List|.
5923 When there is no match item set returns ['', ''].
5924 This is useful to save and restore a |:match|.
5925 Highlighting matches using the |:match| commands are limited
5926 to three matches. |matchadd()| does not have this limitation.
5927
5928 Can also be used as a |method|: >
5929 GetMatch()->matcharg()
5930
5931matchdelete({id} [, {win}) *matchdelete()* *E802* *E803*
5932 Deletes a match with ID {id} previously defined by |matchadd()|
5933 or one of the |:match| commands. Returns 0 if successful,
5934 otherwise -1. See example for |matchadd()|. All matches can
5935 be deleted in one operation by |clearmatches()|.
5936 If {win} is specified, use the window with this number or
5937 window ID instead of the current window.
5938
5939 Can also be used as a |method|: >
5940 GetMatch()->matchdelete()
5941
5942matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()*
5943 Same as |match()|, but return the index of first character
5944 after the match. Example: >
5945 :echo matchend("testing", "ing")
5946< results in "7".
5947 *strspn()* *strcspn()*
5948 Vim doesn't have a strspn() or strcspn() function, but you can
5949 do it with matchend(): >
5950 :let span = matchend(line, '[a-zA-Z]')
5951 :let span = matchend(line, '[^a-zA-Z]')
5952< Except that -1 is returned when there are no matches.
5953
5954 The {start}, if given, has the same meaning as for |match()|. >
5955 :echo matchend("testing", "ing", 2)
5956< results in "7". >
5957 :echo matchend("testing", "ing", 5)
5958< result is "-1".
5959 When {expr} is a |List| the result is equal to |match()|.
5960
5961 Can also be used as a |method|: >
5962 GetText()->matchend('word')
5963
5964
5965matchfuzzy({list}, {str} [, {dict}]) *matchfuzzy()*
5966 If {list} is a list of strings, then returns a |List| with all
5967 the strings in {list} that fuzzy match {str}. The strings in
5968 the returned list are sorted based on the matching score.
5969
5970 The optional {dict} argument always supports the following
5971 items:
zeertzjq9af2bc02022-05-11 14:15:37 +01005972 matchseq When this item is present return only matches
5973 that contain the characters in {str} in the
5974 given sequence.
Kazuyuki Miyagi47f1a552022-06-17 18:30:03 +01005975 limit Maximum number of matches in {list} to be
5976 returned. Zero means no limit.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005977
5978 If {list} is a list of dictionaries, then the optional {dict}
5979 argument supports the following additional items:
Yasuhiro Matsumoto9029a6e2022-04-16 12:35:35 +01005980 key Key of the item which is fuzzy matched against
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005981 {str}. The value of this item should be a
5982 string.
5983 text_cb |Funcref| that will be called for every item
5984 in {list} to get the text for fuzzy matching.
5985 This should accept a dictionary item as the
5986 argument and return the text for that item to
5987 use for fuzzy matching.
5988
5989 {str} is treated as a literal string and regular expression
5990 matching is NOT supported. The maximum supported {str} length
5991 is 256.
5992
5993 When {str} has multiple words each separated by white space,
5994 then the list of strings that have all the words is returned.
5995
5996 If there are no matching strings or there is an error, then an
5997 empty list is returned. If length of {str} is greater than
5998 256, then returns an empty list.
5999
Yasuhiro Matsumoto9029a6e2022-04-16 12:35:35 +01006000 When {limit} is given, matchfuzzy() will find up to this
6001 number of matches in {list} and return them in sorted order.
6002
Bram Moolenaar1588bc82022-03-08 21:35:07 +00006003 Refer to |fuzzy-matching| for more information about fuzzy
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006004 matching strings.
6005
6006 Example: >
6007 :echo matchfuzzy(["clay", "crow"], "cay")
6008< results in ["clay"]. >
6009 :echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl")
6010< results in a list of buffer names fuzzy matching "ndl". >
6011 :echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'})
6012< results in a list of buffer information dicts with buffer
6013 names fuzzy matching "ndl". >
6014 :echo getbufinfo()->matchfuzzy("spl",
6015 \ {'text_cb' : {v -> v.name}})
6016< results in a list of buffer information dicts with buffer
6017 names fuzzy matching "spl". >
6018 :echo v:oldfiles->matchfuzzy("test")
6019< results in a list of file names fuzzy matching "test". >
6020 :let l = readfile("buffer.c")->matchfuzzy("str")
6021< results in a list of lines in "buffer.c" fuzzy matching "str". >
6022 :echo ['one two', 'two one']->matchfuzzy('two one')
6023< results in ['two one', 'one two']. >
6024 :echo ['one two', 'two one']->matchfuzzy('two one',
6025 \ {'matchseq': 1})
6026< results in ['two one'].
6027
6028matchfuzzypos({list}, {str} [, {dict}]) *matchfuzzypos()*
6029 Same as |matchfuzzy()|, but returns the list of matched
6030 strings, the list of character positions where characters
6031 in {str} matches and a list of matching scores. You can
6032 use |byteidx()| to convert a character position to a byte
6033 position.
6034
6035 If {str} matches multiple times in a string, then only the
6036 positions for the best match is returned.
6037
6038 If there are no matching strings or there is an error, then a
6039 list with three empty list items is returned.
6040
6041 Example: >
6042 :echo matchfuzzypos(['testing'], 'tsg')
6043< results in [['testing'], [[0, 2, 6]], [99]] >
6044 :echo matchfuzzypos(['clay', 'lacy'], 'la')
6045< results in [['lacy', 'clay'], [[0, 1], [1, 2]], [153, 133]] >
6046 :echo [{'text': 'hello', 'id' : 10}]->matchfuzzypos('ll', {'key' : 'text'})
6047< results in [[{'id': 10, 'text': 'hello'}], [[2, 3]], [127]]
6048
6049matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()*
6050 Same as |match()|, but return a |List|. The first item in the
6051 list is the matched string, same as what matchstr() would
6052 return. Following items are submatches, like "\1", "\2", etc.
6053 in |:substitute|. When an optional submatch didn't match an
6054 empty string is used. Example: >
6055 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
6056< Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
6057 When there is no match an empty list is returned.
6058
6059 You can pass in a List, but that is not very useful.
6060
6061 Can also be used as a |method|: >
6062 GetText()->matchlist('word')
6063
6064matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()*
6065 Same as |match()|, but return the matched string. Example: >
6066 :echo matchstr("testing", "ing")
6067< results in "ing".
6068 When there is no match "" is returned.
6069 The {start}, if given, has the same meaning as for |match()|. >
6070 :echo matchstr("testing", "ing", 2)
6071< results in "ing". >
6072 :echo matchstr("testing", "ing", 5)
6073< result is "".
6074 When {expr} is a |List| then the matching item is returned.
6075 The type isn't changed, it's not necessarily a String.
6076
6077 Can also be used as a |method|: >
6078 GetText()->matchstr('word')
6079
6080matchstrpos({expr}, {pat} [, {start} [, {count}]]) *matchstrpos()*
6081 Same as |matchstr()|, but return the matched string, the start
6082 position and the end position of the match. Example: >
6083 :echo matchstrpos("testing", "ing")
6084< results in ["ing", 4, 7].
6085 When there is no match ["", -1, -1] is returned.
6086 The {start}, if given, has the same meaning as for |match()|. >
6087 :echo matchstrpos("testing", "ing", 2)
6088< results in ["ing", 4, 7]. >
6089 :echo matchstrpos("testing", "ing", 5)
6090< result is ["", -1, -1].
6091 When {expr} is a |List| then the matching item, the index
6092 of first item where {pat} matches, the start position and the
6093 end position of the match are returned. >
6094 :echo matchstrpos([1, '__x'], '\a')
6095< result is ["x", 1, 2, 3].
6096 The type isn't changed, it's not necessarily a String.
6097
6098 Can also be used as a |method|: >
6099 GetText()->matchstrpos('word')
6100<
6101
6102 *max()*
6103max({expr}) Return the maximum value of all items in {expr}. Example: >
6104 echo max([apples, pears, oranges])
6105
6106< {expr} can be a |List| or a |Dictionary|. For a Dictionary,
6107 it returns the maximum of all values in the Dictionary.
6108 If {expr} is neither a List nor a Dictionary, or one of the
6109 items in {expr} cannot be used as a Number this results in
6110 an error. An empty |List| or |Dictionary| results in zero.
6111
6112 Can also be used as a |method|: >
6113 mylist->max()
6114
6115
6116menu_info({name} [, {mode}]) *menu_info()*
6117 Return information about the specified menu {name} in
6118 mode {mode}. The menu name should be specified without the
6119 shortcut character ('&'). If {name} is "", then the top-level
6120 menu names are returned.
6121
6122 {mode} can be one of these strings:
6123 "n" Normal
6124 "v" Visual (including Select)
6125 "o" Operator-pending
6126 "i" Insert
6127 "c" Cmd-line
6128 "s" Select
6129 "x" Visual
6130 "t" Terminal-Job
6131 "" Normal, Visual and Operator-pending
6132 "!" Insert and Cmd-line
6133 When {mode} is omitted, the modes for "" are used.
6134
6135 Returns a |Dictionary| containing the following items:
6136 accel menu item accelerator text |menu-text|
6137 display display name (name without '&')
6138 enabled v:true if this menu item is enabled
6139 Refer to |:menu-enable|
6140 icon name of the icon file (for toolbar)
6141 |toolbar-icon|
6142 iconidx index of a built-in icon
6143 modes modes for which the menu is defined. In
6144 addition to the modes mentioned above, these
6145 characters will be used:
6146 " " Normal, Visual and Operator-pending
6147 name menu item name.
6148 noremenu v:true if the {rhs} of the menu item is not
6149 remappable else v:false.
6150 priority menu order priority |menu-priority|
6151 rhs right-hand-side of the menu item. The returned
6152 string has special characters translated like
6153 in the output of the ":menu" command listing.
6154 When the {rhs} of a menu item is empty, then
6155 "<Nop>" is returned.
6156 script v:true if script-local remapping of {rhs} is
6157 allowed else v:false. See |:menu-script|.
6158 shortcut shortcut key (character after '&' in
6159 the menu name) |menu-shortcut|
6160 silent v:true if the menu item is created
6161 with <silent> argument |:menu-silent|
6162 submenus |List| containing the names of
6163 all the submenus. Present only if the menu
6164 item has submenus.
6165
6166 Returns an empty dictionary if the menu item is not found.
6167
6168 Examples: >
6169 :echo menu_info('Edit.Cut')
6170 :echo menu_info('File.Save', 'n')
6171
6172 " Display the entire menu hierarchy in a buffer
6173 func ShowMenu(name, pfx)
6174 let m = menu_info(a:name)
6175 call append(line('$'), a:pfx .. m.display)
6176 for child in m->get('submenus', [])
6177 call ShowMenu(a:name .. '.' .. escape(child, '.'),
6178 \ a:pfx .. ' ')
6179 endfor
6180 endfunc
6181 new
6182 for topmenu in menu_info('').submenus
6183 call ShowMenu(topmenu, '')
6184 endfor
6185<
6186 Can also be used as a |method|: >
6187 GetMenuName()->menu_info('v')
6188
6189
6190< *min()*
6191min({expr}) Return the minimum value of all items in {expr}. Example: >
6192 echo min([apples, pears, oranges])
6193
6194< {expr} can be a |List| or a |Dictionary|. For a Dictionary,
6195 it returns the minimum of all values in the Dictionary.
6196 If {expr} is neither a List nor a Dictionary, or one of the
6197 items in {expr} cannot be used as a Number this results in
6198 an error. An empty |List| or |Dictionary| results in zero.
6199
6200 Can also be used as a |method|: >
6201 mylist->min()
6202
6203< *mkdir()* *E739*
6204mkdir({name} [, {path} [, {prot}]])
6205 Create directory {name}.
6206
6207 If {path} is "p" then intermediate directories are created as
6208 necessary. Otherwise it must be "".
6209
6210 If {prot} is given it is used to set the protection bits of
6211 the new directory. The default is 0o755 (rwxr-xr-x: r/w for
6212 the user, readable for others). Use 0o700 to make it
6213 unreadable for others. This is only used for the last part of
6214 {name}. Thus if you create /tmp/foo/bar then /tmp/foo will be
6215 created with 0o755.
6216 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006217 :call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006218
6219< This function is not available in the |sandbox|.
6220
6221 There is no error if the directory already exists and the "p"
6222 flag is passed (since patch 8.0.1708). However, without the
6223 "p" option the call will fail.
6224
6225 The function result is a Number, which is TRUE if the call was
6226 successful or FALSE if the directory creation failed or partly
6227 failed.
6228
6229 Not available on all systems. To check use: >
6230 :if exists("*mkdir")
6231
6232< Can also be used as a |method|: >
6233 GetName()->mkdir()
6234<
6235 *mode()*
6236mode([expr]) Return a string that indicates the current mode.
6237 If [expr] is supplied and it evaluates to a non-zero Number or
6238 a non-empty String (|non-zero-arg|), then the full mode is
6239 returned, otherwise only the first letter is returned.
6240 Also see |state()|.
6241
6242 n Normal
6243 no Operator-pending
6244 nov Operator-pending (forced characterwise |o_v|)
6245 noV Operator-pending (forced linewise |o_V|)
6246 noCTRL-V Operator-pending (forced blockwise |o_CTRL-V|);
6247 CTRL-V is one character
6248 niI Normal using |i_CTRL-O| in |Insert-mode|
6249 niR Normal using |i_CTRL-O| in |Replace-mode|
6250 niV Normal using |i_CTRL-O| in |Virtual-Replace-mode|
6251 nt Terminal-Normal (insert goes to Terminal-Job mode)
6252 v Visual by character
6253 vs Visual by character using |v_CTRL-O| in Select mode
6254 V Visual by line
6255 Vs Visual by line using |v_CTRL-O| in Select mode
6256 CTRL-V Visual blockwise
6257 CTRL-Vs Visual blockwise using |v_CTRL-O| in Select mode
6258 s Select by character
6259 S Select by line
6260 CTRL-S Select blockwise
6261 i Insert
6262 ic Insert mode completion |compl-generic|
6263 ix Insert mode |i_CTRL-X| completion
6264 R Replace |R|
6265 Rc Replace mode completion |compl-generic|
6266 Rx Replace mode |i_CTRL-X| completion
6267 Rv Virtual Replace |gR|
6268 Rvc Virtual Replace mode completion |compl-generic|
6269 Rvx Virtual Replace mode |i_CTRL-X| completion
6270 c Command-line editing
6271 cv Vim Ex mode |gQ|
6272 ce Normal Ex mode |Q|
6273 r Hit-enter prompt
6274 rm The -- more -- prompt
6275 r? A |:confirm| query of some sort
6276 ! Shell or external command is executing
6277 t Terminal-Job mode: keys go to the job
6278
6279 This is useful in the 'statusline' option or when used
6280 with |remote_expr()| In most other places it always returns
6281 "c" or "n".
6282 Note that in the future more modes and more specific modes may
6283 be added. It's better not to compare the whole string but only
6284 the leading character(s).
6285 Also see |visualmode()|.
6286
6287 Can also be used as a |method|: >
6288 DoFull()->mode()
6289
6290mzeval({expr}) *mzeval()*
6291 Evaluate MzScheme expression {expr} and return its result
6292 converted to Vim data structures.
6293 Numbers and strings are returned as they are.
6294 Pairs (including lists and improper lists) and vectors are
6295 returned as Vim |Lists|.
6296 Hash tables are represented as Vim |Dictionary| type with keys
6297 converted to strings.
6298 All other types are converted to string with display function.
6299 Examples: >
6300 :mz (define l (list 1 2 3))
6301 :mz (define h (make-hash)) (hash-set! h "list" l)
6302 :echo mzeval("l")
6303 :echo mzeval("h")
6304<
6305 Note that in a `:def` function local variables are not visible
6306 to {expr}.
6307
6308 Can also be used as a |method|: >
6309 GetExpr()->mzeval()
6310<
6311 {only available when compiled with the |+mzscheme| feature}
6312
6313nextnonblank({lnum}) *nextnonblank()*
6314 Return the line number of the first line at or below {lnum}
6315 that is not blank. Example: >
6316 if getline(nextnonblank(1)) =~ "Java"
6317< When {lnum} is invalid or there is no non-blank line at or
6318 below it, zero is returned.
6319 {lnum} is used like with |getline()|.
6320 See also |prevnonblank()|.
6321
6322 Can also be used as a |method|: >
6323 GetLnum()->nextnonblank()
6324
6325nr2char({expr} [, {utf8}]) *nr2char()*
6326 Return a string with a single character, which has the number
6327 value {expr}. Examples: >
6328 nr2char(64) returns "@"
6329 nr2char(32) returns " "
6330< When {utf8} is omitted or zero, the current 'encoding' is used.
6331 Example for "utf-8": >
6332 nr2char(300) returns I with bow character
6333< When {utf8} is TRUE, always return UTF-8 characters.
6334 Note that a NUL character in the file is specified with
6335 nr2char(10), because NULs are represented with newline
6336 characters. nr2char(0) is a real NUL and terminates the
6337 string, thus results in an empty string.
6338 To turn a list of character numbers into a string: >
6339 let list = [65, 66, 67]
6340 let str = join(map(list, {_, val -> nr2char(val)}), '')
6341< Result: "ABC"
6342
6343 Can also be used as a |method|: >
6344 GetNumber()->nr2char()
6345
6346or({expr}, {expr}) *or()*
6347 Bitwise OR on the two arguments. The arguments are converted
6348 to a number. A List, Dict or Float argument causes an error.
Bram Moolenaar5a6ec102022-05-27 21:58:00 +01006349 Also see `and()` and `xor()`.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006350 Example: >
6351 :let bits = or(bits, 0x80)
6352< Can also be used as a |method|: >
6353 :let bits = bits->or(0x80)
6354
Bram Moolenaar5a6ec102022-05-27 21:58:00 +01006355< Rationale: The reason this is a function and not using the "|"
6356 character like many languages, is that Vi has always used "|"
6357 to separate commands. In many places it would not be clear if
6358 "|" is an operator or a command separator.
6359
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006360
6361pathshorten({path} [, {len}]) *pathshorten()*
6362 Shorten directory names in the path {path} and return the
6363 result. The tail, the file name, is kept as-is. The other
6364 components in the path are reduced to {len} letters in length.
6365 If {len} is omitted or smaller than 1 then 1 is used (single
6366 letters). Leading '~' and '.' characters are kept. Examples: >
6367 :echo pathshorten('~/.vim/autoload/myfile.vim')
6368< ~/.v/a/myfile.vim ~
6369>
6370 :echo pathshorten('~/.vim/autoload/myfile.vim', 2)
6371< ~/.vi/au/myfile.vim ~
6372 It doesn't matter if the path exists or not.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01006373 Returns an empty string on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006374
6375 Can also be used as a |method|: >
6376 GetDirectories()->pathshorten()
6377
6378perleval({expr}) *perleval()*
6379 Evaluate Perl expression {expr} in scalar context and return
6380 its result converted to Vim data structures. If value can't be
6381 converted, it is returned as a string Perl representation.
6382 Note: If you want an array or hash, {expr} must return a
6383 reference to it.
6384 Example: >
6385 :echo perleval('[1 .. 4]')
6386< [1, 2, 3, 4]
6387
6388 Note that in a `:def` function local variables are not visible
6389 to {expr}.
6390
6391 Can also be used as a |method|: >
6392 GetExpr()->perleval()
6393
6394< {only available when compiled with the |+perl| feature}
6395
6396
6397popup_ functions are documented here: |popup-functions|
6398
6399
6400pow({x}, {y}) *pow()*
6401 Return the power of {x} to the exponent {y} as a |Float|.
6402 {x} and {y} must evaluate to a |Float| or a |Number|.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01006403 Returns 0.0 if {x} or {y} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006404 Examples: >
6405 :echo pow(3, 3)
6406< 27.0 >
6407 :echo pow(2, 16)
6408< 65536.0 >
6409 :echo pow(32, 0.20)
6410< 2.0
6411
6412 Can also be used as a |method|: >
6413 Compute()->pow(3)
6414<
6415 {only available when compiled with the |+float| feature}
6416
6417prevnonblank({lnum}) *prevnonblank()*
6418 Return the line number of the first line at or above {lnum}
6419 that is not blank. Example: >
6420 let ind = indent(prevnonblank(v:lnum - 1))
6421< When {lnum} is invalid or there is no non-blank line at or
6422 above it, zero is returned.
6423 {lnum} is used like with |getline()|.
6424 Also see |nextnonblank()|.
6425
6426 Can also be used as a |method|: >
6427 GetLnum()->prevnonblank()
6428
6429printf({fmt}, {expr1} ...) *printf()*
6430 Return a String with {fmt}, where "%" items are replaced by
6431 the formatted form of their respective arguments. Example: >
6432 printf("%4d: E%d %.30s", lnum, errno, msg)
6433< May result in:
6434 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
6435
6436 When used as a |method| the base is passed as the second
6437 argument: >
6438 Compute()->printf("result: %d")
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006439<
6440 You can use `call()` to pass the items as a list.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006441
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006442 Often used items are:
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006443 %s string
6444 %6S string right-aligned in 6 display cells
6445 %6s string right-aligned in 6 bytes
6446 %.9s string truncated to 9 bytes
6447 %c single byte
6448 %d decimal number
6449 %5d decimal number padded with spaces to 5 characters
6450 %x hex number
6451 %04x hex number padded with zeros to at least 4 characters
6452 %X hex number using upper case letters
6453 %o octal number
6454 %08b binary number padded with zeros to at least 8 chars
6455 %f floating point number as 12.23, inf, -inf or nan
6456 %F floating point number as 12.23, INF, -INF or NAN
6457 %e floating point number as 1.23e3, inf, -inf or nan
6458 %E floating point number as 1.23E3, INF, -INF or NAN
6459 %g floating point number, as %f or %e depending on value
6460 %G floating point number, as %F or %E depending on value
6461 %% the % character itself
6462
6463 Conversion specifications start with '%' and end with the
6464 conversion type. All other characters are copied unchanged to
6465 the result.
6466
6467 The "%" starts a conversion specification. The following
6468 arguments appear in sequence:
6469
6470 % [flags] [field-width] [.precision] type
6471
6472 flags
6473 Zero or more of the following flags:
6474
6475 # The value should be converted to an "alternate
6476 form". For c, d, and s conversions, this option
6477 has no effect. For o conversions, the precision
6478 of the number is increased to force the first
6479 character of the output string to a zero (except
6480 if a zero value is printed with an explicit
6481 precision of zero).
6482 For b and B conversions, a non-zero result has
6483 the string "0b" (or "0B" for B conversions)
6484 prepended to it.
6485 For x and X conversions, a non-zero result has
6486 the string "0x" (or "0X" for X conversions)
6487 prepended to it.
6488
6489 0 (zero) Zero padding. For all conversions the converted
6490 value is padded on the left with zeros rather
6491 than blanks. If a precision is given with a
6492 numeric conversion (d, b, B, o, x, and X), the 0
6493 flag is ignored.
6494
6495 - A negative field width flag; the converted value
6496 is to be left adjusted on the field boundary.
6497 The converted value is padded on the right with
6498 blanks, rather than on the left with blanks or
6499 zeros. A - overrides a 0 if both are given.
6500
6501 ' ' (space) A blank should be left before a positive
6502 number produced by a signed conversion (d).
6503
6504 + A sign must always be placed before a number
6505 produced by a signed conversion. A + overrides
6506 a space if both are used.
6507
6508 field-width
6509 An optional decimal digit string specifying a minimum
6510 field width. If the converted value has fewer bytes
6511 than the field width, it will be padded with spaces on
6512 the left (or right, if the left-adjustment flag has
6513 been given) to fill out the field width. For the S
6514 conversion the count is in cells.
6515
6516 .precision
6517 An optional precision, in the form of a period '.'
6518 followed by an optional digit string. If the digit
6519 string is omitted, the precision is taken as zero.
6520 This gives the minimum number of digits to appear for
6521 d, o, x, and X conversions, the maximum number of
6522 bytes to be printed from a string for s conversions,
6523 or the maximum number of cells to be printed from a
6524 string for S conversions.
6525 For floating point it is the number of digits after
6526 the decimal point.
6527
6528 type
6529 A character that specifies the type of conversion to
6530 be applied, see below.
6531
6532 A field width or precision, or both, may be indicated by an
6533 asterisk '*' instead of a digit string. In this case, a
6534 Number argument supplies the field width or precision. A
6535 negative field width is treated as a left adjustment flag
6536 followed by a positive field width; a negative precision is
6537 treated as though it were missing. Example: >
6538 :echo printf("%d: %.*s", nr, width, line)
6539< This limits the length of the text used from "line" to
6540 "width" bytes.
6541
6542 The conversion specifiers and their meanings are:
6543
6544 *printf-d* *printf-b* *printf-B* *printf-o*
6545 *printf-x* *printf-X*
6546 dbBoxX The Number argument is converted to signed decimal
6547 (d), unsigned binary (b and B), unsigned octal (o), or
6548 unsigned hexadecimal (x and X) notation. The letters
6549 "abcdef" are used for x conversions; the letters
6550 "ABCDEF" are used for X conversions.
6551 The precision, if any, gives the minimum number of
6552 digits that must appear; if the converted value
6553 requires fewer digits, it is padded on the left with
6554 zeros.
6555 In no case does a non-existent or small field width
6556 cause truncation of a numeric field; if the result of
6557 a conversion is wider than the field width, the field
6558 is expanded to contain the conversion result.
6559 The 'h' modifier indicates the argument is 16 bits.
6560 The 'l' modifier indicates the argument is 32 bits.
6561 The 'L' modifier indicates the argument is 64 bits.
6562 Generally, these modifiers are not useful. They are
6563 ignored when type is known from the argument.
6564
6565 i alias for d
6566 D alias for ld
6567 U alias for lu
6568 O alias for lo
6569
6570 *printf-c*
6571 c The Number argument is converted to a byte, and the
6572 resulting character is written.
6573
6574 *printf-s*
6575 s The text of the String argument is used. If a
6576 precision is specified, no more bytes than the number
6577 specified are used.
6578 If the argument is not a String type, it is
6579 automatically converted to text with the same format
6580 as ":echo".
6581 *printf-S*
6582 S The text of the String argument is used. If a
6583 precision is specified, no more display cells than the
6584 number specified are used.
6585
6586 *printf-f* *E807*
6587 f F The Float argument is converted into a string of the
6588 form 123.456. The precision specifies the number of
6589 digits after the decimal point. When the precision is
6590 zero the decimal point is omitted. When the precision
6591 is not specified 6 is used. A really big number
6592 (out of range or dividing by zero) results in "inf"
6593 or "-inf" with %f (INF or -INF with %F).
6594 "0.0 / 0.0" results in "nan" with %f (NAN with %F).
6595 Example: >
6596 echo printf("%.2f", 12.115)
6597< 12.12
6598 Note that roundoff depends on the system libraries.
6599 Use |round()| when in doubt.
6600
6601 *printf-e* *printf-E*
6602 e E The Float argument is converted into a string of the
6603 form 1.234e+03 or 1.234E+03 when using 'E'. The
6604 precision specifies the number of digits after the
6605 decimal point, like with 'f'.
6606
6607 *printf-g* *printf-G*
6608 g G The Float argument is converted like with 'f' if the
6609 value is between 0.001 (inclusive) and 10000000.0
6610 (exclusive). Otherwise 'e' is used for 'g' and 'E'
6611 for 'G'. When no precision is specified superfluous
6612 zeroes and '+' signs are removed, except for the zero
6613 immediately after the decimal point. Thus 10000000.0
6614 results in 1.0e7.
6615
6616 *printf-%*
6617 % A '%' is written. No argument is converted. The
6618 complete conversion specification is "%%".
6619
6620 When a Number argument is expected a String argument is also
6621 accepted and automatically converted.
6622 When a Float or String argument is expected a Number argument
6623 is also accepted and automatically converted.
6624 Any other argument type results in an error message.
6625
6626 *E766* *E767*
6627 The number of {exprN} arguments must exactly match the number
6628 of "%" items. If there are not sufficient or too many
6629 arguments an error is given. Up to 18 arguments can be used.
6630
6631
6632prompt_getprompt({buf}) *prompt_getprompt()*
6633 Returns the effective prompt text for buffer {buf}. {buf} can
6634 be a buffer name or number. See |prompt-buffer|.
6635
6636 If the buffer doesn't exist or isn't a prompt buffer, an empty
6637 string is returned.
6638
6639 Can also be used as a |method|: >
6640 GetBuffer()->prompt_getprompt()
6641
6642< {only available when compiled with the |+channel| feature}
6643
6644
6645prompt_setcallback({buf}, {expr}) *prompt_setcallback()*
6646 Set prompt callback for buffer {buf} to {expr}. When {expr}
6647 is an empty string the callback is removed. This has only
6648 effect if {buf} has 'buftype' set to "prompt".
6649
6650 The callback is invoked when pressing Enter. The current
6651 buffer will always be the prompt buffer. A new line for a
6652 prompt is added before invoking the callback, thus the prompt
6653 for which the callback was invoked will be in the last but one
6654 line.
6655 If the callback wants to add text to the buffer, it must
6656 insert it above the last line, since that is where the current
6657 prompt is. This can also be done asynchronously.
6658 The callback is invoked with one argument, which is the text
6659 that was entered at the prompt. This can be an empty string
6660 if the user only typed Enter.
6661 Example: >
6662 call prompt_setcallback(bufnr(), function('s:TextEntered'))
6663 func s:TextEntered(text)
6664 if a:text == 'exit' || a:text == 'quit'
6665 stopinsert
6666 close
6667 else
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006668 call append(line('$') - 1, 'Entered: "' .. a:text .. '"')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006669 " Reset 'modified' to allow the buffer to be closed.
6670 set nomodified
6671 endif
6672 endfunc
6673
6674< Can also be used as a |method|: >
6675 GetBuffer()->prompt_setcallback(callback)
6676
6677< {only available when compiled with the |+channel| feature}
6678
6679prompt_setinterrupt({buf}, {expr}) *prompt_setinterrupt()*
6680 Set a callback for buffer {buf} to {expr}. When {expr} is an
6681 empty string the callback is removed. This has only effect if
6682 {buf} has 'buftype' set to "prompt".
6683
6684 This callback will be invoked when pressing CTRL-C in Insert
6685 mode. Without setting a callback Vim will exit Insert mode,
6686 as in any buffer.
6687
6688 Can also be used as a |method|: >
6689 GetBuffer()->prompt_setinterrupt(callback)
6690
6691< {only available when compiled with the |+channel| feature}
6692
6693prompt_setprompt({buf}, {text}) *prompt_setprompt()*
6694 Set prompt for buffer {buf} to {text}. You most likely want
6695 {text} to end in a space.
6696 The result is only visible if {buf} has 'buftype' set to
6697 "prompt". Example: >
6698 call prompt_setprompt(bufnr(), 'command: ')
6699<
6700 Can also be used as a |method|: >
6701 GetBuffer()->prompt_setprompt('command: ')
6702
6703< {only available when compiled with the |+channel| feature}
6704
6705prop_ functions are documented here: |text-prop-functions|
6706
6707pum_getpos() *pum_getpos()*
6708 If the popup menu (see |ins-completion-menu|) is not visible,
6709 returns an empty |Dictionary|, otherwise, returns a
6710 |Dictionary| with the following keys:
6711 height nr of items visible
6712 width screen cells
6713 row top screen row (0 first row)
6714 col leftmost screen column (0 first col)
6715 size total nr of items
6716 scrollbar |TRUE| if scrollbar is visible
6717
6718 The values are the same as in |v:event| during
6719 |CompleteChanged|.
6720
6721pumvisible() *pumvisible()*
6722 Returns non-zero when the popup menu is visible, zero
6723 otherwise. See |ins-completion-menu|.
6724 This can be used to avoid some things that would remove the
6725 popup menu.
6726
6727py3eval({expr}) *py3eval()*
6728 Evaluate Python expression {expr} and return its result
6729 converted to Vim data structures.
6730 Numbers and strings are returned as they are (strings are
6731 copied though, Unicode strings are additionally converted to
6732 'encoding').
6733 Lists are represented as Vim |List| type.
6734 Dictionaries are represented as Vim |Dictionary| type with
6735 keys converted to strings.
6736 Note that in a `:def` function local variables are not visible
6737 to {expr}.
6738
6739 Can also be used as a |method|: >
6740 GetExpr()->py3eval()
6741
6742< {only available when compiled with the |+python3| feature}
6743
6744 *E858* *E859*
6745pyeval({expr}) *pyeval()*
6746 Evaluate Python expression {expr} and return its result
6747 converted to Vim data structures.
6748 Numbers and strings are returned as they are (strings are
6749 copied though).
6750 Lists are represented as Vim |List| type.
6751 Dictionaries are represented as Vim |Dictionary| type,
6752 non-string keys result in error.
6753 Note that in a `:def` function local variables are not visible
6754 to {expr}.
6755
6756 Can also be used as a |method|: >
6757 GetExpr()->pyeval()
6758
6759< {only available when compiled with the |+python| feature}
6760
6761pyxeval({expr}) *pyxeval()*
6762 Evaluate Python expression {expr} and return its result
6763 converted to Vim data structures.
6764 Uses Python 2 or 3, see |python_x| and 'pyxversion'.
6765 See also: |pyeval()|, |py3eval()|
6766
6767 Can also be used as a |method|: >
6768 GetExpr()->pyxeval()
6769
6770< {only available when compiled with the |+python| or the
6771 |+python3| feature}
6772
6773rand([{expr}]) *rand()* *random*
6774 Return a pseudo-random Number generated with an xoshiro128**
6775 algorithm using seed {expr}. The returned number is 32 bits,
6776 also on 64 bits systems, for consistency.
6777 {expr} can be initialized by |srand()| and will be updated by
6778 rand(). If {expr} is omitted, an internal seed value is used
6779 and updated.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01006780 Returns -1 if {expr} is invalid.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006781
6782 Examples: >
6783 :echo rand()
6784 :let seed = srand()
6785 :echo rand(seed)
6786 :echo rand(seed) % 16 " random number 0 - 15
6787<
6788
6789 *E726* *E727*
6790range({expr} [, {max} [, {stride}]]) *range()*
6791 Returns a |List| with Numbers:
6792 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
6793 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
6794 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
6795 {max}] (increasing {expr} with {stride} each time, not
6796 producing a value past {max}).
6797 When the maximum is one before the start the result is an
6798 empty list. When the maximum is more than one before the
6799 start this is an error.
6800 Examples: >
6801 range(4) " [0, 1, 2, 3]
6802 range(2, 4) " [2, 3, 4]
6803 range(2, 9, 3) " [2, 5, 8]
6804 range(2, -2, -1) " [2, 1, 0, -1, -2]
6805 range(0) " []
6806 range(2, 0) " error!
6807<
6808 Can also be used as a |method|: >
6809 GetExpr()->range()
6810<
6811
6812readblob({fname}) *readblob()*
6813 Read file {fname} in binary mode and return a |Blob|.
6814 When the file can't be opened an error message is given and
6815 the result is an empty |Blob|.
6816 Also see |readfile()| and |writefile()|.
6817
6818
6819readdir({directory} [, {expr} [, {dict}]]) *readdir()*
6820 Return a list with file and directory names in {directory}.
6821 You can also use |glob()| if you don't need to do complicated
6822 things, such as limiting the number of matches.
6823 The list will be sorted (case sensitive), see the {dict}
6824 argument below for changing the sort order.
6825
6826 When {expr} is omitted all entries are included.
6827 When {expr} is given, it is evaluated to check what to do:
6828 If {expr} results in -1 then no further entries will
6829 be handled.
6830 If {expr} results in 0 then this entry will not be
6831 added to the list.
6832 If {expr} results in 1 then this entry will be added
6833 to the list.
6834 The entries "." and ".." are always excluded.
6835 Each time {expr} is evaluated |v:val| is set to the entry name.
6836 When {expr} is a function the name is passed as the argument.
6837 For example, to get a list of files ending in ".txt": >
6838 readdir(dirname, {n -> n =~ '.txt$'})
6839< To skip hidden and backup files: >
6840 readdir(dirname, {n -> n !~ '^\.\|\~$'})
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006841< *E857*
6842 The optional {dict} argument allows for further custom
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006843 values. Currently this is used to specify if and how sorting
6844 should be performed. The dict can have the following members:
6845
6846 sort How to sort the result returned from the system.
6847 Valid values are:
6848 "none" do not sort (fastest method)
6849 "case" sort case sensitive (byte value of
6850 each character, technically, using
6851 strcmp()) (default)
6852 "icase" sort case insensitive (technically
6853 using strcasecmp())
6854 "collate" sort using the collation order
6855 of the "POSIX" or "C" |locale|
6856 (technically using strcoll())
6857 Other values are silently ignored.
6858
6859 For example, to get a list of all files in the current
6860 directory without sorting the individual entries: >
6861 readdir('.', '1', #{sort: 'none'})
6862< If you want to get a directory tree: >
6863 function! s:tree(dir)
6864 return {a:dir : map(readdir(a:dir),
6865 \ {_, x -> isdirectory(x) ?
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006866 \ {x : s:tree(a:dir .. '/' .. x)} : x})}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006867 endfunction
6868 echo s:tree(".")
6869<
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01006870 Returns an empty List on error.
6871
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006872 Can also be used as a |method|: >
6873 GetDirName()->readdir()
6874<
6875readdirex({directory} [, {expr} [, {dict}]]) *readdirex()*
6876 Extended version of |readdir()|.
6877 Return a list of Dictionaries with file and directory
6878 information in {directory}.
6879 This is useful if you want to get the attributes of file and
6880 directory at the same time as getting a list of a directory.
6881 This is much faster than calling |readdir()| then calling
6882 |getfperm()|, |getfsize()|, |getftime()| and |getftype()| for
6883 each file and directory especially on MS-Windows.
6884 The list will by default be sorted by name (case sensitive),
6885 the sorting can be changed by using the optional {dict}
6886 argument, see |readdir()|.
6887
6888 The Dictionary for file and directory information has the
6889 following items:
6890 group Group name of the entry. (Only on Unix)
6891 name Name of the entry.
6892 perm Permissions of the entry. See |getfperm()|.
6893 size Size of the entry. See |getfsize()|.
6894 time Timestamp of the entry. See |getftime()|.
6895 type Type of the entry.
6896 On Unix, almost same as |getftype()| except:
6897 Symlink to a dir "linkd"
6898 Other symlink "link"
6899 On MS-Windows:
6900 Normal file "file"
6901 Directory "dir"
6902 Junction "junction"
6903 Symlink to a dir "linkd"
6904 Other symlink "link"
6905 Other reparse point "reparse"
6906 user User name of the entry's owner. (Only on Unix)
6907 On Unix, if the entry is a symlink, the Dictionary includes
6908 the information of the target (except the "type" item).
6909 On MS-Windows, it includes the information of the symlink
6910 itself because of performance reasons.
6911
6912 When {expr} is omitted all entries are included.
6913 When {expr} is given, it is evaluated to check what to do:
6914 If {expr} results in -1 then no further entries will
6915 be handled.
6916 If {expr} results in 0 then this entry will not be
6917 added to the list.
6918 If {expr} results in 1 then this entry will be added
6919 to the list.
6920 The entries "." and ".." are always excluded.
6921 Each time {expr} is evaluated |v:val| is set to a |Dictionary|
6922 of the entry.
6923 When {expr} is a function the entry is passed as the argument.
6924 For example, to get a list of files ending in ".txt": >
6925 readdirex(dirname, {e -> e.name =~ '.txt$'})
6926<
6927 For example, to get a list of all files in the current
6928 directory without sorting the individual entries: >
6929 readdirex(dirname, '1', #{sort: 'none'})
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006930<
6931 Can also be used as a |method|: >
6932 GetDirName()->readdirex()
6933<
6934
6935 *readfile()*
6936readfile({fname} [, {type} [, {max}]])
6937 Read file {fname} and return a |List|, each line of the file
6938 as an item. Lines are broken at NL characters. Macintosh
6939 files separated with CR will result in a single long line
6940 (unless a NL appears somewhere).
6941 All NUL characters are replaced with a NL character.
6942 When {type} contains "b" binary mode is used:
6943 - When the last line ends in a NL an extra empty list item is
6944 added.
6945 - No CR characters are removed.
6946 Otherwise:
6947 - CR characters that appear before a NL are removed.
6948 - Whether the last line ends in a NL or not does not matter.
6949 - When 'encoding' is Unicode any UTF-8 byte order mark is
6950 removed from the text.
6951 When {max} is given this specifies the maximum number of lines
6952 to be read. Useful if you only want to check the first ten
6953 lines of a file: >
6954 :for line in readfile(fname, '', 10)
6955 : if line =~ 'Date' | echo line | endif
6956 :endfor
6957< When {max} is negative -{max} lines from the end of the file
6958 are returned, or as many as there are.
6959 When {max} is zero the result is an empty list.
6960 Note that without {max} the whole file is read into memory.
6961 Also note that there is no recognition of encoding. Read a
6962 file into a buffer if you need to.
6963 Deprecated (use |readblob()| instead): When {type} contains
6964 "B" a |Blob| is returned with the binary data of the file
6965 unmodified.
6966 When the file can't be opened an error message is given and
6967 the result is an empty list.
6968 Also see |writefile()|.
6969
6970 Can also be used as a |method|: >
6971 GetFileName()->readfile()
6972
6973reduce({object}, {func} [, {initial}]) *reduce()* *E998*
6974 {func} is called for every item in {object}, which can be a
6975 |String|, |List| or a |Blob|. {func} is called with two
6976 arguments: the result so far and current item. After
Bram Moolenaarf10911e2022-01-29 22:20:48 +00006977 processing all items the result is returned. *E1132*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006978
6979 {initial} is the initial result. When omitted, the first item
6980 in {object} is used and {func} is first called for the second
6981 item. If {initial} is not given and {object} is empty no
6982 result can be computed, an E998 error is given.
6983
6984 Examples: >
6985 echo reduce([1, 3, 5], { acc, val -> acc + val })
6986 echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a')
6987 echo reduce(0z1122, { acc, val -> 2 * acc + val })
6988 echo reduce('xyz', { acc, val -> acc .. ',' .. val })
6989<
6990 Can also be used as a |method|: >
6991 echo mylist->reduce({ acc, val -> acc + val }, 0)
6992
6993
6994reg_executing() *reg_executing()*
6995 Returns the single letter name of the register being executed.
6996 Returns an empty string when no register is being executed.
6997 See |@|.
6998
6999reg_recording() *reg_recording()*
7000 Returns the single letter name of the register being recorded.
7001 Returns an empty string when not recording. See |q|.
7002
7003reltime([{start} [, {end}]]) *reltime()*
7004 Return an item that represents a time value. The item is a
7005 list with items that depend on the system. In Vim 9 script
7006 list<any> can be used.
7007 The item can be passed to |reltimestr()| to convert it to a
7008 string or |reltimefloat()| to convert to a Float.
7009
Bram Moolenaar016188f2022-06-06 20:52:59 +01007010 Without an argument reltime() returns the current time (the
Bram Moolenaareb490412022-06-28 13:44:46 +01007011 representation is system-dependent, it can not be used as the
Bram Moolenaar016188f2022-06-06 20:52:59 +01007012 wall-clock time, see |localtime()| for that).
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007013 With one argument is returns the time passed since the time
7014 specified in the argument.
7015 With two arguments it returns the time passed between {start}
7016 and {end}.
7017
7018 The {start} and {end} arguments must be values returned by
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007019 reltime(). If there is an error an empty List is returned in
7020 legacy script, in Vim9 script an error is given.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007021
7022 Can also be used as a |method|: >
7023 GetStart()->reltime()
7024<
7025 {only available when compiled with the |+reltime| feature}
7026
7027reltimefloat({time}) *reltimefloat()*
7028 Return a Float that represents the time value of {time}.
7029 Example: >
7030 let start = reltime()
7031 call MyFunction()
7032 let seconds = reltimefloat(reltime(start))
7033< See the note of reltimestr() about overhead.
7034 Also see |profiling|.
7035 If there is an error 0.0 is returned in legacy script, in Vim9
7036 script an error is given.
7037
7038 Can also be used as a |method|: >
7039 reltime(start)->reltimefloat()
7040
7041< {only available when compiled with the |+reltime| feature}
7042
7043reltimestr({time}) *reltimestr()*
7044 Return a String that represents the time value of {time}.
7045 This is the number of seconds, a dot and the number of
7046 microseconds. Example: >
7047 let start = reltime()
7048 call MyFunction()
7049 echo reltimestr(reltime(start))
7050< Note that overhead for the commands will be added to the time.
7051 The accuracy depends on the system.
7052 Leading spaces are used to make the string align nicely. You
7053 can use split() to remove it. >
7054 echo split(reltimestr(reltime(start)))[0]
7055< Also see |profiling|.
7056 If there is an error an empty string is returned in legacy
7057 script, in Vim9 script an error is given.
7058
7059 Can also be used as a |method|: >
7060 reltime(start)->reltimestr()
7061
7062< {only available when compiled with the |+reltime| feature}
7063
7064 *remote_expr()* *E449*
7065remote_expr({server}, {string} [, {idvar} [, {timeout}]])
Bram Moolenaar944697a2022-02-20 19:48:20 +00007066 Send the {string} to {server}. The {server} argument is a
7067 string, also see |{server}|.
7068
7069 The string is sent as an expression and the result is returned
7070 after evaluation. The result must be a String or a |List|. A
7071 |List| is turned into a String by joining the items with a
7072 line break in between (not at the end), like with join(expr,
7073 "\n").
7074
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007075 If {idvar} is present and not empty, it is taken as the name
7076 of a variable and a {serverid} for later use with
7077 |remote_read()| is stored there.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007078
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007079 If {timeout} is given the read times out after this many
7080 seconds. Otherwise a timeout of 600 seconds is used.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007081
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007082 See also |clientserver| |RemoteReply|.
7083 This function is not available in the |sandbox|.
7084 {only available when compiled with the |+clientserver| feature}
7085 Note: Any errors will cause a local error message to be issued
7086 and the result will be the empty string.
7087
7088 Variables will be evaluated in the global namespace,
7089 independent of a function currently being active. Except
7090 when in debug mode, then local function variables and
7091 arguments can be evaluated.
7092
7093 Examples: >
7094 :echo remote_expr("gvim", "2+2")
7095 :echo remote_expr("gvim1", "b:current_syntax")
7096<
7097 Can also be used as a |method|: >
7098 ServerName()->remote_expr(expr)
7099
7100remote_foreground({server}) *remote_foreground()*
7101 Move the Vim server with the name {server} to the foreground.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007102 The {server} argument is a string, also see |{server}|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007103 This works like: >
7104 remote_expr({server}, "foreground()")
7105< Except that on Win32 systems the client does the work, to work
7106 around the problem that the OS doesn't always allow the server
7107 to bring itself to the foreground.
7108 Note: This does not restore the window if it was minimized,
7109 like foreground() does.
7110 This function is not available in the |sandbox|.
7111
7112 Can also be used as a |method|: >
7113 ServerName()->remote_foreground()
7114
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01007115< {only in the Win32, Motif and GTK GUI versions and the
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007116 Win32 console version}
7117
7118
7119remote_peek({serverid} [, {retvar}]) *remote_peek()*
7120 Returns a positive number if there are available strings
7121 from {serverid}. Copies any reply string into the variable
7122 {retvar} if specified. {retvar} must be a string with the
7123 name of a variable.
7124 Returns zero if none are available.
7125 Returns -1 if something is wrong.
7126 See also |clientserver|.
7127 This function is not available in the |sandbox|.
7128 {only available when compiled with the |+clientserver| feature}
7129 Examples: >
7130 :let repl = ""
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007131 :echo "PEEK: " .. remote_peek(id, "repl") .. ": " .. repl
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007132
7133< Can also be used as a |method|: >
7134 ServerId()->remote_peek()
7135
7136remote_read({serverid}, [{timeout}]) *remote_read()*
7137 Return the oldest available reply from {serverid} and consume
7138 it. Unless a {timeout} in seconds is given, it blocks until a
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007139 reply is available. Returns an empty string, if a reply is
7140 not available or on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007141 See also |clientserver|.
7142 This function is not available in the |sandbox|.
7143 {only available when compiled with the |+clientserver| feature}
7144 Example: >
7145 :echo remote_read(id)
7146
7147< Can also be used as a |method|: >
7148 ServerId()->remote_read()
7149<
7150 *remote_send()* *E241*
7151remote_send({server}, {string} [, {idvar}])
Bram Moolenaar944697a2022-02-20 19:48:20 +00007152 Send the {string} to {server}. The {server} argument is a
7153 string, also see |{server}|.
7154
7155 The string is sent as input keys and the function returns
7156 immediately. At the Vim server the keys are not mapped
7157 |:map|.
7158
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007159 If {idvar} is present, it is taken as the name of a variable
7160 and a {serverid} for later use with remote_read() is stored
7161 there.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007162
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007163 See also |clientserver| |RemoteReply|.
7164 This function is not available in the |sandbox|.
7165 {only available when compiled with the |+clientserver| feature}
7166
7167 Note: Any errors will be reported in the server and may mess
7168 up the display.
7169 Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007170 :echo remote_send("gvim", ":DropAndReply " .. file, "serverid") ..
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007171 \ remote_read(serverid)
7172
7173 :autocmd NONE RemoteReply *
7174 \ echo remote_read(expand("<amatch>"))
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007175 :echo remote_send("gvim", ":sleep 10 | echo " ..
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007176 \ 'server2client(expand("<client>"), "HELLO")<CR>')
7177<
7178 Can also be used as a |method|: >
7179 ServerName()->remote_send(keys)
7180<
7181 *remote_startserver()* *E941* *E942*
7182remote_startserver({name})
7183 Become the server {name}. This fails if already running as a
7184 server, when |v:servername| is not empty.
7185
7186 Can also be used as a |method|: >
7187 ServerName()->remote_startserver()
7188
7189< {only available when compiled with the |+clientserver| feature}
7190
7191remove({list}, {idx} [, {end}]) *remove()*
7192 Without {end}: Remove the item at {idx} from |List| {list} and
7193 return the item.
7194 With {end}: Remove items from {idx} to {end} (inclusive) and
7195 return a |List| with these items. When {idx} points to the same
7196 item as {end} a list with one item is returned. When {end}
7197 points to an item before {idx} this is an error.
7198 See |list-index| for possible values of {idx} and {end}.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007199 Returns zero on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007200 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007201 :echo "last item: " .. remove(mylist, -1)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007202 :call remove(mylist, 0, 9)
7203<
7204 Use |delete()| to remove a file.
7205
7206 Can also be used as a |method|: >
7207 mylist->remove(idx)
7208
7209remove({blob}, {idx} [, {end}])
7210 Without {end}: Remove the byte at {idx} from |Blob| {blob} and
7211 return the byte.
7212 With {end}: Remove bytes from {idx} to {end} (inclusive) and
7213 return a |Blob| with these bytes. When {idx} points to the same
7214 byte as {end} a |Blob| with one byte is returned. When {end}
7215 points to a byte before {idx} this is an error.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007216 Returns zero on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007217 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007218 :echo "last byte: " .. remove(myblob, -1)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007219 :call remove(mylist, 0, 9)
7220
7221remove({dict}, {key})
7222 Remove the entry from {dict} with key {key} and return it.
7223 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007224 :echo "removed " .. remove(dict, "one")
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007225< If there is no {key} in {dict} this is an error.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007226 Returns zero on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007227
7228rename({from}, {to}) *rename()*
7229 Rename the file by the name {from} to the name {to}. This
7230 should also work to move files across file systems. The
7231 result is a Number, which is 0 if the file was renamed
7232 successfully, and non-zero when the renaming failed.
7233 NOTE: If {to} exists it is overwritten without warning.
7234 This function is not available in the |sandbox|.
7235
7236 Can also be used as a |method|: >
7237 GetOldName()->rename(newname)
7238
7239repeat({expr}, {count}) *repeat()*
7240 Repeat {expr} {count} times and return the concatenated
7241 result. Example: >
7242 :let separator = repeat('-', 80)
7243< When {count} is zero or negative the result is empty.
7244 When {expr} is a |List| the result is {expr} concatenated
7245 {count} times. Example: >
7246 :let longlist = repeat(['a', 'b'], 3)
7247< Results in ['a', 'b', 'a', 'b', 'a', 'b'].
7248
7249 Can also be used as a |method|: >
7250 mylist->repeat(count)
7251
7252resolve({filename}) *resolve()* *E655*
7253 On MS-Windows, when {filename} is a shortcut (a .lnk file),
7254 returns the path the shortcut points to in a simplified form.
7255 When {filename} is a symbolic link or junction point, return
7256 the full path to the target. If the target of junction is
7257 removed, return {filename}.
7258 On Unix, repeat resolving symbolic links in all path
7259 components of {filename} and return the simplified result.
7260 To cope with link cycles, resolving of symbolic links is
7261 stopped after 100 iterations.
7262 On other systems, return the simplified {filename}.
7263 The simplification step is done as by |simplify()|.
7264 resolve() keeps a leading path component specifying the
7265 current directory (provided the result is still a relative
7266 path name) and also keeps a trailing path separator.
7267
7268 Can also be used as a |method|: >
7269 GetName()->resolve()
7270
7271reverse({object}) *reverse()*
7272 Reverse the order of items in {object} in-place.
7273 {object} can be a |List| or a |Blob|.
7274 Returns {object}.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007275 Returns zero if {object} is not a List or a Blob.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007276 If you want an object to remain unmodified make a copy first: >
7277 :let revlist = reverse(copy(mylist))
7278< Can also be used as a |method|: >
7279 mylist->reverse()
7280
7281round({expr}) *round()*
7282 Round off {expr} to the nearest integral value and return it
7283 as a |Float|. If {expr} lies halfway between two integral
7284 values, then use the larger one (away from zero).
7285 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007286 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007287 Examples: >
7288 echo round(0.456)
7289< 0.0 >
7290 echo round(4.5)
7291< 5.0 >
7292 echo round(-4.5)
7293< -5.0
7294
7295 Can also be used as a |method|: >
7296 Compute()->round()
7297<
7298 {only available when compiled with the |+float| feature}
7299
7300rubyeval({expr}) *rubyeval()*
7301 Evaluate Ruby expression {expr} and return its result
7302 converted to Vim data structures.
7303 Numbers, floats and strings are returned as they are (strings
7304 are copied though).
7305 Arrays are represented as Vim |List| type.
7306 Hashes are represented as Vim |Dictionary| type.
7307 Other objects are represented as strings resulted from their
7308 "Object#to_s" method.
7309 Note that in a `:def` function local variables are not visible
7310 to {expr}.
7311
7312 Can also be used as a |method|: >
7313 GetRubyExpr()->rubyeval()
7314
7315< {only available when compiled with the |+ruby| feature}
7316
7317screenattr({row}, {col}) *screenattr()*
7318 Like |screenchar()|, but return the attribute. This is a rather
7319 arbitrary number that can only be used to compare to the
7320 attribute at other positions.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007321 Returns -1 when row or col is out of range.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007322
7323 Can also be used as a |method|: >
7324 GetRow()->screenattr(col)
7325
7326screenchar({row}, {col}) *screenchar()*
7327 The result is a Number, which is the character at position
7328 [row, col] on the screen. This works for every possible
7329 screen position, also status lines, window separators and the
7330 command line. The top left position is row one, column one
7331 The character excludes composing characters. For double-byte
7332 encodings it may only be the first byte.
7333 This is mainly to be used for testing.
7334 Returns -1 when row or col is out of range.
7335
7336 Can also be used as a |method|: >
7337 GetRow()->screenchar(col)
7338
7339screenchars({row}, {col}) *screenchars()*
7340 The result is a |List| of Numbers. The first number is the same
7341 as what |screenchar()| returns. Further numbers are
7342 composing characters on top of the base character.
7343 This is mainly to be used for testing.
7344 Returns an empty List when row or col is out of range.
7345
7346 Can also be used as a |method|: >
7347 GetRow()->screenchars(col)
7348
7349screencol() *screencol()*
7350 The result is a Number, which is the current screen column of
7351 the cursor. The leftmost column has number 1.
7352 This function is mainly used for testing.
7353
7354 Note: Always returns the current screen column, thus if used
7355 in a command (e.g. ":echo screencol()") it will return the
7356 column inside the command line, which is 1 when the command is
7357 executed. To get the cursor position in the file use one of
7358 the following mappings: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007359 nnoremap <expr> GG ":echom " .. screencol() .. "\n"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007360 nnoremap <silent> GG :echom screencol()<CR>
7361 nnoremap GG <Cmd>echom screencol()<CR>
7362<
7363screenpos({winid}, {lnum}, {col}) *screenpos()*
7364 The result is a Dict with the screen position of the text
7365 character in window {winid} at buffer line {lnum} and column
7366 {col}. {col} is a one-based byte index.
7367 The Dict has these members:
7368 row screen row
7369 col first screen column
7370 endcol last screen column
7371 curscol cursor screen column
7372 If the specified position is not visible, all values are zero.
7373 The "endcol" value differs from "col" when the character
7374 occupies more than one screen cell. E.g. for a Tab "col" can
7375 be 1 and "endcol" can be 8.
7376 The "curscol" value is where the cursor would be placed. For
7377 a Tab it would be the same as "endcol", while for a double
7378 width character it would be the same as "col".
7379 The |conceal| feature is ignored here, the column numbers are
7380 as if 'conceallevel' is zero. You can set the cursor to the
7381 right position and use |screencol()| to get the value with
7382 |conceal| taken into account.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007383 If the position is in a closed fold the screen position of the
7384 first character is returned, {col} is not used.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01007385 Returns an empty Dict if {winid} is invalid.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007386
7387 Can also be used as a |method|: >
7388 GetWinid()->screenpos(lnum, col)
7389
7390screenrow() *screenrow()*
7391 The result is a Number, which is the current screen row of the
7392 cursor. The top line has number one.
7393 This function is mainly used for testing.
7394 Alternatively you can use |winline()|.
7395
7396 Note: Same restrictions as with |screencol()|.
7397
7398screenstring({row}, {col}) *screenstring()*
7399 The result is a String that contains the base character and
7400 any composing characters at position [row, col] on the screen.
7401 This is like |screenchars()| but returning a String with the
7402 characters.
7403 This is mainly to be used for testing.
7404 Returns an empty String when row or col is out of range.
7405
7406 Can also be used as a |method|: >
7407 GetRow()->screenstring(col)
7408<
7409 *search()*
7410search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
7411 Search for regexp pattern {pattern}. The search starts at the
7412 cursor position (you can use |cursor()| to set it).
7413
7414 When a match has been found its line number is returned.
7415 If there is no match a 0 is returned and the cursor doesn't
7416 move. No error message is given.
7417
7418 {flags} is a String, which can contain these character flags:
7419 'b' search Backward instead of forward
7420 'c' accept a match at the Cursor position
7421 'e' move to the End of the match
7422 'n' do Not move the cursor
7423 'p' return number of matching sub-Pattern (see below)
7424 's' Set the ' mark at the previous location of the cursor
7425 'w' Wrap around the end of the file
7426 'W' don't Wrap around the end of the file
7427 'z' start searching at the cursor column instead of zero
7428 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
7429
7430 If the 's' flag is supplied, the ' mark is set, only if the
7431 cursor is moved. The 's' flag cannot be combined with the 'n'
7432 flag.
7433
7434 'ignorecase', 'smartcase' and 'magic' are used.
7435
7436 When the 'z' flag is not given, forward searching always
7437 starts in column zero and then matches before the cursor are
7438 skipped. When the 'c' flag is present in 'cpo' the next
7439 search starts after the match. Without the 'c' flag the next
7440 search starts one column further. This matters for
7441 overlapping matches.
7442 When searching backwards and the 'z' flag is given then the
7443 search starts in column zero, thus no match in the current
7444 line will be found (unless wrapping around the end of the
7445 file).
7446
7447 When the {stopline} argument is given then the search stops
7448 after searching this line. This is useful to restrict the
7449 search to a range of lines. Examples: >
7450 let match = search('(', 'b', line("w0"))
7451 let end = search('END', '', line("w$"))
7452< When {stopline} is used and it is not zero this also implies
7453 that the search does not wrap around the end of the file.
7454 A zero value is equal to not giving the argument.
Bram Moolenaar2ecbe532022-07-29 21:36:21 +01007455 *E1285* *E1286* *E1287* *E1288* *E1289*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007456 When the {timeout} argument is given the search stops when
7457 more than this many milliseconds have passed. Thus when
7458 {timeout} is 500 the search stops after half a second.
7459 The value must not be negative. A zero value is like not
7460 giving the argument.
7461 {only available when compiled with the |+reltime| feature}
7462
7463 If the {skip} expression is given it is evaluated with the
7464 cursor positioned on the start of a match. If it evaluates to
7465 non-zero this match is skipped. This can be used, for
7466 example, to skip a match in a comment or a string.
7467 {skip} can be a string, which is evaluated as an expression, a
7468 function reference or a lambda.
7469 When {skip} is omitted or empty, every match is accepted.
7470 When evaluating {skip} causes an error the search is aborted
7471 and -1 returned.
7472 *search()-sub-match*
7473 With the 'p' flag the returned value is one more than the
7474 first sub-match in \(\). One if none of them matched but the
7475 whole pattern did match.
7476 To get the column number too use |searchpos()|.
7477
7478 The cursor will be positioned at the match, unless the 'n'
7479 flag is used.
7480
7481 Example (goes over all files in the argument list): >
7482 :let n = 1
7483 :while n <= argc() " loop over all files in arglist
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007484 : exe "argument " .. n
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007485 : " start at the last char in the file and wrap for the
7486 : " first search to find match at start of file
7487 : normal G$
7488 : let flags = "w"
7489 : while search("foo", flags) > 0
7490 : s/foo/bar/g
7491 : let flags = "W"
7492 : endwhile
7493 : update " write the file if modified
7494 : let n = n + 1
7495 :endwhile
7496<
7497 Example for using some flags: >
7498 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
7499< This will search for the keywords "if", "else", and "endif"
7500 under or after the cursor. Because of the 'p' flag, it
7501 returns 1, 2, or 3 depending on which keyword is found, or 0
7502 if the search fails. With the cursor on the first word of the
7503 line:
7504 if (foo == 0) | let foo = foo + 1 | endif ~
7505 the function returns 1. Without the 'c' flag, the function
7506 finds the "endif" and returns 3. The same thing happens
7507 without the 'e' flag if the cursor is on the "f" of "if".
7508 The 'n' flag tells the function not to move the cursor.
7509
7510 Can also be used as a |method|: >
7511 GetPattern()->search()
7512
7513searchcount([{options}]) *searchcount()*
7514 Get or update the last search count, like what is displayed
7515 without the "S" flag in 'shortmess'. This works even if
7516 'shortmess' does contain the "S" flag.
7517
7518 This returns a |Dictionary|. The dictionary is empty if the
7519 previous pattern was not set and "pattern" was not specified.
7520
7521 key type meaning ~
7522 current |Number| current position of match;
7523 0 if the cursor position is
7524 before the first match
7525 exact_match |Boolean| 1 if "current" is matched on
7526 "pos", otherwise 0
7527 total |Number| total count of matches found
7528 incomplete |Number| 0: search was fully completed
7529 1: recomputing was timed out
7530 2: max count exceeded
7531
7532 For {options} see further down.
7533
7534 To get the last search count when |n| or |N| was pressed, call
7535 this function with `recompute: 0` . This sometimes returns
7536 wrong information because |n| and |N|'s maximum count is 99.
7537 If it exceeded 99 the result must be max count + 1 (100). If
7538 you want to get correct information, specify `recompute: 1`: >
7539
7540 " result == maxcount + 1 (100) when many matches
7541 let result = searchcount(#{recompute: 0})
7542
7543 " Below returns correct result (recompute defaults
7544 " to 1)
7545 let result = searchcount()
7546<
Bram Moolenaarb529cfb2022-07-25 15:42:07 +01007547 The function is useful to add the count to 'statusline': >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007548 function! LastSearchCount() abort
7549 let result = searchcount(#{recompute: 0})
7550 if empty(result)
7551 return ''
7552 endif
7553 if result.incomplete ==# 1 " timed out
7554 return printf(' /%s [?/??]', @/)
7555 elseif result.incomplete ==# 2 " max count exceeded
7556 if result.total > result.maxcount &&
7557 \ result.current > result.maxcount
7558 return printf(' /%s [>%d/>%d]', @/,
7559 \ result.current, result.total)
7560 elseif result.total > result.maxcount
7561 return printf(' /%s [%d/>%d]', @/,
7562 \ result.current, result.total)
7563 endif
7564 endif
7565 return printf(' /%s [%d/%d]', @/,
7566 \ result.current, result.total)
7567 endfunction
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007568 let &statusline ..= '%{LastSearchCount()}'
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007569
7570 " Or if you want to show the count only when
7571 " 'hlsearch' was on
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007572 " let &statusline ..=
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007573 " \ '%{v:hlsearch ? LastSearchCount() : ""}'
7574<
7575 You can also update the search count, which can be useful in a
7576 |CursorMoved| or |CursorMovedI| autocommand: >
7577
7578 autocmd CursorMoved,CursorMovedI *
7579 \ let s:searchcount_timer = timer_start(
7580 \ 200, function('s:update_searchcount'))
7581 function! s:update_searchcount(timer) abort
7582 if a:timer ==# s:searchcount_timer
7583 call searchcount(#{
7584 \ recompute: 1, maxcount: 0, timeout: 100})
7585 redrawstatus
7586 endif
7587 endfunction
7588<
7589 This can also be used to count matched texts with specified
7590 pattern in the current buffer using "pattern": >
7591
7592 " Count '\<foo\>' in this buffer
7593 " (Note that it also updates search count)
7594 let result = searchcount(#{pattern: '\<foo\>'})
7595
7596 " To restore old search count by old pattern,
7597 " search again
7598 call searchcount()
7599<
7600 {options} must be a |Dictionary|. It can contain:
7601 key type meaning ~
7602 recompute |Boolean| if |TRUE|, recompute the count
7603 like |n| or |N| was executed.
7604 otherwise returns the last
7605 computed result (when |n| or
7606 |N| was used when "S" is not
7607 in 'shortmess', or this
7608 function was called).
7609 (default: |TRUE|)
7610 pattern |String| recompute if this was given
7611 and different with |@/|.
7612 this works as same as the
7613 below command is executed
7614 before calling this function >
7615 let @/ = pattern
7616< (default: |@/|)
7617 timeout |Number| 0 or negative number is no
7618 timeout. timeout milliseconds
7619 for recomputing the result
7620 (default: 0)
7621 maxcount |Number| 0 or negative number is no
7622 limit. max count of matched
7623 text while recomputing the
7624 result. if search exceeded
7625 total count, "total" value
7626 becomes `maxcount + 1`
7627 (default: 99)
7628 pos |List| `[lnum, col, off]` value
7629 when recomputing the result.
7630 this changes "current" result
7631 value. see |cursor()|,
7632 |getpos()|
7633 (default: cursor's position)
7634
7635 Can also be used as a |method|: >
7636 GetSearchOpts()->searchcount()
7637<
7638searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
7639 Search for the declaration of {name}.
7640
7641 With a non-zero {global} argument it works like |gD|, find
7642 first match in the file. Otherwise it works like |gd|, find
7643 first match in the function.
7644
7645 With a non-zero {thisblock} argument matches in a {} block
7646 that ends before the cursor position are ignored. Avoids
7647 finding variable declarations only valid in another scope.
7648
7649 Moves the cursor to the found match.
7650 Returns zero for success, non-zero for failure.
7651 Example: >
7652 if searchdecl('myvar') == 0
7653 echo getline('.')
7654 endif
7655<
7656 Can also be used as a |method|: >
7657 GetName()->searchdecl()
7658<
7659 *searchpair()*
7660searchpair({start}, {middle}, {end} [, {flags} [, {skip}
7661 [, {stopline} [, {timeout}]]]])
7662 Search for the match of a nested start-end pair. This can be
7663 used to find the "endif" that matches an "if", while other
7664 if/endif pairs in between are ignored.
7665 The search starts at the cursor. The default is to search
7666 forward, include 'b' in {flags} to search backward.
7667 If a match is found, the cursor is positioned at it and the
7668 line number is returned. If no match is found 0 or -1 is
7669 returned and the cursor doesn't move. No error message is
7670 given.
7671
7672 {start}, {middle} and {end} are patterns, see |pattern|. They
7673 must not contain \( \) pairs. Use of \%( \) is allowed. When
7674 {middle} is not empty, it is found when searching from either
7675 direction, but only when not in a nested start-end pair. A
7676 typical use is: >
7677 searchpair('\<if\>', '\<else\>', '\<endif\>')
7678< By leaving {middle} empty the "else" is skipped.
7679
7680 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
7681 |search()|. Additionally:
7682 'r' Repeat until no more matches found; will find the
7683 outer pair. Implies the 'W' flag.
7684 'm' Return number of matches instead of line number with
7685 the match; will be > 1 when 'r' is used.
7686 Note: it's nearly always a good idea to use the 'W' flag, to
7687 avoid wrapping around the end of the file.
7688
7689 When a match for {start}, {middle} or {end} is found, the
7690 {skip} expression is evaluated with the cursor positioned on
7691 the start of the match. It should return non-zero if this
7692 match is to be skipped. E.g., because it is inside a comment
7693 or a string.
7694 When {skip} is omitted or empty, every match is accepted.
7695 When evaluating {skip} causes an error the search is aborted
7696 and -1 returned.
7697 {skip} can be a string, a lambda, a funcref or a partial.
7698 Anything else makes the function fail.
7699 In a `:def` function when the {skip} argument is a string
7700 constant it is compiled into instructions.
7701
7702 For {stopline} and {timeout} see |search()|.
7703
7704 The value of 'ignorecase' is used. 'magic' is ignored, the
7705 patterns are used like it's on.
7706
7707 The search starts exactly at the cursor. A match with
7708 {start}, {middle} or {end} at the next character, in the
7709 direction of searching, is the first one found. Example: >
7710 if 1
7711 if 2
7712 endif 2
7713 endif 1
7714< When starting at the "if 2", with the cursor on the "i", and
7715 searching forwards, the "endif 2" is found. When starting on
7716 the character just before the "if 2", the "endif 1" will be
7717 found. That's because the "if 2" will be found first, and
7718 then this is considered to be a nested if/endif from "if 2" to
7719 "endif 2".
7720 When searching backwards and {end} is more than one character,
7721 it may be useful to put "\zs" at the end of the pattern, so
7722 that when the cursor is inside a match with the end it finds
7723 the matching start.
7724
7725 Example, to find the "endif" command in a Vim script: >
7726
7727 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
7728 \ 'getline(".") =~ "^\\s*\""')
7729
7730< The cursor must be at or after the "if" for which a match is
7731 to be found. Note that single-quote strings are used to avoid
7732 having to double the backslashes. The skip expression only
7733 catches comments at the start of a line, not after a command.
7734 Also, a word "en" or "if" halfway a line is considered a
7735 match.
7736 Another example, to search for the matching "{" of a "}": >
7737
7738 :echo searchpair('{', '', '}', 'bW')
7739
7740< This works when the cursor is at or before the "}" for which a
7741 match is to be found. To reject matches that syntax
7742 highlighting recognized as strings: >
7743
7744 :echo searchpair('{', '', '}', 'bW',
7745 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
7746<
7747 *searchpairpos()*
7748searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
7749 [, {stopline} [, {timeout}]]]])
7750 Same as |searchpair()|, but returns a |List| with the line and
7751 column position of the match. The first element of the |List|
7752 is the line number and the second element is the byte index of
7753 the column position of the match. If no match is found,
7754 returns [0, 0]. >
7755
7756 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
7757<
7758 See |match-parens| for a bigger and more useful example.
7759
7760 *searchpos()*
7761searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
7762 Same as |search()|, but returns a |List| with the line and
7763 column position of the match. The first element of the |List|
7764 is the line number and the second element is the byte index of
7765 the column position of the match. If no match is found,
7766 returns [0, 0].
7767 Example: >
7768 :let [lnum, col] = searchpos('mypattern', 'n')
7769
7770< When the 'p' flag is given then there is an extra item with
7771 the sub-pattern match number |search()-sub-match|. Example: >
7772 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
7773< In this example "submatch" is 2 when a lowercase letter is
7774 found |/\l|, 3 when an uppercase letter is found |/\u|.
7775
7776 Can also be used as a |method|: >
7777 GetPattern()->searchpos()
7778
7779server2client({clientid}, {string}) *server2client()*
7780 Send a reply string to {clientid}. The most recent {clientid}
7781 that sent a string can be retrieved with expand("<client>").
7782 {only available when compiled with the |+clientserver| feature}
7783 Returns zero for success, -1 for failure.
7784 Note:
7785 This id has to be stored before the next command can be
7786 received. I.e. before returning from the received command and
7787 before calling any commands that waits for input.
7788 See also |clientserver|.
7789 Example: >
7790 :echo server2client(expand("<client>"), "HELLO")
7791
7792< Can also be used as a |method|: >
7793 GetClientId()->server2client(string)
7794<
7795serverlist() *serverlist()*
7796 Return a list of available server names, one per line.
7797 When there are no servers or the information is not available
7798 an empty string is returned. See also |clientserver|.
7799 {only available when compiled with the |+clientserver| feature}
7800 Example: >
7801 :echo serverlist()
7802<
7803setbufline({buf}, {lnum}, {text}) *setbufline()*
7804 Set line {lnum} to {text} in buffer {buf}. This works like
7805 |setline()| for the specified buffer.
7806
7807 This function works only for loaded buffers. First call
7808 |bufload()| if needed.
7809
7810 To insert lines use |appendbufline()|.
7811 Any text properties in {lnum} are cleared.
7812
7813 {text} can be a string to set one line, or a list of strings
7814 to set multiple lines. If the list extends below the last
7815 line then those lines are added.
7816
7817 For the use of {buf}, see |bufname()| above.
7818
7819 {lnum} is used like with |setline()|.
7820 Use "$" to refer to the last line in buffer {buf}.
7821 When {lnum} is just below the last line the {text} will be
7822 added below the last line.
7823
7824 When {buf} is not a valid buffer, the buffer is not loaded or
7825 {lnum} is not valid then 1 is returned. In |Vim9| script an
7826 error is given.
7827 On success 0 is returned.
7828
7829 Can also be used as a |method|, the base is passed as the
7830 third argument: >
7831 GetText()->setbufline(buf, lnum)
7832
7833setbufvar({buf}, {varname}, {val}) *setbufvar()*
7834 Set option or local variable {varname} in buffer {buf} to
7835 {val}.
7836 This also works for a global or local window option, but it
7837 doesn't work for a global or local window variable.
7838 For a local window option the global value is unchanged.
7839 For the use of {buf}, see |bufname()| above.
7840 The {varname} argument is a string.
7841 Note that the variable name without "b:" must be used.
7842 Examples: >
7843 :call setbufvar(1, "&mod", 1)
7844 :call setbufvar("todo", "myvar", "foobar")
7845< This function is not available in the |sandbox|.
7846
7847 Can also be used as a |method|, the base is passed as the
7848 third argument: >
7849 GetValue()->setbufvar(buf, varname)
7850
7851
7852setcellwidths({list}) *setcellwidths()*
7853 Specify overrides for cell widths of character ranges. This
7854 tells Vim how wide characters are, counted in screen cells.
7855 This overrides 'ambiwidth'. Example: >
7856 setcellwidths([[0xad, 0xad, 1],
7857 \ [0x2194, 0x2199, 2]])
7858
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007859< *E1109* *E1110* *E1111* *E1112* *E1113* *E1114*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007860 The {list} argument is a list of lists with each three
7861 numbers. These three numbers are [low, high, width]. "low"
7862 and "high" can be the same, in which case this refers to one
7863 character. Otherwise it is the range of characters from "low"
7864 to "high" (inclusive). "width" is either 1 or 2, indicating
7865 the character width in screen cells.
7866 An error is given if the argument is invalid, also when a
7867 range overlaps with another.
7868 Only characters with value 0x100 and higher can be used.
7869
7870 If the new value causes 'fillchars' or 'listchars' to become
7871 invalid it is rejected and an error is given.
7872
7873 To clear the overrides pass an empty list: >
7874 setcellwidths([]);
7875< You can use the script $VIMRUNTIME/tools/emoji_list.vim to see
7876 the effect for known emoji characters.
7877
7878setcharpos({expr}, {list}) *setcharpos()*
7879 Same as |setpos()| but uses the specified column number as the
7880 character index instead of the byte index in the line.
7881
7882 Example:
7883 With the text "여보세요" in line 8: >
7884 call setcharpos('.', [0, 8, 4, 0])
7885< positions the cursor on the fourth character '요'. >
7886 call setpos('.', [0, 8, 4, 0])
7887< positions the cursor on the second character '보'.
7888
7889 Can also be used as a |method|: >
7890 GetPosition()->setcharpos('.')
7891
7892setcharsearch({dict}) *setcharsearch()*
7893 Set the current character search information to {dict},
7894 which contains one or more of the following entries:
7895
7896 char character which will be used for a subsequent
7897 |,| or |;| command; an empty string clears the
7898 character search
7899 forward direction of character search; 1 for forward,
7900 0 for backward
7901 until type of character search; 1 for a |t| or |T|
7902 character search, 0 for an |f| or |F|
7903 character search
7904
7905 This can be useful to save/restore a user's character search
7906 from a script: >
7907 :let prevsearch = getcharsearch()
7908 :" Perform a command which clobbers user's search
7909 :call setcharsearch(prevsearch)
7910< Also see |getcharsearch()|.
7911
7912 Can also be used as a |method|: >
7913 SavedSearch()->setcharsearch()
7914
7915setcmdpos({pos}) *setcmdpos()*
7916 Set the cursor position in the command line to byte position
7917 {pos}. The first position is 1.
7918 Use |getcmdpos()| to obtain the current position.
7919 Only works while editing the command line, thus you must use
7920 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
7921 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
7922 set after the command line is set to the expression. For
7923 |c_CTRL-R_=| it is set after evaluating the expression but
7924 before inserting the resulting text.
7925 When the number is too big the cursor is put at the end of the
7926 line. A number smaller than one has undefined results.
7927 Returns FALSE when successful, TRUE when not editing the
7928 command line.
7929
7930 Can also be used as a |method|: >
7931 GetPos()->setcmdpos()
7932
7933setcursorcharpos({lnum}, {col} [, {off}]) *setcursorcharpos()*
7934setcursorcharpos({list})
7935 Same as |cursor()| but uses the specified column number as the
7936 character index instead of the byte index in the line.
7937
7938 Example:
7939 With the text "여보세요" in line 4: >
7940 call setcursorcharpos(4, 3)
7941< positions the cursor on the third character '세'. >
7942 call cursor(4, 3)
7943< positions the cursor on the first character '여'.
7944
7945 Can also be used as a |method|: >
7946 GetCursorPos()->setcursorcharpos()
7947
7948
7949setenv({name}, {val}) *setenv()*
7950 Set environment variable {name} to {val}. Example: >
7951 call setenv('HOME', '/home/myhome')
7952
7953< When {val} is |v:null| the environment variable is deleted.
7954 See also |expr-env|.
7955
7956 Can also be used as a |method|, the base is passed as the
7957 second argument: >
7958 GetPath()->setenv('PATH')
7959
7960setfperm({fname}, {mode}) *setfperm()* *chmod*
7961 Set the file permissions for {fname} to {mode}.
7962 {mode} must be a string with 9 characters. It is of the form
7963 "rwxrwxrwx", where each group of "rwx" flags represent, in
7964 turn, the permissions of the owner of the file, the group the
7965 file belongs to, and other users. A '-' character means the
7966 permission is off, any other character means on. Multi-byte
7967 characters are not supported.
7968
7969 For example "rw-r-----" means read-write for the user,
7970 readable by the group, not accessible by others. "xx-x-----"
7971 would do the same thing.
7972
7973 Returns non-zero for success, zero for failure.
7974
7975 Can also be used as a |method|: >
7976 GetFilename()->setfperm(mode)
7977<
7978 To read permissions see |getfperm()|.
7979
7980
7981setline({lnum}, {text}) *setline()*
7982 Set line {lnum} of the current buffer to {text}. To insert
7983 lines use |append()|. To set lines in another buffer use
7984 |setbufline()|. Any text properties in {lnum} are cleared.
7985
7986 {lnum} is used like with |getline()|.
7987 When {lnum} is just below the last line the {text} will be
7988 added below the last line.
7989 {text} can be any type or a List of any type, each item is
7990 converted to a String.
7991
7992 If this succeeds, FALSE is returned. If this fails (most likely
7993 because {lnum} is invalid) TRUE is returned.
7994 In |Vim9| script an error is given if {lnum} is invalid.
7995
7996 Example: >
7997 :call setline(5, strftime("%c"))
7998
7999< When {text} is a |List| then line {lnum} and following lines
8000 will be set to the items in the list. Example: >
8001 :call setline(5, ['aaa', 'bbb', 'ccc'])
8002< This is equivalent to: >
8003 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
8004 : call setline(n, l)
8005 :endfor
8006
8007< Note: The '[ and '] marks are not set.
8008
8009 Can also be used as a |method|, the base is passed as the
8010 second argument: >
8011 GetText()->setline(lnum)
8012
8013setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()*
8014 Create or replace or add to the location list for window {nr}.
8015 {nr} can be the window number or the |window-ID|.
8016 When {nr} is zero the current window is used.
8017
8018 For a location list window, the displayed location list is
8019 modified. For an invalid window number {nr}, -1 is returned.
8020 Otherwise, same as |setqflist()|.
8021 Also see |location-list|.
8022
8023 For {action} see |setqflist-action|.
8024
8025 If the optional {what} dictionary argument is supplied, then
8026 only the items listed in {what} are set. Refer to |setqflist()|
8027 for the list of supported keys in {what}.
8028
8029 Can also be used as a |method|, the base is passed as the
8030 second argument: >
8031 GetLoclist()->setloclist(winnr)
8032
8033setmatches({list} [, {win}]) *setmatches()*
8034 Restores a list of matches saved by |getmatches()| for the
8035 current window. Returns 0 if successful, otherwise -1. All
8036 current matches are cleared before the list is restored. See
8037 example for |getmatches()|.
8038 If {win} is specified, use the window with this number or
8039 window ID instead of the current window.
8040
8041 Can also be used as a |method|: >
8042 GetMatches()->setmatches()
8043<
8044 *setpos()*
8045setpos({expr}, {list})
8046 Set the position for String {expr}. Possible values:
8047 . the cursor
8048 'x mark x
8049
8050 {list} must be a |List| with four or five numbers:
8051 [bufnum, lnum, col, off]
8052 [bufnum, lnum, col, off, curswant]
8053
8054 "bufnum" is the buffer number. Zero can be used for the
8055 current buffer. When setting an uppercase mark "bufnum" is
8056 used for the mark position. For other marks it specifies the
8057 buffer to set the mark in. You can use the |bufnr()| function
8058 to turn a file name into a buffer number.
8059 For setting the cursor and the ' mark "bufnum" is ignored,
8060 since these are associated with a window, not a buffer.
8061 Does not change the jumplist.
8062
8063 "lnum" and "col" are the position in the buffer. The first
8064 column is 1. Use a zero "lnum" to delete a mark. If "col" is
8065 smaller than 1 then 1 is used. To use the character count
8066 instead of the byte count, use |setcharpos()|.
8067
8068 The "off" number is only used when 'virtualedit' is set. Then
8069 it is the offset in screen columns from the start of the
8070 character. E.g., a position within a <Tab> or after the last
8071 character.
8072
8073 The "curswant" number is only used when setting the cursor
8074 position. It sets the preferred column for when moving the
8075 cursor vertically. When the "curswant" number is missing the
8076 preferred column is not set. When it is present and setting a
8077 mark position it is not used.
8078
8079 Note that for '< and '> changing the line number may result in
8080 the marks to be effectively be swapped, so that '< is always
8081 before '>.
8082
8083 Returns 0 when the position could be set, -1 otherwise.
8084 An error message is given if {expr} is invalid.
8085
8086 Also see |setcharpos()|, |getpos()| and |getcurpos()|.
8087
8088 This does not restore the preferred column for moving
8089 vertically; if you set the cursor position with this, |j| and
8090 |k| motions will jump to previous columns! Use |cursor()| to
8091 also set the preferred column. Also see the "curswant" key in
8092 |winrestview()|.
8093
8094 Can also be used as a |method|: >
8095 GetPosition()->setpos('.')
8096
8097setqflist({list} [, {action} [, {what}]]) *setqflist()*
8098 Create or replace or add to the quickfix list.
8099
8100 If the optional {what} dictionary argument is supplied, then
8101 only the items listed in {what} are set. The first {list}
8102 argument is ignored. See below for the supported items in
8103 {what}.
8104 *setqflist-what*
8105 When {what} is not present, the items in {list} are used. Each
8106 item must be a dictionary. Non-dictionary items in {list} are
8107 ignored. Each dictionary item can contain the following
8108 entries:
8109
8110 bufnr buffer number; must be the number of a valid
8111 buffer
8112 filename name of a file; only used when "bufnr" is not
8113 present or it is invalid.
8114 module name of a module; if given it will be used in
8115 quickfix error window instead of the filename.
8116 lnum line number in the file
Bram Moolenaara2baa732022-02-04 16:09:54 +00008117 end_lnum end of lines, if the item spans multiple lines
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008118 pattern search pattern used to locate the error
8119 col column number
8120 vcol when non-zero: "col" is visual column
8121 when zero: "col" is byte index
Bram Moolenaara2baa732022-02-04 16:09:54 +00008122 end_col end column, if the item spans multiple columns
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008123 nr error number
8124 text description of the error
8125 type single-character error type, 'E', 'W', etc.
8126 valid recognized error message
8127
8128 The "col", "vcol", "nr", "type" and "text" entries are
8129 optional. Either "lnum" or "pattern" entry can be used to
8130 locate a matching error line.
8131 If the "filename" and "bufnr" entries are not present or
8132 neither the "lnum" or "pattern" entries are present, then the
8133 item will not be handled as an error line.
8134 If both "pattern" and "lnum" are present then "pattern" will
8135 be used.
8136 If the "valid" entry is not supplied, then the valid flag is
8137 set when "bufnr" is a valid buffer or "filename" exists.
8138 If you supply an empty {list}, the quickfix list will be
8139 cleared.
8140 Note that the list is not exactly the same as what
8141 |getqflist()| returns.
8142
8143 {action} values: *setqflist-action* *E927*
8144 'a' The items from {list} are added to the existing
8145 quickfix list. If there is no existing list, then a
8146 new list is created.
8147
8148 'r' The items from the current quickfix list are replaced
8149 with the items from {list}. This can also be used to
8150 clear the list: >
8151 :call setqflist([], 'r')
8152<
8153 'f' All the quickfix lists in the quickfix stack are
8154 freed.
8155
8156 If {action} is not present or is set to ' ', then a new list
8157 is created. The new quickfix list is added after the current
8158 quickfix list in the stack and all the following lists are
8159 freed. To add a new quickfix list at the end of the stack,
8160 set "nr" in {what} to "$".
8161
8162 The following items can be specified in dictionary {what}:
8163 context quickfix list context. See |quickfix-context|
8164 efm errorformat to use when parsing text from
8165 "lines". If this is not present, then the
8166 'errorformat' option value is used.
8167 See |quickfix-parse|
8168 id quickfix list identifier |quickfix-ID|
8169 idx index of the current entry in the quickfix
8170 list specified by 'id' or 'nr'. If set to '$',
8171 then the last entry in the list is set as the
8172 current entry. See |quickfix-index|
8173 items list of quickfix entries. Same as the {list}
8174 argument.
8175 lines use 'errorformat' to parse a list of lines and
8176 add the resulting entries to the quickfix list
8177 {nr} or {id}. Only a |List| value is supported.
8178 See |quickfix-parse|
8179 nr list number in the quickfix stack; zero
8180 means the current quickfix list and "$" means
8181 the last quickfix list.
8182 quickfixtextfunc
8183 function to get the text to display in the
8184 quickfix window. The value can be the name of
8185 a function or a funcref or a lambda. Refer to
8186 |quickfix-window-function| for an explanation
8187 of how to write the function and an example.
8188 title quickfix list title text. See |quickfix-title|
8189 Unsupported keys in {what} are ignored.
8190 If the "nr" item is not present, then the current quickfix list
8191 is modified. When creating a new quickfix list, "nr" can be
8192 set to a value one greater than the quickfix stack size.
8193 When modifying a quickfix list, to guarantee that the correct
8194 list is modified, "id" should be used instead of "nr" to
8195 specify the list.
8196
8197 Examples (See also |setqflist-examples|): >
8198 :call setqflist([], 'r', {'title': 'My search'})
8199 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
8200 :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
8201<
8202 Returns zero for success, -1 for failure.
8203
8204 This function can be used to create a quickfix list
8205 independent of the 'errorformat' setting. Use a command like
8206 `:cc 1` to jump to the first position.
8207
8208 Can also be used as a |method|, the base is passed as the
8209 second argument: >
8210 GetErrorlist()->setqflist()
8211<
8212 *setreg()*
8213setreg({regname}, {value} [, {options}])
8214 Set the register {regname} to {value}.
8215 If {regname} is "" or "@", the unnamed register '"' is used.
8216 The {regname} argument is a string. In |Vim9-script|
8217 {regname} must be one character.
8218
8219 {value} may be any value returned by |getreg()| or
8220 |getreginfo()|, including a |List| or |Dict|.
8221 If {options} contains "a" or {regname} is upper case,
8222 then the value is appended.
8223
8224 {options} can also contain a register type specification:
8225 "c" or "v" |characterwise| mode
8226 "l" or "V" |linewise| mode
8227 "b" or "<CTRL-V>" |blockwise-visual| mode
8228 If a number immediately follows "b" or "<CTRL-V>" then this is
8229 used as the width of the selection - if it is not specified
8230 then the width of the block is set to the number of characters
8231 in the longest line (counting a <Tab> as 1 character).
8232
8233 If {options} contains no register settings, then the default
8234 is to use character mode unless {value} ends in a <NL> for
8235 string {value} and linewise mode for list {value}. Blockwise
8236 mode is never selected automatically.
8237 Returns zero for success, non-zero for failure.
8238
8239 *E883*
8240 Note: you may not use |List| containing more than one item to
8241 set search and expression registers. Lists containing no
8242 items act like empty strings.
8243
8244 Examples: >
8245 :call setreg(v:register, @*)
8246 :call setreg('*', @%, 'ac')
8247 :call setreg('a', "1\n2\n3", 'b5')
8248 :call setreg('"', { 'points_to': 'a'})
8249
8250< This example shows using the functions to save and restore a
8251 register: >
8252 :let var_a = getreginfo()
8253 :call setreg('a', var_a)
8254< or: >
8255 :let var_a = getreg('a', 1, 1)
8256 :let var_amode = getregtype('a')
8257 ....
8258 :call setreg('a', var_a, var_amode)
8259< Note: you may not reliably restore register value
8260 without using the third argument to |getreg()| as without it
8261 newlines are represented as newlines AND Nul bytes are
8262 represented as newlines as well, see |NL-used-for-Nul|.
8263
8264 You can also change the type of a register by appending
8265 nothing: >
8266 :call setreg('a', '', 'al')
8267
8268< Can also be used as a |method|, the base is passed as the
8269 second argument: >
8270 GetText()->setreg('a')
8271
8272settabvar({tabnr}, {varname}, {val}) *settabvar()*
8273 Set tab-local variable {varname} to {val} in tab page {tabnr}.
8274 |t:var|
8275 The {varname} argument is a string.
8276 Note that autocommands are blocked, side effects may not be
8277 triggered, e.g. when setting 'filetype'.
8278 Note that the variable name without "t:" must be used.
8279 Tabs are numbered starting with one.
8280 This function is not available in the |sandbox|.
8281
8282 Can also be used as a |method|, the base is passed as the
8283 third argument: >
8284 GetValue()->settabvar(tab, name)
8285
8286settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
8287 Set option or local variable {varname} in window {winnr} to
8288 {val}.
8289 Tabs are numbered starting with one. For the current tabpage
8290 use |setwinvar()|.
8291 {winnr} can be the window number or the |window-ID|.
8292 When {winnr} is zero the current window is used.
8293 Note that autocommands are blocked, side effects may not be
8294 triggered, e.g. when setting 'filetype' or 'syntax'.
8295 This also works for a global or local buffer option, but it
8296 doesn't work for a global or local buffer variable.
8297 For a local buffer option the global value is unchanged.
8298 Note that the variable name without "w:" must be used.
8299 Examples: >
8300 :call settabwinvar(1, 1, "&list", 0)
8301 :call settabwinvar(3, 2, "myvar", "foobar")
8302< This function is not available in the |sandbox|.
8303
8304 Can also be used as a |method|, the base is passed as the
8305 fourth argument: >
8306 GetValue()->settabwinvar(tab, winnr, name)
8307
8308settagstack({nr}, {dict} [, {action}]) *settagstack()*
8309 Modify the tag stack of the window {nr} using {dict}.
8310 {nr} can be the window number or the |window-ID|.
8311
8312 For a list of supported items in {dict}, refer to
8313 |gettagstack()|. "curidx" takes effect before changing the tag
8314 stack.
8315 *E962*
8316 How the tag stack is modified depends on the {action}
8317 argument:
8318 - If {action} is not present or is set to 'r', then the tag
8319 stack is replaced.
8320 - If {action} is set to 'a', then new entries from {dict} are
8321 pushed (added) onto the tag stack.
8322 - If {action} is set to 't', then all the entries from the
8323 current entry in the tag stack or "curidx" in {dict} are
8324 removed and then new entries are pushed to the stack.
8325
8326 The current index is set to one after the length of the tag
8327 stack after the modification.
8328
8329 Returns zero for success, -1 for failure.
8330
8331 Examples (for more examples see |tagstack-examples|):
8332 Empty the tag stack of window 3: >
8333 call settagstack(3, {'items' : []})
8334
8335< Save and restore the tag stack: >
8336 let stack = gettagstack(1003)
8337 " do something else
8338 call settagstack(1003, stack)
8339 unlet stack
8340<
8341 Can also be used as a |method|, the base is passed as the
8342 second argument: >
8343 GetStack()->settagstack(winnr)
8344
8345setwinvar({winnr}, {varname}, {val}) *setwinvar()*
8346 Like |settabwinvar()| for the current tab page.
8347 Examples: >
8348 :call setwinvar(1, "&list", 0)
8349 :call setwinvar(2, "myvar", "foobar")
8350
8351< Can also be used as a |method|, the base is passed as the
8352 third argument: >
8353 GetValue()->setwinvar(winnr, name)
8354
8355sha256({string}) *sha256()*
8356 Returns a String with 64 hex characters, which is the SHA256
8357 checksum of {string}.
8358
8359 Can also be used as a |method|: >
8360 GetText()->sha256()
8361
8362< {only available when compiled with the |+cryptv| feature}
8363
8364shellescape({string} [, {special}]) *shellescape()*
8365 Escape {string} for use as a shell command argument.
8366 When the 'shell' contains powershell (MS-Windows) or pwsh
Bram Moolenaar944697a2022-02-20 19:48:20 +00008367 (MS-Windows, Linux, and macOS) then it will enclose {string}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008368 in single quotes and will double up all internal single
8369 quotes.
8370 On MS-Windows, when 'shellslash' is not set, it will enclose
8371 {string} in double quotes and double all double quotes within
8372 {string}.
8373 Otherwise it will enclose {string} in single quotes and
8374 replace all "'" with "'\''".
8375
8376 When the {special} argument is present and it's a non-zero
8377 Number or a non-empty String (|non-zero-arg|), then special
8378 items such as "!", "%", "#" and "<cword>" will be preceded by
8379 a backslash. This backslash will be removed again by the |:!|
8380 command.
8381
8382 The "!" character will be escaped (again with a |non-zero-arg|
8383 {special}) when 'shell' contains "csh" in the tail. That is
8384 because for csh and tcsh "!" is used for history replacement
8385 even when inside single quotes.
8386
8387 With a |non-zero-arg| {special} the <NL> character is also
8388 escaped. When 'shell' containing "csh" in the tail it's
8389 escaped a second time.
8390
8391 The "\" character will be escaped when 'shell' contains "fish"
8392 in the tail. That is because for fish "\" is used as an escape
8393 character inside single quotes.
8394
8395 Example of use with a |:!| command: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008396 :exe '!dir ' .. shellescape(expand('<cfile>'), 1)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008397< This results in a directory listing for the file under the
8398 cursor. Example of use with |system()|: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008399 :call system("chmod +w -- " .. shellescape(expand("%")))
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008400< See also |::S|.
8401
8402 Can also be used as a |method|: >
8403 GetCommand()->shellescape()
8404
8405shiftwidth([{col}]) *shiftwidth()*
8406 Returns the effective value of 'shiftwidth'. This is the
8407 'shiftwidth' value unless it is zero, in which case it is the
8408 'tabstop' value. This function was introduced with patch
8409 7.3.694 in 2012, everybody should have it by now (however it
8410 did not allow for the optional {col} argument until 8.1.542).
8411
8412 When there is one argument {col} this is used as column number
8413 for which to return the 'shiftwidth' value. This matters for the
8414 'vartabstop' feature. If the 'vartabstop' setting is enabled and
8415 no {col} argument is given, column 1 will be assumed.
8416
8417 Can also be used as a |method|: >
8418 GetColumn()->shiftwidth()
8419
8420sign_ functions are documented here: |sign-functions-details|
8421
8422
8423simplify({filename}) *simplify()*
8424 Simplify the file name as much as possible without changing
8425 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
8426 Unix) are not resolved. If the first path component in
8427 {filename} designates the current directory, this will be
8428 valid for the result as well. A trailing path separator is
8429 not removed either. On Unix "//path" is unchanged, but
8430 "///path" is simplified to "/path" (this follows the Posix
8431 standard).
8432 Example: >
8433 simplify("./dir/.././/file/") == "./file/"
8434< Note: The combination "dir/.." is only removed if "dir" is
8435 a searchable directory or does not exist. On Unix, it is also
8436 removed when "dir" is a symbolic link within the same
8437 directory. In order to resolve all the involved symbolic
8438 links before simplifying the path name, use |resolve()|.
8439
8440 Can also be used as a |method|: >
8441 GetName()->simplify()
8442
8443sin({expr}) *sin()*
8444 Return the sine of {expr}, measured in radians, as a |Float|.
8445 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008446 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008447 Examples: >
8448 :echo sin(100)
8449< -0.506366 >
8450 :echo sin(-4.01)
8451< 0.763301
8452
8453 Can also be used as a |method|: >
8454 Compute()->sin()
8455<
8456 {only available when compiled with the |+float| feature}
8457
8458
8459sinh({expr}) *sinh()*
8460 Return the hyperbolic sine of {expr} as a |Float| in the range
8461 [-inf, inf].
8462 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008463 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008464 Examples: >
8465 :echo sinh(0.5)
8466< 0.521095 >
8467 :echo sinh(-0.9)
8468< -1.026517
8469
8470 Can also be used as a |method|: >
8471 Compute()->sinh()
8472<
8473 {only available when compiled with the |+float| feature}
8474
8475
8476slice({expr}, {start} [, {end}]) *slice()*
8477 Similar to using a |slice| "expr[start : end]", but "end" is
8478 used exclusive. And for a string the indexes are used as
8479 character indexes instead of byte indexes, like in
8480 |vim9script|. Also, composing characters are not counted.
8481 When {end} is omitted the slice continues to the last item.
8482 When {end} is -1 the last item is omitted.
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008483 Returns an empty value if {start} or {end} are invalid.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008484
8485 Can also be used as a |method|: >
8486 GetList()->slice(offset)
8487
8488
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008489sort({list} [, {how} [, {dict}]]) *sort()* *E702*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008490 Sort the items in {list} in-place. Returns {list}.
8491
8492 If you want a list to remain unmodified make a copy first: >
8493 :let sortedlist = sort(copy(mylist))
8494
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01008495< When {how} is omitted or is a string, then sort() uses the
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008496 string representation of each item to sort on. Numbers sort
8497 after Strings, |Lists| after Numbers. For sorting text in the
8498 current buffer use |:sort|.
8499
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008500 When {how} is given and it is 'i' then case is ignored.
8501 In legacy script, for backwards compatibility, the value one
8502 can be used to ignore case. Zero means to not ignore case.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008503
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008504 When {how} is given and it is 'l' then the current collation
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008505 locale is used for ordering. Implementation details: strcoll()
8506 is used to compare strings. See |:language| check or set the
8507 collation locale. |v:collate| can also be used to check the
8508 current locale. Sorting using the locale typically ignores
8509 case. Example: >
8510 " ö is sorted similarly to o with English locale.
8511 :language collate en_US.UTF8
8512 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
8513< ['n', 'o', 'O', 'ö', 'p', 'z'] ~
8514>
8515 " ö is sorted after z with Swedish locale.
8516 :language collate sv_SE.UTF8
8517 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
8518< ['n', 'o', 'O', 'p', 'z', 'ö'] ~
8519 This does not work properly on Mac.
8520
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008521 When {how} is given and it is 'n' then all items will be
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008522 sorted numerical (Implementation detail: this uses the
8523 strtod() function to parse numbers, Strings, Lists, Dicts and
8524 Funcrefs will be considered as being 0).
8525
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008526 When {how} is given and it is 'N' then all items will be
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008527 sorted numerical. This is like 'n' but a string containing
8528 digits will be used as the number they represent.
8529
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008530 When {how} is given and it is 'f' then all items will be
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008531 sorted numerical. All values must be a Number or a Float.
8532
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008533 When {how} is a |Funcref| or a function name, this function
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008534 is called to compare items. The function is invoked with two
8535 items as argument and must return zero if they are equal, 1 or
8536 bigger if the first one sorts after the second one, -1 or
8537 smaller if the first one sorts before the second one.
8538
8539 {dict} is for functions with the "dict" attribute. It will be
8540 used to set the local variable "self". |Dictionary-function|
8541
8542 The sort is stable, items which compare equal (as number or as
8543 string) will keep their relative position. E.g., when sorting
8544 on numbers, text strings will sort next to each other, in the
8545 same order as they were originally.
8546
8547 Can also be used as a |method|: >
8548 mylist->sort()
8549
8550< Also see |uniq()|.
8551
8552 Example: >
8553 func MyCompare(i1, i2)
8554 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
8555 endfunc
8556 eval mylist->sort("MyCompare")
8557< A shorter compare version for this specific simple case, which
8558 ignores overflow: >
8559 func MyCompare(i1, i2)
8560 return a:i1 - a:i2
8561 endfunc
8562< For a simple expression you can use a lambda: >
8563 eval mylist->sort({i1, i2 -> i1 - i2})
8564<
8565sound_clear() *sound_clear()*
8566 Stop playing all sounds.
8567
8568 On some Linux systems you may need the libcanberra-pulse
8569 package, otherwise sound may not stop.
8570
8571 {only available when compiled with the |+sound| feature}
8572
8573 *sound_playevent()*
8574sound_playevent({name} [, {callback}])
8575 Play a sound identified by {name}. Which event names are
8576 supported depends on the system. Often the XDG sound names
8577 are used. On Ubuntu they may be found in
8578 /usr/share/sounds/freedesktop/stereo. Example: >
8579 call sound_playevent('bell')
8580< On MS-Windows, {name} can be SystemAsterisk, SystemDefault,
8581 SystemExclamation, SystemExit, SystemHand, SystemQuestion,
8582 SystemStart, SystemWelcome, etc.
8583
8584 When {callback} is specified it is invoked when the sound is
8585 finished. The first argument is the sound ID, the second
8586 argument is the status:
8587 0 sound was played to the end
8588 1 sound was interrupted
8589 2 error occurred after sound started
8590 Example: >
8591 func Callback(id, status)
8592 echomsg "sound " .. a:id .. " finished with " .. a:status
8593 endfunc
8594 call sound_playevent('bell', 'Callback')
8595
8596< MS-Windows: {callback} doesn't work for this function.
8597
8598 Returns the sound ID, which can be passed to `sound_stop()`.
8599 Returns zero if the sound could not be played.
8600
8601 Can also be used as a |method|: >
8602 GetSoundName()->sound_playevent()
8603
8604< {only available when compiled with the |+sound| feature}
8605
8606 *sound_playfile()*
8607sound_playfile({path} [, {callback}])
8608 Like `sound_playevent()` but play sound file {path}. {path}
8609 must be a full path. On Ubuntu you may find files to play
8610 with this command: >
8611 :!find /usr/share/sounds -type f | grep -v index.theme
8612
8613< Can also be used as a |method|: >
8614 GetSoundPath()->sound_playfile()
8615
Bram Moolenaar1588bc82022-03-08 21:35:07 +00008616< {only available when compiled with the |+sound| feature}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008617
8618
8619sound_stop({id}) *sound_stop()*
8620 Stop playing sound {id}. {id} must be previously returned by
8621 `sound_playevent()` or `sound_playfile()`.
8622
8623 On some Linux systems you may need the libcanberra-pulse
8624 package, otherwise sound may not stop.
8625
8626 On MS-Windows, this does not work for event sound started by
8627 `sound_playevent()`. To stop event sounds, use `sound_clear()`.
8628
8629 Can also be used as a |method|: >
8630 soundid->sound_stop()
8631
8632< {only available when compiled with the |+sound| feature}
8633
8634 *soundfold()*
8635soundfold({word})
8636 Return the sound-folded equivalent of {word}. Uses the first
8637 language in 'spelllang' for the current window that supports
8638 soundfolding. 'spell' must be set. When no sound folding is
8639 possible the {word} is returned unmodified.
8640 This can be used for making spelling suggestions. Note that
8641 the method can be quite slow.
8642
8643 Can also be used as a |method|: >
8644 GetWord()->soundfold()
8645<
8646 *spellbadword()*
8647spellbadword([{sentence}])
8648 Without argument: The result is the badly spelled word under
8649 or after the cursor. The cursor is moved to the start of the
8650 bad word. When no bad word is found in the cursor line the
8651 result is an empty string and the cursor doesn't move.
8652
8653 With argument: The result is the first word in {sentence} that
8654 is badly spelled. If there are no spelling mistakes the
8655 result is an empty string.
8656
8657 The return value is a list with two items:
8658 - The badly spelled word or an empty string.
8659 - The type of the spelling error:
8660 "bad" spelling mistake
8661 "rare" rare word
8662 "local" word only valid in another region
8663 "caps" word should start with Capital
8664 Example: >
8665 echo spellbadword("the quik brown fox")
8666< ['quik', 'bad'] ~
8667
8668 The spelling information for the current window and the value
8669 of 'spelllang' are used.
8670
8671 Can also be used as a |method|: >
8672 GetText()->spellbadword()
8673<
8674 *spellsuggest()*
8675spellsuggest({word} [, {max} [, {capital}]])
8676 Return a |List| with spelling suggestions to replace {word}.
8677 When {max} is given up to this number of suggestions are
8678 returned. Otherwise up to 25 suggestions are returned.
8679
8680 When the {capital} argument is given and it's non-zero only
8681 suggestions with a leading capital will be given. Use this
8682 after a match with 'spellcapcheck'.
8683
8684 {word} can be a badly spelled word followed by other text.
8685 This allows for joining two words that were split. The
8686 suggestions also include the following text, thus you can
8687 replace a line.
8688
8689 {word} may also be a good word. Similar words will then be
8690 returned. {word} itself is not included in the suggestions,
8691 although it may appear capitalized.
8692
8693 The spelling information for the current window is used. The
8694 values of 'spelllang' and 'spellsuggest' are used.
8695
8696 Can also be used as a |method|: >
8697 GetWord()->spellsuggest()
8698
8699split({string} [, {pattern} [, {keepempty}]]) *split()*
8700 Make a |List| out of {string}. When {pattern} is omitted or
8701 empty each white-separated sequence of characters becomes an
8702 item.
8703 Otherwise the string is split where {pattern} matches,
8704 removing the matched characters. 'ignorecase' is not used
8705 here, add \c to ignore case. |/\c|
8706 When the first or last item is empty it is omitted, unless the
8707 {keepempty} argument is given and it's non-zero.
8708 Other empty items are kept when {pattern} matches at least one
8709 character or when {keepempty} is non-zero.
8710 Example: >
8711 :let words = split(getline('.'), '\W\+')
8712< To split a string in individual characters: >
8713 :for c in split(mystring, '\zs')
8714< If you want to keep the separator you can also use '\zs' at
8715 the end of the pattern: >
8716 :echo split('abc:def:ghi', ':\zs')
8717< ['abc:', 'def:', 'ghi'] ~
8718 Splitting a table where the first element can be empty: >
8719 :let items = split(line, ':', 1)
8720< The opposite function is |join()|.
8721
8722 Can also be used as a |method|: >
8723 GetString()->split()
8724
8725sqrt({expr}) *sqrt()*
8726 Return the non-negative square root of Float {expr} as a
8727 |Float|.
8728 {expr} must evaluate to a |Float| or a |Number|. When {expr}
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008729 is negative the result is NaN (Not a Number). Returns 0.0 if
8730 {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008731 Examples: >
8732 :echo sqrt(100)
8733< 10.0 >
8734 :echo sqrt(-4.01)
8735< nan
8736 "nan" may be different, it depends on system libraries.
8737
8738 Can also be used as a |method|: >
8739 Compute()->sqrt()
8740<
8741 {only available when compiled with the |+float| feature}
8742
8743
8744srand([{expr}]) *srand()*
8745 Initialize seed used by |rand()|:
8746 - If {expr} is not given, seed values are initialized by
8747 reading from /dev/urandom, if possible, or using time(NULL)
8748 a.k.a. epoch time otherwise; this only has second accuracy.
8749 - If {expr} is given it must be a Number. It is used to
8750 initialize the seed values. This is useful for testing or
8751 when a predictable sequence is intended.
8752
8753 Examples: >
8754 :let seed = srand()
8755 :let seed = srand(userinput)
8756 :echo rand(seed)
8757
8758state([{what}]) *state()*
8759 Return a string which contains characters indicating the
8760 current state. Mostly useful in callbacks that want to do
8761 work that may not always be safe. Roughly this works like:
8762 - callback uses state() to check if work is safe to do.
8763 Yes: then do it right away.
8764 No: add to work queue and add a |SafeState| and/or
8765 |SafeStateAgain| autocommand (|SafeState| triggers at
8766 toplevel, |SafeStateAgain| triggers after handling
8767 messages and callbacks).
8768 - When SafeState or SafeStateAgain is triggered and executes
8769 your autocommand, check with `state()` if the work can be
8770 done now, and if yes remove it from the queue and execute.
8771 Remove the autocommand if the queue is now empty.
8772 Also see |mode()|.
8773
8774 When {what} is given only characters in this string will be
8775 added. E.g, this checks if the screen has scrolled: >
8776 if state('s') == ''
8777 " screen has not scrolled
8778<
8779 These characters indicate the state, generally indicating that
8780 something is busy:
8781 m halfway a mapping, :normal command, feedkeys() or
8782 stuffed command
8783 o operator pending, e.g. after |d|
8784 a Insert mode autocomplete active
8785 x executing an autocommand
8786 w blocked on waiting, e.g. ch_evalexpr(), ch_read() and
8787 ch_readraw() when reading json
8788 S not triggering SafeState or SafeStateAgain, e.g. after
8789 |f| or a count
8790 c callback invoked, including timer (repeats for
8791 recursiveness up to "ccc")
8792 s screen has scrolled for messages
8793
8794str2float({string} [, {quoted}]) *str2float()*
8795 Convert String {string} to a Float. This mostly works the
8796 same as when using a floating point number in an expression,
8797 see |floating-point-format|. But it's a bit more permissive.
8798 E.g., "1e40" is accepted, while in an expression you need to
8799 write "1.0e40". The hexadecimal form "0x123" is also
8800 accepted, but not others, like binary or octal.
8801 When {quoted} is present and non-zero then embedded single
8802 quotes before the dot are ignored, thus "1'000.0" is a
8803 thousand.
8804 Text after the number is silently ignored.
8805 The decimal point is always '.', no matter what the locale is
8806 set to. A comma ends the number: "12,345.67" is converted to
8807 12.0. You can strip out thousands separators with
8808 |substitute()|: >
8809 let f = str2float(substitute(text, ',', '', 'g'))
8810<
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008811 Returns 0.0 if the conversion fails.
8812
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008813 Can also be used as a |method|: >
8814 let f = text->substitute(',', '', 'g')->str2float()
8815<
8816 {only available when compiled with the |+float| feature}
8817
8818str2list({string} [, {utf8}]) *str2list()*
8819 Return a list containing the number values which represent
8820 each character in String {string}. Examples: >
8821 str2list(" ") returns [32]
8822 str2list("ABC") returns [65, 66, 67]
8823< |list2str()| does the opposite.
8824
8825 When {utf8} is omitted or zero, the current 'encoding' is used.
8826 When {utf8} is TRUE, always treat the String as UTF-8
8827 characters. With UTF-8 composing characters are handled
8828 properly: >
8829 str2list("á") returns [97, 769]
8830
8831< Can also be used as a |method|: >
8832 GetString()->str2list()
8833
8834
8835str2nr({string} [, {base} [, {quoted}]]) *str2nr()*
8836 Convert string {string} to a number.
8837 {base} is the conversion base, it can be 2, 8, 10 or 16.
8838 When {quoted} is present and non-zero then embedded single
8839 quotes are ignored, thus "1'000'000" is a million.
8840
8841 When {base} is omitted base 10 is used. This also means that
8842 a leading zero doesn't cause octal conversion to be used, as
8843 with the default String to Number conversion. Example: >
8844 let nr = str2nr('0123')
8845<
8846 When {base} is 16 a leading "0x" or "0X" is ignored. With a
8847 different base the result will be zero. Similarly, when
8848 {base} is 8 a leading "0", "0o" or "0O" is ignored, and when
8849 {base} is 2 a leading "0b" or "0B" is ignored.
8850 Text after the number is silently ignored.
8851
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008852 Returns 0 if {string} is empty or on error.
8853
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008854 Can also be used as a |method|: >
8855 GetText()->str2nr()
8856
8857
8858strcharlen({string}) *strcharlen()*
8859 The result is a Number, which is the number of characters
8860 in String {string}. Composing characters are ignored.
8861 |strchars()| can count the number of characters, counting
8862 composing characters separately.
8863
Bram Moolenaar6ba83ba2022-06-12 22:15:57 +01008864 Returns 0 if {string} is empty or on error.
8865
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008866 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
8867
8868 Can also be used as a |method|: >
8869 GetText()->strcharlen()
8870
8871
8872strcharpart({src}, {start} [, {len} [, {skipcc}]]) *strcharpart()*
8873 Like |strpart()| but using character index and length instead
8874 of byte index and length.
8875 When {skipcc} is omitted or zero, composing characters are
8876 counted separately.
8877 When {skipcc} set to 1, Composing characters are ignored,
8878 similar to |slice()|.
8879 When a character index is used where a character does not
8880 exist it is omitted and counted as one character. For
8881 example: >
8882 strcharpart('abc', -1, 2)
8883< results in 'a'.
8884
Bram Moolenaard592deb2022-06-17 15:42:40 +01008885 Returns an empty string on error.
8886
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008887 Can also be used as a |method|: >
8888 GetText()->strcharpart(5)
8889
8890
8891strchars({string} [, {skipcc}]) *strchars()*
8892 The result is a Number, which is the number of characters
8893 in String {string}.
8894 When {skipcc} is omitted or zero, composing characters are
8895 counted separately.
8896 When {skipcc} set to 1, Composing characters are ignored.
8897 |strcharlen()| always does this.
8898
Bram Moolenaard592deb2022-06-17 15:42:40 +01008899 Returns zero on error.
8900
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008901 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
8902
8903 {skipcc} is only available after 7.4.755. For backward
8904 compatibility, you can define a wrapper function: >
8905 if has("patch-7.4.755")
8906 function s:strchars(str, skipcc)
8907 return strchars(a:str, a:skipcc)
8908 endfunction
8909 else
8910 function s:strchars(str, skipcc)
8911 if a:skipcc
8912 return strlen(substitute(a:str, ".", "x", "g"))
8913 else
8914 return strchars(a:str)
8915 endif
8916 endfunction
8917 endif
8918<
8919 Can also be used as a |method|: >
8920 GetText()->strchars()
8921
8922strdisplaywidth({string} [, {col}]) *strdisplaywidth()*
8923 The result is a Number, which is the number of display cells
8924 String {string} occupies on the screen when it starts at {col}
8925 (first column is zero). When {col} is omitted zero is used.
8926 Otherwise it is the screen column where to start. This
8927 matters for Tab characters.
8928 The option settings of the current window are used. This
8929 matters for anything that's displayed differently, such as
8930 'tabstop' and 'display'.
8931 When {string} contains characters with East Asian Width Class
8932 Ambiguous, this function's return value depends on 'ambiwidth'.
Bram Moolenaard592deb2022-06-17 15:42:40 +01008933 Returns zero on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008934 Also see |strlen()|, |strwidth()| and |strchars()|.
8935
8936 Can also be used as a |method|: >
8937 GetText()->strdisplaywidth()
8938
8939strftime({format} [, {time}]) *strftime()*
8940 The result is a String, which is a formatted date and time, as
8941 specified by the {format} string. The given {time} is used,
8942 or the current time if no time is given. The accepted
8943 {format} depends on your system, thus this is not portable!
8944 See the manual page of the C function strftime() for the
8945 format. The maximum length of the result is 80 characters.
8946 See also |localtime()|, |getftime()| and |strptime()|.
8947 The language can be changed with the |:language| command.
8948 Examples: >
8949 :echo strftime("%c") Sun Apr 27 11:49:23 1997
8950 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
8951 :echo strftime("%y%m%d %T") 970427 11:53:55
8952 :echo strftime("%H:%M") 11:55
8953 :echo strftime("%c", getftime("file.c"))
8954 Show mod time of file.c.
8955< Not available on all systems. To check use: >
8956 :if exists("*strftime")
8957
8958< Can also be used as a |method|: >
8959 GetFormat()->strftime()
8960
8961strgetchar({str}, {index}) *strgetchar()*
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01008962 Get a Number corresponding to the character at {index} in
8963 {str}. This uses a zero-based character index, not a byte
8964 index. Composing characters are considered separate
8965 characters here. Use |nr2char()| to convert the Number to a
8966 String.
Bram Moolenaard592deb2022-06-17 15:42:40 +01008967 Returns -1 if {index} is invalid.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008968 Also see |strcharpart()| and |strchars()|.
8969
8970 Can also be used as a |method|: >
8971 GetText()->strgetchar(5)
8972
8973stridx({haystack}, {needle} [, {start}]) *stridx()*
8974 The result is a Number, which gives the byte index in
8975 {haystack} of the first occurrence of the String {needle}.
8976 If {start} is specified, the search starts at index {start}.
8977 This can be used to find a second match: >
8978 :let colon1 = stridx(line, ":")
8979 :let colon2 = stridx(line, ":", colon1 + 1)
8980< The search is done case-sensitive.
8981 For pattern searches use |match()|.
8982 -1 is returned if the {needle} does not occur in {haystack}.
8983 See also |strridx()|.
8984 Examples: >
8985 :echo stridx("An Example", "Example") 3
8986 :echo stridx("Starting point", "Start") 0
8987 :echo stridx("Starting point", "start") -1
8988< *strstr()* *strchr()*
8989 stridx() works similar to the C function strstr(). When used
8990 with a single character it works similar to strchr().
8991
8992 Can also be used as a |method|: >
8993 GetHaystack()->stridx(needle)
8994<
8995 *string()*
8996string({expr}) Return {expr} converted to a String. If {expr} is a Number,
8997 Float, String, Blob or a composition of them, then the result
8998 can be parsed back with |eval()|.
8999 {expr} type result ~
9000 String 'string' (single quotes are doubled)
9001 Number 123
9002 Float 123.123456 or 1.123456e8
9003 Funcref function('name')
9004 Blob 0z00112233.44556677.8899
9005 List [item, item]
9006 Dictionary {key: value, key: value}
9007
9008 When a |List| or |Dictionary| has a recursive reference it is
9009 replaced by "[...]" or "{...}". Using eval() on the result
9010 will then fail.
9011
9012 Can also be used as a |method|: >
9013 mylist->string()
9014
9015< Also see |strtrans()|.
9016
9017
9018strlen({string}) *strlen()*
9019 The result is a Number, which is the length of the String
9020 {string} in bytes.
9021 If the argument is a Number it is first converted to a String.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009022 For other types an error is given and zero is returned.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009023 If you want to count the number of multibyte characters use
9024 |strchars()|.
9025 Also see |len()|, |strdisplaywidth()| and |strwidth()|.
9026
9027 Can also be used as a |method|: >
9028 GetString()->strlen()
9029
9030strpart({src}, {start} [, {len} [, {chars}]]) *strpart()*
9031 The result is a String, which is part of {src}, starting from
9032 byte {start}, with the byte length {len}.
9033 When {chars} is present and TRUE then {len} is the number of
9034 characters positions (composing characters are not counted
9035 separately, thus "1" means one base character and any
9036 following composing characters).
9037 To count {start} as characters instead of bytes use
9038 |strcharpart()|.
9039
9040 When bytes are selected which do not exist, this doesn't
9041 result in an error, the bytes are simply omitted.
9042 If {len} is missing, the copy continues from {start} till the
9043 end of the {src}. >
9044 strpart("abcdefg", 3, 2) == "de"
9045 strpart("abcdefg", -2, 4) == "ab"
9046 strpart("abcdefg", 5, 4) == "fg"
9047 strpart("abcdefg", 3) == "defg"
9048
9049< Note: To get the first character, {start} must be 0. For
9050 example, to get the character under the cursor: >
9051 strpart(getline("."), col(".") - 1, 1, v:true)
9052<
Bram Moolenaard592deb2022-06-17 15:42:40 +01009053 Returns an empty string on error.
9054
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009055 Can also be used as a |method|: >
9056 GetText()->strpart(5)
9057
9058strptime({format}, {timestring}) *strptime()*
9059 The result is a Number, which is a unix timestamp representing
9060 the date and time in {timestring}, which is expected to match
9061 the format specified in {format}.
9062
9063 The accepted {format} depends on your system, thus this is not
9064 portable! See the manual page of the C function strptime()
9065 for the format. Especially avoid "%c". The value of $TZ also
9066 matters.
9067
9068 If the {timestring} cannot be parsed with {format} zero is
9069 returned. If you do not know the format of {timestring} you
9070 can try different {format} values until you get a non-zero
9071 result.
9072
9073 See also |strftime()|.
9074 Examples: >
9075 :echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23")
9076< 862156163 >
9077 :echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55"))
9078< Sun Apr 27 11:53:55 1997 >
9079 :echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
9080< Sun Apr 27 12:53:55 1997
9081
9082 Can also be used as a |method|: >
9083 GetFormat()->strptime(timestring)
9084<
9085 Not available on all systems. To check use: >
9086 :if exists("*strptime")
9087
9088strridx({haystack}, {needle} [, {start}]) *strridx()*
9089 The result is a Number, which gives the byte index in
9090 {haystack} of the last occurrence of the String {needle}.
9091 When {start} is specified, matches beyond this index are
9092 ignored. This can be used to find a match before a previous
9093 match: >
9094 :let lastcomma = strridx(line, ",")
9095 :let comma2 = strridx(line, ",", lastcomma - 1)
9096< The search is done case-sensitive.
9097 For pattern searches use |match()|.
9098 -1 is returned if the {needle} does not occur in {haystack}.
9099 If the {needle} is empty the length of {haystack} is returned.
9100 See also |stridx()|. Examples: >
9101 :echo strridx("an angry armadillo", "an") 3
9102< *strrchr()*
9103 When used with a single character it works similar to the C
9104 function strrchr().
9105
9106 Can also be used as a |method|: >
9107 GetHaystack()->strridx(needle)
9108
9109strtrans({string}) *strtrans()*
9110 The result is a String, which is {string} with all unprintable
9111 characters translated into printable characters |'isprint'|.
9112 Like they are shown in a window. Example: >
9113 echo strtrans(@a)
9114< This displays a newline in register a as "^@" instead of
9115 starting a new line.
9116
Bram Moolenaard592deb2022-06-17 15:42:40 +01009117 Returns an empty string on error.
9118
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009119 Can also be used as a |method|: >
9120 GetString()->strtrans()
9121
9122strwidth({string}) *strwidth()*
9123 The result is a Number, which is the number of display cells
9124 String {string} occupies. A Tab character is counted as one
9125 cell, alternatively use |strdisplaywidth()|.
9126 When {string} contains characters with East Asian Width Class
9127 Ambiguous, this function's return value depends on 'ambiwidth'.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009128 Returns zero on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009129 Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
9130
9131 Can also be used as a |method|: >
9132 GetString()->strwidth()
9133
9134submatch({nr} [, {list}]) *submatch()* *E935*
9135 Only for an expression in a |:substitute| command or
9136 substitute() function.
9137 Returns the {nr}'th submatch of the matched text. When {nr}
9138 is 0 the whole matched text is returned.
9139 Note that a NL in the string can stand for a line break of a
9140 multi-line match or a NUL character in the text.
9141 Also see |sub-replace-expression|.
9142
9143 If {list} is present and non-zero then submatch() returns
9144 a list of strings, similar to |getline()| with two arguments.
9145 NL characters in the text represent NUL characters in the
9146 text.
9147 Only returns more than one item for |:substitute|, inside
9148 |substitute()| this list will always contain one or zero
9149 items, since there are no real line breaks.
9150
9151 When substitute() is used recursively only the submatches in
9152 the current (deepest) call can be obtained.
9153
Bram Moolenaard592deb2022-06-17 15:42:40 +01009154 Returns an empty string or list on error.
9155
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009156 Examples: >
9157 :s/\d\+/\=submatch(0) + 1/
9158 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
9159< This finds the first number in the line and adds one to it.
9160 A line break is included as a newline character.
9161
9162 Can also be used as a |method|: >
9163 GetNr()->submatch()
9164
9165substitute({string}, {pat}, {sub}, {flags}) *substitute()*
9166 The result is a String, which is a copy of {string}, in which
9167 the first match of {pat} is replaced with {sub}.
9168 When {flags} is "g", all matches of {pat} in {string} are
9169 replaced. Otherwise {flags} should be "".
9170
9171 This works like the ":substitute" command (without any flags).
9172 But the matching with {pat} is always done like the 'magic'
9173 option is set and 'cpoptions' is empty (to make scripts
9174 portable). 'ignorecase' is still relevant, use |/\c| or |/\C|
9175 if you want to ignore or match case and ignore 'ignorecase'.
9176 'smartcase' is not used. See |string-match| for how {pat} is
9177 used.
9178
9179 A "~" in {sub} is not replaced with the previous {sub}.
9180 Note that some codes in {sub} have a special meaning
9181 |sub-replace-special|. For example, to replace something with
9182 "\n" (two characters), use "\\\\n" or '\\n'.
9183
9184 When {pat} does not match in {string}, {string} is returned
9185 unmodified.
9186
9187 Example: >
9188 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
9189< This removes the last component of the 'path' option. >
9190 :echo substitute("testing", ".*", "\\U\\0", "")
9191< results in "TESTING".
9192
9193 When {sub} starts with "\=", the remainder is interpreted as
9194 an expression. See |sub-replace-expression|. Example: >
9195 :echo substitute(s, '%\(\x\x\)',
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009196 \ '\=nr2char("0x" .. submatch(1))', 'g')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009197
9198< When {sub} is a Funcref that function is called, with one
9199 optional argument. Example: >
9200 :echo substitute(s, '%\(\x\x\)', SubNr, 'g')
9201< The optional argument is a list which contains the whole
9202 matched string and up to nine submatches, like what
9203 |submatch()| returns. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009204 :echo substitute(s, '%\(\x\x\)', {m -> '0x' .. m[1]}, 'g')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009205
Bram Moolenaard592deb2022-06-17 15:42:40 +01009206< Returns an empty string on error.
9207
9208 Can also be used as a |method|: >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009209 GetString()->substitute(pat, sub, flags)
9210
9211swapinfo({fname}) *swapinfo()*
9212 The result is a dictionary, which holds information about the
9213 swapfile {fname}. The available fields are:
9214 version Vim version
9215 user user name
9216 host host name
9217 fname original file name
9218 pid PID of the Vim process that created the swap
9219 file
9220 mtime last modification time in seconds
9221 inode Optional: INODE number of the file
9222 dirty 1 if file was modified, 0 if not
9223 Note that "user" and "host" are truncated to at most 39 bytes.
9224 In case of failure an "error" item is added with the reason:
9225 Cannot open file: file not found or in accessible
9226 Cannot read file: cannot read first block
9227 Not a swap file: does not contain correct block ID
9228 Magic number mismatch: Info in first block is invalid
9229
9230 Can also be used as a |method|: >
9231 GetFilename()->swapinfo()
9232
9233swapname({buf}) *swapname()*
9234 The result is the swap file path of the buffer {expr}.
9235 For the use of {buf}, see |bufname()| above.
9236 If buffer {buf} is the current buffer, the result is equal to
9237 |:swapname| (unless there is no swap file).
9238 If buffer {buf} has no swap file, returns an empty string.
9239
9240 Can also be used as a |method|: >
9241 GetBufname()->swapname()
9242
9243synID({lnum}, {col}, {trans}) *synID()*
9244 The result is a Number, which is the syntax ID at the position
9245 {lnum} and {col} in the current window.
9246 The syntax ID can be used with |synIDattr()| and
9247 |synIDtrans()| to obtain syntax information about text.
9248
9249 {col} is 1 for the leftmost column, {lnum} is 1 for the first
9250 line. 'synmaxcol' applies, in a longer line zero is returned.
9251 Note that when the position is after the last character,
9252 that's where the cursor can be in Insert mode, synID() returns
9253 zero. {lnum} is used like with |getline()|.
9254
9255 When {trans} is |TRUE|, transparent items are reduced to the
9256 item that they reveal. This is useful when wanting to know
9257 the effective color. When {trans} is |FALSE|, the transparent
9258 item is returned. This is useful when wanting to know which
9259 syntax item is effective (e.g. inside parens).
9260 Warning: This function can be very slow. Best speed is
9261 obtained by going through the file in forward direction.
9262
Bram Moolenaard592deb2022-06-17 15:42:40 +01009263 Returns zero on error.
9264
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009265 Example (echoes the name of the syntax item under the cursor): >
9266 :echo synIDattr(synID(line("."), col("."), 1), "name")
9267<
9268
9269synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
9270 The result is a String, which is the {what} attribute of
9271 syntax ID {synID}. This can be used to obtain information
9272 about a syntax item.
9273 {mode} can be "gui", "cterm" or "term", to get the attributes
9274 for that mode. When {mode} is omitted, or an invalid value is
9275 used, the attributes for the currently active highlighting are
9276 used (GUI, cterm or term).
9277 Use synIDtrans() to follow linked highlight groups.
9278 {what} result
9279 "name" the name of the syntax item
9280 "fg" foreground color (GUI: color name used to set
9281 the color, cterm: color number as a string,
9282 term: empty string)
9283 "bg" background color (as with "fg")
9284 "font" font name (only available in the GUI)
9285 |highlight-font|
9286 "sp" special color for the GUI (as with "fg")
9287 |highlight-guisp|
9288 "ul" underline color for cterm: number as a string
9289 "fg#" like "fg", but for the GUI and the GUI is
9290 running the name in "#RRGGBB" form
9291 "bg#" like "fg#" for "bg"
9292 "sp#" like "fg#" for "sp"
9293 "bold" "1" if bold
9294 "italic" "1" if italic
9295 "reverse" "1" if reverse
9296 "inverse" "1" if inverse (= reverse)
9297 "standout" "1" if standout
9298 "underline" "1" if underlined
9299 "undercurl" "1" if undercurled
9300 "strike" "1" if strikethrough
Bram Moolenaarde786322022-07-30 14:56:17 +01009301 "nocombine" "1" if nocombine
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009302
Bram Moolenaard592deb2022-06-17 15:42:40 +01009303 Returns an empty string on error.
9304
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009305 Example (echoes the color of the syntax item under the
9306 cursor): >
9307 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
9308<
9309 Can also be used as a |method|: >
9310 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
9311
9312
9313synIDtrans({synID}) *synIDtrans()*
9314 The result is a Number, which is the translated syntax ID of
9315 {synID}. This is the syntax group ID of what is being used to
9316 highlight the character. Highlight links given with
9317 ":highlight link" are followed.
9318
Bram Moolenaard592deb2022-06-17 15:42:40 +01009319 Returns zero on error.
9320
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009321 Can also be used as a |method|: >
9322 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
9323
9324synconcealed({lnum}, {col}) *synconcealed()*
9325 The result is a |List| with currently three items:
9326 1. The first item in the list is 0 if the character at the
9327 position {lnum} and {col} is not part of a concealable
9328 region, 1 if it is. {lnum} is used like with |getline()|.
9329 2. The second item in the list is a string. If the first item
9330 is 1, the second item contains the text which will be
9331 displayed in place of the concealed text, depending on the
9332 current setting of 'conceallevel' and 'listchars'.
9333 3. The third and final item in the list is a number
9334 representing the specific syntax region matched in the
9335 line. When the character is not concealed the value is
9336 zero. This allows detection of the beginning of a new
9337 concealable region if there are two consecutive regions
9338 with the same replacement character. For an example, if
9339 the text is "123456" and both "23" and "45" are concealed
9340 and replaced by the character "X", then:
9341 call returns ~
9342 synconcealed(lnum, 1) [0, '', 0]
9343 synconcealed(lnum, 2) [1, 'X', 1]
9344 synconcealed(lnum, 3) [1, 'X', 1]
9345 synconcealed(lnum, 4) [1, 'X', 2]
9346 synconcealed(lnum, 5) [1, 'X', 2]
9347 synconcealed(lnum, 6) [0, '', 0]
9348
9349
9350synstack({lnum}, {col}) *synstack()*
9351 Return a |List|, which is the stack of syntax items at the
9352 position {lnum} and {col} in the current window. {lnum} is
9353 used like with |getline()|. Each item in the List is an ID
9354 like what |synID()| returns.
9355 The first item in the List is the outer region, following are
9356 items contained in that one. The last one is what |synID()|
9357 returns, unless not the whole item is highlighted or it is a
9358 transparent item.
9359 This function is useful for debugging a syntax file.
9360 Example that shows the syntax stack under the cursor: >
9361 for id in synstack(line("."), col("."))
9362 echo synIDattr(id, "name")
9363 endfor
9364< When the position specified with {lnum} and {col} is invalid
Bram Moolenaard592deb2022-06-17 15:42:40 +01009365 an empty List is returned. The position just after the last
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009366 character in a line and the first column in an empty line are
9367 valid positions.
9368
9369system({expr} [, {input}]) *system()* *E677*
9370 Get the output of the shell command {expr} as a |String|. See
9371 |systemlist()| to get the output as a |List|.
9372
9373 When {input} is given and is a |String| this string is written
9374 to a file and passed as stdin to the command. The string is
9375 written as-is, you need to take care of using the correct line
9376 separators yourself.
9377 If {input} is given and is a |List| it is written to the file
9378 in a way |writefile()| does with {binary} set to "b" (i.e.
9379 with a newline between each list item with newlines inside
9380 list items converted to NULs).
9381 When {input} is given and is a number that is a valid id for
9382 an existing buffer then the content of the buffer is written
9383 to the file line by line, each line terminated by a NL and
9384 NULs characters where the text has a NL.
9385
9386 Pipes are not used, the 'shelltemp' option is not used.
9387
9388 When prepended by |:silent| the terminal will not be set to
9389 cooked mode. This is meant to be used for commands that do
9390 not need the user to type. It avoids stray characters showing
9391 up on the screen which require |CTRL-L| to remove. >
9392 :silent let f = system('ls *.vim')
9393<
9394 Note: Use |shellescape()| or |::S| with |expand()| or
9395 |fnamemodify()| to escape special characters in a command
9396 argument. Newlines in {expr} may cause the command to fail.
9397 The characters in 'shellquote' and 'shellxquote' may also
9398 cause trouble.
9399 This is not to be used for interactive commands.
9400
9401 The result is a String. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009402 :let files = system('ls ' .. shellescape(expand('%:h')))
9403 :let files = system('ls ' .. expand('%:h:S'))
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009404
9405< To make the result more system-independent, the shell output
9406 is filtered to replace <CR> with <NL> for Macintosh, and
9407 <CR><NL> with <NL> for DOS-like systems.
9408 To avoid the string being truncated at a NUL, all NUL
9409 characters are replaced with SOH (0x01).
9410
9411 The command executed is constructed using several options:
9412 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
9413 ({tmp} is an automatically generated file name).
9414 For Unix, braces are put around {expr} to allow for
9415 concatenated commands.
9416
9417 The command will be executed in "cooked" mode, so that a
9418 CTRL-C will interrupt the command (on Unix at least).
9419
9420 The resulting error code can be found in |v:shell_error|.
9421 This function will fail in |restricted-mode|.
9422
9423 Note that any wrong value in the options mentioned above may
9424 make the function fail. It has also been reported to fail
9425 when using a security agent application.
9426 Unlike ":!cmd" there is no automatic check for changed files.
9427 Use |:checktime| to force a check.
9428
9429 Can also be used as a |method|: >
9430 :echo GetCmd()->system()
9431
9432
9433systemlist({expr} [, {input}]) *systemlist()*
9434 Same as |system()|, but returns a |List| with lines (parts of
9435 output separated by NL) with NULs transformed into NLs. Output
9436 is the same as |readfile()| will output with {binary} argument
9437 set to "b", except that there is no extra empty item when the
9438 result ends in a NL.
9439 Note that on MS-Windows you may get trailing CR characters.
9440
9441 To see the difference between "echo hello" and "echo -n hello"
9442 use |system()| and |split()|: >
9443 echo system('echo hello')->split('\n', 1)
9444<
9445 Returns an empty string on error.
9446
9447 Can also be used as a |method|: >
9448 :echo GetCmd()->systemlist()
9449
9450
9451tabpagebuflist([{arg}]) *tabpagebuflist()*
9452 The result is a |List|, where each item is the number of the
9453 buffer associated with each window in the current tab page.
9454 {arg} specifies the number of the tab page to be used. When
9455 omitted the current tab page is used.
9456 When {arg} is invalid the number zero is returned.
9457 To get a list of all buffers in all tabs use this: >
9458 let buflist = []
9459 for i in range(tabpagenr('$'))
9460 call extend(buflist, tabpagebuflist(i + 1))
9461 endfor
9462< Note that a buffer may appear in more than one window.
9463
9464 Can also be used as a |method|: >
9465 GetTabpage()->tabpagebuflist()
9466
9467tabpagenr([{arg}]) *tabpagenr()*
9468 The result is a Number, which is the number of the current
9469 tab page. The first tab page has number 1.
9470
9471 The optional argument {arg} supports the following values:
9472 $ the number of the last tab page (the tab page
9473 count).
9474 # the number of the last accessed tab page
9475 (where |g<Tab>| goes to). if there is no
9476 previous tab page 0 is returned.
9477 The number can be used with the |:tab| command.
9478
Bram Moolenaard592deb2022-06-17 15:42:40 +01009479 Returns zero on error.
9480
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009481
9482tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()*
9483 Like |winnr()| but for tab page {tabarg}.
9484 {tabarg} specifies the number of tab page to be used.
9485 {arg} is used like with |winnr()|:
9486 - When omitted the current window number is returned. This is
9487 the window which will be used when going to this tab page.
9488 - When "$" the number of windows is returned.
9489 - When "#" the previous window nr is returned.
9490 Useful examples: >
9491 tabpagewinnr(1) " current window of tab page 1
9492 tabpagewinnr(4, '$') " number of windows in tab page 4
9493< When {tabarg} is invalid zero is returned.
9494
9495 Can also be used as a |method|: >
9496 GetTabpage()->tabpagewinnr()
9497<
9498 *tagfiles()*
9499tagfiles() Returns a |List| with the file names used to search for tags
9500 for the current buffer. This is the 'tags' option expanded.
9501
9502
9503taglist({expr} [, {filename}]) *taglist()*
9504 Returns a |List| of tags matching the regular expression {expr}.
9505
9506 If {filename} is passed it is used to prioritize the results
9507 in the same way that |:tselect| does. See |tag-priority|.
9508 {filename} should be the full path of the file.
9509
9510 Each list item is a dictionary with at least the following
9511 entries:
9512 name Name of the tag.
9513 filename Name of the file where the tag is
9514 defined. It is either relative to the
9515 current directory or a full path.
9516 cmd Ex command used to locate the tag in
9517 the file.
9518 kind Type of the tag. The value for this
9519 entry depends on the language specific
9520 kind values. Only available when
9521 using a tags file generated by
Bram Moolenaar47c532e2022-03-19 15:18:53 +00009522 Universal/Exuberant ctags or hdrtag.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009523 static A file specific tag. Refer to
9524 |static-tag| for more information.
9525 More entries may be present, depending on the content of the
9526 tags file: access, implementation, inherits and signature.
9527 Refer to the ctags documentation for information about these
9528 fields. For C code the fields "struct", "class" and "enum"
9529 may appear, they give the name of the entity the tag is
9530 contained in.
9531
9532 The ex-command "cmd" can be either an ex search pattern, a
9533 line number or a line number followed by a byte number.
9534
9535 If there are no matching tags, then an empty list is returned.
9536
9537 To get an exact tag match, the anchors '^' and '$' should be
9538 used in {expr}. This also make the function work faster.
9539 Refer to |tag-regexp| for more information about the tag
9540 search regular expression pattern.
9541
9542 Refer to |'tags'| for information about how the tags file is
9543 located by Vim. Refer to |tags-file-format| for the format of
9544 the tags file generated by the different ctags tools.
9545
9546 Can also be used as a |method|: >
9547 GetTagpattern()->taglist()
9548
9549tan({expr}) *tan()*
9550 Return the tangent of {expr}, measured in radians, as a |Float|
9551 in the range [-inf, inf].
9552 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009553 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009554 Examples: >
9555 :echo tan(10)
9556< 0.648361 >
9557 :echo tan(-4.01)
9558< -1.181502
9559
9560 Can also be used as a |method|: >
9561 Compute()->tan()
9562<
9563 {only available when compiled with the |+float| feature}
9564
9565
9566tanh({expr}) *tanh()*
9567 Return the hyperbolic tangent of {expr} as a |Float| in the
9568 range [-1, 1].
9569 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009570 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009571 Examples: >
9572 :echo tanh(0.5)
9573< 0.462117 >
9574 :echo tanh(-1)
9575< -0.761594
9576
9577 Can also be used as a |method|: >
9578 Compute()->tanh()
9579<
9580 {only available when compiled with the |+float| feature}
9581
9582
9583tempname() *tempname()* *temp-file-name*
9584 The result is a String, which is the name of a file that
9585 doesn't exist. It can be used for a temporary file. The name
9586 is different for at least 26 consecutive calls. Example: >
9587 :let tmpfile = tempname()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009588 :exe "redir > " .. tmpfile
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009589< For Unix, the file will be in a private directory |tempfile|.
9590 For MS-Windows forward slashes are used when the 'shellslash'
9591 option is set, or when 'shellcmdflag' starts with '-' and
9592 'shell' does not contain powershell or pwsh.
9593
9594
9595term_ functions are documented here: |terminal-function-details|
9596
9597
9598terminalprops() *terminalprops()*
9599 Returns a |Dictionary| with properties of the terminal that Vim
9600 detected from the response to |t_RV| request. See
9601 |v:termresponse| for the response itself. If |v:termresponse|
9602 is empty most values here will be 'u' for unknown.
9603 cursor_style whether sending |t_RS| works **
9604 cursor_blink_mode whether sending |t_RC| works **
9605 underline_rgb whether |t_8u| works **
9606 mouse mouse type supported
9607
9608 ** value 'u' for unknown, 'y' for yes, 'n' for no
9609
9610 If the |+termresponse| feature is missing then the result is
9611 an empty dictionary.
9612
9613 If "cursor_style" is 'y' then |t_RS| will be sent to request the
9614 current cursor style.
9615 If "cursor_blink_mode" is 'y' then |t_RC| will be sent to
9616 request the cursor blink status.
9617 "cursor_style" and "cursor_blink_mode" are also set if |t_u7|
9618 is not empty, Vim will detect the working of sending |t_RS|
9619 and |t_RC| on startup.
9620
9621 When "underline_rgb" is not 'y', then |t_8u| will be made empty.
9622 This avoids sending it to xterm, which would clear the colors.
9623
9624 For "mouse" the value 'u' is unknown
9625
9626 Also see:
9627 - 'ambiwidth' - detected by using |t_u7|.
9628 - |v:termstyleresp| and |v:termblinkresp| for the response to
9629 |t_RS| and |t_RC|.
9630
9631
9632test_ functions are documented here: |test-functions-details|
9633
9634
9635 *timer_info()*
9636timer_info([{id}])
9637 Return a list with information about timers.
9638 When {id} is given only information about this timer is
9639 returned. When timer {id} does not exist an empty list is
9640 returned.
9641 When {id} is omitted information about all timers is returned.
9642
9643 For each timer the information is stored in a |Dictionary| with
9644 these items:
9645 "id" the timer ID
9646 "time" time the timer was started with
9647 "remaining" time until the timer fires
9648 "repeat" number of times the timer will still fire;
9649 -1 means forever
9650 "callback" the callback
9651 "paused" 1 if the timer is paused, 0 otherwise
9652
9653 Can also be used as a |method|: >
9654 GetTimer()->timer_info()
9655
9656< {only available when compiled with the |+timers| feature}
9657
9658timer_pause({timer}, {paused}) *timer_pause()*
9659 Pause or unpause a timer. A paused timer does not invoke its
9660 callback when its time expires. Unpausing a timer may cause
9661 the callback to be invoked almost immediately if enough time
9662 has passed.
9663
9664 Pausing a timer is useful to avoid the callback to be called
9665 for a short time.
9666
9667 If {paused} evaluates to a non-zero Number or a non-empty
9668 String, then the timer is paused, otherwise it is unpaused.
9669 See |non-zero-arg|.
9670
9671 Can also be used as a |method|: >
9672 GetTimer()->timer_pause(1)
9673
9674< {only available when compiled with the |+timers| feature}
9675
9676 *timer_start()* *timer* *timers*
9677timer_start({time}, {callback} [, {options}])
9678 Create a timer and return the timer ID.
9679
9680 {time} is the waiting time in milliseconds. This is the
9681 minimum time before invoking the callback. When the system is
9682 busy or Vim is not waiting for input the time will be longer.
9683
9684 {callback} is the function to call. It can be the name of a
9685 function or a |Funcref|. It is called with one argument, which
9686 is the timer ID. The callback is only invoked when Vim is
9687 waiting for input.
9688 If you want to show a message look at |popup_notification()|
9689 to avoid interfering with what the user is doing.
9690
9691 {options} is a dictionary. Supported entries:
9692 "repeat" Number of times to repeat calling the
9693 callback. -1 means forever. When not present
9694 the callback will be called once.
9695 If the timer causes an error three times in a
9696 row the repeat is cancelled. This avoids that
9697 Vim becomes unusable because of all the error
9698 messages.
9699
Bram Moolenaard592deb2022-06-17 15:42:40 +01009700 Returns -1 on error.
9701
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009702 Example: >
9703 func MyHandler(timer)
9704 echo 'Handler called'
9705 endfunc
9706 let timer = timer_start(500, 'MyHandler',
9707 \ {'repeat': 3})
9708< This will invoke MyHandler() three times at 500 msec
9709 intervals.
9710
9711 Can also be used as a |method|: >
9712 GetMsec()->timer_start(callback)
9713
9714< Not available in the |sandbox|.
9715 {only available when compiled with the |+timers| feature}
9716
9717timer_stop({timer}) *timer_stop()*
9718 Stop a timer. The timer callback will no longer be invoked.
9719 {timer} is an ID returned by timer_start(), thus it must be a
9720 Number. If {timer} does not exist there is no error.
9721
9722 Can also be used as a |method|: >
9723 GetTimer()->timer_stop()
9724
9725< {only available when compiled with the |+timers| feature}
9726
9727timer_stopall() *timer_stopall()*
9728 Stop all timers. The timer callbacks will no longer be
9729 invoked. Useful if a timer is misbehaving. If there are no
9730 timers there is no error.
9731
9732 {only available when compiled with the |+timers| feature}
9733
9734tolower({expr}) *tolower()*
9735 The result is a copy of the String given, with all uppercase
9736 characters turned into lowercase (just like applying |gu| to
Bram Moolenaard592deb2022-06-17 15:42:40 +01009737 the string). Returns an empty string on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009738
9739 Can also be used as a |method|: >
9740 GetText()->tolower()
9741
9742toupper({expr}) *toupper()*
9743 The result is a copy of the String given, with all lowercase
9744 characters turned into uppercase (just like applying |gU| to
Bram Moolenaard592deb2022-06-17 15:42:40 +01009745 the string). Returns an empty string on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009746
9747 Can also be used as a |method|: >
9748 GetText()->toupper()
9749
9750tr({src}, {fromstr}, {tostr}) *tr()*
9751 The result is a copy of the {src} string with all characters
9752 which appear in {fromstr} replaced by the character in that
9753 position in the {tostr} string. Thus the first character in
9754 {fromstr} is translated into the first character in {tostr}
9755 and so on. Exactly like the unix "tr" command.
9756 This code also deals with multibyte characters properly.
9757
Bram Moolenaard592deb2022-06-17 15:42:40 +01009758 Returns an empty string on error.
9759
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009760 Examples: >
9761 echo tr("hello there", "ht", "HT")
9762< returns "Hello THere" >
9763 echo tr("<blob>", "<>", "{}")
9764< returns "{blob}"
9765
9766 Can also be used as a |method|: >
9767 GetText()->tr(from, to)
9768
9769trim({text} [, {mask} [, {dir}]]) *trim()*
9770 Return {text} as a String where any character in {mask} is
9771 removed from the beginning and/or end of {text}.
9772
9773 If {mask} is not given, {mask} is all characters up to 0x20,
9774 which includes Tab, space, NL and CR, plus the non-breaking
9775 space character 0xa0.
9776
9777 The optional {dir} argument specifies where to remove the
9778 characters:
9779 0 remove from the beginning and end of {text}
9780 1 remove only at the beginning of {text}
9781 2 remove only at the end of {text}
9782 When omitted both ends are trimmed.
9783
9784 This function deals with multibyte characters properly.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009785 Returns an empty string on error.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009786
9787 Examples: >
9788 echo trim(" some text ")
9789< returns "some text" >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009790 echo trim(" \r\t\t\r RESERVE \t\n\x0B\xA0") .. "_TAIL"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009791< returns "RESERVE_TAIL" >
9792 echo trim("rm<Xrm<>X>rrm", "rm<>")
9793< returns "Xrm<>X" (characters in the middle are not removed) >
9794 echo trim(" vim ", " ", 2)
9795< returns " vim"
9796
9797 Can also be used as a |method|: >
9798 GetText()->trim()
9799
9800trunc({expr}) *trunc()*
9801 Return the largest integral value with magnitude less than or
9802 equal to {expr} as a |Float| (truncate towards zero).
9803 {expr} must evaluate to a |Float| or a |Number|.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009804 Returns 0.0 if {expr} is not a |Float| or a |Number|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009805 Examples: >
9806 echo trunc(1.456)
9807< 1.0 >
9808 echo trunc(-5.456)
9809< -5.0 >
9810 echo trunc(4.0)
9811< 4.0
9812
9813 Can also be used as a |method|: >
9814 Compute()->trunc()
9815<
9816 {only available when compiled with the |+float| feature}
9817
9818 *type()*
9819type({expr}) The result is a Number representing the type of {expr}.
9820 Instead of using the number directly, it is better to use the
9821 v:t_ variable that has the value:
9822 Number: 0 |v:t_number|
9823 String: 1 |v:t_string|
9824 Funcref: 2 |v:t_func|
9825 List: 3 |v:t_list|
9826 Dictionary: 4 |v:t_dict|
9827 Float: 5 |v:t_float|
9828 Boolean: 6 |v:t_bool| (v:false and v:true)
9829 None: 7 |v:t_none| (v:null and v:none)
9830 Job: 8 |v:t_job|
9831 Channel: 9 |v:t_channel|
9832 Blob: 10 |v:t_blob|
9833 For backward compatibility, this method can be used: >
9834 :if type(myvar) == type(0)
9835 :if type(myvar) == type("")
9836 :if type(myvar) == type(function("tr"))
9837 :if type(myvar) == type([])
9838 :if type(myvar) == type({})
9839 :if type(myvar) == type(0.0)
9840 :if type(myvar) == type(v:false)
9841 :if type(myvar) == type(v:none)
9842< To check if the v:t_ variables exist use this: >
9843 :if exists('v:t_number')
9844
9845< Can also be used as a |method|: >
9846 mylist->type()
9847
9848
9849typename({expr}) *typename()*
9850 Return a string representation of the type of {expr}.
9851 Example: >
9852 echo typename([1, 2, 3])
9853 list<number>
9854
9855
9856undofile({name}) *undofile()*
9857 Return the name of the undo file that would be used for a file
9858 with name {name} when writing. This uses the 'undodir'
9859 option, finding directories that exist. It does not check if
9860 the undo file exists.
9861 {name} is always expanded to the full path, since that is what
9862 is used internally.
9863 If {name} is empty undofile() returns an empty string, since a
9864 buffer without a file name will not write an undo file.
9865 Useful in combination with |:wundo| and |:rundo|.
9866 When compiled without the |+persistent_undo| option this always
9867 returns an empty string.
9868
9869 Can also be used as a |method|: >
9870 GetFilename()->undofile()
9871
9872undotree() *undotree()*
9873 Return the current state of the undo tree in a dictionary with
9874 the following items:
9875 "seq_last" The highest undo sequence number used.
9876 "seq_cur" The sequence number of the current position in
9877 the undo tree. This differs from "seq_last"
9878 when some changes were undone.
9879 "time_cur" Time last used for |:earlier| and related
9880 commands. Use |strftime()| to convert to
9881 something readable.
9882 "save_last" Number of the last file write. Zero when no
9883 write yet.
9884 "save_cur" Number of the current position in the undo
9885 tree.
9886 "synced" Non-zero when the last undo block was synced.
9887 This happens when waiting from input from the
9888 user. See |undo-blocks|.
9889 "entries" A list of dictionaries with information about
9890 undo blocks.
9891
9892 The first item in the "entries" list is the oldest undo item.
9893 Each List item is a |Dictionary| with these items:
9894 "seq" Undo sequence number. Same as what appears in
9895 |:undolist|.
9896 "time" Timestamp when the change happened. Use
9897 |strftime()| to convert to something readable.
9898 "newhead" Only appears in the item that is the last one
9899 that was added. This marks the last change
9900 and where further changes will be added.
9901 "curhead" Only appears in the item that is the last one
9902 that was undone. This marks the current
9903 position in the undo tree, the block that will
9904 be used by a redo command. When nothing was
9905 undone after the last change this item will
9906 not appear anywhere.
9907 "save" Only appears on the last block before a file
9908 write. The number is the write count. The
9909 first write has number 1, the last one the
9910 "save_last" mentioned above.
9911 "alt" Alternate entry. This is again a List of undo
9912 blocks. Each item may again have an "alt"
9913 item.
9914
9915uniq({list} [, {func} [, {dict}]]) *uniq()* *E882*
9916 Remove second and succeeding copies of repeated adjacent
9917 {list} items in-place. Returns {list}. If you want a list
9918 to remain unmodified make a copy first: >
9919 :let newlist = uniq(copy(mylist))
9920< The default compare function uses the string representation of
9921 each item. For the use of {func} and {dict} see |sort()|.
9922
Bram Moolenaard592deb2022-06-17 15:42:40 +01009923 Returns zero if {list} is not a |List|.
9924
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009925 Can also be used as a |method|: >
9926 mylist->uniq()
9927
9928values({dict}) *values()*
9929 Return a |List| with all the values of {dict}. The |List| is
9930 in arbitrary order. Also see |items()| and |keys()|.
Bram Moolenaard592deb2022-06-17 15:42:40 +01009931 Returns zero if {dict} is not a |Dict|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009932
9933 Can also be used as a |method|: >
9934 mydict->values()
9935
LemonBoy0f7a3e12022-05-26 12:10:37 +01009936virtcol({expr} [, {list}]) *virtcol()*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009937 The result is a Number, which is the screen column of the file
9938 position given with {expr}. That is, the last screen position
9939 occupied by the character at that position, when the screen
9940 would be of unlimited width. When there is a <Tab> at the
9941 position, the returned Number will be the column at the end of
9942 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
9943 set to 8, it returns 8. |conceal| is ignored.
9944 For the byte position use |col()|.
LemonBoy0f7a3e12022-05-26 12:10:37 +01009945
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009946 For the use of {expr} see |col()|.
LemonBoy0f7a3e12022-05-26 12:10:37 +01009947
9948 When 'virtualedit' is used {expr} can be [lnum, col, off],
9949 where "off" is the offset in screen columns from the start of
9950 the character. E.g., a position within a <Tab> or after the
9951 last character. When "off" is omitted zero is used. When
9952 Virtual editing is active in the current mode, a position
9953 beyond the end of the line can be returned. Also see
9954 |'virtualedit'|
9955
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009956 The accepted positions are:
9957 . the cursor position
9958 $ the end of the cursor line (the result is the
9959 number of displayed characters in the cursor line
9960 plus one)
9961 'x position of mark x (if the mark is not set, 0 is
9962 returned)
9963 v In Visual mode: the start of the Visual area (the
9964 cursor is the end). When not in Visual mode
9965 returns the cursor position. Differs from |'<| in
9966 that it's updated right away.
LemonBoy0f7a3e12022-05-26 12:10:37 +01009967
9968 If {list} is present and non-zero then virtcol() returns a List
9969 with the first and last screen position occupied by the
9970 character.
9971
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009972 Note that only marks in the current file can be used.
9973 Examples: >
LemonBoy0f7a3e12022-05-26 12:10:37 +01009974 " With text "foo^Lbar" and cursor on the "^L":
9975
9976 virtcol(".") " returns 5
9977 virtcol(".", 1) " returns [4, 5]
9978 virtcol("$") " returns 9
9979
9980 " With text " there", with 't at 'h':
9981
9982 virtcol("'t") " returns 6
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009983< The first column is 1. 0 is returned for an error.
9984 A more advanced example that echoes the maximum length of
9985 all lines: >
9986 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
9987
9988< Can also be used as a |method|: >
9989 GetPos()->virtcol()
9990
Bram Moolenaar5a6ec102022-05-27 21:58:00 +01009991virtcol2col({winid}, {lnum}, {col}) *virtcol2col()*
9992 The result is a Number, which is the byte index of the
9993 character in window {winid} at buffer line {lnum} and virtual
9994 column {col}.
9995
9996 If {col} is greater than the last virtual column in line
9997 {lnum}, then the byte index of the character at the last
9998 virtual column is returned.
9999
10000 The {winid} argument can be the window number or the
10001 |window-ID|. If this is zero, then the current window is used.
10002
10003 Returns -1 if the window {winid} doesn't exist or the buffer
10004 line {lnum} or virtual column {col} is invalid.
10005
10006 See also |screenpos()|, |virtcol()| and |col()|.
10007
10008 Can also be used as a |method|: >
10009 GetWinid()->virtcol2col(lnum, col)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010010
10011visualmode([{expr}]) *visualmode()*
10012 The result is a String, which describes the last Visual mode
10013 used in the current buffer. Initially it returns an empty
10014 string, but once Visual mode has been used, it returns "v",
10015 "V", or "<CTRL-V>" (a single CTRL-V character) for
10016 character-wise, line-wise, or block-wise Visual mode
10017 respectively.
10018 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +000010019 :exe "normal " .. visualmode()
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010020< This enters the same Visual mode as before. It is also useful
10021 in scripts if you wish to act differently depending on the
10022 Visual mode that was used.
10023 If Visual mode is active, use |mode()| to get the Visual mode
10024 (e.g., in a |:vmap|).
10025 If {expr} is supplied and it evaluates to a non-zero Number or
10026 a non-empty String, then the Visual mode will be cleared and
10027 the old value is returned. See |non-zero-arg|.
10028
10029wildmenumode() *wildmenumode()*
10030 Returns |TRUE| when the wildmenu is active and |FALSE|
10031 otherwise. See 'wildmenu' and 'wildmode'.
10032 This can be used in mappings to handle the 'wildcharm' option
10033 gracefully. (Makes only sense with |mapmode-c| mappings).
10034
10035 For example to make <c-j> work like <down> in wildmode, use: >
10036 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
10037<
10038 (Note, this needs the 'wildcharm' option set appropriately).
10039
10040win_execute({id}, {command} [, {silent}]) *win_execute()*
10041 Like `execute()` but in the context of window {id}.
10042 The window will temporarily be made the current window,
10043 without triggering autocommands or changing directory. When
10044 executing {command} autocommands will be triggered, this may
10045 have unexpected side effects. Use |:noautocmd| if needed.
10046 Example: >
10047 call win_execute(winid, 'set syntax=python')
10048< Doing the same with `setwinvar()` would not trigger
10049 autocommands and not actually show syntax highlighting.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010050 *E994*
10051 Not all commands are allowed in popup windows.
10052 When window {id} does not exist then no error is given and
10053 an empty string is returned.
10054
10055 Can also be used as a |method|, the base is passed as the
10056 second argument: >
10057 GetCommand()->win_execute(winid)
10058
10059win_findbuf({bufnr}) *win_findbuf()*
10060 Returns a |List| with |window-ID|s for windows that contain
10061 buffer {bufnr}. When there is none the list is empty.
10062
10063 Can also be used as a |method|: >
10064 GetBufnr()->win_findbuf()
10065
10066win_getid([{win} [, {tab}]]) *win_getid()*
10067 Get the |window-ID| for the specified window.
10068 When {win} is missing use the current window.
10069 With {win} this is the window number. The top window has
10070 number 1.
10071 Without {tab} use the current tab, otherwise the tab with
10072 number {tab}. The first tab has number one.
10073 Return zero if the window cannot be found.
10074
10075 Can also be used as a |method|: >
10076 GetWinnr()->win_getid()
10077
10078
10079win_gettype([{nr}]) *win_gettype()*
10080 Return the type of the window:
10081 "autocmd" autocommand window. Temporary window
10082 used to execute autocommands.
10083 "command" command-line window |cmdwin|
10084 (empty) normal window
10085 "loclist" |location-list-window|
10086 "popup" popup window |popup|
10087 "preview" preview window |preview-window|
10088 "quickfix" |quickfix-window|
10089 "unknown" window {nr} not found
10090
10091 When {nr} is omitted return the type of the current window.
10092 When {nr} is given return the type of this window by number or
10093 |window-ID|.
10094
10095 Also see the 'buftype' option. When running a terminal in a
10096 popup window then 'buftype' is "terminal" and win_gettype()
10097 returns "popup".
10098
10099 Can also be used as a |method|: >
10100 GetWinid()->win_gettype()
10101<
10102win_gotoid({expr}) *win_gotoid()*
10103 Go to window with ID {expr}. This may also change the current
10104 tabpage.
10105 Return TRUE if successful, FALSE if the window cannot be found.
10106
10107 Can also be used as a |method|: >
10108 GetWinid()->win_gotoid()
10109
10110win_id2tabwin({expr}) *win_id2tabwin()*
10111 Return a list with the tab number and window number of window
10112 with ID {expr}: [tabnr, winnr].
10113 Return [0, 0] if the window cannot be found.
10114
10115 Can also be used as a |method|: >
10116 GetWinid()->win_id2tabwin()
10117
10118win_id2win({expr}) *win_id2win()*
10119 Return the window number of window with ID {expr}.
10120 Return 0 if the window cannot be found in the current tabpage.
10121
10122 Can also be used as a |method|: >
10123 GetWinid()->win_id2win()
10124
Daniel Steinbergee630312022-01-10 13:36:34 +000010125win_move_separator({nr}, {offset}) *win_move_separator()*
10126 Move window {nr}'s vertical separator (i.e., the right border)
10127 by {offset} columns, as if being dragged by the mouse. {nr}
10128 can be a window number or |window-ID|. A positive {offset}
10129 moves right and a negative {offset} moves left. Moving a
10130 window's vertical separator will change the width of the
10131 window and the width of other windows adjacent to the vertical
10132 separator. The magnitude of movement may be smaller than
10133 specified (e.g., as a consequence of maintaining
10134 'winminwidth'). Returns TRUE if the window can be found and
10135 FALSE otherwise.
Bram Moolenaard592deb2022-06-17 15:42:40 +010010136 This will fail for the rightmost window and a full-width
10137 window, since it has no separator on the right.
Daniel Steinbergee630312022-01-10 13:36:34 +000010138
10139 Can also be used as a |method|: >
10140 GetWinnr()->win_move_separator(offset)
10141
10142win_move_statusline({nr}, {offset}) *win_move_statusline()*
10143 Move window {nr}'s status line (i.e., the bottom border) by
10144 {offset} rows, as if being dragged by the mouse. {nr} can be a
10145 window number or |window-ID|. A positive {offset} moves down
10146 and a negative {offset} moves up. Moving a window's status
10147 line will change the height of the window and the height of
10148 other windows adjacent to the status line. The magnitude of
10149 movement may be smaller than specified (e.g., as a consequence
10150 of maintaining 'winminheight'). Returns TRUE if the window can
10151 be found and FALSE otherwise.
10152
10153 Can also be used as a |method|: >
10154 GetWinnr()->win_move_statusline(offset)
10155
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010156win_screenpos({nr}) *win_screenpos()*
10157 Return the screen position of window {nr} as a list with two
10158 numbers: [row, col]. The first window always has position
10159 [1, 1], unless there is a tabline, then it is [2, 1].
10160 {nr} can be the window number or the |window-ID|. Use zero
10161 for the current window.
10162 Returns [0, 0] if the window cannot be found in the current
10163 tabpage.
10164
10165 Can also be used as a |method|: >
10166 GetWinid()->win_screenpos()
10167<
10168win_splitmove({nr}, {target} [, {options}]) *win_splitmove()*
10169 Move the window {nr} to a new split of the window {target}.
10170 This is similar to moving to {target}, creating a new window
10171 using |:split| but having the same contents as window {nr}, and
10172 then closing {nr}.
10173
10174 Both {nr} and {target} can be window numbers or |window-ID|s.
10175 Both must be in the current tab page.
10176
10177 Returns zero for success, non-zero for failure.
10178
10179 {options} is a |Dictionary| with the following optional entries:
10180 "vertical" When TRUE, the split is created vertically,
10181 like with |:vsplit|.
10182 "rightbelow" When TRUE, the split is made below or to the
10183 right (if vertical). When FALSE, it is done
10184 above or to the left (if vertical). When not
10185 present, the values of 'splitbelow' and
10186 'splitright' are used.
10187
10188 Can also be used as a |method|: >
10189 GetWinid()->win_splitmove(target)
10190<
10191
10192 *winbufnr()*
10193winbufnr({nr}) The result is a Number, which is the number of the buffer
10194 associated with window {nr}. {nr} can be the window number or
10195 the |window-ID|.
10196 When {nr} is zero, the number of the buffer in the current
10197 window is returned.
10198 When window {nr} doesn't exist, -1 is returned.
10199 Example: >
10200 :echo "The file in the current window is " . bufname(winbufnr(0))
10201<
10202 Can also be used as a |method|: >
10203 FindWindow()->winbufnr()->bufname()
10204<
10205 *wincol()*
10206wincol() The result is a Number, which is the virtual column of the
10207 cursor in the window. This is counting screen cells from the
10208 left side of the window. The leftmost column is one.
10209
10210 *windowsversion()*
10211windowsversion()
10212 The result is a String. For MS-Windows it indicates the OS
10213 version. E.g, Windows 10 is "10.0", Windows 8 is "6.2",
10214 Windows XP is "5.1". For non-MS-Windows systems the result is
10215 an empty string.
10216
10217winheight({nr}) *winheight()*
10218 The result is a Number, which is the height of window {nr}.
10219 {nr} can be the window number or the |window-ID|.
10220 When {nr} is zero, the height of the current window is
10221 returned. When window {nr} doesn't exist, -1 is returned.
10222 An existing window always has a height of zero or more.
10223 This excludes any window toolbar line.
10224 Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +000010225 :echo "The current window has " .. winheight(0) .. " lines."
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010226
10227< Can also be used as a |method|: >
10228 GetWinid()->winheight()
10229<
10230winlayout([{tabnr}]) *winlayout()*
10231 The result is a nested List containing the layout of windows
10232 in a tabpage.
10233
10234 Without {tabnr} use the current tabpage, otherwise the tabpage
10235 with number {tabnr}. If the tabpage {tabnr} is not found,
10236 returns an empty list.
10237
10238 For a leaf window, it returns:
10239 ['leaf', {winid}]
10240 For horizontally split windows, which form a column, it
10241 returns:
10242 ['col', [{nested list of windows}]]
10243 For vertically split windows, which form a row, it returns:
10244 ['row', [{nested list of windows}]]
10245
10246 Example: >
10247 " Only one window in the tab page
10248 :echo winlayout()
10249 ['leaf', 1000]
10250 " Two horizontally split windows
10251 :echo winlayout()
10252 ['col', [['leaf', 1000], ['leaf', 1001]]]
10253 " The second tab page, with three horizontally split
10254 " windows, with two vertically split windows in the
10255 " middle window
10256 :echo winlayout(2)
10257 ['col', [['leaf', 1002], ['row', [['leaf', 1003],
10258 ['leaf', 1001]]], ['leaf', 1000]]]
10259<
10260 Can also be used as a |method|: >
10261 GetTabnr()->winlayout()
10262<
10263 *winline()*
10264winline() The result is a Number, which is the screen line of the cursor
10265 in the window. This is counting screen lines from the top of
10266 the window. The first line is one.
10267 If the cursor was moved the view on the file will be updated
10268 first, this may cause a scroll.
10269
10270 *winnr()*
10271winnr([{arg}]) The result is a Number, which is the number of the current
10272 window. The top window has number 1.
10273 Returns zero for a popup window.
10274
10275 The optional argument {arg} supports the following values:
10276 $ the number of the last window (the window
10277 count).
10278 # the number of the last accessed window (where
10279 |CTRL-W_p| goes to). If there is no previous
10280 window or it is in another tab page 0 is
10281 returned.
10282 {N}j the number of the Nth window below the
10283 current window (where |CTRL-W_j| goes to).
10284 {N}k the number of the Nth window above the current
10285 window (where |CTRL-W_k| goes to).
10286 {N}h the number of the Nth window left of the
10287 current window (where |CTRL-W_h| goes to).
10288 {N}l the number of the Nth window right of the
10289 current window (where |CTRL-W_l| goes to).
10290 The number can be used with |CTRL-W_w| and ":wincmd w"
10291 |:wincmd|.
Bram Moolenaar016188f2022-06-06 20:52:59 +010010292 When {arg} is invalid an error is given and zero is returned.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010293 Also see |tabpagewinnr()| and |win_getid()|.
10294 Examples: >
10295 let window_count = winnr('$')
10296 let prev_window = winnr('#')
10297 let wnum = winnr('3k')
10298
10299< Can also be used as a |method|: >
10300 GetWinval()->winnr()
10301<
10302 *winrestcmd()*
10303winrestcmd() Returns a sequence of |:resize| commands that should restore
10304 the current window sizes. Only works properly when no windows
10305 are opened or closed and the current window and tab page is
10306 unchanged.
10307 Example: >
10308 :let cmd = winrestcmd()
10309 :call MessWithWindowSizes()
10310 :exe cmd
10311<
10312 *winrestview()*
10313winrestview({dict})
10314 Uses the |Dictionary| returned by |winsaveview()| to restore
10315 the view of the current window.
10316 Note: The {dict} does not have to contain all values, that are
10317 returned by |winsaveview()|. If values are missing, those
10318 settings won't be restored. So you can use: >
10319 :call winrestview({'curswant': 4})
10320<
10321 This will only set the curswant value (the column the cursor
10322 wants to move on vertical movements) of the cursor to column 5
10323 (yes, that is 5), while all other settings will remain the
10324 same. This is useful, if you set the cursor position manually.
10325
10326 If you have changed the values the result is unpredictable.
10327 If the window size changed the result won't be the same.
10328
10329 Can also be used as a |method|: >
10330 GetView()->winrestview()
10331<
10332 *winsaveview()*
10333winsaveview() Returns a |Dictionary| that contains information to restore
10334 the view of the current window. Use |winrestview()| to
10335 restore the view.
10336 This is useful if you have a mapping that jumps around in the
10337 buffer and you want to go back to the original view.
10338 This does not save fold information. Use the 'foldenable'
10339 option to temporarily switch off folding, so that folds are
10340 not opened when moving around. This may have side effects.
10341 The return value includes:
10342 lnum cursor line number
10343 col cursor column (Note: the first column
naohiro ono56200ee2022-01-01 14:59:44 +000010344 zero, as opposed to what |getcurpos()|
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010345 returns)
10346 coladd cursor column offset for 'virtualedit'
naohiro ono56200ee2022-01-01 14:59:44 +000010347 curswant column for vertical movement (Note:
10348 the first column is zero, as opposed
10349 to what |getcurpos()| returns). After
10350 |$| command it will be a very large
10351 number equal to |v:maxcol|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010352 topline first line in the window
10353 topfill filler lines, only in diff mode
10354 leftcol first column displayed; only used when
10355 'wrap' is off
10356 skipcol columns skipped
10357 Note that no option values are saved.
10358
10359
10360winwidth({nr}) *winwidth()*
10361 The result is a Number, which is the width of window {nr}.
10362 {nr} can be the window number or the |window-ID|.
10363 When {nr} is zero, the width of the current window is
10364 returned. When window {nr} doesn't exist, -1 is returned.
10365 An existing window always has a width of zero or more.
10366 Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +000010367 :echo "The current window has " .. winwidth(0) .. " columns."
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010368 :if winwidth(0) <= 50
10369 : 50 wincmd |
10370 :endif
10371< For getting the terminal or screen size, see the 'columns'
10372 option.
10373
10374 Can also be used as a |method|: >
10375 GetWinid()->winwidth()
10376
10377
10378wordcount() *wordcount()*
10379 The result is a dictionary of byte/chars/word statistics for
10380 the current buffer. This is the same info as provided by
10381 |g_CTRL-G|
10382 The return value includes:
10383 bytes Number of bytes in the buffer
10384 chars Number of chars in the buffer
10385 words Number of words in the buffer
10386 cursor_bytes Number of bytes before cursor position
10387 (not in Visual mode)
10388 cursor_chars Number of chars before cursor position
10389 (not in Visual mode)
10390 cursor_words Number of words before cursor position
10391 (not in Visual mode)
10392 visual_bytes Number of bytes visually selected
10393 (only in Visual mode)
10394 visual_chars Number of chars visually selected
10395 (only in Visual mode)
10396 visual_words Number of words visually selected
10397 (only in Visual mode)
10398
10399
10400 *writefile()*
10401writefile({object}, {fname} [, {flags}])
10402 When {object} is a |List| write it to file {fname}. Each list
10403 item is separated with a NL. Each list item must be a String
10404 or Number.
10405 When {flags} contains "b" then binary mode is used: There will
10406 not be a NL after the last list item. An empty item at the
10407 end does cause the last line in the file to end in a NL.
10408
10409 When {object} is a |Blob| write the bytes to file {fname}
10410 unmodified.
10411
10412 When {flags} contains "a" then append mode is used, lines are
10413 appended to the file: >
10414 :call writefile(["foo"], "event.log", "a")
10415 :call writefile(["bar"], "event.log", "a")
10416<
10417 When {flags} contains "s" then fsync() is called after writing
10418 the file. This flushes the file to disk, if possible. This
10419 takes more time but avoids losing the file if the system
10420 crashes.
10421 When {flags} does not contain "S" or "s" then fsync() is
10422 called if the 'fsync' option is set.
10423 When {flags} contains "S" then fsync() is not called, even
10424 when 'fsync' is set.
10425
10426 All NL characters are replaced with a NUL character.
10427 Inserting CR characters needs to be done before passing {list}
10428 to writefile().
10429 An existing file is overwritten, if possible.
10430 When the write fails -1 is returned, otherwise 0. There is an
10431 error message if the file can't be created or when writing
10432 fails.
10433 Also see |readfile()|.
10434 To copy a file byte for byte: >
10435 :let fl = readfile("foo", "b")
10436 :call writefile(fl, "foocopy", "b")
10437
10438< Can also be used as a |method|: >
10439 GetText()->writefile("thefile")
10440
10441
10442xor({expr}, {expr}) *xor()*
10443 Bitwise XOR on the two arguments. The arguments are converted
10444 to a number. A List, Dict or Float argument causes an error.
Bram Moolenaar5a6ec102022-05-27 21:58:00 +010010445 Also see `and()` and `or()`.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010446 Example: >
10447 :let bits = xor(bits, 0x80)
10448<
10449 Can also be used as a |method|: >
10450 :let bits = bits->xor(0x80)
10451<
10452
10453==============================================================================
104543. Feature list *feature-list*
10455
10456There are three types of features:
104571. Features that are only supported when they have been enabled when Vim
10458 was compiled |+feature-list|. Example: >
10459 :if has("cindent")
10460< *gui_running*
104612. Features that are only supported when certain conditions have been met.
10462 Example: >
10463 :if has("gui_running")
10464< *has-patch*
104653. Beyond a certain version or at a certain version and including a specific
10466 patch. The "patch-7.4.248" feature means that the Vim version is 7.5 or
10467 later, or it is version 7.4 and patch 248 was included. Example: >
10468 :if has("patch-7.4.248")
10469< Note that it's possible for patch 248 to be omitted even though 249 is
10470 included. Only happens when cherry-picking patches.
10471 Note that this form only works for patch 7.4.237 and later, before that
10472 you need to check for the patch and the v:version. Example (checking
10473 version 6.2.148 or later): >
10474 :if v:version > 602 || (v:version == 602 && has("patch148"))
10475
10476Hint: To find out if Vim supports backslashes in a file name (MS-Windows),
10477use: `if exists('+shellslash')`
10478
10479
10480acl Compiled with |ACL| support.
10481all_builtin_terms Compiled with all builtin terminals enabled.
10482amiga Amiga version of Vim.
10483arabic Compiled with Arabic support |Arabic|.
10484arp Compiled with ARP support (Amiga).
10485autocmd Compiled with autocommand support. (always true)
10486autochdir Compiled with support for 'autochdir'
10487autoservername Automatically enable |clientserver|
10488balloon_eval Compiled with |balloon-eval| support.
10489balloon_multiline GUI supports multiline balloons.
10490beos BeOS version of Vim.
10491browse Compiled with |:browse| support, and browse() will
10492 work.
10493browsefilter Compiled with support for |browsefilter|.
10494bsd Compiled on an OS in the BSD family (excluding macOS).
10495builtin_terms Compiled with some builtin terminals.
10496byte_offset Compiled with support for 'o' in 'statusline'
10497channel Compiled with support for |channel| and |job|
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010498cindent Compiled with 'cindent' support. (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010499clientserver Compiled with remote invocation support |clientserver|.
10500clipboard Compiled with 'clipboard' support.
10501clipboard_working Compiled with 'clipboard' support and it can be used.
10502cmdline_compl Compiled with |cmdline-completion| support.
10503cmdline_hist Compiled with |cmdline-history| support.
10504cmdline_info Compiled with 'showcmd' and 'ruler' support.
10505comments Compiled with |'comments'| support.
10506compatible Compiled to be very Vi compatible.
10507conpty Platform where |ConPTY| can be used.
10508cryptv Compiled with encryption support |encryption|.
10509cscope Compiled with |cscope| support.
10510cursorbind Compiled with |'cursorbind'| (always true)
10511debug Compiled with "DEBUG" defined.
10512dialog_con Compiled with console dialog support.
10513dialog_gui Compiled with GUI dialog support.
10514diff Compiled with |vimdiff| and 'diff' support.
10515digraphs Compiled with support for digraphs.
10516directx Compiled with support for DirectX and 'renderoptions'.
10517dnd Compiled with support for the "~ register |quote_~|.
10518drop_file Compiled with |drop_file| support.
10519ebcdic Compiled on a machine with ebcdic character set.
10520emacs_tags Compiled with support for Emacs tags.
10521eval Compiled with expression evaluation support. Always
10522 true, of course!
10523ex_extra |+ex_extra| (always true)
10524extra_search Compiled with support for |'incsearch'| and
10525 |'hlsearch'|
10526farsi Support for Farsi was removed |farsi|.
10527file_in_path Compiled with support for |gf| and |<cfile>|
10528filterpipe When 'shelltemp' is off pipes are used for shell
10529 read/write/filter commands
10530find_in_path Compiled with support for include file searches
10531 |+find_in_path|.
10532float Compiled with support for |Float|.
10533fname_case Case in file names matters (for Amiga and MS-Windows
10534 this is not present).
10535folding Compiled with |folding| support.
10536footer Compiled with GUI footer support. |gui-footer|
10537fork Compiled to use fork()/exec() instead of system().
10538gettext Compiled with message translation |multi-lang|
10539gui Compiled with GUI enabled.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010010540gui_athena Compiled with Athena GUI (always false).
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010541gui_gnome Compiled with Gnome support (gui_gtk is also defined).
10542gui_gtk Compiled with GTK+ GUI (any version).
10543gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
10544gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined).
10545gui_haiku Compiled with Haiku GUI.
10546gui_mac Compiled with Macintosh GUI.
10547gui_motif Compiled with Motif GUI.
10548gui_photon Compiled with Photon GUI.
10549gui_running Vim is running in the GUI, or it will start soon.
10550gui_win32 Compiled with MS-Windows Win32 GUI.
10551gui_win32s idem, and Win32s system being used (Windows 3.1)
10552haiku Haiku version of Vim.
10553hangul_input Compiled with Hangul input support. |hangul|
10554hpux HP-UX version of Vim.
10555iconv Can use iconv() for conversion.
10556insert_expand Compiled with support for CTRL-X expansion commands in
10557 Insert mode. (always true)
10558job Compiled with support for |channel| and |job|
10559ipv6 Compiled with support for IPv6 networking in |channel|.
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010560jumplist Compiled with |jumplist| support. (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010561keymap Compiled with 'keymap' support.
10562lambda Compiled with |lambda| support.
10563langmap Compiled with 'langmap' support.
10564libcall Compiled with |libcall()| support.
10565linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and
10566 'breakindent' support.
10567linux Linux version of Vim.
10568lispindent Compiled with support for lisp indenting.
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010569 (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010570listcmds Compiled with commands for the buffer list |:files|
10571 and the argument list |arglist|.
10572localmap Compiled with local mappings and abbr. |:map-local|
10573lua Compiled with Lua interface |Lua|.
10574mac Any Macintosh version of Vim cf. osx
10575macunix Synonym for osxdarwin
10576menu Compiled with support for |:menu|.
10577mksession Compiled with support for |:mksession|.
10578modify_fname Compiled with file name modifiers. |filename-modifiers|
10579 (always true)
10580mouse Compiled with support for mouse.
10581mouse_dec Compiled with support for Dec terminal mouse.
10582mouse_gpm Compiled with support for gpm (Linux console mouse)
10583mouse_gpm_enabled GPM mouse is working
10584mouse_netterm Compiled with support for netterm mouse.
10585mouse_pterm Compiled with support for qnx pterm mouse.
10586mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
10587mouse_sgr Compiled with support for sgr mouse.
10588mouse_urxvt Compiled with support for urxvt mouse.
10589mouse_xterm Compiled with support for xterm mouse.
10590mouseshape Compiled with support for 'mouseshape'.
10591multi_byte Compiled with support for 'encoding' (always true)
10592multi_byte_encoding 'encoding' is set to a multibyte encoding.
10593multi_byte_ime Compiled with support for IME input method.
10594multi_lang Compiled with support for multiple languages.
10595mzscheme Compiled with MzScheme interface |mzscheme|.
10596nanotime Compiled with sub-second time stamp checks.
10597netbeans_enabled Compiled with support for |netbeans| and connected.
10598netbeans_intg Compiled with support for |netbeans|.
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010599num64 Compiled with 64-bit |Number| support. (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010600ole Compiled with OLE automation support for Win32.
10601osx Compiled for macOS cf. mac
10602osxdarwin Compiled for macOS, with |mac-darwin-feature|
10603packages Compiled with |packages| support.
10604path_extra Compiled with up/downwards search in 'path' and 'tags'
10605perl Compiled with Perl interface.
10606persistent_undo Compiled with support for persistent undo history.
10607postscript Compiled with PostScript file printing.
10608printer Compiled with |:hardcopy| support.
10609profile Compiled with |:profile| support.
10610python Python 2.x interface available. |has-python|
10611python_compiled Compiled with Python 2.x interface. |has-python|
10612python_dynamic Python 2.x interface is dynamically loaded. |has-python|
10613python3 Python 3.x interface available. |has-python|
10614python3_compiled Compiled with Python 3.x interface. |has-python|
10615python3_dynamic Python 3.x interface is dynamically loaded. |has-python|
10616pythonx Python 2.x and/or 3.x interface available. |python_x|
10617qnx QNX version of Vim.
10618quickfix Compiled with |quickfix| support.
10619reltime Compiled with |reltime()| support.
10620rightleft Compiled with 'rightleft' support.
10621ruby Compiled with Ruby interface |ruby|.
10622scrollbind Compiled with 'scrollbind' support. (always true)
10623showcmd Compiled with 'showcmd' support.
10624signs Compiled with |:sign| support.
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010625smartindent Compiled with 'smartindent' support. (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010626sodium Compiled with libsodium for better crypt support
10627sound Compiled with sound support, e.g. `sound_playevent()`
10628spell Compiled with spell checking support |spell|.
10629startuptime Compiled with |--startuptime| support.
10630statusline Compiled with support for 'statusline', 'rulerformat'
10631 and special formats of 'titlestring' and 'iconstring'.
10632sun SunOS version of Vim.
10633sun_workshop Support for Sun |workshop| has been removed.
10634syntax Compiled with syntax highlighting support |syntax|.
10635syntax_items There are active syntax highlighting items for the
10636 current buffer.
10637system Compiled to use system() instead of fork()/exec().
10638tag_binary Compiled with binary searching in tags files
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010639 |tag-binary-search|. (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010640tag_old_static Support for old static tags was removed, see
10641 |tag-old-static|.
10642tcl Compiled with Tcl interface.
10643termguicolors Compiled with true color in terminal support.
10644terminal Compiled with |terminal| support.
10645terminfo Compiled with terminfo instead of termcap.
10646termresponse Compiled with support for |t_RV| and |v:termresponse|.
10647textobjects Compiled with support for |text-objects|.
10648textprop Compiled with support for |text-properties|.
10649tgetent Compiled with tgetent support, able to use a termcap
10650 or terminfo file.
10651timers Compiled with |timer_start()| support.
10652title Compiled with window title support |'title'|.
Bram Moolenaare1dc76f2022-06-25 18:01:32 +010010653 (always true)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010654toolbar Compiled with support for |gui-toolbar|.
10655ttyin input is a terminal (tty)
10656ttyout output is a terminal (tty)
10657unix Unix version of Vim. *+unix*
10658unnamedplus Compiled with support for "unnamedplus" in 'clipboard'
10659user_commands User-defined commands. (always true)
10660vartabs Compiled with variable tabstop support |'vartabstop'|.
10661vcon Win32: Virtual console support is working, can use
10662 'termguicolors'. Also see |+vtp|.
10663vertsplit Compiled with vertically split windows |:vsplit|.
10664 (always true)
10665vim_starting True while initial source'ing takes place. |startup|
10666 *vim_starting*
Bram Moolenaara6feb162022-01-02 12:06:33 +000010667vim9script Compiled with |Vim9| script support
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010668viminfo Compiled with viminfo support.
10669vimscript-1 Compiled Vim script version 1 support
10670vimscript-2 Compiled Vim script version 2 support
10671vimscript-3 Compiled Vim script version 3 support
Bram Moolenaar8a3b8052022-06-26 12:21:15 +010010672vimscript-4 Compiled Vim script version 4 support
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010673virtualedit Compiled with 'virtualedit' option. (always true)
10674visual Compiled with Visual mode. (always true)
10675visualextra Compiled with extra Visual mode commands. (always
10676 true) |blockwise-operators|.
10677vms VMS version of Vim.
10678vreplace Compiled with |gR| and |gr| commands. (always true)
10679vtp Compiled for vcon support |+vtp| (check vcon to find
10680 out if it works in the current console).
10681wildignore Compiled with 'wildignore' option.
10682wildmenu Compiled with 'wildmenu' option.
10683win16 old version for MS-Windows 3.1 (always false)
10684win32 Win32 version of Vim (MS-Windows 95 and later, 32 or
10685 64 bits)
10686win32unix Win32 version of Vim, using Unix files (Cygwin)
10687win64 Win64 version of Vim (MS-Windows 64 bit).
10688win95 Win32 version for MS-Windows 95/98/ME (always false)
10689winaltkeys Compiled with 'winaltkeys' option.
10690windows Compiled with support for more than one window.
10691 (always true)
10692writebackup Compiled with 'writebackup' default on.
10693xfontset Compiled with X fontset support |xfontset|.
10694xim Compiled with X input method support |xim|.
10695xpm Compiled with pixmap support.
10696xpm_w32 Compiled with pixmap support for Win32. (Only for
10697 backward compatibility. Use "xpm" instead.)
10698xsmp Compiled with X session management support.
10699xsmp_interact Compiled with interactive X session management support.
10700xterm_clipboard Compiled with support for xterm clipboard.
10701xterm_save Compiled with support for saving and restoring the
10702 xterm screen.
10703x11 Compiled with X11 support.
10704
10705
10706==============================================================================
107074. Matching a pattern in a String *string-match*
10708
10709This is common between several functions. A regexp pattern as explained at
10710|pattern| is normally used to find a match in the buffer lines. When a
10711pattern is used to find a match in a String, almost everything works in the
10712same way. The difference is that a String is handled like it is one line.
10713When it contains a "\n" character, this is not seen as a line break for the
10714pattern. It can be matched with a "\n" in the pattern, or with ".". Example:
10715>
10716 :let a = "aaaa\nxxxx"
10717 :echo matchstr(a, "..\n..")
10718 aa
10719 xx
10720 :echo matchstr(a, "a.x")
10721 a
10722 x
10723
10724Don't forget that "^" will only match at the first character of the String and
10725"$" at the last character of the string. They don't match after or before a
10726"\n".
10727
10728 vim:tw=78:ts=8:noet:ft=help:norl: