blob: 5b20ea3322224f3de715d5d14241cbbbbe8b6c9f [file] [log] [blame]
Bram Moolenaar835ee982022-05-22 14:50:16 +01001*builtin.txt* For Vim version 8.2. Last change: 2022 May 21
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Builtin functions *builtin-functions*
8
9Note: Expression evaluation can be disabled at compile time. If this has been
10done, the builtin functions are not available. See |+eval| and
11|no-eval-feature|.
12
131. Overview |builtin-function-list|
142. Details |builtin-function-details|
153. Feature list |feature-list|
164. Matching a pattern in a String |string-match|
17
18==============================================================================
191. Overview *builtin-function-list*
20
21Use CTRL-] on the function name to jump to the full explanation.
22
23USAGE RESULT DESCRIPTION ~
24
25abs({expr}) Float or Number absolute value of {expr}
26acos({expr}) Float arc cosine of {expr}
27add({object}, {item}) List/Blob append {item} to {object}
28and({expr}, {expr}) Number bitwise AND
29append({lnum}, {text}) Number append {text} below line {lnum}
30appendbufline({expr}, {lnum}, {text})
31 Number append {text} below line {lnum}
32 in buffer {expr}
33argc([{winid}]) Number number of files in the argument list
34argidx() Number current index in the argument list
35arglistid([{winnr} [, {tabnr}]]) Number argument list id
36argv({nr} [, {winid}]) String {nr} entry of the argument list
37argv([-1, {winid}]) List the argument list
38asin({expr}) Float arc sine of {expr}
39assert_beeps({cmd}) Number assert {cmd} causes a beep
40assert_equal({exp}, {act} [, {msg}])
41 Number assert {exp} is equal to {act}
42assert_equalfile({fname-one}, {fname-two} [, {msg}])
43 Number assert file contents are equal
44assert_exception({error} [, {msg}])
45 Number assert {error} is in v:exception
46assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
47 Number assert {cmd} fails
48assert_false({actual} [, {msg}])
49 Number assert {actual} is false
50assert_inrange({lower}, {upper}, {actual} [, {msg}])
51 Number assert {actual} is inside the range
52assert_match({pat}, {text} [, {msg}])
53 Number assert {pat} matches {text}
54assert_nobeep({cmd}) Number assert {cmd} does not cause a beep
55assert_notequal({exp}, {act} [, {msg}])
56 Number assert {exp} is not equal {act}
57assert_notmatch({pat}, {text} [, {msg}])
58 Number assert {pat} not matches {text}
59assert_report({msg}) Number report a test failure
60assert_true({actual} [, {msg}]) Number assert {actual} is true
61atan({expr}) Float arc tangent of {expr}
62atan2({expr1}, {expr2}) Float arc tangent of {expr1} / {expr2}
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +010063autocmd_add({acmds}) Bool add a list of autocmds and groups
64autocmd_delete({acmds}) Bool delete a list of autocmds and groups
65autocmd_get([{opts}]) List return a list of autocmds
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000066balloon_gettext() String current text in the balloon
67balloon_show({expr}) none show {expr} inside the balloon
68balloon_split({msg}) List split {msg} as used for a balloon
69blob2list({blob}) List convert {blob} into a list of numbers
70browse({save}, {title}, {initdir}, {default})
71 String put up a file requester
72browsedir({title}, {initdir}) String put up a directory requester
73bufadd({name}) Number add a buffer to the buffer list
74bufexists({buf}) Number |TRUE| if buffer {buf} exists
75buflisted({buf}) Number |TRUE| if buffer {buf} is listed
76bufload({buf}) Number load buffer {buf} if not loaded yet
77bufloaded({buf}) Number |TRUE| if buffer {buf} is loaded
78bufname([{buf}]) String Name of the buffer {buf}
79bufnr([{buf} [, {create}]]) Number Number of the buffer {buf}
80bufwinid({buf}) Number window ID of buffer {buf}
81bufwinnr({buf}) Number window number of buffer {buf}
82byte2line({byte}) Number line number at byte count {byte}
83byteidx({expr}, {nr}) Number byte index of {nr}'th char in {expr}
84byteidxcomp({expr}, {nr}) Number byte index of {nr}'th char in {expr}
85call({func}, {arglist} [, {dict}])
86 any call {func} with arguments {arglist}
87ceil({expr}) Float round {expr} up
88ch_canread({handle}) Number check if there is something to read
89ch_close({handle}) none close {handle}
90ch_close_in({handle}) none close in part of {handle}
91ch_evalexpr({handle}, {expr} [, {options}])
92 any evaluate {expr} on JSON {handle}
93ch_evalraw({handle}, {string} [, {options}])
94 any evaluate {string} on raw {handle}
95ch_getbufnr({handle}, {what}) Number get buffer number for {handle}/{what}
96ch_getjob({channel}) Job get the Job of {channel}
97ch_info({handle}) String info about channel {handle}
98ch_log({msg} [, {handle}]) none write {msg} in the channel log file
99ch_logfile({fname} [, {mode}]) none start logging channel activity
100ch_open({address} [, {options}])
101 Channel open a channel to {address}
102ch_read({handle} [, {options}]) String read from {handle}
103ch_readblob({handle} [, {options}])
104 Blob read Blob from {handle}
105ch_readraw({handle} [, {options}])
106 String read raw from {handle}
107ch_sendexpr({handle}, {expr} [, {options}])
108 any send {expr} over JSON {handle}
109ch_sendraw({handle}, {expr} [, {options}])
110 any send {expr} over raw {handle}
111ch_setoptions({handle}, {options})
112 none set options for {handle}
113ch_status({handle} [, {options}])
114 String status of channel {handle}
115changenr() Number current change number
116char2nr({expr} [, {utf8}]) Number ASCII/UTF-8 value of first char in {expr}
117charclass({string}) Number character class of {string}
118charcol({expr}) Number column number of cursor or mark
119charidx({string}, {idx} [, {countcc}])
120 Number char index of byte {idx} in {string}
121chdir({dir}) String change current working directory
122cindent({lnum}) Number C indent for line {lnum}
123clearmatches([{win}]) none clear all matches
124col({expr}) Number column byte index of cursor or mark
125complete({startcol}, {matches}) none set Insert mode completion
126complete_add({expr}) Number add completion match
127complete_check() Number check for key typed during completion
128complete_info([{what}]) Dict get current completion information
129confirm({msg} [, {choices} [, {default} [, {type}]]])
130 Number number of choice picked by user
131copy({expr}) any make a shallow copy of {expr}
132cos({expr}) Float cosine of {expr}
133cosh({expr}) Float hyperbolic cosine of {expr}
134count({comp}, {expr} [, {ic} [, {start}]])
135 Number count how many {expr} are in {comp}
136cscope_connection([{num}, {dbpath} [, {prepend}]])
137 Number checks existence of cscope connection
138cursor({lnum}, {col} [, {off}])
139 Number move cursor to {lnum}, {col}, {off}
140cursor({list}) Number move cursor to position in {list}
141debugbreak({pid}) Number interrupt process being debugged
142deepcopy({expr} [, {noref}]) any make a full copy of {expr}
143delete({fname} [, {flags}]) Number delete the file or directory {fname}
144deletebufline({buf}, {first} [, {last}])
145 Number delete lines from buffer {buf}
146did_filetype() Number |TRUE| if FileType autocmd event used
147diff_filler({lnum}) Number diff filler lines about {lnum}
148diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col}
149digraph_get({chars}) String get the |digraph| of {chars}
150digraph_getlist([{listall}]) List get all |digraph|s
151digraph_set({chars}, {digraph}) Boolean register |digraph|
152digraph_setlist({digraphlist}) Boolean register multiple |digraph|s
153echoraw({expr}) none output {expr} as-is
154empty({expr}) Number |TRUE| if {expr} is empty
155environ() Dict return environment variables
156escape({string}, {chars}) String escape {chars} in {string} with '\'
157eval({string}) any evaluate {string} into its value
158eventhandler() Number |TRUE| if inside an event handler
159executable({expr}) Number 1 if executable {expr} exists
160execute({command}) String execute {command} and get the output
161exepath({expr}) String full path of the command {expr}
162exists({expr}) Number |TRUE| if {expr} exists
163exists_compiled({expr}) Number |TRUE| if {expr} exists at compile time
164exp({expr}) Float exponential of {expr}
165expand({expr} [, {nosuf} [, {list}]])
166 any expand special keywords in {expr}
Yegappan Lakshmanan2b74b682022-04-03 21:30:32 +0100167expandcmd({string} [, {options}])
168 String expand {string} like with `:edit`
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000169extend({expr1}, {expr2} [, {expr3}])
170 List/Dict insert items of {expr2} into {expr1}
171extendnew({expr1}, {expr2} [, {expr3}])
172 List/Dict like |extend()| but creates a new
173 List or Dictionary
174feedkeys({string} [, {mode}]) Number add key sequence to typeahead buffer
175filereadable({file}) Number |TRUE| if {file} is a readable file
176filewritable({file}) Number |TRUE| if {file} is a writable file
177filter({expr1}, {expr2}) List/Dict/Blob/String
178 remove items from {expr1} where
179 {expr2} is 0
180finddir({name} [, {path} [, {count}]])
181 String find directory {name} in {path}
182findfile({name} [, {path} [, {count}]])
183 String find file {name} in {path}
184flatten({list} [, {maxdepth}]) List flatten {list} up to {maxdepth} levels
185flattennew({list} [, {maxdepth}])
186 List flatten a copy of {list}
187float2nr({expr}) Number convert Float {expr} to a Number
188floor({expr}) Float round {expr} down
189fmod({expr1}, {expr2}) Float remainder of {expr1} / {expr2}
190fnameescape({fname}) String escape special characters in {fname}
191fnamemodify({fname}, {mods}) String modify file name
192foldclosed({lnum}) Number first line of fold at {lnum} if closed
193foldclosedend({lnum}) Number last line of fold at {lnum} if closed
194foldlevel({lnum}) Number fold level at {lnum}
195foldtext() String line displayed for closed fold
196foldtextresult({lnum}) String text for closed fold at {lnum}
197foreground() Number bring the Vim window to the foreground
198fullcommand({name}) String get full command from {name}
199funcref({name} [, {arglist}] [, {dict}])
200 Funcref reference to function {name}
201function({name} [, {arglist}] [, {dict}])
202 Funcref named reference to function {name}
203garbagecollect([{atexit}]) none free memory, breaking cyclic references
204get({list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
205get({dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
206get({func}, {what}) any get property of funcref/partial {func}
207getbufinfo([{buf}]) List information about buffers
208getbufline({buf}, {lnum} [, {end}])
209 List lines {lnum} to {end} of buffer {buf}
210getbufvar({buf}, {varname} [, {def}])
211 any variable {varname} in buffer {buf}
212getchangelist([{buf}]) List list of change list items
213getchar([expr]) Number or String
214 get one character from the user
215getcharmod() Number modifiers for the last typed character
216getcharpos({expr}) List position of cursor, mark, etc.
217getcharsearch() Dict last character search
218getcharstr([expr]) String get one character from the user
Shougo Matsushita79d599b2022-05-07 12:48:29 +0100219getcmdcompltype() String return the type of the current
220 command-line completion
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000221getcmdline() String return the current command-line
222getcmdpos() Number return cursor position in command-line
Shougo Matsushita79d599b2022-05-07 12:48:29 +0100223getcmdscreenpos() Number return cursor screen position in
224 command-line
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000225getcmdtype() String return current command-line type
226getcmdwintype() String return current command-line window type
227getcompletion({pat}, {type} [, {filtered}])
228 List list of cmdline completion matches
229getcurpos([{winnr}]) List position of the cursor
230getcursorcharpos([{winnr}]) List character position of the cursor
231getcwd([{winnr} [, {tabnr}]]) String get the current working directory
232getenv({name}) String return environment variable
233getfontname([{name}]) String name of font being used
234getfperm({fname}) String file permissions of file {fname}
235getfsize({fname}) Number size in bytes of file {fname}
236getftime({fname}) Number last modification time of file
237getftype({fname}) String description of type of file {fname}
238getimstatus() Number |TRUE| if the IME status is active
239getjumplist([{winnr} [, {tabnr}]])
240 List list of jump list items
241getline({lnum}) String line {lnum} of current buffer
242getline({lnum}, {end}) List lines {lnum} to {end} of current buffer
243getloclist({nr}) List list of location list items
244getloclist({nr}, {what}) Dict get specific location list properties
245getmarklist([{buf}]) List list of global/local marks
246getmatches([{win}]) List list of current matches
247getmousepos() Dict last known mouse position
248getpid() Number process ID of Vim
249getpos({expr}) List position of cursor, mark, etc.
250getqflist() List list of quickfix items
251getqflist({what}) Dict get specific quickfix list properties
252getreg([{regname} [, 1 [, {list}]]])
253 String or List contents of a register
254getreginfo([{regname}]) Dict information about a register
255getregtype([{regname}]) String type of a register
256gettabinfo([{expr}]) List list of tab pages
257gettabvar({nr}, {varname} [, {def}])
258 any variable {varname} in tab {nr} or {def}
259gettabwinvar({tabnr}, {winnr}, {name} [, {def}])
260 any {name} in {winnr} in tab page {tabnr}
261gettagstack([{nr}]) Dict get the tag stack of window {nr}
262gettext({text}) String lookup translation of {text}
263getwininfo([{winid}]) List list of info about each window
264getwinpos([{timeout}]) List X and Y coord in pixels of the Vim window
265getwinposx() Number X coord in pixels of the Vim window
266getwinposy() Number Y coord in pixels of the Vim window
267getwinvar({nr}, {varname} [, {def}])
268 any variable {varname} in window {nr}
269glob({expr} [, {nosuf} [, {list} [, {alllinks}]]])
270 any expand file wildcards in {expr}
271glob2regpat({expr}) String convert a glob pat into a search pat
272globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
273 String do glob({expr}) for all dirs in {path}
274has({feature} [, {check}]) Number |TRUE| if feature {feature} supported
275has_key({dict}, {key}) Number |TRUE| if {dict} has entry {key}
276haslocaldir([{winnr} [, {tabnr}]])
277 Number |TRUE| if the window executed |:lcd|
278 or |:tcd|
279hasmapto({what} [, {mode} [, {abbr}]])
280 Number |TRUE| if mapping to {what} exists
281histadd({history}, {item}) Number add an item to a history
282histdel({history} [, {item}]) Number remove an item from a history
283histget({history} [, {index}]) String get the item {index} from a history
284histnr({history}) Number highest index of a history
285hlID({name}) Number syntax ID of highlight group {name}
286hlexists({name}) Number |TRUE| if highlight group {name} exists
287hlget([{name} [, {resolve}]]) List get highlight group attributes
288hlset({list}) Number set highlight group attributes
289hostname() String name of the machine Vim is running on
290iconv({expr}, {from}, {to}) String convert encoding of {expr}
291indent({lnum}) Number indent of line {lnum}
292index({object}, {expr} [, {start} [, {ic}]])
293 Number index in {object} where {expr} appears
294input({prompt} [, {text} [, {completion}]])
295 String get input from the user
296inputdialog({prompt} [, {text} [, {completion}]])
297 String like input() but in a GUI dialog
298inputlist({textlist}) Number let the user pick from a choice list
299inputrestore() Number restore typeahead
300inputsave() Number save and clear typeahead
301inputsecret({prompt} [, {text}]) String like input() but hiding the text
302insert({object}, {item} [, {idx}]) List insert {item} in {object} [before {idx}]
303interrupt() none interrupt script execution
304invert({expr}) Number bitwise invert
LemonBoydca1d402022-04-28 15:26:33 +0100305isabsolutepath({path}) Number |TRUE| if {path} is an absolute path
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000306isdirectory({directory}) Number |TRUE| if {directory} is a directory
307isinf({expr}) Number determine if {expr} is infinity value
308 (positive or negative)
309islocked({expr}) Number |TRUE| if {expr} is locked
310isnan({expr}) Number |TRUE| if {expr} is NaN
311items({dict}) List key-value pairs in {dict}
312job_getchannel({job}) Channel get the channel handle for {job}
313job_info([{job}]) Dict get information about {job}
314job_setoptions({job}, {options}) none set options for {job}
315job_start({command} [, {options}])
316 Job start a job
317job_status({job}) String get the status of {job}
318job_stop({job} [, {how}]) Number stop {job}
319join({list} [, {sep}]) String join {list} items into one String
320js_decode({string}) any decode JS style JSON
321js_encode({expr}) String encode JS style JSON
322json_decode({string}) any decode JSON
323json_encode({expr}) String encode JSON
324keys({dict}) List keys in {dict}
325len({expr}) Number the length of {expr}
326libcall({lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
327libcallnr({lib}, {func}, {arg}) Number idem, but return a Number
328line({expr} [, {winid}]) Number line nr of cursor, last line or mark
329line2byte({lnum}) Number byte count of line {lnum}
330lispindent({lnum}) Number Lisp indent for line {lnum}
331list2blob({list}) Blob turn {list} of numbers into a Blob
332list2str({list} [, {utf8}]) String turn {list} of numbers into a String
333listener_add({callback} [, {buf}])
334 Number add a callback to listen to changes
335listener_flush([{buf}]) none invoke listener callbacks
336listener_remove({id}) none remove a listener callback
337localtime() Number current time
338log({expr}) Float natural logarithm (base e) of {expr}
339log10({expr}) Float logarithm of Float {expr} to base 10
340luaeval({expr} [, {expr}]) any evaluate |Lua| expression
341map({expr1}, {expr2}) List/Dict/Blob/String
342 change each item in {expr1} to {expr2}
343maparg({name} [, {mode} [, {abbr} [, {dict}]]])
344 String or Dict
345 rhs of mapping {name} in mode {mode}
346mapcheck({name} [, {mode} [, {abbr}]])
347 String check for mappings matching {name}
Ernie Rael09661202022-04-25 14:40:44 +0100348maplist([{abbr}]) List list of all mappings, a dict for each
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000349mapnew({expr1}, {expr2}) List/Dict/Blob/String
350 like |map()| but creates a new List or
351 Dictionary
352mapset({mode}, {abbr}, {dict}) none restore mapping from |maparg()| result
353match({expr}, {pat} [, {start} [, {count}]])
354 Number position where {pat} matches in {expr}
355matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
356 Number highlight {pattern} with {group}
357matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
358 Number highlight positions with {group}
359matcharg({nr}) List arguments of |:match|
360matchdelete({id} [, {win}]) Number delete match identified by {id}
361matchend({expr}, {pat} [, {start} [, {count}]])
362 Number position where {pat} ends in {expr}
363matchfuzzy({list}, {str} [, {dict}])
364 List fuzzy match {str} in {list}
365matchfuzzypos({list}, {str} [, {dict}])
366 List fuzzy match {str} in {list}
367matchlist({expr}, {pat} [, {start} [, {count}]])
368 List match and submatches of {pat} in {expr}
369matchstr({expr}, {pat} [, {start} [, {count}]])
370 String {count}'th match of {pat} in {expr}
371matchstrpos({expr}, {pat} [, {start} [, {count}]])
372 List {count}'th match of {pat} in {expr}
373max({expr}) Number maximum value of items in {expr}
374menu_info({name} [, {mode}]) Dict get menu item information
375min({expr}) Number minimum value of items in {expr}
376mkdir({name} [, {path} [, {prot}]])
377 Number create directory {name}
378mode([expr]) String current editing mode
379mzeval({expr}) any evaluate |MzScheme| expression
380nextnonblank({lnum}) Number line nr of non-blank line >= {lnum}
381nr2char({expr} [, {utf8}]) String single char with ASCII/UTF-8 value {expr}
382or({expr}, {expr}) Number bitwise OR
383pathshorten({expr} [, {len}]) String shorten directory names in a path
384perleval({expr}) any evaluate |Perl| expression
385popup_atcursor({what}, {options}) Number create popup window near the cursor
386popup_beval({what}, {options}) Number create popup window for 'ballooneval'
387popup_clear() none close all popup windows
388popup_close({id} [, {result}]) none close popup window {id}
389popup_create({what}, {options}) Number create a popup window
390popup_dialog({what}, {options}) Number create a popup window used as a dialog
391popup_filter_menu({id}, {key}) Number filter for a menu popup window
392popup_filter_yesno({id}, {key}) Number filter for a dialog popup window
393popup_findinfo() Number get window ID of info popup window
394popup_findpreview() Number get window ID of preview popup window
395popup_getoptions({id}) Dict get options of popup window {id}
396popup_getpos({id}) Dict get position of popup window {id}
397popup_hide({id}) none hide popup menu {id}
398popup_list() List get a list of window IDs of all popups
399popup_locate({row}, {col}) Number get window ID of popup at position
400popup_menu({what}, {options}) Number create a popup window used as a menu
401popup_move({id}, {options}) none set position of popup window {id}
402popup_notification({what}, {options})
403 Number create a notification popup window
404popup_setoptions({id}, {options})
405 none set options for popup window {id}
406popup_settext({id}, {text}) none set the text of popup window {id}
407popup_show({id}) none unhide popup window {id}
408pow({x}, {y}) Float {x} to the power of {y}
409prevnonblank({lnum}) Number line nr of non-blank line <= {lnum}
410printf({fmt}, {expr1}...) String format text
411prompt_getprompt({buf}) String get prompt text
412prompt_setcallback({buf}, {expr}) none set prompt callback function
413prompt_setinterrupt({buf}, {text}) none set prompt interrupt function
414prompt_setprompt({buf}, {text}) none set prompt text
415prop_add({lnum}, {col}, {props}) none add one text property
416prop_add_list({props}, [[{lnum}, {col}, {end-lnum}, {end-col}], ...])
417 none add multiple text properties
418prop_clear({lnum} [, {lnum-end} [, {props}]])
419 none remove all text properties
420prop_find({props} [, {direction}])
421 Dict search for a text property
422prop_list({lnum} [, {props}]) List text properties in {lnum}
423prop_remove({props} [, {lnum} [, {lnum-end}]])
424 Number remove a text property
425prop_type_add({name}, {props}) none define a new property type
426prop_type_change({name}, {props})
427 none change an existing property type
428prop_type_delete({name} [, {props}])
429 none delete a property type
430prop_type_get({name} [, {props}])
431 Dict get property type values
432prop_type_list([{props}]) List get list of property types
433pum_getpos() Dict position and size of pum if visible
434pumvisible() Number whether popup menu is visible
435py3eval({expr}) any evaluate |python3| expression
436pyeval({expr}) any evaluate |Python| expression
437pyxeval({expr}) any evaluate |python_x| expression
438rand([{expr}]) Number get pseudo-random number
439range({expr} [, {max} [, {stride}]])
440 List items from {expr} to {max}
441readblob({fname}) Blob read a |Blob| from {fname}
442readdir({dir} [, {expr} [, {dict}]])
443 List file names in {dir} selected by {expr}
444readdirex({dir} [, {expr} [, {dict}]])
445 List file info in {dir} selected by {expr}
446readfile({fname} [, {type} [, {max}]])
447 List get list of lines from file {fname}
448reduce({object}, {func} [, {initial}])
449 any reduce {object} using {func}
450reg_executing() String get the executing register name
451reg_recording() String get the recording register name
452reltime([{start} [, {end}]]) List get time value
453reltimefloat({time}) Float turn the time value into a Float
454reltimestr({time}) String turn time value into a String
455remote_expr({server}, {string} [, {idvar} [, {timeout}]])
456 String send expression
457remote_foreground({server}) Number bring Vim server to the foreground
458remote_peek({serverid} [, {retvar}])
459 Number check for reply string
460remote_read({serverid} [, {timeout}])
461 String read reply string
462remote_send({server}, {string} [, {idvar}])
463 String send key sequence
464remote_startserver({name}) none become server {name}
465remove({list}, {idx} [, {end}]) any/List
466 remove items {idx}-{end} from {list}
467remove({blob}, {idx} [, {end}]) Number/Blob
468 remove bytes {idx}-{end} from {blob}
469remove({dict}, {key}) any remove entry {key} from {dict}
470rename({from}, {to}) Number rename (move) file from {from} to {to}
471repeat({expr}, {count}) String repeat {expr} {count} times
472resolve({filename}) String get filename a shortcut points to
473reverse({list}) List reverse {list} in-place
474round({expr}) Float round off {expr}
475rubyeval({expr}) any evaluate |Ruby| expression
476screenattr({row}, {col}) Number attribute at screen position
477screenchar({row}, {col}) Number character at screen position
478screenchars({row}, {col}) List List of characters at screen position
479screencol() Number current cursor column
480screenpos({winid}, {lnum}, {col}) Dict screen row and col of a text character
481screenrow() Number current cursor row
482screenstring({row}, {col}) String characters at screen position
483search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
484 Number search for {pattern}
485searchcount([{options}]) Dict get or update search stats
486searchdecl({name} [, {global} [, {thisblock}]])
487 Number search for variable declaration
488searchpair({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
489 Number search for other end of start/end pair
490searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [...]]])
491 List search for other end of start/end pair
492searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
493 List search for {pattern}
494server2client({clientid}, {string})
495 Number send reply string
496serverlist() String get a list of available servers
497setbufline({expr}, {lnum}, {text})
498 Number set line {lnum} to {text} in buffer
499 {expr}
500setbufvar({buf}, {varname}, {val})
501 none set {varname} in buffer {buf} to {val}
502setcellwidths({list}) none set character cell width overrides
503setcharpos({expr}, {list}) Number set the {expr} position to {list}
504setcharsearch({dict}) Dict set character search from {dict}
505setcmdpos({pos}) Number set cursor position in command-line
506setcursorcharpos({list}) Number move cursor to position in {list}
507setenv({name}, {val}) none set environment variable
508setfperm({fname}, {mode}) Number set {fname} file permissions to {mode}
509setline({lnum}, {line}) Number set line {lnum} to {line}
510setloclist({nr}, {list} [, {action}])
511 Number modify location list using {list}
512setloclist({nr}, {list}, {action}, {what})
513 Number modify specific location list props
514setmatches({list} [, {win}]) Number restore a list of matches
515setpos({expr}, {list}) Number set the {expr} position to {list}
516setqflist({list} [, {action}]) Number modify quickfix list using {list}
517setqflist({list}, {action}, {what})
518 Number modify specific quickfix list props
519setreg({n}, {v} [, {opt}]) Number set register to value and type
520settabvar({nr}, {varname}, {val}) none set {varname} in tab page {nr} to {val}
521settabwinvar({tabnr}, {winnr}, {varname}, {val})
522 none set {varname} in window {winnr} in tab
523 page {tabnr} to {val}
524settagstack({nr}, {dict} [, {action}])
525 Number modify tag stack using {dict}
526setwinvar({nr}, {varname}, {val}) none set {varname} in window {nr} to {val}
527sha256({string}) String SHA256 checksum of {string}
528shellescape({string} [, {special}])
529 String escape {string} for use as shell
530 command argument
531shiftwidth([{col}]) Number effective value of 'shiftwidth'
532sign_define({name} [, {dict}]) Number define or update a sign
533sign_define({list}) List define or update a list of signs
534sign_getdefined([{name}]) List get a list of defined signs
535sign_getplaced([{buf} [, {dict}]])
536 List get a list of placed signs
537sign_jump({id}, {group}, {buf})
538 Number jump to a sign
539sign_place({id}, {group}, {name}, {buf} [, {dict}])
540 Number place a sign
541sign_placelist({list}) List place a list of signs
542sign_undefine([{name}]) Number undefine a sign
543sign_undefine({list}) List undefine a list of signs
544sign_unplace({group} [, {dict}])
545 Number unplace a sign
546sign_unplacelist({list}) List unplace a list of signs
547simplify({filename}) String simplify filename as much as possible
548sin({expr}) Float sine of {expr}
549sinh({expr}) Float hyperbolic sine of {expr}
550slice({expr}, {start} [, {end}]) String, List or Blob
551 slice of a String, List or Blob
Bram Moolenaar2007dd42022-02-23 13:17:47 +0000552sort({list} [, {how} [, {dict}]])
553 List sort {list}, compare with {how}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000554sound_clear() none stop playing all sounds
555sound_playevent({name} [, {callback}])
556 Number play an event sound
557sound_playfile({path} [, {callback}])
558 Number play sound file {path}
559sound_stop({id}) none stop playing sound {id}
560soundfold({word}) String sound-fold {word}
561spellbadword() String badly spelled word at cursor
562spellsuggest({word} [, {max} [, {capital}]])
563 List spelling suggestions
564split({expr} [, {pat} [, {keepempty}]])
565 List make |List| from {pat} separated {expr}
566sqrt({expr}) Float square root of {expr}
567srand([{expr}]) List get seed for |rand()|
568state([{what}]) String current state of Vim
569str2float({expr} [, {quoted}]) Float convert String to Float
570str2list({expr} [, {utf8}]) List convert each character of {expr} to
571 ASCII/UTF-8 value
572str2nr({expr} [, {base} [, {quoted}]])
573 Number convert String to Number
574strcharlen({expr}) Number character length of the String {expr}
575strcharpart({str}, {start} [, {len} [, {skipcc}]])
576 String {len} characters of {str} at
577 character {start}
578strchars({expr} [, {skipcc}]) Number character count of the String {expr}
579strdisplaywidth({expr} [, {col}]) Number display length of the String {expr}
580strftime({format} [, {time}]) String format time with a specified format
581strgetchar({str}, {index}) Number get char {index} from {str}
582stridx({haystack}, {needle} [, {start}])
583 Number index of {needle} in {haystack}
584string({expr}) String String representation of {expr} value
585strlen({expr}) Number length of the String {expr}
586strpart({str}, {start} [, {len} [, {chars}]])
587 String {len} bytes/chars of {str} at
588 byte {start}
589strptime({format}, {timestring})
590 Number Convert {timestring} to unix timestamp
591strridx({haystack}, {needle} [, {start}])
592 Number last index of {needle} in {haystack}
593strtrans({expr}) String translate string to make it printable
594strwidth({expr}) Number display cell length of the String {expr}
595submatch({nr} [, {list}]) String or List
596 specific match in ":s" or substitute()
597substitute({expr}, {pat}, {sub}, {flags})
598 String all {pat} in {expr} replaced with {sub}
599swapinfo({fname}) Dict information about swap file {fname}
600swapname({buf}) String swap file of buffer {buf}
601synID({lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
602synIDattr({synID}, {what} [, {mode}])
603 String attribute {what} of syntax ID {synID}
604synIDtrans({synID}) Number translated syntax ID of {synID}
605synconcealed({lnum}, {col}) List info about concealing
606synstack({lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
607system({expr} [, {input}]) String output of shell command/filter {expr}
608systemlist({expr} [, {input}]) List output of shell command/filter {expr}
609tabpagebuflist([{arg}]) List list of buffer numbers in tab page
610tabpagenr([{arg}]) Number number of current or last tab page
611tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page
612tagfiles() List tags files used
613taglist({expr} [, {filename}]) List list of tags matching {expr}
614tan({expr}) Float tangent of {expr}
615tanh({expr}) Float hyperbolic tangent of {expr}
616tempname() String name for a temporary file
617term_dumpdiff({filename}, {filename} [, {options}])
618 Number display difference between two dumps
619term_dumpload({filename} [, {options}])
620 Number displaying a screen dump
621term_dumpwrite({buf}, {filename} [, {options}])
622 none dump terminal window contents
623term_getaltscreen({buf}) Number get the alternate screen flag
624term_getansicolors({buf}) List get ANSI palette in GUI color mode
625term_getattr({attr}, {what}) Number get the value of attribute {what}
626term_getcursor({buf}) List get the cursor position of a terminal
627term_getjob({buf}) Job get the job associated with a terminal
628term_getline({buf}, {row}) String get a line of text from a terminal
629term_getscrolled({buf}) Number get the scroll count of a terminal
630term_getsize({buf}) List get the size of a terminal
631term_getstatus({buf}) String get the status of a terminal
632term_gettitle({buf}) String get the title of a terminal
633term_gettty({buf}, [{input}]) String get the tty name of a terminal
634term_list() List get the list of terminal buffers
635term_scrape({buf}, {row}) List get row of a terminal screen
636term_sendkeys({buf}, {keys}) none send keystrokes to a terminal
637term_setansicolors({buf}, {colors})
638 none set ANSI palette in GUI color mode
639term_setapi({buf}, {expr}) none set |terminal-api| function name prefix
640term_setkill({buf}, {how}) none set signal to stop job in terminal
641term_setrestore({buf}, {command}) none set command to restore terminal
642term_setsize({buf}, {rows}, {cols})
643 none set the size of a terminal
644term_start({cmd} [, {options}]) Number open a terminal window and run a job
645term_wait({buf} [, {time}]) Number wait for screen to be updated
646terminalprops() Dict properties of the terminal
647test_alloc_fail({id}, {countdown}, {repeat})
648 none make memory allocation fail
649test_autochdir() none enable 'autochdir' during startup
650test_feedinput({string}) none add key sequence to input buffer
651test_garbagecollect_now() none free memory right now for testing
652test_garbagecollect_soon() none free memory soon for testing
653test_getvalue({string}) any get value of an internal variable
Yegappan Lakshmanan06011e12022-01-30 12:37:29 +0000654test_gui_event({event}, {args}) bool generate a GUI event for testing
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000655test_ignore_error({expr}) none ignore a specific error
656test_null_blob() Blob null value for testing
657test_null_channel() Channel null value for testing
658test_null_dict() Dict null value for testing
659test_null_function() Funcref null value for testing
660test_null_job() Job null value for testing
661test_null_list() List null value for testing
662test_null_partial() Funcref null value for testing
663test_null_string() String null value for testing
664test_option_not_set({name}) none reset flag indicating option was set
665test_override({expr}, {val}) none test with Vim internal overrides
666test_refcount({expr}) Number get the reference count of {expr}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000667test_setmouse({row}, {col}) none set the mouse position for testing
668test_settime({expr}) none set current time for testing
669test_srand_seed([seed]) none set seed for testing srand()
670test_unknown() any unknown value for testing
671test_void() any void value for testing
672timer_info([{id}]) List information about timers
673timer_pause({id}, {pause}) none pause or unpause a timer
674timer_start({time}, {callback} [, {options}])
675 Number create a timer
676timer_stop({timer}) none stop a timer
677timer_stopall() none stop all timers
678tolower({expr}) String the String {expr} switched to lowercase
679toupper({expr}) String the String {expr} switched to uppercase
680tr({src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
681 to chars in {tostr}
682trim({text} [, {mask} [, {dir}]])
683 String trim characters in {mask} from {text}
684trunc({expr}) Float truncate Float {expr}
685type({expr}) Number type of value {expr}
686typename({expr}) String representation of the type of {expr}
687undofile({name}) String undo file name for {name}
688undotree() List undo file tree
689uniq({list} [, {func} [, {dict}]])
690 List remove adjacent duplicates from a list
691values({dict}) List values in {dict}
692virtcol({expr}) Number screen column of cursor or mark
693visualmode([expr]) String last visual mode used
694wildmenumode() Number whether 'wildmenu' mode is active
695win_execute({id}, {command} [, {silent}])
696 String execute {command} in window {id}
697win_findbuf({bufnr}) List find windows containing {bufnr}
698win_getid([{win} [, {tab}]]) Number get window ID for {win} in {tab}
699win_gettype([{nr}]) String type of window {nr}
700win_gotoid({expr}) Number go to window with ID {expr}
701win_id2tabwin({expr}) List get tab and window nr from window ID
702win_id2win({expr}) Number get window nr from window ID
Daniel Steinbergee630312022-01-10 13:36:34 +0000703win_move_separator({nr}) Number move window vertical separator
704win_move_statusline({nr}) Number move window status line
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000705win_screenpos({nr}) List get screen position of window {nr}
706win_splitmove({nr}, {target} [, {options}])
707 Number move window {nr} to split of {target}
708winbufnr({nr}) Number buffer number of window {nr}
709wincol() Number window column of the cursor
710windowsversion() String MS-Windows OS version
711winheight({nr}) Number height of window {nr}
712winlayout([{tabnr}]) List layout of windows in tab {tabnr}
713winline() Number window line of the cursor
714winnr([{expr}]) Number number of current window
715winrestcmd() String returns command to restore window sizes
716winrestview({dict}) none restore view of current window
717winsaveview() Dict save view of current window
718winwidth({nr}) Number width of window {nr}
719wordcount() Dict get byte/char/word statistics
720writefile({object}, {fname} [, {flags}])
721 Number write |Blob| or |List| of lines to file
722xor({expr}, {expr}) Number bitwise XOR
723
724==============================================================================
7252. Details *builtin-function-details*
726
727Not all functions are here, some have been moved to a help file covering the
728specific functionality.
729
730abs({expr}) *abs()*
731 Return the absolute value of {expr}. When {expr} evaluates to
732 a |Float| abs() returns a |Float|. When {expr} can be
733 converted to a |Number| abs() returns a |Number|. Otherwise
734 abs() gives an error message and returns -1.
735 Examples: >
736 echo abs(1.456)
737< 1.456 >
738 echo abs(-5.456)
739< 5.456 >
740 echo abs(-4)
741< 4
742
743 Can also be used as a |method|: >
744 Compute()->abs()
745
746< {only available when compiled with the |+float| feature}
747
748
749acos({expr}) *acos()*
750 Return the arc cosine of {expr} measured in radians, as a
751 |Float| in the range of [0, pi].
752 {expr} must evaluate to a |Float| or a |Number| in the range
753 [-1, 1].
754 Examples: >
755 :echo acos(0)
756< 1.570796 >
757 :echo acos(-0.5)
758< 2.094395
759
760 Can also be used as a |method|: >
761 Compute()->acos()
762
763< {only available when compiled with the |+float| feature}
764
765
766add({object}, {expr}) *add()*
767 Append the item {expr} to |List| or |Blob| {object}. Returns
768 the resulting |List| or |Blob|. Examples: >
769 :let alist = add([1, 2, 3], item)
770 :call add(mylist, "woodstock")
771< Note that when {expr} is a |List| it is appended as a single
772 item. Use |extend()| to concatenate |Lists|.
773 When {object} is a |Blob| then {expr} must be a number.
774 Use |insert()| to add an item at another position.
775
776 Can also be used as a |method|: >
777 mylist->add(val1)->add(val2)
778
779
780and({expr}, {expr}) *and()*
781 Bitwise AND on the two arguments. The arguments are converted
782 to a number. A List, Dict or Float argument causes an error.
783 Example: >
784 :let flag = and(bits, 0x80)
785< Can also be used as a |method|: >
786 :let flag = bits->and(0x80)
787
788
789append({lnum}, {text}) *append()*
790 When {text} is a |List|: Append each item of the |List| as a
791 text line below line {lnum} in the current buffer.
792 Otherwise append {text} as one text line below line {lnum} in
793 the current buffer.
794 Any type of item is accepted and converted to a String.
795 {lnum} can be zero to insert a line before the first one.
796 {lnum} is used like with |getline()|.
797 Returns 1 for failure ({lnum} out of range or out of memory),
798 0 for success. In |Vim9| script an invalid argument or
799 negative number results in an error. Example: >
800 :let failed = append(line('$'), "# THE END")
801 :let failed = append(0, ["Chapter 1", "the beginning"])
802
803< Can also be used as a |method| after a List, the base is
804 passed as the second argument: >
805 mylist->append(lnum)
806
807
808appendbufline({buf}, {lnum}, {text}) *appendbufline()*
809 Like |append()| but append the text in buffer {buf}.
810
811 This function works only for loaded buffers. First call
812 |bufload()| if needed.
813
814 For the use of {buf}, see |bufname()|.
815
Bram Moolenaar8b6256f2021-12-28 11:24:49 +0000816 {lnum} is the line number to append below. Note that using
817 |line()| would use the current buffer, not the one appending
818 to. Use "$" to append at the end of the buffer. Other string
819 values are not supported.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000820
821 On success 0 is returned, on failure 1 is returned.
822 In |Vim9| script an error is given for an invalid {lnum}.
823
824 If {buf} is not a valid buffer or {lnum} is not valid, an
825 error message is given. Example: >
826 :let failed = appendbufline(13, 0, "# THE START")
827<
828 Can also be used as a |method| after a List, the base is
829 passed as the second argument: >
830 mylist->appendbufline(buf, lnum)
831
832
833argc([{winid}]) *argc()*
834 The result is the number of files in the argument list. See
835 |arglist|.
836 If {winid} is not supplied, the argument list of the current
837 window is used.
838 If {winid} is -1, the global argument list is used.
839 Otherwise {winid} specifies the window of which the argument
840 list is used: either the window number or the window ID.
841 Returns -1 if the {winid} argument is invalid.
842
843 *argidx()*
844argidx() The result is the current index in the argument list. 0 is
845 the first file. argc() - 1 is the last one. See |arglist|.
846
847 *arglistid()*
848arglistid([{winnr} [, {tabnr}]])
849 Return the argument list ID. This is a number which
850 identifies the argument list being used. Zero is used for the
851 global argument list. See |arglist|.
852 Returns -1 if the arguments are invalid.
853
854 Without arguments use the current window.
855 With {winnr} only use this window in the current tab page.
856 With {winnr} and {tabnr} use the window in the specified tab
857 page.
858 {winnr} can be the window number or the |window-ID|.
859
860 *argv()*
861argv([{nr} [, {winid}]])
862 The result is the {nr}th file in the argument list. See
863 |arglist|. "argv(0)" is the first one. Example: >
864 :let i = 0
865 :while i < argc()
866 : let f = escape(fnameescape(argv(i)), '.')
Bram Moolenaarc51cf032022-02-26 12:25:45 +0000867 : exe 'amenu Arg.' .. f .. ' :e ' .. f .. '<CR>'
Bram Moolenaar1cae5a02021-12-27 21:28:34 +0000868 : let i = i + 1
869 :endwhile
870< Without the {nr} argument, or when {nr} is -1, a |List| with
871 the whole |arglist| is returned.
872
873 The {winid} argument specifies the window ID, see |argc()|.
874 For the Vim command line arguments see |v:argv|.
875
876asin({expr}) *asin()*
877 Return the arc sine of {expr} measured in radians, as a |Float|
878 in the range of [-pi/2, pi/2].
879 {expr} must evaluate to a |Float| or a |Number| in the range
880 [-1, 1].
881 Examples: >
882 :echo asin(0.8)
883< 0.927295 >
884 :echo asin(-0.5)
885< -0.523599
886
887 Can also be used as a |method|: >
888 Compute()->asin()
889<
890 {only available when compiled with the |+float| feature}
891
892
893assert_ functions are documented here: |assert-functions-details|
894
895
896
897atan({expr}) *atan()*
898 Return the principal value of the arc tangent of {expr}, in
899 the range [-pi/2, +pi/2] radians, as a |Float|.
900 {expr} must evaluate to a |Float| or a |Number|.
901 Examples: >
902 :echo atan(100)
903< 1.560797 >
904 :echo atan(-4.01)
905< -1.326405
906
907 Can also be used as a |method|: >
908 Compute()->atan()
909<
910 {only available when compiled with the |+float| feature}
911
912
913atan2({expr1}, {expr2}) *atan2()*
914 Return the arc tangent of {expr1} / {expr2}, measured in
915 radians, as a |Float| in the range [-pi, pi].
916 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
917 Examples: >
918 :echo atan2(-1, 1)
919< -0.785398 >
920 :echo atan2(1, -1)
921< 2.356194
922
923 Can also be used as a |method|: >
924 Compute()->atan2(1)
925<
926 {only available when compiled with the |+float| feature}
927
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +0100928
929autocmd_add({acmds}) *autocmd_add()*
930 Adds a List of autocmds and autocmd groups.
931
932 The {acmds} argument is a List where each item is a Dict with
933 the following optional items:
934 bufnr buffer number to add a buffer-local autocmd.
935 If this item is specified, then the "pattern"
936 item is ignored.
937 cmd Ex command to execute for this autocmd event
938 event autocmd event name. Refer to |autocmd-events|.
939 group autocmd group name. Refer to |autocmd-groups|.
940 If this group doesn't exist then it is
941 created. If not specified or empty, then the
942 default group is used.
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +0100943 nested boolean flag, set to v:true to add a nested
944 autocmd. Refer to |autocmd-nested|.
945 once boolean flag, set to v:true to add a autocmd
946 which executes only once. Refer to
947 |autocmd-once|.
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +0100948 pattern autocmd pattern string. Refer to
949 |autocmd-patterns|. If "bufnr" item is
950 present, then this item is ignored.
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +0100951 replace boolean flag, set to v:true to remove all the
952 commands associated with the specified autocmd
953 event and group and add the {cmd}. This is
954 useful to avoid adding the same command
955 multiple times for a autocmd event in a group.
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +0100956
957 Returns v:true on success and v:false on failure.
958 Examples: >
959 " Create a buffer-local autocmd for buffer 5
960 let acmd = {}
961 let acmd.group = 'MyGroup'
962 let acmd.event = 'BufEnter'
963 let acmd.bufnr = 5
964 let acmd.cmd = 'call BufEnterFunc()'
965 call autocmd_add([acmd])
966
967 Can also be used as a |method|: >
968 GetAutocmdList()->autocmd_add()
969<
970autocmd_delete({acmds}) *autocmd_delete()*
971 Deletes a List of autocmds and autocmd groups.
972
973 The {acmds} argument is a List where each item is a Dict with
974 the following optional items:
975 bufnr buffer number to delete a buffer-local autocmd.
976 If this item is specified, then the "pattern"
977 item is ignored.
978 cmd Ex command for this autocmd event
979 event autocmd event name. Refer to |autocmd-events|.
980 If '*' then all the autocmd events in this
981 group are deleted.
982 group autocmd group name. Refer to |autocmd-groups|.
983 If not specified or empty, then the default
984 group is used.
985 nested set to v:true for a nested autocmd.
986 Refer to |autocmd-nested|.
987 once set to v:true for an autocmd which executes
988 only once. Refer to |autocmd-once|.
989 pattern autocmd pattern string. Refer to
990 |autocmd-patterns|. If "bufnr" item is
991 present, then this item is ignored.
992
993 If only {group} is specified in a {acmds} entry and {event},
994 {pattern} and {cmd} are not specified, then that autocmd group
995 is deleted.
996
997 Returns v:true on success and v:false on failure.
998 Examples: >
999 " :autocmd! BufLeave *.vim
1000 let acmd = #{event: 'BufLeave', pattern: '*.vim'}
1001 call autocmd_delete([acmd]})
1002 " :autocmd! MyGroup1 BufLeave
1003 let acmd = #{group: 'MyGroup1', event: 'BufLeave'}
1004 call autocmd_delete([acmd])
1005 " :autocmd! MyGroup2 BufEnter *.c
1006 let acmd = #{group: 'MyGroup2', event: 'BufEnter',
1007 \ pattern: '*.c'}
1008 " :autocmd! MyGroup2 * *.c
1009 let acmd = #{group: 'MyGroup2', event: '*',
1010 \ pattern: '*.c'}
1011 call autocmd_delete([acmd])
1012 " :autocmd! MyGroup3
1013 let acmd = #{group: 'MyGroup3'}
1014 call autocmd_delete([acmd])
1015<
1016 Can also be used as a |method|: >
1017 GetAutocmdList()->autocmd_delete()
1018
1019autocmd_get([{opts}]) *autocmd_get()*
1020 Returns a |List| of autocmds. If {opts} is not supplied, then
1021 returns the autocmds for all the events in all the groups.
1022
1023 The optional {opts} Dict argument supports the following
1024 items:
1025 group Autocmd group name. If specified, returns only
1026 the autocmds defined in this group. If the
1027 specified group doesn't exist, results in an
1028 error message. If set to an empty string,
1029 then the default autocmd group is used.
1030 event Autocmd event name. If specified, returns only
1031 the autocmds defined for this event. If set
1032 to "*", then returns autocmds for all the
1033 events. If the specified event doesn't exist,
1034 results in an error message.
1035 pattern Autocmd pattern. If specified, returns only
1036 the autocmds defined for this pattern.
1037 A combination of the above three times can be supplied in
1038 {opts}.
1039
1040 Each Dict in the returned List contains the following items:
1041 bufnr For buffer-local autocmds, buffer number where
1042 the autocmd is defined.
1043 cmd Command executed for this autocmd.
1044 event Autocmd event name.
1045 group Autocmd group name.
Yegappan Lakshmanan971f6822022-05-24 11:40:11 +01001046 nested Boolean flag, set to v:true for a nested
1047 autocmd. See |autocmd-nested|.
1048 once Boolean flag, set to v:true, if the autocmd
1049 will be executed only once. See |autocmd-once|.
Yegappan Lakshmanan1755a912022-05-19 10:31:47 +01001050 pattern Autocmd pattern. For a buffer-local
1051 autocmd, this will be of the form "<buffer=n>".
1052 If there are multiple commands for an autocmd event in a
1053 group, then separate items are returned for each command.
1054
1055 Examples: >
1056 " :autocmd MyGroup
1057 echo autocmd_get(#{group: 'Mygroup'})
1058 " :autocmd G BufUnload
1059 echo autocmd_get(#{group: 'G', event: 'BufUnload'})
1060 " :autocmd G * *.ts
1061 let acmd = #{group: 'G', event: '*', pattern: '*.ts'}
1062 echo autocmd_get(acmd)
1063 " :autocmd Syntax
1064 echo autocmd_get(#{event: 'Syntax'})
1065 " :autocmd G BufEnter *.ts
1066 let acmd = #{group: 'G', event: 'BufEnter',
1067 \ pattern: '*.ts'}
1068 echo autocmd_get(acmd)
1069<
1070 Can also be used as a |method|: >
1071 Getopts()->autocmd_get()
1072<
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001073balloon_gettext() *balloon_gettext()*
1074 Return the current text in the balloon. Only for the string,
1075 not used for the List.
1076
1077balloon_show({expr}) *balloon_show()*
1078 Show {expr} inside the balloon. For the GUI {expr} is used as
1079 a string. For a terminal {expr} can be a list, which contains
1080 the lines of the balloon. If {expr} is not a list it will be
1081 split with |balloon_split()|.
1082 If {expr} is an empty string any existing balloon is removed.
1083
1084 Example: >
1085 func GetBalloonContent()
1086 " ... initiate getting the content
1087 return ''
1088 endfunc
1089 set balloonexpr=GetBalloonContent()
1090
1091 func BalloonCallback(result)
1092 call balloon_show(a:result)
1093 endfunc
1094< Can also be used as a |method|: >
1095 GetText()->balloon_show()
1096<
1097 The intended use is that fetching the content of the balloon
1098 is initiated from 'balloonexpr'. It will invoke an
1099 asynchronous method, in which a callback invokes
1100 balloon_show(). The 'balloonexpr' itself can return an
1101 empty string or a placeholder.
1102
1103 When showing a balloon is not possible nothing happens, no
1104 error message.
1105 {only available when compiled with the |+balloon_eval| or
1106 |+balloon_eval_term| feature}
1107
1108balloon_split({msg}) *balloon_split()*
1109 Split String {msg} into lines to be displayed in a balloon.
1110 The splits are made for the current window size and optimize
1111 to show debugger output.
1112 Returns a |List| with the split lines.
1113 Can also be used as a |method|: >
1114 GetText()->balloon_split()->balloon_show()
1115
1116< {only available when compiled with the |+balloon_eval_term|
1117 feature}
1118
1119blob2list({blob}) *blob2list()*
1120 Return a List containing the number value of each byte in Blob
1121 {blob}. Examples: >
1122 blob2list(0z0102.0304) returns [1, 2, 3, 4]
1123 blob2list(0z) returns []
1124< Returns an empty List on error. |list2blob()| does the
1125 opposite.
1126
1127 Can also be used as a |method|: >
1128 GetBlob()->blob2list()
1129
1130 *browse()*
1131browse({save}, {title}, {initdir}, {default})
1132 Put up a file requester. This only works when "has("browse")"
1133 returns |TRUE| (only in some GUI versions).
1134 The input fields are:
1135 {save} when |TRUE|, select file to write
1136 {title} title for the requester
1137 {initdir} directory to start browsing in
1138 {default} default file name
1139 An empty string is returned when the "Cancel" button is hit,
1140 something went wrong, or browsing is not possible.
1141
1142 *browsedir()*
1143browsedir({title}, {initdir})
1144 Put up a directory requester. This only works when
1145 "has("browse")" returns |TRUE| (only in some GUI versions).
1146 On systems where a directory browser is not supported a file
1147 browser is used. In that case: select a file in the directory
1148 to be used.
1149 The input fields are:
1150 {title} title for the requester
1151 {initdir} directory to start browsing in
1152 When the "Cancel" button is hit, something went wrong, or
1153 browsing is not possible, an empty string is returned.
1154
1155bufadd({name}) *bufadd()*
1156 Add a buffer to the buffer list with String {name}.
1157 If a buffer for file {name} already exists, return that buffer
1158 number. Otherwise return the buffer number of the newly
1159 created buffer. When {name} is an empty string then a new
1160 buffer is always created.
1161 The buffer will not have 'buflisted' set and not be loaded
1162 yet. To add some text to the buffer use this: >
1163 let bufnr = bufadd('someName')
1164 call bufload(bufnr)
1165 call setbufline(bufnr, 1, ['some', 'text'])
1166< Can also be used as a |method|: >
1167 let bufnr = 'somename'->bufadd()
1168
1169bufexists({buf}) *bufexists()*
1170 The result is a Number, which is |TRUE| if a buffer called
1171 {buf} exists.
1172 If the {buf} argument is a number, buffer numbers are used.
1173 Number zero is the alternate buffer for the current window.
1174
1175 If the {buf} argument is a string it must match a buffer name
1176 exactly. The name can be:
1177 - Relative to the current directory.
1178 - A full path.
1179 - The name of a buffer with 'buftype' set to "nofile".
1180 - A URL name.
1181 Unlisted buffers will be found.
1182 Note that help files are listed by their short name in the
1183 output of |:buffers|, but bufexists() requires using their
1184 long name to be able to find them.
1185 bufexists() may report a buffer exists, but to use the name
1186 with a |:buffer| command you may need to use |expand()|. Esp
1187 for MS-Windows 8.3 names in the form "c:\DOCUME~1"
1188 Use "bufexists(0)" to test for the existence of an alternate
1189 file name.
1190
1191 Can also be used as a |method|: >
1192 let exists = 'somename'->bufexists()
1193<
1194 Obsolete name: buffer_exists(). *buffer_exists()*
1195
1196buflisted({buf}) *buflisted()*
1197 The result is a Number, which is |TRUE| if a buffer called
1198 {buf} exists and is listed (has the 'buflisted' option set).
1199 The {buf} argument is used like with |bufexists()|.
1200
1201 Can also be used as a |method|: >
1202 let listed = 'somename'->buflisted()
1203
1204bufload({buf}) *bufload()*
1205 Ensure the buffer {buf} is loaded. When the buffer name
1206 refers to an existing file then the file is read. Otherwise
1207 the buffer will be empty. If the buffer was already loaded
1208 then there is no change.
1209 If there is an existing swap file for the file of the buffer,
1210 there will be no dialog, the buffer will be loaded anyway.
1211 The {buf} argument is used like with |bufexists()|.
1212
1213 Can also be used as a |method|: >
1214 eval 'somename'->bufload()
1215
1216bufloaded({buf}) *bufloaded()*
1217 The result is a Number, which is |TRUE| if a buffer called
1218 {buf} exists and is loaded (shown in a window or hidden).
1219 The {buf} argument is used like with |bufexists()|.
1220
1221 Can also be used as a |method|: >
1222 let loaded = 'somename'->bufloaded()
1223
1224bufname([{buf}]) *bufname()*
1225 The result is the name of a buffer. Mostly as it is displayed
1226 by the `:ls` command, but not using special names such as
1227 "[No Name]".
1228 If {buf} is omitted the current buffer is used.
1229 If {buf} is a Number, that buffer number's name is given.
1230 Number zero is the alternate buffer for the current window.
1231 If {buf} is a String, it is used as a |file-pattern| to match
1232 with the buffer names. This is always done like 'magic' is
1233 set and 'cpoptions' is empty. When there is more than one
1234 match an empty string is returned.
1235 "" or "%" can be used for the current buffer, "#" for the
1236 alternate buffer.
1237 A full match is preferred, otherwise a match at the start, end
1238 or middle of the buffer name is accepted. If you only want a
1239 full match then put "^" at the start and "$" at the end of the
1240 pattern.
1241 Listed buffers are found first. If there is a single match
1242 with a listed buffer, that one is returned. Next unlisted
1243 buffers are searched for.
1244 If the {buf} is a String, but you want to use it as a buffer
1245 number, force it to be a Number by adding zero to it: >
1246 :echo bufname("3" + 0)
1247< Can also be used as a |method|: >
1248 echo bufnr->bufname()
1249
1250< If the buffer doesn't exist, or doesn't have a name, an empty
1251 string is returned. >
1252 bufname("#") alternate buffer name
1253 bufname(3) name of buffer 3
1254 bufname("%") name of current buffer
1255 bufname("file2") name of buffer where "file2" matches.
1256< *buffer_name()*
1257 Obsolete name: buffer_name().
1258
1259 *bufnr()*
1260bufnr([{buf} [, {create}]])
1261 The result is the number of a buffer, as it is displayed by
1262 the `:ls` command. For the use of {buf}, see |bufname()|
1263 above.
1264
1265 If the buffer doesn't exist, -1 is returned. Or, if the
1266 {create} argument is present and TRUE, a new, unlisted,
1267 buffer is created and its number is returned. Example: >
1268 let newbuf = bufnr('Scratch001', 1)
1269< Using an empty name uses the current buffer. To create a new
1270 buffer with an empty name use |bufadd()|.
1271
1272 bufnr("$") is the last buffer: >
1273 :let last_buffer = bufnr("$")
1274< The result is a Number, which is the highest buffer number
1275 of existing buffers. Note that not all buffers with a smaller
1276 number necessarily exist, because ":bwipeout" may have removed
1277 them. Use bufexists() to test for the existence of a buffer.
1278
1279 Can also be used as a |method|: >
1280 echo bufref->bufnr()
1281<
1282 Obsolete name: buffer_number(). *buffer_number()*
1283 *last_buffer_nr()*
1284 Obsolete name for bufnr("$"): last_buffer_nr().
1285
1286bufwinid({buf}) *bufwinid()*
1287 The result is a Number, which is the |window-ID| of the first
1288 window associated with buffer {buf}. For the use of {buf},
1289 see |bufname()| above. If buffer {buf} doesn't exist or
1290 there is no such window, -1 is returned. Example: >
1291
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001292 echo "A window containing buffer 1 is " .. (bufwinid(1))
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001293<
1294 Only deals with the current tab page.
1295
1296 Can also be used as a |method|: >
1297 FindBuffer()->bufwinid()
1298
1299bufwinnr({buf}) *bufwinnr()*
1300 Like |bufwinid()| but return the window number instead of the
1301 |window-ID|.
1302 If buffer {buf} doesn't exist or there is no such window, -1
1303 is returned. Example: >
1304
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001305 echo "A window containing buffer 1 is " .. (bufwinnr(1))
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001306
1307< The number can be used with |CTRL-W_w| and ":wincmd w"
1308 |:wincmd|.
1309
1310 Can also be used as a |method|: >
1311 FindBuffer()->bufwinnr()
1312
1313byte2line({byte}) *byte2line()*
1314 Return the line number that contains the character at byte
1315 count {byte} in the current buffer. This includes the
1316 end-of-line character, depending on the 'fileformat' option
1317 for the current buffer. The first character has byte count
1318 one.
1319 Also see |line2byte()|, |go| and |:goto|.
1320
1321 Can also be used as a |method|: >
1322 GetOffset()->byte2line()
1323
1324< {not available when compiled without the |+byte_offset|
1325 feature}
1326
1327byteidx({expr}, {nr}) *byteidx()*
1328 Return byte index of the {nr}'th character in the String
1329 {expr}. Use zero for the first character, it then returns
1330 zero.
1331 If there are no multibyte characters the returned value is
1332 equal to {nr}.
1333 Composing characters are not counted separately, their byte
1334 length is added to the preceding base character. See
1335 |byteidxcomp()| below for counting composing characters
1336 separately.
1337 Example : >
1338 echo matchstr(str, ".", byteidx(str, 3))
1339< will display the fourth character. Another way to do the
1340 same: >
1341 let s = strpart(str, byteidx(str, 3))
1342 echo strpart(s, 0, byteidx(s, 1))
1343< Also see |strgetchar()| and |strcharpart()|.
1344
1345 If there are less than {nr} characters -1 is returned.
1346 If there are exactly {nr} characters the length of the string
1347 in bytes is returned.
1348
1349 Can also be used as a |method|: >
1350 GetName()->byteidx(idx)
1351
1352byteidxcomp({expr}, {nr}) *byteidxcomp()*
1353 Like byteidx(), except that a composing character is counted
1354 as a separate character. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001355 let s = 'e' .. nr2char(0x301)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001356 echo byteidx(s, 1)
1357 echo byteidxcomp(s, 1)
1358 echo byteidxcomp(s, 2)
1359< The first and third echo result in 3 ('e' plus composing
1360 character is 3 bytes), the second echo results in 1 ('e' is
1361 one byte).
1362 Only works differently from byteidx() when 'encoding' is set
1363 to a Unicode encoding.
1364
1365 Can also be used as a |method|: >
1366 GetName()->byteidxcomp(idx)
1367
1368call({func}, {arglist} [, {dict}]) *call()* *E699*
1369 Call function {func} with the items in |List| {arglist} as
1370 arguments.
1371 {func} can either be a |Funcref| or the name of a function.
1372 a:firstline and a:lastline are set to the cursor line.
1373 Returns the return value of the called function.
1374 {dict} is for functions with the "dict" attribute. It will be
1375 used to set the local variable "self". |Dictionary-function|
1376
1377 Can also be used as a |method|: >
1378 GetFunc()->call([arg, arg], dict)
1379
1380ceil({expr}) *ceil()*
1381 Return the smallest integral value greater than or equal to
1382 {expr} as a |Float| (round up).
1383 {expr} must evaluate to a |Float| or a |Number|.
1384 Examples: >
1385 echo ceil(1.456)
1386< 2.0 >
1387 echo ceil(-5.456)
1388< -5.0 >
1389 echo ceil(4.0)
1390< 4.0
1391
1392 Can also be used as a |method|: >
1393 Compute()->ceil()
1394<
1395 {only available when compiled with the |+float| feature}
1396
1397
1398ch_ functions are documented here: |channel-functions-details|
1399
1400
1401changenr() *changenr()*
1402 Return the number of the most recent change. This is the same
1403 number as what is displayed with |:undolist| and can be used
1404 with the |:undo| command.
1405 When a change was made it is the number of that change. After
1406 redo it is the number of the redone change. After undo it is
1407 one less than the number of the undone change.
1408
1409char2nr({string} [, {utf8}]) *char2nr()*
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01001410 Return Number value of the first char in {string}.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001411 Examples: >
1412 char2nr(" ") returns 32
1413 char2nr("ABC") returns 65
1414< When {utf8} is omitted or zero, the current 'encoding' is used.
1415 Example for "utf-8": >
1416 char2nr("á") returns 225
1417 char2nr("á"[0]) returns 195
1418< When {utf8} is TRUE, always treat as UTF-8 characters.
1419 A combining character is a separate character.
1420 |nr2char()| does the opposite.
1421 To turn a string into a list of character numbers: >
1422 let str = "ABC"
1423 let list = map(split(str, '\zs'), {_, val -> char2nr(val)})
1424< Result: [65, 66, 67]
1425
1426 Can also be used as a |method|: >
1427 GetChar()->char2nr()
1428
1429
1430charclass({string}) *charclass()*
1431 Return the character class of the first character in {string}.
1432 The character class is one of:
1433 0 blank
1434 1 punctuation
1435 2 word character
1436 3 emoji
1437 other specific Unicode class
1438 The class is used in patterns and word motions.
1439
1440
1441charcol({expr}) *charcol()*
1442 Same as |col()| but returns the character index of the column
1443 position given with {expr} instead of the byte position.
1444
1445 Example:
1446 With the cursor on '세' in line 5 with text "여보세요": >
1447 charcol('.') returns 3
1448 col('.') returns 7
1449
1450< Can also be used as a |method|: >
1451 GetPos()->col()
1452<
1453 *charidx()*
1454charidx({string}, {idx} [, {countcc}])
1455 Return the character index of the byte at {idx} in {string}.
1456 The index of the first character is zero.
1457 If there are no multibyte characters the returned value is
1458 equal to {idx}.
1459 When {countcc} is omitted or |FALSE|, then composing characters
1460 are not counted separately, their byte length is
1461 added to the preceding base character.
1462 When {countcc} is |TRUE|, then composing characters are
1463 counted as separate characters.
1464 Returns -1 if the arguments are invalid or if {idx} is greater
1465 than the index of the last byte in {string}. An error is
1466 given if the first argument is not a string, the second
1467 argument is not a number or when the third argument is present
1468 and is not zero or one.
1469 See |byteidx()| and |byteidxcomp()| for getting the byte index
1470 from the character index.
1471 Examples: >
1472 echo charidx('áb́ć', 3) returns 1
1473 echo charidx('áb́ć', 6, 1) returns 4
1474 echo charidx('áb́ć', 16) returns -1
1475<
1476 Can also be used as a |method|: >
1477 GetName()->charidx(idx)
1478
1479chdir({dir}) *chdir()*
1480 Change the current working directory to {dir}. The scope of
1481 the directory change depends on the directory of the current
1482 window:
1483 - If the current window has a window-local directory
1484 (|:lcd|), then changes the window local directory.
1485 - Otherwise, if the current tabpage has a local
1486 directory (|:tcd|) then changes the tabpage local
1487 directory.
1488 - Otherwise, changes the global directory.
1489 {dir} must be a String.
1490 If successful, returns the previous working directory. Pass
1491 this to another chdir() to restore the directory.
1492 On failure, returns an empty string.
1493
1494 Example: >
1495 let save_dir = chdir(newdir)
1496 if save_dir != ""
1497 " ... do some work
1498 call chdir(save_dir)
1499 endif
1500
1501< Can also be used as a |method|: >
1502 GetDir()->chdir()
1503<
1504cindent({lnum}) *cindent()*
1505 Get the amount of indent for line {lnum} according the C
1506 indenting rules, as with 'cindent'.
1507 The indent is counted in spaces, the value of 'tabstop' is
1508 relevant. {lnum} is used just like in |getline()|.
Bram Moolenaar8e145b82022-05-21 20:17:31 +01001509 When {lnum} is invalid -1 is returned.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001510 See |C-indenting|.
1511
1512 Can also be used as a |method|: >
1513 GetLnum()->cindent()
1514
1515clearmatches([{win}]) *clearmatches()*
1516 Clears all matches previously defined for the current window
1517 by |matchadd()| and the |:match| commands.
1518 If {win} is specified, use the window with this number or
1519 window ID instead of the current window.
1520
1521 Can also be used as a |method|: >
1522 GetWin()->clearmatches()
1523<
1524 *col()*
1525col({expr}) The result is a Number, which is the byte index of the column
1526 position given with {expr}. The accepted positions are:
1527 . the cursor position
1528 $ the end of the cursor line (the result is the
1529 number of bytes in the cursor line plus one)
1530 'x position of mark x (if the mark is not set, 0 is
1531 returned)
1532 v In Visual mode: the start of the Visual area (the
1533 cursor is the end). When not in Visual mode
1534 returns the cursor position. Differs from |'<| in
1535 that it's updated right away.
1536 Additionally {expr} can be [lnum, col]: a |List| with the line
1537 and column number. Most useful when the column is "$", to get
1538 the last column of a specific line. When "lnum" or "col" is
1539 out of range then col() returns zero.
1540 To get the line number use |line()|. To get both use
1541 |getpos()|.
1542 For the screen column position use |virtcol()|. For the
1543 character position use |charcol()|.
1544 Note that only marks in the current file can be used.
1545 Examples: >
1546 col(".") column of cursor
1547 col("$") length of cursor line plus one
1548 col("'t") column of mark t
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001549 col("'" .. markname) column of mark markname
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001550< The first column is 1. 0 is returned for an error.
1551 For an uppercase mark the column may actually be in another
1552 buffer.
1553 For the cursor position, when 'virtualedit' is active, the
1554 column is one higher if the cursor is after the end of the
1555 line. This can be used to obtain the column in Insert mode: >
1556 :imap <F2> <C-O>:let save_ve = &ve<CR>
1557 \<C-O>:set ve=all<CR>
Bram Moolenaarc51cf032022-02-26 12:25:45 +00001558 \<C-O>:echo col(".") .. "\n" <Bar>
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001559 \let &ve = save_ve<CR>
1560
1561< Can also be used as a |method|: >
1562 GetPos()->col()
1563<
1564
1565complete({startcol}, {matches}) *complete()* *E785*
1566 Set the matches for Insert mode completion.
1567 Can only be used in Insert mode. You need to use a mapping
1568 with CTRL-R = (see |i_CTRL-R|). It does not work after CTRL-O
1569 or with an expression mapping.
1570 {startcol} is the byte offset in the line where the completed
1571 text start. The text up to the cursor is the original text
1572 that will be replaced by the matches. Use col('.') for an
1573 empty string. "col('.') - 1" will replace one character by a
1574 match.
1575 {matches} must be a |List|. Each |List| item is one match.
1576 See |complete-items| for the kind of items that are possible.
1577 "longest" in 'completeopt' is ignored.
1578 Note that the after calling this function you need to avoid
1579 inserting anything that would cause completion to stop.
1580 The match can be selected with CTRL-N and CTRL-P as usual with
1581 Insert mode completion. The popup menu will appear if
1582 specified, see |ins-completion-menu|.
1583 Example: >
1584 inoremap <F5> <C-R>=ListMonths()<CR>
1585
1586 func! ListMonths()
1587 call complete(col('.'), ['January', 'February', 'March',
1588 \ 'April', 'May', 'June', 'July', 'August', 'September',
1589 \ 'October', 'November', 'December'])
1590 return ''
1591 endfunc
1592< This isn't very useful, but it shows how it works. Note that
1593 an empty string is returned to avoid a zero being inserted.
1594
1595 Can also be used as a |method|, the base is passed as the
1596 second argument: >
1597 GetMatches()->complete(col('.'))
1598
1599complete_add({expr}) *complete_add()*
1600 Add {expr} to the list of matches. Only to be used by the
1601 function specified with the 'completefunc' option.
1602 Returns 0 for failure (empty string or out of memory),
1603 1 when the match was added, 2 when the match was already in
1604 the list.
1605 See |complete-functions| for an explanation of {expr}. It is
1606 the same as one item in the list that 'omnifunc' would return.
1607
1608 Can also be used as a |method|: >
1609 GetMoreMatches()->complete_add()
1610
1611complete_check() *complete_check()*
1612 Check for a key typed while looking for completion matches.
1613 This is to be used when looking for matches takes some time.
1614 Returns |TRUE| when searching for matches is to be aborted,
1615 zero otherwise.
1616 Only to be used by the function specified with the
1617 'completefunc' option.
1618
1619
1620complete_info([{what}]) *complete_info()*
1621 Returns a |Dictionary| with information about Insert mode
1622 completion. See |ins-completion|.
1623 The items are:
1624 mode Current completion mode name string.
1625 See |complete_info_mode| for the values.
1626 pum_visible |TRUE| if popup menu is visible.
1627 See |pumvisible()|.
1628 items List of completion matches. Each item is a
1629 dictionary containing the entries "word",
1630 "abbr", "menu", "kind", "info" and "user_data".
1631 See |complete-items|.
1632 selected Selected item index. First index is zero.
1633 Index is -1 if no item is selected (showing
1634 typed text only, or the last completion after
1635 no item is selected when using the <Up> or
1636 <Down> keys)
1637 inserted Inserted string. [NOT IMPLEMENT YET]
1638
1639 *complete_info_mode*
1640 mode values are:
1641 "" Not in completion mode
1642 "keyword" Keyword completion |i_CTRL-X_CTRL-N|
1643 "ctrl_x" Just pressed CTRL-X |i_CTRL-X|
1644 "scroll" Scrolling with |i_CTRL-X_CTRL-E| or
1645 |i_CTRL-X_CTRL-Y|
1646 "whole_line" Whole lines |i_CTRL-X_CTRL-L|
1647 "files" File names |i_CTRL-X_CTRL-F|
1648 "tags" Tags |i_CTRL-X_CTRL-]|
1649 "path_defines" Definition completion |i_CTRL-X_CTRL-D|
1650 "path_patterns" Include completion |i_CTRL-X_CTRL-I|
1651 "dictionary" Dictionary |i_CTRL-X_CTRL-K|
1652 "thesaurus" Thesaurus |i_CTRL-X_CTRL-T|
1653 "cmdline" Vim Command line |i_CTRL-X_CTRL-V|
1654 "function" User defined completion |i_CTRL-X_CTRL-U|
1655 "omni" Omni completion |i_CTRL-X_CTRL-O|
1656 "spell" Spelling suggestions |i_CTRL-X_s|
1657 "eval" |complete()| completion
1658 "unknown" Other internal modes
1659
1660 If the optional {what} list argument is supplied, then only
1661 the items listed in {what} are returned. Unsupported items in
1662 {what} are silently ignored.
1663
1664 To get the position and size of the popup menu, see
1665 |pum_getpos()|. It's also available in |v:event| during the
1666 |CompleteChanged| event.
1667
1668 Examples: >
1669 " Get all items
1670 call complete_info()
1671 " Get only 'mode'
1672 call complete_info(['mode'])
1673 " Get only 'mode' and 'pum_visible'
1674 call complete_info(['mode', 'pum_visible'])
1675
1676< Can also be used as a |method|: >
1677 GetItems()->complete_info()
1678<
1679 *confirm()*
1680confirm({msg} [, {choices} [, {default} [, {type}]]])
1681 confirm() offers the user a dialog, from which a choice can be
1682 made. It returns the number of the choice. For the first
1683 choice this is 1.
1684 Note: confirm() is only supported when compiled with dialog
1685 support, see |+dialog_con| and |+dialog_gui|.
1686
1687 {msg} is displayed in a |dialog| with {choices} as the
1688 alternatives. When {choices} is missing or empty, "&OK" is
1689 used (and translated).
1690 {msg} is a String, use '\n' to include a newline. Only on
1691 some systems the string is wrapped when it doesn't fit.
1692
1693 {choices} is a String, with the individual choices separated
1694 by '\n', e.g. >
1695 confirm("Save changes?", "&Yes\n&No\n&Cancel")
1696< The letter after the '&' is the shortcut key for that choice.
1697 Thus you can type 'c' to select "Cancel". The shortcut does
1698 not need to be the first letter: >
1699 confirm("file has been modified", "&Save\nSave &All")
1700< For the console, the first letter of each choice is used as
1701 the default shortcut key. Case is ignored.
1702
1703 The optional {default} argument is the number of the choice
1704 that is made if the user hits <CR>. Use 1 to make the first
1705 choice the default one. Use 0 to not set a default. If
1706 {default} is omitted, 1 is used.
1707
1708 The optional {type} String argument gives the type of dialog.
1709 This is only used for the icon of the GTK, Mac, Motif and
1710 Win32 GUI. It can be one of these values: "Error",
1711 "Question", "Info", "Warning" or "Generic". Only the first
1712 character is relevant. When {type} is omitted, "Generic" is
1713 used.
1714
1715 If the user aborts the dialog by pressing <Esc>, CTRL-C,
1716 or another valid interrupt key, confirm() returns 0.
1717
1718 An example: >
Bram Moolenaar46eea442022-03-30 10:51:39 +01001719 let choice = confirm("What do you want?",
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01001720 \ "&Apples\n&Oranges\n&Bananas", 2)
Bram Moolenaar46eea442022-03-30 10:51:39 +01001721 if choice == 0
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01001722 echo "make up your mind!"
Bram Moolenaar46eea442022-03-30 10:51:39 +01001723 elseif choice == 3
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01001724 echo "tasteful"
Bram Moolenaar46eea442022-03-30 10:51:39 +01001725 else
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01001726 echo "I prefer bananas myself."
Bram Moolenaar46eea442022-03-30 10:51:39 +01001727 endif
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001728< In a GUI dialog, buttons are used. The layout of the buttons
1729 depends on the 'v' flag in 'guioptions'. If it is included,
1730 the buttons are always put vertically. Otherwise, confirm()
1731 tries to put the buttons in one horizontal line. If they
1732 don't fit, a vertical layout is used anyway. For some systems
1733 the horizontal layout is always used.
1734
1735 Can also be used as a |method|in: >
1736 BuildMessage()->confirm("&Yes\n&No")
1737<
1738 *copy()*
1739copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
1740 different from using {expr} directly.
1741 When {expr} is a |List| a shallow copy is created. This means
1742 that the original |List| can be changed without changing the
1743 copy, and vice versa. But the items are identical, thus
1744 changing an item changes the contents of both |Lists|.
1745 A |Dictionary| is copied in a similar way as a |List|.
1746 Also see |deepcopy()|.
1747 Can also be used as a |method|: >
1748 mylist->copy()
1749
1750cos({expr}) *cos()*
1751 Return the cosine of {expr}, measured in radians, as a |Float|.
1752 {expr} must evaluate to a |Float| or a |Number|.
1753 Examples: >
1754 :echo cos(100)
1755< 0.862319 >
1756 :echo cos(-4.01)
1757< -0.646043
1758
1759 Can also be used as a |method|: >
1760 Compute()->cos()
1761<
1762 {only available when compiled with the |+float| feature}
1763
1764
1765cosh({expr}) *cosh()*
1766 Return the hyperbolic cosine of {expr} as a |Float| in the range
1767 [1, inf].
1768 {expr} must evaluate to a |Float| or a |Number|.
1769 Examples: >
1770 :echo cosh(0.5)
1771< 1.127626 >
1772 :echo cosh(-0.5)
1773< -1.127626
1774
1775 Can also be used as a |method|: >
1776 Compute()->cosh()
1777<
1778 {only available when compiled with the |+float| feature}
1779
1780
1781count({comp}, {expr} [, {ic} [, {start}]]) *count()*
1782 Return the number of times an item with value {expr} appears
1783 in |String|, |List| or |Dictionary| {comp}.
1784
1785 If {start} is given then start with the item with this index.
1786 {start} can only be used with a |List|.
1787
1788 When {ic} is given and it's |TRUE| then case is ignored.
1789
1790 When {comp} is a string then the number of not overlapping
1791 occurrences of {expr} is returned. Zero is returned when
1792 {expr} is an empty string.
1793
1794 Can also be used as a |method|: >
1795 mylist->count(val)
1796<
1797 *cscope_connection()*
1798cscope_connection([{num} , {dbpath} [, {prepend}]])
1799 Checks for the existence of a |cscope| connection. If no
1800 parameters are specified, then the function returns:
1801 0, if cscope was not available (not compiled in), or
1802 if there are no cscope connections;
1803 1, if there is at least one cscope connection.
1804
1805 If parameters are specified, then the value of {num}
1806 determines how existence of a cscope connection is checked:
1807
1808 {num} Description of existence check
1809 ----- ------------------------------
1810 0 Same as no parameters (e.g., "cscope_connection()").
1811 1 Ignore {prepend}, and use partial string matches for
1812 {dbpath}.
1813 2 Ignore {prepend}, and use exact string matches for
1814 {dbpath}.
1815 3 Use {prepend}, use partial string matches for both
1816 {dbpath} and {prepend}.
1817 4 Use {prepend}, use exact string matches for both
1818 {dbpath} and {prepend}.
1819
1820 Note: All string comparisons are case sensitive!
1821
1822 Examples. Suppose we had the following (from ":cs show"): >
1823
1824 # pid database name prepend path
1825 0 27664 cscope.out /usr/local
1826<
1827 Invocation Return Val ~
1828 ---------- ---------- >
1829 cscope_connection() 1
1830 cscope_connection(1, "out") 1
1831 cscope_connection(2, "out") 0
1832 cscope_connection(3, "out") 0
1833 cscope_connection(3, "out", "local") 1
1834 cscope_connection(4, "out") 0
1835 cscope_connection(4, "out", "local") 0
1836 cscope_connection(4, "cscope.out", "/usr/local") 1
1837<
1838cursor({lnum}, {col} [, {off}]) *cursor()*
1839cursor({list})
1840 Positions the cursor at the column (byte count) {col} in the
1841 line {lnum}. The first column is one.
1842
1843 When there is one argument {list} this is used as a |List|
1844 with two, three or four item:
1845 [{lnum}, {col}]
1846 [{lnum}, {col}, {off}]
1847 [{lnum}, {col}, {off}, {curswant}]
1848 This is like the return value of |getpos()| or |getcurpos()|,
1849 but without the first item.
1850
1851 To position the cursor using the character count, use
1852 |setcursorcharpos()|.
1853
1854 Does not change the jumplist.
1855 {lnum} is used like with |getline()|.
1856 If {lnum} is greater than the number of lines in the buffer,
1857 the cursor will be positioned at the last line in the buffer.
1858 If {lnum} is zero, the cursor will stay in the current line.
1859 If {col} is greater than the number of bytes in the line,
1860 the cursor will be positioned at the last character in the
1861 line.
1862 If {col} is zero, the cursor will stay in the current column.
1863 If {curswant} is given it is used to set the preferred column
1864 for vertical movement. Otherwise {col} is used.
1865
1866 When 'virtualedit' is used {off} specifies the offset in
1867 screen columns from the start of the character. E.g., a
1868 position within a <Tab> or after the last character.
1869 Returns 0 when the position could be set, -1 otherwise.
1870
1871 Can also be used as a |method|: >
1872 GetCursorPos()->cursor()
1873
1874debugbreak({pid}) *debugbreak()*
1875 Specifically used to interrupt a program being debugged. It
1876 will cause process {pid} to get a SIGTRAP. Behavior for other
1877 processes is undefined. See |terminal-debugger|.
1878 {only available on MS-Windows}
1879
1880 Can also be used as a |method|: >
1881 GetPid()->debugbreak()
1882
1883deepcopy({expr} [, {noref}]) *deepcopy()* *E698*
1884 Make a copy of {expr}. For Numbers and Strings this isn't
1885 different from using {expr} directly.
1886 When {expr} is a |List| a full copy is created. This means
1887 that the original |List| can be changed without changing the
1888 copy, and vice versa. When an item is a |List| or
1889 |Dictionary|, a copy for it is made, recursively. Thus
1890 changing an item in the copy does not change the contents of
1891 the original |List|.
1892 A |Dictionary| is copied in a similar way as a |List|.
1893
1894 When {noref} is omitted or zero a contained |List| or
1895 |Dictionary| is only copied once. All references point to
1896 this single copy. With {noref} set to 1 every occurrence of a
1897 |List| or |Dictionary| results in a new copy. This also means
1898 that a cyclic reference causes deepcopy() to fail.
1899 *E724*
1900 Nesting is possible up to 100 levels. When there is an item
1901 that refers back to a higher level making a deep copy with
1902 {noref} set to 1 will fail.
1903 Also see |copy()|.
1904
1905 Can also be used as a |method|: >
1906 GetObject()->deepcopy()
1907
1908delete({fname} [, {flags}]) *delete()*
1909 Without {flags} or with {flags} empty: Deletes the file by the
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01001910 name {fname}.
1911
1912 This also works when {fname} is a symbolic link. The symbolic
1913 link itself is deleted, not what it points to.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001914
1915 When {flags} is "d": Deletes the directory by the name
1916 {fname}. This fails when directory {fname} is not empty.
1917
1918 When {flags} is "rf": Deletes the directory by the name
1919 {fname} and everything in it, recursively. BE CAREFUL!
1920 Note: on MS-Windows it is not possible to delete a directory
1921 that is being used.
1922
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00001923 The result is a Number, which is 0/false if the delete
1924 operation was successful and -1/true when the deletion failed
1925 or partly failed.
1926
1927 Use |remove()| to delete an item from a |List|.
1928 To delete a line from the buffer use |:delete| or
1929 |deletebufline()|.
1930
1931 Can also be used as a |method|: >
1932 GetName()->delete()
1933
1934deletebufline({buf}, {first} [, {last}]) *deletebufline()*
1935 Delete lines {first} to {last} (inclusive) from buffer {buf}.
1936 If {last} is omitted then delete line {first} only.
1937 On success 0 is returned, on failure 1 is returned.
1938
1939 This function works only for loaded buffers. First call
1940 |bufload()| if needed.
1941
1942 For the use of {buf}, see |bufname()| above.
1943
1944 {first} and {last} are used like with |getline()|. Note that
1945 when using |line()| this refers to the current buffer. Use "$"
1946 to refer to the last line in buffer {buf}.
1947
1948 Can also be used as a |method|: >
1949 GetBuffer()->deletebufline(1)
1950<
1951 *did_filetype()*
1952did_filetype() Returns |TRUE| when autocommands are being executed and the
1953 FileType event has been triggered at least once. Can be used
1954 to avoid triggering the FileType event again in the scripts
1955 that detect the file type. |FileType|
1956 Returns |FALSE| when `:setf FALLBACK` was used.
1957 When editing another file, the counter is reset, thus this
1958 really checks if the FileType event has been triggered for the
1959 current buffer. This allows an autocommand that starts
1960 editing another buffer to set 'filetype' and load a syntax
1961 file.
1962
1963diff_filler({lnum}) *diff_filler()*
1964 Returns the number of filler lines above line {lnum}.
1965 These are the lines that were inserted at this point in
1966 another diff'ed window. These filler lines are shown in the
1967 display but don't exist in the buffer.
1968 {lnum} is used like with |getline()|. Thus "." is the current
1969 line, "'m" mark m, etc.
1970 Returns 0 if the current window is not in diff mode.
1971
1972 Can also be used as a |method|: >
1973 GetLnum()->diff_filler()
1974
1975diff_hlID({lnum}, {col}) *diff_hlID()*
1976 Returns the highlight ID for diff mode at line {lnum} column
1977 {col} (byte index). When the current line does not have a
1978 diff change zero is returned.
1979 {lnum} is used like with |getline()|. Thus "." is the current
1980 line, "'m" mark m, etc.
1981 {col} is 1 for the leftmost column, {lnum} is 1 for the first
1982 line.
1983 The highlight ID can be used with |synIDattr()| to obtain
1984 syntax information about the highlighting.
1985
1986 Can also be used as a |method|: >
1987 GetLnum()->diff_hlID(col)
1988<
1989
1990digraph_get({chars}) *digraph_get()* *E1214*
1991 Return the digraph of {chars}. This should be a string with
1992 exactly two characters. If {chars} are not just two
1993 characters, or the digraph of {chars} does not exist, an error
1994 is given and an empty string is returned.
1995
1996 The character will be converted from Unicode to 'encoding'
1997 when needed. This does require the conversion to be
1998 available, it might fail.
1999
2000 Also see |digraph_getlist()|.
2001
2002 Examples: >
2003 " Get a built-in digraph
2004 :echo digraph_get('00') " Returns '∞'
2005
2006 " Get a user-defined digraph
2007 :call digraph_set('aa', 'あ')
2008 :echo digraph_get('aa') " Returns 'あ'
2009<
2010 Can also be used as a |method|: >
2011 GetChars()->digraph_get()
2012<
2013 This function works only when compiled with the |+digraphs|
2014 feature. If this feature is disabled, this function will
2015 display an error message.
2016
2017
2018digraph_getlist([{listall}]) *digraph_getlist()*
2019 Return a list of digraphs. If the {listall} argument is given
2020 and it is TRUE, return all digraphs, including the default
2021 digraphs. Otherwise, return only user-defined digraphs.
2022
2023 The characters will be converted from Unicode to 'encoding'
2024 when needed. This does require the conservation to be
2025 available, it might fail.
2026
2027 Also see |digraph_get()|.
2028
2029 Examples: >
2030 " Get user-defined digraphs
2031 :echo digraph_getlist()
2032
2033 " Get all the digraphs, including default digraphs
2034 :echo digraph_getlist(1)
2035<
2036 Can also be used as a |method|: >
2037 GetNumber()->digraph_getlist()
2038<
2039 This function works only when compiled with the |+digraphs|
2040 feature. If this feature is disabled, this function will
2041 display an error message.
2042
2043
Bram Moolenaara2baa732022-02-04 16:09:54 +00002044digraph_set({chars}, {digraph}) *digraph_set()*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002045 Add digraph {chars} to the list. {chars} must be a string
2046 with two characters. {digraph} is a string with one UTF-8
Bram Moolenaara2baa732022-02-04 16:09:54 +00002047 encoded character. *E1215*
2048 Be careful, composing characters are NOT ignored. This
2049 function is similar to |:digraphs| command, but useful to add
2050 digraphs start with a white space.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002051
2052 The function result is v:true if |digraph| is registered. If
2053 this fails an error message is given and v:false is returned.
2054
2055 If you want to define multiple digraphs at once, you can use
2056 |digraph_setlist()|.
2057
2058 Example: >
2059 call digraph_set(' ', 'あ')
2060<
2061 Can be used as a |method|: >
2062 GetString()->digraph_set('あ')
2063<
2064 This function works only when compiled with the |+digraphs|
2065 feature. If this feature is disabled, this function will
2066 display an error message.
2067
2068
2069digraph_setlist({digraphlist}) *digraph_setlist()*
2070 Similar to |digraph_set()| but this function can add multiple
2071 digraphs at once. {digraphlist} is a list composed of lists,
2072 where each list contains two strings with {chars} and
Bram Moolenaara2baa732022-02-04 16:09:54 +00002073 {digraph} as in |digraph_set()|. *E1216*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002074 Example: >
2075 call digraph_setlist([['aa', 'あ'], ['ii', 'い']])
2076<
2077 It is similar to the following: >
2078 for [chars, digraph] in [['aa', 'あ'], ['ii', 'い']]
2079 call digraph_set(chars, digraph)
2080 endfor
2081< Except that the function returns after the first error,
2082 following digraphs will not be added.
2083
2084 Can be used as a |method|: >
2085 GetList()->digraph_setlist()
2086<
2087 This function works only when compiled with the |+digraphs|
2088 feature. If this feature is disabled, this function will
2089 display an error message.
2090
2091
2092echoraw({string}) *echoraw()*
2093 Output {string} as-is, including unprintable characters.
2094 This can be used to output a terminal code. For example, to
2095 disable modifyOtherKeys: >
2096 call echoraw(&t_TE)
2097< and to enable it again: >
2098 call echoraw(&t_TI)
2099< Use with care, you can mess up the terminal this way.
2100
2101
2102empty({expr}) *empty()*
2103 Return the Number 1 if {expr} is empty, zero otherwise.
2104 - A |List| or |Dictionary| is empty when it does not have any
2105 items.
2106 - A |String| is empty when its length is zero.
2107 - A |Number| and |Float| are empty when their value is zero.
2108 - |v:false|, |v:none| and |v:null| are empty, |v:true| is not.
2109 - A |Job| is empty when it failed to start.
2110 - A |Channel| is empty when it is closed.
2111 - A |Blob| is empty when its length is zero.
2112
2113 For a long |List| this is much faster than comparing the
2114 length with zero.
2115
2116 Can also be used as a |method|: >
2117 mylist->empty()
2118
2119environ() *environ()*
2120 Return all of environment variables as dictionary. You can
2121 check if an environment variable exists like this: >
2122 :echo has_key(environ(), 'HOME')
2123< Note that the variable name may be CamelCase; to ignore case
2124 use this: >
2125 :echo index(keys(environ()), 'HOME', 0, 1) != -1
2126
2127escape({string}, {chars}) *escape()*
2128 Escape the characters in {chars} that occur in {string} with a
2129 backslash. Example: >
2130 :echo escape('c:\program files\vim', ' \')
2131< results in: >
2132 c:\\program\ files\\vim
2133< Also see |shellescape()| and |fnameescape()|.
2134
2135 Can also be used as a |method|: >
2136 GetText()->escape(' \')
2137<
2138 *eval()*
2139eval({string}) Evaluate {string} and return the result. Especially useful to
2140 turn the result of |string()| back into the original value.
2141 This works for Numbers, Floats, Strings, Blobs and composites
2142 of them. Also works for |Funcref|s that refer to existing
2143 functions.
2144
2145 Can also be used as a |method|: >
2146 argv->join()->eval()
2147
2148eventhandler() *eventhandler()*
2149 Returns 1 when inside an event handler. That is that Vim got
2150 interrupted while waiting for the user to type a character,
2151 e.g., when dropping a file on Vim. This means interactive
2152 commands cannot be used. Otherwise zero is returned.
2153
2154executable({expr}) *executable()*
2155 This function checks if an executable with the name {expr}
2156 exists. {expr} must be the name of the program without any
2157 arguments.
2158 executable() uses the value of $PATH and/or the normal
2159 searchpath for programs. *PATHEXT*
2160 On MS-Windows the ".exe", ".bat", etc. can optionally be
2161 included. Then the extensions in $PATHEXT are tried. Thus if
2162 "foo.exe" does not exist, "foo.exe.bat" can be found. If
2163 $PATHEXT is not set then ".com;.exe;.bat;.cmd" is used. A dot
2164 by itself can be used in $PATHEXT to try using the name
2165 without an extension. When 'shell' looks like a Unix shell,
2166 then the name is also tried without adding an extension.
2167 On MS-Windows it only checks if the file exists and is not a
2168 directory, not if it's really executable.
2169 On MS-Windows an executable in the same directory as Vim is
Yasuhiro Matsumoto05cf63e2022-05-03 11:02:28 +01002170 normally found. Since this directory is added to $PATH it
2171 should also work to execute it |win32-PATH|. This can be
2172 disabled by setting the $NoDefaultCurrentDirectoryInExePath
2173 environment variable. *NoDefaultCurrentDirectoryInExePath*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002174 The result is a Number:
2175 1 exists
2176 0 does not exist
2177 -1 not implemented on this system
2178 |exepath()| can be used to get the full path of an executable.
2179
2180 Can also be used as a |method|: >
2181 GetCommand()->executable()
2182
2183execute({command} [, {silent}]) *execute()*
2184 Execute an Ex command or commands and return the output as a
2185 string.
2186 {command} can be a string or a List. In case of a List the
2187 lines are executed one by one.
2188 This is equivalent to: >
2189 redir => var
2190 {command}
2191 redir END
2192<
2193 The optional {silent} argument can have these values:
2194 "" no `:silent` used
2195 "silent" `:silent` used
2196 "silent!" `:silent!` used
2197 The default is "silent". Note that with "silent!", unlike
2198 `:redir`, error messages are dropped. When using an external
2199 command the screen may be messed up, use `system()` instead.
2200 *E930*
2201 It is not possible to use `:redir` anywhere in {command}.
2202
2203 To get a list of lines use |split()| on the result: >
Bram Moolenaar75ab5902022-04-18 15:36:40 +01002204 execute('args')->split("\n")
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002205
2206< To execute a command in another window than the current one
2207 use `win_execute()`.
2208
2209 When used recursively the output of the recursive call is not
2210 included in the output of the higher level call.
2211
2212 Can also be used as a |method|: >
2213 GetCommand()->execute()
2214
2215exepath({expr}) *exepath()*
2216 If {expr} is an executable and is either an absolute path, a
2217 relative path or found in $PATH, return the full path.
2218 Note that the current directory is used when {expr} starts
2219 with "./", which may be a problem for Vim: >
2220 echo exepath(v:progpath)
2221< If {expr} cannot be found in $PATH or is not executable then
2222 an empty string is returned.
2223
2224 Can also be used as a |method|: >
2225 GetCommand()->exepath()
2226<
2227 *exists()*
2228exists({expr}) The result is a Number, which is |TRUE| if {expr} is defined,
2229 zero otherwise.
2230
2231 Note: In a compiled |:def| function the evaluation is done at
2232 runtime. Use `exists_compiled()` to evaluate the expression
2233 at compile time.
2234
2235 For checking for a supported feature use |has()|.
2236 For checking if a file exists use |filereadable()|.
2237
2238 The {expr} argument is a string, which contains one of these:
Bram Moolenaarf10911e2022-01-29 22:20:48 +00002239 varname internal variable (see
2240 dict.key |internal-variables|). Also works
2241 list[i] for |curly-braces-names|, |Dictionary|
2242 import.Func entries, |List| items, imported
Bram Moolenaar944697a2022-02-20 19:48:20 +00002243 items, etc.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00002244 Does not work for local variables in a
2245 compiled `:def` function.
Bram Moolenaar944697a2022-02-20 19:48:20 +00002246 Also works for a function in |Vim9|
2247 script, since it can be used as a
2248 function reference.
Bram Moolenaarf10911e2022-01-29 22:20:48 +00002249 Beware that evaluating an index may
2250 cause an error message for an invalid
2251 expression. E.g.: >
2252 :let l = [1, 2, 3]
2253 :echo exists("l[5]")
2254< 0 >
2255 :echo exists("l[xx]")
2256< E121: Undefined variable: xx
2257 0
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002258 &option-name Vim option (only checks if it exists,
2259 not if it really works)
2260 +option-name Vim option that works.
2261 $ENVNAME environment variable (could also be
2262 done by comparing with an empty
2263 string)
2264 *funcname built-in function (see |functions|)
2265 or user defined function (see
2266 |user-functions|) that is implemented.
2267 Also works for a variable that is a
2268 Funcref.
2269 ?funcname built-in function that could be
2270 implemented; to be used to check if
2271 "funcname" is valid
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002272 :cmdname Ex command: built-in command, user
2273 command or command modifier |:command|.
2274 Returns:
2275 1 for match with start of a command
2276 2 full match with a command
2277 3 matches several user commands
2278 To check for a supported command
2279 always check the return value to be 2.
2280 :2match The |:2match| command.
2281 :3match The |:3match| command.
2282 #event autocommand defined for this event
2283 #event#pattern autocommand defined for this event and
2284 pattern (the pattern is taken
2285 literally and compared to the
2286 autocommand patterns character by
2287 character)
2288 #group autocommand group exists
2289 #group#event autocommand defined for this group and
2290 event.
2291 #group#event#pattern
2292 autocommand defined for this group,
2293 event and pattern.
2294 ##event autocommand for this event is
2295 supported.
2296
2297 Examples: >
2298 exists("&shortname")
2299 exists("$HOSTNAME")
2300 exists("*strftime")
Bram Moolenaar944697a2022-02-20 19:48:20 +00002301 exists("*s:MyFunc") " only for legacy script
2302 exists("*MyFunc")
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002303 exists("bufcount")
2304 exists(":Make")
2305 exists("#CursorHold")
2306 exists("#BufReadPre#*.gz")
2307 exists("#filetypeindent")
2308 exists("#filetypeindent#FileType")
2309 exists("#filetypeindent#FileType#*")
2310 exists("##ColorScheme")
2311< There must be no space between the symbol (&/$/*/#) and the
2312 name.
2313 There must be no extra characters after the name, although in
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01002314 a few cases this is ignored. That may become stricter in the
2315 future, thus don't count on it!
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002316 Working example: >
2317 exists(":make")
2318< NOT working example: >
2319 exists(":make install")
2320
2321< Note that the argument must be a string, not the name of the
2322 variable itself. For example: >
2323 exists(bufcount)
2324< This doesn't check for existence of the "bufcount" variable,
2325 but gets the value of "bufcount", and checks if that exists.
2326
2327 Can also be used as a |method|: >
2328 Varname()->exists()
2329<
2330
2331exists_compiled({expr}) *exists_compiled()*
2332 Like `exists()` but evaluated at compile time. This is useful
2333 to skip a block where a function is used that would otherwise
2334 give an error: >
2335 if exists_compiled('*ThatFunction')
2336 ThatFunction('works')
2337 endif
2338< If `exists()` were used then a compilation error would be
2339 given if ThatFunction() is not defined.
2340
2341 {expr} must be a literal string. *E1232*
2342 Can only be used in a |:def| function. *E1233*
2343 This does not work to check for arguments or local variables.
2344
2345
2346exp({expr}) *exp()*
2347 Return the exponential of {expr} as a |Float| in the range
2348 [0, inf].
2349 {expr} must evaluate to a |Float| or a |Number|.
2350 Examples: >
2351 :echo exp(2)
2352< 7.389056 >
2353 :echo exp(-1)
2354< 0.367879
2355
2356 Can also be used as a |method|: >
2357 Compute()->exp()
2358<
2359 {only available when compiled with the |+float| feature}
2360
2361
2362expand({string} [, {nosuf} [, {list}]]) *expand()*
2363 Expand wildcards and the following special keywords in
2364 {string}. 'wildignorecase' applies.
2365
2366 If {list} is given and it is |TRUE|, a List will be returned.
2367 Otherwise the result is a String and when there are several
2368 matches, they are separated by <NL> characters. [Note: in
2369 version 5.0 a space was used, which caused problems when a
2370 file name contains a space]
2371
2372 If the expansion fails, the result is an empty string. A name
2373 for a non-existing file is not included, unless {string} does
2374 not start with '%', '#' or '<', see below.
2375
2376 When {string} starts with '%', '#' or '<', the expansion is
2377 done like for the |cmdline-special| variables with their
2378 associated modifiers. Here is a short overview:
2379
2380 % current file name
2381 # alternate file name
2382 #n alternate file name n
2383 <cfile> file name under the cursor
2384 <afile> autocmd file name
2385 <abuf> autocmd buffer number (as a String!)
2386 <amatch> autocmd matched name
2387 <cexpr> C expression under the cursor
2388 <sfile> sourced script file or function name
2389 <slnum> sourced script line number or function
2390 line number
2391 <sflnum> script file line number, also when in
2392 a function
2393 <SID> "<SNR>123_" where "123" is the
2394 current script ID |<SID>|
Bram Moolenaar75ab5902022-04-18 15:36:40 +01002395 <script> sourced script file, or script file
2396 where the current function was defined
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002397 <stack> call stack
2398 <cword> word under the cursor
2399 <cWORD> WORD under the cursor
2400 <client> the {clientid} of the last received
2401 message |server2client()|
2402 Modifiers:
2403 :p expand to full path
2404 :h head (last path component removed)
2405 :t tail (last path component only)
2406 :r root (one extension removed)
2407 :e extension only
2408
2409 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00002410 :let &tags = expand("%:p:h") .. "/tags"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002411< Note that when expanding a string that starts with '%', '#' or
2412 '<', any following text is ignored. This does NOT work: >
2413 :let doesntwork = expand("%:h.bak")
2414< Use this: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00002415 :let doeswork = expand("%:h") .. ".bak"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002416< Also note that expanding "<cfile>" and others only returns the
2417 referenced file name without further expansion. If "<cfile>"
2418 is "~/.cshrc", you need to do another expand() to have the
2419 "~/" expanded into the path of the home directory: >
2420 :echo expand(expand("<cfile>"))
2421<
2422 There cannot be white space between the variables and the
2423 following modifier. The |fnamemodify()| function can be used
2424 to modify normal file names.
2425
2426 When using '%' or '#', and the current or alternate file name
2427 is not defined, an empty string is used. Using "%:p" in a
2428 buffer with no name, results in the current directory, with a
2429 '/' added.
Bram Moolenaar57544522022-04-12 12:54:11 +01002430 When 'verbose' is set then expanding '%', '#' and <> items
2431 will result in an error message if the argument cannot be
2432 expanded.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002433
2434 When {string} does not start with '%', '#' or '<', it is
2435 expanded like a file name is expanded on the command line.
2436 'suffixes' and 'wildignore' are used, unless the optional
2437 {nosuf} argument is given and it is |TRUE|.
2438 Names for non-existing files are included. The "**" item can
2439 be used to search in a directory tree. For example, to find
2440 all "README" files in the current directory and below: >
2441 :echo expand("**/README")
2442<
2443 expand() can also be used to expand variables and environment
2444 variables that are only known in a shell. But this can be
2445 slow, because a shell may be used to do the expansion. See
2446 |expr-env-expand|.
2447 The expanded variable is still handled like a list of file
2448 names. When an environment variable cannot be expanded, it is
2449 left unchanged. Thus ":echo expand('$FOOBAR')" results in
2450 "$FOOBAR".
2451
2452 See |glob()| for finding existing files. See |system()| for
2453 getting the raw output of an external command.
2454
2455 Can also be used as a |method|: >
2456 Getpattern()->expand()
2457
Yegappan Lakshmanan2b74b682022-04-03 21:30:32 +01002458expandcmd({string} [, {options}]) *expandcmd()*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002459 Expand special items in String {string} like what is done for
2460 an Ex command such as `:edit`. This expands special keywords,
2461 like with |expand()|, and environment variables, anywhere in
2462 {string}. "~user" and "~/path" are only expanded at the
2463 start.
Yegappan Lakshmanan2b74b682022-04-03 21:30:32 +01002464
2465 The following items are supported in the {options} Dict
2466 argument:
2467 errmsg If set to TRUE, error messages are displayed
2468 if an error is encountered during expansion.
2469 By default, error messages are not displayed.
2470
Yegappan Lakshmanan5018a832022-04-02 21:12:21 +01002471 Returns the expanded string. If an error is encountered
2472 during expansion, the unmodified {string} is returned.
Yegappan Lakshmanan2b74b682022-04-03 21:30:32 +01002473
Yegappan Lakshmanan5018a832022-04-02 21:12:21 +01002474 Example: >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002475 :echo expandcmd('make %<.o')
Yegappan Lakshmanan2b74b682022-04-03 21:30:32 +01002476 make /path/runtime/doc/builtin.o
2477 :echo expandcmd('make %<.o', {'errmsg': v:true})
2478<
Yegappan Lakshmanan5018a832022-04-02 21:12:21 +01002479 Can also be used as a |method|: >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002480 GetCommand()->expandcmd()
2481<
2482extend({expr1}, {expr2} [, {expr3}]) *extend()*
2483 {expr1} and {expr2} must be both |Lists| or both
2484 |Dictionaries|.
2485
2486 If they are |Lists|: Append {expr2} to {expr1}.
2487 If {expr3} is given insert the items of {expr2} before the
2488 item with index {expr3} in {expr1}. When {expr3} is zero
2489 insert before the first item. When {expr3} is equal to
2490 len({expr1}) then {expr2} is appended.
2491 Examples: >
2492 :echo sort(extend(mylist, [7, 5]))
2493 :call extend(mylist, [2, 3], 1)
2494< When {expr1} is the same List as {expr2} then the number of
2495 items copied is equal to the original length of the List.
2496 E.g., when {expr3} is 1 you get N new copies of the first item
2497 (where N is the original length of the List).
2498 Use |add()| to concatenate one item to a list. To concatenate
2499 two lists into a new list use the + operator: >
2500 :let newlist = [1, 2, 3] + [4, 5]
2501<
2502 If they are |Dictionaries|:
2503 Add all entries from {expr2} to {expr1}.
2504 If a key exists in both {expr1} and {expr2} then {expr3} is
2505 used to decide what to do:
2506 {expr3} = "keep": keep the value of {expr1}
2507 {expr3} = "force": use the value of {expr2}
2508 {expr3} = "error": give an error message *E737*
2509 When {expr3} is omitted then "force" is assumed.
2510
2511 {expr1} is changed when {expr2} is not empty. If necessary
2512 make a copy of {expr1} first.
2513 {expr2} remains unchanged.
2514 When {expr1} is locked and {expr2} is not empty the operation
2515 fails.
2516 Returns {expr1}.
2517
2518 Can also be used as a |method|: >
2519 mylist->extend(otherlist)
2520
2521
2522extendnew({expr1}, {expr2} [, {expr3}]) *extendnew()*
2523 Like |extend()| but instead of adding items to {expr1} a new
2524 List or Dictionary is created and returned. {expr1} remains
2525 unchanged. Items can still be changed by {expr2}, if you
2526 don't want that use |deepcopy()| first.
2527
2528
2529feedkeys({string} [, {mode}]) *feedkeys()*
2530 Characters in {string} are queued for processing as if they
2531 come from a mapping or were typed by the user.
2532
2533 By default the string is added to the end of the typeahead
2534 buffer, thus if a mapping is still being executed the
2535 characters come after them. Use the 'i' flag to insert before
2536 other characters, they will be executed next, before any
2537 characters from a mapping.
2538
2539 The function does not wait for processing of keys contained in
2540 {string}.
2541
2542 To include special keys into {string}, use double-quotes
2543 and "\..." notation |expr-quote|. For example,
2544 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
2545 feedkeys('\<CR>') pushes 5 characters.
2546 A special code that might be useful is <Ignore>, it exits the
2547 wait for a character without doing anything. *<Ignore>*
2548
2549 {mode} is a String, which can contain these character flags:
2550 'm' Remap keys. This is default. If {mode} is absent,
2551 keys are remapped.
2552 'n' Do not remap keys.
2553 't' Handle keys as if typed; otherwise they are handled as
2554 if coming from a mapping. This matters for undo,
2555 opening folds, etc.
2556 'L' Lowlevel input. Only works for Unix or when using the
2557 GUI. Keys are used as if they were coming from the
2558 terminal. Other flags are not used. *E980*
2559 When a CTRL-C interrupts and 't' is included it sets
2560 the internal "got_int" flag.
2561 'i' Insert the string instead of appending (see above).
2562 'x' Execute commands until typeahead is empty. This is
2563 similar to using ":normal!". You can call feedkeys()
2564 several times without 'x' and then one time with 'x'
2565 (possibly with an empty {string}) to execute all the
2566 typeahead. Note that when Vim ends in Insert mode it
2567 will behave as if <Esc> is typed, to avoid getting
2568 stuck, waiting for a character to be typed before the
2569 script continues.
2570 Note that if you manage to call feedkeys() while
2571 executing commands, thus calling it recursively, then
2572 all typeahead will be consumed by the last call.
Bram Moolenaara9725222022-01-16 13:30:33 +00002573 'c' Remove any script context when executing, so that
2574 legacy script syntax applies, "s:var" does not work,
Bram Moolenaard899e512022-05-07 21:54:03 +01002575 etc. Note that if the string being fed sets a script
Bram Moolenaarce001a32022-04-27 15:25:03 +01002576 context this still applies.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002577 '!' When used with 'x' will not end Insert mode. Can be
2578 used in a test when a timer is set to exit Insert mode
2579 a little later. Useful for testing CursorHoldI.
2580
2581 Return value is always 0.
2582
2583 Can also be used as a |method|: >
2584 GetInput()->feedkeys()
2585
2586filereadable({file}) *filereadable()*
2587 The result is a Number, which is |TRUE| when a file with the
2588 name {file} exists, and can be read. If {file} doesn't exist,
2589 or is a directory, the result is |FALSE|. {file} is any
2590 expression, which is used as a String.
2591 If you don't care about the file being readable you can use
2592 |glob()|.
2593 {file} is used as-is, you may want to expand wildcards first: >
2594 echo filereadable('~/.vimrc')
2595 0
2596 echo filereadable(expand('~/.vimrc'))
2597 1
2598
2599< Can also be used as a |method|: >
2600 GetName()->filereadable()
2601< *file_readable()*
2602 Obsolete name: file_readable().
2603
2604
2605filewritable({file}) *filewritable()*
2606 The result is a Number, which is 1 when a file with the
2607 name {file} exists, and can be written. If {file} doesn't
2608 exist, or is not writable, the result is 0. If {file} is a
2609 directory, and we can write to it, the result is 2.
2610
2611 Can also be used as a |method|: >
2612 GetName()->filewritable()
2613
2614
2615filter({expr1}, {expr2}) *filter()*
2616 {expr1} must be a |List|, |String|, |Blob| or |Dictionary|.
2617 For each item in {expr1} evaluate {expr2} and when the result
2618 is zero or false remove the item from the |List| or
2619 |Dictionary|. Similarly for each byte in a |Blob| and each
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00002620 character in a |String|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002621
2622 {expr2} must be a |string| or |Funcref|.
2623
2624 If {expr2} is a |string|, inside {expr2} |v:val| has the value
2625 of the current item. For a |Dictionary| |v:key| has the key
2626 of the current item and for a |List| |v:key| has the index of
2627 the current item. For a |Blob| |v:key| has the index of the
2628 current byte. For a |String| |v:key| has the index of the
2629 current character.
2630 Examples: >
2631 call filter(mylist, 'v:val !~ "OLD"')
2632< Removes the items where "OLD" appears. >
2633 call filter(mydict, 'v:key >= 8')
2634< Removes the items with a key below 8. >
2635 call filter(var, 0)
2636< Removes all the items, thus clears the |List| or |Dictionary|.
2637
2638 Note that {expr2} is the result of expression and is then
2639 used as an expression again. Often it is good to use a
2640 |literal-string| to avoid having to double backslashes.
2641
2642 If {expr2} is a |Funcref| it must take two arguments:
2643 1. the key or the index of the current item.
2644 2. the value of the current item.
2645 The function must return |TRUE| if the item should be kept.
2646 Example that keeps the odd items of a list: >
2647 func Odd(idx, val)
2648 return a:idx % 2 == 1
2649 endfunc
2650 call filter(mylist, function('Odd'))
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00002651< It is shorter when using a |lambda|. In |Vim9| syntax: >
2652 call filter(myList, (idx, val) => idx * val <= 42)
2653< In legacy script syntax: >
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002654 call filter(myList, {idx, val -> idx * val <= 42})
2655< If you do not use "val" you can leave it out: >
2656 call filter(myList, {idx -> idx % 2 == 1})
2657<
2658 In |Vim9| script the result must be true, false, zero or one.
2659 Other values will result in a type error.
2660
2661 For a |List| and a |Dictionary| the operation is done
2662 in-place. If you want it to remain unmodified make a copy
2663 first: >
2664 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
2665
2666< Returns {expr1}, the |List| or |Dictionary| that was filtered,
naohiro ono56200ee2022-01-01 14:59:44 +00002667 or a new |Blob| or |String|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002668 When an error is encountered while evaluating {expr2} no
2669 further items in {expr1} are processed.
2670 When {expr2} is a Funcref errors inside a function are ignored,
2671 unless it was defined with the "abort" flag.
2672
2673 Can also be used as a |method|: >
2674 mylist->filter(expr2)
2675
2676finddir({name} [, {path} [, {count}]]) *finddir()*
2677 Find directory {name} in {path}. Supports both downwards and
2678 upwards recursive directory searches. See |file-searching|
2679 for the syntax of {path}.
2680
2681 Returns the path of the first found match. When the found
2682 directory is below the current directory a relative path is
2683 returned. Otherwise a full path is returned.
2684 If {path} is omitted or empty then 'path' is used.
2685
2686 If the optional {count} is given, find {count}'s occurrence of
2687 {name} in {path} instead of the first one.
2688 When {count} is negative return all the matches in a |List|.
2689
2690 This is quite similar to the ex-command `:find`.
2691 {only available when compiled with the |+file_in_path|
2692 feature}
2693
2694 Can also be used as a |method|: >
2695 GetName()->finddir()
2696
2697findfile({name} [, {path} [, {count}]]) *findfile()*
2698 Just like |finddir()|, but find a file instead of a directory.
2699 Uses 'suffixesadd'.
2700 Example: >
2701 :echo findfile("tags.vim", ".;")
2702< Searches from the directory of the current file upwards until
2703 it finds the file "tags.vim".
2704
2705 Can also be used as a |method|: >
2706 GetName()->findfile()
2707
2708flatten({list} [, {maxdepth}]) *flatten()*
2709 Flatten {list} up to {maxdepth} levels. Without {maxdepth}
2710 the result is a |List| without nesting, as if {maxdepth} is
2711 a very large number.
2712 The {list} is changed in place, use |flattennew()| if you do
2713 not want that.
2714 In Vim9 script flatten() cannot be used, you must always use
Bram Moolenaara2baa732022-02-04 16:09:54 +00002715 |flattennew()|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002716 *E900*
2717 {maxdepth} means how deep in nested lists changes are made.
2718 {list} is not modified when {maxdepth} is 0.
2719 {maxdepth} must be positive number.
2720
2721 If there is an error the number zero is returned.
2722
2723 Example: >
2724 :echo flatten([1, [2, [3, 4]], 5])
2725< [1, 2, 3, 4, 5] >
2726 :echo flatten([1, [2, [3, 4]], 5], 1)
2727< [1, 2, [3, 4], 5]
2728
2729 Can also be used as a |method|: >
2730 mylist->flatten()
2731<
2732flattennew({list} [, {maxdepth}]) *flattennew()*
2733 Like |flatten()| but first make a copy of {list}.
2734
2735
2736float2nr({expr}) *float2nr()*
2737 Convert {expr} to a Number by omitting the part after the
2738 decimal point.
2739 {expr} must evaluate to a |Float| or a Number.
2740 When the value of {expr} is out of range for a |Number| the
2741 result is truncated to 0x7fffffff or -0x7fffffff (or when
2742 64-bit Number support is enabled, 0x7fffffffffffffff or
2743 -0x7fffffffffffffff). NaN results in -0x80000000 (or when
2744 64-bit Number support is enabled, -0x8000000000000000).
2745 Examples: >
2746 echo float2nr(3.95)
2747< 3 >
2748 echo float2nr(-23.45)
2749< -23 >
2750 echo float2nr(1.0e100)
2751< 2147483647 (or 9223372036854775807) >
2752 echo float2nr(-1.0e150)
2753< -2147483647 (or -9223372036854775807) >
2754 echo float2nr(1.0e-100)
2755< 0
2756
2757 Can also be used as a |method|: >
2758 Compute()->float2nr()
2759<
2760 {only available when compiled with the |+float| feature}
2761
2762
2763floor({expr}) *floor()*
2764 Return the largest integral value less than or equal to
2765 {expr} as a |Float| (round down).
2766 {expr} must evaluate to a |Float| or a |Number|.
2767 Examples: >
2768 echo floor(1.856)
2769< 1.0 >
2770 echo floor(-5.456)
2771< -6.0 >
2772 echo floor(4.0)
2773< 4.0
2774
2775 Can also be used as a |method|: >
2776 Compute()->floor()
2777<
2778 {only available when compiled with the |+float| feature}
2779
2780
2781fmod({expr1}, {expr2}) *fmod()*
2782 Return the remainder of {expr1} / {expr2}, even if the
2783 division is not representable. Returns {expr1} - i * {expr2}
2784 for some integer i such that if {expr2} is non-zero, the
2785 result has the same sign as {expr1} and magnitude less than
2786 the magnitude of {expr2}. If {expr2} is zero, the value
2787 returned is zero. The value returned is a |Float|.
2788 {expr1} and {expr2} must evaluate to a |Float| or a |Number|.
2789 Examples: >
2790 :echo fmod(12.33, 1.22)
2791< 0.13 >
2792 :echo fmod(-12.33, 1.22)
2793< -0.13
2794
2795 Can also be used as a |method|: >
2796 Compute()->fmod(1.22)
2797<
2798 {only available when compiled with |+float| feature}
2799
2800
2801fnameescape({string}) *fnameescape()*
2802 Escape {string} for use as file name command argument. All
2803 characters that have a special meaning, such as '%' and '|'
2804 are escaped with a backslash.
2805 For most systems the characters escaped are
2806 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash
2807 appears in a filename, it depends on the value of 'isfname'.
2808 A leading '+' and '>' is also escaped (special after |:edit|
2809 and |:write|). And a "-" by itself (special after |:cd|).
2810 Example: >
2811 :let fname = '+some str%nge|name'
Bram Moolenaarc51cf032022-02-26 12:25:45 +00002812 :exe "edit " .. fnameescape(fname)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002813< results in executing: >
2814 edit \+some\ str\%nge\|name
2815<
2816 Can also be used as a |method|: >
2817 GetName()->fnameescape()
2818
2819fnamemodify({fname}, {mods}) *fnamemodify()*
2820 Modify file name {fname} according to {mods}. {mods} is a
2821 string of characters like it is used for file names on the
2822 command line. See |filename-modifiers|.
2823 Example: >
2824 :echo fnamemodify("main.c", ":p:h")
2825< results in: >
2826 /home/mool/vim/vim/src
2827< If {mods} is empty then {fname} is returned.
2828 Note: Environment variables don't work in {fname}, use
2829 |expand()| first then.
2830
2831 Can also be used as a |method|: >
2832 GetName()->fnamemodify(':p:h')
2833
2834foldclosed({lnum}) *foldclosed()*
2835 The result is a Number. If the line {lnum} is in a closed
2836 fold, the result is the number of the first line in that fold.
2837 If the line {lnum} is not in a closed fold, -1 is returned.
2838 {lnum} is used like with |getline()|. Thus "." is the current
2839 line, "'m" mark m, etc.
2840
2841 Can also be used as a |method|: >
2842 GetLnum()->foldclosed()
2843
2844foldclosedend({lnum}) *foldclosedend()*
2845 The result is a Number. If the line {lnum} is in a closed
2846 fold, the result is the number of the last line in that fold.
2847 If the line {lnum} is not in a closed fold, -1 is returned.
2848 {lnum} is used like with |getline()|. Thus "." is the current
2849 line, "'m" mark m, etc.
2850
2851 Can also be used as a |method|: >
2852 GetLnum()->foldclosedend()
2853
2854foldlevel({lnum}) *foldlevel()*
2855 The result is a Number, which is the foldlevel of line {lnum}
2856 in the current buffer. For nested folds the deepest level is
2857 returned. If there is no fold at line {lnum}, zero is
2858 returned. It doesn't matter if the folds are open or closed.
2859 When used while updating folds (from 'foldexpr') -1 is
2860 returned for lines where folds are still to be updated and the
2861 foldlevel is unknown. As a special case the level of the
2862 previous line is usually available.
2863 {lnum} is used like with |getline()|. Thus "." is the current
2864 line, "'m" mark m, etc.
2865
2866 Can also be used as a |method|: >
2867 GetLnum()->foldlevel()
2868<
2869 *foldtext()*
2870foldtext() Returns a String, to be displayed for a closed fold. This is
2871 the default function used for the 'foldtext' option and should
2872 only be called from evaluating 'foldtext'. It uses the
2873 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
2874 The returned string looks like this: >
2875 +-- 45 lines: abcdef
2876< The number of leading dashes depends on the foldlevel. The
2877 "45" is the number of lines in the fold. "abcdef" is the text
2878 in the first non-blank line of the fold. Leading white space,
2879 "//" or "/*" and the text from the 'foldmarker' and
2880 'commentstring' options is removed.
2881 When used to draw the actual foldtext, the rest of the line
2882 will be filled with the fold char from the 'fillchars'
2883 setting.
2884 {not available when compiled without the |+folding| feature}
2885
2886foldtextresult({lnum}) *foldtextresult()*
2887 Returns the text that is displayed for the closed fold at line
2888 {lnum}. Evaluates 'foldtext' in the appropriate context.
2889 When there is no closed fold at {lnum} an empty string is
2890 returned.
2891 {lnum} is used like with |getline()|. Thus "." is the current
2892 line, "'m" mark m, etc.
2893 Useful when exporting folded text, e.g., to HTML.
2894 {not available when compiled without the |+folding| feature}
2895
2896
2897 Can also be used as a |method|: >
2898 GetLnum()->foldtextresult()
2899<
2900 *foreground()*
2901foreground() Move the Vim window to the foreground. Useful when sent from
2902 a client to a Vim server. |remote_send()|
2903 On Win32 systems this might not work, the OS does not always
2904 allow a window to bring itself to the foreground. Use
2905 |remote_foreground()| instead.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01002906 {only in the Win32, Motif and GTK GUI versions and the
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002907 Win32 console version}
2908
2909fullcommand({name}) *fullcommand()*
2910 Get the full command name from a short abbreviated command
2911 name; see |20.2| for details on command abbreviations.
2912
2913 The string argument {name} may start with a `:` and can
2914 include a [range], these are skipped and not returned.
2915 Returns an empty string if a command doesn't exist or if it's
2916 ambiguous (for user-defined commands).
2917
2918 For example `fullcommand('s')`, `fullcommand('sub')`,
2919 `fullcommand(':%substitute')` all return "substitute".
2920
2921 Can also be used as a |method|: >
2922 GetName()->fullcommand()
2923<
2924 *funcref()*
2925funcref({name} [, {arglist}] [, {dict}])
2926 Just like |function()|, but the returned Funcref will lookup
2927 the function by reference, not by name. This matters when the
2928 function {name} is redefined later.
2929
2930 Unlike |function()|, {name} must be an existing user function.
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00002931 It only works for an autoloaded function if it has already
2932 been loaded (to avoid mistakenly loading the autoload script
2933 when only intending to use the function name, use |function()|
2934 instead). {name} cannot be a builtin function.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002935
2936 Can also be used as a |method|: >
2937 GetFuncname()->funcref([arg])
2938<
2939 *function()* *partial* *E700* *E922* *E923*
2940function({name} [, {arglist}] [, {dict}])
2941 Return a |Funcref| variable that refers to function {name}.
2942 {name} can be the name of a user defined function or an
2943 internal function.
2944
2945 {name} can also be a Funcref or a partial. When it is a
2946 partial the dict stored in it will be used and the {dict}
2947 argument is not allowed. E.g.: >
2948 let FuncWithArg = function(dict.Func, [arg])
2949 let Broken = function(dict.Func, [arg], dict)
2950<
2951 When using the Funcref the function will be found by {name},
2952 also when it was redefined later. Use |funcref()| to keep the
2953 same function.
2954
2955 When {arglist} or {dict} is present this creates a partial.
2956 That means the argument list and/or the dictionary is stored in
2957 the Funcref and will be used when the Funcref is called.
2958
2959 The arguments are passed to the function in front of other
2960 arguments, but after any argument from |method|. Example: >
2961 func Callback(arg1, arg2, name)
2962 ...
2963 let Partial = function('Callback', ['one', 'two'])
2964 ...
2965 call Partial('name')
2966< Invokes the function as with: >
2967 call Callback('one', 'two', 'name')
2968
2969< With a |method|: >
2970 func Callback(one, two, three)
2971 ...
2972 let Partial = function('Callback', ['two'])
2973 ...
2974 eval 'one'->Partial('three')
2975< Invokes the function as with: >
2976 call Callback('one', 'two', 'three')
2977
2978< The function() call can be nested to add more arguments to the
2979 Funcref. The extra arguments are appended to the list of
2980 arguments. Example: >
2981 func Callback(arg1, arg2, name)
2982 ...
2983 let Func = function('Callback', ['one'])
2984 let Func2 = function(Func, ['two'])
2985 ...
2986 call Func2('name')
2987< Invokes the function as with: >
2988 call Callback('one', 'two', 'name')
2989
2990< The Dictionary is only useful when calling a "dict" function.
2991 In that case the {dict} is passed in as "self". Example: >
2992 function Callback() dict
Bram Moolenaarc51cf032022-02-26 12:25:45 +00002993 echo "called for " .. self.name
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00002994 endfunction
2995 ...
2996 let context = {"name": "example"}
2997 let Func = function('Callback', context)
2998 ...
2999 call Func() " will echo: called for example
3000< The use of function() is not needed when there are no extra
3001 arguments, these two are equivalent: >
3002 let Func = function('Callback', context)
3003 let Func = context.Callback
3004
3005< The argument list and the Dictionary can be combined: >
3006 function Callback(arg1, count) dict
3007 ...
3008 let context = {"name": "example"}
3009 let Func = function('Callback', ['one'], context)
3010 ...
3011 call Func(500)
3012< Invokes the function as with: >
3013 call context.Callback('one', 500)
3014<
3015 Can also be used as a |method|: >
3016 GetFuncname()->function([arg])
3017
3018
3019garbagecollect([{atexit}]) *garbagecollect()*
3020 Cleanup unused |Lists|, |Dictionaries|, |Channels| and |Jobs|
3021 that have circular references.
3022
3023 There is hardly ever a need to invoke this function, as it is
3024 automatically done when Vim runs out of memory or is waiting
3025 for the user to press a key after 'updatetime'. Items without
3026 circular references are always freed when they become unused.
3027 This is useful if you have deleted a very big |List| and/or
3028 |Dictionary| with circular references in a script that runs
3029 for a long time.
3030
3031 When the optional {atexit} argument is one, garbage
3032 collection will also be done when exiting Vim, if it wasn't
3033 done before. This is useful when checking for memory leaks.
3034
3035 The garbage collection is not done immediately but only when
3036 it's safe to perform. This is when waiting for the user to
3037 type a character. To force garbage collection immediately use
3038 |test_garbagecollect_now()|.
3039
3040get({list}, {idx} [, {default}]) *get()*
3041 Get item {idx} from |List| {list}. When this item is not
3042 available return {default}. Return zero when {default} is
3043 omitted.
3044 Preferably used as a |method|: >
3045 mylist->get(idx)
3046get({blob}, {idx} [, {default}])
3047 Get byte {idx} from |Blob| {blob}. When this byte is not
3048 available return {default}. Return -1 when {default} is
3049 omitted.
3050 Preferably used as a |method|: >
3051 myblob->get(idx)
3052get({dict}, {key} [, {default}])
3053 Get item with key {key} from |Dictionary| {dict}. When this
3054 item is not available return {default}. Return zero when
3055 {default} is omitted. Useful example: >
3056 let val = get(g:, 'var_name', 'default')
3057< This gets the value of g:var_name if it exists, and uses
3058 'default' when it does not exist.
3059 Preferably used as a |method|: >
3060 mydict->get(key)
3061get({func}, {what})
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00003062 Get item {what} from Funcref {func}. Possible values for
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003063 {what} are:
3064 "name" The function name
3065 "func" The function
3066 "dict" The dictionary
3067 "args" The list with arguments
3068 Preferably used as a |method|: >
3069 myfunc->get(what)
3070<
3071 *getbufinfo()*
3072getbufinfo([{buf}])
3073getbufinfo([{dict}])
3074 Get information about buffers as a List of Dictionaries.
3075
3076 Without an argument information about all the buffers is
3077 returned.
3078
3079 When the argument is a |Dictionary| only the buffers matching
3080 the specified criteria are returned. The following keys can
3081 be specified in {dict}:
3082 buflisted include only listed buffers.
3083 bufloaded include only loaded buffers.
3084 bufmodified include only modified buffers.
3085
3086 Otherwise, {buf} specifies a particular buffer to return
3087 information for. For the use of {buf}, see |bufname()|
3088 above. If the buffer is found the returned List has one item.
3089 Otherwise the result is an empty list.
3090
3091 Each returned List item is a dictionary with the following
3092 entries:
3093 bufnr Buffer number.
3094 changed TRUE if the buffer is modified.
3095 changedtick Number of changes made to the buffer.
3096 hidden TRUE if the buffer is hidden.
3097 lastused Timestamp in seconds, like
3098 |localtime()|, when the buffer was
3099 last used.
3100 {only with the |+viminfo| feature}
3101 listed TRUE if the buffer is listed.
3102 lnum Line number used for the buffer when
3103 opened in the current window.
3104 Only valid if the buffer has been
3105 displayed in the window in the past.
3106 If you want the line number of the
3107 last known cursor position in a given
3108 window, use |line()|: >
3109 :echo line('.', {winid})
3110<
3111 linecount Number of lines in the buffer (only
3112 valid when loaded)
3113 loaded TRUE if the buffer is loaded.
3114 name Full path to the file in the buffer.
3115 signs List of signs placed in the buffer.
3116 Each list item is a dictionary with
3117 the following fields:
3118 id sign identifier
3119 lnum line number
3120 name sign name
3121 variables A reference to the dictionary with
3122 buffer-local variables.
3123 windows List of |window-ID|s that display this
3124 buffer
3125 popups List of popup |window-ID|s that
3126 display this buffer
3127
3128 Examples: >
3129 for buf in getbufinfo()
3130 echo buf.name
3131 endfor
3132 for buf in getbufinfo({'buflisted':1})
3133 if buf.changed
3134 ....
3135 endif
3136 endfor
3137<
3138 To get buffer-local options use: >
3139 getbufvar({bufnr}, '&option_name')
3140<
3141 Can also be used as a |method|: >
3142 GetBufnr()->getbufinfo()
3143<
3144
3145 *getbufline()*
3146getbufline({buf}, {lnum} [, {end}])
3147 Return a |List| with the lines starting from {lnum} to {end}
3148 (inclusive) in the buffer {buf}. If {end} is omitted, a
3149 |List| with only the line {lnum} is returned.
3150
3151 For the use of {buf}, see |bufname()| above.
3152
3153 For {lnum} and {end} "$" can be used for the last line of the
3154 buffer. Otherwise a number must be used.
3155
3156 When {lnum} is smaller than 1 or bigger than the number of
3157 lines in the buffer, an empty |List| is returned.
3158
3159 When {end} is greater than the number of lines in the buffer,
3160 it is treated as {end} is set to the number of lines in the
3161 buffer. When {end} is before {lnum} an empty |List| is
3162 returned.
3163
3164 This function works only for loaded buffers. For unloaded and
3165 non-existing buffers, an empty |List| is returned.
3166
3167 Example: >
3168 :let lines = getbufline(bufnr("myfile"), 1, "$")
3169
3170< Can also be used as a |method|: >
3171 GetBufnr()->getbufline(lnum)
3172
3173getbufvar({buf}, {varname} [, {def}]) *getbufvar()*
3174 The result is the value of option or local buffer variable
3175 {varname} in buffer {buf}. Note that the name without "b:"
3176 must be used.
3177 The {varname} argument is a string.
3178 When {varname} is empty returns a |Dictionary| with all the
3179 buffer-local variables.
3180 When {varname} is equal to "&" returns a |Dictionary| with all
3181 the buffer-local options.
3182 Otherwise, when {varname} starts with "&" returns the value of
3183 a buffer-local option.
3184 This also works for a global or buffer-local option, but it
3185 doesn't work for a global variable, window-local variable or
3186 window-local option.
3187 For the use of {buf}, see |bufname()| above.
3188 When the buffer or variable doesn't exist {def} or an empty
3189 string is returned, there is no error message.
3190 Examples: >
3191 :let bufmodified = getbufvar(1, "&mod")
Bram Moolenaarc51cf032022-02-26 12:25:45 +00003192 :echo "todo myvar = " .. getbufvar("todo", "myvar")
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003193
3194< Can also be used as a |method|: >
3195 GetBufnr()->getbufvar(varname)
3196<
3197getchangelist([{buf}]) *getchangelist()*
3198 Returns the |changelist| for the buffer {buf}. For the use
3199 of {buf}, see |bufname()| above. If buffer {buf} doesn't
3200 exist, an empty list is returned.
3201
3202 The returned list contains two entries: a list with the change
3203 locations and the current position in the list. Each
3204 entry in the change list is a dictionary with the following
3205 entries:
3206 col column number
3207 coladd column offset for 'virtualedit'
3208 lnum line number
3209 If buffer {buf} is the current buffer, then the current
3210 position refers to the position in the list. For other
3211 buffers, it is set to the length of the list.
3212
3213 Can also be used as a |method|: >
3214 GetBufnr()->getchangelist()
3215
3216getchar([expr]) *getchar()*
3217 Get a single character from the user or input stream.
3218 If [expr] is omitted, wait until a character is available.
3219 If [expr] is 0, only get a character when one is available.
3220 Return zero otherwise.
3221 If [expr] is 1, only check if a character is available, it is
3222 not consumed. Return zero if no character available.
3223 If you prefer always getting a string use |getcharstr()|.
3224
3225 Without [expr] and when [expr] is 0 a whole character or
3226 special key is returned. If it is a single character, the
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01003227 result is a Number. Use |nr2char()| to convert it to a String.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003228 Otherwise a String is returned with the encoded character.
3229 For a special key it's a String with a sequence of bytes
3230 starting with 0x80 (decimal: 128). This is the same value as
3231 the String "\<Key>", e.g., "\<Left>". The returned value is
3232 also a String when a modifier (shift, control, alt) was used
3233 that is not included in the character.
3234
3235 When [expr] is 0 and Esc is typed, there will be a short delay
3236 while Vim waits to see if this is the start of an escape
3237 sequence.
3238
3239 When [expr] is 1 only the first byte is returned. For a
3240 one-byte character it is the character itself as a number.
3241 Use nr2char() to convert it to a String.
3242
3243 Use getcharmod() to obtain any additional modifiers.
3244
3245 When the user clicks a mouse button, the mouse event will be
3246 returned. The position can then be found in |v:mouse_col|,
3247 |v:mouse_lnum|, |v:mouse_winid| and |v:mouse_win|.
3248 |getmousepos()| can also be used. Mouse move events will be
3249 ignored.
3250 This example positions the mouse as it would normally happen: >
3251 let c = getchar()
3252 if c == "\<LeftMouse>" && v:mouse_win > 0
Bram Moolenaarc51cf032022-02-26 12:25:45 +00003253 exe v:mouse_win .. "wincmd w"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003254 exe v:mouse_lnum
Bram Moolenaarc51cf032022-02-26 12:25:45 +00003255 exe "normal " .. v:mouse_col .. "|"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003256 endif
3257<
3258 When using bracketed paste only the first character is
3259 returned, the rest of the pasted text is dropped.
3260 |xterm-bracketed-paste|.
3261
3262 There is no prompt, you will somehow have to make clear to the
3263 user that a character has to be typed. The screen is not
3264 redrawn, e.g. when resizing the window. When using a popup
3265 window it should work better with a |popup-filter|.
3266
3267 There is no mapping for the character.
3268 Key codes are replaced, thus when the user presses the <Del>
3269 key you get the code for the <Del> key, not the raw character
3270 sequence. Examples: >
3271 getchar() == "\<Del>"
3272 getchar() == "\<S-Left>"
3273< This example redefines "f" to ignore case: >
3274 :nmap f :call FindChar()<CR>
3275 :function FindChar()
3276 : let c = nr2char(getchar())
3277 : while col('.') < col('$') - 1
3278 : normal l
3279 : if getline('.')[col('.') - 1] ==? c
3280 : break
3281 : endif
3282 : endwhile
3283 :endfunction
3284<
3285 You may also receive synthetic characters, such as
3286 |<CursorHold>|. Often you will want to ignore this and get
3287 another character: >
3288 :function GetKey()
3289 : let c = getchar()
3290 : while c == "\<CursorHold>"
3291 : let c = getchar()
3292 : endwhile
3293 : return c
3294 :endfunction
3295
3296getcharmod() *getcharmod()*
3297 The result is a Number which is the state of the modifiers for
3298 the last obtained character with getchar() or in another way.
3299 These values are added together:
3300 2 shift
3301 4 control
3302 8 alt (meta)
3303 16 meta (when it's different from ALT)
3304 32 mouse double click
3305 64 mouse triple click
3306 96 mouse quadruple click (== 32 + 64)
3307 128 command (Macintosh only)
3308 Only the modifiers that have not been included in the
3309 character itself are obtained. Thus Shift-a results in "A"
3310 without a modifier.
3311
3312 *getcharpos()*
3313getcharpos({expr})
3314 Get the position for String {expr}. Same as |getpos()| but the
3315 column number in the returned List is a character index
3316 instead of a byte index.
naohiro ono56200ee2022-01-01 14:59:44 +00003317 If |getpos()| returns a very large column number, equal to
3318 |v:maxcol|, then getcharpos() will return the character index
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003319 of the last character.
3320
3321 Example:
3322 With the cursor on '세' in line 5 with text "여보세요": >
3323 getcharpos('.') returns [0, 5, 3, 0]
3324 getpos('.') returns [0, 5, 7, 0]
3325<
3326 Can also be used as a |method|: >
3327 GetMark()->getcharpos()
3328
3329getcharsearch() *getcharsearch()*
3330 Return the current character search information as a {dict}
3331 with the following entries:
3332
3333 char character previously used for a character
3334 search (|t|, |f|, |T|, or |F|); empty string
3335 if no character search has been performed
3336 forward direction of character search; 1 for forward,
3337 0 for backward
3338 until type of character search; 1 for a |t| or |T|
3339 character search, 0 for an |f| or |F|
3340 character search
3341
3342 This can be useful to always have |;| and |,| search
3343 forward/backward regardless of the direction of the previous
3344 character search: >
3345 :nnoremap <expr> ; getcharsearch().forward ? ';' : ','
3346 :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
3347< Also see |setcharsearch()|.
3348
3349
3350getcharstr([expr]) *getcharstr()*
3351 Get a single character from the user or input stream as a
3352 string.
3353 If [expr] is omitted, wait until a character is available.
3354 If [expr] is 0 or false, only get a character when one is
3355 available. Return an empty string otherwise.
3356 If [expr] is 1 or true, only check if a character is
3357 available, it is not consumed. Return an empty string
3358 if no character is available.
3359 Otherwise this works like |getchar()|, except that a number
3360 result is converted to a string.
3361
Shougo Matsushita79d599b2022-05-07 12:48:29 +01003362getcmdcompltype() *getcmdcompltype()*
3363 Return the type of the current command-line completion.
3364 Only works when the command line is being edited, thus
3365 requires use of |c_CTRL-\_e| or |c_CTRL-R_=|.
Bram Moolenaar921bde82022-05-09 19:50:35 +01003366 See |:command-completion| for the return string.
Shougo Matsushita79d599b2022-05-07 12:48:29 +01003367 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
3368 Returns an empty string when completion is not defined.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003369
3370getcmdline() *getcmdline()*
3371 Return the current command-line. Only works when the command
3372 line is being edited, thus requires use of |c_CTRL-\_e| or
3373 |c_CTRL-R_=|.
3374 Example: >
3375 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
3376< Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
3377 Returns an empty string when entering a password or using
3378 |inputsecret()|.
3379
3380getcmdpos() *getcmdpos()*
3381 Return the position of the cursor in the command line as a
3382 byte count. The first column is 1.
3383 Only works when editing the command line, thus requires use of
3384 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
3385 Returns 0 otherwise.
3386 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
3387
Shougo Matsushita79d599b2022-05-07 12:48:29 +01003388getcmdscreenpos() *getcmdscreenpos()*
3389 Return the screen position of the cursor in the command line
3390 as a byte count. The first column is 1.
3391 Instead of |getcmdpos()|, it adds the prompt position.
3392 Only works when editing the command line, thus requires use of
3393 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
3394 Returns 0 otherwise.
3395 Also see |getcmdpos()|, |setcmdpos()|.
3396
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003397getcmdtype() *getcmdtype()*
3398 Return the current command-line type. Possible return values
3399 are:
3400 : normal Ex command
3401 > debug mode command |debug-mode|
3402 / forward search command
3403 ? backward search command
3404 @ |input()| command
3405 - |:insert| or |:append| command
3406 = |i_CTRL-R_=|
3407 Only works when editing the command line, thus requires use of
3408 |c_CTRL-\_e| or |c_CTRL-R_=| or an expression mapping.
3409 Returns an empty string otherwise.
3410 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
3411
3412getcmdwintype() *getcmdwintype()*
3413 Return the current |command-line-window| type. Possible return
3414 values are the same as |getcmdtype()|. Returns an empty string
3415 when not in the command-line window.
3416
3417getcompletion({pat}, {type} [, {filtered}]) *getcompletion()*
3418 Return a list of command-line completion matches. The String
3419 {type} argument specifies what for. The following completion
3420 types are supported:
3421
3422 arglist file names in argument list
3423 augroup autocmd groups
3424 buffer buffer names
Bram Moolenaar6e2e2cc2022-03-14 19:24:46 +00003425 behave |:behave| suboptions
3426 breakpoint |:breakadd| and |:breakdel| suboptions
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003427 color color schemes
3428 command Ex command
3429 cmdline |cmdline-completion| result
3430 compiler compilers
3431 cscope |:cscope| suboptions
3432 diff_buffer |:diffget| and |:diffput| completion
3433 dir directory names
3434 environment environment variable names
3435 event autocommand events
3436 expression Vim expression
3437 file file and directory names
3438 file_in_path file and directory names in |'path'|
3439 filetype filetype names |'filetype'|
3440 function function name
3441 help help subjects
3442 highlight highlight groups
Bram Moolenaar6e2e2cc2022-03-14 19:24:46 +00003443 history |:history| suboptions
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003444 locale locale names (as output of locale -a)
3445 mapclear buffer argument
3446 mapping mapping name
3447 menu menus
3448 messages |:messages| suboptions
3449 option options
3450 packadd optional package |pack-add| names
Yegappan Lakshmanan454ce672022-03-24 11:22:13 +00003451 scriptnames sourced script names |:scriptnames|
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003452 shellcmd Shell command
3453 sign |:sign| suboptions
3454 syntax syntax file names |'syntax'|
3455 syntime |:syntime| suboptions
3456 tag tags
3457 tag_listfiles tags, file names
3458 user user names
3459 var user variables
3460
3461 If {pat} is an empty string, then all the matches are
3462 returned. Otherwise only items matching {pat} are returned.
3463 See |wildcards| for the use of special characters in {pat}.
3464
3465 If the optional {filtered} flag is set to 1, then 'wildignore'
3466 is applied to filter the results. Otherwise all the matches
3467 are returned. The 'wildignorecase' option always applies.
3468
Yegappan Lakshmanane7dd0fa2022-03-22 16:06:31 +00003469 If the 'wildoptions' option contains 'fuzzy', then fuzzy
3470 matching is used to get the completion matches. Otherwise
Yegappan Lakshmanan454ce672022-03-24 11:22:13 +00003471 regular expression matching is used. Thus this function
3472 follows the user preference, what happens on the command line.
3473 If you do not want this you can make 'wildoptions' empty
3474 before calling getcompletion() and restore it afterwards.
Yegappan Lakshmanane7dd0fa2022-03-22 16:06:31 +00003475
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003476 If {type} is "cmdline", then the |cmdline-completion| result is
3477 returned. For example, to complete the possible values after
3478 a ":call" command: >
3479 echo getcompletion('call ', 'cmdline')
3480<
3481 If there are no matches, an empty list is returned. An
3482 invalid value for {type} produces an error.
3483
3484 Can also be used as a |method|: >
3485 GetPattern()->getcompletion('color')
3486<
3487 *getcurpos()*
3488getcurpos([{winid}])
3489 Get the position of the cursor. This is like getpos('.'), but
3490 includes an extra "curswant" item in the list:
3491 [0, lnum, col, off, curswant] ~
3492 The "curswant" number is the preferred column when moving the
naohiro ono56200ee2022-01-01 14:59:44 +00003493 cursor vertically. After |$| command it will be a very large
3494 number equal to |v:maxcol|. Also see |getcursorcharpos()| and
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003495 |getpos()|.
3496 The first "bufnum" item is always zero. The byte position of
3497 the cursor is returned in 'col'. To get the character
3498 position, use |getcursorcharpos()|.
3499
3500 The optional {winid} argument can specify the window. It can
3501 be the window number or the |window-ID|. The last known
3502 cursor position is returned, this may be invalid for the
3503 current value of the buffer if it is not the current window.
3504 If {winid} is invalid a list with zeroes is returned.
3505
3506 This can be used to save and restore the cursor position: >
3507 let save_cursor = getcurpos()
3508 MoveTheCursorAround
3509 call setpos('.', save_cursor)
3510< Note that this only works within the window. See
3511 |winrestview()| for restoring more state.
3512
3513 Can also be used as a |method|: >
3514 GetWinid()->getcurpos()
3515<
3516 *getcursorcharpos()*
3517getcursorcharpos([{winid}])
3518 Same as |getcurpos()| but the column number in the returned
3519 List is a character index instead of a byte index.
3520
3521 Example:
3522 With the cursor on '보' in line 3 with text "여보세요": >
3523 getcursorcharpos() returns [0, 3, 2, 0, 3]
3524 getcurpos() returns [0, 3, 4, 0, 3]
3525<
3526 Can also be used as a |method|: >
3527 GetWinid()->getcursorcharpos()
3528
3529< *getcwd()*
3530getcwd([{winnr} [, {tabnr}]])
3531 The result is a String, which is the name of the current
3532 working directory. 'autochdir' is ignored.
3533
3534 With {winnr} return the local current directory of this window
3535 in the current tab page. {winnr} can be the window number or
3536 the |window-ID|.
3537 If {winnr} is -1 return the name of the global working
3538 directory. See also |haslocaldir()|.
3539
3540 With {winnr} and {tabnr} return the local current directory of
3541 the window in the specified tab page. If {winnr} is -1 return
3542 the working directory of the tabpage.
3543 If {winnr} is zero use the current window, if {tabnr} is zero
3544 use the current tabpage.
3545 Without any arguments, return the actual working directory of
3546 the current window.
3547 Return an empty string if the arguments are invalid.
3548
3549 Examples: >
3550 " Get the working directory of the current window
3551 :echo getcwd()
3552 :echo getcwd(0)
3553 :echo getcwd(0, 0)
3554 " Get the working directory of window 3 in tabpage 2
3555 :echo getcwd(3, 2)
3556 " Get the global working directory
3557 :echo getcwd(-1)
3558 " Get the working directory of tabpage 3
3559 :echo getcwd(-1, 3)
3560 " Get the working directory of current tabpage
3561 :echo getcwd(-1, 0)
3562
3563< Can also be used as a |method|: >
3564 GetWinnr()->getcwd()
3565
3566getenv({name}) *getenv()*
3567 Return the value of environment variable {name}. The {name}
3568 argument is a string, without a leading '$'. Example: >
3569 myHome = getenv('HOME')
3570
3571< When the variable does not exist |v:null| is returned. That
3572 is different from a variable set to an empty string, although
3573 some systems interpret the empty value as the variable being
3574 deleted. See also |expr-env|.
3575
3576 Can also be used as a |method|: >
3577 GetVarname()->getenv()
3578
3579getfontname([{name}]) *getfontname()*
3580 Without an argument returns the name of the normal font being
3581 used. Like what is used for the Normal highlight group
3582 |hl-Normal|.
3583 With an argument a check is done whether String {name} is a
3584 valid font name. If not then an empty string is returned.
3585 Otherwise the actual font name is returned, or {name} if the
3586 GUI does not support obtaining the real name.
3587 Only works when the GUI is running, thus not in your vimrc or
3588 gvimrc file. Use the |GUIEnter| autocommand to use this
3589 function just after the GUI has started.
3590 Note that the GTK GUI accepts any font name, thus checking for
3591 a valid name does not work.
3592
3593getfperm({fname}) *getfperm()*
3594 The result is a String, which is the read, write, and execute
3595 permissions of the given file {fname}.
3596 If {fname} does not exist or its directory cannot be read, an
3597 empty string is returned.
3598 The result is of the form "rwxrwxrwx", where each group of
3599 "rwx" flags represent, in turn, the permissions of the owner
3600 of the file, the group the file belongs to, and other users.
3601 If a user does not have a given permission the flag for this
3602 is replaced with the string "-". Examples: >
3603 :echo getfperm("/etc/passwd")
3604 :echo getfperm(expand("~/.vimrc"))
3605< This will hopefully (from a security point of view) display
3606 the string "rw-r--r--" or even "rw-------".
3607
3608 Can also be used as a |method|: >
3609 GetFilename()->getfperm()
3610<
3611 For setting permissions use |setfperm()|.
3612
3613getfsize({fname}) *getfsize()*
3614 The result is a Number, which is the size in bytes of the
3615 given file {fname}.
3616 If {fname} is a directory, 0 is returned.
3617 If the file {fname} can't be found, -1 is returned.
3618 If the size of {fname} is too big to fit in a Number then -2
3619 is returned.
3620
3621 Can also be used as a |method|: >
3622 GetFilename()->getfsize()
3623
3624getftime({fname}) *getftime()*
3625 The result is a Number, which is the last modification time of
3626 the given file {fname}. The value is measured as seconds
3627 since 1st Jan 1970, and may be passed to strftime(). See also
3628 |localtime()| and |strftime()|.
3629 If the file {fname} can't be found -1 is returned.
3630
3631 Can also be used as a |method|: >
3632 GetFilename()->getftime()
3633
3634getftype({fname}) *getftype()*
3635 The result is a String, which is a description of the kind of
3636 file of the given file {fname}.
3637 If {fname} does not exist an empty string is returned.
3638 Here is a table over different kinds of files and their
3639 results:
3640 Normal file "file"
3641 Directory "dir"
3642 Symbolic link "link"
3643 Block device "bdev"
3644 Character device "cdev"
3645 Socket "socket"
3646 FIFO "fifo"
3647 All other "other"
3648 Example: >
3649 getftype("/home")
3650< Note that a type such as "link" will only be returned on
3651 systems that support it. On some systems only "dir" and
3652 "file" are returned. On MS-Windows a symbolic link to a
3653 directory returns "dir" instead of "link".
3654
3655 Can also be used as a |method|: >
3656 GetFilename()->getftype()
3657
3658getimstatus() *getimstatus()*
3659 The result is a Number, which is |TRUE| when the IME status is
3660 active.
3661 See 'imstatusfunc'.
3662
3663getjumplist([{winnr} [, {tabnr}]]) *getjumplist()*
3664 Returns the |jumplist| for the specified window.
3665
3666 Without arguments use the current window.
3667 With {winnr} only use this window in the current tab page.
3668 {winnr} can also be a |window-ID|.
3669 With {winnr} and {tabnr} use the window in the specified tab
3670 page.
3671
3672 The returned list contains two entries: a list with the jump
3673 locations and the last used jump position number in the list.
3674 Each entry in the jump location list is a dictionary with
3675 the following entries:
3676 bufnr buffer number
3677 col column number
3678 coladd column offset for 'virtualedit'
3679 filename filename if available
3680 lnum line number
3681
3682 Can also be used as a |method|: >
3683 GetWinnr()->getjumplist()
3684
3685< *getline()*
3686getline({lnum} [, {end}])
3687 Without {end} the result is a String, which is line {lnum}
3688 from the current buffer. Example: >
3689 getline(1)
3690< When {lnum} is a String that doesn't start with a
3691 digit, |line()| is called to translate the String into a Number.
3692 To get the line under the cursor: >
3693 getline(".")
3694< When {lnum} is a number smaller than 1 or bigger than the
3695 number of lines in the buffer, an empty string is returned.
3696
3697 When {end} is given the result is a |List| where each item is
3698 a line from the current buffer in the range {lnum} to {end},
3699 including line {end}.
3700 {end} is used in the same way as {lnum}.
3701 Non-existing lines are silently omitted.
3702 When {end} is before {lnum} an empty |List| is returned.
3703 Example: >
3704 :let start = line('.')
3705 :let end = search("^$") - 1
3706 :let lines = getline(start, end)
3707
3708< Can also be used as a |method|: >
3709 ComputeLnum()->getline()
3710
3711< To get lines from another buffer see |getbufline()|
3712
3713getloclist({nr} [, {what}]) *getloclist()*
3714 Returns a |List| with all the entries in the location list for
3715 window {nr}. {nr} can be the window number or the |window-ID|.
3716 When {nr} is zero the current window is used.
3717
3718 For a location list window, the displayed location list is
3719 returned. For an invalid window number {nr}, an empty list is
3720 returned. Otherwise, same as |getqflist()|.
3721
3722 If the optional {what} dictionary argument is supplied, then
3723 returns the items listed in {what} as a dictionary. Refer to
3724 |getqflist()| for the supported items in {what}.
3725
3726 In addition to the items supported by |getqflist()| in {what},
3727 the following item is supported by |getloclist()|:
3728
3729 filewinid id of the window used to display files
3730 from the location list. This field is
3731 applicable only when called from a
3732 location list window. See
3733 |location-list-file-window| for more
3734 details.
3735
3736 Returns a |Dictionary| with default values if there is no
3737 location list for the window {nr}.
3738 Returns an empty Dictionary if window {nr} does not exist.
3739
3740 Examples (See also |getqflist-examples|): >
3741 :echo getloclist(3, {'all': 0})
3742 :echo getloclist(5, {'filewinid': 0})
3743
3744
3745getmarklist([{buf}]) *getmarklist()*
3746 Without the {buf} argument returns a |List| with information
3747 about all the global marks. |mark|
3748
3749 If the optional {buf} argument is specified, returns the
3750 local marks defined in buffer {buf}. For the use of {buf},
3751 see |bufname()|.
3752
3753 Each item in the returned List is a |Dict| with the following:
3754 mark name of the mark prefixed by "'"
3755 pos a |List| with the position of the mark:
3756 [bufnum, lnum, col, off]
3757 Refer to |getpos()| for more information.
3758 file file name
3759
3760 Refer to |getpos()| for getting information about a specific
3761 mark.
3762
3763 Can also be used as a |method|: >
3764 GetBufnr()->getmarklist()
3765
3766getmatches([{win}]) *getmatches()*
3767 Returns a |List| with all matches previously defined for the
3768 current window by |matchadd()| and the |:match| commands.
3769 |getmatches()| is useful in combination with |setmatches()|,
3770 as |setmatches()| can restore a list of matches saved by
3771 |getmatches()|.
3772 If {win} is specified, use the window with this number or
3773 window ID instead of the current window.
3774 Example: >
3775 :echo getmatches()
3776< [{'group': 'MyGroup1', 'pattern': 'TODO',
3777 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
3778 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
3779 :let m = getmatches()
3780 :call clearmatches()
3781 :echo getmatches()
3782< [] >
3783 :call setmatches(m)
3784 :echo getmatches()
3785< [{'group': 'MyGroup1', 'pattern': 'TODO',
3786 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
3787 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
3788 :unlet m
3789<
3790getmousepos() *getmousepos()*
3791 Returns a |Dictionary| with the last known position of the
3792 mouse. This can be used in a mapping for a mouse click or in
3793 a filter of a popup window. The items are:
3794 screenrow screen row
3795 screencol screen column
3796 winid Window ID of the click
3797 winrow row inside "winid"
3798 wincol column inside "winid"
3799 line text line inside "winid"
3800 column text column inside "winid"
3801 All numbers are 1-based.
3802
3803 If not over a window, e.g. when in the command line, then only
3804 "screenrow" and "screencol" are valid, the others are zero.
3805
3806 When on the status line below a window or the vertical
3807 separator right of a window, the "line" and "column" values
3808 are zero.
3809
3810 When the position is after the text then "column" is the
3811 length of the text in bytes plus one.
3812
3813 If the mouse is over a popup window then that window is used.
3814
3815 When using |getchar()| the Vim variables |v:mouse_lnum|,
3816 |v:mouse_col| and |v:mouse_winid| also provide these values.
3817
3818 *getpid()*
3819getpid() Return a Number which is the process ID of the Vim process.
3820 On Unix and MS-Windows this is a unique number, until Vim
3821 exits.
3822
3823 *getpos()*
3824getpos({expr}) Get the position for String {expr}. For possible values of
3825 {expr} see |line()|. For getting the cursor position see
3826 |getcurpos()|.
3827 The result is a |List| with four numbers:
3828 [bufnum, lnum, col, off]
3829 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
3830 is the buffer number of the mark.
3831 "lnum" and "col" are the position in the buffer. The first
3832 column is 1.
3833 The "off" number is zero, unless 'virtualedit' is used. Then
3834 it is the offset in screen columns from the start of the
3835 character. E.g., a position within a <Tab> or after the last
3836 character.
3837 Note that for '< and '> Visual mode matters: when it is "V"
3838 (visual line mode) the column of '< is zero and the column of
naohiro ono56200ee2022-01-01 14:59:44 +00003839 '> is a large number equal to |v:maxcol|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003840 The column number in the returned List is the byte position
3841 within the line. To get the character position in the line,
3842 use |getcharpos()|.
naohiro ono56200ee2022-01-01 14:59:44 +00003843 A very large column number equal to |v:maxcol| can be returned,
3844 in which case it means "after the end of the line".
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003845 This can be used to save and restore the position of a mark: >
3846 let save_a_mark = getpos("'a")
3847 ...
3848 call setpos("'a", save_a_mark)
3849< Also see |getcharpos()|, |getcurpos()| and |setpos()|.
3850
3851 Can also be used as a |method|: >
3852 GetMark()->getpos()
3853
3854getqflist([{what}]) *getqflist()*
3855 Returns a |List| with all the current quickfix errors. Each
3856 list item is a dictionary with these entries:
3857 bufnr number of buffer that has the file name, use
3858 bufname() to get the name
3859 module module name
3860 lnum line number in the buffer (first line is 1)
3861 end_lnum
3862 end of line number if the item is multiline
3863 col column number (first column is 1)
3864 end_col end of column number if the item has range
3865 vcol |TRUE|: "col" is visual column
3866 |FALSE|: "col" is byte index
3867 nr error number
3868 pattern search pattern used to locate the error
3869 text description of the error
3870 type type of the error, 'E', '1', etc.
3871 valid |TRUE|: recognized error message
3872
3873 When there is no error list or it's empty, an empty list is
3874 returned. Quickfix list entries with a non-existing buffer
3875 number are returned with "bufnr" set to zero (Note: some
3876 functions accept buffer number zero for the alternate buffer,
3877 you may need to explicitly check for zero).
3878
3879 Useful application: Find pattern matches in multiple files and
3880 do something with them: >
3881 :vimgrep /theword/jg *.c
3882 :for d in getqflist()
3883 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
3884 :endfor
3885<
3886 If the optional {what} dictionary argument is supplied, then
3887 returns only the items listed in {what} as a dictionary. The
3888 following string items are supported in {what}:
3889 changedtick get the total number of changes made
3890 to the list |quickfix-changedtick|
3891 context get the |quickfix-context|
3892 efm errorformat to use when parsing "lines". If
3893 not present, then the 'errorformat' option
3894 value is used.
3895 id get information for the quickfix list with
3896 |quickfix-ID|; zero means the id for the
3897 current list or the list specified by "nr"
3898 idx get information for the quickfix entry at this
3899 index in the list specified by 'id' or 'nr'.
3900 If set to zero, then uses the current entry.
3901 See |quickfix-index|
3902 items quickfix list entries
3903 lines parse a list of lines using 'efm' and return
3904 the resulting entries. Only a |List| type is
3905 accepted. The current quickfix list is not
3906 modified. See |quickfix-parse|.
3907 nr get information for this quickfix list; zero
3908 means the current quickfix list and "$" means
3909 the last quickfix list
3910 qfbufnr number of the buffer displayed in the quickfix
3911 window. Returns 0 if the quickfix buffer is
3912 not present. See |quickfix-buffer|.
3913 size number of entries in the quickfix list
3914 title get the list title |quickfix-title|
3915 winid get the quickfix |window-ID|
3916 all all of the above quickfix properties
3917 Non-string items in {what} are ignored. To get the value of a
3918 particular item, set it to zero.
3919 If "nr" is not present then the current quickfix list is used.
3920 If both "nr" and a non-zero "id" are specified, then the list
3921 specified by "id" is used.
3922 To get the number of lists in the quickfix stack, set "nr" to
3923 "$" in {what}. The "nr" value in the returned dictionary
3924 contains the quickfix stack size.
3925 When "lines" is specified, all the other items except "efm"
3926 are ignored. The returned dictionary contains the entry
3927 "items" with the list of entries.
3928
3929 The returned dictionary contains the following entries:
3930 changedtick total number of changes made to the
3931 list |quickfix-changedtick|
3932 context quickfix list context. See |quickfix-context|
3933 If not present, set to "".
3934 id quickfix list ID |quickfix-ID|. If not
3935 present, set to 0.
3936 idx index of the quickfix entry in the list. If not
3937 present, set to 0.
3938 items quickfix list entries. If not present, set to
3939 an empty list.
3940 nr quickfix list number. If not present, set to 0
3941 qfbufnr number of the buffer displayed in the quickfix
3942 window. If not present, set to 0.
3943 size number of entries in the quickfix list. If not
3944 present, set to 0.
3945 title quickfix list title text. If not present, set
3946 to "".
3947 winid quickfix |window-ID|. If not present, set to 0
3948
3949 Examples (See also |getqflist-examples|): >
3950 :echo getqflist({'all': 1})
3951 :echo getqflist({'nr': 2, 'title': 1})
3952 :echo getqflist({'lines' : ["F1:10:L10"]})
3953<
3954getreg([{regname} [, 1 [, {list}]]]) *getreg()*
3955 The result is a String, which is the contents of register
3956 {regname}. Example: >
3957 :let cliptext = getreg('*')
3958< When register {regname} was not set the result is an empty
3959 string.
Bram Moolenaara2baa732022-02-04 16:09:54 +00003960 The {regname} argument must be a string. *E1162*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00003961
3962 getreg('=') returns the last evaluated value of the expression
3963 register. (For use in maps.)
3964 getreg('=', 1) returns the expression itself, so that it can
3965 be restored with |setreg()|. For other registers the extra
3966 argument is ignored, thus you can always give it.
3967
3968 If {list} is present and |TRUE|, the result type is changed
3969 to |List|. Each list item is one text line. Use it if you care
3970 about zero bytes possibly present inside register: without
3971 third argument both NLs and zero bytes are represented as NLs
3972 (see |NL-used-for-Nul|).
3973 When the register was not set an empty list is returned.
3974
3975 If {regname} is "", the unnamed register '"' is used.
3976 If {regname} is not specified, |v:register| is used.
3977 In |Vim9-script| {regname} must be one character.
3978
3979 Can also be used as a |method|: >
3980 GetRegname()->getreg()
3981
3982getreginfo([{regname}]) *getreginfo()*
3983 Returns detailed information about register {regname} as a
3984 Dictionary with the following entries:
3985 regcontents List of lines contained in register
3986 {regname}, like
3987 |getreg|({regname}, 1, 1).
3988 regtype the type of register {regname}, as in
3989 |getregtype()|.
3990 isunnamed Boolean flag, v:true if this register
3991 is currently pointed to by the unnamed
3992 register.
3993 points_to for the unnamed register, gives the
3994 single letter name of the register
3995 currently pointed to (see |quotequote|).
3996 For example, after deleting a line
3997 with `dd`, this field will be "1",
3998 which is the register that got the
3999 deleted text.
4000
4001 The {regname} argument is a string. If {regname} is invalid
4002 or not set, an empty Dictionary will be returned.
4003 If {regname} is "" or "@", the unnamed register '"' is used.
4004 If {regname} is not specified, |v:register| is used.
4005 The returned Dictionary can be passed to |setreg()|.
4006 In |Vim9-script| {regname} must be one character.
4007
4008 Can also be used as a |method|: >
4009 GetRegname()->getreginfo()
4010
4011getregtype([{regname}]) *getregtype()*
4012 The result is a String, which is type of register {regname}.
4013 The value will be one of:
4014 "v" for |characterwise| text
4015 "V" for |linewise| text
4016 "<CTRL-V>{width}" for |blockwise-visual| text
4017 "" for an empty or unknown register
4018 <CTRL-V> is one character with value 0x16.
4019 The {regname} argument is a string. If {regname} is "", the
4020 unnamed register '"' is used. If {regname} is not specified,
4021 |v:register| is used.
4022 In |Vim9-script| {regname} must be one character.
4023
4024 Can also be used as a |method|: >
4025 GetRegname()->getregtype()
4026
4027gettabinfo([{tabnr}]) *gettabinfo()*
4028 If {tabnr} is not specified, then information about all the
4029 tab pages is returned as a |List|. Each List item is a
4030 |Dictionary|. Otherwise, {tabnr} specifies the tab page
4031 number and information about that one is returned. If the tab
4032 page does not exist an empty List is returned.
4033
4034 Each List item is a |Dictionary| with the following entries:
4035 tabnr tab page number.
4036 variables a reference to the dictionary with
4037 tabpage-local variables
4038 windows List of |window-ID|s in the tab page.
4039
4040 Can also be used as a |method|: >
4041 GetTabnr()->gettabinfo()
4042
4043gettabvar({tabnr}, {varname} [, {def}]) *gettabvar()*
4044 Get the value of a tab-local variable {varname} in tab page
4045 {tabnr}. |t:var|
4046 Tabs are numbered starting with one.
4047 The {varname} argument is a string. When {varname} is empty a
4048 dictionary with all tab-local variables is returned.
4049 Note that the name without "t:" must be used.
4050 When the tab or variable doesn't exist {def} or an empty
4051 string is returned, there is no error message.
4052
4053 Can also be used as a |method|: >
4054 GetTabnr()->gettabvar(varname)
4055
4056gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) *gettabwinvar()*
4057 Get the value of window-local variable {varname} in window
4058 {winnr} in tab page {tabnr}.
4059 The {varname} argument is a string. When {varname} is empty a
4060 dictionary with all window-local variables is returned.
4061 When {varname} is equal to "&" get the values of all
4062 window-local options in a |Dictionary|.
4063 Otherwise, when {varname} starts with "&" get the value of a
4064 window-local option.
4065 Note that {varname} must be the name without "w:".
4066 Tabs are numbered starting with one. For the current tabpage
4067 use |getwinvar()|.
4068 {winnr} can be the window number or the |window-ID|.
4069 When {winnr} is zero the current window is used.
4070 This also works for a global option, buffer-local option and
4071 window-local option, but it doesn't work for a global variable
4072 or buffer-local variable.
4073 When the tab, window or variable doesn't exist {def} or an
4074 empty string is returned, there is no error message.
4075 Examples: >
4076 :let list_is_on = gettabwinvar(1, 2, '&list')
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004077 :echo "myvar = " .. gettabwinvar(3, 1, 'myvar')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004078<
4079 To obtain all window-local variables use: >
4080 gettabwinvar({tabnr}, {winnr}, '&')
4081
4082< Can also be used as a |method|: >
4083 GetTabnr()->gettabwinvar(winnr, varname)
4084
4085gettagstack([{winnr}]) *gettagstack()*
4086 The result is a Dict, which is the tag stack of window {winnr}.
4087 {winnr} can be the window number or the |window-ID|.
4088 When {winnr} is not specified, the current window is used.
4089 When window {winnr} doesn't exist, an empty Dict is returned.
4090
4091 The returned dictionary contains the following entries:
4092 curidx Current index in the stack. When at
4093 top of the stack, set to (length + 1).
4094 Index of bottom of the stack is 1.
4095 items List of items in the stack. Each item
4096 is a dictionary containing the
4097 entries described below.
4098 length Number of entries in the stack.
4099
4100 Each item in the stack is a dictionary with the following
4101 entries:
4102 bufnr buffer number of the current jump
4103 from cursor position before the tag jump.
4104 See |getpos()| for the format of the
4105 returned list.
4106 matchnr current matching tag number. Used when
4107 multiple matching tags are found for a
4108 name.
4109 tagname name of the tag
4110
4111 See |tagstack| for more information about the tag stack.
4112
4113 Can also be used as a |method|: >
4114 GetWinnr()->gettagstack()
4115
4116
4117gettext({text}) *gettext()*
4118 Translate String {text} if possible.
4119 This is mainly for use in the distributed Vim scripts. When
4120 generating message translations the {text} is extracted by
4121 xgettext, the translator can add the translated message in the
4122 .po file and Vim will lookup the translation when gettext() is
4123 called.
4124 For {text} double quoted strings are preferred, because
4125 xgettext does not understand escaping in single quoted
4126 strings.
4127
4128
4129getwininfo([{winid}]) *getwininfo()*
4130 Returns information about windows as a |List| with Dictionaries.
4131
4132 If {winid} is given Information about the window with that ID
4133 is returned, as a |List| with one item. If the window does not
4134 exist the result is an empty list.
4135
4136 Without {winid} information about all the windows in all the
4137 tab pages is returned.
4138
4139 Each List item is a |Dictionary| with the following entries:
4140 botline last complete displayed buffer line
4141 bufnr number of buffer in the window
4142 height window height (excluding winbar)
4143 loclist 1 if showing a location list
4144 {only with the +quickfix feature}
4145 quickfix 1 if quickfix or location list window
4146 {only with the +quickfix feature}
4147 terminal 1 if a terminal window
4148 {only with the +terminal feature}
4149 tabnr tab page number
4150 topline first displayed buffer line
4151 variables a reference to the dictionary with
4152 window-local variables
4153 width window width
4154 winbar 1 if the window has a toolbar, 0
4155 otherwise
4156 wincol leftmost screen column of the window;
4157 "col" from |win_screenpos()|
4158 textoff number of columns occupied by any
4159 'foldcolumn', 'signcolumn' and line
4160 number in front of the text
4161 winid |window-ID|
4162 winnr window number
4163 winrow topmost screen line of the window;
4164 "row" from |win_screenpos()|
4165
4166 Can also be used as a |method|: >
4167 GetWinnr()->getwininfo()
4168
4169getwinpos([{timeout}]) *getwinpos()*
4170 The result is a |List| with two numbers, the result of
4171 |getwinposx()| and |getwinposy()| combined:
4172 [x-pos, y-pos]
4173 {timeout} can be used to specify how long to wait in msec for
4174 a response from the terminal. When omitted 100 msec is used.
4175 Use a longer time for a remote terminal.
4176 When using a value less than 10 and no response is received
4177 within that time, a previously reported position is returned,
4178 if available. This can be used to poll for the position and
4179 do some work in the meantime: >
4180 while 1
4181 let res = getwinpos(1)
4182 if res[0] >= 0
4183 break
4184 endif
4185 " Do some work here
4186 endwhile
4187<
4188
4189 Can also be used as a |method|: >
4190 GetTimeout()->getwinpos()
4191<
4192 *getwinposx()*
4193getwinposx() The result is a Number, which is the X coordinate in pixels of
4194 the left hand side of the GUI Vim window. Also works for an
4195 xterm (uses a timeout of 100 msec).
4196 The result will be -1 if the information is not available.
4197 The value can be used with `:winpos`.
4198
4199 *getwinposy()*
4200getwinposy() The result is a Number, which is the Y coordinate in pixels of
4201 the top of the GUI Vim window. Also works for an xterm (uses
4202 a timeout of 100 msec).
4203 The result will be -1 if the information is not available.
4204 The value can be used with `:winpos`.
4205
4206getwinvar({winnr}, {varname} [, {def}]) *getwinvar()*
4207 Like |gettabwinvar()| for the current tabpage.
4208 Examples: >
4209 :let list_is_on = getwinvar(2, '&list')
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004210 :echo "myvar = " .. getwinvar(1, 'myvar')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004211
4212< Can also be used as a |method|: >
4213 GetWinnr()->getwinvar(varname)
4214<
4215glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()*
4216 Expand the file wildcards in {expr}. See |wildcards| for the
4217 use of special characters.
4218
4219 Unless the optional {nosuf} argument is given and is |TRUE|,
4220 the 'suffixes' and 'wildignore' options apply: Names matching
4221 one of the patterns in 'wildignore' will be skipped and
4222 'suffixes' affect the ordering of matches.
4223 'wildignorecase' always applies.
4224
4225 When {list} is present and it is |TRUE| the result is a |List|
4226 with all matching files. The advantage of using a List is,
4227 you also get filenames containing newlines correctly.
4228 Otherwise the result is a String and when there are several
4229 matches, they are separated by <NL> characters.
4230
4231 If the expansion fails, the result is an empty String or List.
4232
4233 You can also use |readdir()| if you need to do complicated
4234 things, such as limiting the number of matches.
4235
4236 A name for a non-existing file is not included. A symbolic
4237 link is only included if it points to an existing file.
4238 However, when the {alllinks} argument is present and it is
4239 |TRUE| then all symbolic links are included.
4240
4241 For most systems backticks can be used to get files names from
4242 any external command. Example: >
4243 :let tagfiles = glob("`find . -name tags -print`")
4244 :let &tags = substitute(tagfiles, "\n", ",", "g")
4245< The result of the program inside the backticks should be one
4246 item per line. Spaces inside an item are allowed.
4247
4248 See |expand()| for expanding special Vim variables. See
4249 |system()| for getting the raw output of an external command.
4250
4251 Can also be used as a |method|: >
4252 GetExpr()->glob()
4253
4254glob2regpat({string}) *glob2regpat()*
4255 Convert a file pattern, as used by glob(), into a search
4256 pattern. The result can be used to match with a string that
4257 is a file name. E.g. >
4258 if filename =~ glob2regpat('Make*.mak')
4259< This is equivalent to: >
4260 if filename =~ '^Make.*\.mak$'
4261< When {string} is an empty string the result is "^$", match an
4262 empty string.
4263 Note that the result depends on the system. On MS-Windows
4264 a backslash usually means a path separator.
4265
4266 Can also be used as a |method|: >
4267 GetExpr()->glob2regpat()
4268< *globpath()*
4269globpath({path}, {expr} [, {nosuf} [, {list} [, {alllinks}]]])
4270 Perform glob() for String {expr} on all directories in {path}
4271 and concatenate the results. Example: >
4272 :echo globpath(&rtp, "syntax/c.vim")
4273<
4274 {path} is a comma-separated list of directory names. Each
4275 directory name is prepended to {expr} and expanded like with
4276 |glob()|. A path separator is inserted when needed.
4277 To add a comma inside a directory name escape it with a
4278 backslash. Note that on MS-Windows a directory may have a
4279 trailing backslash, remove it if you put a comma after it.
4280 If the expansion fails for one of the directories, there is no
4281 error message.
4282
4283 Unless the optional {nosuf} argument is given and is |TRUE|,
4284 the 'suffixes' and 'wildignore' options apply: Names matching
4285 one of the patterns in 'wildignore' will be skipped and
4286 'suffixes' affect the ordering of matches.
4287
4288 When {list} is present and it is |TRUE| the result is a |List|
4289 with all matching files. The advantage of using a List is, you
4290 also get filenames containing newlines correctly. Otherwise
4291 the result is a String and when there are several matches,
4292 they are separated by <NL> characters. Example: >
4293 :echo globpath(&rtp, "syntax/c.vim", 0, 1)
4294<
4295 {alllinks} is used as with |glob()|.
4296
4297 The "**" item can be used to search in a directory tree.
4298 For example, to find all "README.txt" files in the directories
4299 in 'runtimepath' and below: >
4300 :echo globpath(&rtp, "**/README.txt")
4301< Upwards search and limiting the depth of "**" is not
4302 supported, thus using 'path' will not always work properly.
4303
4304 Can also be used as a |method|, the base is passed as the
4305 second argument: >
4306 GetExpr()->globpath(&rtp)
4307<
4308 *has()*
4309has({feature} [, {check}])
4310 When {check} is omitted or is zero: The result is a Number,
4311 which is 1 if the feature {feature} is supported, zero
4312 otherwise. The {feature} argument is a string, case is
4313 ignored. See |feature-list| below.
4314
4315 When {check} is present and not zero: The result is a Number,
4316 which is 1 if the feature {feature} could ever be supported,
4317 zero otherwise. This is useful to check for a typo in
4318 {feature} and to detect dead code. Keep in mind that an older
4319 Vim version will not know about a feature added later and
4320 features that have been abandoned will not be known by the
4321 current Vim version.
4322
4323 Also see |exists()| and |exists_compiled()|.
4324
4325 Note that to skip code that has a syntax error when the
4326 feature is not available, Vim may skip the rest of the line
4327 and miss a following `endif`. Therefore put the `endif` on a
4328 separate line: >
4329 if has('feature')
4330 let x = this->breaks->without->the->feature
4331 endif
4332< If the `endif` would be moved to the second line as "| endif" it
4333 would not be found.
4334
4335
4336has_key({dict}, {key}) *has_key()*
4337 The result is a Number, which is TRUE if |Dictionary| {dict}
4338 has an entry with key {key}. FALSE otherwise. The {key}
4339 argument is a string.
4340
4341 Can also be used as a |method|: >
4342 mydict->has_key(key)
4343
4344haslocaldir([{winnr} [, {tabnr}]]) *haslocaldir()*
4345 The result is a Number:
4346 1 when the window has set a local directory via |:lcd|
4347 2 when the tab-page has set a local directory via |:tcd|
4348 0 otherwise.
4349
4350 Without arguments use the current window.
4351 With {winnr} use this window in the current tab page.
4352 With {winnr} and {tabnr} use the window in the specified tab
4353 page.
4354 {winnr} can be the window number or the |window-ID|.
4355 If {winnr} is -1 it is ignored and only the tabpage is used.
4356 Return 0 if the arguments are invalid.
4357 Examples: >
4358 if haslocaldir() == 1
4359 " window local directory case
4360 elseif haslocaldir() == 2
4361 " tab-local directory case
4362 else
4363 " global directory case
4364 endif
4365
4366 " current window
4367 :echo haslocaldir()
4368 :echo haslocaldir(0)
4369 :echo haslocaldir(0, 0)
4370 " window n in current tab page
4371 :echo haslocaldir(n)
4372 :echo haslocaldir(n, 0)
4373 " window n in tab page m
4374 :echo haslocaldir(n, m)
4375 " tab page m
4376 :echo haslocaldir(-1, m)
4377<
4378 Can also be used as a |method|: >
4379 GetWinnr()->haslocaldir()
4380
4381hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
4382 The result is a Number, which is TRUE if there is a mapping
4383 that contains {what} in somewhere in the rhs (what it is
4384 mapped to) and this mapping exists in one of the modes
4385 indicated by {mode}.
4386 The arguments {what} and {mode} are strings.
4387 When {abbr} is there and it is |TRUE| use abbreviations
4388 instead of mappings. Don't forget to specify Insert and/or
4389 Command-line mode.
4390 Both the global mappings and the mappings local to the current
4391 buffer are checked for a match.
4392 If no matching mapping is found FALSE is returned.
4393 The following characters are recognized in {mode}:
4394 n Normal mode
4395 v Visual and Select mode
4396 x Visual mode
4397 s Select mode
4398 o Operator-pending mode
4399 i Insert mode
4400 l Language-Argument ("r", "f", "t", etc.)
4401 c Command-line mode
4402 When {mode} is omitted, "nvo" is used.
4403
4404 This function is useful to check if a mapping already exists
4405 to a function in a Vim script. Example: >
4406 :if !hasmapto('\ABCdoit')
4407 : map <Leader>d \ABCdoit
4408 :endif
4409< This installs the mapping to "\ABCdoit" only if there isn't
4410 already a mapping to "\ABCdoit".
4411
4412 Can also be used as a |method|: >
4413 GetRHS()->hasmapto()
4414
4415histadd({history}, {item}) *histadd()*
4416 Add the String {item} to the history {history} which can be
4417 one of: *hist-names*
4418 "cmd" or ":" command line history
4419 "search" or "/" search pattern history
4420 "expr" or "=" typed expression history
4421 "input" or "@" input line history
4422 "debug" or ">" debug command history
4423 empty the current or last used history
4424 The {history} string does not need to be the whole name, one
4425 character is sufficient.
4426 If {item} does already exist in the history, it will be
4427 shifted to become the newest entry.
4428 The result is a Number: TRUE if the operation was successful,
4429 otherwise FALSE is returned.
4430
4431 Example: >
4432 :call histadd("input", strftime("%Y %b %d"))
4433 :let date=input("Enter date: ")
4434< This function is not available in the |sandbox|.
4435
4436 Can also be used as a |method|, the base is passed as the
4437 second argument: >
4438 GetHistory()->histadd('search')
4439
4440histdel({history} [, {item}]) *histdel()*
4441 Clear {history}, i.e. delete all its entries. See |hist-names|
4442 for the possible values of {history}.
4443
4444 If the parameter {item} evaluates to a String, it is used as a
4445 regular expression. All entries matching that expression will
4446 be removed from the history (if there are any).
4447 Upper/lowercase must match, unless "\c" is used |/\c|.
4448 If {item} evaluates to a Number, it will be interpreted as
4449 an index, see |:history-indexing|. The respective entry will
4450 be removed if it exists.
4451
4452 The result is TRUE for a successful operation, otherwise FALSE
4453 is returned.
4454
4455 Examples:
4456 Clear expression register history: >
4457 :call histdel("expr")
4458<
4459 Remove all entries starting with "*" from the search history: >
4460 :call histdel("/", '^\*')
4461<
4462 The following three are equivalent: >
4463 :call histdel("search", histnr("search"))
4464 :call histdel("search", -1)
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004465 :call histdel("search", '^' .. histget("search", -1) .. '$')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004466<
4467 To delete the last search pattern and use the last-but-one for
4468 the "n" command and 'hlsearch': >
4469 :call histdel("search", -1)
4470 :let @/ = histget("search", -1)
4471<
4472 Can also be used as a |method|: >
4473 GetHistory()->histdel()
4474
4475histget({history} [, {index}]) *histget()*
4476 The result is a String, the entry with Number {index} from
4477 {history}. See |hist-names| for the possible values of
4478 {history}, and |:history-indexing| for {index}. If there is
4479 no such entry, an empty String is returned. When {index} is
4480 omitted, the most recent item from the history is used.
4481
4482 Examples:
4483 Redo the second last search from history. >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004484 :execute '/' .. histget("search", -2)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004485
4486< Define an Ex command ":H {num}" that supports re-execution of
4487 the {num}th entry from the output of |:history|. >
4488 :command -nargs=1 H execute histget("cmd", 0+<args>)
4489<
4490 Can also be used as a |method|: >
4491 GetHistory()->histget()
4492
4493histnr({history}) *histnr()*
4494 The result is the Number of the current entry in {history}.
4495 See |hist-names| for the possible values of {history}.
4496 If an error occurred, -1 is returned.
4497
4498 Example: >
4499 :let inp_index = histnr("expr")
4500
4501< Can also be used as a |method|: >
4502 GetHistory()->histnr()
4503<
4504hlexists({name}) *hlexists()*
4505 The result is a Number, which is TRUE if a highlight group
4506 called {name} exists. This is when the group has been
4507 defined in some way. Not necessarily when highlighting has
4508 been defined for it, it may also have been used for a syntax
4509 item.
4510 *highlight_exists()*
4511 Obsolete name: highlight_exists().
4512
4513 Can also be used as a |method|: >
4514 GetName()->hlexists()
4515<
4516hlget([{name} [, {resolve}]]) *hlget()*
4517 Returns a List of all the highlight group attributes. If the
4518 optional {name} is specified, then returns a List with only
4519 the attributes of the specified highlight group. Returns an
4520 empty List if the highlight group {name} is not present.
4521
4522 If the optional {resolve} argument is set to v:true and the
4523 highlight group {name} is linked to another group, then the
4524 link is resolved recursively and the attributes of the
4525 resolved highlight group are returned.
4526
4527 Each entry in the returned List is a Dictionary with the
4528 following items:
4529 cleared boolean flag, set to v:true if the highlight
4530 group attributes are cleared or not yet
4531 specified. See |highlight-clear|.
4532 cterm cterm attributes. See |highlight-cterm|.
4533 ctermbg cterm background color.
4534 See |highlight-ctermbg|.
4535 ctermfg cterm foreground color.
4536 See |highlight-ctermfg|.
4537 ctermul cterm underline color. See |highlight-ctermul|.
4538 default boolean flag, set to v:true if the highlight
4539 group link is a default link. See
4540 |highlight-default|.
4541 font highlight group font. See |highlight-font|.
4542 gui gui attributes. See |highlight-gui|.
4543 guibg gui background color. See |highlight-guibg|.
4544 guifg gui foreground color. See |highlight-guifg|.
4545 guisp gui special color. See |highlight-guisp|.
4546 id highlight group ID.
4547 linksto linked highlight group name.
4548 See |:highlight-link|.
4549 name highlight group name. See |group-name|.
4550 start start terminal keycode. See |highlight-start|.
4551 stop stop terminal keycode. See |highlight-stop|.
4552 term term attributes. See |highlight-term|.
4553
4554 The 'term', 'cterm' and 'gui' items in the above Dictionary
4555 have a dictionary value with the following optional boolean
4556 items: 'bold', 'standout', 'underline', 'undercurl', 'italic',
4557 'reverse', 'inverse' and 'strikethrough'.
4558
4559 Example(s): >
4560 :echo hlget()
4561 :echo hlget('ModeMsg')
4562 :echo hlget('Number', v:true)
4563<
4564 Can also be used as a |method|: >
4565 GetName()->hlget()
4566<
4567hlset({list}) *hlset()*
4568 Creates or modifies the attributes of a List of highlight
4569 groups. Each item in {list} is a dictionary containing the
4570 attributes of a highlight group. See |hlget()| for the list of
4571 supported items in this dictionary.
4572
4573 In addition to the items described in |hlget()|, the following
4574 additional items are supported in the dictionary:
4575
4576 force boolean flag to force the creation of
4577 a link for an existing highlight group
4578 with attributes.
4579
4580 The highlight group is identified using the 'name' item and
4581 the 'id' item (if supplied) is ignored. If a highlight group
4582 with a specified name doesn't exist, then it is created.
4583 Otherwise the attributes of an existing highlight group are
4584 modified.
4585
4586 If an empty dictionary value is used for the 'term' or 'cterm'
4587 or 'gui' entries, then the corresponding attributes are
4588 cleared. If the 'cleared' item is set to v:true, then all the
4589 attributes of the highlight group are cleared.
4590
4591 The 'linksto' item can be used to link a highlight group to
4592 another highlight group. See |:highlight-link|.
4593
4594 Returns zero for success, -1 for failure.
4595
4596 Example(s): >
4597 " add bold attribute to the Visual highlight group
4598 :call hlset([#{name: 'Visual',
4599 \ term: #{reverse: 1 , bold: 1}}])
4600 :call hlset([#{name: 'Type', guifg: 'DarkGreen'}])
4601 :let l = hlget()
4602 :call hlset(l)
4603 " clear the Search highlight group
4604 :call hlset([#{name: 'Search', cleared: v:true}])
4605 " clear the 'term' attributes for a highlight group
4606 :call hlset([#{name: 'Title', term: {}}])
4607 " create the MyHlg group linking it to DiffAdd
4608 :call hlset([#{name: 'MyHlg', linksto: 'DiffAdd'}])
4609 " remove the MyHlg group link
4610 :call hlset([#{name: 'MyHlg', linksto: 'NONE'}])
4611 " clear the attributes and a link
4612 :call hlset([#{name: 'MyHlg', cleared: v:true,
4613 \ linksto: 'NONE'}])
4614<
4615 Can also be used as a |method|: >
4616 GetAttrList()->hlset()
4617<
4618 *hlID()*
4619hlID({name}) The result is a Number, which is the ID of the highlight group
4620 with name {name}. When the highlight group doesn't exist,
4621 zero is returned.
4622 This can be used to retrieve information about the highlight
4623 group. For example, to get the background color of the
4624 "Comment" group: >
4625 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
4626< *highlightID()*
4627 Obsolete name: highlightID().
4628
4629 Can also be used as a |method|: >
4630 GetName()->hlID()
4631
4632hostname() *hostname()*
4633 The result is a String, which is the name of the machine on
4634 which Vim is currently running. Machine names greater than
4635 256 characters long are truncated.
4636
4637iconv({string}, {from}, {to}) *iconv()*
4638 The result is a String, which is the text {string} converted
4639 from encoding {from} to encoding {to}.
4640 When the conversion completely fails an empty string is
4641 returned. When some characters could not be converted they
4642 are replaced with "?".
4643 The encoding names are whatever the iconv() library function
4644 can accept, see ":!man 3 iconv".
4645 Most conversions require Vim to be compiled with the |+iconv|
4646 feature. Otherwise only UTF-8 to latin1 conversion and back
4647 can be done.
4648 This can be used to display messages with special characters,
4649 no matter what 'encoding' is set to. Write the message in
4650 UTF-8 and use: >
4651 echo iconv(utf8_str, "utf-8", &enc)
4652< Note that Vim uses UTF-8 for all Unicode encodings, conversion
4653 from/to UCS-2 is automatically changed to use UTF-8. You
4654 cannot use UCS-2 in a string anyway, because of the NUL bytes.
4655
4656 Can also be used as a |method|: >
4657 GetText()->iconv('latin1', 'utf-8')
4658<
4659 *indent()*
4660indent({lnum}) The result is a Number, which is indent of line {lnum} in the
4661 current buffer. The indent is counted in spaces, the value
4662 of 'tabstop' is relevant. {lnum} is used just like in
4663 |getline()|.
4664 When {lnum} is invalid -1 is returned. In |Vim9| script an
4665 error is given.
4666
4667 Can also be used as a |method|: >
4668 GetLnum()->indent()
4669
4670index({object}, {expr} [, {start} [, {ic}]]) *index()*
4671 If {object} is a |List| return the lowest index where the item
4672 has a value equal to {expr}. There is no automatic
4673 conversion, so the String "4" is different from the Number 4.
4674 And the number 4 is different from the Float 4.0. The value
4675 of 'ignorecase' is not used here, case always matters.
4676
4677 If {object} is |Blob| return the lowest index where the byte
4678 value is equal to {expr}.
4679
4680 If {start} is given then start looking at the item with index
4681 {start} (may be negative for an item relative to the end).
4682 When {ic} is given and it is |TRUE|, ignore case. Otherwise
4683 case must match.
4684 -1 is returned when {expr} is not found in {object}.
4685 Example: >
4686 :let idx = index(words, "the")
4687 :if index(numbers, 123) >= 0
4688
4689< Can also be used as a |method|: >
4690 GetObject()->index(what)
4691
4692input({prompt} [, {text} [, {completion}]]) *input()*
4693 The result is a String, which is whatever the user typed on
4694 the command-line. The {prompt} argument is either a prompt
4695 string, or a blank string (for no prompt). A '\n' can be used
4696 in the prompt to start a new line.
4697 The highlighting set with |:echohl| is used for the prompt.
4698 The input is entered just like a command-line, with the same
4699 editing commands and mappings. There is a separate history
4700 for lines typed for input().
4701 Example: >
4702 :if input("Coffee or beer? ") == "beer"
4703 : echo "Cheers!"
4704 :endif
4705<
4706 If the optional {text} argument is present and not empty, this
4707 is used for the default reply, as if the user typed this.
4708 Example: >
4709 :let color = input("Color? ", "white")
4710
4711< The optional {completion} argument specifies the type of
4712 completion supported for the input. Without it completion is
4713 not performed. The supported completion types are the same as
4714 that can be supplied to a user-defined command using the
4715 "-complete=" argument. Refer to |:command-completion| for
4716 more information. Example: >
4717 let fname = input("File: ", "", "file")
4718<
4719 NOTE: This function must not be used in a startup file, for
4720 the versions that only run in GUI mode (e.g., the Win32 GUI).
4721 Note: When input() is called from within a mapping it will
4722 consume remaining characters from that mapping, because a
4723 mapping is handled like the characters were typed.
4724 Use |inputsave()| before input() and |inputrestore()|
4725 after input() to avoid that. Another solution is to avoid
4726 that further characters follow in the mapping, e.g., by using
4727 |:execute| or |:normal|.
4728
4729 Example with a mapping: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004730 :nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR>
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004731 :function GetFoo()
4732 : call inputsave()
4733 : let g:Foo = input("enter search pattern: ")
4734 : call inputrestore()
4735 :endfunction
4736
4737< Can also be used as a |method|: >
4738 GetPrompt()->input()
4739
4740inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
4741 Like |input()|, but when the GUI is running and text dialogs
4742 are supported, a dialog window pops up to input the text.
4743 Example: >
4744 :let n = inputdialog("value for shiftwidth", shiftwidth())
4745 :if n != ""
4746 : let &sw = n
4747 :endif
4748< When the dialog is cancelled {cancelreturn} is returned. When
4749 omitted an empty string is returned.
4750 Hitting <Enter> works like pressing the OK button. Hitting
4751 <Esc> works like pressing the Cancel button.
4752 NOTE: Command-line completion is not supported.
4753
4754 Can also be used as a |method|: >
4755 GetPrompt()->inputdialog()
4756
4757inputlist({textlist}) *inputlist()*
4758 {textlist} must be a |List| of strings. This |List| is
4759 displayed, one string per line. The user will be prompted to
4760 enter a number, which is returned.
4761 The user can also select an item by clicking on it with the
4762 mouse, if the mouse is enabled in the command line ('mouse' is
4763 "a" or includes "c"). For the first string 0 is returned.
4764 When clicking above the first item a negative number is
4765 returned. When clicking on the prompt one more than the
4766 length of {textlist} is returned.
4767 Make sure {textlist} has less than 'lines' entries, otherwise
4768 it won't work. It's a good idea to put the entry number at
4769 the start of the string. And put a prompt in the first item.
4770 Example: >
4771 let color = inputlist(['Select color:', '1. red',
4772 \ '2. green', '3. blue'])
4773
4774< Can also be used as a |method|: >
4775 GetChoices()->inputlist()
4776
4777inputrestore() *inputrestore()*
4778 Restore typeahead that was saved with a previous |inputsave()|.
4779 Should be called the same number of times inputsave() is
4780 called. Calling it more often is harmless though.
4781 Returns TRUE when there is nothing to restore, FALSE otherwise.
4782
4783inputsave() *inputsave()*
4784 Preserve typeahead (also from mappings) and clear it, so that
4785 a following prompt gets input from the user. Should be
4786 followed by a matching inputrestore() after the prompt. Can
4787 be used several times, in which case there must be just as
4788 many inputrestore() calls.
4789 Returns TRUE when out of memory, FALSE otherwise.
4790
4791inputsecret({prompt} [, {text}]) *inputsecret()*
4792 This function acts much like the |input()| function with but
4793 two exceptions:
4794 a) the user's response will be displayed as a sequence of
4795 asterisks ("*") thereby keeping the entry secret, and
4796 b) the user's response will not be recorded on the input
4797 |history| stack.
4798 The result is a String, which is whatever the user actually
4799 typed on the command-line in response to the issued prompt.
4800 NOTE: Command-line completion is not supported.
4801
4802 Can also be used as a |method|: >
4803 GetPrompt()->inputsecret()
4804
4805insert({object}, {item} [, {idx}]) *insert()*
4806 When {object} is a |List| or a |Blob| insert {item} at the start
4807 of it.
4808
4809 If {idx} is specified insert {item} before the item with index
4810 {idx}. If {idx} is zero it goes before the first item, just
4811 like omitting {idx}. A negative {idx} is also possible, see
4812 |list-index|. -1 inserts just before the last item.
4813
4814 Returns the resulting |List| or |Blob|. Examples: >
4815 :let mylist = insert([2, 3, 5], 1)
4816 :call insert(mylist, 4, -1)
4817 :call insert(mylist, 6, len(mylist))
4818< The last example can be done simpler with |add()|.
4819 Note that when {item} is a |List| it is inserted as a single
4820 item. Use |extend()| to concatenate |Lists|.
4821
4822 Can also be used as a |method|: >
4823 mylist->insert(item)
4824
4825interrupt() *interrupt()*
4826 Interrupt script execution. It works more or less like the
4827 user typing CTRL-C, most commands won't execute and control
4828 returns to the user. This is useful to abort execution
4829 from lower down, e.g. in an autocommand. Example: >
4830 :function s:check_typoname(file)
4831 : if fnamemodify(a:file, ':t') == '['
4832 : echomsg 'Maybe typo'
4833 : call interrupt()
4834 : endif
4835 :endfunction
4836 :au BufWritePre * call s:check_typoname(expand('<amatch>'))
4837
4838invert({expr}) *invert()*
4839 Bitwise invert. The argument is converted to a number. A
4840 List, Dict or Float argument causes an error. Example: >
4841 :let bits = invert(bits)
4842< Can also be used as a |method|: >
4843 :let bits = bits->invert()
4844
LemonBoydca1d402022-04-28 15:26:33 +01004845isabsolutepath({directory}) *isabsolutepath()*
4846 The result is a Number, which is |TRUE| when {path} is an
4847 absolute path.
4848< On Unix, a path is considered absolute when it starts with '/'.
4849 On MS-Windows, it is considered absolute when it starts with an
4850 optional drive prefix and is followed by a '\' or '/'. UNC paths
4851 are always absolute.
4852 Example: >
4853 echo isabsolutepath('/usr/share/') " 1
4854 echo isabsolutepath('./foobar') " 0
4855 echo isabsolutepath('C:\Windows') " 1
4856 echo isabsolutepath('foobar') " 0
4857 echo isabsolutepath('\\remote\file') " 1
4858
4859 Can also be used as a |method|: >
4860 GetName()->isabsolutepath()
4861
4862
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004863isdirectory({directory}) *isdirectory()*
4864 The result is a Number, which is |TRUE| when a directory
4865 with the name {directory} exists. If {directory} doesn't
4866 exist, or isn't a directory, the result is |FALSE|. {directory}
4867 is any expression, which is used as a String.
4868
4869 Can also be used as a |method|: >
4870 GetName()->isdirectory()
4871
4872isinf({expr}) *isinf()*
4873 Return 1 if {expr} is a positive infinity, or -1 a negative
4874 infinity, otherwise 0. >
4875 :echo isinf(1.0 / 0.0)
4876< 1 >
4877 :echo isinf(-1.0 / 0.0)
4878< -1
4879
4880 Can also be used as a |method|: >
4881 Compute()->isinf()
4882<
4883 {only available when compiled with the |+float| feature}
4884
4885islocked({expr}) *islocked()* *E786*
4886 The result is a Number, which is |TRUE| when {expr} is the
4887 name of a locked variable.
4888 The string argument {expr} must be the name of a variable,
4889 |List| item or |Dictionary| entry, not the variable itself!
4890 Example: >
4891 :let alist = [0, ['a', 'b'], 2, 3]
4892 :lockvar 1 alist
4893 :echo islocked('alist') " 1
4894 :echo islocked('alist[1]') " 0
4895
Bram Moolenaar9da17d72022-02-09 21:50:44 +00004896< When {expr} is a variable that does not exist -1 is returned.
4897 If {expr} uses a range, list or dict index that is out of
4898 range or does not exist you get an error message. Use
4899 |exists()| to check for existence.
4900 In Vim9 script it does not work for local function variables.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004901
4902 Can also be used as a |method|: >
4903 GetName()->islocked()
4904
4905isnan({expr}) *isnan()*
4906 Return |TRUE| if {expr} is a float with value NaN. >
4907 echo isnan(0.0 / 0.0)
4908< 1
4909
4910 Can also be used as a |method|: >
4911 Compute()->isnan()
4912<
4913 {only available when compiled with the |+float| feature}
4914
4915items({dict}) *items()*
4916 Return a |List| with all the key-value pairs of {dict}. Each
4917 |List| item is a list with two items: the key of a {dict}
4918 entry and the value of this entry. The |List| is in arbitrary
4919 order. Also see |keys()| and |values()|.
4920 Example: >
4921 for [key, value] in items(mydict)
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004922 echo key .. ': ' .. value
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004923 endfor
4924
4925< Can also be used as a |method|: >
4926 mydict->items()
4927
4928job_ functions are documented here: |job-functions-details|
4929
4930
4931join({list} [, {sep}]) *join()*
4932 Join the items in {list} together into one String.
4933 When {sep} is specified it is put in between the items. If
4934 {sep} is omitted a single space is used.
4935 Note that {sep} is not added at the end. You might want to
4936 add it there too: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00004937 let lines = join(mylist, "\n") .. "\n"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004938< String items are used as-is. |Lists| and |Dictionaries| are
4939 converted into a string like with |string()|.
4940 The opposite function is |split()|.
4941
4942 Can also be used as a |method|: >
4943 mylist->join()
4944
4945js_decode({string}) *js_decode()*
4946 This is similar to |json_decode()| with these differences:
4947 - Object key names do not have to be in quotes.
4948 - Strings can be in single quotes.
4949 - Empty items in an array (between two commas) are allowed and
4950 result in v:none items.
4951
4952 Can also be used as a |method|: >
4953 ReadObject()->js_decode()
4954
4955js_encode({expr}) *js_encode()*
4956 This is similar to |json_encode()| with these differences:
4957 - Object key names are not in quotes.
4958 - v:none items in an array result in an empty item between
4959 commas.
4960 For example, the Vim object:
4961 [1,v:none,{"one":1},v:none] ~
4962 Will be encoded as:
4963 [1,,{one:1},,] ~
4964 While json_encode() would produce:
4965 [1,null,{"one":1},null] ~
4966 This encoding is valid for JavaScript. It is more efficient
4967 than JSON, especially when using an array with optional items.
4968
4969 Can also be used as a |method|: >
4970 GetObject()->js_encode()
4971
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00004972json_decode({string}) *json_decode()* *E491*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00004973 This parses a JSON formatted string and returns the equivalent
4974 in Vim values. See |json_encode()| for the relation between
4975 JSON and Vim values.
4976 The decoding is permissive:
4977 - A trailing comma in an array and object is ignored, e.g.
4978 "[1, 2, ]" is the same as "[1, 2]".
4979 - Integer keys are accepted in objects, e.g. {1:2} is the
4980 same as {"1":2}.
4981 - More floating point numbers are recognized, e.g. "1." for
4982 "1.0", or "001.2" for "1.2". Special floating point values
4983 "Infinity", "-Infinity" and "NaN" (capitalization ignored)
4984 are accepted.
4985 - Leading zeroes in integer numbers are ignored, e.g. "012"
4986 for "12" or "-012" for "-12".
4987 - Capitalization is ignored in literal names null, true or
4988 false, e.g. "NULL" for "null", "True" for "true".
4989 - Control characters U+0000 through U+001F which are not
4990 escaped in strings are accepted, e.g. " " (tab
4991 character in string) for "\t".
4992 - An empty JSON expression or made of only spaces is accepted
4993 and results in v:none.
4994 - Backslash in an invalid 2-character sequence escape is
4995 ignored, e.g. "\a" is decoded as "a".
4996 - A correct surrogate pair in JSON strings should normally be
4997 a 12 character sequence such as "\uD834\uDD1E", but
4998 json_decode() silently accepts truncated surrogate pairs
4999 such as "\uD834" or "\uD834\u"
5000 *E938*
5001 A duplicate key in an object, valid in rfc7159, is not
5002 accepted by json_decode() as the result must be a valid Vim
5003 type, e.g. this fails: {"a":"b", "a":"c"}
5004
5005 Can also be used as a |method|: >
5006 ReadObject()->json_decode()
5007
5008json_encode({expr}) *json_encode()*
5009 Encode {expr} as JSON and return this as a string.
5010 The encoding is specified in:
5011 https://tools.ietf.org/html/rfc7159.html
Bram Moolenaara2baa732022-02-04 16:09:54 +00005012 Vim values are converted as follows: *E1161*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005013 |Number| decimal number
5014 |Float| floating point number
5015 Float nan "NaN"
5016 Float inf "Infinity"
5017 Float -inf "-Infinity"
5018 |String| in double quotes (possibly null)
5019 |Funcref| not possible, error
5020 |List| as an array (possibly null); when
5021 used recursively: []
5022 |Dict| as an object (possibly null); when
5023 used recursively: {}
5024 |Blob| as an array of the individual bytes
5025 v:false "false"
5026 v:true "true"
5027 v:none "null"
5028 v:null "null"
5029 Note that NaN and Infinity are passed on as values. This is
5030 missing in the JSON standard, but several implementations do
5031 allow it. If not then you will get an error.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01005032 If a string contains an illegal character then the replacement
5033 character 0xfffd is used.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005034
5035 Can also be used as a |method|: >
5036 GetObject()->json_encode()
5037
5038keys({dict}) *keys()*
5039 Return a |List| with all the keys of {dict}. The |List| is in
5040 arbitrary order. Also see |items()| and |values()|.
5041
5042 Can also be used as a |method|: >
5043 mydict->keys()
5044
5045< *len()* *E701*
5046len({expr}) The result is a Number, which is the length of the argument.
5047 When {expr} is a String or a Number the length in bytes is
5048 used, as with |strlen()|.
5049 When {expr} is a |List| the number of items in the |List| is
5050 returned.
5051 When {expr} is a |Blob| the number of bytes is returned.
5052 When {expr} is a |Dictionary| the number of entries in the
5053 |Dictionary| is returned.
5054 Otherwise an error is given.
5055
5056 Can also be used as a |method|: >
5057 mylist->len()
5058
5059< *libcall()* *E364* *E368*
5060libcall({libname}, {funcname}, {argument})
5061 Call function {funcname} in the run-time library {libname}
5062 with single argument {argument}.
5063 This is useful to call functions in a library that you
5064 especially made to be used with Vim. Since only one argument
5065 is possible, calling standard library functions is rather
5066 limited.
5067 The result is the String returned by the function. If the
5068 function returns NULL, this will appear as an empty string ""
5069 to Vim.
5070 If the function returns a number, use libcallnr()!
5071 If {argument} is a number, it is passed to the function as an
5072 int; if {argument} is a string, it is passed as a
5073 null-terminated string.
5074 This function will fail in |restricted-mode|.
5075
5076 libcall() allows you to write your own 'plug-in' extensions to
5077 Vim without having to recompile the program. It is NOT a
5078 means to call system functions! If you try to do so Vim will
5079 very probably crash.
5080
5081 For Win32, the functions you write must be placed in a DLL
5082 and use the normal C calling convention (NOT Pascal which is
5083 used in Windows System DLLs). The function must take exactly
5084 one parameter, either a character pointer or a long integer,
5085 and must return a character pointer or NULL. The character
5086 pointer returned must point to memory that will remain valid
5087 after the function has returned (e.g. in static data in the
5088 DLL). If it points to allocated memory, that memory will
5089 leak away. Using a static buffer in the function should work,
5090 it's then freed when the DLL is unloaded.
5091
5092 WARNING: If the function returns a non-valid pointer, Vim may
5093 crash! This also happens if the function returns a number,
5094 because Vim thinks it's a pointer.
5095 For Win32 systems, {libname} should be the filename of the DLL
5096 without the ".DLL" suffix. A full path is only required if
5097 the DLL is not in the usual places.
5098 For Unix: When compiling your own plugins, remember that the
5099 object code must be compiled as position-independent ('PIC').
5100 {only in Win32 and some Unix versions, when the |+libcall|
5101 feature is present}
5102 Examples: >
5103 :echo libcall("libc.so", "getenv", "HOME")
5104
5105< Can also be used as a |method|, the base is passed as the
5106 third argument: >
5107 GetValue()->libcall("libc.so", "getenv")
5108<
5109 *libcallnr()*
5110libcallnr({libname}, {funcname}, {argument})
5111 Just like |libcall()|, but used for a function that returns an
5112 int instead of a string.
5113 {only in Win32 on some Unix versions, when the |+libcall|
5114 feature is present}
5115 Examples: >
5116 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
5117 :call libcallnr("libc.so", "printf", "Hello World!\n")
5118 :call libcallnr("libc.so", "sleep", 10)
5119<
5120 Can also be used as a |method|, the base is passed as the
5121 third argument: >
5122 GetValue()->libcallnr("libc.so", "printf")
5123<
5124
5125line({expr} [, {winid}]) *line()*
5126 The result is a Number, which is the line number of the file
5127 position given with {expr}. The {expr} argument is a string.
Bram Moolenaara2baa732022-02-04 16:09:54 +00005128 The accepted positions are: *E1209*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005129 . the cursor position
5130 $ the last line in the current buffer
5131 'x position of mark x (if the mark is not set, 0 is
5132 returned)
5133 w0 first line visible in current window (one if the
5134 display isn't updated, e.g. in silent Ex mode)
5135 w$ last line visible in current window (this is one
5136 less than "w0" if no lines are visible)
5137 v In Visual mode: the start of the Visual area (the
5138 cursor is the end). When not in Visual mode
5139 returns the cursor position. Differs from |'<| in
5140 that it's updated right away.
5141 Note that a mark in another file can be used. The line number
5142 then applies to another buffer.
5143 To get the column number use |col()|. To get both use
5144 |getpos()|.
5145 With the optional {winid} argument the values are obtained for
5146 that window instead of the current window.
5147 Examples: >
5148 line(".") line number of the cursor
5149 line(".", winid) idem, in window "winid"
5150 line("'t") line number of mark t
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005151 line("'" .. marker) line number of mark marker
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005152<
5153 To jump to the last known position when opening a file see
5154 |last-position-jump|.
5155
5156 Can also be used as a |method|: >
5157 GetValue()->line()
5158
5159line2byte({lnum}) *line2byte()*
5160 Return the byte count from the start of the buffer for line
5161 {lnum}. This includes the end-of-line character, depending on
5162 the 'fileformat' option for the current buffer. The first
5163 line returns 1. 'encoding' matters, 'fileencoding' is ignored.
5164 This can also be used to get the byte count for the line just
5165 below the last line: >
5166 line2byte(line("$") + 1)
5167< This is the buffer size plus one. If 'fileencoding' is empty
5168 it is the file size plus one. {lnum} is used like with
5169 |getline()|. When {lnum} is invalid, or the |+byte_offset|
5170 feature has been disabled at compile time, -1 is returned.
5171 Also see |byte2line()|, |go| and |:goto|.
5172
5173 Can also be used as a |method|: >
5174 GetLnum()->line2byte()
5175
5176lispindent({lnum}) *lispindent()*
5177 Get the amount of indent for line {lnum} according the lisp
5178 indenting rules, as with 'lisp'.
5179 The indent is counted in spaces, the value of 'tabstop' is
5180 relevant. {lnum} is used just like in |getline()|.
Bram Moolenaar8e145b82022-05-21 20:17:31 +01005181 When {lnum} is invalid -1 is returned. In |Vim9| script an
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005182 error is given.
5183
5184 Can also be used as a |method|: >
5185 GetLnum()->lispindent()
5186
5187list2blob({list}) *list2blob()*
5188 Return a Blob concatenating all the number values in {list}.
5189 Examples: >
5190 list2blob([1, 2, 3, 4]) returns 0z01020304
5191 list2blob([]) returns 0z
5192< Returns an empty Blob on error. If one of the numbers is
5193 negative or more than 255 error *E1239* is given.
5194
5195 |blob2list()| does the opposite.
5196
5197 Can also be used as a |method|: >
5198 GetList()->list2blob()
5199
5200list2str({list} [, {utf8}]) *list2str()*
5201 Convert each number in {list} to a character string can
5202 concatenate them all. Examples: >
5203 list2str([32]) returns " "
5204 list2str([65, 66, 67]) returns "ABC"
5205< The same can be done (slowly) with: >
5206 join(map(list, {nr, val -> nr2char(val)}), '')
5207< |str2list()| does the opposite.
5208
5209 When {utf8} is omitted or zero, the current 'encoding' is used.
5210 When {utf8} is TRUE, always return UTF-8 characters.
5211 With UTF-8 composing characters work as expected: >
5212 list2str([97, 769]) returns "á"
5213<
5214 Can also be used as a |method|: >
5215 GetList()->list2str()
5216
5217listener_add({callback} [, {buf}]) *listener_add()*
5218 Add a callback function that will be invoked when changes have
5219 been made to buffer {buf}.
5220 {buf} refers to a buffer name or number. For the accepted
5221 values, see |bufname()|. When {buf} is omitted the current
5222 buffer is used.
5223 Returns a unique ID that can be passed to |listener_remove()|.
5224
5225 The {callback} is invoked with five arguments:
Bram Moolenaar944697a2022-02-20 19:48:20 +00005226 bufnr the buffer that was changed
5227 start first changed line number
5228 end first line number below the change
5229 added number of lines added, negative if lines were
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005230 deleted
Bram Moolenaar944697a2022-02-20 19:48:20 +00005231 changes a List of items with details about the changes
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005232
5233 Example: >
5234 func Listener(bufnr, start, end, added, changes)
5235 echo 'lines ' .. a:start .. ' until ' .. a:end .. ' changed'
5236 endfunc
5237 call listener_add('Listener', bufnr)
5238
Bram Moolenaar944697a2022-02-20 19:48:20 +00005239< The List cannot be changed. Each item in "changes" is a
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005240 dictionary with these entries:
5241 lnum the first line number of the change
5242 end the first line below the change
5243 added number of lines added; negative if lines were
5244 deleted
5245 col first column in "lnum" that was affected by
5246 the change; one if unknown or the whole line
5247 was affected; this is a byte index, first
5248 character has a value of one.
5249 When lines are inserted the values are:
5250 lnum line above which the new line is added
5251 end equal to "lnum"
5252 added number of lines inserted
5253 col 1
5254 When lines are deleted the values are:
5255 lnum the first deleted line
5256 end the line below the first deleted line, before
5257 the deletion was done
5258 added negative, number of lines deleted
5259 col 1
5260 When lines are changed:
5261 lnum the first changed line
5262 end the line below the last changed line
5263 added 0
5264 col first column with a change or 1
5265
5266 The entries are in the order the changes were made, thus the
5267 most recent change is at the end. The line numbers are valid
5268 when the callback is invoked, but later changes may make them
5269 invalid, thus keeping a copy for later might not work.
5270
5271 The {callback} is invoked just before the screen is updated,
5272 when |listener_flush()| is called or when a change is being
5273 made that changes the line count in a way it causes a line
5274 number in the list of changes to become invalid.
5275
5276 The {callback} is invoked with the text locked, see
5277 |textlock|. If you do need to make changes to the buffer, use
5278 a timer to do this later |timer_start()|.
5279
5280 The {callback} is not invoked when the buffer is first loaded.
5281 Use the |BufReadPost| autocmd event to handle the initial text
5282 of a buffer.
5283 The {callback} is also not invoked when the buffer is
5284 unloaded, use the |BufUnload| autocmd event for that.
5285
5286 Can also be used as a |method|, the base is passed as the
5287 second argument: >
5288 GetBuffer()->listener_add(callback)
5289
5290listener_flush([{buf}]) *listener_flush()*
5291 Invoke listener callbacks for buffer {buf}. If there are no
5292 pending changes then no callbacks are invoked.
5293
5294 {buf} refers to a buffer name or number. For the accepted
5295 values, see |bufname()|. When {buf} is omitted the current
5296 buffer is used.
5297
5298 Can also be used as a |method|: >
5299 GetBuffer()->listener_flush()
5300
5301listener_remove({id}) *listener_remove()*
5302 Remove a listener previously added with listener_add().
5303 Returns FALSE when {id} could not be found, TRUE when {id} was
5304 removed.
5305
5306 Can also be used as a |method|: >
5307 GetListenerId()->listener_remove()
5308
5309localtime() *localtime()*
5310 Return the current time, measured as seconds since 1st Jan
5311 1970. See also |strftime()|, |strptime()| and |getftime()|.
5312
5313
5314log({expr}) *log()*
5315 Return the natural logarithm (base e) of {expr} as a |Float|.
5316 {expr} must evaluate to a |Float| or a |Number| in the range
5317 (0, inf].
5318 Examples: >
5319 :echo log(10)
5320< 2.302585 >
5321 :echo log(exp(5))
5322< 5.0
5323
5324 Can also be used as a |method|: >
5325 Compute()->log()
5326<
5327 {only available when compiled with the |+float| feature}
5328
5329
5330log10({expr}) *log10()*
5331 Return the logarithm of Float {expr} to base 10 as a |Float|.
5332 {expr} must evaluate to a |Float| or a |Number|.
5333 Examples: >
5334 :echo log10(1000)
5335< 3.0 >
5336 :echo log10(0.01)
5337< -2.0
5338
5339 Can also be used as a |method|: >
5340 Compute()->log10()
5341<
5342 {only available when compiled with the |+float| feature}
5343
5344luaeval({expr} [, {expr}]) *luaeval()*
5345 Evaluate Lua expression {expr} and return its result converted
5346 to Vim data structures. Second {expr} may hold additional
5347 argument accessible as _A inside first {expr}.
5348 Strings are returned as they are.
5349 Boolean objects are converted to numbers.
5350 Numbers are converted to |Float| values if vim was compiled
5351 with |+float| and to numbers otherwise.
5352 Dictionaries and lists obtained by vim.eval() are returned
5353 as-is.
5354 Other objects are returned as zero without any errors.
5355 See |lua-luaeval| for more details.
5356 Note that in a `:def` function local variables are not visible
5357 to {expr}.
5358
5359 Can also be used as a |method|: >
5360 GetExpr()->luaeval()
5361
5362< {only available when compiled with the |+lua| feature}
5363
5364map({expr1}, {expr2}) *map()*
5365 {expr1} must be a |List|, |String|, |Blob| or |Dictionary|.
Bram Moolenaar944697a2022-02-20 19:48:20 +00005366 When {expr1} is a |List| or |Dictionary|, replace each
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005367 item in {expr1} with the result of evaluating {expr2}.
5368 For a |Blob| each byte is replaced.
5369 For a |String|, each character, including composing
5370 characters, is replaced.
5371 If the item type changes you may want to use |mapnew()| to
5372 create a new List or Dictionary. This is required when using
5373 Vim9 script.
5374
5375 {expr2} must be a |String| or |Funcref|.
5376
5377 If {expr2} is a |String|, inside {expr2} |v:val| has the value
5378 of the current item. For a |Dictionary| |v:key| has the key
5379 of the current item and for a |List| |v:key| has the index of
5380 the current item. For a |Blob| |v:key| has the index of the
5381 current byte. For a |String| |v:key| has the index of the
5382 current character.
5383 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005384 :call map(mylist, '"> " .. v:val .. " <"')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005385< This puts "> " before and " <" after each item in "mylist".
5386
5387 Note that {expr2} is the result of an expression and is then
5388 used as an expression again. Often it is good to use a
5389 |literal-string| to avoid having to double backslashes. You
5390 still have to double ' quotes
5391
5392 If {expr2} is a |Funcref| it is called with two arguments:
5393 1. The key or the index of the current item.
5394 2. the value of the current item.
5395 The function must return the new value of the item. Example
5396 that changes each value by "key-value": >
5397 func KeyValue(key, val)
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005398 return a:key .. '-' .. a:val
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005399 endfunc
5400 call map(myDict, function('KeyValue'))
5401< It is shorter when using a |lambda|: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005402 call map(myDict, {key, val -> key .. '-' .. val})
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005403< If you do not use "val" you can leave it out: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005404 call map(myDict, {key -> 'item: ' .. key})
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005405< If you do not use "key" you can use a short name: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005406 call map(myDict, {_, val -> 'item: ' .. val})
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005407<
5408 The operation is done in-place for a |List| and |Dictionary|.
5409 If you want it to remain unmodified make a copy first: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005410 :let tlist = map(copy(mylist), ' v:val .. "\t"')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005411
5412< Returns {expr1}, the |List| or |Dictionary| that was filtered,
5413 or a new |Blob| or |String|.
5414 When an error is encountered while evaluating {expr2} no
5415 further items in {expr1} are processed.
5416 When {expr2} is a Funcref errors inside a function are ignored,
5417 unless it was defined with the "abort" flag.
5418
5419 Can also be used as a |method|: >
5420 mylist->map(expr2)
5421
5422
5423maparg({name} [, {mode} [, {abbr} [, {dict}]]]) *maparg()*
5424 When {dict} is omitted or zero: Return the rhs of mapping
5425 {name} in mode {mode}. The returned String has special
5426 characters translated like in the output of the ":map" command
Ernie Rael09661202022-04-25 14:40:44 +01005427 listing. When {dict} is TRUE a dictionary is returned, see
5428 below. To get a list of all mappings see |maplist()|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005429
5430 When there is no mapping for {name}, an empty String is
5431 returned. When the mapping for {name} is empty, then "<Nop>"
5432 is returned.
5433
5434 The {name} can have special key names, like in the ":map"
5435 command.
5436
5437 {mode} can be one of these strings:
5438 "n" Normal
5439 "v" Visual (including Select)
5440 "o" Operator-pending
5441 "i" Insert
5442 "c" Cmd-line
5443 "s" Select
5444 "x" Visual
5445 "l" langmap |language-mapping|
5446 "t" Terminal-Job
5447 "" Normal, Visual and Operator-pending
5448 When {mode} is omitted, the modes for "" are used.
5449
5450 When {abbr} is there and it is |TRUE| use abbreviations
5451 instead of mappings.
5452
5453 When {dict} is there and it is |TRUE| return a dictionary
5454 containing all the information of the mapping with the
Ernie Rael659c2402022-04-24 18:40:28 +01005455 following items: *mapping-dict*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005456 "lhs" The {lhs} of the mapping as it would be typed
5457 "lhsraw" The {lhs} of the mapping as raw bytes
5458 "lhsrawalt" The {lhs} of the mapping as raw bytes, alternate
5459 form, only present when it differs from "lhsraw"
5460 "rhs" The {rhs} of the mapping as typed.
5461 "silent" 1 for a |:map-silent| mapping, else 0.
5462 "noremap" 1 if the {rhs} of the mapping is not remappable.
5463 "script" 1 if mapping was defined with <script>.
5464 "expr" 1 for an expression mapping (|:map-<expr>|).
5465 "buffer" 1 for a buffer local mapping (|:map-local|).
5466 "mode" Modes for which the mapping is defined. In
5467 addition to the modes mentioned above, these
5468 characters will be used:
5469 " " Normal, Visual and Operator-pending
5470 "!" Insert and Commandline mode
5471 (|mapmode-ic|)
5472 "sid" The script local ID, used for <sid> mappings
5473 (|<SID>|).
Bram Moolenaara9528b32022-01-18 20:51:35 +00005474 "scriptversion" The version of the script. 999999 for
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005475 |Vim9| script.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005476 "lnum" The line number in "sid", zero if unknown.
5477 "nowait" Do not wait for other, longer mappings.
5478 (|:map-<nowait>|).
Bram Moolenaar921bde82022-05-09 19:50:35 +01005479 "abbr" True if this is an abbreviation |abbreviations|.
Ernie Raeld8f5f762022-05-10 17:50:39 +01005480 "mode_bits" Vim's internal binary representation of "mode".
5481 |mapset()| ignores this; only "mode" is used.
5482 See |maplist()| for usage examples. The values
5483 are from src/vim.h and may change in the future.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005484
5485 The dictionary can be used to restore a mapping with
5486 |mapset()|.
5487
5488 The mappings local to the current buffer are checked first,
5489 then the global mappings.
5490 This function can be used to map a key even when it's already
5491 mapped, and have it do the original mapping too. Sketch: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00005492 exe 'nnoremap <Tab> ==' .. maparg('<Tab>', 'n')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005493
5494< Can also be used as a |method|: >
5495 GetKey()->maparg('n')
5496
5497mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()*
5498 Check if there is a mapping that matches with {name} in mode
5499 {mode}. See |maparg()| for {mode} and special names in
5500 {name}.
5501 When {abbr} is there and it is |TRUE| use abbreviations
5502 instead of mappings.
5503 A match happens with a mapping that starts with {name} and
5504 with a mapping which is equal to the start of {name}.
5505
5506 matches mapping "a" "ab" "abc" ~
5507 mapcheck("a") yes yes yes
5508 mapcheck("abc") yes yes yes
5509 mapcheck("ax") yes no no
5510 mapcheck("b") no no no
5511
5512 The difference with maparg() is that mapcheck() finds a
5513 mapping that matches with {name}, while maparg() only finds a
5514 mapping for {name} exactly.
5515 When there is no mapping that starts with {name}, an empty
5516 String is returned. If there is one, the RHS of that mapping
5517 is returned. If there are several mappings that start with
5518 {name}, the RHS of one of them is returned. This will be
5519 "<Nop>" if the RHS is empty.
5520 The mappings local to the current buffer are checked first,
5521 then the global mappings.
5522 This function can be used to check if a mapping can be added
5523 without being ambiguous. Example: >
5524 :if mapcheck("_vv") == ""
5525 : map _vv :set guifont=7x13<CR>
5526 :endif
5527< This avoids adding the "_vv" mapping when there already is a
5528 mapping for "_v" or for "_vvv".
5529
5530 Can also be used as a |method|: >
5531 GetKey()->mapcheck('n')
5532
5533
Ernie Rael09661202022-04-25 14:40:44 +01005534maplist([{abbr}]) *maplist()*
5535 Returns a |List| of all mappings. Each List item is a |Dict|,
5536 the same as what is returned by |maparg()|, see
5537 |mapping-dict|. When {abbr} is there and it is |TRUE| use
5538 abbreviations instead of mappings.
5539
5540 Example to show all mappings with 'MultiMatch' in rhs: >
5541 vim9script
5542 echo maplist()->filter(
5543 (_, m) => match(m.rhs, 'MultiMatch') >= 0)
Ernie Raeld8f5f762022-05-10 17:50:39 +01005544< It can be tricky to find mappings for particular |:map-modes|.
5545 |mapping-dict|'s "mode_bits" can simplify this. For example,
5546 the mode_bits for Normal, Insert or Command-line modes are
5547 0x19. To find all the mappings available in those modes you
5548 can do: >
5549 vim9script
5550 var saved_maps = []
5551 for m in maplist()
5552 if and(m.mode_bits, 0x19) != 0
5553 saved_maps->add(m)
5554 endif
5555 endfor
5556 echo saved_maps->mapnew((_, m) => m.lhs)
5557< The values of the mode_bits are defined in Vim's src/vim.h
5558 file and they can be discovered at runtime using
5559 |:map-commands| and "maplist()". Example: >
5560 vim9script
5561 omap xyzzy <Nop>
5562 var op_bit = maplist()->filter(
5563 (_, m) => m.lhs == 'xyzzy')[0].mode_bits
5564 ounmap xyzzy
5565 echo printf("Operator-pending mode bit: 0x%x", op_bit)
Ernie Rael09661202022-04-25 14:40:44 +01005566
5567
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005568mapnew({expr1}, {expr2}) *mapnew()*
5569 Like |map()| but instead of replacing items in {expr1} a new
5570 List or Dictionary is created and returned. {expr1} remains
5571 unchanged. Items can still be changed by {expr2}, if you
5572 don't want that use |deepcopy()| first.
5573
5574
5575mapset({mode}, {abbr}, {dict}) *mapset()*
Ernie Rael51d04d12022-05-04 15:40:22 +01005576mapset({dict})
5577 Restore a mapping from a dictionary, possibly returned by
5578 |maparg()| or |maplist()|. A buffer mapping, when dict.buffer
5579 is true, is set on the current buffer; it is up to the caller
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01005580 to ensure that the intended buffer is the current buffer. This
Ernie Rael51d04d12022-05-04 15:40:22 +01005581 feature allows copying mappings from one buffer to another.
5582 The dict.mode value may restore a single mapping that covers
5583 more than one mode, like with mode values of '!', ' ', 'nox',
5584 or 'v'. *E1276*
5585
5586 In the first form, {mode} and {abbr} should be the same as
5587 for the call to |maparg()|. *E460*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005588 {mode} is used to define the mode in which the mapping is set,
5589 not the "mode" entry in {dict}.
5590 Example for saving and restoring a mapping: >
5591 let save_map = maparg('K', 'n', 0, 1)
5592 nnoremap K somethingelse
5593 ...
5594 call mapset('n', 0, save_map)
5595< Note that if you are going to replace a map in several modes,
Ernie Rael51d04d12022-05-04 15:40:22 +01005596 e.g. with `:map!`, you need to save/restore the mapping for
5597 all of them, when they might differ.
5598
5599 In the second form, with {dict} as the only argument, mode
5600 and abbr are taken from the dict.
5601 Example: >
5602 vim9script
5603 var save_maps = maplist()->filter(
5604 (_, m) => m.lhs == 'K')
5605 nnoremap K somethingelse
5606 cnoremap K somethingelse2
5607 # ...
5608 unmap K
5609 for d in save_maps
5610 mapset(d)
5611 endfor
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005612
5613
5614match({expr}, {pat} [, {start} [, {count}]]) *match()*
5615 When {expr} is a |List| then this returns the index of the
5616 first item where {pat} matches. Each item is used as a
5617 String, |Lists| and |Dictionaries| are used as echoed.
5618
5619 Otherwise, {expr} is used as a String. The result is a
5620 Number, which gives the index (byte offset) in {expr} where
5621 {pat} matches.
5622
5623 A match at the first character or |List| item returns zero.
5624 If there is no match -1 is returned.
5625
5626 For getting submatches see |matchlist()|.
5627 Example: >
5628 :echo match("testing", "ing") " results in 4
5629 :echo match([1, 'x'], '\a') " results in 1
5630< See |string-match| for how {pat} is used.
5631 *strpbrk()*
5632 Vim doesn't have a strpbrk() function. But you can do: >
5633 :let sepidx = match(line, '[.,;: \t]')
5634< *strcasestr()*
5635 Vim doesn't have a strcasestr() function. But you can add
5636 "\c" to the pattern to ignore case: >
5637 :let idx = match(haystack, '\cneedle')
5638<
5639 If {start} is given, the search starts from byte index
5640 {start} in a String or item {start} in a |List|.
5641 The result, however, is still the index counted from the
5642 first character/item. Example: >
5643 :echo match("testing", "ing", 2)
5644< result is again "4". >
5645 :echo match("testing", "ing", 4)
5646< result is again "4". >
5647 :echo match("testing", "t", 2)
5648< result is "3".
5649 For a String, if {start} > 0 then it is like the string starts
5650 {start} bytes later, thus "^" will match at {start}. Except
5651 when {count} is given, then it's like matches before the
5652 {start} byte are ignored (this is a bit complicated to keep it
5653 backwards compatible).
5654 For a String, if {start} < 0, it will be set to 0. For a list
5655 the index is counted from the end.
5656 If {start} is out of range ({start} > strlen({expr}) for a
5657 String or {start} > len({expr}) for a |List|) -1 is returned.
5658
5659 When {count} is given use the {count}'th match. When a match
5660 is found in a String the search for the next one starts one
5661 character further. Thus this example results in 1: >
5662 echo match("testing", "..", 0, 2)
5663< In a |List| the search continues in the next item.
5664 Note that when {count} is added the way {start} works changes,
5665 see above.
5666
5667 See |pattern| for the patterns that are accepted.
5668 The 'ignorecase' option is used to set the ignore-caseness of
5669 the pattern. 'smartcase' is NOT used. The matching is always
5670 done like 'magic' is set and 'cpoptions' is empty.
5671 Note that a match at the start is preferred, thus when the
5672 pattern is using "*" (any number of matches) it tends to find
5673 zero matches at the start instead of a number of matches
5674 further down in the text.
5675
5676 Can also be used as a |method|: >
5677 GetText()->match('word')
5678 GetList()->match('word')
5679<
Bram Moolenaar2f0936c2022-01-08 21:51:59 +00005680 *matchadd()* *E290* *E798* *E799* *E801* *E957*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005681matchadd({group}, {pattern} [, {priority} [, {id} [, {dict}]]])
5682 Defines a pattern to be highlighted in the current window (a
5683 "match"). It will be highlighted with {group}. Returns an
5684 identification number (ID), which can be used to delete the
5685 match using |matchdelete()|. The ID is bound to the window.
5686 Matching is case sensitive and magic, unless case sensitivity
5687 or magicness are explicitly overridden in {pattern}. The
5688 'magic', 'smartcase' and 'ignorecase' options are not used.
5689 The "Conceal" value is special, it causes the match to be
5690 concealed.
5691
5692 The optional {priority} argument assigns a priority to the
5693 match. A match with a high priority will have its
5694 highlighting overrule that of a match with a lower priority.
5695 A priority is specified as an integer (negative numbers are no
5696 exception). If the {priority} argument is not specified, the
5697 default priority is 10. The priority of 'hlsearch' is zero,
5698 hence all matches with a priority greater than zero will
5699 overrule it. Syntax highlighting (see 'syntax') is a separate
5700 mechanism, and regardless of the chosen priority a match will
5701 always overrule syntax highlighting.
5702
5703 The optional {id} argument allows the request for a specific
5704 match ID. If a specified ID is already taken, an error
5705 message will appear and the match will not be added. An ID
5706 is specified as a positive integer (zero excluded). IDs 1, 2
5707 and 3 are reserved for |:match|, |:2match| and |:3match|,
5708 respectively. If the {id} argument is not specified or -1,
5709 |matchadd()| automatically chooses a free ID.
5710
5711 The optional {dict} argument allows for further custom
5712 values. Currently this is used to specify a match specific
5713 conceal character that will be shown for |hl-Conceal|
5714 highlighted matches. The dict can have the following members:
5715
5716 conceal Special character to show instead of the
5717 match (only for |hl-Conceal| highlighted
5718 matches, see |:syn-cchar|)
5719 window Instead of the current window use the
5720 window with this number or window ID.
5721
5722 The number of matches is not limited, as it is the case with
5723 the |:match| commands.
5724
5725 Example: >
5726 :highlight MyGroup ctermbg=green guibg=green
5727 :let m = matchadd("MyGroup", "TODO")
5728< Deletion of the pattern: >
5729 :call matchdelete(m)
5730
5731< A list of matches defined by |matchadd()| and |:match| are
5732 available from |getmatches()|. All matches can be deleted in
5733 one operation by |clearmatches()|.
5734
5735 Can also be used as a |method|: >
5736 GetGroup()->matchadd('TODO')
5737<
5738 *matchaddpos()*
5739matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]])
5740 Same as |matchadd()|, but requires a list of positions {pos}
5741 instead of a pattern. This command is faster than |matchadd()|
5742 because it does not require to handle regular expressions and
5743 sets buffer line boundaries to redraw screen. It is supposed
5744 to be used when fast match additions and deletions are
5745 required, for example to highlight matching parentheses.
5746
5747 {pos} is a list of positions. Each position can be one of
5748 these:
5749 - A number. This whole line will be highlighted. The first
5750 line has number 1.
5751 - A list with one number, e.g., [23]. The whole line with this
5752 number will be highlighted.
5753 - A list with two numbers, e.g., [23, 11]. The first number is
5754 the line number, the second one is the column number (first
5755 column is 1, the value must correspond to the byte index as
5756 |col()| would return). The character at this position will
5757 be highlighted.
5758 - A list with three numbers, e.g., [23, 11, 3]. As above, but
5759 the third number gives the length of the highlight in bytes.
5760
5761 The maximum number of positions in {pos} is 8.
5762
5763 Example: >
5764 :highlight MyGroup ctermbg=green guibg=green
5765 :let m = matchaddpos("MyGroup", [[23, 24], 34])
5766< Deletion of the pattern: >
5767 :call matchdelete(m)
5768
5769< Matches added by |matchaddpos()| are returned by
5770 |getmatches()|.
5771
5772 Can also be used as a |method|: >
5773 GetGroup()->matchaddpos([23, 11])
5774
5775matcharg({nr}) *matcharg()*
5776 Selects the {nr} match item, as set with a |:match|,
5777 |:2match| or |:3match| command.
5778 Return a |List| with two elements:
5779 The name of the highlight group used
5780 The pattern used.
5781 When {nr} is not 1, 2 or 3 returns an empty |List|.
5782 When there is no match item set returns ['', ''].
5783 This is useful to save and restore a |:match|.
5784 Highlighting matches using the |:match| commands are limited
5785 to three matches. |matchadd()| does not have this limitation.
5786
5787 Can also be used as a |method|: >
5788 GetMatch()->matcharg()
5789
5790matchdelete({id} [, {win}) *matchdelete()* *E802* *E803*
5791 Deletes a match with ID {id} previously defined by |matchadd()|
5792 or one of the |:match| commands. Returns 0 if successful,
5793 otherwise -1. See example for |matchadd()|. All matches can
5794 be deleted in one operation by |clearmatches()|.
5795 If {win} is specified, use the window with this number or
5796 window ID instead of the current window.
5797
5798 Can also be used as a |method|: >
5799 GetMatch()->matchdelete()
5800
5801matchend({expr}, {pat} [, {start} [, {count}]]) *matchend()*
5802 Same as |match()|, but return the index of first character
5803 after the match. Example: >
5804 :echo matchend("testing", "ing")
5805< results in "7".
5806 *strspn()* *strcspn()*
5807 Vim doesn't have a strspn() or strcspn() function, but you can
5808 do it with matchend(): >
5809 :let span = matchend(line, '[a-zA-Z]')
5810 :let span = matchend(line, '[^a-zA-Z]')
5811< Except that -1 is returned when there are no matches.
5812
5813 The {start}, if given, has the same meaning as for |match()|. >
5814 :echo matchend("testing", "ing", 2)
5815< results in "7". >
5816 :echo matchend("testing", "ing", 5)
5817< result is "-1".
5818 When {expr} is a |List| the result is equal to |match()|.
5819
5820 Can also be used as a |method|: >
5821 GetText()->matchend('word')
5822
5823
5824matchfuzzy({list}, {str} [, {dict}]) *matchfuzzy()*
5825 If {list} is a list of strings, then returns a |List| with all
5826 the strings in {list} that fuzzy match {str}. The strings in
5827 the returned list are sorted based on the matching score.
5828
5829 The optional {dict} argument always supports the following
5830 items:
zeertzjq9af2bc02022-05-11 14:15:37 +01005831 matchseq When this item is present return only matches
5832 that contain the characters in {str} in the
5833 given sequence.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005834
5835 If {list} is a list of dictionaries, then the optional {dict}
5836 argument supports the following additional items:
Yasuhiro Matsumoto9029a6e2022-04-16 12:35:35 +01005837 key Key of the item which is fuzzy matched against
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005838 {str}. The value of this item should be a
5839 string.
5840 text_cb |Funcref| that will be called for every item
5841 in {list} to get the text for fuzzy matching.
5842 This should accept a dictionary item as the
5843 argument and return the text for that item to
5844 use for fuzzy matching.
Yasuhiro Matsumoto9029a6e2022-04-16 12:35:35 +01005845 limit Maximum number of matches in {list} to be
5846 returned. Zero means no limit.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005847
5848 {str} is treated as a literal string and regular expression
5849 matching is NOT supported. The maximum supported {str} length
5850 is 256.
5851
5852 When {str} has multiple words each separated by white space,
5853 then the list of strings that have all the words is returned.
5854
5855 If there are no matching strings or there is an error, then an
5856 empty list is returned. If length of {str} is greater than
5857 256, then returns an empty list.
5858
Yasuhiro Matsumoto9029a6e2022-04-16 12:35:35 +01005859 When {limit} is given, matchfuzzy() will find up to this
5860 number of matches in {list} and return them in sorted order.
5861
Bram Moolenaar1588bc82022-03-08 21:35:07 +00005862 Refer to |fuzzy-matching| for more information about fuzzy
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00005863 matching strings.
5864
5865 Example: >
5866 :echo matchfuzzy(["clay", "crow"], "cay")
5867< results in ["clay"]. >
5868 :echo getbufinfo()->map({_, v -> v.name})->matchfuzzy("ndl")
5869< results in a list of buffer names fuzzy matching "ndl". >
5870 :echo getbufinfo()->matchfuzzy("ndl", {'key' : 'name'})
5871< results in a list of buffer information dicts with buffer
5872 names fuzzy matching "ndl". >
5873 :echo getbufinfo()->matchfuzzy("spl",
5874 \ {'text_cb' : {v -> v.name}})
5875< results in a list of buffer information dicts with buffer
5876 names fuzzy matching "spl". >
5877 :echo v:oldfiles->matchfuzzy("test")
5878< results in a list of file names fuzzy matching "test". >
5879 :let l = readfile("buffer.c")->matchfuzzy("str")
5880< results in a list of lines in "buffer.c" fuzzy matching "str". >
5881 :echo ['one two', 'two one']->matchfuzzy('two one')
5882< results in ['two one', 'one two']. >
5883 :echo ['one two', 'two one']->matchfuzzy('two one',
5884 \ {'matchseq': 1})
5885< results in ['two one'].
5886
5887matchfuzzypos({list}, {str} [, {dict}]) *matchfuzzypos()*
5888 Same as |matchfuzzy()|, but returns the list of matched
5889 strings, the list of character positions where characters
5890 in {str} matches and a list of matching scores. You can
5891 use |byteidx()| to convert a character position to a byte
5892 position.
5893
5894 If {str} matches multiple times in a string, then only the
5895 positions for the best match is returned.
5896
5897 If there are no matching strings or there is an error, then a
5898 list with three empty list items is returned.
5899
5900 Example: >
5901 :echo matchfuzzypos(['testing'], 'tsg')
5902< results in [['testing'], [[0, 2, 6]], [99]] >
5903 :echo matchfuzzypos(['clay', 'lacy'], 'la')
5904< results in [['lacy', 'clay'], [[0, 1], [1, 2]], [153, 133]] >
5905 :echo [{'text': 'hello', 'id' : 10}]->matchfuzzypos('ll', {'key' : 'text'})
5906< results in [[{'id': 10, 'text': 'hello'}], [[2, 3]], [127]]
5907
5908matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()*
5909 Same as |match()|, but return a |List|. The first item in the
5910 list is the matched string, same as what matchstr() would
5911 return. Following items are submatches, like "\1", "\2", etc.
5912 in |:substitute|. When an optional submatch didn't match an
5913 empty string is used. Example: >
5914 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
5915< Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
5916 When there is no match an empty list is returned.
5917
5918 You can pass in a List, but that is not very useful.
5919
5920 Can also be used as a |method|: >
5921 GetText()->matchlist('word')
5922
5923matchstr({expr}, {pat} [, {start} [, {count}]]) *matchstr()*
5924 Same as |match()|, but return the matched string. Example: >
5925 :echo matchstr("testing", "ing")
5926< results in "ing".
5927 When there is no match "" is returned.
5928 The {start}, if given, has the same meaning as for |match()|. >
5929 :echo matchstr("testing", "ing", 2)
5930< results in "ing". >
5931 :echo matchstr("testing", "ing", 5)
5932< result is "".
5933 When {expr} is a |List| then the matching item is returned.
5934 The type isn't changed, it's not necessarily a String.
5935
5936 Can also be used as a |method|: >
5937 GetText()->matchstr('word')
5938
5939matchstrpos({expr}, {pat} [, {start} [, {count}]]) *matchstrpos()*
5940 Same as |matchstr()|, but return the matched string, the start
5941 position and the end position of the match. Example: >
5942 :echo matchstrpos("testing", "ing")
5943< results in ["ing", 4, 7].
5944 When there is no match ["", -1, -1] is returned.
5945 The {start}, if given, has the same meaning as for |match()|. >
5946 :echo matchstrpos("testing", "ing", 2)
5947< results in ["ing", 4, 7]. >
5948 :echo matchstrpos("testing", "ing", 5)
5949< result is ["", -1, -1].
5950 When {expr} is a |List| then the matching item, the index
5951 of first item where {pat} matches, the start position and the
5952 end position of the match are returned. >
5953 :echo matchstrpos([1, '__x'], '\a')
5954< result is ["x", 1, 2, 3].
5955 The type isn't changed, it's not necessarily a String.
5956
5957 Can also be used as a |method|: >
5958 GetText()->matchstrpos('word')
5959<
5960
5961 *max()*
5962max({expr}) Return the maximum value of all items in {expr}. Example: >
5963 echo max([apples, pears, oranges])
5964
5965< {expr} can be a |List| or a |Dictionary|. For a Dictionary,
5966 it returns the maximum of all values in the Dictionary.
5967 If {expr} is neither a List nor a Dictionary, or one of the
5968 items in {expr} cannot be used as a Number this results in
5969 an error. An empty |List| or |Dictionary| results in zero.
5970
5971 Can also be used as a |method|: >
5972 mylist->max()
5973
5974
5975menu_info({name} [, {mode}]) *menu_info()*
5976 Return information about the specified menu {name} in
5977 mode {mode}. The menu name should be specified without the
5978 shortcut character ('&'). If {name} is "", then the top-level
5979 menu names are returned.
5980
5981 {mode} can be one of these strings:
5982 "n" Normal
5983 "v" Visual (including Select)
5984 "o" Operator-pending
5985 "i" Insert
5986 "c" Cmd-line
5987 "s" Select
5988 "x" Visual
5989 "t" Terminal-Job
5990 "" Normal, Visual and Operator-pending
5991 "!" Insert and Cmd-line
5992 When {mode} is omitted, the modes for "" are used.
5993
5994 Returns a |Dictionary| containing the following items:
5995 accel menu item accelerator text |menu-text|
5996 display display name (name without '&')
5997 enabled v:true if this menu item is enabled
5998 Refer to |:menu-enable|
5999 icon name of the icon file (for toolbar)
6000 |toolbar-icon|
6001 iconidx index of a built-in icon
6002 modes modes for which the menu is defined. In
6003 addition to the modes mentioned above, these
6004 characters will be used:
6005 " " Normal, Visual and Operator-pending
6006 name menu item name.
6007 noremenu v:true if the {rhs} of the menu item is not
6008 remappable else v:false.
6009 priority menu order priority |menu-priority|
6010 rhs right-hand-side of the menu item. The returned
6011 string has special characters translated like
6012 in the output of the ":menu" command listing.
6013 When the {rhs} of a menu item is empty, then
6014 "<Nop>" is returned.
6015 script v:true if script-local remapping of {rhs} is
6016 allowed else v:false. See |:menu-script|.
6017 shortcut shortcut key (character after '&' in
6018 the menu name) |menu-shortcut|
6019 silent v:true if the menu item is created
6020 with <silent> argument |:menu-silent|
6021 submenus |List| containing the names of
6022 all the submenus. Present only if the menu
6023 item has submenus.
6024
6025 Returns an empty dictionary if the menu item is not found.
6026
6027 Examples: >
6028 :echo menu_info('Edit.Cut')
6029 :echo menu_info('File.Save', 'n')
6030
6031 " Display the entire menu hierarchy in a buffer
6032 func ShowMenu(name, pfx)
6033 let m = menu_info(a:name)
6034 call append(line('$'), a:pfx .. m.display)
6035 for child in m->get('submenus', [])
6036 call ShowMenu(a:name .. '.' .. escape(child, '.'),
6037 \ a:pfx .. ' ')
6038 endfor
6039 endfunc
6040 new
6041 for topmenu in menu_info('').submenus
6042 call ShowMenu(topmenu, '')
6043 endfor
6044<
6045 Can also be used as a |method|: >
6046 GetMenuName()->menu_info('v')
6047
6048
6049< *min()*
6050min({expr}) Return the minimum value of all items in {expr}. Example: >
6051 echo min([apples, pears, oranges])
6052
6053< {expr} can be a |List| or a |Dictionary|. For a Dictionary,
6054 it returns the minimum of all values in the Dictionary.
6055 If {expr} is neither a List nor a Dictionary, or one of the
6056 items in {expr} cannot be used as a Number this results in
6057 an error. An empty |List| or |Dictionary| results in zero.
6058
6059 Can also be used as a |method|: >
6060 mylist->min()
6061
6062< *mkdir()* *E739*
6063mkdir({name} [, {path} [, {prot}]])
6064 Create directory {name}.
6065
6066 If {path} is "p" then intermediate directories are created as
6067 necessary. Otherwise it must be "".
6068
6069 If {prot} is given it is used to set the protection bits of
6070 the new directory. The default is 0o755 (rwxr-xr-x: r/w for
6071 the user, readable for others). Use 0o700 to make it
6072 unreadable for others. This is only used for the last part of
6073 {name}. Thus if you create /tmp/foo/bar then /tmp/foo will be
6074 created with 0o755.
6075 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006076 :call mkdir($HOME .. "/tmp/foo/bar", "p", 0o700)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006077
6078< This function is not available in the |sandbox|.
6079
6080 There is no error if the directory already exists and the "p"
6081 flag is passed (since patch 8.0.1708). However, without the
6082 "p" option the call will fail.
6083
6084 The function result is a Number, which is TRUE if the call was
6085 successful or FALSE if the directory creation failed or partly
6086 failed.
6087
6088 Not available on all systems. To check use: >
6089 :if exists("*mkdir")
6090
6091< Can also be used as a |method|: >
6092 GetName()->mkdir()
6093<
6094 *mode()*
6095mode([expr]) Return a string that indicates the current mode.
6096 If [expr] is supplied and it evaluates to a non-zero Number or
6097 a non-empty String (|non-zero-arg|), then the full mode is
6098 returned, otherwise only the first letter is returned.
6099 Also see |state()|.
6100
6101 n Normal
6102 no Operator-pending
6103 nov Operator-pending (forced characterwise |o_v|)
6104 noV Operator-pending (forced linewise |o_V|)
6105 noCTRL-V Operator-pending (forced blockwise |o_CTRL-V|);
6106 CTRL-V is one character
6107 niI Normal using |i_CTRL-O| in |Insert-mode|
6108 niR Normal using |i_CTRL-O| in |Replace-mode|
6109 niV Normal using |i_CTRL-O| in |Virtual-Replace-mode|
6110 nt Terminal-Normal (insert goes to Terminal-Job mode)
6111 v Visual by character
6112 vs Visual by character using |v_CTRL-O| in Select mode
6113 V Visual by line
6114 Vs Visual by line using |v_CTRL-O| in Select mode
6115 CTRL-V Visual blockwise
6116 CTRL-Vs Visual blockwise using |v_CTRL-O| in Select mode
6117 s Select by character
6118 S Select by line
6119 CTRL-S Select blockwise
6120 i Insert
6121 ic Insert mode completion |compl-generic|
6122 ix Insert mode |i_CTRL-X| completion
6123 R Replace |R|
6124 Rc Replace mode completion |compl-generic|
6125 Rx Replace mode |i_CTRL-X| completion
6126 Rv Virtual Replace |gR|
6127 Rvc Virtual Replace mode completion |compl-generic|
6128 Rvx Virtual Replace mode |i_CTRL-X| completion
6129 c Command-line editing
6130 cv Vim Ex mode |gQ|
6131 ce Normal Ex mode |Q|
6132 r Hit-enter prompt
6133 rm The -- more -- prompt
6134 r? A |:confirm| query of some sort
6135 ! Shell or external command is executing
6136 t Terminal-Job mode: keys go to the job
6137
6138 This is useful in the 'statusline' option or when used
6139 with |remote_expr()| In most other places it always returns
6140 "c" or "n".
6141 Note that in the future more modes and more specific modes may
6142 be added. It's better not to compare the whole string but only
6143 the leading character(s).
6144 Also see |visualmode()|.
6145
6146 Can also be used as a |method|: >
6147 DoFull()->mode()
6148
6149mzeval({expr}) *mzeval()*
6150 Evaluate MzScheme expression {expr} and return its result
6151 converted to Vim data structures.
6152 Numbers and strings are returned as they are.
6153 Pairs (including lists and improper lists) and vectors are
6154 returned as Vim |Lists|.
6155 Hash tables are represented as Vim |Dictionary| type with keys
6156 converted to strings.
6157 All other types are converted to string with display function.
6158 Examples: >
6159 :mz (define l (list 1 2 3))
6160 :mz (define h (make-hash)) (hash-set! h "list" l)
6161 :echo mzeval("l")
6162 :echo mzeval("h")
6163<
6164 Note that in a `:def` function local variables are not visible
6165 to {expr}.
6166
6167 Can also be used as a |method|: >
6168 GetExpr()->mzeval()
6169<
6170 {only available when compiled with the |+mzscheme| feature}
6171
6172nextnonblank({lnum}) *nextnonblank()*
6173 Return the line number of the first line at or below {lnum}
6174 that is not blank. Example: >
6175 if getline(nextnonblank(1)) =~ "Java"
6176< When {lnum} is invalid or there is no non-blank line at or
6177 below it, zero is returned.
6178 {lnum} is used like with |getline()|.
6179 See also |prevnonblank()|.
6180
6181 Can also be used as a |method|: >
6182 GetLnum()->nextnonblank()
6183
6184nr2char({expr} [, {utf8}]) *nr2char()*
6185 Return a string with a single character, which has the number
6186 value {expr}. Examples: >
6187 nr2char(64) returns "@"
6188 nr2char(32) returns " "
6189< When {utf8} is omitted or zero, the current 'encoding' is used.
6190 Example for "utf-8": >
6191 nr2char(300) returns I with bow character
6192< When {utf8} is TRUE, always return UTF-8 characters.
6193 Note that a NUL character in the file is specified with
6194 nr2char(10), because NULs are represented with newline
6195 characters. nr2char(0) is a real NUL and terminates the
6196 string, thus results in an empty string.
6197 To turn a list of character numbers into a string: >
6198 let list = [65, 66, 67]
6199 let str = join(map(list, {_, val -> nr2char(val)}), '')
6200< Result: "ABC"
6201
6202 Can also be used as a |method|: >
6203 GetNumber()->nr2char()
6204
6205or({expr}, {expr}) *or()*
6206 Bitwise OR on the two arguments. The arguments are converted
6207 to a number. A List, Dict or Float argument causes an error.
6208 Example: >
6209 :let bits = or(bits, 0x80)
6210< Can also be used as a |method|: >
6211 :let bits = bits->or(0x80)
6212
6213
6214pathshorten({path} [, {len}]) *pathshorten()*
6215 Shorten directory names in the path {path} and return the
6216 result. The tail, the file name, is kept as-is. The other
6217 components in the path are reduced to {len} letters in length.
6218 If {len} is omitted or smaller than 1 then 1 is used (single
6219 letters). Leading '~' and '.' characters are kept. Examples: >
6220 :echo pathshorten('~/.vim/autoload/myfile.vim')
6221< ~/.v/a/myfile.vim ~
6222>
6223 :echo pathshorten('~/.vim/autoload/myfile.vim', 2)
6224< ~/.vi/au/myfile.vim ~
6225 It doesn't matter if the path exists or not.
6226
6227 Can also be used as a |method|: >
6228 GetDirectories()->pathshorten()
6229
6230perleval({expr}) *perleval()*
6231 Evaluate Perl expression {expr} in scalar context and return
6232 its result converted to Vim data structures. If value can't be
6233 converted, it is returned as a string Perl representation.
6234 Note: If you want an array or hash, {expr} must return a
6235 reference to it.
6236 Example: >
6237 :echo perleval('[1 .. 4]')
6238< [1, 2, 3, 4]
6239
6240 Note that in a `:def` function local variables are not visible
6241 to {expr}.
6242
6243 Can also be used as a |method|: >
6244 GetExpr()->perleval()
6245
6246< {only available when compiled with the |+perl| feature}
6247
6248
6249popup_ functions are documented here: |popup-functions|
6250
6251
6252pow({x}, {y}) *pow()*
6253 Return the power of {x} to the exponent {y} as a |Float|.
6254 {x} and {y} must evaluate to a |Float| or a |Number|.
6255 Examples: >
6256 :echo pow(3, 3)
6257< 27.0 >
6258 :echo pow(2, 16)
6259< 65536.0 >
6260 :echo pow(32, 0.20)
6261< 2.0
6262
6263 Can also be used as a |method|: >
6264 Compute()->pow(3)
6265<
6266 {only available when compiled with the |+float| feature}
6267
6268prevnonblank({lnum}) *prevnonblank()*
6269 Return the line number of the first line at or above {lnum}
6270 that is not blank. Example: >
6271 let ind = indent(prevnonblank(v:lnum - 1))
6272< When {lnum} is invalid or there is no non-blank line at or
6273 above it, zero is returned.
6274 {lnum} is used like with |getline()|.
6275 Also see |nextnonblank()|.
6276
6277 Can also be used as a |method|: >
6278 GetLnum()->prevnonblank()
6279
6280printf({fmt}, {expr1} ...) *printf()*
6281 Return a String with {fmt}, where "%" items are replaced by
6282 the formatted form of their respective arguments. Example: >
6283 printf("%4d: E%d %.30s", lnum, errno, msg)
6284< May result in:
6285 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
6286
6287 When used as a |method| the base is passed as the second
6288 argument: >
6289 Compute()->printf("result: %d")
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006290<
6291 You can use `call()` to pass the items as a list.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006292
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006293 Often used items are:
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006294 %s string
6295 %6S string right-aligned in 6 display cells
6296 %6s string right-aligned in 6 bytes
6297 %.9s string truncated to 9 bytes
6298 %c single byte
6299 %d decimal number
6300 %5d decimal number padded with spaces to 5 characters
6301 %x hex number
6302 %04x hex number padded with zeros to at least 4 characters
6303 %X hex number using upper case letters
6304 %o octal number
6305 %08b binary number padded with zeros to at least 8 chars
6306 %f floating point number as 12.23, inf, -inf or nan
6307 %F floating point number as 12.23, INF, -INF or NAN
6308 %e floating point number as 1.23e3, inf, -inf or nan
6309 %E floating point number as 1.23E3, INF, -INF or NAN
6310 %g floating point number, as %f or %e depending on value
6311 %G floating point number, as %F or %E depending on value
6312 %% the % character itself
6313
6314 Conversion specifications start with '%' and end with the
6315 conversion type. All other characters are copied unchanged to
6316 the result.
6317
6318 The "%" starts a conversion specification. The following
6319 arguments appear in sequence:
6320
6321 % [flags] [field-width] [.precision] type
6322
6323 flags
6324 Zero or more of the following flags:
6325
6326 # The value should be converted to an "alternate
6327 form". For c, d, and s conversions, this option
6328 has no effect. For o conversions, the precision
6329 of the number is increased to force the first
6330 character of the output string to a zero (except
6331 if a zero value is printed with an explicit
6332 precision of zero).
6333 For b and B conversions, a non-zero result has
6334 the string "0b" (or "0B" for B conversions)
6335 prepended to it.
6336 For x and X conversions, a non-zero result has
6337 the string "0x" (or "0X" for X conversions)
6338 prepended to it.
6339
6340 0 (zero) Zero padding. For all conversions the converted
6341 value is padded on the left with zeros rather
6342 than blanks. If a precision is given with a
6343 numeric conversion (d, b, B, o, x, and X), the 0
6344 flag is ignored.
6345
6346 - A negative field width flag; the converted value
6347 is to be left adjusted on the field boundary.
6348 The converted value is padded on the right with
6349 blanks, rather than on the left with blanks or
6350 zeros. A - overrides a 0 if both are given.
6351
6352 ' ' (space) A blank should be left before a positive
6353 number produced by a signed conversion (d).
6354
6355 + A sign must always be placed before a number
6356 produced by a signed conversion. A + overrides
6357 a space if both are used.
6358
6359 field-width
6360 An optional decimal digit string specifying a minimum
6361 field width. If the converted value has fewer bytes
6362 than the field width, it will be padded with spaces on
6363 the left (or right, if the left-adjustment flag has
6364 been given) to fill out the field width. For the S
6365 conversion the count is in cells.
6366
6367 .precision
6368 An optional precision, in the form of a period '.'
6369 followed by an optional digit string. If the digit
6370 string is omitted, the precision is taken as zero.
6371 This gives the minimum number of digits to appear for
6372 d, o, x, and X conversions, the maximum number of
6373 bytes to be printed from a string for s conversions,
6374 or the maximum number of cells to be printed from a
6375 string for S conversions.
6376 For floating point it is the number of digits after
6377 the decimal point.
6378
6379 type
6380 A character that specifies the type of conversion to
6381 be applied, see below.
6382
6383 A field width or precision, or both, may be indicated by an
6384 asterisk '*' instead of a digit string. In this case, a
6385 Number argument supplies the field width or precision. A
6386 negative field width is treated as a left adjustment flag
6387 followed by a positive field width; a negative precision is
6388 treated as though it were missing. Example: >
6389 :echo printf("%d: %.*s", nr, width, line)
6390< This limits the length of the text used from "line" to
6391 "width" bytes.
6392
6393 The conversion specifiers and their meanings are:
6394
6395 *printf-d* *printf-b* *printf-B* *printf-o*
6396 *printf-x* *printf-X*
6397 dbBoxX The Number argument is converted to signed decimal
6398 (d), unsigned binary (b and B), unsigned octal (o), or
6399 unsigned hexadecimal (x and X) notation. The letters
6400 "abcdef" are used for x conversions; the letters
6401 "ABCDEF" are used for X conversions.
6402 The precision, if any, gives the minimum number of
6403 digits that must appear; if the converted value
6404 requires fewer digits, it is padded on the left with
6405 zeros.
6406 In no case does a non-existent or small field width
6407 cause truncation of a numeric field; if the result of
6408 a conversion is wider than the field width, the field
6409 is expanded to contain the conversion result.
6410 The 'h' modifier indicates the argument is 16 bits.
6411 The 'l' modifier indicates the argument is 32 bits.
6412 The 'L' modifier indicates the argument is 64 bits.
6413 Generally, these modifiers are not useful. They are
6414 ignored when type is known from the argument.
6415
6416 i alias for d
6417 D alias for ld
6418 U alias for lu
6419 O alias for lo
6420
6421 *printf-c*
6422 c The Number argument is converted to a byte, and the
6423 resulting character is written.
6424
6425 *printf-s*
6426 s The text of the String argument is used. If a
6427 precision is specified, no more bytes than the number
6428 specified are used.
6429 If the argument is not a String type, it is
6430 automatically converted to text with the same format
6431 as ":echo".
6432 *printf-S*
6433 S The text of the String argument is used. If a
6434 precision is specified, no more display cells than the
6435 number specified are used.
6436
6437 *printf-f* *E807*
6438 f F The Float argument is converted into a string of the
6439 form 123.456. The precision specifies the number of
6440 digits after the decimal point. When the precision is
6441 zero the decimal point is omitted. When the precision
6442 is not specified 6 is used. A really big number
6443 (out of range or dividing by zero) results in "inf"
6444 or "-inf" with %f (INF or -INF with %F).
6445 "0.0 / 0.0" results in "nan" with %f (NAN with %F).
6446 Example: >
6447 echo printf("%.2f", 12.115)
6448< 12.12
6449 Note that roundoff depends on the system libraries.
6450 Use |round()| when in doubt.
6451
6452 *printf-e* *printf-E*
6453 e E The Float argument is converted into a string of the
6454 form 1.234e+03 or 1.234E+03 when using 'E'. The
6455 precision specifies the number of digits after the
6456 decimal point, like with 'f'.
6457
6458 *printf-g* *printf-G*
6459 g G The Float argument is converted like with 'f' if the
6460 value is between 0.001 (inclusive) and 10000000.0
6461 (exclusive). Otherwise 'e' is used for 'g' and 'E'
6462 for 'G'. When no precision is specified superfluous
6463 zeroes and '+' signs are removed, except for the zero
6464 immediately after the decimal point. Thus 10000000.0
6465 results in 1.0e7.
6466
6467 *printf-%*
6468 % A '%' is written. No argument is converted. The
6469 complete conversion specification is "%%".
6470
6471 When a Number argument is expected a String argument is also
6472 accepted and automatically converted.
6473 When a Float or String argument is expected a Number argument
6474 is also accepted and automatically converted.
6475 Any other argument type results in an error message.
6476
6477 *E766* *E767*
6478 The number of {exprN} arguments must exactly match the number
6479 of "%" items. If there are not sufficient or too many
6480 arguments an error is given. Up to 18 arguments can be used.
6481
6482
6483prompt_getprompt({buf}) *prompt_getprompt()*
6484 Returns the effective prompt text for buffer {buf}. {buf} can
6485 be a buffer name or number. See |prompt-buffer|.
6486
6487 If the buffer doesn't exist or isn't a prompt buffer, an empty
6488 string is returned.
6489
6490 Can also be used as a |method|: >
6491 GetBuffer()->prompt_getprompt()
6492
6493< {only available when compiled with the |+channel| feature}
6494
6495
6496prompt_setcallback({buf}, {expr}) *prompt_setcallback()*
6497 Set prompt callback for buffer {buf} to {expr}. When {expr}
6498 is an empty string the callback is removed. This has only
6499 effect if {buf} has 'buftype' set to "prompt".
6500
6501 The callback is invoked when pressing Enter. The current
6502 buffer will always be the prompt buffer. A new line for a
6503 prompt is added before invoking the callback, thus the prompt
6504 for which the callback was invoked will be in the last but one
6505 line.
6506 If the callback wants to add text to the buffer, it must
6507 insert it above the last line, since that is where the current
6508 prompt is. This can also be done asynchronously.
6509 The callback is invoked with one argument, which is the text
6510 that was entered at the prompt. This can be an empty string
6511 if the user only typed Enter.
6512 Example: >
6513 call prompt_setcallback(bufnr(), function('s:TextEntered'))
6514 func s:TextEntered(text)
6515 if a:text == 'exit' || a:text == 'quit'
6516 stopinsert
6517 close
6518 else
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006519 call append(line('$') - 1, 'Entered: "' .. a:text .. '"')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006520 " Reset 'modified' to allow the buffer to be closed.
6521 set nomodified
6522 endif
6523 endfunc
6524
6525< Can also be used as a |method|: >
6526 GetBuffer()->prompt_setcallback(callback)
6527
6528< {only available when compiled with the |+channel| feature}
6529
6530prompt_setinterrupt({buf}, {expr}) *prompt_setinterrupt()*
6531 Set a callback for buffer {buf} to {expr}. When {expr} is an
6532 empty string the callback is removed. This has only effect if
6533 {buf} has 'buftype' set to "prompt".
6534
6535 This callback will be invoked when pressing CTRL-C in Insert
6536 mode. Without setting a callback Vim will exit Insert mode,
6537 as in any buffer.
6538
6539 Can also be used as a |method|: >
6540 GetBuffer()->prompt_setinterrupt(callback)
6541
6542< {only available when compiled with the |+channel| feature}
6543
6544prompt_setprompt({buf}, {text}) *prompt_setprompt()*
6545 Set prompt for buffer {buf} to {text}. You most likely want
6546 {text} to end in a space.
6547 The result is only visible if {buf} has 'buftype' set to
6548 "prompt". Example: >
6549 call prompt_setprompt(bufnr(), 'command: ')
6550<
6551 Can also be used as a |method|: >
6552 GetBuffer()->prompt_setprompt('command: ')
6553
6554< {only available when compiled with the |+channel| feature}
6555
6556prop_ functions are documented here: |text-prop-functions|
6557
6558pum_getpos() *pum_getpos()*
6559 If the popup menu (see |ins-completion-menu|) is not visible,
6560 returns an empty |Dictionary|, otherwise, returns a
6561 |Dictionary| with the following keys:
6562 height nr of items visible
6563 width screen cells
6564 row top screen row (0 first row)
6565 col leftmost screen column (0 first col)
6566 size total nr of items
6567 scrollbar |TRUE| if scrollbar is visible
6568
6569 The values are the same as in |v:event| during
6570 |CompleteChanged|.
6571
6572pumvisible() *pumvisible()*
6573 Returns non-zero when the popup menu is visible, zero
6574 otherwise. See |ins-completion-menu|.
6575 This can be used to avoid some things that would remove the
6576 popup menu.
6577
6578py3eval({expr}) *py3eval()*
6579 Evaluate Python expression {expr} and return its result
6580 converted to Vim data structures.
6581 Numbers and strings are returned as they are (strings are
6582 copied though, Unicode strings are additionally converted to
6583 'encoding').
6584 Lists are represented as Vim |List| type.
6585 Dictionaries are represented as Vim |Dictionary| type with
6586 keys converted to strings.
6587 Note that in a `:def` function local variables are not visible
6588 to {expr}.
6589
6590 Can also be used as a |method|: >
6591 GetExpr()->py3eval()
6592
6593< {only available when compiled with the |+python3| feature}
6594
6595 *E858* *E859*
6596pyeval({expr}) *pyeval()*
6597 Evaluate Python expression {expr} and return its result
6598 converted to Vim data structures.
6599 Numbers and strings are returned as they are (strings are
6600 copied though).
6601 Lists are represented as Vim |List| type.
6602 Dictionaries are represented as Vim |Dictionary| type,
6603 non-string keys result in error.
6604 Note that in a `:def` function local variables are not visible
6605 to {expr}.
6606
6607 Can also be used as a |method|: >
6608 GetExpr()->pyeval()
6609
6610< {only available when compiled with the |+python| feature}
6611
6612pyxeval({expr}) *pyxeval()*
6613 Evaluate Python expression {expr} and return its result
6614 converted to Vim data structures.
6615 Uses Python 2 or 3, see |python_x| and 'pyxversion'.
6616 See also: |pyeval()|, |py3eval()|
6617
6618 Can also be used as a |method|: >
6619 GetExpr()->pyxeval()
6620
6621< {only available when compiled with the |+python| or the
6622 |+python3| feature}
6623
6624rand([{expr}]) *rand()* *random*
6625 Return a pseudo-random Number generated with an xoshiro128**
6626 algorithm using seed {expr}. The returned number is 32 bits,
6627 also on 64 bits systems, for consistency.
6628 {expr} can be initialized by |srand()| and will be updated by
6629 rand(). If {expr} is omitted, an internal seed value is used
6630 and updated.
6631
6632 Examples: >
6633 :echo rand()
6634 :let seed = srand()
6635 :echo rand(seed)
6636 :echo rand(seed) % 16 " random number 0 - 15
6637<
6638
6639 *E726* *E727*
6640range({expr} [, {max} [, {stride}]]) *range()*
6641 Returns a |List| with Numbers:
6642 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
6643 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
6644 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
6645 {max}] (increasing {expr} with {stride} each time, not
6646 producing a value past {max}).
6647 When the maximum is one before the start the result is an
6648 empty list. When the maximum is more than one before the
6649 start this is an error.
6650 Examples: >
6651 range(4) " [0, 1, 2, 3]
6652 range(2, 4) " [2, 3, 4]
6653 range(2, 9, 3) " [2, 5, 8]
6654 range(2, -2, -1) " [2, 1, 0, -1, -2]
6655 range(0) " []
6656 range(2, 0) " error!
6657<
6658 Can also be used as a |method|: >
6659 GetExpr()->range()
6660<
6661
6662readblob({fname}) *readblob()*
6663 Read file {fname} in binary mode and return a |Blob|.
6664 When the file can't be opened an error message is given and
6665 the result is an empty |Blob|.
6666 Also see |readfile()| and |writefile()|.
6667
6668
6669readdir({directory} [, {expr} [, {dict}]]) *readdir()*
6670 Return a list with file and directory names in {directory}.
6671 You can also use |glob()| if you don't need to do complicated
6672 things, such as limiting the number of matches.
6673 The list will be sorted (case sensitive), see the {dict}
6674 argument below for changing the sort order.
6675
6676 When {expr} is omitted all entries are included.
6677 When {expr} is given, it is evaluated to check what to do:
6678 If {expr} results in -1 then no further entries will
6679 be handled.
6680 If {expr} results in 0 then this entry will not be
6681 added to the list.
6682 If {expr} results in 1 then this entry will be added
6683 to the list.
6684 The entries "." and ".." are always excluded.
6685 Each time {expr} is evaluated |v:val| is set to the entry name.
6686 When {expr} is a function the name is passed as the argument.
6687 For example, to get a list of files ending in ".txt": >
6688 readdir(dirname, {n -> n =~ '.txt$'})
6689< To skip hidden and backup files: >
6690 readdir(dirname, {n -> n !~ '^\.\|\~$'})
Bram Moolenaar6f4754b2022-01-23 12:07:04 +00006691< *E857*
6692 The optional {dict} argument allows for further custom
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006693 values. Currently this is used to specify if and how sorting
6694 should be performed. The dict can have the following members:
6695
6696 sort How to sort the result returned from the system.
6697 Valid values are:
6698 "none" do not sort (fastest method)
6699 "case" sort case sensitive (byte value of
6700 each character, technically, using
6701 strcmp()) (default)
6702 "icase" sort case insensitive (technically
6703 using strcasecmp())
6704 "collate" sort using the collation order
6705 of the "POSIX" or "C" |locale|
6706 (technically using strcoll())
6707 Other values are silently ignored.
6708
6709 For example, to get a list of all files in the current
6710 directory without sorting the individual entries: >
6711 readdir('.', '1', #{sort: 'none'})
6712< If you want to get a directory tree: >
6713 function! s:tree(dir)
6714 return {a:dir : map(readdir(a:dir),
6715 \ {_, x -> isdirectory(x) ?
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006716 \ {x : s:tree(a:dir .. '/' .. x)} : x})}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006717 endfunction
6718 echo s:tree(".")
6719<
6720 Can also be used as a |method|: >
6721 GetDirName()->readdir()
6722<
6723readdirex({directory} [, {expr} [, {dict}]]) *readdirex()*
6724 Extended version of |readdir()|.
6725 Return a list of Dictionaries with file and directory
6726 information in {directory}.
6727 This is useful if you want to get the attributes of file and
6728 directory at the same time as getting a list of a directory.
6729 This is much faster than calling |readdir()| then calling
6730 |getfperm()|, |getfsize()|, |getftime()| and |getftype()| for
6731 each file and directory especially on MS-Windows.
6732 The list will by default be sorted by name (case sensitive),
6733 the sorting can be changed by using the optional {dict}
6734 argument, see |readdir()|.
6735
6736 The Dictionary for file and directory information has the
6737 following items:
6738 group Group name of the entry. (Only on Unix)
6739 name Name of the entry.
6740 perm Permissions of the entry. See |getfperm()|.
6741 size Size of the entry. See |getfsize()|.
6742 time Timestamp of the entry. See |getftime()|.
6743 type Type of the entry.
6744 On Unix, almost same as |getftype()| except:
6745 Symlink to a dir "linkd"
6746 Other symlink "link"
6747 On MS-Windows:
6748 Normal file "file"
6749 Directory "dir"
6750 Junction "junction"
6751 Symlink to a dir "linkd"
6752 Other symlink "link"
6753 Other reparse point "reparse"
6754 user User name of the entry's owner. (Only on Unix)
6755 On Unix, if the entry is a symlink, the Dictionary includes
6756 the information of the target (except the "type" item).
6757 On MS-Windows, it includes the information of the symlink
6758 itself because of performance reasons.
6759
6760 When {expr} is omitted all entries are included.
6761 When {expr} is given, it is evaluated to check what to do:
6762 If {expr} results in -1 then no further entries will
6763 be handled.
6764 If {expr} results in 0 then this entry will not be
6765 added to the list.
6766 If {expr} results in 1 then this entry will be added
6767 to the list.
6768 The entries "." and ".." are always excluded.
6769 Each time {expr} is evaluated |v:val| is set to a |Dictionary|
6770 of the entry.
6771 When {expr} is a function the entry is passed as the argument.
6772 For example, to get a list of files ending in ".txt": >
6773 readdirex(dirname, {e -> e.name =~ '.txt$'})
6774<
6775 For example, to get a list of all files in the current
6776 directory without sorting the individual entries: >
6777 readdirex(dirname, '1', #{sort: 'none'})
6778
6779<
6780 Can also be used as a |method|: >
6781 GetDirName()->readdirex()
6782<
6783
6784 *readfile()*
6785readfile({fname} [, {type} [, {max}]])
6786 Read file {fname} and return a |List|, each line of the file
6787 as an item. Lines are broken at NL characters. Macintosh
6788 files separated with CR will result in a single long line
6789 (unless a NL appears somewhere).
6790 All NUL characters are replaced with a NL character.
6791 When {type} contains "b" binary mode is used:
6792 - When the last line ends in a NL an extra empty list item is
6793 added.
6794 - No CR characters are removed.
6795 Otherwise:
6796 - CR characters that appear before a NL are removed.
6797 - Whether the last line ends in a NL or not does not matter.
6798 - When 'encoding' is Unicode any UTF-8 byte order mark is
6799 removed from the text.
6800 When {max} is given this specifies the maximum number of lines
6801 to be read. Useful if you only want to check the first ten
6802 lines of a file: >
6803 :for line in readfile(fname, '', 10)
6804 : if line =~ 'Date' | echo line | endif
6805 :endfor
6806< When {max} is negative -{max} lines from the end of the file
6807 are returned, or as many as there are.
6808 When {max} is zero the result is an empty list.
6809 Note that without {max} the whole file is read into memory.
6810 Also note that there is no recognition of encoding. Read a
6811 file into a buffer if you need to.
6812 Deprecated (use |readblob()| instead): When {type} contains
6813 "B" a |Blob| is returned with the binary data of the file
6814 unmodified.
6815 When the file can't be opened an error message is given and
6816 the result is an empty list.
6817 Also see |writefile()|.
6818
6819 Can also be used as a |method|: >
6820 GetFileName()->readfile()
6821
6822reduce({object}, {func} [, {initial}]) *reduce()* *E998*
6823 {func} is called for every item in {object}, which can be a
6824 |String|, |List| or a |Blob|. {func} is called with two
6825 arguments: the result so far and current item. After
Bram Moolenaarf10911e2022-01-29 22:20:48 +00006826 processing all items the result is returned. *E1132*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006827
6828 {initial} is the initial result. When omitted, the first item
6829 in {object} is used and {func} is first called for the second
6830 item. If {initial} is not given and {object} is empty no
6831 result can be computed, an E998 error is given.
6832
6833 Examples: >
6834 echo reduce([1, 3, 5], { acc, val -> acc + val })
6835 echo reduce(['x', 'y'], { acc, val -> acc .. val }, 'a')
6836 echo reduce(0z1122, { acc, val -> 2 * acc + val })
6837 echo reduce('xyz', { acc, val -> acc .. ',' .. val })
6838<
6839 Can also be used as a |method|: >
6840 echo mylist->reduce({ acc, val -> acc + val }, 0)
6841
6842
6843reg_executing() *reg_executing()*
6844 Returns the single letter name of the register being executed.
6845 Returns an empty string when no register is being executed.
6846 See |@|.
6847
6848reg_recording() *reg_recording()*
6849 Returns the single letter name of the register being recorded.
6850 Returns an empty string when not recording. See |q|.
6851
6852reltime([{start} [, {end}]]) *reltime()*
6853 Return an item that represents a time value. The item is a
6854 list with items that depend on the system. In Vim 9 script
6855 list<any> can be used.
6856 The item can be passed to |reltimestr()| to convert it to a
6857 string or |reltimefloat()| to convert to a Float.
6858
6859 Without an argument reltime() returns the current time.
6860 With one argument is returns the time passed since the time
6861 specified in the argument.
6862 With two arguments it returns the time passed between {start}
6863 and {end}.
6864
6865 The {start} and {end} arguments must be values returned by
6866 reltime(). If there is an error zero is returned in legacy
6867 script, in Vim9 script an error is given.
6868
6869 Can also be used as a |method|: >
6870 GetStart()->reltime()
6871<
6872 {only available when compiled with the |+reltime| feature}
6873
6874reltimefloat({time}) *reltimefloat()*
6875 Return a Float that represents the time value of {time}.
6876 Example: >
6877 let start = reltime()
6878 call MyFunction()
6879 let seconds = reltimefloat(reltime(start))
6880< See the note of reltimestr() about overhead.
6881 Also see |profiling|.
6882 If there is an error 0.0 is returned in legacy script, in Vim9
6883 script an error is given.
6884
6885 Can also be used as a |method|: >
6886 reltime(start)->reltimefloat()
6887
6888< {only available when compiled with the |+reltime| feature}
6889
6890reltimestr({time}) *reltimestr()*
6891 Return a String that represents the time value of {time}.
6892 This is the number of seconds, a dot and the number of
6893 microseconds. Example: >
6894 let start = reltime()
6895 call MyFunction()
6896 echo reltimestr(reltime(start))
6897< Note that overhead for the commands will be added to the time.
6898 The accuracy depends on the system.
6899 Leading spaces are used to make the string align nicely. You
6900 can use split() to remove it. >
6901 echo split(reltimestr(reltime(start)))[0]
6902< Also see |profiling|.
6903 If there is an error an empty string is returned in legacy
6904 script, in Vim9 script an error is given.
6905
6906 Can also be used as a |method|: >
6907 reltime(start)->reltimestr()
6908
6909< {only available when compiled with the |+reltime| feature}
6910
6911 *remote_expr()* *E449*
6912remote_expr({server}, {string} [, {idvar} [, {timeout}]])
Bram Moolenaar944697a2022-02-20 19:48:20 +00006913 Send the {string} to {server}. The {server} argument is a
6914 string, also see |{server}|.
6915
6916 The string is sent as an expression and the result is returned
6917 after evaluation. The result must be a String or a |List|. A
6918 |List| is turned into a String by joining the items with a
6919 line break in between (not at the end), like with join(expr,
6920 "\n").
6921
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006922 If {idvar} is present and not empty, it is taken as the name
6923 of a variable and a {serverid} for later use with
6924 |remote_read()| is stored there.
Bram Moolenaar944697a2022-02-20 19:48:20 +00006925
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006926 If {timeout} is given the read times out after this many
6927 seconds. Otherwise a timeout of 600 seconds is used.
Bram Moolenaar944697a2022-02-20 19:48:20 +00006928
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006929 See also |clientserver| |RemoteReply|.
6930 This function is not available in the |sandbox|.
6931 {only available when compiled with the |+clientserver| feature}
6932 Note: Any errors will cause a local error message to be issued
6933 and the result will be the empty string.
6934
6935 Variables will be evaluated in the global namespace,
6936 independent of a function currently being active. Except
6937 when in debug mode, then local function variables and
6938 arguments can be evaluated.
6939
6940 Examples: >
6941 :echo remote_expr("gvim", "2+2")
6942 :echo remote_expr("gvim1", "b:current_syntax")
6943<
6944 Can also be used as a |method|: >
6945 ServerName()->remote_expr(expr)
6946
6947remote_foreground({server}) *remote_foreground()*
6948 Move the Vim server with the name {server} to the foreground.
Bram Moolenaar944697a2022-02-20 19:48:20 +00006949 The {server} argument is a string, also see |{server}|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006950 This works like: >
6951 remote_expr({server}, "foreground()")
6952< Except that on Win32 systems the client does the work, to work
6953 around the problem that the OS doesn't always allow the server
6954 to bring itself to the foreground.
6955 Note: This does not restore the window if it was minimized,
6956 like foreground() does.
6957 This function is not available in the |sandbox|.
6958
6959 Can also be used as a |method|: >
6960 ServerName()->remote_foreground()
6961
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +01006962< {only in the Win32, Motif and GTK GUI versions and the
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006963 Win32 console version}
6964
6965
6966remote_peek({serverid} [, {retvar}]) *remote_peek()*
6967 Returns a positive number if there are available strings
6968 from {serverid}. Copies any reply string into the variable
6969 {retvar} if specified. {retvar} must be a string with the
6970 name of a variable.
6971 Returns zero if none are available.
6972 Returns -1 if something is wrong.
6973 See also |clientserver|.
6974 This function is not available in the |sandbox|.
6975 {only available when compiled with the |+clientserver| feature}
6976 Examples: >
6977 :let repl = ""
Bram Moolenaarc51cf032022-02-26 12:25:45 +00006978 :echo "PEEK: " .. remote_peek(id, "repl") .. ": " .. repl
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00006979
6980< Can also be used as a |method|: >
6981 ServerId()->remote_peek()
6982
6983remote_read({serverid}, [{timeout}]) *remote_read()*
6984 Return the oldest available reply from {serverid} and consume
6985 it. Unless a {timeout} in seconds is given, it blocks until a
6986 reply is available.
6987 See also |clientserver|.
6988 This function is not available in the |sandbox|.
6989 {only available when compiled with the |+clientserver| feature}
6990 Example: >
6991 :echo remote_read(id)
6992
6993< Can also be used as a |method|: >
6994 ServerId()->remote_read()
6995<
6996 *remote_send()* *E241*
6997remote_send({server}, {string} [, {idvar}])
Bram Moolenaar944697a2022-02-20 19:48:20 +00006998 Send the {string} to {server}. The {server} argument is a
6999 string, also see |{server}|.
7000
7001 The string is sent as input keys and the function returns
7002 immediately. At the Vim server the keys are not mapped
7003 |:map|.
7004
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007005 If {idvar} is present, it is taken as the name of a variable
7006 and a {serverid} for later use with remote_read() is stored
7007 there.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007008
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007009 See also |clientserver| |RemoteReply|.
7010 This function is not available in the |sandbox|.
7011 {only available when compiled with the |+clientserver| feature}
7012
7013 Note: Any errors will be reported in the server and may mess
7014 up the display.
7015 Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007016 :echo remote_send("gvim", ":DropAndReply " .. file, "serverid") ..
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007017 \ remote_read(serverid)
7018
7019 :autocmd NONE RemoteReply *
7020 \ echo remote_read(expand("<amatch>"))
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007021 :echo remote_send("gvim", ":sleep 10 | echo " ..
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007022 \ 'server2client(expand("<client>"), "HELLO")<CR>')
7023<
7024 Can also be used as a |method|: >
7025 ServerName()->remote_send(keys)
7026<
7027 *remote_startserver()* *E941* *E942*
7028remote_startserver({name})
7029 Become the server {name}. This fails if already running as a
7030 server, when |v:servername| is not empty.
7031
7032 Can also be used as a |method|: >
7033 ServerName()->remote_startserver()
7034
7035< {only available when compiled with the |+clientserver| feature}
7036
7037remove({list}, {idx} [, {end}]) *remove()*
7038 Without {end}: Remove the item at {idx} from |List| {list} and
7039 return the item.
7040 With {end}: Remove items from {idx} to {end} (inclusive) and
7041 return a |List| with these items. When {idx} points to the same
7042 item as {end} a list with one item is returned. When {end}
7043 points to an item before {idx} this is an error.
7044 See |list-index| for possible values of {idx} and {end}.
7045 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007046 :echo "last item: " .. remove(mylist, -1)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007047 :call remove(mylist, 0, 9)
7048<
7049 Use |delete()| to remove a file.
7050
7051 Can also be used as a |method|: >
7052 mylist->remove(idx)
7053
7054remove({blob}, {idx} [, {end}])
7055 Without {end}: Remove the byte at {idx} from |Blob| {blob} and
7056 return the byte.
7057 With {end}: Remove bytes from {idx} to {end} (inclusive) and
7058 return a |Blob| with these bytes. When {idx} points to the same
7059 byte as {end} a |Blob| with one byte is returned. When {end}
7060 points to a byte before {idx} this is an error.
7061 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007062 :echo "last byte: " .. remove(myblob, -1)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007063 :call remove(mylist, 0, 9)
7064
7065remove({dict}, {key})
7066 Remove the entry from {dict} with key {key} and return it.
7067 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007068 :echo "removed " .. remove(dict, "one")
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007069< If there is no {key} in {dict} this is an error.
7070
7071rename({from}, {to}) *rename()*
7072 Rename the file by the name {from} to the name {to}. This
7073 should also work to move files across file systems. The
7074 result is a Number, which is 0 if the file was renamed
7075 successfully, and non-zero when the renaming failed.
7076 NOTE: If {to} exists it is overwritten without warning.
7077 This function is not available in the |sandbox|.
7078
7079 Can also be used as a |method|: >
7080 GetOldName()->rename(newname)
7081
7082repeat({expr}, {count}) *repeat()*
7083 Repeat {expr} {count} times and return the concatenated
7084 result. Example: >
7085 :let separator = repeat('-', 80)
7086< When {count} is zero or negative the result is empty.
7087 When {expr} is a |List| the result is {expr} concatenated
7088 {count} times. Example: >
7089 :let longlist = repeat(['a', 'b'], 3)
7090< Results in ['a', 'b', 'a', 'b', 'a', 'b'].
7091
7092 Can also be used as a |method|: >
7093 mylist->repeat(count)
7094
7095resolve({filename}) *resolve()* *E655*
7096 On MS-Windows, when {filename} is a shortcut (a .lnk file),
7097 returns the path the shortcut points to in a simplified form.
7098 When {filename} is a symbolic link or junction point, return
7099 the full path to the target. If the target of junction is
7100 removed, return {filename}.
7101 On Unix, repeat resolving symbolic links in all path
7102 components of {filename} and return the simplified result.
7103 To cope with link cycles, resolving of symbolic links is
7104 stopped after 100 iterations.
7105 On other systems, return the simplified {filename}.
7106 The simplification step is done as by |simplify()|.
7107 resolve() keeps a leading path component specifying the
7108 current directory (provided the result is still a relative
7109 path name) and also keeps a trailing path separator.
7110
7111 Can also be used as a |method|: >
7112 GetName()->resolve()
7113
7114reverse({object}) *reverse()*
7115 Reverse the order of items in {object} in-place.
7116 {object} can be a |List| or a |Blob|.
7117 Returns {object}.
7118 If you want an object to remain unmodified make a copy first: >
7119 :let revlist = reverse(copy(mylist))
7120< Can also be used as a |method|: >
7121 mylist->reverse()
7122
7123round({expr}) *round()*
7124 Round off {expr} to the nearest integral value and return it
7125 as a |Float|. If {expr} lies halfway between two integral
7126 values, then use the larger one (away from zero).
7127 {expr} must evaluate to a |Float| or a |Number|.
7128 Examples: >
7129 echo round(0.456)
7130< 0.0 >
7131 echo round(4.5)
7132< 5.0 >
7133 echo round(-4.5)
7134< -5.0
7135
7136 Can also be used as a |method|: >
7137 Compute()->round()
7138<
7139 {only available when compiled with the |+float| feature}
7140
7141rubyeval({expr}) *rubyeval()*
7142 Evaluate Ruby expression {expr} and return its result
7143 converted to Vim data structures.
7144 Numbers, floats and strings are returned as they are (strings
7145 are copied though).
7146 Arrays are represented as Vim |List| type.
7147 Hashes are represented as Vim |Dictionary| type.
7148 Other objects are represented as strings resulted from their
7149 "Object#to_s" method.
7150 Note that in a `:def` function local variables are not visible
7151 to {expr}.
7152
7153 Can also be used as a |method|: >
7154 GetRubyExpr()->rubyeval()
7155
7156< {only available when compiled with the |+ruby| feature}
7157
7158screenattr({row}, {col}) *screenattr()*
7159 Like |screenchar()|, but return the attribute. This is a rather
7160 arbitrary number that can only be used to compare to the
7161 attribute at other positions.
7162
7163 Can also be used as a |method|: >
7164 GetRow()->screenattr(col)
7165
7166screenchar({row}, {col}) *screenchar()*
7167 The result is a Number, which is the character at position
7168 [row, col] on the screen. This works for every possible
7169 screen position, also status lines, window separators and the
7170 command line. The top left position is row one, column one
7171 The character excludes composing characters. For double-byte
7172 encodings it may only be the first byte.
7173 This is mainly to be used for testing.
7174 Returns -1 when row or col is out of range.
7175
7176 Can also be used as a |method|: >
7177 GetRow()->screenchar(col)
7178
7179screenchars({row}, {col}) *screenchars()*
7180 The result is a |List| of Numbers. The first number is the same
7181 as what |screenchar()| returns. Further numbers are
7182 composing characters on top of the base character.
7183 This is mainly to be used for testing.
7184 Returns an empty List when row or col is out of range.
7185
7186 Can also be used as a |method|: >
7187 GetRow()->screenchars(col)
7188
7189screencol() *screencol()*
7190 The result is a Number, which is the current screen column of
7191 the cursor. The leftmost column has number 1.
7192 This function is mainly used for testing.
7193
7194 Note: Always returns the current screen column, thus if used
7195 in a command (e.g. ":echo screencol()") it will return the
7196 column inside the command line, which is 1 when the command is
7197 executed. To get the cursor position in the file use one of
7198 the following mappings: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007199 nnoremap <expr> GG ":echom " .. screencol() .. "\n"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007200 nnoremap <silent> GG :echom screencol()<CR>
7201 nnoremap GG <Cmd>echom screencol()<CR>
7202<
7203screenpos({winid}, {lnum}, {col}) *screenpos()*
7204 The result is a Dict with the screen position of the text
7205 character in window {winid} at buffer line {lnum} and column
7206 {col}. {col} is a one-based byte index.
7207 The Dict has these members:
7208 row screen row
7209 col first screen column
7210 endcol last screen column
7211 curscol cursor screen column
7212 If the specified position is not visible, all values are zero.
7213 The "endcol" value differs from "col" when the character
7214 occupies more than one screen cell. E.g. for a Tab "col" can
7215 be 1 and "endcol" can be 8.
7216 The "curscol" value is where the cursor would be placed. For
7217 a Tab it would be the same as "endcol", while for a double
7218 width character it would be the same as "col".
7219 The |conceal| feature is ignored here, the column numbers are
7220 as if 'conceallevel' is zero. You can set the cursor to the
7221 right position and use |screencol()| to get the value with
7222 |conceal| taken into account.
Bram Moolenaar944697a2022-02-20 19:48:20 +00007223 If the position is in a closed fold the screen position of the
7224 first character is returned, {col} is not used.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007225
7226 Can also be used as a |method|: >
7227 GetWinid()->screenpos(lnum, col)
7228
7229screenrow() *screenrow()*
7230 The result is a Number, which is the current screen row of the
7231 cursor. The top line has number one.
7232 This function is mainly used for testing.
7233 Alternatively you can use |winline()|.
7234
7235 Note: Same restrictions as with |screencol()|.
7236
7237screenstring({row}, {col}) *screenstring()*
7238 The result is a String that contains the base character and
7239 any composing characters at position [row, col] on the screen.
7240 This is like |screenchars()| but returning a String with the
7241 characters.
7242 This is mainly to be used for testing.
7243 Returns an empty String when row or col is out of range.
7244
7245 Can also be used as a |method|: >
7246 GetRow()->screenstring(col)
7247<
7248 *search()*
7249search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
7250 Search for regexp pattern {pattern}. The search starts at the
7251 cursor position (you can use |cursor()| to set it).
7252
7253 When a match has been found its line number is returned.
7254 If there is no match a 0 is returned and the cursor doesn't
7255 move. No error message is given.
7256
7257 {flags} is a String, which can contain these character flags:
7258 'b' search Backward instead of forward
7259 'c' accept a match at the Cursor position
7260 'e' move to the End of the match
7261 'n' do Not move the cursor
7262 'p' return number of matching sub-Pattern (see below)
7263 's' Set the ' mark at the previous location of the cursor
7264 'w' Wrap around the end of the file
7265 'W' don't Wrap around the end of the file
7266 'z' start searching at the cursor column instead of zero
7267 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
7268
7269 If the 's' flag is supplied, the ' mark is set, only if the
7270 cursor is moved. The 's' flag cannot be combined with the 'n'
7271 flag.
7272
7273 'ignorecase', 'smartcase' and 'magic' are used.
7274
7275 When the 'z' flag is not given, forward searching always
7276 starts in column zero and then matches before the cursor are
7277 skipped. When the 'c' flag is present in 'cpo' the next
7278 search starts after the match. Without the 'c' flag the next
7279 search starts one column further. This matters for
7280 overlapping matches.
7281 When searching backwards and the 'z' flag is given then the
7282 search starts in column zero, thus no match in the current
7283 line will be found (unless wrapping around the end of the
7284 file).
7285
7286 When the {stopline} argument is given then the search stops
7287 after searching this line. This is useful to restrict the
7288 search to a range of lines. Examples: >
7289 let match = search('(', 'b', line("w0"))
7290 let end = search('END', '', line("w$"))
7291< When {stopline} is used and it is not zero this also implies
7292 that the search does not wrap around the end of the file.
7293 A zero value is equal to not giving the argument.
7294
7295 When the {timeout} argument is given the search stops when
7296 more than this many milliseconds have passed. Thus when
7297 {timeout} is 500 the search stops after half a second.
7298 The value must not be negative. A zero value is like not
7299 giving the argument.
7300 {only available when compiled with the |+reltime| feature}
7301
7302 If the {skip} expression is given it is evaluated with the
7303 cursor positioned on the start of a match. If it evaluates to
7304 non-zero this match is skipped. This can be used, for
7305 example, to skip a match in a comment or a string.
7306 {skip} can be a string, which is evaluated as an expression, a
7307 function reference or a lambda.
7308 When {skip} is omitted or empty, every match is accepted.
7309 When evaluating {skip} causes an error the search is aborted
7310 and -1 returned.
7311 *search()-sub-match*
7312 With the 'p' flag the returned value is one more than the
7313 first sub-match in \(\). One if none of them matched but the
7314 whole pattern did match.
7315 To get the column number too use |searchpos()|.
7316
7317 The cursor will be positioned at the match, unless the 'n'
7318 flag is used.
7319
7320 Example (goes over all files in the argument list): >
7321 :let n = 1
7322 :while n <= argc() " loop over all files in arglist
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007323 : exe "argument " .. n
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007324 : " start at the last char in the file and wrap for the
7325 : " first search to find match at start of file
7326 : normal G$
7327 : let flags = "w"
7328 : while search("foo", flags) > 0
7329 : s/foo/bar/g
7330 : let flags = "W"
7331 : endwhile
7332 : update " write the file if modified
7333 : let n = n + 1
7334 :endwhile
7335<
7336 Example for using some flags: >
7337 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
7338< This will search for the keywords "if", "else", and "endif"
7339 under or after the cursor. Because of the 'p' flag, it
7340 returns 1, 2, or 3 depending on which keyword is found, or 0
7341 if the search fails. With the cursor on the first word of the
7342 line:
7343 if (foo == 0) | let foo = foo + 1 | endif ~
7344 the function returns 1. Without the 'c' flag, the function
7345 finds the "endif" and returns 3. The same thing happens
7346 without the 'e' flag if the cursor is on the "f" of "if".
7347 The 'n' flag tells the function not to move the cursor.
7348
7349 Can also be used as a |method|: >
7350 GetPattern()->search()
7351
7352searchcount([{options}]) *searchcount()*
7353 Get or update the last search count, like what is displayed
7354 without the "S" flag in 'shortmess'. This works even if
7355 'shortmess' does contain the "S" flag.
7356
7357 This returns a |Dictionary|. The dictionary is empty if the
7358 previous pattern was not set and "pattern" was not specified.
7359
7360 key type meaning ~
7361 current |Number| current position of match;
7362 0 if the cursor position is
7363 before the first match
7364 exact_match |Boolean| 1 if "current" is matched on
7365 "pos", otherwise 0
7366 total |Number| total count of matches found
7367 incomplete |Number| 0: search was fully completed
7368 1: recomputing was timed out
7369 2: max count exceeded
7370
7371 For {options} see further down.
7372
7373 To get the last search count when |n| or |N| was pressed, call
7374 this function with `recompute: 0` . This sometimes returns
7375 wrong information because |n| and |N|'s maximum count is 99.
7376 If it exceeded 99 the result must be max count + 1 (100). If
7377 you want to get correct information, specify `recompute: 1`: >
7378
7379 " result == maxcount + 1 (100) when many matches
7380 let result = searchcount(#{recompute: 0})
7381
7382 " Below returns correct result (recompute defaults
7383 " to 1)
7384 let result = searchcount()
7385<
7386 The function is useful to add the count to |statusline|: >
7387 function! LastSearchCount() abort
7388 let result = searchcount(#{recompute: 0})
7389 if empty(result)
7390 return ''
7391 endif
7392 if result.incomplete ==# 1 " timed out
7393 return printf(' /%s [?/??]', @/)
7394 elseif result.incomplete ==# 2 " max count exceeded
7395 if result.total > result.maxcount &&
7396 \ result.current > result.maxcount
7397 return printf(' /%s [>%d/>%d]', @/,
7398 \ result.current, result.total)
7399 elseif result.total > result.maxcount
7400 return printf(' /%s [%d/>%d]', @/,
7401 \ result.current, result.total)
7402 endif
7403 endif
7404 return printf(' /%s [%d/%d]', @/,
7405 \ result.current, result.total)
7406 endfunction
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007407 let &statusline ..= '%{LastSearchCount()}'
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007408
7409 " Or if you want to show the count only when
7410 " 'hlsearch' was on
Bram Moolenaarc51cf032022-02-26 12:25:45 +00007411 " let &statusline ..=
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007412 " \ '%{v:hlsearch ? LastSearchCount() : ""}'
7413<
7414 You can also update the search count, which can be useful in a
7415 |CursorMoved| or |CursorMovedI| autocommand: >
7416
7417 autocmd CursorMoved,CursorMovedI *
7418 \ let s:searchcount_timer = timer_start(
7419 \ 200, function('s:update_searchcount'))
7420 function! s:update_searchcount(timer) abort
7421 if a:timer ==# s:searchcount_timer
7422 call searchcount(#{
7423 \ recompute: 1, maxcount: 0, timeout: 100})
7424 redrawstatus
7425 endif
7426 endfunction
7427<
7428 This can also be used to count matched texts with specified
7429 pattern in the current buffer using "pattern": >
7430
7431 " Count '\<foo\>' in this buffer
7432 " (Note that it also updates search count)
7433 let result = searchcount(#{pattern: '\<foo\>'})
7434
7435 " To restore old search count by old pattern,
7436 " search again
7437 call searchcount()
7438<
7439 {options} must be a |Dictionary|. It can contain:
7440 key type meaning ~
7441 recompute |Boolean| if |TRUE|, recompute the count
7442 like |n| or |N| was executed.
7443 otherwise returns the last
7444 computed result (when |n| or
7445 |N| was used when "S" is not
7446 in 'shortmess', or this
7447 function was called).
7448 (default: |TRUE|)
7449 pattern |String| recompute if this was given
7450 and different with |@/|.
7451 this works as same as the
7452 below command is executed
7453 before calling this function >
7454 let @/ = pattern
7455< (default: |@/|)
7456 timeout |Number| 0 or negative number is no
7457 timeout. timeout milliseconds
7458 for recomputing the result
7459 (default: 0)
7460 maxcount |Number| 0 or negative number is no
7461 limit. max count of matched
7462 text while recomputing the
7463 result. if search exceeded
7464 total count, "total" value
7465 becomes `maxcount + 1`
7466 (default: 99)
7467 pos |List| `[lnum, col, off]` value
7468 when recomputing the result.
7469 this changes "current" result
7470 value. see |cursor()|,
7471 |getpos()|
7472 (default: cursor's position)
7473
7474 Can also be used as a |method|: >
7475 GetSearchOpts()->searchcount()
7476<
7477searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
7478 Search for the declaration of {name}.
7479
7480 With a non-zero {global} argument it works like |gD|, find
7481 first match in the file. Otherwise it works like |gd|, find
7482 first match in the function.
7483
7484 With a non-zero {thisblock} argument matches in a {} block
7485 that ends before the cursor position are ignored. Avoids
7486 finding variable declarations only valid in another scope.
7487
7488 Moves the cursor to the found match.
7489 Returns zero for success, non-zero for failure.
7490 Example: >
7491 if searchdecl('myvar') == 0
7492 echo getline('.')
7493 endif
7494<
7495 Can also be used as a |method|: >
7496 GetName()->searchdecl()
7497<
7498 *searchpair()*
7499searchpair({start}, {middle}, {end} [, {flags} [, {skip}
7500 [, {stopline} [, {timeout}]]]])
7501 Search for the match of a nested start-end pair. This can be
7502 used to find the "endif" that matches an "if", while other
7503 if/endif pairs in between are ignored.
7504 The search starts at the cursor. The default is to search
7505 forward, include 'b' in {flags} to search backward.
7506 If a match is found, the cursor is positioned at it and the
7507 line number is returned. If no match is found 0 or -1 is
7508 returned and the cursor doesn't move. No error message is
7509 given.
7510
7511 {start}, {middle} and {end} are patterns, see |pattern|. They
7512 must not contain \( \) pairs. Use of \%( \) is allowed. When
7513 {middle} is not empty, it is found when searching from either
7514 direction, but only when not in a nested start-end pair. A
7515 typical use is: >
7516 searchpair('\<if\>', '\<else\>', '\<endif\>')
7517< By leaving {middle} empty the "else" is skipped.
7518
7519 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
7520 |search()|. Additionally:
7521 'r' Repeat until no more matches found; will find the
7522 outer pair. Implies the 'W' flag.
7523 'm' Return number of matches instead of line number with
7524 the match; will be > 1 when 'r' is used.
7525 Note: it's nearly always a good idea to use the 'W' flag, to
7526 avoid wrapping around the end of the file.
7527
7528 When a match for {start}, {middle} or {end} is found, the
7529 {skip} expression is evaluated with the cursor positioned on
7530 the start of the match. It should return non-zero if this
7531 match is to be skipped. E.g., because it is inside a comment
7532 or a string.
7533 When {skip} is omitted or empty, every match is accepted.
7534 When evaluating {skip} causes an error the search is aborted
7535 and -1 returned.
7536 {skip} can be a string, a lambda, a funcref or a partial.
7537 Anything else makes the function fail.
7538 In a `:def` function when the {skip} argument is a string
7539 constant it is compiled into instructions.
7540
7541 For {stopline} and {timeout} see |search()|.
7542
7543 The value of 'ignorecase' is used. 'magic' is ignored, the
7544 patterns are used like it's on.
7545
7546 The search starts exactly at the cursor. A match with
7547 {start}, {middle} or {end} at the next character, in the
7548 direction of searching, is the first one found. Example: >
7549 if 1
7550 if 2
7551 endif 2
7552 endif 1
7553< When starting at the "if 2", with the cursor on the "i", and
7554 searching forwards, the "endif 2" is found. When starting on
7555 the character just before the "if 2", the "endif 1" will be
7556 found. That's because the "if 2" will be found first, and
7557 then this is considered to be a nested if/endif from "if 2" to
7558 "endif 2".
7559 When searching backwards and {end} is more than one character,
7560 it may be useful to put "\zs" at the end of the pattern, so
7561 that when the cursor is inside a match with the end it finds
7562 the matching start.
7563
7564 Example, to find the "endif" command in a Vim script: >
7565
7566 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
7567 \ 'getline(".") =~ "^\\s*\""')
7568
7569< The cursor must be at or after the "if" for which a match is
7570 to be found. Note that single-quote strings are used to avoid
7571 having to double the backslashes. The skip expression only
7572 catches comments at the start of a line, not after a command.
7573 Also, a word "en" or "if" halfway a line is considered a
7574 match.
7575 Another example, to search for the matching "{" of a "}": >
7576
7577 :echo searchpair('{', '', '}', 'bW')
7578
7579< This works when the cursor is at or before the "}" for which a
7580 match is to be found. To reject matches that syntax
7581 highlighting recognized as strings: >
7582
7583 :echo searchpair('{', '', '}', 'bW',
7584 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
7585<
7586 *searchpairpos()*
7587searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
7588 [, {stopline} [, {timeout}]]]])
7589 Same as |searchpair()|, but returns a |List| with the line and
7590 column position of the match. The first element of the |List|
7591 is the line number and the second element is the byte index of
7592 the column position of the match. If no match is found,
7593 returns [0, 0]. >
7594
7595 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
7596<
7597 See |match-parens| for a bigger and more useful example.
7598
7599 *searchpos()*
7600searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
7601 Same as |search()|, but returns a |List| with the line and
7602 column position of the match. The first element of the |List|
7603 is the line number and the second element is the byte index of
7604 the column position of the match. If no match is found,
7605 returns [0, 0].
7606 Example: >
7607 :let [lnum, col] = searchpos('mypattern', 'n')
7608
7609< When the 'p' flag is given then there is an extra item with
7610 the sub-pattern match number |search()-sub-match|. Example: >
7611 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
7612< In this example "submatch" is 2 when a lowercase letter is
7613 found |/\l|, 3 when an uppercase letter is found |/\u|.
7614
7615 Can also be used as a |method|: >
7616 GetPattern()->searchpos()
7617
7618server2client({clientid}, {string}) *server2client()*
7619 Send a reply string to {clientid}. The most recent {clientid}
7620 that sent a string can be retrieved with expand("<client>").
7621 {only available when compiled with the |+clientserver| feature}
7622 Returns zero for success, -1 for failure.
7623 Note:
7624 This id has to be stored before the next command can be
7625 received. I.e. before returning from the received command and
7626 before calling any commands that waits for input.
7627 See also |clientserver|.
7628 Example: >
7629 :echo server2client(expand("<client>"), "HELLO")
7630
7631< Can also be used as a |method|: >
7632 GetClientId()->server2client(string)
7633<
7634serverlist() *serverlist()*
7635 Return a list of available server names, one per line.
7636 When there are no servers or the information is not available
7637 an empty string is returned. See also |clientserver|.
7638 {only available when compiled with the |+clientserver| feature}
7639 Example: >
7640 :echo serverlist()
7641<
7642setbufline({buf}, {lnum}, {text}) *setbufline()*
7643 Set line {lnum} to {text} in buffer {buf}. This works like
7644 |setline()| for the specified buffer.
7645
7646 This function works only for loaded buffers. First call
7647 |bufload()| if needed.
7648
7649 To insert lines use |appendbufline()|.
7650 Any text properties in {lnum} are cleared.
7651
7652 {text} can be a string to set one line, or a list of strings
7653 to set multiple lines. If the list extends below the last
7654 line then those lines are added.
7655
7656 For the use of {buf}, see |bufname()| above.
7657
7658 {lnum} is used like with |setline()|.
7659 Use "$" to refer to the last line in buffer {buf}.
7660 When {lnum} is just below the last line the {text} will be
7661 added below the last line.
7662
7663 When {buf} is not a valid buffer, the buffer is not loaded or
7664 {lnum} is not valid then 1 is returned. In |Vim9| script an
7665 error is given.
7666 On success 0 is returned.
7667
7668 Can also be used as a |method|, the base is passed as the
7669 third argument: >
7670 GetText()->setbufline(buf, lnum)
7671
7672setbufvar({buf}, {varname}, {val}) *setbufvar()*
7673 Set option or local variable {varname} in buffer {buf} to
7674 {val}.
7675 This also works for a global or local window option, but it
7676 doesn't work for a global or local window variable.
7677 For a local window option the global value is unchanged.
7678 For the use of {buf}, see |bufname()| above.
7679 The {varname} argument is a string.
7680 Note that the variable name without "b:" must be used.
7681 Examples: >
7682 :call setbufvar(1, "&mod", 1)
7683 :call setbufvar("todo", "myvar", "foobar")
7684< This function is not available in the |sandbox|.
7685
7686 Can also be used as a |method|, the base is passed as the
7687 third argument: >
7688 GetValue()->setbufvar(buf, varname)
7689
7690
7691setcellwidths({list}) *setcellwidths()*
7692 Specify overrides for cell widths of character ranges. This
7693 tells Vim how wide characters are, counted in screen cells.
7694 This overrides 'ambiwidth'. Example: >
7695 setcellwidths([[0xad, 0xad, 1],
7696 \ [0x2194, 0x2199, 2]])
7697
Bram Moolenaarf10911e2022-01-29 22:20:48 +00007698< *E1109* *E1110* *E1111* *E1112* *E1113* *E1114*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007699 The {list} argument is a list of lists with each three
7700 numbers. These three numbers are [low, high, width]. "low"
7701 and "high" can be the same, in which case this refers to one
7702 character. Otherwise it is the range of characters from "low"
7703 to "high" (inclusive). "width" is either 1 or 2, indicating
7704 the character width in screen cells.
7705 An error is given if the argument is invalid, also when a
7706 range overlaps with another.
7707 Only characters with value 0x100 and higher can be used.
7708
7709 If the new value causes 'fillchars' or 'listchars' to become
7710 invalid it is rejected and an error is given.
7711
7712 To clear the overrides pass an empty list: >
7713 setcellwidths([]);
7714< You can use the script $VIMRUNTIME/tools/emoji_list.vim to see
7715 the effect for known emoji characters.
7716
7717setcharpos({expr}, {list}) *setcharpos()*
7718 Same as |setpos()| but uses the specified column number as the
7719 character index instead of the byte index in the line.
7720
7721 Example:
7722 With the text "여보세요" in line 8: >
7723 call setcharpos('.', [0, 8, 4, 0])
7724< positions the cursor on the fourth character '요'. >
7725 call setpos('.', [0, 8, 4, 0])
7726< positions the cursor on the second character '보'.
7727
7728 Can also be used as a |method|: >
7729 GetPosition()->setcharpos('.')
7730
7731setcharsearch({dict}) *setcharsearch()*
7732 Set the current character search information to {dict},
7733 which contains one or more of the following entries:
7734
7735 char character which will be used for a subsequent
7736 |,| or |;| command; an empty string clears the
7737 character search
7738 forward direction of character search; 1 for forward,
7739 0 for backward
7740 until type of character search; 1 for a |t| or |T|
7741 character search, 0 for an |f| or |F|
7742 character search
7743
7744 This can be useful to save/restore a user's character search
7745 from a script: >
7746 :let prevsearch = getcharsearch()
7747 :" Perform a command which clobbers user's search
7748 :call setcharsearch(prevsearch)
7749< Also see |getcharsearch()|.
7750
7751 Can also be used as a |method|: >
7752 SavedSearch()->setcharsearch()
7753
7754setcmdpos({pos}) *setcmdpos()*
7755 Set the cursor position in the command line to byte position
7756 {pos}. The first position is 1.
7757 Use |getcmdpos()| to obtain the current position.
7758 Only works while editing the command line, thus you must use
7759 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
7760 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
7761 set after the command line is set to the expression. For
7762 |c_CTRL-R_=| it is set after evaluating the expression but
7763 before inserting the resulting text.
7764 When the number is too big the cursor is put at the end of the
7765 line. A number smaller than one has undefined results.
7766 Returns FALSE when successful, TRUE when not editing the
7767 command line.
7768
7769 Can also be used as a |method|: >
7770 GetPos()->setcmdpos()
7771
7772setcursorcharpos({lnum}, {col} [, {off}]) *setcursorcharpos()*
7773setcursorcharpos({list})
7774 Same as |cursor()| but uses the specified column number as the
7775 character index instead of the byte index in the line.
7776
7777 Example:
7778 With the text "여보세요" in line 4: >
7779 call setcursorcharpos(4, 3)
7780< positions the cursor on the third character '세'. >
7781 call cursor(4, 3)
7782< positions the cursor on the first character '여'.
7783
7784 Can also be used as a |method|: >
7785 GetCursorPos()->setcursorcharpos()
7786
7787
7788setenv({name}, {val}) *setenv()*
7789 Set environment variable {name} to {val}. Example: >
7790 call setenv('HOME', '/home/myhome')
7791
7792< When {val} is |v:null| the environment variable is deleted.
7793 See also |expr-env|.
7794
7795 Can also be used as a |method|, the base is passed as the
7796 second argument: >
7797 GetPath()->setenv('PATH')
7798
7799setfperm({fname}, {mode}) *setfperm()* *chmod*
7800 Set the file permissions for {fname} to {mode}.
7801 {mode} must be a string with 9 characters. It is of the form
7802 "rwxrwxrwx", where each group of "rwx" flags represent, in
7803 turn, the permissions of the owner of the file, the group the
7804 file belongs to, and other users. A '-' character means the
7805 permission is off, any other character means on. Multi-byte
7806 characters are not supported.
7807
7808 For example "rw-r-----" means read-write for the user,
7809 readable by the group, not accessible by others. "xx-x-----"
7810 would do the same thing.
7811
7812 Returns non-zero for success, zero for failure.
7813
7814 Can also be used as a |method|: >
7815 GetFilename()->setfperm(mode)
7816<
7817 To read permissions see |getfperm()|.
7818
7819
7820setline({lnum}, {text}) *setline()*
7821 Set line {lnum} of the current buffer to {text}. To insert
7822 lines use |append()|. To set lines in another buffer use
7823 |setbufline()|. Any text properties in {lnum} are cleared.
7824
7825 {lnum} is used like with |getline()|.
7826 When {lnum} is just below the last line the {text} will be
7827 added below the last line.
7828 {text} can be any type or a List of any type, each item is
7829 converted to a String.
7830
7831 If this succeeds, FALSE is returned. If this fails (most likely
7832 because {lnum} is invalid) TRUE is returned.
7833 In |Vim9| script an error is given if {lnum} is invalid.
7834
7835 Example: >
7836 :call setline(5, strftime("%c"))
7837
7838< When {text} is a |List| then line {lnum} and following lines
7839 will be set to the items in the list. Example: >
7840 :call setline(5, ['aaa', 'bbb', 'ccc'])
7841< This is equivalent to: >
7842 :for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]
7843 : call setline(n, l)
7844 :endfor
7845
7846< Note: The '[ and '] marks are not set.
7847
7848 Can also be used as a |method|, the base is passed as the
7849 second argument: >
7850 GetText()->setline(lnum)
7851
7852setloclist({nr}, {list} [, {action} [, {what}]]) *setloclist()*
7853 Create or replace or add to the location list for window {nr}.
7854 {nr} can be the window number or the |window-ID|.
7855 When {nr} is zero the current window is used.
7856
7857 For a location list window, the displayed location list is
7858 modified. For an invalid window number {nr}, -1 is returned.
7859 Otherwise, same as |setqflist()|.
7860 Also see |location-list|.
7861
7862 For {action} see |setqflist-action|.
7863
7864 If the optional {what} dictionary argument is supplied, then
7865 only the items listed in {what} are set. Refer to |setqflist()|
7866 for the list of supported keys in {what}.
7867
7868 Can also be used as a |method|, the base is passed as the
7869 second argument: >
7870 GetLoclist()->setloclist(winnr)
7871
7872setmatches({list} [, {win}]) *setmatches()*
7873 Restores a list of matches saved by |getmatches()| for the
7874 current window. Returns 0 if successful, otherwise -1. All
7875 current matches are cleared before the list is restored. See
7876 example for |getmatches()|.
7877 If {win} is specified, use the window with this number or
7878 window ID instead of the current window.
7879
7880 Can also be used as a |method|: >
7881 GetMatches()->setmatches()
7882<
7883 *setpos()*
7884setpos({expr}, {list})
7885 Set the position for String {expr}. Possible values:
7886 . the cursor
7887 'x mark x
7888
7889 {list} must be a |List| with four or five numbers:
7890 [bufnum, lnum, col, off]
7891 [bufnum, lnum, col, off, curswant]
7892
7893 "bufnum" is the buffer number. Zero can be used for the
7894 current buffer. When setting an uppercase mark "bufnum" is
7895 used for the mark position. For other marks it specifies the
7896 buffer to set the mark in. You can use the |bufnr()| function
7897 to turn a file name into a buffer number.
7898 For setting the cursor and the ' mark "bufnum" is ignored,
7899 since these are associated with a window, not a buffer.
7900 Does not change the jumplist.
7901
7902 "lnum" and "col" are the position in the buffer. The first
7903 column is 1. Use a zero "lnum" to delete a mark. If "col" is
7904 smaller than 1 then 1 is used. To use the character count
7905 instead of the byte count, use |setcharpos()|.
7906
7907 The "off" number is only used when 'virtualedit' is set. Then
7908 it is the offset in screen columns from the start of the
7909 character. E.g., a position within a <Tab> or after the last
7910 character.
7911
7912 The "curswant" number is only used when setting the cursor
7913 position. It sets the preferred column for when moving the
7914 cursor vertically. When the "curswant" number is missing the
7915 preferred column is not set. When it is present and setting a
7916 mark position it is not used.
7917
7918 Note that for '< and '> changing the line number may result in
7919 the marks to be effectively be swapped, so that '< is always
7920 before '>.
7921
7922 Returns 0 when the position could be set, -1 otherwise.
7923 An error message is given if {expr} is invalid.
7924
7925 Also see |setcharpos()|, |getpos()| and |getcurpos()|.
7926
7927 This does not restore the preferred column for moving
7928 vertically; if you set the cursor position with this, |j| and
7929 |k| motions will jump to previous columns! Use |cursor()| to
7930 also set the preferred column. Also see the "curswant" key in
7931 |winrestview()|.
7932
7933 Can also be used as a |method|: >
7934 GetPosition()->setpos('.')
7935
7936setqflist({list} [, {action} [, {what}]]) *setqflist()*
7937 Create or replace or add to the quickfix list.
7938
7939 If the optional {what} dictionary argument is supplied, then
7940 only the items listed in {what} are set. The first {list}
7941 argument is ignored. See below for the supported items in
7942 {what}.
7943 *setqflist-what*
7944 When {what} is not present, the items in {list} are used. Each
7945 item must be a dictionary. Non-dictionary items in {list} are
7946 ignored. Each dictionary item can contain the following
7947 entries:
7948
7949 bufnr buffer number; must be the number of a valid
7950 buffer
7951 filename name of a file; only used when "bufnr" is not
7952 present or it is invalid.
7953 module name of a module; if given it will be used in
7954 quickfix error window instead of the filename.
7955 lnum line number in the file
Bram Moolenaara2baa732022-02-04 16:09:54 +00007956 end_lnum end of lines, if the item spans multiple lines
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007957 pattern search pattern used to locate the error
7958 col column number
7959 vcol when non-zero: "col" is visual column
7960 when zero: "col" is byte index
Bram Moolenaara2baa732022-02-04 16:09:54 +00007961 end_col end column, if the item spans multiple columns
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00007962 nr error number
7963 text description of the error
7964 type single-character error type, 'E', 'W', etc.
7965 valid recognized error message
7966
7967 The "col", "vcol", "nr", "type" and "text" entries are
7968 optional. Either "lnum" or "pattern" entry can be used to
7969 locate a matching error line.
7970 If the "filename" and "bufnr" entries are not present or
7971 neither the "lnum" or "pattern" entries are present, then the
7972 item will not be handled as an error line.
7973 If both "pattern" and "lnum" are present then "pattern" will
7974 be used.
7975 If the "valid" entry is not supplied, then the valid flag is
7976 set when "bufnr" is a valid buffer or "filename" exists.
7977 If you supply an empty {list}, the quickfix list will be
7978 cleared.
7979 Note that the list is not exactly the same as what
7980 |getqflist()| returns.
7981
7982 {action} values: *setqflist-action* *E927*
7983 'a' The items from {list} are added to the existing
7984 quickfix list. If there is no existing list, then a
7985 new list is created.
7986
7987 'r' The items from the current quickfix list are replaced
7988 with the items from {list}. This can also be used to
7989 clear the list: >
7990 :call setqflist([], 'r')
7991<
7992 'f' All the quickfix lists in the quickfix stack are
7993 freed.
7994
7995 If {action} is not present or is set to ' ', then a new list
7996 is created. The new quickfix list is added after the current
7997 quickfix list in the stack and all the following lists are
7998 freed. To add a new quickfix list at the end of the stack,
7999 set "nr" in {what} to "$".
8000
8001 The following items can be specified in dictionary {what}:
8002 context quickfix list context. See |quickfix-context|
8003 efm errorformat to use when parsing text from
8004 "lines". If this is not present, then the
8005 'errorformat' option value is used.
8006 See |quickfix-parse|
8007 id quickfix list identifier |quickfix-ID|
8008 idx index of the current entry in the quickfix
8009 list specified by 'id' or 'nr'. If set to '$',
8010 then the last entry in the list is set as the
8011 current entry. See |quickfix-index|
8012 items list of quickfix entries. Same as the {list}
8013 argument.
8014 lines use 'errorformat' to parse a list of lines and
8015 add the resulting entries to the quickfix list
8016 {nr} or {id}. Only a |List| value is supported.
8017 See |quickfix-parse|
8018 nr list number in the quickfix stack; zero
8019 means the current quickfix list and "$" means
8020 the last quickfix list.
8021 quickfixtextfunc
8022 function to get the text to display in the
8023 quickfix window. The value can be the name of
8024 a function or a funcref or a lambda. Refer to
8025 |quickfix-window-function| for an explanation
8026 of how to write the function and an example.
8027 title quickfix list title text. See |quickfix-title|
8028 Unsupported keys in {what} are ignored.
8029 If the "nr" item is not present, then the current quickfix list
8030 is modified. When creating a new quickfix list, "nr" can be
8031 set to a value one greater than the quickfix stack size.
8032 When modifying a quickfix list, to guarantee that the correct
8033 list is modified, "id" should be used instead of "nr" to
8034 specify the list.
8035
8036 Examples (See also |setqflist-examples|): >
8037 :call setqflist([], 'r', {'title': 'My search'})
8038 :call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
8039 :call setqflist([], 'a', {'id':qfid, 'lines':["F1:10:L10"]})
8040<
8041 Returns zero for success, -1 for failure.
8042
8043 This function can be used to create a quickfix list
8044 independent of the 'errorformat' setting. Use a command like
8045 `:cc 1` to jump to the first position.
8046
8047 Can also be used as a |method|, the base is passed as the
8048 second argument: >
8049 GetErrorlist()->setqflist()
8050<
8051 *setreg()*
8052setreg({regname}, {value} [, {options}])
8053 Set the register {regname} to {value}.
8054 If {regname} is "" or "@", the unnamed register '"' is used.
8055 The {regname} argument is a string. In |Vim9-script|
8056 {regname} must be one character.
8057
8058 {value} may be any value returned by |getreg()| or
8059 |getreginfo()|, including a |List| or |Dict|.
8060 If {options} contains "a" or {regname} is upper case,
8061 then the value is appended.
8062
8063 {options} can also contain a register type specification:
8064 "c" or "v" |characterwise| mode
8065 "l" or "V" |linewise| mode
8066 "b" or "<CTRL-V>" |blockwise-visual| mode
8067 If a number immediately follows "b" or "<CTRL-V>" then this is
8068 used as the width of the selection - if it is not specified
8069 then the width of the block is set to the number of characters
8070 in the longest line (counting a <Tab> as 1 character).
8071
8072 If {options} contains no register settings, then the default
8073 is to use character mode unless {value} ends in a <NL> for
8074 string {value} and linewise mode for list {value}. Blockwise
8075 mode is never selected automatically.
8076 Returns zero for success, non-zero for failure.
8077
8078 *E883*
8079 Note: you may not use |List| containing more than one item to
8080 set search and expression registers. Lists containing no
8081 items act like empty strings.
8082
8083 Examples: >
8084 :call setreg(v:register, @*)
8085 :call setreg('*', @%, 'ac')
8086 :call setreg('a', "1\n2\n3", 'b5')
8087 :call setreg('"', { 'points_to': 'a'})
8088
8089< This example shows using the functions to save and restore a
8090 register: >
8091 :let var_a = getreginfo()
8092 :call setreg('a', var_a)
8093< or: >
8094 :let var_a = getreg('a', 1, 1)
8095 :let var_amode = getregtype('a')
8096 ....
8097 :call setreg('a', var_a, var_amode)
8098< Note: you may not reliably restore register value
8099 without using the third argument to |getreg()| as without it
8100 newlines are represented as newlines AND Nul bytes are
8101 represented as newlines as well, see |NL-used-for-Nul|.
8102
8103 You can also change the type of a register by appending
8104 nothing: >
8105 :call setreg('a', '', 'al')
8106
8107< Can also be used as a |method|, the base is passed as the
8108 second argument: >
8109 GetText()->setreg('a')
8110
8111settabvar({tabnr}, {varname}, {val}) *settabvar()*
8112 Set tab-local variable {varname} to {val} in tab page {tabnr}.
8113 |t:var|
8114 The {varname} argument is a string.
8115 Note that autocommands are blocked, side effects may not be
8116 triggered, e.g. when setting 'filetype'.
8117 Note that the variable name without "t:" must be used.
8118 Tabs are numbered starting with one.
8119 This function is not available in the |sandbox|.
8120
8121 Can also be used as a |method|, the base is passed as the
8122 third argument: >
8123 GetValue()->settabvar(tab, name)
8124
8125settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
8126 Set option or local variable {varname} in window {winnr} to
8127 {val}.
8128 Tabs are numbered starting with one. For the current tabpage
8129 use |setwinvar()|.
8130 {winnr} can be the window number or the |window-ID|.
8131 When {winnr} is zero the current window is used.
8132 Note that autocommands are blocked, side effects may not be
8133 triggered, e.g. when setting 'filetype' or 'syntax'.
8134 This also works for a global or local buffer option, but it
8135 doesn't work for a global or local buffer variable.
8136 For a local buffer option the global value is unchanged.
8137 Note that the variable name without "w:" must be used.
8138 Examples: >
8139 :call settabwinvar(1, 1, "&list", 0)
8140 :call settabwinvar(3, 2, "myvar", "foobar")
8141< This function is not available in the |sandbox|.
8142
8143 Can also be used as a |method|, the base is passed as the
8144 fourth argument: >
8145 GetValue()->settabwinvar(tab, winnr, name)
8146
8147settagstack({nr}, {dict} [, {action}]) *settagstack()*
8148 Modify the tag stack of the window {nr} using {dict}.
8149 {nr} can be the window number or the |window-ID|.
8150
8151 For a list of supported items in {dict}, refer to
8152 |gettagstack()|. "curidx" takes effect before changing the tag
8153 stack.
8154 *E962*
8155 How the tag stack is modified depends on the {action}
8156 argument:
8157 - If {action} is not present or is set to 'r', then the tag
8158 stack is replaced.
8159 - If {action} is set to 'a', then new entries from {dict} are
8160 pushed (added) onto the tag stack.
8161 - If {action} is set to 't', then all the entries from the
8162 current entry in the tag stack or "curidx" in {dict} are
8163 removed and then new entries are pushed to the stack.
8164
8165 The current index is set to one after the length of the tag
8166 stack after the modification.
8167
8168 Returns zero for success, -1 for failure.
8169
8170 Examples (for more examples see |tagstack-examples|):
8171 Empty the tag stack of window 3: >
8172 call settagstack(3, {'items' : []})
8173
8174< Save and restore the tag stack: >
8175 let stack = gettagstack(1003)
8176 " do something else
8177 call settagstack(1003, stack)
8178 unlet stack
8179<
8180 Can also be used as a |method|, the base is passed as the
8181 second argument: >
8182 GetStack()->settagstack(winnr)
8183
8184setwinvar({winnr}, {varname}, {val}) *setwinvar()*
8185 Like |settabwinvar()| for the current tab page.
8186 Examples: >
8187 :call setwinvar(1, "&list", 0)
8188 :call setwinvar(2, "myvar", "foobar")
8189
8190< Can also be used as a |method|, the base is passed as the
8191 third argument: >
8192 GetValue()->setwinvar(winnr, name)
8193
8194sha256({string}) *sha256()*
8195 Returns a String with 64 hex characters, which is the SHA256
8196 checksum of {string}.
8197
8198 Can also be used as a |method|: >
8199 GetText()->sha256()
8200
8201< {only available when compiled with the |+cryptv| feature}
8202
8203shellescape({string} [, {special}]) *shellescape()*
8204 Escape {string} for use as a shell command argument.
8205 When the 'shell' contains powershell (MS-Windows) or pwsh
Bram Moolenaar944697a2022-02-20 19:48:20 +00008206 (MS-Windows, Linux, and macOS) then it will enclose {string}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008207 in single quotes and will double up all internal single
8208 quotes.
8209 On MS-Windows, when 'shellslash' is not set, it will enclose
8210 {string} in double quotes and double all double quotes within
8211 {string}.
8212 Otherwise it will enclose {string} in single quotes and
8213 replace all "'" with "'\''".
8214
8215 When the {special} argument is present and it's a non-zero
8216 Number or a non-empty String (|non-zero-arg|), then special
8217 items such as "!", "%", "#" and "<cword>" will be preceded by
8218 a backslash. This backslash will be removed again by the |:!|
8219 command.
8220
8221 The "!" character will be escaped (again with a |non-zero-arg|
8222 {special}) when 'shell' contains "csh" in the tail. That is
8223 because for csh and tcsh "!" is used for history replacement
8224 even when inside single quotes.
8225
8226 With a |non-zero-arg| {special} the <NL> character is also
8227 escaped. When 'shell' containing "csh" in the tail it's
8228 escaped a second time.
8229
8230 The "\" character will be escaped when 'shell' contains "fish"
8231 in the tail. That is because for fish "\" is used as an escape
8232 character inside single quotes.
8233
8234 Example of use with a |:!| command: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008235 :exe '!dir ' .. shellescape(expand('<cfile>'), 1)
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008236< This results in a directory listing for the file under the
8237 cursor. Example of use with |system()|: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00008238 :call system("chmod +w -- " .. shellescape(expand("%")))
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008239< See also |::S|.
8240
8241 Can also be used as a |method|: >
8242 GetCommand()->shellescape()
8243
8244shiftwidth([{col}]) *shiftwidth()*
8245 Returns the effective value of 'shiftwidth'. This is the
8246 'shiftwidth' value unless it is zero, in which case it is the
8247 'tabstop' value. This function was introduced with patch
8248 7.3.694 in 2012, everybody should have it by now (however it
8249 did not allow for the optional {col} argument until 8.1.542).
8250
8251 When there is one argument {col} this is used as column number
8252 for which to return the 'shiftwidth' value. This matters for the
8253 'vartabstop' feature. If the 'vartabstop' setting is enabled and
8254 no {col} argument is given, column 1 will be assumed.
8255
8256 Can also be used as a |method|: >
8257 GetColumn()->shiftwidth()
8258
8259sign_ functions are documented here: |sign-functions-details|
8260
8261
8262simplify({filename}) *simplify()*
8263 Simplify the file name as much as possible without changing
8264 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
8265 Unix) are not resolved. If the first path component in
8266 {filename} designates the current directory, this will be
8267 valid for the result as well. A trailing path separator is
8268 not removed either. On Unix "//path" is unchanged, but
8269 "///path" is simplified to "/path" (this follows the Posix
8270 standard).
8271 Example: >
8272 simplify("./dir/.././/file/") == "./file/"
8273< Note: The combination "dir/.." is only removed if "dir" is
8274 a searchable directory or does not exist. On Unix, it is also
8275 removed when "dir" is a symbolic link within the same
8276 directory. In order to resolve all the involved symbolic
8277 links before simplifying the path name, use |resolve()|.
8278
8279 Can also be used as a |method|: >
8280 GetName()->simplify()
8281
8282sin({expr}) *sin()*
8283 Return the sine of {expr}, measured in radians, as a |Float|.
8284 {expr} must evaluate to a |Float| or a |Number|.
8285 Examples: >
8286 :echo sin(100)
8287< -0.506366 >
8288 :echo sin(-4.01)
8289< 0.763301
8290
8291 Can also be used as a |method|: >
8292 Compute()->sin()
8293<
8294 {only available when compiled with the |+float| feature}
8295
8296
8297sinh({expr}) *sinh()*
8298 Return the hyperbolic sine of {expr} as a |Float| in the range
8299 [-inf, inf].
8300 {expr} must evaluate to a |Float| or a |Number|.
8301 Examples: >
8302 :echo sinh(0.5)
8303< 0.521095 >
8304 :echo sinh(-0.9)
8305< -1.026517
8306
8307 Can also be used as a |method|: >
8308 Compute()->sinh()
8309<
8310 {only available when compiled with the |+float| feature}
8311
8312
8313slice({expr}, {start} [, {end}]) *slice()*
8314 Similar to using a |slice| "expr[start : end]", but "end" is
8315 used exclusive. And for a string the indexes are used as
8316 character indexes instead of byte indexes, like in
8317 |vim9script|. Also, composing characters are not counted.
8318 When {end} is omitted the slice continues to the last item.
8319 When {end} is -1 the last item is omitted.
8320
8321 Can also be used as a |method|: >
8322 GetList()->slice(offset)
8323
8324
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008325sort({list} [, {how} [, {dict}]]) *sort()* *E702*
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008326 Sort the items in {list} in-place. Returns {list}.
8327
8328 If you want a list to remain unmodified make a copy first: >
8329 :let sortedlist = sort(copy(mylist))
8330
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01008331< When {how} is omitted or is a string, then sort() uses the
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008332 string representation of each item to sort on. Numbers sort
8333 after Strings, |Lists| after Numbers. For sorting text in the
8334 current buffer use |:sort|.
8335
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008336 When {how} is given and it is 'i' then case is ignored.
8337 In legacy script, for backwards compatibility, the value one
8338 can be used to ignore case. Zero means to not ignore case.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008339
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008340 When {how} is given and it is 'l' then the current collation
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008341 locale is used for ordering. Implementation details: strcoll()
8342 is used to compare strings. See |:language| check or set the
8343 collation locale. |v:collate| can also be used to check the
8344 current locale. Sorting using the locale typically ignores
8345 case. Example: >
8346 " ö is sorted similarly to o with English locale.
8347 :language collate en_US.UTF8
8348 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
8349< ['n', 'o', 'O', 'ö', 'p', 'z'] ~
8350>
8351 " ö is sorted after z with Swedish locale.
8352 :language collate sv_SE.UTF8
8353 :echo sort(['n', 'o', 'O', 'ö', 'p', 'z'], 'l')
8354< ['n', 'o', 'O', 'p', 'z', 'ö'] ~
8355 This does not work properly on Mac.
8356
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008357 When {how} is given and it is 'n' then all items will be
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008358 sorted numerical (Implementation detail: this uses the
8359 strtod() function to parse numbers, Strings, Lists, Dicts and
8360 Funcrefs will be considered as being 0).
8361
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008362 When {how} is given and it is 'N' then all items will be
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008363 sorted numerical. This is like 'n' but a string containing
8364 digits will be used as the number they represent.
8365
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008366 When {how} is given and it is 'f' then all items will be
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008367 sorted numerical. All values must be a Number or a Float.
8368
Bram Moolenaar2007dd42022-02-23 13:17:47 +00008369 When {how} is a |Funcref| or a function name, this function
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008370 is called to compare items. The function is invoked with two
8371 items as argument and must return zero if they are equal, 1 or
8372 bigger if the first one sorts after the second one, -1 or
8373 smaller if the first one sorts before the second one.
8374
8375 {dict} is for functions with the "dict" attribute. It will be
8376 used to set the local variable "self". |Dictionary-function|
8377
8378 The sort is stable, items which compare equal (as number or as
8379 string) will keep their relative position. E.g., when sorting
8380 on numbers, text strings will sort next to each other, in the
8381 same order as they were originally.
8382
8383 Can also be used as a |method|: >
8384 mylist->sort()
8385
8386< Also see |uniq()|.
8387
8388 Example: >
8389 func MyCompare(i1, i2)
8390 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
8391 endfunc
8392 eval mylist->sort("MyCompare")
8393< A shorter compare version for this specific simple case, which
8394 ignores overflow: >
8395 func MyCompare(i1, i2)
8396 return a:i1 - a:i2
8397 endfunc
8398< For a simple expression you can use a lambda: >
8399 eval mylist->sort({i1, i2 -> i1 - i2})
8400<
8401sound_clear() *sound_clear()*
8402 Stop playing all sounds.
8403
8404 On some Linux systems you may need the libcanberra-pulse
8405 package, otherwise sound may not stop.
8406
8407 {only available when compiled with the |+sound| feature}
8408
8409 *sound_playevent()*
8410sound_playevent({name} [, {callback}])
8411 Play a sound identified by {name}. Which event names are
8412 supported depends on the system. Often the XDG sound names
8413 are used. On Ubuntu they may be found in
8414 /usr/share/sounds/freedesktop/stereo. Example: >
8415 call sound_playevent('bell')
8416< On MS-Windows, {name} can be SystemAsterisk, SystemDefault,
8417 SystemExclamation, SystemExit, SystemHand, SystemQuestion,
8418 SystemStart, SystemWelcome, etc.
8419
8420 When {callback} is specified it is invoked when the sound is
8421 finished. The first argument is the sound ID, the second
8422 argument is the status:
8423 0 sound was played to the end
8424 1 sound was interrupted
8425 2 error occurred after sound started
8426 Example: >
8427 func Callback(id, status)
8428 echomsg "sound " .. a:id .. " finished with " .. a:status
8429 endfunc
8430 call sound_playevent('bell', 'Callback')
8431
8432< MS-Windows: {callback} doesn't work for this function.
8433
8434 Returns the sound ID, which can be passed to `sound_stop()`.
8435 Returns zero if the sound could not be played.
8436
8437 Can also be used as a |method|: >
8438 GetSoundName()->sound_playevent()
8439
8440< {only available when compiled with the |+sound| feature}
8441
8442 *sound_playfile()*
8443sound_playfile({path} [, {callback}])
8444 Like `sound_playevent()` but play sound file {path}. {path}
8445 must be a full path. On Ubuntu you may find files to play
8446 with this command: >
8447 :!find /usr/share/sounds -type f | grep -v index.theme
8448
8449< Can also be used as a |method|: >
8450 GetSoundPath()->sound_playfile()
8451
Bram Moolenaar1588bc82022-03-08 21:35:07 +00008452< {only available when compiled with the |+sound| feature}
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008453
8454
8455sound_stop({id}) *sound_stop()*
8456 Stop playing sound {id}. {id} must be previously returned by
8457 `sound_playevent()` or `sound_playfile()`.
8458
8459 On some Linux systems you may need the libcanberra-pulse
8460 package, otherwise sound may not stop.
8461
8462 On MS-Windows, this does not work for event sound started by
8463 `sound_playevent()`. To stop event sounds, use `sound_clear()`.
8464
8465 Can also be used as a |method|: >
8466 soundid->sound_stop()
8467
8468< {only available when compiled with the |+sound| feature}
8469
8470 *soundfold()*
8471soundfold({word})
8472 Return the sound-folded equivalent of {word}. Uses the first
8473 language in 'spelllang' for the current window that supports
8474 soundfolding. 'spell' must be set. When no sound folding is
8475 possible the {word} is returned unmodified.
8476 This can be used for making spelling suggestions. Note that
8477 the method can be quite slow.
8478
8479 Can also be used as a |method|: >
8480 GetWord()->soundfold()
8481<
8482 *spellbadword()*
8483spellbadword([{sentence}])
8484 Without argument: The result is the badly spelled word under
8485 or after the cursor. The cursor is moved to the start of the
8486 bad word. When no bad word is found in the cursor line the
8487 result is an empty string and the cursor doesn't move.
8488
8489 With argument: The result is the first word in {sentence} that
8490 is badly spelled. If there are no spelling mistakes the
8491 result is an empty string.
8492
8493 The return value is a list with two items:
8494 - The badly spelled word or an empty string.
8495 - The type of the spelling error:
8496 "bad" spelling mistake
8497 "rare" rare word
8498 "local" word only valid in another region
8499 "caps" word should start with Capital
8500 Example: >
8501 echo spellbadword("the quik brown fox")
8502< ['quik', 'bad'] ~
8503
8504 The spelling information for the current window and the value
8505 of 'spelllang' are used.
8506
8507 Can also be used as a |method|: >
8508 GetText()->spellbadword()
8509<
8510 *spellsuggest()*
8511spellsuggest({word} [, {max} [, {capital}]])
8512 Return a |List| with spelling suggestions to replace {word}.
8513 When {max} is given up to this number of suggestions are
8514 returned. Otherwise up to 25 suggestions are returned.
8515
8516 When the {capital} argument is given and it's non-zero only
8517 suggestions with a leading capital will be given. Use this
8518 after a match with 'spellcapcheck'.
8519
8520 {word} can be a badly spelled word followed by other text.
8521 This allows for joining two words that were split. The
8522 suggestions also include the following text, thus you can
8523 replace a line.
8524
8525 {word} may also be a good word. Similar words will then be
8526 returned. {word} itself is not included in the suggestions,
8527 although it may appear capitalized.
8528
8529 The spelling information for the current window is used. The
8530 values of 'spelllang' and 'spellsuggest' are used.
8531
8532 Can also be used as a |method|: >
8533 GetWord()->spellsuggest()
8534
8535split({string} [, {pattern} [, {keepempty}]]) *split()*
8536 Make a |List| out of {string}. When {pattern} is omitted or
8537 empty each white-separated sequence of characters becomes an
8538 item.
8539 Otherwise the string is split where {pattern} matches,
8540 removing the matched characters. 'ignorecase' is not used
8541 here, add \c to ignore case. |/\c|
8542 When the first or last item is empty it is omitted, unless the
8543 {keepempty} argument is given and it's non-zero.
8544 Other empty items are kept when {pattern} matches at least one
8545 character or when {keepempty} is non-zero.
8546 Example: >
8547 :let words = split(getline('.'), '\W\+')
8548< To split a string in individual characters: >
8549 :for c in split(mystring, '\zs')
8550< If you want to keep the separator you can also use '\zs' at
8551 the end of the pattern: >
8552 :echo split('abc:def:ghi', ':\zs')
8553< ['abc:', 'def:', 'ghi'] ~
8554 Splitting a table where the first element can be empty: >
8555 :let items = split(line, ':', 1)
8556< The opposite function is |join()|.
8557
8558 Can also be used as a |method|: >
8559 GetString()->split()
8560
8561sqrt({expr}) *sqrt()*
8562 Return the non-negative square root of Float {expr} as a
8563 |Float|.
8564 {expr} must evaluate to a |Float| or a |Number|. When {expr}
8565 is negative the result is NaN (Not a Number).
8566 Examples: >
8567 :echo sqrt(100)
8568< 10.0 >
8569 :echo sqrt(-4.01)
8570< nan
8571 "nan" may be different, it depends on system libraries.
8572
8573 Can also be used as a |method|: >
8574 Compute()->sqrt()
8575<
8576 {only available when compiled with the |+float| feature}
8577
8578
8579srand([{expr}]) *srand()*
8580 Initialize seed used by |rand()|:
8581 - If {expr} is not given, seed values are initialized by
8582 reading from /dev/urandom, if possible, or using time(NULL)
8583 a.k.a. epoch time otherwise; this only has second accuracy.
8584 - If {expr} is given it must be a Number. It is used to
8585 initialize the seed values. This is useful for testing or
8586 when a predictable sequence is intended.
8587
8588 Examples: >
8589 :let seed = srand()
8590 :let seed = srand(userinput)
8591 :echo rand(seed)
8592
8593state([{what}]) *state()*
8594 Return a string which contains characters indicating the
8595 current state. Mostly useful in callbacks that want to do
8596 work that may not always be safe. Roughly this works like:
8597 - callback uses state() to check if work is safe to do.
8598 Yes: then do it right away.
8599 No: add to work queue and add a |SafeState| and/or
8600 |SafeStateAgain| autocommand (|SafeState| triggers at
8601 toplevel, |SafeStateAgain| triggers after handling
8602 messages and callbacks).
8603 - When SafeState or SafeStateAgain is triggered and executes
8604 your autocommand, check with `state()` if the work can be
8605 done now, and if yes remove it from the queue and execute.
8606 Remove the autocommand if the queue is now empty.
8607 Also see |mode()|.
8608
8609 When {what} is given only characters in this string will be
8610 added. E.g, this checks if the screen has scrolled: >
8611 if state('s') == ''
8612 " screen has not scrolled
8613<
8614 These characters indicate the state, generally indicating that
8615 something is busy:
8616 m halfway a mapping, :normal command, feedkeys() or
8617 stuffed command
8618 o operator pending, e.g. after |d|
8619 a Insert mode autocomplete active
8620 x executing an autocommand
8621 w blocked on waiting, e.g. ch_evalexpr(), ch_read() and
8622 ch_readraw() when reading json
8623 S not triggering SafeState or SafeStateAgain, e.g. after
8624 |f| or a count
8625 c callback invoked, including timer (repeats for
8626 recursiveness up to "ccc")
8627 s screen has scrolled for messages
8628
8629str2float({string} [, {quoted}]) *str2float()*
8630 Convert String {string} to a Float. This mostly works the
8631 same as when using a floating point number in an expression,
8632 see |floating-point-format|. But it's a bit more permissive.
8633 E.g., "1e40" is accepted, while in an expression you need to
8634 write "1.0e40". The hexadecimal form "0x123" is also
8635 accepted, but not others, like binary or octal.
8636 When {quoted} is present and non-zero then embedded single
8637 quotes before the dot are ignored, thus "1'000.0" is a
8638 thousand.
8639 Text after the number is silently ignored.
8640 The decimal point is always '.', no matter what the locale is
8641 set to. A comma ends the number: "12,345.67" is converted to
8642 12.0. You can strip out thousands separators with
8643 |substitute()|: >
8644 let f = str2float(substitute(text, ',', '', 'g'))
8645<
8646 Can also be used as a |method|: >
8647 let f = text->substitute(',', '', 'g')->str2float()
8648<
8649 {only available when compiled with the |+float| feature}
8650
8651str2list({string} [, {utf8}]) *str2list()*
8652 Return a list containing the number values which represent
8653 each character in String {string}. Examples: >
8654 str2list(" ") returns [32]
8655 str2list("ABC") returns [65, 66, 67]
8656< |list2str()| does the opposite.
8657
8658 When {utf8} is omitted or zero, the current 'encoding' is used.
8659 When {utf8} is TRUE, always treat the String as UTF-8
8660 characters. With UTF-8 composing characters are handled
8661 properly: >
8662 str2list("á") returns [97, 769]
8663
8664< Can also be used as a |method|: >
8665 GetString()->str2list()
8666
8667
8668str2nr({string} [, {base} [, {quoted}]]) *str2nr()*
8669 Convert string {string} to a number.
8670 {base} is the conversion base, it can be 2, 8, 10 or 16.
8671 When {quoted} is present and non-zero then embedded single
8672 quotes are ignored, thus "1'000'000" is a million.
8673
8674 When {base} is omitted base 10 is used. This also means that
8675 a leading zero doesn't cause octal conversion to be used, as
8676 with the default String to Number conversion. Example: >
8677 let nr = str2nr('0123')
8678<
8679 When {base} is 16 a leading "0x" or "0X" is ignored. With a
8680 different base the result will be zero. Similarly, when
8681 {base} is 8 a leading "0", "0o" or "0O" is ignored, and when
8682 {base} is 2 a leading "0b" or "0B" is ignored.
8683 Text after the number is silently ignored.
8684
8685 Can also be used as a |method|: >
8686 GetText()->str2nr()
8687
8688
8689strcharlen({string}) *strcharlen()*
8690 The result is a Number, which is the number of characters
8691 in String {string}. Composing characters are ignored.
8692 |strchars()| can count the number of characters, counting
8693 composing characters separately.
8694
8695 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
8696
8697 Can also be used as a |method|: >
8698 GetText()->strcharlen()
8699
8700
8701strcharpart({src}, {start} [, {len} [, {skipcc}]]) *strcharpart()*
8702 Like |strpart()| but using character index and length instead
8703 of byte index and length.
8704 When {skipcc} is omitted or zero, composing characters are
8705 counted separately.
8706 When {skipcc} set to 1, Composing characters are ignored,
8707 similar to |slice()|.
8708 When a character index is used where a character does not
8709 exist it is omitted and counted as one character. For
8710 example: >
8711 strcharpart('abc', -1, 2)
8712< results in 'a'.
8713
8714 Can also be used as a |method|: >
8715 GetText()->strcharpart(5)
8716
8717
8718strchars({string} [, {skipcc}]) *strchars()*
8719 The result is a Number, which is the number of characters
8720 in String {string}.
8721 When {skipcc} is omitted or zero, composing characters are
8722 counted separately.
8723 When {skipcc} set to 1, Composing characters are ignored.
8724 |strcharlen()| always does this.
8725
8726 Also see |strlen()|, |strdisplaywidth()| and |strwidth()|.
8727
8728 {skipcc} is only available after 7.4.755. For backward
8729 compatibility, you can define a wrapper function: >
8730 if has("patch-7.4.755")
8731 function s:strchars(str, skipcc)
8732 return strchars(a:str, a:skipcc)
8733 endfunction
8734 else
8735 function s:strchars(str, skipcc)
8736 if a:skipcc
8737 return strlen(substitute(a:str, ".", "x", "g"))
8738 else
8739 return strchars(a:str)
8740 endif
8741 endfunction
8742 endif
8743<
8744 Can also be used as a |method|: >
8745 GetText()->strchars()
8746
8747strdisplaywidth({string} [, {col}]) *strdisplaywidth()*
8748 The result is a Number, which is the number of display cells
8749 String {string} occupies on the screen when it starts at {col}
8750 (first column is zero). When {col} is omitted zero is used.
8751 Otherwise it is the screen column where to start. This
8752 matters for Tab characters.
8753 The option settings of the current window are used. This
8754 matters for anything that's displayed differently, such as
8755 'tabstop' and 'display'.
8756 When {string} contains characters with East Asian Width Class
8757 Ambiguous, this function's return value depends on 'ambiwidth'.
8758 Also see |strlen()|, |strwidth()| and |strchars()|.
8759
8760 Can also be used as a |method|: >
8761 GetText()->strdisplaywidth()
8762
8763strftime({format} [, {time}]) *strftime()*
8764 The result is a String, which is a formatted date and time, as
8765 specified by the {format} string. The given {time} is used,
8766 or the current time if no time is given. The accepted
8767 {format} depends on your system, thus this is not portable!
8768 See the manual page of the C function strftime() for the
8769 format. The maximum length of the result is 80 characters.
8770 See also |localtime()|, |getftime()| and |strptime()|.
8771 The language can be changed with the |:language| command.
8772 Examples: >
8773 :echo strftime("%c") Sun Apr 27 11:49:23 1997
8774 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
8775 :echo strftime("%y%m%d %T") 970427 11:53:55
8776 :echo strftime("%H:%M") 11:55
8777 :echo strftime("%c", getftime("file.c"))
8778 Show mod time of file.c.
8779< Not available on all systems. To check use: >
8780 :if exists("*strftime")
8781
8782< Can also be used as a |method|: >
8783 GetFormat()->strftime()
8784
8785strgetchar({str}, {index}) *strgetchar()*
Bram Moolenaar2d8ed022022-05-21 13:08:16 +01008786 Get a Number corresponding to the character at {index} in
8787 {str}. This uses a zero-based character index, not a byte
8788 index. Composing characters are considered separate
8789 characters here. Use |nr2char()| to convert the Number to a
8790 String.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00008791 Also see |strcharpart()| and |strchars()|.
8792
8793 Can also be used as a |method|: >
8794 GetText()->strgetchar(5)
8795
8796stridx({haystack}, {needle} [, {start}]) *stridx()*
8797 The result is a Number, which gives the byte index in
8798 {haystack} of the first occurrence of the String {needle}.
8799 If {start} is specified, the search starts at index {start}.
8800 This can be used to find a second match: >
8801 :let colon1 = stridx(line, ":")
8802 :let colon2 = stridx(line, ":", colon1 + 1)
8803< The search is done case-sensitive.
8804 For pattern searches use |match()|.
8805 -1 is returned if the {needle} does not occur in {haystack}.
8806 See also |strridx()|.
8807 Examples: >
8808 :echo stridx("An Example", "Example") 3
8809 :echo stridx("Starting point", "Start") 0
8810 :echo stridx("Starting point", "start") -1
8811< *strstr()* *strchr()*
8812 stridx() works similar to the C function strstr(). When used
8813 with a single character it works similar to strchr().
8814
8815 Can also be used as a |method|: >
8816 GetHaystack()->stridx(needle)
8817<
8818 *string()*
8819string({expr}) Return {expr} converted to a String. If {expr} is a Number,
8820 Float, String, Blob or a composition of them, then the result
8821 can be parsed back with |eval()|.
8822 {expr} type result ~
8823 String 'string' (single quotes are doubled)
8824 Number 123
8825 Float 123.123456 or 1.123456e8
8826 Funcref function('name')
8827 Blob 0z00112233.44556677.8899
8828 List [item, item]
8829 Dictionary {key: value, key: value}
8830
8831 When a |List| or |Dictionary| has a recursive reference it is
8832 replaced by "[...]" or "{...}". Using eval() on the result
8833 will then fail.
8834
8835 Can also be used as a |method|: >
8836 mylist->string()
8837
8838< Also see |strtrans()|.
8839
8840
8841strlen({string}) *strlen()*
8842 The result is a Number, which is the length of the String
8843 {string} in bytes.
8844 If the argument is a Number it is first converted to a String.
8845 For other types an error is given.
8846 If you want to count the number of multibyte characters use
8847 |strchars()|.
8848 Also see |len()|, |strdisplaywidth()| and |strwidth()|.
8849
8850 Can also be used as a |method|: >
8851 GetString()->strlen()
8852
8853strpart({src}, {start} [, {len} [, {chars}]]) *strpart()*
8854 The result is a String, which is part of {src}, starting from
8855 byte {start}, with the byte length {len}.
8856 When {chars} is present and TRUE then {len} is the number of
8857 characters positions (composing characters are not counted
8858 separately, thus "1" means one base character and any
8859 following composing characters).
8860 To count {start} as characters instead of bytes use
8861 |strcharpart()|.
8862
8863 When bytes are selected which do not exist, this doesn't
8864 result in an error, the bytes are simply omitted.
8865 If {len} is missing, the copy continues from {start} till the
8866 end of the {src}. >
8867 strpart("abcdefg", 3, 2) == "de"
8868 strpart("abcdefg", -2, 4) == "ab"
8869 strpart("abcdefg", 5, 4) == "fg"
8870 strpart("abcdefg", 3) == "defg"
8871
8872< Note: To get the first character, {start} must be 0. For
8873 example, to get the character under the cursor: >
8874 strpart(getline("."), col(".") - 1, 1, v:true)
8875<
8876 Can also be used as a |method|: >
8877 GetText()->strpart(5)
8878
8879strptime({format}, {timestring}) *strptime()*
8880 The result is a Number, which is a unix timestamp representing
8881 the date and time in {timestring}, which is expected to match
8882 the format specified in {format}.
8883
8884 The accepted {format} depends on your system, thus this is not
8885 portable! See the manual page of the C function strptime()
8886 for the format. Especially avoid "%c". The value of $TZ also
8887 matters.
8888
8889 If the {timestring} cannot be parsed with {format} zero is
8890 returned. If you do not know the format of {timestring} you
8891 can try different {format} values until you get a non-zero
8892 result.
8893
8894 See also |strftime()|.
8895 Examples: >
8896 :echo strptime("%Y %b %d %X", "1997 Apr 27 11:49:23")
8897< 862156163 >
8898 :echo strftime("%c", strptime("%y%m%d %T", "970427 11:53:55"))
8899< Sun Apr 27 11:53:55 1997 >
8900 :echo strftime("%c", strptime("%Y%m%d%H%M%S", "19970427115355") + 3600)
8901< Sun Apr 27 12:53:55 1997
8902
8903 Can also be used as a |method|: >
8904 GetFormat()->strptime(timestring)
8905<
8906 Not available on all systems. To check use: >
8907 :if exists("*strptime")
8908
8909strridx({haystack}, {needle} [, {start}]) *strridx()*
8910 The result is a Number, which gives the byte index in
8911 {haystack} of the last occurrence of the String {needle}.
8912 When {start} is specified, matches beyond this index are
8913 ignored. This can be used to find a match before a previous
8914 match: >
8915 :let lastcomma = strridx(line, ",")
8916 :let comma2 = strridx(line, ",", lastcomma - 1)
8917< The search is done case-sensitive.
8918 For pattern searches use |match()|.
8919 -1 is returned if the {needle} does not occur in {haystack}.
8920 If the {needle} is empty the length of {haystack} is returned.
8921 See also |stridx()|. Examples: >
8922 :echo strridx("an angry armadillo", "an") 3
8923< *strrchr()*
8924 When used with a single character it works similar to the C
8925 function strrchr().
8926
8927 Can also be used as a |method|: >
8928 GetHaystack()->strridx(needle)
8929
8930strtrans({string}) *strtrans()*
8931 The result is a String, which is {string} with all unprintable
8932 characters translated into printable characters |'isprint'|.
8933 Like they are shown in a window. Example: >
8934 echo strtrans(@a)
8935< This displays a newline in register a as "^@" instead of
8936 starting a new line.
8937
8938 Can also be used as a |method|: >
8939 GetString()->strtrans()
8940
8941strwidth({string}) *strwidth()*
8942 The result is a Number, which is the number of display cells
8943 String {string} occupies. A Tab character is counted as one
8944 cell, alternatively use |strdisplaywidth()|.
8945 When {string} contains characters with East Asian Width Class
8946 Ambiguous, this function's return value depends on 'ambiwidth'.
8947 Also see |strlen()|, |strdisplaywidth()| and |strchars()|.
8948
8949 Can also be used as a |method|: >
8950 GetString()->strwidth()
8951
8952submatch({nr} [, {list}]) *submatch()* *E935*
8953 Only for an expression in a |:substitute| command or
8954 substitute() function.
8955 Returns the {nr}'th submatch of the matched text. When {nr}
8956 is 0 the whole matched text is returned.
8957 Note that a NL in the string can stand for a line break of a
8958 multi-line match or a NUL character in the text.
8959 Also see |sub-replace-expression|.
8960
8961 If {list} is present and non-zero then submatch() returns
8962 a list of strings, similar to |getline()| with two arguments.
8963 NL characters in the text represent NUL characters in the
8964 text.
8965 Only returns more than one item for |:substitute|, inside
8966 |substitute()| this list will always contain one or zero
8967 items, since there are no real line breaks.
8968
8969 When substitute() is used recursively only the submatches in
8970 the current (deepest) call can be obtained.
8971
8972 Examples: >
8973 :s/\d\+/\=submatch(0) + 1/
8974 :echo substitute(text, '\d\+', '\=submatch(0) + 1', '')
8975< This finds the first number in the line and adds one to it.
8976 A line break is included as a newline character.
8977
8978 Can also be used as a |method|: >
8979 GetNr()->submatch()
8980
8981substitute({string}, {pat}, {sub}, {flags}) *substitute()*
8982 The result is a String, which is a copy of {string}, in which
8983 the first match of {pat} is replaced with {sub}.
8984 When {flags} is "g", all matches of {pat} in {string} are
8985 replaced. Otherwise {flags} should be "".
8986
8987 This works like the ":substitute" command (without any flags).
8988 But the matching with {pat} is always done like the 'magic'
8989 option is set and 'cpoptions' is empty (to make scripts
8990 portable). 'ignorecase' is still relevant, use |/\c| or |/\C|
8991 if you want to ignore or match case and ignore 'ignorecase'.
8992 'smartcase' is not used. See |string-match| for how {pat} is
8993 used.
8994
8995 A "~" in {sub} is not replaced with the previous {sub}.
8996 Note that some codes in {sub} have a special meaning
8997 |sub-replace-special|. For example, to replace something with
8998 "\n" (two characters), use "\\\\n" or '\\n'.
8999
9000 When {pat} does not match in {string}, {string} is returned
9001 unmodified.
9002
9003 Example: >
9004 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
9005< This removes the last component of the 'path' option. >
9006 :echo substitute("testing", ".*", "\\U\\0", "")
9007< results in "TESTING".
9008
9009 When {sub} starts with "\=", the remainder is interpreted as
9010 an expression. See |sub-replace-expression|. Example: >
9011 :echo substitute(s, '%\(\x\x\)',
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009012 \ '\=nr2char("0x" .. submatch(1))', 'g')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009013
9014< When {sub} is a Funcref that function is called, with one
9015 optional argument. Example: >
9016 :echo substitute(s, '%\(\x\x\)', SubNr, 'g')
9017< The optional argument is a list which contains the whole
9018 matched string and up to nine submatches, like what
9019 |submatch()| returns. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009020 :echo substitute(s, '%\(\x\x\)', {m -> '0x' .. m[1]}, 'g')
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009021
9022< Can also be used as a |method|: >
9023 GetString()->substitute(pat, sub, flags)
9024
9025swapinfo({fname}) *swapinfo()*
9026 The result is a dictionary, which holds information about the
9027 swapfile {fname}. The available fields are:
9028 version Vim version
9029 user user name
9030 host host name
9031 fname original file name
9032 pid PID of the Vim process that created the swap
9033 file
9034 mtime last modification time in seconds
9035 inode Optional: INODE number of the file
9036 dirty 1 if file was modified, 0 if not
9037 Note that "user" and "host" are truncated to at most 39 bytes.
9038 In case of failure an "error" item is added with the reason:
9039 Cannot open file: file not found or in accessible
9040 Cannot read file: cannot read first block
9041 Not a swap file: does not contain correct block ID
9042 Magic number mismatch: Info in first block is invalid
9043
9044 Can also be used as a |method|: >
9045 GetFilename()->swapinfo()
9046
9047swapname({buf}) *swapname()*
9048 The result is the swap file path of the buffer {expr}.
9049 For the use of {buf}, see |bufname()| above.
9050 If buffer {buf} is the current buffer, the result is equal to
9051 |:swapname| (unless there is no swap file).
9052 If buffer {buf} has no swap file, returns an empty string.
9053
9054 Can also be used as a |method|: >
9055 GetBufname()->swapname()
9056
9057synID({lnum}, {col}, {trans}) *synID()*
9058 The result is a Number, which is the syntax ID at the position
9059 {lnum} and {col} in the current window.
9060 The syntax ID can be used with |synIDattr()| and
9061 |synIDtrans()| to obtain syntax information about text.
9062
9063 {col} is 1 for the leftmost column, {lnum} is 1 for the first
9064 line. 'synmaxcol' applies, in a longer line zero is returned.
9065 Note that when the position is after the last character,
9066 that's where the cursor can be in Insert mode, synID() returns
9067 zero. {lnum} is used like with |getline()|.
9068
9069 When {trans} is |TRUE|, transparent items are reduced to the
9070 item that they reveal. This is useful when wanting to know
9071 the effective color. When {trans} is |FALSE|, the transparent
9072 item is returned. This is useful when wanting to know which
9073 syntax item is effective (e.g. inside parens).
9074 Warning: This function can be very slow. Best speed is
9075 obtained by going through the file in forward direction.
9076
9077 Example (echoes the name of the syntax item under the cursor): >
9078 :echo synIDattr(synID(line("."), col("."), 1), "name")
9079<
9080
9081synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
9082 The result is a String, which is the {what} attribute of
9083 syntax ID {synID}. This can be used to obtain information
9084 about a syntax item.
9085 {mode} can be "gui", "cterm" or "term", to get the attributes
9086 for that mode. When {mode} is omitted, or an invalid value is
9087 used, the attributes for the currently active highlighting are
9088 used (GUI, cterm or term).
9089 Use synIDtrans() to follow linked highlight groups.
9090 {what} result
9091 "name" the name of the syntax item
9092 "fg" foreground color (GUI: color name used to set
9093 the color, cterm: color number as a string,
9094 term: empty string)
9095 "bg" background color (as with "fg")
9096 "font" font name (only available in the GUI)
9097 |highlight-font|
9098 "sp" special color for the GUI (as with "fg")
9099 |highlight-guisp|
9100 "ul" underline color for cterm: number as a string
9101 "fg#" like "fg", but for the GUI and the GUI is
9102 running the name in "#RRGGBB" form
9103 "bg#" like "fg#" for "bg"
9104 "sp#" like "fg#" for "sp"
9105 "bold" "1" if bold
9106 "italic" "1" if italic
9107 "reverse" "1" if reverse
9108 "inverse" "1" if inverse (= reverse)
9109 "standout" "1" if standout
9110 "underline" "1" if underlined
9111 "undercurl" "1" if undercurled
9112 "strike" "1" if strikethrough
9113
9114 Example (echoes the color of the syntax item under the
9115 cursor): >
9116 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
9117<
9118 Can also be used as a |method|: >
9119 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
9120
9121
9122synIDtrans({synID}) *synIDtrans()*
9123 The result is a Number, which is the translated syntax ID of
9124 {synID}. This is the syntax group ID of what is being used to
9125 highlight the character. Highlight links given with
9126 ":highlight link" are followed.
9127
9128 Can also be used as a |method|: >
9129 :echo synID(line("."), col("."), 1)->synIDtrans()->synIDattr("fg")
9130
9131synconcealed({lnum}, {col}) *synconcealed()*
9132 The result is a |List| with currently three items:
9133 1. The first item in the list is 0 if the character at the
9134 position {lnum} and {col} is not part of a concealable
9135 region, 1 if it is. {lnum} is used like with |getline()|.
9136 2. The second item in the list is a string. If the first item
9137 is 1, the second item contains the text which will be
9138 displayed in place of the concealed text, depending on the
9139 current setting of 'conceallevel' and 'listchars'.
9140 3. The third and final item in the list is a number
9141 representing the specific syntax region matched in the
9142 line. When the character is not concealed the value is
9143 zero. This allows detection of the beginning of a new
9144 concealable region if there are two consecutive regions
9145 with the same replacement character. For an example, if
9146 the text is "123456" and both "23" and "45" are concealed
9147 and replaced by the character "X", then:
9148 call returns ~
9149 synconcealed(lnum, 1) [0, '', 0]
9150 synconcealed(lnum, 2) [1, 'X', 1]
9151 synconcealed(lnum, 3) [1, 'X', 1]
9152 synconcealed(lnum, 4) [1, 'X', 2]
9153 synconcealed(lnum, 5) [1, 'X', 2]
9154 synconcealed(lnum, 6) [0, '', 0]
9155
9156
9157synstack({lnum}, {col}) *synstack()*
9158 Return a |List|, which is the stack of syntax items at the
9159 position {lnum} and {col} in the current window. {lnum} is
9160 used like with |getline()|. Each item in the List is an ID
9161 like what |synID()| returns.
9162 The first item in the List is the outer region, following are
9163 items contained in that one. The last one is what |synID()|
9164 returns, unless not the whole item is highlighted or it is a
9165 transparent item.
9166 This function is useful for debugging a syntax file.
9167 Example that shows the syntax stack under the cursor: >
9168 for id in synstack(line("."), col("."))
9169 echo synIDattr(id, "name")
9170 endfor
9171< When the position specified with {lnum} and {col} is invalid
9172 nothing is returned. The position just after the last
9173 character in a line and the first column in an empty line are
9174 valid positions.
9175
9176system({expr} [, {input}]) *system()* *E677*
9177 Get the output of the shell command {expr} as a |String|. See
9178 |systemlist()| to get the output as a |List|.
9179
9180 When {input} is given and is a |String| this string is written
9181 to a file and passed as stdin to the command. The string is
9182 written as-is, you need to take care of using the correct line
9183 separators yourself.
9184 If {input} is given and is a |List| it is written to the file
9185 in a way |writefile()| does with {binary} set to "b" (i.e.
9186 with a newline between each list item with newlines inside
9187 list items converted to NULs).
9188 When {input} is given and is a number that is a valid id for
9189 an existing buffer then the content of the buffer is written
9190 to the file line by line, each line terminated by a NL and
9191 NULs characters where the text has a NL.
9192
9193 Pipes are not used, the 'shelltemp' option is not used.
9194
9195 When prepended by |:silent| the terminal will not be set to
9196 cooked mode. This is meant to be used for commands that do
9197 not need the user to type. It avoids stray characters showing
9198 up on the screen which require |CTRL-L| to remove. >
9199 :silent let f = system('ls *.vim')
9200<
9201 Note: Use |shellescape()| or |::S| with |expand()| or
9202 |fnamemodify()| to escape special characters in a command
9203 argument. Newlines in {expr} may cause the command to fail.
9204 The characters in 'shellquote' and 'shellxquote' may also
9205 cause trouble.
9206 This is not to be used for interactive commands.
9207
9208 The result is a String. Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009209 :let files = system('ls ' .. shellescape(expand('%:h')))
9210 :let files = system('ls ' .. expand('%:h:S'))
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009211
9212< To make the result more system-independent, the shell output
9213 is filtered to replace <CR> with <NL> for Macintosh, and
9214 <CR><NL> with <NL> for DOS-like systems.
9215 To avoid the string being truncated at a NUL, all NUL
9216 characters are replaced with SOH (0x01).
9217
9218 The command executed is constructed using several options:
9219 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
9220 ({tmp} is an automatically generated file name).
9221 For Unix, braces are put around {expr} to allow for
9222 concatenated commands.
9223
9224 The command will be executed in "cooked" mode, so that a
9225 CTRL-C will interrupt the command (on Unix at least).
9226
9227 The resulting error code can be found in |v:shell_error|.
9228 This function will fail in |restricted-mode|.
9229
9230 Note that any wrong value in the options mentioned above may
9231 make the function fail. It has also been reported to fail
9232 when using a security agent application.
9233 Unlike ":!cmd" there is no automatic check for changed files.
9234 Use |:checktime| to force a check.
9235
9236 Can also be used as a |method|: >
9237 :echo GetCmd()->system()
9238
9239
9240systemlist({expr} [, {input}]) *systemlist()*
9241 Same as |system()|, but returns a |List| with lines (parts of
9242 output separated by NL) with NULs transformed into NLs. Output
9243 is the same as |readfile()| will output with {binary} argument
9244 set to "b", except that there is no extra empty item when the
9245 result ends in a NL.
9246 Note that on MS-Windows you may get trailing CR characters.
9247
9248 To see the difference between "echo hello" and "echo -n hello"
9249 use |system()| and |split()|: >
9250 echo system('echo hello')->split('\n', 1)
9251<
9252 Returns an empty string on error.
9253
9254 Can also be used as a |method|: >
9255 :echo GetCmd()->systemlist()
9256
9257
9258tabpagebuflist([{arg}]) *tabpagebuflist()*
9259 The result is a |List|, where each item is the number of the
9260 buffer associated with each window in the current tab page.
9261 {arg} specifies the number of the tab page to be used. When
9262 omitted the current tab page is used.
9263 When {arg} is invalid the number zero is returned.
9264 To get a list of all buffers in all tabs use this: >
9265 let buflist = []
9266 for i in range(tabpagenr('$'))
9267 call extend(buflist, tabpagebuflist(i + 1))
9268 endfor
9269< Note that a buffer may appear in more than one window.
9270
9271 Can also be used as a |method|: >
9272 GetTabpage()->tabpagebuflist()
9273
9274tabpagenr([{arg}]) *tabpagenr()*
9275 The result is a Number, which is the number of the current
9276 tab page. The first tab page has number 1.
9277
9278 The optional argument {arg} supports the following values:
9279 $ the number of the last tab page (the tab page
9280 count).
9281 # the number of the last accessed tab page
9282 (where |g<Tab>| goes to). if there is no
9283 previous tab page 0 is returned.
9284 The number can be used with the |:tab| command.
9285
9286
9287tabpagewinnr({tabarg} [, {arg}]) *tabpagewinnr()*
9288 Like |winnr()| but for tab page {tabarg}.
9289 {tabarg} specifies the number of tab page to be used.
9290 {arg} is used like with |winnr()|:
9291 - When omitted the current window number is returned. This is
9292 the window which will be used when going to this tab page.
9293 - When "$" the number of windows is returned.
9294 - When "#" the previous window nr is returned.
9295 Useful examples: >
9296 tabpagewinnr(1) " current window of tab page 1
9297 tabpagewinnr(4, '$') " number of windows in tab page 4
9298< When {tabarg} is invalid zero is returned.
9299
9300 Can also be used as a |method|: >
9301 GetTabpage()->tabpagewinnr()
9302<
9303 *tagfiles()*
9304tagfiles() Returns a |List| with the file names used to search for tags
9305 for the current buffer. This is the 'tags' option expanded.
9306
9307
9308taglist({expr} [, {filename}]) *taglist()*
9309 Returns a |List| of tags matching the regular expression {expr}.
9310
9311 If {filename} is passed it is used to prioritize the results
9312 in the same way that |:tselect| does. See |tag-priority|.
9313 {filename} should be the full path of the file.
9314
9315 Each list item is a dictionary with at least the following
9316 entries:
9317 name Name of the tag.
9318 filename Name of the file where the tag is
9319 defined. It is either relative to the
9320 current directory or a full path.
9321 cmd Ex command used to locate the tag in
9322 the file.
9323 kind Type of the tag. The value for this
9324 entry depends on the language specific
9325 kind values. Only available when
9326 using a tags file generated by
Bram Moolenaar47c532e2022-03-19 15:18:53 +00009327 Universal/Exuberant ctags or hdrtag.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009328 static A file specific tag. Refer to
9329 |static-tag| for more information.
9330 More entries may be present, depending on the content of the
9331 tags file: access, implementation, inherits and signature.
9332 Refer to the ctags documentation for information about these
9333 fields. For C code the fields "struct", "class" and "enum"
9334 may appear, they give the name of the entity the tag is
9335 contained in.
9336
9337 The ex-command "cmd" can be either an ex search pattern, a
9338 line number or a line number followed by a byte number.
9339
9340 If there are no matching tags, then an empty list is returned.
9341
9342 To get an exact tag match, the anchors '^' and '$' should be
9343 used in {expr}. This also make the function work faster.
9344 Refer to |tag-regexp| for more information about the tag
9345 search regular expression pattern.
9346
9347 Refer to |'tags'| for information about how the tags file is
9348 located by Vim. Refer to |tags-file-format| for the format of
9349 the tags file generated by the different ctags tools.
9350
9351 Can also be used as a |method|: >
9352 GetTagpattern()->taglist()
9353
9354tan({expr}) *tan()*
9355 Return the tangent of {expr}, measured in radians, as a |Float|
9356 in the range [-inf, inf].
9357 {expr} must evaluate to a |Float| or a |Number|.
9358 Examples: >
9359 :echo tan(10)
9360< 0.648361 >
9361 :echo tan(-4.01)
9362< -1.181502
9363
9364 Can also be used as a |method|: >
9365 Compute()->tan()
9366<
9367 {only available when compiled with the |+float| feature}
9368
9369
9370tanh({expr}) *tanh()*
9371 Return the hyperbolic tangent of {expr} as a |Float| in the
9372 range [-1, 1].
9373 {expr} must evaluate to a |Float| or a |Number|.
9374 Examples: >
9375 :echo tanh(0.5)
9376< 0.462117 >
9377 :echo tanh(-1)
9378< -0.761594
9379
9380 Can also be used as a |method|: >
9381 Compute()->tanh()
9382<
9383 {only available when compiled with the |+float| feature}
9384
9385
9386tempname() *tempname()* *temp-file-name*
9387 The result is a String, which is the name of a file that
9388 doesn't exist. It can be used for a temporary file. The name
9389 is different for at least 26 consecutive calls. Example: >
9390 :let tmpfile = tempname()
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009391 :exe "redir > " .. tmpfile
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009392< For Unix, the file will be in a private directory |tempfile|.
9393 For MS-Windows forward slashes are used when the 'shellslash'
9394 option is set, or when 'shellcmdflag' starts with '-' and
9395 'shell' does not contain powershell or pwsh.
9396
9397
9398term_ functions are documented here: |terminal-function-details|
9399
9400
9401terminalprops() *terminalprops()*
9402 Returns a |Dictionary| with properties of the terminal that Vim
9403 detected from the response to |t_RV| request. See
9404 |v:termresponse| for the response itself. If |v:termresponse|
9405 is empty most values here will be 'u' for unknown.
9406 cursor_style whether sending |t_RS| works **
9407 cursor_blink_mode whether sending |t_RC| works **
9408 underline_rgb whether |t_8u| works **
9409 mouse mouse type supported
9410
9411 ** value 'u' for unknown, 'y' for yes, 'n' for no
9412
9413 If the |+termresponse| feature is missing then the result is
9414 an empty dictionary.
9415
9416 If "cursor_style" is 'y' then |t_RS| will be sent to request the
9417 current cursor style.
9418 If "cursor_blink_mode" is 'y' then |t_RC| will be sent to
9419 request the cursor blink status.
9420 "cursor_style" and "cursor_blink_mode" are also set if |t_u7|
9421 is not empty, Vim will detect the working of sending |t_RS|
9422 and |t_RC| on startup.
9423
9424 When "underline_rgb" is not 'y', then |t_8u| will be made empty.
9425 This avoids sending it to xterm, which would clear the colors.
9426
9427 For "mouse" the value 'u' is unknown
9428
9429 Also see:
9430 - 'ambiwidth' - detected by using |t_u7|.
9431 - |v:termstyleresp| and |v:termblinkresp| for the response to
9432 |t_RS| and |t_RC|.
9433
9434
9435test_ functions are documented here: |test-functions-details|
9436
9437
9438 *timer_info()*
9439timer_info([{id}])
9440 Return a list with information about timers.
9441 When {id} is given only information about this timer is
9442 returned. When timer {id} does not exist an empty list is
9443 returned.
9444 When {id} is omitted information about all timers is returned.
9445
9446 For each timer the information is stored in a |Dictionary| with
9447 these items:
9448 "id" the timer ID
9449 "time" time the timer was started with
9450 "remaining" time until the timer fires
9451 "repeat" number of times the timer will still fire;
9452 -1 means forever
9453 "callback" the callback
9454 "paused" 1 if the timer is paused, 0 otherwise
9455
9456 Can also be used as a |method|: >
9457 GetTimer()->timer_info()
9458
9459< {only available when compiled with the |+timers| feature}
9460
9461timer_pause({timer}, {paused}) *timer_pause()*
9462 Pause or unpause a timer. A paused timer does not invoke its
9463 callback when its time expires. Unpausing a timer may cause
9464 the callback to be invoked almost immediately if enough time
9465 has passed.
9466
9467 Pausing a timer is useful to avoid the callback to be called
9468 for a short time.
9469
9470 If {paused} evaluates to a non-zero Number or a non-empty
9471 String, then the timer is paused, otherwise it is unpaused.
9472 See |non-zero-arg|.
9473
9474 Can also be used as a |method|: >
9475 GetTimer()->timer_pause(1)
9476
9477< {only available when compiled with the |+timers| feature}
9478
9479 *timer_start()* *timer* *timers*
9480timer_start({time}, {callback} [, {options}])
9481 Create a timer and return the timer ID.
9482
9483 {time} is the waiting time in milliseconds. This is the
9484 minimum time before invoking the callback. When the system is
9485 busy or Vim is not waiting for input the time will be longer.
9486
9487 {callback} is the function to call. It can be the name of a
9488 function or a |Funcref|. It is called with one argument, which
9489 is the timer ID. The callback is only invoked when Vim is
9490 waiting for input.
9491 If you want to show a message look at |popup_notification()|
9492 to avoid interfering with what the user is doing.
9493
9494 {options} is a dictionary. Supported entries:
9495 "repeat" Number of times to repeat calling the
9496 callback. -1 means forever. When not present
9497 the callback will be called once.
9498 If the timer causes an error three times in a
9499 row the repeat is cancelled. This avoids that
9500 Vim becomes unusable because of all the error
9501 messages.
9502
9503 Example: >
9504 func MyHandler(timer)
9505 echo 'Handler called'
9506 endfunc
9507 let timer = timer_start(500, 'MyHandler',
9508 \ {'repeat': 3})
9509< This will invoke MyHandler() three times at 500 msec
9510 intervals.
9511
9512 Can also be used as a |method|: >
9513 GetMsec()->timer_start(callback)
9514
9515< Not available in the |sandbox|.
9516 {only available when compiled with the |+timers| feature}
9517
9518timer_stop({timer}) *timer_stop()*
9519 Stop a timer. The timer callback will no longer be invoked.
9520 {timer} is an ID returned by timer_start(), thus it must be a
9521 Number. If {timer} does not exist there is no error.
9522
9523 Can also be used as a |method|: >
9524 GetTimer()->timer_stop()
9525
9526< {only available when compiled with the |+timers| feature}
9527
9528timer_stopall() *timer_stopall()*
9529 Stop all timers. The timer callbacks will no longer be
9530 invoked. Useful if a timer is misbehaving. If there are no
9531 timers there is no error.
9532
9533 {only available when compiled with the |+timers| feature}
9534
9535tolower({expr}) *tolower()*
9536 The result is a copy of the String given, with all uppercase
9537 characters turned into lowercase (just like applying |gu| to
9538 the string).
9539
9540 Can also be used as a |method|: >
9541 GetText()->tolower()
9542
9543toupper({expr}) *toupper()*
9544 The result is a copy of the String given, with all lowercase
9545 characters turned into uppercase (just like applying |gU| to
9546 the string).
9547
9548 Can also be used as a |method|: >
9549 GetText()->toupper()
9550
9551tr({src}, {fromstr}, {tostr}) *tr()*
9552 The result is a copy of the {src} string with all characters
9553 which appear in {fromstr} replaced by the character in that
9554 position in the {tostr} string. Thus the first character in
9555 {fromstr} is translated into the first character in {tostr}
9556 and so on. Exactly like the unix "tr" command.
9557 This code also deals with multibyte characters properly.
9558
9559 Examples: >
9560 echo tr("hello there", "ht", "HT")
9561< returns "Hello THere" >
9562 echo tr("<blob>", "<>", "{}")
9563< returns "{blob}"
9564
9565 Can also be used as a |method|: >
9566 GetText()->tr(from, to)
9567
9568trim({text} [, {mask} [, {dir}]]) *trim()*
9569 Return {text} as a String where any character in {mask} is
9570 removed from the beginning and/or end of {text}.
9571
9572 If {mask} is not given, {mask} is all characters up to 0x20,
9573 which includes Tab, space, NL and CR, plus the non-breaking
9574 space character 0xa0.
9575
9576 The optional {dir} argument specifies where to remove the
9577 characters:
9578 0 remove from the beginning and end of {text}
9579 1 remove only at the beginning of {text}
9580 2 remove only at the end of {text}
9581 When omitted both ends are trimmed.
9582
9583 This function deals with multibyte characters properly.
9584
9585 Examples: >
9586 echo trim(" some text ")
9587< returns "some text" >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009588 echo trim(" \r\t\t\r RESERVE \t\n\x0B\xA0") .. "_TAIL"
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009589< returns "RESERVE_TAIL" >
9590 echo trim("rm<Xrm<>X>rrm", "rm<>")
9591< returns "Xrm<>X" (characters in the middle are not removed) >
9592 echo trim(" vim ", " ", 2)
9593< returns " vim"
9594
9595 Can also be used as a |method|: >
9596 GetText()->trim()
9597
9598trunc({expr}) *trunc()*
9599 Return the largest integral value with magnitude less than or
9600 equal to {expr} as a |Float| (truncate towards zero).
9601 {expr} must evaluate to a |Float| or a |Number|.
9602 Examples: >
9603 echo trunc(1.456)
9604< 1.0 >
9605 echo trunc(-5.456)
9606< -5.0 >
9607 echo trunc(4.0)
9608< 4.0
9609
9610 Can also be used as a |method|: >
9611 Compute()->trunc()
9612<
9613 {only available when compiled with the |+float| feature}
9614
9615 *type()*
9616type({expr}) The result is a Number representing the type of {expr}.
9617 Instead of using the number directly, it is better to use the
9618 v:t_ variable that has the value:
9619 Number: 0 |v:t_number|
9620 String: 1 |v:t_string|
9621 Funcref: 2 |v:t_func|
9622 List: 3 |v:t_list|
9623 Dictionary: 4 |v:t_dict|
9624 Float: 5 |v:t_float|
9625 Boolean: 6 |v:t_bool| (v:false and v:true)
9626 None: 7 |v:t_none| (v:null and v:none)
9627 Job: 8 |v:t_job|
9628 Channel: 9 |v:t_channel|
9629 Blob: 10 |v:t_blob|
9630 For backward compatibility, this method can be used: >
9631 :if type(myvar) == type(0)
9632 :if type(myvar) == type("")
9633 :if type(myvar) == type(function("tr"))
9634 :if type(myvar) == type([])
9635 :if type(myvar) == type({})
9636 :if type(myvar) == type(0.0)
9637 :if type(myvar) == type(v:false)
9638 :if type(myvar) == type(v:none)
9639< To check if the v:t_ variables exist use this: >
9640 :if exists('v:t_number')
9641
9642< Can also be used as a |method|: >
9643 mylist->type()
9644
9645
9646typename({expr}) *typename()*
9647 Return a string representation of the type of {expr}.
9648 Example: >
9649 echo typename([1, 2, 3])
9650 list<number>
9651
9652
9653undofile({name}) *undofile()*
9654 Return the name of the undo file that would be used for a file
9655 with name {name} when writing. This uses the 'undodir'
9656 option, finding directories that exist. It does not check if
9657 the undo file exists.
9658 {name} is always expanded to the full path, since that is what
9659 is used internally.
9660 If {name} is empty undofile() returns an empty string, since a
9661 buffer without a file name will not write an undo file.
9662 Useful in combination with |:wundo| and |:rundo|.
9663 When compiled without the |+persistent_undo| option this always
9664 returns an empty string.
9665
9666 Can also be used as a |method|: >
9667 GetFilename()->undofile()
9668
9669undotree() *undotree()*
9670 Return the current state of the undo tree in a dictionary with
9671 the following items:
9672 "seq_last" The highest undo sequence number used.
9673 "seq_cur" The sequence number of the current position in
9674 the undo tree. This differs from "seq_last"
9675 when some changes were undone.
9676 "time_cur" Time last used for |:earlier| and related
9677 commands. Use |strftime()| to convert to
9678 something readable.
9679 "save_last" Number of the last file write. Zero when no
9680 write yet.
9681 "save_cur" Number of the current position in the undo
9682 tree.
9683 "synced" Non-zero when the last undo block was synced.
9684 This happens when waiting from input from the
9685 user. See |undo-blocks|.
9686 "entries" A list of dictionaries with information about
9687 undo blocks.
9688
9689 The first item in the "entries" list is the oldest undo item.
9690 Each List item is a |Dictionary| with these items:
9691 "seq" Undo sequence number. Same as what appears in
9692 |:undolist|.
9693 "time" Timestamp when the change happened. Use
9694 |strftime()| to convert to something readable.
9695 "newhead" Only appears in the item that is the last one
9696 that was added. This marks the last change
9697 and where further changes will be added.
9698 "curhead" Only appears in the item that is the last one
9699 that was undone. This marks the current
9700 position in the undo tree, the block that will
9701 be used by a redo command. When nothing was
9702 undone after the last change this item will
9703 not appear anywhere.
9704 "save" Only appears on the last block before a file
9705 write. The number is the write count. The
9706 first write has number 1, the last one the
9707 "save_last" mentioned above.
9708 "alt" Alternate entry. This is again a List of undo
9709 blocks. Each item may again have an "alt"
9710 item.
9711
9712uniq({list} [, {func} [, {dict}]]) *uniq()* *E882*
9713 Remove second and succeeding copies of repeated adjacent
9714 {list} items in-place. Returns {list}. If you want a list
9715 to remain unmodified make a copy first: >
9716 :let newlist = uniq(copy(mylist))
9717< The default compare function uses the string representation of
9718 each item. For the use of {func} and {dict} see |sort()|.
9719
9720 Can also be used as a |method|: >
9721 mylist->uniq()
9722
9723values({dict}) *values()*
9724 Return a |List| with all the values of {dict}. The |List| is
9725 in arbitrary order. Also see |items()| and |keys()|.
9726
9727 Can also be used as a |method|: >
9728 mydict->values()
9729
9730virtcol({expr}) *virtcol()*
9731 The result is a Number, which is the screen column of the file
9732 position given with {expr}. That is, the last screen position
9733 occupied by the character at that position, when the screen
9734 would be of unlimited width. When there is a <Tab> at the
9735 position, the returned Number will be the column at the end of
9736 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
9737 set to 8, it returns 8. |conceal| is ignored.
9738 For the byte position use |col()|.
9739 For the use of {expr} see |col()|.
9740 When 'virtualedit' is used {expr} can be [lnum, col, off], where
9741 "off" is the offset in screen columns from the start of the
9742 character. E.g., a position within a <Tab> or after the last
9743 character. When "off" is omitted zero is used.
9744 When Virtual editing is active in the current mode, a position
9745 beyond the end of the line can be returned. |'virtualedit'|
9746 The accepted positions are:
9747 . the cursor position
9748 $ the end of the cursor line (the result is the
9749 number of displayed characters in the cursor line
9750 plus one)
9751 'x position of mark x (if the mark is not set, 0 is
9752 returned)
9753 v In Visual mode: the start of the Visual area (the
9754 cursor is the end). When not in Visual mode
9755 returns the cursor position. Differs from |'<| in
9756 that it's updated right away.
9757 Note that only marks in the current file can be used.
9758 Examples: >
9759 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
9760 virtcol("$") with text "foo^Lbar", returns 9
9761 virtcol("'t") with text " there", with 't at 'h', returns 6
9762< The first column is 1. 0 is returned for an error.
9763 A more advanced example that echoes the maximum length of
9764 all lines: >
9765 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
9766
9767< Can also be used as a |method|: >
9768 GetPos()->virtcol()
9769
9770
9771visualmode([{expr}]) *visualmode()*
9772 The result is a String, which describes the last Visual mode
9773 used in the current buffer. Initially it returns an empty
9774 string, but once Visual mode has been used, it returns "v",
9775 "V", or "<CTRL-V>" (a single CTRL-V character) for
9776 character-wise, line-wise, or block-wise Visual mode
9777 respectively.
9778 Example: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009779 :exe "normal " .. visualmode()
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009780< This enters the same Visual mode as before. It is also useful
9781 in scripts if you wish to act differently depending on the
9782 Visual mode that was used.
9783 If Visual mode is active, use |mode()| to get the Visual mode
9784 (e.g., in a |:vmap|).
9785 If {expr} is supplied and it evaluates to a non-zero Number or
9786 a non-empty String, then the Visual mode will be cleared and
9787 the old value is returned. See |non-zero-arg|.
9788
9789wildmenumode() *wildmenumode()*
9790 Returns |TRUE| when the wildmenu is active and |FALSE|
9791 otherwise. See 'wildmenu' and 'wildmode'.
9792 This can be used in mappings to handle the 'wildcharm' option
9793 gracefully. (Makes only sense with |mapmode-c| mappings).
9794
9795 For example to make <c-j> work like <down> in wildmode, use: >
9796 :cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"
9797<
9798 (Note, this needs the 'wildcharm' option set appropriately).
9799
9800win_execute({id}, {command} [, {silent}]) *win_execute()*
9801 Like `execute()` but in the context of window {id}.
9802 The window will temporarily be made the current window,
9803 without triggering autocommands or changing directory. When
9804 executing {command} autocommands will be triggered, this may
9805 have unexpected side effects. Use |:noautocmd| if needed.
9806 Example: >
9807 call win_execute(winid, 'set syntax=python')
9808< Doing the same with `setwinvar()` would not trigger
9809 autocommands and not actually show syntax highlighting.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009810 *E994*
9811 Not all commands are allowed in popup windows.
9812 When window {id} does not exist then no error is given and
9813 an empty string is returned.
9814
9815 Can also be used as a |method|, the base is passed as the
9816 second argument: >
9817 GetCommand()->win_execute(winid)
9818
9819win_findbuf({bufnr}) *win_findbuf()*
9820 Returns a |List| with |window-ID|s for windows that contain
9821 buffer {bufnr}. When there is none the list is empty.
9822
9823 Can also be used as a |method|: >
9824 GetBufnr()->win_findbuf()
9825
9826win_getid([{win} [, {tab}]]) *win_getid()*
9827 Get the |window-ID| for the specified window.
9828 When {win} is missing use the current window.
9829 With {win} this is the window number. The top window has
9830 number 1.
9831 Without {tab} use the current tab, otherwise the tab with
9832 number {tab}. The first tab has number one.
9833 Return zero if the window cannot be found.
9834
9835 Can also be used as a |method|: >
9836 GetWinnr()->win_getid()
9837
9838
9839win_gettype([{nr}]) *win_gettype()*
9840 Return the type of the window:
9841 "autocmd" autocommand window. Temporary window
9842 used to execute autocommands.
9843 "command" command-line window |cmdwin|
9844 (empty) normal window
9845 "loclist" |location-list-window|
9846 "popup" popup window |popup|
9847 "preview" preview window |preview-window|
9848 "quickfix" |quickfix-window|
9849 "unknown" window {nr} not found
9850
9851 When {nr} is omitted return the type of the current window.
9852 When {nr} is given return the type of this window by number or
9853 |window-ID|.
9854
9855 Also see the 'buftype' option. When running a terminal in a
9856 popup window then 'buftype' is "terminal" and win_gettype()
9857 returns "popup".
9858
9859 Can also be used as a |method|: >
9860 GetWinid()->win_gettype()
9861<
9862win_gotoid({expr}) *win_gotoid()*
9863 Go to window with ID {expr}. This may also change the current
9864 tabpage.
9865 Return TRUE if successful, FALSE if the window cannot be found.
9866
9867 Can also be used as a |method|: >
9868 GetWinid()->win_gotoid()
9869
9870win_id2tabwin({expr}) *win_id2tabwin()*
9871 Return a list with the tab number and window number of window
9872 with ID {expr}: [tabnr, winnr].
9873 Return [0, 0] if the window cannot be found.
9874
9875 Can also be used as a |method|: >
9876 GetWinid()->win_id2tabwin()
9877
9878win_id2win({expr}) *win_id2win()*
9879 Return the window number of window with ID {expr}.
9880 Return 0 if the window cannot be found in the current tabpage.
9881
9882 Can also be used as a |method|: >
9883 GetWinid()->win_id2win()
9884
Daniel Steinbergee630312022-01-10 13:36:34 +00009885win_move_separator({nr}, {offset}) *win_move_separator()*
9886 Move window {nr}'s vertical separator (i.e., the right border)
9887 by {offset} columns, as if being dragged by the mouse. {nr}
9888 can be a window number or |window-ID|. A positive {offset}
9889 moves right and a negative {offset} moves left. Moving a
9890 window's vertical separator will change the width of the
9891 window and the width of other windows adjacent to the vertical
9892 separator. The magnitude of movement may be smaller than
9893 specified (e.g., as a consequence of maintaining
9894 'winminwidth'). Returns TRUE if the window can be found and
9895 FALSE otherwise.
9896
9897 Can also be used as a |method|: >
9898 GetWinnr()->win_move_separator(offset)
9899
9900win_move_statusline({nr}, {offset}) *win_move_statusline()*
9901 Move window {nr}'s status line (i.e., the bottom border) by
9902 {offset} rows, as if being dragged by the mouse. {nr} can be a
9903 window number or |window-ID|. A positive {offset} moves down
9904 and a negative {offset} moves up. Moving a window's status
9905 line will change the height of the window and the height of
9906 other windows adjacent to the status line. The magnitude of
9907 movement may be smaller than specified (e.g., as a consequence
9908 of maintaining 'winminheight'). Returns TRUE if the window can
9909 be found and FALSE otherwise.
9910
9911 Can also be used as a |method|: >
9912 GetWinnr()->win_move_statusline(offset)
9913
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009914win_screenpos({nr}) *win_screenpos()*
9915 Return the screen position of window {nr} as a list with two
9916 numbers: [row, col]. The first window always has position
9917 [1, 1], unless there is a tabline, then it is [2, 1].
9918 {nr} can be the window number or the |window-ID|. Use zero
9919 for the current window.
9920 Returns [0, 0] if the window cannot be found in the current
9921 tabpage.
9922
9923 Can also be used as a |method|: >
9924 GetWinid()->win_screenpos()
9925<
9926win_splitmove({nr}, {target} [, {options}]) *win_splitmove()*
9927 Move the window {nr} to a new split of the window {target}.
9928 This is similar to moving to {target}, creating a new window
9929 using |:split| but having the same contents as window {nr}, and
9930 then closing {nr}.
9931
9932 Both {nr} and {target} can be window numbers or |window-ID|s.
9933 Both must be in the current tab page.
9934
9935 Returns zero for success, non-zero for failure.
9936
9937 {options} is a |Dictionary| with the following optional entries:
9938 "vertical" When TRUE, the split is created vertically,
9939 like with |:vsplit|.
9940 "rightbelow" When TRUE, the split is made below or to the
9941 right (if vertical). When FALSE, it is done
9942 above or to the left (if vertical). When not
9943 present, the values of 'splitbelow' and
9944 'splitright' are used.
9945
9946 Can also be used as a |method|: >
9947 GetWinid()->win_splitmove(target)
9948<
9949
9950 *winbufnr()*
9951winbufnr({nr}) The result is a Number, which is the number of the buffer
9952 associated with window {nr}. {nr} can be the window number or
9953 the |window-ID|.
9954 When {nr} is zero, the number of the buffer in the current
9955 window is returned.
9956 When window {nr} doesn't exist, -1 is returned.
9957 Example: >
9958 :echo "The file in the current window is " . bufname(winbufnr(0))
9959<
9960 Can also be used as a |method|: >
9961 FindWindow()->winbufnr()->bufname()
9962<
9963 *wincol()*
9964wincol() The result is a Number, which is the virtual column of the
9965 cursor in the window. This is counting screen cells from the
9966 left side of the window. The leftmost column is one.
9967
9968 *windowsversion()*
9969windowsversion()
9970 The result is a String. For MS-Windows it indicates the OS
9971 version. E.g, Windows 10 is "10.0", Windows 8 is "6.2",
9972 Windows XP is "5.1". For non-MS-Windows systems the result is
9973 an empty string.
9974
9975winheight({nr}) *winheight()*
9976 The result is a Number, which is the height of window {nr}.
9977 {nr} can be the window number or the |window-ID|.
9978 When {nr} is zero, the height of the current window is
9979 returned. When window {nr} doesn't exist, -1 is returned.
9980 An existing window always has a height of zero or more.
9981 This excludes any window toolbar line.
9982 Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +00009983 :echo "The current window has " .. winheight(0) .. " lines."
Bram Moolenaar1cae5a02021-12-27 21:28:34 +00009984
9985< Can also be used as a |method|: >
9986 GetWinid()->winheight()
9987<
9988winlayout([{tabnr}]) *winlayout()*
9989 The result is a nested List containing the layout of windows
9990 in a tabpage.
9991
9992 Without {tabnr} use the current tabpage, otherwise the tabpage
9993 with number {tabnr}. If the tabpage {tabnr} is not found,
9994 returns an empty list.
9995
9996 For a leaf window, it returns:
9997 ['leaf', {winid}]
9998 For horizontally split windows, which form a column, it
9999 returns:
10000 ['col', [{nested list of windows}]]
10001 For vertically split windows, which form a row, it returns:
10002 ['row', [{nested list of windows}]]
10003
10004 Example: >
10005 " Only one window in the tab page
10006 :echo winlayout()
10007 ['leaf', 1000]
10008 " Two horizontally split windows
10009 :echo winlayout()
10010 ['col', [['leaf', 1000], ['leaf', 1001]]]
10011 " The second tab page, with three horizontally split
10012 " windows, with two vertically split windows in the
10013 " middle window
10014 :echo winlayout(2)
10015 ['col', [['leaf', 1002], ['row', [['leaf', 1003],
10016 ['leaf', 1001]]], ['leaf', 1000]]]
10017<
10018 Can also be used as a |method|: >
10019 GetTabnr()->winlayout()
10020<
10021 *winline()*
10022winline() The result is a Number, which is the screen line of the cursor
10023 in the window. This is counting screen lines from the top of
10024 the window. The first line is one.
10025 If the cursor was moved the view on the file will be updated
10026 first, this may cause a scroll.
10027
10028 *winnr()*
10029winnr([{arg}]) The result is a Number, which is the number of the current
10030 window. The top window has number 1.
10031 Returns zero for a popup window.
10032
10033 The optional argument {arg} supports the following values:
10034 $ the number of the last window (the window
10035 count).
10036 # the number of the last accessed window (where
10037 |CTRL-W_p| goes to). If there is no previous
10038 window or it is in another tab page 0 is
10039 returned.
10040 {N}j the number of the Nth window below the
10041 current window (where |CTRL-W_j| goes to).
10042 {N}k the number of the Nth window above the current
10043 window (where |CTRL-W_k| goes to).
10044 {N}h the number of the Nth window left of the
10045 current window (where |CTRL-W_h| goes to).
10046 {N}l the number of the Nth window right of the
10047 current window (where |CTRL-W_l| goes to).
10048 The number can be used with |CTRL-W_w| and ":wincmd w"
10049 |:wincmd|.
10050 Also see |tabpagewinnr()| and |win_getid()|.
10051 Examples: >
10052 let window_count = winnr('$')
10053 let prev_window = winnr('#')
10054 let wnum = winnr('3k')
10055
10056< Can also be used as a |method|: >
10057 GetWinval()->winnr()
10058<
10059 *winrestcmd()*
10060winrestcmd() Returns a sequence of |:resize| commands that should restore
10061 the current window sizes. Only works properly when no windows
10062 are opened or closed and the current window and tab page is
10063 unchanged.
10064 Example: >
10065 :let cmd = winrestcmd()
10066 :call MessWithWindowSizes()
10067 :exe cmd
10068<
10069 *winrestview()*
10070winrestview({dict})
10071 Uses the |Dictionary| returned by |winsaveview()| to restore
10072 the view of the current window.
10073 Note: The {dict} does not have to contain all values, that are
10074 returned by |winsaveview()|. If values are missing, those
10075 settings won't be restored. So you can use: >
10076 :call winrestview({'curswant': 4})
10077<
10078 This will only set the curswant value (the column the cursor
10079 wants to move on vertical movements) of the cursor to column 5
10080 (yes, that is 5), while all other settings will remain the
10081 same. This is useful, if you set the cursor position manually.
10082
10083 If you have changed the values the result is unpredictable.
10084 If the window size changed the result won't be the same.
10085
10086 Can also be used as a |method|: >
10087 GetView()->winrestview()
10088<
10089 *winsaveview()*
10090winsaveview() Returns a |Dictionary| that contains information to restore
10091 the view of the current window. Use |winrestview()| to
10092 restore the view.
10093 This is useful if you have a mapping that jumps around in the
10094 buffer and you want to go back to the original view.
10095 This does not save fold information. Use the 'foldenable'
10096 option to temporarily switch off folding, so that folds are
10097 not opened when moving around. This may have side effects.
10098 The return value includes:
10099 lnum cursor line number
10100 col cursor column (Note: the first column
naohiro ono56200ee2022-01-01 14:59:44 +000010101 zero, as opposed to what |getcurpos()|
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010102 returns)
10103 coladd cursor column offset for 'virtualedit'
naohiro ono56200ee2022-01-01 14:59:44 +000010104 curswant column for vertical movement (Note:
10105 the first column is zero, as opposed
10106 to what |getcurpos()| returns). After
10107 |$| command it will be a very large
10108 number equal to |v:maxcol|.
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010109 topline first line in the window
10110 topfill filler lines, only in diff mode
10111 leftcol first column displayed; only used when
10112 'wrap' is off
10113 skipcol columns skipped
10114 Note that no option values are saved.
10115
10116
10117winwidth({nr}) *winwidth()*
10118 The result is a Number, which is the width of window {nr}.
10119 {nr} can be the window number or the |window-ID|.
10120 When {nr} is zero, the width of the current window is
10121 returned. When window {nr} doesn't exist, -1 is returned.
10122 An existing window always has a width of zero or more.
10123 Examples: >
Bram Moolenaarc51cf032022-02-26 12:25:45 +000010124 :echo "The current window has " .. winwidth(0) .. " columns."
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010125 :if winwidth(0) <= 50
10126 : 50 wincmd |
10127 :endif
10128< For getting the terminal or screen size, see the 'columns'
10129 option.
10130
10131 Can also be used as a |method|: >
10132 GetWinid()->winwidth()
10133
10134
10135wordcount() *wordcount()*
10136 The result is a dictionary of byte/chars/word statistics for
10137 the current buffer. This is the same info as provided by
10138 |g_CTRL-G|
10139 The return value includes:
10140 bytes Number of bytes in the buffer
10141 chars Number of chars in the buffer
10142 words Number of words in the buffer
10143 cursor_bytes Number of bytes before cursor position
10144 (not in Visual mode)
10145 cursor_chars Number of chars before cursor position
10146 (not in Visual mode)
10147 cursor_words Number of words before cursor position
10148 (not in Visual mode)
10149 visual_bytes Number of bytes visually selected
10150 (only in Visual mode)
10151 visual_chars Number of chars visually selected
10152 (only in Visual mode)
10153 visual_words Number of words visually selected
10154 (only in Visual mode)
10155
10156
10157 *writefile()*
10158writefile({object}, {fname} [, {flags}])
10159 When {object} is a |List| write it to file {fname}. Each list
10160 item is separated with a NL. Each list item must be a String
10161 or Number.
10162 When {flags} contains "b" then binary mode is used: There will
10163 not be a NL after the last list item. An empty item at the
10164 end does cause the last line in the file to end in a NL.
10165
10166 When {object} is a |Blob| write the bytes to file {fname}
10167 unmodified.
10168
10169 When {flags} contains "a" then append mode is used, lines are
10170 appended to the file: >
10171 :call writefile(["foo"], "event.log", "a")
10172 :call writefile(["bar"], "event.log", "a")
10173<
10174 When {flags} contains "s" then fsync() is called after writing
10175 the file. This flushes the file to disk, if possible. This
10176 takes more time but avoids losing the file if the system
10177 crashes.
10178 When {flags} does not contain "S" or "s" then fsync() is
10179 called if the 'fsync' option is set.
10180 When {flags} contains "S" then fsync() is not called, even
10181 when 'fsync' is set.
10182
10183 All NL characters are replaced with a NUL character.
10184 Inserting CR characters needs to be done before passing {list}
10185 to writefile().
10186 An existing file is overwritten, if possible.
10187 When the write fails -1 is returned, otherwise 0. There is an
10188 error message if the file can't be created or when writing
10189 fails.
10190 Also see |readfile()|.
10191 To copy a file byte for byte: >
10192 :let fl = readfile("foo", "b")
10193 :call writefile(fl, "foocopy", "b")
10194
10195< Can also be used as a |method|: >
10196 GetText()->writefile("thefile")
10197
10198
10199xor({expr}, {expr}) *xor()*
10200 Bitwise XOR on the two arguments. The arguments are converted
10201 to a number. A List, Dict or Float argument causes an error.
10202 Example: >
10203 :let bits = xor(bits, 0x80)
10204<
10205 Can also be used as a |method|: >
10206 :let bits = bits->xor(0x80)
10207<
10208
10209==============================================================================
102103. Feature list *feature-list*
10211
10212There are three types of features:
102131. Features that are only supported when they have been enabled when Vim
10214 was compiled |+feature-list|. Example: >
10215 :if has("cindent")
10216< *gui_running*
102172. Features that are only supported when certain conditions have been met.
10218 Example: >
10219 :if has("gui_running")
10220< *has-patch*
102213. Beyond a certain version or at a certain version and including a specific
10222 patch. The "patch-7.4.248" feature means that the Vim version is 7.5 or
10223 later, or it is version 7.4 and patch 248 was included. Example: >
10224 :if has("patch-7.4.248")
10225< Note that it's possible for patch 248 to be omitted even though 249 is
10226 included. Only happens when cherry-picking patches.
10227 Note that this form only works for patch 7.4.237 and later, before that
10228 you need to check for the patch and the v:version. Example (checking
10229 version 6.2.148 or later): >
10230 :if v:version > 602 || (v:version == 602 && has("patch148"))
10231
10232Hint: To find out if Vim supports backslashes in a file name (MS-Windows),
10233use: `if exists('+shellslash')`
10234
10235
10236acl Compiled with |ACL| support.
10237all_builtin_terms Compiled with all builtin terminals enabled.
10238amiga Amiga version of Vim.
10239arabic Compiled with Arabic support |Arabic|.
10240arp Compiled with ARP support (Amiga).
10241autocmd Compiled with autocommand support. (always true)
10242autochdir Compiled with support for 'autochdir'
10243autoservername Automatically enable |clientserver|
10244balloon_eval Compiled with |balloon-eval| support.
10245balloon_multiline GUI supports multiline balloons.
10246beos BeOS version of Vim.
10247browse Compiled with |:browse| support, and browse() will
10248 work.
10249browsefilter Compiled with support for |browsefilter|.
10250bsd Compiled on an OS in the BSD family (excluding macOS).
10251builtin_terms Compiled with some builtin terminals.
10252byte_offset Compiled with support for 'o' in 'statusline'
10253channel Compiled with support for |channel| and |job|
10254cindent Compiled with 'cindent' support.
10255clientserver Compiled with remote invocation support |clientserver|.
10256clipboard Compiled with 'clipboard' support.
10257clipboard_working Compiled with 'clipboard' support and it can be used.
10258cmdline_compl Compiled with |cmdline-completion| support.
10259cmdline_hist Compiled with |cmdline-history| support.
10260cmdline_info Compiled with 'showcmd' and 'ruler' support.
10261comments Compiled with |'comments'| support.
10262compatible Compiled to be very Vi compatible.
10263conpty Platform where |ConPTY| can be used.
10264cryptv Compiled with encryption support |encryption|.
10265cscope Compiled with |cscope| support.
10266cursorbind Compiled with |'cursorbind'| (always true)
10267debug Compiled with "DEBUG" defined.
10268dialog_con Compiled with console dialog support.
10269dialog_gui Compiled with GUI dialog support.
10270diff Compiled with |vimdiff| and 'diff' support.
10271digraphs Compiled with support for digraphs.
10272directx Compiled with support for DirectX and 'renderoptions'.
10273dnd Compiled with support for the "~ register |quote_~|.
10274drop_file Compiled with |drop_file| support.
10275ebcdic Compiled on a machine with ebcdic character set.
10276emacs_tags Compiled with support for Emacs tags.
10277eval Compiled with expression evaluation support. Always
10278 true, of course!
10279ex_extra |+ex_extra| (always true)
10280extra_search Compiled with support for |'incsearch'| and
10281 |'hlsearch'|
10282farsi Support for Farsi was removed |farsi|.
10283file_in_path Compiled with support for |gf| and |<cfile>|
10284filterpipe When 'shelltemp' is off pipes are used for shell
10285 read/write/filter commands
10286find_in_path Compiled with support for include file searches
10287 |+find_in_path|.
10288float Compiled with support for |Float|.
10289fname_case Case in file names matters (for Amiga and MS-Windows
10290 this is not present).
10291folding Compiled with |folding| support.
10292footer Compiled with GUI footer support. |gui-footer|
10293fork Compiled to use fork()/exec() instead of system().
10294gettext Compiled with message translation |multi-lang|
10295gui Compiled with GUI enabled.
Bram Moolenaarcbaff5e2022-04-08 17:45:08 +010010296gui_athena Compiled with Athena GUI (always false).
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010297gui_gnome Compiled with Gnome support (gui_gtk is also defined).
10298gui_gtk Compiled with GTK+ GUI (any version).
10299gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
10300gui_gtk3 Compiled with GTK+ 3 GUI (gui_gtk is also defined).
10301gui_haiku Compiled with Haiku GUI.
10302gui_mac Compiled with Macintosh GUI.
10303gui_motif Compiled with Motif GUI.
10304gui_photon Compiled with Photon GUI.
10305gui_running Vim is running in the GUI, or it will start soon.
10306gui_win32 Compiled with MS-Windows Win32 GUI.
10307gui_win32s idem, and Win32s system being used (Windows 3.1)
10308haiku Haiku version of Vim.
10309hangul_input Compiled with Hangul input support. |hangul|
10310hpux HP-UX version of Vim.
10311iconv Can use iconv() for conversion.
10312insert_expand Compiled with support for CTRL-X expansion commands in
10313 Insert mode. (always true)
10314job Compiled with support for |channel| and |job|
10315ipv6 Compiled with support for IPv6 networking in |channel|.
10316jumplist Compiled with |jumplist| support.
10317keymap Compiled with 'keymap' support.
10318lambda Compiled with |lambda| support.
10319langmap Compiled with 'langmap' support.
10320libcall Compiled with |libcall()| support.
10321linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and
10322 'breakindent' support.
10323linux Linux version of Vim.
10324lispindent Compiled with support for lisp indenting.
10325listcmds Compiled with commands for the buffer list |:files|
10326 and the argument list |arglist|.
10327localmap Compiled with local mappings and abbr. |:map-local|
10328lua Compiled with Lua interface |Lua|.
10329mac Any Macintosh version of Vim cf. osx
10330macunix Synonym for osxdarwin
10331menu Compiled with support for |:menu|.
10332mksession Compiled with support for |:mksession|.
10333modify_fname Compiled with file name modifiers. |filename-modifiers|
10334 (always true)
10335mouse Compiled with support for mouse.
10336mouse_dec Compiled with support for Dec terminal mouse.
10337mouse_gpm Compiled with support for gpm (Linux console mouse)
10338mouse_gpm_enabled GPM mouse is working
10339mouse_netterm Compiled with support for netterm mouse.
10340mouse_pterm Compiled with support for qnx pterm mouse.
10341mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
10342mouse_sgr Compiled with support for sgr mouse.
10343mouse_urxvt Compiled with support for urxvt mouse.
10344mouse_xterm Compiled with support for xterm mouse.
10345mouseshape Compiled with support for 'mouseshape'.
10346multi_byte Compiled with support for 'encoding' (always true)
10347multi_byte_encoding 'encoding' is set to a multibyte encoding.
10348multi_byte_ime Compiled with support for IME input method.
10349multi_lang Compiled with support for multiple languages.
10350mzscheme Compiled with MzScheme interface |mzscheme|.
10351nanotime Compiled with sub-second time stamp checks.
10352netbeans_enabled Compiled with support for |netbeans| and connected.
10353netbeans_intg Compiled with support for |netbeans|.
10354num64 Compiled with 64-bit |Number| support.
10355ole Compiled with OLE automation support for Win32.
10356osx Compiled for macOS cf. mac
10357osxdarwin Compiled for macOS, with |mac-darwin-feature|
10358packages Compiled with |packages| support.
10359path_extra Compiled with up/downwards search in 'path' and 'tags'
10360perl Compiled with Perl interface.
10361persistent_undo Compiled with support for persistent undo history.
10362postscript Compiled with PostScript file printing.
10363printer Compiled with |:hardcopy| support.
10364profile Compiled with |:profile| support.
10365python Python 2.x interface available. |has-python|
10366python_compiled Compiled with Python 2.x interface. |has-python|
10367python_dynamic Python 2.x interface is dynamically loaded. |has-python|
10368python3 Python 3.x interface available. |has-python|
10369python3_compiled Compiled with Python 3.x interface. |has-python|
10370python3_dynamic Python 3.x interface is dynamically loaded. |has-python|
10371pythonx Python 2.x and/or 3.x interface available. |python_x|
10372qnx QNX version of Vim.
10373quickfix Compiled with |quickfix| support.
10374reltime Compiled with |reltime()| support.
10375rightleft Compiled with 'rightleft' support.
10376ruby Compiled with Ruby interface |ruby|.
10377scrollbind Compiled with 'scrollbind' support. (always true)
10378showcmd Compiled with 'showcmd' support.
10379signs Compiled with |:sign| support.
10380smartindent Compiled with 'smartindent' support.
10381sodium Compiled with libsodium for better crypt support
10382sound Compiled with sound support, e.g. `sound_playevent()`
10383spell Compiled with spell checking support |spell|.
10384startuptime Compiled with |--startuptime| support.
10385statusline Compiled with support for 'statusline', 'rulerformat'
10386 and special formats of 'titlestring' and 'iconstring'.
10387sun SunOS version of Vim.
10388sun_workshop Support for Sun |workshop| has been removed.
10389syntax Compiled with syntax highlighting support |syntax|.
10390syntax_items There are active syntax highlighting items for the
10391 current buffer.
10392system Compiled to use system() instead of fork()/exec().
10393tag_binary Compiled with binary searching in tags files
10394 |tag-binary-search|.
10395tag_old_static Support for old static tags was removed, see
10396 |tag-old-static|.
10397tcl Compiled with Tcl interface.
10398termguicolors Compiled with true color in terminal support.
10399terminal Compiled with |terminal| support.
10400terminfo Compiled with terminfo instead of termcap.
10401termresponse Compiled with support for |t_RV| and |v:termresponse|.
10402textobjects Compiled with support for |text-objects|.
10403textprop Compiled with support for |text-properties|.
10404tgetent Compiled with tgetent support, able to use a termcap
10405 or terminfo file.
10406timers Compiled with |timer_start()| support.
10407title Compiled with window title support |'title'|.
10408toolbar Compiled with support for |gui-toolbar|.
10409ttyin input is a terminal (tty)
10410ttyout output is a terminal (tty)
10411unix Unix version of Vim. *+unix*
10412unnamedplus Compiled with support for "unnamedplus" in 'clipboard'
10413user_commands User-defined commands. (always true)
10414vartabs Compiled with variable tabstop support |'vartabstop'|.
10415vcon Win32: Virtual console support is working, can use
10416 'termguicolors'. Also see |+vtp|.
10417vertsplit Compiled with vertically split windows |:vsplit|.
10418 (always true)
10419vim_starting True while initial source'ing takes place. |startup|
10420 *vim_starting*
Bram Moolenaara6feb162022-01-02 12:06:33 +000010421vim9script Compiled with |Vim9| script support
Bram Moolenaar1cae5a02021-12-27 21:28:34 +000010422viminfo Compiled with viminfo support.
10423vimscript-1 Compiled Vim script version 1 support
10424vimscript-2 Compiled Vim script version 2 support
10425vimscript-3 Compiled Vim script version 3 support
10426virtualedit Compiled with 'virtualedit' option. (always true)
10427visual Compiled with Visual mode. (always true)
10428visualextra Compiled with extra Visual mode commands. (always
10429 true) |blockwise-operators|.
10430vms VMS version of Vim.
10431vreplace Compiled with |gR| and |gr| commands. (always true)
10432vtp Compiled for vcon support |+vtp| (check vcon to find
10433 out if it works in the current console).
10434wildignore Compiled with 'wildignore' option.
10435wildmenu Compiled with 'wildmenu' option.
10436win16 old version for MS-Windows 3.1 (always false)
10437win32 Win32 version of Vim (MS-Windows 95 and later, 32 or
10438 64 bits)
10439win32unix Win32 version of Vim, using Unix files (Cygwin)
10440win64 Win64 version of Vim (MS-Windows 64 bit).
10441win95 Win32 version for MS-Windows 95/98/ME (always false)
10442winaltkeys Compiled with 'winaltkeys' option.
10443windows Compiled with support for more than one window.
10444 (always true)
10445writebackup Compiled with 'writebackup' default on.
10446xfontset Compiled with X fontset support |xfontset|.
10447xim Compiled with X input method support |xim|.
10448xpm Compiled with pixmap support.
10449xpm_w32 Compiled with pixmap support for Win32. (Only for
10450 backward compatibility. Use "xpm" instead.)
10451xsmp Compiled with X session management support.
10452xsmp_interact Compiled with interactive X session management support.
10453xterm_clipboard Compiled with support for xterm clipboard.
10454xterm_save Compiled with support for saving and restoring the
10455 xterm screen.
10456x11 Compiled with X11 support.
10457
10458
10459==============================================================================
104604. Matching a pattern in a String *string-match*
10461
10462This is common between several functions. A regexp pattern as explained at
10463|pattern| is normally used to find a match in the buffer lines. When a
10464pattern is used to find a match in a String, almost everything works in the
10465same way. The difference is that a String is handled like it is one line.
10466When it contains a "\n" character, this is not seen as a line break for the
10467pattern. It can be matched with a "\n" in the pattern, or with ".". Example:
10468>
10469 :let a = "aaaa\nxxxx"
10470 :echo matchstr(a, "..\n..")
10471 aa
10472 xx
10473 :echo matchstr(a, "a.x")
10474 a
10475 x
10476
10477Don't forget that "^" will only match at the first character of the String and
10478"$" at the last character of the string. They don't match after or before a
10479"\n".
10480
10481 vim:tw=78:ts=8:noet:ft=help:norl: