| blob | 2a8931a1b9ad723730ddd5af1af0bb13f27fa8b5 |
1 *eval.txt* For Vim version 7.1. Last change: 2007 Sep 25
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 five types of variables:
42 Number A 32 bit signed number.
43 Examples: -123 0x10 0177
45 String A NUL terminated string of 8-bit unsigned characters (bytes).
46 Examples: "ab\txx\"--" 'x-z''a,c'
48 Funcref A reference to a function |Funcref|.
49 Example: function("strlen")
51 List An ordered sequence of items |List|.
52 Example: [1, 2, ['a', 'b']]
54 Dictionary An associative, unordered array: Each entry has a key and a
55 value. |Dictionary|
56 Example: {'blue': "#0000ff", 'red': "#ff0000"}
58 The Number and String types are converted automatically, depending on how they
59 are used.
61 Conversion from a Number to a String is by making the ASCII representation of
62 the Number. Examples: >
63 Number 123 --> String "123"
64 Number 0 --> String "0"
65 Number -1 --> String "-1"
67 Conversion from a String to a Number is done by converting the first digits
68 to a number. Hexadecimal "0xf9" and Octal "017" numbers are recognized. If
69 the String doesn't start with digits, the result is zero. Examples: >
70 String "456" --> Number 456
71 String "6bar" --> Number 6
72 String "foo" --> Number 0
73 String "0xf1" --> Number 241
74 String "0100" --> Number 64
75 String "-8" --> Number -8
76 String "+8" --> Number 0
78 To force conversion from String to Number, add zero to it: >
79 :echo "0100" + 0
80 < 64 ~
82 To avoid a leading zero to cause octal conversion, or for using a different
83 base, use |str2nr()|.
85 For boolean operators Numbers are used. Zero is FALSE, non-zero is TRUE.
87 Note that in the command >
88 :if "foo"
89 "foo" is converted to 0, which means FALSE. To test for a non-empty string,
90 use strlen(): >
91 :if strlen("foo")
92 < *E745* *E728* *E703* *E729* *E730* *E731*
93 List, Dictionary and Funcref types are not automatically converted.
95 *E706*
96 You will get an error if you try to change the type of a variable. You need
97 to |:unlet| it first to avoid this error. String and Number are considered
98 equivalent though. Consider this sequence of commands: >
99 :let l = "string"
100 :let l = 44 " changes type from String to Number
101 :let l = [1, 2, 3] " error!
104 1.2 Function references ~
105 *Funcref* *E695* *E718*
106 A Funcref variable is obtained with the |function()| function. It can be used
107 in an expression in the place of a function name, before the parenthesis
108 around the arguments, to invoke the function it refers to. Example: >
110 :let Fn = function("MyFunc")
111 :echo Fn()
112 < *E704* *E705* *E707*
113 A Funcref variable must start with a capital, "s:", "w:", "t:" or "b:". You
114 cannot have both a Funcref variable and a function with the same name.
116 A special case is defining a function and directly assigning its Funcref to a
117 Dictionary entry. Example: >
118 :function dict.init() dict
119 : let self.val = 0
120 :endfunction
122 The key of the Dictionary can start with a lower case letter. The actual
123 function name is not used here. Also see |numbered-function|.
125 A Funcref can also be used with the |:call| command: >
126 :call Fn()
127 :call dict.init()
129 The name of the referenced function can be obtained with |string()|. >
130 :let func = string(Fn)
132 You can use |call()| to invoke a Funcref and use a list variable for the
133 arguments: >
134 :let r = call(Fn, mylist)
137 1.3 Lists ~
138 *List* *Lists* *E686*
139 A List is an ordered sequence of items. An item can be of any type. Items
140 can be accessed by their index number. Items can be added and removed at any
141 position in the sequence.
144 List creation ~
145 *E696* *E697*
146 A List is created with a comma separated list of items in square brackets.
147 Examples: >
148 :let mylist = [1, two, 3, "four"]
149 :let emptylist = []
151 An item can be any expression. Using a List for an item creates a
152 List of Lists: >
153 :let nestlist = [[11, 12], [21, 22], [31, 32]]
155 An extra comma after the last item is ignored.
158 List index ~
159 *list-index* *E684*
160 An item in the List can be accessed by putting the index in square brackets
161 after the List. Indexes are zero-based, thus the first item has index zero. >
162 :let item = mylist[0] " get the first item: 1
163 :let item = mylist[2] " get the third item: 3
165 When the resulting item is a list this can be repeated: >
166 :let item = nestlist[0][1] " get the first list, second item: 12
167 <
168 A negative index is counted from the end. Index -1 refers to the last item in
169 the List, -2 to the last but one item, etc. >
170 :let last = mylist[-1] " get the last item: "four"
172 To avoid an error for an invalid index use the |get()| function. When an item
173 is not available it returns zero or the default value you specify: >
174 :echo get(mylist, idx)
175 :echo get(mylist, idx, "NONE")
178 List concatenation ~
180 Two lists can be concatenated with the "+" operator: >
181 :let longlist = mylist + [5, 6]
182 :let mylist += [7, 8]
184 To prepend or append an item turn the item into a list by putting [] around
185 it. To change a list in-place see |list-modification| below.
188 Sublist ~
190 A part of the List can be obtained by specifying the first and last index,
191 separated by a colon in square brackets: >
192 :let shortlist = mylist[2:-1] " get List [3, "four"]
194 Omitting the first index is similar to zero. Omitting the last index is
195 similar to -1. >
196 :let endlist = mylist[2:] " from item 2 to the end: [3, "four"]
197 :let shortlist = mylist[2:2] " List with one item: [3]
198 :let otherlist = mylist[:] " make a copy of the List
200 If the first index is beyond the last item of the List or the second item is
201 before the first item, the result is an empty list. There is no error
202 message.
204 If the second index is equal to or greater than the length of the list the
205 length minus one is used: >
206 :let mylist = [0, 1, 2, 3]
207 :echo mylist[2:8] " result: [2, 3]
209 NOTE: mylist[s:e] means using the variable "s:e" as index. Watch out for
210 using a single letter variable before the ":". Insert a space when needed:
211 mylist[s : e].
214 List identity ~
215 *list-identity*
216 When variable "aa" is a list and you assign it to another variable "bb", both
217 variables refer to the same list. Thus changing the list "aa" will also
218 change "bb": >
219 :let aa = [1, 2, 3]
220 :let bb = aa
221 :call add(aa, 4)
222 :echo bb
223 < [1, 2, 3, 4]
225 Making a copy of a list is done with the |copy()| function. Using [:] also
226 works, as explained above. This creates a shallow copy of the list: Changing
227 a list item in the list will also change the item in the copied list: >
228 :let aa = [[1, 'a'], 2, 3]
229 :let bb = copy(aa)
230 :call add(aa, 4)
231 :let aa[0][1] = 'aaa'
232 :echo aa
233 < [[1, aaa], 2, 3, 4] >
234 :echo bb
235 < [[1, aaa], 2, 3]
237 To make a completely independent list use |deepcopy()|. This also makes a
238 copy of the values in the list, recursively. Up to a hundred levels deep.
240 The operator "is" can be used to check if two variables refer to the same
241 List. "isnot" does the opposite. In contrast "==" compares if two lists have
242 the same value. >
243 :let alist = [1, 2, 3]
244 :let blist = [1, 2, 3]
245 :echo alist is blist
246 < 0 >
247 :echo alist == blist
248 < 1
250 Note about comparing lists: Two lists are considered equal if they have the
251 same length and all items compare equal, as with using "==". There is one
252 exception: When comparing a number with a string they are considered
253 different. There is no automatic type conversion, as with using "==" on
254 variables. Example: >
255 echo 4 == "4"
256 < 1 >
257 echo [4] == ["4"]
258 < 0
260 Thus comparing Lists is more strict than comparing numbers and strings. You
261 can compare simple values this way too by putting them in a string: >
263 :let a = 5
264 :let b = "5"
265 echo a == b
266 < 1 >
267 echo [a] == [b]
268 < 0
271 List unpack ~
273 To unpack the items in a list to individual variables, put the variables in
274 square brackets, like list items: >
275 :let [var1, var2] = mylist
277 When the number of variables does not match the number of items in the list
278 this produces an error. To handle any extra items from the list append ";"
279 and a variable name: >
280 :let [var1, var2; rest] = mylist
282 This works like: >
283 :let var1 = mylist[0]
284 :let var2 = mylist[1]
285 :let rest = mylist[2:]
287 Except that there is no error if there are only two items. "rest" will be an
288 empty list then.
291 List modification ~
292 *list-modification*
293 To change a specific item of a list use |:let| this way: >
294 :let list[4] = "four"
295 :let listlist[0][3] = item
297 To change part of a list you can specify the first and last item to be
298 modified. The value must at least have the number of items in the range: >
299 :let list[3:5] = [3, 4, 5]
301 Adding and removing items from a list is done with functions. Here are a few
302 examples: >
303 :call insert(list, 'a') " prepend item 'a'
304 :call insert(list, 'a', 3) " insert item 'a' before list[3]
305 :call add(list, "new") " append String item
306 :call add(list, [1, 2]) " append a List as one new item
307 :call extend(list, [1, 2]) " extend the list with two more items
308 :let i = remove(list, 3) " remove item 3
309 :unlet list[3] " idem
310 :let l = remove(list, 3, -1) " remove items 3 to last item
311 :unlet list[3 : ] " idem
312 :call filter(list, 'v:val !~ "x"') " remove items with an 'x'
314 Changing the order of items in a list: >
315 :call sort(list) " sort a list alphabetically
316 :call reverse(list) " reverse the order of items
319 For loop ~
321 The |:for| loop executes commands for each item in a list. A variable is set
322 to each item in the list in sequence. Example: >
323 :for item in mylist
324 : call Doit(item)
325 :endfor
327 This works like: >
328 :let index = 0
329 :while index < len(mylist)
330 : let item = mylist[index]
331 : :call Doit(item)
332 : let index = index + 1
333 :endwhile
335 Note that all items in the list should be of the same type, otherwise this
336 results in error |E706|. To avoid this |:unlet| the variable at the end of
337 the loop.
339 If all you want to do is modify each item in the list then the |map()|
340 function will be a simpler method than a for loop.
342 Just like the |:let| command, |:for| also accepts a list of variables. This
343 requires the argument to be a list of lists. >
344 :for [lnum, col] in [[1, 3], [2, 8], [3, 0]]
345 : call Doit(lnum, col)
346 :endfor
348 This works like a |:let| command is done for each list item. Again, the types
349 must remain the same to avoid an error.
351 It is also possible to put remaining items in a List variable: >
352 :for [i, j; rest] in listlist
353 : call Doit(i, j)
354 : if !empty(rest)
355 : echo "remainder: " . string(rest)
356 : endif
357 :endfor
360 List functions ~
361 *E714*
362 Functions that are useful with a List: >
363 :let r = call(funcname, list) " call a function with an argument list
364 :if empty(list) " check if list is empty
365 :let l = len(list) " number of items in list
366 :let big = max(list) " maximum value in list
367 :let small = min(list) " minimum value in list
368 :let xs = count(list, 'x') " count nr of times 'x' appears in list
369 :let i = index(list, 'x') " index of first 'x' in list
370 :let lines = getline(1, 10) " get ten text lines from buffer
371 :call append('$', lines) " append text lines in buffer
372 :let list = split("a b c") " create list from items in a string
373 :let string = join(list, ', ') " create string from list items
374 :let s = string(list) " String representation of list
375 :call map(list, '">> " . v:val') " prepend ">> " to each item
377 Don't forget that a combination of features can make things simple. For
378 example, to add up all the numbers in a list: >
379 :exe 'let sum = ' . join(nrlist, '+')
382 1.4 Dictionaries ~
383 *Dictionaries* *Dictionary*
384 A Dictionary is an associative array: Each entry has a key and a value. The
385 entry can be located with the key. The entries are stored without a specific
386 ordering.
389 Dictionary creation ~
390 *E720* *E721* *E722* *E723*
391 A Dictionary is created with a comma separated list of entries in curly
392 braces. Each entry has a key and a value, separated by a colon. Each key can
393 only appear once. Examples: >
394 :let mydict = {1: 'one', 2: 'two', 3: 'three'}
395 :let emptydict = {}
396 < *E713* *E716* *E717*
397 A key is always a String. You can use a Number, it will be converted to a
398 String automatically. Thus the String '4' and the number 4 will find the same
399 entry. Note that the String '04' and the Number 04 are different, since the
400 Number will be converted to the String '4'.
402 A value can be any expression. Using a Dictionary for a value creates a
403 nested Dictionary: >
404 :let nestdict = {1: {11: 'a', 12: 'b'}, 2: {21: 'c'}}
406 An extra comma after the last entry is ignored.
409 Accessing entries ~
411 The normal way to access an entry is by putting the key in square brackets: >
412 :let val = mydict["one"]
413 :let mydict["four"] = 4
415 You can add new entries to an existing Dictionary this way, unlike Lists.
417 For keys that consist entirely of letters, digits and underscore the following
418 form can be used |expr-entry|: >
419 :let val = mydict.one
420 :let mydict.four = 4
422 Since an entry can be any type, also a List and a Dictionary, the indexing and
423 key lookup can be repeated: >
424 :echo dict.key[idx].key
427 Dictionary to List conversion ~
429 You may want to loop over the entries in a dictionary. For this you need to
430 turn the Dictionary into a List and pass it to |:for|.
432 Most often you want to loop over the keys, using the |keys()| function: >
433 :for key in keys(mydict)
434 : echo key . ': ' . mydict[key]
435 :endfor
437 The List of keys is unsorted. You may want to sort them first: >
438 :for key in sort(keys(mydict))
440 To loop over the values use the |values()| function: >
441 :for v in values(mydict)
442 : echo "value: " . v
443 :endfor
445 If you want both the key and the value use the |items()| function. It returns
446 a List in which each item is a List with two items, the key and the value: >
447 :for [key, value] in items(mydict)
448 : echo key . ': ' . value
449 :endfor
452 Dictionary identity ~
453 *dict-identity*
454 Just like Lists you need to use |copy()| and |deepcopy()| to make a copy of a
455 Dictionary. Otherwise, assignment results in referring to the same
456 Dictionary: >
457 :let onedict = {'a': 1, 'b': 2}
458 :let adict = onedict
459 :let adict['a'] = 11
460 :echo onedict['a']
461 11
463 Two Dictionaries compare equal if all the key-value pairs compare equal. For
464 more info see |list-identity|.
467 Dictionary modification ~
468 *dict-modification*
469 To change an already existing entry of a Dictionary, or to add a new entry,
470 use |:let| this way: >
471 :let dict[4] = "four"
472 :let dict['one'] = item
474 Removing an entry from a Dictionary is done with |remove()| or |:unlet|.
475 Three ways to remove the entry with key "aaa" from dict: >
476 :let i = remove(dict, 'aaa')
477 :unlet dict.aaa
478 :unlet dict['aaa']
480 Merging a Dictionary with another is done with |extend()|: >
481 :call extend(adict, bdict)
482 This extends adict with all entries from bdict. Duplicate keys cause entries
483 in adict to be overwritten. An optional third argument can change this.
484 Note that the order of entries in a Dictionary is irrelevant, thus don't
485 expect ":echo adict" to show the items from bdict after the older entries in
486 adict.
488 Weeding out entries from a Dictionary can be done with |filter()|: >
489 :call filter(dict, 'v:val =~ "x"')
490 This removes all entries from "dict" with a value not matching 'x'.
493 Dictionary function ~
494 *Dictionary-function* *self* *E725*
495 When a function is defined with the "dict" attribute it can be used in a
496 special way with a dictionary. Example: >
497 :function Mylen() dict
498 : return len(self.data)
499 :endfunction
500 :let mydict = {'data': [0, 1, 2, 3], 'len': function("Mylen")}
501 :echo mydict.len()
503 This is like a method in object oriented programming. The entry in the
504 Dictionary is a |Funcref|. The local variable "self" refers to the dictionary
505 the function was invoked from.
507 It is also possible to add a function without the "dict" attribute as a
508 Funcref to a Dictionary, but the "self" variable is not available then.
510 *numbered-function* *anonymous-function*
511 To avoid the extra name for the function it can be defined and directly
512 assigned to a Dictionary in this way: >
513 :let mydict = {'data': [0, 1, 2, 3]}
514 :function mydict.len() dict
515 : return len(self.data)
516 :endfunction
517 :echo mydict.len()
519 The function will then get a number and the value of dict.len is a |Funcref|
520 that references this function. The function can only be used through a
521 |Funcref|. It will automatically be deleted when there is no |Funcref|
522 remaining that refers to it.
524 It is not necessary to use the "dict" attribute for a numbered function.
527 Functions for Dictionaries ~
528 *E715*
529 Functions that can be used with a Dictionary: >
530 :if has_key(dict, 'foo') " TRUE if dict has entry with key "foo"
531 :if empty(dict) " TRUE if dict is empty
532 :let l = len(dict) " number of items in dict
533 :let big = max(dict) " maximum value in dict
534 :let small = min(dict) " minimum value in dict
535 :let xs = count(dict, 'x') " count nr of times 'x' appears in dict
536 :let s = string(dict) " String representation of dict
537 :call map(dict, '">> " . v:val') " prepend ">> " to each item
540 1.5 More about variables ~
541 *more-variables*
542 If you need to know the type of a variable or expression, use the |type()|
543 function.
545 When the '!' flag is included in the 'viminfo' option, global variables that
546 start with an uppercase letter, and don't contain a lowercase letter, are
547 stored in the viminfo file |viminfo-file|.
549 When the 'sessionoptions' option contains "global", global variables that
550 start with an uppercase letter and contain at least one lowercase letter are
551 stored in the session file |session-file|.
553 variable name can be stored where ~
554 my_var_6 not
555 My_Var_6 session file
556 MY_VAR_6 viminfo file
559 It's possible to form a variable name with curly braces, see
560 |curly-braces-names|.
562 ==============================================================================
563 2. Expression syntax *expression-syntax*
565 Expression syntax summary, from least to most significant:
567 |expr1| expr2 ? expr1 : expr1 if-then-else
569 |expr2| expr3 || expr3 .. logical OR
571 |expr3| expr4 && expr4 .. logical AND
573 |expr4| expr5 == expr5 equal
574 expr5 != expr5 not equal
575 expr5 > expr5 greater than
576 expr5 >= expr5 greater than or equal
577 expr5 < expr5 smaller than
578 expr5 <= expr5 smaller than or equal
579 expr5 =~ expr5 regexp matches
580 expr5 !~ expr5 regexp doesn't match
582 expr5 ==? expr5 equal, ignoring case
583 expr5 ==# expr5 equal, match case
584 etc. As above, append ? for ignoring case, # for
585 matching case
587 expr5 is expr5 same |List| instance
588 expr5 isnot expr5 different |List| instance
590 |expr5| expr6 + expr6 .. number addition or list concatenation
591 expr6 - expr6 .. number subtraction
592 expr6 . expr6 .. string concatenation
594 |expr6| expr7 * expr7 .. number multiplication
595 expr7 / expr7 .. number division
596 expr7 % expr7 .. number modulo
598 |expr7| ! expr7 logical NOT
599 - expr7 unary minus
600 + expr7 unary plus
603 |expr8| expr8[expr1] byte of a String or item of a |List|
604 expr8[expr1 : expr1] substring of a String or sublist of a |List|
605 expr8.name entry in a |Dictionary|
606 expr8(expr1, ...) function call with |Funcref| variable
608 |expr9| number number constant
609 "string" string constant, backslash is special
610 'string' string constant, ' is doubled
611 [expr1, ...] |List|
612 {expr1: expr1, ...} |Dictionary|
613 &option option value
614 (expr1) nested expression
615 variable internal variable
616 va{ria}ble internal variable with curly braces
617 $VAR environment variable
618 @r contents of register 'r'
619 function(expr1, ...) function call
620 func{ti}on(expr1, ...) function call with curly braces
623 ".." indicates that the operations in this level can be concatenated.
624 Example: >
625 &nu || &list && &shell == "csh"
627 All expressions within one level are parsed from left to right.
630 expr1 *expr1* *E109*
631 -----
633 expr2 ? expr1 : expr1
635 The expression before the '?' is evaluated to a number. If it evaluates to
636 non-zero, the result is the value of the expression between the '?' and ':',
637 otherwise the result is the value of the expression after the ':'.
638 Example: >
639 :echo lnum == 1 ? "top" : lnum
641 Since the first expression is an "expr2", it cannot contain another ?:. The
642 other two expressions can, thus allow for recursive use of ?:.
643 Example: >
644 :echo lnum == 1 ? "top" : lnum == 1000 ? "last" : lnum
646 To keep this readable, using |line-continuation| is suggested: >
647 :echo lnum == 1
648 :\ ? "top"
649 :\ : lnum == 1000
650 :\ ? "last"
651 :\ : lnum
653 You should always put a space before the ':', otherwise it can be mistaken for
654 use in a variable such as "a:1".
657 expr2 and expr3 *expr2* *expr3*
658 ---------------
660 *expr-barbar* *expr-&&*
661 The "||" and "&&" operators take one argument on each side. The arguments
662 are (converted to) Numbers. The result is:
664 input output ~
665 n1 n2 n1 || n2 n1 && n2 ~
666 zero zero zero zero
667 zero non-zero non-zero zero
668 non-zero zero non-zero zero
669 non-zero non-zero non-zero non-zero
671 The operators can be concatenated, for example: >
673 &nu || &list && &shell == "csh"
675 Note that "&&" takes precedence over "||", so this has the meaning of: >
677 &nu || (&list && &shell == "csh")
679 Once the result is known, the expression "short-circuits", that is, further
680 arguments are not evaluated. This is like what happens in C. For example: >
682 let a = 1
683 echo a || b
685 This is valid even if there is no variable called "b" because "a" is non-zero,
686 so the result must be non-zero. Similarly below: >
688 echo exists("b") && b == "yes"
690 This is valid whether "b" has been defined or not. The second clause will
691 only be evaluated if "b" has been defined.
694 expr4 *expr4*
695 -----
697 expr5 {cmp} expr5
699 Compare two expr5 expressions, resulting in a 0 if it evaluates to false, or 1
700 if it evaluates to true.
702 *expr-==* *expr-!=* *expr->* *expr->=*
703 *expr-<* *expr-<=* *expr-=~* *expr-!~*
704 *expr-==#* *expr-!=#* *expr->#* *expr->=#*
705 *expr-<#* *expr-<=#* *expr-=~#* *expr-!~#*
706 *expr-==?* *expr-!=?* *expr->?* *expr->=?*
707 *expr-<?* *expr-<=?* *expr-=~?* *expr-!~?*
708 *expr-is*
709 use 'ignorecase' match case ignore case ~
710 equal == ==# ==?
711 not equal != !=# !=?
712 greater than > ># >?
713 greater than or equal >= >=# >=?
714 smaller than < <# <?
715 smaller than or equal <= <=# <=?
716 regexp matches =~ =~# =~?
717 regexp doesn't match !~ !~# !~?
718 same instance is
719 different instance isnot
721 Examples:
722 "abc" ==# "Abc" evaluates to 0
723 "abc" ==? "Abc" evaluates to 1
724 "abc" == "Abc" evaluates to 1 if 'ignorecase' is set, 0 otherwise
726 *E691* *E692*
727 A |List| can only be compared with a |List| and only "equal", "not equal" and
728 "is" can be used. This compares the values of the list, recursively.
729 Ignoring case means case is ignored when comparing item values.
731 *E735* *E736*
732 A |Dictionary| can only be compared with a |Dictionary| and only "equal", "not
733 equal" and "is" can be used. This compares the key/values of the |Dictionary|
734 recursively. Ignoring case means case is ignored when comparing item values.
736 *E693* *E694*
737 A |Funcref| can only be compared with a |Funcref| and only "equal" and "not
738 equal" can be used. Case is never ignored.
740 When using "is" or "isnot" with a |List| this checks if the expressions are
741 referring to the same |List| instance. A copy of a |List| is different from
742 the original |List|. When using "is" without a |List| it is equivalent to
743 using "equal", using "isnot" equivalent to using "not equal". Except that a
744 different type means the values are different. "4 == '4'" is true, "4 is '4'"
745 is false.
747 When comparing a String with a Number, the String is converted to a Number,
748 and the comparison is done on Numbers. This means that "0 == 'x'" is TRUE,
749 because 'x' converted to a Number is zero.
751 When comparing two Strings, this is done with strcmp() or stricmp(). This
752 results in the mathematical difference (comparing byte values), not
753 necessarily the alphabetical difference in the local language.
755 When using the operators with a trailing '#", or the short version and
756 'ignorecase' is off, the comparing is done with strcmp(): case matters.
758 When using the operators with a trailing '?', or the short version and
759 'ignorecase' is set, the comparing is done with stricmp(): case is ignored.
761 'smartcase' is not used.
763 The "=~" and "!~" operators match the lefthand argument with the righthand
764 argument, which is used as a pattern. See |pattern| for what a pattern is.
765 This matching is always done like 'magic' was set and 'cpoptions' is empty, no
766 matter what the actual value of 'magic' or 'cpoptions' is. This makes scripts
767 portable. To avoid backslashes in the regexp pattern to be doubled, use a
768 single-quote string, see |literal-string|.
769 Since a string is considered to be a single line, a multi-line pattern
770 (containing \n, backslash-n) will not match. However, a literal NL character
771 can be matched like an ordinary character. Examples:
772 "foo\nbar" =~ "\n" evaluates to 1
773 "foo\nbar" =~ "\\n" evaluates to 0
776 expr5 and expr6 *expr5* *expr6*
777 ---------------
778 expr6 + expr6 .. Number addition or |List| concatenation *expr-+*
779 expr6 - expr6 .. Number subtraction *expr--*
780 expr6 . expr6 .. String concatenation *expr-.*
782 For |Lists| only "+" is possible and then both expr6 must be a list. The
783 result is a new list with the two lists Concatenated.
785 expr7 * expr7 .. number multiplication *expr-star*
786 expr7 / expr7 .. number division *expr-/*
787 expr7 % expr7 .. number modulo *expr-%*
789 For all, except ".", Strings are converted to Numbers.
791 Note the difference between "+" and ".":
792 "123" + "456" = 579
793 "123" . "456" = "123456"
795 When the righthand side of '/' is zero, the result is 0x7fffffff.
796 When the righthand side of '%' is zero, the result is 0.
798 None of these work for |Funcref|s.
801 expr7 *expr7*
802 -----
803 ! expr7 logical NOT *expr-!*
804 - expr7 unary minus *expr-unary--*
805 + expr7 unary plus *expr-unary-+*
807 For '!' non-zero becomes zero, zero becomes one.
808 For '-' the sign of the number is changed.
809 For '+' the number is unchanged.
811 A String will be converted to a Number first.
813 These three can be repeated and mixed. Examples:
814 !-1 == 0
815 !!8 == 1
816 --9 == 9
819 expr8 *expr8*
820 -----
821 expr8[expr1] item of String or |List| *expr-[]* *E111*
823 If expr8 is a Number or String this results in a String that contains the
824 expr1'th single byte from expr8. expr8 is used as a String, expr1 as a
825 Number. Note that this doesn't recognize multi-byte encodings.
827 Index zero gives the first character. This is like it works in C. Careful:
828 text column numbers start with one! Example, to get the character under the
829 cursor: >
830 :let c = getline(".")[col(".") - 1]
832 If the length of the String is less than the index, the result is an empty
833 String. A negative index always results in an empty string (reason: backwards
834 compatibility). Use [-1:] to get the last byte.
836 If expr8 is a |List| then it results the item at index expr1. See |list-index|
837 for possible index values. If the index is out of range this results in an
838 error. Example: >
839 :let item = mylist[-1] " get last item
841 Generally, if a |List| index is equal to or higher than the length of the
842 |List|, or more negative than the length of the |List|, this results in an
843 error.
846 expr8[expr1a : expr1b] substring or sublist *expr-[:]*
848 If expr8 is a Number or String this results in the substring with the bytes
849 from expr1a to and including expr1b. expr8 is used as a String, expr1a and
850 expr1b are used as a Number. Note that this doesn't recognize multi-byte
851 encodings.
853 If expr1a is omitted zero is used. If expr1b is omitted the length of the
854 string minus one is used.
856 A negative number can be used to measure from the end of the string. -1 is
857 the last character, -2 the last but one, etc.
859 If an index goes out of range for the string characters are omitted. If
860 expr1b is smaller than expr1a the result is an empty string.
862 Examples: >
863 :let c = name[-1:] " last byte of a string
864 :let c = name[-2:-2] " last but one byte of a string
865 :let s = line(".")[4:] " from the fifth byte to the end
866 :let s = s[:-3] " remove last two bytes
868 If expr8 is a |List| this results in a new |List| with the items indicated by
869 the indexes expr1a and expr1b. This works like with a String, as explained
870 just above, except that indexes out of range cause an error. Examples: >
871 :let l = mylist[:3] " first four items
872 :let l = mylist[4:4] " List with one item
873 :let l = mylist[:] " shallow copy of a List
875 Using expr8[expr1] or expr8[expr1a : expr1b] on a |Funcref| results in an
876 error.
879 expr8.name entry in a |Dictionary| *expr-entry*
881 If expr8 is a |Dictionary| and it is followed by a dot, then the following
882 name will be used as a key in the |Dictionary|. This is just like:
883 expr8[name].
885 The name must consist of alphanumeric characters, just like a variable name,
886 but it may start with a number. Curly braces cannot be used.
888 There must not be white space before or after the dot.
890 Examples: >
891 :let dict = {"one": 1, 2: "two"}
892 :echo dict.one
893 :echo dict .2
895 Note that the dot is also used for String concatenation. To avoid confusion
896 always put spaces around the dot for String concatenation.
899 expr8(expr1, ...) |Funcref| function call
901 When expr8 is a |Funcref| type variable, invoke the function it refers to.
905 *expr9*
906 number
907 ------
908 number number constant *expr-number*
910 Decimal, Hexadecimal (starting with 0x or 0X), or Octal (starting with 0).
913 string *expr-string* *E114*
914 ------
915 "string" string constant *expr-quote*
917 Note that double quotes are used.
919 A string constant accepts these special characters:
920 \... three-digit octal number (e.g., "\316")
921 \.. two-digit octal number (must be followed by non-digit)
922 \. one-digit octal number (must be followed by non-digit)
923 \x.. byte specified with two hex numbers (e.g., "\x1f")
924 \x. byte specified with one hex number (must be followed by non-hex char)
925 \X.. same as \x..
926 \X. same as \x.
927 \u.... character specified with up to 4 hex numbers, stored according to the
928 current value of 'encoding' (e.g., "\u02a4")
929 \U.... same as \u....
930 \b backspace <BS>
931 \e escape <Esc>
932 \f formfeed <FF>
933 \n newline <NL>
934 \r return <CR>
935 \t tab <Tab>
936 \\ backslash
937 \" double quote
938 \<xxx> Special key named "xxx". e.g. "\<C-W>" for CTRL-W.
940 Note that "\xff" is stored as the byte 255, which may be invalid in some
941 encodings. Use "\u00ff" to store character 255 according to the current value
942 of 'encoding'.
944 Note that "\000" and "\x00" force the end of the string.
947 literal-string *literal-string* *E115*
948 ---------------
949 'string' string constant *expr-'*
951 Note that single quotes are used.
953 This string is taken as it is. No backslashes are removed or have a special
954 meaning. The only exception is that two quotes stand for one quote.
956 Single quoted strings are useful for patterns, so that backslashes do not need
957 to be doubled. These two commands are equivalent: >
958 if a =~ "\\s*"
959 if a =~ '\s*'
962 option *expr-option* *E112* *E113*
963 ------
964 &option option value, local value if possible
965 &g:option global option value
966 &l:option local option value
968 Examples: >
969 echo "tabstop is " . &tabstop
970 if &insertmode
972 Any option name can be used here. See |options|. When using the local value
973 and there is no buffer-local or window-local value, the global value is used
974 anyway.
977 register *expr-register* *@r*
978 --------
979 @r contents of register 'r'
981 The result is the contents of the named register, as a single string.
982 Newlines are inserted where required. To get the contents of the unnamed
983 register use @" or @@. See |registers| for an explanation of the available
984 registers.
986 When using the '=' register you get the expression itself, not what it
987 evaluates to. Use |eval()| to evaluate it.
990 nesting *expr-nesting* *E110*
991 -------
992 (expr1) nested expression
995 environment variable *expr-env*
996 --------------------
997 $VAR environment variable
999 The String value of any environment variable. When it is not defined, the
1000 result is an empty string.
1001 *expr-env-expand*
1002 Note that there is a difference between using $VAR directly and using
1003 expand("$VAR"). Using it directly will only expand environment variables that
1004 are known inside the current Vim session. Using expand() will first try using
1005 the environment variables known inside the current Vim session. If that
1006 fails, a shell will be used to expand the variable. This can be slow, but it
1007 does expand all variables that the shell knows about. Example: >
1008 :echo $version
1009 :echo expand("$version")
1010 The first one probably doesn't echo anything, the second echoes the $version
1011 variable (if your shell supports it).
1014 internal variable *expr-variable*
1015 -----------------
1016 variable internal variable
1017 See below |internal-variables|.
1020 function call *expr-function* *E116* *E118* *E119* *E120*
1021 -------------
1022 function(expr1, ...) function call
1023 See below |functions|.
1026 ==============================================================================
1027 3. Internal variable *internal-variables* *E121*
1028 *E461*
1029 An internal variable name can be made up of letters, digits and '_'. But it
1030 cannot start with a digit. It's also possible to use curly braces, see
1031 |curly-braces-names|.
1033 An internal variable is created with the ":let" command |:let|.
1034 An internal variable is explicitly destroyed with the ":unlet" command
1035 |:unlet|.
1036 Using a name that is not an internal variable or refers to a variable that has
1037 been destroyed results in an error.
1039 There are several name spaces for variables. Which one is to be used is
1040 specified by what is prepended:
1042 (nothing) In a function: local to a function; otherwise: global
1043 |buffer-variable| b: Local to the current buffer.
1044 |window-variable| w: Local to the current window.
1045 |tabpage-variable| t: Local to the current tab page.
1046 |global-variable| g: Global.
1047 |local-variable| l: Local to a function.
1048 |script-variable| s: Local to a |:source|'ed Vim script.
1049 |function-argument| a: Function argument (only inside a function).
1050 |vim-variable| v: Global, predefined by Vim.
1052 The scope name by itself can be used as a |Dictionary|. For example, to
1053 delete all script-local variables: >
1054 :for k in keys(s:)
1055 : unlet s:[k]
1056 :endfor
1057 <
1058 *buffer-variable* *b:var*
1059 A variable name that is preceded with "b:" is local to the current buffer.
1060 Thus you can have several "b:foo" variables, one for each buffer.
1061 This kind of variable is deleted when the buffer is wiped out or deleted with
1062 |:bdelete|.
1064 One local buffer variable is predefined:
1065 *b:changedtick-variable* *changetick*
1066 b:changedtick The total number of changes to the current buffer. It is
1067 incremented for each change. An undo command is also a change
1068 in this case. This can be used to perform an action only when
1069 the buffer has changed. Example: >
1070 :if my_changedtick != b:changedtick
1071 : let my_changedtick = b:changedtick
1072 : call My_Update()
1073 :endif
1074 <
1075 *window-variable* *w:var*
1076 A variable name that is preceded with "w:" is local to the current window. It
1077 is deleted when the window is closed.
1079 *tabpage-variable* *t:var*
1080 A variable name that is preceded with "t:" is local to the current tab page,
1081 It is deleted when the tab page is closed. {not available when compiled
1082 without the +windows feature}
1084 *global-variable* *g:var*
1085 Inside functions global variables are accessed with "g:". Omitting this will
1086 access a variable local to a function. But "g:" can also be used in any other
1087 place if you like.
1089 *local-variable* *l:var*
1090 Inside functions local variables are accessed without prepending anything.
1091 But you can also prepend "l:" if you like. However, without prepending "l:"
1092 you may run into reserved variable names. For example "count". By itself it
1093 refers to "v:count". Using "l:count" you can have a local variable with the
1094 same name.
1096 *script-variable* *s:var*
1097 In a Vim script variables starting with "s:" can be used. They cannot be
1098 accessed from outside of the scripts, thus are local to the script.
1100 They can be used in:
1101 - commands executed while the script is sourced
1102 - functions defined in the script
1103 - autocommands defined in the script
1104 - functions and autocommands defined in functions and autocommands which were
1105 defined in the script (recursively)
1106 - user defined commands defined in the script
1107 Thus not in:
1108 - other scripts sourced from this one
1109 - mappings
1110 - etc.
1112 Script variables can be used to avoid conflicts with global variable names.
1113 Take this example: >
1115 let s:counter = 0
1116 function MyCounter()
1117 let s:counter = s:counter + 1
1118 echo s:counter
1119 endfunction
1120 command Tick call MyCounter()
1122 You can now invoke "Tick" from any script, and the "s:counter" variable in
1123 that script will not be changed, only the "s:counter" in the script where
1124 "Tick" was defined is used.
1126 Another example that does the same: >
1128 let s:counter = 0
1129 command Tick let s:counter = s:counter + 1 | echo s:counter
1131 When calling a function and invoking a user-defined command, the context for
1132 script variables is set to the script where the function or command was
1133 defined.
1135 The script variables are also available when a function is defined inside a
1136 function that is defined in a script. Example: >
1138 let s:counter = 0
1139 function StartCounting(incr)
1140 if a:incr
1141 function MyCounter()
1142 let s:counter = s:counter + 1
1143 endfunction
1144 else
1145 function MyCounter()
1146 let s:counter = s:counter - 1
1147 endfunction
1148 endif
1149 endfunction
1151 This defines the MyCounter() function either for counting up or counting down
1152 when calling StartCounting(). It doesn't matter from where StartCounting() is
1153 called, the s:counter variable will be accessible in MyCounter().
1155 When the same script is sourced again it will use the same script variables.
1156 They will remain valid as long as Vim is running. This can be used to
1157 maintain a counter: >
1159 if !exists("s:counter")
1160 let s:counter = 1
1161 echo "script executed for the first time"
1162 else
1163 let s:counter = s:counter + 1
1164 echo "script executed " . s:counter . " times now"
1165 endif
1167 Note that this means that filetype plugins don't get a different set of script
1168 variables for each buffer. Use local buffer variables instead |b:var|.
1171 Predefined Vim variables: *vim-variable* *v:var*
1173 *v:beval_col* *beval_col-variable*
1174 v:beval_col The number of the column, over which the mouse pointer is.
1175 This is the byte index in the |v:beval_lnum| line.
1176 Only valid while evaluating the 'balloonexpr' option.
1178 *v:beval_bufnr* *beval_bufnr-variable*
1179 v:beval_bufnr The number of the buffer, over which the mouse pointer is. Only
1180 valid while evaluating the 'balloonexpr' option.
1182 *v:beval_lnum* *beval_lnum-variable*
1183 v:beval_lnum The number of the line, over which the mouse pointer is. Only
1184 valid while evaluating the 'balloonexpr' option.
1186 *v:beval_text* *beval_text-variable*
1187 v:beval_text The text under or after the mouse pointer. Usually a word as
1188 it is useful for debugging a C program. 'iskeyword' applies,
1189 but a dot and "->" before the position is included. When on a
1190 ']' the text before it is used, including the matching '[' and
1191 word before it. When on a Visual area within one line the
1192 highlighted text is used.
1193 Only valid while evaluating the 'balloonexpr' option.
1195 *v:beval_winnr* *beval_winnr-variable*
1196 v:beval_winnr The number of the window, over which the mouse pointer is. Only
1197 valid while evaluating the 'balloonexpr' option.
1199 *v:char* *char-variable*
1200 v:char Argument for evaluating 'formatexpr'.
1202 *v:charconvert_from* *charconvert_from-variable*
1203 v:charconvert_from
1204 The name of the character encoding of a file to be converted.
1205 Only valid while evaluating the 'charconvert' option.
1207 *v:charconvert_to* *charconvert_to-variable*
1208 v:charconvert_to
1209 The name of the character encoding of a file after conversion.
1210 Only valid while evaluating the 'charconvert' option.
1212 *v:cmdarg* *cmdarg-variable*
1213 v:cmdarg This variable is used for two purposes:
1214 1. The extra arguments given to a file read/write command.
1215 Currently these are "++enc=" and "++ff=". This variable is
1216 set before an autocommand event for a file read/write
1217 command is triggered. There is a leading space to make it
1218 possible to append this variable directly after the
1219 read/write command. Note: The "+cmd" argument isn't
1220 included here, because it will be executed anyway.
1221 2. When printing a PostScript file with ":hardcopy" this is
1222 the argument for the ":hardcopy" command. This can be used
1223 in 'printexpr'.
1225 *v:cmdbang* *cmdbang-variable*
1226 v:cmdbang Set like v:cmdarg for a file read/write command. When a "!"
1227 was used the value is 1, otherwise it is 0. Note that this
1228 can only be used in autocommands. For user commands |<bang>|
1229 can be used.
1231 *v:count* *count-variable*
1232 v:count The count given for the last Normal mode command. Can be used
1233 to get the count before a mapping. Read-only. Example: >
1234 :map _x :<C-U>echo "the count is " . v:count<CR>
1235 < Note: The <C-U> is required to remove the line range that you
1236 get when typing ':' after a count.
1237 Also used for evaluating the 'formatexpr' option.
1238 "count" also works, for backwards compatibility.
1240 *v:count1* *count1-variable*
1241 v:count1 Just like "v:count", but defaults to one when no count is
1242 used.
1244 *v:ctype* *ctype-variable*
1245 v:ctype The current locale setting for characters of the runtime
1246 environment. This allows Vim scripts to be aware of the
1247 current locale encoding. Technical: it's the value of
1248 LC_CTYPE. When not using a locale the value is "C".
1249 This variable can not be set directly, use the |:language|
1250 command.
1251 See |multi-lang|.
1253 *v:dying* *dying-variable*
1254 v:dying Normally zero. When a deadly signal is caught it's set to
1255 one. When multiple signals are caught the number increases.
1256 Can be used in an autocommand to check if Vim didn't
1257 terminate normally. {only works on Unix}
1258 Example: >
1259 :au VimLeave * if v:dying | echo "\nAAAAaaaarrrggghhhh!!!\n" | endif
1260 <
1261 *v:errmsg* *errmsg-variable*
1262 v:errmsg Last given error message. It's allowed to set this variable.
1263 Example: >
1264 :let v:errmsg = ""
1265 :silent! next
1266 :if v:errmsg != ""
1267 : ... handle error
1268 < "errmsg" also works, for backwards compatibility.
1270 *v:exception* *exception-variable*
1271 v:exception The value of the exception most recently caught and not
1272 finished. See also |v:throwpoint| and |throw-variables|.
1273 Example: >
1274 :try
1275 : throw "oops"
1276 :catch /.*/
1277 : echo "caught" v:exception
1278 :endtry
1279 < Output: "caught oops".
1281 *v:fcs_reason* *fcs_reason-variable*
1282 v:fcs_reason The reason why the |FileChangedShell| event was triggered.
1283 Can be used in an autocommand to decide what to do and/or what
1284 to set v:fcs_choice to. Possible values:
1285 deleted file no longer exists
1286 conflict file contents, mode or timestamp was
1287 changed and buffer is modified
1288 changed file contents has changed
1289 mode mode of file changed
1290 time only file timestamp changed
1292 *v:fcs_choice* *fcs_choice-variable*
1293 v:fcs_choice What should happen after a |FileChangedShell| event was
1294 triggered. Can be used in an autocommand to tell Vim what to
1295 do with the affected buffer:
1296 reload Reload the buffer (does not work if
1297 the file was deleted).
1298 ask Ask the user what to do, as if there
1299 was no autocommand. Except that when
1300 only the timestamp changed nothing
1301 will happen.
1302 <empty> Nothing, the autocommand should do
1303 everything that needs to be done.
1304 The default is empty. If another (invalid) value is used then
1305 Vim behaves like it is empty, there is no warning message.
1307 *v:fname_in* *fname_in-variable*
1308 v:fname_in The name of the input file. Valid while evaluating:
1309 option used for ~
1310 'charconvert' file to be converted
1311 'diffexpr' original file
1312 'patchexpr' original file
1313 'printexpr' file to be printed
1314 And set to the swap file name for |SwapExists|.
1316 *v:fname_out* *fname_out-variable*
1317 v:fname_out The name of the output file. Only valid while
1318 evaluating:
1319 option used for ~
1320 'charconvert' resulting converted file (*)
1321 'diffexpr' output of diff
1322 'patchexpr' resulting patched file
1323 (*) When doing conversion for a write command (e.g., ":w
1324 file") it will be equal to v:fname_in. When doing conversion
1325 for a read command (e.g., ":e file") it will be a temporary
1326 file and different from v:fname_in.
1328 *v:fname_new* *fname_new-variable*
1329 v:fname_new The name of the new version of the file. Only valid while
1330 evaluating 'diffexpr'.
1332 *v:fname_diff* *fname_diff-variable*
1333 v:fname_diff The name of the diff (patch) file. Only valid while
1334 evaluating 'patchexpr'.
1336 *v:folddashes* *folddashes-variable*
1337 v:folddashes Used for 'foldtext': dashes representing foldlevel of a closed
1338 fold.
1339 Read-only in the |sandbox|. |fold-foldtext|
1341 *v:foldlevel* *foldlevel-variable*
1342 v:foldlevel Used for 'foldtext': foldlevel of closed fold.
1343 Read-only in the |sandbox|. |fold-foldtext|
1345 *v:foldend* *foldend-variable*
1346 v:foldend Used for 'foldtext': last line of closed fold.
1347 Read-only in the |sandbox|. |fold-foldtext|
1349 *v:foldstart* *foldstart-variable*
1350 v:foldstart Used for 'foldtext': first line of closed fold.
1351 Read-only in the |sandbox|. |fold-foldtext|
1353 *v:insertmode* *insertmode-variable*
1354 v:insertmode Used for the |InsertEnter| and |InsertChange| autocommand
1355 events. Values:
1356 i Insert mode
1357 r Replace mode
1358 v Virtual Replace mode
1360 *v:key* *key-variable*
1361 v:key Key of the current item of a |Dictionary|. Only valid while
1362 evaluating the expression used with |map()| and |filter()|.
1363 Read-only.
1365 *v:lang* *lang-variable*
1366 v:lang The current locale setting for messages of the runtime
1367 environment. This allows Vim scripts to be aware of the
1368 current language. Technical: it's the value of LC_MESSAGES.
1369 The value is system dependent.
1370 This variable can not be set directly, use the |:language|
1371 command.
1372 It can be different from |v:ctype| when messages are desired
1373 in a different language than what is used for character
1374 encoding. See |multi-lang|.
1376 *v:lc_time* *lc_time-variable*
1377 v:lc_time The current locale setting for time messages of the runtime
1378 environment. This allows Vim scripts to be aware of the
1379 current language. Technical: it's the value of LC_TIME.
1380 This variable can not be set directly, use the |:language|
1381 command. See |multi-lang|.
1383 *v:lnum* *lnum-variable*
1384 v:lnum Line number for the 'foldexpr' |fold-expr| and 'indentexpr'
1385 expressions, tab page number for 'guitablabel' and
1386 'guitabtooltip'. Only valid while one of these expressions is
1387 being evaluated. Read-only when in the |sandbox|.
1389 *v:mouse_win* *mouse_win-variable*
1390 v:mouse_win Window number for a mouse click obtained with |getchar()|.
1391 First window has number 1, like with |winnr()|. The value is
1392 zero when there was no mouse button click.
1394 *v:mouse_lnum* *mouse_lnum-variable*
1395 v:mouse_lnum Line number for a mouse click obtained with |getchar()|.
1396 This is the text line number, not the screen line number. The
1397 value is zero when there was no mouse button click.
1399 *v:mouse_col* *mouse_col-variable*
1400 v:mouse_col Column number for a mouse click obtained with |getchar()|.
1401 This is the screen column number, like with |virtcol()|. The
1402 value is zero when there was no mouse button click.
1404 *v:prevcount* *prevcount-variable*
1405 v:prevcount The count given for the last but one Normal mode command.
1406 This is the v:count value of the previous command. Useful if
1407 you want to cancel Visual mode and then use the count. >
1408 :vmap % <Esc>:call MyFilter(v:prevcount)<CR>
1409 < Read-only.
1411 *v:profiling* *profiling-variable*
1412 v:profiling Normally zero. Set to one after using ":profile start".
1413 See |profiling|.
1415 *v:progname* *progname-variable*
1416 v:progname Contains the name (with path removed) with which Vim was
1417 invoked. Allows you to do special initialisations for "view",
1418 "evim" etc., or any other name you might symlink to Vim.
1419 Read-only.
1421 *v:register* *register-variable*
1422 v:register The name of the register supplied to the last normal mode
1423 command. Empty if none were supplied. |getreg()| |setreg()|
1425 *v:scrollstart* *scrollstart-variable*
1426 v:scrollstart String describing the script or function that caused the
1427 screen to scroll up. It's only set when it is empty, thus the
1428 first reason is remembered. It is set to "Unknown" for a
1429 typed command.
1430 This can be used to find out why your script causes the
1431 hit-enter prompt.
1433 *v:servername* *servername-variable*
1434 v:servername The resulting registered |x11-clientserver| name if any.
1435 Read-only.
1437 *v:shell_error* *shell_error-variable*
1438 v:shell_error Result of the last shell command. When non-zero, the last
1439 shell command had an error. When zero, there was no problem.
1440 This only works when the shell returns the error code to Vim.
1441 The value -1 is often used when the command could not be
1442 executed. Read-only.
1443 Example: >
1444 :!mv foo bar
1445 :if v:shell_error
1446 : echo 'could not rename "foo" to "bar"!'
1447 :endif
1448 < "shell_error" also works, for backwards compatibility.
1450 *v:statusmsg* *statusmsg-variable*
1451 v:statusmsg Last given status message. It's allowed to set this variable.
1453 *v:swapname* *swapname-variable*
1454 v:swapname Only valid when executing |SwapExists| autocommands: Name of
1455 the swap file found. Read-only.
1457 *v:swapchoice* *swapchoice-variable*
1458 v:swapchoice |SwapExists| autocommands can set this to the selected choice
1459 for handling an existing swap file:
1460 'o' Open read-only
1461 'e' Edit anyway
1462 'r' Recover
1463 'd' Delete swapfile
1464 'q' Quit
1465 'a' Abort
1466 The value should be a single-character string. An empty value
1467 results in the user being asked, as would happen when there is
1468 no SwapExists autocommand. The default is empty.
1470 *v:swapcommand* *swapcommand-variable*
1471 v:swapcommand Normal mode command to be executed after a file has been
1472 opened. Can be used for a |SwapExists| autocommand to have
1473 another Vim open the file and jump to the right place. For
1474 example, when jumping to a tag the value is ":tag tagname\r".
1475 For ":edit +cmd file" the value is ":cmd\r".
1477 *v:termresponse* *termresponse-variable*
1478 v:termresponse The escape sequence returned by the terminal for the |t_RV|
1479 termcap entry. It is set when Vim receives an escape sequence
1480 that starts with ESC [ or CSI and ends in a 'c', with only
1481 digits, ';' and '.' in between.
1482 When this option is set, the TermResponse autocommand event is
1483 fired, so that you can react to the response from the
1484 terminal.
1485 The response from a new xterm is: "<Esc>[ Pp ; Pv ; Pc c". Pp
1486 is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
1487 patch level (since this was introduced in patch 95, it's
1488 always 95 or bigger). Pc is always zero.
1489 {only when compiled with |+termresponse| feature}
1491 *v:this_session* *this_session-variable*
1492 v:this_session Full filename of the last loaded or saved session file. See
1493 |:mksession|. It is allowed to set this variable. When no
1494 session file has been saved, this variable is empty.
1495 "this_session" also works, for backwards compatibility.
1497 *v:throwpoint* *throwpoint-variable*
1498 v:throwpoint The point where the exception most recently caught and not
1499 finished was thrown. Not set when commands are typed. See
1500 also |v:exception| and |throw-variables|.
1501 Example: >
1502 :try
1503 : throw "oops"
1504 :catch /.*/
1505 : echo "Exception from" v:throwpoint
1506 :endtry
1507 < Output: "Exception from test.vim, line 2"
1509 *v:val* *val-variable*
1510 v:val Value of the current item of a |List| or |Dictionary|. Only
1511 valid while evaluating the expression used with |map()| and
1512 |filter()|. Read-only.
1514 *v:version* *version-variable*
1515 v:version Version number of Vim: Major version number times 100 plus
1516 minor version number. Version 5.0 is 500. Version 5.1 (5.01)
1517 is 501. Read-only. "version" also works, for backwards
1518 compatibility.
1519 Use |has()| to check if a certain patch was included, e.g.: >
1520 if has("patch123")
1521 < Note that patch numbers are specific to the version, thus both
1522 version 5.0 and 5.1 may have a patch 123, but these are
1523 completely different.
1525 *v:warningmsg* *warningmsg-variable*
1526 v:warningmsg Last given warning message. It's allowed to set this variable.
1528 ==============================================================================
1529 4. Builtin Functions *functions*
1531 See |function-list| for a list grouped by what the function is used for.
1533 (Use CTRL-] on the function name to jump to the full explanation.)
1535 USAGE RESULT DESCRIPTION ~
1537 add( {list}, {item}) List append {item} to |List| {list}
1538 append( {lnum}, {string}) Number append {string} below line {lnum}
1539 append( {lnum}, {list}) Number append lines {list} below line {lnum}
1540 argc() Number number of files in the argument list
1541 argidx() Number current index in the argument list
1542 argv( {nr}) String {nr} entry of the argument list
1543 argv( ) List the argument list
1544 browse( {save}, {title}, {initdir}, {default})
1545 String put up a file requester
1546 browsedir( {title}, {initdir}) String put up a directory requester
1547 bufexists( {expr}) Number TRUE if buffer {expr} exists
1548 buflisted( {expr}) Number TRUE if buffer {expr} is listed
1549 bufloaded( {expr}) Number TRUE if buffer {expr} is loaded
1550 bufname( {expr}) String Name of the buffer {expr}
1551 bufnr( {expr}) Number Number of the buffer {expr}
1552 bufwinnr( {expr}) Number window number of buffer {expr}
1553 byte2line( {byte}) Number line number at byte count {byte}
1554 byteidx( {expr}, {nr}) Number byte index of {nr}'th char in {expr}
1555 call( {func}, {arglist} [, {dict}])
1556 any call {func} with arguments {arglist}
1557 changenr() Number current change number
1558 char2nr( {expr}) Number ASCII value of first char in {expr}
1559 cindent( {lnum}) Number C indent for line {lnum}
1560 clearmatches() None clear all matches
1561 col( {expr}) Number column nr of cursor or mark
1562 complete({startcol}, {matches}) String set Insert mode completion
1563 complete_add( {expr}) Number add completion match
1564 complete_check() Number check for key typed during completion
1565 confirm( {msg} [, {choices} [, {default} [, {type}]]])
1566 Number number of choice picked by user
1567 copy( {expr}) any make a shallow copy of {expr}
1568 count( {list}, {expr} [, {start} [, {ic}]])
1569 Number count how many {expr} are in {list}
1570 cscope_connection( [{num} , {dbpath} [, {prepend}]])
1571 Number checks existence of cscope connection
1572 cursor( {lnum}, {col} [, {coladd}])
1573 Number move cursor to {lnum}, {col}, {coladd}
1574 cursor( {list}) Number move cursor to position in {list}
1575 deepcopy( {expr}) any make a full copy of {expr}
1576 delete( {fname}) Number delete file {fname}
1577 did_filetype() Number TRUE if FileType autocommand event used
1578 diff_filler( {lnum}) Number diff filler lines about {lnum}
1579 diff_hlID( {lnum}, {col}) Number diff highlighting at {lnum}/{col}
1580 empty( {expr}) Number TRUE if {expr} is empty
1581 escape( {string}, {chars}) String escape {chars} in {string} with '\'
1582 eval( {string}) any evaluate {string} into its value
1583 eventhandler( ) Number TRUE if inside an event handler
1584 executable( {expr}) Number 1 if executable {expr} exists
1585 exists( {expr}) Number TRUE if {expr} exists
1586 extend({expr1}, {expr2} [, {expr3}])
1587 List/Dict insert items of {expr2} into {expr1}
1588 expand( {expr}) String expand special keywords in {expr}
1589 feedkeys( {string} [, {mode}]) Number add key sequence to typeahead buffer
1590 filereadable( {file}) Number TRUE if {file} is a readable file
1591 filewritable( {file}) Number TRUE if {file} is a writable file
1592 filter( {expr}, {string}) List/Dict remove items from {expr} where
1593 {string} is 0
1594 finddir( {name}[, {path}[, {count}]])
1595 String find directory {name} in {path}
1596 findfile( {name}[, {path}[, {count}]])
1597 String find file {name} in {path}
1598 fnamemodify( {fname}, {mods}) String modify file name
1599 foldclosed( {lnum}) Number first line of fold at {lnum} if closed
1600 foldclosedend( {lnum}) Number last line of fold at {lnum} if closed
1601 foldlevel( {lnum}) Number fold level at {lnum}
1602 foldtext( ) String line displayed for closed fold
1603 foldtextresult( {lnum}) String text for closed fold at {lnum}
1604 foreground( ) Number bring the Vim window to the foreground
1605 function( {name}) Funcref reference to function {name}
1606 garbagecollect( [at_exit]) none free memory, breaking cyclic references
1607 get( {list}, {idx} [, {def}]) any get item {idx} from {list} or {def}
1608 get( {dict}, {key} [, {def}]) any get item {key} from {dict} or {def}
1609 getbufline( {expr}, {lnum} [, {end}])
1610 List lines {lnum} to {end} of buffer {expr}
1611 getbufvar( {expr}, {varname}) any variable {varname} in buffer {expr}
1612 getchar( [expr]) Number get one character from the user
1613 getcharmod( ) Number modifiers for the last typed character
1614 getcmdline() String return the current command-line
1615 getcmdpos() Number return cursor position in command-line
1616 getcmdtype() String return the current command-line type
1617 getcwd() String the current working directory
1618 getfperm( {fname}) String file permissions of file {fname}
1619 getfsize( {fname}) Number size in bytes of file {fname}
1620 getfontname( [{name}]) String name of font being used
1621 getftime( {fname}) Number last modification time of file
1622 getftype( {fname}) String description of type of file {fname}
1623 getline( {lnum}) String line {lnum} of current buffer
1624 getline( {lnum}, {end}) List lines {lnum} to {end} of current buffer
1625 getloclist({nr}) List list of location list items
1626 getmatches() List list of current matches
1627 getpos( {expr}) List position of cursor, mark, etc.
1628 getqflist() List list of quickfix items
1629 getreg( [{regname} [, 1]]) String contents of register
1630 getregtype( [{regname}]) String type of register
1631 gettabwinvar( {tabnr}, {winnr}, {name})
1632 any {name} in {winnr} in tab page {tabnr}
1633 getwinposx() Number X coord in pixels of GUI Vim window
1634 getwinposy() Number Y coord in pixels of GUI Vim window
1635 getwinvar( {nr}, {varname}) any variable {varname} in window {nr}
1636 glob( {expr}) String expand file wildcards in {expr}
1637 globpath( {path}, {expr}) String do glob({expr}) for all dirs in {path}
1638 has( {feature}) Number TRUE if feature {feature} supported
1639 has_key( {dict}, {key}) Number TRUE if {dict} has entry {key}
1640 haslocaldir() Number TRUE if current window executed |:lcd|
1641 hasmapto( {what} [, {mode} [, {abbr}]])
1642 Number TRUE if mapping to {what} exists
1643 histadd( {history},{item}) String add an item to a history
1644 histdel( {history} [, {item}]) String remove an item from a history
1645 histget( {history} [, {index}]) String get the item {index} from a history
1646 histnr( {history}) Number highest index of a history
1647 hlexists( {name}) Number TRUE if highlight group {name} exists
1648 hlID( {name}) Number syntax ID of highlight group {name}
1649 hostname() String name of the machine Vim is running on
1650 iconv( {expr}, {from}, {to}) String convert encoding of {expr}
1651 indent( {lnum}) Number indent of line {lnum}
1652 index( {list}, {expr} [, {start} [, {ic}]])
1653 Number index in {list} where {expr} appears
1654 input( {prompt} [, {text} [, {completion}]])
1655 String get input from the user
1656 inputdialog( {p} [, {t} [, {c}]]) String like input() but in a GUI dialog
1657 inputlist( {textlist}) Number let the user pick from a choice list
1658 inputrestore() Number restore typeahead
1659 inputsave() Number save and clear typeahead
1660 inputsecret( {prompt} [, {text}]) String like input() but hiding the text
1661 insert( {list}, {item} [, {idx}]) List insert {item} in {list} [before {idx}]
1662 isdirectory( {directory}) Number TRUE if {directory} is a directory
1663 islocked( {expr}) Number TRUE if {expr} is locked
1664 items( {dict}) List key-value pairs in {dict}
1665 join( {list} [, {sep}]) String join {list} items into one String
1666 keys( {dict}) List keys in {dict}
1667 len( {expr}) Number the length of {expr}
1668 libcall( {lib}, {func}, {arg}) String call {func} in library {lib} with {arg}
1669 libcallnr( {lib}, {func}, {arg}) Number idem, but return a Number
1670 line( {expr}) Number line nr of cursor, last line or mark
1671 line2byte( {lnum}) Number byte count of line {lnum}
1672 lispindent( {lnum}) Number Lisp indent for line {lnum}
1673 localtime() Number current time
1674 map( {expr}, {string}) List/Dict change each item in {expr} to {expr}
1675 maparg( {name}[, {mode} [, {abbr}]])
1676 String rhs of mapping {name} in mode {mode}
1677 mapcheck( {name}[, {mode} [, {abbr}]])
1678 String check for mappings matching {name}
1679 match( {expr}, {pat}[, {start}[, {count}]])
1680 Number position where {pat} matches in {expr}
1681 matchadd( {group}, {pattern}[, {priority}[, {id}]])
1682 Number highlight {pattern} with {group}
1683 matcharg( {nr}) List arguments of |:match|
1684 matchdelete( {id}) Number delete match identified by {id}
1685 matchend( {expr}, {pat}[, {start}[, {count}]])
1686 Number position where {pat} ends in {expr}
1687 matchlist( {expr}, {pat}[, {start}[, {count}]])
1688 List match and submatches of {pat} in {expr}
1689 matchstr( {expr}, {pat}[, {start}[, {count}]])
1690 String {count}'th match of {pat} in {expr}
1691 max({list}) Number maximum value of items in {list}
1692 min({list}) Number minimum value of items in {list}
1693 mkdir({name} [, {path} [, {prot}]])
1694 Number create directory {name}
1695 mode() String current editing mode
1696 nextnonblank( {lnum}) Number line nr of non-blank line >= {lnum}
1697 nr2char( {expr}) String single char with ASCII value {expr}
1698 pathshorten( {expr}) String shorten directory names in a path
1699 prevnonblank( {lnum}) Number line nr of non-blank line <= {lnum}
1700 printf( {fmt}, {expr1}...) String format text
1701 pumvisible() Number whether popup menu is visible
1702 range( {expr} [, {max} [, {stride}]])
1703 List items from {expr} to {max}
1704 readfile({fname} [, {binary} [, {max}]])
1705 List get list of lines from file {fname}
1706 reltime( [{start} [, {end}]]) List get time value
1707 reltimestr( {time}) String turn time value into a String
1708 remote_expr( {server}, {string} [, {idvar}])
1709 String send expression
1710 remote_foreground( {server}) Number bring Vim server to the foreground
1711 remote_peek( {serverid} [, {retvar}])
1712 Number check for reply string
1713 remote_read( {serverid}) String read reply string
1714 remote_send( {server}, {string} [, {idvar}])
1715 String send key sequence
1716 remove( {list}, {idx} [, {end}]) any remove items {idx}-{end} from {list}
1717 remove( {dict}, {key}) any remove entry {key} from {dict}
1718 rename( {from}, {to}) Number rename (move) file from {from} to {to}
1719 repeat( {expr}, {count}) String repeat {expr} {count} times
1720 resolve( {filename}) String get filename a shortcut points to
1721 reverse( {list}) List reverse {list} in-place
1722 search( {pattern} [, {flags}]) Number search for {pattern}
1723 searchdecl({name} [, {global} [, {thisblock}]])
1724 Number search for variable declaration
1725 searchpair( {start}, {middle}, {end} [, {flags} [, {skip} [, {stopline}]]])
1726 Number search for other end of start/end pair
1727 searchpairpos( {start}, {middle}, {end} [, {flags} [, {skip} [, {stopline}]]])
1728 List search for other end of start/end pair
1729 searchpos( {pattern} [, {flags} [, {stopline}]])
1730 List search for {pattern}
1731 server2client( {clientid}, {string})
1732 Number send reply string
1733 serverlist() String get a list of available servers
1734 setbufvar( {expr}, {varname}, {val}) set {varname} in buffer {expr} to {val}
1735 setcmdpos( {pos}) Number set cursor position in command-line
1736 setline( {lnum}, {line}) Number set line {lnum} to {line}
1737 setloclist( {nr}, {list}[, {action}])
1738 Number modify location list using {list}
1739 setmatches( {list}) Number restore a list of matches
1740 setpos( {expr}, {list}) none set the {expr} position to {list}
1741 setqflist( {list}[, {action}]) Number modify quickfix list using {list}
1742 setreg( {n}, {v}[, {opt}]) Number set register to value and type
1743 settabwinvar( {tabnr}, {winnr}, {varname}, {val}) set {varname} in window
1744 {winnr} in tab page {tabnr} to {val}
1745 setwinvar( {nr}, {varname}, {val}) set {varname} in window {nr} to {val}
1746 shellescape( {string}) String escape {string} for use as shell
1747 command argument
1748 simplify( {filename}) String simplify filename as much as possible
1749 sort( {list} [, {func}]) List sort {list}, using {func} to compare
1750 soundfold( {word}) String sound-fold {word}
1751 spellbadword() String badly spelled word at cursor
1752 spellsuggest( {word} [, {max} [, {capital}]])
1753 List spelling suggestions
1754 split( {expr} [, {pat} [, {keepempty}]])
1755 List make |List| from {pat} separated {expr}
1756 str2nr( {expr} [, {base}]) Number convert string to number
1757 strftime( {format}[, {time}]) String time in specified format
1758 stridx( {haystack}, {needle}[, {start}])
1759 Number index of {needle} in {haystack}
1760 string( {expr}) String String representation of {expr} value
1761 strlen( {expr}) Number length of the String {expr}
1762 strpart( {src}, {start}[, {len}])
1763 String {len} characters of {src} at {start}
1764 strridx( {haystack}, {needle} [, {start}])
1765 Number last index of {needle} in {haystack}
1766 strtrans( {expr}) String translate string to make it printable
1767 submatch( {nr}) String specific match in ":substitute"
1768 substitute( {expr}, {pat}, {sub}, {flags})
1769 String all {pat} in {expr} replaced with {sub}
1770 synID( {lnum}, {col}, {trans}) Number syntax ID at {lnum} and {col}
1771 synIDattr( {synID}, {what} [, {mode}])
1772 String attribute {what} of syntax ID {synID}
1773 synIDtrans( {synID}) Number translated syntax ID of {synID}
1774 system( {expr} [, {input}]) String output of shell command/filter {expr}
1775 tabpagebuflist( [{arg}]) List list of buffer numbers in tab page
1776 tabpagenr( [{arg}]) Number number of current or last tab page
1777 tabpagewinnr( {tabarg}[, {arg}])
1778 Number number of current window in tab page
1779 taglist( {expr}) List list of tags matching {expr}
1780 tagfiles() List tags files used
1781 tempname() String name for a temporary file
1782 tolower( {expr}) String the String {expr} switched to lowercase
1783 toupper( {expr}) String the String {expr} switched to uppercase
1784 tr( {src}, {fromstr}, {tostr}) String translate chars of {src} in {fromstr}
1785 to chars in {tostr}
1786 type( {name}) Number type of variable {name}
1787 values( {dict}) List values in {dict}
1788 virtcol( {expr}) Number screen column of cursor or mark
1789 visualmode( [expr]) String last visual mode used
1790 winbufnr( {nr}) Number buffer number of window {nr}
1791 wincol() Number window column of the cursor
1792 winheight( {nr}) Number height of window {nr}
1793 winline() Number window line of the cursor
1794 winnr( [{expr}]) Number number of current window
1795 winrestcmd() String returns command to restore window sizes
1796 winrestview({dict}) None restore view of current window
1797 winsaveview() Dict save view of current window
1798 winwidth( {nr}) Number width of window {nr}
1799 writefile({list}, {fname} [, {binary}])
1800 Number write list of lines to file {fname}
1802 add({list}, {expr}) *add()*
1803 Append the item {expr} to |List| {list}. Returns the
1804 resulting |List|. Examples: >
1805 :let alist = add([1, 2, 3], item)
1806 :call add(mylist, "woodstock")
1807 < Note that when {expr} is a |List| it is appended as a single
1808 item. Use |extend()| to concatenate |Lists|.
1809 Use |insert()| to add an item at another position.
1812 append({lnum}, {expr}) *append()*
1813 When {expr} is a |List|: Append each item of the |List| as a
1814 text line below line {lnum} in the current buffer.
1815 Otherwise append {expr} as one text line below line {lnum} in
1816 the current buffer.
1817 {lnum} can be zero to insert a line before the first one.
1818 Returns 1 for failure ({lnum} out of range or out of memory),
1819 0 for success. Example: >
1820 :let failed = append(line('$'), "# THE END")
1821 :let failed = append(0, ["Chapter 1", "the beginning"])
1822 <
1823 *argc()*
1824 argc() The result is the number of files in the argument list of the
1825 current window. See |arglist|.
1827 *argidx()*
1828 argidx() The result is the current index in the argument list. 0 is
1829 the first file. argc() - 1 is the last one. See |arglist|.
1831 *argv()*
1832 argv([{nr}]) The result is the {nr}th file in the argument list of the
1833 current window. See |arglist|. "argv(0)" is the first one.
1834 Example: >
1835 :let i = 0
1836 :while i < argc()
1837 : let f = escape(argv(i), '. ')
1838 : exe 'amenu Arg.' . f . ' :e ' . f . '<CR>'
1839 : let i = i + 1
1840 :endwhile
1841 < Without the {nr} argument a |List| with the whole |arglist| is
1842 returned.
1844 *browse()*
1845 browse({save}, {title}, {initdir}, {default})
1846 Put up a file requester. This only works when "has("browse")"
1847 returns non-zero (only in some GUI versions).
1848 The input fields are:
1849 {save} when non-zero, select file to write
1850 {title} title for the requester
1851 {initdir} directory to start browsing in
1852 {default} default file name
1853 When the "Cancel" button is hit, something went wrong, or
1854 browsing is not possible, an empty string is returned.
1856 *browsedir()*
1857 browsedir({title}, {initdir})
1858 Put up a directory requester. This only works when
1859 "has("browse")" returns non-zero (only in some GUI versions).
1860 On systems where a directory browser is not supported a file
1861 browser is used. In that case: select a file in the directory
1862 to be used.
1863 The input fields are:
1864 {title} title for the requester
1865 {initdir} directory to start browsing in
1866 When the "Cancel" button is hit, something went wrong, or
1867 browsing is not possible, an empty string is returned.
1869 bufexists({expr}) *bufexists()*
1870 The result is a Number, which is non-zero if a buffer called
1871 {expr} exists.
1872 If the {expr} argument is a number, buffer numbers are used.
1873 If the {expr} argument is a string it must match a buffer name
1874 exactly. The name can be:
1875 - Relative to the current directory.
1876 - A full path.
1877 - The name of a buffer with 'filetype' set to "nofile".
1878 - A URL name.
1879 Unlisted buffers will be found.
1880 Note that help files are listed by their short name in the
1881 output of |:buffers|, but bufexists() requires using their
1882 long name to be able to find them.
1883 Use "bufexists(0)" to test for the existence of an alternate
1884 file name.
1885 *buffer_exists()*
1886 Obsolete name: buffer_exists().
1888 buflisted({expr}) *buflisted()*
1889 The result is a Number, which is non-zero if a buffer called
1890 {expr} exists and is listed (has the 'buflisted' option set).
1891 The {expr} argument is used like with |bufexists()|.
1893 bufloaded({expr}) *bufloaded()*
1894 The result is a Number, which is non-zero if a buffer called
1895 {expr} exists and is loaded (shown in a window or hidden).
1896 The {expr} argument is used like with |bufexists()|.
1898 bufname({expr}) *bufname()*
1899 The result is the name of a buffer, as it is displayed by the
1900 ":ls" command.
1901 If {expr} is a Number, that buffer number's name is given.
1902 Number zero is the alternate buffer for the current window.
1903 If {expr} is a String, it is used as a |file-pattern| to match
1904 with the buffer names. This is always done like 'magic' is
1905 set and 'cpoptions' is empty. When there is more than one
1906 match an empty string is returned.
1907 "" or "%" can be used for the current buffer, "#" for the
1908 alternate buffer.
1909 A full match is preferred, otherwise a match at the start, end
1910 or middle of the buffer name is accepted. If you only want a
1911 full match then put "^" at the start and "$" at the end of the
1912 pattern.
1913 Listed buffers are found first. If there is a single match
1914 with a listed buffer, that one is returned. Next unlisted
1915 buffers are searched for.
1916 If the {expr} is a String, but you want to use it as a buffer
1917 number, force it to be a Number by adding zero to it: >
1918 :echo bufname("3" + 0)
1919 < If the buffer doesn't exist, or doesn't have a name, an empty
1920 string is returned. >
1921 bufname("#") alternate buffer name
1922 bufname(3) name of buffer 3
1923 bufname("%") name of current buffer
1924 bufname("file2") name of buffer where "file2" matches.
1925 < *buffer_name()*
1926 Obsolete name: buffer_name().
1928 *bufnr()*
1929 bufnr({expr} [, {create}])
1930 The result is the number of a buffer, as it is displayed by
1931 the ":ls" command. For the use of {expr}, see |bufname()|
1932 above.
1933 If the buffer doesn't exist, -1 is returned. Or, if the
1934 {create} argument is present and not zero, a new, unlisted,
1935 buffer is created and its number is returned.
1936 bufnr("$") is the last buffer: >
1937 :let last_buffer = bufnr("$")
1938 < The result is a Number, which is the highest buffer number
1939 of existing buffers. Note that not all buffers with a smaller
1940 number necessarily exist, because ":bwipeout" may have removed
1941 them. Use bufexists() to test for the existence of a buffer.
1942 *buffer_number()*
1943 Obsolete name: buffer_number().
1944 *last_buffer_nr()*
1945 Obsolete name for bufnr("$"): last_buffer_nr().
1947 bufwinnr({expr}) *bufwinnr()*
1948 The result is a Number, which is the number of the first
1949 window associated with buffer {expr}. For the use of {expr},
1950 see |bufname()| above. If buffer {expr} doesn't exist or
1951 there is no such window, -1 is returned. Example: >
1953 echo "A window containing buffer 1 is " . (bufwinnr(1))
1955 < The number can be used with |CTRL-W_w| and ":wincmd w"
1956 |:wincmd|.
1957 Only deals with the current tab page.
1960 byte2line({byte}) *byte2line()*
1961 Return the line number that contains the character at byte
1962 count {byte} in the current buffer. This includes the
1963 end-of-line character, depending on the 'fileformat' option
1964 for the current buffer. The first character has byte count
1965 one.
1966 Also see |line2byte()|, |go| and |:goto|.
1967 {not available when compiled without the |+byte_offset|
1968 feature}
1970 byteidx({expr}, {nr}) *byteidx()*
1971 Return byte index of the {nr}'th character in the string
1972 {expr}. Use zero for the first character, it returns zero.
1973 This function is only useful when there are multibyte
1974 characters, otherwise the returned value is equal to {nr}.
1975 Composing characters are counted as a separate character.
1976 Example : >
1977 echo matchstr(str, ".", byteidx(str, 3))
1978 < will display the fourth character. Another way to do the
1979 same: >
1980 let s = strpart(str, byteidx(str, 3))
1981 echo strpart(s, 0, byteidx(s, 1))
1982 < If there are less than {nr} characters -1 is returned.
1983 If there are exactly {nr} characters the length of the string
1984 is returned.
1986 call({func}, {arglist} [, {dict}]) *call()* *E699*
1987 Call function {func} with the items in |List| {arglist} as
1988 arguments.
1989 {func} can either be a |Funcref| or the name of a function.
1990 a:firstline and a:lastline are set to the cursor line.
1991 Returns the return value of the called function.
1992 {dict} is for functions with the "dict" attribute. It will be
1993 used to set the local variable "self". |Dictionary-function|
1995 changenr() *changenr()*
1996 Return the number of the most recent change. This is the same
1997 number as what is displayed with |:undolist| and can be used
1998 with the |:undo| command.
1999 When a change was made it is the number of that change. After
2000 redo it is the number of the redone change. After undo it is
2001 one less than the number of the undone change.
2003 char2nr({expr}) *char2nr()*
2004 Return number value of the first char in {expr}. Examples: >
2005 char2nr(" ") returns 32
2006 char2nr("ABC") returns 65
2007 < The current 'encoding' is used. Example for "utf-8": >
2008 char2nr("á") returns 225
2009 char2nr("á"[0]) returns 195
2010 < nr2char() does the opposite.
2012 cindent({lnum}) *cindent()*
2013 Get the amount of indent for line {lnum} according the C
2014 indenting rules, as with 'cindent'.
2015 The indent is counted in spaces, the value of 'tabstop' is
2016 relevant. {lnum} is used just like in |getline()|.
2017 When {lnum} is invalid or Vim was not compiled the |+cindent|
2018 feature, -1 is returned.
2019 See |C-indenting|.
2021 clearmatches() *clearmatches()*
2022 Clears all matches previously defined by |matchadd()| and the
2023 |:match| commands.
2025 *col()*
2026 col({expr}) The result is a Number, which is the byte index of the column
2027 position given with {expr}. The accepted positions are:
2028 . the cursor position
2029 $ the end of the cursor line (the result is the
2030 number of characters in the cursor line plus one)
2031 'x position of mark x (if the mark is not set, 0 is
2032 returned)
2033 Additionally {expr} can be [lnum, col]: a |List| with the line
2034 and column number. Most useful when the column is "$", to get
2035 the las column of a specific line. When "lnum" or "col" is
2036 out of range then col() returns zero.
2037 To get the line number use |line()|. To get both use
2038 |getpos()|.
2039 For the screen column position use |virtcol()|.
2040 Note that only marks in the current file can be used.
2041 Examples: >
2042 col(".") column of cursor
2043 col("$") length of cursor line plus one
2044 col("'t") column of mark t
2045 col("'" . markname) column of mark markname
2046 < The first column is 1. 0 is returned for an error.
2047 For an uppercase mark the column may actually be in another
2048 buffer.
2049 For the cursor position, when 'virtualedit' is active, the
2050 column is one higher if the cursor is after the end of the
2051 line. This can be used to obtain the column in Insert mode: >
2052 :imap <F2> <C-O>:let save_ve = &ve<CR>
2053 \<C-O>:set ve=all<CR>
2054 \<C-O>:echo col(".") . "\n" <Bar>
2055 \let &ve = save_ve<CR>
2056 <
2058 complete({startcol}, {matches}) *complete()* *E785*
2059 Set the matches for Insert mode completion.
2060 Can only be used in Insert mode. You need to use a mapping
2061 with CTRL-R = |i_CTRL-R|. It does not work after CTRL-O or
2062 with an expression mapping.
2063 {startcol} is the byte offset in the line where the completed
2064 text start. The text up to the cursor is the original text
2065 that will be replaced by the matches. Use col('.') for an
2066 empty string. "col('.') - 1" will replace one character by a
2067 match.
2068 {matches} must be a |List|. Each |List| item is one match.
2069 See |complete-items| for the kind of items that are possible.
2070 Note that the after calling this function you need to avoid
2071 inserting anything that would completion to stop.
2072 The match can be selected with CTRL-N and CTRL-P as usual with
2073 Insert mode completion. The popup menu will appear if
2074 specified, see |ins-completion-menu|.
2075 Example: >
2076 inoremap <F5> <C-R>=ListMonths()<CR>
2078 func! ListMonths()
2079 call complete(col('.'), ['January', 'February', 'March',
2080 \ 'April', 'May', 'June', 'July', 'August', 'September',
2081 \ 'October', 'November', 'December'])
2082 return ''
2083 endfunc
2084 < This isn't very useful, but it shows how it works. Note that
2085 an empty string is returned to avoid a zero being inserted.
2087 complete_add({expr}) *complete_add()*
2088 Add {expr} to the list of matches. Only to be used by the
2089 function specified with the 'completefunc' option.
2090 Returns 0 for failure (empty string or out of memory),
2091 1 when the match was added, 2 when the match was already in
2092 the list.
2093 See |complete-functions| for an explanation of {expr}. It is
2094 the same as one item in the list that 'omnifunc' would return.
2096 complete_check() *complete_check()*
2097 Check for a key typed while looking for completion matches.
2098 This is to be used when looking for matches takes some time.
2099 Returns non-zero when searching for matches is to be aborted,
2100 zero otherwise.
2101 Only to be used by the function specified with the
2102 'completefunc' option.
2104 *confirm()*
2105 confirm({msg} [, {choices} [, {default} [, {type}]]])
2106 Confirm() offers the user a dialog, from which a choice can be
2107 made. It returns the number of the choice. For the first
2108 choice this is 1.
2109 Note: confirm() is only supported when compiled with dialog
2110 support, see |+dialog_con| and |+dialog_gui|.
2111 {msg} is displayed in a |dialog| with {choices} as the
2112 alternatives. When {choices} is missing or empty, "&OK" is
2113 used (and translated).
2114 {msg} is a String, use '\n' to include a newline. Only on
2115 some systems the string is wrapped when it doesn't fit.
2116 {choices} is a String, with the individual choices separated
2117 by '\n', e.g. >
2118 confirm("Save changes?", "&Yes\n&No\n&Cancel")
2119 < The letter after the '&' is the shortcut key for that choice.
2120 Thus you can type 'c' to select "Cancel". The shortcut does
2121 not need to be the first letter: >
2122 confirm("file has been modified", "&Save\nSave &All")
2123 < For the console, the first letter of each choice is used as
2124 the default shortcut key.
2125 The optional {default} argument is the number of the choice
2126 that is made if the user hits <CR>. Use 1 to make the first
2127 choice the default one. Use 0 to not set a default. If
2128 {default} is omitted, 1 is used.
2129 The optional {type} argument gives the type of dialog. This
2130 is only used for the icon of the Win32 GUI. It can be one of
2131 these values: "Error", "Question", "Info", "Warning" or
2132 "Generic". Only the first character is relevant. When {type}
2133 is omitted, "Generic" is used.
2134 If the user aborts the dialog by pressing <Esc>, CTRL-C,
2135 or another valid interrupt key, confirm() returns 0.
2137 An example: >
2138 :let choice = confirm("What do you want?", "&Apples\n&Oranges\n&Bananas", 2)
2139 :if choice == 0
2140 : echo "make up your mind!"
2141 :elseif choice == 3
2142 : echo "tasteful"
2143 :else
2144 : echo "I prefer bananas myself."
2145 :endif
2146 < In a GUI dialog, buttons are used. The layout of the buttons
2147 depends on the 'v' flag in 'guioptions'. If it is included,
2148 the buttons are always put vertically. Otherwise, confirm()
2149 tries to put the buttons in one horizontal line. If they
2150 don't fit, a vertical layout is used anyway. For some systems
2151 the horizontal layout is always used.
2153 *copy()*
2154 copy({expr}) Make a copy of {expr}. For Numbers and Strings this isn't
2155 different from using {expr} directly.
2156 When {expr} is a |List| a shallow copy is created. This means
2157 that the original |List| can be changed without changing the
2158 copy, and vise versa. But the items are identical, thus
2159 changing an item changes the contents of both |Lists|. Also
2160 see |deepcopy()|.
2162 count({comp}, {expr} [, {ic} [, {start}]]) *count()*
2163 Return the number of times an item with value {expr} appears
2164 in |List| or |Dictionary| {comp}.
2165 If {start} is given then start with the item with this index.
2166 {start} can only be used with a |List|.
2167 When {ic} is given and it's non-zero then case is ignored.
2170 *cscope_connection()*
2171 cscope_connection([{num} , {dbpath} [, {prepend}]])
2172 Checks for the existence of a |cscope| connection. If no
2173 parameters are specified, then the function returns:
2174 0, if cscope was not available (not compiled in), or
2175 if there are no cscope connections;
2176 1, if there is at least one cscope connection.
2178 If parameters are specified, then the value of {num}
2179 determines how existence of a cscope connection is checked:
2181 {num} Description of existence check
2182 ----- ------------------------------
2183 0 Same as no parameters (e.g., "cscope_connection()").
2184 1 Ignore {prepend}, and use partial string matches for
2185 {dbpath}.
2186 2 Ignore {prepend}, and use exact string matches for
2187 {dbpath}.
2188 3 Use {prepend}, use partial string matches for both
2189 {dbpath} and {prepend}.
2190 4 Use {prepend}, use exact string matches for both
2191 {dbpath} and {prepend}.
2193 Note: All string comparisons are case sensitive!
2195 Examples. Suppose we had the following (from ":cs show"): >
2197 # pid database name prepend path
2198 0 27664 cscope.out /usr/local
2199 <
2200 Invocation Return Val ~
2201 ---------- ---------- >
2202 cscope_connection() 1
2203 cscope_connection(1, "out") 1
2204 cscope_connection(2, "out") 0
2205 cscope_connection(3, "out") 0
2206 cscope_connection(3, "out", "local") 1
2207 cscope_connection(4, "out") 0
2208 cscope_connection(4, "out", "local") 0
2209 cscope_connection(4, "cscope.out", "/usr/local") 1
2210 <
2211 cursor({lnum}, {col} [, {off}]) *cursor()*
2212 cursor({list})
2213 Positions the cursor at the column (byte count) {col} in the
2214 line {lnum}. The first column is one.
2215 When there is one argument {list} this is used as a |List|
2216 with two or three items {lnum}, {col} and {off}. This is like
2217 the return value of |getpos()|, but without the first item.
2218 Does not change the jumplist.
2219 If {lnum} is greater than the number of lines in the buffer,
2220 the cursor will be positioned at the last line in the buffer.
2221 If {lnum} is zero, the cursor will stay in the current line.
2222 If {col} is greater than the number of bytes in the line,
2223 the cursor will be positioned at the last character in the
2224 line.
2225 If {col} is zero, the cursor will stay in the current column.
2226 When 'virtualedit' is used {off} specifies the offset in
2227 screen columns from the start of the character. E.g., a
2228 position within a <Tab> or after the last character.
2231 deepcopy({expr}[, {noref}]) *deepcopy()* *E698*
2232 Make a copy of {expr}. For Numbers and Strings this isn't
2233 different from using {expr} directly.
2234 When {expr} is a |List| a full copy is created. This means
2235 that the original |List| can be changed without changing the
2236 copy, and vise versa. When an item is a |List|, a copy for it
2237 is made, recursively. Thus changing an item in the copy does
2238 not change the contents of the original |List|.
2239 When {noref} is omitted or zero a contained |List| or
2240 |Dictionary| is only copied once. All references point to
2241 this single copy. With {noref} set to 1 every occurrence of a
2242 |List| or |Dictionary| results in a new copy. This also means
2243 that a cyclic reference causes deepcopy() to fail.
2244 *E724*
2245 Nesting is possible up to 100 levels. When there is an item
2246 that refers back to a higher level making a deep copy with
2247 {noref} set to 1 will fail.
2248 Also see |copy()|.
2250 delete({fname}) *delete()*
2251 Deletes the file by the name {fname}. The result is a Number,
2252 which is 0 if the file was deleted successfully, and non-zero
2253 when the deletion failed.
2254 Use |remove()| to delete an item from a |List|.
2256 *did_filetype()*
2257 did_filetype() Returns non-zero when autocommands are being executed and the
2258 FileType event has been triggered at least once. Can be used
2259 to avoid triggering the FileType event again in the scripts
2260 that detect the file type. |FileType|
2261 When editing another file, the counter is reset, thus this
2262 really checks if the FileType event has been triggered for the
2263 current buffer. This allows an autocommand that starts
2264 editing another buffer to set 'filetype' and load a syntax
2265 file.
2267 diff_filler({lnum}) *diff_filler()*
2268 Returns the number of filler lines above line {lnum}.
2269 These are the lines that were inserted at this point in
2270 another diff'ed window. These filler lines are shown in the
2271 display but don't exist in the buffer.
2272 {lnum} is used like with |getline()|. Thus "." is the current
2273 line, "'m" mark m, etc.
2274 Returns 0 if the current window is not in diff mode.
2276 diff_hlID({lnum}, {col}) *diff_hlID()*
2277 Returns the highlight ID for diff mode at line {lnum} column
2278 {col} (byte index). When the current line does not have a
2279 diff change zero is returned.
2280 {lnum} is used like with |getline()|. Thus "." is the current
2281 line, "'m" mark m, etc.
2282 {col} is 1 for the leftmost column, {lnum} is 1 for the first
2283 line.
2284 The highlight ID can be used with |synIDattr()| to obtain
2285 syntax information about the highlighting.
2287 empty({expr}) *empty()*
2288 Return the Number 1 if {expr} is empty, zero otherwise.
2289 A |List| or |Dictionary| is empty when it does not have any
2290 items. A Number is empty when its value is zero.
2291 For a long |List| this is much faster then comparing the
2292 length with zero.
2294 escape({string}, {chars}) *escape()*
2295 Escape the characters in {chars} that occur in {string} with a
2296 backslash. Example: >
2297 :echo escape('c:\program files\vim', ' \')
2298 < results in: >
2299 c:\\program\ files\\vim
2301 < *eval()*
2302 eval({string}) Evaluate {string} and return the result. Especially useful to
2303 turn the result of |string()| back into the original value.
2304 This works for Numbers, Strings and composites of them.
2305 Also works for |Funcref|s that refer to existing functions.
2307 eventhandler() *eventhandler()*
2308 Returns 1 when inside an event handler. That is that Vim got
2309 interrupted while waiting for the user to type a character,
2310 e.g., when dropping a file on Vim. This means interactive
2311 commands cannot be used. Otherwise zero is returned.
2313 executable({expr}) *executable()*
2314 This function checks if an executable with the name {expr}
2315 exists. {expr} must be the name of the program without any
2316 arguments.
2317 executable() uses the value of $PATH and/or the normal
2318 searchpath for programs. *PATHEXT*
2319 On MS-DOS and MS-Windows the ".exe", ".bat", etc. can
2320 optionally be included. Then the extensions in $PATHEXT are
2321 tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be
2322 found. If $PATHEXT is not set then ".exe;.com;.bat;.cmd" is
2323 used. A dot by itself can be used in $PATHEXT to try using
2324 the name without an extension. When 'shell' looks like a
2325 Unix shell, then the name is also tried without adding an
2326 extension.
2327 On MS-DOS and MS-Windows it only checks if the file exists and
2328 is not a directory, not if it's really executable.
2329 On MS-Windows an executable in the same directory as Vim is
2330 always found. Since this directory is added to $PATH it
2331 should also work to execute it |win32-PATH|.
2332 The result is a Number:
2333 1 exists
2334 0 does not exist
2335 -1 not implemented on this system
2337 *exists()*
2338 exists({expr}) The result is a Number, which is non-zero if {expr} is
2339 defined, zero otherwise. The {expr} argument is a string,
2340 which contains one of these:
2341 &option-name Vim option (only checks if it exists,
2342 not if it really works)
2343 +option-name Vim option that works.
2344 $ENVNAME environment variable (could also be
2345 done by comparing with an empty
2346 string)
2347 *funcname built-in function (see |functions|)
2348 or user defined function (see
2349 |user-functions|).
2350 varname internal variable (see
2351 |internal-variables|). Also works
2352 for |curly-braces-names|, |Dictionary|
2353 entries, |List| items, etc. Beware
2354 that this may cause functions to be
2355 invoked cause an error message for an
2356 invalid expression.
2357 :cmdname Ex command: built-in command, user
2358 command or command modifier |:command|.
2359 Returns:
2360 1 for match with start of a command
2361 2 full match with a command
2362 3 matches several user commands
2363 To check for a supported command
2364 always check the return value to be 2.
2365 :2match The |:2match| command.
2366 :3match The |:3match| command.
2367 #event autocommand defined for this event
2368 #event#pattern autocommand defined for this event and
2369 pattern (the pattern is taken
2370 literally and compared to the
2371 autocommand patterns character by
2372 character)
2373 #group autocommand group exists
2374 #group#event autocommand defined for this group and
2375 event.
2376 #group#event#pattern
2377 autocommand defined for this group,
2378 event and pattern.
2379 ##event autocommand for this event is
2380 supported.
2381 For checking for a supported feature use |has()|.
2383 Examples: >
2384 exists("&shortname")
2385 exists("$HOSTNAME")
2386 exists("*strftime")
2387 exists("*s:MyFunc")
2388 exists("bufcount")
2389 exists(":Make")
2390 exists("#CursorHold")
2391 exists("#BufReadPre#*.gz")
2392 exists("#filetypeindent")
2393 exists("#filetypeindent#FileType")
2394 exists("#filetypeindent#FileType#*")
2395 exists("##ColorScheme")
2396 < There must be no space between the symbol (&/$/*/#) and the
2397 name.
2398 There must be no extra characters after the name, although in
2399 a few cases this is ignored. That may become more strict in
2400 the future, thus don't count on it!
2401 Working example: >
2402 exists(":make")
2403 < NOT working example: >
2404 exists(":make install")
2406 < Note that the argument must be a string, not the name of the
2407 variable itself. For example: >
2408 exists(bufcount)
2409 < This doesn't check for existence of the "bufcount" variable,
2410 but gets the value of "bufcount", and checks if that exists.
2412 expand({expr} [, {flag}]) *expand()*
2413 Expand wildcards and the following special keywords in {expr}.
2414 The result is a String.
2416 When there are several matches, they are separated by <NL>
2417 characters. [Note: in version 5.0 a space was used, which
2418 caused problems when a file name contains a space]
2420 If the expansion fails, the result is an empty string. A name
2421 for a non-existing file is not included.
2423 When {expr} starts with '%', '#' or '<', the expansion is done
2424 like for the |cmdline-special| variables with their associated
2425 modifiers. Here is a short overview:
2427 % current file name
2428 # alternate file name
2429 #n alternate file name n
2430 <cfile> file name under the cursor
2431 <afile> autocmd file name
2432 <abuf> autocmd buffer number (as a String!)
2433 <amatch> autocmd matched name
2434 <sfile> sourced script file name
2435 <cword> word under the cursor
2436 <cWORD> WORD under the cursor
2437 <client> the {clientid} of the last received
2438 message |server2client()|
2439 Modifiers:
2440 :p expand to full path
2441 :h head (last path component removed)
2442 :t tail (last path component only)
2443 :r root (one extension removed)
2444 :e extension only
2446 Example: >
2447 :let &tags = expand("%:p:h") . "/tags"
2448 < Note that when expanding a string that starts with '%', '#' or
2449 '<', any following text is ignored. This does NOT work: >
2450 :let doesntwork = expand("%:h.bak")
2451 < Use this: >
2452 :let doeswork = expand("%:h") . ".bak"
2453 < Also note that expanding "<cfile>" and others only returns the
2454 referenced file name without further expansion. If "<cfile>"
2455 is "~/.cshrc", you need to do another expand() to have the
2456 "~/" expanded into the path of the home directory: >
2457 :echo expand(expand("<cfile>"))
2458 <
2459 There cannot be white space between the variables and the
2460 following modifier. The |fnamemodify()| function can be used
2461 to modify normal file names.
2463 When using '%' or '#', and the current or alternate file name
2464 is not defined, an empty string is used. Using "%:p" in a
2465 buffer with no name, results in the current directory, with a
2466 '/' added.
2468 When {expr} does not start with '%', '#' or '<', it is
2469 expanded like a file name is expanded on the command line.
2470 'suffixes' and 'wildignore' are used, unless the optional
2471 {flag} argument is given and it is non-zero. Names for
2472 non-existing files are included. The "**" item can be used to
2473 search in a directory tree. For example, to find all "README"
2474 files in the current directory and below: >
2475 :echo expand("**/README")
2476 <
2477 Expand() can also be used to expand variables and environment
2478 variables that are only known in a shell. But this can be
2479 slow, because a shell must be started. See |expr-env-expand|.
2480 The expanded variable is still handled like a list of file
2481 names. When an environment variable cannot be expanded, it is
2482 left unchanged. Thus ":echo expand('$FOOBAR')" results in
2483 "$FOOBAR".
2485 See |glob()| for finding existing files. See |system()| for
2486 getting the raw output of an external command.
2488 extend({expr1}, {expr2} [, {expr3}]) *extend()*
2489 {expr1} and {expr2} must be both |Lists| or both
2490 |Dictionaries|.
2492 If they are |Lists|: Append {expr2} to {expr1}.
2493 If {expr3} is given insert the items of {expr2} before item
2494 {expr3} in {expr1}. When {expr3} is zero insert before the
2495 first item. When {expr3} is equal to len({expr1}) then
2496 {expr2} is appended.
2497 Examples: >
2498 :echo sort(extend(mylist, [7, 5]))
2499 :call extend(mylist, [2, 3], 1)
2500 < Use |add()| to concatenate one item to a list. To concatenate
2501 two lists into a new list use the + operator: >
2502 :let newlist = [1, 2, 3] + [4, 5]
2503 <
2504 If they are |Dictionaries|:
2505 Add all entries from {expr2} to {expr1}.
2506 If a key exists in both {expr1} and {expr2} then {expr3} is
2507 used to decide what to do:
2508 {expr3} = "keep": keep the value of {expr1}
2509 {expr3} = "force": use the value of {expr2}
2510 {expr3} = "error": give an error message *E737*
2511 When {expr3} is omitted then "force" is assumed.
2513 {expr1} is changed when {expr2} is not empty. If necessary
2514 make a copy of {expr1} first.
2515 {expr2} remains unchanged.
2516 Returns {expr1}.
2519 feedkeys({string} [, {mode}]) *feedkeys()*
2520 Characters in {string} are queued for processing as if they
2521 come from a mapping or were typed by the user. They are added
2522 to the end of the typeahead buffer, thus if a mapping is still
2523 being executed these characters come after them.
2524 The function does not wait for processing of keys contained in
2525 {string}.
2526 To include special keys into {string}, use double-quotes
2527 and "\..." notation |expr-quote|. For example,
2528 feedkeys("\<CR>") simulates pressing of the <Enter> key. But
2529 feedkeys('\<CR>') pushes 5 characters.
2530 If {mode} is absent, keys are remapped.
2531 {mode} is a String, which can contain these character flags:
2532 'm' Remap keys. This is default.
2533 'n' Do not remap keys.
2534 't' Handle keys as if typed; otherwise they are handled as
2535 if coming from a mapping. This matters for undo,
2536 opening folds, etc.
2537 Return value is always 0.
2539 filereadable({file}) *filereadable()*
2540 The result is a Number, which is TRUE when a file with the
2541 name {file} exists, and can be read. If {file} doesn't exist,
2542 or is a directory, the result is FALSE. {file} is any
2543 expression, which is used as a String.
2544 If you don't care about the file being readable you can use
2545 |glob()|.
2546 *file_readable()*
2547 Obsolete name: file_readable().
2550 filewritable({file}) *filewritable()*
2551 The result is a Number, which is 1 when a file with the
2552 name {file} exists, and can be written. If {file} doesn't
2553 exist, or is not writable, the result is 0. If (file) is a
2554 directory, and we can write to it, the result is 2.
2557 filter({expr}, {string}) *filter()*
2558 {expr} must be a |List| or a |Dictionary|.
2559 For each item in {expr} evaluate {string} and when the result
2560 is zero remove the item from the |List| or |Dictionary|.
2561 Inside {string} |v:val| has the value of the current item.
2562 For a |Dictionary| |v:key| has the key of the current item.
2563 Examples: >
2564 :call filter(mylist, 'v:val !~ "OLD"')
2565 < Removes the items where "OLD" appears. >
2566 :call filter(mydict, 'v:key >= 8')
2567 < Removes the items with a key below 8. >
2568 :call filter(var, 0)
2569 < Removes all the items, thus clears the |List| or |Dictionary|.
2571 Note that {string} is the result of expression and is then
2572 used as an expression again. Often it is good to use a
2573 |literal-string| to avoid having to double backslashes.
2575 The operation is done in-place. If you want a |List| or
2576 |Dictionary| to remain unmodified make a copy first: >
2577 :let l = filter(copy(mylist), 'v:val =~ "KEEP"')
2579 < Returns {expr}, the |List| or |Dictionary| that was filtered.
2580 When an error is encountered while evaluating {string} no
2581 further items in {expr} are processed.
2584 finddir({name}[, {path}[, {count}]]) *finddir()*
2585 Find directory {name} in {path}. Supports both downwards and
2586 upwards recursive directory searches. See |file-searching|
2587 for the syntax of {path}.
2588 Returns the path of the first found match. When the found
2589 directory is below the current directory a relative path is
2590 returned. Otherwise a full path is returned.
2591 If {path} is omitted or empty then 'path' is used.
2592 If the optional {count} is given, find {count}'s occurrence of
2593 {name} in {path} instead of the first one.
2594 When {count} is negative return all the matches in a |List|.
2595 This is quite similar to the ex-command |:find|.
2596 {only available when compiled with the +file_in_path feature}
2598 findfile({name}[, {path}[, {count}]]) *findfile()*
2599 Just like |finddir()|, but find a file instead of a directory.
2600 Uses 'suffixesadd'.
2601 Example: >
2602 :echo findfile("tags.vim", ".;")
2603 < Searches from the directory of the current file upwards until
2604 it finds the file "tags.vim".
2606 fnamemodify({fname}, {mods}) *fnamemodify()*
2607 Modify file name {fname} according to {mods}. {mods} is a
2608 string of characters like it is used for file names on the
2609 command line. See |filename-modifiers|.
2610 Example: >
2611 :echo fnamemodify("main.c", ":p:h")
2612 < results in: >
2613 /home/mool/vim/vim/src
2614 < Note: Environment variables and "~" don't work in {fname}, use
2615 |expand()| first then.
2617 foldclosed({lnum}) *foldclosed()*
2618 The result is a Number. If the line {lnum} is in a closed
2619 fold, the result is the number of the first line in that fold.
2620 If the line {lnum} is not in a closed fold, -1 is returned.
2622 foldclosedend({lnum}) *foldclosedend()*
2623 The result is a Number. If the line {lnum} is in a closed
2624 fold, the result is the number of the last line in that fold.
2625 If the line {lnum} is not in a closed fold, -1 is returned.
2627 foldlevel({lnum}) *foldlevel()*
2628 The result is a Number, which is the foldlevel of line {lnum}
2629 in the current buffer. For nested folds the deepest level is
2630 returned. If there is no fold at line {lnum}, zero is
2631 returned. It doesn't matter if the folds are open or closed.
2632 When used while updating folds (from 'foldexpr') -1 is
2633 returned for lines where folds are still to be updated and the
2634 foldlevel is unknown. As a special case the level of the
2635 previous line is usually available.
2637 *foldtext()*
2638 foldtext() Returns a String, to be displayed for a closed fold. This is
2639 the default function used for the 'foldtext' option and should
2640 only be called from evaluating 'foldtext'. It uses the
2641 |v:foldstart|, |v:foldend| and |v:folddashes| variables.
2642 The returned string looks like this: >
2643 +-- 45 lines: abcdef
2644 < The number of dashes depends on the foldlevel. The "45" is
2645 the number of lines in the fold. "abcdef" is the text in the
2646 first non-blank line of the fold. Leading white space, "//"
2647 or "/*" and the text from the 'foldmarker' and 'commentstring'
2648 options is removed.
2649 {not available when compiled without the |+folding| feature}
2651 foldtextresult({lnum}) *foldtextresult()*
2652 Returns the text that is displayed for the closed fold at line
2653 {lnum}. Evaluates 'foldtext' in the appropriate context.
2654 When there is no closed fold at {lnum} an empty string is
2655 returned.
2656 {lnum} is used like with |getline()|. Thus "." is the current
2657 line, "'m" mark m, etc.
2658 Useful when exporting folded text, e.g., to HTML.
2659 {not available when compiled without the |+folding| feature}
2661 *foreground()*
2662 foreground() Move the Vim window to the foreground. Useful when sent from
2663 a client to a Vim server. |remote_send()|
2664 On Win32 systems this might not work, the OS does not always
2665 allow a window to bring itself to the foreground. Use
2666 |remote_foreground()| instead.
2667 {only in the Win32, Athena, Motif and GTK GUI versions and the
2668 Win32 console version}
2671 function({name}) *function()* *E700*
2672 Return a |Funcref| variable that refers to function {name}.
2673 {name} can be a user defined function or an internal function.
2676 garbagecollect([at_exit]) *garbagecollect()*
2677 Cleanup unused |Lists| and |Dictionaries| that have circular
2678 references. There is hardly ever a need to invoke this
2679 function, as it is automatically done when Vim runs out of
2680 memory or is waiting for the user to press a key after
2681 'updatetime'. Items without circular references are always
2682 freed when they become unused.
2683 This is useful if you have deleted a very big |List| and/or
2684 |Dictionary| with circular references in a script that runs
2685 for a long time.
2686 When the optional "at_exit" argument is one, garbage
2687 collection will also be done when exiting Vim, if it wasn't
2688 done before. This is useful when checking for memory leaks.
2690 get({list}, {idx} [, {default}]) *get()*
2691 Get item {idx} from |List| {list}. When this item is not
2692 available return {default}. Return zero when {default} is
2693 omitted.
2694 get({dict}, {key} [, {default}])
2695 Get item with key {key} from |Dictionary| {dict}. When this
2696 item is not available return {default}. Return zero when
2697 {default} is omitted.
2699 *getbufline()*
2700 getbufline({expr}, {lnum} [, {end}])
2701 Return a |List| with the lines starting from {lnum} to {end}
2702 (inclusive) in the buffer {expr}. If {end} is omitted, a
2703 |List| with only the line {lnum} is returned.
2705 For the use of {expr}, see |bufname()| above.
2707 For {lnum} and {end} "$" can be used for the last line of the
2708 buffer. Otherwise a number must be used.
2710 When {lnum} is smaller than 1 or bigger than the number of
2711 lines in the buffer, an empty |List| is returned.
2713 When {end} is greater than the number of lines in the buffer,
2714 it is treated as {end} is set to the number of lines in the
2715 buffer. When {end} is before {lnum} an empty |List| is
2716 returned.
2718 This function works only for loaded buffers. For unloaded and
2719 non-existing buffers, an empty |List| is returned.
2721 Example: >
2722 :let lines = getbufline(bufnr("myfile"), 1, "$")
2724 getbufvar({expr}, {varname}) *getbufvar()*
2725 The result is the value of option or local buffer variable
2726 {varname} in buffer {expr}. Note that the name without "b:"
2727 must be used.
2728 This also works for a global or buffer-local option, but it
2729 doesn't work for a global variable, window-local variable or
2730 window-local option.
2731 For the use of {expr}, see |bufname()| above.
2732 When the buffer or variable doesn't exist an empty string is
2733 returned, there is no error message.
2734 Examples: >
2735 :let bufmodified = getbufvar(1, "&mod")
2736 :echo "todo myvar = " . getbufvar("todo", "myvar")
2737 <
2738 getchar([expr]) *getchar()*
2739 Get a single character from the user or input stream.
2740 If [expr] is omitted, wait until a character is available.
2741 If [expr] is 0, only get a character when one is available.
2742 Return zero otherwise.
2743 If [expr] is 1, only check if a character is available, it is
2744 not consumed. Return zero if no character available.
2746 Without {expr} and when {expr} is 0 a whole character or
2747 special key is returned. If it is an 8-bit character, the
2748 result is a number. Use nr2char() to convert it to a String.
2749 Otherwise a String is returned with the encoded character.
2750 For a special key it's a sequence of bytes starting with 0x80
2751 (decimal: 128). This is the same value as the string
2752 "\<Key>", e.g., "\<Left>". The returned value is also a
2753 String when a modifier (shift, control, alt) was used that is
2754 not included in the character.
2756 When {expr} is 1 only the first byte is returned. For a
2757 one-byte character it is the character itself as a number.
2758 Use nr2char() to convert it to a String.
2760 When the user clicks a mouse button, the mouse event will be
2761 returned. The position can then be found in |v:mouse_col|,
2762 |v:mouse_lnum| and |v:mouse_win|. This example positions the
2763 mouse as it would normally happen: >
2764 let c = getchar()
2765 if c == "\<LeftMouse>" && v:mouse_win > 0
2766 exe v:mouse_win . "wincmd w"
2767 exe v:mouse_lnum
2768 exe "normal " . v:mouse_col . "|"
2769 endif
2770 <
2771 There is no prompt, you will somehow have to make clear to the
2772 user that a character has to be typed.
2773 There is no mapping for the character.
2774 Key codes are replaced, thus when the user presses the <Del>
2775 key you get the code for the <Del> key, not the raw character
2776 sequence. Examples: >
2777 getchar() == "\<Del>"
2778 getchar() == "\<S-Left>"
2779 < This example redefines "f" to ignore case: >
2780 :nmap f :call FindChar()<CR>
2781 :function FindChar()
2782 : let c = nr2char(getchar())
2783 : while col('.') < col('$') - 1
2784 : normal l
2785 : if getline('.')[col('.') - 1] ==? c
2786 : break
2787 : endif
2788 : endwhile
2789 :endfunction
2791 getcharmod() *getcharmod()*
2792 The result is a Number which is the state of the modifiers for
2793 the last obtained character with getchar() or in another way.
2794 These values are added together:
2795 2 shift
2796 4 control
2797 8 alt (meta)
2798 16 mouse double click
2799 32 mouse triple click
2800 64 mouse quadruple click
2801 128 Macintosh only: command
2802 Only the modifiers that have not been included in the
2803 character itself are obtained. Thus Shift-a results in "A"
2804 with no modifier.
2806 getcmdline() *getcmdline()*
2807 Return the current command-line. Only works when the command
2808 line is being edited, thus requires use of |c_CTRL-\_e| or
2809 |c_CTRL-R_=|.
2810 Example: >
2811 :cmap <F7> <C-\>eescape(getcmdline(), ' \')<CR>
2812 < Also see |getcmdtype()|, |getcmdpos()| and |setcmdpos()|.
2814 getcmdpos() *getcmdpos()*
2815 Return the position of the cursor in the command line as a
2816 byte count. The first column is 1.
2817 Only works when editing the command line, thus requires use of
2818 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns 0 otherwise.
2819 Also see |getcmdtype()|, |setcmdpos()| and |getcmdline()|.
2821 getcmdtype() *getcmdtype()*
2822 Return the current command-line type. Possible return values
2823 are:
2824 : normal Ex command
2825 > debug mode command |debug-mode|
2826 / forward search command
2827 ? backward search command
2828 @ |input()| command
2829 - |:insert| or |:append| command
2830 Only works when editing the command line, thus requires use of
2831 |c_CTRL-\_e| or |c_CTRL-R_=|. Returns an empty string
2832 otherwise.
2833 Also see |getcmdpos()|, |setcmdpos()| and |getcmdline()|.
2835 *getcwd()*
2836 getcwd() The result is a String, which is the name of the current
2837 working directory.
2839 getfsize({fname}) *getfsize()*
2840 The result is a Number, which is the size in bytes of the
2841 given file {fname}.
2842 If {fname} is a directory, 0 is returned.
2843 If the file {fname} can't be found, -1 is returned.
2844 If the size of {fname} is too big to fit in a Number then -2
2845 is returned.
2847 getfontname([{name}]) *getfontname()*
2848 Without an argument returns the name of the normal font being
2849 used. Like what is used for the Normal highlight group
2850 |hl-Normal|.
2851 With an argument a check is done whether {name} is a valid
2852 font name. If not then an empty string is returned.
2853 Otherwise the actual font name is returned, or {name} if the
2854 GUI does not support obtaining the real name.
2855 Only works when the GUI is running, thus not in your vimrc or
2856 gvimrc file. Use the |GUIEnter| autocommand to use this
2857 function just after the GUI has started.
2858 Note that the GTK 2 GUI accepts any font name, thus checking
2859 for a valid name does not work.
2861 getfperm({fname}) *getfperm()*
2862 The result is a String, which is the read, write, and execute
2863 permissions of the given file {fname}.
2864 If {fname} does not exist or its directory cannot be read, an
2865 empty string is returned.
2866 The result is of the form "rwxrwxrwx", where each group of
2867 "rwx" flags represent, in turn, the permissions of the owner
2868 of the file, the group the file belongs to, and other users.
2869 If a user does not have a given permission the flag for this
2870 is replaced with the string "-". Example: >
2871 :echo getfperm("/etc/passwd")
2872 < This will hopefully (from a security point of view) display
2873 the string "rw-r--r--" or even "rw-------".
2875 getftime({fname}) *getftime()*
2876 The result is a Number, which is the last modification time of
2877 the given file {fname}. The value is measured as seconds
2878 since 1st Jan 1970, and may be passed to strftime(). See also
2879 |localtime()| and |strftime()|.
2880 If the file {fname} can't be found -1 is returned.
2882 getftype({fname}) *getftype()*
2883 The result is a String, which is a description of the kind of
2884 file of the given file {fname}.
2885 If {fname} does not exist an empty string is returned.
2886 Here is a table over different kinds of files and their
2887 results:
2888 Normal file "file"
2889 Directory "dir"
2890 Symbolic link "link"
2891 Block device "bdev"
2892 Character device "cdev"
2893 Socket "socket"
2894 FIFO "fifo"
2895 All other "other"
2896 Example: >
2897 getftype("/home")
2898 < Note that a type such as "link" will only be returned on
2899 systems that support it. On some systems only "dir" and
2900 "file" are returned.
2902 *getline()*
2903 getline({lnum} [, {end}])
2904 Without {end} the result is a String, which is line {lnum}
2905 from the current buffer. Example: >
2906 getline(1)
2907 < When {lnum} is a String that doesn't start with a
2908 digit, line() is called to translate the String into a Number.
2909 To get the line under the cursor: >
2910 getline(".")
2911 < When {lnum} is smaller than 1 or bigger than the number of
2912 lines in the buffer, an empty string is returned.
2914 When {end} is given the result is a |List| where each item is
2915 a line from the current buffer in the range {lnum} to {end},
2916 including line {end}.
2917 {end} is used in the same way as {lnum}.
2918 Non-existing lines are silently omitted.
2919 When {end} is before {lnum} an empty |List| is returned.
2920 Example: >
2921 :let start = line('.')
2922 :let end = search("^$") - 1
2923 :let lines = getline(start, end)
2925 < To get lines from another buffer see |getbufline()|
2927 getloclist({nr}) *getloclist()*
2928 Returns a list with all the entries in the location list for
2929 window {nr}. When {nr} is zero the current window is used.
2930 For a location list window, the displayed location list is
2931 returned. For an invalid window number {nr}, an empty list is
2932 returned. Otherwise, same as getqflist().
2934 getmatches() *getmatches()*
2935 Returns a |List| with all matches previously defined by
2936 |matchadd()| and the |:match| commands. |getmatches()| is
2937 useful in combination with |setmatches()|, as |setmatches()|
2938 can restore a list of matches saved by |getmatches()|.
2939 Example: >
2940 :echo getmatches()
2941 < [{'group': 'MyGroup1', 'pattern': 'TODO',
2942 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
2943 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
2944 :let m = getmatches()
2945 :call clearmatches()
2946 :echo getmatches()
2947 < [] >
2948 :call setmatches(m)
2949 :echo getmatches()
2950 < [{'group': 'MyGroup1', 'pattern': 'TODO',
2951 'priority': 10, 'id': 1}, {'group': 'MyGroup2',
2952 'pattern': 'FIXME', 'priority': 10, 'id': 2}] >
2953 :unlet m
2954 <
2956 getqflist() *getqflist()*
2957 Returns a list with all the current quickfix errors. Each
2958 list item is a dictionary with these entries:
2959 bufnr number of buffer that has the file name, use
2960 bufname() to get the name
2961 lnum line number in the buffer (first line is 1)
2962 col column number (first column is 1)
2963 vcol non-zero: "col" is visual column
2964 zero: "col" is byte index
2965 nr error number
2966 pattern search pattern used to locate the error
2967 text description of the error
2968 type type of the error, 'E', '1', etc.
2969 valid non-zero: recognized error message
2971 When there is no error list or it's empty an empty list is
2972 returned. Quickfix list entries with non-existing buffer
2973 number are returned with "bufnr" set to zero.
2975 Useful application: Find pattern matches in multiple files and
2976 do something with them: >
2977 :vimgrep /theword/jg *.c
2978 :for d in getqflist()
2979 : echo bufname(d.bufnr) ':' d.lnum '=' d.text
2980 :endfor
2983 getreg([{regname} [, 1]]) *getreg()*
2984 The result is a String, which is the contents of register
2985 {regname}. Example: >
2986 :let cliptext = getreg('*')
2987 < getreg('=') returns the last evaluated value of the expression
2988 register. (For use in maps.)
2989 getreg('=', 1) returns the expression itself, so that it can
2990 be restored with |setreg()|. For other registers the extra
2991 argument is ignored, thus you can always give it.
2992 If {regname} is not specified, |v:register| is used.
2995 getregtype([{regname}]) *getregtype()*
2996 The result is a String, which is type of register {regname}.
2997 The value will be one of:
2998 "v" for |characterwise| text
2999 "V" for |linewise| text
3000 "<CTRL-V>{width}" for |blockwise-visual| text
3001 0 for an empty or unknown register
3002 <CTRL-V> is one character with value 0x16.
3003 If {regname} is not specified, |v:register| is used.
3005 gettabwinvar({tabnr}, {winnr}, {varname}) *gettabwinvar()*
3006 Get the value of window-local variable {varname} in window
3007 {winnr} in tab page {tabnr}.
3008 When {varname} starts with "&" get the value of a window-local
3009 option.
3010 Tabs are numbered starting with one. For the current tabpage
3011 use |getwinvar()|.
3012 When {winnr} is zero the current window is used.
3013 This also works for a global option, buffer-local option and
3014 window-local option, but it doesn't work for a global variable
3015 or buffer-local variable.
3016 When {varname} is empty a dictionary with all window-local
3017 variables is returned.
3018 Note that {varname} must be the name without "w:".
3019 Examples: >
3020 :let list_is_on = gettabwinvar(1, 2, '&list')
3021 :echo "myvar = " . gettabwinvar(3, 1, 'myvar')
3022 <
3023 *getwinposx()*
3024 getwinposx() The result is a Number, which is the X coordinate in pixels of
3025 the left hand side of the GUI Vim window. The result will be
3026 -1 if the information is not available.
3028 *getwinposy()*
3029 getwinposy() The result is a Number, which is the Y coordinate in pixels of
3030 the top of the GUI Vim window. The result will be -1 if the
3031 information is not available.
3033 getwinvar({winnr}, {varname}) *getwinvar()*
3034 Like |gettabwinvar()| for the current tabpage.
3035 Examples: >
3036 :let list_is_on = getwinvar(2, '&list')
3037 :echo "myvar = " . getwinvar(1, 'myvar')
3038 <
3039 *glob()*
3040 glob({expr}) Expand the file wildcards in {expr}. See |wildcards| for the
3041 use of special characters.
3042 The result is a String.
3043 When there are several matches, they are separated by <NL>
3044 characters.
3045 If the expansion fails, the result is an empty string.
3046 A name for a non-existing file is not included.
3048 For most systems backticks can be used to get files names from
3049 any external command. Example: >
3050 :let tagfiles = glob("`find . -name tags -print`")
3051 :let &tags = substitute(tagfiles, "\n", ",", "g")
3052 < The result of the program inside the backticks should be one
3053 item per line. Spaces inside an item are allowed.
3055 See |expand()| for expanding special Vim variables. See
3056 |system()| for getting the raw output of an external command.
3058 globpath({path}, {expr}) *globpath()*
3059 Perform glob() on all directories in {path} and concatenate
3060 the results. Example: >
3061 :echo globpath(&rtp, "syntax/c.vim")
3062 < {path} is a comma-separated list of directory names. Each
3063 directory name is prepended to {expr} and expanded like with
3064 glob(). A path separator is inserted when needed.
3065 To add a comma inside a directory name escape it with a
3066 backslash. Note that on MS-Windows a directory may have a
3067 trailing backslash, remove it if you put a comma after it.
3068 If the expansion fails for one of the directories, there is no
3069 error message.
3070 The 'wildignore' option applies: Names matching one of the
3071 patterns in 'wildignore' will be skipped.
3073 The "**" item can be used to search in a directory tree.
3074 For example, to find all "README.txt" files in the directories
3075 in 'runtimepath' and below: >
3076 :echo globpath(&rtp, "**/README.txt")
3077 <
3078 *has()*
3079 has({feature}) The result is a Number, which is 1 if the feature {feature} is
3080 supported, zero otherwise. The {feature} argument is a
3081 string. See |feature-list| below.
3082 Also see |exists()|.
3085 has_key({dict}, {key}) *has_key()*
3086 The result is a Number, which is 1 if |Dictionary| {dict} has
3087 an entry with key {key}. Zero otherwise.
3089 haslocaldir() *haslocaldir()*
3090 The result is a Number, which is 1 when the current
3091 window has set a local path via |:lcd|, and 0 otherwise.
3093 hasmapto({what} [, {mode} [, {abbr}]]) *hasmapto()*
3094 The result is a Number, which is 1 if there is a mapping that
3095 contains {what} in somewhere in the rhs (what it is mapped to)
3096 and this mapping exists in one of the modes indicated by
3097 {mode}.
3098 When {abbr} is there and it is non-zero use abbreviations
3099 instead of mappings. Don't forget to specify Insert and/or
3100 Command-line mode.
3101 Both the global mappings and the mappings local to the current
3102 buffer are checked for a match.
3103 If no matching mapping is found 0 is returned.
3104 The following characters are recognized in {mode}:
3105 n Normal mode
3106 v Visual mode
3107 o Operator-pending mode
3108 i Insert mode
3109 l Language-Argument ("r", "f", "t", etc.)
3110 c Command-line mode
3111 When {mode} is omitted, "nvo" is used.
3113 This function is useful to check if a mapping already exists
3114 to a function in a Vim script. Example: >
3115 :if !hasmapto('\ABCdoit')
3116 : map <Leader>d \ABCdoit
3117 :endif
3118 < This installs the mapping to "\ABCdoit" only if there isn't
3119 already a mapping to "\ABCdoit".
3121 histadd({history}, {item}) *histadd()*
3122 Add the String {item} to the history {history} which can be
3123 one of: *hist-names*
3124 "cmd" or ":" command line history
3125 "search" or "/" search pattern history
3126 "expr" or "=" typed expression history
3127 "input" or "@" input line history
3128 If {item} does already exist in the history, it will be
3129 shifted to become the newest entry.
3130 The result is a Number: 1 if the operation was successful,
3131 otherwise 0 is returned.
3133 Example: >
3134 :call histadd("input", strftime("%Y %b %d"))
3135 :let date=input("Enter date: ")
3136 < This function is not available in the |sandbox|.
3138 histdel({history} [, {item}]) *histdel()*
3139 Clear {history}, i.e. delete all its entries. See |hist-names|
3140 for the possible values of {history}.
3142 If the parameter {item} is given as String, this is seen
3143 as regular expression. All entries matching that expression
3144 will be removed from the history (if there are any).
3145 Upper/lowercase must match, unless "\c" is used |/\c|.
3146 If {item} is a Number, it will be interpreted as index, see
3147 |:history-indexing|. The respective entry will be removed
3148 if it exists.
3150 The result is a Number: 1 for a successful operation,
3151 otherwise 0 is returned.
3153 Examples:
3154 Clear expression register history: >
3155 :call histdel("expr")
3156 <
3157 Remove all entries starting with "*" from the search history: >
3158 :call histdel("/", '^\*')
3159 <
3160 The following three are equivalent: >
3161 :call histdel("search", histnr("search"))
3162 :call histdel("search", -1)
3163 :call histdel("search", '^'.histget("search", -1).'$')
3164 <
3165 To delete the last search pattern and use the last-but-one for
3166 the "n" command and 'hlsearch': >
3167 :call histdel("search", -1)
3168 :let @/ = histget("search", -1)
3170 histget({history} [, {index}]) *histget()*
3171 The result is a String, the entry with Number {index} from
3172 {history}. See |hist-names| for the possible values of
3173 {history}, and |:history-indexing| for {index}. If there is
3174 no such entry, an empty String is returned. When {index} is
3175 omitted, the most recent item from the history is used.
3177 Examples:
3178 Redo the second last search from history. >
3179 :execute '/' . histget("search", -2)
3181 < Define an Ex command ":H {num}" that supports re-execution of
3182 the {num}th entry from the output of |:history|. >
3183 :command -nargs=1 H execute histget("cmd", 0+<args>)
3184 <
3185 histnr({history}) *histnr()*
3186 The result is the Number of the current entry in {history}.
3187 See |hist-names| for the possible values of {history}.
3188 If an error occurred, -1 is returned.
3190 Example: >
3191 :let inp_index = histnr("expr")
3192 <
3193 hlexists({name}) *hlexists()*
3194 The result is a Number, which is non-zero if a highlight group
3195 called {name} exists. This is when the group has been
3196 defined in some way. Not necessarily when highlighting has
3197 been defined for it, it may also have been used for a syntax
3198 item.
3199 *highlight_exists()*
3200 Obsolete name: highlight_exists().
3202 *hlID()*
3203 hlID({name}) The result is a Number, which is the ID of the highlight group
3204 with name {name}. When the highlight group doesn't exist,
3205 zero is returned.
3206 This can be used to retrieve information about the highlight
3207 group. For example, to get the background color of the
3208 "Comment" group: >
3209 :echo synIDattr(synIDtrans(hlID("Comment")), "bg")
3210 < *highlightID()*
3211 Obsolete name: highlightID().
3213 hostname() *hostname()*
3214 The result is a String, which is the name of the machine on
3215 which Vim is currently running. Machine names greater than
3216 256 characters long are truncated.
3218 iconv({expr}, {from}, {to}) *iconv()*
3219 The result is a String, which is the text {expr} converted
3220 from encoding {from} to encoding {to}.
3221 When the conversion fails an empty string is returned.
3222 The encoding names are whatever the iconv() library function
3223 can accept, see ":!man 3 iconv".
3224 Most conversions require Vim to be compiled with the |+iconv|
3225 feature. Otherwise only UTF-8 to latin1 conversion and back
3226 can be done.
3227 This can be used to display messages with special characters,
3228 no matter what 'encoding' is set to. Write the message in
3229 UTF-8 and use: >
3230 echo iconv(utf8_str, "utf-8", &enc)
3231 < Note that Vim uses UTF-8 for all Unicode encodings, conversion
3232 from/to UCS-2 is automatically changed to use UTF-8. You
3233 cannot use UCS-2 in a string anyway, because of the NUL bytes.
3234 {only available when compiled with the +multi_byte feature}
3236 *indent()*
3237 indent({lnum}) The result is a Number, which is indent of line {lnum} in the
3238 current buffer. The indent is counted in spaces, the value
3239 of 'tabstop' is relevant. {lnum} is used just like in
3240 |getline()|.
3241 When {lnum} is invalid -1 is returned.
3244 index({list}, {expr} [, {start} [, {ic}]]) *index()*
3245 Return the lowest index in |List| {list} where the item has a
3246 value equal to {expr}.
3247 If {start} is given then start looking at the item with index
3248 {start} (may be negative for an item relative to the end).
3249 When {ic} is given and it is non-zero, ignore case. Otherwise
3250 case must match.
3251 -1 is returned when {expr} is not found in {list}.
3252 Example: >
3253 :let idx = index(words, "the")
3254 :if index(numbers, 123) >= 0
3257 input({prompt} [, {text} [, {completion}]]) *input()*
3258 The result is a String, which is whatever the user typed on
3259 the command-line. The parameter is either a prompt string, or
3260 a blank string (for no prompt). A '\n' can be used in the
3261 prompt to start a new line.
3262 The highlighting set with |:echohl| is used for the prompt.
3263 The input is entered just like a command-line, with the same
3264 editing commands and mappings. There is a separate history
3265 for lines typed for input().
3266 Example: >
3267 :if input("Coffee or beer? ") == "beer"
3268 : echo "Cheers!"
3269 :endif
3270 <
3271 If the optional {text} is present and not empty, this is used
3272 for the default reply, as if the user typed this. Example: >
3273 :let color = input("Color? ", "white")
3275 < The optional {completion} argument specifies the type of
3276 completion supported for the input. Without it completion is
3277 not performed. The supported completion types are the same as
3278 that can be supplied to a user-defined command using the
3279 "-complete=" argument. Refer to |:command-completion| for
3280 more information. Example: >
3281 let fname = input("File: ", "", "file")
3282 <
3283 NOTE: This function must not be used in a startup file, for
3284 the versions that only run in GUI mode (e.g., the Win32 GUI).
3285 Note: When input() is called from within a mapping it will
3286 consume remaining characters from that mapping, because a
3287 mapping is handled like the characters were typed.
3288 Use |inputsave()| before input() and |inputrestore()|
3289 after input() to avoid that. Another solution is to avoid
3290 that further characters follow in the mapping, e.g., by using
3291 |:execute| or |:normal|.
3293 Example with a mapping: >
3294 :nmap \x :call GetFoo()<CR>:exe "/" . Foo<CR>
3295 :function GetFoo()
3296 : call inputsave()
3297 : let g:Foo = input("enter search pattern: ")
3298 : call inputrestore()
3299 :endfunction
3301 inputdialog({prompt} [, {text} [, {cancelreturn}]]) *inputdialog()*
3302 Like input(), but when the GUI is running and text dialogs are
3303 supported, a dialog window pops up to input the text.
3304 Example: >
3305 :let n = inputdialog("value for shiftwidth", &sw)
3306 :if n != ""
3307 : let &sw = n
3308 :endif
3309 < When the dialog is cancelled {cancelreturn} is returned. When
3310 omitted an empty string is returned.
3311 Hitting <Enter> works like pressing the OK button. Hitting
3312 <Esc> works like pressing the Cancel button.
3313 NOTE: Command-line completion is not supported.
3315 inputlist({textlist}) *inputlist()*
3316 {textlist} must be a |List| of strings. This |List| is
3317 displayed, one string per line. The user will be prompted to
3318 enter a number, which is returned.
3319 The user can also select an item by clicking on it with the
3320 mouse. For the first string 0 is returned. When clicking
3321 above the first item a negative number is returned. When
3322 clicking on the prompt one more than the length of {textlist}
3323 is returned.
3324 Make sure {textlist} has less then 'lines' entries, otherwise
3325 it won't work. It's a good idea to put the entry number at
3326 the start of the string. And put a prompt in the first item.
3327 Example: >
3328 let color = inputlist(['Select color:', '1. red',
3329 \ '2. green', '3. blue'])
3331 inputrestore() *inputrestore()*
3332 Restore typeahead that was saved with a previous inputsave().
3333 Should be called the same number of times inputsave() is
3334 called. Calling it more often is harmless though.
3335 Returns 1 when there is nothing to restore, 0 otherwise.
3337 inputsave() *inputsave()*
3338 Preserve typeahead (also from mappings) and clear it, so that
3339 a following prompt gets input from the user. Should be
3340 followed by a matching inputrestore() after the prompt. Can
3341 be used several times, in which case there must be just as
3342 many inputrestore() calls.
3343 Returns 1 when out of memory, 0 otherwise.
3345 inputsecret({prompt} [, {text}]) *inputsecret()*
3346 This function acts much like the |input()| function with but
3347 two exceptions:
3348 a) the user's response will be displayed as a sequence of
3349 asterisks ("*") thereby keeping the entry secret, and
3350 b) the user's response will not be recorded on the input
3351 |history| stack.
3352 The result is a String, which is whatever the user actually
3353 typed on the command-line in response to the issued prompt.
3354 NOTE: Command-line completion is not supported.
3356 insert({list}, {item} [, {idx}]) *insert()*
3357 Insert {item} at the start of |List| {list}.
3358 If {idx} is specified insert {item} before the item with index
3359 {idx}. If {idx} is zero it goes before the first item, just
3360 like omitting {idx}. A negative {idx} is also possible, see
3361 |list-index|. -1 inserts just before the last item.
3362 Returns the resulting |List|. Examples: >
3363 :let mylist = insert([2, 3, 5], 1)
3364 :call insert(mylist, 4, -1)
3365 :call insert(mylist, 6, len(mylist))
3366 < The last example can be done simpler with |add()|.
3367 Note that when {item} is a |List| it is inserted as a single
3368 item. Use |extend()| to concatenate |Lists|.
3370 isdirectory({directory}) *isdirectory()*
3371 The result is a Number, which is non-zero when a directory
3372 with the name {directory} exists. If {directory} doesn't
3373 exist, or isn't a directory, the result is FALSE. {directory}
3374 is any expression, which is used as a String.
3376 islocked({expr}) *islocked()* *E786*
3377 The result is a Number, which is non-zero when {expr} is the
3378 name of a locked variable.
3379 {expr} must be the name of a variable, |List| item or
3380 |Dictionary| entry, not the variable itself! Example: >
3381 :let alist = [0, ['a', 'b'], 2, 3]
3382 :lockvar 1 alist
3383 :echo islocked('alist') " 1
3384 :echo islocked('alist[1]') " 0
3386 < When {expr} is a variable that does not exist you get an error
3387 message. Use |exists()| to check for existence.
3389 items({dict}) *items()*
3390 Return a |List| with all the key-value pairs of {dict}. Each
3391 |List| item is a list with two items: the key of a {dict}
3392 entry and the value of this entry. The |List| is in arbitrary
3393 order.
3396 join({list} [, {sep}]) *join()*
3397 Join the items in {list} together into one String.
3398 When {sep} is specified it is put in between the items. If
3399 {sep} is omitted a single space is used.
3400 Note that {sep} is not added at the end. You might want to
3401 add it there too: >
3402 let lines = join(mylist, "\n") . "\n"
3403 < String items are used as-is. |Lists| and |Dictionaries| are
3404 converted into a string like with |string()|.
3405 The opposite function is |split()|.
3407 keys({dict}) *keys()*
3408 Return a |List| with all the keys of {dict}. The |List| is in
3409 arbitrary order.
3411 *len()* *E701*
3412 len({expr}) The result is a Number, which is the length of the argument.
3413 When {expr} is a String or a Number the length in bytes is
3414 used, as with |strlen()|.
3415 When {expr} is a |List| the number of items in the |List| is
3416 returned.
3417 When {expr} is a |Dictionary| the number of entries in the
3418 |Dictionary| is returned.
3419 Otherwise an error is given.
3421 *libcall()* *E364* *E368*
3422 libcall({libname}, {funcname}, {argument})
3423 Call function {funcname} in the run-time library {libname}
3424 with single argument {argument}.
3425 This is useful to call functions in a library that you
3426 especially made to be used with Vim. Since only one argument
3427 is possible, calling standard library functions is rather
3428 limited.
3429 The result is the String returned by the function. If the
3430 function returns NULL, this will appear as an empty string ""
3431 to Vim.
3432 If the function returns a number, use libcallnr()!
3433 If {argument} is a number, it is passed to the function as an
3434 int; if {argument} is a string, it is passed as a
3435 null-terminated string.
3436 This function will fail in |restricted-mode|.
3438 libcall() allows you to write your own 'plug-in' extensions to
3439 Vim without having to recompile the program. It is NOT a
3440 means to call system functions! If you try to do so Vim will
3441 very probably crash.
3443 For Win32, the functions you write must be placed in a DLL
3444 and use the normal C calling convention (NOT Pascal which is
3445 used in Windows System DLLs). The function must take exactly
3446 one parameter, either a character pointer or a long integer,
3447 and must return a character pointer or NULL. The character
3448 pointer returned must point to memory that will remain valid
3449 after the function has returned (e.g. in static data in the
3450 DLL). If it points to allocated memory, that memory will
3451 leak away. Using a static buffer in the function should work,
3452 it's then freed when the DLL is unloaded.
3454 WARNING: If the function returns a non-valid pointer, Vim may
3455 crash! This also happens if the function returns a number,
3456 because Vim thinks it's a pointer.
3457 For Win32 systems, {libname} should be the filename of the DLL
3458 without the ".DLL" suffix. A full path is only required if
3459 the DLL is not in the usual places.
3460 For Unix: When compiling your own plugins, remember that the
3461 object code must be compiled as position-independent ('PIC').
3462 {only in Win32 on some Unix versions, when the |+libcall|
3463 feature is present}
3464 Examples: >
3465 :echo libcall("libc.so", "getenv", "HOME")
3466 :echo libcallnr("/usr/lib/libc.so", "getpid", "")
3467 <
3468 *libcallnr()*
3469 libcallnr({libname}, {funcname}, {argument})
3470 Just like libcall(), but used for a function that returns an
3471 int instead of a string.
3472 {only in Win32 on some Unix versions, when the |+libcall|
3473 feature is present}
3474 Example (not very useful...): >
3475 :call libcallnr("libc.so", "printf", "Hello World!\n")
3476 :call libcallnr("libc.so", "sleep", 10)
3477 <
3478 *line()*
3479 line({expr}) The result is a Number, which is the line number of the file
3480 position given with {expr}. The accepted positions are:
3481 . the cursor position
3482 $ the last line in the current buffer
3483 'x position of mark x (if the mark is not set, 0 is
3484 returned)
3485 w0 first line visible in current window
3486 w$ last line visible in current window
3487 Note that a mark in another file can be used. The line number
3488 then applies to another buffer.
3489 To get the column number use |col()|. To get both use
3490 |getpos()|.
3491 Examples: >
3492 line(".") line number of the cursor
3493 line("'t") line number of mark t
3494 line("'" . marker) line number of mark marker
3495 < *last-position-jump*
3496 This autocommand jumps to the last known position in a file
3497 just after opening it, if the '" mark is set: >
3498 :au BufReadPost * if line("'\"") > 0 && line("'\"") <= line("$") | exe "normal g'\"" | endif
3500 line2byte({lnum}) *line2byte()*
3501 Return the byte count from the start of the buffer for line
3502 {lnum}. This includes the end-of-line character, depending on
3503 the 'fileformat' option for the current buffer. The first
3504 line returns 1.
3505 This can also be used to get the byte count for the line just
3506 below the last line: >
3507 line2byte(line("$") + 1)
3508 < This is the file size plus one.
3509 When {lnum} is invalid, or the |+byte_offset| feature has been
3510 disabled at compile time, -1 is returned.
3511 Also see |byte2line()|, |go| and |:goto|.
3513 lispindent({lnum}) *lispindent()*
3514 Get the amount of indent for line {lnum} according the lisp
3515 indenting rules, as with 'lisp'.
3516 The indent is counted in spaces, the value of 'tabstop' is
3517 relevant. {lnum} is used just like in |getline()|.
3518 When {lnum} is invalid or Vim was not compiled the
3519 |+lispindent| feature, -1 is returned.
3521 localtime() *localtime()*
3522 Return the current time, measured as seconds since 1st Jan
3523 1970. See also |strftime()| and |getftime()|.
3526 map({expr}, {string}) *map()*
3527 {expr} must be a |List| or a |Dictionary|.
3528 Replace each item in {expr} with the result of evaluating
3529 {string}.
3530 Inside {string} |v:val| has the value of the current item.
3531 For a |Dictionary| |v:key| has the key of the current item.
3532 Example: >
3533 :call map(mylist, '"> " . v:val . " <"')
3534 < This puts "> " before and " <" after each item in "mylist".
3536 Note that {string} is the result of an expression and is then
3537 used as an expression again. Often it is good to use a
3538 |literal-string| to avoid having to double backslashes. You
3539 still have to double ' quotes
3541 The operation is done in-place. If you want a |List| or
3542 |Dictionary| to remain unmodified make a copy first: >
3543 :let tlist = map(copy(mylist), ' & . "\t"')
3545 < Returns {expr}, the |List| or |Dictionary| that was filtered.
3546 When an error is encountered while evaluating {string} no
3547 further items in {expr} are processed.
3550 maparg({name}[, {mode} [, {abbr}]]) *maparg()*
3551 Return the rhs of mapping {name} in mode {mode}. When there
3552 is no mapping for {name}, an empty String is returned.
3553 {mode} can be one of these strings:
3554 "n" Normal
3555 "v" Visual
3556 "o" Operator-pending
3557 "i" Insert
3558 "c" Cmd-line
3559 "l" langmap |language-mapping|
3560 "" Normal, Visual and Operator-pending
3561 When {mode} is omitted, the modes for "" are used.
3562 When {abbr} is there and it is non-zero use abbreviations
3563 instead of mappings.
3564 The {name} can have special key names, like in the ":map"
3565 command. The returned String has special characters
3566 translated like in the output of the ":map" command listing.
3567 The mappings local to the current buffer are checked first,
3568 then the global mappings.
3569 This function can be used to map a key even when it's already
3570 mapped, and have it do the original mapping too. Sketch: >
3571 exe 'nnoremap <Tab> ==' . maparg('<Tab>', 'n')
3574 mapcheck({name}[, {mode} [, {abbr}]]) *mapcheck()*
3575 Check if there is a mapping that matches with {name} in mode
3576 {mode}. See |maparg()| for {mode} and special names in
3577 {name}.
3578 When {abbr} is there and it is non-zero use abbreviations
3579 instead of mappings.
3580 A match happens with a mapping that starts with {name} and
3581 with a mapping which is equal to the start of {name}.
3583 matches mapping "a" "ab" "abc" ~
3584 mapcheck("a") yes yes yes
3585 mapcheck("abc") yes yes yes
3586 mapcheck("ax") yes no no
3587 mapcheck("b") no no no
3589 The difference with maparg() is that mapcheck() finds a
3590 mapping that matches with {name}, while maparg() only finds a
3591 mapping for {name} exactly.
3592 When there is no mapping that starts with {name}, an empty
3593 String is returned. If there is one, the rhs of that mapping
3594 is returned. If there are several mappings that start with
3595 {name}, the rhs of one of them is returned.
3596 The mappings local to the current buffer are checked first,
3597 then the global mappings.
3598 This function can be used to check if a mapping can be added
3599 without being ambiguous. Example: >
3600 :if mapcheck("_vv") == ""
3601 : map _vv :set guifont=7x13<CR>
3602 :endif
3603 < This avoids adding the "_vv" mapping when there already is a
3604 mapping for "_v" or for "_vvv".
3606 match({expr}, {pat}[, {start}[, {count}]]) *match()*
3607 When {expr} is a |List| then this returns the index of the
3608 first item where {pat} matches. Each item is used as a
3609 String, |Lists| and |Dictionaries| are used as echoed.
3610 Otherwise, {expr} is used as a String. The result is a
3611 Number, which gives the index (byte offset) in {expr} where
3612 {pat} matches.
3613 A match at the first character or |List| item returns zero.
3614 If there is no match -1 is returned.
3615 Example: >
3616 :echo match("testing", "ing") " results in 4
3617 :echo match([1, 'x'], '\a') " results in 1
3618 < See |string-match| for how {pat} is used.
3619 *strpbrk()*
3620 Vim doesn't have a strpbrk() function. But you can do: >
3621 :let sepidx = match(line, '[.,;: \t]')
3622 < *strcasestr()*
3623 Vim doesn't have a strcasestr() function. But you can add
3624 "\c" to the pattern to ignore case: >
3625 :let idx = match(haystack, '\cneedle')
3626 <
3627 If {start} is given, the search starts from byte index
3628 {start} in a String or item {start} in a |List|.
3629 The result, however, is still the index counted from the
3630 first character/item. Example: >
3631 :echo match("testing", "ing", 2)
3632 < result is again "4". >
3633 :echo match("testing", "ing", 4)
3634 < result is again "4". >
3635 :echo match("testing", "t", 2)
3636 < result is "3".
3637 For a String, if {start} > 0 then it is like the string starts
3638 {start} bytes later, thus "^" will match at {start}. Except
3639 when {count} is given, then it's like matches before the
3640 {start} byte are ignored (this is a bit complicated to keep it
3641 backwards compatible).
3642 For a String, if {start} < 0, it will be set to 0. For a list
3643 the index is counted from the end.
3644 If {start} is out of range ({start} > strlen({expr}) for a
3645 String or {start} > len({expr}) for a |List|) -1 is returned.
3647 When {count} is given use the {count}'th match. When a match
3648 is found in a String the search for the next one starts one
3649 character further. Thus this example results in 1: >
3650 echo match("testing", "..", 0, 2)
3651 < In a |List| the search continues in the next item.
3652 Note that when {count} is added the way {start} works changes,
3653 see above.
3655 See |pattern| for the patterns that are accepted.
3656 The 'ignorecase' option is used to set the ignore-caseness of
3657 the pattern. 'smartcase' is NOT used. The matching is always
3658 done like 'magic' is set and 'cpoptions' is empty.
3660 *matchadd()* *E798* *E799* *E801*
3661 matchadd({group}, {pattern}[, {priority}[, {id}]])
3662 Defines a pattern to be highlighted in the current window (a
3663 "match"). It will be highlighted with {group}. Returns an
3664 identification number (ID), which can be used to delete the
3665 match using |matchdelete()|.
3667 The optional {priority} argument assigns a priority to the
3668 match. A match with a high priority will have its
3669 highlighting overrule that of a match with a lower priority.
3670 A priority is specified as an integer (negative numbers are no
3671 exception). If the {priority} argument is not specified, the
3672 default priority is 10. The priority of 'hlsearch' is zero,
3673 hence all matches with a priority greater than zero will
3674 overrule it. Syntax highlighting (see 'syntax') is a separate
3675 mechanism, and regardless of the chosen priority a match will
3676 always overrule syntax highlighting.
3678 The optional {id} argument allows the request for a specific
3679 match ID. If a specified ID is already taken, an error
3680 message will appear and the match will not be added. An ID
3681 is specified as a positive integer (zero excluded). IDs 1, 2
3682 and 3 are reserved for |:match|, |:2match| and |:3match|,
3683 respectively. If the {id} argument is not specified,
3684 |matchadd()| automatically chooses a free ID.
3686 The number of matches is not limited, as it is the case with
3687 the |:match| commands.
3689 Example: >
3690 :highlight MyGroup ctermbg=green guibg=green
3691 :let m = matchadd("MyGroup", "TODO")
3692 < Deletion of the pattern: >
3693 :call matchdelete(m)
3695 < A list of matches defined by |matchadd()| and |:match| are
3696 available from |getmatches()|. All matches can be deleted in
3697 one operation by |clearmatches()|.
3699 matcharg({nr}) *matcharg()*
3700 Selects the {nr} match item, as set with a |:match|,
3701 |:2match| or |:3match| command.
3702 Return a |List| with two elements:
3703 The name of the highlight group used
3704 The pattern used.
3705 When {nr} is not 1, 2 or 3 returns an empty |List|.
3706 When there is no match item set returns ['', ''].
3707 This is useful to save and restore a |:match|.
3708 Highlighting matches using the |:match| commands are limited
3709 to three matches. |matchadd()| does not have this limitation.
3711 matchdelete({id}) *matchdelete()* *E802* *E803*
3712 Deletes a match with ID {id} previously defined by |matchadd()|
3713 or one of the |:match| commands. Returns 0 if succesfull,
3714 otherwise -1. See example for |matchadd()|. All matches can
3715 be deleted in one operation by |clearmatches()|.
3717 matchend({expr}, {pat}[, {start}[, {count}]]) *matchend()*
3718 Same as match(), but return the index of first character after
3719 the match. Example: >
3720 :echo matchend("testing", "ing")
3721 < results in "7".
3722 *strspn()* *strcspn()*
3723 Vim doesn't have a strspn() or strcspn() function, but you can
3724 do it with matchend(): >
3725 :let span = matchend(line, '[a-zA-Z]')
3726 :let span = matchend(line, '[^a-zA-Z]')
3727 < Except that -1 is returned when there are no matches.
3729 The {start}, if given, has the same meaning as for match(). >
3730 :echo matchend("testing", "ing", 2)
3731 < results in "7". >
3732 :echo matchend("testing", "ing", 5)
3733 < result is "-1".
3734 When {expr} is a |List| the result is equal to match().
3736 matchlist({expr}, {pat}[, {start}[, {count}]]) *matchlist()*
3737 Same as match(), but return a |List|. The first item in the
3738 list is the matched string, same as what matchstr() would
3739 return. Following items are submatches, like "\1", "\2", etc.
3740 in |:substitute|. When an optional submatch didn't match an
3741 empty string is used. Example: >
3742 echo matchlist('acd', '\(a\)\?\(b\)\?\(c\)\?\(.*\)')
3743 < Results in: ['acd', 'a', '', 'c', 'd', '', '', '', '', '']
3744 When there is no match an empty list is returned.
3746 matchstr({expr}, {pat}[, {start}[, {count}]]) *matchstr()*
3747 Same as match(), but return the matched string. Example: >
3748 :echo matchstr("testing", "ing")
3749 < results in "ing".
3750 When there is no match "" is returned.
3751 The {start}, if given, has the same meaning as for match(). >
3752 :echo matchstr("testing", "ing", 2)
3753 < results in "ing". >
3754 :echo matchstr("testing", "ing", 5)
3755 < result is "".
3756 When {expr} is a |List| then the matching item is returned.
3757 The type isn't changed, it's not necessarily a String.
3759 *max()*
3760 max({list}) Return the maximum value of all items in {list}.
3761 If {list} is not a list or one of the items in {list} cannot
3762 be used as a Number this results in an error.
3763 An empty |List| results in zero.
3765 *min()*
3766 min({list}) Return the minimum value of all items in {list}.
3767 If {list} is not a list or one of the items in {list} cannot
3768 be used as a Number this results in an error.
3769 An empty |List| results in zero.
3771 *mkdir()* *E739*
3772 mkdir({name} [, {path} [, {prot}]])
3773 Create directory {name}.
3774 If {path} is "p" then intermediate directories are created as
3775 necessary. Otherwise it must be "".
3776 If {prot} is given it is used to set the protection bits of
3777 the new directory. The default is 0755 (rwxr-xr-x: r/w for
3778 the user readable for others). Use 0700 to make it unreadable
3779 for others.
3780 This function is not available in the |sandbox|.
3781 Not available on all systems. To check use: >
3782 :if exists("*mkdir")
3783 <
3784 *mode()*
3785 mode() Return a string that indicates the current mode:
3786 n Normal
3787 v Visual by character
3788 V Visual by line
3789 CTRL-V Visual blockwise
3790 s Select by character
3791 S Select by line
3792 CTRL-S Select blockwise
3793 i Insert
3794 R Replace
3795 c Command-line
3796 r Hit-enter prompt
3797 This is useful in the 'statusline' option. In most other
3798 places it always returns "c" or "n".
3800 nextnonblank({lnum}) *nextnonblank()*
3801 Return the line number of the first line at or below {lnum}
3802 that is not blank. Example: >
3803 if getline(nextnonblank(1)) =~ "Java"
3804 < When {lnum} is invalid or there is no non-blank line at or
3805 below it, zero is returned.
3806 See also |prevnonblank()|.
3808 nr2char({expr}) *nr2char()*
3809 Return a string with a single character, which has the number
3810 value {expr}. Examples: >
3811 nr2char(64) returns "@"
3812 nr2char(32) returns " "
3813 < The current 'encoding' is used. Example for "utf-8": >
3814 nr2char(300) returns I with bow character
3815 < Note that a NUL character in the file is specified with
3816 nr2char(10), because NULs are represented with newline
3817 characters. nr2char(0) is a real NUL and terminates the
3818 string, thus results in an empty string.
3820 *getpos()*
3821 getpos({expr}) Get the position for {expr}. For possible values of {expr}
3822 see |line()|.
3823 The result is a |List| with four numbers:
3824 [bufnum, lnum, col, off]
3825 "bufnum" is zero, unless a mark like '0 or 'A is used, then it
3826 is the buffer number of the mark.
3827 "lnum" and "col" are the position in the buffer. The first
3828 column is 1.
3829 The "off" number is zero, unless 'virtualedit' is used. Then
3830 it is the offset in screen columns from the start of the
3831 character. E.g., a position within a <Tab> or after the last
3832 character.
3833 This can be used to save and restore the cursor position: >
3834 let save_cursor = getpos(".")
3835 MoveTheCursorAround
3836 call setpos('.', save_cursor)
3837 < Also see |setpos()|.
3839 pathshorten({expr}) *pathshorten()*
3840 Shorten directory names in the path {expr} and return the
3841 result. The tail, the file name, is kept as-is. The other
3842 components in the path are reduced to single letters. Leading
3843 '~' and '.' characters are kept. Example: >
3844 :echo pathshorten('~/.vim/autoload/myfile.vim')
3845 < ~/.v/a/myfile.vim ~
3846 It doesn't matter if the path exists or not.
3848 prevnonblank({lnum}) *prevnonblank()*
3849 Return the line number of the first line at or above {lnum}
3850 that is not blank. Example: >
3851 let ind = indent(prevnonblank(v:lnum - 1))
3852 < When {lnum} is invalid or there is no non-blank line at or
3853 above it, zero is returned.
3854 Also see |nextnonblank()|.
3857 printf({fmt}, {expr1} ...) *printf()*
3858 Return a String with {fmt}, where "%" items are replaced by
3859 the formatted form of their respective arguments. Example: >
3860 printf("%4d: E%d %.30s", lnum, errno, msg)
3861 < May result in:
3862 " 99: E42 asdfasdfasdfasdfasdfasdfasdfas" ~
3864 Often used items are:
3865 %s string
3866 %6s string right-aligned in 6 bytes
3867 %.9s string truncated to 9 bytes
3868 %c single byte
3869 %d decimal number
3870 %5d decimal number padded with spaces to 5 characters
3871 %x hex number
3872 %04x hex number padded with zeros to at least 4 characters
3873 %X hex number using upper case letters
3874 %o octal number
3875 %% the % character itself
3877 Conversion specifications start with '%' and end with the
3878 conversion type. All other characters are copied unchanged to
3879 the result.
3881 The "%" starts a conversion specification. The following
3882 arguments appear in sequence:
3884 % [flags] [field-width] [.precision] type
3886 flags
3887 Zero or more of the following flags:
3889 # The value should be converted to an "alternate
3890 form". For c, d, and s conversions, this option
3891 has no effect. For o conversions, the precision
3892 of the number is increased to force the first
3893 character of the output string to a zero (except
3894 if a zero value is printed with an explicit
3895 precision of zero).
3896 For x and X conversions, a non-zero result has
3897 the string "0x" (or "0X" for X conversions)
3898 prepended to it.
3900 0 (zero) Zero padding. For all conversions the converted
3901 value is padded on the left with zeros rather
3902 than blanks. If a precision is given with a
3903 numeric conversion (d, o, x, and X), the 0 flag
3904 is ignored.
3906 - A negative field width flag; the converted value
3907 is to be left adjusted on the field boundary.
3908 The converted value is padded on the right with
3909 blanks, rather than on the left with blanks or
3910 zeros. A - overrides a 0 if both are given.
3912 ' ' (space) A blank should be left before a positive
3913 number produced by a signed conversion (d).
3915 + A sign must always be placed before a number
3916 produced by a signed conversion. A + overrides
3917 a space if both are used.
3919 field-width
3920 An optional decimal digit string specifying a minimum
3921 field width. If the converted value has fewer bytes
3922 than the field width, it will be padded with spaces on
3923 the left (or right, if the left-adjustment flag has
3924 been given) to fill out the field width.
3926 .precision
3927 An optional precision, in the form of a period '.'
3928 followed by an optional digit string. If the digit
3929 string is omitted, the precision is taken as zero.
3930 This gives the minimum number of digits to appear for
3931 d, o, x, and X conversions, or the maximum number of
3932 bytes to be printed from a string for s conversions.
3934 type
3935 A character that specifies the type of conversion to
3936 be applied, see below.
3938 A field width or precision, or both, may be indicated by an
3939 asterisk '*' instead of a digit string. In this case, a
3940 Number argument supplies the field width or precision. A
3941 negative field width is treated as a left adjustment flag
3942 followed by a positive field width; a negative precision is
3943 treated as though it were missing. Example: >
3944 :echo printf("%d: %.*s", nr, width, line)
3945 < This limits the length of the text used from "line" to
3946 "width" bytes.
3948 The conversion specifiers and their meanings are:
3950 doxX The Number argument is converted to signed decimal
3951 (d), unsigned octal (o), or unsigned hexadecimal (x
3952 and X) notation. The letters "abcdef" are used for
3953 x conversions; the letters "ABCDEF" are used for X
3954 conversions.
3955 The precision, if any, gives the minimum number of
3956 digits that must appear; if the converted value
3957 requires fewer digits, it is padded on the left with
3958 zeros.
3959 In no case does a non-existent or small field width
3960 cause truncation of a numeric field; if the result of
3961 a conversion is wider than the field width, the field
3962 is expanded to contain the conversion result.
3964 c The Number argument is converted to a byte, and the
3965 resulting character is written.
3967 s The text of the String argument is used. If a
3968 precision is specified, no more bytes than the number
3969 specified are used.
3971 % A '%' is written. No argument is converted. The
3972 complete conversion specification is "%%".
3974 Each argument can be Number or String and is converted
3975 automatically to fit the conversion specifier. Any other
3976 argument type results in an error message.
3978 *E766* *E767*
3979 The number of {exprN} arguments must exactly match the number
3980 of "%" items. If there are not sufficient or too many
3981 arguments an error is given. Up to 18 arguments can be used.
3984 pumvisible() *pumvisible()*
3985 Returns non-zero when the popup menu is visible, zero
3986 otherwise. See |ins-completion-menu|.
3987 This can be used to avoid some things that would remove the
3988 popup menu.
3990 *E726* *E727*
3991 range({expr} [, {max} [, {stride}]]) *range()*
3992 Returns a |List| with Numbers:
3993 - If only {expr} is specified: [0, 1, ..., {expr} - 1]
3994 - If {max} is specified: [{expr}, {expr} + 1, ..., {max}]
3995 - If {stride} is specified: [{expr}, {expr} + {stride}, ...,
3996 {max}] (increasing {expr} with {stride} each time, not
3997 producing a value past {max}).
3998 When the maximum is one before the start the result is an
3999 empty list. When the maximum is more than one before the
4000 start this is an error.
4001 Examples: >
4002 range(4) " [0, 1, 2, 3]
4003 range(2, 4) " [2, 3, 4]
4004 range(2, 9, 3) " [2, 5, 8]
4005 range(2, -2, -1) " [2, 1, 0, -1, -2]
4006 range(0) " []
4007 range(2, 0) " error!
4008 <
4009 *readfile()*
4010 readfile({fname} [, {binary} [, {max}]])
4011 Read file {fname} and return a |List|, each line of the file
4012 as an item. Lines broken at NL characters. Macintosh files
4013 separated with CR will result in a single long line (unless a
4014 NL appears somewhere).
4015 When {binary} is equal to "b" binary mode is used:
4016 - When the last line ends in a NL an extra empty list item is
4017 added.
4018 - No CR characters are removed.
4019 Otherwise:
4020 - CR characters that appear before a NL are removed.
4021 - Whether the last line ends in a NL or not does not matter.
4022 All NUL characters are replaced with a NL character.
4023 When {max} is given this specifies the maximum number of lines
4024 to be read. Useful if you only want to check the first ten
4025 lines of a file: >
4026 :for line in readfile(fname, '', 10)
4027 : if line =~ 'Date' | echo line | endif
4028 :endfor
4029 < When {max} is negative -{max} lines from the end of the file
4030 are returned, or as many as there are.
4031 When {max} is zero the result is an empty list.
4032 Note that without {max} the whole file is read into memory.
4033 Also note that there is no recognition of encoding. Read a
4034 file into a buffer if you need to.
4035 When the file can't be opened an error message is given and
4036 the result is an empty list.
4037 Also see |writefile()|.
4039 reltime([{start} [, {end}]]) *reltime()*
4040 Return an item that represents a time value. The format of
4041 the item depends on the system. It can be passed to
4042 |reltimestr()| to convert it to a string.
4043 Without an argument it returns the current time.
4044 With one argument is returns the time passed since the time
4045 specified in the argument.
4046 With two arguments it returns the time passed between {start}
4047 and {end}.
4048 The {start} and {end} arguments must be values returned by
4049 reltime().
4050 {only available when compiled with the +reltime feature}
4052 reltimestr({time}) *reltimestr()*
4053 Return a String that represents the time value of {time}.
4054 This is the number of seconds, a dot and the number of
4055 microseconds. Example: >
4056 let start = reltime()
4057 call MyFunction()
4058 echo reltimestr(reltime(start))
4059 < Note that overhead for the commands will be added to the time.
4060 The accuracy depends on the system.
4061 Leading spaces are used to make the string align nicely. You
4062 can use split() to remove it. >
4063 echo split(reltimestr(reltime(start)))[0]
4064 < Also see |profiling|.
4065 {only available when compiled with the +reltime feature}
4067 *remote_expr()* *E449*
4068 remote_expr({server}, {string} [, {idvar}])
4069 Send the {string} to {server}. The string is sent as an
4070 expression and the result is returned after evaluation.
4071 The result must be a String or a |List|. A |List| is turned
4072 into a String by joining the items with a line break in
4073 between (not at the end), like with join(expr, "\n").
4074 If {idvar} is present, it is taken as the name of a
4075 variable and a {serverid} for later use with
4076 remote_read() is stored there.
4077 See also |clientserver| |RemoteReply|.
4078 This function is not available in the |sandbox|.
4079 {only available when compiled with the |+clientserver| feature}
4080 Note: Any errors will cause a local error message to be issued
4081 and the result will be the empty string.
4082 Examples: >
4083 :echo remote_expr("gvim", "2+2")
4084 :echo remote_expr("gvim1", "b:current_syntax")
4085 <
4087 remote_foreground({server}) *remote_foreground()*
4088 Move the Vim server with the name {server} to the foreground.
4089 This works like: >
4090 remote_expr({server}, "foreground()")
4091 < Except that on Win32 systems the client does the work, to work
4092 around the problem that the OS doesn't always allow the server
4093 to bring itself to the foreground.
4094 Note: This does not restore the window if it was minimized,
4095 like foreground() does.
4096 This function is not available in the |sandbox|.
4097 {only in the Win32, Athena, Motif and GTK GUI versions and the
4098 Win32 console version}
4101 remote_peek({serverid} [, {retvar}]) *remote_peek()*
4102 Returns a positive number if there are available strings
4103 from {serverid}. Copies any reply string into the variable
4104 {retvar} if specified. {retvar} must be a string with the
4105 name of a variable.
4106 Returns zero if none are available.
4107 Returns -1 if something is wrong.
4108 See also |clientserver|.
4109 This function is not available in the |sandbox|.
4110 {only available when compiled with the |+clientserver| feature}
4111 Examples: >
4112 :let repl = ""
4113 :echo "PEEK: ".remote_peek(id, "repl").": ".repl
4115 remote_read({serverid}) *remote_read()*
4116 Return the oldest available reply from {serverid} and consume
4117 it. It blocks until a reply is available.
4118 See also |clientserver|.
4119 This function is not available in the |sandbox|.
4120 {only available when compiled with the |+clientserver| feature}
4121 Example: >
4122 :echo remote_read(id)
4123 <
4124 *remote_send()* *E241*
4125 remote_send({server}, {string} [, {idvar}])
4126 Send the {string} to {server}. The string is sent as input
4127 keys and the function returns immediately. At the Vim server
4128 the keys are not mapped |:map|.
4129 If {idvar} is present, it is taken as the name of a variable
4130 and a {serverid} for later use with remote_read() is stored
4131 there.
4132 See also |clientserver| |RemoteReply|.
4133 This function is not available in the |sandbox|.
4134 {only available when compiled with the |+clientserver| feature}
4135 Note: Any errors will be reported in the server and may mess
4136 up the display.
4137 Examples: >
4138 :echo remote_send("gvim", ":DropAndReply ".file, "serverid").
4139 \ remote_read(serverid)
4141 :autocmd NONE RemoteReply *
4142 \ echo remote_read(expand("<amatch>"))
4143 :echo remote_send("gvim", ":sleep 10 | echo ".
4144 \ 'server2client(expand("<client>"), "HELLO")<CR>')
4145 <
4146 remove({list}, {idx} [, {end}]) *remove()*
4147 Without {end}: Remove the item at {idx} from |List| {list} and
4148 return it.
4149 With {end}: Remove items from {idx} to {end} (inclusive) and
4150 return a list with these items. When {idx} points to the same
4151 item as {end} a list with one item is returned. When {end}
4152 points to an item before {idx} this is an error.
4153 See |list-index| for possible values of {idx} and {end}.
4154 Example: >
4155 :echo "last item: " . remove(mylist, -1)
4156 :call remove(mylist, 0, 9)
4157 remove({dict}, {key})
4158 Remove the entry from {dict} with key {key}. Example: >
4159 :echo "removed " . remove(dict, "one")
4160 < If there is no {key} in {dict} this is an error.
4162 Use |delete()| to remove a file.
4164 rename({from}, {to}) *rename()*
4165 Rename the file by the name {from} to the name {to}. This
4166 should also work to move files across file systems. The
4167 result is a Number, which is 0 if the file was renamed
4168 successfully, and non-zero when the renaming failed.
4169 This function is not available in the |sandbox|.
4171 repeat({expr}, {count}) *repeat()*
4172 Repeat {expr} {count} times and return the concatenated
4173 result. Example: >
4174 :let separator = repeat('-', 80)
4175 < When {count} is zero or negative the result is empty.
4176 When {expr} is a |List| the result is {expr} concatenated
4177 {count} times. Example: >
4178 :let longlist = repeat(['a', 'b'], 3)
4179 < Results in ['a', 'b', 'a', 'b', 'a', 'b'].
4182 resolve({filename}) *resolve()* *E655*
4183 On MS-Windows, when {filename} is a shortcut (a .lnk file),
4184 returns the path the shortcut points to in a simplified form.
4185 On Unix, repeat resolving symbolic links in all path
4186 components of {filename} and return the simplified result.
4187 To cope with link cycles, resolving of symbolic links is
4188 stopped after 100 iterations.
4189 On other systems, return the simplified {filename}.
4190 The simplification step is done as by |simplify()|.
4191 resolve() keeps a leading path component specifying the
4192 current directory (provided the result is still a relative
4193 path name) and also keeps a trailing path separator.
4195 *reverse()*
4196 reverse({list}) Reverse the order of items in {list} in-place. Returns
4197 {list}.
4198 If you want a list to remain unmodified make a copy first: >
4199 :let revlist = reverse(copy(mylist))
4201 search({pattern} [, {flags} [, {stopline}]]) *search()*
4202 Search for regexp pattern {pattern}. The search starts at the
4203 cursor position (you can use |cursor()| to set it).
4205 {flags} is a String, which can contain these character flags:
4206 'b' search backward instead of forward
4207 'c' accept a match at the cursor position
4208 'e' move to the End of the match
4209 'n' do Not move the cursor
4210 'p' return number of matching sub-pattern (see below)
4211 's' set the ' mark at the previous location of the cursor
4212 'w' wrap around the end of the file
4213 'W' don't wrap around the end of the file
4214 If neither 'w' or 'W' is given, the 'wrapscan' option applies.
4216 If the 's' flag is supplied, the ' mark is set, only if the
4217 cursor is moved. The 's' flag cannot be combined with the 'n'
4218 flag.
4220 'ignorecase', 'smartcase' and 'magic' are used.
4222 When the {stopline} argument is given then the search stops
4223 after searching this line. This is useful to restrict the
4224 search to a range of lines. Examples: >
4225 let match = search('(', 'b', line("w0"))
4226 let end = search('END', '', line("w$"))
4227 < When {stopline} is used and it is not zero this also implies
4228 that the search does not wrap around the end of the file.
4230 If there is no match a 0 is returned and the cursor doesn't
4231 move. No error message is given.
4232 When a match has been found its line number is returned.
4233 *search()-sub-match*
4234 With the 'p' flag the returned value is one more than the
4235 first sub-match in \(\). One if none of them matched but the
4236 whole pattern did match.
4237 To get the column number too use |searchpos()|.
4239 The cursor will be positioned at the match, unless the 'n'
4240 flag is used.
4242 Example (goes over all files in the argument list): >
4243 :let n = 1
4244 :while n <= argc() " loop over all files in arglist
4245 : exe "argument " . n
4246 : " start at the last char in the file and wrap for the
4247 : " first search to find match at start of file
4248 : normal G$
4249 : let flags = "w"
4250 : while search("foo", flags) > 0
4251 : s/foo/bar/g
4252 : let flags = "W"
4253 : endwhile
4254 : update " write the file if modified
4255 : let n = n + 1
4256 :endwhile
4257 <
4258 Example for using some flags: >
4259 :echo search('\<if\|\(else\)\|\(endif\)', 'ncpe')
4260 < This will search for the keywords "if", "else", and "endif"
4261 under or after the cursor. Because of the 'p' flag, it
4262 returns 1, 2, or 3 depending on which keyword is found, or 0
4263 if the search fails. With the cursor on the first word of the
4264 line:
4265 if (foo == 0) | let foo = foo + 1 | endif ~
4266 the function returns 1. Without the 'c' flag, the function
4267 finds the "endif" and returns 3. The same thing happens
4268 without the 'e' flag if the cursor is on the "f" of "if".
4269 The 'n' flag tells the function not to move the cursor.
4272 searchdecl({name} [, {global} [, {thisblock}]]) *searchdecl()*
4273 Search for the declaration of {name}.
4275 With a non-zero {global} argument it works like |gD|, find
4276 first match in the file. Otherwise it works like |gd|, find
4277 first match in the function.
4279 With a non-zero {thisblock} argument matches in a {} block
4280 that ends before the cursor position are ignored. Avoids
4281 finding variable declarations only valid in another scope.
4283 Moves the cursor to the found match.
4284 Returns zero for success, non-zero for failure.
4285 Example: >
4286 if searchdecl('myvar') == 0
4287 echo getline('.')
4288 endif
4289 <
4290 *searchpair()*
4291 searchpair({start}, {middle}, {end} [, {flags} [, {skip} [, {stopline}]]])
4292 Search for the match of a nested start-end pair. This can be
4293 used to find the "endif" that matches an "if", while other
4294 if/endif pairs in between are ignored.
4295 The search starts at the cursor. The default is to search
4296 forward, include 'b' in {flags} to search backward.
4297 If a match is found, the cursor is positioned at it and the
4298 line number is returned. If no match is found 0 or -1 is
4299 returned and the cursor doesn't move. No error message is
4300 given.
4302 {start}, {middle} and {end} are patterns, see |pattern|. They
4303 must not contain \( \) pairs. Use of \%( \) is allowed. When
4304 {middle} is not empty, it is found when searching from either
4305 direction, but only when not in a nested start-end pair. A
4306 typical use is: >
4307 searchpair('\<if\>', '\<else\>', '\<endif\>')
4308 < By leaving {middle} empty the "else" is skipped.
4310 {flags} 'b', 'c', 'n', 's', 'w' and 'W' are used like with
4311 |search()|. Additionally:
4312 'r' Repeat until no more matches found; will find the
4313 outer pair
4314 'm' return number of Matches instead of line number with
4315 the match; will be > 1 when 'r' is used.
4317 When a match for {start}, {middle} or {end} is found, the
4318 {skip} expression is evaluated with the cursor positioned on
4319 the start of the match. It should return non-zero if this
4320 match is to be skipped. E.g., because it is inside a comment
4321 or a string.
4322 When {skip} is omitted or empty, every match is accepted.
4323 When evaluating {skip} causes an error the search is aborted
4324 and -1 returned.
4326 For {stopline} see |search()|.
4328 The value of 'ignorecase' is used. 'magic' is ignored, the
4329 patterns are used like it's on.
4331 The search starts exactly at the cursor. A match with
4332 {start}, {middle} or {end} at the next character, in the
4333 direction of searching, is the first one found. Example: >
4334 if 1
4335 if 2
4336 endif 2
4337 endif 1
4338 < When starting at the "if 2", with the cursor on the "i", and
4339 searching forwards, the "endif 2" is found. When starting on
4340 the character just before the "if 2", the "endif 1" will be
4341 found. That's because the "if 2" will be found first, and
4342 then this is considered to be a nested if/endif from "if 2" to
4343 "endif 2".
4344 When searching backwards and {end} is more than one character,
4345 it may be useful to put "\zs" at the end of the pattern, so
4346 that when the cursor is inside a match with the end it finds
4347 the matching start.
4349 Example, to find the "endif" command in a Vim script: >
4351 :echo searchpair('\<if\>', '\<el\%[seif]\>', '\<en\%[dif]\>', 'W',
4352 \ 'getline(".") =~ "^\\s*\""')
4354 < The cursor must be at or after the "if" for which a match is
4355 to be found. Note that single-quote strings are used to avoid
4356 having to double the backslashes. The skip expression only
4357 catches comments at the start of a line, not after a command.
4358 Also, a word "en" or "if" halfway a line is considered a
4359 match.
4360 Another example, to search for the matching "{" of a "}": >
4362 :echo searchpair('{', '', '}', 'bW')
4364 < This works when the cursor is at or before the "}" for which a
4365 match is to be found. To reject matches that syntax
4366 highlighting recognized as strings: >
4368 :echo searchpair('{', '', '}', 'bW',
4369 \ 'synIDattr(synID(line("."), col("."), 0), "name") =~? "string"')
4370 <
4371 *searchpairpos()*
4372 searchpairpos({start}, {middle}, {end} [, {flags} [, {skip} [, {stopline}]]])
4373 Same as searchpair(), but returns a |List| with the line and
4374 column position of the match. The first element of the |List|
4375 is the line number and the second element is the byte index of
4376 the column position of the match. If no match is found,
4377 returns [0, 0].
4378 >
4379 :let [lnum,col] = searchpairpos('{', '', '}', 'n')
4380 <
4381 See |match-parens| for a bigger and more useful example.
4383 searchpos({pattern} [, {flags} [, {stopline}]]) *searchpos()*
4384 Same as |search()|, but returns a |List| with the line and
4385 column position of the match. The first element of the |List|
4386 is the line number and the second element is the byte index of
4387 the column position of the match. If no match is found,
4388 returns [0, 0].
4389 Example: >
4390 :let [lnum, col] = searchpos('mypattern', 'n')
4392 < When the 'p' flag is given then there is an extra item with
4393 the sub-pattern match number |search()-sub-match|. Example: >
4394 :let [lnum, col, submatch] = searchpos('\(\l\)\|\(\u\)', 'np')
4395 < In this example "submatch" is 2 when a lowercase letter is
4396 found |/\l|, 3 when an uppercase letter is found |/\u|.
4398 server2client( {clientid}, {string}) *server2client()*
4399 Send a reply string to {clientid}. The most recent {clientid}
4400 that sent a string can be retrieved with expand("<client>").
4401 {only available when compiled with the |+clientserver| feature}
4402 Note:
4403 This id has to be stored before the next command can be
4404 received. I.e. before returning from the received command and
4405 before calling any commands that waits for input.
4406 See also |clientserver|.
4407 Example: >
4408 :echo server2client(expand("<client>"), "HELLO")
4409 <
4410 serverlist() *serverlist()*
4411 Return a list of available server names, one per line.
4412 When there are no servers or the information is not available
4413 an empty string is returned. See also |clientserver|.
4414 {only available when compiled with the |+clientserver| feature}
4415 Example: >
4416 :echo serverlist()
4417 <
4418 setbufvar({expr}, {varname}, {val}) *setbufvar()*
4419 Set option or local variable {varname} in buffer {expr} to
4420 {val}.
4421 This also works for a global or local window option, but it
4422 doesn't work for a global or local window variable.
4423 For a local window option the global value is unchanged.
4424 For the use of {expr}, see |bufname()| above.
4425 Note that the variable name without "b:" must be used.
4426 Examples: >
4427 :call setbufvar(1, "&mod", 1)
4428 :call setbufvar("todo", "myvar", "foobar")
4429 < This function is not available in the |sandbox|.
4431 setcmdpos({pos}) *setcmdpos()*
4432 Set the cursor position in the command line to byte position
4433 {pos}. The first position is 1.
4434 Use |getcmdpos()| to obtain the current position.
4435 Only works while editing the command line, thus you must use
4436 |c_CTRL-\_e|, |c_CTRL-R_=| or |c_CTRL-R_CTRL-R| with '='. For
4437 |c_CTRL-\_e| and |c_CTRL-R_CTRL-R| with '=' the position is
4438 set after the command line is set to the expression. For
4439 |c_CTRL-R_=| it is set after evaluating the expression but
4440 before inserting the resulting text.
4441 When the number is too big the cursor is put at the end of the
4442 line. A number smaller than one has undefined results.
4443 Returns 0 when successful, 1 when not editing the command
4444 line.
4446 setline({lnum}, {line}) *setline()*
4447 Set line {lnum} of the current buffer to {line}.
4448 {lnum} is used like with |getline()|.
4449 When {lnum} is just below the last line the {line} will be
4450 added as a new line.
4451 If this succeeds, 0 is returned. If this fails (most likely
4452 because {lnum} is invalid) 1 is returned. Example: >
4453 :call setline(5, strftime("%c"))
4454 < When {line} is a |List| then line {lnum} and following lines
4455 will be set to the items in the list. Example: >
4456 :call setline(5, ['aaa', 'bbb', 'ccc'])
4457 < This is equivalent to: >
4458 :for [n, l] in [[5, 6, 7], ['aaa', 'bbb', 'ccc']]
4459 : call setline(n, l)
4460 :endfor
4461 < Note: The '[ and '] marks are not set.
4463 setloclist({nr}, {list} [, {action}]) *setloclist()*
4464 Create or replace or add to the location list for window {nr}.
4465 When {nr} is zero the current window is used. For a location
4466 list window, the displayed location list is modified. For an
4467 invalid window number {nr}, -1 is returned.
4468 Otherwise, same as |setqflist()|.
4469 Also see |location-list|.
4471 setmatches({list}) *setmatches()*
4472 Restores a list of matches saved by |getmatches()|. Returns 0
4473 if succesfull, otherwise -1. All current matches are cleared
4474 before the list is restored. See example for |getmatches()|.
4476 *setpos()*
4477 setpos({expr}, {list})
4478 Set the position for {expr}. Possible values:
4479 . the cursor
4480 'x mark x
4482 {list} must be a |List| with four numbers:
4483 [bufnum, lnum, col, off]
4485 "bufnum" is the buffer number. Zero can be used for the
4486 current buffer. Setting the cursor is only possible for
4487 the current buffer. To set a mark in another buffer you can
4488 use the |bufnr()| function to turn a file name into a buffer
4489 number.
4490 Does not change the jumplist.
4492 "lnum" and "col" are the position in the buffer. The first
4493 column is 1. Use a zero "lnum" to delete a mark.
4495 The "off" number is only used when 'virtualedit' is set. Then
4496 it is the offset in screen columns from the start of the
4497 character. E.g., a position within a <Tab> or after the last
4498 character.
4500 Also see |getpos()|
4502 This does not restore the preferred column for moving
4503 vertically. See |winrestview()| for that.
4506 setqflist({list} [, {action}]) *setqflist()*
4507 Create or replace or add to the quickfix list using the items
4508 in {list}. Each item in {list} is a dictionary.
4509 Non-dictionary items in {list} are ignored. Each dictionary
4510 item can contain the following entries:
4512 bufnr buffer number; must be the number of a valid
4513 buffer
4514 filename name of a file; only used when "bufnr" is not
4515 present or it is invalid.
4516 lnum line number in the file
4517 pattern search pattern used to locate the error
4518 col column number
4519 vcol when non-zero: "col" is visual column
4520 when zero: "col" is byte index
4521 nr error number
4522 text description of the error
4523 type single-character error type, 'E', 'W', etc.
4525 The "col", "vcol", "nr", "type" and "text" entries are
4526 optional. Either "lnum" or "pattern" entry can be used to
4527 locate a matching error line.
4528 If the "filename" and "bufnr" entries are not present or
4529 neither the "lnum" or "pattern" entries are present, then the
4530 item will not be handled as an error line.
4531 If both "pattern" and "lnum" are present then "pattern" will
4532 be used.
4533 Note that the list is not exactly the same as what
4534 |getqflist()| returns.
4536 If {action} is set to 'a', then the items from {list} are
4537 added to the existing quickfix list. If there is no existing
4538 list, then a new list is created. If {action} is set to 'r',
4539 then the items from the current quickfix list are replaced
4540 with the items from {list}. If {action} is not present or is
4541 set to ' ', then a new list is created.
4543 Returns zero for success, -1 for failure.
4545 This function can be used to create a quickfix list
4546 independent of the 'errorformat' setting. Use a command like
4547 ":cc 1" to jump to the first position.
4550 *setreg()*
4551 setreg({regname}, {value} [,{options}])
4552 Set the register {regname} to {value}.
4553 If {options} contains "a" or {regname} is upper case,
4554 then the value is appended.
4555 {options} can also contains a register type specification:
4556 "c" or "v" |characterwise| mode
4557 "l" or "V" |linewise| mode
4558 "b" or "<CTRL-V>" |blockwise-visual| mode
4559 If a number immediately follows "b" or "<CTRL-V>" then this is
4560 used as the width of the selection - if it is not specified
4561 then the width of the block is set to the number of characters
4562 in the longest line (counting a <Tab> as 1 character).
4564 If {options} contains no register settings, then the default
4565 is to use character mode unless {value} ends in a <NL>.
4566 Setting the '=' register is not possible.
4567 Returns zero for success, non-zero for failure.
4569 Examples: >
4570 :call setreg(v:register, @*)
4571 :call setreg('*', @%, 'ac')
4572 :call setreg('a', "1\n2\n3", 'b5')
4574 < This example shows using the functions to save and restore a
4575 register. >
4576 :let var_a = getreg('a', 1)
4577 :let var_amode = getregtype('a')
4578 ....
4579 :call setreg('a', var_a, var_amode)
4581 < You can also change the type of a register by appending
4582 nothing: >
4583 :call setreg('a', '', 'al')
4585 settabwinvar({tabnr}, {winnr}, {varname}, {val}) *settabwinvar()*
4586 Set option or local variable {varname} in window {winnr} to
4587 {val}.
4588 Tabs are numbered starting with one. For the current tabpage
4589 use |setwinvar()|.
4590 When {winnr} is zero the current window is used.
4591 This also works for a global or local buffer option, but it
4592 doesn't work for a global or local buffer variable.
4593 For a local buffer option the global value is unchanged.
4594 Note that the variable name without "w:" must be used.
4595 Vim briefly goes to the tab page {tabnr}, this may trigger
4596 TabLeave and TabEnter autocommands.
4597 Examples: >
4598 :call settabwinvar(1, 1, "&list", 0)
4599 :call settabwinvar(3, 2, "myvar", "foobar")
4600 < This function is not available in the |sandbox|.
4602 setwinvar({nr}, {varname}, {val}) *setwinvar()*
4603 Like |settabwinvar()| for the current tab page.
4604 Examples: >
4605 :call setwinvar(1, "&list", 0)
4606 :call setwinvar(2, "myvar", "foobar")
4608 shellescape({string}) *shellescape()*
4609 Escape {string} for use as shell command argument.
4610 On MS-Windows and MS-DOS, when 'shellslash' is not set, it
4611 will enclose {string} double quotes and double all double
4612 quotes within {string}.
4613 For other systems, it will enclose {string} in single quotes
4614 and replace all "'" with "'\''".
4615 Example: >
4616 :echo shellescape('c:\program files\vim')
4617 < results in:
4618 "c:\program files\vim" ~
4619 Example usage: >
4620 :call system("chmod +x -- " . shellescape(expand("%")))
4623 simplify({filename}) *simplify()*
4624 Simplify the file name as much as possible without changing
4625 the meaning. Shortcuts (on MS-Windows) or symbolic links (on
4626 Unix) are not resolved. If the first path component in
4627 {filename} designates the current directory, this will be
4628 valid for the result as well. A trailing path separator is
4629 not removed either.
4630 Example: >
4631 simplify("./dir/.././/file/") == "./file/"
4632 < Note: The combination "dir/.." is only removed if "dir" is
4633 a searchable directory or does not exist. On Unix, it is also
4634 removed when "dir" is a symbolic link within the same
4635 directory. In order to resolve all the involved symbolic
4636 links before simplifying the path name, use |resolve()|.
4639 sort({list} [, {func}]) *sort()* *E702*
4640 Sort the items in {list} in-place. Returns {list}. If you
4641 want a list to remain unmodified make a copy first: >
4642 :let sortedlist = sort(copy(mylist))
4643 < Uses the string representation of each item to sort on.
4644 Numbers sort after Strings, |Lists| after Numbers.
4645 For sorting text in the current buffer use |:sort|.
4646 When {func} is given and it is one then case is ignored.
4647 When {func} is a |Funcref| or a function name, this function
4648 is called to compare items. The function is invoked with two
4649 items as argument and must return zero if they are equal, 1 if
4650 the first one sorts after the second one, -1 if the first one
4651 sorts before the second one. Example: >
4652 func MyCompare(i1, i2)
4653 return a:i1 == a:i2 ? 0 : a:i1 > a:i2 ? 1 : -1
4654 endfunc
4655 let sortedlist = sort(mylist, "MyCompare")
4656 <
4658 *soundfold()*
4659 soundfold({word})
4660 Return the sound-folded equivalent of {word}. Uses the first
4661 language in 'spellang' for the current window that supports
4662 soundfolding. 'spell' must be set. When no sound folding is
4663 possible the {word} is returned unmodified.
4664 This can be used for making spelling suggestions. Note that
4665 the method can be quite slow.
4667 *spellbadword()*
4668 spellbadword([{sentence}])
4669 Without argument: The result is the badly spelled word under
4670 or after the cursor. The cursor is moved to the start of the
4671 bad word. When no bad word is found in the cursor line the
4672 result is an empty string and the cursor doesn't move.
4674 With argument: The result is the first word in {sentence} that
4675 is badly spelled. If there are no spelling mistakes the
4676 result is an empty string.
4678 The return value is a list with two items:
4679 - The badly spelled word or an empty string.
4680 - The type of the spelling error:
4681 "bad" spelling mistake
4682 "rare" rare word
4683 "local" word only valid in another region
4684 "caps" word should start with Capital
4685 Example: >
4686 echo spellbadword("the quik brown fox")
4687 < ['quik', 'bad'] ~
4689 The spelling information for the current window is used. The
4690 'spell' option must be set and the value of 'spelllang' is
4691 used.
4693 *spellsuggest()*
4694 spellsuggest({word} [, {max} [, {capital}]])
4695 Return a |List| with spelling suggestions to replace {word}.
4696 When {max} is given up to this number of suggestions are
4697 returned. Otherwise up to 25 suggestions are returned.
4699 When the {capital} argument is given and it's non-zero only
4700 suggestions with a leading capital will be given. Use this
4701 after a match with 'spellcapcheck'.
4703 {word} can be a badly spelled word followed by other text.
4704 This allows for joining two words that were split. The
4705 suggestions also include the following text, thus you can
4706 replace a line.
4708 {word} may also be a good word. Similar words will then be
4709 returned. {word} itself is not included in the suggestions,
4710 although it may appear capitalized.
4712 The spelling information for the current window is used. The
4713 'spell' option must be set and the values of 'spelllang' and
4714 'spellsuggest' are used.
4717 split({expr} [, {pattern} [, {keepempty}]]) *split()*
4718 Make a |List| out of {expr}. When {pattern} is omitted or
4719 empty each white-separated sequence of characters becomes an
4720 item.
4721 Otherwise the string is split where {pattern} matches,
4722 removing the matched characters.
4723 When the first or last item is empty it is omitted, unless the
4724 {keepempty} argument is given and it's non-zero.
4725 Other empty items are kept when {pattern} matches at least one
4726 character or when {keepempty} is non-zero.
4727 Example: >
4728 :let words = split(getline('.'), '\W\+')
4729 < To split a string in individual characters: >
4730 :for c in split(mystring, '\zs')
4731 < If you want to keep the separator you can also use '\zs': >
4732 :echo split('abc:def:ghi', ':\zs')
4733 < ['abc:', 'def:', 'ghi'] ~
4734 Splitting a table where the first element can be empty: >
4735 :let items = split(line, ':', 1)
4736 < The opposite function is |join()|.
4739 str2nr( {expr} [, {base}]) *str2nr()*
4740 Convert string {expr} to a number.
4741 {base} is the conversion base, it can be 8, 10 or 16.
4742 When {base} is omitted base 10 is used. This also means that
4743 a leading zero doesn't cause octal conversion to be used, as
4744 with the default String to Number conversion.
4745 When {base} is 16 a leading "0x" or "0X" is ignored. With a
4746 different base the result will be zero.
4747 Text after the number is silently ignored.
4750 strftime({format} [, {time}]) *strftime()*
4751 The result is a String, which is a formatted date and time, as
4752 specified by the {format} string. The given {time} is used,
4753 or the current time if no time is given. The accepted
4754 {format} depends on your system, thus this is not portable!
4755 See the manual page of the C function strftime() for the
4756 format. The maximum length of the result is 80 characters.
4757 See also |localtime()| and |getftime()|.
4758 The language can be changed with the |:language| command.
4759 Examples: >
4760 :echo strftime("%c") Sun Apr 27 11:49:23 1997
4761 :echo strftime("%Y %b %d %X") 1997 Apr 27 11:53:25
4762 :echo strftime("%y%m%d %T") 970427 11:53:55
4763 :echo strftime("%H:%M") 11:55
4764 :echo strftime("%c", getftime("file.c"))
4765 Show mod time of file.c.
4766 < Not available on all systems. To check use: >
4767 :if exists("*strftime")
4769 stridx({haystack}, {needle} [, {start}]) *stridx()*
4770 The result is a Number, which gives the byte index in
4771 {haystack} of the first occurrence of the String {needle}.
4772 If {start} is specified, the search starts at index {start}.
4773 This can be used to find a second match: >
4774 :let comma1 = stridx(line, ",")
4775 :let comma2 = stridx(line, ",", comma1 + 1)
4776 < The search is done case-sensitive.
4777 For pattern searches use |match()|.
4778 -1 is returned if the {needle} does not occur in {haystack}.
4779 See also |strridx()|.
4780 Examples: >
4781 :echo stridx("An Example", "Example") 3
4782 :echo stridx("Starting point", "Start") 0
4783 :echo stridx("Starting point", "start") -1
4784 < *strstr()* *strchr()*
4785 stridx() works similar to the C function strstr(). When used
4786 with a single character it works similar to strchr().
4788 *string()*
4789 string({expr}) Return {expr} converted to a String. If {expr} is a Number,
4790 String or a composition of them, then the result can be parsed
4791 back with |eval()|.
4792 {expr} type result ~
4793 String 'string'
4794 Number 123
4795 Funcref function('name')
4796 List [item, item]
4797 Dictionary {key: value, key: value}
4798 Note that in String values the ' character is doubled.
4799 Also see |strtrans()|.
4801 *strlen()*
4802 strlen({expr}) The result is a Number, which is the length of the String
4803 {expr} in bytes.
4804 If you want to count the number of multi-byte characters (not
4805 counting composing characters) use something like this: >
4807 :let len = strlen(substitute(str, ".", "x", "g"))
4808 <
4809 If the argument is a Number it is first converted to a String.
4810 For other types an error is given.
4811 Also see |len()|.
4813 strpart({src}, {start}[, {len}]) *strpart()*
4814 The result is a String, which is part of {src}, starting from
4815 byte {start}, with the byte length {len}.
4816 When non-existing bytes are included, this doesn't result in
4817 an error, the bytes are simply omitted.
4818 If {len} is missing, the copy continues from {start} till the
4819 end of the {src}. >
4820 strpart("abcdefg", 3, 2) == "de"
4821 strpart("abcdefg", -2, 4) == "ab"
4822 strpart("abcdefg", 5, 4) == "fg"
4823 strpart("abcdefg", 3) == "defg"
4824 < Note: To get the first character, {start} must be 0. For
4825 example, to get three bytes under and after the cursor: >
4826 strpart(getline("."), col(".") - 1, 3)
4827 <
4828 strridx({haystack}, {needle} [, {start}]) *strridx()*
4829 The result is a Number, which gives the byte index in
4830 {haystack} of the last occurrence of the String {needle}.
4831 When {start} is specified, matches beyond this index are
4832 ignored. This can be used to find a match before a previous
4833 match: >
4834 :let lastcomma = strridx(line, ",")
4835 :let comma2 = strridx(line, ",", lastcomma - 1)
4836 < The search is done case-sensitive.
4837 For pattern searches use |match()|.
4838 -1 is returned if the {needle} does not occur in {haystack}.
4839 If the {needle} is empty the length of {haystack} is returned.
4840 See also |stridx()|. Examples: >
4841 :echo strridx("an angry armadillo", "an") 3
4842 < *strrchr()*
4843 When used with a single character it works similar to the C
4844 function strrchr().
4846 strtrans({expr}) *strtrans()*
4847 The result is a String, which is {expr} with all unprintable
4848 characters translated into printable characters |'isprint'|.
4849 Like they are shown in a window. Example: >
4850 echo strtrans(@a)
4851 < This displays a newline in register a as "^@" instead of
4852 starting a new line.
4854 submatch({nr}) *submatch()*
4855 Only for an expression in a |:substitute| command. Returns
4856 the {nr}'th submatch of the matched text. When {nr} is 0
4857 the whole matched text is returned.
4858 Example: >
4859 :s/\d\+/\=submatch(0) + 1/
4860 < This finds the first number in the line and adds one to it.
4861 A line break is included as a newline character.
4863 substitute({expr}, {pat}, {sub}, {flags}) *substitute()*
4864 The result is a String, which is a copy of {expr}, in which
4865 the first match of {pat} is replaced with {sub}. This works
4866 like the ":substitute" command (without any flags). But the
4867 matching with {pat} is always done like the 'magic' option is
4868 set and 'cpoptions' is empty (to make scripts portable).
4869 'ignorecase' is still relevant. 'smartcase' is not used.
4870 See |string-match| for how {pat} is used.
4871 And a "~" in {sub} is not replaced with the previous {sub}.
4872 Note that some codes in {sub} have a special meaning
4873 |sub-replace-special|. For example, to replace something with
4874 "\n" (two characters), use "\\\\n" or '\\n'.
4875 When {pat} does not match in {expr}, {expr} is returned
4876 unmodified.
4877 When {flags} is "g", all matches of {pat} in {expr} are
4878 replaced. Otherwise {flags} should be "".
4879 Example: >
4880 :let &path = substitute(&path, ",\\=[^,]*$", "", "")
4881 < This removes the last component of the 'path' option. >
4882 :echo substitute("testing", ".*", "\\U\\0", "")
4883 < results in "TESTING".
4885 synID({lnum}, {col}, {trans}) *synID()*
4886 The result is a Number, which is the syntax ID at the position
4887 {lnum} and {col} in the current window.
4888 The syntax ID can be used with |synIDattr()| and
4889 |synIDtrans()| to obtain syntax information about text.
4891 {col} is 1 for the leftmost column, {lnum} is 1 for the first
4892 line. 'synmaxcol' applies, in a longer line zero is returned.
4894 When {trans} is non-zero, transparent items are reduced to the
4895 item that they reveal. This is useful when wanting to know
4896 the effective color. When {trans} is zero, the transparent
4897 item is returned. This is useful when wanting to know which
4898 syntax item is effective (e.g. inside parens).
4899 Warning: This function can be very slow. Best speed is
4900 obtained by going through the file in forward direction.
4902 Example (echoes the name of the syntax item under the cursor): >
4903 :echo synIDattr(synID(line("."), col("."), 1), "name")
4904 <
4905 synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
4906 The result is a String, which is the {what} attribute of
4907 syntax ID {synID}. This can be used to obtain information
4908 about a syntax item.
4909 {mode} can be "gui", "cterm" or "term", to get the attributes
4910 for that mode. When {mode} is omitted, or an invalid value is
4911 used, the attributes for the currently active highlighting are
4912 used (GUI, cterm or term).
4913 Use synIDtrans() to follow linked highlight groups.
4914 {what} result
4915 "name" the name of the syntax item
4916 "fg" foreground color (GUI: color name used to set
4917 the color, cterm: color number as a string,
4918 term: empty string)
4919 "bg" background color (like "fg")
4920 "fg#" like "fg", but for the GUI and the GUI is
4921 running the name in "#RRGGBB" form
4922 "bg#" like "fg#" for "bg"
4923 "bold" "1" if bold
4924 "italic" "1" if italic
4925 "reverse" "1" if reverse
4926 "inverse" "1" if inverse (= reverse)
4927 "underline" "1" if underlined
4928 "undercurl" "1" if undercurled
4930 Example (echoes the color of the syntax item under the
4931 cursor): >
4932 :echo synIDattr(synIDtrans(synID(line("."), col("."), 1)), "fg")
4933 <
4934 synIDtrans({synID}) *synIDtrans()*
4935 The result is a Number, which is the translated syntax ID of
4936 {synID}. This is the syntax group ID of what is being used to
4937 highlight the character. Highlight links given with
4938 ":highlight link" are followed.
4940 system({expr} [, {input}]) *system()* *E677*
4941 Get the output of the shell command {expr}.
4942 When {input} is given, this string is written to a file and
4943 passed as stdin to the command. The string is written as-is,
4944 you need to take care of using the correct line separators
4945 yourself. Pipes are not used.
4946 Note: newlines in {expr} may cause the command to fail. The
4947 characters in 'shellquote' and 'shellxquote' may also cause
4948 trouble.
4949 This is not to be used for interactive commands.
4950 The result is a String. Example: >
4952 :let files = system("ls")
4954 < To make the result more system-independent, the shell output
4955 is filtered to replace <CR> with <NL> for Macintosh, and
4956 <CR><NL> with <NL> for DOS-like systems.
4957 The command executed is constructed using several options:
4958 'shell' 'shellcmdflag' 'shellxquote' {expr} 'shellredir' {tmp} 'shellxquote'
4959 ({tmp} is an automatically generated file name).
4960 For Unix and OS/2 braces are put around {expr} to allow for
4961 concatenated commands.
4963 The command will be executed in "cooked" mode, so that a
4964 CTRL-C will interrupt the command (on Unix at least).
4966 The resulting error code can be found in |v:shell_error|.
4967 This function will fail in |restricted-mode|.
4969 Note that any wrong value in the options mentioned above may
4970 make the function fail. It has also been reported to fail
4971 when using a security agent application.
4972 Unlike ":!cmd" there is no automatic check for changed files.
4973 Use |:checktime| to force a check.
4976 tabpagebuflist([{arg}]) *tabpagebuflist()*
4977 The result is a |List|, where each item is the number of the
4978 buffer associated with each window in the current tab page.
4979 {arg} specifies the number of tab page to be used. When
4980 omitted the current tab page is used.
4981 When {arg} is invalid the number zero is returned.
4982 To get a list of all buffers in all tabs use this: >
4983 tablist = []
4984 for i in range(tabpagenr('$'))
4985 call extend(tablist, tabpagebuflist(i + 1))
4986 endfor
4987 < Note that a buffer may appear in more than one window.
4990 tabpagenr([{arg}]) *tabpagenr()*
4991 The result is a Number, which is the number of the current
4992 tab page. The first tab page has number 1.
4993 When the optional argument is "$", the number of the last tab
4994 page is returned (the tab page count).
4995 The number can be used with the |:tab| command.
4998 tabpagewinnr({tabarg}, [{arg}]) *tabpagewinnr()*
4999 Like |winnr()| but for tab page {arg}.
5000 {tabarg} specifies the number of tab page to be used.
5001 {arg} is used like with |winnr()|:
5002 - When omitted the current window number is returned. This is
5003 the window which will be used when going to this tab page.
5004 - When "$" the number of windows is returned.
5005 - When "#" the previous window nr is returned.
5006 Useful examples: >
5007 tabpagewinnr(1) " current window of tab page 1
5008 tabpagewinnr(4, '$') " number of windows in tab page 4
5009 < When {tabarg} is invalid zero is returned.
5011 *tagfiles()*
5012 tagfiles() Returns a |List| with the file names used to search for tags
5013 for the current buffer. This is the 'tags' option expanded.
5016 taglist({expr}) *taglist()*
5017 Returns a list of tags matching the regular expression {expr}.
5018 Each list item is a dictionary with at least the following
5019 entries:
5020 name Name of the tag.
5021 filename Name of the file where the tag is
5022 defined. It is either relative to the
5023 current directory or a full path.
5024 cmd Ex command used to locate the tag in
5025 the file.
5026 kind Type of the tag. The value for this
5027 entry depends on the language specific
5028 kind values. Only available when
5029 using a tags file generated by
5030 Exuberant ctags or hdrtag.
5031 static A file specific tag. Refer to
5032 |static-tag| for more information.
5033 More entries may be present, depending on the content of the
5034 tags file: access, implementation, inherits and signature.
5035 Refer to the ctags documentation for information about these
5036 fields. For C code the fields "struct", "class" and "enum"
5037 may appear, they give the name of the entity the tag is
5038 contained in.
5040 The ex-command 'cmd' can be either an ex search pattern, a
5041 line number or a line number followed by a byte number.
5043 If there are no matching tags, then an empty list is returned.
5045 To get an exact tag match, the anchors '^' and '$' should be
5046 used in {expr}. Refer to |tag-regexp| for more information
5047 about the tag search regular expression pattern.
5049 Refer to |'tags'| for information about how the tags file is
5050 located by Vim. Refer to |tags-file-format| for the format of
5051 the tags file generated by the different ctags tools.
5053 tempname() *tempname()* *temp-file-name*
5054 The result is a String, which is the name of a file that
5055 doesn't exist. It can be used for a temporary file. The name
5056 is different for at least 26 consecutive calls. Example: >
5057 :let tmpfile = tempname()
5058 :exe "redir > " . tmpfile
5059 < For Unix, the file will be in a private directory (only
5060 accessible by the current user) to avoid security problems
5061 (e.g., a symlink attack or other people reading your file).
5062 When Vim exits the directory and all files in it are deleted.
5063 For MS-Windows forward slashes are used when the 'shellslash'
5064 option is set or when 'shellcmdflag' starts with '-'.
5066 tolower({expr}) *tolower()*
5067 The result is a copy of the String given, with all uppercase
5068 characters turned into lowercase (just like applying |gu| to
5069 the string).
5071 toupper({expr}) *toupper()*
5072 The result is a copy of the String given, with all lowercase
5073 characters turned into uppercase (just like applying |gU| to
5074 the string).
5076 tr({src}, {fromstr}, {tostr}) *tr()*
5077 The result is a copy of the {src} string with all characters
5078 which appear in {fromstr} replaced by the character in that
5079 position in the {tostr} string. Thus the first character in
5080 {fromstr} is translated into the first character in {tostr}
5081 and so on. Exactly like the unix "tr" command.
5082 This code also deals with multibyte characters properly.
5084 Examples: >
5085 echo tr("hello there", "ht", "HT")
5086 < returns "Hello THere" >
5087 echo tr("<blob>", "<>", "{}")
5088 < returns "{blob}"
5090 *type()*
5091 type({expr}) The result is a Number, depending on the type of {expr}:
5092 Number: 0
5093 String: 1
5094 Funcref: 2
5095 List: 3
5096 Dictionary: 4
5097 To avoid the magic numbers it should be used this way: >
5098 :if type(myvar) == type(0)
5099 :if type(myvar) == type("")
5100 :if type(myvar) == type(function("tr"))
5101 :if type(myvar) == type([])
5102 :if type(myvar) == type({})
5104 values({dict}) *values()*
5105 Return a |List| with all the values of {dict}. The |List| is
5106 in arbitrary order.
5109 virtcol({expr}) *virtcol()*
5110 The result is a Number, which is the screen column of the file
5111 position given with {expr}. That is, the last screen position
5112 occupied by the character at that position, when the screen
5113 would be of unlimited width. When there is a <Tab> at the
5114 position, the returned Number will be the column at the end of
5115 the <Tab>. For example, for a <Tab> in column 1, with 'ts'
5116 set to 8, it returns 8.
5117 For the byte position use |col()|.
5118 For the use of {expr} see |col()|.
5119 When 'virtualedit' is used {expr} can be [lnum, col, off], where
5120 "off" is the offset in screen columns from the start of the
5121 character. E.g., a position within a <Tab> or after the last
5122 character.
5123 When Virtual editing is active in the current mode, a position
5124 beyond the end of the line can be returned. |'virtualedit'|
5125 The accepted positions are:
5126 . the cursor position
5127 $ the end of the cursor line (the result is the
5128 number of displayed characters in the cursor line
5129 plus one)
5130 'x position of mark x (if the mark is not set, 0 is
5131 returned)
5132 Note that only marks in the current file can be used.
5133 Examples: >
5134 virtcol(".") with text "foo^Lbar", with cursor on the "^L", returns 5
5135 virtcol("$") with text "foo^Lbar", returns 9
5136 virtcol("'t") with text " there", with 't at 'h', returns 6
5137 < The first column is 1. 0 is returned for an error.
5138 A more advanced example that echoes the maximum length of
5139 all lines: >
5140 echo max(map(range(1, line('$')), "virtcol([v:val, '$'])"))
5143 visualmode([expr]) *visualmode()*
5144 The result is a String, which describes the last Visual mode
5145 used in the current buffer. Initially it returns an empty
5146 string, but once Visual mode has been used, it returns "v",
5147 "V", or "<CTRL-V>" (a single CTRL-V character) for
5148 character-wise, line-wise, or block-wise Visual mode
5149 respectively.
5150 Example: >
5151 :exe "normal " . visualmode()
5152 < This enters the same Visual mode as before. It is also useful
5153 in scripts if you wish to act differently depending on the
5154 Visual mode that was used.
5156 If an expression is supplied that results in a non-zero number
5157 or a non-empty string, then the Visual mode will be cleared
5158 and the old value is returned. Note that " " and "0" are also
5159 non-empty strings, thus cause the mode to be cleared.
5161 *winbufnr()*
5162 winbufnr({nr}) The result is a Number, which is the number of the buffer
5163 associated with window {nr}. When {nr} is zero, the number of
5164 the buffer in the current window is returned. When window
5165 {nr} doesn't exist, -1 is returned.
5166 Example: >
5167 :echo "The file in the current window is " . bufname(winbufnr(0))
5168 <
5169 *wincol()*
5170 wincol() The result is a Number, which is the virtual column of the
5171 cursor in the window. This is counting screen cells from the
5172 left side of the window. The leftmost column is one.
5174 winheight({nr}) *winheight()*
5175 The result is a Number, which is the height of window {nr}.
5176 When {nr} is zero, the height of the current window is
5177 returned. When window {nr} doesn't exist, -1 is returned.
5178 An existing window always has a height of zero or more.
5179 Examples: >
5180 :echo "The current window has " . winheight(0) . " lines."
5181 <
5182 *winline()*
5183 winline() The result is a Number, which is the screen line of the cursor
5184 in the window. This is counting screen lines from the top of
5185 the window. The first line is one.
5186 If the cursor was moved the view on the file will be updated
5187 first, this may cause a scroll.
5189 *winnr()*
5190 winnr([{arg}]) The result is a Number, which is the number of the current
5191 window. The top window has number 1.
5192 When the optional argument is "$", the number of the
5193 last window is returned (the window count).
5194 When the optional argument is "#", the number of the last
5195 accessed window is returned (where |CTRL-W_p| goes to).
5196 If there is no previous window or it is in another tab page 0
5197 is returned.
5198 The number can be used with |CTRL-W_w| and ":wincmd w"
5199 |:wincmd|.
5200 Also see |tabpagewinnr()|.
5202 *winrestcmd()*
5203 winrestcmd() Returns a sequence of |:resize| commands that should restore
5204 the current window sizes. Only works properly when no windows
5205 are opened or closed and the current window and tab page is
5206 unchanged.
5207 Example: >
5208 :let cmd = winrestcmd()
5209 :call MessWithWindowSizes()
5210 :exe cmd
5211 <
5212 *winrestview()*
5213 winrestview({dict})
5214 Uses the |Dictionary| returned by |winsaveview()| to restore
5215 the view of the current window.
5216 If you have changed the values the result is unpredictable.
5217 If the window size changed the result won't be the same.
5219 *winsaveview()*
5220 winsaveview() Returns a |Dictionary| that contains information to restore
5221 the view of the current window. Use |winrestview()| to
5222 restore the view.
5223 This is useful if you have a mapping that jumps around in the
5224 buffer and you want to go back to the original view.
5225 This does not save fold information. Use the 'foldenable'
5226 option to temporarily switch off folding, so that folds are
5227 not opened when moving around.
5228 The return value includes:
5229 lnum cursor line number
5230 col cursor column
5231 coladd cursor column offset for 'virtualedit'
5232 curswant column for vertical movement
5233 topline first line in the window
5234 topfill filler lines, only in diff mode
5235 leftcol first column displayed
5236 skipcol columns skipped
5237 Note that no option values are saved.
5240 winwidth({nr}) *winwidth()*
5241 The result is a Number, which is the width of window {nr}.
5242 When {nr} is zero, the width of the current window is
5243 returned. When window {nr} doesn't exist, -1 is returned.
5244 An existing window always has a width of zero or more.
5245 Examples: >
5246 :echo "The current window has " . winwidth(0) . " columns."
5247 :if winwidth(0) <= 50
5248 : exe "normal 50\<C-W>|"
5249 :endif
5250 <
5251 *writefile()*
5252 writefile({list}, {fname} [, {binary}])
5253 Write |List| {list} to file {fname}. Each list item is
5254 separated with a NL. Each list item must be a String or
5255 Number.
5256 When {binary} is equal to "b" binary mode is used: There will
5257 not be a NL after the last list item. An empty item at the
5258 end does cause the last line in the file to end in a NL.
5259 All NL characters are replaced with a NUL character.
5260 Inserting CR characters needs to be done before passing {list}
5261 to writefile().
5262 An existing file is overwritten, if possible.
5263 When the write fails -1 is returned, otherwise 0. There is an
5264 error message if the file can't be created or when writing
5265 fails.
5266 Also see |readfile()|.
5267 To copy a file byte for byte: >
5268 :let fl = readfile("foo", "b")
5269 :call writefile(fl, "foocopy", "b")
5270 <
5272 *feature-list*
5273 There are three types of features:
5274 1. Features that are only supported when they have been enabled when Vim
5275 was compiled |+feature-list|. Example: >
5276 :if has("cindent")
5277 2. Features that are only supported when certain conditions have been met.
5278 Example: >
5279 :if has("gui_running")
5280 < *has-patch*
5281 3. Included patches. First check |v:version| for the version of Vim.
5282 Then the "patch123" feature means that patch 123 has been included for
5283 this version. Example (checking version 6.2.148 or later): >
5284 :if v:version > 602 || v:version == 602 && has("patch148")
5285 < Note that it's possible for patch 147 to be omitted even though 148 is
5286 included.
5288 all_builtin_terms Compiled with all builtin terminals enabled.
5289 amiga Amiga version of Vim.
5290 arabic Compiled with Arabic support |Arabic|.
5291 arp Compiled with ARP support (Amiga).
5292 autocmd Compiled with autocommand support. |autocommand|
5293 balloon_eval Compiled with |balloon-eval| support.
5294 balloon_multiline GUI supports multiline balloons.
5295 beos BeOS version of Vim.
5296 browse Compiled with |:browse| support, and browse() will
5297 work.
5298 builtin_terms Compiled with some builtin terminals.
5299 byte_offset Compiled with support for 'o' in 'statusline'
5300 cindent Compiled with 'cindent' support.
5301 clientserver Compiled with remote invocation support |clientserver|.
5302 clipboard Compiled with 'clipboard' support.
5303 cmdline_compl Compiled with |cmdline-completion| support.
5304 cmdline_hist Compiled with |cmdline-history| support.
5305 cmdline_info Compiled with 'showcmd' and 'ruler' support.
5306 comments Compiled with |'comments'| support.
5307 cryptv Compiled with encryption support |encryption|.
5308 cscope Compiled with |cscope| support.
5309 compatible Compiled to be very Vi compatible.
5310 debug Compiled with "DEBUG" defined.
5311 dialog_con Compiled with console dialog support.
5312 dialog_gui Compiled with GUI dialog support.
5313 diff Compiled with |vimdiff| and 'diff' support.
5314 digraphs Compiled with support for digraphs.
5315 dnd Compiled with support for the "~ register |quote_~|.
5316 dos32 32 bits DOS (DJGPP) version of Vim.
5317 dos16 16 bits DOS version of Vim.
5318 ebcdic Compiled on a machine with ebcdic character set.
5319 emacs_tags Compiled with support for Emacs tags.
5320 eval Compiled with expression evaluation support. Always
5321 true, of course!
5322 ex_extra Compiled with extra Ex commands |+ex_extra|.
5323 extra_search Compiled with support for |'incsearch'| and
5324 |'hlsearch'|
5325 farsi Compiled with Farsi support |farsi|.
5326 file_in_path Compiled with support for |gf| and |<cfile>|
5327 filterpipe When 'shelltemp' is off pipes are used for shell
5328 read/write/filter commands
5329 find_in_path Compiled with support for include file searches
5330 |+find_in_path|.
5331 fname_case Case in file names matters (for Amiga, MS-DOS, and
5332 Windows this is not present).
5333 folding Compiled with |folding| support.
5334 footer Compiled with GUI footer support. |gui-footer|
5335 fork Compiled to use fork()/exec() instead of system().
5336 gettext Compiled with message translation |multi-lang|
5337 gui Compiled with GUI enabled.
5338 gui_athena Compiled with Athena GUI.
5339 gui_gtk Compiled with GTK+ GUI (any version).
5340 gui_gtk2 Compiled with GTK+ 2 GUI (gui_gtk is also defined).
5341 gui_mac Compiled with Macintosh GUI (Carbon).
5342 gui_macvim Compiled with MacVim GUI.
5343 gui_motif Compiled with Motif GUI.
5344 gui_photon Compiled with Photon GUI.
5345 gui_win32 Compiled with MS Windows Win32 GUI.
5346 gui_win32s idem, and Win32s system being used (Windows 3.1)
5347 gui_running Vim is running in the GUI, or it will start soon.
5348 hangul_input Compiled with Hangul input support. |hangul|
5349 iconv Can use iconv() for conversion.
5350 insert_expand Compiled with support for CTRL-X expansion commands in
5351 Insert mode.
5352 jumplist Compiled with |jumplist| support.
5353 keymap Compiled with 'keymap' support.
5354 langmap Compiled with 'langmap' support.
5355 libcall Compiled with |libcall()| support.
5356 linebreak Compiled with 'linebreak', 'breakat' and 'showbreak'
5357 support.
5358 lispindent Compiled with support for lisp indenting.
5359 listcmds Compiled with commands for the buffer list |:files|
5360 and the argument list |arglist|.
5361 localmap Compiled with local mappings and abbr. |:map-local|
5362 mac Macintosh version of Vim.
5363 macunix Macintosh version of Vim, using Unix files (OS-X).
5364 menu Compiled with support for |:menu|.
5365 mksession Compiled with support for |:mksession|.
5366 modify_fname Compiled with file name modifiers. |filename-modifiers|
5367 mouse Compiled with support mouse.
5368 mouseshape Compiled with support for 'mouseshape'.
5369 mouse_dec Compiled with support for Dec terminal mouse.
5370 mouse_gpm Compiled with support for gpm (Linux console mouse)
5371 mouse_netterm Compiled with support for netterm mouse.
5372 mouse_pterm Compiled with support for qnx pterm mouse.
5373 mouse_xterm Compiled with support for xterm mouse.
5374 multi_byte Compiled with support for editing Korean et al.
5375 multi_byte_ime Compiled with support for IME input method.
5376 multi_lang Compiled with support for multiple languages.
5377 mzscheme Compiled with MzScheme interface |mzscheme|.
5378 netbeans_intg Compiled with support for |netbeans|.
5379 netbeans_enabled Compiled with support for |netbeans| and it's used.
5380 ole Compiled with OLE automation support for Win32.
5381 os2 OS/2 version of Vim.
5382 osfiletype Compiled with support for osfiletypes |+osfiletype|
5383 path_extra Compiled with up/downwards search in 'path' and 'tags'
5384 perl Compiled with Perl interface.
5385 postscript Compiled with PostScript file printing.
5386 printer Compiled with |:hardcopy| support.
5387 profile Compiled with |:profile| support.
5388 python Compiled with Python interface.
5389 qnx QNX version of Vim.
5390 quickfix Compiled with |quickfix| support.
5391 reltime Compiled with |reltime()| support.
5392 rightleft Compiled with 'rightleft' support.
5393 ruby Compiled with Ruby interface |ruby|.
5394 scrollbind Compiled with 'scrollbind' support.
5395 showcmd Compiled with 'showcmd' support.
5396 signs Compiled with |:sign| support.
5397 smartindent Compiled with 'smartindent' support.
5398 sniff Compiled with SNiFF interface support.
5399 statusline Compiled with support for 'statusline', 'rulerformat'
5400 and special formats of 'titlestring' and 'iconstring'.
5401 sun_workshop Compiled with support for Sun |workshop|.
5402 spell Compiled with spell checking support |spell|.
5403 syntax Compiled with syntax highlighting support |syntax|.
5404 syntax_items There are active syntax highlighting items for the
5405 current buffer.
5406 system Compiled to use system() instead of fork()/exec().
5407 tag_binary Compiled with binary searching in tags files
5408 |tag-binary-search|.
5409 tag_old_static Compiled with support for old static tags
5410 |tag-old-static|.
5411 tag_any_white Compiled with support for any white characters in tags
5412 files |tag-any-white|.
5413 tcl Compiled with Tcl interface.
5414 terminfo Compiled with terminfo instead of termcap.
5415 termresponse Compiled with support for |t_RV| and |v:termresponse|.
5416 textobjects Compiled with support for |text-objects|.
5417 tgetent Compiled with tgetent support, able to use a termcap
5418 or terminfo file.
5419 title Compiled with window title support |'title'|.
5420 toolbar Compiled with support for |gui-toolbar|.
5421 unix Unix version of Vim.
5422 user_commands User-defined commands.
5423 viminfo Compiled with viminfo support.
5424 vim_starting True while initial source'ing takes place.
5425 vertsplit Compiled with vertically split windows |:vsplit|.
5426 virtualedit Compiled with 'virtualedit' option.
5427 visual Compiled with Visual mode.
5428 visualextra Compiled with extra Visual mode commands.
5429 |blockwise-operators|.
5430 vms VMS version of Vim.
5431 vreplace Compiled with |gR| and |gr| commands.
5432 wildignore Compiled with 'wildignore' option.
5433 wildmenu Compiled with 'wildmenu' option.
5434 windows Compiled with support for more than one window.
5435 winaltkeys Compiled with 'winaltkeys' option.
5436 win16 Win16 version of Vim (MS-Windows 3.1).
5437 win32 Win32 version of Vim (MS-Windows 95/98/ME/NT/2000/XP).
5438 win64 Win64 version of Vim (MS-Windows 64 bit).
5439 win32unix Win32 version of Vim, using Unix files (Cygwin)
5440 win95 Win32 version for MS-Windows 95/98/ME.
5441 writebackup Compiled with 'writebackup' default on.
5442 xfontset Compiled with X fontset support |xfontset|.
5443 xim Compiled with X input method support |xim|.
5444 xsmp Compiled with X session management support.
5445 xsmp_interact Compiled with interactive X session management support.
5446 xterm_clipboard Compiled with support for xterm clipboard.
5447 xterm_save Compiled with support for saving and restoring the
5448 xterm screen.
5449 x11 Compiled with X11 support.
5451 *string-match*
5452 Matching a pattern in a String
5454 A regexp pattern as explained at |pattern| is normally used to find a match in
5455 the buffer lines. When a pattern is used to find a match in a String, almost
5456 everything works in the same way. The difference is that a String is handled
5457 like it is one line. When it contains a "\n" character, this is not seen as a
5458 line break for the pattern. It can be matched with a "\n" in the pattern, or
5459 with ".". Example: >
5460 :let a = "aaaa\nxxxx"
5461 :echo matchstr(a, "..\n..")
5462 aa
5463 xx
5464 :echo matchstr(a, "a.x")
5465 a
5466 x
5468 Don't forget that "^" will only match at the first character of the String and
5469 "$" at the last character of the string. They don't match after or before a
5470 "\n".
5472 ==============================================================================
5473 5. Defining functions *user-functions*
5475 New functions can be defined. These can be called just like builtin
5476 functions. The function executes a sequence of Ex commands. Normal mode
5477 commands can be executed with the |:normal| command.
5479 The function name must start with an uppercase letter, to avoid confusion with
5480 builtin functions. To prevent from using the same name in different scripts
5481 avoid obvious, short names. A good habit is to start the function name with
5482 the name of the script, e.g., "HTMLcolor()".
5484 It's also possible to use curly braces, see |curly-braces-names|. And the
5485 |autoload| facility is useful to define a function only when it's called.
5487 *local-function*
5488 A function local to a script must start with "s:". A local script function
5489 can only be called from within the script and from functions, user commands
5490 and autocommands defined in the script. It is also possible to call the
5491 function from a mappings defined in the script, but then |<SID>| must be used
5492 instead of "s:" when the mapping is expanded outside of the script.
5494 *:fu* *:function* *E128* *E129* *E123*
5495 :fu[nction] List all functions and their arguments.
5497 :fu[nction] {name} List function {name}.
5498 {name} can also be a |Dictionary| entry that is a
5499 |Funcref|: >
5500 :function dict.init
5502 :fu[nction] /{pattern} List functions with a name matching {pattern}.
5503 Example that lists all functions ending with "File": >
5504 :function /File$
5505 <
5506 *:function-verbose*
5507 When 'verbose' is non-zero, listing a function will also display where it was
5508 last defined. Example: >
5510 :verbose function SetFileTypeSH
5511 function SetFileTypeSH(name)
5512 Last set from /usr/share/vim/vim-7.0/filetype.vim
5513 <
5514 See |:verbose-cmd| for more information.
5516 *E124* *E125*
5517 :fu[nction][!] {name}([arguments]) [range] [abort] [dict]
5518 Define a new function by the name {name}. The name
5519 must be made of alphanumeric characters and '_', and
5520 must start with a capital or "s:" (see above).
5522 {name} can also be a |Dictionary| entry that is a
5523 |Funcref|: >
5524 :function dict.init(arg)
5525 < "dict" must be an existing dictionary. The entry
5526 "init" is added if it didn't exist yet. Otherwise [!]
5527 is required to overwrite an existing function. The
5528 result is a |Funcref| to a numbered function. The
5529 function can only be used with a |Funcref| and will be
5530 deleted if there are no more references to it.
5531 *E127* *E122*
5532 When a function by this name already exists and [!] is
5533 not used an error message is given. When [!] is used,
5534 an existing function is silently replaced. Unless it
5535 is currently being executed, that is an error.
5537 For the {arguments} see |function-argument|.
5539 *a:firstline* *a:lastline*
5540 When the [range] argument is added, the function is
5541 expected to take care of a range itself. The range is
5542 passed as "a:firstline" and "a:lastline". If [range]
5543 is excluded, ":{range}call" will call the function for
5544 each line in the range, with the cursor on the start
5545 of each line. See |function-range-example|.
5547 When the [abort] argument is added, the function will
5548 abort as soon as an error is detected.
5550 When the [dict] argument is added, the function must
5551 be invoked through an entry in a |Dictionary|. The
5552 local variable "self" will then be set to the
5553 dictionary. See |Dictionary-function|.
5555 The last used search pattern and the redo command "."
5556 will not be changed by the function.
5558 *:endf* *:endfunction* *E126* *E193*
5559 :endf[unction] The end of a function definition. Must be on a line
5560 by its own, without other commands.
5562 *:delf* *:delfunction* *E130* *E131*
5563 :delf[unction] {name} Delete function {name}.
5564 {name} can also be a |Dictionary| entry that is a
5565 |Funcref|: >
5566 :delfunc dict.init
5567 < This will remove the "init" entry from "dict". The
5568 function is deleted if there are no more references to
5569 it.
5570 *:retu* *:return* *E133*
5571 :retu[rn] [expr] Return from a function. When "[expr]" is given, it is
5572 evaluated and returned as the result of the function.
5573 If "[expr]" is not given, the number 0 is returned.
5574 When a function ends without an explicit ":return",
5575 the number 0 is returned.
5576 Note that there is no check for unreachable lines,
5577 thus there is no warning if commands follow ":return".
5579 If the ":return" is used after a |:try| but before the
5580 matching |:finally| (if present), the commands
5581 following the ":finally" up to the matching |:endtry|
5582 are executed first. This process applies to all
5583 nested ":try"s inside the function. The function
5584 returns at the outermost ":endtry".
5586 *function-argument* *a:var*
5587 An argument can be defined by giving its name. In the function this can then
5588 be used as "a:name" ("a:" for argument).
5589 *a:0* *a:1* *a:000* *E740* *...*
5590 Up to 20 arguments can be given, separated by commas. After the named
5591 arguments an argument "..." can be specified, which means that more arguments
5592 may optionally be following. In the function the extra arguments can be used
5593 as "a:1", "a:2", etc. "a:0" is set to the number of extra arguments (which
5594 can be 0). "a:000" is set to a |List| that contains these arguments. Note
5595 that "a:1" is the same as "a:000[0]".
5596 *E742*
5597 The a: scope and the variables in it cannot be changed, they are fixed.
5598 However, if a |List| or |Dictionary| is used, you can changes their contents.
5599 Thus you can pass a |List| to a function and have the function add an item to
5600 it. If you want to make sure the function cannot change a |List| or
5601 |Dictionary| use |:lockvar|.
5603 When not using "...", the number of arguments in a function call must be equal
5604 to the number of named arguments. When using "...", the number of arguments
5605 may be larger.
5607 It is also possible to define a function without any arguments. You must
5608 still supply the () then. The body of the function follows in the next lines,
5609 until the matching |:endfunction|. It is allowed to define another function
5610 inside a function body.
5612 *local-variables*
5613 Inside a function variables can be used. These are local variables, which
5614 will disappear when the function returns. Global variables need to be
5615 accessed with "g:".
5617 Example: >
5618 :function Table(title, ...)
5619 : echohl Title
5620 : echo a:title
5621 : echohl None
5622 : echo a:0 . " items:"
5623 : for s in a:000
5624 : echon ' ' . s
5625 : endfor
5626 :endfunction
5628 This function can then be called with: >
5629 call Table("Table", "line1", "line2")
5630 call Table("Empty Table")
5632 To return more than one value, return a |List|: >
5633 :function Compute(n1, n2)
5634 : if a:n2 == 0
5635 : return ["fail", 0]
5636 : endif
5637 : return ["ok", a:n1 / a:n2]
5638 :endfunction
5640 This function can then be called with: >
5641 :let [success, div] = Compute(102, 6)
5642 :if success == "ok"
5643 : echo div
5644 :endif
5645 <
5646 *:cal* *:call* *E107* *E117*
5647 :[range]cal[l] {name}([arguments])
5648 Call a function. The name of the function and its arguments
5649 are as specified with |:function|. Up to 20 arguments can be
5650 used. The returned value is discarded.
5651 Without a range and for functions that accept a range, the
5652 function is called once. When a range is given the cursor is
5653 positioned at the start of the first line before executing the
5654 function.
5655 When a range is given and the function doesn't handle it
5656 itself, the function is executed for each line in the range,
5657 with the cursor in the first column of that line. The cursor
5658 is left at the last line (possibly moved by the last function
5659 call). The arguments are re-evaluated for each line. Thus
5660 this works:
5661 *function-range-example* >
5662 :function Mynumber(arg)
5663 : echo line(".") . " " . a:arg
5664 :endfunction
5665 :1,5call Mynumber(getline("."))
5666 <
5667 The "a:firstline" and "a:lastline" are defined anyway, they
5668 can be used to do something different at the start or end of
5669 the range.
5671 Example of a function that handles the range itself: >
5673 :function Cont() range
5674 : execute (a:firstline + 1) . "," . a:lastline . 's/^/\t\\ '
5675 :endfunction
5676 :4,8call Cont()
5677 <
5678 This function inserts the continuation character "\" in front
5679 of all the lines in the range, except the first one.
5681 When the function returns a composite value it can be further
5682 dereferenced, but the range will not be used then. Example: >
5683 :4,8call GetDict().method()
5684 < Here GetDict() gets the range but method() does not.
5686 *E132*
5687 The recursiveness of user functions is restricted with the |'maxfuncdepth'|
5688 option.
5691 AUTOMATICALLY LOADING FUNCTIONS ~
5692 *autoload-functions*
5693 When using many or large functions, it's possible to automatically define them
5694 only when they are used. There are two methods: with an autocommand and with
5695 the "autoload" directory in 'runtimepath'.
5698 Using an autocommand ~
5700 This is introduced in the user manual, section |41.14|.
5702 The autocommand is useful if you have a plugin that is a long Vim script file.
5703 You can define the autocommand and quickly quit the script with |:finish|.
5704 That makes Vim startup faster. The autocommand should then load the same file
5705 again, setting a variable to skip the |:finish| command.
5707 Use the FuncUndefined autocommand event with a pattern that matches the
5708 function(s) to be defined. Example: >
5710 :au FuncUndefined BufNet* source ~/vim/bufnetfuncs.vim
5712 The file "~/vim/bufnetfuncs.vim" should then define functions that start with
5713 "BufNet". Also see |FuncUndefined|.
5716 Using an autoload script ~
5717 *autoload* *E746*
5718 This is introduced in the user manual, section |41.15|.
5720 Using a script in the "autoload" directory is simpler, but requires using
5721 exactly the right file name. A function that can be autoloaded has a name
5722 like this: >
5724 :call filename#funcname()
5726 When such a function is called, and it is not defined yet, Vim will search the
5727 "autoload" directories in 'runtimepath' for a script file called
5728 "filename.vim". For example "~/.vim/autoload/filename.vim". That file should
5729 then define the function like this: >
5731 function filename#funcname()
5732 echo "Done!"
5733 endfunction
5735 The file name and the name used before the # in the function must match
5736 exactly, and the defined function must have the name exactly as it will be
5737 called.
5739 It is possible to use subdirectories. Every # in the function name works like
5740 a path separator. Thus when calling a function: >
5742 :call foo#bar#func()
5744 Vim will look for the file "autoload/foo/bar.vim" in 'runtimepath'.
5746 This also works when reading a variable that has not been set yet: >
5748 :let l = foo#bar#lvar
5750 However, when the autoload script was already loaded it won't be loaded again
5751 for an unknown variable.
5753 When assigning a value to such a variable nothing special happens. This can
5754 be used to pass settings to the autoload script before it's loaded: >
5756 :let foo#bar#toggle = 1
5757 :call foo#bar#func()
5759 Note that when you make a mistake and call a function that is supposed to be
5760 defined in an autoload script, but the script doesn't actually define the
5761 function, the script will be sourced every time you try to call the function.
5762 And you will get an error message every time.
5764 Also note that if you have two script files, and one calls a function in the
5765 other and vise versa, before the used function is defined, it won't work.
5766 Avoid using the autoload functionality at the toplevel.
5768 Hint: If you distribute a bunch of scripts you can pack them together with the
5769 |vimball| utility. Also read the user manual |distribute-script|.
5771 ==============================================================================
5772 6. Curly braces names *curly-braces-names*
5774 Wherever you can use a variable, you can use a "curly braces name" variable.
5775 This is a regular variable name with one or more expressions wrapped in braces
5776 {} like this: >
5777 my_{adjective}_variable
5779 When Vim encounters this, it evaluates the expression inside the braces, puts
5780 that in place of the expression, and re-interprets the whole as a variable
5781 name. So in the above example, if the variable "adjective" was set to
5782 "noisy", then the reference would be to "my_noisy_variable", whereas if
5783 "adjective" was set to "quiet", then it would be to "my_quiet_variable".
5785 One application for this is to create a set of variables governed by an option
5786 value. For example, the statement >
5787 echo my_{&background}_message
5789 would output the contents of "my_dark_message" or "my_light_message" depending
5790 on the current value of 'background'.
5792 You can use multiple brace pairs: >
5793 echo my_{adverb}_{adjective}_message
5794 ..or even nest them: >
5795 echo my_{ad{end_of_word}}_message
5796 where "end_of_word" is either "verb" or "jective".
5798 However, the expression inside the braces must evaluate to a valid single
5799 variable name, e.g. this is invalid: >
5800 :let foo='a + b'
5801 :echo c{foo}d
5802 .. since the result of expansion is "ca + bd", which is not a variable name.
5804 *curly-braces-function-names*
5805 You can call and define functions by an evaluated name in a similar way.
5806 Example: >
5807 :let func_end='whizz'
5808 :call my_func_{func_end}(parameter)
5810 This would call the function "my_func_whizz(parameter)".
5812 ==============================================================================
5813 7. Commands *expression-commands*
5815 :let {var-name} = {expr1} *:let* *E18*
5816 Set internal variable {var-name} to the result of the
5817 expression {expr1}. The variable will get the type
5818 from the {expr}. If {var-name} didn't exist yet, it
5819 is created.
5821 :let {var-name}[{idx}] = {expr1} *E689*
5822 Set a list item to the result of the expression
5823 {expr1}. {var-name} must refer to a list and {idx}
5824 must be a valid index in that list. For nested list
5825 the index can be repeated.
5826 This cannot be used to add an item to a list.
5828 *E711* *E719*
5829 :let {var-name}[{idx1}:{idx2}] = {expr1} *E708* *E709* *E710*
5830 Set a sequence of items in a |List| to the result of
5831 the expression {expr1}, which must be a list with the
5832 correct number of items.
5833 {idx1} can be omitted, zero is used instead.
5834 {idx2} can be omitted, meaning the end of the list.
5835 When the selected range of items is partly past the
5836 end of the list, items will be added.
5838 *:let+=* *:let-=* *:let.=* *E734*
5839 :let {var} += {expr1} Like ":let {var} = {var} + {expr1}".
5840 :let {var} -= {expr1} Like ":let {var} = {var} - {expr1}".
5841 :let {var} .= {expr1} Like ":let {var} = {var} . {expr1}".
5842 These fail if {var} was not set yet and when the type
5843 of {var} and {expr1} don't fit the operator.
5846 :let ${env-name} = {expr1} *:let-environment* *:let-$*
5847 Set environment variable {env-name} to the result of
5848 the expression {expr1}. The type is always String.
5849 :let ${env-name} .= {expr1}
5850 Append {expr1} to the environment variable {env-name}.
5851 If the environment variable didn't exist yet this
5852 works like "=".
5854 :let @{reg-name} = {expr1} *:let-register* *:let-@*
5855 Write the result of the expression {expr1} in register
5856 {reg-name}. {reg-name} must be a single letter, and
5857 must be the name of a writable register (see
5858 |registers|). "@@" can be used for the unnamed
5859 register, "@/" for the search pattern.
5860 If the result of {expr1} ends in a <CR> or <NL>, the
5861 register will be linewise, otherwise it will be set to
5862 characterwise.
5863 This can be used to clear the last search pattern: >
5864 :let @/ = ""
5865 < This is different from searching for an empty string,
5866 that would match everywhere.
5868 :let @{reg-name} .= {expr1}
5869 Append {expr1} to register {reg-name}. If the
5870 register was empty it's like setting it to {expr1}.
5872 :let &{option-name} = {expr1} *:let-option* *:let-&*
5873 Set option {option-name} to the result of the
5874 expression {expr1}. A String or Number value is
5875 always converted to the type of the option.
5876 For an option local to a window or buffer the effect
5877 is just like using the |:set| command: both the local
5878 value and the global value are changed.
5879 Example: >
5880 :let &path = &path . ',/usr/local/include'
5882 :let &{option-name} .= {expr1}
5883 For a string option: Append {expr1} to the value.
5884 Does not insert a comma like |:set+=|.
5886 :let &{option-name} += {expr1}
5887 :let &{option-name} -= {expr1}
5888 For a number or boolean option: Add or subtract
5889 {expr1}.
5891 :let &l:{option-name} = {expr1}
5892 :let &l:{option-name} .= {expr1}
5893 :let &l:{option-name} += {expr1}
5894 :let &l:{option-name} -= {expr1}
5895 Like above, but only set the local value of an option
5896 (if there is one). Works like |:setlocal|.
5898 :let &g:{option-name} = {expr1}
5899 :let &g:{option-name} .= {expr1}
5900 :let &g:{option-name} += {expr1}
5901 :let &g:{option-name} -= {expr1}
5902 Like above, but only set the global value of an option
5903 (if there is one). Works like |:setglobal|.
5905 :let [{name1}, {name2}, ...] = {expr1} *:let-unpack* *E687* *E688*
5906 {expr1} must evaluate to a |List|. The first item in
5907 the list is assigned to {name1}, the second item to
5908 {name2}, etc.
5909 The number of names must match the number of items in
5910 the |List|.
5911 Each name can be one of the items of the ":let"
5912 command as mentioned above.
5913 Example: >
5914 :let [s, item] = GetItem(s)
5915 < Detail: {expr1} is evaluated first, then the
5916 assignments are done in sequence. This matters if
5917 {name2} depends on {name1}. Example: >
5918 :let x = [0, 1]
5919 :let i = 0
5920 :let [i, x[i]] = [1, 2]
5921 :echo x
5922 < The result is [0, 2].
5924 :let [{name1}, {name2}, ...] .= {expr1}
5925 :let [{name1}, {name2}, ...] += {expr1}
5926 :let [{name1}, {name2}, ...] -= {expr1}
5927 Like above, but append/add/subtract the value for each
5928 |List| item.
5930 :let [{name}, ..., ; {lastname}] = {expr1}
5931 Like |:let-unpack| above, but the |List| may have more
5932 items than there are names. A list of the remaining
5933 items is assigned to {lastname}. If there are no
5934 remaining items {lastname} is set to an empty list.
5935 Example: >
5936 :let [a, b; rest] = ["aval", "bval", 3, 4]
5937 <
5938 :let [{name}, ..., ; {lastname}] .= {expr1}
5939 :let [{name}, ..., ; {lastname}] += {expr1}
5940 :let [{name}, ..., ; {lastname}] -= {expr1}
5941 Like above, but append/add/subtract the value for each
5942 |List| item.
5943 *E106*
5944 :let {var-name} .. List the value of variable {var-name}. Multiple
5945 variable names may be given. Special names recognized
5946 here: *E738*
5947 g: global variables
5948 b: local buffer variables
5949 w: local window variables
5950 t: local tab page variables
5951 s: script-local variables
5952 l: local function variables
5953 v: Vim variables.
5955 :let List the values of all variables. The type of the
5956 variable is indicated before the value:
5957 <nothing> String
5958 # Number
5959 * Funcref
5962 :unl[et][!] {name} ... *:unlet* *:unl* *E108* *E795*
5963 Remove the internal variable {name}. Several variable
5964 names can be given, they are all removed. The name
5965 may also be a |List| or |Dictionary| item.
5966 With [!] no error message is given for non-existing
5967 variables.
5968 One or more items from a |List| can be removed: >
5969 :unlet list[3] " remove fourth item
5970 :unlet list[3:] " remove fourth item to last
5971 < One item from a |Dictionary| can be removed at a time: >
5972 :unlet dict['two']
5973 :unlet dict.two
5975 :lockv[ar][!] [depth] {name} ... *:lockvar* *:lockv*
5976 Lock the internal variable {name}. Locking means that
5977 it can no longer be changed (until it is unlocked).
5978 A locked variable can be deleted: >
5979 :lockvar v
5980 :let v = 'asdf' " fails!
5981 :unlet v
5982 < *E741*
5983 If you try to change a locked variable you get an
5984 error message: "E741: Value of {name} is locked"
5986 [depth] is relevant when locking a |List| or
5987 |Dictionary|. It specifies how deep the locking goes:
5988 1 Lock the |List| or |Dictionary| itself,
5989 cannot add or remove items, but can
5990 still change their values.
5991 2 Also lock the values, cannot change
5992 the items. If an item is a |List| or
5993 |Dictionary|, cannot add or remove
5994 items, but can still change the
5995 values.
5996 3 Like 2 but for the |List| /
5997 |Dictionary| in the |List| /
5998 |Dictionary|, one level deeper.
5999 The default [depth] is 2, thus when {name} is a |List|
6000 or |Dictionary| the values cannot be changed.
6001 *E743*
6002 For unlimited depth use [!] and omit [depth].
6003 However, there is a maximum depth of 100 to catch
6004 loops.
6006 Note that when two variables refer to the same |List|
6007 and you lock one of them, the |List| will also be
6008 locked when used through the other variable.
6009 Example: >
6010 :let l = [0, 1, 2, 3]
6011 :let cl = l
6012 :lockvar l
6013 :let cl[1] = 99 " won't work!
6014 < You may want to make a copy of a list to avoid this.
6015 See |deepcopy()|.
6018 :unlo[ckvar][!] [depth] {name} ... *:unlockvar* *:unlo*
6019 Unlock the internal variable {name}. Does the
6020 opposite of |:lockvar|.
6023 :if {expr1} *:if* *:endif* *:en* *E171* *E579* *E580*
6024 :en[dif] Execute the commands until the next matching ":else"
6025 or ":endif" if {expr1} evaluates to non-zero.
6027 From Vim version 4.5 until 5.0, every Ex command in
6028 between the ":if" and ":endif" is ignored. These two
6029 commands were just to allow for future expansions in a
6030 backwards compatible way. Nesting was allowed. Note
6031 that any ":else" or ":elseif" was ignored, the "else"
6032 part was not executed either.
6034 You can use this to remain compatible with older
6035 versions: >
6036 :if version >= 500
6037 : version-5-specific-commands
6038 :endif
6039 < The commands still need to be parsed to find the
6040 "endif". Sometimes an older Vim has a problem with a
6041 new command. For example, ":silent" is recognized as
6042 a ":substitute" command. In that case ":execute" can
6043 avoid problems: >
6044 :if version >= 600
6045 : execute "silent 1,$delete"
6046 :endif
6047 <
6048 NOTE: The ":append" and ":insert" commands don't work
6049 properly in between ":if" and ":endif".
6051 *:else* *:el* *E581* *E583*
6052 :el[se] Execute the commands until the next matching ":else"
6053 or ":endif" if they previously were not being
6054 executed.
6056 *:elseif* *:elsei* *E582* *E584*
6057 :elsei[f] {expr1} Short for ":else" ":if", with the addition that there
6058 is no extra ":endif".
6060 :wh[ile] {expr1} *:while* *:endwhile* *:wh* *:endw*
6061 *E170* *E585* *E588* *E733*
6062 :endw[hile] Repeat the commands between ":while" and ":endwhile",
6063 as long as {expr1} evaluates to non-zero.
6064 When an error is detected from a command inside the
6065 loop, execution continues after the "endwhile".
6066 Example: >
6067 :let lnum = 1
6068 :while lnum <= line("$")
6069 :call FixLine(lnum)
6070 :let lnum = lnum + 1
6071 :endwhile
6072 <
6073 NOTE: The ":append" and ":insert" commands don't work
6074 properly inside a ":while" and ":for" loop.
6076 :for {var} in {list} *:for* *E690* *E732*
6077 :endfo[r] *:endfo* *:endfor*
6078 Repeat the commands between ":for" and ":endfor" for
6079 each item in {list}. Variable {var} is set to the
6080 value of each item.
6081 When an error is detected for a command inside the
6082 loop, execution continues after the "endfor".
6083 Changing {list} inside the loop affects what items are
6084 used. Make a copy if this is unwanted: >
6085 :for item in copy(mylist)
6086 < When not making a copy, Vim stores a reference to the
6087 next item in the list, before executing the commands
6088 with the current item. Thus the current item can be
6089 removed without effect. Removing any later item means
6090 it will not be found. Thus the following example
6091 works (an inefficient way to make a list empty): >
6092 :for item in mylist
6093 :call remove(mylist, 0)
6094 :endfor
6095 < Note that reordering the list (e.g., with sort() or
6096 reverse()) may have unexpected effects.
6097 Note that the type of each list item should be
6098 identical to avoid errors for the type of {var}
6099 changing. Unlet the variable at the end of the loop
6100 to allow multiple item types.
6102 :for [{var1}, {var2}, ...] in {listlist}
6103 :endfo[r]
6104 Like ":for" above, but each item in {listlist} must be
6105 a list, of which each item is assigned to {var1},
6106 {var2}, etc. Example: >
6107 :for [lnum, col] in [[1, 3], [2, 5], [3, 8]]
6108 :echo getline(lnum)[col]
6109 :endfor
6110 <
6111 *:continue* *:con* *E586*
6112 :con[tinue] When used inside a ":while" or ":for" loop, jumps back
6113 to the start of the loop.
6114 If it is used after a |:try| inside the loop but
6115 before the matching |:finally| (if present), the
6116 commands following the ":finally" up to the matching
6117 |:endtry| are executed first. This process applies to
6118 all nested ":try"s inside the loop. The outermost
6119 ":endtry" then jumps back to the start of the loop.
6121 *:break* *:brea* *E587*
6122 :brea[k] When used inside a ":while" or ":for" loop, skips to
6123 the command after the matching ":endwhile" or
6124 ":endfor".
6125 If it is used after a |:try| inside the loop but
6126 before the matching |:finally| (if present), the
6127 commands following the ":finally" up to the matching
6128 |:endtry| are executed first. This process applies to
6129 all nested ":try"s inside the loop. The outermost
6130 ":endtry" then jumps to the command after the loop.
6132 :try *:try* *:endt* *:endtry* *E600* *E601* *E602*
6133 :endt[ry] Change the error handling for the commands between
6134 ":try" and ":endtry" including everything being
6135 executed across ":source" commands, function calls,
6136 or autocommand invocations.
6138 When an error or interrupt is detected and there is
6139 a |:finally| command following, execution continues
6140 after the ":finally". Otherwise, or when the
6141 ":endtry" is reached thereafter, the next
6142 (dynamically) surrounding ":try" is checked for
6143 a corresponding ":finally" etc. Then the script
6144 processing is terminated. (Whether a function
6145 definition has an "abort" argument does not matter.)
6146 Example: >
6147 :try | edit too much | finally | echo "cleanup" | endtry
6148 :echo "impossible" " not reached, script terminated above
6149 <
6150 Moreover, an error or interrupt (dynamically) inside
6151 ":try" and ":endtry" is converted to an exception. It
6152 can be caught as if it were thrown by a |:throw|
6153 command (see |:catch|). In this case, the script
6154 processing is not terminated.
6156 The value "Vim:Interrupt" is used for an interrupt
6157 exception. An error in a Vim command is converted
6158 to a value of the form "Vim({command}):{errmsg}",
6159 other errors are converted to a value of the form
6160 "Vim:{errmsg}". {command} is the full command name,
6161 and {errmsg} is the message that is displayed if the
6162 error exception is not caught, always beginning with
6163 the error number.
6164 Examples: >
6165 :try | sleep 100 | catch /^Vim:Interrupt$/ | endtry
6166 :try | edit | catch /^Vim(edit):E\d\+/ | echo "error" | endtry
6167 <
6168 *:cat* *:catch* *E603* *E604* *E605*
6169 :cat[ch] /{pattern}/ The following commands until the next ":catch",
6170 |:finally|, or |:endtry| that belongs to the same
6171 |:try| as the ":catch" are executed when an exception
6172 matching {pattern} is being thrown and has not yet
6173 been caught by a previous ":catch". Otherwise, these
6174 commands are skipped.
6175 When {pattern} is omitted all errors are caught.
6176 Examples: >
6177 :catch /^Vim:Interrupt$/ " catch interrupts (CTRL-C)
6178 :catch /^Vim\%((\a\+)\)\=:E/ " catch all Vim errors
6179 :catch /^Vim\%((\a\+)\)\=:/ " catch errors and interrupts
6180 :catch /^Vim(write):/ " catch all errors in :write
6181 :catch /^Vim\%((\a\+)\)\=:E123/ " catch error E123
6182 :catch /my-exception/ " catch user exception
6183 :catch /.*/ " catch everything
6184 :catch " same as /.*/
6185 <
6186 Another character can be used instead of / around the
6187 {pattern}, so long as it does not have a special
6188 meaning (e.g., '|' or '"') and doesn't occur inside
6189 {pattern}.
6190 NOTE: It is not reliable to ":catch" the TEXT of
6191 an error message because it may vary in different
6192 locales.
6194 *:fina* *:finally* *E606* *E607*
6195 :fina[lly] The following commands until the matching |:endtry|
6196 are executed whenever the part between the matching
6197 |:try| and the ":finally" is left: either by falling
6198 through to the ":finally" or by a |:continue|,
6199 |:break|, |:finish|, or |:return|, or by an error or
6200 interrupt or exception (see |:throw|).
6202 *:th* *:throw* *E608*
6203 :th[row] {expr1} The {expr1} is evaluated and thrown as an exception.
6204 If the ":throw" is used after a |:try| but before the
6205 first corresponding |:catch|, commands are skipped
6206 until the first ":catch" matching {expr1} is reached.
6207 If there is no such ":catch" or if the ":throw" is
6208 used after a ":catch" but before the |:finally|, the
6209 commands following the ":finally" (if present) up to
6210 the matching |:endtry| are executed. If the ":throw"
6211 is after the ":finally", commands up to the ":endtry"
6212 are skipped. At the ":endtry", this process applies
6213 again for the next dynamically surrounding ":try"
6214 (which may be found in a calling function or sourcing
6215 script), until a matching ":catch" has been found.
6216 If the exception is not caught, the command processing
6217 is terminated.
6218 Example: >
6219 :try | throw "oops" | catch /^oo/ | echo "caught" | endtry
6220 <
6222 *:ec* *:echo*
6223 :ec[ho] {expr1} .. Echoes each {expr1}, with a space in between. The
6224 first {expr1} starts on a new line.
6225 Also see |:comment|.
6226 Use "\n" to start a new line. Use "\r" to move the
6227 cursor to the first column.
6228 Uses the highlighting set by the |:echohl| command.
6229 Cannot be followed by a comment.
6230 Example: >
6231 :echo "the value of 'shell' is" &shell
6232 < *:echo-redraw*
6233 A later redraw may make the message disappear again.
6234 And since Vim mostly postpones redrawing until it's
6235 finished with a sequence of commands this happens
6236 quite often. To avoid that a command from before the
6237 ":echo" causes a redraw afterwards (redraws are often
6238 postponed until you type something), force a redraw
6239 with the |:redraw| command. Example: >
6240 :new | redraw | echo "there is a new window"
6241 <
6242 *:echon*
6243 :echon {expr1} .. Echoes each {expr1}, without anything added. Also see
6244 |:comment|.
6245 Uses the highlighting set by the |:echohl| command.
6246 Cannot be followed by a comment.
6247 Example: >
6248 :echon "the value of 'shell' is " &shell
6249 <
6250 Note the difference between using ":echo", which is a
6251 Vim command, and ":!echo", which is an external shell
6252 command: >
6253 :!echo % --> filename
6254 < The arguments of ":!" are expanded, see |:_%|. >
6255 :!echo "%" --> filename or "filename"
6256 < Like the previous example. Whether you see the double
6257 quotes or not depends on your 'shell'. >
6258 :echo % --> nothing
6259 < The '%' is an illegal character in an expression. >
6260 :echo "%" --> %
6261 < This just echoes the '%' character. >
6262 :echo expand("%") --> filename
6263 < This calls the expand() function to expand the '%'.
6265 *:echoh* *:echohl*
6266 :echoh[l] {name} Use the highlight group {name} for the following
6267 |:echo|, |:echon| and |:echomsg| commands. Also used
6268 for the |input()| prompt. Example: >
6269 :echohl WarningMsg | echo "Don't panic!" | echohl None
6270 < Don't forget to set the group back to "None",
6271 otherwise all following echo's will be highlighted.
6273 *:echom* *:echomsg*
6274 :echom[sg] {expr1} .. Echo the expression(s) as a true message, saving the
6275 message in the |message-history|.
6276 Spaces are placed between the arguments as with the
6277 |:echo| command. But unprintable characters are
6278 displayed, not interpreted.
6279 The parsing works slightly different from |:echo|,
6280 more like |:execute|. All the expressions are first
6281 evaluated and concatenated before echoing anything.
6282 The expressions must evaluate to a Number or String, a
6283 Dictionary or List causes an error.
6284 Uses the highlighting set by the |:echohl| command.
6285 Example: >
6286 :echomsg "It's a Zizzer Zazzer Zuzz, as you can plainly see."
6287 < See |:echo-redraw| to avoid the message disappearing
6288 when the screen is redrawn.
6289 *:echoe* *:echoerr*
6290 :echoe[rr] {expr1} .. Echo the expression(s) as an error message, saving the
6291 message in the |message-history|. When used in a
6292 script or function the line number will be added.
6293 Spaces are placed between the arguments as with the
6294 :echo command. When used inside a try conditional,
6295 the message is raised as an error exception instead
6296 (see |try-echoerr|).
6297 Example: >
6298 :echoerr "This script just failed!"
6299 < If you just want a highlighted message use |:echohl|.
6300 And to get a beep: >
6301 :exe "normal \<Esc>"
6302 <
6303 *:exe* *:execute*
6304 :exe[cute] {expr1} .. Executes the string that results from the evaluation
6305 of {expr1} as an Ex command. Multiple arguments are
6306 concatenated, with a space in between. {expr1} is
6307 used as the processed command, command line editing
6308 keys are not recognized.
6309 Cannot be followed by a comment.
6310 Examples: >
6311 :execute "buffer " nextbuf
6312 :execute "normal " count . "w"
6313 <
6314 ":execute" can be used to append a command to commands
6315 that don't accept a '|'. Example: >
6316 :execute '!ls' | echo "theend"
6318 < ":execute" is also a nice way to avoid having to type
6319 control characters in a Vim script for a ":normal"
6320 command: >
6321 :execute "normal ixxx\<Esc>"
6322 < This has an <Esc> character, see |expr-string|.
6324 Note: The executed string may be any command-line, but
6325 you cannot start or end a "while", "for" or "if"
6326 command. Thus this is illegal: >
6327 :execute 'while i > 5'
6328 :execute 'echo "test" | break'
6329 <
6330 It is allowed to have a "while" or "if" command
6331 completely in the executed string: >
6332 :execute 'while i < 5 | echo i | let i = i + 1 | endwhile'
6333 <
6335 *:comment*
6336 ":execute", ":echo" and ":echon" cannot be followed by
6337 a comment directly, because they see the '"' as the
6338 start of a string. But, you can use '|' followed by a
6339 comment. Example: >
6340 :echo "foo" | "this is a comment
6342 ==============================================================================
6343 8. Exception handling *exception-handling*
6345 The Vim script language comprises an exception handling feature. This section
6346 explains how it can be used in a Vim script.
6348 Exceptions may be raised by Vim on an error or on interrupt, see
6349 |catch-errors| and |catch-interrupt|. You can also explicitly throw an
6350 exception by using the ":throw" command, see |throw-catch|.
6353 TRY CONDITIONALS *try-conditionals*
6355 Exceptions can be caught or can cause cleanup code to be executed. You can
6356 use a try conditional to specify catch clauses (that catch exceptions) and/or
6357 a finally clause (to be executed for cleanup).
6358 A try conditional begins with a |:try| command and ends at the matching
6359 |:endtry| command. In between, you can use a |:catch| command to start
6360 a catch clause, or a |:finally| command to start a finally clause. There may
6361 be none or multiple catch clauses, but there is at most one finally clause,
6362 which must not be followed by any catch clauses. The lines before the catch
6363 clauses and the finally clause is called a try block. >
6365 :try
6366 : ...
6367 : ... TRY BLOCK
6368 : ...
6369 :catch /{pattern}/
6370 : ...
6371 : ... CATCH CLAUSE
6372 : ...
6373 :catch /{pattern}/
6374 : ...
6375 : ... CATCH CLAUSE
6376 : ...
6377 :finally
6378 : ...
6379 : ... FINALLY CLAUSE
6380 : ...
6381 :endtry
6383 The try conditional allows to watch code for exceptions and to take the
6384 appropriate actions. Exceptions from the try block may be caught. Exceptions
6385 from the try block and also the catch clauses may cause cleanup actions.
6386 When no exception is thrown during execution of the try block, the control
6387 is transferred to the finally clause, if present. After its execution, the
6388 script continues with the line following the ":endtry".
6389 When an exception occurs during execution of the try block, the remaining
6390 lines in the try block are skipped. The exception is matched against the
6391 patterns specified as arguments to the ":catch" commands. The catch clause
6392 after the first matching ":catch" is taken, other catch clauses are not
6393 executed. The catch clause ends when the next ":catch", ":finally", or
6394 ":endtry" command is reached - whatever is first. Then, the finally clause
6395 (if present) is executed. When the ":endtry" is reached, the script execution
6396 continues in the following line as usual.
6397 When an exception that does not match any of the patterns specified by the
6398 ":catch" commands is thrown in the try block, the exception is not caught by
6399 that try conditional and none of the catch clauses is executed. Only the
6400 finally clause, if present, is taken. The exception pends during execution of
6401 the finally clause. It is resumed at the ":endtry", so that commands after
6402 the ":endtry" are not executed and the exception might be caught elsewhere,
6403 see |try-nesting|.
6404 When during execution of a catch clause another exception is thrown, the
6405 remaining lines in that catch clause are not executed. The new exception is
6406 not matched against the patterns in any of the ":catch" commands of the same
6407 try conditional and none of its catch clauses is taken. If there is, however,
6408 a finally clause, it is executed, and the exception pends during its
6409 execution. The commands following the ":endtry" are not executed. The new
6410 exception might, however, be caught elsewhere, see |try-nesting|.
6411 When during execution of the finally clause (if present) an exception is
6412 thrown, the remaining lines in the finally clause are skipped. If the finally
6413 clause has been taken because of an exception from the try block or one of the
6414 catch clauses, the original (pending) exception is discarded. The commands
6415 following the ":endtry" are not executed, and the exception from the finally
6416 clause is propagated and can be caught elsewhere, see |try-nesting|.
6418 The finally clause is also executed, when a ":break" or ":continue" for
6419 a ":while" loop enclosing the complete try conditional is executed from the
6420 try block or a catch clause. Or when a ":return" or ":finish" is executed
6421 from the try block or a catch clause of a try conditional in a function or
6422 sourced script, respectively. The ":break", ":continue", ":return", or
6423 ":finish" pends during execution of the finally clause and is resumed when the
6424 ":endtry" is reached. It is, however, discarded when an exception is thrown
6425 from the finally clause.
6426 When a ":break" or ":continue" for a ":while" loop enclosing the complete
6427 try conditional or when a ":return" or ":finish" is encountered in the finally
6428 clause, the rest of the finally clause is skipped, and the ":break",
6429 ":continue", ":return" or ":finish" is executed as usual. If the finally
6430 clause has been taken because of an exception or an earlier ":break",
6431 ":continue", ":return", or ":finish" from the try block or a catch clause,
6432 this pending exception or command is discarded.
6434 For examples see |throw-catch| and |try-finally|.
6437 NESTING OF TRY CONDITIONALS *try-nesting*
6439 Try conditionals can be nested arbitrarily. That is, a complete try
6440 conditional can be put into the try block, a catch clause, or the finally
6441 clause of another try conditional. If the inner try conditional does not
6442 catch an exception thrown in its try block or throws a new exception from one
6443 of its catch clauses or its finally clause, the outer try conditional is
6444 checked according to the rules above. If the inner try conditional is in the
6445 try block of the outer try conditional, its catch clauses are checked, but
6446 otherwise only the finally clause is executed. It does not matter for
6447 nesting, whether the inner try conditional is directly contained in the outer
6448 one, or whether the outer one sources a script or calls a function containing
6449 the inner try conditional.
6451 When none of the active try conditionals catches an exception, just their
6452 finally clauses are executed. Thereafter, the script processing terminates.
6453 An error message is displayed in case of an uncaught exception explicitly
6454 thrown by a ":throw" command. For uncaught error and interrupt exceptions
6455 implicitly raised by Vim, the error message(s) or interrupt message are shown
6456 as usual.
6458 For examples see |throw-catch|.
6461 EXAMINING EXCEPTION HANDLING CODE *except-examine*
6463 Exception handling code can get tricky. If you are in doubt what happens, set
6464 'verbose' to 13 or use the ":13verbose" command modifier when sourcing your
6465 script file. Then you see when an exception is thrown, discarded, caught, or
6466 finished. When using a verbosity level of at least 14, things pending in
6467 a finally clause are also shown. This information is also given in debug mode
6468 (see |debug-scripts|).
6471 THROWING AND CATCHING EXCEPTIONS *throw-catch*
6473 You can throw any number or string as an exception. Use the |:throw| command
6474 and pass the value to be thrown as argument: >
6475 :throw 4711
6476 :throw "string"
6477 < *throw-expression*
6478 You can also specify an expression argument. The expression is then evaluated
6479 first, and the result is thrown: >
6480 :throw 4705 + strlen("string")
6481 :throw strpart("strings", 0, 6)
6483 An exception might be thrown during evaluation of the argument of the ":throw"
6484 command. Unless it is caught there, the expression evaluation is abandoned.
6485 The ":throw" command then does not throw a new exception.
6486 Example: >
6488 :function! Foo(arg)
6489 : try
6490 : throw a:arg
6491 : catch /foo/
6492 : endtry
6493 : return 1
6494 :endfunction
6495 :
6496 :function! Bar()
6497 : echo "in Bar"
6498 : return 4710
6499 :endfunction
6500 :
6501 :throw Foo("arrgh") + Bar()
6503 This throws "arrgh", and "in Bar" is not displayed since Bar() is not
6504 executed. >
6505 :throw Foo("foo") + Bar()
6506 however displays "in Bar" and throws 4711.
6508 Any other command that takes an expression as argument might also be
6509 abandoned by an (uncaught) exception during the expression evaluation. The
6510 exception is then propagated to the caller of the command.
6511 Example: >
6513 :if Foo("arrgh")
6514 : echo "then"
6515 :else
6516 : echo "else"
6517 :endif
6519 Here neither of "then" or "else" is displayed.
6521 *catch-order*
6522 Exceptions can be caught by a try conditional with one or more |:catch|
6523 commands, see |try-conditionals|. The values to be caught by each ":catch"
6524 command can be specified as a pattern argument. The subsequent catch clause
6525 gets executed when a matching exception is caught.
6526 Example: >
6528 :function! Foo(value)
6529 : try
6530 : throw a:value
6531 : catch /^\d\+$/
6532 : echo "Number thrown"
6533 : catch /.*/
6534 : echo "String thrown"
6535 : endtry
6536 :endfunction
6537 :
6538 :call Foo(0x1267)
6539 :call Foo('string')
6541 The first call to Foo() displays "Number thrown", the second "String thrown".
6542 An exception is matched against the ":catch" commands in the order they are
6543 specified. Only the first match counts. So you should place the more
6544 specific ":catch" first. The following order does not make sense: >
6546 : catch /.*/
6547 : echo "String thrown"
6548 : catch /^\d\+$/
6549 : echo "Number thrown"
6551 The first ":catch" here matches always, so that the second catch clause is
6552 never taken.
6554 *throw-variables*
6555 If you catch an exception by a general pattern, you may access the exact value
6556 in the variable |v:exception|: >
6558 : catch /^\d\+$/
6559 : echo "Number thrown. Value is" v:exception
6561 You may also be interested where an exception was thrown. This is stored in
6562 |v:throwpoint|. Note that "v:exception" and "v:throwpoint" are valid for the
6563 exception most recently caught as long it is not finished.
6564 Example: >
6566 :function! Caught()
6567 : if v:exception != ""
6568 : echo 'Caught "' . v:exception . '" in ' . v:throwpoint
6569 : else
6570 : echo 'Nothing caught'
6571 : endif
6572 :endfunction
6573 :
6574 :function! Foo()
6575 : try
6576 : try
6577 : try
6578 : throw 4711
6579 : finally
6580 : call Caught()
6581 : endtry
6582 : catch /.*/
6583 : call Caught()
6584 : throw "oops"
6585 : endtry
6586 : catch /.*/
6587 : call Caught()
6588 : finally
6589 : call Caught()
6590 : endtry
6591 :endfunction
6592 :
6593 :call Foo()
6595 This displays >
6597 Nothing caught
6598 Caught "4711" in function Foo, line 4
6599 Caught "oops" in function Foo, line 10
6600 Nothing caught
6602 A practical example: The following command ":LineNumber" displays the line
6603 number in the script or function where it has been used: >
6605 :function! LineNumber()
6606 : return substitute(v:throwpoint, '.*\D\(\d\+\).*', '\1', "")
6607 :endfunction
6608 :command! LineNumber try | throw "" | catch | echo LineNumber() | endtry
6609 <
6610 *try-nested*
6611 An exception that is not caught by a try conditional can be caught by
6612 a surrounding try conditional: >
6614 :try
6615 : try
6616 : throw "foo"
6617 : catch /foobar/
6618 : echo "foobar"
6619 : finally
6620 : echo "inner finally"
6621 : endtry
6622 :catch /foo/
6623 : echo "foo"
6624 :endtry
6626 The inner try conditional does not catch the exception, just its finally
6627 clause is executed. The exception is then caught by the outer try
6628 conditional. The example displays "inner finally" and then "foo".
6630 *throw-from-catch*
6631 You can catch an exception and throw a new one to be caught elsewhere from the
6632 catch clause: >
6634 :function! Foo()
6635 : throw "foo"
6636 :endfunction
6637 :
6638 :function! Bar()
6639 : try
6640 : call Foo()
6641 : catch /foo/
6642 : echo "Caught foo, throw bar"
6643 : throw "bar"
6644 : endtry
6645 :endfunction
6646 :
6647 :try
6648 : call Bar()
6649 :catch /.*/
6650 : echo "Caught" v:exception
6651 :endtry
6653 This displays "Caught foo, throw bar" and then "Caught bar".
6655 *rethrow*
6656 There is no real rethrow in the Vim script language, but you may throw
6657 "v:exception" instead: >
6659 :function! Bar()
6660 : try
6661 : call Foo()
6662 : catch /.*/
6663 : echo "Rethrow" v:exception
6664 : throw v:exception
6665 : endtry
6666 :endfunction
6667 < *try-echoerr*
6668 Note that this method cannot be used to "rethrow" Vim error or interrupt
6669 exceptions, because it is not possible to fake Vim internal exceptions.
6670 Trying so causes an error exception. You should throw your own exception
6671 denoting the situation. If you want to cause a Vim error exception containing
6672 the original error exception value, you can use the |:echoerr| command: >
6674 :try
6675 : try
6676 : asdf
6677 : catch /.*/
6678 : echoerr v:exception
6679 : endtry
6680 :catch /.*/
6681 : echo v:exception
6682 :endtry
6684 This code displays
6686 Vim(echoerr):Vim:E492: Not an editor command: asdf ~
6689 CLEANUP CODE *try-finally*
6691 Scripts often change global settings and restore them at their end. If the
6692 user however interrupts the script by pressing CTRL-C, the settings remain in
6693 an inconsistent state. The same may happen to you in the development phase of
6694 a script when an error occurs or you explicitly throw an exception without
6695 catching it. You can solve these problems by using a try conditional with
6696 a finally clause for restoring the settings. Its execution is guaranteed on
6697 normal control flow, on error, on an explicit ":throw", and on interrupt.
6698 (Note that errors and interrupts from inside the try conditional are converted
6699 to exceptions. When not caught, they terminate the script after the finally
6700 clause has been executed.)
6701 Example: >
6703 :try
6704 : let s:saved_ts = &ts
6705 : set ts=17
6706 :
6707 : " Do the hard work here.
6708 :
6709 :finally
6710 : let &ts = s:saved_ts
6711 : unlet s:saved_ts
6712 :endtry
6714 This method should be used locally whenever a function or part of a script
6715 changes global settings which need to be restored on failure or normal exit of
6716 that function or script part.
6718 *break-finally*
6719 Cleanup code works also when the try block or a catch clause is left by
6720 a ":continue", ":break", ":return", or ":finish".
6721 Example: >
6723 :let first = 1
6724 :while 1
6725 : try
6726 : if first
6727 : echo "first"
6728 : let first = 0
6729 : continue
6730 : else
6731 : throw "second"
6732 : endif
6733 : catch /.*/
6734 : echo v:exception
6735 : break
6736 : finally
6737 : echo "cleanup"
6738 : endtry
6739 : echo "still in while"
6740 :endwhile
6741 :echo "end"
6743 This displays "first", "cleanup", "second", "cleanup", and "end". >
6745 :function! Foo()
6746 : try
6747 : return 4711
6748 : finally
6749 : echo "cleanup\n"
6750 : endtry
6751 : echo "Foo still active"
6752 :endfunction
6753 :
6754 :echo Foo() "returned by Foo"
6756 This displays "cleanup" and "4711 returned by Foo". You don't need to add an
6757 extra ":return" in the finally clause. (Above all, this would override the
6758 return value.)
6760 *except-from-finally*
6761 Using either of ":continue", ":break", ":return", ":finish", or ":throw" in
6762 a finally clause is possible, but not recommended since it abandons the
6763 cleanup actions for the try conditional. But, of course, interrupt and error
6764 exceptions might get raised from a finally clause.
6765 Example where an error in the finally clause stops an interrupt from
6766 working correctly: >
6768 :try
6769 : try
6770 : echo "Press CTRL-C for interrupt"
6771 : while 1
6772 : endwhile
6773 : finally
6774 : unlet novar
6775 : endtry
6776 :catch /novar/
6777 :endtry
6778 :echo "Script still running"
6779 :sleep 1
6781 If you need to put commands that could fail into a finally clause, you should
6782 think about catching or ignoring the errors in these commands, see
6783 |catch-errors| and |ignore-errors|.
6786 CATCHING ERRORS *catch-errors*
6788 If you want to catch specific errors, you just have to put the code to be
6789 watched in a try block and add a catch clause for the error message. The
6790 presence of the try conditional causes all errors to be converted to an
6791 exception. No message is displayed and |v:errmsg| is not set then. To find
6792 the right pattern for the ":catch" command, you have to know how the format of
6793 the error exception is.
6794 Error exceptions have the following format: >
6796 Vim({cmdname}):{errmsg}
6797 or >
6798 Vim:{errmsg}
6800 {cmdname} is the name of the command that failed; the second form is used when
6801 the command name is not known. {errmsg} is the error message usually produced
6802 when the error occurs outside try conditionals. It always begins with
6803 a capital "E", followed by a two or three-digit error number, a colon, and
6804 a space.
6806 Examples:
6808 The command >
6809 :unlet novar
6810 normally produces the error message >
6811 E108: No such variable: "novar"
6812 which is converted inside try conditionals to an exception >
6813 Vim(unlet):E108: No such variable: "novar"
6815 The command >
6816 :dwim
6817 normally produces the error message >
6818 E492: Not an editor command: dwim
6819 which is converted inside try conditionals to an exception >
6820 Vim:E492: Not an editor command: dwim
6822 You can catch all ":unlet" errors by a >
6823 :catch /^Vim(unlet):/
6824 or all errors for misspelled command names by a >
6825 :catch /^Vim:E492:/
6827 Some error messages may be produced by different commands: >
6828 :function nofunc
6829 and >
6830 :delfunction nofunc
6831 both produce the error message >
6832 E128: Function name must start with a capital: nofunc
6833 which is converted inside try conditionals to an exception >
6834 Vim(function):E128: Function name must start with a capital: nofunc
6835 or >
6836 Vim(delfunction):E128: Function name must start with a capital: nofunc
6837 respectively. You can catch the error by its number independently on the
6838 command that caused it if you use the following pattern: >
6839 :catch /^Vim(\a\+):E128:/
6841 Some commands like >
6842 :let x = novar
6843 produce multiple error messages, here: >
6844 E121: Undefined variable: novar
6845 E15: Invalid expression: novar
6846 Only the first is used for the exception value, since it is the most specific
6847 one (see |except-several-errors|). So you can catch it by >
6848 :catch /^Vim(\a\+):E121:/
6850 You can catch all errors related to the name "nofunc" by >
6851 :catch /\<nofunc\>/
6853 You can catch all Vim errors in the ":write" and ":read" commands by >
6854 :catch /^Vim(\(write\|read\)):E\d\+:/
6856 You can catch all Vim errors by the pattern >
6857 :catch /^Vim\((\a\+)\)\=:E\d\+:/
6858 <
6859 *catch-text*
6860 NOTE: You should never catch the error message text itself: >
6861 :catch /No such variable/
6862 only works in the english locale, but not when the user has selected
6863 a different language by the |:language| command. It is however helpful to
6864 cite the message text in a comment: >
6865 :catch /^Vim(\a\+):E108:/ " No such variable
6868 IGNORING ERRORS *ignore-errors*
6870 You can ignore errors in a specific Vim command by catching them locally: >
6872 :try
6873 : write
6874 :catch
6875 :endtry
6877 But you are strongly recommended NOT to use this simple form, since it could
6878 catch more than you want. With the ":write" command, some autocommands could
6879 be executed and cause errors not related to writing, for instance: >
6881 :au BufWritePre * unlet novar
6883 There could even be such errors you are not responsible for as a script
6884 writer: a user of your script might have defined such autocommands. You would
6885 then hide the error from the user.
6886 It is much better to use >
6888 :try
6889 : write
6890 :catch /^Vim(write):/
6891 :endtry
6893 which only catches real write errors. So catch only what you'd like to ignore
6894 intentionally.
6896 For a single command that does not cause execution of autocommands, you could
6897 even suppress the conversion of errors to exceptions by the ":silent!"
6898 command: >
6899 :silent! nunmap k
6900 This works also when a try conditional is active.
6903 CATCHING INTERRUPTS *catch-interrupt*
6905 When there are active try conditionals, an interrupt (CTRL-C) is converted to
6906 the exception "Vim:Interrupt". You can catch it like every exception. The
6907 script is not terminated, then.
6908 Example: >
6910 :function! TASK1()
6911 : sleep 10
6912 :endfunction
6914 :function! TASK2()
6915 : sleep 20
6916 :endfunction
6918 :while 1
6919 : let command = input("Type a command: ")
6920 : try
6921 : if command == ""
6922 : continue
6923 : elseif command == "END"
6924 : break
6925 : elseif command == "TASK1"
6926 : call TASK1()
6927 : elseif command == "TASK2"
6928 : call TASK2()
6929 : else
6930 : echo "\nIllegal command:" command
6931 : continue
6932 : endif
6933 : catch /^Vim:Interrupt$/
6934 : echo "\nCommand interrupted"
6935 : " Caught the interrupt. Continue with next prompt.
6936 : endtry
6937 :endwhile
6939 You can interrupt a task here by pressing CTRL-C; the script then asks for
6940 a new command. If you press CTRL-C at the prompt, the script is terminated.
6942 For testing what happens when CTRL-C would be pressed on a specific line in
6943 your script, use the debug mode and execute the |>quit| or |>interrupt|
6944 command on that line. See |debug-scripts|.
6947 CATCHING ALL *catch-all*
6949 The commands >
6951 :catch /.*/
6952 :catch //
6953 :catch
6955 catch everything, error exceptions, interrupt exceptions and exceptions
6956 explicitly thrown by the |:throw| command. This is useful at the top level of
6957 a script in order to catch unexpected things.
6958 Example: >
6960 :try
6961 :
6962 : " do the hard work here
6963 :
6964 :catch /MyException/
6965 :
6966 : " handle known problem
6967 :
6968 :catch /^Vim:Interrupt$/
6969 : echo "Script interrupted"
6970 :catch /.*/
6971 : echo "Internal error (" . v:exception . ")"
6972 : echo " - occurred at " . v:throwpoint
6973 :endtry
6974 :" end of script
6976 Note: Catching all might catch more things than you want. Thus, you are
6977 strongly encouraged to catch only for problems that you can really handle by
6978 specifying a pattern argument to the ":catch".
6979 Example: Catching all could make it nearly impossible to interrupt a script
6980 by pressing CTRL-C: >
6982 :while 1
6983 : try
6984 : sleep 1
6985 : catch
6986 : endtry
6987 :endwhile
6990 EXCEPTIONS AND AUTOCOMMANDS *except-autocmd*
6992 Exceptions may be used during execution of autocommands. Example: >
6994 :autocmd User x try
6995 :autocmd User x throw "Oops!"
6996 :autocmd User x catch
6997 :autocmd User x echo v:exception
6998 :autocmd User x endtry
6999 :autocmd User x throw "Arrgh!"
7000 :autocmd User x echo "Should not be displayed"
7001 :
7002 :try
7003 : doautocmd User x
7004 :catch
7005 : echo v:exception
7006 :endtry
7008 This displays "Oops!" and "Arrgh!".
7010 *except-autocmd-Pre*
7011 For some commands, autocommands get executed before the main action of the
7012 command takes place. If an exception is thrown and not caught in the sequence
7013 of autocommands, the sequence and the command that caused its execution are
7014 abandoned and the exception is propagated to the caller of the command.
7015 Example: >
7017 :autocmd BufWritePre * throw "FAIL"
7018 :autocmd BufWritePre * echo "Should not be displayed"
7019 :
7020 :try
7021 : write
7022 :catch
7023 : echo "Caught:" v:exception "from" v:throwpoint
7024 :endtry
7026 Here, the ":write" command does not write the file currently being edited (as
7027 you can see by checking 'modified'), since the exception from the BufWritePre
7028 autocommand abandons the ":write". The exception is then caught and the
7029 script displays: >
7031 Caught: FAIL from BufWrite Auto commands for "*"
7032 <
7033 *except-autocmd-Post*
7034 For some commands, autocommands get executed after the main action of the
7035 command has taken place. If this main action fails and the command is inside
7036 an active try conditional, the autocommands are skipped and an error exception
7037 is thrown that can be caught by the caller of the command.
7038 Example: >
7040 :autocmd BufWritePost * echo "File successfully written!"
7041 :
7042 :try
7043 : write /i/m/p/o/s/s/i/b/l/e
7044 :catch
7045 : echo v:exception
7046 :endtry
7048 This just displays: >
7050 Vim(write):E212: Can't open file for writing (/i/m/p/o/s/s/i/b/l/e)
7052 If you really need to execute the autocommands even when the main action
7053 fails, trigger the event from the catch clause.
7054 Example: >
7056 :autocmd BufWritePre * set noreadonly
7057 :autocmd BufWritePost * set readonly
7058 :
7059 :try
7060 : write /i/m/p/o/s/s/i/b/l/e
7061 :catch
7062 : doautocmd BufWritePost /i/m/p/o/s/s/i/b/l/e
7063 :endtry
7064 <
7065 You can also use ":silent!": >
7067 :let x = "ok"
7068 :let v:errmsg = ""
7069 :autocmd BufWritePost * if v:errmsg != ""
7070 :autocmd BufWritePost * let x = "after fail"
7071 :autocmd BufWritePost * endif
7072 :try
7073 : silent! write /i/m/p/o/s/s/i/b/l/e
7074 :catch
7075 :endtry
7076 :echo x
7078 This displays "after fail".
7080 If the main action of the command does not fail, exceptions from the
7081 autocommands will be catchable by the caller of the command: >
7083 :autocmd BufWritePost * throw ":-("
7084 :autocmd BufWritePost * echo "Should not be displayed"
7085 :
7086 :try
7087 : write
7088 :catch
7089 : echo v:exception
7090 :endtry
7091 <
7092 *except-autocmd-Cmd*
7093 For some commands, the normal action can be replaced by a sequence of
7094 autocommands. Exceptions from that sequence will be catchable by the caller
7095 of the command.
7096 Example: For the ":write" command, the caller cannot know whether the file
7097 had actually been written when the exception occurred. You need to tell it in
7098 some way. >
7100 :if !exists("cnt")
7101 : let cnt = 0
7102 :
7103 : autocmd BufWriteCmd * if &modified
7104 : autocmd BufWriteCmd * let cnt = cnt + 1
7105 : autocmd BufWriteCmd * if cnt % 3 == 2
7106 : autocmd BufWriteCmd * throw "BufWriteCmdError"
7107 : autocmd BufWriteCmd * endif
7108 : autocmd BufWriteCmd * write | set nomodified
7109 : autocmd BufWriteCmd * if cnt % 3 == 0
7110 : autocmd BufWriteCmd * throw "BufWriteCmdError"
7111 : autocmd BufWriteCmd * endif
7112 : autocmd BufWriteCmd * echo "File successfully written!"
7113 : autocmd BufWriteCmd * endif
7114 :endif
7115 :
7116 :try
7117 : write
7118 :catch /^BufWriteCmdError$/
7119 : if &modified
7120 : echo "Error on writing (file contents not changed)"
7121 : else
7122 : echo "Error after writing"
7123 : endif
7124 :catch /^Vim(write):/
7125 : echo "Error on writing"
7126 :endtry
7128 When this script is sourced several times after making changes, it displays
7129 first >
7130 File successfully written!
7131 then >
7132 Error on writing (file contents not changed)
7133 then >
7134 Error after writing
7135 etc.
7137 *except-autocmd-ill*
7138 You cannot spread a try conditional over autocommands for different events.
7139 The following code is ill-formed: >
7141 :autocmd BufWritePre * try
7142 :
7143 :autocmd BufWritePost * catch
7144 :autocmd BufWritePost * echo v:exception
7145 :autocmd BufWritePost * endtry
7146 :
7147 :write
7150 EXCEPTION HIERARCHIES AND PARAMETERIZED EXCEPTIONS *except-hier-param*
7152 Some programming languages allow to use hierarchies of exception classes or to
7153 pass additional information with the object of an exception class. You can do
7154 similar things in Vim.
7155 In order to throw an exception from a hierarchy, just throw the complete
7156 class name with the components separated by a colon, for instance throw the
7157 string "EXCEPT:MATHERR:OVERFLOW" for an overflow in a mathematical library.
7158 When you want to pass additional information with your exception class, add
7159 it in parentheses, for instance throw the string "EXCEPT:IO:WRITEERR(myfile)"
7160 for an error when writing "myfile".
7161 With the appropriate patterns in the ":catch" command, you can catch for
7162 base classes or derived classes of your hierarchy. Additional information in
7163 parentheses can be cut out from |v:exception| with the ":substitute" command.
7164 Example: >
7166 :function! CheckRange(a, func)
7167 : if a:a < 0
7168 : throw "EXCEPT:MATHERR:RANGE(" . a:func . ")"
7169 : endif
7170 :endfunction
7171 :
7172 :function! Add(a, b)
7173 : call CheckRange(a:a, "Add")
7174 : call CheckRange(a:b, "Add")
7175 : let c = a:a + a:b
7176 : if c < 0
7177 : throw "EXCEPT:MATHERR:OVERFLOW"
7178 : endif
7179 : return c
7180 :endfunction
7181 :
7182 :function! Div(a, b)
7183 : call CheckRange(a:a, "Div")
7184 : call CheckRange(a:b, "Div")
7185 : if (a:b == 0)
7186 : throw "EXCEPT:MATHERR:ZERODIV"
7187 : endif
7188 : return a:a / a:b
7189 :endfunction
7190 :
7191 :function! Write(file)
7192 : try
7193 : execute "write" a:file
7194 : catch /^Vim(write):/
7195 : throw "EXCEPT:IO(" . getcwd() . ", " . a:file . "):WRITEERR"
7196 : endtry
7197 :endfunction
7198 :
7199 :try
7200 :
7201 : " something with arithmetics and I/O
7202 :
7203 :catch /^EXCEPT:MATHERR:RANGE/
7204 : let function = substitute(v:exception, '.*(\(\a\+\)).*', '\1', "")
7205 : echo "Range error in" function
7206 :
7207 :catch /^EXCEPT:MATHERR/ " catches OVERFLOW and ZERODIV
7208 : echo "Math error"
7209 :
7210 :catch /^EXCEPT:IO/
7211 : let dir = substitute(v:exception, '.*(\(.\+\),\s*.\+).*', '\1', "")
7212 : let file = substitute(v:exception, '.*(.\+,\s*\(.\+\)).*', '\1', "")
7213 : if file !~ '^/'
7214 : let file = dir . "/" . file
7215 : endif
7216 : echo 'I/O error for "' . file . '"'
7217 :
7218 :catch /^EXCEPT/
7219 : echo "Unspecified error"
7220 :
7221 :endtry
7223 The exceptions raised by Vim itself (on error or when pressing CTRL-C) use
7224 a flat hierarchy: they are all in the "Vim" class. You cannot throw yourself
7225 exceptions with the "Vim" prefix; they are reserved for Vim.
7226 Vim error exceptions are parameterized with the name of the command that
7227 failed, if known. See |catch-errors|.
7230 PECULIARITIES
7231 *except-compat*
7232 The exception handling concept requires that the command sequence causing the
7233 exception is aborted immediately and control is transferred to finally clauses
7234 and/or a catch clause.
7236 In the Vim script language there are cases where scripts and functions
7237 continue after an error: in functions without the "abort" flag or in a command
7238 after ":silent!", control flow goes to the following line, and outside
7239 functions, control flow goes to the line following the outermost ":endwhile"
7240 or ":endif". On the other hand, errors should be catchable as exceptions
7241 (thus, requiring the immediate abortion).
7243 This problem has been solved by converting errors to exceptions and using
7244 immediate abortion (if not suppressed by ":silent!") only when a try
7245 conditional is active. This is no restriction since an (error) exception can
7246 be caught only from an active try conditional. If you want an immediate
7247 termination without catching the error, just use a try conditional without
7248 catch clause. (You can cause cleanup code being executed before termination
7249 by specifying a finally clause.)
7251 When no try conditional is active, the usual abortion and continuation
7252 behavior is used instead of immediate abortion. This ensures compatibility of
7253 scripts written for Vim 6.1 and earlier.
7255 However, when sourcing an existing script that does not use exception handling
7256 commands (or when calling one of its functions) from inside an active try
7257 conditional of a new script, you might change the control flow of the existing
7258 script on error. You get the immediate abortion on error and can catch the
7259 error in the new script. If however the sourced script suppresses error
7260 messages by using the ":silent!" command (checking for errors by testing
7261 |v:errmsg| if appropriate), its execution path is not changed. The error is
7262 not converted to an exception. (See |:silent|.) So the only remaining cause
7263 where this happens is for scripts that don't care about errors and produce
7264 error messages. You probably won't want to use such code from your new
7265 scripts.
7267 *except-syntax-err*
7268 Syntax errors in the exception handling commands are never caught by any of
7269 the ":catch" commands of the try conditional they belong to. Its finally
7270 clauses, however, is executed.
7271 Example: >
7273 :try
7274 : try
7275 : throw 4711
7276 : catch /\(/
7277 : echo "in catch with syntax error"
7278 : catch
7279 : echo "inner catch-all"
7280 : finally
7281 : echo "inner finally"
7282 : endtry
7283 :catch
7284 : echo 'outer catch-all caught "' . v:exception . '"'
7285 : finally
7286 : echo "outer finally"
7287 :endtry
7289 This displays: >
7290 inner finally
7291 outer catch-all caught "Vim(catch):E54: Unmatched \("
7292 outer finally
7293 The original exception is discarded and an error exception is raised, instead.
7295 *except-single-line*
7296 The ":try", ":catch", ":finally", and ":endtry" commands can be put on
7297 a single line, but then syntax errors may make it difficult to recognize the
7298 "catch" line, thus you better avoid this.
7299 Example: >
7300 :try | unlet! foo # | catch | endtry
7301 raises an error exception for the trailing characters after the ":unlet!"
7302 argument, but does not see the ":catch" and ":endtry" commands, so that the
7303 error exception is discarded and the "E488: Trailing characters" message gets
7304 displayed.
7306 *except-several-errors*
7307 When several errors appear in a single command, the first error message is
7308 usually the most specific one and therefor converted to the error exception.
7309 Example: >
7310 echo novar
7311 causes >
7312 E121: Undefined variable: novar
7313 E15: Invalid expression: novar
7314 The value of the error exception inside try conditionals is: >
7315 Vim(echo):E121: Undefined variable: novar
7316 < *except-syntax-error*
7317 But when a syntax error is detected after a normal error in the same command,
7318 the syntax error is used for the exception being thrown.
7319 Example: >
7320 unlet novar #
7321 causes >
7322 E108: No such variable: "novar"
7323 E488: Trailing characters
7324 The value of the error exception inside try conditionals is: >
7325 Vim(unlet):E488: Trailing characters
7326 This is done because the syntax error might change the execution path in a way
7327 not intended by the user. Example: >
7328 try
7329 try | unlet novar # | catch | echo v:exception | endtry
7330 catch /.*/
7331 echo "outer catch:" v:exception
7332 endtry
7333 This displays "outer catch: Vim(unlet):E488: Trailing characters", and then
7334 a "E600: Missing :endtry" error message is given, see |except-single-line|.
7336 ==============================================================================
7337 9. Examples *eval-examples*
7339 Printing in Binary ~
7340 >
7341 :" The function Nr2Bin() returns the Hex string of a number.
7342 :func Nr2Bin(nr)
7343 : let n = a:nr
7344 : let r = ""
7345 : while n
7346 : let r = '01'[n % 2] . r
7347 : let n = n / 2
7348 : endwhile
7349 : return r
7350 :endfunc
7352 :" The function String2Bin() converts each character in a string to a
7353 :" binary string, separated with dashes.
7354 :func String2Bin(str)
7355 : let out = ''
7356 : for ix in range(strlen(a:str))
7357 : let out = out . '-' . Nr2Bin(char2nr(a:str[ix]))
7358 : endfor
7359 : return out[1:]
7360 :endfunc
7362 Example of its use: >
7363 :echo Nr2Bin(32)
7364 result: "100000" >
7365 :echo String2Bin("32")
7366 result: "110011-110010"
7369 Sorting lines ~
7371 This example sorts lines with a specific compare function. >
7373 :func SortBuffer()
7374 : let lines = getline(1, '$')
7375 : call sort(lines, function("Strcmp"))
7376 : call setline(1, lines)
7377 :endfunction
7379 As a one-liner: >
7380 :call setline(1, sort(getline(1, '$'), function("Strcmp")))
7383 scanf() replacement ~
7384 *sscanf*
7385 There is no sscanf() function in Vim. If you need to extract parts from a
7386 line, you can use matchstr() and substitute() to do it. This example shows
7387 how to get the file name, line number and column number out of a line like
7388 "foobar.txt, 123, 45". >
7389 :" Set up the match bit
7390 :let mx='\(\f\+\),\s*\(\d\+\),\s*\(\d\+\)'
7391 :"get the part matching the whole expression
7392 :let l = matchstr(line, mx)
7393 :"get each item out of the match
7394 :let file = substitute(l, mx, '\1', '')
7395 :let lnum = substitute(l, mx, '\2', '')
7396 :let col = substitute(l, mx, '\3', '')
7398 The input is in the variable "line", the results in the variables "file",
7399 "lnum" and "col". (idea from Michael Geddes)
7402 getting the scriptnames in a Dictionary ~
7403 *scriptnames-dictionary*
7404 The |:scriptnames| command can be used to get a list of all script files that
7405 have been sourced. There is no equivalent function or variable for this
7406 (because it's rarely needed). In case you need to manipulate the list this
7407 code can be used: >
7408 " Get the output of ":scriptnames" in the scriptnames_output variable.
7409 let scriptnames_output = ''
7410 redir => scriptnames_output
7411 silent scriptnames
7412 redir END
7414 " Split the output into lines and parse each line. Add an entry to the
7415 " "scripts" dictionary.
7416 let scripts = {}
7417 for line in split(scriptnames_output, "\n")
7418 " Only do non-blank lines.
7419 if line =~ '\S'
7420 " Get the first number in the line.
7421 let nr = matchstr(line, '\d\+')
7422 " Get the file name, remove the script number " 123: ".
7423 let name = substitute(line, '.\+:\s*', '', '')
7424 " Add an item to the Dictionary
7425 let scripts[nr] = name
7426 endif
7427 endfor
7428 unlet scriptnames_output
7430 ==============================================================================
7431 10. No +eval feature *no-eval-feature*
7433 When the |+eval| feature was disabled at compile time, none of the expression
7434 evaluation commands are available. To prevent this from causing Vim scripts
7435 to generate all kinds of errors, the ":if" and ":endif" commands are still
7436 recognized, though the argument of the ":if" and everything between the ":if"
7437 and the matching ":endif" is ignored. Nesting of ":if" blocks is allowed, but
7438 only if the commands are at the start of the line. The ":else" command is not
7439 recognized.
7441 Example of how to avoid executing commands when the |+eval| feature is
7442 missing: >
7444 :if 1
7445 : echo "Expression evaluation is compiled in"
7446 :else
7447 : echo "You will _never_ see this message"
7448 :endif
7450 ==============================================================================
7451 11. The sandbox *eval-sandbox* *sandbox* *E48*
7453 The 'foldexpr', 'includeexpr', 'indentexpr', 'statusline' and 'foldtext'
7454 options are evaluated in a sandbox. This means that you are protected from
7455 these expressions having nasty side effects. This gives some safety for when
7456 these options are set from a modeline. It is also used when the command from
7457 a tags file is executed and for CTRL-R = in the command line.
7458 The sandbox is also used for the |:sandbox| command.
7460 These items are not allowed in the sandbox:
7461 - changing the buffer text
7462 - defining or changing mapping, autocommands, functions, user commands
7463 - setting certain options (see |option-summary|)
7464 - setting certain v: variables (see |v:var|) *E794*
7465 - executing a shell command
7466 - reading or writing a file
7467 - jumping to another buffer or editing a file
7468 - executing Python, Perl, etc. commands
7469 This is not guaranteed 100% secure, but it should block most attacks.
7471 *:san* *:sandbox*
7472 :san[dbox] {cmd} Execute {cmd} in the sandbox. Useful to evaluate an
7473 option that may have been set from a modeline, e.g.
7474 'foldexpr'.
7476 *sandbox-option*
7477 A few options contain an expression. When this expression is evaluated it may
7478 have to be done in the sandbox to avoid a security risk. But the sandbox is
7479 restrictive, thus this only happens when the option was set from an insecure
7480 location. Insecure in this context are:
7481 - sourcing a .vimrc or .exrc in the current directory
7482 - while executing in the sandbox
7483 - value coming from a modeline
7485 Note that when in the sandbox and saving an option value and restoring it, the
7486 option will still be marked as it was set in the sandbox.
7488 ==============================================================================
7489 12. Textlock *textlock*
7491 In a few situations it is not allowed to change the text in the buffer, jump
7492 to another window and some other things that might confuse or break what Vim
7493 is currently doing. This mostly applies to things that happen when Vim is
7494 actually doing something else. For example, evaluating the 'balloonexpr' may
7495 happen any moment the mouse cursor is resting at some position.
7497 This is not allowed when the textlock is active:
7498 - changing the buffer text
7499 - jumping to another buffer or window
7500 - editing another file
7501 - closing a window or quitting Vim
7502 - etc.
7505 vim:tw=78:ts=8:ft=help:norl: