| blob | b321d8ff5ab6efbb588a43ed78c2a088ffdaad8b |
1 *eval.txt* For Vim version 7.2. Last change: 2009 Sep 30
4 VIM REFERENCE MANUAL by Bram Moolenaar
7 Expression evaluation *expression* *expr* *E15* *eval*
9 Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|.
11 Note: Expression evaluation can be disabled at compile time. If this has been
12 done, the features in this document are not available. See |+eval| and
13 |no-eval-feature|.
15 1. Variables |variables|
16 1.1 Variable types
17 1.2 Function references |Funcref|
18 1.3 Lists |Lists|
19 1.4 Dictionaries |Dictionaries|
20 1.5 More about variables |more-variables|
21 2. Expression syntax |expression-syntax|
22 3. Internal variable |internal-variables|
23 4. Builtin Functions |functions|
24 5. Defining functions |user-functions|
25 6. Curly braces names |curly-braces-names|
26 7. Commands |expression-commands|
27 8. Exception handling |exception-handling|
28 9. Examples |eval-examples|
29 10. No +eval feature |no-eval-feature|
30 11. The sandbox |eval-sandbox|
31 12. Textlock |textlock|
33 {Vi does not have any of these commands}
35 ==============================================================================
36 1. Variables *variables*
38 1.1 Variable types ~
39 *E712*
40 There are six types of variables:
42 Number A 32 bit signed number. |expr-number| *Number*
43 Examples: -123 0x10 0177
45 Float A floating point number. |floating-point-format| *Float*
46 {only when compiled with the |+float| feature}
47 Examples: 123.456 1.15e-6 -1.1e3
49 String A NUL terminated string of 8-bit unsigned characters (bytes).
50 |expr-string| Examples: "ab\txx\"--" 'x-z''a,c'
52 Funcref A reference to a function |Funcref|.
53 Example: function("strlen")
55 List An ordered sequence of items |List|.
56 Example: [1, 2, ['a', 'b']]
58 Dictionary An associative, unordered array: Each entry has a key and a
59 value. |Dictionary|
60 Example: {'blue': "#0000ff", 'red': "#ff0000"}
62 The Number and String types are converted automatically, depending on how they
63 are used.
65 Conversion from a Number to a String is by making the ASCII representation of
66 the Number. Examples: >
67 Number 123 --> String "123"
68 Number 0 --> String "0"
69 Number -1 --> String "-1"
71 Conversion from a String to a Number is done by converting the first digits
72 to a number. Hexadecimal "0xf9" and Octal "017" numbers are recognized. If
73 the String doesn't start with digits, the result is zero. Examples: >
74 String "456" --> Number 456
75 String "6bar" --> Number 6
76 String "foo" --> Number 0
77 String "0xf1" --> Number 241
78 String "0100" --> Number 64
79 String "-8" --> Number -8
80 String "+8" --> Number 0
82 To force conversion from String to Number, add zero to it: >
83 :echo "0100" + 0
84 < 64 ~
86 To avoid a leading zero to cause octal conversion, or for using a different
87 base, use |str2nr()|.
89 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE.
91 Note that in the command >
92 :if "foo"
93 "foo" is converted to 0, which means FALSE. To test for a non-empty string,
94 use strlen(): >
95 :if strlen("foo")
96 < *E745* *E728* *E703* *E729* *E730* *E731*
97 List, Dictionary and Funcref types are not automatically converted.
99 *E805* *E806* *E808*
100 When mixing Number and Float the Number is converted to Float. Otherwise
101 there is no automatic conversion of Float. You can use str2float() for String
102 to Float, printf() for Float to String and float2nr() for Float to Number.
104 *E706* *sticky-type-checking*
105 You will get an error if you try to change the type of a variable. You need
106 to |:unlet| it first to avoid this error. String and Number are considered
107 equivalent though, as well are Float and Number. Consider this sequence of
108 commands: >
109 :let l = "string"
110 :let l = 44 " changes type from String to Number
111 :let l = [1, 2, 3] " error! l is still a Number
112 :let l = 4.4 " changes type from Number to Float
113 :let l = "string" " error!
116 1.2 Function references ~
117 *Funcref* *E695* *E718*
118 A Funcref variable is obtained with the |function()| function. It can be used
119 in an expression in the place of a function name, before the parenthesis
120 around the arguments, to invoke the function it refers to. Example: >
122 :let Fn = function("MyFunc")
123 :echo Fn()
124 < *E704* *E705* *E707*
125 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You
126 cannot have both a Funcref variable and a function with the same name.
128 A special case is defining a function and directly assigning its Funcref to a
129 Dictionary entry. Example: >
130 :function dict.init() dict
131 : let self.val = 0
132 :endfunction
134 The key of the Dictionary can start with a lower case letter. The actual
135 function name is not used here. Also see |numbered-function|.
137 A Funcref can also be used with the |:call| command: >
138 :call Fn()
139 :call dict.init()
141 The name of the referenced function can be obtained with |string()|. >
142 :let func = string(Fn)
144 You can use |call()| to invoke a Funcref and use a list variable for the
145 arguments: >
146 :let r = call(Fn, mylist)
149 1.3 Lists ~
150 *List* *Lists* *E686*
151 A List is an ordered sequence of items. An item can be of any type. Items
152 can be accessed by their index number. Items can be added and removed at any
153 position in the sequence.
156 List creation ~
157 *E696* *E697*
158 A List is created with a comma separated list of items in square brackets.
159 Examples: >
160 :let mylist = [1, two, 3, "four"]
161 :let emptylist = []
163 An item can be any expression. Using a List for an item creates a
164 List of Lists: >
165 :let nestlist = [[11, 12], [21, 22], [31, 32]]
167 An extra comma after the last item is ignored.
170 List index ~
171 *list-index* *E684*
172 An item in the List can be accessed by putting the index in square brackets
173 after the List. Indexes are zero-based, thus the first item has index zero. >
174 :let item = mylist[0] " get the first item: 1
175 :let item = mylist[2] " get the third item: 3
177 When the resulting item is a list this can be repeated: >
178 :let item = nestlist[0][1] " get the first list, second item: 12
179 <
180 A negative index is counted from the end. Index -1 refers to the last item in
181 the List, -2 to the last but one item, etc. >
182 :let last = mylist[-1] " get the last item: "four"
184 To avoid an error for an invalid index use the |get()| function. When an item
185 is not available it returns zero or the default value you specify: >
186 :echo get(mylist, idx)
187 :echo get(mylist, idx, "NONE")
190 List concatenation ~
192 Two lists can be concatenated with the "+" operator: >
193 :let longlist = mylist + [5, 6]
194 :let mylist += [7, 8]
196 To prepend or append an item turn the item into a list by putting [] around
197 it. To change a list in-place see |list-modification| below.
200 Sublist ~
202 A part of the List can be obtained by specifying the first and last index,
203 separated by a colon in square brackets: >
204 :let shortlist = mylist[2:-1] " get List [3, "four"]
206 Omitting the first index is similar to zero. Omitting the last index is
207 similar to -1. >
208 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"]
209 :let shortlist = mylist[2:2] " List with one item: [3]
210 :let otherlist = mylist[:] " make a copy of the List
212 If the first index is beyond the last item of the List or the second item is
213 before the first item, the result is an empty list. There is no error
214 message.
216 If the second index is equal to or greater than the length of the list the
217 length minus one is used: >
218 :let mylist = [0, 1, 2, 3]
219 :echo mylist[2:8] " result: [2, 3]
221 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for
222 using a single letter variable before the ":". Insert a space when needed:
223 mylist[s : e].
226 List identity ~
227 *list-identity*
228 When variable "aa" is a list and you assign it to another variable "bb", both
229 variables refer to the same list. Thus changing the list "aa" will also
230 change "bb": >
231 :let aa = [1, 2, 3]
232 :let bb = aa
233 :call add(aa, 4)
234 :echo bb
235 < [1, 2, 3, 4]
237 Making a copy of a list is done with the |copy()| function. Using [:] also
238 works, as explained above. This creates a shallow copy of the list: Changing
239 a list item in the list will also change the item in the copied list: >
240 :let aa = [[1, 'a'], 2, 3]
241 :let bb = copy(aa)
242 :call add(aa, 4)
243 :let aa[0][1] = 'aaa'
244 :echo aa
245 < [[1, aaa], 2, 3, 4] >
246 :echo bb
247 < [[1, aaa], 2, 3]
249 To make a completely independent list use |deepcopy()|. This also makes a
250 copy of the values in the list, recursively. Up to a hundred levels deep.
252 The operator "is" can be used to check if two variables refer to the same
253 List. "isnot" does the opposite. In contrast "==" compares if two lists have
254 the same value. >
255 :let alist = [1, 2, 3]
256 :let blist = [1, 2, 3]
257 :echo alist is blist
258 < 0 >
259 :echo alist == blist
260 < 1
262 Note about comparing lists: Two lists are considered equal if they have the
263 same length and all items compare equal, as with using "==". There is one
264 exception: When comparing a number with a string they are considered
265 different. There is no automatic type conversion, as with using "==" on
266 variables. Example: >
267 echo 4 == "4"
268 < 1 >
269 echo [4] == ["4"]
270 < 0
272 Thus comparing Lists is more strict than comparing numbers and strings. You
273 can compare simple values this way too by putting them in a list: >
275 :let a = 5
276 :let b = "5"
277 :echo a == b
278 < 1 >
279 :echo [a] == [b]
280 < 0
283 List unpack ~
285 To unpack the items in a list to individual variables, put the variables in
286 square brackets, like list items: >
287 :let [var1, var2] = mylist
289 When the number of variables does not match the number of items in the list
290 this produces an error. To handle any extra items from the list append ";"
291 and a variable name: >
292 :let [var1, var2; rest] = mylist
294 This works like: >
295 :let var1 = mylist[0]
296 :let var2 = mylist[1]
297 :let rest = mylist[2:]
299 Except that there is no error if there are only two items. "rest" will be an
300 empty list then.
303 List modification ~
304 *list-modification*
305 To change a specific item of a list use |:let| this way: >
306 :let list[4] = "four"
307 :let listlist[0][3] = item
309 To change part of a list you can specify the first and last item to be
310 modified. The value must at least have the number of items in the range: >
311 :let list[3:5] = [3, 4, 5]
313 Adding and removing items from a list is done with functions. Here are a few
314 examples: >
315 :call insert(list, 'a') " prepend item 'a'
316 :call insert(list, 'a', 3) " insert item 'a' before list[3]
317 :call add(list, "new") " append String item
318 :call add(list, [1, 2]) " append a List as one new item
319 :call extend(list, [1, 2]) " extend the list with two more items
320 :let i = remove(list, 3) " remove item 3
321 :unlet list[3] " idem
322 :let l = remove(list, 3, -1) " remove items 3 to last item
323 :unlet list[3 : ] " idem
324 :call filter(list, 'v:val !~ "x"') " remove items with an 'x'
326 Changing the order of items in a list: >
327 :call sort(list) " sort a list alphabetically
328 :call reverse(list) " reverse the order of items
331 For loop ~
333 The |:for| loop executes commands for each item in a list. A variable is set
334 to each item in the list in sequence. Example: >
335 :for item in mylist
336 : call Doit(item)
337 :endfor
339 This works like: >
340 :let index = 0
341 :while index < len(mylist)
342 : let item = mylist[index]
343 : :call Doit(item)
344 : let index = index + 1
345 :endwhile
347 Note that all items in the list should be of the same type, otherwise this
348 results in error |E706|. To avoid this |:unlet| the variable at the end of
349 the loop.
351 If all you want to do is modify each item in the list then the |map()|
352 function will be a simpler method than a for loop.
354 Just like the |:let| command, |:for| also accepts a list of variables. This
355 requires the argument to be a list of lists. >
356 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]]
357 : call Doit(lnum, col)
358 :endfor
360 This works like a |:let| command is done for each list item. Again, the types
361 must remain the same to avoid an error.
363 It is also possible to put remaining items in a List variable: >
364 :for [i, j; rest] in listlist
365 : call Doit(i, j)
366 : if !empty(rest)
367 : echo "remainder: " . string(rest)
368 : endif
369 :endfor
372 List functions ~
373 *E714*
374 Functions that are useful with a List: >
375 :let r = call(funcname, list) " call a function with an argument list
376 :if empty(list) " check if list is empty
377 :let l = len(list) " number of items in list
378 :let big = max(list) " maximum value in list
379 :let small = min(list) " minimum value in list
380 :let xs = count(list, 'x') " count nr of times 'x' appears in list
381 :let i = index(list, 'x') " index of first 'x' in list
382 :let lines = getline(1, 10) " get ten text lines from buffer
383 :call append('$', lines) " append text lines in buffer
384 :let list = split("a b c") " create list from items in a string
385 :let string = join(list, ', ') " create string from list items
386 :let s = string(list) " String representation of list
387 :call map(list, '">> " . v:val') " prepend ">> " to each item
389 Don't forget that a combination of features can make things simple. For
390 example, to add up all the numbers in a list: >
391 :exe 'let sum = ' . join(nrlist, '+')
394 1.4 Dictionaries ~
395 *Dictionaries* *Dictionary*
396 A Dictionary is an associative array: Each entry has a key and a value. The
397 entry can be located with the key. The entries are stored without a specific
398 ordering.
401 Dictionary creation ~
402 *E720* *E721* *E722* *E723*
403 A Dictionary is created with a comma separated list of entries in curly
404 braces. Each entry has a key and a value, separated by a colon. Each key can
405 only appear once. Examples: >
406 :let mydict = {1: 'one', 2: 'two', 3: 'three'}
407 :let emptydict = {}
408 < *E713* *E716* *E717*
409 A key is always a String. You can use a Number, it will be converted to a
410 String automatically. Thus the String '4' and the number 4 will find the same
411 entry. Note that the String '04' and the Number 04 are different, since the
412 Number will be converted to the String '4'.
414 A value can be any expression. Using a Dictionary for a value creates a
415 nested Dictionary: >
416 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}
418 An extra comma after the last entry is ignored.
421 Accessing entries ~
423 The normal way to access an entry is by putting the key in square brackets: >
424 :let val = mydict["one"]
425 :let mydict["four"] = 4
427 You can add new entries to an existing Dictionary this way, unlike Lists.
429 For keys that consist entirely of letters, digits and underscore the following
430 form can be used |expr-entry|: >
431 :let val = mydict.one
432 :let mydict.four = 4
434 Since an entry can be any type, also a List and a Dictionary, the indexing and
435 key lookup can be repeated: >
436 :echo dict.key[idx].key
439 Dictionary to List conversion ~
441 You may want to loop over the entries in a dictionary. For this you need to
442 turn the Dictionary into a List and pass it to |:for|.
444 Most often you want to loop over the keys, using the |keys()| function: >
445 :for key in keys(mydict)
446 : echo key . ': ' . mydict[key]
447 :endfor
449 The List of keys is unsorted. You may want to sort them first: >
450 :for key in sort(keys(mydict))
452 To loop over the values use the |values()| function: >
453 :for v in values(mydict)
454 : echo "value: " . v
455 :endfor
457 If you want both the key and the value use the |items()| function. It returns
458 a List in which each item is a List with two items, the key and the value: >
459 :for [key, value] in items(mydict)
460 : echo key . ': ' . value
461 :endfor
464 Dictionary identity ~
465 *dict-identity*
466 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a
467 Dictionary. Otherwise, assignment results in referring to the same
468 Dictionary: >
469 :let onedict = {'a': 1, 'b': 2}
470 :let adict = onedict
471 :let adict['a'] = 11
472 :echo onedict['a']
473 11
475 Two Dictionaries compare equal if all the key-value pairs compare equal. For
476 more info see |list-identity|.
479 Dictionary modification ~
480 *dict-modification*
481 To change an already existing entry of a Dictionary, or to add a new entry,
482 use |:let| this way: >
483 :let dict[4] = "four"
484 :let dict['one'] = item
486 Removing an entry from a Dictionary is done with |remove()| or |:unlet|.
487 Three ways to remove the entry with key "aaa" from dict: >
488 :let i = remove(dict, 'aaa')
489 :unlet dict.aaa
490 :unlet dict['aaa']
492 Merging a Dictionary with another is done with |extend()|: >
493 :call extend(adict, bdict)
494 This extends adict with all entries from bdict. Duplicate keys cause entries
495 in adict to be overwritten. An optional third argument can change this.
496 Note that the order of entries in a Dictionary is irrelevant, thus don't
497 expect ":echo adict" to show the items from bdict after the older entries in
498 adict.
500 Weeding out entries from a Dictionary can be done with |filter()|: >
501 :call filter(dict, 'v:val =~ "x"')
502 This removes all entries from "dict" with a value not matching 'x'.
505 Dictionary function ~
506 *Dictionary-function* *self* *E725*
507 When a function is defined with the "dict" attribute it can be used in a
508 special way with a dictionary. Example: >
509 :function Mylen() dict
510 : return len(self.data)
511 :endfunction
512 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")}
513 :echo mydict.len()
515 This is like a method in object oriented programming. The entry in the
516 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary
517 the function was invoked from.
519 It is also possible to add a function without the "dict" attribute as a
520 Funcref to a Dictionary, but the "self" variable is not available then.
522 *numbered-function* *anonymous-function*
523 To avoid the extra name for the function it can be defined and directly
524 assigned to a Dictionary in this way: >
525 :let mydict = {'data': [0, 1, 2, 3]}
526 :function mydict.len() dict
527 : return len(self.data)
528 :endfunction
529 :echo mydict.len()
531 The function will then get a number and the value of dict.len is a |Funcref|
532 that references this function. The function can only be used through a
533 |Funcref|. It will automatically be deleted when there is no |Funcref|
534 remaining that refers to it.
536 It is not necessary to use the "dict" attribute for a numbered function.
539 Functions for Dictionaries ~
540 *E715*
541 Functions that can be used with a Dictionary: >
542 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo"
543 :if empty(dict) " TRUE if dict is empty
544 :let l = len(dict) " number of items in dict
545 :let big = max(dict) " maximum value in dict
546 :let small = min(dict) " minimum value in dict
547 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict
548 :let s = string(dict) " String representation of dict
549 :call map(dict, '">> " . v:val') " prepend ">> " to each item
552 1.5 More about variables ~
553 *more-variables*
554 If you need to know the type of a variable or expression, use the |type()|
555 function.
557 When the '!' flag is included in the 'viminfo' option, global variables that
558 start with an uppercase letter, and don't contain a lowercase letter, are
559 stored in the viminfo file |viminfo-file|.
561 When the 'sessionoptions' option contains "global", global variables that
562 start with an uppercase letter and contain at least one lowercase letter are
563 stored in the session file |session-file|.
565 variable name can be stored where ~
566 my_var_6 not
567 My_Var_6 session file
568 MY_VAR_6 viminfo file
571 It's possible to form a variable name with curly braces, see
572 |curly-braces-names|.
574 ==============================================================================
575 2. Expression syntax *expression-syntax*
577 Expression syntax summary, from least to most significant:
579 |expr1| expr2 ? expr1 : expr1 if-then-else
581 |expr2| expr3 || expr3 .. logical OR
583 |expr3| expr4 && expr4 .. logical AND
585 |expr4| expr5 == expr5 equal
586 expr5 != expr5 not equal
587 expr5 > expr5 greater than
588 expr5 >= expr5 greater than or equal
589 expr5 < expr5 smaller than
590 expr5 <= expr5 smaller than or equal
591 expr5 =~ expr5 regexp matches
592 expr5 !~ expr5 regexp doesn't match
594 expr5 ==? expr5 equal, ignoring case
595 expr5 ==# expr5 equal, match case
596 etc. As above, append ? for ignoring case, # for
597 matching case
599 expr5 is expr5 same |List| instance
600 expr5 isnot expr5 different |List| instance
602 |expr5| expr6 + expr6 .. number addition or list concatenation
603 expr6 - expr6 .. number subtraction
604 expr6 . expr6 .. string concatenation
606 |expr6| expr7 * expr7 .. number multiplication
607 expr7 / expr7 .. number division
608 expr7 % expr7 .. number modulo
610 |expr7| ! expr7 logical NOT
611 - expr7 unary minus
612 + expr7 unary plus
615 |expr8| expr8[expr1] byte of a String or item of a |List|
616 expr8[expr1 : expr1] substring of a String or sublist of a |List|
617 expr8.name entry in a |Dictionary|
618 expr8(expr1, ...) function call with |Funcref| variable
620 |expr9| number number constant
621 "string" string constant, backslash is special
622 'string' string constant, ' is doubled
623 [expr1, ...] |List|
624 {expr1: expr1, ...} |Dictionary|
625 &option option value
626 (expr1) nested expression
627 variable internal variable
628 va{ria}ble internal variable with curly braces
629 $VAR environment variable
630 @r contents of register 'r'
631 function(expr1, ...) function call
632 func{ti}on(expr1, ...) function call with curly braces
635 ".." indicates that the operations in this level can be concatenated.
636 Example: >
637 &nu || &list && &shell == "csh"
639 All expressions within one level are parsed from left to right.
642 expr1 *expr1* *E109*
643 -----
645 expr2 ? expr1 : expr1
647 The expression before the '?' is evaluated to a number. If it evaluates to
648 non-zero, the result is the value of the expression between the '?' and ':',
649 otherwise the result is the value of the expression after the ':'.
650 Example: >
651 :echo lnum == 1 ? "top" : lnum
653 Since the first expression is an "expr2", it cannot contain another ?:. The
654 other two expressions can, thus allow for recursive use of ?:.
655 Example: >
656 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum
658 To keep this readable, using |line-continuation| is suggested: >
659 :echo lnum == 1
660 :\ ? "top"
661 :\ : lnum == 1000
662 :\ ? "last"
663 :\ : lnum
665 You should always put a space before the ':', otherwise it can be mistaken for
666 use in a variable such as "a:1".
669 expr2 and expr3 *expr2* *expr3*
670 ---------------
672 *expr-barbar* *expr-&&*
673 The "||" and "&&" operators take one argument on each side. The arguments
674 are (converted to) Numbers. The result is:
676 input output ~
677 n1 n2 n1 || n2 n1 && n2 ~
678 zero zero zero zero
679 zero non-zero non-zero zero
680 non-zero zero non-zero zero
681 non-zero non-zero non-zero non-zero
683 The operators can be concatenated, for example: >
685 &nu || &list && &shell == "csh"
687 Note that "&&" takes precedence over "||", so this has the meaning of: >
689 &nu || (&list && &shell == "csh")
691 Once the result is known, the expression "short-circuits", that is, further
692 arguments are not evaluated. This is like what happens in C. For example: >
694 let a = 1
695 echo a || b
697 This is valid even if there is no variable called "b" because "a" is non-zero,
698 so the result must be non-zero. Similarly below: >
700 echo exists("b") && b == "yes"
702 This is valid whether "b" has been defined or not. The second clause will
703 only be evaluated if "b" has been defined.
706 expr4 *expr4*
707 -----
709 expr5 {cmp} expr5
711 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1
712 if it evaluates to true.
714 *expr-==* *expr-!=* *expr->* *expr->=*
715 *expr-<* *expr-<=* *expr-=~* *expr-!~*
716 *expr-==#* *expr-!=#* *expr->#* *expr->=#*
717 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#*
718 *expr-==?* *expr-!=?* *expr->?* *expr->=?*
719 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?*
720 *expr-is*
721 use 'ignorecase' match case ignore case ~
722 equal == ==# ==?
723 not equal != !=# !=?
724 greater than > ># >?
725 greater than or equal >= >=# >=?
726 smaller than < <# <?
727 smaller than or equal <= <=# <=?
728 regexp matches =~ =~# =~?
729 regexp doesn't match !~ !~# !~?
730 same instance is
731 different instance isnot
733 Examples:
734 "abc" ==# "Abc" evaluates to 0
735 "abc" ==? "Abc" evaluates to 1
736 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise
738 *E691* *E692*
739 A |List| can only be compared with a |List| and only "equal", "not equal" and
740 "is" can be used. This compares the values of the list, recursively.
741 Ignoring case means case is ignored when comparing item values.
743 *E735* *E736*
744 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not
745 equal" and "is" can be used. This compares the key/values of the |Dictionary|
746 recursively. Ignoring case means case is ignored when comparing item values.
748 *E693* *E694*
749 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not
750 equal" can be used. Case is never ignored.
752 When using "is" or "isnot" with a |List| this checks if the expressions are
753 referring to the same |List| instance. A copy of a |List| is different from
754 the original |List|. When using "is" without a |List| it is equivalent to
755 using "equal", using "isnot" equivalent to using "not equal". Except that a
756 different type means the values are different. "4 == '4'" is true, "4 is '4'"
757 is false.
759 When comparing a String with a Number, the String is converted to a Number,
760 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE,
761 because 'x' converted to a Number is zero.
763 When comparing two Strings, this is done with strcmp() or stricmp(). This
764 results in the mathematical difference (comparing byte values), not
765 necessarily the alphabetical difference in the local language.
767 When using the operators with a trailing '#', or the short version and
768 'ignorecase' is off, the comparing is done with strcmp(): case matters.
770 When using the operators with a trailing '?', or the short version and
771 'ignorecase' is set, the comparing is done with stricmp(): case is ignored.
773 'smartcase' is not used.
775 The "=~" and "!~" operators match the lefthand argument with the righthand
776 argument, which is used as a pattern. See |pattern| for what a pattern is.
777 This matching is always done like 'magic' was set and 'cpoptions' is empty, no
778 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts
779 portable. To avoid backslashes in the regexp pattern to be doubled, use a
780 single-quote string, see |literal-string|.
781 Since a string is considered to be a single line, a multi-line pattern
782 (containing \n, backslash-n) will not match. However, a literal NL character
783 can be matched like an ordinary character. Examples:
784 "foo\nbar" =~ "\n" evaluates to 1
785 "foo\nbar" =~ "\\n" evaluates to 0
788 expr5 and expr6 *expr5* *expr6*
789 ---------------
790 expr6 + expr6 .. Number addition or |List| concatenation *expr-+*
791 expr6 - expr6 .. Number subtraction *expr--*
792 expr6 . expr6 .. String concatenation *expr-.*
794 For |Lists| only "+" is possible and then both expr6 must be a list. The
795 result is a new list with the two lists Concatenated.
797 expr7 * expr7 .. number multiplication *expr-star*
798 expr7 / expr7 .. number division *expr-/*
799 expr7 % expr7 .. number modulo *expr-%*
801 For all, except ".", Strings are converted to Numbers.
803 Note the difference between "+" and ".":
804 "123" + "456" = 579
805 "123" . "456" = "123456"
807 Since '.' has the same precedence as '+' and '-', you need to read: >
808 1 . 90 + 90.0
809 As: >
810 (1 . 90) + 90.0
811 That works, since the String "190" is automatically converted to the Number
812 190, which can be added to the Float 90.0. However: >
813 1 . 90 * 90.0
814 Should be read as: >
815 1 . (90 * 90.0)
816 Since '.' has lower precedence than '*'. This does NOT work, since this
817 attempts to concatenate a Float and a String.
819 When dividing a Number by zero the result depends on the value:
820 0 / 0 = -0x80000000 (like NaN for Float)
821 >0 / 0 = 0x7fffffff (like positive infinity)
822 <0 / 0 = -0x7fffffff (like negative infinity)
823 (before Vim 7.2 it was always 0x7fffffff)
825 When the righthand side of '%' is zero, the result is 0.
827 None of these work for |Funcref|s.
829 . and % do not work for Float. *E804*
832 expr7 *expr7*
833 -----
834 ! expr7 logical NOT *expr-!*
835 - expr7 unary minus *expr-unary--*
836 + expr7 unary plus *expr-unary-+*
838 For '!' non-zero becomes zero, zero becomes one.
839 For '-' the sign of the number is changed.
840 For '+' the number is unchanged.
842 A String will be converted to a Number first.
844 These three can be repeated and mixed. Examples:
845 !-1 == 0
846 !!8 == 1
847 --9 == 9
850 expr8 *expr8*
851 -----
852 expr8[expr1] item of String or |List| *expr-[]* *E111*
854 If expr8 is a Number or String this results in a String that contains the
855 expr1'th single byte from expr8. expr8 is used as a String, expr1 as a
856 Number. This doesn't recognize multi-byte encodings, see |byteidx()| for
857 an alternative.
859 Index zero gives the first character. This is like it works in C. Careful:
860 text column numbers start with one! Example, to get the character under the
861 cursor: >
862 :let c = getline(".")[col(".") - 1]
864 If the length of the String is less than the index, the result is an empty
865 String. A negative index always results in an empty string (reason: backwards
866 compatibility). Use [-1:] to get the last byte.
868 If expr8 is a |List| then it results the item at index expr1. See |list-index|
869 for possible index values. If the index is out of range this results in an
870 error. Example: >
871 :let item = mylist[-1] " get last item
873 Generally, if a |List| index is equal to or higher than the length of the
874 |List|, or more negative than the length of the |List|, this results in an
875 error.
878 expr8[expr1a : expr1b] substring or sublist *expr-[:]*
880 If expr8 is a Number or String this results in the substring with the bytes
881 from expr1a to and including expr1b. expr8 is used as a String, expr1a and
882 expr1b are used as a Number. This doesn't recognize multi-byte encodings, see
883 |byteidx()| for computing the indexes.
885 If expr1a is omitted zero is used. If expr1b is omitted the length of the
886 string minus one is used.
888 A negative number can be used to measure from the end of the string. -1 is
889 the last character, -2 the last but one, etc.
891 If an index goes out of range for the string characters are omitted. If
892 expr1b is smaller than expr1a the result is an empty string.
894 Examples: >
895 :let c = name[-1:] " last byte of a string
896 :let c = name[-2:-2] " last but one byte of a string
897 :let s = line(".")[4:] " from the fifth byte to the end
898 :let s = s[:-3] " remove last two bytes
899 <
900 *sublist* *slice*
901 If expr8 is a |List| this results in a new |List| with the items indicated by
902 the indexes expr1a and expr1b. This works like with a String, as explained
903 just above, except that indexes out of range cause an error. Examples: >
904 :let l = mylist[:3] " first four items
905 :let l = mylist[4:4] " List with one item
906 :let l = mylist[:] " shallow copy of a List
908 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an
909 error.
912 expr8.name entry in a |Dictionary| *expr-entry*
914 If expr8 is a |Dictionary| and it is followed by a dot, then the following
915 name will be used as a key in the |Dictionary|. This is just like:
916 expr8[name].
918 The name must consist of alphanumeric characters, just like a variable name,
919 but it may start with a number. Curly braces cannot be used.
921 There must not be white space before or after the dot.
923 Examples: >
924 :let dict = {"one": 1, 2: "two"}
925 :echo dict.one
926 :echo dict .2
928 Note that the dot is also used for String concatenation. To avoid confusion
929 always put spaces around the dot for String concatenation.
932 expr8(expr1, ...) |Funcref| function call
934 When expr8 is a |Funcref| type variable, invoke the function it refers to.
938 *expr9*
939 number
940 ------
941 number number constant *expr-number*
943 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0).
945 *floating-point-format*
946 Floating point numbers can be written in two forms:
948 [-+]{N}.{M}
949 [-+]{N}.{M}e[-+]{exp}
951 {N} and {M} are numbers. Both {N} and {M} must be present and can only
952 contain digits.
953 [-+] means there is an optional plus or minus sign.
954 {exp} is the exponent, power of 10.
955 Only a decimal point is accepted, not a comma. No matter what the current
956 locale is.
957 {only when compiled with the |+float| feature}
959 Examples:
960 123.456
961 +0.0001
962 55.0
963 -0.123
964 1.234e03
965 1.0E-6
966 -3.1416e+88
968 These are INVALID:
969 3. empty {M}
970 1e40 missing .{M}
972 *float-pi* *float-e*
973 A few useful values to copy&paste: >
974 :let pi = 3.14159265359
975 :let e = 2.71828182846
977 Rationale:
978 Before floating point was introduced, the text "123.456" was interpreted as
979 the two numbers "123" and "456", both converted to a string and concatenated,
980 resulting in the string "123456". Since this was considered pointless, and we
981 could not find it intentionally being used in Vim scripts, this backwards
982 incompatibility was accepted in favor of being able to use the normal notation
983 for floating point numbers.
985 *floating-point-precision*
986 The precision and range of floating points numbers depends on what "double"
987 means in the library Vim was compiled with. There is no way to change this at
988 runtime.
990 The default for displaying a |Float| is to use 6 decimal places, like using
991 printf("%g", f). You can select something else when using the |printf()|
992 function. Example: >
993 :echo printf('%.15e', atan(1))
994 < 7.853981633974483e-01
998 string *expr-string* *E114*
999 ------
1000 "string" string constant *expr-quote*
1002 Note that double quotes are used.
1004 A string constant accepts these special characters:
1005 \... three-digit octal number (e.g., "\316")
1006 \.. two-digit octal number (must be followed by non-digit)
1007 \. one-digit octal number (must be followed by non-digit)
1008 \x.. byte specified with two hex numbers (e.g., "\x1f")
1009 \x. byte specified with one hex number (must be followed by non-hex char)
1010 \X.. same as \x..
1011 \X. same as \x.
1012 \u.... character specified with up to 4 hex numbers, stored according to the
1013 current value of 'encoding' (e.g., "\u02a4")
1014 \U.... same as \u....
1015 \b backspace <BS>
1016 \e escape <Esc>
1017 \f formfeed <FF>
1018 \n newline <NL>
1019 \r return <CR>
1020 \t tab <Tab>
1021 \\ backslash
1022 \" double quote
1023 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W.
1025 Note that "\xff" is stored as the byte 255, which may be invalid in some
1026 encodings. Use "\u00ff" to store character 255 according to the current value
1027 of 'encoding'.
1029 Note that "\000" and "\x00" force the end of the string.
1032 literal-string *literal-string* *E115*
1033 ---------------
1034 'string' string constant *expr-'*
1036 Note that single quotes are used.
1038 This string is taken as it is. No backslashes are removed or have a special
1039 meaning. The only exception is that two quotes stand for one quote.
1041 Single quoted strings are useful for patterns, so that backslashes do not need
1042 to be doubled. These two commands are equivalent: >
1043 if a =~ "\\s*"
1044 if a =~ '\s*'
1047 option *expr-option* *E112* *E113*
1048 ------
1049 &option option value, local value if possible
1050 &g:option global option value
1051 &l:option local option value
1053 Examples: >
1054 echo "tabstop is " . &tabstop
1055 if &insertmode
1057 Any option name can be used here. See |options|. When using the local value
1058 and there is no buffer-local or window-local value, the global value is used
1059 anyway.
1062 register *expr-register* *@r*
1063 --------
1064 @r contents of register 'r'
1066 The result is the contents of the named register, as a single string.
1067 Newlines are inserted where required. To get the contents of the unnamed
1068 register use @" or @@. See |registers| for an explanation of the available
1069 registers.
1071 When using the '=' register you get the expression itself, not what it
1072 evaluates to. Use |eval()| to evaluate it.
1075 nesting *expr-nesting* *E110*
1076 -------
1077 (expr1) nested expression
1080 environment variable *expr-env*
1081 --------------------
1082 $VAR environment variable
1084 The String value of any environment variable. When it is not defined, the
1085 result is an empty string.
1086 *expr-env-expand*
1087 Note that there is a difference between using $VAR directly and using
1088 expand("$VAR"). Using it directly will only expand environment variables that
1089 are known inside the current Vim session. Using expand() will first try using
1090 the environment variables known inside the current Vim session. If that
1091 fails, a shell will be used to expand the variable. This can be slow, but it
1092 does expand all variables that the shell knows about. Example: >
1093 :echo $version
1094 :echo expand("$version")
1095 The first one probably doesn't echo anything, the second echoes the $version
1096 variable (if your shell supports it).
1099 internal variable *expr-variable*
1100 -----------------
1101 variable internal variable
1102 See below |internal-variables|.
1105 function call *expr-function* *E116* *E118* *E119* *E120*
1106 -------------
1107 function(expr1, ...) function call
1108 See below |functions|.
1111 ==============================================================================
1112 3. Internal variable *internal-variables* *E121*
1113 *E461*
1114 An internal variable name can be made up of letters, digits and '_'. But it
1115 cannot start with a digit. It's also possible to use curly braces, see
1116 |curly-braces-names|.
1118 An internal variable is created with the ":let" command |:let|.
1119 An internal variable is explicitly destroyed with the ":unlet" command
1120 |:unlet|.
1121 Using a name that is not an internal variable or refers to a variable that has
1122 been destroyed results in an error.
1124 There are several name spaces for variables. Which one is to be used is
1125 specified by what is prepended:
1127 (nothing) In a function: local to a function; otherwise: global
1128 |buffer-variable| b: Local to the current buffer.
1129 |window-variable| w: Local to the current window.
1130 |tabpage-variable| t: Local to the current tab page.
1131 |global-variable| g: Global.
1132 |local-variable| l: Local to a function.
1133 |script-variable| s: Local to a |:source|'ed Vim script.
1134 |function-argument| a: Function argument (only inside a function).
1135 |vim-variable| v: Global, predefined by Vim.
1137 The scope name by itself can be used as a |Dictionary|. For example, to
1138 delete all script-local variables: >
1139 :for k in keys(s:)
1140 : unlet s:[k]
1141 :endfor
1142 <
1143 *buffer-variable* *b:var*
1144 A variable name that is preceded with "b:" is local to the current buffer.
1145 Thus you can have several "b:foo" variables, one for each buffer.
1146 This kind of variable is deleted when the buffer is wiped out or deleted with
1147 |:bdelete|.
1149 One local buffer variable is predefined:
1150 *b:changedtick-variable* *changetick*
1151 b:changedtick The total number of changes to the current buffer. It is
1152 incremented for each change. An undo command is also a change
1153 in this case. This can be used to perform an action only when
1154 the buffer has changed. Example: >
1155 :if my_changedtick != b:changedtick
1156 : let my_changedtick = b:changedtick
1157 : call My_Update()
1158 :endif
1159 <
1160 *window-variable* *w:var*
1161 A variable name that is preceded with "w:" is local to the current window. It
1162 is deleted when the window is closed.
1164 *tabpage-variable* *t:var*
1165 A variable name that is preceded with "t:" is local to the current tab page,
1166 It is deleted when the tab page is closed. {not available when compiled
1167 without the +windows feature}
1169 *global-variable* *g:var*
1170 Inside functions global variables are accessed with "g:". Omitting this will
1171 access a variable local to a function. But "g:" can also be used in any other
1172 place if you like.
1174 *local-variable* *l:var*
1175 Inside functions local variables are accessed without prepending anything.
1176 But you can also prepend "l:" if you like. However, without prepending "l:"
1177 you may run into reserved variable names. For example "count". By itself it
1178 refers to "v:count". Using "l:count" you can have a local variable with the
1179 same name.
1181 *script-variable* *s:var*
1182 In a Vim script variables starting with "s:" can be used. They cannot be
1183 accessed from outside of the scripts, thus are local to the script.
1185 They can be used in:
1186 - commands executed while the script is sourced
1187 - functions defined in the script
1188 - autocommands defined in the script
1189 - functions and autocommands defined in functions and autocommands which were
1190 defined in the script (recursively)
1191 - user defined commands defined in the script
1192 Thus not in:
1193 - other scripts sourced from this one
1194 - mappings
1195 - menus
1196 - etc.
1198 Script variables can be used to avoid conflicts with global variable names.
1199 Take this example: >
1201 let s:counter = 0
1202 function MyCounter()
1203 let s:counter = s:counter + 1
1204 echo s:counter
1205 endfunction
1206 command Tick call MyCounter()
1208 You can now invoke "Tick" from any script, and the "s:counter" variable in
1209 that script will not be changed, only the "s:counter" in the script where
1210 "Tick" was defined is used.
1212 Another example that does the same: >
1214 let s:counter = 0
1215 command Tick let s:counter = s:counter + 1 | echo s:counter
1217 When calling a function and invoking a user-defined command, the context for
1218 script variables is set to the script where the function or command was
1219 defined.
1221 The script variables are also available when a function is defined inside a
1222 function that is defined in a script. Example: >
1224 let s:counter = 0
1225 function StartCounting(incr)
1226 if a:incr
1227 function MyCounter()
1228 let s:counter = s:counter + 1
1229 endfunction
1230 else
1231 function MyCounter()
1232 let s:counter = s:counter - 1
1233 endfunction
1234 endif
1235 endfunction
1237 This defines the MyCounter() function either for counting up or counting down
1238 when calling StartCounting(). It doesn't matter from where StartCounting() is
1239 called, the s:counter variable will be accessible in MyCounter().
1241 When the same script is sourced again it will use the same script variables.
1242 They will remain valid as long as Vim is running. This can be used to
1243 maintain a counter: >
1245 if !exists("s:counter")
1246 let s:counter = 1
1247 echo "script executed for the first time"
1248 else
1249 let s:counter = s:counter + 1
1250 echo "script executed " . s:counter . " times now"
1251 endif
1253 Note that this means that filetype plugins don't get a different set of script
1254 variables for each buffer. Use local buffer variables instead |b:var|.
1257 Predefined Vim variables: *vim-variable* *v:var*
1259 *v:beval_col* *beval_col-variable*
1260 v:beval_col The number of the column, over which the mouse pointer is.
1261 This is the byte index in the |v:beval_lnum| line.
1262 Only valid while evaluating the 'balloonexpr' option.
1264 *v:beval_bufnr* *beval_bufnr-variable*
1265 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only
1266 valid while evaluating the 'balloonexpr' option.
1268 *v:beval_lnum* *beval_lnum-variable*
1269 v:beval_lnum The number of the line, over which the mouse pointer is. Only
1270 valid while evaluating the 'balloonexpr' option.
1272 *v:beval_text* *beval_text-variable*
1273 v:beval_text The text under or after the mouse pointer. Usually a word as
1274 it is useful for debugging a C program. 'iskeyword' applies,
1275 but a dot and "->" before the position is included. When on a
1276 ']' the text before it is used, including the matching '[' and
1277 word before it. When on a Visual area within one line the
1278 highlighted text is used.
1279 Only valid while evaluating the 'balloonexpr' option.
1281 *v:beval_winnr* *beval_winnr-variable*
1282 v:beval_winnr The number of the window, over which the mouse pointer is. Only
1283 valid while evaluating the 'balloonexpr' option.
1285 *v:char* *char-variable*
1286 v:char Argument for evaluating 'formatexpr' and used for the typed
1287 character when using <expr> in an abbreviation |map-<expr>|.
1289 *v:charconvert_from* *charconvert_from-variable*
1290 v:charconvert_from
1291 The name of the character encoding of a file to be converted.
1292 Only valid while evaluating the 'charconvert' option.
1294 *v:charconvert_to* *charconvert_to-variable*
1295 v:charconvert_to
1296 The name of the character encoding of a file after conversion.
1297 Only valid while evaluating the 'charconvert' option.
1299 *v:cmdarg* *cmdarg-variable*
1300 v:cmdarg This variable is used for two purposes:
1301 1. The extra arguments given to a file read/write command.
1302 Currently these are "++enc=" and "++ff=". This variable is
1303 set before an autocommand event for a file read/write
1304 command is triggered. There is a leading space to make it
1305 possible to append this variable directly after the
1306 read/write command. Note: The "+cmd" argument isn't
1307 included here, because it will be executed anyway.
1308 2. When printing a PostScript file with ":hardcopy" this is
1309 the argument for the ":hardcopy" command. This can be used
1310 in 'printexpr'.
1312 *v:cmdbang* *cmdbang-variable*
1313 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
1314 was used the value is 1, otherwise it is 0. Note that this
1315 can only be used in autocommands. For user commands |<bang>|
1316 can be used.
1318 *v:count* *count-variable*
1319 v:count The count given for the last Normal mode command. Can be used
1320 to get the count before a mapping. Read-only. Example: >
1321 :map _x :<C-U>echo "the count is " . v:count<CR>
1322 < Note: The <C-U> is required to remove the line range that you
1323 get when typing ':' after a count.
1324 When there are two counts, as in "3d2w", they are multiplied,
1325 just like what happens in the command, "d6w" for the example.
1326 Also used for evaluating the 'formatexpr' option.
1327 "count" also works, for backwards compatibility.
1329 *v:count1* *count1-variable*
1330 v:count1 Just like "v:count", but defaults to one when no count is
1331 used.
1333 *v:ctype* *ctype-variable*
1334 v:ctype The current locale setting for characters of the runtime
1335 environment. This allows Vim scripts to be aware of the
1336 current locale encoding. Technical: it's the value of
1337 LC_CTYPE. When not using a locale the value is "C".
1338 This variable can not be set directly, use the |:language|
1339 command.
1340 See |multi-lang|.
1342 *v:dying* *dying-variable*
1343 v:dying Normally zero. When a deadly signal is caught it's set to
1344 one. When multiple signals are caught the number increases.
1345 Can be used in an autocommand to check if Vim didn't
1346 terminate normally. {only works on Unix}
1347 Example: >
1348 :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif
1349 <
1350 *v:errmsg* *errmsg-variable*
1351 v:errmsg Last given error message. It's allowed to set this variable.
1352 Example: >
1353 :let v:errmsg = ""
1354 :silent! next
1355 :if v:errmsg != ""
1356 : ... handle error
1357 < "errmsg" also works, for backwards compatibility.
1359 *v:exception* *exception-variable*
1360 v:exception The value of the exception most recently caught and not
1361 finished. See also |v:throwpoint| and |throw-variables|.
1362 Example: >
1363 :try
1364 : throw "oops"
1365 :catch /.*/
1366 : echo "caught" v:exception
1367 :endtry
1368 < Output: "caught oops".
1370 *v:fcs_reason* *fcs_reason-variable*
1371 v:fcs_reason The reason why the |FileChangedShell| event was triggered.
1372 Can be used in an autocommand to decide what to do and/or what
1373 to set v:fcs_choice to. Possible values:
1374 deleted file no longer exists
1375 conflict file contents, mode or timestamp was
1376 changed and buffer is modified
1377 changed file contents has changed
1378 mode mode of file changed
1379 time only file timestamp changed
1381 *v:fcs_choice* *fcs_choice-variable*
1382 v:fcs_choice What should happen after a |FileChangedShell| event was
1383 triggered. Can be used in an autocommand to tell Vim what to
1384 do with the affected buffer:
1385 reload Reload the buffer (does not work if
1386 the file was deleted).
1387 ask Ask the user what to do, as if there
1388 was no autocommand. Except that when
1389 only the timestamp changed nothing
1390 will happen.
1391 <empty> Nothing, the autocommand should do
1392 everything that needs to be done.
1393 The default is empty. If another (invalid) value is used then
1394 Vim behaves like it is empty, there is no warning message.
1396 *v:fname_in* *fname_in-variable*
1397 v:fname_in The name of the input file. Valid while evaluating:
1398 option used for ~
1399 'charconvert' file to be converted
1400 'diffexpr' original file
1401 'patchexpr' original file
1402 'printexpr' file to be printed
1403 And set to the swap file name for |SwapExists|.
1405 *v:fname_out* *fname_out-variable*
1406 v:fname_out The name of the output file. Only valid while
1407 evaluating:
1408 option used for ~
1409 'charconvert' resulting converted file (*)
1410 'diffexpr' output of diff
1411 'patchexpr' resulting patched file
1412 (*) When doing conversion for a write command (e.g., ":w
1413 file") it will be equal to v:fname_in. When doing conversion
1414 for a read command (e.g., ":e file") it will be a temporary
1415 file and different from v:fname_in.
1417 *v:fname_new* *fname_new-variable*
1418 v:fname_new The name of the new version of the file. Only valid while
1419 evaluating 'diffexpr'.
1421 *v:fname_diff* *fname_diff-variable*
1422 v:fname_diff The name of the diff (patch) file. Only valid while
1423 evaluating 'patchexpr'.
1425 *v:folddashes* *folddashes-variable*
1426 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
1427 fold.
1428 Read-only in the |sandbox|. |fold-foldtext|
1430 *v:foldlevel* *foldlevel-variable*
1431 v:foldlevel Used for 'foldtext': foldlevel of closed fold.
1432 Read-only in the |sandbox|. |fold-foldtext|
1434 *v:foldend* *foldend-variable*
1435 v:foldend Used for 'foldtext': last line of closed fold.
1436 Read-only in the |sandbox|. |fold-foldtext|
1438 *v:foldstart* *foldstart-variable*
1439 v:foldstart Used for 'foldtext': first line of closed fold.
1440 Read-only in the |sandbox|. |fold-foldtext|
1442 *v:insertmode* *insertmode-variable*
1443 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand
1444 events. Values:
1445 i Insert mode
1446 r Replace mode
1447 v Virtual Replace mode
1449 *v:key* *key-variable*
1450 v:key Key of the current item of a |Dictionary|. Only valid while
1451 evaluating the expression used with |map()| and |filter()|.
1452 Read-only.
1454 *v:lang* *lang-variable*
1455 v:lang The current locale setting for messages of the runtime
1456 environment. This allows Vim scripts to be aware of the
1457 current language. Technical: it's the value of LC_MESSAGES.
1458 The value is system dependent.
1459 This variable can not be set directly, use the |:language|
1460 command.
1461 It can be different from |v:ctype| when messages are desired
1462 in a different language than what is used for character
1463 encoding. See |multi-lang|.
1465 *v:lc_time* *lc_time-variable*
1466 v:lc_time The current locale setting for time messages of the runtime
1467 environment. This allows Vim scripts to be aware of the
1468 current language. Technical: it's the value of LC_TIME.
1469 This variable can not be set directly, use the |:language|
1470 command. See |multi-lang|.
1472 *v:lnum* *lnum-variable*
1473 v:lnum Line number for the 'foldexpr' |fold-expr| and 'indentexpr'
1474 expressions, tab page number for 'guitablabel' and
1475 'guitabtooltip'. Only valid while one of these expressions is
1476 being evaluated. Read-only when in the |sandbox|.
1478 *v:mouse_win* *mouse_win-variable*
1479 v:mouse_win Window number for a mouse click obtained with |getchar()|.
1480 First window has number 1, like with |winnr()|. The value is
1481 zero when there was no mouse button click.
1483 *v:mouse_lnum* *mouse_lnum-variable*
1484 v:mouse_lnum Line number for a mouse click obtained with |getchar()|.
1485 This is the text line number, not the screen line number. The
1486 value is zero when there was no mouse button click.
1488 *v:mouse_col* *mouse_col-variable*
1489 v:mouse_col Column number for a mouse click obtained with |getchar()|.
1490 This is the screen column number, like with |virtcol()|. The
1491 value is zero when there was no mouse button click.
1493 *v:oldfiles* *oldfiles-variable*
1494 v:oldfiles List of file names that is loaded from the |viminfo| file on
1495 startup. These are the files that Vim remembers marks for.
1496 The length of the List is limited by the ' argument of the
1497 'viminfo' option (default is 100).
1498 Also see |:oldfiles| and |c_#<|.
1499 The List can be modified, but this has no effect on what is
1500 stored in the |viminfo| file later. If you use values other
1501 than String this will cause trouble.
1502 {only when compiled with the +viminfo feature}
1504 *v:operator* *operator-variable*
1505 v:operator The last operator given in Normal mode. This is a single
1506 character except for commands starting with <g> or <z>,
1507 in which case it is two characters. Best used alongside
1508 |v:prevcount| and |v:register|. Useful if you want to cancel
1509 Operator-pending mode and then use the operator, e.g.: >
1510 :omap O <Esc>:call MyMotion(v:operator)<CR>
1511 < The value remains set until another operator is entered, thus
1512 don't expect it to be empty.
1513 v:operator is not set for |:delete|, |:yank| or other Ex
1514 commands.
1515 Read-only.
1517 *v:prevcount* *prevcount-variable*
1518 v:prevcount The count given for the last but one Normal mode command.
1519 This is the v:count value of the previous command. Useful if
1520 you want to cancel Visual or Operator-pending mode and then
1521 use the count, e.g.: >
1522 :vmap % <Esc>:call MyFilter(v:prevcount)<CR>
1523 < Read-only.
1525 *v:profiling* *profiling-variable*
1526 v:profiling Normally zero. Set to one after using ":profile start".
1527 See |profiling|.
1529 *v:progname* *progname-variable*
1530 v:progname Contains the name (with path removed) with which Vim was
1531 invoked. Allows you to do special initialisations for "view",
1532 "evim" etc., or any other name you might symlink to Vim.
1533 Read-only.
1535 *v:register* *register-variable*
1536 v:register The name of the register supplied to the last normal mode
1537 command. Empty if none were supplied. |getreg()| |setreg()|
1539 *v:scrollstart* *scrollstart-variable*
1540 v:scrollstart String describing the script or function that caused the
1541 screen to scroll up. It's only set when it is empty, thus the
1542 first reason is remembered. It is set to "Unknown" for a
1543 typed command.
1544 This can be used to find out why your script causes the
1545 hit-enter prompt.
1547 *v:servername* *servername-variable*
1548 v:servername The resulting registered |x11-clientserver| name if any.
1549 Read-only.
1552 v:searchforward *v:searchforward* *searchforward-variable*
1553 Search direction: 1 after a forward search, 0 after a
1554 backward search. It is reset to forward when directly setting
1555 the last search pattern, see |quote/|.
1556 Note that the value is restored when returning from a
1557 function. |function-search-undo|.
1558 Read-write.
1560 *v:shell_error* *shell_error-variable*
1561 v:shell_error Result of the last shell command. When non-zero, the last
1562 shell command had an error. When zero, there was no problem.
1563 This only works when the shell returns the error code to Vim.
1564 The value -1 is often used when the command could not be
1565 executed. Read-only.
1566 Example: >
1567 :!mv foo bar
1568 :if v:shell_error
1569 : echo 'could not rename "foo" to "bar"!'
1570 :endif
1571 < "shell_error" also works, for backwards compatibility.
1573 *v:statusmsg* *statusmsg-variable*
1574 v:statusmsg Last given status message. It's allowed to set this variable.
1576 *v:swapname* *swapname-variable*
1577 v:swapname Only valid when executing |SwapExists| autocommands: Name of
1578 the swap file found. Read-only.
1580 *v:swapchoice* *swapchoice-variable*
1581 v:swapchoice |SwapExists| autocommands can set this to the selected choice
1582 for handling an existing swap file:
1583 'o' Open read-only
1584 'e' Edit anyway
1585 'r' Recover
1586 'd' Delete swapfile
1587 'q' Quit
1588 'a' Abort
1589 The value should be a single-character string. An empty value
1590 results in the user being asked, as would happen when there is
1591 no SwapExists autocommand. The default is empty.
1593 *v:swapcommand* *swapcommand-variable*
1594 v:swapcommand Normal mode command to be executed after a file has been
1595 opened. Can be used for a |SwapExists| autocommand to have
1596 another Vim open the file and jump to the right place. For
1597 example, when jumping to a tag the value is ":tag tagname\r".
1598 For ":edit +cmd file" the value is ":cmd\r".
1600 *v:termresponse* *termresponse-variable*
1601 v:termresponse The escape sequence returned by the terminal for the |t_RV|
1602 termcap entry. It is set when Vim receives an escape sequence
1603 that starts with ESC [ or CSI and ends in a 'c', with only
1604 digits, ';' and '.' in between.
1605 When this option is set, the TermResponse autocommand event is
1606 fired, so that you can react to the response from the
1607 terminal.
1608 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp
1609 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
1610 patch level (since this was introduced in patch 95, it's
1611 always 95 or bigger). Pc is always zero.
1612 {only when compiled with |+termresponse| feature}
1614 *v:this_session* *this_session-variable*
1615 v:this_session Full filename of the last loaded or saved session file. See
1616 |:mksession|. It is allowed to set this variable. When no
1617 session file has been saved, this variable is empty.
1618 "this_session" also works, for backwards compatibility.
1620 *v:throwpoint* *throwpoint-variable*
1621 v:throwpoint The point where the exception most recently caught and not
1622 finished was thrown. Not set when commands are typed. See
1623 also |v:exception| and |throw-variables|.
1624 Example: >
1625 :try
1626 : throw "oops"
1627 :catch /.*/
1628 : echo "Exception from" v:throwpoint
1629 :endtry
1630 < Output: "Exception from test.vim, line 2"
1632 *v:val* *val-variable*
1633 v:val Value of the current item of a |List| or |Dictionary|. Only
1634 valid while evaluating the expression used with |map()| and
1635 |filter()|. Read-only.
1637 *v:version* *version-variable*
1638 v:version Version number of Vim: Major version number times 100 plus
1639 minor version number. Version 5.0 is 500. Version 5.1 (5.01)
1640 is 501. Read-only. "version" also works, for backwards
1641 compatibility.
1642 Use |has()| to check if a certain patch was included, e.g.: >
1643 if has("patch123")
1644 < Note that patch numbers are specific to the version, thus both
1645 version 5.0 and 5.1 may have a patch 123, but these are
1646 completely different.
1648 *v:warningmsg* *warningmsg-variable*
1649 v:warningmsg Last given warning message. It's allowed to set this variable.
1651 ==============================================================================
1652 4. Builtin Functions *functions*
1654 See |function-list| for a list grouped by what the function is used for.
1656 (Use CTRL-] on the function name to jump to the full explanation.)
1658 USAGE RESULT DESCRIPTION ~
1660 abs( {expr}) Float or Number absolute value of {expr}
1661 add( {list}, {item}) List append {item} to |List| {list}
1662 append( {lnum}, {string}) Number append {string} below line {lnum}
1663 append( {lnum}, {list}) Number append lines {list} below line {lnum}
1664 argc() Number number of files in the argument list
1665 argidx() Number current index in the argument list
1666 argv( {nr}) String {nr} entry of the argument list
1667 argv( ) List the argument list
1668 atan( {expr}) Float arc tangent of {expr}
1669 browse( {save}, {title}, {initdir}, {default})
1670 String put up a file requester
1671 browsedir( {title}, {initdir}) String put up a directory requester
1672 bufexists( {expr}) Number TRUE if buffer {expr} exists
1673 buflisted( {expr}) Number TRUE if buffer {expr} is listed
1674 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded
1675 bufname( {expr}) String Name of the buffer {expr}
1676 bufnr( {expr}) Number Number of the buffer {expr}
1677 bufwinnr( {expr}) Number window number of buffer {expr}
1678 byte2line( {byte}) Number line number at byte count {byte}
1679 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr}
1680 call( {func}, {arglist} [, {dict}])
1681 any call {func} with arguments {arglist}
1682 ceil( {expr}) Float round {expr} up
1683 changenr() Number current change number
1684 char2nr( {expr}) Number ASCII value of first char in {expr}
1685 cindent( {lnum}) Number C indent for line {lnum}
1686 clearmatches() none clear all matches
1687 col( {expr}) Number column nr of cursor or mark
1688 complete( {startcol}, {matches}) none set Insert mode completion
1689 complete_add( {expr}) Number add completion match
1690 complete_check() Number check for key typed during completion
1691 confirm( {msg} [, {choices} [, {default} [, {type}]]])
1692 Number number of choice picked by user
1693 copy( {expr}) any make a shallow copy of {expr}
1694 cos( {expr}) Float cosine of {expr}
1695 count( {list}, {expr} [, {start} [, {ic}]])
1696 Number count how many {expr} are in {list}
1697 cscope_connection( [{num} , {dbpath} [, {prepend}]])
1698 Number checks existence of cscope connection
1699 cursor( {lnum}, {col} [, {coladd}])
1700 Number move cursor to {lnum}, {col}, {coladd}
1701 cursor( {list}) Number move cursor to position in {list}
1702 deepcopy( {expr}) any make a full copy of {expr}
1703 delete( {fname}) Number delete file {fname}
1704 did_filetype() Number TRUE if FileType autocommand event used
1705 diff_filler( {lnum}) Number diff filler lines about {lnum}
1706 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col}
1707 empty( {expr}) Number TRUE if {expr} is empty
1708 escape( {string}, {chars}) String escape {chars} in {string} with '\'
1709 eval( {string}) any evaluate {string} into its value
1710 eventhandler( ) Number TRUE if inside an event handler
1711 executable( {expr}) Number 1 if executable {expr} exists
1712 exists( {expr}) Number TRUE if {expr} exists
1713 extend( {expr1}, {expr2} [, {expr3}])
1714 List/Dict insert items of {expr2} into {expr1}
1715 expand( {expr} [, {flag}]) String expand special keywords in {expr}
1716 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer
1717 filereadable( {file}) Number TRUE if {file} is a readable file
1718 filewritable( {file}) Number TRUE if {file} is a writable file
1719 filter( {expr}, {string}) List/Dict remove items from {expr} where
1720 {string} is 0
1721 finddir( {name}[, {path}[, {count}]])
1722 String find directory {name} in {path}
1723 findfile( {name}[, {path}[, {count}]])
1724 String find file {name} in {path}
1725 float2nr( {expr}) Number convert Float {expr} to a Number
1726 floor( {expr}) Float round {expr} down
1727 fnameescape( {fname}) String escape special characters in {fname}
1728 fnamemodify( {fname}, {mods}) String modify file name
1729 foldclosed( {lnum}) Number first line of fold at {lnum} if closed
1730 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed
1731 foldlevel( {lnum}) Number fold level at {lnum}
1732 foldtext( ) String line displayed for closed fold
1733 foldtextresult( {lnum}) String text for closed fold at {lnum}
1734 foreground( ) Number bring the Vim window to the foreground
1735 function( {name}) Funcref reference to function {name}
1736 garbagecollect( [at_exit]) none free memory, breaking cyclic references
1737 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
1738 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
1739 getbufline( {expr}, {lnum} [, {end}])
1740 List lines {lnum} to {end} of buffer {expr}
1741 getbufvar( {expr}, {varname}) any variable {varname} in buffer {expr}
1742 getchar( [expr]) Number get one character from the user
1743 getcharmod( ) Number modifiers for the last typed character
1744 getcmdline() String return the current command-line
1745 getcmdpos() Number return cursor position in command-line
1746 getcmdtype() String return the current command-line type
1747 getcwd() String the current working directory
1748 getfperm( {fname}) String file permissions of file {fname}
1749 getfsize( {fname}) Number size in bytes of file {fname}
1750 getfontname( [{name}]) String name of font being used
1751 getftime( {fname}) Number last modification time of file
1752 getftype( {fname}) String description of type of file {fname}
1753 getline( {lnum}) String line {lnum} of current buffer
1754 getline( {lnum}, {end}) List lines {lnum} to {end} of current buffer
1755 getloclist( {nr}) List list of location list items
1756 getmatches() List list of current matches
1757 getpid() Number process ID of Vim
1758 getpos( {expr}) List position of cursor, mark, etc.
1759 getqflist() List list of quickfix items
1760 getreg( [{regname} [, 1]]) String contents of register
1761 getregtype( [{regname}]) String type of register
1762 gettabwinvar( {tabnr}, {winnr}, {name})
1763 any {name} in {winnr} in tab page {tabnr}
1764 getwinposx() Number X coord in pixels of GUI Vim window
1765 getwinposy() Number Y coord in pixels of GUI Vim window
1766 getwinvar( {nr}, {varname}) any variable {varname} in window {nr}
1767 glob( {expr} [, {flag}]) String expand file wildcards in {expr}
1768 globpath( {path}, {expr} [, {flag}])
1769 String do glob({expr}) for all dirs in {path}
1770 has( {feature}) Number TRUE if feature {feature} supported
1771 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key}
1772 haslocaldir() Number TRUE if current window executed |:lcd|
1773 hasmapto( {what} [, {mode} [, {abbr}]])
1774 Number TRUE if mapping to {what} exists
1775 histadd( {history},{item}) String add an item to a history
1776 histdel( {history} [, {item}]) String remove an item from a history
1777 histget( {history} [, {index}]) String get the item {index} from a history
1778 histnr( {history}) Number highest index of a history
1779 hlexists( {name}) Number TRUE if highlight group {name} exists
1780 hlID( {name}) Number syntax ID of highlight group {name}
1781 hostname() String name of the machine Vim is running on
1782 iconv( {expr}, {from}, {to}) String convert encoding of {expr}
1783 indent( {lnum}) Number indent of line {lnum}
1784 index( {list}, {expr} [, {start} [, {ic}]])
1785 Number index in {list} where {expr} appears
1786 input( {prompt} [, {text} [, {completion}]])
1787 String get input from the user
1788 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog
1789 inputlist( {textlist}) Number let the user pick from a choice list
1790 inputrestore() Number restore typeahead
1791 inputsave() Number save and clear typeahead
1792 inputsecret( {prompt} [, {text}]) String like input() but hiding the text
1793 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}]
1794 isdirectory( {directory}) Number TRUE if {directory} is a directory
1795 islocked( {expr}) Number TRUE if {expr} is locked
1796 items( {dict}) List key-value pairs in {dict}
1797 join( {list} [, {sep}]) String join {list} items into one String
1798 keys( {dict}) List keys in {dict}
1799 len( {expr}) Number the length of {expr}
1800 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
1801 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number
1802 line( {expr}) Number line nr of cursor, last line or mark
1803 line2byte( {lnum}) Number byte count of line {lnum}
1804 lispindent( {lnum}) Number Lisp indent for line {lnum}
1805 localtime() Number current time
1806 log10( {expr}) Float logarithm of Float {expr} to base 10
1807 map( {expr}, {string}) List/Dict change each item in {expr} to {expr}
1808 maparg( {name}[, {mode} [, {abbr}]])
1809 String rhs of mapping {name} in mode {mode}
1810 mapcheck( {name}[, {mode} [, {abbr}]])
1811 String check for mappings matching {name}
1812 match( {expr}, {pat}[, {start}[, {count}]])
1813 Number position where {pat} matches in {expr}
1814 matchadd( {group}, {pattern}[, {priority}[, {id}]])
1815 Number highlight {pattern} with {group}
1816 matcharg( {nr}) List arguments of |:match|
1817 matchdelete( {id}) Number delete match identified by {id}
1818 matchend( {expr}, {pat}[, {start}[, {count}]])
1819 Number position where {pat} ends in {expr}
1820 matchlist( {expr}, {pat}[, {start}[, {count}]])
1821 List match and submatches of {pat} in {expr}
1822 matchstr( {expr}, {pat}[, {start}[, {count}]])
1823 String {count}'th match of {pat} in {expr}
1824 max( {list}) Number maximum value of items in {list}
1825 min( {list}) Number minimum value of items in {list}
1826 mkdir( {name} [, {path} [, {prot}]])
1827 Number create directory {name}
1828 mode( [expr]) String current editing mode
1829 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum}
1830 nr2char( {expr}) String single char with ASCII value {expr}
1831 pathshorten( {expr}) String shorten directory names in a path
1832 pow( {x}, {y}) Float {x} to the power of {y}
1833 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum}
1834 printf( {fmt}, {expr1}...) String format text
1835 pumvisible() Number whether popup menu is visible
1836 range( {expr} [, {max} [, {stride}]])
1837 List items from {expr} to {max}
1838 readfile( {fname} [, {binary} [, {max}]])
1839 List get list of lines from file {fname}
1840 reltime( [{start} [, {end}]]) List get time value
1841 reltimestr( {time}) String turn time value into a String
1842 remote_expr( {server}, {string} [, {idvar}])
1843 String send expression
1844 remote_foreground( {server}) Number bring Vim server to the foreground
1845 remote_peek( {serverid} [, {retvar}])
1846 Number check for reply string
1847 remote_read( {serverid}) String read reply string
1848 remote_send( {server}, {string} [, {idvar}])
1849 String send key sequence
1850 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list}
1851 remove( {dict}, {key}) any remove entry {key} from {dict}
1852 rename( {from}, {to}) Number rename (move) file from {from} to {to}
1853 repeat( {expr}, {count}) String repeat {expr} {count} times
1854 resolve( {filename}) String get filename a shortcut points to
1855 reverse( {list}) List reverse {list} in-place
1856 round( {expr}) Float round off {expr}
1857 search( {pattern} [, {flags} [, {stopline} [, {timeout}]]])
1858 Number search for {pattern}
1859 searchdecl( {name} [, {global} [, {thisblock}]])
1860 Number search for variable declaration
1861 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [...]]])
1862 Number search for other end of start/end pair
1863 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [...]]])
1864 List search for other end of start/end pair
1865 searchpos( {pattern} [, {flags} [, {stopline} [, {timeout}]]])
1866 List search for {pattern}
1867 server2client( {clientid}, {string})
1868 Number send reply string
1869 serverlist() String get a list of available servers
1870 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val}
1871 setcmdpos( {pos}) Number set cursor position in command-line
1872 setline( {lnum}, {line}) Number set line {lnum} to {line}
1873 setloclist( {nr}, {list}[, {action}])
1874 Number modify location list using {list}
1875 setmatches( {list}) Number restore a list of matches
1876 setpos( {expr}, {list}) Number set the {expr} position to {list}
1877 setqflist( {list}[, {action}]) Number modify quickfix list using {list}
1878 setreg( {n}, {v}[, {opt}]) Number set register to value and type
1879 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window
1880 {winnr} in tab page {tabnr} to {val}
1881 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val}
1882 shellescape( {string} [, {special}])
1883 String escape {string} for use as shell
1884 command argument
1885 simplify( {filename}) String simplify filename as much as possible
1886 sin( {expr}) Float sine of {expr}
1887 sort( {list} [, {func}]) List sort {list}, using {func} to compare
1888 soundfold( {word}) String sound-fold {word}
1889 spellbadword() String badly spelled word at cursor
1890 spellsuggest( {word} [, {max} [, {capital}]])
1891 List spelling suggestions
1892 split( {expr} [, {pat} [, {keepempty}]])
1893 List make |List| from {pat} separated {expr}
1894 sqrt( {expr} Float squar root of {expr}
1895 str2float( {expr}) Float convert String to Float
1896 str2nr( {expr} [, {base}]) Number convert String to Number
1897 strftime( {format}[, {time}]) String time in specified format
1898 stridx( {haystack}, {needle}[, {start}])
1899 Number index of {needle} in {haystack}
1900 string( {expr}) String String representation of {expr} value
1901 strlen( {expr}) Number length of the String {expr}
1902 strpart( {src}, {start}[, {len}])
1903 String {len} characters of {src} at {start}
1904 strridx( {haystack}, {needle} [, {start}])
1905 Number last index of {needle} in {haystack}
1906 strtrans( {expr}) String translate string to make it printable
1907 submatch( {nr}) String specific match in ":substitute"
1908 substitute( {expr}, {pat}, {sub}, {flags})
1909 String all {pat} in {expr} replaced with {sub}
1910 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
1911 synIDattr( {synID}, {what} [, {mode}])
1912 String attribute {what} of syntax ID {synID}
1913 synIDtrans( {synID}) Number translated syntax ID of {synID}
1914 synstack( {lnum}, {col}) List stack of syntax IDs at {lnum} and {col}
1915 system( {expr} [, {input}]) String output of shell command/filter {expr}
1916 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page
1917 tabpagenr( [{arg}]) Number number of current or last tab page
1918 tabpagewinnr( {tabarg}[, {arg}])
1919 Number number of current window in tab page
1920 taglist( {expr}) List list of tags matching {expr}
1921 tagfiles() List tags files used
1922 tempname() String name for a temporary file
1923 tolower( {expr}) String the String {expr} switched to lowercase
1924 toupper( {expr}) String the String {expr} switched to uppercase
1925 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
1926 to chars in {tostr}
1927 trunc( {expr} Float truncate Float {expr}
1928 type( {name}) Number type of variable {name}
1929 values( {dict}) List values in {dict}
1930 virtcol( {expr}) Number screen column of cursor or mark
1931 visualmode( [expr]) String last visual mode used
1932 winbufnr( {nr}) Number buffer number of window {nr}
1933 wincol() Number window column of the cursor
1934 winheight( {nr}) Number height of window {nr}
1935 winline() Number window line of the cursor
1936 winnr( [{expr}]) Number number of current window
1937 winrestcmd() String returns command to restore window sizes
1938 winrestview( {dict}) none restore view of current window
1939 winsaveview() Dict save view of current window
1940 winwidth( {nr}) Number width of window {nr}
1941 writefile( {list}, {fname} [, {binary}])
1942 Number write list of lines to file {fname}
1944 abs({expr}) *abs()*
1945 Return the absolute value of {expr}. When {expr} evaluates to
1946 a |Float| abs() returns a |Float|. When {expr} can be
1947 converted to a |Number| abs() returns a |Number|. Otherwise
1948 abs() gives an error message and returns -1.
1949 Examples: >
1950 echo abs(1.456)
1951 < 1.456 >
1952 echo abs(-5.456)
1953 < 5.456 >
1954 echo abs(-4)
1955 < 4
1956 {only available when compiled with the |+float| feature}
1958 add({list}, {expr}) *add()*
1959 Append the item {expr} to |List| {list}. Returns the
1960 resulting |List|. Examples: >
1961 :let alist = add([1, 2, 3], item)
1962 :call add(mylist, "woodstock")
1963 < Note that when {expr} is a |List| it is appended as a single
1964 item. Use |extend()| to concatenate |Lists|.
1965 Use |insert()| to add an item at another position.
1968 append({lnum}, {expr}) *append()*
1969 When {expr} is a |List|: Append each item of the |List| as a
1970 text line below line {lnum} in the current buffer.
1971 Otherwise append {expr} as one text line below line {lnum} in
1972 the current buffer.
1973 {lnum} can be zero to insert a line before the first one.
1974 Returns 1 for failure ({lnum} out of range or out of memory),
1975 0 for success. Example: >
1976 :let failed = append(line('$'), "# THE END")
1977 :let failed = append(0, ["Chapter 1", "the beginning"])
1978 <
1979 *argc()*
1980 argc() The result is the number of files in the argument list of the
1981 current window. See |arglist|.
1983 *argidx()*
1984 argidx() The result is the current index in the argument list. 0 is
1985 the first file. argc() - 1 is the last one. See |arglist|.
1987 *argv()*
1988 argv([{nr}]) The result is the {nr}th file in the argument list of the
1989 current window. See |arglist|. "argv(0)" is the first one.
1990 Example: >
1991 :let i = 0
1992 :while i < argc()
1993 : let f = escape(fnameescape(argv(i)), '.')
1994 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
1995 : let i = i + 1
1996 :endwhile
1997 < Without the {nr} argument a |List| with the whole |arglist| is
1998 returned.
2000 atan({expr}) *atan()*
2001 Return the principal value of the arc tangent of {expr}, in
2002 the range [-pi/2, +pi/2] radians, as a |Float|.
2003 {expr} must evaluate to a |Float| or a |Number|.
2004 Examples: >
2005 :echo atan(100)
2006 < 1.560797 >
2007 :echo atan(-4.01)
2008 < -1.326405
2009 {only available when compiled with the |+float| feature}
2011 *browse()*
2012 browse({save}, {title}, {initdir}, {default})
2013 Put up a file requester. This only works when "has("browse")"
2014 returns non-zero (only in some GUI versions).
2015 The input fields are:
2016 {save} when non-zero, select file to write
2017 {title} title for the requester
2018 {initdir} directory to start browsing in
2019 {default} default file name
2020 When the "Cancel" button is hit, something went wrong, or
2021 browsing is not possible, an empty string is returned.
2023 *browsedir()*
2024 browsedir({title}, {initdir})
2025 Put up a directory requester. This only works when
2026 "has("browse")" returns non-zero (only in some GUI versions).
2027 On systems where a directory browser is not supported a file
2028 browser is used. In that case: select a file in the directory
2029 to be used.
2030 The input fields are:
2031 {title} title for the requester
2032 {initdir} directory to start browsing in
2033 When the "Cancel" button is hit, something went wrong, or
2034 browsing is not possible, an empty string is returned.
2036 bufexists({expr}) *bufexists()*
2037 The result is a Number, which is non-zero if a buffer called
2038 {expr} exists.
2039 If the {expr} argument is a number, buffer numbers are used.
2040 If the {expr} argument is a string it must match a buffer name
2041 exactly. The name can be:
2042 - Relative to the current directory.
2043 - A full path.
2044 - The name of a buffer with 'buftype' set to "nofile".
2045 - A URL name.
2046 Unlisted buffers will be found.
2047 Note that help files are listed by their short name in the
2048 output of |:buffers|, but bufexists() requires using their
2049 long name to be able to find them.
2050 bufexists() may report a buffer exists, but to use the name
2051 with a |:buffer| command you may need to use |expand()|. Esp
2052 for MS-Windows 8.3 names in the form "c:\DOCUME~1"
2053 Use "bufexists(0)" to test for the existence of an alternate
2054 file name.
2055 *buffer_exists()*
2056 Obsolete name: buffer_exists().
2058 buflisted({expr}) *buflisted()*
2059 The result is a Number, which is non-zero if a buffer called
2060 {expr} exists and is listed (has the 'buflisted' option set).
2061 The {expr} argument is used like with |bufexists()|.
2063 bufloaded({expr}) *bufloaded()*
2064 The result is a Number, which is non-zero if a buffer called
2065 {expr} exists and is loaded (shown in a window or hidden).
2066 The {expr} argument is used like with |bufexists()|.
2068 bufname({expr}) *bufname()*
2069 The result is the name of a buffer, as it is displayed by the
2070 ":ls" command.
2071 If {expr} is a Number, that buffer number's name is given.
2072 Number zero is the alternate buffer for the current window.
2073 If {expr} is a String, it is used as a |file-pattern| to match
2074 with the buffer names. This is always done like 'magic' is
2075 set and 'cpoptions' is empty. When there is more than one
2076 match an empty string is returned.
2077 "" or "%" can be used for the current buffer, "#" for the
2078 alternate buffer.
2079 A full match is preferred, otherwise a match at the start, end
2080 or middle of the buffer name is accepted. If you only want a
2081 full match then put "^" at the start and "$" at the end of the
2082 pattern.
2083 Listed buffers are found first. If there is a single match
2084 with a listed buffer, that one is returned. Next unlisted
2085 buffers are searched for.
2086 If the {expr} is a String, but you want to use it as a buffer
2087 number, force it to be a Number by adding zero to it: >
2088 :echo bufname("3" + 0)
2089 < If the buffer doesn't exist, or doesn't have a name, an empty
2090 string is returned. >
2091 bufname("#") alternate buffer name
2092 bufname(3) name of buffer 3
2093 bufname("%") name of current buffer
2094 bufname("file2") name of buffer where "file2" matches.
2095 < *buffer_name()*
2096 Obsolete name: buffer_name().
2098 *bufnr()*
2099 bufnr({expr} [, {create}])
2100 The result is the number of a buffer, as it is displayed by
2101 the ":ls" command. For the use of {expr}, see |bufname()|
2102 above.
2103 If the buffer doesn't exist, -1 is returned. Or, if the
2104 {create} argument is present and not zero, a new, unlisted,
2105 buffer is created and its number is returned.
2106 bufnr("$") is the last buffer: >
2107 :let last_buffer = bufnr("$")
2108 < The result is a Number, which is the highest buffer number
2109 of existing buffers. Note that not all buffers with a smaller
2110 number necessarily exist, because ":bwipeout" may have removed
2111 them. Use bufexists() to test for the existence of a buffer.
2112 *buffer_number()*
2113 Obsolete name: buffer_number().
2114 *last_buffer_nr()*
2115 Obsolete name for bufnr("$"): last_buffer_nr().
2117 bufwinnr({expr}) *bufwinnr()*
2118 The result is a Number, which is the number of the first
2119 window associated with buffer {expr}. For the use of {expr},
2120 see |bufname()| above. If buffer {expr} doesn't exist or
2121 there is no such window, -1 is returned. Example: >
2123 echo "A window containing buffer 1 is " . (bufwinnr(1))
2125 < The number can be used with |CTRL-W_w| and ":wincmd w"
2126 |:wincmd|.
2127 Only deals with the current tab page.
2130 byte2line({byte}) *byte2line()*
2131 Return the line number that contains the character at byte
2132 count {byte} in the current buffer. This includes the
2133 end-of-line character, depending on the 'fileformat' option
2134 for the current buffer. The first character has byte count
2135 one.
2136 Also see |line2byte()|, |go| and |:goto|.
2137 {not available when compiled without the |+byte_offset|
2138 feature}
2140 byteidx({expr}, {nr}) *byteidx()*
2141 Return byte index of the {nr}'th character in the string
2142 {expr}. Use zero for the first character, it returns zero.
2143 This function is only useful when there are multibyte
2144 characters, otherwise the returned value is equal to {nr}.
2145 Composing characters are counted as a separate character.
2146 Example : >
2147 echo matchstr(str, ".", byteidx(str, 3))
2148 < will display the fourth character. Another way to do the
2149 same: >
2150 let s = strpart(str, byteidx(str, 3))
2151 echo strpart(s, 0, byteidx(s, 1))
2152 < If there are less than {nr} characters -1 is returned.
2153 If there are exactly {nr} characters the length of the string
2154 is returned.
2156 call({func}, {arglist} [, {dict}]) *call()* *E699*
2157 Call function {func} with the items in |List| {arglist} as
2158 arguments.
2159 {func} can either be a |Funcref| or the name of a function.
2160 a:firstline and a:lastline are set to the cursor line.
2161 Returns the return value of the called function.
2162 {dict} is for functions with the "dict" attribute. It will be
2163 used to set the local variable "self". |Dictionary-function|
2165 ceil({expr}) *ceil()*
2166 Return the smallest integral value greater than or equal to
2167 {expr} as a |Float| (round up).
2168 {expr} must evaluate to a |Float| or a |Number|.
2169 Examples: >
2170 echo ceil(1.456)
2171 < 2.0 >
2172 echo ceil(-5.456)
2173 < -5.0 >
2174 echo ceil(4.0)
2175 < 4.0
2176 {only available when compiled with the |+float| feature}
2178 changenr() *changenr()*
2179 Return the number of the most recent change. This is the same
2180 number as what is displayed with |:undolist| and can be used
2181 with the |:undo| command.
2182 When a change was made it is the number of that change. After
2183 redo it is the number of the redone change. After undo it is
2184 one less than the number of the undone change.
2186 char2nr({expr}) *char2nr()*
2187 Return number value of the first char in {expr}. Examples: >
2188 char2nr(" ") returns 32
2189 char2nr("ABC") returns 65
2190 < The current 'encoding' is used. Example for "utf-8": >
2191 char2nr("á") returns 225
2192 char2nr("á"[0]) returns 195
2193 < |nr2char()| does the opposite.
2195 cindent({lnum}) *cindent()*
2196 Get the amount of indent for line {lnum} according the C
2197 indenting rules, as with 'cindent'.
2198 The indent is counted in spaces, the value of 'tabstop' is
2199 relevant. {lnum} is used just like in |getline()|.
2200 When {lnum} is invalid or Vim was not compiled the |+cindent|
2201 feature, -1 is returned.
2202 See |C-indenting|.
2204 clearmatches() *clearmatches()*
2205 Clears all matches previously defined by |matchadd()| and the
2206 |:match| commands.
2208 *col()*
2209 col({expr}) The result is a Number, which is the byte index of the column
2210 position given with {expr}. The accepted positions are:
2211 . the cursor position
2212 $ the end of the cursor line (the result is the
2213 number of characters in the cursor line plus one)
2214 'x position of mark x (if the mark is not set, 0 is
2215 returned)
2216 Additionally {expr} can be [lnum, col]: a |List| with the line
2217 and column number. Most useful when the column is "$", to get
2218 the last column of a specific line. When "lnum" or "col" is
2219 out of range then col() returns zero.
2220 To get the line number use |line()|. To get both use
2221 |getpos()|.
2222 For the screen column position use |virtcol()|.
2223 Note that only marks in the current file can be used.
2224 Examples: >
2225 col(".") column of cursor
2226 col("$") length of cursor line plus one
2227 col("'t") column of mark t
2228 col("'" . markname) column of mark markname
2229 < The first column is 1. 0 is returned for an error.
2230 For an uppercase mark the column may actually be in another
2231 buffer.
2232 For the cursor position, when 'virtualedit' is active, the
2233 column is one higher if the cursor is after the end of the
2234 line. This can be used to obtain the column in Insert mode: >
2235 :imap <F2> <C-O>:let save_ve = &ve<CR>
2236 \<C-O>:set ve=all<CR>
2237 \<C-O>:echo col(".") . "\n" <Bar>
2238 \let &ve = save_ve<CR>
2239 <
2241 complete({startcol}, {matches}) *complete()* *E785*
2242 Set the matches for Insert mode completion.
2243 Can only be used in Insert mode. You need to use a mapping
2244 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or
2245 with an expression mapping.
2246 {startcol} is the byte offset in the line where the completed
2247 text start. The text up to the cursor is the original text
2248 that will be replaced by the matches. Use col('.') for an
2249 empty string. "col('.') - 1" will replace one character by a
2250 match.
2251 {matches} must be a |List|. Each |List| item is one match.
2252 See |complete-items| for the kind of items that are possible.
2253 Note that the after calling this function you need to avoid
2254 inserting anything that would cause completion to stop.
2255 The match can be selected with CTRL-N and CTRL-P as usual with
2256 Insert mode completion. The popup menu will appear if
2257 specified, see |ins-completion-menu|.
2258 Example: >
2259 inoremap <F5> <C-R>=ListMonths()<CR>
2261 func! ListMonths()
2262 call complete(col('.'), ['January', 'February', 'March',
2263 \ 'April', 'May', 'June', 'July', 'August', 'September',
2264 \ 'October', 'November', 'December'])
2265 return ''
2266 endfunc
2267 < This isn't very useful, but it shows how it works. Note that
2268 an empty string is returned to avoid a zero being inserted.
2270 complete_add({expr}) *complete_add()*
2271 Add {expr} to the list of matches. Only to be used by the
2272 function specified with the 'completefunc' option.
2273 Returns 0 for failure (empty string or out of memory),
2274 1 when the match was added, 2 when the match was already in
2275 the list.
2276 See |complete-functions| for an explanation of {expr}. It is
2277 the same as one item in the list that 'omnifunc' would return.
2279 complete_check() *complete_check()*
2280 Check for a key typed while looking for completion matches.
2281 This is to be used when looking for matches takes some time.
2282 Returns non-zero when searching for matches is to be aborted,
2283 zero otherwise.
2284 Only to be used by the function specified with the
2285 'completefunc' option.
2287 *confirm()*
2288 confirm({msg} [, {choices} [, {default} [, {type}]]])
2289 Confirm() offers the user a dialog, from which a choice can be
2290 made. It returns the number of the choice. For the first
2291 choice this is 1.
2292 Note: confirm() is only supported when compiled with dialog
2293 support, see |+dialog_con| and |+dialog_gui|.
2294 {msg} is displayed in a |dialog| with {choices} as the
2295 alternatives. When {choices} is missing or empty, "&OK" is
2296 used (and translated).
2297 {msg} is a String, use '\n' to include a newline. Only on
2298 some systems the string is wrapped when it doesn't fit.
2299 {choices} is a String, with the individual choices separated
2300 by '\n', e.g. >
2301 confirm("Save changes?", "&Yes\n&No\n&Cancel")
2302 < The letter after the '&' is the shortcut key for that choice.
2303 Thus you can type 'c' to select "Cancel". The shortcut does
2304 not need to be the first letter: >
2305 confirm("file has been modified", "&Save\nSave &All")
2306 < For the console, the first letter of each choice is used as
2307 the default shortcut key.
2308 The optional {default} argument is the number of the choice
2309 that is made if the user hits <CR>. Use 1 to make the first
2310 choice the default one. Use 0 to not set a default. If
2311 {default} is omitted, 1 is used.
2312 The optional {type} argument gives the type of dialog. This
2313 is only used for the icon of the Win32 GUI. It can be one of
2314 these values: "Error", "Question", "Info", "Warning" or
2315 "Generic". Only the first character is relevant. When {type}
2316 is omitted, "Generic" is used.
2317 If the user aborts the dialog by pressing <Esc>, CTRL-C,
2318 or another valid interrupt key, confirm() returns 0.
2320 An example: >
2321 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2)
2322 :if choice == 0
2323 : echo "make up your mind!"
2324 :elseif choice == 3
2325 : echo "tasteful"
2326 :else
2327 : echo "I prefer bananas myself."
2328 :endif
2329 < In a GUI dialog, buttons are used. The layout of the buttons
2330 depends on the 'v' flag in 'guioptions'. If it is included,
2331 the buttons are always put vertically. Otherwise, confirm()
2332 tries to put the buttons in one horizontal line. If they
2333 don't fit, a vertical layout is used anyway. For some systems
2334 the horizontal layout is always used.
2336 *copy()*
2337 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
2338 different from using {expr} directly.
2339 When {expr} is a |List| a shallow copy is created. This means
2340 that the original |List| can be changed without changing the
2341 copy, and vice versa. But the items are identical, thus
2342 changing an item changes the contents of both |Lists|. Also
2343 see |deepcopy()|.
2345 cos({expr}) *cos()*
2346 Return the cosine of {expr}, measured in radians, as a |Float|.
2347 {expr} must evaluate to a |Float| or a |Number|.
2348 Examples: >
2349 :echo cos(100)
2350 < 0.862319 >
2351 :echo cos(-4.01)
2352 < -0.646043
2353 {only available when compiled with the |+float| feature}
2356 count({comp}, {expr} [, {ic} [, {start}]]) *count()*
2357 Return the number of times an item with value {expr} appears
2358 in |List| or |Dictionary| {comp}.
2359 If {start} is given then start with the item with this index.
2360 {start} can only be used with a |List|.
2361 When {ic} is given and it's non-zero then case is ignored.
2364 *cscope_connection()*
2365 cscope_connection([{num} , {dbpath} [, {prepend}]])
2366 Checks for the existence of a |cscope| connection. If no
2367 parameters are specified, then the function returns:
2368 0, if cscope was not available (not compiled in), or
2369 if there are no cscope connections;
2370 1, if there is at least one cscope connection.
2372 If parameters are specified, then the value of {num}
2373 determines how existence of a cscope connection is checked:
2375 {num} Description of existence check
2376 ----- ------------------------------
2377 0 Same as no parameters (e.g., "cscope_connection()").
2378 1 Ignore {prepend}, and use partial string matches for
2379 {dbpath}.
2380 2 Ignore {prepend}, and use exact string matches for
2381 {dbpath}.
2382 3 Use {prepend}, use partial string matches for both
2383 {dbpath} and {prepend}.
2384 4 Use {prepend}, use exact string matches for both
2385 {dbpath} and {prepend}.
2387 Note: All string comparisons are case sensitive!
2389 Examples. Suppose we had the following (from ":cs show"): >
2391 # pid database name prepend path
2392 0 27664 cscope.out /usr/local
2393 <
2394 Invocation Return Val ~
2395 ---------- ---------- >
2396 cscope_connection() 1
2397 cscope_connection(1, "out") 1
2398 cscope_connection(2, "out") 0
2399 cscope_connection(3, "out") 0
2400 cscope_connection(3, "out", "local") 1
2401 cscope_connection(4, "out") 0
2402 cscope_connection(4, "out", "local") 0
2403 cscope_connection(4, "cscope.out", "/usr/local") 1
2404 <
2405 cursor({lnum}, {col} [, {off}]) *cursor()*
2406 cursor({list})
2407 Positions the cursor at the column (byte count) {col} in the
2408 line {lnum}. The first column is one.
2409 When there is one argument {list} this is used as a |List|
2410 with two or three items {lnum}, {col} and {off}. This is like
2411 the return value of |getpos()|, but without the first item.
2412 Does not change the jumplist.
2413 If {lnum} is greater than the number of lines in the buffer,
2414 the cursor will be positioned at the last line in the buffer.
2415 If {lnum} is zero, the cursor will stay in the current line.
2416 If {col} is greater than the number of bytes in the line,
2417 the cursor will be positioned at the last character in the
2418 line.
2419 If {col} is zero, the cursor will stay in the current column.
2420 When 'virtualedit' is used {off} specifies the offset in
2421 screen columns from the start of the character. E.g., a
2422 position within a <Tab> or after the last character.
2423 Returns 0 when the position could be set, -1 otherwise.
2426 deepcopy({expr}[, {noref}]) *deepcopy()* *E698*
2427 Make a copy of {expr}. For Numbers and Strings this isn't
2428 different from using {expr} directly.
2429 When {expr} is a |List| a full copy is created. This means
2430 that the original |List| can be changed without changing the
2431 copy, and vice versa. When an item is a |List|, a copy for it
2432 is made, recursively. Thus changing an item in the copy does
2433 not change the contents of the original |List|.
2434 When {noref} is omitted or zero a contained |List| or
2435 |Dictionary| is only copied once. All references point to
2436 this single copy. With {noref} set to 1 every occurrence of a
2437 |List| or |Dictionary| results in a new copy. This also means
2438 that a cyclic reference causes deepcopy() to fail.
2439 *E724*
2440 Nesting is possible up to 100 levels. When there is an item
2441 that refers back to a higher level making a deep copy with
2442 {noref} set to 1 will fail.
2443 Also see |copy()|.
2445 delete({fname}) *delete()*
2446 Deletes the file by the name {fname}. The result is a Number,
2447 which is 0 if the file was deleted successfully, and non-zero
2448 when the deletion failed.
2449 Use |remove()| to delete an item from a |List|.
2451 *did_filetype()*
2452 did_filetype() Returns non-zero when autocommands are being executed and the
2453 FileType event has been triggered at least once. Can be used
2454 to avoid triggering the FileType event again in the scripts
2455 that detect the file type. |FileType|
2456 When editing another file, the counter is reset, thus this
2457 really checks if the FileType event has been triggered for the
2458 current buffer. This allows an autocommand that starts
2459 editing another buffer to set 'filetype' and load a syntax
2460 file.
2462 diff_filler({lnum}) *diff_filler()*
2463 Returns the number of filler lines above line {lnum}.
2464 These are the lines that were inserted at this point in
2465 another diff'ed window. These filler lines are shown in the
2466 display but don't exist in the buffer.
2467 {lnum} is used like with |getline()|. Thus "." is the current
2468 line, "'m" mark m, etc.
2469 Returns 0 if the current window is not in diff mode.
2471 diff_hlID({lnum}, {col}) *diff_hlID()*
2472 Returns the highlight ID for diff mode at line {lnum} column
2473 {col} (byte index). When the current line does not have a
2474 diff change zero is returned.
2475 {lnum} is used like with |getline()|. Thus "." is the current
2476 line, "'m" mark m, etc.
2477 {col} is 1 for the leftmost column, {lnum} is 1 for the first
2478 line.
2479 The highlight ID can be used with |synIDattr()| to obtain
2480 syntax information about the highlighting.
2482 empty({expr}) *empty()*
2483 Return the Number 1 if {expr} is empty, zero otherwise.
2484 A |List| or |Dictionary| is empty when it does not have any
2485 items. A Number is empty when its value is zero.
2486 For a long |List| this is much faster than comparing the
2487 length with zero.
2489 escape({string}, {chars}) *escape()*
2490 Escape the characters in {chars} that occur in {string} with a
2491 backslash. Example: >
2492 :echo escape('c:\program files\vim', ' \')
2493 < results in: >
2494 c:\\program\ files\\vim
2495 < Also see |shellescape()|.
2497 *eval()*
2498 eval({string}) Evaluate {string} and return the result. Especially useful to
2499 turn the result of |string()| back into the original value.
2500 This works for Numbers, Floats, Strings and composites of
2501 them. Also works for |Funcref|s that refer to existing
2502 functions.
2504 eventhandler() *eventhandler()*
2505 Returns 1 when inside an event handler. That is that Vim got
2506 interrupted while waiting for the user to type a character,
2507 e.g., when dropping a file on Vim. This means interactive
2508 commands cannot be used. Otherwise zero is returned.
2510 executable({expr}) *executable()*
2511 This function checks if an executable with the name {expr}
2512 exists. {expr} must be the name of the program without any
2513 arguments.
2514 executable() uses the value of $PATH and/or the normal
2515 searchpath for programs. *PATHEXT*
2516 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can
2517 optionally be included. Then the extensions in $PATHEXT are
2518 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be
2519 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is
2520 used. A dot by itself can be used in $PATHEXT to try using
2521 the name without an extension. When 'shell' looks like a
2522 Unix shell, then the name is also tried without adding an
2523 extension.
2524 On MS-DOS and MS-Windows it only checks if the file exists and
2525 is not a directory, not if it's really executable.
2526 On MS-Windows an executable in the same directory as Vim is
2527 always found. Since this directory is added to $PATH it
2528 should also work to execute it |win32-PATH|.
2529 The result is a Number:
2530 1 exists
2531 0 does not exist
2532 -1 not implemented on this system
2534 *exists()*
2535 exists({expr}) The result is a Number, which is non-zero if {expr} is
2536 defined, zero otherwise. The {expr} argument is a string,
2537 which contains one of these:
2538 &option-name Vim option (only checks if it exists,
2539 not if it really works)
2540 +option-name Vim option that works.
2541 $ENVNAME environment variable (could also be
2542 done by comparing with an empty
2543 string)
2544 *funcname built-in function (see |functions|)
2545 or user defined function (see
2546 |user-functions|).
2547 varname internal variable (see
2548 |internal-variables|). Also works
2549 for |curly-braces-names|, |Dictionary|
2550 entries, |List| items, etc. Beware
2551 that evaluating an index may cause an
2552 error message for an invalid
2553 expression. E.g.: >
2554 :let l = [1, 2, 3]
2555 :echo exists("l[5]")
2556 < 0 >
2557 :echo exists("l[xx]")
2558 < E121: Undefined variable: xx
2559 0
2560 :cmdname Ex command: built-in command, user
2561 command or command modifier |:command|.
2562 Returns:
2563 1 for match with start of a command
2564 2 full match with a command
2565 3 matches several user commands
2566 To check for a supported command
2567 always check the return value to be 2.
2568 :2match The |:2match| command.
2569 :3match The |:3match| command.
2570 #event autocommand defined for this event
2571 #event#pattern autocommand defined for this event and
2572 pattern (the pattern is taken
2573 literally and compared to the
2574 autocommand patterns character by
2575 character)
2576 #group autocommand group exists
2577 #group#event autocommand defined for this group and
2578 event.
2579 #group#event#pattern
2580 autocommand defined for this group,
2581 event and pattern.
2582 ##event autocommand for this event is
2583 supported.
2584 For checking for a supported feature use |has()|.
2586 Examples: >
2587 exists("&shortname")
2588 exists("$HOSTNAME")
2589 exists("*strftime")
2590 exists("*s:MyFunc")
2591 exists("bufcount")
2592 exists(":Make")
2593 exists("#CursorHold")
2594 exists("#BufReadPre#*.gz")
2595 exists("#filetypeindent")
2596 exists("#filetypeindent#FileType")
2597 exists("#filetypeindent#FileType#*")
2598 exists("##ColorScheme")
2599 < There must be no space between the symbol (&/$/*/#) and the
2600 name.
2601 There must be no extra characters after the name, although in
2602 a few cases this is ignored. That may become more strict in
2603 the future, thus don't count on it!
2604 Working example: >
2605 exists(":make")
2606 < NOT working example: >
2607 exists(":make install")
2609 < Note that the argument must be a string, not the name of the
2610 variable itself. For example: >
2611 exists(bufcount)
2612 < This doesn't check for existence of the "bufcount" variable,
2613 but gets the value of "bufcount", and checks if that exists.
2615 expand({expr} [, {flag}]) *expand()*
2616 Expand wildcards and the following special keywords in {expr}.
2617 The result is a String.
2619 When there are several matches, they are separated by <NL>
2620 characters. [Note: in version 5.0 a space was used, which
2621 caused problems when a file name contains a space]
2623 If the expansion fails, the result is an empty string. A name
2624 for a non-existing file is not included.
2626 When {expr} starts with '%', '#' or '<', the expansion is done
2627 like for the |cmdline-special| variables with their associated
2628 modifiers. Here is a short overview:
2630 % current file name
2631 # alternate file name
2632 #n alternate file name n
2633 <cfile> file name under the cursor
2634 <afile> autocmd file name
2635 <abuf> autocmd buffer number (as a String!)
2636 <amatch> autocmd matched name
2637 <sfile> sourced script file name
2638 <cword> word under the cursor
2639 <cWORD> WORD under the cursor
2640 <client> the {clientid} of the last received
2641 message |server2client()|
2642 Modifiers:
2643 :p expand to full path
2644 :h head (last path component removed)
2645 :t tail (last path component only)
2646 :r root (one extension removed)
2647 :e extension only
2649 Example: >
2650 :let &tags = expand("%:p:h") . "/tags"
2651 < Note that when expanding a string that starts with '%', '#' or
2652 '<', any following text is ignored. This does NOT work: >
2653 :let doesntwork = expand("%:h.bak")
2654 < Use this: >
2655 :let doeswork = expand("%:h") . ".bak"
2656 < Also note that expanding "<cfile>" and others only returns the
2657 referenced file name without further expansion. If "<cfile>"
2658 is "~/.cshrc", you need to do another expand() to have the
2659 "~/" expanded into the path of the home directory: >
2660 :echo expand(expand("<cfile>"))
2661 <
2662 There cannot be white space between the variables and the
2663 following modifier. The |fnamemodify()| function can be used
2664 to modify normal file names.
2666 When using '%' or '#', and the current or alternate file name
2667 is not defined, an empty string is used. Using "%:p" in a
2668 buffer with no name, results in the current directory, with a
2669 '/' added.
2671 When {expr} does not start with '%', '#' or '<', it is
2672 expanded like a file name is expanded on the command line.
2673 'suffixes' and 'wildignore' are used, unless the optional
2674 {flag} argument is given and it is non-zero. Names for
2675 non-existing files are included. The "**" item can be used to
2676 search in a directory tree. For example, to find all "README"
2677 files in the current directory and below: >
2678 :echo expand("**/README")
2679 <
2680 Expand() can also be used to expand variables and environment
2681 variables that are only known in a shell. But this can be
2682 slow, because a shell must be started. See |expr-env-expand|.
2683 The expanded variable is still handled like a list of file
2684 names. When an environment variable cannot be expanded, it is
2685 left unchanged. Thus ":echo expand('$FOOBAR')" results in
2686 "$FOOBAR".
2688 See |glob()| for finding existing files. See |system()| for
2689 getting the raw output of an external command.
2691 extend({expr1}, {expr2} [, {expr3}]) *extend()*
2692 {expr1} and {expr2} must be both |Lists| or both
2693 |Dictionaries|.
2695 If they are |Lists|: Append {expr2} to {expr1}.
2696 If {expr3} is given insert the items of {expr2} before item
2697 {expr3} in {expr1}. When {expr3} is zero insert before the
2698 first item. When {expr3} is equal to len({expr1}) then
2699 {expr2} is appended.
2700 Examples: >
2701 :echo sort(extend(mylist, [7, 5]))
2702 :call extend(mylist, [2, 3], 1)
2703 < When {expr1} is the same List as {expr2} then the number of
2704 items copied is equal to the original length of the List.
2705 E.g., when {expr3} is 1 you get N new copies of the first item
2706 (where N is the original length of the List).
2707 Use |add()| to concatenate one item to a list. To concatenate
2708 two lists into a new list use the + operator: >
2709 :let newlist = [1, 2, 3] + [4, 5]
2710 <
2711 If they are |Dictionaries|:
2712 Add all entries from {expr2} to {expr1}.
2713 If a key exists in both {expr1} and {expr2} then {expr3} is
2714 used to decide what to do:
2715 {expr3} = "keep": keep the value of {expr1}
2716 {expr3} = "force": use the value of {expr2}
2717 {expr3} = "error": give an error message *E737*
2718 When {expr3} is omitted then "force" is assumed.
2720 {expr1} is changed when {expr2} is not empty. If necessary
2721 make a copy of {expr1} first.
2722 {expr2} remains unchanged.
2723 Returns {expr1}.
2726 feedkeys({string} [, {mode}]) *feedkeys()*
2727 Characters in {string} are queued for processing as if they
2728 come from a mapping or were typed by the user. They are added
2729 to the end of the typeahead buffer, thus if a mapping is still
2730 being executed these characters come after them.
2731 The function does not wait for processing of keys contained in
2732 {string}.
2733 To include special keys into {string}, use double-quotes
2734 and "\..." notation |expr-quote|. For example,
2735 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
2736 feedkeys('\<CR>') pushes 5 characters.
2737 If {mode} is absent, keys are remapped.
2738 {mode} is a String, which can contain these character flags:
2739 'm' Remap keys. This is default.
2740 'n' Do not remap keys.
2741 't' Handle keys as if typed; otherwise they are handled as
2742 if coming from a mapping. This matters for undo,
2743 opening folds, etc.
2744 Return value is always 0.
2746 filereadable({file}) *filereadable()*
2747 The result is a Number, which is TRUE when a file with the
2748 name {file} exists, and can be read. If {file} doesn't exist,
2749 or is a directory, the result is FALSE. {file} is any
2750 expression, which is used as a String.
2751 If you don't care about the file being readable you can use
2752 |glob()|.
2753 *file_readable()*
2754 Obsolete name: file_readable().
2757 filewritable({file}) *filewritable()*
2758 The result is a Number, which is 1 when a file with the
2759 name {file} exists, and can be written. If {file} doesn't
2760 exist, or is not writable, the result is 0. If {file} is a
2761 directory, and we can write to it, the result is 2.
2764 filter({expr}, {string}) *filter()*
2765 {expr} must be a |List| or a |Dictionary|.
2766 For each item in {expr} evaluate {string} and when the result
2767 is zero remove the item from the |List| or |Dictionary|.
2768 Inside {string} |v:val| has the value of the current item.
2769 For a |Dictionary| |v:key| has the key of the current item.
2770 Examples: >
2771 :call filter(mylist, 'v:val !~ "OLD"')
2772 < Removes the items where "OLD" appears. >
2773 :call filter(mydict, 'v:key >= 8')
2774 < Removes the items with a key below 8. >
2775 :call filter(var, 0)
2776 < Removes all the items, thus clears the |List| or |Dictionary|.
2778 Note that {string} is the result of expression and is then
2779 used as an expression again. Often it is good to use a
2780 |literal-string| to avoid having to double backslashes.
2782 The operation is done in-place. If you want a |List| or
2783 |Dictionary| to remain unmodified make a copy first: >
2784 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
2786 < Returns {expr}, the |List| or |Dictionary| that was filtered.
2787 When an error is encountered while evaluating {string} no
2788 further items in {expr} are processed.
2791 finddir({name}[, {path}[, {count}]]) *finddir()*
2792 Find directory {name} in {path}. Supports both downwards and
2793 upwards recursive directory searches. See |file-searching|
2794 for the syntax of {path}.
2795 Returns the path of the first found match. When the found
2796 directory is below the current directory a relative path is
2797 returned. Otherwise a full path is returned.
2798 If {path} is omitted or empty then 'path' is used.
2799 If the optional {count} is given, find {count}'s occurrence of
2800 {name} in {path} instead of the first one.
2801 When {count} is negative return all the matches in a |List|.
2802 This is quite similar to the ex-command |:find|.
2803 {only available when compiled with the +file_in_path feature}
2805 findfile({name}[, {path}[, {count}]]) *findfile()*
2806 Just like |finddir()|, but find a file instead of a directory.
2807 Uses 'suffixesadd'.
2808 Example: >
2809 :echo findfile("tags.vim", ".;")
2810 < Searches from the directory of the current file upwards until
2811 it finds the file "tags.vim".
2813 float2nr({expr}) *float2nr()*
2814 Convert {expr} to a Number by omitting the part after the
2815 decimal point.
2816 {expr} must evaluate to a |Float| or a Number.
2817 When the value of {expr} is out of range for a |Number| the
2818 result is truncated to 0x7fffffff or -0x7fffffff. NaN results
2819 in -0x80000000.
2820 Examples: >
2821 echo float2nr(3.95)
2822 < 3 >
2823 echo float2nr(-23.45)
2824 < -23 >
2825 echo float2nr(1.0e100)
2826 < 2147483647 >
2827 echo float2nr(-1.0e150)
2828 < -2147483647 >
2829 echo float2nr(1.0e-100)
2830 < 0
2831 {only available when compiled with the |+float| feature}
2834 floor({expr}) *floor()*
2835 Return the largest integral value less than or equal to
2836 {expr} as a |Float| (round down).
2837 {expr} must evaluate to a |Float| or a |Number|.
2838 Examples: >
2839 echo floor(1.856)
2840 < 1.0 >
2841 echo floor(-5.456)
2842 < -6.0 >
2843 echo floor(4.0)
2844 < 4.0
2845 {only available when compiled with the |+float| feature}
2847 fnameescape({string}) *fnameescape()*
2848 Escape {string} for use as file name command argument. All
2849 characters that have a special meaning, such as '%' and '|'
2850 are escaped with a backslash.
2851 For most systems the characters escaped are
2852 " \t\n*?[{`$\\%#'\"|!<". For systems where a backslash
2853 appears in a filename, it depends on the value of 'isfname'.
2854 A leading '+' and '>' is also escaped (special after |:edit|
2855 and |:write|). And a "-" by itself (special after |:cd|).
2856 Example: >
2857 :let fname = '+some str%nge|name'
2858 :exe "edit " . fnameescape(fname)
2859 < results in executing: >
2860 edit \+some\ str\%nge\|name
2862 fnamemodify({fname}, {mods}) *fnamemodify()*
2863 Modify file name {fname} according to {mods}. {mods} is a
2864 string of characters like it is used for file names on the
2865 command line. See |filename-modifiers|.
2866 Example: >
2867 :echo fnamemodify("main.c", ":p:h")
2868 < results in: >
2869 /home/mool/vim/vim/src
2870 < Note: Environment variables don't work in {fname}, use
2871 |expand()| first then.
2873 foldclosed({lnum}) *foldclosed()*
2874 The result is a Number. If the line {lnum} is in a closed
2875 fold, the result is the number of the first line in that fold.
2876 If the line {lnum} is not in a closed fold, -1 is returned.
2878 foldclosedend({lnum}) *foldclosedend()*
2879 The result is a Number. If the line {lnum} is in a closed
2880 fold, the result is the number of the last line in that fold.
2881 If the line {lnum} is not in a closed fold, -1 is returned.
2883 foldlevel({lnum}) *foldlevel()*
2884 The result is a Number, which is the foldlevel of line {lnum}
2885 in the current buffer. For nested folds the deepest level is
2886 returned. If there is no fold at line {lnum}, zero is
2887 returned. It doesn't matter if the folds are open or closed.
2888 When used while updating folds (from 'foldexpr') -1 is
2889 returned for lines where folds are still to be updated and the
2890 foldlevel is unknown. As a special case the level of the
2891 previous line is usually available.
2893 *foldtext()*
2894 foldtext() Returns a String, to be displayed for a closed fold. This is
2895 the default function used for the 'foldtext' option and should
2896 only be called from evaluating 'foldtext'. It uses the
2897 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
2898 The returned string looks like this: >
2899 +-- 45 lines: abcdef
2900 < The number of dashes depends on the foldlevel. The "45" is
2901 the number of lines in the fold. "abcdef" is the text in the
2902 first non-blank line of the fold. Leading white space, "//"
2903 or "/*" and the text from the 'foldmarker' and 'commentstring'
2904 options is removed.
2905 {not available when compiled without the |+folding| feature}
2907 foldtextresult({lnum}) *foldtextresult()*
2908 Returns the text that is displayed for the closed fold at line
2909 {lnum}. Evaluates 'foldtext' in the appropriate context.
2910 When there is no closed fold at {lnum} an empty string is
2911 returned.
2912 {lnum} is used like with |getline()|. Thus "." is the current
2913 line, "'m" mark m, etc.
2914 Useful when exporting folded text, e.g., to HTML.
2915 {not available when compiled without the |+folding| feature}
2917 *foreground()*
2918 foreground() Move the Vim window to the foreground. Useful when sent from
2919 a client to a Vim server. |remote_send()|
2920 On Win32 systems this might not work, the OS does not always
2921 allow a window to bring itself to the foreground. Use
2922 |remote_foreground()| instead.
2923 {only in the Win32, Athena, Motif and GTK GUI versions and the
2924 Win32 console version}
2927 function({name}) *function()* *E700*
2928 Return a |Funcref| variable that refers to function {name}.
2929 {name} can be a user defined function or an internal function.
2932 garbagecollect([at_exit]) *garbagecollect()*
2933 Cleanup unused |Lists| and |Dictionaries| that have circular
2934 references. There is hardly ever a need to invoke this
2935 function, as it is automatically done when Vim runs out of
2936 memory or is waiting for the user to press a key after
2937 'updatetime'. Items without circular references are always
2938 freed when they become unused.
2939 This is useful if you have deleted a very big |List| and/or
2940 |Dictionary| with circular references in a script that runs
2941 for a long time.
2942 When the optional "at_exit" argument is one, garbage
2943 collection will also be done when exiting Vim, if it wasn't
2944 done before. This is useful when checking for memory leaks.
2946 get({list}, {idx} [, {default}]) *get()*
2947 Get item {idx} from |List| {list}. When this item is not
2948 available return {default}. Return zero when {default} is
2949 omitted.
2950 get({dict}, {key} [, {default}])
2951 Get item with key {key} from |Dictionary| {dict}. When this
2952 item is not available return {default}. Return zero when
2953 {default} is omitted.
2955 *getbufline()*
2956 getbufline({expr}, {lnum} [, {end}])
2957 Return a |List| with the lines starting from {lnum} to {end}
2958 (inclusive) in the buffer {expr}. If {end} is omitted, a
2959 |List| with only the line {lnum} is returned.
2961 For the use of {expr}, see |bufname()| above.
2963 For {lnum} and {end} "$" can be used for the last line of the
2964 buffer. Otherwise a number must be used.
2966 When {lnum} is smaller than 1 or bigger than the number of
2967 lines in the buffer, an empty |List| is returned.
2969 When {end} is greater than the number of lines in the buffer,
2970 it is treated as {end} is set to the number of lines in the
2971 buffer. When {end} is before {lnum} an empty |List| is
2972 returned.
2974 This function works only for loaded buffers. For unloaded and
2975 non-existing buffers, an empty |List| is returned.
2977 Example: >
2978 :let lines = getbufline(bufnr("myfile"), 1, "$")
2980 getbufvar({expr}, {varname}) *getbufvar()*
2981 The result is the value of option or local buffer variable
2982 {varname} in buffer {expr}. Note that the name without "b:"
2983 must be used.
2984 When {varname} is empty returns a dictionary with all the
2985 buffer-local variables.
2986 This also works for a global or buffer-local option, but it
2987 doesn't work for a global variable, window-local variable or
2988 window-local option.
2989 For the use of {expr}, see |bufname()| above.
2990 When the buffer or variable doesn't exist an empty string is
2991 returned, there is no error message.
2992 Examples: >
2993 :let bufmodified = getbufvar(1, "&mod")
2994 :echo "todo myvar = " . getbufvar("todo", "myvar")
2995 <
2996 getchar([expr]) *getchar()*
2997 Get a single character from the user or input stream.
2998 If [expr] is omitted, wait until a character is available.
2999 If [expr] is 0, only get a character when one is available.
3000 Return zero otherwise.
3001 If [expr] is 1, only check if a character is available, it is
3002 not consumed. Return zero if no character available.
3004 Without {expr} and when {expr} is 0 a whole character or
3005 special key is returned. If it is an 8-bit character, the
3006 result is a number. Use nr2char() to convert it to a String.
3007 Otherwise a String is returned with the encoded character.
3008 For a special key it's a sequence of bytes starting with 0x80
3009 (decimal: 128). This is the same value as the string
3010 "\<Key>", e.g., "\<Left>". The returned value is also a
3011 String when a modifier (shift, control, alt) was used that is
3012 not included in the character.
3014 When {expr} is 1 only the first byte is returned. For a
3015 one-byte character it is the character itself as a number.
3016 Use nr2char() to convert it to a String.
3018 When the user clicks a mouse button, the mouse event will be
3019 returned. The position can then be found in |v:mouse_col|,
3020 |v:mouse_lnum| and |v:mouse_win|. This example positions the
3021 mouse as it would normally happen: >
3022 let c = getchar()
3023 if c == "\<LeftMouse>" && v:mouse_win > 0
3024 exe v:mouse_win . "wincmd w"
3025 exe v:mouse_lnum
3026 exe "normal " . v:mouse_col . "|"
3027 endif
3028 <
3029 There is no prompt, you will somehow have to make clear to the
3030 user that a character has to be typed.
3031 There is no mapping for the character.
3032 Key codes are replaced, thus when the user presses the <Del>
3033 key you get the code for the <Del> key, not the raw character
3034 sequence. Examples: >
3035 getchar() == "\<Del>"
3036 getchar() == "\<S-Left>"
3037 < This example redefines "f" to ignore case: >
3038 :nmap f :call FindChar()<CR>
3039 :function FindChar()
3040 : let c = nr2char(getchar())
3041 : while col('.') < col('$') - 1
3042 : normal l
3043 : if getline('.')[col('.') - 1] ==? c
3044 : break
3045 : endif
3046 : endwhile
3047 :endfunction
3049 getcharmod() *getcharmod()*
3050 The result is a Number which is the state of the modifiers for
3051 the last obtained character with getchar() or in another way.
3052 These values are added together:
3053 2 shift
3054 4 control
3055 8 alt (meta)
3056 16 mouse double click
3057 32 mouse triple click
3058 64 mouse quadruple click
3059 128 Macintosh only: command
3060 Only the modifiers that have not been included in the
3061 character itself are obtained. Thus Shift-a results in "A"
3062 without a modifier.
3064 getcmdline() *getcmdline()*
3065 Return the current command-line. Only works when the command
3066 line is being edited, thus requires use of |c_CTRL-\_e| or
3067 |c_CTRL-R_=|.
3068 Example: >
3069 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
3070 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
3072 getcmdpos() *getcmdpos()*
3073 Return the position of the cursor in the command line as a
3074 byte count. The first column is 1.
3075 Only works when editing the command line, thus requires use of
3076 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns 0 otherwise.
3077 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
3079 getcmdtype() *getcmdtype()*
3080 Return the current command-line type. Possible return values
3081 are:
3082 : normal Ex command
3083 > debug mode command |debug-mode|
3084 / forward search command
3085 ? backward search command
3086 @ |input()| command
3087 - |:insert| or |:append| command
3088 Only works when editing the command line, thus requires use of
3089 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns an empty string
3090 otherwise.
3091 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
3093 *getcwd()*
3094 getcwd() The result is a String, which is the name of the current
3095 working directory.
3097 getfsize({fname}) *getfsize()*
3098 The result is a Number, which is the size in bytes of the
3099 given file {fname}.
3100 If {fname} is a directory, 0 is returned.
3101 If the file {fname} can't be found, -1 is returned.
3102 If the size of {fname} is too big to fit in a Number then -2
3103 is returned.
3105 getfontname([{name}]) *getfontname()*
3106 Without an argument returns the name of the normal font being
3107 used. Like what is used for the Normal highlight group
3108 |hl-Normal|.
3109 With an argument a check is done whether {name} is a valid
3110 font name. If not then an empty string is returned.
3111 Otherwise the actual font name is returned, or {name} if the
3112 GUI does not support obtaining the real name.
3113 Only works when the GUI is running, thus not in your vimrc or
3114 gvimrc file. Use the |GUIEnter| autocommand to use this
3115 function just after the GUI has started.
3116 Note that the GTK 2 GUI accepts any font name, thus checking
3117 for a valid name does not work.
3119 getfperm({fname}) *getfperm()*
3120 The result is a String, which is the read, write, and execute
3121 permissions of the given file {fname}.
3122 If {fname} does not exist or its directory cannot be read, an
3123 empty string is returned.
3124 The result is of the form "rwxrwxrwx", where each group of
3125 "rwx" flags represent, in turn, the permissions of the owner
3126 of the file, the group the file belongs to, and other users.
3127 If a user does not have a given permission the flag for this
3128 is replaced with the string "-". Example: >
3129 :echo getfperm("/etc/passwd")
3130 < This will hopefully (from a security point of view) display
3131 the string "rw-r--r--" or even "rw-------".
3133 getftime({fname}) *getftime()*
3134 The result is a Number, which is the last modification time of
3135 the given file {fname}. The value is measured as seconds
3136 since 1st Jan 1970, and may be passed to strftime(). See also
3137 |localtime()| and |strftime()|.
3138 If the file {fname} can't be found -1 is returned.
3140 getftype({fname}) *getftype()*
3141 The result is a String, which is a description of the kind of
3142 file of the given file {fname}.
3143 If {fname} does not exist an empty string is returned.
3144 Here is a table over different kinds of files and their
3145 results:
3146 Normal file "file"
3147 Directory "dir"
3148 Symbolic link "link"
3149 Block device "bdev"
3150 Character device "cdev"
3151 Socket "socket"
3152 FIFO "fifo"
3153 All other "other"
3154 Example: >
3155 getftype("/home")
3156 < Note that a type such as "link" will only be returned on
3157 systems that support it. On some systems only "dir" and
3158 "file" are returned.
3160 *getline()*
3161 getline({lnum} [, {end}])
3162 Without {end} the result is a String, which is line {lnum}
3163 from the current buffer. Example: >
3164 getline(1)
3165 < When {lnum} is a String that doesn't start with a
3166 digit, line() is called to translate the String into a Number.
3167 To get the line under the cursor: >
3168 getline(".")
3169 < When {lnum} is smaller than 1 or bigger than the number of
3170 lines in the buffer, an empty string is returned.
3172 When {end} is given the result is a |List| where each item is
3173 a line from the current buffer in the range {lnum} to {end},
3174 including line {end}.
3175 {end} is used in the same way as {lnum}.
3176 Non-existing lines are silently omitted.
3177 When {end} is before {lnum} an empty |List| is returned.
3178 Example: >
3179 :let start = line('.')
3180 :let end = search("^$") - 1
3181 :let lines = getline(start, end)
3183 < To get lines from another buffer see |getbufline()|
3185 getloclist({nr}) *getloclist()*
3186 Returns a list with all the entries in the location list for
3187 window {nr}. When {nr} is zero the current window is used.
3188 For a location list window, the displayed location list is
3189 returned. For an invalid window number {nr}, an empty list is
3190 returned. Otherwise, same as |getqflist()|.
3192 getmatches() *getmatches()*
3193 Returns a |List| with all matches previously defined by
3194 |matchadd()| and the |:match| commands. |getmatches()| is
3195 useful in combination with |setmatches()|, as |setmatches()|
3196 can restore a list of matches saved by |getmatches()|.
3197 Example: >
3198 :echo getmatches()
3199 < [{'group': 'MyGroup1', 'pattern': 'TODO',
3200 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
3201 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
3202 :let m = getmatches()
3203 :call clearmatches()
3204 :echo getmatches()
3205 < [] >
3206 :call setmatches(m)
3207 :echo getmatches()
3208 < [{'group': 'MyGroup1', 'pattern': 'TODO',
3209 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
3210 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
3211 :unlet m
3212 <
3214 getqflist() *getqflist()*
3215 Returns a list with all the current quickfix errors. Each
3216 list item is a dictionary with these entries:
3217 bufnr number of buffer that has the file name, use
3218 bufname() to get the name
3219 lnum line number in the buffer (first line is 1)
3220 col column number (first column is 1)
3221 vcol non-zero: "col" is visual column
3222 zero: "col" is byte index
3223 nr error number
3224 pattern search pattern used to locate the error
3225 text description of the error
3226 type type of the error, 'E', '1', etc.
3227 valid non-zero: recognized error message
3229 When there is no error list or it's empty an empty list is
3230 returned. Quickfix list entries with non-existing buffer
3231 number are returned with "bufnr" set to zero.
3233 Useful application: Find pattern matches in multiple files and
3234 do something with them: >
3235 :vimgrep /theword/jg *.c
3236 :for d in getqflist()
3237 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
3238 :endfor
3241 getreg([{regname} [, 1]]) *getreg()*
3242 The result is a String, which is the contents of register
3243 {regname}. Example: >
3244 :let cliptext = getreg('*')
3245 < getreg('=') returns the last evaluated value of the expression
3246 register. (For use in maps.)
3247 getreg('=', 1) returns the expression itself, so that it can
3248 be restored with |setreg()|. For other registers the extra
3249 argument is ignored, thus you can always give it.
3250 If {regname} is not specified, |v:register| is used.
3253 getregtype([{regname}]) *getregtype()*
3254 The result is a String, which is type of register {regname}.
3255 The value will be one of:
3256 "v" for |characterwise| text
3257 "V" for |linewise| text
3258 "<CTRL-V>{width}" for |blockwise-visual| text
3259 0 for an empty or unknown register
3260 <CTRL-V> is one character with value 0x16.
3261 If {regname} is not specified, |v:register| is used.
3263 gettabwinvar({tabnr}, {winnr}, {varname}) *gettabwinvar()*
3264 Get the value of window-local variable {varname} in window
3265 {winnr} in tab page {tabnr}.
3266 When {varname} starts with "&" get the value of a window-local
3267 option.
3268 Tabs are numbered starting with one. For the current tabpage
3269 use |getwinvar()|.
3270 When {winnr} is zero the current window is used.
3271 This also works for a global option, buffer-local option and
3272 window-local option, but it doesn't work for a global variable
3273 or buffer-local variable.
3274 When {varname} is empty a dictionary with all window-local
3275 variables is returned.
3276 Note that {varname} must be the name without "w:".
3277 Examples: >
3278 :let list_is_on = gettabwinvar(1, 2, '&list')
3279 :echo "myvar = " . gettabwinvar(3, 1, 'myvar')
3280 <
3281 *getwinposx()*
3282 getwinposx() The result is a Number, which is the X coordinate in pixels of
3283 the left hand side of the GUI Vim window. The result will be
3284 -1 if the information is not available.
3286 *getwinposy()*
3287 getwinposy() The result is a Number, which is the Y coordinate in pixels of
3288 the top of the GUI Vim window. The result will be -1 if the
3289 information is not available.
3291 getwinvar({winnr}, {varname}) *getwinvar()*
3292 Like |gettabwinvar()| for the current tabpage.
3293 Examples: >
3294 :let list_is_on = getwinvar(2, '&list')
3295 :echo "myvar = " . getwinvar(1, 'myvar')
3296 <
3297 glob({expr} [, {flag}]) *glob()*
3298 Expand the file wildcards in {expr}. See |wildcards| for the
3299 use of special characters.
3300 The result is a String.
3301 When there are several matches, they are separated by <NL>
3302 characters.
3303 Unless the optional {flag} argument is given and is non-zero,
3304 the 'suffixes' and 'wildignore' options apply: Names matching
3305 one of the patterns in 'wildignore' will be skipped and
3306 'suffixes' affect the ordering of matches.
3307 If the expansion fails, the result is an empty string.
3308 A name for a non-existing file is not included.
3310 For most systems backticks can be used to get files names from
3311 any external command. Example: >
3312 :let tagfiles = glob("`find . -name tags -print`")
3313 :let &tags = substitute(tagfiles, "\n", ",", "g")
3314 < The result of the program inside the backticks should be one
3315 item per line. Spaces inside an item are allowed.
3317 See |expand()| for expanding special Vim variables. See
3318 |system()| for getting the raw output of an external command.
3320 globpath({path}, {expr} [, {flag}]) *globpath()*
3321 Perform glob() on all directories in {path} and concatenate
3322 the results. Example: >
3323 :echo globpath(&rtp, "syntax/c.vim")
3324 < {path} is a comma-separated list of directory names. Each
3325 directory name is prepended to {expr} and expanded like with
3326 |glob()|. A path separator is inserted when needed.
3327 To add a comma inside a directory name escape it with a
3328 backslash. Note that on MS-Windows a directory may have a
3329 trailing backslash, remove it if you put a comma after it.
3330 If the expansion fails for one of the directories, there is no
3331 error message.
3332 Unless the optional {flag} argument is given and is non-zero,
3333 the 'suffixes' and 'wildignore' options apply: Names matching
3334 one of the patterns in 'wildignore' will be skipped and
3335 'suffixes' affect the ordering of matches.
3337 The "**" item can be used to search in a directory tree.
3338 For example, to find all "README.txt" files in the directories
3339 in 'runtimepath' and below: >
3340 :echo globpath(&rtp, "**/README.txt")
3341 < Upwards search and limiting the depth of "**" is not
3342 supported, thus using 'path' will not always work properly.
3344 *has()*
3345 has({feature}) The result is a Number, which is 1 if the feature {feature} is
3346 supported, zero otherwise. The {feature} argument is a
3347 string. See |feature-list| below.
3348 Also see |exists()|.
3351 has_key({dict}, {key}) *has_key()*
3352 The result is a Number, which is 1 if |Dictionary| {dict} has
3353 an entry with key {key}. Zero otherwise.
3355 haslocaldir() *haslocaldir()*
3356 The result is a Number, which is 1 when the current
3357 window has set a local path via |:lcd|, and 0 otherwise.
3359 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
3360 The result is a Number, which is 1 if there is a mapping that
3361 contains {what} in somewhere in the rhs (what it is mapped to)
3362 and this mapping exists in one of the modes indicated by
3363 {mode}.
3364 When {abbr} is there and it is non-zero use abbreviations
3365 instead of mappings. Don't forget to specify Insert and/or
3366 Command-line mode.
3367 Both the global mappings and the mappings local to the current
3368 buffer are checked for a match.
3369 If no matching mapping is found 0 is returned.
3370 The following characters are recognized in {mode}:
3371 n Normal mode
3372 v Visual mode
3373 o Operator-pending mode
3374 i Insert mode
3375 l Language-Argument ("r", "f", "t", etc.)
3376 c Command-line mode
3377 When {mode} is omitted, "nvo" is used.
3379 This function is useful to check if a mapping already exists
3380 to a function in a Vim script. Example: >
3381 :if !hasmapto('\ABCdoit')
3382 : map <Leader>d \ABCdoit
3383 :endif
3384 < This installs the mapping to "\ABCdoit" only if there isn't
3385 already a mapping to "\ABCdoit".
3387 histadd({history}, {item}) *histadd()*
3388 Add the String {item} to the history {history} which can be
3389 one of: *hist-names*
3390 "cmd" or ":" command line history
3391 "search" or "/" search pattern history
3392 "expr" or "=" typed expression history
3393 "input" or "@" input line history
3394 If {item} does already exist in the history, it will be
3395 shifted to become the newest entry.
3396 The result is a Number: 1 if the operation was successful,
3397 otherwise 0 is returned.
3399 Example: >
3400 :call histadd("input", strftime("%Y %b %d"))
3401 :let date=input("Enter date: ")
3402 < This function is not available in the |sandbox|.
3404 histdel({history} [, {item}]) *histdel()*
3405 Clear {history}, i.e. delete all its entries. See |hist-names|
3406 for the possible values of {history}.
3408 If the parameter {item} evaluates to a String, it is used as a
3409 regular expression. All entries matching that expression will
3410 be removed from the history (if there are any).
3411 Upper/lowercase must match, unless "\c" is used |/\c|.
3412 If {item} evaluates to a Number, it will be interpreted as
3413 an index, see |:history-indexing|. The respective entry will
3414 be removed if it exists.
3416 The result is a Number: 1 for a successful operation,
3417 otherwise 0 is returned.
3419 Examples:
3420 Clear expression register history: >
3421 :call histdel("expr")
3422 <
3423 Remove all entries starting with "*" from the search history: >
3424 :call histdel("/", '^\*')
3425 <
3426 The following three are equivalent: >
3427 :call histdel("search", histnr("search"))
3428 :call histdel("search", -1)
3429 :call histdel("search", '^'.histget("search", -1).'$')
3430 <
3431 To delete the last search pattern and use the last-but-one for
3432 the "n" command and 'hlsearch': >
3433 :call histdel("search", -1)
3434 :let @/ = histget("search", -1)
3436 histget({history} [, {index}]) *histget()*
3437 The result is a String, the entry with Number {index} from
3438 {history}. See |hist-names| for the possible values of
3439 {history}, and |:history-indexing| for {index}. If there is
3440 no such entry, an empty String is returned. When {index} is
3441 omitted, the most recent item from the history is used.
3443 Examples:
3444 Redo the second last search from history. >
3445 :execute '/' . histget("search", -2)
3447 < Define an Ex command ":H {num}" that supports re-execution of
3448 the {num}th entry from the output of |:history|. >
3449 :command -nargs=1 H execute histget("cmd", 0+<args>)
3450 <
3451 histnr({history}) *histnr()*
3452 The result is the Number of the current entry in {history}.
3453 See |hist-names| for the possible values of {history}.
3454 If an error occurred, -1 is returned.
3456 Example: >
3457 :let inp_index = histnr("expr")
3458 <
3459 hlexists({name}) *hlexists()*
3460 The result is a Number, which is non-zero if a highlight group
3461 called {name} exists. This is when the group has been
3462 defined in some way. Not necessarily when highlighting has
3463 been defined for it, it may also have been used for a syntax
3464 item.
3465 *highlight_exists()*
3466 Obsolete name: highlight_exists().
3468 *hlID()*
3469 hlID({name}) The result is a Number, which is the ID of the highlight group
3470 with name {name}. When the highlight group doesn't exist,
3471 zero is returned.
3472 This can be used to retrieve information about the highlight
3473 group. For example, to get the background color of the
3474 "Comment" group: >
3475 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
3476 < *highlightID()*
3477 Obsolete name: highlightID().
3479 hostname() *hostname()*
3480 The result is a String, which is the name of the machine on
3481 which Vim is currently running. Machine names greater than
3482 256 characters long are truncated.
3484 iconv({expr}, {from}, {to}) *iconv()*
3485 The result is a String, which is the text {expr} converted
3486 from encoding {from} to encoding {to}.
3487 When the conversion fails an empty string is returned.
3488 The encoding names are whatever the iconv() library function
3489 can accept, see ":!man 3 iconv".
3490 Most conversions require Vim to be compiled with the |+iconv|
3491 feature. Otherwise only UTF-8 to latin1 conversion and back
3492 can be done.
3493 This can be used to display messages with special characters,
3494 no matter what 'encoding' is set to. Write the message in
3495 UTF-8 and use: >
3496 echo iconv(utf8_str, "utf-8", &enc)
3497 < Note that Vim uses UTF-8 for all Unicode encodings, conversion
3498 from/to UCS-2 is automatically changed to use UTF-8. You
3499 cannot use UCS-2 in a string anyway, because of the NUL bytes.
3500 {only available when compiled with the +multi_byte feature}
3502 *indent()*
3503 indent({lnum}) The result is a Number, which is indent of line {lnum} in the
3504 current buffer. The indent is counted in spaces, the value
3505 of 'tabstop' is relevant. {lnum} is used just like in
3506 |getline()|.
3507 When {lnum} is invalid -1 is returned.
3510 index({list}, {expr} [, {start} [, {ic}]]) *index()*
3511 Return the lowest index in |List| {list} where the item has a
3512 value equal to {expr}. There is no automatic conversion, so
3513 the String "4" is different from the Number 4. And the number
3514 4 is different from the Float 4.0. The value of 'ignorecase'
3515 is not used here, case always matters.
3516 If {start} is given then start looking at the item with index
3517 {start} (may be negative for an item relative to the end).
3518 When {ic} is given and it is non-zero, ignore case. Otherwise
3519 case must match.
3520 -1 is returned when {expr} is not found in {list}.
3521 Example: >
3522 :let idx = index(words, "the")
3523 :if index(numbers, 123) >= 0
3526 input({prompt} [, {text} [, {completion}]]) *input()*
3527 The result is a String, which is whatever the user typed on
3528 the command-line. The {prompt} argument is either a prompt
3529 string, or a blank string (for no prompt). A '\n' can be used
3530 in the prompt to start a new line.
3531 The highlighting set with |:echohl| is used for the prompt.
3532 The input is entered just like a command-line, with the same
3533 editing commands and mappings. There is a separate history
3534 for lines typed for input().
3535 Example: >
3536 :if input("Coffee or beer? ") == "beer"
3537 : echo "Cheers!"
3538 :endif
3539 <
3540 If the optional {text} argument is present and not empty, this
3541 is used for the default reply, as if the user typed this.
3542 Example: >
3543 :let color = input("Color? ", "white")
3545 < The optional {completion} argument specifies the type of
3546 completion supported for the input. Without it completion is
3547 not performed. The supported completion types are the same as
3548 that can be supplied to a user-defined command using the
3549 "-complete=" argument. Refer to |:command-completion| for
3550 more information. Example: >
3551 let fname = input("File: ", "", "file")
3552 <
3553 NOTE: This function must not be used in a startup file, for
3554 the versions that only run in GUI mode (e.g., the Win32 GUI).
3555 Note: When input() is called from within a mapping it will
3556 consume remaining characters from that mapping, because a
3557 mapping is handled like the characters were typed.
3558 Use |inputsave()| before input() and |inputrestore()|
3559 after input() to avoid that. Another solution is to avoid
3560 that further characters follow in the mapping, e.g., by using
3561 |:execute| or |:normal|.
3563 Example with a mapping: >
3564 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR>
3565 :function GetFoo()
3566 : call inputsave()
3567 : let g:Foo = input("enter search pattern: ")
3568 : call inputrestore()
3569 :endfunction
3571 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
3572 Like |input()|, but when the GUI is running and text dialogs
3573 are supported, a dialog window pops up to input the text.
3574 Example: >
3575 :let n = inputdialog("value for shiftwidth", &sw)
3576 :if n != ""
3577 : let &sw = n
3578 :endif
3579 < When the dialog is cancelled {cancelreturn} is returned. When
3580 omitted an empty string is returned.
3581 Hitting <Enter> works like pressing the OK button. Hitting
3582 <Esc> works like pressing the Cancel button.
3583 NOTE: Command-line completion is not supported.
3585 inputlist({textlist}) *inputlist()*
3586 {textlist} must be a |List| of strings. This |List| is
3587 displayed, one string per line. The user will be prompted to
3588 enter a number, which is returned.
3589 The user can also select an item by clicking on it with the
3590 mouse. For the first string 0 is returned. When clicking
3591 above the first item a negative number is returned. When
3592 clicking on the prompt one more than the length of {textlist}
3593 is returned.
3594 Make sure {textlist} has less than 'lines' entries, otherwise
3595 it won't work. It's a good idea to put the entry number at
3596 the start of the string. And put a prompt in the first item.
3597 Example: >
3598 let color = inputlist(['Select color:', '1. red',
3599 \ '2. green', '3. blue'])
3601 inputrestore() *inputrestore()*
3602 Restore typeahead that was saved with a previous |inputsave()|.
3603 Should be called the same number of times inputsave() is
3604 called. Calling it more often is harmless though.
3605 Returns 1 when there is nothing to restore, 0 otherwise.
3607 inputsave() *inputsave()*
3608 Preserve typeahead (also from mappings) and clear it, so that
3609 a following prompt gets input from the user. Should be
3610 followed by a matching inputrestore() after the prompt. Can
3611 be used several times, in which case there must be just as
3612 many inputrestore() calls.
3613 Returns 1 when out of memory, 0 otherwise.
3615 inputsecret({prompt} [, {text}]) *inputsecret()*
3616 This function acts much like the |input()| function with but
3617 two exceptions:
3618 a) the user's response will be displayed as a sequence of
3619 asterisks ("*") thereby keeping the entry secret, and
3620 b) the user's response will not be recorded on the input
3621 |history| stack.
3622 The result is a String, which is whatever the user actually
3623 typed on the command-line in response to the issued prompt.
3624 NOTE: Command-line completion is not supported.
3626 insert({list}, {item} [, {idx}]) *insert()*
3627 Insert {item} at the start of |List| {list}.
3628 If {idx} is specified insert {item} before the item with index
3629 {idx}. If {idx} is zero it goes before the first item, just
3630 like omitting {idx}. A negative {idx} is also possible, see
3631 |list-index|. -1 inserts just before the last item.
3632 Returns the resulting |List|. Examples: >
3633 :let mylist = insert([2, 3, 5], 1)
3634 :call insert(mylist, 4, -1)
3635 :call insert(mylist, 6, len(mylist))
3636 < The last example can be done simpler with |add()|.
3637 Note that when {item} is a |List| it is inserted as a single
3638 item. Use |extend()| to concatenate |Lists|.
3640 isdirectory({directory}) *isdirectory()*
3641 The result is a Number, which is non-zero when a directory
3642 with the name {directory} exists. If {directory} doesn't
3643 exist, or isn't a directory, the result is FALSE. {directory}
3644 is any expression, which is used as a String.
3646 islocked({expr}) *islocked()* *E786*
3647 The result is a Number, which is non-zero when {expr} is the
3648 name of a locked variable.
3649 {expr} must be the name of a variable, |List| item or
3650 |Dictionary| entry, not the variable itself! Example: >
3651 :let alist = [0, ['a', 'b'], 2, 3]
3652 :lockvar 1 alist
3653 :echo islocked('alist') " 1
3654 :echo islocked('alist[1]') " 0
3656 < When {expr} is a variable that does not exist you get an error
3657 message. Use |exists()| to check for existence.
3659 items({dict}) *items()*
3660 Return a |List| with all the key-value pairs of {dict}. Each
3661 |List| item is a list with two items: the key of a {dict}
3662 entry and the value of this entry. The |List| is in arbitrary
3663 order.
3666 join({list} [, {sep}]) *join()*
3667 Join the items in {list} together into one String.
3668 When {sep} is specified it is put in between the items. If
3669 {sep} is omitted a single space is used.
3670 Note that {sep} is not added at the end. You might want to
3671 add it there too: >
3672 let lines = join(mylist, "\n") . "\n"
3673 < String items are used as-is. |Lists| and |Dictionaries| are
3674 converted into a string like with |string()|.
3675 The opposite function is |split()|.
3677 keys({dict}) *keys()*
3678 Return a |List| with all the keys of {dict}. The |List| is in
3679 arbitrary order.
3681 *len()* *E701*
3682 len({expr}) The result is a Number, which is the length of the argument.
3683 When {expr} is a String or a Number the length in bytes is
3684 used, as with |strlen()|.
3685 When {expr} is a |List| the number of items in the |List| is
3686 returned.
3687 When {expr} is a |Dictionary| the number of entries in the
3688 |Dictionary| is returned.
3689 Otherwise an error is given.
3691 *libcall()* *E364* *E368*
3692 libcall({libname}, {funcname}, {argument})
3693 Call function {funcname} in the run-time library {libname}
3694 with single argument {argument}.
3695 This is useful to call functions in a library that you
3696 especially made to be used with Vim. Since only one argument
3697 is possible, calling standard library functions is rather
3698 limited.
3699 The result is the String returned by the function. If the
3700 function returns NULL, this will appear as an empty string ""
3701 to Vim.
3702 If the function returns a number, use libcallnr()!
3703 If {argument} is a number, it is passed to the function as an
3704 int; if {argument} is a string, it is passed as a
3705 null-terminated string.
3706 This function will fail in |restricted-mode|.
3708 libcall() allows you to write your own 'plug-in' extensions to
3709 Vim without having to recompile the program. It is NOT a
3710 means to call system functions! If you try to do so Vim will
3711 very probably crash.
3713 For Win32, the functions you write must be placed in a DLL
3714 and use the normal C calling convention (NOT Pascal which is
3715 used in Windows System DLLs). The function must take exactly
3716 one parameter, either a character pointer or a long integer,
3717 and must return a character pointer or NULL. The character
3718 pointer returned must point to memory that will remain valid
3719 after the function has returned (e.g. in static data in the
3720 DLL). If it points to allocated memory, that memory will
3721 leak away. Using a static buffer in the function should work,
3722 it's then freed when the DLL is unloaded.
3724 WARNING: If the function returns a non-valid pointer, Vim may
3725 crash! This also happens if the function returns a number,
3726 because Vim thinks it's a pointer.
3727 For Win32 systems, {libname} should be the filename of the DLL
3728 without the ".DLL" suffix. A full path is only required if
3729 the DLL is not in the usual places.
3730 For Unix: When compiling your own plugins, remember that the
3731 object code must be compiled as position-independent ('PIC').
3732 {only in Win32 on some Unix versions, when the |+libcall|
3733 feature is present}
3734 Examples: >
3735 :echo libcall("libc.so", "getenv", "HOME")
3736 <
3737 *libcallnr()*
3738 libcallnr({libname}, {funcname}, {argument})
3739 Just like |libcall()|, but used for a function that returns an
3740 int instead of a string.
3741 {only in Win32 on some Unix versions, when the |+libcall|
3742 feature is present}
3743 Examples: >
3744 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
3745 :call libcallnr("libc.so", "printf", "Hello World!\n")
3746 :call libcallnr("libc.so", "sleep", 10)
3747 <
3748 *line()*
3749 line({expr}) The result is a Number, which is the line number of the file
3750 position given with {expr}. The accepted positions are:
3751 . the cursor position
3752 $ the last line in the current buffer
3753 'x position of mark x (if the mark is not set, 0 is
3754 returned)
3755 w0 first line visible in current window
3756 w$ last line visible in current window
3757 v In Visual mode: the start of the Visual area (the
3758 cursor is the end). When not in Visual mode
3759 returns the cursor position. Differs from |'<| in
3760 that it's updated right away.
3761 Note that a mark in another file can be used. The line number
3762 then applies to another buffer.
3763 To get the column number use |col()|. To get both use
3764 |getpos()|.
3765 Examples: >
3766 line(".") line number of the cursor
3767 line("'t") line number of mark t
3768 line("'" . marker) line number of mark marker
3769 < *last-position-jump*
3770 This autocommand jumps to the last known position in a file
3771 just after opening it, if the '" mark is set: >
3772 :au BufReadPost * if line("'\"") > 1 && line("'\"") <= line("$") | exe "normal! g`\"" | endif
3774 line2byte({lnum}) *line2byte()*
3775 Return the byte count from the start of the buffer for line
3776 {lnum}. This includes the end-of-line character, depending on
3777 the 'fileformat' option for the current buffer. The first
3778 line returns 1.
3779 This can also be used to get the byte count for the line just
3780 below the last line: >
3781 line2byte(line("$") + 1)
3782 < This is the file size plus one.
3783 When {lnum} is invalid, or the |+byte_offset| feature has been
3784 disabled at compile time, -1 is returned.
3785 Also see |byte2line()|, |go| and |:goto|.
3787 lispindent({lnum}) *lispindent()*
3788 Get the amount of indent for line {lnum} according the lisp
3789 indenting rules, as with 'lisp'.
3790 The indent is counted in spaces, the value of 'tabstop' is
3791 relevant. {lnum} is used just like in |getline()|.
3792 When {lnum} is invalid or Vim was not compiled the
3793 |+lispindent| feature, -1 is returned.
3795 localtime() *localtime()*
3796 Return the current time, measured as seconds since 1st Jan
3797 1970. See also |strftime()| and |getftime()|.
3800 log10({expr}) *log10()*
3801 Return the logarithm of Float {expr} to base 10 as a |Float|.
3802 {expr} must evaluate to a |Float| or a |Number|.
3803 Examples: >
3804 :echo log10(1000)
3805 < 3.0 >
3806 :echo log10(0.01)
3807 < -2.0
3808 {only available when compiled with the |+float| feature}
3810 map({expr}, {string}) *map()*
3811 {expr} must be a |List| or a |Dictionary|.
3812 Replace each item in {expr} with the result of evaluating
3813 {string}.
3814 Inside {string} |v:val| has the value of the current item.
3815 For a |Dictionary| |v:key| has the key of the current item
3816 and for a |List| |v:key| has the index of the current item.
3817 Example: >
3818 :call map(mylist, '"> " . v:val . " <"')
3819 < This puts "> " before and " <" after each item in "mylist".
3821 Note that {string} is the result of an expression and is then
3822 used as an expression again. Often it is good to use a
3823 |literal-string| to avoid having to double backslashes. You
3824 still have to double ' quotes
3826 The operation is done in-place. If you want a |List| or
3827 |Dictionary| to remain unmodified make a copy first: >
3828 :let tlist = map(copy(mylist), ' & . "\t"')
3830 < Returns {expr}, the |List| or |Dictionary| that was filtered.
3831 When an error is encountered while evaluating {string} no
3832 further items in {expr} are processed.
3835 maparg({name}[, {mode} [, {abbr}]]) *maparg()*
3836 Return the rhs of mapping {name} in mode {mode}. When there
3837 is no mapping for {name}, an empty String is returned.
3838 {mode} can be one of these strings:
3839 "n" Normal
3840 "v" Visual
3841 "o" Operator-pending
3842 "i" Insert
3843 "c" Cmd-line
3844 "l" langmap |language-mapping|
3845 "" Normal, Visual and Operator-pending
3846 When {mode} is omitted, the modes for "" are used.
3847 When {abbr} is there and it is non-zero use abbreviations
3848 instead of mappings.
3849 The {name} can have special key names, like in the ":map"
3850 command. The returned String has special characters
3851 translated like in the output of the ":map" command listing.
3852 The mappings local to the current buffer are checked first,
3853 then the global mappings.
3854 This function can be used to map a key even when it's already
3855 mapped, and have it do the original mapping too. Sketch: >
3856 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n')
3859 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()*
3860 Check if there is a mapping that matches with {name} in mode
3861 {mode}. See |maparg()| for {mode} and special names in
3862 {name}.
3863 When {abbr} is there and it is non-zero use abbreviations
3864 instead of mappings.
3865 A match happens with a mapping that starts with {name} and
3866 with a mapping which is equal to the start of {name}.
3868 matches mapping "a" "ab" "abc" ~
3869 mapcheck("a") yes yes yes
3870 mapcheck("abc") yes yes yes
3871 mapcheck("ax") yes no no
3872 mapcheck("b") no no no
3874 The difference with maparg() is that mapcheck() finds a
3875 mapping that matches with {name}, while maparg() only finds a
3876 mapping for {name} exactly.
3877 When there is no mapping that starts with {name}, an empty
3878 String is returned. If there is one, the rhs of that mapping
3879 is returned. If there are several mappings that start with
3880 {name}, the rhs of one of them is returned.
3881 The mappings local to the current buffer are checked first,
3882 then the global mappings.
3883 This function can be used to check if a mapping can be added
3884 without being ambiguous. Example: >
3885 :if mapcheck("_vv") == ""
3886 : map _vv :set guifont=7x13<CR>
3887 :endif
3888 < This avoids adding the "_vv" mapping when there already is a
3889 mapping for "_v" or for "_vvv".
3891 match({expr}, {pat}[, {start}[, {count}]]) *match()*
3892 When {expr} is a |List| then this returns the index of the
3893 first item where {pat} matches. Each item is used as a
3894 String, |Lists| and |Dictionaries| are used as echoed.
3895 Otherwise, {expr} is used as a String. The result is a
3896 Number, which gives the index (byte offset) in {expr} where
3897 {pat} matches.
3898 A match at the first character or |List| item returns zero.
3899 If there is no match -1 is returned.
3900 Example: >
3901 :echo match("testing", "ing") " results in 4
3902 :echo match([1, 'x'], '\a') " results in 1
3903 < See |string-match| for how {pat} is used.
3904 *strpbrk()*
3905 Vim doesn't have a strpbrk() function. But you can do: >
3906 :let sepidx = match(line, '[.,;: \t]')
3907 < *strcasestr()*
3908 Vim doesn't have a strcasestr() function. But you can add
3909 "\c" to the pattern to ignore case: >
3910 :let idx = match(haystack, '\cneedle')
3911 <
3912 If {start} is given, the search starts from byte index
3913 {start} in a String or item {start} in a |List|.
3914 The result, however, is still the index counted from the
3915 first character/item. Example: >
3916 :echo match("testing", "ing", 2)
3917 < result is again "4". >
3918 :echo match("testing", "ing", 4)
3919 < result is again "4". >
3920 :echo match("testing", "t", 2)
3921 < result is "3".
3922 For a String, if {start} > 0 then it is like the string starts
3923 {start} bytes later, thus "^" will match at {start}. Except
3924 when {count} is given, then it's like matches before the
3925 {start} byte are ignored (this is a bit complicated to keep it
3926 backwards compatible).
3927 For a String, if {start} < 0, it will be set to 0. For a list
3928 the index is counted from the end.
3929 If {start} is out of range ({start} > strlen({expr}) for a
3930 String or {start} > len({expr}) for a |List|) -1 is returned.
3932 When {count} is given use the {count}'th match. When a match
3933 is found in a String the search for the next one starts one
3934 character further. Thus this example results in 1: >
3935 echo match("testing", "..", 0, 2)
3936 < In a |List| the search continues in the next item.
3937 Note that when {count} is added the way {start} works changes,
3938 see above.
3940 See |pattern| for the patterns that are accepted.
3941 The 'ignorecase' option is used to set the ignore-caseness of
3942 the pattern. 'smartcase' is NOT used. The matching is always
3943 done like 'magic' is set and 'cpoptions' is empty.
3945 *matchadd()* *E798* *E799* *E801*
3946 matchadd({group}, {pattern}[, {priority}[, {id}]])
3947 Defines a pattern to be highlighted in the current window (a
3948 "match"). It will be highlighted with {group}. Returns an
3949 identification number (ID), which can be used to delete the
3950 match using |matchdelete()|.
3952 The optional {priority} argument assigns a priority to the
3953 match. A match with a high priority will have its
3954 highlighting overrule that of a match with a lower priority.
3955 A priority is specified as an integer (negative numbers are no
3956 exception). If the {priority} argument is not specified, the
3957 default priority is 10. The priority of 'hlsearch' is zero,
3958 hence all matches with a priority greater than zero will
3959 overrule it. Syntax highlighting (see 'syntax') is a separate
3960 mechanism, and regardless of the chosen priority a match will
3961 always overrule syntax highlighting.
3963 The optional {id} argument allows the request for a specific
3964 match ID. If a specified ID is already taken, an error
3965 message will appear and the match will not be added. An ID
3966 is specified as a positive integer (zero excluded). IDs 1, 2
3967 and 3 are reserved for |:match|, |:2match| and |:3match|,
3968 respectively. If the {id} argument is not specified,
3969 |matchadd()| automatically chooses a free ID.
3971 The number of matches is not limited, as it is the case with
3972 the |:match| commands.
3974 Example: >
3975 :highlight MyGroup ctermbg=green guibg=green
3976 :let m = matchadd("MyGroup", "TODO")
3977 < Deletion of the pattern: >
3978 :call matchdelete(m)
3980 < A list of matches defined by |matchadd()| and |:match| are
3981 available from |getmatches()|. All matches can be deleted in
3982 one operation by |clearmatches()|.
3984 matcharg({nr}) *matcharg()*
3985 Selects the {nr} match item, as set with a |:match|,
3986 |:2match| or |:3match| command.
3987 Return a |List| with two elements:
3988 The name of the highlight group used
3989 The pattern used.
3990 When {nr} is not 1, 2 or 3 returns an empty |List|.
3991 When there is no match item set returns ['', ''].
3992 This is useful to save and restore a |:match|.
3993 Highlighting matches using the |:match| commands are limited
3994 to three matches. |matchadd()| does not have this limitation.
3996 matchdelete({id}) *matchdelete()* *E802* *E803*
3997 Deletes a match with ID {id} previously defined by |matchadd()|
3998 or one of the |:match| commands. Returns 0 if successful,
3999 otherwise -1. See example for |matchadd()|. All matches can
4000 be deleted in one operation by |clearmatches()|.
4002 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()*
4003 Same as |match()|, but return the index of first character
4004 after the match. Example: >
4005 :echo matchend("testing", "ing")
4006 < results in "7".
4007 *strspn()* *strcspn()*
4008 Vim doesn't have a strspn() or strcspn() function, but you can
4009 do it with matchend(): >
4010 :let span = matchend(line, '[a-zA-Z]')
4011 :let span = matchend(line, '[^a-zA-Z]')
4012 < Except that -1 is returned when there are no matches.
4014 The {start}, if given, has the same meaning as for |match()|. >
4015 :echo matchend("testing", "ing", 2)
4016 < results in "7". >
4017 :echo matchend("testing", "ing", 5)
4018 < result is "-1".
4019 When {expr} is a |List| the result is equal to |match()|.
4021 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()*
4022 Same as |match()|, but return a |List|. The first item in the
4023 list is the matched string, same as what matchstr() would
4024 return. Following items are submatches, like "\1", "\2", etc.
4025 in |:substitute|. When an optional submatch didn't match an
4026 empty string is used. Example: >
4027 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
4028 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
4029 When there is no match an empty list is returned.
4031 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()*
4032 Same as |match()|, but return the matched string. Example: >
4033 :echo matchstr("testing", "ing")
4034 < results in "ing".
4035 When there is no match "" is returned.
4036 The {start}, if given, has the same meaning as for |match()|. >
4037 :echo matchstr("testing", "ing", 2)
4038 < results in "ing". >
4039 :echo matchstr("testing", "ing", 5)
4040 < result is "".
4041 When {expr} is a |List| then the matching item is returned.
4042 The type isn't changed, it's not necessarily a String.
4044 *max()*
4045 max({list}) Return the maximum value of all items in {list}.
4046 If {list} is not a list or one of the items in {list} cannot
4047 be used as a Number this results in an error.
4048 An empty |List| results in zero.
4050 *min()*
4051 min({list}) Return the minimum value of all items in {list}.
4052 If {list} is not a list or one of the items in {list} cannot
4053 be used as a Number this results in an error.
4054 An empty |List| results in zero.
4056 *mkdir()* *E739*
4057 mkdir({name} [, {path} [, {prot}]])
4058 Create directory {name}.
4059 If {path} is "p" then intermediate directories are created as
4060 necessary. Otherwise it must be "".
4061 If {prot} is given it is used to set the protection bits of
4062 the new directory. The default is 0755 (rwxr-xr-x: r/w for
4063 the user readable for others). Use 0700 to make it unreadable
4064 for others. This is only used for the last part of {name}.
4065 Thus if you create /tmp/foo/bar then /tmp/foo will be created
4066 with 0755.
4067 Example: >
4068 :call mkdir($HOME . "/tmp/foo/bar", "p", 0700)
4069 < This function is not available in the |sandbox|.
4070 Not available on all systems. To check use: >
4071 :if exists("*mkdir")
4072 <
4073 *mode()*
4074 mode([expr]) Return a string that indicates the current mode.
4075 If [expr] is supplied and it evaluates to a non-zero Number or
4076 a non-empty String (|non-zero-arg|), then the full mode is
4077 returned, otherwise only the first letter is returned. Note
4078 that " " and "0" are also non-empty strings.
4080 n Normal
4081 no Operator-pending
4082 v Visual by character
4083 V Visual by line
4084 CTRL-V Visual blockwise
4085 s Select by character
4086 S Select by line
4087 CTRL-S Select blockwise
4088 i Insert
4089 R Replace |R|
4090 Rv Virtual Replace |gR|
4091 c Command-line
4092 cv Vim Ex mode |gQ|
4093 ce Normal Ex mode |Q|
4094 r Hit-enter prompt
4095 rm The -- more -- prompt
4096 r? A |:confirm| query of some sort
4097 ! Shell or external command is executing
4098 This is useful in the 'statusline' option or when used
4099 with |remote_expr()| In most other places it always returns
4100 "c" or "n".
4101 Also see |visualmode()|.
4103 nextnonblank({lnum}) *nextnonblank()*
4104 Return the line number of the first line at or below {lnum}
4105 that is not blank. Example: >
4106 if getline(nextnonblank(1)) =~ "Java"
4107 < When {lnum} is invalid or there is no non-blank line at or
4108 below it, zero is returned.
4109 See also |prevnonblank()|.
4111 nr2char({expr}) *nr2char()*
4112 Return a string with a single character, which has the number
4113 value {expr}. Examples: >
4114 nr2char(64) returns "@"
4115 nr2char(32) returns " "
4116 < The current 'encoding' is used. Example for "utf-8": >
4117 nr2char(300) returns I with bow character
4118 < Note that a NUL character in the file is specified with
4119 nr2char(10), because NULs are represented with newline
4120 characters. nr2char(0) is a real NUL and terminates the
4121 string, thus results in an empty string.
4123 *getpid()*
4124 getpid() Return a Number which is the process ID of the Vim process.
4125 On Unix and MS-Windows this is a unique number, until Vim
4126 exits. On MS-DOS it's always zero.
4128 *getpos()*
4129 getpos({expr}) Get the position for {expr}. For possible values of {expr}
4130 see |line()|.
4131 The result is a |List| with four numbers:
4132 [bufnum, lnum, col, off]
4133 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
4134 is the buffer number of the mark.
4135 "lnum" and "col" are the position in the buffer. The first
4136 column is 1.
4137 The "off" number is zero, unless 'virtualedit' is used. Then
4138 it is the offset in screen columns from the start of the
4139 character. E.g., a position within a <Tab> or after the last
4140 character.
4141 This can be used to save and restore the cursor position: >
4142 let save_cursor = getpos(".")
4143 MoveTheCursorAround
4144 call setpos('.', save_cursor)
4145 < Also see |setpos()|.
4147 pathshorten({expr}) *pathshorten()*
4148 Shorten directory names in the path {expr} and return the
4149 result. The tail, the file name, is kept as-is. The other
4150 components in the path are reduced to single letters. Leading
4151 '~' and '.' characters are kept. Example: >
4152 :echo pathshorten('~/.vim/autoload/myfile.vim')
4153 < ~/.v/a/myfile.vim ~
4154 It doesn't matter if the path exists or not.
4156 pow({x}, {y}) *pow()*
4157 Return the power of {x} to the exponent {y} as a |Float|.
4158 {x} and {y} must evaluate to a |Float| or a |Number|.
4159 Examples: >
4160 :echo pow(3, 3)
4161 < 27.0 >
4162 :echo pow(2, 16)
4163 < 65536.0 >
4164 :echo pow(32, 0.20)
4165 < 2.0
4166 {only available when compiled with the |+float| feature}
4168 prevnonblank({lnum}) *prevnonblank()*
4169 Return the line number of the first line at or above {lnum}
4170 that is not blank. Example: >
4171 let ind = indent(prevnonblank(v:lnum - 1))
4172 < When {lnum} is invalid or there is no non-blank line at or
4173 above it, zero is returned.
4174 Also see |nextnonblank()|.
4177 printf({fmt}, {expr1} ...) *printf()*
4178 Return a String with {fmt}, where "%" items are replaced by
4179 the formatted form of their respective arguments. Example: >
4180 printf("%4d: E%d %.30s", lnum, errno, msg)
4181 < May result in:
4182 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
4184 Often used items are:
4185 %s string
4186 %6s string right-aligned in 6 bytes
4187 %.9s string truncated to 9 bytes
4188 %c single byte
4189 %d decimal number
4190 %5d decimal number padded with spaces to 5 characters
4191 %x hex number
4192 %04x hex number padded with zeros to at least 4 characters
4193 %X hex number using upper case letters
4194 %o octal number
4195 %f floating point number in the form 123.456
4196 %e floating point number in the form 1.234e3
4197 %E floating point number in the form 1.234E3
4198 %g floating point number, as %f or %e depending on value
4199 %G floating point number, as %f or %E depending on value
4200 %% the % character itself
4202 Conversion specifications start with '%' and end with the
4203 conversion type. All other characters are copied unchanged to
4204 the result.
4206 The "%" starts a conversion specification. The following
4207 arguments appear in sequence:
4209 % [flags] [field-width] [.precision] type
4211 flags
4212 Zero or more of the following flags:
4214 # The value should be converted to an "alternate
4215 form". For c, d, and s conversions, this option
4216 has no effect. For o conversions, the precision
4217 of the number is increased to force the first
4218 character of the output string to a zero (except
4219 if a zero value is printed with an explicit
4220 precision of zero).
4221 For x and X conversions, a non-zero result has
4222 the string "0x" (or "0X" for X conversions)
4223 prepended to it.
4225 0 (zero) Zero padding. For all conversions the converted
4226 value is padded on the left with zeros rather
4227 than blanks. If a precision is given with a
4228 numeric conversion (d, o, x, and X), the 0 flag
4229 is ignored.
4231 - A negative field width flag; the converted value
4232 is to be left adjusted on the field boundary.
4233 The converted value is padded on the right with
4234 blanks, rather than on the left with blanks or
4235 zeros. A - overrides a 0 if both are given.
4237 ' ' (space) A blank should be left before a positive
4238 number produced by a signed conversion (d).
4240 + A sign must always be placed before a number
4241 produced by a signed conversion. A + overrides
4242 a space if both are used.
4244 field-width
4245 An optional decimal digit string specifying a minimum
4246 field width. If the converted value has fewer bytes
4247 than the field width, it will be padded with spaces on
4248 the left (or right, if the left-adjustment flag has
4249 been given) to fill out the field width.
4251 .precision
4252 An optional precision, in the form of a period '.'
4253 followed by an optional digit string. If the digit
4254 string is omitted, the precision is taken as zero.
4255 This gives the minimum number of digits to appear for
4256 d, o, x, and X conversions, or the maximum number of
4257 bytes to be printed from a string for s conversions.
4258 For floating point it is the number of digits after
4259 the decimal point.
4261 type
4262 A character that specifies the type of conversion to
4263 be applied, see below.
4265 A field width or precision, or both, may be indicated by an
4266 asterisk '*' instead of a digit string. In this case, a
4267 Number argument supplies the field width or precision. A
4268 negative field width is treated as a left adjustment flag
4269 followed by a positive field width; a negative precision is
4270 treated as though it were missing. Example: >
4271 :echo printf("%d: %.*s", nr, width, line)
4272 < This limits the length of the text used from "line" to
4273 "width" bytes.
4275 The conversion specifiers and their meanings are:
4277 *printf-d* *printf-o* *printf-x* *printf-X*
4278 doxX The Number argument is converted to signed decimal
4279 (d), unsigned octal (o), or unsigned hexadecimal (x
4280 and X) notation. The letters "abcdef" are used for
4281 x conversions; the letters "ABCDEF" are used for X
4282 conversions.
4283 The precision, if any, gives the minimum number of
4284 digits that must appear; if the converted value
4285 requires fewer digits, it is padded on the left with
4286 zeros.
4287 In no case does a non-existent or small field width
4288 cause truncation of a numeric field; if the result of
4289 a conversion is wider than the field width, the field
4290 is expanded to contain the conversion result.
4292 *printf-c*
4293 c The Number argument is converted to a byte, and the
4294 resulting character is written.
4296 *printf-s*
4297 s The text of the String argument is used. If a
4298 precision is specified, no more bytes than the number
4299 specified are used.
4301 *printf-f* *E807*
4302 f The Float argument is converted into a string of the
4303 form 123.456. The precision specifies the number of
4304 digits after the decimal point. When the precision is
4305 zero the decimal point is omitted. When the precision
4306 is not specified 6 is used. A really big number
4307 (out of range or dividing by zero) results in "inf".
4308 "0.0 / 0.0" results in "nan".
4309 Example: >
4310 echo printf("%.2f", 12.115)
4311 < 12.12
4312 Note that roundoff depends on the system libraries.
4313 Use |round()| when in doubt.
4315 *printf-e* *printf-E*
4316 e E The Float argument is converted into a string of the
4317 form 1.234e+03 or 1.234E+03 when using 'E'. The
4318 precision specifies the number of digits after the
4319 decimal point, like with 'f'.
4321 *printf-g* *printf-G*
4322 g G The Float argument is converted like with 'f' if the
4323 value is between 0.001 (inclusive) and 10000000.0
4324 (exclusive). Otherwise 'e' is used for 'g' and 'E'
4325 for 'G'. When no precision is specified superfluous
4326 zeroes and '+' signs are removed, except for the zero
4327 immediately after the decimal point. Thus 10000000.0
4328 results in 1.0e7.
4330 *printf-%*
4331 % A '%' is written. No argument is converted. The
4332 complete conversion specification is "%%".
4334 When a Number argument is expected a String argument is also
4335 accepted and automatically converted.
4336 When a Float or String argument is expected a Number argument
4337 is also accepted and automatically converted.
4338 Any other argument type results in an error message.
4340 *E766* *E767*
4341 The number of {exprN} arguments must exactly match the number
4342 of "%" items. If there are not sufficient or too many
4343 arguments an error is given. Up to 18 arguments can be used.
4346 pumvisible() *pumvisible()*
4347 Returns non-zero when the popup menu is visible, zero
4348 otherwise. See |ins-completion-menu|.
4349 This can be used to avoid some things that would remove the
4350 popup menu.
4352 *E726* *E727*
4353 range({expr} [, {max} [, {stride}]]) *range()*
4354 Returns a |List| with Numbers:
4355 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
4356 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
4357 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
4358 {max}] (increasing {expr} with {stride} each time, not
4359 producing a value past {max}).
4360 When the maximum is one before the start the result is an
4361 empty list. When the maximum is more than one before the
4362 start this is an error.
4363 Examples: >
4364 range(4) " [0, 1, 2, 3]
4365 range(2, 4) " [2, 3, 4]
4366 range(2, 9, 3) " [2, 5, 8]
4367 range(2, -2, -1) " [2, 1, 0, -1, -2]
4368 range(0) " []
4369 range(2, 0) " error!
4370 <
4371 *readfile()*
4372 readfile({fname} [, {binary} [, {max}]])
4373 Read file {fname} and return a |List|, each line of the file
4374 as an item. Lines broken at NL characters. Macintosh files
4375 separated with CR will result in a single long line (unless a
4376 NL appears somewhere).
4377 When {binary} is equal to "b" binary mode is used:
4378 - When the last line ends in a NL an extra empty list item is
4379 added.
4380 - No CR characters are removed.
4381 Otherwise:
4382 - CR characters that appear before a NL are removed.
4383 - Whether the last line ends in a NL or not does not matter.
4384 All NUL characters are replaced with a NL character.
4385 When {max} is given this specifies the maximum number of lines
4386 to be read. Useful if you only want to check the first ten
4387 lines of a file: >
4388 :for line in readfile(fname, '', 10)
4389 : if line =~ 'Date' | echo line | endif
4390 :endfor
4391 < When {max} is negative -{max} lines from the end of the file
4392 are returned, or as many as there are.
4393 When {max} is zero the result is an empty list.
4394 Note that without {max} the whole file is read into memory.
4395 Also note that there is no recognition of encoding. Read a
4396 file into a buffer if you need to.
4397 When the file can't be opened an error message is given and
4398 the result is an empty list.
4399 Also see |writefile()|.
4401 reltime([{start} [, {end}]]) *reltime()*
4402 Return an item that represents a time value. The format of
4403 the item depends on the system. It can be passed to
4404 |reltimestr()| to convert it to a string.
4405 Without an argument it returns the current time.
4406 With one argument is returns the time passed since the time
4407 specified in the argument.
4408 With two arguments it returns the time passed between {start}
4409 and {end}.
4410 The {start} and {end} arguments must be values returned by
4411 reltime().
4412 {only available when compiled with the +reltime feature}
4414 reltimestr({time}) *reltimestr()*
4415 Return a String that represents the time value of {time}.
4416 This is the number of seconds, a dot and the number of
4417 microseconds. Example: >
4418 let start = reltime()
4419 call MyFunction()
4420 echo reltimestr(reltime(start))
4421 < Note that overhead for the commands will be added to the time.
4422 The accuracy depends on the system.
4423 Leading spaces are used to make the string align nicely. You
4424 can use split() to remove it. >
4425 echo split(reltimestr(reltime(start)))[0]
4426 < Also see |profiling|.
4427 {only available when compiled with the +reltime feature}
4429 *remote_expr()* *E449*
4430 remote_expr({server}, {string} [, {idvar}])
4431 Send the {string} to {server}. The string is sent as an
4432 expression and the result is returned after evaluation.
4433 The result must be a String or a |List|. A |List| is turned
4434 into a String by joining the items with a line break in
4435 between (not at the end), like with join(expr, "\n").
4436 If {idvar} is present, it is taken as the name of a
4437 variable and a {serverid} for later use with
4438 remote_read() is stored there.
4439 See also |clientserver| |RemoteReply|.
4440 This function is not available in the |sandbox|.
4441 {only available when compiled with the |+clientserver| feature}
4442 Note: Any errors will cause a local error message to be issued
4443 and the result will be the empty string.
4444 Examples: >
4445 :echo remote_expr("gvim", "2+2")
4446 :echo remote_expr("gvim1", "b:current_syntax")
4447 <
4449 remote_foreground({server}) *remote_foreground()*
4450 Move the Vim server with the name {server} to the foreground.
4451 This works like: >
4452 remote_expr({server}, "foreground()")
4453 < Except that on Win32 systems the client does the work, to work
4454 around the problem that the OS doesn't always allow the server
4455 to bring itself to the foreground.
4456 Note: This does not restore the window if it was minimized,
4457 like foreground() does.
4458 This function is not available in the |sandbox|.
4459 {only in the Win32, Athena, Motif and GTK GUI versions and the
4460 Win32 console version}
4463 remote_peek({serverid} [, {retvar}]) *remote_peek()*
4464 Returns a positive number if there are available strings
4465 from {serverid}. Copies any reply string into the variable
4466 {retvar} if specified. {retvar} must be a string with the
4467 name of a variable.
4468 Returns zero if none are available.
4469 Returns -1 if something is wrong.
4470 See also |clientserver|.
4471 This function is not available in the |sandbox|.
4472 {only available when compiled with the |+clientserver| feature}
4473 Examples: >
4474 :let repl = ""
4475 :echo "PEEK: ".remote_peek(id, "repl").": ".repl
4477 remote_read({serverid}) *remote_read()*
4478 Return the oldest available reply from {serverid} and consume
4479 it. It blocks until a reply is available.
4480 See also |clientserver|.
4481 This function is not available in the |sandbox|.
4482 {only available when compiled with the |+clientserver| feature}
4483 Example: >
4484 :echo remote_read(id)
4485 <
4486 *remote_send()* *E241*
4487 remote_send({server}, {string} [, {idvar}])
4488 Send the {string} to {server}. The string is sent as input
4489 keys and the function returns immediately. At the Vim server
4490 the keys are not mapped |:map|.
4491 If {idvar} is present, it is taken as the name of a variable
4492 and a {serverid} for later use with remote_read() is stored
4493 there.
4494 See also |clientserver| |RemoteReply|.
4495 This function is not available in the |sandbox|.
4496 {only available when compiled with the |+clientserver| feature}
4497 Note: Any errors will be reported in the server and may mess
4498 up the display.
4499 Examples: >
4500 :echo remote_send("gvim", ":DropAndReply ".file, "serverid").
4501 \ remote_read(serverid)
4503 :autocmd NONE RemoteReply *
4504 \ echo remote_read(expand("<amatch>"))
4505 :echo remote_send("gvim", ":sleep 10 | echo ".
4506 \ 'server2client(expand("<client>"), "HELLO")<CR>')
4507 <
4508 remove({list}, {idx} [, {end}]) *remove()*
4509 Without {end}: Remove the item at {idx} from |List| {list} and
4510 return the item.
4511 With {end}: Remove items from {idx} to {end} (inclusive) and
4512 return a List with these items. When {idx} points to the same
4513 item as {end} a list with one item is returned. When {end}
4514 points to an item before {idx} this is an error.
4515 See |list-index| for possible values of {idx} and {end}.
4516 Example: >
4517 :echo "last item: " . remove(mylist, -1)
4518 :call remove(mylist, 0, 9)
4519 remove({dict}, {key})
4520 Remove the entry from {dict} with key {key}. Example: >
4521 :echo "removed " . remove(dict, "one")
4522 < If there is no {key} in {dict} this is an error.
4524 Use |delete()| to remove a file.
4526 rename({from}, {to}) *rename()*
4527 Rename the file by the name {from} to the name {to}. This
4528 should also work to move files across file systems. The
4529 result is a Number, which is 0 if the file was renamed
4530 successfully, and non-zero when the renaming failed.
4531 NOTE: If {to} exists it is overwritten without warning.
4532 This function is not available in the |sandbox|.
4534 repeat({expr}, {count}) *repeat()*
4535 Repeat {expr} {count} times and return the concatenated
4536 result. Example: >
4537 :let separator = repeat('-', 80)
4538 < When {count} is zero or negative the result is empty.
4539 When {expr} is a |List| the result is {expr} concatenated
4540 {count} times. Example: >
4541 :let longlist = repeat(['a', 'b'], 3)
4542 < Results in ['a', 'b', 'a', 'b', 'a', 'b'].
4545 resolve({filename}) *resolve()* *E655*
4546 On MS-Windows, when {filename} is a shortcut (a .lnk file),
4547 returns the path the shortcut points to in a simplified form.
4548 On Unix, repeat resolving symbolic links in all path
4549 components of {filename} and return the simplified result.
4550 To cope with link cycles, resolving of symbolic links is
4551 stopped after 100 iterations.
4552 On other systems, return the simplified {filename}.
4553 The simplification step is done as by |simplify()|.
4554 resolve() keeps a leading path component specifying the
4555 current directory (provided the result is still a relative
4556 path name) and also keeps a trailing path separator.
4558 *reverse()*
4559 reverse({list}) Reverse the order of items in {list} in-place. Returns
4560 {list}.
4561 If you want a list to remain unmodified make a copy first: >
4562 :let revlist = reverse(copy(mylist))
4564 round({expr}) *round()*
4565 Round off {expr} to the nearest integral value and return it
4566 as a |Float|. If {expr} lies halfway between two integral
4567 values, then use the larger one (away from zero).
4568 {expr} must evaluate to a |Float| or a |Number|.
4569 Examples: >
4570 echo round(0.456)
4571 < 0.0 >
4572 echo round(4.5)
4573 < 5.0 >
4574 echo round(-4.5)
4575 < -5.0
4576 {only available when compiled with the |+float| feature}
4579 search({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *search()*
4580 Search for regexp pattern {pattern}. The search starts at the
4581 cursor position (you can use |cursor()| to set it).
4583 {flags} is a String, which can contain these character flags:
4584 'b' search backward instead of forward
4585 'c' accept a match at the cursor position
4586 'e' move to the End of the match
4587 'n' do Not move the cursor
4588 'p' return number of matching sub-pattern (see below)
4589 's' set the ' mark at the previous location of the cursor
4590 'w' wrap around the end of the file
4591 'W' don't wrap around the end of the file
4592 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
4594 If the 's' flag is supplied, the ' mark is set, only if the
4595 cursor is moved. The 's' flag cannot be combined with the 'n'
4596 flag.
4598 'ignorecase', 'smartcase' and 'magic' are used.
4600 When the {stopline} argument is given then the search stops
4601 after searching this line. This is useful to restrict the
4602 search to a range of lines. Examples: >
4603 let match = search('(', 'b', line("w0"))
4604 let end = search('END', '', line("w$"))
4605 < When {stopline} is used and it is not zero this also implies
4606 that the search does not wrap around the end of the file.
4607 A zero value is equal to not giving the argument.
4609 When the {timeout} argument is given the search stops when
4610 more than this many milli seconds have passed. Thus when
4611 {timeout} is 500 the search stops after half a second.
4612 The value must not be negative. A zero value is like not
4613 giving the argument.
4614 {only available when compiled with the +reltime feature}
4616 If there is no match a 0 is returned and the cursor doesn't
4617 move. No error message is given.
4618 When a match has been found its line number is returned.
4619 *search()-sub-match*
4620 With the 'p' flag the returned value is one more than the
4621 first sub-match in \(\). One if none of them matched but the
4622 whole pattern did match.
4623 To get the column number too use |searchpos()|.
4625 The cursor will be positioned at the match, unless the 'n'
4626 flag is used.
4628 Example (goes over all files in the argument list): >
4629 :let n = 1
4630 :while n <= argc() " loop over all files in arglist
4631 : exe "argument " . n
4632 : " start at the last char in the file and wrap for the
4633 : " first search to find match at start of file
4634 : normal G$
4635 : let flags = "w"
4636 : while search("foo", flags) > 0
4637 : s/foo/bar/g
4638 : let flags = "W"
4639 : endwhile
4640 : update " write the file if modified
4641 : let n = n + 1
4642 :endwhile
4643 <
4644 Example for using some flags: >
4645 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
4646 < This will search for the keywords "if", "else", and "endif"
4647 under or after the cursor. Because of the 'p' flag, it
4648 returns 1, 2, or 3 depending on which keyword is found, or 0
4649 if the search fails. With the cursor on the first word of the
4650 line:
4651 if (foo == 0) | let foo = foo + 1 | endif ~
4652 the function returns 1. Without the 'c' flag, the function
4653 finds the "endif" and returns 3. The same thing happens
4654 without the 'e' flag if the cursor is on the "f" of "if".
4655 The 'n' flag tells the function not to move the cursor.
4658 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
4659 Search for the declaration of {name}.
4661 With a non-zero {global} argument it works like |gD|, find
4662 first match in the file. Otherwise it works like |gd|, find
4663 first match in the function.
4665 With a non-zero {thisblock} argument matches in a {} block
4666 that ends before the cursor position are ignored. Avoids
4667 finding variable declarations only valid in another scope.
4669 Moves the cursor to the found match.
4670 Returns zero for success, non-zero for failure.
4671 Example: >
4672 if searchdecl('myvar') == 0
4673 echo getline('.')
4674 endif
4675 <
4676 *searchpair()*
4677 searchpair({start}, {middle}, {end} [, {flags} [, {skip}
4678 [, {stopline} [, {timeout}]]]])
4679 Search for the match of a nested start-end pair. This can be
4680 used to find the "endif" that matches an "if", while other
4681 if/endif pairs in between are ignored.
4682 The search starts at the cursor. The default is to search
4683 forward, include 'b' in {flags} to search backward.
4684 If a match is found, the cursor is positioned at it and the
4685 line number is returned. If no match is found 0 or -1 is
4686 returned and the cursor doesn't move. No error message is
4687 given.
4689 {start}, {middle} and {end} are patterns, see |pattern|. They
4690 must not contain \( \) pairs. Use of \%( \) is allowed. When
4691 {middle} is not empty, it is found when searching from either
4692 direction, but only when not in a nested start-end pair. A
4693 typical use is: >
4694 searchpair('\<if\>', '\<else\>', '\<endif\>')
4695 < By leaving {middle} empty the "else" is skipped.
4697 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
4698 |search()|. Additionally:
4699 'r' Repeat until no more matches found; will find the
4700 outer pair. Implies the 'W' flag.
4701 'm' Return number of matches instead of line number with
4702 the match; will be > 1 when 'r' is used.
4703 Note: it's nearly always a good idea to use the 'W' flag, to
4704 avoid wrapping around the end of the file.
4706 When a match for {start}, {middle} or {end} is found, the
4707 {skip} expression is evaluated with the cursor positioned on
4708 the start of the match. It should return non-zero if this
4709 match is to be skipped. E.g., because it is inside a comment
4710 or a string.
4711 When {skip} is omitted or empty, every match is accepted.
4712 When evaluating {skip} causes an error the search is aborted
4713 and -1 returned.
4715 For {stopline} and {timeout} see |search()|.
4717 The value of 'ignorecase' is used. 'magic' is ignored, the
4718 patterns are used like it's on.
4720 The search starts exactly at the cursor. A match with
4721 {start}, {middle} or {end} at the next character, in the
4722 direction of searching, is the first one found. Example: >
4723 if 1
4724 if 2
4725 endif 2
4726 endif 1
4727 < When starting at the "if 2", with the cursor on the "i", and
4728 searching forwards, the "endif 2" is found. When starting on
4729 the character just before the "if 2", the "endif 1" will be
4730 found. That's because the "if 2" will be found first, and
4731 then this is considered to be a nested if/endif from "if 2" to
4732 "endif 2".
4733 When searching backwards and {end} is more than one character,
4734 it may be useful to put "\zs" at the end of the pattern, so
4735 that when the cursor is inside a match with the end it finds
4736 the matching start.
4738 Example, to find the "endif" command in a Vim script: >
4740 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
4741 \ 'getline(".") =~ "^\\s*\""')
4743 < The cursor must be at or after the "if" for which a match is
4744 to be found. Note that single-quote strings are used to avoid
4745 having to double the backslashes. The skip expression only
4746 catches comments at the start of a line, not after a command.
4747 Also, a word "en" or "if" halfway a line is considered a
4748 match.
4749 Another example, to search for the matching "{" of a "}": >
4751 :echo searchpair('{', '', '}', 'bW')
4753 < This works when the cursor is at or before the "}" for which a
4754 match is to be found. To reject matches that syntax
4755 highlighting recognized as strings: >
4757 :echo searchpair('{', '', '}', 'bW',
4758 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
4759 <
4760 *searchpairpos()*
4761 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip}
4762 [, {stopline} [, {timeout}]]]])
4763 Same as |searchpair()|, but returns a |List| with the line and
4764 column position of the match. The first element of the |List|
4765 is the line number and the second element is the byte index of
4766 the column position of the match. If no match is found,
4767 returns [0, 0].
4768 >
4769 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
4770 <
4771 See |match-parens| for a bigger and more useful example.
4773 searchpos({pattern} [, {flags} [, {stopline} [, {timeout}]]]) *searchpos()*
4774 Same as |search()|, but returns a |List| with the line and
4775 column position of the match. The first element of the |List|
4776 is the line number and the second element is the byte index of
4777 the column position of the match. If no match is found,
4778 returns [0, 0].
4779 Example: >
4780 :let [lnum, col] = searchpos('mypattern', 'n')
4782 < When the 'p' flag is given then there is an extra item with
4783 the sub-pattern match number |search()-sub-match|. Example: >
4784 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
4785 < In this example "submatch" is 2 when a lowercase letter is
4786 found |/\l|, 3 when an uppercase letter is found |/\u|.
4788 server2client( {clientid}, {string}) *server2client()*
4789 Send a reply string to {clientid}. The most recent {clientid}
4790 that sent a string can be retrieved with expand("<client>").
4791 {only available when compiled with the |+clientserver| feature}
4792 Note:
4793 This id has to be stored before the next command can be
4794 received. I.e. before returning from the received command and
4795 before calling any commands that waits for input.
4796 See also |clientserver|.
4797 Example: >
4798 :echo server2client(expand("<client>"), "HELLO")
4799 <
4800 serverlist() *serverlist()*
4801 Return a list of available server names, one per line.
4802 When there are no servers or the information is not available
4803 an empty string is returned. See also |clientserver|.
4804 {only available when compiled with the |+clientserver| feature}
4805 Example: >
4806 :echo serverlist()
4807 <
4808 setbufvar({expr}, {varname}, {val}) *setbufvar()*
4809 Set option or local variable {varname} in buffer {expr} to
4810 {val}.
4811 This also works for a global or local window option, but it
4812 doesn't work for a global or local window variable.
4813 For a local window option the global value is unchanged.
4814 For the use of {expr}, see |bufname()| above.
4815 Note that the variable name without "b:" must be used.
4816 Examples: >
4817 :call setbufvar(1, "&mod", 1)
4818 :call setbufvar("todo", "myvar", "foobar")
4819 < This function is not available in the |sandbox|.
4821 setcmdpos({pos}) *setcmdpos()*
4822 Set the cursor position in the command line to byte position
4823 {pos}. The first position is 1.
4824 Use |getcmdpos()| to obtain the current position.
4825 Only works while editing the command line, thus you must use
4826 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
4827 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
4828 set after the command line is set to the expression. For
4829 |c_CTRL-R_=| it is set after evaluating the expression but
4830 before inserting the resulting text.
4831 When the number is too big the cursor is put at the end of the
4832 line. A number smaller than one has undefined results.
4833 Returns 0 when successful, 1 when not editing the command
4834 line.
4836 setline({lnum}, {text}) *setline()*
4837 Set line {lnum} of the current buffer to {text}.
4838 {lnum} is used like with |getline()|.
4839 When {lnum} is just below the last line the {text} will be
4840 added as a new line.
4841 If this succeeds, 0 is returned. If this fails (most likely
4842 because {lnum} is invalid) 1 is returned. Example: >
4843 :call setline(5, strftime("%c"))
4844 < When {text} is a |List| then line {lnum} and following lines
4845 will be set to the items in the list. Example: >
4846 :call setline(5, ['aaa', 'bbb', 'ccc'])
4847 < This is equivalent to: >
4848 :for [n, l] in [[5, 6, 7], ['aaa', 'bbb', 'ccc']]
4849 : call setline(n, l)
4850 :endfor
4851 < Note: The '[ and '] marks are not set.
4853 setloclist({nr}, {list} [, {action}]) *setloclist()*
4854 Create or replace or add to the location list for window {nr}.
4855 When {nr} is zero the current window is used. For a location
4856 list window, the displayed location list is modified. For an
4857 invalid window number {nr}, -1 is returned.
4858 Otherwise, same as |setqflist()|.
4859 Also see |location-list|.
4861 setmatches({list}) *setmatches()*
4862 Restores a list of matches saved by |getmatches()|. Returns 0
4863 if successful, otherwise -1. All current matches are cleared
4864 before the list is restored. See example for |getmatches()|.
4866 *setpos()*
4867 setpos({expr}, {list})
4868 Set the position for {expr}. Possible values:
4869 . the cursor
4870 'x mark x
4872 {list} must be a |List| with four numbers:
4873 [bufnum, lnum, col, off]
4875 "bufnum" is the buffer number. Zero can be used for the
4876 current buffer. Setting the cursor is only possible for
4877 the current buffer. To set a mark in another buffer you can
4878 use the |bufnr()| function to turn a file name into a buffer
4879 number.
4880 Does not change the jumplist.
4882 "lnum" and "col" are the position in the buffer. The first
4883 column is 1. Use a zero "lnum" to delete a mark.
4885 The "off" number is only used when 'virtualedit' is set. Then
4886 it is the offset in screen columns from the start of the
4887 character. E.g., a position within a <Tab> or after the last
4888 character.
4890 Returns 0 when the position could be set, -1 otherwise.
4891 An error message is given if {expr} is invalid.
4893 Also see |getpos()|
4895 This does not restore the preferred column for moving
4896 vertically. See |winrestview()| for that.
4899 setqflist({list} [, {action}]) *setqflist()*
4900 Create or replace or add to the quickfix list using the items
4901 in {list}. Each item in {list} is a dictionary.
4902 Non-dictionary items in {list} are ignored. Each dictionary
4903 item can contain the following entries:
4905 bufnr buffer number; must be the number of a valid
4906 buffer
4907 filename name of a file; only used when "bufnr" is not
4908 present or it is invalid.
4909 lnum line number in the file
4910 pattern search pattern used to locate the error
4911 col column number
4912 vcol when non-zero: "col" is visual column
4913 when zero: "col" is byte index
4914 nr error number
4915 text description of the error
4916 type single-character error type, 'E', 'W', etc.
4918 The "col", "vcol", "nr", "type" and "text" entries are
4919 optional. Either "lnum" or "pattern" entry can be used to
4920 locate a matching error line.
4921 If the "filename" and "bufnr" entries are not present or
4922 neither the "lnum" or "pattern" entries are present, then the
4923 item will not be handled as an error line.
4924 If both "pattern" and "lnum" are present then "pattern" will
4925 be used.
4926 Note that the list is not exactly the same as what
4927 |getqflist()| returns.
4929 If {action} is set to 'a', then the items from {list} are
4930 added to the existing quickfix list. If there is no existing
4931 list, then a new list is created. If {action} is set to 'r',
4932 then the items from the current quickfix list are replaced
4933 with the items from {list}. If {action} is not present or is
4934 set to ' ', then a new list is created.
4936 Returns zero for success, -1 for failure.
4938 This function can be used to create a quickfix list
4939 independent of the 'errorformat' setting. Use a command like
4940 ":cc 1" to jump to the first position.
4943 *setreg()*
4944 setreg({regname}, {value} [,{options}])
4945 Set the register {regname} to {value}.
4946 If {options} contains "a" or {regname} is upper case,
4947 then the value is appended.
4948 {options} can also contains a register type specification:
4949 "c" or "v" |characterwise| mode
4950 "l" or "V" |linewise| mode
4951 "b" or "<CTRL-V>" |blockwise-visual| mode
4952 If a number immediately follows "b" or "<CTRL-V>" then this is
4953 used as the width of the selection - if it is not specified
4954 then the width of the block is set to the number of characters
4955 in the longest line (counting a <Tab> as 1 character).
4957 If {options} contains no register settings, then the default
4958 is to use character mode unless {value} ends in a <NL>.
4959 Setting the '=' register is not possible.
4960 Returns zero for success, non-zero for failure.
4962 Examples: >
4963 :call setreg(v:register, @*)
4964 :call setreg('*', @%, 'ac')
4965 :call setreg('a', "1\n2\n3", 'b5')
4967 < This example shows using the functions to save and restore a
4968 register. >
4969 :let var_a = getreg('a', 1)
4970 :let var_amode = getregtype('a')
4971 ....
4972 :call setreg('a', var_a, var_amode)
4974 < You can also change the type of a register by appending
4975 nothing: >
4976 :call setreg('a', '', 'al')
4978 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
4979 Set option or local variable {varname} in window {winnr} to
4980 {val}.
4981 Tabs are numbered starting with one. For the current tabpage
4982 use |setwinvar()|.
4983 When {winnr} is zero the current window is used.
4984 This also works for a global or local buffer option, but it
4985 doesn't work for a global or local buffer variable.
4986 For a local buffer option the global value is unchanged.
4987 Note that the variable name without "w:" must be used.
4988 Vim briefly goes to the tab page {tabnr}, this may trigger
4989 TabLeave and TabEnter autocommands.
4990 Examples: >
4991 :call settabwinvar(1, 1, "&list", 0)
4992 :call settabwinvar(3, 2, "myvar", "foobar")
4993 < This function is not available in the |sandbox|.
4995 setwinvar({nr}, {varname}, {val}) *setwinvar()*
4996 Like |settabwinvar()| for the current tab page.
4997 Examples: >
4998 :call setwinvar(1, "&list", 0)
4999 :call setwinvar(2, "myvar", "foobar")
5001 shellescape({string} [, {special}]) *shellescape()*
5002 Escape {string} for use as shell command argument.
5003 On MS-Windows and MS-DOS, when 'shellslash' is not set, it
5004 will enclose {string} in double quotes and double all double
5005 quotes within {string}.
5006 For other systems, it will enclose {string} in single quotes
5007 and replace all "'" with "'\''".
5008 When the {special} argument is present and it's a non-zero
5009 Number or a non-empty String (|non-zero-arg|), then special
5010 items such as "!", "%", "#" and "<cword>" will be preceded by
5011 a backslash. This backslash will be removed again by the |:!|
5012 command.
5013 The "!" character will be escaped (again with a |non-zero-arg|
5014 {special}) when 'shell' contains "csh" in the tail. That is
5015 because for csh and tcsh "!" is used for history replacement
5016 even when inside single quotes.
5017 The <NL> character is also escaped. With a |non-zero-arg|
5018 {special} and 'shell' containing "csh" in the tail it's
5019 escaped a second time.
5020 Example of use with a |:!| command: >
5021 :exe '!dir ' . shellescape(expand('<cfile>'), 1)
5022 < This results in a directory listing for the file under the
5023 cursor. Example of use with |system()|: >
5024 :call system("chmod +w -- " . shellescape(expand("%")))
5027 simplify({filename}) *simplify()*
5028 Simplify the file name as much as possible without changing
5029 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
5030 Unix) are not resolved. If the first path component in
5031 {filename} designates the current directory, this will be
5032 valid for the result as well. A trailing path separator is
5033 not removed either.
5034 Example: >
5035 simplify("./dir/.././/file/") == "./file/"
5036 < Note: The combination "dir/.." is only removed if "dir" is
5037 a searchable directory or does not exist. On Unix, it is also
5038 removed when "dir" is a symbolic link within the same
5039 directory. In order to resolve all the involved symbolic
5040 links before simplifying the path name, use |resolve()|.
5043 sin({expr}) *sin()*
5044 Return the sine of {expr}, measured in radians, as a |Float|.
5045 {expr} must evaluate to a |Float| or a |Number|.
5046 Examples: >
5047 :echo sin(100)
5048 < -0.506366 >
5049 :echo sin(-4.01)
5050 < 0.763301
5051 {only available when compiled with the |+float| feature}
5054 sort({list} [, {func}]) *sort()* *E702*
5055 Sort the items in {list} in-place. Returns {list}. If you
5056 want a list to remain unmodified make a copy first: >
5057 :let sortedlist = sort(copy(mylist))
5058 < Uses the string representation of each item to sort on.
5059 Numbers sort after Strings, |Lists| after Numbers.
5060 For sorting text in the current buffer use |:sort|.
5061 When {func} is given and it is one then case is ignored.
5062 When {func} is a |Funcref| or a function name, this function
5063 is called to compare items. The function is invoked with two
5064 items as argument and must return zero if they are equal, 1 or
5065 bigger if the first one sorts after the second one, -1 or
5066 smaller if the first one sorts before the second one.
5067 Example: >
5068 func MyCompare(i1, i2)
5069 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
5070 endfunc
5071 let sortedlist = sort(mylist, "MyCompare")
5072 < A shorter compare version for this specific simple case, which
5073 ignores overflow: >
5074 func MyCompare(i1, i2)
5075 return a:i1 - a:i2
5076 endfunc
5077 <
5078 *soundfold()*
5079 soundfold({word})
5080 Return the sound-folded equivalent of {word}. Uses the first
5081 language in 'spelllang' for the current window that supports
5082 soundfolding. 'spell' must be set. When no sound folding is
5083 possible the {word} is returned unmodified.
5084 This can be used for making spelling suggestions. Note that
5085 the method can be quite slow.
5087 *spellbadword()*
5088 spellbadword([{sentence}])
5089 Without argument: The result is the badly spelled word under
5090 or after the cursor. The cursor is moved to the start of the
5091 bad word. When no bad word is found in the cursor line the
5092 result is an empty string and the cursor doesn't move.
5094 With argument: The result is the first word in {sentence} that
5095 is badly spelled. If there are no spelling mistakes the
5096 result is an empty string.
5098 The return value is a list with two items:
5099 - The badly spelled word or an empty string.
5100 - The type of the spelling error:
5101 "bad" spelling mistake
5102 "rare" rare word
5103 "local" word only valid in another region
5104 "caps" word should start with Capital
5105 Example: >
5106 echo spellbadword("the quik brown fox")
5107 < ['quik', 'bad'] ~
5109 The spelling information for the current window is used. The
5110 'spell' option must be set and the value of 'spelllang' is
5111 used.
5113 *spellsuggest()*
5114 spellsuggest({word} [, {max} [, {capital}]])
5115 Return a |List| with spelling suggestions to replace {word}.
5116 When {max} is given up to this number of suggestions are
5117 returned. Otherwise up to 25 suggestions are returned.
5119 When the {capital} argument is given and it's non-zero only
5120 suggestions with a leading capital will be given. Use this
5121 after a match with 'spellcapcheck'.
5123 {word} can be a badly spelled word followed by other text.
5124 This allows for joining two words that were split. The
5125 suggestions also include the following text, thus you can
5126 replace a line.
5128 {word} may also be a good word. Similar words will then be
5129 returned. {word} itself is not included in the suggestions,
5130 although it may appear capitalized.
5132 The spelling information for the current window is used. The
5133 'spell' option must be set and the values of 'spelllang' and
5134 'spellsuggest' are used.
5137 split({expr} [, {pattern} [, {keepempty}]]) *split()*
5138 Make a |List| out of {expr}. When {pattern} is omitted or
5139 empty each white-separated sequence of characters becomes an
5140 item.
5141 Otherwise the string is split where {pattern} matches,
5142 removing the matched characters.
5143 When the first or last item is empty it is omitted, unless the
5144 {keepempty} argument is given and it's non-zero.
5145 Other empty items are kept when {pattern} matches at least one
5146 character or when {keepempty} is non-zero.
5147 Example: >
5148 :let words = split(getline('.'), '\W\+')
5149 < To split a string in individual characters: >
5150 :for c in split(mystring, '\zs')
5151 < If you want to keep the separator you can also use '\zs': >
5152 :echo split('abc:def:ghi', ':\zs')
5153 < ['abc:', 'def:', 'ghi'] ~
5154 Splitting a table where the first element can be empty: >
5155 :let items = split(line, ':', 1)
5156 < The opposite function is |join()|.
5159 sqrt({expr}) *sqrt()*
5160 Return the non-negative square root of Float {expr} as a
5161 |Float|.
5162 {expr} must evaluate to a |Float| or a |Number|. When {expr}
5163 is negative the result is NaN (Not a Number).
5164 Examples: >
5165 :echo sqrt(100)
5166 < 10.0 >
5167 :echo sqrt(-4.01)
5168 < nan
5169 "nan" may be different, it depends on system libraries.
5170 {only available when compiled with the |+float| feature}
5173 str2float( {expr}) *str2float()*
5174 Convert String {expr} to a Float. This mostly works the same
5175 as when using a floating point number in an expression, see
5176 |floating-point-format|. But it's a bit more permissive.
5177 E.g., "1e40" is accepted, while in an expression you need to
5178 write "1.0e40".
5179 Text after the number is silently ignored.
5180 The decimal point is always '.', no matter what the locale is
5181 set to. A comma ends the number: "12,345.67" is converted to
5182 12.0. You can strip out thousands separators with
5183 |substitute()|: >
5184 let f = str2float(substitute(text, ',', '', 'g'))
5185 < {only available when compiled with the |+float| feature}
5188 str2nr( {expr} [, {base}]) *str2nr()*
5189 Convert string {expr} to a number.
5190 {base} is the conversion base, it can be 8, 10 or 16.
5191 When {base} is omitted base 10 is used. This also means that
5192 a leading zero doesn't cause octal conversion to be used, as
5193 with the default String to Number conversion.
5194 When {base} is 16 a leading "0x" or "0X" is ignored. With a
5195 different base the result will be zero.
5196 Text after the number is silently ignored.
5199 strftime({format} [, {time}]) *strftime()*
5200 The result is a String, which is a formatted date and time, as
5201 specified by the {format} string. The given {time} is used,
5202 or the current time if no time is given. The accepted
5203 {format} depends on your system, thus this is not portable!
5204 See the manual page of the C function strftime() for the
5205 format. The maximum length of the result is 80 characters.
5206 See also |localtime()| and |getftime()|.
5207 The language can be changed with the |:language| command.
5208 Examples: >
5209 :echo strftime("%c") Sun Apr 27 11:49:23 1997
5210 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
5211 :echo strftime("%y%m%d %T") 970427 11:53:55
5212 :echo strftime("%H:%M") 11:55
5213 :echo strftime("%c", getftime("file.c"))
5214 Show mod time of file.c.
5215 < Not available on all systems. To check use: >
5216 :if exists("*strftime")
5218 stridx({haystack}, {needle} [, {start}]) *stridx()*
5219 The result is a Number, which gives the byte index in
5220 {haystack} of the first occurrence of the String {needle}.
5221 If {start} is specified, the search starts at index {start}.
5222 This can be used to find a second match: >
5223 :let comma1 = stridx(line, ",")
5224 :let comma2 = stridx(line, ",", comma1 + 1)
5225 < The search is done case-sensitive.
5226 For pattern searches use |match()|.
5227 -1 is returned if the {needle} does not occur in {haystack}.
5228 See also |strridx()|.
5229 Examples: >
5230 :echo stridx("An Example", "Example") 3
5231 :echo stridx("Starting point", "Start") 0
5232 :echo stridx("Starting point", "start") -1
5233 < *strstr()* *strchr()*
5234 stridx() works similar to the C function strstr(). When used
5235 with a single character it works similar to strchr().
5237 *string()*
5238 string({expr}) Return {expr} converted to a String. If {expr} is a Number,
5239 Float, String or a composition of them, then the result can be
5240 parsed back with |eval()|.
5241 {expr} type result ~
5242 String 'string'
5243 Number 123
5244 Float 123.123456 or 1.123456e8
5245 Funcref function('name')
5246 List [item, item]
5247 Dictionary {key: value, key: value}
5248 Note that in String values the ' character is doubled.
5249 Also see |strtrans()|.
5251 *strlen()*
5252 strlen({expr}) The result is a Number, which is the length of the String
5253 {expr} in bytes.
5254 If you want to count the number of multi-byte characters (not
5255 counting composing characters) use something like this: >
5257 :let len = strlen(substitute(str, ".", "x", "g"))
5258 <
5259 If the argument is a Number it is first converted to a String.
5260 For other types an error is given.
5261 Also see |len()|.
5263 strpart({src}, {start}[, {len}]) *strpart()*
5264 The result is a String, which is part of {src}, starting from
5265 byte {start}, with the byte length {len}.
5266 When non-existing bytes are included, this doesn't result in
5267 an error, the bytes are simply omitted.
5268 If {len} is missing, the copy continues from {start} till the
5269 end of the {src}. >
5270 strpart("abcdefg", 3, 2) == "de"
5271 strpart("abcdefg", -2, 4) == "ab"
5272 strpart("abcdefg", 5, 4) == "fg"
5273 strpart("abcdefg", 3) == "defg"
5274 < Note: To get the first character, {start} must be 0. For
5275 example, to get three bytes under and after the cursor: >
5276 strpart(getline("."), col(".") - 1, 3)
5277 <
5278 strridx({haystack}, {needle} [, {start}]) *strridx()*
5279 The result is a Number, which gives the byte index in
5280 {haystack} of the last occurrence of the String {needle}.
5281 When {start} is specified, matches beyond this index are
5282 ignored. This can be used to find a match before a previous
5283 match: >
5284 :let lastcomma = strridx(line, ",")
5285 :let comma2 = strridx(line, ",", lastcomma - 1)
5286 < The search is done case-sensitive.
5287 For pattern searches use |match()|.
5288 -1 is returned if the {needle} does not occur in {haystack}.
5289 If the {needle} is empty the length of {haystack} is returned.
5290 See also |stridx()|. Examples: >
5291 :echo strridx("an angry armadillo", "an") 3
5292 < *strrchr()*
5293 When used with a single character it works similar to the C
5294 function strrchr().
5296 strtrans({expr}) *strtrans()*
5297 The result is a String, which is {expr} with all unprintable
5298 characters translated into printable characters |'isprint'|.
5299 Like they are shown in a window. Example: >
5300 echo strtrans(@a)
5301 < This displays a newline in register a as "^@" instead of
5302 starting a new line.
5304 submatch({nr}) *submatch()*
5305 Only for an expression in a |:substitute| command. Returns
5306 the {nr}'th submatch of the matched text. When {nr} is 0
5307 the whole matched text is returned.
5308 Example: >
5309 :s/\d\+/\=submatch(0) + 1/
5310 < This finds the first number in the line and adds one to it.
5311 A line break is included as a newline character.
5313 substitute({expr}, {pat}, {sub}, {flags}) *substitute()*
5314 The result is a String, which is a copy of {expr}, in which
5315 the first match of {pat} is replaced with {sub}. This works
5316 like the ":substitute" command (without any flags). But the
5317 matching with {pat} is always done like the 'magic' option is
5318 set and 'cpoptions' is empty (to make scripts portable).
5319 'ignorecase' is still relevant. 'smartcase' is not used.
5320 See |string-match| for how {pat} is used.
5321 And a "~" in {sub} is not replaced with the previous {sub}.
5322 Note that some codes in {sub} have a special meaning
5323 |sub-replace-special|. For example, to replace something with
5324 "\n" (two characters), use "\\\\n" or '\\n'.
5325 When {pat} does not match in {expr}, {expr} is returned
5326 unmodified.
5327 When {flags} is "g", all matches of {pat} in {expr} are
5328 replaced. Otherwise {flags} should be "".
5329 Example: >
5330 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
5331 < This removes the last component of the 'path' option. >
5332 :echo substitute("testing", ".*", "\\U\\0", "")
5333 < results in "TESTING".
5335 synID({lnum}, {col}, {trans}) *synID()*
5336 The result is a Number, which is the syntax ID at the position
5337 {lnum} and {col} in the current window.
5338 The syntax ID can be used with |synIDattr()| and
5339 |synIDtrans()| to obtain syntax information about text.
5341 {col} is 1 for the leftmost column, {lnum} is 1 for the first
5342 line. 'synmaxcol' applies, in a longer line zero is returned.
5344 When {trans} is non-zero, transparent items are reduced to the
5345 item that they reveal. This is useful when wanting to know
5346 the effective color. When {trans} is zero, the transparent
5347 item is returned. This is useful when wanting to know which
5348 syntax item is effective (e.g. inside parens).
5349 Warning: This function can be very slow. Best speed is
5350 obtained by going through the file in forward direction.
5352 Example (echoes the name of the syntax item under the cursor): >
5353 :echo synIDattr(synID(line("."), col("."), 1), "name")
5354 <
5355 synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
5356 The result is a String, which is the {what} attribute of
5357 syntax ID {synID}. This can be used to obtain information
5358 about a syntax item.
5359 {mode} can be "gui", "cterm" or "term", to get the attributes
5360 for that mode. When {mode} is omitted, or an invalid value is
5361 used, the attributes for the currently active highlighting are
5362 used (GUI, cterm or term).
5363 Use synIDtrans() to follow linked highlight groups.
5364 {what} result
5365 "name" the name of the syntax item
5366 "fg" foreground color (GUI: color name used to set
5367 the color, cterm: color number as a string,
5368 term: empty string)
5369 "bg" background color (as with "fg")
5370 "sp" special color (as with "fg") |highlight-guisp|
5371 "fg#" like "fg", but for the GUI and the GUI is
5372 running the name in "#RRGGBB" form
5373 "bg#" like "fg#" for "bg"
5374 "sp#" like "fg#" for "sp"
5375 "bold" "1" if bold
5376 "italic" "1" if italic
5377 "reverse" "1" if reverse
5378 "inverse" "1" if inverse (= reverse)
5379 "underline" "1" if underlined
5380 "undercurl" "1" if undercurled
5382 Example (echoes the color of the syntax item under the
5383 cursor): >
5384 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
5385 <
5386 synIDtrans({synID}) *synIDtrans()*
5387 The result is a Number, which is the translated syntax ID of
5388 {synID}. This is the syntax group ID of what is being used to
5389 highlight the character. Highlight links given with
5390 ":highlight link" are followed.
5392 synstack({lnum}, {col}) *synstack()*
5393 Return a |List|, which is the stack of syntax items at the
5394 position {lnum} and {col} in the current window. Each item in
5395 the List is an ID like what |synID()| returns.
5396 The first item in the List is the outer region, following are
5397 items contained in that one. The last one is what |synID()|
5398 returns, unless not the whole item is highlighted or it is a
5399 transparent item.
5400 This function is useful for debugging a syntax file.
5401 Example that shows the syntax stack under the cursor: >
5402 for id in synstack(line("."), col("."))
5403 echo synIDattr(id, "name")
5404 endfor
5406 system({expr} [, {input}]) *system()* *E677*
5407 Get the output of the shell command {expr}.
5408 When {input} is given, this string is written to a file and
5409 passed as stdin to the command. The string is written as-is,
5410 you need to take care of using the correct line separators
5411 yourself. Pipes are not used.
5412 Note: Use |shellescape()| to escape special characters in a
5413 command argument. Newlines in {expr} may cause the command to
5414 fail. The characters in 'shellquote' and 'shellxquote' may
5415 also cause trouble.
5416 This is not to be used for interactive commands.
5418 The result is a String. Example: >
5419 :let files = system("ls " . shellescape(expand('%:h')))
5421 < To make the result more system-independent, the shell output
5422 is filtered to replace <CR> with <NL> for Macintosh, and
5423 <CR><NL> with <NL> for DOS-like systems.
5424 The command executed is constructed using several options:
5425 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
5426 ({tmp} is an automatically generated file name).
5427 For Unix and OS/2 braces are put around {expr} to allow for
5428 concatenated commands.
5430 The command will be executed in "cooked" mode, so that a
5431 CTRL-C will interrupt the command (on Unix at least).
5433 The resulting error code can be found in |v:shell_error|.
5434 This function will fail in |restricted-mode|.
5436 Note that any wrong value in the options mentioned above may
5437 make the function fail. It has also been reported to fail
5438 when using a security agent application.
5439 Unlike ":!cmd" there is no automatic check for changed files.
5440 Use |:checktime| to force a check.
5443 tabpagebuflist([{arg}]) *tabpagebuflist()*
5444 The result is a |List|, where each item is the number of the
5445 buffer associated with each window in the current tab page.
5446 {arg} specifies the number of tab page to be used. When
5447 omitted the current tab page is used.
5448 When {arg} is invalid the number zero is returned.
5449 To get a list of all buffers in all tabs use this: >
5450 tablist = []
5451 for i in range(tabpagenr('$'))
5452 call extend(tablist, tabpagebuflist(i + 1))
5453 endfor
5454 < Note that a buffer may appear in more than one window.
5457 tabpagenr([{arg}]) *tabpagenr()*
5458 The result is a Number, which is the number of the current
5459 tab page. The first tab page has number 1.
5460 When the optional argument is "$", the number of the last tab
5461 page is returned (the tab page count).
5462 The number can be used with the |:tab| command.
5465 tabpagewinnr({tabarg}, [{arg}]) *tabpagewinnr()*
5466 Like |winnr()| but for tab page {arg}.
5467 {tabarg} specifies the number of tab page to be used.
5468 {arg} is used like with |winnr()|:
5469 - When omitted the current window number is returned. This is
5470 the window which will be used when going to this tab page.
5471 - When "$" the number of windows is returned.
5472 - When "#" the previous window nr is returned.
5473 Useful examples: >
5474 tabpagewinnr(1) " current window of tab page 1
5475 tabpagewinnr(4, '$') " number of windows in tab page 4
5476 < When {tabarg} is invalid zero is returned.
5478 *tagfiles()*
5479 tagfiles() Returns a |List| with the file names used to search for tags
5480 for the current buffer. This is the 'tags' option expanded.
5483 taglist({expr}) *taglist()*
5484 Returns a list of tags matching the regular expression {expr}.
5485 Each list item is a dictionary with at least the following
5486 entries:
5487 name Name of the tag.
5488 filename Name of the file where the tag is
5489 defined. It is either relative to the
5490 current directory or a full path.
5491 cmd Ex command used to locate the tag in
5492 the file.
5493 kind Type of the tag. The value for this
5494 entry depends on the language specific
5495 kind values. Only available when
5496 using a tags file generated by
5497 Exuberant ctags or hdrtag.
5498 static A file specific tag. Refer to
5499 |static-tag| for more information.
5500 More entries may be present, depending on the content of the
5501 tags file: access, implementation, inherits and signature.
5502 Refer to the ctags documentation for information about these
5503 fields. For C code the fields "struct", "class" and "enum"
5504 may appear, they give the name of the entity the tag is
5505 contained in.
5507 The ex-command 'cmd' can be either an ex search pattern, a
5508 line number or a line number followed by a byte number.
5510 If there are no matching tags, then an empty list is returned.
5512 To get an exact tag match, the anchors '^' and '$' should be
5513 used in {expr}. Refer to |tag-regexp| for more information
5514 about the tag search regular expression pattern.
5516 Refer to |'tags'| for information about how the tags file is
5517 located by Vim. Refer to |tags-file-format| for the format of
5518 the tags file generated by the different ctags tools.
5520 tempname() *tempname()* *temp-file-name*
5521 The result is a String, which is the name of a file that
5522 doesn't exist. It can be used for a temporary file. The name
5523 is different for at least 26 consecutive calls. Example: >
5524 :let tmpfile = tempname()
5525 :exe "redir > " . tmpfile
5526 < For Unix, the file will be in a private directory |tempfile|.
5527 For MS-Windows forward slashes are used when the 'shellslash'
5528 option is set or when 'shellcmdflag' starts with '-'.
5530 tolower({expr}) *tolower()*
5531 The result is a copy of the String given, with all uppercase
5532 characters turned into lowercase (just like applying |gu| to
5533 the string).
5535 toupper({expr}) *toupper()*
5536 The result is a copy of the String given, with all lowercase
5537 characters turned into uppercase (just like applying |gU| to
5538 the string).
5540 tr({src}, {fromstr}, {tostr}) *tr()*
5541 The result is a copy of the {src} string with all characters
5542 which appear in {fromstr} replaced by the character in that
5543 position in the {tostr} string. Thus the first character in
5544 {fromstr} is translated into the first character in {tostr}
5545 and so on. Exactly like the unix "tr" command.
5546 This code also deals with multibyte characters properly.
5548 Examples: >
5549 echo tr("hello there", "ht", "HT")
5550 < returns "Hello THere" >
5551 echo tr("<blob>", "<>", "{}")
5552 < returns "{blob}"
5554 trunc({expr}) *trunc()*
5555 Return the largest integral value with magnitude less than or
5556 equal to {expr} as a |Float| (truncate towards zero).
5557 {expr} must evaluate to a |Float| or a |Number|.
5558 Examples: >
5559 echo trunc(1.456)
5560 < 1.0 >
5561 echo trunc(-5.456)
5562 < -5.0 >
5563 echo trunc(4.0)
5564 < 4.0
5565 {only available when compiled with the |+float| feature}
5567 *type()*
5568 type({expr}) The result is a Number, depending on the type of {expr}:
5569 Number: 0
5570 String: 1
5571 Funcref: 2
5572 List: 3
5573 Dictionary: 4
5574 Float: 5
5575 To avoid the magic numbers it should be used this way: >
5576 :if type(myvar) == type(0)
5577 :if type(myvar) == type("")
5578 :if type(myvar) == type(function("tr"))
5579 :if type(myvar) == type([])
5580 :if type(myvar) == type({})
5581 :if type(myvar) == type(0.0)
5583 values({dict}) *values()*
5584 Return a |List| with all the values of {dict}. The |List| is
5585 in arbitrary order.
5588 virtcol({expr}) *virtcol()*
5589 The result is a Number, which is the screen column of the file
5590 position given with {expr}. That is, the last screen position
5591 occupied by the character at that position, when the screen
5592 would be of unlimited width. When there is a <Tab> at the
5593 position, the returned Number will be the column at the end of
5594 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
5595 set to 8, it returns 8.
5596 For the byte position use |col()|.
5597 For the use of {expr} see |col()|.
5598 When 'virtualedit' is used {expr} can be [lnum, col, off], where
5599 "off" is the offset in screen columns from the start of the
5600 character. E.g., a position within a <Tab> or after the last
5601 character.
5602 When Virtual editing is active in the current mode, a position
5603 beyond the end of the line can be returned. |'virtualedit'|
5604 The accepted positions are:
5605 . the cursor position
5606 $ the end of the cursor line (the result is the
5607 number of displayed characters in the cursor line
5608 plus one)
5609 'x position of mark x (if the mark is not set, 0 is
5610 returned)
5611 Note that only marks in the current file can be used.
5612 Examples: >
5613 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
5614 virtcol("$") with text "foo^Lbar", returns 9
5615 virtcol("'t") with text " there", with 't at 'h', returns 6
5616 < The first column is 1. 0 is returned for an error.
5617 A more advanced example that echoes the maximum length of
5618 all lines: >
5619 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
5622 visualmode([expr]) *visualmode()*
5623 The result is a String, which describes the last Visual mode
5624 used in the current buffer. Initially it returns an empty
5625 string, but once Visual mode has been used, it returns "v",
5626 "V", or "<CTRL-V>" (a single CTRL-V character) for
5627 character-wise, line-wise, or block-wise Visual mode
5628 respectively.
5629 Example: >
5630 :exe "normal " . visualmode()
5631 < This enters the same Visual mode as before. It is also useful
5632 in scripts if you wish to act differently depending on the
5633 Visual mode that was used.
5634 If Visual mode is active, use |mode()| to get the Visual mode
5635 (e.g., in a |:vmap|).
5636 *non-zero-arg*
5637 If [expr] is supplied and it evaluates to a non-zero Number or
5638 a non-empty String, then the Visual mode will be cleared and
5639 the old value is returned. Note that " " and "0" are also
5640 non-empty strings, thus cause the mode to be cleared. A List,
5641 Dictionary or Float is not a Number or String, thus does not
5642 cause the mode to be cleared.
5644 *winbufnr()*
5645 winbufnr({nr}) The result is a Number, which is the number of the buffer
5646 associated with window {nr}. When {nr} is zero, the number of
5647 the buffer in the current window is returned. When window
5648 {nr} doesn't exist, -1 is returned.
5649 Example: >
5650 :echo "The file in the current window is " . bufname(winbufnr(0))
5651 <
5652 *wincol()*
5653 wincol() The result is a Number, which is the virtual column of the
5654 cursor in the window. This is counting screen cells from the
5655 left side of the window. The leftmost column is one.
5657 winheight({nr}) *winheight()*
5658 The result is a Number, which is the height of window {nr}.
5659 When {nr} is zero, the height of the current window is
5660 returned. When window {nr} doesn't exist, -1 is returned.
5661 An existing window always has a height of zero or more.
5662 Examples: >
5663 :echo "The current window has " . winheight(0) . " lines."
5664 <
5665 *winline()*
5666 winline() The result is a Number, which is the screen line of the cursor
5667 in the window. This is counting screen lines from the top of
5668 the window. The first line is one.
5669 If the cursor was moved the view on the file will be updated
5670 first, this may cause a scroll.
5672 *winnr()*
5673 winnr([{arg}]) The result is a Number, which is the number of the current
5674 window. The top window has number 1.
5675 When the optional argument is "$", the number of the
5676 last window is returned (the window count).
5677 When the optional argument is "#", the number of the last
5678 accessed window is returned (where |CTRL-W_p| goes to).
5679 If there is no previous window or it is in another tab page 0
5680 is returned.
5681 The number can be used with |CTRL-W_w| and ":wincmd w"
5682 |:wincmd|.
5683 Also see |tabpagewinnr()|.
5685 *winrestcmd()*
5686 winrestcmd() Returns a sequence of |:resize| commands that should restore
5687 the current window sizes. Only works properly when no windows
5688 are opened or closed and the current window and tab page is
5689 unchanged.
5690 Example: >
5691 :let cmd = winrestcmd()
5692 :call MessWithWindowSizes()
5693 :exe cmd
5694 <
5695 *winrestview()*
5696 winrestview({dict})
5697 Uses the |Dictionary| returned by |winsaveview()| to restore
5698 the view of the current window.
5699 If you have changed the values the result is unpredictable.
5700 If the window size changed the result won't be the same.
5702 *winsaveview()*
5703 winsaveview() Returns a |Dictionary| that contains information to restore
5704 the view of the current window. Use |winrestview()| to
5705 restore the view.
5706 This is useful if you have a mapping that jumps around in the
5707 buffer and you want to go back to the original view.
5708 This does not save fold information. Use the 'foldenable'
5709 option to temporarily switch off folding, so that folds are
5710 not opened when moving around.
5711 The return value includes:
5712 lnum cursor line number
5713 col cursor column
5714 coladd cursor column offset for 'virtualedit'
5715 curswant column for vertical movement
5716 topline first line in the window
5717 topfill filler lines, only in diff mode
5718 leftcol first column displayed
5719 skipcol columns skipped
5720 Note that no option values are saved.
5723 winwidth({nr}) *winwidth()*
5724 The result is a Number, which is the width of window {nr}.
5725 When {nr} is zero, the width of the current window is
5726 returned. When window {nr} doesn't exist, -1 is returned.
5727 An existing window always has a width of zero or more.
5728 Examples: >
5729 :echo "The current window has " . winwidth(0) . " columns."
5730 :if winwidth(0) <= 50
5731 : exe "normal 50\<C-W>|"
5732 :endif
5733 <
5734 *writefile()*
5735 writefile({list}, {fname} [, {binary}])
5736 Write |List| {list} to file {fname}. Each list item is
5737 separated with a NL. Each list item must be a String or
5738 Number.
5739 When {binary} is equal to "b" binary mode is used: There will
5740 not be a NL after the last list item. An empty item at the
5741 end does cause the last line in the file to end in a NL.
5742 All NL characters are replaced with a NUL character.
5743 Inserting CR characters needs to be done before passing {list}
5744 to writefile().
5745 An existing file is overwritten, if possible.
5746 When the write fails -1 is returned, otherwise 0. There is an
5747 error message if the file can't be created or when writing
5748 fails.
5749 Also see |readfile()|.
5750 To copy a file byte for byte: >
5751 :let fl = readfile("foo", "b")
5752 :call writefile(fl, "foocopy", "b")
5753 <
5755 *feature-list*
5756 There are three types of features:
5757 1. Features that are only supported when they have been enabled when Vim
5758 was compiled |+feature-list|. Example: >
5759 :if has("cindent")
5760 2. Features that are only supported when certain conditions have been met.
5761 Example: >
5762 :if has("gui_running")
5763 < *has-patch*
5764 3. Included patches. First check |v:version| for the version of Vim.
5765 Then the "patch123" feature means that patch 123 has been included for
5766 this version. Example (checking version 6.2.148 or later): >
5767 :if v:version > 602 || v:version == 602 && has("patch148")
5768 < Note that it's possible for patch 147 to be omitted even though 148 is
5769 included.
5771 all_builtin_terms Compiled with all builtin terminals enabled.
5772 amiga Amiga version of Vim.
5773 arabic Compiled with Arabic support |Arabic|.
5774 arp Compiled with ARP support (Amiga).
5775 autocmd Compiled with autocommand support. |autocommand|
5776 balloon_eval Compiled with |balloon-eval| support.
5777 balloon_multiline GUI supports multiline balloons.
5778 beos BeOS version of Vim.
5779 browse Compiled with |:browse| support, and browse() will
5780 work.
5781 builtin_terms Compiled with some builtin terminals.
5782 byte_offset Compiled with support for 'o' in 'statusline'
5783 cindent Compiled with 'cindent' support.
5784 clientserver Compiled with remote invocation support |clientserver|.
5785 clipboard Compiled with 'clipboard' support.
5786 cmdline_compl Compiled with |cmdline-completion| support.
5787 cmdline_hist Compiled with |cmdline-history| support.
5788 cmdline_info Compiled with 'showcmd' and 'ruler' support.
5789 comments Compiled with |'comments'| support.
5790 cryptv Compiled with encryption support |encryption|.
5791 cscope Compiled with |cscope| support.
5792 compatible Compiled to be very Vi compatible.
5793 debug Compiled with "DEBUG" defined.
5794 dialog_con Compiled with console dialog support.
5795 dialog_gui Compiled with GUI dialog support.
5796 diff Compiled with |vimdiff| and 'diff' support.
5797 digraphs Compiled with support for digraphs.
5798 dnd Compiled with support for the "~ register |quote_~|.
5799 dos32 32 bits DOS (DJGPP) version of Vim.
5800 dos16 16 bits DOS version of Vim.
5801 ebcdic Compiled on a machine with ebcdic character set.
5802 emacs_tags Compiled with support for Emacs tags.
5803 eval Compiled with expression evaluation support. Always
5804 true, of course!
5805 ex_extra Compiled with extra Ex commands |+ex_extra|.
5806 extra_search Compiled with support for |'incsearch'| and
5807 |'hlsearch'|
5808 farsi Compiled with Farsi support |farsi|.
5809 file_in_path Compiled with support for |gf| and |<cfile>|
5810 filterpipe When 'shelltemp' is off pipes are used for shell
5811 read/write/filter commands
5812 find_in_path Compiled with support for include file searches
5813 |+find_in_path|.
5814 float Compiled with support for |Float|.
5815 fname_case Case in file names matters (for Amiga, MS-DOS, and
5816 Windows this is not present).
5817 folding Compiled with |folding| support.
5818 footer Compiled with GUI footer support. |gui-footer|
5819 fork Compiled to use fork()/exec() instead of system().
5820 gettext Compiled with message translation |multi-lang|
5821 gui Compiled with GUI enabled.
5822 gui_athena Compiled with Athena GUI.
5823 gui_gtk Compiled with GTK+ GUI (any version).
5824 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
5825 gui_gnome Compiled with Gnome support (gui_gtk is also defined).
5826 gui_mac Compiled with Macintosh GUI.
5827 gui_motif Compiled with Motif GUI.
5828 gui_photon Compiled with Photon GUI.
5829 gui_win32 Compiled with MS Windows Win32 GUI.
5830 gui_win32s idem, and Win32s system being used (Windows 3.1)
5831 gui_running Vim is running in the GUI, or it will start soon.
5832 hangul_input Compiled with Hangul input support. |hangul|
5833 iconv Can use iconv() for conversion.
5834 insert_expand Compiled with support for CTRL-X expansion commands in
5835 Insert mode.
5836 jumplist Compiled with |jumplist| support.
5837 keymap Compiled with 'keymap' support.
5838 langmap Compiled with 'langmap' support.
5839 libcall Compiled with |libcall()| support.
5840 linebreak Compiled with 'linebreak', 'breakat' and 'showbreak'
5841 support.
5842 lispindent Compiled with support for lisp indenting.
5843 listcmds Compiled with commands for the buffer list |:files|
5844 and the argument list |arglist|.
5845 localmap Compiled with local mappings and abbr. |:map-local|
5846 mac Macintosh version of Vim.
5847 macunix Macintosh version of Vim, using Unix files (OS-X).
5848 menu Compiled with support for |:menu|.
5849 mksession Compiled with support for |:mksession|.
5850 modify_fname Compiled with file name modifiers. |filename-modifiers|
5851 mouse Compiled with support mouse.
5852 mouseshape Compiled with support for 'mouseshape'.
5853 mouse_dec Compiled with support for Dec terminal mouse.
5854 mouse_gpm Compiled with support for gpm (Linux console mouse)
5855 mouse_netterm Compiled with support for netterm mouse.
5856 mouse_pterm Compiled with support for qnx pterm mouse.
5857 mouse_sysmouse Compiled with support for sysmouse (*BSD console mouse)
5858 mouse_xterm Compiled with support for xterm mouse.
5859 multi_byte Compiled with support for 'encoding'
5860 multi_byte_encoding 'encoding' is set to a multi-byte encoding.
5861 multi_byte_ime Compiled with support for IME input method.
5862 multi_lang Compiled with support for multiple languages.
5863 mzscheme Compiled with MzScheme interface |mzscheme|.
5864 netbeans_intg Compiled with support for |netbeans|.
5865 netbeans_enabled Compiled with support for |netbeans| and it's used.
5866 ole Compiled with OLE automation support for Win32.
5867 os2 OS/2 version of Vim.
5868 osfiletype Compiled with support for osfiletypes |+osfiletype|
5869 path_extra Compiled with up/downwards search in 'path' and 'tags'
5870 perl Compiled with Perl interface.
5871 postscript Compiled with PostScript file printing.
5872 printer Compiled with |:hardcopy| support.
5873 profile Compiled with |:profile| support.
5874 python Compiled with Python interface.
5875 qnx QNX version of Vim.
5876 quickfix Compiled with |quickfix| support.
5877 reltime Compiled with |reltime()| support.
5878 rightleft Compiled with 'rightleft' support.
5879 ruby Compiled with Ruby interface |ruby|.
5880 scrollbind Compiled with 'scrollbind' support.
5881 showcmd Compiled with 'showcmd' support.
5882 signs Compiled with |:sign| support.
5883 smartindent Compiled with 'smartindent' support.
5884 sniff Compiled with SNiFF interface support.
5885 startuptime Compiled with |--startuptime| support.
5886 statusline Compiled with support for 'statusline', 'rulerformat'
5887 and special formats of 'titlestring' and 'iconstring'.
5888 sun_workshop Compiled with support for Sun |workshop|.
5889 spell Compiled with spell checking support |spell|.
5890 syntax Compiled with syntax highlighting support |syntax|.
5891 syntax_items There are active syntax highlighting items for the
5892 current buffer.
5893 system Compiled to use system() instead of fork()/exec().
5894 tag_binary Compiled with binary searching in tags files
5895 |tag-binary-search|.
5896 tag_old_static Compiled with support for old static tags
5897 |tag-old-static|.
5898 tag_any_white Compiled with support for any white characters in tags
5899 files |tag-any-white|.
5900 tcl Compiled with Tcl interface.
5901 terminfo Compiled with terminfo instead of termcap.
5902 termresponse Compiled with support for |t_RV| and |v:termresponse|.
5903 textobjects Compiled with support for |text-objects|.
5904 tgetent Compiled with tgetent support, able to use a termcap
5905 or terminfo file.
5906 title Compiled with window title support |'title'|.
5907 toolbar Compiled with support for |gui-toolbar|.
5908 unix Unix version of Vim.
5909 user_commands User-defined commands.
5910 viminfo Compiled with viminfo support.
5911 vim_starting True while initial source'ing takes place.
5912 vertsplit Compiled with vertically split windows |:vsplit|.
5913 virtualedit Compiled with 'virtualedit' option.
5914 visual Compiled with Visual mode.
5915 visualextra Compiled with extra Visual mode commands.
5916 |blockwise-operators|.
5917 vms VMS version of Vim.
5918 vreplace Compiled with |gR| and |gr| commands.
5919 wildignore Compiled with 'wildignore' option.
5920 wildmenu Compiled with 'wildmenu' option.
5921 windows Compiled with support for more than one window.
5922 winaltkeys Compiled with 'winaltkeys' option.
5923 win16 Win16 version of Vim (MS-Windows 3.1).
5924 win32 Win32 version of Vim (MS-Windows 95/98/ME/NT/2000/XP).
5925 win64 Win64 version of Vim (MS-Windows 64 bit).
5926 win32unix Win32 version of Vim, using Unix files (Cygwin)
5927 win95 Win32 version for MS-Windows 95/98/ME.
5928 writebackup Compiled with 'writebackup' default on.
5929 xfontset Compiled with X fontset support |xfontset|.
5930 xim Compiled with X input method support |xim|.
5931 xsmp Compiled with X session management support.
5932 xsmp_interact Compiled with interactive X session management support.
5933 xterm_clipboard Compiled with support for xterm clipboard.
5934 xterm_save Compiled with support for saving and restoring the
5935 xterm screen.
5936 x11 Compiled with X11 support.
5938 *string-match*
5939 Matching a pattern in a String
5941 A regexp pattern as explained at |pattern| is normally used to find a match in
5942 the buffer lines. When a pattern is used to find a match in a String, almost
5943 everything works in the same way. The difference is that a String is handled
5944 like it is one line. When it contains a "\n" character, this is not seen as a
5945 line break for the pattern. It can be matched with a "\n" in the pattern, or
5946 with ".". Example: >
5947 :let a = "aaaa\nxxxx"
5948 :echo matchstr(a, "..\n..")
5949 aa
5950 xx
5951 :echo matchstr(a, "a.x")
5952 a
5953 x
5955 Don't forget that "^" will only match at the first character of the String and
5956 "$" at the last character of the string. They don't match after or before a
5957 "\n".
5959 ==============================================================================
5960 5. Defining functions *user-functions*
5962 New functions can be defined. These can be called just like builtin
5963 functions. The function executes a sequence of Ex commands. Normal mode
5964 commands can be executed with the |:normal| command.
5966 The function name must start with an uppercase letter, to avoid confusion with
5967 builtin functions. To prevent from using the same name in different scripts
5968 avoid obvious, short names. A good habit is to start the function name with
5969 the name of the script, e.g., "HTMLcolor()".
5971 It's also possible to use curly braces, see |curly-braces-names|. And the
5972 |autoload| facility is useful to define a function only when it's called.
5974 *local-function*
5975 A function local to a script must start with "s:". A local script function
5976 can only be called from within the script and from functions, user commands
5977 and autocommands defined in the script. It is also possible to call the
5978 function from a mapping defined in the script, but then |<SID>| must be used
5979 instead of "s:" when the mapping is expanded outside of the script.
5981 *:fu* *:function* *E128* *E129* *E123*
5982 :fu[nction] List all functions and their arguments.
5984 :fu[nction] {name} List function {name}.
5985 {name} can also be a |Dictionary| entry that is a
5986 |Funcref|: >
5987 :function dict.init
5989 :fu[nction] /{pattern} List functions with a name matching {pattern}.
5990 Example that lists all functions ending with "File": >
5991 :function /File$
5992 <
5993 *:function-verbose*
5994 When 'verbose' is non-zero, listing a function will also display where it was
5995 last defined. Example: >
5997 :verbose function SetFileTypeSH
5998 function SetFileTypeSH(name)
5999 Last set from /usr/share/vim/vim-7.0/filetype.vim
6000 <
6001 See |:verbose-cmd| for more information.
6003 *E124* *E125*
6004 :fu[nction][!] {name}([arguments]) [range] [abort] [dict]
6005 Define a new function by the name {name}. The name
6006 must be made of alphanumeric characters and '_', and
6007 must start with a capital or "s:" (see above).
6009 {name} can also be a |Dictionary| entry that is a
6010 |Funcref|: >
6011 :function dict.init(arg)
6012 < "dict" must be an existing dictionary. The entry
6013 "init" is added if it didn't exist yet. Otherwise [!]
6014 is required to overwrite an existing function. The
6015 result is a |Funcref| to a numbered function. The
6016 function can only be used with a |Funcref| and will be
6017 deleted if there are no more references to it.
6018 *E127* *E122*
6019 When a function by this name already exists and [!] is
6020 not used an error message is given. When [!] is used,
6021 an existing function is silently replaced. Unless it
6022 is currently being executed, that is an error.
6024 For the {arguments} see |function-argument|.
6026 *a:firstline* *a:lastline*
6027 When the [range] argument is added, the function is
6028 expected to take care of a range itself. The range is
6029 passed as "a:firstline" and "a:lastline". If [range]
6030 is excluded, ":{range}call" will call the function for
6031 each line in the range, with the cursor on the start
6032 of each line. See |function-range-example|.
6034 When the [abort] argument is added, the function will
6035 abort as soon as an error is detected.
6037 When the [dict] argument is added, the function must
6038 be invoked through an entry in a |Dictionary|. The
6039 local variable "self" will then be set to the
6040 dictionary. See |Dictionary-function|.
6042 *function-search-undo*
6043 The last used search pattern and the redo command "."
6044 will not be changed by the function. This also
6045 implies that the effect of |:nohlsearch| is undone
6046 when the function returns.
6048 *:endf* *:endfunction* *E126* *E193*
6049 :endf[unction] The end of a function definition. Must be on a line
6050 by its own, without other commands.
6052 *:delf* *:delfunction* *E130* *E131*
6053 :delf[unction] {name} Delete function {name}.
6054 {name} can also be a |Dictionary| entry that is a
6055 |Funcref|: >
6056 :delfunc dict.init
6057 < This will remove the "init" entry from "dict". The
6058 function is deleted if there are no more references to
6059 it.
6060 *:retu* *:return* *E133*
6061 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is
6062 evaluated and returned as the result of the function.
6063 If "[expr]" is not given, the number 0 is returned.
6064 When a function ends without an explicit ":return",
6065 the number 0 is returned.
6066 Note that there is no check for unreachable lines,
6067 thus there is no warning if commands follow ":return".
6069 If the ":return" is used after a |:try| but before the
6070 matching |:finally| (if present), the commands
6071 following the ":finally" up to the matching |:endtry|
6072 are executed first. This process applies to all
6073 nested ":try"s inside the function. The function
6074 returns at the outermost ":endtry".
6076 *function-argument* *a:var*
6077 An argument can be defined by giving its name. In the function this can then
6078 be used as "a:name" ("a:" for argument).
6079 *a:0* *a:1* *a:000* *E740* *...*
6080 Up to 20 arguments can be given, separated by commas. After the named
6081 arguments an argument "..." can be specified, which means that more arguments
6082 may optionally be following. In the function the extra arguments can be used
6083 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which
6084 can be 0). "a:000" is set to a |List| that contains these arguments. Note
6085 that "a:1" is the same as "a:000[0]".
6086 *E742*
6087 The a: scope and the variables in it cannot be changed, they are fixed.
6088 However, if a |List| or |Dictionary| is used, you can change their contents.
6089 Thus you can pass a |List| to a function and have the function add an item to
6090 it. If you want to make sure the function cannot change a |List| or
6091 |Dictionary| use |:lockvar|.
6093 When not using "...", the number of arguments in a function call must be equal
6094 to the number of named arguments. When using "...", the number of arguments
6095 may be larger.
6097 It is also possible to define a function without any arguments. You must
6098 still supply the () then. The body of the function follows in the next lines,
6099 until the matching |:endfunction|. It is allowed to define another function
6100 inside a function body.
6102 *local-variables*
6103 Inside a function variables can be used. These are local variables, which
6104 will disappear when the function returns. Global variables need to be
6105 accessed with "g:".
6107 Example: >
6108 :function Table(title, ...)
6109 : echohl Title
6110 : echo a:title
6111 : echohl None
6112 : echo a:0 . " items:"
6113 : for s in a:000
6114 : echon ' ' . s
6115 : endfor
6116 :endfunction
6118 This function can then be called with: >
6119 call Table("Table", "line1", "line2")
6120 call Table("Empty Table")
6122 To return more than one value, return a |List|: >
6123 :function Compute(n1, n2)
6124 : if a:n2 == 0
6125 : return ["fail", 0]
6126 : endif
6127 : return ["ok", a:n1 / a:n2]
6128 :endfunction
6130 This function can then be called with: >
6131 :let [success, div] = Compute(102, 6)
6132 :if success == "ok"
6133 : echo div
6134 :endif
6135 <
6136 *:cal* *:call* *E107* *E117*
6137 :[range]cal[l] {name}([arguments])
6138 Call a function. The name of the function and its arguments
6139 are as specified with |:function|. Up to 20 arguments can be
6140 used. The returned value is discarded.
6141 Without a range and for functions that accept a range, the
6142 function is called once. When a range is given the cursor is
6143 positioned at the start of the first line before executing the
6144 function.
6145 When a range is given and the function doesn't handle it
6146 itself, the function is executed for each line in the range,
6147 with the cursor in the first column of that line. The cursor
6148 is left at the last line (possibly moved by the last function
6149 call). The arguments are re-evaluated for each line. Thus
6150 this works:
6151 *function-range-example* >
6152 :function Mynumber(arg)
6153 : echo line(".") . " " . a:arg
6154 :endfunction
6155 :1,5call Mynumber(getline("."))
6156 <
6157 The "a:firstline" and "a:lastline" are defined anyway, they
6158 can be used to do something different at the start or end of
6159 the range.
6161 Example of a function that handles the range itself: >
6163 :function Cont() range
6164 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ '
6165 :endfunction
6166 :4,8call Cont()
6167 <
6168 This function inserts the continuation character "\" in front
6169 of all the lines in the range, except the first one.
6171 When the function returns a composite value it can be further
6172 dereferenced, but the range will not be used then. Example: >
6173 :4,8call GetDict().method()
6174 < Here GetDict() gets the range but method() does not.
6176 *E132*
6177 The recursiveness of user functions is restricted with the |'maxfuncdepth'|
6178 option.
6181 AUTOMATICALLY LOADING FUNCTIONS ~
6182 *autoload-functions*
6183 When using many or large functions, it's possible to automatically define them
6184 only when they are used. There are two methods: with an autocommand and with
6185 the "autoload" directory in 'runtimepath'.
6188 Using an autocommand ~
6190 This is introduced in the user manual, section |41.14|.
6192 The autocommand is useful if you have a plugin that is a long Vim script file.
6193 You can define the autocommand and quickly quit the script with |:finish|.
6194 That makes Vim startup faster. The autocommand should then load the same file
6195 again, setting a variable to skip the |:finish| command.
6197 Use the FuncUndefined autocommand event with a pattern that matches the
6198 function(s) to be defined. Example: >
6200 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim
6202 The file "~/vim/bufnetfuncs.vim" should then define functions that start with
6203 "BufNet". Also see |FuncUndefined|.
6206 Using an autoload script ~
6207 *autoload* *E746*
6208 This is introduced in the user manual, section |41.15|.
6210 Using a script in the "autoload" directory is simpler, but requires using
6211 exactly the right file name. A function that can be autoloaded has a name
6212 like this: >
6214 :call filename#funcname()
6216 When such a function is called, and it is not defined yet, Vim will search the
6217 "autoload" directories in 'runtimepath' for a script file called
6218 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should
6219 then define the function like this: >
6221 function filename#funcname()
6222 echo "Done!"
6223 endfunction
6225 The file name and the name used before the # in the function must match
6226 exactly, and the defined function must have the name exactly as it will be
6227 called.
6229 It is possible to use subdirectories. Every # in the function name works like
6230 a path separator. Thus when calling a function: >
6232 :call foo#bar#func()
6234 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'.
6236 This also works when reading a variable that has not been set yet: >
6238 :let l = foo#bar#lvar
6240 However, when the autoload script was already loaded it won't be loaded again
6241 for an unknown variable.
6243 When assigning a value to such a variable nothing special happens. This can
6244 be used to pass settings to the autoload script before it's loaded: >
6246 :let foo#bar#toggle = 1
6247 :call foo#bar#func()
6249 Note that when you make a mistake and call a function that is supposed to be
6250 defined in an autoload script, but the script doesn't actually define the
6251 function, the script will be sourced every time you try to call the function.
6252 And you will get an error message every time.
6254 Also note that if you have two script files, and one calls a function in the
6255 other and vice versa, before the used function is defined, it won't work.
6256 Avoid using the autoload functionality at the toplevel.
6258 Hint: If you distribute a bunch of scripts you can pack them together with the
6259 |vimball| utility. Also read the user manual |distribute-script|.
6261 ==============================================================================
6262 6. Curly braces names *curly-braces-names*
6264 Wherever you can use a variable, you can use a "curly braces name" variable.
6265 This is a regular variable name with one or more expressions wrapped in braces
6266 {} like this: >
6267 my_{adjective}_variable
6269 When Vim encounters this, it evaluates the expression inside the braces, puts
6270 that in place of the expression, and re-interprets the whole as a variable
6271 name. So in the above example, if the variable "adjective" was set to
6272 "noisy", then the reference would be to "my_noisy_variable", whereas if
6273 "adjective" was set to "quiet", then it would be to "my_quiet_variable".
6275 One application for this is to create a set of variables governed by an option
6276 value. For example, the statement >
6277 echo my_{&background}_message
6279 would output the contents of "my_dark_message" or "my_light_message" depending
6280 on the current value of 'background'.
6282 You can use multiple brace pairs: >
6283 echo my_{adverb}_{adjective}_message
6284 ..or even nest them: >
6285 echo my_{ad{end_of_word}}_message
6286 where "end_of_word" is either "verb" or "jective".
6288 However, the expression inside the braces must evaluate to a valid single
6289 variable name, e.g. this is invalid: >
6290 :let foo='a + b'
6291 :echo c{foo}d
6292 .. since the result of expansion is "ca + bd", which is not a variable name.
6294 *curly-braces-function-names*
6295 You can call and define functions by an evaluated name in a similar way.
6296 Example: >
6297 :let func_end='whizz'
6298 :call my_func_{func_end}(parameter)
6300 This would call the function "my_func_whizz(parameter)".
6302 ==============================================================================
6303 7. Commands *expression-commands*
6305 :let {var-name} = {expr1} *:let* *E18*
6306 Set internal variable {var-name} to the result of the
6307 expression {expr1}. The variable will get the type
6308 from the {expr}. If {var-name} didn't exist yet, it
6309 is created.
6311 :let {var-name}[{idx}] = {expr1} *E689*
6312 Set a list item to the result of the expression
6313 {expr1}. {var-name} must refer to a list and {idx}
6314 must be a valid index in that list. For nested list
6315 the index can be repeated.
6316 This cannot be used to add an item to a |List|.
6317 This cannot be used to set a byte in a String. You
6318 can do that like this: >
6319 :let var = var[0:2] . 'X' . var[4:]
6320 <
6321 *E711* *E719*
6322 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710*
6323 Set a sequence of items in a |List| to the result of
6324 the expression {expr1}, which must be a list with the
6325 correct number of items.
6326 {idx1} can be omitted, zero is used instead.
6327 {idx2} can be omitted, meaning the end of the list.
6328 When the selected range of items is partly past the
6329 end of the list, items will be added.
6331 *:let+=* *:let-=* *:let.=* *E734*
6332 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}".
6333 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}".
6334 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}".
6335 These fail if {var} was not set yet and when the type
6336 of {var} and {expr1} don't fit the operator.
6339 :let ${env-name} = {expr1} *:let-environment* *:let-$*
6340 Set environment variable {env-name} to the result of
6341 the expression {expr1}. The type is always String.
6342 :let ${env-name} .= {expr1}
6343 Append {expr1} to the environment variable {env-name}.
6344 If the environment variable didn't exist yet this
6345 works like "=".
6347 :let @{reg-name} = {expr1} *:let-register* *:let-@*
6348 Write the result of the expression {expr1} in register
6349 {reg-name}. {reg-name} must be a single letter, and
6350 must be the name of a writable register (see
6351 |registers|). "@@" can be used for the unnamed
6352 register, "@/" for the search pattern.
6353 If the result of {expr1} ends in a <CR> or <NL>, the
6354 register will be linewise, otherwise it will be set to
6355 characterwise.
6356 This can be used to clear the last search pattern: >
6357 :let @/ = ""
6358 < This is different from searching for an empty string,
6359 that would match everywhere.
6361 :let @{reg-name} .= {expr1}
6362 Append {expr1} to register {reg-name}. If the
6363 register was empty it's like setting it to {expr1}.
6365 :let &{option-name} = {expr1} *:let-option* *:let-&*
6366 Set option {option-name} to the result of the
6367 expression {expr1}. A String or Number value is
6368 always converted to the type of the option.
6369 For an option local to a window or buffer the effect
6370 is just like using the |:set| command: both the local
6371 value and the global value are changed.
6372 Example: >
6373 :let &path = &path . ',/usr/local/include'
6375 :let &{option-name} .= {expr1}
6376 For a string option: Append {expr1} to the value.
6377 Does not insert a comma like |:set+=|.
6379 :let &{option-name} += {expr1}
6380 :let &{option-name} -= {expr1}
6381 For a number or boolean option: Add or subtract
6382 {expr1}.
6384 :let &l:{option-name} = {expr1}
6385 :let &l:{option-name} .= {expr1}
6386 :let &l:{option-name} += {expr1}
6387 :let &l:{option-name} -= {expr1}
6388 Like above, but only set the local value of an option
6389 (if there is one). Works like |:setlocal|.
6391 :let &g:{option-name} = {expr1}
6392 :let &g:{option-name} .= {expr1}
6393 :let &g:{option-name} += {expr1}
6394 :let &g:{option-name} -= {expr1}
6395 Like above, but only set the global value of an option
6396 (if there is one). Works like |:setglobal|.
6398 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688*
6399 {expr1} must evaluate to a |List|. The first item in
6400 the list is assigned to {name1}, the second item to
6401 {name2}, etc.
6402 The number of names must match the number of items in
6403 the |List|.
6404 Each name can be one of the items of the ":let"
6405 command as mentioned above.
6406 Example: >
6407 :let [s, item] = GetItem(s)
6408 < Detail: {expr1} is evaluated first, then the
6409 assignments are done in sequence. This matters if
6410 {name2} depends on {name1}. Example: >
6411 :let x = [0, 1]
6412 :let i = 0
6413 :let [i, x[i]] = [1, 2]
6414 :echo x
6415 < The result is [0, 2].
6417 :let [{name1}, {name2}, ...] .= {expr1}
6418 :let [{name1}, {name2}, ...] += {expr1}
6419 :let [{name1}, {name2}, ...] -= {expr1}
6420 Like above, but append/add/subtract the value for each
6421 |List| item.
6423 :let [{name}, ..., ; {lastname}] = {expr1}
6424 Like |:let-unpack| above, but the |List| may have more
6425 items than there are names. A list of the remaining
6426 items is assigned to {lastname}. If there are no
6427 remaining items {lastname} is set to an empty list.
6428 Example: >
6429 :let [a, b; rest] = ["aval", "bval", 3, 4]
6430 <
6431 :let [{name}, ..., ; {lastname}] .= {expr1}
6432 :let [{name}, ..., ; {lastname}] += {expr1}
6433 :let [{name}, ..., ; {lastname}] -= {expr1}
6434 Like above, but append/add/subtract the value for each
6435 |List| item.
6436 *E106*
6437 :let {var-name} .. List the value of variable {var-name}. Multiple
6438 variable names may be given. Special names recognized
6439 here: *E738*
6440 g: global variables
6441 b: local buffer variables
6442 w: local window variables
6443 t: local tab page variables
6444 s: script-local variables
6445 l: local function variables
6446 v: Vim variables.
6448 :let List the values of all variables. The type of the
6449 variable is indicated before the value:
6450 <nothing> String
6451 # Number
6452 * Funcref
6455 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795*
6456 Remove the internal variable {name}. Several variable
6457 names can be given, they are all removed. The name
6458 may also be a |List| or |Dictionary| item.
6459 With [!] no error message is given for non-existing
6460 variables.
6461 One or more items from a |List| can be removed: >
6462 :unlet list[3] " remove fourth item
6463 :unlet list[3:] " remove fourth item to last
6464 < One item from a |Dictionary| can be removed at a time: >
6465 :unlet dict['two']
6466 :unlet dict.two
6467 < This is especially useful to clean up used global
6468 variables and script-local variables (these are not
6469 deleted when the script ends). Function-local
6470 variables are automatically deleted when the function
6471 ends.
6473 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv*
6474 Lock the internal variable {name}. Locking means that
6475 it can no longer be changed (until it is unlocked).
6476 A locked variable can be deleted: >
6477 :lockvar v
6478 :let v = 'asdf' " fails!
6479 :unlet v
6480 < *E741*
6481 If you try to change a locked variable you get an
6482 error message: "E741: Value of {name} is locked"
6484 [depth] is relevant when locking a |List| or
6485 |Dictionary|. It specifies how deep the locking goes:
6486 1 Lock the |List| or |Dictionary| itself,
6487 cannot add or remove items, but can
6488 still change their values.
6489 2 Also lock the values, cannot change
6490 the items. If an item is a |List| or
6491 |Dictionary|, cannot add or remove
6492 items, but can still change the
6493 values.
6494 3 Like 2 but for the |List| /
6495 |Dictionary| in the |List| /
6496 |Dictionary|, one level deeper.
6497 The default [depth] is 2, thus when {name} is a |List|
6498 or |Dictionary| the values cannot be changed.
6499 *E743*
6500 For unlimited depth use [!] and omit [depth].
6501 However, there is a maximum depth of 100 to catch
6502 loops.
6504 Note that when two variables refer to the same |List|
6505 and you lock one of them, the |List| will also be
6506 locked when used through the other variable.
6507 Example: >
6508 :let l = [0, 1, 2, 3]
6509 :let cl = l
6510 :lockvar l
6511 :let cl[1] = 99 " won't work!
6512 < You may want to make a copy of a list to avoid this.
6513 See |deepcopy()|.
6516 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo*
6517 Unlock the internal variable {name}. Does the
6518 opposite of |:lockvar|.
6521 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580*
6522 :en[dif] Execute the commands until the next matching ":else"
6523 or ":endif" if {expr1} evaluates to non-zero.
6525 From Vim version 4.5 until 5.0, every Ex command in
6526 between the ":if" and ":endif" is ignored. These two
6527 commands were just to allow for future expansions in a
6528 backwards compatible way. Nesting was allowed. Note
6529 that any ":else" or ":elseif" was ignored, the "else"
6530 part was not executed either.
6532 You can use this to remain compatible with older
6533 versions: >
6534 :if version >= 500
6535 : version-5-specific-commands
6536 :endif
6537 < The commands still need to be parsed to find the
6538 "endif". Sometimes an older Vim has a problem with a
6539 new command. For example, ":silent" is recognized as
6540 a ":substitute" command. In that case ":execute" can
6541 avoid problems: >
6542 :if version >= 600
6543 : execute "silent 1,$delete"
6544 :endif
6545 <
6546 NOTE: The ":append" and ":insert" commands don't work
6547 properly in between ":if" and ":endif".
6549 *:else* *:el* *E581* *E583*
6550 :el[se] Execute the commands until the next matching ":else"
6551 or ":endif" if they previously were not being
6552 executed.
6554 *:elseif* *:elsei* *E582* *E584*
6555 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there
6556 is no extra ":endif".
6558 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw*
6559 *E170* *E585* *E588* *E733*
6560 :endw[hile] Repeat the commands between ":while" and ":endwhile",
6561 as long as {expr1} evaluates to non-zero.
6562 When an error is detected from a command inside the
6563 loop, execution continues after the "endwhile".
6564 Example: >
6565 :let lnum = 1
6566 :while lnum <= line("$")
6567 :call FixLine(lnum)
6568 :let lnum = lnum + 1
6569 :endwhile
6570 <
6571 NOTE: The ":append" and ":insert" commands don't work
6572 properly inside a ":while" and ":for" loop.
6574 :for {var} in {list} *:for* *E690* *E732*
6575 :endfo[r] *:endfo* *:endfor*
6576 Repeat the commands between ":for" and ":endfor" for
6577 each item in {list}. Variable {var} is set to the
6578 value of each item.
6579 When an error is detected for a command inside the
6580 loop, execution continues after the "endfor".
6581 Changing {list} inside the loop affects what items are
6582 used. Make a copy if this is unwanted: >
6583 :for item in copy(mylist)
6584 < When not making a copy, Vim stores a reference to the
6585 next item in the list, before executing the commands
6586 with the current item. Thus the current item can be
6587 removed without effect. Removing any later item means
6588 it will not be found. Thus the following example
6589 works (an inefficient way to make a list empty): >
6590 for item in mylist
6591 call remove(mylist, 0)
6592 endfor
6593 < Note that reordering the list (e.g., with sort() or
6594 reverse()) may have unexpected effects.
6595 Note that the type of each list item should be
6596 identical to avoid errors for the type of {var}
6597 changing. Unlet the variable at the end of the loop
6598 to allow multiple item types: >
6599 for item in ["foo", ["bar"]]
6600 echo item
6601 unlet item " E706 without this
6602 endfor
6604 :for [{var1}, {var2}, ...] in {listlist}
6605 :endfo[r]
6606 Like ":for" above, but each item in {listlist} must be
6607 a list, of which each item is assigned to {var1},
6608 {var2}, etc. Example: >
6609 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]]
6610 :echo getline(lnum)[col]
6611 :endfor
6612 <
6613 *:continue* *:con* *E586*
6614 :con[tinue] When used inside a ":while" or ":for" loop, jumps back
6615 to the start of the loop.
6616 If it is used after a |:try| inside the loop but
6617 before the matching |:finally| (if present), the
6618 commands following the ":finally" up to the matching
6619 |:endtry| are executed first. This process applies to
6620 all nested ":try"s inside the loop. The outermost
6621 ":endtry" then jumps back to the start of the loop.
6623 *:break* *:brea* *E587*
6624 :brea[k] When used inside a ":while" or ":for" loop, skips to
6625 the command after the matching ":endwhile" or
6626 ":endfor".
6627 If it is used after a |:try| inside the loop but
6628 before the matching |:finally| (if present), the
6629 commands following the ":finally" up to the matching
6630 |:endtry| are executed first. This process applies to
6631 all nested ":try"s inside the loop. The outermost
6632 ":endtry" then jumps to the command after the loop.
6634 :try *:try* *:endt* *:endtry* *E600* *E601* *E602*
6635 :endt[ry] Change the error handling for the commands between
6636 ":try" and ":endtry" including everything being
6637 executed across ":source" commands, function calls,
6638 or autocommand invocations.
6640 When an error or interrupt is detected and there is
6641 a |:finally| command following, execution continues
6642 after the ":finally". Otherwise, or when the
6643 ":endtry" is reached thereafter, the next
6644 (dynamically) surrounding ":try" is checked for
6645 a corresponding ":finally" etc. Then the script
6646 processing is terminated. (Whether a function
6647 definition has an "abort" argument does not matter.)
6648 Example: >
6649 :try | edit too much | finally | echo "cleanup" | endtry
6650 :echo "impossible" " not reached, script terminated above
6651 <
6652 Moreover, an error or interrupt (dynamically) inside
6653 ":try" and ":endtry" is converted to an exception. It
6654 can be caught as if it were thrown by a |:throw|
6655 command (see |:catch|). In this case, the script
6656 processing is not terminated.
6658 The value "Vim:Interrupt" is used for an interrupt
6659 exception. An error in a Vim command is converted
6660 to a value of the form "Vim({command}):{errmsg}",
6661 other errors are converted to a value of the form
6662 "Vim:{errmsg}". {command} is the full command name,
6663 and {errmsg} is the message that is displayed if the
6664 error exception is not caught, always beginning with
6665 the error number.
6666 Examples: >
6667 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry
6668 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry
6669 <
6670 *:cat* *:catch* *E603* *E604* *E605*
6671 :cat[ch] /{pattern}/ The following commands until the next |:catch|,
6672 |:finally|, or |:endtry| that belongs to the same
6673 |:try| as the ":catch" are executed when an exception
6674 matching {pattern} is being thrown and has not yet
6675 been caught by a previous ":catch". Otherwise, these
6676 commands are skipped.
6677 When {pattern} is omitted all errors are caught.
6678 Examples: >
6679 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C)
6680 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors
6681 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts
6682 :catch /^Vim(write):/ " catch all errors in :write
6683 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123
6684 :catch /my-exception/ " catch user exception
6685 :catch /.*/ " catch everything
6686 :catch " same as /.*/
6687 <
6688 Another character can be used instead of / around the
6689 {pattern}, so long as it does not have a special
6690 meaning (e.g., '|' or '"') and doesn't occur inside
6691 {pattern}.
6692 NOTE: It is not reliable to ":catch" the TEXT of
6693 an error message because it may vary in different
6694 locales.
6696 *:fina* *:finally* *E606* *E607*
6697 :fina[lly] The following commands until the matching |:endtry|
6698 are executed whenever the part between the matching
6699 |:try| and the ":finally" is left: either by falling
6700 through to the ":finally" or by a |:continue|,
6701 |:break|, |:finish|, or |:return|, or by an error or
6702 interrupt or exception (see |:throw|).
6704 *:th* *:throw* *E608*
6705 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception.
6706 If the ":throw" is used after a |:try| but before the
6707 first corresponding |:catch|, commands are skipped
6708 until the first ":catch" matching {expr1} is reached.
6709 If there is no such ":catch" or if the ":throw" is
6710 used after a ":catch" but before the |:finally|, the
6711 commands following the ":finally" (if present) up to
6712 the matching |:endtry| are executed. If the ":throw"
6713 is after the ":finally", commands up to the ":endtry"
6714 are skipped. At the ":endtry", this process applies
6715 again for the next dynamically surrounding ":try"
6716 (which may be found in a calling function or sourcing
6717 script), until a matching ":catch" has been found.
6718 If the exception is not caught, the command processing
6719 is terminated.
6720 Example: >
6721 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry
6722 <
6724 *:ec* *:echo*
6725 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The
6726 first {expr1} starts on a new line.
6727 Also see |:comment|.
6728 Use "\n" to start a new line. Use "\r" to move the
6729 cursor to the first column.
6730 Uses the highlighting set by the |:echohl| command.
6731 Cannot be followed by a comment.
6732 Example: >
6733 :echo "the value of 'shell' is" &shell
6734 < *:echo-redraw*
6735 A later redraw may make the message disappear again.
6736 And since Vim mostly postpones redrawing until it's
6737 finished with a sequence of commands this happens
6738 quite often. To avoid that a command from before the
6739 ":echo" causes a redraw afterwards (redraws are often
6740 postponed until you type something), force a redraw
6741 with the |:redraw| command. Example: >
6742 :new | redraw | echo "there is a new window"
6743 <
6744 *:echon*
6745 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see
6746 |:comment|.
6747 Uses the highlighting set by the |:echohl| command.
6748 Cannot be followed by a comment.
6749 Example: >
6750 :echon "the value of 'shell' is " &shell
6751 <
6752 Note the difference between using ":echo", which is a
6753 Vim command, and ":!echo", which is an external shell
6754 command: >
6755 :!echo % --> filename
6756 < The arguments of ":!" are expanded, see |:_%|. >
6757 :!echo "%" --> filename or "filename"
6758 < Like the previous example. Whether you see the double
6759 quotes or not depends on your 'shell'. >
6760 :echo % --> nothing
6761 < The '%' is an illegal character in an expression. >
6762 :echo "%" --> %
6763 < This just echoes the '%' character. >
6764 :echo expand("%") --> filename
6765 < This calls the expand() function to expand the '%'.
6767 *:echoh* *:echohl*
6768 :echoh[l] {name} Use the highlight group {name} for the following
6769 |:echo|, |:echon| and |:echomsg| commands. Also used
6770 for the |input()| prompt. Example: >
6771 :echohl WarningMsg | echo "Don't panic!" | echohl None
6772 < Don't forget to set the group back to "None",
6773 otherwise all following echo's will be highlighted.
6775 *:echom* *:echomsg*
6776 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the
6777 message in the |message-history|.
6778 Spaces are placed between the arguments as with the
6779 |:echo| command. But unprintable characters are
6780 displayed, not interpreted.
6781 The parsing works slightly different from |:echo|,
6782 more like |:execute|. All the expressions are first
6783 evaluated and concatenated before echoing anything.
6784 The expressions must evaluate to a Number or String, a
6785 Dictionary or List causes an error.
6786 Uses the highlighting set by the |:echohl| command.
6787 Example: >
6788 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
6789 < See |:echo-redraw| to avoid the message disappearing
6790 when the screen is redrawn.
6791 *:echoe* *:echoerr*
6792 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the
6793 message in the |message-history|. When used in a
6794 script or function the line number will be added.
6795 Spaces are placed between the arguments as with the
6796 :echo command. When used inside a try conditional,
6797 the message is raised as an error exception instead
6798 (see |try-echoerr|).
6799 Example: >
6800 :echoerr "This script just failed!"
6801 < If you just want a highlighted message use |:echohl|.
6802 And to get a beep: >
6803 :exe "normal \<Esc>"
6804 <
6805 *:exe* *:execute*
6806 :exe[cute] {expr1} .. Executes the string that results from the evaluation
6807 of {expr1} as an Ex command. Multiple arguments are
6808 concatenated, with a space in between. {expr1} is
6809 used as the processed command, command line editing
6810 keys are not recognized.
6811 Cannot be followed by a comment.
6812 Examples: >
6813 :execute "buffer " nextbuf
6814 :execute "normal " count . "w"
6815 <
6816 ":execute" can be used to append a command to commands
6817 that don't accept a '|'. Example: >
6818 :execute '!ls' | echo "theend"
6820 < ":execute" is also a nice way to avoid having to type
6821 control characters in a Vim script for a ":normal"
6822 command: >
6823 :execute "normal ixxx\<Esc>"
6824 < This has an <Esc> character, see |expr-string|.
6826 Be careful to correctly escape special characters in
6827 file names. The |fnameescape()| function can be used
6828 for Vim commands, |shellescape()| for |:!| commands.
6829 Examples: >
6830 :execute "e " . fnameescape(filename)
6831 :execute "!ls " . shellescape(expand('%:h'), 1)
6832 <
6833 Note: The executed string may be any command-line, but
6834 you cannot start or end a "while", "for" or "if"
6835 command. Thus this is illegal: >
6836 :execute 'while i > 5'
6837 :execute 'echo "test" | break'
6838 <
6839 It is allowed to have a "while" or "if" command
6840 completely in the executed string: >
6841 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile'
6842 <
6844 *:exe-comment*
6845 ":execute", ":echo" and ":echon" cannot be followed by
6846 a comment directly, because they see the '"' as the
6847 start of a string. But, you can use '|' followed by a
6848 comment. Example: >
6849 :echo "foo" | "this is a comment
6851 ==============================================================================
6852 8. Exception handling *exception-handling*
6854 The Vim script language comprises an exception handling feature. This section
6855 explains how it can be used in a Vim script.
6857 Exceptions may be raised by Vim on an error or on interrupt, see
6858 |catch-errors| and |catch-interrupt|. You can also explicitly throw an
6859 exception by using the ":throw" command, see |throw-catch|.
6862 TRY CONDITIONALS *try-conditionals*
6864 Exceptions can be caught or can cause cleanup code to be executed. You can
6865 use a try conditional to specify catch clauses (that catch exceptions) and/or
6866 a finally clause (to be executed for cleanup).
6867 A try conditional begins with a |:try| command and ends at the matching
6868 |:endtry| command. In between, you can use a |:catch| command to start
6869 a catch clause, or a |:finally| command to start a finally clause. There may
6870 be none or multiple catch clauses, but there is at most one finally clause,
6871 which must not be followed by any catch clauses. The lines before the catch
6872 clauses and the finally clause is called a try block. >
6874 :try
6875 : ...
6876 : ... TRY BLOCK
6877 : ...
6878 :catch /{pattern}/
6879 : ...
6880 : ... CATCH CLAUSE
6881 : ...
6882 :catch /{pattern}/
6883 : ...
6884 : ... CATCH CLAUSE
6885 : ...
6886 :finally
6887 : ...
6888 : ... FINALLY CLAUSE
6889 : ...
6890 :endtry
6892 The try conditional allows to watch code for exceptions and to take the
6893 appropriate actions. Exceptions from the try block may be caught. Exceptions
6894 from the try block and also the catch clauses may cause cleanup actions.
6895 When no exception is thrown during execution of the try block, the control
6896 is transferred to the finally clause, if present. After its execution, the
6897 script continues with the line following the ":endtry".
6898 When an exception occurs during execution of the try block, the remaining
6899 lines in the try block are skipped. The exception is matched against the
6900 patterns specified as arguments to the ":catch" commands. The catch clause
6901 after the first matching ":catch" is taken, other catch clauses are not
6902 executed. The catch clause ends when the next ":catch", ":finally", or
6903 ":endtry" command is reached - whatever is first. Then, the finally clause
6904 (if present) is executed. When the ":endtry" is reached, the script execution
6905 continues in the following line as usual.
6906 When an exception that does not match any of the patterns specified by the
6907 ":catch" commands is thrown in the try block, the exception is not caught by
6908 that try conditional and none of the catch clauses is executed. Only the
6909 finally clause, if present, is taken. The exception pends during execution of
6910 the finally clause. It is resumed at the ":endtry", so that commands after
6911 the ":endtry" are not executed and the exception might be caught elsewhere,
6912 see |try-nesting|.
6913 When during execution of a catch clause another exception is thrown, the
6914 remaining lines in that catch clause are not executed. The new exception is
6915 not matched against the patterns in any of the ":catch" commands of the same
6916 try conditional and none of its catch clauses is taken. If there is, however,
6917 a finally clause, it is executed, and the exception pends during its
6918 execution. The commands following the ":endtry" are not executed. The new
6919 exception might, however, be caught elsewhere, see |try-nesting|.
6920 When during execution of the finally clause (if present) an exception is
6921 thrown, the remaining lines in the finally clause are skipped. If the finally
6922 clause has been taken because of an exception from the try block or one of the
6923 catch clauses, the original (pending) exception is discarded. The commands
6924 following the ":endtry" are not executed, and the exception from the finally
6925 clause is propagated and can be caught elsewhere, see |try-nesting|.
6927 The finally clause is also executed, when a ":break" or ":continue" for
6928 a ":while" loop enclosing the complete try conditional is executed from the
6929 try block or a catch clause. Or when a ":return" or ":finish" is executed
6930 from the try block or a catch clause of a try conditional in a function or
6931 sourced script, respectively. The ":break", ":continue", ":return", or
6932 ":finish" pends during execution of the finally clause and is resumed when the
6933 ":endtry" is reached. It is, however, discarded when an exception is thrown
6934 from the finally clause.
6935 When a ":break" or ":continue" for a ":while" loop enclosing the complete
6936 try conditional or when a ":return" or ":finish" is encountered in the finally
6937 clause, the rest of the finally clause is skipped, and the ":break",
6938 ":continue", ":return" or ":finish" is executed as usual. If the finally
6939 clause has been taken because of an exception or an earlier ":break",
6940 ":continue", ":return", or ":finish" from the try block or a catch clause,
6941 this pending exception or command is discarded.
6943 For examples see |throw-catch| and |try-finally|.
6946 NESTING OF TRY CONDITIONALS *try-nesting*
6948 Try conditionals can be nested arbitrarily. That is, a complete try
6949 conditional can be put into the try block, a catch clause, or the finally
6950 clause of another try conditional. If the inner try conditional does not
6951 catch an exception thrown in its try block or throws a new exception from one
6952 of its catch clauses or its finally clause, the outer try conditional is
6953 checked according to the rules above. If the inner try conditional is in the
6954 try block of the outer try conditional, its catch clauses are checked, but
6955 otherwise only the finally clause is executed. It does not matter for
6956 nesting, whether the inner try conditional is directly contained in the outer
6957 one, or whether the outer one sources a script or calls a function containing
6958 the inner try conditional.
6960 When none of the active try conditionals catches an exception, just their
6961 finally clauses are executed. Thereafter, the script processing terminates.
6962 An error message is displayed in case of an uncaught exception explicitly
6963 thrown by a ":throw" command. For uncaught error and interrupt exceptions
6964 implicitly raised by Vim, the error message(s) or interrupt message are shown
6965 as usual.
6967 For examples see |throw-catch|.
6970 EXAMINING EXCEPTION HANDLING CODE *except-examine*
6972 Exception handling code can get tricky. If you are in doubt what happens, set
6973 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your
6974 script file. Then you see when an exception is thrown, discarded, caught, or
6975 finished. When using a verbosity level of at least 14, things pending in
6976 a finally clause are also shown. This information is also given in debug mode
6977 (see |debug-scripts|).
6980 THROWING AND CATCHING EXCEPTIONS *throw-catch*
6982 You can throw any number or string as an exception. Use the |:throw| command
6983 and pass the value to be thrown as argument: >
6984 :throw 4711
6985 :throw "string"
6986 < *throw-expression*
6987 You can also specify an expression argument. The expression is then evaluated
6988 first, and the result is thrown: >
6989 :throw 4705 + strlen("string")
6990 :throw strpart("strings", 0, 6)
6992 An exception might be thrown during evaluation of the argument of the ":throw"
6993 command. Unless it is caught there, the expression evaluation is abandoned.
6994 The ":throw" command then does not throw a new exception.
6995 Example: >
6997 :function! Foo(arg)
6998 : try
6999 : throw a:arg
7000 : catch /foo/
7001 : endtry
7002 : return 1
7003 :endfunction
7004 :
7005 :function! Bar()
7006 : echo "in Bar"
7007 : return 4710
7008 :endfunction
7009 :
7010 :throw Foo("arrgh") + Bar()
7012 This throws "arrgh", and "in Bar" is not displayed since Bar() is not
7013 executed. >
7014 :throw Foo("foo") + Bar()
7015 however displays "in Bar" and throws 4711.
7017 Any other command that takes an expression as argument might also be
7018 abandoned by an (uncaught) exception during the expression evaluation. The
7019 exception is then propagated to the caller of the command.
7020 Example: >
7022 :if Foo("arrgh")
7023 : echo "then"
7024 :else
7025 : echo "else"
7026 :endif
7028 Here neither of "then" or "else" is displayed.
7030 *catch-order*
7031 Exceptions can be caught by a try conditional with one or more |:catch|
7032 commands, see |try-conditionals|. The values to be caught by each ":catch"
7033 command can be specified as a pattern argument. The subsequent catch clause
7034 gets executed when a matching exception is caught.
7035 Example: >
7037 :function! Foo(value)
7038 : try
7039 : throw a:value
7040 : catch /^\d\+$/
7041 : echo "Number thrown"
7042 : catch /.*/
7043 : echo "String thrown"
7044 : endtry
7045 :endfunction
7046 :
7047 :call Foo(0x1267)
7048 :call Foo('string')
7050 The first call to Foo() displays "Number thrown", the second "String thrown".
7051 An exception is matched against the ":catch" commands in the order they are
7052 specified. Only the first match counts. So you should place the more
7053 specific ":catch" first. The following order does not make sense: >
7055 : catch /.*/
7056 : echo "String thrown"
7057 : catch /^\d\+$/
7058 : echo "Number thrown"
7060 The first ":catch" here matches always, so that the second catch clause is
7061 never taken.
7063 *throw-variables*
7064 If you catch an exception by a general pattern, you may access the exact value
7065 in the variable |v:exception|: >
7067 : catch /^\d\+$/
7068 : echo "Number thrown. Value is" v:exception
7070 You may also be interested where an exception was thrown. This is stored in
7071 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the
7072 exception most recently caught as long it is not finished.
7073 Example: >
7075 :function! Caught()
7076 : if v:exception != ""
7077 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint
7078 : else
7079 : echo 'Nothing caught'
7080 : endif
7081 :endfunction
7082 :
7083 :function! Foo()
7084 : try
7085 : try
7086 : try
7087 : throw 4711
7088 : finally
7089 : call Caught()
7090 : endtry
7091 : catch /.*/
7092 : call Caught()
7093 : throw "oops"
7094 : endtry
7095 : catch /.*/
7096 : call Caught()
7097 : finally
7098 : call Caught()
7099 : endtry
7100 :endfunction
7101 :
7102 :call Foo()
7104 This displays >
7106 Nothing caught
7107 Caught "4711" in function Foo, line 4
7108 Caught "oops" in function Foo, line 10
7109 Nothing caught
7111 A practical example: The following command ":LineNumber" displays the line
7112 number in the script or function where it has been used: >
7114 :function! LineNumber()
7115 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "")
7116 :endfunction
7117 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry
7118 <
7119 *try-nested*
7120 An exception that is not caught by a try conditional can be caught by
7121 a surrounding try conditional: >
7123 :try
7124 : try
7125 : throw "foo"
7126 : catch /foobar/
7127 : echo "foobar"
7128 : finally
7129 : echo "inner finally"
7130 : endtry
7131 :catch /foo/
7132 : echo "foo"
7133 :endtry
7135 The inner try conditional does not catch the exception, just its finally
7136 clause is executed. The exception is then caught by the outer try
7137 conditional. The example displays "inner finally" and then "foo".
7139 *throw-from-catch*
7140 You can catch an exception and throw a new one to be caught elsewhere from the
7141 catch clause: >
7143 :function! Foo()
7144 : throw "foo"
7145 :endfunction
7146 :
7147 :function! Bar()
7148 : try
7149 : call Foo()
7150 : catch /foo/
7151 : echo "Caught foo, throw bar"
7152 : throw "bar"
7153 : endtry
7154 :endfunction
7155 :
7156 :try
7157 : call Bar()
7158 :catch /.*/
7159 : echo "Caught" v:exception
7160 :endtry
7162 This displays "Caught foo, throw bar" and then "Caught bar".
7164 *rethrow*
7165 There is no real rethrow in the Vim script language, but you may throw
7166 "v:exception" instead: >
7168 :function! Bar()
7169 : try
7170 : call Foo()
7171 : catch /.*/
7172 : echo "Rethrow" v:exception
7173 : throw v:exception
7174 : endtry
7175 :endfunction
7176 < *try-echoerr*
7177 Note that this method cannot be used to "rethrow" Vim error or interrupt
7178 exceptions, because it is not possible to fake Vim internal exceptions.
7179 Trying so causes an error exception. You should throw your own exception
7180 denoting the situation. If you want to cause a Vim error exception containing
7181 the original error exception value, you can use the |:echoerr| command: >
7183 :try
7184 : try
7185 : asdf
7186 : catch /.*/
7187 : echoerr v:exception
7188 : endtry
7189 :catch /.*/
7190 : echo v:exception
7191 :endtry
7193 This code displays
7195 Vim(echoerr):Vim:E492: Not an editor command: asdf ~
7198 CLEANUP CODE *try-finally*
7200 Scripts often change global settings and restore them at their end. If the
7201 user however interrupts the script by pressing CTRL-C, the settings remain in
7202 an inconsistent state. The same may happen to you in the development phase of
7203 a script when an error occurs or you explicitly throw an exception without
7204 catching it. You can solve these problems by using a try conditional with
7205 a finally clause for restoring the settings. Its execution is guaranteed on
7206 normal control flow, on error, on an explicit ":throw", and on interrupt.
7207 (Note that errors and interrupts from inside the try conditional are converted
7208 to exceptions. When not caught, they terminate the script after the finally
7209 clause has been executed.)
7210 Example: >
7212 :try
7213 : let s:saved_ts = &ts
7214 : set ts=17
7215 :
7216 : " Do the hard work here.
7217 :
7218 :finally
7219 : let &ts = s:saved_ts
7220 : unlet s:saved_ts
7221 :endtry
7223 This method should be used locally whenever a function or part of a script
7224 changes global settings which need to be restored on failure or normal exit of
7225 that function or script part.
7227 *break-finally*
7228 Cleanup code works also when the try block or a catch clause is left by
7229 a ":continue", ":break", ":return", or ":finish".
7230 Example: >
7232 :let first = 1
7233 :while 1
7234 : try
7235 : if first
7236 : echo "first"
7237 : let first = 0
7238 : continue
7239 : else
7240 : throw "second"
7241 : endif
7242 : catch /.*/
7243 : echo v:exception
7244 : break
7245 : finally
7246 : echo "cleanup"
7247 : endtry
7248 : echo "still in while"
7249 :endwhile
7250 :echo "end"
7252 This displays "first", "cleanup", "second", "cleanup", and "end". >
7254 :function! Foo()
7255 : try
7256 : return 4711
7257 : finally
7258 : echo "cleanup\n"
7259 : endtry
7260 : echo "Foo still active"
7261 :endfunction
7262 :
7263 :echo Foo() "returned by Foo"
7265 This displays "cleanup" and "4711 returned by Foo". You don't need to add an
7266 extra ":return" in the finally clause. (Above all, this would override the
7267 return value.)
7269 *except-from-finally*
7270 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in
7271 a finally clause is possible, but not recommended since it abandons the
7272 cleanup actions for the try conditional. But, of course, interrupt and error
7273 exceptions might get raised from a finally clause.
7274 Example where an error in the finally clause stops an interrupt from
7275 working correctly: >
7277 :try
7278 : try
7279 : echo "Press CTRL-C for interrupt"
7280 : while 1
7281 : endwhile
7282 : finally
7283 : unlet novar
7284 : endtry
7285 :catch /novar/
7286 :endtry
7287 :echo "Script still running"
7288 :sleep 1
7290 If you need to put commands that could fail into a finally clause, you should
7291 think about catching or ignoring the errors in these commands, see
7292 |catch-errors| and |ignore-errors|.
7295 CATCHING ERRORS *catch-errors*
7297 If you want to catch specific errors, you just have to put the code to be
7298 watched in a try block and add a catch clause for the error message. The
7299 presence of the try conditional causes all errors to be converted to an
7300 exception. No message is displayed and |v:errmsg| is not set then. To find
7301 the right pattern for the ":catch" command, you have to know how the format of
7302 the error exception is.
7303 Error exceptions have the following format: >
7305 Vim({cmdname}):{errmsg}
7306 or >
7307 Vim:{errmsg}
7309 {cmdname} is the name of the command that failed; the second form is used when
7310 the command name is not known. {errmsg} is the error message usually produced
7311 when the error occurs outside try conditionals. It always begins with
7312 a capital "E", followed by a two or three-digit error number, a colon, and
7313 a space.
7315 Examples:
7317 The command >
7318 :unlet novar
7319 normally produces the error message >
7320 E108: No such variable: "novar"
7321 which is converted inside try conditionals to an exception >
7322 Vim(unlet):E108: No such variable: "novar"
7324 The command >
7325 :dwim
7326 normally produces the error message >
7327 E492: Not an editor command: dwim
7328 which is converted inside try conditionals to an exception >
7329 Vim:E492: Not an editor command: dwim
7331 You can catch all ":unlet" errors by a >
7332 :catch /^Vim(unlet):/
7333 or all errors for misspelled command names by a >
7334 :catch /^Vim:E492:/
7336 Some error messages may be produced by different commands: >
7337 :function nofunc
7338 and >
7339 :delfunction nofunc
7340 both produce the error message >
7341 E128: Function name must start with a capital: nofunc
7342 which is converted inside try conditionals to an exception >
7343 Vim(function):E128: Function name must start with a capital: nofunc
7344 or >
7345 Vim(delfunction):E128: Function name must start with a capital: nofunc
7346 respectively. You can catch the error by its number independently on the
7347 command that caused it if you use the following pattern: >
7348 :catch /^Vim(\a\+):E128:/
7350 Some commands like >
7351 :let x = novar
7352 produce multiple error messages, here: >
7353 E121: Undefined variable: novar
7354 E15: Invalid expression: novar
7355 Only the first is used for the exception value, since it is the most specific
7356 one (see |except-several-errors|). So you can catch it by >
7357 :catch /^Vim(\a\+):E121:/
7359 You can catch all errors related to the name "nofunc" by >
7360 :catch /\<nofunc\>/
7362 You can catch all Vim errors in the ":write" and ":read" commands by >
7363 :catch /^Vim(\(write\|read\)):E\d\+:/
7365 You can catch all Vim errors by the pattern >
7366 :catch /^Vim\((\a\+)\)\=:E\d\+:/
7367 <
7368 *catch-text*
7369 NOTE: You should never catch the error message text itself: >
7370 :catch /No such variable/
7371 only works in the english locale, but not when the user has selected
7372 a different language by the |:language| command. It is however helpful to
7373 cite the message text in a comment: >
7374 :catch /^Vim(\a\+):E108:/ " No such variable
7377 IGNORING ERRORS *ignore-errors*
7379 You can ignore errors in a specific Vim command by catching them locally: >
7381 :try
7382 : write
7383 :catch
7384 :endtry
7386 But you are strongly recommended NOT to use this simple form, since it could
7387 catch more than you want. With the ":write" command, some autocommands could
7388 be executed and cause errors not related to writing, for instance: >
7390 :au BufWritePre * unlet novar
7392 There could even be such errors you are not responsible for as a script
7393 writer: a user of your script might have defined such autocommands. You would
7394 then hide the error from the user.
7395 It is much better to use >
7397 :try
7398 : write
7399 :catch /^Vim(write):/
7400 :endtry
7402 which only catches real write errors. So catch only what you'd like to ignore
7403 intentionally.
7405 For a single command that does not cause execution of autocommands, you could
7406 even suppress the conversion of errors to exceptions by the ":silent!"
7407 command: >
7408 :silent! nunmap k
7409 This works also when a try conditional is active.
7412 CATCHING INTERRUPTS *catch-interrupt*
7414 When there are active try conditionals, an interrupt (CTRL-C) is converted to
7415 the exception "Vim:Interrupt". You can catch it like every exception. The
7416 script is not terminated, then.
7417 Example: >
7419 :function! TASK1()
7420 : sleep 10
7421 :endfunction
7423 :function! TASK2()
7424 : sleep 20
7425 :endfunction
7427 :while 1
7428 : let command = input("Type a command: ")
7429 : try
7430 : if command == ""
7431 : continue
7432 : elseif command == "END"
7433 : break
7434 : elseif command == "TASK1"
7435 : call TASK1()
7436 : elseif command == "TASK2"
7437 : call TASK2()
7438 : else
7439 : echo "\nIllegal command:" command
7440 : continue
7441 : endif
7442 : catch /^Vim:Interrupt$/
7443 : echo "\nCommand interrupted"
7444 : " Caught the interrupt. Continue with next prompt.
7445 : endtry
7446 :endwhile
7448 You can interrupt a task here by pressing CTRL-C; the script then asks for
7449 a new command. If you press CTRL-C at the prompt, the script is terminated.
7451 For testing what happens when CTRL-C would be pressed on a specific line in
7452 your script, use the debug mode and execute the |>quit| or |>interrupt|
7453 command on that line. See |debug-scripts|.
7456 CATCHING ALL *catch-all*
7458 The commands >
7460 :catch /.*/
7461 :catch //
7462 :catch
7464 catch everything, error exceptions, interrupt exceptions and exceptions
7465 explicitly thrown by the |:throw| command. This is useful at the top level of
7466 a script in order to catch unexpected things.
7467 Example: >
7469 :try
7470 :
7471 : " do the hard work here
7472 :
7473 :catch /MyException/
7474 :
7475 : " handle known problem
7476 :
7477 :catch /^Vim:Interrupt$/
7478 : echo "Script interrupted"
7479 :catch /.*/
7480 : echo "Internal error (" . v:exception . ")"
7481 : echo " - occurred at " . v:throwpoint
7482 :endtry
7483 :" end of script
7485 Note: Catching all might catch more things than you want. Thus, you are
7486 strongly encouraged to catch only for problems that you can really handle by
7487 specifying a pattern argument to the ":catch".
7488 Example: Catching all could make it nearly impossible to interrupt a script
7489 by pressing CTRL-C: >
7491 :while 1
7492 : try
7493 : sleep 1
7494 : catch
7495 : endtry
7496 :endwhile
7499 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd*
7501 Exceptions may be used during execution of autocommands. Example: >
7503 :autocmd User x try
7504 :autocmd User x throw "Oops!"
7505 :autocmd User x catch
7506 :autocmd User x echo v:exception
7507 :autocmd User x endtry
7508 :autocmd User x throw "Arrgh!"
7509 :autocmd User x echo "Should not be displayed"
7510 :
7511 :try
7512 : doautocmd User x
7513 :catch
7514 : echo v:exception
7515 :endtry
7517 This displays "Oops!" and "Arrgh!".
7519 *except-autocmd-Pre*
7520 For some commands, autocommands get executed before the main action of the
7521 command takes place. If an exception is thrown and not caught in the sequence
7522 of autocommands, the sequence and the command that caused its execution are
7523 abandoned and the exception is propagated to the caller of the command.
7524 Example: >
7526 :autocmd BufWritePre * throw "FAIL"
7527 :autocmd BufWritePre * echo "Should not be displayed"
7528 :
7529 :try
7530 : write
7531 :catch
7532 : echo "Caught:" v:exception "from" v:throwpoint
7533 :endtry
7535 Here, the ":write" command does not write the file currently being edited (as
7536 you can see by checking 'modified'), since the exception from the BufWritePre
7537 autocommand abandons the ":write". The exception is then caught and the
7538 script displays: >
7540 Caught: FAIL from BufWrite Auto commands for "*"
7541 <
7542 *except-autocmd-Post*
7543 For some commands, autocommands get executed after the main action of the
7544 command has taken place. If this main action fails and the command is inside
7545 an active try conditional, the autocommands are skipped and an error exception
7546 is thrown that can be caught by the caller of the command.
7547 Example: >
7549 :autocmd BufWritePost * echo "File successfully written!"
7550 :
7551 :try
7552 : write /i/m/p/o/s/s/i/b/l/e
7553 :catch
7554 : echo v:exception
7555 :endtry
7557 This just displays: >
7559 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e)
7561 If you really need to execute the autocommands even when the main action
7562 fails, trigger the event from the catch clause.
7563 Example: >
7565 :autocmd BufWritePre * set noreadonly
7566 :autocmd BufWritePost * set readonly
7567 :
7568 :try
7569 : write /i/m/p/o/s/s/i/b/l/e
7570 :catch
7571 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e
7572 :endtry
7573 <
7574 You can also use ":silent!": >
7576 :let x = "ok"
7577 :let v:errmsg = ""
7578 :autocmd BufWritePost * if v:errmsg != ""
7579 :autocmd BufWritePost * let x = "after fail"
7580 :autocmd BufWritePost * endif
7581 :try
7582 : silent! write /i/m/p/o/s/s/i/b/l/e
7583 :catch
7584 :endtry
7585 :echo x
7587 This displays "after fail".
7589 If the main action of the command does not fail, exceptions from the
7590 autocommands will be catchable by the caller of the command: >
7592 :autocmd BufWritePost * throw ":-("
7593 :autocmd BufWritePost * echo "Should not be displayed"
7594 :
7595 :try
7596 : write
7597 :catch
7598 : echo v:exception
7599 :endtry
7600 <
7601 *except-autocmd-Cmd*
7602 For some commands, the normal action can be replaced by a sequence of
7603 autocommands. Exceptions from that sequence will be catchable by the caller
7604 of the command.
7605 Example: For the ":write" command, the caller cannot know whether the file
7606 had actually been written when the exception occurred. You need to tell it in
7607 some way. >
7609 :if !exists("cnt")
7610 : let cnt = 0
7611 :
7612 : autocmd BufWriteCmd * if &modified
7613 : autocmd BufWriteCmd * let cnt = cnt + 1
7614 : autocmd BufWriteCmd * if cnt % 3 == 2
7615 : autocmd BufWriteCmd * throw "BufWriteCmdError"
7616 : autocmd BufWriteCmd * endif
7617 : autocmd BufWriteCmd * write | set nomodified
7618 : autocmd BufWriteCmd * if cnt % 3 == 0
7619 : autocmd BufWriteCmd * throw "BufWriteCmdError"
7620 : autocmd BufWriteCmd * endif
7621 : autocmd BufWriteCmd * echo "File successfully written!"
7622 : autocmd BufWriteCmd * endif
7623 :endif
7624 :
7625 :try
7626 : write
7627 :catch /^BufWriteCmdError$/
7628 : if &modified
7629 : echo "Error on writing (file contents not changed)"
7630 : else
7631 : echo "Error after writing"
7632 : endif
7633 :catch /^Vim(write):/
7634 : echo "Error on writing"
7635 :endtry
7637 When this script is sourced several times after making changes, it displays
7638 first >
7639 File successfully written!
7640 then >
7641 Error on writing (file contents not changed)
7642 then >
7643 Error after writing
7644 etc.
7646 *except-autocmd-ill*
7647 You cannot spread a try conditional over autocommands for different events.
7648 The following code is ill-formed: >
7650 :autocmd BufWritePre * try
7651 :
7652 :autocmd BufWritePost * catch
7653 :autocmd BufWritePost * echo v:exception
7654 :autocmd BufWritePost * endtry
7655 :
7656 :write
7659 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param*
7661 Some programming languages allow to use hierarchies of exception classes or to
7662 pass additional information with the object of an exception class. You can do
7663 similar things in Vim.
7664 In order to throw an exception from a hierarchy, just throw the complete
7665 class name with the components separated by a colon, for instance throw the
7666 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library.
7667 When you want to pass additional information with your exception class, add
7668 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)"
7669 for an error when writing "myfile".
7670 With the appropriate patterns in the ":catch" command, you can catch for
7671 base classes or derived classes of your hierarchy. Additional information in
7672 parentheses can be cut out from |v:exception| with the ":substitute" command.
7673 Example: >
7675 :function! CheckRange(a, func)
7676 : if a:a < 0
7677 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")"
7678 : endif
7679 :endfunction
7680 :
7681 :function! Add(a, b)
7682 : call CheckRange(a:a, "Add")
7683 : call CheckRange(a:b, "Add")
7684 : let c = a:a + a:b
7685 : if c < 0
7686 : throw "EXCEPT:MATHERR:OVERFLOW"
7687 : endif
7688 : return c
7689 :endfunction
7690 :
7691 :function! Div(a, b)
7692 : call CheckRange(a:a, "Div")
7693 : call CheckRange(a:b, "Div")
7694 : if (a:b == 0)
7695 : throw "EXCEPT:MATHERR:ZERODIV"
7696 : endif
7697 : return a:a / a:b
7698 :endfunction
7699 :
7700 :function! Write(file)
7701 : try
7702 : execute "write" fnameescape(a:file)
7703 : catch /^Vim(write):/
7704 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR"
7705 : endtry
7706 :endfunction
7707 :
7708 :try
7709 :
7710 : " something with arithmetics and I/O
7711 :
7712 :catch /^EXCEPT:MATHERR:RANGE/
7713 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "")
7714 : echo "Range error in" function
7715 :
7716 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV
7717 : echo "Math error"
7718 :
7719 :catch /^EXCEPT:IO/
7720 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "")
7721 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "")
7722 : if file !~ '^/'
7723 : let file = dir . "/" . file
7724 : endif
7725 : echo 'I/O error for "' . file . '"'
7726 :
7727 :catch /^EXCEPT/
7728 : echo "Unspecified error"
7729 :
7730 :endtry
7732 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use
7733 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself
7734 exceptions with the "Vim" prefix; they are reserved for Vim.
7735 Vim error exceptions are parameterized with the name of the command that
7736 failed, if known. See |catch-errors|.
7739 PECULIARITIES
7740 *except-compat*
7741 The exception handling concept requires that the command sequence causing the
7742 exception is aborted immediately and control is transferred to finally clauses
7743 and/or a catch clause.
7745 In the Vim script language there are cases where scripts and functions
7746 continue after an error: in functions without the "abort" flag or in a command
7747 after ":silent!", control flow goes to the following line, and outside
7748 functions, control flow goes to the line following the outermost ":endwhile"
7749 or ":endif". On the other hand, errors should be catchable as exceptions
7750 (thus, requiring the immediate abortion).
7752 This problem has been solved by converting errors to exceptions and using
7753 immediate abortion (if not suppressed by ":silent!") only when a try
7754 conditional is active. This is no restriction since an (error) exception can
7755 be caught only from an active try conditional. If you want an immediate
7756 termination without catching the error, just use a try conditional without
7757 catch clause. (You can cause cleanup code being executed before termination
7758 by specifying a finally clause.)
7760 When no try conditional is active, the usual abortion and continuation
7761 behavior is used instead of immediate abortion. This ensures compatibility of
7762 scripts written for Vim 6.1 and earlier.
7764 However, when sourcing an existing script that does not use exception handling
7765 commands (or when calling one of its functions) from inside an active try
7766 conditional of a new script, you might change the control flow of the existing
7767 script on error. You get the immediate abortion on error and can catch the
7768 error in the new script. If however the sourced script suppresses error
7769 messages by using the ":silent!" command (checking for errors by testing
7770 |v:errmsg| if appropriate), its execution path is not changed. The error is
7771 not converted to an exception. (See |:silent|.) So the only remaining cause
7772 where this happens is for scripts that don't care about errors and produce
7773 error messages. You probably won't want to use such code from your new
7774 scripts.
7776 *except-syntax-err*
7777 Syntax errors in the exception handling commands are never caught by any of
7778 the ":catch" commands of the try conditional they belong to. Its finally
7779 clauses, however, is executed.
7780 Example: >
7782 :try
7783 : try
7784 : throw 4711
7785 : catch /\(/
7786 : echo "in catch with syntax error"
7787 : catch
7788 : echo "inner catch-all"
7789 : finally
7790 : echo "inner finally"
7791 : endtry
7792 :catch
7793 : echo 'outer catch-all caught "' . v:exception . '"'
7794 : finally
7795 : echo "outer finally"
7796 :endtry
7798 This displays: >
7799 inner finally
7800 outer catch-all caught "Vim(catch):E54: Unmatched \("
7801 outer finally
7802 The original exception is discarded and an error exception is raised, instead.
7804 *except-single-line*
7805 The ":try", ":catch", ":finally", and ":endtry" commands can be put on
7806 a single line, but then syntax errors may make it difficult to recognize the
7807 "catch" line, thus you better avoid this.
7808 Example: >
7809 :try | unlet! foo # | catch | endtry
7810 raises an error exception for the trailing characters after the ":unlet!"
7811 argument, but does not see the ":catch" and ":endtry" commands, so that the
7812 error exception is discarded and the "E488: Trailing characters" message gets
7813 displayed.
7815 *except-several-errors*
7816 When several errors appear in a single command, the first error message is
7817 usually the most specific one and therefor converted to the error exception.
7818 Example: >
7819 echo novar
7820 causes >
7821 E121: Undefined variable: novar
7822 E15: Invalid expression: novar
7823 The value of the error exception inside try conditionals is: >
7824 Vim(echo):E121: Undefined variable: novar
7825 < *except-syntax-error*
7826 But when a syntax error is detected after a normal error in the same command,
7827 the syntax error is used for the exception being thrown.
7828 Example: >
7829 unlet novar #
7830 causes >
7831 E108: No such variable: "novar"
7832 E488: Trailing characters
7833 The value of the error exception inside try conditionals is: >
7834 Vim(unlet):E488: Trailing characters
7835 This is done because the syntax error might change the execution path in a way
7836 not intended by the user. Example: >
7837 try
7838 try | unlet novar # | catch | echo v:exception | endtry
7839 catch /.*/
7840 echo "outer catch:" v:exception
7841 endtry
7842 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then
7843 a "E600: Missing :endtry" error message is given, see |except-single-line|.
7845 ==============================================================================
7846 9. Examples *eval-examples*
7848 Printing in Binary ~
7849 >
7850 :" The function Nr2Bin() returns the binary string representation of a number.
7851 :func Nr2Bin(nr)
7852 : let n = a:nr
7853 : let r = ""
7854 : while n
7855 : let r = '01'[n % 2] . r
7856 : let n = n / 2
7857 : endwhile
7858 : return r
7859 :endfunc
7861 :" The function String2Bin() converts each character in a string to a
7862 :" binary string, separated with dashes.
7863 :func String2Bin(str)
7864 : let out = ''
7865 : for ix in range(strlen(a:str))
7866 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix]))
7867 : endfor
7868 : return out[1:]
7869 :endfunc
7871 Example of its use: >
7872 :echo Nr2Bin(32)
7873 result: "100000" >
7874 :echo String2Bin("32")
7875 result: "110011-110010"
7878 Sorting lines ~
7880 This example sorts lines with a specific compare function. >
7882 :func SortBuffer()
7883 : let lines = getline(1, '$')
7884 : call sort(lines, function("Strcmp"))
7885 : call setline(1, lines)
7886 :endfunction
7888 As a one-liner: >
7889 :call setline(1, sort(getline(1, '$'), function("Strcmp")))
7892 scanf() replacement ~
7893 *sscanf*
7894 There is no sscanf() function in Vim. If you need to extract parts from a
7895 line, you can use matchstr() and substitute() to do it. This example shows
7896 how to get the file name, line number and column number out of a line like
7897 "foobar.txt, 123, 45". >
7898 :" Set up the match bit
7899 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)'
7900 :"get the part matching the whole expression
7901 :let l = matchstr(line, mx)
7902 :"get each item out of the match
7903 :let file = substitute(l, mx, '\1', '')
7904 :let lnum = substitute(l, mx, '\2', '')
7905 :let col = substitute(l, mx, '\3', '')
7907 The input is in the variable "line", the results in the variables "file",
7908 "lnum" and "col". (idea from Michael Geddes)
7911 getting the scriptnames in a Dictionary ~
7912 *scriptnames-dictionary*
7913 The |:scriptnames| command can be used to get a list of all script files that
7914 have been sourced. There is no equivalent function or variable for this
7915 (because it's rarely needed). In case you need to manipulate the list this
7916 code can be used: >
7917 " Get the output of ":scriptnames" in the scriptnames_output variable.
7918 let scriptnames_output = ''
7919 redir => scriptnames_output
7920 silent scriptnames
7921 redir END
7923 " Split the output into lines and parse each line. Add an entry to the
7924 " "scripts" dictionary.
7925 let scripts = {}
7926 for line in split(scriptnames_output, "\n")
7927 " Only do non-blank lines.
7928 if line =~ '\S'
7929 " Get the first number in the line.
7930 let nr = matchstr(line, '\d\+')
7931 " Get the file name, remove the script number " 123: ".
7932 let name = substitute(line, '.\+:\s*', '', '')
7933 " Add an item to the Dictionary
7934 let scripts[nr] = name
7935 endif
7936 endfor
7937 unlet scriptnames_output
7939 ==============================================================================
7940 10. No +eval feature *no-eval-feature*
7942 When the |+eval| feature was disabled at compile time, none of the expression
7943 evaluation commands are available. To prevent this from causing Vim scripts
7944 to generate all kinds of errors, the ":if" and ":endif" commands are still
7945 recognized, though the argument of the ":if" and everything between the ":if"
7946 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but
7947 only if the commands are at the start of the line. The ":else" command is not
7948 recognized.
7950 Example of how to avoid executing commands when the |+eval| feature is
7951 missing: >
7953 :if 1
7954 : echo "Expression evaluation is compiled in"
7955 :else
7956 : echo "You will _never_ see this message"
7957 :endif
7959 ==============================================================================
7960 11. The sandbox *eval-sandbox* *sandbox* *E48*
7962 The 'foldexpr', 'includeexpr', 'indentexpr', 'statusline' and 'foldtext'
7963 options are evaluated in a sandbox. This means that you are protected from
7964 these expressions having nasty side effects. This gives some safety for when
7965 these options are set from a modeline. It is also used when the command from
7966 a tags file is executed and for CTRL-R = in the command line.
7967 The sandbox is also used for the |:sandbox| command.
7969 These items are not allowed in the sandbox:
7970 - changing the buffer text
7971 - defining or changing mapping, autocommands, functions, user commands
7972 - setting certain options (see |option-summary|)
7973 - setting certain v: variables (see |v:var|) *E794*
7974 - executing a shell command
7975 - reading or writing a file
7976 - jumping to another buffer or editing a file
7977 - executing Python, Perl, etc. commands
7978 This is not guaranteed 100% secure, but it should block most attacks.
7980 *:san* *:sandbox*
7981 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an
7982 option that may have been set from a modeline, e.g.
7983 'foldexpr'.
7985 *sandbox-option*
7986 A few options contain an expression. When this expression is evaluated it may
7987 have to be done in the sandbox to avoid a security risk. But the sandbox is
7988 restrictive, thus this only happens when the option was set from an insecure
7989 location. Insecure in this context are:
7990 - sourcing a .vimrc or .exrc in the current directory
7991 - while executing in the sandbox
7992 - value coming from a modeline
7994 Note that when in the sandbox and saving an option value and restoring it, the
7995 option will still be marked as it was set in the sandbox.
7997 ==============================================================================
7998 12. Textlock *textlock*
8000 In a few situations it is not allowed to change the text in the buffer, jump
8001 to another window and some other things that might confuse or break what Vim
8002 is currently doing. This mostly applies to things that happen when Vim is
8003 actually doing something else. For example, evaluating the 'balloonexpr' may
8004 happen any moment the mouse cursor is resting at some position.
8006 This is not allowed when the textlock is active:
8007 - changing the buffer text
8008 - jumping to another buffer or window
8009 - editing another file
8010 - closing a window or quitting Vim
8011 - etc.
8014 vim:tw=78:ts=8:ft=help:norl: