blob: 943cd517583c1f0985492f0cc50cde5066dc683f [file] [log] [blame]
Bram Moolenaarf10911e2022-01-29 22:20:48 +00001*builtin.txt* For Vim version 8.2. Last change: 2022 Jan 28
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}
63balloon_gettext() String current text in the balloon
64balloon_show({expr}) none show {expr} inside the balloon
65balloon_split({msg}) List split {msg} as used for a balloon
66blob2list({blob}) List convert {blob} into a list of numbers
67browse({save}, {title}, {initdir}, {default})
68 String put up a file requester
69browsedir({title}, {initdir}) String put up a directory requester
70bufadd({name}) Number add a buffer to the buffer list
71bufexists({buf}) Number |TRUE| if buffer {buf} exists
72buflisted({buf}) Number |TRUE| if buffer {buf} is listed
73bufload({buf}) Number load buffer {buf} if not loaded yet
74bufloaded({buf}) Number |TRUE| if buffer {buf} is loaded
75bufname([{buf}]) String Name of the buffer {buf}
76bufnr([{buf} [, {create}]]) Number Number of the buffer {buf}
77bufwinid({buf}) Number window ID of buffer {buf}
78bufwinnr({buf}) Number window number of buffer {buf}
79byte2line({byte}) Number line number at byte count {byte}
80byteidx({expr}, {nr}) Number byte index of {nr}'th char in {expr}
81byteidxcomp({expr}, {nr}) Number byte index of {nr}'th char in {expr}
82call({func}, {arglist} [, {dict}])
83 any call {func} with arguments {arglist}
84ceil({expr}) Float round {expr} up
85ch_canread({handle}) Number check if there is something to read
86ch_close({handle}) none close {handle}
87ch_close_in({handle}) none close in part of {handle}
88ch_evalexpr({handle}, {expr} [, {options}])
89 any evaluate {expr} on JSON {handle}
90ch_evalraw({handle}, {string} [, {options}])
91 any evaluate {string} on raw {handle}
92ch_getbufnr({handle}, {what}) Number get buffer number for {handle}/{what}
93ch_getjob({channel}) Job get the Job of {channel}
94ch_info({handle}) String info about channel {handle}
95ch_log({msg} [, {handle}]) none write {msg} in the channel log file
96ch_logfile({fname} [, {mode}]) none start logging channel activity
97ch_open({address} [, {options}])
98 Channel open a channel to {address}
99ch_read({handle} [, {options}]) String read from {handle}
100ch_readblob({handle} [, {options}])
101 Blob read Blob from {handle}
102ch_readraw({handle} [, {options}])
103 String read raw from {handle}
104ch_sendexpr({handle}, {expr} [, {options}])
105 any send {expr} over JSON {handle}
106ch_sendraw({handle}, {expr} [, {options}])
107 any send {expr} over raw {handle}
108ch_setoptions({handle}, {options})
109 none set options for {handle}
110ch_status({handle} [, {options}])
111 String status of channel {handle}
112changenr() Number current change number
113char2nr({expr} [, {utf8}]) Number ASCII/UTF-8 value of first char in {expr}
114charclass({string}) Number character class of {string}
115charcol({expr}) Number column number of cursor or mark
116charidx({string}, {idx} [, {countcc}])
117 Number char index of byte {idx} in {string}
118chdir({dir}) String change current working directory
119cindent({lnum}) Number C indent for line {lnum}
120clearmatches([{win}]) none clear all matches
121col({expr}) Number column byte index of cursor or mark
122complete({startcol}, {matches}) none set Insert mode completion
123complete_add({expr}) Number add completion match
124complete_check() Number check for key typed during completion
125complete_info([{what}]) Dict get current completion information
126confirm({msg} [, {choices} [, {default} [, {type}]]])
127 Number number of choice picked by user
128copy({expr}) any make a shallow copy of {expr}
129cos({expr}) Float cosine of {expr}
130cosh({expr}) Float hyperbolic cosine of {expr}
131count({comp}, {expr} [, {ic} [, {start}]])
132 Number count how many {expr} are in {comp}
133cscope_connection([{num}, {dbpath} [, {prepend}]])
134 Number checks existence of cscope connection
135cursor({lnum}, {col} [, {off}])
136 Number move cursor to {lnum}, {col}, {off}
137cursor({list}) Number move cursor to position in {list}
138debugbreak({pid}) Number interrupt process being debugged
139deepcopy({expr} [, {noref}]) any make a full copy of {expr}
140delete({fname} [, {flags}]) Number delete the file or directory {fname}
141deletebufline({buf}, {first} [, {last}])
142 Number delete lines from buffer {buf}
143did_filetype() Number |TRUE| if FileType autocmd event used
144diff_filler({lnum}) Number diff filler lines about {lnum}
145diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col}
146digraph_get({chars}) String get the |digraph| of {chars}
147digraph_getlist([{listall}]) List get all |digraph|s
148digraph_set({chars}, {digraph}) Boolean register |digraph|
149digraph_setlist({digraphlist}) Boolean register multiple |digraph|s
150echoraw({expr}) none output {expr} as-is
151empty({expr}) Number |TRUE| if {expr} is empty
152environ() Dict return environment variables
153escape({string}, {chars}) String escape {chars} in {string} with '\'
154eval({string}) any evaluate {string} into its value
155eventhandler() Number |TRUE| if inside an event handler
156executable({expr}) Number 1 if executable {expr} exists
157execute({command}) String execute {command} and get the output
158exepath({expr}) String full path of the command {expr}
159exists({expr}) Number |TRUE| if {expr} exists
160exists_compiled({expr}) Number |TRUE| if {expr} exists at compile time
161exp({expr}) Float exponential of {expr}
162expand({expr} [, {nosuf} [, {list}]])
163 any expand special keywords in {expr}
164expandcmd({expr}) String expand {expr} like with `:edit`
165extend({expr1}, {expr2} [, {expr3}])
166 List/Dict insert items of {expr2} into {expr1}
167extendnew({expr1}, {expr2} [, {expr3}])
168 List/Dict like |extend()| but creates a new
169 List or Dictionary
170feedkeys({string} [, {mode}]) Number add key sequence to typeahead buffer
171filereadable({file}) Number |TRUE| if {file} is a readable file
172filewritable({file}) Number |TRUE| if {file} is a writable file
173filter({expr1}, {expr2}) List/Dict/Blob/String
174 remove items from {expr1} where
175 {expr2} is 0
176finddir({name} [, {path} [, {count}]])
177 String find directory {name} in {path}
178findfile({name} [, {path} [, {count}]])
179 String find file {name} in {path}
180flatten({list} [, {maxdepth}]) List flatten {list} up to {maxdepth} levels
181flattennew({list} [, {maxdepth}])
182 List flatten a copy of {list}
183float2nr({expr}) Number convert Float {expr} to a Number
184floor({expr}) Float round {expr} down
185fmod({expr1}, {expr2}) Float remainder of {expr1} / {expr2}
186fnameescape({fname}) String escape special characters in {fname}
187fnamemodify({fname}, {mods}) String modify file name
188foldclosed({lnum}) Number first line of fold at {lnum} if closed
189foldclosedend({lnum}) Number last line of fold at {lnum} if closed
190foldlevel({lnum}) Number fold level at {lnum}
191foldtext() String line displayed for closed fold
192foldtextresult({lnum}) String text for closed fold at {lnum}
193foreground() Number bring the Vim window to the foreground
194fullcommand({name}) String get full command from {name}
195funcref({name} [, {arglist}] [, {dict}])
196 Funcref reference to function {name}
197function({name} [, {arglist}] [, {dict}])
198 Funcref named reference to function {name}
199garbagecollect([{atexit}]) none free memory, breaking cyclic references
200get({list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
201get({dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
202get({func}, {what}) any get property of funcref/partial {func}
203getbufinfo([{buf}]) List information about buffers
204getbufline({buf}, {lnum} [, {end}])
205 List lines {lnum} to {end} of buffer {buf}
206getbufvar({buf}, {varname} [, {def}])
207 any variable {varname} in buffer {buf}
208getchangelist([{buf}]) List list of change list items
209getchar([expr]) Number or String
210 get one character from the user
211getcharmod() Number modifiers for the last typed character
212getcharpos({expr}) List position of cursor, mark, etc.
213getcharsearch() Dict last character search
214getcharstr([expr]) String get one character from the user
215getcmdline() String return the current command-line
216getcmdpos() Number return cursor position in command-line
217getcmdtype() String return current command-line type
218getcmdwintype() String return current command-line window type
219getcompletion({pat}, {type} [, {filtered}])
220 List list of cmdline completion matches
221getcurpos([{winnr}]) List position of the cursor
222getcursorcharpos([{winnr}]) List character position of the cursor
223getcwd([{winnr} [, {tabnr}]]) String get the current working directory
224getenv({name}) String return environment variable
225getfontname([{name}]) String name of font being used
226getfperm({fname}) String file permissions of file {fname}
227getfsize({fname}) Number size in bytes of file {fname}
228getftime({fname}) Number last modification time of file
229getftype({fname}) String description of type of file {fname}
230getimstatus() Number |TRUE| if the IME status is active
231getjumplist([{winnr} [, {tabnr}]])
232 List list of jump list items
233getline({lnum}) String line {lnum} of current buffer
234getline({lnum}, {end}) List lines {lnum} to {end} of current buffer
235getloclist({nr}) List list of location list items
236getloclist({nr}, {what}) Dict get specific location list properties
237getmarklist([{buf}]) List list of global/local marks
238getmatches([{win}]) List list of current matches
239getmousepos() Dict last known mouse position
240getpid() Number process ID of Vim
241getpos({expr}) List position of cursor, mark, etc.
242getqflist() List list of quickfix items
243getqflist({what}) Dict get specific quickfix list properties
244getreg([{regname} [, 1 [, {list}]]])
245 String or List contents of a register
246getreginfo([{regname}]) Dict information about a register
247getregtype([{regname}]) String type of a register
248gettabinfo([{expr}]) List list of tab pages
249gettabvar({nr}, {varname} [, {def}])
250 any variable {varname} in tab {nr} or {def}
251gettabwinvar({tabnr}, {winnr}, {name} [, {def}])
252 any {name} in {winnr} in tab page {tabnr}
253gettagstack([{nr}]) Dict get the tag stack of window {nr}
254gettext({text}) String lookup translation of {text}
255getwininfo([{winid}]) List list of info about each window
256getwinpos([{timeout}]) List X and Y coord in pixels of the Vim window
257getwinposx() Number X coord in pixels of the Vim window
258getwinposy() Number Y coord in pixels of the Vim window
259getwinvar({nr}, {varname} [, {def}])
260 any variable {varname} in window {nr}
261glob({expr} [, {nosuf} [, {list} [, {alllinks}]]])
262 any expand file wildcards in {expr}
263glob2regpat({expr}) String convert a glob pat into a search pat
264globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
265 String do glob({expr}) for all dirs in {path}
266has({feature} [, {check}]) Number |TRUE| if feature {feature} supported
267has_key({dict}, {key}) Number |TRUE| if {dict} has entry {key}
268haslocaldir([{winnr} [, {tabnr}]])
269 Number |TRUE| if the window executed |:lcd|
270 or |:tcd|
271hasmapto({what} [, {mode} [, {abbr}]])
272 Number |TRUE| if mapping to {what} exists
273histadd({history}, {item}) Number add an item to a history
274histdel({history} [, {item}]) Number remove an item from a history
275histget({history} [, {index}]) String get the item {index} from a history
276histnr({history}) Number highest index of a history
277hlID({name}) Number syntax ID of highlight group {name}
278hlexists({name}) Number |TRUE| if highlight group {name} exists
279hlget([{name} [, {resolve}]]) List get highlight group attributes
280hlset({list}) Number set highlight group attributes
281hostname() String name of the machine Vim is running on
282iconv({expr}, {from}, {to}) String convert encoding of {expr}
283indent({lnum}) Number indent of line {lnum}
284index({object}, {expr} [, {start} [, {ic}]])
285 Number index in {object} where {expr} appears
286input({prompt} [, {text} [, {completion}]])
287 String get input from the user
288inputdialog({prompt} [, {text} [, {completion}]])
289 String like input() but in a GUI dialog
290inputlist({textlist}) Number let the user pick from a choice list
291inputrestore() Number restore typeahead
292inputsave() Number save and clear typeahead
293inputsecret({prompt} [, {text}]) String like input() but hiding the text
294insert({object}, {item} [, {idx}]) List insert {item} in {object} [before {idx}]
295interrupt() none interrupt script execution
296invert({expr}) Number bitwise invert
297isdirectory({directory}) Number |TRUE| if {directory} is a directory
298isinf({expr}) Number determine if {expr} is infinity value
299 (positive or negative)
300islocked({expr}) Number |TRUE| if {expr} is locked
301isnan({expr}) Number |TRUE| if {expr} is NaN
302items({dict}) List key-value pairs in {dict}
303job_getchannel({job}) Channel get the channel handle for {job}
304job_info([{job}]) Dict get information about {job}
305job_setoptions({job}, {options}) none set options for {job}
306job_start({command} [, {options}])
307 Job start a job
308job_status({job}) String get the status of {job}
309job_stop({job} [, {how}]) Number stop {job}
310join({list} [, {sep}]) String join {list} items into one String
311js_decode({string}) any decode JS style JSON
312js_encode({expr}) String encode JS style JSON
313json_decode({string}) any decode JSON
314json_encode({expr}) String encode JSON
315keys({dict}) List keys in {dict}
316len({expr}) Number the length of {expr}
317libcall({lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
318libcallnr({lib}, {func}, {arg}) Number idem, but return a Number
319line({expr} [, {winid}]) Number line nr of cursor, last line or mark
320line2byte({lnum}) Number byte count of line {lnum}
321lispindent({lnum}) Number Lisp indent for line {lnum}
322list2blob({list}) Blob turn {list} of numbers into a Blob
323list2str({list} [, {utf8}]) String turn {list} of numbers into a String
324listener_add({callback} [, {buf}])
325 Number add a callback to listen to changes
326listener_flush([{buf}]) none invoke listener callbacks
327listener_remove({id}) none remove a listener callback
328localtime() Number current time
329log({expr}) Float natural logarithm (base e) of {expr}
330log10({expr}) Float logarithm of Float {expr} to base 10
331luaeval({expr} [, {expr}]) any evaluate |Lua| expression
332map({expr1}, {expr2}) List/Dict/Blob/String
333 change each item in {expr1} to {expr2}
334maparg({name} [, {mode} [, {abbr} [, {dict}]]])
335 String or Dict
336 rhs of mapping {name} in mode {mode}
337mapcheck({name} [, {mode} [, {abbr}]])
338 String check for mappings matching {name}
339mapnew({expr1}, {expr2}) List/Dict/Blob/String
340 like |map()| but creates a new List or
341 Dictionary
342mapset({mode}, {abbr}, {dict}) none restore mapping from |maparg()| result
343match({expr}, {pat} [, {start} [, {count}]])
344 Number position where {pat} matches in {expr}
345matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
346 Number highlight {pattern} with {group}
347matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
348 Number highlight positions with {group}
349matcharg({nr}) List arguments of |:match|
350matchdelete({id} [, {win}]) Number delete match identified by {id}
351matchend({expr}, {pat} [, {start} [, {count}]])
352 Number position where {pat} ends in {expr}
353matchfuzzy({list}, {str} [, {dict}])
354 List fuzzy match {str} in {list}
355matchfuzzypos({list}, {str} [, {dict}])
356 List fuzzy match {str} in {list}
357matchlist({expr}, {pat} [, {start} [, {count}]])
358 List match and submatches of {pat} in {expr}
359matchstr({expr}, {pat} [, {start} [, {count}]])
360 String {count}'th match of {pat} in {expr}
361matchstrpos({expr}, {pat} [, {start} [, {count}]])
362 List {count}'th match of {pat} in {expr}
363max({expr}) Number maximum value of items in {expr}
364menu_info({name} [, {mode}]) Dict get menu item information
365min({expr}) Number minimum value of items in {expr}
366mkdir({name} [, {path} [, {prot}]])
367 Number create directory {name}
368mode([expr]) String current editing mode
369mzeval({expr}) any evaluate |MzScheme| expression
370nextnonblank({lnum}) Number line nr of non-blank line >= {lnum}
371nr2char({expr} [, {utf8}]) String single char with ASCII/UTF-8 value {expr}
372or({expr}, {expr}) Number bitwise OR
373pathshorten({expr} [, {len}]) String shorten directory names in a path
374perleval({expr}) any evaluate |Perl| expression
375popup_atcursor({what}, {options}) Number create popup window near the cursor
376popup_beval({what}, {options}) Number create popup window for 'ballooneval'
377popup_clear() none close all popup windows
378popup_close({id} [, {result}]) none close popup window {id}
379popup_create({what}, {options}) Number create a popup window
380popup_dialog({what}, {options}) Number create a popup window used as a dialog
381popup_filter_menu({id}, {key}) Number filter for a menu popup window
382popup_filter_yesno({id}, {key}) Number filter for a dialog popup window
383popup_findinfo() Number get window ID of info popup window
384popup_findpreview() Number get window ID of preview popup window
385popup_getoptions({id}) Dict get options of popup window {id}
386popup_getpos({id}) Dict get position of popup window {id}
387popup_hide({id}) none hide popup menu {id}
388popup_list() List get a list of window IDs of all popups
389popup_locate({row}, {col}) Number get window ID of popup at position
390popup_menu({what}, {options}) Number create a popup window used as a menu
391popup_move({id}, {options}) none set position of popup window {id}
392popup_notification({what}, {options})
393 Number create a notification popup window
394popup_setoptions({id}, {options})
395 none set options for popup window {id}
396popup_settext({id}, {text}) none set the text of popup window {id}
397popup_show({id}) none unhide popup window {id}
398pow({x}, {y}) Float {x} to the power of {y}
399prevnonblank({lnum}) Number line nr of non-blank line <= {lnum}
400printf({fmt}, {expr1}...) String format text
401prompt_getprompt({buf}) String get prompt text
402prompt_setcallback({buf}, {expr}) none set prompt callback function
403prompt_setinterrupt({buf}, {text}) none set prompt interrupt function
404prompt_setprompt({buf}, {text}) none set prompt text
405prop_add({lnum}, {col}, {props}) none add one text property
406prop_add_list({props}, [[{lnum}, {col}, {end-lnum}, {end-col}], ...])
407 none add multiple text properties
408prop_clear({lnum} [, {lnum-end} [, {props}]])
409 none remove all text properties
410prop_find({props} [, {direction}])
411 Dict search for a text property
412prop_list({lnum} [, {props}]) List text properties in {lnum}
413prop_remove({props} [, {lnum} [, {lnum-end}]])
414 Number remove a text property
415prop_type_add({name}, {props}) none define a new property type
416prop_type_change({name}, {props})
417 none change an existing property type
418prop_type_delete({name} [, {props}])
419 none delete a property type
420prop_type_get({name} [, {props}])
421 Dict get property type values
422prop_type_list([{props}]) List get list of property types
423pum_getpos() Dict position and size of pum if visible
424pumvisible() Number whether popup menu is visible
425py3eval({expr}) any evaluate |python3| expression
426pyeval({expr}) any evaluate |Python| expression
427pyxeval({expr}) any evaluate |python_x| expression
428rand([{expr}]) Number get pseudo-random number
429range({expr} [, {max} [, {stride}]])
430 List items from {expr} to {max}
431readblob({fname}) Blob read a |Blob| from {fname}
432readdir({dir} [, {expr} [, {dict}]])
433 List file names in {dir} selected by {expr}
434readdirex({dir} [, {expr} [, {dict}]])
435 List file info in {dir} selected by {expr}
436readfile({fname} [, {type} [, {max}]])
437 List get list of lines from file {fname}
438reduce({object}, {func} [, {initial}])
439 any reduce {object} using {func}
440reg_executing() String get the executing register name
441reg_recording() String get the recording register name
442reltime([{start} [, {end}]]) List get time value
443reltimefloat({time}) Float turn the time value into a Float
444reltimestr({time}) String turn time value into a String
445remote_expr({server}, {string} [, {idvar} [, {timeout}]])
446 String send expression
447remote_foreground({server}) Number bring Vim server to the foreground
448remote_peek({serverid} [, {retvar}])
449 Number check for reply string
450remote_read({serverid} [, {timeout}])
451 String read reply string
452remote_send({server}, {string} [, {idvar}])
453 String send key sequence
454remote_startserver({name}) none become server {name}
455remove({list}, {idx} [, {end}]) any/List
456 remove items {idx}-{end} from {list}
457remove({blob}, {idx} [, {end}]) Number/Blob
458 remove bytes {idx}-{end} from {blob}
459remove({dict}, {key}) any remove entry {key} from {dict}
460rename({from}, {to}) Number rename (move) file from {from} to {to}
461repeat({expr}, {count}) String repeat {expr} {count} times
462resolve({filename}) String get filename a shortcut points to
463reverse({list}) List reverse {list} in-place
464round({expr}) Float round off {expr}
465rubyeval({expr}) any evaluate |Ruby| expression
466screenattr({row}, {col}) Number attribute at screen position
467screenchar({row}, {col}) Number character at screen position
468screenchars({row}, {col}) List List of characters at screen position
469screencol() Number current cursor column
470screenpos({winid}, {lnum}, {col}) Dict screen row and col of a text character
471screenrow() Number current cursor row
472screenstring({row}, {col}) String characters at screen position
473search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
474 Number search for {pattern}
475searchcount([{options}]) Dict get or update search stats
476searchdecl({name} [, {global} [, {thisblock}]])
477 Number search for variable declaration
478searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
479 Number search for other end of start/end pair
480searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
481 List search for other end of start/end pair
482searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
483 List search for {pattern}
484server2client({clientid}, {string})
485 Number send reply string
486serverlist() String get a list of available servers
487setbufline({expr}, {lnum}, {text})
488 Number set line {lnum} to {text} in buffer
489 {expr}
490setbufvar({buf}, {varname}, {val})
491 none set {varname} in buffer {buf} to {val}
492setcellwidths({list}) none set character cell width overrides
493setcharpos({expr}, {list}) Number set the {expr} position to {list}
494setcharsearch({dict}) Dict set character search from {dict}
495setcmdpos({pos}) Number set cursor position in command-line
496setcursorcharpos({list}) Number move cursor to position in {list}
497setenv({name}, {val}) none set environment variable
498setfperm({fname}, {mode}) Number set {fname} file permissions to {mode}
499setline({lnum}, {line}) Number set line {lnum} to {line}
500setloclist({nr}, {list} [, {action}])
501 Number modify location list using {list}
502setloclist({nr}, {list}, {action}, {what})
503 Number modify specific location list props
504setmatches({list} [, {win}]) Number restore a list of matches
505setpos({expr}, {list}) Number set the {expr} position to {list}
506setqflist({list} [, {action}]) Number modify quickfix list using {list}
507setqflist({list}, {action}, {what})
508 Number modify specific quickfix list props
509setreg({n}, {v} [, {opt}]) Number set register to value and type
510settabvar({nr}, {varname}, {val}) none set {varname} in tab page {nr} to {val}
511settabwinvar({tabnr}, {winnr}, {varname}, {val})
512 none set {varname} in window {winnr} in tab
513 page {tabnr} to {val}
514settagstack({nr}, {dict} [, {action}])
515 Number modify tag stack using {dict}
516setwinvar({nr}, {varname}, {val}) none set {varname} in window {nr} to {val}
517sha256({string}) String SHA256 checksum of {string}
518shellescape({string} [, {special}])
519 String escape {string} for use as shell
520 command argument
521shiftwidth([{col}]) Number effective value of 'shiftwidth'
522sign_define({name} [, {dict}]) Number define or update a sign
523sign_define({list}) List define or update a list of signs
524sign_getdefined([{name}]) List get a list of defined signs
525sign_getplaced([{buf} [, {dict}]])
526 List get a list of placed signs
527sign_jump({id}, {group}, {buf})
528 Number jump to a sign
529sign_place({id}, {group}, {name}, {buf} [, {dict}])
530 Number place a sign
531sign_placelist({list}) List place a list of signs
532sign_undefine([{name}]) Number undefine a sign
533sign_undefine({list}) List undefine a list of signs
534sign_unplace({group} [, {dict}])
535 Number unplace a sign
536sign_unplacelist({list}) List unplace a list of signs
537simplify({filename}) String simplify filename as much as possible
538sin({expr}) Float sine of {expr}
539sinh({expr}) Float hyperbolic sine of {expr}
540slice({expr}, {start} [, {end}]) String, List or Blob
541 slice of a String, List or Blob
542sort({list} [, {func} [, {dict}]])
543 List sort {list}, using {func} to compare
544sound_clear() none stop playing all sounds
545sound_playevent({name} [, {callback}])
546 Number play an event sound
547sound_playfile({path} [, {callback}])
548 Number play sound file {path}
549sound_stop({id}) none stop playing sound {id}
550soundfold({word}) String sound-fold {word}
551spellbadword() String badly spelled word at cursor
552spellsuggest({word} [, {max} [, {capital}]])
553 List spelling suggestions
554split({expr} [, {pat} [, {keepempty}]])
555 List make |List| from {pat} separated {expr}
556sqrt({expr}) Float square root of {expr}
557srand([{expr}]) List get seed for |rand()|
558state([{what}]) String current state of Vim
559str2float({expr} [, {quoted}]) Float convert String to Float
560str2list({expr} [, {utf8}]) List convert each character of {expr} to
561 ASCII/UTF-8 value
562str2nr({expr} [, {base} [, {quoted}]])
563 Number convert String to Number
564strcharlen({expr}) Number character length of the String {expr}
565strcharpart({str}, {start} [, {len} [, {skipcc}]])
566 String {len} characters of {str} at
567 character {start}
568strchars({expr} [, {skipcc}]) Number character count of the String {expr}
569strdisplaywidth({expr} [, {col}]) Number display length of the String {expr}
570strftime({format} [, {time}]) String format time with a specified format
571strgetchar({str}, {index}) Number get char {index} from {str}
572stridx({haystack}, {needle} [, {start}])
573 Number index of {needle} in {haystack}
574string({expr}) String String representation of {expr} value
575strlen({expr}) Number length of the String {expr}
576strpart({str}, {start} [, {len} [, {chars}]])
577 String {len} bytes/chars of {str} at
578 byte {start}
579strptime({format}, {timestring})
580 Number Convert {timestring} to unix timestamp
581strridx({haystack}, {needle} [, {start}])
582 Number last index of {needle} in {haystack}
583strtrans({expr}) String translate string to make it printable
584strwidth({expr}) Number display cell length of the String {expr}
585submatch({nr} [, {list}]) String or List
586 specific match in ":s" or substitute()
587substitute({expr}, {pat}, {sub}, {flags})
588 String all {pat} in {expr} replaced with {sub}
589swapinfo({fname}) Dict information about swap file {fname}
590swapname({buf}) String swap file of buffer {buf}
591synID({lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
592synIDattr({synID}, {what} [, {mode}])
593 String attribute {what} of syntax ID {synID}
594synIDtrans({synID}) Number translated syntax ID of {synID}
595synconcealed({lnum}, {col}) List info about concealing
596synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
597system({expr} [, {input}]) String output of shell command/filter {expr}
598systemlist({expr} [, {input}]) List output of shell command/filter {expr}
599tabpagebuflist([{arg}]) List list of buffer numbers in tab page
600tabpagenr([{arg}]) Number number of current or last tab page
601tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page
602tagfiles() List tags files used
603taglist({expr} [, {filename}]) List list of tags matching {expr}
604tan({expr}) Float tangent of {expr}
605tanh({expr}) Float hyperbolic tangent of {expr}
606tempname() String name for a temporary file
607term_dumpdiff({filename}, {filename} [, {options}])
608 Number display difference between two dumps
609term_dumpload({filename} [, {options}])
610 Number displaying a screen dump
611term_dumpwrite({buf}, {filename} [, {options}])
612 none dump terminal window contents
613term_getaltscreen({buf}) Number get the alternate screen flag
614term_getansicolors({buf}) List get ANSI palette in GUI color mode
615term_getattr({attr}, {what}) Number get the value of attribute {what}
616term_getcursor({buf}) List get the cursor position of a terminal
617term_getjob({buf}) Job get the job associated with a terminal
618term_getline({buf}, {row}) String get a line of text from a terminal
619term_getscrolled({buf}) Number get the scroll count of a terminal
620term_getsize({buf}) List get the size of a terminal
621term_getstatus({buf}) String get the status of a terminal
622term_gettitle({buf}) String get the title of a terminal
623term_gettty({buf}, [{input}]) String get the tty name of a terminal
624term_list() List get the list of terminal buffers
625term_scrape({buf}, {row}) List get row of a terminal screen
626term_sendkeys({buf}, {keys}) none send keystrokes to a terminal
627term_setansicolors({buf}, {colors})
628 none set ANSI palette in GUI color mode
629term_setapi({buf}, {expr}) none set |terminal-api| function name prefix
630term_setkill({buf}, {how}) none set signal to stop job in terminal
631term_setrestore({buf}, {command}) none set command to restore terminal
632term_setsize({buf}, {rows}, {cols})
633 none set the size of a terminal
634term_start({cmd} [, {options}]) Number open a terminal window and run a job
635term_wait({buf} [, {time}]) Number wait for screen to be updated
636terminalprops() Dict properties of the terminal
637test_alloc_fail({id}, {countdown}, {repeat})
638 none make memory allocation fail
639test_autochdir() none enable 'autochdir' during startup
640test_feedinput({string}) none add key sequence to input buffer
641test_garbagecollect_now() none free memory right now for testing
642test_garbagecollect_soon() none free memory soon for testing
643test_getvalue({string}) any get value of an internal variable
Yegappan Lakshmanan06011e12022-01-30 12:37:29 +0000644test_gui_event({event}, {args}) bool generate a GUI event for testing
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000645test_ignore_error({expr}) none ignore a specific error
646test_null_blob() Blob null value for testing
647test_null_channel() Channel null value for testing
648test_null_dict() Dict null value for testing
649test_null_function() Funcref null value for testing
650test_null_job() Job null value for testing
651test_null_list() List null value for testing
652test_null_partial() Funcref null value for testing
653test_null_string() String null value for testing
654test_option_not_set({name}) none reset flag indicating option was set
655test_override({expr}, {val}) none test with Vim internal overrides
656test_refcount({expr}) Number get the reference count of {expr}
657test_scrollbar({which}, {value}, {dragging})
658 none scroll in the GUI for testing
659test_setmouse({row}, {col}) none set the mouse position for testing
660test_settime({expr}) none set current time for testing
661test_srand_seed([seed]) none set seed for testing srand()
662test_unknown() any unknown value for testing
663test_void() any void value for testing
664timer_info([{id}]) List information about timers
665timer_pause({id}, {pause}) none pause or unpause a timer
666timer_start({time}, {callback} [, {options}])
667 Number create a timer
668timer_stop({timer}) none stop a timer
669timer_stopall() none stop all timers
670tolower({expr}) String the String {expr} switched to lowercase
671toupper({expr}) String the String {expr} switched to uppercase
672tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
673 to chars in {tostr}
674trim({text} [, {mask} [, {dir}]])
675 String trim characters in {mask} from {text}
676trunc({expr}) Float truncate Float {expr}
677type({expr}) Number type of value {expr}
678typename({expr}) String representation of the type of {expr}
679undofile({name}) String undo file name for {name}
680undotree() List undo file tree
681uniq({list} [, {func} [, {dict}]])
682 List remove adjacent duplicates from a list
683values({dict}) List values in {dict}
684virtcol({expr}) Number screen column of cursor or mark
685visualmode([expr]) String last visual mode used
686wildmenumode() Number whether 'wildmenu' mode is active
687win_execute({id}, {command} [, {silent}])
688 String execute {command} in window {id}
689win_findbuf({bufnr}) List find windows containing {bufnr}
690win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab}
691win_gettype([{nr}]) String type of window {nr}
692win_gotoid({expr}) Number go to window with ID {expr}
693win_id2tabwin({expr}) List get tab and window nr from window ID
694win_id2win({expr}) Number get window nr from window ID
Daniel Steinbergee630312022-01-10 13:36:34 +0000695win_move_separator({nr}) Number move window vertical separator
696win_move_statusline({nr}) Number move window status line
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000697win_screenpos({nr}) List get screen position of window {nr}
698win_splitmove({nr}, {target} [, {options}])
699 Number move window {nr} to split of {target}
700winbufnr({nr}) Number buffer number of window {nr}
701wincol() Number window column of the cursor
702windowsversion() String MS-Windows OS version
703winheight({nr}) Number height of window {nr}
704winlayout([{tabnr}]) List layout of windows in tab {tabnr}
705winline() Number window line of the cursor
706winnr([{expr}]) Number number of current window
707winrestcmd() String returns command to restore window sizes
708winrestview({dict}) none restore view of current window
709winsaveview() Dict save view of current window
710winwidth({nr}) Number width of window {nr}
711wordcount() Dict get byte/char/word statistics
712writefile({object}, {fname} [, {flags}])
713 Number write |Blob| or |List| of lines to file
714xor({expr}, {expr}) Number bitwise XOR
715
716==============================================================================
7172. Details *builtin-function-details*
718
719Not all functions are here, some have been moved to a help file covering the
720specific functionality.
721
722abs({expr}) *abs()*
723 Return the absolute value of {expr}. When {expr} evaluates to
724 a |Float| abs() returns a |Float|. When {expr} can be
725 converted to a |Number| abs() returns a |Number|. Otherwise
726 abs() gives an error message and returns -1.
727 Examples: >
728 echo abs(1.456)
729< 1.456 >
730 echo abs(-5.456)
731< 5.456 >
732 echo abs(-4)
733< 4
734
735 Can also be used as a |method|: >
736 Compute()->abs()
737
738< {only available when compiled with the |+float| feature}
739
740
741acos({expr}) *acos()*
742 Return the arc cosine of {expr} measured in radians, as a
743 |Float| in the range of [0, pi].
744 {expr} must evaluate to a |Float| or a |Number| in the range
745 [-1, 1].
746 Examples: >
747 :echo acos(0)
748< 1.570796 >
749 :echo acos(-0.5)
750< 2.094395
751
752 Can also be used as a |method|: >
753 Compute()->acos()
754
755< {only available when compiled with the |+float| feature}
756
757
758add({object}, {expr}) *add()*
759 Append the item {expr} to |List| or |Blob| {object}. Returns
760 the resulting |List| or |Blob|. Examples: >
761 :let alist = add([1, 2, 3], item)
762 :call add(mylist, "woodstock")
763< Note that when {expr} is a |List| it is appended as a single
764 item. Use |extend()| to concatenate |Lists|.
765 When {object} is a |Blob| then {expr} must be a number.
766 Use |insert()| to add an item at another position.
767
768 Can also be used as a |method|: >
769 mylist->add(val1)->add(val2)
770
771
772and({expr}, {expr}) *and()*
773 Bitwise AND on the two arguments. The arguments are converted
774 to a number. A List, Dict or Float argument causes an error.
775 Example: >
776 :let flag = and(bits, 0x80)
777< Can also be used as a |method|: >
778 :let flag = bits->and(0x80)
779
780
781append({lnum}, {text}) *append()*
782 When {text} is a |List|: Append each item of the |List| as a
783 text line below line {lnum} in the current buffer.
784 Otherwise append {text} as one text line below line {lnum} in
785 the current buffer.
786 Any type of item is accepted and converted to a String.
787 {lnum} can be zero to insert a line before the first one.
788 {lnum} is used like with |getline()|.
789 Returns 1 for failure ({lnum} out of range or out of memory),
790 0 for success. In |Vim9| script an invalid argument or
791 negative number results in an error. Example: >
792 :let failed = append(line('$'), "# THE END")
793 :let failed = append(0, ["Chapter 1", "the beginning"])
794
795< Can also be used as a |method| after a List, the base is
796 passed as the second argument: >
797 mylist->append(lnum)
798
799
800appendbufline({buf}, {lnum}, {text}) *appendbufline()*
801 Like |append()| but append the text in buffer {buf}.
802
803 This function works only for loaded buffers. First call
804 |bufload()| if needed.
805
806 For the use of {buf}, see |bufname()|.
807
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000808 {lnum} is the line number to append below. Note that using
809 |line()| would use the current buffer, not the one appending
810 to. Use "$" to append at the end of the buffer. Other string
811 values are not supported.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000812
813 On success 0 is returned, on failure 1 is returned.
814 In |Vim9| script an error is given for an invalid {lnum}.
815
816 If {buf} is not a valid buffer or {lnum} is not valid, an
817 error message is given. Example: >
818 :let failed = appendbufline(13, 0, "# THE START")
819<
820 Can also be used as a |method| after a List, the base is
821 passed as the second argument: >
822 mylist->appendbufline(buf, lnum)
823
824
825argc([{winid}]) *argc()*
826 The result is the number of files in the argument list. See
827 |arglist|.
828 If {winid} is not supplied, the argument list of the current
829 window is used.
830 If {winid} is -1, the global argument list is used.
831 Otherwise {winid} specifies the window of which the argument
832 list is used: either the window number or the window ID.
833 Returns -1 if the {winid} argument is invalid.
834
835 *argidx()*
836argidx() The result is the current index in the argument list. 0 is
837 the first file. argc() - 1 is the last one. See |arglist|.
838
839 *arglistid()*
840arglistid([{winnr} [, {tabnr}]])
841 Return the argument list ID. This is a number which
842 identifies the argument list being used. Zero is used for the
843 global argument list. See |arglist|.
844 Returns -1 if the arguments are invalid.
845
846 Without arguments use the current window.
847 With {winnr} only use this window in the current tab page.
848 With {winnr} and {tabnr} use the window in the specified tab
849 page.
850 {winnr} can be the window number or the |window-ID|.
851
852 *argv()*
853argv([{nr} [, {winid}]])
854 The result is the {nr}th file in the argument list. See
855 |arglist|. "argv(0)" is the first one. Example: >
856 :let i = 0
857 :while i < argc()
858 : let f = escape(fnameescape(argv(i)), '.')
859 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
860 : let i = i + 1
861 :endwhile
862< Without the {nr} argument, or when {nr} is -1, a |List| with
863 the whole |arglist| is returned.
864
865 The {winid} argument specifies the window ID, see |argc()|.
866 For the Vim command line arguments see |v:argv|.
867
868asin({expr}) *asin()*
869 Return the arc sine of {expr} measured in radians, as a |Float|
870 in the range of [-pi/2, pi/2].
871 {expr} must evaluate to a |Float| or a |Number| in the range
872 [-1, 1].
873 Examples: >
874 :echo asin(0.8)
875< 0.927295 >
876 :echo asin(-0.5)
877< -0.523599
878
879 Can also be used as a |method|: >
880 Compute()->asin()
881<
882 {only available when compiled with the |+float| feature}
883
884
885assert_ functions are documented here: |assert-functions-details|
886
887
888
889atan({expr}) *atan()*
890 Return the principal value of the arc tangent of {expr}, in
891 the range [-pi/2, +pi/2] radians, as a |Float|.
892 {expr} must evaluate to a |Float| or a |Number|.
893 Examples: >
894 :echo atan(100)
895< 1.560797 >
896 :echo atan(-4.01)
897< -1.326405
898
899 Can also be used as a |method|: >
900 Compute()->atan()
901<
902 {only available when compiled with the |+float| feature}
903
904
905atan2({expr1}, {expr2}) *atan2()*
906 Return the arc tangent of {expr1} / {expr2}, measured in
907 radians, as a |Float| in the range [-pi, pi].
908 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
909 Examples: >
910 :echo atan2(-1, 1)
911< -0.785398 >
912 :echo atan2(1, -1)
913< 2.356194
914
915 Can also be used as a |method|: >
916 Compute()->atan2(1)
917<
918 {only available when compiled with the |+float| feature}
919
920balloon_gettext() *balloon_gettext()*
921 Return the current text in the balloon. Only for the string,
922 not used for the List.
923
924balloon_show({expr}) *balloon_show()*
925 Show {expr} inside the balloon. For the GUI {expr} is used as
926 a string. For a terminal {expr} can be a list, which contains
927 the lines of the balloon. If {expr} is not a list it will be
928 split with |balloon_split()|.
929 If {expr} is an empty string any existing balloon is removed.
930
931 Example: >
932 func GetBalloonContent()
933 " ... initiate getting the content
934 return ''
935 endfunc
936 set balloonexpr=GetBalloonContent()
937
938 func BalloonCallback(result)
939 call balloon_show(a:result)
940 endfunc
941< Can also be used as a |method|: >
942 GetText()->balloon_show()
943<
944 The intended use is that fetching the content of the balloon
945 is initiated from 'balloonexpr'. It will invoke an
946 asynchronous method, in which a callback invokes
947 balloon_show(). The 'balloonexpr' itself can return an
948 empty string or a placeholder.
949
950 When showing a balloon is not possible nothing happens, no
951 error message.
952 {only available when compiled with the |+balloon_eval| or
953 |+balloon_eval_term| feature}
954
955balloon_split({msg}) *balloon_split()*
956 Split String {msg} into lines to be displayed in a balloon.
957 The splits are made for the current window size and optimize
958 to show debugger output.
959 Returns a |List| with the split lines.
960 Can also be used as a |method|: >
961 GetText()->balloon_split()->balloon_show()
962
963< {only available when compiled with the |+balloon_eval_term|
964 feature}
965
966blob2list({blob}) *blob2list()*
967 Return a List containing the number value of each byte in Blob
968 {blob}. Examples: >
969 blob2list(0z0102.0304) returns [1, 2, 3, 4]
970 blob2list(0z) returns []
971< Returns an empty List on error. |list2blob()| does the
972 opposite.
973
974 Can also be used as a |method|: >
975 GetBlob()->blob2list()
976
977 *browse()*
978browse({save}, {title}, {initdir}, {default})
979 Put up a file requester. This only works when "has("browse")"
980 returns |TRUE| (only in some GUI versions).
981 The input fields are:
982 {save} when |TRUE|, select file to write
983 {title} title for the requester
984 {initdir} directory to start browsing in
985 {default} default file name
986 An empty string is returned when the "Cancel" button is hit,
987 something went wrong, or browsing is not possible.
988
989 *browsedir()*
990browsedir({title}, {initdir})
991 Put up a directory requester. This only works when
992 "has("browse")" returns |TRUE| (only in some GUI versions).
993 On systems where a directory browser is not supported a file
994 browser is used. In that case: select a file in the directory
995 to be used.
996 The input fields are:
997 {title} title for the requester
998 {initdir} directory to start browsing in
999 When the "Cancel" button is hit, something went wrong, or
1000 browsing is not possible, an empty string is returned.
1001
1002bufadd({name}) *bufadd()*
1003 Add a buffer to the buffer list with String {name}.
1004 If a buffer for file {name} already exists, return that buffer
1005 number. Otherwise return the buffer number of the newly
1006 created buffer. When {name} is an empty string then a new
1007 buffer is always created.
1008 The buffer will not have 'buflisted' set and not be loaded
1009 yet. To add some text to the buffer use this: >
1010 let bufnr = bufadd('someName')
1011 call bufload(bufnr)
1012 call setbufline(bufnr, 1, ['some', 'text'])
1013< Can also be used as a |method|: >
1014 let bufnr = 'somename'->bufadd()
1015
1016bufexists({buf}) *bufexists()*
1017 The result is a Number, which is |TRUE| if a buffer called
1018 {buf} exists.
1019 If the {buf} argument is a number, buffer numbers are used.
1020 Number zero is the alternate buffer for the current window.
1021
1022 If the {buf} argument is a string it must match a buffer name
1023 exactly. The name can be:
1024 - Relative to the current directory.
1025 - A full path.
1026 - The name of a buffer with 'buftype' set to "nofile".
1027 - A URL name.
1028 Unlisted buffers will be found.
1029 Note that help files are listed by their short name in the
1030 output of |:buffers|, but bufexists() requires using their
1031 long name to be able to find them.
1032 bufexists() may report a buffer exists, but to use the name
1033 with a |:buffer| command you may need to use |expand()|. Esp
1034 for MS-Windows 8.3 names in the form "c:\DOCUME~1"
1035 Use "bufexists(0)" to test for the existence of an alternate
1036 file name.
1037
1038 Can also be used as a |method|: >
1039 let exists = 'somename'->bufexists()
1040<
1041 Obsolete name: buffer_exists(). *buffer_exists()*
1042
1043buflisted({buf}) *buflisted()*
1044 The result is a Number, which is |TRUE| if a buffer called
1045 {buf} exists and is listed (has the 'buflisted' option set).
1046 The {buf} argument is used like with |bufexists()|.
1047
1048 Can also be used as a |method|: >
1049 let listed = 'somename'->buflisted()
1050
1051bufload({buf}) *bufload()*
1052 Ensure the buffer {buf} is loaded. When the buffer name
1053 refers to an existing file then the file is read. Otherwise
1054 the buffer will be empty. If the buffer was already loaded
1055 then there is no change.
1056 If there is an existing swap file for the file of the buffer,
1057 there will be no dialog, the buffer will be loaded anyway.
1058 The {buf} argument is used like with |bufexists()|.
1059
1060 Can also be used as a |method|: >
1061 eval 'somename'->bufload()
1062
1063bufloaded({buf}) *bufloaded()*
1064 The result is a Number, which is |TRUE| if a buffer called
1065 {buf} exists and is loaded (shown in a window or hidden).
1066 The {buf} argument is used like with |bufexists()|.
1067
1068 Can also be used as a |method|: >
1069 let loaded = 'somename'->bufloaded()
1070
1071bufname([{buf}]) *bufname()*
1072 The result is the name of a buffer. Mostly as it is displayed
1073 by the `:ls` command, but not using special names such as
1074 "[No Name]".
1075 If {buf} is omitted the current buffer is used.
1076 If {buf} is a Number, that buffer number's name is given.
1077 Number zero is the alternate buffer for the current window.
1078 If {buf} is a String, it is used as a |file-pattern| to match
1079 with the buffer names. This is always done like 'magic' is
1080 set and 'cpoptions' is empty. When there is more than one
1081 match an empty string is returned.
1082 "" or "%" can be used for the current buffer, "#" for the
1083 alternate buffer.
1084 A full match is preferred, otherwise a match at the start, end
1085 or middle of the buffer name is accepted. If you only want a
1086 full match then put "^" at the start and "$" at the end of the
1087 pattern.
1088 Listed buffers are found first. If there is a single match
1089 with a listed buffer, that one is returned. Next unlisted
1090 buffers are searched for.
1091 If the {buf} is a String, but you want to use it as a buffer
1092 number, force it to be a Number by adding zero to it: >
1093 :echo bufname("3" + 0)
1094< Can also be used as a |method|: >
1095 echo bufnr->bufname()
1096
1097< If the buffer doesn't exist, or doesn't have a name, an empty
1098 string is returned. >
1099 bufname("#") alternate buffer name
1100 bufname(3) name of buffer 3
1101 bufname("%") name of current buffer
1102 bufname("file2") name of buffer where "file2" matches.
1103< *buffer_name()*
1104 Obsolete name: buffer_name().
1105
1106 *bufnr()*
1107bufnr([{buf} [, {create}]])
1108 The result is the number of a buffer, as it is displayed by
1109 the `:ls` command. For the use of {buf}, see |bufname()|
1110 above.
1111
1112 If the buffer doesn't exist, -1 is returned. Or, if the
1113 {create} argument is present and TRUE, a new, unlisted,
1114 buffer is created and its number is returned. Example: >
1115 let newbuf = bufnr('Scratch001', 1)
1116< Using an empty name uses the current buffer. To create a new
1117 buffer with an empty name use |bufadd()|.
1118
1119 bufnr("$") is the last buffer: >
1120 :let last_buffer = bufnr("$")
1121< The result is a Number, which is the highest buffer number
1122 of existing buffers. Note that not all buffers with a smaller
1123 number necessarily exist, because ":bwipeout" may have removed
1124 them. Use bufexists() to test for the existence of a buffer.
1125
1126 Can also be used as a |method|: >
1127 echo bufref->bufnr()
1128<
1129 Obsolete name: buffer_number(). *buffer_number()*
1130 *last_buffer_nr()*
1131 Obsolete name for bufnr("$"): last_buffer_nr().
1132
1133bufwinid({buf}) *bufwinid()*
1134 The result is a Number, which is the |window-ID| of the first
1135 window associated with buffer {buf}. For the use of {buf},
1136 see |bufname()| above. If buffer {buf} doesn't exist or
1137 there is no such window, -1 is returned. Example: >
1138
1139 echo "A window containing buffer 1 is " . (bufwinid(1))
1140<
1141 Only deals with the current tab page.
1142
1143 Can also be used as a |method|: >
1144 FindBuffer()->bufwinid()
1145
1146bufwinnr({buf}) *bufwinnr()*
1147 Like |bufwinid()| but return the window number instead of the
1148 |window-ID|.
1149 If buffer {buf} doesn't exist or there is no such window, -1
1150 is returned. Example: >
1151
1152 echo "A window containing buffer 1 is " . (bufwinnr(1))
1153
1154< The number can be used with |CTRL-W_w| and ":wincmd w"
1155 |:wincmd|.
1156
1157 Can also be used as a |method|: >
1158 FindBuffer()->bufwinnr()
1159
1160byte2line({byte}) *byte2line()*
1161 Return the line number that contains the character at byte
1162 count {byte} in the current buffer. This includes the
1163 end-of-line character, depending on the 'fileformat' option
1164 for the current buffer. The first character has byte count
1165 one.
1166 Also see |line2byte()|, |go| and |:goto|.
1167
1168 Can also be used as a |method|: >
1169 GetOffset()->byte2line()
1170
1171< {not available when compiled without the |+byte_offset|
1172 feature}
1173
1174byteidx({expr}, {nr}) *byteidx()*
1175 Return byte index of the {nr}'th character in the String
1176 {expr}. Use zero for the first character, it then returns
1177 zero.
1178 If there are no multibyte characters the returned value is
1179 equal to {nr}.
1180 Composing characters are not counted separately, their byte
1181 length is added to the preceding base character. See
1182 |byteidxcomp()| below for counting composing characters
1183 separately.
1184 Example : >
1185 echo matchstr(str, ".", byteidx(str, 3))
1186< will display the fourth character. Another way to do the
1187 same: >
1188 let s = strpart(str, byteidx(str, 3))
1189 echo strpart(s, 0, byteidx(s, 1))
1190< Also see |strgetchar()| and |strcharpart()|.
1191
1192 If there are less than {nr} characters -1 is returned.
1193 If there are exactly {nr} characters the length of the string
1194 in bytes is returned.
1195
1196 Can also be used as a |method|: >
1197 GetName()->byteidx(idx)
1198
1199byteidxcomp({expr}, {nr}) *byteidxcomp()*
1200 Like byteidx(), except that a composing character is counted
1201 as a separate character. Example: >
1202 let s = 'e' . nr2char(0x301)
1203 echo byteidx(s, 1)
1204 echo byteidxcomp(s, 1)
1205 echo byteidxcomp(s, 2)
1206< The first and third echo result in 3 ('e' plus composing
1207 character is 3 bytes), the second echo results in 1 ('e' is
1208 one byte).
1209 Only works differently from byteidx() when 'encoding' is set
1210 to a Unicode encoding.
1211
1212 Can also be used as a |method|: >
1213 GetName()->byteidxcomp(idx)
1214
1215call({func}, {arglist} [, {dict}]) *call()* *E699*
1216 Call function {func} with the items in |List| {arglist} as
1217 arguments.
1218 {func} can either be a |Funcref| or the name of a function.
1219 a:firstline and a:lastline are set to the cursor line.
1220 Returns the return value of the called function.
1221 {dict} is for functions with the "dict" attribute. It will be
1222 used to set the local variable "self". |Dictionary-function|
1223
1224 Can also be used as a |method|: >
1225 GetFunc()->call([arg, arg], dict)
1226
1227ceil({expr}) *ceil()*
1228 Return the smallest integral value greater than or equal to
1229 {expr} as a |Float| (round up).
1230 {expr} must evaluate to a |Float| or a |Number|.
1231 Examples: >
1232 echo ceil(1.456)
1233< 2.0 >
1234 echo ceil(-5.456)
1235< -5.0 >
1236 echo ceil(4.0)
1237< 4.0
1238
1239 Can also be used as a |method|: >
1240 Compute()->ceil()
1241<
1242 {only available when compiled with the |+float| feature}
1243
1244
1245ch_ functions are documented here: |channel-functions-details|
1246
1247
1248changenr() *changenr()*
1249 Return the number of the most recent change. This is the same
1250 number as what is displayed with |:undolist| and can be used
1251 with the |:undo| command.
1252 When a change was made it is the number of that change. After
1253 redo it is the number of the redone change. After undo it is
1254 one less than the number of the undone change.
1255
1256char2nr({string} [, {utf8}]) *char2nr()*
1257 Return number value of the first char in {string}.
1258 Examples: >
1259 char2nr(" ") returns 32
1260 char2nr("ABC") returns 65
1261< When {utf8} is omitted or zero, the current 'encoding' is used.
1262 Example for "utf-8": >
1263 char2nr("á") returns 225
1264 char2nr("á"[0]) returns 195
1265< When {utf8} is TRUE, always treat as UTF-8 characters.
1266 A combining character is a separate character.
1267 |nr2char()| does the opposite.
1268 To turn a string into a list of character numbers: >
1269 let str = "ABC"
1270 let list = map(split(str, '\zs'), {_, val -> char2nr(val)})
1271< Result: [65, 66, 67]
1272
1273 Can also be used as a |method|: >
1274 GetChar()->char2nr()
1275
1276
1277charclass({string}) *charclass()*
1278 Return the character class of the first character in {string}.
1279 The character class is one of:
1280 0 blank
1281 1 punctuation
1282 2 word character
1283 3 emoji
1284 other specific Unicode class
1285 The class is used in patterns and word motions.
1286
1287
1288charcol({expr}) *charcol()*
1289 Same as |col()| but returns the character index of the column
1290 position given with {expr} instead of the byte position.
1291
1292 Example:
1293 With the cursor on '세' in line 5 with text "여보세요": >
1294 charcol('.') returns 3
1295 col('.') returns 7
1296
1297< Can also be used as a |method|: >
1298 GetPos()->col()
1299<
1300 *charidx()*
1301charidx({string}, {idx} [, {countcc}])
1302 Return the character index of the byte at {idx} in {string}.
1303 The index of the first character is zero.
1304 If there are no multibyte characters the returned value is
1305 equal to {idx}.
1306 When {countcc} is omitted or |FALSE|, then composing characters
1307 are not counted separately, their byte length is
1308 added to the preceding base character.
1309 When {countcc} is |TRUE|, then composing characters are
1310 counted as separate characters.
1311 Returns -1 if the arguments are invalid or if {idx} is greater
1312 than the index of the last byte in {string}. An error is
1313 given if the first argument is not a string, the second
1314 argument is not a number or when the third argument is present
1315 and is not zero or one.
1316 See |byteidx()| and |byteidxcomp()| for getting the byte index
1317 from the character index.
1318 Examples: >
1319 echo charidx('áb́ć', 3) returns 1
1320 echo charidx('áb́ć', 6, 1) returns 4
1321 echo charidx('áb́ć', 16) returns -1
1322<
1323 Can also be used as a |method|: >
1324 GetName()->charidx(idx)
1325
1326chdir({dir}) *chdir()*
1327 Change the current working directory to {dir}. The scope of
1328 the directory change depends on the directory of the current
1329 window:
1330 - If the current window has a window-local directory
1331 (|:lcd|), then changes the window local directory.
1332 - Otherwise, if the current tabpage has a local
1333 directory (|:tcd|) then changes the tabpage local
1334 directory.
1335 - Otherwise, changes the global directory.
1336 {dir} must be a String.
1337 If successful, returns the previous working directory. Pass
1338 this to another chdir() to restore the directory.
1339 On failure, returns an empty string.
1340
1341 Example: >
1342 let save_dir = chdir(newdir)
1343 if save_dir != ""
1344 " ... do some work
1345 call chdir(save_dir)
1346 endif
1347
1348< Can also be used as a |method|: >
1349 GetDir()->chdir()
1350<
1351cindent({lnum}) *cindent()*
1352 Get the amount of indent for line {lnum} according the C
1353 indenting rules, as with 'cindent'.
1354 The indent is counted in spaces, the value of 'tabstop' is
1355 relevant. {lnum} is used just like in |getline()|.
1356 When {lnum} is invalid or Vim was not compiled the |+cindent|
1357 feature, -1 is returned.
1358 See |C-indenting|.
1359
1360 Can also be used as a |method|: >
1361 GetLnum()->cindent()
1362
1363clearmatches([{win}]) *clearmatches()*
1364 Clears all matches previously defined for the current window
1365 by |matchadd()| and the |:match| commands.
1366 If {win} is specified, use the window with this number or
1367 window ID instead of the current window.
1368
1369 Can also be used as a |method|: >
1370 GetWin()->clearmatches()
1371<
1372 *col()*
1373col({expr}) The result is a Number, which is the byte index of the column
1374 position given with {expr}. The accepted positions are:
1375 . the cursor position
1376 $ the end of the cursor line (the result is the
1377 number of bytes in the cursor line plus one)
1378 'x position of mark x (if the mark is not set, 0 is
1379 returned)
1380 v In Visual mode: the start of the Visual area (the
1381 cursor is the end). When not in Visual mode
1382 returns the cursor position. Differs from |'<| in
1383 that it's updated right away.
1384 Additionally {expr} can be [lnum, col]: a |List| with the line
1385 and column number. Most useful when the column is "$", to get
1386 the last column of a specific line. When "lnum" or "col" is
1387 out of range then col() returns zero.
1388 To get the line number use |line()|. To get both use
1389 |getpos()|.
1390 For the screen column position use |virtcol()|. For the
1391 character position use |charcol()|.
1392 Note that only marks in the current file can be used.
1393 Examples: >
1394 col(".") column of cursor
1395 col("$") length of cursor line plus one
1396 col("'t") column of mark t
1397 col("'" . markname) column of mark markname
1398< The first column is 1. 0 is returned for an error.
1399 For an uppercase mark the column may actually be in another
1400 buffer.
1401 For the cursor position, when 'virtualedit' is active, the
1402 column is one higher if the cursor is after the end of the
1403 line. This can be used to obtain the column in Insert mode: >
1404 :imap <F2> <C-O>:let save_ve = &ve<CR>
1405 \<C-O>:set ve=all<CR>
1406 \<C-O>:echo col(".") . "\n" <Bar>
1407 \let &ve = save_ve<CR>
1408
1409< Can also be used as a |method|: >
1410 GetPos()->col()
1411<
1412
1413complete({startcol}, {matches}) *complete()* *E785*
1414 Set the matches for Insert mode completion.
1415 Can only be used in Insert mode. You need to use a mapping
1416 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O
1417 or with an expression mapping.
1418 {startcol} is the byte offset in the line where the completed
1419 text start. The text up to the cursor is the original text
1420 that will be replaced by the matches. Use col('.') for an
1421 empty string. "col('.') - 1" will replace one character by a
1422 match.
1423 {matches} must be a |List|. Each |List| item is one match.
1424 See |complete-items| for the kind of items that are possible.
1425 "longest" in 'completeopt' is ignored.
1426 Note that the after calling this function you need to avoid
1427 inserting anything that would cause completion to stop.
1428 The match can be selected with CTRL-N and CTRL-P as usual with
1429 Insert mode completion. The popup menu will appear if
1430 specified, see |ins-completion-menu|.
1431 Example: >
1432 inoremap <F5> <C-R>=ListMonths()<CR>
1433
1434 func! ListMonths()
1435 call complete(col('.'), ['January', 'February', 'March',
1436 \ 'April', 'May', 'June', 'July', 'August', 'September',
1437 \ 'October', 'November', 'December'])
1438 return ''
1439 endfunc
1440< This isn't very useful, but it shows how it works. Note that
1441 an empty string is returned to avoid a zero being inserted.
1442
1443 Can also be used as a |method|, the base is passed as the
1444 second argument: >
1445 GetMatches()->complete(col('.'))
1446
1447complete_add({expr}) *complete_add()*
1448 Add {expr} to the list of matches. Only to be used by the
1449 function specified with the 'completefunc' option.
1450 Returns 0 for failure (empty string or out of memory),
1451 1 when the match was added, 2 when the match was already in
1452 the list.
1453 See |complete-functions| for an explanation of {expr}. It is
1454 the same as one item in the list that 'omnifunc' would return.
1455
1456 Can also be used as a |method|: >
1457 GetMoreMatches()->complete_add()
1458
1459complete_check() *complete_check()*
1460 Check for a key typed while looking for completion matches.
1461 This is to be used when looking for matches takes some time.
1462 Returns |TRUE| when searching for matches is to be aborted,
1463 zero otherwise.
1464 Only to be used by the function specified with the
1465 'completefunc' option.
1466
1467
1468complete_info([{what}]) *complete_info()*
1469 Returns a |Dictionary| with information about Insert mode
1470 completion. See |ins-completion|.
1471 The items are:
1472 mode Current completion mode name string.
1473 See |complete_info_mode| for the values.
1474 pum_visible |TRUE| if popup menu is visible.
1475 See |pumvisible()|.
1476 items List of completion matches. Each item is a
1477 dictionary containing the entries "word",
1478 "abbr", "menu", "kind", "info" and "user_data".
1479 See |complete-items|.
1480 selected Selected item index. First index is zero.
1481 Index is -1 if no item is selected (showing
1482 typed text only, or the last completion after
1483 no item is selected when using the <Up> or
1484 <Down> keys)
1485 inserted Inserted string. [NOT IMPLEMENT YET]
1486
1487 *complete_info_mode*
1488 mode values are:
1489 "" Not in completion mode
1490 "keyword" Keyword completion |i_CTRL-X_CTRL-N|
1491 "ctrl_x" Just pressed CTRL-X |i_CTRL-X|
1492 "scroll" Scrolling with |i_CTRL-X_CTRL-E| or
1493 |i_CTRL-X_CTRL-Y|
1494 "whole_line" Whole lines |i_CTRL-X_CTRL-L|
1495 "files" File names |i_CTRL-X_CTRL-F|
1496 "tags" Tags |i_CTRL-X_CTRL-]|
1497 "path_defines" Definition completion |i_CTRL-X_CTRL-D|
1498 "path_patterns" Include completion |i_CTRL-X_CTRL-I|
1499 "dictionary" Dictionary |i_CTRL-X_CTRL-K|
1500 "thesaurus" Thesaurus |i_CTRL-X_CTRL-T|
1501 "cmdline" Vim Command line |i_CTRL-X_CTRL-V|
1502 "function" User defined completion |i_CTRL-X_CTRL-U|
1503 "omni" Omni completion |i_CTRL-X_CTRL-O|
1504 "spell" Spelling suggestions |i_CTRL-X_s|
1505 "eval" |complete()| completion
1506 "unknown" Other internal modes
1507
1508 If the optional {what} list argument is supplied, then only
1509 the items listed in {what} are returned. Unsupported items in
1510 {what} are silently ignored.
1511
1512 To get the position and size of the popup menu, see
1513 |pum_getpos()|. It's also available in |v:event| during the
1514 |CompleteChanged| event.
1515
1516 Examples: >
1517 " Get all items
1518 call complete_info()
1519 " Get only 'mode'
1520 call complete_info(['mode'])
1521 " Get only 'mode' and 'pum_visible'
1522 call complete_info(['mode', 'pum_visible'])
1523
1524< Can also be used as a |method|: >
1525 GetItems()->complete_info()
1526<
1527 *confirm()*
1528confirm({msg} [, {choices} [, {default} [, {type}]]])
1529 confirm() offers the user a dialog, from which a choice can be
1530 made. It returns the number of the choice. For the first
1531 choice this is 1.
1532 Note: confirm() is only supported when compiled with dialog
1533 support, see |+dialog_con| and |+dialog_gui|.
1534
1535 {msg} is displayed in a |dialog| with {choices} as the
1536 alternatives. When {choices} is missing or empty, "&OK" is
1537 used (and translated).
1538 {msg} is a String, use '\n' to include a newline. Only on
1539 some systems the string is wrapped when it doesn't fit.
1540
1541 {choices} is a String, with the individual choices separated
1542 by '\n', e.g. >
1543 confirm("Save changes?", "&Yes\n&No\n&Cancel")
1544< The letter after the '&' is the shortcut key for that choice.
1545 Thus you can type 'c' to select "Cancel". The shortcut does
1546 not need to be the first letter: >
1547 confirm("file has been modified", "&Save\nSave &All")
1548< For the console, the first letter of each choice is used as
1549 the default shortcut key. Case is ignored.
1550
1551 The optional {default} argument is the number of the choice
1552 that is made if the user hits <CR>. Use 1 to make the first
1553 choice the default one. Use 0 to not set a default. If
1554 {default} is omitted, 1 is used.
1555
1556 The optional {type} String argument gives the type of dialog.
1557 This is only used for the icon of the GTK, Mac, Motif and
1558 Win32 GUI. It can be one of these values: "Error",
1559 "Question", "Info", "Warning" or "Generic". Only the first
1560 character is relevant. When {type} is omitted, "Generic" is
1561 used.
1562
1563 If the user aborts the dialog by pressing <Esc>, CTRL-C,
1564 or another valid interrupt key, confirm() returns 0.
1565
1566 An example: >
1567 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2)
1568 :if choice == 0
1569 : echo "make up your mind!"
1570 :elseif choice == 3
1571 : echo "tasteful"
1572 :else
1573 : echo "I prefer bananas myself."
1574 :endif
1575< In a GUI dialog, buttons are used. The layout of the buttons
1576 depends on the 'v' flag in 'guioptions'. If it is included,
1577 the buttons are always put vertically. Otherwise, confirm()
1578 tries to put the buttons in one horizontal line. If they
1579 don't fit, a vertical layout is used anyway. For some systems
1580 the horizontal layout is always used.
1581
1582 Can also be used as a |method|in: >
1583 BuildMessage()->confirm("&Yes\n&No")
1584<
1585 *copy()*
1586copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
1587 different from using {expr} directly.
1588 When {expr} is a |List| a shallow copy is created. This means
1589 that the original |List| can be changed without changing the
1590 copy, and vice versa. But the items are identical, thus
1591 changing an item changes the contents of both |Lists|.
1592 A |Dictionary| is copied in a similar way as a |List|.
1593 Also see |deepcopy()|.
1594 Can also be used as a |method|: >
1595 mylist->copy()
1596
1597cos({expr}) *cos()*
1598 Return the cosine of {expr}, measured in radians, as a |Float|.
1599 {expr} must evaluate to a |Float| or a |Number|.
1600 Examples: >
1601 :echo cos(100)
1602< 0.862319 >
1603 :echo cos(-4.01)
1604< -0.646043
1605
1606 Can also be used as a |method|: >
1607 Compute()->cos()
1608<
1609 {only available when compiled with the |+float| feature}
1610
1611
1612cosh({expr}) *cosh()*
1613 Return the hyperbolic cosine of {expr} as a |Float| in the range
1614 [1, inf].
1615 {expr} must evaluate to a |Float| or a |Number|.
1616 Examples: >
1617 :echo cosh(0.5)
1618< 1.127626 >
1619 :echo cosh(-0.5)
1620< -1.127626
1621
1622 Can also be used as a |method|: >
1623 Compute()->cosh()
1624<
1625 {only available when compiled with the |+float| feature}
1626
1627
1628count({comp}, {expr} [, {ic} [, {start}]]) *count()*
1629 Return the number of times an item with value {expr} appears
1630 in |String|, |List| or |Dictionary| {comp}.
1631
1632 If {start} is given then start with the item with this index.
1633 {start} can only be used with a |List|.
1634
1635 When {ic} is given and it's |TRUE| then case is ignored.
1636
1637 When {comp} is a string then the number of not overlapping
1638 occurrences of {expr} is returned. Zero is returned when
1639 {expr} is an empty string.
1640
1641 Can also be used as a |method|: >
1642 mylist->count(val)
1643<
1644 *cscope_connection()*
1645cscope_connection([{num} , {dbpath} [, {prepend}]])
1646 Checks for the existence of a |cscope| connection. If no
1647 parameters are specified, then the function returns:
1648 0, if cscope was not available (not compiled in), or
1649 if there are no cscope connections;
1650 1, if there is at least one cscope connection.
1651
1652 If parameters are specified, then the value of {num}
1653 determines how existence of a cscope connection is checked:
1654
1655 {num} Description of existence check
1656 ----- ------------------------------
1657 0 Same as no parameters (e.g., "cscope_connection()").
1658 1 Ignore {prepend}, and use partial string matches for
1659 {dbpath}.
1660 2 Ignore {prepend}, and use exact string matches for
1661 {dbpath}.
1662 3 Use {prepend}, use partial string matches for both
1663 {dbpath} and {prepend}.
1664 4 Use {prepend}, use exact string matches for both
1665 {dbpath} and {prepend}.
1666
1667 Note: All string comparisons are case sensitive!
1668
1669 Examples. Suppose we had the following (from ":cs show"): >
1670
1671 # pid database name prepend path
1672 0 27664 cscope.out /usr/local
1673<
1674 Invocation Return Val ~
1675 ---------- ---------- >
1676 cscope_connection() 1
1677 cscope_connection(1, "out") 1
1678 cscope_connection(2, "out") 0
1679 cscope_connection(3, "out") 0
1680 cscope_connection(3, "out", "local") 1
1681 cscope_connection(4, "out") 0
1682 cscope_connection(4, "out", "local") 0
1683 cscope_connection(4, "cscope.out", "/usr/local") 1
1684<
1685cursor({lnum}, {col} [, {off}]) *cursor()*
1686cursor({list})
1687 Positions the cursor at the column (byte count) {col} in the
1688 line {lnum}. The first column is one.
1689
1690 When there is one argument {list} this is used as a |List|
1691 with two, three or four item:
1692 [{lnum}, {col}]
1693 [{lnum}, {col}, {off}]
1694 [{lnum}, {col}, {off}, {curswant}]
1695 This is like the return value of |getpos()| or |getcurpos()|,
1696 but without the first item.
1697
1698 To position the cursor using the character count, use
1699 |setcursorcharpos()|.
1700
1701 Does not change the jumplist.
1702 {lnum} is used like with |getline()|.
1703 If {lnum} is greater than the number of lines in the buffer,
1704 the cursor will be positioned at the last line in the buffer.
1705 If {lnum} is zero, the cursor will stay in the current line.
1706 If {col} is greater than the number of bytes in the line,
1707 the cursor will be positioned at the last character in the
1708 line.
1709 If {col} is zero, the cursor will stay in the current column.
1710 If {curswant} is given it is used to set the preferred column
1711 for vertical movement. Otherwise {col} is used.
1712
1713 When 'virtualedit' is used {off} specifies the offset in
1714 screen columns from the start of the character. E.g., a
1715 position within a <Tab> or after the last character.
1716 Returns 0 when the position could be set, -1 otherwise.
1717
1718 Can also be used as a |method|: >
1719 GetCursorPos()->cursor()
1720
1721debugbreak({pid}) *debugbreak()*
1722 Specifically used to interrupt a program being debugged. It
1723 will cause process {pid} to get a SIGTRAP. Behavior for other
1724 processes is undefined. See |terminal-debugger|.
1725 {only available on MS-Windows}
1726
1727 Can also be used as a |method|: >
1728 GetPid()->debugbreak()
1729
1730deepcopy({expr} [, {noref}]) *deepcopy()* *E698*
1731 Make a copy of {expr}. For Numbers and Strings this isn't
1732 different from using {expr} directly.
1733 When {expr} is a |List| a full copy is created. This means
1734 that the original |List| can be changed without changing the
1735 copy, and vice versa. When an item is a |List| or
1736 |Dictionary|, a copy for it is made, recursively. Thus
1737 changing an item in the copy does not change the contents of
1738 the original |List|.
1739 A |Dictionary| is copied in a similar way as a |List|.
1740
1741 When {noref} is omitted or zero a contained |List| or
1742 |Dictionary| is only copied once. All references point to
1743 this single copy. With {noref} set to 1 every occurrence of a
1744 |List| or |Dictionary| results in a new copy. This also means
1745 that a cyclic reference causes deepcopy() to fail.
1746 *E724*
1747 Nesting is possible up to 100 levels. When there is an item
1748 that refers back to a higher level making a deep copy with
1749 {noref} set to 1 will fail.
1750 Also see |copy()|.
1751
1752 Can also be used as a |method|: >
1753 GetObject()->deepcopy()
1754
1755delete({fname} [, {flags}]) *delete()*
1756 Without {flags} or with {flags} empty: Deletes the file by the
1757 name {fname}. This also works when {fname} is a symbolic link.
1758
1759 When {flags} is "d": Deletes the directory by the name
1760 {fname}. This fails when directory {fname} is not empty.
1761
1762 When {flags} is "rf": Deletes the directory by the name
1763 {fname} and everything in it, recursively. BE CAREFUL!
1764 Note: on MS-Windows it is not possible to delete a directory
1765 that is being used.
1766
1767 A symbolic link itself is deleted, not what it points to.
1768
1769 The result is a Number, which is 0/false if the delete
1770 operation was successful and -1/true when the deletion failed
1771 or partly failed.
1772
1773 Use |remove()| to delete an item from a |List|.
1774 To delete a line from the buffer use |:delete| or
1775 |deletebufline()|.
1776
1777 Can also be used as a |method|: >
1778 GetName()->delete()
1779
1780deletebufline({buf}, {first} [, {last}]) *deletebufline()*
1781 Delete lines {first} to {last} (inclusive) from buffer {buf}.
1782 If {last} is omitted then delete line {first} only.
1783 On success 0 is returned, on failure 1 is returned.
1784
1785 This function works only for loaded buffers. First call
1786 |bufload()| if needed.
1787
1788 For the use of {buf}, see |bufname()| above.
1789
1790 {first} and {last} are used like with |getline()|. Note that
1791 when using |line()| this refers to the current buffer. Use "$"
1792 to refer to the last line in buffer {buf}.
1793
1794 Can also be used as a |method|: >
1795 GetBuffer()->deletebufline(1)
1796<
1797 *did_filetype()*
1798did_filetype() Returns |TRUE| when autocommands are being executed and the
1799 FileType event has been triggered at least once. Can be used
1800 to avoid triggering the FileType event again in the scripts
1801 that detect the file type. |FileType|
1802 Returns |FALSE| when `:setf FALLBACK` was used.
1803 When editing another file, the counter is reset, thus this
1804 really checks if the FileType event has been triggered for the
1805 current buffer. This allows an autocommand that starts
1806 editing another buffer to set 'filetype' and load a syntax
1807 file.
1808
1809diff_filler({lnum}) *diff_filler()*
1810 Returns the number of filler lines above line {lnum}.
1811 These are the lines that were inserted at this point in
1812 another diff'ed window. These filler lines are shown in the
1813 display but don't exist in the buffer.
1814 {lnum} is used like with |getline()|. Thus "." is the current
1815 line, "'m" mark m, etc.
1816 Returns 0 if the current window is not in diff mode.
1817
1818 Can also be used as a |method|: >
1819 GetLnum()->diff_filler()
1820
1821diff_hlID({lnum}, {col}) *diff_hlID()*
1822 Returns the highlight ID for diff mode at line {lnum} column
1823 {col} (byte index). When the current line does not have a
1824 diff change zero is returned.
1825 {lnum} is used like with |getline()|. Thus "." is the current
1826 line, "'m" mark m, etc.
1827 {col} is 1 for the leftmost column, {lnum} is 1 for the first
1828 line.
1829 The highlight ID can be used with |synIDattr()| to obtain
1830 syntax information about the highlighting.
1831
1832 Can also be used as a |method|: >
1833 GetLnum()->diff_hlID(col)
1834<
1835
1836digraph_get({chars}) *digraph_get()* *E1214*
1837 Return the digraph of {chars}. This should be a string with
1838 exactly two characters. If {chars} are not just two
1839 characters, or the digraph of {chars} does not exist, an error
1840 is given and an empty string is returned.
1841
1842 The character will be converted from Unicode to 'encoding'
1843 when needed. This does require the conversion to be
1844 available, it might fail.
1845
1846 Also see |digraph_getlist()|.
1847
1848 Examples: >
1849 " Get a built-in digraph
1850 :echo digraph_get('00') " Returns '∞'
1851
1852 " Get a user-defined digraph
1853 :call digraph_set('aa', 'あ')
1854 :echo digraph_get('aa') " Returns 'あ'
1855<
1856 Can also be used as a |method|: >
1857 GetChars()->digraph_get()
1858<
1859 This function works only when compiled with the |+digraphs|
1860 feature. If this feature is disabled, this function will
1861 display an error message.
1862
1863
1864digraph_getlist([{listall}]) *digraph_getlist()*
1865 Return a list of digraphs. If the {listall} argument is given
1866 and it is TRUE, return all digraphs, including the default
1867 digraphs. Otherwise, return only user-defined digraphs.
1868
1869 The characters will be converted from Unicode to 'encoding'
1870 when needed. This does require the conservation to be
1871 available, it might fail.
1872
1873 Also see |digraph_get()|.
1874
1875 Examples: >
1876 " Get user-defined digraphs
1877 :echo digraph_getlist()
1878
1879 " Get all the digraphs, including default digraphs
1880 :echo digraph_getlist(1)
1881<
1882 Can also be used as a |method|: >
1883 GetNumber()->digraph_getlist()
1884<
1885 This function works only when compiled with the |+digraphs|
1886 feature. If this feature is disabled, this function will
1887 display an error message.
1888
1889
1890digraph_set({chars}, {digraph}) *digraph_set()* *E1205*
1891 Add digraph {chars} to the list. {chars} must be a string
1892 with two characters. {digraph} is a string with one UTF-8
1893 encoded character. Be careful, composing characters are NOT
1894 ignored. This function is similar to |:digraphs| command, but
1895 useful to add digraphs start with a white space.
1896
1897 The function result is v:true if |digraph| is registered. If
1898 this fails an error message is given and v:false is returned.
1899
1900 If you want to define multiple digraphs at once, you can use
1901 |digraph_setlist()|.
1902
1903 Example: >
1904 call digraph_set(' ', 'あ')
1905<
1906 Can be used as a |method|: >
1907 GetString()->digraph_set('あ')
1908<
1909 This function works only when compiled with the |+digraphs|
1910 feature. If this feature is disabled, this function will
1911 display an error message.
1912
1913
1914digraph_setlist({digraphlist}) *digraph_setlist()*
1915 Similar to |digraph_set()| but this function can add multiple
1916 digraphs at once. {digraphlist} is a list composed of lists,
1917 where each list contains two strings with {chars} and
1918 {digraph} as in |digraph_set()|.
1919 Example: >
1920 call digraph_setlist([['aa', 'あ'], ['ii', 'い']])
1921<
1922 It is similar to the following: >
1923 for [chars, digraph] in [['aa', 'あ'], ['ii', 'い']]
1924 call digraph_set(chars, digraph)
1925 endfor
1926< Except that the function returns after the first error,
1927 following digraphs will not be added.
1928
1929 Can be used as a |method|: >
1930 GetList()->digraph_setlist()
1931<
1932 This function works only when compiled with the |+digraphs|
1933 feature. If this feature is disabled, this function will
1934 display an error message.
1935
1936
1937echoraw({string}) *echoraw()*
1938 Output {string} as-is, including unprintable characters.
1939 This can be used to output a terminal code. For example, to
1940 disable modifyOtherKeys: >
1941 call echoraw(&t_TE)
1942< and to enable it again: >
1943 call echoraw(&t_TI)
1944< Use with care, you can mess up the terminal this way.
1945
1946
1947empty({expr}) *empty()*
1948 Return the Number 1 if {expr} is empty, zero otherwise.
1949 - A |List| or |Dictionary| is empty when it does not have any
1950 items.
1951 - A |String| is empty when its length is zero.
1952 - A |Number| and |Float| are empty when their value is zero.
1953 - |v:false|, |v:none| and |v:null| are empty, |v:true| is not.
1954 - A |Job| is empty when it failed to start.
1955 - A |Channel| is empty when it is closed.
1956 - A |Blob| is empty when its length is zero.
1957
1958 For a long |List| this is much faster than comparing the
1959 length with zero.
1960
1961 Can also be used as a |method|: >
1962 mylist->empty()
1963
1964environ() *environ()*
1965 Return all of environment variables as dictionary. You can
1966 check if an environment variable exists like this: >
1967 :echo has_key(environ(), 'HOME')
1968< Note that the variable name may be CamelCase; to ignore case
1969 use this: >
1970 :echo index(keys(environ()), 'HOME', 0, 1) != -1
1971
1972escape({string}, {chars}) *escape()*
1973 Escape the characters in {chars} that occur in {string} with a
1974 backslash. Example: >
1975 :echo escape('c:\program files\vim', ' \')
1976< results in: >
1977 c:\\program\ files\\vim
1978< Also see |shellescape()| and |fnameescape()|.
1979
1980 Can also be used as a |method|: >
1981 GetText()->escape(' \')
1982<
1983 *eval()*
1984eval({string}) Evaluate {string} and return the result. Especially useful to
1985 turn the result of |string()| back into the original value.
1986 This works for Numbers, Floats, Strings, Blobs and composites
1987 of them. Also works for |Funcref|s that refer to existing
1988 functions.
1989
1990 Can also be used as a |method|: >
1991 argv->join()->eval()
1992
1993eventhandler() *eventhandler()*
1994 Returns 1 when inside an event handler. That is that Vim got
1995 interrupted while waiting for the user to type a character,
1996 e.g., when dropping a file on Vim. This means interactive
1997 commands cannot be used. Otherwise zero is returned.
1998
1999executable({expr}) *executable()*
2000 This function checks if an executable with the name {expr}
2001 exists. {expr} must be the name of the program without any
2002 arguments.
2003 executable() uses the value of $PATH and/or the normal
2004 searchpath for programs. *PATHEXT*
2005 On MS-Windows the ".exe", ".bat", etc. can optionally be
2006 included. Then the extensions in $PATHEXT are tried. Thus if
2007 "foo.exe" does not exist, "foo.exe.bat" can be found. If
2008 $PATHEXT is not set then ".com;.exe;.bat;.cmd" is used. A dot
2009 by itself can be used in $PATHEXT to try using the name
2010 without an extension. When 'shell' looks like a Unix shell,
2011 then the name is also tried without adding an extension.
2012 On MS-Windows it only checks if the file exists and is not a
2013 directory, not if it's really executable.
2014 On MS-Windows an executable in the same directory as Vim is
2015 always found. Since this directory is added to $PATH it
2016 should also work to execute it |win32-PATH|.
2017 The result is a Number:
2018 1 exists
2019 0 does not exist
2020 -1 not implemented on this system
2021 |exepath()| can be used to get the full path of an executable.
2022
2023 Can also be used as a |method|: >
2024 GetCommand()->executable()
2025
2026execute({command} [, {silent}]) *execute()*
2027 Execute an Ex command or commands and return the output as a
2028 string.
2029 {command} can be a string or a List. In case of a List the
2030 lines are executed one by one.
2031 This is equivalent to: >
2032 redir => var
2033 {command}
2034 redir END
2035<
2036 The optional {silent} argument can have these values:
2037 "" no `:silent` used
2038 "silent" `:silent` used
2039 "silent!" `:silent!` used
2040 The default is "silent". Note that with "silent!", unlike
2041 `:redir`, error messages are dropped. When using an external
2042 command the screen may be messed up, use `system()` instead.
2043 *E930*
2044 It is not possible to use `:redir` anywhere in {command}.
2045
2046 To get a list of lines use |split()| on the result: >
2047 split(execute('args'), "\n")
2048
2049< To execute a command in another window than the current one
2050 use `win_execute()`.
2051
2052 When used recursively the output of the recursive call is not
2053 included in the output of the higher level call.
2054
2055 Can also be used as a |method|: >
2056 GetCommand()->execute()
2057
2058exepath({expr}) *exepath()*
2059 If {expr} is an executable and is either an absolute path, a
2060 relative path or found in $PATH, return the full path.
2061 Note that the current directory is used when {expr} starts
2062 with "./", which may be a problem for Vim: >
2063 echo exepath(v:progpath)
2064< If {expr} cannot be found in $PATH or is not executable then
2065 an empty string is returned.
2066
2067 Can also be used as a |method|: >
2068 GetCommand()->exepath()
2069<
2070 *exists()*
2071exists({expr}) The result is a Number, which is |TRUE| if {expr} is defined,
2072 zero otherwise.
2073
2074 Note: In a compiled |:def| function the evaluation is done at
2075 runtime. Use `exists_compiled()` to evaluate the expression
2076 at compile time.
2077
2078 For checking for a supported feature use |has()|.
2079 For checking if a file exists use |filereadable()|.
2080
2081 The {expr} argument is a string, which contains one of these:
Bram Moolenaarf10911e2022-01-29 22:20:48 +00002082 varname internal variable (see
2083 dict.key |internal-variables|). Also works
2084 list[i] for |curly-braces-names|, |Dictionary|
2085 import.Func entries, |List| items, imported
2086 items,etc.
2087 Does not work for local variables in a
2088 compiled `:def` function.
2089 Beware that evaluating an index may
2090 cause an error message for an invalid
2091 expression. E.g.: >
2092 :let l = [1, 2, 3]
2093 :echo exists("l[5]")
2094< 0 >
2095 :echo exists("l[xx]")
2096< E121: Undefined variable: xx
2097 0
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002098 &option-name Vim option (only checks if it exists,
2099 not if it really works)
2100 +option-name Vim option that works.
2101 $ENVNAME environment variable (could also be
2102 done by comparing with an empty
2103 string)
2104 *funcname built-in function (see |functions|)
2105 or user defined function (see
2106 |user-functions|) that is implemented.
2107 Also works for a variable that is a
2108 Funcref.
2109 ?funcname built-in function that could be
2110 implemented; to be used to check if
2111 "funcname" is valid
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002112 :cmdname Ex command: built-in command, user
2113 command or command modifier |:command|.
2114 Returns:
2115 1 for match with start of a command
2116 2 full match with a command
2117 3 matches several user commands
2118 To check for a supported command
2119 always check the return value to be 2.
2120 :2match The |:2match| command.
2121 :3match The |:3match| command.
2122 #event autocommand defined for this event
2123 #event#pattern autocommand defined for this event and
2124 pattern (the pattern is taken
2125 literally and compared to the
2126 autocommand patterns character by
2127 character)
2128 #group autocommand group exists
2129 #group#event autocommand defined for this group and
2130 event.
2131 #group#event#pattern
2132 autocommand defined for this group,
2133 event and pattern.
2134 ##event autocommand for this event is
2135 supported.
2136
2137 Examples: >
2138 exists("&shortname")
2139 exists("$HOSTNAME")
2140 exists("*strftime")
2141 exists("*s:MyFunc")
2142 exists("bufcount")
2143 exists(":Make")
2144 exists("#CursorHold")
2145 exists("#BufReadPre#*.gz")
2146 exists("#filetypeindent")
2147 exists("#filetypeindent#FileType")
2148 exists("#filetypeindent#FileType#*")
2149 exists("##ColorScheme")
2150< There must be no space between the symbol (&/$/*/#) and the
2151 name.
2152 There must be no extra characters after the name, although in
2153 a few cases this is ignored. That may become more strict in
2154 the future, thus don't count on it!
2155 Working example: >
2156 exists(":make")
2157< NOT working example: >
2158 exists(":make install")
2159
2160< Note that the argument must be a string, not the name of the
2161 variable itself. For example: >
2162 exists(bufcount)
2163< This doesn't check for existence of the "bufcount" variable,
2164 but gets the value of "bufcount", and checks if that exists.
2165
2166 Can also be used as a |method|: >
2167 Varname()->exists()
2168<
2169
2170exists_compiled({expr}) *exists_compiled()*
2171 Like `exists()` but evaluated at compile time. This is useful
2172 to skip a block where a function is used that would otherwise
2173 give an error: >
2174 if exists_compiled('*ThatFunction')
2175 ThatFunction('works')
2176 endif
2177< If `exists()` were used then a compilation error would be
2178 given if ThatFunction() is not defined.
2179
2180 {expr} must be a literal string. *E1232*
2181 Can only be used in a |:def| function. *E1233*
2182 This does not work to check for arguments or local variables.
2183
2184
2185exp({expr}) *exp()*
2186 Return the exponential of {expr} as a |Float| in the range
2187 [0, inf].
2188 {expr} must evaluate to a |Float| or a |Number|.
2189 Examples: >
2190 :echo exp(2)
2191< 7.389056 >
2192 :echo exp(-1)
2193< 0.367879
2194
2195 Can also be used as a |method|: >
2196 Compute()->exp()
2197<
2198 {only available when compiled with the |+float| feature}
2199
2200
2201expand({string} [, {nosuf} [, {list}]]) *expand()*
2202 Expand wildcards and the following special keywords in
2203 {string}. 'wildignorecase' applies.
2204
2205 If {list} is given and it is |TRUE|, a List will be returned.
2206 Otherwise the result is a String and when there are several
2207 matches, they are separated by <NL> characters. [Note: in
2208 version 5.0 a space was used, which caused problems when a
2209 file name contains a space]
2210
2211 If the expansion fails, the result is an empty string. A name
2212 for a non-existing file is not included, unless {string} does
2213 not start with '%', '#' or '<', see below.
2214
2215 When {string} starts with '%', '#' or '<', the expansion is
2216 done like for the |cmdline-special| variables with their
2217 associated modifiers. Here is a short overview:
2218
2219 % current file name
2220 # alternate file name
2221 #n alternate file name n
2222 <cfile> file name under the cursor
2223 <afile> autocmd file name
2224 <abuf> autocmd buffer number (as a String!)
2225 <amatch> autocmd matched name
2226 <cexpr> C expression under the cursor
2227 <sfile> sourced script file or function name
2228 <slnum> sourced script line number or function
2229 line number
2230 <sflnum> script file line number, also when in
2231 a function
2232 <SID> "<SNR>123_" where "123" is the
2233 current script ID |<SID>|
2234 <stack> call stack
2235 <cword> word under the cursor
2236 <cWORD> WORD under the cursor
2237 <client> the {clientid} of the last received
2238 message |server2client()|
2239 Modifiers:
2240 :p expand to full path
2241 :h head (last path component removed)
2242 :t tail (last path component only)
2243 :r root (one extension removed)
2244 :e extension only
2245
2246 Example: >
2247 :let &tags = expand("%:p:h") . "/tags"
2248< Note that when expanding a string that starts with '%', '#' or
2249 '<', any following text is ignored. This does NOT work: >
2250 :let doesntwork = expand("%:h.bak")
2251< Use this: >
2252 :let doeswork = expand("%:h") . ".bak"
2253< Also note that expanding "<cfile>" and others only returns the
2254 referenced file name without further expansion. If "<cfile>"
2255 is "~/.cshrc", you need to do another expand() to have the
2256 "~/" expanded into the path of the home directory: >
2257 :echo expand(expand("<cfile>"))
2258<
2259 There cannot be white space between the variables and the
2260 following modifier. The |fnamemodify()| function can be used
2261 to modify normal file names.
2262
2263 When using '%' or '#', and the current or alternate file name
2264 is not defined, an empty string is used. Using "%:p" in a
2265 buffer with no name, results in the current directory, with a
2266 '/' added.
2267
2268 When {string} does not start with '%', '#' or '<', it is
2269 expanded like a file name is expanded on the command line.
2270 'suffixes' and 'wildignore' are used, unless the optional
2271 {nosuf} argument is given and it is |TRUE|.
2272 Names for non-existing files are included. The "**" item can
2273 be used to search in a directory tree. For example, to find
2274 all "README" files in the current directory and below: >
2275 :echo expand("**/README")
2276<
2277 expand() can also be used to expand variables and environment
2278 variables that are only known in a shell. But this can be
2279 slow, because a shell may be used to do the expansion. See
2280 |expr-env-expand|.
2281 The expanded variable is still handled like a list of file
2282 names. When an environment variable cannot be expanded, it is
2283 left unchanged. Thus ":echo expand('$FOOBAR')" results in
2284 "$FOOBAR".
2285
2286 See |glob()| for finding existing files. See |system()| for
2287 getting the raw output of an external command.
2288
2289 Can also be used as a |method|: >
2290 Getpattern()->expand()
2291
2292expandcmd({string}) *expandcmd()*
2293 Expand special items in String {string} like what is done for
2294 an Ex command such as `:edit`. This expands special keywords,
2295 like with |expand()|, and environment variables, anywhere in
2296 {string}. "~user" and "~/path" are only expanded at the
2297 start.
2298 Returns the expanded string. Example: >
2299 :echo expandcmd('make %<.o')
2300
2301< Can also be used as a |method|: >
2302 GetCommand()->expandcmd()
2303<
2304extend({expr1}, {expr2} [, {expr3}]) *extend()*
2305 {expr1} and {expr2} must be both |Lists| or both
2306 |Dictionaries|.
2307
2308 If they are |Lists|: Append {expr2} to {expr1}.
2309 If {expr3} is given insert the items of {expr2} before the
2310 item with index {expr3} in {expr1}. When {expr3} is zero
2311 insert before the first item. When {expr3} is equal to
2312 len({expr1}) then {expr2} is appended.
2313 Examples: >
2314 :echo sort(extend(mylist, [7, 5]))
2315 :call extend(mylist, [2, 3], 1)
2316< When {expr1} is the same List as {expr2} then the number of
2317 items copied is equal to the original length of the List.
2318 E.g., when {expr3} is 1 you get N new copies of the first item
2319 (where N is the original length of the List).
2320 Use |add()| to concatenate one item to a list. To concatenate
2321 two lists into a new list use the + operator: >
2322 :let newlist = [1, 2, 3] + [4, 5]
2323<
2324 If they are |Dictionaries|:
2325 Add all entries from {expr2} to {expr1}.
2326 If a key exists in both {expr1} and {expr2} then {expr3} is
2327 used to decide what to do:
2328 {expr3} = "keep": keep the value of {expr1}
2329 {expr3} = "force": use the value of {expr2}
2330 {expr3} = "error": give an error message *E737*
2331 When {expr3} is omitted then "force" is assumed.
2332
2333 {expr1} is changed when {expr2} is not empty. If necessary
2334 make a copy of {expr1} first.
2335 {expr2} remains unchanged.
2336 When {expr1} is locked and {expr2} is not empty the operation
2337 fails.
2338 Returns {expr1}.
2339
2340 Can also be used as a |method|: >
2341 mylist->extend(otherlist)
2342
2343
2344extendnew({expr1}, {expr2} [, {expr3}]) *extendnew()*
2345 Like |extend()| but instead of adding items to {expr1} a new
2346 List or Dictionary is created and returned. {expr1} remains
2347 unchanged. Items can still be changed by {expr2}, if you
2348 don't want that use |deepcopy()| first.
2349
2350
2351feedkeys({string} [, {mode}]) *feedkeys()*
2352 Characters in {string} are queued for processing as if they
2353 come from a mapping or were typed by the user.
2354
2355 By default the string is added to the end of the typeahead
2356 buffer, thus if a mapping is still being executed the
2357 characters come after them. Use the 'i' flag to insert before
2358 other characters, they will be executed next, before any
2359 characters from a mapping.
2360
2361 The function does not wait for processing of keys contained in
2362 {string}.
2363
2364 To include special keys into {string}, use double-quotes
2365 and "\..." notation |expr-quote|. For example,
2366 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
2367 feedkeys('\<CR>') pushes 5 characters.
2368 A special code that might be useful is <Ignore>, it exits the
2369 wait for a character without doing anything. *<Ignore>*
2370
2371 {mode} is a String, which can contain these character flags:
2372 'm' Remap keys. This is default. If {mode} is absent,
2373 keys are remapped.
2374 'n' Do not remap keys.
2375 't' Handle keys as if typed; otherwise they are handled as
2376 if coming from a mapping. This matters for undo,
2377 opening folds, etc.
2378 'L' Lowlevel input. Only works for Unix or when using the
2379 GUI. Keys are used as if they were coming from the
2380 terminal. Other flags are not used. *E980*
2381 When a CTRL-C interrupts and 't' is included it sets
2382 the internal "got_int" flag.
2383 'i' Insert the string instead of appending (see above).
2384 'x' Execute commands until typeahead is empty. This is
2385 similar to using ":normal!". You can call feedkeys()
2386 several times without 'x' and then one time with 'x'
2387 (possibly with an empty {string}) to execute all the
2388 typeahead. Note that when Vim ends in Insert mode it
2389 will behave as if <Esc> is typed, to avoid getting
2390 stuck, waiting for a character to be typed before the
2391 script continues.
2392 Note that if you manage to call feedkeys() while
2393 executing commands, thus calling it recursively, then
2394 all typeahead will be consumed by the last call.
Bram Moolenaara9725222022-01-16 13:30:33 +00002395 'c' Remove any script context when executing, so that
2396 legacy script syntax applies, "s:var" does not work,
2397 etc.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002398 '!' When used with 'x' will not end Insert mode. Can be
2399 used in a test when a timer is set to exit Insert mode
2400 a little later. Useful for testing CursorHoldI.
2401
2402 Return value is always 0.
2403
2404 Can also be used as a |method|: >
2405 GetInput()->feedkeys()
2406
2407filereadable({file}) *filereadable()*
2408 The result is a Number, which is |TRUE| when a file with the
2409 name {file} exists, and can be read. If {file} doesn't exist,
2410 or is a directory, the result is |FALSE|. {file} is any
2411 expression, which is used as a String.
2412 If you don't care about the file being readable you can use
2413 |glob()|.
2414 {file} is used as-is, you may want to expand wildcards first: >
2415 echo filereadable('~/.vimrc')
2416 0
2417 echo filereadable(expand('~/.vimrc'))
2418 1
2419
2420< Can also be used as a |method|: >
2421 GetName()->filereadable()
2422< *file_readable()*
2423 Obsolete name: file_readable().
2424
2425
2426filewritable({file}) *filewritable()*
2427 The result is a Number, which is 1 when a file with the
2428 name {file} exists, and can be written. If {file} doesn't
2429 exist, or is not writable, the result is 0. If {file} is a
2430 directory, and we can write to it, the result is 2.
2431
2432 Can also be used as a |method|: >
2433 GetName()->filewritable()
2434
2435
2436filter({expr1}, {expr2}) *filter()*
2437 {expr1} must be a |List|, |String|, |Blob| or |Dictionary|.
2438 For each item in {expr1} evaluate {expr2} and when the result
2439 is zero or false remove the item from the |List| or
2440 |Dictionary|. Similarly for each byte in a |Blob| and each
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00002441 character in a |String|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002442
2443 {expr2} must be a |string| or |Funcref|.
2444
2445 If {expr2} is a |string|, inside {expr2} |v:val| has the value
2446 of the current item. For a |Dictionary| |v:key| has the key
2447 of the current item and for a |List| |v:key| has the index of
2448 the current item. For a |Blob| |v:key| has the index of the
2449 current byte. For a |String| |v:key| has the index of the
2450 current character.
2451 Examples: >
2452 call filter(mylist, 'v:val !~ "OLD"')
2453< Removes the items where "OLD" appears. >
2454 call filter(mydict, 'v:key >= 8')
2455< Removes the items with a key below 8. >
2456 call filter(var, 0)
2457< Removes all the items, thus clears the |List| or |Dictionary|.
2458
2459 Note that {expr2} is the result of expression and is then
2460 used as an expression again. Often it is good to use a
2461 |literal-string| to avoid having to double backslashes.
2462
2463 If {expr2} is a |Funcref| it must take two arguments:
2464 1. the key or the index of the current item.
2465 2. the value of the current item.
2466 The function must return |TRUE| if the item should be kept.
2467 Example that keeps the odd items of a list: >
2468 func Odd(idx, val)
2469 return a:idx % 2 == 1
2470 endfunc
2471 call filter(mylist, function('Odd'))
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00002472< It is shorter when using a |lambda|. In |Vim9| syntax: >
2473 call filter(myList, (idx, val) => idx * val <= 42)
2474< In legacy script syntax: >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002475 call filter(myList, {idx, val -> idx * val <= 42})
2476< If you do not use "val" you can leave it out: >
2477 call filter(myList, {idx -> idx % 2 == 1})
2478<
2479 In |Vim9| script the result must be true, false, zero or one.
2480 Other values will result in a type error.
2481
2482 For a |List| and a |Dictionary| the operation is done
2483 in-place. If you want it to remain unmodified make a copy
2484 first: >
2485 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
2486
2487< Returns {expr1}, the |List| or |Dictionary| that was filtered,
naohiro ono56200ee2022-01-01 14:59:44 +00002488 or a new |Blob| or |String|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002489 When an error is encountered while evaluating {expr2} no
2490 further items in {expr1} are processed.
2491 When {expr2} is a Funcref errors inside a function are ignored,
2492 unless it was defined with the "abort" flag.
2493
2494 Can also be used as a |method|: >
2495 mylist->filter(expr2)
2496
2497finddir({name} [, {path} [, {count}]]) *finddir()*
2498 Find directory {name} in {path}. Supports both downwards and
2499 upwards recursive directory searches. See |file-searching|
2500 for the syntax of {path}.
2501
2502 Returns the path of the first found match. When the found
2503 directory is below the current directory a relative path is
2504 returned. Otherwise a full path is returned.
2505 If {path} is omitted or empty then 'path' is used.
2506
2507 If the optional {count} is given, find {count}'s occurrence of
2508 {name} in {path} instead of the first one.
2509 When {count} is negative return all the matches in a |List|.
2510
2511 This is quite similar to the ex-command `:find`.
2512 {only available when compiled with the |+file_in_path|
2513 feature}
2514
2515 Can also be used as a |method|: >
2516 GetName()->finddir()
2517
2518findfile({name} [, {path} [, {count}]]) *findfile()*
2519 Just like |finddir()|, but find a file instead of a directory.
2520 Uses 'suffixesadd'.
2521 Example: >
2522 :echo findfile("tags.vim", ".;")
2523< Searches from the directory of the current file upwards until
2524 it finds the file "tags.vim".
2525
2526 Can also be used as a |method|: >
2527 GetName()->findfile()
2528
2529flatten({list} [, {maxdepth}]) *flatten()*
2530 Flatten {list} up to {maxdepth} levels. Without {maxdepth}
2531 the result is a |List| without nesting, as if {maxdepth} is
2532 a very large number.
2533 The {list} is changed in place, use |flattennew()| if you do
2534 not want that.
2535 In Vim9 script flatten() cannot be used, you must always use
Bram Moolenaarf10911e2022-01-29 22:20:48 +00002536 |flattennew()|. *E1158*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002537 *E900*
2538 {maxdepth} means how deep in nested lists changes are made.
2539 {list} is not modified when {maxdepth} is 0.
2540 {maxdepth} must be positive number.
2541
2542 If there is an error the number zero is returned.
2543
2544 Example: >
2545 :echo flatten([1, [2, [3, 4]], 5])
2546< [1, 2, 3, 4, 5] >
2547 :echo flatten([1, [2, [3, 4]], 5], 1)
2548< [1, 2, [3, 4], 5]
2549
2550 Can also be used as a |method|: >
2551 mylist->flatten()
2552<
2553flattennew({list} [, {maxdepth}]) *flattennew()*
2554 Like |flatten()| but first make a copy of {list}.
2555
2556
2557float2nr({expr}) *float2nr()*
2558 Convert {expr} to a Number by omitting the part after the
2559 decimal point.
2560 {expr} must evaluate to a |Float| or a Number.
2561 When the value of {expr} is out of range for a |Number| the
2562 result is truncated to 0x7fffffff or -0x7fffffff (or when
2563 64-bit Number support is enabled, 0x7fffffffffffffff or
2564 -0x7fffffffffffffff). NaN results in -0x80000000 (or when
2565 64-bit Number support is enabled, -0x8000000000000000).
2566 Examples: >
2567 echo float2nr(3.95)
2568< 3 >
2569 echo float2nr(-23.45)
2570< -23 >
2571 echo float2nr(1.0e100)
2572< 2147483647 (or 9223372036854775807) >
2573 echo float2nr(-1.0e150)
2574< -2147483647 (or -9223372036854775807) >
2575 echo float2nr(1.0e-100)
2576< 0
2577
2578 Can also be used as a |method|: >
2579 Compute()->float2nr()
2580<
2581 {only available when compiled with the |+float| feature}
2582
2583
2584floor({expr}) *floor()*
2585 Return the largest integral value less than or equal to
2586 {expr} as a |Float| (round down).
2587 {expr} must evaluate to a |Float| or a |Number|.
2588 Examples: >
2589 echo floor(1.856)
2590< 1.0 >
2591 echo floor(-5.456)
2592< -6.0 >
2593 echo floor(4.0)
2594< 4.0
2595
2596 Can also be used as a |method|: >
2597 Compute()->floor()
2598<
2599 {only available when compiled with the |+float| feature}
2600
2601
2602fmod({expr1}, {expr2}) *fmod()*
2603 Return the remainder of {expr1} / {expr2}, even if the
2604 division is not representable. Returns {expr1} - i * {expr2}
2605 for some integer i such that if {expr2} is non-zero, the
2606 result has the same sign as {expr1} and magnitude less than
2607 the magnitude of {expr2}. If {expr2} is zero, the value
2608 returned is zero. The value returned is a |Float|.
2609 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
2610 Examples: >
2611 :echo fmod(12.33, 1.22)
2612< 0.13 >
2613 :echo fmod(-12.33, 1.22)
2614< -0.13
2615
2616 Can also be used as a |method|: >
2617 Compute()->fmod(1.22)
2618<
2619 {only available when compiled with |+float| feature}
2620
2621
2622fnameescape({string}) *fnameescape()*
2623 Escape {string} for use as file name command argument. All
2624 characters that have a special meaning, such as '%' and '|'
2625 are escaped with a backslash.
2626 For most systems the characters escaped are
2627 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash
2628 appears in a filename, it depends on the value of 'isfname'.
2629 A leading '+' and '>' is also escaped (special after |:edit|
2630 and |:write|). And a "-" by itself (special after |:cd|).
2631 Example: >
2632 :let fname = '+some str%nge|name'
2633 :exe "edit " . fnameescape(fname)
2634< results in executing: >
2635 edit \+some\ str\%nge\|name
2636<
2637 Can also be used as a |method|: >
2638 GetName()->fnameescape()
2639
2640fnamemodify({fname}, {mods}) *fnamemodify()*
2641 Modify file name {fname} according to {mods}. {mods} is a
2642 string of characters like it is used for file names on the
2643 command line. See |filename-modifiers|.
2644 Example: >
2645 :echo fnamemodify("main.c", ":p:h")
2646< results in: >
2647 /home/mool/vim/vim/src
2648< If {mods} is empty then {fname} is returned.
2649 Note: Environment variables don't work in {fname}, use
2650 |expand()| first then.
2651
2652 Can also be used as a |method|: >
2653 GetName()->fnamemodify(':p:h')
2654
2655foldclosed({lnum}) *foldclosed()*
2656 The result is a Number. If the line {lnum} is in a closed
2657 fold, the result is the number of the first line in that fold.
2658 If the line {lnum} is not in a closed fold, -1 is returned.
2659 {lnum} is used like with |getline()|. Thus "." is the current
2660 line, "'m" mark m, etc.
2661
2662 Can also be used as a |method|: >
2663 GetLnum()->foldclosed()
2664
2665foldclosedend({lnum}) *foldclosedend()*
2666 The result is a Number. If the line {lnum} is in a closed
2667 fold, the result is the number of the last line in that fold.
2668 If the line {lnum} is not in a closed fold, -1 is returned.
2669 {lnum} is used like with |getline()|. Thus "." is the current
2670 line, "'m" mark m, etc.
2671
2672 Can also be used as a |method|: >
2673 GetLnum()->foldclosedend()
2674
2675foldlevel({lnum}) *foldlevel()*
2676 The result is a Number, which is the foldlevel of line {lnum}
2677 in the current buffer. For nested folds the deepest level is
2678 returned. If there is no fold at line {lnum}, zero is
2679 returned. It doesn't matter if the folds are open or closed.
2680 When used while updating folds (from 'foldexpr') -1 is
2681 returned for lines where folds are still to be updated and the
2682 foldlevel is unknown. As a special case the level of the
2683 previous line is usually available.
2684 {lnum} is used like with |getline()|. Thus "." is the current
2685 line, "'m" mark m, etc.
2686
2687 Can also be used as a |method|: >
2688 GetLnum()->foldlevel()
2689<
2690 *foldtext()*
2691foldtext() Returns a String, to be displayed for a closed fold. This is
2692 the default function used for the 'foldtext' option and should
2693 only be called from evaluating 'foldtext'. It uses the
2694 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
2695 The returned string looks like this: >
2696 +-- 45 lines: abcdef
2697< The number of leading dashes depends on the foldlevel. The
2698 "45" is the number of lines in the fold. "abcdef" is the text
2699 in the first non-blank line of the fold. Leading white space,
2700 "//" or "/*" and the text from the 'foldmarker' and
2701 'commentstring' options is removed.
2702 When used to draw the actual foldtext, the rest of the line
2703 will be filled with the fold char from the 'fillchars'
2704 setting.
2705 {not available when compiled without the |+folding| feature}
2706
2707foldtextresult({lnum}) *foldtextresult()*
2708 Returns the text that is displayed for the closed fold at line
2709 {lnum}. Evaluates 'foldtext' in the appropriate context.
2710 When there is no closed fold at {lnum} an empty string is
2711 returned.
2712 {lnum} is used like with |getline()|. Thus "." is the current
2713 line, "'m" mark m, etc.
2714 Useful when exporting folded text, e.g., to HTML.
2715 {not available when compiled without the |+folding| feature}
2716
2717
2718 Can also be used as a |method|: >
2719 GetLnum()->foldtextresult()
2720<
2721 *foreground()*
2722foreground() Move the Vim window to the foreground. Useful when sent from
2723 a client to a Vim server. |remote_send()|
2724 On Win32 systems this might not work, the OS does not always
2725 allow a window to bring itself to the foreground. Use
2726 |remote_foreground()| instead.
2727 {only in the Win32, Athena, Motif and GTK GUI versions and the
2728 Win32 console version}
2729
2730fullcommand({name}) *fullcommand()*
2731 Get the full command name from a short abbreviated command
2732 name; see |20.2| for details on command abbreviations.
2733
2734 The string argument {name} may start with a `:` and can
2735 include a [range], these are skipped and not returned.
2736 Returns an empty string if a command doesn't exist or if it's
2737 ambiguous (for user-defined commands).
2738
2739 For example `fullcommand('s')`, `fullcommand('sub')`,
2740 `fullcommand(':%substitute')` all return "substitute".
2741
2742 Can also be used as a |method|: >
2743 GetName()->fullcommand()
2744<
2745 *funcref()*
2746funcref({name} [, {arglist}] [, {dict}])
2747 Just like |function()|, but the returned Funcref will lookup
2748 the function by reference, not by name. This matters when the
2749 function {name} is redefined later.
2750
2751 Unlike |function()|, {name} must be an existing user function.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00002752 It only works for an autoloaded function if it has already
2753 been loaded (to avoid mistakenly loading the autoload script
2754 when only intending to use the function name, use |function()|
2755 instead). {name} cannot be a builtin function.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002756
2757 Can also be used as a |method|: >
2758 GetFuncname()->funcref([arg])
2759<
2760 *function()* *partial* *E700* *E922* *E923*
2761function({name} [, {arglist}] [, {dict}])
2762 Return a |Funcref| variable that refers to function {name}.
2763 {name} can be the name of a user defined function or an
2764 internal function.
2765
2766 {name} can also be a Funcref or a partial. When it is a
2767 partial the dict stored in it will be used and the {dict}
2768 argument is not allowed. E.g.: >
2769 let FuncWithArg = function(dict.Func, [arg])
2770 let Broken = function(dict.Func, [arg], dict)
2771<
2772 When using the Funcref the function will be found by {name},
2773 also when it was redefined later. Use |funcref()| to keep the
2774 same function.
2775
2776 When {arglist} or {dict} is present this creates a partial.
2777 That means the argument list and/or the dictionary is stored in
2778 the Funcref and will be used when the Funcref is called.
2779
2780 The arguments are passed to the function in front of other
2781 arguments, but after any argument from |method|. Example: >
2782 func Callback(arg1, arg2, name)
2783 ...
2784 let Partial = function('Callback', ['one', 'two'])
2785 ...
2786 call Partial('name')
2787< Invokes the function as with: >
2788 call Callback('one', 'two', 'name')
2789
2790< With a |method|: >
2791 func Callback(one, two, three)
2792 ...
2793 let Partial = function('Callback', ['two'])
2794 ...
2795 eval 'one'->Partial('three')
2796< Invokes the function as with: >
2797 call Callback('one', 'two', 'three')
2798
2799< The function() call can be nested to add more arguments to the
2800 Funcref. The extra arguments are appended to the list of
2801 arguments. Example: >
2802 func Callback(arg1, arg2, name)
2803 ...
2804 let Func = function('Callback', ['one'])
2805 let Func2 = function(Func, ['two'])
2806 ...
2807 call Func2('name')
2808< Invokes the function as with: >
2809 call Callback('one', 'two', 'name')
2810
2811< The Dictionary is only useful when calling a "dict" function.
2812 In that case the {dict} is passed in as "self". Example: >
2813 function Callback() dict
2814 echo "called for " . self.name
2815 endfunction
2816 ...
2817 let context = {"name": "example"}
2818 let Func = function('Callback', context)
2819 ...
2820 call Func() " will echo: called for example
2821< The use of function() is not needed when there are no extra
2822 arguments, these two are equivalent: >
2823 let Func = function('Callback', context)
2824 let Func = context.Callback
2825
2826< The argument list and the Dictionary can be combined: >
2827 function Callback(arg1, count) dict
2828 ...
2829 let context = {"name": "example"}
2830 let Func = function('Callback', ['one'], context)
2831 ...
2832 call Func(500)
2833< Invokes the function as with: >
2834 call context.Callback('one', 500)
2835<
2836 Can also be used as a |method|: >
2837 GetFuncname()->function([arg])
2838
2839
2840garbagecollect([{atexit}]) *garbagecollect()*
2841 Cleanup unused |Lists|, |Dictionaries|, |Channels| and |Jobs|
2842 that have circular references.
2843
2844 There is hardly ever a need to invoke this function, as it is
2845 automatically done when Vim runs out of memory or is waiting
2846 for the user to press a key after 'updatetime'. Items without
2847 circular references are always freed when they become unused.
2848 This is useful if you have deleted a very big |List| and/or
2849 |Dictionary| with circular references in a script that runs
2850 for a long time.
2851
2852 When the optional {atexit} argument is one, garbage
2853 collection will also be done when exiting Vim, if it wasn't
2854 done before. This is useful when checking for memory leaks.
2855
2856 The garbage collection is not done immediately but only when
2857 it's safe to perform. This is when waiting for the user to
2858 type a character. To force garbage collection immediately use
2859 |test_garbagecollect_now()|.
2860
2861get({list}, {idx} [, {default}]) *get()*
2862 Get item {idx} from |List| {list}. When this item is not
2863 available return {default}. Return zero when {default} is
2864 omitted.
2865 Preferably used as a |method|: >
2866 mylist->get(idx)
2867get({blob}, {idx} [, {default}])
2868 Get byte {idx} from |Blob| {blob}. When this byte is not
2869 available return {default}. Return -1 when {default} is
2870 omitted.
2871 Preferably used as a |method|: >
2872 myblob->get(idx)
2873get({dict}, {key} [, {default}])
2874 Get item with key {key} from |Dictionary| {dict}. When this
2875 item is not available return {default}. Return zero when
2876 {default} is omitted. Useful example: >
2877 let val = get(g:, 'var_name', 'default')
2878< This gets the value of g:var_name if it exists, and uses
2879 'default' when it does not exist.
2880 Preferably used as a |method|: >
2881 mydict->get(key)
2882get({func}, {what})
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00002883 Get item {what} from Funcref {func}. Possible values for
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002884 {what} are:
2885 "name" The function name
2886 "func" The function
2887 "dict" The dictionary
2888 "args" The list with arguments
2889 Preferably used as a |method|: >
2890 myfunc->get(what)
2891<
2892 *getbufinfo()*
2893getbufinfo([{buf}])
2894getbufinfo([{dict}])
2895 Get information about buffers as a List of Dictionaries.
2896
2897 Without an argument information about all the buffers is
2898 returned.
2899
2900 When the argument is a |Dictionary| only the buffers matching
2901 the specified criteria are returned. The following keys can
2902 be specified in {dict}:
2903 buflisted include only listed buffers.
2904 bufloaded include only loaded buffers.
2905 bufmodified include only modified buffers.
2906
2907 Otherwise, {buf} specifies a particular buffer to return
2908 information for. For the use of {buf}, see |bufname()|
2909 above. If the buffer is found the returned List has one item.
2910 Otherwise the result is an empty list.
2911
2912 Each returned List item is a dictionary with the following
2913 entries:
2914 bufnr Buffer number.
2915 changed TRUE if the buffer is modified.
2916 changedtick Number of changes made to the buffer.
2917 hidden TRUE if the buffer is hidden.
2918 lastused Timestamp in seconds, like
2919 |localtime()|, when the buffer was
2920 last used.
2921 {only with the |+viminfo| feature}
2922 listed TRUE if the buffer is listed.
2923 lnum Line number used for the buffer when
2924 opened in the current window.
2925 Only valid if the buffer has been
2926 displayed in the window in the past.
2927 If you want the line number of the
2928 last known cursor position in a given
2929 window, use |line()|: >
2930 :echo line('.', {winid})
2931<
2932 linecount Number of lines in the buffer (only
2933 valid when loaded)
2934 loaded TRUE if the buffer is loaded.
2935 name Full path to the file in the buffer.
2936 signs List of signs placed in the buffer.
2937 Each list item is a dictionary with
2938 the following fields:
2939 id sign identifier
2940 lnum line number
2941 name sign name
2942 variables A reference to the dictionary with
2943 buffer-local variables.
2944 windows List of |window-ID|s that display this
2945 buffer
2946 popups List of popup |window-ID|s that
2947 display this buffer
2948
2949 Examples: >
2950 for buf in getbufinfo()
2951 echo buf.name
2952 endfor
2953 for buf in getbufinfo({'buflisted':1})
2954 if buf.changed
2955 ....
2956 endif
2957 endfor
2958<
2959 To get buffer-local options use: >
2960 getbufvar({bufnr}, '&option_name')
2961<
2962 Can also be used as a |method|: >
2963 GetBufnr()->getbufinfo()
2964<
2965
2966 *getbufline()*
2967getbufline({buf}, {lnum} [, {end}])
2968 Return a |List| with the lines starting from {lnum} to {end}
2969 (inclusive) in the buffer {buf}. If {end} is omitted, a
2970 |List| with only the line {lnum} is returned.
2971
2972 For the use of {buf}, see |bufname()| above.
2973
2974 For {lnum} and {end} "$" can be used for the last line of the
2975 buffer. Otherwise a number must be used.
2976
2977 When {lnum} is smaller than 1 or bigger than the number of
2978 lines in the buffer, an empty |List| is returned.
2979
2980 When {end} is greater than the number of lines in the buffer,
2981 it is treated as {end} is set to the number of lines in the
2982 buffer. When {end} is before {lnum} an empty |List| is
2983 returned.
2984
2985 This function works only for loaded buffers. For unloaded and
2986 non-existing buffers, an empty |List| is returned.
2987
2988 Example: >
2989 :let lines = getbufline(bufnr("myfile"), 1, "$")
2990
2991< Can also be used as a |method|: >
2992 GetBufnr()->getbufline(lnum)
2993
2994getbufvar({buf}, {varname} [, {def}]) *getbufvar()*
2995 The result is the value of option or local buffer variable
2996 {varname} in buffer {buf}. Note that the name without "b:"
2997 must be used.
2998 The {varname} argument is a string.
2999 When {varname} is empty returns a |Dictionary| with all the
3000 buffer-local variables.
3001 When {varname} is equal to "&" returns a |Dictionary| with all
3002 the buffer-local options.
3003 Otherwise, when {varname} starts with "&" returns the value of
3004 a buffer-local option.
3005 This also works for a global or buffer-local option, but it
3006 doesn't work for a global variable, window-local variable or
3007 window-local option.
3008 For the use of {buf}, see |bufname()| above.
3009 When the buffer or variable doesn't exist {def} or an empty
3010 string is returned, there is no error message.
3011 Examples: >
3012 :let bufmodified = getbufvar(1, "&mod")
3013 :echo "todo myvar = " . getbufvar("todo", "myvar")
3014
3015< Can also be used as a |method|: >
3016 GetBufnr()->getbufvar(varname)
3017<
3018getchangelist([{buf}]) *getchangelist()*
3019 Returns the |changelist| for the buffer {buf}. For the use
3020 of {buf}, see |bufname()| above. If buffer {buf} doesn't
3021 exist, an empty list is returned.
3022
3023 The returned list contains two entries: a list with the change
3024 locations and the current position in the list. Each
3025 entry in the change list is a dictionary with the following
3026 entries:
3027 col column number
3028 coladd column offset for 'virtualedit'
3029 lnum line number
3030 If buffer {buf} is the current buffer, then the current
3031 position refers to the position in the list. For other
3032 buffers, it is set to the length of the list.
3033
3034 Can also be used as a |method|: >
3035 GetBufnr()->getchangelist()
3036
3037getchar([expr]) *getchar()*
3038 Get a single character from the user or input stream.
3039 If [expr] is omitted, wait until a character is available.
3040 If [expr] is 0, only get a character when one is available.
3041 Return zero otherwise.
3042 If [expr] is 1, only check if a character is available, it is
3043 not consumed. Return zero if no character available.
3044 If you prefer always getting a string use |getcharstr()|.
3045
3046 Without [expr] and when [expr] is 0 a whole character or
3047 special key is returned. If it is a single character, the
3048 result is a number. Use nr2char() to convert it to a String.
3049 Otherwise a String is returned with the encoded character.
3050 For a special key it's a String with a sequence of bytes
3051 starting with 0x80 (decimal: 128). This is the same value as
3052 the String "\<Key>", e.g., "\<Left>". The returned value is
3053 also a String when a modifier (shift, control, alt) was used
3054 that is not included in the character.
3055
3056 When [expr] is 0 and Esc is typed, there will be a short delay
3057 while Vim waits to see if this is the start of an escape
3058 sequence.
3059
3060 When [expr] is 1 only the first byte is returned. For a
3061 one-byte character it is the character itself as a number.
3062 Use nr2char() to convert it to a String.
3063
3064 Use getcharmod() to obtain any additional modifiers.
3065
3066 When the user clicks a mouse button, the mouse event will be
3067 returned. The position can then be found in |v:mouse_col|,
3068 |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|.
3069 |getmousepos()| can also be used. Mouse move events will be
3070 ignored.
3071 This example positions the mouse as it would normally happen: >
3072 let c = getchar()
3073 if c == "\<LeftMouse>" && v:mouse_win > 0
3074 exe v:mouse_win . "wincmd w"
3075 exe v:mouse_lnum
3076 exe "normal " . v:mouse_col . "|"
3077 endif
3078<
3079 When using bracketed paste only the first character is
3080 returned, the rest of the pasted text is dropped.
3081 |xterm-bracketed-paste|.
3082
3083 There is no prompt, you will somehow have to make clear to the
3084 user that a character has to be typed. The screen is not
3085 redrawn, e.g. when resizing the window. When using a popup
3086 window it should work better with a |popup-filter|.
3087
3088 There is no mapping for the character.
3089 Key codes are replaced, thus when the user presses the <Del>
3090 key you get the code for the <Del> key, not the raw character
3091 sequence. Examples: >
3092 getchar() == "\<Del>"
3093 getchar() == "\<S-Left>"
3094< This example redefines "f" to ignore case: >
3095 :nmap f :call FindChar()<CR>
3096 :function FindChar()
3097 : let c = nr2char(getchar())
3098 : while col('.') < col('$') - 1
3099 : normal l
3100 : if getline('.')[col('.') - 1] ==? c
3101 : break
3102 : endif
3103 : endwhile
3104 :endfunction
3105<
3106 You may also receive synthetic characters, such as
3107 |<CursorHold>|. Often you will want to ignore this and get
3108 another character: >
3109 :function GetKey()
3110 : let c = getchar()
3111 : while c == "\<CursorHold>"
3112 : let c = getchar()
3113 : endwhile
3114 : return c
3115 :endfunction
3116
3117getcharmod() *getcharmod()*
3118 The result is a Number which is the state of the modifiers for
3119 the last obtained character with getchar() or in another way.
3120 These values are added together:
3121 2 shift
3122 4 control
3123 8 alt (meta)
3124 16 meta (when it's different from ALT)
3125 32 mouse double click
3126 64 mouse triple click
3127 96 mouse quadruple click (== 32 + 64)
3128 128 command (Macintosh only)
3129 Only the modifiers that have not been included in the
3130 character itself are obtained. Thus Shift-a results in "A"
3131 without a modifier.
3132
3133 *getcharpos()*
3134getcharpos({expr})
3135 Get the position for String {expr}. Same as |getpos()| but the
3136 column number in the returned List is a character index
3137 instead of a byte index.
naohiro ono56200ee2022-01-01 14:59:44 +00003138 If |getpos()| returns a very large column number, equal to
3139 |v:maxcol|, then getcharpos() will return the character index
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003140 of the last character.
3141
3142 Example:
3143 With the cursor on '세' in line 5 with text "여보세요": >
3144 getcharpos('.') returns [0, 5, 3, 0]
3145 getpos('.') returns [0, 5, 7, 0]
3146<
3147 Can also be used as a |method|: >
3148 GetMark()->getcharpos()
3149
3150getcharsearch() *getcharsearch()*
3151 Return the current character search information as a {dict}
3152 with the following entries:
3153
3154 char character previously used for a character
3155 search (|t|, |f|, |T|, or |F|); empty string
3156 if no character search has been performed
3157 forward direction of character search; 1 for forward,
3158 0 for backward
3159 until type of character search; 1 for a |t| or |T|
3160 character search, 0 for an |f| or |F|
3161 character search
3162
3163 This can be useful to always have |;| and |,| search
3164 forward/backward regardless of the direction of the previous
3165 character search: >
3166 :nnoremap <expr> ; getcharsearch().forward ? ';' : ','
3167 :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
3168< Also see |setcharsearch()|.
3169
3170
3171getcharstr([expr]) *getcharstr()*
3172 Get a single character from the user or input stream as a
3173 string.
3174 If [expr] is omitted, wait until a character is available.
3175 If [expr] is 0 or false, only get a character when one is
3176 available. Return an empty string otherwise.
3177 If [expr] is 1 or true, only check if a character is
3178 available, it is not consumed. Return an empty string
3179 if no character is available.
3180 Otherwise this works like |getchar()|, except that a number
3181 result is converted to a string.
3182
3183
3184getcmdline() *getcmdline()*
3185 Return the current command-line. Only works when the command
3186 line is being edited, thus requires use of |c_CTRL-\_e| or
3187 |c_CTRL-R_=|.
3188 Example: >
3189 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
3190< Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
3191 Returns an empty string when entering a password or using
3192 |inputsecret()|.
3193
3194getcmdpos() *getcmdpos()*
3195 Return the position of the cursor in the command line as a
3196 byte count. The first column is 1.
3197 Only works when editing the command line, thus requires use of
3198 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
3199 Returns 0 otherwise.
3200 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
3201
3202getcmdtype() *getcmdtype()*
3203 Return the current command-line type. Possible return values
3204 are:
3205 : normal Ex command
3206 > debug mode command |debug-mode|
3207 / forward search command
3208 ? backward search command
3209 @ |input()| command
3210 - |:insert| or |:append| command
3211 = |i_CTRL-R_=|
3212 Only works when editing the command line, thus requires use of
3213 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
3214 Returns an empty string otherwise.
3215 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
3216
3217getcmdwintype() *getcmdwintype()*
3218 Return the current |command-line-window| type. Possible return
3219 values are the same as |getcmdtype()|. Returns an empty string
3220 when not in the command-line window.
3221
3222getcompletion({pat}, {type} [, {filtered}]) *getcompletion()*
3223 Return a list of command-line completion matches. The String
3224 {type} argument specifies what for. The following completion
3225 types are supported:
3226
3227 arglist file names in argument list
3228 augroup autocmd groups
3229 buffer buffer names
3230 behave :behave suboptions
3231 color color schemes
3232 command Ex command
3233 cmdline |cmdline-completion| result
3234 compiler compilers
3235 cscope |:cscope| suboptions
3236 diff_buffer |:diffget| and |:diffput| completion
3237 dir directory names
3238 environment environment variable names
3239 event autocommand events
3240 expression Vim expression
3241 file file and directory names
3242 file_in_path file and directory names in |'path'|
3243 filetype filetype names |'filetype'|
3244 function function name
3245 help help subjects
3246 highlight highlight groups
3247 history :history suboptions
3248 locale locale names (as output of locale -a)
3249 mapclear buffer argument
3250 mapping mapping name
3251 menu menus
3252 messages |:messages| suboptions
3253 option options
3254 packadd optional package |pack-add| names
3255 shellcmd Shell command
3256 sign |:sign| suboptions
3257 syntax syntax file names |'syntax'|
3258 syntime |:syntime| suboptions
3259 tag tags
3260 tag_listfiles tags, file names
3261 user user names
3262 var user variables
3263
3264 If {pat} is an empty string, then all the matches are
3265 returned. Otherwise only items matching {pat} are returned.
3266 See |wildcards| for the use of special characters in {pat}.
3267
3268 If the optional {filtered} flag is set to 1, then 'wildignore'
3269 is applied to filter the results. Otherwise all the matches
3270 are returned. The 'wildignorecase' option always applies.
3271
3272 If {type} is "cmdline", then the |cmdline-completion| result is
3273 returned. For example, to complete the possible values after
3274 a ":call" command: >
3275 echo getcompletion('call ', 'cmdline')
3276<
3277 If there are no matches, an empty list is returned. An
3278 invalid value for {type} produces an error.
3279
3280 Can also be used as a |method|: >
3281 GetPattern()->getcompletion('color')
3282<
3283 *getcurpos()*
3284getcurpos([{winid}])
3285 Get the position of the cursor. This is like getpos('.'), but
3286 includes an extra "curswant" item in the list:
3287 [0, lnum, col, off, curswant] ~
3288 The "curswant" number is the preferred column when moving the
naohiro ono56200ee2022-01-01 14:59:44 +00003289 cursor vertically. After |$| command it will be a very large
3290 number equal to |v:maxcol|. Also see |getcursorcharpos()| and
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003291 |getpos()|.
3292 The first "bufnum" item is always zero. The byte position of
3293 the cursor is returned in 'col'. To get the character
3294 position, use |getcursorcharpos()|.
3295
3296 The optional {winid} argument can specify the window. It can
3297 be the window number or the |window-ID|. The last known
3298 cursor position is returned, this may be invalid for the
3299 current value of the buffer if it is not the current window.
3300 If {winid} is invalid a list with zeroes is returned.
3301
3302 This can be used to save and restore the cursor position: >
3303 let save_cursor = getcurpos()
3304 MoveTheCursorAround
3305 call setpos('.', save_cursor)
3306< Note that this only works within the window. See
3307 |winrestview()| for restoring more state.
3308
3309 Can also be used as a |method|: >
3310 GetWinid()->getcurpos()
3311<
3312 *getcursorcharpos()*
3313getcursorcharpos([{winid}])
3314 Same as |getcurpos()| but the column number in the returned
3315 List is a character index instead of a byte index.
3316
3317 Example:
3318 With the cursor on '보' in line 3 with text "여보세요": >
3319 getcursorcharpos() returns [0, 3, 2, 0, 3]
3320 getcurpos() returns [0, 3, 4, 0, 3]
3321<
3322 Can also be used as a |method|: >
3323 GetWinid()->getcursorcharpos()
3324
3325< *getcwd()*
3326getcwd([{winnr} [, {tabnr}]])
3327 The result is a String, which is the name of the current
3328 working directory. 'autochdir' is ignored.
3329
3330 With {winnr} return the local current directory of this window
3331 in the current tab page. {winnr} can be the window number or
3332 the |window-ID|.
3333 If {winnr} is -1 return the name of the global working
3334 directory. See also |haslocaldir()|.
3335
3336 With {winnr} and {tabnr} return the local current directory of
3337 the window in the specified tab page. If {winnr} is -1 return
3338 the working directory of the tabpage.
3339 If {winnr} is zero use the current window, if {tabnr} is zero
3340 use the current tabpage.
3341 Without any arguments, return the actual working directory of
3342 the current window.
3343 Return an empty string if the arguments are invalid.
3344
3345 Examples: >
3346 " Get the working directory of the current window
3347 :echo getcwd()
3348 :echo getcwd(0)
3349 :echo getcwd(0, 0)
3350 " Get the working directory of window 3 in tabpage 2
3351 :echo getcwd(3, 2)
3352 " Get the global working directory
3353 :echo getcwd(-1)
3354 " Get the working directory of tabpage 3
3355 :echo getcwd(-1, 3)
3356 " Get the working directory of current tabpage
3357 :echo getcwd(-1, 0)
3358
3359< Can also be used as a |method|: >
3360 GetWinnr()->getcwd()
3361
3362getenv({name}) *getenv()*
3363 Return the value of environment variable {name}. The {name}
3364 argument is a string, without a leading '$'. Example: >
3365 myHome = getenv('HOME')
3366
3367< When the variable does not exist |v:null| is returned. That
3368 is different from a variable set to an empty string, although
3369 some systems interpret the empty value as the variable being
3370 deleted. See also |expr-env|.
3371
3372 Can also be used as a |method|: >
3373 GetVarname()->getenv()
3374
3375getfontname([{name}]) *getfontname()*
3376 Without an argument returns the name of the normal font being
3377 used. Like what is used for the Normal highlight group
3378 |hl-Normal|.
3379 With an argument a check is done whether String {name} is a
3380 valid font name. If not then an empty string is returned.
3381 Otherwise the actual font name is returned, or {name} if the
3382 GUI does not support obtaining the real name.
3383 Only works when the GUI is running, thus not in your vimrc or
3384 gvimrc file. Use the |GUIEnter| autocommand to use this
3385 function just after the GUI has started.
3386 Note that the GTK GUI accepts any font name, thus checking for
3387 a valid name does not work.
3388
3389getfperm({fname}) *getfperm()*
3390 The result is a String, which is the read, write, and execute
3391 permissions of the given file {fname}.
3392 If {fname} does not exist or its directory cannot be read, an
3393 empty string is returned.
3394 The result is of the form "rwxrwxrwx", where each group of
3395 "rwx" flags represent, in turn, the permissions of the owner
3396 of the file, the group the file belongs to, and other users.
3397 If a user does not have a given permission the flag for this
3398 is replaced with the string "-". Examples: >
3399 :echo getfperm("/etc/passwd")
3400 :echo getfperm(expand("~/.vimrc"))
3401< This will hopefully (from a security point of view) display
3402 the string "rw-r--r--" or even "rw-------".
3403
3404 Can also be used as a |method|: >
3405 GetFilename()->getfperm()
3406<
3407 For setting permissions use |setfperm()|.
3408
3409getfsize({fname}) *getfsize()*
3410 The result is a Number, which is the size in bytes of the
3411 given file {fname}.
3412 If {fname} is a directory, 0 is returned.
3413 If the file {fname} can't be found, -1 is returned.
3414 If the size of {fname} is too big to fit in a Number then -2
3415 is returned.
3416
3417 Can also be used as a |method|: >
3418 GetFilename()->getfsize()
3419
3420getftime({fname}) *getftime()*
3421 The result is a Number, which is the last modification time of
3422 the given file {fname}. The value is measured as seconds
3423 since 1st Jan 1970, and may be passed to strftime(). See also
3424 |localtime()| and |strftime()|.
3425 If the file {fname} can't be found -1 is returned.
3426
3427 Can also be used as a |method|: >
3428 GetFilename()->getftime()
3429
3430getftype({fname}) *getftype()*
3431 The result is a String, which is a description of the kind of
3432 file of the given file {fname}.
3433 If {fname} does not exist an empty string is returned.
3434 Here is a table over different kinds of files and their
3435 results:
3436 Normal file "file"
3437 Directory "dir"
3438 Symbolic link "link"
3439 Block device "bdev"
3440 Character device "cdev"
3441 Socket "socket"
3442 FIFO "fifo"
3443 All other "other"
3444 Example: >
3445 getftype("/home")
3446< Note that a type such as "link" will only be returned on
3447 systems that support it. On some systems only "dir" and
3448 "file" are returned. On MS-Windows a symbolic link to a
3449 directory returns "dir" instead of "link".
3450
3451 Can also be used as a |method|: >
3452 GetFilename()->getftype()
3453
3454getimstatus() *getimstatus()*
3455 The result is a Number, which is |TRUE| when the IME status is
3456 active.
3457 See 'imstatusfunc'.
3458
3459getjumplist([{winnr} [, {tabnr}]]) *getjumplist()*
3460 Returns the |jumplist| for the specified window.
3461
3462 Without arguments use the current window.
3463 With {winnr} only use this window in the current tab page.
3464 {winnr} can also be a |window-ID|.
3465 With {winnr} and {tabnr} use the window in the specified tab
3466 page.
3467
3468 The returned list contains two entries: a list with the jump
3469 locations and the last used jump position number in the list.
3470 Each entry in the jump location list is a dictionary with
3471 the following entries:
3472 bufnr buffer number
3473 col column number
3474 coladd column offset for 'virtualedit'
3475 filename filename if available
3476 lnum line number
3477
3478 Can also be used as a |method|: >
3479 GetWinnr()->getjumplist()
3480
3481< *getline()*
3482getline({lnum} [, {end}])
3483 Without {end} the result is a String, which is line {lnum}
3484 from the current buffer. Example: >
3485 getline(1)
3486< When {lnum} is a String that doesn't start with a
3487 digit, |line()| is called to translate the String into a Number.
3488 To get the line under the cursor: >
3489 getline(".")
3490< When {lnum} is a number smaller than 1 or bigger than the
3491 number of lines in the buffer, an empty string is returned.
3492
3493 When {end} is given the result is a |List| where each item is
3494 a line from the current buffer in the range {lnum} to {end},
3495 including line {end}.
3496 {end} is used in the same way as {lnum}.
3497 Non-existing lines are silently omitted.
3498 When {end} is before {lnum} an empty |List| is returned.
3499 Example: >
3500 :let start = line('.')
3501 :let end = search("^$") - 1
3502 :let lines = getline(start, end)
3503
3504< Can also be used as a |method|: >
3505 ComputeLnum()->getline()
3506
3507< To get lines from another buffer see |getbufline()|
3508
3509getloclist({nr} [, {what}]) *getloclist()*
3510 Returns a |List| with all the entries in the location list for
3511 window {nr}. {nr} can be the window number or the |window-ID|.
3512 When {nr} is zero the current window is used.
3513
3514 For a location list window, the displayed location list is
3515 returned. For an invalid window number {nr}, an empty list is
3516 returned. Otherwise, same as |getqflist()|.
3517
3518 If the optional {what} dictionary argument is supplied, then
3519 returns the items listed in {what} as a dictionary. Refer to
3520 |getqflist()| for the supported items in {what}.
3521
3522 In addition to the items supported by |getqflist()| in {what},
3523 the following item is supported by |getloclist()|:
3524
3525 filewinid id of the window used to display files
3526 from the location list. This field is
3527 applicable only when called from a
3528 location list window. See
3529 |location-list-file-window| for more
3530 details.
3531
3532 Returns a |Dictionary| with default values if there is no
3533 location list for the window {nr}.
3534 Returns an empty Dictionary if window {nr} does not exist.
3535
3536 Examples (See also |getqflist-examples|): >
3537 :echo getloclist(3, {'all': 0})
3538 :echo getloclist(5, {'filewinid': 0})
3539
3540
3541getmarklist([{buf}]) *getmarklist()*
3542 Without the {buf} argument returns a |List| with information
3543 about all the global marks. |mark|
3544
3545 If the optional {buf} argument is specified, returns the
3546 local marks defined in buffer {buf}. For the use of {buf},
3547 see |bufname()|.
3548
3549 Each item in the returned List is a |Dict| with the following:
3550 mark name of the mark prefixed by "'"
3551 pos a |List| with the position of the mark:
3552 [bufnum, lnum, col, off]
3553 Refer to |getpos()| for more information.
3554 file file name
3555
3556 Refer to |getpos()| for getting information about a specific
3557 mark.
3558
3559 Can also be used as a |method|: >
3560 GetBufnr()->getmarklist()
3561
3562getmatches([{win}]) *getmatches()*
3563 Returns a |List| with all matches previously defined for the
3564 current window by |matchadd()| and the |:match| commands.
3565 |getmatches()| is useful in combination with |setmatches()|,
3566 as |setmatches()| can restore a list of matches saved by
3567 |getmatches()|.
3568 If {win} is specified, use the window with this number or
3569 window ID instead of the current window.
3570 Example: >
3571 :echo getmatches()
3572< [{'group': 'MyGroup1', 'pattern': 'TODO',
3573 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
3574 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
3575 :let m = getmatches()
3576 :call clearmatches()
3577 :echo getmatches()
3578< [] >
3579 :call setmatches(m)
3580 :echo getmatches()
3581< [{'group': 'MyGroup1', 'pattern': 'TODO',
3582 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
3583 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
3584 :unlet m
3585<
3586getmousepos() *getmousepos()*
3587 Returns a |Dictionary| with the last known position of the
3588 mouse. This can be used in a mapping for a mouse click or in
3589 a filter of a popup window. The items are:
3590 screenrow screen row
3591 screencol screen column
3592 winid Window ID of the click
3593 winrow row inside "winid"
3594 wincol column inside "winid"
3595 line text line inside "winid"
3596 column text column inside "winid"
3597 All numbers are 1-based.
3598
3599 If not over a window, e.g. when in the command line, then only
3600 "screenrow" and "screencol" are valid, the others are zero.
3601
3602 When on the status line below a window or the vertical
3603 separator right of a window, the "line" and "column" values
3604 are zero.
3605
3606 When the position is after the text then "column" is the
3607 length of the text in bytes plus one.
3608
3609 If the mouse is over a popup window then that window is used.
3610
3611 When using |getchar()| the Vim variables |v:mouse_lnum|,
3612 |v:mouse_col| and |v:mouse_winid| also provide these values.
3613
3614 *getpid()*
3615getpid() Return a Number which is the process ID of the Vim process.
3616 On Unix and MS-Windows this is a unique number, until Vim
3617 exits.
3618
3619 *getpos()*
3620getpos({expr}) Get the position for String {expr}. For possible values of
3621 {expr} see |line()|. For getting the cursor position see
3622 |getcurpos()|.
3623 The result is a |List| with four numbers:
3624 [bufnum, lnum, col, off]
3625 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
3626 is the buffer number of the mark.
3627 "lnum" and "col" are the position in the buffer. The first
3628 column is 1.
3629 The "off" number is zero, unless 'virtualedit' is used. Then
3630 it is the offset in screen columns from the start of the
3631 character. E.g., a position within a <Tab> or after the last
3632 character.
3633 Note that for '< and '> Visual mode matters: when it is "V"
3634 (visual line mode) the column of '< is zero and the column of
naohiro ono56200ee2022-01-01 14:59:44 +00003635 '> is a large number equal to |v:maxcol|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003636 The column number in the returned List is the byte position
3637 within the line. To get the character position in the line,
3638 use |getcharpos()|.
naohiro ono56200ee2022-01-01 14:59:44 +00003639 A very large column number equal to |v:maxcol| can be returned,
3640 in which case it means "after the end of the line".
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003641 This can be used to save and restore the position of a mark: >
3642 let save_a_mark = getpos("'a")
3643 ...
3644 call setpos("'a", save_a_mark)
3645< Also see |getcharpos()|, |getcurpos()| and |setpos()|.
3646
3647 Can also be used as a |method|: >
3648 GetMark()->getpos()
3649
3650getqflist([{what}]) *getqflist()*
3651 Returns a |List| with all the current quickfix errors. Each
3652 list item is a dictionary with these entries:
3653 bufnr number of buffer that has the file name, use
3654 bufname() to get the name
3655 module module name
3656 lnum line number in the buffer (first line is 1)
3657 end_lnum
3658 end of line number if the item is multiline
3659 col column number (first column is 1)
3660 end_col end of column number if the item has range
3661 vcol |TRUE|: "col" is visual column
3662 |FALSE|: "col" is byte index
3663 nr error number
3664 pattern search pattern used to locate the error
3665 text description of the error
3666 type type of the error, 'E', '1', etc.
3667 valid |TRUE|: recognized error message
3668
3669 When there is no error list or it's empty, an empty list is
3670 returned. Quickfix list entries with a non-existing buffer
3671 number are returned with "bufnr" set to zero (Note: some
3672 functions accept buffer number zero for the alternate buffer,
3673 you may need to explicitly check for zero).
3674
3675 Useful application: Find pattern matches in multiple files and
3676 do something with them: >
3677 :vimgrep /theword/jg *.c
3678 :for d in getqflist()
3679 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
3680 :endfor
3681<
3682 If the optional {what} dictionary argument is supplied, then
3683 returns only the items listed in {what} as a dictionary. The
3684 following string items are supported in {what}:
3685 changedtick get the total number of changes made
3686 to the list |quickfix-changedtick|
3687 context get the |quickfix-context|
3688 efm errorformat to use when parsing "lines". If
3689 not present, then the 'errorformat' option
3690 value is used.
3691 id get information for the quickfix list with
3692 |quickfix-ID|; zero means the id for the
3693 current list or the list specified by "nr"
3694 idx get information for the quickfix entry at this
3695 index in the list specified by 'id' or 'nr'.
3696 If set to zero, then uses the current entry.
3697 See |quickfix-index|
3698 items quickfix list entries
3699 lines parse a list of lines using 'efm' and return
3700 the resulting entries. Only a |List| type is
3701 accepted. The current quickfix list is not
3702 modified. See |quickfix-parse|.
3703 nr get information for this quickfix list; zero
3704 means the current quickfix list and "$" means
3705 the last quickfix list
3706 qfbufnr number of the buffer displayed in the quickfix
3707 window. Returns 0 if the quickfix buffer is
3708 not present. See |quickfix-buffer|.
3709 size number of entries in the quickfix list
3710 title get the list title |quickfix-title|
3711 winid get the quickfix |window-ID|
3712 all all of the above quickfix properties
3713 Non-string items in {what} are ignored. To get the value of a
3714 particular item, set it to zero.
3715 If "nr" is not present then the current quickfix list is used.
3716 If both "nr" and a non-zero "id" are specified, then the list
3717 specified by "id" is used.
3718 To get the number of lists in the quickfix stack, set "nr" to
3719 "$" in {what}. The "nr" value in the returned dictionary
3720 contains the quickfix stack size.
3721 When "lines" is specified, all the other items except "efm"
3722 are ignored. The returned dictionary contains the entry
3723 "items" with the list of entries.
3724
3725 The returned dictionary contains the following entries:
3726 changedtick total number of changes made to the
3727 list |quickfix-changedtick|
3728 context quickfix list context. See |quickfix-context|
3729 If not present, set to "".
3730 id quickfix list ID |quickfix-ID|. If not
3731 present, set to 0.
3732 idx index of the quickfix entry in the list. If not
3733 present, set to 0.
3734 items quickfix list entries. If not present, set to
3735 an empty list.
3736 nr quickfix list number. If not present, set to 0
3737 qfbufnr number of the buffer displayed in the quickfix
3738 window. If not present, set to 0.
3739 size number of entries in the quickfix list. If not
3740 present, set to 0.
3741 title quickfix list title text. If not present, set
3742 to "".
3743 winid quickfix |window-ID|. If not present, set to 0
3744
3745 Examples (See also |getqflist-examples|): >
3746 :echo getqflist({'all': 1})
3747 :echo getqflist({'nr': 2, 'title': 1})
3748 :echo getqflist({'lines' : ["F1:10:L10"]})
3749<
3750getreg([{regname} [, 1 [, {list}]]]) *getreg()*
3751 The result is a String, which is the contents of register
3752 {regname}. Example: >
3753 :let cliptext = getreg('*')
3754< When register {regname} was not set the result is an empty
3755 string.
3756 The {regname} argument must be a string.
3757
3758 getreg('=') returns the last evaluated value of the expression
3759 register. (For use in maps.)
3760 getreg('=', 1) returns the expression itself, so that it can
3761 be restored with |setreg()|. For other registers the extra
3762 argument is ignored, thus you can always give it.
3763
3764 If {list} is present and |TRUE|, the result type is changed
3765 to |List|. Each list item is one text line. Use it if you care
3766 about zero bytes possibly present inside register: without
3767 third argument both NLs and zero bytes are represented as NLs
3768 (see |NL-used-for-Nul|).
3769 When the register was not set an empty list is returned.
3770
3771 If {regname} is "", the unnamed register '"' is used.
3772 If {regname} is not specified, |v:register| is used.
3773 In |Vim9-script| {regname} must be one character.
3774
3775 Can also be used as a |method|: >
3776 GetRegname()->getreg()
3777
3778getreginfo([{regname}]) *getreginfo()*
3779 Returns detailed information about register {regname} as a
3780 Dictionary with the following entries:
3781 regcontents List of lines contained in register
3782 {regname}, like
3783 |getreg|({regname}, 1, 1).
3784 regtype the type of register {regname}, as in
3785 |getregtype()|.
3786 isunnamed Boolean flag, v:true if this register
3787 is currently pointed to by the unnamed
3788 register.
3789 points_to for the unnamed register, gives the
3790 single letter name of the register
3791 currently pointed to (see |quotequote|).
3792 For example, after deleting a line
3793 with `dd`, this field will be "1",
3794 which is the register that got the
3795 deleted text.
3796
3797 The {regname} argument is a string. If {regname} is invalid
3798 or not set, an empty Dictionary will be returned.
3799 If {regname} is "" or "@", the unnamed register '"' is used.
3800 If {regname} is not specified, |v:register| is used.
3801 The returned Dictionary can be passed to |setreg()|.
3802 In |Vim9-script| {regname} must be one character.
3803
3804 Can also be used as a |method|: >
3805 GetRegname()->getreginfo()
3806
3807getregtype([{regname}]) *getregtype()*
3808 The result is a String, which is type of register {regname}.
3809 The value will be one of:
3810 "v" for |characterwise| text
3811 "V" for |linewise| text
3812 "<CTRL-V>{width}" for |blockwise-visual| text
3813 "" for an empty or unknown register
3814 <CTRL-V> is one character with value 0x16.
3815 The {regname} argument is a string. If {regname} is "", the
3816 unnamed register '"' is used. If {regname} is not specified,
3817 |v:register| is used.
3818 In |Vim9-script| {regname} must be one character.
3819
3820 Can also be used as a |method|: >
3821 GetRegname()->getregtype()
3822
3823gettabinfo([{tabnr}]) *gettabinfo()*
3824 If {tabnr} is not specified, then information about all the
3825 tab pages is returned as a |List|. Each List item is a
3826 |Dictionary|. Otherwise, {tabnr} specifies the tab page
3827 number and information about that one is returned. If the tab
3828 page does not exist an empty List is returned.
3829
3830 Each List item is a |Dictionary| with the following entries:
3831 tabnr tab page number.
3832 variables a reference to the dictionary with
3833 tabpage-local variables
3834 windows List of |window-ID|s in the tab page.
3835
3836 Can also be used as a |method|: >
3837 GetTabnr()->gettabinfo()
3838
3839gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()*
3840 Get the value of a tab-local variable {varname} in tab page
3841 {tabnr}. |t:var|
3842 Tabs are numbered starting with one.
3843 The {varname} argument is a string. When {varname} is empty a
3844 dictionary with all tab-local variables is returned.
3845 Note that the name without "t:" must be used.
3846 When the tab or variable doesn't exist {def} or an empty
3847 string is returned, there is no error message.
3848
3849 Can also be used as a |method|: >
3850 GetTabnr()->gettabvar(varname)
3851
3852gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()*
3853 Get the value of window-local variable {varname} in window
3854 {winnr} in tab page {tabnr}.
3855 The {varname} argument is a string. When {varname} is empty a
3856 dictionary with all window-local variables is returned.
3857 When {varname} is equal to "&" get the values of all
3858 window-local options in a |Dictionary|.
3859 Otherwise, when {varname} starts with "&" get the value of a
3860 window-local option.
3861 Note that {varname} must be the name without "w:".
3862 Tabs are numbered starting with one. For the current tabpage
3863 use |getwinvar()|.
3864 {winnr} can be the window number or the |window-ID|.
3865 When {winnr} is zero the current window is used.
3866 This also works for a global option, buffer-local option and
3867 window-local option, but it doesn't work for a global variable
3868 or buffer-local variable.
3869 When the tab, window or variable doesn't exist {def} or an
3870 empty string is returned, there is no error message.
3871 Examples: >
3872 :let list_is_on = gettabwinvar(1, 2, '&list')
3873 :echo "myvar = " . gettabwinvar(3, 1, 'myvar')
3874<
3875 To obtain all window-local variables use: >
3876 gettabwinvar({tabnr}, {winnr}, '&')
3877
3878< Can also be used as a |method|: >
3879 GetTabnr()->gettabwinvar(winnr, varname)
3880
3881gettagstack([{winnr}]) *gettagstack()*
3882 The result is a Dict, which is the tag stack of window {winnr}.
3883 {winnr} can be the window number or the |window-ID|.
3884 When {winnr} is not specified, the current window is used.
3885 When window {winnr} doesn't exist, an empty Dict is returned.
3886
3887 The returned dictionary contains the following entries:
3888 curidx Current index in the stack. When at
3889 top of the stack, set to (length + 1).
3890 Index of bottom of the stack is 1.
3891 items List of items in the stack. Each item
3892 is a dictionary containing the
3893 entries described below.
3894 length Number of entries in the stack.
3895
3896 Each item in the stack is a dictionary with the following
3897 entries:
3898 bufnr buffer number of the current jump
3899 from cursor position before the tag jump.
3900 See |getpos()| for the format of the
3901 returned list.
3902 matchnr current matching tag number. Used when
3903 multiple matching tags are found for a
3904 name.
3905 tagname name of the tag
3906
3907 See |tagstack| for more information about the tag stack.
3908
3909 Can also be used as a |method|: >
3910 GetWinnr()->gettagstack()
3911
3912
3913gettext({text}) *gettext()*
3914 Translate String {text} if possible.
3915 This is mainly for use in the distributed Vim scripts. When
3916 generating message translations the {text} is extracted by
3917 xgettext, the translator can add the translated message in the
3918 .po file and Vim will lookup the translation when gettext() is
3919 called.
3920 For {text} double quoted strings are preferred, because
3921 xgettext does not understand escaping in single quoted
3922 strings.
3923
3924
3925getwininfo([{winid}]) *getwininfo()*
3926 Returns information about windows as a |List| with Dictionaries.
3927
3928 If {winid} is given Information about the window with that ID
3929 is returned, as a |List| with one item. If the window does not
3930 exist the result is an empty list.
3931
3932 Without {winid} information about all the windows in all the
3933 tab pages is returned.
3934
3935 Each List item is a |Dictionary| with the following entries:
3936 botline last complete displayed buffer line
3937 bufnr number of buffer in the window
3938 height window height (excluding winbar)
3939 loclist 1 if showing a location list
3940 {only with the +quickfix feature}
3941 quickfix 1 if quickfix or location list window
3942 {only with the +quickfix feature}
3943 terminal 1 if a terminal window
3944 {only with the +terminal feature}
3945 tabnr tab page number
3946 topline first displayed buffer line
3947 variables a reference to the dictionary with
3948 window-local variables
3949 width window width
3950 winbar 1 if the window has a toolbar, 0
3951 otherwise
3952 wincol leftmost screen column of the window;
3953 "col" from |win_screenpos()|
3954 textoff number of columns occupied by any
3955 'foldcolumn', 'signcolumn' and line
3956 number in front of the text
3957 winid |window-ID|
3958 winnr window number
3959 winrow topmost screen line of the window;
3960 "row" from |win_screenpos()|
3961
3962 Can also be used as a |method|: >
3963 GetWinnr()->getwininfo()
3964
3965getwinpos([{timeout}]) *getwinpos()*
3966 The result is a |List| with two numbers, the result of
3967 |getwinposx()| and |getwinposy()| combined:
3968 [x-pos, y-pos]
3969 {timeout} can be used to specify how long to wait in msec for
3970 a response from the terminal. When omitted 100 msec is used.
3971 Use a longer time for a remote terminal.
3972 When using a value less than 10 and no response is received
3973 within that time, a previously reported position is returned,
3974 if available. This can be used to poll for the position and
3975 do some work in the meantime: >
3976 while 1
3977 let res = getwinpos(1)
3978 if res[0] >= 0
3979 break
3980 endif
3981 " Do some work here
3982 endwhile
3983<
3984
3985 Can also be used as a |method|: >
3986 GetTimeout()->getwinpos()
3987<
3988 *getwinposx()*
3989getwinposx() The result is a Number, which is the X coordinate in pixels of
3990 the left hand side of the GUI Vim window. Also works for an
3991 xterm (uses a timeout of 100 msec).
3992 The result will be -1 if the information is not available.
3993 The value can be used with `:winpos`.
3994
3995 *getwinposy()*
3996getwinposy() The result is a Number, which is the Y coordinate in pixels of
3997 the top of the GUI Vim window. Also works for an xterm (uses
3998 a timeout of 100 msec).
3999 The result will be -1 if the information is not available.
4000 The value can be used with `:winpos`.
4001
4002getwinvar({winnr}, {varname} [, {def}]) *getwinvar()*
4003 Like |gettabwinvar()| for the current tabpage.
4004 Examples: >
4005 :let list_is_on = getwinvar(2, '&list')
4006 :echo "myvar = " . getwinvar(1, 'myvar')
4007
4008< Can also be used as a |method|: >
4009 GetWinnr()->getwinvar(varname)
4010<
4011glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()*
4012 Expand the file wildcards in {expr}. See |wildcards| for the
4013 use of special characters.
4014
4015 Unless the optional {nosuf} argument is given and is |TRUE|,
4016 the 'suffixes' and 'wildignore' options apply: Names matching
4017 one of the patterns in 'wildignore' will be skipped and
4018 'suffixes' affect the ordering of matches.
4019 'wildignorecase' always applies.
4020
4021 When {list} is present and it is |TRUE| the result is a |List|
4022 with all matching files. The advantage of using a List is,
4023 you also get filenames containing newlines correctly.
4024 Otherwise the result is a String and when there are several
4025 matches, they are separated by <NL> characters.
4026
4027 If the expansion fails, the result is an empty String or List.
4028
4029 You can also use |readdir()| if you need to do complicated
4030 things, such as limiting the number of matches.
4031
4032 A name for a non-existing file is not included. A symbolic
4033 link is only included if it points to an existing file.
4034 However, when the {alllinks} argument is present and it is
4035 |TRUE| then all symbolic links are included.
4036
4037 For most systems backticks can be used to get files names from
4038 any external command. Example: >
4039 :let tagfiles = glob("`find . -name tags -print`")
4040 :let &tags = substitute(tagfiles, "\n", ",", "g")
4041< The result of the program inside the backticks should be one
4042 item per line. Spaces inside an item are allowed.
4043
4044 See |expand()| for expanding special Vim variables. See
4045 |system()| for getting the raw output of an external command.
4046
4047 Can also be used as a |method|: >
4048 GetExpr()->glob()
4049
4050glob2regpat({string}) *glob2regpat()*
4051 Convert a file pattern, as used by glob(), into a search
4052 pattern. The result can be used to match with a string that
4053 is a file name. E.g. >
4054 if filename =~ glob2regpat('Make*.mak')
4055< This is equivalent to: >
4056 if filename =~ '^Make.*\.mak$'
4057< When {string} is an empty string the result is "^$", match an
4058 empty string.
4059 Note that the result depends on the system. On MS-Windows
4060 a backslash usually means a path separator.
4061
4062 Can also be used as a |method|: >
4063 GetExpr()->glob2regpat()
4064< *globpath()*
4065globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
4066 Perform glob() for String {expr} on all directories in {path}
4067 and concatenate the results. Example: >
4068 :echo globpath(&rtp, "syntax/c.vim")
4069<
4070 {path} is a comma-separated list of directory names. Each
4071 directory name is prepended to {expr} and expanded like with
4072 |glob()|. A path separator is inserted when needed.
4073 To add a comma inside a directory name escape it with a
4074 backslash. Note that on MS-Windows a directory may have a
4075 trailing backslash, remove it if you put a comma after it.
4076 If the expansion fails for one of the directories, there is no
4077 error message.
4078
4079 Unless the optional {nosuf} argument is given and is |TRUE|,
4080 the 'suffixes' and 'wildignore' options apply: Names matching
4081 one of the patterns in 'wildignore' will be skipped and
4082 'suffixes' affect the ordering of matches.
4083
4084 When {list} is present and it is |TRUE| the result is a |List|
4085 with all matching files. The advantage of using a List is, you
4086 also get filenames containing newlines correctly. Otherwise
4087 the result is a String and when there are several matches,
4088 they are separated by <NL> characters. Example: >
4089 :echo globpath(&rtp, "syntax/c.vim", 0, 1)
4090<
4091 {alllinks} is used as with |glob()|.
4092
4093 The "**" item can be used to search in a directory tree.
4094 For example, to find all "README.txt" files in the directories
4095 in 'runtimepath' and below: >
4096 :echo globpath(&rtp, "**/README.txt")
4097< Upwards search and limiting the depth of "**" is not
4098 supported, thus using 'path' will not always work properly.
4099
4100 Can also be used as a |method|, the base is passed as the
4101 second argument: >
4102 GetExpr()->globpath(&rtp)
4103<
4104 *has()*
4105has({feature} [, {check}])
4106 When {check} is omitted or is zero: The result is a Number,
4107 which is 1 if the feature {feature} is supported, zero
4108 otherwise. The {feature} argument is a string, case is
4109 ignored. See |feature-list| below.
4110
4111 When {check} is present and not zero: The result is a Number,
4112 which is 1 if the feature {feature} could ever be supported,
4113 zero otherwise. This is useful to check for a typo in
4114 {feature} and to detect dead code. Keep in mind that an older
4115 Vim version will not know about a feature added later and
4116 features that have been abandoned will not be known by the
4117 current Vim version.
4118
4119 Also see |exists()| and |exists_compiled()|.
4120
4121 Note that to skip code that has a syntax error when the
4122 feature is not available, Vim may skip the rest of the line
4123 and miss a following `endif`. Therefore put the `endif` on a
4124 separate line: >
4125 if has('feature')
4126 let x = this->breaks->without->the->feature
4127 endif
4128< If the `endif` would be moved to the second line as "| endif" it
4129 would not be found.
4130
4131
4132has_key({dict}, {key}) *has_key()*
4133 The result is a Number, which is TRUE if |Dictionary| {dict}
4134 has an entry with key {key}. FALSE otherwise. The {key}
4135 argument is a string.
4136
4137 Can also be used as a |method|: >
4138 mydict->has_key(key)
4139
4140haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()*
4141 The result is a Number:
4142 1 when the window has set a local directory via |:lcd|
4143 2 when the tab-page has set a local directory via |:tcd|
4144 0 otherwise.
4145
4146 Without arguments use the current window.
4147 With {winnr} use this window in the current tab page.
4148 With {winnr} and {tabnr} use the window in the specified tab
4149 page.
4150 {winnr} can be the window number or the |window-ID|.
4151 If {winnr} is -1 it is ignored and only the tabpage is used.
4152 Return 0 if the arguments are invalid.
4153 Examples: >
4154 if haslocaldir() == 1
4155 " window local directory case
4156 elseif haslocaldir() == 2
4157 " tab-local directory case
4158 else
4159 " global directory case
4160 endif
4161
4162 " current window
4163 :echo haslocaldir()
4164 :echo haslocaldir(0)
4165 :echo haslocaldir(0, 0)
4166 " window n in current tab page
4167 :echo haslocaldir(n)
4168 :echo haslocaldir(n, 0)
4169 " window n in tab page m
4170 :echo haslocaldir(n, m)
4171 " tab page m
4172 :echo haslocaldir(-1, m)
4173<
4174 Can also be used as a |method|: >
4175 GetWinnr()->haslocaldir()
4176
4177hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
4178 The result is a Number, which is TRUE if there is a mapping
4179 that contains {what} in somewhere in the rhs (what it is
4180 mapped to) and this mapping exists in one of the modes
4181 indicated by {mode}.
4182 The arguments {what} and {mode} are strings.
4183 When {abbr} is there and it is |TRUE| use abbreviations
4184 instead of mappings. Don't forget to specify Insert and/or
4185 Command-line mode.
4186 Both the global mappings and the mappings local to the current
4187 buffer are checked for a match.
4188 If no matching mapping is found FALSE is returned.
4189 The following characters are recognized in {mode}:
4190 n Normal mode
4191 v Visual and Select mode
4192 x Visual mode
4193 s Select mode
4194 o Operator-pending mode
4195 i Insert mode
4196 l Language-Argument ("r", "f", "t", etc.)
4197 c Command-line mode
4198 When {mode} is omitted, "nvo" is used.
4199
4200 This function is useful to check if a mapping already exists
4201 to a function in a Vim script. Example: >
4202 :if !hasmapto('\ABCdoit')
4203 : map <Leader>d \ABCdoit
4204 :endif
4205< This installs the mapping to "\ABCdoit" only if there isn't
4206 already a mapping to "\ABCdoit".
4207
4208 Can also be used as a |method|: >
4209 GetRHS()->hasmapto()
4210
4211histadd({history}, {item}) *histadd()*
4212 Add the String {item} to the history {history} which can be
4213 one of: *hist-names*
4214 "cmd" or ":" command line history
4215 "search" or "/" search pattern history
4216 "expr" or "=" typed expression history
4217 "input" or "@" input line history
4218 "debug" or ">" debug command history
4219 empty the current or last used history
4220 The {history} string does not need to be the whole name, one
4221 character is sufficient.
4222 If {item} does already exist in the history, it will be
4223 shifted to become the newest entry.
4224 The result is a Number: TRUE if the operation was successful,
4225 otherwise FALSE is returned.
4226
4227 Example: >
4228 :call histadd("input", strftime("%Y %b %d"))
4229 :let date=input("Enter date: ")
4230< This function is not available in the |sandbox|.
4231
4232 Can also be used as a |method|, the base is passed as the
4233 second argument: >
4234 GetHistory()->histadd('search')
4235
4236histdel({history} [, {item}]) *histdel()*
4237 Clear {history}, i.e. delete all its entries. See |hist-names|
4238 for the possible values of {history}.
4239
4240 If the parameter {item} evaluates to a String, it is used as a
4241 regular expression. All entries matching that expression will
4242 be removed from the history (if there are any).
4243 Upper/lowercase must match, unless "\c" is used |/\c|.
4244 If {item} evaluates to a Number, it will be interpreted as
4245 an index, see |:history-indexing|. The respective entry will
4246 be removed if it exists.
4247
4248 The result is TRUE for a successful operation, otherwise FALSE
4249 is returned.
4250
4251 Examples:
4252 Clear expression register history: >
4253 :call histdel("expr")
4254<
4255 Remove all entries starting with "*" from the search history: >
4256 :call histdel("/", '^\*')
4257<
4258 The following three are equivalent: >
4259 :call histdel("search", histnr("search"))
4260 :call histdel("search", -1)
4261 :call histdel("search", '^'.histget("search", -1).'$')
4262<
4263 To delete the last search pattern and use the last-but-one for
4264 the "n" command and 'hlsearch': >
4265 :call histdel("search", -1)
4266 :let @/ = histget("search", -1)
4267<
4268 Can also be used as a |method|: >
4269 GetHistory()->histdel()
4270
4271histget({history} [, {index}]) *histget()*
4272 The result is a String, the entry with Number {index} from
4273 {history}. See |hist-names| for the possible values of
4274 {history}, and |:history-indexing| for {index}. If there is
4275 no such entry, an empty String is returned. When {index} is
4276 omitted, the most recent item from the history is used.
4277
4278 Examples:
4279 Redo the second last search from history. >
4280 :execute '/' . histget("search", -2)
4281
4282< Define an Ex command ":H {num}" that supports re-execution of
4283 the {num}th entry from the output of |:history|. >
4284 :command -nargs=1 H execute histget("cmd", 0+<args>)
4285<
4286 Can also be used as a |method|: >
4287 GetHistory()->histget()
4288
4289histnr({history}) *histnr()*
4290 The result is the Number of the current entry in {history}.
4291 See |hist-names| for the possible values of {history}.
4292 If an error occurred, -1 is returned.
4293
4294 Example: >
4295 :let inp_index = histnr("expr")
4296
4297< Can also be used as a |method|: >
4298 GetHistory()->histnr()
4299<
4300hlexists({name}) *hlexists()*
4301 The result is a Number, which is TRUE if a highlight group
4302 called {name} exists. This is when the group has been
4303 defined in some way. Not necessarily when highlighting has
4304 been defined for it, it may also have been used for a syntax
4305 item.
4306 *highlight_exists()*
4307 Obsolete name: highlight_exists().
4308
4309 Can also be used as a |method|: >
4310 GetName()->hlexists()
4311<
4312hlget([{name} [, {resolve}]]) *hlget()*
4313 Returns a List of all the highlight group attributes. If the
4314 optional {name} is specified, then returns a List with only
4315 the attributes of the specified highlight group. Returns an
4316 empty List if the highlight group {name} is not present.
4317
4318 If the optional {resolve} argument is set to v:true and the
4319 highlight group {name} is linked to another group, then the
4320 link is resolved recursively and the attributes of the
4321 resolved highlight group are returned.
4322
4323 Each entry in the returned List is a Dictionary with the
4324 following items:
4325 cleared boolean flag, set to v:true if the highlight
4326 group attributes are cleared or not yet
4327 specified. See |highlight-clear|.
4328 cterm cterm attributes. See |highlight-cterm|.
4329 ctermbg cterm background color.
4330 See |highlight-ctermbg|.
4331 ctermfg cterm foreground color.
4332 See |highlight-ctermfg|.
4333 ctermul cterm underline color. See |highlight-ctermul|.
4334 default boolean flag, set to v:true if the highlight
4335 group link is a default link. See
4336 |highlight-default|.
4337 font highlight group font. See |highlight-font|.
4338 gui gui attributes. See |highlight-gui|.
4339 guibg gui background color. See |highlight-guibg|.
4340 guifg gui foreground color. See |highlight-guifg|.
4341 guisp gui special color. See |highlight-guisp|.
4342 id highlight group ID.
4343 linksto linked highlight group name.
4344 See |:highlight-link|.
4345 name highlight group name. See |group-name|.
4346 start start terminal keycode. See |highlight-start|.
4347 stop stop terminal keycode. See |highlight-stop|.
4348 term term attributes. See |highlight-term|.
4349
4350 The 'term', 'cterm' and 'gui' items in the above Dictionary
4351 have a dictionary value with the following optional boolean
4352 items: 'bold', 'standout', 'underline', 'undercurl', 'italic',
4353 'reverse', 'inverse' and 'strikethrough'.
4354
4355 Example(s): >
4356 :echo hlget()
4357 :echo hlget('ModeMsg')
4358 :echo hlget('Number', v:true)
4359<
4360 Can also be used as a |method|: >
4361 GetName()->hlget()
4362<
4363hlset({list}) *hlset()*
4364 Creates or modifies the attributes of a List of highlight
4365 groups. Each item in {list} is a dictionary containing the
4366 attributes of a highlight group. See |hlget()| for the list of
4367 supported items in this dictionary.
4368
4369 In addition to the items described in |hlget()|, the following
4370 additional items are supported in the dictionary:
4371
4372 force boolean flag to force the creation of
4373 a link for an existing highlight group
4374 with attributes.
4375
4376 The highlight group is identified using the 'name' item and
4377 the 'id' item (if supplied) is ignored. If a highlight group
4378 with a specified name doesn't exist, then it is created.
4379 Otherwise the attributes of an existing highlight group are
4380 modified.
4381
4382 If an empty dictionary value is used for the 'term' or 'cterm'
4383 or 'gui' entries, then the corresponding attributes are
4384 cleared. If the 'cleared' item is set to v:true, then all the
4385 attributes of the highlight group are cleared.
4386
4387 The 'linksto' item can be used to link a highlight group to
4388 another highlight group. See |:highlight-link|.
4389
4390 Returns zero for success, -1 for failure.
4391
4392 Example(s): >
4393 " add bold attribute to the Visual highlight group
4394 :call hlset([#{name: 'Visual',
4395 \ term: #{reverse: 1 , bold: 1}}])
4396 :call hlset([#{name: 'Type', guifg: 'DarkGreen'}])
4397 :let l = hlget()
4398 :call hlset(l)
4399 " clear the Search highlight group
4400 :call hlset([#{name: 'Search', cleared: v:true}])
4401 " clear the 'term' attributes for a highlight group
4402 :call hlset([#{name: 'Title', term: {}}])
4403 " create the MyHlg group linking it to DiffAdd
4404 :call hlset([#{name: 'MyHlg', linksto: 'DiffAdd'}])
4405 " remove the MyHlg group link
4406 :call hlset([#{name: 'MyHlg', linksto: 'NONE'}])
4407 " clear the attributes and a link
4408 :call hlset([#{name: 'MyHlg', cleared: v:true,
4409 \ linksto: 'NONE'}])
4410<
4411 Can also be used as a |method|: >
4412 GetAttrList()->hlset()
4413<
4414 *hlID()*
4415hlID({name}) The result is a Number, which is the ID of the highlight group
4416 with name {name}. When the highlight group doesn't exist,
4417 zero is returned.
4418 This can be used to retrieve information about the highlight
4419 group. For example, to get the background color of the
4420 "Comment" group: >
4421 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
4422< *highlightID()*
4423 Obsolete name: highlightID().
4424
4425 Can also be used as a |method|: >
4426 GetName()->hlID()
4427
4428hostname() *hostname()*
4429 The result is a String, which is the name of the machine on
4430 which Vim is currently running. Machine names greater than
4431 256 characters long are truncated.
4432
4433iconv({string}, {from}, {to}) *iconv()*
4434 The result is a String, which is the text {string} converted
4435 from encoding {from} to encoding {to}.
4436 When the conversion completely fails an empty string is
4437 returned. When some characters could not be converted they
4438 are replaced with "?".
4439 The encoding names are whatever the iconv() library function
4440 can accept, see ":!man 3 iconv".
4441 Most conversions require Vim to be compiled with the |+iconv|
4442 feature. Otherwise only UTF-8 to latin1 conversion and back
4443 can be done.
4444 This can be used to display messages with special characters,
4445 no matter what 'encoding' is set to. Write the message in
4446 UTF-8 and use: >
4447 echo iconv(utf8_str, "utf-8", &enc)
4448< Note that Vim uses UTF-8 for all Unicode encodings, conversion
4449 from/to UCS-2 is automatically changed to use UTF-8. You
4450 cannot use UCS-2 in a string anyway, because of the NUL bytes.
4451
4452 Can also be used as a |method|: >
4453 GetText()->iconv('latin1', 'utf-8')
4454<
4455 *indent()*
4456indent({lnum}) The result is a Number, which is indent of line {lnum} in the
4457 current buffer. The indent is counted in spaces, the value
4458 of 'tabstop' is relevant. {lnum} is used just like in
4459 |getline()|.
4460 When {lnum} is invalid -1 is returned. In |Vim9| script an
4461 error is given.
4462
4463 Can also be used as a |method|: >
4464 GetLnum()->indent()
4465
4466index({object}, {expr} [, {start} [, {ic}]]) *index()*
4467 If {object} is a |List| return the lowest index where the item
4468 has a value equal to {expr}. There is no automatic
4469 conversion, so the String "4" is different from the Number 4.
4470 And the number 4 is different from the Float 4.0. The value
4471 of 'ignorecase' is not used here, case always matters.
4472
4473 If {object} is |Blob| return the lowest index where the byte
4474 value is equal to {expr}.
4475
4476 If {start} is given then start looking at the item with index
4477 {start} (may be negative for an item relative to the end).
4478 When {ic} is given and it is |TRUE|, ignore case. Otherwise
4479 case must match.
4480 -1 is returned when {expr} is not found in {object}.
4481 Example: >
4482 :let idx = index(words, "the")
4483 :if index(numbers, 123) >= 0
4484
4485< Can also be used as a |method|: >
4486 GetObject()->index(what)
4487
4488input({prompt} [, {text} [, {completion}]]) *input()*
4489 The result is a String, which is whatever the user typed on
4490 the command-line. The {prompt} argument is either a prompt
4491 string, or a blank string (for no prompt). A '\n' can be used
4492 in the prompt to start a new line.
4493 The highlighting set with |:echohl| is used for the prompt.
4494 The input is entered just like a command-line, with the same
4495 editing commands and mappings. There is a separate history
4496 for lines typed for input().
4497 Example: >
4498 :if input("Coffee or beer? ") == "beer"
4499 : echo "Cheers!"
4500 :endif
4501<
4502 If the optional {text} argument is present and not empty, this
4503 is used for the default reply, as if the user typed this.
4504 Example: >
4505 :let color = input("Color? ", "white")
4506
4507< The optional {completion} argument specifies the type of
4508 completion supported for the input. Without it completion is
4509 not performed. The supported completion types are the same as
4510 that can be supplied to a user-defined command using the
4511 "-complete=" argument. Refer to |:command-completion| for
4512 more information. Example: >
4513 let fname = input("File: ", "", "file")
4514<
4515 NOTE: This function must not be used in a startup file, for
4516 the versions that only run in GUI mode (e.g., the Win32 GUI).
4517 Note: When input() is called from within a mapping it will
4518 consume remaining characters from that mapping, because a
4519 mapping is handled like the characters were typed.
4520 Use |inputsave()| before input() and |inputrestore()|
4521 after input() to avoid that. Another solution is to avoid
4522 that further characters follow in the mapping, e.g., by using
4523 |:execute| or |:normal|.
4524
4525 Example with a mapping: >
4526 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR>
4527 :function GetFoo()
4528 : call inputsave()
4529 : let g:Foo = input("enter search pattern: ")
4530 : call inputrestore()
4531 :endfunction
4532
4533< Can also be used as a |method|: >
4534 GetPrompt()->input()
4535
4536inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
4537 Like |input()|, but when the GUI is running and text dialogs
4538 are supported, a dialog window pops up to input the text.
4539 Example: >
4540 :let n = inputdialog("value for shiftwidth", shiftwidth())
4541 :if n != ""
4542 : let &sw = n
4543 :endif
4544< When the dialog is cancelled {cancelreturn} is returned. When
4545 omitted an empty string is returned.
4546 Hitting <Enter> works like pressing the OK button. Hitting
4547 <Esc> works like pressing the Cancel button.
4548 NOTE: Command-line completion is not supported.
4549
4550 Can also be used as a |method|: >
4551 GetPrompt()->inputdialog()
4552
4553inputlist({textlist}) *inputlist()*
4554 {textlist} must be a |List| of strings. This |List| is
4555 displayed, one string per line. The user will be prompted to
4556 enter a number, which is returned.
4557 The user can also select an item by clicking on it with the
4558 mouse, if the mouse is enabled in the command line ('mouse' is
4559 "a" or includes "c"). For the first string 0 is returned.
4560 When clicking above the first item a negative number is
4561 returned. When clicking on the prompt one more than the
4562 length of {textlist} is returned.
4563 Make sure {textlist} has less than 'lines' entries, otherwise
4564 it won't work. It's a good idea to put the entry number at
4565 the start of the string. And put a prompt in the first item.
4566 Example: >
4567 let color = inputlist(['Select color:', '1. red',
4568 \ '2. green', '3. blue'])
4569
4570< Can also be used as a |method|: >
4571 GetChoices()->inputlist()
4572
4573inputrestore() *inputrestore()*
4574 Restore typeahead that was saved with a previous |inputsave()|.
4575 Should be called the same number of times inputsave() is
4576 called. Calling it more often is harmless though.
4577 Returns TRUE when there is nothing to restore, FALSE otherwise.
4578
4579inputsave() *inputsave()*
4580 Preserve typeahead (also from mappings) and clear it, so that
4581 a following prompt gets input from the user. Should be
4582 followed by a matching inputrestore() after the prompt. Can
4583 be used several times, in which case there must be just as
4584 many inputrestore() calls.
4585 Returns TRUE when out of memory, FALSE otherwise.
4586
4587inputsecret({prompt} [, {text}]) *inputsecret()*
4588 This function acts much like the |input()| function with but
4589 two exceptions:
4590 a) the user's response will be displayed as a sequence of
4591 asterisks ("*") thereby keeping the entry secret, and
4592 b) the user's response will not be recorded on the input
4593 |history| stack.
4594 The result is a String, which is whatever the user actually
4595 typed on the command-line in response to the issued prompt.
4596 NOTE: Command-line completion is not supported.
4597
4598 Can also be used as a |method|: >
4599 GetPrompt()->inputsecret()
4600
4601insert({object}, {item} [, {idx}]) *insert()*
4602 When {object} is a |List| or a |Blob| insert {item} at the start
4603 of it.
4604
4605 If {idx} is specified insert {item} before the item with index
4606 {idx}. If {idx} is zero it goes before the first item, just
4607 like omitting {idx}. A negative {idx} is also possible, see
4608 |list-index|. -1 inserts just before the last item.
4609
4610 Returns the resulting |List| or |Blob|. Examples: >
4611 :let mylist = insert([2, 3, 5], 1)
4612 :call insert(mylist, 4, -1)
4613 :call insert(mylist, 6, len(mylist))
4614< The last example can be done simpler with |add()|.
4615 Note that when {item} is a |List| it is inserted as a single
4616 item. Use |extend()| to concatenate |Lists|.
4617
4618 Can also be used as a |method|: >
4619 mylist->insert(item)
4620
4621interrupt() *interrupt()*
4622 Interrupt script execution. It works more or less like the
4623 user typing CTRL-C, most commands won't execute and control
4624 returns to the user. This is useful to abort execution
4625 from lower down, e.g. in an autocommand. Example: >
4626 :function s:check_typoname(file)
4627 : if fnamemodify(a:file, ':t') == '['
4628 : echomsg 'Maybe typo'
4629 : call interrupt()
4630 : endif
4631 :endfunction
4632 :au BufWritePre * call s:check_typoname(expand('<amatch>'))
4633
4634invert({expr}) *invert()*
4635 Bitwise invert. The argument is converted to a number. A
4636 List, Dict or Float argument causes an error. Example: >
4637 :let bits = invert(bits)
4638< Can also be used as a |method|: >
4639 :let bits = bits->invert()
4640
4641isdirectory({directory}) *isdirectory()*
4642 The result is a Number, which is |TRUE| when a directory
4643 with the name {directory} exists. If {directory} doesn't
4644 exist, or isn't a directory, the result is |FALSE|. {directory}
4645 is any expression, which is used as a String.
4646
4647 Can also be used as a |method|: >
4648 GetName()->isdirectory()
4649
4650isinf({expr}) *isinf()*
4651 Return 1 if {expr} is a positive infinity, or -1 a negative
4652 infinity, otherwise 0. >
4653 :echo isinf(1.0 / 0.0)
4654< 1 >
4655 :echo isinf(-1.0 / 0.0)
4656< -1
4657
4658 Can also be used as a |method|: >
4659 Compute()->isinf()
4660<
4661 {only available when compiled with the |+float| feature}
4662
4663islocked({expr}) *islocked()* *E786*
4664 The result is a Number, which is |TRUE| when {expr} is the
4665 name of a locked variable.
4666 The string argument {expr} must be the name of a variable,
4667 |List| item or |Dictionary| entry, not the variable itself!
4668 Example: >
4669 :let alist = [0, ['a', 'b'], 2, 3]
4670 :lockvar 1 alist
4671 :echo islocked('alist') " 1
4672 :echo islocked('alist[1]') " 0
4673
4674< When {expr} is a variable that does not exist you get an error
4675 message. Use |exists()| to check for existence.
4676 In Vim9 script it does not work for local variables.
4677
4678 Can also be used as a |method|: >
4679 GetName()->islocked()
4680
4681isnan({expr}) *isnan()*
4682 Return |TRUE| if {expr} is a float with value NaN. >
4683 echo isnan(0.0 / 0.0)
4684< 1
4685
4686 Can also be used as a |method|: >
4687 Compute()->isnan()
4688<
4689 {only available when compiled with the |+float| feature}
4690
4691items({dict}) *items()*
4692 Return a |List| with all the key-value pairs of {dict}. Each
4693 |List| item is a list with two items: the key of a {dict}
4694 entry and the value of this entry. The |List| is in arbitrary
4695 order. Also see |keys()| and |values()|.
4696 Example: >
4697 for [key, value] in items(mydict)
4698 echo key . ': ' . value
4699 endfor
4700
4701< Can also be used as a |method|: >
4702 mydict->items()
4703
4704job_ functions are documented here: |job-functions-details|
4705
4706
4707join({list} [, {sep}]) *join()*
4708 Join the items in {list} together into one String.
4709 When {sep} is specified it is put in between the items. If
4710 {sep} is omitted a single space is used.
4711 Note that {sep} is not added at the end. You might want to
4712 add it there too: >
4713 let lines = join(mylist, "\n") . "\n"
4714< String items are used as-is. |Lists| and |Dictionaries| are
4715 converted into a string like with |string()|.
4716 The opposite function is |split()|.
4717
4718 Can also be used as a |method|: >
4719 mylist->join()
4720
4721js_decode({string}) *js_decode()*
4722 This is similar to |json_decode()| with these differences:
4723 - Object key names do not have to be in quotes.
4724 - Strings can be in single quotes.
4725 - Empty items in an array (between two commas) are allowed and
4726 result in v:none items.
4727
4728 Can also be used as a |method|: >
4729 ReadObject()->js_decode()
4730
4731js_encode({expr}) *js_encode()*
4732 This is similar to |json_encode()| with these differences:
4733 - Object key names are not in quotes.
4734 - v:none items in an array result in an empty item between
4735 commas.
4736 For example, the Vim object:
4737 [1,v:none,{"one":1},v:none] ~
4738 Will be encoded as:
4739 [1,,{one:1},,] ~
4740 While json_encode() would produce:
4741 [1,null,{"one":1},null] ~
4742 This encoding is valid for JavaScript. It is more efficient
4743 than JSON, especially when using an array with optional items.
4744
4745 Can also be used as a |method|: >
4746 GetObject()->js_encode()
4747
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00004748json_decode({string}) *json_decode()* *E491*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004749 This parses a JSON formatted string and returns the equivalent
4750 in Vim values. See |json_encode()| for the relation between
4751 JSON and Vim values.
4752 The decoding is permissive:
4753 - A trailing comma in an array and object is ignored, e.g.
4754 "[1, 2, ]" is the same as "[1, 2]".
4755 - Integer keys are accepted in objects, e.g. {1:2} is the
4756 same as {"1":2}.
4757 - More floating point numbers are recognized, e.g. "1." for
4758 "1.0", or "001.2" for "1.2". Special floating point values
4759 "Infinity", "-Infinity" and "NaN" (capitalization ignored)
4760 are accepted.
4761 - Leading zeroes in integer numbers are ignored, e.g. "012"
4762 for "12" or "-012" for "-12".
4763 - Capitalization is ignored in literal names null, true or
4764 false, e.g. "NULL" for "null", "True" for "true".
4765 - Control characters U+0000 through U+001F which are not
4766 escaped in strings are accepted, e.g. " " (tab
4767 character in string) for "\t".
4768 - An empty JSON expression or made of only spaces is accepted
4769 and results in v:none.
4770 - Backslash in an invalid 2-character sequence escape is
4771 ignored, e.g. "\a" is decoded as "a".
4772 - A correct surrogate pair in JSON strings should normally be
4773 a 12 character sequence such as "\uD834\uDD1E", but
4774 json_decode() silently accepts truncated surrogate pairs
4775 such as "\uD834" or "\uD834\u"
4776 *E938*
4777 A duplicate key in an object, valid in rfc7159, is not
4778 accepted by json_decode() as the result must be a valid Vim
4779 type, e.g. this fails: {"a":"b", "a":"c"}
4780
4781 Can also be used as a |method|: >
4782 ReadObject()->json_decode()
4783
4784json_encode({expr}) *json_encode()*
4785 Encode {expr} as JSON and return this as a string.
4786 The encoding is specified in:
4787 https://tools.ietf.org/html/rfc7159.html
4788 Vim values are converted as follows:
4789 |Number| decimal number
4790 |Float| floating point number
4791 Float nan "NaN"
4792 Float inf "Infinity"
4793 Float -inf "-Infinity"
4794 |String| in double quotes (possibly null)
4795 |Funcref| not possible, error
4796 |List| as an array (possibly null); when
4797 used recursively: []
4798 |Dict| as an object (possibly null); when
4799 used recursively: {}
4800 |Blob| as an array of the individual bytes
4801 v:false "false"
4802 v:true "true"
4803 v:none "null"
4804 v:null "null"
4805 Note that NaN and Infinity are passed on as values. This is
4806 missing in the JSON standard, but several implementations do
4807 allow it. If not then you will get an error.
4808
4809 Can also be used as a |method|: >
4810 GetObject()->json_encode()
4811
4812keys({dict}) *keys()*
4813 Return a |List| with all the keys of {dict}. The |List| is in
4814 arbitrary order. Also see |items()| and |values()|.
4815
4816 Can also be used as a |method|: >
4817 mydict->keys()
4818
4819< *len()* *E701*
4820len({expr}) The result is a Number, which is the length of the argument.
4821 When {expr} is a String or a Number the length in bytes is
4822 used, as with |strlen()|.
4823 When {expr} is a |List| the number of items in the |List| is
4824 returned.
4825 When {expr} is a |Blob| the number of bytes is returned.
4826 When {expr} is a |Dictionary| the number of entries in the
4827 |Dictionary| is returned.
4828 Otherwise an error is given.
4829
4830 Can also be used as a |method|: >
4831 mylist->len()
4832
4833< *libcall()* *E364* *E368*
4834libcall({libname}, {funcname}, {argument})
4835 Call function {funcname} in the run-time library {libname}
4836 with single argument {argument}.
4837 This is useful to call functions in a library that you
4838 especially made to be used with Vim. Since only one argument
4839 is possible, calling standard library functions is rather
4840 limited.
4841 The result is the String returned by the function. If the
4842 function returns NULL, this will appear as an empty string ""
4843 to Vim.
4844 If the function returns a number, use libcallnr()!
4845 If {argument} is a number, it is passed to the function as an
4846 int; if {argument} is a string, it is passed as a
4847 null-terminated string.
4848 This function will fail in |restricted-mode|.
4849
4850 libcall() allows you to write your own 'plug-in' extensions to
4851 Vim without having to recompile the program. It is NOT a
4852 means to call system functions! If you try to do so Vim will
4853 very probably crash.
4854
4855 For Win32, the functions you write must be placed in a DLL
4856 and use the normal C calling convention (NOT Pascal which is
4857 used in Windows System DLLs). The function must take exactly
4858 one parameter, either a character pointer or a long integer,
4859 and must return a character pointer or NULL. The character
4860 pointer returned must point to memory that will remain valid
4861 after the function has returned (e.g. in static data in the
4862 DLL). If it points to allocated memory, that memory will
4863 leak away. Using a static buffer in the function should work,
4864 it's then freed when the DLL is unloaded.
4865
4866 WARNING: If the function returns a non-valid pointer, Vim may
4867 crash! This also happens if the function returns a number,
4868 because Vim thinks it's a pointer.
4869 For Win32 systems, {libname} should be the filename of the DLL
4870 without the ".DLL" suffix. A full path is only required if
4871 the DLL is not in the usual places.
4872 For Unix: When compiling your own plugins, remember that the
4873 object code must be compiled as position-independent ('PIC').
4874 {only in Win32 and some Unix versions, when the |+libcall|
4875 feature is present}
4876 Examples: >
4877 :echo libcall("libc.so", "getenv", "HOME")
4878
4879< Can also be used as a |method|, the base is passed as the
4880 third argument: >
4881 GetValue()->libcall("libc.so", "getenv")
4882<
4883 *libcallnr()*
4884libcallnr({libname}, {funcname}, {argument})
4885 Just like |libcall()|, but used for a function that returns an
4886 int instead of a string.
4887 {only in Win32 on some Unix versions, when the |+libcall|
4888 feature is present}
4889 Examples: >
4890 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
4891 :call libcallnr("libc.so", "printf", "Hello World!\n")
4892 :call libcallnr("libc.so", "sleep", 10)
4893<
4894 Can also be used as a |method|, the base is passed as the
4895 third argument: >
4896 GetValue()->libcallnr("libc.so", "printf")
4897<
4898
4899line({expr} [, {winid}]) *line()*
4900 The result is a Number, which is the line number of the file
4901 position given with {expr}. The {expr} argument is a string.
4902 The accepted positions are:
4903 . the cursor position
4904 $ the last line in the current buffer
4905 'x position of mark x (if the mark is not set, 0 is
4906 returned)
4907 w0 first line visible in current window (one if the
4908 display isn't updated, e.g. in silent Ex mode)
4909 w$ last line visible in current window (this is one
4910 less than "w0" if no lines are visible)
4911 v In Visual mode: the start of the Visual area (the
4912 cursor is the end). When not in Visual mode
4913 returns the cursor position. Differs from |'<| in
4914 that it's updated right away.
4915 Note that a mark in another file can be used. The line number
4916 then applies to another buffer.
4917 To get the column number use |col()|. To get both use
4918 |getpos()|.
4919 With the optional {winid} argument the values are obtained for
4920 that window instead of the current window.
4921 Examples: >
4922 line(".") line number of the cursor
4923 line(".", winid) idem, in window "winid"
4924 line("'t") line number of mark t
4925 line("'" . marker) line number of mark marker
4926<
4927 To jump to the last known position when opening a file see
4928 |last-position-jump|.
4929
4930 Can also be used as a |method|: >
4931 GetValue()->line()
4932
4933line2byte({lnum}) *line2byte()*
4934 Return the byte count from the start of the buffer for line
4935 {lnum}. This includes the end-of-line character, depending on
4936 the 'fileformat' option for the current buffer. The first
4937 line returns 1. 'encoding' matters, 'fileencoding' is ignored.
4938 This can also be used to get the byte count for the line just
4939 below the last line: >
4940 line2byte(line("$") + 1)
4941< This is the buffer size plus one. If 'fileencoding' is empty
4942 it is the file size plus one. {lnum} is used like with
4943 |getline()|. When {lnum} is invalid, or the |+byte_offset|
4944 feature has been disabled at compile time, -1 is returned.
4945 Also see |byte2line()|, |go| and |:goto|.
4946
4947 Can also be used as a |method|: >
4948 GetLnum()->line2byte()
4949
4950lispindent({lnum}) *lispindent()*
4951 Get the amount of indent for line {lnum} according the lisp
4952 indenting rules, as with 'lisp'.
4953 The indent is counted in spaces, the value of 'tabstop' is
4954 relevant. {lnum} is used just like in |getline()|.
4955 When {lnum} is invalid or Vim was not compiled the
4956 |+lispindent| feature, -1 is returned. In |Vim9| script an
4957 error is given.
4958
4959 Can also be used as a |method|: >
4960 GetLnum()->lispindent()
4961
4962list2blob({list}) *list2blob()*
4963 Return a Blob concatenating all the number values in {list}.
4964 Examples: >
4965 list2blob([1, 2, 3, 4]) returns 0z01020304
4966 list2blob([]) returns 0z
4967< Returns an empty Blob on error. If one of the numbers is
4968 negative or more than 255 error *E1239* is given.
4969
4970 |blob2list()| does the opposite.
4971
4972 Can also be used as a |method|: >
4973 GetList()->list2blob()
4974
4975list2str({list} [, {utf8}]) *list2str()*
4976 Convert each number in {list} to a character string can
4977 concatenate them all. Examples: >
4978 list2str([32]) returns " "
4979 list2str([65, 66, 67]) returns "ABC"
4980< The same can be done (slowly) with: >
4981 join(map(list, {nr, val -> nr2char(val)}), '')
4982< |str2list()| does the opposite.
4983
4984 When {utf8} is omitted or zero, the current 'encoding' is used.
4985 When {utf8} is TRUE, always return UTF-8 characters.
4986 With UTF-8 composing characters work as expected: >
4987 list2str([97, 769]) returns "á"
4988<
4989 Can also be used as a |method|: >
4990 GetList()->list2str()
4991
4992listener_add({callback} [, {buf}]) *listener_add()*
4993 Add a callback function that will be invoked when changes have
4994 been made to buffer {buf}.
4995 {buf} refers to a buffer name or number. For the accepted
4996 values, see |bufname()|. When {buf} is omitted the current
4997 buffer is used.
4998 Returns a unique ID that can be passed to |listener_remove()|.
4999
5000 The {callback} is invoked with five arguments:
5001 a:bufnr the buffer that was changed
5002 a:start first changed line number
5003 a:end first line number below the change
5004 a:added number of lines added, negative if lines were
5005 deleted
5006 a:changes a List of items with details about the changes
5007
5008 Example: >
5009 func Listener(bufnr, start, end, added, changes)
5010 echo 'lines ' .. a:start .. ' until ' .. a:end .. ' changed'
5011 endfunc
5012 call listener_add('Listener', bufnr)
5013
5014< The List cannot be changed. Each item in a:changes is a
5015 dictionary with these entries:
5016 lnum the first line number of the change
5017 end the first line below the change
5018 added number of lines added; negative if lines were
5019 deleted
5020 col first column in "lnum" that was affected by
5021 the change; one if unknown or the whole line
5022 was affected; this is a byte index, first
5023 character has a value of one.
5024 When lines are inserted the values are:
5025 lnum line above which the new line is added
5026 end equal to "lnum"
5027 added number of lines inserted
5028 col 1
5029 When lines are deleted the values are:
5030 lnum the first deleted line
5031 end the line below the first deleted line, before
5032 the deletion was done
5033 added negative, number of lines deleted
5034 col 1
5035 When lines are changed:
5036 lnum the first changed line
5037 end the line below the last changed line
5038 added 0
5039 col first column with a change or 1
5040
5041 The entries are in the order the changes were made, thus the
5042 most recent change is at the end. The line numbers are valid
5043 when the callback is invoked, but later changes may make them
5044 invalid, thus keeping a copy for later might not work.
5045
5046 The {callback} is invoked just before the screen is updated,
5047 when |listener_flush()| is called or when a change is being
5048 made that changes the line count in a way it causes a line
5049 number in the list of changes to become invalid.
5050
5051 The {callback} is invoked with the text locked, see
5052 |textlock|. If you do need to make changes to the buffer, use
5053 a timer to do this later |timer_start()|.
5054
5055 The {callback} is not invoked when the buffer is first loaded.
5056 Use the |BufReadPost| autocmd event to handle the initial text
5057 of a buffer.
5058 The {callback} is also not invoked when the buffer is
5059 unloaded, use the |BufUnload| autocmd event for that.
5060
5061 Can also be used as a |method|, the base is passed as the
5062 second argument: >
5063 GetBuffer()->listener_add(callback)
5064
5065listener_flush([{buf}]) *listener_flush()*
5066 Invoke listener callbacks for buffer {buf}. If there are no
5067 pending changes then no callbacks are invoked.
5068
5069 {buf} refers to a buffer name or number. For the accepted
5070 values, see |bufname()|. When {buf} is omitted the current
5071 buffer is used.
5072
5073 Can also be used as a |method|: >
5074 GetBuffer()->listener_flush()
5075
5076listener_remove({id}) *listener_remove()*
5077 Remove a listener previously added with listener_add().
5078 Returns FALSE when {id} could not be found, TRUE when {id} was
5079 removed.
5080
5081 Can also be used as a |method|: >
5082 GetListenerId()->listener_remove()
5083
5084localtime() *localtime()*
5085 Return the current time, measured as seconds since 1st Jan
5086 1970. See also |strftime()|, |strptime()| and |getftime()|.
5087
5088
5089log({expr}) *log()*
5090 Return the natural logarithm (base e) of {expr} as a |Float|.
5091 {expr} must evaluate to a |Float| or a |Number| in the range
5092 (0, inf].
5093 Examples: >
5094 :echo log(10)
5095< 2.302585 >
5096 :echo log(exp(5))
5097< 5.0
5098
5099 Can also be used as a |method|: >
5100 Compute()->log()
5101<
5102 {only available when compiled with the |+float| feature}
5103
5104
5105log10({expr}) *log10()*
5106 Return the logarithm of Float {expr} to base 10 as a |Float|.
5107 {expr} must evaluate to a |Float| or a |Number|.
5108 Examples: >
5109 :echo log10(1000)
5110< 3.0 >
5111 :echo log10(0.01)
5112< -2.0
5113
5114 Can also be used as a |method|: >
5115 Compute()->log10()
5116<
5117 {only available when compiled with the |+float| feature}
5118
5119luaeval({expr} [, {expr}]) *luaeval()*
5120 Evaluate Lua expression {expr} and return its result converted
5121 to Vim data structures. Second {expr} may hold additional
5122 argument accessible as _A inside first {expr}.
5123 Strings are returned as they are.
5124 Boolean objects are converted to numbers.
5125 Numbers are converted to |Float| values if vim was compiled
5126 with |+float| and to numbers otherwise.
5127 Dictionaries and lists obtained by vim.eval() are returned
5128 as-is.
5129 Other objects are returned as zero without any errors.
5130 See |lua-luaeval| for more details.
5131 Note that in a `:def` function local variables are not visible
5132 to {expr}.
5133
5134 Can also be used as a |method|: >
5135 GetExpr()->luaeval()
5136
5137< {only available when compiled with the |+lua| feature}
5138
5139map({expr1}, {expr2}) *map()*
5140 {expr1} must be a |List|, |String|, |Blob| or |Dictionary|.
5141 When {expr1} is a |List|| or |Dictionary|, replace each
5142 item in {expr1} with the result of evaluating {expr2}.
5143 For a |Blob| each byte is replaced.
5144 For a |String|, each character, including composing
5145 characters, is replaced.
5146 If the item type changes you may want to use |mapnew()| to
5147 create a new List or Dictionary. This is required when using
5148 Vim9 script.
5149
5150 {expr2} must be a |String| or |Funcref|.
5151
5152 If {expr2} is a |String|, inside {expr2} |v:val| has the value
5153 of the current item. For a |Dictionary| |v:key| has the key
5154 of the current item and for a |List| |v:key| has the index of
5155 the current item. For a |Blob| |v:key| has the index of the
5156 current byte. For a |String| |v:key| has the index of the
5157 current character.
5158 Example: >
5159 :call map(mylist, '"> " . v:val . " <"')
5160< This puts "> " before and " <" after each item in "mylist".
5161
5162 Note that {expr2} is the result of an expression and is then
5163 used as an expression again. Often it is good to use a
5164 |literal-string| to avoid having to double backslashes. You
5165 still have to double ' quotes
5166
5167 If {expr2} is a |Funcref| it is called with two arguments:
5168 1. The key or the index of the current item.
5169 2. the value of the current item.
5170 The function must return the new value of the item. Example
5171 that changes each value by "key-value": >
5172 func KeyValue(key, val)
5173 return a:key . '-' . a:val
5174 endfunc
5175 call map(myDict, function('KeyValue'))
5176< It is shorter when using a |lambda|: >
5177 call map(myDict, {key, val -> key . '-' . val})
5178< If you do not use "val" you can leave it out: >
5179 call map(myDict, {key -> 'item: ' . key})
5180< If you do not use "key" you can use a short name: >
5181 call map(myDict, {_, val -> 'item: ' . val})
5182<
5183 The operation is done in-place for a |List| and |Dictionary|.
5184 If you want it to remain unmodified make a copy first: >
5185 :let tlist = map(copy(mylist), ' v:val . "\t"')
5186
5187< Returns {expr1}, the |List| or |Dictionary| that was filtered,
5188 or a new |Blob| or |String|.
5189 When an error is encountered while evaluating {expr2} no
5190 further items in {expr1} are processed.
5191 When {expr2} is a Funcref errors inside a function are ignored,
5192 unless it was defined with the "abort" flag.
5193
5194 Can also be used as a |method|: >
5195 mylist->map(expr2)
5196
5197
5198maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()*
5199 When {dict} is omitted or zero: Return the rhs of mapping
5200 {name} in mode {mode}. The returned String has special
5201 characters translated like in the output of the ":map" command
5202 listing.
5203
5204 When there is no mapping for {name}, an empty String is
5205 returned. When the mapping for {name} is empty, then "<Nop>"
5206 is returned.
5207
5208 The {name} can have special key names, like in the ":map"
5209 command.
5210
5211 {mode} can be one of these strings:
5212 "n" Normal
5213 "v" Visual (including Select)
5214 "o" Operator-pending
5215 "i" Insert
5216 "c" Cmd-line
5217 "s" Select
5218 "x" Visual
5219 "l" langmap |language-mapping|
5220 "t" Terminal-Job
5221 "" Normal, Visual and Operator-pending
5222 When {mode} is omitted, the modes for "" are used.
5223
5224 When {abbr} is there and it is |TRUE| use abbreviations
5225 instead of mappings.
5226
5227 When {dict} is there and it is |TRUE| return a dictionary
5228 containing all the information of the mapping with the
5229 following items:
5230 "lhs" The {lhs} of the mapping as it would be typed
5231 "lhsraw" The {lhs} of the mapping as raw bytes
5232 "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate
5233 form, only present when it differs from "lhsraw"
5234 "rhs" The {rhs} of the mapping as typed.
5235 "silent" 1 for a |:map-silent| mapping, else 0.
5236 "noremap" 1 if the {rhs} of the mapping is not remappable.
5237 "script" 1 if mapping was defined with <script>.
5238 "expr" 1 for an expression mapping (|:map-<expr>|).
5239 "buffer" 1 for a buffer local mapping (|:map-local|).
5240 "mode" Modes for which the mapping is defined. In
5241 addition to the modes mentioned above, these
5242 characters will be used:
5243 " " Normal, Visual and Operator-pending
5244 "!" Insert and Commandline mode
5245 (|mapmode-ic|)
5246 "sid" The script local ID, used for <sid> mappings
5247 (|<SID>|).
Bram Moolenaara9528b32022-01-18 20:51:35 +00005248 "scriptversion" The version of the script. 999999 for
5249 |Vim9| script.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005250 "lnum" The line number in "sid", zero if unknown.
5251 "nowait" Do not wait for other, longer mappings.
5252 (|:map-<nowait>|).
5253
5254 The dictionary can be used to restore a mapping with
5255 |mapset()|.
5256
5257 The mappings local to the current buffer are checked first,
5258 then the global mappings.
5259 This function can be used to map a key even when it's already
5260 mapped, and have it do the original mapping too. Sketch: >
5261 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n')
5262
5263< Can also be used as a |method|: >
5264 GetKey()->maparg('n')
5265
5266mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()*
5267 Check if there is a mapping that matches with {name} in mode
5268 {mode}. See |maparg()| for {mode} and special names in
5269 {name}.
5270 When {abbr} is there and it is |TRUE| use abbreviations
5271 instead of mappings.
5272 A match happens with a mapping that starts with {name} and
5273 with a mapping which is equal to the start of {name}.
5274
5275 matches mapping "a" "ab" "abc" ~
5276 mapcheck("a") yes yes yes
5277 mapcheck("abc") yes yes yes
5278 mapcheck("ax") yes no no
5279 mapcheck("b") no no no
5280
5281 The difference with maparg() is that mapcheck() finds a
5282 mapping that matches with {name}, while maparg() only finds a
5283 mapping for {name} exactly.
5284 When there is no mapping that starts with {name}, an empty
5285 String is returned. If there is one, the RHS of that mapping
5286 is returned. If there are several mappings that start with
5287 {name}, the RHS of one of them is returned. This will be
5288 "<Nop>" if the RHS is empty.
5289 The mappings local to the current buffer are checked first,
5290 then the global mappings.
5291 This function can be used to check if a mapping can be added
5292 without being ambiguous. Example: >
5293 :if mapcheck("_vv") == ""
5294 : map _vv :set guifont=7x13<CR>
5295 :endif
5296< This avoids adding the "_vv" mapping when there already is a
5297 mapping for "_v" or for "_vvv".
5298
5299 Can also be used as a |method|: >
5300 GetKey()->mapcheck('n')
5301
5302
5303mapnew({expr1}, {expr2}) *mapnew()*
5304 Like |map()| but instead of replacing items in {expr1} a new
5305 List or Dictionary is created and returned. {expr1} remains
5306 unchanged. Items can still be changed by {expr2}, if you
5307 don't want that use |deepcopy()| first.
5308
5309
5310mapset({mode}, {abbr}, {dict}) *mapset()*
5311 Restore a mapping from a dictionary returned by |maparg()|.
5312 {mode} and {abbr} should be the same as for the call to
5313 |maparg()|. *E460*
5314 {mode} is used to define the mode in which the mapping is set,
5315 not the "mode" entry in {dict}.
5316 Example for saving and restoring a mapping: >
5317 let save_map = maparg('K', 'n', 0, 1)
5318 nnoremap K somethingelse
5319 ...
5320 call mapset('n', 0, save_map)
5321< Note that if you are going to replace a map in several modes,
5322 e.g. with `:map!`, you need to save the mapping for all of
5323 them, since they can differ.
5324
5325
5326match({expr}, {pat} [, {start} [, {count}]]) *match()*
5327 When {expr} is a |List| then this returns the index of the
5328 first item where {pat} matches. Each item is used as a
5329 String, |Lists| and |Dictionaries| are used as echoed.
5330
5331 Otherwise, {expr} is used as a String. The result is a
5332 Number, which gives the index (byte offset) in {expr} where
5333 {pat} matches.
5334
5335 A match at the first character or |List| item returns zero.
5336 If there is no match -1 is returned.
5337
5338 For getting submatches see |matchlist()|.
5339 Example: >
5340 :echo match("testing", "ing") " results in 4
5341 :echo match([1, 'x'], '\a') " results in 1
5342< See |string-match| for how {pat} is used.
5343 *strpbrk()*
5344 Vim doesn't have a strpbrk() function. But you can do: >
5345 :let sepidx = match(line, '[.,;: \t]')
5346< *strcasestr()*
5347 Vim doesn't have a strcasestr() function. But you can add
5348 "\c" to the pattern to ignore case: >
5349 :let idx = match(haystack, '\cneedle')
5350<
5351 If {start} is given, the search starts from byte index
5352 {start} in a String or item {start} in a |List|.
5353 The result, however, is still the index counted from the
5354 first character/item. Example: >
5355 :echo match("testing", "ing", 2)
5356< result is again "4". >
5357 :echo match("testing", "ing", 4)
5358< result is again "4". >
5359 :echo match("testing", "t", 2)
5360< result is "3".
5361 For a String, if {start} > 0 then it is like the string starts
5362 {start} bytes later, thus "^" will match at {start}. Except
5363 when {count} is given, then it's like matches before the
5364 {start} byte are ignored (this is a bit complicated to keep it
5365 backwards compatible).
5366 For a String, if {start} < 0, it will be set to 0. For a list
5367 the index is counted from the end.
5368 If {start} is out of range ({start} > strlen({expr}) for a
5369 String or {start} > len({expr}) for a |List|) -1 is returned.
5370
5371 When {count} is given use the {count}'th match. When a match
5372 is found in a String the search for the next one starts one
5373 character further. Thus this example results in 1: >
5374 echo match("testing", "..", 0, 2)
5375< In a |List| the search continues in the next item.
5376 Note that when {count} is added the way {start} works changes,
5377 see above.
5378
5379 See |pattern| for the patterns that are accepted.
5380 The 'ignorecase' option is used to set the ignore-caseness of
5381 the pattern. 'smartcase' is NOT used. The matching is always
5382 done like 'magic' is set and 'cpoptions' is empty.
5383 Note that a match at the start is preferred, thus when the
5384 pattern is using "*" (any number of matches) it tends to find
5385 zero matches at the start instead of a number of matches
5386 further down in the text.
5387
5388 Can also be used as a |method|: >
5389 GetText()->match('word')
5390 GetList()->match('word')
5391<
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00005392 *matchadd()* *E290* *E798* *E799* *E801* *E957*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005393matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
5394 Defines a pattern to be highlighted in the current window (a
5395 "match"). It will be highlighted with {group}. Returns an
5396 identification number (ID), which can be used to delete the
5397 match using |matchdelete()|. The ID is bound to the window.
5398 Matching is case sensitive and magic, unless case sensitivity
5399 or magicness are explicitly overridden in {pattern}. The
5400 'magic', 'smartcase' and 'ignorecase' options are not used.
5401 The "Conceal" value is special, it causes the match to be
5402 concealed.
5403
5404 The optional {priority} argument assigns a priority to the
5405 match. A match with a high priority will have its
5406 highlighting overrule that of a match with a lower priority.
5407 A priority is specified as an integer (negative numbers are no
5408 exception). If the {priority} argument is not specified, the
5409 default priority is 10. The priority of 'hlsearch' is zero,
5410 hence all matches with a priority greater than zero will
5411 overrule it. Syntax highlighting (see 'syntax') is a separate
5412 mechanism, and regardless of the chosen priority a match will
5413 always overrule syntax highlighting.
5414
5415 The optional {id} argument allows the request for a specific
5416 match ID. If a specified ID is already taken, an error
5417 message will appear and the match will not be added. An ID
5418 is specified as a positive integer (zero excluded). IDs 1, 2
5419 and 3 are reserved for |:match|, |:2match| and |:3match|,
5420 respectively. If the {id} argument is not specified or -1,
5421 |matchadd()| automatically chooses a free ID.
5422
5423 The optional {dict} argument allows for further custom
5424 values. Currently this is used to specify a match specific
5425 conceal character that will be shown for |hl-Conceal|
5426 highlighted matches. The dict can have the following members:
5427
5428 conceal Special character to show instead of the
5429 match (only for |hl-Conceal| highlighted
5430 matches, see |:syn-cchar|)
5431 window Instead of the current window use the
5432 window with this number or window ID.
5433
5434 The number of matches is not limited, as it is the case with
5435 the |:match| commands.
5436
5437 Example: >
5438 :highlight MyGroup ctermbg=green guibg=green
5439 :let m = matchadd("MyGroup", "TODO")
5440< Deletion of the pattern: >
5441 :call matchdelete(m)
5442
5443< A list of matches defined by |matchadd()| and |:match| are
5444 available from |getmatches()|. All matches can be deleted in
5445 one operation by |clearmatches()|.
5446
5447 Can also be used as a |method|: >
5448 GetGroup()->matchadd('TODO')
5449<
5450 *matchaddpos()*
5451matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
5452 Same as |matchadd()|, but requires a list of positions {pos}
5453 instead of a pattern. This command is faster than |matchadd()|
5454 because it does not require to handle regular expressions and
5455 sets buffer line boundaries to redraw screen. It is supposed
5456 to be used when fast match additions and deletions are
5457 required, for example to highlight matching parentheses.
5458
5459 {pos} is a list of positions. Each position can be one of
5460 these:
5461 - A number. This whole line will be highlighted. The first
5462 line has number 1.
5463 - A list with one number, e.g., [23]. The whole line with this
5464 number will be highlighted.
5465 - A list with two numbers, e.g., [23, 11]. The first number is
5466 the line number, the second one is the column number (first
5467 column is 1, the value must correspond to the byte index as
5468 |col()| would return). The character at this position will
5469 be highlighted.
5470 - A list with three numbers, e.g., [23, 11, 3]. As above, but
5471 the third number gives the length of the highlight in bytes.
5472
5473 The maximum number of positions in {pos} is 8.
5474
5475 Example: >
5476 :highlight MyGroup ctermbg=green guibg=green
5477 :let m = matchaddpos("MyGroup", [[23, 24], 34])
5478< Deletion of the pattern: >
5479 :call matchdelete(m)
5480
5481< Matches added by |matchaddpos()| are returned by
5482 |getmatches()|.
5483
5484 Can also be used as a |method|: >
5485 GetGroup()->matchaddpos([23, 11])
5486
5487matcharg({nr}) *matcharg()*
5488 Selects the {nr} match item, as set with a |:match|,
5489 |:2match| or |:3match| command.
5490 Return a |List| with two elements:
5491 The name of the highlight group used
5492 The pattern used.
5493 When {nr} is not 1, 2 or 3 returns an empty |List|.
5494 When there is no match item set returns ['', ''].
5495 This is useful to save and restore a |:match|.
5496 Highlighting matches using the |:match| commands are limited
5497 to three matches. |matchadd()| does not have this limitation.
5498
5499 Can also be used as a |method|: >
5500 GetMatch()->matcharg()
5501
5502matchdelete({id} [, {win}) *matchdelete()* *E802* *E803*
5503 Deletes a match with ID {id} previously defined by |matchadd()|
5504 or one of the |:match| commands. Returns 0 if successful,
5505 otherwise -1. See example for |matchadd()|. All matches can
5506 be deleted in one operation by |clearmatches()|.
5507 If {win} is specified, use the window with this number or
5508 window ID instead of the current window.
5509
5510 Can also be used as a |method|: >
5511 GetMatch()->matchdelete()
5512
5513matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()*
5514 Same as |match()|, but return the index of first character
5515 after the match. Example: >
5516 :echo matchend("testing", "ing")
5517< results in "7".
5518 *strspn()* *strcspn()*
5519 Vim doesn't have a strspn() or strcspn() function, but you can
5520 do it with matchend(): >
5521 :let span = matchend(line, '[a-zA-Z]')
5522 :let span = matchend(line, '[^a-zA-Z]')
5523< Except that -1 is returned when there are no matches.
5524
5525 The {start}, if given, has the same meaning as for |match()|. >
5526 :echo matchend("testing", "ing", 2)
5527< results in "7". >
5528 :echo matchend("testing", "ing", 5)
5529< result is "-1".
5530 When {expr} is a |List| the result is equal to |match()|.
5531
5532 Can also be used as a |method|: >
5533 GetText()->matchend('word')
5534
5535
5536matchfuzzy({list}, {str} [, {dict}]) *matchfuzzy()*
5537 If {list} is a list of strings, then returns a |List| with all
5538 the strings in {list} that fuzzy match {str}. The strings in
5539 the returned list are sorted based on the matching score.
5540
5541 The optional {dict} argument always supports the following
5542 items:
5543 matchseq When this item is present and {str} contains
5544 multiple words separated by white space, then
5545 returns only matches that contain the words in
5546 the given sequence.
5547
5548 If {list} is a list of dictionaries, then the optional {dict}
5549 argument supports the following additional items:
5550 key key of the item which is fuzzy matched against
5551 {str}. The value of this item should be a
5552 string.
5553 text_cb |Funcref| that will be called for every item
5554 in {list} to get the text for fuzzy matching.
5555 This should accept a dictionary item as the
5556 argument and return the text for that item to
5557 use for fuzzy matching.
5558
5559 {str} is treated as a literal string and regular expression
5560 matching is NOT supported. The maximum supported {str} length
5561 is 256.
5562
5563 When {str} has multiple words each separated by white space,
5564 then the list of strings that have all the words is returned.
5565
5566 If there are no matching strings or there is an error, then an
5567 empty list is returned. If length of {str} is greater than
5568 256, then returns an empty list.
5569
5570 Refer to |fuzzy-match| for more information about fuzzy
5571 matching strings.
5572
5573 Example: >
5574 :echo matchfuzzy(["clay", "crow"], "cay")
5575< results in ["clay"]. >
5576 :echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl")
5577< results in a list of buffer names fuzzy matching "ndl". >
5578 :echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'})
5579< results in a list of buffer information dicts with buffer
5580 names fuzzy matching "ndl". >
5581 :echo getbufinfo()->matchfuzzy("spl",
5582 \ {'text_cb' : {v -> v.name}})
5583< results in a list of buffer information dicts with buffer
5584 names fuzzy matching "spl". >
5585 :echo v:oldfiles->matchfuzzy("test")
5586< results in a list of file names fuzzy matching "test". >
5587 :let l = readfile("buffer.c")->matchfuzzy("str")
5588< results in a list of lines in "buffer.c" fuzzy matching "str". >
5589 :echo ['one two', 'two one']->matchfuzzy('two one')
5590< results in ['two one', 'one two']. >
5591 :echo ['one two', 'two one']->matchfuzzy('two one',
5592 \ {'matchseq': 1})
5593< results in ['two one'].
5594
5595matchfuzzypos({list}, {str} [, {dict}]) *matchfuzzypos()*
5596 Same as |matchfuzzy()|, but returns the list of matched
5597 strings, the list of character positions where characters
5598 in {str} matches and a list of matching scores. You can
5599 use |byteidx()| to convert a character position to a byte
5600 position.
5601
5602 If {str} matches multiple times in a string, then only the
5603 positions for the best match is returned.
5604
5605 If there are no matching strings or there is an error, then a
5606 list with three empty list items is returned.
5607
5608 Example: >
5609 :echo matchfuzzypos(['testing'], 'tsg')
5610< results in [['testing'], [[0, 2, 6]], [99]] >
5611 :echo matchfuzzypos(['clay', 'lacy'], 'la')
5612< results in [['lacy', 'clay'], [[0, 1], [1, 2]], [153, 133]] >
5613 :echo [{'text': 'hello', 'id' : 10}]->matchfuzzypos('ll', {'key' : 'text'})
5614< results in [[{'id': 10, 'text': 'hello'}], [[2, 3]], [127]]
5615
5616matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()*
5617 Same as |match()|, but return a |List|. The first item in the
5618 list is the matched string, same as what matchstr() would
5619 return. Following items are submatches, like "\1", "\2", etc.
5620 in |:substitute|. When an optional submatch didn't match an
5621 empty string is used. Example: >
5622 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
5623< Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
5624 When there is no match an empty list is returned.
5625
5626 You can pass in a List, but that is not very useful.
5627
5628 Can also be used as a |method|: >
5629 GetText()->matchlist('word')
5630
5631matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()*
5632 Same as |match()|, but return the matched string. Example: >
5633 :echo matchstr("testing", "ing")
5634< results in "ing".
5635 When there is no match "" is returned.
5636 The {start}, if given, has the same meaning as for |match()|. >
5637 :echo matchstr("testing", "ing", 2)
5638< results in "ing". >
5639 :echo matchstr("testing", "ing", 5)
5640< result is "".
5641 When {expr} is a |List| then the matching item is returned.
5642 The type isn't changed, it's not necessarily a String.
5643
5644 Can also be used as a |method|: >
5645 GetText()->matchstr('word')
5646
5647matchstrpos({expr}, {pat} [, {start} [, {count}]]) *matchstrpos()*
5648 Same as |matchstr()|, but return the matched string, the start
5649 position and the end position of the match. Example: >
5650 :echo matchstrpos("testing", "ing")
5651< results in ["ing", 4, 7].
5652 When there is no match ["", -1, -1] is returned.
5653 The {start}, if given, has the same meaning as for |match()|. >
5654 :echo matchstrpos("testing", "ing", 2)
5655< results in ["ing", 4, 7]. >
5656 :echo matchstrpos("testing", "ing", 5)
5657< result is ["", -1, -1].
5658 When {expr} is a |List| then the matching item, the index
5659 of first item where {pat} matches, the start position and the
5660 end position of the match are returned. >
5661 :echo matchstrpos([1, '__x'], '\a')
5662< result is ["x", 1, 2, 3].
5663 The type isn't changed, it's not necessarily a String.
5664
5665 Can also be used as a |method|: >
5666 GetText()->matchstrpos('word')
5667<
5668
5669 *max()*
5670max({expr}) Return the maximum value of all items in {expr}. Example: >
5671 echo max([apples, pears, oranges])
5672
5673< {expr} can be a |List| or a |Dictionary|. For a Dictionary,
5674 it returns the maximum of all values in the Dictionary.
5675 If {expr} is neither a List nor a Dictionary, or one of the
5676 items in {expr} cannot be used as a Number this results in
5677 an error. An empty |List| or |Dictionary| results in zero.
5678
5679 Can also be used as a |method|: >
5680 mylist->max()
5681
5682
5683menu_info({name} [, {mode}]) *menu_info()*
5684 Return information about the specified menu {name} in
5685 mode {mode}. The menu name should be specified without the
5686 shortcut character ('&'). If {name} is "", then the top-level
5687 menu names are returned.
5688
5689 {mode} can be one of these strings:
5690 "n" Normal
5691 "v" Visual (including Select)
5692 "o" Operator-pending
5693 "i" Insert
5694 "c" Cmd-line
5695 "s" Select
5696 "x" Visual
5697 "t" Terminal-Job
5698 "" Normal, Visual and Operator-pending
5699 "!" Insert and Cmd-line
5700 When {mode} is omitted, the modes for "" are used.
5701
5702 Returns a |Dictionary| containing the following items:
5703 accel menu item accelerator text |menu-text|
5704 display display name (name without '&')
5705 enabled v:true if this menu item is enabled
5706 Refer to |:menu-enable|
5707 icon name of the icon file (for toolbar)
5708 |toolbar-icon|
5709 iconidx index of a built-in icon
5710 modes modes for which the menu is defined. In
5711 addition to the modes mentioned above, these
5712 characters will be used:
5713 " " Normal, Visual and Operator-pending
5714 name menu item name.
5715 noremenu v:true if the {rhs} of the menu item is not
5716 remappable else v:false.
5717 priority menu order priority |menu-priority|
5718 rhs right-hand-side of the menu item. The returned
5719 string has special characters translated like
5720 in the output of the ":menu" command listing.
5721 When the {rhs} of a menu item is empty, then
5722 "<Nop>" is returned.
5723 script v:true if script-local remapping of {rhs} is
5724 allowed else v:false. See |:menu-script|.
5725 shortcut shortcut key (character after '&' in
5726 the menu name) |menu-shortcut|
5727 silent v:true if the menu item is created
5728 with <silent> argument |:menu-silent|
5729 submenus |List| containing the names of
5730 all the submenus. Present only if the menu
5731 item has submenus.
5732
5733 Returns an empty dictionary if the menu item is not found.
5734
5735 Examples: >
5736 :echo menu_info('Edit.Cut')
5737 :echo menu_info('File.Save', 'n')
5738
5739 " Display the entire menu hierarchy in a buffer
5740 func ShowMenu(name, pfx)
5741 let m = menu_info(a:name)
5742 call append(line('$'), a:pfx .. m.display)
5743 for child in m->get('submenus', [])
5744 call ShowMenu(a:name .. '.' .. escape(child, '.'),
5745 \ a:pfx .. ' ')
5746 endfor
5747 endfunc
5748 new
5749 for topmenu in menu_info('').submenus
5750 call ShowMenu(topmenu, '')
5751 endfor
5752<
5753 Can also be used as a |method|: >
5754 GetMenuName()->menu_info('v')
5755
5756
5757< *min()*
5758min({expr}) Return the minimum value of all items in {expr}. Example: >
5759 echo min([apples, pears, oranges])
5760
5761< {expr} can be a |List| or a |Dictionary|. For a Dictionary,
5762 it returns the minimum of all values in the Dictionary.
5763 If {expr} is neither a List nor a Dictionary, or one of the
5764 items in {expr} cannot be used as a Number this results in
5765 an error. An empty |List| or |Dictionary| results in zero.
5766
5767 Can also be used as a |method|: >
5768 mylist->min()
5769
5770< *mkdir()* *E739*
5771mkdir({name} [, {path} [, {prot}]])
5772 Create directory {name}.
5773
5774 If {path} is "p" then intermediate directories are created as
5775 necessary. Otherwise it must be "".
5776
5777 If {prot} is given it is used to set the protection bits of
5778 the new directory. The default is 0o755 (rwxr-xr-x: r/w for
5779 the user, readable for others). Use 0o700 to make it
5780 unreadable for others. This is only used for the last part of
5781 {name}. Thus if you create /tmp/foo/bar then /tmp/foo will be
5782 created with 0o755.
5783 Example: >
5784 :call mkdir($HOME . "/tmp/foo/bar", "p", 0o700)
5785
5786< This function is not available in the |sandbox|.
5787
5788 There is no error if the directory already exists and the "p"
5789 flag is passed (since patch 8.0.1708). However, without the
5790 "p" option the call will fail.
5791
5792 The function result is a Number, which is TRUE if the call was
5793 successful or FALSE if the directory creation failed or partly
5794 failed.
5795
5796 Not available on all systems. To check use: >
5797 :if exists("*mkdir")
5798
5799< Can also be used as a |method|: >
5800 GetName()->mkdir()
5801<
5802 *mode()*
5803mode([expr]) Return a string that indicates the current mode.
5804 If [expr] is supplied and it evaluates to a non-zero Number or
5805 a non-empty String (|non-zero-arg|), then the full mode is
5806 returned, otherwise only the first letter is returned.
5807 Also see |state()|.
5808
5809 n Normal
5810 no Operator-pending
5811 nov Operator-pending (forced characterwise |o_v|)
5812 noV Operator-pending (forced linewise |o_V|)
5813 noCTRL-V Operator-pending (forced blockwise |o_CTRL-V|);
5814 CTRL-V is one character
5815 niI Normal using |i_CTRL-O| in |Insert-mode|
5816 niR Normal using |i_CTRL-O| in |Replace-mode|
5817 niV Normal using |i_CTRL-O| in |Virtual-Replace-mode|
5818 nt Terminal-Normal (insert goes to Terminal-Job mode)
5819 v Visual by character
5820 vs Visual by character using |v_CTRL-O| in Select mode
5821 V Visual by line
5822 Vs Visual by line using |v_CTRL-O| in Select mode
5823 CTRL-V Visual blockwise
5824 CTRL-Vs Visual blockwise using |v_CTRL-O| in Select mode
5825 s Select by character
5826 S Select by line
5827 CTRL-S Select blockwise
5828 i Insert
5829 ic Insert mode completion |compl-generic|
5830 ix Insert mode |i_CTRL-X| completion
5831 R Replace |R|
5832 Rc Replace mode completion |compl-generic|
5833 Rx Replace mode |i_CTRL-X| completion
5834 Rv Virtual Replace |gR|
5835 Rvc Virtual Replace mode completion |compl-generic|
5836 Rvx Virtual Replace mode |i_CTRL-X| completion
5837 c Command-line editing
5838 cv Vim Ex mode |gQ|
5839 ce Normal Ex mode |Q|
5840 r Hit-enter prompt
5841 rm The -- more -- prompt
5842 r? A |:confirm| query of some sort
5843 ! Shell or external command is executing
5844 t Terminal-Job mode: keys go to the job
5845
5846 This is useful in the 'statusline' option or when used
5847 with |remote_expr()| In most other places it always returns
5848 "c" or "n".
5849 Note that in the future more modes and more specific modes may
5850 be added. It's better not to compare the whole string but only
5851 the leading character(s).
5852 Also see |visualmode()|.
5853
5854 Can also be used as a |method|: >
5855 DoFull()->mode()
5856
5857mzeval({expr}) *mzeval()*
5858 Evaluate MzScheme expression {expr} and return its result
5859 converted to Vim data structures.
5860 Numbers and strings are returned as they are.
5861 Pairs (including lists and improper lists) and vectors are
5862 returned as Vim |Lists|.
5863 Hash tables are represented as Vim |Dictionary| type with keys
5864 converted to strings.
5865 All other types are converted to string with display function.
5866 Examples: >
5867 :mz (define l (list 1 2 3))
5868 :mz (define h (make-hash)) (hash-set! h "list" l)
5869 :echo mzeval("l")
5870 :echo mzeval("h")
5871<
5872 Note that in a `:def` function local variables are not visible
5873 to {expr}.
5874
5875 Can also be used as a |method|: >
5876 GetExpr()->mzeval()
5877<
5878 {only available when compiled with the |+mzscheme| feature}
5879
5880nextnonblank({lnum}) *nextnonblank()*
5881 Return the line number of the first line at or below {lnum}
5882 that is not blank. Example: >
5883 if getline(nextnonblank(1)) =~ "Java"
5884< When {lnum} is invalid or there is no non-blank line at or
5885 below it, zero is returned.
5886 {lnum} is used like with |getline()|.
5887 See also |prevnonblank()|.
5888
5889 Can also be used as a |method|: >
5890 GetLnum()->nextnonblank()
5891
5892nr2char({expr} [, {utf8}]) *nr2char()*
5893 Return a string with a single character, which has the number
5894 value {expr}. Examples: >
5895 nr2char(64) returns "@"
5896 nr2char(32) returns " "
5897< When {utf8} is omitted or zero, the current 'encoding' is used.
5898 Example for "utf-8": >
5899 nr2char(300) returns I with bow character
5900< When {utf8} is TRUE, always return UTF-8 characters.
5901 Note that a NUL character in the file is specified with
5902 nr2char(10), because NULs are represented with newline
5903 characters. nr2char(0) is a real NUL and terminates the
5904 string, thus results in an empty string.
5905 To turn a list of character numbers into a string: >
5906 let list = [65, 66, 67]
5907 let str = join(map(list, {_, val -> nr2char(val)}), '')
5908< Result: "ABC"
5909
5910 Can also be used as a |method|: >
5911 GetNumber()->nr2char()
5912
5913or({expr}, {expr}) *or()*
5914 Bitwise OR on the two arguments. The arguments are converted
5915 to a number. A List, Dict or Float argument causes an error.
5916 Example: >
5917 :let bits = or(bits, 0x80)
5918< Can also be used as a |method|: >
5919 :let bits = bits->or(0x80)
5920
5921
5922pathshorten({path} [, {len}]) *pathshorten()*
5923 Shorten directory names in the path {path} and return the
5924 result. The tail, the file name, is kept as-is. The other
5925 components in the path are reduced to {len} letters in length.
5926 If {len} is omitted or smaller than 1 then 1 is used (single
5927 letters). Leading '~' and '.' characters are kept. Examples: >
5928 :echo pathshorten('~/.vim/autoload/myfile.vim')
5929< ~/.v/a/myfile.vim ~
5930>
5931 :echo pathshorten('~/.vim/autoload/myfile.vim', 2)
5932< ~/.vi/au/myfile.vim ~
5933 It doesn't matter if the path exists or not.
5934
5935 Can also be used as a |method|: >
5936 GetDirectories()->pathshorten()
5937
5938perleval({expr}) *perleval()*
5939 Evaluate Perl expression {expr} in scalar context and return
5940 its result converted to Vim data structures. If value can't be
5941 converted, it is returned as a string Perl representation.
5942 Note: If you want an array or hash, {expr} must return a
5943 reference to it.
5944 Example: >
5945 :echo perleval('[1 .. 4]')
5946< [1, 2, 3, 4]
5947
5948 Note that in a `:def` function local variables are not visible
5949 to {expr}.
5950
5951 Can also be used as a |method|: >
5952 GetExpr()->perleval()
5953
5954< {only available when compiled with the |+perl| feature}
5955
5956
5957popup_ functions are documented here: |popup-functions|
5958
5959
5960pow({x}, {y}) *pow()*
5961 Return the power of {x} to the exponent {y} as a |Float|.
5962 {x} and {y} must evaluate to a |Float| or a |Number|.
5963 Examples: >
5964 :echo pow(3, 3)
5965< 27.0 >
5966 :echo pow(2, 16)
5967< 65536.0 >
5968 :echo pow(32, 0.20)
5969< 2.0
5970
5971 Can also be used as a |method|: >
5972 Compute()->pow(3)
5973<
5974 {only available when compiled with the |+float| feature}
5975
5976prevnonblank({lnum}) *prevnonblank()*
5977 Return the line number of the first line at or above {lnum}
5978 that is not blank. Example: >
5979 let ind = indent(prevnonblank(v:lnum - 1))
5980< When {lnum} is invalid or there is no non-blank line at or
5981 above it, zero is returned.
5982 {lnum} is used like with |getline()|.
5983 Also see |nextnonblank()|.
5984
5985 Can also be used as a |method|: >
5986 GetLnum()->prevnonblank()
5987
5988printf({fmt}, {expr1} ...) *printf()*
5989 Return a String with {fmt}, where "%" items are replaced by
5990 the formatted form of their respective arguments. Example: >
5991 printf("%4d: E%d %.30s", lnum, errno, msg)
5992< May result in:
5993 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
5994
5995 When used as a |method| the base is passed as the second
5996 argument: >
5997 Compute()->printf("result: %d")
5998
5999< Often used items are:
6000 %s string
6001 %6S string right-aligned in 6 display cells
6002 %6s string right-aligned in 6 bytes
6003 %.9s string truncated to 9 bytes
6004 %c single byte
6005 %d decimal number
6006 %5d decimal number padded with spaces to 5 characters
6007 %x hex number
6008 %04x hex number padded with zeros to at least 4 characters
6009 %X hex number using upper case letters
6010 %o octal number
6011 %08b binary number padded with zeros to at least 8 chars
6012 %f floating point number as 12.23, inf, -inf or nan
6013 %F floating point number as 12.23, INF, -INF or NAN
6014 %e floating point number as 1.23e3, inf, -inf or nan
6015 %E floating point number as 1.23E3, INF, -INF or NAN
6016 %g floating point number, as %f or %e depending on value
6017 %G floating point number, as %F or %E depending on value
6018 %% the % character itself
6019
6020 Conversion specifications start with '%' and end with the
6021 conversion type. All other characters are copied unchanged to
6022 the result.
6023
6024 The "%" starts a conversion specification. The following
6025 arguments appear in sequence:
6026
6027 % [flags] [field-width] [.precision] type
6028
6029 flags
6030 Zero or more of the following flags:
6031
6032 # The value should be converted to an "alternate
6033 form". For c, d, and s conversions, this option
6034 has no effect. For o conversions, the precision
6035 of the number is increased to force the first
6036 character of the output string to a zero (except
6037 if a zero value is printed with an explicit
6038 precision of zero).
6039 For b and B conversions, a non-zero result has
6040 the string "0b" (or "0B" for B conversions)
6041 prepended to it.
6042 For x and X conversions, a non-zero result has
6043 the string "0x" (or "0X" for X conversions)
6044 prepended to it.
6045
6046 0 (zero) Zero padding. For all conversions the converted
6047 value is padded on the left with zeros rather
6048 than blanks. If a precision is given with a
6049 numeric conversion (d, b, B, o, x, and X), the 0
6050 flag is ignored.
6051
6052 - A negative field width flag; the converted value
6053 is to be left adjusted on the field boundary.
6054 The converted value is padded on the right with
6055 blanks, rather than on the left with blanks or
6056 zeros. A - overrides a 0 if both are given.
6057
6058 ' ' (space) A blank should be left before a positive
6059 number produced by a signed conversion (d).
6060
6061 + A sign must always be placed before a number
6062 produced by a signed conversion. A + overrides
6063 a space if both are used.
6064
6065 field-width
6066 An optional decimal digit string specifying a minimum
6067 field width. If the converted value has fewer bytes
6068 than the field width, it will be padded with spaces on
6069 the left (or right, if the left-adjustment flag has
6070 been given) to fill out the field width. For the S
6071 conversion the count is in cells.
6072
6073 .precision
6074 An optional precision, in the form of a period '.'
6075 followed by an optional digit string. If the digit
6076 string is omitted, the precision is taken as zero.
6077 This gives the minimum number of digits to appear for
6078 d, o, x, and X conversions, the maximum number of
6079 bytes to be printed from a string for s conversions,
6080 or the maximum number of cells to be printed from a
6081 string for S conversions.
6082 For floating point it is the number of digits after
6083 the decimal point.
6084
6085 type
6086 A character that specifies the type of conversion to
6087 be applied, see below.
6088
6089 A field width or precision, or both, may be indicated by an
6090 asterisk '*' instead of a digit string. In this case, a
6091 Number argument supplies the field width or precision. A
6092 negative field width is treated as a left adjustment flag
6093 followed by a positive field width; a negative precision is
6094 treated as though it were missing. Example: >
6095 :echo printf("%d: %.*s", nr, width, line)
6096< This limits the length of the text used from "line" to
6097 "width" bytes.
6098
6099 The conversion specifiers and their meanings are:
6100
6101 *printf-d* *printf-b* *printf-B* *printf-o*
6102 *printf-x* *printf-X*
6103 dbBoxX The Number argument is converted to signed decimal
6104 (d), unsigned binary (b and B), unsigned octal (o), or
6105 unsigned hexadecimal (x and X) notation. The letters
6106 "abcdef" are used for x conversions; the letters
6107 "ABCDEF" are used for X conversions.
6108 The precision, if any, gives the minimum number of
6109 digits that must appear; if the converted value
6110 requires fewer digits, it is padded on the left with
6111 zeros.
6112 In no case does a non-existent or small field width
6113 cause truncation of a numeric field; if the result of
6114 a conversion is wider than the field width, the field
6115 is expanded to contain the conversion result.
6116 The 'h' modifier indicates the argument is 16 bits.
6117 The 'l' modifier indicates the argument is 32 bits.
6118 The 'L' modifier indicates the argument is 64 bits.
6119 Generally, these modifiers are not useful. They are
6120 ignored when type is known from the argument.
6121
6122 i alias for d
6123 D alias for ld
6124 U alias for lu
6125 O alias for lo
6126
6127 *printf-c*
6128 c The Number argument is converted to a byte, and the
6129 resulting character is written.
6130
6131 *printf-s*
6132 s The text of the String argument is used. If a
6133 precision is specified, no more bytes than the number
6134 specified are used.
6135 If the argument is not a String type, it is
6136 automatically converted to text with the same format
6137 as ":echo".
6138 *printf-S*
6139 S The text of the String argument is used. If a
6140 precision is specified, no more display cells than the
6141 number specified are used.
6142
6143 *printf-f* *E807*
6144 f F The Float argument is converted into a string of the
6145 form 123.456. The precision specifies the number of
6146 digits after the decimal point. When the precision is
6147 zero the decimal point is omitted. When the precision
6148 is not specified 6 is used. A really big number
6149 (out of range or dividing by zero) results in "inf"
6150 or "-inf" with %f (INF or -INF with %F).
6151 "0.0 / 0.0" results in "nan" with %f (NAN with %F).
6152 Example: >
6153 echo printf("%.2f", 12.115)
6154< 12.12
6155 Note that roundoff depends on the system libraries.
6156 Use |round()| when in doubt.
6157
6158 *printf-e* *printf-E*
6159 e E The Float argument is converted into a string of the
6160 form 1.234e+03 or 1.234E+03 when using 'E'. The
6161 precision specifies the number of digits after the
6162 decimal point, like with 'f'.
6163
6164 *printf-g* *printf-G*
6165 g G The Float argument is converted like with 'f' if the
6166 value is between 0.001 (inclusive) and 10000000.0
6167 (exclusive). Otherwise 'e' is used for 'g' and 'E'
6168 for 'G'. When no precision is specified superfluous
6169 zeroes and '+' signs are removed, except for the zero
6170 immediately after the decimal point. Thus 10000000.0
6171 results in 1.0e7.
6172
6173 *printf-%*
6174 % A '%' is written. No argument is converted. The
6175 complete conversion specification is "%%".
6176
6177 When a Number argument is expected a String argument is also
6178 accepted and automatically converted.
6179 When a Float or String argument is expected a Number argument
6180 is also accepted and automatically converted.
6181 Any other argument type results in an error message.
6182
6183 *E766* *E767*
6184 The number of {exprN} arguments must exactly match the number
6185 of "%" items. If there are not sufficient or too many
6186 arguments an error is given. Up to 18 arguments can be used.
6187
6188
6189prompt_getprompt({buf}) *prompt_getprompt()*
6190 Returns the effective prompt text for buffer {buf}. {buf} can
6191 be a buffer name or number. See |prompt-buffer|.
6192
6193 If the buffer doesn't exist or isn't a prompt buffer, an empty
6194 string is returned.
6195
6196 Can also be used as a |method|: >
6197 GetBuffer()->prompt_getprompt()
6198
6199< {only available when compiled with the |+channel| feature}
6200
6201
6202prompt_setcallback({buf}, {expr}) *prompt_setcallback()*
6203 Set prompt callback for buffer {buf} to {expr}. When {expr}
6204 is an empty string the callback is removed. This has only
6205 effect if {buf} has 'buftype' set to "prompt".
6206
6207 The callback is invoked when pressing Enter. The current
6208 buffer will always be the prompt buffer. A new line for a
6209 prompt is added before invoking the callback, thus the prompt
6210 for which the callback was invoked will be in the last but one
6211 line.
6212 If the callback wants to add text to the buffer, it must
6213 insert it above the last line, since that is where the current
6214 prompt is. This can also be done asynchronously.
6215 The callback is invoked with one argument, which is the text
6216 that was entered at the prompt. This can be an empty string
6217 if the user only typed Enter.
6218 Example: >
6219 call prompt_setcallback(bufnr(), function('s:TextEntered'))
6220 func s:TextEntered(text)
6221 if a:text == 'exit' || a:text == 'quit'
6222 stopinsert
6223 close
6224 else
6225 call append(line('$') - 1, 'Entered: "' . a:text . '"')
6226 " Reset 'modified' to allow the buffer to be closed.
6227 set nomodified
6228 endif
6229 endfunc
6230
6231< Can also be used as a |method|: >
6232 GetBuffer()->prompt_setcallback(callback)
6233
6234< {only available when compiled with the |+channel| feature}
6235
6236prompt_setinterrupt({buf}, {expr}) *prompt_setinterrupt()*
6237 Set a callback for buffer {buf} to {expr}. When {expr} is an
6238 empty string the callback is removed. This has only effect if
6239 {buf} has 'buftype' set to "prompt".
6240
6241 This callback will be invoked when pressing CTRL-C in Insert
6242 mode. Without setting a callback Vim will exit Insert mode,
6243 as in any buffer.
6244
6245 Can also be used as a |method|: >
6246 GetBuffer()->prompt_setinterrupt(callback)
6247
6248< {only available when compiled with the |+channel| feature}
6249
6250prompt_setprompt({buf}, {text}) *prompt_setprompt()*
6251 Set prompt for buffer {buf} to {text}. You most likely want
6252 {text} to end in a space.
6253 The result is only visible if {buf} has 'buftype' set to
6254 "prompt". Example: >
6255 call prompt_setprompt(bufnr(), 'command: ')
6256<
6257 Can also be used as a |method|: >
6258 GetBuffer()->prompt_setprompt('command: ')
6259
6260< {only available when compiled with the |+channel| feature}
6261
6262prop_ functions are documented here: |text-prop-functions|
6263
6264pum_getpos() *pum_getpos()*
6265 If the popup menu (see |ins-completion-menu|) is not visible,
6266 returns an empty |Dictionary|, otherwise, returns a
6267 |Dictionary| with the following keys:
6268 height nr of items visible
6269 width screen cells
6270 row top screen row (0 first row)
6271 col leftmost screen column (0 first col)
6272 size total nr of items
6273 scrollbar |TRUE| if scrollbar is visible
6274
6275 The values are the same as in |v:event| during
6276 |CompleteChanged|.
6277
6278pumvisible() *pumvisible()*
6279 Returns non-zero when the popup menu is visible, zero
6280 otherwise. See |ins-completion-menu|.
6281 This can be used to avoid some things that would remove the
6282 popup menu.
6283
6284py3eval({expr}) *py3eval()*
6285 Evaluate Python expression {expr} and return its result
6286 converted to Vim data structures.
6287 Numbers and strings are returned as they are (strings are
6288 copied though, Unicode strings are additionally converted to
6289 'encoding').
6290 Lists are represented as Vim |List| type.
6291 Dictionaries are represented as Vim |Dictionary| type with
6292 keys converted to strings.
6293 Note that in a `:def` function local variables are not visible
6294 to {expr}.
6295
6296 Can also be used as a |method|: >
6297 GetExpr()->py3eval()
6298
6299< {only available when compiled with the |+python3| feature}
6300
6301 *E858* *E859*
6302pyeval({expr}) *pyeval()*
6303 Evaluate Python expression {expr} and return its result
6304 converted to Vim data structures.
6305 Numbers and strings are returned as they are (strings are
6306 copied though).
6307 Lists are represented as Vim |List| type.
6308 Dictionaries are represented as Vim |Dictionary| type,
6309 non-string keys result in error.
6310 Note that in a `:def` function local variables are not visible
6311 to {expr}.
6312
6313 Can also be used as a |method|: >
6314 GetExpr()->pyeval()
6315
6316< {only available when compiled with the |+python| feature}
6317
6318pyxeval({expr}) *pyxeval()*
6319 Evaluate Python expression {expr} and return its result
6320 converted to Vim data structures.
6321 Uses Python 2 or 3, see |python_x| and 'pyxversion'.
6322 See also: |pyeval()|, |py3eval()|
6323
6324 Can also be used as a |method|: >
6325 GetExpr()->pyxeval()
6326
6327< {only available when compiled with the |+python| or the
6328 |+python3| feature}
6329
6330rand([{expr}]) *rand()* *random*
6331 Return a pseudo-random Number generated with an xoshiro128**
6332 algorithm using seed {expr}. The returned number is 32 bits,
6333 also on 64 bits systems, for consistency.
6334 {expr} can be initialized by |srand()| and will be updated by
6335 rand(). If {expr} is omitted, an internal seed value is used
6336 and updated.
6337
6338 Examples: >
6339 :echo rand()
6340 :let seed = srand()
6341 :echo rand(seed)
6342 :echo rand(seed) % 16 " random number 0 - 15
6343<
6344
6345 *E726* *E727*
6346range({expr} [, {max} [, {stride}]]) *range()*
6347 Returns a |List| with Numbers:
6348 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
6349 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
6350 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
6351 {max}] (increasing {expr} with {stride} each time, not
6352 producing a value past {max}).
6353 When the maximum is one before the start the result is an
6354 empty list. When the maximum is more than one before the
6355 start this is an error.
6356 Examples: >
6357 range(4) " [0, 1, 2, 3]
6358 range(2, 4) " [2, 3, 4]
6359 range(2, 9, 3) " [2, 5, 8]
6360 range(2, -2, -1) " [2, 1, 0, -1, -2]
6361 range(0) " []
6362 range(2, 0) " error!
6363<
6364 Can also be used as a |method|: >
6365 GetExpr()->range()
6366<
6367
6368readblob({fname}) *readblob()*
6369 Read file {fname} in binary mode and return a |Blob|.
6370 When the file can't be opened an error message is given and
6371 the result is an empty |Blob|.
6372 Also see |readfile()| and |writefile()|.
6373
6374
6375readdir({directory} [, {expr} [, {dict}]]) *readdir()*
6376 Return a list with file and directory names in {directory}.
6377 You can also use |glob()| if you don't need to do complicated
6378 things, such as limiting the number of matches.
6379 The list will be sorted (case sensitive), see the {dict}
6380 argument below for changing the sort order.
6381
6382 When {expr} is omitted all entries are included.
6383 When {expr} is given, it is evaluated to check what to do:
6384 If {expr} results in -1 then no further entries will
6385 be handled.
6386 If {expr} results in 0 then this entry will not be
6387 added to the list.
6388 If {expr} results in 1 then this entry will be added
6389 to the list.
6390 The entries "." and ".." are always excluded.
6391 Each time {expr} is evaluated |v:val| is set to the entry name.
6392 When {expr} is a function the name is passed as the argument.
6393 For example, to get a list of files ending in ".txt": >
6394 readdir(dirname, {n -> n =~ '.txt$'})
6395< To skip hidden and backup files: >
6396 readdir(dirname, {n -> n !~ '^\.\|\~$'})
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006397< *E857*
6398 The optional {dict} argument allows for further custom
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006399 values. Currently this is used to specify if and how sorting
6400 should be performed. The dict can have the following members:
6401
6402 sort How to sort the result returned from the system.
6403 Valid values are:
6404 "none" do not sort (fastest method)
6405 "case" sort case sensitive (byte value of
6406 each character, technically, using
6407 strcmp()) (default)
6408 "icase" sort case insensitive (technically
6409 using strcasecmp())
6410 "collate" sort using the collation order
6411 of the "POSIX" or "C" |locale|
6412 (technically using strcoll())
6413 Other values are silently ignored.
6414
6415 For example, to get a list of all files in the current
6416 directory without sorting the individual entries: >
6417 readdir('.', '1', #{sort: 'none'})
6418< If you want to get a directory tree: >
6419 function! s:tree(dir)
6420 return {a:dir : map(readdir(a:dir),
6421 \ {_, x -> isdirectory(x) ?
6422 \ {x : s:tree(a:dir . '/' . x)} : x})}
6423 endfunction
6424 echo s:tree(".")
6425<
6426 Can also be used as a |method|: >
6427 GetDirName()->readdir()
6428<
6429readdirex({directory} [, {expr} [, {dict}]]) *readdirex()*
6430 Extended version of |readdir()|.
6431 Return a list of Dictionaries with file and directory
6432 information in {directory}.
6433 This is useful if you want to get the attributes of file and
6434 directory at the same time as getting a list of a directory.
6435 This is much faster than calling |readdir()| then calling
6436 |getfperm()|, |getfsize()|, |getftime()| and |getftype()| for
6437 each file and directory especially on MS-Windows.
6438 The list will by default be sorted by name (case sensitive),
6439 the sorting can be changed by using the optional {dict}
6440 argument, see |readdir()|.
6441
6442 The Dictionary for file and directory information has the
6443 following items:
6444 group Group name of the entry. (Only on Unix)
6445 name Name of the entry.
6446 perm Permissions of the entry. See |getfperm()|.
6447 size Size of the entry. See |getfsize()|.
6448 time Timestamp of the entry. See |getftime()|.
6449 type Type of the entry.
6450 On Unix, almost same as |getftype()| except:
6451 Symlink to a dir "linkd"
6452 Other symlink "link"
6453 On MS-Windows:
6454 Normal file "file"
6455 Directory "dir"
6456 Junction "junction"
6457 Symlink to a dir "linkd"
6458 Other symlink "link"
6459 Other reparse point "reparse"
6460 user User name of the entry's owner. (Only on Unix)
6461 On Unix, if the entry is a symlink, the Dictionary includes
6462 the information of the target (except the "type" item).
6463 On MS-Windows, it includes the information of the symlink
6464 itself because of performance reasons.
6465
6466 When {expr} is omitted all entries are included.
6467 When {expr} is given, it is evaluated to check what to do:
6468 If {expr} results in -1 then no further entries will
6469 be handled.
6470 If {expr} results in 0 then this entry will not be
6471 added to the list.
6472 If {expr} results in 1 then this entry will be added
6473 to the list.
6474 The entries "." and ".." are always excluded.
6475 Each time {expr} is evaluated |v:val| is set to a |Dictionary|
6476 of the entry.
6477 When {expr} is a function the entry is passed as the argument.
6478 For example, to get a list of files ending in ".txt": >
6479 readdirex(dirname, {e -> e.name =~ '.txt$'})
6480<
6481 For example, to get a list of all files in the current
6482 directory without sorting the individual entries: >
6483 readdirex(dirname, '1', #{sort: 'none'})
6484
6485<
6486 Can also be used as a |method|: >
6487 GetDirName()->readdirex()
6488<
6489
6490 *readfile()*
6491readfile({fname} [, {type} [, {max}]])
6492 Read file {fname} and return a |List|, each line of the file
6493 as an item. Lines are broken at NL characters. Macintosh
6494 files separated with CR will result in a single long line
6495 (unless a NL appears somewhere).
6496 All NUL characters are replaced with a NL character.
6497 When {type} contains "b" binary mode is used:
6498 - When the last line ends in a NL an extra empty list item is
6499 added.
6500 - No CR characters are removed.
6501 Otherwise:
6502 - CR characters that appear before a NL are removed.
6503 - Whether the last line ends in a NL or not does not matter.
6504 - When 'encoding' is Unicode any UTF-8 byte order mark is
6505 removed from the text.
6506 When {max} is given this specifies the maximum number of lines
6507 to be read. Useful if you only want to check the first ten
6508 lines of a file: >
6509 :for line in readfile(fname, '', 10)
6510 : if line =~ 'Date' | echo line | endif
6511 :endfor
6512< When {max} is negative -{max} lines from the end of the file
6513 are returned, or as many as there are.
6514 When {max} is zero the result is an empty list.
6515 Note that without {max} the whole file is read into memory.
6516 Also note that there is no recognition of encoding. Read a
6517 file into a buffer if you need to.
6518 Deprecated (use |readblob()| instead): When {type} contains
6519 "B" a |Blob| is returned with the binary data of the file
6520 unmodified.
6521 When the file can't be opened an error message is given and
6522 the result is an empty list.
6523 Also see |writefile()|.
6524
6525 Can also be used as a |method|: >
6526 GetFileName()->readfile()
6527
6528reduce({object}, {func} [, {initial}]) *reduce()* *E998*
6529 {func} is called for every item in {object}, which can be a
6530 |String|, |List| or a |Blob|. {func} is called with two
6531 arguments: the result so far and current item. After
Bram Moolenaarf10911e2022-01-29 22:20:48 +00006532 processing all items the result is returned. *E1132*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006533
6534 {initial} is the initial result. When omitted, the first item
6535 in {object} is used and {func} is first called for the second
6536 item. If {initial} is not given and {object} is empty no
6537 result can be computed, an E998 error is given.
6538
6539 Examples: >
6540 echo reduce([1, 3, 5], { acc, val -> acc + val })
6541 echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a')
6542 echo reduce(0z1122, { acc, val -> 2 * acc + val })
6543 echo reduce('xyz', { acc, val -> acc .. ',' .. val })
6544<
6545 Can also be used as a |method|: >
6546 echo mylist->reduce({ acc, val -> acc + val }, 0)
6547
6548
6549reg_executing() *reg_executing()*
6550 Returns the single letter name of the register being executed.
6551 Returns an empty string when no register is being executed.
6552 See |@|.
6553
6554reg_recording() *reg_recording()*
6555 Returns the single letter name of the register being recorded.
6556 Returns an empty string when not recording. See |q|.
6557
6558reltime([{start} [, {end}]]) *reltime()*
6559 Return an item that represents a time value. The item is a
6560 list with items that depend on the system. In Vim 9 script
6561 list<any> can be used.
6562 The item can be passed to |reltimestr()| to convert it to a
6563 string or |reltimefloat()| to convert to a Float.
6564
6565 Without an argument reltime() returns the current time.
6566 With one argument is returns the time passed since the time
6567 specified in the argument.
6568 With two arguments it returns the time passed between {start}
6569 and {end}.
6570
6571 The {start} and {end} arguments must be values returned by
6572 reltime(). If there is an error zero is returned in legacy
6573 script, in Vim9 script an error is given.
6574
6575 Can also be used as a |method|: >
6576 GetStart()->reltime()
6577<
6578 {only available when compiled with the |+reltime| feature}
6579
6580reltimefloat({time}) *reltimefloat()*
6581 Return a Float that represents the time value of {time}.
6582 Example: >
6583 let start = reltime()
6584 call MyFunction()
6585 let seconds = reltimefloat(reltime(start))
6586< See the note of reltimestr() about overhead.
6587 Also see |profiling|.
6588 If there is an error 0.0 is returned in legacy script, in Vim9
6589 script an error is given.
6590
6591 Can also be used as a |method|: >
6592 reltime(start)->reltimefloat()
6593
6594< {only available when compiled with the |+reltime| feature}
6595
6596reltimestr({time}) *reltimestr()*
6597 Return a String that represents the time value of {time}.
6598 This is the number of seconds, a dot and the number of
6599 microseconds. Example: >
6600 let start = reltime()
6601 call MyFunction()
6602 echo reltimestr(reltime(start))
6603< Note that overhead for the commands will be added to the time.
6604 The accuracy depends on the system.
6605 Leading spaces are used to make the string align nicely. You
6606 can use split() to remove it. >
6607 echo split(reltimestr(reltime(start)))[0]
6608< Also see |profiling|.
6609 If there is an error an empty string is returned in legacy
6610 script, in Vim9 script an error is given.
6611
6612 Can also be used as a |method|: >
6613 reltime(start)->reltimestr()
6614
6615< {only available when compiled with the |+reltime| feature}
6616
6617 *remote_expr()* *E449*
6618remote_expr({server}, {string} [, {idvar} [, {timeout}]])
6619 Send the {string} to {server}. The string is sent as an
6620 expression and the result is returned after evaluation.
6621 The result must be a String or a |List|. A |List| is turned
6622 into a String by joining the items with a line break in
6623 between (not at the end), like with join(expr, "\n").
6624 If {idvar} is present and not empty, it is taken as the name
6625 of a variable and a {serverid} for later use with
6626 |remote_read()| is stored there.
6627 If {timeout} is given the read times out after this many
6628 seconds. Otherwise a timeout of 600 seconds is used.
6629 See also |clientserver| |RemoteReply|.
6630 This function is not available in the |sandbox|.
6631 {only available when compiled with the |+clientserver| feature}
6632 Note: Any errors will cause a local error message to be issued
6633 and the result will be the empty string.
6634
6635 Variables will be evaluated in the global namespace,
6636 independent of a function currently being active. Except
6637 when in debug mode, then local function variables and
6638 arguments can be evaluated.
6639
6640 Examples: >
6641 :echo remote_expr("gvim", "2+2")
6642 :echo remote_expr("gvim1", "b:current_syntax")
6643<
6644 Can also be used as a |method|: >
6645 ServerName()->remote_expr(expr)
6646
6647remote_foreground({server}) *remote_foreground()*
6648 Move the Vim server with the name {server} to the foreground.
6649 The {server} argument is a string.
6650 This works like: >
6651 remote_expr({server}, "foreground()")
6652< Except that on Win32 systems the client does the work, to work
6653 around the problem that the OS doesn't always allow the server
6654 to bring itself to the foreground.
6655 Note: This does not restore the window if it was minimized,
6656 like foreground() does.
6657 This function is not available in the |sandbox|.
6658
6659 Can also be used as a |method|: >
6660 ServerName()->remote_foreground()
6661
6662< {only in the Win32, Athena, Motif and GTK GUI versions and the
6663 Win32 console version}
6664
6665
6666remote_peek({serverid} [, {retvar}]) *remote_peek()*
6667 Returns a positive number if there are available strings
6668 from {serverid}. Copies any reply string into the variable
6669 {retvar} if specified. {retvar} must be a string with the
6670 name of a variable.
6671 Returns zero if none are available.
6672 Returns -1 if something is wrong.
6673 See also |clientserver|.
6674 This function is not available in the |sandbox|.
6675 {only available when compiled with the |+clientserver| feature}
6676 Examples: >
6677 :let repl = ""
6678 :echo "PEEK: ".remote_peek(id, "repl").": ".repl
6679
6680< Can also be used as a |method|: >
6681 ServerId()->remote_peek()
6682
6683remote_read({serverid}, [{timeout}]) *remote_read()*
6684 Return the oldest available reply from {serverid} and consume
6685 it. Unless a {timeout} in seconds is given, it blocks until a
6686 reply is available.
6687 See also |clientserver|.
6688 This function is not available in the |sandbox|.
6689 {only available when compiled with the |+clientserver| feature}
6690 Example: >
6691 :echo remote_read(id)
6692
6693< Can also be used as a |method|: >
6694 ServerId()->remote_read()
6695<
6696 *remote_send()* *E241*
6697remote_send({server}, {string} [, {idvar}])
6698 Send the {string} to {server}. The string is sent as input
6699 keys and the function returns immediately. At the Vim server
6700 the keys are not mapped |:map|.
6701 If {idvar} is present, it is taken as the name of a variable
6702 and a {serverid} for later use with remote_read() is stored
6703 there.
6704 See also |clientserver| |RemoteReply|.
6705 This function is not available in the |sandbox|.
6706 {only available when compiled with the |+clientserver| feature}
6707
6708 Note: Any errors will be reported in the server and may mess
6709 up the display.
6710 Examples: >
6711 :echo remote_send("gvim", ":DropAndReply ".file, "serverid").
6712 \ remote_read(serverid)
6713
6714 :autocmd NONE RemoteReply *
6715 \ echo remote_read(expand("<amatch>"))
6716 :echo remote_send("gvim", ":sleep 10 | echo ".
6717 \ 'server2client(expand("<client>"), "HELLO")<CR>')
6718<
6719 Can also be used as a |method|: >
6720 ServerName()->remote_send(keys)
6721<
6722 *remote_startserver()* *E941* *E942*
6723remote_startserver({name})
6724 Become the server {name}. This fails if already running as a
6725 server, when |v:servername| is not empty.
6726
6727 Can also be used as a |method|: >
6728 ServerName()->remote_startserver()
6729
6730< {only available when compiled with the |+clientserver| feature}
6731
6732remove({list}, {idx} [, {end}]) *remove()*
6733 Without {end}: Remove the item at {idx} from |List| {list} and
6734 return the item.
6735 With {end}: Remove items from {idx} to {end} (inclusive) and
6736 return a |List| with these items. When {idx} points to the same
6737 item as {end} a list with one item is returned. When {end}
6738 points to an item before {idx} this is an error.
6739 See |list-index| for possible values of {idx} and {end}.
6740 Example: >
6741 :echo "last item: " . remove(mylist, -1)
6742 :call remove(mylist, 0, 9)
6743<
6744 Use |delete()| to remove a file.
6745
6746 Can also be used as a |method|: >
6747 mylist->remove(idx)
6748
6749remove({blob}, {idx} [, {end}])
6750 Without {end}: Remove the byte at {idx} from |Blob| {blob} and
6751 return the byte.
6752 With {end}: Remove bytes from {idx} to {end} (inclusive) and
6753 return a |Blob| with these bytes. When {idx} points to the same
6754 byte as {end} a |Blob| with one byte is returned. When {end}
6755 points to a byte before {idx} this is an error.
6756 Example: >
6757 :echo "last byte: " . remove(myblob, -1)
6758 :call remove(mylist, 0, 9)
6759
6760remove({dict}, {key})
6761 Remove the entry from {dict} with key {key} and return it.
6762 Example: >
6763 :echo "removed " . remove(dict, "one")
6764< If there is no {key} in {dict} this is an error.
6765
6766rename({from}, {to}) *rename()*
6767 Rename the file by the name {from} to the name {to}. This
6768 should also work to move files across file systems. The
6769 result is a Number, which is 0 if the file was renamed
6770 successfully, and non-zero when the renaming failed.
6771 NOTE: If {to} exists it is overwritten without warning.
6772 This function is not available in the |sandbox|.
6773
6774 Can also be used as a |method|: >
6775 GetOldName()->rename(newname)
6776
6777repeat({expr}, {count}) *repeat()*
6778 Repeat {expr} {count} times and return the concatenated
6779 result. Example: >
6780 :let separator = repeat('-', 80)
6781< When {count} is zero or negative the result is empty.
6782 When {expr} is a |List| the result is {expr} concatenated
6783 {count} times. Example: >
6784 :let longlist = repeat(['a', 'b'], 3)
6785< Results in ['a', 'b', 'a', 'b', 'a', 'b'].
6786
6787 Can also be used as a |method|: >
6788 mylist->repeat(count)
6789
6790resolve({filename}) *resolve()* *E655*
6791 On MS-Windows, when {filename} is a shortcut (a .lnk file),
6792 returns the path the shortcut points to in a simplified form.
6793 When {filename} is a symbolic link or junction point, return
6794 the full path to the target. If the target of junction is
6795 removed, return {filename}.
6796 On Unix, repeat resolving symbolic links in all path
6797 components of {filename} and return the simplified result.
6798 To cope with link cycles, resolving of symbolic links is
6799 stopped after 100 iterations.
6800 On other systems, return the simplified {filename}.
6801 The simplification step is done as by |simplify()|.
6802 resolve() keeps a leading path component specifying the
6803 current directory (provided the result is still a relative
6804 path name) and also keeps a trailing path separator.
6805
6806 Can also be used as a |method|: >
6807 GetName()->resolve()
6808
6809reverse({object}) *reverse()*
6810 Reverse the order of items in {object} in-place.
6811 {object} can be a |List| or a |Blob|.
6812 Returns {object}.
6813 If you want an object to remain unmodified make a copy first: >
6814 :let revlist = reverse(copy(mylist))
6815< Can also be used as a |method|: >
6816 mylist->reverse()
6817
6818round({expr}) *round()*
6819 Round off {expr} to the nearest integral value and return it
6820 as a |Float|. If {expr} lies halfway between two integral
6821 values, then use the larger one (away from zero).
6822 {expr} must evaluate to a |Float| or a |Number|.
6823 Examples: >
6824 echo round(0.456)
6825< 0.0 >
6826 echo round(4.5)
6827< 5.0 >
6828 echo round(-4.5)
6829< -5.0
6830
6831 Can also be used as a |method|: >
6832 Compute()->round()
6833<
6834 {only available when compiled with the |+float| feature}
6835
6836rubyeval({expr}) *rubyeval()*
6837 Evaluate Ruby expression {expr} and return its result
6838 converted to Vim data structures.
6839 Numbers, floats and strings are returned as they are (strings
6840 are copied though).
6841 Arrays are represented as Vim |List| type.
6842 Hashes are represented as Vim |Dictionary| type.
6843 Other objects are represented as strings resulted from their
6844 "Object#to_s" method.
6845 Note that in a `:def` function local variables are not visible
6846 to {expr}.
6847
6848 Can also be used as a |method|: >
6849 GetRubyExpr()->rubyeval()
6850
6851< {only available when compiled with the |+ruby| feature}
6852
6853screenattr({row}, {col}) *screenattr()*
6854 Like |screenchar()|, but return the attribute. This is a rather
6855 arbitrary number that can only be used to compare to the
6856 attribute at other positions.
6857
6858 Can also be used as a |method|: >
6859 GetRow()->screenattr(col)
6860
6861screenchar({row}, {col}) *screenchar()*
6862 The result is a Number, which is the character at position
6863 [row, col] on the screen. This works for every possible
6864 screen position, also status lines, window separators and the
6865 command line. The top left position is row one, column one
6866 The character excludes composing characters. For double-byte
6867 encodings it may only be the first byte.
6868 This is mainly to be used for testing.
6869 Returns -1 when row or col is out of range.
6870
6871 Can also be used as a |method|: >
6872 GetRow()->screenchar(col)
6873
6874screenchars({row}, {col}) *screenchars()*
6875 The result is a |List| of Numbers. The first number is the same
6876 as what |screenchar()| returns. Further numbers are
6877 composing characters on top of the base character.
6878 This is mainly to be used for testing.
6879 Returns an empty List when row or col is out of range.
6880
6881 Can also be used as a |method|: >
6882 GetRow()->screenchars(col)
6883
6884screencol() *screencol()*
6885 The result is a Number, which is the current screen column of
6886 the cursor. The leftmost column has number 1.
6887 This function is mainly used for testing.
6888
6889 Note: Always returns the current screen column, thus if used
6890 in a command (e.g. ":echo screencol()") it will return the
6891 column inside the command line, which is 1 when the command is
6892 executed. To get the cursor position in the file use one of
6893 the following mappings: >
6894 nnoremap <expr> GG ":echom ".screencol()."\n"
6895 nnoremap <silent> GG :echom screencol()<CR>
6896 nnoremap GG <Cmd>echom screencol()<CR>
6897<
6898screenpos({winid}, {lnum}, {col}) *screenpos()*
6899 The result is a Dict with the screen position of the text
6900 character in window {winid} at buffer line {lnum} and column
6901 {col}. {col} is a one-based byte index.
6902 The Dict has these members:
6903 row screen row
6904 col first screen column
6905 endcol last screen column
6906 curscol cursor screen column
6907 If the specified position is not visible, all values are zero.
6908 The "endcol" value differs from "col" when the character
6909 occupies more than one screen cell. E.g. for a Tab "col" can
6910 be 1 and "endcol" can be 8.
6911 The "curscol" value is where the cursor would be placed. For
6912 a Tab it would be the same as "endcol", while for a double
6913 width character it would be the same as "col".
6914 The |conceal| feature is ignored here, the column numbers are
6915 as if 'conceallevel' is zero. You can set the cursor to the
6916 right position and use |screencol()| to get the value with
6917 |conceal| taken into account.
6918
6919 Can also be used as a |method|: >
6920 GetWinid()->screenpos(lnum, col)
6921
6922screenrow() *screenrow()*
6923 The result is a Number, which is the current screen row of the
6924 cursor. The top line has number one.
6925 This function is mainly used for testing.
6926 Alternatively you can use |winline()|.
6927
6928 Note: Same restrictions as with |screencol()|.
6929
6930screenstring({row}, {col}) *screenstring()*
6931 The result is a String that contains the base character and
6932 any composing characters at position [row, col] on the screen.
6933 This is like |screenchars()| but returning a String with the
6934 characters.
6935 This is mainly to be used for testing.
6936 Returns an empty String when row or col is out of range.
6937
6938 Can also be used as a |method|: >
6939 GetRow()->screenstring(col)
6940<
6941 *search()*
6942search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
6943 Search for regexp pattern {pattern}. The search starts at the
6944 cursor position (you can use |cursor()| to set it).
6945
6946 When a match has been found its line number is returned.
6947 If there is no match a 0 is returned and the cursor doesn't
6948 move. No error message is given.
6949
6950 {flags} is a String, which can contain these character flags:
6951 'b' search Backward instead of forward
6952 'c' accept a match at the Cursor position
6953 'e' move to the End of the match
6954 'n' do Not move the cursor
6955 'p' return number of matching sub-Pattern (see below)
6956 's' Set the ' mark at the previous location of the cursor
6957 'w' Wrap around the end of the file
6958 'W' don't Wrap around the end of the file
6959 'z' start searching at the cursor column instead of zero
6960 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
6961
6962 If the 's' flag is supplied, the ' mark is set, only if the
6963 cursor is moved. The 's' flag cannot be combined with the 'n'
6964 flag.
6965
6966 'ignorecase', 'smartcase' and 'magic' are used.
6967
6968 When the 'z' flag is not given, forward searching always
6969 starts in column zero and then matches before the cursor are
6970 skipped. When the 'c' flag is present in 'cpo' the next
6971 search starts after the match. Without the 'c' flag the next
6972 search starts one column further. This matters for
6973 overlapping matches.
6974 When searching backwards and the 'z' flag is given then the
6975 search starts in column zero, thus no match in the current
6976 line will be found (unless wrapping around the end of the
6977 file).
6978
6979 When the {stopline} argument is given then the search stops
6980 after searching this line. This is useful to restrict the
6981 search to a range of lines. Examples: >
6982 let match = search('(', 'b', line("w0"))
6983 let end = search('END', '', line("w$"))
6984< When {stopline} is used and it is not zero this also implies
6985 that the search does not wrap around the end of the file.
6986 A zero value is equal to not giving the argument.
6987
6988 When the {timeout} argument is given the search stops when
6989 more than this many milliseconds have passed. Thus when
6990 {timeout} is 500 the search stops after half a second.
6991 The value must not be negative. A zero value is like not
6992 giving the argument.
6993 {only available when compiled with the |+reltime| feature}
6994
6995 If the {skip} expression is given it is evaluated with the
6996 cursor positioned on the start of a match. If it evaluates to
6997 non-zero this match is skipped. This can be used, for
6998 example, to skip a match in a comment or a string.
6999 {skip} can be a string, which is evaluated as an expression, a
7000 function reference or a lambda.
7001 When {skip} is omitted or empty, every match is accepted.
7002 When evaluating {skip} causes an error the search is aborted
7003 and -1 returned.
7004 *search()-sub-match*
7005 With the 'p' flag the returned value is one more than the
7006 first sub-match in \(\). One if none of them matched but the
7007 whole pattern did match.
7008 To get the column number too use |searchpos()|.
7009
7010 The cursor will be positioned at the match, unless the 'n'
7011 flag is used.
7012
7013 Example (goes over all files in the argument list): >
7014 :let n = 1
7015 :while n <= argc() " loop over all files in arglist
7016 : exe "argument " . n
7017 : " start at the last char in the file and wrap for the
7018 : " first search to find match at start of file
7019 : normal G$
7020 : let flags = "w"
7021 : while search("foo", flags) > 0
7022 : s/foo/bar/g
7023 : let flags = "W"
7024 : endwhile
7025 : update " write the file if modified
7026 : let n = n + 1
7027 :endwhile
7028<
7029 Example for using some flags: >
7030 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
7031< This will search for the keywords "if", "else", and "endif"
7032 under or after the cursor. Because of the 'p' flag, it
7033 returns 1, 2, or 3 depending on which keyword is found, or 0
7034 if the search fails. With the cursor on the first word of the
7035 line:
7036 if (foo == 0) | let foo = foo + 1 | endif ~
7037 the function returns 1. Without the 'c' flag, the function
7038 finds the "endif" and returns 3. The same thing happens
7039 without the 'e' flag if the cursor is on the "f" of "if".
7040 The 'n' flag tells the function not to move the cursor.
7041
7042 Can also be used as a |method|: >
7043 GetPattern()->search()
7044
7045searchcount([{options}]) *searchcount()*
7046 Get or update the last search count, like what is displayed
7047 without the "S" flag in 'shortmess'. This works even if
7048 'shortmess' does contain the "S" flag.
7049
7050 This returns a |Dictionary|. The dictionary is empty if the
7051 previous pattern was not set and "pattern" was not specified.
7052
7053 key type meaning ~
7054 current |Number| current position of match;
7055 0 if the cursor position is
7056 before the first match
7057 exact_match |Boolean| 1 if "current" is matched on
7058 "pos", otherwise 0
7059 total |Number| total count of matches found
7060 incomplete |Number| 0: search was fully completed
7061 1: recomputing was timed out
7062 2: max count exceeded
7063
7064 For {options} see further down.
7065
7066 To get the last search count when |n| or |N| was pressed, call
7067 this function with `recompute: 0` . This sometimes returns
7068 wrong information because |n| and |N|'s maximum count is 99.
7069 If it exceeded 99 the result must be max count + 1 (100). If
7070 you want to get correct information, specify `recompute: 1`: >
7071
7072 " result == maxcount + 1 (100) when many matches
7073 let result = searchcount(#{recompute: 0})
7074
7075 " Below returns correct result (recompute defaults
7076 " to 1)
7077 let result = searchcount()
7078<
7079 The function is useful to add the count to |statusline|: >
7080 function! LastSearchCount() abort
7081 let result = searchcount(#{recompute: 0})
7082 if empty(result)
7083 return ''
7084 endif
7085 if result.incomplete ==# 1 " timed out
7086 return printf(' /%s [?/??]', @/)
7087 elseif result.incomplete ==# 2 " max count exceeded
7088 if result.total > result.maxcount &&
7089 \ result.current > result.maxcount
7090 return printf(' /%s [>%d/>%d]', @/,
7091 \ result.current, result.total)
7092 elseif result.total > result.maxcount
7093 return printf(' /%s [%d/>%d]', @/,
7094 \ result.current, result.total)
7095 endif
7096 endif
7097 return printf(' /%s [%d/%d]', @/,
7098 \ result.current, result.total)
7099 endfunction
7100 let &statusline .= '%{LastSearchCount()}'
7101
7102 " Or if you want to show the count only when
7103 " 'hlsearch' was on
7104 " let &statusline .=
7105 " \ '%{v:hlsearch ? LastSearchCount() : ""}'
7106<
7107 You can also update the search count, which can be useful in a
7108 |CursorMoved| or |CursorMovedI| autocommand: >
7109
7110 autocmd CursorMoved,CursorMovedI *
7111 \ let s:searchcount_timer = timer_start(
7112 \ 200, function('s:update_searchcount'))
7113 function! s:update_searchcount(timer) abort
7114 if a:timer ==# s:searchcount_timer
7115 call searchcount(#{
7116 \ recompute: 1, maxcount: 0, timeout: 100})
7117 redrawstatus
7118 endif
7119 endfunction
7120<
7121 This can also be used to count matched texts with specified
7122 pattern in the current buffer using "pattern": >
7123
7124 " Count '\<foo\>' in this buffer
7125 " (Note that it also updates search count)
7126 let result = searchcount(#{pattern: '\<foo\>'})
7127
7128 " To restore old search count by old pattern,
7129 " search again
7130 call searchcount()
7131<
7132 {options} must be a |Dictionary|. It can contain:
7133 key type meaning ~
7134 recompute |Boolean| if |TRUE|, recompute the count
7135 like |n| or |N| was executed.
7136 otherwise returns the last
7137 computed result (when |n| or
7138 |N| was used when "S" is not
7139 in 'shortmess', or this
7140 function was called).
7141 (default: |TRUE|)
7142 pattern |String| recompute if this was given
7143 and different with |@/|.
7144 this works as same as the
7145 below command is executed
7146 before calling this function >
7147 let @/ = pattern
7148< (default: |@/|)
7149 timeout |Number| 0 or negative number is no
7150 timeout. timeout milliseconds
7151 for recomputing the result
7152 (default: 0)
7153 maxcount |Number| 0 or negative number is no
7154 limit. max count of matched
7155 text while recomputing the
7156 result. if search exceeded
7157 total count, "total" value
7158 becomes `maxcount + 1`
7159 (default: 99)
7160 pos |List| `[lnum, col, off]` value
7161 when recomputing the result.
7162 this changes "current" result
7163 value. see |cursor()|,
7164 |getpos()|
7165 (default: cursor's position)
7166
7167 Can also be used as a |method|: >
7168 GetSearchOpts()->searchcount()
7169<
7170searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
7171 Search for the declaration of {name}.
7172
7173 With a non-zero {global} argument it works like |gD|, find
7174 first match in the file. Otherwise it works like |gd|, find
7175 first match in the function.
7176
7177 With a non-zero {thisblock} argument matches in a {} block
7178 that ends before the cursor position are ignored. Avoids
7179 finding variable declarations only valid in another scope.
7180
7181 Moves the cursor to the found match.
7182 Returns zero for success, non-zero for failure.
7183 Example: >
7184 if searchdecl('myvar') == 0
7185 echo getline('.')
7186 endif
7187<
7188 Can also be used as a |method|: >
7189 GetName()->searchdecl()
7190<
7191 *searchpair()*
7192searchpair({start}, {middle}, {end} [, {flags} [, {skip}
7193 [, {stopline} [, {timeout}]]]])
7194 Search for the match of a nested start-end pair. This can be
7195 used to find the "endif" that matches an "if", while other
7196 if/endif pairs in between are ignored.
7197 The search starts at the cursor. The default is to search
7198 forward, include 'b' in {flags} to search backward.
7199 If a match is found, the cursor is positioned at it and the
7200 line number is returned. If no match is found 0 or -1 is
7201 returned and the cursor doesn't move. No error message is
7202 given.
7203
7204 {start}, {middle} and {end} are patterns, see |pattern|. They
7205 must not contain \( \) pairs. Use of \%( \) is allowed. When
7206 {middle} is not empty, it is found when searching from either
7207 direction, but only when not in a nested start-end pair. A
7208 typical use is: >
7209 searchpair('\<if\>', '\<else\>', '\<endif\>')
7210< By leaving {middle} empty the "else" is skipped.
7211
7212 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
7213 |search()|. Additionally:
7214 'r' Repeat until no more matches found; will find the
7215 outer pair. Implies the 'W' flag.
7216 'm' Return number of matches instead of line number with
7217 the match; will be > 1 when 'r' is used.
7218 Note: it's nearly always a good idea to use the 'W' flag, to
7219 avoid wrapping around the end of the file.
7220
7221 When a match for {start}, {middle} or {end} is found, the
7222 {skip} expression is evaluated with the cursor positioned on
7223 the start of the match. It should return non-zero if this
7224 match is to be skipped. E.g., because it is inside a comment
7225 or a string.
7226 When {skip} is omitted or empty, every match is accepted.
7227 When evaluating {skip} causes an error the search is aborted
7228 and -1 returned.
7229 {skip} can be a string, a lambda, a funcref or a partial.
7230 Anything else makes the function fail.
7231 In a `:def` function when the {skip} argument is a string
7232 constant it is compiled into instructions.
7233
7234 For {stopline} and {timeout} see |search()|.
7235
7236 The value of 'ignorecase' is used. 'magic' is ignored, the
7237 patterns are used like it's on.
7238
7239 The search starts exactly at the cursor. A match with
7240 {start}, {middle} or {end} at the next character, in the
7241 direction of searching, is the first one found. Example: >
7242 if 1
7243 if 2
7244 endif 2
7245 endif 1
7246< When starting at the "if 2", with the cursor on the "i", and
7247 searching forwards, the "endif 2" is found. When starting on
7248 the character just before the "if 2", the "endif 1" will be
7249 found. That's because the "if 2" will be found first, and
7250 then this is considered to be a nested if/endif from "if 2" to
7251 "endif 2".
7252 When searching backwards and {end} is more than one character,
7253 it may be useful to put "\zs" at the end of the pattern, so
7254 that when the cursor is inside a match with the end it finds
7255 the matching start.
7256
7257 Example, to find the "endif" command in a Vim script: >
7258
7259 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
7260 \ 'getline(".") =~ "^\\s*\""')
7261
7262< The cursor must be at or after the "if" for which a match is
7263 to be found. Note that single-quote strings are used to avoid
7264 having to double the backslashes. The skip expression only
7265 catches comments at the start of a line, not after a command.
7266 Also, a word "en" or "if" halfway a line is considered a
7267 match.
7268 Another example, to search for the matching "{" of a "}": >
7269
7270 :echo searchpair('{', '', '}', 'bW')
7271
7272< This works when the cursor is at or before the "}" for which a
7273 match is to be found. To reject matches that syntax
7274 highlighting recognized as strings: >
7275
7276 :echo searchpair('{', '', '}', 'bW',
7277 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
7278<
7279 *searchpairpos()*
7280searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
7281 [, {stopline} [, {timeout}]]]])
7282 Same as |searchpair()|, but returns a |List| with the line and
7283 column position of the match. The first element of the |List|
7284 is the line number and the second element is the byte index of
7285 the column position of the match. If no match is found,
7286 returns [0, 0]. >
7287
7288 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
7289<
7290 See |match-parens| for a bigger and more useful example.
7291
7292 *searchpos()*
7293searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
7294 Same as |search()|, but returns a |List| with the line and
7295 column position of the match. The first element of the |List|
7296 is the line number and the second element is the byte index of
7297 the column position of the match. If no match is found,
7298 returns [0, 0].
7299 Example: >
7300 :let [lnum, col] = searchpos('mypattern', 'n')
7301
7302< When the 'p' flag is given then there is an extra item with
7303 the sub-pattern match number |search()-sub-match|. Example: >
7304 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
7305< In this example "submatch" is 2 when a lowercase letter is
7306 found |/\l|, 3 when an uppercase letter is found |/\u|.
7307
7308 Can also be used as a |method|: >
7309 GetPattern()->searchpos()
7310
7311server2client({clientid}, {string}) *server2client()*
7312 Send a reply string to {clientid}. The most recent {clientid}
7313 that sent a string can be retrieved with expand("<client>").
7314 {only available when compiled with the |+clientserver| feature}
7315 Returns zero for success, -1 for failure.
7316 Note:
7317 This id has to be stored before the next command can be
7318 received. I.e. before returning from the received command and
7319 before calling any commands that waits for input.
7320 See also |clientserver|.
7321 Example: >
7322 :echo server2client(expand("<client>"), "HELLO")
7323
7324< Can also be used as a |method|: >
7325 GetClientId()->server2client(string)
7326<
7327serverlist() *serverlist()*
7328 Return a list of available server names, one per line.
7329 When there are no servers or the information is not available
7330 an empty string is returned. See also |clientserver|.
7331 {only available when compiled with the |+clientserver| feature}
7332 Example: >
7333 :echo serverlist()
7334<
7335setbufline({buf}, {lnum}, {text}) *setbufline()*
7336 Set line {lnum} to {text} in buffer {buf}. This works like
7337 |setline()| for the specified buffer.
7338
7339 This function works only for loaded buffers. First call
7340 |bufload()| if needed.
7341
7342 To insert lines use |appendbufline()|.
7343 Any text properties in {lnum} are cleared.
7344
7345 {text} can be a string to set one line, or a list of strings
7346 to set multiple lines. If the list extends below the last
7347 line then those lines are added.
7348
7349 For the use of {buf}, see |bufname()| above.
7350
7351 {lnum} is used like with |setline()|.
7352 Use "$" to refer to the last line in buffer {buf}.
7353 When {lnum} is just below the last line the {text} will be
7354 added below the last line.
7355
7356 When {buf} is not a valid buffer, the buffer is not loaded or
7357 {lnum} is not valid then 1 is returned. In |Vim9| script an
7358 error is given.
7359 On success 0 is returned.
7360
7361 Can also be used as a |method|, the base is passed as the
7362 third argument: >
7363 GetText()->setbufline(buf, lnum)
7364
7365setbufvar({buf}, {varname}, {val}) *setbufvar()*
7366 Set option or local variable {varname} in buffer {buf} to
7367 {val}.
7368 This also works for a global or local window option, but it
7369 doesn't work for a global or local window variable.
7370 For a local window option the global value is unchanged.
7371 For the use of {buf}, see |bufname()| above.
7372 The {varname} argument is a string.
7373 Note that the variable name without "b:" must be used.
7374 Examples: >
7375 :call setbufvar(1, "&mod", 1)
7376 :call setbufvar("todo", "myvar", "foobar")
7377< This function is not available in the |sandbox|.
7378
7379 Can also be used as a |method|, the base is passed as the
7380 third argument: >
7381 GetValue()->setbufvar(buf, varname)
7382
7383
7384setcellwidths({list}) *setcellwidths()*
7385 Specify overrides for cell widths of character ranges. This
7386 tells Vim how wide characters are, counted in screen cells.
7387 This overrides 'ambiwidth'. Example: >
7388 setcellwidths([[0xad, 0xad, 1],
7389 \ [0x2194, 0x2199, 2]])
7390
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007391< *E1109* *E1110* *E1111* *E1112* *E1113* *E1114*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007392 The {list} argument is a list of lists with each three
7393 numbers. These three numbers are [low, high, width]. "low"
7394 and "high" can be the same, in which case this refers to one
7395 character. Otherwise it is the range of characters from "low"
7396 to "high" (inclusive). "width" is either 1 or 2, indicating
7397 the character width in screen cells.
7398 An error is given if the argument is invalid, also when a
7399 range overlaps with another.
7400 Only characters with value 0x100 and higher can be used.
7401
7402 If the new value causes 'fillchars' or 'listchars' to become
7403 invalid it is rejected and an error is given.
7404
7405 To clear the overrides pass an empty list: >
7406 setcellwidths([]);
7407< You can use the script $VIMRUNTIME/tools/emoji_list.vim to see
7408 the effect for known emoji characters.
7409
7410setcharpos({expr}, {list}) *setcharpos()*
7411 Same as |setpos()| but uses the specified column number as the
7412 character index instead of the byte index in the line.
7413
7414 Example:
7415 With the text "여보세요" in line 8: >
7416 call setcharpos('.', [0, 8, 4, 0])
7417< positions the cursor on the fourth character '요'. >
7418 call setpos('.', [0, 8, 4, 0])
7419< positions the cursor on the second character '보'.
7420
7421 Can also be used as a |method|: >
7422 GetPosition()->setcharpos('.')
7423
7424setcharsearch({dict}) *setcharsearch()*
7425 Set the current character search information to {dict},
7426 which contains one or more of the following entries:
7427
7428 char character which will be used for a subsequent
7429 |,| or |;| command; an empty string clears the
7430 character search
7431 forward direction of character search; 1 for forward,
7432 0 for backward
7433 until type of character search; 1 for a |t| or |T|
7434 character search, 0 for an |f| or |F|
7435 character search
7436
7437 This can be useful to save/restore a user's character search
7438 from a script: >
7439 :let prevsearch = getcharsearch()
7440 :" Perform a command which clobbers user's search
7441 :call setcharsearch(prevsearch)
7442< Also see |getcharsearch()|.
7443
7444 Can also be used as a |method|: >
7445 SavedSearch()->setcharsearch()
7446
7447setcmdpos({pos}) *setcmdpos()*
7448 Set the cursor position in the command line to byte position
7449 {pos}. The first position is 1.
7450 Use |getcmdpos()| to obtain the current position.
7451 Only works while editing the command line, thus you must use
7452 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
7453 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
7454 set after the command line is set to the expression. For
7455 |c_CTRL-R_=| it is set after evaluating the expression but
7456 before inserting the resulting text.
7457 When the number is too big the cursor is put at the end of the
7458 line. A number smaller than one has undefined results.
7459 Returns FALSE when successful, TRUE when not editing the
7460 command line.
7461
7462 Can also be used as a |method|: >
7463 GetPos()->setcmdpos()
7464
7465setcursorcharpos({lnum}, {col} [, {off}]) *setcursorcharpos()*
7466setcursorcharpos({list})
7467 Same as |cursor()| but uses the specified column number as the
7468 character index instead of the byte index in the line.
7469
7470 Example:
7471 With the text "여보세요" in line 4: >
7472 call setcursorcharpos(4, 3)
7473< positions the cursor on the third character '세'. >
7474 call cursor(4, 3)
7475< positions the cursor on the first character '여'.
7476
7477 Can also be used as a |method|: >
7478 GetCursorPos()->setcursorcharpos()
7479
7480
7481setenv({name}, {val}) *setenv()*
7482 Set environment variable {name} to {val}. Example: >
7483 call setenv('HOME', '/home/myhome')
7484
7485< When {val} is |v:null| the environment variable is deleted.
7486 See also |expr-env|.
7487
7488 Can also be used as a |method|, the base is passed as the
7489 second argument: >
7490 GetPath()->setenv('PATH')
7491
7492setfperm({fname}, {mode}) *setfperm()* *chmod*
7493 Set the file permissions for {fname} to {mode}.
7494 {mode} must be a string with 9 characters. It is of the form
7495 "rwxrwxrwx", where each group of "rwx" flags represent, in
7496 turn, the permissions of the owner of the file, the group the
7497 file belongs to, and other users. A '-' character means the
7498 permission is off, any other character means on. Multi-byte
7499 characters are not supported.
7500
7501 For example "rw-r-----" means read-write for the user,
7502 readable by the group, not accessible by others. "xx-x-----"
7503 would do the same thing.
7504
7505 Returns non-zero for success, zero for failure.
7506
7507 Can also be used as a |method|: >
7508 GetFilename()->setfperm(mode)
7509<
7510 To read permissions see |getfperm()|.
7511
7512
7513setline({lnum}, {text}) *setline()*
7514 Set line {lnum} of the current buffer to {text}. To insert
7515 lines use |append()|. To set lines in another buffer use
7516 |setbufline()|. Any text properties in {lnum} are cleared.
7517
7518 {lnum} is used like with |getline()|.
7519 When {lnum} is just below the last line the {text} will be
7520 added below the last line.
7521 {text} can be any type or a List of any type, each item is
7522 converted to a String.
7523
7524 If this succeeds, FALSE is returned. If this fails (most likely
7525 because {lnum} is invalid) TRUE is returned.
7526 In |Vim9| script an error is given if {lnum} is invalid.
7527
7528 Example: >
7529 :call setline(5, strftime("%c"))
7530
7531< When {text} is a |List| then line {lnum} and following lines
7532 will be set to the items in the list. Example: >
7533 :call setline(5, ['aaa', 'bbb', 'ccc'])
7534< This is equivalent to: >
7535 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
7536 : call setline(n, l)
7537 :endfor
7538
7539< Note: The '[ and '] marks are not set.
7540
7541 Can also be used as a |method|, the base is passed as the
7542 second argument: >
7543 GetText()->setline(lnum)
7544
7545setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()*
7546 Create or replace or add to the location list for window {nr}.
7547 {nr} can be the window number or the |window-ID|.
7548 When {nr} is zero the current window is used.
7549
7550 For a location list window, the displayed location list is
7551 modified. For an invalid window number {nr}, -1 is returned.
7552 Otherwise, same as |setqflist()|.
7553 Also see |location-list|.
7554
7555 For {action} see |setqflist-action|.
7556
7557 If the optional {what} dictionary argument is supplied, then
7558 only the items listed in {what} are set. Refer to |setqflist()|
7559 for the list of supported keys in {what}.
7560
7561 Can also be used as a |method|, the base is passed as the
7562 second argument: >
7563 GetLoclist()->setloclist(winnr)
7564
7565setmatches({list} [, {win}]) *setmatches()*
7566 Restores a list of matches saved by |getmatches()| for the
7567 current window. Returns 0 if successful, otherwise -1. All
7568 current matches are cleared before the list is restored. See
7569 example for |getmatches()|.
7570 If {win} is specified, use the window with this number or
7571 window ID instead of the current window.
7572
7573 Can also be used as a |method|: >
7574 GetMatches()->setmatches()
7575<
7576 *setpos()*
7577setpos({expr}, {list})
7578 Set the position for String {expr}. Possible values:
7579 . the cursor
7580 'x mark x
7581
7582 {list} must be a |List| with four or five numbers:
7583 [bufnum, lnum, col, off]
7584 [bufnum, lnum, col, off, curswant]
7585
7586 "bufnum" is the buffer number. Zero can be used for the
7587 current buffer. When setting an uppercase mark "bufnum" is
7588 used for the mark position. For other marks it specifies the
7589 buffer to set the mark in. You can use the |bufnr()| function
7590 to turn a file name into a buffer number.
7591 For setting the cursor and the ' mark "bufnum" is ignored,
7592 since these are associated with a window, not a buffer.
7593 Does not change the jumplist.
7594
7595 "lnum" and "col" are the position in the buffer. The first
7596 column is 1. Use a zero "lnum" to delete a mark. If "col" is
7597 smaller than 1 then 1 is used. To use the character count
7598 instead of the byte count, use |setcharpos()|.
7599
7600 The "off" number is only used when 'virtualedit' is set. Then
7601 it is the offset in screen columns from the start of the
7602 character. E.g., a position within a <Tab> or after the last
7603 character.
7604
7605 The "curswant" number is only used when setting the cursor
7606 position. It sets the preferred column for when moving the
7607 cursor vertically. When the "curswant" number is missing the
7608 preferred column is not set. When it is present and setting a
7609 mark position it is not used.
7610
7611 Note that for '< and '> changing the line number may result in
7612 the marks to be effectively be swapped, so that '< is always
7613 before '>.
7614
7615 Returns 0 when the position could be set, -1 otherwise.
7616 An error message is given if {expr} is invalid.
7617
7618 Also see |setcharpos()|, |getpos()| and |getcurpos()|.
7619
7620 This does not restore the preferred column for moving
7621 vertically; if you set the cursor position with this, |j| and
7622 |k| motions will jump to previous columns! Use |cursor()| to
7623 also set the preferred column. Also see the "curswant" key in
7624 |winrestview()|.
7625
7626 Can also be used as a |method|: >
7627 GetPosition()->setpos('.')
7628
7629setqflist({list} [, {action} [, {what}]]) *setqflist()*
7630 Create or replace or add to the quickfix list.
7631
7632 If the optional {what} dictionary argument is supplied, then
7633 only the items listed in {what} are set. The first {list}
7634 argument is ignored. See below for the supported items in
7635 {what}.
7636 *setqflist-what*
7637 When {what} is not present, the items in {list} are used. Each
7638 item must be a dictionary. Non-dictionary items in {list} are
7639 ignored. Each dictionary item can contain the following
7640 entries:
7641
7642 bufnr buffer number; must be the number of a valid
7643 buffer
7644 filename name of a file; only used when "bufnr" is not
7645 present or it is invalid.
7646 module name of a module; if given it will be used in
7647 quickfix error window instead of the filename.
7648 lnum line number in the file
7649 pattern search pattern used to locate the error
7650 col column number
7651 vcol when non-zero: "col" is visual column
7652 when zero: "col" is byte index
7653 nr error number
7654 text description of the error
7655 type single-character error type, 'E', 'W', etc.
7656 valid recognized error message
7657
7658 The "col", "vcol", "nr", "type" and "text" entries are
7659 optional. Either "lnum" or "pattern" entry can be used to
7660 locate a matching error line.
7661 If the "filename" and "bufnr" entries are not present or
7662 neither the "lnum" or "pattern" entries are present, then the
7663 item will not be handled as an error line.
7664 If both "pattern" and "lnum" are present then "pattern" will
7665 be used.
7666 If the "valid" entry is not supplied, then the valid flag is
7667 set when "bufnr" is a valid buffer or "filename" exists.
7668 If you supply an empty {list}, the quickfix list will be
7669 cleared.
7670 Note that the list is not exactly the same as what
7671 |getqflist()| returns.
7672
7673 {action} values: *setqflist-action* *E927*
7674 'a' The items from {list} are added to the existing
7675 quickfix list. If there is no existing list, then a
7676 new list is created.
7677
7678 'r' The items from the current quickfix list are replaced
7679 with the items from {list}. This can also be used to
7680 clear the list: >
7681 :call setqflist([], 'r')
7682<
7683 'f' All the quickfix lists in the quickfix stack are
7684 freed.
7685
7686 If {action} is not present or is set to ' ', then a new list
7687 is created. The new quickfix list is added after the current
7688 quickfix list in the stack and all the following lists are
7689 freed. To add a new quickfix list at the end of the stack,
7690 set "nr" in {what} to "$".
7691
7692 The following items can be specified in dictionary {what}:
7693 context quickfix list context. See |quickfix-context|
7694 efm errorformat to use when parsing text from
7695 "lines". If this is not present, then the
7696 'errorformat' option value is used.
7697 See |quickfix-parse|
7698 id quickfix list identifier |quickfix-ID|
7699 idx index of the current entry in the quickfix
7700 list specified by 'id' or 'nr'. If set to '$',
7701 then the last entry in the list is set as the
7702 current entry. See |quickfix-index|
7703 items list of quickfix entries. Same as the {list}
7704 argument.
7705 lines use 'errorformat' to parse a list of lines and
7706 add the resulting entries to the quickfix list
7707 {nr} or {id}. Only a |List| value is supported.
7708 See |quickfix-parse|
7709 nr list number in the quickfix stack; zero
7710 means the current quickfix list and "$" means
7711 the last quickfix list.
7712 quickfixtextfunc
7713 function to get the text to display in the
7714 quickfix window. The value can be the name of
7715 a function or a funcref or a lambda. Refer to
7716 |quickfix-window-function| for an explanation
7717 of how to write the function and an example.
7718 title quickfix list title text. See |quickfix-title|
7719 Unsupported keys in {what} are ignored.
7720 If the "nr" item is not present, then the current quickfix list
7721 is modified. When creating a new quickfix list, "nr" can be
7722 set to a value one greater than the quickfix stack size.
7723 When modifying a quickfix list, to guarantee that the correct
7724 list is modified, "id" should be used instead of "nr" to
7725 specify the list.
7726
7727 Examples (See also |setqflist-examples|): >
7728 :call setqflist([], 'r', {'title': 'My search'})
7729 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
7730 :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
7731<
7732 Returns zero for success, -1 for failure.
7733
7734 This function can be used to create a quickfix list
7735 independent of the 'errorformat' setting. Use a command like
7736 `:cc 1` to jump to the first position.
7737
7738 Can also be used as a |method|, the base is passed as the
7739 second argument: >
7740 GetErrorlist()->setqflist()
7741<
7742 *setreg()*
7743setreg({regname}, {value} [, {options}])
7744 Set the register {regname} to {value}.
7745 If {regname} is "" or "@", the unnamed register '"' is used.
7746 The {regname} argument is a string. In |Vim9-script|
7747 {regname} must be one character.
7748
7749 {value} may be any value returned by |getreg()| or
7750 |getreginfo()|, including a |List| or |Dict|.
7751 If {options} contains "a" or {regname} is upper case,
7752 then the value is appended.
7753
7754 {options} can also contain a register type specification:
7755 "c" or "v" |characterwise| mode
7756 "l" or "V" |linewise| mode
7757 "b" or "<CTRL-V>" |blockwise-visual| mode
7758 If a number immediately follows "b" or "<CTRL-V>" then this is
7759 used as the width of the selection - if it is not specified
7760 then the width of the block is set to the number of characters
7761 in the longest line (counting a <Tab> as 1 character).
7762
7763 If {options} contains no register settings, then the default
7764 is to use character mode unless {value} ends in a <NL> for
7765 string {value} and linewise mode for list {value}. Blockwise
7766 mode is never selected automatically.
7767 Returns zero for success, non-zero for failure.
7768
7769 *E883*
7770 Note: you may not use |List| containing more than one item to
7771 set search and expression registers. Lists containing no
7772 items act like empty strings.
7773
7774 Examples: >
7775 :call setreg(v:register, @*)
7776 :call setreg('*', @%, 'ac')
7777 :call setreg('a', "1\n2\n3", 'b5')
7778 :call setreg('"', { 'points_to': 'a'})
7779
7780< This example shows using the functions to save and restore a
7781 register: >
7782 :let var_a = getreginfo()
7783 :call setreg('a', var_a)
7784< or: >
7785 :let var_a = getreg('a', 1, 1)
7786 :let var_amode = getregtype('a')
7787 ....
7788 :call setreg('a', var_a, var_amode)
7789< Note: you may not reliably restore register value
7790 without using the third argument to |getreg()| as without it
7791 newlines are represented as newlines AND Nul bytes are
7792 represented as newlines as well, see |NL-used-for-Nul|.
7793
7794 You can also change the type of a register by appending
7795 nothing: >
7796 :call setreg('a', '', 'al')
7797
7798< Can also be used as a |method|, the base is passed as the
7799 second argument: >
7800 GetText()->setreg('a')
7801
7802settabvar({tabnr}, {varname}, {val}) *settabvar()*
7803 Set tab-local variable {varname} to {val} in tab page {tabnr}.
7804 |t:var|
7805 The {varname} argument is a string.
7806 Note that autocommands are blocked, side effects may not be
7807 triggered, e.g. when setting 'filetype'.
7808 Note that the variable name without "t:" must be used.
7809 Tabs are numbered starting with one.
7810 This function is not available in the |sandbox|.
7811
7812 Can also be used as a |method|, the base is passed as the
7813 third argument: >
7814 GetValue()->settabvar(tab, name)
7815
7816settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
7817 Set option or local variable {varname} in window {winnr} to
7818 {val}.
7819 Tabs are numbered starting with one. For the current tabpage
7820 use |setwinvar()|.
7821 {winnr} can be the window number or the |window-ID|.
7822 When {winnr} is zero the current window is used.
7823 Note that autocommands are blocked, side effects may not be
7824 triggered, e.g. when setting 'filetype' or 'syntax'.
7825 This also works for a global or local buffer option, but it
7826 doesn't work for a global or local buffer variable.
7827 For a local buffer option the global value is unchanged.
7828 Note that the variable name without "w:" must be used.
7829 Examples: >
7830 :call settabwinvar(1, 1, "&list", 0)
7831 :call settabwinvar(3, 2, "myvar", "foobar")
7832< This function is not available in the |sandbox|.
7833
7834 Can also be used as a |method|, the base is passed as the
7835 fourth argument: >
7836 GetValue()->settabwinvar(tab, winnr, name)
7837
7838settagstack({nr}, {dict} [, {action}]) *settagstack()*
7839 Modify the tag stack of the window {nr} using {dict}.
7840 {nr} can be the window number or the |window-ID|.
7841
7842 For a list of supported items in {dict}, refer to
7843 |gettagstack()|. "curidx" takes effect before changing the tag
7844 stack.
7845 *E962*
7846 How the tag stack is modified depends on the {action}
7847 argument:
7848 - If {action} is not present or is set to 'r', then the tag
7849 stack is replaced.
7850 - If {action} is set to 'a', then new entries from {dict} are
7851 pushed (added) onto the tag stack.
7852 - If {action} is set to 't', then all the entries from the
7853 current entry in the tag stack or "curidx" in {dict} are
7854 removed and then new entries are pushed to the stack.
7855
7856 The current index is set to one after the length of the tag
7857 stack after the modification.
7858
7859 Returns zero for success, -1 for failure.
7860
7861 Examples (for more examples see |tagstack-examples|):
7862 Empty the tag stack of window 3: >
7863 call settagstack(3, {'items' : []})
7864
7865< Save and restore the tag stack: >
7866 let stack = gettagstack(1003)
7867 " do something else
7868 call settagstack(1003, stack)
7869 unlet stack
7870<
7871 Can also be used as a |method|, the base is passed as the
7872 second argument: >
7873 GetStack()->settagstack(winnr)
7874
7875setwinvar({winnr}, {varname}, {val}) *setwinvar()*
7876 Like |settabwinvar()| for the current tab page.
7877 Examples: >
7878 :call setwinvar(1, "&list", 0)
7879 :call setwinvar(2, "myvar", "foobar")
7880
7881< Can also be used as a |method|, the base is passed as the
7882 third argument: >
7883 GetValue()->setwinvar(winnr, name)
7884
7885sha256({string}) *sha256()*
7886 Returns a String with 64 hex characters, which is the SHA256
7887 checksum of {string}.
7888
7889 Can also be used as a |method|: >
7890 GetText()->sha256()
7891
7892< {only available when compiled with the |+cryptv| feature}
7893
7894shellescape({string} [, {special}]) *shellescape()*
7895 Escape {string} for use as a shell command argument.
7896 When the 'shell' contains powershell (MS-Windows) or pwsh
7897 (MS-Windows, Linux, and MacOS) then it will enclose {string}
7898 in single quotes and will double up all internal single
7899 quotes.
7900 On MS-Windows, when 'shellslash' is not set, it will enclose
7901 {string} in double quotes and double all double quotes within
7902 {string}.
7903 Otherwise it will enclose {string} in single quotes and
7904 replace all "'" with "'\''".
7905
7906 When the {special} argument is present and it's a non-zero
7907 Number or a non-empty String (|non-zero-arg|), then special
7908 items such as "!", "%", "#" and "<cword>" will be preceded by
7909 a backslash. This backslash will be removed again by the |:!|
7910 command.
7911
7912 The "!" character will be escaped (again with a |non-zero-arg|
7913 {special}) when 'shell' contains "csh" in the tail. That is
7914 because for csh and tcsh "!" is used for history replacement
7915 even when inside single quotes.
7916
7917 With a |non-zero-arg| {special} the <NL> character is also
7918 escaped. When 'shell' containing "csh" in the tail it's
7919 escaped a second time.
7920
7921 The "\" character will be escaped when 'shell' contains "fish"
7922 in the tail. That is because for fish "\" is used as an escape
7923 character inside single quotes.
7924
7925 Example of use with a |:!| command: >
7926 :exe '!dir ' . shellescape(expand('<cfile>'), 1)
7927< This results in a directory listing for the file under the
7928 cursor. Example of use with |system()|: >
7929 :call system("chmod +w -- " . shellescape(expand("%")))
7930< See also |::S|.
7931
7932 Can also be used as a |method|: >
7933 GetCommand()->shellescape()
7934
7935shiftwidth([{col}]) *shiftwidth()*
7936 Returns the effective value of 'shiftwidth'. This is the
7937 'shiftwidth' value unless it is zero, in which case it is the
7938 'tabstop' value. This function was introduced with patch
7939 7.3.694 in 2012, everybody should have it by now (however it
7940 did not allow for the optional {col} argument until 8.1.542).
7941
7942 When there is one argument {col} this is used as column number
7943 for which to return the 'shiftwidth' value. This matters for the
7944 'vartabstop' feature. If the 'vartabstop' setting is enabled and
7945 no {col} argument is given, column 1 will be assumed.
7946
7947 Can also be used as a |method|: >
7948 GetColumn()->shiftwidth()
7949
7950sign_ functions are documented here: |sign-functions-details|
7951
7952
7953simplify({filename}) *simplify()*
7954 Simplify the file name as much as possible without changing
7955 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
7956 Unix) are not resolved. If the first path component in
7957 {filename} designates the current directory, this will be
7958 valid for the result as well. A trailing path separator is
7959 not removed either. On Unix "//path" is unchanged, but
7960 "///path" is simplified to "/path" (this follows the Posix
7961 standard).
7962 Example: >
7963 simplify("./dir/.././/file/") == "./file/"
7964< Note: The combination "dir/.." is only removed if "dir" is
7965 a searchable directory or does not exist. On Unix, it is also
7966 removed when "dir" is a symbolic link within the same
7967 directory. In order to resolve all the involved symbolic
7968 links before simplifying the path name, use |resolve()|.
7969
7970 Can also be used as a |method|: >
7971 GetName()->simplify()
7972
7973sin({expr}) *sin()*
7974 Return the sine of {expr}, measured in radians, as a |Float|.
7975 {expr} must evaluate to a |Float| or a |Number|.
7976 Examples: >
7977 :echo sin(100)
7978< -0.506366 >
7979 :echo sin(-4.01)
7980< 0.763301
7981
7982 Can also be used as a |method|: >
7983 Compute()->sin()
7984<
7985 {only available when compiled with the |+float| feature}
7986
7987
7988sinh({expr}) *sinh()*
7989 Return the hyperbolic sine of {expr} as a |Float| in the range
7990 [-inf, inf].
7991 {expr} must evaluate to a |Float| or a |Number|.
7992 Examples: >
7993 :echo sinh(0.5)
7994< 0.521095 >
7995 :echo sinh(-0.9)
7996< -1.026517
7997
7998 Can also be used as a |method|: >
7999 Compute()->sinh()
8000<
8001 {only available when compiled with the |+float| feature}
8002
8003
8004slice({expr}, {start} [, {end}]) *slice()*
8005 Similar to using a |slice| "expr[start : end]", but "end" is
8006 used exclusive. And for a string the indexes are used as
8007 character indexes instead of byte indexes, like in
8008 |vim9script|. Also, composing characters are not counted.
8009 When {end} is omitted the slice continues to the last item.
8010 When {end} is -1 the last item is omitted.
8011
8012 Can also be used as a |method|: >
8013 GetList()->slice(offset)
8014
8015
8016sort({list} [, {func} [, {dict}]]) *sort()* *E702*
8017 Sort the items in {list} in-place. Returns {list}.
8018
8019 If you want a list to remain unmodified make a copy first: >
8020 :let sortedlist = sort(copy(mylist))
8021
8022< When {func} is omitted, is empty or zero, then sort() uses the
8023 string representation of each item to sort on. Numbers sort
8024 after Strings, |Lists| after Numbers. For sorting text in the
8025 current buffer use |:sort|.
8026
8027 When {func} is given and it is '1' or 'i' then case is
8028 ignored.
8029
8030 When {func} is given and it is 'l' then the current collation
8031 locale is used for ordering. Implementation details: strcoll()
8032 is used to compare strings. See |:language| check or set the
8033 collation locale. |v:collate| can also be used to check the
8034 current locale. Sorting using the locale typically ignores
8035 case. Example: >
8036 " ö is sorted similarly to o with English locale.
8037 :language collate en_US.UTF8
8038 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
8039< ['n', 'o', 'O', 'ö', 'p', 'z'] ~
8040>
8041 " ö is sorted after z with Swedish locale.
8042 :language collate sv_SE.UTF8
8043 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
8044< ['n', 'o', 'O', 'p', 'z', 'ö'] ~
8045 This does not work properly on Mac.
8046
8047 When {func} is given and it is 'n' then all items will be
8048 sorted numerical (Implementation detail: this uses the
8049 strtod() function to parse numbers, Strings, Lists, Dicts and
8050 Funcrefs will be considered as being 0).
8051
8052 When {func} is given and it is 'N' then all items will be
8053 sorted numerical. This is like 'n' but a string containing
8054 digits will be used as the number they represent.
8055
8056 When {func} is given and it is 'f' then all items will be
8057 sorted numerical. All values must be a Number or a Float.
8058
8059 When {func} is a |Funcref| or a function name, this function
8060 is called to compare items. The function is invoked with two
8061 items as argument and must return zero if they are equal, 1 or
8062 bigger if the first one sorts after the second one, -1 or
8063 smaller if the first one sorts before the second one.
8064
8065 {dict} is for functions with the "dict" attribute. It will be
8066 used to set the local variable "self". |Dictionary-function|
8067
8068 The sort is stable, items which compare equal (as number or as
8069 string) will keep their relative position. E.g., when sorting
8070 on numbers, text strings will sort next to each other, in the
8071 same order as they were originally.
8072
8073 Can also be used as a |method|: >
8074 mylist->sort()
8075
8076< Also see |uniq()|.
8077
8078 Example: >
8079 func MyCompare(i1, i2)
8080 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
8081 endfunc
8082 eval mylist->sort("MyCompare")
8083< A shorter compare version for this specific simple case, which
8084 ignores overflow: >
8085 func MyCompare(i1, i2)
8086 return a:i1 - a:i2
8087 endfunc
8088< For a simple expression you can use a lambda: >
8089 eval mylist->sort({i1, i2 -> i1 - i2})
8090<
8091sound_clear() *sound_clear()*
8092 Stop playing all sounds.
8093
8094 On some Linux systems you may need the libcanberra-pulse
8095 package, otherwise sound may not stop.
8096
8097 {only available when compiled with the |+sound| feature}
8098
8099 *sound_playevent()*
8100sound_playevent({name} [, {callback}])
8101 Play a sound identified by {name}. Which event names are
8102 supported depends on the system. Often the XDG sound names
8103 are used. On Ubuntu they may be found in
8104 /usr/share/sounds/freedesktop/stereo. Example: >
8105 call sound_playevent('bell')
8106< On MS-Windows, {name} can be SystemAsterisk, SystemDefault,
8107 SystemExclamation, SystemExit, SystemHand, SystemQuestion,
8108 SystemStart, SystemWelcome, etc.
8109
8110 When {callback} is specified it is invoked when the sound is
8111 finished. The first argument is the sound ID, the second
8112 argument is the status:
8113 0 sound was played to the end
8114 1 sound was interrupted
8115 2 error occurred after sound started
8116 Example: >
8117 func Callback(id, status)
8118 echomsg "sound " .. a:id .. " finished with " .. a:status
8119 endfunc
8120 call sound_playevent('bell', 'Callback')
8121
8122< MS-Windows: {callback} doesn't work for this function.
8123
8124 Returns the sound ID, which can be passed to `sound_stop()`.
8125 Returns zero if the sound could not be played.
8126
8127 Can also be used as a |method|: >
8128 GetSoundName()->sound_playevent()
8129
8130< {only available when compiled with the |+sound| feature}
8131
8132 *sound_playfile()*
8133sound_playfile({path} [, {callback}])
8134 Like `sound_playevent()` but play sound file {path}. {path}
8135 must be a full path. On Ubuntu you may find files to play
8136 with this command: >
8137 :!find /usr/share/sounds -type f | grep -v index.theme
8138
8139< Can also be used as a |method|: >
8140 GetSoundPath()->sound_playfile()
8141
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00008142< There is no error *E538* , but can listen to 538.nl.
8143 {only available when compiled with the |+sound| feature}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008144
8145
8146sound_stop({id}) *sound_stop()*
8147 Stop playing sound {id}. {id} must be previously returned by
8148 `sound_playevent()` or `sound_playfile()`.
8149
8150 On some Linux systems you may need the libcanberra-pulse
8151 package, otherwise sound may not stop.
8152
8153 On MS-Windows, this does not work for event sound started by
8154 `sound_playevent()`. To stop event sounds, use `sound_clear()`.
8155
8156 Can also be used as a |method|: >
8157 soundid->sound_stop()
8158
8159< {only available when compiled with the |+sound| feature}
8160
8161 *soundfold()*
8162soundfold({word})
8163 Return the sound-folded equivalent of {word}. Uses the first
8164 language in 'spelllang' for the current window that supports
8165 soundfolding. 'spell' must be set. When no sound folding is
8166 possible the {word} is returned unmodified.
8167 This can be used for making spelling suggestions. Note that
8168 the method can be quite slow.
8169
8170 Can also be used as a |method|: >
8171 GetWord()->soundfold()
8172<
8173 *spellbadword()*
8174spellbadword([{sentence}])
8175 Without argument: The result is the badly spelled word under
8176 or after the cursor. The cursor is moved to the start of the
8177 bad word. When no bad word is found in the cursor line the
8178 result is an empty string and the cursor doesn't move.
8179
8180 With argument: The result is the first word in {sentence} that
8181 is badly spelled. If there are no spelling mistakes the
8182 result is an empty string.
8183
8184 The return value is a list with two items:
8185 - The badly spelled word or an empty string.
8186 - The type of the spelling error:
8187 "bad" spelling mistake
8188 "rare" rare word
8189 "local" word only valid in another region
8190 "caps" word should start with Capital
8191 Example: >
8192 echo spellbadword("the quik brown fox")
8193< ['quik', 'bad'] ~
8194
8195 The spelling information for the current window and the value
8196 of 'spelllang' are used.
8197
8198 Can also be used as a |method|: >
8199 GetText()->spellbadword()
8200<
8201 *spellsuggest()*
8202spellsuggest({word} [, {max} [, {capital}]])
8203 Return a |List| with spelling suggestions to replace {word}.
8204 When {max} is given up to this number of suggestions are
8205 returned. Otherwise up to 25 suggestions are returned.
8206
8207 When the {capital} argument is given and it's non-zero only
8208 suggestions with a leading capital will be given. Use this
8209 after a match with 'spellcapcheck'.
8210
8211 {word} can be a badly spelled word followed by other text.
8212 This allows for joining two words that were split. The
8213 suggestions also include the following text, thus you can
8214 replace a line.
8215
8216 {word} may also be a good word. Similar words will then be
8217 returned. {word} itself is not included in the suggestions,
8218 although it may appear capitalized.
8219
8220 The spelling information for the current window is used. The
8221 values of 'spelllang' and 'spellsuggest' are used.
8222
8223 Can also be used as a |method|: >
8224 GetWord()->spellsuggest()
8225
8226split({string} [, {pattern} [, {keepempty}]]) *split()*
8227 Make a |List| out of {string}. When {pattern} is omitted or
8228 empty each white-separated sequence of characters becomes an
8229 item.
8230 Otherwise the string is split where {pattern} matches,
8231 removing the matched characters. 'ignorecase' is not used
8232 here, add \c to ignore case. |/\c|
8233 When the first or last item is empty it is omitted, unless the
8234 {keepempty} argument is given and it's non-zero.
8235 Other empty items are kept when {pattern} matches at least one
8236 character or when {keepempty} is non-zero.
8237 Example: >
8238 :let words = split(getline('.'), '\W\+')
8239< To split a string in individual characters: >
8240 :for c in split(mystring, '\zs')
8241< If you want to keep the separator you can also use '\zs' at
8242 the end of the pattern: >
8243 :echo split('abc:def:ghi', ':\zs')
8244< ['abc:', 'def:', 'ghi'] ~
8245 Splitting a table where the first element can be empty: >
8246 :let items = split(line, ':', 1)
8247< The opposite function is |join()|.
8248
8249 Can also be used as a |method|: >
8250 GetString()->split()
8251
8252sqrt({expr}) *sqrt()*
8253 Return the non-negative square root of Float {expr} as a
8254 |Float|.
8255 {expr} must evaluate to a |Float| or a |Number|. When {expr}
8256 is negative the result is NaN (Not a Number).
8257 Examples: >
8258 :echo sqrt(100)
8259< 10.0 >
8260 :echo sqrt(-4.01)
8261< nan
8262 "nan" may be different, it depends on system libraries.
8263
8264 Can also be used as a |method|: >
8265 Compute()->sqrt()
8266<
8267 {only available when compiled with the |+float| feature}
8268
8269
8270srand([{expr}]) *srand()*
8271 Initialize seed used by |rand()|:
8272 - If {expr} is not given, seed values are initialized by
8273 reading from /dev/urandom, if possible, or using time(NULL)
8274 a.k.a. epoch time otherwise; this only has second accuracy.
8275 - If {expr} is given it must be a Number. It is used to
8276 initialize the seed values. This is useful for testing or
8277 when a predictable sequence is intended.
8278
8279 Examples: >
8280 :let seed = srand()
8281 :let seed = srand(userinput)
8282 :echo rand(seed)
8283
8284state([{what}]) *state()*
8285 Return a string which contains characters indicating the
8286 current state. Mostly useful in callbacks that want to do
8287 work that may not always be safe. Roughly this works like:
8288 - callback uses state() to check if work is safe to do.
8289 Yes: then do it right away.
8290 No: add to work queue and add a |SafeState| and/or
8291 |SafeStateAgain| autocommand (|SafeState| triggers at
8292 toplevel, |SafeStateAgain| triggers after handling
8293 messages and callbacks).
8294 - When SafeState or SafeStateAgain is triggered and executes
8295 your autocommand, check with `state()` if the work can be
8296 done now, and if yes remove it from the queue and execute.
8297 Remove the autocommand if the queue is now empty.
8298 Also see |mode()|.
8299
8300 When {what} is given only characters in this string will be
8301 added. E.g, this checks if the screen has scrolled: >
8302 if state('s') == ''
8303 " screen has not scrolled
8304<
8305 These characters indicate the state, generally indicating that
8306 something is busy:
8307 m halfway a mapping, :normal command, feedkeys() or
8308 stuffed command
8309 o operator pending, e.g. after |d|
8310 a Insert mode autocomplete active
8311 x executing an autocommand
8312 w blocked on waiting, e.g. ch_evalexpr(), ch_read() and
8313 ch_readraw() when reading json
8314 S not triggering SafeState or SafeStateAgain, e.g. after
8315 |f| or a count
8316 c callback invoked, including timer (repeats for
8317 recursiveness up to "ccc")
8318 s screen has scrolled for messages
8319
8320str2float({string} [, {quoted}]) *str2float()*
8321 Convert String {string} to a Float. This mostly works the
8322 same as when using a floating point number in an expression,
8323 see |floating-point-format|. But it's a bit more permissive.
8324 E.g., "1e40" is accepted, while in an expression you need to
8325 write "1.0e40". The hexadecimal form "0x123" is also
8326 accepted, but not others, like binary or octal.
8327 When {quoted} is present and non-zero then embedded single
8328 quotes before the dot are ignored, thus "1'000.0" is a
8329 thousand.
8330 Text after the number is silently ignored.
8331 The decimal point is always '.', no matter what the locale is
8332 set to. A comma ends the number: "12,345.67" is converted to
8333 12.0. You can strip out thousands separators with
8334 |substitute()|: >
8335 let f = str2float(substitute(text, ',', '', 'g'))
8336<
8337 Can also be used as a |method|: >
8338 let f = text->substitute(',', '', 'g')->str2float()
8339<
8340 {only available when compiled with the |+float| feature}
8341
8342str2list({string} [, {utf8}]) *str2list()*
8343 Return a list containing the number values which represent
8344 each character in String {string}. Examples: >
8345 str2list(" ") returns [32]
8346 str2list("ABC") returns [65, 66, 67]
8347< |list2str()| does the opposite.
8348
8349 When {utf8} is omitted or zero, the current 'encoding' is used.
8350 When {utf8} is TRUE, always treat the String as UTF-8
8351 characters. With UTF-8 composing characters are handled
8352 properly: >
8353 str2list("á") returns [97, 769]
8354
8355< Can also be used as a |method|: >
8356 GetString()->str2list()
8357
8358
8359str2nr({string} [, {base} [, {quoted}]]) *str2nr()*
8360 Convert string {string} to a number.
8361 {base} is the conversion base, it can be 2, 8, 10 or 16.
8362 When {quoted} is present and non-zero then embedded single
8363 quotes are ignored, thus "1'000'000" is a million.
8364
8365 When {base} is omitted base 10 is used. This also means that
8366 a leading zero doesn't cause octal conversion to be used, as
8367 with the default String to Number conversion. Example: >
8368 let nr = str2nr('0123')
8369<
8370 When {base} is 16 a leading "0x" or "0X" is ignored. With a
8371 different base the result will be zero. Similarly, when
8372 {base} is 8 a leading "0", "0o" or "0O" is ignored, and when
8373 {base} is 2 a leading "0b" or "0B" is ignored.
8374 Text after the number is silently ignored.
8375
8376 Can also be used as a |method|: >
8377 GetText()->str2nr()
8378
8379
8380strcharlen({string}) *strcharlen()*
8381 The result is a Number, which is the number of characters
8382 in String {string}. Composing characters are ignored.
8383 |strchars()| can count the number of characters, counting
8384 composing characters separately.
8385
8386 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
8387
8388 Can also be used as a |method|: >
8389 GetText()->strcharlen()
8390
8391
8392strcharpart({src}, {start} [, {len} [, {skipcc}]]) *strcharpart()*
8393 Like |strpart()| but using character index and length instead
8394 of byte index and length.
8395 When {skipcc} is omitted or zero, composing characters are
8396 counted separately.
8397 When {skipcc} set to 1, Composing characters are ignored,
8398 similar to |slice()|.
8399 When a character index is used where a character does not
8400 exist it is omitted and counted as one character. For
8401 example: >
8402 strcharpart('abc', -1, 2)
8403< results in 'a'.
8404
8405 Can also be used as a |method|: >
8406 GetText()->strcharpart(5)
8407
8408
8409strchars({string} [, {skipcc}]) *strchars()*
8410 The result is a Number, which is the number of characters
8411 in String {string}.
8412 When {skipcc} is omitted or zero, composing characters are
8413 counted separately.
8414 When {skipcc} set to 1, Composing characters are ignored.
8415 |strcharlen()| always does this.
8416
8417 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
8418
8419 {skipcc} is only available after 7.4.755. For backward
8420 compatibility, you can define a wrapper function: >
8421 if has("patch-7.4.755")
8422 function s:strchars(str, skipcc)
8423 return strchars(a:str, a:skipcc)
8424 endfunction
8425 else
8426 function s:strchars(str, skipcc)
8427 if a:skipcc
8428 return strlen(substitute(a:str, ".", "x", "g"))
8429 else
8430 return strchars(a:str)
8431 endif
8432 endfunction
8433 endif
8434<
8435 Can also be used as a |method|: >
8436 GetText()->strchars()
8437
8438strdisplaywidth({string} [, {col}]) *strdisplaywidth()*
8439 The result is a Number, which is the number of display cells
8440 String {string} occupies on the screen when it starts at {col}
8441 (first column is zero). When {col} is omitted zero is used.
8442 Otherwise it is the screen column where to start. This
8443 matters for Tab characters.
8444 The option settings of the current window are used. This
8445 matters for anything that's displayed differently, such as
8446 'tabstop' and 'display'.
8447 When {string} contains characters with East Asian Width Class
8448 Ambiguous, this function's return value depends on 'ambiwidth'.
8449 Also see |strlen()|, |strwidth()| and |strchars()|.
8450
8451 Can also be used as a |method|: >
8452 GetText()->strdisplaywidth()
8453
8454strftime({format} [, {time}]) *strftime()*
8455 The result is a String, which is a formatted date and time, as
8456 specified by the {format} string. The given {time} is used,
8457 or the current time if no time is given. The accepted
8458 {format} depends on your system, thus this is not portable!
8459 See the manual page of the C function strftime() for the
8460 format. The maximum length of the result is 80 characters.
8461 See also |localtime()|, |getftime()| and |strptime()|.
8462 The language can be changed with the |:language| command.
8463 Examples: >
8464 :echo strftime("%c") Sun Apr 27 11:49:23 1997
8465 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
8466 :echo strftime("%y%m%d %T") 970427 11:53:55
8467 :echo strftime("%H:%M") 11:55
8468 :echo strftime("%c", getftime("file.c"))
8469 Show mod time of file.c.
8470< Not available on all systems. To check use: >
8471 :if exists("*strftime")
8472
8473< Can also be used as a |method|: >
8474 GetFormat()->strftime()
8475
8476strgetchar({str}, {index}) *strgetchar()*
8477 Get character {index} from {str}. This uses a character
8478 index, not a byte index. Composing characters are considered
8479 separate characters here.
8480 Also see |strcharpart()| and |strchars()|.
8481
8482 Can also be used as a |method|: >
8483 GetText()->strgetchar(5)
8484
8485stridx({haystack}, {needle} [, {start}]) *stridx()*
8486 The result is a Number, which gives the byte index in
8487 {haystack} of the first occurrence of the String {needle}.
8488 If {start} is specified, the search starts at index {start}.
8489 This can be used to find a second match: >
8490 :let colon1 = stridx(line, ":")
8491 :let colon2 = stridx(line, ":", colon1 + 1)
8492< The search is done case-sensitive.
8493 For pattern searches use |match()|.
8494 -1 is returned if the {needle} does not occur in {haystack}.
8495 See also |strridx()|.
8496 Examples: >
8497 :echo stridx("An Example", "Example") 3
8498 :echo stridx("Starting point", "Start") 0
8499 :echo stridx("Starting point", "start") -1
8500< *strstr()* *strchr()*
8501 stridx() works similar to the C function strstr(). When used
8502 with a single character it works similar to strchr().
8503
8504 Can also be used as a |method|: >
8505 GetHaystack()->stridx(needle)
8506<
8507 *string()*
8508string({expr}) Return {expr} converted to a String. If {expr} is a Number,
8509 Float, String, Blob or a composition of them, then the result
8510 can be parsed back with |eval()|.
8511 {expr} type result ~
8512 String 'string' (single quotes are doubled)
8513 Number 123
8514 Float 123.123456 or 1.123456e8
8515 Funcref function('name')
8516 Blob 0z00112233.44556677.8899
8517 List [item, item]
8518 Dictionary {key: value, key: value}
8519
8520 When a |List| or |Dictionary| has a recursive reference it is
8521 replaced by "[...]" or "{...}". Using eval() on the result
8522 will then fail.
8523
8524 Can also be used as a |method|: >
8525 mylist->string()
8526
8527< Also see |strtrans()|.
8528
8529
8530strlen({string}) *strlen()*
8531 The result is a Number, which is the length of the String
8532 {string} in bytes.
8533 If the argument is a Number it is first converted to a String.
8534 For other types an error is given.
8535 If you want to count the number of multibyte characters use
8536 |strchars()|.
8537 Also see |len()|, |strdisplaywidth()| and |strwidth()|.
8538
8539 Can also be used as a |method|: >
8540 GetString()->strlen()
8541
8542strpart({src}, {start} [, {len} [, {chars}]]) *strpart()*
8543 The result is a String, which is part of {src}, starting from
8544 byte {start}, with the byte length {len}.
8545 When {chars} is present and TRUE then {len} is the number of
8546 characters positions (composing characters are not counted
8547 separately, thus "1" means one base character and any
8548 following composing characters).
8549 To count {start} as characters instead of bytes use
8550 |strcharpart()|.
8551
8552 When bytes are selected which do not exist, this doesn't
8553 result in an error, the bytes are simply omitted.
8554 If {len} is missing, the copy continues from {start} till the
8555 end of the {src}. >
8556 strpart("abcdefg", 3, 2) == "de"
8557 strpart("abcdefg", -2, 4) == "ab"
8558 strpart("abcdefg", 5, 4) == "fg"
8559 strpart("abcdefg", 3) == "defg"
8560
8561< Note: To get the first character, {start} must be 0. For
8562 example, to get the character under the cursor: >
8563 strpart(getline("."), col(".") - 1, 1, v:true)
8564<
8565 Can also be used as a |method|: >
8566 GetText()->strpart(5)
8567
8568strptime({format}, {timestring}) *strptime()*
8569 The result is a Number, which is a unix timestamp representing
8570 the date and time in {timestring}, which is expected to match
8571 the format specified in {format}.
8572
8573 The accepted {format} depends on your system, thus this is not
8574 portable! See the manual page of the C function strptime()
8575 for the format. Especially avoid "%c". The value of $TZ also
8576 matters.
8577
8578 If the {timestring} cannot be parsed with {format} zero is
8579 returned. If you do not know the format of {timestring} you
8580 can try different {format} values until you get a non-zero
8581 result.
8582
8583 See also |strftime()|.
8584 Examples: >
8585 :echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23")
8586< 862156163 >
8587 :echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55"))
8588< Sun Apr 27 11:53:55 1997 >
8589 :echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
8590< Sun Apr 27 12:53:55 1997
8591
8592 Can also be used as a |method|: >
8593 GetFormat()->strptime(timestring)
8594<
8595 Not available on all systems. To check use: >
8596 :if exists("*strptime")
8597
8598strridx({haystack}, {needle} [, {start}]) *strridx()*
8599 The result is a Number, which gives the byte index in
8600 {haystack} of the last occurrence of the String {needle}.
8601 When {start} is specified, matches beyond this index are
8602 ignored. This can be used to find a match before a previous
8603 match: >
8604 :let lastcomma = strridx(line, ",")
8605 :let comma2 = strridx(line, ",", lastcomma - 1)
8606< The search is done case-sensitive.
8607 For pattern searches use |match()|.
8608 -1 is returned if the {needle} does not occur in {haystack}.
8609 If the {needle} is empty the length of {haystack} is returned.
8610 See also |stridx()|. Examples: >
8611 :echo strridx("an angry armadillo", "an") 3
8612< *strrchr()*
8613 When used with a single character it works similar to the C
8614 function strrchr().
8615
8616 Can also be used as a |method|: >
8617 GetHaystack()->strridx(needle)
8618
8619strtrans({string}) *strtrans()*
8620 The result is a String, which is {string} with all unprintable
8621 characters translated into printable characters |'isprint'|.
8622 Like they are shown in a window. Example: >
8623 echo strtrans(@a)
8624< This displays a newline in register a as "^@" instead of
8625 starting a new line.
8626
8627 Can also be used as a |method|: >
8628 GetString()->strtrans()
8629
8630strwidth({string}) *strwidth()*
8631 The result is a Number, which is the number of display cells
8632 String {string} occupies. A Tab character is counted as one
8633 cell, alternatively use |strdisplaywidth()|.
8634 When {string} contains characters with East Asian Width Class
8635 Ambiguous, this function's return value depends on 'ambiwidth'.
8636 Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
8637
8638 Can also be used as a |method|: >
8639 GetString()->strwidth()
8640
8641submatch({nr} [, {list}]) *submatch()* *E935*
8642 Only for an expression in a |:substitute| command or
8643 substitute() function.
8644 Returns the {nr}'th submatch of the matched text. When {nr}
8645 is 0 the whole matched text is returned.
8646 Note that a NL in the string can stand for a line break of a
8647 multi-line match or a NUL character in the text.
8648 Also see |sub-replace-expression|.
8649
8650 If {list} is present and non-zero then submatch() returns
8651 a list of strings, similar to |getline()| with two arguments.
8652 NL characters in the text represent NUL characters in the
8653 text.
8654 Only returns more than one item for |:substitute|, inside
8655 |substitute()| this list will always contain one or zero
8656 items, since there are no real line breaks.
8657
8658 When substitute() is used recursively only the submatches in
8659 the current (deepest) call can be obtained.
8660
8661 Examples: >
8662 :s/\d\+/\=submatch(0) + 1/
8663 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
8664< This finds the first number in the line and adds one to it.
8665 A line break is included as a newline character.
8666
8667 Can also be used as a |method|: >
8668 GetNr()->submatch()
8669
8670substitute({string}, {pat}, {sub}, {flags}) *substitute()*
8671 The result is a String, which is a copy of {string}, in which
8672 the first match of {pat} is replaced with {sub}.
8673 When {flags} is "g", all matches of {pat} in {string} are
8674 replaced. Otherwise {flags} should be "".
8675
8676 This works like the ":substitute" command (without any flags).
8677 But the matching with {pat} is always done like the 'magic'
8678 option is set and 'cpoptions' is empty (to make scripts
8679 portable). 'ignorecase' is still relevant, use |/\c| or |/\C|
8680 if you want to ignore or match case and ignore 'ignorecase'.
8681 'smartcase' is not used. See |string-match| for how {pat} is
8682 used.
8683
8684 A "~" in {sub} is not replaced with the previous {sub}.
8685 Note that some codes in {sub} have a special meaning
8686 |sub-replace-special|. For example, to replace something with
8687 "\n" (two characters), use "\\\\n" or '\\n'.
8688
8689 When {pat} does not match in {string}, {string} is returned
8690 unmodified.
8691
8692 Example: >
8693 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
8694< This removes the last component of the 'path' option. >
8695 :echo substitute("testing", ".*", "\\U\\0", "")
8696< results in "TESTING".
8697
8698 When {sub} starts with "\=", the remainder is interpreted as
8699 an expression. See |sub-replace-expression|. Example: >
8700 :echo substitute(s, '%\(\x\x\)',
8701 \ '\=nr2char("0x" . submatch(1))', 'g')
8702
8703< When {sub} is a Funcref that function is called, with one
8704 optional argument. Example: >
8705 :echo substitute(s, '%\(\x\x\)', SubNr, 'g')
8706< The optional argument is a list which contains the whole
8707 matched string and up to nine submatches, like what
8708 |submatch()| returns. Example: >
8709 :echo substitute(s, '%\(\x\x\)', {m -> '0x' . m[1]}, 'g')
8710
8711< Can also be used as a |method|: >
8712 GetString()->substitute(pat, sub, flags)
8713
8714swapinfo({fname}) *swapinfo()*
8715 The result is a dictionary, which holds information about the
8716 swapfile {fname}. The available fields are:
8717 version Vim version
8718 user user name
8719 host host name
8720 fname original file name
8721 pid PID of the Vim process that created the swap
8722 file
8723 mtime last modification time in seconds
8724 inode Optional: INODE number of the file
8725 dirty 1 if file was modified, 0 if not
8726 Note that "user" and "host" are truncated to at most 39 bytes.
8727 In case of failure an "error" item is added with the reason:
8728 Cannot open file: file not found or in accessible
8729 Cannot read file: cannot read first block
8730 Not a swap file: does not contain correct block ID
8731 Magic number mismatch: Info in first block is invalid
8732
8733 Can also be used as a |method|: >
8734 GetFilename()->swapinfo()
8735
8736swapname({buf}) *swapname()*
8737 The result is the swap file path of the buffer {expr}.
8738 For the use of {buf}, see |bufname()| above.
8739 If buffer {buf} is the current buffer, the result is equal to
8740 |:swapname| (unless there is no swap file).
8741 If buffer {buf} has no swap file, returns an empty string.
8742
8743 Can also be used as a |method|: >
8744 GetBufname()->swapname()
8745
8746synID({lnum}, {col}, {trans}) *synID()*
8747 The result is a Number, which is the syntax ID at the position
8748 {lnum} and {col} in the current window.
8749 The syntax ID can be used with |synIDattr()| and
8750 |synIDtrans()| to obtain syntax information about text.
8751
8752 {col} is 1 for the leftmost column, {lnum} is 1 for the first
8753 line. 'synmaxcol' applies, in a longer line zero is returned.
8754 Note that when the position is after the last character,
8755 that's where the cursor can be in Insert mode, synID() returns
8756 zero. {lnum} is used like with |getline()|.
8757
8758 When {trans} is |TRUE|, transparent items are reduced to the
8759 item that they reveal. This is useful when wanting to know
8760 the effective color. When {trans} is |FALSE|, the transparent
8761 item is returned. This is useful when wanting to know which
8762 syntax item is effective (e.g. inside parens).
8763 Warning: This function can be very slow. Best speed is
8764 obtained by going through the file in forward direction.
8765
8766 Example (echoes the name of the syntax item under the cursor): >
8767 :echo synIDattr(synID(line("."), col("."), 1), "name")
8768<
8769
8770synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
8771 The result is a String, which is the {what} attribute of
8772 syntax ID {synID}. This can be used to obtain information
8773 about a syntax item.
8774 {mode} can be "gui", "cterm" or "term", to get the attributes
8775 for that mode. When {mode} is omitted, or an invalid value is
8776 used, the attributes for the currently active highlighting are
8777 used (GUI, cterm or term).
8778 Use synIDtrans() to follow linked highlight groups.
8779 {what} result
8780 "name" the name of the syntax item
8781 "fg" foreground color (GUI: color name used to set
8782 the color, cterm: color number as a string,
8783 term: empty string)
8784 "bg" background color (as with "fg")
8785 "font" font name (only available in the GUI)
8786 |highlight-font|
8787 "sp" special color for the GUI (as with "fg")
8788 |highlight-guisp|
8789 "ul" underline color for cterm: number as a string
8790 "fg#" like "fg", but for the GUI and the GUI is
8791 running the name in "#RRGGBB" form
8792 "bg#" like "fg#" for "bg"
8793 "sp#" like "fg#" for "sp"
8794 "bold" "1" if bold
8795 "italic" "1" if italic
8796 "reverse" "1" if reverse
8797 "inverse" "1" if inverse (= reverse)
8798 "standout" "1" if standout
8799 "underline" "1" if underlined
8800 "undercurl" "1" if undercurled
8801 "strike" "1" if strikethrough
8802
8803 Example (echoes the color of the syntax item under the
8804 cursor): >
8805 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
8806<
8807 Can also be used as a |method|: >
8808 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
8809
8810
8811synIDtrans({synID}) *synIDtrans()*
8812 The result is a Number, which is the translated syntax ID of
8813 {synID}. This is the syntax group ID of what is being used to
8814 highlight the character. Highlight links given with
8815 ":highlight link" are followed.
8816
8817 Can also be used as a |method|: >
8818 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
8819
8820synconcealed({lnum}, {col}) *synconcealed()*
8821 The result is a |List| with currently three items:
8822 1. The first item in the list is 0 if the character at the
8823 position {lnum} and {col} is not part of a concealable
8824 region, 1 if it is. {lnum} is used like with |getline()|.
8825 2. The second item in the list is a string. If the first item
8826 is 1, the second item contains the text which will be
8827 displayed in place of the concealed text, depending on the
8828 current setting of 'conceallevel' and 'listchars'.
8829 3. The third and final item in the list is a number
8830 representing the specific syntax region matched in the
8831 line. When the character is not concealed the value is
8832 zero. This allows detection of the beginning of a new
8833 concealable region if there are two consecutive regions
8834 with the same replacement character. For an example, if
8835 the text is "123456" and both "23" and "45" are concealed
8836 and replaced by the character "X", then:
8837 call returns ~
8838 synconcealed(lnum, 1) [0, '', 0]
8839 synconcealed(lnum, 2) [1, 'X', 1]
8840 synconcealed(lnum, 3) [1, 'X', 1]
8841 synconcealed(lnum, 4) [1, 'X', 2]
8842 synconcealed(lnum, 5) [1, 'X', 2]
8843 synconcealed(lnum, 6) [0, '', 0]
8844
8845
8846synstack({lnum}, {col}) *synstack()*
8847 Return a |List|, which is the stack of syntax items at the
8848 position {lnum} and {col} in the current window. {lnum} is
8849 used like with |getline()|. Each item in the List is an ID
8850 like what |synID()| returns.
8851 The first item in the List is the outer region, following are
8852 items contained in that one. The last one is what |synID()|
8853 returns, unless not the whole item is highlighted or it is a
8854 transparent item.
8855 This function is useful for debugging a syntax file.
8856 Example that shows the syntax stack under the cursor: >
8857 for id in synstack(line("."), col("."))
8858 echo synIDattr(id, "name")
8859 endfor
8860< When the position specified with {lnum} and {col} is invalid
8861 nothing is returned. The position just after the last
8862 character in a line and the first column in an empty line are
8863 valid positions.
8864
8865system({expr} [, {input}]) *system()* *E677*
8866 Get the output of the shell command {expr} as a |String|. See
8867 |systemlist()| to get the output as a |List|.
8868
8869 When {input} is given and is a |String| this string is written
8870 to a file and passed as stdin to the command. The string is
8871 written as-is, you need to take care of using the correct line
8872 separators yourself.
8873 If {input} is given and is a |List| it is written to the file
8874 in a way |writefile()| does with {binary} set to "b" (i.e.
8875 with a newline between each list item with newlines inside
8876 list items converted to NULs).
8877 When {input} is given and is a number that is a valid id for
8878 an existing buffer then the content of the buffer is written
8879 to the file line by line, each line terminated by a NL and
8880 NULs characters where the text has a NL.
8881
8882 Pipes are not used, the 'shelltemp' option is not used.
8883
8884 When prepended by |:silent| the terminal will not be set to
8885 cooked mode. This is meant to be used for commands that do
8886 not need the user to type. It avoids stray characters showing
8887 up on the screen which require |CTRL-L| to remove. >
8888 :silent let f = system('ls *.vim')
8889<
8890 Note: Use |shellescape()| or |::S| with |expand()| or
8891 |fnamemodify()| to escape special characters in a command
8892 argument. Newlines in {expr} may cause the command to fail.
8893 The characters in 'shellquote' and 'shellxquote' may also
8894 cause trouble.
8895 This is not to be used for interactive commands.
8896
8897 The result is a String. Example: >
8898 :let files = system("ls " . shellescape(expand('%:h')))
8899 :let files = system('ls ' . expand('%:h:S'))
8900
8901< To make the result more system-independent, the shell output
8902 is filtered to replace <CR> with <NL> for Macintosh, and
8903 <CR><NL> with <NL> for DOS-like systems.
8904 To avoid the string being truncated at a NUL, all NUL
8905 characters are replaced with SOH (0x01).
8906
8907 The command executed is constructed using several options:
8908 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
8909 ({tmp} is an automatically generated file name).
8910 For Unix, braces are put around {expr} to allow for
8911 concatenated commands.
8912
8913 The command will be executed in "cooked" mode, so that a
8914 CTRL-C will interrupt the command (on Unix at least).
8915
8916 The resulting error code can be found in |v:shell_error|.
8917 This function will fail in |restricted-mode|.
8918
8919 Note that any wrong value in the options mentioned above may
8920 make the function fail. It has also been reported to fail
8921 when using a security agent application.
8922 Unlike ":!cmd" there is no automatic check for changed files.
8923 Use |:checktime| to force a check.
8924
8925 Can also be used as a |method|: >
8926 :echo GetCmd()->system()
8927
8928
8929systemlist({expr} [, {input}]) *systemlist()*
8930 Same as |system()|, but returns a |List| with lines (parts of
8931 output separated by NL) with NULs transformed into NLs. Output
8932 is the same as |readfile()| will output with {binary} argument
8933 set to "b", except that there is no extra empty item when the
8934 result ends in a NL.
8935 Note that on MS-Windows you may get trailing CR characters.
8936
8937 To see the difference between "echo hello" and "echo -n hello"
8938 use |system()| and |split()|: >
8939 echo system('echo hello')->split('\n', 1)
8940<
8941 Returns an empty string on error.
8942
8943 Can also be used as a |method|: >
8944 :echo GetCmd()->systemlist()
8945
8946
8947tabpagebuflist([{arg}]) *tabpagebuflist()*
8948 The result is a |List|, where each item is the number of the
8949 buffer associated with each window in the current tab page.
8950 {arg} specifies the number of the tab page to be used. When
8951 omitted the current tab page is used.
8952 When {arg} is invalid the number zero is returned.
8953 To get a list of all buffers in all tabs use this: >
8954 let buflist = []
8955 for i in range(tabpagenr('$'))
8956 call extend(buflist, tabpagebuflist(i + 1))
8957 endfor
8958< Note that a buffer may appear in more than one window.
8959
8960 Can also be used as a |method|: >
8961 GetTabpage()->tabpagebuflist()
8962
8963tabpagenr([{arg}]) *tabpagenr()*
8964 The result is a Number, which is the number of the current
8965 tab page. The first tab page has number 1.
8966
8967 The optional argument {arg} supports the following values:
8968 $ the number of the last tab page (the tab page
8969 count).
8970 # the number of the last accessed tab page
8971 (where |g<Tab>| goes to). if there is no
8972 previous tab page 0 is returned.
8973 The number can be used with the |:tab| command.
8974
8975
8976tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()*
8977 Like |winnr()| but for tab page {tabarg}.
8978 {tabarg} specifies the number of tab page to be used.
8979 {arg} is used like with |winnr()|:
8980 - When omitted the current window number is returned. This is
8981 the window which will be used when going to this tab page.
8982 - When "$" the number of windows is returned.
8983 - When "#" the previous window nr is returned.
8984 Useful examples: >
8985 tabpagewinnr(1) " current window of tab page 1
8986 tabpagewinnr(4, '$') " number of windows in tab page 4
8987< When {tabarg} is invalid zero is returned.
8988
8989 Can also be used as a |method|: >
8990 GetTabpage()->tabpagewinnr()
8991<
8992 *tagfiles()*
8993tagfiles() Returns a |List| with the file names used to search for tags
8994 for the current buffer. This is the 'tags' option expanded.
8995
8996
8997taglist({expr} [, {filename}]) *taglist()*
8998 Returns a |List| of tags matching the regular expression {expr}.
8999
9000 If {filename} is passed it is used to prioritize the results
9001 in the same way that |:tselect| does. See |tag-priority|.
9002 {filename} should be the full path of the file.
9003
9004 Each list item is a dictionary with at least the following
9005 entries:
9006 name Name of the tag.
9007 filename Name of the file where the tag is
9008 defined. It is either relative to the
9009 current directory or a full path.
9010 cmd Ex command used to locate the tag in
9011 the file.
9012 kind Type of the tag. The value for this
9013 entry depends on the language specific
9014 kind values. Only available when
9015 using a tags file generated by
9016 Exuberant ctags or hdrtag.
9017 static A file specific tag. Refer to
9018 |static-tag| for more information.
9019 More entries may be present, depending on the content of the
9020 tags file: access, implementation, inherits and signature.
9021 Refer to the ctags documentation for information about these
9022 fields. For C code the fields "struct", "class" and "enum"
9023 may appear, they give the name of the entity the tag is
9024 contained in.
9025
9026 The ex-command "cmd" can be either an ex search pattern, a
9027 line number or a line number followed by a byte number.
9028
9029 If there are no matching tags, then an empty list is returned.
9030
9031 To get an exact tag match, the anchors '^' and '$' should be
9032 used in {expr}. This also make the function work faster.
9033 Refer to |tag-regexp| for more information about the tag
9034 search regular expression pattern.
9035
9036 Refer to |'tags'| for information about how the tags file is
9037 located by Vim. Refer to |tags-file-format| for the format of
9038 the tags file generated by the different ctags tools.
9039
9040 Can also be used as a |method|: >
9041 GetTagpattern()->taglist()
9042
9043tan({expr}) *tan()*
9044 Return the tangent of {expr}, measured in radians, as a |Float|
9045 in the range [-inf, inf].
9046 {expr} must evaluate to a |Float| or a |Number|.
9047 Examples: >
9048 :echo tan(10)
9049< 0.648361 >
9050 :echo tan(-4.01)
9051< -1.181502
9052
9053 Can also be used as a |method|: >
9054 Compute()->tan()
9055<
9056 {only available when compiled with the |+float| feature}
9057
9058
9059tanh({expr}) *tanh()*
9060 Return the hyperbolic tangent of {expr} as a |Float| in the
9061 range [-1, 1].
9062 {expr} must evaluate to a |Float| or a |Number|.
9063 Examples: >
9064 :echo tanh(0.5)
9065< 0.462117 >
9066 :echo tanh(-1)
9067< -0.761594
9068
9069 Can also be used as a |method|: >
9070 Compute()->tanh()
9071<
9072 {only available when compiled with the |+float| feature}
9073
9074
9075tempname() *tempname()* *temp-file-name*
9076 The result is a String, which is the name of a file that
9077 doesn't exist. It can be used for a temporary file. The name
9078 is different for at least 26 consecutive calls. Example: >
9079 :let tmpfile = tempname()
9080 :exe "redir > " . tmpfile
9081< For Unix, the file will be in a private directory |tempfile|.
9082 For MS-Windows forward slashes are used when the 'shellslash'
9083 option is set, or when 'shellcmdflag' starts with '-' and
9084 'shell' does not contain powershell or pwsh.
9085
9086
9087term_ functions are documented here: |terminal-function-details|
9088
9089
9090terminalprops() *terminalprops()*
9091 Returns a |Dictionary| with properties of the terminal that Vim
9092 detected from the response to |t_RV| request. See
9093 |v:termresponse| for the response itself. If |v:termresponse|
9094 is empty most values here will be 'u' for unknown.
9095 cursor_style whether sending |t_RS| works **
9096 cursor_blink_mode whether sending |t_RC| works **
9097 underline_rgb whether |t_8u| works **
9098 mouse mouse type supported
9099
9100 ** value 'u' for unknown, 'y' for yes, 'n' for no
9101
9102 If the |+termresponse| feature is missing then the result is
9103 an empty dictionary.
9104
9105 If "cursor_style" is 'y' then |t_RS| will be sent to request the
9106 current cursor style.
9107 If "cursor_blink_mode" is 'y' then |t_RC| will be sent to
9108 request the cursor blink status.
9109 "cursor_style" and "cursor_blink_mode" are also set if |t_u7|
9110 is not empty, Vim will detect the working of sending |t_RS|
9111 and |t_RC| on startup.
9112
9113 When "underline_rgb" is not 'y', then |t_8u| will be made empty.
9114 This avoids sending it to xterm, which would clear the colors.
9115
9116 For "mouse" the value 'u' is unknown
9117
9118 Also see:
9119 - 'ambiwidth' - detected by using |t_u7|.
9120 - |v:termstyleresp| and |v:termblinkresp| for the response to
9121 |t_RS| and |t_RC|.
9122
9123
9124test_ functions are documented here: |test-functions-details|
9125
9126
9127 *timer_info()*
9128timer_info([{id}])
9129 Return a list with information about timers.
9130 When {id} is given only information about this timer is
9131 returned. When timer {id} does not exist an empty list is
9132 returned.
9133 When {id} is omitted information about all timers is returned.
9134
9135 For each timer the information is stored in a |Dictionary| with
9136 these items:
9137 "id" the timer ID
9138 "time" time the timer was started with
9139 "remaining" time until the timer fires
9140 "repeat" number of times the timer will still fire;
9141 -1 means forever
9142 "callback" the callback
9143 "paused" 1 if the timer is paused, 0 otherwise
9144
9145 Can also be used as a |method|: >
9146 GetTimer()->timer_info()
9147
9148< {only available when compiled with the |+timers| feature}
9149
9150timer_pause({timer}, {paused}) *timer_pause()*
9151 Pause or unpause a timer. A paused timer does not invoke its
9152 callback when its time expires. Unpausing a timer may cause
9153 the callback to be invoked almost immediately if enough time
9154 has passed.
9155
9156 Pausing a timer is useful to avoid the callback to be called
9157 for a short time.
9158
9159 If {paused} evaluates to a non-zero Number or a non-empty
9160 String, then the timer is paused, otherwise it is unpaused.
9161 See |non-zero-arg|.
9162
9163 Can also be used as a |method|: >
9164 GetTimer()->timer_pause(1)
9165
9166< {only available when compiled with the |+timers| feature}
9167
9168 *timer_start()* *timer* *timers*
9169timer_start({time}, {callback} [, {options}])
9170 Create a timer and return the timer ID.
9171
9172 {time} is the waiting time in milliseconds. This is the
9173 minimum time before invoking the callback. When the system is
9174 busy or Vim is not waiting for input the time will be longer.
9175
9176 {callback} is the function to call. It can be the name of a
9177 function or a |Funcref|. It is called with one argument, which
9178 is the timer ID. The callback is only invoked when Vim is
9179 waiting for input.
9180 If you want to show a message look at |popup_notification()|
9181 to avoid interfering with what the user is doing.
9182
9183 {options} is a dictionary. Supported entries:
9184 "repeat" Number of times to repeat calling the
9185 callback. -1 means forever. When not present
9186 the callback will be called once.
9187 If the timer causes an error three times in a
9188 row the repeat is cancelled. This avoids that
9189 Vim becomes unusable because of all the error
9190 messages.
9191
9192 Example: >
9193 func MyHandler(timer)
9194 echo 'Handler called'
9195 endfunc
9196 let timer = timer_start(500, 'MyHandler',
9197 \ {'repeat': 3})
9198< This will invoke MyHandler() three times at 500 msec
9199 intervals.
9200
9201 Can also be used as a |method|: >
9202 GetMsec()->timer_start(callback)
9203
9204< Not available in the |sandbox|.
9205 {only available when compiled with the |+timers| feature}
9206
9207timer_stop({timer}) *timer_stop()*
9208 Stop a timer. The timer callback will no longer be invoked.
9209 {timer} is an ID returned by timer_start(), thus it must be a
9210 Number. If {timer} does not exist there is no error.
9211
9212 Can also be used as a |method|: >
9213 GetTimer()->timer_stop()
9214
9215< {only available when compiled with the |+timers| feature}
9216
9217timer_stopall() *timer_stopall()*
9218 Stop all timers. The timer callbacks will no longer be
9219 invoked. Useful if a timer is misbehaving. If there are no
9220 timers there is no error.
9221
9222 {only available when compiled with the |+timers| feature}
9223
9224tolower({expr}) *tolower()*
9225 The result is a copy of the String given, with all uppercase
9226 characters turned into lowercase (just like applying |gu| to
9227 the string).
9228
9229 Can also be used as a |method|: >
9230 GetText()->tolower()
9231
9232toupper({expr}) *toupper()*
9233 The result is a copy of the String given, with all lowercase
9234 characters turned into uppercase (just like applying |gU| to
9235 the string).
9236
9237 Can also be used as a |method|: >
9238 GetText()->toupper()
9239
9240tr({src}, {fromstr}, {tostr}) *tr()*
9241 The result is a copy of the {src} string with all characters
9242 which appear in {fromstr} replaced by the character in that
9243 position in the {tostr} string. Thus the first character in
9244 {fromstr} is translated into the first character in {tostr}
9245 and so on. Exactly like the unix "tr" command.
9246 This code also deals with multibyte characters properly.
9247
9248 Examples: >
9249 echo tr("hello there", "ht", "HT")
9250< returns "Hello THere" >
9251 echo tr("<blob>", "<>", "{}")
9252< returns "{blob}"
9253
9254 Can also be used as a |method|: >
9255 GetText()->tr(from, to)
9256
9257trim({text} [, {mask} [, {dir}]]) *trim()*
9258 Return {text} as a String where any character in {mask} is
9259 removed from the beginning and/or end of {text}.
9260
9261 If {mask} is not given, {mask} is all characters up to 0x20,
9262 which includes Tab, space, NL and CR, plus the non-breaking
9263 space character 0xa0.
9264
9265 The optional {dir} argument specifies where to remove the
9266 characters:
9267 0 remove from the beginning and end of {text}
9268 1 remove only at the beginning of {text}
9269 2 remove only at the end of {text}
9270 When omitted both ends are trimmed.
9271
9272 This function deals with multibyte characters properly.
9273
9274 Examples: >
9275 echo trim(" some text ")
9276< returns "some text" >
9277 echo trim(" \r\t\t\r RESERVE \t\n\x0B\xA0") . "_TAIL"
9278< returns "RESERVE_TAIL" >
9279 echo trim("rm<Xrm<>X>rrm", "rm<>")
9280< returns "Xrm<>X" (characters in the middle are not removed) >
9281 echo trim(" vim ", " ", 2)
9282< returns " vim"
9283
9284 Can also be used as a |method|: >
9285 GetText()->trim()
9286
9287trunc({expr}) *trunc()*
9288 Return the largest integral value with magnitude less than or
9289 equal to {expr} as a |Float| (truncate towards zero).
9290 {expr} must evaluate to a |Float| or a |Number|.
9291 Examples: >
9292 echo trunc(1.456)
9293< 1.0 >
9294 echo trunc(-5.456)
9295< -5.0 >
9296 echo trunc(4.0)
9297< 4.0
9298
9299 Can also be used as a |method|: >
9300 Compute()->trunc()
9301<
9302 {only available when compiled with the |+float| feature}
9303
9304 *type()*
9305type({expr}) The result is a Number representing the type of {expr}.
9306 Instead of using the number directly, it is better to use the
9307 v:t_ variable that has the value:
9308 Number: 0 |v:t_number|
9309 String: 1 |v:t_string|
9310 Funcref: 2 |v:t_func|
9311 List: 3 |v:t_list|
9312 Dictionary: 4 |v:t_dict|
9313 Float: 5 |v:t_float|
9314 Boolean: 6 |v:t_bool| (v:false and v:true)
9315 None: 7 |v:t_none| (v:null and v:none)
9316 Job: 8 |v:t_job|
9317 Channel: 9 |v:t_channel|
9318 Blob: 10 |v:t_blob|
9319 For backward compatibility, this method can be used: >
9320 :if type(myvar) == type(0)
9321 :if type(myvar) == type("")
9322 :if type(myvar) == type(function("tr"))
9323 :if type(myvar) == type([])
9324 :if type(myvar) == type({})
9325 :if type(myvar) == type(0.0)
9326 :if type(myvar) == type(v:false)
9327 :if type(myvar) == type(v:none)
9328< To check if the v:t_ variables exist use this: >
9329 :if exists('v:t_number')
9330
9331< Can also be used as a |method|: >
9332 mylist->type()
9333
9334
9335typename({expr}) *typename()*
9336 Return a string representation of the type of {expr}.
9337 Example: >
9338 echo typename([1, 2, 3])
9339 list<number>
9340
9341
9342undofile({name}) *undofile()*
9343 Return the name of the undo file that would be used for a file
9344 with name {name} when writing. This uses the 'undodir'
9345 option, finding directories that exist. It does not check if
9346 the undo file exists.
9347 {name} is always expanded to the full path, since that is what
9348 is used internally.
9349 If {name} is empty undofile() returns an empty string, since a
9350 buffer without a file name will not write an undo file.
9351 Useful in combination with |:wundo| and |:rundo|.
9352 When compiled without the |+persistent_undo| option this always
9353 returns an empty string.
9354
9355 Can also be used as a |method|: >
9356 GetFilename()->undofile()
9357
9358undotree() *undotree()*
9359 Return the current state of the undo tree in a dictionary with
9360 the following items:
9361 "seq_last" The highest undo sequence number used.
9362 "seq_cur" The sequence number of the current position in
9363 the undo tree. This differs from "seq_last"
9364 when some changes were undone.
9365 "time_cur" Time last used for |:earlier| and related
9366 commands. Use |strftime()| to convert to
9367 something readable.
9368 "save_last" Number of the last file write. Zero when no
9369 write yet.
9370 "save_cur" Number of the current position in the undo
9371 tree.
9372 "synced" Non-zero when the last undo block was synced.
9373 This happens when waiting from input from the
9374 user. See |undo-blocks|.
9375 "entries" A list of dictionaries with information about
9376 undo blocks.
9377
9378 The first item in the "entries" list is the oldest undo item.
9379 Each List item is a |Dictionary| with these items:
9380 "seq" Undo sequence number. Same as what appears in
9381 |:undolist|.
9382 "time" Timestamp when the change happened. Use
9383 |strftime()| to convert to something readable.
9384 "newhead" Only appears in the item that is the last one
9385 that was added. This marks the last change
9386 and where further changes will be added.
9387 "curhead" Only appears in the item that is the last one
9388 that was undone. This marks the current
9389 position in the undo tree, the block that will
9390 be used by a redo command. When nothing was
9391 undone after the last change this item will
9392 not appear anywhere.
9393 "save" Only appears on the last block before a file
9394 write. The number is the write count. The
9395 first write has number 1, the last one the
9396 "save_last" mentioned above.
9397 "alt" Alternate entry. This is again a List of undo
9398 blocks. Each item may again have an "alt"
9399 item.
9400
9401uniq({list} [, {func} [, {dict}]]) *uniq()* *E882*
9402 Remove second and succeeding copies of repeated adjacent
9403 {list} items in-place. Returns {list}. If you want a list
9404 to remain unmodified make a copy first: >
9405 :let newlist = uniq(copy(mylist))
9406< The default compare function uses the string representation of
9407 each item. For the use of {func} and {dict} see |sort()|.
9408
9409 Can also be used as a |method|: >
9410 mylist->uniq()
9411
9412values({dict}) *values()*
9413 Return a |List| with all the values of {dict}. The |List| is
9414 in arbitrary order. Also see |items()| and |keys()|.
9415
9416 Can also be used as a |method|: >
9417 mydict->values()
9418
9419virtcol({expr}) *virtcol()*
9420 The result is a Number, which is the screen column of the file
9421 position given with {expr}. That is, the last screen position
9422 occupied by the character at that position, when the screen
9423 would be of unlimited width. When there is a <Tab> at the
9424 position, the returned Number will be the column at the end of
9425 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
9426 set to 8, it returns 8. |conceal| is ignored.
9427 For the byte position use |col()|.
9428 For the use of {expr} see |col()|.
9429 When 'virtualedit' is used {expr} can be [lnum, col, off], where
9430 "off" is the offset in screen columns from the start of the
9431 character. E.g., a position within a <Tab> or after the last
9432 character. When "off" is omitted zero is used.
9433 When Virtual editing is active in the current mode, a position
9434 beyond the end of the line can be returned. |'virtualedit'|
9435 The accepted positions are:
9436 . the cursor position
9437 $ the end of the cursor line (the result is the
9438 number of displayed characters in the cursor line
9439 plus one)
9440 'x position of mark x (if the mark is not set, 0 is
9441 returned)
9442 v In Visual mode: the start of the Visual area (the
9443 cursor is the end). When not in Visual mode
9444 returns the cursor position. Differs from |'<| in
9445 that it's updated right away.
9446 Note that only marks in the current file can be used.
9447 Examples: >
9448 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
9449 virtcol("$") with text "foo^Lbar", returns 9
9450 virtcol("'t") with text " there", with 't at 'h', returns 6
9451< The first column is 1. 0 is returned for an error.
9452 A more advanced example that echoes the maximum length of
9453 all lines: >
9454 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
9455
9456< Can also be used as a |method|: >
9457 GetPos()->virtcol()
9458
9459
9460visualmode([{expr}]) *visualmode()*
9461 The result is a String, which describes the last Visual mode
9462 used in the current buffer. Initially it returns an empty
9463 string, but once Visual mode has been used, it returns "v",
9464 "V", or "<CTRL-V>" (a single CTRL-V character) for
9465 character-wise, line-wise, or block-wise Visual mode
9466 respectively.
9467 Example: >
9468 :exe "normal " . visualmode()
9469< This enters the same Visual mode as before. It is also useful
9470 in scripts if you wish to act differently depending on the
9471 Visual mode that was used.
9472 If Visual mode is active, use |mode()| to get the Visual mode
9473 (e.g., in a |:vmap|).
9474 If {expr} is supplied and it evaluates to a non-zero Number or
9475 a non-empty String, then the Visual mode will be cleared and
9476 the old value is returned. See |non-zero-arg|.
9477
9478wildmenumode() *wildmenumode()*
9479 Returns |TRUE| when the wildmenu is active and |FALSE|
9480 otherwise. See 'wildmenu' and 'wildmode'.
9481 This can be used in mappings to handle the 'wildcharm' option
9482 gracefully. (Makes only sense with |mapmode-c| mappings).
9483
9484 For example to make <c-j> work like <down> in wildmode, use: >
9485 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
9486<
9487 (Note, this needs the 'wildcharm' option set appropriately).
9488
9489win_execute({id}, {command} [, {silent}]) *win_execute()*
9490 Like `execute()` but in the context of window {id}.
9491 The window will temporarily be made the current window,
9492 without triggering autocommands or changing directory. When
9493 executing {command} autocommands will be triggered, this may
9494 have unexpected side effects. Use |:noautocmd| if needed.
9495 Example: >
9496 call win_execute(winid, 'set syntax=python')
9497< Doing the same with `setwinvar()` would not trigger
9498 autocommands and not actually show syntax highlighting.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009499 *E994*
9500 Not all commands are allowed in popup windows.
9501 When window {id} does not exist then no error is given and
9502 an empty string is returned.
9503
9504 Can also be used as a |method|, the base is passed as the
9505 second argument: >
9506 GetCommand()->win_execute(winid)
9507
9508win_findbuf({bufnr}) *win_findbuf()*
9509 Returns a |List| with |window-ID|s for windows that contain
9510 buffer {bufnr}. When there is none the list is empty.
9511
9512 Can also be used as a |method|: >
9513 GetBufnr()->win_findbuf()
9514
9515win_getid([{win} [, {tab}]]) *win_getid()*
9516 Get the |window-ID| for the specified window.
9517 When {win} is missing use the current window.
9518 With {win} this is the window number. The top window has
9519 number 1.
9520 Without {tab} use the current tab, otherwise the tab with
9521 number {tab}. The first tab has number one.
9522 Return zero if the window cannot be found.
9523
9524 Can also be used as a |method|: >
9525 GetWinnr()->win_getid()
9526
9527
9528win_gettype([{nr}]) *win_gettype()*
9529 Return the type of the window:
9530 "autocmd" autocommand window. Temporary window
9531 used to execute autocommands.
9532 "command" command-line window |cmdwin|
9533 (empty) normal window
9534 "loclist" |location-list-window|
9535 "popup" popup window |popup|
9536 "preview" preview window |preview-window|
9537 "quickfix" |quickfix-window|
9538 "unknown" window {nr} not found
9539
9540 When {nr} is omitted return the type of the current window.
9541 When {nr} is given return the type of this window by number or
9542 |window-ID|.
9543
9544 Also see the 'buftype' option. When running a terminal in a
9545 popup window then 'buftype' is "terminal" and win_gettype()
9546 returns "popup".
9547
9548 Can also be used as a |method|: >
9549 GetWinid()->win_gettype()
9550<
9551win_gotoid({expr}) *win_gotoid()*
9552 Go to window with ID {expr}. This may also change the current
9553 tabpage.
9554 Return TRUE if successful, FALSE if the window cannot be found.
9555
9556 Can also be used as a |method|: >
9557 GetWinid()->win_gotoid()
9558
9559win_id2tabwin({expr}) *win_id2tabwin()*
9560 Return a list with the tab number and window number of window
9561 with ID {expr}: [tabnr, winnr].
9562 Return [0, 0] if the window cannot be found.
9563
9564 Can also be used as a |method|: >
9565 GetWinid()->win_id2tabwin()
9566
9567win_id2win({expr}) *win_id2win()*
9568 Return the window number of window with ID {expr}.
9569 Return 0 if the window cannot be found in the current tabpage.
9570
9571 Can also be used as a |method|: >
9572 GetWinid()->win_id2win()
9573
Daniel Steinbergee630312022-01-10 13:36:34 +00009574win_move_separator({nr}, {offset}) *win_move_separator()*
9575 Move window {nr}'s vertical separator (i.e., the right border)
9576 by {offset} columns, as if being dragged by the mouse. {nr}
9577 can be a window number or |window-ID|. A positive {offset}
9578 moves right and a negative {offset} moves left. Moving a
9579 window's vertical separator will change the width of the
9580 window and the width of other windows adjacent to the vertical
9581 separator. The magnitude of movement may be smaller than
9582 specified (e.g., as a consequence of maintaining
9583 'winminwidth'). Returns TRUE if the window can be found and
9584 FALSE otherwise.
9585
9586 Can also be used as a |method|: >
9587 GetWinnr()->win_move_separator(offset)
9588
9589win_move_statusline({nr}, {offset}) *win_move_statusline()*
9590 Move window {nr}'s status line (i.e., the bottom border) by
9591 {offset} rows, as if being dragged by the mouse. {nr} can be a
9592 window number or |window-ID|. A positive {offset} moves down
9593 and a negative {offset} moves up. Moving a window's status
9594 line will change the height of the window and the height of
9595 other windows adjacent to the status line. The magnitude of
9596 movement may be smaller than specified (e.g., as a consequence
9597 of maintaining 'winminheight'). Returns TRUE if the window can
9598 be found and FALSE otherwise.
9599
9600 Can also be used as a |method|: >
9601 GetWinnr()->win_move_statusline(offset)
9602
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009603win_screenpos({nr}) *win_screenpos()*
9604 Return the screen position of window {nr} as a list with two
9605 numbers: [row, col]. The first window always has position
9606 [1, 1], unless there is a tabline, then it is [2, 1].
9607 {nr} can be the window number or the |window-ID|. Use zero
9608 for the current window.
9609 Returns [0, 0] if the window cannot be found in the current
9610 tabpage.
9611
9612 Can also be used as a |method|: >
9613 GetWinid()->win_screenpos()
9614<
9615win_splitmove({nr}, {target} [, {options}]) *win_splitmove()*
9616 Move the window {nr} to a new split of the window {target}.
9617 This is similar to moving to {target}, creating a new window
9618 using |:split| but having the same contents as window {nr}, and
9619 then closing {nr}.
9620
9621 Both {nr} and {target} can be window numbers or |window-ID|s.
9622 Both must be in the current tab page.
9623
9624 Returns zero for success, non-zero for failure.
9625
9626 {options} is a |Dictionary| with the following optional entries:
9627 "vertical" When TRUE, the split is created vertically,
9628 like with |:vsplit|.
9629 "rightbelow" When TRUE, the split is made below or to the
9630 right (if vertical). When FALSE, it is done
9631 above or to the left (if vertical). When not
9632 present, the values of 'splitbelow' and
9633 'splitright' are used.
9634
9635 Can also be used as a |method|: >
9636 GetWinid()->win_splitmove(target)
9637<
9638
9639 *winbufnr()*
9640winbufnr({nr}) The result is a Number, which is the number of the buffer
9641 associated with window {nr}. {nr} can be the window number or
9642 the |window-ID|.
9643 When {nr} is zero, the number of the buffer in the current
9644 window is returned.
9645 When window {nr} doesn't exist, -1 is returned.
9646 Example: >
9647 :echo "The file in the current window is " . bufname(winbufnr(0))
9648<
9649 Can also be used as a |method|: >
9650 FindWindow()->winbufnr()->bufname()
9651<
9652 *wincol()*
9653wincol() The result is a Number, which is the virtual column of the
9654 cursor in the window. This is counting screen cells from the
9655 left side of the window. The leftmost column is one.
9656
9657 *windowsversion()*
9658windowsversion()
9659 The result is a String. For MS-Windows it indicates the OS
9660 version. E.g, Windows 10 is "10.0", Windows 8 is "6.2",
9661 Windows XP is "5.1". For non-MS-Windows systems the result is
9662 an empty string.
9663
9664winheight({nr}) *winheight()*
9665 The result is a Number, which is the height of window {nr}.
9666 {nr} can be the window number or the |window-ID|.
9667 When {nr} is zero, the height of the current window is
9668 returned. When window {nr} doesn't exist, -1 is returned.
9669 An existing window always has a height of zero or more.
9670 This excludes any window toolbar line.
9671 Examples: >
9672 :echo "The current window has " . winheight(0) . " lines."
9673
9674< Can also be used as a |method|: >
9675 GetWinid()->winheight()
9676<
9677winlayout([{tabnr}]) *winlayout()*
9678 The result is a nested List containing the layout of windows
9679 in a tabpage.
9680
9681 Without {tabnr} use the current tabpage, otherwise the tabpage
9682 with number {tabnr}. If the tabpage {tabnr} is not found,
9683 returns an empty list.
9684
9685 For a leaf window, it returns:
9686 ['leaf', {winid}]
9687 For horizontally split windows, which form a column, it
9688 returns:
9689 ['col', [{nested list of windows}]]
9690 For vertically split windows, which form a row, it returns:
9691 ['row', [{nested list of windows}]]
9692
9693 Example: >
9694 " Only one window in the tab page
9695 :echo winlayout()
9696 ['leaf', 1000]
9697 " Two horizontally split windows
9698 :echo winlayout()
9699 ['col', [['leaf', 1000], ['leaf', 1001]]]
9700 " The second tab page, with three horizontally split
9701 " windows, with two vertically split windows in the
9702 " middle window
9703 :echo winlayout(2)
9704 ['col', [['leaf', 1002], ['row', [['leaf', 1003],
9705 ['leaf', 1001]]], ['leaf', 1000]]]
9706<
9707 Can also be used as a |method|: >
9708 GetTabnr()->winlayout()
9709<
9710 *winline()*
9711winline() The result is a Number, which is the screen line of the cursor
9712 in the window. This is counting screen lines from the top of
9713 the window. The first line is one.
9714 If the cursor was moved the view on the file will be updated
9715 first, this may cause a scroll.
9716
9717 *winnr()*
9718winnr([{arg}]) The result is a Number, which is the number of the current
9719 window. The top window has number 1.
9720 Returns zero for a popup window.
9721
9722 The optional argument {arg} supports the following values:
9723 $ the number of the last window (the window
9724 count).
9725 # the number of the last accessed window (where
9726 |CTRL-W_p| goes to). If there is no previous
9727 window or it is in another tab page 0 is
9728 returned.
9729 {N}j the number of the Nth window below the
9730 current window (where |CTRL-W_j| goes to).
9731 {N}k the number of the Nth window above the current
9732 window (where |CTRL-W_k| goes to).
9733 {N}h the number of the Nth window left of the
9734 current window (where |CTRL-W_h| goes to).
9735 {N}l the number of the Nth window right of the
9736 current window (where |CTRL-W_l| goes to).
9737 The number can be used with |CTRL-W_w| and ":wincmd w"
9738 |:wincmd|.
9739 Also see |tabpagewinnr()| and |win_getid()|.
9740 Examples: >
9741 let window_count = winnr('$')
9742 let prev_window = winnr('#')
9743 let wnum = winnr('3k')
9744
9745< Can also be used as a |method|: >
9746 GetWinval()->winnr()
9747<
9748 *winrestcmd()*
9749winrestcmd() Returns a sequence of |:resize| commands that should restore
9750 the current window sizes. Only works properly when no windows
9751 are opened or closed and the current window and tab page is
9752 unchanged.
9753 Example: >
9754 :let cmd = winrestcmd()
9755 :call MessWithWindowSizes()
9756 :exe cmd
9757<
9758 *winrestview()*
9759winrestview({dict})
9760 Uses the |Dictionary| returned by |winsaveview()| to restore
9761 the view of the current window.
9762 Note: The {dict} does not have to contain all values, that are
9763 returned by |winsaveview()|. If values are missing, those
9764 settings won't be restored. So you can use: >
9765 :call winrestview({'curswant': 4})
9766<
9767 This will only set the curswant value (the column the cursor
9768 wants to move on vertical movements) of the cursor to column 5
9769 (yes, that is 5), while all other settings will remain the
9770 same. This is useful, if you set the cursor position manually.
9771
9772 If you have changed the values the result is unpredictable.
9773 If the window size changed the result won't be the same.
9774
9775 Can also be used as a |method|: >
9776 GetView()->winrestview()
9777<
9778 *winsaveview()*
9779winsaveview() Returns a |Dictionary| that contains information to restore
9780 the view of the current window. Use |winrestview()| to
9781 restore the view.
9782 This is useful if you have a mapping that jumps around in the
9783 buffer and you want to go back to the original view.
9784 This does not save fold information. Use the 'foldenable'
9785 option to temporarily switch off folding, so that folds are
9786 not opened when moving around. This may have side effects.
9787 The return value includes:
9788 lnum cursor line number
9789 col cursor column (Note: the first column
naohiro ono56200ee2022-01-01 14:59:44 +00009790 zero, as opposed to what |getcurpos()|
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009791 returns)
9792 coladd cursor column offset for 'virtualedit'
naohiro ono56200ee2022-01-01 14:59:44 +00009793 curswant column for vertical movement (Note:
9794 the first column is zero, as opposed
9795 to what |getcurpos()| returns). After
9796 |$| command it will be a very large
9797 number equal to |v:maxcol|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009798 topline first line in the window
9799 topfill filler lines, only in diff mode
9800 leftcol first column displayed; only used when
9801 'wrap' is off
9802 skipcol columns skipped
9803 Note that no option values are saved.
9804
9805
9806winwidth({nr}) *winwidth()*
9807 The result is a Number, which is the width of window {nr}.
9808 {nr} can be the window number or the |window-ID|.
9809 When {nr} is zero, the width of the current window is
9810 returned. When window {nr} doesn't exist, -1 is returned.
9811 An existing window always has a width of zero or more.
9812 Examples: >
9813 :echo "The current window has " . winwidth(0) . " columns."
9814 :if winwidth(0) <= 50
9815 : 50 wincmd |
9816 :endif
9817< For getting the terminal or screen size, see the 'columns'
9818 option.
9819
9820 Can also be used as a |method|: >
9821 GetWinid()->winwidth()
9822
9823
9824wordcount() *wordcount()*
9825 The result is a dictionary of byte/chars/word statistics for
9826 the current buffer. This is the same info as provided by
9827 |g_CTRL-G|
9828 The return value includes:
9829 bytes Number of bytes in the buffer
9830 chars Number of chars in the buffer
9831 words Number of words in the buffer
9832 cursor_bytes Number of bytes before cursor position
9833 (not in Visual mode)
9834 cursor_chars Number of chars before cursor position
9835 (not in Visual mode)
9836 cursor_words Number of words before cursor position
9837 (not in Visual mode)
9838 visual_bytes Number of bytes visually selected
9839 (only in Visual mode)
9840 visual_chars Number of chars visually selected
9841 (only in Visual mode)
9842 visual_words Number of words visually selected
9843 (only in Visual mode)
9844
9845
9846 *writefile()*
9847writefile({object}, {fname} [, {flags}])
9848 When {object} is a |List| write it to file {fname}. Each list
9849 item is separated with a NL. Each list item must be a String
9850 or Number.
9851 When {flags} contains "b" then binary mode is used: There will
9852 not be a NL after the last list item. An empty item at the
9853 end does cause the last line in the file to end in a NL.
9854
9855 When {object} is a |Blob| write the bytes to file {fname}
9856 unmodified.
9857
9858 When {flags} contains "a" then append mode is used, lines are
9859 appended to the file: >
9860 :call writefile(["foo"], "event.log", "a")
9861 :call writefile(["bar"], "event.log", "a")
9862<
9863 When {flags} contains "s" then fsync() is called after writing
9864 the file. This flushes the file to disk, if possible. This
9865 takes more time but avoids losing the file if the system
9866 crashes.
9867 When {flags} does not contain "S" or "s" then fsync() is
9868 called if the 'fsync' option is set.
9869 When {flags} contains "S" then fsync() is not called, even
9870 when 'fsync' is set.
9871
9872 All NL characters are replaced with a NUL character.
9873 Inserting CR characters needs to be done before passing {list}
9874 to writefile().
9875 An existing file is overwritten, if possible.
9876 When the write fails -1 is returned, otherwise 0. There is an
9877 error message if the file can't be created or when writing
9878 fails.
9879 Also see |readfile()|.
9880 To copy a file byte for byte: >
9881 :let fl = readfile("foo", "b")
9882 :call writefile(fl, "foocopy", "b")
9883
9884< Can also be used as a |method|: >
9885 GetText()->writefile("thefile")
9886
9887
9888xor({expr}, {expr}) *xor()*
9889 Bitwise XOR on the two arguments. The arguments are converted
9890 to a number. A List, Dict or Float argument causes an error.
9891 Example: >
9892 :let bits = xor(bits, 0x80)
9893<
9894 Can also be used as a |method|: >
9895 :let bits = bits->xor(0x80)
9896<
9897
9898==============================================================================
98993. Feature list *feature-list*
9900
9901There are three types of features:
99021. Features that are only supported when they have been enabled when Vim
9903 was compiled |+feature-list|. Example: >
9904 :if has("cindent")
9905< *gui_running*
99062. Features that are only supported when certain conditions have been met.
9907 Example: >
9908 :if has("gui_running")
9909< *has-patch*
99103. Beyond a certain version or at a certain version and including a specific
9911 patch. The "patch-7.4.248" feature means that the Vim version is 7.5 or
9912 later, or it is version 7.4 and patch 248 was included. Example: >
9913 :if has("patch-7.4.248")
9914< Note that it's possible for patch 248 to be omitted even though 249 is
9915 included. Only happens when cherry-picking patches.
9916 Note that this form only works for patch 7.4.237 and later, before that
9917 you need to check for the patch and the v:version. Example (checking
9918 version 6.2.148 or later): >
9919 :if v:version > 602 || (v:version == 602 && has("patch148"))
9920
9921Hint: To find out if Vim supports backslashes in a file name (MS-Windows),
9922use: `if exists('+shellslash')`
9923
9924
9925acl Compiled with |ACL| support.
9926all_builtin_terms Compiled with all builtin terminals enabled.
9927amiga Amiga version of Vim.
9928arabic Compiled with Arabic support |Arabic|.
9929arp Compiled with ARP support (Amiga).
9930autocmd Compiled with autocommand support. (always true)
9931autochdir Compiled with support for 'autochdir'
9932autoservername Automatically enable |clientserver|
9933balloon_eval Compiled with |balloon-eval| support.
9934balloon_multiline GUI supports multiline balloons.
9935beos BeOS version of Vim.
9936browse Compiled with |:browse| support, and browse() will
9937 work.
9938browsefilter Compiled with support for |browsefilter|.
9939bsd Compiled on an OS in the BSD family (excluding macOS).
9940builtin_terms Compiled with some builtin terminals.
9941byte_offset Compiled with support for 'o' in 'statusline'
9942channel Compiled with support for |channel| and |job|
9943cindent Compiled with 'cindent' support.
9944clientserver Compiled with remote invocation support |clientserver|.
9945clipboard Compiled with 'clipboard' support.
9946clipboard_working Compiled with 'clipboard' support and it can be used.
9947cmdline_compl Compiled with |cmdline-completion| support.
9948cmdline_hist Compiled with |cmdline-history| support.
9949cmdline_info Compiled with 'showcmd' and 'ruler' support.
9950comments Compiled with |'comments'| support.
9951compatible Compiled to be very Vi compatible.
9952conpty Platform where |ConPTY| can be used.
9953cryptv Compiled with encryption support |encryption|.
9954cscope Compiled with |cscope| support.
9955cursorbind Compiled with |'cursorbind'| (always true)
9956debug Compiled with "DEBUG" defined.
9957dialog_con Compiled with console dialog support.
9958dialog_gui Compiled with GUI dialog support.
9959diff Compiled with |vimdiff| and 'diff' support.
9960digraphs Compiled with support for digraphs.
9961directx Compiled with support for DirectX and 'renderoptions'.
9962dnd Compiled with support for the "~ register |quote_~|.
9963drop_file Compiled with |drop_file| support.
9964ebcdic Compiled on a machine with ebcdic character set.
9965emacs_tags Compiled with support for Emacs tags.
9966eval Compiled with expression evaluation support. Always
9967 true, of course!
9968ex_extra |+ex_extra| (always true)
9969extra_search Compiled with support for |'incsearch'| and
9970 |'hlsearch'|
9971farsi Support for Farsi was removed |farsi|.
9972file_in_path Compiled with support for |gf| and |<cfile>|
9973filterpipe When 'shelltemp' is off pipes are used for shell
9974 read/write/filter commands
9975find_in_path Compiled with support for include file searches
9976 |+find_in_path|.
9977float Compiled with support for |Float|.
9978fname_case Case in file names matters (for Amiga and MS-Windows
9979 this is not present).
9980folding Compiled with |folding| support.
9981footer Compiled with GUI footer support. |gui-footer|
9982fork Compiled to use fork()/exec() instead of system().
9983gettext Compiled with message translation |multi-lang|
9984gui Compiled with GUI enabled.
9985gui_athena Compiled with Athena GUI.
9986gui_gnome Compiled with Gnome support (gui_gtk is also defined).
9987gui_gtk Compiled with GTK+ GUI (any version).
9988gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
9989gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined).
9990gui_haiku Compiled with Haiku GUI.
9991gui_mac Compiled with Macintosh GUI.
9992gui_motif Compiled with Motif GUI.
9993gui_photon Compiled with Photon GUI.
9994gui_running Vim is running in the GUI, or it will start soon.
9995gui_win32 Compiled with MS-Windows Win32 GUI.
9996gui_win32s idem, and Win32s system being used (Windows 3.1)
9997haiku Haiku version of Vim.
9998hangul_input Compiled with Hangul input support. |hangul|
9999hpux HP-UX version of Vim.
10000iconv Can use iconv() for conversion.
10001insert_expand Compiled with support for CTRL-X expansion commands in
10002 Insert mode. (always true)
10003job Compiled with support for |channel| and |job|
10004ipv6 Compiled with support for IPv6 networking in |channel|.
10005jumplist Compiled with |jumplist| support.
10006keymap Compiled with 'keymap' support.
10007lambda Compiled with |lambda| support.
10008langmap Compiled with 'langmap' support.
10009libcall Compiled with |libcall()| support.
10010linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and
10011 'breakindent' support.
10012linux Linux version of Vim.
10013lispindent Compiled with support for lisp indenting.
10014listcmds Compiled with commands for the buffer list |:files|
10015 and the argument list |arglist|.
10016localmap Compiled with local mappings and abbr. |:map-local|
10017lua Compiled with Lua interface |Lua|.
10018mac Any Macintosh version of Vim cf. osx
10019macunix Synonym for osxdarwin
10020menu Compiled with support for |:menu|.
10021mksession Compiled with support for |:mksession|.
10022modify_fname Compiled with file name modifiers. |filename-modifiers|
10023 (always true)
10024mouse Compiled with support for mouse.
10025mouse_dec Compiled with support for Dec terminal mouse.
10026mouse_gpm Compiled with support for gpm (Linux console mouse)
10027mouse_gpm_enabled GPM mouse is working
10028mouse_netterm Compiled with support for netterm mouse.
10029mouse_pterm Compiled with support for qnx pterm mouse.
10030mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
10031mouse_sgr Compiled with support for sgr mouse.
10032mouse_urxvt Compiled with support for urxvt mouse.
10033mouse_xterm Compiled with support for xterm mouse.
10034mouseshape Compiled with support for 'mouseshape'.
10035multi_byte Compiled with support for 'encoding' (always true)
10036multi_byte_encoding 'encoding' is set to a multibyte encoding.
10037multi_byte_ime Compiled with support for IME input method.
10038multi_lang Compiled with support for multiple languages.
10039mzscheme Compiled with MzScheme interface |mzscheme|.
10040nanotime Compiled with sub-second time stamp checks.
10041netbeans_enabled Compiled with support for |netbeans| and connected.
10042netbeans_intg Compiled with support for |netbeans|.
10043num64 Compiled with 64-bit |Number| support.
10044ole Compiled with OLE automation support for Win32.
10045osx Compiled for macOS cf. mac
10046osxdarwin Compiled for macOS, with |mac-darwin-feature|
10047packages Compiled with |packages| support.
10048path_extra Compiled with up/downwards search in 'path' and 'tags'
10049perl Compiled with Perl interface.
10050persistent_undo Compiled with support for persistent undo history.
10051postscript Compiled with PostScript file printing.
10052printer Compiled with |:hardcopy| support.
10053profile Compiled with |:profile| support.
10054python Python 2.x interface available. |has-python|
10055python_compiled Compiled with Python 2.x interface. |has-python|
10056python_dynamic Python 2.x interface is dynamically loaded. |has-python|
10057python3 Python 3.x interface available. |has-python|
10058python3_compiled Compiled with Python 3.x interface. |has-python|
10059python3_dynamic Python 3.x interface is dynamically loaded. |has-python|
10060pythonx Python 2.x and/or 3.x interface available. |python_x|
10061qnx QNX version of Vim.
10062quickfix Compiled with |quickfix| support.
10063reltime Compiled with |reltime()| support.
10064rightleft Compiled with 'rightleft' support.
10065ruby Compiled with Ruby interface |ruby|.
10066scrollbind Compiled with 'scrollbind' support. (always true)
10067showcmd Compiled with 'showcmd' support.
10068signs Compiled with |:sign| support.
10069smartindent Compiled with 'smartindent' support.
10070sodium Compiled with libsodium for better crypt support
10071sound Compiled with sound support, e.g. `sound_playevent()`
10072spell Compiled with spell checking support |spell|.
10073startuptime Compiled with |--startuptime| support.
10074statusline Compiled with support for 'statusline', 'rulerformat'
10075 and special formats of 'titlestring' and 'iconstring'.
10076sun SunOS version of Vim.
10077sun_workshop Support for Sun |workshop| has been removed.
10078syntax Compiled with syntax highlighting support |syntax|.
10079syntax_items There are active syntax highlighting items for the
10080 current buffer.
10081system Compiled to use system() instead of fork()/exec().
10082tag_binary Compiled with binary searching in tags files
10083 |tag-binary-search|.
10084tag_old_static Support for old static tags was removed, see
10085 |tag-old-static|.
10086tcl Compiled with Tcl interface.
10087termguicolors Compiled with true color in terminal support.
10088terminal Compiled with |terminal| support.
10089terminfo Compiled with terminfo instead of termcap.
10090termresponse Compiled with support for |t_RV| and |v:termresponse|.
10091textobjects Compiled with support for |text-objects|.
10092textprop Compiled with support for |text-properties|.
10093tgetent Compiled with tgetent support, able to use a termcap
10094 or terminfo file.
10095timers Compiled with |timer_start()| support.
10096title Compiled with window title support |'title'|.
10097toolbar Compiled with support for |gui-toolbar|.
10098ttyin input is a terminal (tty)
10099ttyout output is a terminal (tty)
10100unix Unix version of Vim. *+unix*
10101unnamedplus Compiled with support for "unnamedplus" in 'clipboard'
10102user_commands User-defined commands. (always true)
10103vartabs Compiled with variable tabstop support |'vartabstop'|.
10104vcon Win32: Virtual console support is working, can use
10105 'termguicolors'. Also see |+vtp|.
10106vertsplit Compiled with vertically split windows |:vsplit|.
10107 (always true)
10108vim_starting True while initial source'ing takes place. |startup|
10109 *vim_starting*
Bram Moolenaara6feb162022-01-02 12:06:33 +000010110vim9script Compiled with |Vim9| script support
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010111viminfo Compiled with viminfo support.
10112vimscript-1 Compiled Vim script version 1 support
10113vimscript-2 Compiled Vim script version 2 support
10114vimscript-3 Compiled Vim script version 3 support
10115virtualedit Compiled with 'virtualedit' option. (always true)
10116visual Compiled with Visual mode. (always true)
10117visualextra Compiled with extra Visual mode commands. (always
10118 true) |blockwise-operators|.
10119vms VMS version of Vim.
10120vreplace Compiled with |gR| and |gr| commands. (always true)
10121vtp Compiled for vcon support |+vtp| (check vcon to find
10122 out if it works in the current console).
10123wildignore Compiled with 'wildignore' option.
10124wildmenu Compiled with 'wildmenu' option.
10125win16 old version for MS-Windows 3.1 (always false)
10126win32 Win32 version of Vim (MS-Windows 95 and later, 32 or
10127 64 bits)
10128win32unix Win32 version of Vim, using Unix files (Cygwin)
10129win64 Win64 version of Vim (MS-Windows 64 bit).
10130win95 Win32 version for MS-Windows 95/98/ME (always false)
10131winaltkeys Compiled with 'winaltkeys' option.
10132windows Compiled with support for more than one window.
10133 (always true)
10134writebackup Compiled with 'writebackup' default on.
10135xfontset Compiled with X fontset support |xfontset|.
10136xim Compiled with X input method support |xim|.
10137xpm Compiled with pixmap support.
10138xpm_w32 Compiled with pixmap support for Win32. (Only for
10139 backward compatibility. Use "xpm" instead.)
10140xsmp Compiled with X session management support.
10141xsmp_interact Compiled with interactive X session management support.
10142xterm_clipboard Compiled with support for xterm clipboard.
10143xterm_save Compiled with support for saving and restoring the
10144 xterm screen.
10145x11 Compiled with X11 support.
10146
10147
10148==============================================================================
101494. Matching a pattern in a String *string-match*
10150
10151This is common between several functions. A regexp pattern as explained at
10152|pattern| is normally used to find a match in the buffer lines. When a
10153pattern is used to find a match in a String, almost everything works in the
10154same way. The difference is that a String is handled like it is one line.
10155When it contains a "\n" character, this is not seen as a line break for the
10156pattern. It can be matched with a "\n" in the pattern, or with ".". Example:
10157>
10158 :let a = "aaaa\nxxxx"
10159 :echo matchstr(a, "..\n..")
10160 aa
10161 xx
10162 :echo matchstr(a, "a.x")
10163 a
10164 x
10165
10166Don't forget that "^" will only match at the first character of the String and
10167"$" at the last character of the string. They don't match after or before a
10168"\n".
10169
10170 vim:tw=78:ts=8:noet:ft=help:norl: