eval.txt Nvim VIM REFERENCE MANUAL by Bram Moolenaar
Expression evaluation expression expr E15 eval
Using expressions is introduced in chapter 41 of the user manual usr_41.txt. Note: Expression evaluation can be disabled at compile time. If this has been done, the features in this document are not available. See +eval and no-eval-feature. Type gO to see the table of contents.
1. Variables variables
1.1 Variable types E712 There are six types of variables:
Number A 32 or 64 bit signed number. expr-number Number 64-bit Number is available only when compiled with the +num64 feature. Examples: -123 0x10 0177 0b1011
Float A floating point number. floating-point-format Float Examples: 123.456 1.15e-6 -1.1e3
E928 String A NUL terminated string of 8-bit unsigned characters (bytes). expr-string Examples: "ab\txx\"--" 'x-z''a,c' Funcref A reference to a function Funcref. Example: function("strlen") It can be bound to a dictionary and arguments, it then works like a Partial. Example: function("Callback", [arg], myDict) List An ordered sequence of items List. Example: [1, 2, ['a', 'b']] Dictionary An associative, unordered array: Each entry has a key and a value. Dictionary Example: {'blue': "#0000ff", 'red': "#ff0000"} The Number and String types are converted automatically, depending on how they are used. Conversion from a Number to a String is by making the ASCII representation of the Number. Examples: Number 123 --> String "123" Number 0 --> String "0" Number -1 --> String "-1"octal Conversion from a String to a Number is done by converting the first digits to a number. Hexadecimal "0xf9", Octal "017", and Binary "0b10" numbers are recognized. If the String doesn't start with digits, the result is zero. Examples: String "456" --> Number 456 String "6bar" --> Number 6 String "foo" --> Number 0 String "0xf1" --> Number 241 String "0100" --> Number 64 String "0b101" --> Number 5 String "-8" --> Number -8 String "+8" --> Number 0To force conversion from String to Number, add zero to it:
echo "0100" + 064To avoid a leading zero to cause octal conversion, or for using a different base, use str2nr().
TRUE FALSE For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE. You can also use v:false and v:true. When TRUE is returned from a function it is the Number one, FALSE is the number zero. Note that in the command:
if "foo"" NOT executed
"foo" is converted to 0, which means FALSE. If the string starts with a non-zero number it means TRUE:
if "8foo"" executed
To test for a non-empty string, use empty():
if !empty("foo")non-zero-arg Function arguments often behave slightly different from TRUE: If the argument is present and it evaluates to a non-zero Number, v:true or a non-empty String, then the value is considered to be TRUE. Note that " " and "0" are also non-empty strings, thus considered to be TRUE. A List, Dictionary or Float is not a Number or String, thus evaluate to FALSE.
E745 E728 E703 E729 E730 E731 List, Dictionary and Funcref types are not automatically converted.
E805 E806 E808 When mixing Number and Float the Number is converted to Float. Otherwise there is no automatic conversion of Float. You can use str2float() for String to Float, printf() for Float to String and float2nr() for Float to Number.
E891 E892 E893 E894 When expecting a Float a Number can also be used, but nothing else.
no-type-checking You will not get an error if you try to change the type of a variable. 1.2 Function references Funcref E695 E718 A Funcref variable is obtained with the function() function or created with the lambda expression expr-lambda. It can be used in an expression in the place of a function name, before the parenthesis around the arguments, to invoke the function it refers to. Example:
let Fn = function("MyFunc")echo Fn()
E704 E705 E707 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You can use "g:" but the following name must still start with a capital. You cannot have both a Funcref variable and a function with the same name. A special case is defining a function and directly assigning its Funcref to a Dictionary entry. Example:
function dict.init() dictlet self.val = 0endfunction
The key of the Dictionary can start with a lower case letter. The actual function name is not used here. Also see numbered-function. A Funcref can also be used with the :call command:
call Fn()call dict.init()
The name of the referenced function can be obtained with string().
let func = string(Fn)You can use call() to invoke a Funcref and use a list variable for the arguments:
let r = call(Fn, mylist)Partial A Funcref optionally binds a Dictionary and/or arguments. This is also called a Partial. This is created by passing the Dictionary and/or arguments to function(). When calling the function the Dictionary and/or arguments will be passed to the function. Example:
let Cb = function('Callback', ['foo'], myDict)call Cb()
This will invoke the function as if using:
call myDict.Callback('foo')Note that binding a function to a Dictionary also happens when the function is a member of the Dictionary:
let myDict.myFunction = MyFunctioncall myDict.myFunction()
Here MyFunction() will get myDict passed as "self". This happens when the "myFunction" member is accessed. When assigning "myFunction" to otherDict and calling it, it will be bound to otherDict:
let otherDict.myFunction = myDict.myFunctioncall otherDict.myFunction()
Now "self" will be "otherDict". But when the dictionary was bound explicitly this won't happen:
let myDict.myFunction = function(MyFunction, myDict)let otherDict.myFunction = myDict.myFunctioncall otherDict.myFunction()
Here "self" will be "myDict", because it was bound explicitly. 1.3 Lists list List Lists E686 A List is an ordered sequence of items. An item can be of any type. Items can be accessed by their index number. Items can be added and removed at any position in the sequence. List creation E696 E697 A List is created with a comma separated list of items in square brackets. Examples:
let mylist = [1, two, 3, "four"]let emptylist = []
An item can be any expression. Using a List for an item creates a List of Lists:
let nestlist = [[11, 12], [21, 22], [31, 32]]An extra comma after the last item is ignored. List index list-index E684 An item in the List can be accessed by putting the index in square brackets after the List. Indexes are zero-based, thus the first item has index zero.
let item = mylist[0] " get the first item: 1let item = mylist[2] " get the third item: 3
When the resulting item is a list this can be repeated:
let item = nestlist[0][1] " get the first list, second item: 12A negative index is counted from the end. Index -1 refers to the last item in the List, -2 to the last but one item, etc.
let last = mylist[-1] " get the last item: "four"To avoid an error for an invalid index use the get() function. When an item is not available it returns zero or the default value you specify:
echo get(mylist, idx)echo get(mylist, idx, "NONE")
List concatenationTwo lists can be concatenated with the "+" operator:
let longlist = mylist + [5, 6]let mylist += [7, 8]
To prepend or append an item turn the item into a list by putting [] around it. To change a list in-place see list-modification below. Sublist sublist A part of the List can be obtained by specifying the first and last index, separated by a colon in square brackets:
let shortlist = mylist[2:-1] " get List [3, "four"]Omitting the first index is similar to zero. Omitting the last index is similar to -1.
let endlist = mylist[2:] " from item 2 to the end: [3, "four"]let shortlist = mylist[2:2] " List with one item: [3]let otherlist = mylist[:] " make a copy of the List
If the first index is beyond the last item of the List or the second item is before the first item, the result is an empty list. There is no error message. If the second index is equal to or greater than the length of the list the length minus one is used:
let mylist = [0, 1, 2, 3]echo mylist[2:8] " result: [2, 3]
NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for using a single letter variable before the ":". Insert a space when needed: mylist[s : e]. List identity list-identity When variable "aa" is a list and you assign it to another variable "bb", both variables refer to the same list. Thus changing the list "aa" will also change "bb":
let aa = [1, 2, 3]let bb = aacall add(aa, 4)echo bb
[1, 2, 3, 4] Making a copy of a list is done with the copy() function. Using [:] also works, as explained above. This creates a shallow copy of the list: Changing a list item in the list will also change the item in the copied list:
let aa = [[1, 'a'], 2, 3]let bb = copy(aa)call add(aa, 4)let aa[0][1] = 'aaa'echo aa
[[1, aaa], 2, 3, 4]
echo bb[[1, aaa], 2, 3] To make a completely independent list use deepcopy(). This also makes a copy of the values in the list, recursively. Up to a hundred levels deep. The operator "is" can be used to check if two variables refer to the same List. "isnot" does the opposite. In contrast "==" compares if two lists have the same value.
let alist = [1, 2, 3]let blist = [1, 2, 3]echo alist is blist
0
echo alist == blist1 Note about comparing lists: Two lists are considered equal if they have the same length and all items compare equal, as with using "==". There is one exception: When comparing a number with a string they are considered different. There is no automatic type conversion, as with using "==" on variables. Example:
echo 4 == "4"1
echo [4] == ["4"]0 Thus comparing Lists is more strict than comparing numbers and strings. You can compare simple values this way too by putting them in a list:
let a = 5let b = "5"echo a == b
1
echo [a] == [b]0 List unpack To unpack the items in a list to individual variables, put the variables in square brackets, like list items:
let [var1, var2] = mylistWhen the number of variables does not match the number of items in the list this produces an error. To handle any extra items from the list append ";" and a variable name:
let [var1, var2; rest] = mylistThis works like:
let var1 = mylist[0]let var2 = mylist[1]let rest = mylist[2:]
Except that there is no error if there are only two items. "rest" will be an empty list then. List modification list-modification To change a specific item of a list use :let this way:
let list[4] = "four"let listlist[0][3] = item
To change part of a list you can specify the first and last item to be modified. The value must at least have the number of items in the range:
let list[3:5] = [3, 4, 5]Adding and removing items from a list is done with functions. Here are a few examples:
call insert(list, 'a') " prepend item 'a'call insert(list, 'a', 3) " insert item 'a' before list[3]call add(list, "new") " append String itemcall add(list, [1, 2]) " append a List as one new itemcall extend(list, [1, 2]) " extend the list with two more itemslet i = remove(list, 3) " remove item 3unlet list[3] " idemlet l = remove(list, 3, -1) " remove items 3 to last itemunlet list[3 : ] " idemcall filter(list, 'v:val !~ "x"') " remove items with an 'x'
Changing the order of items in a list:
call sort(list) " sort a list alphabeticallycall reverse(list) " reverse the order of itemscall uniq(sort(list)) " sort and remove duplicates
For loopThe :for loop executes commands for each item in a list. A variable is set to each item in the list in sequence. Example:
for item in mylistcall Doit(item)endfor
This works like:
let index = 0while index < len(mylist)let item = mylist[index]:call Doit(item)let index = index + 1endwhile
If all you want to do is modify each item in the list then the map() function will be a simpler method than a for loop. Just like the :let command, :for also accepts a list of variables. This requires the argument to be a list of lists.
for [lnum, col] in [[1, 3], [2, 8], [3, 0]]call Doit(lnum, col)endfor
This works like a :let command is done for each list item. Again, the types must remain the same to avoid an error. It is also possible to put remaining items in a List variable:
for [i, j; rest] in listlistcall Doit(i, j)if !empty(rest)echo "remainder: " . string(rest)endifendfor
List functionsE714 Functions that are useful with a List:
let r = call(funcname, list) " call a function with an argument listif empty(list) " check if list is emptylet l = len(list) " number of items in listlet big = max(list) " maximum value in listlet small = min(list) " minimum value in listlet xs = count(list, 'x') " count nr of times 'x' appears in listlet i = index(list, 'x') " index of first 'x' in listlet lines = getline(1, 10) " get ten text lines from buffercall append('$', lines) " append text lines in bufferlet list = split("a b c") " create list from items in a stringlet string = join(list, ', ') " create string from list itemslet s = string(list) " String representation of listcall map(list, '">> " . v:val') " prepend ">> " to each item
Don't forget that a combination of features can make things simple. For example, to add up all the numbers in a list:
exe 'let sum = ' . join(nrlist, '+')1.4 DictionariesDict dict Dictionaries Dictionary A Dictionary is an associative array: Each entry has a key and a value. The entry can be located with the key. The entries are stored without a specific ordering. Dictionary creation E720 E721 E722 E723 A Dictionary is created with a comma separated list of entries in curly braces. Each entry has a key and a value, separated by a colon. Each key can only appear once. Examples:
let mydict = {1: 'one', 2: 'two', 3: 'three'}let emptydict = {}
E713 E716 E717 A key is always a String. You can use a Number, it will be converted to a String automatically. Thus the String '4' and the number 4 will find the same entry. Note that the String '04' and the Number 04 are different, since the Number will be converted to the String '4'. The empty string can be used as a key. A value can be any expression. Using a Dictionary for a value creates a nested Dictionary:
let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}An extra comma after the last entry is ignored. Accessing entries The normal way to access an entry is by putting the key in square brackets:
let val = mydict["one"]let mydict["four"] = 4
You can add new entries to an existing Dictionary this way, unlike Lists. For keys that consist entirely of letters, digits and underscore the following form can be used expr-entry:
let val = mydict.onelet mydict.four = 4
Since an entry can be any type, also a List and a Dictionary, the indexing and key lookup can be repeated:
echo dict.key[idx].keyDictionary to List conversionYou may want to loop over the entries in a dictionary. For this you need to turn the Dictionary into a List and pass it to :for. Most often you want to loop over the keys, using the keys() function:
for key in keys(mydict)echo key . ': ' . mydict[key]endfor
The List of keys is unsorted. You may want to sort them first:
for key in sort(keys(mydict))To loop over the values use the values() function:
for v in values(mydict)echo "value: " . vendfor
If you want both the key and the value use the items() function. It returns a List in which each item is a List with two items, the key and the value:
for [key, value] in items(mydict)echo key . ': ' . valueendfor
Dictionary identitydict-identity Just like Lists you need to use copy() and deepcopy() to make a copy of a Dictionary. Otherwise, assignment results in referring to the same Dictionary:
:let onedict = {'a': 1, 'b': 2}:let adict = onedict:let adict['a'] = 11:echo onedict['a']11
Two Dictionaries compare equal if all the key-value pairs compare equal. For more info see list-identity. Dictionary modification dict-modification To change an already existing entry of a Dictionary, or to add a new entry, use :let this way:
let dict[4] = "four"let dict['one'] = item
Removing an entry from a Dictionary is done with remove() or :unlet. Three ways to remove the entry with key "aaa" from dict:
let i = remove(dict, 'aaa')unlet dict.aaaunlet dict['aaa']
Merging a Dictionary with another is done with extend():
call extend(adict, bdict)This extends adict with all entries from bdict. Duplicate keys cause entries in adict to be overwritten. An optional third argument can change this. Note that the order of entries in a Dictionary is irrelevant, thus don't expect ":echo adict" to show the items from bdict after the older entries in adict. Weeding out entries from a Dictionary can be done with filter():
call filter(dict, 'v:val =~ "x"')This removes all entries from "dict" with a value not matching 'x'. Dictionary function Dictionary-function self E725 E862 When a function is defined with the "dict" attribute it can be used in a special way with a dictionary. Example:
function Mylen() dictreturn len(self.data)endfunctionlet mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")}echo mydict.len()
This is like a method in object oriented programming. The entry in the Dictionary is a Funcref. The local variable "self" refers to the dictionary the function was invoked from. It is also possible to add a function without the "dict" attribute as a Funcref to a Dictionary, but the "self" variable is not available then.
numbered-function anonymous-function To avoid the extra name for the function it can be defined and directly assigned to a Dictionary in this way:
let mydict = {'data': [0, 1, 2, 3]}function mydict.len()return len(self.data)endfunctionecho mydict.len()
The function will then get a number and the value of dict.len is a Funcref that references this function. The function can only be used through a Funcref. It will automatically be deleted when there is no Funcref remaining that refers to it. It is not necessary to use the "dict" attribute for a numbered function. If you get an error for a numbered function, you can find out what it is with a trick. Assuming the function is 42, the command is:
function {42}Functions for DictionariesE715 Functions that can be used with a Dictionary:
if has_key(dict, 'foo') " TRUE if dict has entry with key "foo"if empty(dict) " TRUE if dict is emptylet l = len(dict) " number of items in dictlet big = max(dict) " maximum value in dictlet small = min(dict) " minimum value in dictlet xs = count(dict, 'x') " count nr of times 'x' appears in dictlet s = string(dict) " String representation of dictcall map(dict, '">> " . v:val') " prepend ">> " to each item
1.5 More about variablesmore-variables If you need to know the type of a variable or expression, use the type() function. When the '!' flag is included in the 'shada' option, global variables that start with an uppercase letter, and don't contain a lowercase letter, are stored in the shada file shada-file. When the 'sessionoptions' option contains "global", global variables that start with an uppercase letter and contain at least one lowercase letter are stored in the session file session-file. variable name can be stored where my_var_6 not My_Var_6 session file MY_VAR_6 shada file It's possible to form a variable name with curly braces, see curly-braces-names.
2. Expression syntax expression-syntax
Expression syntax summary, from least to most significant: expr1 expr2 expr2 ? expr1 : expr1 if-then-else expr2 expr3 expr3 || expr3 .. logical OR expr3 expr4 expr4 && expr4 .. logical AND expr4 expr5 expr5 == expr5 equal expr5 != expr5 not equal expr5 > expr5 greater than expr5 >= expr5 greater than or equal expr5 < expr5 smaller than expr5 <= expr5 smaller than or equal expr5 =~ expr5 regexp matches expr5 !~ expr5 regexp doesn't match expr5 ==? expr5 equal, ignoring case expr5 ==# expr5 equal, match case etc. As above, append ? for ignoring case, # for matching case expr5 is expr5 same List instance expr5 isnot expr5 different List instance expr5 expr6 expr6 + expr6 .. number addition or list concatenation expr6 - expr6 .. number subtraction expr6 . expr6 .. string concatenation expr6 expr7 expr7 * expr7 .. number multiplication expr7 / expr7 .. number division expr7 % expr7 .. number modulo expr7 expr8 ! expr7 logical NOT - expr7 unary minus + expr7 unary plus expr8 expr9 expr8[expr1] byte of a String or item of a List expr8[expr1 : expr1] substring of a String or sublist of a List expr8.name entry in a Dictionary expr8(expr1, ...) function call with Funcref variable expr9 number number constant "string" string constant, backslash is special 'string' string constant, ' is doubled [expr1, ...] List {expr1: expr1, ...} Dictionary &option option value (expr1) nested expression variable internal variable va{ria}ble internal variable with curly braces $VAR environment variable @r contents of register 'r' function(expr1, ...) function call func{ti}on(expr1, ...) function call with curly braces {args -> expr1} lambda expression ".." indicates that the operations in this level can be concatenated. Example:
&nu || &list && &shell == "csh"All expressions within one level are parsed from left to right.
expr1 expr1 E109 -----expr2 ? expr1 : expr1 The expression before the '?' is evaluated to a number. If it evaluates to TRUE, the result is the value of the expression between the '?' and ':', otherwise the result is the value of the expression after the ':'. Example:
echo lnum == 1 ? "top" : lnumSince the first expression is an "expr2", it cannot contain another ?:. The other two expressions can, thus allow for recursive use of ?:. Example:
echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnumTo keep this readable, using line-continuation is suggested:
echo lnum == 1\ ? "top"\ : lnum == 1000\ ? "last"\ : lnum
You should always put a space before the ':', otherwise it can be mistaken for use in a variable such as "a:1".
expr2 and expr3 expr2 expr3 ---------------
expr-barbar expr-&& The "||" and "&&" operators take one argument on each side. The arguments are (converted to) Numbers. The result is: input output n1 n2 n1 || n2 n1 && n2 FALSE FALSE FALSE FALSE FALSE TRUE TRUE FALSE TRUE FALSE TRUE FALSE TRUE TRUE TRUE TRUE The operators can be concatenated, for example:
&nu || &list && &shell == "csh"Note that "&&" takes precedence over "||", so this has the meaning of:
&nu || (&list && &shell == "csh")Once the result is known, the expression "short-circuits", that is, further arguments are not evaluated. This is like what happens in C. For example:
let a = 1echo a || b
This is valid even if there is no variable called "b" because "a" is TRUE, so the result must be TRUE. Similarly below:
echo exists("b") && b == "yes"This is valid whether "b" has been defined or not. The second clause will only be evaluated if "b" has been defined.
expr4 expr4 -----expr5 {cmp} expr5 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1 if it evaluates to true.
expr-== expr-!= expr-> expr->= expr-< expr-<= expr-=~ expr-!~ expr-==# expr-!=# expr-># expr->=# expr-<# expr-<=# expr-=~# expr-!~# expr-==? expr-!=? expr->? expr->=? expr-<? expr-<=? expr-=~? expr-!~? expr-is expr-isnot expr-is# expr-isnot# expr-is? expr-isnot? use 'ignorecase' match case ignore caseequal == ==# ==? not equal != !=# !=? greater than > ># >? greater than or equal >= >=# >=? smaller than < <# <? smaller than or equal <= <=# <=? regexp matches =~ =~# =~? regexp doesn't match !~ !~# !~? same instance is is# is? different instance isnot isnot# isnot? Examples: "abc" ==# "Abc" evaluates to 0 "abc" ==? "Abc" evaluates to 1 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise
E691 E692 A List can only be compared with a List and only "equal", "not equal", "is" and "isnot" can be used. This compares the values of the list, recursively. Ignoring case means case is ignored when comparing item values.
E735 E736 A Dictionary can only be compared with a Dictionary and only "equal", "not equal", "is" and "isnot" can be used. This compares the key/values of the Dictionary recursively. Ignoring case means case is ignored when comparing item values.
E694 A Funcref can only be compared with a Funcref and only "equal", "not equal", "is" and "isnot" can be used. Case is never ignored. Whether arguments or a Dictionary are bound (with a partial) matters. The Dictionaries must also be equal (or the same, in case of "is") and the arguments must be equal (or the same). To compare Funcrefs to see if they refer to the same function, ignoring bound Dictionary and arguments, use get() to get the function name:
if get(Part1, 'name') == get(Part2, 'name')" Part1 and Part2 refer to the same function
When using "is" or "isnot" with a List or a Dictionary this checks if the expressions are referring to the same List or Dictionary instance. A copy of a List is different from the original List. When using "is" without a List or a Dictionary it is equivalent to using "equal", using "isnot" equivalent to using "not equal". Except that a different type means the values are different:
echo 4 == '4'1echo 4 is '4'0echo 0 is []0
"is#"/"isnot#" and "is?"/"isnot?" can be used to match and ignore case. When comparing a String with a Number, the String is converted to a Number, and the comparison is done on Numbers. This means that:
echo 0 == 'x'1
because 'x' converted to a Number is zero. However:
echo [0] == ['x']0
Inside a List or Dictionary this conversion is not used. When comparing two Strings, this is done with strcmp() or stricmp(). This results in the mathematical difference (comparing byte values), not necessarily the alphabetical difference in the local language. When using the operators with a trailing '#', or the short version and 'ignorecase' is off, the comparing is done with strcmp(): case matters. When using the operators with a trailing '?', or the short version and 'ignorecase' is set, the comparing is done with stricmp(): case is ignored. 'smartcase' is not used. The "=~" and "!~" operators match the lefthand argument with the righthand argument, which is used as a pattern. See pattern for what a pattern is. This matching is always done like 'magic' was set and 'cpoptions' is empty, no matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts portable. To avoid backslashes in the regexp pattern to be doubled, use a single-quote string, see literal-string. Since a string is considered to be a single line, a multi-line pattern (containing \n, backslash-n) will not match. However, a literal NL character can be matched like an ordinary character. Examples: "foo\nbar" =~ "\n" evaluates to 1 "foo\nbar" =~ "\\n" evaluates to 0
expr5 and expr6 expr5 expr6 ---------------expr6 + expr6 .. Number addition or List concatenation expr-+ expr6 - expr6 .. Number subtraction expr-- expr6 . expr6 .. String concatenation expr-. For Lists only "+" is possible and then both expr6 must be a list. The result is a new list with the two lists Concatenated.
expr7 * expr7 .. Number multiplication expr-star expr7 / expr7 .. Number division expr-/ expr7 % expr7 .. Number modulo expr-% For all, except ".", Strings are converted to Numbers. For bitwise operators see and(), or() and xor(). Note the difference between "+" and ".": "123" + "456" = 579 "123" . "456" = "123456" Since '.' has the same precedence as '+' and '-', you need to read:
1 . 90 + 90.0As:
(1 . 90) + 90.0That works, since the String "190" is automatically converted to the Number 190, which can be added to the Float 90.0. However:
1 . 90 * 90.0Should be read as:
1 . (90 * 90.0)Since '.' has lower precedence than '*'. This does NOT work, since this attempts to concatenate a Float and a String. When dividing a Number by zero the result depends on the value: 0 / 0 = -0x80000000 (like NaN for Float) >0 / 0 = 0x7fffffff (like positive infinity) <0 / 0 = -0x7fffffff (like negative infinity) (before Vim 7.2 it was always 0x7fffffff) When 64-bit Number support is enabled: 0 / 0 = -0x8000000000000000 (like NaN for Float) >0 / 0 = 0x7fffffffffffffff (like positive infinity) <0 / 0 = -0x7fffffffffffffff (like negative infinity) When the righthand side of '%' is zero, the result is 0. None of these work for Funcrefs.
. and % do not work for Float. E804
expr7 expr7 -----! expr7 logical NOT expr-! - expr7 unary minus expr-unary-- + expr7 unary plus expr-unary-+ For '!' TRUE becomes FALSE, FALSE becomes TRUE (one). For '-' the sign of the number is changed. For '+' the number is unchanged. A String will be converted to a Number first. These three can be repeated and mixed. Examples: !-1 == 0 !!8 == 1 --9 == 9
expr8 expr8 -----expr8[expr1] item of String or List expr-[] E111 subscript If expr8 is a Number or String this results in a String that contains the expr1'th single byte from expr8. expr8 is used as a String, expr1 as a Number. This doesn't recognize multi-byte encodings, see byteidx()foran alternative, or use split()to turn the string into a list of characters.Index zero gives the first byte. This is like it works in C. Careful: text column numbers start with one! Example, to get the byte under the cursor:
let c = getline(".")[col(".") - 1]If the length of the String is less than the index, the result is an empty String. A negative index always results in an empty string (reason: backward compatibility). Use [-1:] to get the last byte. If expr8 is a List then it results the item at index expr1. See list-index for possible index values. If the index is out of range this results in an error. Example:
let item = mylist[-1] " get last itemGenerally, if a List index is equal to or higher than the length of the List, or more negative than the length of the List, this results in an error.
expr8[expr1a : expr1b] substring or sublist expr-[:] If expr8 is a Number or String this results in the substring with the bytes from expr1a to and including expr1b. expr8 is used as a String, expr1a and expr1b are used as a Number. This doesn't recognize multi-byte encodings, see byteidx() for computing the indexes. If expr1a is omitted zero is used. If expr1b is omitted the length of the string minus one is used. A negative number can be used to measure from the end of the string. -1 is the last character, -2 the last but one, etc. If an index goes out of range for the string characters are omitted. If expr1b is smaller than expr1a the result is an empty string. Examples:
let c = name[-1:] " last byte of a stringlet c = name[-2:-2] " last but one byte of a stringlet s = line(".")[4:] " from the fifth byte to the endlet s = s[:-3] " remove last two bytes
slice If expr8 is a List this results in a new List with the items indicated by the indexes expr1a and expr1b. This works like with a String, as explained just above. Also see sublist below. Examples:
let l = mylist[:3] " first four itemslet l = mylist[4:4] " List with one itemlet l = mylist[:] " shallow copy of a List
Using expr8[expr1] or expr8[expr1a : expr1b] on a Funcref results in an error. Watch out for confusion between a namespace and a variable followed by a colon for a sublist:
mylist[n:] " uses variable nmylist[s:] " uses namespace s:, error!
expr8.name entry in a Dictionary expr-entry If expr8 is a Dictionary and it is followed by a dot, then the following name will be used as a key in the Dictionary. This is just like: expr8[name]. The name must consist of alphanumeric characters, just like a variable name, but it may start with a number. Curly braces cannot be used. There must not be white space before or after the dot. Examples:
let dict = {"one": 1, 2: "two"}echo dict.oneecho dict .2
Note that the dot is also used for String concatenation. To avoid confusion always put spaces around the dot for String concatenation. expr8(expr1, ...) Funcref function call When expr8 is a Funcref type variable, invoke the function it refers to.
expr9 number ------number number constant expr-number hex-number octal-number binary-number Decimal, Hexadecimal (starting with 0x or 0X), Binary (starting with 0b or 0B) and Octal (starting with 0).
floating-point-format Floating point numbers can be written in two forms: [-+]{N}.{M} [-+]{N}.{M}[eE][-+]{exp} {N} and {M} are numbers. Both {N} and {M} must be present and can only contain digits. [-+] means there is an optional plus or minus sign. {exp} is the exponent, power of 10. Only a decimal point is accepted, not a comma. No matter what the current locale is. Examples: 123.456 +0.0001 55.0 -0.123 1.234e03 1.0E-6 -3.1416e+88 These are INVALID: 3. empty {M} 1e40 missing .{M}
float-pi float-e A few useful values to copy&paste:
let pi = 3.14159265359let e = 2.71828182846
Rationale: Before floating point was introduced, the text "123.456" was interpreted as the two numbers "123" and "456", both converted to a string and concatenated, resulting in the string "123456". Since this was considered pointless, and we could not find it intentionally being used in Vim scripts, this backwards incompatibility was accepted in favor of being able to use the normal notation for floating point numbers.
floating-point-precision The precision and range of floating points numbers depends on what "double" means in the library Vim was compiled with. There is no way to change this at runtime. The default for displaying a Float is to use 6 decimal places, like using printf("%g", f). You can select something else when using the printf() function. Example:
echo printf('%.15e', atan(1))7.853981633974483e-01
string string String expr-string E114 ------"string" string constant expr-quote Note that double quotes are used. A string constant accepts these special characters: \... three-digit octal number (e.g., "\316") \.. two-digit octal number (must be followed by non-digit) \. one-digit octal number (must be followed by non-digit) \x.. byte specified with two hex numbers (e.g., "\x1f") \x. byte specified with one hex number (must be followed by non-hex char) \X.. same as \x.. \X. same as \x. \u.... character specified with up to 4 hex numbers, stored as UTF-8 (e.g., "\u02a4") \U.... same as \u but allows up to 8 hex numbers. \b backspace <BS> \e escape <Esc> \f formfeed <FF> \n newline <NL> \r return <CR> \t tab <Tab> \\ backslash \" double quote \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W. This is for use in mappings, the 0x80 byte is escaped. Don't use <Char-xxxx> to get a utf-8 character, use \uxxxx as mentioned above. Note that "\xff" is stored as the byte 255, which may be invalid in some encodings. Use "\u00ff" to store character 255 correctly as UTF-8. Note that "\000" and "\x00" force the end of the string.
literal-string literal-string E115 ---------------'string' string constant expr-' Note that single quotes are used. This string is taken as it is. No backslashes are removed or have a special meaning. The only exception is that two quotes stand for one quote. Single quoted strings are useful for patterns, so that backslashes do not need to be doubled. These two commands are equivalent:
if a =~ "\\s*"if a =~ '\s*'
option expr-option E112 E113 ------&option option value, local value if possible &g:option global option value &l:option local option value Examples:
echo "tabstop is " . &tabstopif &insertmode
Any option name can be used here. See options. When using the local value and there is no buffer-local or window-local value, the global value is used anyway.
register expr-register @r --------@r contents of register 'r' The result is the contents of the named register, as a single string. Newlines are inserted where required. To get the contents of the unnamed register use @" or @@. See registers for an explanation of the available registers. When using the '=' register you get the expression itself, not what it evaluates to. Use eval() to evaluate it.
nesting expr-nesting E110 -------(expr1) nested expression
environment variable expr-env --------------------$VAR environment variable The String value of any environment variable. When it is not defined, the result is an empty string. expr-env-expand Note that there is a difference between using $VAR directly and using expand("$VAR"). Using it directly will only expand environment variables that are known inside the current Vim session. Using expand() will first try using the environment variables known inside the current Vim session. If that fails, a shell will be used to expand the variable. This can be slow, but it does expand all variables that the shell knows about. Example:
echo $shellecho expand("$shell")
The first one probably doesn't echo anything, the second echoes the $shell variable (if your shell supports it).
internal variable expr-variable -----------------variable internal variable See below internal-variables.
function call expr-function E116 E118 E119 E120 -------------function(expr1, ...) function call See below functions.
lambda expression expr-lambda lambda -----------------{args -> expr1} lambda expression A lambda expression creates a new unnamed function which returns the result of evaluating expr1. Lambda expressions differ from user-functions in the following ways: 1. The body of the lambda expression is an expr1 and not a sequence of Ex commands. 2. The prefix "a:" should not be used for arguments. E.g.:
let F = {arg1, arg2 -> arg1 - arg2}echo F(5, 2)
3 The arguments are optional. Example:
let F = {-> 'error function'}echo F()
error function closure Lambda expressions can access outer scope variables and arguments. This is often called a closure. Example where "i" and "a:arg" are used in a lambda while they exist in the function scope. They remain valid even after the function returns:
function Foo(arg)let i = 3return {x -> x + i - a:arg}endfunctionlet Bar = Foo(4)echo Bar(6)
5 See also :func-closure. Lambda and closure support can be checked with:
if has('lambda')Examples for using a lambda expression with sort(), map() and filter():
echo map([1, 2, 3], {idx, val -> val + 1})[2, 3, 4]
echo sort([3,7,2,1,4], {a, b -> a - b})[1, 2, 3, 4, 7] The lambda expression is also useful for jobs and timers:
:let timer = timer_start(500,\ {-> execute("echo 'Handler called'", "")},\ {'repeat': 3})
Handler called Handler called Handler called Note how execute() is used to execute an Ex command. That's ugly though. Lambda expressions have internal names like '<lambda>42'. If you get an error for a lambda expression, you can find what it is with the following command:
function {'<lambda>42'}See also: numbered-function
3. Internal variable internal-variables E461
An internal variable name can be made up of letters, digits and '_'. But it cannot start with a digit. It's also possible to use curly braces, see curly-braces-names. An internal variable is created with the ":let" command :let. An internal variable is explicitly destroyed with the ":unlet" command :unlet. Using a name that is not an internal variable or refers to a variable that has been destroyed results in an error. There are several name spaces for variables. Which one is to be used is specified by what is prepended: (nothing) In a function: local to a function; otherwise: global buffer-variable b: Local to the current buffer. window-variable w: Local to the current window. tabpage-variable t: Local to the current tab page. global-variable g: Global. local-variable l: Local to a function. script-variable s: Local to a :source'ed Vim script. function-argument a: Function argument (only inside a function). vim-variable v: Global, predefined by Vim. The scope name by itself can be used as a Dictionary. For example, to delete all script-local variables:
for k in keys(s:)unlet s:[k]endfor
buffer-variable b:var b: A variable name that is preceded with "b:" is local to the current buffer. Thus you can have several "b:foo" variables, one for each buffer. This kind of variable is deleted when the buffer is wiped out or deleted with :bdelete. One local buffer variable is predefined: b:changedtick changetick b:changedtick The total number of changes to the current buffer. It is incremented for each change. An undo command is also a change in this case. This can be used to perform an action only when the buffer has changed. Example:
if my_changedtick != b:changedticklet my_changedtick = b:changedtickcall My_Update()endif
You cannot change or delete the b:changedtick variable.
window-variable w:var w: A variable name that is preceded with "w:" is local to the current window. It is deleted when the window is closed.
tabpage-variable t:var t: A variable name that is preceded with "t:" is local to the current tab page, It is deleted when the tab page is closed. {not available when compiled without the +windows feature}
global-variable g:var g: Inside functions global variables are accessed with "g:". Omitting this will access a variable local to a function. But "g:" can also be used in any other place if you like.
local-variable l:var l: Inside functions local variables are accessed without prepending anything. But you can also prepend "l:" if you like. However, without prepending "l:" you may run into reserved variable names. For example "count". By itself it refers to "v:count". Using "l:count" you can have a local variable with the same name.
script-variable s:var In a Vim script variables starting with "s:" can be used. They cannot be accessed from outside of the scripts, thus are local to the script. They can be used in: - commands executed while the script is sourced - functions defined in the script - autocommands defined in the script - functions and autocommands defined in functions and autocommands which were defined in the script (recursively) - user defined commands defined in the script Thus not in: - other scripts sourced from this one - mappings - menus - etc. Script variables can be used to avoid conflicts with global variable names. Take this example:
let s:counter = 0function MyCounter()let s:counter = s:counter + 1echo s:counterendfunctioncommand Tick call MyCounter()
You can now invoke "Tick" from any script, and the "s:counter" variable in that script will not be changed, only the "s:counter" in the script where "Tick" was defined is used. Another example that does the same:
let s:counter = 0command Tick let s:counter = s:counter + 1 | echo s:counter
When calling a function and invoking a user-defined command, the context for script variables is set to the script where the function or command was defined. The script variables are also available when a function is defined inside a function that is defined in a script. Example:
let s:counter = 0function StartCounting(incr)if a:incrfunction MyCounter()let s:counter = s:counter + 1endfunctionelsefunction MyCounter()let s:counter = s:counter - 1endfunctionendifendfunction
This defines the MyCounter() function either for counting up or counting down when calling StartCounting(). It doesn't matter from where StartCounting() is called, the s:counter variable will be accessible in MyCounter(). When the same script is sourced again it will use the same script variables. They will remain valid as long as Vim is running. This can be used to maintain a counter:
if !exists("s:counter")let s:counter = 1echo "script executed for the first time"elselet s:counter = s:counter + 1echo "script executed " . s:counter . " times now"endif
Note that this means that filetype plugins don't get a different set of script variables for each buffer. Use local buffer variables instead b:var.
Predefined Vim variables: vim-variable v:var v:
v:beval_col beval_col-variable v:beval_col The number of the column, over which the mouse pointer is. This is the byte index in the v:beval_lnum line. Only valid while evaluating the 'balloonexpr' option.
v:beval_bufnr beval_bufnr-variable v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only valid while evaluating the 'balloonexpr' option.
v:beval_lnum beval_lnum-variable v:beval_lnum The number of the line, over which the mouse pointer is. Only valid while evaluating the 'balloonexpr' option.
v:beval_text beval_text-variable v:beval_text The text under or after the mouse pointer. Usually a word as it is useful for debugging a C program. 'iskeyword' applies, but a dot and "->" before the position is included. When on a ']' the text before it is used, including the matching '[' and word before it. When on a Visual area within one line the highlighted text is used. Only valid while evaluating the 'balloonexpr' option.
v:beval_winnr beval_winnr-variable v:beval_winnr The number of the window, over which the mouse pointer is. Only valid while evaluating the 'balloonexpr' option. The first window has number zero (unlike most other places where a window gets a number).
v:beval_winid beval_winid-variable v:beval_winid The window-ID of the window, over which the mouse pointer is. Otherwise like v:beval_winnr.
v:char char-variable v:char Argument for evaluating 'formatexpr' and used for the typed character when using <expr> in an abbreviation :map-<expr>. It is also used by the InsertCharPre and InsertEnter events.
v:charconvert_from charconvert_from-variable v:charconvert_from The name of the character encoding of a file to be converted. Only valid while evaluating the 'charconvert' option.
v:charconvert_to charconvert_to-variable v:charconvert_to The name of the character encoding of a file after conversion. Only valid while evaluating the 'charconvert' option.
v:cmdarg cmdarg-variable v:cmdarg This variable is used for two purposes: 1. The extra arguments given to a file read/write command. Currently these are "++enc=" and "++ff=". This variable is set before an autocommand event for a file read/write command is triggered. There is a leading space to make it possible to append this variable directly after the read/write command. Note: The "+cmd" argument isn't included here, because it will be executed anyway. 2. When printing a PostScript file with ":hardcopy" this is the argument for the ":hardcopy" command. This can be used in 'printexpr'.
v:cmdbang cmdbang-variable v:cmdbang Set like v:cmdarg for a file read/write command. When a "!" was used the value is 1, otherwise it is 0. Note that this can only be used in autocommands. For user commands <bang> can be used.
v:completed_item completed_item-variable v:completed_item Dictionary containing the most recent complete-items after CompleteDone. Empty if the completion failed, or after leaving and re-entering insert mode.
v:count count-variable v:count The count given for the last Normal mode command. Can be used to get the count before a mapping. Read-only. Example:
map _x :<C-U>echo "the count is " . v:count<CR>Note: The <C-U> is required to remove the line range that you get when typing ':' after a count. When there are two counts, as in "3d2w", they are multiplied, just like what happens in the command, "d6w" for the example. Also used for evaluating the 'formatexpr' option.
v:count1 count1-variable v:count1 Just like "v:count", but defaults to one when no count is used.
v:ctype ctype-variable v:ctype The current locale setting for characters of the runtime environment. This allows Vim scripts to be aware of the current locale encoding. Technical: it's the value of LC_CTYPE. When not using a locale the value is "C". This variable can not be set directly, use the :language command. See multi-lang.
v:dying dying-variable v:dying Normally zero. When a deadly signal is caught it's set to one. When multiple signals are caught the number increases. Can be used in an autocommand to check if Vim didn't terminate normally. {only works on Unix} Example:
au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endifNote: if another deadly signal is caught when v:dying is one, VimLeave autocommands will not be executed.
v:exiting exiting-variable v:exiting Exit code, or v:null if not exiting. VimLeave
v:errmsg errmsg-variable v:errmsg Last given error message. It's allowed to set this variable. Example:
let v:errmsg = ""silent! nextif v:errmsg != ""... handle error
"errmsg" also works, for backwards compatibility.
v:errors errors-variable v:errors Errors found by assert functions, such as assert_true(). This is a list of strings. The assert functions append an item when an assert fails. To remove old results make it empty:
let v:errors = []If v:errors is set to anything but a list it is made an empty list by the assert function.
v:event event-variable v:event Dictionary of event data for the current autocommand. Valid only during the event lifetime; storing or passing v:event is invalid! Copy it instead:
au TextYankPost * let g:foo = deepcopy(v:event)Keys vary by event; see the documentation for the specific event, e.g. DirChanged or TextYankPost. KEY DESCRIPTIONabort Whether the event triggered during an aborting condition, i e c_Esc or c_CTRL-cfor CmdlineLeave. cmdlevel Level of cmdline. cmdtype Type of cmdline, cmdline-char. cwd Current working directory. scope Event-specific scope name. operator Current operator. Also set for Ex commands (unlike v:operator). For example if TextYankPost is triggered by the :yank Ex command then v:event.operatoris "y".regcontents Text stored in the register as a readfile()-style list of lines. regname Requested register (e.g "x" for "xyy) or the empty string for an unnamed operation. regtype Type of register as returned by getregtype().
v:exception exception-variable v:exception The value of the exception most recently caught and not finished. See also v:throwpoint and throw-variables. Example:
trythrow "oops"catch /.*/echo "caught" v:exceptionendtry
Output: "caught oops".
v:false false-variable v:false Special value used to put "false" in JSON and msgpack. See json_encode(). This value is converted to "v:false" when used as a String (e.g. in expr5 with string concatenation operator) and to zero when used as a Number (e.g. in expr5 or expr7 when used with numeric operators). Read-only.
v:fcs_reason fcs_reason-variable v:fcs_reason The reason why the FileChangedShell event was triggered. Can be used in an autocommand to decide what to do and/or what to set v:fcs_choice to. Possible values: deleted file no longer exists conflict file contents, mode or timestamp was changed and buffer is modified changed file contents has changed mode mode of file changed time only file timestamp changed
v:fcs_choice fcs_choice-variable v:fcs_choice What should happen after a FileChangedShell event was triggered. Can be used in an autocommand to tell Vim what to do with the affected buffer: reload Reload the buffer (does not work if the file was deleted). ask Ask the user what to do, as if there was no autocommand. Except that when only the timestamp changed nothing will happen. <empty> Nothing, the autocommand should do everything that needs to be done. The default is empty. If another (invalid) value is used then Vim behaves like it is empty, there is no warning message.
v:fname_in fname_in-variable v:fname_in The name of the input file. Valid while evaluating: option used for'charconvert' file to be converted 'diffexpr' original file 'patchexpr' original file 'printexpr' file to be printed And set to the swap file name for SwapExists.
v:fname_out fname_out-variable v:fname_out The name of the output file. Only valid while evaluating: option used for'charconvert' resulting converted file (*) 'diffexpr' output of diff 'patchexpr' resulting patched file (*) When doing conversion for a write command (e.g., ":w file") it will be equal to v:fname_in. When doing conversion for a read command (e.g., ":e file") it will be a temporary file and different from v:fname_in.
v:fname_new fname_new-variable v:fname_new The name of the new version of the file. Only valid while evaluating 'diffexpr'.
v:fname_diff fname_diff-variable v:fname_diff The name of the diff (patch) file. Only valid while evaluating 'patchexpr'.
v:folddashes folddashes-variable v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed fold. Read-only in the sandbox. fold-foldtext
v:foldlevel foldlevel-variable v:foldlevel Used for 'foldtext': foldlevel of closed fold. Read-only in the sandbox. fold-foldtext
v:foldend foldend-variable v:foldend Used for 'foldtext': last line of closed fold. Read-only in the sandbox. fold-foldtext
v:foldstart foldstart-variable v:foldstart Used for 'foldtext': first line of closed fold. Read-only in the sandbox. fold-foldtext
v:hlsearch hlsearch-variable v:hlsearch Variable that indicates whether search highlighting is on. Setting it makes sense only if 'hlsearch' is enabled. Setting this variable to zero acts like the :nohlsearch command, setting it to one acts like
let &hlsearch = &hlsearchNote that the value is restored when returning from a function. function-search-undo.
v:insertmode insertmode-variable v:insertmode Used for the InsertEnter and InsertChange autocommand events. Values: i Insert mode r Replace mode v Virtual Replace mode
v:key key-variable v:key Key of the current item of a Dictionary. Only valid while evaluating the expression used with map() and filter(). Read-only.
v:lang lang-variable v:lang The current locale setting for messages of the runtime environment. This allows Vim scripts to be aware of the current language. Technical: it's the value of LC_MESSAGES. The value is system dependent. This variable can not be set directly, use the :language command. It can be different from v:ctype when messages are desired in a different language than what is used for character encoding. See multi-lang.
v:lc_time lc_time-variable v:lc_time The current locale setting for time messages of the runtime environment. This allows Vim scripts to be aware of the current language. Technical: it's the value of LC_TIME. This variable can not be set directly, use the :language command. See multi-lang.
v:lnum lnum-variable v:lnum Line number for the 'foldexpr' fold-expr, 'formatexpr' and 'indentexpr' expressions, tab page number for 'guitablabel' and 'guitabtooltip'. Only valid while one of these expressions is being evaluated. Read-only when in the sandbox.
v:mouse_win mouse_win-variable v:mouse_win Window number for a mouse click obtained with getchar(). First window has number 1, like with winnr(). The value is zero when there was no mouse button click.
v:mouse_winid mouse_winid-variable v:mouse_winid window-ID for a mouse click obtained with getchar(). The value is zero when there was no mouse button click.
v:mouse_lnum mouse_lnum-variable v:mouse_lnum Line number for a mouse click obtained with getchar(). This is the text line number, not the screen line number. The value is zero when there was no mouse button click.
v:mouse_col mouse_col-variable v:mouse_col Column number for a mouse click obtained with getchar(). This is the screen column number, like with virtcol(). The value is zero when there was no mouse button click.
v:msgpack_types msgpack_types-variable v:msgpack_types Dictionary containing msgpack types used by msgpackparse() and msgpackdump(). All types inside dictionary are fixed (not editable) empty lists. To check whether some list is one of msgpack types, use is operator.
v:null null-variable v:null Special value used to put "null" in JSON and NIL in msgpack. See json_encode(). This value is converted to "v:null" when used as a String (e.g. in expr5 with string concatenation operator) and to zero when used as a Number (e.g. in expr5 or expr7 when used with numeric operators). Read-only.
v:oldfiles oldfiles-variable v:oldfiles List of file names that is loaded from the shada file on startup. These are the files that Vim remembers marks for. The length of the List is limited by the ' argument of the 'shada' option (default is 100). When the shada file is not used the List is empty. Also see :oldfiles and c_#<. The List can be modified, but this has no effect on what is stored in the shada file later. If you use values other than String this will cause trouble. {only when compiled with the +shada feature}
v:option_new v:option_new New value of the option. Valid while executing an OptionSet autocommand. v:option_old v:option_old Old value of the option. Valid while executing an OptionSet autocommand. v:option_type v:option_type Scope of the set command. Valid while executing an OptionSet autocommand. Can be either "global" or "local" v:operator operator-variable v:operator The last operator given in Normal mode. This is a single character except for commands starting with <g> or <z>, in which case it is two characters. Best used alongside v:prevcount and v:register. Useful if you want to cancel Operator-pending mode and then use the operator, e.g.:
omap O <Esc>:call MyMotion(v:operator)<CR>The value remains set until another operator is entered, thus don't expect it to be empty. v:operator is not set for :delete, :yank or other Ex commands. Read-only.
v:prevcount prevcount-variable v:prevcount The count given for the last but one Normal mode command. This is the v:count value of the previous command. Useful if you want to cancel Visual or Operator-pending mode and then use the count, e.g.:
vmap % <Esc>:call MyFilter(v:prevcount)<CR>Read-only.
v:profiling profiling-variable v:profiling Normally zero. Set to one after using ":profile start". See profiling.
v:progname progname-variable v:progname The name by which Nvim was invoked (with path removed). Read-only.
v:progpath progpath-variable v:progpath Absolute path to the current running Nvim. Read-only.
v:register register-variable v:register The name of the register in effect for the current normal mode command (regardless of whether that command actually used a register). Or for the currently executing normal mode mapping (use this in custom commands that take a register). If none is supplied it is the default register '"', unless 'clipboard' contains "unnamed" or "unnamedplus", then it is '*' or '+'. Also see getreg() and setreg()
v:scrollstart scrollstart-variable v:scrollstart String describing the script or function that caused the screen to scroll up. It's only set when it is empty, thus the first reason is remembered. It is set to "Unknown" for a typed command. This can be used to find out why your script causes the hit-enter prompt.
v:servername servername-variable $NVIM_LISTEN_ADDRESS v:servername Default Nvim server address. Equivalent to $NVIM_LISTEN_ADDRESS on startup. serverstop() Read-only.
v:searchforward v:searchforward searchforward-variable Search direction: 1 after a forward search, 0 after a backward search. It is reset to forward when directly setting the last search pattern, see quote/. Note that the value is restored when returning from a function. function-search-undo. Read-write.
v:shell_error shell_error-variable v:shell_error Result of the last shell command. When non-zero, the last shell command had an error. When zero, there was no problem. This only works when the shell returns the error code to Vim. The value -1 is often used when the command could not be executed. Read-only. Example:
!mv foo barif v:shell_errorecho 'could not rename "foo" to "bar"!'endif
"shell_error" also works, for backwards compatibility.
v:statusmsg statusmsg-variable v:statusmsg Last given status message. It's allowed to set this variable.
v:stderr stderr-variable v:stderr Channel id for stderr. Unlike stdin and stdout (see stdioopen()), stderr is always open for writing. This channel ID is always 2, but this variable can be used to be explicit. Example:
call chansend(v:stderr, "something bad happened\n")v:swapname swapname-variable v:swapname Only valid when executing SwapExists autocommands: Name of the swap file found. Read-only.
v:swapchoice swapchoice-variable v:swapchoice SwapExists autocommands can set this to the selected choice for handling an existing swap file: 'o' Open read-only 'e' Edit anyway 'r' Recover 'd' Delete swapfile 'q' Quit 'a' Abort The value should be a single-character string. An empty value results in the user being asked, as would happen when there is no SwapExists autocommand. The default is empty.
v:swapcommand swapcommand-variable v:swapcommand Normal mode command to be executed after a file has been opened. Can be used for a SwapExists autocommand to have another Vim open the file and jump to the right place. For example, when jumping to a tag the value is ":tag tagname\r". For ":edit +cmd file" the value is ":cmd\r".
v:t_TYPE v:t_bool t_bool-variable v:t_bool Value of Boolean type. Read-only. See: type() v:t_dict t_dict-variable v:t_dict Value of Dictionary type. Read-only. See: type() v:t_float t_float-variable v:t_float Value of Float type. Read-only. See: type() v:t_func t_func-variable v:t_func Value of Funcref type. Read-only. See: type() v:t_list t_list-variable v:t_list Value of List type. Read-only. See: type() v:t_number t_number-variable v:t_number Value of Number type. Read-only. See: type() v:t_string t_string-variable v:t_string Value of String type. Read-only. See: type()
v:termresponse termresponse-variable v:termresponse The escape sequence returned by the terminal for the DA (request primary device attributes) control sequence. It is set when Vim receives an escape sequence that starts with ESC [ or CSI and ends in a 'c', with only digits, ';' and '.' in between. When this option is set, the TermResponse autocommand event is fired, so that you can react to the response from the terminal. The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp is the terminal type: 0 for vt100 and 1 for vt220. Pv is the patch level (since this was introduced in patch 95, it's always 95 or bigger). Pc is always zero. {only when compiled with +termresponse feature}
v:testing testing-variable v:testing Must be set before using test_garbagecollect_now().Also, when set certain error messages won't be shown for 2 seconds. (e.g. "'dictionary' option is empty")
v:this_session this_session-variable v:this_session Full filename of the last loaded or saved session file. See :mksession. It is allowed to set this variable. When no session file has been saved, this variable is empty. "this_session" also works, for backwards compatibility.
v:throwpoint throwpoint-variable v:throwpoint The point where the exception most recently caught and not finished was thrown. Not set when commands are typed. See also v:exception and throw-variables. Example:
trythrow "oops"catch /.*/echo "Exception from" v:throwpointendtry
Output: "Exception from test.vim, line 2"
v:true true-variable v:true Special value used to put "true" in JSON and msgpack. See json_encode(). This value is converted to "v:true" when used as a String (e.g. in expr5 with string concatenation operator) and to one when used as a Number (e.g. in expr5 or expr7 when used with numeric operators). Read-only.
v:val val-variable v:val Value of the current item of a List or Dictionary. Only valid while evaluating the expression used with map() and filter(). Read-only.
v:version version-variable v:version Version number of Vim: Major version number times 100 plus minor version number. Version 5.0 is 500. Version 5.1 (5.01) is 501. Read-only. "version" also works, for backwards compatibility. Use has() to check if a certain patch was included, e.g.:
if has("patch-7.4.123")Note that patch numbers are specific to the version, thus both version 5.0 and 5.1 may have a patch 123, but these are completely different.
v:vim_did_enter vim_did_enter-variable v:vim_did_enter Zero until most of startup is done. It is set to one just before VimEnter autocommands are triggered.
v:warningmsg warningmsg-variable v:warningmsg Last given warning message. It's allowed to set this variable.
v:windowid windowid-variable v:windowid Application-specific window "handle" which may be set by any attached UI. Defaults to zero. Note: For Nvim windows use winnr() or win_getid(), see window-ID.
4. Builtin Functions functions
See function-list for a list grouped by what the function is used for. (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({list}, {item}) List append {item} to List {list} and({expr}, {expr}) Number bitwise AND api_info() Dict api metadata append({lnum}, {string}) Number append {string} below line {lnum} append({lnum}, {list}) Number append lines {list} below line {lnum} argc() 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}) String {nr} entry of the argument list argv() List the argument list assert_equal({exp}, {act} [, {msg}]) none assert {exp} is equal to {act} assert_exception({error} [, {msg}]) none assert {error} is in v:exception assert_fails({cmd} [, {error}]) none assert {cmd} fails assert_false({actual} [, {msg}]) none assert {actual} is false assert_inrange({lower}, {upper}, {actual} [, {msg}]) none assert {actual} is inside the range assert_match({pat}, {text} [, {msg}]) none assert {pat} matches {text} assert_notequal({exp}, {act} [, {msg}]) none assert {exp} is not equal {act} assert_notmatch({pat}, {text} [, {msg}]) none assert {pat} not matches {text} assert_report({msg}) none report a test failure assert_true({actual} [, {msg}]) none assert {actual} is true asin({expr}) Float arc sine of {expr} atan({expr}) Float arc tangent of {expr} atan2({expr}, {expr}) Float arc tangent of {expr1} / {expr2} browse({save}, {title}, {initdir}, {default}) String put up a file requester browsedir({title}, {initdir}) String put up a directory requester bufexists({expr}) Number TRUE if buffer {expr} exists buflisted({expr}) Number TRUE if buffer {expr} is listed bufloaded({expr}) Number TRUE if buffer {expr} is loaded bufname({expr}) String Name of the buffer {expr} bufnr({expr} [, {create}]) Number Number of the buffer {expr} bufwinid({expr}) Number window-ID of buffer {expr} bufwinnr({expr}) Number window number of buffer {expr} byte2line({byte}) Number line number at byte count {byte} byteidx({expr}, {nr}) Number byte index of {nr}'th char in {expr} byteidxcomp({expr}, {nr}) 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 changenr() Number current change number chanclose({id}[, {stream}]) Number Closes a channel or one of its streams chansend({id}, {data}) Number Writes {data} to channel char2nr({expr}[, {utf8}]) Number ASCII/UTF8 value of first char in {expr} cindent({lnum}) Number C indent for line {lnum} clearmatches() none clear all matches col({expr}) Number column nr 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 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({list}, {expr} [, {ic} [, {start}]]) Number count how many {expr} are in {list} 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} deepcopy({expr} [, {noref}]) any make a full copy of {expr} delete({fname} [, {flags}]) Number delete the file or directory {fname} dictwatcheradd({dict}, {pattern}, {callback}) Start watching a dictionary dictwatcherdel({dict}, {pattern}, {callback}) Stop watching a dictionary did_filetype() Number TRUE if FileType autocommand event used diff_filler({lnum}) Number diff filler lines about {lnum} diff_hlID({lnum}, {col}) Number diff highlighting at {lnum}/{col} empty({expr}) Number TRUE if {expr} is empty 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 and capture output of {command} exepath({expr}) String full path of the command {expr} exists({expr}) Number TRUE if {expr} exists extend({expr1}, {expr2} [, {expr3}]) List/Dict insert items of {expr2} into {expr1} exp({expr}) Float exponential of {expr} expand({expr} [, {nosuf} [, {list}]]) any expand special keywords in {expr} feedkeys({string} [, {mode}]) Number add key sequence to typeahead buffer 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 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} 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} foreground() Number bring the Vim window to the foreground 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([{expr}]) List information about buffers getbufline({expr}, {lnum} [, {end}]) List lines {lnum} to {end} of buffer {expr} getbufvar({expr}, {varname} [, {def}]) any variable {varname} in buffer {expr} getchar([expr]) Number get one character from the user getcharmod() Number modifiers for the last typed character getcharsearch() Dict last character search getcmdline() String return the current command-line getcmdpos() Number return cursor position in command-line 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() List position of the cursor getcwd([{winnr} [, {tabnr}]]) String get the current working directory 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} getline({lnum}) String line {lnum} of current buffer getline({lnum}, {end}) List lines {lnum} to {end} of current buffer getloclist({nr} [, {what}]) List list of location list items getmatches() List list of current matches getpid() Number process ID of Vim getpos({expr}) List position of cursor, mark, etc. getqflist([{what}]) List list of quickfix items getreg([{regname} [, 1 [, {list}]]]) String or List contents of register getregtype([{regname}]) String type of register 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} getwininfo([{winid}]) List list of windows getwinposx() Number X coord in pixels of GUI Vim window getwinposy() Number Y coord in pixels of GUI 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}) Number TRUE if feature {feature} supported has_key({dict}, {key}) Number TRUE if {dict} has entry {key} haslocaldir([{winnr} [, {tabnr}]]) Number TRUE if current window executed :lcd hasmapto({what} [, {mode} [, {abbr}]]) Number TRUE if mapping to {what} exists histadd({history}, {item}) String add an item to a history histdel({history} [, {item}]) String 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 hlexists({name}) Number TRUE if highlight group {name} exists hlID({name}) Number syntax ID of highlight group {name} 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({list}, {expr} [, {start} [, {ic}]]) Number index in {list} where {expr} appears input({prompt} [, {text} [, {completion}]]) String get input from the user inputdialog({prompt} [, {text} [, {completion}]]) 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({list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}] invert({expr}) Number bitwise invert isdirectory({directory}) Number TRUE if {directory} is a directory islocked({expr}) Number TRUE if {expr} is locked id({expr}) String identifier of the container items({dict}) List key-value pairs in {dict} jobpid({id}) Number Returns pid of a job. jobresize({id}, {width}, {height}) Number Resize pseudo terminal window of a job jobstart({cmd}[, {opts}]) Number Spawns {cmd} as a job jobstop({id}) Number Stops a job jobwait({ids}[, {timeout}]) Number Wait for a set of jobs join({list} [, {sep}]) String join {list} items into one String json_decode({expr}) any Convert {expr} from JSON json_encode({expr}) String Convert {expr} to JSON keys({dict}) List keys in {dict} 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}) 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} 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 change each item in {expr1} to {expr} 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} match({expr}, {pat}[, {start}[, {count}]]) Number position where {pat} matches in {expr} matchadd({group}, {pattern}[, {priority}[, {id}]]) Number highlight {pattern} with {group} matchaddpos({group}, {list}[, {priority}[, {id}]]) Number highlight positions with {group} matcharg({nr}) List arguments of :match matchdelete({id}) Number delete match identified by {id} matchend({expr}, {pat}[, {start}[, {count}]]) Number position where {pat} ends in {expr} 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} matchstrpos({expr}, {pat}[, {start}[, {count}]]) List {count}'th match of {pat} in {expr} max({expr}) Number maximum value of items in {expr} min({expr}) Number minimum value of items in {expr} mkdir({name} [, {path} [, {prot}]]) Number create directory {name} mode([expr]) String current editing mode msgpackdump({list}) List dump a list of objects to msgpack msgpackparse({list}) List parse msgpack to a list of objects nextnonblank({lnum}) Number line nr of non-blank line >= {lnum} nr2char({expr}[, {utf8}]) String single char with ASCII/UTF8 value {expr} nvim_...({args}...) any call nvim api functions or({expr}, {expr}) Number bitwise OR pathshorten({expr}) String shorten directory names in a path 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 pumvisible() Number whether popup menu is visible pyeval({expr}) any evaluate Python expression py3eval({expr}) any evaluate python3 expression range({expr} [, {max} [, {stride}]]) List items from {expr} to {max} readfile({fname} [, {binary} [, {max}]]) List get list of lines from file {fname} 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 remove({list}, {idx} [, {end}]) any remove items {idx}-{end} from {list} remove({dict}, {key}) any remove entry {key} from {dict} rename({from}, {to}) Number rename (move) file from {from} to {to} repeat({expr}, {count}) String repeat {expr} {count} times resolve({filename}) String get filename a shortcut points to reverse({list}) List reverse {list} in-place round({expr}) Float round off {expr} rpcnotify({channel}, {event}[, {args}...]) Sends an RPC notification to {channel} rpcrequest({channel}, {method}[, {args}...]) Sends an RPC request to {channel} screenattr({row}, {col}) Number attribute at screen position screenchar({row}, {col}) Number character at screen position screencol() Number current cursor column screenrow() Number current cursor row search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) Number search for {pattern} 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}]]]) List search for {pattern} server2client({clientid}, {string}) Number send reply string serverlist() String get a list of available servers setbufvar({expr}, {varname}, {val}) set {varname} in buffer {expr} to {val} setcharsearch({dict}) Dict set character search from {dict} setcmdpos({pos}) Number set cursor position in command-line setfperm({fname}, {mode} Number set {fname} file permissions to {mode} setline({lnum}, {line}) Number set line {lnum} to {line} setloclist({nr}, {list}[, {action}[, {what}]]) Number modify location list using {list} setmatches({list}) Number restore a list of matches setpos({expr}, {list}) Number set the {expr} position to {list} setqflist({list}[, {action}[, {what}]] Number modify quickfix list using {list} setreg({n}, {v}[, {opt}]) Number set register to value and type settabvar({nr}, {varname}, {val}) set {varname} in tab page {nr} to {val} settabwinvar({tabnr}, {winnr}, {varname}, {val}) set {varname} in window {winnr} in tab page {tabnr} to {val} setwinvar({nr}, {varname}, {val}) 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() Number effective value of 'shiftwidth' simplify({filename}) String simplify filename as much as possible sin({expr}) Float sine of {expr} sinh({expr}) Float hyperbolic sine of {expr} sockconnect({mode}, {address} [, {opts}]) Number Connects to socket sort({list} [, {func} [, {dict}]]) List sort {list}, using {func} to compare 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} stdioopen({dict}) Number open stdio in a headless instance. str2float({expr}) Float convert String to Float str2nr({expr} [, {base}]) Number convert String to Number strchars({expr} [, {skipcc}]) Number character length of the String {expr} strcharpart({str}, {start} [, {len}]) String {len} characters of {str} at {start} strdisplaywidth({expr} [, {col}]) Number display length of the String {expr} strftime({format} [, {time}]) String time in 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}]) String {len} characters of {str} at {start} strridx({haystack}, {needle} [, {start}]) Number last index of {needle} in {haystack} strtrans({expr}) String translate string to make it printable strwidth({expr}) Number display cell length of the String {expr} submatch({nr} [, {list}]) String or List specific match in ":s" or substitute() substitute({expr}, {pat}, {sub}, {flags}) String all {pat} in {expr} replaced with {sub} 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({cmd} [, {input}]) String output of shell command/filter {cmd} systemlist({cmd} [, {input}]) List output of shell command/filter {cmd} 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 taglist({expr}[, {filename}]) List list of tags matching {expr} tagfiles() List tags files used tan({expr}) Float tangent of {expr} tanh({expr}) Float hyperbolic tangent of {expr} tempname() String name for a temporary file test_garbagecollect_now() none free memory right now 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} trunc({expr}) Float truncate Float {expr} type({name}) Number type of variable {name} undofile({name}) String undo file name for {name} undotree() List undo file tree uniq({list} [, {func} [, {dict}]]) List remove adjacent duplicates from a list values({dict}) List values in {dict} virtcol({expr}) Number screen column of cursor or mark visualmode([expr]) String last visual mode used wildmenumode() Number whether 'wildmenu' mode is active win_findbuf({bufnr}) List find windows containing {bufnr} win_getid([{win} [, {tab}]]) Number get window-ID for {win} in {tab} win_gotoid({expr}) Number go to window-ID {expr} win_id2tabwin({expr}) List get tab and window nr from window-ID win_id2win({expr}) Number get window nr from window-ID winbufnr({nr}) Number buffer number of window {nr} wincol() Number window column of the cursor winheight({nr}) Number height of window {nr} 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({list}, {fname} [, {flags}]) Number write list of lines to file {fname} xor({expr}, {expr}) Number bitwise XOR
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. Examples:
echo abs(1.456)1.456
echo abs(-5.456)5.456
echo abs(-4)4
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]. Examples:
echo acos(0)1.570796
echo acos(-0.5)2.094395
add({list}, {expr}) add() Append the item {expr} to List {list}. Returns the resulting List. 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. Use insert() to add an item at another position.
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. Example:
let flag = and(bits, 0x80)api_info() api_info() Returns Dictionary of api-metadata.
append({lnum}, {expr}) append() When {expr} is a List: Append each item of the List as a text line below line {lnum} in the current buffer. Otherwise append {expr} as one text line below line {lnum} in the current buffer. {lnum} can be zero to insert a line before the first one. Returns 1 for failure ({lnum} out of range or out of memory), 0 for success. Example:
let failed = append(line('$'), "# THE END")let failed = append(0, ["Chapter 1", "the beginning"])
argc() argc() The result is the number of files in the argument list of the current window. See arglist.
argidx() argidx() The result is the current index in the argument list. 0 is the first file. argc() - 1 is the last one. See arglist.
arglistid() 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. Return -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 page. {winnr} can be the window number or the window-ID.
argv() argv([{nr}]) The result is the {nr}th file in the argument list of the current window. See arglist. "argv(0)" is the first one. Example:
let i = 0while i < argc()let f = escape(fnameescape(argv(i)), '.')exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'let i = i + 1endwhile
Without the {nr} argument a List with the whole arglist is returned.
assert_equal() assert_equal({expected}, {actual}, [, {msg}]) When {expected} and {actual} are not equal an error message is added to v:errors. There is no automatic conversion, 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 always matters. When {msg} is omitted an error in the form "Expected {expected} but got {actual}" is produced. Example:
assert_equal('foo', 'bar')Will result in a string to be added to v:errors: test.vim line 12: Expected 'foo' but got 'bar'
assert_exception({error} [, {msg}]) assert_exception() When v:exception does not contain the string {error} an error message is added to v:errors. This can be used to assert that a command throws an exception. Using the error number, followed by a colon, avoids problems with translations:
trycommandthatfailscall assert_false(1, 'command should have failed')catchcall assert_exception('E492:')endtry
assert_fails({cmd} [, {error}]) assert_fails() Run {cmd} and add an error message to v:errors if it does NOT produce an error. When {error} is given it must match in v:errmsg.
assert_false({actual} [, {msg}]) assert_false() When {actual} is not false an error message is added to v:errors, like with assert_equal(). A value is false when it is zero or v:false. When "{actual}" is not a number or v:false the assert fails. When {msg} is omitted an error in the form "Expected False but got {actual}" is produced.
assert_inrange({lower}, {upper}, {actual} [, {msg}]) assert_inrange() This asserts number values. When {actual} is lower than {lower} or higher than {upper} an error message is added to v:errors. When {msg} is omitted an error in the form "Expected range {lower} - {upper}, but got {actual}" is produced.
assert_match() assert_match({pattern}, {actual} [, {msg}]) When {pattern} does not match {actual} an error message is added to v:errors. {pattern} is used as with =~: The matching is always done like 'magic' was set and 'cpoptions' is empty, no matter what the actual value of 'magic' or 'cpoptions' is. {actual} is used as a string, automatic conversion applies. Use "^" and "$" to match with the start and end of the text. Use both to match the whole text. When {msg} is omitted an error in the form "Pattern {pattern} does not match {actual}" is produced. Example:
assert_match('^f.*o$', 'foobar')Will result in a string to be added to v:errors: test.vim line 12: Pattern '^f.*o$' does not match 'foobar'
assert_notequal() assert_notequal({expected}, {actual} [, {msg}]) The opposite of assert_equal(): add an error message tov:errors when {expected} and {actual} are equal.
assert_notmatch() assert_notmatch({pattern}, {actual} [, {msg}]) The opposite of assert_match(): add an error message tov:errors when {pattern} matches {actual}.
assert_report({msg}) assert_report() Report a test failure directly, using {msg}.
assert_true({actual} [, {msg}]) assert_true() When {actual} is not true an error message is added to v:errors, like with assert_equal(). A value is TRUE when it is a non-zero number or v:true. When {actual} is not a number or v:true the assert fails. When {msg} is omitted an error in the form "Expected True but got {actual}" is produced.
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]. Examples:
echo asin(0.8)0.927295
echo asin(-0.5)-0.523599
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. Examples:
echo atan(100)1.560797
echo atan(-4.01)-1.326405
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. Examples:
echo atan2(-1, 1)-0.785398
echo atan2(1, -1)2.356194
browse() browse({save}, {title}, {initdir}, {default}) 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 When the "Cancel" button is hit, something went wrong, or browsing is not possible, an empty string is returned.
browsedir() browsedir({title}, {initdir}) 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.
bufexists({expr}) bufexists() The result is a Number, which is TRUE if a buffer called {expr} exists. If the {expr} argument is a number, buffer numbers are used. If the {expr} 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.
buflisted({expr}) buflisted() The result is a Number, which is TRUE if a buffer called {expr} exists and is listed (has the 'buflisted' option set). The {expr} argument is used like with bufexists().
bufloaded({expr}) bufloaded() The result is a Number, which is TRUE if a buffer called {expr} exists and is loaded (shown in a window or hidden). The {expr} argument is used like with bufexists().
bufname({expr}) bufname() The result is the name of a buffer, as it is displayed by the ":ls" command. If {expr} is a Number, that buffer number's name is given. Number zero is the alternate buffer for the current window. If {expr} 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 pattern. 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 {expr} 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)If the buffer doesn't exist, or doesn't have a name, an empty string is returned.
bufname("#") alternate buffer namebufname(3) name of buffer 3bufname("%") name of current bufferbufname("file2") name of buffer where "file2" matches.
bufnr() bufnr({expr} [, {create}]) The result is the number of a buffer, as it is displayed by the ":ls" command. For the use of {expr}, see bufname() above. If the buffer doesn't exist, -1 is returned. Or, if the {create} argument is present and not zero, a new, unlisted, buffer is created and its number is returned. 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.
bufwinid({expr}) bufwinid() The result is a Number, which is the window-ID of the first window associated with buffer {expr}. For the use of {expr}, see bufname() above. If buffer {expr} 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.
bufwinnr({expr}) bufwinnr() The result is a Number, which is the number of the first window associated with buffer {expr}. For the use of {expr}, see bufname() above. If buffer {expr} 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" :wincmd. Only deals with the current tab page.
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 one. Also see line2byte(), go and :goto.
byteidx({expr}, {nr}) byteidx() Return byte index of the {nr}'th character in the string {expr}. Use zero for the first character, it returns zero. This function is only useful when there are multibyte characters, otherwise 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 separately. Example :
echo matchstr(str, ".", byteidx(str, 3))will display the fourth character. Another way to do the same:
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.
byteidxcomp({expr}, {nr}) 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).
call({func}, {arglist} [, {dict}]) call() E699 Call function {func} with the items in List {arglist} as arguments. {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
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. Examples:
echo ceil(1.456)2.0
echo ceil(-5.456)-5.0
echo ceil(4.0)4.0
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.
chanclose({id}[, {stream}]) {Nvim} chanclose() Close a channel or a specific stream associated with it. For a job, {stream} can be one of "stdin", "stdout", "stderr" or "rpc" (closes stdin/stdout for a job started with "rpc":v:true) If {stream} is omitted, all streamsare closed. If the channel is a pty, this will then close the pty master, sending SIGHUP to the job process. For a socket, there is only one stream, and {stream} should be ommited.
chansend({id}, {data}) {Nvim} chansend() Send data to channel {id}. For a job, it writes it to the stdin of the process. For the stdio channel channel-stdio, it writes to Nvim's stdout. Returns the number of bytes written if the write succeeded, 0 otherwise. See channel-bytes for more information. {data} may be a string, string convertible, or a list. If {data} is a list, the items will be joined by newlines; any newlines in an item will be sent as NUL. To send a final newline, include a final empty string. Example:
call chansend(id, ["abc", "123\n456", ""])will send "abc<NL>123<NUL>456<NL>". chansend() writes raw data, not RPC messages. If the channel was created with "rpc":v:truethen the channel expects RPCmessages, use rpcnotify() and rpcrequest() instead.
char2nr({expr} [, {utf8}]) char2nr() Return number value of the first char in {expr}. Examples:
char2nr(" ") returns 32char2nr("ABC") returns 65char2nr("á") returns 225char2nr("á"[0]) returns 195
Non-ASCII characters are always treated as UTF-8 characters. {utf8} has no effect, and exists only for backwards-compatibility. A combining character is a separate character. nr2char() does the opposite.
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.
clearmatches() clearmatches() Clears all matches previously defined by matchadd() and the :match commands.
col() col({expr}) The result is a Number, which is the byte index of the column position given with {expr}. The accepted positions are: . the cursor position $ the end of the cursor line (the result is the number of bytes in the cursor line plus one) 'x position of mark x (if the mark is not set, 0 is returned) v In Visual mode: the start of the Visual area (the cursor is the end). When not in Visual mode returns the cursor position. Differs from '< in that it's updated right away. 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. To get the line number use line(). To get both use getpos(). For the screen column position use virtcol(). Note that only marks in the current file can be used. Examples:
col(".") column of cursorcol("$") length of cursor line plus onecol("'t") column of mark tcol("'" . markname) column of mark markname
The first column is 1. 0 is returned for an error. For an uppercase mark the column may actually be in another buffer. For the cursor position, when 'virtualedit' is active, the column is one higher if the cursor is after the end of the line. This can be used to obtain the column in Insert mode:
:imap <F2> <C-O>:let save_ve = &ve<CR>\<C-O>:set ve=all<CR>\<C-O>:echo col(".") . "\n" <Bar>\let &ve = save_ve<CR>
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 match. {matches} must be a List. Each List item is one match. See complete-items for the kind of items that are possible. 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. Example:
inoremap <F5> <C-R>=ListMonths()<CR>func! ListMonths()call complete(col('.'), ['January', 'February', 'March',\ 'April', 'May', 'June', 'July', 'August', 'September',\ 'October', 'November', 'December'])return ''endfunc
This isn't very useful, but it shows how it works. Note that an empty string is returned to avoid a zero being inserted.
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.
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.
confirm() 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. {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. 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} argument gives the type of dialog. This is only used for the icon of the 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 used. 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 == 0echo "make up your mind!"elseif choice == 3echo "tasteful"elseecho "I prefer bananas myself."endif
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.
copy() copy({expr}) 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. Also see deepcopy().
cos({expr}) cos() Return the cosine of {expr}, measured in radians, as a Float. {expr} must evaluate to a Float or a Number. Examples:
echo cos(100)0.862319
echo cos(-4.01)-0.646043
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. Examples:
echo cosh(0.5)1.127626
echo cosh(-0.5)-1.127626
count({comp}, {expr} [, {ic} [, {start}]]) count() Return the number of times an item with value {expr} appears in List 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.
cscope_connection() 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 {dbpath}. 2 Ignore {prepend}, and use exact string matches for {dbpath}. 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 path0 27664 cscope.out /usr/local
Invocation Return Val ---------- ----------
cscope_connection() 1cscope_connection(1, "out") 1cscope_connection(2, "out") 0cscope_connection(3, "out") 0cscope_connection(3, "out", "local") 1cscope_connection(4, "out") 0cscope_connection(4, "out", "local") 0cscope_connection(4, "cscope.out", "/usr/local") 1
cursor({lnum}, {col} [, {off}]) cursor() cursor({list}) 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: [{lnum}, {col}] [{lnum}, {col}, {off}] [{lnum}, {col}, {off}, {curswant}] This is like the return value of getpos() or getcurpos(), but without the first item. Does not change the jumplist. 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 {lnum} is zero, the cursor will stay in the current line. If {col} is greater than the number of bytes in the line, the cursor will be positioned at the last character in the line. 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.
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, a copy for it is made, recursively. Thus changing an item in the copy does not change the contents of the original 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. E724 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().
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. A 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 if the delete operation was successful and -1 when the deletion failed or partly failed.
dictwatcheradd({dict}, {pattern}, {callback}) dictwatcheradd() Adds a watcher to a dictionary. A dictionary watcher is identified by three components: - A dictionary({dict}); - A key pattern({pattern}). - A function({callback}). After this is called, every change on {dict} and on keys matching {pattern} will result in {callback} being invoked. For example, to watch all global variables:
silent! call dictwatcherdel(g:, '*', 'OnDictChanged')function! OnDictChanged(d,k,z)echomsg string(a:k) string(a:z)endfunctioncall dictwatcheradd(g:, '*', 'OnDictChanged')
For now {pattern} only accepts very simple patterns that can contain a '*' at the end of the string, in which case it will match every key that begins with the substring before the '*'. That means if '*' is not the last character of {pattern}, only keys that are exactly equal as {pattern} will be matched. The {callback} receives three arguments: - The dictionary being watched. - The key which changed. - A dictionary containing the new and old values for the key. The type of change can be determined by examining the keys present on the third argument: - If contains both oldandnew, the key was updated.- If it contains only new, the key was added.- If it contains only old, the key was deleted.This function can be used by plugins to implement options with validation and parsing logic.
dictwatcherdel({dict}, {pattern}, {callback}) dictwatcherdel() Removes a watcher added with dictwatcheradd(). All three arguments must match the ones passed to dictwatcheradd() in order for the watcher to be successfully deleted.
did_filetype() 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 FALLBACKwas 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 file.
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.
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 line. The highlight ID can be used with synIDattr() to obtain syntax information about the highlighting.
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 items. A Number is empty when its value is zero. Special variable is empty when it is v:false or v:null.
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\\vimAlso see shellescape().
eval() 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 and composites of them. Also works for Funcrefs that refer to existing functions.
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.
executable({expr}) executable() This function checks if an executable with the name {expr} exists. {expr} must be the name of the program without any arguments. executable() uses the value of $PATH and/or the normal searchpath for programs. PATHEXT On 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 ".exe;.com;.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 Windows it only checks if the file exists and is not a directory, not if it's really executable. On Windows an executable in the same directory as Vim is always found. Since this directory is added to $PATH it should also work to execute it win32-PATH. The result is a Number: 1 exists 0 does not exist -1 not implemented on this system
execute({command} [, {silent}]) execute() Execute {command} and capture its output. If {command} is a String, returns {command} output. If {command} is a List, returns concatenated outputs. Examples:
echo execute('echon "foo"')foo
echo execute(['echon "foo"', 'echon "bar"'])foobar The optional {silent} argument can have these values: "" no :silentused"silent" :silentused"silent!" :silent!usedThe default is "silent". Note that with "silent!", unlike :redir, error messages are dropped.To get a list of lines use split() on the result:
split(execute('args'), "\n")This function is not available in the sandbox. Note: If nested, an outer execute() will not observe output of the inner calls. Note: Text attributes (highlights) are not captured.
exepath({expr}) exepath() Returns the full path of {expr} if it is an executable and given as a (partial or full) path or is found in $PATH. Returns empty string otherwise. If {expr} starts with "./" the current-directory is used.
exists() exists({expr}) The result is a Number, which is TRUE if {expr} is defined, zero otherwise. 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: &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 string) *funcname built-in function (see functions) or user defined function (see user-functions). Also works for a variable that is a Funcref. varname internal variable (see internal-variables). Also works for curly-braces-names, Dictionary entries, List items, etc. 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]")
0
echo exists("l[xx]")E121: Undefined variable: xx 0 :cmdname Ex command: built-in command, user command or command modifier :command. Returns: 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. #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 character) #group autocommand group exists #group#event autocommand defined for this group and event. #group#event#pattern autocommand defined for this group, event and pattern. ##event autocommand for this event is supported. Examples:
exists("&mouse")exists("$HOSTNAME")exists("*strftime")exists("*s:MyFunc")exists("bufcount")exists(":Make")exists("#CursorHold")exists("#BufReadPre#*.gz")exists("#filetypeindent")exists("#filetypeindent#FileType")exists("#filetypeindent#FileType#*")exists("##ColorScheme")
There must be no space between the symbol (&/$/*/#) and the name. There must be no extra characters after the name, although in a few cases this is ignored. That may become more strict in the future, thus don't count on it! Working example:
exists(":make")NOT working example:
exists(":make install")Note that the argument must be a string, not the name of the variable itself. For example:
exists(bufcount)This doesn't check for existence of the "bufcount" variable, but gets the value of "bufcount", and checks if that exists.
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. Examples:
echo exp(2)7.389056
echo exp(-1)0.367879
expand({expr} [, {nosuf} [, {list}]]) expand() Expand wildcards and the following special keywords in {expr}. '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 {expr} does not start with '%', '#' or '<', see below. When {expr} 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 <sfile> sourced script file or function name <slnum> sourced script file line number <cword> word under the cursor <cWORD> WORD under the cursor <client> the {clientid} of the last received message server2client() Modifiers: :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 Example:
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 {expr} 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 expr-env-expand. 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 "$FOOBAR". See glob() for finding existing files. See system() for getting the raw output of an external command.
extend({expr1}, {expr2} [, {expr3}]) extend() {expr1} and {expr2} must be both Lists or both Dictionaries. If they are Lists: Append {expr2} to {expr1}. If {expr3} is given insert the items of {expr2} before item {expr3} in {expr1}. When {expr3} is zero insert before the first item. When {expr3} is equal to len({expr1}) then {expr2} is appended. Examples:
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 fails. Returns {expr1}.
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 {string}. 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. If {mode} is absent, keys are remapped. {mode} is a String, which can contain these character flags: 'm' Remap keys. This is default. '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. '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. '!' 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.
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 glob().
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.
filter({expr1}, {expr2}) filter() {expr1} must be a List or a Dictionary. For each item in {expr1} evaluate {expr2} and when the result is zero remove the item from the List or Dictionary. {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 Dictionary v:key has the key of the current item. Examples:
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 == 1endfunccall filter(mylist, function('Odd'))
It is shorter when using a lambda:
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})The operation is done in-place. If you want a List or Dictionary to remain unmodified make a copy first:
let l = filter(copy(mylist), 'v:val =~ "KEEP"')Returns {expr1}, the List or Dictionary that was filtered. 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.
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. This is quite similar to the ex-command :find. {only available when compiled with the +file_in_path feature}
findfile({name} [, {path} [, {count}]]) findfile() Just like finddir(), but find a file instead of a directory. Uses 'suffixesadd'. Example:
echo findfile("tags.vim", ".;")Searches from the directory of the current file upwards until it finds the file "tags.vim".
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. 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). Examples:
echo float2nr(3.95)3
echo float2nr(-23.45)-23
echo float2nr(1.0e100)2147483647 (or 9223372036854775807)
echo float2nr(-1.0e150)-2147483647 (or -9223372036854775807)
echo float2nr(1.0e-100)0
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. Examples:
echo floor(1.856)1.0
echo floor(-5.456)-6.0
echo floor(4.0)4.0
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. Examples:
echo fmod(12.33, 1.22)0.13
echo fmod(-12.33, 1.22)-0.13
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). Example:
let fname = '+some str%nge|name'exe "edit " . fnameescape(fname)
results in executing:
edit \+some\ str\%nge\|namefnamemodify({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. Example:
echo fnamemodify("main.c", ":p:h")results in:
/home/mool/vim/vim/srcNote: Environment variables don't work in {fname}, use expand() first then.
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.
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.
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.
foldtext() 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:foldstart, v:foldend and v:folddashes variables. The returned string looks like this:
+-- 45 lines: abcdefThe 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' setting. {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 returned. {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}
foreground() 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. {only in the Win32 GUI and console version}
funcref() funcref({name} [, {arglist}] [, {dict}]) 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. Also for autoloaded functions. {name} cannot be a builtin function.
function() E700 E922 E923 function({name} [, {arglist}] [, {dict}]) Return a Funcref variable that refers to function {name}. {name} can be 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 mans 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. Example:
func Callback(arg1, arg2, name)...let Func = function('Callback', ['one', 'two'])...call Func('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() dictecho "called for " . self.nameendfunction...let context = {"name": "example"}let Func = function('Callback', context)...call Func() " will echo: called for example
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)garbagecollect([{atexit}]) garbagecollect() Cleanup unused Lists and Dictionaries 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 test_garbagecollect_now().
get({list}, {idx} [, {default}]) get() Get item {idx} from List {list}. When this item is not available return {default}. Return zero when {default} is omitted. 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. get({func}, {what}) 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
getbufinfo() getbufinfo([{expr}]) getbufinfo([{dict}]) Get information about buffers as a List of Dictionaries. Without an argument information about all the buffers is returned. 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. Otherwise, {expr} specifies a particular buffer to return information for. For the use of {expr}, 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 entries: bufnr buffer number. changed TRUE if the buffer is modified. changedtick number of changes made to the buffer. hidden TRUE if the buffer is hidden. listed TRUE if the buffer is listed. lnum current line number in buffer. 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 buffer Examples:
for buf in getbufinfo()echo buf.nameendforfor buf in getbufinfo({'buflisted':1})if buf.changed....endifendfor
To get buffer-local options use:
getbufvar({bufnr}, '&')getbufline() getbufline({expr}, {lnum} [, {end}]) Return a List with the lines starting from {lnum} to {end} (inclusive) in the buffer {expr}. If {end} is omitted, a List with only the line {lnum} is returned. For the use of {expr}, 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 returned. This function works only for loaded buffers. For unloaded and non-existing buffers, an empty List is returned. Example:
let lines = getbufline(bufnr("myfile"), 1, "$")getbufvar({expr}, {varname} [, {def}]) getbufvar() The result is the value of option or local buffer variable {varname} in buffer {expr}. Note that the name without "b:" must be used. 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 {expr}, see bufname() above. When the buffer or variable doesn't exist {def} or an empty string is returned, there is no error message. Examples:
let bufmodified = getbufvar(1, "&mod")echo "todo myvar = " . getbufvar("todo", "myvar")
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. Without [expr] and when [expr] is 0 a whole character or special key is returned. If it is an 8-bit 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 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 sequence. 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_lnum, v:mouse_winid and v:mouse_win. This example positions the mouse as it would normally happen:
let c = getchar()if c == "\<LeftMouse>" && v:mouse_win > 0exe v:mouse_win . "wincmd w"exe v:mouse_lnumexe "normal " . v:mouse_col . "|"endif
There is no prompt, you will somehow have to make clear to the user that a character has to be typed. 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('$') - 1normal lif getline('.')[col('.') - 1] ==? cbreakendifendwhileendfunction
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()endwhilereturn cendfunction
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 (Macintosh only) Only the modifiers that have not been included in the character itself are obtained. Thus Shift-a results in "A" without a modifier.
getcharsearch() getcharsearch() Return the current character search information as a {dict} with the following entries: char character previously used for a character search (t, f, T, 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().
getcmdline() getcmdline() Return the current command-line. Only works when the command line is being edited, thus requires use of c_CTRL-\_e or c_CTRL-R_=. Example:
cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>Also see getcmdtype(), getcmdpos() and setcmdpos().
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() and getcmdline().
getcmdtype() getcmdtype() Return the current command-line type. Possible return values are: : 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().
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.
getcompletion({pat}, {type} [, {filtered}]) getcompletion() Return a list of command-line completion matches. {type} specifies what for. The following completion types are supported: augroup autocmd groups buffer buffer names behave :behave suboptions cmdline cmdline-completion color color schemes command Ex command (and arguments) compiler compilers cscope :cscope suboptions 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 locale locale names (as output of locale -a) mapping mapping name menu menus messages :messages suboptions option options packadd optional package pack-add names 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 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 there are no matches, an empty list is returned. An invalid value for {type} produces an error.
getcurpos() getcurpos() Get the position of the cursor. This is like getpos('.'), but includes an extra item in the list: [bufnum, lnum, col, off, curswant]The "curswant" number is the preferred column when moving the cursor vertically. Also see getpos(). This can be used to save and restore the cursor position:
let save_cursor = getcurpos()MoveTheCursorAroundcall setpos('.', save_cursor)
Note that this only works within the window. See winrestview() for restoring more state.
getcwd([{winnr}[, {tabnr}]]) getcwd() With no arguments the result is a String, which is the name of the current effective working directory. With {winnr} or {tabnr} the working directory of that scope is returned. Tabs and windows are identified by their respective numbers, 0 means current tab or window. Missing argument implies 0. Thus the following are equivalent:
getcwd()getcwd(0)getcwd(0, 0)
If {winnr} is -1 it is ignored, only the tab is resolved. {winnr} can be the window number or the window-ID.
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.
getfontname([{name}]) getfontname() Without an argument returns the name of the normal font being used. Like what is used for the Normal highlight group hl-Normal. With an argument a check is done whether {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.
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("~/.config/nvim/init.vim"))
This will hopefully (from a security point of view) display the string "rw-r--r--" or even "rw-------". For setting permissions use setfperm().
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.
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 results: Normal file "file" Directory "dir" Symbolic link "link" Block device "bdev" Character device "cdev" Socket "socket" FIFO "fifo" All other "other" Example:
getftype("/home")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".
getline() getline({lnum} [, {end}]) Without {end} the result is a String, which is line {lnum} from the current buffer. Example:
getline(1)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:
getline(".")When {lnum} is 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. Example:
let start = line('.')let end = search("^$") - 1let lines = getline(start, end)
To get lines from another buffer see getbufline()
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}.
getmatches() getmatches() Returns a List with all matches previously defined by matchadd() and the :match commands. getmatches() is useful in combination with setmatches(), as setmatches() can restore a list of matches saved by getmatches(). Example:
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 mgetpid() getpid() Return a Number which is the process ID of the Vim process. This is a unique number, until Vim exits.
getpos() getpos({expr}) Get the position for {expr}. For possible values of {expr} see line(). For getting the cursor position see getcurpos(). 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 character. 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. 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 getcurpos() and setpos().
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 lnum line number in the buffer (first line is 1) col column number (first column is 1) 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 When there is no error list or it's empty, an empty list is returned. Quickfix list entries with non-existing buffer number are returned with "bufnr" set to zero. Useful application: Find pattern matches in multiple files and do something with them:
vimgrep /theword/jg *.cfor d in getqflist()echo bufname(d.bufnr) ':' d.lnum '=' d.textendfor
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}: context get the context stored with setqflist() items quickfix list entries nr get information for this quickfix list; zero means the current quickfix list and '$' means the last quickfix list title get the list title winid get the window-ID (if opened) all all of the above quickfix properties Non-string items in {what} are ignored. If "nr" is not present then the current quickfix list 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. In case of error processing {what}, an empty dictionary is returned. The returned dictionary contains the following entries: context context information stored with setqflist() items quickfix list entries nr quickfix list number title quickfix list title text winid quickfix window-ID (if opened) Examples:
echo getqflist({'all': 1})echo getqflist({'nr': 2, 'title': 1})
getreg([{regname} [, 1 [, {list}]]]) getreg() The result is a String, which is the contents of register {regname}. Example:
let cliptext = getreg('*')When {regname} was not set the result is an empty string. 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 not specified, v:register is used.
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. If {regname} is not specified, v:register is used.
gettabinfo([{arg}]) gettabinfo() If {arg} is not specified, then information about all the tab pages is returned as a List. Each List item is a Dictionary. Otherwise, {arg} 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 tag page.
gettabvar({tabnr}, {varname} [, {def}]) gettabvar() Get the value of a tab-local variable {varname} in tab page {tabnr}. t:var Tabs are numbered starting with one. 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.
gettabwinvar({tabnr}, {winnr}, {varname} [, {def}]) gettabwinvar() Get the value of window-local variable {varname} in window {winnr} in tab page {tabnr}. 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. Examples:
let list_is_on = gettabwinvar(1, 2, '&list')echo "myvar = " . gettabwinvar(3, 1, 'myvar')
getwinposx() getwinposx() The result is a Number, which is the X coordinate in pixels of the left hand side of the GUI Vim window. The result will be -1 if the information is not available. The value can be used with :winpos.
getwinposy() getwinposy() The result is a Number, which is the Y coordinate in pixels of the top of the GUI Vim window. The result will be -1 if the information is not available. The value can be used with :winpos.
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. 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: bufnr number of buffer in the window height window height (excluding winbar) winbar 1 if the window has a toolbar, 0 otherwise loclist 1 if showing a location list quickfix 1 if quickfix or location list window tabnr tab page number variables a reference to the dictionary with window-local variables width window width winid window-ID winnr window number To obtain all window-local variables use:
gettabwinvar({tabnr}, {winnr}, '&')getwinvar({winnr}, {varname} [, {def}]) getwinvar() Like gettabwinvar() for the current tabpage. Examples:
let list_is_on = getwinvar(2, '&list')echo "myvar = " . getwinvar(1, 'myvar')
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. 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.
glob2regpat({expr}) 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 {expr} 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 patch separator.
globpath() globpath({path}, {expr} [, {nosuf} [, {list} [, {allinks}]]]) Perform glob() 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){allinks} 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.
has() has({feature}) The result is a Number, which is 1 if the feature {feature} is supported, zero otherwise. The {feature} argument is a string. See feature-list below. Also see exists().
has_key({dict}, {key}) has_key() The result is a Number, which is 1 if Dictionary {dict} has an entry with key {key}. Zero otherwise.
haslocaldir([{winnr}[, {tabnr}]]) haslocaldir() The result is a Number, which is 1 when the tabpage or window has set a local path via :tcd or :lcd, otherwise 0. Tabs and windows are identified by their respective numbers, 0 means current tab or window. Missing argument implies 0. Thus the following are equivalent:
haslocaldir()haslocaldir(0)haslocaldir(0, 0)
With {winnr} use that window in the current tabpage. With {winnr} and {tabnr} use the window in that tabpage. {winnr} can be the window number or the window-ID. If {winnr} is -1 it is ignored, only the tab is resolved.
hasmapto({what} [, {mode} [, {abbr}]]) hasmapto() The result is a Number, which is 1 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}. 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 0 is returned. The following characters are recognized in {mode}: n Normal mode v Visual 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 \ABCdoitendif
This installs the mapping to "\ABCdoit" only if there isn't already a mapping to "\ABCdoit".
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: 1 if the operation was successful, otherwise 0 is returned. Example:
call histadd("input", strftime("%Y %b %d"))let date=input("Enter date: ")
This function is not available in the sandbox.
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 a Number: 1 for a successful operation, otherwise 0 is returned. Examples: 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)
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. Examples: 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>)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. Example:
let inp_index = histnr("expr")hlexists({name}) hlexists() The result is a Number, which is non-zero 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 item.
hlID() hlID({name}) 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")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.
iconv({expr}, {from}, {to}) iconv() The result is a String, which is the text {expr} 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. 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. {only available when compiled with the +multi_byte feature}
indent() indent({lnum}) 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 getline(). When {lnum} is invalid -1 is returned.
index({list}, {expr} [, {start} [, {ic}]]) index() Return the lowest index in List {list} 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 always matters. 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 {list}. Example:
let idx = index(words, "the")if index(numbers, 123) >= 0
input({prompt} [, {text} [, {completion}]]) input() input({opts}) 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. In the second form it accepts a single dictionary with the following keys, any of which may be omitted: Key Default Description prompt "" Same as {prompt} in the first form. default "" Same as {text} in the first form. completion nothing Same as {completion} in the first form. cancelreturn "" Same as {cancelreturn} from inputdialog(). Also works with input(). highlight nothing Highlight handler: Funcref. 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(). Example:
if input("Coffee or beer? ") == "beer"echo "Cheers!"endif
If the optional {text} argument is present and not empty, this is used for the default reply, as if the user typed this. Example:
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")input()-highlight E5400 E5402 The optional highlightkey allows specifying function whichwill be used for highlighting user input. This function receives user input as its only argument and must return a list of 3-tuples [hl_start_col, hl_end_col + 1, hl_group] where hl_start_col is the first highlighted column, hl_end_col is the last highlighted column (+ 1!), hl_group is :hl group used for highlighting. E5403 E5404 E5405 E5406 Both hl_start_col and hl_end_col + 1 must point to the start of the multibyte character (highlighting must not break multibyte characters), hl_end_col + 1 may be equal to the input length. Start column must be in range [0, len(input)), end column must be in range (hl_start_col, len(input)], sections must be ordered so that next hl_start_col is greater then or equal to previous hl_end_col. Example (try some input with parentheses):
highlight RBP1 guibg=Red ctermbg=redhighlight RBP2 guibg=Yellow ctermbg=yellowhighlight RBP3 guibg=Green ctermbg=greenhighlight RBP4 guibg=Blue ctermbg=bluelet g:rainbow_levels = 4function! RainbowParens(cmdline)let ret = []let i = 0let lvl = 0while i < len(a:cmdline)if a:cmdline[i] is# '('call add(ret, [i, i + 1, 'RBP' . ((lvl % g:rainbow_levels) + 1)])let lvl += 1elseif a:cmdline[i] is# ')'let lvl -= 1call add(ret, [i, i + 1, 'RBP' . ((lvl % g:rainbow_levels) + 1)])endiflet i += 1endwhilereturn retendfunctioncall input({'prompt':'>','highlight':'RainbowParens'})
Highlight function is called at least once for each new displayed input string, before command-line is redrawn. It is expected that function is pure for the duration of one input() call, i.e. it produces the same output for the same input, so output may be memoized. Function is run like under :silent modifier. If the function causes any errors, it will be skipped for the duration of the current input() call. Highlighting is disabled if command-line contains arabic characters. 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()endfunction
inputdialog({prompt} [, {text} [, {cancelreturn}]]) inputdialog() inputdialog({opts}) Like input(), but when the GUI is running and text dialogs are supported, a dialog window pops up to input the text. Example:
let n = inputdialog("value for shiftwidth", shiftwidth())if n != ""let &sw = nendif
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.
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. 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. Example:
let color = inputlist(['Select color:', '1. red',\ '2. green', '3. blue'])
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 1 when there is nothing to restore, 0 otherwise.
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 1 when out of memory, 0 otherwise.
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.
insert({list}, {item} [, {idx}]) insert() Insert {item} at the start of List {list}. 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. 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.
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)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.
islocked({expr}) islocked() E786 The result is a Number, which is TRUE when {expr} is the name of a locked variable. {expr} must be the name of a variable, List item or Dictionary entry, not the variable itself! Example:
let alist = [0, ['a', 'b'], 2, 3]lockvar 1 alistecho islocked('alist') " 1echo islocked('alist[1]') " 0
When {expr} is a variable that does not exist you get an error message. Use exists() to check for existence.
id({expr}) id() Returns a String which is a unique identifier of the container type (List, Dict and Partial). It is guaranteed that for the mentioned types id(v1) ==# id(v2)returns true iff type(v1) == type(v2) && v1 is v2(note:v:_null_list and v:_null_dict have the same id()withdifferent types because they are internally represented as a NULL pointers). Currently id()returns a hexadecimalrepresentanion of the pointers to the containers (i.e. like 0x994a40), same asprintf("%p", {expr}), but it is advisedagainst counting on exact format of return value. It is not guaranteed that id(no_longer_existing_container)will not be equal to some other id(): new containers mayreuse identifiers of the garbage-collected ones.
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.
jobpid({job}) jobpid() Return the PID (process id) of job-id {job}.
jobresize({job}, {width}, {height}) jobresize() Resize the pseudo terminal window of job-id {job} to {width} columns and {height} rows. Fails if the job was not started with "pty":v:true.
jobstart({cmd}[, {opts}]) jobstart() Spawns {cmd} as a job. If {cmd} is a List it runs directly (no 'shell'). If {cmd} is a String it runs in the 'shell', like this:
call jobstart(split(&shell) + split(&shellcmdflag) + ['{cmd}'])(See shell-unquoting for details.) Returns job-id on success, 0 on invalid arguments (or job table is full), -1 if {cmd}[0] or 'shell' is not executable. For communication over the job's stdio, it is represented as a channel, and a channel ID is returned on success. Use chansend() (or rpcnotify() and rpcrequest() if "rpc" option was used) to send data to stdin and chanclose() to close stdio streams without stopping the job explicitly. See job-control and rpc. NOTE: on Windows if {cmd} is a List: - cmd[0] must be an executable (not a "built-in"). If it is in $PATH it can be called by name, without an extension:
call jobstart(['ping', 'neovim.io'])If it is a full or partial path, extension is required:
call jobstart(['System32\ping.exe', 'neovim.io'])- {cmd} is collapsed to a string of quoted args as expected by CommandLineToArgvW https://msdn.microsoft.com/bb776391 unless cmd[0] is some form of "cmd.exe".
jobstart-options {opts} is a dictionary with these keys: on_stdout: stdout event handler (function name or Funcref) stdout_buffered : read stdout in buffered mode. on_stderr: stderr event handler (function name or Funcref) stderr_buffered : read stderr in buffered mode. on_exit : exit event handler (function name or Funcref) cwd : Working directory of the job; defaults to current-directory. rpc : If set, msgpack-rpc will be used to communicate with the job over stdin and stdout. "on_stdout" is then ignored, but "on_stderr" can still be used. pty : If set, the job will be connected to a new pseudo terminal and the job streams are connected to the master file descriptor. "on_stderr" is ignored, "on_stdout" receives all output. width : (pty only) Width of the terminal screen height : (pty only) Height of the terminal screen TERM : (pty only) $TERM environment variable detach : (non-pty only) Detach the job process from the nvim process. The process will not get killed when nvim exits. If the process dies before nvim exits, "on_exit" will still be invoked. {opts} is passed as self dictionary to the callback; the caller may set other keys to pass application-specific data. Returns: - The channel ID on success - 0 on invalid arguments - -1 if {cmd}[0] is not executable. See job-control, channels, and msgpack-rpc for more information.
jobstop({id}) jobstop() Stop job-id {id} by sending SIGTERM to the job process. If the process does not terminate after a timeout then SIGKILL will be sent. When the job terminates its on_exit handler (if any) will be invoked. See job-control.
jobwait({ids}[, {timeout}]) jobwait() Wait for a set of jobs to finish. The {ids} argument is a list of job-ids to wait for. {timeout} is the maximum number of milliseconds to wait. During jobwait(), callbacks for jobs not in the {ids} list may be invoked. The screen will not redraw unless :redraw is invoked by a callback. Returns a list of len({ids}) integers, where each integer is the wait-result of the corresponding job. Each wait-result is: Job exit-code, if the job exited -1 if the wait timed out for the job -2 if the job was interrupted -3 if the job-id is invalid.
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().
json_decode({expr}) json_decode() Convert {expr} from JSON object. Accepts readfile()-style list as the input, as well as regular string. May output any Vim value. In the following cases it will output msgpack-special-dict: 1. Dictionary contains duplicate key. 2. Dictionary contains empty key. 3. String contains NUL byte. Two special dictionaries: for dictionary and for string will be emitted in case string with NUL byte was a dictionary key. Note: function treats its input as UTF-8 always. The JSON standard allows only a few encodings, of which UTF-8 is recommended and the only one required to be supported. Non-UTF-8 characters are an error.
json_encode({expr}) json_encode() Convert {expr} into a JSON string. Accepts msgpack-special-dict as the input. Will not convert Funcrefs, mappings with non-string keys (can be created as msgpack-special-dict), values with self-referencing containers, strings which contain non-UTF-8 characters, pseudo-UTF-8 strings which contain codepoints reserved for surrogate pairs (such strings are not valid UTF-8 strings). Non-printable characters are converted into "\u1234" escapes or special escapes like "\t", other are dumped as-is.
keys({dict}) keys() Return a List with all the keys of {dict}. The List is in arbitrary order.
len() E701 len({expr}) The result is a Number, which is the length of the argument. When {expr} is a String or a Number the length in bytes is used, as with strlen(). When {expr} is a List the number of items in the List is returned. When {expr} is a Dictionary the number of entries in the Dictionary is returned. Otherwise an error is given.
libcall() E364 E368 libcall({libname}, {funcname}, {argument}) Call function {funcname} in the run-time library {libname} with single argument {argument}. This is useful to call functions in a library that you especially made to be used with Vim. Since only one argument is possible, calling standard library functions is rather limited. The result is the String returned by the function. If the function returns NULL, this will appear as an empty string "" to Vim. If the function returns a number, use libcallnr()! If {argument} is a number, it is passed to the function as an int; if {argument} is a string, it is passed as a null-terminated string. This function will fail in restricted-mode. libcall() allows you to write your own 'plug-in' extensions to Vim without having to recompile the program. It is NOT a means to call system functions! If you try to do so Vim will very probably crash. For Win32, the functions you write must be placed in a DLL and use the normal C calling convention (NOT Pascal which is used in Windows System DLLs). The function must take exactly one parameter, either a character pointer or a long integer, and must return a character pointer or NULL. The character pointer returned must point to memory that will remain valid after the function has returned (e.g. in static data in the DLL). If it points to allocated memory, that memory will leak away. Using a static buffer in the function should work, it's then freed when the DLL is unloaded. WARNING: If the function returns a non-valid pointer, Vim may crash! This also happens if the function returns a number, because Vim thinks it's a pointer. For Win32 systems, {libname} should be the filename of the DLL without the ".DLL" suffix. A full path is only required if the DLL is not in the usual places. For Unix: When compiling your own plugins, remember that the object code must be compiled as position-independent ('PIC'). {only in Win32 and some Unix versions, when the +libcall feature is present} Examples:
echo libcall("libc.so", "getenv", "HOME")libcallnr() libcallnr({libname}, {funcname}, {argument}) Just like libcall(), but used for a function that returns an int instead of a string. {only in Win32 on some Unix versions, when the +libcall feature is present} Examples:
echo libcallnr("/usr/lib/libc.so", "getpid", "")call libcallnr("libc.so", "printf", "Hello World!\n")call libcallnr("libc.so", "sleep", 10)
line() line({expr}) The result is a Number, which is the line number of the file position given with {expr}. The accepted positions are: . the cursor position $ the last line in the current buffer 'x position of mark x (if the mark is not set, 0 is returned) w0 first line visible in current window w$ last line visible in current window v In Visual mode: the start of the Visual area (the cursor is the end). When not in Visual mode returns the cursor position. Differs from '< 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. To get the column number use col(). To get both use getpos(). Examples:
line(".") line number of the cursorline("'t") line number of mark tline("'" . marker) line number of mark marker
last-position-jump This autocommand jumps to the last known position in a file just after opening it, if the '" mark is set:
:au BufReadPost *\ if line("'\"") > 1 && line("'\"") <= line("$") && &ft !~# 'commit'\ | exe "normal! g`\""\ | endif
line2byte({lnum}) line2byte() Return the byte count from the start of the buffer for line {lnum}. This includes the end-of-line character, depending on the 'fileformat' option for the current buffer. The first line returns 1. UTF-8 encoding is used, 'fileencoding' is ignored. This can also be used to get the byte count for the line just below the last line:
line2byte(line("$") + 1)This is the buffer size plus one. If 'fileencoding' is empty it is the file size plus one. When {lnum} is invalid -1 is returned. Also see byte2line(), go and :goto.
lispindent({lnum}) lispindent() Get the amount of indent for line {lnum} according the lisp indenting rules, as with 'lisp'. The indent is counted in spaces, the value of 'tabstop' is relevant. {lnum} is used just like in getline(). When {lnum} is invalid or Vim was not compiled the +lispindent feature, -1 is returned.
localtime() localtime() Return the current time, measured as seconds since 1st Jan 1970. See also strftime() and getftime().
log({expr}) log() Return the natural logarithm (base e) of {expr} as a Float. {expr} must evaluate to a Float or a Number in the range (0, inf]. Examples:
echo log(10)2.302585
echo log(exp(5))5.0
log10({expr}) log10() Return the logarithm of Float {expr} to base 10 as a Float. {expr} must evaluate to a Float or a Number. Examples:
echo log10(1000)3.0
echo log10(0.01)-2.0 luaeval({expr}[, {expr}]) Evaluate Lua expression {expr} and return its result converted to Vim data structures. See lua-luaeval for more details.
map({expr1}, {expr2}) map() {expr1} must be a List or a Dictionary. Replace each item in {expr1} with the result of evaluating {expr2}. {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. Example:
call map(mylist, '"> " . v:val . " <"')This puts "> " before and " <" after each item in "mylist". Note that {expr2} is the result of an expression and is then used as an expression again. Often it is good to use a literal-string to avoid having to double backslashes. You still have to double ' quotes If {expr2} is a Funcref it is called with two arguments: 1. The key or the index of the current item. 2. the value of the current item. The function must return the new value of the item. Example that changes each value by "key-value":
func KeyValue(key, val)return a:key . '-' . a:valendfunccall map(myDict, function('KeyValue'))
It is shorter when using a lambda:
call map(myDict, {key, val -> key . '-' . val})If you do not use "val" you can leave it out:
call map(myDict, {key -> 'item: ' . key})The operation is done in-place. If you want a List or Dictionary to remain unmodified make a copy first:
let tlist = map(copy(mylist), ' v:val . "\t"')Returns {expr1}, the List or Dictionary that was filtered. 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.
maparg({name} [, {mode} [, {abbr} [, {dict}]]]) maparg() When {dict} is omitted or zero: Return the rhs of mapping {name} in mode {mode}. The returned String has special characters translated like in the output of the ":map" command listing. When there is no mapping for {name}, an empty String is returned. The {name} can have special key names, like in the ":map" command. {mode} can be one of these strings: "n" Normal "v" Visual (including Select) "o" Operator-pending "i" Insert "c" Cmd-line "s" Select "x" Visual "l" langmap language-mapping "t" Terminal "" Normal, Visual and Operator-pending When {mode} is omitted, the modes for "" are used. When {abbr} is there and it is TRUE use abbreviations instead of mappings. When {dict} is there and it is TRUE return a dictionary containing all the information of the mapping with the following items: "lhs" The {lhs} of the mapping. "rhs" The {rhs} of the mapping as typed. "silent" 1 for a :map-silent mapping, else 0. "noremap" 1 if the {rhs} of the mapping is not remappable. "expr" 1 for an expression mapping (:map-<expr>). "buffer" 1 for a buffer local mapping (:map-local). "mode" Modes for which the mapping is defined. In addition to the modes mentioned above, these characters will be used: " " Normal, Visual and Operator-pending "!" Insert and Commandline mode (mapmode-ic) "sid" The script local ID, used for <sid> mappings (<SID>). "nowait" Do not wait for other, longer mappings. (:map-<nowait>). The mappings local to the current buffer are checked first, then the global mappings. This function can be used to map a key even when it's already mapped, and have it do the original mapping too. Sketch:
exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n')mapcheck({name} [, {mode} [, {abbr}]]) mapcheck() Check if there is a mapping that matches with {name} in mode {mode}. See maparg() for {mode} and special names in {name}. When {abbr} is there and it is non-zero use abbreviations instead of mappings. A match happens with a mapping that starts with {name} and with a mapping which is equal to the start of {name}. matches mapping "a" "ab" "abc" mapcheck("a") yes yes yes mapcheck("abc") yes yes yes mapcheck("ax") yes no no mapcheck("b") no no no The difference with maparg() is that mapcheck() finds a mapping that matches with {name}, while maparg() only finds a mapping for {name} exactly. When there is no mapping that starts with {name}, an empty String is returned. If there is one, the rhs of that mapping is returned. If there are several mappings that start with {name}, the rhs of one of them is returned. The mappings local to the current buffer are checked first, then the global mappings. This function can be used to check if a mapping can be added without being ambiguous. Example:
if mapcheck("_vv") == ""map _vv :set guifont=7x13<CR>endif
This avoids adding the "_vv" mapping when there already is a mapping for "_v" or for "_vvv".
match({expr}, {pat} [, {start} [, {count}]]) match() When {expr} is a List then this returns the index of the first item where {pat} matches. Each item is used as a String, Lists and Dictionaries are used as echoed. Otherwise, {expr} is used as a String. The result is a Number, which gives the index (byte offset) in {expr} where {pat} matches. A match at the first character or List item returns zero. If there is no match -1 is returned. For getting submatches see matchlist(). Example:
echo match("testing", "ing") " results in 4echo match([1, 'x'], '\a') " results in 1
See string-match for how {pat} is used. strpbrk() Vim doesn't have a strpbrk() function. But you can do:
let sepidx = match(line, '[.,;: \t]')strcasestr() Vim doesn't have a strcasestr() function. But you can add "\c" to the pattern to ignore case:
let idx = match(haystack, '\cneedle')If {start} is given, the search starts from byte index {start} in a String or item {start} in a List. The result, however, is still the index counted from the first character/item. Example:
echo match("testing", "ing", 2)result is again "4".
echo match("testing", "ing", 4)result is again "4".
echo match("testing", "t", 2)result is "3". For a String, if {start} > 0 then it is like the string starts {start} bytes later, thus "^" will match at {start}. Except when {count} is given, then it's like matches before the {start} byte are ignored (this is a bit complicated to keep it backwards compatible). For a String, if {start} < 0, it will be set to 0. For a list the index is counted from the end. If {start} is out of range ({start} > strlen({expr}) for a String or {start} > len({expr}) for a List) -1 is returned. When {count} is given use the {count}'th match. When a match is found in a String the search for the next one starts one character further. Thus this example results in 1:
echo match("testing", "..", 0, 2)In a List the search continues in the next item. Note that when {count} is added the way {start} works changes, see above. See pattern for the patterns that are accepted. The 'ignorecase' option is used to set the ignore-caseness of the pattern. 'smartcase' is NOT used. The matching is always done like 'magic' is set and 'cpoptions' is empty.
matchadd() E798 E799 E801 matchadd({group}, {pattern}[, {priority}[, {id} [, {dict}]]]) Defines a pattern to be highlighted in the current window (a "match"). It will be highlighted with {group}. Returns an identification number (ID), which can be used to delete the match using matchdelete(). Matching is case sensitive and magic, unless case sensitivity or magicness are explicitly overridden in {pattern}. The 'magic', 'smartcase' and 'ignorecase' options are not used. The "Conceal" value is special, it causes the match to be concealed. The optional {priority} argument assigns a priority to the match. A match with a high priority will have its highlighting overrule that of a match with a lower priority. A priority is specified as an integer (negative numbers are no exception). If the {priority} argument is not specified, the default priority is 10. The priority of 'hlsearch' is zero, hence all matches with a priority greater than zero will overrule it. Syntax highlighting (see 'syntax') is a separate mechanism, and regardless of the chosen priority a match will always overrule syntax highlighting. The optional {id} argument allows the request for a specific match ID. If a specified ID is already taken, an error message will appear and the match will not be added. An ID is specified as a positive integer (zero excluded). IDs 1, 2 and 3 are reserved for :match, :2match and :3match, respectively. If the {id} argument is not specified or -1, matchadd() automatically chooses a free ID. The optional {dict} argument allows for further custom values. Currently this is used to specify a match specific conceal character that will be shown for hl-Conceal highlighted matches. The dict can have the following members: conceal Special character to show instead of the match (only for hl-Conceal highlighed matches, see :syn-cchar) The number of matches is not limited, as it is the case with the :match commands. Example:
highlight MyGroup ctermbg=green guibg=greenlet m = matchadd("MyGroup", "TODO")
Deletion of the pattern:
call matchdelete(m)A list of matches defined by matchadd() and :match are available from getmatches(). All matches can be deleted in one operation by clearmatches().
matchaddpos() matchaddpos({group}, {pos} [, {priority} [, {id} [, {dict}]]]) Same as matchadd(), but requires a list of positions {pos} instead of a pattern. This command is faster than matchadd() because it does not require to handle regular expressions and sets buffer line boundaries to redraw screen. It is supposed to be used when fast match additions and deletions are required, for example to highlight matching parentheses. E5030 E5031 The list {pos} can contain one of these items: - A number. This whole line will be highlighted. The first line has number 1. - A list with one number, e.g., [23]. The whole line with this number will be highlighted. - A list with two numbers, e.g., [23, 11]. The first number is the line number, the second one is the column number (first column is 1, the value must correspond to the byte index as col() would return). The character at this position will be highlighted. - A list with three numbers, e.g., [23, 11, 3]. As above, but the third number gives the length of the highlight in bytes. Entries with zero and negative line numbers are silently ignored, as well as entries with negative column numbers and lengths. The maximum number of positions is 8. Example:
highlight MyGroup ctermbg=green guibg=greenlet m = matchaddpos("MyGroup", [[23, 24], 34])
Deletion of the pattern:
call matchdelete(m)Matches added by matchaddpos() are returned by getmatches() with an entry "pos1", "pos2", etc., with the value a list like the {pos} item. These matches cannot be set via setmatches(), however they can still be deleted by clearmatches().
matcharg({nr}) matcharg() Selects the {nr} match item, as set with a :match, :2match or :3match command. Return a List with two elements: The name of the highlight group used The pattern used. When {nr} is not 1, 2 or 3 returns an empty List. When there is no match item set returns ['', '']. This is useful to save and restore a :match. Highlighting matches using the :match commands are limited to three matches. matchadd() does not have this limitation.
matchdelete({id}) matchdelete() E802 E803 Deletes a match with ID {id} previously defined by matchadd() or one of the :match commands. Returns 0 if successful, otherwise -1. See example for matchadd(). All matches can be deleted in one operation by clearmatches().
matchend({expr}, {pat} [, {start} [, {count}]]) matchend() Same as match(), but return the index of first character after the match. Example:
echo matchend("testing", "ing")results in "7". strspn() strcspn() Vim doesn't have a strspn() or strcspn() function, but you can do it with matchend():
let span = matchend(line, '[a-zA-Z]')let span = matchend(line, '[^a-zA-Z]')
Except that -1 is returned when there are no matches. The {start}, if given, has the same meaning as for match().
echo matchend("testing", "ing", 2)results in "7".
echo matchend("testing", "ing", 5)result is "-1". When {expr} is a List the result is equal to match().
matchlist({expr}, {pat} [, {start} [, {count}]]) matchlist() Same as match(), but return a List. The first item in the list is the matched string, same as what matchstr() would return. Following items are submatches, like "\1", "\2", etc. in :substitute. When an optional submatch didn't match an empty string is used. Example:
echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', ''] When there is no match an empty list is returned.
matchstr({expr}, {pat} [, {start} [, {count}]]) matchstr() Same as match(), but return the matched string. Example:
echo matchstr("testing", "ing")results in "ing". When there is no match "" is returned. The {start}, if given, has the same meaning as for match().
echo matchstr("testing", "ing", 2)results in "ing".
echo matchstr("testing", "ing", 5)result is "". When {expr} is a List then the matching item is returned. The type isn't changed, it's not necessarily a String.
matchstrpos({expr}, {pat} [, {start} [, {count}]]) matchstrpos() Same as matchstr(), but return the matched string, the start position and the end position of the match. Example:
echo matchstrpos("testing", "ing")results in ["ing", 4, 7]. When there is no match ["", -1, -1] is returned. The {start}, if given, has the same meaning as for match().
echo matchstrpos("testing", "ing", 2)results in ["ing", 4, 7].
echo matchstrpos("testing", "ing", 5)result is ["", -1, -1]. When {expr} is a List then the matching item, the index of first item where {pat} matches, the start position and the end position of the match are returned.
echo matchstrpos([1, '__x'], '\a')result is ["x", 1, 2, 3]. The type isn't changed, it's not necessarily a String.
max() max({expr}) Return the maximum value of all items in {expr}. {expr} can be a list or a dictionary. For a dictionary, it returns the maximum of all values in the dictionary. If {expr} is neither a list nor a dictionary, or one of the items in {expr} cannot be used as a Number this results in an error. An empty List or Dictionary results in zero.
menu_get({path}, {modes}) menu_get() Returns a List of Dictionaries describing menus (defined by :menu, :amenu, etc.). {path} limits the result to a subtree of the menu hierarchy (empty string matches all menus). E.g. to get items in the "File" menu subtree:
echo menu_get('File',''){modes} is a string of zero or more modes (see maparg() or creating-menus for the list of modes). "a" means "all". For example:
nnoremenu &Test.Test inormalinoremenu Test.Test insertvnoremenu Test.Test xecho menu_get("")
returns something like this:
[ {"hidden": 0,"name": "Test","priority": 500,"shortcut": 84,"submenus": [ {"hidden": 0,"mappings": {i": {"enabled": 1,"noremap": 1,"rhs": "insert","sid": 1,"silent": 0},n": { ... },s": { ... },v": { ... }},"name": "Test","priority": 500,"shortcut": 0} ]} ]
min() min({expr}) Return the minimum value of all items in {expr}. {expr} can be a list or a dictionary. For a dictionary, it returns the minimum of all values in the dictionary. If {expr} is neither a list nor a dictionary, or one of the items in {expr} cannot be used as a Number this results in an error. An empty List or Dictionary results in zero.
mkdir() E739 mkdir({name} [, {path} [, {prot}]]) Create directory {name}. If {path} is "p" then intermediate directories are created as necessary. Otherwise it must be "". If {prot} is given it is used to set the protection bits of the new directory. The default is 0755 (rwxr-xr-x: r/w for the user readable for others). Use 0700 to make it unreadable for others. {Nvim} {prot} is applied for all parts of {name}. Thus if you create /tmp/foo/bar then /tmp/foo will be created with 0700. Example:
call mkdir($HOME . "/tmp/foo/bar", "p", 0700)This function is not available in the sandbox. If you try to create an existing directory with {path} set to "p" mkdir() will silently exit.
mode() mode([expr]) Return a string that indicates the current mode. If [expr] is supplied and it evaluates to a non-zero Number or a non-empty String (non-zero-arg), then the full mode is returned, otherwise only the first letter is returned. n Normal no Operator-pending v Visual by character V Visual by line CTRL-V Visual blockwise s Select by character S Select by line CTRL-S Select blockwise i Insert ic Insert mode completion compl-generic ix Insert mode i_CTRL-X completion R Replace R Rc Replace mode completion compl-generic Rv Virtual Replace gR Rx Replace mode i_CTRL-X completion c Command-line editing cv Vim Ex mode gQ ce Normal Ex mode Q r Hit-enter prompt rm The -- more -- prompt r? A :confirm query of some sort ! Shell or external command is executing t Terminal mode: keys go to the job This is useful in the 'statusline' option or when used with remote_expr() In most other places it always returns "c" or "n". Also see visualmode().
msgpackdump({list}) {Nvim} msgpackdump() Convert a list of VimL objects to msgpack. Returned value is readfile()-style list. Example:
call writefile(msgpackdump([{}]), 'fname.mpack', 'b')This will write the single 0x80 byte to fname.mpackfile(dictionary with zero items is represented by 0x80 byte in messagepack).
Limitations: E5004 E5005 1. Funcrefs cannot be dumped. 2. Containers that reference themselves cannot be dumped. 3. Dictionary keys are always dumped as STR strings. 4. Other strings are always dumped as BIN strings. 5. Points 3. and 4. do not apply to msgpack-special-dicts.
msgpackparse({list}) {Nvim} msgpackparse() Convert a readfile()-style list to a list of VimL objects. Example:
let fname = expand('~/.config/nvim/shada/main.shada')let mpack = readfile(fname, 'b')let shada_objects = msgpackparse(mpack)
This will read ~/.config/nvim/shada/main.shada file to shada_objectslist.Limitations: 1. Mapping ordering is not preserved unless messagepack mapping is dumped using generic mapping (msgpack-special-map). 2. Since the parser aims to preserve all data untouched (except for 1.) some strings are parsed to msgpack-special-dict format which is not convenient to use. msgpack-special-dict Some messagepack strings may be parsed to special dictionaries. Special dictionaries are dictionaries which 1. Contain exactly two keys: _TYPEand_VAL.2. _TYPEkey is one of the types found in v:msgpack_typesvariable. 3. Value for _VALhas the following format (Key columncontains name of the key from v:msgpack_types): Key Value nil Zero, ignored when dumping. Not returned by msgpackparse() since v:null was introduced. boolean One or zero. When dumping it is only checked that value is a Number. Not returned by msgpackparse() since v:true and v:false were introduced. integer List with four numbers: sign (-1 or 1), highest two bits, number with bits from 62nd to 31st, lowest 31 bits. I.e. to get actual number one will need to use code like
_VAL[0] * ((_VAL[1] << 62)& (_VAL[2] << 31)& _VAL[3])
Special dictionary with this type will appear in msgpackparse() output under one of the following circumstances: 1. Number is 32-bit and value is either above INT32_MAX or below INT32_MIN. 2. Number is 64-bit and value is above INT64_MAX. It cannot possibly be below INT64_MIN because msgpack C parser does not support such values. float Float. This value cannot possibly appear in msgpackparse() output. string readfile()-style list of strings. This value will appear in msgpackparse() output if string contains zero byte or if string is a mapping key and mapping is being represented as special dictionary for other reasons. binary readfile()-style list of strings. This value will appear in msgpackparse() output if binary string contains zero byte. array List. This value cannot appear in msgpackparse() output. msgpack-special-map map List of Lists with two items (key and value) each. This value will appear in msgpackparse() output if parsed mapping contains one of the following keys: 1. Any key that is not a string (including keys which are binary strings). 2. String with NUL byte inside. 3. Duplicate key. 4. Empty key. ext List with two values: first is a signed integer representing extension type. Second is readfile()-style list of strings.
msgbuf({message}[, {highlight}[, {open}]]) {Nvim} msgbuf() Display {message} in the message pane, optionally highlighted with a {highlight} group name. When {open} is non-zero, open the message pane in a window. See also 'messagepane', msgbuf_open().
msgbuf_open() {Nvim} msgbuf_open() Open the message pane if it's not already displayed in a window. Only one message pane window is opened per tab. Returns the message pane's buffer number or 0 if the pane couldn't be opened. See also 'messagepane', msgbuf().
nextnonblank({lnum}) nextnonblank() Return the line number of the first line at or below {lnum} that is not blank. Example:
if getline(nextnonblank(1)) =~ "Java"When {lnum} is invalid or there is no non-blank line at or below it, zero is returned. See also prevnonblank().
nr2char({expr} [, {utf8}]) nr2char() Return a string with a single character, which has the number value {expr}. Examples:
nr2char(64) returns "@"nr2char(32) returns " "
Example for "utf-8":
nr2char(300) returns I with bow characterUTF-8 encoding is always used, {utf8} option has no effect, and exists only for backwards-compatibility. Note that a NUL character in the file is specified with nr2char(10), because NULs are represented with newline characters. nr2char(0) is a real NUL and terminates the string, thus results in an empty string.
nvim_...({...}) nvim_...() eval-api Call nvim api functions. The type checking of arguments will be stricter than for most other builtins. For instance, if Integer is expected, a Number must be passed in, a String will not be autoconverted. Buffer numbers, as returned by bufnr() could be used as first argument to nvim_buf_... functions. All functions expecting an object (buffer, window or tabpage) can also take the numerical value 0 to indicate the current (focused) object.
or({expr}, {expr}) or() Bitwise OR on the two arguments. The arguments are converted to a number. A List, Dict or Float argument causes an error. Example:
let bits = or(bits, 0x80)pathshorten({expr}) pathshorten() Shorten directory names in the path {expr} and return the result. The tail, the file name, is kept as-is. The other components in the path are reduced to single letters. Leading '~' and '.' characters are kept. Example:
echo pathshorten('~/.config/nvim/autoload/file1.vim')~/.c/n/a/file1.vimIt doesn't matter if the path exists or not.
pow({x}, {y}) pow() Return the power of {x} to the exponent {y} as a Float. {x} and {y} must evaluate to a Float or a Number. Examples:
echo pow(3, 3)27.0
echo pow(2, 16)65536.0
echo pow(32, 0.20)2.0
prevnonblank({lnum}) prevnonblank() Return the line number of the first line at or above {lnum} that is not blank. Example:
let ind = indent(prevnonblank(v:lnum - 1))When {lnum} is invalid or there is no non-blank line at or above it, zero is returned. Also see nextnonblank().
printf({fmt}, {expr1} ...) printf() Return a String with {fmt}, where "%" items are replaced by the formatted form of their respective arguments. Example:
printf("%4d: E%d %.30s", lnum, errno, msg)May result in: " 99: E42 asdfasdfasdfasdfasdfasdfasdfas"Often used items are: %s string %6S string right-aligned in 6 display cells %6s string right-aligned in 6 bytes %.9s string truncated to 9 bytes %c single byte %d decimal number %5d decimal number padded with spaces to 5 characters %b binary number %08b binary number padded with zeros to at least 8 characters %B binary number using upper case letters %x hex number %04x hex number padded with zeros to at least 4 characters %X hex number using upper case letters %o octal number %f floating point number as 12.23, inf, -inf or nan %F floating point number as 12.23, INF, -INF or NAN %e floating point number as 1.23e3, inf, -inf or nan %E floating point number as 1.23E3, INF, -INF or NAN %g floating point number, as %f or %e depending on value %G floating point number, as %F or %E depending on value %% the % character itself %p representation of the pointer to the container Conversion specifications start with '%' and end with the conversion type. All other characters are copied unchanged to the result. The "%" starts a conversion specification. The following arguments appear in sequence: % [flags] [field-width] [.precision] type flags Zero or more of the following flags: # The value should be converted to an "alternate form". For c, d, and s conversions, this option has no effect. For o conversions, the precision of the number is increased to force the first character of the output string to a zero (except if a zero value is printed with an explicit precision of zero). For x and X conversions, a non-zero result has the string "0x" (or "0X" for X conversions) prepended to it. 0 (zero) Zero padding. For all conversions the converted value is padded on the left with zeros rather than blanks. If a precision is given with a numeric conversion (d, o, x, and X), the 0 flag is ignored. - A negative field width flag; the converted value is to be left adjusted on the field boundary. The converted value is padded on the right with blanks, rather than on the left with blanks or zeros. A - overrides a 0 if both are given. ' ' (space) A blank should be left before a positive number produced by a signed conversion (d). + A sign must always be placed before a number produced by a signed conversion. A + overrides a space if both are used. field-width An optional decimal digit string specifying a minimum field width. If the converted value has fewer bytes than the field width, it will be padded with spaces on the left (or right, if the left-adjustment flag has been given) to fill out the field width. .precision An optional precision, in the form of a period '.' followed by an optional digit string. If the digit string is omitted, the precision is taken as zero. This gives the minimum number of digits to appear for d, o, x, and X conversions, or the maximum number of bytes to be printed from a string for s conversions. For floating point it is the number of digits after the decimal point. type A character that specifies the type of conversion to be applied, see below. A field width or precision, or both, may be indicated by an asterisk '*' instead of a digit string. In this case, a Number argument supplies the field width or precision. A negative field width is treated as a left adjustment flag followed by a positive field width; a negative precision is treated as though it were missing. Example:
echo printf("%d: %.*s", nr, width, line)This limits the length of the text used from "line" to "width" bytes. The conversion specifiers and their meanings are:
printf-d printf-b printf-B printf-o printf-x printf-X dbBoxX The Number argument is converted to signed decimal (d), unsigned binary (b and B), unsigned octal (o), or unsigned hexadecimal (x and X) notation. The letters "abcdef" are used for x conversions; the letters "ABCDEF" are used for X conversions. The precision, if any, gives the minimum number of digits that must appear; if the converted value requires fewer digits, it is padded on the left with zeros. In no case does a non-existent or small field width cause truncation of a numeric field; if the result of a conversion is wider than the field width, the field is expanded to contain the conversion result. The 'h' modifier indicates the argument is 16 bits. The 'l' modifier indicates the argument is 32 bits. The 'L' modifier indicates the argument is 64 bits. Generally, these modifiers are not useful. They are ignored when type is known from the argument. i alias for d D alias for ld U alias for lu O alias for lo
printf-c c The Number argument is converted to a byte, and the resulting character is written.
printf-s s The text of the String argument is used. If a precision is specified, no more bytes than the number specified are used. If the argument is not a String type, it is automatically converted to text with the same format as ":echo". printf-S S The text of the String argument is used. If a precision is specified, no more display cells than the number specified are used. Without the +multi_byte feature works just like 's'.
printf-f E807 f F The Float argument is converted into a string of the form 123.456. The precision specifies the number of digits after the decimal point. When the precision is zero the decimal point is omitted. When the precision is not specified 6 is used. A really big number (out of range or dividing by zero) results in "inf" or "-inf" with %f (INF or -INF with %F). "0.0 / 0.0" results in "nan" with %f (NAN with %F). Example:
echo printf("%.2f", 12.115)12.12 Note that roundoff depends on the system libraries. Use round() when in doubt.
printf-e printf-E e E The Float argument is converted into a string of the form 1.234e+03 or 1.234E+03 when using 'E'. The precision specifies the number of digits after the decimal point, like with 'f'.
printf-g printf-G g G The Float argument is converted like with 'f' if the value is between 0.001 (inclusive) and 10000000.0 (exclusive). Otherwise 'e' is used for 'g' and 'E' for 'G'. When no precision is specified superfluous zeroes and '+' signs are removed, except for the zero immediately after the decimal point. Thus 10000000.0 results in 1.0e7.
printf-% % A '%' is written. No argument is converted. The complete conversion specification is "%%". When a Number argument is expected a String argument is also accepted and automatically converted. When a Float or String argument is expected a Number argument is also accepted and automatically converted. Any other argument type results in an error message.
E766 E767 The number of {exprN} arguments must exactly match the number of "%" items. If there are not sufficient or too many arguments an error is given. Up to 18 arguments can be used.
pumvisible() pumvisible() Returns non-zero when the popup menu is visible, zero otherwise. See ins-completion-menu. This can be used to avoid some things that would remove the popup menu.
py3eval({expr}) py3eval() Evaluate Python expression {expr} and return its result converted to Vim data structures. Numbers and strings are returned as they are (strings are copied though, Unicode strings are additionally converted to UTF-8). Lists are represented as Vim List type. Dictionaries are represented as Vim Dictionary type with keys converted to strings. {only available when compiled with the +python3 feature}
E858 E859 pyeval({expr}) pyeval() Evaluate Python expression {expr} and return its result converted to Vim data structures. Numbers and strings are returned as they are (strings are copied though). Lists are represented as Vim List type. Dictionaries are represented as Vim Dictionary type, non-string keys result in error. {only available when compiled with the +python feature}
E726 E727 range({expr} [, {max} [, {stride}]]) range() Returns a List with Numbers: - If only {expr} is specified: [0, 1, ..., {expr} - 1] - If {max} is specified: [{expr}, {expr} + 1, ..., {max}] - If {stride} is specified: [{expr}, {expr} + {stride}, ..., {max}] (increasing {expr} with {stride} each time, not producing a value past {max}). When the maximum is one before the start the result is an empty list. When the maximum is more than one before the start this is an error. Examples:
range(4) " [0, 1, 2, 3]range(2, 4) " [2, 3, 4]range(2, 9, 3) " [2, 5, 8]range(2, -2, -1) " [2, 1, 0, -1, -2]range(0) " []range(2, 0) " error!
readfile() readfile({fname} [, {binary} [, {max}]]) Read file {fname} and return a List, each line of the file as an item. Lines are broken at NL characters. Macintosh files separated with CR will result in a single long line (unless a NL appears somewhere). All NUL characters are replaced with a NL character. When {binary} contains "b" binary mode is used: - When the last line ends in a NL an extra empty list item is added. - No CR characters are removed. Otherwise: - CR characters that appear before a NL are removed. - Whether the last line ends in a NL or not does not matter. - Any UTF-8 byte order mark is removed from the text. When {max} is given this specifies the maximum number of lines to be read. Useful if you only want to check the first ten lines of a file:
for line in readfile(fname, '', 10)if line =~ 'Date' | echo line | endifendfor
When {max} is negative -{max} lines from the end of the file are returned, or as many as there are. When {max} is zero the result is an empty list. Note that without {max} the whole file is read into memory. Also note that there is no recognition of encoding. Read a file into a buffer if you need to. When the file can't be opened an error message is given and the result is an empty list. Also see writefile().
reltime([{start} [, {end}]]) reltime() Return an item that represents a time value. The format of the item depends on the system. It can be passed to reltimestr() to convert it to a string or reltimefloat() to convert to a float. Without an argument it returns the current "relative time", an implementation-defined value meaningful only when used as an argument to reltime(), reltimestr() and reltimefloat(). With one argument it returns the time passed since the time specified in the argument. With two arguments it returns the time passed between {start} and {end}. The {start} and {end} arguments must be values returned by reltime(). Note: localtime() returns the current (non-relative) time.
reltimefloat({time}) reltimefloat() Return a Float that represents the time value of {time}. Unit of time is seconds. Example: let start = reltime() call MyFunction() let seconds = reltimefloat(reltime(start)) See the note of reltimestr() about overhead. Also see profiling.
reltimestr({time}) reltimestr() Return a String that represents the time value of {time}. This is the number of seconds, a dot and the number of microseconds. Example:
let start = reltime()call MyFunction()echo reltimestr(reltime(start))
Note that overhead for the commands will be added to the time. Leading spaces are used to make the string align nicely. You can use split() to remove it.
echo split(reltimestr(reltime(start)))[0]Also see profiling.
remote_expr() E449 remote_expr({server}, {string} [, {idvar}]) Send the {string} to {server}. The string is sent as an expression and the result is returned after evaluation. The result must be a String or a List. A List is turned into a String by joining the items with a line break in between (not at the end), like with join(expr, "\n"). If {idvar} is present, it is taken as the name of a variable and a {serverid} for later use with remote_read() is stored there. See also clientserver RemoteReply. This function is not available in the sandbox. {only available when compiled with the +clientserver feature} Note: Any errors will cause a local error message to be issued and the result will be the empty string. Variables will be evaluated in the global namespace, independent of a function currently being active. Except when in debug mode, then local function variables and arguments can be evaluated. Examples:
echo remote_expr("gvim", "2+2")echo remote_expr("gvim1", "b:current_syntax")
remote_foreground({server}) remote_foreground() Move the Vim server with the name {server} to the foreground. This works like:
remote_expr({server}, "foreground()")Except that on Win32 systems the client does the work, to work around the problem that the OS doesn't always allow the server to bring itself to the foreground. Note: This does not restore the window if it was minimized, like foreground() does. This function is not available in the sandbox. {only in the Win32 GUI and the Win32 console version}
remote_peek({serverid} [, {retvar}]) remote_peek() Returns a positive number if there are available strings from {serverid}. Copies any reply string into the variable {retvar} if specified. {retvar} must be a string with the name of a variable. Returns zero if none are available. Returns -1 if something is wrong. See also clientserver. This function is not available in the sandbox. {only available when compiled with the +clientserver feature} Examples:
let repl = ""echo "PEEK: ".remote_peek(id, "repl").": ".repl
remote_read({serverid}) remote_read() Return the oldest available reply from {serverid} and consume it. It blocks until a reply is available. See also clientserver. This function is not available in the sandbox. {only available when compiled with the +clientserver feature} Example:
echo remote_read(id)remote_send() E241 remote_send({server}, {string} [, {idvar}]) Send the {string} to {server}. The string is sent as input keys and the function returns immediately. At the Vim server the keys are not mapped :map. If {idvar} is present, it is taken as the name of a variable and a {serverid} for later use with remote_read() is stored there. See also clientserver RemoteReply. This function is not available in the sandbox. {only available when compiled with the +clientserver feature} Note: Any errors will be reported in the server and may mess up the display. Examples:
:echo remote_send("gvim", ":DropAndReply ".file, "serverid").\ remote_read(serverid):autocmd NONE RemoteReply *\ echo remote_read(expand("<amatch>")):echo remote_send("gvim", ":sleep 10 | echo ".\ 'server2client(expand("<client>"), "HELLO")<CR>')
remove({list}, {idx} [, {end}]) remove() Without {end}: Remove the item at {idx} from List {list} and return the item. With {end}: Remove items from {idx} to {end} (inclusive) and return a List with these items. When {idx} points to the same item as {end} a list with one item is returned. When {end} points to an item before {idx} this is an error. See list-index for possible values of {idx} and {end}. Example:
echo "last item: " . remove(mylist, -1)call remove(mylist, 0, 9)
remove({dict}, {key}) Remove the entry from {dict} with key {key}. Example:
echo "removed " . remove(dict, "one")If there is no {key} in {dict} this is an error. Use delete() to remove a file.
rename({from}, {to}) rename() Rename the file by the name {from} to the name {to}. This should also work to move files across file systems. The result is a Number, which is 0 if the file was renamed successfully, and non-zero when the renaming failed. NOTE: If {to} exists it is overwritten without warning. This function is not available in the sandbox.
repeat({expr}, {count}) repeat() Repeat {expr} {count} times and return the concatenated result. Example:
let separator = repeat('-', 80)When {count} is zero or negative the result is empty. When {expr} is a List the result is {expr} concatenated {count} times. Example:
let longlist = repeat(['a', 'b'], 3)Results in ['a', 'b', 'a', 'b', 'a', 'b'].
resolve({filename}) resolve() E655 On MS-Windows, when {filename} is a shortcut (a .lnk file), returns the path the shortcut points to in a simplified form. On Unix, repeat resolving symbolic links in all path components of {filename} and return the simplified result. To cope with link cycles, resolving of symbolic links is stopped after 100 iterations. On other systems, return the simplified {filename}. The simplification step is done as by simplify(). resolve() keeps a leading path component specifying the current directory (provided the result is still a relative path name) and also keeps a trailing path separator.
reverse() reverse({list}) Reverse the order of items in {list} in-place. Returns {list}. If you want a list to remain unmodified make a copy first:
let revlist = reverse(copy(mylist))round({expr}) round() Round off {expr} to the nearest integral value and return it as a Float. If {expr} lies halfway between two integral values, then use the larger one (away from zero). {expr} must evaluate to a Float or a Number. Examples:
echo round(0.456)0.0
echo round(4.5)5.0
echo round(-4.5)-5.0
rpcnotify({channel}, {event}[, {args}...]) {Nvim} rpcnotify() Sends {event} to {channel} via RPC and returns immediately. If {channel} is 0, the event is broadcast to all channels. Example:
au VimLeave call rpcnotify(0, "leaving")rpcrequest({channel}, {method}[, {args}...]) {Nvim} rpcrequest() Sends a request to {channel} to invoke {method} via RPC and blocks until a response is received. Example:
let result = rpcrequest(rpc_chan, "func", 1, 2, 3)rpcstart({prog}[, {argv}]) {Nvim} rpcstart() Deprecated. Replace
let id = rpcstart('prog', ['arg1', 'arg2'])with
let id = jobstart(['prog', 'arg1', 'arg2'], {'rpc': v:true})rpcstop({channel}) {Nvim} rpcstop() Deprecated. This function was used to stop a job with rpc channel, and additionally closed rpc sockets. Instead use jobstop() to stop any job, and chanclose(id, "rpc") to close rpc communication without stopping the job. Use chanclose(id) to close any socket.
screenattr({row}, {col}) screenattr() Like screenchar(), but return the attribute. This is a rather arbitrary number that can only be used to compare to the attribute at other positions.
screenchar({row}, {col}) screenchar() The result is a Number, which is the character at position [row, col] on the screen. This works for every possible screen position, also status lines, window separators and the command line. The top left position is row one, column one The character excludes composing characters. For double-byte encodings it may only be the first byte. This is mainly to be used for testing. Returns -1 when row or col is out of range.
screencol() screencol() The result is a Number, which is the current screen column of the cursor. The leftmost column has number 1. This function is mainly used for testing. Note: Always returns the current screen column, thus if used in a command (e.g. ":echo screencol()") it will return the column inside the command line, which is 1 when the command is executed. To get the cursor position in the file use one of the following mappings:
nnoremap <expr> GG ":echom ".screencol()."\n"nnoremap <silent> GG :echom screencol()<CR>
screenrow() screenrow() The result is a Number, which is the current screen row of the cursor. The top line has number one. This function is mainly used for testing. Alternatively you can use winline(). Note: Same restrictions as with screencol().
search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) search() Search for regexp pattern {pattern}. The search starts at the cursor position (you can use cursor() to set it). When a match has been found its line number is returned. If there is no match a 0 is returned and the cursor doesn't move. No error message is given. {flags} is a String, which can contain these character flags: 'b' search Backward instead of forward 'c' accept a match at the Cursor position 'e' move to the End of the match 'n' do Not move the cursor 'p' return number of matching sub-Pattern (see below) 's' Set the ' mark at the previous location of the cursor 'w' Wrap around the end of the file 'W' don't Wrap around the end of the file 'z' start searching at the cursor column instead of Zero If neither 'w' or 'W' is given, the 'wrapscan' option applies. If the 's' flag is supplied, the ' mark is set, only if the cursor is moved. The 's' flag cannot be combined with the 'n' flag. 'ignorecase', 'smartcase' and 'magic' are used. When the 'z' flag is not given, searching always starts in column zero and then matches before the cursor are skipped. When the 'c' flag is present in 'cpo' the next search starts after the match. Without the 'c' flag the next search starts one column further. When the {stopline} argument is given then the search stops after searching this line. This is useful to restrict the search to a range of lines. Examples:
let match = search('(', 'b', line("w0"))let end = search('END', '', line("w$"))
When {stopline} is used and it is not zero this also implies that the search does not wrap around the end of the file. A zero value is equal to not giving the argument. When the {timeout} argument is given the search stops when more than this many milliseconds have passed. Thus when {timeout} is 500 the search stops after half a second. The value must not be negative. A zero value is like not giving the argument. {only available when compiled with the +reltime feature}
search()-sub-match With the 'p' flag the returned value is one more than the first sub-match in \(\). One if none of them matched but the whole pattern did match. To get the column number too use searchpos(). The cursor will be positioned at the match, unless the 'n' flag is used. Example (goes over all files in the argument list):
let n = 1while n <= argc() " loop over all files in arglistexe "argument " . n" start at the last char in the file and wrap for the" first search to find match at start of filenormal G$let flags = "w"while search("foo", flags) > 0s/foo/bar/glet flags = "W"endwhileupdate " write the file if modifiedlet n = n + 1endwhile
Example for using some flags:
echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')This will search for the keywords "if", "else", and "endif" under or after the cursor. Because of the 'p' flag, it returns 1, 2, or 3 depending on which keyword is found, or 0 if the search fails. With the cursor on the first word of the line: if (foo == 0) | let foo = foo + 1 | endifthe function returns 1. Without the 'c' flag, the function finds the "endif" and returns 3. The same thing happens without the 'e' flag if the cursor is on the "f" of "if". The 'n' flag tells the function not to move the cursor.
searchdecl({name} [, {global} [, {thisblock}]]) searchdecl() Search for the declaration of {name}. With a non-zero {global} argument it works like gD, find first match in the file. Otherwise it works like gd, find first match in the function. With a non-zero {thisblock} argument matches in a {} block that ends before the cursor position are ignored. Avoids finding variable declarations only valid in another scope. Moves the cursor to the found match. Returns zero for success, non-zero for failure. Example:
if searchdecl('myvar') == 0echo getline('.')endif
searchpair() searchpair({start}, {middle}, {end} [, {flags} [, {skip} [, {stopline} [, {timeout}]]]]) Search for the match of a nested start-end pair. This can be used to find the "endif" that matches an "if", while other if/endif pairs in between are ignored. The search starts at the cursor. The default is to search forward, include 'b' in {flags} to search backward. If a match is found, the cursor is positioned at it and the line number is returned. If no match is found 0 or -1 is returned and the cursor doesn't move. No error message is given. {start}, {middle} and {end} are patterns, see pattern. They must not contain \( \) pairs. Use of \%( \) is allowed. When {middle} is not empty, it is found when searching from either direction, but only when not in a nested start-end pair. A typical use is:
searchpair('\<if\>', '\<else\>', '\<endif\>')By leaving {middle} empty the "else" is skipped. {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with search(). Additionally: 'r' Repeat until no more matches found; will find the outer pair. Implies the 'W' flag. 'm' Return number of matches instead of line number with the match; will be > 1 when 'r' is used. Note: it's nearly always a good idea to use the 'W' flag, to avoid wrapping around the end of the file. When a match for {start}, {middle} or {end} is found, the {skip} expression is evaluated with the cursor positioned on the start of the match. It should return non-zero if this match is to be skipped. E.g., because it is inside a comment or a string. When {skip} is omitted or empty, every match is accepted. When evaluating {skip} causes an error the search is aborted and -1 returned. For {stopline} and {timeout} see search(). The value of 'ignorecase' is used. 'magic' is ignored, the patterns are used like it's on. The search starts exactly at the cursor. A match with {start}, {middle} or {end} at the next character, in the direction of searching, is the first one found. Example:
if 1if 2endif 2endif 1
When starting at the "if 2", with the cursor on the "i", and searching forwards, the "endif 2" is found. When starting on the character just before the "if 2", the "endif 1" will be found. That's because the "if 2" will be found first, and then this is considered to be a nested if/endif from "if 2" to "endif 2". When searching backwards and {end} is more than one character, it may be useful to put "\zs" at the end of the pattern, so that when the cursor is inside a match with the end it finds the matching start. Example, to find the "endif" command in a Vim script:
:echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',\ 'getline(".") =~ "^\\s*\""')
The cursor must be at or after the "if" for which a match is to be found. Note that single-quote strings are used to avoid having to double the backslashes. The skip expression only catches comments at the start of a line, not after a command. Also, a word "en" or "if" halfway through a line is considered a match. Another example, to search for the matching "{" of a "}":
echo searchpair('{', '', '}', 'bW')This works when the cursor is at or before the "}" for which a match is to be found. To reject matches that syntax highlighting recognized as strings:
:echo searchpair('{', '', '}', 'bW',\ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
searchpairpos() searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [, {stopline} [, {timeout}]]]]) Same as searchpair(), but returns a List with the line and column position of the match. The first element of the List is the line number and the second element is the byte index of the column position of the match. If no match is found, returns [0, 0].
let [lnum,col] = searchpairpos('{', '', '}', 'n')See match-parens for a bigger and more useful example.
searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) searchpos() Same as search(), but returns a List with the line and column position of the match. The first element of the List is the line number and the second element is the byte index of the column position of the match. If no match is found, returns [0, 0]. Example:
let [lnum, col] = searchpos('mypattern', 'n')When the 'p' flag is given then there is an extra item with the sub-pattern match number search()-sub-match. Example:
let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')In this example "submatch" is 2 when a lowercase letter is found /\l, 3 when an uppercase letter is found /\u.
server2client({clientid}, {string}) server2client() Send a reply string to {clientid}. The most recent {clientid} that sent a string can be retrieved with expand("<client>"). {only available when compiled with the +clientserver feature} Note: This id has to be stored before the next command can be received. I.e. before returning from the received command and before calling any commands that waits for input. See also clientserver. Example:
echo server2client(expand("<client>"), "HELLO")serverlist() serverlist() Returns a list of available server names in a list. When there are no servers an empty string is returned. Example:
echo serverlist(){Nvim} --serverlist The Vim command-line option --serverlistwas removed fromNvim, but it can be imitated:
nvim --cmd "echo serverlist()" --cmd "q"serverstart([{address}]) serverstart() Opens a socket or named pipe at {address} and listens for RPC messages. Clients can send API commands to the address to control Nvim. Returns the address string. If {address} does not contain a colon ":" it is interpreted as a named pipe or Unix domain socket path. Example:
if has('win32')call serverstart('\\.\pipe\nvim-pipe-1234')elsecall serverstart('nvim.sock')endif
If {address} contains a colon ":" it is interpreted as a TCP address where the last ":" separates the host and port. Assigns a random port if it is empty or 0. Supports IPv4/IPv6. Example:
call serverstart('::1:12345')If no address is given, it is equivalent to:
call serverstart(tempname())$NVIM_LISTEN_ADDRESS is set to {address} if not already set.
--servername The Vim command-line option --servernamecan be imitated:
nvim --cmd "let g:server_addr = serverstart('foo')"serverstop({address}) serverstop() Closes the pipe or socket at {address}. Does nothing if {address} is empty or invalid. If $NVIM_LISTEN_ADDRESS is stopped it is unset. If v:servername is stopped it is set to the next available address returned by serverlist().
setbufvar({expr}, {varname}, {val}) setbufvar() Set option or local variable {varname} in buffer {expr} to {val}. This also works for a global or local window option, but it doesn't work for a global or local window variable. For a local window option the global value is unchanged. For the use of {expr}, see bufname() above. Note that the variable name without "b:" must be used. Examples:
call setbufvar(1, "&mod", 1)call setbufvar("todo", "myvar", "foobar")
This function is not available in the sandbox.
setcharsearch({dict}) setcharsearch() Set the current character search information to {dict}, which contains one or more of the following entries: char character which will be used for a subsequent , or ; command; an empty string clears the character search 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 save/restore a user's character search from a script:
let prevsearch = getcharsearch()" Perform a command which clobbers user's searchcall setcharsearch(prevsearch)
Also see getcharsearch().
setcmdpos({pos}) setcmdpos() Set the cursor position in the command line to byte position {pos}. The first position is 1. Use getcmdpos() to obtain the current position. Only works while editing the command line, thus you must use c_CTRL-\_e, c_CTRL-R_= or c_CTRL-R_CTRL-R with '='. For c_CTRL-\_e and c_CTRL-R_CTRL-R with '=' the position is set after the command line is set to the expression. For c_CTRL-R_= it is set after evaluating the expression but before inserting the resulting text. When the number is too big the cursor is put at the end of the line. A number smaller than one has undefined results. Returns 0 when successful, 1 when not editing the command line.
setfperm({fname}, {mode}) setfperm() chmod Set the file permissions for {fname} to {mode}. {mode} must be a string with 9 characters. It 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. A '-' character means the permission is off, any other character means on. Multi-byte characters are not supported. For example "rw-r-----" means read-write for the user, readable by the group, not accessible by others. "xx-x-----" would do the same thing. Returns non-zero for success, zero for failure. To read permissions see getfperm().
setline({lnum}, {text}) setline() Set line {lnum} of the current buffer to {text}. To insert lines use append(). {lnum} is used like with getline(). When {lnum} is just below the last line the {text} will be added as a new line. If this succeeds, 0 is returned. If this fails (most likely because {lnum} is invalid) 1 is returned. Example:
call setline(5, strftime("%c"))When {text} is a List then line {lnum} and following lines will be set to the items in the list. Example:
call setline(5, ['aaa', 'bbb', 'ccc'])This is equivalent to:
for [n, l] in [[5, 'aaa'], [6, 'bbb'], [7, 'ccc']]call setline(n, l)endfor
Note: The '[ and '] marks are not set.
setloclist({nr}, {list} [, {action}[, {what}]]) setloclist() Create or replace or add to 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 modified. For an invalid window number {nr}, -1 is returned. Otherwise, same as setqflist(). Also see location-list. If the optional {what} dictionary argument is supplied, then only the items listed in {what} are set. Refer to setqflist() for the list of supported keys in {what}.
setmatches({list}) setmatches() Restores a list of matches saved by getmatches(). Returns 0 if successful, otherwise -1. All current matches are cleared before the list is restored. See example for getmatches().
setpos() setpos({expr}, {list}) Set the position for {expr}. Possible values: . the cursor 'x mark x {list} must be a List with four or five numbers: [bufnum, lnum, col, off] [bufnum, lnum, col, off, curswant] "bufnum" is the buffer number. Zero can be used for the current buffer. Setting the cursor is only possible for the current buffer. To set a mark in another buffer you can use the bufnr() function to turn a file name into a buffer number. Does not change the jumplist. "lnum" and "col" are the position in the buffer. The first column is 1. Use a zero "lnum" to delete a mark. If "col" is smaller than 1 then 1 is used. The "off" number is only used when 'virtualedit' is set. 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 character. The "curswant" number is only used when setting the cursor position. It sets the preferred column for when moving the cursor vertically. When the "curswant" number is missing the preferred column is not set. When it is present and setting a mark position it is not used. Note that for '< and '> changing the line number may result in the marks to be effectively be swapped, so that '< is always before '>. Returns 0 when the position could be set, -1 otherwise. An error message is given if {expr} is invalid. Also see getpos() and getcurpos(). This does not restore the preferred column for moving vertically; if you set the cursor position with this, j and k motions will jump to previous columns! Use cursor() to also set the preferred column. Also see the "curswant" key in winrestview().
setqflist({list} [, {action}[, {what}]]) setqflist() Create or replace or add to the quickfix list using the items in {list}. Each item in {list} is a dictionary. Non-dictionary items in {list} are ignored. Each dictionary item can contain the following entries: bufnr buffer number; must be the number of a valid buffer filename name of a file; only used when "bufnr" is not present or it is invalid. lnum line number in the file pattern search pattern used to locate the error col column number vcol when non-zero: "col" is visual column when zero: "col" is byte index nr error number text description of the error type single-character error type, 'E', 'W', etc. valid recognized error message The "col", "vcol", "nr", "type" and "text" entries are optional. Either "lnum" or "pattern" entry can be used to locate a matching error line. If the "filename" and "bufnr" entries are not present or neither the "lnum" or "pattern" entries are present, then the item will not be handled as an error line. If both "pattern" and "lnum" are present then "pattern" will be used. If the "valid" entry is not supplied, then the valid flag is set when "bufnr" is a valid buffer or "filename" exists. If you supply an empty {list}, the quickfix list will be cleared. Note that the list is not exactly the same as what getqflist() returns.
{action} values: E927 'a' The items from {list} are added to the existing quickfix list. If there is no existing list, then a new list is created. 'r' The items from the current quickfix list are replaced with the items from {list}. This can also be used to clear the list:
call setqflist([], 'r')'f' All the quickfix lists in the quickfix stack are freed. If {action} is not present or is set to ' ', then a new list is created. If {title} is given, it will be used to set w:quickfix_title after opening the quickfix window. If the optional {what} dictionary argument is supplied, then only the items listed in {what} are set. The first {list} argument is ignored. The following items can be specified in {what}: context any Vim type can be stored as a context items list of quickfix entries. Same as the {list} argument. nr list number in the quickfix stack; zero means the current quickfix list and '$' means the last quickfix list title quickfix list title text Unsupported keys in {what} are ignored. If the "nr" item is not present, then the current quickfix list is modified. Examples:
call setqflist([], 'r', {'title': 'My search'})call setqflist([], 'r', {'nr': 2, 'title': 'Errors'})
Returns zero for success, -1 for failure. This function can be used to create a quickfix list independent of the 'errorformat' setting. Use a command like :cc 1to jump to the first position.
setreg() setreg({regname}, {value} [, {options}]) Set the register {regname} to {value}. {value} may be any value returned by getreg(), including a List. If {options} contains "a" or {regname} is upper case, then the value is appended. {options} can also contain a register type specification: "c" or "v" characterwise mode "l" or "V" linewise mode "b" or "<CTRL-V>" blockwise-visual mode If a number immediately follows "b" or "<CTRL-V>" then this is used as the width of the selection - if it is not specified then the width of the block is set to the number of characters in the longest line (counting a <Tab> as 1 character). If {options} contains "u" or '"', then the unnamed register is set to point to register {regname}. If {options} contains no register settings, then the default is to use character mode unless {value} ends in a <NL> for string {value} and linewise mode for list {value}. Blockwise mode is never selected automatically. Returns zero for success, non-zero for failure.
E883 Note: you may not use List containing more than one item to set search and expression registers. Lists containing no items act like empty strings. Examples:
call setreg(v:register, @*)call setreg('*', @%, 'ac')call setreg('a', "1\n2\n3", 'b5')
This example shows using the functions to save and restore a register (note: you may not reliably restore register value without using the third argument to getreg() as without it newlines are represented as newlines AND Nul bytes are represented as newlines as well, see NL-used-for-Nul).
:let var_a = getreg('a', 1, 1):let var_amode = getregtype('a')....:call setreg('a', var_a, var_amode)
You can also change the type of a register by appending nothing:
call setreg('a', '', 'al')settabvar({tabnr}, {varname}, {val}) settabvar() Set tab-local variable {varname} to {val} in tab page {tabnr}. t:var Note that the variable name without "t:" must be used. Tabs are numbered starting with one. This function is not available in the sandbox.
settabwinvar({tabnr}, {winnr}, {varname}, {val}) settabwinvar() Set option or local variable {varname} in window {winnr} to {val}. Tabs are numbered starting with one. For the current tabpage use setwinvar(). {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 or local buffer option, but it doesn't work for a global or local buffer variable. For a local buffer option the global value is unchanged. Note that the variable name without "w:" must be used. Examples:
call settabwinvar(1, 1, "&list", 0)call settabwinvar(3, 2, "myvar", "foobar")
This function is not available in the sandbox.
setwinvar({nr}, {varname}, {val}) setwinvar() Like settabwinvar() for the current tab page. Examples:
call setwinvar(1, "&list", 0)call setwinvar(2, "myvar", "foobar")
sha256({string}) sha256() Returns a String with 64 hex characters, which is the SHA256 checksum of {string}.
shellescape({string} [, {special}]) shellescape() Escape {string} for use as a shell command argument. On Windows when 'shellslash' is not set, it will enclose {string} in double quotes and double all double quotes within {string}. Otherwise, it will enclose {string} in single quotes and replace all "'" with "'\''". When the {special} argument is present and it's a non-zero Number or a non-empty String (non-zero-arg), then special items such as "!", "%", "#" and "<cword>" will be preceded by a backslash. This backslash will be removed again by the :! command. The "!" character will be escaped (again with a non-zero-arg {special}) when 'shell' contains "csh" in the tail. That is because for csh and tcsh "!" is used for history replacement even when inside single quotes. With a non-zero-arg {special} the <NL> character is also escaped. When 'shell' containing "csh" in the tail it's escaped a second time. Example of use with a :! command:
exe '!dir ' . shellescape(expand('<cfile>'), 1)This results in a directory listing for the file under the cursor. Example of use with system():
call system("chmod +w -- " . shellescape(expand("%")))See also ::S.
shiftwidth() shiftwidth() Returns the effective value of 'shiftwidth'. This is the 'shiftwidth' value unless it is zero, in which case it is the 'tabstop' value. To be backwards compatible in indent plugins, use this:
if exists('*shiftwidth')func s:sw()return shiftwidth()endfuncelsefunc s:sw()return &swendfuncendif
And then use s:sw() instead of &sw.
simplify({filename}) simplify() Simplify the file name as much as possible without changing the meaning. Shortcuts (on MS-Windows) or symbolic links (on Unix) are not resolved. If the first path component in {filename} designates the current directory, this will be valid for the result as well. A trailing path separator is not removed either. Example:
simplify("./dir/.././/file/") == "./file/"Note: The combination "dir/.." is only removed if "dir" is a searchable directory or does not exist. On Unix, it is also removed when "dir" is a symbolic link within the same directory. In order to resolve all the involved symbolic links before simplifying the path name, use resolve().
sin({expr}) sin() Return the sine of {expr}, measured in radians, as a Float. {expr} must evaluate to a Float or a Number. Examples:
echo sin(100)-0.506366
echo sin(-4.01)0.763301
sinh({expr}) sinh() Return the hyperbolic sine of {expr} as a Float in the range [-inf, inf]. {expr} must evaluate to a Float or a Number. Examples:
echo sinh(0.5)0.521095
echo sinh(-0.9)-1.026517
sockconnect({mode}, {address}, {opts}) sockconnect() Connect a socket to an address. If {mode} is "pipe" then {address} should be the path of a named pipe. If {mode} is "tcp" then {address} should be of the form "host:port" where the host should be an ip adderess or host name, and port the port number. Returns a channel ID. Close the socket with chanclose(). Use chansend() to send data over a bytes socket, and rpcrequest() and rpcnotify() to communicate with a RPC socket. {opts} is a dictionary with these keys: on_data : callback invoked when data was read from socket data_buffered : read data from socket in buffered mode. rpc : If set, msgpack-rpc will be used to communicate over the socket. Returns: - The channel ID on success (greater than zero) - 0 on invalid arguments or connection failure.
sort({list} [, {func} [, {dict}]]) sort() E702 Sort the items in {list} in-place. Returns {list}. If you want a list to remain unmodified make a copy first:
let sortedlist = sort(copy(mylist))When {func} is omitted, is empty or zero, then sort() uses the string representation of each item to sort on. Numbers sort after Strings, Lists after Numbers. For sorting text in the current buffer use :sort. When {func} is given and it is '1' or 'i' then case is ignored. When {func} is given and it is 'n' then all items will be sorted numerical (Implementation detail: This uses the strtod() function to parse numbers, Strings, Lists, Dicts and Funcrefs will be considered as being 0). When {func} is given and it is 'N' then all items will be sorted numerical. This is like 'n' but a string containing digits will be used as the number they represent. When {func} is given and it is 'f' then all items will be sorted numerical. All values must be a Number or a Float. When {func} is a Funcref or a function name, this function is called to compare items. The function is invoked with two items as argument and must return zero if they are equal, 1 or bigger if the first one sorts after the second one, -1 or smaller if the first one sorts before the second one. {dict} is for functions with the "dict" attribute. It will be used to set the local variable "self". Dictionary-function The sort is stable, items which compare equal (as number or as string) will keep their relative position. E.g., when sorting on numbers, text strings will sort next to each other, in the same order as they were originally. Also see uniq(). Example:
func MyCompare(i1, i2)return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1endfunclet sortedlist = sort(mylist, "MyCompare")
A shorter compare version for this specific simple case, which ignores overflow:
func MyCompare(i1, i2)return a:i1 - a:i2endfunc
soundfold() soundfold({word}) Return the sound-folded equivalent of {word}. Uses the first language in 'spelllang' for the current window that supports soundfolding. 'spell' must be set. When no sound folding is possible the {word} is returned unmodified. This can be used for making spelling suggestions. Note that the method can be quite slow.
spellbadword() spellbadword([{sentence}]) Without argument: The result is the badly spelled word under or after the cursor. The cursor is moved to the start of the bad word. When no bad word is found in the cursor line the result is an empty string and the cursor doesn't move. With argument: The result is the first word in {sentence} that is badly spelled. If there are no spelling mistakes the result is an empty string. The return value is a list with two items: - The badly spelled word or an empty string. - The type of the spelling error: "bad" spelling mistake "rare" rare word "local" word only valid in another region "caps" word should start with Capital Example:
echo spellbadword("the quik brown fox")['quik', 'bad']The spelling information for the current window is used. The 'spell' option must be set and the value of 'spelllang' is used.
spellsuggest() spellsuggest({word} [, {max} [, {capital}]]) Return a List with spelling suggestions to replace {word}. When {max} is given up to this number of suggestions are returned. Otherwise up to 25 suggestions are returned. When the {capital} argument is given and it's non-zero only suggestions with a leading capital will be given. Use this after a match with 'spellcapcheck'. {word} can be a badly spelled word followed by other text. This allows for joining two words that were split. The suggestions also include the following text, thus you can replace a line. {word} may also be a good word. Similar words will then be returned. {word} itself is not included in the suggestions, although it may appear capitalized. The spelling information for the current window is used. The 'spell' option must be set and the values of 'spelllang' and 'spellsuggest' are used.
split({expr} [, {pattern} [, {keepempty}]]) split() Make a List out of {expr}. When {pattern} is omitted or empty each white-separated sequence of characters becomes an item. Otherwise the string is split where {pattern} matches, removing the matched characters. 'ignorecase' is not used here, add \c to ignore case. /\c When the first or last item is empty it is omitted, unless the {keepempty} argument is given and it's non-zero. Other empty items are kept when {pattern} matches at least one character or when {keepempty} is non-zero. Example:
let words = split(getline('.'), '\W\+')To split a string in individual characters:
for c in split(mystring, '\zs')If you want to keep the separator you can also use '\zs' at the end of the pattern:
echo split('abc:def:ghi', ':\zs')['abc:', 'def:', 'ghi']Splitting a table where the first element can be empty:
let items = split(line, ':', 1)The opposite function is join().
sqrt({expr}) sqrt() Return the non-negative square root of Float {expr} as a Float. {expr} must evaluate to a Float or a Number. When {expr} is negative the result is NaN (Not a Number). Examples:
echo sqrt(100)10.0
echo sqrt(-4.01)nan "nan" may be different, it depends on system libraries.
stdioopen({opts}) stdioopen() In a nvim launched with the --headless option, this opens stdin and stdout as a channel. This function can only be invoked once per instance. See channel-stdio for more information and examples. Note that stderr is not handled by this function, see v:stderr. Returns a channel ID. Close the stdio descriptors with chanclose(). Use chansend() to send data to stdout, and rpcrequest() and rpcnotify() to communicate over RPC. {opts} is a dictionary with these keys: on_stdin : callback invoked when stdin is written to. stdin_buffered : read stdin in buffered mode. rpc : If set, msgpack-rpc will be used to communicate over stdio Returns: - The channel ID on success (this is always 1) - 0 on invalid arguments
str2float({expr}) str2float() Convert String {expr} to a Float. This mostly works the same as when using a floating point number in an expression, see floating-point-format. But it's a bit more permissive. E.g., "1e40" is accepted, while in an expression you need to write "1.0e40". Text after the number is silently ignored. The decimal point is always '.', no matter what the locale is set to. A comma ends the number: "12,345.67" is converted to 12.0. You can strip out thousands separators with substitute():
let f = str2float(substitute(text, ',', '', 'g'))str2nr({expr} [, {base}]) str2nr() Convert string {expr} to a number. {base} is the conversion base, it can be 2, 8, 10 or 16. When {base} is omitted base 10 is used. This also means that a leading zero doesn't cause octal conversion to be used, as with the default String to Number conversion. When {base} is 16 a leading "0x" or "0X" is ignored. With a different base the result will be zero. Similarly, when {base} is 8 a leading "0" is ignored, and when {base} is 2 a leading "0b" or "0B" is ignored. Text after the number is silently ignored.
strchars({expr} [, {skipcc}]) strchars() The result is a Number, which is the number of characters in String {expr}. When {skipcc} is omitted or zero, composing characters are counted separately. When {skipcc} set to 1, Composing characters are ignored. Also see strlen(), strdisplaywidth() and strwidth(). {skipcc} is only available after 7.4.755. For backward compatibility, you can define a wrapper function:
if has("patch-7.4.755")function s:strchars(str, skipcc)return strchars(a:str, a:skipcc)endfunctionelsefunction s:strchars(str, skipcc)if a:skipccreturn strlen(substitute(a:str, ".", "x", "g"))elsereturn strchars(a:str)endifendfunctionendif
strcharpart({src}, {start} [, {len}]) strcharpart() Like strpart() but using character index and length instead of byte index and length. When a character index is used where a character does not exist it is assumed to be one character. For example:
strcharpart('abc', -1, 2)results in 'a'.
strdisplaywidth({expr} [, {col}]) strdisplaywidth() The result is a Number, which is the number of display cells String {expr} occupies on the screen when it starts at {col}. When {col} is omitted zero is used. Otherwise it is the screen column where to start. This matters for Tab characters. The option settings of the current window are used. This matters for anything that's displayed differently, such as 'tabstop' and 'display'. When {expr} contains characters with East Asian Width Class Ambiguous, this function's return value depends on 'ambiwidth'. Also see strlen(), strwidth() and strchars().
strftime({format} [, {time}]) strftime() The result is a String, which is a formatted date and time, as specified by the {format} string. The given {time} is used, or the current time if no time is given. The accepted {format} depends on your system, thus this is not portable! See the manual page of the C function strftime() for the format. The maximum length of the result is 80 characters. See also localtime() and getftime(). The language can be changed with the :language command. Examples:
:echo strftime("%c") Sun Apr 27 11:49:23 1997:echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25:echo strftime("%y%m%d %T") 970427 11:53:55:echo strftime("%H:%M") 11:55:echo strftime("%c", getftime("file.c"))Show mod time of file.c.
Not available on all systems. To check use:
if exists("*strftime")strgetchar({str}, {index}) strgetchar() Get character {index} from {str}. This uses a character index, not a byte index. Composing characters are considered separate characters here. Also see strcharpart() and strchars().
stridx({haystack}, {needle} [, {start}]) stridx() The result is a Number, which gives the byte index in {haystack} of the first occurrence of the String {needle}. If {start} is specified, the search starts at index {start}. This can be used to find a second match:
let colon1 = stridx(line, ":")let colon2 = stridx(line, ":", colon1 + 1)
The search is done case-sensitive. For pattern searches use match(). -1 is returned if the {needle} does not occur in {haystack}. See also strridx(). Examples:
echo stridx("An Example", "Example") 3echo stridx("Starting point", "Start") 0echo stridx("Starting point", "start") -1
strstr() strchr() stridx() works similar to the C function strstr(). When used with a single character it works similar to strchr().
string() string({expr}) Return {expr} converted to a String. If {expr} is a Number, Float, String or a composition of them, then the result can be parsed back with eval(). {expr} type resultString 'string' Number 123 Float 123.123456 or 1.123456e8 or `str2float('inf')` Funcref `function('name')` List [item, item] Dictionary {key: value, key: value} Note that in String values the ' character is doubled. Also see strtrans(). Note 2: Output format is mostly compatible with YAML, except for infinite and NaN floating-point values representations which use str2float(). Strings are also dumped literally, only single quote is escaped, which does not allow using YAML for parsing back binary strings. eval() should always work for strings and floats though and this is the only official method, use msgpackdump() or json_encode() if you need to share data with other application.
strlen() strlen({expr}) The result is a Number, which is the length of the String {expr} in bytes. If the argument is a Number it is first converted to a String. For other types an error is given. If you want to count the number of multi-byte characters use strchars(). Also see len(), strdisplaywidth() and strwidth().
strpart({src}, {start} [, {len}]) strpart() The result is a String, which is part of {src}, starting from byte {start}, with the byte length {len}. To count characters instead of bytes use strcharpart(). When bytes are selected which do not exist, this doesn't result in an error, the bytes are simply omitted. If {len} is missing, the copy continues from {start} till the end of the {src}.
strpart("abcdefg", 3, 2) == "de"strpart("abcdefg", -2, 4) == "ab"strpart("abcdefg", 5, 4) == "fg"strpart("abcdefg", 3) == "defg"
Note: To get the first character, {start} must be 0. For example, to get three bytes under and after the cursor:
strpart(getline("."), col(".") - 1, 3)strridx({haystack}, {needle} [, {start}]) strridx() The result is a Number, which gives the byte index in {haystack} of the last occurrence of the String {needle}. When {start} is specified, matches beyond this index are ignored. This can be used to find a match before a previous match:
let lastcomma = strridx(line, ",")let comma2 = strridx(line, ",", lastcomma - 1)
The search is done case-sensitive. For pattern searches use match(). -1 is returned if the {needle} does not occur in {haystack}. If the {needle} is empty the length of {haystack} is returned. See also stridx(). Examples:
echo strridx("an angry armadillo", "an") 3strrchr() When used with a single character it works similar to the C function strrchr().
strtrans({expr}) strtrans() The result is a String, which is {expr} with all unprintable characters translated into printable characters 'isprint'. Like they are shown in a window. Example:
echo strtrans(@a)This displays a newline in register a as "^@" instead of starting a new line.
strwidth({expr}) strwidth() The result is a Number, which is the number of display cells String {expr} occupies. A Tab character is counted as one cell, alternatively use strdisplaywidth(). When {expr} contains characters with East Asian Width Class Ambiguous, this function's return value depends on 'ambiwidth'. Also see strlen(), strdisplaywidth() and strchars().
submatch({nr} [, {list}]) submatch() E935 Only for an expression in a :substitute command or substitute() function. Returns the {nr}'th submatch of the matched text. When {nr} is 0 the whole matched text is returned. Note that a NL in the string can stand for a line break of a multi-line match or a NUL character in the text. Also see sub-replace-expression. If {list} is present and non-zero then submatch() returns a list of strings, similar to getline() with two arguments. NL characters in the text represent NUL characters in the text. Only returns more than one item for :substitute, inside substitute() this list will always contain one or zero items, since there are no real line breaks. When substitute() is used recursively only the submatches in the current (deepest) call can be obtained. Example:
s/\d\+/\=submatch(0) + 1/This finds the first number in the line and adds one to it. A line break is included as a newline character.
substitute({expr}, {pat}, {sub}, {flags}) substitute() The result is a String, which is a copy of {expr}, in which the first match of {pat} is replaced with {sub}. When {flags} is "g", all matches of {pat} in {expr} are replaced. Otherwise {flags} should be "". This works like the ":substitute" command (without any flags). But the matching with {pat} is always done like the 'magic' option is set and 'cpoptions' is empty (to make scripts portable). 'ignorecase' is still relevant, use /\c or /\C if you want to ignore or match case and ignore 'ignorecase'. 'smartcase' is not used. See string-match for how {pat} is used. A "~" in {sub} is not replaced with the previous {sub}. Note that some codes in {sub} have a special meaning sub-replace-special. For example, to replace something with "\n" (two characters), use "\\\\n" or '\\n'. When {pat} does not match in {expr}, {expr} is returned unmodified. Example:
let &path = substitute(&path, ",\\=[^,]*$", "", "")This removes the last component of the 'path' option.
echo substitute("testing", ".*", "\\U\\0", "")results in "TESTING". When {sub} starts with "\=", the remainder is interpreted as an expression. See sub-replace-expression. Example:
:echo substitute(s, '%\(\x\x\)',\ '\=nr2char("0x" . submatch(1))', 'g')
When {sub} is a Funcref that function is called, with one optional argument. Example:
echo substitute(s, '%\(\x\x\)', SubNr, 'g')The optional argument is a list which contains the whole matched string and up to nine submatches,like what submatch() returns. Example:
echo substitute(s, '\(\x\x\)', {m -> '0x' . m[1]}, 'g')synID({lnum}, {col}, {trans}) synID() The result is a Number, which is the syntax ID at the position {lnum} and {col} in the current window. The syntax ID can be used with synIDattr() and synIDtrans() to obtain syntax information about text. {col} is 1 for the leftmost column, {lnum} is 1 for the first line. 'synmaxcol' applies, in a longer line zero is returned. Note that when the position is after the last character, that's where the cursor can be in Insert mode, synID() returns zero. When {trans} is TRUE, transparent items are reduced to the item that they reveal. This is useful when wanting to know the effective color. When {trans} is FALSE, the transparent item is returned. This is useful when wanting to know which syntax item is effective (e.g. inside parens). Warning: This function can be very slow. Best speed is obtained by going through the file in forward direction. Example (echoes the name of the syntax item under the cursor):
echo synIDattr(synID(line("."), col("."), 1), "name")synIDattr({synID}, {what} [, {mode}]) synIDattr() The result is a String, which is the {what} attribute of syntax ID {synID}. This can be used to obtain information about a syntax item. {mode} can be "gui", "cterm" or "term", to get the attributes for that mode. When {mode} is omitted, or an invalid value is used, the attributes for the currently active highlighting are used (GUI, cterm or term). Use synIDtrans() to follow linked highlight groups. {what} result "name" the name of the syntax item "fg" foreground color (GUI: color name used to set the color, cterm: color number as a string, term: empty string) "bg" background color (as with "fg") "font" font name (only available in the GUI) highlight-font "sp" special color (as with "fg") highlight-guisp "fg#" like "fg", but for the GUI and the GUI is running the name in "#RRGGBB" form "bg#" like "fg#" for "bg" "sp#" like "fg#" for "sp" "bold" "1" if bold "italic" "1" if italic "reverse" "1" if reverse "inverse" "1" if inverse (= reverse) "standout" "1" if standout "underline" "1" if underlined "undercurl" "1" if undercurled Example (echoes the color of the syntax item under the cursor):
echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")synIDtrans({synID}) synIDtrans() The result is a Number, which is the translated syntax ID of {synID}. This is the syntax group ID of what is being used to highlight the character. Highlight links given with ":highlight link" are followed.
synconcealed({lnum}, {col}) synconcealed() The result is a List with currently three items: 1. The first item in the list is 0 if the character at the position {lnum} and {col} is not part of a concealable region, 1 if it is. 2. The second item in the list is a string. If the first item is 1, the second item contains the text which will be displayed in place of the concealed text, depending on the current setting of 'conceallevel' and 'listchars'. 3. The third and final item in the list is a number representing the specific syntax region matched in the line. When the character is not concealed the value is zero. This allows detection of the beginning of a new concealable region if there are two consecutive regions with the same replacement character. For an example, if the text is "123456" and both "23" and "45" are concealed and replace by the character "X", then: call returnssynconcealed(lnum, 1) [0, '', 0] synconcealed(lnum, 2) [1, 'X', 1] synconcealed(lnum, 3) [1, 'X', 1] synconcealed(lnum, 4) [1, 'X', 2] synconcealed(lnum, 5) [1, 'X', 2] synconcealed(lnum, 6) [0, '', 0]
synstack({lnum}, {col}) synstack() Return a List, which is the stack of syntax items at the position {lnum} and {col} in the current window. Each item in the List is an ID like what synID() returns. The first item in the List is the outer region, following are items contained in that one. The last one is what synID() returns, unless not the whole item is highlighted or it is a transparent item. This function is useful for debugging a syntax file. Example that shows the syntax stack under the cursor:
for id in synstack(line("."), col("."))echo synIDattr(id, "name")endfor
When the position specified with {lnum} and {col} is invalid nothing is returned. The position just after the last character in a line and the first column in an empty line are valid positions.
system({cmd} [, {input}]) system() E677 Get the output of {cmd} as a string (use systemlist() to get a List). {cmd} is treated exactly as in jobstart(). Not to be used for interactive commands. If {input} is a string it is written to a pipe and passed as stdin to the command. The string is written as-is, line separators are not changed. If {input} is a List it is written to the pipe as writefile() does with {binary} set to "b" (i.e. with a newline between each list item, and newlines inside list items converted to NULs). When {input} is given and is a valid buffer id, the content of the buffer is written to the file line by line, each line terminated by a NL (and NUL where the text has NL). E5677 Note: system() cannot write to or read from backgrounded ("&") shell commands, e.g.:
echo system("cat - &", "foo"))which is equivalent to:
$ echo foo | bash -c 'cat - &'The pipes are disconnected (unless overridden by shell redirection syntax) before input can reach it. Use jobstart() instead. Note: Use shellescape() or ::S with expand() or fnamemodify() to escape special characters in a command argument. Newlines in {cmd} may cause the command to fail. The characters in 'shellquote' and 'shellxquote' may also cause trouble. The result is a String. Example:
let files = system("ls " . shellescape(expand('%:h')))let files = system('ls ' . expand('%:h:S'))
To make the result more system-independent, the shell output is filtered to replace <CR> with <NL> for Macintosh, and <CR><NL> with <NL> for DOS-like systems. To avoid the string being truncated at a NUL, all NUL characters are replaced with SOH (0x01). The command executed is constructed using several options when {cmd} is a string: 'shell' 'shellcmdflag' {cmd} The resulting error code can be found in v:shell_error. This function will fail in restricted-mode. Note that any wrong value in the options mentioned above may make the function fail. It has also been reported to fail when using a security agent application. Unlike ":!cmd" there is no automatic check for changed files. Use :checktime to force a check.
systemlist({cmd} [, {input} [, {keepempty}]]) systemlist() Same as system(), but returns a List with lines (parts of output separated by NL) with NULs transformed into NLs. Output is the same as readfile() will output with {binary} argument set to "b", except that a final newline is not preserved, unless {keepempty} is non-zero. Note that on MS-Windows you may get trailing CR characters. Returns an empty string on error.
tabpagebuflist([{arg}]) tabpagebuflist() The result is a List, where each item is the number of the buffer associated with each window in the current tab page. {arg} specifies the number of the tab page to be used. When omitted the current tab page is used. When {arg} is invalid the number zero is returned. To get a list of all buffers in all tabs use this:
let buflist = []for i in range(tabpagenr('$'))call extend(buflist, tabpagebuflist(i + 1))endfor
Note that a buffer may appear in more than one window.
tabpagenr([{arg}]) tabpagenr() The result is a Number, which is the number of the current tab page. The first tab page has number 1. When the optional argument is "$", the number of the last tab page is returned (the tab page count). The number can be used with the :tab command.
tabpagewinnr({tabarg} [, {arg}]) tabpagewinnr() Like winnr() but for tab page {tabarg}. {tabarg} specifies the number of tab page to be used. {arg} is used like with winnr(): - When omitted the current window number is returned. This is the window which will be used when going to this tab page. - When "$" the number of windows is returned. - When "#" the previous window nr is returned. Useful examples:
tabpagewinnr(1) " current window of tab page 1tabpagewinnr(4, '$') " number of windows in tab page 4
When {tabarg} is invalid zero is returned.
tagfiles() tagfiles() Returns a List with the file names used to search for tags for the current buffer. This is the 'tags' option expanded.
taglist({expr} [, {filename}]) taglist() Returns a list of tags matching the regular expression {expr}. If {filename} is passed it is used to prioritize the results in the same way that :tselect does. See tag-priority. {filename} should be the full path of the file. Each list item is a dictionary with at least the following entries: name Name of the tag. filename Name of the file where the tag is defined. It is either relative to the current directory or a full path. cmd Ex command used to locate the tag in the file. kind Type of the tag. The value for this entry depends on the language specific kind values. Only available when using a tags file generated by Exuberant ctags or hdrtag. static A file specific tag. Refer to static-tag for more information. More entries may be present, depending on the content of the tags file: access, implementation, inherits and signature. Refer to the ctags documentation for information about these fields. For C code the fields "struct", "class" and "enum" may appear, they give the name of the entity the tag is contained in. The ex-command "cmd" can be either an ex search pattern, a line number or a line number followed by a byte number. If there are no matching tags, then an empty list is returned. To get an exact tag match, the anchors '^' and '$' should be used in {expr}. This also make the function work faster. Refer to tag-regexp for more information about the tag search regular expression pattern. Refer to 'tags' for information about how the tags file is located by Vim. Refer to tags-file-format for the format of the tags file generated by the different ctags tools.
tempname() tempname() temp-file-name The result is a String, which is the name of a file that doesn't exist. It can be used for a temporary file. Example:
let tmpfile = tempname()exe "redir > " . tmpfile
For Unix, the file will be in a private directory tempfile. For MS-Windows forward slashes are used when the 'shellslash' option is set or when 'shellcmdflag' starts with '-'.
termopen({cmd}[, {opts}]) {Nvim} termopen() Spawns {cmd} in a new pseudo-terminal session connected to the current buffer. {cmd} is the same as the one passed to jobstart(). This function fails if the current buffer is modified (all buffer contents are destroyed). The {opts} dict is similar to the one passed to jobstart(), but the pty,width,height, andTERMfields areignored: height/widthare taken from the current windowand $TERMis set to "xterm-256color".Returns the same values as jobstart(). See terminal for more information.
test_garbagecollect_now() test_garbagecollect_now() Like garbagecollect(), but executed right away. This must only be called directly to avoid any structure to exist internally, and v:testing must have been set before calling any function.
tan({expr}) tan() Return the tangent of {expr}, measured in radians, as a Float in the range [-inf, inf]. {expr} must evaluate to a Float or a Number. Examples:
echo tan(10)0.648361
echo tan(-4.01)-1.181502
tanh({expr}) tanh() Return the hyperbolic tangent of {expr} as a Float in the range [-1, 1]. {expr} must evaluate to a Float or a Number. Examples:
echo tanh(0.5)0.462117
echo tanh(-1)-0.761594
timer_info() timer_info([{id}]) Return a list with information about timers. When {id} is given only information about this timer is returned. When timer {id} does not exist an empty list is returned. When {id} is omitted information about all timers is returned. For each timer the information is stored in a Dictionary with these items: "id" the timer ID "time" time the timer was started with "repeat" number of times the timer will still fire; -1 means forever "callback" the callback
timer_pause({timer}, {paused}) timer_pause() Pause or unpause a timer. A paused timer does not invoke its callback when its time expires. Unpausing a timer may cause the callback to be invoked almost immediately if enough time has passed. Pausing a timer is useful to avoid the callback to be called for a short time. If {paused} evaluates to a non-zero Number or a non-empty String, then the timer is paused, otherwise it is unpaused. See non-zero-arg.
timer_start() timer timers timer_start({time}, {callback} [, {options}]) Create a timer and return the timer ID. {time} is the waiting time in milliseconds. This is the minimum time before invoking the callback. When the system is busy or Vim is not waiting for input the time will be longer. {callback} is the function to call. It can be the name of a function or a Funcref. It is called with one argument, which is the timer ID. The callback is only invoked when Vim is waiting for input. {options} is a dictionary. Supported entries: "repeat" Number of times to repeat calling the callback. -1 means forever. When not present the callback will be called once. Example:
func MyHandler(timer)echo 'Handler called'endfunclet timer = timer_start(500, 'MyHandler',\ {'repeat': 3})
This will invoke MyHandler() three times at 500 msec intervals.
timer_stop({timer}) timer_stop() Stop a timer. The timer callback will no longer be invoked. {timer} is an ID returned by timer_start(), thus it must be a Number. If {timer} does not exist there is no error.
timer_stopall() timer_stopall() Stop all timers. The timer callbacks will no longer be invoked. Useful if some timers is misbehaving. If there are no timers there is no error.
tolower({expr}) tolower() The result is a copy of the String given, with all uppercase characters turned into lowercase (just like applying gu to the string).
toupper({expr}) toupper() The result is a copy of the String given, with all lowercase characters turned into uppercase (just like applying gU to the string).
tr({src}, {fromstr}, {tostr}) tr() The result is a copy of the {src} string with all characters which appear in {fromstr} replaced by the character in that position in the {tostr} string. Thus the first character in {fromstr} is translated into the first character in {tostr} and so on. Exactly like the unix "tr" command. This code also deals with multibyte characters properly. Examples:
echo tr("hello there", "ht", "HT")returns "Hello THere"
echo tr("<blob>", "<>", "{}")returns "{blob}"
trunc({expr}) trunc() Return the largest integral value with magnitude less than or equal to {expr} as a Float (truncate towards zero). {expr} must evaluate to a Float or a Number. Examples:
echo trunc(1.456)1.0
echo trunc(-5.456)-5.0
echo trunc(4.0)4.0
type({expr}) type() The result is a Number representing the type of {expr}. Instead of using the number directly, it is better to use the v:t_ variable that has the value: Number: 0 (v:t_number) String: 1 (v:t_string) Funcref: 2 (v:t_func) List: 3 (v:t_list) Dictionary: 4 (v:t_dict) Float: 5 (v:t_float) Boolean: 6 (v:true and v:false) Null: 7 (v:null) For backward compatibility, this method can be used:
if type(myvar) == type(0)if type(myvar) == type("")if type(myvar) == type(function("tr"))if type(myvar) == type([])if type(myvar) == type({})if type(myvar) == type(0.0)if type(myvar) == type(v:true)
In place of checking for v:null type it is better to check for v:null directly as it is the only value of this type:
if myvar is v:nullTo check if the v:t_ variables exist use this:
if exists('v:t_number')undofile({name}) undofile() Return the name of the undo file that would be used for a file with name {name} when writing. This uses the 'undodir' option, finding directories that exist. It does not check if the undo file exists. {name} is always expanded to the full path, since that is what is used internally. If {name} is empty undofile() returns an empty string, since a buffer without a file name will not write an undo file. Useful in combination with :wundo and :rundo. When compiled without the +persistent_undo option this always returns an empty string.
undotree() undotree() Return the current state of the undo tree in a dictionary with the following items: "seq_last" The highest undo sequence number used. "seq_cur" The sequence number of the current position in the undo tree. This differs from "seq_last" when some changes were undone. "time_cur" Time last used for :earlier and related commands. Use strftime() to convert to something readable. "save_last" Number of the last file write. Zero when no write yet. "save_cur" Number of the current position in the undo tree. "synced" Non-zero when the last undo block was synced. This happens when waiting from input from the user. See undo-blocks. "entries" A list of dictionaries with information about undo blocks. The first item in the "entries" list is the oldest undo item. Each List item is a Dictionary with these items: "seq" Undo sequence number. Same as what appears in :undolist. "time" Timestamp when the change happened. Use strftime() to convert to something readable. "newhead" Only appears in the item that is the last one that was added. This marks the last change and where further changes will be added. "curhead" Only appears in the item that is the last one that was undone. This marks the current position in the undo tree, the block that will be used by a redo command. When nothing was undone after the last change this item will not appear anywhere. "save" Only appears on the last block before a file write. The number is the write count. The first write has number 1, the last one the "save_last" mentioned above. "alt" Alternate entry. This is again a List of undo blocks. Each item may again have an "alt" item.
uniq({list} [, {func} [, {dict}]]) uniq() E882 Remove second and succeeding copies of repeated adjacent {list} items in-place. Returns {list}. If you want a list to remain unmodified make a copy first:
let newlist = uniq(copy(mylist))The default compare function uses the string representation of each item. For the use of {func} and {dict} see sort().
values({dict}) values() Return a List with all the values of {dict}. The List is in arbitrary order.
virtcol({expr}) virtcol() The result is a Number, which is the screen column of the file position given with {expr}. That is, the last screen position occupied by the character at that position, when the screen would be of unlimited width. When there is a <Tab> at the position, the returned Number will be the column at the end of the <Tab>. For example, for a <Tab> in column 1, with 'ts' set to 8, it returns 8. conceal is ignored. For the byte position use col(). For the use of {expr} see col(). When 'virtualedit' is used {expr} can be [lnum, col, off], where "off" is the offset in screen columns from the start of the character. E.g., a position within a <Tab> or after the last character. When "off" is omitted zero is used. When Virtual editing is active in the current mode, a position beyond the end of the line can be returned. 'virtualedit' The accepted positions are: . the cursor position $ the end of the cursor line (the result is the number of displayed characters in the cursor line plus one) 'x position of mark x (if the mark is not set, 0 is returned) v In Visual mode: the start of the Visual area (the cursor is the end). When not in Visual mode returns the cursor position. Differs from '< in that it's updated right away. Note that only marks in the current file can be used. Examples:
virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5virtcol("$") with text "foo^Lbar", returns 9virtcol("'t") with text " there", with 't at 'h', returns 6
The first column is 1. 0 is returned for an error. A more advanced example that echoes the maximum length of all lines:
echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))visualmode([expr]) visualmode() The result is a String, which describes the last Visual mode used in the current buffer. Initially it returns an empty string, but once Visual mode has been used, it returns "v", "V", or "<CTRL-V>" (a single CTRL-V character) for character-wise, line-wise, or block-wise Visual mode respectively. Example:
exe "normal " . visualmode()This enters the same Visual mode as before. It is also useful in scripts if you wish to act differently depending on the Visual mode that was used. If Visual mode is active, use mode() to get the Visual mode (e.g., in a :vmap). If [expr] is supplied and it evaluates to a non-zero Number or a non-empty String, then the Visual mode will be cleared and the old value is returned. See non-zero-arg.
wildmenumode() wildmenumode() Returns TRUE when the wildmenu is active and FALSE otherwise. See 'wildmenu' and 'wildmode'. This can be used in mappings to handle the 'wildcharm' option gracefully. (Makes only sense with mapmode-c mappings). For example to make <c-j> work like <down> in wildmode, use:
cnoremap <expr> <C-j> wildmenumode() ? "\<Down>\<Tab>" : "\<c-j>"(Note, this needs the 'wildcharm' option set appropriately).
win_findbuf({bufnr}) win_findbuf() Returns a list with window-IDs for windows that contain buffer {bufnr}. When there is none the list is empty.
win_getid([{win} [, {tab}]]) win_getid() Get the window-ID for the specified window. When {win} is missing use the current window. With {win} this is the window number. The top window has number 1. Without {tab} use the current tab, otherwise the tab with number {tab}. The first tab has number one. Return zero if the window cannot be found.
win_gotoid({expr}) win_gotoid() Go to window with ID {expr}. This may also change the current tabpage. Return 1 if successful, 0 if the window cannot be found.
win_id2tabwin({expr} *win_id2tabwin()* Return a list with the tab number and window number of window with ID {expr}: [tabnr, winnr]. Return [0, 0] if the window cannot be found.
win_id2win({expr}) win_id2win() Return the window number of window with ID {expr}. Return 0 if the window cannot be found in the current tabpage.
winbufnr() winbufnr({nr}) The result is a Number, which is the number of the buffer associated with window {nr}. {nr} can be the window number or the window-ID. When {nr} is zero, the number of the buffer in the current window is returned. When window {nr} doesn't exist, -1 is returned. Example:
echo "The file in the current window is " . bufname(winbufnr(0))wincol() wincol() The result is a Number, which is the virtual column of the cursor in the window. This is counting screen cells from the left side of the window. The leftmost column is one.
winheight({nr}) winheight() The result is a Number, which is the height of window {nr}. {nr} can be the window number or the window-ID. When {nr} is zero, the height of the current window is returned. When window {nr} doesn't exist, -1 is returned. An existing window always has a height of zero or more. This excludes any window toolbar line. Examples:
echo "The current window has " . winheight(0) . " lines."winline() winline() The result is a Number, which is the screen line of the cursor in the window. This is counting screen lines from the top of the window. The first line is one. If the cursor was moved the view on the file will be updated first, this may cause a scroll.
winnr() winnr([{arg}]) The result is a Number, which is the number of the current window. The top window has number 1. When the optional argument is "$", the number of the last window is returned (the window count).
let window_count = winnr('$')When the optional argument is "#", the number of the last accessed window is returned (where CTRL-W_p goes to). If there is no previous window or it is in another tab page 0 is returned. The number can be used with CTRL-W_w and ":wincmd w" :wincmd. Also see tabpagewinnr() and win_getid().
winrestcmd() winrestcmd() Returns a sequence of :resize commands that should restore the current window sizes. Only works properly when no windows are opened or closed and the current window and tab page is unchanged. Example:
let cmd = winrestcmd()call MessWithWindowSizes()exe cmd
winrestview() winrestview({dict}) Uses the Dictionary returned by winsaveview() to restore the view of the current window. Note: The {dict} does not have to contain all values, that are returned by winsaveview(). If values are missing, those settings won't be restored. So you can use:
call winrestview({'curswant': 4})This will only set the curswant value (the column the cursor wants to move on vertical movements) of the cursor to column 5 (yes, that is 5), while all other settings will remain the same. This is useful, if you set the cursor position manually. If you have changed the values the result is unpredictable. If the window size changed the result won't be the same.
winsaveview() winsaveview() Returns a Dictionary that contains information to restore the view of the current window. Use winrestview() to restore the view. This is useful if you have a mapping that jumps around in the buffer and you want to go back to the original view. This does not save fold information. Use the 'foldenable' option to temporarily switch off folding, so that folds are not opened when moving around. This may have side effects. The return value includes: lnum cursor line number col cursor column (Note: the first column zero, as opposed to what getpos() returns) coladd cursor column offset for 'virtualedit' curswant column for vertical movement topline first line in the window topfill filler lines, only in diff mode leftcol first column displayed skipcol columns skipped Note that no option values are saved.
winwidth({nr}) winwidth() The result is a Number, which is the width of window {nr}. {nr} can be the window number or the window-ID. When {nr} is zero, the width of the current window is returned. When window {nr} doesn't exist, -1 is returned. An existing window always has a width of zero or more. Examples:
echo "The current window has " . winwidth(0) . " columns."if winwidth(0) <= 50exe "normal 50\<C-W>|"endif
For getting the terminal or screen size, see the 'columns' option.
wordcount() wordcount() The result is a dictionary of byte/chars/word statistics for the current buffer. This is the same info as provided by g_CTRL-G The return value includes: bytes Number of bytes in the buffer chars Number of chars in the buffer words Number of words in the buffer cursor_bytes Number of bytes before cursor position (not in Visual mode) cursor_chars Number of chars before cursor position (not in Visual mode) cursor_words Number of words before cursor position (not in Visual mode) visual_bytes Number of bytes visually selected (only in Visual mode) visual_chars Number of chars visually selected (only in Visual mode) visual_words Number of chars visually selected (only in Visual mode)
writefile() writefile({list}, {fname} [, {flags}]) Write List {list} to file {fname}. Each list item is separated with a NL. Each list item must be a String or Number. When {flags} contains "b" then binary mode is used: There will not be a NL after the last list item. An empty item at the end does cause the last line in the file to end in a NL. When {flags} contains "a" then append mode is used, lines are appended to the file:
call writefile(["foo"], "event.log", "a")call writefile(["bar"], "event.log", "a")
When {flags} contains "S" fsync() call is not used, with "s" it is used, 'fsync' option applies by default. No fsync() means that writefile() will finish faster, but writes may be left in OS buffers and not yet written to disk. Such changes will disappear if system crashes before OS does writing. All NL characters are replaced with a NUL character. Inserting CR characters needs to be done before passing {list} to writefile(). An existing file is overwritten, if possible. When the write fails -1 is returned, otherwise 0. There is an error message if the file can't be created or when writing fails. Also see readfile(). To copy a file byte for byte:
let fl = readfile("foo", "b")call writefile(fl, "foocopy", "b")
xor({expr}, {expr}) xor() Bitwise XOR on the two arguments. The arguments are converted to a number. A List, Dict or Float argument causes an error. Example:
let bits = xor(bits, 0x80)feature-list There are four types of features: 1. Features that are only supported when they have been enabled when Vim was compiled +feature-list. Example:
if has("cindent")2. Features that are only supported when certain conditions have been met. Example:
if has("win32")has-patch 3. Nvim version. The "nvim-0.2.1" feature means that the Nvim version is 0.2.1 or later. Example:
if has("nvim-0.2.1")4. Included patches. The "patch123" feature means that patch 123 has been included. Note that this form does not check the version of Vim, you need to inspect v:version for that. Example (checking version 6.2.148 or later):
if v:version > 602 || v:version == 602 && has("patch148")Note that it's possible for patch 147 to be omitted even though 148 is included. 5. Beyond a certain version or at a certain version and including a specific patch. The "patch-7.4.237" feature means that the Vim version is 7.5 or later, or it is version 7.4 and patch 237 was included. Note that this only works for patch 7.4.237 and later, before that you need to use the example above that checks v:version. Example:
if has("patch-7.4.248")Note that it's possible for patch 147 to be omitted even though 148 is included. Hint: To find out if Vim supports backslashes in a file name (MS-Windows), use: if exists('+shellslash')acl Compiled with ACL support. arabic Compiled with Arabic support Arabic. autocmd Compiled with autocommand support. autocommand browse Compiled with :browse support, and browse() will work. browsefilter Compiled with support for browsefilter. byte_offset Compiled with support for 'o' in 'statusline' cindent Compiled with 'cindent' support. clipboard Compiled with 'clipboard' support. cmdline_compl Compiled with cmdline-completion support. cmdline_hist Compiled with cmdline-history support. cmdline_info Compiled with 'showcmd' and 'ruler' support. comments Compiled with 'comments' support. cscope Compiled with cscope support. debug Compiled with "DEBUG" defined. dialog_con Compiled with console dialog support. digraphs Compiled with support for digraphs. eval Compiled with expression evaluation support. Always true, of course! ex_extra +ex_extra, always true now extra_search Compiled with support for 'incsearch' and 'hlsearch' farsi Compiled with Farsi support farsi. file_in_path Compiled with support for gf and <cfile> filterpipe When 'shelltemp' is off pipes are used for shell read/write/filter commands find_in_path Compiled with support for include file searches +find_in_path. float Compiled with support for Float. fname_case Case in file names matters (for Windows this is not present). folding Compiled with folding support. gettext Compiled with message translation multi-lang iconv Can use iconv() for conversion. insert_expand Compiled with support for CTRL-X expansion commands in Insert mode. jumplist Compiled with jumplist support. keymap Compiled with 'keymap' support. lambda Compiled with lambda support. langmap Compiled with 'langmap' support. libcall Compiled with libcall() support. linebreak Compiled with 'linebreak', 'breakat', 'showbreak' and 'breakindent' support. lispindent Compiled with support for lisp indenting. listcmds Compiled with commands for the buffer list :files and the argument list arglist. localmap Compiled with local mappings and abbr. :map-local mac macOS version of Nvim. menu Compiled with support for :menu. msgbuf Compiled with support for 'messagebuf'. mksession Compiled with support for :mksession. modify_fname Compiled with file name modifiers. filename-modifiers mouse Compiled with support mouse. mouseshape Compiled with support for 'mouseshape'. multi_byte Compiled with support for 'encoding' multi_byte_encoding 'encoding' is set to a multi-byte encoding. multi_lang Compiled with support for multiple languages. num64 Compiled with 64-bit Number support. nvim This is Nvim. has-patch path_extra Compiled with up/downwards search in 'path' and 'tags' persistent_undo Compiled with support for persistent undo history. postscript Compiled with PostScript file printing. printer Compiled with :hardcopy support. profile Compiled with :profile support. python Legacy Vim Python 2.x API is available. has-python python3 Legacy Vim Python 3.x API is available. has-python quickfix Compiled with quickfix support. reltime Compiled with reltime() support. rightleft Compiled with 'rightleft' support. scrollbind Compiled with 'scrollbind' support. shada Compiled with shada support. showcmd Compiled with 'showcmd' support. signs Compiled with :sign support. smartindent Compiled with 'smartindent' support. spell Compiled with spell checking support spell. startuptime Compiled with --startuptime support. statusline Compiled with support for 'statusline', 'rulerformat' and special formats of 'titlestring' and 'iconstring'. syntax Compiled with syntax highlighting support syntax. syntax_items There are active syntax highlighting items for the current buffer. tablineat 'tabline' option accepts %@Func@ items. tag_binary Compiled with binary searching in tags files tag-binary-search. tag_old_static Compiled with support for old static tags tag-old-static. tag_any_white Compiled with support for any white characters in tags files tag-any-white. termresponse Compiled with support for t_RV and v:termresponse. textobjects Compiled with support for text-objects. timers Compiled with timer_start() support. title Compiled with window title support 'title'. ttyin input is a terminal (tty) ttyout output is a terminal (tty) unix Unix version of Vim. unnamedplus Compiled with support for "unnamedplus" in 'clipboard' user_commands User-defined commands. vertsplit Compiled with vertically split windows :vsplit. vim_starting True while initial source'ing takes place. startup vim_starting virtualedit Compiled with 'virtualedit' option. visual Compiled with Visual mode. visualextra Compiled with extra Visual mode commands. blockwise-operators. vreplace Compiled with gR and gr commands. wildignore Compiled with 'wildignore' option. wildmenu Compiled with 'wildmenu' option. win32 Windows version of Vim (32 or 64 bit). winaltkeys Compiled with 'winaltkeys' option. windows Compiled with support for more than one window. writebackup Compiled with 'writebackup' default on. wsl WSL (Windows Subsystem for Linux) version of Vim.
string-match Matching a pattern in a String A regexp pattern as explained at pattern is normally used to find a match in the buffer lines. When a pattern is used to find a match in a String, almost everything works in the same way. The difference is that a String is handled like it is one line. When it contains a "\n" character, this is not seen as a line break for the pattern. It can be matched with a "\n" in the pattern, or with ".". Example:
:let a = "aaaa\nxxxx":echo matchstr(a, "..\n..")aaxx:echo matchstr(a, "a.x")ax
Don't forget that "^" will only match at the first character of the String and "$" at the last character of the string. They don't match after or before a "\n".
5. Defining functions user-functions
New functions can be defined. These can be called just like builtin functions. The function executes a sequence of Ex commands. Normal mode commands can be executed with the :normal command. The function name must start with an uppercase letter, to avoid confusion with builtin functions. To prevent from using the same name in different scripts avoid obvious, short names. A good habit is to start the function name with the name of the script, e.g., "HTMLcolor()". It's also possible to use curly braces, see curly-braces-names. And the autoload facility is useful to define a function only when it's called.
local-function A function local to a script must start with "s:". A local script function can only be called from within the script and from functions, user commands and autocommands defined in the script. It is also possible to call the function from a mapping defined in the script, but then <SID> must be used instead of "s:" when the mapping is expanded outside of the script. There are only script-local functions, no buffer-local or window-local functions.
:fu :function E128 E129 E123 :fu[nction] List all functions and their arguments. :fu[nction] {name} List function {name}. {name} can also be a Dictionary entry that is a Funcref:
function dict.init:fu[nction] /{pattern} List functions with a name matching {pattern}. Example that lists all functions ending with "File":
function /File$:function-verbose When 'verbose' is non-zero, listing a function will also display where it was last defined. Example:
:verbose function SetFileTypeSHfunction SetFileTypeSH(name)Last set from /usr/share/vim/vim-7.0/filetype.vim
See :verbose-cmd for more information.
E124 E125 E853 E884 :fu[nction][!] {name}([arguments]) [range] [abort] [dict] [closure] Define a new function by the name {name}. The body of the function follows in the next lines, until the matching :endfunction. The name must be made of alphanumeric characters and '_', and must start with a capital or "s:" (see above). Note that using "b:" or "g:" is not allowed. (since patch 7.4.260 E884 is given if the function name has a colon in the name, e.g. for "foo:bar()". Before that patch no error was given). {name} can also be a Dictionary entry that is a Funcref:
function dict.init(arg)"dict" must be an existing dictionary. The entry "init" is added if it didn't exist yet. Otherwise [!] is required to overwrite an existing function. The result is a Funcref to a numbered function. The function can only be used with a Funcref and will be deleted if there are no more references to it. E127 E122 When a function by this name already exists and [!] is not used an error message is given. When [!] is used, an existing function is silently replaced. Unless it is currently being executed, that is an error. For the {arguments} see function-argument.
:func-range a:firstline a:lastline When the [range] argument is added, the function is expected to take care of a range itself. The range is passed as "a:firstline" and "a:lastline". If [range] is excluded, ":{range}call" will call the function for each line in the range, with the cursor on the start of each line. See function-range-example. The cursor is still moved to the first line of the range, as is the case with all Ex commands. :func-abort When the [abort] argument is added, the function will abort as soon as an error is detected. :func-dict When the [dict] argument is added, the function must be invoked through an entry in a Dictionary. The local variable "self" will then be set to the dictionary. See Dictionary-function. :func-closure E932 When the [closure] argument is added, the function can access variables and arguments from the outer scope. This is usually called a closure. In this example Bar() uses "x" from the scope of Foo(). It remains referenced even after Foo() returns:
function! Foo()let x = 0function! Bar() closurelet x += 1return xendfunctionreturn funcref('Bar')endfunctionlet F = Foo()echo F()
1
echo F()2
echo F()3
function-search-undo The last used search pattern and the redo command "." will not be changed by the function. This also implies that the effect of :nohlsearch is undone when the function returns.
:endf :endfunction E126 E193 :endf[unction] The end of a function definition. Must be on a line by its own, without other commands.
:delf :delfunction E130 E131 E933 :delf[unction] {name} Delete function {name}. {name} can also be a Dictionary entry that is a Funcref:
delfunc dict.initThis will remove the "init" entry from "dict". The function is deleted if there are no more references to it. :retu :return E133 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is evaluated and returned as the result of the function. If "[expr]" is not given, the number 0 is returned. When a function ends without an explicit ":return", the number 0 is returned. Note that there is no check for unreachable lines, thus there is no warning if commands follow ":return". If the ":return" is used after a :try but before the matching :finally (if present), the commands following the ":finally" up to the matching :endtry are executed first. This process applies to all nested ":try"s inside the function. The function returns at the outermost ":endtry".
function-argument a:var An argument can be defined by giving its name. In the function this can then be used as "a:name" ("a:" for argument). a:0 a:1 a:000 E740 ... Up to 20 arguments can be given, separated by commas. After the named arguments an argument "..." can be specified, which means that more arguments may optionally be following. In the function the extra arguments can be used as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which can be 0). "a:000" is set to a List that contains these arguments. Note that "a:1" is the same as "a:000[0]". E742 The a: scope and the variables in it cannot be changed, they are fixed. However, if a composite type is used, such as List or Dictionary , you can change their contents. Thus you can pass a List to a function and have the function add an item to it. If you want to make sure the function cannot change a List or Dictionary use :lockvar. When not using "...", the number of arguments in a function call must be equal to the number of named arguments. When using "...", the number of arguments may be larger. It is also possible to define a function without any arguments. You must still supply the () then. It is allowed to define another function inside a function body.
local-variables Inside a function local variables can be used. These will disappear when the function returns. Global variables need to be accessed with "g:". Example:
function Table(title, ...)echohl Titleecho a:titleechohl Noneecho a:0 . " items:"for s in a:000echon ' ' . sendforendfunction
This function can then be called with:
call Table("Table", "line1", "line2")call Table("Empty Table")
To return more than one value, return a List:
function Compute(n1, n2)if a:n2 == 0return ["fail", 0]endifreturn ["ok", a:n1 / a:n2]endfunction
This function can then be called with:
let [success, div] = Compute(102, 6)if success == "ok"echo divendif
:cal :call E107 E117 :[range]cal[l] {name}([arguments]) Call a function. The name of the function and its arguments are as specified with :function. Up to 20 arguments can be used. The returned value is discarded. Without a range and for functions that accept a range, the function is called once. When a range is given the cursor is positioned at the start of the first line before executing the function. When a range is given and the function doesn't handle it itself, the function is executed for each line in the range, with the cursor in the first column of that line. The cursor is left at the last line (possibly moved by the last function call). The arguments are re-evaluated for each line. Thus this works: function-range-example
function Mynumber(arg)echo line(".") . " " . a:argendfunction1,5call Mynumber(getline("."))
The "a:firstline" and "a:lastline" are defined anyway, they can be used to do something different at the start or end of the range. Example of a function that handles the range itself:
function Cont() rangeexecute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ 'endfunction4,8call Cont()
This function inserts the continuation character "\" in front of all the lines in the range, except the first one. When the function returns a composite value it can be further dereferenced, but the range will not be used then. Example:
4,8call GetDict().method()Here GetDict() gets the range but method() does not.
E132 The recursiveness of user functions is restricted with the 'maxfuncdepth' option. AUTOMATICALLY LOADING FUNCTIONS autoload-functions When using many or large functions, it's possible to automatically define them only when they are used. There are two methods: with an autocommand and with the "autoload" directory in 'runtimepath'. Using an autocommand This is introduced in the user manual, section 41.14. The autocommand is useful if you have a plugin that is a long Vim script file. You can define the autocommand and quickly quit the script with :finish. That makes Vim startup faster. The autocommand should then load the same file again, setting a variable to skip the :finish command. Use the FuncUndefined autocommand event with a pattern that matches the function(s) to be defined. Example:
au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vimThe file "~/vim/bufnetfuncs.vim" should then define functions that start with "BufNet". Also see FuncUndefined. Using an autoload script autoload E746 This is introduced in the user manual, section 41.15. Using a script in the "autoload" directory is simpler, but requires using exactly the right file name. A function that can be autoloaded has a name like this:
call filename#funcname()When such a function is called, and it is not defined yet, Vim will search the "autoload" directories in 'runtimepath' for a script file called "filename.vim". For example "~/.config/nvim/autoload/filename.vim". That file should then define the function like this:
function filename#funcname()echo "Done!"endfunction
The file name and the name used before the # in the function must match exactly, and the defined function must have the name exactly as it will be called. It is possible to use subdirectories. Every # in the function name works like a path separator. Thus when calling a function:
call foo#bar#func()Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'. This also works when reading a variable that has not been set yet:
let l = foo#bar#lvarHowever, when the autoload script was already loaded it won't be loaded again for an unknown variable. When assigning a value to such a variable nothing special happens. This can be used to pass settings to the autoload script before it's loaded:
let foo#bar#toggle = 1call foo#bar#func()
Note that when you make a mistake and call a function that is supposed to be defined in an autoload script, but the script doesn't actually define the function, the script will be sourced every time you try to call the function. And you will get an error message every time. Also note that if you have two script files, and one calls a function in the other and vice versa, before the used function is defined, it won't work. Avoid using the autoload functionality at the toplevel. Hint: If you distribute a bunch of scripts you can pack them together with the vimball utility. Also read the user manual distribute-script.
6. Curly braces names curly-braces-names
In most places where you can use a variable, you can use a "curly braces name" variable. This is a regular variable name with one or more expressions wrapped in braces {} like this:
my_{adjective}_variableWhen Vim encounters this, it evaluates the expression inside the braces, puts that in place of the expression, and re-interprets the whole as a variable name. So in the above example, if the variable "adjective" was set to "noisy", then the reference would be to "my_noisy_variable", whereas if "adjective" was set to "quiet", then it would be to "my_quiet_variable". One application for this is to create a set of variables governed by an option value. For example, the statement
echo my_{&background}_messagewould output the contents of "my_dark_message" or "my_light_message" depending on the current value of 'background'. You can use multiple brace pairs:
echo my_{adverb}_{adjective}_message..or even nest them:
echo my_{ad{end_of_word}}_messagewhere "end_of_word" is either "verb" or "jective". However, the expression inside the braces must evaluate to a valid single variable name, e.g. this is invalid:
let foo='a + b'echo c{foo}d
.. since the result of expansion is "ca + bd", which is not a variable name.
curly-braces-function-names You can call and define functions by an evaluated name in a similar way. Example:
let func_end='whizz'call my_func_{func_end}(parameter)
This would call the function "my_func_whizz(parameter)". This does NOT work:
let i = 3let @{i} = '' " errorecho @{i} " error
7. Commands expression-commands
:let {var-name} = {expr1} :let E18 Set internal variable {var-name} to the result of the expression {expr1}. The variable will get the type from the {expr}. If {var-name} didn't exist yet, it is created.
:let {var-name}[{idx}] = {expr1} E689 Set a list item to the result of the expression {expr1}. {var-name} must refer to a list and {idx} must be a valid index in that list. For nested list the index can be repeated. This cannot be used to add an item to a List. This cannot be used to set a byte in a String. You can do that like this:
let var = var[0:2] . 'X' . var[4:]E711 E719 :let {var-name}[{idx1}:{idx2}] = {expr1} E708 E709 E710 Set a sequence of items in a List to the result of the expression {expr1}, which must be a list with the correct number of items. {idx1} can be omitted, zero is used instead. {idx2} can be omitted, meaning the end of the list. When the selected range of items is partly past the end of the list, items will be added.
:let+= :let-= :let.= E734 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}". :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}". :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}". These fail if {var} was not set yet and when the type of {var} and {expr1} don't fit the operator.
:let ${env-name} = {expr1} :let-environment :let-$ Set environment variable {env-name} to the result of the expression {expr1}. The type is always String. :let ${env-name} .= {expr1} Append {expr1} to the environment variable {env-name}. If the environment variable didn't exist yet this works like "=".
:let @{reg-name} = {expr1} :let-register :let-@ Write the result of the expression {expr1} in register {reg-name}. {reg-name} must be a single letter, and must be the name of a writable register (see registers). "@@" can be used for the unnamed register, "@/" for the search pattern. If the result of {expr1} ends in a <CR> or <NL>, the register will be linewise, otherwise it will be set to characterwise. This can be used to clear the last search pattern:
let @/ = ""This is different from searching for an empty string, that would match everywhere. :let @{reg-name} .= {expr1} Append {expr1} to register {reg-name}. If the register was empty it's like setting it to {expr1}.
:let &{option-name} = {expr1} :let-option :let-& Set option {option-name} to the result of the expression {expr1}. A String or Number value is always converted to the type of the option. For an option local to a window or buffer the effect is just like using the :set command: both the local value and the global value are changed. Example:
let &path = &path . ',/usr/local/include':let &{option-name} .= {expr1} For a string option: Append {expr1} to the value. Does not insert a comma like :set+=. :let &{option-name} += {expr1} :let &{option-name} -= {expr1} For a number or boolean option: Add or subtract {expr1}. :let &l:{option-name} = {expr1} :let &l:{option-name} .= {expr1} :let &l:{option-name} += {expr1} :let &l:{option-name} -= {expr1} Like above, but only set the local value of an option (if there is one). Works like :setlocal. :let &g:{option-name} = {expr1} :let &g:{option-name} .= {expr1} :let &g:{option-name} += {expr1} :let &g:{option-name} -= {expr1} Like above, but only set the global value of an option (if there is one). Works like :setglobal.
:let [{name1}, {name2}, ...] = {expr1} :let-unpack E687 E688 {expr1} must evaluate to a List. The first item in the list is assigned to {name1}, the second item to {name2}, etc. The number of names must match the number of items in the List. Each name can be one of the items of the ":let" command as mentioned above. Example:
let [s, item] = GetItem(s)Detail: {expr1} is evaluated first, then the assignments are done in sequence. This matters if {name2} depends on {name1}. Example:
let x = [0, 1]let i = 0let [i, x[i]] = [1, 2]echo x
The result is [0, 2]. :let [{name1}, {name2}, ...] .= {expr1} :let [{name1}, {name2}, ...] += {expr1} :let [{name1}, {name2}, ...] -= {expr1} Like above, but append/add/subtract the value for each List item. :let [{name}, ..., ; {lastname}] = {expr1} Like :let-unpack above, but the List may have more items than there are names. A list of the remaining items is assigned to {lastname}. If there are no remaining items {lastname} is set to an empty list. Example:
let [a, b; rest] = ["aval", "bval", 3, 4]:let [{name}, ..., ; {lastname}] .= {expr1} :let [{name}, ..., ; {lastname}] += {expr1} :let [{name}, ..., ; {lastname}] -= {expr1} Like above, but append/add/subtract the value for each List item.
E121 :let {var-name} .. List the value of variable {var-name}. Multiple variable names may be given. Special names recognized here: E738 g: global variables b: local buffer variables w: local window variables t: local tab page variables s: script-local variables l: local function variables v: Vim variables. :let List the values of all variables. The type of the variable is indicated before the value: <nothing> String # Number * Funcref
:unl[et][!] {name} ... :unlet :unl E108 E795 Remove the internal variable {name}. Several variable names can be given, they are all removed. The name may also be a List or Dictionary item. With [!] no error message is given for non-existing variables. One or more items from a List can be removed:
unlet list[3] " remove fourth itemunlet list[3:] " remove fourth item to last
One item from a Dictionary can be removed at a time:
unlet dict['two']unlet dict.two
This is especially useful to clean up used global variables and script-local variables (these are not deleted when the script ends). Function-local variables are automatically deleted when the function ends.
:lockv[ar][!] [depth] {name} ... :lockvar :lockv Lock the internal variable {name}. Locking means that it can no longer be changed (until it is unlocked). A locked variable can be deleted:
lockvar vlet v = 'asdf' " fails!unlet v
E741 E940 If you try to change a locked variable you get an error message: "E741: Value is locked: {name}". If you try to lock or unlock a built-in variable you will get an error message "E940: Cannot lock or unlock variable {name}". [depth] is relevant when locking a List or Dictionary. It specifies how deep the locking goes: 1 Lock the List or Dictionary itself, cannot add or remove items, but can still change their values. 2 Also lock the values, cannot change the items. If an item is a List or Dictionary, cannot add or remove items, but can still change the values. 3 Like 2 but for the List / Dictionary in the List / Dictionary, one level deeper. The default [depth] is 2, thus when {name} is a List or Dictionary the values cannot be changed. E743 For unlimited depth use [!] and omit [depth]. However, there is a maximum depth of 100 to catch loops. Note that when two variables refer to the same List and you lock one of them, the List will also be locked when used through the other variable. Example:
let l = [0, 1, 2, 3]let cl = llockvar llet cl[1] = 99 " won't work!
You may want to make a copy of a list to avoid this. See deepcopy().
:unlo[ckvar][!] [depth] {name} ... :unlockvar :unlo Unlock the internal variable {name}. Does the opposite of :lockvar.
:if {expr1} :if :endif :en E171 E579 E580 :en[dif] Execute the commands until the next matching ":else" or ":endif" if {expr1} evaluates to non-zero. From Vim version 4.5 until 5.0, every Ex command in between the ":if" and ":endif" is ignored. These two commands were just to allow for future expansions in a backward compatible way. Nesting was allowed. Note that any ":else" or ":elseif" was ignored, the "else" part was not executed either. You can use this to remain compatible with older versions:
if version >= 500version-5-specific-commandsendif
The commands still need to be parsed to find the "endif". Sometimes an older Vim has a problem with a new command. For example, ":silent" is recognized as a ":substitute" command. In that case ":execute" can avoid problems:
if version >= 600execute "silent 1,$delete"endif
NOTE: The ":append" and ":insert" commands don't work properly in between ":if" and ":endif".
:else :el E581 E583 :el[se] Execute the commands until the next matching ":else" or ":endif" if they previously were not being executed.
:elseif :elsei E582 E584 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there is no extra ":endif".
:wh[ile] {expr1} :while :endwhile :wh :endw E170 E585 E588 E733 :endw[hile] Repeat the commands between ":while" and ":endwhile", as long as {expr1} evaluates to non-zero. When an error is detected from a command inside the loop, execution continues after the "endwhile". Example:
let lnum = 1while lnum <= line("$"):call FixLine(lnum):let lnum = lnum + 1endwhile
NOTE: The ":append" and ":insert" commands don't work properly inside a ":while" and ":for" loop.
:for {var} in {list} :for E690 E732 :endfo[r] :endfo :endfor Repeat the commands between ":for" and ":endfor" for each item in {list}. Variable {var} is set to the value of each item. When an error is detected for a command inside the loop, execution continues after the "endfor". Changing {list} inside the loop affects what items are used. Make a copy if this is unwanted:
for item in copy(mylist)When not making a copy, Vim stores a reference to the next item in the list, before executing the commands with the current item. Thus the current item can be removed without effect. Removing any later item means it will not be found. Thus the following example works (an inefficient way to make a list empty):
for item in mylistcall remove(mylist, 0)endfor
Note that reordering the list (e.g., with sort() or reverse()) may have unexpected effects. :for [{var1}, {var2}, ...] in {listlist} :endfo[r] Like ":for" above, but each item in {listlist} must be a list, of which each item is assigned to {var1}, {var2}, etc. Example:
for [lnum, col] in [[1, 3], [2, 5], [3, 8]]:echo getline(lnum)[col]endfor
:continue :con E586 :con[tinue] When used inside a ":while" or ":for" loop, jumps back to the start of the loop. If it is used after a :try inside the loop but before the matching :finally (if present), the commands following the ":finally" up to the matching :endtry are executed first. This process applies to all nested ":try"s inside the loop. The outermost ":endtry" then jumps back to the start of the loop.
:break :brea E587 :brea[k] When used inside a ":while" or ":for" loop, skips to the command after the matching ":endwhile" or ":endfor". If it is used after a :try inside the loop but before the matching :finally (if present), the commands following the ":finally" up to the matching :endtry are executed first. This process applies to all nested ":try"s inside the loop. The outermost ":endtry" then jumps to the command after the loop.
:try :try :endt :endtry E600 E601 E602 :endt[ry] Change the error handling for the commands between ":try" and ":endtry" including everything being executed across ":source" commands, function calls, or autocommand invocations. When an error or interrupt is detected and there is a :finally command following, execution continues after the ":finally". Otherwise, or when the ":endtry" is reached thereafter, the next (dynamically) surrounding ":try" is checked for a corresponding ":finally" etc. Then the script processing is terminated. (Whether a function definition has an "abort" argument does not matter.) Example:
try | edit too much | finally | echo "cleanup" | endtryecho "impossible" " not reached, script terminated above
Moreover, an error or interrupt (dynamically) inside ":try" and ":endtry" is converted to an exception. It can be caught as if it were thrown by a :throw command (see :catch). In this case, the script processing is not terminated. The value "Vim:Interrupt" is used for an interrupt exception. An error in a Vim command is converted to a value of the form "Vim({command}):{errmsg}", other errors are converted to a value of the form "Vim:{errmsg}". {command} is the full command name, and {errmsg} is the message that is displayed if the error exception is not caught, always beginning with the error number. Examples:
try | sleep 100 | catch /^Vim:Interrupt$/ | endtrytry | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry
:cat :catch E603 E604 E605 :cat[ch] /{pattern}/ The following commands until the next :catch, :finally, or :endtry that belongs to the same :try as the ":catch" are executed when an exception matching {pattern} is being thrown and has not yet been caught by a previous ":catch". Otherwise, these commands are skipped. When {pattern} is omitted all errors are caught. Examples:
catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C)catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errorscatch /^Vim\%((\a\+)\)\=:/ " catch errors and interruptscatch /^Vim(write):/ " catch all errors in :writecatch /^Vim\%((\a\+)\)\=:E123/ " catch error E123catch /my-exception/ " catch user exceptioncatch /.*/ " catch everythingcatch " same as /.*/
Another character can be used instead of / around the {pattern}, so long as it does not have a special meaning (e.g., '|' or '"') and doesn't occur inside {pattern}. Information about the exception is available in v:exception. Also see throw-variables. NOTE: It is not reliable to ":catch" the TEXT of an error message because it may vary in different locales.
:fina :finally E606 E607 :fina[lly] The following commands until the matching :endtry are executed whenever the part between the matching :try and the ":finally" is left: either by falling through to the ":finally" or by a :continue, :break, :finish, or :return, or by an error or interrupt or exception (see :throw).
:th :throw E608 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception. If the ":throw" is used after a :try but before the first corresponding :catch, commands are skipped until the first ":catch" matching {expr1} is reached. If there is no such ":catch" or if the ":throw" is used after a ":catch" but before the :finally, the commands following the ":finally" (if present) up to the matching :endtry are executed. If the ":throw" is after the ":finally", commands up to the ":endtry" are skipped. At the ":endtry", this process applies again for the next dynamically surrounding ":try" (which may be found in a calling function or sourcing script), until a matching ":catch" has been found. If the exception is not caught, the command processing is terminated. Example:
try | throw "oops" | catch /^oo/ | echo "caught" | endtryNote that "catch" may need to be on a separate line for when an error causes the parsing to skip the whole line and not see the "|" that separates the commands.
:ec :echo :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The first {expr1} starts on a new line. Also see :comment. Use "\n" to start a new line. Use "\r" to move the cursor to the first column. Uses the highlighting set by the :echohl command. Cannot be followed by a comment. Example:
echo "the value of 'shell' is" &shell:echo-redraw A later redraw may make the message disappear again. And since Vim mostly postpones redrawing until it's finished with a sequence of commands this happens quite often. To avoid that a command from before the ":echo" causes a redraw afterwards (redraws are often postponed until you type something), force a redraw with the :redraw command. Example:
new | redraw | echo "there is a new window":echo-self-refer When printing nested containers echo prints second occurrence of the self-referencing container using "[...@level]" (self-referencing List) or "{...@level}" (self-referencing Dict):
let l = []call add(l, l)let l2 = []call add(l2, [l2])echo l l2
echoes "[[...@0]] [[[...@0]]]". Echoing "[l]" will echo "[[[...@1]]]" because l first occurs at second level.
:echon :echon {expr1} .. Echoes each {expr1}, without anything added. Also see :comment. Uses the highlighting set by the :echohl command. Cannot be followed by a comment. Example:
echon "the value of 'shell' is " &shellNote the difference between using ":echo", which is a Vim command, and ":!echo", which is an external shell command:
!echo % --> filenameThe arguments of ":!" are expanded, see :_%.
!echo "%" --> filename or "filename"Like the previous example. Whether you see the double quotes or not depends on your 'shell'.
echo % --> nothingThe '%' is an illegal character in an expression.
echo "%" --> %This just echoes the '%' character.
echo expand("%") --> filenameThis calls the expand() function to expand the '%'.
:echoh :echohl :echoh[l] {name} Use the highlight group {name} for the following :echo, :echon and :echomsg commands. Also used for the input() prompt. Example:
echohl WarningMsg | echo "Don't panic!" | echohl NoneDon't forget to set the group back to "None", otherwise all following echo's will be highlighted.
:echom :echomsg :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the message in the message-history. Spaces are placed between the arguments as with the :echo command. But unprintable characters are displayed, not interpreted. The parsing works slightly different from :echo, more like :execute. All the expressions are first evaluated and concatenated before echoing anything. The expressions must evaluate to a Number or String, a Dictionary or List causes an error. Uses the highlighting set by the :echohl command. Example:
echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."See :echo-redraw to avoid the message disappearing when the screen is redrawn. :echoe :echoerr :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the message in the message-history. When used in a script or function the line number will be added. Spaces are placed between the arguments as with the :echo command. When used inside a try conditional, the message is raised as an error exception instead (see try-echoerr). Example:
echoerr "This script just failed!"If you just want a highlighted message use :echohl. And to get a beep:
exe "normal \<Esc>":exe :execute :exe[cute] {expr1} .. Executes the string that results from the evaluation of {expr1} as an Ex command. Multiple arguments are concatenated, with a space in between. To avoid the extra space use the "." operator to concatenate strings into one argument. {expr1} is used as the processed command, command line editing keys are not recognized. Cannot be followed by a comment. Examples:
execute "buffer" nextbufexecute "normal" count . "w"
":execute" can be used to append a command to commands that don't accept a '|'. Example:
execute '!ls' | echo "theend"":execute" is also a nice way to avoid having to type control characters in a Vim script for a ":normal" command:
execute "normal ixxx\<Esc>"This has an <Esc> character, see expr-string. Be careful to correctly escape special characters in file names. The fnameescape() function can be used for Vim commands, shellescape() for :! commands. Examples:
execute "e " . fnameescape(filename)execute "!ls " . shellescape(filename, 1)
Note: The executed string may be any command-line, but starting or ending "if", "while" and "for" does not always work, because when commands are skipped the ":execute" is not evaluated and Vim loses track of where blocks start and end. Also "break" and "continue" should not be inside ":execute". This example does not work, because the ":execute" is not evaluated and Vim does not see the "while", and gives an error for finding an ":endwhile":
if 0execute 'while i > 5'echo "test"endwhileendif
It is allowed to have a "while" or "if" command completely in the executed string:
execute 'while i < 5 | echo i | let i = i + 1 | endwhile':exe-comment ":execute", ":echo" and ":echon" cannot be followed by a comment directly, because they see the '"' as the start of a string. But, you can use '|' followed by a comment. Example:
echo "foo" | "this is a comment
8. Exception handling exception-handling
The Vim script language comprises an exception handling feature. This section explains how it can be used in a Vim script. Exceptions may be raised by Vim on an error or on interrupt, see catch-errors and catch-interrupt. You can also explicitly throw an exception by using the ":throw" command, see throw-catch.
TRY CONDITIONALS try-conditionals
Exceptions can be caught or can cause cleanup code to be executed. You can use a try conditional to specify catch clauses (that catch exceptions) and/or a finally clause (to be executed for cleanup). A try conditional begins with a :try command and ends at the matching :endtry command. In between, you can use a :catch command to start a catch clause, or a :finally command to start a finally clause. There may be none or multiple catch clauses, but there is at most one finally clause, which must not be followed by any catch clauses. The lines before the catch clauses and the finally clause is called a try block.
try...... TRY BLOCK...catch /{pattern}/...... CATCH CLAUSE...catch /{pattern}/...... CATCH CLAUSE...finally...... FINALLY CLAUSE...endtry
The try conditional allows to watch code for exceptions and to take the appropriate actions. Exceptions from the try block may be caught. Exceptions from the try block and also the catch clauses may cause cleanup actions. When no exception is thrown during execution of the try block, the control is transferred to the finally clause, if present. After its execution, the script continues with the line following the ":endtry". When an exception occurs during execution of the try block, the remaining lines in the try block are skipped. The exception is matched against the patterns specified as arguments to the ":catch" commands. The catch clause after the first matching ":catch" is taken, other catch clauses are not executed. The catch clause ends when the next ":catch", ":finally", or ":endtry" command is reached - whatever is first. Then, the finally clause (if present) is executed. When the ":endtry" is reached, the script execution continues in the following line as usual. When an exception that does not match any of the patterns specified by the ":catch" commands is thrown in the try block, the exception is not caught by that try conditional and none of the catch clauses is executed. Only the finally clause, if present, is taken. The exception pends during execution of the finally clause. It is resumed at the ":endtry", so that commands after the ":endtry" are not executed and the exception might be caught elsewhere, see try-nesting. When during execution of a catch clause another exception is thrown, the remaining lines in that catch clause are not executed. The new exception is not matched against the patterns in any of the ":catch" commands of the same try conditional and none of its catch clauses is taken. If there is, however, a finally clause, it is executed, and the exception pends during its execution. The commands following the ":endtry" are not executed. The new exception might, however, be caught elsewhere, see try-nesting. When during execution of the finally clause (if present) an exception is thrown, the remaining lines in the finally clause are skipped. If the finally clause has been taken because of an exception from the try block or one of the catch clauses, the original (pending) exception is discarded. The commands following the ":endtry" are not executed, and the exception from the finally clause is propagated and can be caught elsewhere, see try-nesting. The finally clause is also executed, when a ":break" or ":continue" for a ":while" loop enclosing the complete try conditional is executed from the try block or a catch clause. Or when a ":return" or ":finish" is executed from the try block or a catch clause of a try conditional in a function or sourced script, respectively. The ":break", ":continue", ":return", or ":finish" pends during execution of the finally clause and is resumed when the ":endtry" is reached. It is, however, discarded when an exception is thrown from the finally clause. When a ":break" or ":continue" for a ":while" loop enclosing the complete try conditional or when a ":return" or ":finish" is encountered in the finally clause, the rest of the finally clause is skipped, and the ":break", ":continue", ":return" or ":finish" is executed as usual. If the finally clause has been taken because of an exception or an earlier ":break", ":continue", ":return", or ":finish" from the try block or a catch clause, this pending exception or command is discarded. For examples see throw-catch and try-finally.
NESTING OF TRY CONDITIONALS try-nesting Try conditionals can be nested arbitrarily. That is, a complete try conditional can be put into the try block, a catch clause, or the finally clause of another try conditional. If the inner try conditional does not catch an exception thrown in its try block or throws a new exception from one of its catch clauses or its finally clause, the outer try conditional is checked according to the rules above. If the inner try conditional is in the try block of the outer try conditional, its catch clauses are checked, but otherwise only the finally clause is executed. It does not matter for nesting, whether the inner try conditional is directly contained in the outer one, or whether the outer one sources a script or calls a function containing the inner try conditional. When none of the active try conditionals catches an exception, just their finally clauses are executed. Thereafter, the script processing terminates. An error message is displayed in case of an uncaught exception explicitly thrown by a ":throw" command. For uncaught error and interrupt exceptions implicitly raised by Vim, the error message(s) or interrupt message are shown as usual. For examples see throw-catch.
EXAMINING EXCEPTION HANDLING CODE except-examine
Exception handling code can get tricky. If you are in doubt what happens, set 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your script file. Then you see when an exception is thrown, discarded, caught, or finished. When using a verbosity level of at least 14, things pending in a finally clause are also shown. This information is also given in debug mode (see debug-scripts).
THROWING AND CATCHING EXCEPTIONS throw-catch
You can throw any number or string as an exception. Use the :throw command and pass the value to be thrown as argument:
throw 4711throw "string"
throw-expression You can also specify an expression argument. The expression is then evaluated first, and the result is thrown:
throw 4705 + strlen("string")throw strpart("strings", 0, 6)
An exception might be thrown during evaluation of the argument of the ":throw" command. Unless it is caught there, the expression evaluation is abandoned. The ":throw" command then does not throw a new exception. Example:
function! Foo(arg)trythrow a:argcatch /foo/endtryreturn 1endfunctionfunction! Bar()echo "in Bar"return 4710endfunctionthrow Foo("arrgh") + Bar()
This throws "arrgh", and "in Bar" is not displayed since Bar() is not executed.
throw Foo("foo") + Bar()however displays "in Bar" and throws 4711. Any other command that takes an expression as argument might also be abandoned by an (uncaught) exception during the expression evaluation. The exception is then propagated to the caller of the command. Example:
if Foo("arrgh")echo "then"elseecho "else"endif
Here neither of "then" or "else" is displayed.
catch-order Exceptions can be caught by a try conditional with one or more :catch commands, see try-conditionals. The values to be caught by each ":catch" command can be specified as a pattern argument. The subsequent catch clause gets executed when a matching exception is caught. Example:
function! Foo(value)trythrow a:valuecatch /^\d\+$/echo "Number thrown"catch /.*/echo "String thrown"endtryendfunctioncall Foo(0x1267)call Foo('string')
The first call to Foo() displays "Number thrown", the second "String thrown". An exception is matched against the ":catch" commands in the order they are specified. Only the first match counts. So you should place the more specific ":catch" first. The following order does not make sense:
catch /.*/echo "String thrown"catch /^\d\+$/echo "Number thrown"
The first ":catch" here matches always, so that the second catch clause is never taken.
throw-variables If you catch an exception by a general pattern, you may access the exact value in the variable v:exception:
catch /^\d\+$/echo "Number thrown. Value is" v:exception
You may also be interested where an exception was thrown. This is stored in v:throwpoint. Note that "v:exception" and "v:throwpoint" are valid for the exception most recently caught as long it is not finished. Example:
function! Caught()if v:exception != ""echo 'Caught "' . v:exception . '" in ' . v:throwpointelseecho 'Nothing caught'endifendfunctionfunction! Foo()trytrytrythrow 4711finallycall Caught()endtrycatch /.*/call Caught()throw "oops"endtrycatch /.*/call Caught()finallycall Caught()endtryendfunctioncall Foo()
This displays
Nothing caughtCaught "4711" in function Foo, line 4Caught "oops" in function Foo, line 10Nothing caught
A practical example: The following command ":LineNumber" displays the line number in the script or function where it has been used:
function! LineNumber()return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "")endfunctioncommand! LineNumber try | throw "" | catch | echo LineNumber() | endtry
try-nested An exception that is not caught by a try conditional can be caught by a surrounding try conditional:
trytrythrow "foo"catch /foobar/echo "foobar"finallyecho "inner finally"endtrycatch /foo/echo "foo"endtry
The inner try conditional does not catch the exception, just its finally clause is executed. The exception is then caught by the outer try conditional. The example displays "inner finally" and then "foo".
throw-from-catch You can catch an exception and throw a new one to be caught elsewhere from the catch clause:
function! Foo()throw "foo"endfunctionfunction! Bar()trycall Foo()catch /foo/echo "Caught foo, throw bar"throw "bar"endtryendfunctiontrycall Bar()catch /.*/echo "Caught" v:exceptionendtry
This displays "Caught foo, throw bar" and then "Caught bar".
rethrow There is no real rethrow in the Vim script language, but you may throw "v:exception" instead:
function! Bar()trycall Foo()catch /.*/echo "Rethrow" v:exceptionthrow v:exceptionendtryendfunction
try-echoerr Note that this method cannot be used to "rethrow" Vim error or interrupt exceptions, because it is not possible to fake Vim internal exceptions. Trying so causes an error exception. You should throw your own exception denoting the situation. If you want to cause a Vim error exception containing the original error exception value, you can use the :echoerr command:
trytryasdfcatch /.*/echoerr v:exceptionendtrycatch /.*/echo v:exceptionendtry
This code displays Vim(echoerr):Vim:E492: Not an editor command: asdf
CLEANUP CODE try-finally
Scripts often change global settings and restore them at their end. If the user however interrupts the script by pressing CTRL-C, the settings remain in an inconsistent state. The same may happen to you in the development phase of a script when an error occurs or you explicitly throw an exception without catching it. You can solve these problems by using a try conditional with a finally clause for restoring the settings. Its execution is guaranteed on normal control flow, on error, on an explicit ":throw", and on interrupt. (Note that errors and interrupts from inside the try conditional are converted to exceptions. When not caught, they terminate the script after the finally clause has been executed.) Example:
trylet s:saved_ts = &tsset ts=17" Do the hard work here.finallylet &ts = s:saved_tsunlet s:saved_tsendtry
This method should be used locally whenever a function or part of a script changes global settings which need to be restored on failure or normal exit of that function or script part.
break-finally Cleanup code works also when the try block or a catch clause is left by a ":continue", ":break", ":return", or ":finish". Example:
let first = 1while 1tryif firstecho "first"let first = 0continueelsethrow "second"endifcatch /.*/echo v:exceptionbreakfinallyecho "cleanup"endtryecho "still in while"endwhileecho "end"
This displays "first", "cleanup", "second", "cleanup", and "end".
function! Foo()tryreturn 4711finallyecho "cleanup\n"endtryecho "Foo still active"endfunctionecho Foo() "returned by Foo"
This displays "cleanup" and "4711 returned by Foo". You don't need to add an extra ":return" in the finally clause. (Above all, this would override the return value.)
except-from-finally Using either of ":continue", ":break", ":return", ":finish", or ":throw" in a finally clause is possible, but not recommended since it abandons the cleanup actions for the try conditional. But, of course, interrupt and error exceptions might get raised from a finally clause. Example where an error in the finally clause stops an interrupt from working correctly:
trytryecho "Press CTRL-C for interrupt"while 1endwhilefinallyunlet novarendtrycatch /novar/endtryecho "Script still running"sleep 1
If you need to put commands that could fail into a finally clause, you should think about catching or ignoring the errors in these commands, see catch-errors and ignore-errors.
CATCHING ERRORS catch-errors
If you want to catch specific errors, you just have to put the code to be watched in a try block and add a catch clause for the error message. The presence of the try conditional causes all errors to be converted to an exception. No message is displayed and v:errmsg is not set then. To find the right pattern for the ":catch" command, you have to know how the format of the error exception is. Error exceptions have the following format:
Vim({cmdname}):{errmsg}or
Vim:{errmsg}{cmdname} is the name of the command that failed; the second form is used when the command name is not known. {errmsg} is the error message usually produced when the error occurs outside try conditionals. It always begins with a capital "E", followed by a two or three-digit error number, a colon, and a space. Examples: The command
unlet novarnormally produces the error message
E108: No such variable: "novar"which is converted inside try conditionals to an exception
Vim(unlet):E108: No such variable: "novar"The command
dwimnormally produces the error message
E492: Not an editor command: dwimwhich is converted inside try conditionals to an exception
Vim:E492: Not an editor command: dwimYou can catch all ":unlet" errors by a
catch /^Vim(unlet):/or all errors for misspelled command names by a
catch /^Vim:E492:/Some error messages may be produced by different commands:
function nofuncand
delfunction nofuncboth produce the error message
E128: Function name must start with a capital: nofuncwhich is converted inside try conditionals to an exception
Vim(function):E128: Function name must start with a capital: nofuncor
Vim(delfunction):E128: Function name must start with a capital: nofuncrespectively. You can catch the error by its number independently on the command that caused it if you use the following pattern:
catch /^Vim(\a\+):E128:/Some commands like
let x = novarproduce multiple error messages, here:
E121: Undefined variable: novarE15: Invalid expression: novar
Only the first is used for the exception value, since it is the most specific one (see except-several-errors). So you can catch it by
catch /^Vim(\a\+):E121:/You can catch all errors related to the name "nofunc" by
catch /\<nofunc\>/You can catch all Vim errors in the ":write" and ":read" commands by
catch /^Vim(\(write\|read\)):E\d\+:/You can catch all Vim errors by the pattern
catch /^Vim\((\a\+)\)\=:E\d\+:/catch-text NOTE: You should never catch the error message text itself:
catch /No such variable/only works in the English locale, but not when the user has selected a different language by the :language command. It is however helpful to cite the message text in a comment:
catch /^Vim(\a\+):E108:/ " No such variableIGNORING ERRORS ignore-errors
You can ignore errors in a specific Vim command by catching them locally:
trywritecatchendtry
But you are strongly recommended NOT to use this simple form, since it could catch more than you want. With the ":write" command, some autocommands could be executed and cause errors not related to writing, for instance:
au BufWritePre * unlet novarThere could even be such errors you are not responsible for as a script writer: a user of your script might have defined such autocommands. You would then hide the error from the user. It is much better to use
trywritecatch /^Vim(write):/endtry
which only catches real write errors. So catch only what you'd like to ignore intentionally. For a single command that does not cause execution of autocommands, you could even suppress the conversion of errors to exceptions by the ":silent!" command:
silent! nunmap kThis works also when a try conditional is active.
CATCHING INTERRUPTS catch-interrupt
When there are active try conditionals, an interrupt (CTRL-C) is converted to the exception "Vim:Interrupt". You can catch it like every exception. The script is not terminated, then. Example:
function! TASK1()sleep 10endfunctionfunction! TASK2()sleep 20endfunctionwhile 1let command = input("Type a command: ")tryif command == ""continueelseif command == "END"breakelseif command == "TASK1"call TASK1()elseif command == "TASK2"call TASK2()elseecho "\nIllegal command:" commandcontinueendifcatch /^Vim:Interrupt$/echo "\nCommand interrupted"" Caught the interrupt. Continue with next prompt.endtryendwhile
You can interrupt a task here by pressing CTRL-C; the script then asks for a new command. If you press CTRL-C at the prompt, the script is terminated. For testing what happens when CTRL-C would be pressed on a specific line in your script, use the debug mode and execute the >quit or >interrupt command on that line. See debug-scripts.
CATCHING ALL catch-all
The commands
catch /.*/catch //catch
catch everything, error exceptions, interrupt exceptions and exceptions explicitly thrown by the :throw command. This is useful at the top level of a script in order to catch unexpected things. Example:
try" do the hard work herecatch /MyException/" handle known problemcatch /^Vim:Interrupt$/echo "Script interrupted"catch /.*/echo "Internal error (" . v:exception . ")"echo " - occurred at " . v:throwpointendtry" end of script
Note: Catching all might catch more things than you want. Thus, you are strongly encouraged to catch only for problems that you can really handle by specifying a pattern argument to the ":catch". Example: Catching all could make it nearly impossible to interrupt a script by pressing CTRL-C:
while 1trysleep 1catchendtryendwhile
EXCEPTIONS AND AUTOCOMMANDS except-autocmd
Exceptions may be used during execution of autocommands. Example:
autocmd User x tryautocmd User x throw "Oops!"autocmd User x catchautocmd User x echo v:exceptionautocmd User x endtryautocmd User x throw "Arrgh!"autocmd User x echo "Should not be displayed"trydoautocmd User xcatchecho v:exceptionendtry
This displays "Oops!" and "Arrgh!".
except-autocmd-Pre For some commands, autocommands get executed before the main action of the command takes place. If an exception is thrown and not caught in the sequence of autocommands, the sequence and the command that caused its execution are abandoned and the exception is propagated to the caller of the command. Example:
autocmd BufWritePre * throw "FAIL"autocmd BufWritePre * echo "Should not be displayed"trywritecatchecho "Caught:" v:exception "from" v:throwpointendtry
Here, the ":write" command does not write the file currently being edited (as you can see by checking 'modified'), since the exception from the BufWritePre autocommand abandons the ":write". The exception is then caught and the script displays:
Caught: FAIL from BufWrite Auto commands for "*"except-autocmd-Post For some commands, autocommands get executed after the main action of the command has taken place. If this main action fails and the command is inside an active try conditional, the autocommands are skipped and an error exception is thrown that can be caught by the caller of the command. Example:
autocmd BufWritePost * echo "File successfully written!"trywrite /i/m/p/o/s/s/i/b/l/ecatchecho v:exceptionendtry
This just displays:
Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e)If you really need to execute the autocommands even when the main action fails, trigger the event from the catch clause. Example:
autocmd BufWritePre * set noreadonlyautocmd BufWritePost * set readonlytrywrite /i/m/p/o/s/s/i/b/l/ecatchdoautocmd BufWritePost /i/m/p/o/s/s/i/b/l/eendtry
You can also use ":silent!":
let x = "ok"let v:errmsg = ""autocmd BufWritePost * if v:errmsg != ""autocmd BufWritePost * let x = "after fail"autocmd BufWritePost * endiftrysilent! write /i/m/p/o/s/s/i/b/l/ecatchendtryecho x
This displays "after fail". If the main action of the command does not fail, exceptions from the autocommands will be catchable by the caller of the command:
autocmd BufWritePost * throw ":-("autocmd BufWritePost * echo "Should not be displayed"trywritecatchecho v:exceptionendtry
except-autocmd-Cmd For some commands, the normal action can be replaced by a sequence of autocommands. Exceptions from that sequence will be catchable by the caller of the command. Example: For the ":write" command, the caller cannot know whether the file had actually been written when the exception occurred. You need to tell it in some way.
if !exists("cnt")let cnt = 0autocmd BufWriteCmd * if &modifiedautocmd BufWriteCmd * let cnt = cnt + 1autocmd BufWriteCmd * if cnt % 3 == 2autocmd BufWriteCmd * throw "BufWriteCmdError"autocmd BufWriteCmd * endifautocmd BufWriteCmd * write | set nomodifiedautocmd BufWriteCmd * if cnt % 3 == 0autocmd BufWriteCmd * throw "BufWriteCmdError"autocmd BufWriteCmd * endifautocmd BufWriteCmd * echo "File successfully written!"autocmd BufWriteCmd * endifendiftrywritecatch /^BufWriteCmdError$/if &modifiedecho "Error on writing (file contents not changed)"elseecho "Error after writing"endifcatch /^Vim(write):/echo "Error on writing"endtry
When this script is sourced several times after making changes, it displays first
File successfully written!then
Error on writing (file contents not changed)then
Error after writingetc.
except-autocmd-ill You cannot spread a try conditional over autocommands for different events. The following code is ill-formed:
autocmd BufWritePre * tryautocmd BufWritePost * catchautocmd BufWritePost * echo v:exceptionautocmd BufWritePost * endtrywrite
EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS except-hier-param
Some programming languages allow to use hierarchies of exception classes or to pass additional information with the object of an exception class. You can do similar things in Vim. In order to throw an exception from a hierarchy, just throw the complete class name with the components separated by a colon, for instance throw the string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library. When you want to pass additional information with your exception class, add it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)" for an error when writing "myfile". With the appropriate patterns in the ":catch" command, you can catch for base classes or derived classes of your hierarchy. Additional information in parentheses can be cut out from v:exception with the ":substitute" command. Example:
function! CheckRange(a, func)if a:a < 0throw "EXCEPT:MATHERR:RANGE(" . a:func . ")"endifendfunctionfunction! Add(a, b)call CheckRange(a:a, "Add")call CheckRange(a:b, "Add")let c = a:a + a:bif c < 0throw "EXCEPT:MATHERR:OVERFLOW"endifreturn cendfunctionfunction! Div(a, b)call CheckRange(a:a, "Div")call CheckRange(a:b, "Div")if (a:b == 0)throw "EXCEPT:MATHERR:ZERODIV"endifreturn a:a / a:bendfunctionfunction! Write(file)tryexecute "write" fnameescape(a:file)catch /^Vim(write):/throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR"endtryendfunctiontry" something with arithmetics and I/Ocatch /^EXCEPT:MATHERR:RANGE/let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "")echo "Range error in" functioncatch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIVecho "Math error"catch /^EXCEPT:IO/let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "")let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "")if file !~ '^/'let file = dir . "/" . fileendifecho 'I/O error for "' . file . '"'catch /^EXCEPT/echo "Unspecified error"endtry
The exceptions raised by Vim itself (on error or when pressing CTRL-C) use a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself exceptions with the "Vim" prefix; they are reserved for Vim. Vim error exceptions are parameterized with the name of the command that failed, if known. See catch-errors. PECULIARITIES except-compat The exception handling concept requires that the command sequence causing the exception is aborted immediately and control is transferred to finally clauses and/or a catch clause. In the Vim script language there are cases where scripts and functions continue after an error: in functions without the "abort" flag or in a command after ":silent!", control flow goes to the following line, and outside functions, control flow goes to the line following the outermost ":endwhile" or ":endif". On the other hand, errors should be catchable as exceptions (thus, requiring the immediate abortion). This problem has been solved by converting errors to exceptions and using immediate abortion (if not suppressed by ":silent!") only when a try conditional is active. This is no restriction since an (error) exception can be caught only from an active try conditional. If you want an immediate termination without catching the error, just use a try conditional without catch clause. (You can cause cleanup code being executed before termination by specifying a finally clause.) When no try conditional is active, the usual abortion and continuation behavior is used instead of immediate abortion. This ensures compatibility of scripts written for Vim 6.1 and earlier. However, when sourcing an existing script that does not use exception handling commands (or when calling one of its functions) from inside an active try conditional of a new script, you might change the control flow of the existing script on error. You get the immediate abortion on error and can catch the error in the new script. If however the sourced script suppresses error messages by using the ":silent!" command (checking for errors by testing v:errmsg if appropriate), its execution path is not changed. The error is not converted to an exception. (See :silent.) So the only remaining cause where this happens is for scripts that don't care about errors and produce error messages. You probably won't want to use such code from your new scripts.
except-syntax-err Syntax errors in the exception handling commands are never caught by any of the ":catch" commands of the try conditional they belong to. Its finally clauses, however, is executed. Example:
trytrythrow 4711catch /\(/echo "in catch with syntax error"catchecho "inner catch-all"finallyecho "inner finally"endtrycatchecho 'outer catch-all caught "' . v:exception . '"'finallyecho "outer finally"endtry
This displays:
inner finallyouter catch-all caught "Vim(catch):E54: Unmatched \("outer finally
The original exception is discarded and an error exception is raised, instead.
except-single-line The ":try", ":catch", ":finally", and ":endtry" commands can be put on a single line, but then syntax errors may make it difficult to recognize the "catch" line, thus you better avoid this. Example:
try | unlet! foo # | catch | endtryraises an error exception for the trailing characters after the ":unlet!" argument, but does not see the ":catch" and ":endtry" commands, so that the error exception is discarded and the "E488: Trailing characters" message gets displayed.
except-several-errors When several errors appear in a single command, the first error message is usually the most specific one and therefor converted to the error exception. Example:
echo novarcauses
E121: Undefined variable: novarE15: Invalid expression: novar
The value of the error exception inside try conditionals is:
Vim(echo):E121: Undefined variable: novarexcept-syntax-error But when a syntax error is detected after a normal error in the same command, the syntax error is used for the exception being thrown. Example:
unlet novar #causes
E108: No such variable: "novar"E488: Trailing characters
The value of the error exception inside try conditionals is:
Vim(unlet):E488: Trailing charactersThis is done because the syntax error might change the execution path in a way not intended by the user. Example:
trytry | unlet novar # | catch | echo v:exception | endtrycatch /.*/echo "outer catch:" v:exceptionendtry
This displays "outer catch: Vim(unlet):E488: Trailing characters", and then a "E600: Missing :endtry" error message is given, see except-single-line.
9. Examples eval-examples
Printing in Binary
" The function Nr2Bin() returns the binary string representation of a number.func Nr2Bin(nr)let n = a:nrlet r = ""while nlet r = '01'[n % 2] . rlet n = n / 2endwhilereturn rendfunc" The function String2Bin() converts each character in a string to a" binary string, separated with dashes.func String2Bin(str)let out = ''for ix in range(strlen(a:str))let out = out . '-' . Nr2Bin(char2nr(a:str[ix]))endforreturn out[1:]endfunc
Example of its use:
echo Nr2Bin(32)result: "100000"
echo String2Bin("32")result: "110011-110010" Sorting lines This example sorts lines with a specific compare function.
func SortBuffer()let lines = getline(1, '$')call sort(lines, function("Strcmp"))call setline(1, lines)endfunction
As a one-liner:
call setline(1, sort(getline(1, '$'), function("Strcmp")))scanf() replacementsscanf There is no sscanf() function in Vim. If you need to extract parts from a line, you can use matchstr() and substitute() to do it. This example shows how to get the file name, line number and column number out of a line like "foobar.txt, 123, 45".
" Set up the match bitlet mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)'"get the part matching the whole expressionlet l = matchstr(line, mx)"get each item out of the matchlet file = substitute(l, mx, '\1', '')let lnum = substitute(l, mx, '\2', '')let col = substitute(l, mx, '\3', '')
The input is in the variable "line", the results in the variables "file", "lnum" and "col". (idea from Michael Geddes) getting the scriptnames in a Dictionary scriptnames-dictionary The :scriptnames command can be used to get a list of all script files that have been sourced. There is no equivalent function or variable for this (because it's rarely needed). In case you need to manipulate the list this code can be used:
" Get the output of ":scriptnames" in the scriptnames_output variable.let scriptnames_output = ''redir => scriptnames_outputsilent scriptnamesredir END" Split the output into lines and parse each line. Add an entry to the" "scripts" dictionary.let scripts = {}for line in split(scriptnames_output, "\n")" Only do non-blank lines.if line =~ '\S'" Get the first number in the line.let nr = matchstr(line, '\d\+')" Get the file name, remove the script number " 123: ".let name = substitute(line, '.\+:\s*', '', '')" Add an item to the Dictionarylet scripts[nr] = nameendifendforunlet scriptnames_output
10. No +eval feature no-eval-feature When the +eval feature was disabled at compile time, none of the expression evaluation commands are available. To prevent this from causing Vim scripts to generate all kinds of errors, the ":if" and ":endif" commands are still recognized, though the argument of the ":if" and everything between the ":if" and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but only if the commands are at the start of the line. The ":else" command is not recognized. Example of how to avoid executing commands when the +eval feature is missing:
if 1echo "Expression evaluation is compiled in"elseecho "You will _never_ see this message"endif
To execute a command only when the +eval feature is disabled requires a trick, as this example shows:
silent! while 0set history=111silent! endwhile
When the +eval feature is available the command is skipped because of the "while 0". Without the +eval feature the "while 0" is an error, which is silently ignored, and the command is executed. The "<CR>" here is a real CR character, type CTRL-V Enter to get it. When the +eval feature is available the ":" is remapped to add a double quote, which has the effect of commenting-out the command. Without the +eval feature the nnoremap command is skipped and the command is executed.
11. The sandbox eval-sandbox sandbox E48
The 'foldexpr', 'formatexpr', 'includeexpr', 'indentexpr', 'statusline' and 'foldtext' options may be evaluated in a sandbox. This means that you are protected from these expressions having nasty side effects. This gives some safety for when these options are set from a modeline. It is also used when the command from a tags file is executed and for CTRL-R = in the command line. The sandbox is also used for the :sandbox command. These items are not allowed in the sandbox: - changing the buffer text - defining or changing mapping, autocommands, functions, user commands - setting certain options (see option-summary) - setting certain v: variables (see v:var) E794 - executing a shell command - reading or writing a file - jumping to another buffer or editing a file - executing Python, Perl, etc. commands This is not guaranteed 100% secure, but it should block most attacks.
:san :sandbox :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an option that may have been set from a modeline, e.g. 'foldexpr'.
sandbox-option A few options contain an expression. When this expression is evaluated it may have to be done in the sandbox to avoid a security risk. But the sandbox is restrictive, thus this only happens when the option was set from an insecure location. Insecure in this context are: - sourcing a .nvimrc or .exrc in the current directory - while executing in the sandbox - value coming from a modeline Note that when in the sandbox and saving an option value and restoring it, the option will still be marked as it was set in the sandbox.
12. Textlock textlock
In a few situations it is not allowed to change the text in the buffer, jump to another window and some other things that might confuse or break what Vim is currently doing. This mostly applies to things that happen when Vim is actually doing something else. For example, evaluating the 'balloonexpr' may happen any moment the mouse cursor is resting at some position. This is not allowed when the textlock is active: - changing the buffer text - jumping to another buffer or window - editing another file - closing a window or quitting Vim - etc.
13. Command-line expressions highlighting expr-highlight
Expressions entered by the user in i_CTRL-R_=, c_CTRL-\_e, quote= are highlighted by the built-in expressions parser. It uses highlight groups described in the table below, which may be overriden by colorschemes. hl-NvimInvalid Besides the "Nvim"-prefixed highlight groups described below, there are "NvimInvalid"-prefixed highlight groups which have the same meaning but indicate that the token contains an error or that an error occurred just before it. They have mostly the same hierarchy, except that (by default) in place of any non-Nvim-prefixed group NvimInvalid linking to Erroris usedand some other intermediate groups are present. Group Default link Colored expression hl-NvimInternalError None, red/red Parser bug hl-NvimAssignment Operator Generic assignment hl-NvimPlainAssignment NvimAssignment =in :lethl-NvimAugmentedAssignment NvimAssignment Generic, +=/-=/.=hl-NvimAssignmentWithAddition NvimAugmentedAssignment +=in :let+=hl-NvimAssignmentWithSubtraction NvimAugmentedAssignment -=in :let-=hl-NvimAssignmentWithConcatenation NvimAugmentedAssignment .=in :let.=hl-NvimOperator Operator Generic operator hl-NvimUnaryOperator NvimOperator Generic unary op hl-NvimUnaryPlus NvimUnaryOperator expr-unary-+ hl-NvimUnaryMinus NvimUnaryOperator expr-unary-- hl-NvimNot NvimUnaryOperator expr-! hl-NvimBinaryOperator NvimOperator Generic binary op hl-NvimComparison NvimBinaryOperator Any expr4 operator hl-NvimComparisonModifier NvimComparison #/?near expr4 ophl-NvimBinaryPlus NvimBinaryOperator expr-+ hl-NvimBinaryMinus NvimBinaryOperator expr-- hl-NvimConcat NvimBinaryOperator expr-. hl-NvimConcatOrSubscript NvimConcat expr-. or expr-entry hl-NvimOr NvimBinaryOperator expr-barbar hl-NvimAnd NvimBinaryOperator expr-&& hl-NvimMultiplication NvimBinaryOperator expr-star hl-NvimDivision NvimBinaryOperator expr-/ hl-NvimMod NvimBinaryOperator expr-% hl-NvimTernary NvimOperator ?in expr1hl-NvimTernaryColon NvimTernary :in expr1hl-NvimParenthesis Delimiter Generic bracket hl-NvimLambda NvimParenthesis {/}in lambdahl-NvimNestingParenthesis NvimParenthesis (/)in expr-nestinghl-NvimCallingParenthesis NvimParenthesis (/)in expr-functionhl-NvimSubscript NvimParenthesis Generic subscript hl-NvimSubscriptBracket NvimSubscript [/]in expr-[]hl-NvimSubscriptColon NvimSubscript :in expr-[:]hl-NvimCurly NvimSubscript {/}incurly-braces-names hl-NvimContainer NvimParenthesis Generic container hl-NvimDict NvimContainer {/}in dict literalhl-NvimList NvimContainer [/]in list literalhl-NvimIdentifier Identifier Generic identifier hl-NvimIdentifierScope NvimIdentifier Namespace: letter before :ininternal-variables hl-NvimIdentifierScopeDelimiter NvimIdentifier :after namespaceletter hl-NvimIdentifierName NvimIdentifier Rest of the ident hl-NvimIdentifierKey NvimIdentifier Identifier after expr-entry hl-NvimColon Delimiter :in dict literalhl-NvimComma Delimiter ,in dict|/|listliteral or expr-function hl-NvimArrow Delimiter ->in lambdahl-NvimRegister SpecialChar expr-register hl-NvimNumber Number Non-prefix digits in integer expr-number hl-NvimNumberPrefix Type 0for octal-number0xfor hex-number0bfor binary-numberhl-NvimFloat NvimNumber Floating-point number hl-NvimOptionSigil Type &in expr-optionhl-NvimOptionScope NvimIdentifierScope Option scope if any hl-NvimOptionScopeDelimiter NvimIdentifierScopeDelimiter :after option scopehl-NvimOptionName NvimIdentifier Option name hl-NvimEnvironmentSigil NvimOptionSigil $in expr-envhl-NvimEnvironmentName NvimIdentifier Env variable name hl-NvimString String Generic string hl-NvimStringBody NvimString Generic string literal body hl-NvimStringQuote NvimString Generic string quote hl-NvimStringSpecial SpecialChar Generic string non-literal body hl-NvimSingleQuote NvimStringQuote 'in expr-'hl-NvimSingleQuotedBody NvimStringBody Literal part of expr-' string body hl-NvimSingleQuotedQuote NvimStringSpecial ''inside expr-'string body hl-NvimDoubleQuote NvimStringQuote "in expr-quotehl-NvimDoubleQuotedBody NvimStringBody Literal part of expr-quote body hl-NvimDoubleQuotedEscape NvimStringSpecial Valid expr-quote escape sequence hl-NvimDoubleQuotedUnknownEscape NvimInvalidValue Unrecognized expr-quote escape sequence
vim:tw=78:ts=8:noet:ft=help:norl: