vim-jp / vimdoc-en / builtin

builtin - Vim Documentation

Return to main English | ζ—₯本θͺž
builtin.txt   For Vim version 9.1.  Last change: 2024 Jun 20

                  VIM REFERENCE MANUAL    by Bram Moolenaar

Builtin functions                               builtin-functions

Note: Expression evaluation can be disabled at compile time, the builtin
functions are not available then.  See +eval and no-eval-feature.

For functions grouped by what they are used for see function-list.

1. Overview                             builtin-function-list
2. Details                              builtin-function-details
3. Feature list                         feature-list
4. Matching a pattern in a String       string-match

1. Overview                                     builtin-function-list

Use CTRL-] on the function name to jump to the full explanation.

USAGE                           RESULT  DESCRIPTION

abs({expr})                     Float or Number  absolute value of {expr}
acos({expr})                    Float   arc cosine of {expr}
add({object}{item})           List/Blob   append {item} to {object}
and({expr}{expr})             Number  bitwise AND
append({lnum}{text})          Number  append {text} below line {lnum}
                                Number  append {text} below line {lnum}
                                        in buffer {expr}
argc([{winid}])                 Number  number of files in the argument list
argidx()                        Number  current index in the argument list
arglistid([{winnr} [, {tabnr}]]) Number argument list id
argv({nr} [, {winid}])          String  {nr} entry of the argument list
argv([-1, {winid}])             List    the argument list
asin({expr})                    Float   arc sine of {expr}
assert_beeps({cmd})             Number  assert {cmd} causes a beep
assert_equal({exp}{act} [, {msg}])
                                Number  assert {exp} is equal to {act}
assert_equalfile({fname-one}{fname-two} [, {msg}])
                                Number  assert file contents are equal
assert_exception({error} [, {msg}])
                                Number  assert {error} is in v:exception
assert_fails({cmd} [, {error} [, {msg} [, {lnum} [, {context}]]]])
                                Number  assert {cmd} fails
assert_false({actual} [, {msg}])
                                Number  assert {actual} is false
assert_inrange({lower}{upper}{actual} [, {msg}])
                                Number  assert {actual} is inside the range
assert_match({pat}{text} [, {msg}])
                                Number  assert {pat} matches {text}
assert_nobeep({cmd})            Number  assert {cmd} does not cause a beep
assert_notequal({exp}{act} [, {msg}])
                                Number  assert {exp} is not equal {act}
assert_notmatch({pat}{text} [, {msg}])
                                Number  assert {pat} not matches {text}
assert_report({msg})            Number  report a test failure
assert_true({actual} [, {msg}]) Number  assert {actual} is true
atan({expr})                    Float   arc tangent of {expr}
atan2({expr1}{expr2})         Float   arc tangent of {expr1} / {expr2}
autocmd_add({acmds})            Bool    add a list of autocmds and groups
autocmd_delete({acmds})         Bool    delete a list of autocmds and groups
autocmd_get([{opts}])           List    return a list of autocmds
balloon_gettext()               String  current text in the balloon
balloon_show({expr})            none    show {expr} inside the balloon
balloon_split({msg})            List    split {msg} as used for a balloon
                                none    bind text domain to specied path
blob2list({blob})               List    convert {blob} into a list of numbers
                                String  put up a file requester
browsedir({title}{initdir})   String  put up a directory requester
bufadd({name})                  Number  add a buffer to the buffer list
bufexists({buf})                Number  TRUE if buffer {buf} exists
buflisted({buf})                Number  TRUE if buffer {buf} is listed
bufload({buf})                  Number  load buffer {buf} if not loaded yet
bufloaded({buf})                Number  TRUE if buffer {buf} is loaded
bufname([{buf}])                String  Name of the buffer {buf}
bufnr([{buf} [, {create}]])     Number  Number of the buffer {buf}
bufwinid({buf})                 Number  window ID of buffer {buf}
bufwinnr({buf})                 Number  window number of buffer {buf}
byte2line({byte})               Number  line number at byte count {byte}
byteidx({expr}{nr} [, {utf16}])
                                Number  byte index of {nr}'th char in {expr}
byteidxcomp({expr}{nr} [, {utf16}])
                                Number  byte index of {nr}'th char in {expr}
call({func}{arglist} [, {dict}])
                                any     call {func} with arguments {arglist}
ceil({expr})                    Float   round {expr} up
ch_canread({handle})            Number  check if there is something to read
ch_close({handle})              none    close {handle}
ch_close_in({handle})           none    close in part of {handle}
ch_evalexpr({handle}{expr} [, {options}])
                                any     evaluate {expr} on JSON {handle}
ch_evalraw({handle}{string} [, {options}])
                                any     evaluate {string} on raw {handle}
ch_getbufnr({handle}{what})   Number  get buffer number for {handle}/{what}
ch_getjob({channel})            Job     get the Job of {channel}
ch_info({handle})               String  info about channel {handle}
ch_log({msg} [, {handle}])      none    write {msg} in the channel log file
ch_logfile({fname} [, {mode}])  none    start logging channel activity
ch_open({address} [, {options}])
                                Channel open a channel to {address}
ch_read({handle} [, {options}]) String  read from {handle}
ch_readblob({handle} [, {options}])
                                Blob    read Blob from {handle}
ch_readraw({handle} [, {options}])
                                String  read raw from {handle}
ch_sendexpr({handle}{expr} [, {options}])
                                any     send {expr} over JSON {handle}
ch_sendraw({handle}{expr} [, {options}])
                                any     send {expr} over raw {handle}
                                none    set options for {handle}
ch_status({handle} [, {options}])
                                String  status of channel {handle}
changenr()                      Number  current change number
char2nr({expr} [, {utf8}])      Number  ASCII/UTF-8 value of first char in {expr}
charclass({string})             Number  character class of {string}
charcol({expr} [, {winid}])     Number  column number of cursor or mark
charidx({string}{idx} [, {countcc} [, {utf16}]])
                                Number  char index of byte {idx} in {string}
chdir({dir})                    String  change current working directory
cindent({lnum})                 Number  C indent for line {lnum}
clearmatches([{win}])           none    clear all matches
col({expr} [, {winid}])         Number  column byte index of cursor or mark
complete({startcol}{matches}) none    set Insert mode completion
complete_add({expr})            Number  add completion match
complete_check()                Number  check for key typed during completion
complete_info([{what}])         Dict    get current completion information
confirm({msg} [, {choices} [, {default} [, {type}]]])
                                Number  number of choice picked by user
copy({expr})                    any     make a shallow copy of {expr}
cos({expr})                     Float   cosine of {expr}
cosh({expr})                    Float   hyperbolic cosine of {expr}
count({comp}{expr} [, {ic} [, {start}]])
                                Number  count how many {expr} are in {comp}
cscope_connection([{num}{dbpath} [, {prepend}]])
                                Number  checks existence of cscope connection
cursor({lnum}{col} [, {off}])
                                Number  move cursor to {lnum}{col}{off}
cursor({list})                  Number  move cursor to position in {list}
debugbreak({pid})               Number  interrupt process being debugged
deepcopy({expr} [, {noref}])    any     make a full copy of {expr}
delete({fname} [, {flags}])     Number  delete the file or directory {fname}
deletebufline({buf}{first} [, {last}])
                                Number  delete lines from buffer {buf}
did_filetype()                  Number  TRUE if FileType autocmd event used
diff({fromlist}{tolist} [, {options}])
                                List    diff two Lists of strings
diff_filler({lnum})             Number  diff filler lines about {lnum}
diff_hlID({lnum}{col})        Number  diff highlighting at {lnum}/{col}
digraph_get({chars})            String  get the digraph of {chars}
digraph_getlist([{listall}])    List    get all digraphs
digraph_set({chars}{digraph}) Bool    register digraph
digraph_setlist({digraphlist})  Bool    register multiple digraphs
echoraw({expr})                 none    output {expr} as-is
empty({expr})                   Number  TRUE if {expr} is empty
environ()                       Dict    return environment variables
err_teapot([{expr}])            none    give E418, or E503 if {expr} is TRUE
escape({string}{chars})       String  escape {chars} in {string} with '\'
eval({string})                  any     evaluate {string} into its value
eventhandler()                  Number  TRUE if inside an event handler
executable({expr})              Number  1 if executable {expr} exists
execute({command})              String  execute {command} and get the output
exepath({expr})                 String  full path of the command {expr}
exists({expr})                  Number  TRUE if {expr} exists
exists_compiled({expr})         Number  TRUE if {expr} exists at compile time
exp({expr})                     Float   exponential of {expr}
expand({expr} [, {nosuf} [, {list}]])
                                any     expand special keywords in {expr}
expandcmd({string} [, {options}])
                                String  expand {string} like with :edit
extend({expr1}{expr2} [, {expr3}])
                                List/Dict insert items of {expr2} into {expr1}
extendnew({expr1}{expr2} [, {expr3}])
                                List/Dict like extend() but creates a new
                                        List or Dictionary
feedkeys({string} [, {mode}])   Number  add key sequence to typeahead buffer
filecopy({from}{to})          Number  TRUE if copying file {from} to {to}
filereadable({file})            Number  TRUE if {file} is a readable file
filewritable({file})            Number  TRUE if {file} is a writable file
filter({expr1}{expr2})        List/Dict/Blob/String
                                        remove items from {expr1} where
                                        {expr2} is 0
finddir({name} [, {path} [, {count}]])
                                String  find directory {name} in {path}
findfile({name} [, {path} [, {count}]])
                                String  find file {name} in {path}
flatten({list} [, {maxdepth}])  List    flatten {list} up to {maxdepth} levels
flattennew({list} [, {maxdepth}])
                                List    flatten a copy of {list}
float2nr({expr})                Number  convert Float {expr} to a Number
floor({expr})                   Float   round {expr} down
fmod({expr1}{expr2})          Float   remainder of {expr1} / {expr2}
fnameescape({fname})            String  escape special characters in {fname}
fnamemodify({fname}{mods})    String  modify file name
foldclosed({lnum})              Number  first line of fold at {lnum} if closed
foldclosedend({lnum})           Number  last line of fold at {lnum} if closed
foldlevel({lnum})               Number  fold level at {lnum}
foldtext()                      String  line displayed for closed fold
foldtextresult({lnum})          String  text for closed fold at {lnum}
foreach({expr1}{expr2})       List/Dict/Blob/String
                                        for each item in {expr1} call {expr2}
foreground()                    Number  bring the Vim window to the foreground
fullcommand({name} [, {vim9}])  String  get full command from {name}
funcref({name} [, {arglist}] [, {dict}])
                                Funcref reference to function {name}
function({name} [, {arglist}] [, {dict}])
                                Funcref named reference to function {name}
garbagecollect([{atexit}])      none    free memory, breaking cyclic references
get({list}{idx} [, {def}])    any     get item {idx} from {list} or {def}
get({dict}{key} [, {def}])    any     get item {key} from {dict} or {def}
get({func}{what})             any     get property of funcref/partial {func}
getbufinfo([{buf}])             List    information about buffers
getbufline({buf}{lnum} [, {end}])
                                List    lines {lnum} to {end} of buffer {buf}
getbufoneline({buf}{lnum})    String  line {lnum} of buffer {buf}
getbufvar({buf}{varname} [, {def}])
                                any     variable {varname} in buffer {buf}
getcellwidths()                 List    get character cell width overrides
getchangelist([{buf}])          List    list of change list items
getchar([{expr}])               Number or String
                                        get one character from the user
getcharmod()                    Number  modifiers for the last typed character
getcharpos({expr})              List    position of cursor, mark, etc.
getcharsearch()                 Dict    last character search
getcharstr([{expr}])            String  get one character from the user
getcmdcompltype()               String  return the type of the current
                                        command-line completion
getcmdline()                    String  return the current command-line
getcmdpos()                     Number  return cursor position in command-line
getcmdscreenpos()               Number  return cursor screen position in
getcmdtype()                    String  return current command-line type
getcmdwintype()                 String  return current command-line window type
getcompletion({pat}{type} [, {filtered}])
                                List    list of cmdline completion matches
getcurpos([{winnr}])            List    position of the cursor
getcursorcharpos([{winnr}])     List    character position of the cursor
getcwd([{winnr} [, {tabnr}]])   String  get the current working directory
getenv({name})                  String  return environment variable
getfontname([{name}])           String  name of font being used
getfperm({fname})               String  file permissions of file {fname}
getfsize({fname})               Number  size in bytes of file {fname}
getftime({fname})               Number  last modification time of file
getftype({fname})               String  description of type of file {fname}
getimstatus()                   Number  TRUE if the IME status is active
getjumplist([{winnr} [, {tabnr}]])
                                List    list of jump list items
getline({lnum})                 String  line {lnum} of current buffer
getline({lnum}{end})          List    lines {lnum} to {end} of current buffer
getloclist({nr})                List    list of location list items
getloclist({nr}{what})        Dict    get specific location list properties
getmarklist([{buf}])            List    list of global/local marks
getmatches([{win}])             List    list of current matches
getmousepos()                   Dict    last known mouse position
getmouseshape()                 String  current mouse shape name
getpid()                        Number  process ID of Vim
getpos({expr})                  List    position of cursor, mark, etc.
getqflist()                     List    list of quickfix items
getqflist({what})               Dict    get specific quickfix list properties
getreg([{regname} [, 1 [, {list}]]])
                                String or List   contents of a register
getreginfo([{regname}])         Dict    information about a register
getregion({pos1}{pos2} [, {opts}])
                                List    get the text from {pos1} to {pos2}
getregionpos({pos1}{pos2} [, {opts}])
                                List    get a list of positions for a region
getregtype([{regname}])         String  type of a register
getscriptinfo([{opts}])         List    list of sourced scripts
gettabinfo([{expr}])            List    list of tab pages
gettabvar({nr}{varname} [, {def}])
                                any     variable {varname} in tab {nr} or {def}
gettabwinvar({tabnr}{winnr}{name} [, {def}])
                                any     {name} in {winnr} in tab page {tabnr}
gettagstack([{nr}])             Dict    get the tag stack of window {nr}
gettext({text} [, {package}])
                                String  lookup translation of {text}
getwininfo([{winid}])           List    list of info about each window
getwinpos([{timeout}])          List    X and Y coord in pixels of Vim window
getwinposx()                    Number  X coord in pixels of the Vim window
getwinposy()                    Number  Y coord in pixels of the Vim window
getwinvar({nr}{varname} [, {def}])
                                any     variable {varname} in window {nr}
glob({expr} [, {nosuf} [, {list} [, {alllinks}]]])
                                any     expand file wildcards in {expr}
glob2regpat({expr})             String  convert a glob pat into a search pat
globpath({path}{expr} [, {nosuf} [, {list} [, {alllinks}]]])
                                String  do glob({expr}) for all dirs in {path}
has({feature} [, {check}])      Number  TRUE if feature {feature} supported
has_key({dict}{key})          Number  TRUE if {dict} has entry {key}
haslocaldir([{winnr} [, {tabnr}]])
                                Number  TRUE if the window executed :lcd
                                        or :tcd
hasmapto({what} [, {mode} [, {abbr}]])
                                Number  TRUE if mapping to {what} exists
histadd({history}{item})      Number  add an item to a history
histdel({history} [, {item}])   Number  remove an item from a history
histget({history} [, {index}])  String  get the item {index} from a history
histnr({history})               Number  highest index of a history
hlID({name})                    Number  syntax ID of highlight group {name}
hlexists({name})                Number  TRUE if highlight group {name} exists
hlget([{name} [, {resolve}]])   List    get highlight group attributes
hlset({list})                   Number  set highlight group attributes
hostname()                      String  name of the machine Vim is running on
iconv({expr}{from}{to})     String  convert encoding of {expr}
indent({lnum})                  Number  indent of line {lnum}
index({object}{expr} [, {start} [, {ic}]])
                                Number  index in {object} where {expr} appears
indexof({object}{expr} [, {opts}]])
                                Number  index in {object} where {expr} is true
input({prompt} [, {text} [, {completion}]])
                                String  get input from the user
inputdialog({prompt} [, {text} [, {cancelreturn}]])
                                String  like input() but in a GUI dialog
inputlist({textlist})           Number  let the user pick from a choice list
inputrestore()                  Number  restore typeahead
inputsave()                     Number  save and clear typeahead
inputsecret({prompt} [, {text}]) String like input() but hiding the text
insert({object}{item} [, {idx}]) List insert {item} in {object} [before {idx}]
instanceof({object}{class})   Number  TRUE if {object} is an instance of {class}
interrupt()                     none    interrupt script execution
invert({expr})                  Number  bitwise invert
isabsolutepath({path})          Number  TRUE if {path} is an absolute path
isdirectory({directory})        Number  TRUE if {directory} is a directory
isinf({expr})                   Number  determine if {expr} is infinity value
                                        (positive or negative)
islocked({expr})                Number  TRUE if {expr} is locked
isnan({expr})                   Number  TRUE if {expr} is NaN
items({dict})                   List    key-value pairs in {dict}
job_getchannel({job})           Channel get the channel handle for {job}
job_info([{job}])               Dict    get information about {job}
job_setoptions({job}{options}) none   set options for {job}
job_start({command} [, {options}])
                                Job     start a job
job_status({job})               String  get the status of {job}
job_stop({job} [, {how}])       Number  stop {job}
join({list} [, {sep}])          String  join {list} items into one String
js_decode({string})             any     decode JS style JSON
js_encode({expr})               String  encode JS style JSON
json_decode({string})           any     decode JSON
json_encode({expr})             String  encode JSON
keys({dict})                    List    keys in {dict}
keytrans({string})              String  translate internal keycodes to a form
                                        that can be used by :map
len({expr})                     Number  the length of {expr}
libcall({lib}{func}{arg})   String  call {func} in library {lib} with {arg}
libcallnr({lib}{func}{arg}) Number  idem, but return a Number
line({expr} [, {winid}])        Number  line nr of cursor, last line or mark
line2byte({lnum})               Number  byte count of line {lnum}
lispindent({lnum})              Number  Lisp indent for line {lnum}
list2blob({list})               Blob    turn {list} of numbers into a Blob
list2str({list} [, {utf8}])     String  turn {list} of numbers into a String
listener_add({callback} [, {buf}])
                                Number  add a callback to listen to changes
listener_flush([{buf}])         none    invoke listener callbacks
listener_remove({id})           none    remove a listener callback
localtime()                     Number  current time
log({expr})                     Float   natural logarithm (base e) of {expr}
log10({expr})                   Float   logarithm of Float {expr} to base 10
luaeval({expr} [, {expr}])      any     evaluate Lua expression
map({expr1}{expr2})           List/Dict/Blob/String
                                        change each item in {expr1} to {expr2}
maparg({name} [, {mode} [, {abbr} [, {dict}]]])
                                String or Dict
                                        rhs of mapping {name} in mode {mode}
mapcheck({name} [, {mode} [, {abbr}]])
                                String  check for mappings matching {name}
maplist([{abbr}])               List    list of all mappings, a dict for each
mapnew({expr1}{expr2})        List/Dict/Blob/String
                                        like map() but creates a new List or
mapset({mode}{abbr}{dict})  none    restore mapping from maparg() result
match({expr}{pat} [, {start} [, {count}]])
                                Number  position where {pat} matches in {expr}
matchadd({group}{pattern} [, {priority} [, {id} [, {dict}]]])
                                Number  highlight {pattern} with {group}
matchaddpos({group}{pos} [, {priority} [, {id} [, {dict}]]])
                                Number  highlight positions with {group}
matcharg({nr})                  List    arguments of :match
matchbufline({buf}{pat}{lnum}{end}, [, {dict})
                                List    all the {pat} matches in buffer {buf}
matchdelete({id} [, {win}])     Number  delete match identified by {id}
matchend({expr}{pat} [, {start} [, {count}]])
                                Number  position where {pat} ends in {expr}
matchfuzzy({list}{str} [, {dict}])
                                List    fuzzy match {str} in {list}
matchfuzzypos({list}{str} [, {dict}])
                                List    fuzzy match {str} in {list}
matchlist({expr}{pat} [, {start} [, {count}]])
                                List    match and submatches of {pat} in {expr}
matchstr({expr}{pat} [, {start} [, {count}]])
                                String  {count}'th match of {pat} in {expr}
matchstrlist({list}{pat} [, {dict})
                                List    all the {pat} matches in {list}
matchstrpos({expr}{pat} [, {start} [, {count}]])
                                List    {count}'th match of {pat} in {expr}
max({expr})                     Number  maximum value of items in {expr}
menu_info({name} [, {mode}])    Dict    get menu item information
min({expr})                     Number  minimum value of items in {expr}
mkdir({name} [, {flags} [, {prot}]])
                                Number  create directory {name}
mode([{expr}])                  String  current editing mode
mzeval({expr})                  any     evaluate MzScheme expression
nextnonblank({lnum})            Number  line nr of non-blank line >= {lnum}
nr2char({expr} [, {utf8}])      String  single char with ASCII/UTF-8 value {expr}
or({expr}{expr})              Number  bitwise OR
pathshorten({expr} [, {len}])   String  shorten directory names in a path
perleval({expr})                any     evaluate Perl expression
popup_atcursor({what}{options}) Number create popup window near the cursor
popup_beval({what}{options})  Number  create popup window for 'ballooneval'
popup_clear()                   none    close all popup windows
popup_close({id} [, {result}])  none    close popup window {id}
popup_create({what}{options}) Number  create a popup window
popup_dialog({what}{options}) Number  create a popup window used as a dialog
popup_filter_menu({id}{key})  Number  filter for a menu popup window
popup_filter_yesno({id}{key}) Number  filter for a dialog popup window
popup_findecho()                Number  get window ID of popup for :echowin
popup_findinfo()                Number  get window ID of info popup window
popup_findpreview()             Number  get window ID of preview popup window
popup_getoptions({id})          Dict    get options of popup window {id}
popup_getpos({id})              Dict    get position of popup window {id}
popup_hide({id})                none    hide popup menu {id}
popup_list()                    List    get a list of window IDs of all popups
popup_locate({row}{col})      Number  get window ID of popup at position
popup_menu({what}{options})   Number  create a popup window used as a menu
popup_move({id}{options})     none    set position of popup window {id}
                                Number  create a notification popup window
popup_setbuf({id}{buf})       Bool    set the buffer for the popup window {id}
                                none    set options for popup window {id}
popup_settext({id}{text})     none    set the text of popup window {id}
popup_show({id})                none    unhide popup window {id}
pow({x}{y})                   Float   {x} to the power of {y}
prevnonblank({lnum})            Number  line nr of non-blank line <= {lnum}
printf({fmt}{expr1}...)       String  format text
prompt_getprompt({buf})         String  get prompt text
prompt_setcallback({buf}{expr}) none  set prompt callback function
prompt_setinterrupt({buf}{text}) none set prompt interrupt function
prompt_setprompt({buf}{text}) none    set prompt text
prop_add({lnum}{col}{props})  none  add one text property
prop_add_list({props}, [[{lnum}{col}{end-lnum}{end-col}], ...])
                                none    add multiple text properties
prop_clear({lnum} [, {lnum-end} [, {props}]])
                                none    remove all text properties
prop_find({props} [, {direction}])
                                Dict    search for a text property
prop_list({lnum} [, {props}])   List    text properties in {lnum}
prop_remove({props} [, {lnum} [, {lnum-end}]])
                                Number  remove a text property
prop_type_add({name}{props})  none    define a new property type
                                none    change an existing property type
prop_type_delete({name} [, {props}])
                                none    delete a property type
prop_type_get({name} [, {props}])
                                Dict    get property type values
prop_type_list([{props}])       List    get list of property types
pum_getpos()                    Dict    position and size of pum if visible
pumvisible()                    Number  whether popup menu is visible
py3eval({expr})                 any     evaluate python3 expression
pyeval({expr})                  any     evaluate Python expression
pyxeval({expr})                 any     evaluate python_x expression
rand([{expr}])                  Number  get pseudo-random number
range({expr} [, {max} [, {stride}]])
                                List    items from {expr} to {max}
readblob({fname} [, {offset} [, {size}]])
                                Blob    read a Blob from {fname}
readdir({dir} [, {expr} [, {dict}]])
                                List    file names in {dir} selected by {expr}
readdirex({dir} [, {expr} [, {dict}]])
                                List    file info in {dir} selected by {expr}
readfile({fname} [, {type} [, {max}]])
                                List    get list of lines from file {fname}
reduce({object}{func} [, {initial}])
                                any     reduce {object} using {func}
reg_executing()                 String  get the executing register name
reg_recording()                 String  get the recording register name
reltime([{start} [, {end}]])    List    get time value
reltimefloat({time})            Float   turn the time value into a Float
reltimestr({time})              String  turn time value into a String
remote_expr({server}{string} [, {idvar} [, {timeout}]])
                                String  send expression
remote_foreground({server})     Number  bring Vim server to the foreground
remote_peek({serverid} [, {retvar}])
                                Number  check for reply string
remote_read({serverid} [, {timeout}])
                                String  read reply string
remote_send({server}{string} [, {idvar}])
                                String  send key sequence
remote_startserver({name})      none    become server {name}
remove({list}{idx} [, {end}]) any/List
                                        remove items {idx}-{end} from {list}
remove({blob}{idx} [, {end}]) Number/Blob
                                        remove bytes {idx}-{end} from {blob}
remove({dict}{key})           any     remove entry {key} from {dict}
rename({from}{to})            Number  rename (move) file from {from} to {to}
repeat({expr}{count})         List/Blob/String
                                        repeat {expr} {count} times
resolve({filename})             String  get filename a shortcut points to
reverse({obj})                  List/Blob/String
                                        reverse {obj}
round({expr})                   Float   round off {expr}
rubyeval({expr})                any     evaluate Ruby expression
screenattr({row}{col})        Number  attribute at screen position
screenchar({row}{col})        Number  character at screen position
screenchars({row}{col})       List    List of characters at screen position
screencol()                     Number  current cursor column
screenpos({winid}{lnum}{col}) Dict  screen row and col of a text character
screenrow()                     Number  current cursor row
screenstring({row}{col})      String  characters at screen position
search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
                                Number  search for {pattern}
searchcount([{options}])        Dict    get or update search stats
searchdecl({name} [, {global} [, {thisblock}]])
                                Number  search for variable declaration
searchpair({start}{middle}{end} [, {flags} [, {skip} [...]]])
                                Number  search for other end of start/end pair
searchpairpos({start}{middle}{end} [, {flags} [, {skip} [...]]])
                                List    search for other end of start/end pair
searchpos({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]])
                                List    search for {pattern}
                                Number  send reply string
serverlist()                    String  get a list of available servers
                                Number  set line {lnum} to {text} in buffer
                                none    set {varname} in buffer {buf} to {val}
setcellwidths({list})           none    set character cell width overrides
setcharpos({expr}{list})      Number  set the {expr} position to {list}
setcharsearch({dict})           Dict    set character search from {dict}
setcmdline({str} [, {pos}])     Number  set command-line
setcmdpos({pos})                Number  set cursor position in command-line
setcursorcharpos({list})        Number  move cursor to position in {list}
setenv({name}{val})           none    set environment variable
setfperm({fname}{mode})       Number  set {fname} file permissions to {mode}
setline({lnum}{line})         Number  set line {lnum} to {line}
setloclist({nr}{list} [, {action}])
                                Number  modify location list using {list}
                                Number  modify specific location list props
setmatches({list} [, {win}])    Number  restore a list of matches
setpos({expr}{list})          Number  set the {expr} position to {list}
setqflist({list} [, {action}])  Number  modify quickfix list using {list}
                                Number  modify specific quickfix list props
setreg({n}{v} [, {opt}])      Number  set register to value and type
settabvar({nr}{varname}{val}) none  set {varname} in tab page {nr} to {val}
                                none    set {varname} in window {winnr} in tab
                                        page {tabnr} to {val}
settagstack({nr}{dict} [, {action}])
                                Number  modify tag stack using {dict}
setwinvar({nr}{varname}{val}) none  set {varname} in window {nr} to {val}
sha256({string})                String  SHA256 checksum of {string}
shellescape({string} [, {special}])
                                String  escape {string} for use as shell
                                        command argument
shiftwidth([{col}])             Number  effective value of 'shiftwidth'
sign_define({name} [, {dict}])  Number  define or update a sign
sign_define({list})             List    define or update a list of signs
sign_getdefined([{name}])       List    get a list of defined signs
sign_getplaced([{buf} [, {dict}]])
                                List    get a list of placed signs
                                Number  jump to a sign
sign_place({id}{group}{name}{buf} [, {dict}])
                                Number  place a sign
sign_placelist({list})          List    place a list of signs
sign_undefine([{name}])         Number  undefine a sign
sign_undefine({list})           List    undefine a list of signs
sign_unplace({group} [, {dict}])
                                Number  unplace a sign
sign_unplacelist({list})        List    unplace a list of signs
simplify({filename})            String  simplify filename as much as possible
sin({expr})                     Float   sine of {expr}
sinh({expr})                    Float   hyperbolic sine of {expr}
slice({expr}{start} [, {end}])  String, List or Blob
                                        slice of a String, List or Blob
sort({list} [, {how} [, {dict}]])
                                List    sort {list}, compare with {how}
sound_clear()                   none    stop playing all sounds
sound_playevent({name} [, {callback}])
                                Number  play an event sound
sound_playfile({path} [, {callback}])
                                Number  play sound file {path}
sound_stop({id})                none    stop playing sound {id}
soundfold({word})               String  sound-fold {word}
spellbadword()                  String  badly spelled word at cursor
spellsuggest({word} [, {max} [, {capital}]])
                                List    spelling suggestions
split({expr} [, {pat} [, {keepempty}]])
                                List    make List from {pat} separated {expr}
sqrt({expr})                    Float   square root of {expr}
srand([{expr}])                 List    get seed for rand()
state([{what}])                 String  current state of Vim
str2float({expr} [, {quoted}])  Float   convert String to Float
str2list({expr} [, {utf8}])     List    convert each character of {expr} to
                                        ASCII/UTF-8 value
str2nr({expr} [, {base} [, {quoted}]])
                                Number  convert String to Number
strcharlen({expr})              Number  character length of the String {expr}
strcharpart({str}{start} [, {len} [, {skipcc}]])
                                String  {len} characters of {str} at
                                        character {start}
strchars({expr} [, {skipcc}])   Number  character count of the String {expr}
strdisplaywidth({expr} [, {col}]) Number display length of the String {expr}
strftime({format} [, {time}])   String  format time with a specified format
strgetchar({str}{index})      Number  get char {index} from {str}
stridx({haystack}{needle} [, {start}])
                                Number  index of {needle} in {haystack}
string({expr})                  String  String representation of {expr} value
strlen({expr})                  Number  length of the String {expr}
strpart({str}{start} [, {len} [, {chars}]])
                                String  {len} bytes/chars of {str} at
                                        byte {start}
                                Number  Convert {timestring} to unix timestamp
strridx({haystack}{needle} [, {start}])
                                Number  last index of {needle} in {haystack}
strtrans({expr})                String  translate string to make it printable
strutf16len({string} [, {countcc}])
                                Number  number of UTF-16 code units in {string}
strwidth({expr})                Number  display cell length of the String {expr}
submatch({nr} [, {list}])       String or List
                                        specific match in ":s" or substitute()
                                String  all {pat} in {expr} replaced with {sub}
swapfilelist()                  List    swap files found in 'directory'
swapinfo({fname})               Dict    information about swap file {fname}
swapname({buf})                 String  swap file of buffer {buf}
synID({lnum}{col}{trans})   Number  syntax ID at {lnum} and {col}
synIDattr({synID}{what} [, {mode}])
                                String  attribute {what} of syntax ID {synID}
synIDtrans({synID})             Number  translated syntax ID of {synID}
synconcealed({lnum}{col})     List    info about concealing
synstack({lnum}{col})         List    stack of syntax IDs at {lnum} and {col}
system({expr} [, {input}])      String  output of shell command/filter {expr}
systemlist({expr} [, {input}])  List    output of shell command/filter {expr}
tabpagebuflist([{arg}])         List    list of buffer numbers in tab page
tabpagenr([{arg}])              Number  number of current or last tab page
tabpagewinnr({tabarg} [, {arg}]) Number number of current window in tab page
tagfiles()                      List    tags files used
taglist({expr} [, {filename}])  List    list of tags matching {expr}
tan({expr})                     Float   tangent of {expr}
tanh({expr})                    Float   hyperbolic tangent of {expr}
tempname()                      String  name for a temporary file
term_dumpdiff({filename}{filename} [, {options}])
                                Number  display difference between two dumps
term_dumpload({filename} [, {options}])
                                Number  displaying a screen dump
term_dumpwrite({buf}{filename} [, {options}])
                                none    dump terminal window contents
term_getaltscreen({buf})        Number  get the alternate screen flag
term_getansicolors({buf})       List    get ANSI palette in GUI color mode
term_getattr({attr}{what})    Number  get the value of attribute {what}
term_getcursor({buf})           List    get the cursor position of a terminal
term_getjob({buf})              Job     get the job associated with a terminal
term_getline({buf}{row})      String  get a line of text from a terminal
term_getscrolled({buf})         Number  get the scroll count of a terminal
term_getsize({buf})             List    get the size of a terminal
term_getstatus({buf})           String  get the status of a terminal
term_gettitle({buf})            String  get the title of a terminal
term_gettty({buf}, [{input}])   String  get the tty name of a terminal
term_list()                     List    get the list of terminal buffers
term_scrape({buf}{row})       List    get row of a terminal screen
term_sendkeys({buf}{keys})    none    send keystrokes to a terminal
                                none    set ANSI palette in GUI color mode
term_setapi({buf}{expr})      none    set terminal-api function name prefix
term_setkill({buf}{how})      none    set signal to stop job in terminal
term_setrestore({buf}{command}) none  set command to restore terminal
                                none    set the size of a terminal
term_start({cmd} [, {options}]) Number  open a terminal window and run a job
term_wait({buf} [, {time}])     Number  wait for screen to be updated
terminalprops()                 Dict    properties of the terminal
                                none    make memory allocation fail
test_autochdir()                none    enable 'autochdir' during startup
test_feedinput({string})        none    add key sequence to input buffer
test_garbagecollect_now()       none    free memory right now for testing
test_garbagecollect_soon()      none    free memory soon for testing
test_getvalue({string})         any     get value of an internal variable
test_gui_event({event}{args}) bool    generate a GUI event for testing
test_ignore_error({expr})       none    ignore a specific error
                                bool    generate MS-Windows event for testing
test_null_blob()                Blob    null value for testing
test_null_channel()             Channel null value for testing
test_null_dict()                Dict    null value for testing
test_null_function()            Funcref null value for testing
test_null_job()                 Job     null value for testing
test_null_list()                List    null value for testing
test_null_partial()             Funcref null value for testing
test_null_string()              String  null value for testing
test_option_not_set({name})     none    reset flag indicating option was set
test_override({expr}{val})    none    test with Vim internal overrides
test_refcount({expr})           Number  get the reference count of {expr}
test_setmouse({row}{col})     none    set the mouse position for testing
test_settime({expr})            none    set current time for testing
test_srand_seed([{seed}])       none    set seed for testing srand()
test_unknown()                  any     unknown value for testing
test_void()                     any     void value for testing
timer_info([{id}])              List    information about timers
timer_pause({id}{pause})      none    pause or unpause a timer
timer_start({time}{callback} [, {options}])
                                Number  create a timer
timer_stop({timer})             none    stop a timer
timer_stopall()                 none    stop all timers
tolower({expr})                 String  the String {expr} switched to lowercase
toupper({expr})                 String  the String {expr} switched to uppercase
tr({src}{fromstr}{tostr})   String  translate chars of {src} in {fromstr}
                                        to chars in {tostr}
trim({text} [, {mask} [, {dir}]])
                                String  trim characters in {mask} from {text}
trunc({expr})                   Float   truncate Float {expr}
type({expr})                    Number  type of value {expr}
typename({expr})                String  representation of the type of {expr}
undofile({name})                String  undo file name for {name}
undotree([{buf}])               List    undo file tree for buffer {buf}
uniq({list} [, {func} [, {dict}]])
                                List    remove adjacent duplicates from a list
utf16idx({string}{idx} [, {countcc} [, {charidx}]])
                                Number  UTF-16 index of byte {idx} in {string}
values({dict})                  List    values in {dict}
virtcol({expr} [, {list} [, {winid}])
                                Number or List
                                        screen column of cursor or mark
                                Number  byte index of a character on screen
visualmode([{expr}])            String  last visual mode used
wildmenumode()                  Number  whether 'wildmenu' mode is active
win_execute({id}{command} [, {silent}])
                                String  execute {command} in window {id}
win_findbuf({bufnr})            List    find windows containing {bufnr}
win_getid([{win} [, {tab}]])    Number  get window ID for {win} in {tab}
win_gettype([{nr}])             String  type of window {nr}
win_gotoid({expr})              Number  go to window with ID {expr}
win_id2tabwin({expr})           List    get tab and window nr from window ID
win_id2win({expr})              Number  get window nr from window ID
win_move_separator({nr})        Number  move window vertical separator
win_move_statusline({nr})       Number  move window status line
win_screenpos({nr})             List    get screen position of window {nr}
win_splitmove({nr}{target} [, {options}])
                                Number  move window {nr} to split of {target}
winbufnr({nr})                  Number  buffer number of window {nr}
wincol()                        Number  window column of the cursor
windowsversion()                String  MS-Windows OS version
winheight({nr})                 Number  height of window {nr}
winlayout([{tabnr}])            List    layout of windows in tab {tabnr}
winline()                       Number  window line of the cursor
winnr([{expr}])                 Number  number of current window
winrestcmd()                    String  returns command to restore window sizes
winrestview({dict})             none    restore view of current window
winsaveview()                   Dict    save view of current window
winwidth({nr})                  Number  width of window {nr}
wordcount()                     Dict    get byte/char/word statistics
writefile({object}{fname} [, {flags}])
                                Number  write Blob or List of lines to file
xor({expr}{expr})             Number  bitwise XOR

2. Details                                      builtin-function-details

Not all functions are here, some have been moved to a help file covering the
specific functionality.
Return type specifies the type for Vim9-script, see vim9-types

abs({expr})                                                     abs()
                Return the absolute value of {expr}.  When {expr} evaluates to
                a Float abs() returns a Float.  When {expr} can be
                converted to a Number abs() returns a Number.  Otherwise
                abs() gives an error message and returns -1.
                        echo abs(1.456)
                        echo abs(-5.456)
                        echo abs(-4)

                Can also be used as a method:

                Return type: Number or Float depending on {expr}

acos({expr})                                                    acos()
                Return the arc cosine of {expr} measured in radians, as a
                Float in the range of [0, pi].
                {expr} must evaluate to a Float or a Number in the range
                [-1, 1].  Otherwise acos() returns "nan".
                        :echo acos(0)
                        :echo acos(-0.5)

                Can also be used as a method:

                Return type: Float

add({object}{expr})                                   add()
                Append the item {expr} to List or Blob {object}.  Returns
                the resulting List or Blob.  Examples:
                        :let alist = add([1, 2, 3], item)
                        :call add(mylist, "woodstock")
                Note that when {expr} is a List it is appended as a single
                item.  Use extend() to concatenate Lists.
                When {object} is a Blob then  {expr} must be a number.
                Use insert() to add an item at another position.
                Returns 1 if {object} is not a List or a Blob.

                Can also be used as a method:

                Return type: list<{type}> (depending on the given List) or

and({expr}{expr})                                     and()
                Bitwise AND on the two arguments.  The arguments are converted
                to a number.  A List, Dict or Float argument causes an error.
                Also see or() and xor().
                        :let flag = and(bits, 0x80)
                Can also be used as a method:
                        :let flag = bits->and(0x80)

                Return type: Number

append({lnum}{text})                                  append()
                When {text} is a List: Append each item of the List as a
                text line below line {lnum} in the current buffer.
                Otherwise append {text} as one text line below line {lnum} in
                the current buffer.
                Any type of item is accepted and converted to a String.
                {lnum} can be zero to insert a line before the first one.
                {lnum} is used like with getline().
                Returns 1 for failure ({lnum} out of range or out of memory),
                0 for success.  When {text} is an empty list zero is returned,
                no matter the value of {lnum}.
                In Vim9 script an invalid argument or negative number
                results in an error.  Example:
                        :let failed = append(line('$'), "# THE END")
                        :let failed = append(0, ["Chapter 1", "the beginning"])

                Can also be used as a method after a List, the base is
                passed as the second argument:

                Return type: Number

appendbufline({buf}{lnum}{text})                    appendbufline()
                Like append() but append the text in buffer {buf}.

                This function works only for loaded buffers. First call
                bufload() if needed.

                For the use of {buf}, see bufname().

                {lnum} is the line number to append below.  Note that using
                line() would use the current buffer, not the one appending
                to.  Use "$" to append at the end of the buffer.  Other string
                values are not supported.

                On success 0 is returned, on failure 1 is returned.
                In Vim9 script an error is given for an invalid {lnum}.

                If {buf} is not a valid buffer or {lnum} is not valid, an
                error message is given. Example:
                        :let failed = appendbufline(13, 0, "# THE START")
                However, when {text} is an empty list then no error is given
                for an invalid {lnum}, since {lnum} isn't actually used.

                Can also be used as a method after a List, the base is
                passed as the second argument:
                        mylist->appendbufline(buf, lnum)

                Return type: Number

argc([{winid}])                                 argc()
                The result is the number of files in the argument list.  See
                If {winid} is not supplied, the argument list of the current
                window is used.
                If {winid} is -1, the global argument list is used.
                Otherwise {winid} specifies the window of which the argument
                list is used: either the window number or the window ID.
                Returns -1 if the {winid} argument is invalid.

                Return type: Number

argidx()        The result is the current index in the argument list.  0 is
                the first file.  argc() - 1 is the last one.  See arglist.

                Return type: Number

arglistid([{winnr} [, {tabnr}]])
                Return the argument list ID.  This is a number which
                identifies the argument list being used.  Zero is used for the
                global argument list.  See arglist.
                Returns -1 if the arguments are invalid.

                Without arguments use the current window.
                With {winnr} only use this window in the current tab page.
                With {winnr} and {tabnr} use the window in the specified tab
                {winnr} can be the window number or the window-ID.

                Return type: Number

argv([{nr} [, {winid}]])
                The result is the {nr}th file in the argument list.  See
                arglist.  "argv(0)" is the first one.  Example:
        :let i = 0
        :while i < argc()
        :  let f = escape(fnameescape(argv(i)), '.')
        :  exe 'amenu Arg.' .. f .. ' :e ' .. f .. '<CR>'
        :  let i = i + 1
                Without the {nr} argument, or when {nr} is -1, a List with
                the whole arglist is returned.

                The {winid} argument specifies the window ID, see argc().
                For the Vim command line arguments see v:argv.

                Returns an empty string if {nr}th argument is not present in
                the argument list.  Returns an empty List if the {winid}
                argument is invalid.

                Return type: String

asin({expr})                                            asin()
                Return the arc sine of {expr} measured in radians, as a Float
                in the range of [-pi/2, pi/2].
                {expr} must evaluate to a Float or a Number in the range
                [-1, 1].
                Returns "nan" if {expr} is outside the range [-1, 1].  Returns
                0.0 if {expr} is not a Float or a Number.
                        :echo asin(0.8)
                        :echo asin(-0.5)

                Can also be used as a method:

                Return type: Float

assert_ functions are documented here: assert-functions-details

atan({expr})                                            atan()
                Return the principal value of the arc tangent of {expr}, in
                the range [-pi/2, +pi/2] radians, as a Float.
                {expr} must evaluate to a Float or a Number.
                Returns 0.0 if {expr} is not a Float or a Number.
                        :echo atan(100)
                        :echo atan(-4.01)

                Can also be used as a method:

                Return type: Float

atan2({expr1}{expr2})                                 atan2()
                Return the arc tangent of {expr1} / {expr2}, measured in
                radians, as a Float in the range [-pi, pi].
                {expr1} and {expr2} must evaluate to a Float or a Number.
                Returns 0.0 if {expr1} or {expr2} is not a Float or a
                        :echo atan2(-1, 1)
                        :echo atan2(1, -1)

                Can also be used as a method:

                Return type: Float

autocmd_add({acmds})                                    autocmd_add()
                Adds a List of autocmds and autocmd groups.

                The {acmds} argument is a List where each item is a Dict with
                the following optional items:
                    bufnr       buffer number to add a buffer-local autocmd.
                                If this item is specified, then the "pattern"
                                item is ignored.
                    cmd         Ex command to execute for this autocmd event
                    event       autocmd event name. Refer to autocmd-events.
                                This can be either a String with a single
                                event name or a List of event names.
                    group       autocmd group name. Refer to autocmd-groups.
                                If this group doesn't exist then it is
                                created.  If not specified or empty, then the
                                default group is used.
                    nested      boolean flag, set to v:true to add a nested
                                autocmd.  Refer to autocmd-nested.
                    once        boolean flag, set to v:true to add an autocmd
                                which executes only once. Refer to
                    pattern     autocmd pattern string. Refer to
                                autocmd-patterns.  If "bufnr" item is
                                present, then this item is ignored.  This can
                                be a String with a single pattern or a List of
                    replace     boolean flag, set to v:true to remove all the
                                commands associated with the specified autocmd
                                event and group and add the {cmd}.  This is
                                useful to avoid adding the same command
                                multiple times for an autocmd event in a group.

                Returns v:true on success and v:false on failure.
                        " Create a buffer-local autocmd for buffer 5
                        let acmd = {}
                        let = 'MyGroup'
                        let acmd.event = 'BufEnter'
                        let acmd.bufnr = 5
                        let acmd.cmd = 'call BufEnterFunc()'
                        call autocmd_add([acmd])

                Can also be used as a method:

                Return type: vim9-boolean

autocmd_delete({acmds})                                 autocmd_delete()
                Deletes a List of autocmds and autocmd groups.

                The {acmds} argument is a List where each item is a Dict with
                the following optional items:
                    bufnr       buffer number to delete a buffer-local autocmd.
                                If this item is specified, then the "pattern"
                                item is ignored.
                    cmd         Ex command for this autocmd event
                    event       autocmd event name. Refer to autocmd-events.
                                If '*' then all the autocmd events in this
                                group are deleted.
                    group       autocmd group name. Refer to autocmd-groups.
                                If not specified or empty, then the default
                                group is used.
                    nested      set to v:true for a nested autocmd.
                                Refer to autocmd-nested.
                    once        set to v:true for an autocmd which executes
                                only once. Refer to autocmd-once.
                    pattern     autocmd pattern string. Refer to
                                autocmd-patterns.  If "bufnr" item is
                                present, then this item is ignored.

                If only {group} is specified in a {acmds} entry and {event},
                {pattern} and {cmd} are not specified, then that autocmd group
                is deleted.

                Returns v:true on success and v:false on failure.
                        " :autocmd! BufLeave *.vim
                        let acmd = #{event: 'BufLeave', pattern: '*.vim'}
                        call autocmd_delete([acmd]})
                        " :autocmd! MyGroup1 BufLeave
                        let acmd = #{group: 'MyGroup1', event: 'BufLeave'}
                        call autocmd_delete([acmd])
                        " :autocmd! MyGroup2 BufEnter *.c
                        let acmd = #{group: 'MyGroup2', event: 'BufEnter',
                                                        \ pattern: '*.c'}
                        " :autocmd! MyGroup2 * *.c
                        let acmd = #{group: 'MyGroup2', event: '*',
                                                        \ pattern: '*.c'}
                        call autocmd_delete([acmd])
                        " :autocmd! MyGroup3
                        let acmd = #{group: 'MyGroup3'}
                        call autocmd_delete([acmd])

                Can also be used as a method:

                Return type: vim9-boolean

autocmd_get([{opts}])                                   autocmd_get()
                Returns a List of autocmds. If {opts} is not supplied, then
                returns the autocmds for all the events in all the groups.

                The optional {opts} Dict argument supports the following
                    group       Autocmd group name. If specified, returns only
                                the autocmds defined in this group. If the
                                specified group doesn't exist, results in an
                                error message.  If set to an empty string,
                                then the default autocmd group is used.
                    event       Autocmd event name. If specified, returns only
                                the autocmds defined for this event.  If set
                                to "*", then returns autocmds for all the
                                events.  If the specified event doesn't exist,
                                results in an error message.
                    pattern     Autocmd pattern. If specified, returns only
                                the autocmds defined for this pattern.
                A combination of the above three times can be supplied in

                Each Dict in the returned List contains the following items:
                    bufnr       For buffer-local autocmds, buffer number where
                                the autocmd is defined.
                    cmd         Command executed for this autocmd.
                    event       Autocmd event name.
                    group       Autocmd group name.
                    nested      Boolean flag, set to v:true for a nested
                                autocmd. See autocmd-nested.
                    once        Boolean flag, set to v:true, if the autocmd
                                will be executed only once. See autocmd-once.
                    pattern     Autocmd pattern.  For a buffer-local
                                autocmd, this will be of the form "<buffer=n>".
                If there are multiple commands for an autocmd event in a
                group, then separate items are returned for each command.

                Returns an empty List if an autocmd with the specified group
                or event or pattern is not found.

                        " :autocmd MyGroup
                        echo autocmd_get(#{group: 'Mygroup'})
                        " :autocmd G BufUnload
                        echo autocmd_get(#{group: 'G', event: 'BufUnload'})
                        " :autocmd G * *.ts
                        let acmd = #{group: 'G', event: '*', pattern: '*.ts'}
                        echo autocmd_get(acmd)
                        " :autocmd Syntax
                        echo autocmd_get(#{event: 'Syntax'})
                        " :autocmd G BufEnter *.ts
                        let acmd = #{group: 'G', event: 'BufEnter',
                                                        \ pattern: '*.ts'}
                        echo autocmd_get(acmd)

                Can also be used as a method:

                Return type: list<dict<any>>

balloon_gettext()                                       balloon_gettext()
                Return the current text in the balloon.  Only for the string,
                not used for the List.  Returns an empty string if balloon
                is not present.

                Return type: String

balloon_show({expr})                                    balloon_show()
                Show {expr} inside the balloon.  For the GUI {expr} is used as
                a string.  For a terminal {expr} can be a list, which contains
                the lines of the balloon.  If {expr} is not a list it will be
                split with balloon_split().
                If {expr} is an empty string any existing balloon is removed.

                        func GetBalloonContent()
                           " ... initiate getting the content
                           return ''
                        set balloonexpr=GetBalloonContent()

                        func BalloonCallback(result)
                          call balloon_show(a:result)
                Can also be used as a method:

                The intended use is that fetching the content of the balloon
                is initiated from 'balloonexpr'.  It will invoke an
                asynchronous method, in which a callback invokes
                balloon_show().  The 'balloonexpr' itself can return an
                empty string or a placeholder, e.g. "loading...".

                When showing a balloon is not possible then nothing happens,
                no error message is given.
                {only available when compiled with the +balloon_eval or
                +balloon_eval_term feature}

                Return type: Number

balloon_split({msg})                                    balloon_split()
                Split String {msg} into lines to be displayed in a balloon.
                The splits are made for the current window size and optimize
                to show debugger output.
                Returns a List with the split lines.  Returns an empty List
                on error.
                Can also be used as a method:

                {only available when compiled with the +balloon_eval_term

                Return type: list<any> or list<string>

bindtextdomain({package}{path})                       bindtextdomain()
                Bind a specific {package} to a {path} so that the
                gettext() function can be used to get language-specific
                translations for a package.  {path} is the directory name
                for the translations. See package-create.

                Return type: none

blob2list({blob})                                       blob2list()
                Return a List containing the number value of each byte in Blob
                {blob}.  Examples:
                        blob2list(0z0102.0304)  returns [1, 2, 3, 4]
                        blob2list(0z)           returns []
                Returns an empty List on error.  list2blob() does the

                Can also be used as a method:

                Return type: list<any> or list<number>

                Put up a file requester.  This only works when "has("browse")"
                returns TRUE (only in some GUI versions).
                The input fields are:
                    {save}      when TRUE, select file to write
                    {title}     title for the requester
                    {initdir}   directory to start browsing in
                    {default}   default file name
                An empty string is returned when the "Cancel" button is hit,
                something went wrong, or browsing is not possible.

                Return type: String

browsedir({title}{initdir})                           browsedir()
                Put up a directory requester.  This only works when
                "has("browse")" returns TRUE (only in some GUI versions).
                On systems where a directory browser is not supported a file
                browser is used.  In that case: select a file in the directory
                to be used.
                The input fields are:
                    {title}     title for the requester
                    {initdir}   directory to start browsing in
                When the "Cancel" button is hit, something went wrong, or
                browsing is not possible, an empty string is returned.

                Return type: String

bufadd({name})                                          bufadd()
                Add a buffer to the buffer list with name {name} (must be a
                If a buffer for file {name} already exists, return that buffer
                number.  Otherwise return the buffer number of the newly
                created buffer.  When {name} is an empty string then a new
                buffer is always created.
                The buffer will not have 'buflisted' set and not be loaded
                yet.  To add some text to the buffer use this:
                        let bufnr = bufadd('someName')
                        call bufload(bufnr)
                        call setbufline(bufnr, 1, ['some', 'text'])
                Returns 0 on error.
                Can also be used as a method:
                        let bufnr = 'somename'->bufadd()

                Return type: Number

bufexists({buf})                                        bufexists()
                The result is a Number, which is TRUE if a buffer called
                {buf} exists.
                If the {buf} argument is a number, buffer numbers are used.
                Number zero is the alternate buffer for the current window.

                If the {buf} argument is a string it must match a buffer name
                exactly.  The name can be:
                - Relative to the current directory.
                - A full path.
                - The name of a buffer with 'buftype' set to "nofile".
                - A URL name.
                Unlisted buffers will be found.
                Note that help files are listed by their short name in the
                output of :buffers, but bufexists() requires using their
                long name to be able to find them.
                bufexists() may report a buffer exists, but to use the name
                with a :buffer command you may need to use expand().  Esp
                for MS-Windows 8.3 names in the form "c:\DOCUME~1"
                Use "bufexists(0)" to test for the existence of an alternate
                file name.

                Can also be used as a method:
                        let exists = 'somename'->bufexists()

                Return type: Number

                Obsolete name: buffer_exists().         buffer_exists()

buflisted({buf})                                        buflisted()
                The result is a Number, which is TRUE if a buffer called
                {buf} exists and is listed (has the 'buflisted' option set).
                The {buf} argument is used like with bufexists().

                Can also be used as a method:
                        let listed = 'somename'->buflisted()

                Return type: Number

bufload({buf})                                          bufload()
                Ensure the buffer {buf} is loaded.  When the buffer name
                refers to an existing file then the file is read.  Otherwise
                the buffer will be empty.  If the buffer was already loaded
                then there is no change.  If the buffer is not related to a
                file then no file is read (e.g., when 'buftype' is "nofile").
                If there is an existing swap file for the file of the buffer,
                there will be no dialog, the buffer will be loaded anyway.
                The {buf} argument is used like with bufexists().

                Can also be used as a method:
                        eval 'somename'->bufload()

                Return type: Number

bufloaded({buf})                                        bufloaded()
                The result is a Number, which is TRUE if a buffer called
                {buf} exists and is loaded (shown in a window or hidden).
                The {buf} argument is used like with bufexists().

                Can also be used as a method:
                        let loaded = 'somename'->bufloaded()

                Return type: Number

bufname([{buf}])                                        bufname()
                The result is the name of a buffer.  Mostly as it is displayed
                by the :ls command, but not using special names such as
                "[No Name]".
                If {buf} is omitted the current buffer is used.
                If {buf} is a Number, that buffer number's name is given.
                Number zero is the alternate buffer for the current window.
                If {buf} is a String, it is used as a file-pattern to match
                with the buffer names.  This is always done like 'magic' is
                set and 'cpoptions' is empty.  When there is more than one
                match an empty string is returned.
                "" or "%" can be used for the current buffer, "#" for the
                alternate buffer.
                A full match is preferred, otherwise a match at the start, end
                or middle of the buffer name is accepted.  If you only want a
                full match then put "^" at the start and "$" at the end of the
                Listed buffers are found first.  If there is a single match
                with a listed buffer, that one is returned.  Next unlisted
                buffers are searched for.
                If the {buf} is a String, but you want to use it as a buffer
                number, force it to be a Number by adding zero to it:
                        :echo bufname("3" + 0)
                Can also be used as a method:
                        echo bufnr->bufname()

                If the buffer doesn't exist, or doesn't have a name, an empty
                string is returned.
        bufname("#")            alternate buffer name
        bufname(3)              name of buffer 3
        bufname("%")            name of current buffer
        bufname("file2")        name of buffer where "file2" matches.

                Return type: String
                Obsolete name: buffer_name().

bufnr([{buf} [, {create}]])                             bufnr()
                The result is the number of a buffer, as it is displayed by
                the :ls command.  For the use of {buf}, see bufname()

                If the buffer doesn't exist, -1 is returned.  Or, if the
                {create} argument is present and TRUE, a new, unlisted,
                buffer is created and its number is returned.  Example:
                        let newbuf = bufnr('Scratch001', 1)
                Using an empty name uses the current buffer. To create a new
                buffer with an empty name use bufadd().

                bufnr("$") is the last buffer:
                        :let last_buffer = bufnr("$")
                The result is a Number, which is the highest buffer number
                of existing buffers.  Note that not all buffers with a smaller
                number necessarily exist, because ":bwipeout" may have removed
                them.  Use bufexists() to test for the existence of a buffer.

                Can also be used as a method:
                        echo bufref->bufnr()

                Return type: Number

                Obsolete name: buffer_number().         buffer_number()
                Obsolete name for bufnr("$"): last_buffer_nr().

bufwinid({buf})                                         bufwinid()
                The result is a Number, which is the window-ID of the first
                window associated with buffer {buf}.  For the use of {buf},
                see bufname() above.  If buffer {buf} doesn't exist or
                there is no such window, -1 is returned.  Example:

        echo "A window containing buffer 1 is " .. (bufwinid(1))

                Only deals with the current tab page.  See win_findbuf() for
                finding more.

                Can also be used as a method:

                Return type: Number

bufwinnr({buf})                                         bufwinnr()
                Like bufwinid() but return the window number instead of the
                If buffer {buf} doesn't exist or there is no such window, -1
                is returned.  Example:

        echo "A window containing buffer 1 is " .. (bufwinnr(1))

                The number can be used with CTRL-W_w and ":wincmd w"

                Can also be used as a method:

                Return type: Number

byte2line({byte})                                       byte2line()
                Return the line number that contains the character at byte
                count {byte} in the current buffer.  This includes the
                end-of-line character, depending on the 'fileformat' option
                for the current buffer.  The first character has byte count
                Also see line2byte()go and :goto.

                Returns -1 if the {byte} value is invalid.

                Can also be used as a method:

                Return type: Number

                {not available when compiled without the +byte_offset

byteidx({expr}{nr} [, {utf16}])                       byteidx()
                Return byte index of the {nr}'th character in the String
                {expr}.  Use zero for the first character, it then returns
                If there are no multibyte characters the returned value is
                equal to {nr}.
                Composing characters are not counted separately, their byte
                length is added to the preceding base character.  See
                byteidxcomp() below for counting composing characters
                When {utf16} is present and TRUE, {nr} is used as the UTF-16
                index in the String {expr} instead of as the character index.
                The UTF-16 index is the index in the string when it is encoded
                with 16-bit words.  If the specified UTF-16 index is in the
                middle of a character (e.g. in a 4-byte character), then the
                byte index of the first byte in the character is returned.
                Refer to string-offset-encoding for more information.
                Example :
                        echo matchstr(str, ".", byteidx(str, 3))
                will display the fourth character.  Another way to do the
                        let s = strpart(str, byteidx(str, 3))
                        echo strpart(s, 0, byteidx(s, 1))
                Also see strgetchar() and strcharpart().

                If there are less than {nr} characters -1 is returned.
                If there are exactly {nr} characters the length of the string
                in bytes is returned.
                See charidx() and utf16idx() for getting the character and
                UTF-16 index respectively from the byte index.
                        echo byteidx('a😊😊', 2)        returns 5
                        echo byteidx('a😊😊', 2, 1)     returns 1
                        echo byteidx('a😊😊', 3, 1)     returns 5

                Can also be used as a method:

                Return type: Number

byteidxcomp({expr}{nr} [, {utf16}])                   byteidxcomp()
                Like byteidx(), except that a composing character is counted
                as a separate character.  Example:
                        let s = 'e' .. nr2char(0x301)
                        echo byteidx(s, 1)
                        echo byteidxcomp(s, 1)
                        echo byteidxcomp(s, 2)
                The first and third echo result in 3 ('e' plus composing
                character is 3 bytes), the second echo results in 1 ('e' is
                one byte).
                Only works differently from byteidx() when 'encoding' is set
                to a Unicode encoding.

                Can also be used as a method:

                Return type: Number

call({func}{arglist} [, {dict}])                      call() E699
                Call function {func} with the items in List {arglist} as
                {func} can either be a Funcref or the name of a function.
                a:firstline and a:lastline are set to the cursor line.
                Returns the return value of the called function.
                {dict} is for functions with the "dict" attribute.  It will be
                used to set the local variable "self". Dictionary-function

                Can also be used as a method:
                        GetFunc()->call([arg, arg], dict)

                Return type: any, depending on {func}

ceil({expr})                                                    ceil()
                Return the smallest integral value greater than or equal to
                {expr} as a Float (round up).
                {expr} must evaluate to a Float or a Number.
                        echo ceil(1.456)
                        echo ceil(-5.456)
                        echo ceil(4.0)

                Returns 0.0 if {expr} is not a Float or a Number.

                Can also be used as a method:

                Return type: Float

ch_ functions are documented here: channel-functions-details

changenr()                                              changenr()
                Return the number of the most recent change.  This is the same
                number as what is displayed with :undolist and can be used
                with the :undo command.
                When a change was made it is the number of that change.  After
                redo it is the number of the redone change.  After undo it is
                one less than the number of the undone change.
                Returns 0 if the undo list is empty.

                Return type: Number

char2nr({string} [, {utf8}])                                    char2nr()
                Return Number value of the first char in {string}.
                        char2nr(" ")            returns 32
                        char2nr("ABC")          returns 65
                When {utf8} is omitted or zero, the current 'encoding' is used.
                Example for "utf-8":
                        char2nr("Γ‘")            returns 225
                        char2nr("Γ‘"[0])         returns 195
                When {utf8} is TRUE, always treat as UTF-8 characters.
                A combining character is a separate character.
                nr2char() does the opposite.
                To turn a string into a list of character numbers:
                    let str = "ABC"
                    let list = map(split(str, '\zs'), {_, val -> char2nr(val)})
                Result: [65, 66, 67]

                Returns 0 if {string} is not a String.

                Can also be used as a method:

                Return type: Number

charclass({string})                                     charclass()
                Return the character class of the first character in {string}.
                The character class is one of:
                        0       blank
                        1       punctuation
                        2       word character
                        3       emoji
                        other   specific Unicode class
                The class is used in patterns and word motions.
                Returns 0 if {string} is not a String.

                Return type: Number

charcol({expr} [, {winid}])                             charcol()
                Same as col() but returns the character index of the column
                position given with {expr} instead of the byte position.

                With the cursor on 'μ„Έ' in line 5 with text "μ—¬λ³΄μ„Έμš”":
                        charcol('.')            returns 3
                        col('.')                returns 7

                Can also be used as a method:

                Return type: Number

charidx({string}{idx} [, {countcc} [, {utf16}]])
                Return the character index of the byte at {idx} in {string}.
                The index of the first character is zero.
                If there are no multibyte characters the returned value is
                equal to {idx}.

                When {countcc} is omitted or FALSE, then composing characters
                are not counted separately, their byte length is added to the
                preceding base character.
                When {countcc} is TRUE, then composing characters are
                counted as separate characters.

                When {utf16} is present and TRUE, {idx} is used as the UTF-16
                index in the String {expr} instead of as the byte index.

                Returns -1 if the arguments are invalid or if there are less
                than {idx} bytes. If there are exactly {idx} bytes the length
                of the string in characters is returned.

                An error is given and -1 is returned if the first argument is
                not a string, the second argument is not a number or when the
                third argument is present and is not zero or one.

                See byteidx() and byteidxcomp() for getting the byte index
                from the character index and utf16idx() for getting the
                UTF-16 index from the character index.
                Refer to string-offset-encoding for more information.
                        echo charidx('áb́ć', 3)          returns 1
                        echo charidx('áb́ć', 6, 1)       returns 4
                        echo charidx('áb́ć', 16)         returns -1
                        echo charidx('a😊😊', 4, 0, 1)  returns 2

                Can also be used as a method:

                Return type: Number

chdir({dir})                                            chdir()
                Change the current working directory to {dir}.  The scope of
                the directory change depends on the directory of the current
                        - If the current window has a window-local directory
                          (:lcd), then changes the window local directory.
                        - Otherwise, if the current tabpage has a local
                          directory (:tcd) then changes the tabpage local
                        - Otherwise, changes the global directory.
                {dir} must be a String.
                If successful, returns the previous working directory.  Pass
                this to another chdir() to restore the directory.
                On failure, returns an empty string.

                        let save_dir = chdir(newdir)
                        if save_dir != ""
                           " ... do some work
                           call chdir(save_dir)

                Can also be used as a method:

                Return type: String

cindent({lnum})                                         cindent()
                Get the amount of indent for line {lnum} according the C
                indenting rules, as with 'cindent'.
                The indent is counted in spaces, the value of 'tabstop' is
                relevant.  {lnum} is used just like in getline().
                When {lnum} is invalid -1 is returned.
                See C-indenting.

                Can also be used as a method:

                Return type: Number

clearmatches([{win}])                                   clearmatches()
                Clears all matches previously defined for the current window
                by matchadd() and the :match commands.
                If {win} is specified, use the window with this number or
                window ID instead of the current window.

                Can also be used as a method:

                Return type: Number

col({expr} [, {winid}])                                 col()
                The result is a Number, which is the byte index of the column
                position given with {expr}.
                For accepted positions see getpos().
                When {expr} is "$", it means the end of the cursor line, so
                the result is the number of bytes in the cursor line plus one.
                Additionally {expr} can be [lnum, col]: a List with the line
                and column number. Most useful when the column is "$", to get
                the last column of a specific line.  When "lnum" or "col" is
                out of range then col() returns zero.

                With the optional {winid} argument the values are obtained for
                that window instead of the current window.

                To get the line number use line().  To get both use
                For the screen column position use virtcol().  For the
                character position use charcol().

                Note that only marks in the current file can be used.

                        col(".")                column of cursor
                        col("$")                length of cursor line plus one
                        col("'t")               column of mark t
                        col("'" .. markname)    column of mark markname

                The first column is 1.  Returns 0 if {expr} is invalid or when
                the window with ID {winid} is not found.
                For an uppercase mark the column may actually be in another
                For the cursor position, when 'virtualedit' is active, the
                column is one higher if the cursor is after the end of the
                line.  Also, when using a <Cmd> mapping the cursor isn't
                moved, this can be used to obtain the column in Insert mode:
                        :imap <F2> <Cmd>echowin col(".")<CR>

                Can also be used as a method:

                Return type: Number

complete({startcol}{matches})                 complete() E785
                Set the matches for Insert mode completion.
                Can only be used in Insert mode.  You need to use a mapping
                with CTRL-R = (see i_CTRL-R).  It does not work after CTRL-O
                or with an expression mapping.
                {startcol} is the byte offset in the line where the completed
                text start.  The text up to the cursor is the original text
                that will be replaced by the matches.  Use col('.') for an
                empty string.  "col('.') - 1" will replace one character by a
                {matches} must be a List.  Each List item is one match.
                See complete-items for the kind of items that are possible.
                "longest" in 'completeopt' is ignored.
                Note that the after calling this function you need to avoid
                inserting anything that would cause completion to stop.
                The match can be selected with CTRL-N and CTRL-P as usual with
                Insert mode completion.  The popup menu will appear if
                specified, see ins-completion-menu.
        inoremap <F5> <C-R>=ListMonths()<CR>

        func ListMonths()
          call complete(col('.'), ['January', 'February', 'March',
                \ 'April', 'May', 'June', 'July', 'August', 'September',
                \ 'October', 'November', 'December'])
          return ''
                This isn't very useful, but it shows how it works.  Note that
                an empty string is returned to avoid a zero being inserted.

                Can also be used as a method, the base is passed as the
                second argument:

                Return type: Number

complete_add({expr})                            complete_add()
                Add {expr} to the list of matches.  Only to be used by the
                function specified with the 'completefunc' option.
                Returns 0 for failure (empty string or out of memory),
                1 when the match was added, 2 when the match was already in
                the list.
                See complete-functions for an explanation of {expr}.  It is
                the same as one item in the list that 'omnifunc' would return.

                Can also be used as a method:

                Return type: Number

complete_check()                                complete_check()
                Check for a key typed while looking for completion matches.
                This is to be used when looking for matches takes some time.
                Returns TRUE when searching for matches is to be aborted,
                zero otherwise.
                Only to be used by the function specified with the
                'completefunc' option.

                Return type: Number

complete_info([{what}])                         complete_info()
                Returns a Dictionary with information about Insert mode
                completion.  See ins-completion.
                The items are:
                   mode         Current completion mode name string.
                                See complete_info_mode for the values.
                   pum_visible  TRUE if popup menu is visible.
                                See pumvisible().
                   items        List of completion matches.  Each item is a
                                dictionary containing the entries "word",
                                "abbr", "menu", "kind", "info" and "user_data".
                                See complete-items.
                   selected     Selected item index.  First index is zero.
                                Index is -1 if no item is selected (showing
                                typed text only, or the last completion after
                                no item is selected when using the <Up> or
                                <Down> keys)
                   inserted     Inserted string. [NOT IMPLEMENTED YET]

                mode values are:
                   ""                Not in completion mode
                   "keyword"         Keyword completion i_CTRL-X_CTRL-N
                   "ctrl_x"          Just pressed CTRL-X i_CTRL-X
                   "scroll"          Scrolling with i_CTRL-X_CTRL-E or
                   "whole_line"      Whole lines i_CTRL-X_CTRL-L
                   "files"           File names i_CTRL-X_CTRL-F
                   "tags"            Tags i_CTRL-X_CTRL-]
                   "path_defines"    Definition completion i_CTRL-X_CTRL-D
                   "path_patterns"   Include completion i_CTRL-X_CTRL-I
                   "dictionary"      Dictionary i_CTRL-X_CTRL-K
                   "thesaurus"       Thesaurus i_CTRL-X_CTRL-T
                   "cmdline"         Vim Command line i_CTRL-X_CTRL-V
                   "function"        User defined completion i_CTRL-X_CTRL-U
                   "omni"            Omni completion i_CTRL-X_CTRL-O
                   "spell"           Spelling suggestions i_CTRL-X_s
                   "eval"            complete() completion
                   "unknown"         Other internal modes

                If the optional {what} list argument is supplied, then only
                the items listed in {what} are returned.  Unsupported items in
                {what} are silently ignored.

                To get the position and size of the popup menu, see
                pum_getpos(). It's also available in v:event during the
                CompleteChanged event.

                Returns an empty Dictionary on error.

                        " Get all items
                        call complete_info()
                        " Get only 'mode'
                        call complete_info(['mode'])
                        " Get only 'mode' and 'pum_visible'
                        call complete_info(['mode', 'pum_visible'])

                Can also be used as a method:

                Return type: dict<any>

confirm({msg} [, {choices} [, {default} [, {type}]]])
                confirm() offers the user a dialog, from which a choice can be
                made.  It returns the number of the choice.  For the first
                choice this is 1.
                Note: confirm() is only supported when compiled with dialog
                support, see +dialog_con +dialog_con_gui and +dialog_gui.

                {msg} is displayed in a dialog with {choices} as the
                alternatives.  When {choices} is missing or empty, "&OK" is
                used (and translated).
                {msg} is a String, use '\n' to include a newline.  Only on
                some systems the string is wrapped when it doesn't fit.

                {choices} is a String, with the individual choices separated
                by '\n', e.g.
                        confirm("Save changes?", "&Yes\n&No\n&Cancel")
                The letter after the '&' is the shortcut key for that choice.
                Thus you can type 'c' to select "Cancel".  The shortcut does
                not need to be the first letter:
                        confirm("file has been modified", "&Save\nSave &All")
                For the console, the first letter of each choice is used as
                the default shortcut key.  Case is ignored.

                The optional {default} argument is the number of the choice
                that is made if the user hits <CR>.  Use 1 to make the first
                choice the default one.  Use 0 to not set a default.  If
                {default} is omitted, 1 is used.

                The optional {type} String argument gives the type of dialog.
                This is only used for the icon of the GTK, Mac, Motif and
                Win32 GUI.  It can be one of these values: "Error",
                "Question", "Info", "Warning" or "Generic".  Only the first
                character is relevant.  When {type} is omitted, "Generic" is

                If the user aborts the dialog by pressing <Esc>CTRL-C,
                or another valid interrupt key, confirm() returns 0.

                An example:
                   let choice = confirm("What do you want?",
                                        \ "&Apples\n&Oranges\n&Bananas", 2)
                   if choice == 0
                        echo "make up your mind!"
                   elseif choice == 3
                        echo "tasteful"
                        echo "I prefer bananas myself."
                In a GUI dialog, buttons are used.  The layout of the buttons
                depends on the 'v' flag in 'guioptions'.  If it is included,
                the buttons are always put vertically.  Otherwise,  confirm()
                tries to put the buttons in one horizontal line.  If they
                don't fit, a vertical layout is used anyway.  For some systems
                the horizontal layout is always used.

                Can also be used as a methodin:

                Return type: Number

copy({expr})                                                    copy()
                Make a copy of {expr}.  For Numbers and Strings this isn't
                different from using {expr} directly.
                When {expr} is a List a shallow copy is created.  This means
                that the original List can be changed without changing the
                copy, and vice versa.  But the items are identical, thus
                changing an item changes the contents of both Lists.
                A Dictionary is copied in a similar way as a List.
                Also see deepcopy().
                Can also be used as a method:

                Return type: any, depending on {expr}

cos({expr})                                             cos()
                Return the cosine of {expr}, measured in radians, as a Float.
                {expr} must evaluate to a Float or a Number.
                Returns 0.0 if {expr} is not a Float or a Number.
                        :echo cos(100)
                        :echo cos(-4.01)

                Can also be used as a method:

                Return type: Float

cosh({expr})                                            cosh()
                Return the hyperbolic cosine of {expr} as a Float in the range
                [1, inf].
                {expr} must evaluate to a Float or a Number.
                Returns 0.0 if {expr} is not a Float or a Number.
                        :echo cosh(0.5)
                        :echo cosh(-0.5)

                Can also be used as a method:

                Return type: Float

count({comp}{expr} [, {ic} [, {start}]])              count() E706
                Return the number of times an item with value {expr} appears
                in StringList or Dictionary {comp}.

                If {start} is given then start with the item with this index.
                {start} can only be used with a List.

                When {ic} is given and it's TRUE then case is ignored.

                When {comp} is a string then the number of not overlapping
                occurrences of {expr} is returned. Zero is returned when
                {expr} is an empty string.

                Can also be used as a method:

                Return type: Number

cscope_connection([{num} , {dbpath} [, {prepend}]])
                Checks for the existence of a cscope connection.  If no
                parameters are specified, then the function returns:
                        0, if cscope was not available (not compiled in), or
                           if there are no cscope connections;
                        1, if there is at least one cscope connection.

                If parameters are specified, then the value of {num}
                determines how existence of a cscope connection is checked:

                {num}   Description of existence check
                -----   ------------------------------
                0       Same as no parameters (e.g., "cscope_connection()").
                1       Ignore {prepend}, and use partial string matches for
                2       Ignore {prepend}, and use exact string matches for
                3       Use {prepend}, use partial string matches for both
                        {dbpath} and {prepend}.
                4       Use {prepend}, use exact string matches for both
                        {dbpath} and {prepend}.

                Note: All string comparisons are case sensitive!

                Examples.  Suppose we had the following (from ":cs show"):

  # pid    database name                        prepend path
  0 27664  cscope.out                           /usr/local

                Invocation                                      Return Val
                ----------                                      ----------
                cscope_connection()                                     1
                cscope_connection(1, "out")                             1
                cscope_connection(2, "out")                             0
                cscope_connection(3, "out")                             0
                cscope_connection(3, "out", "local")                    1
                cscope_connection(4, "out")                             0
                cscope_connection(4, "out", "local")                    0
                cscope_connection(4, "cscope.out", "/usr/local")        1

                Return type: Number

cursor({lnum}{col} [, {off}])                         cursor()
                Positions the cursor at the column (byte count) {col} in the
                line {lnum}.  The first column is one.

                When there is one argument {list} this is used as a List
                with two, three or four item:
                This is like the return value of getpos() or getcurpos(),
                but without the first item.

                To position the cursor using {col} as the character count, use

                Does not change the jumplist.
                {lnum} is used like with getline(), except that if {lnum} is
                zero, the cursor will stay in the current line.
                If {lnum} is greater than the number of lines in the buffer,
                the cursor will be positioned at the last line in the buffer.
                If {col} is greater than the number of bytes in the line,
                the cursor will be positioned at the last character in the
                If {col} is zero, the cursor will stay in the current column.
                If {curswant} is given it is used to set the preferred column
                for vertical movement.  Otherwise {col} is used.

                When 'virtualedit' is used {off} specifies the offset in
                screen columns from the start of the character.  E.g., a
                position within a <Tab> or after the last character.
                Returns 0 when the position could be set, -1 otherwise.

                Can also be used as a method:

                Return type: Number

debugbreak({pid})                                       debugbreak()
                Specifically used to interrupt a program being debugged.  It
                will cause process {pid} to get a SIGTRAP.  Behavior for other
                processes is undefined. See terminal-debugger.
                {only available on MS-Windows}

                Returns TRUE if successfully interrupted the program.
                Otherwise returns FALSE.

                Can also be used as a method:

                Return type: Number

deepcopy({expr} [, {noref}])                            deepcopy() E698
                Make a copy of {expr}.  For Numbers and Strings this isn't
                different from using {expr} directly.
                When {expr} is a List a full copy is created.  This means
                that the original List can be changed without changing the
                copy, and vice versa.  When an item is a List or
                Dictionary, a copy for it is made, recursively.  Thus
                changing an item in the copy does not change the contents of
                the original List.
                A Dictionary is copied in a similar way as a List.

                When {noref} is omitted or zero a contained List or
                Dictionary is only copied once.  All references point to
                this single copy.  With {noref} set to 1 every occurrence of a
                List or Dictionary results in a new copy.  This also means
                that a cyclic reference causes deepcopy() to fail.
                Nesting is possible up to 100 levels.  When there is an item
                that refers back to a higher level making a deep copy with
                {noref} set to 1 will fail.
                Also see copy().

                Can also be used as a method:

                Return type: any, depending on {expr}

delete({fname} [, {flags}])                             delete()
                Without {flags} or with {flags} empty: Deletes the file by the
                name {fname}.

                This also works when {fname} is a symbolic link.  The symbolic
                link itself is deleted, not what it points to.

                When {flags} is "d": Deletes the directory by the name
                {fname}.  This fails when directory {fname} is not empty.

                When {flags} is "rf": Deletes the directory by the name
                {fname} and everything in it, recursively.  BE CAREFUL!
                Note: on MS-Windows it is not possible to delete a directory
                that is being used.

                The result is a Number, which is 0/false if the delete
                operation was successful and -1/true when the deletion failed
                or partly failed.

                Use remove() to delete an item from a List.
                To delete a line from the buffer use :delete or

                Can also be used as a method:

                Return type: Number

deletebufline({buf}{first} [, {last}])                deletebufline()
                Delete lines {first} to {last} (inclusive) from buffer {buf}.
                If {last} is omitted then delete line {first} only.
                On success 0 is returned, on failure 1 is returned.

                This function works only for loaded buffers. First call
                bufload() if needed.

                For the use of {buf}, see bufname() above.

                {first} and {last} are used like with getline()Note that
                when using line() this refers to the current buffer. Use "$"
                to refer to the last line in buffer {buf}.

                Can also be used as a method:

                Return type: Number

did_filetype()  Returns TRUE when autocommands are being executed and the
                FileType event has been triggered at least once.  Can be used
                to avoid triggering the FileType event again in the scripts
                that detect the file type. FileType
                Returns FALSE when :setf FALLBACK was used.
                When editing another file, the counter is reset, thus this
                really checks if the FileType event has been triggered for the
                current buffer.  This allows an autocommand that starts
                editing another buffer to set 'filetype' and load a syntax

                Return type: Number

diff({fromlist}{tolist} [, {options}])                diff()
                Returns a String or a List containing the diff between the
                strings in {fromlist} and {tolist}.  Uses the Vim internal
                diff library to compute the diff.

                The optional "output" item in {options} specifies the returned
                diff format.  The following values are supported:
                    indices     Return a List of the starting and ending
                                indices and a count of the strings in each
                                diff hunk.
                    unified     Return the unified diff output as a String.
                                This is the default.

                If the "output" item in {options} is "indices", then a List is
                returned.  Each List item contains a Dict with the following
                items for each diff hunk:
                    from_idx    start index in {fromlist} for this diff hunk.
                    from_count  number of strings in {fromlist} that are
                                added/removed/modified in this diff hunk.
                    to_idx      start index in {tolist} for this diff hunk.
                    to_count    number of strings in {tolist} that are
                                added/removed/modified in this diff hunk.

                The {options} Dict argument also specifies diff options
                (similar to 'diffopt') and supports the following items:
                    algorithm           Dict specifying the diff algorithm to
                                        use.  Supported boolean items are
                                        "myers", "minimal", "patience" and
                    context             diff context length.  Default is 0.
                    iblank              ignore changes where lines are all
                    icase               ignore changes in case of text.
                    indent-heuristic    use the indent heuristic for the
                                        internal diff library.
                    iwhite              ignore changes in amount of white
                    iwhiteall           ignore all white space changes.
                    iwhiteeol           ignore white space changes at end of
                For more information about these options, refer to 'diffopt'.

                To compute the unified diff, all the items in {fromlist} are
                concatenated into a string using a newline separator and the
                same for {tolist}.  The unified diff output uses line numbers.

                Returns an empty List or String if {fromlist} and {tolist} are

                    :echo diff(['abc'], ['xxx'])
                     @@ -1 +1 @@

                    :echo diff(['abc'], ['xxx'], {'output': 'indices'})
                     [{'from_idx': 0, 'from_count': 1, 'to_idx': 0, 'to_count': 1}]
                    :echo diff(readfile('oldfile'), readfile('newfile'))
                    :echo diff(getbufline(5, 1, '$'), getbufline(6, 1, '$'))

                For more examples, refer to diff-func-examples

                Can also be used as a method:

                Return type: String or list<dict<number>> or list<any>
                depending on {options}

diff_filler({lnum})                                     diff_filler()
                Returns the number of filler lines above line {lnum}.
                These are the lines that were inserted at this point in
                another diff'ed window.  These filler lines are shown in the
                display but don't exist in the buffer.
                {lnum} is used like with getline().  Thus "." is the current
                line, "'m" mark m, etc.
                Returns 0 if the current window is not in diff mode.

                Can also be used as a method:

                Return type: Number

diff_hlID({lnum}{col})                                diff_hlID()
                Returns the highlight ID for diff mode at line {lnum} column
                {col} (byte index).  When the current line does not have a
                diff change zero is returned.
                {lnum} is used like with getline().  Thus "." is the current
                line, "'m" mark m, etc.
                {col} is 1 for the leftmost column, {lnum} is 1 for the first
                The highlight ID can be used with synIDattr() to obtain
                syntax information about the highlighting.

                Can also be used as a method:

                Return type: Number

digraph_get({chars})                                    digraph_get() E1214
                Return the digraph of {chars}.  This should be a string with
                exactly two characters.  If {chars} are not just two
                characters, or the digraph of {chars} does not exist, an error
                is given and an empty string is returned.

                The character will be converted from Unicode to 'encoding'
                when needed.  This does require the conversion to be
                available, it might fail.

                Also see digraph_getlist().

                " Get a built-in digraph
                :echo digraph_get('00')         " Returns '∞'

                " Get a user-defined digraph
                :call digraph_set('aa', 'あ')
                :echo digraph_get('aa')         " Returns 'あ'

                Can also be used as a method:

                Return type: String

                This function works only when compiled with the +digraphs
                feature.  If this feature is disabled, this function will
                display an error message.

digraph_getlist([{listall}])                            digraph_getlist()
                Return a list of digraphs.  If the {listall} argument is given
                and it is TRUE, return all digraphs, including the default
                digraphs.  Otherwise, return only user-defined digraphs.

                The characters will be converted from Unicode to 'encoding'
                when needed.  This does require the conservation to be
                available, it might fail.

                Also see digraph_get().

                " Get user-defined digraphs
                :echo digraph_getlist()

                " Get all the digraphs, including default digraphs
                :echo digraph_getlist(1)

                Can also be used as a method:

                Return type: list<list<string>>

                This function works only when compiled with the +digraphs
                feature.  If this feature is disabled, this function will
                display an error message.

digraph_set({chars}{digraph})                         digraph_set()
                Add digraph {chars} to the list.  {chars} must be a string
                with two characters.  {digraph} is a string with one UTF-8
                encoded character.  E1215
                Be careful, composing characters are NOT ignored.  This
                function is similar to :digraphs command, but useful to add
                digraphs start with a white space.

                The function returns v:true if digraph is registered.  If
                this fails an error message is given and v:false is returned.

                If you want to define multiple digraphs at once, you can use

                        call digraph_set('  ', 'あ')

                Can be used as a method:

                Return type: vim9-boolean

                This function works only when compiled with the +digraphs
                feature.  If this feature is disabled, this function will
                display an error message.

digraph_setlist({digraphlist})                          digraph_setlist()
                Similar to digraph_set() but this function can add multiple
                digraphs at once.  {digraphlist} is a list composed of lists,
                where each list contains two strings with {chars} and
                {digraph} as in digraph_set()E1216
                    call digraph_setlist([['aa', 'あ'], ['ii', 'い']])

                It is similar to the following:
                    for [chars, digraph] in [['aa', 'あ'], ['ii', 'い']]
                          call digraph_set(chars, digraph)
                Except that the function returns after the first error,
                following digraphs will not be added.

                Can be used as a method:

                Return type: vim9-boolean

                This function works only when compiled with the +digraphs
                feature.  If this feature is disabled, this function will
                display an error message.

echoraw({string})                                       echoraw()
                Output {string} as-is, including unprintable characters.
                This can be used to output a terminal code. For example, to
                disable modifyOtherKeys:
                        call echoraw(&t_TE)
                and to enable it again:
                        call echoraw(&t_TI)
                Use with care, you can mess up the terminal this way.

                Return type: Number

empty({expr})                                           empty()
                Return the Number 1 if {expr} is empty, zero otherwise.
                - A List or Dictionary is empty when it does not have any
                - A String is empty when its length is zero.
                - A Number and Float are empty when their value is zero.
                - v:falsev:none and v:null are empty, v:true is not.
                - A Job is empty when it failed to start.
                - A Channel is empty when it is closed.
                - A Blob is empty when its length is zero.
                - An Object is empty, when the empty() method in the object
                  (if present) returns true. object-empty()

                For a long List this is much faster than comparing the
                length with zero.

                Can also be used as a method:

                Return type: Number

environ()                                               environ()
                Return all of environment variables as dictionary. You can
                check if an environment variable exists like this:
                        :echo has_key(environ(), 'HOME')
                Note that the variable name may be CamelCase; to ignore case
                use this:
                        :echo index(keys(environ()), 'HOME', 0, 1) != -1

                Return type: dict<string>

err_teapot([{expr}])                                    err_teapot()
                Produce an error with number 418, needed for implementation of
                RFC 2324.
                If {expr} is present and it is TRUE error 503 is given,
                indicating that coffee is temporarily not available.
                If {expr} is present it must be a String.

                Return type: Number

escape({string}{chars})                               escape()
                Escape the characters in {chars} that occur in {string} with a
                backslash.  Example:
                        :echo escape('c:\program files\vim', ' \')
                results in:
                        c:\\program\ files\\vim
                Also see shellescape() and fnameescape().

                Can also be used as a method:
                        GetText()->escape(' \')

                Return type: String

eval({string})  Evaluate {string} and return the result.  Especially useful to
                turn the result of string() back into the original value.
                This works for Numbers, Floats, Strings, Blobs and composites
                of them.  Also works for Funcrefs that refer to existing
                functions.  In Vim9 script, it can be used to obtain enum
                values from their fully qualified names.

                Can also be used as a method:

                Return type: any, depending on {string}

eventhandler()                                          eventhandler()
                Returns 1 when inside an event handler.  That is that Vim got
                interrupted while waiting for the user to type a character,
                e.g., when dropping a file on Vim.  This means interactive
                commands cannot be used.  Otherwise zero is returned.

                Return type: Number

executable({expr})                                      executable()
                This function checks if an executable with the name {expr}
                exists.  {expr} must be the name of the program without any
                executable() uses the value of $PATH and/or the normal
                searchpath for programs.                PATHEXT
                On MS-Windows the ".exe", ".bat", etc. can optionally be
                included.  Then the extensions in $PATHEXT are tried.  Thus if
                "foo.exe" does not exist, "foo.exe.bat" can be found.  If
                $PATHEXT is not set then ".com;.exe;.bat;.cmd" is used.  A dot
                by itself can be used in $PATHEXT to try using the name
                without an extension.  When 'shell' looks like a Unix shell,
                then the name is also tried without adding an extension.
                On MS-Windows it only checks if the file exists and is not a
                directory, not if it's really executable.
                On MS-Windows an executable in the same directory as Vim is
                normally found.  Since this directory is added to $PATH it
                should also work to execute it win32-PATH.  This can be
                disabled by setting the $NoDefaultCurrentDirectoryInExePath
                environment variable.  NoDefaultCurrentDirectoryInExePath
                The result is a Number:
                        1       exists
                        0       does not exist
                        -1      not implemented on this system
                exepath() can be used to get the full path of an executable.

                Can also be used as a method:

                Return type: Number

execute({command} [, {silent}])                                 execute()
                Execute an Ex command or commands and return the output as a
                {command} can be a string or a List.  In case of a List the
                lines are executed one by one.
                This is more or less equivalent to:
                        redir => var
                        redir END
                Except that line continuation in {command} is not recognized.

                The optional {silent} argument can have these values:
                        ""              no :silent used
                        "silent"        :silent used
                        "silent!"       :silent! used
                The default is "silent".  Note that with "silent!", unlike
                :redir, error messages are dropped.  When using an external
                command the screen may be messed up, use system() instead.
                It is not possible to use :redir anywhere in {command}.

                To get a list of lines use split() on the result:

                To execute a command in another window than the current one
                use win_execute().

                When used recursively the output of the recursive call is not
                included in the output of the higher level call.

                Can also be used as a method:

                Return type: String

exepath({expr})                                         exepath()
                If {expr} is an executable and is either an absolute path, a
                relative path or found in $PATH, return the full path.
                Note that the current directory is used when {expr} starts
                with "./", which may be a problem for Vim:
                        echo exepath(v:progpath)
                If {expr} cannot be found in $PATH or is not executable then
                an empty string is returned.

                Can also be used as a method:

                Return type: String

exists({expr})                                                  exists()
                The result is a Number, which is TRUE if {expr} is defined,
                zero otherwise.

                Note: In a compiled :def function the evaluation is done at
                runtime.  Use exists_compiled() to evaluate the expression
                at compile time.

                For checking for a supported feature use has().
                For checking if a file exists use filereadable().

                The {expr} argument is a string, which contains one of these:
                        varname         internal variable (see
                        dict.key        internal-variables).  Also works
                        list[i]         for curly-braces-namesDictionary
                        import.Func     entries, List items, class and
                        class.Func      object methods, imported items, etc.
                        object.Func     Does not work for local variables in a
                        class.varname   compiled :def function.
                        object.varname  Also works for a function in Vim9
                                        script, since it can be used as a
                                        function reference.
                                        Beware that evaluating an index may
                                        cause an error message for an invalid
                                        expression.  E.g.:
                                           :let l = [1, 2, 3]
                                           :echo exists("l[5]")
                                           :echo exists("l[xx]")
                                           E121: Undefined variable: xx
                        &option-name    Vim option (only checks if it exists,
                                        not if it really works)
                        +option-name    Vim option that works.
                        $ENVNAME        environment variable (could also be
                                        done by comparing with an empty
                        *funcname       built-in function (see functions)
                                        or user defined function (see
                                        user-functions) that is implemented.
                                        Also works for a variable that is a
                        ?funcname       built-in function that could be
                                        implemented; to be used to check if
                                        "funcname" is valid
                        :cmdname        Ex command: built-in command, user
                                        command or command modifier :command.
                                        1  for match with start of a command
                                        2  full match with a command
                                        3  matches several user commands
                                        To check for a supported command
                                        always check the return value to be 2.
                        :2match         The :2match command.
                        :3match         The :3match command (but you
                                        probably should not use it, it is
                                        reserved for internal usage)
                        #event          autocommand defined for this event
                        #event#pattern  autocommand defined for this event and
                                        pattern (the pattern is taken
                                        literally and compared to the
                                        autocommand patterns character by
                        #group          autocommand group exists
                        #group#event    autocommand defined for this group and
                                        autocommand defined for this group,
                                        event and pattern.
                        ##event         autocommand for this event is

                        exists("*s:MyFunc")     " only for legacy script
                There must be no space between the symbol (&/$/*/#) and the
                There must be no extra characters after the name, although in
                a few cases this is ignored.  That may become stricter in the
                future, thus don't count on it!
                Working example:
                NOT working example:
                        exists(":make install")

                Note that the argument must be a string, not the name of the
                variable itself.  For example:
                This doesn't check for existence of the "bufcount" variable,
                but gets the value of "bufcount", and checks if that exists.

                Can also be used as a method:

                Return type: String

exists_compiled({expr})                                 exists_compiled()
                Like exists() but evaluated at compile time.  This is useful
                to skip a block where a function is used that would otherwise
                give an error:
                        if exists_compiled('*ThatFunction')
                If exists() were used then a compilation error would be
                given if ThatFunction() is not defined.

                {expr} must be a literal string. E1232
                Can only be used in a :def function. E1233
                This does not work to check for arguments or local variables.

                Return type: String

exp({expr})                                                     exp()
                Return the exponential of {expr} as a Float in the range
                [0, inf].
                {expr} must evaluate to a Float or a Number.
                Returns 0.0 if {expr} is not a Float or a Number.
                        :echo exp(2)
                        :echo exp(-1)

                Can also be used as a method:

                Return type: Float

expand({string} [, {nosuf} [, {list}]])                         expand()
                Expand wildcards and the following special keywords in
                {string}.  'wildignorecase' applies.

                If {list} is given and it is TRUE, a List will be returned.
                Otherwise the result is a String and when there are several
                matches, they are separated by <NL> characters.  [Note: in
                version 5.0 a space was used, which caused problems when a
                file name contains a space]

                If the expansion fails, the result is an empty string.  A name
                for a non-existing file is not included, unless {string} does
                not start with '%', '#' or '<', see below.

                For a :terminal window '%' expands to a '!' followed by
                the command or shell that is run.  terminal-bufname

                When {string} starts with '%', '#' or '<', the expansion is
                done like for the cmdline-special variables with their
                associated modifiers.  Here is a short overview:

                        %               current file name
                        #               alternate file name
                        #n              alternate file name n
                        <cfile>         file name under the cursor
                        <afile>         autocmd file name
                        <abuf>          autocmd buffer number (as a String!)
                        <amatch>        autocmd matched name
                        <cexpr>         C expression under the cursor
                        <sfile>         sourced script file or function name
                        <slnum>         sourced script line number or function
                                        line number
                        <sflnum>        script file line number, also when in
                                        a function
                        <SID>           "<SNR>123_"  where "123" is the
                                        current script ID  <SID>
                        <script>        sourced script file, or script file
                                        where the current function was defined
                        <stack>         call stack
                        <cword>         word under the cursor
                        <cWORD>         WORD under the cursor
                        <client>        the {clientid} of the last received
                                        message server2client()
                        :p              expand to full path
                        :h              head (last path component removed)
                        :t              tail (last path component only)
                        :r              root (one extension removed)
                        :e              extension only

                        :let &tags = expand("%:p:h") .. "/tags"
                Note that when expanding a string that starts with '%', '#' or
                '<', any following text is ignored.  This does NOT work:
                        :let doesntwork = expand("%:h.bak")
                Use this:
                        :let doeswork = expand("%:h") .. ".bak"
                Also note that expanding "<cfile>" and others only returns the
                referenced file name without further expansion.  If "<cfile>"
                is "~/.cshrc", you need to do another expand() to have the
                "~/" expanded into the path of the home directory:
                        :echo expand(expand("<cfile>"))

                There cannot be white space between the variables and the
                following modifier.  The fnamemodify() function can be used
                to modify normal file names.

                When using '%' or '#', and the current or alternate file name
                is not defined, an empty string is used.  Using "%:p" in a
                buffer with no name, results in the current directory, with a
                '/' added.
                When 'verbose' is set then expanding '%', '#' and <> items
                will result in an error message if the argument cannot be

                When {string} does not start with '%', '#' or '<', it is
                expanded like a file name is expanded on the command line.
                'suffixes' and 'wildignore' are used, unless the optional
                {nosuf} argument is given and it is TRUE.
                Names for non-existing files are included.  The "**" item can
                be used to search in a directory tree.  For example, to find
                all "README" files in the current directory and below:
                        :echo expand("**/README")

                expand() can also be used to expand variables and environment
                variables that are only known in a shell.  But this can be
                slow, because a shell may be used to do the expansion.  See
                The expanded variable is still handled like a list of file
                names.  When an environment variable cannot be expanded, it is
                left unchanged.  Thus ":echo expand('$FOOBAR')" results in

                See glob() for finding existing files.  See system() for
                getting the raw output of an external command.

                Can also be used as a method:

                Return type: String or list<string> depending on {list}

expandcmd({string} [, {options}])                       expandcmd()
                Expand special items in String {string} like what is done for
                an Ex command such as :edit.  This expands special keywords,
                like with expand(), and environment variables, anywhere in
                {string}.  "~user" and "~/path" are only expanded at the

                The following items are supported in the {options} Dict
                    errmsg      If set to TRUE, error messages are displayed
                                if an error is encountered during expansion.
                                By default, error messages are not displayed.

                Returns the expanded string.  If an error is encountered
                during expansion, the unmodified {string} is returned.

                        :echo expandcmd('make %<.o')
                        make /path/runtime/doc/builtin.o
                        :echo expandcmd('make %<.o', {'errmsg': v:true})

                Can also be used as a method:

                Return type: String or list<string> depending on {list}

extend({expr1}{expr2} [, {expr3}])                    extend()
                {expr1} and {expr2} must be both Lists or both

                If they are Lists: Append {expr2} to {expr1}.
                If {expr3} is given insert the items of {expr2} before the
                item with index {expr3} in {expr1}.  When {expr3} is zero
                insert before the first item.  When {expr3} is equal to
                len({expr1}) then {expr2} is appended.
                        :echo sort(extend(mylist, [7, 5]))
                        :call extend(mylist, [2, 3], 1)
                When {expr1} is the same List as {expr2} then the number of
                items copied is equal to the original length of the List.
                E.g., when {expr3} is 1 you get N new copies of the first item
                (where N is the original length of the List).
                Use add() to concatenate one item to a list.  To concatenate
                two lists into a new list use the + operator:
                        :let newlist = [1, 2, 3] + [4, 5]

                If they are Dictionaries:
                Add all entries from {expr2} to {expr1}.
                If a key exists in both {expr1} and {expr2} then {expr3} is
                used to decide what to do:
                {expr3} = "keep": keep the value of {expr1}
                {expr3} = "force": use the value of {expr2}
                {expr3} = "error": give an error message                E737
                When {expr3} is omitted then "force" is assumed.

                {expr1} is changed when {expr2} is not empty.  If necessary
                make a copy of {expr1} first.
                {expr2} remains unchanged.
                When {expr1} is locked and {expr2} is not empty the operation
                Returns {expr1}.  Returns 0 on error.

                Can also be used as a method:

                Return type: list<{type}> or dict<{type}> depending on {expr1}
                and {expr2}, in case of error: Number

extendnew({expr1}{expr2} [, {expr3}])                 extendnew()
                Like extend() but instead of adding items to {expr1} a new
                List or Dictionary is created and returned.  {expr1} remains

                Return type: list<{type}> or dict<{type}> depending on {expr1}
                and {expr2}, in case of error: Number

feedkeys({string} [, {mode}])                           feedkeys()
                Characters in {string} are queued for processing as if they
                come from a mapping or were typed by the user.

                By default the string is added to the end of the typeahead
                buffer, thus if a mapping is still being executed the
                characters come after them.  Use the 'i' flag to insert before
                other characters, they will be executed next, before any
                characters from a mapping.

                The function does not wait for processing of keys contained in

                To include special keys into {string}, use double-quotes
                and "\..." notation expr-quote. For example,
                feedkeys("\<CR>") simulates pressing of the <Enter> key. But
                feedkeys('\<CR>') pushes 5 characters.
                A special code that might be useful is <Ignore>, it exits the
                wait for a character without doing anything.  <Ignore>

                {mode} is a String, which can contain these character flags:
                'm'     Remap keys. This is default.  If {mode} is absent,
                        keys are remapped.
                'n'     Do not remap keys.
                't'     Handle keys as if typed; otherwise they are handled as
                        if coming from a mapping.  This matters for undo,
                        opening folds, etc.
                'L'     Lowlevel input.  Only works for Unix or when using the
                        GUI. Keys are used as if they were coming from the
                        terminal.  Other flags are not used.  E980
                        When a CTRL-C interrupts and 't' is included it sets
                        the internal "got_int" flag.
                'i'     Insert the string instead of appending (see above).
                'x'     Execute commands until typeahead is empty.  This is
                        similar to using ":normal!".  You can call feedkeys()
                        several times without 'x' and then one time with 'x'
                        (possibly with an empty {string}) to execute all the
                        typeahead.  Note that when Vim ends in Insert mode it
                        will behave as if <Esc> is typed, to avoid getting
                        stuck, waiting for a character to be typed before the
                        script continues.
                        Note that if you manage to call feedkeys() while
                        executing commands, thus calling it recursively, then
                        all typeahead will be consumed by the last call.
                'c'     Remove any script context when executing, so that
                        legacy script syntax applies, "s:var" does not work,
                        etc.  Note that if the string being fed sets a script
                        context this still applies.
                '!'     When used with 'x' will not end Insert mode. Can be
                        used in a test when a timer is set to exit Insert mode
                        a little later.  Useful for testing CursorHoldI.

                Return value is always 0.

                Can also be used as a method:

                Return type: String or list<string> depending on {list}

filecopy({from}{to})                                  filecopy()
                Copy the file pointed to by the name {from} to {to}. The
                result is a Number, which is TRUE if the file was copied
                successfully, and FALSE when it failed.
                If a file with name {to} already exists, it will fail.
                Note that it does not handle directories (yet).

                This function is not available in the sandbox.

                Can also be used as a method:

                Return type: Number

filereadable({file})                                    filereadable()
                The result is a Number, which is TRUE when a file with the
                name {file} exists, and can be read.  If {file} doesn't exist,
                or is a directory, the result is FALSE.  {file} is any
                expression, which is used as a String.
                If you don't care about the file being readable you can use
                {file} is used as-is, you may want to expand wildcards first:
                        echo filereadable('~/.vimrc')
                        echo filereadable(expand('~/.vimrc'))

                Can also be used as a method:

                Return type: Number

                Obsolete name: file_readable().

filewritable({file})                                    filewritable()
                The result is a Number, which is 1 when a file with the
                name {file} exists, and can be written.  If {file} doesn't
                exist, or is not writable, the result is 0.  If {file} is a
                directory, and we can write to it, the result is 2.

                Can also be used as a method:

                Return type: Number

filter({expr1}{expr2})                                filter()
                {expr1} must be a ListStringBlob or Dictionary.
                For each item in {expr1} evaluate {expr2} and when the result
                is zero or false remove the item from the List or
                Dictionary.  Similarly for each byte in a Blob and each
                character in a String.

                {expr2} must be a string or Funcref.

                If {expr2} is a string, inside {expr2} v:val has the value
                of the current item.  For a Dictionary v:key has the key
                of the current item and for a List v:key has the index of
                the current item.  For a Blob v:key has the index of the
                current byte. For a String v:key has the index of the
                current character.
                        call filter(mylist, 'v:val !~ "OLD"')
                Removes the items where "OLD" appears.
                        call filter(mydict, 'v:key >= 8')
                Removes the items with a key below 8.
                        call filter(var, 0)
                Removes all the items, thus clears the List or Dictionary.

                Note that {expr2} is the result of expression and is then
                used as an expression again.  Often it is good to use a
                literal-string to avoid having to double backslashes.

                If {expr2} is a Funcref it must take two arguments:
                        1. the key or the index of the current item.
                        2. the value of the current item.
                The function must return TRUE if the item should be kept.
                Example that keeps the odd items of a list:
                        func Odd(idx, val)
                          return a:idx % 2 == 1
                        call filter(mylist, function('Odd'))
                It is shorter when using a lambda.  In Vim9 syntax:
                        call filter(myList, (idx, val) => idx * val <= 42)
                In legacy script syntax:
                        call filter(myList, {idx, val -> idx * val <= 42})
                If you do not use "val" you can leave it out:
                        call filter(myList, {idx -> idx % 2 == 1})

                In Vim9 script the result must be true, false, zero or one.
                Other values will result in a type error.

                For a List and a Dictionary the operation is done
                in-place.  If you want it to remain unmodified make a copy
                        :let l = filter(copy(mylist), 'v:val =~ "KEEP"')

                Returns {expr1}, the List or Dictionary that was filtered,
                or a new Blob or String.
                When an error is encountered while evaluating {expr2} no
                further items in {expr1} are processed.
                When {expr2} is a Funcref errors inside a function are ignored,
                unless it was defined with the "abort" flag.

                Can also be used as a method:

                Return type: StringBlob, list<{type}> or dict<{type}>
                depending on {expr1}

finddir({name} [, {path} [, {count}]])                          finddir()
                Find directory {name} in {path}.  Supports both downwards and
                upwards recursive directory searches.  See file-searching
                for the syntax of {path}.

                Returns the path of the first found match.  When the found
                directory is below the current directory a relative path is
                returned.  Otherwise a full path is returned.
                If {path} is omitted or empty then 'path' is used.

                If the optional {count} is given, find {count}'s occurrence of
                {name} in {path} instead of the first one.
                When {count} is negative return all the matches in a List.

                Returns an empty string if the directory is not found.

                This is quite similar to the ex-command :find.

                Can also be used as a method:

                Return type: String

findfile({name} [, {path} [, {count}]])                         findfile()
                Just like finddir(), but find a file instead of a directory.
                Uses 'suffixesadd'.
                        :echo findfile("tags.vim", ".;")
                Searches from the directory of the current file upwards until
                it finds the file "tags.vim".

                Can also be used as a method:

                Return type: String

flatten({list} [, {maxdepth}])                                  flatten()
                Flatten {list} up to {maxdepth} levels.  Without {maxdepth}
                the result is a List without nesting, as if {maxdepth} is
                a very large number.
                The {list} is changed in place, use flattennew() if you do
                not want that.
                In Vim9 script flatten() cannot be used, you must always use
                {maxdepth} means how deep in nested lists changes are made.
                {list} is not modified when {maxdepth} is 0.
                {maxdepth} must be positive number.

                If there is an error the number zero is returned.

                        :echo flatten([1, [2, [3, 4]], 5])
                        [1, 2, 3, 4, 5]
                        :echo flatten([1, [2, [3, 4]], 5], 1)
                        [1, 2, [3, 4], 5]

                Can also be used as a method:

                Return type: list<{type}>

flattennew({list} [, {maxdepth}])                       flattennew()
                Like flatten() but first make a copy of {list}.

                Return type: list<{type}>

float2nr({expr})                                        float2nr()
                Convert {expr} to a Number by omitting the part after the
                decimal point.
                {expr} must evaluate to a Float or a Number.
                Returns 0 if {expr} is not a Float or a Number.
                When the value of {expr} is out of range for a Number the
                result is truncated to 0x7fffffff or -0x7fffffff (or when
                64-bit Number support is enabled, 0x7fffffffffffffff or
                -0x7fffffffffffffff).  NaN results in -0x80000000 (or when
                64-bit Number support is enabled, -0x8000000000000000).
                        echo float2nr(3.95)
                        echo float2nr(-23.45)
                        echo float2nr(1.0e100)
                        2147483647  (or 9223372036854775807)
                        echo float2nr(-1.0e150)
                        -2147483647 (or -9223372036854775807)
                        echo float2nr(1.0e-100)

                Can also be used as a method:

                Return type: Number

floor({expr})                                                   floor()
                Return the largest integral value less than or equal to
                {expr} as a Float (round down).
                {expr} must evaluate to a Float or a Number.
                Returns 0.0 if {expr} is not a Float or a Number.
                        echo floor(1.856)
                        echo floor(-5.456)
                        echo floor(4.0)

                Can also be used as a method:

                Return type: Float

fmod({expr1}{expr2})                                  fmod()
                Return the remainder of {expr1} / {expr2}, even if the
                division is not representable.  Returns {expr1} - i * {expr2}
                for some integer i such that if {expr2} is non-zero, the
                result has the same sign as {expr1} and magnitude less than
                the magnitude of {expr2}.  If {expr2} is zero, the value
                returned is zero.  The value returned is a Float.
                {expr1} and {expr2} must evaluate to a Float or a Number.
                Returns 0.0 if {expr1} or {expr2} is not a Float or a
                        :echo fmod(12.33, 1.22)
                        :echo fmod(-12.33, 1.22)

                Can also be used as a method:

                Return type: Float

fnameescape({string})                                   fnameescape()
                Escape {string} for use as file name command argument.  All
                characters that have a special meaning, such as '%' and '|'
                are escaped with a backslash.
                For most systems the characters escaped are
                " \t\n*?[{`$\\%#'\"|!<".  For systems where a backslash
                appears in a filename, it depends on the value of 'isfname'.
                A leading '+' and '>' is also escaped (special after :edit
                and :write).  And a "-" by itself (special after :cd).
                Returns an empty string on error.
                        :let fname = '+some str%nge|name'
                        :exe "edit " .. fnameescape(fname)
                results in executing:
                        edit \+some\ str\%nge\|name

                Can also be used as a method:

                Return type: String

fnamemodify({fname}{mods})                            fnamemodify()
                Modify file name {fname} according to {mods}.  {mods} is a
                string of characters like it is used for file names on the
                command line.  See filename-modifiers.
                        :echo fnamemodify("main.c", ":p:h")
                results in:
                If {mods} is empty or an unsupported modifier is used then
                {fname} is returned.
                When {fname} is empty then with {mods} ":h" returns ".", so
                that :cd can be used with it.  This is different from
                expand('%:h') without a buffer name, which returns an empty
                Note: Environment variables don't work in {fname}, use
                expand() first then.

                Can also be used as a method:

                Return type: String

foldclosed({lnum})                                      foldclosed()
                The result is a Number.  If the line {lnum} is in a closed
                fold, the result is the number of the first line in that fold.
                If the line {lnum} is not in a closed fold, -1 is returned.
                {lnum} is used like with getline().  Thus "." is the current
                line, "'m" mark m, etc.

                Can also be used as a method:

                Return type: Number

foldclosedend({lnum})                                   foldclosedend()
                The result is a Number.  If the line {lnum} is in a closed
                fold, the result is the number of the last line in that fold.
                If the line {lnum} is not in a closed fold, -1 is returned.
                {lnum} is used like with getline().  Thus "." is the current
                line, "'m" mark m, etc.

                Can also be used as a method:

                Return type: Number

foldlevel({lnum})                                       foldlevel()
                The result is a Number, which is the foldlevel of line {lnum}
                in the current buffer.  For nested folds the deepest level is
                returned.  If there is no fold at line {lnum}, zero is
                returned.  It doesn't matter if the folds are open or closed.
                When used while updating folds (from 'foldexpr') -1 is
                returned for lines where folds are still to be updated and the
                foldlevel is unknown.  As a special case the level of the
                previous line is usually available.
                {lnum} is used like with getline().  Thus "." is the current
                line, "'m" mark m, etc.

                Can also be used as a method:

                Return type: Number

foldtext()      Returns a String, to be displayed for a closed fold.  This is
                the default function used for the 'foldtext' option and should
                only be called from evaluating 'foldtext'.  It uses the
                v:foldstartv:foldend and v:folddashes variables.
                The returned string looks like this:
                        +-- 45 lines: abcdef
                The number of leading dashes depends on the foldlevel.  The
                "45" is the number of lines in the fold.  "abcdef" is the text
                in the first non-blank line of the fold.  Leading white space,
                "//" or "/*" and the text from the 'foldmarker' and
                'commentstring' options is removed.
                When used to draw the actual foldtext, the rest of the line
                will be filled with the fold char from the 'fillchars'
                Returns an empty string when there is no fold.

                Return type: String
                {not available when compiled without the +folding feature}

foldtextresult({lnum})                                  foldtextresult()
                Returns the text that is displayed for the closed fold at line
                {lnum}.  Evaluates 'foldtext' in the appropriate context.
                When there is no closed fold at {lnum} an empty string is
                {lnum} is used like with getline().  Thus "." is the current
                line, "'m" mark m, etc.
                Useful when exporting folded text, e.g., to HTML.
                {not available when compiled without the +folding feature}

                Can also be used as a method:

                Return type: String

foreach({expr1}{expr2})                                       foreach()
                {expr1} must be a ListStringBlob or Dictionary.
                For each item in {expr1} execute {expr2}{expr1} is not
                modified; its values may be, as with :lockvar 1. E741
                See map() and filter() to modify {expr1}.

                {expr2} must be a string or Funcref.

                If {expr2} is a string, inside {expr2} v:val has the value
                of the current item.  For a Dictionary v:key has the key
                of the current item and for a List v:key has the index of
                the current item.  For a Blob v:key has the index of the
                current byte. For a String v:key has the index of the
                current character.
                        call foreach(mylist, 'used[v:val] = true')
                This records the items that are in the {expr1} list.

                Note that {expr2} is the result of expression and is then used
                as a command.  Often it is good to use a literal-string to
                avoid having to double backslashes.

                If {expr2} is a Funcref it must take two arguments:
                        1. the key or the index of the current item.
                        2. the value of the current item.
                With a legacy script lambda you don't get an error if it only
                accepts one argument, but with a Vim9 lambda you get "E1106:
                One argument too many", the number of arguments must match.
                If the function returns a value, it is ignored.

                Returns {expr1} in all cases.
                When an error is encountered while executing {expr2} no
                further items in {expr1} are processed.
                When {expr2} is a Funcref errors inside a function are ignored,
                unless it was defined with the "abort" flag.

                Can also be used as a method:

                Return type: StringBlob list<{type}> or dict<{type}>
                depending on {expr1}

foreground()    Move the Vim window to the foreground.  Useful when sent from
                a client to a Vim server. remote_send()
                On Win32 systems this might not work, the OS does not always
                allow a window to bring itself to the foreground.  Use
                remote_foreground() instead.

                Return type: Number
                {only in the Win32, Motif and GTK GUI versions and the
                Win32 console version}

fullcommand({name} [, {vim9}])                          fullcommand()
                Get the full command name from a short abbreviated command
                name; see 20.2 for details on command abbreviations.

                The string argument {name} may start with a : and can
                include a [range], these are skipped and not returned.
                Returns an empty string if a command doesn't exist, if it's
                ambiguous (for user-defined commands) or cannot be shortened
                this way. vim9-no-shorten

                Without the {vim9} argument uses the current script version.
                If {vim9} is present and FALSE then legacy script rules are
                used.  When {vim9} is present and TRUE then Vim9 rules are
                used, e.g. "en" is not a short form of "endif".

                For example fullcommand('s')fullcommand('sub'),
                fullcommand(':%substitute') all return "substitute".

                Can also be used as a method:

                Return type: String

funcref({name} [, {arglist}] [, {dict}])                funcref()
                Just like function(), but the returned Funcref will lookup
                the function by reference, not by name.  This matters when the
                function {name} is redefined later.

                Unlike function(){name} must be an existing user function.
                It only works for an autoloaded function if it has already
                been loaded (to avoid mistakenly loading the autoload script
                when only intending to use the function name, use function()
                instead). {name} cannot be a builtin function.
                Returns 0 on error.

                Can also be used as a method:

                Return type: func(...): any or Number on error

                                function() partial E700 E923
function({name} [, {arglist}] [, {dict}])
                Return a Funcref variable that refers to function {name}.
                {name} can be the name of a user defined function or an
                internal function.

                {name} can also be a Funcref or a partial.  When it is a
                partial the dict stored in it will be used and the {dict}
                argument is not allowed. E.g.:
                        let FuncWithArg = function(dict.Func, [arg])
                        let Broken = function(dict.Func, [arg], dict)

                When using the Funcref the function will be found by {name},
                also when it was redefined later.  Use funcref() to keep the
                same function.

                When {arglist} or {dict} is present this creates a partial.
                That means the argument list and/or the dictionary is stored in
                the Funcref and will be used when the Funcref is called.

                The arguments are passed to the function in front of other
                arguments, but after any argument from method.  Example:
                        func Callback(arg1, arg2, name)
                        let Partial = function('Callback', ['one', 'two'])
                        call Partial('name')
                Invokes the function as with:
                        call Callback('one', 'two', 'name')

                With a method:
                        func Callback(one, two, three)
                        let Partial = function('Callback', ['two'])
                        eval 'one'->Partial('three')
                Invokes the function as with:
                        call Callback('one', 'two', 'three')

                The function() call can be nested to add more arguments to the
                Funcref.  The extra arguments are appended to the list of
                arguments.  Example:
                        func Callback(arg1, arg2, name)
                        let Func = function('Callback', ['one'])
                        let Func2 = function(Func, ['two'])
                        call Func2('name')
                Invokes the function as with:
                        call Callback('one', 'two', 'name')

                The Dictionary is only useful when calling a "dict" function.
                In that case the {dict} is passed in as "self". Example:
                        function Callback() dict
                           echo "called for " ..
                        let context = {"name": "example"}
                        let Func = function('Callback', context)
                        call Func()     " will echo: called for example
                The use of function() is not needed when there are no extra
                arguments, these two are equivalent, if Callback() is defined
                as context.Callback():
                        let Func = function('Callback', context)
                        let Func = context.Callback

                The argument list and the Dictionary can be combined:
                        function Callback(arg1, count) dict
                        let context = {"name": "example"}
                        let Func = function('Callback', ['one'], context)
                        call Func(500)
                Invokes the function as with:
                        call context.Callback('one', 500)

                Returns 0 on error.

                Can also be used as a method:

                Return type: func(...): any or Number on error

garbagecollect([{atexit}])                              garbagecollect()
                Cleanup unused ListsDictionariesChannels and Jobs
                that have circular references.

                There is hardly ever a need to invoke this function, as it is
                automatically done when Vim runs out of memory or is waiting
                for the user to press a key after 'updatetime'.  Items without
                circular references are always freed when they become unused.
                This is useful if you have deleted a very big List and/or
                Dictionary with circular references in a script that runs
                for a long time.

                When the optional {atexit} argument is one, garbage
                collection will also be done when exiting Vim, if it wasn't
                done before.  This is useful when checking for memory leaks.

                The garbage collection is not done immediately but only when
                it's safe to perform.  This is when waiting for the user to
                type a character.  To force garbage collection immediately use

                Return type: String

get({list}{idx} [, {default}])                        get()
                Get item {idx} from List {list}.  When this item is not
                available return {default}.  Return zero when {default} is
                Preferably used as a method:

                Return type: any, depending on {list}

get({blob}{idx} [, {default}])
                Get byte {idx} from Blob {blob}.  When this byte is not
                available return {default}.  Return -1 when {default} is
                Preferably used as a method:

                Return type: Number

get({dict}{key} [, {default}])
                Get item with key {key} from Dictionary {dict}.  When this
                item is not available return {default}.  Return zero when
                {default} is omitted.  Useful example:
                        let val = get(g:, 'var_name', 'default')
                This gets the value of g:var_name if it exists, and uses
                'default' when it does not exist.
                Preferably used as a method:

                Return type: any, depending on {dict}

                Get item {what} from Funcref {func}.  Possible values for
                {what} are:
                        "name"  The function name
                        "func"  The function
                        "dict"  The dictionary
                        "args"  The list with arguments
                Returns zero on error.
                Preferably used as a method:

                Return type: any, depending on {func}

                Get information about buffers as a List of Dictionaries.

                Without an argument information about all the buffers is

                When the argument is a Dictionary only the buffers matching
                the specified criteria are returned.  The following keys can
                be specified in {dict}:
                        buflisted       include only listed buffers.
                        bufloaded       include only loaded buffers.
                        bufmodified     include only modified buffers.

                Otherwise, {buf} specifies a particular buffer to return
                information for.  For the use of {buf}, see bufname()
                above.  If the buffer is found the returned List has one item.
                Otherwise the result is an empty list.

                Each returned List item is a dictionary with the following
                        bufnr           Buffer number.
                        changed         TRUE if the buffer is modified.
                        changedtick     Number of changes made to the buffer.
                        command         TRUE if the buffer belongs to the
                                        command-line window cmdwin.
                        hidden          TRUE if the buffer is hidden.
                        lastused        Timestamp in seconds, like
                                        localtime(), when the buffer was
                                        last used.
                                        {only with the +viminfo feature}
                        listed          TRUE if the buffer is listed.
                        lnum            Line number used for the buffer when
                                        opened in the current window.
                                        Only valid if the buffer has been
                                        displayed in the window in the past.
                                        If you want the line number of the
                                        last known cursor position in a given
                                        window, use line():
                                                :echo line('.', {winid})

                        linecount       Number of lines in the buffer (only
                                        valid when loaded)
                        loaded          TRUE if the buffer is loaded.
                        name            Full path to the file in the buffer.
                        signs           List of signs placed in the buffer.
                                        Each list item is a dictionary with
                                        the following fields:
                                            id    sign identifier
                                            lnum  line number
                                            name  sign name
                        variables       A reference to the dictionary with
                                        buffer-local variables.
                        windows         List of window-IDs that display this
                        popups          List of popup window-IDs that
                                        display this buffer

                        for buf in getbufinfo()
                        for buf in getbufinfo({'buflisted':1})
                            if buf.changed

                To get buffer-local options use:
                        getbufvar({bufnr}, '&option_name')

                Can also be used as a method:

                Return type: list<dict<any>>

getbufline({buf}{lnum} [, {end}])
                Return a List with the lines starting from {lnum} to {end}
                (inclusive) in the buffer {buf}.  If {end} is omitted, a
                List with only the line {lnum} is returned.  See
                getbufoneline() for only getting the line.

                For the use of {buf}, see bufname() above.

                For {lnum} and {end} "$" can be used for the last line of the
                buffer.  Otherwise a number must be used.

                When {lnum} is smaller than 1 or bigger than the number of
                lines in the buffer, an empty List is returned.

                When {end} is greater than the number of lines in the buffer,
                it is treated as {end} is set to the number of lines in the
                buffer.  When {end} is before {lnum} an empty List is

                This function works only for loaded buffers.  For unloaded and
                non-existing buffers, an empty List is returned.

                        :let lines = getbufline(bufnr("myfile"), 1, "$")

                Can also be used as a method:

                Return type: list<string>

                Just like getbufline() but only get one line and return it
                as a string.

                Return type: String

getbufvar({buf}{varname} [, {def}])                           getbufvar()
                The result is the value of option or local buffer variable
                {varname} in buffer {buf}.  Note that the name without "b:"
                must be used.
                The {varname} argument is a string.
                When {varname} is empty returns a Dictionary with all the
                buffer-local variables.
                When {varname} is equal to "&" returns a Dictionary with all
                the buffer-local options.
                Otherwise, when {varname} starts with "&" returns the value of
                a buffer-local option.
                This also works for a global or buffer-local option, but it
                doesn't work for a global variable, window-local variable or
                window-local option.
                For the use of {buf}, see bufname() above.
                When the buffer or variable doesn't exist {def} or an empty
                string is returned, there is no error message.
                        :let bufmodified = getbufvar(1, "&mod")
                        :echo "todo myvar = " .. getbufvar("todo", "myvar")

                Can also be used as a method:

                Return type: any, depending on {varname}

getcellwidths()                                         getcellwidths()
                Returns a List of cell widths of character ranges overridden
                by setcellwidths().  The format is equal to the argument of
                setcellwidths().  If no character ranges have their cell
                widths overridden, an empty List is returned.

                Return type: list<any>

getchangelist([{buf}])                                  getchangelist()
                Returns the changelist for the buffer {buf}. For the use
                of {buf}, see bufname() above. If buffer {buf} doesn't
                exist, an empty list is returned.

                The returned list contains two entries: a list with the change
                locations and the current position in the list.  Each
                entry in the change list is a dictionary with the following
                        col             column number
                        coladd          column offset for 'virtualedit'
                        lnum            line number
                If buffer {buf} is the current buffer, then the current
                position refers to the position in the list. For other
                buffers, it is set to the length of the list.

                Can also be used as a method:

                Return type: list<any>

getchar([{expr}])                                       getchar()
                Get a single character from the user or input stream.
                If {expr} is omitted, wait until a character is available.
                If {expr} is 0, only get a character when one is available.
                        Return zero otherwise.
                If {expr} is 1, only check if a character is available, it is
                        not consumed.  Return zero if no character available.
                If you prefer always getting a string use getcharstr().

                Without {expr} and when {expr} is 0 a whole character or
                special key is returned.  If it is a single character, the
                result is a Number.  Use nr2char() to convert it to a String.
                Otherwise a String is returned with the encoded character.
                For a special key it's a String with a sequence of bytes
                starting with 0x80 (decimal: 128).  This is the same value as
                the String "\<Key>", e.g., "\<Left>".  The returned value is
                also a String when a modifier (shift, control, alt) was used
                that is not included in the character.

                When {expr} is 0 and Esc is typed, there will be a short delay
                while Vim waits to see if this is the start of an escape

                When {expr} is 1 only the first byte is returned.  For a
                one-byte character it is the character itself as a number.
                Use nr2char() to convert it to a String.

                Use getcharmod() to obtain any additional modifiers.

                When the user clicks a mouse button, the mouse event will be
                returned.  The position can then be found in v:mouse_col,
                v:mouse_lnumv:mouse_winid and v:mouse_win.
                getmousepos() can also be used.  Mouse move events will be
                This example positions the mouse as it would normally happen:
                        let c = getchar()
                        if c == "\<LeftMouse>" && v:mouse_win > 0
                          exe v:mouse_win .. "wincmd w"
                          exe v:mouse_lnum
                          exe "normal " .. v:mouse_col .. "|"

                When using bracketed paste only the first character is
                returned, the rest of the pasted text is dropped.

                There is no prompt, you will somehow have to make clear to the
                user that a character has to be typed.  The screen is not
                redrawn, e.g. when resizing the window.  When using a popup
                window it should work better with a popup-filter.

                There is no mapping for the character.
                Key codes are replaced, thus when the user presses the <Del>
                key you get the code for the <Del> key, not the raw character
                sequence.  Examples:
                        getchar() == "\<Del>"
                        getchar() == "\<S-Left>"
                This example redefines "f" to ignore case:
                        :nmap f :call FindChar()<CR>
                        :function FindChar()
                        :  let c = nr2char(getchar())
                        :  while col('.') < col('$') - 1
                        :    normal l
                        :    if getline('.')[col('.') - 1] ==? c
                        :      break
                        :    endif
                        :  endwhile

                You may also receive synthetic characters, such as
                <CursorHold>. Often you will want to ignore this and get
                another character:
                        :function GetKey()
                        :  let c = getchar()
                        :  while c == "\<CursorHold>"
                        :    let c = getchar()
                        :  endwhile
                        :  return c

                Return type: Number or String

getcharmod()                                            getcharmod()
                The result is a Number which is the state of the modifiers for
                the last obtained character with getchar() or in another way.
                These values are added together:
                        2       shift
                        4       control
                        8       alt (meta)
                        16      meta (when it's different from ALT)
                        32      mouse double click
                        64      mouse triple click
                        96      mouse quadruple click (== 32 + 64)
                        128     command (Mac) or super (GTK)
                Only the modifiers that have not been included in the
                character itself are obtained.  Thus Shift-a results in "A"
                without a modifier.  Returns 0 if no modifiers are used.

                Return type: Number

getcharpos({expr})                                      getcharpos()
                Get the position for String {expr}. Same as getpos() but the
                column number in the returned List is a character index
                instead of a byte index.
                If getpos() returns a very large column number, equal to
                v:maxcol, then getcharpos() will return the character index
                of the last character.

                With the cursor on 'μ„Έ' in line 5 with text "μ—¬λ³΄μ„Έμš”":
                        getcharpos('.')         returns [0, 5, 3, 0]
                        getpos('.')             returns [0, 5, 7, 0]

                Can also be used as a method:

                Return type: list<number>

getcharsearch()                                         getcharsearch()
                Return the current character search information as a {dict}
                with the following entries:

                    char        character previously used for a character
                                search (tfT, or F); empty string
                                if no character search has been performed
                    forward     direction of character search; 1 for forward,
                                0 for backward
                    until       type of character search; 1 for a t or T
                                character search, 0 for an f or F
                                character search

                This can be useful to always have ; and , search
                forward/backward regardless of the direction of the previous
                character search:
                        :nnoremap <expr> ; getcharsearch().forward ? ';' : ','
                        :nnoremap <expr> , getcharsearch().forward ? ',' : ';'
                Also see setcharsearch().

                Return type: dict<any>

getcharstr([{expr}])                                    getcharstr()
                Get a single character from the user or input stream as a
                If {expr} is omitted, wait until a character is available.
                If {expr} is 0 or false, only get a character when one is
                        available.  Return an empty string otherwise.
                If {expr} is 1 or true, only check if a character is
                        available, it is not consumed.  Return an empty string
                        if no character is available.
                Otherwise this works like getchar(), except that a number
                result is converted to a string.

                Return type: String

getcmdcompltype()                                       getcmdcompltype()
                Return the type of the current command-line completion.
                Only works when the command line is being edited, thus
                requires use of c_CTRL-\_e or c_CTRL-R_=.
                See :command-completion for the return string.
                Also see getcmdtype()setcmdpos()getcmdline() and
                Returns an empty string when completion is not defined.

                Return type: String

getcmdline()                                            getcmdline()
                Return the current command-line.  Only works when the command
                line is being edited, thus requires use of c_CTRL-\_e or
                        :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
                Also see getcmdtype()getcmdpos()setcmdpos() and
                Returns an empty string when entering a password or using

                Return type: String

getcmdpos()                                             getcmdpos()
                Return the position of the cursor in the command line as a
                byte count.  The first column is 1.
                Only works when editing the command line, thus requires use of
                c_CTRL-\_e or c_CTRL-R_= or an expression mapping.
                Returns 0 otherwise.
                Also see getcmdtype()setcmdpos()getcmdline() and

                Return type: Number

getcmdscreenpos()                                       getcmdscreenpos()
                Return the screen position of the cursor in the command line
                as a byte count.  The first column is 1.
                Instead of getcmdpos(), it adds the prompt position.
                Only works when editing the command line, thus requires use of
                c_CTRL-\_e or c_CTRL-R_= or an expression mapping.
                Returns 0 otherwise.
                Also see getcmdpos()setcmdpos()getcmdline() and

                Return type: Number

getcmdtype()                                            getcmdtype()
                Return the current command-line type. Possible return values
                    :   normal Ex command
                    >   debug mode command debug-mode
                    /   forward search command
                    ?   backward search command
                    @   input() command
                    -   :insert or :append command
                    =   i_CTRL-R_=
                Only works when editing the command line, thus requires use of
                c_CTRL-\_e or c_CTRL-R_= or an expression mapping.
                Returns an empty string otherwise.
                Also see getcmdpos()setcmdpos() and getcmdline().

                Return type: String

getcmdwintype()                                         getcmdwintype()
                Return the current command-line-window type. Possible return
                values are the same as getcmdtype(). Returns an empty string
                when not in the command-line window.

                Return type: String

getcompletion({pat}{type} [, {filtered}])             getcompletion()
                Return a list of command-line completion matches. The String
                {type} argument specifies what for.  The following completion
                types are supported:

                arglist         file names in argument list
                augroup         autocmd groups
                buffer          buffer names
                behave          :behave suboptions
                breakpoint      :breakadd and :breakdel suboptions
                color           color schemes
                command         Ex command
                cmdline         cmdline-completion result
                compiler        compilers
                cscope          :cscope suboptions
                custom,{func}   custom completion, defined via {func}
                customlist,{func} custom completion, defined via {func}
                diff_buffer     :diffget and :diffput completion
                dir             directory names
                environment     environment variable names
                event           autocommand events
                expression      Vim expression
                file            file and directory names
                file_in_path    file and directory names in 'path'
                filetype        filetype names 'filetype'
                function        function name
                help            help subjects
                highlight       highlight groups
                history         :history suboptions
                keymap          keyboard mappings
                locale          locale names (as output of locale -a)
                mapclear        buffer argument
                mapping         mapping name
                menu            menus
                messages        :messages suboptions
                option          options
                packadd         optional package pack-add names
                runtime         :runtime completion
                scriptnames     sourced script names :scriptnames
                shellcmd        Shell command
                sign            :sign suboptions
                syntax          syntax file names 'syntax'
                syntime         :syntime suboptions
                tag             tags
                tag_listfiles   tags, file names
                user            user names
                var             user variables

                If {pat} is an empty string, then all the matches are
                returned.  Otherwise only items matching {pat} are returned.
                See wildcards for the use of special characters in {pat}.

                If the optional {filtered} flag is set to 1, then 'wildignore'
                is applied to filter the results.  Otherwise all the matches
                are returned. The 'wildignorecase' option always applies.

                If the 'wildoptions' option contains 'fuzzy', then fuzzy
                matching is used to get the completion matches. Otherwise
                regular expression matching is used.  Thus this function
                follows the user preference, what happens on the command line.
                If you do not want this you can make 'wildoptions' empty
                before calling getcompletion() and restore it afterwards.

                If {type} is "cmdline", then the cmdline-completion result is
                returned.  For example, to complete the possible values after
                a ":call" command:
                        echo getcompletion('call ', 'cmdline')

                If there are no matches, an empty list is returned.  An
                invalid value for {type} produces an error.

                Can also be used as a method:

                Return type: list<string>

                Get the position of the cursor.  This is like getpos('.'), but
                includes an extra "curswant" item in the list:
                    [0, lnum, col, off, curswant]
                The "curswant" number is the preferred column when moving the
                cursor vertically.  After $ command it will be a very large
                number equal to v:maxcol.  Also see getcursorcharpos() and
                The first "bufnum" item is always zero. The byte position of
                the cursor is returned in 'col'. To get the character
                position, use getcursorcharpos().

                The optional {winid} argument can specify the window.  It can
                be the window number or the window-ID.  The last known
                cursor position is returned, this may be invalid for the
                current value of the buffer if it is not the current window.
                If {winid} is invalid a list with zeroes is returned.

                This can be used to save and restore the cursor position:
                        let save_cursor = getcurpos()
                        call setpos('.', save_cursor)
                Note that this only works within the window.  See
                winrestview() for restoring more state.

                Can also be used as a method:

                Return type: list<number>

getcursorcharpos([{winid}])                     getcursorcharpos()
                Same as getcurpos() but the column number in the returned
                List is a character index instead of a byte index.

                With the cursor on '보' in line 3 with text "μ—¬λ³΄μ„Έμš”":
                        getcursorcharpos()      returns [0, 3, 2, 0, 3]
                        getcurpos()             returns [0, 3, 4, 0, 3]

                Can also be used as a method:

                Return type: list<number>

getcwd([{winnr} [, {tabnr}]])                           getcwd()
                The result is a String, which is the name of the current
                working directory.  'autochdir' is ignored.

                With {winnr} return the local current directory of this window
                in the current tab page.  {winnr} can be the window number or
                the window-ID.
                If {winnr} is -1 return the name of the global working
                directory.  See also haslocaldir().

                With {winnr} and {tabnr} return the local current directory of
                the window in the specified tab page. If {winnr} is -1 return
                the working directory of the tabpage.
                If {winnr} is zero use the current window, if {tabnr} is zero
                use the current tabpage.
                Without any arguments, return the actual working directory of
                the current window.
                Return an empty string if the arguments are invalid.

                        " Get the working directory of the current window
                        :echo getcwd()
                        :echo getcwd(0)
                        :echo getcwd(0, 0)
                        " Get the working directory of window 3 in tabpage 2
                        :echo getcwd(3, 2)
                        " Get the global working directory
                        :echo getcwd(-1)
                        " Get the working directory of tabpage 3
                        :echo getcwd(-1, 3)
                        " Get the working directory of current tabpage
                        :echo getcwd(-1, 0)

                Can also be used as a method:

                Return type: String

getenv({name})                                          getenv()
                Return the value of environment variable {name}.  The {name}
                argument is a string, without a leading '$'.  Example:
                        myHome = getenv('HOME')

                When the variable does not exist v:null is returned.  That
                is different from a variable set to an empty string, although
                some systems interpret the empty value as the variable being
                deleted.  See also expr-env.

                Can also be used as a method:

                Return type: String or Number

getfontname([{name}])                                   getfontname()
                Without an argument returns the name of the normal font being
                used.  Like what is used for the Normal highlight group
                With an argument a check is done whether String {name} is a
                valid font name.  If not then an empty string is returned.
                Otherwise the actual font name is returned, or {name} if the
                GUI does not support obtaining the real name.
                Only works when the GUI is running, thus not in your vimrc or
                gvimrc file.  Use the GUIEnter autocommand to use this
                function just after the GUI has started.
                Note that the GTK GUI accepts any font name, thus checking for
                a valid name does not work.

                Return type: String

getfperm({fname})                                       getfperm()
                The result is a String, which is the read, write, and execute
                permissions of the given file {fname}.
                If {fname} does not exist or its directory cannot be read, an
                empty string is returned.
                The result is of the form "rwxrwxrwx", where each group of
                "rwx" flags represent, in turn, the permissions of the owner
                of the file, the group the file belongs to, and other users.
                If a user does not have a given permission the flag for this
                is replaced with the string "-".  Examples:
                        :echo getfperm("/etc/passwd")
                        :echo getfperm(expand("~/.vimrc"))
                This will hopefully (from a security point of view) display
                the string "rw-r--r--" or even "rw-------".

                Can also be used as a method:

                Return type: String

                For setting permissions use setfperm().

getfsize({fname})                                       getfsize()
                The result is a Number, which is the size in bytes of the
                given file {fname}.
                If {fname} is a directory, 0 is returned.
                If the file {fname} can't be found, -1 is returned.
                If the size of {fname} is too big to fit in a Number then -2
                is returned.

                Can also be used as a method:

                Return type: Number

getftime({fname})                                       getftime()
                The result is a Number, which is the last modification time of
                the given file {fname}.  The value is measured as seconds
                since 1st Jan 1970, and may be passed to strftime().  See also
                localtime() and strftime().
                If the file {fname} can't be found -1 is returned.

                Can also be used as a method:

                Return type: Number

getftype({fname})                                       getftype()
                The result is a String, which is a description of the kind of
                file of the given file {fname}.
                If {fname} does not exist an empty string is returned.
                Here is a table over different kinds of files and their
                        Normal file             "file"
                        Directory               "dir"
                        Symbolic link           "link"
                        Block device            "bdev"
                        Character device        "cdev"
                        Socket                  "socket"
                        FIFO                    "fifo"
                        All other               "other"
                Note that a type such as "link" will only be returned on
                systems that support it.  On some systems only "dir" and
                "file" are returned.  On MS-Windows a symbolic link to a
                directory returns "dir" instead of "link".

                Can also be used as a method:

                Return type: String

getimstatus()                                           getimstatus()
                The result is a Number, which is TRUE when the IME status is
                active and FALSE otherwise.
                See 'imstatusfunc'.

                Return type: Number

getjumplist([{winnr} [, {tabnr}]])                      getjumplist()
                Returns the jumplist for the specified window.

                Without arguments use the current window.
                With {winnr} only use this window in the current tab page.
                {winnr} can also be a window-ID.
                With {winnr} and {tabnr} use the window in the specified tab
                page.  If {winnr} or {tabnr} is invalid, an empty list is

                The returned list contains two entries: a list with the jump
                locations and the last used jump position number in the list.
                Each entry in the jump location list is a dictionary with
                the following entries:
                        bufnr           buffer number
                        col             column number
                        coladd          column offset for 'virtualedit'
                        filename        filename if available
                        lnum            line number

                Can also be used as a method:

                Return type: list<any>

getline({lnum} [, {end}])
                Without {end} the result is a String, which is line {lnum}
                from the current buffer.  Example:
                When {lnum} is a String that doesn't start with a
                digit, line() is called to translate the String into a Number.
                To get the line under the cursor:
                When {lnum} is a number smaller than 1 or bigger than the
                number of lines in the buffer, an empty string is returned.

                When {end} is given the result is a List where each item is
                a line from the current buffer in the range {lnum} to {end},
                including line {end}.
                {end} is used in the same way as {lnum}.
                Non-existing lines are silently omitted.
                When {end} is before {lnum} an empty List is returned.
                        :let start = line('.')
                        :let end = search("^$") - 1
                        :let lines = getline(start, end)

                Can also be used as a method:

                Return type: list<string> or String depending on {end}

                To get lines from another buffer see getbufline() and

getloclist({nr} [, {what}])                             getloclist()
                Returns a List with all the entries in the location list for
                window {nr}.  {nr} can be the window number or the window-ID.
                When {nr} is zero the current window is used.

                For a location list window, the displayed location list is
                returned.  For an invalid window number {nr}, an empty list is
                returned. Otherwise, same as getqflist().

                If the optional {what} dictionary argument is supplied, then
                returns the items listed in {what} as a dictionary. Refer to
                getqflist() for the supported items in {what}.

                In addition to the items supported by getqflist() in {what},
                the following item is supported by getloclist():

                        filewinid       id of the window used to display files
                                        from the location list. This field is
                                        applicable only when called from a
                                        location list window. See
                                        location-list-file-window for more

                Returns a Dictionary with default values if there is no
                location list for the window {nr}.
                Returns an empty Dictionary if window {nr} does not exist.

                Examples (See also getqflist-examples):
                        :echo getloclist(3, {'all': 0})
                        :echo getloclist(5, {'filewinid': 0})

                Return type: list<dict<any>> or list<any>

getmarklist([{buf}])                                    getmarklist()
                Without the {buf} argument returns a List with information
                about all the global marks. mark

                If the optional {buf} argument is specified, returns the
                local marks defined in buffer {buf}.  For the use of {buf},
                see bufname().  If {buf} is invalid, an empty list is

                Each item in the returned List is a Dict with the following:
                    mark   name of the mark prefixed by "'"
                    pos    a List with the position of the mark:
                                [bufnum, lnum, col, off]
                           Refer to getpos() for more information.
                    file   file name

                Refer to getpos() for getting information about a specific

                Can also be used as a method:

                Return type: list<dict<any>> or list<any>

getmatches([{win}])                                     getmatches()
                Returns a List with all matches previously defined for the
                current window by matchadd() and the :match commands.
                getmatches() is useful in combination with setmatches(),
                as setmatches() can restore a list of matches saved by
                If {win} is specified, use the window with this number or
                window ID instead of the current window.  If {win} is invalid,
                an empty list is returned.
                        :echo getmatches()
                        [{'group': 'MyGroup1', 'pattern': 'TODO',
                        'priority': 10, 'id': 1}, {'group': 'MyGroup2',
                        'pattern': 'FIXME', 'priority': 10, 'id': 2}]
                        :let m = getmatches()
                        :call clearmatches()
                        :echo getmatches()
                        :call setmatches(m)
                        :echo getmatches()
                        [{'group': 'MyGroup1', 'pattern': 'TODO',
                        'priority': 10, 'id': 1}, {'group': 'MyGroup2',
                        'pattern': 'FIXME', 'priority': 10, 'id': 2}]
                        :unlet m

                Return type: list<dict<any>> or list<any>

getmousepos()                                           getmousepos()
                Returns a Dictionary with the last known position of the
                mouse.  This can be used in a mapping for a mouse click or in
                a filter of a popup window.  The items are:
                        screenrow       screen row
                        screencol       screen column
                        winid           Window ID of the click
                        winrow          row inside "winid"
                        wincol          column inside "winid"
                        line            text line inside "winid"
                        column          text column inside "winid"
                        coladd          offset (in screen columns) from the
                                        start of the clicked char
                All numbers are 1-based.

                If not over a window, e.g. when in the command line, then only
                "screenrow" and "screencol" are valid, the others are zero.

                When on the status line below a window or the vertical
                separator right of a window, the "line" and "column" values
                are zero.

                When the position is after the text then "column" is the
                length of the text in bytes plus one.

                If the mouse is over a popup window then that window is used.

                When using getchar() the Vim variables v:mouse_lnum,
                v:mouse_col and v:mouse_winid also provide these values.

                Return type: dict<number>

getmouseshape()                                         getmouseshape()
                Returns the name of the currently showing mouse pointer.
                When the +mouseshape feature is not supported or the shape
                is unknown an empty string is returned.
                This function is mainly intended for testing.

                Return type: String

getpid()                                                        getpid()
                Return a Number which is the process ID of the Vim process.
                On Unix and MS-Windows this is a unique number, until Vim

                Return type: Number

getpos({expr})                                                  getpos()
                Get the position for String {expr}.
                The accepted values for {expr} are:             E1209
                    .       The cursor position.
                    $       The last line in the current buffer.
                    'x      Position of mark x (if the mark is not set, 0 is
                            returned for all values).
                    w0      First line visible in current window (one if the
                            display isn't updated, e.g. in silent Ex mode).
                    w$      Last line visible in current window (this is one
                            less than "w0" if no lines are visible).
                    v       When not in Visual mode, returns the cursor
                            position.  In Visual mode, returns the other end
                            of the Visual area.  A good way to think about
                            this is that in Visual mode "v" and "." complement
                            each other.  While "." refers to the cursor
                            position, "v" refers to where v_o would move the
                            cursor.  As a result, you can use "v" and "."
                            together to work on all of a selection in
                            characterwise Visual mode.  If the cursor is at
                            the end of a characterwise Visual area, "v" refers
                            to the start of the same Visual area.  And if the
                            cursor is at the start of a characterwise Visual
                            area, "v" refers to the end of the same Visual
                            area.  "v" differs from '< and '> in that it's
                            updated right away.
                Note that a mark in another file can be used.  The line number
                then applies to another buffer.

                The result is a List with four numbers:
                    [bufnum, lnum, col, off]
                "bufnum" is zero, unless a mark like '0 or 'A is used, then it
                is the buffer number of the mark.
                "lnum" and "col" are the position in the buffer.  The first
                column is 1.
                The "off" number is zero, unless 'virtualedit' is used.  Then
                it is the offset in screen columns from the start of the
                character.  E.g., a position within a <Tab> or after the last

                For getting the cursor position see getcurpos().
                The column number in the returned List is the byte position
                within the line. To get the character position in the line,
                use getcharpos().

                Note that for '< and '> Visual mode matters: when it is "V"
                (visual line mode) the column of '< is zero and the column of
                '> is a large number equal to v:maxcol.
                A very large column number equal to v:maxcol can be returned,
                in which case it means "after the end of the line".
                If {expr} is invalid, returns a list with all zeros.

                This can be used to save and restore the position of a mark:
                        let save_a_mark = getpos("'a")
                        call setpos("'a", save_a_mark)

                Also see getcharpos()getcurpos() and setpos().

                Can also be used as a method:

                Return type: list<number>

getqflist([{what}])                                     getqflist()
                Returns a List with all the current quickfix errors.  Each
                list item is a dictionary with these entries:
                        bufnr   number of buffer that has the file name, use
                                bufname() to get the name
                        module  module name
                        lnum    line number in the buffer (first line is 1)
                                end of line number if the item is multiline
                        col     column number (first column is 1)
                        end_col end of column number if the item has range
                        vcol    TRUE: "col" is visual column
                                FALSE: "col" is byte index
                        nr      error number
                        pattern search pattern used to locate the error
                        text    description of the error
                        type    type of the error, 'E', '1', etc.
                        valid   TRUE: recognized error message
                                custom data associated with the item, can be
                                any type.

                When there is no error list or it's empty, an empty list is
                returned. Quickfix list entries with a non-existing buffer
                number are returned with "bufnr" set to zero (Note: some
                functions accept buffer number zero for the alternate buffer,
                you may need to explicitly check for zero).

                Useful application: Find pattern matches in multiple files and
                do something with them:
                        :vimgrep /theword/jg *.c
                        :for d in getqflist()
                        :   echo bufname(d.bufnr) ':' d.lnum '=' d.text

                If the optional {what} dictionary argument is supplied, then
                returns only the items listed in {what} as a dictionary. The
                following string items are supported in {what}:
                        changedtick     get the total number of changes made
                                        to the list quickfix-changedtick
                        context get the quickfix-context
                        efm     errorformat to use when parsing "lines". If
                                not present, then the 'errorformat' option
                                value is used.
                        id      get information for the quickfix list with
                                quickfix-ID; zero means the id for the
                                current list or the list specified by "nr"
                        idx     get information for the quickfix entry at this
                                index in the list specified by 'id' or 'nr'.
                                If set to zero, then uses the current entry.
                                See quickfix-index
                        items   quickfix list entries
                        lines   parse a list of lines using 'efm' and return
                                the resulting entries.  Only a List type is
                                accepted.  The current quickfix list is not
                                modified. See quickfix-parse.
                        nr      get information for this quickfix list; zero
                                means the current quickfix list and "$" means
                                the last quickfix list
                        qfbufnr number of the buffer displayed in the quickfix
                                window. Returns 0 if the quickfix buffer is
                                not present. See quickfix-buffer.
                        size    number of entries in the quickfix list
                        title   get the list title quickfix-title
                        winid   get the quickfix window-ID
                        all     all of the above quickfix properties
                Non-string items in {what} are ignored. To get the value of a
                particular item, set it to zero.
                If "nr" is not present then the current quickfix list is used.
                If both "nr" and a non-zero "id" are specified, then the list
                specified by "id" is used.
                To get the number of lists in the quickfix stack, set "nr" to
                "$" in {what}. The "nr" value in the returned dictionary
                contains the quickfix stack size.
                When "lines" is specified, all the other items except "efm"
                are ignored.  The returned dictionary contains the entry
                "items" with the list of entries.

                The returned dictionary contains the following entries:
                        changedtick     total number of changes made to the
                                        list quickfix-changedtick
                        context quickfix list context. See quickfix-context
                                If not present, set to "".
                        id      quickfix list ID quickfix-ID. If not
                                present, set to 0.
                        idx     index of the quickfix entry in the list. If not
                                present, set to 0.
                        items   quickfix list entries. If not present, set to
                                an empty list.
                        nr      quickfix list number. If not present, set to 0
                        qfbufnr number of the buffer displayed in the quickfix
                                window. If not present, set to 0.
                        size    number of entries in the quickfix list. If not
                                present, set to 0.
                        title   quickfix list title text. If not present, set
                                to "".
                        winid   quickfix window-ID. If not present, set to 0

                Examples (See also getqflist-examples):
                        :echo getqflist({'all': 1})
                        :echo getqflist({'nr': 2, 'title': 1})
                        :echo getqflist({'lines' : ["F1:10:L10"]})

                Return type: list<dict<any>> or list<any>

getreg([{regname} [, 1 [, {list}]]])                    getreg()
                The result is a String, which is the contents of register
                {regname}.  Example:
                        :let cliptext = getreg('*')
                When register {regname} was not set the result is an empty
                The {regname} argument must be a string.  E1162

                getreg('=') returns the last evaluated value of the expression
                register.  (For use in maps.)
                getreg('=', 1) returns the expression itself, so that it can
                be restored with setreg().  For other registers the extra
                argument is ignored, thus you can always give it.

                If {list} is present and TRUE, the result type is changed
                to List. Each list item is one text line. Use it if you care
                about zero bytes possibly present inside register: without
                third argument both NLs and zero bytes are represented as NLs
                (see NL-used-for-Nul).
                When the register was not set an empty list is returned.

                If {regname} is "", the unnamed register '"' is used.
                If {regname} is not specified, v:register is used.
                In Vim9-script {regname} must be one character.

                Can also be used as a method:

                Return type: String

getreginfo([{regname}])                                 getreginfo()
                Returns detailed information about register {regname} as a
                Dictionary with the following entries:
                        regcontents     List of lines contained in register
                                        {regname}, like
                                        getreg({regname}, 1, 1).
                        regtype         the type of register {regname}, as in
                        isunnamed       Boolean flag, v:true if this register
                                        is currently pointed to by the unnamed
                        points_to       for the unnamed register, gives the
                                        single letter name of the register
                                        currently pointed to (see quotequote).
                                        For example, after deleting a line
                                        with dd, this field will be "1",
                                        which is the register that got the
                                        deleted text.

                The {regname} argument is a string.  If {regname} is invalid
                or not set, an empty Dictionary will be returned.
                If {regname} is "" or "@", the unnamed register '"' is used.
                If {regname} is not specified, v:register is used.
                The returned Dictionary can be passed to setreg().
                In Vim9-script {regname} must be one character.

                Can also be used as a method:

                Return type: dict<any>

getregion({pos1}{pos2} [, {opts}])                    getregion()
                Returns the list of strings from {pos1} to {pos2} from a

                {pos1} and {pos2} must both be Lists with four numbers.
                See getpos() for the format of the list.  It's possible
                to specify positions from a different buffer, but please
                note the limitations at getregion-notes.

                The optional argument {opts} is a Dict and supports the
                following items:

                        type            Specify the region's selection type.
                                        See getregtype() for possible values,
                                        except that the width can be omitted
                                        and an empty string cannot be used.
                                        (default: "v")

                        exclusive       If TRUE, use exclusive selection
                                        for the end position.
                                        (default: follow 'selection')

                You can get the last selection type by visualmode().
                If Visual mode is active, use mode() to get the Visual mode
                (e.g., in a :vmap).
                This function is useful to get text starting and ending in
                different columns, such as a characterwise-visual selection.

                Note that:
                - Order of {pos1} and {pos2} doesn't matter, it will always
                  return content from the upper left position to the lower
                  right position.
                - If 'virtualedit' is enabled and the region is past the end
                  of the lines, resulting lines are padded with spaces.
                - If the region is blockwise and it starts or ends in the
                  middle of a multi-cell character, it is not included but
                  its selected part is substituted with spaces.
                - If {pos1} and {pos2} are not in the same buffer, an empty
                  list is returned.
                - {pos1} and {pos2} must belong to a bufloaded() buffer.
                - It is evaluated in current window context, which makes a
                  difference if the buffer is displayed in a window with
                  different 'virtualedit' or 'list' values.

                        :xnoremap <CR>
                        \ <Cmd>echow getregion(
                        \ getpos('v'), getpos('.'), #{ type: mode() })<CR>

                Can also be used as a method:

getregionpos({pos1}{pos2} [, {opts}])            getregionpos()
                Same as getregion(), but returns a list of positions
                describing the buffer text segments bound by {pos1} and
                The segments are a pair of positions for every line:
                        [[{start_pos}, {end_pos}], ...]

                The position is a List with four numbers:
                    [bufnum, lnum, col, off]
                "bufnum" is the buffer number.
                "lnum" and "col" are the position in the buffer.  The first
                column is 1.
                If the "off" number of a starting position is non-zero, it is
                the offset in screen columns from the start of the character.
                E.g., a position within a <Tab> or after the last character.
                If the "off" number of an ending position is non-zero, it is
                the offset of the character's first cell not included in the
                selection, otherwise all its cells are included.

                Apart from the options supported by getregion(){opts} also
                supports the following:

                        eol             If TRUE, indicate positions beyond
                                        the end of a line with "col" values
                                        one more than the length of the line.
                                        If FALSE, positions are limited
                                        within their lines, and if a line is
                                        empty or the selection is entirely
                                        beyond the end of a line, a "col"
                                        value of 0 is used for both positions.
                                        (default: FALSE)

                Can also be used as a method:

                Return type: list<string>

getregtype([{regname}])                                 getregtype()
                The result is a String, which is type of register {regname}.
                The value will be one of:
                    "v"                 for characterwise text
                    "V"                 for linewise text
                    "<CTRL-V>{width}"   for blockwise-visual text
                    ""                  for an empty or unknown register
                <CTRL-V> is one character with value 0x16.
                The {regname} argument is a string.  If {regname} is "", the
                unnamed register '"' is used.  If {regname} is not specified,
                v:register is used.
                In Vim9-script {regname} must be one character.

                Can also be used as a method:

                Return type: String

getscriptinfo([{opts}])                                 getscriptinfo()
                Returns a List with information about all the sourced Vim
                scripts in the order they were sourced, like what
                :scriptnames shows.

                The optional Dict argument {opts} supports the following
                optional items:
                    name        Script name match pattern. If specified,
                                and "sid" is not specified, information about
                                scripts with a name that match the pattern
                                "name" are returned.
                    sid         Script ID <SID>.  If specified, only
                                information about the script with ID "sid" is
                                returned and "name" is ignored.

                Each item in the returned List is a Dict with the following
                    autoload    Set to TRUE for a script that was used with
                                import autoload but was not actually sourced
                                yet (see import-autoload).
                    functions   List of script-local function names defined in
                                the script.  Present only when a particular
                                script is specified using the "sid" item in
                    name        Vim script file name.
                    sid         Script ID <SID>.
                    sourced     Script ID of the actually sourced script that
                                this script name links to, if any, otherwise
                    variables   A dictionary with the script-local variables.
                                Present only when a particular script is
                                specified using the "sid" item in {opts}.
                                Note that this is a copy, the value of
                                script-local variables cannot be changed using
                                this dictionary.
                    version     Vim script version (scriptversion)

                        :echo getscriptinfo({'name': 'myscript'})
                        :echo getscriptinfo({'sid': 15})[0].variables

                Return type: list<dict<any>>

gettabinfo([{tabnr}])                                   gettabinfo()
                If {tabnr} is not specified, then information about all the
                tab pages is returned as a List. Each List item is a
                Dictionary.  Otherwise, {tabnr} specifies the tab page
                number and information about that one is returned.  If the tab
                page does not exist an empty List is returned.

                Each List item is a Dictionary with the following entries:
                        tabnr           tab page number.
                        variables       a reference to the dictionary with
                                        tabpage-local variables
                        windows         List of window-IDs in the tab page.

                Can also be used as a method:

                Return type: list<dict<any>>

gettabvar({tabnr}{varname} [, {def}])                         gettabvar()
                Get the value of a tab-local variable {varname} in tab page
                Tabs are numbered starting with one.
                The {varname} argument is a string.  When {varname} is empty a
                dictionary with all tab-local variables is returned.
                Note that the name without "t:" must be used.
                When the tab or variable doesn't exist {def} or an empty
                string is returned, there is no error message.

                Can also be used as a method:

                Return type: any, depending on {varname}

gettabwinvar({tabnr}{winnr}{varname} [, {def}])             gettabwinvar()
                Get the value of window-local variable {varname} in window
                {winnr} in tab page {tabnr}.
                The {varname} argument is a string.  When {varname} is empty a
                dictionary with all window-local variables is returned.
                When {varname} is equal to "&" get the values of all
                window-local options in a Dictionary.
                Otherwise, when {varname} starts with "&" get the value of a
                window-local option.
                Note that {varname} must be the name without "w:".
                Tabs are numbered starting with one.  For the current tabpage
                use getwinvar().
                {winnr} can be the window number or the window-ID.
                When {winnr} is zero the current window is used.
                This also works for a global option, buffer-local option and
                window-local option, but it doesn't work for a global variable
                or buffer-local variable.
                When the tab, window or variable doesn't exist {def} or an
                empty string is returned, there is no error message.
                        :let list_is_on = gettabwinvar(1, 2, '&list')
                        :echo "myvar = " .. gettabwinvar(3, 1, 'myvar')

                To obtain all window-local variables use:
                        gettabwinvar({tabnr}, {winnr}, '&')

                Can also be used as a method:
                        GetTabnr()->gettabwinvar(winnr, varname)

                Return type: any, depending on {varname}

gettagstack([{winnr}])                                  gettagstack()
                The result is a Dict, which is the tag stack of window {winnr}.
                {winnr} can be the window number or the window-ID.
                When {winnr} is not specified, the current window is used.
                When window {winnr} doesn't exist, an empty Dict is returned.

                The returned dictionary contains the following entries:
                        curidx          Current index in the stack. When at
                                        top of the stack, set to (length + 1).
                                        Index of bottom of the stack is 1.
                        items           List of items in the stack. Each item
                                        is a dictionary containing the
                                        entries described below.
                        length          Number of entries in the stack.

                Each item in the stack is a dictionary with the following
                        bufnr           buffer number of the current jump
                        from            cursor position before the tag jump.
                                        See getpos() for the format of the
                                        returned list.
                        matchnr         current matching tag number. Used when
                                        multiple matching tags are found for a
                        tagname         name of the tag

                See tagstack for more information about the tag stack.

                Can also be used as a method:

                Return type: dict<any>

gettext({text} [, {package}])                           gettext()
                Translate String {text} if possible.
                This is mainly for use in the distributed Vim scripts.  When
                generating message translations the {text} is extracted by
                xgettext, the translator can add the translated message in the
                .po file and Vim will lookup the translation when gettext() is
                For {text} double quoted strings are preferred, because
                xgettext does not understand escaping in single quoted
                When the {package} is specified, the translation is looked up
                for that specific package. You need to specify the path to
                look for translations with the bindtextdomain() function.

                Return type: String

getwininfo([{winid}])                                   getwininfo()
                Returns information about windows as a List with Dictionaries.

                If {winid} is given Information about the window with that ID
                is returned, as a List with one item.  If the window does not
                exist the result is an empty list.

                Without {winid} information about all the windows in all the
                tab pages is returned.

                Each List item is a Dictionary with the following entries:
                        botline         last complete displayed buffer line
                        bufnr           number of buffer in the window
                        height          window height (excluding winbar)
                        loclist         1 if showing a location list
                                        {only with the +quickfix feature}
                        quickfix        1 if quickfix or location list window
                                        {only with the +quickfix feature}
                        terminal        1 if a terminal window
                                        {only with the +terminal feature}
                        tabnr           tab page number
                        topline         first displayed buffer line
                        variables       a reference to the dictionary with
                                        window-local variables
                        width           window width
                        winbar          1 if the window has a toolbar, 0
                        wincol          leftmost screen column of the window;
                                        "col" from win_screenpos()
                        textoff         number of columns occupied by any
                                        'foldcolumn''signcolumn' and line
                                        number in front of the text
                        winid           window-ID
                        winnr           window number
                        winrow          topmost screen line of the window;
                                        "row" from win_screenpos()

                Can also be used as a method:

                Return type: list<dict<any>>

getwinpos([{timeout}])                                  getwinpos()
                The result is a List with two numbers, the result of
                getwinposx() and getwinposy() combined:
                        [x-pos, y-pos]
                {timeout} can be used to specify how long to wait in msec for
                a response from the terminal.  When omitted 100 msec is used.
                Use a longer time for a remote terminal.
                When using a value less than 10 and no response is received
                within that time, a previously reported position is returned,
                if available.  This can be used to poll for the position and
                do some work in the meantime:
                        while 1
                          let res = getwinpos(1)
                          if res[0] >= 0
                          " Do some work here

                Can also be used as a method:

                Return type: list<number>

getwinposx()                                            getwinposx()
                The result is a Number, which is the X coordinate in pixels of
                the left hand side of the GUI Vim window. Also works for an
                xterm (uses a timeout of 100 msec).
                The result will be -1 if the information is not available
                (e.g. on the Wayland backend).
                The value can be used with :winpos.

                Return type: Number

getwinposy()                                            getwinposy()
                The result is a Number, which is the Y coordinate in pixels of
                the top of the GUI Vim window.  Also works for an xterm (uses
                a timeout of 100 msec).
                The result will be -1 if the information is not available
                (e.g. on the Wayland backend).
                The value can be used with :winpos.

                Return type: Number

getwinvar({winnr}{varname} [, {def}])                         getwinvar()
                Like gettabwinvar() for the current tabpage.
                        :let list_is_on = getwinvar(2, '&list')
                        :echo "myvar = " .. getwinvar(1, 'myvar')

                Can also be used as a method:

                Return type: any, depending on {varname}

glob({expr} [, {nosuf} [, {list} [, {alllinks}]]])              glob()
                Expand the file wildcards in {expr}.  See wildcards for the
                use of special characters.

                Unless the optional {nosuf} argument is given and is TRUE,
                the 'suffixes' and 'wildignore' options apply: Names matching
                one of the patterns in 'wildignore' will be skipped and
                'suffixes' affect the ordering of matches.
                'wildignorecase' always applies.

                When {list} is present and it is TRUE the result is a List
                with all matching files. The advantage of using a List is,
                you also get filenames containing newlines correctly.
                Otherwise the result is a String and when there are several
                matches, they are separated by <NL> characters.

                If the expansion fails, the result is an empty String or List.

                You can also use readdir() if you need to do complicated
                things, such as limiting the number of matches.

                A name for a non-existing file is not included.  A symbolic
                link is only included if it points to an existing file.
                However, when the {alllinks} argument is present and it is
                TRUE then all symbolic links are included.

                For most systems backticks can be used to get files names from
                any external command.  Example:
                        :let tagfiles = glob("`find . -name tags -print`")
                        :let &tags = substitute(tagfiles, "\n", ",", "g")
                The result of the program inside the backticks should be one
                item per line.  Spaces inside an item are allowed.

                See expand() for expanding special Vim variables.  See
                system() for getting the raw output of an external command.

                Can also be used as a method:

                Return type: String or list<string> or list<any> depending
                on {list}

glob2regpat({string})                                    glob2regpat()
                Convert a file pattern, as used by glob(), into a search
                pattern.  The result can be used to match with a string that
                is a file name.  E.g.
                        if filename =~ glob2regpat('Make*.mak')
                This is equivalent to:
                        if filename =~ '^Make.*\.mak$'
                When {string} is an empty string the result is "^$", match an
                empty string.
                Note that the result depends on the system.  On MS-Windows
                a backslash usually means a path separator.

                Can also be used as a method:

                Return type: String

globpath({path}{expr} [, {nosuf} [, {list} [, {alllinks}]]])
                Perform glob() for String {expr} on all directories in {path}
                and concatenate the results.  Example:
                        :echo globpath(&rtp, "syntax/c.vim")

                {path} is a comma-separated list of directory names.  Each
                directory name is prepended to {expr} and expanded like with
                glob().  A path separator is inserted when needed.
                To add a comma inside a directory name escape it with a
                backslash.  Note that on MS-Windows a directory may have a
                trailing backslash, remove it if you put a comma after it.
                If the expansion fails for one of the directories, there is no
                error message.

                Unless the optional {nosuf} argument is given and is TRUE,
                the 'suffixes' and 'wildignore' options apply: Names matching
                one of the patterns in 'wildignore' will be skipped and
                'suffixes' affect the ordering of matches.

                When {list} is present and it is TRUE the result is a List
                with all matching files. The advantage of using a List is, you
                also get filenames containing newlines correctly. Otherwise
                the result is a String and when there are several matches,
                they are separated by <NL> characters.  Example:
                        :echo globpath(&rtp, "syntax/c.vim", 0, 1)

                {alllinks} is used as with glob().

                The "**" item can be used to search in a directory tree.
                For example, to find all "README.txt" files in the directories
                in 'runtimepath' and below:
                        :echo globpath(&rtp, "**/README.txt")
                Upwards search and limiting the depth of "**" is not
                supported, thus using 'path' will not always work properly.

                Can also be used as a method, the base is passed as the
                second argument:

                Return type: String or list<string> or list<any> depending
                on {list}

has({feature} [, {check}])                                      has()
                When {check} is omitted or is zero: The result is a Number,
                which is 1 if the feature {feature} is supported, zero
                otherwise.  The {feature} argument is a string, case is
                ignored.  See feature-list below.

                When {check} is present and not zero: The result is a Number,
                which is 1 if the feature {feature} could ever be supported,
                zero otherwise.  This is useful to check for a typo in
                {feature} and to detect dead code.  Keep in mind that an older
                Vim version will not know about a feature added later and
                features that have been abandoned will not be known by the
                current Vim version.

                Also see exists() and exists_compiled().

                Note that to skip code that has a syntax error when the
                feature is not available, Vim may skip the rest of the line
                and miss a following endif.  Therefore put the endif on a
                separate line:
                        if has('feature')
                          let x = this->breaks->without->the->feature
                If the endif would be moved to the second line as "| endif" it
                would not be found.

                Return type: Number

has_key({dict}{key})                                  has_key()
                The result is a Number, which is TRUE if Dictionary {dict}
                has an entry with key {key}.  FALSE otherwise.
                The {key} argument is a string.  In Vim9 script a number is
                also accepted (and converted to a string) but no other types.
                In legacy script the usual automatic conversion to string is

                Can also be used as a method:

                Return type: Number

haslocaldir([{winnr} [, {tabnr}]])                      haslocaldir()
                The result is a Number:
                    1   when the window has set a local directory via :lcd
                    2   when the tab-page has set a local directory via :tcd
                    0   otherwise.

                Without arguments use the current window.
                With {winnr} use this window in the current tab page.
                With {winnr} and {tabnr} use the window in the specified tab
                {winnr} can be the window number or the window-ID.
                If {winnr} is -1 it is ignored and only the tabpage is used.
                Return 0 if the arguments are invalid.
                        if haslocaldir() == 1
                          " window local directory case
                        elseif haslocaldir() == 2
                          " tab-local directory case
                          " global directory case

                        " current window
                        :echo haslocaldir()
                        :echo haslocaldir(0)
                        :echo haslocaldir(0, 0)
                        " window n in current tab page
                        :echo haslocaldir(n)
                        :echo haslocaldir(n, 0)
                        " window n in tab page m
                        :echo haslocaldir(n, m)
                        " tab page m
                        :echo haslocaldir(-1, m)

                Can also be used as a method:

                Return type: Number

hasmapto({what} [, {mode} [, {abbr}]])                  hasmapto()
                The result is a Number, which is TRUE if there is a mapping
                that contains {what} in somewhere in the rhs (what it is
                mapped to) and this mapping exists in one of the modes
                indicated by {mode}.
                The arguments {what} and {mode} are strings.
                When {abbr} is there and it is TRUE use abbreviations
                instead of mappings.  Don't forget to specify Insert and/or
                Command-line mode.
                Both the global mappings and the mappings local to the current
                buffer are checked for a match.
                If no matching mapping is found FALSE is returned.
                The following characters are recognized in {mode}:
                        n       Normal mode
                        v       Visual and Select mode
                        x       Visual mode
                        s       Select mode
                        o       Operator-pending mode
                        i       Insert mode
                        l       Language-Argument ("r", "f", "t", etc.)
                        c       Command-line mode
                When {mode} is omitted, "nvo" is used.

                This function is useful to check if a mapping already exists
                to a function in a Vim script.  Example:
                        :if !hasmapto('\ABCdoit')
                        :   map <Leader>d \ABCdoit
                This installs the mapping to "\ABCdoit" only if there isn't
                already a mapping to "\ABCdoit".

                Can also be used as a method:

                Return type: Number

histadd({history}{item})                              histadd()
                Add the String {item} to the history {history} which can be
                one of:                                 hist-names
                        "cmd"    or ":"   command line history
                        "search" or "/"   search pattern history
                        "expr"   or "="   typed expression history
                        "input"  or "@"   input line history
                        "debug"  or ">"   debug command history
                        empty             the current or last used history
                The {history} string does not need to be the whole name, one
                character is sufficient.
                If {item} does already exist in the history, it will be
                shifted to become the newest entry.
                The result is a Number: TRUE if the operation was successful,
                otherwise FALSE is returned.

                        :call histadd("input", strftime("%Y %b %d"))
                        :let date=input("Enter date: ")
                This function is not available in the sandbox.

                Can also be used as a method, the base is passed as the
                second argument:

                Return type: Number

histdel({history} [, {item}])                           histdel()
                Clear {history}, i.e. delete all its entries.  See hist-names
                for the possible values of {history}.

                If the parameter {item} evaluates to a String, it is used as a
                regular expression.  All entries matching that expression will
                be removed from the history (if there are any).
                Upper/lowercase must match, unless "\c" is used /\c.
                If {item} evaluates to a Number, it will be interpreted as
                an index, see :history-indexing.  The respective entry will
                be removed if it exists.

                The result is TRUE for a successful operation, otherwise FALSE
                is returned.

                Clear expression register history:
                        :call histdel("expr")

                Remove all entries starting with "*" from the search history:
                        :call histdel("/", '^\*')

                The following three are equivalent:
                        :call histdel("search", histnr("search"))
                        :call histdel("search", -1)
                        :call histdel("search", '^' .. histget("search", -1) .. '$')

                To delete the last search pattern and use the last-but-one for
                the "n" command and 'hlsearch':
                        :call histdel("search", -1)
                        :let @/ = histget("search", -1)

                Can also be used as a method:

                Return type: Number

histget({history} [, {index}])                          histget()
                The result is a String, the entry with Number {index} from
                {history}.  See hist-names for the possible values of
                {history}, and :history-indexing for {index}.  If there is
                no such entry, an empty String is returned.  When {index} is
                omitted, the most recent item from the history is used.

                Redo the second last search from history.
                        :execute '/' .. histget("search", -2)

                Define an Ex command ":H {num}" that supports re-execution of
                the {num}th entry from the output of :history.
                        :command -nargs=1 H execute histget("cmd", 0+<args>)

                Can also be used as a method:

                Return type: String

histnr({history})                                       histnr()
                The result is the Number of the current entry in {history}.
                See hist-names for the possible values of {history}.
                If an error occurred, -1 is returned.

                        :let inp_index = histnr("expr")

                Can also be used as a method:

                Return type: Number

hlexists({name})                                        hlexists()
                The result is a Number, which is TRUE if a highlight group
                called {name} exists.  This is when the group has been
                defined in some way.  Not necessarily when highlighting has
                been defined for it, it may also have been used for a syntax
                Obsolete name: highlight_exists().

                Can also be used as a method:

                Return type: Number

hlget([{name} [, {resolve}]])                           hlget()
                Returns a List of all the highlight group attributes.  If the
                optional {name} is specified, then returns a List with only
                the attributes of the specified highlight group.  Returns an
                empty List if the highlight group {name} is not present.

                If the optional {resolve} argument is set to v:true and the
                highlight group {name} is linked to another group, then the
                link is resolved recursively and the attributes of the
                resolved highlight group are returned.

                Each entry in the returned List is a Dictionary with the
                following items:
                        cleared boolean flag, set to v:true if the highlight
                                group attributes are cleared or not yet
                                specified.  See highlight-clear.
                        cterm   cterm attributes. See highlight-cterm.
                        ctermbg cterm background color.
                                See highlight-ctermbg.
                        ctermfg cterm foreground color.
                                See highlight-ctermfg.
                        ctermul cterm underline color.  See highlight-ctermul.
                        default boolean flag, set to v:true if the highlight
                                group link is a default link. See
                        font    highlight group font.  See highlight-font.
                        gui     gui attributes. See highlight-gui.
                        guibg   gui background color.  See highlight-guibg.
                        guifg   gui foreground color.  See highlight-guifg.
                        guisp   gui special color.  See highlight-guisp.
                        id      highlight group ID.
                        linksto linked highlight group name.
                                See :highlight-link.
                        name    highlight group name. See group-name.
                        start   start terminal keycode.  See highlight-start.
                        stop    stop terminal keycode.  See highlight-stop.
                        term    term attributes.  See highlight-term.

                The 'term''cterm' and 'gui' items in the above Dictionary
                have a dictionary value with the following optional boolean
                items: 'bold''standout''underline''undercurl''italic',
                'reverse''inverse' and 'strikethrough'.

                        :echo hlget()
                        :echo hlget('ModeMsg')
                        :echo hlget('Number', v:true)

                Can also be used as a method:

                Return type: list<dict<any>>

hlset({list})                                           hlset()
                Creates or modifies the attributes of a List of highlight
                groups.  Each item in {list} is a dictionary containing the
                attributes of a highlight group. See hlget() for the list of
                supported items in this dictionary.

                In addition to the items described in hlget(), the following
                additional items are supported in the dictionary:

                        force           boolean flag to force the creation of
                                        a link for an existing highlight group
                                        with attributes.

                The highlight group is identified using the 'name' item and
                the 'id' item (if supplied) is ignored.  If a highlight group
                with a specified name doesn't exist, then it is created.
                Otherwise the attributes of an existing highlight group are

                If an empty dictionary value is used for the 'term' or 'cterm'
                or 'gui' entries, then the corresponding attributes are
                cleared.  If the 'cleared' item is set to v:true, then all the
                attributes of the highlight group are cleared.

                The 'linksto' item can be used to link a highlight group to
                another highlight group.  See :highlight-link.

                Returns zero for success, -1 for failure.

                        " add bold attribute to the Visual highlight group
                        :call hlset([#{name: 'Visual',
                                        \ term: #{reverse: 1 , bold: 1}}])
                        :call hlset([#{name: 'Type', guifg: 'DarkGreen'}])
                        :let l = hlget()
                        :call hlset(l)
                        " clear the Search highlight group
                        :call hlset([#{name: 'Search', cleared: v:true}])
                        " clear the 'term' attributes for a highlight group
                        :call hlset([#{name: 'Title', term: {}}])
                        " create the MyHlg group linking it to DiffAdd
                        :call hlset([#{name: 'MyHlg', linksto: 'DiffAdd'}])
                        " remove the MyHlg group link
                        :call hlset([#{name: 'MyHlg', linksto: 'NONE'}])
                        " clear the attributes and a link
                        :call hlset([#{name: 'MyHlg', cleared: v:true,
                                        \ linksto: 'NONE'}])

                Can also be used as a method:

                Return type: Number

hlID({name})                                                    hlID()
                The result is a Number, which is the ID of the highlight group
                with name {name}.  When the highlight group doesn't exist,
                zero is returned.
                This can be used to retrieve information about the highlight
                group.  For example, to get the background color of the
                "Comment" group:
        :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
                Obsolete name: highlightID().

                Can also be used as a method:

                Return type: Number

hostname()                                              hostname()
                The result is a String, which is the name of the machine on
                which Vim is currently running.  Machine names greater than
                256 characters long are truncated.

                Return type: String

iconv({string}{from}{to})                           iconv()
                The result is a String, which is the text {string} converted
                from encoding {from} to encoding {to}.
                When the conversion completely fails an empty string is
                returned.  When some characters could not be converted they
                are replaced with "?".
                The encoding names are whatever the iconv() library function
                can accept, see ":!man 3 iconv".
                Most conversions require Vim to be compiled with the +iconv
                feature.  Otherwise only UTF-8 to latin1 conversion and back
                can be done.
                This can be used to display messages with special characters,
                no matter what 'encoding' is set to.  Write the message in
                UTF-8 and use:
                        echo iconv(utf8_str, "utf-8", &enc)
                Note that Vim uses UTF-8 for all Unicode encodings, conversion
                from/to UCS-2 is automatically changed to use UTF-8.  You
                cannot use UCS-2 in a string anyway, because of the NUL bytes.

                Can also be used as a method:
                        GetText()->iconv('latin1', 'utf-8')

                Return type: String

indent({lnum})                                                  indent()
                The result is a Number, which is indent of line {lnum} in the
                current buffer.  The indent is counted in spaces, the value
                of 'tabstop' is relevant.  {lnum} is used just like in
                When {lnum} is invalid -1 is returned.  In Vim9 script an
                error is given.

                Can also be used as a method:

                Return type: Number

index({object}{expr} [, {start} [, {ic}]])                    index()
                Find {expr} in {object} and return its index.  See
                indexof() for using a lambda to select the item.

                If {object} is a List return the lowest index where the item
                has a value equal to {expr}.  There is no automatic
                conversion, so the String "4" is different from the Number 4.
                And the number 4 is different from the Float 4.0.  The value
                of 'ignorecase' is not used here, case matters as indicated by
                the {ic} argument.

                If {object} is Blob return the lowest index where the byte
                value is equal to {expr}.

                If {start} is given then start looking at the item with index
                {start} (may be negative for an item relative to the end).

                When {ic} is given and it is TRUE, ignore case.  Otherwise
                case must match.

                -1 is returned when {expr} is not found in {object}.
                        :let idx = index(words, "the")
                        :if index(numbers, 123) >= 0

                Can also be used as a method:

                Return type: Number

indexof({object}{expr} [, {opts}])                    indexof()
                Returns the index of an item in {object} where {expr} is
                v:true.  {object} must be a List or a Blob.

                If {object} is a List, evaluate {expr} for each item in the
                List until the expression is v:true and return the index of
                this item.

                If {object} is a Blob evaluate {expr} for each byte in the
                Blob until the expression is v:true and return the index of
                this byte.

                {expr} must be a string or Funcref.

                If {expr} is a string: If {object} is a List, inside
                {expr} v:key has the index of the current List item and
                v:val has the value of the item.  If {object} is a Blob,
                inside {expr} v:key has the index of the current byte and
                v:val has the byte value.

                If {expr} is a Funcref it must take two arguments:
                        1. the key or the index of the current item.
                        2. the value of the current item.
                The function must return TRUE if the item is found and the
                search should stop.

                The optional argument {opts} is a Dict and supports the
                following items:
                    startidx    start evaluating {expr} at the item with this
                                index; may be negative for an item relative to
                                the end
                Returns -1 when {expr} evaluates to v:false for all the items.
                        :let l = [#{n: 10}, #{n: 20}, #{n: 30}]
                        :echo indexof(l, "v:val.n == 20")
                        :echo indexof(l, {i, v -> v.n == 30})
                        :echo indexof(l, "v:val.n == 20", #{startidx: 1})

                Can also be used as a method:

                Return type: Number

input({prompt} [, {text} [, {completion}]])             input()
                The result is a String, which is whatever the user typed on
                the command-line.  The {prompt} argument is either a prompt
                string, or a blank string (for no prompt).  A '\n' can be used
                in the prompt to start a new line.
                The highlighting set with :echohl is used for the prompt.
                The input is entered just like a command-line, with the same
                editing commands and mappings.  There is a separate history
                for lines typed for input().
                        :if input("Coffee or beer? ") == "beer"
                        :  echo "Cheers!"

                If the optional {text} argument is present and not empty, this
                is used for the default reply, as if the user typed this.
                        :let color = input("Color? ", "white")

                The optional {completion} argument specifies the type of
                completion supported for the input.  Without it completion is
                not performed.  The supported completion types are the same as
                that can be supplied to a user-defined command using the
                "-complete=" argument.  Refer to :command-completion for
                more information.  Example:
                        let fname = input("File: ", "", "file")

                NOTE: This function must not be used in a startup file, for
                the versions that only run in GUI mode (e.g., the Win32 GUI).
                Note: When input() is called from within a mapping it will
                consume remaining characters from that mapping, because a
                mapping is handled like the characters were typed.
                Use inputsave() before input() and inputrestore()
                after input() to avoid that.  Another solution is to avoid
                that further characters follow in the mapping, e.g., by using
                :execute or :normal.

                Example with a mapping:
                        :nmap \x :call GetFoo()<CR>:exe "/" .. Foo<CR>
                        :function GetFoo()
                        :  call inputsave()
                        :  let g:Foo = input("enter search pattern: ")
                        :  call inputrestore()

                Can also be used as a method:

                Return type: String

inputdialog({prompt} [, {text} [, {cancelreturn}]])             inputdialog()
                Like input(), but when the GUI is running and text dialogs
                are supported, a dialog window pops up to input the text.
                   :let n = inputdialog("value for shiftwidth", shiftwidth())
                   :if n != ""
                   :  let &sw = n
                When the dialog is cancelled {cancelreturn} is returned.  When
                omitted an empty string is returned.
                Hitting <Enter> works like pressing the OK button.  Hitting
                <Esc> works like pressing the Cancel button.
                NOTE: Command-line completion is not supported.

                Can also be used as a method:

                Return type: String

inputlist({textlist})                                   inputlist()
                {textlist} must be a List of strings.  This List is
                displayed, one string per line.  The user will be prompted to
                enter a number, which is returned.
                The user can also select an item by clicking on it with the
                mouse, if the mouse is enabled in the command line ('mouse' is
                "a" or includes "c").  For the first string 0 is returned.
                When clicking above the first item a negative number is
                returned.  When clicking on the prompt one more than the
                length of {textlist} is returned.
                Make sure {textlist} has less than 'lines' entries, otherwise
                it won't work.  It's a good idea to put the entry number at
                the start of the string.  And put a prompt in the first item.
                        let color = inputlist(['Select color:', '1. red',
                                \ '2. green', '3. blue'])

                Can also be used as a method:

                Return type: Number

inputrestore()                                          inputrestore()
                Restore typeahead that was saved with a previous inputsave().
                Should be called the same number of times inputsave() is
                called.  Calling it more often is harmless though.
                Returns TRUE when there is nothing to restore, FALSE otherwise.

                Return type: Number

inputsave()                                             inputsave()
                Preserve typeahead (also from mappings) and clear it, so that
                a following prompt gets input from the user.  Should be
                followed by a matching inputrestore() after the prompt.  Can
                be used several times, in which case there must be just as
                many inputrestore() calls.
                Returns TRUE when out of memory, FALSE otherwise.

                Return type: Number

inputsecret({prompt} [, {text}])                        inputsecret()
                This function acts much like the input() function with but
                two exceptions:
                a) the user's response will be displayed as a sequence of
                asterisks ("*") thereby keeping the entry secret, and
                b) the user's response will not be recorded on the input
                history stack.
                The result is a String, which is whatever the user actually
                typed on the command-line in response to the issued prompt.
                NOTE: Command-line completion is not supported.

                Can also be used as a method:

                Return type: String

insert({object}{item} [, {idx}])                      insert()
                When {object} is a List or a Blob insert {item} at the start
                of it.

                If {idx} is specified insert {item} before the item with index
                {idx}.  If {idx} is zero it goes before the first item, just
                like omitting {idx}.  A negative {idx} is also possible, see
                list-index.  -1 inserts just before the last item.

                Returns the resulting List or Blob.  Examples:
                        :let mylist = insert([2, 3, 5], 1)
                        :call insert(mylist, 4, -1)
                        :call insert(mylist, 6, len(mylist))
                The last example can be done simpler with add().
                Note that when {item} is a List it is inserted as a single
                item.  Use extend() to concatenate Lists.

                Can also be used as a method:

                Return type: Number

                                        instanceof() E614 E616 E693
                The result is a Number, which is TRUE when the {object}
                argument is a direct or indirect instance of a Class,
                Interface, or class :type alias specified by {class}.
                If {class} is varargs, the function returns TRUE when
                {object} is an instance of any of the specified classes.
                        instanceof(animal, Dog, Cat)

                Can also be used as a method:

                Return type: Number

interrupt()                                             interrupt()
                Interrupt script execution.  It works more or less like the
                user typing CTRL-C, most commands won't execute and control
                returns to the user.  This is useful to abort execution
                from lower down, e.g. in an autocommand.  Example:
                :function s:check_typoname(file)
                :   if fnamemodify(a:file, ':t') == '['
                :       echomsg 'Maybe typo'
                :       call interrupt()
                :   endif
                :au BufWritePre * call s:check_typoname(expand('<amatch>'))

                Return type: void

invert({expr})                                          invert()
                Bitwise invert.  The argument is converted to a number.  A
                List, Dict or Float argument causes an error.  Example:
                        :let bits = invert(bits)
                Can also be used as a method:
                        :let bits = bits->invert()

                Return type: Number

isabsolutepath({path})                                  isabsolutepath()
                The result is a Number, which is TRUE when {path} is an
                absolute path.
                On Unix, a path is considered absolute when it starts with '/'.
                On MS-Windows, it is considered absolute when it starts with an
                optional drive prefix and is followed by a '\' or '/'. UNC paths
                are always absolute.
                        echo isabsolutepath('/usr/share/')      " 1
                        echo isabsolutepath('./foobar')         " 0
                        echo isabsolutepath('C:\Windows')       " 1
                        echo isabsolutepath('foobar')           " 0
                        echo isabsolutepath('\\remote\file')    " 1

                Can also be used as a method:

                Return type: Number

isdirectory({directory})                                isdirectory()
                The result is a Number, which is TRUE when a directory
                with the name {directory} exists.  If {directory} doesn't
                exist, or isn't a directory, the result is FALSE.  {directory}
                is any expression, which is used as a String.

                Can also be used as a method:

                Return type: Number

isinf({expr})                                           isinf()
                Return 1 if {expr} is a positive infinity, or -1 a negative
                infinity, otherwise 0.
                        :echo isinf(1.0 / 0.0)
                        :echo isinf(-1.0 / 0.0)

                Can also be used as a method:

                Return type: Number

islocked({expr})                                        islocked() E786
                The result is a Number, which is TRUE when {expr} is the
                name of a locked variable.
                The string argument {expr} must be the name of a variable,
                List item or Dictionary entry, not the variable itself!
                        :let alist = [0, ['a', 'b'], 2, 3]
                        :lockvar 1 alist
                        :echo islocked('alist')         " 1
                        :echo islocked('alist[1]')      " 0

                When {expr} is a variable that does not exist -1 is returned.
                If {expr} uses a range, list or dict index that is out of
                range or does not exist you get an error message.  Use
                exists() to check for existence.
                In Vim9 script it does not work for local function variables.

                Can also be used as a method:

                Return type: Number

isnan({expr})                                           isnan()
                Return TRUE if {expr} is a float with value NaN.
                        echo isnan(0.0 / 0.0)

                Can also be used as a method:

                Return type: Number

items({dict})                                           items()
                Return a List with all the key-value pairs of {dict}.  Each
                List item is a list with two items: the key of a {dict}
                entry and the value of this entry.  The List is in arbitrary
                order.  Also see keys() and values().
                        for [key, value] in items(mydict)
                           echo key .. ': ' .. value

                A List or a String argument is also supported.  In these
                cases, items() returns a List with the index and the value at
                the index.

                Can also be used as a method:

                Return type: list<list<any>> or list<any>

job_ functions are documented here: job-functions-details

join({list} [, {sep}])                                  join()
                Join the items in {list} together into one String.
                When {sep} is specified it is put in between the items.  If
                {sep} is omitted a single space is used.
                Note that {sep} is not added at the end.  You might want to
                add it there too:
                        let lines = join(mylist, "\n") .. "\n"
                String items are used as-is.  Lists and Dictionaries are
                converted into a string like with string().
                The opposite function is split().

                Can also be used as a method:

                Return type: String

js_decode({string})                                     js_decode()
                This is similar to json_decode() with these differences:
                - Object key names do not have to be in quotes.
                - Strings can be in single quotes.
                - Empty items in an array (between two commas) are allowed and
                  result in v:none items.

                Can also be used as a method:

                Return type: any, depending on {varname}

js_encode({expr})                                       js_encode()
                This is similar to json_encode() with these differences:
                - Object key names are not in quotes.
                - v:none items in an array result in an empty item between
                For example, the Vim object:
                Will be encoded as:
                While json_encode() would produce:
                This encoding is valid for JavaScript. It is more efficient
                than JSON, especially when using an array with optional items.

                Can also be used as a method:

                Return type: String

json_decode({string})                           json_decode() E491
                This parses a JSON formatted string and returns the equivalent
                in Vim values.  See json_encode() for the relation between
                JSON and Vim values.
                The decoding is permissive:
                - A trailing comma in an array and object is ignored, e.g.
                  "[1, 2, ]" is the same as "[1, 2]".
                - Integer keys are accepted in objects, e.g. {1:2} is the
                  same as {"1":2}.
                - More floating point numbers are recognized, e.g. "1." for
                  "1.0", or "001.2" for "1.2". Special floating point values
                  "Infinity", "-Infinity" and "NaN" (capitalization ignored)
                  are accepted.
                - Leading zeroes in integer numbers are ignored, e.g. "012"
                  for "12" or "-012" for "-12".
                - Capitalization is ignored in literal names null, true or
                  false, e.g. "NULL" for "null", "True" for "true".
                - Control characters U+0000 through U+001F which are not
                  escaped in strings are accepted, e.g. "       " (tab
                  character in string) for "\t".
                - An empty JSON expression or made of only spaces is accepted
                  and results in v:none.
                - Backslash in an invalid 2-character sequence escape is
                  ignored, e.g. "\a" is decoded as "a".
                - A correct surrogate pair in JSON strings should normally be
                  a 12 character sequence such as "\uD834\uDD1E", but
                  json_decode() silently accepts truncated surrogate pairs
                  such as "\uD834" or "\uD834\u"
                A duplicate key in an object, valid in rfc7159, is not
                accepted by json_decode() as the result must be a valid Vim
                type, e.g. this fails: {"a":"b", "a":"c"}

                Can also be used as a method:

                Return type: any, depending on {varname}

json_encode({expr})                                     json_encode()
                Encode {expr} as JSON and return this as a string.